From c295aaf80462734753b4a08fd810b6a2ee833158 Mon Sep 17 00:00:00 2001 From: Jeffrey Aven Date: Thu, 6 Jun 2024 16:25:48 +1000 Subject: [PATCH 1/3] new and improved aws --- providers/src/aws/v00.00.00000/provider.yaml | 63 +- .../v00.00.00000/services/accessanalyzer.yaml | 86 +- .../src/aws/v00.00.00000/services/acmpca.yaml | 191 +- .../aws/v00.00.00000/services/amplify.yaml | 316 +- .../services/amplifyuibuilder.yaml | 330 +- .../aws/v00.00.00000/services/apigateway.yaml | 2784 +- .../v00.00.00000/services/apigatewayv2.yaml | 955 +- .../aws/v00.00.00000/services/appconfig.yaml | 540 +- .../aws/v00.00.00000/services/appflow.yaml | 270 +- .../services/appintegrations.yaml | 275 +- .../services/applicationautoscaling.yaml | 468 +- .../services/applicationinsights.yaml | 98 +- .../aws/v00.00.00000/services/apprunner.yaml | 396 +- .../aws/v00.00.00000/services/appstream.yaml | 386 +- .../aws/v00.00.00000/services/appsync.yaml | 434 +- .../src/aws/v00.00.00000/services/aps.yaml | 264 +- .../v00.00.00000/services/arczonalshift.yaml | 86 +- .../src/aws/v00.00.00000/services/athena.yaml | 421 +- .../v00.00.00000/services/auditmanager.yaml | 100 +- .../v00.00.00000/services/autoscaling.yaml | 868 +- .../src/aws/v00.00.00000/services/b2bi.yaml | 380 +- .../src/aws/v00.00.00000/services/backup.yaml | 595 +- .../v00.00.00000/services/backupgateway.yaml | 90 +- .../src/aws/v00.00.00000/services/batch.yaml | 268 +- .../v00.00.00000/services/bcmdataexports.yaml | 80 +- .../aws/v00.00.00000/services/bedrock.yaml | 1734 +- .../services/billingconductor.yaml | 392 +- .../aws/v00.00.00000/services/budgets.yaml | 131 +- .../aws/v00.00.00000/services/cassandra.yaml | 185 +- .../src/aws/v00.00.00000/services/ce.yaml | 274 +- .../services/certificatemanager.yaml | 34 +- .../aws/v00.00.00000/services/chatbot.yaml | 251 +- .../aws/v00.00.00000/services/cleanrooms.yaml | 579 +- .../v00.00.00000/services/cleanroomsml.yaml | 88 +- .../v00.00.00000/services/cloudformation.yaml | 928 +- .../aws/v00.00.00000/services/cloudfront.yaml | 994 +- .../aws/v00.00.00000/services/cloudtrail.yaml | 338 +- .../aws/v00.00.00000/services/cloudwatch.yaml | 1450 +- .../v00.00.00000/services/cloudwatch_api.yaml | 4741 --- .../v00.00.00000/services/codeartifact.yaml | 272 +- .../aws/v00.00.00000/services/codebuild.yaml | 130 +- .../services/codeconnections.yaml | 88 +- .../aws/v00.00.00000/services/codedeploy.yaml | 146 +- .../services/codeguruprofiler.yaml | 86 +- .../services/codegurureviewer.yaml | 70 +- .../v00.00.00000/services/codepipeline.yaml | 102 +- .../services/codestarconnections.yaml | 279 +- .../services/codestarnotifications.yaml | 96 +- .../aws/v00.00.00000/services/cognito.yaml | 781 +- .../aws/v00.00.00000/services/comprehend.yaml | 192 +- .../src/aws/v00.00.00000/services/config.yaml | 527 +- .../aws/v00.00.00000/services/connect.yaml | 1905 +- .../services/connectcampaigns.yaml | 89 +- .../v00.00.00000/services/controltower.yaml | 263 +- .../src/aws/v00.00.00000/services/cur.yaml | 121 +- .../services/customerprofiles.yaml | 488 +- .../aws/v00.00.00000/services/databrew.yaml | 534 +- .../v00.00.00000/services/datapipeline.yaml | 90 +- .../aws/v00.00.00000/services/datasync.yaml | 1235 +- .../aws/v00.00.00000/services/datazone.yaml | 1600 +- .../aws/v00.00.00000/services/deadline.yaml | 678 +- .../aws/v00.00.00000/services/detective.yaml | 211 +- .../aws/v00.00.00000/services/devopsguru.yaml | 214 +- .../services/directoryservice.yaml | 98 +- .../src/aws/v00.00.00000/services/dms.yaml | 716 +- .../v00.00.00000/services/docdbelastic.yaml | 106 +- .../aws/v00.00.00000/services/dynamodb.yaml | 864 +- .../src/aws/v00.00.00000/services/ec2.yaml | 7779 ++-- .../src/aws/v00.00.00000/services/ecr.yaml | 510 +- .../src/aws/v00.00.00000/services/ecs.yaml | 380 +- .../src/aws/v00.00.00000/services/efs.yaml | 276 +- .../src/aws/v00.00.00000/services/eks.yaml | 1450 +- .../v00.00.00000/services/elasticache.yaml | 732 +- .../services/elasticbeanstalk.yaml | 362 +- .../services/elasticloadbalancingv2.yaml | 690 +- .../src/aws/v00.00.00000/services/emr.yaml | 344 +- .../v00.00.00000/services/emrcontainers.yaml | 84 +- .../v00.00.00000/services/emrserverless.yaml | 106 +- .../services/entityresolution.yaml | 463 +- .../src/aws/v00.00.00000/services/events.yaml | 577 +- .../v00.00.00000/services/eventschemas.yaml | 298 +- .../aws/v00.00.00000/services/evidently.yaml | 202 +- .../aws/v00.00.00000/services/finspace.yaml | 104 +- .../src/aws/v00.00.00000/services/fis.yaml | 188 +- .../src/aws/v00.00.00000/services/fms.yaml | 378 +- .../aws/v00.00.00000/services/forecast.yaml | 156 +- .../v00.00.00000/services/frauddetector.yaml | 546 +- .../src/aws/v00.00.00000/services/fsx.yaml | 92 +- .../aws/v00.00.00000/services/gamelift.yaml | 2378 +- .../services/globalaccelerator.yaml | 374 +- .../src/aws/v00.00.00000/services/glue.yaml | 133 +- .../aws/v00.00.00000/services/grafana.yaml | 122 +- .../v00.00.00000/services/greengrassv2.yaml | 176 +- .../v00.00.00000/services/groundstation.yaml | 271 +- .../aws/v00.00.00000/services/guardduty.yaml | 523 +- .../v00.00.00000/services/healthimaging.yaml | 72 +- .../aws/v00.00.00000/services/healthlake.yaml | 97 +- .../src/aws/v00.00.00000/services/iam.yaml | 8600 +++-- .../aws/v00.00.00000/services/iam_api.yaml | 31632 ---------------- .../v00.00.00000/services/identitystore.yaml | 156 +- .../v00.00.00000/services/imagebuilder.yaml | 788 +- .../aws/v00.00.00000/services/inspector.yaml | 164 +- .../v00.00.00000/services/inspectorv2.yaml | 170 +- .../services/internetmonitor.yaml | 108 +- .../src/aws/v00.00.00000/services/iot.yaml | 2297 +- .../v00.00.00000/services/iotanalytics.yaml | 174 +- .../services/iotcoredeviceadvisor.yaml | 84 +- .../aws/v00.00.00000/services/iotevents.yaml | 262 +- .../v00.00.00000/services/iotfleethub.yaml | 98 +- .../v00.00.00000/services/iotfleetwise.yaml | 572 +- .../v00.00.00000/services/iotsitewise.yaml | 628 +- .../v00.00.00000/services/iottwinmaker.yaml | 484 +- .../v00.00.00000/services/iotwireless.yaml | 952 +- .../src/aws/v00.00.00000/services/ivs.yaml | 684 +- .../aws/v00.00.00000/services/ivschat.yaml | 176 +- .../v00.00.00000/services/kafkaconnect.yaml | 278 +- .../src/aws/v00.00.00000/services/kendra.yaml | 300 +- .../v00.00.00000/services/kendraranking.yaml | 86 +- .../aws/v00.00.00000/services/kinesis.yaml | 88 +- .../services/kinesisanalyticsv2.yaml | 92 +- .../services/kinesisfirehose.yaml | 106 +- .../v00.00.00000/services/kinesisvideo.yaml | 68 +- .../src/aws/v00.00.00000/services/kms.yaml | 335 +- .../v00.00.00000/services/lakeformation.yaml | 221 +- .../src/aws/v00.00.00000/services/lambda.yaml | 1519 +- .../src/aws/v00.00.00000/services/lex.yaml | 352 +- .../v00.00.00000/services/licensemanager.yaml | 190 +- .../aws/v00.00.00000/services/lightsail.yaml | 984 +- .../aws/v00.00.00000/services/location.yaml | 641 +- .../src/aws/v00.00.00000/services/logs.yaml | 939 +- .../services/lookoutequipment.yaml | 94 +- .../v00.00.00000/services/lookoutmetrics.yaml | 154 +- .../v00.00.00000/services/lookoutvision.yaml | 60 +- .../src/aws/v00.00.00000/services/m2.yaml | 198 +- .../src/aws/v00.00.00000/services/macie.yaml | 352 +- .../services/managedblockchain.yaml | 90 +- .../v00.00.00000/services/mediaconnect.yaml | 1071 +- .../aws/v00.00.00000/services/medialive.yaml | 187 +- .../v00.00.00000/services/mediapackage.yaml | 456 +- .../v00.00.00000/services/mediapackagev2.yaml | 453 +- .../v00.00.00000/services/mediatailor.yaml | 513 +- .../aws/v00.00.00000/services/memorydb.yaml | 470 +- .../src/aws/v00.00.00000/services/msk.yaml | 590 +- .../src/aws/v00.00.00000/services/mwaa.yaml | 150 +- .../aws/v00.00.00000/services/neptune.yaml | 132 +- .../v00.00.00000/services/neptunegraph.yaml | 180 +- .../services/networkfirewall.yaml | 440 +- .../v00.00.00000/services/networkmanager.yaml | 1313 +- .../v00.00.00000/services/nimblestudio.yaml | 395 +- .../src/aws/v00.00.00000/services/oam.yaml | 194 +- .../src/aws/v00.00.00000/services/omics.yaml | 536 +- .../services/opensearchserverless.yaml | 521 +- .../services/opensearchservice.yaml | 34 +- .../aws/v00.00.00000/services/opsworkscm.yaml | 120 +- .../v00.00.00000/services/organizations.yaml | 422 +- .../src/aws/v00.00.00000/services/osis.yaml | 98 +- .../aws/v00.00.00000/services/panorama.yaml | 228 +- .../services/paymentcryptography.yaml | 1132 + .../v00.00.00000/services/pcaconnectorad.yaml | 402 +- .../v00.00.00000/services/personalize.yaml | 288 +- .../aws/v00.00.00000/services/pinpoint.yaml | 88 +- .../src/aws/v00.00.00000/services/pipes.yaml | 247 +- .../src/aws/v00.00.00000/services/proton.yaml | 270 +- .../aws/v00.00.00000/services/qbusiness.yaml | 3061 ++ .../src/aws/v00.00.00000/services/qldb.yaml | 107 +- .../aws/v00.00.00000/services/quicksight.yaml | 15577 ++++---- .../src/aws/v00.00.00000/services/ram.yaml | 90 +- .../src/aws/v00.00.00000/services/rds.yaml | 4900 +-- .../aws/v00.00.00000/services/redshift.yaml | 2239 +- .../services/redshiftserverless.yaml | 208 +- .../v00.00.00000/services/refactorspaces.yaml | 351 +- .../v00.00.00000/services/rekognition.yaml | 246 +- .../v00.00.00000/services/resiliencehub.yaml | 184 +- .../services/resourceexplorer2.yaml | 202 +- .../v00.00.00000/services/resourcegroups.yaml | 88 +- .../aws/v00.00.00000/services/robomaker.yaml | 378 +- .../v00.00.00000/services/rolesanywhere.yaml | 312 +- .../aws/v00.00.00000/services/route53.yaml | 1221 +- .../v00.00.00000/services/route53_api.yaml | 7824 ---- .../services/route53profiles.yaml | 1326 + .../services/route53recoverycontrol.yaml | 328 +- .../services/route53recoveryreadiness.yaml | 332 +- .../services/route53resolver.yaml | 836 +- .../src/aws/v00.00.00000/services/rum.yaml | 102 +- .../src/aws/v00.00.00000/services/s3.yaml | 799 +- .../aws/v00.00.00000/services/s3express.yaml | 142 +- .../v00.00.00000/services/s3objectlambda.yaml | 122 +- .../aws/v00.00.00000/services/s3outposts.yaml | 282 +- .../aws/v00.00.00000/services/sagemaker.yaml | 1908 +- .../aws/v00.00.00000/services/scheduler.yaml | 184 +- .../v00.00.00000/services/secretsmanager.yaml | 90 +- .../v00.00.00000/services/securityhub.yaml | 1785 +- .../v00.00.00000/services/securitylake.yaml | 508 +- .../v00.00.00000/services/servicecatalog.yaml | 192 +- .../services/servicecatalogappregistry.yaml | 321 +- .../src/aws/v00.00.00000/services/ses.yaml | 495 +- .../src/aws/v00.00.00000/services/shield.yaml | 321 +- .../src/aws/v00.00.00000/services/signer.yaml | 159 +- .../v00.00.00000/services/simspaceweaver.yaml | 86 +- .../src/aws/v00.00.00000/services/sns.yaml | 134 +- .../src/aws/v00.00.00000/services/sqs.yaml | 144 +- .../src/aws/v00.00.00000/services/ssm.yaml | 581 +- .../v00.00.00000/services/ssmcontacts.yaml | 292 +- .../v00.00.00000/services/ssmincidents.yaml | 198 +- .../src/aws/v00.00.00000/services/sso.yaml | 1108 +- .../v00.00.00000/services/stepfunctions.yaml | 351 +- .../aws/v00.00.00000/services/supportapp.yaml | 251 +- .../aws/v00.00.00000/services/synthetics.yaml | 190 +- .../services/systemsmanagersap.yaml | 90 +- .../aws/v00.00.00000/services/timestream.yaml | 407 +- .../aws/v00.00.00000/services/transfer.yaml | 6331 ++-- .../v00.00.00000/services/transfer_api.yaml | 6592 ---- .../services/verifiedpermissions.yaml | 364 +- .../aws/v00.00.00000/services/voiceid.yaml | 84 +- .../aws/v00.00.00000/services/vpclattice.yaml | 826 +- .../src/aws/v00.00.00000/services/wafv2.yaml | 543 +- .../src/aws/v00.00.00000/services/wisdom.yaml | 273 +- .../aws/v00.00.00000/services/workspaces.yaml | 16 +- .../services/workspacesthinclient.yaml | 119 +- .../v00.00.00000/services/workspacesweb.yaml | 683 +- .../src/aws/v00.00.00000/services/xray.yaml | 250 +- 221 files changed, 74258 insertions(+), 113688 deletions(-) delete mode 100644 providers/src/aws/v00.00.00000/services/cloudwatch_api.yaml delete mode 100644 providers/src/aws/v00.00.00000/services/iam_api.yaml create mode 100644 providers/src/aws/v00.00.00000/services/paymentcryptography.yaml create mode 100644 providers/src/aws/v00.00.00000/services/qbusiness.yaml delete mode 100644 providers/src/aws/v00.00.00000/services/route53_api.yaml create mode 100644 providers/src/aws/v00.00.00000/services/route53profiles.yaml delete mode 100644 providers/src/aws/v00.00.00000/services/transfer_api.yaml diff --git a/providers/src/aws/v00.00.00000/provider.yaml b/providers/src/aws/v00.00.00000/provider.yaml index 5d96b2b4..fd82f508 100644 --- a/providers/src/aws/v00.00.00000/provider.yaml +++ b/providers/src/aws/v00.00.00000/provider.yaml @@ -1388,6 +1388,15 @@ providerServices: title: panorama version: v00.00.00000 description: panorama + paymentcryptography: + id: paymentcryptography:v00.00.00000 + name: paymentcryptography + preferred: true + service: + $ref: aws/v00.00.00000/services/paymentcryptography.yaml + title: paymentcryptography + version: v00.00.00000 + description: paymentcryptography pcaconnectorad: id: pcaconnectorad:v00.00.00000 name: pcaconnectorad @@ -1433,6 +1442,15 @@ providerServices: title: proton version: v00.00.00000 description: proton + qbusiness: + id: qbusiness:v00.00.00000 + name: qbusiness + preferred: true + service: + $ref: aws/v00.00.00000/services/qbusiness.yaml + title: qbusiness + version: v00.00.00000 + description: qbusiness qldb: id: qldb:v00.00.00000 name: qldb @@ -1559,6 +1577,15 @@ providerServices: title: route53 version: v00.00.00000 description: route53 + route53profiles: + id: route53profiles:v00.00.00000 + name: route53profiles + preferred: true + service: + $ref: aws/v00.00.00000/services/route53profiles.yaml + title: route53profiles + version: v00.00.00000 + description: route53profiles route53recoverycontrol: id: route53recoverycontrol:v00.00.00000 name: route53recoverycontrol @@ -1937,15 +1964,6 @@ providerServices: title: cloudhsm version: v00.00.00000 description: cloudhsm - cloudwatch_api: - id: cloudwatch_api:v00.00.00000 - name: cloudwatch_api - preferred: true - service: - $ref: aws/v00.00.00000/services/cloudwatch_api.yaml - title: cloudwatch_api - version: v00.00.00000 - description: cloudwatch_api ec2_api: id: ec2_api:v00.00.00000 name: ec2_api @@ -1955,24 +1973,6 @@ providerServices: title: ec2_api version: v00.00.00000 description: ec2_api - iam_api: - id: iam_api:v00.00.00000 - name: iam_api - preferred: true - service: - $ref: aws/v00.00.00000/services/iam_api.yaml - title: iam_api - version: v00.00.00000 - description: iam_api - route53_api: - id: route53_api:v00.00.00000 - name: route53_api - preferred: true - service: - $ref: aws/v00.00.00000/services/route53_api.yaml - title: route53_api - version: v00.00.00000 - description: route53_api s3_api: id: s3_api:v00.00.00000 name: s3_api @@ -1982,15 +1982,6 @@ providerServices: title: s3_api version: v00.00.00000 description: s3_api - transfer_api: - id: transfer_api:v00.00.00000 - name: transfer_api - preferred: true - service: - $ref: aws/v00.00.00000/services/transfer_api.yaml - title: transfer_api - version: v00.00.00000 - description: transfer_api config: auth: type: aws_signing_v4 diff --git a/providers/src/aws/v00.00.00000/services/accessanalyzer.yaml b/providers/src/aws/v00.00.00000/services/accessanalyzer.yaml index c6d0ea61..6869f31a 100644 --- a/providers/src/aws/v00.00.00000/services/accessanalyzer.yaml +++ b/providers/src/aws/v00.00.00000/services/accessanalyzer.yaml @@ -603,7 +603,7 @@ components: x-cfn-type-name: AWS::AccessAnalyzer::Analyzer x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -620,9 +620,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -632,41 +632,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/analyzers/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/analyzers/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AccessAnalyzer::Analyzer' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AccessAnalyzer::Analyzer' - AND region = 'us-east-1' - analyzer: - name: analyzer - id: aws.accessanalyzer.analyzer - x-cfn-schema-name: Analyzer - x-cfn-type-name: AWS::AccessAnalyzer::Analyzer - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -677,12 +645,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/analyzers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/analyzers/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/analyzer/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/analyzers/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -697,20 +669,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AnalyzerName') as analyzer_name, - json_extract_path_text(Properties, 'ArchiveRules') as archive_rules, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Type') as type, - json_extract_path_text(Properties, 'AnalyzerConfiguration') as analyzer_configuration - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AccessAnalyzer::Analyzer' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AccessAnalyzer::Analyzer' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AnalyzerName') as analyzer_name, + json_extract_path_text(Properties, 'ArchiveRules') as archive_rules, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'AnalyzerConfiguration') as analyzer_configuration + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AccessAnalyzer::Analyzer' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AccessAnalyzer::Analyzer' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/acmpca.yaml b/providers/src/aws/v00.00.00000/services/acmpca.yaml index 6199f26f..71bdb766 100644 --- a/providers/src/aws/v00.00.00000/services/acmpca.yaml +++ b/providers/src/aws/v00.00.00000/services/acmpca.yaml @@ -661,7 +661,6 @@ components: type: string required: - PartyName - - NameAssigner UniformResourceIdentifier: description: String that contains X.509 UniformResourceIdentifier information. type: string @@ -728,6 +727,10 @@ components: x-write-only-properties: - ApiPassthrough - CertificateSigningRequest + - SigningAlgorithm + - TemplateArn + - Validity + - ValidityNotBefore x-read-only-properties: - Arn - Certificate @@ -736,6 +739,11 @@ components: - CertificateSigningRequest - SigningAlgorithm - Validity + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - acm-pca:IssueCertificate @@ -744,7 +752,6 @@ components: - acm-pca:GetCertificate delete: - acm-pca:GetCertificate - update: [] Tag: type: object additionalProperties: false @@ -753,6 +760,8 @@ components: type: string Value: type: string + required: + - Key CrlDistributionPointExtensionConfiguration: description: Configures the default behavior of the CRL Distribution Point extension for certificates issued by your certificate authority type: object @@ -779,6 +788,8 @@ components: type: string CrlDistributionPointExtensionConfiguration: $ref: '#/components/schemas/CrlDistributionPointExtensionConfiguration' + required: + - Enabled OcspConfiguration: description: Helps to configure online certificate status protocol (OCSP) responder for your certificate authority type: object @@ -788,6 +799,8 @@ components: type: boolean OcspCustomCname: type: string + required: + - Enabled RevocationConfiguration: description: Certificate Authority revocation information. type: object @@ -969,6 +982,11 @@ components: x-required-properties: - CertificateAuthorityArn - Certificate + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - acm-pca:ImportCertificateAuthorityCertificate @@ -1018,6 +1036,11 @@ components: - Actions - CertificateAuthorityArn - Principal + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false x-required-permissions: create: - acm-pca:CreatePermission @@ -1209,7 +1232,7 @@ components: x-identifiers: - Arn - CertificateAuthorityArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1243,22 +1266,11 @@ components: - $ref: '#/components/x-stackQL-resources/certificates/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/certificates/methods/delete_resource' - certificate: - name: certificate - id: aws.acmpca.certificate - x-cfn-schema-name: Certificate - x-cfn-type-name: AWS::ACMPCA::Certificate - x-identifiers: - - Arn - - CertificateAuthorityArn - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1276,7 +1288,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1300,7 +1312,7 @@ components: x-cfn-type-name: AWS::ACMPCA::CertificateAuthority x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1317,9 +1329,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1329,41 +1341,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/certificate_authorities/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/certificate_authorities/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ACMPCA::CertificateAuthority' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ACMPCA::CertificateAuthority' - AND region = 'us-east-1' - certificate_authority: - name: certificate_authority - id: aws.acmpca.certificate_authority - x-cfn-schema-name: CertificateAuthority - x-cfn-type-name: AWS::ACMPCA::CertificateAuthority - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1374,12 +1354,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/certificate_authorities/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/certificate_authorities/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/certificate_authority/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/certificate_authorities/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1399,25 +1383,41 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Type') as type, - json_extract_path_text(Properties, 'KeyAlgorithm') as key_algorithm, - json_extract_path_text(Properties, 'SigningAlgorithm') as signing_algorithm, - json_extract_path_text(Properties, 'Subject') as subject, - json_extract_path_text(Properties, 'RevocationConfiguration') as revocation_configuration, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'CertificateSigningRequest') as certificate_signing_request, - json_extract_path_text(Properties, 'CsrExtensions') as csr_extensions, - json_extract_path_text(Properties, 'KeyStorageSecurityStandard') as key_storage_security_standard, - json_extract_path_text(Properties, 'UsageMode') as usage_mode - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ACMPCA::CertificateAuthority' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ACMPCA::CertificateAuthority' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'KeyAlgorithm') as key_algorithm, + json_extract_path_text(Properties, 'SigningAlgorithm') as signing_algorithm, + json_extract_path_text(Properties, 'Subject') as subject, + json_extract_path_text(Properties, 'RevocationConfiguration') as revocation_configuration, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'CertificateSigningRequest') as certificate_signing_request, + json_extract_path_text(Properties, 'CsrExtensions') as csr_extensions, + json_extract_path_text(Properties, 'KeyStorageSecurityStandard') as key_storage_security_standard, + json_extract_path_text(Properties, 'UsageMode') as usage_mode + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ACMPCA::CertificateAuthority' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ACMPCA::CertificateAuthority' + AND region = 'us-east-1' certificate_authority_activations: name: certificate_authority_activations id: aws.acmpca.certificate_authority_activations @@ -1425,7 +1425,7 @@ components: x-cfn-type-name: AWS::ACMPCA::CertificateAuthorityActivation x-identifiers: - CertificateAuthorityArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1442,9 +1442,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1454,23 +1454,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/certificate_authority_activations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/certificate_authority_activations/methods/delete_resource' - certificate_authority_activation: - name: certificate_authority_activation - id: aws.acmpca.certificate_authority_activation - x-cfn-schema-name: CertificateAuthorityActivation - x-cfn-type-name: AWS::ACMPCA::CertificateAuthorityActivation - x-identifiers: - - CertificateAuthorityArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1481,12 +1467,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/certificate_authority_activations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/certificate_authority_activations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/certificate_authority_activation/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/certificate_authority_activations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1500,7 +1490,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1521,7 +1511,7 @@ components: x-identifiers: - CertificateAuthorityArn - Principal - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1555,22 +1545,11 @@ components: - $ref: '#/components/x-stackQL-resources/permissions/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/permissions/methods/delete_resource' - permission: - name: permission - id: aws.acmpca.permission - x-cfn-schema-name: Permission - x-cfn-type-name: AWS::ACMPCA::Permission - x-identifiers: - - CertificateAuthorityArn - - Principal - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1583,7 +1562,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, diff --git a/providers/src/aws/v00.00.00000/services/amplify.yaml b/providers/src/aws/v00.00.00000/services/amplify.yaml index 9e286771..035ab217 100644 --- a/providers/src/aws/v00.00.00000/services/amplify.yaml +++ b/providers/src/aws/v00.00.00000/services/amplify.yaml @@ -1191,7 +1191,7 @@ components: x-cfn-type-name: AWS::Amplify::App x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1208,9 +1208,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1220,41 +1220,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/apps/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/apps/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Amplify::App' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Amplify::App' - AND region = 'us-east-1' - app: - name: app - id: aws.amplify.app - x-cfn-schema-name: App - x-cfn-type-name: AWS::Amplify::App - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1265,12 +1233,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/apps/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/apps/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/app/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/apps/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1298,33 +1270,49 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AccessToken') as access_token, - json_extract_path_text(Properties, 'AppId') as app_id, - json_extract_path_text(Properties, 'AppName') as app_name, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'AutoBranchCreationConfig') as auto_branch_creation_config, - json_extract_path_text(Properties, 'BasicAuthConfig') as basic_auth_config, - json_extract_path_text(Properties, 'BuildSpec') as build_spec, - json_extract_path_text(Properties, 'CustomHeaders') as custom_headers, - json_extract_path_text(Properties, 'CustomRules') as custom_rules, - json_extract_path_text(Properties, 'DefaultDomain') as default_domain, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'EnableBranchAutoDeletion') as enable_branch_auto_deletion, - json_extract_path_text(Properties, 'EnvironmentVariables') as environment_variables, - json_extract_path_text(Properties, 'IAMServiceRole') as iam_service_role, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'OauthToken') as oauth_token, - json_extract_path_text(Properties, 'Platform') as platform, - json_extract_path_text(Properties, 'Repository') as repository, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Amplify::App' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Amplify::App' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AccessToken') as access_token, + json_extract_path_text(Properties, 'AppId') as app_id, + json_extract_path_text(Properties, 'AppName') as app_name, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'AutoBranchCreationConfig') as auto_branch_creation_config, + json_extract_path_text(Properties, 'BasicAuthConfig') as basic_auth_config, + json_extract_path_text(Properties, 'BuildSpec') as build_spec, + json_extract_path_text(Properties, 'CustomHeaders') as custom_headers, + json_extract_path_text(Properties, 'CustomRules') as custom_rules, + json_extract_path_text(Properties, 'DefaultDomain') as default_domain, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'EnableBranchAutoDeletion') as enable_branch_auto_deletion, + json_extract_path_text(Properties, 'EnvironmentVariables') as environment_variables, + json_extract_path_text(Properties, 'IAMServiceRole') as iam_service_role, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'OauthToken') as oauth_token, + json_extract_path_text(Properties, 'Platform') as platform, + json_extract_path_text(Properties, 'Repository') as repository, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Amplify::App' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Amplify::App' + AND region = 'us-east-1' branches: name: branches id: aws.amplify.branches @@ -1332,7 +1320,7 @@ components: x-cfn-type-name: AWS::Amplify::Branch x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1349,9 +1337,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1361,41 +1349,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/branches/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/branches/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Amplify::Branch' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Amplify::Branch' - AND region = 'us-east-1' - branch: - name: branch - id: aws.amplify.branch - x-cfn-schema-name: Branch - x-cfn-type-name: AWS::Amplify::Branch - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1406,12 +1362,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/branches/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/branches/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/branch/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/branches/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1435,29 +1395,45 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AppId') as app_id, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'BasicAuthConfig') as basic_auth_config, - json_extract_path_text(Properties, 'Backend') as backend, - json_extract_path_text(Properties, 'BranchName') as branch_name, - json_extract_path_text(Properties, 'BuildSpec') as build_spec, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'EnableAutoBuild') as enable_auto_build, - json_extract_path_text(Properties, 'EnablePerformanceMode') as enable_performance_mode, - json_extract_path_text(Properties, 'EnablePullRequestPreview') as enable_pull_request_preview, - json_extract_path_text(Properties, 'EnvironmentVariables') as environment_variables, - json_extract_path_text(Properties, 'Framework') as framework, - json_extract_path_text(Properties, 'PullRequestEnvironmentName') as pull_request_environment_name, - json_extract_path_text(Properties, 'Stage') as stage, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Amplify::Branch' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Amplify::Branch' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AppId') as app_id, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'BasicAuthConfig') as basic_auth_config, + json_extract_path_text(Properties, 'Backend') as backend, + json_extract_path_text(Properties, 'BranchName') as branch_name, + json_extract_path_text(Properties, 'BuildSpec') as build_spec, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'EnableAutoBuild') as enable_auto_build, + json_extract_path_text(Properties, 'EnablePerformanceMode') as enable_performance_mode, + json_extract_path_text(Properties, 'EnablePullRequestPreview') as enable_pull_request_preview, + json_extract_path_text(Properties, 'EnvironmentVariables') as environment_variables, + json_extract_path_text(Properties, 'Framework') as framework, + json_extract_path_text(Properties, 'PullRequestEnvironmentName') as pull_request_environment_name, + json_extract_path_text(Properties, 'Stage') as stage, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Amplify::Branch' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Amplify::Branch' + AND region = 'us-east-1' domains: name: domains id: aws.amplify.domains @@ -1465,7 +1441,7 @@ components: x-cfn-type-name: AWS::Amplify::Domain x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1482,9 +1458,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1494,41 +1470,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/domains/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/domains/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Amplify::Domain' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Amplify::Domain' - AND region = 'us-east-1' - domain: - name: domain - id: aws.amplify.domain - x-cfn-schema-name: Domain - x-cfn-type-name: AWS::Amplify::Domain - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1539,12 +1483,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/domains/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/domains/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/domain/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/domains/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1566,27 +1514,43 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AppId') as app_id, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'AutoSubDomainCreationPatterns') as auto_sub_domain_creation_patterns, - json_extract_path_text(Properties, 'AutoSubDomainIAMRole') as auto_sub_domain_iam_role, - json_extract_path_text(Properties, 'CertificateRecord') as certificate_record, - json_extract_path_text(Properties, 'Certificate') as certificate, - json_extract_path_text(Properties, 'CertificateSettings') as certificate_settings, - json_extract_path_text(Properties, 'DomainName') as domain_name, - json_extract_path_text(Properties, 'DomainStatus') as domain_status, - json_extract_path_text(Properties, 'UpdateStatus') as update_status, - json_extract_path_text(Properties, 'EnableAutoSubDomain') as enable_auto_sub_domain, - json_extract_path_text(Properties, 'StatusReason') as status_reason, - json_extract_path_text(Properties, 'SubDomainSettings') as sub_domain_settings - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Amplify::Domain' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Amplify::Domain' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AppId') as app_id, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'AutoSubDomainCreationPatterns') as auto_sub_domain_creation_patterns, + json_extract_path_text(Properties, 'AutoSubDomainIAMRole') as auto_sub_domain_iam_role, + json_extract_path_text(Properties, 'CertificateRecord') as certificate_record, + json_extract_path_text(Properties, 'Certificate') as certificate, + json_extract_path_text(Properties, 'CertificateSettings') as certificate_settings, + json_extract_path_text(Properties, 'DomainName') as domain_name, + json_extract_path_text(Properties, 'DomainStatus') as domain_status, + json_extract_path_text(Properties, 'UpdateStatus') as update_status, + json_extract_path_text(Properties, 'EnableAutoSubDomain') as enable_auto_sub_domain, + json_extract_path_text(Properties, 'StatusReason') as status_reason, + json_extract_path_text(Properties, 'SubDomainSettings') as sub_domain_settings + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Amplify::Domain' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Amplify::Domain' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/amplifyuibuilder.yaml b/providers/src/aws/v00.00.00000/services/amplifyuibuilder.yaml index 269d485e..a34c3a06 100644 --- a/providers/src/aws/v00.00.00000/services/amplifyuibuilder.yaml +++ b/providers/src/aws/v00.00.00000/services/amplifyuibuilder.yaml @@ -1404,7 +1404,7 @@ components: - AppId - EnvironmentName - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1421,9 +1421,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1433,47 +1433,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/components/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/components/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AppId') as app_id, - JSON_EXTRACT(Properties, '$.EnvironmentName') as environment_name, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AmplifyUIBuilder::Component' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AppId') as app_id, - json_extract_path_text(Properties, 'EnvironmentName') as environment_name, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AmplifyUIBuilder::Component' - AND region = 'us-east-1' - component: - name: component - id: aws.amplifyuibuilder.component - x-cfn-schema-name: Component - x-cfn-type-name: AWS::AmplifyUIBuilder::Component - x-identifiers: - - AppId - - EnvironmentName - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1484,12 +1446,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/components/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/components/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/component/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/components/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1515,31 +1481,51 @@ components: AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AppId') as app_id, - json_extract_path_text(Properties, 'BindingProperties') as binding_properties, - json_extract_path_text(Properties, 'Children') as children, - json_extract_path_text(Properties, 'CollectionProperties') as collection_properties, - json_extract_path_text(Properties, 'ComponentType') as component_type, - json_extract_path_text(Properties, 'CreatedAt') as created_at, - json_extract_path_text(Properties, 'EnvironmentName') as environment_name, - json_extract_path_text(Properties, 'Events') as events, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'ModifiedAt') as modified_at, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Overrides') as overrides, - json_extract_path_text(Properties, 'Properties') as properties, - json_extract_path_text(Properties, 'SchemaVersion') as schema_version, - json_extract_path_text(Properties, 'SourceId') as source_id, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Variants') as variants - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AmplifyUIBuilder::Component' - AND data__Identifier = '||' + JSON_EXTRACT(Properties, '$.AppId') as app_id, + JSON_EXTRACT(Properties, '$.EnvironmentName') as environment_name, + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AmplifyUIBuilder::Component' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AppId') as app_id, + json_extract_path_text(Properties, 'BindingProperties') as binding_properties, + json_extract_path_text(Properties, 'Children') as children, + json_extract_path_text(Properties, 'CollectionProperties') as collection_properties, + json_extract_path_text(Properties, 'ComponentType') as component_type, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'EnvironmentName') as environment_name, + json_extract_path_text(Properties, 'Events') as events, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'ModifiedAt') as modified_at, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Overrides') as overrides, + json_extract_path_text(Properties, 'Properties') as properties, + json_extract_path_text(Properties, 'SchemaVersion') as schema_version, + json_extract_path_text(Properties, 'SourceId') as source_id, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Variants') as variants + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AmplifyUIBuilder::Component' + AND data__Identifier = '||' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AppId') as app_id, + json_extract_path_text(Properties, 'EnvironmentName') as environment_name, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AmplifyUIBuilder::Component' + AND region = 'us-east-1' forms: name: forms id: aws.amplifyuibuilder.forms @@ -1549,7 +1535,7 @@ components: - AppId - EnvironmentName - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1566,9 +1552,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1578,47 +1564,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/forms/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/forms/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AppId') as app_id, - JSON_EXTRACT(Properties, '$.EnvironmentName') as environment_name, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AmplifyUIBuilder::Form' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AppId') as app_id, - json_extract_path_text(Properties, 'EnvironmentName') as environment_name, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AmplifyUIBuilder::Form' - AND region = 'us-east-1' - form: - name: form - id: aws.amplifyuibuilder.form - x-cfn-schema-name: Form - x-cfn-type-name: AWS::AmplifyUIBuilder::Form - x-identifiers: - - AppId - - EnvironmentName - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1629,12 +1577,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/forms/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/forms/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/form/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/forms/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1656,27 +1608,47 @@ components: AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AppId') as app_id, - json_extract_path_text(Properties, 'Cta') as cta, - json_extract_path_text(Properties, 'DataType') as data_type, - json_extract_path_text(Properties, 'EnvironmentName') as environment_name, - json_extract_path_text(Properties, 'Fields') as fields, - json_extract_path_text(Properties, 'FormActionType') as form_action_type, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'LabelDecorator') as label_decorator, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'SchemaVersion') as schema_version, - json_extract_path_text(Properties, 'SectionalElements') as sectional_elements, - json_extract_path_text(Properties, 'Style') as style, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AmplifyUIBuilder::Form' - AND data__Identifier = '||' + JSON_EXTRACT(Properties, '$.AppId') as app_id, + JSON_EXTRACT(Properties, '$.EnvironmentName') as environment_name, + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AmplifyUIBuilder::Form' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AppId') as app_id, + json_extract_path_text(Properties, 'Cta') as cta, + json_extract_path_text(Properties, 'DataType') as data_type, + json_extract_path_text(Properties, 'EnvironmentName') as environment_name, + json_extract_path_text(Properties, 'Fields') as fields, + json_extract_path_text(Properties, 'FormActionType') as form_action_type, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'LabelDecorator') as label_decorator, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'SchemaVersion') as schema_version, + json_extract_path_text(Properties, 'SectionalElements') as sectional_elements, + json_extract_path_text(Properties, 'Style') as style, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AmplifyUIBuilder::Form' + AND data__Identifier = '||' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AppId') as app_id, + json_extract_path_text(Properties, 'EnvironmentName') as environment_name, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AmplifyUIBuilder::Form' + AND region = 'us-east-1' themes: name: themes id: aws.amplifyuibuilder.themes @@ -1686,7 +1658,7 @@ components: - AppId - EnvironmentName - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1703,9 +1675,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1715,47 +1687,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/themes/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/themes/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AppId') as app_id, - JSON_EXTRACT(Properties, '$.EnvironmentName') as environment_name, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AmplifyUIBuilder::Theme' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AppId') as app_id, - json_extract_path_text(Properties, 'EnvironmentName') as environment_name, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AmplifyUIBuilder::Theme' - AND region = 'us-east-1' - theme: - name: theme - id: aws.amplifyuibuilder.theme - x-cfn-schema-name: Theme - x-cfn-type-name: AWS::AmplifyUIBuilder::Theme - x-identifiers: - - AppId - - EnvironmentName - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1766,12 +1700,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/themes/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/themes/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/theme/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/themes/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1789,23 +1727,43 @@ components: AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AppId') as app_id, - json_extract_path_text(Properties, 'CreatedAt') as created_at, - json_extract_path_text(Properties, 'EnvironmentName') as environment_name, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'ModifiedAt') as modified_at, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Overrides') as overrides, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Values') as _values - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AmplifyUIBuilder::Theme' - AND data__Identifier = '||' + JSON_EXTRACT(Properties, '$.AppId') as app_id, + JSON_EXTRACT(Properties, '$.EnvironmentName') as environment_name, + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AmplifyUIBuilder::Theme' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AppId') as app_id, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'EnvironmentName') as environment_name, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'ModifiedAt') as modified_at, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Overrides') as overrides, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Values') as _values + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AmplifyUIBuilder::Theme' + AND data__Identifier = '||' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AppId') as app_id, + json_extract_path_text(Properties, 'EnvironmentName') as environment_name, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AmplifyUIBuilder::Theme' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/apigateway.yaml b/providers/src/aws/v00.00.00000/services/apigateway.yaml index 5fd985db..f56730ca 100644 --- a/providers/src/aws/v00.00.00000/services/apigateway.yaml +++ b/providers/src/aws/v00.00.00000/services/apigateway.yaml @@ -401,18 +401,21 @@ components: - Id x-read-only-properties: - Id + x-tagging: + taggable: false x-required-permissions: + read: + - apigateway:GET create: - apigateway:PATCH - iam:GetRole - iam:PassRole - read: - - apigateway:GET update: - apigateway:PATCH - iam:GetRole - iam:PassRole - delete: [] + delete: + - apigateway:PATCH StageKey: type: object additionalProperties: false @@ -435,6 +438,7 @@ components: required: - Value - Key + description: '' ApiKey: type: object properties: @@ -487,6 +491,16 @@ components: - GenerateDistinctId x-read-only-properties: - APIKeyId + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - apigateway:PUT + - apigateway:DELETE + - apigateway:GET x-required-permissions: create: - apigateway:POST @@ -657,6 +671,16 @@ components: - ClientCertificateId x-read-only-properties: - ClientCertificateId + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + permissions: + - apigateway:PUT + - apigateway:DELETE + - apigateway:GET x-required-permissions: create: - apigateway:POST @@ -673,113 +697,123 @@ components: - apigateway:DELETE list: - apigateway:GET - StageDescription: + MethodSetting: + description: |- + The ``MethodSetting`` property type configures settings for all methods in a stage. + The ``MethodSettings`` property of the ``AWS::ApiGateway::Stage`` resource contains a list of ``MethodSetting`` property types. type: object additionalProperties: false properties: - AccessLogSetting: - description: Specifies settings for logging access in this stage. - $ref: '#/components/schemas/AccessLogSetting' - CacheClusterEnabled: - description: Specifies whether a cache cluster is enabled for the stage. - type: boolean - CacheClusterSize: - description: The size of the stage's cache cluster. For more information, see [cacheClusterSize](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateStage.html#apigw-CreateStage-request-cacheClusterSize) in the *API Gateway API Reference*. - type: string CacheDataEncrypted: - description: Indicates whether the cached responses are encrypted. + description: Specifies whether the cached responses are encrypted. type: boolean CacheTtlInSeconds: - description: The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses. + description: Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached. type: integer CachingEnabled: - description: Indicates whether responses are cached and returned for requests. You must enable a cache cluster on the stage to cache responses. For more information, see [Enable API Gateway Caching in a Stage to Enhance API Performance](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html) in the *API Gateway Developer Guide*. + description: Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached. + type: boolean + DataTraceEnabled: + description: Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. This can be useful to troubleshoot APIs, but can result in logging sensitive data. We recommend that you don't enable this option for production APIs. + type: boolean + HttpMethod: + description: The HTTP method. To apply settings to multiple resources and methods, specify an asterisk (``*``) for the ``HttpMethod`` and ``/*`` for the ``ResourcePath``. This parameter is required when you specify a ``MethodSetting``. + type: string + LoggingLevel: + description: Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. Valid values are ``OFF``, ``ERROR``, and ``INFO``. Choose ``ERROR`` to write only error-level entries to CloudWatch Logs, or choose ``INFO`` to include all ``ERROR`` events as well as extra informational events. + type: string + MetricsEnabled: + description: Specifies whether Amazon CloudWatch metrics are enabled for this method. type: boolean + ResourcePath: + description: >- + The resource path for this method. Forward slashes (``/``) are encoded as ``~1`` and the initial slash must include a forward slash. For example, the path value ``/resource/subresource`` must be encoded as ``/~1resource~1subresource``. To specify the root path, use only a slash (``/``). To apply settings to multiple resources and methods, specify an asterisk (``*``) for the ``HttpMethod`` and ``/*`` for the ``ResourcePath``. This parameter is required when you specify a + ``MethodSetting``. + type: string + ThrottlingBurstLimit: + description: Specifies the throttling burst limit. + type: integer + minimum: 0 + ThrottlingRateLimit: + description: Specifies the throttling rate limit. + type: number + minimum: 0 + StageDescription: + description: '``StageDescription`` is a property of the [AWS::ApiGateway::Deployment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html) resource that configures a deployment stage.' + additionalProperties: false + type: object + properties: + CacheTtlInSeconds: + description: The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses. + type: integer + Description: + description: A description of the purpose of the stage. + type: string + LoggingLevel: + description: The logging level for this method. For valid values, see the ``loggingLevel`` property of the [MethodSetting](https://docs.aws.amazon.com/apigateway/latest/api/API_MethodSetting.html) resource in the *Amazon API Gateway API Reference*. + type: string CanarySetting: description: Specifies settings for the canary deployment in this stage. $ref: '#/components/schemas/CanarySetting' + ThrottlingRateLimit: + description: The target request steady-state rate limit. For more information, see [Manage API Request Throttling](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html) in the *API Gateway Developer Guide*. + type: number ClientCertificateId: description: The identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage. type: string - DataTraceEnabled: - description: Indicates whether data trace logging is enabled for methods in the stage. API Gateway pushes these logs to Amazon CloudWatch Logs. - type: boolean - Description: - description: A description of the purpose of the stage. - type: string + Variables: + x-patternProperties: + '[a-zA-Z0-9]+': + type: string + description: 'A map that defines the stage variables. Variable names must consist of alphanumeric characters, and the values must match the following regular expression: ``[A-Za-z0-9-._~:/?#&=,]+``.' + additionalProperties: false + type: object DocumentationVersion: description: The version identifier of the API documentation snapshot. type: string - LoggingLevel: - description: The logging level for this method. For valid values, see the ``loggingLevel`` property of the [MethodSetting](https://docs.aws.amazon.com/apigateway/latest/api/API_MethodSetting.html) resource in the *Amazon API Gateway API Reference*. - type: string + CacheDataEncrypted: + description: Indicates whether the cached responses are encrypted. + type: boolean + DataTraceEnabled: + description: Indicates whether data trace logging is enabled for methods in the stage. API Gateway pushes these logs to Amazon CloudWatch Logs. + type: boolean + ThrottlingBurstLimit: + description: The target request burst rate limit. This allows more requests through for a period of time than the target rate limit. For more information, see [Manage API Request Throttling](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html) in the *API Gateway Developer Guide*. + type: integer + CachingEnabled: + description: Indicates whether responses are cached and returned for requests. You must enable a cache cluster on the stage to cache responses. For more information, see [Enable API Gateway Caching in a Stage to Enhance API Performance](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html) in the *API Gateway Developer Guide*. + type: boolean + TracingEnabled: + description: |- + Specifies whether active tracing with X-ray is enabled for this stage. + For more information, see [Trace API Gateway API Execution with X-Ray](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-xray.html) in the *API Gateway Developer Guide*. + type: boolean MethodSettings: - description: Configures settings for all of the stage's methods. - type: array uniqueItems: true + description: Configures settings for all of the stage's methods. x-insertionOrder: false + type: array items: $ref: '#/components/schemas/MethodSetting' + AccessLogSetting: + description: Specifies settings for logging access in this stage. + $ref: '#/components/schemas/AccessLogSetting' + CacheClusterSize: + description: The size of the stage's cache cluster. For more information, see [cacheClusterSize](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateStage.html#apigw-CreateStage-request-cacheClusterSize) in the *API Gateway API Reference*. + type: string MetricsEnabled: description: Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage. type: boolean Tags: - description: An array of arbitrary tags (key-value pairs) to associate with the stage. - type: array uniqueItems: false + description: An array of arbitrary tags (key-value pairs) to associate with the stage. x-insertionOrder: false + type: array items: $ref: '#/components/schemas/Tag' - ThrottlingBurstLimit: - description: The target request burst rate limit. This allows more requests through for a period of time than the target rate limit. For more information, see [Manage API Request Throttling](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html) in the *API Gateway Developer Guide*. - type: integer - ThrottlingRateLimit: - description: The target request steady-state rate limit. For more information, see [Manage API Request Throttling](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html) in the *API Gateway Developer Guide*. - type: number - TracingEnabled: - description: |- - Specifies whether active tracing with X-ray is enabled for this stage. - For more information, see [Trace API Gateway API Execution with X-Ray](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-xray.html) in the *API Gateway Developer Guide*. - type: boolean - Variables: - description: 'A map that defines the stage variables. Variable names must consist of alphanumeric characters, and the values must match the following regular expression: ``[A-Za-z0-9-._~:/?#&=,]+``.' - type: object - additionalProperties: false - x-patternProperties: - '[a-zA-Z0-9]+': - type: string - description: '``StageDescription`` is a property of the [AWS::ApiGateway::Deployment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html) resource that configures a deployment stage.' - DeploymentCanarySettings: - type: object - additionalProperties: false - properties: - PercentTraffic: - description: The percentage (0.0-100.0) of traffic routed to the canary deployment. - type: number - StageVariableOverrides: - description: A stage variable overrides used for the canary release deployment. They can override existing stage variables or add new stage variables for the canary release deployment. These stage variables are represented as a string-to-string map between stage variable names and their values. - type: object - additionalProperties: false - x-patternProperties: - '[a-zA-Z0-9]+': - type: string - UseStageCache: - description: A Boolean flag to indicate whether the canary release deployment uses the stage cache or not. + CacheClusterEnabled: + description: Specifies whether a cache cluster is enabled for the stage. type: boolean - description: The ``DeploymentCanarySettings`` property type specifies settings for the canary deployment. - AccessLogSetting: - description: |- - The ``AccessLogSetting`` property type specifies settings for logging access in this stage. - ``AccessLogSetting`` is a property of the [AWS::ApiGateway::Stage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html) resource. - type: object - additionalProperties: false - properties: - DestinationArn: - description: The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with ``amazon-apigateway-``. This parameter is required to enable access logging. - type: string - Format: - description: A single line format of the access logs of data, as specified by selected [$context variables](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference). The format must include at least ``$context.requestId``. This parameter is required to enable access logging. - type: string CanarySetting: description: Configuration settings of a canary deployment. type: object @@ -803,68 +837,58 @@ components: UseStageCache: description: A Boolean flag to indicate whether the canary deployment uses the stage cache or not. type: boolean - MethodSetting: + DeploymentCanarySettings: + description: The ``DeploymentCanarySettings`` property type specifies settings for the canary deployment. + additionalProperties: false + type: object + properties: + StageVariableOverrides: + x-patternProperties: + '[a-zA-Z0-9]+': + type: string + description: A stage variable overrides used for the canary release deployment. They can override existing stage variables or add new stage variables for the canary release deployment. These stage variables are represented as a string-to-string map between stage variable names and their values. + additionalProperties: false + type: object + PercentTraffic: + description: The percentage (0.0-100.0) of traffic routed to the canary deployment. + type: number + UseStageCache: + description: A Boolean flag to indicate whether the canary release deployment uses the stage cache or not. + type: boolean + AccessLogSetting: description: |- - The ``MethodSetting`` property type configures settings for all methods in a stage. - The ``MethodSettings`` property of the ``AWS::ApiGateway::Stage`` resource contains a list of ``MethodSetting`` property types. + The ``AccessLogSetting`` property type specifies settings for logging access in this stage. + ``AccessLogSetting`` is a property of the [AWS::ApiGateway::Stage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html) resource. type: object additionalProperties: false properties: - CacheDataEncrypted: - description: Specifies whether the cached responses are encrypted. - type: boolean - CacheTtlInSeconds: - description: Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached. - type: integer - CachingEnabled: - description: Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached. - type: boolean - DataTraceEnabled: - description: Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. This can be useful to troubleshoot APIs, but can result in logging sensitive data. We recommend that you don't enable this option for production APIs. - type: boolean - HttpMethod: - description: The HTTP method. To apply settings to multiple resources and methods, specify an asterisk (``*``) for the ``HttpMethod`` and ``/*`` for the ``ResourcePath``. This parameter is required when you specify a ``MethodSetting``. - type: string - LoggingLevel: - description: Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. Valid values are ``OFF``, ``ERROR``, and ``INFO``. Choose ``ERROR`` to write only error-level entries to CloudWatch Logs, or choose ``INFO`` to include all ``ERROR`` events as well as extra informational events. + DestinationArn: + description: The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with ``amazon-apigateway-``. This parameter is required to enable access logging. type: string - MetricsEnabled: - description: Specifies whether Amazon CloudWatch metrics are enabled for this method. - type: boolean - ResourcePath: - description: >- - The resource path for this method. Forward slashes (``/``) are encoded as ``~1`` and the initial slash must include a forward slash. For example, the path value ``/resource/subresource`` must be encoded as ``/~1resource~1subresource``. To specify the root path, use only a slash (``/``). To apply settings to multiple resources and methods, specify an asterisk (``*``) for the ``HttpMethod`` and ``/*`` for the ``ResourcePath``. This parameter is required when you specify a - ``MethodSetting``. + Format: + description: A single line format of the access logs of data, as specified by selected [$context variables](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference). The format must include at least ``$context.requestId``. This parameter is required to enable access logging. type: string - ThrottlingBurstLimit: - description: Specifies the throttling burst limit. - type: integer - minimum: 0 - ThrottlingRateLimit: - description: Specifies the throttling rate limit. - type: number - minimum: 0 Deployment: type: object properties: DeploymentId: - type: string description: '' - DeploymentCanarySettings: - $ref: '#/components/schemas/DeploymentCanarySettings' - description: The input configuration for a canary deployment. - Description: type: string + Description: description: The description for the Deployment resource to create. - RestApiId: type: string - description: The string identifier of the associated RestApi. StageDescription: - $ref: '#/components/schemas/StageDescription' description: The description of the Stage resource for the Deployment resource to create. To specify a stage description, you must also provide a stage name. + $ref: '#/components/schemas/StageDescription' StageName: - type: string description: The name of the Stage resource for the Deployment resource to create. + type: string + RestApiId: + description: The string identifier of the associated RestApi. + type: string + DeploymentCanarySettings: + description: The input configuration for a canary deployment. + $ref: '#/components/schemas/DeploymentCanarySettings' required: - RestApiId x-stackql-resource-name: deployment @@ -884,25 +908,26 @@ components: - DeploymentId x-required-properties: - RestApiId - x-taggable: true + x-tagging: + taggable: false x-required-permissions: + read: + - apigateway:GET create: - apigateway:POST - apigateway:PATCH - apigateway:PUT - apigateway:GET - read: - - apigateway:GET update: - apigateway:PATCH - apigateway:GET - apigateway:PUT - apigateway:DELETE + list: + - apigateway:GET delete: - apigateway:GET - apigateway:DELETE - list: - - apigateway:GET Location: type: object additionalProperties: false @@ -976,6 +1001,8 @@ components: - Location - Properties - RestApiId + x-tagging: + taggable: false x-required-permissions: create: - apigateway:GET @@ -1018,6 +1045,8 @@ components: x-required-properties: - DocumentationVersion - RestApiId + x-tagging: + taggable: false x-required-permissions: create: - apigateway:GET @@ -1032,24 +1061,27 @@ components: list: - apigateway:GET EndpointConfiguration: - type: object + description: |- + The ``EndpointConfiguration`` property type specifies the endpoint types of a REST API. + ``EndpointConfiguration`` is a property of the [AWS::ApiGateway::RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource. additionalProperties: false + type: object properties: Types: - type: array uniqueItems: true + description: A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is ``"EDGE"``. For a regional API and its custom domain name, the endpoint type is ``REGIONAL``. For a private API, the endpoint type is ``PRIVATE``. + type: array items: type: string - description: A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is ``"EDGE"``. For a regional API and its custom domain name, the endpoint type is ``REGIONAL``. For a private API, the endpoint type is ``PRIVATE``. VpcEndpointIds: - type: array uniqueItems: true + description: A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for ``PRIVATE`` endpoint type. + type: array items: + relationshipRef: + typeName: AWS::EC2::VPCEndpoint + propertyPath: /properties/Id type: string - description: A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for ``PRIVATE`` endpoint type. - description: |- - The ``EndpointConfiguration`` property type specifies the endpoint types of a REST API. - ``EndpointConfiguration`` is a property of the [AWS::ApiGateway::RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource. MutualTlsAuthentication: type: object properties: @@ -1110,48 +1142,121 @@ components: - apigateway:* list: - apigateway:* - Integration: + GatewayResponse: + type: object + properties: + Id: + description: '' + type: string + RestApiId: + description: The string identifier of the associated RestApi. + type: string + ResponseType: + description: The response type of the associated GatewayResponse. + type: string + StatusCode: + description: The HTTP status code for this GatewayResponse. + type: string + ResponseParameters: + description: Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs. + type: object + additionalProperties: false + x-patternProperties: + '[a-zA-Z0-9]+': + type: string + ResponseTemplates: + description: Response templates of the GatewayResponse as a string-to-string map of key-value pairs. + type: object + additionalProperties: false + x-patternProperties: + '[a-zA-Z0-9]+': + type: string + required: + - ResponseType + - RestApiId + x-stackql-resource-name: gateway_response + description: The ``AWS::ApiGateway::GatewayResponse`` resource creates a gateway response for your API. For more information, see [API Gateway Responses](https://docs.aws.amazon.com/apigateway/latest/developerguide/customize-gateway-responses.html#api-gateway-gatewayResponse-definition) in the *API Gateway Developer Guide*. + x-type-name: AWS::ApiGateway::GatewayResponse + x-stackql-primary-identifier: + - Id + x-create-only-properties: + - ResponseType + - RestApiId + x-read-only-properties: + - Id + x-required-properties: + - ResponseType + - RestApiId + x-tagging: + taggable: false + x-required-permissions: + create: + - apigateway:PUT + - apigateway:GET + read: + - apigateway:GET + update: + - apigateway:GET + - apigateway:PUT + delete: + - apigateway:GET + - apigateway:DELETE + list: + - apigateway:GET + MethodResponse: + description: Represents a method response of a given HTTP status code returned to the client. The method response is passed from the back end through the associated integration response that can be transformed using a mapping template. + additionalProperties: false type: object + properties: + ResponseParameters: + x-patternProperties: + '[a-zA-Z0-9]+': + type: boolean + description: >- + A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern ``method.response.header.{name}``, where ``name`` is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to + the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in ``integration.response.header.{name}``, a static value enclosed within a pair of single quotes (e.g., ``'application/json'``), or a JSON expression from the back-end response payload in the form of ``integration.response.body.{JSON-expression}``, where ``JSON-expression`` is a valid JSON expression without the ``$`` prefix.) + additionalProperties: false + type: object + StatusCode: + description: The method response's status code. + type: string + ResponseModels: + x-patternProperties: + '[a-zA-Z0-9]+': + type: string + description: Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value. + additionalProperties: false + type: object + required: + - StatusCode + Integration: + description: '``Integration`` is a property of the [AWS::ApiGateway::Method](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html) resource that specifies information about the target backend that a method calls.' additionalProperties: false + type: object properties: - CacheKeyParameters: - description: A list of request parameters whose values API Gateway caches. To be valid values for ``cacheKeyParameters``, these parameters must also be specified for Method ``requestParameters``. - type: array - uniqueItems: true - items: - type: string CacheNamespace: description: Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the ``cacheNamespace``. You can specify the same ``cacheNamespace`` across resources to return the same cached data for requests to different resources. type: string - ConnectionId: - description: The ID of the VpcLink used for the integration when ``connectionType=VPC_LINK`` and undefined, otherwise. - type: string ConnectionType: description: The type of the network connection to the integration endpoint. The valid value is ``INTERNET`` for connections through the public routable internet or ``VPC_LINK`` for private connections between API Gateway and a network load balancer in a VPC. The default value is ``INTERNET``. type: string enum: - INTERNET - VPC_LINK - ContentHandling: - description: |- - Specifies how to handle request payload content type conversions. Supported values are ``CONVERT_TO_BINARY`` and ``CONVERT_TO_TEXT``, with the following behaviors: - If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the ``passthroughBehavior`` is configured to support payload pass-through. - type: string - enum: - - CONVERT_TO_BINARY - - CONVERT_TO_TEXT - Credentials: - description: Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string ``arn:aws:iam::\*:user/\*``. To use resource-based permissions on supported AWS services, specify null. - type: string - IntegrationHttpMethod: - description: Specifies the integration's HTTP method type. For the Type property, if you specify ``MOCK``, this property is optional. For Lambda integrations, you must set the integration method to ``POST``. For all other types, you must specify this property. - type: string IntegrationResponses: + uniqueItems: true description: Specifies the integration's responses. type: array - uniqueItems: true items: $ref: '#/components/schemas/IntegrationResponse' + IntegrationHttpMethod: + description: Specifies the integration's HTTP method type. For the Type property, if you specify ``MOCK``, this property is optional. For Lambda integrations, you must set the integration method to ``POST``. For all other types, you must specify this property. + type: string + Uri: + description: |- + Specifies Uniform Resource Identifier (URI) of the integration endpoint. + For ``HTTP`` or ``HTTP_PROXY`` integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification for standard integrations. If ``connectionType`` is ``VPC_LINK`` specify the Network Load Balancer DNS name. For ``AWS`` or ``AWS_PROXY`` integrations, the URI is of the form ``arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}``. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either ``arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}`` or ``arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}`` + type: string PassthroughBehavior: description: >- Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in ``requestTemplates``. The valid value is one of the following: ``WHEN_NO_MATCH``: passes the method request body through the integration request to the back end without @@ -1163,25 +1268,17 @@ components: - WHEN_NO_TEMPLATES - NEVER RequestParameters: + x-patternProperties: + '[a-zA-Z0-9]+': + type: string description: >- A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of ``method.request.{location}.{name}``, where ``location`` is ``querystring``, ``path``, or ``header`` and ``name`` must be a valid and unique method request parameter name. - type: object additionalProperties: false - x-patternProperties: - '[a-zA-Z0-9]+': - type: string - RequestTemplates: - description: Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. type: object - additionalProperties: false - x-patternProperties: - '[a-zA-Z0-9]+': - type: string - TimeoutInMillis: - description: Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds. - type: integer - minimum: 50 + ConnectionId: + description: The ID of the VpcLink used for the integration when ``connectionType=VPC_LINK`` and undefined, otherwise. + type: string Type: description: |- Specifies an API method integration type. The valid value is one of the following: @@ -1193,44 +1290,53 @@ components: - HTTP - HTTP_PROXY - MOCK - Uri: + CacheKeyParameters: + uniqueItems: true + description: A list of request parameters whose values API Gateway caches. To be valid values for ``cacheKeyParameters``, these parameters must also be specified for Method ``requestParameters``. + type: array + items: + type: string + ContentHandling: description: |- - Specifies Uniform Resource Identifier (URI) of the integration endpoint. - For ``HTTP`` or ``HTTP_PROXY`` integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification for standard integrations. If ``connectionType`` is ``VPC_LINK`` specify the Network Load Balancer DNS name. For ``AWS`` or ``AWS_PROXY`` integrations, the URI is of the form ``arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}``. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either ``arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}`` or ``arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}`` + Specifies how to handle request payload content type conversions. Supported values are ``CONVERT_TO_BINARY`` and ``CONVERT_TO_TEXT``, with the following behaviors: + If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the ``passthroughBehavior`` is configured to support payload pass-through. type: string - required: - - Type - description: '``Integration`` is a property of the [AWS::ApiGateway::Method](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html) resource that specifies information about the target backend that a method calls.' - MethodResponse: - type: object - additionalProperties: false - properties: - ResponseModels: - description: Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value. - type: object - additionalProperties: false + enum: + - CONVERT_TO_BINARY + - CONVERT_TO_TEXT + RequestTemplates: x-patternProperties: '[a-zA-Z0-9]+': type: string - ResponseParameters: - description: >- - A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern ``method.response.header.{name}``, where ``name`` is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to - the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in ``integration.response.header.{name}``, a static value enclosed within a pair of single quotes (e.g., ``'application/json'``), or a JSON expression from the back-end response payload in the form of ``integration.response.body.{JSON-expression}``, where ``JSON-expression`` is a valid JSON expression without the ``$`` prefix.) - type: object + description: Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. additionalProperties: false - x-patternProperties: - '[a-zA-Z0-9]+': - type: boolean - StatusCode: - description: The method response's status code. + type: object + TimeoutInMillis: + description: Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds. + type: integer + minimum: 50 + Credentials: + description: Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string ``arn:aws:iam::\*:user/\*``. To use resource-based permissions on supported AWS services, specify null. type: string required: - - StatusCode - description: Represents a method response of a given HTTP status code returned to the client. The method response is passed from the back end through the associated integration response that can be transformed using a mapping template. + - Type IntegrationResponse: - type: object + description: '``IntegrationResponse`` is a property of the [Amazon API Gateway Method Integration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html) property type that specifies the response that API Gateway sends after a method''s backend finishes processing a request.' additionalProperties: false + type: object properties: + ResponseTemplates: + x-patternProperties: + '[a-zA-Z0-9]+': + type: string + description: Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value. + additionalProperties: false + type: object + SelectionPattern: + description: >- + Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the ``.+`` regex to match error response. However, make sure that the error response does not contain any newline (``\n``) character in such cases. If the back end is an LAMlong function, the LAMlong function error header is matched. For all other + HTTP and AWS back ends, the HTTP status code is matched. + type: string ContentHandling: description: |- Specifies how to handle response payload content type conversions. Supported values are ``CONVERT_TO_BINARY`` and ``CONVERT_TO_TEXT``, with the following behaviors: @@ -1240,97 +1346,79 @@ components: - CONVERT_TO_BINARY - CONVERT_TO_TEXT ResponseParameters: + x-patternProperties: + '[a-zA-Z0-9]+': + type: string description: >- A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of ``method.response.header.{name}``, where ``name`` is a valid and unique header name. The mapped non-static value must match the pattern of ``integration.response.header.{name}`` or ``integration.response.body.{JSON-expression}``, where ``name`` is a valid and unique response header name and ``JSON-expression`` is a valid JSON expression without the ``$`` prefix. - type: object additionalProperties: false - x-patternProperties: - '[a-zA-Z0-9]+': - type: string - ResponseTemplates: - description: Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value. type: object - additionalProperties: false - x-patternProperties: - '[a-zA-Z0-9]+': - type: string - SelectionPattern: - description: >- - Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the ``.+`` regex to match error response. However, make sure that the error response does not contain any newline (``\n``) character in such cases. If the back end is an LAMlong function, the LAMlong function error header is matched. For all other - HTTP and AWS back ends, the HTTP status code is matched. - type: string StatusCode: description: Specifies the status code that is used to map the integration response to an existing MethodResponse. type: string required: - StatusCode - description: '``IntegrationResponse`` is a property of the [Amazon API Gateway Method Integration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html) property type that specifies the response that API Gateway sends after a method''s backend finishes processing a request.' Method: type: object - properties: - ApiKeyRequired: - description: A boolean flag specifying whether a valid ApiKey is required to invoke this method. - type: boolean - AuthorizationScopes: - description: >- - A list of authorization scopes configured on the method. The scopes are used with a ``COGNITO_USER_POOLS`` authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide - an access token instead of an identity token for authorization purposes. - type: array - items: - type: string - AuthorizationType: - description: |- - The method's authorization type. This parameter is required. For valid values, see [Method](https://docs.aws.amazon.com/apigateway/latest/api/API_Method.html) in the *API Gateway API Reference*. - If you specify the ``AuthorizerId`` property, specify ``CUSTOM`` or ``COGNITO_USER_POOLS`` for this property. - type: string - enum: - - NONE - - AWS_IAM - - CUSTOM - - COGNITO_USER_POOLS - AuthorizerId: - description: The identifier of an authorizer to use on this method. The method's authorization type must be ``CUSTOM`` or ``COGNITO_USER_POOLS``. - type: string - HttpMethod: - description: The method's HTTP verb. - type: string - Integration: - description: Represents an ``HTTP``, ``HTTP_PROXY``, ``AWS``, ``AWS_PROXY``, or Mock integration. - $ref: '#/components/schemas/Integration' - MethodResponses: - description: Gets a method response associated with a given HTTP status code. - type: array - uniqueItems: true - items: - $ref: '#/components/schemas/MethodResponse' + properties: + Integration: + description: Represents an ``HTTP``, ``HTTP_PROXY``, ``AWS``, ``AWS_PROXY``, or Mock integration. + $ref: '#/components/schemas/Integration' OperationName: description: A human-friendly operation identifier for the method. For example, you can assign the ``operationName`` of ``ListPets`` for the ``GET /pets`` method in the ``PetStore`` example. type: string RequestModels: - description: A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key). - type: object - additionalProperties: false x-patternProperties: '[a-zA-Z0-9]+': type: string + description: A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key). + additionalProperties: false + type: object + RestApiId: + description: The string identifier of the associated RestApi. + type: string + AuthorizationScopes: + description: >- + A list of authorization scopes configured on the method. The scopes are used with a ``COGNITO_USER_POOLS`` authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide + an access token instead of an identity token for authorization purposes. + type: array + items: + type: string + RequestValidatorId: + description: The identifier of a RequestValidator for request validation. + type: string RequestParameters: + x-patternProperties: + '[a-zA-Z0-9]+': + type: boolean description: >- A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of ``method.request.{location}.{name}``, where ``location`` is ``querystring``, ``path``, or ``header`` and ``name`` is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (``true``) or optional (``false``). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates. - type: object additionalProperties: false - x-patternProperties: - '[a-zA-Z0-9]+': - type: boolean - RequestValidatorId: - description: The identifier of a RequestValidator for request validation. + type: object + MethodResponses: + uniqueItems: true + description: Gets a method response associated with a given HTTP status code. + type: array + items: + $ref: '#/components/schemas/MethodResponse' + AuthorizerId: + description: The identifier of an authorizer to use on this method. The method's authorization type must be ``CUSTOM`` or ``COGNITO_USER_POOLS``. type: string ResourceId: description: The Resource identifier for the MethodResponse resource. type: string - RestApiId: - description: The string identifier of the associated RestApi. + ApiKeyRequired: + description: A boolean flag specifying whether a valid ApiKey is required to invoke this method. + type: boolean + AuthorizationType: + description: |- + The method's authorization type. This parameter is required. For valid values, see [Method](https://docs.aws.amazon.com/apigateway/latest/api/API_Method.html) in the *API Gateway API Reference*. + If you specify the ``AuthorizerId`` property, specify ``CUSTOM`` or ``COGNITO_USER_POOLS`` for this property. + type: string + HttpMethod: + description: The method's HTTP verb. type: string required: - RestApiId @@ -1357,12 +1445,12 @@ components: tagUpdatable: false cloudFormationSystemTags: false x-required-permissions: + read: + - apigateway:GET create: - apigateway:PUT - apigateway:GET - iam:PassRole - read: - - apigateway:GET update: - apigateway:GET - apigateway:DELETE @@ -1404,6 +1492,8 @@ components: - RestApiId x-required-properties: - RestApiId + x-tagging: + taggable: false x-required-permissions: create: - apigateway:POST @@ -1451,6 +1541,8 @@ components: - RequestValidatorId x-required-properties: - RestApiId + x-tagging: + taggable: false x-required-permissions: create: - apigateway:POST @@ -1467,18 +1559,18 @@ components: Resource: type: object properties: - ResourceId: - description: '' - type: string - RestApiId: - description: The string identifier of the associated RestApi. - type: string ParentId: description: The parent resource's identifier. type: string PathPart: description: The last path segment for this resource. type: string + ResourceId: + description: '' + type: string + RestApiId: + description: The string identifier of the associated RestApi. + type: string required: - ParentId - PathPart @@ -1499,6 +1591,8 @@ components: - ParentId - PathPart - RestApiId + x-tagging: + taggable: false x-required-permissions: read: - apigateway:GET @@ -1507,76 +1601,58 @@ components: update: - apigateway:GET - apigateway:PATCH - delete: - - apigateway:DELETE list: - apigateway:GET + delete: + - apigateway:DELETE S3Location: - type: object + description: |- + ``S3Location`` is a property of the [AWS::ApiGateway::RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource that specifies the Amazon S3 location of a OpenAPI (formerly Swagger) file that defines a set of RESTful APIs in JSON or YAML. + On January 1, 2016, the Swagger Specification was donated to the [OpenAPI initiative](https://docs.aws.amazon.com/https://www.openapis.org/), becoming the foundation of the OpenAPI Specification. additionalProperties: false + type: object properties: Bucket: - type: string + x-relationshipRef: + typeName: AWS::S3::Bucket + propertyPath: /properties/BucketName description: The name of the S3 bucket where the OpenAPI file is stored. - ETag: type: string + ETag: description: The Amazon S3 ETag (a file checksum) of the OpenAPI file. If you don't specify a value, API Gateway skips ETag validation of your OpenAPI file. - Version: type: string + Version: description: For versioning-enabled buckets, a specific version of the OpenAPI file. - Key: type: string + Key: description: The file name of the OpenAPI file (Amazon S3 object name). - description: |- - ``S3Location`` is a property of the [AWS::ApiGateway::RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource that specifies the Amazon S3 location of a OpenAPI (formerly Swagger) file that defines a set of RESTful APIs in JSON or YAML. - On January 1, 2016, the Swagger Specification was donated to the [OpenAPI initiative](https://docs.aws.amazon.com/https://www.openapis.org/), becoming the foundation of the OpenAPI Specification. + type: string RestApi: type: object properties: - RestApiId: - type: string - description: '' - RootResourceId: - type: string - description: '' - ApiKeySourceType: - type: string - description: 'The source of the API key for metering requests according to a usage plan. Valid values are: ``HEADER`` to read the API key from the ``X-API-Key`` header of a request. ``AUTHORIZER`` to read the API key from the ``UsageIdentifierKey`` from a custom authorizer.' - BinaryMediaTypes: - type: array - uniqueItems: true - items: - type: string - description: The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads. - Body: + Policy: + description: A policy document that contains the permissions for the ``RestApi`` resource. To set the ARN for the policy, use the ``!Join`` intrinsic function with ``""`` as delimiter and values of ``"execute-api:/"`` and ``"*"``. type: object - description: An OpenAPI specification that defines a set of RESTful APIs in JSON format. For YAML templates, you can also provide the specification in YAML format. BodyS3Location: - $ref: '#/components/schemas/S3Location' description: The Amazon Simple Storage Service (Amazon S3) location that points to an OpenAPI file, which defines a set of RESTful APIs in JSON or YAML format. - CloneFrom: - type: string - description: The ID of the RestApi that you want to clone from. - EndpointConfiguration: - $ref: '#/components/schemas/EndpointConfiguration' - description: A list of the endpoint types of the API. Use this property when creating an API. When importing an existing API, specify the endpoint configuration types using the ``Parameters`` property. + $ref: '#/components/schemas/S3Location' Description: - type: string description: The description of the RestApi. - DisableExecuteApiEndpoint: - type: boolean - description: Specifies whether clients can invoke your API by using the default ``execute-api`` endpoint. By default, clients can invoke your API with the default ``https://{api_id}.execute-api.{region}.amazonaws.com`` endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint - FailOnWarnings: - type: boolean - description: A query parameter to indicate whether to rollback the API update (``true``) or not (``false``) when a warning is encountered. The default value is ``false``. - Name: type: string - description: The name of the RestApi. A name is required if the REST API is not based on an OpenAPI specification. MinimumCompressionSize: - type: integer description: A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size. - Mode: + type: integer + Parameters: + x-patternProperties: + '[a-zA-Z0-9]+': + type: string + description: Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ``ignore=documentation`` as a ``parameters`` value, as in the AWS CLI command of ``aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'``. + additionalProperties: false + type: object + CloneFrom: + description: The ID of the RestApi that you want to clone from. type: string + Mode: description: |- This property applies only when you use OpenAPI to define your REST API. The ``Mode`` determines how API Gateway handles resource updates. Valid values are ``overwrite`` or ``merge``. @@ -1584,22 +1660,43 @@ components: For ``merge``, the new API definition is merged with the existing API. If you don't specify this property, a default value is chosen. For REST APIs created before March 29, 2021, the default is ``overwrite``. For REST APIs created after March 29, 2021, the new API definition takes precedence, but any container types such as endpoint configurations and binary media types are merged with the existing API. Use the default mode to define top-level ``RestApi`` properties in addition to using OpenAPI. Generally, it's preferred to use API Gateway's OpenAPI extensions to model these properties. - Policy: - type: object - description: A policy document that contains the permissions for the ``RestApi`` resource. To set the ARN for the policy, use the ``!Join`` intrinsic function with ``""`` as delimiter and values of ``"execute-api:/"`` and ``"*"``. - Parameters: + type: string + RestApiId: + description: '' + type: string + DisableExecuteApiEndpoint: + description: Specifies whether clients can invoke your API by using the default ``execute-api`` endpoint. By default, clients can invoke your API with the default ``https://{api_id}.execute-api.{region}.amazonaws.com`` endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint + type: boolean + FailOnWarnings: + description: A query parameter to indicate whether to rollback the API update (``true``) or not (``false``) when a warning is encountered. The default value is ``false``. + type: boolean + BinaryMediaTypes: + uniqueItems: true + description: The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads. + type: array + items: + type: string + Name: + description: The name of the RestApi. A name is required if the REST API is not based on an OpenAPI specification. + type: string + RootResourceId: + description: '' + type: string + ApiKeySourceType: + description: 'The source of the API key for metering requests according to a usage plan. Valid values are: ``HEADER`` to read the API key from the ``X-API-Key`` header of a request. ``AUTHORIZER`` to read the API key from the ``UsageIdentifierKey`` from a custom authorizer.' + type: string + EndpointConfiguration: + description: A list of the endpoint types of the API. Use this property when creating an API. When importing an existing API, specify the endpoint configuration types using the ``Parameters`` property. + $ref: '#/components/schemas/EndpointConfiguration' + Body: + description: An OpenAPI specification that defines a set of RESTful APIs in JSON format. For YAML templates, you can also provide the specification in YAML format. type: object - additionalProperties: false - x-patternProperties: - '[a-zA-Z0-9]+': - type: string - description: Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ``ignore=documentation`` as a ``parameters`` value, as in the AWS CLI command of ``aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'``. Tags: - type: array uniqueItems: false + description: The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with ``aws:``. The tag value can be up to 256 characters. + type: array items: $ref: '#/components/schemas/Tag' - description: The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with ``aws:``. The tag value can be up to 256 characters. x-stackql-resource-name: rest_api description: |- The ``AWS::ApiGateway::RestApi`` resource creates a REST API. For more information, see [restapi:create](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateRestApi.html) in the *Amazon API Gateway REST API Reference*. @@ -1618,12 +1715,18 @@ components: - RestApiId - RootResourceId x-tagging: + permissions: + - apigateway:PUT + - apigateway:DELETE + - apigateway:GET taggable: true tagOnCreate: true tagUpdatable: true - cloudFormationSystemTags: true tagProperty: /properties/Tags + cloudFormationSystemTags: true x-required-permissions: + read: + - apigateway:GET create: - apigateway:GET - apigateway:POST @@ -1632,8 +1735,6 @@ components: - apigateway:UpdateRestApiPolicy - s3:GetObject - iam:PassRole - read: - - apigateway:GET update: - apigateway:GET - apigateway:DELETE @@ -1642,10 +1743,10 @@ components: - apigateway:UpdateRestApiPolicy - s3:GetObject - iam:PassRole - delete: - - apigateway:DELETE list: - apigateway:GET + delete: + - apigateway:DELETE Stage: type: object properties: @@ -1722,6 +1823,10 @@ components: tagUpdatable: true cloudFormationSystemTags: true tagProperty: /properties/Tags + permissions: + - apigateway:PUT + - apigateway:DELETE + - apigateway:GET x-required-permissions: create: - apigateway:POST @@ -1834,6 +1939,10 @@ components: tagUpdatable: true cloudFormationSystemTags: true tagProperty: /properties/Tags + permissions: + - apigateway:PUT + - apigateway:DELETE + - apigateway:GET x-required-permissions: create: - apigateway:POST @@ -1888,6 +1997,8 @@ components: - KeyType - UsagePlanId - KeyId + x-tagging: + taggable: false x-required-permissions: create: - apigateway:POST @@ -1903,33 +2014,33 @@ components: type: object properties: Name: - description: A name for the VPC link. + description: The name used to label and identify the VPC link. type: string Description: - description: A description of the VPC link. + description: The description of the VPC link. type: string Tags: - description: An array of arbitrary tags (key-value pairs) to associate with the stage. + description: An array of arbitrary tags (key-value pairs) to associate with the VPC link. x-insertionOrder: false uniqueItems: true type: array items: $ref: '#/components/schemas/Tag' TargetArns: - description: The ARN of network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner. + description: The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS-account of the API owner. type: array uniqueItems: false x-insertionOrder: false items: type: string VpcLinkId: - description: The ID of the instance that backs VPC link. + description: '' type: string required: - Name - TargetArns x-stackql-resource-name: vpc_link - description: Schema for AWS ApiGateway VpcLink + description: The ``AWS::ApiGateway::VpcLink`` resource creates an API Gateway VPC link for a REST API to access resources in an Amazon Virtual Private Cloud (VPC). For more information, see [vpclink:create](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateVpcLink.html) in the ``Amazon API Gateway REST API Reference``. x-type-name: AWS::ApiGateway::VpcLink x-stackql-primary-identifier: - VpcLinkId @@ -2192,23 +2303,23 @@ components: type: object properties: DeploymentId: - type: string description: '' - DeploymentCanarySettings: - $ref: '#/components/schemas/DeploymentCanarySettings' - description: The input configuration for a canary deployment. - Description: type: string + Description: description: The description for the Deployment resource to create. - RestApiId: type: string - description: The string identifier of the associated RestApi. StageDescription: - $ref: '#/components/schemas/StageDescription' description: The description of the Stage resource for the Deployment resource to create. To specify a stage description, you must also provide a stage name. + $ref: '#/components/schemas/StageDescription' StageName: - type: string description: The name of the Stage resource for the Deployment resource to create. + type: string + RestApiId: + description: The string identifier of the associated RestApi. + type: string + DeploymentCanarySettings: + description: The input configuration for a canary deployment. + $ref: '#/components/schemas/DeploymentCanarySettings' x-stackQL-stringOnly: true x-title: CreateDeploymentRequest type: object @@ -2305,12 +2416,55 @@ components: type: string SecurityPolicy: type: string - Tags: - type: array - items: - $ref: '#/components/schemas/Tag' + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateDomainNameRequest + type: object + required: [] + CreateGatewayResponseRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Id: + description: '' + type: string + RestApiId: + description: The string identifier of the associated RestApi. + type: string + ResponseType: + description: The response type of the associated GatewayResponse. + type: string + StatusCode: + description: The HTTP status code for this GatewayResponse. + type: string + ResponseParameters: + description: Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs. + type: object + additionalProperties: false + x-patternProperties: + '[a-zA-Z0-9]+': + type: string + ResponseTemplates: + description: Response templates of the GatewayResponse as a string-to-string map of key-value pairs. + type: object + additionalProperties: false + x-patternProperties: + '[a-zA-Z0-9]+': + type: string x-stackQL-stringOnly: true - x-title: CreateDomainNameRequest + x-title: CreateGatewayResponseRequest type: object required: [] CreateMethodRequest: @@ -2326,68 +2480,63 @@ components: DesiredState: type: object properties: - ApiKeyRequired: - description: A boolean flag specifying whether a valid ApiKey is required to invoke this method. - type: boolean - AuthorizationScopes: - description: >- - A list of authorization scopes configured on the method. The scopes are used with a ``COGNITO_USER_POOLS`` authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must - provide an access token instead of an identity token for authorization purposes. - type: array - items: - type: string - AuthorizationType: - description: |- - The method's authorization type. This parameter is required. For valid values, see [Method](https://docs.aws.amazon.com/apigateway/latest/api/API_Method.html) in the *API Gateway API Reference*. - If you specify the ``AuthorizerId`` property, specify ``CUSTOM`` or ``COGNITO_USER_POOLS`` for this property. - type: string - enum: - - NONE - - AWS_IAM - - CUSTOM - - COGNITO_USER_POOLS - AuthorizerId: - description: The identifier of an authorizer to use on this method. The method's authorization type must be ``CUSTOM`` or ``COGNITO_USER_POOLS``. - type: string - HttpMethod: - description: The method's HTTP verb. - type: string Integration: description: Represents an ``HTTP``, ``HTTP_PROXY``, ``AWS``, ``AWS_PROXY``, or Mock integration. $ref: '#/components/schemas/Integration' - MethodResponses: - description: Gets a method response associated with a given HTTP status code. - type: array - uniqueItems: true - items: - $ref: '#/components/schemas/MethodResponse' OperationName: description: A human-friendly operation identifier for the method. For example, you can assign the ``operationName`` of ``ListPets`` for the ``GET /pets`` method in the ``PetStore`` example. type: string RequestModels: - description: A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key). - type: object - additionalProperties: false x-patternProperties: '[a-zA-Z0-9]+': type: string + description: A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key). + additionalProperties: false + type: object + RestApiId: + description: The string identifier of the associated RestApi. + type: string + AuthorizationScopes: + description: >- + A list of authorization scopes configured on the method. The scopes are used with a ``COGNITO_USER_POOLS`` authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must + provide an access token instead of an identity token for authorization purposes. + type: array + items: + type: string + RequestValidatorId: + description: The identifier of a RequestValidator for request validation. + type: string RequestParameters: + x-patternProperties: + '[a-zA-Z0-9]+': + type: boolean description: >- A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of ``method.request.{location}.{name}``, where ``location`` is ``querystring``, ``path``, or ``header`` and ``name`` is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (``true``) or optional (``false``). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates. - type: object additionalProperties: false - x-patternProperties: - '[a-zA-Z0-9]+': - type: boolean - RequestValidatorId: - description: The identifier of a RequestValidator for request validation. + type: object + MethodResponses: + uniqueItems: true + description: Gets a method response associated with a given HTTP status code. + type: array + items: + $ref: '#/components/schemas/MethodResponse' + AuthorizerId: + description: The identifier of an authorizer to use on this method. The method's authorization type must be ``CUSTOM`` or ``COGNITO_USER_POOLS``. type: string ResourceId: description: The Resource identifier for the MethodResponse resource. type: string - RestApiId: - description: The string identifier of the associated RestApi. + ApiKeyRequired: + description: A boolean flag specifying whether a valid ApiKey is required to invoke this method. + type: boolean + AuthorizationType: + description: |- + The method's authorization type. This parameter is required. For valid values, see [Method](https://docs.aws.amazon.com/apigateway/latest/api/API_Method.html) in the *API Gateway API Reference*. + If you specify the ``AuthorizerId`` property, specify ``CUSTOM`` or ``COGNITO_USER_POOLS`` for this property. + type: string + HttpMethod: + description: The method's HTTP verb. type: string x-stackQL-stringOnly: true x-title: CreateMethodRequest @@ -2472,18 +2621,18 @@ components: DesiredState: type: object properties: - ResourceId: - description: '' - type: string - RestApiId: - description: The string identifier of the associated RestApi. - type: string ParentId: description: The parent resource's identifier. type: string PathPart: description: The last path segment for this resource. type: string + ResourceId: + description: '' + type: string + RestApiId: + description: The string identifier of the associated RestApi. + type: string x-stackQL-stringOnly: true x-title: CreateResourceRequest type: object @@ -2501,50 +2650,29 @@ components: DesiredState: type: object properties: - RestApiId: - type: string - description: '' - RootResourceId: - type: string - description: '' - ApiKeySourceType: - type: string - description: 'The source of the API key for metering requests according to a usage plan. Valid values are: ``HEADER`` to read the API key from the ``X-API-Key`` header of a request. ``AUTHORIZER`` to read the API key from the ``UsageIdentifierKey`` from a custom authorizer.' - BinaryMediaTypes: - type: array - uniqueItems: true - items: - type: string - description: The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads. - Body: + Policy: + description: A policy document that contains the permissions for the ``RestApi`` resource. To set the ARN for the policy, use the ``!Join`` intrinsic function with ``""`` as delimiter and values of ``"execute-api:/"`` and ``"*"``. type: object - description: An OpenAPI specification that defines a set of RESTful APIs in JSON format. For YAML templates, you can also provide the specification in YAML format. BodyS3Location: - $ref: '#/components/schemas/S3Location' description: The Amazon Simple Storage Service (Amazon S3) location that points to an OpenAPI file, which defines a set of RESTful APIs in JSON or YAML format. - CloneFrom: - type: string - description: The ID of the RestApi that you want to clone from. - EndpointConfiguration: - $ref: '#/components/schemas/EndpointConfiguration' - description: A list of the endpoint types of the API. Use this property when creating an API. When importing an existing API, specify the endpoint configuration types using the ``Parameters`` property. + $ref: '#/components/schemas/S3Location' Description: - type: string description: The description of the RestApi. - DisableExecuteApiEndpoint: - type: boolean - description: Specifies whether clients can invoke your API by using the default ``execute-api`` endpoint. By default, clients can invoke your API with the default ``https://{api_id}.execute-api.{region}.amazonaws.com`` endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint - FailOnWarnings: - type: boolean - description: A query parameter to indicate whether to rollback the API update (``true``) or not (``false``) when a warning is encountered. The default value is ``false``. - Name: type: string - description: The name of the RestApi. A name is required if the REST API is not based on an OpenAPI specification. MinimumCompressionSize: - type: integer description: A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size. - Mode: + type: integer + Parameters: + x-patternProperties: + '[a-zA-Z0-9]+': + type: string + description: Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ``ignore=documentation`` as a ``parameters`` value, as in the AWS CLI command of ``aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'``. + additionalProperties: false + type: object + CloneFrom: + description: The ID of the RestApi that you want to clone from. type: string + Mode: description: |- This property applies only when you use OpenAPI to define your REST API. The ``Mode`` determines how API Gateway handles resource updates. Valid values are ``overwrite`` or ``merge``. @@ -2552,22 +2680,43 @@ components: For ``merge``, the new API definition is merged with the existing API. If you don't specify this property, a default value is chosen. For REST APIs created before March 29, 2021, the default is ``overwrite``. For REST APIs created after March 29, 2021, the new API definition takes precedence, but any container types such as endpoint configurations and binary media types are merged with the existing API. Use the default mode to define top-level ``RestApi`` properties in addition to using OpenAPI. Generally, it's preferred to use API Gateway's OpenAPI extensions to model these properties. - Policy: - type: object - description: A policy document that contains the permissions for the ``RestApi`` resource. To set the ARN for the policy, use the ``!Join`` intrinsic function with ``""`` as delimiter and values of ``"execute-api:/"`` and ``"*"``. - Parameters: + type: string + RestApiId: + description: '' + type: string + DisableExecuteApiEndpoint: + description: Specifies whether clients can invoke your API by using the default ``execute-api`` endpoint. By default, clients can invoke your API with the default ``https://{api_id}.execute-api.{region}.amazonaws.com`` endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint + type: boolean + FailOnWarnings: + description: A query parameter to indicate whether to rollback the API update (``true``) or not (``false``) when a warning is encountered. The default value is ``false``. + type: boolean + BinaryMediaTypes: + uniqueItems: true + description: The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads. + type: array + items: + type: string + Name: + description: The name of the RestApi. A name is required if the REST API is not based on an OpenAPI specification. + type: string + RootResourceId: + description: '' + type: string + ApiKeySourceType: + description: 'The source of the API key for metering requests according to a usage plan. Valid values are: ``HEADER`` to read the API key from the ``X-API-Key`` header of a request. ``AUTHORIZER`` to read the API key from the ``UsageIdentifierKey`` from a custom authorizer.' + type: string + EndpointConfiguration: + description: A list of the endpoint types of the API. Use this property when creating an API. When importing an existing API, specify the endpoint configuration types using the ``Parameters`` property. + $ref: '#/components/schemas/EndpointConfiguration' + Body: + description: An OpenAPI specification that defines a set of RESTful APIs in JSON format. For YAML templates, you can also provide the specification in YAML format. type: object - additionalProperties: false - x-patternProperties: - '[a-zA-Z0-9]+': - type: string - description: Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ``ignore=documentation`` as a ``parameters`` value, as in the AWS CLI command of ``aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'``. Tags: - type: array uniqueItems: false + description: The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with ``aws:``. The tag value can be up to 256 characters. + type: array items: $ref: '#/components/schemas/Tag' - description: The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with ``aws:``. The tag value can be up to 256 characters. x-stackQL-stringOnly: true x-title: CreateRestApiRequest type: object @@ -2733,27 +2882,27 @@ components: type: object properties: Name: - description: A name for the VPC link. + description: The name used to label and identify the VPC link. type: string Description: - description: A description of the VPC link. + description: The description of the VPC link. type: string Tags: - description: An array of arbitrary tags (key-value pairs) to associate with the stage. + description: An array of arbitrary tags (key-value pairs) to associate with the VPC link. x-insertionOrder: false uniqueItems: true type: array items: $ref: '#/components/schemas/Tag' TargetArns: - description: The ARN of network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner. + description: The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS-account of the API owner. type: array uniqueItems: false x-insertionOrder: false items: type: string VpcLinkId: - description: The ID of the instance that backs VPC link. + description: '' type: string x-stackQL-stringOnly: true x-title: CreateVpcLinkRequest @@ -2774,7 +2923,7 @@ components: x-cfn-type-name: AWS::ApiGateway::Account x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2791,19 +2940,6 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/accounts/methods/create_resource' - delete: [] - account: - name: account - id: aws.apigateway.account - x-cfn-schema-name: Account - x-cfn-type-name: AWS::ApiGateway::Account - x-identifiers: - - Id - x-type: get - methods: update_resource: operation: $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' @@ -2816,13 +2952,29 @@ components: response: mediaType: application/json openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::Account" + } + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/accounts/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/accounts/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/account/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/accounts/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2833,7 +2985,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2850,7 +3002,7 @@ components: x-cfn-type-name: AWS::ApiGateway::ApiKey x-identifiers: - APIKeyId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2867,53 +3019,21 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: - mediaType: application/x-amz-json-1.0 - base: |- - { - "TypeName": "AWS::ApiGateway::ApiKey" - } - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/api_keys/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/api_keys/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.APIKeyId') as api_key_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::ApiKey' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'APIKeyId') as api_key_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::ApiKey' - AND region = 'us-east-1' - api_key: - name: api_key - id: aws.apigateway.api_key - x-cfn-schema-name: ApiKey - x-cfn-type-name: AWS::ApiGateway::ApiKey - x-identifiers: - - APIKeyId - x-type: get - methods: - update_resource: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::ApiKey" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2924,12 +3044,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/api_keys/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/api_keys/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/api_key/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/api_keys/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2947,23 +3071,39 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'APIKeyId') as api_key_id, - json_extract_path_text(Properties, 'CustomerId') as customer_id, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Enabled') as enabled, - json_extract_path_text(Properties, 'GenerateDistinctId') as generate_distinct_id, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'StageKeys') as stage_keys, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Value') as value - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::ApiKey' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.APIKeyId') as api_key_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::ApiKey' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'APIKeyId') as api_key_id, + json_extract_path_text(Properties, 'CustomerId') as customer_id, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Enabled') as enabled, + json_extract_path_text(Properties, 'GenerateDistinctId') as generate_distinct_id, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'StageKeys') as stage_keys, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Value') as value + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::ApiKey' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'APIKeyId') as api_key_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::ApiKey' + AND region = 'us-east-1' authorizers: name: authorizers id: aws.apigateway.authorizers @@ -2972,7 +3112,7 @@ components: x-identifiers: - RestApiId - AuthorizerId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2989,9 +3129,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3001,44 +3141,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/authorizers/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/authorizers/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.RestApiId') as rest_api_id, - JSON_EXTRACT(Properties, '$.AuthorizerId') as authorizer_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::Authorizer' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'RestApiId') as rest_api_id, - json_extract_path_text(Properties, 'AuthorizerId') as authorizer_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::Authorizer' - AND region = 'us-east-1' - authorizer: - name: authorizer - id: aws.apigateway.authorizer - x-cfn-schema-name: Authorizer - x-cfn-type-name: AWS::ApiGateway::Authorizer - x-identifiers: - - RestApiId - - AuthorizerId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3049,12 +3154,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/authorizers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/authorizers/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/authorizer/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/authorizers/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3074,25 +3183,43 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'RestApiId') as rest_api_id, - json_extract_path_text(Properties, 'AuthorizerId') as authorizer_id, - json_extract_path_text(Properties, 'AuthType') as auth_type, - json_extract_path_text(Properties, 'AuthorizerCredentials') as authorizer_credentials, - json_extract_path_text(Properties, 'AuthorizerResultTtlInSeconds') as authorizer_result_ttl_in_seconds, - json_extract_path_text(Properties, 'AuthorizerUri') as authorizer_uri, - json_extract_path_text(Properties, 'IdentitySource') as identity_source, - json_extract_path_text(Properties, 'IdentityValidationExpression') as identity_validation_expression, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'ProviderARNs') as provider_arns, - json_extract_path_text(Properties, 'Type') as type - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::Authorizer' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.RestApiId') as rest_api_id, + JSON_EXTRACT(Properties, '$.AuthorizerId') as authorizer_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::Authorizer' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'RestApiId') as rest_api_id, + json_extract_path_text(Properties, 'AuthorizerId') as authorizer_id, + json_extract_path_text(Properties, 'AuthType') as auth_type, + json_extract_path_text(Properties, 'AuthorizerCredentials') as authorizer_credentials, + json_extract_path_text(Properties, 'AuthorizerResultTtlInSeconds') as authorizer_result_ttl_in_seconds, + json_extract_path_text(Properties, 'AuthorizerUri') as authorizer_uri, + json_extract_path_text(Properties, 'IdentitySource') as identity_source, + json_extract_path_text(Properties, 'IdentityValidationExpression') as identity_validation_expression, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'ProviderARNs') as provider_arns, + json_extract_path_text(Properties, 'Type') as type + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::Authorizer' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'RestApiId') as rest_api_id, + json_extract_path_text(Properties, 'AuthorizerId') as authorizer_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::Authorizer' + AND region = 'us-east-1' base_path_mappings: name: base_path_mappings id: aws.apigateway.base_path_mappings @@ -3101,7 +3228,7 @@ components: x-identifiers: - DomainName - BasePath - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3118,9 +3245,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3130,44 +3257,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/base_path_mappings/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/base_path_mappings/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.DomainName') as domain_name, - JSON_EXTRACT(Properties, '$.BasePath') as base_path - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::BasePathMapping' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'DomainName') as domain_name, - json_extract_path_text(Properties, 'BasePath') as base_path - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::BasePathMapping' - AND region = 'us-east-1' - base_path_mapping: - name: base_path_mapping - id: aws.apigateway.base_path_mapping - x-cfn-schema-name: BasePathMapping - x-cfn-type-name: AWS::ApiGateway::BasePathMapping - x-identifiers: - - DomainName - - BasePath - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3178,12 +3270,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/base_path_mappings/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/base_path_mappings/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/base_path_mapping/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/base_path_mappings/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3196,18 +3292,36 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'BasePath') as base_path, - json_extract_path_text(Properties, 'DomainName') as domain_name, - json_extract_path_text(Properties, 'RestApiId') as rest_api_id, - json_extract_path_text(Properties, 'Stage') as stage - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::BasePathMapping' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.DomainName') as domain_name, + JSON_EXTRACT(Properties, '$.BasePath') as base_path + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::BasePathMapping' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'BasePath') as base_path, + json_extract_path_text(Properties, 'DomainName') as domain_name, + json_extract_path_text(Properties, 'RestApiId') as rest_api_id, + json_extract_path_text(Properties, 'Stage') as stage + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::BasePathMapping' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DomainName') as domain_name, + json_extract_path_text(Properties, 'BasePath') as base_path + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::BasePathMapping' + AND region = 'us-east-1' client_certificates: name: client_certificates id: aws.apigateway.client_certificates @@ -3215,7 +3329,7 @@ components: x-cfn-type-name: AWS::ApiGateway::ClientCertificate x-identifiers: - ClientCertificateId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3232,9 +3346,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3244,41 +3358,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/client_certificates/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/client_certificates/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ClientCertificateId') as client_certificate_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::ClientCertificate' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ClientCertificateId') as client_certificate_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::ClientCertificate' - AND region = 'us-east-1' - client_certificate: - name: client_certificate - id: aws.apigateway.client_certificate - x-cfn-schema-name: ClientCertificate - x-cfn-type-name: AWS::ApiGateway::ClientCertificate - x-identifiers: - - ClientCertificateId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3289,12 +3371,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/client_certificates/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/client_certificates/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/client_certificate/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/client_certificates/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3306,17 +3392,33 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ClientCertificateId') as client_certificate_id, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::ClientCertificate' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ClientCertificateId') as client_certificate_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::ClientCertificate' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ClientCertificateId') as client_certificate_id, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::ClientCertificate' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ClientCertificateId') as client_certificate_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::ClientCertificate' + AND region = 'us-east-1' deployments: name: deployments id: aws.apigateway.deployments @@ -3325,7 +3427,7 @@ components: x-identifiers: - DeploymentId - RestApiId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3342,9 +3444,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3354,44 +3456,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/deployments/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/deployments/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.DeploymentId') as deployment_id, - JSON_EXTRACT(Properties, '$.RestApiId') as rest_api_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::Deployment' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'DeploymentId') as deployment_id, - json_extract_path_text(Properties, 'RestApiId') as rest_api_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::Deployment' - AND region = 'us-east-1' - deployment: - name: deployment - id: aws.apigateway.deployment - x-cfn-schema-name: Deployment - x-cfn-type-name: AWS::ApiGateway::Deployment - x-identifiers: - - DeploymentId - - RestApiId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3402,40 +3469,62 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/deployments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/deployments/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/deployment/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/deployments/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, JSON_EXTRACT(Properties, '$.DeploymentId') as deployment_id, - JSON_EXTRACT(Properties, '$.DeploymentCanarySettings') as deployment_canary_settings, JSON_EXTRACT(Properties, '$.Description') as description, - JSON_EXTRACT(Properties, '$.RestApiId') as rest_api_id, JSON_EXTRACT(Properties, '$.StageDescription') as stage_description, - JSON_EXTRACT(Properties, '$.StageName') as stage_name + JSON_EXTRACT(Properties, '$.StageName') as stage_name, + JSON_EXTRACT(Properties, '$.RestApiId') as rest_api_id, + JSON_EXTRACT(Properties, '$.DeploymentCanarySettings') as deployment_canary_settings FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::Deployment' AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'DeploymentId') as deployment_id, - json_extract_path_text(Properties, 'DeploymentCanarySettings') as deployment_canary_settings, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'RestApiId') as rest_api_id, - json_extract_path_text(Properties, 'StageDescription') as stage_description, - json_extract_path_text(Properties, 'StageName') as stage_name - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::Deployment' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.DeploymentId') as deployment_id, + JSON_EXTRACT(Properties, '$.RestApiId') as rest_api_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::Deployment' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DeploymentId') as deployment_id, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'StageDescription') as stage_description, + json_extract_path_text(Properties, 'StageName') as stage_name, + json_extract_path_text(Properties, 'RestApiId') as rest_api_id, + json_extract_path_text(Properties, 'DeploymentCanarySettings') as deployment_canary_settings + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::Deployment' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DeploymentId') as deployment_id, + json_extract_path_text(Properties, 'RestApiId') as rest_api_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::Deployment' + AND region = 'us-east-1' documentation_parts: name: documentation_parts id: aws.apigateway.documentation_parts @@ -3444,7 +3533,7 @@ components: x-identifiers: - DocumentationPartId - RestApiId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3461,9 +3550,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3473,44 +3562,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/documentation_parts/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/documentation_parts/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.DocumentationPartId') as documentation_part_id, - JSON_EXTRACT(Properties, '$.RestApiId') as rest_api_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::DocumentationPart' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'DocumentationPartId') as documentation_part_id, - json_extract_path_text(Properties, 'RestApiId') as rest_api_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::DocumentationPart' - AND region = 'us-east-1' - documentation_part: - name: documentation_part - id: aws.apigateway.documentation_part - x-cfn-schema-name: DocumentationPart - x-cfn-type-name: AWS::ApiGateway::DocumentationPart - x-identifiers: - - DocumentationPartId - - RestApiId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3521,12 +3575,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/documentation_parts/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/documentation_parts/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/documentation_part/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/documentation_parts/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3539,18 +3597,36 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'DocumentationPartId') as documentation_part_id, - json_extract_path_text(Properties, 'Location') as location, - json_extract_path_text(Properties, 'Properties') as properties, - json_extract_path_text(Properties, 'RestApiId') as rest_api_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::DocumentationPart' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.DocumentationPartId') as documentation_part_id, + JSON_EXTRACT(Properties, '$.RestApiId') as rest_api_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::DocumentationPart' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DocumentationPartId') as documentation_part_id, + json_extract_path_text(Properties, 'Location') as location, + json_extract_path_text(Properties, 'Properties') as properties, + json_extract_path_text(Properties, 'RestApiId') as rest_api_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::DocumentationPart' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DocumentationPartId') as documentation_part_id, + json_extract_path_text(Properties, 'RestApiId') as rest_api_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::DocumentationPart' + AND region = 'us-east-1' documentation_versions: name: documentation_versions id: aws.apigateway.documentation_versions @@ -3559,7 +3635,7 @@ components: x-identifiers: - DocumentationVersion - RestApiId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3576,56 +3652,21 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- { - "TypeName": "AWS::ApiGateway::DocumentationVersion" - } - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/documentation_versions/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/documentation_versions/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.DocumentationVersion') as documentation_version, - JSON_EXTRACT(Properties, '$.RestApiId') as rest_api_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::DocumentationVersion' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'DocumentationVersion') as documentation_version, - json_extract_path_text(Properties, 'RestApiId') as rest_api_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::DocumentationVersion' - AND region = 'us-east-1' - documentation_version: - name: documentation_version - id: aws.apigateway.documentation_version - x-cfn-schema-name: DocumentationVersion - x-cfn-type-name: AWS::ApiGateway::DocumentationVersion - x-identifiers: - - DocumentationVersion - - RestApiId - x-type: get - methods: - update_resource: + "TypeName": "AWS::ApiGateway::DocumentationVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3636,12 +3677,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/documentation_versions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/documentation_versions/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/documentation_version/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/documentation_versions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3653,17 +3698,35 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'DocumentationVersion') as documentation_version, - json_extract_path_text(Properties, 'RestApiId') as rest_api_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::DocumentationVersion' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.DocumentationVersion') as documentation_version, + JSON_EXTRACT(Properties, '$.RestApiId') as rest_api_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::DocumentationVersion' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'DocumentationVersion') as documentation_version, + json_extract_path_text(Properties, 'RestApiId') as rest_api_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::DocumentationVersion' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DocumentationVersion') as documentation_version, + json_extract_path_text(Properties, 'RestApiId') as rest_api_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::DocumentationVersion' + AND region = 'us-east-1' domain_names: name: domain_names id: aws.apigateway.domain_names @@ -3671,7 +3734,7 @@ components: x-cfn-type-name: AWS::ApiGateway::DomainName x-identifiers: - DomainName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3688,6 +3751,18 @@ components: response: mediaType: application/json openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::DomainName" + } + response: + mediaType: application/json + openAPIDocKey: '200' delete_resource: operation: $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' @@ -3705,33 +3780,92 @@ components: - $ref: '#/components/x-stackQL-resources/domain_names/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/domain_names/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/domain_names/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.DomainName') as domain_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::DomainName' + data__Identifier, + JSON_EXTRACT(Properties, '$.DomainName') as domain_name, + JSON_EXTRACT(Properties, '$.DistributionDomainName') as distribution_domain_name, + JSON_EXTRACT(Properties, '$.DistributionHostedZoneId') as distribution_hosted_zone_id, + JSON_EXTRACT(Properties, '$.EndpointConfiguration') as endpoint_configuration, + JSON_EXTRACT(Properties, '$.MutualTlsAuthentication') as mutual_tls_authentication, + JSON_EXTRACT(Properties, '$.RegionalDomainName') as regional_domain_name, + JSON_EXTRACT(Properties, '$.RegionalHostedZoneId') as regional_hosted_zone_id, + JSON_EXTRACT(Properties, '$.CertificateArn') as certificate_arn, + JSON_EXTRACT(Properties, '$.RegionalCertificateArn') as regional_certificate_arn, + JSON_EXTRACT(Properties, '$.OwnershipVerificationCertificateArn') as ownership_verification_certificate_arn, + JSON_EXTRACT(Properties, '$.SecurityPolicy') as security_policy, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::DomainName' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - json_extract_path_text(Properties, 'DomainName') as domain_name + JSON_EXTRACT(Properties, '$.DomainName') as domain_name FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::DomainName' AND region = 'us-east-1' - domain_name: - name: domain_name - id: aws.apigateway.domain_name - x-cfn-schema-name: DomainName - x-cfn-type-name: AWS::ApiGateway::DomainName + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DomainName') as domain_name, + json_extract_path_text(Properties, 'DistributionDomainName') as distribution_domain_name, + json_extract_path_text(Properties, 'DistributionHostedZoneId') as distribution_hosted_zone_id, + json_extract_path_text(Properties, 'EndpointConfiguration') as endpoint_configuration, + json_extract_path_text(Properties, 'MutualTlsAuthentication') as mutual_tls_authentication, + json_extract_path_text(Properties, 'RegionalDomainName') as regional_domain_name, + json_extract_path_text(Properties, 'RegionalHostedZoneId') as regional_hosted_zone_id, + json_extract_path_text(Properties, 'CertificateArn') as certificate_arn, + json_extract_path_text(Properties, 'RegionalCertificateArn') as regional_certificate_arn, + json_extract_path_text(Properties, 'OwnershipVerificationCertificateArn') as ownership_verification_certificate_arn, + json_extract_path_text(Properties, 'SecurityPolicy') as security_policy, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::DomainName' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DomainName') as domain_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::DomainName' + AND region = 'us-east-1' + gateway_responses: + name: gateway_responses + id: aws.apigateway.gateway_responses + x-cfn-schema-name: GatewayResponse + x-cfn-type-name: AWS::ApiGateway::GatewayResponse x-identifiers: - - DomainName - x-type: get + - Id + x-type: cloud_control methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__GatewayResponse&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::GatewayResponse" + } + response: + mediaType: application/json + openAPIDocKey: '200' update_resource: operation: $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' @@ -3739,58 +3873,78 @@ components: mediaType: application/x-amz-json-1.0 base: |- { - "TypeName": "AWS::ApiGateway::DomainName" + "TypeName": "AWS::ApiGateway::GatewayResponse" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ApiGateway::GatewayResponse" } response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/gateway_responses/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/gateway_responses/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/domain_name/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/gateway_responses/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.DomainName') as domain_name, - JSON_EXTRACT(Properties, '$.DistributionDomainName') as distribution_domain_name, - JSON_EXTRACT(Properties, '$.DistributionHostedZoneId') as distribution_hosted_zone_id, - JSON_EXTRACT(Properties, '$.EndpointConfiguration') as endpoint_configuration, - JSON_EXTRACT(Properties, '$.MutualTlsAuthentication') as mutual_tls_authentication, - JSON_EXTRACT(Properties, '$.RegionalDomainName') as regional_domain_name, - JSON_EXTRACT(Properties, '$.RegionalHostedZoneId') as regional_hosted_zone_id, - JSON_EXTRACT(Properties, '$.CertificateArn') as certificate_arn, - JSON_EXTRACT(Properties, '$.RegionalCertificateArn') as regional_certificate_arn, - JSON_EXTRACT(Properties, '$.OwnershipVerificationCertificateArn') as ownership_verification_certificate_arn, - JSON_EXTRACT(Properties, '$.SecurityPolicy') as security_policy, - JSON_EXTRACT(Properties, '$.Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::DomainName' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.RestApiId') as rest_api_id, + JSON_EXTRACT(Properties, '$.ResponseType') as response_type, + JSON_EXTRACT(Properties, '$.StatusCode') as status_code, + JSON_EXTRACT(Properties, '$.ResponseParameters') as response_parameters, + JSON_EXTRACT(Properties, '$.ResponseTemplates') as response_templates + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::GatewayResponse' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'DomainName') as domain_name, - json_extract_path_text(Properties, 'DistributionDomainName') as distribution_domain_name, - json_extract_path_text(Properties, 'DistributionHostedZoneId') as distribution_hosted_zone_id, - json_extract_path_text(Properties, 'EndpointConfiguration') as endpoint_configuration, - json_extract_path_text(Properties, 'MutualTlsAuthentication') as mutual_tls_authentication, - json_extract_path_text(Properties, 'RegionalDomainName') as regional_domain_name, - json_extract_path_text(Properties, 'RegionalHostedZoneId') as regional_hosted_zone_id, - json_extract_path_text(Properties, 'CertificateArn') as certificate_arn, - json_extract_path_text(Properties, 'RegionalCertificateArn') as regional_certificate_arn, - json_extract_path_text(Properties, 'OwnershipVerificationCertificateArn') as ownership_verification_certificate_arn, - json_extract_path_text(Properties, 'SecurityPolicy') as security_policy, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::DomainName' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::GatewayResponse' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'RestApiId') as rest_api_id, + json_extract_path_text(Properties, 'ResponseType') as response_type, + json_extract_path_text(Properties, 'StatusCode') as status_code, + json_extract_path_text(Properties, 'ResponseParameters') as response_parameters, + json_extract_path_text(Properties, 'ResponseTemplates') as response_templates + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::GatewayResponse' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::GatewayResponse' + AND region = 'us-east-1' methods: name: methods id: aws.apigateway.methods @@ -3800,7 +3954,7 @@ components: - RestApiId - ResourceId - HttpMethod - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3817,9 +3971,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3829,25 +3983,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/methods/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/methods/methods/delete_resource' - method: - name: method - id: aws.apigateway.method - x-cfn-schema-name: Method - x-cfn-type-name: AWS::ApiGateway::Method - x-identifiers: - - RestApiId - - ResourceId - - HttpMethod - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3858,51 +3996,55 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/methods/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/methods/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/method/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/methods/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.ApiKeyRequired') as api_key_required, - JSON_EXTRACT(Properties, '$.AuthorizationScopes') as authorization_scopes, - JSON_EXTRACT(Properties, '$.AuthorizationType') as authorization_type, - JSON_EXTRACT(Properties, '$.AuthorizerId') as authorizer_id, - JSON_EXTRACT(Properties, '$.HttpMethod') as http_method, JSON_EXTRACT(Properties, '$.Integration') as integration, - JSON_EXTRACT(Properties, '$.MethodResponses') as method_responses, JSON_EXTRACT(Properties, '$.OperationName') as operation_name, JSON_EXTRACT(Properties, '$.RequestModels') as request_models, - JSON_EXTRACT(Properties, '$.RequestParameters') as request_parameters, + JSON_EXTRACT(Properties, '$.RestApiId') as rest_api_id, + JSON_EXTRACT(Properties, '$.AuthorizationScopes') as authorization_scopes, JSON_EXTRACT(Properties, '$.RequestValidatorId') as request_validator_id, + JSON_EXTRACT(Properties, '$.RequestParameters') as request_parameters, + JSON_EXTRACT(Properties, '$.MethodResponses') as method_responses, + JSON_EXTRACT(Properties, '$.AuthorizerId') as authorizer_id, JSON_EXTRACT(Properties, '$.ResourceId') as resource_id, - JSON_EXTRACT(Properties, '$.RestApiId') as rest_api_id + JSON_EXTRACT(Properties, '$.ApiKeyRequired') as api_key_required, + JSON_EXTRACT(Properties, '$.AuthorizationType') as authorization_type, + JSON_EXTRACT(Properties, '$.HttpMethod') as http_method FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::Method' AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - json_extract_path_text(Properties, 'ApiKeyRequired') as api_key_required, - json_extract_path_text(Properties, 'AuthorizationScopes') as authorization_scopes, - json_extract_path_text(Properties, 'AuthorizationType') as authorization_type, - json_extract_path_text(Properties, 'AuthorizerId') as authorizer_id, - json_extract_path_text(Properties, 'HttpMethod') as http_method, json_extract_path_text(Properties, 'Integration') as integration, - json_extract_path_text(Properties, 'MethodResponses') as method_responses, json_extract_path_text(Properties, 'OperationName') as operation_name, json_extract_path_text(Properties, 'RequestModels') as request_models, - json_extract_path_text(Properties, 'RequestParameters') as request_parameters, + json_extract_path_text(Properties, 'RestApiId') as rest_api_id, + json_extract_path_text(Properties, 'AuthorizationScopes') as authorization_scopes, json_extract_path_text(Properties, 'RequestValidatorId') as request_validator_id, + json_extract_path_text(Properties, 'RequestParameters') as request_parameters, + json_extract_path_text(Properties, 'MethodResponses') as method_responses, + json_extract_path_text(Properties, 'AuthorizerId') as authorizer_id, json_extract_path_text(Properties, 'ResourceId') as resource_id, - json_extract_path_text(Properties, 'RestApiId') as rest_api_id + json_extract_path_text(Properties, 'ApiKeyRequired') as api_key_required, + json_extract_path_text(Properties, 'AuthorizationType') as authorization_type, + json_extract_path_text(Properties, 'HttpMethod') as http_method FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::Method' AND data__Identifier = '||' AND region = 'us-east-1' @@ -3914,7 +4056,7 @@ components: x-identifiers: - RestApiId - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3931,9 +4073,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3943,44 +4085,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/models/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/models/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.RestApiId') as rest_api_id, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::Model' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'RestApiId') as rest_api_id, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::Model' - AND region = 'us-east-1' - model: - name: model - id: aws.apigateway.model - x-cfn-schema-name: Model - x-cfn-type-name: AWS::ApiGateway::Model - x-identifiers: - - RestApiId - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3991,12 +4098,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/models/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/models/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/model/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/models/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -4010,19 +4121,37 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ContentType') as content_type, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'RestApiId') as rest_api_id, - json_extract_path_text(Properties, 'Schema') as _schema - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::Model' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.RestApiId') as rest_api_id, + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::Model' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ContentType') as content_type, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'RestApiId') as rest_api_id, + json_extract_path_text(Properties, 'Schema') as _schema + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::Model' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'RestApiId') as rest_api_id, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::Model' + AND region = 'us-east-1' request_validators: name: request_validators id: aws.apigateway.request_validators @@ -4031,7 +4160,7 @@ components: x-identifiers: - RestApiId - RequestValidatorId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -4048,9 +4177,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -4060,44 +4189,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/request_validators/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/request_validators/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.RestApiId') as rest_api_id, - JSON_EXTRACT(Properties, '$.RequestValidatorId') as request_validator_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::RequestValidator' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'RestApiId') as rest_api_id, - json_extract_path_text(Properties, 'RequestValidatorId') as request_validator_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::RequestValidator' - AND region = 'us-east-1' - request_validator: - name: request_validator - id: aws.apigateway.request_validator - x-cfn-schema-name: RequestValidator - x-cfn-type-name: AWS::ApiGateway::RequestValidator - x-identifiers: - - RestApiId - - RequestValidatorId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -4108,12 +4202,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/request_validators/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/request_validators/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/request_validator/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/request_validators/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -4127,19 +4225,37 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'RequestValidatorId') as request_validator_id, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'RestApiId') as rest_api_id, - json_extract_path_text(Properties, 'ValidateRequestBody') as validate_request_body, - json_extract_path_text(Properties, 'ValidateRequestParameters') as validate_request_parameters - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::RequestValidator' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.RestApiId') as rest_api_id, + JSON_EXTRACT(Properties, '$.RequestValidatorId') as request_validator_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::RequestValidator' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'RequestValidatorId') as request_validator_id, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'RestApiId') as rest_api_id, + json_extract_path_text(Properties, 'ValidateRequestBody') as validate_request_body, + json_extract_path_text(Properties, 'ValidateRequestParameters') as validate_request_parameters + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::RequestValidator' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'RestApiId') as rest_api_id, + json_extract_path_text(Properties, 'RequestValidatorId') as request_validator_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::RequestValidator' + AND region = 'us-east-1' resources: name: resources id: aws.apigateway.resources @@ -4148,7 +4264,7 @@ components: x-identifiers: - RestApiId - ResourceId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -4165,9 +4281,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -4177,44 +4293,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/resources/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/resources/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.RestApiId') as rest_api_id, - JSON_EXTRACT(Properties, '$.ResourceId') as resource_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::Resource' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'RestApiId') as rest_api_id, - json_extract_path_text(Properties, 'ResourceId') as resource_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::Resource' - AND region = 'us-east-1' - resource: - name: resource - id: aws.apigateway.resource - x-cfn-schema-name: Resource - x-cfn-type-name: AWS::ApiGateway::Resource - x-identifiers: - - RestApiId - - ResourceId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -4225,36 +4306,58 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/resources/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/resources/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/resource/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/resources/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.ResourceId') as resource_id, - JSON_EXTRACT(Properties, '$.RestApiId') as rest_api_id, JSON_EXTRACT(Properties, '$.ParentId') as parent_id, - JSON_EXTRACT(Properties, '$.PathPart') as path_part + JSON_EXTRACT(Properties, '$.PathPart') as path_part, + JSON_EXTRACT(Properties, '$.ResourceId') as resource_id, + JSON_EXTRACT(Properties, '$.RestApiId') as rest_api_id FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::Resource' AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ResourceId') as resource_id, - json_extract_path_text(Properties, 'RestApiId') as rest_api_id, - json_extract_path_text(Properties, 'ParentId') as parent_id, - json_extract_path_text(Properties, 'PathPart') as path_part - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::Resource' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.RestApiId') as rest_api_id, + JSON_EXTRACT(Properties, '$.ResourceId') as resource_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::Resource' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ParentId') as parent_id, + json_extract_path_text(Properties, 'PathPart') as path_part, + json_extract_path_text(Properties, 'ResourceId') as resource_id, + json_extract_path_text(Properties, 'RestApiId') as rest_api_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::Resource' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'RestApiId') as rest_api_id, + json_extract_path_text(Properties, 'ResourceId') as resource_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::Resource' + AND region = 'us-east-1' rest_apis: name: rest_apis id: aws.apigateway.rest_apis @@ -4262,7 +4365,7 @@ components: x-cfn-type-name: AWS::ApiGateway::RestApi x-identifiers: - RestApiId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -4279,9 +4382,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -4291,41 +4394,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/rest_apis/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/rest_apis/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.RestApiId') as rest_api_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::RestApi' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'RestApiId') as rest_api_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::RestApi' - AND region = 'us-east-1' - rest_api: - name: rest_api - id: aws.apigateway.rest_api - x-cfn-schema-name: RestApi - x-cfn-type-name: AWS::ApiGateway::RestApi - x-identifiers: - - RestApiId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -4336,62 +4407,82 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/rest_apis/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/rest_apis/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/rest_api/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/rest_apis/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.RestApiId') as rest_api_id, - JSON_EXTRACT(Properties, '$.RootResourceId') as root_resource_id, - JSON_EXTRACT(Properties, '$.ApiKeySourceType') as api_key_source_type, - JSON_EXTRACT(Properties, '$.BinaryMediaTypes') as binary_media_types, - JSON_EXTRACT(Properties, '$.Body') as body, + JSON_EXTRACT(Properties, '$.Policy') as policy, JSON_EXTRACT(Properties, '$.BodyS3Location') as body_s3_location, - JSON_EXTRACT(Properties, '$.CloneFrom') as clone_from, - JSON_EXTRACT(Properties, '$.EndpointConfiguration') as endpoint_configuration, JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.MinimumCompressionSize') as minimum_compression_size, + JSON_EXTRACT(Properties, '$.Parameters') as parameters, + JSON_EXTRACT(Properties, '$.CloneFrom') as clone_from, + JSON_EXTRACT(Properties, '$.Mode') as mode, + JSON_EXTRACT(Properties, '$.RestApiId') as rest_api_id, JSON_EXTRACT(Properties, '$.DisableExecuteApiEndpoint') as disable_execute_api_endpoint, JSON_EXTRACT(Properties, '$.FailOnWarnings') as fail_on_warnings, + JSON_EXTRACT(Properties, '$.BinaryMediaTypes') as binary_media_types, JSON_EXTRACT(Properties, '$.Name') as name, - JSON_EXTRACT(Properties, '$.MinimumCompressionSize') as minimum_compression_size, - JSON_EXTRACT(Properties, '$.Mode') as mode, - JSON_EXTRACT(Properties, '$.Policy') as policy, - JSON_EXTRACT(Properties, '$.Parameters') as parameters, + JSON_EXTRACT(Properties, '$.RootResourceId') as root_resource_id, + JSON_EXTRACT(Properties, '$.ApiKeySourceType') as api_key_source_type, + JSON_EXTRACT(Properties, '$.EndpointConfiguration') as endpoint_configuration, + JSON_EXTRACT(Properties, '$.Body') as body, JSON_EXTRACT(Properties, '$.Tags') as tags FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::RestApi' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'RestApiId') as rest_api_id, - json_extract_path_text(Properties, 'RootResourceId') as root_resource_id, - json_extract_path_text(Properties, 'ApiKeySourceType') as api_key_source_type, - json_extract_path_text(Properties, 'BinaryMediaTypes') as binary_media_types, - json_extract_path_text(Properties, 'Body') as body, - json_extract_path_text(Properties, 'BodyS3Location') as body_s3_location, - json_extract_path_text(Properties, 'CloneFrom') as clone_from, - json_extract_path_text(Properties, 'EndpointConfiguration') as endpoint_configuration, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'DisableExecuteApiEndpoint') as disable_execute_api_endpoint, - json_extract_path_text(Properties, 'FailOnWarnings') as fail_on_warnings, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'MinimumCompressionSize') as minimum_compression_size, - json_extract_path_text(Properties, 'Mode') as mode, - json_extract_path_text(Properties, 'Policy') as policy, - json_extract_path_text(Properties, 'Parameters') as parameters, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::RestApi' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.RestApiId') as rest_api_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::RestApi' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Policy') as policy, + json_extract_path_text(Properties, 'BodyS3Location') as body_s3_location, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'MinimumCompressionSize') as minimum_compression_size, + json_extract_path_text(Properties, 'Parameters') as parameters, + json_extract_path_text(Properties, 'CloneFrom') as clone_from, + json_extract_path_text(Properties, 'Mode') as mode, + json_extract_path_text(Properties, 'RestApiId') as rest_api_id, + json_extract_path_text(Properties, 'DisableExecuteApiEndpoint') as disable_execute_api_endpoint, + json_extract_path_text(Properties, 'FailOnWarnings') as fail_on_warnings, + json_extract_path_text(Properties, 'BinaryMediaTypes') as binary_media_types, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'RootResourceId') as root_resource_id, + json_extract_path_text(Properties, 'ApiKeySourceType') as api_key_source_type, + json_extract_path_text(Properties, 'EndpointConfiguration') as endpoint_configuration, + json_extract_path_text(Properties, 'Body') as body, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::RestApi' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'RestApiId') as rest_api_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::RestApi' + AND region = 'us-east-1' stages: name: stages id: aws.apigateway.stages @@ -4400,7 +4491,7 @@ components: x-identifiers: - RestApiId - StageName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -4417,9 +4508,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -4429,44 +4520,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/stages/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/stages/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.RestApiId') as rest_api_id, - JSON_EXTRACT(Properties, '$.StageName') as stage_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::Stage' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'RestApiId') as rest_api_id, - json_extract_path_text(Properties, 'StageName') as stage_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::Stage' - AND region = 'us-east-1' - stage: - name: stage - id: aws.apigateway.stage - x-cfn-schema-name: Stage - x-cfn-type-name: AWS::ApiGateway::Stage - x-identifiers: - - RestApiId - - StageName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -4477,12 +4533,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/stages/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/stages/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/stage/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/stages/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -4505,28 +4565,46 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AccessLogSetting') as access_log_setting, - json_extract_path_text(Properties, 'CacheClusterEnabled') as cache_cluster_enabled, - json_extract_path_text(Properties, 'CacheClusterSize') as cache_cluster_size, - json_extract_path_text(Properties, 'CanarySetting') as canary_setting, - json_extract_path_text(Properties, 'ClientCertificateId') as client_certificate_id, - json_extract_path_text(Properties, 'DeploymentId') as deployment_id, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'DocumentationVersion') as documentation_version, - json_extract_path_text(Properties, 'MethodSettings') as method_settings, - json_extract_path_text(Properties, 'RestApiId') as rest_api_id, - json_extract_path_text(Properties, 'StageName') as stage_name, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'TracingEnabled') as tracing_enabled, - json_extract_path_text(Properties, 'Variables') as variables - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::Stage' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.RestApiId') as rest_api_id, + JSON_EXTRACT(Properties, '$.StageName') as stage_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::Stage' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AccessLogSetting') as access_log_setting, + json_extract_path_text(Properties, 'CacheClusterEnabled') as cache_cluster_enabled, + json_extract_path_text(Properties, 'CacheClusterSize') as cache_cluster_size, + json_extract_path_text(Properties, 'CanarySetting') as canary_setting, + json_extract_path_text(Properties, 'ClientCertificateId') as client_certificate_id, + json_extract_path_text(Properties, 'DeploymentId') as deployment_id, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'DocumentationVersion') as documentation_version, + json_extract_path_text(Properties, 'MethodSettings') as method_settings, + json_extract_path_text(Properties, 'RestApiId') as rest_api_id, + json_extract_path_text(Properties, 'StageName') as stage_name, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'TracingEnabled') as tracing_enabled, + json_extract_path_text(Properties, 'Variables') as variables + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::Stage' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'RestApiId') as rest_api_id, + json_extract_path_text(Properties, 'StageName') as stage_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::Stage' + AND region = 'us-east-1' usage_plans: name: usage_plans id: aws.apigateway.usage_plans @@ -4534,7 +4612,7 @@ components: x-cfn-type-name: AWS::ApiGateway::UsagePlan x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -4551,9 +4629,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -4563,41 +4641,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/usage_plans/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/usage_plans/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::UsagePlan' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::UsagePlan' - AND region = 'us-east-1' - usage_plan: - name: usage_plan - id: aws.apigateway.usage_plan - x-cfn-schema-name: UsagePlan - x-cfn-type-name: AWS::ApiGateway::UsagePlan - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -4608,12 +4654,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/usage_plans/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/usage_plans/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/usage_plan/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/usage_plans/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -4629,21 +4679,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'ApiStages') as api_stages, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Quota') as quota, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Throttle') as throttle, - json_extract_path_text(Properties, 'UsagePlanName') as usage_plan_name - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::UsagePlan' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::UsagePlan' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'ApiStages') as api_stages, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Quota') as quota, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Throttle') as throttle, + json_extract_path_text(Properties, 'UsagePlanName') as usage_plan_name + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::UsagePlan' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::UsagePlan' + AND region = 'us-east-1' usage_plan_keys: name: usage_plan_keys id: aws.apigateway.usage_plan_keys @@ -4651,7 +4717,7 @@ components: x-cfn-type-name: AWS::ApiGateway::UsagePlanKey x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -4685,39 +4751,11 @@ components: - $ref: '#/components/x-stackQL-resources/usage_plan_keys/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/usage_plan_keys/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::UsagePlanKey' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::UsagePlanKey' - AND region = 'us-east-1' - usage_plan_key: - name: usage_plan_key - id: aws.apigateway.usage_plan_key - x-cfn-schema-name: UsagePlanKey - x-cfn-type-name: AWS::ApiGateway::UsagePlanKey - x-identifiers: - - Id - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -4730,18 +4768,34 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'KeyId') as key_id, - json_extract_path_text(Properties, 'KeyType') as key_type, - json_extract_path_text(Properties, 'UsagePlanId') as usage_plan_id, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::UsagePlanKey' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::UsagePlanKey' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'KeyId') as key_id, + json_extract_path_text(Properties, 'KeyType') as key_type, + json_extract_path_text(Properties, 'UsagePlanId') as usage_plan_id, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::UsagePlanKey' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::UsagePlanKey' + AND region = 'us-east-1' vpc_links: name: vpc_links id: aws.apigateway.vpc_links @@ -4749,7 +4803,7 @@ components: x-cfn-type-name: AWS::ApiGateway::VpcLink x-identifiers: - VpcLinkId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -4766,9 +4820,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -4778,41 +4832,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/vpc_links/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/vpc_links/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.VpcLinkId') as vpc_link_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::VpcLink' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'VpcLinkId') as vpc_link_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::VpcLink' - AND region = 'us-east-1' - vpc_link: - name: vpc_link - id: aws.apigateway.vpc_link - x-cfn-schema-name: VpcLink - x-cfn-type-name: AWS::ApiGateway::VpcLink - x-identifiers: - - VpcLinkId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -4823,12 +4845,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/vpc_links/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/vpc_links/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/vpc_link/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/vpc_links/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -4842,19 +4868,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'TargetArns') as target_arns, - json_extract_path_text(Properties, 'VpcLinkId') as vpc_link_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::VpcLink' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.VpcLinkId') as vpc_link_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::VpcLink' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'TargetArns') as target_arns, + json_extract_path_text(Properties, 'VpcLinkId') as vpc_link_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGateway::VpcLink' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'VpcLinkId') as vpc_link_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGateway::VpcLink' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: @@ -5376,6 +5418,48 @@ paths: schema: $ref: '#/components/x-cloud-control-schemas/ProgressEvent' description: Success + /?Action=CreateResource&Version=2021-09-30&__GatewayResponse&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateGatewayResponse + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateGatewayResponseRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success /?Action=CreateResource&Version=2021-09-30&__Method&__detailTransformed=true: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' diff --git a/providers/src/aws/v00.00.00000/services/apigatewayv2.yaml b/providers/src/aws/v00.00.00000/services/apigatewayv2.yaml index 5935e51b..95e86f66 100644 --- a/providers/src/aws/v00.00.00000/services/apigatewayv2.yaml +++ b/providers/src/aws/v00.00.00000/services/apigatewayv2.yaml @@ -1709,7 +1709,7 @@ components: x-cfn-type-name: AWS::ApiGatewayV2::Api x-identifiers: - ApiId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1726,9 +1726,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1738,41 +1738,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/apis/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/apis/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ApiId') as api_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::Api' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ApiId') as api_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::Api' - AND region = 'us-east-1' - api: - name: api - id: aws.apigatewayv2.api - x-cfn-schema-name: Api - x-cfn-type-name: AWS::ApiGatewayV2::Api - x-identifiers: - - ApiId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1783,12 +1751,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/apis/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/apis/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/api/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/apis/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1816,33 +1788,49 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'RouteSelectionExpression') as route_selection_expression, - json_extract_path_text(Properties, 'BodyS3Location') as body_s3_location, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'ApiEndpoint') as api_endpoint, - json_extract_path_text(Properties, 'BasePath') as base_path, - json_extract_path_text(Properties, 'FailOnWarnings') as fail_on_warnings, - json_extract_path_text(Properties, 'DisableExecuteApiEndpoint') as disable_execute_api_endpoint, - json_extract_path_text(Properties, 'DisableSchemaValidation') as disable_schema_validation, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Target') as target, - json_extract_path_text(Properties, 'CredentialsArn') as credentials_arn, - json_extract_path_text(Properties, 'CorsConfiguration') as cors_configuration, - json_extract_path_text(Properties, 'Version') as version, - json_extract_path_text(Properties, 'ProtocolType') as protocol_type, - json_extract_path_text(Properties, 'RouteKey') as route_key, - json_extract_path_text(Properties, 'ApiId') as api_id, - json_extract_path_text(Properties, 'Body') as body, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'ApiKeySelectionExpression') as api_key_selection_expression - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGatewayV2::Api' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ApiId') as api_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::Api' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'RouteSelectionExpression') as route_selection_expression, + json_extract_path_text(Properties, 'BodyS3Location') as body_s3_location, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'ApiEndpoint') as api_endpoint, + json_extract_path_text(Properties, 'BasePath') as base_path, + json_extract_path_text(Properties, 'FailOnWarnings') as fail_on_warnings, + json_extract_path_text(Properties, 'DisableExecuteApiEndpoint') as disable_execute_api_endpoint, + json_extract_path_text(Properties, 'DisableSchemaValidation') as disable_schema_validation, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Target') as target, + json_extract_path_text(Properties, 'CredentialsArn') as credentials_arn, + json_extract_path_text(Properties, 'CorsConfiguration') as cors_configuration, + json_extract_path_text(Properties, 'Version') as version, + json_extract_path_text(Properties, 'ProtocolType') as protocol_type, + json_extract_path_text(Properties, 'RouteKey') as route_key, + json_extract_path_text(Properties, 'ApiId') as api_id, + json_extract_path_text(Properties, 'Body') as body, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'ApiKeySelectionExpression') as api_key_selection_expression + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGatewayV2::Api' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ApiId') as api_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::Api' + AND region = 'us-east-1' api_mappings: name: api_mappings id: aws.apigatewayv2.api_mappings @@ -1851,7 +1839,7 @@ components: x-identifiers: - ApiMappingId - DomainName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1868,9 +1856,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1880,44 +1868,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/api_mappings/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/api_mappings/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ApiMappingId') as api_mapping_id, - JSON_EXTRACT(Properties, '$.DomainName') as domain_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::ApiMapping' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ApiMappingId') as api_mapping_id, - json_extract_path_text(Properties, 'DomainName') as domain_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::ApiMapping' - AND region = 'us-east-1' - api_mapping: - name: api_mapping - id: aws.apigatewayv2.api_mapping - x-cfn-schema-name: ApiMapping - x-cfn-type-name: AWS::ApiGatewayV2::ApiMapping - x-identifiers: - - ApiMappingId - - DomainName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1928,12 +1881,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/api_mappings/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/api_mappings/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/api_mapping/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/api_mappings/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1947,19 +1904,37 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ApiMappingId') as api_mapping_id, - json_extract_path_text(Properties, 'DomainName') as domain_name, - json_extract_path_text(Properties, 'Stage') as stage, - json_extract_path_text(Properties, 'ApiMappingKey') as api_mapping_key, - json_extract_path_text(Properties, 'ApiId') as api_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGatewayV2::ApiMapping' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.ApiMappingId') as api_mapping_id, + JSON_EXTRACT(Properties, '$.DomainName') as domain_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::ApiMapping' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ApiMappingId') as api_mapping_id, + json_extract_path_text(Properties, 'DomainName') as domain_name, + json_extract_path_text(Properties, 'Stage') as stage, + json_extract_path_text(Properties, 'ApiMappingKey') as api_mapping_key, + json_extract_path_text(Properties, 'ApiId') as api_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGatewayV2::ApiMapping' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ApiMappingId') as api_mapping_id, + json_extract_path_text(Properties, 'DomainName') as domain_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::ApiMapping' + AND region = 'us-east-1' authorizers: name: authorizers id: aws.apigatewayv2.authorizers @@ -1968,7 +1943,7 @@ components: x-identifiers: - AuthorizerId - ApiId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1985,9 +1960,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1997,44 +1972,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/authorizers/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/authorizers/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AuthorizerId') as authorizer_id, - JSON_EXTRACT(Properties, '$.ApiId') as api_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::Authorizer' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AuthorizerId') as authorizer_id, - json_extract_path_text(Properties, 'ApiId') as api_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::Authorizer' - AND region = 'us-east-1' - authorizer: - name: authorizer - id: aws.apigatewayv2.authorizer - x-cfn-schema-name: Authorizer - x-cfn-type-name: AWS::ApiGatewayV2::Authorizer - x-identifiers: - - AuthorizerId - - ApiId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2045,12 +1985,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/authorizers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/authorizers/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/authorizer/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/authorizers/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2071,26 +2015,44 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'IdentityValidationExpression') as identity_validation_expression, - json_extract_path_text(Properties, 'AuthorizerUri') as authorizer_uri, - json_extract_path_text(Properties, 'AuthorizerCredentialsArn') as authorizer_credentials_arn, - json_extract_path_text(Properties, 'AuthorizerType') as authorizer_type, - json_extract_path_text(Properties, 'JwtConfiguration') as jwt_configuration, - json_extract_path_text(Properties, 'AuthorizerResultTtlInSeconds') as authorizer_result_ttl_in_seconds, - json_extract_path_text(Properties, 'IdentitySource') as identity_source, - json_extract_path_text(Properties, 'AuthorizerPayloadFormatVersion') as authorizer_payload_format_version, - json_extract_path_text(Properties, 'ApiId') as api_id, - json_extract_path_text(Properties, 'EnableSimpleResponses') as enable_simple_responses, - json_extract_path_text(Properties, 'AuthorizerId') as authorizer_id, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGatewayV2::Authorizer' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.AuthorizerId') as authorizer_id, + JSON_EXTRACT(Properties, '$.ApiId') as api_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::Authorizer' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'IdentityValidationExpression') as identity_validation_expression, + json_extract_path_text(Properties, 'AuthorizerUri') as authorizer_uri, + json_extract_path_text(Properties, 'AuthorizerCredentialsArn') as authorizer_credentials_arn, + json_extract_path_text(Properties, 'AuthorizerType') as authorizer_type, + json_extract_path_text(Properties, 'JwtConfiguration') as jwt_configuration, + json_extract_path_text(Properties, 'AuthorizerResultTtlInSeconds') as authorizer_result_ttl_in_seconds, + json_extract_path_text(Properties, 'IdentitySource') as identity_source, + json_extract_path_text(Properties, 'AuthorizerPayloadFormatVersion') as authorizer_payload_format_version, + json_extract_path_text(Properties, 'ApiId') as api_id, + json_extract_path_text(Properties, 'EnableSimpleResponses') as enable_simple_responses, + json_extract_path_text(Properties, 'AuthorizerId') as authorizer_id, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGatewayV2::Authorizer' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AuthorizerId') as authorizer_id, + json_extract_path_text(Properties, 'ApiId') as api_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::Authorizer' + AND region = 'us-east-1' deployments: name: deployments id: aws.apigatewayv2.deployments @@ -2099,7 +2061,7 @@ components: x-identifiers: - ApiId - DeploymentId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2116,9 +2078,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2128,44 +2090,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/deployments/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/deployments/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ApiId') as api_id, - JSON_EXTRACT(Properties, '$.DeploymentId') as deployment_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::Deployment' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ApiId') as api_id, - json_extract_path_text(Properties, 'DeploymentId') as deployment_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::Deployment' - AND region = 'us-east-1' - deployment: - name: deployment - id: aws.apigatewayv2.deployment - x-cfn-schema-name: Deployment - x-cfn-type-name: AWS::ApiGatewayV2::Deployment - x-identifiers: - - ApiId - - DeploymentId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2176,12 +2103,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/deployments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/deployments/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/deployment/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/deployments/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2194,18 +2125,36 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'DeploymentId') as deployment_id, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'StageName') as stage_name, - json_extract_path_text(Properties, 'ApiId') as api_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGatewayV2::Deployment' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.ApiId') as api_id, + JSON_EXTRACT(Properties, '$.DeploymentId') as deployment_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::Deployment' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DeploymentId') as deployment_id, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'StageName') as stage_name, + json_extract_path_text(Properties, 'ApiId') as api_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGatewayV2::Deployment' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ApiId') as api_id, + json_extract_path_text(Properties, 'DeploymentId') as deployment_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::Deployment' + AND region = 'us-east-1' domain_names: name: domain_names id: aws.apigatewayv2.domain_names @@ -2213,7 +2162,7 @@ components: x-cfn-type-name: AWS::ApiGatewayV2::DomainName x-identifiers: - DomainName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2230,9 +2179,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2242,41 +2191,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/domain_names/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/domain_names/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.DomainName') as domain_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::DomainName' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'DomainName') as domain_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::DomainName' - AND region = 'us-east-1' - domain_name: - name: domain_name - id: aws.apigatewayv2.domain_name - x-cfn-schema-name: DomainName - x-cfn-type-name: AWS::ApiGatewayV2::DomainName - x-identifiers: - - DomainName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2287,12 +2204,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/domain_names/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/domain_names/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/domain_name/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/domain_names/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2307,20 +2228,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'MutualTlsAuthentication') as mutual_tls_authentication, - json_extract_path_text(Properties, 'RegionalHostedZoneId') as regional_hosted_zone_id, - json_extract_path_text(Properties, 'RegionalDomainName') as regional_domain_name, - json_extract_path_text(Properties, 'DomainName') as domain_name, - json_extract_path_text(Properties, 'DomainNameConfigurations') as domain_name_configurations, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGatewayV2::DomainName' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.DomainName') as domain_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::DomainName' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'MutualTlsAuthentication') as mutual_tls_authentication, + json_extract_path_text(Properties, 'RegionalHostedZoneId') as regional_hosted_zone_id, + json_extract_path_text(Properties, 'RegionalDomainName') as regional_domain_name, + json_extract_path_text(Properties, 'DomainName') as domain_name, + json_extract_path_text(Properties, 'DomainNameConfigurations') as domain_name_configurations, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGatewayV2::DomainName' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DomainName') as domain_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::DomainName' + AND region = 'us-east-1' integration_responses: name: integration_responses id: aws.apigatewayv2.integration_responses @@ -2330,7 +2267,7 @@ components: - ApiId - IntegrationId - IntegrationResponseId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2347,9 +2284,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2359,47 +2296,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/integration_responses/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/integration_responses/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ApiId') as api_id, - JSON_EXTRACT(Properties, '$.IntegrationId') as integration_id, - JSON_EXTRACT(Properties, '$.IntegrationResponseId') as integration_response_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::IntegrationResponse' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ApiId') as api_id, - json_extract_path_text(Properties, 'IntegrationId') as integration_id, - json_extract_path_text(Properties, 'IntegrationResponseId') as integration_response_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::IntegrationResponse' - AND region = 'us-east-1' - integration_response: - name: integration_response - id: aws.apigatewayv2.integration_response - x-cfn-schema-name: IntegrationResponse - x-cfn-type-name: AWS::ApiGatewayV2::IntegrationResponse - x-identifiers: - - ApiId - - IntegrationId - - IntegrationResponseId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2410,12 +2309,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/integration_responses/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/integration_responses/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/integration_response/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/integration_responses/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2432,22 +2335,42 @@ components: AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'IntegrationResponseId') as integration_response_id, - json_extract_path_text(Properties, 'ResponseTemplates') as response_templates, - json_extract_path_text(Properties, 'TemplateSelectionExpression') as template_selection_expression, - json_extract_path_text(Properties, 'ResponseParameters') as response_parameters, - json_extract_path_text(Properties, 'ContentHandlingStrategy') as content_handling_strategy, - json_extract_path_text(Properties, 'IntegrationId') as integration_id, - json_extract_path_text(Properties, 'IntegrationResponseKey') as integration_response_key, - json_extract_path_text(Properties, 'ApiId') as api_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGatewayV2::IntegrationResponse' - AND data__Identifier = '||' + JSON_EXTRACT(Properties, '$.ApiId') as api_id, + JSON_EXTRACT(Properties, '$.IntegrationId') as integration_id, + JSON_EXTRACT(Properties, '$.IntegrationResponseId') as integration_response_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::IntegrationResponse' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'IntegrationResponseId') as integration_response_id, + json_extract_path_text(Properties, 'ResponseTemplates') as response_templates, + json_extract_path_text(Properties, 'TemplateSelectionExpression') as template_selection_expression, + json_extract_path_text(Properties, 'ResponseParameters') as response_parameters, + json_extract_path_text(Properties, 'ContentHandlingStrategy') as content_handling_strategy, + json_extract_path_text(Properties, 'IntegrationId') as integration_id, + json_extract_path_text(Properties, 'IntegrationResponseKey') as integration_response_key, + json_extract_path_text(Properties, 'ApiId') as api_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGatewayV2::IntegrationResponse' + AND data__Identifier = '||' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ApiId') as api_id, + json_extract_path_text(Properties, 'IntegrationId') as integration_id, + json_extract_path_text(Properties, 'IntegrationResponseId') as integration_response_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::IntegrationResponse' + AND region = 'us-east-1' models: name: models id: aws.apigatewayv2.models @@ -2456,7 +2379,7 @@ components: x-identifiers: - ApiId - ModelId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2473,9 +2396,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2485,44 +2408,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/models/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/models/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ApiId') as api_id, - JSON_EXTRACT(Properties, '$.ModelId') as model_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::Model' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ApiId') as api_id, - json_extract_path_text(Properties, 'ModelId') as model_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::Model' - AND region = 'us-east-1' - model: - name: model - id: aws.apigatewayv2.model - x-cfn-schema-name: Model - x-cfn-type-name: AWS::ApiGatewayV2::Model - x-identifiers: - - ApiId - - ModelId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2533,12 +2421,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/models/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/models/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/model/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/models/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2553,20 +2445,38 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ModelId') as model_id, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'ContentType') as content_type, - json_extract_path_text(Properties, 'Schema') as _schema, - json_extract_path_text(Properties, 'ApiId') as api_id, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGatewayV2::Model' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.ApiId') as api_id, + JSON_EXTRACT(Properties, '$.ModelId') as model_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::Model' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ModelId') as model_id, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'ContentType') as content_type, + json_extract_path_text(Properties, 'Schema') as _schema, + json_extract_path_text(Properties, 'ApiId') as api_id, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGatewayV2::Model' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ApiId') as api_id, + json_extract_path_text(Properties, 'ModelId') as model_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::Model' + AND region = 'us-east-1' routes: name: routes id: aws.apigatewayv2.routes @@ -2575,7 +2485,7 @@ components: x-identifiers: - ApiId - RouteId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2592,9 +2502,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2604,44 +2514,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/routes/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/routes/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ApiId') as api_id, - JSON_EXTRACT(Properties, '$.RouteId') as route_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::Route' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ApiId') as api_id, - json_extract_path_text(Properties, 'RouteId') as route_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::Route' - AND region = 'us-east-1' - route: - name: route - id: aws.apigatewayv2.route - x-cfn-schema-name: Route - x-cfn-type-name: AWS::ApiGatewayV2::Route - x-identifiers: - - ApiId - - RouteId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2652,12 +2527,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/routes/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/routes/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/route/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/routes/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2679,27 +2558,45 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'RouteId') as route_id, - json_extract_path_text(Properties, 'RouteResponseSelectionExpression') as route_response_selection_expression, - json_extract_path_text(Properties, 'RequestModels') as request_models, - json_extract_path_text(Properties, 'OperationName') as operation_name, - json_extract_path_text(Properties, 'AuthorizationScopes') as authorization_scopes, - json_extract_path_text(Properties, 'ApiKeyRequired') as api_key_required, - json_extract_path_text(Properties, 'RouteKey') as route_key, - json_extract_path_text(Properties, 'AuthorizationType') as authorization_type, - json_extract_path_text(Properties, 'ModelSelectionExpression') as model_selection_expression, - json_extract_path_text(Properties, 'ApiId') as api_id, - json_extract_path_text(Properties, 'RequestParameters') as request_parameters, - json_extract_path_text(Properties, 'Target') as target, - json_extract_path_text(Properties, 'AuthorizerId') as authorizer_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGatewayV2::Route' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.ApiId') as api_id, + JSON_EXTRACT(Properties, '$.RouteId') as route_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::Route' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'RouteId') as route_id, + json_extract_path_text(Properties, 'RouteResponseSelectionExpression') as route_response_selection_expression, + json_extract_path_text(Properties, 'RequestModels') as request_models, + json_extract_path_text(Properties, 'OperationName') as operation_name, + json_extract_path_text(Properties, 'AuthorizationScopes') as authorization_scopes, + json_extract_path_text(Properties, 'ApiKeyRequired') as api_key_required, + json_extract_path_text(Properties, 'RouteKey') as route_key, + json_extract_path_text(Properties, 'AuthorizationType') as authorization_type, + json_extract_path_text(Properties, 'ModelSelectionExpression') as model_selection_expression, + json_extract_path_text(Properties, 'ApiId') as api_id, + json_extract_path_text(Properties, 'RequestParameters') as request_parameters, + json_extract_path_text(Properties, 'Target') as target, + json_extract_path_text(Properties, 'AuthorizerId') as authorizer_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGatewayV2::Route' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ApiId') as api_id, + json_extract_path_text(Properties, 'RouteId') as route_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::Route' + AND region = 'us-east-1' route_responses: name: route_responses id: aws.apigatewayv2.route_responses @@ -2709,7 +2606,7 @@ components: - ApiId - RouteId - RouteResponseId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2726,9 +2623,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2738,47 +2635,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/route_responses/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/route_responses/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ApiId') as api_id, - JSON_EXTRACT(Properties, '$.RouteId') as route_id, - JSON_EXTRACT(Properties, '$.RouteResponseId') as route_response_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::RouteResponse' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ApiId') as api_id, - json_extract_path_text(Properties, 'RouteId') as route_id, - json_extract_path_text(Properties, 'RouteResponseId') as route_response_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::RouteResponse' - AND region = 'us-east-1' - route_response: - name: route_response - id: aws.apigatewayv2.route_response - x-cfn-schema-name: RouteResponse - x-cfn-type-name: AWS::ApiGatewayV2::RouteResponse - x-identifiers: - - ApiId - - RouteId - - RouteResponseId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2789,12 +2648,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/route_responses/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/route_responses/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/route_response/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/route_responses/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2810,21 +2673,41 @@ components: AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'RouteResponseKey') as route_response_key, - json_extract_path_text(Properties, 'ResponseParameters') as response_parameters, - json_extract_path_text(Properties, 'RouteId') as route_id, - json_extract_path_text(Properties, 'ModelSelectionExpression') as model_selection_expression, - json_extract_path_text(Properties, 'ApiId') as api_id, - json_extract_path_text(Properties, 'ResponseModels') as response_models, - json_extract_path_text(Properties, 'RouteResponseId') as route_response_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGatewayV2::RouteResponse' - AND data__Identifier = '||' + JSON_EXTRACT(Properties, '$.ApiId') as api_id, + JSON_EXTRACT(Properties, '$.RouteId') as route_id, + JSON_EXTRACT(Properties, '$.RouteResponseId') as route_response_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::RouteResponse' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'RouteResponseKey') as route_response_key, + json_extract_path_text(Properties, 'ResponseParameters') as response_parameters, + json_extract_path_text(Properties, 'RouteId') as route_id, + json_extract_path_text(Properties, 'ModelSelectionExpression') as model_selection_expression, + json_extract_path_text(Properties, 'ApiId') as api_id, + json_extract_path_text(Properties, 'ResponseModels') as response_models, + json_extract_path_text(Properties, 'RouteResponseId') as route_response_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGatewayV2::RouteResponse' + AND data__Identifier = '||' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ApiId') as api_id, + json_extract_path_text(Properties, 'RouteId') as route_id, + json_extract_path_text(Properties, 'RouteResponseId') as route_response_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::RouteResponse' + AND region = 'us-east-1' vpc_links: name: vpc_links id: aws.apigatewayv2.vpc_links @@ -2832,7 +2715,7 @@ components: x-cfn-type-name: AWS::ApiGatewayV2::VpcLink x-identifiers: - VpcLinkId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2849,9 +2732,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2861,41 +2744,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/vpc_links/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/vpc_links/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.VpcLinkId') as vpc_link_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::VpcLink' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'VpcLinkId') as vpc_link_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::VpcLink' - AND region = 'us-east-1' - vpc_link: - name: vpc_link - id: aws.apigatewayv2.vpc_link - x-cfn-schema-name: VpcLink - x-cfn-type-name: AWS::ApiGatewayV2::VpcLink - x-identifiers: - - VpcLinkId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2906,12 +2757,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/vpc_links/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/vpc_links/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/vpc_link/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/vpc_links/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2925,19 +2780,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'VpcLinkId') as vpc_link_id, - json_extract_path_text(Properties, 'SubnetIds') as subnet_ids, - json_extract_path_text(Properties, 'SecurityGroupIds') as security_group_ids, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGatewayV2::VpcLink' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.VpcLinkId') as vpc_link_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::VpcLink' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'VpcLinkId') as vpc_link_id, + json_extract_path_text(Properties, 'SubnetIds') as subnet_ids, + json_extract_path_text(Properties, 'SecurityGroupIds') as security_group_ids, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApiGatewayV2::VpcLink' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'VpcLinkId') as vpc_link_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApiGatewayV2::VpcLink' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/appconfig.yaml b/providers/src/aws/v00.00.00000/services/appconfig.yaml index 2e20740c..e28de010 100644 --- a/providers/src/aws/v00.00.00000/services/appconfig.yaml +++ b/providers/src/aws/v00.00.00000/services/appconfig.yaml @@ -1297,7 +1297,7 @@ components: x-cfn-type-name: AWS::AppConfig::Application x-identifiers: - ApplicationId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1314,9 +1314,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1326,41 +1326,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/applications/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/applications/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ApplicationId') as application_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppConfig::Application' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ApplicationId') as application_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppConfig::Application' - AND region = 'us-east-1' - application: - name: application - id: aws.appconfig.application - x-cfn-schema-name: Application - x-cfn-type-name: AWS::AppConfig::Application - x-identifiers: - - ApplicationId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1371,12 +1339,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/applications/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/applications/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/application/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/applications/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1389,18 +1361,34 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'ApplicationId') as application_id, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AppConfig::Application' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ApplicationId') as application_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppConfig::Application' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'ApplicationId') as application_id, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AppConfig::Application' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ApplicationId') as application_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppConfig::Application' + AND region = 'us-east-1' configuration_profiles: name: configuration_profiles id: aws.appconfig.configuration_profiles @@ -1409,7 +1397,7 @@ components: x-identifiers: - ApplicationId - ConfigurationProfileId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1426,9 +1414,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1438,44 +1426,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/configuration_profiles/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/configuration_profiles/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ApplicationId') as application_id, - JSON_EXTRACT(Properties, '$.ConfigurationProfileId') as configuration_profile_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppConfig::ConfigurationProfile' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ApplicationId') as application_id, - json_extract_path_text(Properties, 'ConfigurationProfileId') as configuration_profile_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppConfig::ConfigurationProfile' - AND region = 'us-east-1' - configuration_profile: - name: configuration_profile - id: aws.appconfig.configuration_profile - x-cfn-schema-name: ConfigurationProfile - x-cfn-type-name: AWS::AppConfig::ConfigurationProfile - x-identifiers: - - ApplicationId - - ConfigurationProfileId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1486,12 +1439,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/configuration_profiles/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/configuration_profiles/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/configuration_profile/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/configuration_profiles/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1511,25 +1468,43 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ConfigurationProfileId') as configuration_profile_id, - json_extract_path_text(Properties, 'LocationUri') as location_uri, - json_extract_path_text(Properties, 'Type') as type, - json_extract_path_text(Properties, 'KmsKeyIdentifier') as kms_key_identifier, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'KmsKeyArn') as kms_key_arn, - json_extract_path_text(Properties, 'Validators') as validators, - json_extract_path_text(Properties, 'RetrievalRoleArn') as retrieval_role_arn, - json_extract_path_text(Properties, 'ApplicationId') as application_id, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AppConfig::ConfigurationProfile' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.ApplicationId') as application_id, + JSON_EXTRACT(Properties, '$.ConfigurationProfileId') as configuration_profile_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppConfig::ConfigurationProfile' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ConfigurationProfileId') as configuration_profile_id, + json_extract_path_text(Properties, 'LocationUri') as location_uri, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'KmsKeyIdentifier') as kms_key_identifier, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'KmsKeyArn') as kms_key_arn, + json_extract_path_text(Properties, 'Validators') as validators, + json_extract_path_text(Properties, 'RetrievalRoleArn') as retrieval_role_arn, + json_extract_path_text(Properties, 'ApplicationId') as application_id, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AppConfig::ConfigurationProfile' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ApplicationId') as application_id, + json_extract_path_text(Properties, 'ConfigurationProfileId') as configuration_profile_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppConfig::ConfigurationProfile' + AND region = 'us-east-1' environments: name: environments id: aws.appconfig.environments @@ -1538,7 +1513,7 @@ components: x-identifiers: - ApplicationId - EnvironmentId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1555,9 +1530,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1567,44 +1542,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/environments/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/environments/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ApplicationId') as application_id, - JSON_EXTRACT(Properties, '$.EnvironmentId') as environment_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppConfig::Environment' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ApplicationId') as application_id, - json_extract_path_text(Properties, 'EnvironmentId') as environment_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppConfig::Environment' - AND region = 'us-east-1' - environment: - name: environment - id: aws.appconfig.environment - x-cfn-schema-name: Environment - x-cfn-type-name: AWS::AppConfig::Environment - x-identifiers: - - ApplicationId - - EnvironmentId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1615,12 +1555,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/environments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/environments/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/environment/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/environments/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1635,20 +1579,38 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'EnvironmentId') as environment_id, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Monitors') as monitors, - json_extract_path_text(Properties, 'ApplicationId') as application_id, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AppConfig::Environment' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.ApplicationId') as application_id, + JSON_EXTRACT(Properties, '$.EnvironmentId') as environment_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppConfig::Environment' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'EnvironmentId') as environment_id, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Monitors') as monitors, + json_extract_path_text(Properties, 'ApplicationId') as application_id, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AppConfig::Environment' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ApplicationId') as application_id, + json_extract_path_text(Properties, 'EnvironmentId') as environment_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppConfig::Environment' + AND region = 'us-east-1' extensions: name: extensions id: aws.appconfig.extensions @@ -1656,7 +1618,7 @@ components: x-cfn-type-name: AWS::AppConfig::Extension x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1673,9 +1635,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1685,41 +1647,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/extensions/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/extensions/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppConfig::Extension' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppConfig::Extension' - AND region = 'us-east-1' - extension: - name: extension - id: aws.appconfig.extension - x-cfn-schema-name: Extension - x-cfn-type-name: AWS::AppConfig::Extension - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1730,12 +1660,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/extensions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/extensions/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/extension/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/extensions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1753,23 +1687,39 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'VersionNumber') as version_number, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Actions') as actions, - json_extract_path_text(Properties, 'Parameters') as parameters, - json_extract_path_text(Properties, 'LatestVersionNumber') as latest_version_number, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AppConfig::Extension' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppConfig::Extension' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'VersionNumber') as version_number, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Actions') as actions, + json_extract_path_text(Properties, 'Parameters') as parameters, + json_extract_path_text(Properties, 'LatestVersionNumber') as latest_version_number, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AppConfig::Extension' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppConfig::Extension' + AND region = 'us-east-1' extension_associations: name: extension_associations id: aws.appconfig.extension_associations @@ -1777,7 +1727,7 @@ components: x-cfn-type-name: AWS::AppConfig::ExtensionAssociation x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1794,9 +1744,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1806,41 +1756,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/extension_associations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/extension_associations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppConfig::ExtensionAssociation' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppConfig::ExtensionAssociation' - AND region = 'us-east-1' - extension_association: - name: extension_association - id: aws.appconfig.extension_association - x-cfn-schema-name: ExtensionAssociation - x-cfn-type-name: AWS::AppConfig::ExtensionAssociation - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1851,12 +1769,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/extension_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/extension_associations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/extension_association/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/extension_associations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1874,23 +1796,39 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'ExtensionArn') as extension_arn, - json_extract_path_text(Properties, 'ResourceArn') as resource_arn, - json_extract_path_text(Properties, 'ExtensionIdentifier') as extension_identifier, - json_extract_path_text(Properties, 'ResourceIdentifier') as resource_identifier, - json_extract_path_text(Properties, 'ExtensionVersionNumber') as extension_version_number, - json_extract_path_text(Properties, 'Parameters') as parameters, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AppConfig::ExtensionAssociation' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppConfig::ExtensionAssociation' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'ExtensionArn') as extension_arn, + json_extract_path_text(Properties, 'ResourceArn') as resource_arn, + json_extract_path_text(Properties, 'ExtensionIdentifier') as extension_identifier, + json_extract_path_text(Properties, 'ResourceIdentifier') as resource_identifier, + json_extract_path_text(Properties, 'ExtensionVersionNumber') as extension_version_number, + json_extract_path_text(Properties, 'Parameters') as parameters, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AppConfig::ExtensionAssociation' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppConfig::ExtensionAssociation' + AND region = 'us-east-1' hosted_configuration_versions: name: hosted_configuration_versions id: aws.appconfig.hosted_configuration_versions @@ -1900,7 +1838,7 @@ components: - ApplicationId - ConfigurationProfileId - VersionNumber - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1934,45 +1872,11 @@ components: - $ref: '#/components/x-stackQL-resources/hosted_configuration_versions/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/hosted_configuration_versions/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ApplicationId') as application_id, - JSON_EXTRACT(Properties, '$.ConfigurationProfileId') as configuration_profile_id, - JSON_EXTRACT(Properties, '$.VersionNumber') as version_number - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppConfig::HostedConfigurationVersion' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ApplicationId') as application_id, - json_extract_path_text(Properties, 'ConfigurationProfileId') as configuration_profile_id, - json_extract_path_text(Properties, 'VersionNumber') as version_number - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppConfig::HostedConfigurationVersion' - AND region = 'us-east-1' - hosted_configuration_version: - name: hosted_configuration_version - id: aws.appconfig.hosted_configuration_version - x-cfn-schema-name: HostedConfigurationVersion - x-cfn-type-name: AWS::AppConfig::HostedConfigurationVersion - x-identifiers: - - ApplicationId - - ConfigurationProfileId - - VersionNumber - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1989,22 +1893,42 @@ components: AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ConfigurationProfileId') as configuration_profile_id, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'ContentType') as content_type, - json_extract_path_text(Properties, 'LatestVersionNumber') as latest_version_number, - json_extract_path_text(Properties, 'Content') as content, - json_extract_path_text(Properties, 'VersionLabel') as version_label, - json_extract_path_text(Properties, 'ApplicationId') as application_id, - json_extract_path_text(Properties, 'VersionNumber') as version_number - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AppConfig::HostedConfigurationVersion' - AND data__Identifier = '||' + JSON_EXTRACT(Properties, '$.ApplicationId') as application_id, + JSON_EXTRACT(Properties, '$.ConfigurationProfileId') as configuration_profile_id, + JSON_EXTRACT(Properties, '$.VersionNumber') as version_number + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppConfig::HostedConfigurationVersion' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ConfigurationProfileId') as configuration_profile_id, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'ContentType') as content_type, + json_extract_path_text(Properties, 'LatestVersionNumber') as latest_version_number, + json_extract_path_text(Properties, 'Content') as content, + json_extract_path_text(Properties, 'VersionLabel') as version_label, + json_extract_path_text(Properties, 'ApplicationId') as application_id, + json_extract_path_text(Properties, 'VersionNumber') as version_number + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AppConfig::HostedConfigurationVersion' + AND data__Identifier = '||' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ApplicationId') as application_id, + json_extract_path_text(Properties, 'ConfigurationProfileId') as configuration_profile_id, + json_extract_path_text(Properties, 'VersionNumber') as version_number + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppConfig::HostedConfigurationVersion' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/appflow.yaml b/providers/src/aws/v00.00.00000/services/appflow.yaml index 4678ca0f..de38f01d 100644 --- a/providers/src/aws/v00.00.00000/services/appflow.yaml +++ b/providers/src/aws/v00.00.00000/services/appflow.yaml @@ -2876,7 +2876,7 @@ components: x-cfn-type-name: AWS::AppFlow::Connector x-identifiers: - ConnectorLabel - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2893,9 +2893,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2905,41 +2905,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/connectors/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/connectors/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ConnectorLabel') as connector_label - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppFlow::Connector' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ConnectorLabel') as connector_label - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppFlow::Connector' - AND region = 'us-east-1' - connector: - name: connector - id: aws.appflow.connector - x-cfn-schema-name: Connector - x-cfn-type-name: AWS::AppFlow::Connector - x-identifiers: - - ConnectorLabel - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2950,12 +2918,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/connectors/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/connectors/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/connector/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/connectors/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2969,19 +2941,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ConnectorLabel') as connector_label, - json_extract_path_text(Properties, 'ConnectorArn') as connector_arn, - json_extract_path_text(Properties, 'ConnectorProvisioningType') as connector_provisioning_type, - json_extract_path_text(Properties, 'ConnectorProvisioningConfig') as connector_provisioning_config, - json_extract_path_text(Properties, 'Description') as description - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AppFlow::Connector' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ConnectorLabel') as connector_label + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppFlow::Connector' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ConnectorLabel') as connector_label, + json_extract_path_text(Properties, 'ConnectorArn') as connector_arn, + json_extract_path_text(Properties, 'ConnectorProvisioningType') as connector_provisioning_type, + json_extract_path_text(Properties, 'ConnectorProvisioningConfig') as connector_provisioning_config, + json_extract_path_text(Properties, 'Description') as description + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AppFlow::Connector' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ConnectorLabel') as connector_label + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppFlow::Connector' + AND region = 'us-east-1' connector_profiles: name: connector_profiles id: aws.appflow.connector_profiles @@ -2989,7 +2977,7 @@ components: x-cfn-type-name: AWS::AppFlow::ConnectorProfile x-identifiers: - ConnectorProfileName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3006,9 +2994,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3018,41 +3006,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/connector_profiles/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/connector_profiles/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ConnectorProfileName') as connector_profile_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppFlow::ConnectorProfile' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ConnectorProfileName') as connector_profile_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppFlow::ConnectorProfile' - AND region = 'us-east-1' - connector_profile: - name: connector_profile - id: aws.appflow.connector_profile - x-cfn-schema-name: ConnectorProfile - x-cfn-type-name: AWS::AppFlow::ConnectorProfile - x-identifiers: - - ConnectorProfileName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3063,12 +3019,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/connector_profiles/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/connector_profiles/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/connector_profile/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/connector_profiles/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3085,22 +3045,38 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ConnectorProfileArn') as connector_profile_arn, - json_extract_path_text(Properties, 'ConnectorLabel') as connector_label, - json_extract_path_text(Properties, 'ConnectorProfileName') as connector_profile_name, - json_extract_path_text(Properties, 'KMSArn') as kms_arn, - json_extract_path_text(Properties, 'ConnectorType') as connector_type, - json_extract_path_text(Properties, 'ConnectionMode') as connection_mode, - json_extract_path_text(Properties, 'ConnectorProfileConfig') as connector_profile_config, - json_extract_path_text(Properties, 'CredentialsArn') as credentials_arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AppFlow::ConnectorProfile' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ConnectorProfileName') as connector_profile_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppFlow::ConnectorProfile' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ConnectorProfileArn') as connector_profile_arn, + json_extract_path_text(Properties, 'ConnectorLabel') as connector_label, + json_extract_path_text(Properties, 'ConnectorProfileName') as connector_profile_name, + json_extract_path_text(Properties, 'KMSArn') as kms_arn, + json_extract_path_text(Properties, 'ConnectorType') as connector_type, + json_extract_path_text(Properties, 'ConnectionMode') as connection_mode, + json_extract_path_text(Properties, 'ConnectorProfileConfig') as connector_profile_config, + json_extract_path_text(Properties, 'CredentialsArn') as credentials_arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AppFlow::ConnectorProfile' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ConnectorProfileName') as connector_profile_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppFlow::ConnectorProfile' + AND region = 'us-east-1' flows: name: flows id: aws.appflow.flows @@ -3108,7 +3084,7 @@ components: x-cfn-type-name: AWS::AppFlow::Flow x-identifiers: - FlowName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3125,9 +3101,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3137,41 +3113,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/flows/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/flows/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.FlowName') as flow_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppFlow::Flow' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'FlowName') as flow_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppFlow::Flow' - AND region = 'us-east-1' - flow: - name: flow - id: aws.appflow.flow - x-cfn-schema-name: Flow - x-cfn-type-name: AWS::AppFlow::Flow - x-identifiers: - - FlowName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3182,12 +3126,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/flows/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/flows/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/flow/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/flows/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3207,25 +3155,41 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'FlowArn') as flow_arn, - json_extract_path_text(Properties, 'FlowName') as flow_name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'KMSArn') as kms_arn, - json_extract_path_text(Properties, 'TriggerConfig') as trigger_config, - json_extract_path_text(Properties, 'FlowStatus') as flow_status, - json_extract_path_text(Properties, 'SourceFlowConfig') as source_flow_config, - json_extract_path_text(Properties, 'DestinationFlowConfigList') as destination_flow_config_list, - json_extract_path_text(Properties, 'Tasks') as tasks, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'MetadataCatalogConfig') as metadata_catalog_config - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AppFlow::Flow' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.FlowName') as flow_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppFlow::Flow' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'FlowArn') as flow_arn, + json_extract_path_text(Properties, 'FlowName') as flow_name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'KMSArn') as kms_arn, + json_extract_path_text(Properties, 'TriggerConfig') as trigger_config, + json_extract_path_text(Properties, 'FlowStatus') as flow_status, + json_extract_path_text(Properties, 'SourceFlowConfig') as source_flow_config, + json_extract_path_text(Properties, 'DestinationFlowConfigList') as destination_flow_config_list, + json_extract_path_text(Properties, 'Tasks') as tasks, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'MetadataCatalogConfig') as metadata_catalog_config + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AppFlow::Flow' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'FlowName') as flow_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppFlow::Flow' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/appintegrations.yaml b/providers/src/aws/v00.00.00000/services/appintegrations.yaml index 4669cbab..3e3c2302 100644 --- a/providers/src/aws/v00.00.00000/services/appintegrations.yaml +++ b/providers/src/aws/v00.00.00000/services/appintegrations.yaml @@ -408,7 +408,6 @@ components: additionalProperties: false required: - AccessUrl - - ApprovedOrigins properties: AccessUrl: type: string @@ -438,7 +437,7 @@ components: Name: description: The name of the application. type: string - pattern: ^[a-zA-Z0-9/\._\-]+$ + pattern: ^[a-zA-Z0-9\/\._ \-]+$ minLength: 1 maxLength: 255 Id: @@ -855,7 +854,7 @@ components: Name: description: The name of the application. type: string - pattern: ^[a-zA-Z0-9/\._\-]+$ + pattern: ^[a-zA-Z0-9\/\._ \-]+$ minLength: 1 maxLength: 255 Id: @@ -1042,7 +1041,7 @@ components: x-cfn-type-name: AWS::AppIntegrations::Application x-identifiers: - ApplicationArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1059,9 +1058,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1071,41 +1070,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/applications/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/applications/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ApplicationArn') as application_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppIntegrations::Application' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ApplicationArn') as application_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppIntegrations::Application' - AND region = 'us-east-1' - application: - name: application - id: aws.appintegrations.application - x-cfn-schema-name: Application - x-cfn-type-name: AWS::AppIntegrations::Application - x-identifiers: - - ApplicationArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1116,12 +1083,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/applications/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/applications/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/application/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/applications/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1138,22 +1109,38 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Namespace') as namespace, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'ApplicationArn') as application_arn, - json_extract_path_text(Properties, 'ApplicationSourceConfig') as application_source_config, - json_extract_path_text(Properties, 'Permissions') as permissions, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AppIntegrations::Application' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ApplicationArn') as application_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppIntegrations::Application' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Namespace') as namespace, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'ApplicationArn') as application_arn, + json_extract_path_text(Properties, 'ApplicationSourceConfig') as application_source_config, + json_extract_path_text(Properties, 'Permissions') as permissions, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AppIntegrations::Application' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ApplicationArn') as application_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppIntegrations::Application' + AND region = 'us-east-1' data_integrations: name: data_integrations id: aws.appintegrations.data_integrations @@ -1161,7 +1148,7 @@ components: x-cfn-type-name: AWS::AppIntegrations::DataIntegration x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1178,9 +1165,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1190,41 +1177,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/data_integrations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/data_integrations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppIntegrations::DataIntegration' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppIntegrations::DataIntegration' - AND region = 'us-east-1' - data_integration: - name: data_integration - id: aws.appintegrations.data_integration - x-cfn-schema-name: DataIntegration - x-cfn-type-name: AWS::AppIntegrations::DataIntegration - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1235,12 +1190,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/data_integrations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/data_integrations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/data_integration/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/data_integrations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1259,24 +1218,40 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'DataIntegrationArn') as data_integration_arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'KmsKey') as kms_key, - json_extract_path_text(Properties, 'ScheduleConfig') as schedule_config, - json_extract_path_text(Properties, 'SourceURI') as source_uri, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'FileConfiguration') as file_configuration, - json_extract_path_text(Properties, 'ObjectConfiguration') as object_configuration - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AppIntegrations::DataIntegration' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppIntegrations::DataIntegration' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'DataIntegrationArn') as data_integration_arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'KmsKey') as kms_key, + json_extract_path_text(Properties, 'ScheduleConfig') as schedule_config, + json_extract_path_text(Properties, 'SourceURI') as source_uri, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'FileConfiguration') as file_configuration, + json_extract_path_text(Properties, 'ObjectConfiguration') as object_configuration + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AppIntegrations::DataIntegration' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppIntegrations::DataIntegration' + AND region = 'us-east-1' event_integrations: name: event_integrations id: aws.appintegrations.event_integrations @@ -1284,7 +1259,7 @@ components: x-cfn-type-name: AWS::AppIntegrations::EventIntegration x-identifiers: - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1301,9 +1276,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1313,41 +1288,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/event_integrations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/event_integrations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppIntegrations::EventIntegration' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppIntegrations::EventIntegration' - AND region = 'us-east-1' - event_integration: - name: event_integration - id: aws.appintegrations.event_integration - x-cfn-schema-name: EventIntegration - x-cfn-type-name: AWS::AppIntegrations::EventIntegration - x-identifiers: - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1358,12 +1301,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/event_integrations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/event_integrations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/event_integration/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/event_integrations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1378,20 +1325,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'EventIntegrationArn') as event_integration_arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'EventBridgeBus') as event_bridge_bus, - json_extract_path_text(Properties, 'EventFilter') as event_filter, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AppIntegrations::EventIntegration' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppIntegrations::EventIntegration' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'EventIntegrationArn') as event_integration_arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'EventBridgeBus') as event_bridge_bus, + json_extract_path_text(Properties, 'EventFilter') as event_filter, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AppIntegrations::EventIntegration' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppIntegrations::EventIntegration' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/applicationautoscaling.yaml b/providers/src/aws/v00.00.00000/services/applicationautoscaling.yaml index df2aa0f2..70b96a62 100644 --- a/providers/src/aws/v00.00.00000/services/applicationautoscaling.yaml +++ b/providers/src/aws/v00.00.00000/services/applicationautoscaling.yaml @@ -386,79 +386,160 @@ components: type: object schemas: SuspendedState: - type: object + description: |- + ``SuspendedState`` is a property of the [AWS::ApplicationAutoScaling::ScalableTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalabletarget.html) resource that specifies whether the scaling activities for a scalable target are in a suspended state. + For more information, see [Suspending and resuming scaling](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-suspend-resume-scaling.html) in the *Application Auto Scaling User Guide*. additionalProperties: false - description: specifies whether the scaling activities for a scalable target are in a suspended state + type: object properties: - ScheduledScalingSuspended: - type: boolean DynamicScalingOutSuspended: + description: Whether scale out by a target tracking scaling policy or a step scaling policy is suspended. Set the value to ``true`` if you don't want Application Auto Scaling to add capacity when a scaling policy is triggered. The default is ``false``. + type: boolean + ScheduledScalingSuspended: + description: Whether scheduled scaling is suspended. Set the value to ``true`` if you don't want Application Auto Scaling to add or remove capacity by initiating scheduled actions. The default is ``false``. type: boolean DynamicScalingInSuspended: + description: Whether scale in by a target tracking scaling policy or a step scaling policy is suspended. Set the value to ``true`` if you don't want Application Auto Scaling to remove capacity when a scaling policy is triggered. The default is ``false``. type: boolean ScheduledAction: - type: object + description: |- + ``ScheduledAction`` is a property of the [AWS::ApplicationAutoScaling::ScalableTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalabletarget.html) resource that specifies a scheduled action for a scalable target. + For more information, see [Scheduled scaling](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-scheduled-scaling.html) in the *Application Auto Scaling User Guide*. additionalProperties: false - description: specifies a scheduled action for a scalable target + type: object properties: Timezone: + description: The time zone used when referring to the date and time of a scheduled action, when the scheduled action uses an at or cron expression. type: string ScheduledActionName: + description: The name of the scheduled action. This name must be unique among all other scheduled actions on the specified scalable target. type: string EndTime: + description: The date and time that the action is scheduled to end, in UTC. type: string Schedule: + description: |- + The schedule for this action. The following formats are supported: + + At expressions - "``at(yyyy-mm-ddThh:mm:ss)``" + + Rate expressions - "``rate(value unit)``" + + Cron expressions - "``cron(fields)``" + + At expressions are useful for one-time schedules. Cron expressions are useful for scheduled actions that run periodically at a specified date and time, and rate expressions are useful for scheduled actions that run at a regular interval. + At and cron expressions use Universal Coordinated Time (UTC) by default. + The cron format consists of six fields separated by white spaces: [Minutes] [Hours] [Day_of_Month] [Month] [Day_of_Week] [Year]. + For rate expressions, *value* is a positive integer and *unit* is ``minute`` | ``minutes`` | ``hour`` | ``hours`` | ``day`` | ``days``. type: string StartTime: + description: The date and time that the action is scheduled to begin, in UTC. type: string ScalableTargetAction: + description: The new minimum and maximum capacity. You can set both values or just one. At the scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling scales in to the maximum capacity. $ref: '#/components/schemas/ScalableTargetAction' required: - ScheduledActionName - Schedule ScalableTargetAction: - type: object + description: '``ScalableTargetAction`` specifies the minimum and maximum capacity for the ``ScalableTargetAction`` property of the [AWS::ApplicationAutoScaling::ScalableTarget ScheduledAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalabletarget-scheduledaction.html) property type.' additionalProperties: false - description: specifies the minimum and maximum capacity + type: object properties: MinCapacity: + description: The minimum capacity. type: integer MaxCapacity: + description: The maximum capacity. type: integer ScalableTarget: type: object properties: - Id: - description: This value can be returned by using the Ref function. Ref returns the Cloudformation generated ID of the resource in format - ResourceId|ScalableDimension|ServiceNamespace - type: string - MaxCapacity: - description: The maximum value that you plan to scale in to. When a scaling policy is in effect, Application Auto Scaling can scale in (contract) as needed to the minimum capacity limit in response to changing demand - type: integer - MinCapacity: - description: The minimum value that you plan to scale in to. When a scaling policy is in effect, Application Auto Scaling can scale in (contract) as needed to the minimum capacity limit in response to changing demand - type: integer - ResourceId: - description: The identifier of the resource associated with the scalable target - type: string - RoleARN: - description: 'Specify the Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that allows Application Auto Scaling to modify the scalable target on your behalf. ' - type: string - ScalableDimension: - description: The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property - type: string ScheduledActions: - description: The scheduled actions for the scalable target. Duplicates aren't allowed. - type: array uniqueItems: true + description: The scheduled actions for the scalable target. Duplicates aren't allowed. x-insertionOrder: false + type: array items: $ref: '#/components/schemas/ScheduledAction' + ResourceId: + description: |- + The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier. + + ECS service - The resource type is ``service`` and the unique identifier is the cluster name and service name. Example: ``service/my-cluster/my-service``. + + Spot Fleet - The resource type is ``spot-fleet-request`` and the unique identifier is the Spot Fleet request ID. Example: ``spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE``. + + EMR cluster - The resource type is ``instancegroup`` and the unique identifier is the cluster ID and instance group ID. Example: ``instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0``. + + AppStream 2.0 fleet - The resource type is ``fleet`` and the unique identifier is the fleet name. Example: ``fleet/sample-fleet``. + + DynamoDB table - The resource type is ``table`` and the unique identifier is the table name. Example: ``table/my-table``. + + DynamoDB global secondary index - The resource type is ``index`` and the unique identifier is the index name. Example: ``table/my-table/index/my-table-index``. + + Aurora DB cluster - The resource type is ``cluster`` and the unique identifier is the cluster name. Example: ``cluster:my-db-cluster``. + + SageMaker endpoint variant - The resource type is ``variant`` and the unique identifier is the resource ID. Example: ``endpoint/my-end-point/variant/KMeansClustering``. + + Custom resources are not supported with a resource type. This parameter must specify the ``OutputValue`` from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our [GitHub repository](https://docs.aws.amazon.com/https://github.com/aws/aws-auto-scaling-custom-resource). + + Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: ``arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE``. + + Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: ``arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE``. + + Lambda provisioned concurrency - The resource type is ``function`` and the unique identifier is the function name with a function version or alias name suffix that is not ``$LATEST``. Example: ``function:my-function:prod`` or ``function:my-function:1``. + + Amazon Keyspaces table - The resource type is ``table`` and the unique identifier is the table name. Example: ``keyspace/mykeyspace/table/mytable``. + + Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: ``arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5``. + + Amazon ElastiCache replication group - The resource type is ``replication-group`` and the unique identifier is the replication group name. Example: ``replication-group/mycluster``. + + Neptune cluster - The resource type is ``cluster`` and the unique identifier is the cluster name. Example: ``cluster:mycluster``. + + SageMaker serverless endpoint - The resource type is ``variant`` and the unique identifier is the resource ID. Example: ``endpoint/my-end-point/variant/KMeansClustering``. + + SageMaker inference component - The resource type is ``inference-component`` and the unique identifier is the resource ID. Example: ``inference-component/my-inference-component``. + anyOf: + - relationshipRef: + typeName: AWS::MSK::Cluster + propertyPath: /properties/Arn + - relationshipRef: + typeName: AWS::ECS::Service + propertyPath: /properties/ServiceArn + type: string ServiceNamespace: - description: The namespace of the AWS service that provides the resource, or a custom-resource + description: The namespace of the AWS service that provides the resource, or a ``custom-resource``. + type: string + ScalableDimension: + description: |- + The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property. + + ``ecs:service:DesiredCount`` - The desired task count of an ECS service. + + ``elasticmapreduce:instancegroup:InstanceCount`` - The instance count of an EMR Instance Group. + + ``ec2:spot-fleet-request:TargetCapacity`` - The target capacity of a Spot Fleet. + + ``appstream:fleet:DesiredCapacity`` - The desired capacity of an AppStream 2.0 fleet. + + ``dynamodb:table:ReadCapacityUnits`` - The provisioned read capacity for a DynamoDB table. + + ``dynamodb:table:WriteCapacityUnits`` - The provisioned write capacity for a DynamoDB table. + + ``dynamodb:index:ReadCapacityUnits`` - The provisioned read capacity for a DynamoDB global secondary index. + + ``dynamodb:index:WriteCapacityUnits`` - The provisioned write capacity for a DynamoDB global secondary index. + + ``rds:cluster:ReadReplicaCount`` - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition. + + ``sagemaker:variant:DesiredInstanceCount`` - The number of EC2 instances for a SageMaker model endpoint variant. + + ``custom-resource:ResourceType:Property`` - The scalable dimension for a custom resource provided by your own application or service. + + ``comprehend:document-classifier-endpoint:DesiredInferenceUnits`` - The number of inference units for an Amazon Comprehend document classification endpoint. + + ``comprehend:entity-recognizer-endpoint:DesiredInferenceUnits`` - The number of inference units for an Amazon Comprehend entity recognizer endpoint. + + ``lambda:function:ProvisionedConcurrency`` - The provisioned concurrency for a Lambda function. + + ``cassandra:table:ReadCapacityUnits`` - The provisioned read capacity for an Amazon Keyspaces table. + + ``cassandra:table:WriteCapacityUnits`` - The provisioned write capacity for an Amazon Keyspaces table. + + ``kafka:broker-storage:VolumeSize`` - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster. + + ``elasticache:replication-group:NodeGroups`` - The number of node groups for an Amazon ElastiCache replication group. + + ``elasticache:replication-group:Replicas`` - The number of replicas per node group for an Amazon ElastiCache replication group. + + ``neptune:cluster:ReadReplicaCount`` - The count of read replicas in an Amazon Neptune DB cluster. + + ``sagemaker:variant:DesiredProvisionedConcurrency`` - The provisioned concurrency for a SageMaker serverless endpoint. + + ``sagemaker:inference-component:DesiredCopyCount`` - The number of copies across an endpoint for a SageMaker inference component. type: string SuspendedState: - description: An embedded object that contains attributes and attribute values that are used to suspend and resume automatic scaling. Setting the value of an attribute to true suspends the specified scaling activities. Setting it to false (default) resumes the specified scaling activities. + description: |- + An embedded object that contains attributes and attribute values that are used to suspend and resume automatic scaling. Setting the value of an attribute to ``true`` suspends the specified scaling activities. Setting it to ``false`` (default) resumes the specified scaling activities. + *Suspension Outcomes* + + For ``DynamicScalingInSuspended``, while a suspension is in effect, all scale-in activities that are triggered by a scaling policy are suspended. + + For ``DynamicScalingOutSuspended``, while a suspension is in effect, all scale-out activities that are triggered by a scaling policy are suspended. + + For ``ScheduledScalingSuspended``, while a suspension is in effect, all scaling activities that involve scheduled actions are suspended. $ref: '#/components/schemas/SuspendedState' + Id: + description: '' + type: string + MinCapacity: + description: The minimum value that you plan to scale in to. When a scaling policy is in effect, Application Auto Scaling can scale in (contract) as needed to the minimum capacity limit in response to changing demand. + type: integer + RoleARN: + description: >- + Specify the Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that allows Application Auto Scaling to modify the scalable target on your behalf. This can be either an IAM service role that Application Auto Scaling can assume to make calls to other AWS resources on your behalf, or a service-linked role for the specified service. For more information, see [How Application Auto Scaling works with + IAM](https://docs.aws.amazon.com/autoscaling/application/userguide/security_iam_service-with-iam.html) in the *Application Auto Scaling User Guide*. + To automatically create a service-linked role (recommended), specify the full ARN of the service-linked role in your stack template. To find the exact ARN of the service-linked role for your AWS or custom resource, see the [Service-linked roles](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-service-linked-roles.html) topic in the *Application Auto Scaling User Guide*. Look for the ARN in the table at the bottom of the page. + type: string + MaxCapacity: + description: The maximum value that you plan to scale out to. When a scaling policy is in effect, Application Auto Scaling can scale out (expand) as needed to the maximum capacity limit in response to changing demand. + type: integer required: - ResourceId - ServiceNamespace @@ -466,7 +547,10 @@ components: - MinCapacity - MaxCapacity x-stackql-resource-name: scalable_target - description: Resource Type definition for AWS::ApplicationAutoScaling::ScalableTarget + description: |- + The ``AWS::ApplicationAutoScaling::ScalableTarget`` resource specifies a resource that Application Auto Scaling can scale, such as an AWS::DynamoDB::Table or AWS::ECS::Service resource. + For more information, see [Getting started](https://docs.aws.amazon.com/autoscaling/application/userguide/getting-started.html) in the *Application Auto Scaling User Guide*. + If the resource that you want Application Auto Scaling to scale is not yet created in your account, add a dependency on the resource when registering it as a scalable target using the [DependsOn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) attribute. x-type-name: AWS::ApplicationAutoScaling::ScalableTarget x-stackql-primary-identifier: - ResourceId @@ -492,6 +576,9 @@ components: tagUpdatable: false cloudFormationSystemTags: false x-required-permissions: + read: + - application-autoscaling:DescribeScalableTargets + - application-autoscaling:DescribeScheduledActions create: - application-autoscaling:DescribeScalableTargets - application-autoscaling:RegisterScalableTarget @@ -505,11 +592,6 @@ components: - lambda:GetProvisionedConcurrencyConfig - lambda:PutProvisionedConcurrencyConfig - lambda:DeleteProvisionedConcurrencyConfig - read: - - application-autoscaling:DescribeScalableTargets - - application-autoscaling:DescribeScheduledActions - list: - - application-autoscaling:DescribeScalableTargets update: - application-autoscaling:RegisterScalableTarget - application-autoscaling:DescribeScalableTargets @@ -522,6 +604,8 @@ components: - lambda:GetProvisionedConcurrencyConfig - lambda:PutProvisionedConcurrencyConfig - lambda:DeleteProvisionedConcurrencyConfig + list: + - application-autoscaling:DescribeScalableTargets delete: - application-autoscaling:DeregisterScalableTarget StepScalingPolicyConfiguration: @@ -805,37 +889,94 @@ components: DesiredState: type: object properties: - Id: - description: This value can be returned by using the Ref function. Ref returns the Cloudformation generated ID of the resource in format - ResourceId|ScalableDimension|ServiceNamespace - type: string - MaxCapacity: - description: The maximum value that you plan to scale in to. When a scaling policy is in effect, Application Auto Scaling can scale in (contract) as needed to the minimum capacity limit in response to changing demand - type: integer - MinCapacity: - description: The minimum value that you plan to scale in to. When a scaling policy is in effect, Application Auto Scaling can scale in (contract) as needed to the minimum capacity limit in response to changing demand - type: integer - ResourceId: - description: The identifier of the resource associated with the scalable target - type: string - RoleARN: - description: 'Specify the Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that allows Application Auto Scaling to modify the scalable target on your behalf. ' - type: string - ScalableDimension: - description: The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property - type: string ScheduledActions: - description: The scheduled actions for the scalable target. Duplicates aren't allowed. - type: array uniqueItems: true + description: The scheduled actions for the scalable target. Duplicates aren't allowed. x-insertionOrder: false + type: array items: $ref: '#/components/schemas/ScheduledAction' + ResourceId: + description: |- + The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier. + + ECS service - The resource type is ``service`` and the unique identifier is the cluster name and service name. Example: ``service/my-cluster/my-service``. + + Spot Fleet - The resource type is ``spot-fleet-request`` and the unique identifier is the Spot Fleet request ID. Example: ``spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE``. + + EMR cluster - The resource type is ``instancegroup`` and the unique identifier is the cluster ID and instance group ID. Example: ``instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0``. + + AppStream 2.0 fleet - The resource type is ``fleet`` and the unique identifier is the fleet name. Example: ``fleet/sample-fleet``. + + DynamoDB table - The resource type is ``table`` and the unique identifier is the table name. Example: ``table/my-table``. + + DynamoDB global secondary index - The resource type is ``index`` and the unique identifier is the index name. Example: ``table/my-table/index/my-table-index``. + + Aurora DB cluster - The resource type is ``cluster`` and the unique identifier is the cluster name. Example: ``cluster:my-db-cluster``. + + SageMaker endpoint variant - The resource type is ``variant`` and the unique identifier is the resource ID. Example: ``endpoint/my-end-point/variant/KMeansClustering``. + + Custom resources are not supported with a resource type. This parameter must specify the ``OutputValue`` from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our [GitHub repository](https://docs.aws.amazon.com/https://github.com/aws/aws-auto-scaling-custom-resource). + + Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: ``arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE``. + + Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: ``arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE``. + + Lambda provisioned concurrency - The resource type is ``function`` and the unique identifier is the function name with a function version or alias name suffix that is not ``$LATEST``. Example: ``function:my-function:prod`` or ``function:my-function:1``. + + Amazon Keyspaces table - The resource type is ``table`` and the unique identifier is the table name. Example: ``keyspace/mykeyspace/table/mytable``. + + Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: ``arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5``. + + Amazon ElastiCache replication group - The resource type is ``replication-group`` and the unique identifier is the replication group name. Example: ``replication-group/mycluster``. + + Neptune cluster - The resource type is ``cluster`` and the unique identifier is the cluster name. Example: ``cluster:mycluster``. + + SageMaker serverless endpoint - The resource type is ``variant`` and the unique identifier is the resource ID. Example: ``endpoint/my-end-point/variant/KMeansClustering``. + + SageMaker inference component - The resource type is ``inference-component`` and the unique identifier is the resource ID. Example: ``inference-component/my-inference-component``. + anyOf: + - relationshipRef: + typeName: AWS::MSK::Cluster + propertyPath: /properties/Arn + - relationshipRef: + typeName: AWS::ECS::Service + propertyPath: /properties/ServiceArn + type: string ServiceNamespace: - description: The namespace of the AWS service that provides the resource, or a custom-resource + description: The namespace of the AWS service that provides the resource, or a ``custom-resource``. + type: string + ScalableDimension: + description: |- + The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property. + + ``ecs:service:DesiredCount`` - The desired task count of an ECS service. + + ``elasticmapreduce:instancegroup:InstanceCount`` - The instance count of an EMR Instance Group. + + ``ec2:spot-fleet-request:TargetCapacity`` - The target capacity of a Spot Fleet. + + ``appstream:fleet:DesiredCapacity`` - The desired capacity of an AppStream 2.0 fleet. + + ``dynamodb:table:ReadCapacityUnits`` - The provisioned read capacity for a DynamoDB table. + + ``dynamodb:table:WriteCapacityUnits`` - The provisioned write capacity for a DynamoDB table. + + ``dynamodb:index:ReadCapacityUnits`` - The provisioned read capacity for a DynamoDB global secondary index. + + ``dynamodb:index:WriteCapacityUnits`` - The provisioned write capacity for a DynamoDB global secondary index. + + ``rds:cluster:ReadReplicaCount`` - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition. + + ``sagemaker:variant:DesiredInstanceCount`` - The number of EC2 instances for a SageMaker model endpoint variant. + + ``custom-resource:ResourceType:Property`` - The scalable dimension for a custom resource provided by your own application or service. + + ``comprehend:document-classifier-endpoint:DesiredInferenceUnits`` - The number of inference units for an Amazon Comprehend document classification endpoint. + + ``comprehend:entity-recognizer-endpoint:DesiredInferenceUnits`` - The number of inference units for an Amazon Comprehend entity recognizer endpoint. + + ``lambda:function:ProvisionedConcurrency`` - The provisioned concurrency for a Lambda function. + + ``cassandra:table:ReadCapacityUnits`` - The provisioned read capacity for an Amazon Keyspaces table. + + ``cassandra:table:WriteCapacityUnits`` - The provisioned write capacity for an Amazon Keyspaces table. + + ``kafka:broker-storage:VolumeSize`` - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster. + + ``elasticache:replication-group:NodeGroups`` - The number of node groups for an Amazon ElastiCache replication group. + + ``elasticache:replication-group:Replicas`` - The number of replicas per node group for an Amazon ElastiCache replication group. + + ``neptune:cluster:ReadReplicaCount`` - The count of read replicas in an Amazon Neptune DB cluster. + + ``sagemaker:variant:DesiredProvisionedConcurrency`` - The provisioned concurrency for a SageMaker serverless endpoint. + + ``sagemaker:inference-component:DesiredCopyCount`` - The number of copies across an endpoint for a SageMaker inference component. type: string SuspendedState: - description: An embedded object that contains attributes and attribute values that are used to suspend and resume automatic scaling. Setting the value of an attribute to true suspends the specified scaling activities. Setting it to false (default) resumes the specified scaling activities. + description: |- + An embedded object that contains attributes and attribute values that are used to suspend and resume automatic scaling. Setting the value of an attribute to ``true`` suspends the specified scaling activities. Setting it to ``false`` (default) resumes the specified scaling activities. + *Suspension Outcomes* + + For ``DynamicScalingInSuspended``, while a suspension is in effect, all scale-in activities that are triggered by a scaling policy are suspended. + + For ``DynamicScalingOutSuspended``, while a suspension is in effect, all scale-out activities that are triggered by a scaling policy are suspended. + + For ``ScheduledScalingSuspended``, while a suspension is in effect, all scaling activities that involve scheduled actions are suspended. $ref: '#/components/schemas/SuspendedState' + Id: + description: '' + type: string + MinCapacity: + description: The minimum value that you plan to scale in to. When a scaling policy is in effect, Application Auto Scaling can scale in (contract) as needed to the minimum capacity limit in response to changing demand. + type: integer + RoleARN: + description: >- + Specify the Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that allows Application Auto Scaling to modify the scalable target on your behalf. This can be either an IAM service role that Application Auto Scaling can assume to make calls to other AWS resources on your behalf, or a service-linked role for the specified service. For more information, see [How Application Auto Scaling works with + IAM](https://docs.aws.amazon.com/autoscaling/application/userguide/security_iam_service-with-iam.html) in the *Application Auto Scaling User Guide*. + To automatically create a service-linked role (recommended), specify the full ARN of the service-linked role in your stack template. To find the exact ARN of the service-linked role for your AWS or custom resource, see the [Service-linked roles](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-service-linked-roles.html) topic in the *Application Auto Scaling User Guide*. Look for the ARN in the table at the bottom of the page. + type: string + MaxCapacity: + description: The maximum value that you plan to scale out to. When a scaling policy is in effect, Application Auto Scaling can scale out (expand) as needed to the maximum capacity limit in response to changing demand. + type: integer x-stackQL-stringOnly: true x-title: CreateScalableTargetRequest type: object @@ -911,7 +1052,7 @@ components: - ResourceId - ScalableDimension - ServiceNamespace - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -928,9 +1069,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -940,47 +1081,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/scalable_targets/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/scalable_targets/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ResourceId') as resource_id, - JSON_EXTRACT(Properties, '$.ScalableDimension') as scalable_dimension, - JSON_EXTRACT(Properties, '$.ServiceNamespace') as service_namespace - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApplicationAutoScaling::ScalableTarget' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ResourceId') as resource_id, - json_extract_path_text(Properties, 'ScalableDimension') as scalable_dimension, - json_extract_path_text(Properties, 'ServiceNamespace') as service_namespace - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApplicationAutoScaling::ScalableTarget' - AND region = 'us-east-1' - scalable_target: - name: scalable_target - id: aws.applicationautoscaling.scalable_target - x-cfn-schema-name: ScalableTarget - x-cfn-type-name: AWS::ApplicationAutoScaling::ScalableTarget - x-identifiers: - - ResourceId - - ScalableDimension - - ServiceNamespace - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -991,46 +1094,70 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/scalable_targets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/scalable_targets/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/scalable_target/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/scalable_targets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, + JSON_EXTRACT(Properties, '$.ScheduledActions') as scheduled_actions, + JSON_EXTRACT(Properties, '$.ResourceId') as resource_id, + JSON_EXTRACT(Properties, '$.ServiceNamespace') as service_namespace, + JSON_EXTRACT(Properties, '$.ScalableDimension') as scalable_dimension, + JSON_EXTRACT(Properties, '$.SuspendedState') as suspended_state, JSON_EXTRACT(Properties, '$.Id') as id, - JSON_EXTRACT(Properties, '$.MaxCapacity') as max_capacity, JSON_EXTRACT(Properties, '$.MinCapacity') as min_capacity, - JSON_EXTRACT(Properties, '$.ResourceId') as resource_id, JSON_EXTRACT(Properties, '$.RoleARN') as role_arn, - JSON_EXTRACT(Properties, '$.ScalableDimension') as scalable_dimension, - JSON_EXTRACT(Properties, '$.ScheduledActions') as scheduled_actions, - JSON_EXTRACT(Properties, '$.ServiceNamespace') as service_namespace, - JSON_EXTRACT(Properties, '$.SuspendedState') as suspended_state + JSON_EXTRACT(Properties, '$.MaxCapacity') as max_capacity FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApplicationAutoScaling::ScalableTarget' AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'MaxCapacity') as max_capacity, - json_extract_path_text(Properties, 'MinCapacity') as min_capacity, - json_extract_path_text(Properties, 'ResourceId') as resource_id, - json_extract_path_text(Properties, 'RoleARN') as role_arn, - json_extract_path_text(Properties, 'ScalableDimension') as scalable_dimension, - json_extract_path_text(Properties, 'ScheduledActions') as scheduled_actions, - json_extract_path_text(Properties, 'ServiceNamespace') as service_namespace, - json_extract_path_text(Properties, 'SuspendedState') as suspended_state - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApplicationAutoScaling::ScalableTarget' - AND data__Identifier = '||' + JSON_EXTRACT(Properties, '$.ResourceId') as resource_id, + JSON_EXTRACT(Properties, '$.ScalableDimension') as scalable_dimension, + JSON_EXTRACT(Properties, '$.ServiceNamespace') as service_namespace + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApplicationAutoScaling::ScalableTarget' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ScheduledActions') as scheduled_actions, + json_extract_path_text(Properties, 'ResourceId') as resource_id, + json_extract_path_text(Properties, 'ServiceNamespace') as service_namespace, + json_extract_path_text(Properties, 'ScalableDimension') as scalable_dimension, + json_extract_path_text(Properties, 'SuspendedState') as suspended_state, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'MinCapacity') as min_capacity, + json_extract_path_text(Properties, 'RoleARN') as role_arn, + json_extract_path_text(Properties, 'MaxCapacity') as max_capacity + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApplicationAutoScaling::ScalableTarget' + AND data__Identifier = '||' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ResourceId') as resource_id, + json_extract_path_text(Properties, 'ScalableDimension') as scalable_dimension, + json_extract_path_text(Properties, 'ServiceNamespace') as service_namespace + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApplicationAutoScaling::ScalableTarget' + AND region = 'us-east-1' scaling_policies: name: scaling_policies id: aws.applicationautoscaling.scaling_policies @@ -1039,7 +1166,7 @@ components: x-identifiers: - Arn - ScalableDimension - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1056,9 +1183,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1068,44 +1195,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/scaling_policies/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/scaling_policies/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn, - JSON_EXTRACT(Properties, '$.ScalableDimension') as scalable_dimension - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApplicationAutoScaling::ScalingPolicy' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'ScalableDimension') as scalable_dimension - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApplicationAutoScaling::ScalingPolicy' - AND region = 'us-east-1' - scaling_policy: - name: scaling_policy - id: aws.applicationautoscaling.scaling_policy - x-cfn-schema-name: ScalingPolicy - x-cfn-type-name: AWS::ApplicationAutoScaling::ScalingPolicy - x-identifiers: - - Arn - - ScalableDimension - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1116,12 +1208,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/scaling_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/scaling_policies/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/scaling_policy/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/scaling_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1139,23 +1235,41 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'PolicyName') as policy_name, - json_extract_path_text(Properties, 'PolicyType') as policy_type, - json_extract_path_text(Properties, 'ResourceId') as resource_id, - json_extract_path_text(Properties, 'ScalableDimension') as scalable_dimension, - json_extract_path_text(Properties, 'ScalingTargetId') as scaling_target_id, - json_extract_path_text(Properties, 'ServiceNamespace') as service_namespace, - json_extract_path_text(Properties, 'StepScalingPolicyConfiguration') as step_scaling_policy_configuration, - json_extract_path_text(Properties, 'TargetTrackingScalingPolicyConfiguration') as target_tracking_scaling_policy_configuration, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApplicationAutoScaling::ScalingPolicy' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.ScalableDimension') as scalable_dimension + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApplicationAutoScaling::ScalingPolicy' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'PolicyName') as policy_name, + json_extract_path_text(Properties, 'PolicyType') as policy_type, + json_extract_path_text(Properties, 'ResourceId') as resource_id, + json_extract_path_text(Properties, 'ScalableDimension') as scalable_dimension, + json_extract_path_text(Properties, 'ScalingTargetId') as scaling_target_id, + json_extract_path_text(Properties, 'ServiceNamespace') as service_namespace, + json_extract_path_text(Properties, 'StepScalingPolicyConfiguration') as step_scaling_policy_configuration, + json_extract_path_text(Properties, 'TargetTrackingScalingPolicyConfiguration') as target_tracking_scaling_policy_configuration, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApplicationAutoScaling::ScalingPolicy' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'ScalableDimension') as scalable_dimension + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApplicationAutoScaling::ScalingPolicy' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/applicationinsights.yaml b/providers/src/aws/v00.00.00000/services/applicationinsights.yaml index 641fd67e..c6db706d 100644 --- a/providers/src/aws/v00.00.00000/services/applicationinsights.yaml +++ b/providers/src/aws/v00.00.00000/services/applicationinsights.yaml @@ -1027,7 +1027,7 @@ components: x-cfn-type-name: AWS::ApplicationInsights::Application x-identifiers: - ApplicationARN - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1044,9 +1044,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1056,41 +1056,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/applications/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/applications/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ApplicationARN') as application_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApplicationInsights::Application' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ApplicationARN') as application_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApplicationInsights::Application' - AND region = 'us-east-1' - application: - name: application - id: aws.applicationinsights.application - x-cfn-schema-name: Application - x-cfn-type-name: AWS::ApplicationInsights::Application - x-identifiers: - - ApplicationARN - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1101,12 +1069,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/applications/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/applications/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/application/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/applications/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1127,26 +1099,42 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ResourceGroupName') as resource_group_name, - json_extract_path_text(Properties, 'ApplicationARN') as application_arn, - json_extract_path_text(Properties, 'CWEMonitorEnabled') as cwe_monitor_enabled, - json_extract_path_text(Properties, 'OpsCenterEnabled') as ops_center_enabled, - json_extract_path_text(Properties, 'OpsItemSNSTopicArn') as ops_item_sns_topic_arn, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'CustomComponents') as custom_components, - json_extract_path_text(Properties, 'LogPatternSets') as log_pattern_sets, - json_extract_path_text(Properties, 'AutoConfigurationEnabled') as auto_configuration_enabled, - json_extract_path_text(Properties, 'ComponentMonitoringSettings') as component_monitoring_settings, - json_extract_path_text(Properties, 'GroupingType') as grouping_type, - json_extract_path_text(Properties, 'AttachMissingPermission') as attach_missing_permission - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApplicationInsights::Application' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ApplicationARN') as application_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApplicationInsights::Application' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ResourceGroupName') as resource_group_name, + json_extract_path_text(Properties, 'ApplicationARN') as application_arn, + json_extract_path_text(Properties, 'CWEMonitorEnabled') as cwe_monitor_enabled, + json_extract_path_text(Properties, 'OpsCenterEnabled') as ops_center_enabled, + json_extract_path_text(Properties, 'OpsItemSNSTopicArn') as ops_item_sns_topic_arn, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'CustomComponents') as custom_components, + json_extract_path_text(Properties, 'LogPatternSets') as log_pattern_sets, + json_extract_path_text(Properties, 'AutoConfigurationEnabled') as auto_configuration_enabled, + json_extract_path_text(Properties, 'ComponentMonitoringSettings') as component_monitoring_settings, + json_extract_path_text(Properties, 'GroupingType') as grouping_type, + json_extract_path_text(Properties, 'AttachMissingPermission') as attach_missing_permission + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ApplicationInsights::Application' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ApplicationARN') as application_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ApplicationInsights::Application' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/apprunner.yaml b/providers/src/aws/v00.00.00000/services/apprunner.yaml index dabe2a06..0172856d 100644 --- a/providers/src/aws/v00.00.00000/services/apprunner.yaml +++ b/providers/src/aws/v00.00.00000/services/apprunner.yaml @@ -1397,7 +1397,7 @@ components: x-cfn-type-name: AWS::AppRunner::AutoScalingConfiguration x-identifiers: - AutoScalingConfigurationArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1431,39 +1431,11 @@ components: - $ref: '#/components/x-stackQL-resources/auto_scaling_configurations/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/auto_scaling_configurations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AutoScalingConfigurationArn') as auto_scaling_configuration_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppRunner::AutoScalingConfiguration' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AutoScalingConfigurationArn') as auto_scaling_configuration_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppRunner::AutoScalingConfiguration' - AND region = 'us-east-1' - auto_scaling_configuration: - name: auto_scaling_configuration - id: aws.apprunner.auto_scaling_configuration - x-cfn-schema-name: AutoScalingConfiguration - x-cfn-type-name: AWS::AppRunner::AutoScalingConfiguration - x-identifiers: - - AutoScalingConfigurationArn - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1480,22 +1452,38 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AutoScalingConfigurationArn') as auto_scaling_configuration_arn, - json_extract_path_text(Properties, 'AutoScalingConfigurationName') as auto_scaling_configuration_name, - json_extract_path_text(Properties, 'AutoScalingConfigurationRevision') as auto_scaling_configuration_revision, - json_extract_path_text(Properties, 'MaxConcurrency') as max_concurrency, - json_extract_path_text(Properties, 'MaxSize') as max_size, - json_extract_path_text(Properties, 'MinSize') as min_size, - json_extract_path_text(Properties, 'Latest') as latest, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AppRunner::AutoScalingConfiguration' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.AutoScalingConfigurationArn') as auto_scaling_configuration_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppRunner::AutoScalingConfiguration' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AutoScalingConfigurationArn') as auto_scaling_configuration_arn, + json_extract_path_text(Properties, 'AutoScalingConfigurationName') as auto_scaling_configuration_name, + json_extract_path_text(Properties, 'AutoScalingConfigurationRevision') as auto_scaling_configuration_revision, + json_extract_path_text(Properties, 'MaxConcurrency') as max_concurrency, + json_extract_path_text(Properties, 'MaxSize') as max_size, + json_extract_path_text(Properties, 'MinSize') as min_size, + json_extract_path_text(Properties, 'Latest') as latest, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AppRunner::AutoScalingConfiguration' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AutoScalingConfigurationArn') as auto_scaling_configuration_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppRunner::AutoScalingConfiguration' + AND region = 'us-east-1' observability_configurations: name: observability_configurations id: aws.apprunner.observability_configurations @@ -1503,7 +1491,7 @@ components: x-cfn-type-name: AWS::AppRunner::ObservabilityConfiguration x-identifiers: - ObservabilityConfigurationArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1537,39 +1525,11 @@ components: - $ref: '#/components/x-stackQL-resources/observability_configurations/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/observability_configurations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ObservabilityConfigurationArn') as observability_configuration_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppRunner::ObservabilityConfiguration' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ObservabilityConfigurationArn') as observability_configuration_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppRunner::ObservabilityConfiguration' - AND region = 'us-east-1' - observability_configuration: - name: observability_configuration - id: aws.apprunner.observability_configuration - x-cfn-schema-name: ObservabilityConfiguration - x-cfn-type-name: AWS::AppRunner::ObservabilityConfiguration - x-identifiers: - - ObservabilityConfigurationArn - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1584,20 +1544,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ObservabilityConfigurationArn') as observability_configuration_arn, - json_extract_path_text(Properties, 'ObservabilityConfigurationName') as observability_configuration_name, - json_extract_path_text(Properties, 'ObservabilityConfigurationRevision') as observability_configuration_revision, - json_extract_path_text(Properties, 'Latest') as latest, - json_extract_path_text(Properties, 'TraceConfiguration') as trace_configuration, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AppRunner::ObservabilityConfiguration' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ObservabilityConfigurationArn') as observability_configuration_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppRunner::ObservabilityConfiguration' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ObservabilityConfigurationArn') as observability_configuration_arn, + json_extract_path_text(Properties, 'ObservabilityConfigurationName') as observability_configuration_name, + json_extract_path_text(Properties, 'ObservabilityConfigurationRevision') as observability_configuration_revision, + json_extract_path_text(Properties, 'Latest') as latest, + json_extract_path_text(Properties, 'TraceConfiguration') as trace_configuration, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AppRunner::ObservabilityConfiguration' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ObservabilityConfigurationArn') as observability_configuration_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppRunner::ObservabilityConfiguration' + AND region = 'us-east-1' services: name: services id: aws.apprunner.services @@ -1605,7 +1581,7 @@ components: x-cfn-type-name: AWS::AppRunner::Service x-identifiers: - ServiceArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1622,9 +1598,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1634,41 +1610,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/services/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/services/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ServiceArn') as service_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppRunner::Service' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ServiceArn') as service_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppRunner::Service' - AND region = 'us-east-1' - service: - name: service - id: aws.apprunner.service - x-cfn-schema-name: Service - x-cfn-type-name: AWS::AppRunner::Service - x-identifiers: - - ServiceArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1679,12 +1623,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/services/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/services/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/service/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/services/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1706,27 +1654,43 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ServiceName') as service_name, - json_extract_path_text(Properties, 'ServiceId') as service_id, - json_extract_path_text(Properties, 'ServiceArn') as service_arn, - json_extract_path_text(Properties, 'ServiceUrl') as service_url, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'SourceConfiguration') as source_configuration, - json_extract_path_text(Properties, 'InstanceConfiguration') as instance_configuration, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'EncryptionConfiguration') as encryption_configuration, - json_extract_path_text(Properties, 'HealthCheckConfiguration') as health_check_configuration, - json_extract_path_text(Properties, 'ObservabilityConfiguration') as observability_configuration, - json_extract_path_text(Properties, 'AutoScalingConfigurationArn') as auto_scaling_configuration_arn, - json_extract_path_text(Properties, 'NetworkConfiguration') as network_configuration - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AppRunner::Service' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ServiceArn') as service_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppRunner::Service' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ServiceName') as service_name, + json_extract_path_text(Properties, 'ServiceId') as service_id, + json_extract_path_text(Properties, 'ServiceArn') as service_arn, + json_extract_path_text(Properties, 'ServiceUrl') as service_url, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'SourceConfiguration') as source_configuration, + json_extract_path_text(Properties, 'InstanceConfiguration') as instance_configuration, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'EncryptionConfiguration') as encryption_configuration, + json_extract_path_text(Properties, 'HealthCheckConfiguration') as health_check_configuration, + json_extract_path_text(Properties, 'ObservabilityConfiguration') as observability_configuration, + json_extract_path_text(Properties, 'AutoScalingConfigurationArn') as auto_scaling_configuration_arn, + json_extract_path_text(Properties, 'NetworkConfiguration') as network_configuration + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AppRunner::Service' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ServiceArn') as service_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppRunner::Service' + AND region = 'us-east-1' vpc_connectors: name: vpc_connectors id: aws.apprunner.vpc_connectors @@ -1734,7 +1698,7 @@ components: x-cfn-type-name: AWS::AppRunner::VpcConnector x-identifiers: - VpcConnectorArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1768,39 +1732,11 @@ components: - $ref: '#/components/x-stackQL-resources/vpc_connectors/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/vpc_connectors/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.VpcConnectorArn') as vpc_connector_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppRunner::VpcConnector' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'VpcConnectorArn') as vpc_connector_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppRunner::VpcConnector' - AND region = 'us-east-1' - vpc_connector: - name: vpc_connector - id: aws.apprunner.vpc_connector - x-cfn-schema-name: VpcConnector - x-cfn-type-name: AWS::AppRunner::VpcConnector - x-identifiers: - - VpcConnectorArn - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1815,20 +1751,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'VpcConnectorName') as vpc_connector_name, - json_extract_path_text(Properties, 'VpcConnectorArn') as vpc_connector_arn, - json_extract_path_text(Properties, 'VpcConnectorRevision') as vpc_connector_revision, - json_extract_path_text(Properties, 'Subnets') as subnets, - json_extract_path_text(Properties, 'SecurityGroups') as security_groups, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AppRunner::VpcConnector' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.VpcConnectorArn') as vpc_connector_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppRunner::VpcConnector' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'VpcConnectorName') as vpc_connector_name, + json_extract_path_text(Properties, 'VpcConnectorArn') as vpc_connector_arn, + json_extract_path_text(Properties, 'VpcConnectorRevision') as vpc_connector_revision, + json_extract_path_text(Properties, 'Subnets') as subnets, + json_extract_path_text(Properties, 'SecurityGroups') as security_groups, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AppRunner::VpcConnector' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'VpcConnectorArn') as vpc_connector_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppRunner::VpcConnector' + AND region = 'us-east-1' vpc_ingress_connections: name: vpc_ingress_connections id: aws.apprunner.vpc_ingress_connections @@ -1836,7 +1788,7 @@ components: x-cfn-type-name: AWS::AppRunner::VpcIngressConnection x-identifiers: - VpcIngressConnectionArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1853,9 +1805,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1865,41 +1817,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/vpc_ingress_connections/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/vpc_ingress_connections/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.VpcIngressConnectionArn') as vpc_ingress_connection_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppRunner::VpcIngressConnection' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'VpcIngressConnectionArn') as vpc_ingress_connection_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppRunner::VpcIngressConnection' - AND region = 'us-east-1' - vpc_ingress_connection: - name: vpc_ingress_connection - id: aws.apprunner.vpc_ingress_connection - x-cfn-schema-name: VpcIngressConnection - x-cfn-type-name: AWS::AppRunner::VpcIngressConnection - x-identifiers: - - VpcIngressConnectionArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1910,12 +1830,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/vpc_ingress_connections/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/vpc_ingress_connections/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/vpc_ingress_connection/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/vpc_ingress_connections/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1931,21 +1855,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'VpcIngressConnectionArn') as vpc_ingress_connection_arn, - json_extract_path_text(Properties, 'VpcIngressConnectionName') as vpc_ingress_connection_name, - json_extract_path_text(Properties, 'ServiceArn') as service_arn, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'DomainName') as domain_name, - json_extract_path_text(Properties, 'IngressVpcConfiguration') as ingress_vpc_configuration, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AppRunner::VpcIngressConnection' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.VpcIngressConnectionArn') as vpc_ingress_connection_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppRunner::VpcIngressConnection' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'VpcIngressConnectionArn') as vpc_ingress_connection_arn, + json_extract_path_text(Properties, 'VpcIngressConnectionName') as vpc_ingress_connection_name, + json_extract_path_text(Properties, 'ServiceArn') as service_arn, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'DomainName') as domain_name, + json_extract_path_text(Properties, 'IngressVpcConfiguration') as ingress_vpc_configuration, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AppRunner::VpcIngressConnection' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'VpcIngressConnectionArn') as vpc_ingress_connection_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppRunner::VpcIngressConnection' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/appstream.yaml b/providers/src/aws/v00.00.00000/services/appstream.yaml index 9ed8669a..cc39e552 100644 --- a/providers/src/aws/v00.00.00000/services/appstream.yaml +++ b/providers/src/aws/v00.00.00000/services/appstream.yaml @@ -1387,7 +1387,7 @@ components: x-cfn-type-name: AWS::AppStream::AppBlock x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1421,21 +1421,11 @@ components: - $ref: '#/components/x-stackQL-resources/app_blocks/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/app_blocks/methods/delete_resource' - app_block: - name: app_block - id: aws.appstream.app_block - x-cfn-schema-name: AppBlock - x-cfn-type-name: AWS::AppStream::AppBlock - x-identifiers: - - Arn - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1454,7 +1444,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1479,7 +1469,7 @@ components: x-cfn-type-name: AWS::AppStream::AppBlockBuilder x-identifiers: - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1496,9 +1486,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1508,41 +1498,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/app_block_builders/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/app_block_builders/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppStream::AppBlockBuilder' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppStream::AppBlockBuilder' - AND region = 'us-east-1' - app_block_builder: - name: app_block_builder - id: aws.appstream.app_block_builder - x-cfn-schema-name: AppBlockBuilder - x-cfn-type-name: AWS::AppStream::AppBlockBuilder - x-identifiers: - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1553,12 +1511,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/app_block_builders/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/app_block_builders/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/app_block_builder/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/app_block_builders/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1580,27 +1542,43 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'DisplayName') as display_name, - json_extract_path_text(Properties, 'Platform') as platform, - json_extract_path_text(Properties, 'AccessEndpoints') as access_endpoints, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'VpcConfig') as vpc_config, - json_extract_path_text(Properties, 'EnableDefaultInternetAccess') as enable_default_internet_access, - json_extract_path_text(Properties, 'IamRoleArn') as iam_role_arn, - json_extract_path_text(Properties, 'CreatedTime') as created_time, - json_extract_path_text(Properties, 'InstanceType') as instance_type, - json_extract_path_text(Properties, 'AppBlockArns') as app_block_arns - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AppStream::AppBlockBuilder' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppStream::AppBlockBuilder' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'DisplayName') as display_name, + json_extract_path_text(Properties, 'Platform') as platform, + json_extract_path_text(Properties, 'AccessEndpoints') as access_endpoints, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'VpcConfig') as vpc_config, + json_extract_path_text(Properties, 'EnableDefaultInternetAccess') as enable_default_internet_access, + json_extract_path_text(Properties, 'IamRoleArn') as iam_role_arn, + json_extract_path_text(Properties, 'CreatedTime') as created_time, + json_extract_path_text(Properties, 'InstanceType') as instance_type, + json_extract_path_text(Properties, 'AppBlockArns') as app_block_arns + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AppStream::AppBlockBuilder' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppStream::AppBlockBuilder' + AND region = 'us-east-1' applications: name: applications id: aws.appstream.applications @@ -1608,7 +1586,7 @@ components: x-cfn-type-name: AWS::AppStream::Application x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1625,9 +1603,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1637,23 +1615,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/applications/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/applications/methods/delete_resource' - application: - name: application - id: aws.appstream.application - x-cfn-schema-name: Application - x-cfn-type-name: AWS::AppStream::Application - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1664,12 +1628,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/applications/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/applications/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/application/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/applications/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1692,7 +1660,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1723,7 +1691,7 @@ components: - StackName - EntitlementName - ApplicationIdentifier - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1757,23 +1725,11 @@ components: - $ref: '#/components/x-stackQL-resources/application_entitlement_associations/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/application_entitlement_associations/methods/delete_resource' - application_entitlement_association: - name: application_entitlement_association - id: aws.appstream.application_entitlement_association - x-cfn-schema-name: ApplicationEntitlementAssociation - x-cfn-type-name: AWS::AppStream::ApplicationEntitlementAssociation - x-identifiers: - - StackName - - EntitlementName - - ApplicationIdentifier - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1785,7 +1741,7 @@ components: AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1804,7 +1760,7 @@ components: x-identifiers: - FleetName - ApplicationArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1838,22 +1794,11 @@ components: - $ref: '#/components/x-stackQL-resources/application_fleet_associations/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/application_fleet_associations/methods/delete_resource' - application_fleet_association: - name: application_fleet_association - id: aws.appstream.application_fleet_association - x-cfn-schema-name: ApplicationFleetAssociation - x-cfn-type-name: AWS::AppStream::ApplicationFleetAssociation - x-identifiers: - - FleetName - - ApplicationArn - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1864,7 +1809,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1881,7 +1826,7 @@ components: x-cfn-type-name: AWS::AppStream::DirectoryConfig x-identifiers: - DirectoryName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1898,9 +1843,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1910,41 +1855,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/directory_configs/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/directory_configs/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.DirectoryName') as directory_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppStream::DirectoryConfig' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'DirectoryName') as directory_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppStream::DirectoryConfig' - AND region = 'us-east-1' - directory_config: - name: directory_config - id: aws.appstream.directory_config - x-cfn-schema-name: DirectoryConfig - x-cfn-type-name: AWS::AppStream::DirectoryConfig - x-identifiers: - - DirectoryName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1955,12 +1868,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/directory_configs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/directory_configs/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/directory_config/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/directory_configs/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1973,18 +1890,34 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'OrganizationalUnitDistinguishedNames') as organizational_unit_distinguished_names, - json_extract_path_text(Properties, 'ServiceAccountCredentials') as service_account_credentials, - json_extract_path_text(Properties, 'DirectoryName') as directory_name, - json_extract_path_text(Properties, 'CertificateBasedAuthProperties') as certificate_based_auth_properties - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AppStream::DirectoryConfig' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.DirectoryName') as directory_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppStream::DirectoryConfig' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'OrganizationalUnitDistinguishedNames') as organizational_unit_distinguished_names, + json_extract_path_text(Properties, 'ServiceAccountCredentials') as service_account_credentials, + json_extract_path_text(Properties, 'DirectoryName') as directory_name, + json_extract_path_text(Properties, 'CertificateBasedAuthProperties') as certificate_based_auth_properties + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AppStream::DirectoryConfig' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DirectoryName') as directory_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppStream::DirectoryConfig' + AND region = 'us-east-1' entitlements: name: entitlements id: aws.appstream.entitlements @@ -1993,7 +1926,7 @@ components: x-identifiers: - StackName - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2010,9 +1943,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2022,24 +1955,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/entitlements/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/entitlements/methods/delete_resource' - entitlement: - name: entitlement - id: aws.appstream.entitlement - x-cfn-schema-name: Entitlement - x-cfn-type-name: AWS::AppStream::Entitlement - x-identifiers: - - StackName - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2050,12 +1968,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/entitlements/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/entitlements/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/entitlement/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/entitlements/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2071,7 +1993,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2093,7 +2015,7 @@ components: x-cfn-type-name: AWS::AppStream::ImageBuilder x-identifiers: - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2127,39 +2049,11 @@ components: - $ref: '#/components/x-stackQL-resources/image_builders/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/image_builders/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppStream::ImageBuilder' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppStream::ImageBuilder' - AND region = 'us-east-1' - image_builder: - name: image_builder - id: aws.appstream.image_builder - x-cfn-schema-name: ImageBuilder - x-cfn-type-name: AWS::AppStream::ImageBuilder - x-identifiers: - - Name - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2182,28 +2076,44 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'VpcConfig') as vpc_config, - json_extract_path_text(Properties, 'EnableDefaultInternetAccess') as enable_default_internet_access, - json_extract_path_text(Properties, 'DomainJoinInfo') as domain_join_info, - json_extract_path_text(Properties, 'AppstreamAgentVersion') as appstream_agent_version, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'ImageName') as image_name, - json_extract_path_text(Properties, 'DisplayName') as display_name, - json_extract_path_text(Properties, 'IamRoleArn') as iam_role_arn, - json_extract_path_text(Properties, 'InstanceType') as instance_type, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'StreamingUrl') as streaming_url, - json_extract_path_text(Properties, 'ImageArn') as image_arn, - json_extract_path_text(Properties, 'AccessEndpoints') as access_endpoints - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AppStream::ImageBuilder' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppStream::ImageBuilder' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'VpcConfig') as vpc_config, + json_extract_path_text(Properties, 'EnableDefaultInternetAccess') as enable_default_internet_access, + json_extract_path_text(Properties, 'DomainJoinInfo') as domain_join_info, + json_extract_path_text(Properties, 'AppstreamAgentVersion') as appstream_agent_version, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'ImageName') as image_name, + json_extract_path_text(Properties, 'DisplayName') as display_name, + json_extract_path_text(Properties, 'IamRoleArn') as iam_role_arn, + json_extract_path_text(Properties, 'InstanceType') as instance_type, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'StreamingUrl') as streaming_url, + json_extract_path_text(Properties, 'ImageArn') as image_arn, + json_extract_path_text(Properties, 'AccessEndpoints') as access_endpoints + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AppStream::ImageBuilder' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppStream::ImageBuilder' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/appsync.yaml b/providers/src/aws/v00.00.00000/services/appsync.yaml index 049b6eec..7c11e2dd 100644 --- a/providers/src/aws/v00.00.00000/services/appsync.yaml +++ b/providers/src/aws/v00.00.00000/services/appsync.yaml @@ -1166,7 +1166,7 @@ components: x-cfn-type-name: AWS::AppSync::DomainName x-identifiers: - DomainName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1183,9 +1183,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1195,41 +1195,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/domain_names/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/domain_names/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.DomainName') as domain_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppSync::DomainName' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'DomainName') as domain_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppSync::DomainName' - AND region = 'us-east-1' - domain_name: - name: domain_name - id: aws.appsync.domain_name - x-cfn-schema-name: DomainName - x-cfn-type-name: AWS::AppSync::DomainName - x-identifiers: - - DomainName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1240,12 +1208,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/domain_names/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/domain_names/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/domain_name/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/domain_names/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1259,19 +1231,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'DomainName') as domain_name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'CertificateArn') as certificate_arn, - json_extract_path_text(Properties, 'AppSyncDomainName') as app_sync_domain_name, - json_extract_path_text(Properties, 'HostedZoneId') as hosted_zone_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AppSync::DomainName' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.DomainName') as domain_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppSync::DomainName' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DomainName') as domain_name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'CertificateArn') as certificate_arn, + json_extract_path_text(Properties, 'AppSyncDomainName') as app_sync_domain_name, + json_extract_path_text(Properties, 'HostedZoneId') as hosted_zone_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AppSync::DomainName' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DomainName') as domain_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppSync::DomainName' + AND region = 'us-east-1' domain_name_api_associations: name: domain_name_api_associations id: aws.appsync.domain_name_api_associations @@ -1279,7 +1267,7 @@ components: x-cfn-type-name: AWS::AppSync::DomainNameApiAssociation x-identifiers: - ApiAssociationIdentifier - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1296,9 +1284,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1308,23 +1296,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/domain_name_api_associations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/domain_name_api_associations/methods/delete_resource' - domain_name_api_association: - name: domain_name_api_association - id: aws.appsync.domain_name_api_association - x-cfn-schema-name: DomainNameApiAssociation - x-cfn-type-name: AWS::AppSync::DomainNameApiAssociation - x-identifiers: - - ApiAssociationIdentifier - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1335,12 +1309,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/domain_name_api_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/domain_name_api_associations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/domain_name_api_association/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/domain_name_api_associations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1352,7 +1330,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1370,7 +1348,7 @@ components: x-cfn-type-name: AWS::AppSync::FunctionConfiguration x-identifiers: - FunctionArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1387,9 +1365,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1399,41 +1377,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/function_configurations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/function_configurations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.FunctionArn') as function_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppSync::FunctionConfiguration' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'FunctionArn') as function_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppSync::FunctionConfiguration' - AND region = 'us-east-1' - function_configuration: - name: function_configuration - id: aws.appsync.function_configuration - x-cfn-schema-name: FunctionConfiguration - x-cfn-type-name: AWS::AppSync::FunctionConfiguration - x-identifiers: - - FunctionArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1444,12 +1390,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/function_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/function_configurations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/function_configuration/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/function_configurations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1474,30 +1424,46 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'FunctionId') as function_id, - json_extract_path_text(Properties, 'FunctionArn') as function_arn, - json_extract_path_text(Properties, 'ApiId') as api_id, - json_extract_path_text(Properties, 'Code') as code, - json_extract_path_text(Properties, 'CodeS3Location') as code_s3_location, - json_extract_path_text(Properties, 'DataSourceName') as data_source_name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'FunctionVersion') as function_version, - json_extract_path_text(Properties, 'MaxBatchSize') as max_batch_size, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'RequestMappingTemplate') as request_mapping_template, - json_extract_path_text(Properties, 'RequestMappingTemplateS3Location') as request_mapping_template_s3_location, - json_extract_path_text(Properties, 'ResponseMappingTemplate') as response_mapping_template, - json_extract_path_text(Properties, 'ResponseMappingTemplateS3Location') as response_mapping_template_s3_location, - json_extract_path_text(Properties, 'Runtime') as runtime, - json_extract_path_text(Properties, 'SyncConfig') as sync_config - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AppSync::FunctionConfiguration' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.FunctionArn') as function_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppSync::FunctionConfiguration' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'FunctionId') as function_id, + json_extract_path_text(Properties, 'FunctionArn') as function_arn, + json_extract_path_text(Properties, 'ApiId') as api_id, + json_extract_path_text(Properties, 'Code') as code, + json_extract_path_text(Properties, 'CodeS3Location') as code_s3_location, + json_extract_path_text(Properties, 'DataSourceName') as data_source_name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'FunctionVersion') as function_version, + json_extract_path_text(Properties, 'MaxBatchSize') as max_batch_size, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'RequestMappingTemplate') as request_mapping_template, + json_extract_path_text(Properties, 'RequestMappingTemplateS3Location') as request_mapping_template_s3_location, + json_extract_path_text(Properties, 'ResponseMappingTemplate') as response_mapping_template, + json_extract_path_text(Properties, 'ResponseMappingTemplateS3Location') as response_mapping_template_s3_location, + json_extract_path_text(Properties, 'Runtime') as runtime, + json_extract_path_text(Properties, 'SyncConfig') as sync_config + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AppSync::FunctionConfiguration' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'FunctionArn') as function_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppSync::FunctionConfiguration' + AND region = 'us-east-1' resolvers: name: resolvers id: aws.appsync.resolvers @@ -1505,7 +1471,7 @@ components: x-cfn-type-name: AWS::AppSync::Resolver x-identifiers: - ResolverArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1522,9 +1488,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1534,41 +1500,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/resolvers/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/resolvers/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ResolverArn') as resolver_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppSync::Resolver' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ResolverArn') as resolver_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppSync::Resolver' - AND region = 'us-east-1' - resolver: - name: resolver - id: aws.appsync.resolver - x-cfn-schema-name: Resolver - x-cfn-type-name: AWS::AppSync::Resolver - x-identifiers: - - ResolverArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1579,12 +1513,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/resolvers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/resolvers/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/resolver/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/resolvers/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1611,32 +1549,48 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ApiId') as api_id, - json_extract_path_text(Properties, 'CachingConfig') as caching_config, - json_extract_path_text(Properties, 'Code') as code, - json_extract_path_text(Properties, 'CodeS3Location') as code_s3_location, - json_extract_path_text(Properties, 'DataSourceName') as data_source_name, - json_extract_path_text(Properties, 'FieldName') as field_name, - json_extract_path_text(Properties, 'Kind') as kind, - json_extract_path_text(Properties, 'MaxBatchSize') as max_batch_size, - json_extract_path_text(Properties, 'PipelineConfig') as pipeline_config, - json_extract_path_text(Properties, 'RequestMappingTemplate') as request_mapping_template, - json_extract_path_text(Properties, 'RequestMappingTemplateS3Location') as request_mapping_template_s3_location, - json_extract_path_text(Properties, 'ResolverArn') as resolver_arn, - json_extract_path_text(Properties, 'ResponseMappingTemplate') as response_mapping_template, - json_extract_path_text(Properties, 'ResponseMappingTemplateS3Location') as response_mapping_template_s3_location, - json_extract_path_text(Properties, 'Runtime') as runtime, - json_extract_path_text(Properties, 'SyncConfig') as sync_config, - json_extract_path_text(Properties, 'TypeName') as type_name, - json_extract_path_text(Properties, 'MetricsConfig') as metrics_config - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AppSync::Resolver' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ResolverArn') as resolver_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppSync::Resolver' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ApiId') as api_id, + json_extract_path_text(Properties, 'CachingConfig') as caching_config, + json_extract_path_text(Properties, 'Code') as code, + json_extract_path_text(Properties, 'CodeS3Location') as code_s3_location, + json_extract_path_text(Properties, 'DataSourceName') as data_source_name, + json_extract_path_text(Properties, 'FieldName') as field_name, + json_extract_path_text(Properties, 'Kind') as kind, + json_extract_path_text(Properties, 'MaxBatchSize') as max_batch_size, + json_extract_path_text(Properties, 'PipelineConfig') as pipeline_config, + json_extract_path_text(Properties, 'RequestMappingTemplate') as request_mapping_template, + json_extract_path_text(Properties, 'RequestMappingTemplateS3Location') as request_mapping_template_s3_location, + json_extract_path_text(Properties, 'ResolverArn') as resolver_arn, + json_extract_path_text(Properties, 'ResponseMappingTemplate') as response_mapping_template, + json_extract_path_text(Properties, 'ResponseMappingTemplateS3Location') as response_mapping_template_s3_location, + json_extract_path_text(Properties, 'Runtime') as runtime, + json_extract_path_text(Properties, 'SyncConfig') as sync_config, + json_extract_path_text(Properties, 'TypeName') as type_name, + json_extract_path_text(Properties, 'MetricsConfig') as metrics_config + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AppSync::Resolver' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ResolverArn') as resolver_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppSync::Resolver' + AND region = 'us-east-1' source_api_associations: name: source_api_associations id: aws.appsync.source_api_associations @@ -1644,7 +1598,7 @@ components: x-cfn-type-name: AWS::AppSync::SourceApiAssociation x-identifiers: - AssociationArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1661,9 +1615,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1673,41 +1627,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/source_api_associations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/source_api_associations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AssociationArn') as association_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppSync::SourceApiAssociation' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AssociationArn') as association_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppSync::SourceApiAssociation' - AND region = 'us-east-1' - source_api_association: - name: source_api_association - id: aws.appsync.source_api_association - x-cfn-schema-name: SourceApiAssociation - x-cfn-type-name: AWS::AppSync::SourceApiAssociation - x-identifiers: - - AssociationArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1718,12 +1640,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/source_api_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/source_api_associations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/source_api_association/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/source_api_associations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1745,27 +1671,43 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'SourceApiIdentifier') as source_api_identifier, - json_extract_path_text(Properties, 'MergedApiIdentifier') as merged_api_identifier, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'SourceApiAssociationConfig') as source_api_association_config, - json_extract_path_text(Properties, 'AssociationId') as association_id, - json_extract_path_text(Properties, 'AssociationArn') as association_arn, - json_extract_path_text(Properties, 'SourceApiId') as source_api_id, - json_extract_path_text(Properties, 'SourceApiArn') as source_api_arn, - json_extract_path_text(Properties, 'MergedApiId') as merged_api_id, - json_extract_path_text(Properties, 'MergedApiArn') as merged_api_arn, - json_extract_path_text(Properties, 'SourceApiAssociationStatus') as source_api_association_status, - json_extract_path_text(Properties, 'SourceApiAssociationStatusDetail') as source_api_association_status_detail, - json_extract_path_text(Properties, 'LastSuccessfulMergeDate') as last_successful_merge_date - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AppSync::SourceApiAssociation' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.AssociationArn') as association_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppSync::SourceApiAssociation' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'SourceApiIdentifier') as source_api_identifier, + json_extract_path_text(Properties, 'MergedApiIdentifier') as merged_api_identifier, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'SourceApiAssociationConfig') as source_api_association_config, + json_extract_path_text(Properties, 'AssociationId') as association_id, + json_extract_path_text(Properties, 'AssociationArn') as association_arn, + json_extract_path_text(Properties, 'SourceApiId') as source_api_id, + json_extract_path_text(Properties, 'SourceApiArn') as source_api_arn, + json_extract_path_text(Properties, 'MergedApiId') as merged_api_id, + json_extract_path_text(Properties, 'MergedApiArn') as merged_api_arn, + json_extract_path_text(Properties, 'SourceApiAssociationStatus') as source_api_association_status, + json_extract_path_text(Properties, 'SourceApiAssociationStatusDetail') as source_api_association_status_detail, + json_extract_path_text(Properties, 'LastSuccessfulMergeDate') as last_successful_merge_date + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AppSync::SourceApiAssociation' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AssociationArn') as association_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AppSync::SourceApiAssociation' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/aps.yaml b/providers/src/aws/v00.00.00000/services/aps.yaml index c5121bca..45824297 100644 --- a/providers/src/aws/v00.00.00000/services/aps.yaml +++ b/providers/src/aws/v00.00.00000/services/aps.yaml @@ -921,7 +921,7 @@ components: x-cfn-type-name: AWS::APS::RuleGroupsNamespace x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -938,9 +938,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -950,41 +950,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/rule_groups_namespaces/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/rule_groups_namespaces/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::APS::RuleGroupsNamespace' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::APS::RuleGroupsNamespace' - AND region = 'us-east-1' - rule_groups_namespace: - name: rule_groups_namespace - id: aws.aps.rule_groups_namespace - x-cfn-schema-name: RuleGroupsNamespace - x-cfn-type-name: AWS::APS::RuleGroupsNamespace - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -995,12 +963,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/rule_groups_namespaces/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/rule_groups_namespaces/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/rule_groups_namespace/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/rule_groups_namespaces/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1014,19 +986,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Workspace') as workspace, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Data') as data, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::APS::RuleGroupsNamespace' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::APS::RuleGroupsNamespace' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Workspace') as workspace, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Data') as data, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::APS::RuleGroupsNamespace' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::APS::RuleGroupsNamespace' + AND region = 'us-east-1' scrapers: name: scrapers id: aws.aps.scrapers @@ -1034,7 +1022,7 @@ components: x-cfn-type-name: AWS::APS::Scraper x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1051,9 +1039,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1063,41 +1051,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/scrapers/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/scrapers/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::APS::Scraper' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::APS::Scraper' - AND region = 'us-east-1' - scraper: - name: scraper - id: aws.aps.scraper - x-cfn-schema-name: Scraper - x-cfn-type-name: AWS::APS::Scraper - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1108,12 +1064,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/scrapers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/scrapers/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/scraper/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/scrapers/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1130,22 +1090,38 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ScraperId') as scraper_id, - json_extract_path_text(Properties, 'Alias') as alias, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'ScrapeConfiguration') as scrape_configuration, - json_extract_path_text(Properties, 'Source') as source, - json_extract_path_text(Properties, 'Destination') as destination, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::APS::Scraper' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::APS::Scraper' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ScraperId') as scraper_id, + json_extract_path_text(Properties, 'Alias') as alias, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'ScrapeConfiguration') as scrape_configuration, + json_extract_path_text(Properties, 'Source') as source, + json_extract_path_text(Properties, 'Destination') as destination, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::APS::Scraper' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::APS::Scraper' + AND region = 'us-east-1' workspaces: name: workspaces id: aws.aps.workspaces @@ -1153,7 +1129,7 @@ components: x-cfn-type-name: AWS::APS::Workspace x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1170,9 +1146,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1182,41 +1158,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/workspaces/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/workspaces/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::APS::Workspace' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::APS::Workspace' - AND region = 'us-east-1' - workspace: - name: workspace - id: aws.aps.workspace - x-cfn-schema-name: Workspace - x-cfn-type-name: AWS::APS::Workspace - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1227,12 +1171,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/workspaces/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/workspaces/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/workspace/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/workspaces/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1249,22 +1197,38 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'WorkspaceId') as workspace_id, - json_extract_path_text(Properties, 'Alias') as alias, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'AlertManagerDefinition') as alert_manager_definition, - json_extract_path_text(Properties, 'PrometheusEndpoint') as prometheus_endpoint, - json_extract_path_text(Properties, 'LoggingConfiguration') as logging_configuration, - json_extract_path_text(Properties, 'KmsKeyArn') as kms_key_arn, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::APS::Workspace' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::APS::Workspace' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'WorkspaceId') as workspace_id, + json_extract_path_text(Properties, 'Alias') as alias, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'AlertManagerDefinition') as alert_manager_definition, + json_extract_path_text(Properties, 'PrometheusEndpoint') as prometheus_endpoint, + json_extract_path_text(Properties, 'LoggingConfiguration') as logging_configuration, + json_extract_path_text(Properties, 'KmsKeyArn') as kms_key_arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::APS::Workspace' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::APS::Workspace' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/arczonalshift.yaml b/providers/src/aws/v00.00.00000/services/arczonalshift.yaml index a32ea107..a578262e 100644 --- a/providers/src/aws/v00.00.00000/services/arczonalshift.yaml +++ b/providers/src/aws/v00.00.00000/services/arczonalshift.yaml @@ -452,9 +452,6 @@ components: properties: ZonalAutoshiftStatus: $ref: '#/components/schemas/ZonalAutoshiftStatus' - x-dependencies: - ZonalAutoshiftStatus: - - PracticeRunConfiguration PracticeRunConfiguration: $ref: '#/components/schemas/PracticeRunConfiguration' ResourceIdentifier: @@ -505,9 +502,6 @@ components: properties: ZonalAutoshiftStatus: $ref: '#/components/schemas/ZonalAutoshiftStatus' - x-dependencies: - ZonalAutoshiftStatus: - - PracticeRunConfiguration PracticeRunConfiguration: $ref: '#/components/schemas/PracticeRunConfiguration' ResourceIdentifier: @@ -533,7 +527,7 @@ components: x-cfn-type-name: AWS::ARCZonalShift::ZonalAutoshiftConfiguration x-identifiers: - ResourceIdentifier - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -550,9 +544,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -562,41 +556,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/zonal_autoshift_configurations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/zonal_autoshift_configurations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ResourceIdentifier') as resource_identifier - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ARCZonalShift::ZonalAutoshiftConfiguration' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ResourceIdentifier') as resource_identifier - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ARCZonalShift::ZonalAutoshiftConfiguration' - AND region = 'us-east-1' - zonal_autoshift_configuration: - name: zonal_autoshift_configuration - id: aws.arczonalshift.zonal_autoshift_configuration - x-cfn-schema-name: ZonalAutoshiftConfiguration - x-cfn-type-name: AWS::ARCZonalShift::ZonalAutoshiftConfiguration - x-identifiers: - - ResourceIdentifier - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -607,12 +569,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/zonal_autoshift_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/zonal_autoshift_configurations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/zonal_autoshift_configuration/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/zonal_autoshift_configurations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -624,17 +590,33 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ZonalAutoshiftStatus') as zonal_autoshift_status, - json_extract_path_text(Properties, 'PracticeRunConfiguration') as practice_run_configuration, - json_extract_path_text(Properties, 'ResourceIdentifier') as resource_identifier - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ARCZonalShift::ZonalAutoshiftConfiguration' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ResourceIdentifier') as resource_identifier + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ARCZonalShift::ZonalAutoshiftConfiguration' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ZonalAutoshiftStatus') as zonal_autoshift_status, + json_extract_path_text(Properties, 'PracticeRunConfiguration') as practice_run_configuration, + json_extract_path_text(Properties, 'ResourceIdentifier') as resource_identifier + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ARCZonalShift::ZonalAutoshiftConfiguration' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ResourceIdentifier') as resource_identifier + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ARCZonalShift::ZonalAutoshiftConfiguration' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/athena.yaml b/providers/src/aws/v00.00.00000/services/athena.yaml index 62ee5f5b..870c7fbd 100644 --- a/providers/src/aws/v00.00.00000/services/athena.yaml +++ b/providers/src/aws/v00.00.00000/services/athena.yaml @@ -1221,7 +1221,7 @@ components: x-cfn-type-name: AWS::Athena::CapacityReservation x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1238,9 +1238,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1250,41 +1250,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/capacity_reservations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/capacity_reservations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Athena::CapacityReservation' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Athena::CapacityReservation' - AND region = 'us-east-1' - capacity_reservation: - name: capacity_reservation - id: aws.athena.capacity_reservation - x-cfn-schema-name: CapacityReservation - x-cfn-type-name: AWS::Athena::CapacityReservation - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1295,12 +1263,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/capacity_reservations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/capacity_reservations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/capacity_reservation/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/capacity_reservations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1318,23 +1290,39 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'TargetDpus') as target_dpus, - json_extract_path_text(Properties, 'AllocatedDpus') as allocated_dpus, - json_extract_path_text(Properties, 'CapacityAssignmentConfiguration') as capacity_assignment_configuration, - json_extract_path_text(Properties, 'CreationTime') as creation_time, - json_extract_path_text(Properties, 'LastSuccessfulAllocationTime') as last_successful_allocation_time, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Athena::CapacityReservation' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Athena::CapacityReservation' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'TargetDpus') as target_dpus, + json_extract_path_text(Properties, 'AllocatedDpus') as allocated_dpus, + json_extract_path_text(Properties, 'CapacityAssignmentConfiguration') as capacity_assignment_configuration, + json_extract_path_text(Properties, 'CreationTime') as creation_time, + json_extract_path_text(Properties, 'LastSuccessfulAllocationTime') as last_successful_allocation_time, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Athena::CapacityReservation' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Athena::CapacityReservation' + AND region = 'us-east-1' data_catalogs: name: data_catalogs id: aws.athena.data_catalogs @@ -1342,7 +1330,7 @@ components: x-cfn-type-name: AWS::Athena::DataCatalog x-identifiers: - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1359,9 +1347,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1371,41 +1359,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/data_catalogs/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/data_catalogs/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Athena::DataCatalog' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Athena::DataCatalog' - AND region = 'us-east-1' - data_catalog: - name: data_catalog - id: aws.athena.data_catalog - x-cfn-schema-name: DataCatalog - x-cfn-type-name: AWS::Athena::DataCatalog - x-identifiers: - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1416,12 +1372,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/data_catalogs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/data_catalogs/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/data_catalog/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/data_catalogs/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1435,19 +1395,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Parameters') as parameters, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Type') as type - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Athena::DataCatalog' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Athena::DataCatalog' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Parameters') as parameters, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Type') as type + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Athena::DataCatalog' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Athena::DataCatalog' + AND region = 'us-east-1' named_queries: name: named_queries id: aws.athena.named_queries @@ -1455,7 +1431,7 @@ components: x-cfn-type-name: AWS::Athena::NamedQuery x-identifiers: - NamedQueryId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1489,39 +1465,11 @@ components: - $ref: '#/components/x-stackQL-resources/named_queries/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/named_queries/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.NamedQueryId') as named_query_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Athena::NamedQuery' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'NamedQueryId') as named_query_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Athena::NamedQuery' - AND region = 'us-east-1' - named_query: - name: named_query - id: aws.athena.named_query - x-cfn-schema-name: NamedQuery - x-cfn-type-name: AWS::Athena::NamedQuery - x-identifiers: - - NamedQueryId - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1536,20 +1484,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Database') as _database, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'QueryString') as query_string, - json_extract_path_text(Properties, 'WorkGroup') as work_group, - json_extract_path_text(Properties, 'NamedQueryId') as named_query_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Athena::NamedQuery' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.NamedQueryId') as named_query_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Athena::NamedQuery' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Database') as _database, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'QueryString') as query_string, + json_extract_path_text(Properties, 'WorkGroup') as work_group, + json_extract_path_text(Properties, 'NamedQueryId') as named_query_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Athena::NamedQuery' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'NamedQueryId') as named_query_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Athena::NamedQuery' + AND region = 'us-east-1' prepared_statements: name: prepared_statements id: aws.athena.prepared_statements @@ -1558,7 +1522,7 @@ components: x-identifiers: - StatementName - WorkGroup - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1575,9 +1539,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1587,44 +1551,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/prepared_statements/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/prepared_statements/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.StatementName') as statement_name, - JSON_EXTRACT(Properties, '$.WorkGroup') as work_group - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Athena::PreparedStatement' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'StatementName') as statement_name, - json_extract_path_text(Properties, 'WorkGroup') as work_group - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Athena::PreparedStatement' - AND region = 'us-east-1' - prepared_statement: - name: prepared_statement - id: aws.athena.prepared_statement - x-cfn-schema-name: PreparedStatement - x-cfn-type-name: AWS::Athena::PreparedStatement - x-identifiers: - - StatementName - - WorkGroup - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1635,12 +1564,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/prepared_statements/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/prepared_statements/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/prepared_statement/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/prepared_statements/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1653,18 +1586,36 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'StatementName') as statement_name, - json_extract_path_text(Properties, 'WorkGroup') as work_group, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'QueryStatement') as query_statement - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Athena::PreparedStatement' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.StatementName') as statement_name, + JSON_EXTRACT(Properties, '$.WorkGroup') as work_group + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Athena::PreparedStatement' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'StatementName') as statement_name, + json_extract_path_text(Properties, 'WorkGroup') as work_group, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'QueryStatement') as query_statement + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Athena::PreparedStatement' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'StatementName') as statement_name, + json_extract_path_text(Properties, 'WorkGroup') as work_group + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Athena::PreparedStatement' + AND region = 'us-east-1' work_groups: name: work_groups id: aws.athena.work_groups @@ -1672,7 +1623,7 @@ components: x-cfn-type-name: AWS::Athena::WorkGroup x-identifiers: - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1689,9 +1640,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1701,41 +1652,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/work_groups/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/work_groups/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Athena::WorkGroup' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Athena::WorkGroup' - AND region = 'us-east-1' - work_group: - name: work_group - id: aws.athena.work_group - x-cfn-schema-name: WorkGroup - x-cfn-type-name: AWS::Athena::WorkGroup - x-identifiers: - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1746,12 +1665,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/work_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/work_groups/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/work_group/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/work_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1768,22 +1691,38 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'WorkGroupConfiguration') as work_group_configuration, - json_extract_path_text(Properties, 'WorkGroupConfigurationUpdates') as work_group_configuration_updates, - json_extract_path_text(Properties, 'CreationTime') as creation_time, - json_extract_path_text(Properties, 'State') as state, - json_extract_path_text(Properties, 'RecursiveDeleteOption') as recursive_delete_option - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Athena::WorkGroup' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Athena::WorkGroup' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'WorkGroupConfiguration') as work_group_configuration, + json_extract_path_text(Properties, 'WorkGroupConfigurationUpdates') as work_group_configuration_updates, + json_extract_path_text(Properties, 'CreationTime') as creation_time, + json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'RecursiveDeleteOption') as recursive_delete_option + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Athena::WorkGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Athena::WorkGroup' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/auditmanager.yaml b/providers/src/aws/v00.00.00000/services/auditmanager.yaml index ca2937b0..56fdd226 100644 --- a/providers/src/aws/v00.00.00000/services/auditmanager.yaml +++ b/providers/src/aws/v00.00.00000/services/auditmanager.yaml @@ -721,7 +721,7 @@ components: x-cfn-type-name: AWS::AuditManager::Assessment x-identifiers: - AssessmentId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -738,9 +738,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -750,41 +750,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/assessments/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/assessments/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AssessmentId') as assessment_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AuditManager::Assessment' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AssessmentId') as assessment_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AuditManager::Assessment' - AND region = 'us-east-1' - assessment: - name: assessment - id: aws.auditmanager.assessment - x-cfn-schema-name: Assessment - x-cfn-type-name: AWS::AuditManager::Assessment - x-identifiers: - - AssessmentId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -795,12 +763,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/assessments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/assessments/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/assessment/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/assessments/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -822,27 +794,43 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'FrameworkId') as framework_id, - json_extract_path_text(Properties, 'AssessmentId') as assessment_id, - json_extract_path_text(Properties, 'AwsAccount') as aws_account, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Delegations') as delegations, - json_extract_path_text(Properties, 'Roles') as roles, - json_extract_path_text(Properties, 'Scope') as scope, - json_extract_path_text(Properties, 'AssessmentReportsDestination') as assessment_reports_destination, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'CreationTime') as creation_time, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Description') as description - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AuditManager::Assessment' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.AssessmentId') as assessment_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AuditManager::Assessment' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'FrameworkId') as framework_id, + json_extract_path_text(Properties, 'AssessmentId') as assessment_id, + json_extract_path_text(Properties, 'AwsAccount') as aws_account, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Delegations') as delegations, + json_extract_path_text(Properties, 'Roles') as roles, + json_extract_path_text(Properties, 'Scope') as scope, + json_extract_path_text(Properties, 'AssessmentReportsDestination') as assessment_reports_destination, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'CreationTime') as creation_time, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Description') as description + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AuditManager::Assessment' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AssessmentId') as assessment_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AuditManager::Assessment' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/autoscaling.yaml b/providers/src/aws/v00.00.00000/services/autoscaling.yaml index 5c8e2d75..2279b460 100644 --- a/providers/src/aws/v00.00.00000/services/autoscaling.yaml +++ b/providers/src/aws/v00.00.00000/services/autoscaling.yaml @@ -416,9 +416,9 @@ components: + The ID or the name of the launch template, but not both. + The version of the launch template. - ``LaunchTemplateSpecification`` is property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource. It is also a property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplate.html) and [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property types. + ``LaunchTemplateSpecification`` is property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource. It is also a property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplate.html) and [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property types. For information about creating a launch template, see [AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html) and [Create a launch template for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html) in the *Amazon EC2 Auto Scaling User Guide*. - For examples of launch templates, see [Auto scaling template snippets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-autoscaling.html) and the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#aws-resource-ec2-launchtemplate--examples) section in the ``AWS::EC2::LaunchTemplate`` resource. + For examples of launch templates, see [Create launch templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-ec2-launch-templates.html). additionalProperties: false type: object properties: @@ -527,7 +527,7 @@ components: type: string RoleARN: description: |- - The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target. For information about creating this role, see [Configure a notification target for a lifecycle hook](https://docs.aws.amazon.com/autoscaling/ec2/userguide/prepare-for-lifecycle-notifications.html#lifecycle-hook-notification-target) in the *Amazon EC2 Auto Scaling User Guide*. + The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target. For information about creating this role, see [Prepare to add a lifecycle hook to your Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/prepare-for-lifecycle-notifications.html) in the *Amazon EC2 Auto Scaling User Guide*. Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue. type: string required: @@ -547,7 +547,7 @@ components: NotificationConfiguration: description: |- A structure that specifies an Amazon SNS notification configuration for the ``NotificationConfigurations`` property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource. - For an example template snippet, see [Auto scaling template snippets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-autoscaling.html). + For an example template snippet, see [Configure Amazon EC2 Auto Scaling resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-ec2-auto-scaling.html). For more information, see [Get Amazon SNS notifications when your Auto Scaling group scales](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ASGettingNotifications.html) in the *Amazon EC2 Auto Scaling User Guide*. additionalProperties: false type: object @@ -561,7 +561,7 @@ components: uniqueItems: false description: |- A list of event types that send a notification. Event types can include any of the following types. - *Allowed values*: + *Allowed values*: + ``autoscaling:EC2_INSTANCE_LAUNCH`` + ``autoscaling:EC2_INSTANCE_LAUNCH_ERROR`` + ``autoscaling:EC2_INSTANCE_TERMINATE`` @@ -607,7 +607,7 @@ components: + ``GroupAndWarmPoolTotalCapacity`` If you specify ``Granularity`` and don't specify any metrics, all metrics are enabled. - For more information, see [Auto Scaling group metrics](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-cloudwatch-monitoring.html#as-group-metrics) in the *Amazon EC2 Auto Scaling User Guide*. + For more information, see [Amazon CloudWatch metrics for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-metrics.html) in the *Amazon EC2 Auto Scaling User Guide*. x-insertionOrder: false type: array items: @@ -758,7 +758,7 @@ components: $ref: '#/components/schemas/InstanceRequirements' InstanceType: description: |- - The instance type, such as ``m3.xlarge``. You must specify an instance type that is supported in your requested Region and Availability Zones. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon Elastic Compute Cloud User Guide*. + The instance type, such as ``m3.xlarge``. You must specify an instance type that is supported in your requested Region and Availability Zones. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide for Linux Instances*. You can specify up to 40 instance types per Auto Scaling group. type: string AcceleratorTotalMemoryMiBRequest: @@ -799,13 +799,13 @@ components: The attributes for the instance types for a mixed instances policy. Amazon EC2 Auto Scaling uses your specified requirements to identify instance types. Then, it uses your On-Demand and Spot allocation strategies to launch instances from these instance types. When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values. To limit the list of instance types from which Amazon EC2 Auto Scaling can identify matching instance types, you can use one of the following parameters, but not both in the same request: - + ``AllowedInstanceTypes`` - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes. - + ``ExcludedInstanceTypes`` - The instance types to exclude from the list, even if they match your specified attributes. + + ``AllowedInstanceTypes`` - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes. + + ``ExcludedInstanceTypes`` - The instance types to exclude from the list, even if they match your specified attributes. You must specify ``VCpuCount`` and ``MemoryMiB``. All other attributes are optional. Any unspecified optional attribute is set to its default. - For an example template, see [Auto scaling template snippets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-autoscaling.html). + For an example template, see [Configure Amazon EC2 Auto Scaling resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-ec2-auto-scaling.html). For more information, see [Creating an Auto Scaling group using attribute-based instance type selection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-instance-type-requirements.html) in the *Amazon EC2 Auto Scaling User Guide*. For help determining which instance types match your attributes before you apply them to your Auto Scaling group, see [Preview instance types with specified attributes](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html#ec2fleet-get-instance-types-from-instance-requirements) in the *Amazon EC2 User Guide for Linux Instances*. - ``InstanceRequirements`` is a property of the ``LaunchTemplateOverrides`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplate.html) property type. + ``InstanceRequirements`` is a property of the ``LaunchTemplateOverrides`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplate.html) property type. additionalProperties: false type: object properties: @@ -941,9 +941,8 @@ components: [Price protection] The price protection threshold for Spot Instances, as a percentage of 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 EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage. - To indicate no price protection threshold, specify a high value, such as ``999999``. If you set ``DesiredCapacityType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is based on the per-vCPU or per-memory price instead of the per instance price. - Only one of ``SpotMaxPricePercentageOverLowestPrice`` or ``MaxSpotPriceAsPercentageOfOptimalOnDemandPrice`` can be specified. If you don't specify either, then ``SpotMaxPricePercentageOverLowestPrice`` is used and the value for that parameter defaults to ``100``. + Only one of ``SpotMaxPricePercentageOverLowestPrice`` or ``MaxSpotPriceAsPercentageOfOptimalOnDemandPrice`` can be specified. If you don't specify either, Amazon EC2 Auto Scaling will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as ``999999``. type: integer BaselineEbsBandwidthMbps: description: |- @@ -954,11 +953,9 @@ components: description: >- [Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot 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 EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold. - The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage. - To turn off price protection, specify a high value, such as ``999999``. + The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage. If you set ``DesiredCapacityType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is based on the per-vCPU or per-memory price instead of the per instance price. - Only one of ``SpotMaxPricePercentageOverLowestPrice`` or ``MaxSpotPriceAsPercentageOfOptimalOnDemandPrice`` can be specified. - Default: ``100`` + Only one of ``SpotMaxPricePercentageOverLowestPrice`` or ``MaxSpotPriceAsPercentageOfOptimalOnDemandPrice`` can be specified. If you don't specify either, Amazon EC2 Auto Scaling will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as ``999999``. type: integer AcceleratorNames: uniqueItems: true @@ -1044,7 +1041,7 @@ components: Cooldown: description: |- *Only needed if you use simple scaling policies.* - The amount of time, in seconds, between one scaling activity ending and another one starting due to simple scaling policies. For more information, see [Scaling cooldowns for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html) in the *Amazon EC2 Auto Scaling User Guide*. + The amount of time, in seconds, between one scaling activity ending and another one starting due to simple scaling policies. For more information, see [Scaling cooldowns for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-scaling-cooldowns.html) in the *Amazon EC2 Auto Scaling User Guide*. Default: ``300`` seconds type: string NotificationConfigurations: @@ -1075,7 +1072,7 @@ components: Default: None type: integer NewInstancesProtectedFromScaleIn: - description: Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. For more information about preventing instances from terminating on scale in, see [Using instance scale-in protection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-protection.html) in the *Amazon EC2 Auto Scaling User Guide*. + description: Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. For more information about preventing instances from terminating on scale in, see [Use instance scale-in protection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-protection.html) in the *Amazon EC2 Auto Scaling User Guide*. type: boolean LaunchTemplate: description: |- @@ -1153,7 +1150,7 @@ components: TerminationPolicies: uniqueItems: false description: |- - A policy or a list of policies that are used to select the instance to terminate. These policies are executed in the order that you list them. For more information, see [Work with Amazon EC2 Auto Scaling termination policies](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-termination-policies.html) in the *Amazon EC2 Auto Scaling User Guide*. + A policy or a list of policies that are used to select the instance to terminate. These policies are executed in the order that you list them. For more information, see [Configure termination policies for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-termination-policies.html) in the *Amazon EC2 Auto Scaling User Guide*. Valid values: ``Default`` | ``AllocationStrategy`` | ``ClosestToNextInstanceHour`` | ``NewestInstance`` | ``OldestInstance`` | ``OldestLaunchConfiguration`` | ``OldestLaunchTemplate`` | ``arn:aws:lambda:region:account-id:function:my-function:my-alias`` x-insertionOrder: true type: array @@ -1167,7 +1164,7 @@ components: type: string DesiredCapacityType: description: |- - The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports ``DesiredCapacityType`` for attribute-based instance type selection only. For more information, see [Creating an Auto Scaling group using attribute-based instance type selection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-instance-type-requirements.html) in the *Amazon EC2 Auto Scaling User Guide*. + The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports ``DesiredCapacityType`` for attribute-based instance type selection only. For more information, see [Create a mixed instances group using attribute-based instance type selection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-mixed-instances-group-attribute-based-instance-type-selection.html) in the *Amazon EC2 Auto Scaling User Guide*. By default, Amazon EC2 Auto Scaling specifies ``units``, which translates into number of instances. Valid values: ``units`` | ``vcpu`` | ``memory-mib`` type: string @@ -1179,11 +1176,11 @@ components: HealthCheckType: description: |- A comma-separated value string of one or more health check types. - The valid values are ``EC2``, ``ELB``, and ``VPC_LATTICE``. ``EC2`` is the default health check and cannot be disabled. For more information, see [Health checks for Auto Scaling instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html) in the *Amazon EC2 Auto Scaling User Guide*. + The valid values are ``EC2``, ``ELB``, and ``VPC_LATTICE``. ``EC2`` is the default health check and cannot be disabled. For more information, see [Health checks for instances in an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-health-checks.html) in the *Amazon EC2 Auto Scaling User Guide*. Only specify ``EC2`` if you must clear a value that was previously set. type: string MaxInstanceLifetime: - description: The maximum amount of time, in seconds, that an instance can be in service. The default is null. If specified, the value must be either 0 or a number equal to or greater than 86,400 seconds (1 day). For more information, see [Replacing Auto Scaling instances based on maximum instance lifetime](https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html) in the *Amazon EC2 Auto Scaling User Guide*. + description: The maximum amount of time, in seconds, that an instance can be in service. The default is null. If specified, the value must be either 0 or a number equal to or greater than 86,400 seconds (1 day). For more information, see [Replace Auto Scaling instances based on maximum instance lifetime](https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html) in the *Amazon EC2 Auto Scaling User Guide*. type: integer required: - MinSize @@ -1192,7 +1189,8 @@ components: description: |- The ``AWS::AutoScaling::AutoScalingGroup`` resource defines an Amazon EC2 Auto Scaling group, which is a collection of Amazon EC2 instances that are treated as a logical grouping for the purposes of automatic scaling and management. For more information about Amazon EC2 Auto Scaling, see the [Amazon EC2 Auto Scaling User Guide](https://docs.aws.amazon.com/autoscaling/ec2/userguide/what-is-amazon-ec2-auto-scaling.html). - Amazon EC2 Auto Scaling configures instances launched as part of an Auto Scaling group using either a [launch template](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html) or a launch configuration. We strongly recommend that you do not use launch configurations. They do not provide full functionality for Amazon EC2 Auto Scaling or Amazon EC2. For more information, see [Launch configurations](https://docs.aws.amazon.com/autoscaling/ec2/userguide/launch-configurations.html) and [Migrate CloudFormation stacks from launch configurations to launch templates](https://docs.aws.amazon.com/autoscaling/ec2/userguide/migrate-launch-configurations-with-cloudformation.html) in the *Amazon EC2 Auto Scaling User Guide*. + Amazon EC2 Auto Scaling configures instances launched as part of an Auto Scaling group using either a [launch template](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html) or a launch configuration. We strongly recommend that you do not use launch configurations. For more information, see [Launch configurations](https://docs.aws.amazon.com/autoscaling/ec2/userguide/launch-configurations.html) in the *Amazon EC2 Auto Scaling User Guide*. + For help migrating from launch configurations to launch templates, see [Migrate CloudFormation stacks from launch configurations to launch templates](https://docs.aws.amazon.com/autoscaling/ec2/userguide/migrate-launch-configurations-with-cloudformation.html) in the *Amazon EC2 Auto Scaling User Guide*. x-type-name: AWS::AutoScaling::AutoScalingGroup x-stackql-primary-identifier: - AutoScalingGroupName @@ -1277,8 +1275,8 @@ components: - managed-fleets:DeleteAutoScalingGroup MetadataOptions: description: MetadataOptions is a property of AWS::AutoScaling::LaunchConfiguration that describes metadata options for the instances. - type: object additionalProperties: false + type: object properties: HttpPutResponseHopLimit: description: The desired HTTP PUT response hop limit for instance metadata requests. @@ -1291,18 +1289,18 @@ components: type: string BlockDeviceMapping: description: BlockDeviceMapping is a property of AWS::AutoScaling::LaunchConfiguration that describes a block device mapping for an Auto Scaling group. - type: object additionalProperties: false + type: object properties: + Ebs: + description: Parameters used to automatically set up EBS volumes when an instance is launched. + $ref: '#/components/schemas/BlockDevice' NoDevice: description: Setting this value to true suppresses the specified device included in the block device mapping of the AMI. type: boolean VirtualName: description: The name of the virtual device. type: string - Ebs: - description: Parameters used to automatically set up EBS volumes when an instance is launched. - $ref: '#/components/schemas/BlockDevice' DeviceName: description: 'The device name exposed to the EC2 instance (for example, /dev/sdh or xvdh). ' type: string @@ -1310,8 +1308,8 @@ components: - DeviceName BlockDevice: description: BlockDevice is a subproperty of BlockDeviceMapping that describes an Amazon EBS volume. - type: object additionalProperties: false + type: object properties: SnapshotId: description: The snapshot ID of the volume to use. @@ -1322,6 +1320,9 @@ components: Encrypted: description: 'Specifies whether the volume should be encrypted. ' type: boolean + Throughput: + description: The throughput (MiBps) to provision for a gp3 volume. + type: integer Iops: description: 'The number of input/output (I/O) operations per second (IOPS) to provision for the volume. ' type: integer @@ -1331,82 +1332,86 @@ components: DeleteOnTermination: description: 'Indicates whether the volume is deleted on instance termination. ' type: boolean - Throughput: - description: The throughput (MiBps) to provision for a gp3 volume. - type: integer LaunchConfiguration: type: object properties: - AssociatePublicIpAddress: - description: For Auto Scaling groups that are running in a virtual private cloud (VPC), specifies whether to assign a public IP address to the group's instances. - type: boolean - BlockDeviceMappings: - description: Specifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes. - type: array - uniqueItems: true + PlacementTenancy: + description: The tenancy of the instance, either default or dedicated. + type: string + SecurityGroups: + description: A list that contains the security groups to assign to the instances in the Auto Scaling group. x-insertionOrder: false + type: array items: - $ref: '#/components/schemas/BlockDeviceMapping' - ClassicLinkVPCId: - description: The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. + anyOf: + - relationshipRef: + typeName: AWS::EC2::SecurityGroup + propertyPath: /properties/GroupId + - relationshipRef: + typeName: AWS::EC2::SecurityGroup + propertyPath: /properties/Id + type: string + LaunchConfigurationName: + minLength: 1 + description: The name of the launch configuration. This name must be unique per Region per account. + type: string + maxLength: 255 + MetadataOptions: + description: The metadata options for the instances. + $ref: '#/components/schemas/MetadataOptions' + InstanceId: + description: The ID of the Amazon EC2 instance you want to use to create the launch configuration. + type: string + UserData: + description: The Base64-encoded user data to make available to the launched EC2 instances. type: string + maxLength: 21847 ClassicLinkVPCSecurityGroups: description: The IDs of one or more security groups for the VPC that you specified in the ClassicLinkVPCId property. - type: array x-insertionOrder: false + type: array items: type: string - EbsOptimized: - description: Specifies whether the launch configuration is optimized for EBS I/O (true) or not (false). - type: boolean + BlockDeviceMappings: + uniqueItems: true + description: Specifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/BlockDeviceMapping' IamInstanceProfile: description: Provides the name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance. The instance profile contains the IAM role. type: string - ImageId: - description: Provides the unique ID of the Amazon Machine Image (AMI) that was assigned during registration. - type: string - InstanceId: - description: The ID of the Amazon EC2 instance you want to use to create the launch configuration. - type: string - InstanceMonitoring: - description: Controls whether instances in this group are launched with detailed (true) or basic (false) monitoring. - type: boolean - InstanceType: - description: Specifies the instance type of the EC2 instance. - type: string KernelId: description: Provides the ID of the kernel associated with the EC2 AMI. type: string + AssociatePublicIpAddress: + description: For Auto Scaling groups that are running in a virtual private cloud (VPC), specifies whether to assign a public IP address to the group's instances. + type: boolean + ClassicLinkVPCId: + description: The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. + type: string + EbsOptimized: + description: Specifies whether the launch configuration is optimized for EBS I/O (true) or not (false). + type: boolean KeyName: description: Provides the name of the EC2 key pair. type: string - LaunchConfigurationName: - description: The name of the launch configuration. This name must be unique per Region per account. + SpotPrice: + description: The maximum hourly price you are willing to pay for any Spot Instances launched to fulfill the request. type: string - minLength: 1 - maxLength: 255 - MetadataOptions: - description: The metadata options for the instances. - $ref: '#/components/schemas/MetadataOptions' - PlacementTenancy: - description: The tenancy of the instance, either default or dedicated. + ImageId: + description: Provides the unique ID of the Amazon Machine Image (AMI) that was assigned during registration. + type: string + InstanceType: + description: Specifies the instance type of the EC2 instance. type: string RamDiskId: description: The ID of the RAM disk to select. type: string - SecurityGroups: - description: A list that contains the security groups to assign to the instances in the Auto Scaling group. - type: array - x-insertionOrder: false - items: - type: string - SpotPrice: - description: The maximum hourly price you are willing to pay for any Spot Instances launched to fulfill the request. - type: string - UserData: - description: The Base64-encoded user data to make available to the launched EC2 instances. - type: string - maxLength: 21847 + InstanceMonitoring: + description: Controls whether instances in this group are launched with detailed (true) or basic (false) monitoring. + type: boolean required: - ImageId - InstanceType @@ -1443,17 +1448,17 @@ components: x-tagging: taggable: false x-required-permissions: + read: + - autoscaling:DescribeLaunchConfigurations create: - autoscaling:CreateLaunchConfiguration - autoscaling:DescribeLaunchConfigurations - iam:PassRole - read: + list: - autoscaling:DescribeLaunchConfigurations delete: - autoscaling:DeleteLaunchConfiguration - autoscaling:DescribeLaunchConfigurations - list: - - autoscaling:DescribeLaunchConfigurations LifecycleHook: type: object properties: @@ -1970,7 +1975,7 @@ components: Cooldown: description: |- *Only needed if you use simple scaling policies.* - The amount of time, in seconds, between one scaling activity ending and another one starting due to simple scaling policies. For more information, see [Scaling cooldowns for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html) in the *Amazon EC2 Auto Scaling User Guide*. + The amount of time, in seconds, between one scaling activity ending and another one starting due to simple scaling policies. For more information, see [Scaling cooldowns for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-scaling-cooldowns.html) in the *Amazon EC2 Auto Scaling User Guide*. Default: ``300`` seconds type: string NotificationConfigurations: @@ -2001,7 +2006,7 @@ components: Default: None type: integer NewInstancesProtectedFromScaleIn: - description: Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. For more information about preventing instances from terminating on scale in, see [Using instance scale-in protection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-protection.html) in the *Amazon EC2 Auto Scaling User Guide*. + description: Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. For more information about preventing instances from terminating on scale in, see [Use instance scale-in protection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-protection.html) in the *Amazon EC2 Auto Scaling User Guide*. type: boolean LaunchTemplate: description: |- @@ -2079,7 +2084,7 @@ components: TerminationPolicies: uniqueItems: false description: |- - A policy or a list of policies that are used to select the instance to terminate. These policies are executed in the order that you list them. For more information, see [Work with Amazon EC2 Auto Scaling termination policies](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-termination-policies.html) in the *Amazon EC2 Auto Scaling User Guide*. + A policy or a list of policies that are used to select the instance to terminate. These policies are executed in the order that you list them. For more information, see [Configure termination policies for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-termination-policies.html) in the *Amazon EC2 Auto Scaling User Guide*. Valid values: ``Default`` | ``AllocationStrategy`` | ``ClosestToNextInstanceHour`` | ``NewestInstance`` | ``OldestInstance`` | ``OldestLaunchConfiguration`` | ``OldestLaunchTemplate`` | ``arn:aws:lambda:region:account-id:function:my-function:my-alias`` x-insertionOrder: true type: array @@ -2093,7 +2098,7 @@ components: type: string DesiredCapacityType: description: |- - The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports ``DesiredCapacityType`` for attribute-based instance type selection only. For more information, see [Creating an Auto Scaling group using attribute-based instance type selection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-instance-type-requirements.html) in the *Amazon EC2 Auto Scaling User Guide*. + The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports ``DesiredCapacityType`` for attribute-based instance type selection only. For more information, see [Create a mixed instances group using attribute-based instance type selection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-mixed-instances-group-attribute-based-instance-type-selection.html) in the *Amazon EC2 Auto Scaling User Guide*. By default, Amazon EC2 Auto Scaling specifies ``units``, which translates into number of instances. Valid values: ``units`` | ``vcpu`` | ``memory-mib`` type: string @@ -2105,11 +2110,11 @@ components: HealthCheckType: description: |- A comma-separated value string of one or more health check types. - The valid values are ``EC2``, ``ELB``, and ``VPC_LATTICE``. ``EC2`` is the default health check and cannot be disabled. For more information, see [Health checks for Auto Scaling instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html) in the *Amazon EC2 Auto Scaling User Guide*. + The valid values are ``EC2``, ``ELB``, and ``VPC_LATTICE``. ``EC2`` is the default health check and cannot be disabled. For more information, see [Health checks for instances in an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-health-checks.html) in the *Amazon EC2 Auto Scaling User Guide*. Only specify ``EC2`` if you must clear a value that was previously set. type: string MaxInstanceLifetime: - description: The maximum amount of time, in seconds, that an instance can be in service. The default is null. If specified, the value must be either 0 or a number equal to or greater than 86,400 seconds (1 day). For more information, see [Replacing Auto Scaling instances based on maximum instance lifetime](https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html) in the *Amazon EC2 Auto Scaling User Guide*. + description: The maximum amount of time, in seconds, that an instance can be in service. The default is null. If specified, the value must be either 0 or a number equal to or greater than 86,400 seconds (1 day). For more information, see [Replace Auto Scaling instances based on maximum instance lifetime](https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html) in the *Amazon EC2 Auto Scaling User Guide*. type: integer x-stackQL-stringOnly: true x-title: CreateAutoScalingGroupRequest @@ -2128,76 +2133,83 @@ components: DesiredState: type: object properties: - AssociatePublicIpAddress: - description: For Auto Scaling groups that are running in a virtual private cloud (VPC), specifies whether to assign a public IP address to the group's instances. - type: boolean - BlockDeviceMappings: - description: Specifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes. - type: array - uniqueItems: true + PlacementTenancy: + description: The tenancy of the instance, either default or dedicated. + type: string + SecurityGroups: + description: A list that contains the security groups to assign to the instances in the Auto Scaling group. x-insertionOrder: false + type: array items: - $ref: '#/components/schemas/BlockDeviceMapping' - ClassicLinkVPCId: - description: The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. + anyOf: + - relationshipRef: + typeName: AWS::EC2::SecurityGroup + propertyPath: /properties/GroupId + - relationshipRef: + typeName: AWS::EC2::SecurityGroup + propertyPath: /properties/Id + type: string + LaunchConfigurationName: + minLength: 1 + description: The name of the launch configuration. This name must be unique per Region per account. + type: string + maxLength: 255 + MetadataOptions: + description: The metadata options for the instances. + $ref: '#/components/schemas/MetadataOptions' + InstanceId: + description: The ID of the Amazon EC2 instance you want to use to create the launch configuration. type: string + UserData: + description: The Base64-encoded user data to make available to the launched EC2 instances. + type: string + maxLength: 21847 ClassicLinkVPCSecurityGroups: description: The IDs of one or more security groups for the VPC that you specified in the ClassicLinkVPCId property. - type: array x-insertionOrder: false + type: array items: type: string - EbsOptimized: - description: Specifies whether the launch configuration is optimized for EBS I/O (true) or not (false). - type: boolean + BlockDeviceMappings: + uniqueItems: true + description: Specifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/BlockDeviceMapping' IamInstanceProfile: description: Provides the name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance. The instance profile contains the IAM role. type: string - ImageId: - description: Provides the unique ID of the Amazon Machine Image (AMI) that was assigned during registration. - type: string - InstanceId: - description: The ID of the Amazon EC2 instance you want to use to create the launch configuration. - type: string - InstanceMonitoring: - description: Controls whether instances in this group are launched with detailed (true) or basic (false) monitoring. - type: boolean - InstanceType: - description: Specifies the instance type of the EC2 instance. - type: string KernelId: description: Provides the ID of the kernel associated with the EC2 AMI. type: string + AssociatePublicIpAddress: + description: For Auto Scaling groups that are running in a virtual private cloud (VPC), specifies whether to assign a public IP address to the group's instances. + type: boolean + ClassicLinkVPCId: + description: The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. + type: string + EbsOptimized: + description: Specifies whether the launch configuration is optimized for EBS I/O (true) or not (false). + type: boolean KeyName: description: Provides the name of the EC2 key pair. type: string - LaunchConfigurationName: - description: The name of the launch configuration. This name must be unique per Region per account. + SpotPrice: + description: The maximum hourly price you are willing to pay for any Spot Instances launched to fulfill the request. type: string - minLength: 1 - maxLength: 255 - MetadataOptions: - description: The metadata options for the instances. - $ref: '#/components/schemas/MetadataOptions' - PlacementTenancy: - description: The tenancy of the instance, either default or dedicated. + ImageId: + description: Provides the unique ID of the Amazon Machine Image (AMI) that was assigned during registration. + type: string + InstanceType: + description: Specifies the instance type of the EC2 instance. type: string RamDiskId: description: The ID of the RAM disk to select. type: string - SecurityGroups: - description: A list that contains the security groups to assign to the instances in the Auto Scaling group. - type: array - x-insertionOrder: false - items: - type: string - SpotPrice: - description: The maximum hourly price you are willing to pay for any Spot Instances launched to fulfill the request. - type: string - UserData: - description: The Base64-encoded user data to make available to the launched EC2 instances. - type: string - maxLength: 21847 + InstanceMonitoring: + description: Controls whether instances in this group are launched with detailed (true) or basic (false) monitoring. + type: boolean x-stackQL-stringOnly: true x-title: CreateLaunchConfigurationRequest type: object @@ -2392,7 +2404,7 @@ components: x-cfn-type-name: AWS::AutoScaling::AutoScalingGroup x-identifiers: - AutoScalingGroupName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2409,9 +2421,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2421,41 +2433,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/auto_scaling_groups/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/auto_scaling_groups/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AutoScalingGroupName') as auto_scaling_group_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AutoScaling::AutoScalingGroup' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AutoScalingGroupName') as auto_scaling_group_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AutoScaling::AutoScalingGroup' - AND region = 'us-east-1' - auto_scaling_group: - name: auto_scaling_group - id: aws.autoscaling.auto_scaling_group - x-cfn-schema-name: AutoScalingGroup - x-cfn-type-name: AWS::AutoScaling::AutoScalingGroup - x-identifiers: - - AutoScalingGroupName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2466,12 +2446,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/auto_scaling_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/auto_scaling_groups/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/auto_scaling_group/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/auto_scaling_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2510,44 +2494,60 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'LifecycleHookSpecificationList') as lifecycle_hook_specification_list, - json_extract_path_text(Properties, 'LoadBalancerNames') as load_balancer_names, - json_extract_path_text(Properties, 'LaunchConfigurationName') as launch_configuration_name, - json_extract_path_text(Properties, 'ServiceLinkedRoleARN') as service_linked_role_arn, - json_extract_path_text(Properties, 'TargetGroupARNs') as target_group_arns, - json_extract_path_text(Properties, 'Cooldown') as cooldown, - json_extract_path_text(Properties, 'NotificationConfigurations') as notification_configurations, - json_extract_path_text(Properties, 'DesiredCapacity') as desired_capacity, - json_extract_path_text(Properties, 'HealthCheckGracePeriod') as health_check_grace_period, - json_extract_path_text(Properties, 'DefaultInstanceWarmup') as default_instance_warmup, - json_extract_path_text(Properties, 'NewInstancesProtectedFromScaleIn') as new_instances_protected_from_scale_in, - json_extract_path_text(Properties, 'LaunchTemplate') as launch_template, - json_extract_path_text(Properties, 'MixedInstancesPolicy') as mixed_instances_policy, - json_extract_path_text(Properties, 'VPCZoneIdentifier') as vpc_zone_identifier, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Context') as context, - json_extract_path_text(Properties, 'CapacityRebalance') as capacity_rebalance, - json_extract_path_text(Properties, 'InstanceId') as instance_id, - json_extract_path_text(Properties, 'AvailabilityZones') as availability_zones, - json_extract_path_text(Properties, 'NotificationConfiguration') as notification_configuration, - json_extract_path_text(Properties, 'MetricsCollection') as metrics_collection, - json_extract_path_text(Properties, 'InstanceMaintenancePolicy') as instance_maintenance_policy, - json_extract_path_text(Properties, 'MaxSize') as max_size, - json_extract_path_text(Properties, 'MinSize') as min_size, - json_extract_path_text(Properties, 'TerminationPolicies') as termination_policies, - json_extract_path_text(Properties, 'AutoScalingGroupName') as auto_scaling_group_name, - json_extract_path_text(Properties, 'DesiredCapacityType') as desired_capacity_type, - json_extract_path_text(Properties, 'PlacementGroup') as placement_group, - json_extract_path_text(Properties, 'HealthCheckType') as health_check_type, - json_extract_path_text(Properties, 'MaxInstanceLifetime') as max_instance_lifetime - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AutoScaling::AutoScalingGroup' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.AutoScalingGroupName') as auto_scaling_group_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AutoScaling::AutoScalingGroup' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'LifecycleHookSpecificationList') as lifecycle_hook_specification_list, + json_extract_path_text(Properties, 'LoadBalancerNames') as load_balancer_names, + json_extract_path_text(Properties, 'LaunchConfigurationName') as launch_configuration_name, + json_extract_path_text(Properties, 'ServiceLinkedRoleARN') as service_linked_role_arn, + json_extract_path_text(Properties, 'TargetGroupARNs') as target_group_arns, + json_extract_path_text(Properties, 'Cooldown') as cooldown, + json_extract_path_text(Properties, 'NotificationConfigurations') as notification_configurations, + json_extract_path_text(Properties, 'DesiredCapacity') as desired_capacity, + json_extract_path_text(Properties, 'HealthCheckGracePeriod') as health_check_grace_period, + json_extract_path_text(Properties, 'DefaultInstanceWarmup') as default_instance_warmup, + json_extract_path_text(Properties, 'NewInstancesProtectedFromScaleIn') as new_instances_protected_from_scale_in, + json_extract_path_text(Properties, 'LaunchTemplate') as launch_template, + json_extract_path_text(Properties, 'MixedInstancesPolicy') as mixed_instances_policy, + json_extract_path_text(Properties, 'VPCZoneIdentifier') as vpc_zone_identifier, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Context') as context, + json_extract_path_text(Properties, 'CapacityRebalance') as capacity_rebalance, + json_extract_path_text(Properties, 'InstanceId') as instance_id, + json_extract_path_text(Properties, 'AvailabilityZones') as availability_zones, + json_extract_path_text(Properties, 'NotificationConfiguration') as notification_configuration, + json_extract_path_text(Properties, 'MetricsCollection') as metrics_collection, + json_extract_path_text(Properties, 'InstanceMaintenancePolicy') as instance_maintenance_policy, + json_extract_path_text(Properties, 'MaxSize') as max_size, + json_extract_path_text(Properties, 'MinSize') as min_size, + json_extract_path_text(Properties, 'TerminationPolicies') as termination_policies, + json_extract_path_text(Properties, 'AutoScalingGroupName') as auto_scaling_group_name, + json_extract_path_text(Properties, 'DesiredCapacityType') as desired_capacity_type, + json_extract_path_text(Properties, 'PlacementGroup') as placement_group, + json_extract_path_text(Properties, 'HealthCheckType') as health_check_type, + json_extract_path_text(Properties, 'MaxInstanceLifetime') as max_instance_lifetime + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AutoScaling::AutoScalingGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AutoScalingGroupName') as auto_scaling_group_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AutoScaling::AutoScalingGroup' + AND region = 'us-east-1' launch_configurations: name: launch_configurations id: aws.autoscaling.launch_configurations @@ -2555,7 +2555,7 @@ components: x-cfn-type-name: AWS::AutoScaling::LaunchConfiguration x-identifiers: - LaunchConfigurationName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2589,93 +2589,81 @@ components: - $ref: '#/components/x-stackQL-resources/launch_configurations/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/launch_configurations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.LaunchConfigurationName') as launch_configuration_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AutoScaling::LaunchConfiguration' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'LaunchConfigurationName') as launch_configuration_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AutoScaling::LaunchConfiguration' - AND region = 'us-east-1' - launch_configuration: - name: launch_configuration - id: aws.autoscaling.launch_configuration - x-cfn-schema-name: LaunchConfiguration - x-cfn-type-name: AWS::AutoScaling::LaunchConfiguration - x-identifiers: - - LaunchConfigurationName - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.AssociatePublicIpAddress') as associate_public_ip_address, + JSON_EXTRACT(Properties, '$.PlacementTenancy') as placement_tenancy, + JSON_EXTRACT(Properties, '$.SecurityGroups') as security_groups, + JSON_EXTRACT(Properties, '$.LaunchConfigurationName') as launch_configuration_name, + JSON_EXTRACT(Properties, '$.MetadataOptions') as metadata_options, + JSON_EXTRACT(Properties, '$.InstanceId') as instance_id, + JSON_EXTRACT(Properties, '$.UserData') as user_data, + JSON_EXTRACT(Properties, '$.ClassicLinkVPCSecurityGroups') as classic_link_vpc_security_groups, JSON_EXTRACT(Properties, '$.BlockDeviceMappings') as block_device_mappings, + JSON_EXTRACT(Properties, '$.IamInstanceProfile') as iam_instance_profile, + JSON_EXTRACT(Properties, '$.KernelId') as kernel_id, + JSON_EXTRACT(Properties, '$.AssociatePublicIpAddress') as associate_public_ip_address, JSON_EXTRACT(Properties, '$.ClassicLinkVPCId') as classic_link_vpc_id, - JSON_EXTRACT(Properties, '$.ClassicLinkVPCSecurityGroups') as classic_link_vpc_security_groups, JSON_EXTRACT(Properties, '$.EbsOptimized') as ebs_optimized, - JSON_EXTRACT(Properties, '$.IamInstanceProfile') as iam_instance_profile, + JSON_EXTRACT(Properties, '$.KeyName') as key_name, + JSON_EXTRACT(Properties, '$.SpotPrice') as spot_price, JSON_EXTRACT(Properties, '$.ImageId') as image_id, - JSON_EXTRACT(Properties, '$.InstanceId') as instance_id, - JSON_EXTRACT(Properties, '$.InstanceMonitoring') as instance_monitoring, JSON_EXTRACT(Properties, '$.InstanceType') as instance_type, - JSON_EXTRACT(Properties, '$.KernelId') as kernel_id, - JSON_EXTRACT(Properties, '$.KeyName') as key_name, - JSON_EXTRACT(Properties, '$.LaunchConfigurationName') as launch_configuration_name, - JSON_EXTRACT(Properties, '$.MetadataOptions') as metadata_options, - JSON_EXTRACT(Properties, '$.PlacementTenancy') as placement_tenancy, JSON_EXTRACT(Properties, '$.RamDiskId') as ram_disk_id, - JSON_EXTRACT(Properties, '$.SecurityGroups') as security_groups, - JSON_EXTRACT(Properties, '$.SpotPrice') as spot_price, - JSON_EXTRACT(Properties, '$.UserData') as user_data + JSON_EXTRACT(Properties, '$.InstanceMonitoring') as instance_monitoring FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AutoScaling::LaunchConfiguration' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AssociatePublicIpAddress') as associate_public_ip_address, - json_extract_path_text(Properties, 'BlockDeviceMappings') as block_device_mappings, - json_extract_path_text(Properties, 'ClassicLinkVPCId') as classic_link_vpc_id, - json_extract_path_text(Properties, 'ClassicLinkVPCSecurityGroups') as classic_link_vpc_security_groups, - json_extract_path_text(Properties, 'EbsOptimized') as ebs_optimized, - json_extract_path_text(Properties, 'IamInstanceProfile') as iam_instance_profile, - json_extract_path_text(Properties, 'ImageId') as image_id, - json_extract_path_text(Properties, 'InstanceId') as instance_id, - json_extract_path_text(Properties, 'InstanceMonitoring') as instance_monitoring, - json_extract_path_text(Properties, 'InstanceType') as instance_type, - json_extract_path_text(Properties, 'KernelId') as kernel_id, - json_extract_path_text(Properties, 'KeyName') as key_name, - json_extract_path_text(Properties, 'LaunchConfigurationName') as launch_configuration_name, - json_extract_path_text(Properties, 'MetadataOptions') as metadata_options, - json_extract_path_text(Properties, 'PlacementTenancy') as placement_tenancy, - json_extract_path_text(Properties, 'RamDiskId') as ram_disk_id, - json_extract_path_text(Properties, 'SecurityGroups') as security_groups, - json_extract_path_text(Properties, 'SpotPrice') as spot_price, - json_extract_path_text(Properties, 'UserData') as user_data - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AutoScaling::LaunchConfiguration' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.LaunchConfigurationName') as launch_configuration_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AutoScaling::LaunchConfiguration' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'PlacementTenancy') as placement_tenancy, + json_extract_path_text(Properties, 'SecurityGroups') as security_groups, + json_extract_path_text(Properties, 'LaunchConfigurationName') as launch_configuration_name, + json_extract_path_text(Properties, 'MetadataOptions') as metadata_options, + json_extract_path_text(Properties, 'InstanceId') as instance_id, + json_extract_path_text(Properties, 'UserData') as user_data, + json_extract_path_text(Properties, 'ClassicLinkVPCSecurityGroups') as classic_link_vpc_security_groups, + json_extract_path_text(Properties, 'BlockDeviceMappings') as block_device_mappings, + json_extract_path_text(Properties, 'IamInstanceProfile') as iam_instance_profile, + json_extract_path_text(Properties, 'KernelId') as kernel_id, + json_extract_path_text(Properties, 'AssociatePublicIpAddress') as associate_public_ip_address, + json_extract_path_text(Properties, 'ClassicLinkVPCId') as classic_link_vpc_id, + json_extract_path_text(Properties, 'EbsOptimized') as ebs_optimized, + json_extract_path_text(Properties, 'KeyName') as key_name, + json_extract_path_text(Properties, 'SpotPrice') as spot_price, + json_extract_path_text(Properties, 'ImageId') as image_id, + json_extract_path_text(Properties, 'InstanceType') as instance_type, + json_extract_path_text(Properties, 'RamDiskId') as ram_disk_id, + json_extract_path_text(Properties, 'InstanceMonitoring') as instance_monitoring + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AutoScaling::LaunchConfiguration' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'LaunchConfigurationName') as launch_configuration_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AutoScaling::LaunchConfiguration' + AND region = 'us-east-1' lifecycle_hooks: name: lifecycle_hooks id: aws.autoscaling.lifecycle_hooks @@ -2684,7 +2672,7 @@ components: x-identifiers: - AutoScalingGroupName - LifecycleHookName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2701,9 +2689,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2713,44 +2701,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/lifecycle_hooks/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/lifecycle_hooks/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AutoScalingGroupName') as auto_scaling_group_name, - JSON_EXTRACT(Properties, '$.LifecycleHookName') as lifecycle_hook_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AutoScaling::LifecycleHook' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AutoScalingGroupName') as auto_scaling_group_name, - json_extract_path_text(Properties, 'LifecycleHookName') as lifecycle_hook_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AutoScaling::LifecycleHook' - AND region = 'us-east-1' - lifecycle_hook: - name: lifecycle_hook - id: aws.autoscaling.lifecycle_hook - x-cfn-schema-name: LifecycleHook - x-cfn-type-name: AWS::AutoScaling::LifecycleHook - x-identifiers: - - AutoScalingGroupName - - LifecycleHookName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2761,12 +2714,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/lifecycle_hooks/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/lifecycle_hooks/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/lifecycle_hook/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/lifecycle_hooks/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2783,22 +2740,40 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AutoScalingGroupName') as auto_scaling_group_name, - json_extract_path_text(Properties, 'DefaultResult') as default_result, - json_extract_path_text(Properties, 'HeartbeatTimeout') as heartbeat_timeout, - json_extract_path_text(Properties, 'LifecycleHookName') as lifecycle_hook_name, - json_extract_path_text(Properties, 'LifecycleTransition') as lifecycle_transition, - json_extract_path_text(Properties, 'NotificationMetadata') as notification_metadata, - json_extract_path_text(Properties, 'NotificationTargetARN') as notification_target_arn, - json_extract_path_text(Properties, 'RoleARN') as role_arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AutoScaling::LifecycleHook' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.AutoScalingGroupName') as auto_scaling_group_name, + JSON_EXTRACT(Properties, '$.LifecycleHookName') as lifecycle_hook_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AutoScaling::LifecycleHook' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AutoScalingGroupName') as auto_scaling_group_name, + json_extract_path_text(Properties, 'DefaultResult') as default_result, + json_extract_path_text(Properties, 'HeartbeatTimeout') as heartbeat_timeout, + json_extract_path_text(Properties, 'LifecycleHookName') as lifecycle_hook_name, + json_extract_path_text(Properties, 'LifecycleTransition') as lifecycle_transition, + json_extract_path_text(Properties, 'NotificationMetadata') as notification_metadata, + json_extract_path_text(Properties, 'NotificationTargetARN') as notification_target_arn, + json_extract_path_text(Properties, 'RoleARN') as role_arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AutoScaling::LifecycleHook' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AutoScalingGroupName') as auto_scaling_group_name, + json_extract_path_text(Properties, 'LifecycleHookName') as lifecycle_hook_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AutoScaling::LifecycleHook' + AND region = 'us-east-1' scaling_policies: name: scaling_policies id: aws.autoscaling.scaling_policies @@ -2806,7 +2781,7 @@ components: x-cfn-type-name: AWS::AutoScaling::ScalingPolicy x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2823,9 +2798,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2835,41 +2810,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/scaling_policies/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/scaling_policies/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AutoScaling::ScalingPolicy' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AutoScaling::ScalingPolicy' - AND region = 'us-east-1' - scaling_policy: - name: scaling_policy - id: aws.autoscaling.scaling_policy - x-cfn-schema-name: ScalingPolicy - x-cfn-type-name: AWS::AutoScaling::ScalingPolicy - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2880,12 +2823,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/scaling_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/scaling_policies/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/scaling_policy/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/scaling_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2907,27 +2854,43 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'MetricAggregationType') as metric_aggregation_type, - json_extract_path_text(Properties, 'PolicyName') as policy_name, - json_extract_path_text(Properties, 'PolicyType') as policy_type, - json_extract_path_text(Properties, 'PredictiveScalingConfiguration') as predictive_scaling_configuration, - json_extract_path_text(Properties, 'ScalingAdjustment') as scaling_adjustment, - json_extract_path_text(Properties, 'Cooldown') as cooldown, - json_extract_path_text(Properties, 'StepAdjustments') as step_adjustments, - json_extract_path_text(Properties, 'AutoScalingGroupName') as auto_scaling_group_name, - json_extract_path_text(Properties, 'MinAdjustmentMagnitude') as min_adjustment_magnitude, - json_extract_path_text(Properties, 'TargetTrackingConfiguration') as target_tracking_configuration, - json_extract_path_text(Properties, 'EstimatedInstanceWarmup') as estimated_instance_warmup, - json_extract_path_text(Properties, 'AdjustmentType') as adjustment_type, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AutoScaling::ScalingPolicy' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AutoScaling::ScalingPolicy' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'MetricAggregationType') as metric_aggregation_type, + json_extract_path_text(Properties, 'PolicyName') as policy_name, + json_extract_path_text(Properties, 'PolicyType') as policy_type, + json_extract_path_text(Properties, 'PredictiveScalingConfiguration') as predictive_scaling_configuration, + json_extract_path_text(Properties, 'ScalingAdjustment') as scaling_adjustment, + json_extract_path_text(Properties, 'Cooldown') as cooldown, + json_extract_path_text(Properties, 'StepAdjustments') as step_adjustments, + json_extract_path_text(Properties, 'AutoScalingGroupName') as auto_scaling_group_name, + json_extract_path_text(Properties, 'MinAdjustmentMagnitude') as min_adjustment_magnitude, + json_extract_path_text(Properties, 'TargetTrackingConfiguration') as target_tracking_configuration, + json_extract_path_text(Properties, 'EstimatedInstanceWarmup') as estimated_instance_warmup, + json_extract_path_text(Properties, 'AdjustmentType') as adjustment_type, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AutoScaling::ScalingPolicy' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AutoScaling::ScalingPolicy' + AND region = 'us-east-1' scheduled_actions: name: scheduled_actions id: aws.autoscaling.scheduled_actions @@ -2936,7 +2899,7 @@ components: x-identifiers: - ScheduledActionName - AutoScalingGroupName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2953,9 +2916,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2965,44 +2928,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/scheduled_actions/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/scheduled_actions/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ScheduledActionName') as scheduled_action_name, - JSON_EXTRACT(Properties, '$.AutoScalingGroupName') as auto_scaling_group_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AutoScaling::ScheduledAction' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ScheduledActionName') as scheduled_action_name, - json_extract_path_text(Properties, 'AutoScalingGroupName') as auto_scaling_group_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AutoScaling::ScheduledAction' - AND region = 'us-east-1' - scheduled_action: - name: scheduled_action - id: aws.autoscaling.scheduled_action - x-cfn-schema-name: ScheduledAction - x-cfn-type-name: AWS::AutoScaling::ScheduledAction - x-identifiers: - - ScheduledActionName - - AutoScalingGroupName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3013,12 +2941,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/scheduled_actions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/scheduled_actions/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/scheduled_action/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/scheduled_actions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3036,23 +2968,41 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ScheduledActionName') as scheduled_action_name, - json_extract_path_text(Properties, 'MinSize') as min_size, - json_extract_path_text(Properties, 'Recurrence') as recurrence, - json_extract_path_text(Properties, 'TimeZone') as time_zone, - json_extract_path_text(Properties, 'EndTime') as end_time, - json_extract_path_text(Properties, 'AutoScalingGroupName') as auto_scaling_group_name, - json_extract_path_text(Properties, 'StartTime') as start_time, - json_extract_path_text(Properties, 'DesiredCapacity') as desired_capacity, - json_extract_path_text(Properties, 'MaxSize') as max_size - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AutoScaling::ScheduledAction' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.ScheduledActionName') as scheduled_action_name, + JSON_EXTRACT(Properties, '$.AutoScalingGroupName') as auto_scaling_group_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AutoScaling::ScheduledAction' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ScheduledActionName') as scheduled_action_name, + json_extract_path_text(Properties, 'MinSize') as min_size, + json_extract_path_text(Properties, 'Recurrence') as recurrence, + json_extract_path_text(Properties, 'TimeZone') as time_zone, + json_extract_path_text(Properties, 'EndTime') as end_time, + json_extract_path_text(Properties, 'AutoScalingGroupName') as auto_scaling_group_name, + json_extract_path_text(Properties, 'StartTime') as start_time, + json_extract_path_text(Properties, 'DesiredCapacity') as desired_capacity, + json_extract_path_text(Properties, 'MaxSize') as max_size + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::AutoScaling::ScheduledAction' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ScheduledActionName') as scheduled_action_name, + json_extract_path_text(Properties, 'AutoScalingGroupName') as auto_scaling_group_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::AutoScaling::ScheduledAction' + AND region = 'us-east-1' warm_pools: name: warm_pools id: aws.autoscaling.warm_pools @@ -3060,7 +3010,7 @@ components: x-cfn-type-name: AWS::AutoScaling::WarmPool x-identifiers: - AutoScalingGroupName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3077,9 +3027,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3089,23 +3039,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/warm_pools/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/warm_pools/methods/delete_resource' - warm_pool: - name: warm_pool - id: aws.autoscaling.warm_pool - x-cfn-schema-name: WarmPool - x-cfn-type-name: AWS::AutoScaling::WarmPool - x-identifiers: - - AutoScalingGroupName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3116,12 +3052,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/warm_pools/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/warm_pools/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/warm_pool/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/warm_pools/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3135,7 +3075,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, diff --git a/providers/src/aws/v00.00.00000/services/b2bi.yaml b/providers/src/aws/v00.00.00000/services/b2bi.yaml index 43900abc..b751371d 100644 --- a/providers/src/aws/v00.00.00000/services/b2bi.yaml +++ b/providers/src/aws/v00.00.00000/services/b2bi.yaml @@ -1211,7 +1211,7 @@ components: x-cfn-type-name: AWS::B2BI::Capability x-identifiers: - CapabilityId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1228,9 +1228,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1240,41 +1240,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/capabilities/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/capabilities/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.CapabilityId') as capability_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::B2BI::Capability' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'CapabilityId') as capability_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::B2BI::Capability' - AND region = 'us-east-1' - capability: - name: capability - id: aws.b2bi.capability - x-cfn-schema-name: Capability - x-cfn-type-name: AWS::B2BI::Capability - x-identifiers: - - CapabilityId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1285,12 +1253,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/capabilities/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/capabilities/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/capability/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/capabilities/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1308,23 +1280,39 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'CapabilityArn') as capability_arn, - json_extract_path_text(Properties, 'CapabilityId') as capability_id, - json_extract_path_text(Properties, 'Configuration') as configuration, - json_extract_path_text(Properties, 'CreatedAt') as created_at, - json_extract_path_text(Properties, 'InstructionsDocuments') as instructions_documents, - json_extract_path_text(Properties, 'ModifiedAt') as modified_at, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Type') as type - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::B2BI::Capability' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.CapabilityId') as capability_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::B2BI::Capability' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'CapabilityArn') as capability_arn, + json_extract_path_text(Properties, 'CapabilityId') as capability_id, + json_extract_path_text(Properties, 'Configuration') as configuration, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'InstructionsDocuments') as instructions_documents, + json_extract_path_text(Properties, 'ModifiedAt') as modified_at, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Type') as type + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::B2BI::Capability' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'CapabilityId') as capability_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::B2BI::Capability' + AND region = 'us-east-1' partnerships: name: partnerships id: aws.b2bi.partnerships @@ -1332,7 +1320,7 @@ components: x-cfn-type-name: AWS::B2BI::Partnership x-identifiers: - PartnershipId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1349,9 +1337,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1361,41 +1349,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/partnerships/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/partnerships/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.PartnershipId') as partnership_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::B2BI::Partnership' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'PartnershipId') as partnership_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::B2BI::Partnership' - AND region = 'us-east-1' - partnership: - name: partnership - id: aws.b2bi.partnership - x-cfn-schema-name: Partnership - x-cfn-type-name: AWS::B2BI::Partnership - x-identifiers: - - PartnershipId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1406,12 +1362,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/partnerships/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/partnerships/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/partnership/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/partnerships/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1431,25 +1391,41 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Capabilities') as capabilities, - json_extract_path_text(Properties, 'CreatedAt') as created_at, - json_extract_path_text(Properties, 'Email') as email, - json_extract_path_text(Properties, 'ModifiedAt') as modified_at, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'PartnershipArn') as partnership_arn, - json_extract_path_text(Properties, 'PartnershipId') as partnership_id, - json_extract_path_text(Properties, 'Phone') as phone, - json_extract_path_text(Properties, 'ProfileId') as profile_id, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'TradingPartnerId') as trading_partner_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::B2BI::Partnership' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.PartnershipId') as partnership_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::B2BI::Partnership' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Capabilities') as capabilities, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'Email') as email, + json_extract_path_text(Properties, 'ModifiedAt') as modified_at, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'PartnershipArn') as partnership_arn, + json_extract_path_text(Properties, 'PartnershipId') as partnership_id, + json_extract_path_text(Properties, 'Phone') as phone, + json_extract_path_text(Properties, 'ProfileId') as profile_id, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'TradingPartnerId') as trading_partner_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::B2BI::Partnership' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'PartnershipId') as partnership_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::B2BI::Partnership' + AND region = 'us-east-1' profiles: name: profiles id: aws.b2bi.profiles @@ -1457,7 +1433,7 @@ components: x-cfn-type-name: AWS::B2BI::Profile x-identifiers: - ProfileId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1474,9 +1450,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1486,41 +1462,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/profiles/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/profiles/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ProfileId') as profile_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::B2BI::Profile' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ProfileId') as profile_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::B2BI::Profile' - AND region = 'us-east-1' - profile: - name: profile - id: aws.b2bi.profile - x-cfn-schema-name: Profile - x-cfn-type-name: AWS::B2BI::Profile - x-identifiers: - - ProfileId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1531,12 +1475,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/profiles/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/profiles/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/profile/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/profiles/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1556,25 +1504,41 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'BusinessName') as business_name, - json_extract_path_text(Properties, 'CreatedAt') as created_at, - json_extract_path_text(Properties, 'Email') as email, - json_extract_path_text(Properties, 'LogGroupName') as log_group_name, - json_extract_path_text(Properties, 'Logging') as logging, - json_extract_path_text(Properties, 'ModifiedAt') as modified_at, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Phone') as phone, - json_extract_path_text(Properties, 'ProfileArn') as profile_arn, - json_extract_path_text(Properties, 'ProfileId') as profile_id, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::B2BI::Profile' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ProfileId') as profile_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::B2BI::Profile' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'BusinessName') as business_name, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'Email') as email, + json_extract_path_text(Properties, 'LogGroupName') as log_group_name, + json_extract_path_text(Properties, 'Logging') as logging, + json_extract_path_text(Properties, 'ModifiedAt') as modified_at, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Phone') as phone, + json_extract_path_text(Properties, 'ProfileArn') as profile_arn, + json_extract_path_text(Properties, 'ProfileId') as profile_id, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::B2BI::Profile' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ProfileId') as profile_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::B2BI::Profile' + AND region = 'us-east-1' transformers: name: transformers id: aws.b2bi.transformers @@ -1582,7 +1546,7 @@ components: x-cfn-type-name: AWS::B2BI::Transformer x-identifiers: - TransformerId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1599,9 +1563,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1611,41 +1575,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/transformers/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/transformers/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.TransformerId') as transformer_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::B2BI::Transformer' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'TransformerId') as transformer_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::B2BI::Transformer' - AND region = 'us-east-1' - transformer: - name: transformer - id: aws.b2bi.transformer - x-cfn-schema-name: Transformer - x-cfn-type-name: AWS::B2BI::Transformer - x-identifiers: - - TransformerId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1656,12 +1588,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/transformers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/transformers/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/transformer/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/transformers/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1681,25 +1617,41 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'CreatedAt') as created_at, - json_extract_path_text(Properties, 'EdiType') as edi_type, - json_extract_path_text(Properties, 'FileFormat') as file_format, - json_extract_path_text(Properties, 'MappingTemplate') as mapping_template, - json_extract_path_text(Properties, 'ModifiedAt') as modified_at, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'SampleDocument') as sample_document, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'TransformerArn') as transformer_arn, - json_extract_path_text(Properties, 'TransformerId') as transformer_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::B2BI::Transformer' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.TransformerId') as transformer_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::B2BI::Transformer' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'EdiType') as edi_type, + json_extract_path_text(Properties, 'FileFormat') as file_format, + json_extract_path_text(Properties, 'MappingTemplate') as mapping_template, + json_extract_path_text(Properties, 'ModifiedAt') as modified_at, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'SampleDocument') as sample_document, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'TransformerArn') as transformer_arn, + json_extract_path_text(Properties, 'TransformerId') as transformer_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::B2BI::Transformer' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'TransformerId') as transformer_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::B2BI::Transformer' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/backup.yaml b/providers/src/aws/v00.00.00000/services/backup.yaml index 25f8fd3c..68396478 100644 --- a/providers/src/aws/v00.00.00000/services/backup.yaml +++ b/providers/src/aws/v00.00.00000/services/backup.yaml @@ -1571,7 +1571,7 @@ components: x-cfn-type-name: AWS::Backup::BackupPlan x-identifiers: - BackupPlanId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1588,9 +1588,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1600,41 +1600,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/backup_plans/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/backup_plans/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.BackupPlanId') as backup_plan_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Backup::BackupPlan' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'BackupPlanId') as backup_plan_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Backup::BackupPlan' - AND region = 'us-east-1' - backup_plan: - name: backup_plan - id: aws.backup.backup_plan - x-cfn-schema-name: BackupPlan - x-cfn-type-name: AWS::Backup::BackupPlan - x-identifiers: - - BackupPlanId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1645,12 +1613,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/backup_plans/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/backup_plans/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/backup_plan/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/backup_plans/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1664,19 +1636,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'BackupPlan') as backup_plan, - json_extract_path_text(Properties, 'BackupPlanTags') as backup_plan_tags, - json_extract_path_text(Properties, 'BackupPlanArn') as backup_plan_arn, - json_extract_path_text(Properties, 'BackupPlanId') as backup_plan_id, - json_extract_path_text(Properties, 'VersionId') as version_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Backup::BackupPlan' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.BackupPlanId') as backup_plan_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Backup::BackupPlan' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'BackupPlan') as backup_plan, + json_extract_path_text(Properties, 'BackupPlanTags') as backup_plan_tags, + json_extract_path_text(Properties, 'BackupPlanArn') as backup_plan_arn, + json_extract_path_text(Properties, 'BackupPlanId') as backup_plan_id, + json_extract_path_text(Properties, 'VersionId') as version_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Backup::BackupPlan' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'BackupPlanId') as backup_plan_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Backup::BackupPlan' + AND region = 'us-east-1' backup_selections: name: backup_selections id: aws.backup.backup_selections @@ -1684,7 +1672,7 @@ components: x-cfn-type-name: AWS::Backup::BackupSelection x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1718,39 +1706,11 @@ components: - $ref: '#/components/x-stackQL-resources/backup_selections/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/backup_selections/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Backup::BackupSelection' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Backup::BackupSelection' - AND region = 'us-east-1' - backup_selection: - name: backup_selection - id: aws.backup.backup_selection - x-cfn-schema-name: BackupSelection - x-cfn-type-name: AWS::Backup::BackupSelection - x-identifiers: - - Id - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1763,18 +1723,34 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'BackupPlanId') as backup_plan_id, - json_extract_path_text(Properties, 'BackupSelection') as backup_selection, - json_extract_path_text(Properties, 'SelectionId') as selection_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Backup::BackupSelection' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Backup::BackupSelection' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'BackupPlanId') as backup_plan_id, + json_extract_path_text(Properties, 'BackupSelection') as backup_selection, + json_extract_path_text(Properties, 'SelectionId') as selection_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Backup::BackupSelection' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Backup::BackupSelection' + AND region = 'us-east-1' backup_vaults: name: backup_vaults id: aws.backup.backup_vaults @@ -1782,7 +1758,7 @@ components: x-cfn-type-name: AWS::Backup::BackupVault x-identifiers: - BackupVaultName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1799,9 +1775,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1811,41 +1787,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/backup_vaults/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/backup_vaults/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.BackupVaultName') as backup_vault_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Backup::BackupVault' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'BackupVaultName') as backup_vault_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Backup::BackupVault' - AND region = 'us-east-1' - backup_vault: - name: backup_vault - id: aws.backup.backup_vault - x-cfn-schema-name: BackupVault - x-cfn-type-name: AWS::Backup::BackupVault - x-identifiers: - - BackupVaultName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1856,12 +1800,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/backup_vaults/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/backup_vaults/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/backup_vault/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/backup_vaults/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1877,21 +1825,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AccessPolicy') as access_policy, - json_extract_path_text(Properties, 'BackupVaultName') as backup_vault_name, - json_extract_path_text(Properties, 'BackupVaultTags') as backup_vault_tags, - json_extract_path_text(Properties, 'EncryptionKeyArn') as encryption_key_arn, - json_extract_path_text(Properties, 'Notifications') as notifications, - json_extract_path_text(Properties, 'LockConfiguration') as lock_configuration, - json_extract_path_text(Properties, 'BackupVaultArn') as backup_vault_arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Backup::BackupVault' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.BackupVaultName') as backup_vault_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Backup::BackupVault' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AccessPolicy') as access_policy, + json_extract_path_text(Properties, 'BackupVaultName') as backup_vault_name, + json_extract_path_text(Properties, 'BackupVaultTags') as backup_vault_tags, + json_extract_path_text(Properties, 'EncryptionKeyArn') as encryption_key_arn, + json_extract_path_text(Properties, 'Notifications') as notifications, + json_extract_path_text(Properties, 'LockConfiguration') as lock_configuration, + json_extract_path_text(Properties, 'BackupVaultArn') as backup_vault_arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Backup::BackupVault' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'BackupVaultName') as backup_vault_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Backup::BackupVault' + AND region = 'us-east-1' frameworks: name: frameworks id: aws.backup.frameworks @@ -1899,7 +1863,7 @@ components: x-cfn-type-name: AWS::Backup::Framework x-identifiers: - FrameworkArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1916,9 +1880,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1928,41 +1892,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/frameworks/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/frameworks/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.FrameworkArn') as framework_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Backup::Framework' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'FrameworkArn') as framework_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Backup::Framework' - AND region = 'us-east-1' - framework: - name: framework - id: aws.backup.framework - x-cfn-schema-name: Framework - x-cfn-type-name: AWS::Backup::Framework - x-identifiers: - - FrameworkArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1973,12 +1905,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/frameworks/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/frameworks/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/framework/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/frameworks/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1995,22 +1931,38 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'FrameworkName') as framework_name, - json_extract_path_text(Properties, 'FrameworkDescription') as framework_description, - json_extract_path_text(Properties, 'FrameworkArn') as framework_arn, - json_extract_path_text(Properties, 'DeploymentStatus') as deployment_status, - json_extract_path_text(Properties, 'CreationTime') as creation_time, - json_extract_path_text(Properties, 'FrameworkControls') as framework_controls, - json_extract_path_text(Properties, 'FrameworkStatus') as framework_status, - json_extract_path_text(Properties, 'FrameworkTags') as framework_tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Backup::Framework' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.FrameworkArn') as framework_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Backup::Framework' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'FrameworkName') as framework_name, + json_extract_path_text(Properties, 'FrameworkDescription') as framework_description, + json_extract_path_text(Properties, 'FrameworkArn') as framework_arn, + json_extract_path_text(Properties, 'DeploymentStatus') as deployment_status, + json_extract_path_text(Properties, 'CreationTime') as creation_time, + json_extract_path_text(Properties, 'FrameworkControls') as framework_controls, + json_extract_path_text(Properties, 'FrameworkStatus') as framework_status, + json_extract_path_text(Properties, 'FrameworkTags') as framework_tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Backup::Framework' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'FrameworkArn') as framework_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Backup::Framework' + AND region = 'us-east-1' report_plans: name: report_plans id: aws.backup.report_plans @@ -2018,7 +1970,7 @@ components: x-cfn-type-name: AWS::Backup::ReportPlan x-identifiers: - ReportPlanArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2035,9 +1987,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2047,41 +1999,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/report_plans/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/report_plans/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ReportPlanArn') as report_plan_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Backup::ReportPlan' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ReportPlanArn') as report_plan_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Backup::ReportPlan' - AND region = 'us-east-1' - report_plan: - name: report_plan - id: aws.backup.report_plan - x-cfn-schema-name: ReportPlan - x-cfn-type-name: AWS::Backup::ReportPlan - x-identifiers: - - ReportPlanArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2092,12 +2012,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/report_plans/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/report_plans/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/report_plan/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/report_plans/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2112,20 +2036,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ReportPlanName') as report_plan_name, - json_extract_path_text(Properties, 'ReportPlanArn') as report_plan_arn, - json_extract_path_text(Properties, 'ReportPlanDescription') as report_plan_description, - json_extract_path_text(Properties, 'ReportPlanTags') as report_plan_tags, - json_extract_path_text(Properties, 'ReportDeliveryChannel') as report_delivery_channel, - json_extract_path_text(Properties, 'ReportSetting') as report_setting - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Backup::ReportPlan' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ReportPlanArn') as report_plan_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Backup::ReportPlan' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ReportPlanName') as report_plan_name, + json_extract_path_text(Properties, 'ReportPlanArn') as report_plan_arn, + json_extract_path_text(Properties, 'ReportPlanDescription') as report_plan_description, + json_extract_path_text(Properties, 'ReportPlanTags') as report_plan_tags, + json_extract_path_text(Properties, 'ReportDeliveryChannel') as report_delivery_channel, + json_extract_path_text(Properties, 'ReportSetting') as report_setting + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Backup::ReportPlan' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ReportPlanArn') as report_plan_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Backup::ReportPlan' + AND region = 'us-east-1' restore_testing_plans: name: restore_testing_plans id: aws.backup.restore_testing_plans @@ -2133,7 +2073,7 @@ components: x-cfn-type-name: AWS::Backup::RestoreTestingPlan x-identifiers: - RestoreTestingPlanName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2150,9 +2090,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2162,41 +2102,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/restore_testing_plans/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/restore_testing_plans/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.RestoreTestingPlanName') as restore_testing_plan_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Backup::RestoreTestingPlan' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'RestoreTestingPlanName') as restore_testing_plan_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Backup::RestoreTestingPlan' - AND region = 'us-east-1' - restore_testing_plan: - name: restore_testing_plan - id: aws.backup.restore_testing_plan - x-cfn-schema-name: RestoreTestingPlan - x-cfn-type-name: AWS::Backup::RestoreTestingPlan - x-identifiers: - - RestoreTestingPlanName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2207,12 +2115,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/restore_testing_plans/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/restore_testing_plans/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/restore_testing_plan/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/restore_testing_plans/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2228,21 +2140,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'RecoveryPointSelection') as recovery_point_selection, - json_extract_path_text(Properties, 'RestoreTestingPlanArn') as restore_testing_plan_arn, - json_extract_path_text(Properties, 'RestoreTestingPlanName') as restore_testing_plan_name, - json_extract_path_text(Properties, 'ScheduleExpression') as schedule_expression, - json_extract_path_text(Properties, 'ScheduleExpressionTimezone') as schedule_expression_timezone, - json_extract_path_text(Properties, 'StartWindowHours') as start_window_hours, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Backup::RestoreTestingPlan' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.RestoreTestingPlanName') as restore_testing_plan_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Backup::RestoreTestingPlan' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'RecoveryPointSelection') as recovery_point_selection, + json_extract_path_text(Properties, 'RestoreTestingPlanArn') as restore_testing_plan_arn, + json_extract_path_text(Properties, 'RestoreTestingPlanName') as restore_testing_plan_name, + json_extract_path_text(Properties, 'ScheduleExpression') as schedule_expression, + json_extract_path_text(Properties, 'ScheduleExpressionTimezone') as schedule_expression_timezone, + json_extract_path_text(Properties, 'StartWindowHours') as start_window_hours, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Backup::RestoreTestingPlan' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'RestoreTestingPlanName') as restore_testing_plan_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Backup::RestoreTestingPlan' + AND region = 'us-east-1' restore_testing_selections: name: restore_testing_selections id: aws.backup.restore_testing_selections @@ -2251,7 +2179,7 @@ components: x-identifiers: - RestoreTestingPlanName - RestoreTestingSelectionName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2268,9 +2196,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2280,44 +2208,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/restore_testing_selections/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/restore_testing_selections/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.RestoreTestingPlanName') as restore_testing_plan_name, - JSON_EXTRACT(Properties, '$.RestoreTestingSelectionName') as restore_testing_selection_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Backup::RestoreTestingSelection' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'RestoreTestingPlanName') as restore_testing_plan_name, - json_extract_path_text(Properties, 'RestoreTestingSelectionName') as restore_testing_selection_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Backup::RestoreTestingSelection' - AND region = 'us-east-1' - restore_testing_selection: - name: restore_testing_selection - id: aws.backup.restore_testing_selection - x-cfn-schema-name: RestoreTestingSelection - x-cfn-type-name: AWS::Backup::RestoreTestingSelection - x-identifiers: - - RestoreTestingPlanName - - RestoreTestingSelectionName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2328,12 +2221,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/restore_testing_selections/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/restore_testing_selections/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/restore_testing_selection/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/restore_testing_selections/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2350,22 +2247,40 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'IamRoleArn') as iam_role_arn, - json_extract_path_text(Properties, 'ProtectedResourceArns') as protected_resource_arns, - json_extract_path_text(Properties, 'ProtectedResourceConditions') as protected_resource_conditions, - json_extract_path_text(Properties, 'ProtectedResourceType') as protected_resource_type, - json_extract_path_text(Properties, 'RestoreMetadataOverrides') as restore_metadata_overrides, - json_extract_path_text(Properties, 'RestoreTestingPlanName') as restore_testing_plan_name, - json_extract_path_text(Properties, 'RestoreTestingSelectionName') as restore_testing_selection_name, - json_extract_path_text(Properties, 'ValidationWindowHours') as validation_window_hours - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Backup::RestoreTestingSelection' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.RestoreTestingPlanName') as restore_testing_plan_name, + JSON_EXTRACT(Properties, '$.RestoreTestingSelectionName') as restore_testing_selection_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Backup::RestoreTestingSelection' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'IamRoleArn') as iam_role_arn, + json_extract_path_text(Properties, 'ProtectedResourceArns') as protected_resource_arns, + json_extract_path_text(Properties, 'ProtectedResourceConditions') as protected_resource_conditions, + json_extract_path_text(Properties, 'ProtectedResourceType') as protected_resource_type, + json_extract_path_text(Properties, 'RestoreMetadataOverrides') as restore_metadata_overrides, + json_extract_path_text(Properties, 'RestoreTestingPlanName') as restore_testing_plan_name, + json_extract_path_text(Properties, 'RestoreTestingSelectionName') as restore_testing_selection_name, + json_extract_path_text(Properties, 'ValidationWindowHours') as validation_window_hours + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Backup::RestoreTestingSelection' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'RestoreTestingPlanName') as restore_testing_plan_name, + json_extract_path_text(Properties, 'RestoreTestingSelectionName') as restore_testing_selection_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Backup::RestoreTestingSelection' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/backupgateway.yaml b/providers/src/aws/v00.00.00000/services/backupgateway.yaml index b522349f..c926a1c9 100644 --- a/providers/src/aws/v00.00.00000/services/backupgateway.yaml +++ b/providers/src/aws/v00.00.00000/services/backupgateway.yaml @@ -576,7 +576,7 @@ components: x-cfn-type-name: AWS::BackupGateway::Hypervisor x-identifiers: - HypervisorArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -593,9 +593,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -605,41 +605,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/hypervisors/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/hypervisors/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.HypervisorArn') as hypervisor_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::BackupGateway::Hypervisor' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'HypervisorArn') as hypervisor_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::BackupGateway::Hypervisor' - AND region = 'us-east-1' - hypervisor: - name: hypervisor - id: aws.backupgateway.hypervisor - x-cfn-schema-name: Hypervisor - x-cfn-type-name: AWS::BackupGateway::Hypervisor - x-identifiers: - - HypervisorArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -650,12 +618,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/hypervisors/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/hypervisors/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/hypervisor/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/hypervisors/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -672,22 +644,38 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Host') as host, - json_extract_path_text(Properties, 'HypervisorArn') as hypervisor_arn, - json_extract_path_text(Properties, 'KmsKeyArn') as kms_key_arn, - json_extract_path_text(Properties, 'LogGroupArn') as log_group_arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Password') as password, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Username') as username - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::BackupGateway::Hypervisor' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.HypervisorArn') as hypervisor_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::BackupGateway::Hypervisor' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Host') as host, + json_extract_path_text(Properties, 'HypervisorArn') as hypervisor_arn, + json_extract_path_text(Properties, 'KmsKeyArn') as kms_key_arn, + json_extract_path_text(Properties, 'LogGroupArn') as log_group_arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Password') as password, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Username') as username + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::BackupGateway::Hypervisor' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'HypervisorArn') as hypervisor_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::BackupGateway::Hypervisor' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/batch.yaml b/providers/src/aws/v00.00.00000/services/batch.yaml index ae9b7d3c..06f23339 100644 --- a/providers/src/aws/v00.00.00000/services/batch.yaml +++ b/providers/src/aws/v00.00.00000/services/batch.yaml @@ -937,7 +937,7 @@ components: x-cfn-type-name: AWS::Batch::ComputeEnvironment x-identifiers: - ComputeEnvironmentArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -954,9 +954,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -966,41 +966,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/compute_environments/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/compute_environments/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ComputeEnvironmentArn') as compute_environment_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Batch::ComputeEnvironment' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ComputeEnvironmentArn') as compute_environment_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Batch::ComputeEnvironment' - AND region = 'us-east-1' - compute_environment: - name: compute_environment - id: aws.batch.compute_environment - x-cfn-schema-name: ComputeEnvironment - x-cfn-type-name: AWS::Batch::ComputeEnvironment - x-identifiers: - - ComputeEnvironmentArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1011,12 +979,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/compute_environments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/compute_environments/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/compute_environment/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/compute_environments/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1036,25 +1008,41 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ComputeEnvironmentArn') as compute_environment_arn, - json_extract_path_text(Properties, 'ComputeEnvironmentName') as compute_environment_name, - json_extract_path_text(Properties, 'ComputeResources') as compute_resources, - json_extract_path_text(Properties, 'ReplaceComputeEnvironment') as replace_compute_environment, - json_extract_path_text(Properties, 'ServiceRole') as service_role, - json_extract_path_text(Properties, 'State') as state, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Type') as type, - json_extract_path_text(Properties, 'UpdatePolicy') as update_policy, - json_extract_path_text(Properties, 'UnmanagedvCpus') as unmanagedv_cpus, - json_extract_path_text(Properties, 'EksConfiguration') as eks_configuration - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Batch::ComputeEnvironment' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ComputeEnvironmentArn') as compute_environment_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Batch::ComputeEnvironment' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ComputeEnvironmentArn') as compute_environment_arn, + json_extract_path_text(Properties, 'ComputeEnvironmentName') as compute_environment_name, + json_extract_path_text(Properties, 'ComputeResources') as compute_resources, + json_extract_path_text(Properties, 'ReplaceComputeEnvironment') as replace_compute_environment, + json_extract_path_text(Properties, 'ServiceRole') as service_role, + json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'UpdatePolicy') as update_policy, + json_extract_path_text(Properties, 'UnmanagedvCpus') as unmanagedv_cpus, + json_extract_path_text(Properties, 'EksConfiguration') as eks_configuration + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Batch::ComputeEnvironment' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ComputeEnvironmentArn') as compute_environment_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Batch::ComputeEnvironment' + AND region = 'us-east-1' job_queues: name: job_queues id: aws.batch.job_queues @@ -1062,7 +1050,7 @@ components: x-cfn-type-name: AWS::Batch::JobQueue x-identifiers: - JobQueueArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1079,9 +1067,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1091,41 +1079,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/job_queues/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/job_queues/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.JobQueueArn') as job_queue_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Batch::JobQueue' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'JobQueueArn') as job_queue_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Batch::JobQueue' - AND region = 'us-east-1' - job_queue: - name: job_queue - id: aws.batch.job_queue - x-cfn-schema-name: JobQueue - x-cfn-type-name: AWS::Batch::JobQueue - x-identifiers: - - JobQueueArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1136,12 +1092,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/job_queues/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/job_queues/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/job_queue/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/job_queues/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1158,22 +1118,38 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'JobQueueName') as job_queue_name, - json_extract_path_text(Properties, 'JobQueueArn') as job_queue_arn, - json_extract_path_text(Properties, 'ComputeEnvironmentOrder') as compute_environment_order, - json_extract_path_text(Properties, 'JobStateTimeLimitActions') as job_state_time_limit_actions, - json_extract_path_text(Properties, 'Priority') as priority, - json_extract_path_text(Properties, 'State') as state, - json_extract_path_text(Properties, 'SchedulingPolicyArn') as scheduling_policy_arn, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Batch::JobQueue' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.JobQueueArn') as job_queue_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Batch::JobQueue' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'JobQueueName') as job_queue_name, + json_extract_path_text(Properties, 'JobQueueArn') as job_queue_arn, + json_extract_path_text(Properties, 'ComputeEnvironmentOrder') as compute_environment_order, + json_extract_path_text(Properties, 'JobStateTimeLimitActions') as job_state_time_limit_actions, + json_extract_path_text(Properties, 'Priority') as priority, + json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'SchedulingPolicyArn') as scheduling_policy_arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Batch::JobQueue' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'JobQueueArn') as job_queue_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Batch::JobQueue' + AND region = 'us-east-1' scheduling_policies: name: scheduling_policies id: aws.batch.scheduling_policies @@ -1181,7 +1157,7 @@ components: x-cfn-type-name: AWS::Batch::SchedulingPolicy x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1198,9 +1174,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1210,41 +1186,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/scheduling_policies/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/scheduling_policies/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Batch::SchedulingPolicy' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Batch::SchedulingPolicy' - AND region = 'us-east-1' - scheduling_policy: - name: scheduling_policy - id: aws.batch.scheduling_policy - x-cfn-schema-name: SchedulingPolicy - x-cfn-type-name: AWS::Batch::SchedulingPolicy - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1255,12 +1199,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/scheduling_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/scheduling_policies/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/scheduling_policy/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/scheduling_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1273,18 +1221,34 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'FairsharePolicy') as fairshare_policy, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Batch::SchedulingPolicy' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Batch::SchedulingPolicy' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'FairsharePolicy') as fairshare_policy, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Batch::SchedulingPolicy' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Batch::SchedulingPolicy' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/bcmdataexports.yaml b/providers/src/aws/v00.00.00000/services/bcmdataexports.yaml index 2d00ca06..a21c822d 100644 --- a/providers/src/aws/v00.00.00000/services/bcmdataexports.yaml +++ b/providers/src/aws/v00.00.00000/services/bcmdataexports.yaml @@ -613,7 +613,7 @@ components: x-cfn-type-name: AWS::BCMDataExports::Export x-identifiers: - ExportArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -630,9 +630,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -642,41 +642,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/exports/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/exports/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ExportArn') as export_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::BCMDataExports::Export' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ExportArn') as export_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::BCMDataExports::Export' - AND region = 'us-east-1' - export: - name: export - id: aws.bcmdataexports.export - x-cfn-schema-name: Export - x-cfn-type-name: AWS::BCMDataExports::Export - x-identifiers: - - ExportArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -687,12 +655,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/exports/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/exports/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/export/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/exports/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -704,17 +676,33 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Export') as export, - json_extract_path_text(Properties, 'ExportArn') as export_arn, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::BCMDataExports::Export' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ExportArn') as export_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::BCMDataExports::Export' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Export') as export, + json_extract_path_text(Properties, 'ExportArn') as export_arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::BCMDataExports::Export' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ExportArn') as export_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::BCMDataExports::Export' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/bedrock.yaml b/providers/src/aws/v00.00.00000/services/bedrock.yaml index f61cdaf7..e2e6b397 100644 --- a/providers/src/aws/v00.00.00000/services/bedrock.yaml +++ b/providers/src/aws/v00.00.00000/services/bedrock.yaml @@ -406,17 +406,27 @@ components: - Payload additionalProperties: false ActionGroupExecutor: - type: object - x-title: Lambda - properties: - Lambda: - type: string - maxLength: 2048 - pattern: ^arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_\.]+(:(\$LATEST|[a-zA-Z0-9-_]+))?$ - description: ARN of a Lambda. - required: - - Lambda - additionalProperties: false + description: Type of Executors for an Action Group + oneOf: + - type: object + title: Lambda + properties: + Lambda: + type: string + maxLength: 2048 + pattern: ^arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_\.]+(:(\$LATEST|[a-zA-Z0-9-_]+))?$ + description: ARN of a Lambda. + required: + - Lambda + additionalProperties: false + - type: object + title: CustomControl + properties: + CustomControl: + $ref: '#/components/schemas/CustomControlMethod' + required: + - CustomControl + additionalProperties: false ActionGroupSignature: type: string description: Action Group Signature for a BuiltIn Action @@ -449,6 +459,8 @@ components: $ref: '#/components/schemas/APISchema' ActionGroupState: $ref: '#/components/schemas/ActionGroupState' + FunctionSchema: + $ref: '#/components/schemas/FunctionSchema' SkipResourceInUseCheckOnDelete: description: Specifies whether to allow deleting action group while it is in use. type: boolean @@ -493,6 +505,43 @@ components: enum: - DEFAULT - OVERRIDDEN + CustomControlMethod: + type: string + description: Custom control of action execution + enum: + - RETURN_CONTROL + Function: + type: object + description: Function definition + properties: + Name: + type: string + pattern: ^([0-9a-zA-Z][_-]?){1,100}$ + description: Name for a resource. + Description: + type: string + maxLength: 1200 + minLength: 1 + description: Description of function + Parameters: + $ref: '#/components/schemas/ParameterMap' + required: + - Name + additionalProperties: false + FunctionSchema: + description: Schema of Functions + type: object + x-title: Functions + properties: + Functions: + type: array + items: + $ref: '#/components/schemas/Function' + description: List of Function definitions + x-insertionOrder: false + required: + - Functions + additionalProperties: false InferenceConfiguration: type: object description: Configuration for inference in prompt configuration @@ -532,6 +581,30 @@ components: enum: - ENABLED - DISABLED + ParameterDetail: + type: object + description: Parameter detail + properties: + Description: + type: string + maxLength: 500 + minLength: 1 + description: Description of function parameter. + Type: + $ref: '#/components/schemas/Type' + Required: + type: boolean + description: Information about if a parameter is required for function call. Default to false. + required: + - Type + additionalProperties: false + ParameterMap: + type: object + description: A map of parameter name and detail + x-patternProperties: + ^([0-9a-zA-Z][_-]?){1,100}$: + $ref: '#/components/schemas/ParameterDetail' + additionalProperties: false PromptConfiguration: type: object description: BasePromptConfiguration per Prompt Type. @@ -613,6 +686,15 @@ components: pattern: ^[a-zA-Z0-9\s._:/=+@-]*$ description: Value of a tag additionalProperties: false + Type: + type: string + description: Parameter Type + enum: + - string + - number + - integer + - boolean + - array Agent: type: object properties: @@ -638,7 +720,6 @@ components: AgentResourceRoleArn: type: string maxLength: 2048 - pattern: ^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/(service-role/)?AmazonBedrockExecutionRoleForAgents.+$ description: ARN of a IAM role. AgentStatus: $ref: '#/components/schemas/AgentStatus' @@ -693,8 +774,8 @@ components: description: Max Session Time. Instruction: type: string - maxLength: 1200 minLength: 40 + maxLength: 4000 description: Instruction for the agent. KnowledgeBases: type: array @@ -719,6 +800,8 @@ components: x-insertionOrder: false Tags: $ref: '#/components/schemas/TagsMap' + TestAliasTags: + $ref: '#/components/schemas/TagsMap' UpdatedAt: type: string description: Time Stamp. @@ -974,11 +1057,18 @@ components: enum: - AVAILABLE - DELETING + - DELETE_UNSUCCESSFUL DataSourceType: type: string description: The type of the data source location. enum: - S3 + DataDeletionPolicy: + type: string + description: The deletion policy for the data source. + enum: + - RETAIN + - DELETE FixedSizeChunkingConfiguration: type: object description: Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE, exclude this field. @@ -1017,6 +1107,12 @@ components: minItems: 1 description: A list of S3 prefixes that define the object containing the data sources. x-insertionOrder: false + BucketOwnerAccountId: + type: string + maxLength: 12 + minLength: 12 + pattern: ^[0-9]{12}$ + description: The account ID for the owner of the S3 bucket. required: - BucketArn additionalProperties: false @@ -1066,12 +1162,23 @@ components: $ref: '#/components/schemas/ServerSideEncryptionConfiguration' VectorIngestionConfiguration: $ref: '#/components/schemas/VectorIngestionConfiguration' + DataDeletionPolicy: + $ref: '#/components/schemas/DataDeletionPolicy' CreatedAt: type: string description: The time at which the data source was created. UpdatedAt: type: string description: The time at which the knowledge base was last updated. + FailureReasons: + type: array + items: + type: string + maxLength: 2048 + description: Failure Reason for Error. + maxItems: 2048 + description: The details of the failure reasons related to the data source. + x-insertionOrder: false required: - DataSourceConfiguration - Name @@ -1090,6 +1197,7 @@ components: - DataSourceStatus - CreatedAt - UpdatedAt + - FailureReasons x-required-properties: - DataSourceConfiguration - Name @@ -1112,172 +1220,710 @@ components: - bedrock:DeleteDataSource list: - bedrock:ListDataSources - KnowledgeBaseConfiguration: + ContentFilter: type: object - description: Contains details about the embeddings model used for the knowledge base. + description: Content filter in content policy. properties: Type: - $ref: '#/components/schemas/KnowledgeBaseType' - VectorKnowledgeBaseConfiguration: - $ref: '#/components/schemas/VectorKnowledgeBaseConfiguration' + $ref: '#/components/schemas/ContentFilterType' + InputStrength: + $ref: '#/components/schemas/FilterStrength' + OutputStrength: + $ref: '#/components/schemas/FilterStrength' required: + - InputStrength + - OutputStrength - Type - - VectorKnowledgeBaseConfiguration additionalProperties: false - KnowledgeBaseStatus: + ContentFilterConfig: + type: object + description: Content filter config in content policy. + properties: + Type: + $ref: '#/components/schemas/ContentFilterType' + InputStrength: + $ref: '#/components/schemas/FilterStrength' + OutputStrength: + $ref: '#/components/schemas/FilterStrength' + required: + - InputStrength + - OutputStrength + - Type + additionalProperties: false + ContentFilterType: type: string - description: The status of a knowledge base. + description: Type of filter in content policy + enum: + - SEXUAL + - VIOLENCE + - HATE + - INSULTS + - MISCONDUCT + - PROMPT_ATTACK + ContentPolicyConfig: + type: object + description: Content policy config for a guardrail. + properties: + FiltersConfig: + type: array + items: + $ref: '#/components/schemas/ContentFilterConfig' + maxItems: 6 + minItems: 1 + description: List of content filter configs in content policy. + required: + - FiltersConfig + additionalProperties: false + FilterStrength: + type: string + description: Strength for filters + enum: + - NONE + - LOW + - MEDIUM + - HIGH + GuardrailStatus: + type: string + description: Status of the guardrail enum: - CREATING - - ACTIVE - - DELETING - UPDATING + - VERSIONING + - READY - FAILED - KnowledgeBaseStorageType: - type: string - description: The storage type of a knowledge base. - enum: - - OPENSEARCH_SERVERLESS - - PINECONE - - RDS - KnowledgeBaseType: + - DELETING + ManagedWords: + type: object + description: A managed words definition. + properties: + Type: + $ref: '#/components/schemas/ManagedWordsType' + required: + - Type + additionalProperties: false + ManagedWordsConfig: + type: object + description: A managed words config. + properties: + Type: + $ref: '#/components/schemas/ManagedWordsType' + required: + - Type + additionalProperties: false + ManagedWordsType: type: string - description: The type of a knowledge base. + description: Options for managed words. enum: - - VECTOR - OpenSearchServerlessConfiguration: + - PROFANITY + PiiEntity: type: object - description: Contains the storage configuration of the knowledge base in Amazon OpenSearch Service. + description: Entity name and behavior. properties: - CollectionArn: - type: string - maxLength: 2048 - pattern: ^arn:aws:aoss:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:collection/[a-z0-9-]{3,32}$ - description: The ARN of the OpenSearch Service vector store. - VectorIndexName: - type: string - maxLength: 2048 - pattern: ^.*$ - description: The name of the vector store. - FieldMapping: - $ref: '#/components/schemas/OpenSearchServerlessFieldMapping' + Type: + $ref: '#/components/schemas/PiiEntityType' + Action: + $ref: '#/components/schemas/SensitiveInformationAction' required: - - CollectionArn - - FieldMapping - - VectorIndexName + - Action + - Type additionalProperties: false - OpenSearchServerlessFieldMapping: + PiiEntityConfig: type: object - description: A mapping of Bedrock Knowledge Base fields to OpenSearch Serverless field names + description: Pii entity configuration. properties: - VectorField: - type: string - maxLength: 2048 - pattern: ^.*$ - description: The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources. - TextField: - type: string - maxLength: 2048 - pattern: ^.*$ - description: The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose. - MetadataField: - type: string - maxLength: 2048 - pattern: ^.*$ - description: The name of the field in which Amazon Bedrock stores metadata about the vector store. + Type: + $ref: '#/components/schemas/PiiEntityType' + Action: + $ref: '#/components/schemas/SensitiveInformationAction' required: - - MetadataField - - TextField - - VectorField + - Action + - Type additionalProperties: false - PineconeConfiguration: + PiiEntityType: + type: string + description: The currently supported PII entities + enum: + - ADDRESS + - AGE + - AWS_ACCESS_KEY + - AWS_SECRET_KEY + - CA_HEALTH_NUMBER + - CA_SOCIAL_INSURANCE_NUMBER + - CREDIT_DEBIT_CARD_CVV + - CREDIT_DEBIT_CARD_EXPIRY + - CREDIT_DEBIT_CARD_NUMBER + - DRIVER_ID + - EMAIL + - INTERNATIONAL_BANK_ACCOUNT_NUMBER + - IP_ADDRESS + - LICENSE_PLATE + - MAC_ADDRESS + - NAME + - PASSWORD + - PHONE + - PIN + - SWIFT_CODE + - UK_NATIONAL_HEALTH_SERVICE_NUMBER + - UK_NATIONAL_INSURANCE_NUMBER + - UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER + - URL + - USERNAME + - US_BANK_ACCOUNT_NUMBER + - US_BANK_ROUTING_NUMBER + - US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER + - US_PASSPORT_NUMBER + - US_SOCIAL_SECURITY_NUMBER + - VEHICLE_IDENTIFICATION_NUMBER + RegexConfig: type: object - description: Contains the storage configuration of the knowledge base in Pinecone. + description: A regex configuration. properties: - ConnectionString: + Name: type: string - maxLength: 2048 - pattern: ^.*$ - description: The endpoint URL for your index management page. - CredentialsSecretArn: + maxLength: 100 + minLength: 1 + description: The regex name. + Description: type: string - pattern: ^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}$ - description: The ARN of the secret that you created in AWS Secrets Manager that is linked to your Pinecone API key. - Namespace: + maxLength: 1000 + minLength: 1 + description: The regex description. + Pattern: type: string - maxLength: 2048 - pattern: ^.*$ - description: The namespace to be used to write new data to your database. - FieldMapping: - $ref: '#/components/schemas/PineconeFieldMapping' + minLength: 1 + description: The regex pattern. + Action: + $ref: '#/components/schemas/SensitiveInformationAction' required: - - ConnectionString - - CredentialsSecretArn - - FieldMapping + - Action + - Name + - Pattern additionalProperties: false - PineconeFieldMapping: + SensitiveInformationAction: + type: string + description: Options for sensitive information action. + enum: + - BLOCK + - ANONYMIZE + SensitiveInformationPolicyConfig: type: object - description: Contains the names of the fields to which to map information about the vector store. + description: Sensitive information policy config for a guardrail. properties: - TextField: - type: string - maxLength: 2048 - pattern: ^.*$ - description: The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose. - MetadataField: - type: string - maxLength: 2048 - pattern: ^.*$ - description: The name of the field in which Amazon Bedrock stores metadata about the vector store. - required: - - MetadataField - - TextField + PiiEntitiesConfig: + type: array + items: + $ref: '#/components/schemas/PiiEntityConfig' + minItems: 1 + uniqueItems: true + description: List of entities. + RegexesConfig: + type: array + items: + $ref: '#/components/schemas/RegexConfig' + minItems: 1 + description: List of regex. additionalProperties: false - RdsConfiguration: + Tag: type: object - description: Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS. + description: Definition of the key/value pair for a tag properties: - ResourceArn: - type: string - pattern: ^arn:aws(|-cn|-us-gov):rds:[a-zA-Z0-9-]*:[0-9]{12}:cluster:[a-zA-Z0-9-]{1,63}$ - description: The ARN of the vector store. - CredentialsSecretArn: - type: string - pattern: ^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}$ - description: The ARN of the secret that you created in AWS Secrets Manager that is linked to your Amazon RDS database. - DatabaseName: + Key: type: string - maxLength: 63 - pattern: ^[a-zA-Z0-9_\-]+$ - description: The name of your Amazon RDS database. - TableName: + maxLength: 128 + minLength: 1 + pattern: ^[a-zA-Z0-9\s._:/=+@-]*$ + description: Tag Key + Value: type: string - maxLength: 63 - pattern: ^[a-zA-Z0-9_\.\-]+$ - description: The name of the table in the database. - FieldMapping: - $ref: '#/components/schemas/RdsFieldMapping' + maxLength: 256 + minLength: 0 + pattern: ^[a-zA-Z0-9\s._:/=+@-]*$ + description: Tag Value required: - - CredentialsSecretArn - - DatabaseName - - FieldMapping - - ResourceArn - - TableName + - Key + - Value additionalProperties: false - RdsFieldMapping: + Topic: type: object - description: Contains the names of the fields to which to map information about the vector store. + description: Topic in topic policy. properties: - PrimaryKeyField: + Name: type: string - maxLength: 63 - pattern: ^[a-zA-Z0-9_\-]+$ - description: The name of the field in which Amazon Bedrock stores the ID for each entry. - VectorField: + maxLength: 100 + minLength: 1 + pattern: ^[0-9a-zA-Z-_ !?.]+$ + description: Name of topic in topic policy + Definition: type: string - maxLength: 63 - pattern: ^[a-zA-Z0-9_\-]+$ - description: The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources. + maxLength: 200 + minLength: 1 + description: Definition of topic in topic policy + Examples: + type: array + items: + type: string + maxLength: 100 + minLength: 1 + description: Text example in topic policy + minItems: 0 + description: List of text examples + Type: + $ref: '#/components/schemas/TopicType' + required: + - Definition + - Name + - Type + additionalProperties: false + TopicConfig: + type: object + description: Topic config in topic policy. + properties: + Name: + type: string + maxLength: 100 + minLength: 1 + pattern: ^[0-9a-zA-Z-_ !?.]+$ + description: Name of topic in topic policy + Definition: + type: string + maxLength: 200 + minLength: 1 + description: Definition of topic in topic policy + Examples: + type: array + items: + type: string + maxLength: 100 + minLength: 1 + description: Text example in topic policy + minItems: 0 + description: List of text examples + Type: + $ref: '#/components/schemas/TopicType' + required: + - Definition + - Name + - Type + additionalProperties: false + TopicPolicyConfig: + type: object + description: Topic policy config for a guardrail. + properties: + TopicsConfig: + type: array + items: + $ref: '#/components/schemas/TopicConfig' + minItems: 1 + description: List of topic configs in topic policy. + required: + - TopicsConfig + additionalProperties: false + TopicType: + type: string + description: Type of topic in a policy + enum: + - DENY + WordConfig: + type: object + description: A custom word config. + properties: + Text: + type: string + minLength: 1 + description: The custom word text. + required: + - Text + additionalProperties: false + WordPolicyConfig: + type: object + description: Word policy config for a guardrail. + properties: + WordsConfig: + type: array + items: + $ref: '#/components/schemas/WordConfig' + minItems: 1 + description: List of custom word configs. + ManagedWordListsConfig: + type: array + items: + $ref: '#/components/schemas/ManagedWordsConfig' + description: A config for the list of managed words. + additionalProperties: false + Guardrail: + type: object + properties: + BlockedInputMessaging: + type: string + maxLength: 500 + minLength: 1 + description: Messaging for when violations are detected in text + BlockedOutputsMessaging: + type: string + maxLength: 500 + minLength: 1 + description: Messaging for when violations are detected in text + ContentPolicyConfig: + $ref: '#/components/schemas/ContentPolicyConfig' + CreatedAt: + type: string + description: Time Stamp + format: date-time + Description: + type: string + maxLength: 200 + minLength: 1 + description: Description of the guardrail or its version + FailureRecommendations: + type: array + items: + type: string + maxLength: 200 + minLength: 1 + description: Recommendation for guardrail failure status + maxItems: 100 + description: List of failure recommendations + GuardrailArn: + type: string + maxLength: 2048 + pattern: ^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+$ + description: Arn representation for the guardrail + GuardrailId: + type: string + maxLength: 64 + pattern: ^[a-z0-9]+$ + description: Unique id for the guardrail + KmsKeyArn: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$ + description: The KMS key with which the guardrail was encrypted at rest + Name: + type: string + maxLength: 50 + minLength: 1 + pattern: ^[0-9a-zA-Z-_]+$ + description: Name of the guardrail + SensitiveInformationPolicyConfig: + $ref: '#/components/schemas/SensitiveInformationPolicyConfig' + Status: + $ref: '#/components/schemas/GuardrailStatus' + StatusReasons: + type: array + items: + type: string + maxLength: 200 + minLength: 1 + description: Reason for guardrail status + maxItems: 100 + description: List of status reasons + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + description: List of Tags + TopicPolicyConfig: + $ref: '#/components/schemas/TopicPolicyConfig' + UpdatedAt: + type: string + description: Time Stamp + format: date-time + Version: + type: string + pattern: ^(([1-9][0-9]{0,7})|(DRAFT))$ + description: Guardrail version + WordPolicyConfig: + $ref: '#/components/schemas/WordPolicyConfig' + required: + - Name + - BlockedInputMessaging + - BlockedOutputsMessaging + x-stackql-resource-name: guardrail + description: Definition of AWS::Bedrock::Guardrail Resource Type + x-type-name: AWS::Bedrock::Guardrail + x-stackql-primary-identifier: + - GuardrailArn + x-read-only-properties: + - CreatedAt + - FailureRecommendations + - GuardrailArn + - GuardrailId + - Status + - StatusReasons + - UpdatedAt + - Version + x-required-properties: + - Name + - BlockedInputMessaging + - BlockedOutputsMessaging + x-tagging: + cloudFormationSystemTags: false + tagOnCreate: true + tagProperty: /properties/Tags + tagUpdatable: true + taggable: true + x-required-permissions: + create: + - bedrock:CreateGuardrail + - bedrock:GetGuardrail + - kms:DescribeKey + - kms:CreateGrant + - kms:GenerateDataKey + - kms:Decrypt + - bedrock:TagResource + - bedrock:ListTagsForResource + read: + - bedrock:GetGuardrail + - kms:Decrypt + - bedrock:ListTagsForResource + update: + - bedrock:UpdateGuardrail + - bedrock:GetGuardrail + - bedrock:ListTagsForResource + - bedrock:TagResource + - bedrock:UntagResource + - kms:DescribeKey + - kms:CreateGrant + - kms:GenerateDataKey + - kms:Decrypt + delete: + - bedrock:DeleteGuardrail + - bedrock:GetGuardrail + - kms:Decrypt + - kms:RetireGrant + list: + - bedrock:ListGuardrails + GuardrailVersion: + type: object + properties: + Description: + type: string + maxLength: 200 + minLength: 1 + description: Description of the Guardrail version + GuardrailArn: + type: string + maxLength: 2048 + pattern: ^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+$ + description: Arn representation for the guardrail + GuardrailId: + type: string + maxLength: 64 + pattern: ^[a-z0-9]+$ + description: Unique id for the guardrail + GuardrailIdentifier: + type: string + maxLength: 2048 + pattern: ^(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))$ + description: Identifier (GuardrailId or GuardrailArn) for the guardrail + Version: + type: string + pattern: ^[1-9][0-9]{0,7}$ + description: Guardrail version + required: + - GuardrailIdentifier + x-stackql-resource-name: guardrail_version + description: Definition of AWS::Bedrock::GuardrailVersion Resource Type + x-type-name: AWS::Bedrock::GuardrailVersion + x-stackql-primary-identifier: + - GuardrailId + - Version + x-create-only-properties: + - Description + - GuardrailIdentifier + x-write-only-properties: + - GuardrailIdentifier + x-read-only-properties: + - GuardrailArn + - GuardrailId + - Version + x-required-properties: + - GuardrailIdentifier + x-tagging: + taggable: false + x-required-permissions: + create: + - bedrock:CreateGuardrailVersion + - bedrock:GetGuardrail + - kms:CreateGrant + - kms:Decrypt + read: + - bedrock:GetGuardrail + - kms:Decrypt + delete: + - bedrock:DeleteGuardrail + - bedrock:GetGuardrail + - kms:RetireGrant + KnowledgeBaseConfiguration: + type: object + description: Contains details about the embeddings model used for the knowledge base. + properties: + Type: + $ref: '#/components/schemas/KnowledgeBaseType' + VectorKnowledgeBaseConfiguration: + $ref: '#/components/schemas/VectorKnowledgeBaseConfiguration' + required: + - Type + - VectorKnowledgeBaseConfiguration + additionalProperties: false + KnowledgeBaseStatus: + type: string + description: The status of a knowledge base. + enum: + - CREATING + - ACTIVE + - DELETING + - UPDATING + - FAILED + - DELETE_UNSUCCESSFUL + KnowledgeBaseStorageType: + type: string + description: The storage type of a knowledge base. + enum: + - OPENSEARCH_SERVERLESS + - PINECONE + - RDS + KnowledgeBaseType: + type: string + description: The type of a knowledge base. + enum: + - VECTOR + OpenSearchServerlessConfiguration: + type: object + description: Contains the storage configuration of the knowledge base in Amazon OpenSearch Service. + properties: + CollectionArn: + type: string + maxLength: 2048 + pattern: ^arn:aws:aoss:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:collection/[a-z0-9-]{3,32}$ + description: The ARN of the OpenSearch Service vector store. + VectorIndexName: + type: string + maxLength: 2048 + pattern: ^.*$ + description: The name of the vector store. + FieldMapping: + $ref: '#/components/schemas/OpenSearchServerlessFieldMapping' + required: + - CollectionArn + - FieldMapping + - VectorIndexName + additionalProperties: false + OpenSearchServerlessFieldMapping: + type: object + description: A mapping of Bedrock Knowledge Base fields to OpenSearch Serverless field names + properties: + VectorField: + type: string + maxLength: 2048 + pattern: ^.*$ + description: The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources. + TextField: + type: string + maxLength: 2048 + pattern: ^.*$ + description: The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose. + MetadataField: + type: string + maxLength: 2048 + pattern: ^.*$ + description: The name of the field in which Amazon Bedrock stores metadata about the vector store. + required: + - MetadataField + - TextField + - VectorField + additionalProperties: false + PineconeConfiguration: + type: object + description: Contains the storage configuration of the knowledge base in Pinecone. + properties: + ConnectionString: + type: string + maxLength: 2048 + pattern: ^.*$ + description: The endpoint URL for your index management page. + CredentialsSecretArn: + type: string + pattern: ^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}$ + description: The ARN of the secret that you created in AWS Secrets Manager that is linked to your Pinecone API key. + Namespace: + type: string + maxLength: 2048 + pattern: ^.*$ + description: The namespace to be used to write new data to your database. + FieldMapping: + $ref: '#/components/schemas/PineconeFieldMapping' + required: + - ConnectionString + - CredentialsSecretArn + - FieldMapping + additionalProperties: false + PineconeFieldMapping: + type: object + description: Contains the names of the fields to which to map information about the vector store. + properties: + TextField: + type: string + maxLength: 2048 + pattern: ^.*$ + description: The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose. + MetadataField: + type: string + maxLength: 2048 + pattern: ^.*$ + description: The name of the field in which Amazon Bedrock stores metadata about the vector store. + required: + - MetadataField + - TextField + additionalProperties: false + RdsConfiguration: + type: object + description: Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS. + properties: + ResourceArn: + type: string + pattern: ^arn:aws(|-cn|-us-gov):rds:[a-zA-Z0-9-]*:[0-9]{12}:cluster:[a-zA-Z0-9-]{1,63}$ + description: The ARN of the vector store. + CredentialsSecretArn: + type: string + pattern: ^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}$ + description: The ARN of the secret that you created in AWS Secrets Manager that is linked to your Amazon RDS database. + DatabaseName: + type: string + maxLength: 63 + pattern: ^[a-zA-Z0-9_\-]+$ + description: The name of your Amazon RDS database. + TableName: + type: string + maxLength: 63 + pattern: ^[a-zA-Z0-9_\.\-]+$ + description: The name of the table in the database. + FieldMapping: + $ref: '#/components/schemas/RdsFieldMapping' + required: + - CredentialsSecretArn + - DatabaseName + - FieldMapping + - ResourceArn + - TableName + additionalProperties: false + RdsFieldMapping: + type: object + description: Contains the names of the fields to which to map information about the vector store. + properties: + PrimaryKeyField: + type: string + maxLength: 63 + pattern: ^[a-zA-Z0-9_\-]+$ + description: The name of the field in which Amazon Bedrock stores the ID for each entry. + VectorField: + type: string + maxLength: 63 + pattern: ^[a-zA-Z0-9_\-]+$ + description: The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources. TextField: type: string maxLength: 63 @@ -1520,7 +2166,6 @@ components: AgentResourceRoleArn: type: string maxLength: 2048 - pattern: ^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/(service-role/)?AmazonBedrockExecutionRoleForAgents.+$ description: ARN of a IAM role. AgentStatus: $ref: '#/components/schemas/AgentStatus' @@ -1575,8 +2220,8 @@ components: description: Max Session Time. Instruction: type: string - maxLength: 1200 minLength: 40 + maxLength: 4000 description: Instruction for the agent. KnowledgeBases: type: array @@ -1601,6 +2246,8 @@ components: x-insertionOrder: false Tags: $ref: '#/components/schemas/TagsMap' + TestAliasTags: + $ref: '#/components/schemas/TagsMap' UpdatedAt: type: string description: Time Stamp. @@ -1712,16 +2359,169 @@ components: $ref: '#/components/schemas/ServerSideEncryptionConfiguration' VectorIngestionConfiguration: $ref: '#/components/schemas/VectorIngestionConfiguration' + DataDeletionPolicy: + $ref: '#/components/schemas/DataDeletionPolicy' CreatedAt: type: string description: The time at which the data source was created. UpdatedAt: type: string description: The time at which the knowledge base was last updated. + FailureReasons: + type: array + items: + type: string + maxLength: 2048 + description: Failure Reason for Error. + maxItems: 2048 + description: The details of the failure reasons related to the data source. + x-insertionOrder: false x-stackQL-stringOnly: true x-title: CreateDataSourceRequest type: object required: [] + CreateGuardrailRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + BlockedInputMessaging: + type: string + maxLength: 500 + minLength: 1 + description: Messaging for when violations are detected in text + BlockedOutputsMessaging: + type: string + maxLength: 500 + minLength: 1 + description: Messaging for when violations are detected in text + ContentPolicyConfig: + $ref: '#/components/schemas/ContentPolicyConfig' + CreatedAt: + type: string + description: Time Stamp + format: date-time + Description: + type: string + maxLength: 200 + minLength: 1 + description: Description of the guardrail or its version + FailureRecommendations: + type: array + items: + type: string + maxLength: 200 + minLength: 1 + description: Recommendation for guardrail failure status + maxItems: 100 + description: List of failure recommendations + GuardrailArn: + type: string + maxLength: 2048 + pattern: ^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+$ + description: Arn representation for the guardrail + GuardrailId: + type: string + maxLength: 64 + pattern: ^[a-z0-9]+$ + description: Unique id for the guardrail + KmsKeyArn: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$ + description: The KMS key with which the guardrail was encrypted at rest + Name: + type: string + maxLength: 50 + minLength: 1 + pattern: ^[0-9a-zA-Z-_]+$ + description: Name of the guardrail + SensitiveInformationPolicyConfig: + $ref: '#/components/schemas/SensitiveInformationPolicyConfig' + Status: + $ref: '#/components/schemas/GuardrailStatus' + StatusReasons: + type: array + items: + type: string + maxLength: 200 + minLength: 1 + description: Reason for guardrail status + maxItems: 100 + description: List of status reasons + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + description: List of Tags + TopicPolicyConfig: + $ref: '#/components/schemas/TopicPolicyConfig' + UpdatedAt: + type: string + description: Time Stamp + format: date-time + Version: + type: string + pattern: ^(([1-9][0-9]{0,7})|(DRAFT))$ + description: Guardrail version + WordPolicyConfig: + $ref: '#/components/schemas/WordPolicyConfig' + x-stackQL-stringOnly: true + x-title: CreateGuardrailRequest + type: object + required: [] + CreateGuardrailVersionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Description: + type: string + maxLength: 200 + minLength: 1 + description: Description of the Guardrail version + GuardrailArn: + type: string + maxLength: 2048 + pattern: ^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+$ + description: Arn representation for the guardrail + GuardrailId: + type: string + maxLength: 64 + pattern: ^[a-z0-9]+$ + description: Unique id for the guardrail + GuardrailIdentifier: + type: string + maxLength: 2048 + pattern: ^(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))$ + description: Identifier (GuardrailId or GuardrailArn) for the guardrail + Version: + type: string + pattern: ^[1-9][0-9]{0,7}$ + description: Guardrail version + x-stackQL-stringOnly: true + x-title: CreateGuardrailVersionRequest + type: object + required: [] CreateKnowledgeBaseRequest: properties: ClientToken: @@ -1801,7 +2601,7 @@ components: x-cfn-type-name: AWS::Bedrock::Agent x-identifiers: - AgentId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1818,53 +2618,21 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- { "TypeName": "AWS::Bedrock::Agent" } - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/agents/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/agents/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AgentId') as agent_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Bedrock::Agent' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AgentId') as agent_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Bedrock::Agent' - AND region = 'us-east-1' - agent: - name: agent - id: aws.bedrock.agent - x-cfn-schema-name: Agent - x-cfn-type-name: AWS::Bedrock::Agent - x-identifiers: - - AgentId - x-type: get - methods: - update_resource: + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1875,12 +2643,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/agents/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/agents/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/agent/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/agents/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1906,41 +2678,59 @@ components: JSON_EXTRACT(Properties, '$.PromptOverrideConfiguration') as prompt_override_configuration, JSON_EXTRACT(Properties, '$.RecommendedActions') as recommended_actions, JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.TestAliasTags') as test_alias_tags, JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Bedrock::Agent' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ActionGroups') as action_groups, - json_extract_path_text(Properties, 'AgentArn') as agent_arn, - json_extract_path_text(Properties, 'AgentId') as agent_id, - json_extract_path_text(Properties, 'AgentName') as agent_name, - json_extract_path_text(Properties, 'AgentResourceRoleArn') as agent_resource_role_arn, - json_extract_path_text(Properties, 'AgentStatus') as agent_status, - json_extract_path_text(Properties, 'AgentVersion') as agent_version, - json_extract_path_text(Properties, 'AutoPrepare') as auto_prepare, - json_extract_path_text(Properties, 'CreatedAt') as created_at, - json_extract_path_text(Properties, 'CustomerEncryptionKeyArn') as customer_encryption_key_arn, - json_extract_path_text(Properties, 'SkipResourceInUseCheckOnDelete') as skip_resource_in_use_check_on_delete, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'FailureReasons') as failure_reasons, - json_extract_path_text(Properties, 'FoundationModel') as foundation_model, - json_extract_path_text(Properties, 'IdleSessionTTLInSeconds') as idle_session_ttl_in_seconds, - json_extract_path_text(Properties, 'Instruction') as instruction, - json_extract_path_text(Properties, 'KnowledgeBases') as knowledge_bases, - json_extract_path_text(Properties, 'PreparedAt') as prepared_at, - json_extract_path_text(Properties, 'PromptOverrideConfiguration') as prompt_override_configuration, - json_extract_path_text(Properties, 'RecommendedActions') as recommended_actions, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'UpdatedAt') as updated_at - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Bedrock::Agent' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.AgentId') as agent_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Bedrock::Agent' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ActionGroups') as action_groups, + json_extract_path_text(Properties, 'AgentArn') as agent_arn, + json_extract_path_text(Properties, 'AgentId') as agent_id, + json_extract_path_text(Properties, 'AgentName') as agent_name, + json_extract_path_text(Properties, 'AgentResourceRoleArn') as agent_resource_role_arn, + json_extract_path_text(Properties, 'AgentStatus') as agent_status, + json_extract_path_text(Properties, 'AgentVersion') as agent_version, + json_extract_path_text(Properties, 'AutoPrepare') as auto_prepare, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'CustomerEncryptionKeyArn') as customer_encryption_key_arn, + json_extract_path_text(Properties, 'SkipResourceInUseCheckOnDelete') as skip_resource_in_use_check_on_delete, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'FailureReasons') as failure_reasons, + json_extract_path_text(Properties, 'FoundationModel') as foundation_model, + json_extract_path_text(Properties, 'IdleSessionTTLInSeconds') as idle_session_ttl_in_seconds, + json_extract_path_text(Properties, 'Instruction') as instruction, + json_extract_path_text(Properties, 'KnowledgeBases') as knowledge_bases, + json_extract_path_text(Properties, 'PreparedAt') as prepared_at, + json_extract_path_text(Properties, 'PromptOverrideConfiguration') as prompt_override_configuration, + json_extract_path_text(Properties, 'RecommendedActions') as recommended_actions, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'TestAliasTags') as test_alias_tags, + json_extract_path_text(Properties, 'UpdatedAt') as updated_at + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Bedrock::Agent' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AgentId') as agent_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Bedrock::Agent' + AND region = 'us-east-1' agent_aliases: name: agent_aliases id: aws.bedrock.agent_aliases @@ -1949,7 +2739,7 @@ components: x-identifiers: - AgentId - AgentAliasId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1966,9 +2756,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1978,44 +2768,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/agent_aliases/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/agent_aliases/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AgentId') as agent_id, - JSON_EXTRACT(Properties, '$.AgentAliasId') as agent_alias_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Bedrock::AgentAlias' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AgentId') as agent_id, - json_extract_path_text(Properties, 'AgentAliasId') as agent_alias_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Bedrock::AgentAlias' - AND region = 'us-east-1' - agent_alias: - name: agent_alias - id: aws.bedrock.agent_alias - x-cfn-schema-name: AgentAlias - x-cfn-type-name: AWS::Bedrock::AgentAlias - x-identifiers: - - AgentId - - AgentAliasId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2026,12 +2781,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/agent_aliases/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/agent_aliases/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/agent_alias/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/agent_aliases/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2051,25 +2810,43 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AgentAliasArn') as agent_alias_arn, - json_extract_path_text(Properties, 'AgentAliasHistoryEvents') as agent_alias_history_events, - json_extract_path_text(Properties, 'AgentAliasId') as agent_alias_id, - json_extract_path_text(Properties, 'AgentAliasName') as agent_alias_name, - json_extract_path_text(Properties, 'AgentAliasStatus') as agent_alias_status, - json_extract_path_text(Properties, 'AgentId') as agent_id, - json_extract_path_text(Properties, 'CreatedAt') as created_at, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'RoutingConfiguration') as routing_configuration, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'UpdatedAt') as updated_at - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Bedrock::AgentAlias' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.AgentId') as agent_id, + JSON_EXTRACT(Properties, '$.AgentAliasId') as agent_alias_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Bedrock::AgentAlias' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AgentAliasArn') as agent_alias_arn, + json_extract_path_text(Properties, 'AgentAliasHistoryEvents') as agent_alias_history_events, + json_extract_path_text(Properties, 'AgentAliasId') as agent_alias_id, + json_extract_path_text(Properties, 'AgentAliasName') as agent_alias_name, + json_extract_path_text(Properties, 'AgentAliasStatus') as agent_alias_status, + json_extract_path_text(Properties, 'AgentId') as agent_id, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'RoutingConfiguration') as routing_configuration, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'UpdatedAt') as updated_at + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Bedrock::AgentAlias' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AgentId') as agent_id, + json_extract_path_text(Properties, 'AgentAliasId') as agent_alias_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Bedrock::AgentAlias' + AND region = 'us-east-1' data_sources: name: data_sources id: aws.bedrock.data_sources @@ -2078,7 +2855,7 @@ components: x-identifiers: - KnowledgeBaseId - DataSourceId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2095,6 +2872,18 @@ components: response: mediaType: application/json openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Bedrock::DataSource" + } + response: + mediaType: application/json + openAPIDocKey: '200' delete_resource: operation: $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' @@ -2112,36 +2901,94 @@ components: - $ref: '#/components/x-stackQL-resources/data_sources/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/data_sources/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/data_sources/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, + data__Identifier, + JSON_EXTRACT(Properties, '$.DataSourceConfiguration') as data_source_configuration, + JSON_EXTRACT(Properties, '$.DataSourceId') as data_source_id, + JSON_EXTRACT(Properties, '$.Description') as description, JSON_EXTRACT(Properties, '$.KnowledgeBaseId') as knowledge_base_id, - JSON_EXTRACT(Properties, '$.DataSourceId') as data_source_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Bedrock::DataSource' + JSON_EXTRACT(Properties, '$.DataSourceStatus') as data_source_status, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.ServerSideEncryptionConfiguration') as server_side_encryption_configuration, + JSON_EXTRACT(Properties, '$.VectorIngestionConfiguration') as vector_ingestion_configuration, + JSON_EXTRACT(Properties, '$.DataDeletionPolicy') as data_deletion_policy, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at, + JSON_EXTRACT(Properties, '$.FailureReasons') as failure_reasons + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Bedrock::DataSource' + AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - json_extract_path_text(Properties, 'KnowledgeBaseId') as knowledge_base_id, - json_extract_path_text(Properties, 'DataSourceId') as data_source_id + JSON_EXTRACT(Properties, '$.KnowledgeBaseId') as knowledge_base_id, + JSON_EXTRACT(Properties, '$.DataSourceId') as data_source_id FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Bedrock::DataSource' AND region = 'us-east-1' - data_source: - name: data_source - id: aws.bedrock.data_source - x-cfn-schema-name: DataSource - x-cfn-type-name: AWS::Bedrock::DataSource + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DataSourceConfiguration') as data_source_configuration, + json_extract_path_text(Properties, 'DataSourceId') as data_source_id, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'KnowledgeBaseId') as knowledge_base_id, + json_extract_path_text(Properties, 'DataSourceStatus') as data_source_status, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'ServerSideEncryptionConfiguration') as server_side_encryption_configuration, + json_extract_path_text(Properties, 'VectorIngestionConfiguration') as vector_ingestion_configuration, + json_extract_path_text(Properties, 'DataDeletionPolicy') as data_deletion_policy, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'UpdatedAt') as updated_at, + json_extract_path_text(Properties, 'FailureReasons') as failure_reasons + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Bedrock::DataSource' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'KnowledgeBaseId') as knowledge_base_id, + json_extract_path_text(Properties, 'DataSourceId') as data_source_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Bedrock::DataSource' + AND region = 'us-east-1' + guardrails: + name: guardrails + id: aws.bedrock.guardrails + x-cfn-schema-name: Guardrail + x-cfn-type-name: AWS::Bedrock::Guardrail x-identifiers: - - KnowledgeBaseId - - DataSourceId - x-type: get + - GuardrailArn + x-type: cloud_control methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Guardrail&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Bedrock::Guardrail" + } + response: + mediaType: application/json + openAPIDocKey: '200' update_resource: operation: $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' @@ -2149,74 +2996,123 @@ components: mediaType: application/x-amz-json-1.0 base: |- { - "TypeName": "AWS::Bedrock::DataSource" + "TypeName": "AWS::Bedrock::Guardrail" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Bedrock::Guardrail" } response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/guardrails/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/guardrails/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/data_source/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/guardrails/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.DataSourceConfiguration') as data_source_configuration, - JSON_EXTRACT(Properties, '$.DataSourceId') as data_source_id, + JSON_EXTRACT(Properties, '$.BlockedInputMessaging') as blocked_input_messaging, + JSON_EXTRACT(Properties, '$.BlockedOutputsMessaging') as blocked_outputs_messaging, + JSON_EXTRACT(Properties, '$.ContentPolicyConfig') as content_policy_config, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, JSON_EXTRACT(Properties, '$.Description') as description, - JSON_EXTRACT(Properties, '$.KnowledgeBaseId') as knowledge_base_id, - JSON_EXTRACT(Properties, '$.DataSourceStatus') as data_source_status, + JSON_EXTRACT(Properties, '$.FailureRecommendations') as failure_recommendations, + JSON_EXTRACT(Properties, '$.GuardrailArn') as guardrail_arn, + JSON_EXTRACT(Properties, '$.GuardrailId') as guardrail_id, + JSON_EXTRACT(Properties, '$.KmsKeyArn') as kms_key_arn, JSON_EXTRACT(Properties, '$.Name') as name, - JSON_EXTRACT(Properties, '$.ServerSideEncryptionConfiguration') as server_side_encryption_configuration, - JSON_EXTRACT(Properties, '$.VectorIngestionConfiguration') as vector_ingestion_configuration, - JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, - JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Bedrock::DataSource' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.SensitiveInformationPolicyConfig') as sensitive_information_policy_config, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.StatusReasons') as status_reasons, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.TopicPolicyConfig') as topic_policy_config, + JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at, + JSON_EXTRACT(Properties, '$.Version') as version, + JSON_EXTRACT(Properties, '$.WordPolicyConfig') as word_policy_config + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Bedrock::Guardrail' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'DataSourceConfiguration') as data_source_configuration, - json_extract_path_text(Properties, 'DataSourceId') as data_source_id, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'KnowledgeBaseId') as knowledge_base_id, - json_extract_path_text(Properties, 'DataSourceStatus') as data_source_status, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'ServerSideEncryptionConfiguration') as server_side_encryption_configuration, - json_extract_path_text(Properties, 'VectorIngestionConfiguration') as vector_ingestion_configuration, - json_extract_path_text(Properties, 'CreatedAt') as created_at, - json_extract_path_text(Properties, 'UpdatedAt') as updated_at - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Bedrock::DataSource' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.GuardrailArn') as guardrail_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Bedrock::Guardrail' AND region = 'us-east-1' - knowledge_bases: - name: knowledge_bases - id: aws.bedrock.knowledge_bases - x-cfn-schema-name: KnowledgeBase - x-cfn-type-name: AWS::Bedrock::KnowledgeBase + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'BlockedInputMessaging') as blocked_input_messaging, + json_extract_path_text(Properties, 'BlockedOutputsMessaging') as blocked_outputs_messaging, + json_extract_path_text(Properties, 'ContentPolicyConfig') as content_policy_config, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'FailureRecommendations') as failure_recommendations, + json_extract_path_text(Properties, 'GuardrailArn') as guardrail_arn, + json_extract_path_text(Properties, 'GuardrailId') as guardrail_id, + json_extract_path_text(Properties, 'KmsKeyArn') as kms_key_arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'SensitiveInformationPolicyConfig') as sensitive_information_policy_config, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'StatusReasons') as status_reasons, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'TopicPolicyConfig') as topic_policy_config, + json_extract_path_text(Properties, 'UpdatedAt') as updated_at, + json_extract_path_text(Properties, 'Version') as version, + json_extract_path_text(Properties, 'WordPolicyConfig') as word_policy_config + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Bedrock::Guardrail' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'GuardrailArn') as guardrail_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Bedrock::Guardrail' + AND region = 'us-east-1' + guardrail_versions: + name: guardrail_versions + id: aws.bedrock.guardrail_versions + x-cfn-schema-name: GuardrailVersion + x-cfn-type-name: AWS::Bedrock::GuardrailVersion x-identifiers: - - KnowledgeBaseId - x-type: list + - GuardrailId + - Version + x-type: cloud_control methods: create_resource: config: requestBodyTranslate: algorithm: naive_DesiredState operation: - $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__KnowledgeBase&__detailTransformed=true/post' + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__GuardrailVersion&__detailTransformed=true/post' request: mediaType: application/x-amz-json-1.0 base: |- { - "TypeName": "AWS::Bedrock::KnowledgeBase" + "TypeName": "AWS::Bedrock::GuardrailVersion" } response: mediaType: application/json @@ -2228,43 +3124,71 @@ components: mediaType: application/x-amz-json-1.0 base: |- { - "TypeName": "AWS::Bedrock::KnowledgeBase" + "TypeName": "AWS::Bedrock::GuardrailVersion" } response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: insert: - - $ref: '#/components/x-stackQL-resources/knowledge_bases/methods/create_resource' + - $ref: '#/components/x-stackQL-resources/guardrail_versions/methods/create_resource' delete: - - $ref: '#/components/x-stackQL-resources/knowledge_bases/methods/delete_resource' + - $ref: '#/components/x-stackQL-resources/guardrail_versions/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.KnowledgeBaseId') as knowledge_base_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Bedrock::KnowledgeBase' + data__Identifier, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.GuardrailArn') as guardrail_arn, + JSON_EXTRACT(Properties, '$.GuardrailId') as guardrail_id, + JSON_EXTRACT(Properties, '$.GuardrailIdentifier') as guardrail_identifier, + JSON_EXTRACT(Properties, '$.Version') as version + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Bedrock::GuardrailVersion' + AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, - json_extract_path_text(Properties, 'KnowledgeBaseId') as knowledge_base_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Bedrock::KnowledgeBase' + data__Identifier, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'GuardrailArn') as guardrail_arn, + json_extract_path_text(Properties, 'GuardrailId') as guardrail_id, + json_extract_path_text(Properties, 'GuardrailIdentifier') as guardrail_identifier, + json_extract_path_text(Properties, 'Version') as version + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Bedrock::GuardrailVersion' + AND data__Identifier = '|' AND region = 'us-east-1' - knowledge_base: - name: knowledge_base - id: aws.bedrock.knowledge_base + knowledge_bases: + name: knowledge_bases + id: aws.bedrock.knowledge_bases x-cfn-schema-name: KnowledgeBase x-cfn-type-name: AWS::Bedrock::KnowledgeBase x-identifiers: - KnowledgeBaseId - x-type: get + x-type: cloud_control methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__KnowledgeBase&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Bedrock::KnowledgeBase" + } + response: + mediaType: application/json + openAPIDocKey: '200' update_resource: operation: $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' @@ -2277,13 +3201,29 @@ components: response: mediaType: application/json openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Bedrock::KnowledgeBase" + } + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/knowledge_bases/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/knowledge_bases/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/knowledge_base/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/knowledge_bases/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2304,26 +3244,42 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'KnowledgeBaseConfiguration') as knowledge_base_configuration, - json_extract_path_text(Properties, 'KnowledgeBaseId') as knowledge_base_id, - json_extract_path_text(Properties, 'KnowledgeBaseArn') as knowledge_base_arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'CreatedAt') as created_at, - json_extract_path_text(Properties, 'FailureReasons') as failure_reasons, - json_extract_path_text(Properties, 'UpdatedAt') as updated_at, - json_extract_path_text(Properties, 'StorageConfiguration') as storage_configuration, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Bedrock::KnowledgeBase' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.KnowledgeBaseId') as knowledge_base_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Bedrock::KnowledgeBase' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'KnowledgeBaseConfiguration') as knowledge_base_configuration, + json_extract_path_text(Properties, 'KnowledgeBaseId') as knowledge_base_id, + json_extract_path_text(Properties, 'KnowledgeBaseArn') as knowledge_base_arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'FailureReasons') as failure_reasons, + json_extract_path_text(Properties, 'UpdatedAt') as updated_at, + json_extract_path_text(Properties, 'StorageConfiguration') as storage_configuration, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Bedrock::KnowledgeBase' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'KnowledgeBaseId') as knowledge_base_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Bedrock::KnowledgeBase' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: @@ -2593,6 +3549,90 @@ paths: schema: $ref: '#/components/x-cloud-control-schemas/ProgressEvent' description: Success + /?Action=CreateResource&Version=2021-09-30&__Guardrail&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateGuardrail + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateGuardrailRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__GuardrailVersion&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateGuardrailVersion + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateGuardrailVersionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success /?Action=CreateResource&Version=2021-09-30&__KnowledgeBase&__detailTransformed=true: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' diff --git a/providers/src/aws/v00.00.00000/services/billingconductor.yaml b/providers/src/aws/v00.00.00000/services/billingconductor.yaml index 5dbbb1e5..a4375de9 100644 --- a/providers/src/aws/v00.00.00000/services/billingconductor.yaml +++ b/providers/src/aws/v00.00.00000/services/billingconductor.yaml @@ -1250,7 +1250,7 @@ components: x-cfn-type-name: AWS::BillingConductor::BillingGroup x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1267,9 +1267,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1279,41 +1279,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/billing_groups/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/billing_groups/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::BillingConductor::BillingGroup' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::BillingConductor::BillingGroup' - AND region = 'us-east-1' - billing_group: - name: billing_group - id: aws.billingconductor.billing_group - x-cfn-schema-name: BillingGroup - x-cfn-type-name: AWS::BillingConductor::BillingGroup - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1324,12 +1292,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/billing_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/billing_groups/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/billing_group/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/billing_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1350,26 +1322,42 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'PrimaryAccountId') as primary_account_id, - json_extract_path_text(Properties, 'ComputationPreference') as computation_preference, - json_extract_path_text(Properties, 'AccountGrouping') as account_grouping, - json_extract_path_text(Properties, 'Size') as size, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'StatusReason') as status_reason, - json_extract_path_text(Properties, 'CreationTime') as creation_time, - json_extract_path_text(Properties, 'LastModifiedTime') as last_modified_time, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::BillingConductor::BillingGroup' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::BillingConductor::BillingGroup' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'PrimaryAccountId') as primary_account_id, + json_extract_path_text(Properties, 'ComputationPreference') as computation_preference, + json_extract_path_text(Properties, 'AccountGrouping') as account_grouping, + json_extract_path_text(Properties, 'Size') as size, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'StatusReason') as status_reason, + json_extract_path_text(Properties, 'CreationTime') as creation_time, + json_extract_path_text(Properties, 'LastModifiedTime') as last_modified_time, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::BillingConductor::BillingGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::BillingConductor::BillingGroup' + AND region = 'us-east-1' custom_line_items: name: custom_line_items id: aws.billingconductor.custom_line_items @@ -1377,7 +1365,7 @@ components: x-cfn-type-name: AWS::BillingConductor::CustomLineItem x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1394,9 +1382,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1406,41 +1394,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/custom_line_items/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/custom_line_items/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::BillingConductor::CustomLineItem' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::BillingConductor::CustomLineItem' - AND region = 'us-east-1' - custom_line_item: - name: custom_line_item - id: aws.billingconductor.custom_line_item - x-cfn-schema-name: CustomLineItem - x-cfn-type-name: AWS::BillingConductor::CustomLineItem - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1451,12 +1407,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/custom_line_items/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/custom_line_items/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/custom_line_item/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/custom_line_items/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1478,27 +1438,43 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'CustomLineItemChargeDetails') as custom_line_item_charge_details, - json_extract_path_text(Properties, 'BillingGroupArn') as billing_group_arn, - json_extract_path_text(Properties, 'BillingPeriodRange') as billing_period_range, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'CreationTime') as creation_time, - json_extract_path_text(Properties, 'LastModifiedTime') as last_modified_time, - json_extract_path_text(Properties, 'AssociationSize') as association_size, - json_extract_path_text(Properties, 'ProductCode') as product_code, - json_extract_path_text(Properties, 'CurrencyCode') as currency_code, - json_extract_path_text(Properties, 'AccountId') as account_id, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::BillingConductor::CustomLineItem' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::BillingConductor::CustomLineItem' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'CustomLineItemChargeDetails') as custom_line_item_charge_details, + json_extract_path_text(Properties, 'BillingGroupArn') as billing_group_arn, + json_extract_path_text(Properties, 'BillingPeriodRange') as billing_period_range, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'CreationTime') as creation_time, + json_extract_path_text(Properties, 'LastModifiedTime') as last_modified_time, + json_extract_path_text(Properties, 'AssociationSize') as association_size, + json_extract_path_text(Properties, 'ProductCode') as product_code, + json_extract_path_text(Properties, 'CurrencyCode') as currency_code, + json_extract_path_text(Properties, 'AccountId') as account_id, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::BillingConductor::CustomLineItem' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::BillingConductor::CustomLineItem' + AND region = 'us-east-1' pricing_plans: name: pricing_plans id: aws.billingconductor.pricing_plans @@ -1506,7 +1482,7 @@ components: x-cfn-type-name: AWS::BillingConductor::PricingPlan x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1523,9 +1499,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1535,41 +1511,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/pricing_plans/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/pricing_plans/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::BillingConductor::PricingPlan' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::BillingConductor::PricingPlan' - AND region = 'us-east-1' - pricing_plan: - name: pricing_plan - id: aws.billingconductor.pricing_plan - x-cfn-schema-name: PricingPlan - x-cfn-type-name: AWS::BillingConductor::PricingPlan - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1580,12 +1524,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/pricing_plans/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/pricing_plans/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/pricing_plan/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/pricing_plans/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1602,22 +1550,38 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'PricingRuleArns') as pricing_rule_arns, - json_extract_path_text(Properties, 'Size') as size, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'CreationTime') as creation_time, - json_extract_path_text(Properties, 'LastModifiedTime') as last_modified_time, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::BillingConductor::PricingPlan' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::BillingConductor::PricingPlan' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'PricingRuleArns') as pricing_rule_arns, + json_extract_path_text(Properties, 'Size') as size, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'CreationTime') as creation_time, + json_extract_path_text(Properties, 'LastModifiedTime') as last_modified_time, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::BillingConductor::PricingPlan' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::BillingConductor::PricingPlan' + AND region = 'us-east-1' pricing_rules: name: pricing_rules id: aws.billingconductor.pricing_rules @@ -1625,7 +1589,7 @@ components: x-cfn-type-name: AWS::BillingConductor::PricingRule x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1642,9 +1606,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1654,41 +1618,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/pricing_rules/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/pricing_rules/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::BillingConductor::PricingRule' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::BillingConductor::PricingRule' - AND region = 'us-east-1' - pricing_rule: - name: pricing_rule - id: aws.billingconductor.pricing_rule - x-cfn-schema-name: PricingRule - x-cfn-type-name: AWS::BillingConductor::PricingRule - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1699,12 +1631,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/pricing_rules/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/pricing_rules/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/pricing_rule/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/pricing_rules/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1728,29 +1664,45 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Scope') as scope, - json_extract_path_text(Properties, 'Type') as type, - json_extract_path_text(Properties, 'ModifierPercentage') as modifier_percentage, - json_extract_path_text(Properties, 'Service') as service, - json_extract_path_text(Properties, 'BillingEntity') as billing_entity, - json_extract_path_text(Properties, 'Tiering') as tiering, - json_extract_path_text(Properties, 'UsageType') as usage_type, - json_extract_path_text(Properties, 'Operation') as operation, - json_extract_path_text(Properties, 'AssociatedPricingPlanCount') as associated_pricing_plan_count, - json_extract_path_text(Properties, 'CreationTime') as creation_time, - json_extract_path_text(Properties, 'LastModifiedTime') as last_modified_time, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::BillingConductor::PricingRule' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::BillingConductor::PricingRule' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Scope') as scope, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'ModifierPercentage') as modifier_percentage, + json_extract_path_text(Properties, 'Service') as service, + json_extract_path_text(Properties, 'BillingEntity') as billing_entity, + json_extract_path_text(Properties, 'Tiering') as tiering, + json_extract_path_text(Properties, 'UsageType') as usage_type, + json_extract_path_text(Properties, 'Operation') as operation, + json_extract_path_text(Properties, 'AssociatedPricingPlanCount') as associated_pricing_plan_count, + json_extract_path_text(Properties, 'CreationTime') as creation_time, + json_extract_path_text(Properties, 'LastModifiedTime') as last_modified_time, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::BillingConductor::PricingRule' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::BillingConductor::PricingRule' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/budgets.yaml b/providers/src/aws/v00.00.00000/services/budgets.yaml index fd3c938b..bd50693d 100644 --- a/providers/src/aws/v00.00.00000/services/budgets.yaml +++ b/providers/src/aws/v00.00.00000/services/budgets.yaml @@ -485,6 +485,17 @@ components: SsmActionDefinition: $ref: '#/components/schemas/SsmActionDefinition' additionalProperties: false + ResourceTag: + type: object + properties: + Key: + type: string + Value: + type: string + required: + - Key + - Value + additionalProperties: false BudgetsAction: type: object properties: @@ -520,6 +531,10 @@ components: minItems: 1 Definition: $ref: '#/components/schemas/Definition' + ResourceTags: + type: array + items: + $ref: '#/components/schemas/ResourceTag' required: - BudgetName - NotificationType @@ -547,15 +562,26 @@ components: - ExecutionRoleArn - Definition - Subscribers + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/ResourceTags x-required-permissions: create: - budgets:CreateBudgetAction - iam:PassRole + - budgets:TagResource read: - budgets:DescribeBudgetAction + - budgets:ListTagsForResource update: - budgets:UpdateBudgetAction - iam:PassRole + - budgets:TagResource + - budgets:UntagResource + - budgets:ListTagsForResource delete: - budgets:DeleteBudgetAction list: @@ -606,6 +632,10 @@ components: minItems: 1 Definition: $ref: '#/components/schemas/Definition' + ResourceTags: + type: array + items: + $ref: '#/components/schemas/ResourceTag' x-stackQL-stringOnly: true x-title: CreateBudgetsActionRequest type: object @@ -626,7 +656,7 @@ components: x-identifiers: - ActionId - BudgetName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -643,9 +673,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -655,44 +685,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/budgets_actions/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/budgets_actions/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ActionId') as action_id, - JSON_EXTRACT(Properties, '$.BudgetName') as budget_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Budgets::BudgetsAction' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ActionId') as action_id, - json_extract_path_text(Properties, 'BudgetName') as budget_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Budgets::BudgetsAction' - AND region = 'us-east-1' - budgets_action: - name: budgets_action - id: aws.budgets.budgets_action - x-cfn-schema-name: BudgetsAction - x-cfn-type-name: AWS::Budgets::BudgetsAction - x-identifiers: - - ActionId - - BudgetName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -703,12 +698,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/budgets_actions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/budgets_actions/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/budgets_action/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/budgets_actions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -721,28 +720,48 @@ components: JSON_EXTRACT(Properties, '$.ExecutionRoleArn') as execution_role_arn, JSON_EXTRACT(Properties, '$.ApprovalModel') as approval_model, JSON_EXTRACT(Properties, '$.Subscribers') as subscribers, - JSON_EXTRACT(Properties, '$.Definition') as definition + JSON_EXTRACT(Properties, '$.Definition') as definition, + JSON_EXTRACT(Properties, '$.ResourceTags') as resource_tags FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Budgets::BudgetsAction' AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ActionId') as action_id, - json_extract_path_text(Properties, 'BudgetName') as budget_name, - json_extract_path_text(Properties, 'NotificationType') as notification_type, - json_extract_path_text(Properties, 'ActionType') as action_type, - json_extract_path_text(Properties, 'ActionThreshold') as action_threshold, - json_extract_path_text(Properties, 'ExecutionRoleArn') as execution_role_arn, - json_extract_path_text(Properties, 'ApprovalModel') as approval_model, - json_extract_path_text(Properties, 'Subscribers') as subscribers, - json_extract_path_text(Properties, 'Definition') as definition - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Budgets::BudgetsAction' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.ActionId') as action_id, + JSON_EXTRACT(Properties, '$.BudgetName') as budget_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Budgets::BudgetsAction' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ActionId') as action_id, + json_extract_path_text(Properties, 'BudgetName') as budget_name, + json_extract_path_text(Properties, 'NotificationType') as notification_type, + json_extract_path_text(Properties, 'ActionType') as action_type, + json_extract_path_text(Properties, 'ActionThreshold') as action_threshold, + json_extract_path_text(Properties, 'ExecutionRoleArn') as execution_role_arn, + json_extract_path_text(Properties, 'ApprovalModel') as approval_model, + json_extract_path_text(Properties, 'Subscribers') as subscribers, + json_extract_path_text(Properties, 'Definition') as definition, + json_extract_path_text(Properties, 'ResourceTags') as resource_tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Budgets::BudgetsAction' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ActionId') as action_id, + json_extract_path_text(Properties, 'BudgetName') as budget_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Budgets::BudgetsAction' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/cassandra.yaml b/providers/src/aws/v00.00.00000/services/cassandra.yaml index 6c417563..700c4da1 100644 --- a/providers/src/aws/v00.00.00000/services/cassandra.yaml +++ b/providers/src/aws/v00.00.00000/services/cassandra.yaml @@ -932,7 +932,7 @@ components: x-cfn-type-name: AWS::Cassandra::Keyspace x-identifiers: - KeyspaceName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -949,9 +949,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -961,41 +961,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/keyspaces/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/keyspaces/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.KeyspaceName') as keyspace_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Cassandra::Keyspace' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'KeyspaceName') as keyspace_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Cassandra::Keyspace' - AND region = 'us-east-1' - keyspace: - name: keyspace - id: aws.cassandra.keyspace - x-cfn-schema-name: Keyspace - x-cfn-type-name: AWS::Cassandra::Keyspace - x-identifiers: - - KeyspaceName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1006,12 +974,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/keyspaces/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/keyspaces/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/keyspace/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/keyspaces/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1023,17 +995,33 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'KeyspaceName') as keyspace_name, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'ReplicationSpecification') as replication_specification - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Cassandra::Keyspace' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.KeyspaceName') as keyspace_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Cassandra::Keyspace' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'KeyspaceName') as keyspace_name, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'ReplicationSpecification') as replication_specification + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Cassandra::Keyspace' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'KeyspaceName') as keyspace_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Cassandra::Keyspace' + AND region = 'us-east-1' tables: name: tables id: aws.cassandra.tables @@ -1042,7 +1030,7 @@ components: x-identifiers: - KeyspaceName - TableName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1059,9 +1047,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1071,44 +1059,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/tables/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/tables/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.KeyspaceName') as keyspace_name, - JSON_EXTRACT(Properties, '$.TableName') as table_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Cassandra::Table' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'KeyspaceName') as keyspace_name, - json_extract_path_text(Properties, 'TableName') as table_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Cassandra::Table' - AND region = 'us-east-1' - table: - name: table - id: aws.cassandra.table - x-cfn-schema-name: Table - x-cfn-type-name: AWS::Cassandra::Table - x-identifiers: - - KeyspaceName - - TableName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1119,12 +1072,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/tables/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/tables/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/table/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/tables/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1146,27 +1103,45 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'KeyspaceName') as keyspace_name, - json_extract_path_text(Properties, 'TableName') as table_name, - json_extract_path_text(Properties, 'RegularColumns') as regular_columns, - json_extract_path_text(Properties, 'PartitionKeyColumns') as partition_key_columns, - json_extract_path_text(Properties, 'ClusteringKeyColumns') as clustering_key_columns, - json_extract_path_text(Properties, 'BillingMode') as billing_mode, - json_extract_path_text(Properties, 'PointInTimeRecoveryEnabled') as point_in_time_recovery_enabled, - json_extract_path_text(Properties, 'ClientSideTimestampsEnabled') as client_side_timestamps_enabled, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'DefaultTimeToLive') as default_time_to_live, - json_extract_path_text(Properties, 'EncryptionSpecification') as encryption_specification, - json_extract_path_text(Properties, 'AutoScalingSpecifications') as auto_scaling_specifications, - json_extract_path_text(Properties, 'ReplicaSpecifications') as replica_specifications - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Cassandra::Table' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.KeyspaceName') as keyspace_name, + JSON_EXTRACT(Properties, '$.TableName') as table_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Cassandra::Table' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'KeyspaceName') as keyspace_name, + json_extract_path_text(Properties, 'TableName') as table_name, + json_extract_path_text(Properties, 'RegularColumns') as regular_columns, + json_extract_path_text(Properties, 'PartitionKeyColumns') as partition_key_columns, + json_extract_path_text(Properties, 'ClusteringKeyColumns') as clustering_key_columns, + json_extract_path_text(Properties, 'BillingMode') as billing_mode, + json_extract_path_text(Properties, 'PointInTimeRecoveryEnabled') as point_in_time_recovery_enabled, + json_extract_path_text(Properties, 'ClientSideTimestampsEnabled') as client_side_timestamps_enabled, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'DefaultTimeToLive') as default_time_to_live, + json_extract_path_text(Properties, 'EncryptionSpecification') as encryption_specification, + json_extract_path_text(Properties, 'AutoScalingSpecifications') as auto_scaling_specifications, + json_extract_path_text(Properties, 'ReplicaSpecifications') as replica_specifications + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Cassandra::Table' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'KeyspaceName') as keyspace_name, + json_extract_path_text(Properties, 'TableName') as table_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Cassandra::Table' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/ce.yaml b/providers/src/aws/v00.00.00000/services/ce.yaml index 65cf965f..3a115f5e 100644 --- a/providers/src/aws/v00.00.00000/services/ce.yaml +++ b/providers/src/aws/v00.00.00000/services/ce.yaml @@ -853,7 +853,7 @@ components: x-cfn-type-name: AWS::CE::AnomalyMonitor x-identifiers: - MonitorArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -870,9 +870,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -882,41 +882,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/anomaly_monitors/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/anomaly_monitors/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.MonitorArn') as monitor_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CE::AnomalyMonitor' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'MonitorArn') as monitor_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CE::AnomalyMonitor' - AND region = 'us-east-1' - anomaly_monitor: - name: anomaly_monitor - id: aws.ce.anomaly_monitor - x-cfn-schema-name: AnomalyMonitor - x-cfn-type-name: AWS::CE::AnomalyMonitor - x-identifiers: - - MonitorArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -927,12 +895,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/anomaly_monitors/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/anomaly_monitors/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/anomaly_monitor/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/anomaly_monitors/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -951,24 +923,40 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'MonitorArn') as monitor_arn, - json_extract_path_text(Properties, 'MonitorType') as monitor_type, - json_extract_path_text(Properties, 'MonitorName') as monitor_name, - json_extract_path_text(Properties, 'CreationDate') as creation_date, - json_extract_path_text(Properties, 'LastEvaluatedDate') as last_evaluated_date, - json_extract_path_text(Properties, 'LastUpdatedDate') as last_updated_date, - json_extract_path_text(Properties, 'MonitorDimension') as monitor_dimension, - json_extract_path_text(Properties, 'MonitorSpecification') as monitor_specification, - json_extract_path_text(Properties, 'DimensionalValueCount') as dimensional_value_count, - json_extract_path_text(Properties, 'ResourceTags') as resource_tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CE::AnomalyMonitor' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.MonitorArn') as monitor_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CE::AnomalyMonitor' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'MonitorArn') as monitor_arn, + json_extract_path_text(Properties, 'MonitorType') as monitor_type, + json_extract_path_text(Properties, 'MonitorName') as monitor_name, + json_extract_path_text(Properties, 'CreationDate') as creation_date, + json_extract_path_text(Properties, 'LastEvaluatedDate') as last_evaluated_date, + json_extract_path_text(Properties, 'LastUpdatedDate') as last_updated_date, + json_extract_path_text(Properties, 'MonitorDimension') as monitor_dimension, + json_extract_path_text(Properties, 'MonitorSpecification') as monitor_specification, + json_extract_path_text(Properties, 'DimensionalValueCount') as dimensional_value_count, + json_extract_path_text(Properties, 'ResourceTags') as resource_tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CE::AnomalyMonitor' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'MonitorArn') as monitor_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CE::AnomalyMonitor' + AND region = 'us-east-1' anomaly_subscriptions: name: anomaly_subscriptions id: aws.ce.anomaly_subscriptions @@ -976,7 +964,7 @@ components: x-cfn-type-name: AWS::CE::AnomalySubscription x-identifiers: - SubscriptionArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -993,9 +981,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1005,41 +993,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/anomaly_subscriptions/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/anomaly_subscriptions/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.SubscriptionArn') as subscription_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CE::AnomalySubscription' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'SubscriptionArn') as subscription_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CE::AnomalySubscription' - AND region = 'us-east-1' - anomaly_subscription: - name: anomaly_subscription - id: aws.ce.anomaly_subscription - x-cfn-schema-name: AnomalySubscription - x-cfn-type-name: AWS::CE::AnomalySubscription - x-identifiers: - - SubscriptionArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1050,12 +1006,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/anomaly_subscriptions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/anomaly_subscriptions/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/anomaly_subscription/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/anomaly_subscriptions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1073,23 +1033,39 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'SubscriptionArn') as subscription_arn, - json_extract_path_text(Properties, 'SubscriptionName') as subscription_name, - json_extract_path_text(Properties, 'AccountId') as account_id, - json_extract_path_text(Properties, 'MonitorArnList') as monitor_arn_list, - json_extract_path_text(Properties, 'Subscribers') as subscribers, - json_extract_path_text(Properties, 'Threshold') as threshold, - json_extract_path_text(Properties, 'ThresholdExpression') as threshold_expression, - json_extract_path_text(Properties, 'Frequency') as frequency, - json_extract_path_text(Properties, 'ResourceTags') as resource_tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CE::AnomalySubscription' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.SubscriptionArn') as subscription_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CE::AnomalySubscription' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'SubscriptionArn') as subscription_arn, + json_extract_path_text(Properties, 'SubscriptionName') as subscription_name, + json_extract_path_text(Properties, 'AccountId') as account_id, + json_extract_path_text(Properties, 'MonitorArnList') as monitor_arn_list, + json_extract_path_text(Properties, 'Subscribers') as subscribers, + json_extract_path_text(Properties, 'Threshold') as threshold, + json_extract_path_text(Properties, 'ThresholdExpression') as threshold_expression, + json_extract_path_text(Properties, 'Frequency') as frequency, + json_extract_path_text(Properties, 'ResourceTags') as resource_tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CE::AnomalySubscription' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'SubscriptionArn') as subscription_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CE::AnomalySubscription' + AND region = 'us-east-1' cost_categories: name: cost_categories id: aws.ce.cost_categories @@ -1097,7 +1073,7 @@ components: x-cfn-type-name: AWS::CE::CostCategory x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1114,9 +1090,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1126,41 +1102,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/cost_categories/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/cost_categories/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CE::CostCategory' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CE::CostCategory' - AND region = 'us-east-1' - cost_category: - name: cost_category - id: aws.ce.cost_category - x-cfn-schema-name: CostCategory - x-cfn-type-name: AWS::CE::CostCategory - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1171,12 +1115,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/cost_categories/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/cost_categories/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/cost_category/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/cost_categories/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1192,21 +1140,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'EffectiveStart') as effective_start, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'RuleVersion') as rule_version, - json_extract_path_text(Properties, 'Rules') as rules, - json_extract_path_text(Properties, 'SplitChargeRules') as split_charge_rules, - json_extract_path_text(Properties, 'DefaultValue') as default_value - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CE::CostCategory' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CE::CostCategory' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'EffectiveStart') as effective_start, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'RuleVersion') as rule_version, + json_extract_path_text(Properties, 'Rules') as rules, + json_extract_path_text(Properties, 'SplitChargeRules') as split_charge_rules, + json_extract_path_text(Properties, 'DefaultValue') as default_value + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CE::CostCategory' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CE::CostCategory' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/certificatemanager.yaml b/providers/src/aws/v00.00.00000/services/certificatemanager.yaml index 5578bd39..76e3162f 100644 --- a/providers/src/aws/v00.00.00000/services/certificatemanager.yaml +++ b/providers/src/aws/v00.00.00000/services/certificatemanager.yaml @@ -461,7 +461,7 @@ components: x-cfn-type-name: AWS::CertificateManager::Account x-identifiers: - AccountId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -478,9 +478,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -490,23 +490,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/accounts/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/accounts/methods/delete_resource' - account: - name: account - id: aws.certificatemanager.account - x-cfn-schema-name: Account - x-cfn-type-name: AWS::CertificateManager::Account - x-identifiers: - - AccountId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -517,12 +503,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/accounts/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/accounts/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/account/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/accounts/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -533,7 +523,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, diff --git a/providers/src/aws/v00.00.00000/services/chatbot.yaml b/providers/src/aws/v00.00.00000/services/chatbot.yaml index 8500be87..1d74a872 100644 --- a/providers/src/aws/v00.00.00000/services/chatbot.yaml +++ b/providers/src/aws/v00.00.00000/services/chatbot.yaml @@ -385,6 +385,17 @@ components: $ref: '#/components/x-cloud-control-schemas/ProgressEvent' type: object schemas: + Tag: + type: object + additionalProperties: false + properties: + Value: + type: string + Key: + type: string + required: + - Value + - Key MicrosoftTeamsChannelConfiguration: type: object properties: @@ -443,6 +454,13 @@ components: description: Enables use of a user role requirement in your chat configuration type: boolean default: false + Tags: + description: The tags to add to the configuration + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' required: - TeamId - TeamsChannelId @@ -467,16 +485,24 @@ components: - ConfigurationName - IamRoleArn x-tagging: - taggable: false + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags x-required-permissions: create: - chatbot:CreateMicrosoftTeamsChannelConfiguration + - chatbot:TagResource - iam:PassRole - iam:CreateServiceLinkedRole read: - chatbot:GetMicrosoftTeamsChannelConfiguration update: - chatbot:UpdateMicrosoftTeamsChannelConfiguration + - chatbot:TagResource + - chatbot:UntagResource + - chatbot:ListTagsForResource - iam:PassRole delete: - chatbot:GetMicrosoftTeamsChannelConfiguration @@ -531,6 +557,13 @@ components: items: type: string pattern: ^(^$|arn:aws:iam:[A-Za-z0-9_\/.-]{0,63}:[A-Za-z0-9_\/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_\/+=,@.-]{0,1023})$ + Tags: + description: The tags to add to the configuration + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' UserRoleRequired: description: Enables use of a user role requirement in your chat configuration type: boolean @@ -555,15 +588,25 @@ components: - SlackChannelId - ConfigurationName - IamRoleArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags x-required-permissions: create: - chatbot:CreateSlackChannelConfiguration + - chatbot:TagResource - iam:PassRole - iam:CreateServiceLinkedRole read: - chatbot:DescribeSlackChannelConfigurations update: - chatbot:UpdateSlackChannelConfiguration + - chatbot:TagResource + - chatbot:UntagResource + - chatbot:ListTagsForResource - iam:PassRole delete: - chatbot:DeleteSlackChannelConfiguration @@ -637,6 +680,13 @@ components: description: Enables use of a user role requirement in your chat configuration type: boolean default: false + Tags: + description: The tags to add to the configuration + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' x-stackQL-stringOnly: true x-title: CreateMicrosoftTeamsChannelConfigurationRequest type: object @@ -699,6 +749,13 @@ components: items: type: string pattern: ^(^$|arn:aws:iam:[A-Za-z0-9_\/.-]{0,63}:[A-Za-z0-9_\/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_\/+=,@.-]{0,1023})$ + Tags: + description: The tags to add to the configuration + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' UserRoleRequired: description: Enables use of a user role requirement in your chat configuration type: boolean @@ -722,7 +779,7 @@ components: x-cfn-type-name: AWS::Chatbot::MicrosoftTeamsChannelConfiguration x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -739,9 +796,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -751,41 +808,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/microsoft_teams_channel_configurations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/microsoft_teams_channel_configurations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Chatbot::MicrosoftTeamsChannelConfiguration' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Chatbot::MicrosoftTeamsChannelConfiguration' - AND region = 'us-east-1' - microsoft_teams_channel_configuration: - name: microsoft_teams_channel_configuration - id: aws.chatbot.microsoft_teams_channel_configuration - x-cfn-schema-name: MicrosoftTeamsChannelConfiguration - x-cfn-type-name: AWS::Chatbot::MicrosoftTeamsChannelConfiguration - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -796,12 +821,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/microsoft_teams_channel_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/microsoft_teams_channel_configurations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/microsoft_teams_channel_configuration/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/microsoft_teams_channel_configurations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -815,29 +844,47 @@ components: JSON_EXTRACT(Properties, '$.LoggingLevel') as logging_level, JSON_EXTRACT(Properties, '$.Arn') as arn, JSON_EXTRACT(Properties, '$.GuardrailPolicies') as guardrail_policies, - JSON_EXTRACT(Properties, '$.UserRoleRequired') as user_role_required + JSON_EXTRACT(Properties, '$.UserRoleRequired') as user_role_required, + JSON_EXTRACT(Properties, '$.Tags') as tags FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Chatbot::MicrosoftTeamsChannelConfiguration' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'TeamId') as team_id, - json_extract_path_text(Properties, 'TeamsChannelId') as teams_channel_id, - json_extract_path_text(Properties, 'TeamsTenantId') as teams_tenant_id, - json_extract_path_text(Properties, 'ConfigurationName') as configuration_name, - json_extract_path_text(Properties, 'IamRoleArn') as iam_role_arn, - json_extract_path_text(Properties, 'SnsTopicArns') as sns_topic_arns, - json_extract_path_text(Properties, 'LoggingLevel') as logging_level, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'GuardrailPolicies') as guardrail_policies, - json_extract_path_text(Properties, 'UserRoleRequired') as user_role_required - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Chatbot::MicrosoftTeamsChannelConfiguration' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Chatbot::MicrosoftTeamsChannelConfiguration' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'TeamId') as team_id, + json_extract_path_text(Properties, 'TeamsChannelId') as teams_channel_id, + json_extract_path_text(Properties, 'TeamsTenantId') as teams_tenant_id, + json_extract_path_text(Properties, 'ConfigurationName') as configuration_name, + json_extract_path_text(Properties, 'IamRoleArn') as iam_role_arn, + json_extract_path_text(Properties, 'SnsTopicArns') as sns_topic_arns, + json_extract_path_text(Properties, 'LoggingLevel') as logging_level, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'GuardrailPolicies') as guardrail_policies, + json_extract_path_text(Properties, 'UserRoleRequired') as user_role_required, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Chatbot::MicrosoftTeamsChannelConfiguration' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Chatbot::MicrosoftTeamsChannelConfiguration' + AND region = 'us-east-1' slack_channel_configurations: name: slack_channel_configurations id: aws.chatbot.slack_channel_configurations @@ -845,7 +892,7 @@ components: x-cfn-type-name: AWS::Chatbot::SlackChannelConfiguration x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -862,9 +909,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -874,41 +921,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/slack_channel_configurations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/slack_channel_configurations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Chatbot::SlackChannelConfiguration' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Chatbot::SlackChannelConfiguration' - AND region = 'us-east-1' - slack_channel_configuration: - name: slack_channel_configuration - id: aws.chatbot.slack_channel_configuration - x-cfn-schema-name: SlackChannelConfiguration - x-cfn-type-name: AWS::Chatbot::SlackChannelConfiguration - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -919,12 +934,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/slack_channel_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/slack_channel_configurations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/slack_channel_configuration/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/slack_channel_configurations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -937,28 +956,46 @@ components: JSON_EXTRACT(Properties, '$.LoggingLevel') as logging_level, JSON_EXTRACT(Properties, '$.Arn') as arn, JSON_EXTRACT(Properties, '$.GuardrailPolicies') as guardrail_policies, + JSON_EXTRACT(Properties, '$.Tags') as tags, JSON_EXTRACT(Properties, '$.UserRoleRequired') as user_role_required FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Chatbot::SlackChannelConfiguration' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'SlackWorkspaceId') as slack_workspace_id, - json_extract_path_text(Properties, 'SlackChannelId') as slack_channel_id, - json_extract_path_text(Properties, 'ConfigurationName') as configuration_name, - json_extract_path_text(Properties, 'IamRoleArn') as iam_role_arn, - json_extract_path_text(Properties, 'SnsTopicArns') as sns_topic_arns, - json_extract_path_text(Properties, 'LoggingLevel') as logging_level, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'GuardrailPolicies') as guardrail_policies, - json_extract_path_text(Properties, 'UserRoleRequired') as user_role_required - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Chatbot::SlackChannelConfiguration' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Chatbot::SlackChannelConfiguration' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'SlackWorkspaceId') as slack_workspace_id, + json_extract_path_text(Properties, 'SlackChannelId') as slack_channel_id, + json_extract_path_text(Properties, 'ConfigurationName') as configuration_name, + json_extract_path_text(Properties, 'IamRoleArn') as iam_role_arn, + json_extract_path_text(Properties, 'SnsTopicArns') as sns_topic_arns, + json_extract_path_text(Properties, 'LoggingLevel') as logging_level, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'GuardrailPolicies') as guardrail_policies, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'UserRoleRequired') as user_role_required + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Chatbot::SlackChannelConfiguration' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Chatbot::SlackChannelConfiguration' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/cleanrooms.yaml b/providers/src/aws/v00.00.00000/services/cleanrooms.yaml index f9f9a6d2..f884b5ac 100644 --- a/providers/src/aws/v00.00.00000/services/cleanrooms.yaml +++ b/providers/src/aws/v00.00.00000/services/cleanrooms.yaml @@ -1963,7 +1963,7 @@ components: x-identifiers: - AnalysisTemplateIdentifier - MembershipIdentifier - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1980,9 +1980,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1992,44 +1992,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/analysis_templates/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/analysis_templates/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AnalysisTemplateIdentifier') as analysis_template_identifier, - JSON_EXTRACT(Properties, '$.MembershipIdentifier') as membership_identifier - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CleanRooms::AnalysisTemplate' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AnalysisTemplateIdentifier') as analysis_template_identifier, - json_extract_path_text(Properties, 'MembershipIdentifier') as membership_identifier - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CleanRooms::AnalysisTemplate' - AND region = 'us-east-1' - analysis_template: - name: analysis_template - id: aws.cleanrooms.analysis_template - x-cfn-schema-name: AnalysisTemplate - x-cfn-type-name: AWS::CleanRooms::AnalysisTemplate - x-identifiers: - - AnalysisTemplateIdentifier - - MembershipIdentifier - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2040,12 +2005,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/analysis_templates/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/analysis_templates/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/analysis_template/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/analysis_templates/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2067,27 +2036,45 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'CollaborationArn') as collaboration_arn, - json_extract_path_text(Properties, 'CollaborationIdentifier') as collaboration_identifier, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'AnalysisParameters') as analysis_parameters, - json_extract_path_text(Properties, 'AnalysisTemplateIdentifier') as analysis_template_identifier, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'MembershipArn') as membership_arn, - json_extract_path_text(Properties, 'MembershipIdentifier') as membership_identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Schema') as _schema, - json_extract_path_text(Properties, 'Source') as source, - json_extract_path_text(Properties, 'Format') as _format - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CleanRooms::AnalysisTemplate' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.AnalysisTemplateIdentifier') as analysis_template_identifier, + JSON_EXTRACT(Properties, '$.MembershipIdentifier') as membership_identifier + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CleanRooms::AnalysisTemplate' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'CollaborationArn') as collaboration_arn, + json_extract_path_text(Properties, 'CollaborationIdentifier') as collaboration_identifier, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'AnalysisParameters') as analysis_parameters, + json_extract_path_text(Properties, 'AnalysisTemplateIdentifier') as analysis_template_identifier, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'MembershipArn') as membership_arn, + json_extract_path_text(Properties, 'MembershipIdentifier') as membership_identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Schema') as _schema, + json_extract_path_text(Properties, 'Source') as source, + json_extract_path_text(Properties, 'Format') as _format + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CleanRooms::AnalysisTemplate' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AnalysisTemplateIdentifier') as analysis_template_identifier, + json_extract_path_text(Properties, 'MembershipIdentifier') as membership_identifier + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CleanRooms::AnalysisTemplate' + AND region = 'us-east-1' collaborations: name: collaborations id: aws.cleanrooms.collaborations @@ -2095,7 +2082,7 @@ components: x-cfn-type-name: AWS::CleanRooms::Collaboration x-identifiers: - CollaborationIdentifier - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2112,9 +2099,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2124,41 +2111,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/collaborations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/collaborations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.CollaborationIdentifier') as collaboration_identifier - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CleanRooms::Collaboration' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'CollaborationIdentifier') as collaboration_identifier - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CleanRooms::Collaboration' - AND region = 'us-east-1' - collaboration: - name: collaboration - id: aws.cleanrooms.collaboration - x-cfn-schema-name: Collaboration - x-cfn-type-name: AWS::CleanRooms::Collaboration - x-identifiers: - - CollaborationIdentifier - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2169,12 +2124,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/collaborations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/collaborations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/collaboration/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/collaborations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2194,25 +2153,41 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'CollaborationIdentifier') as collaboration_identifier, - json_extract_path_text(Properties, 'CreatorDisplayName') as creator_display_name, - json_extract_path_text(Properties, 'CreatorMemberAbilities') as creator_member_abilities, - json_extract_path_text(Properties, 'DataEncryptionMetadata') as data_encryption_metadata, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Members') as members, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'QueryLogStatus') as query_log_status, - json_extract_path_text(Properties, 'CreatorPaymentConfiguration') as creator_payment_configuration - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CleanRooms::Collaboration' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.CollaborationIdentifier') as collaboration_identifier + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CleanRooms::Collaboration' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'CollaborationIdentifier') as collaboration_identifier, + json_extract_path_text(Properties, 'CreatorDisplayName') as creator_display_name, + json_extract_path_text(Properties, 'CreatorMemberAbilities') as creator_member_abilities, + json_extract_path_text(Properties, 'DataEncryptionMetadata') as data_encryption_metadata, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Members') as members, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'QueryLogStatus') as query_log_status, + json_extract_path_text(Properties, 'CreatorPaymentConfiguration') as creator_payment_configuration + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CleanRooms::Collaboration' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'CollaborationIdentifier') as collaboration_identifier + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CleanRooms::Collaboration' + AND region = 'us-east-1' configured_tables: name: configured_tables id: aws.cleanrooms.configured_tables @@ -2220,7 +2195,7 @@ components: x-cfn-type-name: AWS::CleanRooms::ConfiguredTable x-identifiers: - ConfiguredTableIdentifier - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2237,9 +2212,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2249,41 +2224,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/configured_tables/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/configured_tables/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ConfiguredTableIdentifier') as configured_table_identifier - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CleanRooms::ConfiguredTable' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ConfiguredTableIdentifier') as configured_table_identifier - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CleanRooms::ConfiguredTable' - AND region = 'us-east-1' - configured_table: - name: configured_table - id: aws.cleanrooms.configured_table - x-cfn-schema-name: ConfiguredTable - x-cfn-type-name: AWS::CleanRooms::ConfiguredTable - x-identifiers: - - ConfiguredTableIdentifier - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2294,12 +2237,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/configured_tables/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/configured_tables/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/configured_table/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/configured_tables/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2317,23 +2264,39 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'AllowedColumns') as allowed_columns, - json_extract_path_text(Properties, 'AnalysisMethod') as analysis_method, - json_extract_path_text(Properties, 'ConfiguredTableIdentifier') as configured_table_identifier, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'AnalysisRules') as analysis_rules, - json_extract_path_text(Properties, 'TableReference') as table_reference - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CleanRooms::ConfiguredTable' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ConfiguredTableIdentifier') as configured_table_identifier + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CleanRooms::ConfiguredTable' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'AllowedColumns') as allowed_columns, + json_extract_path_text(Properties, 'AnalysisMethod') as analysis_method, + json_extract_path_text(Properties, 'ConfiguredTableIdentifier') as configured_table_identifier, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'AnalysisRules') as analysis_rules, + json_extract_path_text(Properties, 'TableReference') as table_reference + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CleanRooms::ConfiguredTable' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ConfiguredTableIdentifier') as configured_table_identifier + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CleanRooms::ConfiguredTable' + AND region = 'us-east-1' configured_table_associations: name: configured_table_associations id: aws.cleanrooms.configured_table_associations @@ -2342,7 +2305,7 @@ components: x-identifiers: - ConfiguredTableAssociationIdentifier - MembershipIdentifier - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2359,9 +2322,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2371,44 +2334,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/configured_table_associations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/configured_table_associations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ConfiguredTableAssociationIdentifier') as configured_table_association_identifier, - JSON_EXTRACT(Properties, '$.MembershipIdentifier') as membership_identifier - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CleanRooms::ConfiguredTableAssociation' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ConfiguredTableAssociationIdentifier') as configured_table_association_identifier, - json_extract_path_text(Properties, 'MembershipIdentifier') as membership_identifier - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CleanRooms::ConfiguredTableAssociation' - AND region = 'us-east-1' - configured_table_association: - name: configured_table_association - id: aws.cleanrooms.configured_table_association - x-cfn-schema-name: ConfiguredTableAssociation - x-cfn-type-name: AWS::CleanRooms::ConfiguredTableAssociation - x-identifiers: - - ConfiguredTableAssociationIdentifier - - MembershipIdentifier - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2419,12 +2347,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/configured_table_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/configured_table_associations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/configured_table_association/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/configured_table_associations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2441,22 +2373,40 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'ConfiguredTableAssociationIdentifier') as configured_table_association_identifier, - json_extract_path_text(Properties, 'ConfiguredTableIdentifier') as configured_table_identifier, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'MembershipIdentifier') as membership_identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'RoleArn') as role_arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CleanRooms::ConfiguredTableAssociation' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.ConfiguredTableAssociationIdentifier') as configured_table_association_identifier, + JSON_EXTRACT(Properties, '$.MembershipIdentifier') as membership_identifier + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CleanRooms::ConfiguredTableAssociation' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'ConfiguredTableAssociationIdentifier') as configured_table_association_identifier, + json_extract_path_text(Properties, 'ConfiguredTableIdentifier') as configured_table_identifier, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'MembershipIdentifier') as membership_identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'RoleArn') as role_arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CleanRooms::ConfiguredTableAssociation' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ConfiguredTableAssociationIdentifier') as configured_table_association_identifier, + json_extract_path_text(Properties, 'MembershipIdentifier') as membership_identifier + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CleanRooms::ConfiguredTableAssociation' + AND region = 'us-east-1' memberships: name: memberships id: aws.cleanrooms.memberships @@ -2464,7 +2414,7 @@ components: x-cfn-type-name: AWS::CleanRooms::Membership x-identifiers: - MembershipIdentifier - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2481,9 +2431,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2493,41 +2443,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/memberships/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/memberships/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.MembershipIdentifier') as membership_identifier - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CleanRooms::Membership' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'MembershipIdentifier') as membership_identifier - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CleanRooms::Membership' - AND region = 'us-east-1' - membership: - name: membership - id: aws.cleanrooms.membership - x-cfn-schema-name: Membership - x-cfn-type-name: AWS::CleanRooms::Membership - x-identifiers: - - MembershipIdentifier - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2538,12 +2456,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/memberships/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/memberships/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/membership/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/memberships/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2561,23 +2483,39 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'CollaborationArn') as collaboration_arn, - json_extract_path_text(Properties, 'CollaborationCreatorAccountId') as collaboration_creator_account_id, - json_extract_path_text(Properties, 'CollaborationIdentifier') as collaboration_identifier, - json_extract_path_text(Properties, 'MembershipIdentifier') as membership_identifier, - json_extract_path_text(Properties, 'QueryLogStatus') as query_log_status, - json_extract_path_text(Properties, 'DefaultResultConfiguration') as default_result_configuration, - json_extract_path_text(Properties, 'PaymentConfiguration') as payment_configuration - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CleanRooms::Membership' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.MembershipIdentifier') as membership_identifier + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CleanRooms::Membership' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'CollaborationArn') as collaboration_arn, + json_extract_path_text(Properties, 'CollaborationCreatorAccountId') as collaboration_creator_account_id, + json_extract_path_text(Properties, 'CollaborationIdentifier') as collaboration_identifier, + json_extract_path_text(Properties, 'MembershipIdentifier') as membership_identifier, + json_extract_path_text(Properties, 'QueryLogStatus') as query_log_status, + json_extract_path_text(Properties, 'DefaultResultConfiguration') as default_result_configuration, + json_extract_path_text(Properties, 'PaymentConfiguration') as payment_configuration + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CleanRooms::Membership' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'MembershipIdentifier') as membership_identifier + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CleanRooms::Membership' + AND region = 'us-east-1' privacy_budget_templates: name: privacy_budget_templates id: aws.cleanrooms.privacy_budget_templates @@ -2586,7 +2524,7 @@ components: x-identifiers: - PrivacyBudgetTemplateIdentifier - MembershipIdentifier - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2603,9 +2541,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2615,44 +2553,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/privacy_budget_templates/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/privacy_budget_templates/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.PrivacyBudgetTemplateIdentifier') as privacy_budget_template_identifier, - JSON_EXTRACT(Properties, '$.MembershipIdentifier') as membership_identifier - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CleanRooms::PrivacyBudgetTemplate' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'PrivacyBudgetTemplateIdentifier') as privacy_budget_template_identifier, - json_extract_path_text(Properties, 'MembershipIdentifier') as membership_identifier - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CleanRooms::PrivacyBudgetTemplate' - AND region = 'us-east-1' - privacy_budget_template: - name: privacy_budget_template - id: aws.cleanrooms.privacy_budget_template - x-cfn-schema-name: PrivacyBudgetTemplate - x-cfn-type-name: AWS::CleanRooms::PrivacyBudgetTemplate - x-identifiers: - - PrivacyBudgetTemplateIdentifier - - MembershipIdentifier - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2663,12 +2566,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/privacy_budget_templates/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/privacy_budget_templates/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/privacy_budget_template/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/privacy_budget_templates/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2687,24 +2594,42 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'CollaborationArn') as collaboration_arn, - json_extract_path_text(Properties, 'CollaborationIdentifier') as collaboration_identifier, - json_extract_path_text(Properties, 'PrivacyBudgetTemplateIdentifier') as privacy_budget_template_identifier, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'AutoRefresh') as auto_refresh, - json_extract_path_text(Properties, 'PrivacyBudgetType') as privacy_budget_type, - json_extract_path_text(Properties, 'Parameters') as parameters, - json_extract_path_text(Properties, 'MembershipArn') as membership_arn, - json_extract_path_text(Properties, 'MembershipIdentifier') as membership_identifier - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CleanRooms::PrivacyBudgetTemplate' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.PrivacyBudgetTemplateIdentifier') as privacy_budget_template_identifier, + JSON_EXTRACT(Properties, '$.MembershipIdentifier') as membership_identifier + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CleanRooms::PrivacyBudgetTemplate' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'CollaborationArn') as collaboration_arn, + json_extract_path_text(Properties, 'CollaborationIdentifier') as collaboration_identifier, + json_extract_path_text(Properties, 'PrivacyBudgetTemplateIdentifier') as privacy_budget_template_identifier, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'AutoRefresh') as auto_refresh, + json_extract_path_text(Properties, 'PrivacyBudgetType') as privacy_budget_type, + json_extract_path_text(Properties, 'Parameters') as parameters, + json_extract_path_text(Properties, 'MembershipArn') as membership_arn, + json_extract_path_text(Properties, 'MembershipIdentifier') as membership_identifier + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CleanRooms::PrivacyBudgetTemplate' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'PrivacyBudgetTemplateIdentifier') as privacy_budget_template_identifier, + json_extract_path_text(Properties, 'MembershipIdentifier') as membership_identifier + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CleanRooms::PrivacyBudgetTemplate' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/cleanroomsml.yaml b/providers/src/aws/v00.00.00000/services/cleanroomsml.yaml index 749f0e5a..a7ab10fd 100644 --- a/providers/src/aws/v00.00.00000/services/cleanroomsml.yaml +++ b/providers/src/aws/v00.00.00000/services/cleanroomsml.yaml @@ -638,7 +638,7 @@ components: x-cfn-type-name: AWS::CleanRoomsML::TrainingDataset x-identifiers: - TrainingDatasetArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -655,9 +655,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -667,41 +667,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/training_datasets/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/training_datasets/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.TrainingDatasetArn') as training_dataset_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CleanRoomsML::TrainingDataset' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'TrainingDatasetArn') as training_dataset_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CleanRoomsML::TrainingDataset' - AND region = 'us-east-1' - training_dataset: - name: training_dataset - id: aws.cleanroomsml.training_dataset - x-cfn-schema-name: TrainingDataset - x-cfn-type-name: AWS::CleanRoomsML::TrainingDataset - x-identifiers: - - TrainingDatasetArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -712,12 +680,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/training_datasets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/training_datasets/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/training_dataset/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/training_datasets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -733,21 +705,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'TrainingData') as training_data, - json_extract_path_text(Properties, 'TrainingDatasetArn') as training_dataset_arn, - json_extract_path_text(Properties, 'Status') as status - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CleanRoomsML::TrainingDataset' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.TrainingDatasetArn') as training_dataset_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CleanRoomsML::TrainingDataset' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'TrainingData') as training_data, + json_extract_path_text(Properties, 'TrainingDatasetArn') as training_dataset_arn, + json_extract_path_text(Properties, 'Status') as status + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CleanRoomsML::TrainingDataset' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'TrainingDatasetArn') as training_dataset_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CleanRoomsML::TrainingDataset' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/cloudformation.yaml b/providers/src/aws/v00.00.00000/services/cloudformation.yaml index a19afba2..87e36d85 100644 --- a/providers/src/aws/v00.00.00000/services/cloudformation.yaml +++ b/providers/src/aws/v00.00.00000/services/cloudformation.yaml @@ -2319,7 +2319,7 @@ components: x-cfn-type-name: AWS::CloudFormation::HookDefaultVersion x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2336,37 +2336,6 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/hook_default_versions/methods/create_resource' - delete: [] - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::HookDefaultVersion' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::HookDefaultVersion' - AND region = 'us-east-1' - hook_default_version: - name: hook_default_version - id: aws.cloudformation.hook_default_version - x-cfn-schema-name: HookDefaultVersion - x-cfn-type-name: AWS::CloudFormation::HookDefaultVersion - x-identifiers: - - Arn - x-type: get - methods: update_resource: operation: $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' @@ -2380,12 +2349,15 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/hook_default_versions/methods/create_resource' + delete: [] update: - - $ref: '#/components/x-stackQL-resources/hook_default_version/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/hook_default_versions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2398,18 +2370,34 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'TypeVersionArn') as type_version_arn, - json_extract_path_text(Properties, 'TypeName') as type_name, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'VersionId') as version_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFormation::HookDefaultVersion' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::HookDefaultVersion' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'TypeVersionArn') as type_version_arn, + json_extract_path_text(Properties, 'TypeName') as type_name, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'VersionId') as version_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFormation::HookDefaultVersion' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::HookDefaultVersion' + AND region = 'us-east-1' hook_type_configs: name: hook_type_configs id: aws.cloudformation.hook_type_configs @@ -2417,7 +2405,7 @@ components: x-cfn-type-name: AWS::CloudFormation::HookTypeConfig x-identifiers: - ConfigurationArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2434,9 +2422,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2446,41 +2434,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/hook_type_configs/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/hook_type_configs/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ConfigurationArn') as configuration_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::HookTypeConfig' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ConfigurationArn') as configuration_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::HookTypeConfig' - AND region = 'us-east-1' - hook_type_config: - name: hook_type_config - id: aws.cloudformation.hook_type_config - x-cfn-schema-name: HookTypeConfig - x-cfn-type-name: AWS::CloudFormation::HookTypeConfig - x-identifiers: - - ConfigurationArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2491,12 +2447,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/hook_type_configs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/hook_type_configs/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/hook_type_config/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/hook_type_configs/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2510,19 +2470,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'TypeArn') as type_arn, - json_extract_path_text(Properties, 'TypeName') as type_name, - json_extract_path_text(Properties, 'ConfigurationArn') as configuration_arn, - json_extract_path_text(Properties, 'Configuration') as configuration, - json_extract_path_text(Properties, 'ConfigurationAlias') as configuration_alias - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFormation::HookTypeConfig' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ConfigurationArn') as configuration_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::HookTypeConfig' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'TypeArn') as type_arn, + json_extract_path_text(Properties, 'TypeName') as type_name, + json_extract_path_text(Properties, 'ConfigurationArn') as configuration_arn, + json_extract_path_text(Properties, 'Configuration') as configuration, + json_extract_path_text(Properties, 'ConfigurationAlias') as configuration_alias + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFormation::HookTypeConfig' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ConfigurationArn') as configuration_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::HookTypeConfig' + AND region = 'us-east-1' hook_versions: name: hook_versions id: aws.cloudformation.hook_versions @@ -2530,7 +2506,7 @@ components: x-cfn-type-name: AWS::CloudFormation::HookVersion x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2564,39 +2540,11 @@ components: - $ref: '#/components/x-stackQL-resources/hook_versions/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/hook_versions/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::HookVersion' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::HookVersion' - AND region = 'us-east-1' - hook_version: - name: hook_version - id: aws.cloudformation.hook_version - x-cfn-schema-name: HookVersion - x-cfn-type-name: AWS::CloudFormation::HookVersion - x-identifiers: - - Arn - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2614,23 +2562,39 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'TypeArn') as type_arn, - json_extract_path_text(Properties, 'ExecutionRoleArn') as execution_role_arn, - json_extract_path_text(Properties, 'IsDefaultVersion') as is_default_version, - json_extract_path_text(Properties, 'LoggingConfig') as logging_config, - json_extract_path_text(Properties, 'SchemaHandlerPackage') as schema_handler_package, - json_extract_path_text(Properties, 'TypeName') as type_name, - json_extract_path_text(Properties, 'VersionId') as version_id, - json_extract_path_text(Properties, 'Visibility') as visibility - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFormation::HookVersion' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::HookVersion' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'TypeArn') as type_arn, + json_extract_path_text(Properties, 'ExecutionRoleArn') as execution_role_arn, + json_extract_path_text(Properties, 'IsDefaultVersion') as is_default_version, + json_extract_path_text(Properties, 'LoggingConfig') as logging_config, + json_extract_path_text(Properties, 'SchemaHandlerPackage') as schema_handler_package, + json_extract_path_text(Properties, 'TypeName') as type_name, + json_extract_path_text(Properties, 'VersionId') as version_id, + json_extract_path_text(Properties, 'Visibility') as visibility + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFormation::HookVersion' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::HookVersion' + AND region = 'us-east-1' module_default_versions: name: module_default_versions id: aws.cloudformation.module_default_versions @@ -2638,7 +2602,7 @@ components: x-cfn-type-name: AWS::CloudFormation::ModuleDefaultVersion x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2659,39 +2623,11 @@ components: insert: - $ref: '#/components/x-stackQL-resources/module_default_versions/methods/create_resource' delete: [] - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::ModuleDefaultVersion' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::ModuleDefaultVersion' - AND region = 'us-east-1' - module_default_version: - name: module_default_version - id: aws.cloudformation.module_default_version - x-cfn-schema-name: ModuleDefaultVersion - x-cfn-type-name: AWS::CloudFormation::ModuleDefaultVersion - x-identifiers: - - Arn - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2703,17 +2639,33 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'ModuleName') as module_name, - json_extract_path_text(Properties, 'VersionId') as version_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFormation::ModuleDefaultVersion' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::ModuleDefaultVersion' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'ModuleName') as module_name, + json_extract_path_text(Properties, 'VersionId') as version_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFormation::ModuleDefaultVersion' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::ModuleDefaultVersion' + AND region = 'us-east-1' module_versions: name: module_versions id: aws.cloudformation.module_versions @@ -2721,7 +2673,7 @@ components: x-cfn-type-name: AWS::CloudFormation::ModuleVersion x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2755,21 +2707,11 @@ components: - $ref: '#/components/x-stackQL-resources/module_versions/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/module_versions/methods/delete_resource' - module_version: - name: module_version - id: aws.cloudformation.module_version - x-cfn-schema-name: ModuleVersion - x-cfn-type-name: AWS::CloudFormation::ModuleVersion - x-identifiers: - - Arn - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2788,7 +2730,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2813,7 +2755,7 @@ components: x-cfn-type-name: AWS::CloudFormation::PublicTypeVersion x-identifiers: - PublicTypeArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2834,39 +2776,11 @@ components: insert: - $ref: '#/components/x-stackQL-resources/public_type_versions/methods/create_resource' delete: [] - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.PublicTypeArn') as public_type_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::PublicTypeVersion' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'PublicTypeArn') as public_type_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::PublicTypeVersion' - AND region = 'us-east-1' - public_type_version: - name: public_type_version - id: aws.cloudformation.public_type_version - x-cfn-schema-name: PublicTypeVersion - x-cfn-type-name: AWS::CloudFormation::PublicTypeVersion - x-identifiers: - - PublicTypeArn - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2883,22 +2797,38 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'TypeVersionArn') as type_version_arn, - json_extract_path_text(Properties, 'PublicVersionNumber') as public_version_number, - json_extract_path_text(Properties, 'PublisherId') as publisher_id, - json_extract_path_text(Properties, 'PublicTypeArn') as public_type_arn, - json_extract_path_text(Properties, 'TypeName') as type_name, - json_extract_path_text(Properties, 'LogDeliveryBucket') as log_delivery_bucket, - json_extract_path_text(Properties, 'Type') as type - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFormation::PublicTypeVersion' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.PublicTypeArn') as public_type_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::PublicTypeVersion' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'TypeVersionArn') as type_version_arn, + json_extract_path_text(Properties, 'PublicVersionNumber') as public_version_number, + json_extract_path_text(Properties, 'PublisherId') as publisher_id, + json_extract_path_text(Properties, 'PublicTypeArn') as public_type_arn, + json_extract_path_text(Properties, 'TypeName') as type_name, + json_extract_path_text(Properties, 'LogDeliveryBucket') as log_delivery_bucket, + json_extract_path_text(Properties, 'Type') as type + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFormation::PublicTypeVersion' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'PublicTypeArn') as public_type_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::PublicTypeVersion' + AND region = 'us-east-1' publishers: name: publishers id: aws.cloudformation.publishers @@ -2906,7 +2836,7 @@ components: x-cfn-type-name: AWS::CloudFormation::Publisher x-identifiers: - PublisherId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2927,39 +2857,11 @@ components: insert: - $ref: '#/components/x-stackQL-resources/publishers/methods/create_resource' delete: [] - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.PublisherId') as publisher_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::Publisher' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'PublisherId') as publisher_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::Publisher' - AND region = 'us-east-1' - publisher: - name: publisher - id: aws.cloudformation.publisher - x-cfn-schema-name: Publisher - x-cfn-type-name: AWS::CloudFormation::Publisher - x-identifiers: - - PublisherId - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2974,20 +2876,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AcceptTermsAndConditions') as accept_terms_and_conditions, - json_extract_path_text(Properties, 'PublisherId') as publisher_id, - json_extract_path_text(Properties, 'ConnectionArn') as connection_arn, - json_extract_path_text(Properties, 'PublisherStatus') as publisher_status, - json_extract_path_text(Properties, 'PublisherProfile') as publisher_profile, - json_extract_path_text(Properties, 'IdentityProvider') as identity_provider - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFormation::Publisher' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.PublisherId') as publisher_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::Publisher' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AcceptTermsAndConditions') as accept_terms_and_conditions, + json_extract_path_text(Properties, 'PublisherId') as publisher_id, + json_extract_path_text(Properties, 'ConnectionArn') as connection_arn, + json_extract_path_text(Properties, 'PublisherStatus') as publisher_status, + json_extract_path_text(Properties, 'PublisherProfile') as publisher_profile, + json_extract_path_text(Properties, 'IdentityProvider') as identity_provider + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFormation::Publisher' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'PublisherId') as publisher_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::Publisher' + AND region = 'us-east-1' resource_default_versions: name: resource_default_versions id: aws.cloudformation.resource_default_versions @@ -2995,7 +2913,7 @@ components: x-cfn-type-name: AWS::CloudFormation::ResourceDefaultVersion x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3012,9 +2930,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3024,41 +2942,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/resource_default_versions/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/resource_default_versions/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::ResourceDefaultVersion' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::ResourceDefaultVersion' - AND region = 'us-east-1' - resource_default_version: - name: resource_default_version - id: aws.cloudformation.resource_default_version - x-cfn-schema-name: ResourceDefaultVersion - x-cfn-type-name: AWS::CloudFormation::ResourceDefaultVersion - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3069,12 +2955,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/resource_default_versions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/resource_default_versions/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/resource_default_version/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/resource_default_versions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3087,18 +2977,34 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'VersionId') as version_id, - json_extract_path_text(Properties, 'TypeName') as type_name, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'TypeVersionArn') as type_version_arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFormation::ResourceDefaultVersion' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::ResourceDefaultVersion' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'VersionId') as version_id, + json_extract_path_text(Properties, 'TypeName') as type_name, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'TypeVersionArn') as type_version_arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFormation::ResourceDefaultVersion' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::ResourceDefaultVersion' + AND region = 'us-east-1' resource_versions: name: resource_versions id: aws.cloudformation.resource_versions @@ -3106,7 +3012,7 @@ components: x-cfn-type-name: AWS::CloudFormation::ResourceVersion x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3140,39 +3046,11 @@ components: - $ref: '#/components/x-stackQL-resources/resource_versions/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/resource_versions/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::ResourceVersion' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::ResourceVersion' - AND region = 'us-east-1' - resource_version: - name: resource_version - id: aws.cloudformation.resource_version - x-cfn-schema-name: ResourceVersion - x-cfn-type-name: AWS::CloudFormation::ResourceVersion - x-identifiers: - - Arn - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3191,24 +3069,40 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'TypeArn') as type_arn, - json_extract_path_text(Properties, 'ExecutionRoleArn') as execution_role_arn, - json_extract_path_text(Properties, 'IsDefaultVersion') as is_default_version, - json_extract_path_text(Properties, 'LoggingConfig') as logging_config, - json_extract_path_text(Properties, 'ProvisioningType') as provisioning_type, - json_extract_path_text(Properties, 'SchemaHandlerPackage') as schema_handler_package, - json_extract_path_text(Properties, 'TypeName') as type_name, - json_extract_path_text(Properties, 'VersionId') as version_id, - json_extract_path_text(Properties, 'Visibility') as visibility - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFormation::ResourceVersion' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::ResourceVersion' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'TypeArn') as type_arn, + json_extract_path_text(Properties, 'ExecutionRoleArn') as execution_role_arn, + json_extract_path_text(Properties, 'IsDefaultVersion') as is_default_version, + json_extract_path_text(Properties, 'LoggingConfig') as logging_config, + json_extract_path_text(Properties, 'ProvisioningType') as provisioning_type, + json_extract_path_text(Properties, 'SchemaHandlerPackage') as schema_handler_package, + json_extract_path_text(Properties, 'TypeName') as type_name, + json_extract_path_text(Properties, 'VersionId') as version_id, + json_extract_path_text(Properties, 'Visibility') as visibility + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFormation::ResourceVersion' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::ResourceVersion' + AND region = 'us-east-1' stacks: name: stacks id: aws.cloudformation.stacks @@ -3216,7 +3110,7 @@ components: x-cfn-type-name: AWS::CloudFormation::Stack x-identifiers: - StackId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3233,9 +3127,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3245,41 +3139,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/stacks/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/stacks/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.StackId') as stack_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::Stack' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'StackId') as stack_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::Stack' - AND region = 'us-east-1' - stack: - name: stack - id: aws.cloudformation.stack - x-cfn-schema-name: Stack - x-cfn-type-name: AWS::CloudFormation::Stack - x-identifiers: - - StackId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3290,12 +3152,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/stacks/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/stacks/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/stack/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/stacks/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3327,37 +3193,53 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Capabilities') as capabilities, - json_extract_path_text(Properties, 'RoleARN') as role_arn, - json_extract_path_text(Properties, 'Outputs') as outputs, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'DisableRollback') as disable_rollback, - json_extract_path_text(Properties, 'EnableTerminationProtection') as enable_termination_protection, - json_extract_path_text(Properties, 'NotificationARNs') as notification_arns, - json_extract_path_text(Properties, 'Parameters') as parameters, - json_extract_path_text(Properties, 'ParentId') as parent_id, - json_extract_path_text(Properties, 'RootId') as root_id, - json_extract_path_text(Properties, 'ChangeSetId') as change_set_id, - json_extract_path_text(Properties, 'StackName') as stack_name, - json_extract_path_text(Properties, 'StackId') as stack_id, - json_extract_path_text(Properties, 'StackPolicyBody') as stack_policy_body, - json_extract_path_text(Properties, 'StackPolicyURL') as stack_policy_url, - json_extract_path_text(Properties, 'StackStatus') as stack_status, - json_extract_path_text(Properties, 'StackStatusReason') as stack_status_reason, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'TemplateBody') as template_body, - json_extract_path_text(Properties, 'TemplateURL') as template_url, - json_extract_path_text(Properties, 'TimeoutInMinutes') as timeout_in_minutes, - json_extract_path_text(Properties, 'LastUpdateTime') as last_update_time, - json_extract_path_text(Properties, 'CreationTime') as creation_time - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFormation::Stack' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.StackId') as stack_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::Stack' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Capabilities') as capabilities, + json_extract_path_text(Properties, 'RoleARN') as role_arn, + json_extract_path_text(Properties, 'Outputs') as outputs, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'DisableRollback') as disable_rollback, + json_extract_path_text(Properties, 'EnableTerminationProtection') as enable_termination_protection, + json_extract_path_text(Properties, 'NotificationARNs') as notification_arns, + json_extract_path_text(Properties, 'Parameters') as parameters, + json_extract_path_text(Properties, 'ParentId') as parent_id, + json_extract_path_text(Properties, 'RootId') as root_id, + json_extract_path_text(Properties, 'ChangeSetId') as change_set_id, + json_extract_path_text(Properties, 'StackName') as stack_name, + json_extract_path_text(Properties, 'StackId') as stack_id, + json_extract_path_text(Properties, 'StackPolicyBody') as stack_policy_body, + json_extract_path_text(Properties, 'StackPolicyURL') as stack_policy_url, + json_extract_path_text(Properties, 'StackStatus') as stack_status, + json_extract_path_text(Properties, 'StackStatusReason') as stack_status_reason, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'TemplateBody') as template_body, + json_extract_path_text(Properties, 'TemplateURL') as template_url, + json_extract_path_text(Properties, 'TimeoutInMinutes') as timeout_in_minutes, + json_extract_path_text(Properties, 'LastUpdateTime') as last_update_time, + json_extract_path_text(Properties, 'CreationTime') as creation_time + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFormation::Stack' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'StackId') as stack_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::Stack' + AND region = 'us-east-1' stack_sets: name: stack_sets id: aws.cloudformation.stack_sets @@ -3365,7 +3247,7 @@ components: x-cfn-type-name: AWS::CloudFormation::StackSet x-identifiers: - StackSetId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3382,9 +3264,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3394,41 +3276,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/stack_sets/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/stack_sets/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.StackSetId') as stack_set_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::StackSet' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'StackSetId') as stack_set_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::StackSet' - AND region = 'us-east-1' - stack_set: - name: stack_set - id: aws.cloudformation.stack_set - x-cfn-schema-name: StackSet - x-cfn-type-name: AWS::CloudFormation::StackSet - x-identifiers: - - StackSetId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3439,12 +3289,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/stack_sets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/stack_sets/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/stack_set/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/stack_sets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3469,30 +3323,46 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'StackSetName') as stack_set_name, - json_extract_path_text(Properties, 'StackSetId') as stack_set_id, - json_extract_path_text(Properties, 'AdministrationRoleARN') as administration_role_arn, - json_extract_path_text(Properties, 'AutoDeployment') as auto_deployment, - json_extract_path_text(Properties, 'Capabilities') as capabilities, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'ExecutionRoleName') as execution_role_name, - json_extract_path_text(Properties, 'OperationPreferences') as operation_preferences, - json_extract_path_text(Properties, 'StackInstancesGroup') as stack_instances_group, - json_extract_path_text(Properties, 'Parameters') as parameters, - json_extract_path_text(Properties, 'PermissionModel') as permission_model, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'TemplateBody') as template_body, - json_extract_path_text(Properties, 'TemplateURL') as template_url, - json_extract_path_text(Properties, 'CallAs') as call_as, - json_extract_path_text(Properties, 'ManagedExecution') as managed_execution - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFormation::StackSet' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.StackSetId') as stack_set_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::StackSet' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'StackSetName') as stack_set_name, + json_extract_path_text(Properties, 'StackSetId') as stack_set_id, + json_extract_path_text(Properties, 'AdministrationRoleARN') as administration_role_arn, + json_extract_path_text(Properties, 'AutoDeployment') as auto_deployment, + json_extract_path_text(Properties, 'Capabilities') as capabilities, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'ExecutionRoleName') as execution_role_name, + json_extract_path_text(Properties, 'OperationPreferences') as operation_preferences, + json_extract_path_text(Properties, 'StackInstancesGroup') as stack_instances_group, + json_extract_path_text(Properties, 'Parameters') as parameters, + json_extract_path_text(Properties, 'PermissionModel') as permission_model, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'TemplateBody') as template_body, + json_extract_path_text(Properties, 'TemplateURL') as template_url, + json_extract_path_text(Properties, 'CallAs') as call_as, + json_extract_path_text(Properties, 'ManagedExecution') as managed_execution + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFormation::StackSet' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'StackSetId') as stack_set_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::StackSet' + AND region = 'us-east-1' type_activations: name: type_activations id: aws.cloudformation.type_activations @@ -3500,7 +3370,7 @@ components: x-cfn-type-name: AWS::CloudFormation::TypeActivation x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3517,9 +3387,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3529,41 +3399,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/type_activations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/type_activations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::TypeActivation' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::TypeActivation' - AND region = 'us-east-1' - type_activation: - name: type_activation - id: aws.cloudformation.type_activation - x-cfn-schema-name: TypeActivation - x-cfn-type-name: AWS::CloudFormation::TypeActivation - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3574,12 +3412,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/type_activations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/type_activations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/type_activation/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/type_activations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3599,25 +3441,41 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'ExecutionRoleArn') as execution_role_arn, - json_extract_path_text(Properties, 'PublisherId') as publisher_id, - json_extract_path_text(Properties, 'LoggingConfig') as logging_config, - json_extract_path_text(Properties, 'PublicTypeArn') as public_type_arn, - json_extract_path_text(Properties, 'AutoUpdate') as auto_update, - json_extract_path_text(Properties, 'TypeNameAlias') as type_name_alias, - json_extract_path_text(Properties, 'VersionBump') as version_bump, - json_extract_path_text(Properties, 'MajorVersion') as major_version, - json_extract_path_text(Properties, 'TypeName') as type_name, - json_extract_path_text(Properties, 'Type') as type - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFormation::TypeActivation' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::TypeActivation' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'ExecutionRoleArn') as execution_role_arn, + json_extract_path_text(Properties, 'PublisherId') as publisher_id, + json_extract_path_text(Properties, 'LoggingConfig') as logging_config, + json_extract_path_text(Properties, 'PublicTypeArn') as public_type_arn, + json_extract_path_text(Properties, 'AutoUpdate') as auto_update, + json_extract_path_text(Properties, 'TypeNameAlias') as type_name_alias, + json_extract_path_text(Properties, 'VersionBump') as version_bump, + json_extract_path_text(Properties, 'MajorVersion') as major_version, + json_extract_path_text(Properties, 'TypeName') as type_name, + json_extract_path_text(Properties, 'Type') as type + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFormation::TypeActivation' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFormation::TypeActivation' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/cloudfront.yaml b/providers/src/aws/v00.00.00000/services/cloudfront.yaml index 9b007988..0049c8f6 100644 --- a/providers/src/aws/v00.00.00000/services/cloudfront.yaml +++ b/providers/src/aws/v00.00.00000/services/cloudfront.yaml @@ -2891,7 +2891,7 @@ components: x-cfn-type-name: AWS::CloudFront::CachePolicy x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2908,9 +2908,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2920,41 +2920,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/cache_policies/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/cache_policies/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::CachePolicy' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::CachePolicy' - AND region = 'us-east-1' - cache_policy: - name: cache_policy - id: aws.cloudfront.cache_policy - x-cfn-schema-name: CachePolicy - x-cfn-type-name: AWS::CloudFront::CachePolicy - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2965,12 +2933,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/cache_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/cache_policies/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/cache_policy/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/cache_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2982,17 +2954,33 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'CachePolicyConfig') as cache_policy_config, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'LastModifiedTime') as last_modified_time - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFront::CachePolicy' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::CachePolicy' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'CachePolicyConfig') as cache_policy_config, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'LastModifiedTime') as last_modified_time + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFront::CachePolicy' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::CachePolicy' + AND region = 'us-east-1' cloud_front_origin_access_identities: name: cloud_front_origin_access_identities id: aws.cloudfront.cloud_front_origin_access_identities @@ -3000,7 +2988,7 @@ components: x-cfn-type-name: AWS::CloudFront::CloudFrontOriginAccessIdentity x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3017,9 +3005,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3029,41 +3017,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/cloud_front_origin_access_identities/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/cloud_front_origin_access_identities/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::CloudFrontOriginAccessIdentity' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::CloudFrontOriginAccessIdentity' - AND region = 'us-east-1' - cloud_front_origin_access_identity: - name: cloud_front_origin_access_identity - id: aws.cloudfront.cloud_front_origin_access_identity - x-cfn-schema-name: CloudFrontOriginAccessIdentity - x-cfn-type-name: AWS::CloudFront::CloudFrontOriginAccessIdentity - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3074,12 +3030,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/cloud_front_origin_access_identities/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/cloud_front_origin_access_identities/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/cloud_front_origin_access_identity/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/cloud_front_origin_access_identities/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3091,17 +3051,33 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'CloudFrontOriginAccessIdentityConfig') as cloud_front_origin_access_identity_config, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'S3CanonicalUserId') as s3_canonical_user_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFront::CloudFrontOriginAccessIdentity' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::CloudFrontOriginAccessIdentity' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'CloudFrontOriginAccessIdentityConfig') as cloud_front_origin_access_identity_config, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'S3CanonicalUserId') as s3_canonical_user_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFront::CloudFrontOriginAccessIdentity' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::CloudFrontOriginAccessIdentity' + AND region = 'us-east-1' continuous_deployment_policies: name: continuous_deployment_policies id: aws.cloudfront.continuous_deployment_policies @@ -3109,7 +3085,7 @@ components: x-cfn-type-name: AWS::CloudFront::ContinuousDeploymentPolicy x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3126,9 +3102,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3138,41 +3114,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/continuous_deployment_policies/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/continuous_deployment_policies/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::ContinuousDeploymentPolicy' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::ContinuousDeploymentPolicy' - AND region = 'us-east-1' - continuous_deployment_policy: - name: continuous_deployment_policy - id: aws.cloudfront.continuous_deployment_policy - x-cfn-schema-name: ContinuousDeploymentPolicy - x-cfn-type-name: AWS::CloudFront::ContinuousDeploymentPolicy - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3183,12 +3127,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/continuous_deployment_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/continuous_deployment_policies/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/continuous_deployment_policy/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/continuous_deployment_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3200,17 +3148,33 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ContinuousDeploymentPolicyConfig') as continuous_deployment_policy_config, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'LastModifiedTime') as last_modified_time - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFront::ContinuousDeploymentPolicy' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::ContinuousDeploymentPolicy' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ContinuousDeploymentPolicyConfig') as continuous_deployment_policy_config, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'LastModifiedTime') as last_modified_time + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFront::ContinuousDeploymentPolicy' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::ContinuousDeploymentPolicy' + AND region = 'us-east-1' distributions: name: distributions id: aws.cloudfront.distributions @@ -3218,7 +3182,7 @@ components: x-cfn-type-name: AWS::CloudFront::Distribution x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3235,9 +3199,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3247,41 +3211,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/distributions/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/distributions/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::Distribution' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::Distribution' - AND region = 'us-east-1' - distribution: - name: distribution - id: aws.cloudfront.distribution - x-cfn-schema-name: Distribution - x-cfn-type-name: AWS::CloudFront::Distribution - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3292,12 +3224,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/distributions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/distributions/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/distribution/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/distributions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3310,18 +3246,34 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'DistributionConfig') as distribution_config, - json_extract_path_text(Properties, 'DomainName') as domain_name, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFront::Distribution' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::Distribution' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DistributionConfig') as distribution_config, + json_extract_path_text(Properties, 'DomainName') as domain_name, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFront::Distribution' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::Distribution' + AND region = 'us-east-1' functions: name: functions id: aws.cloudfront.functions @@ -3329,7 +3281,7 @@ components: x-cfn-type-name: AWS::CloudFront::Function x-identifiers: - FunctionARN - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3346,9 +3298,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3358,41 +3310,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/functions/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/functions/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.FunctionARN') as function_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::Function' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'FunctionARN') as function_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::Function' - AND region = 'us-east-1' - function: - name: function - id: aws.cloudfront.function - x-cfn-schema-name: Function - x-cfn-type-name: AWS::CloudFront::Function - x-identifiers: - - FunctionARN - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3403,12 +3323,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/functions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/functions/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/function/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/functions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3424,21 +3348,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AutoPublish') as auto_publish, - json_extract_path_text(Properties, 'FunctionARN') as function_arn, - json_extract_path_text(Properties, 'FunctionCode') as function_code, - json_extract_path_text(Properties, 'FunctionConfig') as function_config, - json_extract_path_text(Properties, 'FunctionMetadata') as function_metadata, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Stage') as stage - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFront::Function' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.FunctionARN') as function_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::Function' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AutoPublish') as auto_publish, + json_extract_path_text(Properties, 'FunctionARN') as function_arn, + json_extract_path_text(Properties, 'FunctionCode') as function_code, + json_extract_path_text(Properties, 'FunctionConfig') as function_config, + json_extract_path_text(Properties, 'FunctionMetadata') as function_metadata, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Stage') as stage + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFront::Function' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'FunctionARN') as function_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::Function' + AND region = 'us-east-1' key_groups: name: key_groups id: aws.cloudfront.key_groups @@ -3446,7 +3386,7 @@ components: x-cfn-type-name: AWS::CloudFront::KeyGroup x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3463,9 +3403,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3475,41 +3415,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/key_groups/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/key_groups/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::KeyGroup' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::KeyGroup' - AND region = 'us-east-1' - key_group: - name: key_group - id: aws.cloudfront.key_group - x-cfn-schema-name: KeyGroup - x-cfn-type-name: AWS::CloudFront::KeyGroup - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3520,12 +3428,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/key_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/key_groups/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/key_group/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/key_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3537,17 +3449,33 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'KeyGroupConfig') as key_group_config, - json_extract_path_text(Properties, 'LastModifiedTime') as last_modified_time - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFront::KeyGroup' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::KeyGroup' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'KeyGroupConfig') as key_group_config, + json_extract_path_text(Properties, 'LastModifiedTime') as last_modified_time + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFront::KeyGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::KeyGroup' + AND region = 'us-east-1' key_value_stores: name: key_value_stores id: aws.cloudfront.key_value_stores @@ -3555,7 +3483,7 @@ components: x-cfn-type-name: AWS::CloudFront::KeyValueStore x-identifiers: - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3572,9 +3500,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3584,41 +3512,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/key_value_stores/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/key_value_stores/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::KeyValueStore' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::KeyValueStore' - AND region = 'us-east-1' - key_value_store: - name: key_value_store - id: aws.cloudfront.key_value_store - x-cfn-schema-name: KeyValueStore - x-cfn-type-name: AWS::CloudFront::KeyValueStore - x-identifiers: - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3629,12 +3525,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/key_value_stores/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/key_value_stores/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/key_value_store/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/key_value_stores/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3649,20 +3549,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Comment') as comment, - json_extract_path_text(Properties, 'ImportSource') as import_source - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFront::KeyValueStore' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::KeyValueStore' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Comment') as comment, + json_extract_path_text(Properties, 'ImportSource') as import_source + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFront::KeyValueStore' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::KeyValueStore' + AND region = 'us-east-1' monitoring_subscriptions: name: monitoring_subscriptions id: aws.cloudfront.monitoring_subscriptions @@ -3670,7 +3586,7 @@ components: x-cfn-type-name: AWS::CloudFront::MonitoringSubscription x-identifiers: - DistributionId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3704,21 +3620,11 @@ components: - $ref: '#/components/x-stackQL-resources/monitoring_subscriptions/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/monitoring_subscriptions/methods/delete_resource' - monitoring_subscription: - name: monitoring_subscription - id: aws.cloudfront.monitoring_subscription - x-cfn-schema-name: MonitoringSubscription - x-cfn-type-name: AWS::CloudFront::MonitoringSubscription - x-identifiers: - - DistributionId - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3729,7 +3635,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3746,7 +3652,7 @@ components: x-cfn-type-name: AWS::CloudFront::OriginAccessControl x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3763,9 +3669,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3775,41 +3681,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/origin_access_controls/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/origin_access_controls/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::OriginAccessControl' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::OriginAccessControl' - AND region = 'us-east-1' - origin_access_control: - name: origin_access_control - id: aws.cloudfront.origin_access_control - x-cfn-schema-name: OriginAccessControl - x-cfn-type-name: AWS::CloudFront::OriginAccessControl - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3820,12 +3694,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/origin_access_controls/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/origin_access_controls/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/origin_access_control/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/origin_access_controls/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3836,16 +3714,32 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'OriginAccessControlConfig') as origin_access_control_config - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFront::OriginAccessControl' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::OriginAccessControl' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'OriginAccessControlConfig') as origin_access_control_config + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFront::OriginAccessControl' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::OriginAccessControl' + AND region = 'us-east-1' origin_request_policies: name: origin_request_policies id: aws.cloudfront.origin_request_policies @@ -3853,7 +3747,7 @@ components: x-cfn-type-name: AWS::CloudFront::OriginRequestPolicy x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3870,9 +3764,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3882,41 +3776,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/origin_request_policies/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/origin_request_policies/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::OriginRequestPolicy' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::OriginRequestPolicy' - AND region = 'us-east-1' - origin_request_policy: - name: origin_request_policy - id: aws.cloudfront.origin_request_policy - x-cfn-schema-name: OriginRequestPolicy - x-cfn-type-name: AWS::CloudFront::OriginRequestPolicy - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3927,12 +3789,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/origin_request_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/origin_request_policies/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/origin_request_policy/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/origin_request_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3944,17 +3810,33 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'LastModifiedTime') as last_modified_time, - json_extract_path_text(Properties, 'OriginRequestPolicyConfig') as origin_request_policy_config - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFront::OriginRequestPolicy' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::OriginRequestPolicy' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'LastModifiedTime') as last_modified_time, + json_extract_path_text(Properties, 'OriginRequestPolicyConfig') as origin_request_policy_config + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFront::OriginRequestPolicy' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::OriginRequestPolicy' + AND region = 'us-east-1' public_keys: name: public_keys id: aws.cloudfront.public_keys @@ -3962,7 +3844,7 @@ components: x-cfn-type-name: AWS::CloudFront::PublicKey x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3979,9 +3861,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3991,41 +3873,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/public_keys/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/public_keys/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::PublicKey' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::PublicKey' - AND region = 'us-east-1' - public_key: - name: public_key - id: aws.cloudfront.public_key - x-cfn-schema-name: PublicKey - x-cfn-type-name: AWS::CloudFront::PublicKey - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -4036,12 +3886,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/public_keys/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/public_keys/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/public_key/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/public_keys/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -4053,17 +3907,33 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'CreatedTime') as created_time, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'PublicKeyConfig') as public_key_config - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFront::PublicKey' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::PublicKey' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'CreatedTime') as created_time, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'PublicKeyConfig') as public_key_config + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFront::PublicKey' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::PublicKey' + AND region = 'us-east-1' realtime_log_configs: name: realtime_log_configs id: aws.cloudfront.realtime_log_configs @@ -4071,7 +3941,7 @@ components: x-cfn-type-name: AWS::CloudFront::RealtimeLogConfig x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -4088,9 +3958,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -4100,41 +3970,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/realtime_log_configs/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/realtime_log_configs/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::RealtimeLogConfig' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::RealtimeLogConfig' - AND region = 'us-east-1' - realtime_log_config: - name: realtime_log_config - id: aws.cloudfront.realtime_log_config - x-cfn-schema-name: RealtimeLogConfig - x-cfn-type-name: AWS::CloudFront::RealtimeLogConfig - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -4145,12 +3983,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/realtime_log_configs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/realtime_log_configs/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/realtime_log_config/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/realtime_log_configs/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -4164,19 +4006,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'EndPoints') as end_points, - json_extract_path_text(Properties, 'Fields') as fields, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'SamplingRate') as sampling_rate - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFront::RealtimeLogConfig' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::RealtimeLogConfig' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'EndPoints') as end_points, + json_extract_path_text(Properties, 'Fields') as fields, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'SamplingRate') as sampling_rate + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFront::RealtimeLogConfig' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::RealtimeLogConfig' + AND region = 'us-east-1' response_headers_policies: name: response_headers_policies id: aws.cloudfront.response_headers_policies @@ -4184,7 +4042,7 @@ components: x-cfn-type-name: AWS::CloudFront::ResponseHeadersPolicy x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -4201,9 +4059,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -4213,41 +4071,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/response_headers_policies/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/response_headers_policies/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::ResponseHeadersPolicy' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::ResponseHeadersPolicy' - AND region = 'us-east-1' - response_headers_policy: - name: response_headers_policy - id: aws.cloudfront.response_headers_policy - x-cfn-schema-name: ResponseHeadersPolicy - x-cfn-type-name: AWS::CloudFront::ResponseHeadersPolicy - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -4258,12 +4084,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/response_headers_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/response_headers_policies/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/response_headers_policy/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/response_headers_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -4275,17 +4105,33 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'LastModifiedTime') as last_modified_time, - json_extract_path_text(Properties, 'ResponseHeadersPolicyConfig') as response_headers_policy_config - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFront::ResponseHeadersPolicy' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::ResponseHeadersPolicy' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'LastModifiedTime') as last_modified_time, + json_extract_path_text(Properties, 'ResponseHeadersPolicyConfig') as response_headers_policy_config + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CloudFront::ResponseHeadersPolicy' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudFront::ResponseHeadersPolicy' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/cloudtrail.yaml b/providers/src/aws/v00.00.00000/services/cloudtrail.yaml index a532817a..9d609e75 100644 --- a/providers/src/aws/v00.00.00000/services/cloudtrail.yaml +++ b/providers/src/aws/v00.00.00000/services/cloudtrail.yaml @@ -1225,7 +1225,7 @@ components: x-cfn-type-name: AWS::CloudTrail::Channel x-identifiers: - ChannelArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1242,9 +1242,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1254,41 +1254,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/channels/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/channels/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ChannelArn') as channel_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudTrail::Channel' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ChannelArn') as channel_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudTrail::Channel' - AND region = 'us-east-1' - channel: - name: channel - id: aws.cloudtrail.channel - x-cfn-schema-name: Channel - x-cfn-type-name: AWS::CloudTrail::Channel - x-identifiers: - - ChannelArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1299,12 +1267,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/channels/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/channels/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/channel/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/channels/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1318,19 +1290,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Source') as source, - json_extract_path_text(Properties, 'Destinations') as destinations, - json_extract_path_text(Properties, 'ChannelArn') as channel_arn, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CloudTrail::Channel' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ChannelArn') as channel_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudTrail::Channel' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Source') as source, + json_extract_path_text(Properties, 'Destinations') as destinations, + json_extract_path_text(Properties, 'ChannelArn') as channel_arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CloudTrail::Channel' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ChannelArn') as channel_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudTrail::Channel' + AND region = 'us-east-1' event_data_stores: name: event_data_stores id: aws.cloudtrail.event_data_stores @@ -1338,7 +1326,7 @@ components: x-cfn-type-name: AWS::CloudTrail::EventDataStore x-identifiers: - EventDataStoreArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1355,9 +1343,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1367,41 +1355,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/event_data_stores/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/event_data_stores/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.EventDataStoreArn') as event_data_store_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudTrail::EventDataStore' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'EventDataStoreArn') as event_data_store_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudTrail::EventDataStore' - AND region = 'us-east-1' - event_data_store: - name: event_data_store - id: aws.cloudtrail.event_data_store - x-cfn-schema-name: EventDataStore - x-cfn-type-name: AWS::CloudTrail::EventDataStore - x-identifiers: - - EventDataStoreArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1412,12 +1368,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/event_data_stores/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/event_data_stores/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/event_data_store/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/event_data_stores/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1444,32 +1404,48 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AdvancedEventSelectors') as advanced_event_selectors, - json_extract_path_text(Properties, 'CreatedTimestamp') as created_timestamp, - json_extract_path_text(Properties, 'EventDataStoreArn') as event_data_store_arn, - json_extract_path_text(Properties, 'FederationEnabled') as federation_enabled, - json_extract_path_text(Properties, 'FederationRoleArn') as federation_role_arn, - json_extract_path_text(Properties, 'MultiRegionEnabled') as multi_region_enabled, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'OrganizationEnabled') as organization_enabled, - json_extract_path_text(Properties, 'BillingMode') as billing_mode, - json_extract_path_text(Properties, 'RetentionPeriod') as retention_period, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'TerminationProtectionEnabled') as termination_protection_enabled, - json_extract_path_text(Properties, 'UpdatedTimestamp') as updated_timestamp, - json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'InsightSelectors') as insight_selectors, - json_extract_path_text(Properties, 'InsightsDestination') as insights_destination, - json_extract_path_text(Properties, 'IngestionEnabled') as ingestion_enabled - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CloudTrail::EventDataStore' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.EventDataStoreArn') as event_data_store_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudTrail::EventDataStore' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AdvancedEventSelectors') as advanced_event_selectors, + json_extract_path_text(Properties, 'CreatedTimestamp') as created_timestamp, + json_extract_path_text(Properties, 'EventDataStoreArn') as event_data_store_arn, + json_extract_path_text(Properties, 'FederationEnabled') as federation_enabled, + json_extract_path_text(Properties, 'FederationRoleArn') as federation_role_arn, + json_extract_path_text(Properties, 'MultiRegionEnabled') as multi_region_enabled, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'OrganizationEnabled') as organization_enabled, + json_extract_path_text(Properties, 'BillingMode') as billing_mode, + json_extract_path_text(Properties, 'RetentionPeriod') as retention_period, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'TerminationProtectionEnabled') as termination_protection_enabled, + json_extract_path_text(Properties, 'UpdatedTimestamp') as updated_timestamp, + json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'InsightSelectors') as insight_selectors, + json_extract_path_text(Properties, 'InsightsDestination') as insights_destination, + json_extract_path_text(Properties, 'IngestionEnabled') as ingestion_enabled + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CloudTrail::EventDataStore' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'EventDataStoreArn') as event_data_store_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudTrail::EventDataStore' + AND region = 'us-east-1' resource_policies: name: resource_policies id: aws.cloudtrail.resource_policies @@ -1477,7 +1453,7 @@ components: x-cfn-type-name: AWS::CloudTrail::ResourcePolicy x-identifiers: - ResourceArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1494,9 +1470,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1506,23 +1482,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/resource_policies/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/resource_policies/methods/delete_resource' - resource_policy: - name: resource_policy - id: aws.cloudtrail.resource_policy - x-cfn-schema-name: ResourcePolicy - x-cfn-type-name: AWS::CloudTrail::ResourcePolicy - x-identifiers: - - ResourceArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1533,12 +1495,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/resource_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/resource_policies/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/resource_policy/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/resource_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1549,7 +1515,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1566,7 +1532,7 @@ components: x-cfn-type-name: AWS::CloudTrail::Trail x-identifiers: - TrailName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1583,9 +1549,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1595,41 +1561,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/trails/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/trails/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.TrailName') as trail_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudTrail::Trail' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'TrailName') as trail_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudTrail::Trail' - AND region = 'us-east-1' - trail: - name: trail - id: aws.cloudtrail.trail - x-cfn-schema-name: Trail - x-cfn-type-name: AWS::CloudTrail::Trail - x-identifiers: - - TrailName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1640,12 +1574,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/trails/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/trails/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/trail/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/trails/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1672,32 +1610,48 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'CloudWatchLogsLogGroupArn') as cloud_watch_logs_log_group_arn, - json_extract_path_text(Properties, 'CloudWatchLogsRoleArn') as cloud_watch_logs_role_arn, - json_extract_path_text(Properties, 'EnableLogFileValidation') as enable_log_file_validation, - json_extract_path_text(Properties, 'AdvancedEventSelectors') as advanced_event_selectors, - json_extract_path_text(Properties, 'EventSelectors') as event_selectors, - json_extract_path_text(Properties, 'IncludeGlobalServiceEvents') as include_global_service_events, - json_extract_path_text(Properties, 'IsLogging') as is_logging, - json_extract_path_text(Properties, 'IsMultiRegionTrail') as is_multi_region_trail, - json_extract_path_text(Properties, 'IsOrganizationTrail') as is_organization_trail, - json_extract_path_text(Properties, 'KMSKeyId') as kms_key_id, - json_extract_path_text(Properties, 'S3BucketName') as s3_bucket_name, - json_extract_path_text(Properties, 'S3KeyPrefix') as s3_key_prefix, - json_extract_path_text(Properties, 'SnsTopicName') as sns_topic_name, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'TrailName') as trail_name, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'SnsTopicArn') as sns_topic_arn, - json_extract_path_text(Properties, 'InsightSelectors') as insight_selectors - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CloudTrail::Trail' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.TrailName') as trail_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudTrail::Trail' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'CloudWatchLogsLogGroupArn') as cloud_watch_logs_log_group_arn, + json_extract_path_text(Properties, 'CloudWatchLogsRoleArn') as cloud_watch_logs_role_arn, + json_extract_path_text(Properties, 'EnableLogFileValidation') as enable_log_file_validation, + json_extract_path_text(Properties, 'AdvancedEventSelectors') as advanced_event_selectors, + json_extract_path_text(Properties, 'EventSelectors') as event_selectors, + json_extract_path_text(Properties, 'IncludeGlobalServiceEvents') as include_global_service_events, + json_extract_path_text(Properties, 'IsLogging') as is_logging, + json_extract_path_text(Properties, 'IsMultiRegionTrail') as is_multi_region_trail, + json_extract_path_text(Properties, 'IsOrganizationTrail') as is_organization_trail, + json_extract_path_text(Properties, 'KMSKeyId') as kms_key_id, + json_extract_path_text(Properties, 'S3BucketName') as s3_bucket_name, + json_extract_path_text(Properties, 'S3KeyPrefix') as s3_key_prefix, + json_extract_path_text(Properties, 'SnsTopicName') as sns_topic_name, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'TrailName') as trail_name, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'SnsTopicArn') as sns_topic_arn, + json_extract_path_text(Properties, 'InsightSelectors') as insight_selectors + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CloudTrail::Trail' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'TrailName') as trail_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudTrail::Trail' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/cloudwatch.yaml b/providers/src/aws/v00.00.00000/services/cloudwatch.yaml index d08e2bef..a0dce82a 100644 --- a/providers/src/aws/v00.00.00000/services/cloudwatch.yaml +++ b/providers/src/aws/v00.00.00000/services/cloudwatch.yaml @@ -385,6 +385,413 @@ components: $ref: '#/components/x-cloud-control-schemas/ProgressEvent' type: object schemas: + AccountId: + type: string + pattern: ^\d{12}$ + minLength: 12 + maxLength: 12 + AccountIds: + type: array + items: + $ref: '#/components/schemas/AccountId' + minItems: 0 + maxItems: 20 + Arn: + type: string + CreateLogGroupRequest: + type: object + required: + - logGroupName + title: CreateLogGroupRequest + properties: + logGroupName: + allOf: + - $ref: '#/components/schemas/LogGroupName' + - description: The name of the log group. + kmsKeyId: + allOf: + - $ref: '#/components/schemas/KmsKeyId' + - description: The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data. For more information, see Amazon Resource Names. + tags: + allOf: + - $ref: '#/components/schemas/Tags' + - description: >- +

The key-value pairs to use for the tags.

You can grant users access to certain log groups while preventing them from accessing other log groups. To do so, tag your groups and use IAM policies that refer to those tags. To assign tags when you create a log group, you must have either the logs:TagResource or logs:TagLogGroup permission. For more information about tagging, see Tagging Amazon Web Services resources. For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags.

+ CreateLogStreamRequest: + type: object + required: + - logGroupName + - logStreamName + title: CreateLogStreamRequest + properties: + logGroupName: + allOf: + - $ref: '#/components/schemas/LogGroupName' + - description: The name of the log group. + logStreamName: + allOf: + - $ref: '#/components/schemas/LogStreamName' + - description: The name of the log stream. + DataProtectionStatus: + type: string + enum: + - ACTIVATED + - DELETED + - ARCHIVED + - DISABLED + Days: + type: integer + description: '

The number of days to retain the log events in the specified log group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1096, 1827, 2192, 2557, 2922, 3288, and 3653.

To set a log group so that its log events do not expire, use DeleteRetentionPolicy.

' + DeleteLogGroupRequest: + type: object + required: + - logGroupName + title: DeleteLogGroupRequest + properties: + logGroupName: + allOf: + - $ref: '#/components/schemas/LogGroupName' + - description: The name of the log group. + DeleteLogStreamRequest: + type: object + required: + - logGroupName + - logStreamName + title: DeleteLogStreamRequest + properties: + logGroupName: + allOf: + - $ref: '#/components/schemas/LogGroupName' + - description: The name of the log group. + logStreamName: + allOf: + - $ref: '#/components/schemas/LogStreamName' + - description: The name of the log stream. + Descending: + type: boolean + DescribeLimit: + type: integer + minimum: 1 + maximum: 50 + DescribeLogGroupsRequest: + type: object + title: DescribeLogGroupsRequest + properties: + accountIdentifiers: + allOf: + - $ref: '#/components/schemas/AccountIds' + - description: 'When includeLinkedAccounts is set to True, use this parameter to specify the list of accounts to search. You can specify as many as 20 account IDs in the array. ' + logGroupNamePrefix: + allOf: + - $ref: '#/components/schemas/LogGroupName' + - description:

The prefix to match.

logGroupNamePrefix and logGroupNamePattern are mutually exclusive. Only one of these parameters can be passed.

+ logGroupNamePattern: + allOf: + - $ref: '#/components/schemas/LogGroupNamePattern' + - description: >- +

If you specify a string for this parameter, the operation returns only log groups that have names that match the string based on a case-sensitive substring search. For example, if you specify Foo, log groups named FooBar, aws/Foo, and GroupFoo would match, but foo, F/o/o and Froo would not match.

If you specify logGroupNamePattern in your request, then only + arn, creationTime, and logGroupName are included in the response.

logGroupNamePattern and logGroupNamePrefix are mutually exclusive. Only one of these parameters can be passed.

+ nextToken: + allOf: + - $ref: '#/components/schemas/NextToken' + - description: The token for the next set of items to return. (You received this token from a previous call.) + limit: + allOf: + - $ref: '#/components/schemas/DescribeLimit' + - description: The maximum number of items returned. If you don't specify a value, the default is up to 50 items. + includeLinkedAccounts: + allOf: + - $ref: '#/components/schemas/IncludeLinkedAccounts' + - description:

If you are using a monitoring account, set this to True to have the operation return log groups in the accounts listed in accountIdentifiers.

If this parameter is set to true and accountIdentifiers contains a null value, the operation returns all log groups in the monitoring account and all log groups in all source accounts that are linked to the monitoring account.

+ DescribeLogGroupsResponse: + type: object + properties: + logGroups: + $ref: '#/components/schemas/LogGroups' + nextToken: + $ref: '#/components/schemas/NextToken' + DescribeLogStreamsRequest: + type: object + title: DescribeLogStreamsRequest + properties: + logGroupName: + allOf: + - $ref: '#/components/schemas/LogGroupName' + - description:

The name of the log group.

You must include either logGroupIdentifier or logGroupName, but not both.

+ logGroupIdentifier: + allOf: + - $ref: '#/components/schemas/LogGroupIdentifier' + - description:

Specify either the name or ARN of the log group to view. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN.

You must include either logGroupIdentifier or logGroupName, but not both.

+ logStreamNamePrefix: + allOf: + - $ref: '#/components/schemas/LogStreamName' + - description:

The prefix to match.

If orderBy is LastEventTime, you cannot specify this parameter.

+ orderBy: + allOf: + - $ref: '#/components/schemas/OrderBy' + - description: >- +

If the value is LogStreamName, the results are ordered by log stream name. If the value is LastEventTime, the results are ordered by the event time. The default value is LogStreamName.

If you order the results by event time, you cannot specify the logStreamNamePrefix parameter.

lastEventTimestamp represents the time of the most recent log event in the log stream in CloudWatch Logs. This number is + expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. lastEventTimestamp updates on an eventual consistency basis. It typically updates in less than an hour from ingestion, but in rare situations might take longer.

+ descending: + allOf: + - $ref: '#/components/schemas/Descending' + - description: If the value is true, results are returned in descending order. If the value is to false, results are returned in ascending order. The default value is false. + nextToken: + allOf: + - $ref: '#/components/schemas/NextToken' + - description: The token for the next set of items to return. (You received this token from a previous call.) + limit: + allOf: + - $ref: '#/components/schemas/DescribeLimit' + - description: The maximum number of items returned. If you don't specify a value, the default is up to 50 items. + DescribeLogStreamsResponse: + type: object + properties: + logStreams: + $ref: '#/components/schemas/LogStreams' + nextToken: + $ref: '#/components/schemas/NextToken' + EventMessage: + type: string + minLength: 1 + EventsLimit: + type: integer + minimum: 1 + maximum: 10000 + FilterCount: + type: integer + GetLogEventsRequest: + type: object + required: + - logStreamName + title: GetLogEventsRequest + properties: + logGroupName: + allOf: + - $ref: '#/components/schemas/LogGroupName' + - description:

The name of the log group.

You must include either logGroupIdentifier or logGroupName, but not both.

+ logGroupIdentifier: + allOf: + - $ref: '#/components/schemas/LogGroupIdentifier' + - description:

Specify either the name or ARN of the log group to view events from. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN.

You must include either logGroupIdentifier or logGroupName, but not both.

+ logStreamName: + allOf: + - $ref: '#/components/schemas/LogStreamName' + - description: The name of the log stream. + startTime: + allOf: + - $ref: '#/components/schemas/Timestamp' + - description: The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp equal to this time or later than this time are included. Events with a timestamp earlier than this time are not included. + endTime: + allOf: + - $ref: '#/components/schemas/Timestamp' + - description: The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp equal to or later than this time are not included. + nextToken: + allOf: + - $ref: '#/components/schemas/NextToken' + - description: The token for the next set of items to return. (You received this token from a previous call.) + limit: + allOf: + - $ref: '#/components/schemas/EventsLimit' + - description: The maximum number of log events returned. If you don't specify a limit, the default is as many log events as can fit in a response size of 1 MB (up to 10,000 log events). + startFromHead: + allOf: + - $ref: '#/components/schemas/StartFromHead' + - description:

If the value is true, the earliest log events are returned first. If the value is false, the latest log events are returned first. The default value is false.

If you are using a previous nextForwardToken value as the nextToken in this operation, you must specify true for startFromHead.

+ unmask: + allOf: + - $ref: '#/components/schemas/Unmask' + - description:

Specify true to display the log event fields with all sensitive data unmasked and visible. The default is false.

To use this operation with this parameter, you must be signed into an account with the logs:Unmask permission.

+ GetLogEventsResponse: + type: object + properties: + events: + $ref: '#/components/schemas/OutputLogEvents' + nextForwardToken: + allOf: + - $ref: '#/components/schemas/NextToken' + - description: The token for the next set of items in the forward direction. The token expires after 24 hours. If you have reached the end of the stream, it returns the same token you passed in. + nextBackwardToken: + allOf: + - $ref: '#/components/schemas/NextToken' + - description: The token for the next set of items in the backward direction. The token expires after 24 hours. This token is not null. If you have reached the end of the stream, it returns the same token you passed in. + IncludeLinkedAccounts: + type: boolean + InheritedProperties: + type: array + items: + $ref: '#/components/schemas/InheritedProperty' + InheritedProperty: + type: string + enum: + - ACCOUNT_DATA_PROTECTION + InvalidParameterException: {} + KmsKeyId: + type: string + maxLength: 256 + LimitExceededException: {} + LogGroup: + type: object + properties: + logGroupName: + allOf: + - $ref: '#/components/schemas/LogGroupName' + - description: The name of the log group. + creationTime: + allOf: + - $ref: '#/components/schemas/Timestamp' + - description: The creation time of the log group, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. + retentionInDays: + $ref: '#/components/schemas/Days' + metricFilterCount: + allOf: + - $ref: '#/components/schemas/FilterCount' + - description: The number of metric filters. + arn: + allOf: + - $ref: '#/components/schemas/Arn' + - description: The Amazon Resource Name (ARN) of the log group. + storedBytes: + allOf: + - $ref: '#/components/schemas/StoredBytes' + - description: The number of bytes stored. + kmsKeyId: + allOf: + - $ref: '#/components/schemas/KmsKeyId' + - description: The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data. + dataProtectionStatus: + allOf: + - $ref: '#/components/schemas/DataProtectionStatus' + - description: Displays whether this log group has a protection policy, or whether it had one in the past. For more information, see PutDataProtectionPolicy. + inheritedProperties: + allOf: + - $ref: '#/components/schemas/InheritedProperties' + - description: Displays all the properties that this log group has inherited from account-level settings. + description: Represents a log group. + LogGroupIdentifier: + type: string + pattern: '[\w#+=/:,.@-]*' + minLength: 1 + maxLength: 2048 + LogGroupName: + type: string + pattern: '[\.\-_/#A-Za-z0-9]+' + minLength: 1 + maxLength: 512 + LogGroupNamePattern: + type: string + pattern: '[\.\-_/#A-Za-z0-9]*' + minLength: 0 + maxLength: 512 + LogGroups: + type: array + items: + $ref: '#/components/schemas/LogGroup' + LogStream: + type: object + properties: + logStreamName: + allOf: + - $ref: '#/components/schemas/LogStreamName' + - description: The name of the log stream. + creationTime: + allOf: + - $ref: '#/components/schemas/Timestamp' + - description: The creation time of the stream, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. + firstEventTimestamp: + allOf: + - $ref: '#/components/schemas/Timestamp' + - description: The time of the first event, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. + lastEventTimestamp: + allOf: + - $ref: '#/components/schemas/Timestamp' + - description: The time of the most recent log event in the log stream in CloudWatch Logs. This number is expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. The lastEventTime value updates on an eventual consistency basis. It typically updates in less than an hour from ingestion, but in rare situations might take longer. + lastIngestionTime: + allOf: + - $ref: '#/components/schemas/Timestamp' + - description: The ingestion time, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC The lastIngestionTime value updates on an eventual consistency basis. It typically updates in less than an hour after ingestion, but in rare situations might take longer. + uploadSequenceToken: + allOf: + - $ref: '#/components/schemas/SequenceToken' + - description:

The sequence token.

The sequence token is now ignored in PutLogEvents actions. PutLogEvents actions are always accepted regardless of receiving an invalid sequence token. You don't need to obtain uploadSequenceToken to use a PutLogEvents action.

 + arn: + allOf: + - $ref: '#/components/schemas/Arn' + - description: The Amazon Resource Name (ARN) of the log stream. + storedBytes: + allOf: + - $ref: '#/components/schemas/StoredBytes' + - deprecated: true + description: >- +

The number of bytes stored.

Important: As of June 17, 2019, this parameter is no longer supported for log streams, and is always reported as zero. This change applies only to log streams. The storedBytes parameter for log groups is not affected.

Starting on June 17, 2019, this parameter will be deprecated for log streams, and will be reported as zero. This change applies only to log streams. The storedBytes parameter for log groups is not + affected. + description: Represents a log stream, which is a sequence of log events from a single emitter of logs. + LogStreamName: + type: string + pattern: '[^:*]*' + minLength: 1 + maxLength: 512 + LogStreams: + type: array + items: + $ref: '#/components/schemas/LogStream' + NextToken: + type: string + description: The token for the next set of items to return. The token expires after 24 hours. + minLength: 1 + OperationAbortedException: {} + OrderBy: + type: string + enum: + - LogStreamName + - LastEventTime + OutputLogEvent: + type: object + properties: + timestamp: + allOf: + - $ref: '#/components/schemas/Timestamp' + - description: The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. + message: + allOf: + - $ref: '#/components/schemas/EventMessage' + - description: The data contained in the log event. + ingestionTime: + allOf: + - $ref: '#/components/schemas/Timestamp' + - description: The time the event was ingested, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. + description: Represents a log event. + OutputLogEvents: + type: array + items: + $ref: '#/components/schemas/OutputLogEvent' + ResourceAlreadyExistsException: {} + ResourceNotFoundException: {} + SequenceToken: + type: string + minLength: 1 + ServiceUnavailableException: {} + StartFromHead: + type: boolean + StoredBytes: + type: integer + minimum: 0 + Tags: + type: object + minProperties: 1 + maxProperties: 50 + additionalProperties: + $ref: '#/components/schemas/TagValue' + TagValue: + type: string + pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$ + maxLength: 256 + Timestamp: + type: integer + minimum: 0 + Unmask: + type: boolean MetricStat: description: |- This structure defines the metric to be returned, along with the statistics, period, and units. @@ -1276,7 +1683,7 @@ components: x-cfn-type-name: AWS::CloudWatch::Alarm x-identifiers: - AlarmName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1293,9 +1700,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1305,41 +1712,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/alarms/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/alarms/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AlarmName') as alarm_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudWatch::Alarm' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AlarmName') as alarm_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudWatch::Alarm' - AND region = 'us-east-1' - alarm: - name: alarm - id: aws.cloudwatch.alarm - x-cfn-schema-name: Alarm - x-cfn-type-name: AWS::CloudWatch::Alarm - x-identifiers: - - AlarmName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1350,12 +1725,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/alarms/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/alarms/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/alarm/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/alarms/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1387,37 +1766,53 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ThresholdMetricId') as threshold_metric_id, - json_extract_path_text(Properties, 'EvaluateLowSampleCountPercentile') as evaluate_low_sample_count_percentile, - json_extract_path_text(Properties, 'ExtendedStatistic') as extended_statistic, - json_extract_path_text(Properties, 'ComparisonOperator') as comparison_operator, - json_extract_path_text(Properties, 'TreatMissingData') as treat_missing_data, - json_extract_path_text(Properties, 'Dimensions') as dimensions, - json_extract_path_text(Properties, 'Period') as period, - json_extract_path_text(Properties, 'EvaluationPeriods') as evaluation_periods, - json_extract_path_text(Properties, 'Unit') as unit, - json_extract_path_text(Properties, 'Namespace') as namespace, - json_extract_path_text(Properties, 'OKActions') as ok_actions, - json_extract_path_text(Properties, 'AlarmActions') as alarm_actions, - json_extract_path_text(Properties, 'MetricName') as metric_name, - json_extract_path_text(Properties, 'ActionsEnabled') as actions_enabled, - json_extract_path_text(Properties, 'Metrics') as metrics, - json_extract_path_text(Properties, 'AlarmDescription') as alarm_description, - json_extract_path_text(Properties, 'AlarmName') as alarm_name, - json_extract_path_text(Properties, 'Statistic') as statistic, - json_extract_path_text(Properties, 'InsufficientDataActions') as insufficient_data_actions, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'DatapointsToAlarm') as datapoints_to_alarm, - json_extract_path_text(Properties, 'Threshold') as threshold, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CloudWatch::Alarm' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.AlarmName') as alarm_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudWatch::Alarm' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ThresholdMetricId') as threshold_metric_id, + json_extract_path_text(Properties, 'EvaluateLowSampleCountPercentile') as evaluate_low_sample_count_percentile, + json_extract_path_text(Properties, 'ExtendedStatistic') as extended_statistic, + json_extract_path_text(Properties, 'ComparisonOperator') as comparison_operator, + json_extract_path_text(Properties, 'TreatMissingData') as treat_missing_data, + json_extract_path_text(Properties, 'Dimensions') as dimensions, + json_extract_path_text(Properties, 'Period') as period, + json_extract_path_text(Properties, 'EvaluationPeriods') as evaluation_periods, + json_extract_path_text(Properties, 'Unit') as unit, + json_extract_path_text(Properties, 'Namespace') as namespace, + json_extract_path_text(Properties, 'OKActions') as ok_actions, + json_extract_path_text(Properties, 'AlarmActions') as alarm_actions, + json_extract_path_text(Properties, 'MetricName') as metric_name, + json_extract_path_text(Properties, 'ActionsEnabled') as actions_enabled, + json_extract_path_text(Properties, 'Metrics') as metrics, + json_extract_path_text(Properties, 'AlarmDescription') as alarm_description, + json_extract_path_text(Properties, 'AlarmName') as alarm_name, + json_extract_path_text(Properties, 'Statistic') as statistic, + json_extract_path_text(Properties, 'InsufficientDataActions') as insufficient_data_actions, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'DatapointsToAlarm') as datapoints_to_alarm, + json_extract_path_text(Properties, 'Threshold') as threshold, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CloudWatch::Alarm' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AlarmName') as alarm_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudWatch::Alarm' + AND region = 'us-east-1' composite_alarms: name: composite_alarms id: aws.cloudwatch.composite_alarms @@ -1425,7 +1820,7 @@ components: x-cfn-type-name: AWS::CloudWatch::CompositeAlarm x-identifiers: - AlarmName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1442,9 +1837,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1454,41 +1849,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/composite_alarms/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/composite_alarms/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AlarmName') as alarm_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudWatch::CompositeAlarm' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AlarmName') as alarm_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudWatch::CompositeAlarm' - AND region = 'us-east-1' - composite_alarm: - name: composite_alarm - id: aws.cloudwatch.composite_alarm - x-cfn-schema-name: CompositeAlarm - x-cfn-type-name: AWS::CloudWatch::CompositeAlarm - x-identifiers: - - AlarmName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1499,12 +1862,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/composite_alarms/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/composite_alarms/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/composite_alarm/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/composite_alarms/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1525,26 +1892,42 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'AlarmName') as alarm_name, - json_extract_path_text(Properties, 'AlarmRule') as alarm_rule, - json_extract_path_text(Properties, 'AlarmDescription') as alarm_description, - json_extract_path_text(Properties, 'ActionsEnabled') as actions_enabled, - json_extract_path_text(Properties, 'OKActions') as ok_actions, - json_extract_path_text(Properties, 'AlarmActions') as alarm_actions, - json_extract_path_text(Properties, 'InsufficientDataActions') as insufficient_data_actions, - json_extract_path_text(Properties, 'ActionsSuppressor') as actions_suppressor, - json_extract_path_text(Properties, 'ActionsSuppressorWaitPeriod') as actions_suppressor_wait_period, - json_extract_path_text(Properties, 'ActionsSuppressorExtensionPeriod') as actions_suppressor_extension_period, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CloudWatch::CompositeAlarm' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.AlarmName') as alarm_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudWatch::CompositeAlarm' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'AlarmName') as alarm_name, + json_extract_path_text(Properties, 'AlarmRule') as alarm_rule, + json_extract_path_text(Properties, 'AlarmDescription') as alarm_description, + json_extract_path_text(Properties, 'ActionsEnabled') as actions_enabled, + json_extract_path_text(Properties, 'OKActions') as ok_actions, + json_extract_path_text(Properties, 'AlarmActions') as alarm_actions, + json_extract_path_text(Properties, 'InsufficientDataActions') as insufficient_data_actions, + json_extract_path_text(Properties, 'ActionsSuppressor') as actions_suppressor, + json_extract_path_text(Properties, 'ActionsSuppressorWaitPeriod') as actions_suppressor_wait_period, + json_extract_path_text(Properties, 'ActionsSuppressorExtensionPeriod') as actions_suppressor_extension_period, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CloudWatch::CompositeAlarm' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AlarmName') as alarm_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudWatch::CompositeAlarm' + AND region = 'us-east-1' metric_streams: name: metric_streams id: aws.cloudwatch.metric_streams @@ -1552,7 +1935,7 @@ components: x-cfn-type-name: AWS::CloudWatch::MetricStream x-identifiers: - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1569,9 +1952,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1581,41 +1964,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/metric_streams/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/metric_streams/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudWatch::MetricStream' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudWatch::MetricStream' - AND region = 'us-east-1' - metric_stream: - name: metric_stream - id: aws.cloudwatch.metric_stream - x-cfn-schema-name: MetricStream - x-cfn-type-name: AWS::CloudWatch::MetricStream - x-identifiers: - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1626,12 +1977,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/metric_streams/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/metric_streams/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/metric_stream/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/metric_streams/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1653,43 +2008,171 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'CreationDate') as creation_date, - json_extract_path_text(Properties, 'ExcludeFilters') as exclude_filters, - json_extract_path_text(Properties, 'FirehoseArn') as firehose_arn, - json_extract_path_text(Properties, 'IncludeFilters') as include_filters, - json_extract_path_text(Properties, 'LastUpdateDate') as last_update_date, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'State') as state, - json_extract_path_text(Properties, 'OutputFormat') as output_format, - json_extract_path_text(Properties, 'StatisticsConfigurations') as statistics_configurations, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'IncludeLinkedAccountsMetrics') as include_linked_accounts_metrics - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CloudWatch::MetricStream' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudWatch::MetricStream' AND region = 'us-east-1' -paths: - /?Action=CreateResource&Version=2021-09-30: - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - operationId: CreateResource - parameters: - - description: Action Header - in: header - name: X-Amz-Target + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'CreationDate') as creation_date, + json_extract_path_text(Properties, 'ExcludeFilters') as exclude_filters, + json_extract_path_text(Properties, 'FirehoseArn') as firehose_arn, + json_extract_path_text(Properties, 'IncludeFilters') as include_filters, + json_extract_path_text(Properties, 'LastUpdateDate') as last_update_date, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'OutputFormat') as output_format, + json_extract_path_text(Properties, 'StatisticsConfigurations') as statistics_configurations, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'IncludeLinkedAccountsMetrics') as include_linked_accounts_metrics + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CloudWatch::MetricStream' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudWatch::MetricStream' + AND region = 'us-east-1' + log_events: + name: log_events + x-cfn-schema-name: OutputLogEvent + x-example-where-clause: WHERE region = 'us-east-1' AND data___logStreamName = '' + x-type: native + id: aws.cloudwatch.log_events + methods: + GetLogEvents: + serviceName: logs + operation: + $ref: '#/paths/~1?__X-Amz-Target=Logs_20140328.GetLogEvents&__nativeEndpoint=true/post' + request: + mediaType: application/json + response: + mediaType: application/json + objectKey: $.events + openAPIDocKey: '200' + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/log_events/methods/GetLogEvents' + update: [] + title: log_events + log_groups: + name: log_groups + x-cfn-schema-name: LogGroup + x-example-where-clause: WHERE region = 'us-east-1' + x-type: native + id: aws.cloudwatch.log_groups + methods: + DescribeLogGroups: + serviceName: logs + operation: + $ref: '#/paths/~1?__X-Amz-Target=Logs_20140328.DescribeLogGroups&__nativeEndpoint=true/post' + request: + mediaType: application/json + response: + mediaType: application/json + objectKey: $.logGroups + openAPIDocKey: '200' + DeleteLogGroup: + serviceName: logs + operation: + $ref: '#/paths/~1?__X-Amz-Target=Logs_20140328.DeleteLogGroup&__nativeEndpoint=true/post' + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + CreateLogGroup: + serviceName: logs + operation: + $ref: '#/paths/~1?__X-Amz-Target=Logs_20140328.CreateLogGroup&__nativeEndpoint=true/post' + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/log_groups/methods/DeleteLogGroup' + insert: + - $ref: '#/components/x-stackQL-resources/log_groups/methods/CreateLogGroup' + select: + - $ref: '#/components/x-stackQL-resources/log_groups/methods/DescribeLogGroups' + update: [] + title: log_groups + log_streams: + name: log_streams + x-cfn-schema-name: LogStream + x-example-where-clause: WHERE region = 'us-east-1' + x-type: native + id: aws.cloudwatch.log_streams + methods: + DescribeLogGroups: + serviceName: logs + operation: + $ref: '#/paths/~1?__X-Amz-Target=Logs_20140328.DescribeLogStreams&__nativeEndpoint=true/post' + request: + mediaType: application/json + response: + mediaType: application/json + objectKey: $.logStreams + openAPIDocKey: '200' + DeleteLogGroup: + serviceName: logs + operation: + $ref: '#/paths/~1?__X-Amz-Target=Logs_20140328.DeleteLogStream&__nativeEndpoint=true/post' + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + CreateLogGroup: + serviceName: logs + operation: + $ref: '#/paths/~1?__X-Amz-Target=Logs_20140328.CreateLogStream&__nativeEndpoint=true/post' + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/log_streams/methods/DeleteLogGroup' + insert: + - $ref: '#/components/x-stackQL-resources/log_streams/methods/CreateLogGroup' + select: + - $ref: '#/components/x-stackQL-resources/log_streams/methods/DescribeLogGroups' + update: [] + title: log_streams +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target required: false schema: default: CloudApiService.CreateResource @@ -1943,6 +2426,585 @@ paths: schema: $ref: '#/components/x-cloud-control-schemas/ProgressEvent' description: Success + /?__X-Amz-Target=Logs_20140328.GetLogEvents&__nativeEndpoint=true: + servers: + - url: https://logs.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The Amazon CloudWatch Logs multi-region endpoint + post: + operationId: GetLogEvents + description: >- +

Lists log events from the specified log stream. You can list all of the log events or filter using a time range.

By default, this operation returns as many log events as can fit in a response size of 1MB (up to 10,000 log events). You can get additional log events by specifying one of the tokens in a subsequent call. This operation can return empty results while there are more log events available through the token.

If you are using CloudWatch cross-account + observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.

You can specify the log group to search by using either logGroupIdentifier or logGroupName. You must include one of these two parameters, but you can't include both. +

+ responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/GetLogEventsResponse' + '480': + description: InvalidParameterException + content: + application/json: + schema: + $ref: '#/components/schemas/InvalidParameterException' + '481': + description: ResourceNotFoundException + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceNotFoundException' + '482': + description: ServiceUnavailableException + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceUnavailableException' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/GetLogEventsRequest' + parameters: + - name: limit + in: query + schema: + type: string + description: Pagination limit + required: false + - name: nextToken + in: query + schema: + type: string + description: Pagination token + required: false + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + /?__X-Amz-Target=Logs_20140328.DescribeLogGroups&__nativeEndpoint=true: + servers: + - url: https://logs.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The Amazon CloudWatch Logs multi-region endpoint + post: + operationId: DescribeLogGroups + description: >- +

Lists the specified log groups. You can list all your log groups or filter the results by prefix. The results are ASCII-sorted by log group name.

CloudWatch Logs doesn’t support IAM policies that control access to the DescribeLogGroups action by using the aws:ResourceTag/key-name condition key. Other CloudWatch Logs actions do support the use of the aws:ResourceTag/key-name condition key to control access. For more + information about using tags to control access, see Controlling access to Amazon Web Services resources using tags.

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.

+ responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/DescribeLogGroupsResponse' + '480': + description: InvalidParameterException + content: + application/json: + schema: + $ref: '#/components/schemas/InvalidParameterException' + '481': + description: ServiceUnavailableException + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceUnavailableException' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DescribeLogGroupsRequest' + parameters: + - name: limit + in: query + schema: + type: string + description: Pagination limit + required: false + - name: nextToken + in: query + schema: + type: string + description: Pagination token + required: false + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + /?__X-Amz-Target=Logs_20140328.DescribeLogStreams&__nativeEndpoint=true: + servers: + - url: https://logs.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The Amazon CloudWatch Logs multi-region endpoint + post: + operationId: DescribeLogStreams + description: >- +

Lists the log streams for the specified log group. You can list all the log streams or filter the results by prefix. You can also control how the results are ordered.

You can specify the log group to search by using either logGroupIdentifier or logGroupName. You must include one of these two parameters, but you can't include both.

This operation has a limit of five transactions per second, after which transactions are throttled.

If you + are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.

+ responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/DescribeLogStreamsResponse' + '480': + description: InvalidParameterException + content: + application/json: + schema: + $ref: '#/components/schemas/InvalidParameterException' + '481': + description: ResourceNotFoundException + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceNotFoundException' + '482': + description: ServiceUnavailableException + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceUnavailableException' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DescribeLogStreamsRequest' + parameters: + - name: limit + in: query + schema: + type: string + description: Pagination limit + required: false + - name: nextToken + in: query + schema: + type: string + description: Pagination token + required: false + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + /?__X-Amz-Target=Logs_20140328.CreateLogGroup&__nativeEndpoint=true: + servers: + - url: https://logs.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The Amazon CloudWatch Logs multi-region endpoint + post: + operationId: CreateLogGroup + description: >- +

Creates a log group with the specified name. You can create up to 20,000 log groups per account.

You must use the following guidelines when naming a log group:

  • Log group names must be unique within a Region for an Amazon Web Services account.

  • Log group names can be between 1 and 512 characters long.

  • Log group names consist of the following characters: a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), '.' + (period), and '#' (number sign)

When you create a log group, by default the log events in the log group do not expire. To set a retention policy so that events expire and are deleted after a specified time, use PutRetentionPolicy.

If you associate an KMS key with the log group, ingested data is encrypted using the KMS key. This association is stored as + long as the data encrypted with the KMS key is still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested.

If you attempt to associate a KMS key with the log group but the KMS key does not exist or the KMS key is disabled, you receive an InvalidParameterException error.

CloudWatch Logs supports only symmetric KMS keys. Do not associate an asymmetric KMS key with your log group. For more information, see + Using Symmetric and Asymmetric Keys.

 + responses: + '200': + description: Success + '480': + description: InvalidParameterException + content: + application/json: + schema: + $ref: '#/components/schemas/InvalidParameterException' + '481': + description: ResourceAlreadyExistsException + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceAlreadyExistsException' + '482': + description: LimitExceededException + content: + application/json: + schema: + $ref: '#/components/schemas/LimitExceededException' + '483': + description: OperationAbortedException + content: + application/json: + schema: + $ref: '#/components/schemas/OperationAbortedException' + '484': + description: ServiceUnavailableException + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceUnavailableException' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/CreateLogGroupRequest' + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + /?__X-Amz-Target=Logs_20140328.CreateLogStream&__nativeEndpoint=true: + servers: + - url: https://logs.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The Amazon CloudWatch Logs multi-region endpoint + post: + operationId: CreateLogStream + description: >- +

Creates a log stream for the specified log group. A log stream is a sequence of log events that originate from a single source, such as an application instance or a resource that is being monitored.

There is no limit on the number of log streams that you can create for a log group. There is a limit of 50 TPS on CreateLogStream operations, after which transactions are throttled.

You must use the following guidelines when naming a log stream:

  • +

    Log stream names must be unique within the log group.

  • Log stream names can be between 1 and 512 characters long.

  • Don't use ':' (colon) or '*' (asterisk) characters.

+ responses: + '200': + description: Success + '480': + description: InvalidParameterException + content: + application/json: + schema: + $ref: '#/components/schemas/InvalidParameterException' + '481': + description: ResourceAlreadyExistsException + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceAlreadyExistsException' + '482': + description: ResourceNotFoundException + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceNotFoundException' + '483': + description: ServiceUnavailableException + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceUnavailableException' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/CreateLogStreamRequest' + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + /?__X-Amz-Target=Logs_20140328.DeleteLogGroup&__nativeEndpoint=true: + servers: + - url: https://logs.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The Amazon CloudWatch Logs multi-region endpoint + post: + operationId: DeleteLogGroup + description: Deletes the specified log group and permanently deletes all the archived log events associated with the log group. + responses: + '200': + description: Success + '480': + description: InvalidParameterException + content: + application/json: + schema: + $ref: '#/components/schemas/InvalidParameterException' + '481': + description: ResourceNotFoundException + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceNotFoundException' + '482': + description: OperationAbortedException + content: + application/json: + schema: + $ref: '#/components/schemas/OperationAbortedException' + '483': + description: ServiceUnavailableException + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceUnavailableException' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteLogGroupRequest' + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + /?__X-Amz-Target=Logs_20140328.DeleteLogStream&__nativeEndpoint=true: + servers: + - url: https://logs.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The Amazon CloudWatch Logs multi-region endpoint + post: + operationId: DeleteLogStream + description: Deletes the specified log stream and permanently deletes all the archived log events associated with the log stream. + responses: + '200': + description: Success + '480': + description: InvalidParameterException + content: + application/json: + schema: + $ref: '#/components/schemas/InvalidParameterException' + '481': + description: ResourceNotFoundException + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceNotFoundException' + '482': + description: OperationAbortedException + content: + application/json: + schema: + $ref: '#/components/schemas/OperationAbortedException' + '483': + description: ServiceUnavailableException + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceUnavailableException' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteLogStreamRequest' + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' x-stackQL-config: requestTranslate: algorithm: drop_double_underscore_params @@ -1953,3 +3015,5 @@ x-stackQL-config: responseToken: key: NextToken location: body + queryParamTranspose: + algorithm: AWSCanonical diff --git a/providers/src/aws/v00.00.00000/services/cloudwatch_api.yaml b/providers/src/aws/v00.00.00000/services/cloudwatch_api.yaml deleted file mode 100644 index 97ffe447..00000000 --- a/providers/src/aws/v00.00.00000/services/cloudwatch_api.yaml +++ /dev/null @@ -1,4741 +0,0 @@ -openapi: 3.0.0 -info: - version: '2014-03-28' - x-release: v4 - title: Amazon CloudWatch Logs - description: '

You can use Amazon CloudWatch Logs to monitor, store, and access your log files from EC2 instances, CloudTrail, and other sources. You can then retrieve the associated log data from CloudWatch Logs using the CloudWatch console. Alternatively, you can use CloudWatch Logs commands in the Amazon Web Services CLI, CloudWatch Logs API, or CloudWatch Logs SDK.

You can use CloudWatch Logs to:

  • Monitor logs from EC2 instances in real time: You can use CloudWatch Logs to monitor applications and systems using log data. For example, CloudWatch Logs can track the number of errors that occur in your application logs. Then, it can send you a notification whenever the rate of errors exceeds a threshold that you specify. CloudWatch Logs uses your log data for monitoring so no code changes are required. For example, you can monitor application logs for specific literal terms (such as "NullReferenceException"). You can also count the number of occurrences of a literal term at a particular position in log data (such as "404" status codes in an Apache access log). When the term you are searching for is found, CloudWatch Logs reports the data to a CloudWatch metric that you specify.

  • Monitor CloudTrail logged events: You can create alarms in CloudWatch and receive notifications of particular API activity as captured by CloudTrail. You can use the notification to perform troubleshooting.

  • Archive log data: You can use CloudWatch Logs to store your log data in highly durable storage. You can change the log retention setting so that any log events earlier than this setting are automatically deleted. The CloudWatch Logs agent helps to quickly send both rotated and non-rotated log data off of a host and into the log service. You can then access the raw log data when you need it.

' - x-logo: - url: 'https://twitter.com/awscloud/profile_image?size=original' - backgroundColor: '#FFFFFF' - termsOfService: 'https://aws.amazon.com/service-terms/' - contact: - name: Mike Ralphson - email: mike.ralphson@gmail.com - url: 'https://github.com/mermade/aws2openapi' - x-twitter: PermittedSoc - license: - name: Apache 2.0 License - url: 'http://www.apache.org/licenses/' - x-providerName: amazonaws.com - x-serviceName: logs - x-origin: - - contentType: application/json - url: 'https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/logs-2014-03-28.normal.json' - converter: - url: 'https://github.com/mermade/aws2openapi' - version: 1.0.0 - x-apisguru-driver: external - x-apiClientRegistration: - url: 'https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct' - x-apisguru-categories: - - cloud - x-preferred: true -externalDocs: - description: Amazon Web Services documentation - url: 'https://docs.aws.amazon.com/logs/' -servers: - - url: 'https://logs.{region}.amazonaws.com' - variables: - region: - description: The AWS region - enum: - - us-east-1 - - us-east-2 - - us-west-1 - - us-west-2 - - us-gov-west-1 - - us-gov-east-1 - - ca-central-1 - - eu-north-1 - - eu-west-1 - - eu-west-2 - - eu-west-3 - - eu-central-1 - - eu-south-1 - - af-south-1 - - ap-northeast-1 - - ap-northeast-2 - - ap-northeast-3 - - ap-southeast-1 - - ap-southeast-2 - - ap-east-1 - - ap-south-1 - - sa-east-1 - - me-south-1 - default: us-east-1 - description: The Amazon CloudWatch Logs multi-region endpoint -x-hasEquivalentPaths: true -paths: - /#X-Amz-Target=Logs_20140328.AssociateKmsKey: - post: - operationId: AssociateKmsKey - description: '

Associates the specified KMS key with the specified log group.

Associating a KMS key with a log group overrides any existing associations between the log group and a KMS key. After a KMS key is associated with a log group, all newly ingested data for the log group is encrypted using the KMS key. This association is stored as long as the data encrypted with the KMS keyis still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested.

CloudWatch Logs supports only symmetric KMS keys. Do not use an associate an asymmetric KMS key with your log group. For more information, see Using Symmetric and Asymmetric Keys.

It can take up to 5 minutes for this operation to take effect.

If you attempt to associate a KMS key with a log group but the KMS key does not exist or the KMS key is disabled, you receive an InvalidParameterException error.

' - responses: - '200': - description: Success - '480': - description: InvalidParameterException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidParameterException' - '481': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - '482': - description: OperationAbortedException - content: - application/json: - schema: - $ref: '#/components/schemas/OperationAbortedException' - '483': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/AssociateKmsKeyRequest' - parameters: - - name: X-Amz-Target - in: header - required: true - schema: - type: string - enum: - - Logs_20140328.AssociateKmsKey - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /#X-Amz-Target=Logs_20140328.CancelExportTask: - post: - operationId: CancelExportTask - description:

Cancels the specified export task.

The task must be in the PENDING or RUNNING state.

- responses: - '200': - description: Success - '480': - description: InvalidParameterException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidParameterException' - '481': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - '482': - description: InvalidOperationException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidOperationException' - '483': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/CancelExportTaskRequest' - parameters: - - name: X-Amz-Target - in: header - required: true - schema: - type: string - enum: - - Logs_20140328.CancelExportTask - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /#X-Amz-Target=Logs_20140328.CreateExportTask: - post: - operationId: CreateExportTask - description: '

Creates an export task so that you can efficiently export data from a log group to an Amazon S3 bucket. When you perform a CreateExportTask operation, you must use credentials that have permission to write to the S3 bucket that you specify as the destination.

Exporting log data to S3 buckets that are encrypted by KMS is supported. Exporting log data to Amazon S3 buckets that have S3 Object Lock enabled with a retention period is also supported.

Exporting to S3 buckets that are encrypted with AES-256 is supported.

This is an asynchronous call. If all the required information is provided, this operation initiates an export task and responds with the ID of the task. After the task has started, you can use DescribeExportTasks to get the status of the export task. Each account can only have one active (RUNNING or PENDING) export task at a time. To cancel an export task, use CancelExportTask.

You can export logs from multiple log groups or multiple time ranges to the same S3 bucket. To separate log data for each export task, specify a prefix to be used as the Amazon S3 key prefix for all exported objects.

Time-based sorting on chunks of log data inside an exported file is not guaranteed. You can sort the exported log field data by using Linux utilities.

' - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/CreateExportTaskResponse' - '480': - description: InvalidParameterException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidParameterException' - '481': - description: LimitExceededException - content: - application/json: - schema: - $ref: '#/components/schemas/LimitExceededException' - '482': - description: OperationAbortedException - content: - application/json: - schema: - $ref: '#/components/schemas/OperationAbortedException' - '483': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - '484': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - '485': - description: ResourceAlreadyExistsException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceAlreadyExistsException' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/CreateExportTaskRequest' - parameters: - - name: X-Amz-Target - in: header - required: true - schema: - type: string - enum: - - Logs_20140328.CreateExportTask - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /#X-Amz-Target=Logs_20140328.CreateLogGroup: - post: - operationId: CreateLogGroup - description: '

Creates a log group with the specified name. You can create up to 20,000 log groups per account.

You must use the following guidelines when naming a log group:

  • Log group names must be unique within a Region for an Amazon Web Services account.

  • Log group names can be between 1 and 512 characters long.

  • Log group names consist of the following characters: a-z, A-Z, 0-9, ''_'' (underscore), ''-'' (hyphen), ''/'' (forward slash), ''.'' (period), and ''#'' (number sign)

When you create a log group, by default the log events in the log group do not expire. To set a retention policy so that events expire and are deleted after a specified time, use PutRetentionPolicy.

If you associate an KMS key with the log group, ingested data is encrypted using the KMS key. This association is stored as long as the data encrypted with the KMS key is still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested.

If you attempt to associate a KMS key with the log group but the KMS keydoes not exist or the KMS key is disabled, you receive an InvalidParameterException error.

CloudWatch Logs supports only symmetric KMS keys. Do not associate an asymmetric KMS key with your log group. For more information, see Using Symmetric and Asymmetric Keys.

' - responses: - '200': - description: Success - '480': - description: InvalidParameterException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidParameterException' - '481': - description: ResourceAlreadyExistsException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceAlreadyExistsException' - '482': - description: LimitExceededException - content: - application/json: - schema: - $ref: '#/components/schemas/LimitExceededException' - '483': - description: OperationAbortedException - content: - application/json: - schema: - $ref: '#/components/schemas/OperationAbortedException' - '484': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/CreateLogGroupRequest' - parameters: - - name: X-Amz-Target - in: header - required: true - schema: - type: string - enum: - - Logs_20140328.CreateLogGroup - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /#X-Amz-Target=Logs_20140328.CreateLogStream: - post: - operationId: CreateLogStream - description: '

Creates a log stream for the specified log group. A log stream is a sequence of log events that originate from a single source, such as an application instance or a resource that is being monitored.

There is no limit on the number of log streams that you can create for a log group. There is a limit of 50 TPS on CreateLogStream operations, after which transactions are throttled.

You must use the following guidelines when naming a log stream:

  • Log stream names must be unique within the log group.

  • Log stream names can be between 1 and 512 characters long.

  • Don''t use '':'' (colon) or ''*'' (asterisk) characters.

' - responses: - '200': - description: Success - '480': - description: InvalidParameterException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidParameterException' - '481': - description: ResourceAlreadyExistsException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceAlreadyExistsException' - '482': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - '483': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/CreateLogStreamRequest' - parameters: - - name: X-Amz-Target - in: header - required: true - schema: - type: string - enum: - - Logs_20140328.CreateLogStream - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /#X-Amz-Target=Logs_20140328.DeleteDataProtectionPolicy: - post: - operationId: DeleteDataProtectionPolicy - description: '

Deletes the data protection policy from the specified log group.

For more information about data protection policies, see PutDataProtectionPolicy.

' - responses: - '200': - description: Success - '480': - description: InvalidParameterException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidParameterException' - '481': - description: OperationAbortedException - content: - application/json: - schema: - $ref: '#/components/schemas/OperationAbortedException' - '482': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - '483': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/DeleteDataProtectionPolicyRequest' - parameters: - - name: X-Amz-Target - in: header - required: true - schema: - type: string - enum: - - Logs_20140328.DeleteDataProtectionPolicy - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /#X-Amz-Target=Logs_20140328.DeleteDestination: - post: - operationId: DeleteDestination - description: 'Deletes the specified destination, and eventually disables all the subscription filters that publish to it. This operation does not delete the physical resource encapsulated by the destination.' - responses: - '200': - description: Success - '480': - description: InvalidParameterException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidParameterException' - '481': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - '482': - description: OperationAbortedException - content: - application/json: - schema: - $ref: '#/components/schemas/OperationAbortedException' - '483': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/DeleteDestinationRequest' - parameters: - - name: X-Amz-Target - in: header - required: true - schema: - type: string - enum: - - Logs_20140328.DeleteDestination - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /#X-Amz-Target=Logs_20140328.DeleteLogGroup: - post: - operationId: DeleteLogGroup - description: Deletes the specified log group and permanently deletes all the archived log events associated with the log group. - responses: - '200': - description: Success - '480': - description: InvalidParameterException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidParameterException' - '481': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - '482': - description: OperationAbortedException - content: - application/json: - schema: - $ref: '#/components/schemas/OperationAbortedException' - '483': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/DeleteLogGroupRequest' - parameters: - - name: X-Amz-Target - in: header - required: true - schema: - type: string - enum: - - Logs_20140328.DeleteLogGroup - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /#X-Amz-Target=Logs_20140328.DeleteLogStream: - post: - operationId: DeleteLogStream - description: Deletes the specified log stream and permanently deletes all the archived log events associated with the log stream. - responses: - '200': - description: Success - '480': - description: InvalidParameterException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidParameterException' - '481': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - '482': - description: OperationAbortedException - content: - application/json: - schema: - $ref: '#/components/schemas/OperationAbortedException' - '483': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/DeleteLogStreamRequest' - parameters: - - name: X-Amz-Target - in: header - required: true - schema: - type: string - enum: - - Logs_20140328.DeleteLogStream - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /#X-Amz-Target=Logs_20140328.DeleteMetricFilter: - post: - operationId: DeleteMetricFilter - description: Deletes the specified metric filter. - responses: - '200': - description: Success - '480': - description: InvalidParameterException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidParameterException' - '481': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - '482': - description: OperationAbortedException - content: - application/json: - schema: - $ref: '#/components/schemas/OperationAbortedException' - '483': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/DeleteMetricFilterRequest' - parameters: - - name: X-Amz-Target - in: header - required: true - schema: - type: string - enum: - - Logs_20140328.DeleteMetricFilter - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /#X-Amz-Target=Logs_20140328.DeleteQueryDefinition: - post: - operationId: DeleteQueryDefinition - description: '

Deletes a saved CloudWatch Logs Insights query definition. A query definition contains details about a saved CloudWatch Logs Insights query.

Each DeleteQueryDefinition operation can delete one query definition.

You must have the logs:DeleteQueryDefinition permission to be able to perform this operation.

' - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/DeleteQueryDefinitionResponse' - '480': - description: InvalidParameterException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidParameterException' - '481': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - '482': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/DeleteQueryDefinitionRequest' - parameters: - - name: X-Amz-Target - in: header - required: true - schema: - type: string - enum: - - Logs_20140328.DeleteQueryDefinition - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /#X-Amz-Target=Logs_20140328.DeleteResourcePolicy: - post: - operationId: DeleteResourcePolicy - description: Deletes a resource policy from this account. This revokes the access of the identities in that policy to put log events to this account. - responses: - '200': - description: Success - '480': - description: InvalidParameterException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidParameterException' - '481': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - '482': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/DeleteResourcePolicyRequest' - parameters: - - name: X-Amz-Target - in: header - required: true - schema: - type: string - enum: - - Logs_20140328.DeleteResourcePolicy - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /#X-Amz-Target=Logs_20140328.DeleteRetentionPolicy: - post: - operationId: DeleteRetentionPolicy - description:

Deletes the specified retention policy.

Log events do not expire if they belong to log groups without a retention policy.

- responses: - '200': - description: Success - '480': - description: InvalidParameterException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidParameterException' - '481': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - '482': - description: OperationAbortedException - content: - application/json: - schema: - $ref: '#/components/schemas/OperationAbortedException' - '483': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/DeleteRetentionPolicyRequest' - parameters: - - name: X-Amz-Target - in: header - required: true - schema: - type: string - enum: - - Logs_20140328.DeleteRetentionPolicy - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /#X-Amz-Target=Logs_20140328.DeleteSubscriptionFilter: - post: - operationId: DeleteSubscriptionFilter - description: Deletes the specified subscription filter. - responses: - '200': - description: Success - '480': - description: InvalidParameterException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidParameterException' - '481': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - '482': - description: OperationAbortedException - content: - application/json: - schema: - $ref: '#/components/schemas/OperationAbortedException' - '483': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/DeleteSubscriptionFilterRequest' - parameters: - - name: X-Amz-Target - in: header - required: true - schema: - type: string - enum: - - Logs_20140328.DeleteSubscriptionFilter - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /#X-Amz-Target=Logs_20140328.DescribeDestinations: - post: - operationId: DescribeDestinations - description: Lists all your destinations. The results are ASCII-sorted by destination name. - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/DescribeDestinationsResponse' - '480': - description: InvalidParameterException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidParameterException' - '481': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/DescribeDestinationsRequest' - parameters: - - name: limit - in: query - schema: - type: string - description: Pagination limit - required: false - - name: nextToken - in: query - schema: - type: string - description: Pagination token - required: false - - name: X-Amz-Target - in: header - required: true - schema: - type: string - enum: - - Logs_20140328.DescribeDestinations - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /#X-Amz-Target=Logs_20140328.DescribeExportTasks: - post: - operationId: DescribeExportTasks - description: Lists the specified export tasks. You can list all your export tasks or filter the results based on task ID or task status. - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/DescribeExportTasksResponse' - '480': - description: InvalidParameterException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidParameterException' - '481': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/DescribeExportTasksRequest' - parameters: - - name: X-Amz-Target - in: header - required: true - schema: - type: string - enum: - - Logs_20140328.DescribeExportTasks - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /#X-Amz-Target=Logs_20140328.DescribeLogGroups: - post: - operationId: DescribeLogGroups - description: '

Lists the specified log groups. You can list all your log groups or filter the results by prefix. The results are ASCII-sorted by log group name.

CloudWatch Logs doesn’t support IAM policies that control access to the DescribeLogGroups action by using the aws:ResourceTag/key-name condition key. Other CloudWatch Logs actions do support the use of the aws:ResourceTag/key-name condition key to control access. For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags.

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.

' - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/DescribeLogGroupsResponse' - '480': - description: InvalidParameterException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidParameterException' - '481': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/DescribeLogGroupsRequest' - parameters: - - name: limit - in: query - schema: - type: string - description: Pagination limit - required: false - - name: nextToken - in: query - schema: - type: string - description: Pagination token - required: false - - name: X-Amz-Target - in: header - required: true - schema: - type: string - enum: - - Logs_20140328.DescribeLogGroups - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /#X-Amz-Target=Logs_20140328.DescribeLogStreams: - post: - operationId: DescribeLogStreams - description: '

Lists the log streams for the specified log group. You can list all the log streams or filter the results by prefix. You can also control how the results are ordered.

You can specify the log group to search by using either logGroupIdentifier or logGroupName. You must include one of these two parameters, but you can''t include both.

This operation has a limit of five transactions per second, after which transactions are throttled.

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.

' - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/DescribeLogStreamsResponse' - '480': - description: InvalidParameterException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidParameterException' - '481': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - '482': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/DescribeLogStreamsRequest' - parameters: - - name: limit - in: query - schema: - type: string - description: Pagination limit - required: false - - name: nextToken - in: query - schema: - type: string - description: Pagination token - required: false - - name: X-Amz-Target - in: header - required: true - schema: - type: string - enum: - - Logs_20140328.DescribeLogStreams - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /#X-Amz-Target=Logs_20140328.DescribeMetricFilters: - post: - operationId: DescribeMetricFilters - description: 'Lists the specified metric filters. You can list all of the metric filters or filter the results by log name, prefix, metric name, or metric namespace. The results are ASCII-sorted by filter name.' - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/DescribeMetricFiltersResponse' - '480': - description: InvalidParameterException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidParameterException' - '481': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - '482': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/DescribeMetricFiltersRequest' - parameters: - - name: limit - in: query - schema: - type: string - description: Pagination limit - required: false - - name: nextToken - in: query - schema: - type: string - description: Pagination token - required: false - - name: X-Amz-Target - in: header - required: true - schema: - type: string - enum: - - Logs_20140328.DescribeMetricFilters - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /#X-Amz-Target=Logs_20140328.DescribeQueries: - post: - operationId: DescribeQueries - description: 'Returns a list of CloudWatch Logs Insights queries that are scheduled, running, or have been run recently in this account. You can request all queries or limit it to queries of a specific log group or queries with a certain status.' - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/DescribeQueriesResponse' - '480': - description: InvalidParameterException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidParameterException' - '481': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - '482': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/DescribeQueriesRequest' - parameters: - - name: X-Amz-Target - in: header - required: true - schema: - type: string - enum: - - Logs_20140328.DescribeQueries - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /#X-Amz-Target=Logs_20140328.DescribeQueryDefinitions: - post: - operationId: DescribeQueryDefinitions - description:

This operation returns a paginated list of your saved CloudWatch Logs Insights query definitions.

You can use the queryDefinitionNamePrefix parameter to limit the results to only the query definitions that have names that start with a certain string.

- responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/DescribeQueryDefinitionsResponse' - '480': - description: InvalidParameterException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidParameterException' - '481': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/DescribeQueryDefinitionsRequest' - parameters: - - name: X-Amz-Target - in: header - required: true - schema: - type: string - enum: - - Logs_20140328.DescribeQueryDefinitions - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /#X-Amz-Target=Logs_20140328.DescribeResourcePolicies: - post: - operationId: DescribeResourcePolicies - description: Lists the resource policies in this account. - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/DescribeResourcePoliciesResponse' - '480': - description: InvalidParameterException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidParameterException' - '481': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/DescribeResourcePoliciesRequest' - parameters: - - name: X-Amz-Target - in: header - required: true - schema: - type: string - enum: - - Logs_20140328.DescribeResourcePolicies - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /#X-Amz-Target=Logs_20140328.DescribeSubscriptionFilters: - post: - operationId: DescribeSubscriptionFilters - description: Lists the subscription filters for the specified log group. You can list all the subscription filters or filter the results by prefix. The results are ASCII-sorted by filter name. - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/DescribeSubscriptionFiltersResponse' - '480': - description: InvalidParameterException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidParameterException' - '481': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - '482': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/DescribeSubscriptionFiltersRequest' - parameters: - - name: limit - in: query - schema: - type: string - description: Pagination limit - required: false - - name: nextToken - in: query - schema: - type: string - description: Pagination token - required: false - - name: X-Amz-Target - in: header - required: true - schema: - type: string - enum: - - Logs_20140328.DescribeSubscriptionFilters - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /#X-Amz-Target=Logs_20140328.DisassociateKmsKey: - post: - operationId: DisassociateKmsKey - description: '

Disassociates the associated KMS key from the specified log group.

After the KMS key is disassociated from the log group, CloudWatch Logs stops encrypting newly ingested data for the log group. All previously ingested data remains encrypted, and CloudWatch Logs requires permissions for the KMS key whenever the encrypted data is requested.

Note that it can take up to 5 minutes for this operation to take effect.

' - responses: - '200': - description: Success - '480': - description: InvalidParameterException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidParameterException' - '481': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - '482': - description: OperationAbortedException - content: - application/json: - schema: - $ref: '#/components/schemas/OperationAbortedException' - '483': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/DisassociateKmsKeyRequest' - parameters: - - name: X-Amz-Target - in: header - required: true - schema: - type: string - enum: - - Logs_20140328.DisassociateKmsKey - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /#X-Amz-Target=Logs_20140328.FilterLogEvents: - post: - operationId: FilterLogEvents - description: '

Lists log events from the specified log group. You can list all the log events or filter the results using a filter pattern, a time range, and the name of the log stream.

You must have the logs;FilterLogEvents permission to perform this operation.

You can specify the log group to search by using either logGroupIdentifier or logGroupName. You must include one of these two parameters, but you can''t include both.

By default, this operation returns as many log events as can fit in 1 MB (up to 10,000 log events) or all the events found within the specified time range. If the results include a token, that means there are more log events available. You can get additional results by specifying the token in a subsequent call. This operation can return empty results while there are more log events available through the token.

The returned log events are sorted by event timestamp, the timestamp when the event was ingested by CloudWatch Logs, and the ID of the PutLogEvents request.

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.

' - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/FilterLogEventsResponse' - '480': - description: InvalidParameterException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidParameterException' - '481': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - '482': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/FilterLogEventsRequest' - parameters: - - name: limit - in: query - schema: - type: string - description: Pagination limit - required: false - - name: nextToken - in: query - schema: - type: string - description: Pagination token - required: false - - name: X-Amz-Target - in: header - required: true - schema: - type: string - enum: - - Logs_20140328.FilterLogEvents - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /#X-Amz-Target=Logs_20140328.GetDataProtectionPolicy: - post: - operationId: GetDataProtectionPolicy - description: Returns information about a log group data protection policy. - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/GetDataProtectionPolicyResponse' - '480': - description: InvalidParameterException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidParameterException' - '481': - description: OperationAbortedException - content: - application/json: - schema: - $ref: '#/components/schemas/OperationAbortedException' - '482': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - '483': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/GetDataProtectionPolicyRequest' - parameters: - - name: X-Amz-Target - in: header - required: true - schema: - type: string - enum: - - Logs_20140328.GetDataProtectionPolicy - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /: - post: - operationId: GetLogEvents - description: '

Lists log events from the specified log stream. You can list all of the log events or filter using a time range.

By default, this operation returns as many log events as can fit in a response size of 1MB (up to 10,000 log events). You can get additional log events by specifying one of the tokens in a subsequent call. This operation can return empty results while there are more log events available through the token.

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.

You can specify the log group to search by using either logGroupIdentifier or logGroupName. You must include one of these two parameters, but you can''t include both.

' - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/GetLogEventsResponse' - '480': - description: InvalidParameterException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidParameterException' - '481': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - '482': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/GetLogEventsRequest' - parameters: - - name: limit - in: query - schema: - type: string - description: Pagination limit - required: false - - name: nextToken - in: query - schema: - type: string - description: Pagination token - required: false - - name: X-Amz-Target - in: header - required: false - schema: - type: string - enum: - - Logs_20140328.GetLogEvents - default: Logs_20140328.GetLogEvents - - in: header - name: Content-Type - required: false - schema: - default: application/json - enum: - - application/json - type: string - - in: header - name: Content-Encoding - required: false - schema: - default: amz-1.0 - enum: - - amz-1.0 - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /#X-Amz-Target=Logs_20140328.GetLogGroupFields: - post: - operationId: GetLogGroupFields - description: '

Returns a list of the fields that are included in log events in the specified log group. Includes the percentage of log events that contain each field. The search is limited to a time period that you specify.

You can specify the log group to search by using either logGroupIdentifier or logGroupName. You must specify one of these parameters, but you can''t specify both.

In the results, fields that start with @ are fields generated by CloudWatch Logs. For example, @timestamp is the timestamp of each log event. For more information about the fields that are generated by CloudWatch logs, see Supported Logs and Discovered Fields.

The response results are sorted by the frequency percentage, starting with the highest percentage.

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.

' - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/GetLogGroupFieldsResponse' - '480': - description: InvalidParameterException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidParameterException' - '481': - description: LimitExceededException - content: - application/json: - schema: - $ref: '#/components/schemas/LimitExceededException' - '482': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - '483': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/GetLogGroupFieldsRequest' - parameters: - - name: X-Amz-Target - in: header - required: true - schema: - type: string - enum: - - Logs_20140328.GetLogGroupFields - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /#X-Amz-Target=Logs_20140328.GetLogRecord: - post: - operationId: GetLogRecord - description: '

Retrieves all of the fields and values of a single log event. All fields are retrieved, even if the original query that produced the logRecordPointer retrieved only a subset of fields. Fields are returned as field name/field value pairs.

The full unparsed log event is returned within @message.

' - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/GetLogRecordResponse' - '480': - description: InvalidParameterException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidParameterException' - '481': - description: LimitExceededException - content: - application/json: - schema: - $ref: '#/components/schemas/LimitExceededException' - '482': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - '483': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/GetLogRecordRequest' - parameters: - - name: X-Amz-Target - in: header - required: true - schema: - type: string - enum: - - Logs_20140328.GetLogRecord - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /#X-Amz-Target=Logs_20140328.GetQueryResults: - post: - operationId: GetQueryResults - description: '

Returns the results from the specified query.

Only the fields requested in the query are returned, along with a @ptr field, which is the identifier for the log record. You can use the value of @ptr in a GetLogRecord operation to get the full log record.

GetQueryResults does not start running a query. To run a query, use StartQuery.

If the value of the Status field in the output is Running, this operation returns only partial results. If you see a value of Scheduled or Running for the status, you can retry the operation later to see the final results.

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account to start queries in linked source accounts. For more information, see CloudWatch cross-account observability.

' - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/GetQueryResultsResponse' - '480': - description: InvalidParameterException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidParameterException' - '481': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - '482': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/GetQueryResultsRequest' - parameters: - - name: X-Amz-Target - in: header - required: true - schema: - type: string - enum: - - Logs_20140328.GetQueryResults - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /#X-Amz-Target=Logs_20140328.ListTagsForResource: - post: - operationId: ListTagsForResource - description: 'Displays the tags associated with a CloudWatch Logs resource. Currently, log groups and destinations support tagging.' - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/ListTagsForResourceResponse' - '480': - description: InvalidParameterException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidParameterException' - '481': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - '482': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/ListTagsForResourceRequest' - parameters: - - name: X-Amz-Target - in: header - required: true - schema: - type: string - enum: - - Logs_20140328.ListTagsForResource - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /#X-Amz-Target=Logs_20140328.ListTagsLogGroup: - post: - deprecated: true - operationId: ListTagsLogGroup - description: '

The ListTagsLogGroup operation is on the path to deprecation. We recommend that you use ListTagsForResource instead.

Lists the tags for the specified log group.

' - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/ListTagsLogGroupResponse' - '480': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - '481': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/ListTagsLogGroupRequest' - parameters: - - name: X-Amz-Target - in: header - required: true - schema: - type: string - enum: - - Logs_20140328.ListTagsLogGroup - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /#X-Amz-Target=Logs_20140328.PutDataProtectionPolicy: - post: - operationId: PutDataProtectionPolicy - description: '

Creates a data protection policy for the specified log group. A data protection policy can help safeguard sensitive data that''s ingested by the log group by auditing and masking the sensitive log data.

Sensitive data is detected and masked when it is ingested into the log group. When you set a data protection policy, log events ingested into the log group before that time are not masked.

By default, when a user views a log event that includes masked data, the sensitive data is replaced by asterisks. A user who has the logs:Unmask permission can use a GetLogEvents or FilterLogEvents operation with the unmask parameter set to true to view the unmasked log events. Users with the logs:Unmask can also view unmasked data in the CloudWatch Logs console by running a CloudWatch Logs Insights query with the unmask query command.

For more information, including a list of types of data that can be audited and masked, see Protect sensitive log data with masking.

' - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/PutDataProtectionPolicyResponse' - '480': - description: InvalidParameterException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidParameterException' - '481': - description: LimitExceededException - content: - application/json: - schema: - $ref: '#/components/schemas/LimitExceededException' - '482': - description: OperationAbortedException - content: - application/json: - schema: - $ref: '#/components/schemas/OperationAbortedException' - '483': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - '484': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/PutDataProtectionPolicyRequest' - parameters: - - name: X-Amz-Target - in: header - required: true - schema: - type: string - enum: - - Logs_20140328.PutDataProtectionPolicy - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /#X-Amz-Target=Logs_20140328.PutDestination: - post: - operationId: PutDestination - description: '

Creates or updates a destination. This operation is used only to create destinations for cross-account subscriptions.

A destination encapsulates a physical resource (such as an Amazon Kinesis stream). With a destination, you can subscribe to a real-time stream of log events for a different account, ingested using PutLogEvents.

Through an access policy, a destination controls what is written to it. By default, PutDestination does not set any access policy with the destination, which means a cross-account user cannot call PutSubscriptionFilter against this destination. To enable this, the destination owner must call PutDestinationPolicy after PutDestination.

To perform a PutDestination operation, you must also have the iam:PassRole permission.

' - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/PutDestinationResponse' - '480': - description: InvalidParameterException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidParameterException' - '481': - description: OperationAbortedException - content: - application/json: - schema: - $ref: '#/components/schemas/OperationAbortedException' - '482': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/PutDestinationRequest' - parameters: - - name: X-Amz-Target - in: header - required: true - schema: - type: string - enum: - - Logs_20140328.PutDestination - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /#X-Amz-Target=Logs_20140328.PutDestinationPolicy: - post: - operationId: PutDestinationPolicy - description: 'Creates or updates an access policy associated with an existing destination. An access policy is an IAM policy document that is used to authorize claims to register a subscription filter against a given destination.' - responses: - '200': - description: Success - '480': - description: InvalidParameterException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidParameterException' - '481': - description: OperationAbortedException - content: - application/json: - schema: - $ref: '#/components/schemas/OperationAbortedException' - '482': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/PutDestinationPolicyRequest' - parameters: - - name: X-Amz-Target - in: header - required: true - schema: - type: string - enum: - - Logs_20140328.PutDestinationPolicy - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /#X-Amz-Target=Logs_20140328.PutLogEvents: - post: - operationId: PutLogEvents - description: '

Uploads a batch of log events to the specified log stream.

The sequence token is now ignored in PutLogEvents actions. PutLogEvents actions are always accepted and never return InvalidSequenceTokenException or DataAlreadyAcceptedException even if the sequence token is not valid. You can use parallel PutLogEvents actions on the same log stream.

The batch of events must satisfy the following constraints:

  • The maximum batch size is 1,048,576 bytes. This size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.

  • None of the log events in the batch can be more than 2 hours in the future.

  • None of the log events in the batch can be more than 14 days in the past. Also, none of the log events can be from earlier than the retention period of the log group.

  • The log events in the batch must be in chronological order by their timestamp. The timestamp is the time that the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. (In Amazon Web Services Tools for PowerShell and the Amazon Web Services SDK for .NET, the timestamp is specified in .NET format: yyyy-mm-ddThh:mm:ss. For example, 2017-09-15T13:45:30.)

  • A batch of log events in a single request cannot span more than 24 hours. Otherwise, the operation fails.

  • The maximum number of log events in a batch is 10,000.

  • The quota of five requests per second per log stream has been removed. Instead, PutLogEvents actions are throttled based on a per-second per-account quota. You can request an increase to the per-second throttling quota by using the Service Quotas service.

If a call to PutLogEvents returns "UnrecognizedClientException" the most likely cause is a non-valid Amazon Web Services access key ID or secret key.

' - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/PutLogEventsResponse' - '480': - description: InvalidParameterException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidParameterException' - '481': - description: InvalidSequenceTokenException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidSequenceTokenException' - '482': - description: DataAlreadyAcceptedException - content: - application/json: - schema: - $ref: '#/components/schemas/DataAlreadyAcceptedException' - '483': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - '484': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - '485': - description: UnrecognizedClientException - content: - application/json: - schema: - $ref: '#/components/schemas/UnrecognizedClientException' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/PutLogEventsRequest' - parameters: - - name: X-Amz-Target - in: header - required: true - schema: - type: string - enum: - - Logs_20140328.PutLogEvents - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /#X-Amz-Target=Logs_20140328.PutMetricFilter: - post: - operationId: PutMetricFilter - description: '

Creates or updates a metric filter and associates it with the specified log group. With metric filters, you can configure rules to extract metric data from log events ingested through PutLogEvents.

The maximum number of metric filters that can be associated with a log group is 100.

When you create a metric filter, you can also optionally assign a unit and dimensions to the metric that is created.

Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as IPAddress or requestID as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric.

CloudWatch Logs disables a metric filter if it generates 1,000 different name/value pairs for your specified dimensions within a certain amount of time. This helps to prevent accidental high charges.

You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges.

' - responses: - '200': - description: Success - '480': - description: InvalidParameterException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidParameterException' - '481': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - '482': - description: OperationAbortedException - content: - application/json: - schema: - $ref: '#/components/schemas/OperationAbortedException' - '483': - description: LimitExceededException - content: - application/json: - schema: - $ref: '#/components/schemas/LimitExceededException' - '484': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/PutMetricFilterRequest' - parameters: - - name: X-Amz-Target - in: header - required: true - schema: - type: string - enum: - - Logs_20140328.PutMetricFilter - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /#X-Amz-Target=Logs_20140328.PutQueryDefinition: - post: - operationId: PutQueryDefinition - description: '

Creates or updates a query definition for CloudWatch Logs Insights. For more information, see Analyzing Log Data with CloudWatch Logs Insights.

To update a query definition, specify its queryDefinitionId in your request. The values of name, queryString, and logGroupNames are changed to the values that you specify in your update operation. No current values are retained from the current query definition. For example, imagine updating a current query definition that includes log groups. If you don''t specify the logGroupNames parameter in your update operation, the query definition changes to contain no log groups.

You must have the logs:PutQueryDefinition permission to be able to perform this operation.

' - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/PutQueryDefinitionResponse' - '480': - description: InvalidParameterException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidParameterException' - '481': - description: LimitExceededException - content: - application/json: - schema: - $ref: '#/components/schemas/LimitExceededException' - '482': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - '483': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/PutQueryDefinitionRequest' - parameters: - - name: X-Amz-Target - in: header - required: true - schema: - type: string - enum: - - Logs_20140328.PutQueryDefinition - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /#X-Amz-Target=Logs_20140328.PutResourcePolicy: - post: - operationId: PutResourcePolicy - description: 'Creates or updates a resource policy allowing other Amazon Web Services services to put log events to this account, such as Amazon Route 53. An account can have up to 10 resource policies per Amazon Web Services Region.' - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/PutResourcePolicyResponse' - '480': - description: InvalidParameterException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidParameterException' - '481': - description: LimitExceededException - content: - application/json: - schema: - $ref: '#/components/schemas/LimitExceededException' - '482': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/PutResourcePolicyRequest' - parameters: - - name: X-Amz-Target - in: header - required: true - schema: - type: string - enum: - - Logs_20140328.PutResourcePolicy - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /#X-Amz-Target=Logs_20140328.PutRetentionPolicy: - post: - operationId: PutRetentionPolicy - description: '

Sets the retention of the specified log group. With a retention policy, you can configure the number of days for which to retain log events in the specified log group.

CloudWatch Logs doesn’t immediately delete log events when they reach their retention setting. It typically takes up to 72 hours after that before log events are deleted, but in rare situations might take longer.

To illustrate, imagine that you change a log group to have a longer retention setting when it contains log events that are past the expiration date, but haven’t been deleted. Those log events will take up to 72 hours to be deleted after the new retention date is reached. To make sure that log data is deleted permanently, keep a log group at its lower retention setting until 72 hours after the previous retention period ends. Alternatively, wait to change the retention setting until you confirm that the earlier log events are deleted.

' - responses: - '200': - description: Success - '480': - description: InvalidParameterException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidParameterException' - '481': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - '482': - description: OperationAbortedException - content: - application/json: - schema: - $ref: '#/components/schemas/OperationAbortedException' - '483': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/PutRetentionPolicyRequest' - parameters: - - name: X-Amz-Target - in: header - required: true - schema: - type: string - enum: - - Logs_20140328.PutRetentionPolicy - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /#X-Amz-Target=Logs_20140328.PutSubscriptionFilter: - post: - operationId: PutSubscriptionFilter - description: '

Creates or updates a subscription filter and associates it with the specified log group. With subscription filters, you can subscribe to a real-time stream of log events ingested through PutLogEvents and have them delivered to a specific destination. When log events are sent to the receiving service, they are Base64 encoded and compressed with the GZIP format.

The following destinations are supported for subscription filters:

  • An Amazon Kinesis data stream belonging to the same account as the subscription filter, for same-account delivery.

  • A logical destination that belongs to a different account, for cross-account delivery.

  • An Amazon Kinesis Data Firehose delivery stream that belongs to the same account as the subscription filter, for same-account delivery.

  • An Lambda function that belongs to the same account as the subscription filter, for same-account delivery.

Each log group can have up to two subscription filters associated with it. If you are updating an existing filter, you must specify the correct name in filterName.

To perform a PutSubscriptionFilter operation, you must also have the iam:PassRole permission.

' - responses: - '200': - description: Success - '480': - description: InvalidParameterException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidParameterException' - '481': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - '482': - description: OperationAbortedException - content: - application/json: - schema: - $ref: '#/components/schemas/OperationAbortedException' - '483': - description: LimitExceededException - content: - application/json: - schema: - $ref: '#/components/schemas/LimitExceededException' - '484': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/PutSubscriptionFilterRequest' - parameters: - - name: X-Amz-Target - in: header - required: true - schema: - type: string - enum: - - Logs_20140328.PutSubscriptionFilter - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /#X-Amz-Target=Logs_20140328.StartQuery: - post: - operationId: StartQuery - description: '

Schedules a query of a log group using CloudWatch Logs Insights. You specify the log group and time range to query and the query string to use.

For more information, see CloudWatch Logs Insights Query Syntax.

Queries time out after 15 minutes of runtime. If your queries are timing out, reduce the time range being searched or partition your query into a number of queries.

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account to start a query in a linked source account. For more information, see CloudWatch cross-account observability. For a cross-account StartQuery operation, the query definition must be defined in the monitoring account.

You can have up to 20 concurrent CloudWatch Logs insights queries, including queries that have been added to dashboards.

' - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/StartQueryResponse' - '480': - description: MalformedQueryException - content: - application/json: - schema: - $ref: '#/components/schemas/MalformedQueryException' - '481': - description: InvalidParameterException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidParameterException' - '482': - description: LimitExceededException - content: - application/json: - schema: - $ref: '#/components/schemas/LimitExceededException' - '483': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - '484': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/StartQueryRequest' - parameters: - - name: X-Amz-Target - in: header - required: true - schema: - type: string - enum: - - Logs_20140328.StartQuery - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /#X-Amz-Target=Logs_20140328.StopQuery: - post: - operationId: StopQuery - description: 'Stops a CloudWatch Logs Insights query that is in progress. If the query has already ended, the operation returns an error indicating that the specified query is not running.' - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/StopQueryResponse' - '480': - description: InvalidParameterException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidParameterException' - '481': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - '482': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/StopQueryRequest' - parameters: - - name: X-Amz-Target - in: header - required: true - schema: - type: string - enum: - - Logs_20140328.StopQuery - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /#X-Amz-Target=Logs_20140328.TagLogGroup: - post: - deprecated: true - operationId: TagLogGroup - description: '

The TagLogGroup operation is on the path to deprecation. We recommend that you use TagResource instead.

Adds or updates the specified tags for the specified log group.

To list the tags for a log group, use ListTagsForResource. To remove tags, use UntagResource.

For more information about tags, see Tag Log Groups in Amazon CloudWatch Logs in the Amazon CloudWatch Logs User Guide.

CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to log groups using the aws:Resource/key-name or aws:TagKeys condition keys. For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags.

' - responses: - '200': - description: Success - '480': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - '481': - description: InvalidParameterException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidParameterException' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/TagLogGroupRequest' - parameters: - - name: X-Amz-Target - in: header - required: true - schema: - type: string - enum: - - Logs_20140328.TagLogGroup - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /#X-Amz-Target=Logs_20140328.TagResource: - post: - operationId: TagResource - description: '

Assigns one or more tags (key-value pairs) to the specified CloudWatch Logs resource. Currently, the only CloudWatch Logs resources that can be tagged are log groups and destinations.

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 a resource 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 Logs resource.

' - responses: - '200': - description: Success - '480': - description: InvalidParameterException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidParameterException' - '481': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - '482': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - '483': - description: TooManyTagsException - content: - application/json: - schema: - $ref: '#/components/schemas/TooManyTagsException' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/TagResourceRequest' - parameters: - - name: X-Amz-Target - in: header - required: true - schema: - type: string - enum: - - Logs_20140328.TagResource - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /#X-Amz-Target=Logs_20140328.TestMetricFilter: - post: - operationId: TestMetricFilter - description: Tests the filter pattern of a metric filter against a sample of log event messages. You can use this operation to validate the correctness of a metric filter pattern. - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/TestMetricFilterResponse' - '480': - description: InvalidParameterException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidParameterException' - '481': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/TestMetricFilterRequest' - parameters: - - name: X-Amz-Target - in: header - required: true - schema: - type: string - enum: - - Logs_20140328.TestMetricFilter - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /#X-Amz-Target=Logs_20140328.UntagLogGroup: - post: - deprecated: true - operationId: UntagLogGroup - description: '

The UntagLogGroup operation is on the path to deprecation. We recommend that you use UntagResource instead.

Removes the specified tags from the specified log group.

To list the tags for a log group, use ListTagsForResource. To add tags, use TagResource.

CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to log groups using the aws:Resource/key-name or aws:TagKeys condition keys.

' - responses: - '200': - description: Success - '480': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/UntagLogGroupRequest' - parameters: - - name: X-Amz-Target - in: header - required: true - schema: - type: string - enum: - - Logs_20140328.UntagLogGroup - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /#X-Amz-Target=Logs_20140328.UntagResource: - post: - operationId: UntagResource - description: Removes one or more tags from the specified resource. - responses: - '200': - description: Success - '480': - description: InvalidParameterException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidParameterException' - '481': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - '482': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/UntagResourceRequest' - parameters: - - name: X-Amz-Target - in: header - required: true - schema: - type: string - enum: - - Logs_20140328.UntagResource - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' -components: - parameters: - X-Amz-Content-Sha256: - name: X-Amz-Content-Sha256 - in: header - schema: - type: string - required: false - X-Amz-Date: - name: X-Amz-Date - in: header - schema: - type: string - required: false - X-Amz-Algorithm: - name: X-Amz-Algorithm - in: header - schema: - type: string - required: false - X-Amz-Credential: - name: X-Amz-Credential - in: header - schema: - type: string - required: false - X-Amz-Security-Token: - name: X-Amz-Security-Token - in: header - schema: - type: string - required: false - X-Amz-Signature: - name: X-Amz-Signature - in: header - schema: - type: string - required: false - X-Amz-SignedHeaders: - name: X-Amz-SignedHeaders - in: header - schema: - type: string - required: false - securitySchemes: - hmac: - type: apiKey - name: Authorization - in: header - description: Amazon Signature authorization v4 - x-amazon-apigateway-authtype: awsSigv4 - schemas: - AssociateKmsKeyRequest: - type: object - required: - - logGroupName - - kmsKeyId - title: AssociateKmsKeyRequest - properties: - logGroupName: - allOf: - - $ref: '#/components/schemas/LogGroupName' - - description: The name of the log group. - kmsKeyId: - allOf: - - $ref: '#/components/schemas/KmsKeyId' - - description: 'The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data. This must be a symmetric KMS key. For more information, see Amazon Resource Names and Using Symmetric and Asymmetric Keys.' - InvalidParameterException: {} - ResourceNotFoundException: {} - OperationAbortedException: {} - ServiceUnavailableException: {} - CancelExportTaskRequest: - type: object - required: - - taskId - title: CancelExportTaskRequest - properties: - taskId: - allOf: - - $ref: '#/components/schemas/ExportTaskId' - - description: The ID of the export task. - InvalidOperationException: {} - CreateExportTaskResponse: - type: object - properties: - taskId: - allOf: - - $ref: '#/components/schemas/ExportTaskId' - - description: The ID of the export task. - CreateExportTaskRequest: - type: object - required: - - logGroupName - - from - - to - - destination - title: CreateExportTaskRequest - properties: - taskName: - allOf: - - $ref: '#/components/schemas/ExportTaskName' - - description: The name of the export task. - logGroupName: - allOf: - - $ref: '#/components/schemas/LogGroupName' - - description: The name of the log group. - logStreamNamePrefix: - allOf: - - $ref: '#/components/schemas/LogStreamName' - - description: 'Export only log streams that match the provided prefix. If you don''t specify a value, no prefix filter is applied.' - from: - allOf: - - $ref: '#/components/schemas/Timestamp' - - description: 'The start time of the range for the request, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp earlier than this time are not exported.' - to: - allOf: - - $ref: '#/components/schemas/Timestamp' - - description: '

The end time of the range for the request, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time are not exported.

You must specify a time that is not earlier than when this log group was created.

' - destination: - allOf: - - $ref: '#/components/schemas/ExportDestinationBucket' - - description: The name of S3 bucket for the exported log data. The bucket must be in the same Amazon Web Services Region. - destinationPrefix: - allOf: - - $ref: '#/components/schemas/ExportDestinationPrefix' - - description: 'The prefix used as the start of the key for every object exported. If you don''t specify a value, the default is exportedlogs.' - LimitExceededException: {} - ResourceAlreadyExistsException: {} - CreateLogGroupRequest: - type: object - required: - - logGroupName - title: CreateLogGroupRequest - properties: - logGroupName: - allOf: - - $ref: '#/components/schemas/LogGroupName' - - description: The name of the log group. - kmsKeyId: - allOf: - - $ref: '#/components/schemas/KmsKeyId' - - description: 'The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data. For more information, see Amazon Resource Names.' - tags: - allOf: - - $ref: '#/components/schemas/Tags' - - description: '

The key-value pairs to use for the tags.

You can grant users access to certain log groups while preventing them from accessing other log groups. To do so, tag your groups and use IAM policies that refer to those tags. To assign tags when you create a log group, you must have either the logs:TagResource or logs:TagLogGroup permission. For more information about tagging, see Tagging Amazon Web Services resources. For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags.

' - CreateLogStreamRequest: - type: object - required: - - logGroupName - - logStreamName - title: CreateLogStreamRequest - properties: - logGroupName: - allOf: - - $ref: '#/components/schemas/LogGroupName' - - description: The name of the log group. - logStreamName: - allOf: - - $ref: '#/components/schemas/LogStreamName' - - description: The name of the log stream. - DeleteDataProtectionPolicyRequest: - type: object - required: - - logGroupIdentifier - title: DeleteDataProtectionPolicyRequest - properties: - logGroupIdentifier: - allOf: - - $ref: '#/components/schemas/LogGroupIdentifier' - - description: The name or ARN of the log group that you want to delete the data protection policy for. - DeleteDestinationRequest: - type: object - required: - - destinationName - title: DeleteDestinationRequest - properties: - destinationName: - allOf: - - $ref: '#/components/schemas/DestinationName' - - description: The name of the destination. - DeleteLogGroupRequest: - type: object - required: - - logGroupName - title: DeleteLogGroupRequest - properties: - logGroupName: - allOf: - - $ref: '#/components/schemas/LogGroupName' - - description: The name of the log group. - DeleteLogStreamRequest: - type: object - required: - - logGroupName - - logStreamName - title: DeleteLogStreamRequest - properties: - logGroupName: - allOf: - - $ref: '#/components/schemas/LogGroupName' - - description: The name of the log group. - logStreamName: - allOf: - - $ref: '#/components/schemas/LogStreamName' - - description: The name of the log stream. - DeleteMetricFilterRequest: - type: object - required: - - logGroupName - - filterName - title: DeleteMetricFilterRequest - properties: - logGroupName: - allOf: - - $ref: '#/components/schemas/LogGroupName' - - description: The name of the log group. - filterName: - allOf: - - $ref: '#/components/schemas/FilterName' - - description: The name of the metric filter. - DeleteQueryDefinitionResponse: - type: object - properties: - success: - allOf: - - $ref: '#/components/schemas/Success' - - description: A value of TRUE indicates that the operation succeeded. FALSE indicates that the operation failed. - DeleteQueryDefinitionRequest: - type: object - required: - - queryDefinitionId - title: DeleteQueryDefinitionRequest - properties: - queryDefinitionId: - allOf: - - $ref: '#/components/schemas/QueryId' - - description: 'The ID of the query definition that you want to delete. You can use DescribeQueryDefinitions to retrieve the IDs of your saved query definitions.' - DeleteResourcePolicyRequest: - type: object - title: DeleteResourcePolicyRequest - properties: - policyName: - allOf: - - $ref: '#/components/schemas/PolicyName' - - description: The name of the policy to be revoked. This parameter is required. - DeleteRetentionPolicyRequest: - type: object - required: - - logGroupName - title: DeleteRetentionPolicyRequest - properties: - logGroupName: - allOf: - - $ref: '#/components/schemas/LogGroupName' - - description: The name of the log group. - DeleteSubscriptionFilterRequest: - type: object - required: - - logGroupName - - filterName - title: DeleteSubscriptionFilterRequest - properties: - logGroupName: - allOf: - - $ref: '#/components/schemas/LogGroupName' - - description: The name of the log group. - filterName: - allOf: - - $ref: '#/components/schemas/FilterName' - - description: The name of the subscription filter. - DescribeDestinationsResponse: - type: object - properties: - destinations: - allOf: - - $ref: '#/components/schemas/Destinations' - - description: The destinations. - nextToken: - $ref: '#/components/schemas/NextToken' - DescribeDestinationsRequest: - type: object - title: DescribeDestinationsRequest - properties: - DestinationNamePrefix: - allOf: - - $ref: '#/components/schemas/DestinationName' - - description: 'The prefix to match. If you don''t specify a value, no prefix filter is applied.' - nextToken: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: The token for the next set of items to return. (You received this token from a previous call.) - limit: - allOf: - - $ref: '#/components/schemas/DescribeLimit' - - description: 'The maximum number of items returned. If you don''t specify a value, the default maximum value of 50 items is used.' - DescribeExportTasksResponse: - type: object - properties: - exportTasks: - allOf: - - $ref: '#/components/schemas/ExportTasks' - - description: The export tasks. - nextToken: - $ref: '#/components/schemas/NextToken' - DescribeExportTasksRequest: - type: object - title: DescribeExportTasksRequest - properties: - taskId: - allOf: - - $ref: '#/components/schemas/ExportTaskId' - - description: The ID of the export task. Specifying a task ID filters the results to one or zero export tasks. - statusCode: - allOf: - - $ref: '#/components/schemas/ExportTaskStatusCode' - - description: The status code of the export task. Specifying a status code filters the results to zero or more export tasks. - nextToken: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: The token for the next set of items to return. (You received this token from a previous call.) - limit: - allOf: - - $ref: '#/components/schemas/DescribeLimit' - - description: 'The maximum number of items returned. If you don''t specify a value, the default is up to 50 items.' - DescribeLogGroupsResponse: - type: object - properties: - logGroups: - allOf: - - $ref: '#/components/schemas/LogGroups' - - description: '

The log groups.

If the retentionInDays value is not included for a log group, then that log group''s events do not expire.

' - nextToken: - $ref: '#/components/schemas/NextToken' - DescribeLogGroupsRequest: - type: object - title: DescribeLogGroupsRequest - properties: - accountIdentifiers: - allOf: - - $ref: '#/components/schemas/AccountIds' - - description: 'When includeLinkedAccounts is set to True, use this parameter to specify the list of accounts to search. You can specify as many as 20 account IDs in the array. ' - logGroupNamePrefix: - allOf: - - $ref: '#/components/schemas/LogGroupName' - - description:

The prefix to match.

logGroupNamePrefix and logGroupNamePattern are mutually exclusive. Only one of these parameters can be passed.

- logGroupNamePattern: - allOf: - - $ref: '#/components/schemas/LogGroupNamePattern' - - description: '

If you specify a string for this parameter, the operation returns only log groups that have names that match the string based on a case-sensitive substring search. For example, if you specify Foo, log groups named FooBar, aws/Foo, and GroupFoo would match, but foo, F/o/o and Froo would not match.

logGroupNamePattern and logGroupNamePrefix are mutually exclusive. Only one of these parameters can be passed.

' - nextToken: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: The token for the next set of items to return. (You received this token from a previous call.) - limit: - allOf: - - $ref: '#/components/schemas/DescribeLimit' - - description: 'The maximum number of items returned. If you don''t specify a value, the default is up to 50 items.' - includeLinkedAccounts: - allOf: - - $ref: '#/components/schemas/IncludeLinkedAccounts' - - description: '

If you are using a monitoring account, set this to True to have the operation return log groups in the accounts listed in accountIdentifiers.

If this parameter is set to true and accountIdentifiers contains a null value, the operation returns all log groups in the monitoring account and all log groups in all source accounts that are linked to the monitoring account.

If you specify includeLinkedAccounts in your request, then metricFilterCount, retentionInDays, and storedBytes are not included in the response.

' - DescribeLogStreamsResponse: - type: object - properties: - logStreams: - allOf: - - $ref: '#/components/schemas/LogStreams' - - description: The log streams. - nextToken: - $ref: '#/components/schemas/NextToken' - DescribeLogStreamsRequest: - type: object - title: DescribeLogStreamsRequest - properties: - logGroupName: - allOf: - - $ref: '#/components/schemas/LogGroupName' - - description: '

The name of the log group.

You must include either logGroupIdentifier or logGroupName, but not both.

' - logGroupIdentifier: - allOf: - - $ref: '#/components/schemas/LogGroupIdentifier' - - description: '

Specify either the name or ARN of the log group to view. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN.

You must include either logGroupIdentifier or logGroupName, but not both.

' - logStreamNamePrefix: - allOf: - - $ref: '#/components/schemas/LogStreamName' - - description: '

The prefix to match.

If orderBy is LastEventTime, you cannot specify this parameter.

' - orderBy: - allOf: - - $ref: '#/components/schemas/OrderBy' - - description: '

If the value is LogStreamName, the results are ordered by log stream name. If the value is LastEventTime, the results are ordered by the event time. The default value is LogStreamName.

If you order the results by event time, you cannot specify the logStreamNamePrefix parameter.

lastEventTimestamp represents the time of the most recent log event in the log stream in CloudWatch Logs. This number is expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. lastEventTimestamp updates on an eventual consistency basis. It typically updates in less than an hour from ingestion, but in rare situations might take longer.

' - descending: - allOf: - - $ref: '#/components/schemas/Descending' - - description: 'If the value is true, results are returned in descending order. If the value is to false, results are returned in ascending order. The default value is false.' - nextToken: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: The token for the next set of items to return. (You received this token from a previous call.) - limit: - allOf: - - $ref: '#/components/schemas/DescribeLimit' - - description: 'The maximum number of items returned. If you don''t specify a value, the default is up to 50 items.' - DescribeMetricFiltersResponse: - type: object - properties: - metricFilters: - allOf: - - $ref: '#/components/schemas/MetricFilters' - - description: The metric filters. - nextToken: - $ref: '#/components/schemas/NextToken' - DescribeMetricFiltersRequest: - type: object - title: DescribeMetricFiltersRequest - properties: - logGroupName: - allOf: - - $ref: '#/components/schemas/LogGroupName' - - description: The name of the log group. - filterNamePrefix: - allOf: - - $ref: '#/components/schemas/FilterName' - - description: The prefix to match. CloudWatch Logs uses the value that you set here only if you also include the logGroupName parameter in your request. - nextToken: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: The token for the next set of items to return. (You received this token from a previous call.) - limit: - allOf: - - $ref: '#/components/schemas/DescribeLimit' - - description: 'The maximum number of items returned. If you don''t specify a value, the default is up to 50 items.' - metricName: - allOf: - - $ref: '#/components/schemas/MetricName' - - description: 'Filters results to include only those with the specified metric name. If you include this parameter in your request, you must also include the metricNamespace parameter.' - metricNamespace: - allOf: - - $ref: '#/components/schemas/MetricNamespace' - - description: 'Filters results to include only those in the specified namespace. If you include this parameter in your request, you must also include the metricName parameter.' - DescribeQueriesResponse: - type: object - properties: - queries: - allOf: - - $ref: '#/components/schemas/QueryInfoList' - - description: The list of queries that match the request. - nextToken: - $ref: '#/components/schemas/NextToken' - DescribeQueriesRequest: - type: object - title: DescribeQueriesRequest - properties: - logGroupName: - allOf: - - $ref: '#/components/schemas/LogGroupName' - - description: Limits the returned queries to only those for the specified log group. - status: - allOf: - - $ref: '#/components/schemas/QueryStatus' - - description: 'Limits the returned queries to only those that have the specified status. Valid values are Cancelled, Complete, Failed, Running, and Scheduled.' - maxResults: - allOf: - - $ref: '#/components/schemas/DescribeQueriesMaxResults' - - description: Limits the number of returned queries to the specified number. - nextToken: - $ref: '#/components/schemas/NextToken' - DescribeQueryDefinitionsResponse: - type: object - properties: - queryDefinitions: - allOf: - - $ref: '#/components/schemas/QueryDefinitionList' - - description: The list of query definitions that match your request. - nextToken: - $ref: '#/components/schemas/NextToken' - DescribeQueryDefinitionsRequest: - type: object - title: DescribeQueryDefinitionsRequest - properties: - queryDefinitionNamePrefix: - allOf: - - $ref: '#/components/schemas/QueryDefinitionName' - - description: Use this parameter to filter your results to only the query definitions that have names that start with the prefix you specify. - maxResults: - allOf: - - $ref: '#/components/schemas/QueryListMaxResults' - - description: Limits the number of returned query definitions to the specified number. - nextToken: - $ref: '#/components/schemas/NextToken' - DescribeResourcePoliciesResponse: - type: object - properties: - resourcePolicies: - allOf: - - $ref: '#/components/schemas/ResourcePolicies' - - description: The resource policies that exist in this account. - nextToken: - $ref: '#/components/schemas/NextToken' - DescribeResourcePoliciesRequest: - type: object - title: DescribeResourcePoliciesRequest - properties: - nextToken: - $ref: '#/components/schemas/NextToken' - limit: - allOf: - - $ref: '#/components/schemas/DescribeLimit' - - description: The maximum number of resource policies to be displayed with one call of this API. - DescribeSubscriptionFiltersResponse: - type: object - properties: - subscriptionFilters: - allOf: - - $ref: '#/components/schemas/SubscriptionFilters' - - description: The subscription filters. - nextToken: - $ref: '#/components/schemas/NextToken' - DescribeSubscriptionFiltersRequest: - type: object - required: - - logGroupName - title: DescribeSubscriptionFiltersRequest - properties: - logGroupName: - allOf: - - $ref: '#/components/schemas/LogGroupName' - - description: The name of the log group. - filterNamePrefix: - allOf: - - $ref: '#/components/schemas/FilterName' - - description: 'The prefix to match. If you don''t specify a value, no prefix filter is applied.' - nextToken: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: The token for the next set of items to return. (You received this token from a previous call.) - limit: - allOf: - - $ref: '#/components/schemas/DescribeLimit' - - description: 'The maximum number of items returned. If you don''t specify a value, the default is up to 50 items.' - DisassociateKmsKeyRequest: - type: object - required: - - logGroupName - title: DisassociateKmsKeyRequest - properties: - logGroupName: - allOf: - - $ref: '#/components/schemas/LogGroupName' - - description: The name of the log group. - FilterLogEventsResponse: - type: object - properties: - events: - allOf: - - $ref: '#/components/schemas/FilteredLogEvents' - - description: The matched events. - searchedLogStreams: - allOf: - - $ref: '#/components/schemas/SearchedLogStreams' - - description: '

Important As of May 15, 2020, this parameter is no longer supported. This parameter returns an empty list.

Indicates which log streams have been searched and whether each has been searched completely.

' - nextToken: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: The token to use when requesting the next set of items. The token expires after 24 hours. - FilterLogEventsRequest: - type: object - title: FilterLogEventsRequest - properties: - logGroupName: - allOf: - - $ref: '#/components/schemas/LogGroupName' - - description: '

The name of the log group to search.

You must include either logGroupIdentifier or logGroupName, but not both.

' - logGroupIdentifier: - allOf: - - $ref: '#/components/schemas/LogGroupIdentifier' - - description: '

Specify either the name or ARN of the log group to view log events from. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN.

You must include either logGroupIdentifier or logGroupName, but not both.

' - logStreamNames: - allOf: - - $ref: '#/components/schemas/InputLogStreamNames' - - description: '

Filters the results to only logs from the log streams in this list.

If you specify a value for both logStreamNamePrefix and logStreamNames, the action returns an InvalidParameterException error.

' - logStreamNamePrefix: - allOf: - - $ref: '#/components/schemas/LogStreamName' - - description: '

Filters the results to include only events from log streams that have names starting with this prefix.

If you specify a value for both logStreamNamePrefix and logStreamNames, but the value for logStreamNamePrefix does not match any log stream names specified in logStreamNames, the action returns an InvalidParameterException error.

' - startTime: - allOf: - - $ref: '#/components/schemas/Timestamp' - - description: 'The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp before this time are not returned.' - endTime: - allOf: - - $ref: '#/components/schemas/Timestamp' - - description: 'The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time are not returned.' - filterPattern: - allOf: - - $ref: '#/components/schemas/FilterPattern' - - description: '

The filter pattern to use. For more information, see Filter and Pattern Syntax.

If not provided, all the events are matched.

' - nextToken: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: The token for the next set of events to return. (You received this token from a previous call.) - limit: - allOf: - - $ref: '#/components/schemas/EventsLimit' - - description: 'The maximum number of events to return. The default is 10,000 events.' - interleaved: - allOf: - - $ref: '#/components/schemas/Interleaved' - - deprecated: true - description: '

If the value is true, the operation attempts to provide responses that contain events from multiple log streams within the log group, interleaved in a single response. If the value is false, all the matched log events in the first log stream are searched first, then those in the next log stream, and so on.

Important As of June 17, 2019, this parameter is ignored and the value is assumed to be true. The response from this operation always interleaves events from multiple log streams within a log group.

Starting on June 17, 2019, this parameter will be ignored and the value will be assumed to be true. The response from this operation will always interleave events from multiple log streams within a log group.' - unmask: - allOf: - - $ref: '#/components/schemas/Unmask' - - description: '

Specify true to display the log event fields with all sensitive data unmasked and visible. The default is false.

To use this operation with this parameter, you must be signed into an account with the logs:Unmask permission.

' - GetDataProtectionPolicyResponse: - type: object - properties: - logGroupIdentifier: - allOf: - - $ref: '#/components/schemas/LogGroupIdentifier' - - description: The log group name or ARN that you specified in your request. - policyDocument: - allOf: - - $ref: '#/components/schemas/DataProtectionPolicyDocument' - - description: The data protection policy document for this log group. - lastUpdatedTime: - allOf: - - $ref: '#/components/schemas/Timestamp' - - description: The date and time that this policy was most recently updated. - GetDataProtectionPolicyRequest: - type: object - required: - - logGroupIdentifier - title: GetDataProtectionPolicyRequest - properties: - logGroupIdentifier: - allOf: - - $ref: '#/components/schemas/LogGroupIdentifier' - - description: The name or ARN of the log group that contains the data protection policy that you want to see. - GetLogEventsResponse: - type: object - properties: - events: - $ref: '#/components/schemas/OutputLogEvents' - description: The events. - nextForwardToken: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: 'The token for the next set of items in the forward direction. The token expires after 24 hours. If you have reached the end of the stream, it returns the same token you passed in.' - nextBackwardToken: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: 'The token for the next set of items in the backward direction. The token expires after 24 hours. This token is not null. If you have reached the end of the stream, it returns the same token you passed in.' - GetLogEventsRequest: - type: object - required: - - logStreamName - title: GetLogEventsRequest - properties: - logGroupName: - allOf: - - $ref: '#/components/schemas/LogGroupName' - - description: '

The name of the log group.

You must include either logGroupIdentifier or logGroupName, but not both.

' - logGroupIdentifier: - allOf: - - $ref: '#/components/schemas/LogGroupIdentifier' - - description: '

Specify either the name or ARN of the log group to view events from. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN.

You must include either logGroupIdentifier or logGroupName, but not both.

' - logStreamName: - allOf: - - $ref: '#/components/schemas/LogStreamName' - - description: The name of the log stream. - startTime: - type: integer - minimum: 0 - endTime: - allOf: - - $ref: '#/components/schemas/Timestamp' - - description: 'The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp equal to or later than this time are not included.' - nextToken: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: The token for the next set of items to return. (You received this token from a previous call.) - limit: - allOf: - - $ref: '#/components/schemas/EventsLimit' - - description: 'The maximum number of log events returned. If you don''t specify a limit, the default is as many log events as can fit in a response size of 1 MB (up to 10,000 log events).' - startFromHead: - allOf: - - $ref: '#/components/schemas/StartFromHead' - - description: '

If the value is true, the earliest log events are returned first. If the value is false, the latest log events are returned first. The default value is false.

If you are using a previous nextForwardToken value as the nextToken in this operation, you must specify true for startFromHead.

' - unmask: - allOf: - - $ref: '#/components/schemas/Unmask' - - description: '

Specify true to display the log event fields with all sensitive data unmasked and visible. The default is false.

To use this operation with this parameter, you must be signed into an account with the logs:Unmask permission.

' - GetLogGroupFieldsResponse: - type: object - properties: - logGroupFields: - allOf: - - $ref: '#/components/schemas/LogGroupFieldList' - - description: 'The array of fields found in the query. Each object in the array contains the name of the field, along with the percentage of time it appeared in the log events that were queried.' - GetLogGroupFieldsRequest: - type: object - title: GetLogGroupFieldsRequest - properties: - logGroupName: - allOf: - - $ref: '#/components/schemas/LogGroupName' - - description: '

The name of the log group to search.

You must include either logGroupIdentifier or logGroupName, but not both.

' - time: - allOf: - - $ref: '#/components/schemas/Timestamp' - - description: '

The time to set as the center of the query. If you specify time, the 15 minutes before this time are queries. If you omit time, the 8 minutes before and 8 minutes after this time are searched.

The time value is specified as epoch time, which is the number of seconds since January 1, 1970, 00:00:00 UTC.

' - logGroupIdentifier: - allOf: - - $ref: '#/components/schemas/LogGroupIdentifier' - - description: '

Specify either the name or ARN of the log group to view. If the log group is in a source account and you are using a monitoring account, you must specify the ARN.

You must include either logGroupIdentifier or logGroupName, but not both.

' - GetLogRecordResponse: - type: object - properties: - logRecord: - allOf: - - $ref: '#/components/schemas/LogRecord' - - description: 'The requested log event, as a JSON string.' - GetLogRecordRequest: - type: object - required: - - logRecordPointer - title: GetLogRecordRequest - properties: - logRecordPointer: - allOf: - - $ref: '#/components/schemas/LogRecordPointer' - - description: 'The pointer corresponding to the log event record you want to retrieve. You get this from the response of a GetQueryResults operation. In that response, the value of the @ptr field for a log event is the value to use as logRecordPointer to retrieve that complete log event record.' - unmask: - allOf: - - $ref: '#/components/schemas/Unmask' - - description: '

Specify true to display the log event fields with all sensitive data unmasked and visible. The default is false.

To use this operation with this parameter, you must be signed into an account with the logs:Unmask permission.

' - GetQueryResultsResponse: - type: object - properties: - results: - allOf: - - $ref: '#/components/schemas/QueryResults' - - description:

The log events that matched the query criteria during the most recent time it ran.

The results value is an array of arrays. Each log event is one object in the top-level array. Each of these log event objects is an array of field/value pairs.

- statistics: - allOf: - - $ref: '#/components/schemas/QueryStatistics' - - description: 'Includes the number of log events scanned by the query, the number of log events that matched the query criteria, and the total number of bytes in the log events that were scanned. These values reflect the full raw results of the query.' - status: - allOf: - - $ref: '#/components/schemas/QueryStatus' - - description: '

The status of the most recent running of the query. Possible values are Cancelled, Complete, Failed, Running, Scheduled, Timeout, and Unknown.

Queries time out after 15 minutes of runtime. To avoid having your queries time out, reduce the time range being searched or partition your query into a number of queries.

' - GetQueryResultsRequest: - type: object - required: - - queryId - title: GetQueryResultsRequest - properties: - queryId: - allOf: - - $ref: '#/components/schemas/QueryId' - - description: The ID number of the query. - ListTagsForResourceResponse: - type: object - properties: - tags: - allOf: - - $ref: '#/components/schemas/Tags' - - description: The list of tags associated with the requested resource.> - ListTagsForResourceRequest: - type: object - required: - - resourceArn - title: ListTagsForResourceRequest - properties: - resourceArn: - allOf: - - $ref: '#/components/schemas/AmazonResourceName' - - description: '

The ARN of the resource that you want to view tags for.

The ARN format of a log group is arn:aws:logs:Region:account-id:log-group:log-group-name

The ARN format of a destination is arn:aws:logs:Region:account-id:destination:destination-name

For more information about ARN format, see CloudWatch Logs resources and operations.

' - ListTagsLogGroupResponse: - type: object - deprecated: true - properties: - tags: - allOf: - - $ref: '#/components/schemas/Tags' - - description: The tags for the log group. - description: Please use the generic tagging API model ListTagsForResourceRequest and ListTagsForResourceResponse - ListTagsLogGroupRequest: - type: object - required: - - logGroupName - deprecated: true - title: ListTagsLogGroupRequest - properties: - logGroupName: - allOf: - - $ref: '#/components/schemas/LogGroupName' - - description: The name of the log group. - description: Please use the generic tagging API model ListTagsForResourceRequest and ListTagsForResourceResponse - PutDataProtectionPolicyResponse: - type: object - properties: - logGroupIdentifier: - allOf: - - $ref: '#/components/schemas/LogGroupIdentifier' - - description: The log group name or ARN that you specified in your request. - policyDocument: - allOf: - - $ref: '#/components/schemas/DataProtectionPolicyDocument' - - description: The data protection policy used for this log group. - lastUpdatedTime: - allOf: - - $ref: '#/components/schemas/Timestamp' - - description: The date and time that this policy was most recently updated. - PutDataProtectionPolicyRequest: - type: object - required: - - logGroupIdentifier - - policyDocument - title: PutDataProtectionPolicyRequest - properties: - logGroupIdentifier: - allOf: - - $ref: '#/components/schemas/LogGroupIdentifier' - - description: Specify either the log group name or log group ARN. - policyDocument: - allOf: - - $ref: '#/components/schemas/DataProtectionPolicyDocument' - - description: '

Specify the data protection policy, in JSON.

This policy must include two JSON blocks:

  • The first block must include both a DataIdentifer array and an Operation property with an Audit action. The DataIdentifer array lists the types of sensitive data that you want to mask. For more information about the available options, see Types of data that you can mask.

    The Operation property with an Audit action is required to find the sensitive data terms. This Audit action must contain a FindingsDestination object. You can optionally use that FindingsDestination object to list one or more destinations to send audit findings to. If you specify destinations such as log groups, Kinesis Data Firehose streams, and S3 buckets, they must already exist.

  • The second block must include both a DataIdentifer array and an Operation property with an Deidentify action. The DataIdentifer array must exactly match the DataIdentifer array in the first block of the policy.

    The Operation property with the Deidentify action is what actually masks the data, and it must contain the "MaskConfig": {} object. The "MaskConfig": {} object must be empty.

For an example data protection policy, see the Examples section on this page.

The contents of two DataIdentifer arrays must match exactly.

' - PutDestinationResponse: - type: object - properties: - destination: - allOf: - - $ref: '#/components/schemas/Destination' - - description: The destination. - PutDestinationRequest: - type: object - required: - - destinationName - - targetArn - - roleArn - title: PutDestinationRequest - properties: - destinationName: - allOf: - - $ref: '#/components/schemas/DestinationName' - - description: A name for the destination. - targetArn: - allOf: - - $ref: '#/components/schemas/TargetArn' - - description: The ARN of an Amazon Kinesis stream to which to deliver matching log events. - roleArn: - allOf: - - $ref: '#/components/schemas/RoleArn' - - description: The ARN of an IAM role that grants CloudWatch Logs permissions to call the Amazon Kinesis PutRecord operation on the destination stream. - tags: - allOf: - - $ref: '#/components/schemas/Tags' - - description: '

An optional list of key-value pairs to associate with the resource.

For more information about tagging, see Tagging Amazon Web Services resources

' - PutDestinationPolicyRequest: - type: object - required: - - destinationName - - accessPolicy - title: PutDestinationPolicyRequest - properties: - destinationName: - allOf: - - $ref: '#/components/schemas/DestinationName' - - description: A name for an existing destination. - accessPolicy: - allOf: - - $ref: '#/components/schemas/AccessPolicy' - - description: An IAM policy document that authorizes cross-account users to deliver their log events to the associated destination. This can be up to 5120 bytes. - forceUpdate: - allOf: - - $ref: '#/components/schemas/ForceUpdate' - - description: '

Specify true if you are updating an existing destination policy to grant permission to an organization ID instead of granting permission to individual AWS accounts. Before you update a destination policy this way, you must first update the subscription filters in the accounts that send logs to this destination. If you do not, the subscription filters might stop working. By specifying true for forceUpdate, you are affirming that you have already updated the subscription filters. For more information, see Updating an existing cross-account subscription

If you omit this parameter, the default of false is used.

' - PutLogEventsResponse: - type: object - properties: - nextSequenceToken: - allOf: - - $ref: '#/components/schemas/SequenceToken' - - description:

The next sequence token.

This field has been deprecated.

The sequence token is now ignored in PutLogEvents actions. PutLogEvents actions are always accepted even if the sequence token is not valid. You can use parallel PutLogEvents actions on the same log stream and you do not need to wait for the response of a previous PutLogEvents action to obtain the nextSequenceToken value.

 - rejectedLogEventsInfo: - allOf: - - $ref: '#/components/schemas/RejectedLogEventsInfo' - - description: The rejected events. - PutLogEventsRequest: - type: object - required: - - logGroupName - - logStreamName - - logEvents - title: PutLogEventsRequest - properties: - logGroupName: - allOf: - - $ref: '#/components/schemas/LogGroupName' - - description: The name of the log group. - logStreamName: - allOf: - - $ref: '#/components/schemas/LogStreamName' - - description: The name of the log stream. - logEvents: - allOf: - - $ref: '#/components/schemas/InputLogEvents' - - description: The log events. - sequenceToken: - allOf: - - $ref: '#/components/schemas/SequenceToken' - - description:

The sequence token obtained from the response of the previous PutLogEvents call.

The sequenceToken parameter is now ignored in PutLogEvents actions. PutLogEvents actions are now accepted and never return InvalidSequenceTokenException or DataAlreadyAcceptedException even if the sequence token is not valid.

 - InvalidSequenceTokenException: {} - DataAlreadyAcceptedException: {} - UnrecognizedClientException: {} - PutMetricFilterRequest: - type: object - required: - - logGroupName - - filterName - - filterPattern - - metricTransformations - title: PutMetricFilterRequest - properties: - logGroupName: - allOf: - - $ref: '#/components/schemas/LogGroupName' - - description: The name of the log group. - filterName: - allOf: - - $ref: '#/components/schemas/FilterName' - - description: A name for the metric filter. - filterPattern: - allOf: - - $ref: '#/components/schemas/FilterPattern' - - description: A filter pattern for extracting metric data out of ingested log events. - metricTransformations: - allOf: - - $ref: '#/components/schemas/MetricTransformations' - - description: A collection of information that defines how metric data gets emitted. - PutQueryDefinitionResponse: - type: object - properties: - queryDefinitionId: - allOf: - - $ref: '#/components/schemas/QueryId' - - description: The ID of the query definition. - PutQueryDefinitionRequest: - type: object - required: - - name - - queryString - title: PutQueryDefinitionRequest - properties: - name: - allOf: - - $ref: '#/components/schemas/QueryDefinitionName' - - description: 'A name for the query definition. If you are saving numerous query definitions, we recommend that you name them. This way, you can find the ones you want by using the first part of the name as a filter in the queryDefinitionNamePrefix parameter of DescribeQueryDefinitions.' - queryDefinitionId: - allOf: - - $ref: '#/components/schemas/QueryId' - - description: '

If you are updating a query definition, use this parameter to specify the ID of the query definition that you want to update. You can use DescribeQueryDefinitions to retrieve the IDs of your saved query definitions.

If you are creating a query definition, do not specify this parameter. CloudWatch generates a unique ID for the new query definition and include it in the response to this operation.

' - logGroupNames: - allOf: - - $ref: '#/components/schemas/LogGroupNames' - - description: '

Use this parameter to include specific log groups as part of your query definition.

If you are updating a query definition and you omit this parameter, then the updated definition will contain no log groups.

' - queryString: - allOf: - - $ref: '#/components/schemas/QueryDefinitionString' - - description: 'The query string to use for this definition. For more information, see CloudWatch Logs Insights Query Syntax.' - PutResourcePolicyResponse: - type: object - properties: - resourcePolicy: - allOf: - - $ref: '#/components/schemas/ResourcePolicy' - - description: The new policy. - PutResourcePolicyRequest: - type: object - title: PutResourcePolicyRequest - properties: - policyName: - allOf: - - $ref: '#/components/schemas/PolicyName' - - description: Name of the new policy. This parameter is required. - policyDocument: - allOf: - - $ref: '#/components/schemas/PolicyDocument' - - description: "

Details of the new policy, including the identity of the principal that is enabled to put logs to this account. This is formatted as a JSON string. This parameter is required.

The following example creates a resource policy enabling the Route 53 service to put DNS query logs in to the specified log group. Replace \"logArn\" with the ARN of your CloudWatch Logs resource, such as a log group or log stream.

CloudWatch Logs also supports aws:SourceArn and aws:SourceAccount condition context keys.

In the example resource policy, you would replace the value of SourceArn with the resource making the call from Route\_53 to CloudWatch Logs. You would also replace the value of SourceAccount with the Amazon Web Services account ID making that call.

{ \"Version\": \"2012-10-17\", \"Statement\": [ { \"Sid\": \"Route53LogsToCloudWatchLogs\", \"Effect\": \"Allow\", \"Principal\": { \"Service\": [ \"route53.amazonaws.com\" ] }, \"Action\": \"logs:PutLogEvents\", \"Resource\": \"logArn\", \"Condition\": { \"ArnLike\": { \"aws:SourceArn\": \"myRoute53ResourceArn\" }, \"StringEquals\": { \"aws:SourceAccount\": \"myAwsAccountId\" } } } ] }

" - PutRetentionPolicyRequest: - type: object - required: - - logGroupName - - retentionInDays - title: PutRetentionPolicyRequest - properties: - logGroupName: - allOf: - - $ref: '#/components/schemas/LogGroupName' - - description: The name of the log group. - retentionInDays: - $ref: '#/components/schemas/Days' - PutSubscriptionFilterRequest: - type: object - required: - - logGroupName - - filterName - - filterPattern - - destinationArn - title: PutSubscriptionFilterRequest - properties: - logGroupName: - allOf: - - $ref: '#/components/schemas/LogGroupName' - - description: The name of the log group. - filterName: - allOf: - - $ref: '#/components/schemas/FilterName' - - description: 'A name for the subscription filter. If you are updating an existing filter, you must specify the correct name in filterName. To find the name of the filter currently associated with a log group, use DescribeSubscriptionFilters.' - filterPattern: - allOf: - - $ref: '#/components/schemas/FilterPattern' - - description: A filter pattern for subscribing to a filtered stream of log events. - destinationArn: - allOf: - - $ref: '#/components/schemas/DestinationArn' - - description: '

The ARN of the destination to deliver matching log events to. Currently, the supported destinations are:

  • An Amazon Kinesis stream belonging to the same account as the subscription filter, for same-account delivery.

  • A logical destination (specified using an ARN) belonging to a different account, for cross-account delivery.

    If you''re setting up a cross-account subscription, the destination must have an IAM policy associated with it. The IAM policy must allow the sender to send logs to the destination. For more information, see PutDestinationPolicy.

  • A Kinesis Data Firehose delivery stream belonging to the same account as the subscription filter, for same-account delivery.

  • A Lambda function belonging to the same account as the subscription filter, for same-account delivery.

' - roleArn: - allOf: - - $ref: '#/components/schemas/RoleArn' - - description: The ARN of an IAM role that grants CloudWatch Logs permissions to deliver ingested log events to the destination stream. You don't need to provide the ARN when you are working with a logical destination for cross-account delivery. - distribution: - allOf: - - $ref: '#/components/schemas/Distribution' - - description: 'The method used to distribute log data to the destination. By default, log data is grouped by log stream, but the grouping can be set to random for a more even distribution. This property is only applicable when the destination is an Amazon Kinesis data stream. ' - StartQueryResponse: - type: object - properties: - queryId: - allOf: - - $ref: '#/components/schemas/QueryId' - - description: 'The unique ID of the query. ' - StartQueryRequest: - type: object - required: - - startTime - - endTime - - queryString - title: StartQueryRequest - properties: - logGroupName: - allOf: - - $ref: '#/components/schemas/LogGroupName' - - description: '

The log group on which to perform the query.

A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames or logGroupIdentifiers.

' - logGroupNames: - allOf: - - $ref: '#/components/schemas/LogGroupNames' - - description: '

The list of log groups to be queried. You can include up to 50 log groups.

A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames or logGroupIdentifiers.

' - logGroupIdentifiers: - allOf: - - $ref: '#/components/schemas/LogGroupIdentifiers' - - description: '

The list of log groups to query. You can include up to 50 log groups.

You can specify them by the log group name or ARN. If a log group that you''re querying is in a source account and you''re using a monitoring account, you must specify the ARN of the log group here. The query definition must also be defined in the monitoring account.

If you specify an ARN, the ARN can''t end with an asterisk (*).

A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames or logGroupIdentifiers.

' - startTime: - allOf: - - $ref: '#/components/schemas/Timestamp' - - description: 'The beginning of the time range to query. The range is inclusive, so the specified start time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.' - endTime: - allOf: - - $ref: '#/components/schemas/Timestamp' - - description: 'The end of the time range to query. The range is inclusive, so the specified end time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.' - queryString: - allOf: - - $ref: '#/components/schemas/QueryString' - - description: 'The query string to use. For more information, see CloudWatch Logs Insights Query Syntax.' - limit: - allOf: - - $ref: '#/components/schemas/EventsLimit' - - description: 'The maximum number of log events to return in the query. If the query string uses the fields command, only the specified fields and their values are returned. The default is 1000.' - MalformedQueryException: {} - StopQueryResponse: - type: object - properties: - success: - allOf: - - $ref: '#/components/schemas/Success' - - description: This is true if the query was stopped by the StopQuery operation. - StopQueryRequest: - type: object - required: - - queryId - title: StopQueryRequest - properties: - queryId: - allOf: - - $ref: '#/components/schemas/QueryId' - - description: 'The ID number of the query to stop. To find this ID number, use DescribeQueries.' - TagLogGroupRequest: - type: object - required: - - logGroupName - - tags - deprecated: true - title: TagLogGroupRequest - properties: - logGroupName: - allOf: - - $ref: '#/components/schemas/LogGroupName' - - description: The name of the log group. - tags: - allOf: - - $ref: '#/components/schemas/Tags' - - description: The key-value pairs to use for the tags. - description: Please use the generic tagging API model TagResourceRequest - TagResourceRequest: - type: object - required: - - resourceArn - - tags - title: TagResourceRequest - properties: - resourceArn: - allOf: - - $ref: '#/components/schemas/AmazonResourceName' - - description: '

The ARN of the resource that you''re adding tags to.

The ARN format of a log group is arn:aws:logs:Region:account-id:log-group:log-group-name

The ARN format of a destination is arn:aws:logs:Region:account-id:destination:destination-name

For more information about ARN format, see CloudWatch Logs resources and operations.

' - tags: - allOf: - - $ref: '#/components/schemas/Tags' - - description: The list of key-value pairs to associate with the resource. - TooManyTagsException: {} - TestMetricFilterResponse: - type: object - properties: - matches: - allOf: - - $ref: '#/components/schemas/MetricFilterMatches' - - description: The matched events. - TestMetricFilterRequest: - type: object - required: - - filterPattern - - logEventMessages - title: TestMetricFilterRequest - properties: - filterPattern: - $ref: '#/components/schemas/FilterPattern' - logEventMessages: - allOf: - - $ref: '#/components/schemas/TestEventMessages' - - description: The log event messages to test. - UntagLogGroupRequest: - type: object - required: - - logGroupName - - tags - deprecated: true - title: UntagLogGroupRequest - properties: - logGroupName: - allOf: - - $ref: '#/components/schemas/LogGroupName' - - description: The name of the log group. - tags: - allOf: - - $ref: '#/components/schemas/TagList' - - description: The tag keys. The corresponding tags are removed from the log group. - description: Please use the generic tagging API model UntagResourceRequest - UntagResourceRequest: - type: object - required: - - resourceArn - - tagKeys - title: UntagResourceRequest - properties: - resourceArn: - allOf: - - $ref: '#/components/schemas/AmazonResourceName' - - description: '

The ARN of the CloudWatch Logs resource that you''re removing tags from.

The ARN format of a log group is arn:aws:logs:Region:account-id:log-group:log-group-name

The ARN format of a destination is arn:aws:logs:Region:account-id:destination:destination-name

For more information about ARN format, see CloudWatch Logs resources and operations.

' - tagKeys: - allOf: - - $ref: '#/components/schemas/TagKeyList' - - description: The list of tag keys to remove from the resource. - AccessPolicy: - type: string - minLength: 1 - AccountId: - type: string - pattern: '^\d{12}$' - minLength: 12 - maxLength: 12 - AccountIds: - type: array - items: - $ref: '#/components/schemas/AccountId' - minItems: 0 - maxItems: 20 - AmazonResourceName: - type: string - pattern: '[\w+=/:,.@-]*' - minLength: 1 - maxLength: 1011 - Arn: - type: string - LogGroupName: - type: string - pattern: '[\.\-_/#A-Za-z0-9]+' - minLength: 1 - maxLength: 512 - KmsKeyId: - type: string - maxLength: 256 - ExportTaskId: - type: string - minLength: 1 - maxLength: 512 - ExportTaskName: - type: string - minLength: 1 - maxLength: 512 - LogStreamName: - type: string - pattern: '[^:*]*' - minLength: 1 - maxLength: 512 - Timestamp: - type: number - minimum: 0 - ExportDestinationBucket: - type: string - minLength: 1 - maxLength: 512 - ExportDestinationPrefix: - type: string - Tags: - type: object - minProperties: 1 - maxProperties: 50 - additionalProperties: - $ref: '#/components/schemas/TagValue' - DataProtectionPolicyDocument: - type: string - DataProtectionStatus: - type: string - enum: - - ACTIVATED - - DELETED - - ARCHIVED - - DISABLED - Days: - type: integer - description: '

The number of days to retain the log events in the specified log group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, 2192, 2557, 2922, 3288, and 3653.

To set a log group so that its log events do not expire, use DeleteRetentionPolicy.

' - DefaultValue: - type: number - format: double - LogGroupIdentifier: - type: string - pattern: '[\w#+=/:,.@-]*' - minLength: 1 - maxLength: 2048 - DestinationName: - type: string - pattern: '[^:*]*' - minLength: 1 - maxLength: 512 - FilterName: - type: string - pattern: '[^:*]*' - minLength: 1 - maxLength: 512 - QueryId: - type: string - minLength: 0 - maxLength: 256 - Success: - type: boolean - PolicyName: - type: string - Descending: - type: boolean - NextToken: - type: string - description: The token for the next set of items to return. The token expires after 24 hours. - minLength: 1 - DescribeLimit: - type: integer - minimum: 1 - maximum: 50 - Destinations: - type: array - items: - $ref: '#/components/schemas/Destination' - ExportTaskStatusCode: - type: string - enum: - - CANCELLED - - COMPLETED - - FAILED - - PENDING - - PENDING_CANCEL - - RUNNING - ExportTasks: - type: array - items: - $ref: '#/components/schemas/ExportTask' - LogGroupNamePattern: - type: string - pattern: '[\.\-_/#A-Za-z0-9]*' - minLength: 0 - maxLength: 512 - IncludeLinkedAccounts: - type: boolean - LogGroups: - type: array - items: - $ref: '#/components/schemas/LogGroup' - OrderBy: - type: string - enum: - - LogStreamName - - LastEventTime - LogStreams: - type: array - items: - $ref: '#/components/schemas/LogStream' - MetricName: - type: string - pattern: '[^:*$]*' - description: 'The name of the CloudWatch metric to which the monitored log information should be published. For example, you might publish to a metric named ErrorCount.' - maxLength: 255 - MetricNamespace: - type: string - pattern: '[^:*$]*' - maxLength: 255 - MetricFilters: - type: array - items: - $ref: '#/components/schemas/MetricFilter' - DescribeQueriesMaxResults: - type: integer - minimum: 1 - maximum: 1000 - QueryStatus: - type: string - enum: - - Scheduled - - Running - - Complete - - Failed - - Cancelled - - Timeout - - Unknown - QueryInfoList: - type: array - items: - $ref: '#/components/schemas/QueryInfo' - QueryDefinitionName: - type: string - minLength: 1 - maxLength: 255 - QueryListMaxResults: - type: integer - minimum: 1 - maximum: 1000 - QueryDefinitionList: - type: array - items: - $ref: '#/components/schemas/QueryDefinition' - ResourcePolicies: - type: array - items: - $ref: '#/components/schemas/ResourcePolicy' - SubscriptionFilters: - type: array - items: - $ref: '#/components/schemas/SubscriptionFilter' - TargetArn: - type: string - minLength: 1 - RoleArn: - type: string - minLength: 1 - Destination: - type: object - properties: - destinationName: - allOf: - - $ref: '#/components/schemas/DestinationName' - - description: The name of the destination. - targetArn: - allOf: - - $ref: '#/components/schemas/TargetArn' - - description: 'The Amazon Resource Name (ARN) of the physical target where the log events are delivered (for example, a Kinesis stream).' - roleArn: - allOf: - - $ref: '#/components/schemas/RoleArn' - - description: 'A role for impersonation, used when delivering log events to the target.' - accessPolicy: - allOf: - - $ref: '#/components/schemas/AccessPolicy' - - description: An IAM policy document that governs which Amazon Web Services accounts can create subscription filters against this destination. - arn: - allOf: - - $ref: '#/components/schemas/Arn' - - description: The ARN of this destination. - creationTime: - allOf: - - $ref: '#/components/schemas/Timestamp' - - description: 'The creation time of the destination, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.' - description: Represents a cross-account destination that receives subscription log events. - DestinationArn: - type: string - minLength: 1 - DimensionsValue: - type: string - maxLength: 255 - Dimensions: - type: object - additionalProperties: - $ref: '#/components/schemas/DimensionsValue' - DimensionsKey: - type: string - maxLength: 255 - Distribution: - type: string - enum: - - Random - - ByLogStream - description: 'The method used to distribute log data to the destination, which can be either random or grouped by log stream.' - EventId: - type: string - EventMessage: - type: string - minLength: 1 - EventNumber: - type: integer - EventsLimit: - type: integer - minimum: 1 - maximum: 10000 - ExportTaskStatus: - type: object - properties: - code: - allOf: - - $ref: '#/components/schemas/ExportTaskStatusCode' - - description: The status code of the export task. - message: - allOf: - - $ref: '#/components/schemas/ExportTaskStatusMessage' - - description: The status message related to the status code. - description: Represents the status of an export task. - ExportTaskExecutionInfo: - type: object - properties: - creationTime: - allOf: - - $ref: '#/components/schemas/Timestamp' - - description: 'The creation time of the export task, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.' - completionTime: - allOf: - - $ref: '#/components/schemas/Timestamp' - - description: 'The completion time of the export task, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.' - description: Represents the status of an export task. - ExportTask: - type: object - properties: - taskId: - allOf: - - $ref: '#/components/schemas/ExportTaskId' - - description: The ID of the export task. - taskName: - allOf: - - $ref: '#/components/schemas/ExportTaskName' - - description: The name of the export task. - logGroupName: - allOf: - - $ref: '#/components/schemas/LogGroupName' - - description: The name of the log group from which logs data was exported. - from: - allOf: - - $ref: '#/components/schemas/Timestamp' - - description: 'The start time, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp before this time are not exported.' - to: - allOf: - - $ref: '#/components/schemas/Timestamp' - - description: 'The end time, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time are not exported.' - destination: - allOf: - - $ref: '#/components/schemas/ExportDestinationBucket' - - description: The name of the S3 bucket to which the log data was exported. - destinationPrefix: - allOf: - - $ref: '#/components/schemas/ExportDestinationPrefix' - - description: The prefix that was used as the start of Amazon S3 key for every object exported. - status: - allOf: - - $ref: '#/components/schemas/ExportTaskStatus' - - description: The status of the export task. - executionInfo: - allOf: - - $ref: '#/components/schemas/ExportTaskExecutionInfo' - - description: Execution information about the export task. - description: Represents an export task. - ExportTaskStatusMessage: - type: string - Value: - type: string - ExtractedValues: - type: object - additionalProperties: - $ref: '#/components/schemas/Value' - Field: - type: string - FilterCount: - type: integer - InputLogStreamNames: - type: array - items: - $ref: '#/components/schemas/LogStreamName' - minItems: 1 - maxItems: 100 - FilterPattern: - type: string - description: 'A symbolic description of how CloudWatch Logs should interpret the data in each log event. For example, a log event can contain timestamps, IP addresses, strings, and so on. You use the filter pattern to specify what to look for in the log event message.' - minLength: 0 - maxLength: 1024 - Interleaved: - type: boolean - Unmask: - type: boolean - FilteredLogEvents: - type: array - items: - $ref: '#/components/schemas/FilteredLogEvent' - SearchedLogStreams: - type: array - items: - $ref: '#/components/schemas/SearchedLogStream' - FilteredLogEvent: - type: object - properties: - logStreamName: - allOf: - - $ref: '#/components/schemas/LogStreamName' - - description: The name of the log stream to which this event belongs. - timestamp: - allOf: - - $ref: '#/components/schemas/Timestamp' - - description: 'The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.' - message: - allOf: - - $ref: '#/components/schemas/EventMessage' - - description: The data contained in the log event. - ingestionTime: - allOf: - - $ref: '#/components/schemas/Timestamp' - - description: 'The time the event was ingested, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.' - eventId: - allOf: - - $ref: '#/components/schemas/EventId' - - description: The ID of the event. - description: Represents a matched event. - ForceUpdate: - type: boolean - StartFromHead: - type: boolean - OutputLogEvents: - type: array - items: - $ref: '#/components/schemas/OutputLogEvent' - LogGroupFieldList: - type: array - items: - $ref: '#/components/schemas/LogGroupField' - LogRecordPointer: - type: string - LogRecord: - type: object - additionalProperties: - $ref: '#/components/schemas/Value' - QueryResults: - type: array - items: - $ref: '#/components/schemas/ResultRows' - QueryStatistics: - type: object - properties: - recordsMatched: - allOf: - - $ref: '#/components/schemas/StatsValue' - - description: The number of log events that matched the query string. - recordsScanned: - allOf: - - $ref: '#/components/schemas/StatsValue' - - description: The total number of log events scanned during the query. - bytesScanned: - allOf: - - $ref: '#/components/schemas/StatsValue' - - description: The total number of bytes in the log events scanned during the query. - description: 'Contains the number of log events scanned by the query, the number of log events that matched the query criteria, and the total number of bytes in the log events that were scanned.' - InputLogEvent: - type: object - required: - - timestamp - - message - properties: - timestamp: - allOf: - - $ref: '#/components/schemas/Timestamp' - - description: 'The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.' - message: - allOf: - - $ref: '#/components/schemas/EventMessage' - - description: The raw event message. - description: 'Represents a log event, which is a record of activity that was recorded by the application or resource being monitored.' - InputLogEvents: - type: array - items: - $ref: '#/components/schemas/InputLogEvent' - minItems: 1 - maxItems: 10000 - LogEventIndex: - type: integer - StoredBytes: - type: integer - minimum: 0 - LogGroup: - type: object - properties: - logGroupName: - allOf: - - $ref: '#/components/schemas/LogGroupName' - - description: The name of the log group. - creationTime: - allOf: - - $ref: '#/components/schemas/Timestamp' - - description: 'The creation time of the log group, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.' - retentionInDays: - $ref: '#/components/schemas/Days' - metricFilterCount: - allOf: - - $ref: '#/components/schemas/FilterCount' - - description: The number of metric filters. - arn: - allOf: - - $ref: '#/components/schemas/Arn' - - description: The Amazon Resource Name (ARN) of the log group. - storedBytes: - allOf: - - $ref: '#/components/schemas/StoredBytes' - - description: The number of bytes stored. - kmsKeyId: - allOf: - - $ref: '#/components/schemas/KmsKeyId' - - description: The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data. - dataProtectionStatus: - allOf: - - $ref: '#/components/schemas/DataProtectionStatus' - - description: 'Displays whether this log group has a protection policy, or whether it had one in the past. For more information, see PutDataProtectionPolicy.' - description: Represents a log group. - Percentage: - type: integer - minimum: 0 - maximum: 100 - LogGroupField: - type: object - properties: - name: - allOf: - - $ref: '#/components/schemas/Field' - - description: The name of a log field. - percent: - allOf: - - $ref: '#/components/schemas/Percentage' - - description: The percentage of log events queried that contained the field. - description: 'The fields contained in log events found by a GetLogGroupFields operation, along with the percentage of queried log events in which each field appears.' - LogGroupIdentifiers: - type: array - items: - $ref: '#/components/schemas/LogGroupIdentifier' - LogGroupNames: - type: array - items: - $ref: '#/components/schemas/LogGroupName' - SequenceToken: - type: string - minLength: 1 - LogStream: - type: object - properties: - logStreamName: - allOf: - - $ref: '#/components/schemas/LogStreamName' - - description: The name of the log stream. - creationTime: - allOf: - - $ref: '#/components/schemas/Timestamp' - - description: 'The creation time of the stream, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.' - firstEventTimestamp: - allOf: - - $ref: '#/components/schemas/Timestamp' - - description: 'The time of the first event, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.' - lastEventTimestamp: - allOf: - - $ref: '#/components/schemas/Timestamp' - - description: 'The time of the most recent log event in the log stream in CloudWatch Logs. This number is expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. The lastEventTime value updates on an eventual consistency basis. It typically updates in less than an hour from ingestion, but in rare situations might take longer.' - lastIngestionTime: - allOf: - - $ref: '#/components/schemas/Timestamp' - - description: 'The ingestion time, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC The lastIngestionTime value updates on an eventual consistency basis. It typically updates in less than an hour after ingestion, but in rare situations might take longer.' - uploadSequenceToken: - allOf: - - $ref: '#/components/schemas/SequenceToken' - - description:

The sequence token.

The sequence token is now ignored in PutLogEvents actions. PutLogEvents actions are always accepted regardless of receiving an invalid sequence token. You don't need to obtain uploadSequenceToken to use a PutLogEvents action.

 - arn: - allOf: - - $ref: '#/components/schemas/Arn' - - description: The Amazon Resource Name (ARN) of the log stream. - storedBytes: - allOf: - - $ref: '#/components/schemas/StoredBytes' - - deprecated: true - description: '

The number of bytes stored.

Important: As of June 17, 2019, this parameter is no longer supported for log streams, and is always reported as zero. This change applies only to log streams. The storedBytes parameter for log groups is not affected.

Starting on June 17, 2019, this parameter will be deprecated for log streams, and will be reported as zero. This change applies only to log streams. The storedBytes parameter for log groups is not affected.' - description: 'Represents a log stream, which is a sequence of log events from a single emitter of logs.' - LogStreamSearchedCompletely: - type: boolean - MetricTransformations: - type: array - items: - $ref: '#/components/schemas/MetricTransformation' - minItems: 1 - maxItems: 1 - MetricFilter: - type: object - properties: - filterName: - allOf: - - $ref: '#/components/schemas/FilterName' - - description: The name of the metric filter. - filterPattern: - $ref: '#/components/schemas/FilterPattern' - metricTransformations: - allOf: - - $ref: '#/components/schemas/MetricTransformations' - - description: The metric transformations. - creationTime: - allOf: - - $ref: '#/components/schemas/Timestamp' - - description: 'The creation time of the metric filter, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.' - logGroupName: - allOf: - - $ref: '#/components/schemas/LogGroupName' - - description: The name of the log group. - description: Metric filters express how CloudWatch Logs would extract metric observations from ingested log events and transform them into metric data in a CloudWatch metric. - MetricFilterMatchRecord: - type: object - properties: - eventNumber: - allOf: - - $ref: '#/components/schemas/EventNumber' - - description: The event number. - eventMessage: - allOf: - - $ref: '#/components/schemas/EventMessage' - - description: The raw event data. - extractedValues: - allOf: - - $ref: '#/components/schemas/ExtractedValues' - - description: The values extracted from the event data by the filter. - description: Represents a matched event. - MetricFilterMatches: - type: array - items: - $ref: '#/components/schemas/MetricFilterMatchRecord' - MetricValue: - type: string - description: 'The value to publish to the CloudWatch metric. For example, if you''re counting the occurrences of a term like Error, the value is 1 for each occurrence. If you''re counting the bytes transferred, the value is the value in the log event.' - maxLength: 100 - StandardUnit: - type: string - enum: - - Seconds - - Microseconds - - Milliseconds - - Bytes - - Kilobytes - - Megabytes - - Gigabytes - - Terabytes - - Bits - - Kilobits - - Megabits - - Gigabits - - Terabits - - Percent - - Count - - Bytes/Second - - Kilobytes/Second - - Megabytes/Second - - Gigabytes/Second - - Terabytes/Second - - Bits/Second - - Kilobits/Second - - Megabits/Second - - Gigabits/Second - - Terabits/Second - - Count/Second - - None - MetricTransformation: - type: object - required: - - metricName - - metricNamespace - - metricValue - properties: - metricName: - allOf: - - $ref: '#/components/schemas/MetricName' - - description: The name of the CloudWatch metric. - metricNamespace: - allOf: - - $ref: '#/components/schemas/MetricNamespace' - - description: 'A custom namespace to contain your metric in CloudWatch. Use namespaces to group together metrics that are similar. For more information, see Namespaces.' - metricValue: - allOf: - - $ref: '#/components/schemas/MetricValue' - - description: The value to publish to the CloudWatch metric when a filter pattern matches a log event. - defaultValue: - allOf: - - $ref: '#/components/schemas/DefaultValue' - - description: (Optional) The value to emit when a filter pattern does not match a log event. This value can be null. - dimensions: - allOf: - - $ref: '#/components/schemas/Dimensions' - - description: '

The fields to use as dimensions for the metric. One metric filter can include as many as three dimensions.

Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as IPAddress or requestID as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric.

CloudWatch Logs disables a metric filter if it generates 1000 different name/value pairs for your specified dimensions within a certain amount of time. This helps to prevent accidental high charges.

You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges.

' - unit: - allOf: - - $ref: '#/components/schemas/StandardUnit' - - description: 'The unit to assign to the metric. If you omit this, the unit is set as None.' - description: Indicates how to transform ingested log events to metric data in a CloudWatch metric. - OutputLogEvent: - type: object - properties: - timestamp: - allOf: - - $ref: '#/components/schemas/Timestamp' - - description: 'The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.' - message: - allOf: - - $ref: '#/components/schemas/EventMessage' - - description: The data contained in the log event. - ingestionTime: - allOf: - - $ref: '#/components/schemas/Timestamp' - - description: 'The time the event was ingested, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.' - description: Represents a log event. - PolicyDocument: - type: string - minLength: 1 - maxLength: 5120 - RejectedLogEventsInfo: - type: object - properties: - tooNewLogEventStartIndex: - allOf: - - $ref: '#/components/schemas/LogEventIndex' - - description: The log events that are too new. - tooOldLogEventEndIndex: - allOf: - - $ref: '#/components/schemas/LogEventIndex' - - description: The log events that are dated too far in the past. - expiredLogEventEndIndex: - allOf: - - $ref: '#/components/schemas/LogEventIndex' - - description: The expired log events. - description: Represents the rejected events. - QueryDefinitionString: - type: string - minLength: 1 - maxLength: 10000 - ResourcePolicy: - type: object - properties: - policyName: - allOf: - - $ref: '#/components/schemas/PolicyName' - - description: The name of the resource policy. - policyDocument: - allOf: - - $ref: '#/components/schemas/PolicyDocument' - - description: The details of the policy. - lastUpdatedTime: - allOf: - - $ref: '#/components/schemas/Timestamp' - - description: 'Timestamp showing when this policy was last updated, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.' - description: A policy enabling one or more entities to put logs to a log group in this account. - QueryDefinition: - type: object - properties: - queryDefinitionId: - allOf: - - $ref: '#/components/schemas/QueryId' - - description: The unique ID of the query definition. - name: - allOf: - - $ref: '#/components/schemas/QueryDefinitionName' - - description: The name of the query definition. - queryString: - allOf: - - $ref: '#/components/schemas/QueryDefinitionString' - - description: 'The query string to use for this definition. For more information, see CloudWatch Logs Insights Query Syntax.' - lastModified: - allOf: - - $ref: '#/components/schemas/Timestamp' - - description: The date that the query definition was most recently modified. - logGroupNames: - allOf: - - $ref: '#/components/schemas/LogGroupNames' - - description: 'If this query definition contains a list of log groups that it is limited to, that list appears here.' - description: This structure contains details about a saved CloudWatch Logs Insights query definition. - QueryString: - type: string - minLength: 0 - maxLength: 10000 - QueryInfo: - type: object - properties: - queryId: - allOf: - - $ref: '#/components/schemas/QueryId' - - description: The unique ID number of this query. - queryString: - allOf: - - $ref: '#/components/schemas/QueryString' - - description: The query string used in this query. - status: - allOf: - - $ref: '#/components/schemas/QueryStatus' - - description: 'The status of this query. Possible values are Cancelled, Complete, Failed, Running, Scheduled, and Unknown.' - createTime: - allOf: - - $ref: '#/components/schemas/Timestamp' - - description: The date and time that this query was created. - logGroupName: - allOf: - - $ref: '#/components/schemas/LogGroupName' - - description: The name of the log group scanned by this query. - description: 'Information about one CloudWatch Logs Insights query that matches the request in a DescribeQueries operation. ' - ResultRows: - type: array - items: - $ref: '#/components/schemas/ResultField' - StatsValue: - type: number - format: double - ResultField: - type: object - properties: - field: - allOf: - - $ref: '#/components/schemas/Field' - - description: The log event field. - value: - allOf: - - $ref: '#/components/schemas/Value' - - description: The value of this field. - description: '

Contains one field from one log event returned by a CloudWatch Logs Insights query, along with the value of that field.

For more information about the fields that are generated by CloudWatch logs, see Supported Logs and Discovered Fields.

' - SearchedLogStream: - type: object - properties: - logStreamName: - allOf: - - $ref: '#/components/schemas/LogStreamName' - - description: The name of the log stream. - searchedCompletely: - allOf: - - $ref: '#/components/schemas/LogStreamSearchedCompletely' - - description: Indicates whether all the events in this log stream were searched. - description: Represents the search status of a log stream. - SubscriptionFilter: - type: object - properties: - filterName: - allOf: - - $ref: '#/components/schemas/FilterName' - - description: The name of the subscription filter. - logGroupName: - allOf: - - $ref: '#/components/schemas/LogGroupName' - - description: The name of the log group. - filterPattern: - $ref: '#/components/schemas/FilterPattern' - destinationArn: - allOf: - - $ref: '#/components/schemas/DestinationArn' - - description: The Amazon Resource Name (ARN) of the destination. - roleArn: - allOf: - - $ref: '#/components/schemas/RoleArn' - - description:

- distribution: - $ref: '#/components/schemas/Distribution' - creationTime: - allOf: - - $ref: '#/components/schemas/Timestamp' - - description: 'The creation time of the subscription filter, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.' - description: Represents a subscription filter. - TagKey: - type: string - pattern: '^([\p{L}\p{Z}\p{N}_.:/=+\-@]+)$' - minLength: 1 - maxLength: 128 - TagKeyList: - type: array - items: - $ref: '#/components/schemas/TagKey' - minItems: 0 - maxItems: 50 - TagList: - type: array - items: - $ref: '#/components/schemas/TagKey' - minItems: 1 - TagValue: - type: string - pattern: '^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$' - maxLength: 256 - TestEventMessages: - type: array - items: - $ref: '#/components/schemas/EventMessage' - minItems: 1 - maxItems: 50 - Token: - type: string - x-stackQL-resources: - log_events: - id: aws.cloudwatch_api.log_events - methods: - GetLogEvents: - operation: - $ref: '#/paths/~1/post' - request: - mediaType: application/json - response: - mediaType: application/json - # objectKey: /*/OutputLogEvents - objectKey: $.events - openAPIDocKey: '200' - name: log_events - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/log_events/methods/GetLogEvents' - update: [] - title: log_events -security: - - hmac: [] -x-stackQL-config: - # queryParamTranspose: - # algorithm: AWSCanonical - # requestTranslate: - # algorithm: get_query_to_post_form_utf_8 \ No newline at end of file diff --git a/providers/src/aws/v00.00.00000/services/codeartifact.yaml b/providers/src/aws/v00.00.00000/services/codeartifact.yaml index 2453e052..3e5c93f7 100644 --- a/providers/src/aws/v00.00.00000/services/codeartifact.yaml +++ b/providers/src/aws/v00.00.00000/services/codeartifact.yaml @@ -910,7 +910,7 @@ components: x-cfn-type-name: AWS::CodeArtifact::Domain x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -927,9 +927,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -939,41 +939,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/domains/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/domains/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CodeArtifact::Domain' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CodeArtifact::Domain' - AND region = 'us-east-1' - domain: - name: domain - id: aws.codeartifact.domain - x-cfn-schema-name: Domain - x-cfn-type-name: AWS::CodeArtifact::Domain - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -984,12 +952,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/domains/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/domains/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/domain/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/domains/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1005,21 +977,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'DomainName') as domain_name, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Owner') as owner, - json_extract_path_text(Properties, 'EncryptionKey') as encryption_key, - json_extract_path_text(Properties, 'PermissionsPolicyDocument') as permissions_policy_document, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CodeArtifact::Domain' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CodeArtifact::Domain' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DomainName') as domain_name, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Owner') as owner, + json_extract_path_text(Properties, 'EncryptionKey') as encryption_key, + json_extract_path_text(Properties, 'PermissionsPolicyDocument') as permissions_policy_document, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CodeArtifact::Domain' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CodeArtifact::Domain' + AND region = 'us-east-1' package_groups: name: package_groups id: aws.codeartifact.package_groups @@ -1027,7 +1015,7 @@ components: x-cfn-type-name: AWS::CodeArtifact::PackageGroup x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1044,9 +1032,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1056,41 +1044,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/package_groups/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/package_groups/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CodeArtifact::PackageGroup' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CodeArtifact::PackageGroup' - AND region = 'us-east-1' - package_group: - name: package_group - id: aws.codeartifact.package_group - x-cfn-schema-name: PackageGroup - x-cfn-type-name: AWS::CodeArtifact::PackageGroup - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1101,12 +1057,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/package_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/package_groups/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/package_group/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/package_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1123,22 +1083,38 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'DomainName') as domain_name, - json_extract_path_text(Properties, 'DomainOwner') as domain_owner, - json_extract_path_text(Properties, 'Pattern') as pattern, - json_extract_path_text(Properties, 'ContactInfo') as contact_info, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'OriginConfiguration') as origin_configuration, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CodeArtifact::PackageGroup' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CodeArtifact::PackageGroup' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DomainName') as domain_name, + json_extract_path_text(Properties, 'DomainOwner') as domain_owner, + json_extract_path_text(Properties, 'Pattern') as pattern, + json_extract_path_text(Properties, 'ContactInfo') as contact_info, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'OriginConfiguration') as origin_configuration, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CodeArtifact::PackageGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CodeArtifact::PackageGroup' + AND region = 'us-east-1' repositories: name: repositories id: aws.codeartifact.repositories @@ -1146,7 +1122,7 @@ components: x-cfn-type-name: AWS::CodeArtifact::Repository x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1163,9 +1139,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1175,41 +1151,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/repositories/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/repositories/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CodeArtifact::Repository' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CodeArtifact::Repository' - AND region = 'us-east-1' - repository: - name: repository - id: aws.codeartifact.repository - x-cfn-schema-name: Repository - x-cfn-type-name: AWS::CodeArtifact::Repository - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1220,12 +1164,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/repositories/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/repositories/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/repository/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/repositories/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1244,24 +1192,40 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'RepositoryName') as repository_name, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'DomainName') as domain_name, - json_extract_path_text(Properties, 'DomainOwner') as domain_owner, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'ExternalConnections') as external_connections, - json_extract_path_text(Properties, 'Upstreams') as upstreams, - json_extract_path_text(Properties, 'PermissionsPolicyDocument') as permissions_policy_document, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CodeArtifact::Repository' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CodeArtifact::Repository' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'RepositoryName') as repository_name, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'DomainName') as domain_name, + json_extract_path_text(Properties, 'DomainOwner') as domain_owner, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'ExternalConnections') as external_connections, + json_extract_path_text(Properties, 'Upstreams') as upstreams, + json_extract_path_text(Properties, 'PermissionsPolicyDocument') as permissions_policy_document, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CodeArtifact::Repository' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CodeArtifact::Repository' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/codebuild.yaml b/providers/src/aws/v00.00.00000/services/codebuild.yaml index c444a41f..896dacb8 100644 --- a/providers/src/aws/v00.00.00000/services/codebuild.yaml +++ b/providers/src/aws/v00.00.00000/services/codebuild.yaml @@ -404,6 +404,22 @@ components: required: - Value - Key + VpcConfig: + type: object + additionalProperties: false + properties: + VpcId: + type: string + Subnets: + type: array + x-insertionOrder: false + items: + type: string + SecurityGroupIds: + type: array + x-insertionOrder: false + items: + type: string Fleet: type: object properties: @@ -429,6 +445,16 @@ components: - BUILD_GENERAL1_MEDIUM - BUILD_GENERAL1_LARGE - BUILD_GENERAL1_2XLARGE + OverflowBehavior: + type: string + enum: + - QUEUE + - ON_DEMAND + FleetServiceRole: + type: string + pattern: ^(?:arn:)[a-zA-Z+-=,._:/@]+$ + FleetVpcConfig: + $ref: '#/components/schemas/VpcConfig' Tags: type: array x-insertionOrder: false @@ -454,6 +480,7 @@ components: create: - codebuild:BatchGetFleets - codebuild:CreateFleet + - iam:PassRole delete: - codebuild:BatchGetFleets - codebuild:DeleteFleet @@ -464,6 +491,7 @@ components: update: - codebuild:BatchGetFleets - codebuild:UpdateFleet + - iam:PassRole CreateFleetRequest: properties: ClientToken: @@ -499,6 +527,16 @@ components: - BUILD_GENERAL1_MEDIUM - BUILD_GENERAL1_LARGE - BUILD_GENERAL1_2XLARGE + OverflowBehavior: + type: string + enum: + - QUEUE + - ON_DEMAND + FleetServiceRole: + type: string + pattern: ^(?:arn:)[a-zA-Z+-=,._:/@]+$ + FleetVpcConfig: + $ref: '#/components/schemas/VpcConfig' Tags: type: array x-insertionOrder: false @@ -526,7 +564,7 @@ components: x-cfn-type-name: AWS::CodeBuild::Fleet x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -543,9 +581,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -555,41 +593,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/fleets/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/fleets/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CodeBuild::Fleet' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CodeBuild::Fleet' - AND region = 'us-east-1' - fleet: - name: fleet - id: aws.codebuild.fleet - x-cfn-schema-name: Fleet - x-cfn-type-name: AWS::CodeBuild::Fleet - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -600,12 +606,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/fleets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/fleets/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/fleet/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/fleets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -614,26 +624,48 @@ components: JSON_EXTRACT(Properties, '$.BaseCapacity') as base_capacity, JSON_EXTRACT(Properties, '$.EnvironmentType') as environment_type, JSON_EXTRACT(Properties, '$.ComputeType') as compute_type, + JSON_EXTRACT(Properties, '$.OverflowBehavior') as overflow_behavior, + JSON_EXTRACT(Properties, '$.FleetServiceRole') as fleet_service_role, + JSON_EXTRACT(Properties, '$.FleetVpcConfig') as fleet_vpc_config, JSON_EXTRACT(Properties, '$.Tags') as tags, JSON_EXTRACT(Properties, '$.Arn') as arn FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CodeBuild::Fleet' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'BaseCapacity') as base_capacity, - json_extract_path_text(Properties, 'EnvironmentType') as environment_type, - json_extract_path_text(Properties, 'ComputeType') as compute_type, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CodeBuild::Fleet' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CodeBuild::Fleet' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'BaseCapacity') as base_capacity, + json_extract_path_text(Properties, 'EnvironmentType') as environment_type, + json_extract_path_text(Properties, 'ComputeType') as compute_type, + json_extract_path_text(Properties, 'OverflowBehavior') as overflow_behavior, + json_extract_path_text(Properties, 'FleetServiceRole') as fleet_service_role, + json_extract_path_text(Properties, 'FleetVpcConfig') as fleet_vpc_config, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CodeBuild::Fleet' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CodeBuild::Fleet' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/codeconnections.yaml b/providers/src/aws/v00.00.00000/services/codeconnections.yaml index 83383ff5..7db8c9a7 100644 --- a/providers/src/aws/v00.00.00000/services/codeconnections.yaml +++ b/providers/src/aws/v00.00.00000/services/codeconnections.yaml @@ -547,7 +547,7 @@ components: x-cfn-type-name: AWS::CodeConnections::Connection x-identifiers: - ConnectionArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -564,9 +564,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -576,41 +576,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/connections/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/connections/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ConnectionArn') as connection_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CodeConnections::Connection' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ConnectionArn') as connection_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CodeConnections::Connection' - AND region = 'us-east-1' - connection: - name: connection - id: aws.codeconnections.connection - x-cfn-schema-name: Connection - x-cfn-type-name: AWS::CodeConnections::Connection - x-identifiers: - - ConnectionArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -621,12 +589,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/connections/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/connections/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/connection/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/connections/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -642,21 +614,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ConnectionArn') as connection_arn, - json_extract_path_text(Properties, 'ConnectionName') as connection_name, - json_extract_path_text(Properties, 'ConnectionStatus') as connection_status, - json_extract_path_text(Properties, 'OwnerAccountId') as owner_account_id, - json_extract_path_text(Properties, 'ProviderType') as provider_type, - json_extract_path_text(Properties, 'HostArn') as host_arn, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CodeConnections::Connection' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ConnectionArn') as connection_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CodeConnections::Connection' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ConnectionArn') as connection_arn, + json_extract_path_text(Properties, 'ConnectionName') as connection_name, + json_extract_path_text(Properties, 'ConnectionStatus') as connection_status, + json_extract_path_text(Properties, 'OwnerAccountId') as owner_account_id, + json_extract_path_text(Properties, 'ProviderType') as provider_type, + json_extract_path_text(Properties, 'HostArn') as host_arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CodeConnections::Connection' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ConnectionArn') as connection_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CodeConnections::Connection' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/codedeploy.yaml b/providers/src/aws/v00.00.00000/services/codedeploy.yaml index c9a9282f..a8001498 100644 --- a/providers/src/aws/v00.00.00000/services/codedeploy.yaml +++ b/providers/src/aws/v00.00.00000/services/codedeploy.yaml @@ -631,7 +631,7 @@ components: x-cfn-type-name: AWS::CodeDeploy::Application x-identifiers: - ApplicationName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -648,9 +648,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -660,41 +660,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/applications/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/applications/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ApplicationName') as application_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CodeDeploy::Application' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ApplicationName') as application_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CodeDeploy::Application' - AND region = 'us-east-1' - application: - name: application - id: aws.codedeploy.application - x-cfn-schema-name: Application - x-cfn-type-name: AWS::CodeDeploy::Application - x-identifiers: - - ApplicationName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -705,12 +673,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/applications/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/applications/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/application/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/applications/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -722,17 +694,33 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ApplicationName') as application_name, - json_extract_path_text(Properties, 'ComputePlatform') as compute_platform, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CodeDeploy::Application' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ApplicationName') as application_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CodeDeploy::Application' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ApplicationName') as application_name, + json_extract_path_text(Properties, 'ComputePlatform') as compute_platform, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CodeDeploy::Application' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ApplicationName') as application_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CodeDeploy::Application' + AND region = 'us-east-1' deployment_configs: name: deployment_configs id: aws.codedeploy.deployment_configs @@ -740,7 +728,7 @@ components: x-cfn-type-name: AWS::CodeDeploy::DeploymentConfig x-identifiers: - DeploymentConfigName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -774,39 +762,11 @@ components: - $ref: '#/components/x-stackQL-resources/deployment_configs/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/deployment_configs/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.DeploymentConfigName') as deployment_config_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CodeDeploy::DeploymentConfig' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'DeploymentConfigName') as deployment_config_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CodeDeploy::DeploymentConfig' - AND region = 'us-east-1' - deployment_config: - name: deployment_config - id: aws.codedeploy.deployment_config - x-cfn-schema-name: DeploymentConfig - x-cfn-type-name: AWS::CodeDeploy::DeploymentConfig - x-identifiers: - - DeploymentConfigName - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -820,19 +780,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ComputePlatform') as compute_platform, - json_extract_path_text(Properties, 'DeploymentConfigName') as deployment_config_name, - json_extract_path_text(Properties, 'MinimumHealthyHosts') as minimum_healthy_hosts, - json_extract_path_text(Properties, 'ZonalConfig') as zonal_config, - json_extract_path_text(Properties, 'TrafficRoutingConfig') as traffic_routing_config - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CodeDeploy::DeploymentConfig' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.DeploymentConfigName') as deployment_config_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CodeDeploy::DeploymentConfig' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ComputePlatform') as compute_platform, + json_extract_path_text(Properties, 'DeploymentConfigName') as deployment_config_name, + json_extract_path_text(Properties, 'MinimumHealthyHosts') as minimum_healthy_hosts, + json_extract_path_text(Properties, 'ZonalConfig') as zonal_config, + json_extract_path_text(Properties, 'TrafficRoutingConfig') as traffic_routing_config + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CodeDeploy::DeploymentConfig' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DeploymentConfigName') as deployment_config_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CodeDeploy::DeploymentConfig' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/codeguruprofiler.yaml b/providers/src/aws/v00.00.00000/services/codeguruprofiler.yaml index 067dfc5f..b57ba379 100644 --- a/providers/src/aws/v00.00.00000/services/codeguruprofiler.yaml +++ b/providers/src/aws/v00.00.00000/services/codeguruprofiler.yaml @@ -584,7 +584,7 @@ components: x-cfn-type-name: AWS::CodeGuruProfiler::ProfilingGroup x-identifiers: - ProfilingGroupName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -601,9 +601,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -613,41 +613,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/profiling_groups/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/profiling_groups/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ProfilingGroupName') as profiling_group_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CodeGuruProfiler::ProfilingGroup' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ProfilingGroupName') as profiling_group_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CodeGuruProfiler::ProfilingGroup' - AND region = 'us-east-1' - profiling_group: - name: profiling_group - id: aws.codeguruprofiler.profiling_group - x-cfn-schema-name: ProfilingGroup - x-cfn-type-name: AWS::CodeGuruProfiler::ProfilingGroup - x-identifiers: - - ProfilingGroupName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -658,12 +626,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/profiling_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/profiling_groups/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/profiling_group/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/profiling_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -678,20 +650,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ProfilingGroupName') as profiling_group_name, - json_extract_path_text(Properties, 'ComputePlatform') as compute_platform, - json_extract_path_text(Properties, 'AgentPermissions') as agent_permissions, - json_extract_path_text(Properties, 'AnomalyDetectionNotificationConfiguration') as anomaly_detection_notification_configuration, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CodeGuruProfiler::ProfilingGroup' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ProfilingGroupName') as profiling_group_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CodeGuruProfiler::ProfilingGroup' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ProfilingGroupName') as profiling_group_name, + json_extract_path_text(Properties, 'ComputePlatform') as compute_platform, + json_extract_path_text(Properties, 'AgentPermissions') as agent_permissions, + json_extract_path_text(Properties, 'AnomalyDetectionNotificationConfiguration') as anomaly_detection_notification_configuration, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CodeGuruProfiler::ProfilingGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ProfilingGroupName') as profiling_group_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CodeGuruProfiler::ProfilingGroup' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/codegurureviewer.yaml b/providers/src/aws/v00.00.00000/services/codegurureviewer.yaml index 6054b473..b4914b92 100644 --- a/providers/src/aws/v00.00.00000/services/codegurureviewer.yaml +++ b/providers/src/aws/v00.00.00000/services/codegurureviewer.yaml @@ -579,7 +579,7 @@ components: x-cfn-type-name: AWS::CodeGuruReviewer::RepositoryAssociation x-identifiers: - AssociationArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -613,39 +613,11 @@ components: - $ref: '#/components/x-stackQL-resources/repository_associations/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/repository_associations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AssociationArn') as association_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CodeGuruReviewer::RepositoryAssociation' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AssociationArn') as association_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CodeGuruReviewer::RepositoryAssociation' - AND region = 'us-east-1' - repository_association: - name: repository_association - id: aws.codegurureviewer.repository_association - x-cfn-schema-name: RepositoryAssociation - x-cfn-type-name: AWS::CodeGuruReviewer::RepositoryAssociation - x-identifiers: - - AssociationArn - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -661,21 +633,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Type') as type, - json_extract_path_text(Properties, 'Owner') as owner, - json_extract_path_text(Properties, 'BucketName') as bucket_name, - json_extract_path_text(Properties, 'ConnectionArn') as connection_arn, - json_extract_path_text(Properties, 'AssociationArn') as association_arn, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CodeGuruReviewer::RepositoryAssociation' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.AssociationArn') as association_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CodeGuruReviewer::RepositoryAssociation' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'Owner') as owner, + json_extract_path_text(Properties, 'BucketName') as bucket_name, + json_extract_path_text(Properties, 'ConnectionArn') as connection_arn, + json_extract_path_text(Properties, 'AssociationArn') as association_arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CodeGuruReviewer::RepositoryAssociation' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AssociationArn') as association_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CodeGuruReviewer::RepositoryAssociation' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/codepipeline.yaml b/providers/src/aws/v00.00.00000/services/codepipeline.yaml index e4787761..cab975f2 100644 --- a/providers/src/aws/v00.00.00000/services/codepipeline.yaml +++ b/providers/src/aws/v00.00.00000/services/codepipeline.yaml @@ -619,7 +619,7 @@ components: - Category - Provider - Version - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -636,9 +636,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -648,47 +648,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/custom_action_types/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/custom_action_types/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Category') as category, - JSON_EXTRACT(Properties, '$.Provider') as provider, - JSON_EXTRACT(Properties, '$.Version') as version - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CodePipeline::CustomActionType' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Category') as category, - json_extract_path_text(Properties, 'Provider') as provider, - json_extract_path_text(Properties, 'Version') as version - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CodePipeline::CustomActionType' - AND region = 'us-east-1' - custom_action_type: - name: custom_action_type - id: aws.codepipeline.custom_action_type - x-cfn-schema-name: CustomActionType - x-cfn-type-name: AWS::CodePipeline::CustomActionType - x-identifiers: - - Category - - Provider - - Version - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -699,12 +661,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/custom_action_types/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/custom_action_types/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/custom_action_type/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/custom_action_types/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -722,23 +688,43 @@ components: AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Category') as category, - json_extract_path_text(Properties, 'ConfigurationProperties') as configuration_properties, - json_extract_path_text(Properties, 'InputArtifactDetails') as input_artifact_details, - json_extract_path_text(Properties, 'OutputArtifactDetails') as output_artifact_details, - json_extract_path_text(Properties, 'Provider') as provider, - json_extract_path_text(Properties, 'Settings') as settings, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Version') as version, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CodePipeline::CustomActionType' - AND data__Identifier = '||' + JSON_EXTRACT(Properties, '$.Category') as category, + JSON_EXTRACT(Properties, '$.Provider') as provider, + JSON_EXTRACT(Properties, '$.Version') as version + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CodePipeline::CustomActionType' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Category') as category, + json_extract_path_text(Properties, 'ConfigurationProperties') as configuration_properties, + json_extract_path_text(Properties, 'InputArtifactDetails') as input_artifact_details, + json_extract_path_text(Properties, 'OutputArtifactDetails') as output_artifact_details, + json_extract_path_text(Properties, 'Provider') as provider, + json_extract_path_text(Properties, 'Settings') as settings, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Version') as version, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CodePipeline::CustomActionType' + AND data__Identifier = '||' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Category') as category, + json_extract_path_text(Properties, 'Provider') as provider, + json_extract_path_text(Properties, 'Version') as version + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CodePipeline::CustomActionType' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/codestarconnections.yaml b/providers/src/aws/v00.00.00000/services/codestarconnections.yaml index 1c2172a2..bc5254e0 100644 --- a/providers/src/aws/v00.00.00000/services/codestarconnections.yaml +++ b/providers/src/aws/v00.00.00000/services/codestarconnections.yaml @@ -864,7 +864,7 @@ components: x-cfn-type-name: AWS::CodeStarConnections::Connection x-identifiers: - ConnectionArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -881,9 +881,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -893,41 +893,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/connections/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/connections/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ConnectionArn') as connection_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CodeStarConnections::Connection' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ConnectionArn') as connection_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CodeStarConnections::Connection' - AND region = 'us-east-1' - connection: - name: connection - id: aws.codestarconnections.connection - x-cfn-schema-name: Connection - x-cfn-type-name: AWS::CodeStarConnections::Connection - x-identifiers: - - ConnectionArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -938,12 +906,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/connections/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/connections/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/connection/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/connections/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -959,21 +931,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ConnectionArn') as connection_arn, - json_extract_path_text(Properties, 'ConnectionName') as connection_name, - json_extract_path_text(Properties, 'ConnectionStatus') as connection_status, - json_extract_path_text(Properties, 'OwnerAccountId') as owner_account_id, - json_extract_path_text(Properties, 'ProviderType') as provider_type, - json_extract_path_text(Properties, 'HostArn') as host_arn, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CodeStarConnections::Connection' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ConnectionArn') as connection_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CodeStarConnections::Connection' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ConnectionArn') as connection_arn, + json_extract_path_text(Properties, 'ConnectionName') as connection_name, + json_extract_path_text(Properties, 'ConnectionStatus') as connection_status, + json_extract_path_text(Properties, 'OwnerAccountId') as owner_account_id, + json_extract_path_text(Properties, 'ProviderType') as provider_type, + json_extract_path_text(Properties, 'HostArn') as host_arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CodeStarConnections::Connection' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ConnectionArn') as connection_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CodeStarConnections::Connection' + AND region = 'us-east-1' repository_links: name: repository_links id: aws.codestarconnections.repository_links @@ -981,7 +969,7 @@ components: x-cfn-type-name: AWS::CodeStarConnections::RepositoryLink x-identifiers: - RepositoryLinkArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -998,9 +986,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1010,41 +998,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/repository_links/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/repository_links/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.RepositoryLinkArn') as repository_link_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CodeStarConnections::RepositoryLink' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'RepositoryLinkArn') as repository_link_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CodeStarConnections::RepositoryLink' - AND region = 'us-east-1' - repository_link: - name: repository_link - id: aws.codestarconnections.repository_link - x-cfn-schema-name: RepositoryLink - x-cfn-type-name: AWS::CodeStarConnections::RepositoryLink - x-identifiers: - - RepositoryLinkArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1055,12 +1011,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/repository_links/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/repository_links/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/repository_link/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/repository_links/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1077,22 +1037,38 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ConnectionArn') as connection_arn, - json_extract_path_text(Properties, 'ProviderType') as provider_type, - json_extract_path_text(Properties, 'OwnerId') as owner_id, - json_extract_path_text(Properties, 'RepositoryName') as repository_name, - json_extract_path_text(Properties, 'EncryptionKeyArn') as encryption_key_arn, - json_extract_path_text(Properties, 'RepositoryLinkId') as repository_link_id, - json_extract_path_text(Properties, 'RepositoryLinkArn') as repository_link_arn, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CodeStarConnections::RepositoryLink' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.RepositoryLinkArn') as repository_link_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CodeStarConnections::RepositoryLink' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ConnectionArn') as connection_arn, + json_extract_path_text(Properties, 'ProviderType') as provider_type, + json_extract_path_text(Properties, 'OwnerId') as owner_id, + json_extract_path_text(Properties, 'RepositoryName') as repository_name, + json_extract_path_text(Properties, 'EncryptionKeyArn') as encryption_key_arn, + json_extract_path_text(Properties, 'RepositoryLinkId') as repository_link_id, + json_extract_path_text(Properties, 'RepositoryLinkArn') as repository_link_arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CodeStarConnections::RepositoryLink' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'RepositoryLinkArn') as repository_link_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CodeStarConnections::RepositoryLink' + AND region = 'us-east-1' sync_configurations: name: sync_configurations id: aws.codestarconnections.sync_configurations @@ -1101,7 +1077,7 @@ components: x-identifiers: - ResourceName - SyncType - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1118,9 +1094,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1130,44 +1106,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/sync_configurations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/sync_configurations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ResourceName') as resource_name, - JSON_EXTRACT(Properties, '$.SyncType') as sync_type - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CodeStarConnections::SyncConfiguration' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ResourceName') as resource_name, - json_extract_path_text(Properties, 'SyncType') as sync_type - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CodeStarConnections::SyncConfiguration' - AND region = 'us-east-1' - sync_configuration: - name: sync_configuration - id: aws.codestarconnections.sync_configuration - x-cfn-schema-name: SyncConfiguration - x-cfn-type-name: AWS::CodeStarConnections::SyncConfiguration - x-identifiers: - - ResourceName - - SyncType - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1178,12 +1119,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/sync_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/sync_configurations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/sync_configuration/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/sync_configurations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1203,25 +1148,43 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'OwnerId') as owner_id, - json_extract_path_text(Properties, 'ResourceName') as resource_name, - json_extract_path_text(Properties, 'RepositoryName') as repository_name, - json_extract_path_text(Properties, 'ProviderType') as provider_type, - json_extract_path_text(Properties, 'Branch') as branch, - json_extract_path_text(Properties, 'ConfigFile') as config_file, - json_extract_path_text(Properties, 'SyncType') as sync_type, - json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'PublishDeploymentStatus') as publish_deployment_status, - json_extract_path_text(Properties, 'TriggerResourceUpdateOn') as trigger_resource_update_on, - json_extract_path_text(Properties, 'RepositoryLinkId') as repository_link_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CodeStarConnections::SyncConfiguration' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.ResourceName') as resource_name, + JSON_EXTRACT(Properties, '$.SyncType') as sync_type + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CodeStarConnections::SyncConfiguration' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'OwnerId') as owner_id, + json_extract_path_text(Properties, 'ResourceName') as resource_name, + json_extract_path_text(Properties, 'RepositoryName') as repository_name, + json_extract_path_text(Properties, 'ProviderType') as provider_type, + json_extract_path_text(Properties, 'Branch') as branch, + json_extract_path_text(Properties, 'ConfigFile') as config_file, + json_extract_path_text(Properties, 'SyncType') as sync_type, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'PublishDeploymentStatus') as publish_deployment_status, + json_extract_path_text(Properties, 'TriggerResourceUpdateOn') as trigger_resource_update_on, + json_extract_path_text(Properties, 'RepositoryLinkId') as repository_link_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CodeStarConnections::SyncConfiguration' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ResourceName') as resource_name, + json_extract_path_text(Properties, 'SyncType') as sync_type + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CodeStarConnections::SyncConfiguration' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/codestarnotifications.yaml b/providers/src/aws/v00.00.00000/services/codestarnotifications.yaml index 3b2ef808..24061297 100644 --- a/providers/src/aws/v00.00.00000/services/codestarnotifications.yaml +++ b/providers/src/aws/v00.00.00000/services/codestarnotifications.yaml @@ -573,7 +573,7 @@ components: x-cfn-type-name: AWS::CodeStarNotifications::NotificationRule x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -590,9 +590,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -602,41 +602,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/notification_rules/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/notification_rules/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CodeStarNotifications::NotificationRule' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CodeStarNotifications::NotificationRule' - AND region = 'us-east-1' - notification_rule: - name: notification_rule - id: aws.codestarnotifications.notification_rule - x-cfn-schema-name: NotificationRule - x-cfn-type-name: AWS::CodeStarNotifications::NotificationRule - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -647,12 +615,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/notification_rules/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/notification_rules/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/notification_rule/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/notification_rules/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -672,25 +644,41 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'EventTypeId') as event_type_id, - json_extract_path_text(Properties, 'CreatedBy') as created_by, - json_extract_path_text(Properties, 'TargetAddress') as target_address, - json_extract_path_text(Properties, 'EventTypeIds') as event_type_ids, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'DetailType') as detail_type, - json_extract_path_text(Properties, 'Resource') as resource, - json_extract_path_text(Properties, 'Targets') as targets, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CodeStarNotifications::NotificationRule' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CodeStarNotifications::NotificationRule' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'EventTypeId') as event_type_id, + json_extract_path_text(Properties, 'CreatedBy') as created_by, + json_extract_path_text(Properties, 'TargetAddress') as target_address, + json_extract_path_text(Properties, 'EventTypeIds') as event_type_ids, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'DetailType') as detail_type, + json_extract_path_text(Properties, 'Resource') as resource, + json_extract_path_text(Properties, 'Targets') as targets, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CodeStarNotifications::NotificationRule' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CodeStarNotifications::NotificationRule' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/cognito.yaml b/providers/src/aws/v00.00.00000/services/cognito.yaml index a6cd0a71..091cf9e0 100644 --- a/providers/src/aws/v00.00.00000/services/cognito.yaml +++ b/providers/src/aws/v00.00.00000/services/cognito.yaml @@ -1984,7 +1984,7 @@ components: x-cfn-type-name: AWS::Cognito::IdentityPool x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2001,9 +2001,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2013,41 +2013,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/identity_pools/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/identity_pools/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Cognito::IdentityPool' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Cognito::IdentityPool' - AND region = 'us-east-1' - identity_pool: - name: identity_pool - id: aws.cognito.identity_pool - x-cfn-schema-name: IdentityPool - x-cfn-type-name: AWS::Cognito::IdentityPool - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2058,12 +2026,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/identity_pools/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/identity_pools/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/identity_pool/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/identity_pools/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2085,27 +2057,43 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'PushSync') as push_sync, - json_extract_path_text(Properties, 'CognitoIdentityProviders') as cognito_identity_providers, - json_extract_path_text(Properties, 'DeveloperProviderName') as developer_provider_name, - json_extract_path_text(Properties, 'CognitoStreams') as cognito_streams, - json_extract_path_text(Properties, 'SupportedLoginProviders') as supported_login_providers, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'CognitoEvents') as cognito_events, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'IdentityPoolName') as identity_pool_name, - json_extract_path_text(Properties, 'AllowUnauthenticatedIdentities') as allow_unauthenticated_identities, - json_extract_path_text(Properties, 'SamlProviderARNs') as saml_provider_arns, - json_extract_path_text(Properties, 'OpenIdConnectProviderARNs') as open_id_connect_provider_arns, - json_extract_path_text(Properties, 'AllowClassicFlow') as allow_classic_flow - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Cognito::IdentityPool' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Cognito::IdentityPool' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'PushSync') as push_sync, + json_extract_path_text(Properties, 'CognitoIdentityProviders') as cognito_identity_providers, + json_extract_path_text(Properties, 'DeveloperProviderName') as developer_provider_name, + json_extract_path_text(Properties, 'CognitoStreams') as cognito_streams, + json_extract_path_text(Properties, 'SupportedLoginProviders') as supported_login_providers, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'CognitoEvents') as cognito_events, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'IdentityPoolName') as identity_pool_name, + json_extract_path_text(Properties, 'AllowUnauthenticatedIdentities') as allow_unauthenticated_identities, + json_extract_path_text(Properties, 'SamlProviderARNs') as saml_provider_arns, + json_extract_path_text(Properties, 'OpenIdConnectProviderARNs') as open_id_connect_provider_arns, + json_extract_path_text(Properties, 'AllowClassicFlow') as allow_classic_flow + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Cognito::IdentityPool' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Cognito::IdentityPool' + AND region = 'us-east-1' identity_pool_principal_tags: name: identity_pool_principal_tags id: aws.cognito.identity_pool_principal_tags @@ -2114,7 +2102,7 @@ components: x-identifiers: - IdentityPoolId - IdentityProviderName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2131,9 +2119,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2143,44 +2131,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/identity_pool_principal_tags/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/identity_pool_principal_tags/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.IdentityPoolId') as identity_pool_id, - JSON_EXTRACT(Properties, '$.IdentityProviderName') as identity_provider_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Cognito::IdentityPoolPrincipalTag' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'IdentityPoolId') as identity_pool_id, - json_extract_path_text(Properties, 'IdentityProviderName') as identity_provider_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Cognito::IdentityPoolPrincipalTag' - AND region = 'us-east-1' - identity_pool_principal_tag: - name: identity_pool_principal_tag - id: aws.cognito.identity_pool_principal_tag - x-cfn-schema-name: IdentityPoolPrincipalTag - x-cfn-type-name: AWS::Cognito::IdentityPoolPrincipalTag - x-identifiers: - - IdentityPoolId - - IdentityProviderName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2191,12 +2144,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/identity_pool_principal_tags/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/identity_pool_principal_tags/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/identity_pool_principal_tag/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/identity_pool_principal_tags/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2209,18 +2166,36 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'IdentityPoolId') as identity_pool_id, - json_extract_path_text(Properties, 'IdentityProviderName') as identity_provider_name, - json_extract_path_text(Properties, 'UseDefaults') as use_defaults, - json_extract_path_text(Properties, 'PrincipalTags') as principal_tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Cognito::IdentityPoolPrincipalTag' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.IdentityPoolId') as identity_pool_id, + JSON_EXTRACT(Properties, '$.IdentityProviderName') as identity_provider_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Cognito::IdentityPoolPrincipalTag' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'IdentityPoolId') as identity_pool_id, + json_extract_path_text(Properties, 'IdentityProviderName') as identity_provider_name, + json_extract_path_text(Properties, 'UseDefaults') as use_defaults, + json_extract_path_text(Properties, 'PrincipalTags') as principal_tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Cognito::IdentityPoolPrincipalTag' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'IdentityPoolId') as identity_pool_id, + json_extract_path_text(Properties, 'IdentityProviderName') as identity_provider_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Cognito::IdentityPoolPrincipalTag' + AND region = 'us-east-1' identity_pool_role_attachments: name: identity_pool_role_attachments id: aws.cognito.identity_pool_role_attachments @@ -2228,7 +2203,7 @@ components: x-cfn-type-name: AWS::Cognito::IdentityPoolRoleAttachment x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2245,9 +2220,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2257,41 +2232,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/identity_pool_role_attachments/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/identity_pool_role_attachments/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Cognito::IdentityPoolRoleAttachment' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Cognito::IdentityPoolRoleAttachment' - AND region = 'us-east-1' - identity_pool_role_attachment: - name: identity_pool_role_attachment - id: aws.cognito.identity_pool_role_attachment - x-cfn-schema-name: IdentityPoolRoleAttachment - x-cfn-type-name: AWS::Cognito::IdentityPoolRoleAttachment - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2302,12 +2245,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/identity_pool_role_attachments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/identity_pool_role_attachments/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/identity_pool_role_attachment/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/identity_pool_role_attachments/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2320,18 +2267,34 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'IdentityPoolId') as identity_pool_id, - json_extract_path_text(Properties, 'Roles') as roles, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'RoleMappings') as role_mappings - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Cognito::IdentityPoolRoleAttachment' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Cognito::IdentityPoolRoleAttachment' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'IdentityPoolId') as identity_pool_id, + json_extract_path_text(Properties, 'Roles') as roles, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'RoleMappings') as role_mappings + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Cognito::IdentityPoolRoleAttachment' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Cognito::IdentityPoolRoleAttachment' + AND region = 'us-east-1' log_delivery_configurations: name: log_delivery_configurations id: aws.cognito.log_delivery_configurations @@ -2339,7 +2302,7 @@ components: x-cfn-type-name: AWS::Cognito::LogDeliveryConfiguration x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2356,9 +2319,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2368,23 +2331,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/log_delivery_configurations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/log_delivery_configurations/methods/delete_resource' - log_delivery_configuration: - name: log_delivery_configuration - id: aws.cognito.log_delivery_configuration - x-cfn-schema-name: LogDeliveryConfiguration - x-cfn-type-name: AWS::Cognito::LogDeliveryConfiguration - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2395,12 +2344,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/log_delivery_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/log_delivery_configurations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/log_delivery_configuration/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/log_delivery_configurations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2412,7 +2365,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2430,7 +2383,7 @@ components: x-cfn-type-name: AWS::Cognito::UserPool x-identifiers: - UserPoolId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2447,9 +2400,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2459,41 +2412,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/user_pools/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/user_pools/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.UserPoolId') as user_pool_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Cognito::UserPool' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'UserPoolId') as user_pool_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Cognito::UserPool' - AND region = 'us-east-1' - user_pool: - name: user_pool - id: aws.cognito.user_pool - x-cfn-schema-name: UserPool - x-cfn-type-name: AWS::Cognito::UserPool - x-identifiers: - - UserPoolId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2504,12 +2425,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/user_pools/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/user_pools/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/user_pool/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/user_pools/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2546,42 +2471,58 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'UserPoolName') as user_pool_name, - json_extract_path_text(Properties, 'Policies') as policies, - json_extract_path_text(Properties, 'AccountRecoverySetting') as account_recovery_setting, - json_extract_path_text(Properties, 'AdminCreateUserConfig') as admin_create_user_config, - json_extract_path_text(Properties, 'AliasAttributes') as alias_attributes, - json_extract_path_text(Properties, 'UsernameAttributes') as username_attributes, - json_extract_path_text(Properties, 'AutoVerifiedAttributes') as auto_verified_attributes, - json_extract_path_text(Properties, 'DeviceConfiguration') as device_configuration, - json_extract_path_text(Properties, 'EmailConfiguration') as email_configuration, - json_extract_path_text(Properties, 'EmailVerificationMessage') as email_verification_message, - json_extract_path_text(Properties, 'EmailVerificationSubject') as email_verification_subject, - json_extract_path_text(Properties, 'DeletionProtection') as deletion_protection, - json_extract_path_text(Properties, 'LambdaConfig') as lambda_config, - json_extract_path_text(Properties, 'MfaConfiguration') as mfa_configuration, - json_extract_path_text(Properties, 'EnabledMfas') as enabled_mfas, - json_extract_path_text(Properties, 'SmsAuthenticationMessage') as sms_authentication_message, - json_extract_path_text(Properties, 'SmsConfiguration') as sms_configuration, - json_extract_path_text(Properties, 'SmsVerificationMessage') as sms_verification_message, - json_extract_path_text(Properties, 'Schema') as _schema, - json_extract_path_text(Properties, 'UsernameConfiguration') as username_configuration, - json_extract_path_text(Properties, 'UserAttributeUpdateSettings') as user_attribute_update_settings, - json_extract_path_text(Properties, 'UserPoolTags') as user_pool_tags, - json_extract_path_text(Properties, 'VerificationMessageTemplate') as verification_message_template, - json_extract_path_text(Properties, 'UserPoolAddOns') as user_pool_add_ons, - json_extract_path_text(Properties, 'ProviderName') as provider_name, - json_extract_path_text(Properties, 'ProviderURL') as provider_url, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'UserPoolId') as user_pool_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Cognito::UserPool' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.UserPoolId') as user_pool_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Cognito::UserPool' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'UserPoolName') as user_pool_name, + json_extract_path_text(Properties, 'Policies') as policies, + json_extract_path_text(Properties, 'AccountRecoverySetting') as account_recovery_setting, + json_extract_path_text(Properties, 'AdminCreateUserConfig') as admin_create_user_config, + json_extract_path_text(Properties, 'AliasAttributes') as alias_attributes, + json_extract_path_text(Properties, 'UsernameAttributes') as username_attributes, + json_extract_path_text(Properties, 'AutoVerifiedAttributes') as auto_verified_attributes, + json_extract_path_text(Properties, 'DeviceConfiguration') as device_configuration, + json_extract_path_text(Properties, 'EmailConfiguration') as email_configuration, + json_extract_path_text(Properties, 'EmailVerificationMessage') as email_verification_message, + json_extract_path_text(Properties, 'EmailVerificationSubject') as email_verification_subject, + json_extract_path_text(Properties, 'DeletionProtection') as deletion_protection, + json_extract_path_text(Properties, 'LambdaConfig') as lambda_config, + json_extract_path_text(Properties, 'MfaConfiguration') as mfa_configuration, + json_extract_path_text(Properties, 'EnabledMfas') as enabled_mfas, + json_extract_path_text(Properties, 'SmsAuthenticationMessage') as sms_authentication_message, + json_extract_path_text(Properties, 'SmsConfiguration') as sms_configuration, + json_extract_path_text(Properties, 'SmsVerificationMessage') as sms_verification_message, + json_extract_path_text(Properties, 'Schema') as _schema, + json_extract_path_text(Properties, 'UsernameConfiguration') as username_configuration, + json_extract_path_text(Properties, 'UserAttributeUpdateSettings') as user_attribute_update_settings, + json_extract_path_text(Properties, 'UserPoolTags') as user_pool_tags, + json_extract_path_text(Properties, 'VerificationMessageTemplate') as verification_message_template, + json_extract_path_text(Properties, 'UserPoolAddOns') as user_pool_add_ons, + json_extract_path_text(Properties, 'ProviderName') as provider_name, + json_extract_path_text(Properties, 'ProviderURL') as provider_url, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'UserPoolId') as user_pool_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Cognito::UserPool' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'UserPoolId') as user_pool_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Cognito::UserPool' + AND region = 'us-east-1' user_pool_clients: name: user_pool_clients id: aws.cognito.user_pool_clients @@ -2590,7 +2531,7 @@ components: x-identifiers: - UserPoolId - ClientId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2607,9 +2548,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2619,44 +2560,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/user_pool_clients/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/user_pool_clients/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.UserPoolId') as user_pool_id, - JSON_EXTRACT(Properties, '$.ClientId') as client_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Cognito::UserPoolClient' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'UserPoolId') as user_pool_id, - json_extract_path_text(Properties, 'ClientId') as client_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Cognito::UserPoolClient' - AND region = 'us-east-1' - user_pool_client: - name: user_pool_client - id: aws.cognito.user_pool_client - x-cfn-schema-name: UserPoolClient - x-cfn-type-name: AWS::Cognito::UserPoolClient - x-identifiers: - - UserPoolId - - ClientId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2667,12 +2573,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/user_pool_clients/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/user_pool_clients/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/user_pool_client/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/user_pool_clients/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2706,39 +2616,57 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ClientName') as client_name, - json_extract_path_text(Properties, 'ExplicitAuthFlows') as explicit_auth_flows, - json_extract_path_text(Properties, 'GenerateSecret') as generate_secret, - json_extract_path_text(Properties, 'ReadAttributes') as read_attributes, - json_extract_path_text(Properties, 'AuthSessionValidity') as auth_session_validity, - json_extract_path_text(Properties, 'RefreshTokenValidity') as refresh_token_validity, - json_extract_path_text(Properties, 'AccessTokenValidity') as access_token_validity, - json_extract_path_text(Properties, 'IdTokenValidity') as id_token_validity, - json_extract_path_text(Properties, 'TokenValidityUnits') as token_validity_units, - json_extract_path_text(Properties, 'UserPoolId') as user_pool_id, - json_extract_path_text(Properties, 'WriteAttributes') as write_attributes, - json_extract_path_text(Properties, 'AllowedOAuthFlows') as allowed_oauth_flows, - json_extract_path_text(Properties, 'AllowedOAuthFlowsUserPoolClient') as allowed_oauth_flows_user_pool_client, - json_extract_path_text(Properties, 'AllowedOAuthScopes') as allowed_oauth_scopes, - json_extract_path_text(Properties, 'CallbackURLs') as callback_urls, - json_extract_path_text(Properties, 'DefaultRedirectURI') as default_redirect_uri, - json_extract_path_text(Properties, 'LogoutURLs') as logout_urls, - json_extract_path_text(Properties, 'SupportedIdentityProviders') as supported_identity_providers, - json_extract_path_text(Properties, 'AnalyticsConfiguration') as analytics_configuration, - json_extract_path_text(Properties, 'PreventUserExistenceErrors') as prevent_user_existence_errors, - json_extract_path_text(Properties, 'EnableTokenRevocation') as enable_token_revocation, - json_extract_path_text(Properties, 'EnablePropagateAdditionalUserContextData') as enable_propagate_additional_user_context_data, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'ClientSecret') as client_secret, - json_extract_path_text(Properties, 'ClientId') as client_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Cognito::UserPoolClient' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.UserPoolId') as user_pool_id, + JSON_EXTRACT(Properties, '$.ClientId') as client_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Cognito::UserPoolClient' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ClientName') as client_name, + json_extract_path_text(Properties, 'ExplicitAuthFlows') as explicit_auth_flows, + json_extract_path_text(Properties, 'GenerateSecret') as generate_secret, + json_extract_path_text(Properties, 'ReadAttributes') as read_attributes, + json_extract_path_text(Properties, 'AuthSessionValidity') as auth_session_validity, + json_extract_path_text(Properties, 'RefreshTokenValidity') as refresh_token_validity, + json_extract_path_text(Properties, 'AccessTokenValidity') as access_token_validity, + json_extract_path_text(Properties, 'IdTokenValidity') as id_token_validity, + json_extract_path_text(Properties, 'TokenValidityUnits') as token_validity_units, + json_extract_path_text(Properties, 'UserPoolId') as user_pool_id, + json_extract_path_text(Properties, 'WriteAttributes') as write_attributes, + json_extract_path_text(Properties, 'AllowedOAuthFlows') as allowed_oauth_flows, + json_extract_path_text(Properties, 'AllowedOAuthFlowsUserPoolClient') as allowed_oauth_flows_user_pool_client, + json_extract_path_text(Properties, 'AllowedOAuthScopes') as allowed_oauth_scopes, + json_extract_path_text(Properties, 'CallbackURLs') as callback_urls, + json_extract_path_text(Properties, 'DefaultRedirectURI') as default_redirect_uri, + json_extract_path_text(Properties, 'LogoutURLs') as logout_urls, + json_extract_path_text(Properties, 'SupportedIdentityProviders') as supported_identity_providers, + json_extract_path_text(Properties, 'AnalyticsConfiguration') as analytics_configuration, + json_extract_path_text(Properties, 'PreventUserExistenceErrors') as prevent_user_existence_errors, + json_extract_path_text(Properties, 'EnableTokenRevocation') as enable_token_revocation, + json_extract_path_text(Properties, 'EnablePropagateAdditionalUserContextData') as enable_propagate_additional_user_context_data, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'ClientSecret') as client_secret, + json_extract_path_text(Properties, 'ClientId') as client_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Cognito::UserPoolClient' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'UserPoolId') as user_pool_id, + json_extract_path_text(Properties, 'ClientId') as client_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Cognito::UserPoolClient' + AND region = 'us-east-1' user_pool_groups: name: user_pool_groups id: aws.cognito.user_pool_groups @@ -2747,7 +2675,7 @@ components: x-identifiers: - UserPoolId - GroupName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2764,9 +2692,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2776,44 +2704,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/user_pool_groups/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/user_pool_groups/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.UserPoolId') as user_pool_id, - JSON_EXTRACT(Properties, '$.GroupName') as group_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Cognito::UserPoolGroup' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'UserPoolId') as user_pool_id, - json_extract_path_text(Properties, 'GroupName') as group_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Cognito::UserPoolGroup' - AND region = 'us-east-1' - user_pool_group: - name: user_pool_group - id: aws.cognito.user_pool_group - x-cfn-schema-name: UserPoolGroup - x-cfn-type-name: AWS::Cognito::UserPoolGroup - x-identifiers: - - UserPoolId - - GroupName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2824,12 +2717,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/user_pool_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/user_pool_groups/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/user_pool_group/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/user_pool_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2843,19 +2740,37 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'GroupName') as group_name, - json_extract_path_text(Properties, 'Precedence') as precedence, - json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'UserPoolId') as user_pool_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Cognito::UserPoolGroup' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.UserPoolId') as user_pool_id, + JSON_EXTRACT(Properties, '$.GroupName') as group_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Cognito::UserPoolGroup' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'GroupName') as group_name, + json_extract_path_text(Properties, 'Precedence') as precedence, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'UserPoolId') as user_pool_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Cognito::UserPoolGroup' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'UserPoolId') as user_pool_id, + json_extract_path_text(Properties, 'GroupName') as group_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Cognito::UserPoolGroup' + AND region = 'us-east-1' user_pool_risk_configuration_attachments: name: user_pool_risk_configuration_attachments id: aws.cognito.user_pool_risk_configuration_attachments @@ -2864,7 +2779,7 @@ components: x-identifiers: - UserPoolId - ClientId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2881,9 +2796,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2893,24 +2808,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/user_pool_risk_configuration_attachments/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/user_pool_risk_configuration_attachments/methods/delete_resource' - user_pool_risk_configuration_attachment: - name: user_pool_risk_configuration_attachment - id: aws.cognito.user_pool_risk_configuration_attachment - x-cfn-schema-name: UserPoolRiskConfigurationAttachment - x-cfn-type-name: AWS::Cognito::UserPoolRiskConfigurationAttachment - x-identifiers: - - UserPoolId - - ClientId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2921,12 +2821,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/user_pool_risk_configuration_attachments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/user_pool_risk_configuration_attachments/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/user_pool_risk_configuration_attachment/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/user_pool_risk_configuration_attachments/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2940,7 +2844,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2961,7 +2865,7 @@ components: x-identifiers: - UserPoolId - Username - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2995,42 +2899,11 @@ components: - $ref: '#/components/x-stackQL-resources/user_pool_users/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/user_pool_users/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.UserPoolId') as user_pool_id, - JSON_EXTRACT(Properties, '$.Username') as username - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Cognito::UserPoolUser' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'UserPoolId') as user_pool_id, - json_extract_path_text(Properties, 'Username') as username - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Cognito::UserPoolUser' - AND region = 'us-east-1' - user_pool_user: - name: user_pool_user - id: aws.cognito.user_pool_user - x-cfn-schema-name: UserPoolUser - x-cfn-type-name: AWS::Cognito::UserPoolUser - x-identifiers: - - UserPoolId - - Username - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3047,22 +2920,40 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'DesiredDeliveryMediums') as desired_delivery_mediums, - json_extract_path_text(Properties, 'ForceAliasCreation') as force_alias_creation, - json_extract_path_text(Properties, 'UserAttributes') as user_attributes, - json_extract_path_text(Properties, 'MessageAction') as message_action, - json_extract_path_text(Properties, 'Username') as username, - json_extract_path_text(Properties, 'UserPoolId') as user_pool_id, - json_extract_path_text(Properties, 'ValidationData') as validation_data, - json_extract_path_text(Properties, 'ClientMetadata') as client_metadata - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Cognito::UserPoolUser' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.UserPoolId') as user_pool_id, + JSON_EXTRACT(Properties, '$.Username') as username + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Cognito::UserPoolUser' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DesiredDeliveryMediums') as desired_delivery_mediums, + json_extract_path_text(Properties, 'ForceAliasCreation') as force_alias_creation, + json_extract_path_text(Properties, 'UserAttributes') as user_attributes, + json_extract_path_text(Properties, 'MessageAction') as message_action, + json_extract_path_text(Properties, 'Username') as username, + json_extract_path_text(Properties, 'UserPoolId') as user_pool_id, + json_extract_path_text(Properties, 'ValidationData') as validation_data, + json_extract_path_text(Properties, 'ClientMetadata') as client_metadata + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Cognito::UserPoolUser' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'UserPoolId') as user_pool_id, + json_extract_path_text(Properties, 'Username') as username + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Cognito::UserPoolUser' + AND region = 'us-east-1' user_pool_user_to_group_attachments: name: user_pool_user_to_group_attachments id: aws.cognito.user_pool_user_to_group_attachments @@ -3072,7 +2963,7 @@ components: - UserPoolId - GroupName - Username - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3106,23 +2997,11 @@ components: - $ref: '#/components/x-stackQL-resources/user_pool_user_to_group_attachments/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/user_pool_user_to_group_attachments/methods/delete_resource' - user_pool_user_to_group_attachment: - name: user_pool_user_to_group_attachment - id: aws.cognito.user_pool_user_to_group_attachment - x-cfn-schema-name: UserPoolUserToGroupAttachment - x-cfn-type-name: AWS::Cognito::UserPoolUserToGroupAttachment - x-identifiers: - - UserPoolId - - GroupName - - Username - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3134,7 +3013,7 @@ components: AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, diff --git a/providers/src/aws/v00.00.00000/services/comprehend.yaml b/providers/src/aws/v00.00.00000/services/comprehend.yaml index 1e7dbbd1..b52ff336 100644 --- a/providers/src/aws/v00.00.00000/services/comprehend.yaml +++ b/providers/src/aws/v00.00.00000/services/comprehend.yaml @@ -962,7 +962,7 @@ components: x-cfn-type-name: AWS::Comprehend::DocumentClassifier x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -979,9 +979,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -991,41 +991,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/document_classifiers/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/document_classifiers/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Comprehend::DocumentClassifier' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Comprehend::DocumentClassifier' - AND region = 'us-east-1' - document_classifier: - name: document_classifier - id: aws.comprehend.document_classifier - x-cfn-schema-name: DocumentClassifier - x-cfn-type-name: AWS::Comprehend::DocumentClassifier - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1036,12 +1004,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/document_classifiers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/document_classifiers/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/document_classifier/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/document_classifiers/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1063,27 +1035,43 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'DataAccessRoleArn') as data_access_role_arn, - json_extract_path_text(Properties, 'InputDataConfig') as input_data_config, - json_extract_path_text(Properties, 'OutputDataConfig') as output_data_config, - json_extract_path_text(Properties, 'LanguageCode') as language_code, - json_extract_path_text(Properties, 'ModelKmsKeyId') as model_kms_key_id, - json_extract_path_text(Properties, 'ModelPolicy') as model_policy, - json_extract_path_text(Properties, 'DocumentClassifierName') as document_classifier_name, - json_extract_path_text(Properties, 'Mode') as mode, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'VersionName') as version_name, - json_extract_path_text(Properties, 'VolumeKmsKeyId') as volume_kms_key_id, - json_extract_path_text(Properties, 'VpcConfig') as vpc_config, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Comprehend::DocumentClassifier' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Comprehend::DocumentClassifier' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DataAccessRoleArn') as data_access_role_arn, + json_extract_path_text(Properties, 'InputDataConfig') as input_data_config, + json_extract_path_text(Properties, 'OutputDataConfig') as output_data_config, + json_extract_path_text(Properties, 'LanguageCode') as language_code, + json_extract_path_text(Properties, 'ModelKmsKeyId') as model_kms_key_id, + json_extract_path_text(Properties, 'ModelPolicy') as model_policy, + json_extract_path_text(Properties, 'DocumentClassifierName') as document_classifier_name, + json_extract_path_text(Properties, 'Mode') as mode, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'VersionName') as version_name, + json_extract_path_text(Properties, 'VolumeKmsKeyId') as volume_kms_key_id, + json_extract_path_text(Properties, 'VpcConfig') as vpc_config, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Comprehend::DocumentClassifier' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Comprehend::DocumentClassifier' + AND region = 'us-east-1' flywheels: name: flywheels id: aws.comprehend.flywheels @@ -1091,7 +1079,7 @@ components: x-cfn-type-name: AWS::Comprehend::Flywheel x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1108,9 +1096,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1120,41 +1108,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/flywheels/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/flywheels/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Comprehend::Flywheel' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Comprehend::Flywheel' - AND region = 'us-east-1' - flywheel: - name: flywheel - id: aws.comprehend.flywheel - x-cfn-schema-name: Flywheel - x-cfn-type-name: AWS::Comprehend::Flywheel - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1165,12 +1121,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/flywheels/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/flywheels/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/flywheel/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/flywheels/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1188,23 +1148,39 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ActiveModelArn') as active_model_arn, - json_extract_path_text(Properties, 'DataAccessRoleArn') as data_access_role_arn, - json_extract_path_text(Properties, 'DataLakeS3Uri') as data_lake_s3_uri, - json_extract_path_text(Properties, 'DataSecurityConfig') as data_security_config, - json_extract_path_text(Properties, 'FlywheelName') as flywheel_name, - json_extract_path_text(Properties, 'ModelType') as model_type, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'TaskConfig') as task_config, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Comprehend::Flywheel' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Comprehend::Flywheel' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ActiveModelArn') as active_model_arn, + json_extract_path_text(Properties, 'DataAccessRoleArn') as data_access_role_arn, + json_extract_path_text(Properties, 'DataLakeS3Uri') as data_lake_s3_uri, + json_extract_path_text(Properties, 'DataSecurityConfig') as data_security_config, + json_extract_path_text(Properties, 'FlywheelName') as flywheel_name, + json_extract_path_text(Properties, 'ModelType') as model_type, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'TaskConfig') as task_config, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Comprehend::Flywheel' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Comprehend::Flywheel' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/config.yaml b/providers/src/aws/v00.00.00000/services/config.yaml index 56cd9e77..be7537cf 100644 --- a/providers/src/aws/v00.00.00000/services/config.yaml +++ b/providers/src/aws/v00.00.00000/services/config.yaml @@ -1370,7 +1370,7 @@ components: x-identifiers: - AuthorizedAccountId - AuthorizedAwsRegion - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1387,9 +1387,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1399,44 +1399,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/aggregation_authorizations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/aggregation_authorizations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AuthorizedAccountId') as authorized_account_id, - JSON_EXTRACT(Properties, '$.AuthorizedAwsRegion') as authorized_aws_region - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Config::AggregationAuthorization' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AuthorizedAccountId') as authorized_account_id, - json_extract_path_text(Properties, 'AuthorizedAwsRegion') as authorized_aws_region - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Config::AggregationAuthorization' - AND region = 'us-east-1' - aggregation_authorization: - name: aggregation_authorization - id: aws.config.aggregation_authorization - x-cfn-schema-name: AggregationAuthorization - x-cfn-type-name: AWS::Config::AggregationAuthorization - x-identifiers: - - AuthorizedAccountId - - AuthorizedAwsRegion - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1447,12 +1412,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/aggregation_authorizations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/aggregation_authorizations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/aggregation_authorization/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/aggregation_authorizations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1465,18 +1434,36 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AuthorizedAccountId') as authorized_account_id, - json_extract_path_text(Properties, 'AuthorizedAwsRegion') as authorized_aws_region, - json_extract_path_text(Properties, 'AggregationAuthorizationArn') as aggregation_authorization_arn, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Config::AggregationAuthorization' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.AuthorizedAccountId') as authorized_account_id, + JSON_EXTRACT(Properties, '$.AuthorizedAwsRegion') as authorized_aws_region + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Config::AggregationAuthorization' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AuthorizedAccountId') as authorized_account_id, + json_extract_path_text(Properties, 'AuthorizedAwsRegion') as authorized_aws_region, + json_extract_path_text(Properties, 'AggregationAuthorizationArn') as aggregation_authorization_arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Config::AggregationAuthorization' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AuthorizedAccountId') as authorized_account_id, + json_extract_path_text(Properties, 'AuthorizedAwsRegion') as authorized_aws_region + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Config::AggregationAuthorization' + AND region = 'us-east-1' config_rules: name: config_rules id: aws.config.config_rules @@ -1484,7 +1471,7 @@ components: x-cfn-type-name: AWS::Config::ConfigRule x-identifiers: - ConfigRuleName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1501,9 +1488,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1513,41 +1500,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/config_rules/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/config_rules/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ConfigRuleName') as config_rule_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Config::ConfigRule' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ConfigRuleName') as config_rule_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Config::ConfigRule' - AND region = 'us-east-1' - config_rule: - name: config_rule - id: aws.config.config_rule - x-cfn-schema-name: ConfigRule - x-cfn-type-name: AWS::Config::ConfigRule - x-identifiers: - - ConfigRuleName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1558,12 +1513,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/config_rules/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/config_rules/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/config_rule/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/config_rules/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1582,24 +1541,40 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ConfigRuleId') as config_rule_id, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Scope') as scope, - json_extract_path_text(Properties, 'ConfigRuleName') as config_rule_name, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Compliance') as compliance, - json_extract_path_text(Properties, 'MaximumExecutionFrequency') as maximum_execution_frequency, - json_extract_path_text(Properties, 'Source') as source, - json_extract_path_text(Properties, 'InputParameters') as input_parameters, - json_extract_path_text(Properties, 'EvaluationModes') as evaluation_modes - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Config::ConfigRule' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ConfigRuleName') as config_rule_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Config::ConfigRule' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ConfigRuleId') as config_rule_id, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Scope') as scope, + json_extract_path_text(Properties, 'ConfigRuleName') as config_rule_name, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Compliance') as compliance, + json_extract_path_text(Properties, 'MaximumExecutionFrequency') as maximum_execution_frequency, + json_extract_path_text(Properties, 'Source') as source, + json_extract_path_text(Properties, 'InputParameters') as input_parameters, + json_extract_path_text(Properties, 'EvaluationModes') as evaluation_modes + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Config::ConfigRule' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ConfigRuleName') as config_rule_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Config::ConfigRule' + AND region = 'us-east-1' configuration_aggregators: name: configuration_aggregators id: aws.config.configuration_aggregators @@ -1607,7 +1582,7 @@ components: x-cfn-type-name: AWS::Config::ConfigurationAggregator x-identifiers: - ConfigurationAggregatorName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1624,9 +1599,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1636,41 +1611,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/configuration_aggregators/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/configuration_aggregators/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ConfigurationAggregatorName') as configuration_aggregator_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Config::ConfigurationAggregator' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ConfigurationAggregatorName') as configuration_aggregator_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Config::ConfigurationAggregator' - AND region = 'us-east-1' - configuration_aggregator: - name: configuration_aggregator - id: aws.config.configuration_aggregator - x-cfn-schema-name: ConfigurationAggregator - x-cfn-type-name: AWS::Config::ConfigurationAggregator - x-identifiers: - - ConfigurationAggregatorName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1681,12 +1624,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/configuration_aggregators/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/configuration_aggregators/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/configuration_aggregator/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/configuration_aggregators/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1700,19 +1647,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AccountAggregationSources') as account_aggregation_sources, - json_extract_path_text(Properties, 'ConfigurationAggregatorName') as configuration_aggregator_name, - json_extract_path_text(Properties, 'ConfigurationAggregatorArn') as configuration_aggregator_arn, - json_extract_path_text(Properties, 'OrganizationAggregationSource') as organization_aggregation_source, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Config::ConfigurationAggregator' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ConfigurationAggregatorName') as configuration_aggregator_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Config::ConfigurationAggregator' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AccountAggregationSources') as account_aggregation_sources, + json_extract_path_text(Properties, 'ConfigurationAggregatorName') as configuration_aggregator_name, + json_extract_path_text(Properties, 'ConfigurationAggregatorArn') as configuration_aggregator_arn, + json_extract_path_text(Properties, 'OrganizationAggregationSource') as organization_aggregation_source, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Config::ConfigurationAggregator' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ConfigurationAggregatorName') as configuration_aggregator_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Config::ConfigurationAggregator' + AND region = 'us-east-1' conformance_packs: name: conformance_packs id: aws.config.conformance_packs @@ -1720,7 +1683,7 @@ components: x-cfn-type-name: AWS::Config::ConformancePack x-identifiers: - ConformancePackName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1737,9 +1700,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1749,41 +1712,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/conformance_packs/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/conformance_packs/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ConformancePackName') as conformance_pack_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Config::ConformancePack' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ConformancePackName') as conformance_pack_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Config::ConformancePack' - AND region = 'us-east-1' - conformance_pack: - name: conformance_pack - id: aws.config.conformance_pack - x-cfn-schema-name: ConformancePack - x-cfn-type-name: AWS::Config::ConformancePack - x-identifiers: - - ConformancePackName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1794,12 +1725,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/conformance_packs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/conformance_packs/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/conformance_pack/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/conformance_packs/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1815,21 +1750,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ConformancePackName') as conformance_pack_name, - json_extract_path_text(Properties, 'DeliveryS3Bucket') as delivery_s3_bucket, - json_extract_path_text(Properties, 'DeliveryS3KeyPrefix') as delivery_s3_key_prefix, - json_extract_path_text(Properties, 'TemplateBody') as template_body, - json_extract_path_text(Properties, 'TemplateS3Uri') as template_s3_uri, - json_extract_path_text(Properties, 'TemplateSSMDocumentDetails') as template_ssm_document_details, - json_extract_path_text(Properties, 'ConformancePackInputParameters') as conformance_pack_input_parameters - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Config::ConformancePack' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ConformancePackName') as conformance_pack_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Config::ConformancePack' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ConformancePackName') as conformance_pack_name, + json_extract_path_text(Properties, 'DeliveryS3Bucket') as delivery_s3_bucket, + json_extract_path_text(Properties, 'DeliveryS3KeyPrefix') as delivery_s3_key_prefix, + json_extract_path_text(Properties, 'TemplateBody') as template_body, + json_extract_path_text(Properties, 'TemplateS3Uri') as template_s3_uri, + json_extract_path_text(Properties, 'TemplateSSMDocumentDetails') as template_ssm_document_details, + json_extract_path_text(Properties, 'ConformancePackInputParameters') as conformance_pack_input_parameters + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Config::ConformancePack' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ConformancePackName') as conformance_pack_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Config::ConformancePack' + AND region = 'us-east-1' organization_conformance_packs: name: organization_conformance_packs id: aws.config.organization_conformance_packs @@ -1837,7 +1788,7 @@ components: x-cfn-type-name: AWS::Config::OrganizationConformancePack x-identifiers: - OrganizationConformancePackName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1854,9 +1805,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1866,41 +1817,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/organization_conformance_packs/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/organization_conformance_packs/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.OrganizationConformancePackName') as organization_conformance_pack_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Config::OrganizationConformancePack' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'OrganizationConformancePackName') as organization_conformance_pack_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Config::OrganizationConformancePack' - AND region = 'us-east-1' - organization_conformance_pack: - name: organization_conformance_pack - id: aws.config.organization_conformance_pack - x-cfn-schema-name: OrganizationConformancePack - x-cfn-type-name: AWS::Config::OrganizationConformancePack - x-identifiers: - - OrganizationConformancePackName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1911,12 +1830,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/organization_conformance_packs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/organization_conformance_packs/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/organization_conformance_pack/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/organization_conformance_packs/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1932,21 +1855,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'OrganizationConformancePackName') as organization_conformance_pack_name, - json_extract_path_text(Properties, 'TemplateS3Uri') as template_s3_uri, - json_extract_path_text(Properties, 'TemplateBody') as template_body, - json_extract_path_text(Properties, 'DeliveryS3Bucket') as delivery_s3_bucket, - json_extract_path_text(Properties, 'DeliveryS3KeyPrefix') as delivery_s3_key_prefix, - json_extract_path_text(Properties, 'ConformancePackInputParameters') as conformance_pack_input_parameters, - json_extract_path_text(Properties, 'ExcludedAccounts') as excluded_accounts - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Config::OrganizationConformancePack' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.OrganizationConformancePackName') as organization_conformance_pack_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Config::OrganizationConformancePack' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'OrganizationConformancePackName') as organization_conformance_pack_name, + json_extract_path_text(Properties, 'TemplateS3Uri') as template_s3_uri, + json_extract_path_text(Properties, 'TemplateBody') as template_body, + json_extract_path_text(Properties, 'DeliveryS3Bucket') as delivery_s3_bucket, + json_extract_path_text(Properties, 'DeliveryS3KeyPrefix') as delivery_s3_key_prefix, + json_extract_path_text(Properties, 'ConformancePackInputParameters') as conformance_pack_input_parameters, + json_extract_path_text(Properties, 'ExcludedAccounts') as excluded_accounts + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Config::OrganizationConformancePack' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'OrganizationConformancePackName') as organization_conformance_pack_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Config::OrganizationConformancePack' + AND region = 'us-east-1' stored_queries: name: stored_queries id: aws.config.stored_queries @@ -1954,7 +1893,7 @@ components: x-cfn-type-name: AWS::Config::StoredQuery x-identifiers: - QueryName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1971,9 +1910,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1983,41 +1922,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/stored_queries/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/stored_queries/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.QueryName') as query_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Config::StoredQuery' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'QueryName') as query_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Config::StoredQuery' - AND region = 'us-east-1' - stored_query: - name: stored_query - id: aws.config.stored_query - x-cfn-schema-name: StoredQuery - x-cfn-type-name: AWS::Config::StoredQuery - x-identifiers: - - QueryName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2028,12 +1935,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/stored_queries/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/stored_queries/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/stored_query/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/stored_queries/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2048,20 +1959,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'QueryArn') as query_arn, - json_extract_path_text(Properties, 'QueryId') as query_id, - json_extract_path_text(Properties, 'QueryName') as query_name, - json_extract_path_text(Properties, 'QueryDescription') as query_description, - json_extract_path_text(Properties, 'QueryExpression') as query_expression, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Config::StoredQuery' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.QueryName') as query_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Config::StoredQuery' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'QueryArn') as query_arn, + json_extract_path_text(Properties, 'QueryId') as query_id, + json_extract_path_text(Properties, 'QueryName') as query_name, + json_extract_path_text(Properties, 'QueryDescription') as query_description, + json_extract_path_text(Properties, 'QueryExpression') as query_expression, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Config::StoredQuery' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'QueryName') as query_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Config::StoredQuery' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/connect.yaml b/providers/src/aws/v00.00.00000/services/connect.yaml index 0dd3fd06..c058cbb2 100644 --- a/providers/src/aws/v00.00.00000/services/connect.yaml +++ b/providers/src/aws/v00.00.00000/services/connect.yaml @@ -2166,7 +2166,6 @@ components: description: The queues to associate with this routing profile. type: array minItems: 1 - maxItems: 10 x-insertionOrder: false items: $ref: '#/components/schemas/RoutingProfileQueueConfig' @@ -4175,7 +4174,6 @@ components: description: The queues to associate with this routing profile. type: array minItems: 1 - maxItems: 10 x-insertionOrder: false items: $ref: '#/components/schemas/RoutingProfileQueueConfig' @@ -4750,7 +4748,7 @@ components: x-identifiers: - InstanceId - Origin - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -4784,42 +4782,11 @@ components: - $ref: '#/components/x-stackQL-resources/approved_origins/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/approved_origins/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.InstanceId') as instance_id, - JSON_EXTRACT(Properties, '$.Origin') as origin - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::ApprovedOrigin' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'InstanceId') as instance_id, - json_extract_path_text(Properties, 'Origin') as origin - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::ApprovedOrigin' - AND region = 'us-east-1' - approved_origin: - name: approved_origin - id: aws.connect.approved_origin - x-cfn-schema-name: ApprovedOrigin - x-cfn-type-name: AWS::Connect::ApprovedOrigin - x-identifiers: - - InstanceId - - Origin - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -4830,16 +4797,34 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Origin') as origin, - json_extract_path_text(Properties, 'InstanceId') as instance_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::ApprovedOrigin' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.InstanceId') as instance_id, + JSON_EXTRACT(Properties, '$.Origin') as origin + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::ApprovedOrigin' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Origin') as origin, + json_extract_path_text(Properties, 'InstanceId') as instance_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::ApprovedOrigin' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'InstanceId') as instance_id, + json_extract_path_text(Properties, 'Origin') as origin + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::ApprovedOrigin' + AND region = 'us-east-1' contact_flows: name: contact_flows id: aws.connect.contact_flows @@ -4847,7 +4832,7 @@ components: x-cfn-type-name: AWS::Connect::ContactFlow x-identifiers: - ContactFlowArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -4864,9 +4849,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -4876,41 +4861,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/contact_flows/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/contact_flows/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ContactFlowArn') as contact_flow_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::ContactFlow' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ContactFlowArn') as contact_flow_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::ContactFlow' - AND region = 'us-east-1' - contact_flow: - name: contact_flow - id: aws.connect.contact_flow - x-cfn-schema-name: ContactFlow - x-cfn-type-name: AWS::Connect::ContactFlow - x-identifiers: - - ContactFlowArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -4921,12 +4874,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/contact_flows/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/contact_flows/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/contact_flow/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/contact_flows/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -4943,22 +4900,38 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'InstanceArn') as instance_arn, - json_extract_path_text(Properties, 'ContactFlowArn') as contact_flow_arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Content') as content, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'State') as state, - json_extract_path_text(Properties, 'Type') as type, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::ContactFlow' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ContactFlowArn') as contact_flow_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::ContactFlow' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'InstanceArn') as instance_arn, + json_extract_path_text(Properties, 'ContactFlowArn') as contact_flow_arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Content') as content, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::ContactFlow' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ContactFlowArn') as contact_flow_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::ContactFlow' + AND region = 'us-east-1' contact_flow_modules: name: contact_flow_modules id: aws.connect.contact_flow_modules @@ -4966,7 +4939,7 @@ components: x-cfn-type-name: AWS::Connect::ContactFlowModule x-identifiers: - ContactFlowModuleArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -4983,9 +4956,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -4995,41 +4968,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/contact_flow_modules/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/contact_flow_modules/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ContactFlowModuleArn') as contact_flow_module_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::ContactFlowModule' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ContactFlowModuleArn') as contact_flow_module_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::ContactFlowModule' - AND region = 'us-east-1' - contact_flow_module: - name: contact_flow_module - id: aws.connect.contact_flow_module - x-cfn-schema-name: ContactFlowModule - x-cfn-type-name: AWS::Connect::ContactFlowModule - x-identifiers: - - ContactFlowModuleArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -5040,12 +4981,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/contact_flow_modules/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/contact_flow_modules/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/contact_flow_module/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/contact_flow_modules/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -5062,22 +5007,38 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'InstanceArn') as instance_arn, - json_extract_path_text(Properties, 'ContactFlowModuleArn') as contact_flow_module_arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Content') as content, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'State') as state, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::ContactFlowModule' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ContactFlowModuleArn') as contact_flow_module_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::ContactFlowModule' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'InstanceArn') as instance_arn, + json_extract_path_text(Properties, 'ContactFlowModuleArn') as contact_flow_module_arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Content') as content, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::ContactFlowModule' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ContactFlowModuleArn') as contact_flow_module_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::ContactFlowModule' + AND region = 'us-east-1' evaluation_forms: name: evaluation_forms id: aws.connect.evaluation_forms @@ -5085,7 +5046,7 @@ components: x-cfn-type-name: AWS::Connect::EvaluationForm x-identifiers: - EvaluationFormArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -5102,9 +5063,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -5114,41 +5075,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/evaluation_forms/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/evaluation_forms/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.EvaluationFormArn') as evaluation_form_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::EvaluationForm' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'EvaluationFormArn') as evaluation_form_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::EvaluationForm' - AND region = 'us-east-1' - evaluation_form: - name: evaluation_form - id: aws.connect.evaluation_form - x-cfn-schema-name: EvaluationForm - x-cfn-type-name: AWS::Connect::EvaluationForm - x-identifiers: - - EvaluationFormArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -5159,12 +5088,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/evaluation_forms/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/evaluation_forms/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/evaluation_form/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/evaluation_forms/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -5181,22 +5114,38 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Title') as title, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'EvaluationFormArn') as evaluation_form_arn, - json_extract_path_text(Properties, 'InstanceArn') as instance_arn, - json_extract_path_text(Properties, 'Items') as items, - json_extract_path_text(Properties, 'ScoringStrategy') as scoring_strategy, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::EvaluationForm' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.EvaluationFormArn') as evaluation_form_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::EvaluationForm' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Title') as title, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'EvaluationFormArn') as evaluation_form_arn, + json_extract_path_text(Properties, 'InstanceArn') as instance_arn, + json_extract_path_text(Properties, 'Items') as items, + json_extract_path_text(Properties, 'ScoringStrategy') as scoring_strategy, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::EvaluationForm' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'EvaluationFormArn') as evaluation_form_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::EvaluationForm' + AND region = 'us-east-1' hours_of_operations: name: hours_of_operations id: aws.connect.hours_of_operations @@ -5204,7 +5153,7 @@ components: x-cfn-type-name: AWS::Connect::HoursOfOperation x-identifiers: - HoursOfOperationArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -5221,9 +5170,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -5233,41 +5182,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/hours_of_operations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/hours_of_operations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.HoursOfOperationArn') as hours_of_operation_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::HoursOfOperation' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'HoursOfOperationArn') as hours_of_operation_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::HoursOfOperation' - AND region = 'us-east-1' - hours_of_operation: - name: hours_of_operation - id: aws.connect.hours_of_operation - x-cfn-schema-name: HoursOfOperation - x-cfn-type-name: AWS::Connect::HoursOfOperation - x-identifiers: - - HoursOfOperationArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -5278,12 +5195,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/hours_of_operations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/hours_of_operations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/hours_of_operation/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/hours_of_operations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -5299,21 +5220,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'InstanceArn') as instance_arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'TimeZone') as time_zone, - json_extract_path_text(Properties, 'Config') as config, - json_extract_path_text(Properties, 'HoursOfOperationArn') as hours_of_operation_arn, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::HoursOfOperation' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.HoursOfOperationArn') as hours_of_operation_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::HoursOfOperation' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'InstanceArn') as instance_arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'TimeZone') as time_zone, + json_extract_path_text(Properties, 'Config') as config, + json_extract_path_text(Properties, 'HoursOfOperationArn') as hours_of_operation_arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::HoursOfOperation' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'HoursOfOperationArn') as hours_of_operation_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::HoursOfOperation' + AND region = 'us-east-1' instances: name: instances id: aws.connect.instances @@ -5321,7 +5258,7 @@ components: x-cfn-type-name: AWS::Connect::Instance x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -5338,9 +5275,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -5350,41 +5287,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/instances/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/instances/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::Instance' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::Instance' - AND region = 'us-east-1' - instance: - name: instance - id: aws.connect.instance - x-cfn-schema-name: Instance - x-cfn-type-name: AWS::Connect::Instance - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -5395,12 +5300,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/instances/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/instances/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/instance/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/instances/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -5419,24 +5328,40 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'IdentityManagementType') as identity_management_type, - json_extract_path_text(Properties, 'InstanceAlias') as instance_alias, - json_extract_path_text(Properties, 'CreatedTime') as created_time, - json_extract_path_text(Properties, 'ServiceRole') as service_role, - json_extract_path_text(Properties, 'InstanceStatus') as instance_status, - json_extract_path_text(Properties, 'DirectoryId') as directory_id, - json_extract_path_text(Properties, 'Attributes') as attributes, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::Instance' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::Instance' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'IdentityManagementType') as identity_management_type, + json_extract_path_text(Properties, 'InstanceAlias') as instance_alias, + json_extract_path_text(Properties, 'CreatedTime') as created_time, + json_extract_path_text(Properties, 'ServiceRole') as service_role, + json_extract_path_text(Properties, 'InstanceStatus') as instance_status, + json_extract_path_text(Properties, 'DirectoryId') as directory_id, + json_extract_path_text(Properties, 'Attributes') as attributes, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::Instance' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::Instance' + AND region = 'us-east-1' instance_storage_configs: name: instance_storage_configs id: aws.connect.instance_storage_configs @@ -5446,7 +5371,7 @@ components: - InstanceArn - AssociationId - ResourceType - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -5463,6 +5388,18 @@ components: response: mediaType: application/json openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Connect::InstanceStorageConfig" + } + response: + mediaType: application/json + openAPIDocKey: '200' delete_resource: operation: $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' @@ -5480,100 +5417,74 @@ components: - $ref: '#/components/x-stackQL-resources/instance_storage_configs/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/instance_storage_configs/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/instance_storage_configs/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, + data__Identifier, JSON_EXTRACT(Properties, '$.InstanceArn') as instance_arn, + JSON_EXTRACT(Properties, '$.ResourceType') as resource_type, JSON_EXTRACT(Properties, '$.AssociationId') as association_id, - JSON_EXTRACT(Properties, '$.ResourceType') as resource_type - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::InstanceStorageConfig' + JSON_EXTRACT(Properties, '$.StorageType') as storage_type, + JSON_EXTRACT(Properties, '$.S3Config') as s3_config, + JSON_EXTRACT(Properties, '$.KinesisVideoStreamConfig') as kinesis_video_stream_config, + JSON_EXTRACT(Properties, '$.KinesisStreamConfig') as kinesis_stream_config, + JSON_EXTRACT(Properties, '$.KinesisFirehoseConfig') as kinesis_firehose_config + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::InstanceStorageConfig' + AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - json_extract_path_text(Properties, 'InstanceArn') as instance_arn, - json_extract_path_text(Properties, 'AssociationId') as association_id, - json_extract_path_text(Properties, 'ResourceType') as resource_type + JSON_EXTRACT(Properties, '$.InstanceArn') as instance_arn, + JSON_EXTRACT(Properties, '$.AssociationId') as association_id, + JSON_EXTRACT(Properties, '$.ResourceType') as resource_type FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::InstanceStorageConfig' AND region = 'us-east-1' - instance_storage_config: - name: instance_storage_config - id: aws.connect.instance_storage_config - x-cfn-schema-name: InstanceStorageConfig - x-cfn-type-name: AWS::Connect::InstanceStorageConfig - x-identifiers: - - InstanceArn - - AssociationId - - ResourceType - x-type: get - methods: - update_resource: - operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' - request: - mediaType: application/x-amz-json-1.0 - base: |- - { - "TypeName": "AWS::Connect::InstanceStorageConfig" - } - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - update: - - $ref: '#/components/x-stackQL-resources/instance_storage_config/methods/update_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - data__Identifier, - JSON_EXTRACT(Properties, '$.InstanceArn') as instance_arn, - JSON_EXTRACT(Properties, '$.ResourceType') as resource_type, - JSON_EXTRACT(Properties, '$.AssociationId') as association_id, - JSON_EXTRACT(Properties, '$.StorageType') as storage_type, - JSON_EXTRACT(Properties, '$.S3Config') as s3_config, - JSON_EXTRACT(Properties, '$.KinesisVideoStreamConfig') as kinesis_video_stream_config, - JSON_EXTRACT(Properties, '$.KinesisStreamConfig') as kinesis_stream_config, - JSON_EXTRACT(Properties, '$.KinesisFirehoseConfig') as kinesis_firehose_config - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::InstanceStorageConfig' - AND data__Identifier = '||' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - data__Identifier, - json_extract_path_text(Properties, 'InstanceArn') as instance_arn, - json_extract_path_text(Properties, 'ResourceType') as resource_type, - json_extract_path_text(Properties, 'AssociationId') as association_id, - json_extract_path_text(Properties, 'StorageType') as storage_type, - json_extract_path_text(Properties, 'S3Config') as s3_config, - json_extract_path_text(Properties, 'KinesisVideoStreamConfig') as kinesis_video_stream_config, - json_extract_path_text(Properties, 'KinesisStreamConfig') as kinesis_stream_config, - json_extract_path_text(Properties, 'KinesisFirehoseConfig') as kinesis_firehose_config - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::InstanceStorageConfig' - AND data__Identifier = '||' - AND region = 'us-east-1' - integration_associations: - name: integration_associations - id: aws.connect.integration_associations - x-cfn-schema-name: IntegrationAssociation - x-cfn-type-name: AWS::Connect::IntegrationAssociation + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'InstanceArn') as instance_arn, + json_extract_path_text(Properties, 'ResourceType') as resource_type, + json_extract_path_text(Properties, 'AssociationId') as association_id, + json_extract_path_text(Properties, 'StorageType') as storage_type, + json_extract_path_text(Properties, 'S3Config') as s3_config, + json_extract_path_text(Properties, 'KinesisVideoStreamConfig') as kinesis_video_stream_config, + json_extract_path_text(Properties, 'KinesisStreamConfig') as kinesis_stream_config, + json_extract_path_text(Properties, 'KinesisFirehoseConfig') as kinesis_firehose_config + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::InstanceStorageConfig' + AND data__Identifier = '||' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'InstanceArn') as instance_arn, + json_extract_path_text(Properties, 'AssociationId') as association_id, + json_extract_path_text(Properties, 'ResourceType') as resource_type + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::InstanceStorageConfig' + AND region = 'us-east-1' + integration_associations: + name: integration_associations + id: aws.connect.integration_associations + x-cfn-schema-name: IntegrationAssociation + x-cfn-type-name: AWS::Connect::IntegrationAssociation x-identifiers: - InstanceId - IntegrationType - IntegrationArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -5607,45 +5518,11 @@ components: - $ref: '#/components/x-stackQL-resources/integration_associations/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/integration_associations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.InstanceId') as instance_id, - JSON_EXTRACT(Properties, '$.IntegrationType') as integration_type, - JSON_EXTRACT(Properties, '$.IntegrationArn') as integration_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::IntegrationAssociation' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'InstanceId') as instance_id, - json_extract_path_text(Properties, 'IntegrationType') as integration_type, - json_extract_path_text(Properties, 'IntegrationArn') as integration_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::IntegrationAssociation' - AND region = 'us-east-1' - integration_association: - name: integration_association - id: aws.connect.integration_association - x-cfn-schema-name: IntegrationAssociation - x-cfn-type-name: AWS::Connect::IntegrationAssociation - x-identifiers: - - InstanceId - - IntegrationType - - IntegrationArn - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -5658,18 +5535,38 @@ components: AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'IntegrationAssociationId') as integration_association_id, - json_extract_path_text(Properties, 'InstanceId') as instance_id, - json_extract_path_text(Properties, 'IntegrationArn') as integration_arn, - json_extract_path_text(Properties, 'IntegrationType') as integration_type - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::IntegrationAssociation' - AND data__Identifier = '||' + JSON_EXTRACT(Properties, '$.InstanceId') as instance_id, + JSON_EXTRACT(Properties, '$.IntegrationType') as integration_type, + JSON_EXTRACT(Properties, '$.IntegrationArn') as integration_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::IntegrationAssociation' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'IntegrationAssociationId') as integration_association_id, + json_extract_path_text(Properties, 'InstanceId') as instance_id, + json_extract_path_text(Properties, 'IntegrationArn') as integration_arn, + json_extract_path_text(Properties, 'IntegrationType') as integration_type + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::IntegrationAssociation' + AND data__Identifier = '||' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'InstanceId') as instance_id, + json_extract_path_text(Properties, 'IntegrationType') as integration_type, + json_extract_path_text(Properties, 'IntegrationArn') as integration_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::IntegrationAssociation' + AND region = 'us-east-1' predefined_attributes: name: predefined_attributes id: aws.connect.predefined_attributes @@ -5678,7 +5575,7 @@ components: x-identifiers: - InstanceArn - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -5695,9 +5592,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -5707,44 +5604,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/predefined_attributes/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/predefined_attributes/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.InstanceArn') as instance_arn, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::PredefinedAttribute' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'InstanceArn') as instance_arn, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::PredefinedAttribute' - AND region = 'us-east-1' - predefined_attribute: - name: predefined_attribute - id: aws.connect.predefined_attribute - x-cfn-schema-name: PredefinedAttribute - x-cfn-type-name: AWS::Connect::PredefinedAttribute - x-identifiers: - - InstanceArn - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -5755,12 +5617,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/predefined_attributes/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/predefined_attributes/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/predefined_attribute/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/predefined_attributes/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -5774,19 +5640,37 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'InstanceArn') as instance_arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Values') as _values, - json_extract_path_text(Properties, 'LastModifiedRegion') as last_modified_region, - json_extract_path_text(Properties, 'LastModifiedTime') as last_modified_time - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::PredefinedAttribute' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.InstanceArn') as instance_arn, + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::PredefinedAttribute' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'InstanceArn') as instance_arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Values') as _values, + json_extract_path_text(Properties, 'LastModifiedRegion') as last_modified_region, + json_extract_path_text(Properties, 'LastModifiedTime') as last_modified_time + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::PredefinedAttribute' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'InstanceArn') as instance_arn, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::PredefinedAttribute' + AND region = 'us-east-1' prompts: name: prompts id: aws.connect.prompts @@ -5794,7 +5678,7 @@ components: x-cfn-type-name: AWS::Connect::Prompt x-identifiers: - PromptArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -5811,9 +5695,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -5823,41 +5707,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/prompts/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/prompts/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.PromptArn') as prompt_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::Prompt' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'PromptArn') as prompt_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::Prompt' - AND region = 'us-east-1' - prompt: - name: prompt - id: aws.connect.prompt - x-cfn-schema-name: Prompt - x-cfn-type-name: AWS::Connect::Prompt - x-identifiers: - - PromptArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -5868,12 +5720,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/prompts/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/prompts/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/prompt/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/prompts/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -5888,20 +5744,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'InstanceArn') as instance_arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'S3Uri') as s3_uri, - json_extract_path_text(Properties, 'PromptArn') as prompt_arn, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::Prompt' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.PromptArn') as prompt_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::Prompt' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'InstanceArn') as instance_arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'S3Uri') as s3_uri, + json_extract_path_text(Properties, 'PromptArn') as prompt_arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::Prompt' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'PromptArn') as prompt_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::Prompt' + AND region = 'us-east-1' queues: name: queues id: aws.connect.queues @@ -5909,7 +5781,7 @@ components: x-cfn-type-name: AWS::Connect::Queue x-identifiers: - QueueArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -5926,9 +5798,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -5938,41 +5810,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/queues/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/queues/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.QueueArn') as queue_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::Queue' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'QueueArn') as queue_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::Queue' - AND region = 'us-east-1' - queue: - name: queue - id: aws.connect.queue - x-cfn-schema-name: Queue - x-cfn-type-name: AWS::Connect::Queue - x-identifiers: - - QueueArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -5983,12 +5823,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/queues/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/queues/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/queue/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/queues/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -6008,25 +5852,41 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'InstanceArn') as instance_arn, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'HoursOfOperationArn') as hours_of_operation_arn, - json_extract_path_text(Properties, 'MaxContacts') as max_contacts, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'OutboundCallerConfig') as outbound_caller_config, - json_extract_path_text(Properties, 'QueueArn') as queue_arn, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'QuickConnectArns') as quick_connect_arns, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Type') as type - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::Queue' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.QueueArn') as queue_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::Queue' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'InstanceArn') as instance_arn, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'HoursOfOperationArn') as hours_of_operation_arn, + json_extract_path_text(Properties, 'MaxContacts') as max_contacts, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'OutboundCallerConfig') as outbound_caller_config, + json_extract_path_text(Properties, 'QueueArn') as queue_arn, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'QuickConnectArns') as quick_connect_arns, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Type') as type + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::Queue' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'QueueArn') as queue_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::Queue' + AND region = 'us-east-1' quick_connects: name: quick_connects id: aws.connect.quick_connects @@ -6034,7 +5894,7 @@ components: x-cfn-type-name: AWS::Connect::QuickConnect x-identifiers: - QuickConnectArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -6051,9 +5911,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -6063,41 +5923,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/quick_connects/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/quick_connects/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.QuickConnectArn') as quick_connect_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::QuickConnect' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'QuickConnectArn') as quick_connect_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::QuickConnect' - AND region = 'us-east-1' - quick_connect: - name: quick_connect - id: aws.connect.quick_connect - x-cfn-schema-name: QuickConnect - x-cfn-type-name: AWS::Connect::QuickConnect - x-identifiers: - - QuickConnectArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -6108,12 +5936,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/quick_connects/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/quick_connects/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/quick_connect/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/quick_connects/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -6129,21 +5961,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'InstanceArn') as instance_arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'QuickConnectConfig') as quick_connect_config, - json_extract_path_text(Properties, 'QuickConnectArn') as quick_connect_arn, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'QuickConnectType') as quick_connect_type - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::QuickConnect' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.QuickConnectArn') as quick_connect_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::QuickConnect' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'InstanceArn') as instance_arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'QuickConnectConfig') as quick_connect_config, + json_extract_path_text(Properties, 'QuickConnectArn') as quick_connect_arn, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'QuickConnectType') as quick_connect_type + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::QuickConnect' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'QuickConnectArn') as quick_connect_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::QuickConnect' + AND region = 'us-east-1' routing_profiles: name: routing_profiles id: aws.connect.routing_profiles @@ -6151,7 +5999,7 @@ components: x-cfn-type-name: AWS::Connect::RoutingProfile x-identifiers: - RoutingProfileArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -6168,9 +6016,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -6180,41 +6028,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/routing_profiles/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/routing_profiles/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.RoutingProfileArn') as routing_profile_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::RoutingProfile' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'RoutingProfileArn') as routing_profile_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::RoutingProfile' - AND region = 'us-east-1' - routing_profile: - name: routing_profile - id: aws.connect.routing_profile - x-cfn-schema-name: RoutingProfile - x-cfn-type-name: AWS::Connect::RoutingProfile - x-identifiers: - - RoutingProfileArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -6225,12 +6041,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/routing_profiles/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/routing_profiles/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/routing_profile/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/routing_profiles/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -6248,23 +6068,39 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'InstanceArn') as instance_arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'MediaConcurrencies') as media_concurrencies, - json_extract_path_text(Properties, 'DefaultOutboundQueueArn') as default_outbound_queue_arn, - json_extract_path_text(Properties, 'RoutingProfileArn') as routing_profile_arn, - json_extract_path_text(Properties, 'QueueConfigs') as queue_configs, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'AgentAvailabilityTimer') as agent_availability_timer - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::RoutingProfile' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.RoutingProfileArn') as routing_profile_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::RoutingProfile' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'InstanceArn') as instance_arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'MediaConcurrencies') as media_concurrencies, + json_extract_path_text(Properties, 'DefaultOutboundQueueArn') as default_outbound_queue_arn, + json_extract_path_text(Properties, 'RoutingProfileArn') as routing_profile_arn, + json_extract_path_text(Properties, 'QueueConfigs') as queue_configs, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'AgentAvailabilityTimer') as agent_availability_timer + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::RoutingProfile' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'RoutingProfileArn') as routing_profile_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::RoutingProfile' + AND region = 'us-east-1' rules: name: rules id: aws.connect.rules @@ -6272,7 +6108,7 @@ components: x-cfn-type-name: AWS::Connect::Rule x-identifiers: - RuleArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -6289,9 +6125,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -6301,23 +6137,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/rules/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/rules/methods/delete_resource' - rule: - name: rule - id: aws.connect.rule - x-cfn-schema-name: Rule - x-cfn-type-name: AWS::Connect::Rule - x-identifiers: - - RuleArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -6328,12 +6150,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/rules/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/rules/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/rule/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/rules/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -6350,7 +6176,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -6374,7 +6200,7 @@ components: x-identifiers: - InstanceId - AssociationId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -6408,42 +6234,11 @@ components: - $ref: '#/components/x-stackQL-resources/security_keys/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/security_keys/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.InstanceId') as instance_id, - JSON_EXTRACT(Properties, '$.AssociationId') as association_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::SecurityKey' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'InstanceId') as instance_id, - json_extract_path_text(Properties, 'AssociationId') as association_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::SecurityKey' - AND region = 'us-east-1' - security_key: - name: security_key - id: aws.connect.security_key - x-cfn-schema-name: SecurityKey - x-cfn-type-name: AWS::Connect::SecurityKey - x-identifiers: - - InstanceId - - AssociationId - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -6455,17 +6250,35 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Key') as key, - json_extract_path_text(Properties, 'InstanceId') as instance_id, - json_extract_path_text(Properties, 'AssociationId') as association_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::SecurityKey' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.InstanceId') as instance_id, + JSON_EXTRACT(Properties, '$.AssociationId') as association_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::SecurityKey' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Key') as key, + json_extract_path_text(Properties, 'InstanceId') as instance_id, + json_extract_path_text(Properties, 'AssociationId') as association_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::SecurityKey' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'InstanceId') as instance_id, + json_extract_path_text(Properties, 'AssociationId') as association_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::SecurityKey' + AND region = 'us-east-1' security_profiles: name: security_profiles id: aws.connect.security_profiles @@ -6473,7 +6286,7 @@ components: x-cfn-type-name: AWS::Connect::SecurityProfile x-identifiers: - SecurityProfileArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -6490,9 +6303,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -6502,41 +6315,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/security_profiles/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/security_profiles/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.SecurityProfileArn') as security_profile_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::SecurityProfile' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'SecurityProfileArn') as security_profile_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::SecurityProfile' - AND region = 'us-east-1' - security_profile: - name: security_profile - id: aws.connect.security_profile - x-cfn-schema-name: SecurityProfile - x-cfn-type-name: AWS::Connect::SecurityProfile - x-identifiers: - - SecurityProfileArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -6547,12 +6328,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/security_profiles/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/security_profiles/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/security_profile/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/security_profiles/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -6574,27 +6359,43 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AllowedAccessControlTags') as allowed_access_control_tags, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'InstanceArn') as instance_arn, - json_extract_path_text(Properties, 'Permissions') as permissions, - json_extract_path_text(Properties, 'SecurityProfileArn') as security_profile_arn, - json_extract_path_text(Properties, 'SecurityProfileName') as security_profile_name, - json_extract_path_text(Properties, 'TagRestrictedResources') as tag_restricted_resources, - json_extract_path_text(Properties, 'HierarchyRestrictedResources') as hierarchy_restricted_resources, - json_extract_path_text(Properties, 'AllowedAccessControlHierarchyGroupId') as allowed_access_control_hierarchy_group_id, - json_extract_path_text(Properties, 'Applications') as applications, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'LastModifiedRegion') as last_modified_region, - json_extract_path_text(Properties, 'LastModifiedTime') as last_modified_time - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::SecurityProfile' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.SecurityProfileArn') as security_profile_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::SecurityProfile' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AllowedAccessControlTags') as allowed_access_control_tags, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'InstanceArn') as instance_arn, + json_extract_path_text(Properties, 'Permissions') as permissions, + json_extract_path_text(Properties, 'SecurityProfileArn') as security_profile_arn, + json_extract_path_text(Properties, 'SecurityProfileName') as security_profile_name, + json_extract_path_text(Properties, 'TagRestrictedResources') as tag_restricted_resources, + json_extract_path_text(Properties, 'HierarchyRestrictedResources') as hierarchy_restricted_resources, + json_extract_path_text(Properties, 'AllowedAccessControlHierarchyGroupId') as allowed_access_control_hierarchy_group_id, + json_extract_path_text(Properties, 'Applications') as applications, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'LastModifiedRegion') as last_modified_region, + json_extract_path_text(Properties, 'LastModifiedTime') as last_modified_time + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::SecurityProfile' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'SecurityProfileArn') as security_profile_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::SecurityProfile' + AND region = 'us-east-1' task_templates: name: task_templates id: aws.connect.task_templates @@ -6602,7 +6403,7 @@ components: x-cfn-type-name: AWS::Connect::TaskTemplate x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -6619,9 +6420,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -6631,41 +6432,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/task_templates/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/task_templates/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::TaskTemplate' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::TaskTemplate' - AND region = 'us-east-1' - task_template: - name: task_template - id: aws.connect.task_template - x-cfn-schema-name: TaskTemplate - x-cfn-type-name: AWS::Connect::TaskTemplate - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -6676,12 +6445,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/task_templates/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/task_templates/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/task_template/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/task_templates/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -6701,25 +6474,41 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'InstanceArn') as instance_arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'ContactFlowArn') as contact_flow_arn, - json_extract_path_text(Properties, 'Constraints') as constraints, - json_extract_path_text(Properties, 'Defaults') as defaults, - json_extract_path_text(Properties, 'Fields') as fields, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'ClientToken') as client_token, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::TaskTemplate' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::TaskTemplate' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'InstanceArn') as instance_arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'ContactFlowArn') as contact_flow_arn, + json_extract_path_text(Properties, 'Constraints') as constraints, + json_extract_path_text(Properties, 'Defaults') as defaults, + json_extract_path_text(Properties, 'Fields') as fields, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'ClientToken') as client_token, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::TaskTemplate' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::TaskTemplate' + AND region = 'us-east-1' traffic_distribution_groups: name: traffic_distribution_groups id: aws.connect.traffic_distribution_groups @@ -6727,7 +6516,7 @@ components: x-cfn-type-name: AWS::Connect::TrafficDistributionGroup x-identifiers: - TrafficDistributionGroupArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -6744,9 +6533,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -6756,41 +6545,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/traffic_distribution_groups/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/traffic_distribution_groups/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.TrafficDistributionGroupArn') as traffic_distribution_group_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::TrafficDistributionGroup' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'TrafficDistributionGroupArn') as traffic_distribution_group_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::TrafficDistributionGroup' - AND region = 'us-east-1' - traffic_distribution_group: - name: traffic_distribution_group - id: aws.connect.traffic_distribution_group - x-cfn-schema-name: TrafficDistributionGroup - x-cfn-type-name: AWS::Connect::TrafficDistributionGroup - x-identifiers: - - TrafficDistributionGroupArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -6801,12 +6558,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/traffic_distribution_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/traffic_distribution_groups/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/traffic_distribution_group/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/traffic_distribution_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -6822,21 +6583,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'InstanceArn') as instance_arn, - json_extract_path_text(Properties, 'TrafficDistributionGroupArn') as traffic_distribution_group_arn, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'IsDefault') as is_default - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::TrafficDistributionGroup' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.TrafficDistributionGroupArn') as traffic_distribution_group_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::TrafficDistributionGroup' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'InstanceArn') as instance_arn, + json_extract_path_text(Properties, 'TrafficDistributionGroupArn') as traffic_distribution_group_arn, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'IsDefault') as is_default + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::TrafficDistributionGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'TrafficDistributionGroupArn') as traffic_distribution_group_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::TrafficDistributionGroup' + AND region = 'us-east-1' users: name: users id: aws.connect.users @@ -6844,7 +6621,7 @@ components: x-cfn-type-name: AWS::Connect::User x-identifiers: - UserArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -6861,9 +6638,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -6873,41 +6650,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/users/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/users/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.UserArn') as user_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::User' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'UserArn') as user_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::User' - AND region = 'us-east-1' - user: - name: user - id: aws.connect.user - x-cfn-schema-name: User - x-cfn-type-name: AWS::Connect::User - x-identifiers: - - UserArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -6918,12 +6663,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/users/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/users/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/user/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/users/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -6944,26 +6693,42 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'InstanceArn') as instance_arn, - json_extract_path_text(Properties, 'DirectoryUserId') as directory_user_id, - json_extract_path_text(Properties, 'HierarchyGroupArn') as hierarchy_group_arn, - json_extract_path_text(Properties, 'Username') as username, - json_extract_path_text(Properties, 'Password') as password, - json_extract_path_text(Properties, 'RoutingProfileArn') as routing_profile_arn, - json_extract_path_text(Properties, 'IdentityInfo') as identity_info, - json_extract_path_text(Properties, 'PhoneConfig') as phone_config, - json_extract_path_text(Properties, 'SecurityProfileArns') as security_profile_arns, - json_extract_path_text(Properties, 'UserArn') as user_arn, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'UserProficiencies') as user_proficiencies - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::User' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.UserArn') as user_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::User' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'InstanceArn') as instance_arn, + json_extract_path_text(Properties, 'DirectoryUserId') as directory_user_id, + json_extract_path_text(Properties, 'HierarchyGroupArn') as hierarchy_group_arn, + json_extract_path_text(Properties, 'Username') as username, + json_extract_path_text(Properties, 'Password') as password, + json_extract_path_text(Properties, 'RoutingProfileArn') as routing_profile_arn, + json_extract_path_text(Properties, 'IdentityInfo') as identity_info, + json_extract_path_text(Properties, 'PhoneConfig') as phone_config, + json_extract_path_text(Properties, 'SecurityProfileArns') as security_profile_arns, + json_extract_path_text(Properties, 'UserArn') as user_arn, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'UserProficiencies') as user_proficiencies + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::User' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'UserArn') as user_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::User' + AND region = 'us-east-1' user_hierarchy_groups: name: user_hierarchy_groups id: aws.connect.user_hierarchy_groups @@ -6971,7 +6736,7 @@ components: x-cfn-type-name: AWS::Connect::UserHierarchyGroup x-identifiers: - UserHierarchyGroupArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -6988,9 +6753,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -7000,41 +6765,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/user_hierarchy_groups/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/user_hierarchy_groups/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.UserHierarchyGroupArn') as user_hierarchy_group_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::UserHierarchyGroup' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'UserHierarchyGroupArn') as user_hierarchy_group_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::UserHierarchyGroup' - AND region = 'us-east-1' - user_hierarchy_group: - name: user_hierarchy_group - id: aws.connect.user_hierarchy_group - x-cfn-schema-name: UserHierarchyGroup - x-cfn-type-name: AWS::Connect::UserHierarchyGroup - x-identifiers: - - UserHierarchyGroupArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -7045,12 +6778,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/user_hierarchy_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/user_hierarchy_groups/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/user_hierarchy_group/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/user_hierarchy_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -7064,19 +6801,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'InstanceArn') as instance_arn, - json_extract_path_text(Properties, 'UserHierarchyGroupArn') as user_hierarchy_group_arn, - json_extract_path_text(Properties, 'ParentGroupArn') as parent_group_arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::UserHierarchyGroup' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.UserHierarchyGroupArn') as user_hierarchy_group_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::UserHierarchyGroup' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'InstanceArn') as instance_arn, + json_extract_path_text(Properties, 'UserHierarchyGroupArn') as user_hierarchy_group_arn, + json_extract_path_text(Properties, 'ParentGroupArn') as parent_group_arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::UserHierarchyGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'UserHierarchyGroupArn') as user_hierarchy_group_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::UserHierarchyGroup' + AND region = 'us-east-1' views: name: views id: aws.connect.views @@ -7084,7 +6837,7 @@ components: x-cfn-type-name: AWS::Connect::View x-identifiers: - ViewArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -7101,9 +6854,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -7113,41 +6866,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/views/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/views/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ViewArn') as view_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::View' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ViewArn') as view_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::View' - AND region = 'us-east-1' - view: - name: view - id: aws.connect.view - x-cfn-schema-name: View - x-cfn-type-name: AWS::Connect::View - x-identifiers: - - ViewArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -7158,12 +6879,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/views/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/views/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/view/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/views/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -7181,23 +6906,39 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'InstanceArn') as instance_arn, - json_extract_path_text(Properties, 'ViewArn') as view_arn, - json_extract_path_text(Properties, 'ViewId') as view_id, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Template') as template, - json_extract_path_text(Properties, 'Actions') as actions, - json_extract_path_text(Properties, 'ViewContentSha256') as view_content_sha256, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::View' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ViewArn') as view_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::View' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'InstanceArn') as instance_arn, + json_extract_path_text(Properties, 'ViewArn') as view_arn, + json_extract_path_text(Properties, 'ViewId') as view_id, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Template') as template, + json_extract_path_text(Properties, 'Actions') as actions, + json_extract_path_text(Properties, 'ViewContentSha256') as view_content_sha256, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::View' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ViewArn') as view_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::View' + AND region = 'us-east-1' view_versions: name: view_versions id: aws.connect.view_versions @@ -7205,7 +6946,7 @@ components: x-cfn-type-name: AWS::Connect::ViewVersion x-identifiers: - ViewVersionArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -7239,39 +6980,11 @@ components: - $ref: '#/components/x-stackQL-resources/view_versions/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/view_versions/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ViewVersionArn') as view_version_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::ViewVersion' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ViewVersionArn') as view_version_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::ViewVersion' - AND region = 'us-east-1' - view_version: - name: view_version - id: aws.connect.view_version - x-cfn-schema-name: ViewVersion - x-cfn-type-name: AWS::Connect::ViewVersion - x-identifiers: - - ViewVersionArn - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -7285,19 +6998,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ViewArn') as view_arn, - json_extract_path_text(Properties, 'ViewVersionArn') as view_version_arn, - json_extract_path_text(Properties, 'VersionDescription') as version_description, - json_extract_path_text(Properties, 'ViewContentSha256') as view_content_sha256, - json_extract_path_text(Properties, 'Version') as version - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::ViewVersion' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ViewVersionArn') as view_version_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::ViewVersion' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ViewArn') as view_arn, + json_extract_path_text(Properties, 'ViewVersionArn') as view_version_arn, + json_extract_path_text(Properties, 'VersionDescription') as version_description, + json_extract_path_text(Properties, 'ViewContentSha256') as view_content_sha256, + json_extract_path_text(Properties, 'Version') as version + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Connect::ViewVersion' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ViewVersionArn') as view_version_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Connect::ViewVersion' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/connectcampaigns.yaml b/providers/src/aws/v00.00.00000/services/connectcampaigns.yaml index e560839b..a7a8d667 100644 --- a/providers/src/aws/v00.00.00000/services/connectcampaigns.yaml +++ b/providers/src/aws/v00.00.00000/services/connectcampaigns.yaml @@ -478,6 +478,9 @@ components: EnableAnswerMachineDetection: type: boolean description: Flag to decided whether outbound calls should have answering machine detection enabled or not + AwaitAnswerMachinePrompt: + type: boolean + description: Enables detection of prompts (e.g., beep after after a voicemail greeting) required: - EnableAnswerMachineDetection additionalProperties: false @@ -639,7 +642,7 @@ components: x-cfn-type-name: AWS::ConnectCampaigns::Campaign x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -656,9 +659,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -668,41 +671,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/campaigns/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/campaigns/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ConnectCampaigns::Campaign' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ConnectCampaigns::Campaign' - AND region = 'us-east-1' - campaign: - name: campaign - id: aws.connectcampaigns.campaign - x-cfn-schema-name: Campaign - x-cfn-type-name: AWS::ConnectCampaigns::Campaign - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -713,12 +684,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/campaigns/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/campaigns/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/campaign/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/campaigns/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -733,20 +708,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ConnectInstanceArn') as connect_instance_arn, - json_extract_path_text(Properties, 'DialerConfig') as dialer_config, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'OutboundCallConfig') as outbound_call_config, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ConnectCampaigns::Campaign' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ConnectCampaigns::Campaign' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ConnectInstanceArn') as connect_instance_arn, + json_extract_path_text(Properties, 'DialerConfig') as dialer_config, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'OutboundCallConfig') as outbound_call_config, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ConnectCampaigns::Campaign' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ConnectCampaigns::Campaign' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/controltower.yaml b/providers/src/aws/v00.00.00000/services/controltower.yaml index 8cdc1cba..9e4de6f7 100644 --- a/providers/src/aws/v00.00.00000/services/controltower.yaml +++ b/providers/src/aws/v00.00.00000/services/controltower.yaml @@ -988,7 +988,7 @@ components: x-cfn-type-name: AWS::ControlTower::EnabledBaseline x-identifiers: - EnabledBaselineIdentifier - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1005,9 +1005,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1017,41 +1017,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/enabled_baselines/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/enabled_baselines/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.EnabledBaselineIdentifier') as enabled_baseline_identifier - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ControlTower::EnabledBaseline' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'EnabledBaselineIdentifier') as enabled_baseline_identifier - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ControlTower::EnabledBaseline' - AND region = 'us-east-1' - enabled_baseline: - name: enabled_baseline - id: aws.controltower.enabled_baseline - x-cfn-schema-name: EnabledBaseline - x-cfn-type-name: AWS::ControlTower::EnabledBaseline - x-identifiers: - - EnabledBaselineIdentifier - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1062,12 +1030,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/enabled_baselines/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/enabled_baselines/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/enabled_baseline/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/enabled_baselines/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1082,20 +1054,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'BaselineIdentifier') as baseline_identifier, - json_extract_path_text(Properties, 'BaselineVersion') as baseline_version, - json_extract_path_text(Properties, 'EnabledBaselineIdentifier') as enabled_baseline_identifier, - json_extract_path_text(Properties, 'TargetIdentifier') as target_identifier, - json_extract_path_text(Properties, 'Parameters') as parameters, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ControlTower::EnabledBaseline' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.EnabledBaselineIdentifier') as enabled_baseline_identifier + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ControlTower::EnabledBaseline' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'BaselineIdentifier') as baseline_identifier, + json_extract_path_text(Properties, 'BaselineVersion') as baseline_version, + json_extract_path_text(Properties, 'EnabledBaselineIdentifier') as enabled_baseline_identifier, + json_extract_path_text(Properties, 'TargetIdentifier') as target_identifier, + json_extract_path_text(Properties, 'Parameters') as parameters, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ControlTower::EnabledBaseline' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'EnabledBaselineIdentifier') as enabled_baseline_identifier + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ControlTower::EnabledBaseline' + AND region = 'us-east-1' enabled_controls: name: enabled_controls id: aws.controltower.enabled_controls @@ -1104,7 +1092,7 @@ components: x-identifiers: - TargetIdentifier - ControlIdentifier - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1121,9 +1109,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1133,44 +1121,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/enabled_controls/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/enabled_controls/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.TargetIdentifier') as target_identifier, - JSON_EXTRACT(Properties, '$.ControlIdentifier') as control_identifier - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ControlTower::EnabledControl' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'TargetIdentifier') as target_identifier, - json_extract_path_text(Properties, 'ControlIdentifier') as control_identifier - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ControlTower::EnabledControl' - AND region = 'us-east-1' - enabled_control: - name: enabled_control - id: aws.controltower.enabled_control - x-cfn-schema-name: EnabledControl - x-cfn-type-name: AWS::ControlTower::EnabledControl - x-identifiers: - - TargetIdentifier - - ControlIdentifier - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1181,12 +1134,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/enabled_controls/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/enabled_controls/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/enabled_control/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/enabled_controls/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1199,18 +1156,36 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ControlIdentifier') as control_identifier, - json_extract_path_text(Properties, 'TargetIdentifier') as target_identifier, - json_extract_path_text(Properties, 'Parameters') as parameters, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ControlTower::EnabledControl' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.TargetIdentifier') as target_identifier, + JSON_EXTRACT(Properties, '$.ControlIdentifier') as control_identifier + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ControlTower::EnabledControl' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ControlIdentifier') as control_identifier, + json_extract_path_text(Properties, 'TargetIdentifier') as target_identifier, + json_extract_path_text(Properties, 'Parameters') as parameters, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ControlTower::EnabledControl' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'TargetIdentifier') as target_identifier, + json_extract_path_text(Properties, 'ControlIdentifier') as control_identifier + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ControlTower::EnabledControl' + AND region = 'us-east-1' landing_zones: name: landing_zones id: aws.controltower.landing_zones @@ -1218,7 +1193,7 @@ components: x-cfn-type-name: AWS::ControlTower::LandingZone x-identifiers: - LandingZoneIdentifier - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1235,9 +1210,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1247,41 +1222,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/landing_zones/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/landing_zones/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.LandingZoneIdentifier') as landing_zone_identifier - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ControlTower::LandingZone' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'LandingZoneIdentifier') as landing_zone_identifier - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ControlTower::LandingZone' - AND region = 'us-east-1' - landing_zone: - name: landing_zone - id: aws.controltower.landing_zone - x-cfn-schema-name: LandingZone - x-cfn-type-name: AWS::ControlTower::LandingZone - x-identifiers: - - LandingZoneIdentifier - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1292,12 +1235,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/landing_zones/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/landing_zones/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/landing_zone/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/landing_zones/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1314,22 +1261,38 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'LandingZoneIdentifier') as landing_zone_identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'LatestAvailableVersion') as latest_available_version, - json_extract_path_text(Properties, 'DriftStatus') as drift_status, - json_extract_path_text(Properties, 'Manifest') as manifest, - json_extract_path_text(Properties, 'Version') as version, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ControlTower::LandingZone' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.LandingZoneIdentifier') as landing_zone_identifier + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ControlTower::LandingZone' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'LandingZoneIdentifier') as landing_zone_identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'LatestAvailableVersion') as latest_available_version, + json_extract_path_text(Properties, 'DriftStatus') as drift_status, + json_extract_path_text(Properties, 'Manifest') as manifest, + json_extract_path_text(Properties, 'Version') as version, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ControlTower::LandingZone' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'LandingZoneIdentifier') as landing_zone_identifier + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ControlTower::LandingZone' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/cur.yaml b/providers/src/aws/v00.00.00000/services/cur.yaml index 23354242..6a89f32f 100644 --- a/providers/src/aws/v00.00.00000/services/cur.yaml +++ b/providers/src/aws/v00.00.00000/services/cur.yaml @@ -385,6 +385,21 @@ components: $ref: '#/components/x-cloud-control-schemas/ProgressEvent' type: object schemas: + Tag: + type: object + properties: + Key: + type: string + maxLength: 128 + minLength: 1 + Value: + type: string + maxLength: 256 + minLength: 0 + required: + - Key + - Value + additionalProperties: false ReportDefinition: type: object properties: @@ -423,6 +438,8 @@ components: type: string enum: - RESOURCES + - SPLIT_COST_ALLOCATION_DATA + - MANUAL_DISCOUNT_COMPATIBILITY S3Bucket: description: The S3 bucket where AWS delivers the report. type: string @@ -496,16 +513,18 @@ components: - S3Region - RefreshClosedReports - ReportVersioning + x-tagging: + taggable: false x-required-permissions: create: - cur:PutReportDefinition + - cur:DescribeReportDefinitions read: - cur:DescribeReportDefinitions update: - cur:DescribeReportDefinitions - cur:ModifyReportDefinition delete: - - cur:DescribeReportDefinitions - cur:DeleteReportDefinition list: - cur:DescribeReportDefinitions @@ -557,6 +576,8 @@ components: type: string enum: - RESOURCES + - SPLIT_COST_ALLOCATION_DATA + - MANUAL_DISCOUNT_COMPATIBILITY S3Bucket: description: The S3 bucket where AWS delivers the report. type: string @@ -618,7 +639,7 @@ components: x-cfn-type-name: AWS::CUR::ReportDefinition x-identifiers: - ReportName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -635,9 +656,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -647,41 +668,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/report_definitions/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/report_definitions/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ReportName') as report_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CUR::ReportDefinition' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ReportName') as report_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CUR::ReportDefinition' - AND region = 'us-east-1' - report_definition: - name: report_definition - id: aws.cur.report_definition - x-cfn-schema-name: ReportDefinition - x-cfn-type-name: AWS::CUR::ReportDefinition - x-identifiers: - - ReportName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -692,12 +681,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/report_definitions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/report_definitions/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/report_definition/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/report_definitions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -718,26 +711,42 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ReportName') as report_name, - json_extract_path_text(Properties, 'TimeUnit') as time_unit, - json_extract_path_text(Properties, 'Format') as _format, - json_extract_path_text(Properties, 'Compression') as compression, - json_extract_path_text(Properties, 'AdditionalSchemaElements') as additional_schema_elements, - json_extract_path_text(Properties, 'S3Bucket') as s3_bucket, - json_extract_path_text(Properties, 'S3Prefix') as s3_prefix, - json_extract_path_text(Properties, 'S3Region') as s3_region, - json_extract_path_text(Properties, 'AdditionalArtifacts') as additional_artifacts, - json_extract_path_text(Properties, 'RefreshClosedReports') as refresh_closed_reports, - json_extract_path_text(Properties, 'ReportVersioning') as report_versioning, - json_extract_path_text(Properties, 'BillingViewArn') as billing_view_arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CUR::ReportDefinition' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ReportName') as report_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CUR::ReportDefinition' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ReportName') as report_name, + json_extract_path_text(Properties, 'TimeUnit') as time_unit, + json_extract_path_text(Properties, 'Format') as _format, + json_extract_path_text(Properties, 'Compression') as compression, + json_extract_path_text(Properties, 'AdditionalSchemaElements') as additional_schema_elements, + json_extract_path_text(Properties, 'S3Bucket') as s3_bucket, + json_extract_path_text(Properties, 'S3Prefix') as s3_prefix, + json_extract_path_text(Properties, 'S3Region') as s3_region, + json_extract_path_text(Properties, 'AdditionalArtifacts') as additional_artifacts, + json_extract_path_text(Properties, 'RefreshClosedReports') as refresh_closed_reports, + json_extract_path_text(Properties, 'ReportVersioning') as report_versioning, + json_extract_path_text(Properties, 'BillingViewArn') as billing_view_arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CUR::ReportDefinition' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ReportName') as report_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CUR::ReportDefinition' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/customerprofiles.yaml b/providers/src/aws/v00.00.00000/services/customerprofiles.yaml index 0c558707..244a1fc4 100644 --- a/providers/src/aws/v00.00.00000/services/customerprofiles.yaml +++ b/providers/src/aws/v00.00.00000/services/customerprofiles.yaml @@ -2074,7 +2074,7 @@ components: x-identifiers: - DomainName - CalculatedAttributeName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2091,9 +2091,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2103,44 +2103,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/calculated_attribute_definitions/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/calculated_attribute_definitions/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.DomainName') as domain_name, - JSON_EXTRACT(Properties, '$.CalculatedAttributeName') as calculated_attribute_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CustomerProfiles::CalculatedAttributeDefinition' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'DomainName') as domain_name, - json_extract_path_text(Properties, 'CalculatedAttributeName') as calculated_attribute_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CustomerProfiles::CalculatedAttributeDefinition' - AND region = 'us-east-1' - calculated_attribute_definition: - name: calculated_attribute_definition - id: aws.customerprofiles.calculated_attribute_definition - x-cfn-schema-name: CalculatedAttributeDefinition - x-cfn-type-name: AWS::CustomerProfiles::CalculatedAttributeDefinition - x-identifiers: - - DomainName - - CalculatedAttributeName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2151,12 +2116,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/calculated_attribute_definitions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/calculated_attribute_definitions/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/calculated_attribute_definition/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/calculated_attribute_definitions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2175,24 +2144,42 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'DomainName') as domain_name, - json_extract_path_text(Properties, 'CalculatedAttributeName') as calculated_attribute_name, - json_extract_path_text(Properties, 'DisplayName') as display_name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'AttributeDetails') as attribute_details, - json_extract_path_text(Properties, 'Conditions') as conditions, - json_extract_path_text(Properties, 'Statistic') as statistic, - json_extract_path_text(Properties, 'CreatedAt') as created_at, - json_extract_path_text(Properties, 'LastUpdatedAt') as last_updated_at, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CustomerProfiles::CalculatedAttributeDefinition' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.DomainName') as domain_name, + JSON_EXTRACT(Properties, '$.CalculatedAttributeName') as calculated_attribute_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CustomerProfiles::CalculatedAttributeDefinition' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DomainName') as domain_name, + json_extract_path_text(Properties, 'CalculatedAttributeName') as calculated_attribute_name, + json_extract_path_text(Properties, 'DisplayName') as display_name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'AttributeDetails') as attribute_details, + json_extract_path_text(Properties, 'Conditions') as conditions, + json_extract_path_text(Properties, 'Statistic') as statistic, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'LastUpdatedAt') as last_updated_at, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CustomerProfiles::CalculatedAttributeDefinition' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DomainName') as domain_name, + json_extract_path_text(Properties, 'CalculatedAttributeName') as calculated_attribute_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CustomerProfiles::CalculatedAttributeDefinition' + AND region = 'us-east-1' domains: name: domains id: aws.customerprofiles.domains @@ -2200,7 +2187,7 @@ components: x-cfn-type-name: AWS::CustomerProfiles::Domain x-identifiers: - DomainName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2217,9 +2204,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2229,41 +2216,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/domains/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/domains/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.DomainName') as domain_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CustomerProfiles::Domain' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'DomainName') as domain_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CustomerProfiles::Domain' - AND region = 'us-east-1' - domain: - name: domain - id: aws.customerprofiles.domain - x-cfn-schema-name: Domain - x-cfn-type-name: AWS::CustomerProfiles::Domain - x-identifiers: - - DomainName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2274,12 +2229,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/domains/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/domains/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/domain/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/domains/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2298,24 +2257,40 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'DomainName') as domain_name, - json_extract_path_text(Properties, 'DeadLetterQueueUrl') as dead_letter_queue_url, - json_extract_path_text(Properties, 'DefaultEncryptionKey') as default_encryption_key, - json_extract_path_text(Properties, 'DefaultExpirationDays') as default_expiration_days, - json_extract_path_text(Properties, 'Matching') as matching, - json_extract_path_text(Properties, 'RuleBasedMatching') as rule_based_matching, - json_extract_path_text(Properties, 'Stats') as stats, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'CreatedAt') as created_at, - json_extract_path_text(Properties, 'LastUpdatedAt') as last_updated_at - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CustomerProfiles::Domain' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.DomainName') as domain_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CustomerProfiles::Domain' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DomainName') as domain_name, + json_extract_path_text(Properties, 'DeadLetterQueueUrl') as dead_letter_queue_url, + json_extract_path_text(Properties, 'DefaultEncryptionKey') as default_encryption_key, + json_extract_path_text(Properties, 'DefaultExpirationDays') as default_expiration_days, + json_extract_path_text(Properties, 'Matching') as matching, + json_extract_path_text(Properties, 'RuleBasedMatching') as rule_based_matching, + json_extract_path_text(Properties, 'Stats') as stats, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'LastUpdatedAt') as last_updated_at + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CustomerProfiles::Domain' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DomainName') as domain_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CustomerProfiles::Domain' + AND region = 'us-east-1' event_streams: name: event_streams id: aws.customerprofiles.event_streams @@ -2324,7 +2299,7 @@ components: x-identifiers: - DomainName - EventStreamName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2341,9 +2316,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2353,44 +2328,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/event_streams/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/event_streams/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.DomainName') as domain_name, - JSON_EXTRACT(Properties, '$.EventStreamName') as event_stream_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CustomerProfiles::EventStream' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'DomainName') as domain_name, - json_extract_path_text(Properties, 'EventStreamName') as event_stream_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CustomerProfiles::EventStream' - AND region = 'us-east-1' - event_stream: - name: event_stream - id: aws.customerprofiles.event_stream - x-cfn-schema-name: EventStream - x-cfn-type-name: AWS::CustomerProfiles::EventStream - x-identifiers: - - DomainName - - EventStreamName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2401,12 +2341,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/event_streams/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/event_streams/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/event_stream/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/event_streams/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2423,22 +2367,40 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'DomainName') as domain_name, - json_extract_path_text(Properties, 'EventStreamName') as event_stream_name, - json_extract_path_text(Properties, 'Uri') as uri, - json_extract_path_text(Properties, 'EventStreamArn') as event_stream_arn, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'CreatedAt') as created_at, - json_extract_path_text(Properties, 'State') as state, - json_extract_path_text(Properties, 'DestinationDetails') as destination_details - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CustomerProfiles::EventStream' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.DomainName') as domain_name, + JSON_EXTRACT(Properties, '$.EventStreamName') as event_stream_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CustomerProfiles::EventStream' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DomainName') as domain_name, + json_extract_path_text(Properties, 'EventStreamName') as event_stream_name, + json_extract_path_text(Properties, 'Uri') as uri, + json_extract_path_text(Properties, 'EventStreamArn') as event_stream_arn, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'DestinationDetails') as destination_details + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CustomerProfiles::EventStream' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DomainName') as domain_name, + json_extract_path_text(Properties, 'EventStreamName') as event_stream_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CustomerProfiles::EventStream' + AND region = 'us-east-1' integrations: name: integrations id: aws.customerprofiles.integrations @@ -2447,7 +2409,7 @@ components: x-identifiers: - DomainName - Uri - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2464,9 +2426,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2476,44 +2438,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/integrations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/integrations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.DomainName') as domain_name, - JSON_EXTRACT(Properties, '$.Uri') as uri - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CustomerProfiles::Integration' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'DomainName') as domain_name, - json_extract_path_text(Properties, 'Uri') as uri - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CustomerProfiles::Integration' - AND region = 'us-east-1' - integration: - name: integration - id: aws.customerprofiles.integration - x-cfn-schema-name: Integration - x-cfn-type-name: AWS::CustomerProfiles::Integration - x-identifiers: - - DomainName - - Uri - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2524,12 +2451,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/integrations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/integrations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/integration/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/integrations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2546,22 +2477,40 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'DomainName') as domain_name, - json_extract_path_text(Properties, 'Uri') as uri, - json_extract_path_text(Properties, 'FlowDefinition') as flow_definition, - json_extract_path_text(Properties, 'ObjectTypeName') as object_type_name, - json_extract_path_text(Properties, 'CreatedAt') as created_at, - json_extract_path_text(Properties, 'LastUpdatedAt') as last_updated_at, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'ObjectTypeNames') as object_type_names - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CustomerProfiles::Integration' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.DomainName') as domain_name, + JSON_EXTRACT(Properties, '$.Uri') as uri + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CustomerProfiles::Integration' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DomainName') as domain_name, + json_extract_path_text(Properties, 'Uri') as uri, + json_extract_path_text(Properties, 'FlowDefinition') as flow_definition, + json_extract_path_text(Properties, 'ObjectTypeName') as object_type_name, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'LastUpdatedAt') as last_updated_at, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'ObjectTypeNames') as object_type_names + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CustomerProfiles::Integration' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DomainName') as domain_name, + json_extract_path_text(Properties, 'Uri') as uri + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CustomerProfiles::Integration' + AND region = 'us-east-1' object_types: name: object_types id: aws.customerprofiles.object_types @@ -2570,7 +2519,7 @@ components: x-identifiers: - DomainName - ObjectTypeName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2587,9 +2536,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2599,44 +2548,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/object_types/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/object_types/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.DomainName') as domain_name, - JSON_EXTRACT(Properties, '$.ObjectTypeName') as object_type_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CustomerProfiles::ObjectType' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'DomainName') as domain_name, - json_extract_path_text(Properties, 'ObjectTypeName') as object_type_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CustomerProfiles::ObjectType' - AND region = 'us-east-1' - object_type: - name: object_type - id: aws.customerprofiles.object_type - x-cfn-schema-name: ObjectType - x-cfn-type-name: AWS::CustomerProfiles::ObjectType - x-identifiers: - - DomainName - - ObjectTypeName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2647,12 +2561,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/object_types/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/object_types/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/object_type/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/object_types/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2674,27 +2592,45 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'DomainName') as domain_name, - json_extract_path_text(Properties, 'ObjectTypeName') as object_type_name, - json_extract_path_text(Properties, 'AllowProfileCreation') as allow_profile_creation, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'EncryptionKey') as encryption_key, - json_extract_path_text(Properties, 'ExpirationDays') as expiration_days, - json_extract_path_text(Properties, 'Fields') as fields, - json_extract_path_text(Properties, 'Keys') as keys, - json_extract_path_text(Properties, 'CreatedAt') as created_at, - json_extract_path_text(Properties, 'LastUpdatedAt') as last_updated_at, - json_extract_path_text(Properties, 'SourceLastUpdatedTimestampFormat') as source_last_updated_timestamp_format, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'TemplateId') as template_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CustomerProfiles::ObjectType' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.DomainName') as domain_name, + JSON_EXTRACT(Properties, '$.ObjectTypeName') as object_type_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CustomerProfiles::ObjectType' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DomainName') as domain_name, + json_extract_path_text(Properties, 'ObjectTypeName') as object_type_name, + json_extract_path_text(Properties, 'AllowProfileCreation') as allow_profile_creation, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'EncryptionKey') as encryption_key, + json_extract_path_text(Properties, 'ExpirationDays') as expiration_days, + json_extract_path_text(Properties, 'Fields') as fields, + json_extract_path_text(Properties, 'Keys') as keys, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'LastUpdatedAt') as last_updated_at, + json_extract_path_text(Properties, 'SourceLastUpdatedTimestampFormat') as source_last_updated_timestamp_format, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'TemplateId') as template_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::CustomerProfiles::ObjectType' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DomainName') as domain_name, + json_extract_path_text(Properties, 'ObjectTypeName') as object_type_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CustomerProfiles::ObjectType' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/databrew.yaml b/providers/src/aws/v00.00.00000/services/databrew.yaml index b6f383a5..930da6e9 100644 --- a/providers/src/aws/v00.00.00000/services/databrew.yaml +++ b/providers/src/aws/v00.00.00000/services/databrew.yaml @@ -2122,7 +2122,7 @@ components: x-cfn-type-name: AWS::DataBrew::Dataset x-identifiers: - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2139,9 +2139,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2151,41 +2151,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/datasets/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/datasets/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataBrew::Dataset' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataBrew::Dataset' - AND region = 'us-east-1' - dataset: - name: dataset - id: aws.databrew.dataset - x-cfn-schema-name: Dataset - x-cfn-type-name: AWS::DataBrew::Dataset - x-identifiers: - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2196,12 +2164,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/datasets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/datasets/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/dataset/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/datasets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2216,20 +2188,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Format') as _format, - json_extract_path_text(Properties, 'FormatOptions') as format_options, - json_extract_path_text(Properties, 'Input') as input, - json_extract_path_text(Properties, 'PathOptions') as path_options, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataBrew::Dataset' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataBrew::Dataset' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Format') as _format, + json_extract_path_text(Properties, 'FormatOptions') as format_options, + json_extract_path_text(Properties, 'Input') as input, + json_extract_path_text(Properties, 'PathOptions') as path_options, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataBrew::Dataset' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataBrew::Dataset' + AND region = 'us-east-1' recipes: name: recipes id: aws.databrew.recipes @@ -2237,7 +2225,7 @@ components: x-cfn-type-name: AWS::DataBrew::Recipe x-identifiers: - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2254,9 +2242,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2266,41 +2254,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/recipes/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/recipes/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataBrew::Recipe' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataBrew::Recipe' - AND region = 'us-east-1' - recipe: - name: recipe - id: aws.databrew.recipe - x-cfn-schema-name: Recipe - x-cfn-type-name: AWS::DataBrew::Recipe - x-identifiers: - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2311,12 +2267,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/recipes/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/recipes/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/recipe/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/recipes/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2329,18 +2289,34 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Steps') as steps, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataBrew::Recipe' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataBrew::Recipe' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Steps') as steps, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataBrew::Recipe' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataBrew::Recipe' + AND region = 'us-east-1' jobs: name: jobs id: aws.databrew.jobs @@ -2348,7 +2324,7 @@ components: x-cfn-type-name: AWS::DataBrew::Job x-identifiers: - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2365,9 +2341,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2377,41 +2353,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/jobs/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/jobs/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataBrew::Job' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataBrew::Job' - AND region = 'us-east-1' - job: - name: job - id: aws.databrew.job - x-cfn-schema-name: Job - x-cfn-type-name: AWS::DataBrew::Job - x-identifiers: - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2422,12 +2366,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/jobs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/jobs/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/job/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/jobs/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2456,34 +2404,50 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'DatasetName') as dataset_name, - json_extract_path_text(Properties, 'EncryptionKeyArn') as encryption_key_arn, - json_extract_path_text(Properties, 'EncryptionMode') as encryption_mode, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Type') as type, - json_extract_path_text(Properties, 'LogSubscription') as log_subscription, - json_extract_path_text(Properties, 'MaxCapacity') as max_capacity, - json_extract_path_text(Properties, 'MaxRetries') as max_retries, - json_extract_path_text(Properties, 'Outputs') as outputs, - json_extract_path_text(Properties, 'DataCatalogOutputs') as data_catalog_outputs, - json_extract_path_text(Properties, 'DatabaseOutputs') as database_outputs, - json_extract_path_text(Properties, 'OutputLocation') as output_location, - json_extract_path_text(Properties, 'ProjectName') as project_name, - json_extract_path_text(Properties, 'Recipe') as recipe, - json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Timeout') as timeout, - json_extract_path_text(Properties, 'JobSample') as job_sample, - json_extract_path_text(Properties, 'ProfileConfiguration') as profile_configuration, - json_extract_path_text(Properties, 'ValidationConfigurations') as validation_configurations - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataBrew::Job' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataBrew::Job' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DatasetName') as dataset_name, + json_extract_path_text(Properties, 'EncryptionKeyArn') as encryption_key_arn, + json_extract_path_text(Properties, 'EncryptionMode') as encryption_mode, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'LogSubscription') as log_subscription, + json_extract_path_text(Properties, 'MaxCapacity') as max_capacity, + json_extract_path_text(Properties, 'MaxRetries') as max_retries, + json_extract_path_text(Properties, 'Outputs') as outputs, + json_extract_path_text(Properties, 'DataCatalogOutputs') as data_catalog_outputs, + json_extract_path_text(Properties, 'DatabaseOutputs') as database_outputs, + json_extract_path_text(Properties, 'OutputLocation') as output_location, + json_extract_path_text(Properties, 'ProjectName') as project_name, + json_extract_path_text(Properties, 'Recipe') as recipe, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Timeout') as timeout, + json_extract_path_text(Properties, 'JobSample') as job_sample, + json_extract_path_text(Properties, 'ProfileConfiguration') as profile_configuration, + json_extract_path_text(Properties, 'ValidationConfigurations') as validation_configurations + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataBrew::Job' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataBrew::Job' + AND region = 'us-east-1' projects: name: projects id: aws.databrew.projects @@ -2491,7 +2455,7 @@ components: x-cfn-type-name: AWS::DataBrew::Project x-identifiers: - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2508,9 +2472,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2520,41 +2484,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/projects/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/projects/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataBrew::Project' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataBrew::Project' - AND region = 'us-east-1' - project: - name: project - id: aws.databrew.project - x-cfn-schema-name: Project - x-cfn-type-name: AWS::DataBrew::Project - x-identifiers: - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2565,12 +2497,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/projects/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/projects/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/project/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/projects/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2585,20 +2521,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'DatasetName') as dataset_name, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'RecipeName') as recipe_name, - json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'Sample') as sample, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataBrew::Project' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataBrew::Project' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DatasetName') as dataset_name, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'RecipeName') as recipe_name, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'Sample') as sample, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataBrew::Project' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataBrew::Project' + AND region = 'us-east-1' rulesets: name: rulesets id: aws.databrew.rulesets @@ -2606,7 +2558,7 @@ components: x-cfn-type-name: AWS::DataBrew::Ruleset x-identifiers: - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2623,9 +2575,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2635,41 +2587,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/rulesets/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/rulesets/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataBrew::Ruleset' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataBrew::Ruleset' - AND region = 'us-east-1' - ruleset: - name: ruleset - id: aws.databrew.ruleset - x-cfn-schema-name: Ruleset - x-cfn-type-name: AWS::DataBrew::Ruleset - x-identifiers: - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2680,12 +2600,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/rulesets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/rulesets/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/ruleset/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/rulesets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2699,19 +2623,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'TargetArn') as target_arn, - json_extract_path_text(Properties, 'Rules') as rules, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataBrew::Ruleset' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataBrew::Ruleset' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'TargetArn') as target_arn, + json_extract_path_text(Properties, 'Rules') as rules, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataBrew::Ruleset' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataBrew::Ruleset' + AND region = 'us-east-1' schedules: name: schedules id: aws.databrew.schedules @@ -2719,7 +2659,7 @@ components: x-cfn-type-name: AWS::DataBrew::Schedule x-identifiers: - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2736,9 +2676,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2748,41 +2688,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/schedules/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/schedules/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataBrew::Schedule' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataBrew::Schedule' - AND region = 'us-east-1' - schedule: - name: schedule - id: aws.databrew.schedule - x-cfn-schema-name: Schedule - x-cfn-type-name: AWS::DataBrew::Schedule - x-identifiers: - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2793,12 +2701,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/schedules/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/schedules/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/schedule/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/schedules/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2811,18 +2723,34 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'JobNames') as job_names, - json_extract_path_text(Properties, 'CronExpression') as cron_expression, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataBrew::Schedule' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataBrew::Schedule' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'JobNames') as job_names, + json_extract_path_text(Properties, 'CronExpression') as cron_expression, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataBrew::Schedule' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataBrew::Schedule' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/datapipeline.yaml b/providers/src/aws/v00.00.00000/services/datapipeline.yaml index f9c348c2..447923f4 100644 --- a/providers/src/aws/v00.00.00000/services/datapipeline.yaml +++ b/providers/src/aws/v00.00.00000/services/datapipeline.yaml @@ -642,7 +642,7 @@ components: x-cfn-type-name: AWS::DataPipeline::Pipeline x-identifiers: - PipelineId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -659,9 +659,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -671,41 +671,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/pipelines/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/pipelines/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.PipelineId') as pipeline_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataPipeline::Pipeline' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'PipelineId') as pipeline_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataPipeline::Pipeline' - AND region = 'us-east-1' - pipeline: - name: pipeline - id: aws.datapipeline.pipeline - x-cfn-schema-name: Pipeline - x-cfn-type-name: AWS::DataPipeline::Pipeline - x-identifiers: - - PipelineId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -716,12 +684,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/pipelines/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/pipelines/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/pipeline/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/pipelines/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -738,22 +710,38 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Activate') as activate, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'ParameterObjects') as parameter_objects, - json_extract_path_text(Properties, 'ParameterValues') as parameter_values, - json_extract_path_text(Properties, 'PipelineObjects') as pipeline_objects, - json_extract_path_text(Properties, 'PipelineTags') as pipeline_tags, - json_extract_path_text(Properties, 'PipelineId') as pipeline_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataPipeline::Pipeline' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.PipelineId') as pipeline_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataPipeline::Pipeline' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Activate') as activate, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'ParameterObjects') as parameter_objects, + json_extract_path_text(Properties, 'ParameterValues') as parameter_values, + json_extract_path_text(Properties, 'PipelineObjects') as pipeline_objects, + json_extract_path_text(Properties, 'PipelineTags') as pipeline_tags, + json_extract_path_text(Properties, 'PipelineId') as pipeline_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataPipeline::Pipeline' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'PipelineId') as pipeline_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataPipeline::Pipeline' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/datasync.yaml b/providers/src/aws/v00.00.00000/services/datasync.yaml index 76d0d104..e48b391a 100644 --- a/providers/src/aws/v00.00.00000/services/datasync.yaml +++ b/providers/src/aws/v00.00.00000/services/datasync.yaml @@ -2145,8 +2145,12 @@ components: type: string maxLength: 256 pattern: ^[a-zA-Z0-9\ \_\*\?\,\|\^\-\/\#\s\(\)\+]*$ - required: - - ScheduleExpression + Status: + description: Specifies status of a schedule. + type: string + enum: + - ENABLED + - DISABLED Options: additionalProperties: false description: Represents the options that are available to control the behavior of a StartTaskExecution operation. @@ -3409,7 +3413,7 @@ components: x-cfn-type-name: AWS::DataSync::Agent x-identifiers: - AgentArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3426,9 +3430,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3438,41 +3442,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/agents/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/agents/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AgentArn') as agent_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::Agent' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AgentArn') as agent_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::Agent' - AND region = 'us-east-1' - agent: - name: agent - id: aws.datasync.agent - x-cfn-schema-name: Agent - x-cfn-type-name: AWS::DataSync::Agent - x-identifiers: - - AgentArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3483,12 +3455,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/agents/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/agents/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/agent/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/agents/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3505,22 +3481,38 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AgentName') as agent_name, - json_extract_path_text(Properties, 'ActivationKey') as activation_key, - json_extract_path_text(Properties, 'SecurityGroupArns') as security_group_arns, - json_extract_path_text(Properties, 'SubnetArns') as subnet_arns, - json_extract_path_text(Properties, 'VpcEndpointId') as vpc_endpoint_id, - json_extract_path_text(Properties, 'EndpointType') as endpoint_type, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'AgentArn') as agent_arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataSync::Agent' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.AgentArn') as agent_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::Agent' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AgentName') as agent_name, + json_extract_path_text(Properties, 'ActivationKey') as activation_key, + json_extract_path_text(Properties, 'SecurityGroupArns') as security_group_arns, + json_extract_path_text(Properties, 'SubnetArns') as subnet_arns, + json_extract_path_text(Properties, 'VpcEndpointId') as vpc_endpoint_id, + json_extract_path_text(Properties, 'EndpointType') as endpoint_type, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'AgentArn') as agent_arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataSync::Agent' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AgentArn') as agent_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::Agent' + AND region = 'us-east-1' location_azure_blobs: name: location_azure_blobs id: aws.datasync.location_azure_blobs @@ -3528,7 +3520,7 @@ components: x-cfn-type-name: AWS::DataSync::LocationAzureBlob x-identifiers: - LocationArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3545,9 +3537,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3557,41 +3549,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/location_azure_blobs/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/location_azure_blobs/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.LocationArn') as location_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationAzureBlob' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'LocationArn') as location_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationAzureBlob' - AND region = 'us-east-1' - location_azure_blob: - name: location_azure_blob - id: aws.datasync.location_azure_blob - x-cfn-schema-name: LocationAzureBlob - x-cfn-type-name: AWS::DataSync::LocationAzureBlob - x-identifiers: - - LocationArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3602,12 +3562,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/location_azure_blobs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/location_azure_blobs/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/location_azure_blob/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/location_azure_blobs/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3626,24 +3590,40 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AgentArns') as agent_arns, - json_extract_path_text(Properties, 'AzureBlobAuthenticationType') as azure_blob_authentication_type, - json_extract_path_text(Properties, 'AzureBlobSasConfiguration') as azure_blob_sas_configuration, - json_extract_path_text(Properties, 'AzureBlobContainerUrl') as azure_blob_container_url, - json_extract_path_text(Properties, 'AzureBlobType') as azure_blob_type, - json_extract_path_text(Properties, 'AzureAccessTier') as azure_access_tier, - json_extract_path_text(Properties, 'Subdirectory') as subdirectory, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'LocationArn') as location_arn, - json_extract_path_text(Properties, 'LocationUri') as location_uri - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataSync::LocationAzureBlob' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.LocationArn') as location_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationAzureBlob' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AgentArns') as agent_arns, + json_extract_path_text(Properties, 'AzureBlobAuthenticationType') as azure_blob_authentication_type, + json_extract_path_text(Properties, 'AzureBlobSasConfiguration') as azure_blob_sas_configuration, + json_extract_path_text(Properties, 'AzureBlobContainerUrl') as azure_blob_container_url, + json_extract_path_text(Properties, 'AzureBlobType') as azure_blob_type, + json_extract_path_text(Properties, 'AzureAccessTier') as azure_access_tier, + json_extract_path_text(Properties, 'Subdirectory') as subdirectory, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'LocationArn') as location_arn, + json_extract_path_text(Properties, 'LocationUri') as location_uri + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataSync::LocationAzureBlob' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'LocationArn') as location_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationAzureBlob' + AND region = 'us-east-1' location_efs: name: location_efs id: aws.datasync.location_efs @@ -3651,8 +3631,23 @@ components: x-cfn-type-name: AWS::DataSync::LocationEFS x-identifiers: - LocationArn - x-type: get + x-type: cloud_control methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__LocationEFS&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataSync::LocationEFS" + } + response: + mediaType: application/json + openAPIDocKey: '200' update_resource: operation: $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' @@ -3665,13 +3660,29 @@ components: response: mediaType: application/json openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataSync::LocationEFS" + } + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/location_efs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/location_efs/methods/delete_resource' update: - $ref: '#/components/x-stackQL-resources/location_efs/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3689,23 +3700,39 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Ec2Config') as ec2_config, - json_extract_path_text(Properties, 'EfsFilesystemArn') as efs_filesystem_arn, - json_extract_path_text(Properties, 'AccessPointArn') as access_point_arn, - json_extract_path_text(Properties, 'FileSystemAccessRoleArn') as file_system_access_role_arn, - json_extract_path_text(Properties, 'InTransitEncryption') as in_transit_encryption, - json_extract_path_text(Properties, 'Subdirectory') as subdirectory, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'LocationArn') as location_arn, - json_extract_path_text(Properties, 'LocationUri') as location_uri - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataSync::LocationEFS' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.LocationArn') as location_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationEFS' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Ec2Config') as ec2_config, + json_extract_path_text(Properties, 'EfsFilesystemArn') as efs_filesystem_arn, + json_extract_path_text(Properties, 'AccessPointArn') as access_point_arn, + json_extract_path_text(Properties, 'FileSystemAccessRoleArn') as file_system_access_role_arn, + json_extract_path_text(Properties, 'InTransitEncryption') as in_transit_encryption, + json_extract_path_text(Properties, 'Subdirectory') as subdirectory, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'LocationArn') as location_arn, + json_extract_path_text(Properties, 'LocationUri') as location_uri + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataSync::LocationEFS' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'LocationArn') as location_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationEFS' + AND region = 'us-east-1' locationf_sx_lustres: name: locationf_sx_lustres id: aws.datasync.locationf_sx_lustres @@ -3713,7 +3740,7 @@ components: x-cfn-type-name: AWS::DataSync::LocationFSxLustre x-identifiers: - LocationArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3730,9 +3757,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3742,41 +3769,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/locationf_sx_lustres/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/locationf_sx_lustres/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.LocationArn') as location_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationFSxLustre' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'LocationArn') as location_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationFSxLustre' - AND region = 'us-east-1' - locationf_sx_lustre: - name: locationf_sx_lustre - id: aws.datasync.locationf_sx_lustre - x-cfn-schema-name: LocationFSxLustre - x-cfn-type-name: AWS::DataSync::LocationFSxLustre - x-identifiers: - - LocationArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3787,12 +3782,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/locationf_sx_lustres/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/locationf_sx_lustres/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/locationf_sx_lustre/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/locationf_sx_lustres/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3807,20 +3806,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'FsxFilesystemArn') as fsx_filesystem_arn, - json_extract_path_text(Properties, 'SecurityGroupArns') as security_group_arns, - json_extract_path_text(Properties, 'Subdirectory') as subdirectory, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'LocationArn') as location_arn, - json_extract_path_text(Properties, 'LocationUri') as location_uri - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataSync::LocationFSxLustre' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.LocationArn') as location_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationFSxLustre' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'FsxFilesystemArn') as fsx_filesystem_arn, + json_extract_path_text(Properties, 'SecurityGroupArns') as security_group_arns, + json_extract_path_text(Properties, 'Subdirectory') as subdirectory, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'LocationArn') as location_arn, + json_extract_path_text(Properties, 'LocationUri') as location_uri + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataSync::LocationFSxLustre' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'LocationArn') as location_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationFSxLustre' + AND region = 'us-east-1' locationf_sx_ontaps: name: locationf_sx_ontaps id: aws.datasync.locationf_sx_ontaps @@ -3828,7 +3843,7 @@ components: x-cfn-type-name: AWS::DataSync::LocationFSxONTAP x-identifiers: - LocationArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3845,9 +3860,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3857,41 +3872,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/locationf_sx_ontaps/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/locationf_sx_ontaps/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.LocationArn') as location_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationFSxONTAP' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'LocationArn') as location_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationFSxONTAP' - AND region = 'us-east-1' - locationf_sx_ontap: - name: locationf_sx_ontap - id: aws.datasync.locationf_sx_ontap - x-cfn-schema-name: LocationFSxONTAP - x-cfn-type-name: AWS::DataSync::LocationFSxONTAP - x-identifiers: - - LocationArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3902,12 +3885,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/locationf_sx_ontaps/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/locationf_sx_ontaps/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/locationf_sx_ontap/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/locationf_sx_ontaps/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3924,22 +3911,38 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'StorageVirtualMachineArn') as storage_virtual_machine_arn, - json_extract_path_text(Properties, 'FsxFilesystemArn') as fsx_filesystem_arn, - json_extract_path_text(Properties, 'SecurityGroupArns') as security_group_arns, - json_extract_path_text(Properties, 'Protocol') as protocol, - json_extract_path_text(Properties, 'Subdirectory') as subdirectory, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'LocationArn') as location_arn, - json_extract_path_text(Properties, 'LocationUri') as location_uri - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataSync::LocationFSxONTAP' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.LocationArn') as location_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationFSxONTAP' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'StorageVirtualMachineArn') as storage_virtual_machine_arn, + json_extract_path_text(Properties, 'FsxFilesystemArn') as fsx_filesystem_arn, + json_extract_path_text(Properties, 'SecurityGroupArns') as security_group_arns, + json_extract_path_text(Properties, 'Protocol') as protocol, + json_extract_path_text(Properties, 'Subdirectory') as subdirectory, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'LocationArn') as location_arn, + json_extract_path_text(Properties, 'LocationUri') as location_uri + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataSync::LocationFSxONTAP' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'LocationArn') as location_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationFSxONTAP' + AND region = 'us-east-1' locationf_sx_open_zfs: name: locationf_sx_open_zfs id: aws.datasync.locationf_sx_open_zfs @@ -3947,8 +3950,23 @@ components: x-cfn-type-name: AWS::DataSync::LocationFSxOpenZFS x-identifiers: - LocationArn - x-type: get + x-type: cloud_control methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__LocationFSxOpenZFS&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataSync::LocationFSxOpenZFS" + } + response: + mediaType: application/json + openAPIDocKey: '200' update_resource: operation: $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' @@ -3961,13 +3979,29 @@ components: response: mediaType: application/json openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataSync::LocationFSxOpenZFS" + } + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/locationf_sx_open_zfs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/locationf_sx_open_zfs/methods/delete_resource' update: - $ref: '#/components/x-stackQL-resources/locationf_sx_open_zfs/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3983,21 +4017,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'FsxFilesystemArn') as fsx_filesystem_arn, - json_extract_path_text(Properties, 'SecurityGroupArns') as security_group_arns, - json_extract_path_text(Properties, 'Protocol') as protocol, - json_extract_path_text(Properties, 'Subdirectory') as subdirectory, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'LocationArn') as location_arn, - json_extract_path_text(Properties, 'LocationUri') as location_uri - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataSync::LocationFSxOpenZFS' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.LocationArn') as location_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationFSxOpenZFS' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'FsxFilesystemArn') as fsx_filesystem_arn, + json_extract_path_text(Properties, 'SecurityGroupArns') as security_group_arns, + json_extract_path_text(Properties, 'Protocol') as protocol, + json_extract_path_text(Properties, 'Subdirectory') as subdirectory, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'LocationArn') as location_arn, + json_extract_path_text(Properties, 'LocationUri') as location_uri + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataSync::LocationFSxOpenZFS' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'LocationArn') as location_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationFSxOpenZFS' + AND region = 'us-east-1' locationf_sx_windows: name: locationf_sx_windows id: aws.datasync.locationf_sx_windows @@ -4005,8 +4055,23 @@ components: x-cfn-type-name: AWS::DataSync::LocationFSxWindows x-identifiers: - LocationArn - x-type: get + x-type: cloud_control methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__LocationFSxWindows&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataSync::LocationFSxWindows" + } + response: + mediaType: application/json + openAPIDocKey: '200' update_resource: operation: $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' @@ -4019,13 +4084,29 @@ components: response: mediaType: application/json openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataSync::LocationFSxWindows" + } + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/locationf_sx_windows/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/locationf_sx_windows/methods/delete_resource' update: - $ref: '#/components/x-stackQL-resources/locationf_sx_windows/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -4043,23 +4124,39 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Domain') as domain, - json_extract_path_text(Properties, 'FsxFilesystemArn') as fsx_filesystem_arn, - json_extract_path_text(Properties, 'Password') as password, - json_extract_path_text(Properties, 'SecurityGroupArns') as security_group_arns, - json_extract_path_text(Properties, 'Subdirectory') as subdirectory, - json_extract_path_text(Properties, 'User') as user, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'LocationArn') as location_arn, - json_extract_path_text(Properties, 'LocationUri') as location_uri - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataSync::LocationFSxWindows' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.LocationArn') as location_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationFSxWindows' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Domain') as domain, + json_extract_path_text(Properties, 'FsxFilesystemArn') as fsx_filesystem_arn, + json_extract_path_text(Properties, 'Password') as password, + json_extract_path_text(Properties, 'SecurityGroupArns') as security_group_arns, + json_extract_path_text(Properties, 'Subdirectory') as subdirectory, + json_extract_path_text(Properties, 'User') as user, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'LocationArn') as location_arn, + json_extract_path_text(Properties, 'LocationUri') as location_uri + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataSync::LocationFSxWindows' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'LocationArn') as location_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationFSxWindows' + AND region = 'us-east-1' location_hdfs: name: location_hdfs id: aws.datasync.location_hdfs @@ -4067,8 +4164,23 @@ components: x-cfn-type-name: AWS::DataSync::LocationHDFS x-identifiers: - LocationArn - x-type: get + x-type: cloud_control methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__LocationHDFS&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataSync::LocationHDFS" + } + response: + mediaType: application/json + openAPIDocKey: '200' update_resource: operation: $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' @@ -4081,13 +4193,29 @@ components: response: mediaType: application/json openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataSync::LocationHDFS" + } + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/location_hdfs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/location_hdfs/methods/delete_resource' update: - $ref: '#/components/x-stackQL-resources/location_hdfs/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -4111,29 +4239,45 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'NameNodes') as name_nodes, - json_extract_path_text(Properties, 'BlockSize') as block_size, - json_extract_path_text(Properties, 'ReplicationFactor') as replication_factor, - json_extract_path_text(Properties, 'KmsKeyProviderUri') as kms_key_provider_uri, - json_extract_path_text(Properties, 'QopConfiguration') as qop_configuration, - json_extract_path_text(Properties, 'AuthenticationType') as authentication_type, - json_extract_path_text(Properties, 'SimpleUser') as simple_user, - json_extract_path_text(Properties, 'KerberosPrincipal') as kerberos_principal, - json_extract_path_text(Properties, 'KerberosKeytab') as kerberos_keytab, - json_extract_path_text(Properties, 'KerberosKrb5Conf') as kerberos_krb5_conf, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'AgentArns') as agent_arns, - json_extract_path_text(Properties, 'Subdirectory') as subdirectory, - json_extract_path_text(Properties, 'LocationArn') as location_arn, - json_extract_path_text(Properties, 'LocationUri') as location_uri - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataSync::LocationHDFS' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.LocationArn') as location_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationHDFS' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'NameNodes') as name_nodes, + json_extract_path_text(Properties, 'BlockSize') as block_size, + json_extract_path_text(Properties, 'ReplicationFactor') as replication_factor, + json_extract_path_text(Properties, 'KmsKeyProviderUri') as kms_key_provider_uri, + json_extract_path_text(Properties, 'QopConfiguration') as qop_configuration, + json_extract_path_text(Properties, 'AuthenticationType') as authentication_type, + json_extract_path_text(Properties, 'SimpleUser') as simple_user, + json_extract_path_text(Properties, 'KerberosPrincipal') as kerberos_principal, + json_extract_path_text(Properties, 'KerberosKeytab') as kerberos_keytab, + json_extract_path_text(Properties, 'KerberosKrb5Conf') as kerberos_krb5_conf, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'AgentArns') as agent_arns, + json_extract_path_text(Properties, 'Subdirectory') as subdirectory, + json_extract_path_text(Properties, 'LocationArn') as location_arn, + json_extract_path_text(Properties, 'LocationUri') as location_uri + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataSync::LocationHDFS' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'LocationArn') as location_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationHDFS' + AND region = 'us-east-1' location_nfs: name: location_nfs id: aws.datasync.location_nfs @@ -4141,8 +4285,23 @@ components: x-cfn-type-name: AWS::DataSync::LocationNFS x-identifiers: - LocationArn - x-type: get + x-type: cloud_control methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__LocationNFS&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataSync::LocationNFS" + } + response: + mediaType: application/json + openAPIDocKey: '200' update_resource: operation: $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' @@ -4155,13 +4314,29 @@ components: response: mediaType: application/json openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataSync::LocationNFS" + } + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/location_nfs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/location_nfs/methods/delete_resource' update: - $ref: '#/components/x-stackQL-resources/location_nfs/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -4177,21 +4352,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'MountOptions') as mount_options, - json_extract_path_text(Properties, 'OnPremConfig') as on_prem_config, - json_extract_path_text(Properties, 'ServerHostname') as server_hostname, - json_extract_path_text(Properties, 'Subdirectory') as subdirectory, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'LocationArn') as location_arn, - json_extract_path_text(Properties, 'LocationUri') as location_uri - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataSync::LocationNFS' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.LocationArn') as location_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationNFS' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'MountOptions') as mount_options, + json_extract_path_text(Properties, 'OnPremConfig') as on_prem_config, + json_extract_path_text(Properties, 'ServerHostname') as server_hostname, + json_extract_path_text(Properties, 'Subdirectory') as subdirectory, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'LocationArn') as location_arn, + json_extract_path_text(Properties, 'LocationUri') as location_uri + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataSync::LocationNFS' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'LocationArn') as location_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationNFS' + AND region = 'us-east-1' location_object_storages: name: location_object_storages id: aws.datasync.location_object_storages @@ -4199,7 +4390,7 @@ components: x-cfn-type-name: AWS::DataSync::LocationObjectStorage x-identifiers: - LocationArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -4216,9 +4407,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -4228,41 +4419,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/location_object_storages/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/location_object_storages/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.LocationArn') as location_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationObjectStorage' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'LocationArn') as location_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationObjectStorage' - AND region = 'us-east-1' - location_object_storage: - name: location_object_storage - id: aws.datasync.location_object_storage - x-cfn-schema-name: LocationObjectStorage - x-cfn-type-name: AWS::DataSync::LocationObjectStorage - x-identifiers: - - LocationArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -4273,12 +4432,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/location_object_storages/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/location_object_storages/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/location_object_storage/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/location_object_storages/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -4299,26 +4462,42 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AccessKey') as access_key, - json_extract_path_text(Properties, 'AgentArns') as agent_arns, - json_extract_path_text(Properties, 'BucketName') as bucket_name, - json_extract_path_text(Properties, 'SecretKey') as secret_key, - json_extract_path_text(Properties, 'ServerCertificate') as server_certificate, - json_extract_path_text(Properties, 'ServerHostname') as server_hostname, - json_extract_path_text(Properties, 'ServerPort') as server_port, - json_extract_path_text(Properties, 'ServerProtocol') as server_protocol, - json_extract_path_text(Properties, 'Subdirectory') as subdirectory, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'LocationArn') as location_arn, - json_extract_path_text(Properties, 'LocationUri') as location_uri - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataSync::LocationObjectStorage' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.LocationArn') as location_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationObjectStorage' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AccessKey') as access_key, + json_extract_path_text(Properties, 'AgentArns') as agent_arns, + json_extract_path_text(Properties, 'BucketName') as bucket_name, + json_extract_path_text(Properties, 'SecretKey') as secret_key, + json_extract_path_text(Properties, 'ServerCertificate') as server_certificate, + json_extract_path_text(Properties, 'ServerHostname') as server_hostname, + json_extract_path_text(Properties, 'ServerPort') as server_port, + json_extract_path_text(Properties, 'ServerProtocol') as server_protocol, + json_extract_path_text(Properties, 'Subdirectory') as subdirectory, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'LocationArn') as location_arn, + json_extract_path_text(Properties, 'LocationUri') as location_uri + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataSync::LocationObjectStorage' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'LocationArn') as location_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationObjectStorage' + AND region = 'us-east-1' location_s3s: name: location_s3s id: aws.datasync.location_s3s @@ -4326,7 +4505,7 @@ components: x-cfn-type-name: AWS::DataSync::LocationS3 x-identifiers: - LocationArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -4343,9 +4522,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -4355,41 +4534,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/location_s3s/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/location_s3s/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.LocationArn') as location_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationS3' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'LocationArn') as location_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationS3' - AND region = 'us-east-1' - location_s3: - name: location_s3 - id: aws.datasync.location_s3 - x-cfn-schema-name: LocationS3 - x-cfn-type-name: AWS::DataSync::LocationS3 - x-identifiers: - - LocationArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -4400,12 +4547,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/location_s3s/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/location_s3s/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/location_s3/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/location_s3s/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -4421,21 +4572,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'S3Config') as s3_config, - json_extract_path_text(Properties, 'S3BucketArn') as s3_bucket_arn, - json_extract_path_text(Properties, 'Subdirectory') as subdirectory, - json_extract_path_text(Properties, 'S3StorageClass') as s3_storage_class, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'LocationArn') as location_arn, - json_extract_path_text(Properties, 'LocationUri') as location_uri - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataSync::LocationS3' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.LocationArn') as location_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationS3' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'S3Config') as s3_config, + json_extract_path_text(Properties, 'S3BucketArn') as s3_bucket_arn, + json_extract_path_text(Properties, 'Subdirectory') as subdirectory, + json_extract_path_text(Properties, 'S3StorageClass') as s3_storage_class, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'LocationArn') as location_arn, + json_extract_path_text(Properties, 'LocationUri') as location_uri + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataSync::LocationS3' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'LocationArn') as location_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationS3' + AND region = 'us-east-1' location_smbs: name: location_smbs id: aws.datasync.location_smbs @@ -4443,7 +4610,7 @@ components: x-cfn-type-name: AWS::DataSync::LocationSMB x-identifiers: - LocationArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -4460,9 +4627,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -4472,41 +4639,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/location_smbs/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/location_smbs/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.LocationArn') as location_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationSMB' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'LocationArn') as location_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationSMB' - AND region = 'us-east-1' - location_smb: - name: location_smb - id: aws.datasync.location_smb - x-cfn-schema-name: LocationSMB - x-cfn-type-name: AWS::DataSync::LocationSMB - x-identifiers: - - LocationArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -4517,12 +4652,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/location_smbs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/location_smbs/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/location_smb/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/location_smbs/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -4541,24 +4680,40 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AgentArns') as agent_arns, - json_extract_path_text(Properties, 'Domain') as domain, - json_extract_path_text(Properties, 'MountOptions') as mount_options, - json_extract_path_text(Properties, 'Password') as password, - json_extract_path_text(Properties, 'ServerHostname') as server_hostname, - json_extract_path_text(Properties, 'Subdirectory') as subdirectory, - json_extract_path_text(Properties, 'User') as user, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'LocationArn') as location_arn, - json_extract_path_text(Properties, 'LocationUri') as location_uri - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataSync::LocationSMB' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.LocationArn') as location_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationSMB' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AgentArns') as agent_arns, + json_extract_path_text(Properties, 'Domain') as domain, + json_extract_path_text(Properties, 'MountOptions') as mount_options, + json_extract_path_text(Properties, 'Password') as password, + json_extract_path_text(Properties, 'ServerHostname') as server_hostname, + json_extract_path_text(Properties, 'Subdirectory') as subdirectory, + json_extract_path_text(Properties, 'User') as user, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'LocationArn') as location_arn, + json_extract_path_text(Properties, 'LocationUri') as location_uri + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataSync::LocationSMB' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'LocationArn') as location_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::LocationSMB' + AND region = 'us-east-1' storage_systems: name: storage_systems id: aws.datasync.storage_systems @@ -4566,7 +4721,7 @@ components: x-cfn-type-name: AWS::DataSync::StorageSystem x-identifiers: - StorageSystemArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -4583,9 +4738,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -4595,41 +4750,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/storage_systems/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/storage_systems/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.StorageSystemArn') as storage_system_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::StorageSystem' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'StorageSystemArn') as storage_system_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::StorageSystem' - AND region = 'us-east-1' - storage_system: - name: storage_system - id: aws.datasync.storage_system - x-cfn-schema-name: StorageSystem - x-cfn-type-name: AWS::DataSync::StorageSystem - x-identifiers: - - StorageSystemArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -4640,12 +4763,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/storage_systems/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/storage_systems/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/storage_system/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/storage_systems/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -4664,24 +4791,40 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ServerConfiguration') as server_configuration, - json_extract_path_text(Properties, 'ServerCredentials') as server_credentials, - json_extract_path_text(Properties, 'SecretsManagerArn') as secrets_manager_arn, - json_extract_path_text(Properties, 'SystemType') as system_type, - json_extract_path_text(Properties, 'AgentArns') as agent_arns, - json_extract_path_text(Properties, 'CloudWatchLogGroupArn') as cloud_watch_log_group_arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'StorageSystemArn') as storage_system_arn, - json_extract_path_text(Properties, 'ConnectivityStatus') as connectivity_status - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataSync::StorageSystem' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.StorageSystemArn') as storage_system_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::StorageSystem' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ServerConfiguration') as server_configuration, + json_extract_path_text(Properties, 'ServerCredentials') as server_credentials, + json_extract_path_text(Properties, 'SecretsManagerArn') as secrets_manager_arn, + json_extract_path_text(Properties, 'SystemType') as system_type, + json_extract_path_text(Properties, 'AgentArns') as agent_arns, + json_extract_path_text(Properties, 'CloudWatchLogGroupArn') as cloud_watch_log_group_arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'StorageSystemArn') as storage_system_arn, + json_extract_path_text(Properties, 'ConnectivityStatus') as connectivity_status + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataSync::StorageSystem' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'StorageSystemArn') as storage_system_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::StorageSystem' + AND region = 'us-east-1' tasks: name: tasks id: aws.datasync.tasks @@ -4689,7 +4832,7 @@ components: x-cfn-type-name: AWS::DataSync::Task x-identifiers: - TaskArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -4706,9 +4849,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -4718,41 +4861,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/tasks/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/tasks/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.TaskArn') as task_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::Task' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'TaskArn') as task_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::Task' - AND region = 'us-east-1' - task: - name: task - id: aws.datasync.task - x-cfn-schema-name: Task - x-cfn-type-name: AWS::DataSync::Task - x-identifiers: - - TaskArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -4763,12 +4874,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/tasks/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/tasks/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/task/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/tasks/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -4792,29 +4907,45 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Excludes') as excludes, - json_extract_path_text(Properties, 'Includes') as includes, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'CloudWatchLogGroupArn') as cloud_watch_log_group_arn, - json_extract_path_text(Properties, 'DestinationLocationArn') as destination_location_arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Options') as options, - json_extract_path_text(Properties, 'TaskReportConfig') as task_report_config, - json_extract_path_text(Properties, 'ManifestConfig') as manifest_config, - json_extract_path_text(Properties, 'Schedule') as schedule, - json_extract_path_text(Properties, 'SourceLocationArn') as source_location_arn, - json_extract_path_text(Properties, 'TaskArn') as task_arn, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'SourceNetworkInterfaceArns') as source_network_interface_arns, - json_extract_path_text(Properties, 'DestinationNetworkInterfaceArns') as destination_network_interface_arns - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataSync::Task' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.TaskArn') as task_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::Task' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Excludes') as excludes, + json_extract_path_text(Properties, 'Includes') as includes, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'CloudWatchLogGroupArn') as cloud_watch_log_group_arn, + json_extract_path_text(Properties, 'DestinationLocationArn') as destination_location_arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Options') as options, + json_extract_path_text(Properties, 'TaskReportConfig') as task_report_config, + json_extract_path_text(Properties, 'ManifestConfig') as manifest_config, + json_extract_path_text(Properties, 'Schedule') as schedule, + json_extract_path_text(Properties, 'SourceLocationArn') as source_location_arn, + json_extract_path_text(Properties, 'TaskArn') as task_arn, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'SourceNetworkInterfaceArns') as source_network_interface_arns, + json_extract_path_text(Properties, 'DestinationNetworkInterfaceArns') as destination_network_interface_arns + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataSync::Task' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'TaskArn') as task_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataSync::Task' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/datazone.yaml b/providers/src/aws/v00.00.00000/services/datazone.yaml index a8b4366c..f315013f 100644 --- a/providers/src/aws/v00.00.00000/services/datazone.yaml +++ b/providers/src/aws/v00.00.00000/services/datazone.yaml @@ -479,6 +479,9 @@ components: GlueRunConfigurationInput: type: object properties: + AutoImportDataQualityResult: + description: Specifies whether to automatically import data quality metrics as part of the data source run. + type: boolean DataAccessRole: description: The data access role included in the configuration details of the AWS Glue data source. $ref: '#/components/schemas/DataAccessRole' @@ -726,7 +729,7 @@ components: - EnvironmentIdentifier - Type x-stackql-resource-name: data_source - description: Definition of AWS::DataZone::DataSource Resource Type + description: 'A data source is used to import technical metadata of assets (data) from the source databases or data warehouses into Amazon DataZone. ' x-type-name: AWS::DataZone::DataSource x-stackql-primary-identifier: - DomainId @@ -1336,6 +1339,96 @@ components: - datazone:GetEnvironmentProfile list: - datazone:ListEnvironmentProfiles + GroupProfileStatus: + type: string + description: The status of the group profile. + enum: + - ASSIGNED + - NOT_ASSIGNED + GroupProfile: + type: object + properties: + DomainId: + type: string + description: The identifier of the Amazon DataZone domain in which the group profile is created. + pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ + DomainIdentifier: + type: string + description: The identifier of the Amazon DataZone domain in which the group profile would be created. + pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ + GroupIdentifier: + type: string + description: The ID of the group. + pattern: (^([0-9a-f]{10}-|)[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}$|[\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r ]+) + GroupName: + type: string + description: The group-name of the Group Profile. + maxLength: 1024 + minLength: 1 + pattern: ^[a-zA-Z_0-9+=,.@-]+$ + Id: + type: string + description: The ID of the Amazon DataZone group profile. + pattern: ^([0-9a-f]{10}-|)[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}$ + Status: + $ref: '#/components/schemas/GroupProfileStatus' + required: + - DomainIdentifier + - GroupIdentifier + x-stackql-resource-name: group_profile + description: >- + Group profiles represent groups of Amazon DataZone users. Groups can be manually created, or mapped to Active Directory groups of enterprise customers. In Amazon DataZone, groups serve two purposes. First, a group can map to a team of users in the organizational chart, and thus reduce the administrative work of a Amazon DataZone project owner when there are new employees joining or leaving a team. Second, corporate administrators use Active Directory groups to manage and update user + statuses and so Amazon DataZone domain administrators can use these group memberships to implement Amazon DataZone domain policies. + x-type-name: AWS::DataZone::GroupProfile + x-stackql-primary-identifier: + - DomainId + - Id + x-create-only-properties: + - DomainIdentifier + - GroupIdentifier + x-write-only-properties: + - DomainIdentifier + - GroupIdentifier + x-read-only-properties: + - DomainId + - GroupName + - Id + x-required-properties: + - DomainIdentifier + - GroupIdentifier + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - datazone:CreateGroupProfile + - datazone:GetGroupProfile + - datazone:UpdateGroupProfile + - sso:ListProfiles + - sso:GetProfile + - sso:AssociateProfile + - sso:DisassociateProfile + read: + - datazone:GetGroupProfile + update: + - datazone:UpdateGroupProfile + - datazone:GetGroupProfile + - sso:ListProfiles + - sso:GetProfile + - sso:AssociateProfile + - sso:DisassociateProfile + delete: + - datazone:DeleteGroupProfile + - datazone:GetGroupProfile + - datazone:UpdateGroupProfile + - sso:ListProfiles + - sso:GetProfile + - sso:AssociateProfile + - sso:DisassociateProfile + list: + - datazone:SearchGroupProfiles Project: type: object properties: @@ -1424,6 +1517,90 @@ components: - datazone:GetProject list: - datazone:ListProjects + UserDesignation: + type: string + enum: + - PROJECT_OWNER + - PROJECT_CONTRIBUTOR + MemberIdentifierType: + type: string + enum: + - USER_IDENTIFIER + - GROUP_IDENTIFIER + Member: + oneOf: + - additionalProperties: false + type: object + title: UserIdentifier + properties: + UserIdentifier: + type: string + required: + - UserIdentifier + - additionalProperties: false + type: object + title: GroupIdentifier + properties: + GroupIdentifier: + type: string + required: + - GroupIdentifier + ProjectMembership: + type: object + properties: + ProjectIdentifier: + pattern: ^[a-zA-Z0-9_-]{1,36}$ + type: string + Designation: + $ref: '#/components/schemas/UserDesignation' + Member: + $ref: '#/components/schemas/Member' + DomainIdentifier: + pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ + type: string + required: + - Designation + - DomainIdentifier + - ProjectIdentifier + - Member + x-stackql-resource-name: project_membership + description: Definition of AWS::DataZone::ProjectMembership Resource Type + x-type-name: AWS::DataZone::ProjectMembership + x-stackql-primary-identifier: + - DomainIdentifier + - MemberIdentifier + - MemberIdentifierType + - ProjectIdentifier + x-create-only-properties: + - DomainIdentifier + - ProjectIdentifier + - Member + x-write-only-properties: + - Designation + - Member + x-required-properties: + - Designation + - DomainIdentifier + - ProjectIdentifier + - Member + x-tagging: + taggable: false + x-required-permissions: + read: + - datazone:ListProjectMemberships + create: + - datazone:CreateProjectMembership + - datazone:ListProjectMemberships + - iam:GetRole + - datazone:GetGroupProfile + - datazone:GetUserProfile + update: + - datazone:CreateProjectMembership + - datazone:DeleteProjectMembership + list: + - datazone:ListProjectMemberships + delete: + - datazone:DeleteProjectMembership SubscriptionTargetForm: type: object description: The details of the subscription target configuration. @@ -1581,6 +1758,164 @@ components: - datazone:DeleteSubscriptionTarget list: - datazone:ListSubscriptionTargets + IamUserProfileDetails: + type: object + description: The details of the IAM User Profile. + properties: + Arn: + type: string + description: The ARN of the IAM User Profile. + additionalProperties: false + SsoUserProfileDetails: + type: object + description: The details of the SSO User Profile. + properties: + Username: + type: string + description: The username of the SSO User Profile. + maxLength: 1024 + minLength: 1 + pattern: ^[a-zA-Z_0-9+=,.@-]+$ + FirstName: + type: string + description: The First Name of the IAM User Profile. + LastName: + type: string + description: The Last Name of the IAM User Profile. + additionalProperties: false + UserProfileDetails: + oneOf: + - type: object + title: Iam + properties: + Iam: + $ref: '#/components/schemas/IamUserProfileDetails' + required: + - Iam + additionalProperties: false + - type: object + title: Sso + properties: + Sso: + $ref: '#/components/schemas/SsoUserProfileDetails' + required: + - Sso + additionalProperties: false + UserProfileStatus: + type: string + description: The status of the user profile. + enum: + - ASSIGNED + - NOT_ASSIGNED + - ACTIVATED + - DEACTIVATED + UserProfileType: + type: string + description: The type of the user profile. + enum: + - IAM + - SSO + UserType: + type: string + description: The type of the user. + enum: + - IAM_USER + - IAM_ROLE + - SSO_USER + UserProfile: + type: object + properties: + Details: + $ref: '#/components/schemas/UserProfileDetails' + DomainId: + type: string + description: The identifier of the Amazon DataZone domain in which the user profile is created. + pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ + DomainIdentifier: + type: string + description: The identifier of the Amazon DataZone domain in which the user profile would be created. + pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ + Id: + type: string + description: The ID of the Amazon DataZone user profile. + Status: + $ref: '#/components/schemas/UserProfileStatus' + Type: + $ref: '#/components/schemas/UserProfileType' + UserIdentifier: + type: string + description: The ID of the user. + pattern: (^([0-9a-f]{10}-|)[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}$|^[a-zA-Z_0-9+=,.@-]+$|^arn:aws:iam::\d{12}:.+$) + UserType: + $ref: '#/components/schemas/UserType' + required: + - DomainIdentifier + - UserIdentifier + x-stackql-resource-name: user_profile + description: >- + A user profile represents Amazon DataZone users. Amazon DataZone supports both IAM roles and SSO identities to interact with the Amazon DataZone Management Console and the data portal for different purposes. Domain administrators use IAM roles to perform the initial administrative domain-related work in the Amazon DataZone Management Console, including creating new Amazon DataZone domains, configuring metadata form types, and implementing policies. Data workers use their SSO corporate + identities via Identity Center to log into the Amazon DataZone Data Portal and access projects where they have memberships. + x-type-name: AWS::DataZone::UserProfile + x-stackql-primary-identifier: + - DomainId + - Id + x-create-only-properties: + - DomainIdentifier + - UserIdentifier + - UserType + x-write-only-properties: + - DomainIdentifier + - UserIdentifier + - UserType + x-read-only-properties: + - DomainId + - Type + - Id + - Details + x-required-properties: + - DomainIdentifier + - UserIdentifier + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - datazone:CreateUserProfile + - datazone:GetUserProfile + - datazone:UpdateUserProfile + - datazone:GetDomain + - sso:ListProfiles + - sso:GetProfile + - sso:AssociateProfile + - sso:DisassociateProfile + - iam:GetRole + - iam:GetUser + read: + - datazone:GetUserProfile + update: + - datazone:UpdateUserProfile + - datazone:GetUserProfile + - datazone:UpdateUserProfile + - sso:ListProfiles + - sso:GetProfile + - sso:AssociateProfile + - sso:DisassociateProfile + - iam:GetRole + - iam:GetUser + delete: + - datazone:DeleteUserProfile + - datazone:GetUserProfile + - datazone:UpdateUserProfile + - sso:ListProfiles + - sso:GetProfile + - sso:AssociateProfile + - sso:DisassociateProfile + - iam:GetRole + - iam:GetUser + list: + - datazone:SearchUserProfiles CreateDataSourceRequest: properties: ClientToken: @@ -1984,6 +2319,47 @@ components: x-title: CreateEnvironmentProfileRequest type: object required: [] + CreateGroupProfileRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + DomainId: + type: string + description: The identifier of the Amazon DataZone domain in which the group profile is created. + pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ + DomainIdentifier: + type: string + description: The identifier of the Amazon DataZone domain in which the group profile would be created. + pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ + GroupIdentifier: + type: string + description: The ID of the group. + pattern: (^([0-9a-f]{10}-|)[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}$|[\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r ]+) + GroupName: + type: string + description: The group-name of the Group Profile. + maxLength: 1024 + minLength: 1 + pattern: ^[a-zA-Z_0-9+=,.@-]+$ + Id: + type: string + description: The ID of the Amazon DataZone group profile. + pattern: ^([0-9a-f]{10}-|)[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}$ + Status: + $ref: '#/components/schemas/GroupProfileStatus' + x-stackQL-stringOnly: true + x-title: CreateGroupProfileRequest + type: object + required: [] CreateProjectRequest: properties: ClientToken: @@ -2043,6 +2419,33 @@ components: x-title: CreateProjectRequest type: object required: [] + CreateProjectMembershipRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ProjectIdentifier: + pattern: ^[a-zA-Z0-9_-]{1,36}$ + type: string + Designation: + $ref: '#/components/schemas/UserDesignation' + Member: + $ref: '#/components/schemas/Member' + DomainIdentifier: + pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ + type: string + x-stackQL-stringOnly: true + x-title: CreateProjectMembershipRequest + type: object + required: [] CreateSubscriptionTargetRequest: properties: ClientToken: @@ -2136,6 +2539,46 @@ components: x-title: CreateSubscriptionTargetRequest type: object required: [] + CreateUserProfileRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Details: + $ref: '#/components/schemas/UserProfileDetails' + DomainId: + type: string + description: The identifier of the Amazon DataZone domain in which the user profile is created. + pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ + DomainIdentifier: + type: string + description: The identifier of the Amazon DataZone domain in which the user profile would be created. + pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$ + Id: + type: string + description: The ID of the Amazon DataZone user profile. + Status: + $ref: '#/components/schemas/UserProfileStatus' + Type: + $ref: '#/components/schemas/UserProfileType' + UserIdentifier: + type: string + description: The ID of the user. + pattern: (^([0-9a-f]{10}-|)[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}$|^[a-zA-Z_0-9+=,.@-]+$|^arn:aws:iam::\d{12}:.+$) + UserType: + $ref: '#/components/schemas/UserType' + x-stackQL-stringOnly: true + x-title: CreateUserProfileRequest + type: object + required: [] securitySchemes: hmac: type: apiKey @@ -2152,7 +2595,7 @@ components: x-identifiers: - DomainId - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2169,6 +2612,18 @@ components: response: mediaType: application/json openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataZone::DataSource" + } + response: + mediaType: application/json + openAPIDocKey: '200' delete_resource: operation: $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' @@ -2186,62 +2641,19 @@ components: - $ref: '#/components/x-stackQL-resources/data_sources/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/data_sources/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/data_sources/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.DomainId') as domain_id, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::DataSource' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'DomainId') as domain_id, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::DataSource' - AND region = 'us-east-1' - data_source: - name: data_source - id: aws.datazone.data_source - x-cfn-schema-name: DataSource - x-cfn-type-name: AWS::DataZone::DataSource - x-identifiers: - - DomainId - - Id - x-type: get - methods: - update_resource: - operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' - request: - mediaType: application/x-amz-json-1.0 - base: |- - { - "TypeName": "AWS::DataZone::DataSource" - } - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - update: - - $ref: '#/components/x-stackQL-resources/data_source/methods/update_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - data__Identifier, - JSON_EXTRACT(Properties, '$.AssetFormsInput') as asset_forms_input, - JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, - JSON_EXTRACT(Properties, '$.Description') as description, + data__Identifier, + JSON_EXTRACT(Properties, '$.AssetFormsInput') as asset_forms_input, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.Description') as description, JSON_EXTRACT(Properties, '$.DomainId') as domain_id, JSON_EXTRACT(Properties, '$.DomainIdentifier') as domain_identifier, JSON_EXTRACT(Properties, '$.EnableSetting') as enable_setting, @@ -2265,36 +2677,54 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AssetFormsInput') as asset_forms_input, - json_extract_path_text(Properties, 'CreatedAt') as created_at, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'DomainId') as domain_id, - json_extract_path_text(Properties, 'DomainIdentifier') as domain_identifier, - json_extract_path_text(Properties, 'EnableSetting') as enable_setting, - json_extract_path_text(Properties, 'EnvironmentId') as environment_id, - json_extract_path_text(Properties, 'EnvironmentIdentifier') as environment_identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Configuration') as configuration, - json_extract_path_text(Properties, 'LastRunAssetCount') as last_run_asset_count, - json_extract_path_text(Properties, 'LastRunAt') as last_run_at, - json_extract_path_text(Properties, 'LastRunStatus') as last_run_status, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'ProjectId') as project_id, - json_extract_path_text(Properties, 'ProjectIdentifier') as project_identifier, - json_extract_path_text(Properties, 'PublishOnImport') as publish_on_import, - json_extract_path_text(Properties, 'Recommendation') as recommendation, - json_extract_path_text(Properties, 'Schedule') as schedule, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'Type') as type, - json_extract_path_text(Properties, 'UpdatedAt') as updated_at - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::DataSource' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.DomainId') as domain_id, + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::DataSource' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AssetFormsInput') as asset_forms_input, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'DomainId') as domain_id, + json_extract_path_text(Properties, 'DomainIdentifier') as domain_identifier, + json_extract_path_text(Properties, 'EnableSetting') as enable_setting, + json_extract_path_text(Properties, 'EnvironmentId') as environment_id, + json_extract_path_text(Properties, 'EnvironmentIdentifier') as environment_identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Configuration') as configuration, + json_extract_path_text(Properties, 'LastRunAssetCount') as last_run_asset_count, + json_extract_path_text(Properties, 'LastRunAt') as last_run_at, + json_extract_path_text(Properties, 'LastRunStatus') as last_run_status, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'ProjectId') as project_id, + json_extract_path_text(Properties, 'ProjectIdentifier') as project_identifier, + json_extract_path_text(Properties, 'PublishOnImport') as publish_on_import, + json_extract_path_text(Properties, 'Recommendation') as recommendation, + json_extract_path_text(Properties, 'Schedule') as schedule, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'UpdatedAt') as updated_at + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::DataSource' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DomainId') as domain_id, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::DataSource' + AND region = 'us-east-1' domains: name: domains id: aws.datazone.domains @@ -2302,7 +2732,7 @@ components: x-cfn-type-name: AWS::DataZone::Domain x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2319,9 +2749,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2331,41 +2761,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/domains/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/domains/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::Domain' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::Domain' - AND region = 'us-east-1' - domain: - name: domain - id: aws.datazone.domain - x-cfn-schema-name: Domain - x-cfn-type-name: AWS::DataZone::Domain - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2376,12 +2774,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/domains/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/domains/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/domain/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/domains/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2403,27 +2805,43 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'CreatedAt') as created_at, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'DomainExecutionRole') as domain_execution_role, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'KmsKeyIdentifier') as kms_key_identifier, - json_extract_path_text(Properties, 'LastUpdatedAt') as last_updated_at, - json_extract_path_text(Properties, 'ManagedAccountId') as managed_account_id, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'PortalUrl') as portal_url, - json_extract_path_text(Properties, 'SingleSignOn') as single_sign_on, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::Domain' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::Domain' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'DomainExecutionRole') as domain_execution_role, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'KmsKeyIdentifier') as kms_key_identifier, + json_extract_path_text(Properties, 'LastUpdatedAt') as last_updated_at, + json_extract_path_text(Properties, 'ManagedAccountId') as managed_account_id, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'PortalUrl') as portal_url, + json_extract_path_text(Properties, 'SingleSignOn') as single_sign_on, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::Domain' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::Domain' + AND region = 'us-east-1' environments: name: environments id: aws.datazone.environments @@ -2432,7 +2850,7 @@ components: x-identifiers: - DomainId - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2449,9 +2867,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2461,44 +2879,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/environments/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/environments/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.DomainId') as domain_id, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::Environment' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'DomainId') as domain_id, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::Environment' - AND region = 'us-east-1' - environment: - name: environment - id: aws.datazone.environment - x-cfn-schema-name: Environment - x-cfn-type-name: AWS::DataZone::Environment - x-identifiers: - - DomainId - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2509,12 +2892,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/environments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/environments/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/environment/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/environments/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2542,33 +2929,51 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, - json_extract_path_text(Properties, 'AwsAccountRegion') as aws_account_region, - json_extract_path_text(Properties, 'CreatedAt') as created_at, - json_extract_path_text(Properties, 'CreatedBy') as created_by, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'DomainId') as domain_id, - json_extract_path_text(Properties, 'DomainIdentifier') as domain_identifier, - json_extract_path_text(Properties, 'EnvironmentBlueprintId') as environment_blueprint_id, - json_extract_path_text(Properties, 'EnvironmentProfileId') as environment_profile_id, - json_extract_path_text(Properties, 'EnvironmentProfileIdentifier') as environment_profile_identifier, - json_extract_path_text(Properties, 'GlossaryTerms') as glossary_terms, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'ProjectId') as project_id, - json_extract_path_text(Properties, 'ProjectIdentifier') as project_identifier, - json_extract_path_text(Properties, 'Provider') as provider, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'UpdatedAt') as updated_at, - json_extract_path_text(Properties, 'UserParameters') as user_parameters - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::Environment' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.DomainId') as domain_id, + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::Environment' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, + json_extract_path_text(Properties, 'AwsAccountRegion') as aws_account_region, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'CreatedBy') as created_by, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'DomainId') as domain_id, + json_extract_path_text(Properties, 'DomainIdentifier') as domain_identifier, + json_extract_path_text(Properties, 'EnvironmentBlueprintId') as environment_blueprint_id, + json_extract_path_text(Properties, 'EnvironmentProfileId') as environment_profile_id, + json_extract_path_text(Properties, 'EnvironmentProfileIdentifier') as environment_profile_identifier, + json_extract_path_text(Properties, 'GlossaryTerms') as glossary_terms, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'ProjectId') as project_id, + json_extract_path_text(Properties, 'ProjectIdentifier') as project_identifier, + json_extract_path_text(Properties, 'Provider') as provider, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'UpdatedAt') as updated_at, + json_extract_path_text(Properties, 'UserParameters') as user_parameters + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::Environment' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DomainId') as domain_id, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::Environment' + AND region = 'us-east-1' environment_blueprint_configurations: name: environment_blueprint_configurations id: aws.datazone.environment_blueprint_configurations @@ -2577,7 +2982,7 @@ components: x-identifiers: - DomainId - EnvironmentBlueprintId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2594,9 +2999,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2606,44 +3011,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/environment_blueprint_configurations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/environment_blueprint_configurations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.DomainId') as domain_id, - JSON_EXTRACT(Properties, '$.EnvironmentBlueprintId') as environment_blueprint_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::EnvironmentBlueprintConfiguration' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'DomainId') as domain_id, - json_extract_path_text(Properties, 'EnvironmentBlueprintId') as environment_blueprint_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::EnvironmentBlueprintConfiguration' - AND region = 'us-east-1' - environment_blueprint_configuration: - name: environment_blueprint_configuration - id: aws.datazone.environment_blueprint_configuration - x-cfn-schema-name: EnvironmentBlueprintConfiguration - x-cfn-type-name: AWS::DataZone::EnvironmentBlueprintConfiguration - x-identifiers: - - DomainId - - EnvironmentBlueprintId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2654,12 +3024,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/environment_blueprint_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/environment_blueprint_configurations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/environment_blueprint_configuration/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/environment_blueprint_configurations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2678,24 +3052,42 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'RegionalParameters') as regional_parameters, - json_extract_path_text(Properties, 'ProvisioningRoleArn') as provisioning_role_arn, - json_extract_path_text(Properties, 'DomainId') as domain_id, - json_extract_path_text(Properties, 'CreatedAt') as created_at, - json_extract_path_text(Properties, 'EnabledRegions') as enabled_regions, - json_extract_path_text(Properties, 'EnvironmentBlueprintIdentifier') as environment_blueprint_identifier, - json_extract_path_text(Properties, 'EnvironmentBlueprintId') as environment_blueprint_id, - json_extract_path_text(Properties, 'UpdatedAt') as updated_at, - json_extract_path_text(Properties, 'DomainIdentifier') as domain_identifier, - json_extract_path_text(Properties, 'ManageAccessRoleArn') as manage_access_role_arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::EnvironmentBlueprintConfiguration' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.DomainId') as domain_id, + JSON_EXTRACT(Properties, '$.EnvironmentBlueprintId') as environment_blueprint_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::EnvironmentBlueprintConfiguration' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'RegionalParameters') as regional_parameters, + json_extract_path_text(Properties, 'ProvisioningRoleArn') as provisioning_role_arn, + json_extract_path_text(Properties, 'DomainId') as domain_id, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'EnabledRegions') as enabled_regions, + json_extract_path_text(Properties, 'EnvironmentBlueprintIdentifier') as environment_blueprint_identifier, + json_extract_path_text(Properties, 'EnvironmentBlueprintId') as environment_blueprint_id, + json_extract_path_text(Properties, 'UpdatedAt') as updated_at, + json_extract_path_text(Properties, 'DomainIdentifier') as domain_identifier, + json_extract_path_text(Properties, 'ManageAccessRoleArn') as manage_access_role_arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::EnvironmentBlueprintConfiguration' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DomainId') as domain_id, + json_extract_path_text(Properties, 'EnvironmentBlueprintId') as environment_blueprint_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::EnvironmentBlueprintConfiguration' + AND region = 'us-east-1' environment_profiles: name: environment_profiles id: aws.datazone.environment_profiles @@ -2704,7 +3096,7 @@ components: x-identifiers: - DomainId - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2721,6 +3113,18 @@ components: response: mediaType: application/json openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataZone::EnvironmentProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' delete_resource: operation: $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' @@ -2738,36 +3142,101 @@ components: - $ref: '#/components/x-stackQL-resources/environment_profiles/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/environment_profiles/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/environment_profiles/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, + data__Identifier, + JSON_EXTRACT(Properties, '$.AwsAccountId') as aws_account_id, + JSON_EXTRACT(Properties, '$.AwsAccountRegion') as aws_account_region, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.CreatedBy') as created_by, + JSON_EXTRACT(Properties, '$.Description') as description, JSON_EXTRACT(Properties, '$.DomainId') as domain_id, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::EnvironmentProfile' + JSON_EXTRACT(Properties, '$.DomainIdentifier') as domain_identifier, + JSON_EXTRACT(Properties, '$.EnvironmentBlueprintId') as environment_blueprint_id, + JSON_EXTRACT(Properties, '$.EnvironmentBlueprintIdentifier') as environment_blueprint_identifier, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.ProjectId') as project_id, + JSON_EXTRACT(Properties, '$.ProjectIdentifier') as project_identifier, + JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at, + JSON_EXTRACT(Properties, '$.UserParameters') as user_parameters + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::EnvironmentProfile' + AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - json_extract_path_text(Properties, 'DomainId') as domain_id, - json_extract_path_text(Properties, 'Id') as id + JSON_EXTRACT(Properties, '$.DomainId') as domain_id, + JSON_EXTRACT(Properties, '$.Id') as id FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::EnvironmentProfile' AND region = 'us-east-1' - environment_profile: - name: environment_profile - id: aws.datazone.environment_profile - x-cfn-schema-name: EnvironmentProfile - x-cfn-type-name: AWS::DataZone::EnvironmentProfile + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, + json_extract_path_text(Properties, 'AwsAccountRegion') as aws_account_region, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'CreatedBy') as created_by, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'DomainId') as domain_id, + json_extract_path_text(Properties, 'DomainIdentifier') as domain_identifier, + json_extract_path_text(Properties, 'EnvironmentBlueprintId') as environment_blueprint_id, + json_extract_path_text(Properties, 'EnvironmentBlueprintIdentifier') as environment_blueprint_identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'ProjectId') as project_id, + json_extract_path_text(Properties, 'ProjectIdentifier') as project_identifier, + json_extract_path_text(Properties, 'UpdatedAt') as updated_at, + json_extract_path_text(Properties, 'UserParameters') as user_parameters + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::EnvironmentProfile' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DomainId') as domain_id, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::EnvironmentProfile' + AND region = 'us-east-1' + group_profiles: + name: group_profiles + id: aws.datazone.group_profiles + x-cfn-schema-name: GroupProfile + x-cfn-type-name: AWS::DataZone::GroupProfile x-identifiers: - DomainId - Id - x-type: get + x-type: cloud_control methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__GroupProfile&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataZone::GroupProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' update_resource: operation: $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' @@ -2775,64 +3244,80 @@ components: mediaType: application/x-amz-json-1.0 base: |- { - "TypeName": "AWS::DataZone::EnvironmentProfile" + "TypeName": "AWS::DataZone::GroupProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataZone::GroupProfile" } response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/group_profiles/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/group_profiles/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/environment_profile/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/group_profiles/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.AwsAccountId') as aws_account_id, - JSON_EXTRACT(Properties, '$.AwsAccountRegion') as aws_account_region, - JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, - JSON_EXTRACT(Properties, '$.CreatedBy') as created_by, - JSON_EXTRACT(Properties, '$.Description') as description, JSON_EXTRACT(Properties, '$.DomainId') as domain_id, JSON_EXTRACT(Properties, '$.DomainIdentifier') as domain_identifier, - JSON_EXTRACT(Properties, '$.EnvironmentBlueprintId') as environment_blueprint_id, - JSON_EXTRACT(Properties, '$.EnvironmentBlueprintIdentifier') as environment_blueprint_identifier, + JSON_EXTRACT(Properties, '$.GroupIdentifier') as group_identifier, + JSON_EXTRACT(Properties, '$.GroupName') as group_name, JSON_EXTRACT(Properties, '$.Id') as id, - JSON_EXTRACT(Properties, '$.Name') as name, - JSON_EXTRACT(Properties, '$.ProjectId') as project_id, - JSON_EXTRACT(Properties, '$.ProjectIdentifier') as project_identifier, - JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at, - JSON_EXTRACT(Properties, '$.UserParameters') as user_parameters - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::EnvironmentProfile' + JSON_EXTRACT(Properties, '$.Status') as status + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::GroupProfile' AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, - json_extract_path_text(Properties, 'AwsAccountRegion') as aws_account_region, - json_extract_path_text(Properties, 'CreatedAt') as created_at, - json_extract_path_text(Properties, 'CreatedBy') as created_by, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'DomainId') as domain_id, - json_extract_path_text(Properties, 'DomainIdentifier') as domain_identifier, - json_extract_path_text(Properties, 'EnvironmentBlueprintId') as environment_blueprint_id, - json_extract_path_text(Properties, 'EnvironmentBlueprintIdentifier') as environment_blueprint_identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'ProjectId') as project_id, - json_extract_path_text(Properties, 'ProjectIdentifier') as project_identifier, - json_extract_path_text(Properties, 'UpdatedAt') as updated_at, - json_extract_path_text(Properties, 'UserParameters') as user_parameters - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::EnvironmentProfile' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.DomainId') as domain_id, + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::GroupProfile' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DomainId') as domain_id, + json_extract_path_text(Properties, 'DomainIdentifier') as domain_identifier, + json_extract_path_text(Properties, 'GroupIdentifier') as group_identifier, + json_extract_path_text(Properties, 'GroupName') as group_name, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Status') as status + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::GroupProfile' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DomainId') as domain_id, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::GroupProfile' + AND region = 'us-east-1' projects: name: projects id: aws.datazone.projects @@ -2841,7 +3326,7 @@ components: x-identifiers: - DomainId - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2858,6 +3343,18 @@ components: response: mediaType: application/json openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataZone::Project" + } + response: + mediaType: application/json + openAPIDocKey: '200' delete_resource: operation: $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' @@ -2875,36 +3372,91 @@ components: - $ref: '#/components/x-stackQL-resources/projects/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/projects/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/projects/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, + data__Identifier, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.CreatedBy') as created_by, + JSON_EXTRACT(Properties, '$.Description') as description, JSON_EXTRACT(Properties, '$.DomainId') as domain_id, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::Project' + JSON_EXTRACT(Properties, '$.DomainIdentifier') as domain_identifier, + JSON_EXTRACT(Properties, '$.GlossaryTerms') as glossary_terms, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.LastUpdatedAt') as last_updated_at, + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::Project' + AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - json_extract_path_text(Properties, 'DomainId') as domain_id, - json_extract_path_text(Properties, 'Id') as id + JSON_EXTRACT(Properties, '$.DomainId') as domain_id, + JSON_EXTRACT(Properties, '$.Id') as id FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::Project' AND region = 'us-east-1' - project: - name: project - id: aws.datazone.project - x-cfn-schema-name: Project - x-cfn-type-name: AWS::DataZone::Project + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'CreatedBy') as created_by, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'DomainId') as domain_id, + json_extract_path_text(Properties, 'DomainIdentifier') as domain_identifier, + json_extract_path_text(Properties, 'GlossaryTerms') as glossary_terms, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'LastUpdatedAt') as last_updated_at, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::Project' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DomainId') as domain_id, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::Project' + AND region = 'us-east-1' + project_memberships: + name: project_memberships + id: aws.datazone.project_memberships + x-cfn-schema-name: ProjectMembership + x-cfn-type-name: AWS::DataZone::ProjectMembership x-identifiers: - - DomainId - - Id - x-type: get + - DomainIdentifier + - MemberIdentifier + - MemberIdentifierType + - ProjectIdentifier + x-type: cloud_control methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ProjectMembership&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataZone::ProjectMembership" + } + response: + mediaType: application/json + openAPIDocKey: '200' update_resource: operation: $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' @@ -2912,52 +3464,80 @@ components: mediaType: application/x-amz-json-1.0 base: |- { - "TypeName": "AWS::DataZone::Project" + "TypeName": "AWS::DataZone::ProjectMembership" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataZone::ProjectMembership" } response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/project_memberships/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/project_memberships/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/project/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/project_memberships/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, - JSON_EXTRACT(Properties, '$.CreatedBy') as created_by, - JSON_EXTRACT(Properties, '$.Description') as description, - JSON_EXTRACT(Properties, '$.DomainId') as domain_id, - JSON_EXTRACT(Properties, '$.DomainIdentifier') as domain_identifier, - JSON_EXTRACT(Properties, '$.GlossaryTerms') as glossary_terms, - JSON_EXTRACT(Properties, '$.Id') as id, - JSON_EXTRACT(Properties, '$.LastUpdatedAt') as last_updated_at, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::Project' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.ProjectIdentifier') as project_identifier, + JSON_EXTRACT(Properties, '$.Designation') as designation, + JSON_EXTRACT(Properties, '$.Member') as member, + JSON_EXTRACT(Properties, '$.DomainIdentifier') as domain_identifier + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::ProjectMembership' + AND data__Identifier = '|||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'CreatedAt') as created_at, - json_extract_path_text(Properties, 'CreatedBy') as created_by, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'DomainId') as domain_id, - json_extract_path_text(Properties, 'DomainIdentifier') as domain_identifier, - json_extract_path_text(Properties, 'GlossaryTerms') as glossary_terms, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'LastUpdatedAt') as last_updated_at, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::Project' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.DomainIdentifier') as domain_identifier, + JSON_EXTRACT(Properties, '$.MemberIdentifier') as member_identifier, + JSON_EXTRACT(Properties, '$.MemberIdentifierType') as member_identifier_type, + JSON_EXTRACT(Properties, '$.ProjectIdentifier') as project_identifier + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::ProjectMembership' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ProjectIdentifier') as project_identifier, + json_extract_path_text(Properties, 'Designation') as designation, + json_extract_path_text(Properties, 'Member') as member, + json_extract_path_text(Properties, 'DomainIdentifier') as domain_identifier + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::ProjectMembership' + AND data__Identifier = '|||' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DomainIdentifier') as domain_identifier, + json_extract_path_text(Properties, 'MemberIdentifier') as member_identifier, + json_extract_path_text(Properties, 'MemberIdentifierType') as member_identifier_type, + json_extract_path_text(Properties, 'ProjectIdentifier') as project_identifier + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::ProjectMembership' + AND region = 'us-east-1' subscription_targets: name: subscription_targets id: aws.datazone.subscription_targets @@ -2967,7 +3547,7 @@ components: - DomainId - EnvironmentId - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2984,6 +3564,18 @@ components: response: mediaType: application/json openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataZone::SubscriptionTarget" + } + response: + mediaType: application/json + openAPIDocKey: '200' delete_resource: operation: $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' @@ -3001,39 +3593,107 @@ components: - $ref: '#/components/x-stackQL-resources/subscription_targets/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/subscription_targets/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/subscription_targets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, + data__Identifier, + JSON_EXTRACT(Properties, '$.ApplicableAssetTypes') as applicable_asset_types, + JSON_EXTRACT(Properties, '$.AuthorizedPrincipals') as authorized_principals, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.CreatedBy') as created_by, JSON_EXTRACT(Properties, '$.DomainId') as domain_id, + JSON_EXTRACT(Properties, '$.DomainIdentifier') as domain_identifier, JSON_EXTRACT(Properties, '$.EnvironmentId') as environment_id, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::SubscriptionTarget' + JSON_EXTRACT(Properties, '$.EnvironmentIdentifier') as environment_identifier, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.ManageAccessRole') as manage_access_role, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.ProjectId') as project_id, + JSON_EXTRACT(Properties, '$.Provider') as provider, + JSON_EXTRACT(Properties, '$.SubscriptionTargetConfig') as subscription_target_config, + JSON_EXTRACT(Properties, '$.Type') as type, + JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at, + JSON_EXTRACT(Properties, '$.UpdatedBy') as updated_by + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::SubscriptionTarget' + AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - json_extract_path_text(Properties, 'DomainId') as domain_id, - json_extract_path_text(Properties, 'EnvironmentId') as environment_id, - json_extract_path_text(Properties, 'Id') as id + JSON_EXTRACT(Properties, '$.DomainId') as domain_id, + JSON_EXTRACT(Properties, '$.EnvironmentId') as environment_id, + JSON_EXTRACT(Properties, '$.Id') as id FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::SubscriptionTarget' AND region = 'us-east-1' - subscription_target: - name: subscription_target - id: aws.datazone.subscription_target - x-cfn-schema-name: SubscriptionTarget - x-cfn-type-name: AWS::DataZone::SubscriptionTarget + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ApplicableAssetTypes') as applicable_asset_types, + json_extract_path_text(Properties, 'AuthorizedPrincipals') as authorized_principals, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'CreatedBy') as created_by, + json_extract_path_text(Properties, 'DomainId') as domain_id, + json_extract_path_text(Properties, 'DomainIdentifier') as domain_identifier, + json_extract_path_text(Properties, 'EnvironmentId') as environment_id, + json_extract_path_text(Properties, 'EnvironmentIdentifier') as environment_identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'ManageAccessRole') as manage_access_role, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'ProjectId') as project_id, + json_extract_path_text(Properties, 'Provider') as provider, + json_extract_path_text(Properties, 'SubscriptionTargetConfig') as subscription_target_config, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'UpdatedAt') as updated_at, + json_extract_path_text(Properties, 'UpdatedBy') as updated_by + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::SubscriptionTarget' + AND data__Identifier = '||' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DomainId') as domain_id, + json_extract_path_text(Properties, 'EnvironmentId') as environment_id, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::SubscriptionTarget' + AND region = 'us-east-1' + user_profiles: + name: user_profiles + id: aws.datazone.user_profiles + x-cfn-schema-name: UserProfile + x-cfn-type-name: AWS::DataZone::UserProfile x-identifiers: - DomainId - - EnvironmentId - Id - x-type: get + x-type: cloud_control methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__UserProfile&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataZone::UserProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' update_resource: operation: $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' @@ -3041,68 +3701,84 @@ components: mediaType: application/x-amz-json-1.0 base: |- { - "TypeName": "AWS::DataZone::SubscriptionTarget" + "TypeName": "AWS::DataZone::UserProfile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::DataZone::UserProfile" } response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/user_profiles/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/user_profiles/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/subscription_target/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/user_profiles/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.ApplicableAssetTypes') as applicable_asset_types, - JSON_EXTRACT(Properties, '$.AuthorizedPrincipals') as authorized_principals, - JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, - JSON_EXTRACT(Properties, '$.CreatedBy') as created_by, + JSON_EXTRACT(Properties, '$.Details') as details, JSON_EXTRACT(Properties, '$.DomainId') as domain_id, JSON_EXTRACT(Properties, '$.DomainIdentifier') as domain_identifier, - JSON_EXTRACT(Properties, '$.EnvironmentId') as environment_id, - JSON_EXTRACT(Properties, '$.EnvironmentIdentifier') as environment_identifier, JSON_EXTRACT(Properties, '$.Id') as id, - JSON_EXTRACT(Properties, '$.ManageAccessRole') as manage_access_role, - JSON_EXTRACT(Properties, '$.Name') as name, - JSON_EXTRACT(Properties, '$.ProjectId') as project_id, - JSON_EXTRACT(Properties, '$.Provider') as provider, - JSON_EXTRACT(Properties, '$.SubscriptionTargetConfig') as subscription_target_config, + JSON_EXTRACT(Properties, '$.Status') as status, JSON_EXTRACT(Properties, '$.Type') as type, - JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at, - JSON_EXTRACT(Properties, '$.UpdatedBy') as updated_by - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::SubscriptionTarget' - AND data__Identifier = '||' + JSON_EXTRACT(Properties, '$.UserIdentifier') as user_identifier, + JSON_EXTRACT(Properties, '$.UserType') as user_type + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::UserProfile' + AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ApplicableAssetTypes') as applicable_asset_types, - json_extract_path_text(Properties, 'AuthorizedPrincipals') as authorized_principals, - json_extract_path_text(Properties, 'CreatedAt') as created_at, - json_extract_path_text(Properties, 'CreatedBy') as created_by, - json_extract_path_text(Properties, 'DomainId') as domain_id, - json_extract_path_text(Properties, 'DomainIdentifier') as domain_identifier, - json_extract_path_text(Properties, 'EnvironmentId') as environment_id, - json_extract_path_text(Properties, 'EnvironmentIdentifier') as environment_identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'ManageAccessRole') as manage_access_role, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'ProjectId') as project_id, - json_extract_path_text(Properties, 'Provider') as provider, - json_extract_path_text(Properties, 'SubscriptionTargetConfig') as subscription_target_config, - json_extract_path_text(Properties, 'Type') as type, - json_extract_path_text(Properties, 'UpdatedAt') as updated_at, - json_extract_path_text(Properties, 'UpdatedBy') as updated_by - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::SubscriptionTarget' - AND data__Identifier = '||' + JSON_EXTRACT(Properties, '$.DomainId') as domain_id, + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::UserProfile' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Details') as details, + json_extract_path_text(Properties, 'DomainId') as domain_id, + json_extract_path_text(Properties, 'DomainIdentifier') as domain_identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'UserIdentifier') as user_identifier, + json_extract_path_text(Properties, 'UserType') as user_type + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DataZone::UserProfile' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DomainId') as domain_id, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DataZone::UserProfile' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: @@ -3456,6 +4132,48 @@ paths: schema: $ref: '#/components/x-cloud-control-schemas/ProgressEvent' description: Success + /?Action=CreateResource&Version=2021-09-30&__GroupProfile&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateGroupProfile + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateGroupProfileRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success /?Action=CreateResource&Version=2021-09-30&__Project&__detailTransformed=true: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' @@ -3498,6 +4216,48 @@ paths: schema: $ref: '#/components/x-cloud-control-schemas/ProgressEvent' description: Success + /?Action=CreateResource&Version=2021-09-30&__ProjectMembership&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateProjectMembership + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateProjectMembershipRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success /?Action=CreateResource&Version=2021-09-30&__SubscriptionTarget&__detailTransformed=true: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' @@ -3540,6 +4300,48 @@ paths: schema: $ref: '#/components/x-cloud-control-schemas/ProgressEvent' description: Success + /?Action=CreateResource&Version=2021-09-30&__UserProfile&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateUserProfile + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateUserProfileRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success x-stackQL-config: requestTranslate: algorithm: drop_double_underscore_params diff --git a/providers/src/aws/v00.00.00000/services/deadline.yaml b/providers/src/aws/v00.00.00000/services/deadline.yaml index 1b182007..e319e680 100644 --- a/providers/src/aws/v00.00.00000/services/deadline.yaml +++ b/providers/src/aws/v00.00.00000/services/deadline.yaml @@ -740,7 +740,6 @@ components: ServiceManagedFleetOperatingSystemFamily: type: string enum: - - WINDOWS - LINUX VCpuCountRange: type: object @@ -1726,7 +1725,7 @@ components: x-cfn-type-name: AWS::Deadline::Farm x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1743,9 +1742,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1755,41 +1754,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/farms/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/farms/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Deadline::Farm' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Deadline::Farm' - AND region = 'us-east-1' - farm: - name: farm - id: aws.deadline.farm - x-cfn-schema-name: Farm - x-cfn-type-name: AWS::Deadline::Farm - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1800,12 +1767,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/farms/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/farms/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/farm/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/farms/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1819,19 +1790,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'DisplayName') as display_name, - json_extract_path_text(Properties, 'FarmId') as farm_id, - json_extract_path_text(Properties, 'KmsKeyArn') as kms_key_arn, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Deadline::Farm' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Deadline::Farm' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'DisplayName') as display_name, + json_extract_path_text(Properties, 'FarmId') as farm_id, + json_extract_path_text(Properties, 'KmsKeyArn') as kms_key_arn, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Deadline::Farm' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Deadline::Farm' + AND region = 'us-east-1' fleets: name: fleets id: aws.deadline.fleets @@ -1839,7 +1826,7 @@ components: x-cfn-type-name: AWS::Deadline::Fleet x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1856,9 +1843,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1868,41 +1855,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/fleets/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/fleets/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Deadline::Fleet' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Deadline::Fleet' - AND region = 'us-east-1' - fleet: - name: fleet - id: aws.deadline.fleet - x-cfn-schema-name: Fleet - x-cfn-type-name: AWS::Deadline::Fleet - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1913,12 +1868,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/fleets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/fleets/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/fleet/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/fleets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1939,26 +1898,42 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Capabilities') as capabilities, - json_extract_path_text(Properties, 'Configuration') as configuration, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'DisplayName') as display_name, - json_extract_path_text(Properties, 'FarmId') as farm_id, - json_extract_path_text(Properties, 'FleetId') as fleet_id, - json_extract_path_text(Properties, 'MaxWorkerCount') as max_worker_count, - json_extract_path_text(Properties, 'MinWorkerCount') as min_worker_count, - json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'WorkerCount') as worker_count, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Deadline::Fleet' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Deadline::Fleet' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Capabilities') as capabilities, + json_extract_path_text(Properties, 'Configuration') as configuration, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'DisplayName') as display_name, + json_extract_path_text(Properties, 'FarmId') as farm_id, + json_extract_path_text(Properties, 'FleetId') as fleet_id, + json_extract_path_text(Properties, 'MaxWorkerCount') as max_worker_count, + json_extract_path_text(Properties, 'MinWorkerCount') as min_worker_count, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'WorkerCount') as worker_count, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Deadline::Fleet' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Deadline::Fleet' + AND region = 'us-east-1' license_endpoints: name: license_endpoints id: aws.deadline.license_endpoints @@ -1966,7 +1941,7 @@ components: x-cfn-type-name: AWS::Deadline::LicenseEndpoint x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2000,39 +1975,11 @@ components: - $ref: '#/components/x-stackQL-resources/license_endpoints/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/license_endpoints/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Deadline::LicenseEndpoint' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Deadline::LicenseEndpoint' - AND region = 'us-east-1' - license_endpoint: - name: license_endpoint - id: aws.deadline.license_endpoint - x-cfn-schema-name: LicenseEndpoint - x-cfn-type-name: AWS::Deadline::LicenseEndpoint - x-identifiers: - - Arn - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2049,22 +1996,38 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'DnsName') as dns_name, - json_extract_path_text(Properties, 'LicenseEndpointId') as license_endpoint_id, - json_extract_path_text(Properties, 'SecurityGroupIds') as security_group_ids, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'StatusMessage') as status_message, - json_extract_path_text(Properties, 'SubnetIds') as subnet_ids, - json_extract_path_text(Properties, 'VpcId') as vpc_id, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Deadline::LicenseEndpoint' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Deadline::LicenseEndpoint' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DnsName') as dns_name, + json_extract_path_text(Properties, 'LicenseEndpointId') as license_endpoint_id, + json_extract_path_text(Properties, 'SecurityGroupIds') as security_group_ids, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'StatusMessage') as status_message, + json_extract_path_text(Properties, 'SubnetIds') as subnet_ids, + json_extract_path_text(Properties, 'VpcId') as vpc_id, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Deadline::LicenseEndpoint' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Deadline::LicenseEndpoint' + AND region = 'us-east-1' metered_products: name: metered_products id: aws.deadline.metered_products @@ -2072,7 +2035,7 @@ components: x-cfn-type-name: AWS::Deadline::MeteredProduct x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2106,39 +2069,11 @@ components: - $ref: '#/components/x-stackQL-resources/metered_products/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/metered_products/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Deadline::MeteredProduct' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Deadline::MeteredProduct' - AND region = 'us-east-1' - metered_product: - name: metered_product - id: aws.deadline.metered_product - x-cfn-schema-name: MeteredProduct - x-cfn-type-name: AWS::Deadline::MeteredProduct - x-identifiers: - - Arn - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2153,20 +2088,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'LicenseEndpointId') as license_endpoint_id, - json_extract_path_text(Properties, 'ProductId') as product_id, - json_extract_path_text(Properties, 'Port') as port, - json_extract_path_text(Properties, 'Family') as family, - json_extract_path_text(Properties, 'Vendor') as vendor, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Deadline::MeteredProduct' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Deadline::MeteredProduct' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'LicenseEndpointId') as license_endpoint_id, + json_extract_path_text(Properties, 'ProductId') as product_id, + json_extract_path_text(Properties, 'Port') as port, + json_extract_path_text(Properties, 'Family') as family, + json_extract_path_text(Properties, 'Vendor') as vendor, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Deadline::MeteredProduct' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Deadline::MeteredProduct' + AND region = 'us-east-1' queues: name: queues id: aws.deadline.queues @@ -2174,7 +2125,7 @@ components: x-cfn-type-name: AWS::Deadline::Queue x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2191,9 +2142,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2203,41 +2154,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/queues/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/queues/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Deadline::Queue' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Deadline::Queue' - AND region = 'us-east-1' - queue: - name: queue - id: aws.deadline.queue - x-cfn-schema-name: Queue - x-cfn-type-name: AWS::Deadline::Queue - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2248,12 +2167,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/queues/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/queues/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/queue/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/queues/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2273,25 +2196,41 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AllowedStorageProfileIds') as allowed_storage_profile_ids, - json_extract_path_text(Properties, 'DefaultBudgetAction') as default_budget_action, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'DisplayName') as display_name, - json_extract_path_text(Properties, 'FarmId') as farm_id, - json_extract_path_text(Properties, 'JobAttachmentSettings') as job_attachment_settings, - json_extract_path_text(Properties, 'JobRunAsUser') as job_run_as_user, - json_extract_path_text(Properties, 'QueueId') as queue_id, - json_extract_path_text(Properties, 'RequiredFileSystemLocationNames') as required_file_system_location_names, - json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Deadline::Queue' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Deadline::Queue' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AllowedStorageProfileIds') as allowed_storage_profile_ids, + json_extract_path_text(Properties, 'DefaultBudgetAction') as default_budget_action, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'DisplayName') as display_name, + json_extract_path_text(Properties, 'FarmId') as farm_id, + json_extract_path_text(Properties, 'JobAttachmentSettings') as job_attachment_settings, + json_extract_path_text(Properties, 'JobRunAsUser') as job_run_as_user, + json_extract_path_text(Properties, 'QueueId') as queue_id, + json_extract_path_text(Properties, 'RequiredFileSystemLocationNames') as required_file_system_location_names, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Deadline::Queue' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Deadline::Queue' + AND region = 'us-east-1' queue_environments: name: queue_environments id: aws.deadline.queue_environments @@ -2301,7 +2240,7 @@ components: - FarmId - QueueId - QueueEnvironmentId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2318,9 +2257,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2330,47 +2269,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/queue_environments/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/queue_environments/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.FarmId') as farm_id, - JSON_EXTRACT(Properties, '$.QueueId') as queue_id, - JSON_EXTRACT(Properties, '$.QueueEnvironmentId') as queue_environment_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Deadline::QueueEnvironment' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'FarmId') as farm_id, - json_extract_path_text(Properties, 'QueueId') as queue_id, - json_extract_path_text(Properties, 'QueueEnvironmentId') as queue_environment_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Deadline::QueueEnvironment' - AND region = 'us-east-1' - queue_environment: - name: queue_environment - id: aws.deadline.queue_environment - x-cfn-schema-name: QueueEnvironment - x-cfn-type-name: AWS::Deadline::QueueEnvironment - x-identifiers: - - FarmId - - QueueId - - QueueEnvironmentId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2381,12 +2282,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/queue_environments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/queue_environments/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/queue_environment/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/queue_environments/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2402,21 +2307,41 @@ components: AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'FarmId') as farm_id, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Priority') as priority, - json_extract_path_text(Properties, 'QueueEnvironmentId') as queue_environment_id, - json_extract_path_text(Properties, 'QueueId') as queue_id, - json_extract_path_text(Properties, 'Template') as template, - json_extract_path_text(Properties, 'TemplateType') as template_type - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Deadline::QueueEnvironment' - AND data__Identifier = '||' + JSON_EXTRACT(Properties, '$.FarmId') as farm_id, + JSON_EXTRACT(Properties, '$.QueueId') as queue_id, + JSON_EXTRACT(Properties, '$.QueueEnvironmentId') as queue_environment_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Deadline::QueueEnvironment' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'FarmId') as farm_id, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Priority') as priority, + json_extract_path_text(Properties, 'QueueEnvironmentId') as queue_environment_id, + json_extract_path_text(Properties, 'QueueId') as queue_id, + json_extract_path_text(Properties, 'Template') as template, + json_extract_path_text(Properties, 'TemplateType') as template_type + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Deadline::QueueEnvironment' + AND data__Identifier = '||' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'FarmId') as farm_id, + json_extract_path_text(Properties, 'QueueId') as queue_id, + json_extract_path_text(Properties, 'QueueEnvironmentId') as queue_environment_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Deadline::QueueEnvironment' + AND region = 'us-east-1' queue_fleet_associations: name: queue_fleet_associations id: aws.deadline.queue_fleet_associations @@ -2426,7 +2351,7 @@ components: - FarmId - FleetId - QueueId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2460,45 +2385,11 @@ components: - $ref: '#/components/x-stackQL-resources/queue_fleet_associations/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/queue_fleet_associations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.FarmId') as farm_id, - JSON_EXTRACT(Properties, '$.FleetId') as fleet_id, - JSON_EXTRACT(Properties, '$.QueueId') as queue_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Deadline::QueueFleetAssociation' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'FarmId') as farm_id, - json_extract_path_text(Properties, 'FleetId') as fleet_id, - json_extract_path_text(Properties, 'QueueId') as queue_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Deadline::QueueFleetAssociation' - AND region = 'us-east-1' - queue_fleet_association: - name: queue_fleet_association - id: aws.deadline.queue_fleet_association - x-cfn-schema-name: QueueFleetAssociation - x-cfn-type-name: AWS::Deadline::QueueFleetAssociation - x-identifiers: - - FarmId - - FleetId - - QueueId - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2510,17 +2401,37 @@ components: AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'FarmId') as farm_id, - json_extract_path_text(Properties, 'FleetId') as fleet_id, - json_extract_path_text(Properties, 'QueueId') as queue_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Deadline::QueueFleetAssociation' - AND data__Identifier = '||' + JSON_EXTRACT(Properties, '$.FarmId') as farm_id, + JSON_EXTRACT(Properties, '$.FleetId') as fleet_id, + JSON_EXTRACT(Properties, '$.QueueId') as queue_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Deadline::QueueFleetAssociation' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'FarmId') as farm_id, + json_extract_path_text(Properties, 'FleetId') as fleet_id, + json_extract_path_text(Properties, 'QueueId') as queue_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Deadline::QueueFleetAssociation' + AND data__Identifier = '||' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'FarmId') as farm_id, + json_extract_path_text(Properties, 'FleetId') as fleet_id, + json_extract_path_text(Properties, 'QueueId') as queue_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Deadline::QueueFleetAssociation' + AND region = 'us-east-1' storage_profiles: name: storage_profiles id: aws.deadline.storage_profiles @@ -2529,7 +2440,7 @@ components: x-identifiers: - FarmId - StorageProfileId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2546,9 +2457,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2558,44 +2469,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/storage_profiles/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/storage_profiles/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.FarmId') as farm_id, - JSON_EXTRACT(Properties, '$.StorageProfileId') as storage_profile_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Deadline::StorageProfile' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'FarmId') as farm_id, - json_extract_path_text(Properties, 'StorageProfileId') as storage_profile_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Deadline::StorageProfile' - AND region = 'us-east-1' - storage_profile: - name: storage_profile - id: aws.deadline.storage_profile - x-cfn-schema-name: StorageProfile - x-cfn-type-name: AWS::Deadline::StorageProfile - x-identifiers: - - FarmId - - StorageProfileId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2606,12 +2482,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/storage_profiles/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/storage_profiles/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/storage_profile/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/storage_profiles/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2625,19 +2505,37 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'DisplayName') as display_name, - json_extract_path_text(Properties, 'FarmId') as farm_id, - json_extract_path_text(Properties, 'FileSystemLocations') as file_system_locations, - json_extract_path_text(Properties, 'OsFamily') as os_family, - json_extract_path_text(Properties, 'StorageProfileId') as storage_profile_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Deadline::StorageProfile' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.FarmId') as farm_id, + JSON_EXTRACT(Properties, '$.StorageProfileId') as storage_profile_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Deadline::StorageProfile' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DisplayName') as display_name, + json_extract_path_text(Properties, 'FarmId') as farm_id, + json_extract_path_text(Properties, 'FileSystemLocations') as file_system_locations, + json_extract_path_text(Properties, 'OsFamily') as os_family, + json_extract_path_text(Properties, 'StorageProfileId') as storage_profile_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Deadline::StorageProfile' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'FarmId') as farm_id, + json_extract_path_text(Properties, 'StorageProfileId') as storage_profile_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Deadline::StorageProfile' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/detective.yaml b/providers/src/aws/v00.00.00000/services/detective.yaml index 1ada2e2e..105a276b 100644 --- a/providers/src/aws/v00.00.00000/services/detective.yaml +++ b/providers/src/aws/v00.00.00000/services/detective.yaml @@ -653,7 +653,7 @@ components: x-cfn-type-name: AWS::Detective::Graph x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -670,9 +670,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -682,41 +682,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/graphs/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/graphs/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Detective::Graph' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Detective::Graph' - AND region = 'us-east-1' - graph: - name: graph - id: aws.detective.graph - x-cfn-schema-name: Graph - x-cfn-type-name: AWS::Detective::Graph - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -727,12 +695,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/graphs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/graphs/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/graph/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/graphs/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -744,17 +716,33 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'AutoEnableMembers') as auto_enable_members - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Detective::Graph' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Detective::Graph' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'AutoEnableMembers') as auto_enable_members + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Detective::Graph' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Detective::Graph' + AND region = 'us-east-1' member_invitations: name: member_invitations id: aws.detective.member_invitations @@ -763,7 +751,7 @@ components: x-identifiers: - GraphArn - MemberId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -797,42 +785,11 @@ components: - $ref: '#/components/x-stackQL-resources/member_invitations/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/member_invitations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.GraphArn') as graph_arn, - JSON_EXTRACT(Properties, '$.MemberId') as member_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Detective::MemberInvitation' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'GraphArn') as graph_arn, - json_extract_path_text(Properties, 'MemberId') as member_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Detective::MemberInvitation' - AND region = 'us-east-1' - member_invitation: - name: member_invitation - id: aws.detective.member_invitation - x-cfn-schema-name: MemberInvitation - x-cfn-type-name: AWS::Detective::MemberInvitation - x-identifiers: - - GraphArn - - MemberId - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -846,19 +803,37 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'GraphArn') as graph_arn, - json_extract_path_text(Properties, 'MemberId') as member_id, - json_extract_path_text(Properties, 'MemberEmailAddress') as member_email_address, - json_extract_path_text(Properties, 'DisableEmailNotification') as disable_email_notification, - json_extract_path_text(Properties, 'Message') as message - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Detective::MemberInvitation' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.GraphArn') as graph_arn, + JSON_EXTRACT(Properties, '$.MemberId') as member_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Detective::MemberInvitation' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'GraphArn') as graph_arn, + json_extract_path_text(Properties, 'MemberId') as member_id, + json_extract_path_text(Properties, 'MemberEmailAddress') as member_email_address, + json_extract_path_text(Properties, 'DisableEmailNotification') as disable_email_notification, + json_extract_path_text(Properties, 'Message') as message + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Detective::MemberInvitation' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'GraphArn') as graph_arn, + json_extract_path_text(Properties, 'MemberId') as member_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Detective::MemberInvitation' + AND region = 'us-east-1' organization_admins: name: organization_admins id: aws.detective.organization_admins @@ -866,7 +841,7 @@ components: x-cfn-type-name: AWS::Detective::OrganizationAdmin x-identifiers: - AccountId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -900,39 +875,11 @@ components: - $ref: '#/components/x-stackQL-resources/organization_admins/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/organization_admins/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AccountId') as account_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Detective::OrganizationAdmin' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AccountId') as account_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Detective::OrganizationAdmin' - AND region = 'us-east-1' - organization_admin: - name: organization_admin - id: aws.detective.organization_admin - x-cfn-schema-name: OrganizationAdmin - x-cfn-type-name: AWS::Detective::OrganizationAdmin - x-identifiers: - - AccountId - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -943,16 +890,32 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AccountId') as account_id, - json_extract_path_text(Properties, 'GraphArn') as graph_arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Detective::OrganizationAdmin' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.AccountId') as account_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Detective::OrganizationAdmin' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AccountId') as account_id, + json_extract_path_text(Properties, 'GraphArn') as graph_arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Detective::OrganizationAdmin' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AccountId') as account_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Detective::OrganizationAdmin' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/devopsguru.yaml b/providers/src/aws/v00.00.00000/services/devopsguru.yaml index e6790d52..a3cc78dc 100644 --- a/providers/src/aws/v00.00.00000/services/devopsguru.yaml +++ b/providers/src/aws/v00.00.00000/services/devopsguru.yaml @@ -693,7 +693,7 @@ components: x-cfn-type-name: AWS::DevOpsGuru::LogAnomalyDetectionIntegration x-identifiers: - AccountId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -710,9 +710,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -722,41 +722,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/log_anomaly_detection_integrations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/log_anomaly_detection_integrations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AccountId') as account_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DevOpsGuru::LogAnomalyDetectionIntegration' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AccountId') as account_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DevOpsGuru::LogAnomalyDetectionIntegration' - AND region = 'us-east-1' - log_anomaly_detection_integration: - name: log_anomaly_detection_integration - id: aws.devopsguru.log_anomaly_detection_integration - x-cfn-schema-name: LogAnomalyDetectionIntegration - x-cfn-type-name: AWS::DevOpsGuru::LogAnomalyDetectionIntegration - x-identifiers: - - AccountId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -767,12 +735,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/log_anomaly_detection_integrations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/log_anomaly_detection_integrations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/log_anomaly_detection_integration/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/log_anomaly_detection_integrations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -782,15 +754,31 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AccountId') as account_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DevOpsGuru::LogAnomalyDetectionIntegration' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.AccountId') as account_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DevOpsGuru::LogAnomalyDetectionIntegration' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AccountId') as account_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DevOpsGuru::LogAnomalyDetectionIntegration' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AccountId') as account_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DevOpsGuru::LogAnomalyDetectionIntegration' + AND region = 'us-east-1' notification_channels: name: notification_channels id: aws.devopsguru.notification_channels @@ -798,7 +786,7 @@ components: x-cfn-type-name: AWS::DevOpsGuru::NotificationChannel x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -832,39 +820,11 @@ components: - $ref: '#/components/x-stackQL-resources/notification_channels/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/notification_channels/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DevOpsGuru::NotificationChannel' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DevOpsGuru::NotificationChannel' - AND region = 'us-east-1' - notification_channel: - name: notification_channel - id: aws.devopsguru.notification_channel - x-cfn-schema-name: NotificationChannel - x-cfn-type-name: AWS::DevOpsGuru::NotificationChannel - x-identifiers: - - Id - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -875,16 +835,32 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Config') as config, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DevOpsGuru::NotificationChannel' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DevOpsGuru::NotificationChannel' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Config') as config, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DevOpsGuru::NotificationChannel' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DevOpsGuru::NotificationChannel' + AND region = 'us-east-1' resource_collections: name: resource_collections id: aws.devopsguru.resource_collections @@ -892,7 +868,7 @@ components: x-cfn-type-name: AWS::DevOpsGuru::ResourceCollection x-identifiers: - ResourceCollectionType - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -909,9 +885,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -921,41 +897,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/resource_collections/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/resource_collections/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ResourceCollectionType') as resource_collection_type - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DevOpsGuru::ResourceCollection' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ResourceCollectionType') as resource_collection_type - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DevOpsGuru::ResourceCollection' - AND region = 'us-east-1' - resource_collection: - name: resource_collection - id: aws.devopsguru.resource_collection - x-cfn-schema-name: ResourceCollection - x-cfn-type-name: AWS::DevOpsGuru::ResourceCollection - x-identifiers: - - ResourceCollectionType - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -966,12 +910,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/resource_collections/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/resource_collections/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/resource_collection/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/resource_collections/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -982,16 +930,32 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ResourceCollectionFilter') as resource_collection_filter, - json_extract_path_text(Properties, 'ResourceCollectionType') as resource_collection_type - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DevOpsGuru::ResourceCollection' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ResourceCollectionType') as resource_collection_type + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DevOpsGuru::ResourceCollection' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ResourceCollectionFilter') as resource_collection_filter, + json_extract_path_text(Properties, 'ResourceCollectionType') as resource_collection_type + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DevOpsGuru::ResourceCollection' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ResourceCollectionType') as resource_collection_type + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DevOpsGuru::ResourceCollection' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/directoryservice.yaml b/providers/src/aws/v00.00.00000/services/directoryservice.yaml index faef65f9..138f51b8 100644 --- a/providers/src/aws/v00.00.00000/services/directoryservice.yaml +++ b/providers/src/aws/v00.00.00000/services/directoryservice.yaml @@ -490,6 +490,8 @@ components: - ec2:AuthorizeSecurityGroupIngress - ec2:AuthorizeSecurityGroupEgress - ec2:CreateTags + - ec2:RevokeSecurityGroupIngress + - ec2:RevokeSecurityGroupEgress read: - ds:DescribeDirectories update: @@ -576,7 +578,7 @@ components: x-cfn-type-name: AWS::DirectoryService::SimpleAD x-identifiers: - DirectoryId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -593,9 +595,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -605,41 +607,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/simple_ads/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/simple_ads/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.DirectoryId') as directory_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DirectoryService::SimpleAD' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'DirectoryId') as directory_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DirectoryService::SimpleAD' - AND region = 'us-east-1' - simple_ad: - name: simple_ad - id: aws.directoryservice.simple_ad - x-cfn-schema-name: SimpleAD - x-cfn-type-name: AWS::DirectoryService::SimpleAD - x-identifiers: - - DirectoryId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -650,12 +620,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/simple_ads/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/simple_ads/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/simple_ad/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/simple_ads/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -675,25 +649,41 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'DirectoryId') as directory_id, - json_extract_path_text(Properties, 'Alias') as alias, - json_extract_path_text(Properties, 'DnsIpAddresses') as dns_ip_addresses, - json_extract_path_text(Properties, 'CreateAlias') as create_alias, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'EnableSso') as enable_sso, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Password') as password, - json_extract_path_text(Properties, 'ShortName') as short_name, - json_extract_path_text(Properties, 'Size') as size, - json_extract_path_text(Properties, 'VpcSettings') as vpc_settings - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DirectoryService::SimpleAD' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.DirectoryId') as directory_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DirectoryService::SimpleAD' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DirectoryId') as directory_id, + json_extract_path_text(Properties, 'Alias') as alias, + json_extract_path_text(Properties, 'DnsIpAddresses') as dns_ip_addresses, + json_extract_path_text(Properties, 'CreateAlias') as create_alias, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'EnableSso') as enable_sso, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Password') as password, + json_extract_path_text(Properties, 'ShortName') as short_name, + json_extract_path_text(Properties, 'Size') as size, + json_extract_path_text(Properties, 'VpcSettings') as vpc_settings + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DirectoryService::SimpleAD' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DirectoryId') as directory_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DirectoryService::SimpleAD' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/dms.yaml b/providers/src/aws/v00.00.00000/services/dms.yaml index 85d5a381..0053d6b7 100644 --- a/providers/src/aws/v00.00.00000/services/dms.yaml +++ b/providers/src/aws/v00.00.00000/services/dms.yaml @@ -410,8 +410,8 @@ components: enum: - none - require - - verify_ca - - verify_full + - verify-ca + - verify-full DataProvider: type: object properties: @@ -457,91 +457,108 @@ components: Settings: description: The property identifies the exact type of settings for the data provider. type: object - anyOf: - - description: PostgreSqlSettings property identifier. + properties: + PostgreSqlSettings: + description: PostgreSqlSettings property identifier. type: object - additionalProperties: false properties: - PostgreSqlSettings: + ServerName: + type: string + Port: + type: integer + DatabaseName: + type: string + SslMode: type: object - additionalProperties: false - properties: - ServerName: - type: string - Port: - type: integer - DatabaseName: - type: string - SslMode: - type: object - $ref: '#/components/schemas/DmsSslModeValue' - CertificateArn: - type: string - - description: MySqlSettings property identifier. - type: object + $ref: '#/components/schemas/DmsSslModeValue' + CertificateArn: + type: string + required: + - ServerName + - Port + - SslMode + - DatabaseName additionalProperties: false + MySqlSettings: + description: MySqlSettings property identifier. + type: object properties: - MySqlSettings: + ServerName: + type: string + Port: + type: integer + SslMode: type: object - additionalProperties: false - properties: - ServerName: - type: string - Port: - type: integer - SslMode: - type: object - $ref: '#/components/schemas/DmsSslModeValue' - CertificateArn: - type: string - - description: OracleSettings property identifier. - type: object + $ref: '#/components/schemas/DmsSslModeValue' + CertificateArn: + type: string + required: + - ServerName + - Port + - SslMode additionalProperties: false + OracleSettings: + description: OracleSettings property identifier. + type: object properties: - OracleSettings: + ServerName: + type: string + Port: + type: integer + DatabaseName: + type: string + SslMode: type: object - additionalProperties: false - properties: - ServerName: - type: string - Port: - type: integer - DatabaseName: - type: string - SslMode: - type: object - $ref: '#/components/schemas/DmsSslModeValue' - CertificateArn: - type: string - AsmServer: - type: string - SecretsManagerOracleAsmSecretId: - type: string - SecretsManagerOracleAsmAccessRoleArn: - type: string - SecretsManagerSecurityDbEncryptionSecretId: - type: string - SecretsManagerSecurityDbEncryptionAccessRoleArn: - type: string - - description: MicrosoftSqlServerSettings property identifier. - type: object + $ref: '#/components/schemas/DmsSslModeValue' + CertificateArn: + type: string + AsmServer: + type: string + SecretsManagerOracleAsmSecretId: + type: string + SecretsManagerOracleAsmAccessRoleArn: + type: string + SecretsManagerSecurityDbEncryptionSecretId: + type: string + SecretsManagerSecurityDbEncryptionAccessRoleArn: + type: string + required: + - ServerName + - Port + - SslMode + - DatabaseName additionalProperties: false + MicrosoftSqlServerSettings: + description: MicrosoftSqlServerSettings property identifier. + type: object properties: - MicrosoftSqlServerSettings: + ServerName: + type: string + Port: + type: integer + DatabaseName: + type: string + SslMode: type: object - additionalProperties: false - properties: - ServerName: - type: string - Port: - type: integer - DatabaseName: - type: string - SslMode: - type: object - $ref: '#/components/schemas/DmsSslModeValue' - CertificateArn: - type: string + $ref: '#/components/schemas/DmsSslModeValue' + CertificateArn: + type: string + required: + - ServerName + - Port + - SslMode + - DatabaseName + additionalProperties: false + anyOf: + - required: + - PostgreSqlSettings + - required: + - MySqlSettings + - required: + - OracleSettings + - required: + - MicrosoftSqlServerSettings + additionalProperties: false Tags: description: An array of key-value pairs to apply to this resource. type: array @@ -1001,91 +1018,108 @@ components: Settings: description: The property identifies the exact type of settings for the data provider. type: object - anyOf: - - description: PostgreSqlSettings property identifier. + properties: + PostgreSqlSettings: + description: PostgreSqlSettings property identifier. type: object - additionalProperties: false properties: - PostgreSqlSettings: + ServerName: + type: string + Port: + type: integer + DatabaseName: + type: string + SslMode: type: object - additionalProperties: false - properties: - ServerName: - type: string - Port: - type: integer - DatabaseName: - type: string - SslMode: - type: object - $ref: '#/components/schemas/DmsSslModeValue' - CertificateArn: - type: string - - description: MySqlSettings property identifier. - type: object + $ref: '#/components/schemas/DmsSslModeValue' + CertificateArn: + type: string + required: + - ServerName + - Port + - SslMode + - DatabaseName additionalProperties: false + MySqlSettings: + description: MySqlSettings property identifier. + type: object properties: - MySqlSettings: + ServerName: + type: string + Port: + type: integer + SslMode: type: object - additionalProperties: false - properties: - ServerName: - type: string - Port: - type: integer - SslMode: - type: object - $ref: '#/components/schemas/DmsSslModeValue' - CertificateArn: - type: string - - description: OracleSettings property identifier. - type: object + $ref: '#/components/schemas/DmsSslModeValue' + CertificateArn: + type: string + required: + - ServerName + - Port + - SslMode additionalProperties: false + OracleSettings: + description: OracleSettings property identifier. + type: object properties: - OracleSettings: + ServerName: + type: string + Port: + type: integer + DatabaseName: + type: string + SslMode: type: object - additionalProperties: false - properties: - ServerName: - type: string - Port: - type: integer - DatabaseName: - type: string - SslMode: - type: object - $ref: '#/components/schemas/DmsSslModeValue' - CertificateArn: - type: string - AsmServer: - type: string - SecretsManagerOracleAsmSecretId: - type: string - SecretsManagerOracleAsmAccessRoleArn: - type: string - SecretsManagerSecurityDbEncryptionSecretId: - type: string - SecretsManagerSecurityDbEncryptionAccessRoleArn: - type: string - - description: MicrosoftSqlServerSettings property identifier. - type: object + $ref: '#/components/schemas/DmsSslModeValue' + CertificateArn: + type: string + AsmServer: + type: string + SecretsManagerOracleAsmSecretId: + type: string + SecretsManagerOracleAsmAccessRoleArn: + type: string + SecretsManagerSecurityDbEncryptionSecretId: + type: string + SecretsManagerSecurityDbEncryptionAccessRoleArn: + type: string + required: + - ServerName + - Port + - SslMode + - DatabaseName additionalProperties: false + MicrosoftSqlServerSettings: + description: MicrosoftSqlServerSettings property identifier. + type: object properties: - MicrosoftSqlServerSettings: + ServerName: + type: string + Port: + type: integer + DatabaseName: + type: string + SslMode: type: object - additionalProperties: false - properties: - ServerName: - type: string - Port: - type: integer - DatabaseName: - type: string - SslMode: - type: object - $ref: '#/components/schemas/DmsSslModeValue' - CertificateArn: - type: string + $ref: '#/components/schemas/DmsSslModeValue' + CertificateArn: + type: string + required: + - ServerName + - Port + - SslMode + - DatabaseName + additionalProperties: false + anyOf: + - required: + - PostgreSqlSettings + - required: + - MySqlSettings + - required: + - OracleSettings + - required: + - MicrosoftSqlServerSettings + additionalProperties: false Tags: description: An array of key-value pairs to apply to this resource. type: array @@ -1342,7 +1376,7 @@ components: x-cfn-type-name: AWS::DMS::DataProvider x-identifiers: - DataProviderArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1359,9 +1393,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1371,41 +1405,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/data_providers/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/data_providers/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.DataProviderArn') as data_provider_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DMS::DataProvider' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'DataProviderArn') as data_provider_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DMS::DataProvider' - AND region = 'us-east-1' - data_provider: - name: data_provider - id: aws.dms.data_provider - x-cfn-schema-name: DataProvider - x-cfn-type-name: AWS::DMS::DataProvider - x-identifiers: - - DataProviderArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1416,12 +1418,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/data_providers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/data_providers/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/data_provider/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/data_providers/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1439,23 +1445,39 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'DataProviderName') as data_provider_name, - json_extract_path_text(Properties, 'DataProviderIdentifier') as data_provider_identifier, - json_extract_path_text(Properties, 'DataProviderArn') as data_provider_arn, - json_extract_path_text(Properties, 'DataProviderCreationTime') as data_provider_creation_time, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Engine') as engine, - json_extract_path_text(Properties, 'ExactSettings') as exact_settings, - json_extract_path_text(Properties, 'Settings') as settings, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DMS::DataProvider' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.DataProviderArn') as data_provider_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DMS::DataProvider' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DataProviderName') as data_provider_name, + json_extract_path_text(Properties, 'DataProviderIdentifier') as data_provider_identifier, + json_extract_path_text(Properties, 'DataProviderArn') as data_provider_arn, + json_extract_path_text(Properties, 'DataProviderCreationTime') as data_provider_creation_time, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Engine') as engine, + json_extract_path_text(Properties, 'ExactSettings') as exact_settings, + json_extract_path_text(Properties, 'Settings') as settings, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DMS::DataProvider' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DataProviderArn') as data_provider_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DMS::DataProvider' + AND region = 'us-east-1' instance_profiles: name: instance_profiles id: aws.dms.instance_profiles @@ -1463,7 +1485,7 @@ components: x-cfn-type-name: AWS::DMS::InstanceProfile x-identifiers: - InstanceProfileArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1480,9 +1502,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1492,41 +1514,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/instance_profiles/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/instance_profiles/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.InstanceProfileArn') as instance_profile_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DMS::InstanceProfile' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'InstanceProfileArn') as instance_profile_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DMS::InstanceProfile' - AND region = 'us-east-1' - instance_profile: - name: instance_profile - id: aws.dms.instance_profile - x-cfn-schema-name: InstanceProfile - x-cfn-type-name: AWS::DMS::InstanceProfile - x-identifiers: - - InstanceProfileArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1537,12 +1527,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/instance_profiles/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/instance_profiles/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/instance_profile/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/instance_profiles/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1563,26 +1557,42 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'InstanceProfileArn') as instance_profile_arn, - json_extract_path_text(Properties, 'InstanceProfileIdentifier') as instance_profile_identifier, - json_extract_path_text(Properties, 'AvailabilityZone') as availability_zone, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'KmsKeyArn') as kms_key_arn, - json_extract_path_text(Properties, 'PubliclyAccessible') as publicly_accessible, - json_extract_path_text(Properties, 'NetworkType') as network_type, - json_extract_path_text(Properties, 'InstanceProfileName') as instance_profile_name, - json_extract_path_text(Properties, 'InstanceProfileCreationTime') as instance_profile_creation_time, - json_extract_path_text(Properties, 'SubnetGroupIdentifier') as subnet_group_identifier, - json_extract_path_text(Properties, 'VpcSecurityGroups') as vpc_security_groups, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DMS::InstanceProfile' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.InstanceProfileArn') as instance_profile_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DMS::InstanceProfile' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'InstanceProfileArn') as instance_profile_arn, + json_extract_path_text(Properties, 'InstanceProfileIdentifier') as instance_profile_identifier, + json_extract_path_text(Properties, 'AvailabilityZone') as availability_zone, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'KmsKeyArn') as kms_key_arn, + json_extract_path_text(Properties, 'PubliclyAccessible') as publicly_accessible, + json_extract_path_text(Properties, 'NetworkType') as network_type, + json_extract_path_text(Properties, 'InstanceProfileName') as instance_profile_name, + json_extract_path_text(Properties, 'InstanceProfileCreationTime') as instance_profile_creation_time, + json_extract_path_text(Properties, 'SubnetGroupIdentifier') as subnet_group_identifier, + json_extract_path_text(Properties, 'VpcSecurityGroups') as vpc_security_groups, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DMS::InstanceProfile' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'InstanceProfileArn') as instance_profile_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DMS::InstanceProfile' + AND region = 'us-east-1' migration_projects: name: migration_projects id: aws.dms.migration_projects @@ -1590,7 +1600,7 @@ components: x-cfn-type-name: AWS::DMS::MigrationProject x-identifiers: - MigrationProjectArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1607,9 +1617,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1619,41 +1629,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/migration_projects/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/migration_projects/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.MigrationProjectArn') as migration_project_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DMS::MigrationProject' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'MigrationProjectArn') as migration_project_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DMS::MigrationProject' - AND region = 'us-east-1' - migration_project: - name: migration_project - id: aws.dms.migration_project - x-cfn-schema-name: MigrationProject - x-cfn-type-name: AWS::DMS::MigrationProject - x-identifiers: - - MigrationProjectArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1664,12 +1642,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/migration_projects/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/migration_projects/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/migration_project/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/migration_projects/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1691,27 +1673,43 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'MigrationProjectName') as migration_project_name, - json_extract_path_text(Properties, 'MigrationProjectIdentifier') as migration_project_identifier, - json_extract_path_text(Properties, 'MigrationProjectArn') as migration_project_arn, - json_extract_path_text(Properties, 'MigrationProjectCreationTime') as migration_project_creation_time, - json_extract_path_text(Properties, 'InstanceProfileIdentifier') as instance_profile_identifier, - json_extract_path_text(Properties, 'InstanceProfileName') as instance_profile_name, - json_extract_path_text(Properties, 'InstanceProfileArn') as instance_profile_arn, - json_extract_path_text(Properties, 'TransformationRules') as transformation_rules, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'SchemaConversionApplicationAttributes') as schema_conversion_application_attributes, - json_extract_path_text(Properties, 'SourceDataProviderDescriptors') as source_data_provider_descriptors, - json_extract_path_text(Properties, 'TargetDataProviderDescriptors') as target_data_provider_descriptors, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DMS::MigrationProject' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.MigrationProjectArn') as migration_project_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DMS::MigrationProject' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'MigrationProjectName') as migration_project_name, + json_extract_path_text(Properties, 'MigrationProjectIdentifier') as migration_project_identifier, + json_extract_path_text(Properties, 'MigrationProjectArn') as migration_project_arn, + json_extract_path_text(Properties, 'MigrationProjectCreationTime') as migration_project_creation_time, + json_extract_path_text(Properties, 'InstanceProfileIdentifier') as instance_profile_identifier, + json_extract_path_text(Properties, 'InstanceProfileName') as instance_profile_name, + json_extract_path_text(Properties, 'InstanceProfileArn') as instance_profile_arn, + json_extract_path_text(Properties, 'TransformationRules') as transformation_rules, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'SchemaConversionApplicationAttributes') as schema_conversion_application_attributes, + json_extract_path_text(Properties, 'SourceDataProviderDescriptors') as source_data_provider_descriptors, + json_extract_path_text(Properties, 'TargetDataProviderDescriptors') as target_data_provider_descriptors, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DMS::MigrationProject' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'MigrationProjectArn') as migration_project_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DMS::MigrationProject' + AND region = 'us-east-1' replication_configs: name: replication_configs id: aws.dms.replication_configs @@ -1719,7 +1717,7 @@ components: x-cfn-type-name: AWS::DMS::ReplicationConfig x-identifiers: - ReplicationConfigArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1736,9 +1734,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1748,41 +1746,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/replication_configs/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/replication_configs/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ReplicationConfigArn') as replication_config_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DMS::ReplicationConfig' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ReplicationConfigArn') as replication_config_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DMS::ReplicationConfig' - AND region = 'us-east-1' - replication_config: - name: replication_config - id: aws.dms.replication_config - x-cfn-schema-name: ReplicationConfig - x-cfn-type-name: AWS::DMS::ReplicationConfig - x-identifiers: - - ReplicationConfigArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1793,12 +1759,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/replication_configs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/replication_configs/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/replication_config/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/replication_configs/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1818,25 +1788,41 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ReplicationConfigIdentifier') as replication_config_identifier, - json_extract_path_text(Properties, 'ReplicationConfigArn') as replication_config_arn, - json_extract_path_text(Properties, 'SourceEndpointArn') as source_endpoint_arn, - json_extract_path_text(Properties, 'TargetEndpointArn') as target_endpoint_arn, - json_extract_path_text(Properties, 'ReplicationType') as replication_type, - json_extract_path_text(Properties, 'ComputeConfig') as compute_config, - json_extract_path_text(Properties, 'ReplicationSettings') as replication_settings, - json_extract_path_text(Properties, 'SupplementalSettings') as supplemental_settings, - json_extract_path_text(Properties, 'ResourceIdentifier') as resource_identifier, - json_extract_path_text(Properties, 'TableMappings') as table_mappings, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DMS::ReplicationConfig' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ReplicationConfigArn') as replication_config_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DMS::ReplicationConfig' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ReplicationConfigIdentifier') as replication_config_identifier, + json_extract_path_text(Properties, 'ReplicationConfigArn') as replication_config_arn, + json_extract_path_text(Properties, 'SourceEndpointArn') as source_endpoint_arn, + json_extract_path_text(Properties, 'TargetEndpointArn') as target_endpoint_arn, + json_extract_path_text(Properties, 'ReplicationType') as replication_type, + json_extract_path_text(Properties, 'ComputeConfig') as compute_config, + json_extract_path_text(Properties, 'ReplicationSettings') as replication_settings, + json_extract_path_text(Properties, 'SupplementalSettings') as supplemental_settings, + json_extract_path_text(Properties, 'ResourceIdentifier') as resource_identifier, + json_extract_path_text(Properties, 'TableMappings') as table_mappings, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DMS::ReplicationConfig' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ReplicationConfigArn') as replication_config_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DMS::ReplicationConfig' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/docdbelastic.yaml b/providers/src/aws/v00.00.00000/services/docdbelastic.yaml index 0c052739..b462bd95 100644 --- a/providers/src/aws/v00.00.00000/services/docdbelastic.yaml +++ b/providers/src/aws/v00.00.00000/services/docdbelastic.yaml @@ -632,7 +632,7 @@ components: x-cfn-type-name: AWS::DocDBElastic::Cluster x-identifiers: - ClusterArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -649,9 +649,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -661,41 +661,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/clusters/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/clusters/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ClusterArn') as cluster_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DocDBElastic::Cluster' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ClusterArn') as cluster_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DocDBElastic::Cluster' - AND region = 'us-east-1' - cluster: - name: cluster - id: aws.docdbelastic.cluster - x-cfn-schema-name: Cluster - x-cfn-type-name: AWS::DocDBElastic::Cluster - x-identifiers: - - ClusterArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -706,12 +674,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/clusters/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/clusters/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/cluster/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/clusters/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -736,30 +708,46 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ClusterName') as cluster_name, - json_extract_path_text(Properties, 'ClusterArn') as cluster_arn, - json_extract_path_text(Properties, 'ClusterEndpoint') as cluster_endpoint, - json_extract_path_text(Properties, 'AdminUserName') as admin_user_name, - json_extract_path_text(Properties, 'AdminUserPassword') as admin_user_password, - json_extract_path_text(Properties, 'ShardCapacity') as shard_capacity, - json_extract_path_text(Properties, 'ShardCount') as shard_count, - json_extract_path_text(Properties, 'VpcSecurityGroupIds') as vpc_security_group_ids, - json_extract_path_text(Properties, 'SubnetIds') as subnet_ids, - json_extract_path_text(Properties, 'PreferredMaintenanceWindow') as preferred_maintenance_window, - json_extract_path_text(Properties, 'PreferredBackupWindow') as preferred_backup_window, - json_extract_path_text(Properties, 'BackupRetentionPeriod') as backup_retention_period, - json_extract_path_text(Properties, 'ShardInstanceCount') as shard_instance_count, - json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'AuthType') as auth_type - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DocDBElastic::Cluster' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ClusterArn') as cluster_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DocDBElastic::Cluster' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ClusterName') as cluster_name, + json_extract_path_text(Properties, 'ClusterArn') as cluster_arn, + json_extract_path_text(Properties, 'ClusterEndpoint') as cluster_endpoint, + json_extract_path_text(Properties, 'AdminUserName') as admin_user_name, + json_extract_path_text(Properties, 'AdminUserPassword') as admin_user_password, + json_extract_path_text(Properties, 'ShardCapacity') as shard_capacity, + json_extract_path_text(Properties, 'ShardCount') as shard_count, + json_extract_path_text(Properties, 'VpcSecurityGroupIds') as vpc_security_group_ids, + json_extract_path_text(Properties, 'SubnetIds') as subnet_ids, + json_extract_path_text(Properties, 'PreferredMaintenanceWindow') as preferred_maintenance_window, + json_extract_path_text(Properties, 'PreferredBackupWindow') as preferred_backup_window, + json_extract_path_text(Properties, 'BackupRetentionPeriod') as backup_retention_period, + json_extract_path_text(Properties, 'ShardInstanceCount') as shard_instance_count, + json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'AuthType') as auth_type + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DocDBElastic::Cluster' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ClusterArn') as cluster_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DocDBElastic::Cluster' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/dynamodb.yaml b/providers/src/aws/v00.00.00000/services/dynamodb.yaml index 9593e0e0..9b7f1f14 100644 --- a/providers/src/aws/v00.00.00000/services/dynamodb.yaml +++ b/providers/src/aws/v00.00.00000/services/dynamodb.yaml @@ -385,61 +385,56 @@ components: $ref: '#/components/x-cloud-control-schemas/ProgressEvent' type: object schemas: - LocalSecondaryIndex: - description: Represents the properties of a local secondary index. A local secondary index can only be created when its parent table is created. + StreamSpecification: + description: Represents the DynamoDB Streams configuration for a table in DynamoDB. additionalProperties: false type: object properties: - IndexName: - description: The name of the local secondary index. The name must be unique among all other indexes on this table. + StreamViewType: + description: |- + When an item in the table is modified, ``StreamViewType`` determines what information is written to the stream for this table. Valid values for ``StreamViewType`` are: + + ``KEYS_ONLY`` - Only the key attributes of the modified item are written to the stream. + + ``NEW_IMAGE`` - The entire item, as it appears after it was modified, is written to the stream. + + ``OLD_IMAGE`` - The entire item, as it appeared before it was modified, is written to the stream. + + ``NEW_AND_OLD_IMAGES`` - Both the new and the old item images of the item are written to the stream. type: string - Projection: - description: Represents attributes that are copied (projected) from the table into the local secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. - $ref: '#/components/schemas/Projection' - KeySchema: - uniqueItems: true + ResourcePolicy: description: |- - The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types: - + ``HASH`` - partition key - + ``RANGE`` - sort key - - The partition key of an item is also known as its *hash attribute*. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. - The sort key of an item is also known as its *range attribute*. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value. - type: array - items: - $ref: '#/components/schemas/KeySchema' + Creates or updates a resource-based policy document that contains the permissions for DDB resources, such as a table's streams. Resource-based policies let you define access permissions by specifying who has access to each resource, and the actions they are allowed to perform on each resource. + In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see [Using resource-based policies for](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html). + $ref: '#/components/schemas/ResourcePolicy' required: - - IndexName - - Projection - - KeySchema - SSESpecification: - description: Represents the settings used to enable server-side encryption. + - StreamViewType + ResourcePolicy: + description: |- + Creates or updates a resource-based policy document that contains the permissions for DDB resources, such as a table, its indexes, and stream. Resource-based policies let you define access permissions by specifying who has access to each resource, and the actions they are allowed to perform on each resource. + In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see [Using resource-based policies for](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html). + While defining resource-based policies in your CFNshort templates, the following considerations apply: + + The maximum size supported for a resource-based policy document in JSON format is 20 KB. DDB counts whitespaces when calculating the size of a policy against this limit. + + Resource-based policies don't support [drift detection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html#). If you update a policy outside of the CFNshort stack template, you'll need to update the CFNshort stack with the changes. + + Resource-based policies don't support out-of-band changes. If you add, update, or delete a policy outside of the CFNshort template, the change won't be overwritten if there are no changes to the policy within the template. + For example, say that your template contains a resource-based policy, which you later update outside of the template. If you don't make any changes to the policy in the template, the updated policy in DDB won’t be synced with the policy in the template. + Conversely, say that your template doesn’t contain a resource-based policy, but you add a policy outside of the template. This policy won’t be removed from DDB as long as you don’t add it to the template. When you add a policy to the template and update the stack, the existing policy in DDB will be updated to match the one defined in the template. + + For a full list of all considerations, see [Resource-based policy considerations](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-considerations.html). additionalProperties: false type: object properties: - SSEEnabled: - description: Indicates whether server-side encryption is done using an AWS managed key or an AWS owned key. If enabled (true), server-side encryption type is set to ``KMS`` and an AWS managed key is used (KMS charges apply). If disabled (false) or not specified, server-side encryption is set to AWS owned key. - type: boolean - SSEType: - description: |- - Server-side encryption type. The only supported value is: - + ``KMS`` - Server-side encryption that uses KMSlong. The key is stored in your account and is managed by KMS (KMS charges apply). - type: string - KMSMasterKeyId: - anyOf: - - relationshipRef: - typeName: AWS::KMS::Key - propertyPath: /properties/Arn - - relationshipRef: - typeName: AWS::KMS::Key - propertyPath: /properties/KeyId - - relationshipRef: - typeName: AWS::KMS::Alias - propertyPath: /properties/AliasName - description: The KMS key that should be used for the KMS encryption. To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB key ``alias/aws/dynamodb``. - type: string + PolicyDocument: + description: >- + A resource-based policy document that contains permissions to add to the specified DDB table, index, or both. In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see [Using resource-based policies for](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy + examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html). + type: object required: - - SSEEnabled + - PolicyDocument + ReplicaStreamSpecification: + type: object + additionalProperties: false + properties: + ResourcePolicy: + $ref: '#/components/schemas/ResourcePolicy' + required: + - ResourcePolicy KinesisStreamSpecification: description: The Kinesis Data Streams configuration for the specified table. additionalProperties: false @@ -461,172 +456,120 @@ components: type: string required: - StreamArn - StreamSpecification: - description: Represents the DynamoDB Streams configuration for a table in DynamoDB. + KeySchema: + description: |- + Represents *a single element* of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index. + A ``KeySchemaElement`` represents exactly one attribute of the primary key. For example, a simple primary key would be represented by one ``KeySchemaElement`` (for the partition key). A composite primary key would require one ``KeySchemaElement`` for the partition key, and another ``KeySchemaElement`` for the sort key. + A ``KeySchemaElement`` must be a scalar, top-level attribute (not a nested attribute). The data type must be one of String, Number, or Binary. The attribute cannot be nested within a List or a Map. additionalProperties: false type: object properties: - StreamViewType: + KeyType: description: |- - When an item in the table is modified, ``StreamViewType`` determines what information is written to the stream for this table. Valid values for ``StreamViewType`` are: - + ``KEYS_ONLY`` - Only the key attributes of the modified item are written to the stream. - + ``NEW_IMAGE`` - The entire item, as it appears after it was modified, is written to the stream. - + ``OLD_IMAGE`` - The entire item, as it appeared before it was modified, is written to the stream. - + ``NEW_AND_OLD_IMAGES`` - Both the new and the old item images of the item are written to the stream. + The role that this key attribute will assume: + + ``HASH`` - partition key + + ``RANGE`` - sort key + + The partition key of an item is also known as its *hash attribute*. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. + The sort key of an item is also known as its *range attribute*. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value. + type: string + AttributeName: + description: The name of a key attribute. type: string - ResourcePolicy: - description: |- - Creates or updates a resource-based policy document that contains the permissions for DDB resources, such as a table's streams. Resource-based policies let you define access permissions by specifying who has access to each resource, and the actions they are allowed to perform on each resource. - In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see [Using resource-based policies for](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html). - $ref: '#/components/schemas/ResourcePolicy' required: - - StreamViewType - ContributorInsightsSpecification: - description: The settings used to enable or disable CloudWatch Contributor Insights. + - KeyType + - AttributeName + PointInTimeRecoverySpecification: + description: The settings used to enable point in time recovery. additionalProperties: false type: object properties: - Enabled: - description: Indicates whether CloudWatch Contributor Insights are to be enabled (true) or disabled (false). + PointInTimeRecoveryEnabled: + description: Indicates whether point in time recovery is enabled (true) or disabled (false) on the table. type: boolean - required: - - Enabled ReplicaSpecification: - additionalProperties: false type: object + additionalProperties: false properties: - SSESpecification: - $ref: '#/components/schemas/ReplicaSSESpecification' - KinesisStreamSpecification: - $ref: '#/components/schemas/KinesisStreamSpecification' - ContributorInsightsSpecification: - $ref: '#/components/schemas/ContributorInsightsSpecification' - PointInTimeRecoverySpecification: - $ref: '#/components/schemas/PointInTimeRecoverySpecification' - ReplicaStreamSpecification: - $ref: '#/components/schemas/ReplicaStreamSpecification' + Region: + type: string GlobalSecondaryIndexes: + type: array uniqueItems: true x-insertionOrder: false - type: array items: $ref: '#/components/schemas/ReplicaGlobalSecondaryIndexSpecification' - Region: - type: string - ResourcePolicy: - $ref: '#/components/schemas/ResourcePolicy' - ReadProvisionedThroughputSettings: - $ref: '#/components/schemas/ReadProvisionedThroughputSettings' + ContributorInsightsSpecification: + $ref: '#/components/schemas/ContributorInsightsSpecification' + PointInTimeRecoverySpecification: + $ref: '#/components/schemas/PointInTimeRecoverySpecification' TableClass: type: string DeletionProtectionEnabled: type: boolean + SSESpecification: + $ref: '#/components/schemas/ReplicaSSESpecification' Tags: - uniqueItems: true - x-insertionOrder: false type: array + x-insertionOrder: false + uniqueItems: true items: $ref: '#/components/schemas/Tag' + ReadProvisionedThroughputSettings: + $ref: '#/components/schemas/ReadProvisionedThroughputSettings' + ReadOnDemandThroughputSettings: + $ref: '#/components/schemas/ReadOnDemandThroughputSettings' + KinesisStreamSpecification: + $ref: '#/components/schemas/KinesisStreamSpecification' + ResourcePolicy: + $ref: '#/components/schemas/ResourcePolicy' + ReplicaStreamSpecification: + $ref: '#/components/schemas/ReplicaStreamSpecification' required: - Region - CapacityAutoScalingSettings: - additionalProperties: false - type: object - properties: - MinCapacity: - type: integer - minimum: 1 - SeedCapacity: - type: integer - minimum: 1 - TargetTrackingScalingPolicyConfiguration: - $ref: '#/components/schemas/TargetTrackingScalingPolicyConfiguration' - MaxCapacity: - type: integer - minimum: 1 - required: - - MinCapacity - - MaxCapacity - - TargetTrackingScalingPolicyConfiguration - AttributeDefinition: - description: Represents an attribute for describing the schema for the table and indexes. + TimeToLiveSpecification: + description: Represents the settings used to enable or disable Time to Live (TTL) for the specified table. additionalProperties: false type: object properties: - AttributeType: - description: |- - The data type for the attribute, where: - + ``S`` - the attribute is of type String - + ``N`` - the attribute is of type Number - + ``B`` - the attribute is of type Binary - type: string + Enabled: + description: Indicates whether TTL is to be enabled (true) or disabled (false) on the table. + type: boolean AttributeName: - description: A name for the attribute. + description: |- + The name of the TTL attribute used to store the expiration time for items in the table. + + The ``AttributeName`` property is required when enabling the TTL, or when TTL is already enabled. + + To update this property, you must first disable TTL and then enable TTL with the new attribute name. type: string required: - - AttributeName - - AttributeType - Projection: - description: Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. + - Enabled + LocalSecondaryIndex: + description: Represents the properties of a local secondary index. A local secondary index can only be created when its parent table is created. additionalProperties: false type: object properties: - NonKeyAttributes: - uniqueItems: false + IndexName: + description: The name of the local secondary index. The name must be unique among all other indexes on this table. + type: string + Projection: + description: Represents attributes that are copied (projected) from the table into the local secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. + $ref: '#/components/schemas/Projection' + KeySchema: + uniqueItems: true description: |- - Represents the non-key attribute names which will be projected into the index. - For local secondary indexes, the total count of ``NonKeyAttributes`` summed across all of the local secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total. + The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types: + + ``HASH`` - partition key + + ``RANGE`` - sort key + + The partition key of an item is also known as its *hash attribute*. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. + The sort key of an item is also known as its *range attribute*. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value. type: array items: - type: string - ProjectionType: - description: |- - The set of attributes that are projected into the index: - + ``KEYS_ONLY`` - Only the index and primary keys are projected into the index. - + ``INCLUDE`` - In addition to the attributes described in ``KEYS_ONLY``, the secondary index will include other non-key attributes that you specify. - + ``ALL`` - All of the table attributes are projected into the index. - - When using the DynamoDB console, ``ALL`` is selected by default. - type: string - PointInTimeRecoverySpecification: - description: The settings used to enable point in time recovery. - additionalProperties: false - type: object - properties: - PointInTimeRecoveryEnabled: - description: Indicates whether point in time recovery is enabled (true) or disabled (false) on the table. - type: boolean - ReplicaGlobalSecondaryIndexSpecification: - additionalProperties: false - type: object - properties: - IndexName: - minLength: 3 - type: string - maxLength: 255 - ContributorInsightsSpecification: - $ref: '#/components/schemas/ContributorInsightsSpecification' - ReadProvisionedThroughputSettings: - $ref: '#/components/schemas/ReadProvisionedThroughputSettings' + $ref: '#/components/schemas/KeySchema' required: - IndexName - TargetTrackingScalingPolicyConfiguration: - additionalProperties: false - type: object - properties: - ScaleOutCooldown: - type: integer - minimum: 0 - TargetValue: - format: double - type: number - DisableScaleIn: - type: boolean - ScaleInCooldown: - type: integer - minimum: 0 - required: - - TargetValue + - Projection + - KeySchema GlobalSecondaryIndex: description: Represents the properties of a global secondary index. additionalProperties: false @@ -635,6 +578,9 @@ components: IndexName: description: The name of the global secondary index. The name must be unique among all other indexes on this table. type: string + OnDemandThroughput: + description: The maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify ``MaxReadRequestUnits``, ``MaxWriteRequestUnits``, or both. + $ref: '#/components/schemas/OnDemandThroughput' ContributorInsightsSpecification: description: The settings used to enable or disable CloudWatch Contributor Insights for the specified global secondary index. $ref: '#/components/schemas/ContributorInsightsSpecification' @@ -662,25 +608,40 @@ components: - IndexName - Projection - KeySchema - WriteProvisionedThroughputSettings: - additionalProperties: false - type: object - properties: - WriteCapacityAutoScalingSettings: - $ref: '#/components/schemas/CapacityAutoScalingSettings' - ReplicaStreamSpecification: + SSESpecification: + description: Represents the settings used to enable server-side encryption. additionalProperties: false type: object properties: - ResourcePolicy: - $ref: '#/components/schemas/ResourcePolicy' + SSEEnabled: + description: Indicates whether server-side encryption is done using an AWS managed key or an AWS owned key. If enabled (true), server-side encryption type is set to ``KMS`` and an AWS managed key is used (KMS charges apply). If disabled (false) or not specified, server-side encryption is set to AWS owned key. + type: boolean + SSEType: + description: |- + Server-side encryption type. The only supported value is: + + ``KMS`` - Server-side encryption that uses KMSlong. The key is stored in your account and is managed by KMS (KMS charges apply). + type: string + KMSMasterKeyId: + anyOf: + - relationshipRef: + typeName: AWS::KMS::Key + propertyPath: /properties/Arn + - relationshipRef: + typeName: AWS::KMS::Key + propertyPath: /properties/KeyId + - relationshipRef: + typeName: AWS::KMS::Alias + propertyPath: /properties/AliasName + description: The KMS key that should be used for the KMS encryption. To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB key ``alias/aws/dynamodb``. + type: string required: - - ResourcePolicy + - SSEEnabled ReplicaSSESpecification: - additionalProperties: false type: object + additionalProperties: false properties: KMSMasterKeyId: + type: string anyOf: - relationshipRef: typeName: AWS::KMS::Key @@ -691,54 +652,26 @@ components: - relationshipRef: typeName: AWS::KMS::Alias propertyPath: /properties/AliasName - type: string required: - KMSMasterKeyId - ResourcePolicy: - description: |- - Creates or updates a resource-based policy document that contains the permissions for DDB resources, such as a table, its indexes, and stream. Resource-based policies let you define access permissions by specifying who has access to each resource, and the actions they are allowed to perform on each resource. - In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see [Using resource-based policies for](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html). - While defining resource-based policies in your CFNshort templates, the following considerations apply: - + The maximum size supported for a resource-based policy document in JSON format is 20 KB. DDB counts whitespaces when calculating the size of a policy against this limit. - + Resource-based policies don't support [drift detection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html#). If you update a policy outside of the CFNshort stack template, you'll need to update the CFNshort stack with the changes. - + Resource-based policies don't support out-of-band changes. If you add, update, or delete a policy outside of the CFNshort template, the change won't be overwritten if there are no changes to the policy within the template. - For example, say that your template contains a resource-based policy, which you later update outside of the template. If you don't make any changes to the policy in the template, the updated policy in DDB won’t be synced with the policy in the template. - Conversely, say that your template doesn’t contain a resource-based policy, but you add a policy outside of the template. This policy won’t be removed from DDB as long as you don’t add it to the template. When you add a policy to the template and update the stack, the existing policy in DDB will be updated to match the one defined in the template. - - For a full list of all considerations, see [Resource-based policy considerations](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-considerations.html). - additionalProperties: false - type: object - properties: - PolicyDocument: - description: >- - A resource-based policy document that contains permissions to add to the specified DDB table, index, or both. In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see [Using resource-based policies for](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy - examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html). - type: object - required: - - PolicyDocument - KeySchema: - description: |- - Represents *a single element* of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index. - A ``KeySchemaElement`` represents exactly one attribute of the primary key. For example, a simple primary key would be represented by one ``KeySchemaElement`` (for the partition key). A composite primary key would require one ``KeySchemaElement`` for the partition key, and another ``KeySchemaElement`` for the sort key. - A ``KeySchemaElement`` must be a scalar, top-level attribute (not a nested attribute). The data type must be one of String, Number, or Binary. The attribute cannot be nested within a List or a Map. + AttributeDefinition: + description: Represents an attribute for describing the schema for the table and indexes. additionalProperties: false type: object properties: - KeyType: + AttributeType: description: |- - The role that this key attribute will assume: - + ``HASH`` - partition key - + ``RANGE`` - sort key - - The partition key of an item is also known as its *hash attribute*. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. - The sort key of an item is also known as its *range attribute*. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value. + The data type for the attribute, where: + + ``S`` - the attribute is of type String + + ``N`` - the attribute is of type Number + + ``B`` - the attribute is of type Binary type: string AttributeName: - description: The name of a key attribute. + description: A name for the attribute. type: string required: - - KeyType - AttributeName + - AttributeType Tag: description: |- Describes a tag. A tag is a key-value pair. You can add up to 50 tags to a single DynamoDB table. @@ -756,82 +689,172 @@ components: required: - Value - Key + Projection: + description: Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. + additionalProperties: false + type: object + properties: + NonKeyAttributes: + uniqueItems: false + description: |- + Represents the non-key attribute names which will be projected into the index. + For local secondary indexes, the total count of ``NonKeyAttributes`` summed across all of the local secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total. + type: array + items: + type: string + ProjectionType: + description: |- + The set of attributes that are projected into the index: + + ``KEYS_ONLY`` - Only the index and primary keys are projected into the index. + + ``INCLUDE`` - In addition to the attributes described in ``KEYS_ONLY``, the secondary index will include other non-key attributes that you specify. + + ``ALL`` - All of the table attributes are projected into the index. + + When using the DynamoDB console, ``ALL`` is selected by default. + type: string + ReplicaGlobalSecondaryIndexSpecification: + type: object + additionalProperties: false + properties: + IndexName: + type: string + minLength: 3 + maxLength: 255 + ContributorInsightsSpecification: + $ref: '#/components/schemas/ContributorInsightsSpecification' + ReadProvisionedThroughputSettings: + $ref: '#/components/schemas/ReadProvisionedThroughputSettings' + ReadOnDemandThroughputSettings: + $ref: '#/components/schemas/ReadOnDemandThroughputSettings' + required: + - IndexName + ContributorInsightsSpecification: + description: The settings used to enable or disable CloudWatch Contributor Insights. + additionalProperties: false + type: object + properties: + Enabled: + description: Indicates whether CloudWatch Contributor Insights are to be enabled (true) or disabled (false). + type: boolean + required: + - Enabled ReadProvisionedThroughputSettings: + type: object + additionalProperties: false + properties: + ReadCapacityUnits: + type: integer + minimum: 1 + ReadCapacityAutoScalingSettings: + $ref: '#/components/schemas/CapacityAutoScalingSettings' + WriteProvisionedThroughputSettings: + type: object additionalProperties: false + properties: + WriteCapacityAutoScalingSettings: + $ref: '#/components/schemas/CapacityAutoScalingSettings' + ReadOnDemandThroughputSettings: + type: object + additionalProperties: false + properties: + MaxReadRequestUnits: + type: integer + minimum: 1 + WriteOnDemandThroughputSettings: + type: object + additionalProperties: false + properties: + MaxWriteRequestUnits: + type: integer + minimum: 1 + CapacityAutoScalingSettings: type: object + additionalProperties: false properties: - ReadCapacityUnits: + MinCapacity: type: integer minimum: 1 - ReadCapacityAutoScalingSettings: - $ref: '#/components/schemas/CapacityAutoScalingSettings' - TimeToLiveSpecification: - description: Represents the settings used to enable or disable Time to Live (TTL) for the specified table. - additionalProperties: false + MaxCapacity: + type: integer + minimum: 1 + SeedCapacity: + type: integer + minimum: 1 + TargetTrackingScalingPolicyConfiguration: + $ref: '#/components/schemas/TargetTrackingScalingPolicyConfiguration' + required: + - MinCapacity + - MaxCapacity + - TargetTrackingScalingPolicyConfiguration + TargetTrackingScalingPolicyConfiguration: type: object + additionalProperties: false properties: - Enabled: - description: Indicates whether TTL is to be enabled (true) or disabled (false) on the table. + DisableScaleIn: type: boolean - AttributeName: - description: |- - The name of the TTL attribute used to store the expiration time for items in the table. - + The ``AttributeName`` property is required when enabling the TTL, or when TTL is already enabled. - + To update this property, you must first disable TTL and then enable TTL with the new attribute name. - type: string + ScaleInCooldown: + type: integer + minimum: 0 + ScaleOutCooldown: + type: integer + minimum: 0 + TargetValue: + type: number + format: double required: - - Enabled + - TargetValue GlobalTable: type: object properties: - TableId: + Arn: type: string - SSESpecification: - $ref: '#/components/schemas/SSESpecification' - StreamSpecification: - $ref: '#/components/schemas/StreamSpecification' - Replicas: - minItems: 1 - uniqueItems: true - x-insertionOrder: false - type: array - items: - $ref: '#/components/schemas/ReplicaSpecification' - WriteProvisionedThroughputSettings: - $ref: '#/components/schemas/WriteProvisionedThroughputSettings' - TableName: + StreamArn: type: string AttributeDefinitions: - minItems: 1 + type: array uniqueItems: true x-insertionOrder: false - type: array items: $ref: '#/components/schemas/AttributeDefinition' + minItems: 1 BillingMode: type: string GlobalSecondaryIndexes: + type: array uniqueItems: true x-insertionOrder: false - type: array items: $ref: '#/components/schemas/GlobalSecondaryIndex' KeySchema: - minItems: 1 - maxItems: 2 - uniqueItems: true type: array + uniqueItems: true items: $ref: '#/components/schemas/KeySchema' + minItems: 1 + maxItems: 2 LocalSecondaryIndexes: + type: array uniqueItems: true x-insertionOrder: false - type: array items: $ref: '#/components/schemas/LocalSecondaryIndex' - Arn: + WriteProvisionedThroughputSettings: + $ref: '#/components/schemas/WriteProvisionedThroughputSettings' + WriteOnDemandThroughputSettings: + $ref: '#/components/schemas/WriteOnDemandThroughputSettings' + Replicas: + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/ReplicaSpecification' + minItems: 1 + SSESpecification: + $ref: '#/components/schemas/SSESpecification' + StreamSpecification: + $ref: '#/components/schemas/StreamSpecification' + TableName: type: string - StreamArn: + TableId: type: string TimeToLiveSpecification: $ref: '#/components/schemas/TimeToLiveSpecification' @@ -865,13 +888,6 @@ components: - AttributeDefinitions - Replicas x-required-permissions: - read: - - dynamodb:Describe* - - dynamodb:GetResourcePolicy - - application-autoscaling:Describe* - - cloudwatch:PutMetricData - - dynamodb:ListTagsOfResource - - kms:DescribeKey create: - dynamodb:CreateTable - dynamodb:CreateTableReplica @@ -911,6 +927,13 @@ components: - kms:RevokeGrant - cloudwatch:PutMetricData - iam:CreateServiceLinkedRole + read: + - dynamodb:Describe* + - dynamodb:GetResourcePolicy + - application-autoscaling:Describe* + - cloudwatch:PutMetricData + - dynamodb:ListTagsOfResource + - kms:DescribeKey update: - dynamodb:Describe* - dynamodb:CreateTableReplica @@ -953,9 +976,6 @@ components: - kms:ListAliases - kms:RevokeGrant - cloudwatch:PutMetricData - list: - - dynamodb:ListTables - - cloudwatch:PutMetricData delete: - dynamodb:Describe* - dynamodb:DeleteTable @@ -966,6 +986,26 @@ components: - application-autoscaling:PutScalingPolicy - application-autoscaling:PutScheduledAction - application-autoscaling:RegisterScalableTarget + list: + - dynamodb:ListTables + - cloudwatch:PutMetricData + OnDemandThroughput: + description: Sets the maximum number of read and write units for the specified on-demand table. If you use this property, you must specify ``MaxReadRequestUnits``, ``MaxWriteRequestUnits``, or both. + additionalProperties: false + type: object + properties: + MaxReadRequestUnits: + description: |- + Maximum number of read request units for the specified table. + To specify a maximum ``OnDemandThroughput`` on your table, set the value of ``MaxReadRequestUnits`` as greater than or equal to 1. To remove the maximum ``OnDemandThroughput`` that is currently set on your table, set the value of ``MaxReadRequestUnits`` to -1. + type: integer + minimum: 1 + MaxWriteRequestUnits: + description: |- + Maximum number of write request units for the specified table. + To specify a maximum ``OnDemandThroughput`` on your table, set the value of ``MaxWriteRequestUnits`` as greater than or equal to 1. To remove the maximum ``OnDemandThroughput`` that is currently set on your table, set the value of ``MaxWriteRequestUnits`` to -1. + type: integer + minimum: 1 InputFormatOptions: description: The format options for the data that was imported into the target table. There is one value, CsvOption. additionalProperties: false @@ -1069,6 +1109,9 @@ components: Table: type: object properties: + OnDemandThroughput: + description: Sets the maximum number of read and write units for the specified on-demand table. If you use this property, you must specify ``MaxReadRequestUnits``, ``MaxWriteRequestUnits``, or both. + $ref: '#/components/schemas/OnDemandThroughput' SSESpecification: description: Specifies the settings to enable server-side encryption. $ref: '#/components/schemas/SSESpecification' @@ -1291,54 +1334,56 @@ components: DesiredState: type: object properties: - TableId: + Arn: type: string - SSESpecification: - $ref: '#/components/schemas/SSESpecification' - StreamSpecification: - $ref: '#/components/schemas/StreamSpecification' - Replicas: - minItems: 1 - uniqueItems: true - x-insertionOrder: false - type: array - items: - $ref: '#/components/schemas/ReplicaSpecification' - WriteProvisionedThroughputSettings: - $ref: '#/components/schemas/WriteProvisionedThroughputSettings' - TableName: + StreamArn: type: string AttributeDefinitions: - minItems: 1 + type: array uniqueItems: true x-insertionOrder: false - type: array items: $ref: '#/components/schemas/AttributeDefinition' + minItems: 1 BillingMode: type: string GlobalSecondaryIndexes: + type: array uniqueItems: true x-insertionOrder: false - type: array items: $ref: '#/components/schemas/GlobalSecondaryIndex' KeySchema: - minItems: 1 - maxItems: 2 - uniqueItems: true type: array + uniqueItems: true items: $ref: '#/components/schemas/KeySchema' + minItems: 1 + maxItems: 2 LocalSecondaryIndexes: + type: array uniqueItems: true x-insertionOrder: false - type: array items: $ref: '#/components/schemas/LocalSecondaryIndex' - Arn: + WriteProvisionedThroughputSettings: + $ref: '#/components/schemas/WriteProvisionedThroughputSettings' + WriteOnDemandThroughputSettings: + $ref: '#/components/schemas/WriteOnDemandThroughputSettings' + Replicas: + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/ReplicaSpecification' + minItems: 1 + SSESpecification: + $ref: '#/components/schemas/SSESpecification' + StreamSpecification: + $ref: '#/components/schemas/StreamSpecification' + TableName: type: string - StreamArn: + TableId: type: string TimeToLiveSpecification: $ref: '#/components/schemas/TimeToLiveSpecification' @@ -1359,6 +1404,9 @@ components: DesiredState: type: object properties: + OnDemandThroughput: + description: Sets the maximum number of read and write units for the specified on-demand table. If you use this property, you must specify ``MaxReadRequestUnits``, ``MaxWriteRequestUnits``, or both. + $ref: '#/components/schemas/OnDemandThroughput' SSESpecification: description: Specifies the settings to enable server-side encryption. $ref: '#/components/schemas/SSESpecification' @@ -1483,7 +1531,7 @@ components: x-cfn-type-name: AWS::DynamoDB::GlobalTable x-identifiers: - TableName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1500,9 +1548,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1512,41 +1560,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/global_tables/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/global_tables/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.TableName') as table_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DynamoDB::GlobalTable' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'TableName') as table_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DynamoDB::GlobalTable' - AND region = 'us-east-1' - global_table: - name: global_table - id: aws.dynamodb.global_table - x-cfn-schema-name: GlobalTable - x-cfn-type-name: AWS::DynamoDB::GlobalTable - x-identifiers: - - TableName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1557,56 +1573,78 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/global_tables/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/global_tables/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/global_table/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/global_tables/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.TableId') as table_id, - JSON_EXTRACT(Properties, '$.SSESpecification') as sse_specification, - JSON_EXTRACT(Properties, '$.StreamSpecification') as stream_specification, - JSON_EXTRACT(Properties, '$.Replicas') as replicas, - JSON_EXTRACT(Properties, '$.WriteProvisionedThroughputSettings') as write_provisioned_throughput_settings, - JSON_EXTRACT(Properties, '$.TableName') as table_name, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.StreamArn') as stream_arn, JSON_EXTRACT(Properties, '$.AttributeDefinitions') as attribute_definitions, JSON_EXTRACT(Properties, '$.BillingMode') as billing_mode, JSON_EXTRACT(Properties, '$.GlobalSecondaryIndexes') as global_secondary_indexes, JSON_EXTRACT(Properties, '$.KeySchema') as key_schema, JSON_EXTRACT(Properties, '$.LocalSecondaryIndexes') as local_secondary_indexes, - JSON_EXTRACT(Properties, '$.Arn') as arn, - JSON_EXTRACT(Properties, '$.StreamArn') as stream_arn, + JSON_EXTRACT(Properties, '$.WriteProvisionedThroughputSettings') as write_provisioned_throughput_settings, + JSON_EXTRACT(Properties, '$.WriteOnDemandThroughputSettings') as write_on_demand_throughput_settings, + JSON_EXTRACT(Properties, '$.Replicas') as replicas, + JSON_EXTRACT(Properties, '$.SSESpecification') as sse_specification, + JSON_EXTRACT(Properties, '$.StreamSpecification') as stream_specification, + JSON_EXTRACT(Properties, '$.TableName') as table_name, + JSON_EXTRACT(Properties, '$.TableId') as table_id, JSON_EXTRACT(Properties, '$.TimeToLiveSpecification') as time_to_live_specification FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DynamoDB::GlobalTable' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'TableId') as table_id, - json_extract_path_text(Properties, 'SSESpecification') as sse_specification, - json_extract_path_text(Properties, 'StreamSpecification') as stream_specification, - json_extract_path_text(Properties, 'Replicas') as replicas, - json_extract_path_text(Properties, 'WriteProvisionedThroughputSettings') as write_provisioned_throughput_settings, - json_extract_path_text(Properties, 'TableName') as table_name, - json_extract_path_text(Properties, 'AttributeDefinitions') as attribute_definitions, - json_extract_path_text(Properties, 'BillingMode') as billing_mode, - json_extract_path_text(Properties, 'GlobalSecondaryIndexes') as global_secondary_indexes, - json_extract_path_text(Properties, 'KeySchema') as key_schema, - json_extract_path_text(Properties, 'LocalSecondaryIndexes') as local_secondary_indexes, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'StreamArn') as stream_arn, - json_extract_path_text(Properties, 'TimeToLiveSpecification') as time_to_live_specification - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DynamoDB::GlobalTable' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.TableName') as table_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DynamoDB::GlobalTable' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'StreamArn') as stream_arn, + json_extract_path_text(Properties, 'AttributeDefinitions') as attribute_definitions, + json_extract_path_text(Properties, 'BillingMode') as billing_mode, + json_extract_path_text(Properties, 'GlobalSecondaryIndexes') as global_secondary_indexes, + json_extract_path_text(Properties, 'KeySchema') as key_schema, + json_extract_path_text(Properties, 'LocalSecondaryIndexes') as local_secondary_indexes, + json_extract_path_text(Properties, 'WriteProvisionedThroughputSettings') as write_provisioned_throughput_settings, + json_extract_path_text(Properties, 'WriteOnDemandThroughputSettings') as write_on_demand_throughput_settings, + json_extract_path_text(Properties, 'Replicas') as replicas, + json_extract_path_text(Properties, 'SSESpecification') as sse_specification, + json_extract_path_text(Properties, 'StreamSpecification') as stream_specification, + json_extract_path_text(Properties, 'TableName') as table_name, + json_extract_path_text(Properties, 'TableId') as table_id, + json_extract_path_text(Properties, 'TimeToLiveSpecification') as time_to_live_specification + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DynamoDB::GlobalTable' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'TableName') as table_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DynamoDB::GlobalTable' + AND region = 'us-east-1' tables: name: tables id: aws.dynamodb.tables @@ -1614,7 +1652,7 @@ components: x-cfn-type-name: AWS::DynamoDB::Table x-identifiers: - TableName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1631,9 +1669,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1643,41 +1681,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/tables/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/tables/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.TableName') as table_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DynamoDB::Table' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'TableName') as table_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DynamoDB::Table' - AND region = 'us-east-1' - table: - name: table - id: aws.dynamodb.table - x-cfn-schema-name: Table - x-cfn-type-name: AWS::DynamoDB::Table - x-identifiers: - - TableName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1688,16 +1694,21 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/tables/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/tables/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/table/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/tables/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, + JSON_EXTRACT(Properties, '$.OnDemandThroughput') as on_demand_throughput, JSON_EXTRACT(Properties, '$.SSESpecification') as sse_specification, JSON_EXTRACT(Properties, '$.KinesisStreamSpecification') as kinesis_stream_specification, JSON_EXTRACT(Properties, '$.StreamSpecification') as stream_specification, @@ -1722,34 +1733,51 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'SSESpecification') as sse_specification, - json_extract_path_text(Properties, 'KinesisStreamSpecification') as kinesis_stream_specification, - json_extract_path_text(Properties, 'StreamSpecification') as stream_specification, - json_extract_path_text(Properties, 'ContributorInsightsSpecification') as contributor_insights_specification, - json_extract_path_text(Properties, 'ImportSourceSpecification') as import_source_specification, - json_extract_path_text(Properties, 'PointInTimeRecoverySpecification') as point_in_time_recovery_specification, - json_extract_path_text(Properties, 'ProvisionedThroughput') as provisioned_throughput, - json_extract_path_text(Properties, 'TableName') as table_name, - json_extract_path_text(Properties, 'AttributeDefinitions') as attribute_definitions, - json_extract_path_text(Properties, 'BillingMode') as billing_mode, - json_extract_path_text(Properties, 'GlobalSecondaryIndexes') as global_secondary_indexes, - json_extract_path_text(Properties, 'ResourcePolicy') as resource_policy, - json_extract_path_text(Properties, 'KeySchema') as key_schema, - json_extract_path_text(Properties, 'LocalSecondaryIndexes') as local_secondary_indexes, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'StreamArn') as stream_arn, - json_extract_path_text(Properties, 'DeletionProtectionEnabled') as deletion_protection_enabled, - json_extract_path_text(Properties, 'TableClass') as table_class, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'TimeToLiveSpecification') as time_to_live_specification - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DynamoDB::Table' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.TableName') as table_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DynamoDB::Table' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'OnDemandThroughput') as on_demand_throughput, + json_extract_path_text(Properties, 'SSESpecification') as sse_specification, + json_extract_path_text(Properties, 'KinesisStreamSpecification') as kinesis_stream_specification, + json_extract_path_text(Properties, 'StreamSpecification') as stream_specification, + json_extract_path_text(Properties, 'ContributorInsightsSpecification') as contributor_insights_specification, + json_extract_path_text(Properties, 'ImportSourceSpecification') as import_source_specification, + json_extract_path_text(Properties, 'PointInTimeRecoverySpecification') as point_in_time_recovery_specification, + json_extract_path_text(Properties, 'ProvisionedThroughput') as provisioned_throughput, + json_extract_path_text(Properties, 'TableName') as table_name, + json_extract_path_text(Properties, 'AttributeDefinitions') as attribute_definitions, + json_extract_path_text(Properties, 'BillingMode') as billing_mode, + json_extract_path_text(Properties, 'GlobalSecondaryIndexes') as global_secondary_indexes, + json_extract_path_text(Properties, 'ResourcePolicy') as resource_policy, + json_extract_path_text(Properties, 'KeySchema') as key_schema, + json_extract_path_text(Properties, 'LocalSecondaryIndexes') as local_secondary_indexes, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'StreamArn') as stream_arn, + json_extract_path_text(Properties, 'DeletionProtectionEnabled') as deletion_protection_enabled, + json_extract_path_text(Properties, 'TableClass') as table_class, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'TimeToLiveSpecification') as time_to_live_specification + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::DynamoDB::Table' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'TableName') as table_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::DynamoDB::Table' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/ec2.yaml b/providers/src/aws/v00.00.00000/services/ec2.yaml index d549e600..c75ef946 100644 --- a/providers/src/aws/v00.00.00000/services/ec2.yaml +++ b/providers/src/aws/v00.00.00000/services/ec2.yaml @@ -385,6 +385,74 @@ components: $ref: '#/components/x-cloud-control-schemas/ProgressEvent' type: object schemas: + region: + type: string + description: The AWS region + outpostArn: + type: string + description: The Amazon Resource Name (ARN) of the Outpost. + ownerId: + type: string + description: The ID of the Amazon Web Services account that owns the resource. + tagSet: + type: array + description: Any tags assigned to the resource. + snapshots: + description: List of snapshots by region (requires `aws` provider to be installed) + type: object + additionalProperties: false + properties: + description: + type: string + description: The description for the snapshot. + dataEncryptionKeyId: + type: string + description: The data encryption key identifier for the snapshot. + encrypted: + type: boolean + description: Indicates whether the snapshot is encrypted. + kmsKeyId: + type: string + description: The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the volume encryption key for the parent volume. + outpostArn: + $ref: '#/components/schemas/outpostArn' + ownerAlias: + type: string + description: The Amazon Web Services owner alias. + ownerId: + $ref: '#/components/schemas/ownerId' + progress: + type: string + description: The progress of the snapshot, as a percentage. + restoreExpiryTime: + type: string + description: Only for archived snapshots that are temporarily restored. Indicates the date and time when a temporarily restored snapshot will be automatically re-archived. + snapshotId: + type: string + description: The ID of the snapshot. Each snapshot receives a unique identifier when it is created. + startTime: + type: string + description: The time stamp when the snapshot was initiated. + status: + type: string + description: The snapshot state. + statusMessage: + type: string + description: Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper Key Management Service (KMS) permissions are not obtained) this field displays error state details. + storageTier: + type: string + description: The storage tier in which the snapshot is stored. + tagSet: + $ref: '#/components/schemas/tagSet' + volumeId: + type: string + description: The ID of the volume that was used to create the snapshot. + volumeSize: + type: integer + description: The size of the volume, in GiB. + region: + $ref: '#/components/schemas/region' + x-example-where-clause: WHERE region = '' Tag: type: object additionalProperties: false @@ -676,37 +744,42 @@ components: CustomerGateway: type: object properties: - CertificateArn: + Type: + description: The type of VPN connection that this customer gateway supports (``ipsec.1``). type: string - description: '' - pattern: ^arn:(aws[a-zA-Z-]*)?:acm:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1}:\d{12}:certificate\/[a-zA-Z0-9-_]+$ CustomerGatewayId: + description: '' + type: string + IpAddress: + description: IPv4 address for the customer gateway device's outside interface. The address must be static. type: string + BgpAsnExtended: + multipleOf: 1 + maximum: 4294967294 description: '' + type: number + minimum: 2147483648 BgpAsn: - type: integer default: 65000 description: |- For devices that support BGP, the customer gateway's BGP ASN. Default: 65000 - IpAddress: - type: string - description: IPv4 address for the customer gateway device's outside interface. The address must be static. + type: integer Tags: - type: array uniqueItems: false + description: One or more tags for the customer gateway. x-insertionOrder: false + type: array items: $ref: '#/components/schemas/Tag' - description: One or more tags for the customer gateway. - Type: + CertificateArn: + pattern: ^arn:(aws[a-zA-Z-]*)?:acm:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1}:\d{12}:certificate\/[a-zA-Z0-9-_]+$ + description: '' type: string - description: The type of VPN connection that this customer gateway supports (``ipsec.1``). DeviceName: - type: string description: The name of customer gateway device. + type: string required: - - BgpAsn - IpAddress - Type x-stackql-resource-name: customer_gateway @@ -717,38 +790,38 @@ components: x-create-only-properties: - CertificateArn - BgpAsn + - BgpAsnExtended - Type - IpAddress - DeviceName x-read-only-properties: - CustomerGatewayId x-required-properties: - - BgpAsn - IpAddress - Type x-tagging: taggable: true tagOnCreate: true tagUpdatable: true - cloudFormationSystemTags: true tagProperty: /properties/Tags + cloudFormationSystemTags: true x-required-permissions: + read: + - ec2:DescribeCustomerGateways create: - ec2:CreateCustomerGateway - ec2:DescribeCustomerGateways - ec2:CreateTags - read: - - ec2:DescribeCustomerGateways update: - ec2:CreateTags - ec2:DeleteTags - ec2:DescribeCustomerGateways + list: + - ec2:DescribeCustomerGateways delete: - ec2:DeleteCustomerGateway - ec2:DescribeCustomerGateways - ec2:DeleteTags - list: - - ec2:DescribeCustomerGateways DHCPOptions: type: object properties: @@ -2141,6 +2214,17 @@ components: - ec2:DescribeVolumes - ec2:DescribeTags - ec2:DescribeVolumeAttribute + State: + description: The current state of the instance + additionalProperties: false + type: object + properties: + Code: + description: The state of the instance as a 16-bit unsigned integer. + type: string + Name: + description: The current state of the instance. + type: string Ebs: description: |- Parameters for a block device for an EBS volume in an Amazon EC2 launch template. @@ -2402,6 +2486,10 @@ components: VpcId: description: The ID of the VPC that the instance is running in. type: string + State: + description: The current state of the instance. + type: object + $ref: '#/components/schemas/State' Affinity: description: Indicates whether the instance is associated with a dedicated host. If you want the instance to always restart on the same host on which it was launched, specify host. If you want the instance to restart on any available host, but try to launch onto the last host it ran on (on a best-effort basis), specify default. type: string @@ -2467,6 +2555,7 @@ components: - PublicIp - PrivateDnsName - VpcId + - State x-tagging: taggable: true tagOnCreate: true @@ -3318,33 +3407,40 @@ components: type: object properties: KeyName: - description: The name of the SSH key pair + description: |- + A unique name for the key pair. + Constraints: Up to 255 ASCII characters type: string KeyType: - description: The crypto-system used to generate a key pair. + description: |- + The type of key pair. Note that ED25519 keys are not supported for Windows instances. + If the ``PublicKeyMaterial`` property is specified, the ``KeyType`` property is ignored, and the key type is inferred from the ``PublicKeyMaterial`` value. + Default: ``rsa`` type: string default: rsa enum: - rsa - ed25519 KeyFormat: - description: The format of the private key + description: |- + The format of the key pair. + Default: ``pem`` type: string default: pem enum: - pem - ppk PublicKeyMaterial: - description: Plain text public key to import + description: The public key material. The ``PublicKeyMaterial`` property is used to import a key pair. If this property is not specified, then a new key pair will be created. type: string KeyFingerprint: - description: A short sequence of bytes used for public key verification + description: '' type: string KeyPairId: - description: An AWS generated ID for the key pair + description: '' type: string Tags: - description: An array of key-value pairs to apply to this resource. + description: The tags to apply to the key pair. type: array uniqueItems: true x-insertionOrder: false @@ -3353,7 +3449,14 @@ components: required: - KeyName x-stackql-resource-name: key_pair - description: The AWS::EC2::KeyPair creates an SSH key pair + description: |- + Specifies a key pair for use with an EC2long instance as follows: + + To import an existing key pair, include the ``PublicKeyMaterial`` property. + + To create a new key pair, omit the ``PublicKeyMaterial`` property. + + When you import an existing key pair, you specify the public key material for the key. We assume that you have the private key material for the key. CFNlong does not create or return the private key material when you import a key pair. + When you create a new key pair, the private key is saved to SYSlong Parameter Store, using a parameter with the following name: ``/ec2/keypair/{key_pair_id}``. For more information about retrieving private key, and the required permissions, see [Create a key pair using](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/create-key-pairs.html#create-key-pair-cloudformation) in the *User Guide*. + When CFN deletes a key pair that was created or imported by a stack, it also deletes the parameter that was used to store the private key material in Parameter Store. x-type-name: AWS::EC2::KeyPair x-stackql-primary-identifier: - KeyName @@ -4208,7 +4311,7 @@ components: Specifies the properties for creating a launch template. The minimum required properties for specifying a launch template are as follows: + You must specify at least one property for the launch template data. - + You do not need to specify a name for the launch template. If you do not specify a name, CFN creates the name for you. + + You can optionally specify a name for the launch template. If you do not specify a name, CFN creates a name for you. A launch template can contain some or all of the configuration information to launch an instance. When you launch an instance using a launch template, instance properties that are not specified in the launch template use default values, except the ``ImageId`` property, which has no default value. If you do not specify an AMI ID for the launch template ``ImageId`` property, you must specify an AMI ID for the instance ``ImageId`` property. For more information, see [Launch an instance from a launch template](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html) in the *Amazon EC2 User Guide*. @@ -7611,6 +7714,55 @@ components: delete: - ec2:DeleteTransitGatewayPeeringAttachment - ec2:DescribeTransitGatewayPeeringAttachments + TransitGatewayRoute: + type: object + properties: + TransitGatewayRouteTableId: + description: The ID of transit gateway route table. + type: string + DestinationCidrBlock: + description: The CIDR range used for destination matches. Routing decisions are based on the most specific match. + type: string + Blackhole: + description: Indicates whether to drop traffic that matches this route. + type: boolean + TransitGatewayAttachmentId: + description: The ID of transit gateway attachment. + type: string + required: + - TransitGatewayRouteTableId + - DestinationCidrBlock + x-stackql-resource-name: transit_gateway_route + description: Resource Type definition for AWS::EC2::TransitGatewayRoute + x-type-name: AWS::EC2::TransitGatewayRoute + x-stackql-primary-identifier: + - TransitGatewayRouteTableId + - DestinationCidrBlock + x-create-only-properties: + - TransitGatewayRouteTableId + - TransitGatewayAttachmentId + - DestinationCidrBlock + - Blackhole + x-required-properties: + - TransitGatewayRouteTableId + - DestinationCidrBlock + x-replacement-strategy: delete_then_create + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + read: + - ec2:SearchTransitGatewayRoutes + create: + - ec2:CreateTransitGatewayRoute + - ec2:SearchTransitGatewayRoutes + list: + - ec2:SearchTransitGatewayRoutes + delete: + - ec2:DeleteTransitGatewayRoute + - ec2:SearchTransitGatewayRoutes TransitGatewayRouteTable: type: object properties: @@ -7701,6 +7853,46 @@ components: - ec2:DisassociateTransitGatewayRouteTable list: - ec2:GetTransitGatewayRouteTableAssociations + TransitGatewayRouteTablePropagation: + type: object + properties: + TransitGatewayRouteTableId: + description: The ID of transit gateway route table. + type: string + TransitGatewayAttachmentId: + description: The ID of transit gateway attachment. + type: string + required: + - TransitGatewayRouteTableId + - TransitGatewayAttachmentId + x-stackql-resource-name: transit_gateway_route_table_propagation + description: AWS::EC2::TransitGatewayRouteTablePropagation Type + x-type-name: AWS::EC2::TransitGatewayRouteTablePropagation + x-stackql-primary-identifier: + - TransitGatewayRouteTableId + - TransitGatewayAttachmentId + x-create-only-properties: + - TransitGatewayAttachmentId + - TransitGatewayRouteTableId + x-required-properties: + - TransitGatewayRouteTableId + - TransitGatewayAttachmentId + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - ec2:GetTransitGatewayRouteTablePropagations + - ec2:EnableTransitGatewayRouteTablePropagation + read: + - ec2:GetTransitGatewayRouteTablePropagations + delete: + - ec2:GetTransitGatewayRouteTablePropagations + - ec2:DisableTransitGatewayRouteTablePropagation + list: + - ec2:GetTransitGatewayRouteTablePropagations TransitGatewayVpcAttachment: type: object properties: @@ -9649,35 +9841,41 @@ components: DesiredState: type: object properties: - CertificateArn: + Type: + description: The type of VPN connection that this customer gateway supports (``ipsec.1``). type: string - description: '' - pattern: ^arn:(aws[a-zA-Z-]*)?:acm:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1}:\d{12}:certificate\/[a-zA-Z0-9-_]+$ CustomerGatewayId: + description: '' + type: string + IpAddress: + description: IPv4 address for the customer gateway device's outside interface. The address must be static. type: string + BgpAsnExtended: + multipleOf: 1 + maximum: 4294967294 description: '' + type: number + minimum: 2147483648 BgpAsn: - type: integer default: 65000 description: |- For devices that support BGP, the customer gateway's BGP ASN. Default: 65000 - IpAddress: - type: string - description: IPv4 address for the customer gateway device's outside interface. The address must be static. + type: integer Tags: - type: array uniqueItems: false + description: One or more tags for the customer gateway. x-insertionOrder: false + type: array items: $ref: '#/components/schemas/Tag' - description: One or more tags for the customer gateway. - Type: + CertificateArn: + pattern: ^arn:(aws[a-zA-Z-]*)?:acm:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1}:\d{12}:certificate\/[a-zA-Z0-9-_]+$ + description: '' type: string - description: The type of VPN connection that this customer gateway supports (``ipsec.1``). DeviceName: - type: string description: The name of customer gateway device. + type: string x-stackQL-stringOnly: true x-title: CreateCustomerGatewayRequest type: object @@ -10520,6 +10718,10 @@ components: VpcId: description: The ID of the VPC that the instance is running in. type: string + State: + description: The current state of the instance. + type: object + $ref: '#/components/schemas/State' Affinity: description: Indicates whether the instance is associated with a dedicated host. If you want the instance to always restart on the same host on which it was launched, specify host. If you want the instance to restart on any available host, but try to launch onto the last host it ran on (on a best-effort basis), specify default. type: string @@ -11016,33 +11218,40 @@ components: type: object properties: KeyName: - description: The name of the SSH key pair + description: |- + A unique name for the key pair. + Constraints: Up to 255 ASCII characters type: string KeyType: - description: The crypto-system used to generate a key pair. + description: |- + The type of key pair. Note that ED25519 keys are not supported for Windows instances. + If the ``PublicKeyMaterial`` property is specified, the ``KeyType`` property is ignored, and the key type is inferred from the ``PublicKeyMaterial`` value. + Default: ``rsa`` type: string default: rsa enum: - rsa - ed25519 KeyFormat: - description: The format of the private key + description: |- + The format of the key pair. + Default: ``pem`` type: string default: pem enum: - pem - ppk PublicKeyMaterial: - description: Plain text public key to import + description: The public key material. The ``PublicKeyMaterial`` property is used to import a key pair. If this property is not specified, then a new key pair will be created. type: string KeyFingerprint: - description: A short sequence of bytes used for public key verification + description: '' type: string KeyPairId: - description: An AWS generated ID for the key pair + description: '' type: string Tags: - description: An array of key-value pairs to apply to this resource. + description: The tags to apply to the key pair. type: array uniqueItems: true x-insertionOrder: false @@ -12620,6 +12829,35 @@ components: x-title: CreateTransitGatewayPeeringAttachmentRequest type: object required: [] + CreateTransitGatewayRouteRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + TransitGatewayRouteTableId: + description: The ID of transit gateway route table. + type: string + DestinationCidrBlock: + description: The CIDR range used for destination matches. Routing decisions are based on the most specific match. + type: string + Blackhole: + description: Indicates whether to drop traffic that matches this route. + type: boolean + TransitGatewayAttachmentId: + description: The ID of transit gateway attachment. + type: string + x-stackQL-stringOnly: true + x-title: CreateTransitGatewayRouteRequest + type: object + required: [] CreateTransitGatewayRouteTableRequest: properties: ClientToken: @@ -12673,7 +12911,7 @@ components: x-title: CreateTransitGatewayRouteTableAssociationRequest type: object required: [] - CreateTransitGatewayVpcAttachmentRequest: + CreateTransitGatewayRouteTablePropagationRequest: properties: ClientToken: type: string @@ -12686,7 +12924,30 @@ components: DesiredState: type: object properties: - Options: + TransitGatewayRouteTableId: + description: The ID of transit gateway route table. + type: string + TransitGatewayAttachmentId: + description: The ID of transit gateway attachment. + type: string + x-stackQL-stringOnly: true + x-title: CreateTransitGatewayRouteTablePropagationRequest + type: object + required: [] + CreateTransitGatewayVpcAttachmentRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Options: description: The options for the transit gateway vpc attachment. additionalProperties: false type: object @@ -13527,74 +13788,6 @@ components: x-title: CreateVPNGatewayRequest type: object required: [] - region: - type: string - description: The AWS region - outpostArn: - type: string - description: The Amazon Resource Name (ARN) of the Outpost. - ownerId: - type: string - description: The ID of the Amazon Web Services account that owns the resource. - tagSet: - type: array - description: Any tags assigned to the resource. - snapshots: - description: List of snapshots by region (requires `aws` provider to be installed) - type: object - additionalProperties: false - properties: - description: - type: string - description: The description for the snapshot. - dataEncryptionKeyId: - type: string - description: The data encryption key identifier for the snapshot. - encrypted: - type: boolean - description: Indicates whether the snapshot is encrypted. - kmsKeyId: - type: string - description: The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the volume encryption key for the parent volume. - outpostArn: - $ref: '#/components/schemas/outpostArn' - ownerAlias: - type: string - description: The Amazon Web Services owner alias. - ownerId: - $ref: '#/components/schemas/ownerId' - progress: - type: string - description: The progress of the snapshot, as a percentage. - restoreExpiryTime: - type: string - description: Only for archived snapshots that are temporarily restored. Indicates the date and time when a temporarily restored snapshot will be automatically re-archived. - snapshotId: - type: string - description: The ID of the snapshot. Each snapshot receives a unique identifier when it is created. - startTime: - type: string - description: The time stamp when the snapshot was initiated. - status: - type: string - description: The snapshot state. - statusMessage: - type: string - description: Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper Key Management Service (KMS) permissions are not obtained) this field displays error state details. - storageTier: - type: string - description: The storage tier in which the snapshot is stored. - tagSet: - $ref: '#/components/schemas/tagSet' - volumeId: - type: string - description: The ID of the volume that was used to create the snapshot. - volumeSize: - type: integer - description: The size of the volume, in GiB. - region: - $ref: '#/components/schemas/region' - x-example-where-clause: WHERE region = '' securitySchemes: hmac: type: apiKey @@ -13610,7 +13803,7 @@ components: x-cfn-type-name: AWS::EC2::CapacityReservation x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -13627,9 +13820,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -13639,41 +13832,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/capacity_reservations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/capacity_reservations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::CapacityReservation' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::CapacityReservation' - AND region = 'us-east-1' - capacity_reservation: - name: capacity_reservation - id: aws.ec2.capacity_reservation - x-cfn-schema-name: CapacityReservation - x-cfn-type-name: AWS::EC2::CapacityReservation - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -13684,12 +13845,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/capacity_reservations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/capacity_reservations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/capacity_reservation/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/capacity_reservations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -13714,30 +13879,46 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Tenancy') as tenancy, - json_extract_path_text(Properties, 'EndDateType') as end_date_type, - json_extract_path_text(Properties, 'TagSpecifications') as tag_specifications, - json_extract_path_text(Properties, 'AvailabilityZone') as availability_zone, - json_extract_path_text(Properties, 'TotalInstanceCount') as total_instance_count, - json_extract_path_text(Properties, 'EndDate') as end_date, - json_extract_path_text(Properties, 'EbsOptimized') as ebs_optimized, - json_extract_path_text(Properties, 'OutPostArn') as out_post_arn, - json_extract_path_text(Properties, 'InstanceCount') as instance_count, - json_extract_path_text(Properties, 'PlacementGroupArn') as placement_group_arn, - json_extract_path_text(Properties, 'AvailableInstanceCount') as available_instance_count, - json_extract_path_text(Properties, 'InstancePlatform') as instance_platform, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'InstanceType') as instance_type, - json_extract_path_text(Properties, 'EphemeralStorage') as ephemeral_storage, - json_extract_path_text(Properties, 'InstanceMatchCriteria') as instance_match_criteria - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::CapacityReservation' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::CapacityReservation' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Tenancy') as tenancy, + json_extract_path_text(Properties, 'EndDateType') as end_date_type, + json_extract_path_text(Properties, 'TagSpecifications') as tag_specifications, + json_extract_path_text(Properties, 'AvailabilityZone') as availability_zone, + json_extract_path_text(Properties, 'TotalInstanceCount') as total_instance_count, + json_extract_path_text(Properties, 'EndDate') as end_date, + json_extract_path_text(Properties, 'EbsOptimized') as ebs_optimized, + json_extract_path_text(Properties, 'OutPostArn') as out_post_arn, + json_extract_path_text(Properties, 'InstanceCount') as instance_count, + json_extract_path_text(Properties, 'PlacementGroupArn') as placement_group_arn, + json_extract_path_text(Properties, 'AvailableInstanceCount') as available_instance_count, + json_extract_path_text(Properties, 'InstancePlatform') as instance_platform, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'InstanceType') as instance_type, + json_extract_path_text(Properties, 'EphemeralStorage') as ephemeral_storage, + json_extract_path_text(Properties, 'InstanceMatchCriteria') as instance_match_criteria + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::CapacityReservation' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::CapacityReservation' + AND region = 'us-east-1' capacity_reservation_fleets: name: capacity_reservation_fleets id: aws.ec2.capacity_reservation_fleets @@ -13745,7 +13926,7 @@ components: x-cfn-type-name: AWS::EC2::CapacityReservationFleet x-identifiers: - CapacityReservationFleetId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -13762,9 +13943,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -13774,41 +13955,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/capacity_reservation_fleets/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/capacity_reservation_fleets/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.CapacityReservationFleetId') as capacity_reservation_fleet_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::CapacityReservationFleet' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'CapacityReservationFleetId') as capacity_reservation_fleet_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::CapacityReservationFleet' - AND region = 'us-east-1' - capacity_reservation_fleet: - name: capacity_reservation_fleet - id: aws.ec2.capacity_reservation_fleet - x-cfn-schema-name: CapacityReservationFleet - x-cfn-type-name: AWS::EC2::CapacityReservationFleet - x-identifiers: - - CapacityReservationFleetId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -13819,12 +13968,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/capacity_reservation_fleets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/capacity_reservation_fleets/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/capacity_reservation_fleet/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/capacity_reservation_fleets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -13843,24 +13996,40 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AllocationStrategy') as allocation_strategy, - json_extract_path_text(Properties, 'TagSpecifications') as tag_specifications, - json_extract_path_text(Properties, 'InstanceTypeSpecifications') as instance_type_specifications, - json_extract_path_text(Properties, 'TotalTargetCapacity') as total_target_capacity, - json_extract_path_text(Properties, 'EndDate') as end_date, - json_extract_path_text(Properties, 'InstanceMatchCriteria') as instance_match_criteria, - json_extract_path_text(Properties, 'CapacityReservationFleetId') as capacity_reservation_fleet_id, - json_extract_path_text(Properties, 'Tenancy') as tenancy, - json_extract_path_text(Properties, 'RemoveEndDate') as remove_end_date, - json_extract_path_text(Properties, 'NoRemoveEndDate') as no_remove_end_date - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::CapacityReservationFleet' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.CapacityReservationFleetId') as capacity_reservation_fleet_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::CapacityReservationFleet' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AllocationStrategy') as allocation_strategy, + json_extract_path_text(Properties, 'TagSpecifications') as tag_specifications, + json_extract_path_text(Properties, 'InstanceTypeSpecifications') as instance_type_specifications, + json_extract_path_text(Properties, 'TotalTargetCapacity') as total_target_capacity, + json_extract_path_text(Properties, 'EndDate') as end_date, + json_extract_path_text(Properties, 'InstanceMatchCriteria') as instance_match_criteria, + json_extract_path_text(Properties, 'CapacityReservationFleetId') as capacity_reservation_fleet_id, + json_extract_path_text(Properties, 'Tenancy') as tenancy, + json_extract_path_text(Properties, 'RemoveEndDate') as remove_end_date, + json_extract_path_text(Properties, 'NoRemoveEndDate') as no_remove_end_date + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::CapacityReservationFleet' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'CapacityReservationFleetId') as capacity_reservation_fleet_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::CapacityReservationFleet' + AND region = 'us-east-1' carrier_gateways: name: carrier_gateways id: aws.ec2.carrier_gateways @@ -13868,7 +14037,7 @@ components: x-cfn-type-name: AWS::EC2::CarrierGateway x-identifiers: - CarrierGatewayId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -13885,9 +14054,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -13897,41 +14066,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/carrier_gateways/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/carrier_gateways/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.CarrierGatewayId') as carrier_gateway_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::CarrierGateway' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'CarrierGatewayId') as carrier_gateway_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::CarrierGateway' - AND region = 'us-east-1' - carrier_gateway: - name: carrier_gateway - id: aws.ec2.carrier_gateway - x-cfn-schema-name: CarrierGateway - x-cfn-type-name: AWS::EC2::CarrierGateway - x-identifiers: - - CarrierGatewayId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -13942,12 +14079,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/carrier_gateways/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/carrier_gateways/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/carrier_gateway/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/carrier_gateways/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -13961,19 +14102,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'CarrierGatewayId') as carrier_gateway_id, - json_extract_path_text(Properties, 'State') as state, - json_extract_path_text(Properties, 'VpcId') as vpc_id, - json_extract_path_text(Properties, 'OwnerId') as owner_id, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::CarrierGateway' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.CarrierGatewayId') as carrier_gateway_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::CarrierGateway' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'CarrierGatewayId') as carrier_gateway_id, + json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'VpcId') as vpc_id, + json_extract_path_text(Properties, 'OwnerId') as owner_id, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::CarrierGateway' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'CarrierGatewayId') as carrier_gateway_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::CarrierGateway' + AND region = 'us-east-1' customer_gateways: name: customer_gateways id: aws.ec2.customer_gateways @@ -13981,7 +14138,7 @@ components: x-cfn-type-name: AWS::EC2::CustomerGateway x-identifiers: - CustomerGatewayId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -13998,9 +14155,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -14010,41 +14167,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/customer_gateways/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/customer_gateways/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.CustomerGatewayId') as customer_gateway_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::CustomerGateway' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'CustomerGatewayId') as customer_gateway_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::CustomerGateway' - AND region = 'us-east-1' - customer_gateway: - name: customer_gateway - id: aws.ec2.customer_gateway - x-cfn-schema-name: CustomerGateway - x-cfn-type-name: AWS::EC2::CustomerGateway - x-identifiers: - - CustomerGatewayId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -14055,42 +14180,64 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/customer_gateways/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/customer_gateways/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/customer_gateway/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/customer_gateways/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.CertificateArn') as certificate_arn, + JSON_EXTRACT(Properties, '$.Type') as type, JSON_EXTRACT(Properties, '$.CustomerGatewayId') as customer_gateway_id, - JSON_EXTRACT(Properties, '$.BgpAsn') as bgp_asn, JSON_EXTRACT(Properties, '$.IpAddress') as ip_address, + JSON_EXTRACT(Properties, '$.BgpAsnExtended') as bgp_asn_extended, + JSON_EXTRACT(Properties, '$.BgpAsn') as bgp_asn, JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.Type') as type, + JSON_EXTRACT(Properties, '$.CertificateArn') as certificate_arn, JSON_EXTRACT(Properties, '$.DeviceName') as device_name FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::CustomerGateway' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'CertificateArn') as certificate_arn, - json_extract_path_text(Properties, 'CustomerGatewayId') as customer_gateway_id, - json_extract_path_text(Properties, 'BgpAsn') as bgp_asn, - json_extract_path_text(Properties, 'IpAddress') as ip_address, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Type') as type, - json_extract_path_text(Properties, 'DeviceName') as device_name - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::CustomerGateway' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.CustomerGatewayId') as customer_gateway_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::CustomerGateway' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'CustomerGatewayId') as customer_gateway_id, + json_extract_path_text(Properties, 'IpAddress') as ip_address, + json_extract_path_text(Properties, 'BgpAsnExtended') as bgp_asn_extended, + json_extract_path_text(Properties, 'BgpAsn') as bgp_asn, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'CertificateArn') as certificate_arn, + json_extract_path_text(Properties, 'DeviceName') as device_name + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::CustomerGateway' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'CustomerGatewayId') as customer_gateway_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::CustomerGateway' + AND region = 'us-east-1' dhcp_options: name: dhcp_options id: aws.ec2.dhcp_options @@ -14098,11 +14245,38 @@ components: x-cfn-type-name: AWS::EC2::DHCPOptions x-identifiers: - DhcpOptionsId - x-type: get + x-type: cloud_control methods: - update_resource: - operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DHCPOptions&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::DHCPOptions" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::DHCPOptions" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -14113,12 +14287,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/dhcp_options/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/dhcp_options/methods/delete_resource' update: - $ref: '#/components/x-stackQL-resources/dhcp_options/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -14135,22 +14313,38 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'DhcpOptionsId') as dhcp_options_id, - json_extract_path_text(Properties, 'DomainName') as domain_name, - json_extract_path_text(Properties, 'DomainNameServers') as domain_name_servers, - json_extract_path_text(Properties, 'NetbiosNameServers') as netbios_name_servers, - json_extract_path_text(Properties, 'NetbiosNodeType') as netbios_node_type, - json_extract_path_text(Properties, 'NtpServers') as ntp_servers, - json_extract_path_text(Properties, 'Ipv6AddressPreferredLeaseTime') as ipv6_address_preferred_lease_time, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::DHCPOptions' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.DhcpOptionsId') as dhcp_options_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::DHCPOptions' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DhcpOptionsId') as dhcp_options_id, + json_extract_path_text(Properties, 'DomainName') as domain_name, + json_extract_path_text(Properties, 'DomainNameServers') as domain_name_servers, + json_extract_path_text(Properties, 'NetbiosNameServers') as netbios_name_servers, + json_extract_path_text(Properties, 'NetbiosNodeType') as netbios_node_type, + json_extract_path_text(Properties, 'NtpServers') as ntp_servers, + json_extract_path_text(Properties, 'Ipv6AddressPreferredLeaseTime') as ipv6_address_preferred_lease_time, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::DHCPOptions' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DhcpOptionsId') as dhcp_options_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::DHCPOptions' + AND region = 'us-east-1' ec2fleets: name: ec2fleets id: aws.ec2.ec2fleets @@ -14158,7 +14352,7 @@ components: x-cfn-type-name: AWS::EC2::EC2Fleet x-identifiers: - FleetId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -14175,9 +14369,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -14187,41 +14381,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/ec2fleets/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/ec2fleets/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.FleetId') as fleet_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::EC2Fleet' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'FleetId') as fleet_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::EC2Fleet' - AND region = 'us-east-1' - ec2fleet: - name: ec2fleet - id: aws.ec2.ec2fleet - x-cfn-schema-name: EC2Fleet - x-cfn-type-name: AWS::EC2::EC2Fleet - x-identifiers: - - FleetId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -14232,12 +14394,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/ec2fleets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/ec2fleets/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/ec2fleet/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/ec2fleets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -14259,27 +14425,43 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'TargetCapacitySpecification') as target_capacity_specification, - json_extract_path_text(Properties, 'OnDemandOptions') as on_demand_options, - json_extract_path_text(Properties, 'Type') as type, - json_extract_path_text(Properties, 'ExcessCapacityTerminationPolicy') as excess_capacity_termination_policy, - json_extract_path_text(Properties, 'TagSpecifications') as tag_specifications, - json_extract_path_text(Properties, 'SpotOptions') as spot_options, - json_extract_path_text(Properties, 'ValidFrom') as valid_from, - json_extract_path_text(Properties, 'ReplaceUnhealthyInstances') as replace_unhealthy_instances, - json_extract_path_text(Properties, 'LaunchTemplateConfigs') as launch_template_configs, - json_extract_path_text(Properties, 'FleetId') as fleet_id, - json_extract_path_text(Properties, 'TerminateInstancesWithExpiration') as terminate_instances_with_expiration, - json_extract_path_text(Properties, 'ValidUntil') as valid_until, - json_extract_path_text(Properties, 'Context') as context - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::EC2Fleet' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.FleetId') as fleet_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::EC2Fleet' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'TargetCapacitySpecification') as target_capacity_specification, + json_extract_path_text(Properties, 'OnDemandOptions') as on_demand_options, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'ExcessCapacityTerminationPolicy') as excess_capacity_termination_policy, + json_extract_path_text(Properties, 'TagSpecifications') as tag_specifications, + json_extract_path_text(Properties, 'SpotOptions') as spot_options, + json_extract_path_text(Properties, 'ValidFrom') as valid_from, + json_extract_path_text(Properties, 'ReplaceUnhealthyInstances') as replace_unhealthy_instances, + json_extract_path_text(Properties, 'LaunchTemplateConfigs') as launch_template_configs, + json_extract_path_text(Properties, 'FleetId') as fleet_id, + json_extract_path_text(Properties, 'TerminateInstancesWithExpiration') as terminate_instances_with_expiration, + json_extract_path_text(Properties, 'ValidUntil') as valid_until, + json_extract_path_text(Properties, 'Context') as context + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::EC2Fleet' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'FleetId') as fleet_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::EC2Fleet' + AND region = 'us-east-1' egress_only_internet_gateways: name: egress_only_internet_gateways id: aws.ec2.egress_only_internet_gateways @@ -14287,7 +14469,7 @@ components: x-cfn-type-name: AWS::EC2::EgressOnlyInternetGateway x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -14321,39 +14503,11 @@ components: - $ref: '#/components/x-stackQL-resources/egress_only_internet_gateways/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/egress_only_internet_gateways/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::EgressOnlyInternetGateway' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::EgressOnlyInternetGateway' - AND region = 'us-east-1' - egress_only_internet_gateway: - name: egress_only_internet_gateway - id: aws.ec2.egress_only_internet_gateway - x-cfn-schema-name: EgressOnlyInternetGateway - x-cfn-type-name: AWS::EC2::EgressOnlyInternetGateway - x-identifiers: - - Id - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -14364,16 +14518,32 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'VpcId') as vpc_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::EgressOnlyInternetGateway' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::EgressOnlyInternetGateway' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'VpcId') as vpc_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::EgressOnlyInternetGateway' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::EgressOnlyInternetGateway' + AND region = 'us-east-1' eips: name: eips id: aws.ec2.eips @@ -14382,7 +14552,7 @@ components: x-identifiers: - PublicIp - AllocationId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -14399,9 +14569,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -14411,44 +14581,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/eips/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/eips/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.PublicIp') as public_ip, - JSON_EXTRACT(Properties, '$.AllocationId') as allocation_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::EIP' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'PublicIp') as public_ip, - json_extract_path_text(Properties, 'AllocationId') as allocation_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::EIP' - AND region = 'us-east-1' - eip: - name: eip - id: aws.ec2.eip - x-cfn-schema-name: EIP - x-cfn-type-name: AWS::EC2::EIP - x-identifiers: - - PublicIp - - AllocationId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -14459,12 +14594,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/eips/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/eips/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/eip/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/eips/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -14481,22 +14620,40 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'PublicIp') as public_ip, - json_extract_path_text(Properties, 'AllocationId') as allocation_id, - json_extract_path_text(Properties, 'Domain') as domain, - json_extract_path_text(Properties, 'NetworkBorderGroup') as network_border_group, - json_extract_path_text(Properties, 'TransferAddress') as transfer_address, - json_extract_path_text(Properties, 'InstanceId') as instance_id, - json_extract_path_text(Properties, 'PublicIpv4Pool') as public_ipv4_pool, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::EIP' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.PublicIp') as public_ip, + JSON_EXTRACT(Properties, '$.AllocationId') as allocation_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::EIP' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'PublicIp') as public_ip, + json_extract_path_text(Properties, 'AllocationId') as allocation_id, + json_extract_path_text(Properties, 'Domain') as domain, + json_extract_path_text(Properties, 'NetworkBorderGroup') as network_border_group, + json_extract_path_text(Properties, 'TransferAddress') as transfer_address, + json_extract_path_text(Properties, 'InstanceId') as instance_id, + json_extract_path_text(Properties, 'PublicIpv4Pool') as public_ipv4_pool, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::EIP' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'PublicIp') as public_ip, + json_extract_path_text(Properties, 'AllocationId') as allocation_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::EIP' + AND region = 'us-east-1' eip_associations: name: eip_associations id: aws.ec2.eip_associations @@ -14504,7 +14661,7 @@ components: x-cfn-type-name: AWS::EC2::EIPAssociation x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -14538,39 +14695,11 @@ components: - $ref: '#/components/x-stackQL-resources/eip_associations/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/eip_associations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::EIPAssociation' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::EIPAssociation' - AND region = 'us-east-1' - eip_association: - name: eip_association - id: aws.ec2.eip_association - x-cfn-schema-name: EIPAssociation - x-cfn-type-name: AWS::EC2::EIPAssociation - x-identifiers: - - Id - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -14585,20 +14714,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'AllocationId') as allocation_id, - json_extract_path_text(Properties, 'NetworkInterfaceId') as network_interface_id, - json_extract_path_text(Properties, 'InstanceId') as instance_id, - json_extract_path_text(Properties, 'PrivateIpAddress') as private_ip_address, - json_extract_path_text(Properties, 'EIP') as e_ip - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::EIPAssociation' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::EIPAssociation' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'AllocationId') as allocation_id, + json_extract_path_text(Properties, 'NetworkInterfaceId') as network_interface_id, + json_extract_path_text(Properties, 'InstanceId') as instance_id, + json_extract_path_text(Properties, 'PrivateIpAddress') as private_ip_address, + json_extract_path_text(Properties, 'EIP') as e_ip + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::EIPAssociation' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::EIPAssociation' + AND region = 'us-east-1' enclave_certificate_iam_role_associations: name: enclave_certificate_iam_role_associations id: aws.ec2.enclave_certificate_iam_role_associations @@ -14607,7 +14752,7 @@ components: x-identifiers: - CertificateArn - RoleArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -14641,42 +14786,11 @@ components: - $ref: '#/components/x-stackQL-resources/enclave_certificate_iam_role_associations/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/enclave_certificate_iam_role_associations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.CertificateArn') as certificate_arn, - JSON_EXTRACT(Properties, '$.RoleArn') as role_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::EnclaveCertificateIamRoleAssociation' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'CertificateArn') as certificate_arn, - json_extract_path_text(Properties, 'RoleArn') as role_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::EnclaveCertificateIamRoleAssociation' - AND region = 'us-east-1' - enclave_certificate_iam_role_association: - name: enclave_certificate_iam_role_association - id: aws.ec2.enclave_certificate_iam_role_association - x-cfn-schema-name: EnclaveCertificateIamRoleAssociation - x-cfn-type-name: AWS::EC2::EnclaveCertificateIamRoleAssociation - x-identifiers: - - CertificateArn - - RoleArn - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -14690,19 +14804,37 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'CertificateArn') as certificate_arn, - json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'CertificateS3BucketName') as certificate_s3_bucket_name, - json_extract_path_text(Properties, 'CertificateS3ObjectKey') as certificate_s3_object_key, - json_extract_path_text(Properties, 'EncryptionKmsKeyId') as encryption_kms_key_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::EnclaveCertificateIamRoleAssociation' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.CertificateArn') as certificate_arn, + JSON_EXTRACT(Properties, '$.RoleArn') as role_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::EnclaveCertificateIamRoleAssociation' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'CertificateArn') as certificate_arn, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'CertificateS3BucketName') as certificate_s3_bucket_name, + json_extract_path_text(Properties, 'CertificateS3ObjectKey') as certificate_s3_object_key, + json_extract_path_text(Properties, 'EncryptionKmsKeyId') as encryption_kms_key_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::EnclaveCertificateIamRoleAssociation' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'CertificateArn') as certificate_arn, + json_extract_path_text(Properties, 'RoleArn') as role_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::EnclaveCertificateIamRoleAssociation' + AND region = 'us-east-1' flow_logs: name: flow_logs id: aws.ec2.flow_logs @@ -14710,7 +14842,7 @@ components: x-cfn-type-name: AWS::EC2::FlowLog x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -14727,9 +14859,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -14739,41 +14871,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/flow_logs/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/flow_logs/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::FlowLog' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::FlowLog' - AND region = 'us-east-1' - flow_log: - name: flow_log - id: aws.ec2.flow_log - x-cfn-schema-name: FlowLog - x-cfn-type-name: AWS::EC2::FlowLog - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -14784,12 +14884,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/flow_logs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/flow_logs/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/flow_log/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/flow_logs/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -14811,27 +14915,43 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'DeliverCrossAccountRole') as deliver_cross_account_role, - json_extract_path_text(Properties, 'DeliverLogsPermissionArn') as deliver_logs_permission_arn, - json_extract_path_text(Properties, 'LogDestination') as log_destination, - json_extract_path_text(Properties, 'LogDestinationType') as log_destination_type, - json_extract_path_text(Properties, 'LogFormat') as log_format, - json_extract_path_text(Properties, 'LogGroupName') as log_group_name, - json_extract_path_text(Properties, 'MaxAggregationInterval') as max_aggregation_interval, - json_extract_path_text(Properties, 'ResourceId') as resource_id, - json_extract_path_text(Properties, 'ResourceType') as resource_type, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'TrafficType') as traffic_type, - json_extract_path_text(Properties, 'DestinationOptions') as destination_options - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::FlowLog' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::FlowLog' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'DeliverCrossAccountRole') as deliver_cross_account_role, + json_extract_path_text(Properties, 'DeliverLogsPermissionArn') as deliver_logs_permission_arn, + json_extract_path_text(Properties, 'LogDestination') as log_destination, + json_extract_path_text(Properties, 'LogDestinationType') as log_destination_type, + json_extract_path_text(Properties, 'LogFormat') as log_format, + json_extract_path_text(Properties, 'LogGroupName') as log_group_name, + json_extract_path_text(Properties, 'MaxAggregationInterval') as max_aggregation_interval, + json_extract_path_text(Properties, 'ResourceId') as resource_id, + json_extract_path_text(Properties, 'ResourceType') as resource_type, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'TrafficType') as traffic_type, + json_extract_path_text(Properties, 'DestinationOptions') as destination_options + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::FlowLog' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::FlowLog' + AND region = 'us-east-1' gateway_route_table_associations: name: gateway_route_table_associations id: aws.ec2.gateway_route_table_associations @@ -14839,7 +14959,7 @@ components: x-cfn-type-name: AWS::EC2::GatewayRouteTableAssociation x-identifiers: - GatewayId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -14856,9 +14976,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -14868,23 +14988,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/gateway_route_table_associations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/gateway_route_table_associations/methods/delete_resource' - gateway_route_table_association: - name: gateway_route_table_association - id: aws.ec2.gateway_route_table_association - x-cfn-schema-name: GatewayRouteTableAssociation - x-cfn-type-name: AWS::EC2::GatewayRouteTableAssociation - x-identifiers: - - GatewayId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -14895,12 +15001,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/gateway_route_table_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/gateway_route_table_associations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/gateway_route_table_association/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/gateway_route_table_associations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -14912,7 +15022,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -14930,7 +15040,7 @@ components: x-cfn-type-name: AWS::EC2::Host x-identifiers: - HostId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -14947,6 +15057,18 @@ components: response: mediaType: application/json openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::Host" + } + response: + mediaType: application/json + openAPIDocKey: '200' delete_resource: operation: $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' @@ -14964,52 +15086,12 @@ components: - $ref: '#/components/x-stackQL-resources/hosts/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/hosts/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/hosts/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.HostId') as host_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::Host' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'HostId') as host_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::Host' - AND region = 'us-east-1' - host: - name: host - id: aws.ec2.host - x-cfn-schema-name: Host - x-cfn-type-name: AWS::EC2::Host - x-identifiers: - - HostId - x-type: get - methods: - update_resource: - operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' - request: - mediaType: application/x-amz-json-1.0 - base: |- - { - "TypeName": "AWS::EC2::Host" - } - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - update: - - $ref: '#/components/x-stackQL-resources/host/methods/update_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -15027,23 +15109,39 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'HostId') as host_id, - json_extract_path_text(Properties, 'AutoPlacement') as auto_placement, - json_extract_path_text(Properties, 'AvailabilityZone') as availability_zone, - json_extract_path_text(Properties, 'HostRecovery') as host_recovery, - json_extract_path_text(Properties, 'InstanceType') as instance_type, - json_extract_path_text(Properties, 'InstanceFamily') as instance_family, - json_extract_path_text(Properties, 'OutpostArn') as outpost_arn, - json_extract_path_text(Properties, 'HostMaintenance') as host_maintenance, - json_extract_path_text(Properties, 'AssetId') as asset_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::Host' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.HostId') as host_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::Host' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'HostId') as host_id, + json_extract_path_text(Properties, 'AutoPlacement') as auto_placement, + json_extract_path_text(Properties, 'AvailabilityZone') as availability_zone, + json_extract_path_text(Properties, 'HostRecovery') as host_recovery, + json_extract_path_text(Properties, 'InstanceType') as instance_type, + json_extract_path_text(Properties, 'InstanceFamily') as instance_family, + json_extract_path_text(Properties, 'OutpostArn') as outpost_arn, + json_extract_path_text(Properties, 'HostMaintenance') as host_maintenance, + json_extract_path_text(Properties, 'AssetId') as asset_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::Host' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'HostId') as host_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::Host' + AND region = 'us-east-1' network_interfaces: name: network_interfaces id: aws.ec2.network_interfaces @@ -15051,7 +15149,7 @@ components: x-cfn-type-name: AWS::EC2::NetworkInterface x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -15068,9 +15166,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -15080,41 +15178,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/network_interfaces/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/network_interfaces/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NetworkInterface' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NetworkInterface' - AND region = 'us-east-1' - network_interface: - name: network_interface - id: aws.ec2.network_interface - x-cfn-schema-name: NetworkInterface - x-cfn-type-name: AWS::EC2::NetworkInterface - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -15125,12 +15191,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/network_interfaces/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/network_interfaces/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/network_interface/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/network_interfaces/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -15161,36 +15231,52 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'PrivateIpAddress') as private_ip_address, - json_extract_path_text(Properties, 'PrivateIpAddresses') as private_ip_addresses, - json_extract_path_text(Properties, 'SecondaryPrivateIpAddressCount') as secondary_private_ip_address_count, - json_extract_path_text(Properties, 'PrimaryPrivateIpAddress') as primary_private_ip_address, - json_extract_path_text(Properties, 'Ipv4Prefixes') as ipv4_prefixes, - json_extract_path_text(Properties, 'Ipv4PrefixCount') as ipv4_prefix_count, - json_extract_path_text(Properties, 'GroupSet') as group_set, - json_extract_path_text(Properties, 'Ipv6Addresses') as ipv6_addresses, - json_extract_path_text(Properties, 'Ipv6Prefixes') as ipv6_prefixes, - json_extract_path_text(Properties, 'Ipv6PrefixCount') as ipv6_prefix_count, - json_extract_path_text(Properties, 'SubnetId') as subnet_id, - json_extract_path_text(Properties, 'SourceDestCheck') as source_dest_check, - json_extract_path_text(Properties, 'InterfaceType') as interface_type, - json_extract_path_text(Properties, 'SecondaryPrivateIpAddresses') as secondary_private_ip_addresses, - json_extract_path_text(Properties, 'Ipv6AddressCount') as ipv6_address_count, - json_extract_path_text(Properties, 'EnablePrimaryIpv6') as enable_primary_ipv6, - json_extract_path_text(Properties, 'PrimaryIpv6Address') as primary_ipv6_address, - json_extract_path_text(Properties, 'ConnectionTrackingSpecification') as connection_tracking_specification, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'VpcId') as vpc_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::NetworkInterface' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NetworkInterface' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'PrivateIpAddress') as private_ip_address, + json_extract_path_text(Properties, 'PrivateIpAddresses') as private_ip_addresses, + json_extract_path_text(Properties, 'SecondaryPrivateIpAddressCount') as secondary_private_ip_address_count, + json_extract_path_text(Properties, 'PrimaryPrivateIpAddress') as primary_private_ip_address, + json_extract_path_text(Properties, 'Ipv4Prefixes') as ipv4_prefixes, + json_extract_path_text(Properties, 'Ipv4PrefixCount') as ipv4_prefix_count, + json_extract_path_text(Properties, 'GroupSet') as group_set, + json_extract_path_text(Properties, 'Ipv6Addresses') as ipv6_addresses, + json_extract_path_text(Properties, 'Ipv6Prefixes') as ipv6_prefixes, + json_extract_path_text(Properties, 'Ipv6PrefixCount') as ipv6_prefix_count, + json_extract_path_text(Properties, 'SubnetId') as subnet_id, + json_extract_path_text(Properties, 'SourceDestCheck') as source_dest_check, + json_extract_path_text(Properties, 'InterfaceType') as interface_type, + json_extract_path_text(Properties, 'SecondaryPrivateIpAddresses') as secondary_private_ip_addresses, + json_extract_path_text(Properties, 'Ipv6AddressCount') as ipv6_address_count, + json_extract_path_text(Properties, 'EnablePrimaryIpv6') as enable_primary_ipv6, + json_extract_path_text(Properties, 'PrimaryIpv6Address') as primary_ipv6_address, + json_extract_path_text(Properties, 'ConnectionTrackingSpecification') as connection_tracking_specification, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'VpcId') as vpc_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::NetworkInterface' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NetworkInterface' + AND region = 'us-east-1' volumes: name: volumes id: aws.ec2.volumes @@ -15198,7 +15284,7 @@ components: x-cfn-type-name: AWS::EC2::Volume x-identifiers: - VolumeId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -15215,9 +15301,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -15227,41 +15313,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/volumes/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/volumes/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.VolumeId') as volume_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::Volume' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'VolumeId') as volume_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::Volume' - AND region = 'us-east-1' - volume: - name: volume - id: aws.ec2.volume - x-cfn-schema-name: Volume - x-cfn-type-name: AWS::EC2::Volume - x-identifiers: - - VolumeId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -15272,12 +15326,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/volumes/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/volumes/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/volume/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/volumes/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -15299,27 +15357,43 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'MultiAttachEnabled') as multi_attach_enabled, - json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, - json_extract_path_text(Properties, 'Encrypted') as encrypted, - json_extract_path_text(Properties, 'Size') as size, - json_extract_path_text(Properties, 'AutoEnableIO') as auto_enable_io, - json_extract_path_text(Properties, 'OutpostArn') as outpost_arn, - json_extract_path_text(Properties, 'AvailabilityZone') as availability_zone, - json_extract_path_text(Properties, 'Throughput') as throughput, - json_extract_path_text(Properties, 'Iops') as iops, - json_extract_path_text(Properties, 'SnapshotId') as snapshot_id, - json_extract_path_text(Properties, 'VolumeType') as volume_type, - json_extract_path_text(Properties, 'VolumeId') as volume_id, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::Volume' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.VolumeId') as volume_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::Volume' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'MultiAttachEnabled') as multi_attach_enabled, + json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, + json_extract_path_text(Properties, 'Encrypted') as encrypted, + json_extract_path_text(Properties, 'Size') as size, + json_extract_path_text(Properties, 'AutoEnableIO') as auto_enable_io, + json_extract_path_text(Properties, 'OutpostArn') as outpost_arn, + json_extract_path_text(Properties, 'AvailabilityZone') as availability_zone, + json_extract_path_text(Properties, 'Throughput') as throughput, + json_extract_path_text(Properties, 'Iops') as iops, + json_extract_path_text(Properties, 'SnapshotId') as snapshot_id, + json_extract_path_text(Properties, 'VolumeType') as volume_type, + json_extract_path_text(Properties, 'VolumeId') as volume_id, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::Volume' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'VolumeId') as volume_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::Volume' + AND region = 'us-east-1' instances: name: instances id: aws.ec2.instances @@ -15327,7 +15401,7 @@ components: x-cfn-type-name: AWS::EC2::Instance x-identifiers: - InstanceId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -15344,9 +15418,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -15356,41 +15430,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/instances/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/instances/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.InstanceId') as instance_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::Instance' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'InstanceId') as instance_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::Instance' - AND region = 'us-east-1' - instance: - name: instance - id: aws.ec2.instance - x-cfn-schema-name: Instance - x-cfn-type-name: AWS::EC2::Instance - x-identifiers: - - InstanceId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -15401,12 +15443,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/instances/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/instances/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/instance/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/instances/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -15455,66 +15501,84 @@ components: JSON_EXTRACT(Properties, '$.PlacementGroupName') as placement_group_name, JSON_EXTRACT(Properties, '$.SsmAssociations') as ssm_associations, JSON_EXTRACT(Properties, '$.VpcId') as vpc_id, + JSON_EXTRACT(Properties, '$.State') as state, JSON_EXTRACT(Properties, '$.Affinity') as affinity, JSON_EXTRACT(Properties, '$.CreditSpecification') as credit_specification FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::Instance' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Tenancy') as tenancy, - json_extract_path_text(Properties, 'SecurityGroups') as security_groups, - json_extract_path_text(Properties, 'PrivateDnsName') as private_dns_name, - json_extract_path_text(Properties, 'PrivateIpAddress') as private_ip_address, - json_extract_path_text(Properties, 'UserData') as user_data, - json_extract_path_text(Properties, 'BlockDeviceMappings') as block_device_mappings, - json_extract_path_text(Properties, 'IamInstanceProfile') as iam_instance_profile, - json_extract_path_text(Properties, 'Ipv6Addresses') as ipv6_addresses, - json_extract_path_text(Properties, 'KernelId') as kernel_id, - json_extract_path_text(Properties, 'SubnetId') as subnet_id, - json_extract_path_text(Properties, 'EbsOptimized') as ebs_optimized, - json_extract_path_text(Properties, 'PropagateTagsToVolumeOnCreation') as propagate_tags_to_volume_on_creation, - json_extract_path_text(Properties, 'ElasticGpuSpecifications') as elastic_gpu_specifications, - json_extract_path_text(Properties, 'ElasticInferenceAccelerators') as elastic_inference_accelerators, - json_extract_path_text(Properties, 'Volumes') as volumes, - json_extract_path_text(Properties, 'PrivateIp') as private_ip, - json_extract_path_text(Properties, 'Ipv6AddressCount') as ipv6_address_count, - json_extract_path_text(Properties, 'LaunchTemplate') as launch_template, - json_extract_path_text(Properties, 'EnclaveOptions') as enclave_options, - json_extract_path_text(Properties, 'NetworkInterfaces') as network_interfaces, - json_extract_path_text(Properties, 'ImageId') as image_id, - json_extract_path_text(Properties, 'InstanceType') as instance_type, - json_extract_path_text(Properties, 'Monitoring') as monitoring, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'AdditionalInfo') as additional_info, - json_extract_path_text(Properties, 'HibernationOptions') as hibernation_options, - json_extract_path_text(Properties, 'LicenseSpecifications') as license_specifications, - json_extract_path_text(Properties, 'InstanceId') as instance_id, - json_extract_path_text(Properties, 'PublicIp') as public_ip, - json_extract_path_text(Properties, 'InstanceInitiatedShutdownBehavior') as instance_initiated_shutdown_behavior, - json_extract_path_text(Properties, 'CpuOptions') as cpu_options, - json_extract_path_text(Properties, 'AvailabilityZone') as availability_zone, - json_extract_path_text(Properties, 'PrivateDnsNameOptions') as private_dns_name_options, - json_extract_path_text(Properties, 'HostId') as host_id, - json_extract_path_text(Properties, 'HostResourceGroupArn') as host_resource_group_arn, - json_extract_path_text(Properties, 'PublicDnsName') as public_dns_name, - json_extract_path_text(Properties, 'SecurityGroupIds') as security_group_ids, - json_extract_path_text(Properties, 'DisableApiTermination') as disable_api_termination, - json_extract_path_text(Properties, 'KeyName') as key_name, - json_extract_path_text(Properties, 'RamdiskId') as ramdisk_id, - json_extract_path_text(Properties, 'SourceDestCheck') as source_dest_check, - json_extract_path_text(Properties, 'PlacementGroupName') as placement_group_name, - json_extract_path_text(Properties, 'SsmAssociations') as ssm_associations, - json_extract_path_text(Properties, 'VpcId') as vpc_id, - json_extract_path_text(Properties, 'Affinity') as affinity, - json_extract_path_text(Properties, 'CreditSpecification') as credit_specification - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::Instance' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.InstanceId') as instance_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::Instance' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Tenancy') as tenancy, + json_extract_path_text(Properties, 'SecurityGroups') as security_groups, + json_extract_path_text(Properties, 'PrivateDnsName') as private_dns_name, + json_extract_path_text(Properties, 'PrivateIpAddress') as private_ip_address, + json_extract_path_text(Properties, 'UserData') as user_data, + json_extract_path_text(Properties, 'BlockDeviceMappings') as block_device_mappings, + json_extract_path_text(Properties, 'IamInstanceProfile') as iam_instance_profile, + json_extract_path_text(Properties, 'Ipv6Addresses') as ipv6_addresses, + json_extract_path_text(Properties, 'KernelId') as kernel_id, + json_extract_path_text(Properties, 'SubnetId') as subnet_id, + json_extract_path_text(Properties, 'EbsOptimized') as ebs_optimized, + json_extract_path_text(Properties, 'PropagateTagsToVolumeOnCreation') as propagate_tags_to_volume_on_creation, + json_extract_path_text(Properties, 'ElasticGpuSpecifications') as elastic_gpu_specifications, + json_extract_path_text(Properties, 'ElasticInferenceAccelerators') as elastic_inference_accelerators, + json_extract_path_text(Properties, 'Volumes') as volumes, + json_extract_path_text(Properties, 'PrivateIp') as private_ip, + json_extract_path_text(Properties, 'Ipv6AddressCount') as ipv6_address_count, + json_extract_path_text(Properties, 'LaunchTemplate') as launch_template, + json_extract_path_text(Properties, 'EnclaveOptions') as enclave_options, + json_extract_path_text(Properties, 'NetworkInterfaces') as network_interfaces, + json_extract_path_text(Properties, 'ImageId') as image_id, + json_extract_path_text(Properties, 'InstanceType') as instance_type, + json_extract_path_text(Properties, 'Monitoring') as monitoring, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'AdditionalInfo') as additional_info, + json_extract_path_text(Properties, 'HibernationOptions') as hibernation_options, + json_extract_path_text(Properties, 'LicenseSpecifications') as license_specifications, + json_extract_path_text(Properties, 'InstanceId') as instance_id, + json_extract_path_text(Properties, 'PublicIp') as public_ip, + json_extract_path_text(Properties, 'InstanceInitiatedShutdownBehavior') as instance_initiated_shutdown_behavior, + json_extract_path_text(Properties, 'CpuOptions') as cpu_options, + json_extract_path_text(Properties, 'AvailabilityZone') as availability_zone, + json_extract_path_text(Properties, 'PrivateDnsNameOptions') as private_dns_name_options, + json_extract_path_text(Properties, 'HostId') as host_id, + json_extract_path_text(Properties, 'HostResourceGroupArn') as host_resource_group_arn, + json_extract_path_text(Properties, 'PublicDnsName') as public_dns_name, + json_extract_path_text(Properties, 'SecurityGroupIds') as security_group_ids, + json_extract_path_text(Properties, 'DisableApiTermination') as disable_api_termination, + json_extract_path_text(Properties, 'KeyName') as key_name, + json_extract_path_text(Properties, 'RamdiskId') as ramdisk_id, + json_extract_path_text(Properties, 'SourceDestCheck') as source_dest_check, + json_extract_path_text(Properties, 'PlacementGroupName') as placement_group_name, + json_extract_path_text(Properties, 'SsmAssociations') as ssm_associations, + json_extract_path_text(Properties, 'VpcId') as vpc_id, + json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'Affinity') as affinity, + json_extract_path_text(Properties, 'CreditSpecification') as credit_specification + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::Instance' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'InstanceId') as instance_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::Instance' + AND region = 'us-east-1' instance_connect_endpoints: name: instance_connect_endpoints id: aws.ec2.instance_connect_endpoints @@ -15522,7 +15586,7 @@ components: x-cfn-type-name: AWS::EC2::InstanceConnectEndpoint x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -15539,9 +15603,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -15551,41 +15615,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/instance_connect_endpoints/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/instance_connect_endpoints/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::InstanceConnectEndpoint' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::InstanceConnectEndpoint' - AND region = 'us-east-1' - instance_connect_endpoint: - name: instance_connect_endpoint - id: aws.ec2.instance_connect_endpoint - x-cfn-schema-name: InstanceConnectEndpoint - x-cfn-type-name: AWS::EC2::InstanceConnectEndpoint - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -15596,12 +15628,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/instance_connect_endpoints/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/instance_connect_endpoints/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/instance_connect_endpoint/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/instance_connect_endpoints/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -15616,20 +15652,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'SubnetId') as subnet_id, - json_extract_path_text(Properties, 'ClientToken') as client_token, - json_extract_path_text(Properties, 'PreserveClientIp') as preserve_client_ip, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'SecurityGroupIds') as security_group_ids - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::InstanceConnectEndpoint' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::InstanceConnectEndpoint' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'SubnetId') as subnet_id, + json_extract_path_text(Properties, 'ClientToken') as client_token, + json_extract_path_text(Properties, 'PreserveClientIp') as preserve_client_ip, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'SecurityGroupIds') as security_group_ids + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::InstanceConnectEndpoint' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::InstanceConnectEndpoint' + AND region = 'us-east-1' internet_gateways: name: internet_gateways id: aws.ec2.internet_gateways @@ -15637,7 +15689,7 @@ components: x-cfn-type-name: AWS::EC2::InternetGateway x-identifiers: - InternetGatewayId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -15654,9 +15706,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -15666,41 +15718,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/internet_gateways/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/internet_gateways/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.InternetGatewayId') as internet_gateway_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::InternetGateway' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'InternetGatewayId') as internet_gateway_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::InternetGateway' - AND region = 'us-east-1' - internet_gateway: - name: internet_gateway - id: aws.ec2.internet_gateway - x-cfn-schema-name: InternetGateway - x-cfn-type-name: AWS::EC2::InternetGateway - x-identifiers: - - InternetGatewayId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -15711,12 +15731,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/internet_gateways/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/internet_gateways/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/internet_gateway/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/internet_gateways/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -15727,16 +15751,32 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'InternetGatewayId') as internet_gateway_id, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::InternetGateway' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.InternetGatewayId') as internet_gateway_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::InternetGateway' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'InternetGatewayId') as internet_gateway_id, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::InternetGateway' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'InternetGatewayId') as internet_gateway_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::InternetGateway' + AND region = 'us-east-1' ipams: name: ipams id: aws.ec2.ipams @@ -15744,7 +15784,7 @@ components: x-cfn-type-name: AWS::EC2::IPAM x-identifiers: - IpamId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -15761,6 +15801,18 @@ components: response: mediaType: application/json openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::IPAM" + } + response: + mediaType: application/json + openAPIDocKey: '200' delete_resource: operation: $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' @@ -15778,52 +15830,12 @@ components: - $ref: '#/components/x-stackQL-resources/ipams/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/ipams/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/ipams/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.IpamId') as ipam_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::IPAM' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'IpamId') as ipam_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::IPAM' - AND region = 'us-east-1' - ipam: - name: ipam - id: aws.ec2.ipam - x-cfn-schema-name: IPAM - x-cfn-type-name: AWS::EC2::IPAM - x-identifiers: - - IpamId - x-type: get - methods: - update_resource: - operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' - request: - mediaType: application/x-amz-json-1.0 - base: |- - { - "TypeName": "AWS::EC2::IPAM" - } - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - update: - - $ref: '#/components/x-stackQL-resources/ipam/methods/update_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -15844,26 +15856,42 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'IpamId') as ipam_id, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'DefaultResourceDiscoveryId') as default_resource_discovery_id, - json_extract_path_text(Properties, 'DefaultResourceDiscoveryAssociationId') as default_resource_discovery_association_id, - json_extract_path_text(Properties, 'ResourceDiscoveryAssociationCount') as resource_discovery_association_count, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'PublicDefaultScopeId') as public_default_scope_id, - json_extract_path_text(Properties, 'PrivateDefaultScopeId') as private_default_scope_id, - json_extract_path_text(Properties, 'ScopeCount') as scope_count, - json_extract_path_text(Properties, 'OperatingRegions') as operating_regions, - json_extract_path_text(Properties, 'Tier') as tier, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::IPAM' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.IpamId') as ipam_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::IPAM' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'IpamId') as ipam_id, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'DefaultResourceDiscoveryId') as default_resource_discovery_id, + json_extract_path_text(Properties, 'DefaultResourceDiscoveryAssociationId') as default_resource_discovery_association_id, + json_extract_path_text(Properties, 'ResourceDiscoveryAssociationCount') as resource_discovery_association_count, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'PublicDefaultScopeId') as public_default_scope_id, + json_extract_path_text(Properties, 'PrivateDefaultScopeId') as private_default_scope_id, + json_extract_path_text(Properties, 'ScopeCount') as scope_count, + json_extract_path_text(Properties, 'OperatingRegions') as operating_regions, + json_extract_path_text(Properties, 'Tier') as tier, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::IPAM' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'IpamId') as ipam_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::IPAM' + AND region = 'us-east-1' ipam_allocations: name: ipam_allocations id: aws.ec2.ipam_allocations @@ -15873,7 +15901,7 @@ components: - IpamPoolId - IpamPoolAllocationId - Cidr - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -15907,45 +15935,11 @@ components: - $ref: '#/components/x-stackQL-resources/ipam_allocations/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/ipam_allocations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.IpamPoolId') as ipam_pool_id, - JSON_EXTRACT(Properties, '$.IpamPoolAllocationId') as ipam_pool_allocation_id, - JSON_EXTRACT(Properties, '$.Cidr') as cidr - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::IPAMAllocation' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'IpamPoolId') as ipam_pool_id, - json_extract_path_text(Properties, 'IpamPoolAllocationId') as ipam_pool_allocation_id, - json_extract_path_text(Properties, 'Cidr') as cidr - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::IPAMAllocation' - AND region = 'us-east-1' - ipam_allocation: - name: ipam_allocation - id: aws.ec2.ipam_allocation - x-cfn-schema-name: IPAMAllocation - x-cfn-type-name: AWS::EC2::IPAMAllocation - x-identifiers: - - IpamPoolId - - IpamPoolAllocationId - - Cidr - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -15959,19 +15953,39 @@ components: AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'IpamPoolAllocationId') as ipam_pool_allocation_id, - json_extract_path_text(Properties, 'IpamPoolId') as ipam_pool_id, - json_extract_path_text(Properties, 'Cidr') as cidr, - json_extract_path_text(Properties, 'NetmaskLength') as netmask_length, - json_extract_path_text(Properties, 'Description') as description - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::IPAMAllocation' - AND data__Identifier = '||' + JSON_EXTRACT(Properties, '$.IpamPoolId') as ipam_pool_id, + JSON_EXTRACT(Properties, '$.IpamPoolAllocationId') as ipam_pool_allocation_id, + JSON_EXTRACT(Properties, '$.Cidr') as cidr + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::IPAMAllocation' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'IpamPoolAllocationId') as ipam_pool_allocation_id, + json_extract_path_text(Properties, 'IpamPoolId') as ipam_pool_id, + json_extract_path_text(Properties, 'Cidr') as cidr, + json_extract_path_text(Properties, 'NetmaskLength') as netmask_length, + json_extract_path_text(Properties, 'Description') as description + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::IPAMAllocation' + AND data__Identifier = '||' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'IpamPoolId') as ipam_pool_id, + json_extract_path_text(Properties, 'IpamPoolAllocationId') as ipam_pool_allocation_id, + json_extract_path_text(Properties, 'Cidr') as cidr + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::IPAMAllocation' + AND region = 'us-east-1' ipam_pools: name: ipam_pools id: aws.ec2.ipam_pools @@ -15979,7 +15993,7 @@ components: x-cfn-type-name: AWS::EC2::IPAMPool x-identifiers: - IpamPoolId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -15996,9 +16010,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -16008,41 +16022,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/ipam_pools/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/ipam_pools/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.IpamPoolId') as ipam_pool_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::IPAMPool' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'IpamPoolId') as ipam_pool_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::IPAMPool' - AND region = 'us-east-1' - ipam_pool: - name: ipam_pool - id: aws.ec2.ipam_pool - x-cfn-schema-name: IPAMPool - x-cfn-type-name: AWS::EC2::IPAMPool - x-identifiers: - - IpamPoolId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -16053,12 +16035,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/ipam_pools/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/ipam_pools/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/ipam_pool/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/ipam_pools/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -16091,38 +16077,54 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'IpamPoolId') as ipam_pool_id, - json_extract_path_text(Properties, 'AddressFamily') as address_family, - json_extract_path_text(Properties, 'AllocationMinNetmaskLength') as allocation_min_netmask_length, - json_extract_path_text(Properties, 'AllocationDefaultNetmaskLength') as allocation_default_netmask_length, - json_extract_path_text(Properties, 'AllocationMaxNetmaskLength') as allocation_max_netmask_length, - json_extract_path_text(Properties, 'AllocationResourceTags') as allocation_resource_tags, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'AutoImport') as auto_import, - json_extract_path_text(Properties, 'AwsService') as aws_service, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'IpamScopeId') as ipam_scope_id, - json_extract_path_text(Properties, 'IpamScopeArn') as ipam_scope_arn, - json_extract_path_text(Properties, 'IpamScopeType') as ipam_scope_type, - json_extract_path_text(Properties, 'IpamArn') as ipam_arn, - json_extract_path_text(Properties, 'Locale') as locale, - json_extract_path_text(Properties, 'PoolDepth') as pool_depth, - json_extract_path_text(Properties, 'ProvisionedCidrs') as provisioned_cidrs, - json_extract_path_text(Properties, 'PublicIpSource') as public_ip_source, - json_extract_path_text(Properties, 'PubliclyAdvertisable') as publicly_advertisable, - json_extract_path_text(Properties, 'SourceIpamPoolId') as source_ipam_pool_id, - json_extract_path_text(Properties, 'SourceResource') as source_resource, - json_extract_path_text(Properties, 'State') as state, - json_extract_path_text(Properties, 'StateMessage') as state_message, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::IPAMPool' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.IpamPoolId') as ipam_pool_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::IPAMPool' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'IpamPoolId') as ipam_pool_id, + json_extract_path_text(Properties, 'AddressFamily') as address_family, + json_extract_path_text(Properties, 'AllocationMinNetmaskLength') as allocation_min_netmask_length, + json_extract_path_text(Properties, 'AllocationDefaultNetmaskLength') as allocation_default_netmask_length, + json_extract_path_text(Properties, 'AllocationMaxNetmaskLength') as allocation_max_netmask_length, + json_extract_path_text(Properties, 'AllocationResourceTags') as allocation_resource_tags, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'AutoImport') as auto_import, + json_extract_path_text(Properties, 'AwsService') as aws_service, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'IpamScopeId') as ipam_scope_id, + json_extract_path_text(Properties, 'IpamScopeArn') as ipam_scope_arn, + json_extract_path_text(Properties, 'IpamScopeType') as ipam_scope_type, + json_extract_path_text(Properties, 'IpamArn') as ipam_arn, + json_extract_path_text(Properties, 'Locale') as locale, + json_extract_path_text(Properties, 'PoolDepth') as pool_depth, + json_extract_path_text(Properties, 'ProvisionedCidrs') as provisioned_cidrs, + json_extract_path_text(Properties, 'PublicIpSource') as public_ip_source, + json_extract_path_text(Properties, 'PubliclyAdvertisable') as publicly_advertisable, + json_extract_path_text(Properties, 'SourceIpamPoolId') as source_ipam_pool_id, + json_extract_path_text(Properties, 'SourceResource') as source_resource, + json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'StateMessage') as state_message, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::IPAMPool' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'IpamPoolId') as ipam_pool_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::IPAMPool' + AND region = 'us-east-1' ipam_pool_cidrs: name: ipam_pool_cidrs id: aws.ec2.ipam_pool_cidrs @@ -16131,7 +16133,7 @@ components: x-identifiers: - IpamPoolId - IpamPoolCidrId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -16165,42 +16167,11 @@ components: - $ref: '#/components/x-stackQL-resources/ipam_pool_cidrs/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/ipam_pool_cidrs/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.IpamPoolId') as ipam_pool_id, - JSON_EXTRACT(Properties, '$.IpamPoolCidrId') as ipam_pool_cidr_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::IPAMPoolCidr' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'IpamPoolId') as ipam_pool_id, - json_extract_path_text(Properties, 'IpamPoolCidrId') as ipam_pool_cidr_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::IPAMPoolCidr' - AND region = 'us-east-1' - ipam_pool_cidr: - name: ipam_pool_cidr - id: aws.ec2.ipam_pool_cidr - x-cfn-schema-name: IPAMPoolCidr - x-cfn-type-name: AWS::EC2::IPAMPoolCidr - x-identifiers: - - IpamPoolId - - IpamPoolCidrId - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -16214,19 +16185,37 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'IpamPoolCidrId') as ipam_pool_cidr_id, - json_extract_path_text(Properties, 'IpamPoolId') as ipam_pool_id, - json_extract_path_text(Properties, 'Cidr') as cidr, - json_extract_path_text(Properties, 'NetmaskLength') as netmask_length, - json_extract_path_text(Properties, 'State') as state - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::IPAMPoolCidr' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.IpamPoolId') as ipam_pool_id, + JSON_EXTRACT(Properties, '$.IpamPoolCidrId') as ipam_pool_cidr_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::IPAMPoolCidr' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'IpamPoolCidrId') as ipam_pool_cidr_id, + json_extract_path_text(Properties, 'IpamPoolId') as ipam_pool_id, + json_extract_path_text(Properties, 'Cidr') as cidr, + json_extract_path_text(Properties, 'NetmaskLength') as netmask_length, + json_extract_path_text(Properties, 'State') as state + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::IPAMPoolCidr' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'IpamPoolId') as ipam_pool_id, + json_extract_path_text(Properties, 'IpamPoolCidrId') as ipam_pool_cidr_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::IPAMPoolCidr' + AND region = 'us-east-1' ipam_resource_discoveries: name: ipam_resource_discoveries id: aws.ec2.ipam_resource_discoveries @@ -16234,7 +16223,7 @@ components: x-cfn-type-name: AWS::EC2::IPAMResourceDiscovery x-identifiers: - IpamResourceDiscoveryId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -16251,9 +16240,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -16263,41 +16252,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/ipam_resource_discoveries/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/ipam_resource_discoveries/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.IpamResourceDiscoveryId') as ipam_resource_discovery_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::IPAMResourceDiscovery' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'IpamResourceDiscoveryId') as ipam_resource_discovery_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::IPAMResourceDiscovery' - AND region = 'us-east-1' - ipam_resource_discovery: - name: ipam_resource_discovery - id: aws.ec2.ipam_resource_discovery - x-cfn-schema-name: IPAMResourceDiscovery - x-cfn-type-name: AWS::EC2::IPAMResourceDiscovery - x-identifiers: - - IpamResourceDiscoveryId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -16308,12 +16265,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/ipam_resource_discoveries/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/ipam_resource_discoveries/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/ipam_resource_discovery/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/ipam_resource_discoveries/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -16331,23 +16292,39 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'IpamResourceDiscoveryId') as ipam_resource_discovery_id, - json_extract_path_text(Properties, 'OwnerId') as owner_id, - json_extract_path_text(Properties, 'OperatingRegions') as operating_regions, - json_extract_path_text(Properties, 'IpamResourceDiscoveryRegion') as ipam_resource_discovery_region, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'IsDefault') as is_default, - json_extract_path_text(Properties, 'IpamResourceDiscoveryArn') as ipam_resource_discovery_arn, - json_extract_path_text(Properties, 'State') as state, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::IPAMResourceDiscovery' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.IpamResourceDiscoveryId') as ipam_resource_discovery_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::IPAMResourceDiscovery' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'IpamResourceDiscoveryId') as ipam_resource_discovery_id, + json_extract_path_text(Properties, 'OwnerId') as owner_id, + json_extract_path_text(Properties, 'OperatingRegions') as operating_regions, + json_extract_path_text(Properties, 'IpamResourceDiscoveryRegion') as ipam_resource_discovery_region, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'IsDefault') as is_default, + json_extract_path_text(Properties, 'IpamResourceDiscoveryArn') as ipam_resource_discovery_arn, + json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::IPAMResourceDiscovery' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'IpamResourceDiscoveryId') as ipam_resource_discovery_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::IPAMResourceDiscovery' + AND region = 'us-east-1' ipam_resource_discovery_associations: name: ipam_resource_discovery_associations id: aws.ec2.ipam_resource_discovery_associations @@ -16355,7 +16332,7 @@ components: x-cfn-type-name: AWS::EC2::IPAMResourceDiscoveryAssociation x-identifiers: - IpamResourceDiscoveryAssociationId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -16372,9 +16349,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -16384,41 +16361,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/ipam_resource_discovery_associations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/ipam_resource_discovery_associations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.IpamResourceDiscoveryAssociationId') as ipam_resource_discovery_association_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::IPAMResourceDiscoveryAssociation' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'IpamResourceDiscoveryAssociationId') as ipam_resource_discovery_association_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::IPAMResourceDiscoveryAssociation' - AND region = 'us-east-1' - ipam_resource_discovery_association: - name: ipam_resource_discovery_association - id: aws.ec2.ipam_resource_discovery_association - x-cfn-schema-name: IPAMResourceDiscoveryAssociation - x-cfn-type-name: AWS::EC2::IPAMResourceDiscoveryAssociation - x-identifiers: - - IpamResourceDiscoveryAssociationId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -16429,12 +16374,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/ipam_resource_discovery_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/ipam_resource_discovery_associations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/ipam_resource_discovery_association/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/ipam_resource_discovery_associations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -16454,25 +16403,41 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'IpamArn') as ipam_arn, - json_extract_path_text(Properties, 'IpamRegion') as ipam_region, - json_extract_path_text(Properties, 'IpamResourceDiscoveryAssociationId') as ipam_resource_discovery_association_id, - json_extract_path_text(Properties, 'IpamResourceDiscoveryId') as ipam_resource_discovery_id, - json_extract_path_text(Properties, 'IpamId') as ipam_id, - json_extract_path_text(Properties, 'IpamResourceDiscoveryAssociationArn') as ipam_resource_discovery_association_arn, - json_extract_path_text(Properties, 'IsDefault') as is_default, - json_extract_path_text(Properties, 'OwnerId') as owner_id, - json_extract_path_text(Properties, 'State') as state, - json_extract_path_text(Properties, 'ResourceDiscoveryStatus') as resource_discovery_status, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::IPAMResourceDiscoveryAssociation' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.IpamResourceDiscoveryAssociationId') as ipam_resource_discovery_association_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::IPAMResourceDiscoveryAssociation' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'IpamArn') as ipam_arn, + json_extract_path_text(Properties, 'IpamRegion') as ipam_region, + json_extract_path_text(Properties, 'IpamResourceDiscoveryAssociationId') as ipam_resource_discovery_association_id, + json_extract_path_text(Properties, 'IpamResourceDiscoveryId') as ipam_resource_discovery_id, + json_extract_path_text(Properties, 'IpamId') as ipam_id, + json_extract_path_text(Properties, 'IpamResourceDiscoveryAssociationArn') as ipam_resource_discovery_association_arn, + json_extract_path_text(Properties, 'IsDefault') as is_default, + json_extract_path_text(Properties, 'OwnerId') as owner_id, + json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'ResourceDiscoveryStatus') as resource_discovery_status, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::IPAMResourceDiscoveryAssociation' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'IpamResourceDiscoveryAssociationId') as ipam_resource_discovery_association_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::IPAMResourceDiscoveryAssociation' + AND region = 'us-east-1' ipam_scopes: name: ipam_scopes id: aws.ec2.ipam_scopes @@ -16480,7 +16445,7 @@ components: x-cfn-type-name: AWS::EC2::IPAMScope x-identifiers: - IpamScopeId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -16497,9 +16462,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -16509,41 +16474,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/ipam_scopes/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/ipam_scopes/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.IpamScopeId') as ipam_scope_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::IPAMScope' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'IpamScopeId') as ipam_scope_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::IPAMScope' - AND region = 'us-east-1' - ipam_scope: - name: ipam_scope - id: aws.ec2.ipam_scope - x-cfn-schema-name: IPAMScope - x-cfn-type-name: AWS::EC2::IPAMScope - x-identifiers: - - IpamScopeId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -16554,12 +16487,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/ipam_scopes/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/ipam_scopes/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/ipam_scope/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/ipam_scopes/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -16577,23 +16514,39 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'IpamScopeId') as ipam_scope_id, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'IpamId') as ipam_id, - json_extract_path_text(Properties, 'IpamArn') as ipam_arn, - json_extract_path_text(Properties, 'IpamScopeType') as ipam_scope_type, - json_extract_path_text(Properties, 'IsDefault') as is_default, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'PoolCount') as pool_count, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::IPAMScope' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.IpamScopeId') as ipam_scope_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::IPAMScope' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'IpamScopeId') as ipam_scope_id, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'IpamId') as ipam_id, + json_extract_path_text(Properties, 'IpamArn') as ipam_arn, + json_extract_path_text(Properties, 'IpamScopeType') as ipam_scope_type, + json_extract_path_text(Properties, 'IsDefault') as is_default, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'PoolCount') as pool_count, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::IPAMScope' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'IpamScopeId') as ipam_scope_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::IPAMScope' + AND region = 'us-east-1' key_pairs: name: key_pairs id: aws.ec2.key_pairs @@ -16601,7 +16554,7 @@ components: x-cfn-type-name: AWS::EC2::KeyPair x-identifiers: - KeyName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -16635,39 +16588,11 @@ components: - $ref: '#/components/x-stackQL-resources/key_pairs/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/key_pairs/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.KeyName') as key_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::KeyPair' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'KeyName') as key_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::KeyPair' - AND region = 'us-east-1' - key_pair: - name: key_pair - id: aws.ec2.key_pair - x-cfn-schema-name: KeyPair - x-cfn-type-name: AWS::EC2::KeyPair - x-identifiers: - - KeyName - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -16683,21 +16608,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'KeyName') as key_name, - json_extract_path_text(Properties, 'KeyType') as key_type, - json_extract_path_text(Properties, 'KeyFormat') as key_format, - json_extract_path_text(Properties, 'PublicKeyMaterial') as public_key_material, - json_extract_path_text(Properties, 'KeyFingerprint') as key_fingerprint, - json_extract_path_text(Properties, 'KeyPairId') as key_pair_id, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::KeyPair' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.KeyName') as key_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::KeyPair' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'KeyName') as key_name, + json_extract_path_text(Properties, 'KeyType') as key_type, + json_extract_path_text(Properties, 'KeyFormat') as key_format, + json_extract_path_text(Properties, 'PublicKeyMaterial') as public_key_material, + json_extract_path_text(Properties, 'KeyFingerprint') as key_fingerprint, + json_extract_path_text(Properties, 'KeyPairId') as key_pair_id, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::KeyPair' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'KeyName') as key_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::KeyPair' + AND region = 'us-east-1' launch_templates: name: launch_templates id: aws.ec2.launch_templates @@ -16705,7 +16646,7 @@ components: x-cfn-type-name: AWS::EC2::LaunchTemplate x-identifiers: - LaunchTemplateId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -16722,9 +16663,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -16734,41 +16675,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/launch_templates/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/launch_templates/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.LaunchTemplateId') as launch_template_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::LaunchTemplate' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'LaunchTemplateId') as launch_template_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::LaunchTemplate' - AND region = 'us-east-1' - launch_template: - name: launch_template - id: aws.ec2.launch_template - x-cfn-schema-name: LaunchTemplate - x-cfn-type-name: AWS::EC2::LaunchTemplate - x-identifiers: - - LaunchTemplateId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -16779,12 +16688,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/launch_templates/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/launch_templates/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/launch_template/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/launch_templates/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -16800,21 +16713,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'LaunchTemplateName') as launch_template_name, - json_extract_path_text(Properties, 'LaunchTemplateData') as launch_template_data, - json_extract_path_text(Properties, 'VersionDescription') as version_description, - json_extract_path_text(Properties, 'TagSpecifications') as tag_specifications, - json_extract_path_text(Properties, 'LatestVersionNumber') as latest_version_number, - json_extract_path_text(Properties, 'LaunchTemplateId') as launch_template_id, - json_extract_path_text(Properties, 'DefaultVersionNumber') as default_version_number - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::LaunchTemplate' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.LaunchTemplateId') as launch_template_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::LaunchTemplate' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'LaunchTemplateName') as launch_template_name, + json_extract_path_text(Properties, 'LaunchTemplateData') as launch_template_data, + json_extract_path_text(Properties, 'VersionDescription') as version_description, + json_extract_path_text(Properties, 'TagSpecifications') as tag_specifications, + json_extract_path_text(Properties, 'LatestVersionNumber') as latest_version_number, + json_extract_path_text(Properties, 'LaunchTemplateId') as launch_template_id, + json_extract_path_text(Properties, 'DefaultVersionNumber') as default_version_number + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::LaunchTemplate' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'LaunchTemplateId') as launch_template_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::LaunchTemplate' + AND region = 'us-east-1' local_gateway_routes: name: local_gateway_routes id: aws.ec2.local_gateway_routes @@ -16823,7 +16752,7 @@ components: x-identifiers: - DestinationCidrBlock - LocalGatewayRouteTableId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -16840,9 +16769,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -16852,44 +16781,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/local_gateway_routes/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/local_gateway_routes/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.DestinationCidrBlock') as destination_cidr_block, - JSON_EXTRACT(Properties, '$.LocalGatewayRouteTableId') as local_gateway_route_table_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::LocalGatewayRoute' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'DestinationCidrBlock') as destination_cidr_block, - json_extract_path_text(Properties, 'LocalGatewayRouteTableId') as local_gateway_route_table_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::LocalGatewayRoute' - AND region = 'us-east-1' - local_gateway_route: - name: local_gateway_route - id: aws.ec2.local_gateway_route - x-cfn-schema-name: LocalGatewayRoute - x-cfn-type-name: AWS::EC2::LocalGatewayRoute - x-identifiers: - - DestinationCidrBlock - - LocalGatewayRouteTableId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -16900,12 +16794,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/local_gateway_routes/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/local_gateway_routes/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/local_gateway_route/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/local_gateway_routes/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -16920,20 +16818,38 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'DestinationCidrBlock') as destination_cidr_block, - json_extract_path_text(Properties, 'LocalGatewayRouteTableId') as local_gateway_route_table_id, - json_extract_path_text(Properties, 'LocalGatewayVirtualInterfaceGroupId') as local_gateway_virtual_interface_group_id, - json_extract_path_text(Properties, 'NetworkInterfaceId') as network_interface_id, - json_extract_path_text(Properties, 'State') as state, - json_extract_path_text(Properties, 'Type') as type - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::LocalGatewayRoute' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.DestinationCidrBlock') as destination_cidr_block, + JSON_EXTRACT(Properties, '$.LocalGatewayRouteTableId') as local_gateway_route_table_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::LocalGatewayRoute' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DestinationCidrBlock') as destination_cidr_block, + json_extract_path_text(Properties, 'LocalGatewayRouteTableId') as local_gateway_route_table_id, + json_extract_path_text(Properties, 'LocalGatewayVirtualInterfaceGroupId') as local_gateway_virtual_interface_group_id, + json_extract_path_text(Properties, 'NetworkInterfaceId') as network_interface_id, + json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'Type') as type + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::LocalGatewayRoute' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DestinationCidrBlock') as destination_cidr_block, + json_extract_path_text(Properties, 'LocalGatewayRouteTableId') as local_gateway_route_table_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::LocalGatewayRoute' + AND region = 'us-east-1' local_gateway_route_tables: name: local_gateway_route_tables id: aws.ec2.local_gateway_route_tables @@ -16941,7 +16857,7 @@ components: x-cfn-type-name: AWS::EC2::LocalGatewayRouteTable x-identifiers: - LocalGatewayRouteTableId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -16958,9 +16874,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -16970,41 +16886,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/local_gateway_route_tables/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/local_gateway_route_tables/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.LocalGatewayRouteTableId') as local_gateway_route_table_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::LocalGatewayRouteTable' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'LocalGatewayRouteTableId') as local_gateway_route_table_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::LocalGatewayRouteTable' - AND region = 'us-east-1' - local_gateway_route_table: - name: local_gateway_route_table - id: aws.ec2.local_gateway_route_table - x-cfn-schema-name: LocalGatewayRouteTable - x-cfn-type-name: AWS::EC2::LocalGatewayRouteTable - x-identifiers: - - LocalGatewayRouteTableId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -17015,12 +16899,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/local_gateway_route_tables/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/local_gateway_route_tables/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/local_gateway_route_table/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/local_gateway_route_tables/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -17037,22 +16925,38 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'LocalGatewayRouteTableId') as local_gateway_route_table_id, - json_extract_path_text(Properties, 'LocalGatewayRouteTableArn') as local_gateway_route_table_arn, - json_extract_path_text(Properties, 'LocalGatewayId') as local_gateway_id, - json_extract_path_text(Properties, 'OutpostArn') as outpost_arn, - json_extract_path_text(Properties, 'OwnerId') as owner_id, - json_extract_path_text(Properties, 'State') as state, - json_extract_path_text(Properties, 'Mode') as mode, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::LocalGatewayRouteTable' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.LocalGatewayRouteTableId') as local_gateway_route_table_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::LocalGatewayRouteTable' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'LocalGatewayRouteTableId') as local_gateway_route_table_id, + json_extract_path_text(Properties, 'LocalGatewayRouteTableArn') as local_gateway_route_table_arn, + json_extract_path_text(Properties, 'LocalGatewayId') as local_gateway_id, + json_extract_path_text(Properties, 'OutpostArn') as outpost_arn, + json_extract_path_text(Properties, 'OwnerId') as owner_id, + json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'Mode') as mode, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::LocalGatewayRouteTable' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'LocalGatewayRouteTableId') as local_gateway_route_table_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::LocalGatewayRouteTable' + AND region = 'us-east-1' local_gateway_route_table_virtual_interface_group_associations: name: local_gateway_route_table_virtual_interface_group_associations id: aws.ec2.local_gateway_route_table_virtual_interface_group_associations @@ -17060,7 +16964,7 @@ components: x-cfn-type-name: AWS::EC2::LocalGatewayRouteTableVirtualInterfaceGroupAssociation x-identifiers: - LocalGatewayRouteTableVirtualInterfaceGroupAssociationId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -17077,9 +16981,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -17089,41 +16993,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/local_gateway_route_table_virtual_interface_group_associations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/local_gateway_route_table_virtual_interface_group_associations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.LocalGatewayRouteTableVirtualInterfaceGroupAssociationId') as local_gateway_route_table_virtual_interface_group_association_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::LocalGatewayRouteTableVirtualInterfaceGroupAssociation' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'LocalGatewayRouteTableVirtualInterfaceGroupAssociationId') as local_gateway_route_table_virtual_interface_group_association_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::LocalGatewayRouteTableVirtualInterfaceGroupAssociation' - AND region = 'us-east-1' - local_gateway_route_table_virtual_interface_group_association: - name: local_gateway_route_table_virtual_interface_group_association - id: aws.ec2.local_gateway_route_table_virtual_interface_group_association - x-cfn-schema-name: LocalGatewayRouteTableVirtualInterfaceGroupAssociation - x-cfn-type-name: AWS::EC2::LocalGatewayRouteTableVirtualInterfaceGroupAssociation - x-identifiers: - - LocalGatewayRouteTableVirtualInterfaceGroupAssociationId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -17134,12 +17006,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/local_gateway_route_table_virtual_interface_group_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/local_gateway_route_table_virtual_interface_group_associations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/local_gateway_route_table_virtual_interface_group_association/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/local_gateway_route_table_virtual_interface_group_associations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -17156,22 +17032,38 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'LocalGatewayRouteTableVirtualInterfaceGroupAssociationId') as local_gateway_route_table_virtual_interface_group_association_id, - json_extract_path_text(Properties, 'LocalGatewayId') as local_gateway_id, - json_extract_path_text(Properties, 'LocalGatewayRouteTableId') as local_gateway_route_table_id, - json_extract_path_text(Properties, 'LocalGatewayRouteTableArn') as local_gateway_route_table_arn, - json_extract_path_text(Properties, 'LocalGatewayVirtualInterfaceGroupId') as local_gateway_virtual_interface_group_id, - json_extract_path_text(Properties, 'OwnerId') as owner_id, - json_extract_path_text(Properties, 'State') as state, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::LocalGatewayRouteTableVirtualInterfaceGroupAssociation' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.LocalGatewayRouteTableVirtualInterfaceGroupAssociationId') as local_gateway_route_table_virtual_interface_group_association_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::LocalGatewayRouteTableVirtualInterfaceGroupAssociation' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'LocalGatewayRouteTableVirtualInterfaceGroupAssociationId') as local_gateway_route_table_virtual_interface_group_association_id, + json_extract_path_text(Properties, 'LocalGatewayId') as local_gateway_id, + json_extract_path_text(Properties, 'LocalGatewayRouteTableId') as local_gateway_route_table_id, + json_extract_path_text(Properties, 'LocalGatewayRouteTableArn') as local_gateway_route_table_arn, + json_extract_path_text(Properties, 'LocalGatewayVirtualInterfaceGroupId') as local_gateway_virtual_interface_group_id, + json_extract_path_text(Properties, 'OwnerId') as owner_id, + json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::LocalGatewayRouteTableVirtualInterfaceGroupAssociation' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'LocalGatewayRouteTableVirtualInterfaceGroupAssociationId') as local_gateway_route_table_virtual_interface_group_association_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::LocalGatewayRouteTableVirtualInterfaceGroupAssociation' + AND region = 'us-east-1' local_gateway_route_tablevpc_associations: name: local_gateway_route_tablevpc_associations id: aws.ec2.local_gateway_route_tablevpc_associations @@ -17179,7 +17071,7 @@ components: x-cfn-type-name: AWS::EC2::LocalGatewayRouteTableVPCAssociation x-identifiers: - LocalGatewayRouteTableVpcAssociationId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -17196,9 +17088,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -17208,41 +17100,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/local_gateway_route_tablevpc_associations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/local_gateway_route_tablevpc_associations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.LocalGatewayRouteTableVpcAssociationId') as local_gateway_route_table_vpc_association_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::LocalGatewayRouteTableVPCAssociation' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'LocalGatewayRouteTableVpcAssociationId') as local_gateway_route_table_vpc_association_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::LocalGatewayRouteTableVPCAssociation' - AND region = 'us-east-1' - local_gateway_route_tablevpc_association: - name: local_gateway_route_tablevpc_association - id: aws.ec2.local_gateway_route_tablevpc_association - x-cfn-schema-name: LocalGatewayRouteTableVPCAssociation - x-cfn-type-name: AWS::EC2::LocalGatewayRouteTableVPCAssociation - x-identifiers: - - LocalGatewayRouteTableVpcAssociationId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -17253,12 +17113,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/local_gateway_route_tablevpc_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/local_gateway_route_tablevpc_associations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/local_gateway_route_tablevpc_association/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/local_gateway_route_tablevpc_associations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -17273,20 +17137,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'LocalGatewayId') as local_gateway_id, - json_extract_path_text(Properties, 'LocalGatewayRouteTableId') as local_gateway_route_table_id, - json_extract_path_text(Properties, 'LocalGatewayRouteTableVpcAssociationId') as local_gateway_route_table_vpc_association_id, - json_extract_path_text(Properties, 'State') as state, - json_extract_path_text(Properties, 'VpcId') as vpc_id, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::LocalGatewayRouteTableVPCAssociation' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.LocalGatewayRouteTableVpcAssociationId') as local_gateway_route_table_vpc_association_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::LocalGatewayRouteTableVPCAssociation' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'LocalGatewayId') as local_gateway_id, + json_extract_path_text(Properties, 'LocalGatewayRouteTableId') as local_gateway_route_table_id, + json_extract_path_text(Properties, 'LocalGatewayRouteTableVpcAssociationId') as local_gateway_route_table_vpc_association_id, + json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'VpcId') as vpc_id, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::LocalGatewayRouteTableVPCAssociation' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'LocalGatewayRouteTableVpcAssociationId') as local_gateway_route_table_vpc_association_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::LocalGatewayRouteTableVPCAssociation' + AND region = 'us-east-1' nat_gateways: name: nat_gateways id: aws.ec2.nat_gateways @@ -17294,7 +17174,7 @@ components: x-cfn-type-name: AWS::EC2::NatGateway x-identifiers: - NatGatewayId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -17311,9 +17191,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -17323,41 +17203,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/nat_gateways/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/nat_gateways/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.NatGatewayId') as nat_gateway_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NatGateway' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'NatGatewayId') as nat_gateway_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NatGateway' - AND region = 'us-east-1' - nat_gateway: - name: nat_gateway - id: aws.ec2.nat_gateway - x-cfn-schema-name: NatGateway - x-cfn-type-name: AWS::EC2::NatGateway - x-identifiers: - - NatGatewayId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -17368,12 +17216,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/nat_gateways/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/nat_gateways/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/nat_gateway/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/nat_gateways/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -17392,24 +17244,40 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'SecondaryAllocationIds') as secondary_allocation_ids, - json_extract_path_text(Properties, 'PrivateIpAddress') as private_ip_address, - json_extract_path_text(Properties, 'ConnectivityType') as connectivity_type, - json_extract_path_text(Properties, 'SecondaryPrivateIpAddresses') as secondary_private_ip_addresses, - json_extract_path_text(Properties, 'SecondaryPrivateIpAddressCount') as secondary_private_ip_address_count, - json_extract_path_text(Properties, 'AllocationId') as allocation_id, - json_extract_path_text(Properties, 'SubnetId') as subnet_id, - json_extract_path_text(Properties, 'NatGatewayId') as nat_gateway_id, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'MaxDrainDurationSeconds') as max_drain_duration_seconds - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::NatGateway' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.NatGatewayId') as nat_gateway_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NatGateway' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'SecondaryAllocationIds') as secondary_allocation_ids, + json_extract_path_text(Properties, 'PrivateIpAddress') as private_ip_address, + json_extract_path_text(Properties, 'ConnectivityType') as connectivity_type, + json_extract_path_text(Properties, 'SecondaryPrivateIpAddresses') as secondary_private_ip_addresses, + json_extract_path_text(Properties, 'SecondaryPrivateIpAddressCount') as secondary_private_ip_address_count, + json_extract_path_text(Properties, 'AllocationId') as allocation_id, + json_extract_path_text(Properties, 'SubnetId') as subnet_id, + json_extract_path_text(Properties, 'NatGatewayId') as nat_gateway_id, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'MaxDrainDurationSeconds') as max_drain_duration_seconds + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::NatGateway' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'NatGatewayId') as nat_gateway_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NatGateway' + AND region = 'us-east-1' network_acls: name: network_acls id: aws.ec2.network_acls @@ -17417,7 +17285,7 @@ components: x-cfn-type-name: AWS::EC2::NetworkAcl x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -17434,6 +17302,18 @@ components: response: mediaType: application/json openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::NetworkAcl" + } + response: + mediaType: application/json + openAPIDocKey: '200' delete_resource: operation: $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' @@ -17451,74 +17331,50 @@ components: - $ref: '#/components/x-stackQL-resources/network_acls/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/network_acls/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/network_acls/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NetworkAcl' + data__Identifier, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.VpcId') as vpc_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::NetworkAcl' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Id') as id + JSON_EXTRACT(Properties, '$.Id') as id FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NetworkAcl' AND region = 'us-east-1' - network_acl: - name: network_acl - id: aws.ec2.network_acl - x-cfn-schema-name: NetworkAcl - x-cfn-type-name: AWS::EC2::NetworkAcl - x-identifiers: - - Id - x-type: get - methods: - update_resource: - operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' - request: - mediaType: application/x-amz-json-1.0 - base: |- - { - "TypeName": "AWS::EC2::NetworkAcl" - } - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - update: - - $ref: '#/components/x-stackQL-resources/network_acl/methods/update_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - data__Identifier, - JSON_EXTRACT(Properties, '$.Id') as id, - JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.VpcId') as vpc_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::NetworkAcl' - AND data__Identifier = '' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'VpcId') as vpc_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::NetworkAcl' - AND data__Identifier = '' - AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'VpcId') as vpc_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::NetworkAcl' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NetworkAcl' + AND region = 'us-east-1' network_insights_access_scopes: name: network_insights_access_scopes id: aws.ec2.network_insights_access_scopes @@ -17526,7 +17382,7 @@ components: x-cfn-type-name: AWS::EC2::NetworkInsightsAccessScope x-identifiers: - NetworkInsightsAccessScopeId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -17543,9 +17399,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -17555,41 +17411,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/network_insights_access_scopes/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/network_insights_access_scopes/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.NetworkInsightsAccessScopeId') as network_insights_access_scope_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NetworkInsightsAccessScope' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'NetworkInsightsAccessScopeId') as network_insights_access_scope_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NetworkInsightsAccessScope' - AND region = 'us-east-1' - network_insights_access_scope: - name: network_insights_access_scope - id: aws.ec2.network_insights_access_scope - x-cfn-schema-name: NetworkInsightsAccessScope - x-cfn-type-name: AWS::EC2::NetworkInsightsAccessScope - x-identifiers: - - NetworkInsightsAccessScopeId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -17600,12 +17424,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/network_insights_access_scopes/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/network_insights_access_scopes/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/network_insights_access_scope/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/network_insights_access_scopes/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -17621,21 +17449,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'NetworkInsightsAccessScopeId') as network_insights_access_scope_id, - json_extract_path_text(Properties, 'NetworkInsightsAccessScopeArn') as network_insights_access_scope_arn, - json_extract_path_text(Properties, 'CreatedDate') as created_date, - json_extract_path_text(Properties, 'UpdatedDate') as updated_date, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'MatchPaths') as match_paths, - json_extract_path_text(Properties, 'ExcludePaths') as exclude_paths - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::NetworkInsightsAccessScope' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.NetworkInsightsAccessScopeId') as network_insights_access_scope_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NetworkInsightsAccessScope' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'NetworkInsightsAccessScopeId') as network_insights_access_scope_id, + json_extract_path_text(Properties, 'NetworkInsightsAccessScopeArn') as network_insights_access_scope_arn, + json_extract_path_text(Properties, 'CreatedDate') as created_date, + json_extract_path_text(Properties, 'UpdatedDate') as updated_date, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'MatchPaths') as match_paths, + json_extract_path_text(Properties, 'ExcludePaths') as exclude_paths + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::NetworkInsightsAccessScope' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'NetworkInsightsAccessScopeId') as network_insights_access_scope_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NetworkInsightsAccessScope' + AND region = 'us-east-1' network_insights_access_scope_analyses: name: network_insights_access_scope_analyses id: aws.ec2.network_insights_access_scope_analyses @@ -17643,7 +17487,7 @@ components: x-cfn-type-name: AWS::EC2::NetworkInsightsAccessScopeAnalysis x-identifiers: - NetworkInsightsAccessScopeAnalysisId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -17660,9 +17504,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -17672,41 +17516,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/network_insights_access_scope_analyses/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/network_insights_access_scope_analyses/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.NetworkInsightsAccessScopeAnalysisId') as network_insights_access_scope_analysis_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NetworkInsightsAccessScopeAnalysis' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'NetworkInsightsAccessScopeAnalysisId') as network_insights_access_scope_analysis_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NetworkInsightsAccessScopeAnalysis' - AND region = 'us-east-1' - network_insights_access_scope_analysis: - name: network_insights_access_scope_analysis - id: aws.ec2.network_insights_access_scope_analysis - x-cfn-schema-name: NetworkInsightsAccessScopeAnalysis - x-cfn-type-name: AWS::EC2::NetworkInsightsAccessScopeAnalysis - x-identifiers: - - NetworkInsightsAccessScopeAnalysisId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -17717,12 +17529,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/network_insights_access_scope_analyses/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/network_insights_access_scope_analyses/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/network_insights_access_scope_analysis/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/network_insights_access_scope_analyses/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -17741,24 +17557,40 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'NetworkInsightsAccessScopeAnalysisId') as network_insights_access_scope_analysis_id, - json_extract_path_text(Properties, 'NetworkInsightsAccessScopeAnalysisArn') as network_insights_access_scope_analysis_arn, - json_extract_path_text(Properties, 'NetworkInsightsAccessScopeId') as network_insights_access_scope_id, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'StatusMessage') as status_message, - json_extract_path_text(Properties, 'StartDate') as start_date, - json_extract_path_text(Properties, 'EndDate') as end_date, - json_extract_path_text(Properties, 'FindingsFound') as findings_found, - json_extract_path_text(Properties, 'AnalyzedEniCount') as analyzed_eni_count, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::NetworkInsightsAccessScopeAnalysis' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.NetworkInsightsAccessScopeAnalysisId') as network_insights_access_scope_analysis_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NetworkInsightsAccessScopeAnalysis' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'NetworkInsightsAccessScopeAnalysisId') as network_insights_access_scope_analysis_id, + json_extract_path_text(Properties, 'NetworkInsightsAccessScopeAnalysisArn') as network_insights_access_scope_analysis_arn, + json_extract_path_text(Properties, 'NetworkInsightsAccessScopeId') as network_insights_access_scope_id, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'StatusMessage') as status_message, + json_extract_path_text(Properties, 'StartDate') as start_date, + json_extract_path_text(Properties, 'EndDate') as end_date, + json_extract_path_text(Properties, 'FindingsFound') as findings_found, + json_extract_path_text(Properties, 'AnalyzedEniCount') as analyzed_eni_count, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::NetworkInsightsAccessScopeAnalysis' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'NetworkInsightsAccessScopeAnalysisId') as network_insights_access_scope_analysis_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NetworkInsightsAccessScopeAnalysis' + AND region = 'us-east-1' network_insights_analyses: name: network_insights_analyses id: aws.ec2.network_insights_analyses @@ -17766,7 +17598,7 @@ components: x-cfn-type-name: AWS::EC2::NetworkInsightsAnalysis x-identifiers: - NetworkInsightsAnalysisId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -17783,9 +17615,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -17795,41 +17627,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/network_insights_analyses/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/network_insights_analyses/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.NetworkInsightsAnalysisId') as network_insights_analysis_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NetworkInsightsAnalysis' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'NetworkInsightsAnalysisId') as network_insights_analysis_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NetworkInsightsAnalysis' - AND region = 'us-east-1' - network_insights_analysis: - name: network_insights_analysis - id: aws.ec2.network_insights_analysis - x-cfn-schema-name: NetworkInsightsAnalysis - x-cfn-type-name: AWS::EC2::NetworkInsightsAnalysis - x-identifiers: - - NetworkInsightsAnalysisId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -17840,12 +17640,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/network_insights_analyses/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/network_insights_analyses/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/network_insights_analysis/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/network_insights_analyses/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -17869,29 +17673,45 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'ReturnPathComponents') as return_path_components, - json_extract_path_text(Properties, 'NetworkInsightsAnalysisId') as network_insights_analysis_id, - json_extract_path_text(Properties, 'NetworkInsightsPathId') as network_insights_path_id, - json_extract_path_text(Properties, 'NetworkPathFound') as network_path_found, - json_extract_path_text(Properties, 'SuggestedAccounts') as suggested_accounts, - json_extract_path_text(Properties, 'FilterInArns') as filter_in_arns, - json_extract_path_text(Properties, 'NetworkInsightsAnalysisArn') as network_insights_analysis_arn, - json_extract_path_text(Properties, 'StatusMessage') as status_message, - json_extract_path_text(Properties, 'StartDate') as start_date, - json_extract_path_text(Properties, 'AlternatePathHints') as alternate_path_hints, - json_extract_path_text(Properties, 'Explanations') as explanations, - json_extract_path_text(Properties, 'ForwardPathComponents') as forward_path_components, - json_extract_path_text(Properties, 'AdditionalAccounts') as additional_accounts, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::NetworkInsightsAnalysis' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.NetworkInsightsAnalysisId') as network_insights_analysis_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NetworkInsightsAnalysis' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'ReturnPathComponents') as return_path_components, + json_extract_path_text(Properties, 'NetworkInsightsAnalysisId') as network_insights_analysis_id, + json_extract_path_text(Properties, 'NetworkInsightsPathId') as network_insights_path_id, + json_extract_path_text(Properties, 'NetworkPathFound') as network_path_found, + json_extract_path_text(Properties, 'SuggestedAccounts') as suggested_accounts, + json_extract_path_text(Properties, 'FilterInArns') as filter_in_arns, + json_extract_path_text(Properties, 'NetworkInsightsAnalysisArn') as network_insights_analysis_arn, + json_extract_path_text(Properties, 'StatusMessage') as status_message, + json_extract_path_text(Properties, 'StartDate') as start_date, + json_extract_path_text(Properties, 'AlternatePathHints') as alternate_path_hints, + json_extract_path_text(Properties, 'Explanations') as explanations, + json_extract_path_text(Properties, 'ForwardPathComponents') as forward_path_components, + json_extract_path_text(Properties, 'AdditionalAccounts') as additional_accounts, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::NetworkInsightsAnalysis' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'NetworkInsightsAnalysisId') as network_insights_analysis_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NetworkInsightsAnalysis' + AND region = 'us-east-1' network_insights_paths: name: network_insights_paths id: aws.ec2.network_insights_paths @@ -17899,7 +17719,7 @@ components: x-cfn-type-name: AWS::EC2::NetworkInsightsPath x-identifiers: - NetworkInsightsPathId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -17916,9 +17736,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -17928,41 +17748,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/network_insights_paths/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/network_insights_paths/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.NetworkInsightsPathId') as network_insights_path_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NetworkInsightsPath' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'NetworkInsightsPathId') as network_insights_path_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NetworkInsightsPath' - AND region = 'us-east-1' - network_insights_path: - name: network_insights_path - id: aws.ec2.network_insights_path - x-cfn-schema-name: NetworkInsightsPath - x-cfn-type-name: AWS::EC2::NetworkInsightsPath - x-identifiers: - - NetworkInsightsPathId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -17973,12 +17761,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/network_insights_paths/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/network_insights_paths/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/network_insights_path/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/network_insights_paths/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -18001,28 +17793,44 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'NetworkInsightsPathId') as network_insights_path_id, - json_extract_path_text(Properties, 'NetworkInsightsPathArn') as network_insights_path_arn, - json_extract_path_text(Properties, 'CreatedDate') as created_date, - json_extract_path_text(Properties, 'SourceIp') as source_ip, - json_extract_path_text(Properties, 'FilterAtSource') as filter_at_source, - json_extract_path_text(Properties, 'FilterAtDestination') as filter_at_destination, - json_extract_path_text(Properties, 'DestinationIp') as destination_ip, - json_extract_path_text(Properties, 'Source') as source, - json_extract_path_text(Properties, 'Destination') as destination, - json_extract_path_text(Properties, 'SourceArn') as source_arn, - json_extract_path_text(Properties, 'DestinationArn') as destination_arn, - json_extract_path_text(Properties, 'Protocol') as protocol, - json_extract_path_text(Properties, 'DestinationPort') as destination_port, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::NetworkInsightsPath' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.NetworkInsightsPathId') as network_insights_path_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NetworkInsightsPath' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'NetworkInsightsPathId') as network_insights_path_id, + json_extract_path_text(Properties, 'NetworkInsightsPathArn') as network_insights_path_arn, + json_extract_path_text(Properties, 'CreatedDate') as created_date, + json_extract_path_text(Properties, 'SourceIp') as source_ip, + json_extract_path_text(Properties, 'FilterAtSource') as filter_at_source, + json_extract_path_text(Properties, 'FilterAtDestination') as filter_at_destination, + json_extract_path_text(Properties, 'DestinationIp') as destination_ip, + json_extract_path_text(Properties, 'Source') as source, + json_extract_path_text(Properties, 'Destination') as destination, + json_extract_path_text(Properties, 'SourceArn') as source_arn, + json_extract_path_text(Properties, 'DestinationArn') as destination_arn, + json_extract_path_text(Properties, 'Protocol') as protocol, + json_extract_path_text(Properties, 'DestinationPort') as destination_port, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::NetworkInsightsPath' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'NetworkInsightsPathId') as network_insights_path_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NetworkInsightsPath' + AND region = 'us-east-1' network_interface_attachments: name: network_interface_attachments id: aws.ec2.network_interface_attachments @@ -18030,7 +17838,7 @@ components: x-cfn-type-name: AWS::EC2::NetworkInterfaceAttachment x-identifiers: - AttachmentId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -18047,9 +17855,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -18059,41 +17867,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/network_interface_attachments/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/network_interface_attachments/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AttachmentId') as attachment_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NetworkInterfaceAttachment' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AttachmentId') as attachment_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NetworkInterfaceAttachment' - AND region = 'us-east-1' - network_interface_attachment: - name: network_interface_attachment - id: aws.ec2.network_interface_attachment - x-cfn-schema-name: NetworkInterfaceAttachment - x-cfn-type-name: AWS::EC2::NetworkInterfaceAttachment - x-identifiers: - - AttachmentId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -18104,12 +17880,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/network_interface_attachments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/network_interface_attachments/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/network_interface_attachment/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/network_interface_attachments/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -18124,20 +17904,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AttachmentId') as attachment_id, - json_extract_path_text(Properties, 'DeleteOnTermination') as delete_on_termination, - json_extract_path_text(Properties, 'DeviceIndex') as device_index, - json_extract_path_text(Properties, 'InstanceId') as instance_id, - json_extract_path_text(Properties, 'NetworkInterfaceId') as network_interface_id, - json_extract_path_text(Properties, 'EnaSrdSpecification') as ena_srd_specification - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::NetworkInterfaceAttachment' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.AttachmentId') as attachment_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NetworkInterfaceAttachment' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AttachmentId') as attachment_id, + json_extract_path_text(Properties, 'DeleteOnTermination') as delete_on_termination, + json_extract_path_text(Properties, 'DeviceIndex') as device_index, + json_extract_path_text(Properties, 'InstanceId') as instance_id, + json_extract_path_text(Properties, 'NetworkInterfaceId') as network_interface_id, + json_extract_path_text(Properties, 'EnaSrdSpecification') as ena_srd_specification + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::NetworkInterfaceAttachment' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AttachmentId') as attachment_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NetworkInterfaceAttachment' + AND region = 'us-east-1' network_performance_metric_subscriptions: name: network_performance_metric_subscriptions id: aws.ec2.network_performance_metric_subscriptions @@ -18148,7 +17944,7 @@ components: - Destination - Metric - Statistic - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -18182,80 +17978,65 @@ components: - $ref: '#/components/x-stackQL-resources/network_performance_metric_subscriptions/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/network_performance_metric_subscriptions/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, + data__Identifier, JSON_EXTRACT(Properties, '$.Source') as source, JSON_EXTRACT(Properties, '$.Destination') as destination, JSON_EXTRACT(Properties, '$.Metric') as metric, JSON_EXTRACT(Properties, '$.Statistic') as statistic - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NetworkPerformanceMetricSubscription' + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::NetworkPerformanceMetricSubscription' + AND data__Identifier = '|||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - json_extract_path_text(Properties, 'Source') as source, - json_extract_path_text(Properties, 'Destination') as destination, - json_extract_path_text(Properties, 'Metric') as metric, - json_extract_path_text(Properties, 'Statistic') as statistic + JSON_EXTRACT(Properties, '$.Source') as source, + JSON_EXTRACT(Properties, '$.Destination') as destination, + JSON_EXTRACT(Properties, '$.Metric') as metric, + JSON_EXTRACT(Properties, '$.Statistic') as statistic FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NetworkPerformanceMetricSubscription' AND region = 'us-east-1' - network_performance_metric_subscription: - name: network_performance_metric_subscription - id: aws.ec2.network_performance_metric_subscription - x-cfn-schema-name: NetworkPerformanceMetricSubscription - x-cfn-type-name: AWS::EC2::NetworkPerformanceMetricSubscription - x-identifiers: - - Source - - Destination - - Metric - - Statistic - x-type: get - methods: {} - sqlVerbs: - update: [] - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - data__Identifier, - JSON_EXTRACT(Properties, '$.Source') as source, - JSON_EXTRACT(Properties, '$.Destination') as destination, - JSON_EXTRACT(Properties, '$.Metric') as metric, - JSON_EXTRACT(Properties, '$.Statistic') as statistic - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::NetworkPerformanceMetricSubscription' - AND data__Identifier = '|||' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - data__Identifier, - json_extract_path_text(Properties, 'Source') as source, - json_extract_path_text(Properties, 'Destination') as destination, - json_extract_path_text(Properties, 'Metric') as metric, - json_extract_path_text(Properties, 'Statistic') as statistic - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::NetworkPerformanceMetricSubscription' - AND data__Identifier = '|||' - AND region = 'us-east-1' - placement_groups: - name: placement_groups - id: aws.ec2.placement_groups - x-cfn-schema-name: PlacementGroup - x-cfn-type-name: AWS::EC2::PlacementGroup + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Source') as source, + json_extract_path_text(Properties, 'Destination') as destination, + json_extract_path_text(Properties, 'Metric') as metric, + json_extract_path_text(Properties, 'Statistic') as statistic + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::NetworkPerformanceMetricSubscription' + AND data__Identifier = '|||' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Source') as source, + json_extract_path_text(Properties, 'Destination') as destination, + json_extract_path_text(Properties, 'Metric') as metric, + json_extract_path_text(Properties, 'Statistic') as statistic + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::NetworkPerformanceMetricSubscription' + AND region = 'us-east-1' + placement_groups: + name: placement_groups + id: aws.ec2.placement_groups + x-cfn-schema-name: PlacementGroup + x-cfn-type-name: AWS::EC2::PlacementGroup x-identifiers: - GroupName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -18289,39 +18070,11 @@ components: - $ref: '#/components/x-stackQL-resources/placement_groups/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/placement_groups/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.GroupName') as group_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::PlacementGroup' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'GroupName') as group_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::PlacementGroup' - AND region = 'us-east-1' - placement_group: - name: placement_group - id: aws.ec2.placement_group - x-cfn-schema-name: PlacementGroup - x-cfn-type-name: AWS::EC2::PlacementGroup - x-identifiers: - - GroupName - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -18335,19 +18088,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Strategy') as strategy, - json_extract_path_text(Properties, 'GroupName') as group_name, - json_extract_path_text(Properties, 'SpreadLevel') as spread_level, - json_extract_path_text(Properties, 'PartitionCount') as partition_count, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::PlacementGroup' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.GroupName') as group_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::PlacementGroup' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Strategy') as strategy, + json_extract_path_text(Properties, 'GroupName') as group_name, + json_extract_path_text(Properties, 'SpreadLevel') as spread_level, + json_extract_path_text(Properties, 'PartitionCount') as partition_count, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::PlacementGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'GroupName') as group_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::PlacementGroup' + AND region = 'us-east-1' prefix_lists: name: prefix_lists id: aws.ec2.prefix_lists @@ -18355,7 +18124,7 @@ components: x-cfn-type-name: AWS::EC2::PrefixList x-identifiers: - PrefixListId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -18372,9 +18141,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -18384,41 +18153,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/prefix_lists/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/prefix_lists/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.PrefixListId') as prefix_list_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::PrefixList' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'PrefixListId') as prefix_list_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::PrefixList' - AND region = 'us-east-1' - prefix_list: - name: prefix_list - id: aws.ec2.prefix_list - x-cfn-schema-name: PrefixList - x-cfn-type-name: AWS::EC2::PrefixList - x-identifiers: - - PrefixListId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -18429,12 +18166,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/prefix_lists/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/prefix_lists/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/prefix_list/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/prefix_lists/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -18452,23 +18193,39 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'PrefixListName') as prefix_list_name, - json_extract_path_text(Properties, 'PrefixListId') as prefix_list_id, - json_extract_path_text(Properties, 'OwnerId') as owner_id, - json_extract_path_text(Properties, 'AddressFamily') as address_family, - json_extract_path_text(Properties, 'MaxEntries') as max_entries, - json_extract_path_text(Properties, 'Version') as version, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Entries') as entries, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::PrefixList' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.PrefixListId') as prefix_list_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::PrefixList' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'PrefixListName') as prefix_list_name, + json_extract_path_text(Properties, 'PrefixListId') as prefix_list_id, + json_extract_path_text(Properties, 'OwnerId') as owner_id, + json_extract_path_text(Properties, 'AddressFamily') as address_family, + json_extract_path_text(Properties, 'MaxEntries') as max_entries, + json_extract_path_text(Properties, 'Version') as version, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Entries') as entries, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::PrefixList' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'PrefixListId') as prefix_list_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::PrefixList' + AND region = 'us-east-1' routes: name: routes id: aws.ec2.routes @@ -18477,7 +18234,7 @@ components: x-identifiers: - RouteTableId - CidrBlock - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -18494,9 +18251,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -18506,44 +18263,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/routes/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/routes/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.RouteTableId') as route_table_id, - JSON_EXTRACT(Properties, '$.CidrBlock') as cidr_block - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::Route' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'RouteTableId') as route_table_id, - json_extract_path_text(Properties, 'CidrBlock') as cidr_block - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::Route' - AND region = 'us-east-1' - route: - name: route - id: aws.ec2.route - x-cfn-schema-name: Route - x-cfn-type-name: AWS::EC2::Route - x-identifiers: - - RouteTableId - - CidrBlock - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -18554,12 +18276,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/routes/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/routes/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/route/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/routes/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -18584,30 +18310,48 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'CarrierGatewayId') as carrier_gateway_id, - json_extract_path_text(Properties, 'CidrBlock') as cidr_block, - json_extract_path_text(Properties, 'CoreNetworkArn') as core_network_arn, - json_extract_path_text(Properties, 'DestinationCidrBlock') as destination_cidr_block, - json_extract_path_text(Properties, 'DestinationIpv6CidrBlock') as destination_ipv6_cidr_block, - json_extract_path_text(Properties, 'DestinationPrefixListId') as destination_prefix_list_id, - json_extract_path_text(Properties, 'EgressOnlyInternetGatewayId') as egress_only_internet_gateway_id, - json_extract_path_text(Properties, 'GatewayId') as gateway_id, - json_extract_path_text(Properties, 'InstanceId') as instance_id, - json_extract_path_text(Properties, 'LocalGatewayId') as local_gateway_id, - json_extract_path_text(Properties, 'NatGatewayId') as nat_gateway_id, - json_extract_path_text(Properties, 'NetworkInterfaceId') as network_interface_id, - json_extract_path_text(Properties, 'RouteTableId') as route_table_id, - json_extract_path_text(Properties, 'TransitGatewayId') as transit_gateway_id, - json_extract_path_text(Properties, 'VpcEndpointId') as vpc_endpoint_id, - json_extract_path_text(Properties, 'VpcPeeringConnectionId') as vpc_peering_connection_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::Route' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.RouteTableId') as route_table_id, + JSON_EXTRACT(Properties, '$.CidrBlock') as cidr_block + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::Route' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'CarrierGatewayId') as carrier_gateway_id, + json_extract_path_text(Properties, 'CidrBlock') as cidr_block, + json_extract_path_text(Properties, 'CoreNetworkArn') as core_network_arn, + json_extract_path_text(Properties, 'DestinationCidrBlock') as destination_cidr_block, + json_extract_path_text(Properties, 'DestinationIpv6CidrBlock') as destination_ipv6_cidr_block, + json_extract_path_text(Properties, 'DestinationPrefixListId') as destination_prefix_list_id, + json_extract_path_text(Properties, 'EgressOnlyInternetGatewayId') as egress_only_internet_gateway_id, + json_extract_path_text(Properties, 'GatewayId') as gateway_id, + json_extract_path_text(Properties, 'InstanceId') as instance_id, + json_extract_path_text(Properties, 'LocalGatewayId') as local_gateway_id, + json_extract_path_text(Properties, 'NatGatewayId') as nat_gateway_id, + json_extract_path_text(Properties, 'NetworkInterfaceId') as network_interface_id, + json_extract_path_text(Properties, 'RouteTableId') as route_table_id, + json_extract_path_text(Properties, 'TransitGatewayId') as transit_gateway_id, + json_extract_path_text(Properties, 'VpcEndpointId') as vpc_endpoint_id, + json_extract_path_text(Properties, 'VpcPeeringConnectionId') as vpc_peering_connection_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::Route' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'RouteTableId') as route_table_id, + json_extract_path_text(Properties, 'CidrBlock') as cidr_block + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::Route' + AND region = 'us-east-1' route_tables: name: route_tables id: aws.ec2.route_tables @@ -18615,7 +18359,7 @@ components: x-cfn-type-name: AWS::EC2::RouteTable x-identifiers: - RouteTableId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -18632,9 +18376,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -18644,41 +18388,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/route_tables/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/route_tables/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.RouteTableId') as route_table_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::RouteTable' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'RouteTableId') as route_table_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::RouteTable' - AND region = 'us-east-1' - route_table: - name: route_table - id: aws.ec2.route_table - x-cfn-schema-name: RouteTable - x-cfn-type-name: AWS::EC2::RouteTable - x-identifiers: - - RouteTableId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -18689,12 +18401,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/route_tables/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/route_tables/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/route_table/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/route_tables/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -18706,17 +18422,33 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'RouteTableId') as route_table_id, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'VpcId') as vpc_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::RouteTable' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.RouteTableId') as route_table_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::RouteTable' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'RouteTableId') as route_table_id, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'VpcId') as vpc_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::RouteTable' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'RouteTableId') as route_table_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::RouteTable' + AND region = 'us-east-1' security_groups: name: security_groups id: aws.ec2.security_groups @@ -18724,7 +18456,7 @@ components: x-cfn-type-name: AWS::EC2::SecurityGroup x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -18741,9 +18473,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -18753,41 +18485,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/security_groups/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/security_groups/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::SecurityGroup' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::SecurityGroup' - AND region = 'us-east-1' - security_group: - name: security_group - id: aws.ec2.security_group - x-cfn-schema-name: SecurityGroup - x-cfn-type-name: AWS::EC2::SecurityGroup - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -18798,12 +18498,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/security_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/security_groups/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/security_group/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/security_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -18820,22 +18524,38 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'GroupDescription') as group_description, - json_extract_path_text(Properties, 'GroupName') as group_name, - json_extract_path_text(Properties, 'VpcId') as vpc_id, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'SecurityGroupIngress') as security_group_ingress, - json_extract_path_text(Properties, 'SecurityGroupEgress') as security_group_egress, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'GroupId') as group_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::SecurityGroup' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::SecurityGroup' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'GroupDescription') as group_description, + json_extract_path_text(Properties, 'GroupName') as group_name, + json_extract_path_text(Properties, 'VpcId') as vpc_id, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'SecurityGroupIngress') as security_group_ingress, + json_extract_path_text(Properties, 'SecurityGroupEgress') as security_group_egress, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'GroupId') as group_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::SecurityGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::SecurityGroup' + AND region = 'us-east-1' security_group_egresses: name: security_group_egresses id: aws.ec2.security_group_egresses @@ -18843,7 +18563,7 @@ components: x-cfn-type-name: AWS::EC2::SecurityGroupEgress x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -18860,9 +18580,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -18872,41 +18592,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/security_group_egresses/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/security_group_egresses/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::SecurityGroupEgress' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::SecurityGroupEgress' - AND region = 'us-east-1' - security_group_egress: - name: security_group_egress - id: aws.ec2.security_group_egress - x-cfn-schema-name: SecurityGroupEgress - x-cfn-type-name: AWS::EC2::SecurityGroupEgress - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -18917,12 +18605,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/security_group_egresses/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/security_group_egresses/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/security_group_egress/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/security_group_egresses/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -18941,24 +18633,40 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'CidrIp') as cidr_ip, - json_extract_path_text(Properties, 'CidrIpv6') as cidr_ipv6, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'FromPort') as from_port, - json_extract_path_text(Properties, 'ToPort') as to_port, - json_extract_path_text(Properties, 'IpProtocol') as ip_protocol, - json_extract_path_text(Properties, 'DestinationSecurityGroupId') as destination_security_group_id, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'DestinationPrefixListId') as destination_prefix_list_id, - json_extract_path_text(Properties, 'GroupId') as group_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::SecurityGroupEgress' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::SecurityGroupEgress' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'CidrIp') as cidr_ip, + json_extract_path_text(Properties, 'CidrIpv6') as cidr_ipv6, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'FromPort') as from_port, + json_extract_path_text(Properties, 'ToPort') as to_port, + json_extract_path_text(Properties, 'IpProtocol') as ip_protocol, + json_extract_path_text(Properties, 'DestinationSecurityGroupId') as destination_security_group_id, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'DestinationPrefixListId') as destination_prefix_list_id, + json_extract_path_text(Properties, 'GroupId') as group_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::SecurityGroupEgress' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::SecurityGroupEgress' + AND region = 'us-east-1' security_group_ingresses: name: security_group_ingresses id: aws.ec2.security_group_ingresses @@ -18966,7 +18674,7 @@ components: x-cfn-type-name: AWS::EC2::SecurityGroupIngress x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -18983,9 +18691,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -18995,41 +18703,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/security_group_ingresses/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/security_group_ingresses/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::SecurityGroupIngress' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::SecurityGroupIngress' - AND region = 'us-east-1' - security_group_ingress: - name: security_group_ingress - id: aws.ec2.security_group_ingress - x-cfn-schema-name: SecurityGroupIngress - x-cfn-type-name: AWS::EC2::SecurityGroupIngress - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -19040,12 +18716,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/security_group_ingresses/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/security_group_ingresses/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/security_group_ingress/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/security_group_ingresses/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -19067,27 +18747,43 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'CidrIp') as cidr_ip, - json_extract_path_text(Properties, 'CidrIpv6') as cidr_ipv6, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'FromPort') as from_port, - json_extract_path_text(Properties, 'GroupId') as group_id, - json_extract_path_text(Properties, 'GroupName') as group_name, - json_extract_path_text(Properties, 'IpProtocol') as ip_protocol, - json_extract_path_text(Properties, 'SourcePrefixListId') as source_prefix_list_id, - json_extract_path_text(Properties, 'SourceSecurityGroupId') as source_security_group_id, - json_extract_path_text(Properties, 'SourceSecurityGroupName') as source_security_group_name, - json_extract_path_text(Properties, 'SourceSecurityGroupOwnerId') as source_security_group_owner_id, - json_extract_path_text(Properties, 'ToPort') as to_port - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::SecurityGroupIngress' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::SecurityGroupIngress' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'CidrIp') as cidr_ip, + json_extract_path_text(Properties, 'CidrIpv6') as cidr_ipv6, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'FromPort') as from_port, + json_extract_path_text(Properties, 'GroupId') as group_id, + json_extract_path_text(Properties, 'GroupName') as group_name, + json_extract_path_text(Properties, 'IpProtocol') as ip_protocol, + json_extract_path_text(Properties, 'SourcePrefixListId') as source_prefix_list_id, + json_extract_path_text(Properties, 'SourceSecurityGroupId') as source_security_group_id, + json_extract_path_text(Properties, 'SourceSecurityGroupName') as source_security_group_name, + json_extract_path_text(Properties, 'SourceSecurityGroupOwnerId') as source_security_group_owner_id, + json_extract_path_text(Properties, 'ToPort') as to_port + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::SecurityGroupIngress' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::SecurityGroupIngress' + AND region = 'us-east-1' snapshot_block_public_accesses: name: snapshot_block_public_accesses id: aws.ec2.snapshot_block_public_accesses @@ -19095,7 +18791,7 @@ components: x-cfn-type-name: AWS::EC2::SnapshotBlockPublicAccess x-identifiers: - AccountId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -19112,9 +18808,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -19124,41 +18820,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/snapshot_block_public_accesses/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/snapshot_block_public_accesses/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AccountId') as account_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::SnapshotBlockPublicAccess' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AccountId') as account_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::SnapshotBlockPublicAccess' - AND region = 'us-east-1' - snapshot_block_public_access: - name: snapshot_block_public_access - id: aws.ec2.snapshot_block_public_access - x-cfn-schema-name: SnapshotBlockPublicAccess - x-cfn-type-name: AWS::EC2::SnapshotBlockPublicAccess - x-identifiers: - - AccountId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -19169,12 +18833,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/snapshot_block_public_accesses/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/snapshot_block_public_accesses/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/snapshot_block_public_access/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/snapshot_block_public_accesses/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -19185,16 +18853,32 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'State') as state, - json_extract_path_text(Properties, 'AccountId') as account_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::SnapshotBlockPublicAccess' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.AccountId') as account_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::SnapshotBlockPublicAccess' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'AccountId') as account_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::SnapshotBlockPublicAccess' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AccountId') as account_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::SnapshotBlockPublicAccess' + AND region = 'us-east-1' spot_fleets: name: spot_fleets id: aws.ec2.spot_fleets @@ -19202,67 +18886,23 @@ components: x-cfn-type-name: AWS::EC2::SpotFleet x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: requestBodyTranslate: algorithm: naive_DesiredState - operation: - $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__SpotFleet&__detailTransformed=true/post' - request: - mediaType: application/x-amz-json-1.0 - base: |- - { - "TypeName": "AWS::EC2::SpotFleet" - } - response: - mediaType: application/json - openAPIDocKey: '200' - delete_resource: - operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' - request: - mediaType: application/x-amz-json-1.0 - base: |- - { - "TypeName": "AWS::EC2::SpotFleet" - } - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/spot_fleets/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/spot_fleets/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::SpotFleet' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::SpotFleet' - AND region = 'us-east-1' - spot_fleet: - name: spot_fleet - id: aws.ec2.spot_fleet - x-cfn-schema-name: SpotFleet - x-cfn-type-name: AWS::EC2::SpotFleet - x-identifiers: - - Id - x-type: get - methods: + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__SpotFleet&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::SpotFleet" + } + response: + mediaType: application/json + openAPIDocKey: '200' update_resource: operation: $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' @@ -19275,13 +18915,29 @@ components: response: mediaType: application/json openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::SpotFleet" + } + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/spot_fleets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/spot_fleets/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/spot_fleet/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/spot_fleets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -19292,16 +18948,32 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'SpotFleetRequestConfigData') as spot_fleet_request_config_data - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::SpotFleet' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::SpotFleet' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'SpotFleetRequestConfigData') as spot_fleet_request_config_data + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::SpotFleet' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::SpotFleet' + AND region = 'us-east-1' subnets: name: subnets id: aws.ec2.subnets @@ -19309,7 +18981,7 @@ components: x-cfn-type-name: AWS::EC2::Subnet x-identifiers: - SubnetId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -19326,9 +18998,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -19338,41 +19010,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/subnets/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/subnets/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.SubnetId') as subnet_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::Subnet' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'SubnetId') as subnet_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::Subnet' - AND region = 'us-east-1' - subnet: - name: subnet - id: aws.ec2.subnet - x-cfn-schema-name: Subnet - x-cfn-type-name: AWS::EC2::Subnet - x-identifiers: - - SubnetId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -19383,12 +19023,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/subnets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/subnets/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/subnet/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/subnets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -19417,34 +19061,50 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AssignIpv6AddressOnCreation') as assign_ipv6_address_on_creation, - json_extract_path_text(Properties, 'VpcId') as vpc_id, - json_extract_path_text(Properties, 'MapPublicIpOnLaunch') as map_public_ip_on_launch, - json_extract_path_text(Properties, 'EnableLniAtDeviceIndex') as enable_lni_at_device_index, - json_extract_path_text(Properties, 'NetworkAclAssociationId') as network_acl_association_id, - json_extract_path_text(Properties, 'AvailabilityZone') as availability_zone, - json_extract_path_text(Properties, 'AvailabilityZoneId') as availability_zone_id, - json_extract_path_text(Properties, 'CidrBlock') as cidr_block, - json_extract_path_text(Properties, 'SubnetId') as subnet_id, - json_extract_path_text(Properties, 'Ipv6CidrBlocks') as ipv6_cidr_blocks, - json_extract_path_text(Properties, 'Ipv6CidrBlock') as ipv6_cidr_block, - json_extract_path_text(Properties, 'OutpostArn') as outpost_arn, - json_extract_path_text(Properties, 'Ipv6Native') as ipv6_native, - json_extract_path_text(Properties, 'EnableDns64') as enable_dns64, - json_extract_path_text(Properties, 'PrivateDnsNameOptionsOnLaunch') as private_dns_name_options_on_launch, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Ipv4IpamPoolId') as ipv4_ipam_pool_id, - json_extract_path_text(Properties, 'Ipv4NetmaskLength') as ipv4_netmask_length, - json_extract_path_text(Properties, 'Ipv6IpamPoolId') as ipv6_ipam_pool_id, - json_extract_path_text(Properties, 'Ipv6NetmaskLength') as ipv6_netmask_length - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::Subnet' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.SubnetId') as subnet_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::Subnet' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AssignIpv6AddressOnCreation') as assign_ipv6_address_on_creation, + json_extract_path_text(Properties, 'VpcId') as vpc_id, + json_extract_path_text(Properties, 'MapPublicIpOnLaunch') as map_public_ip_on_launch, + json_extract_path_text(Properties, 'EnableLniAtDeviceIndex') as enable_lni_at_device_index, + json_extract_path_text(Properties, 'NetworkAclAssociationId') as network_acl_association_id, + json_extract_path_text(Properties, 'AvailabilityZone') as availability_zone, + json_extract_path_text(Properties, 'AvailabilityZoneId') as availability_zone_id, + json_extract_path_text(Properties, 'CidrBlock') as cidr_block, + json_extract_path_text(Properties, 'SubnetId') as subnet_id, + json_extract_path_text(Properties, 'Ipv6CidrBlocks') as ipv6_cidr_blocks, + json_extract_path_text(Properties, 'Ipv6CidrBlock') as ipv6_cidr_block, + json_extract_path_text(Properties, 'OutpostArn') as outpost_arn, + json_extract_path_text(Properties, 'Ipv6Native') as ipv6_native, + json_extract_path_text(Properties, 'EnableDns64') as enable_dns64, + json_extract_path_text(Properties, 'PrivateDnsNameOptionsOnLaunch') as private_dns_name_options_on_launch, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Ipv4IpamPoolId') as ipv4_ipam_pool_id, + json_extract_path_text(Properties, 'Ipv4NetmaskLength') as ipv4_netmask_length, + json_extract_path_text(Properties, 'Ipv6IpamPoolId') as ipv6_ipam_pool_id, + json_extract_path_text(Properties, 'Ipv6NetmaskLength') as ipv6_netmask_length + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::Subnet' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'SubnetId') as subnet_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::Subnet' + AND region = 'us-east-1' subnet_cidr_blocks: name: subnet_cidr_blocks id: aws.ec2.subnet_cidr_blocks @@ -19452,7 +19112,7 @@ components: x-cfn-type-name: AWS::EC2::SubnetCidrBlock x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -19486,39 +19146,11 @@ components: - $ref: '#/components/x-stackQL-resources/subnet_cidr_blocks/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/subnet_cidr_blocks/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::SubnetCidrBlock' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::SubnetCidrBlock' - AND region = 'us-east-1' - subnet_cidr_block: - name: subnet_cidr_block - id: aws.ec2.subnet_cidr_block - x-cfn-schema-name: SubnetCidrBlock - x-cfn-type-name: AWS::EC2::SubnetCidrBlock - x-identifiers: - - Id - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -19532,19 +19164,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Ipv6CidrBlock') as ipv6_cidr_block, - json_extract_path_text(Properties, 'Ipv6IpamPoolId') as ipv6_ipam_pool_id, - json_extract_path_text(Properties, 'Ipv6NetmaskLength') as ipv6_netmask_length, - json_extract_path_text(Properties, 'SubnetId') as subnet_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::SubnetCidrBlock' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::SubnetCidrBlock' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Ipv6CidrBlock') as ipv6_cidr_block, + json_extract_path_text(Properties, 'Ipv6IpamPoolId') as ipv6_ipam_pool_id, + json_extract_path_text(Properties, 'Ipv6NetmaskLength') as ipv6_netmask_length, + json_extract_path_text(Properties, 'SubnetId') as subnet_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::SubnetCidrBlock' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::SubnetCidrBlock' + AND region = 'us-east-1' subnet_network_acl_associations: name: subnet_network_acl_associations id: aws.ec2.subnet_network_acl_associations @@ -19552,7 +19200,7 @@ components: x-cfn-type-name: AWS::EC2::SubnetNetworkAclAssociation x-identifiers: - AssociationId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -19586,39 +19234,11 @@ components: - $ref: '#/components/x-stackQL-resources/subnet_network_acl_associations/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/subnet_network_acl_associations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AssociationId') as association_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::SubnetNetworkAclAssociation' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AssociationId') as association_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::SubnetNetworkAclAssociation' - AND region = 'us-east-1' - subnet_network_acl_association: - name: subnet_network_acl_association - id: aws.ec2.subnet_network_acl_association - x-cfn-schema-name: SubnetNetworkAclAssociation - x-cfn-type-name: AWS::EC2::SubnetNetworkAclAssociation - x-identifiers: - - AssociationId - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -19630,17 +19250,33 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'SubnetId') as subnet_id, - json_extract_path_text(Properties, 'NetworkAclId') as network_acl_id, - json_extract_path_text(Properties, 'AssociationId') as association_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::SubnetNetworkAclAssociation' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.AssociationId') as association_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::SubnetNetworkAclAssociation' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'SubnetId') as subnet_id, + json_extract_path_text(Properties, 'NetworkAclId') as network_acl_id, + json_extract_path_text(Properties, 'AssociationId') as association_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::SubnetNetworkAclAssociation' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AssociationId') as association_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::SubnetNetworkAclAssociation' + AND region = 'us-east-1' subnet_route_table_associations: name: subnet_route_table_associations id: aws.ec2.subnet_route_table_associations @@ -19648,7 +19284,7 @@ components: x-cfn-type-name: AWS::EC2::SubnetRouteTableAssociation x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -19682,39 +19318,11 @@ components: - $ref: '#/components/x-stackQL-resources/subnet_route_table_associations/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/subnet_route_table_associations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::SubnetRouteTableAssociation' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::SubnetRouteTableAssociation' - AND region = 'us-east-1' - subnet_route_table_association: - name: subnet_route_table_association - id: aws.ec2.subnet_route_table_association - x-cfn-schema-name: SubnetRouteTableAssociation - x-cfn-type-name: AWS::EC2::SubnetRouteTableAssociation - x-identifiers: - - Id - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -19726,17 +19334,33 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'RouteTableId') as route_table_id, - json_extract_path_text(Properties, 'SubnetId') as subnet_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::SubnetRouteTableAssociation' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::SubnetRouteTableAssociation' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'RouteTableId') as route_table_id, + json_extract_path_text(Properties, 'SubnetId') as subnet_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::SubnetRouteTableAssociation' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::SubnetRouteTableAssociation' + AND region = 'us-east-1' transit_gateways: name: transit_gateways id: aws.ec2.transit_gateways @@ -19744,7 +19368,7 @@ components: x-cfn-type-name: AWS::EC2::TransitGateway x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -19761,9 +19385,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -19773,41 +19397,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/transit_gateways/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/transit_gateways/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGateway' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGateway' - AND region = 'us-east-1' - transit_gateway: - name: transit_gateway - id: aws.ec2.transit_gateway - x-cfn-schema-name: TransitGateway - x-cfn-type-name: AWS::EC2::TransitGateway - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -19818,12 +19410,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/transit_gateways/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/transit_gateways/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/transit_gateway/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/transit_gateways/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -19846,28 +19442,44 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'AssociationDefaultRouteTableId') as association_default_route_table_id, - json_extract_path_text(Properties, 'AutoAcceptSharedAttachments') as auto_accept_shared_attachments, - json_extract_path_text(Properties, 'TransitGatewayArn') as transit_gateway_arn, - json_extract_path_text(Properties, 'DefaultRouteTablePropagation') as default_route_table_propagation, - json_extract_path_text(Properties, 'TransitGatewayCidrBlocks') as transit_gateway_cidr_blocks, - json_extract_path_text(Properties, 'PropagationDefaultRouteTableId') as propagation_default_route_table_id, - json_extract_path_text(Properties, 'DefaultRouteTableAssociation') as default_route_table_association, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'VpnEcmpSupport') as vpn_ecmp_support, - json_extract_path_text(Properties, 'DnsSupport') as dns_support, - json_extract_path_text(Properties, 'MulticastSupport') as multicast_support, - json_extract_path_text(Properties, 'AmazonSideAsn') as amazon_side_asn, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::TransitGateway' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGateway' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'AssociationDefaultRouteTableId') as association_default_route_table_id, + json_extract_path_text(Properties, 'AutoAcceptSharedAttachments') as auto_accept_shared_attachments, + json_extract_path_text(Properties, 'TransitGatewayArn') as transit_gateway_arn, + json_extract_path_text(Properties, 'DefaultRouteTablePropagation') as default_route_table_propagation, + json_extract_path_text(Properties, 'TransitGatewayCidrBlocks') as transit_gateway_cidr_blocks, + json_extract_path_text(Properties, 'PropagationDefaultRouteTableId') as propagation_default_route_table_id, + json_extract_path_text(Properties, 'DefaultRouteTableAssociation') as default_route_table_association, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'VpnEcmpSupport') as vpn_ecmp_support, + json_extract_path_text(Properties, 'DnsSupport') as dns_support, + json_extract_path_text(Properties, 'MulticastSupport') as multicast_support, + json_extract_path_text(Properties, 'AmazonSideAsn') as amazon_side_asn, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::TransitGateway' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGateway' + AND region = 'us-east-1' transit_gateway_attachments: name: transit_gateway_attachments id: aws.ec2.transit_gateway_attachments @@ -19875,7 +19487,7 @@ components: x-cfn-type-name: AWS::EC2::TransitGatewayAttachment x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -19892,9 +19504,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -19904,41 +19516,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/transit_gateway_attachments/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/transit_gateway_attachments/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayAttachment' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayAttachment' - AND region = 'us-east-1' - transit_gateway_attachment: - name: transit_gateway_attachment - id: aws.ec2.transit_gateway_attachment - x-cfn-schema-name: TransitGatewayAttachment - x-cfn-type-name: AWS::EC2::TransitGatewayAttachment - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -19949,12 +19529,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/transit_gateway_attachments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/transit_gateway_attachments/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/transit_gateway_attachment/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/transit_gateway_attachments/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -19969,20 +19553,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'TransitGatewayId') as transit_gateway_id, - json_extract_path_text(Properties, 'VpcId') as vpc_id, - json_extract_path_text(Properties, 'SubnetIds') as subnet_ids, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Options') as options - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::TransitGatewayAttachment' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayAttachment' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'TransitGatewayId') as transit_gateway_id, + json_extract_path_text(Properties, 'VpcId') as vpc_id, + json_extract_path_text(Properties, 'SubnetIds') as subnet_ids, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Options') as options + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::TransitGatewayAttachment' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayAttachment' + AND region = 'us-east-1' transit_gateway_connects: name: transit_gateway_connects id: aws.ec2.transit_gateway_connects @@ -19990,7 +19590,7 @@ components: x-cfn-type-name: AWS::EC2::TransitGatewayConnect x-identifiers: - TransitGatewayAttachmentId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -20007,53 +19607,21 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: - mediaType: application/x-amz-json-1.0 - base: |- - { - "TypeName": "AWS::EC2::TransitGatewayConnect" - } - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/transit_gateway_connects/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/transit_gateway_connects/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.TransitGatewayAttachmentId') as transit_gateway_attachment_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayConnect' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'TransitGatewayAttachmentId') as transit_gateway_attachment_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayConnect' - AND region = 'us-east-1' - transit_gateway_connect: - name: transit_gateway_connect - id: aws.ec2.transit_gateway_connect - x-cfn-schema-name: TransitGatewayConnect - x-cfn-type-name: AWS::EC2::TransitGatewayConnect - x-identifiers: - - TransitGatewayAttachmentId - x-type: get - methods: - update_resource: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::TransitGatewayConnect" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -20064,12 +19632,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/transit_gateway_connects/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/transit_gateway_connects/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/transit_gateway_connect/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/transit_gateway_connects/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -20085,21 +19657,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'TransitGatewayAttachmentId') as transit_gateway_attachment_id, - json_extract_path_text(Properties, 'TransportTransitGatewayAttachmentId') as transport_transit_gateway_attachment_id, - json_extract_path_text(Properties, 'TransitGatewayId') as transit_gateway_id, - json_extract_path_text(Properties, 'State') as state, - json_extract_path_text(Properties, 'CreationTime') as creation_time, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Options') as options - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::TransitGatewayConnect' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.TransitGatewayAttachmentId') as transit_gateway_attachment_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayConnect' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'TransitGatewayAttachmentId') as transit_gateway_attachment_id, + json_extract_path_text(Properties, 'TransportTransitGatewayAttachmentId') as transport_transit_gateway_attachment_id, + json_extract_path_text(Properties, 'TransitGatewayId') as transit_gateway_id, + json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'CreationTime') as creation_time, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Options') as options + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::TransitGatewayConnect' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'TransitGatewayAttachmentId') as transit_gateway_attachment_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayConnect' + AND region = 'us-east-1' transit_gateway_multicast_domains: name: transit_gateway_multicast_domains id: aws.ec2.transit_gateway_multicast_domains @@ -20107,7 +19695,7 @@ components: x-cfn-type-name: AWS::EC2::TransitGatewayMulticastDomain x-identifiers: - TransitGatewayMulticastDomainId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -20124,9 +19712,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -20136,41 +19724,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/transit_gateway_multicast_domains/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/transit_gateway_multicast_domains/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.TransitGatewayMulticastDomainId') as transit_gateway_multicast_domain_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayMulticastDomain' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'TransitGatewayMulticastDomainId') as transit_gateway_multicast_domain_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayMulticastDomain' - AND region = 'us-east-1' - transit_gateway_multicast_domain: - name: transit_gateway_multicast_domain - id: aws.ec2.transit_gateway_multicast_domain - x-cfn-schema-name: TransitGatewayMulticastDomain - x-cfn-type-name: AWS::EC2::TransitGatewayMulticastDomain - x-identifiers: - - TransitGatewayMulticastDomainId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -20181,12 +19737,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/transit_gateway_multicast_domains/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/transit_gateway_multicast_domains/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/transit_gateway_multicast_domain/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/transit_gateway_multicast_domains/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -20202,21 +19762,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'TransitGatewayMulticastDomainId') as transit_gateway_multicast_domain_id, - json_extract_path_text(Properties, 'TransitGatewayMulticastDomainArn') as transit_gateway_multicast_domain_arn, - json_extract_path_text(Properties, 'TransitGatewayId') as transit_gateway_id, - json_extract_path_text(Properties, 'State') as state, - json_extract_path_text(Properties, 'CreationTime') as creation_time, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Options') as options - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::TransitGatewayMulticastDomain' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.TransitGatewayMulticastDomainId') as transit_gateway_multicast_domain_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayMulticastDomain' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'TransitGatewayMulticastDomainId') as transit_gateway_multicast_domain_id, + json_extract_path_text(Properties, 'TransitGatewayMulticastDomainArn') as transit_gateway_multicast_domain_arn, + json_extract_path_text(Properties, 'TransitGatewayId') as transit_gateway_id, + json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'CreationTime') as creation_time, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Options') as options + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::TransitGatewayMulticastDomain' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'TransitGatewayMulticastDomainId') as transit_gateway_multicast_domain_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayMulticastDomain' + AND region = 'us-east-1' transit_gateway_multicast_domain_associations: name: transit_gateway_multicast_domain_associations id: aws.ec2.transit_gateway_multicast_domain_associations @@ -20226,7 +19802,7 @@ components: - TransitGatewayMulticastDomainId - TransitGatewayAttachmentId - SubnetId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -20260,45 +19836,11 @@ components: - $ref: '#/components/x-stackQL-resources/transit_gateway_multicast_domain_associations/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/transit_gateway_multicast_domain_associations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.TransitGatewayMulticastDomainId') as transit_gateway_multicast_domain_id, - JSON_EXTRACT(Properties, '$.TransitGatewayAttachmentId') as transit_gateway_attachment_id, - JSON_EXTRACT(Properties, '$.SubnetId') as subnet_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayMulticastDomainAssociation' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'TransitGatewayMulticastDomainId') as transit_gateway_multicast_domain_id, - json_extract_path_text(Properties, 'TransitGatewayAttachmentId') as transit_gateway_attachment_id, - json_extract_path_text(Properties, 'SubnetId') as subnet_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayMulticastDomainAssociation' - AND region = 'us-east-1' - transit_gateway_multicast_domain_association: - name: transit_gateway_multicast_domain_association - id: aws.ec2.transit_gateway_multicast_domain_association - x-cfn-schema-name: TransitGatewayMulticastDomainAssociation - x-cfn-type-name: AWS::EC2::TransitGatewayMulticastDomainAssociation - x-identifiers: - - TransitGatewayMulticastDomainId - - TransitGatewayAttachmentId - - SubnetId - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -20313,20 +19855,40 @@ components: AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'TransitGatewayMulticastDomainId') as transit_gateway_multicast_domain_id, - json_extract_path_text(Properties, 'TransitGatewayAttachmentId') as transit_gateway_attachment_id, - json_extract_path_text(Properties, 'ResourceId') as resource_id, - json_extract_path_text(Properties, 'ResourceType') as resource_type, - json_extract_path_text(Properties, 'State') as state, - json_extract_path_text(Properties, 'SubnetId') as subnet_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::TransitGatewayMulticastDomainAssociation' - AND data__Identifier = '||' + JSON_EXTRACT(Properties, '$.TransitGatewayMulticastDomainId') as transit_gateway_multicast_domain_id, + JSON_EXTRACT(Properties, '$.TransitGatewayAttachmentId') as transit_gateway_attachment_id, + JSON_EXTRACT(Properties, '$.SubnetId') as subnet_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayMulticastDomainAssociation' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'TransitGatewayMulticastDomainId') as transit_gateway_multicast_domain_id, + json_extract_path_text(Properties, 'TransitGatewayAttachmentId') as transit_gateway_attachment_id, + json_extract_path_text(Properties, 'ResourceId') as resource_id, + json_extract_path_text(Properties, 'ResourceType') as resource_type, + json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'SubnetId') as subnet_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::TransitGatewayMulticastDomainAssociation' + AND data__Identifier = '||' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'TransitGatewayMulticastDomainId') as transit_gateway_multicast_domain_id, + json_extract_path_text(Properties, 'TransitGatewayAttachmentId') as transit_gateway_attachment_id, + json_extract_path_text(Properties, 'SubnetId') as subnet_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayMulticastDomainAssociation' + AND region = 'us-east-1' transit_gateway_multicast_group_members: name: transit_gateway_multicast_group_members id: aws.ec2.transit_gateway_multicast_group_members @@ -20336,7 +19898,7 @@ components: - TransitGatewayMulticastDomainId - GroupIpAddress - NetworkInterfaceId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -20370,45 +19932,11 @@ components: - $ref: '#/components/x-stackQL-resources/transit_gateway_multicast_group_members/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/transit_gateway_multicast_group_members/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.TransitGatewayMulticastDomainId') as transit_gateway_multicast_domain_id, - JSON_EXTRACT(Properties, '$.GroupIpAddress') as group_ip_address, - JSON_EXTRACT(Properties, '$.NetworkInterfaceId') as network_interface_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayMulticastGroupMember' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'TransitGatewayMulticastDomainId') as transit_gateway_multicast_domain_id, - json_extract_path_text(Properties, 'GroupIpAddress') as group_ip_address, - json_extract_path_text(Properties, 'NetworkInterfaceId') as network_interface_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayMulticastGroupMember' - AND region = 'us-east-1' - transit_gateway_multicast_group_member: - name: transit_gateway_multicast_group_member - id: aws.ec2.transit_gateway_multicast_group_member - x-cfn-schema-name: TransitGatewayMulticastGroupMember - x-cfn-type-name: AWS::EC2::TransitGatewayMulticastGroupMember - x-identifiers: - - TransitGatewayMulticastDomainId - - GroupIpAddress - - NetworkInterfaceId - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -20428,25 +19956,45 @@ components: AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'GroupIpAddress') as group_ip_address, - json_extract_path_text(Properties, 'TransitGatewayAttachmentId') as transit_gateway_attachment_id, - json_extract_path_text(Properties, 'TransitGatewayMulticastDomainId') as transit_gateway_multicast_domain_id, - json_extract_path_text(Properties, 'SubnetId') as subnet_id, - json_extract_path_text(Properties, 'ResourceId') as resource_id, - json_extract_path_text(Properties, 'ResourceType') as resource_type, - json_extract_path_text(Properties, 'NetworkInterfaceId') as network_interface_id, - json_extract_path_text(Properties, 'GroupMember') as group_member, - json_extract_path_text(Properties, 'GroupSource') as group_source, - json_extract_path_text(Properties, 'MemberType') as member_type, - json_extract_path_text(Properties, 'SourceType') as source_type - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::TransitGatewayMulticastGroupMember' - AND data__Identifier = '||' + JSON_EXTRACT(Properties, '$.TransitGatewayMulticastDomainId') as transit_gateway_multicast_domain_id, + JSON_EXTRACT(Properties, '$.GroupIpAddress') as group_ip_address, + JSON_EXTRACT(Properties, '$.NetworkInterfaceId') as network_interface_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayMulticastGroupMember' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'GroupIpAddress') as group_ip_address, + json_extract_path_text(Properties, 'TransitGatewayAttachmentId') as transit_gateway_attachment_id, + json_extract_path_text(Properties, 'TransitGatewayMulticastDomainId') as transit_gateway_multicast_domain_id, + json_extract_path_text(Properties, 'SubnetId') as subnet_id, + json_extract_path_text(Properties, 'ResourceId') as resource_id, + json_extract_path_text(Properties, 'ResourceType') as resource_type, + json_extract_path_text(Properties, 'NetworkInterfaceId') as network_interface_id, + json_extract_path_text(Properties, 'GroupMember') as group_member, + json_extract_path_text(Properties, 'GroupSource') as group_source, + json_extract_path_text(Properties, 'MemberType') as member_type, + json_extract_path_text(Properties, 'SourceType') as source_type + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::TransitGatewayMulticastGroupMember' + AND data__Identifier = '||' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'TransitGatewayMulticastDomainId') as transit_gateway_multicast_domain_id, + json_extract_path_text(Properties, 'GroupIpAddress') as group_ip_address, + json_extract_path_text(Properties, 'NetworkInterfaceId') as network_interface_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayMulticastGroupMember' + AND region = 'us-east-1' transit_gateway_multicast_group_sources: name: transit_gateway_multicast_group_sources id: aws.ec2.transit_gateway_multicast_group_sources @@ -20456,7 +20004,7 @@ components: - TransitGatewayMulticastDomainId - GroupIpAddress - NetworkInterfaceId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -20490,45 +20038,11 @@ components: - $ref: '#/components/x-stackQL-resources/transit_gateway_multicast_group_sources/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/transit_gateway_multicast_group_sources/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.TransitGatewayMulticastDomainId') as transit_gateway_multicast_domain_id, - JSON_EXTRACT(Properties, '$.GroupIpAddress') as group_ip_address, - JSON_EXTRACT(Properties, '$.NetworkInterfaceId') as network_interface_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayMulticastGroupSource' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'TransitGatewayMulticastDomainId') as transit_gateway_multicast_domain_id, - json_extract_path_text(Properties, 'GroupIpAddress') as group_ip_address, - json_extract_path_text(Properties, 'NetworkInterfaceId') as network_interface_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayMulticastGroupSource' - AND region = 'us-east-1' - transit_gateway_multicast_group_source: - name: transit_gateway_multicast_group_source - id: aws.ec2.transit_gateway_multicast_group_source - x-cfn-schema-name: TransitGatewayMulticastGroupSource - x-cfn-type-name: AWS::EC2::TransitGatewayMulticastGroupSource - x-identifiers: - - TransitGatewayMulticastDomainId - - GroupIpAddress - - NetworkInterfaceId - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -20548,25 +20062,45 @@ components: AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'GroupIpAddress') as group_ip_address, - json_extract_path_text(Properties, 'TransitGatewayAttachmentId') as transit_gateway_attachment_id, - json_extract_path_text(Properties, 'TransitGatewayMulticastDomainId') as transit_gateway_multicast_domain_id, - json_extract_path_text(Properties, 'SubnetId') as subnet_id, - json_extract_path_text(Properties, 'ResourceId') as resource_id, - json_extract_path_text(Properties, 'ResourceType') as resource_type, - json_extract_path_text(Properties, 'NetworkInterfaceId') as network_interface_id, - json_extract_path_text(Properties, 'GroupMember') as group_member, - json_extract_path_text(Properties, 'GroupSource') as group_source, - json_extract_path_text(Properties, 'MemberType') as member_type, - json_extract_path_text(Properties, 'SourceType') as source_type - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::TransitGatewayMulticastGroupSource' - AND data__Identifier = '||' + JSON_EXTRACT(Properties, '$.TransitGatewayMulticastDomainId') as transit_gateway_multicast_domain_id, + JSON_EXTRACT(Properties, '$.GroupIpAddress') as group_ip_address, + JSON_EXTRACT(Properties, '$.NetworkInterfaceId') as network_interface_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayMulticastGroupSource' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'GroupIpAddress') as group_ip_address, + json_extract_path_text(Properties, 'TransitGatewayAttachmentId') as transit_gateway_attachment_id, + json_extract_path_text(Properties, 'TransitGatewayMulticastDomainId') as transit_gateway_multicast_domain_id, + json_extract_path_text(Properties, 'SubnetId') as subnet_id, + json_extract_path_text(Properties, 'ResourceId') as resource_id, + json_extract_path_text(Properties, 'ResourceType') as resource_type, + json_extract_path_text(Properties, 'NetworkInterfaceId') as network_interface_id, + json_extract_path_text(Properties, 'GroupMember') as group_member, + json_extract_path_text(Properties, 'GroupSource') as group_source, + json_extract_path_text(Properties, 'MemberType') as member_type, + json_extract_path_text(Properties, 'SourceType') as source_type + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::TransitGatewayMulticastGroupSource' + AND data__Identifier = '||' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'TransitGatewayMulticastDomainId') as transit_gateway_multicast_domain_id, + json_extract_path_text(Properties, 'GroupIpAddress') as group_ip_address, + json_extract_path_text(Properties, 'NetworkInterfaceId') as network_interface_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayMulticastGroupSource' + AND region = 'us-east-1' transit_gateway_peering_attachments: name: transit_gateway_peering_attachments id: aws.ec2.transit_gateway_peering_attachments @@ -20574,7 +20108,7 @@ components: x-cfn-type-name: AWS::EC2::TransitGatewayPeeringAttachment x-identifiers: - TransitGatewayAttachmentId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -20591,6 +20125,18 @@ components: response: mediaType: application/json openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::TransitGatewayPeeringAttachment" + } + response: + mediaType: application/json + openAPIDocKey: '200' delete_resource: operation: $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' @@ -20608,86 +20154,151 @@ components: - $ref: '#/components/x-stackQL-resources/transit_gateway_peering_attachments/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/transit_gateway_peering_attachments/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/transit_gateway_peering_attachments/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.TransitGatewayId') as transit_gateway_id, + JSON_EXTRACT(Properties, '$.PeerTransitGatewayId') as peer_transit_gateway_id, + JSON_EXTRACT(Properties, '$.PeerAccountId') as peer_account_id, + JSON_EXTRACT(Properties, '$.State') as state, + JSON_EXTRACT(Properties, '$.CreationTime') as creation_time, + JSON_EXTRACT(Properties, '$.PeerRegion') as peer_region, + JSON_EXTRACT(Properties, '$.Tags') as tags, JSON_EXTRACT(Properties, '$.TransitGatewayAttachmentId') as transit_gateway_attachment_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayPeeringAttachment' + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::TransitGatewayPeeringAttachment' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - json_extract_path_text(Properties, 'TransitGatewayAttachmentId') as transit_gateway_attachment_id + JSON_EXTRACT(Properties, '$.TransitGatewayAttachmentId') as transit_gateway_attachment_id FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayPeeringAttachment' AND region = 'us-east-1' - transit_gateway_peering_attachment: - name: transit_gateway_peering_attachment - id: aws.ec2.transit_gateway_peering_attachment - x-cfn-schema-name: TransitGatewayPeeringAttachment - x-cfn-type-name: AWS::EC2::TransitGatewayPeeringAttachment + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'TransitGatewayId') as transit_gateway_id, + json_extract_path_text(Properties, 'PeerTransitGatewayId') as peer_transit_gateway_id, + json_extract_path_text(Properties, 'PeerAccountId') as peer_account_id, + json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'CreationTime') as creation_time, + json_extract_path_text(Properties, 'PeerRegion') as peer_region, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'TransitGatewayAttachmentId') as transit_gateway_attachment_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::TransitGatewayPeeringAttachment' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'TransitGatewayAttachmentId') as transit_gateway_attachment_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayPeeringAttachment' + AND region = 'us-east-1' + transit_gateway_routes: + name: transit_gateway_routes + id: aws.ec2.transit_gateway_routes + x-cfn-schema-name: TransitGatewayRoute + x-cfn-type-name: AWS::EC2::TransitGatewayRoute x-identifiers: - - TransitGatewayAttachmentId - x-type: get + - TransitGatewayRouteTableId + - DestinationCidrBlock + x-type: cloud_control methods: - update_resource: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__TransitGatewayRoute&__detailTransformed=true/post' request: mediaType: application/x-amz-json-1.0 base: |- { - "TypeName": "AWS::EC2::TransitGatewayPeeringAttachment" + "TypeName": "AWS::EC2::TransitGatewayRoute" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::TransitGatewayRoute" } response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: - update: - - $ref: '#/components/x-stackQL-resources/transit_gateway_peering_attachment/methods/update_resource' + insert: + - $ref: '#/components/x-stackQL-resources/transit_gateway_routes/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/transit_gateway_routes/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.Status') as status, - JSON_EXTRACT(Properties, '$.TransitGatewayId') as transit_gateway_id, - JSON_EXTRACT(Properties, '$.PeerTransitGatewayId') as peer_transit_gateway_id, - JSON_EXTRACT(Properties, '$.PeerAccountId') as peer_account_id, - JSON_EXTRACT(Properties, '$.State') as state, - JSON_EXTRACT(Properties, '$.CreationTime') as creation_time, - JSON_EXTRACT(Properties, '$.PeerRegion') as peer_region, - JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.TransitGatewayRouteTableId') as transit_gateway_route_table_id, + JSON_EXTRACT(Properties, '$.DestinationCidrBlock') as destination_cidr_block, + JSON_EXTRACT(Properties, '$.Blackhole') as blackhole, JSON_EXTRACT(Properties, '$.TransitGatewayAttachmentId') as transit_gateway_attachment_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::TransitGatewayPeeringAttachment' - AND data__Identifier = '' + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::TransitGatewayRoute' + AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'TransitGatewayId') as transit_gateway_id, - json_extract_path_text(Properties, 'PeerTransitGatewayId') as peer_transit_gateway_id, - json_extract_path_text(Properties, 'PeerAccountId') as peer_account_id, - json_extract_path_text(Properties, 'State') as state, - json_extract_path_text(Properties, 'CreationTime') as creation_time, - json_extract_path_text(Properties, 'PeerRegion') as peer_region, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'TransitGatewayAttachmentId') as transit_gateway_attachment_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::TransitGatewayPeeringAttachment' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.TransitGatewayRouteTableId') as transit_gateway_route_table_id, + JSON_EXTRACT(Properties, '$.DestinationCidrBlock') as destination_cidr_block + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayRoute' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'TransitGatewayRouteTableId') as transit_gateway_route_table_id, + json_extract_path_text(Properties, 'DestinationCidrBlock') as destination_cidr_block, + json_extract_path_text(Properties, 'Blackhole') as blackhole, + json_extract_path_text(Properties, 'TransitGatewayAttachmentId') as transit_gateway_attachment_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::TransitGatewayRoute' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'TransitGatewayRouteTableId') as transit_gateway_route_table_id, + json_extract_path_text(Properties, 'DestinationCidrBlock') as destination_cidr_block + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayRoute' + AND region = 'us-east-1' transit_gateway_route_tables: name: transit_gateway_route_tables id: aws.ec2.transit_gateway_route_tables @@ -20695,7 +20306,7 @@ components: x-cfn-type-name: AWS::EC2::TransitGatewayRouteTable x-identifiers: - TransitGatewayRouteTableId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -20729,39 +20340,11 @@ components: - $ref: '#/components/x-stackQL-resources/transit_gateway_route_tables/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/transit_gateway_route_tables/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.TransitGatewayRouteTableId') as transit_gateway_route_table_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayRouteTable' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'TransitGatewayRouteTableId') as transit_gateway_route_table_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayRouteTable' - AND region = 'us-east-1' - transit_gateway_route_table: - name: transit_gateway_route_table - id: aws.ec2.transit_gateway_route_table - x-cfn-schema-name: TransitGatewayRouteTable - x-cfn-type-name: AWS::EC2::TransitGatewayRouteTable - x-identifiers: - - TransitGatewayRouteTableId - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -20773,17 +20356,33 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'TransitGatewayRouteTableId') as transit_gateway_route_table_id, - json_extract_path_text(Properties, 'TransitGatewayId') as transit_gateway_id, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::TransitGatewayRouteTable' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.TransitGatewayRouteTableId') as transit_gateway_route_table_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayRouteTable' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'TransitGatewayRouteTableId') as transit_gateway_route_table_id, + json_extract_path_text(Properties, 'TransitGatewayId') as transit_gateway_id, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::TransitGatewayRouteTable' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'TransitGatewayRouteTableId') as transit_gateway_route_table_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayRouteTable' + AND region = 'us-east-1' transit_gateway_route_table_associations: name: transit_gateway_route_table_associations id: aws.ec2.transit_gateway_route_table_associations @@ -20792,7 +20391,7 @@ components: x-identifiers: - TransitGatewayRouteTableId - TransitGatewayAttachmentId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -20826,62 +20425,134 @@ components: - $ref: '#/components/x-stackQL-resources/transit_gateway_route_table_associations/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/transit_gateway_route_table_associations/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, + data__Identifier, JSON_EXTRACT(Properties, '$.TransitGatewayRouteTableId') as transit_gateway_route_table_id, JSON_EXTRACT(Properties, '$.TransitGatewayAttachmentId') as transit_gateway_attachment_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayRouteTableAssociation' + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::TransitGatewayRouteTableAssociation' + AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - json_extract_path_text(Properties, 'TransitGatewayRouteTableId') as transit_gateway_route_table_id, - json_extract_path_text(Properties, 'TransitGatewayAttachmentId') as transit_gateway_attachment_id + JSON_EXTRACT(Properties, '$.TransitGatewayRouteTableId') as transit_gateway_route_table_id, + JSON_EXTRACT(Properties, '$.TransitGatewayAttachmentId') as transit_gateway_attachment_id FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayRouteTableAssociation' AND region = 'us-east-1' - transit_gateway_route_table_association: - name: transit_gateway_route_table_association - id: aws.ec2.transit_gateway_route_table_association - x-cfn-schema-name: TransitGatewayRouteTableAssociation - x-cfn-type-name: AWS::EC2::TransitGatewayRouteTableAssociation + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'TransitGatewayRouteTableId') as transit_gateway_route_table_id, + json_extract_path_text(Properties, 'TransitGatewayAttachmentId') as transit_gateway_attachment_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::TransitGatewayRouteTableAssociation' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'TransitGatewayRouteTableId') as transit_gateway_route_table_id, + json_extract_path_text(Properties, 'TransitGatewayAttachmentId') as transit_gateway_attachment_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayRouteTableAssociation' + AND region = 'us-east-1' + transit_gateway_route_table_propagations: + name: transit_gateway_route_table_propagations + id: aws.ec2.transit_gateway_route_table_propagations + x-cfn-schema-name: TransitGatewayRouteTablePropagation + x-cfn-type-name: AWS::EC2::TransitGatewayRouteTablePropagation x-identifiers: - TransitGatewayRouteTableId - TransitGatewayAttachmentId - x-type: get - methods: {} + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__TransitGatewayRouteTablePropagation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::TransitGatewayRouteTablePropagation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::TransitGatewayRouteTablePropagation" + } + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/transit_gateway_route_table_propagations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/transit_gateway_route_table_propagations/methods/delete_resource' update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, JSON_EXTRACT(Properties, '$.TransitGatewayRouteTableId') as transit_gateway_route_table_id, JSON_EXTRACT(Properties, '$.TransitGatewayAttachmentId') as transit_gateway_attachment_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::TransitGatewayRouteTableAssociation' + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::TransitGatewayRouteTablePropagation' AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'TransitGatewayRouteTableId') as transit_gateway_route_table_id, - json_extract_path_text(Properties, 'TransitGatewayAttachmentId') as transit_gateway_attachment_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::TransitGatewayRouteTableAssociation' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.TransitGatewayRouteTableId') as transit_gateway_route_table_id, + JSON_EXTRACT(Properties, '$.TransitGatewayAttachmentId') as transit_gateway_attachment_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayRouteTablePropagation' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'TransitGatewayRouteTableId') as transit_gateway_route_table_id, + json_extract_path_text(Properties, 'TransitGatewayAttachmentId') as transit_gateway_attachment_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::TransitGatewayRouteTablePropagation' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'TransitGatewayRouteTableId') as transit_gateway_route_table_id, + json_extract_path_text(Properties, 'TransitGatewayAttachmentId') as transit_gateway_attachment_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayRouteTablePropagation' + AND region = 'us-east-1' transit_gateway_vpc_attachments: name: transit_gateway_vpc_attachments id: aws.ec2.transit_gateway_vpc_attachments @@ -20889,7 +20560,7 @@ components: x-cfn-type-name: AWS::EC2::TransitGatewayVpcAttachment x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -20906,9 +20577,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -20918,41 +20589,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/transit_gateway_vpc_attachments/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/transit_gateway_vpc_attachments/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayVpcAttachment' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayVpcAttachment' - AND region = 'us-east-1' - transit_gateway_vpc_attachment: - name: transit_gateway_vpc_attachment - id: aws.ec2.transit_gateway_vpc_attachment - x-cfn-schema-name: TransitGatewayVpcAttachment - x-cfn-type-name: AWS::EC2::TransitGatewayVpcAttachment - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -20963,12 +20602,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/transit_gateway_vpc_attachments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/transit_gateway_vpc_attachments/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/transit_gateway_vpc_attachment/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/transit_gateway_vpc_attachments/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -20985,22 +20628,38 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Options') as options, - json_extract_path_text(Properties, 'TransitGatewayId') as transit_gateway_id, - json_extract_path_text(Properties, 'VpcId') as vpc_id, - json_extract_path_text(Properties, 'RemoveSubnetIds') as remove_subnet_ids, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'SubnetIds') as subnet_ids, - json_extract_path_text(Properties, 'AddSubnetIds') as add_subnet_ids, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::TransitGatewayVpcAttachment' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayVpcAttachment' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Options') as options, + json_extract_path_text(Properties, 'TransitGatewayId') as transit_gateway_id, + json_extract_path_text(Properties, 'VpcId') as vpc_id, + json_extract_path_text(Properties, 'RemoveSubnetIds') as remove_subnet_ids, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'SubnetIds') as subnet_ids, + json_extract_path_text(Properties, 'AddSubnetIds') as add_subnet_ids, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::TransitGatewayVpcAttachment' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::TransitGatewayVpcAttachment' + AND region = 'us-east-1' verified_access_endpoints: name: verified_access_endpoints id: aws.ec2.verified_access_endpoints @@ -21008,7 +20667,7 @@ components: x-cfn-type-name: AWS::EC2::VerifiedAccessEndpoint x-identifiers: - VerifiedAccessEndpointId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -21025,9 +20684,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -21037,41 +20696,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/verified_access_endpoints/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/verified_access_endpoints/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.VerifiedAccessEndpointId') as verified_access_endpoint_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VerifiedAccessEndpoint' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'VerifiedAccessEndpointId') as verified_access_endpoint_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VerifiedAccessEndpoint' - AND region = 'us-east-1' - verified_access_endpoint: - name: verified_access_endpoint - id: aws.ec2.verified_access_endpoint - x-cfn-schema-name: VerifiedAccessEndpoint - x-cfn-type-name: AWS::EC2::VerifiedAccessEndpoint - x-identifiers: - - VerifiedAccessEndpointId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -21082,12 +20709,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/verified_access_endpoints/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/verified_access_endpoints/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/verified_access_endpoint/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/verified_access_endpoints/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -21117,35 +20748,51 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'VerifiedAccessEndpointId') as verified_access_endpoint_id, - json_extract_path_text(Properties, 'VerifiedAccessGroupId') as verified_access_group_id, - json_extract_path_text(Properties, 'VerifiedAccessInstanceId') as verified_access_instance_id, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'SecurityGroupIds') as security_group_ids, - json_extract_path_text(Properties, 'NetworkInterfaceOptions') as network_interface_options, - json_extract_path_text(Properties, 'LoadBalancerOptions') as load_balancer_options, - json_extract_path_text(Properties, 'EndpointType') as endpoint_type, - json_extract_path_text(Properties, 'EndpointDomain') as endpoint_domain, - json_extract_path_text(Properties, 'EndpointDomainPrefix') as endpoint_domain_prefix, - json_extract_path_text(Properties, 'DeviceValidationDomain') as device_validation_domain, - json_extract_path_text(Properties, 'DomainCertificateArn') as domain_certificate_arn, - json_extract_path_text(Properties, 'AttachmentType') as attachment_type, - json_extract_path_text(Properties, 'ApplicationDomain') as application_domain, - json_extract_path_text(Properties, 'CreationTime') as creation_time, - json_extract_path_text(Properties, 'LastUpdatedTime') as last_updated_time, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'PolicyDocument') as policy_document, - json_extract_path_text(Properties, 'PolicyEnabled') as policy_enabled, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'SseSpecification') as sse_specification - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VerifiedAccessEndpoint' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.VerifiedAccessEndpointId') as verified_access_endpoint_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VerifiedAccessEndpoint' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'VerifiedAccessEndpointId') as verified_access_endpoint_id, + json_extract_path_text(Properties, 'VerifiedAccessGroupId') as verified_access_group_id, + json_extract_path_text(Properties, 'VerifiedAccessInstanceId') as verified_access_instance_id, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'SecurityGroupIds') as security_group_ids, + json_extract_path_text(Properties, 'NetworkInterfaceOptions') as network_interface_options, + json_extract_path_text(Properties, 'LoadBalancerOptions') as load_balancer_options, + json_extract_path_text(Properties, 'EndpointType') as endpoint_type, + json_extract_path_text(Properties, 'EndpointDomain') as endpoint_domain, + json_extract_path_text(Properties, 'EndpointDomainPrefix') as endpoint_domain_prefix, + json_extract_path_text(Properties, 'DeviceValidationDomain') as device_validation_domain, + json_extract_path_text(Properties, 'DomainCertificateArn') as domain_certificate_arn, + json_extract_path_text(Properties, 'AttachmentType') as attachment_type, + json_extract_path_text(Properties, 'ApplicationDomain') as application_domain, + json_extract_path_text(Properties, 'CreationTime') as creation_time, + json_extract_path_text(Properties, 'LastUpdatedTime') as last_updated_time, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'PolicyDocument') as policy_document, + json_extract_path_text(Properties, 'PolicyEnabled') as policy_enabled, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'SseSpecification') as sse_specification + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VerifiedAccessEndpoint' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'VerifiedAccessEndpointId') as verified_access_endpoint_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VerifiedAccessEndpoint' + AND region = 'us-east-1' verified_access_groups: name: verified_access_groups id: aws.ec2.verified_access_groups @@ -21153,7 +20800,7 @@ components: x-cfn-type-name: AWS::EC2::VerifiedAccessGroup x-identifiers: - VerifiedAccessGroupId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -21170,9 +20817,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -21182,41 +20829,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/verified_access_groups/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/verified_access_groups/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.VerifiedAccessGroupId') as verified_access_group_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VerifiedAccessGroup' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'VerifiedAccessGroupId') as verified_access_group_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VerifiedAccessGroup' - AND region = 'us-east-1' - verified_access_group: - name: verified_access_group - id: aws.ec2.verified_access_group - x-cfn-schema-name: VerifiedAccessGroup - x-cfn-type-name: AWS::EC2::VerifiedAccessGroup - x-identifiers: - - VerifiedAccessGroupId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -21227,12 +20842,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/verified_access_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/verified_access_groups/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/verified_access_group/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/verified_access_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -21252,25 +20871,41 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'VerifiedAccessGroupId') as verified_access_group_id, - json_extract_path_text(Properties, 'VerifiedAccessInstanceId') as verified_access_instance_id, - json_extract_path_text(Properties, 'VerifiedAccessGroupArn') as verified_access_group_arn, - json_extract_path_text(Properties, 'Owner') as owner, - json_extract_path_text(Properties, 'CreationTime') as creation_time, - json_extract_path_text(Properties, 'LastUpdatedTime') as last_updated_time, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'PolicyDocument') as policy_document, - json_extract_path_text(Properties, 'PolicyEnabled') as policy_enabled, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'SseSpecification') as sse_specification - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VerifiedAccessGroup' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.VerifiedAccessGroupId') as verified_access_group_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VerifiedAccessGroup' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'VerifiedAccessGroupId') as verified_access_group_id, + json_extract_path_text(Properties, 'VerifiedAccessInstanceId') as verified_access_instance_id, + json_extract_path_text(Properties, 'VerifiedAccessGroupArn') as verified_access_group_arn, + json_extract_path_text(Properties, 'Owner') as owner, + json_extract_path_text(Properties, 'CreationTime') as creation_time, + json_extract_path_text(Properties, 'LastUpdatedTime') as last_updated_time, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'PolicyDocument') as policy_document, + json_extract_path_text(Properties, 'PolicyEnabled') as policy_enabled, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'SseSpecification') as sse_specification + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VerifiedAccessGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'VerifiedAccessGroupId') as verified_access_group_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VerifiedAccessGroup' + AND region = 'us-east-1' verified_access_trust_providers: name: verified_access_trust_providers id: aws.ec2.verified_access_trust_providers @@ -21278,7 +20913,7 @@ components: x-cfn-type-name: AWS::EC2::VerifiedAccessTrustProvider x-identifiers: - VerifiedAccessTrustProviderId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -21295,9 +20930,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -21307,41 +20942,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/verified_access_trust_providers/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/verified_access_trust_providers/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.VerifiedAccessTrustProviderId') as verified_access_trust_provider_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VerifiedAccessTrustProvider' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'VerifiedAccessTrustProviderId') as verified_access_trust_provider_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VerifiedAccessTrustProvider' - AND region = 'us-east-1' - verified_access_trust_provider: - name: verified_access_trust_provider - id: aws.ec2.verified_access_trust_provider - x-cfn-schema-name: VerifiedAccessTrustProvider - x-cfn-type-name: AWS::EC2::VerifiedAccessTrustProvider - x-identifiers: - - VerifiedAccessTrustProviderId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -21352,12 +20955,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/verified_access_trust_providers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/verified_access_trust_providers/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/verified_access_trust_provider/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/verified_access_trust_providers/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -21378,26 +20985,42 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'TrustProviderType') as trust_provider_type, - json_extract_path_text(Properties, 'DeviceTrustProviderType') as device_trust_provider_type, - json_extract_path_text(Properties, 'UserTrustProviderType') as user_trust_provider_type, - json_extract_path_text(Properties, 'OidcOptions') as oidc_options, - json_extract_path_text(Properties, 'DeviceOptions') as device_options, - json_extract_path_text(Properties, 'PolicyReferenceName') as policy_reference_name, - json_extract_path_text(Properties, 'CreationTime') as creation_time, - json_extract_path_text(Properties, 'LastUpdatedTime') as last_updated_time, - json_extract_path_text(Properties, 'VerifiedAccessTrustProviderId') as verified_access_trust_provider_id, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'SseSpecification') as sse_specification - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VerifiedAccessTrustProvider' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.VerifiedAccessTrustProviderId') as verified_access_trust_provider_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VerifiedAccessTrustProvider' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'TrustProviderType') as trust_provider_type, + json_extract_path_text(Properties, 'DeviceTrustProviderType') as device_trust_provider_type, + json_extract_path_text(Properties, 'UserTrustProviderType') as user_trust_provider_type, + json_extract_path_text(Properties, 'OidcOptions') as oidc_options, + json_extract_path_text(Properties, 'DeviceOptions') as device_options, + json_extract_path_text(Properties, 'PolicyReferenceName') as policy_reference_name, + json_extract_path_text(Properties, 'CreationTime') as creation_time, + json_extract_path_text(Properties, 'LastUpdatedTime') as last_updated_time, + json_extract_path_text(Properties, 'VerifiedAccessTrustProviderId') as verified_access_trust_provider_id, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'SseSpecification') as sse_specification + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VerifiedAccessTrustProvider' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'VerifiedAccessTrustProviderId') as verified_access_trust_provider_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VerifiedAccessTrustProvider' + AND region = 'us-east-1' verified_access_instances: name: verified_access_instances id: aws.ec2.verified_access_instances @@ -21405,7 +21028,7 @@ components: x-cfn-type-name: AWS::EC2::VerifiedAccessInstance x-identifiers: - VerifiedAccessInstanceId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -21422,9 +21045,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -21434,41 +21057,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/verified_access_instances/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/verified_access_instances/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.VerifiedAccessInstanceId') as verified_access_instance_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VerifiedAccessInstance' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'VerifiedAccessInstanceId') as verified_access_instance_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VerifiedAccessInstance' - AND region = 'us-east-1' - verified_access_instance: - name: verified_access_instance - id: aws.ec2.verified_access_instance - x-cfn-schema-name: VerifiedAccessInstance - x-cfn-type-name: AWS::EC2::VerifiedAccessInstance - x-identifiers: - - VerifiedAccessInstanceId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -21479,12 +21070,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/verified_access_instances/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/verified_access_instances/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/verified_access_instance/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/verified_access_instances/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -21502,23 +21097,39 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'VerifiedAccessInstanceId') as verified_access_instance_id, - json_extract_path_text(Properties, 'VerifiedAccessTrustProviders') as verified_access_trust_providers, - json_extract_path_text(Properties, 'VerifiedAccessTrustProviderIds') as verified_access_trust_provider_ids, - json_extract_path_text(Properties, 'CreationTime') as creation_time, - json_extract_path_text(Properties, 'LastUpdatedTime') as last_updated_time, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'LoggingConfigurations') as logging_configurations, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'FipsEnabled') as fips_enabled - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VerifiedAccessInstance' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.VerifiedAccessInstanceId') as verified_access_instance_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VerifiedAccessInstance' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'VerifiedAccessInstanceId') as verified_access_instance_id, + json_extract_path_text(Properties, 'VerifiedAccessTrustProviders') as verified_access_trust_providers, + json_extract_path_text(Properties, 'VerifiedAccessTrustProviderIds') as verified_access_trust_provider_ids, + json_extract_path_text(Properties, 'CreationTime') as creation_time, + json_extract_path_text(Properties, 'LastUpdatedTime') as last_updated_time, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'LoggingConfigurations') as logging_configurations, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'FipsEnabled') as fips_enabled + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VerifiedAccessInstance' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'VerifiedAccessInstanceId') as verified_access_instance_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VerifiedAccessInstance' + AND region = 'us-east-1' volume_attachments: name: volume_attachments id: aws.ec2.volume_attachments @@ -21527,7 +21138,7 @@ components: x-identifiers: - VolumeId - InstanceId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -21561,42 +21172,11 @@ components: - $ref: '#/components/x-stackQL-resources/volume_attachments/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/volume_attachments/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.VolumeId') as volume_id, - JSON_EXTRACT(Properties, '$.InstanceId') as instance_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VolumeAttachment' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'VolumeId') as volume_id, - json_extract_path_text(Properties, 'InstanceId') as instance_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VolumeAttachment' - AND region = 'us-east-1' - volume_attachment: - name: volume_attachment - id: aws.ec2.volume_attachment - x-cfn-schema-name: VolumeAttachment - x-cfn-type-name: AWS::EC2::VolumeAttachment - x-identifiers: - - VolumeId - - InstanceId - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -21608,17 +21188,35 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'VolumeId') as volume_id, - json_extract_path_text(Properties, 'InstanceId') as instance_id, - json_extract_path_text(Properties, 'Device') as device - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VolumeAttachment' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.VolumeId') as volume_id, + JSON_EXTRACT(Properties, '$.InstanceId') as instance_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VolumeAttachment' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'VolumeId') as volume_id, + json_extract_path_text(Properties, 'InstanceId') as instance_id, + json_extract_path_text(Properties, 'Device') as device + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VolumeAttachment' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'VolumeId') as volume_id, + json_extract_path_text(Properties, 'InstanceId') as instance_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VolumeAttachment' + AND region = 'us-east-1' vpcs: name: vpcs id: aws.ec2.vpcs @@ -21626,7 +21224,7 @@ components: x-cfn-type-name: AWS::EC2::VPC x-identifiers: - VpcId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -21643,9 +21241,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -21655,41 +21253,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/vpcs/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/vpcs/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.VpcId') as vpc_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPC' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'VpcId') as vpc_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPC' - AND region = 'us-east-1' - vpc: - name: vpc - id: aws.ec2.vpc - x-cfn-schema-name: VPC - x-cfn-type-name: AWS::EC2::VPC - x-identifiers: - - VpcId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -21700,12 +21266,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/vpcs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/vpcs/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/vpc/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/vpcs/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -21726,26 +21296,42 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'VpcId') as vpc_id, - json_extract_path_text(Properties, 'InstanceTenancy') as instance_tenancy, - json_extract_path_text(Properties, 'Ipv4NetmaskLength') as ipv4_netmask_length, - json_extract_path_text(Properties, 'CidrBlockAssociations') as cidr_block_associations, - json_extract_path_text(Properties, 'CidrBlock') as cidr_block, - json_extract_path_text(Properties, 'Ipv4IpamPoolId') as ipv4_ipam_pool_id, - json_extract_path_text(Properties, 'DefaultNetworkAcl') as default_network_acl, - json_extract_path_text(Properties, 'EnableDnsSupport') as enable_dns_support, - json_extract_path_text(Properties, 'Ipv6CidrBlocks') as ipv6_cidr_blocks, - json_extract_path_text(Properties, 'DefaultSecurityGroup') as default_security_group, - json_extract_path_text(Properties, 'EnableDnsHostnames') as enable_dns_hostnames, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VPC' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.VpcId') as vpc_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPC' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'VpcId') as vpc_id, + json_extract_path_text(Properties, 'InstanceTenancy') as instance_tenancy, + json_extract_path_text(Properties, 'Ipv4NetmaskLength') as ipv4_netmask_length, + json_extract_path_text(Properties, 'CidrBlockAssociations') as cidr_block_associations, + json_extract_path_text(Properties, 'CidrBlock') as cidr_block, + json_extract_path_text(Properties, 'Ipv4IpamPoolId') as ipv4_ipam_pool_id, + json_extract_path_text(Properties, 'DefaultNetworkAcl') as default_network_acl, + json_extract_path_text(Properties, 'EnableDnsSupport') as enable_dns_support, + json_extract_path_text(Properties, 'Ipv6CidrBlocks') as ipv6_cidr_blocks, + json_extract_path_text(Properties, 'DefaultSecurityGroup') as default_security_group, + json_extract_path_text(Properties, 'EnableDnsHostnames') as enable_dns_hostnames, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VPC' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'VpcId') as vpc_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPC' + AND region = 'us-east-1' vpc_cidr_blocks: name: vpc_cidr_blocks id: aws.ec2.vpc_cidr_blocks @@ -21754,7 +21340,7 @@ components: x-identifiers: - Id - VpcId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -21788,42 +21374,11 @@ components: - $ref: '#/components/x-stackQL-resources/vpc_cidr_blocks/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/vpc_cidr_blocks/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id, - JSON_EXTRACT(Properties, '$.VpcId') as vpc_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPCCidrBlock' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'VpcId') as vpc_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPCCidrBlock' - AND region = 'us-east-1' - vpc_cidr_block: - name: vpc_cidr_block - id: aws.ec2.vpc_cidr_block - x-cfn-schema-name: VPCCidrBlock - x-cfn-type-name: AWS::EC2::VPCCidrBlock - x-identifiers: - - Id - - VpcId - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -21842,24 +21397,42 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'CidrBlock') as cidr_block, - json_extract_path_text(Properties, 'Ipv6Pool') as ipv6_pool, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'VpcId') as vpc_id, - json_extract_path_text(Properties, 'Ipv6CidrBlock') as ipv6_cidr_block, - json_extract_path_text(Properties, 'Ipv4IpamPoolId') as ipv4_ipam_pool_id, - json_extract_path_text(Properties, 'Ipv4NetmaskLength') as ipv4_netmask_length, - json_extract_path_text(Properties, 'Ipv6IpamPoolId') as ipv6_ipam_pool_id, - json_extract_path_text(Properties, 'Ipv6NetmaskLength') as ipv6_netmask_length, - json_extract_path_text(Properties, 'AmazonProvidedIpv6CidrBlock') as amazon_provided_ipv6_cidr_block - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VPCCidrBlock' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.VpcId') as vpc_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPCCidrBlock' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'CidrBlock') as cidr_block, + json_extract_path_text(Properties, 'Ipv6Pool') as ipv6_pool, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'VpcId') as vpc_id, + json_extract_path_text(Properties, 'Ipv6CidrBlock') as ipv6_cidr_block, + json_extract_path_text(Properties, 'Ipv4IpamPoolId') as ipv4_ipam_pool_id, + json_extract_path_text(Properties, 'Ipv4NetmaskLength') as ipv4_netmask_length, + json_extract_path_text(Properties, 'Ipv6IpamPoolId') as ipv6_ipam_pool_id, + json_extract_path_text(Properties, 'Ipv6NetmaskLength') as ipv6_netmask_length, + json_extract_path_text(Properties, 'AmazonProvidedIpv6CidrBlock') as amazon_provided_ipv6_cidr_block + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VPCCidrBlock' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'VpcId') as vpc_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPCCidrBlock' + AND region = 'us-east-1' vpcdhcp_options_associations: name: vpcdhcp_options_associations id: aws.ec2.vpcdhcp_options_associations @@ -21868,7 +21441,7 @@ components: x-identifiers: - DhcpOptionsId - VpcId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -21885,9 +21458,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -21897,44 +21470,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/vpcdhcp_options_associations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/vpcdhcp_options_associations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.DhcpOptionsId') as dhcp_options_id, - JSON_EXTRACT(Properties, '$.VpcId') as vpc_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPCDHCPOptionsAssociation' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'DhcpOptionsId') as dhcp_options_id, - json_extract_path_text(Properties, 'VpcId') as vpc_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPCDHCPOptionsAssociation' - AND region = 'us-east-1' - vpcdhcp_options_association: - name: vpcdhcp_options_association - id: aws.ec2.vpcdhcp_options_association - x-cfn-schema-name: VPCDHCPOptionsAssociation - x-cfn-type-name: AWS::EC2::VPCDHCPOptionsAssociation - x-identifiers: - - DhcpOptionsId - - VpcId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -21945,12 +21483,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/vpcdhcp_options_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/vpcdhcp_options_associations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/vpcdhcp_options_association/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/vpcdhcp_options_associations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -21961,16 +21503,34 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'DhcpOptionsId') as dhcp_options_id, - json_extract_path_text(Properties, 'VpcId') as vpc_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VPCDHCPOptionsAssociation' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.DhcpOptionsId') as dhcp_options_id, + JSON_EXTRACT(Properties, '$.VpcId') as vpc_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPCDHCPOptionsAssociation' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DhcpOptionsId') as dhcp_options_id, + json_extract_path_text(Properties, 'VpcId') as vpc_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VPCDHCPOptionsAssociation' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DhcpOptionsId') as dhcp_options_id, + json_extract_path_text(Properties, 'VpcId') as vpc_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPCDHCPOptionsAssociation' + AND region = 'us-east-1' vpc_endpoints: name: vpc_endpoints id: aws.ec2.vpc_endpoints @@ -21978,7 +21538,7 @@ components: x-cfn-type-name: AWS::EC2::VPCEndpoint x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -21995,9 +21555,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -22007,41 +21567,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/vpc_endpoints/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/vpc_endpoints/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPCEndpoint' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPCEndpoint' - AND region = 'us-east-1' - vpc_endpoint: - name: vpc_endpoint - id: aws.ec2.vpc_endpoint - x-cfn-schema-name: VPCEndpoint - x-cfn-type-name: AWS::EC2::VPCEndpoint - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -22052,12 +21580,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/vpc_endpoints/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/vpc_endpoints/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/vpc_endpoint/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/vpc_endpoints/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -22078,26 +21610,42 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'CreationTimestamp') as creation_timestamp, - json_extract_path_text(Properties, 'DnsEntries') as dns_entries, - json_extract_path_text(Properties, 'NetworkInterfaceIds') as network_interface_ids, - json_extract_path_text(Properties, 'PolicyDocument') as policy_document, - json_extract_path_text(Properties, 'PrivateDnsEnabled') as private_dns_enabled, - json_extract_path_text(Properties, 'RouteTableIds') as route_table_ids, - json_extract_path_text(Properties, 'SecurityGroupIds') as security_group_ids, - json_extract_path_text(Properties, 'ServiceName') as service_name, - json_extract_path_text(Properties, 'SubnetIds') as subnet_ids, - json_extract_path_text(Properties, 'VpcEndpointType') as vpc_endpoint_type, - json_extract_path_text(Properties, 'VpcId') as vpc_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VPCEndpoint' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPCEndpoint' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'CreationTimestamp') as creation_timestamp, + json_extract_path_text(Properties, 'DnsEntries') as dns_entries, + json_extract_path_text(Properties, 'NetworkInterfaceIds') as network_interface_ids, + json_extract_path_text(Properties, 'PolicyDocument') as policy_document, + json_extract_path_text(Properties, 'PrivateDnsEnabled') as private_dns_enabled, + json_extract_path_text(Properties, 'RouteTableIds') as route_table_ids, + json_extract_path_text(Properties, 'SecurityGroupIds') as security_group_ids, + json_extract_path_text(Properties, 'ServiceName') as service_name, + json_extract_path_text(Properties, 'SubnetIds') as subnet_ids, + json_extract_path_text(Properties, 'VpcEndpointType') as vpc_endpoint_type, + json_extract_path_text(Properties, 'VpcId') as vpc_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VPCEndpoint' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPCEndpoint' + AND region = 'us-east-1' vpc_endpoint_connection_notifications: name: vpc_endpoint_connection_notifications id: aws.ec2.vpc_endpoint_connection_notifications @@ -22105,7 +21653,7 @@ components: x-cfn-type-name: AWS::EC2::VPCEndpointConnectionNotification x-identifiers: - VPCEndpointConnectionNotificationId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -22122,9 +21670,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -22134,41 +21682,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/vpc_endpoint_connection_notifications/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/vpc_endpoint_connection_notifications/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.VPCEndpointConnectionNotificationId') as vpc_endpoint_connection_notification_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPCEndpointConnectionNotification' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'VPCEndpointConnectionNotificationId') as vpc_endpoint_connection_notification_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPCEndpointConnectionNotification' - AND region = 'us-east-1' - vpc_endpoint_connection_notification: - name: vpc_endpoint_connection_notification - id: aws.ec2.vpc_endpoint_connection_notification - x-cfn-schema-name: VPCEndpointConnectionNotification - x-cfn-type-name: AWS::EC2::VPCEndpointConnectionNotification - x-identifiers: - - VPCEndpointConnectionNotificationId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -22179,12 +21695,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/vpc_endpoint_connection_notifications/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/vpc_endpoint_connection_notifications/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/vpc_endpoint_connection_notification/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/vpc_endpoint_connection_notifications/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -22198,19 +21718,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'VPCEndpointConnectionNotificationId') as vpc_endpoint_connection_notification_id, - json_extract_path_text(Properties, 'ConnectionEvents') as connection_events, - json_extract_path_text(Properties, 'ConnectionNotificationArn') as connection_notification_arn, - json_extract_path_text(Properties, 'ServiceId') as service_id, - json_extract_path_text(Properties, 'VPCEndpointId') as vpc_endpoint_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VPCEndpointConnectionNotification' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.VPCEndpointConnectionNotificationId') as vpc_endpoint_connection_notification_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPCEndpointConnectionNotification' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'VPCEndpointConnectionNotificationId') as vpc_endpoint_connection_notification_id, + json_extract_path_text(Properties, 'ConnectionEvents') as connection_events, + json_extract_path_text(Properties, 'ConnectionNotificationArn') as connection_notification_arn, + json_extract_path_text(Properties, 'ServiceId') as service_id, + json_extract_path_text(Properties, 'VPCEndpointId') as vpc_endpoint_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VPCEndpointConnectionNotification' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'VPCEndpointConnectionNotificationId') as vpc_endpoint_connection_notification_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPCEndpointConnectionNotification' + AND region = 'us-east-1' vpc_endpoint_services: name: vpc_endpoint_services id: aws.ec2.vpc_endpoint_services @@ -22218,7 +21754,7 @@ components: x-cfn-type-name: AWS::EC2::VPCEndpointService x-identifiers: - ServiceId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -22235,9 +21771,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -22247,41 +21783,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/vpc_endpoint_services/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/vpc_endpoint_services/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ServiceId') as service_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPCEndpointService' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ServiceId') as service_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPCEndpointService' - AND region = 'us-east-1' - vpc_endpoint_service: - name: vpc_endpoint_service - id: aws.ec2.vpc_endpoint_service - x-cfn-schema-name: VPCEndpointService - x-cfn-type-name: AWS::EC2::VPCEndpointService - x-identifiers: - - ServiceId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -22292,12 +21796,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/vpc_endpoint_services/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/vpc_endpoint_services/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/vpc_endpoint_service/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/vpc_endpoint_services/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -22312,20 +21820,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'NetworkLoadBalancerArns') as network_load_balancer_arns, - json_extract_path_text(Properties, 'ContributorInsightsEnabled') as contributor_insights_enabled, - json_extract_path_text(Properties, 'PayerResponsibility') as payer_responsibility, - json_extract_path_text(Properties, 'ServiceId') as service_id, - json_extract_path_text(Properties, 'AcceptanceRequired') as acceptance_required, - json_extract_path_text(Properties, 'GatewayLoadBalancerArns') as gateway_load_balancer_arns - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VPCEndpointService' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ServiceId') as service_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPCEndpointService' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'NetworkLoadBalancerArns') as network_load_balancer_arns, + json_extract_path_text(Properties, 'ContributorInsightsEnabled') as contributor_insights_enabled, + json_extract_path_text(Properties, 'PayerResponsibility') as payer_responsibility, + json_extract_path_text(Properties, 'ServiceId') as service_id, + json_extract_path_text(Properties, 'AcceptanceRequired') as acceptance_required, + json_extract_path_text(Properties, 'GatewayLoadBalancerArns') as gateway_load_balancer_arns + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VPCEndpointService' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ServiceId') as service_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPCEndpointService' + AND region = 'us-east-1' vpc_endpoint_service_permissions: name: vpc_endpoint_service_permissions id: aws.ec2.vpc_endpoint_service_permissions @@ -22333,11 +21857,14 @@ components: x-cfn-type-name: AWS::EC2::VPCEndpointServicePermissions x-identifiers: - ServiceId - x-type: get + x-type: cloud_control methods: - update_resource: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__VPCEndpointServicePermissions&__detailTransformed=true/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -22347,54 +21874,14 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - update: - - $ref: '#/components/x-stackQL-resources/vpc_endpoint_service_permissions/methods/update_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - data__Identifier, - JSON_EXTRACT(Properties, '$.AllowedPrincipals') as allowed_principals, - JSON_EXTRACT(Properties, '$.ServiceId') as service_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VPCEndpointServicePermissions' - AND data__Identifier = '' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - data__Identifier, - json_extract_path_text(Properties, 'AllowedPrincipals') as allowed_principals, - json_extract_path_text(Properties, 'ServiceId') as service_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VPCEndpointServicePermissions' - AND data__Identifier = '' - AND region = 'us-east-1' - vpc_gateway_attachments: - name: vpc_gateway_attachments - id: aws.ec2.vpc_gateway_attachments - x-cfn-schema-name: VPCGatewayAttachment - x-cfn-type-name: AWS::EC2::VPCGatewayAttachment - x-identifiers: - - AttachmentType - - VpcId - x-type: list - methods: - create_resource: - config: - requestBodyTranslate: - algorithm: naive_DesiredState + update_resource: operation: - $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__VPCGatewayAttachment&__detailTransformed=true/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- { - "TypeName": "AWS::EC2::VPCGatewayAttachment" + "TypeName": "AWS::EC2::VPCEndpointServicePermissions" } response: mediaType: application/json @@ -22406,46 +21893,83 @@ components: mediaType: application/x-amz-json-1.0 base: |- { - "TypeName": "AWS::EC2::VPCGatewayAttachment" + "TypeName": "AWS::EC2::VPCEndpointServicePermissions" } response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: insert: - - $ref: '#/components/x-stackQL-resources/vpc_gateway_attachments/methods/create_resource' + - $ref: '#/components/x-stackQL-resources/vpc_endpoint_service_permissions/methods/create_resource' delete: - - $ref: '#/components/x-stackQL-resources/vpc_gateway_attachments/methods/delete_resource' + - $ref: '#/components/x-stackQL-resources/vpc_endpoint_service_permissions/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/vpc_endpoint_service_permissions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.AttachmentType') as attachment_type, - JSON_EXTRACT(Properties, '$.VpcId') as vpc_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPCGatewayAttachment' + data__Identifier, + JSON_EXTRACT(Properties, '$.AllowedPrincipals') as allowed_principals, + JSON_EXTRACT(Properties, '$.ServiceId') as service_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VPCEndpointServicePermissions' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - json_extract_path_text(Properties, 'AttachmentType') as attachment_type, - json_extract_path_text(Properties, 'VpcId') as vpc_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPCGatewayAttachment' + JSON_EXTRACT(Properties, '$.ServiceId') as service_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPCEndpointServicePermissions' AND region = 'us-east-1' - vpc_gateway_attachment: - name: vpc_gateway_attachment - id: aws.ec2.vpc_gateway_attachment + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AllowedPrincipals') as allowed_principals, + json_extract_path_text(Properties, 'ServiceId') as service_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VPCEndpointServicePermissions' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ServiceId') as service_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPCEndpointServicePermissions' + AND region = 'us-east-1' + vpc_gateway_attachments: + name: vpc_gateway_attachments + id: aws.ec2.vpc_gateway_attachments x-cfn-schema-name: VPCGatewayAttachment x-cfn-type-name: AWS::EC2::VPCGatewayAttachment x-identifiers: - AttachmentType - VpcId - x-type: get + x-type: cloud_control methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__VPCGatewayAttachment&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::VPCGatewayAttachment" + } + response: + mediaType: application/json + openAPIDocKey: '200' update_resource: operation: $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' @@ -22458,13 +21982,29 @@ components: response: mediaType: application/json openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EC2::VPCGatewayAttachment" + } + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/vpc_gateway_attachments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/vpc_gateway_attachments/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/vpc_gateway_attachment/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/vpc_gateway_attachments/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -22477,18 +22017,36 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AttachmentType') as attachment_type, - json_extract_path_text(Properties, 'InternetGatewayId') as internet_gateway_id, - json_extract_path_text(Properties, 'VpcId') as vpc_id, - json_extract_path_text(Properties, 'VpnGatewayId') as vpn_gateway_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VPCGatewayAttachment' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.AttachmentType') as attachment_type, + JSON_EXTRACT(Properties, '$.VpcId') as vpc_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPCGatewayAttachment' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AttachmentType') as attachment_type, + json_extract_path_text(Properties, 'InternetGatewayId') as internet_gateway_id, + json_extract_path_text(Properties, 'VpcId') as vpc_id, + json_extract_path_text(Properties, 'VpnGatewayId') as vpn_gateway_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VPCGatewayAttachment' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AttachmentType') as attachment_type, + json_extract_path_text(Properties, 'VpcId') as vpc_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPCGatewayAttachment' + AND region = 'us-east-1' vpc_peering_connections: name: vpc_peering_connections id: aws.ec2.vpc_peering_connections @@ -22496,7 +22054,7 @@ components: x-cfn-type-name: AWS::EC2::VPCPeeringConnection x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -22513,9 +22071,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -22525,41 +22083,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/vpc_peering_connections/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/vpc_peering_connections/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPCPeeringConnection' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPCPeeringConnection' - AND region = 'us-east-1' - vpc_peering_connection: - name: vpc_peering_connection - id: aws.ec2.vpc_peering_connection - x-cfn-schema-name: VPCPeeringConnection - x-cfn-type-name: AWS::EC2::VPCPeeringConnection - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -22570,12 +22096,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/vpc_peering_connections/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/vpc_peering_connections/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/vpc_peering_connection/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/vpc_peering_connections/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -22591,21 +22121,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'PeerOwnerId') as peer_owner_id, - json_extract_path_text(Properties, 'PeerRegion') as peer_region, - json_extract_path_text(Properties, 'PeerRoleArn') as peer_role_arn, - json_extract_path_text(Properties, 'PeerVpcId') as peer_vpc_id, - json_extract_path_text(Properties, 'VpcId') as vpc_id, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VPCPeeringConnection' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPCPeeringConnection' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'PeerOwnerId') as peer_owner_id, + json_extract_path_text(Properties, 'PeerRegion') as peer_region, + json_extract_path_text(Properties, 'PeerRoleArn') as peer_role_arn, + json_extract_path_text(Properties, 'PeerVpcId') as peer_vpc_id, + json_extract_path_text(Properties, 'VpcId') as vpc_id, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VPCPeeringConnection' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPCPeeringConnection' + AND region = 'us-east-1' vpn_connections: name: vpn_connections id: aws.ec2.vpn_connections @@ -22613,7 +22159,7 @@ components: x-cfn-type-name: AWS::EC2::VPNConnection x-identifiers: - VpnConnectionId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -22630,9 +22176,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -22642,41 +22188,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/vpn_connections/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/vpn_connections/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.VpnConnectionId') as vpn_connection_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPNConnection' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'VpnConnectionId') as vpn_connection_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPNConnection' - AND region = 'us-east-1' - vpn_connection: - name: vpn_connection - id: aws.ec2.vpn_connection - x-cfn-schema-name: VPNConnection - x-cfn-type-name: AWS::EC2::VPNConnection - x-identifiers: - - VpnConnectionId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -22687,12 +22201,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/vpn_connections/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/vpn_connections/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/vpn_connection/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/vpn_connections/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -22709,22 +22227,38 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'VpnConnectionId') as vpn_connection_id, - json_extract_path_text(Properties, 'CustomerGatewayId') as customer_gateway_id, - json_extract_path_text(Properties, 'StaticRoutesOnly') as static_routes_only, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'TransitGatewayId') as transit_gateway_id, - json_extract_path_text(Properties, 'Type') as type, - json_extract_path_text(Properties, 'VpnGatewayId') as vpn_gateway_id, - json_extract_path_text(Properties, 'VpnTunnelOptionsSpecifications') as vpn_tunnel_options_specifications - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VPNConnection' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.VpnConnectionId') as vpn_connection_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPNConnection' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'VpnConnectionId') as vpn_connection_id, + json_extract_path_text(Properties, 'CustomerGatewayId') as customer_gateway_id, + json_extract_path_text(Properties, 'StaticRoutesOnly') as static_routes_only, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'TransitGatewayId') as transit_gateway_id, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'VpnGatewayId') as vpn_gateway_id, + json_extract_path_text(Properties, 'VpnTunnelOptionsSpecifications') as vpn_tunnel_options_specifications + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VPNConnection' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'VpnConnectionId') as vpn_connection_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPNConnection' + AND region = 'us-east-1' vpn_connection_routes: name: vpn_connection_routes id: aws.ec2.vpn_connection_routes @@ -22733,7 +22267,7 @@ components: x-identifiers: - DestinationCidrBlock - VpnConnectionId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -22767,42 +22301,11 @@ components: - $ref: '#/components/x-stackQL-resources/vpn_connection_routes/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/vpn_connection_routes/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.DestinationCidrBlock') as destination_cidr_block, - JSON_EXTRACT(Properties, '$.VpnConnectionId') as vpn_connection_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPNConnectionRoute' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'DestinationCidrBlock') as destination_cidr_block, - json_extract_path_text(Properties, 'VpnConnectionId') as vpn_connection_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPNConnectionRoute' - AND region = 'us-east-1' - vpn_connection_route: - name: vpn_connection_route - id: aws.ec2.vpn_connection_route - x-cfn-schema-name: VPNConnectionRoute - x-cfn-type-name: AWS::EC2::VPNConnectionRoute - x-identifiers: - - DestinationCidrBlock - - VpnConnectionId - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -22813,16 +22316,34 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'DestinationCidrBlock') as destination_cidr_block, - json_extract_path_text(Properties, 'VpnConnectionId') as vpn_connection_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VPNConnectionRoute' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.DestinationCidrBlock') as destination_cidr_block, + JSON_EXTRACT(Properties, '$.VpnConnectionId') as vpn_connection_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPNConnectionRoute' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DestinationCidrBlock') as destination_cidr_block, + json_extract_path_text(Properties, 'VpnConnectionId') as vpn_connection_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VPNConnectionRoute' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DestinationCidrBlock') as destination_cidr_block, + json_extract_path_text(Properties, 'VpnConnectionId') as vpn_connection_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPNConnectionRoute' + AND region = 'us-east-1' vpn_gateways: name: vpn_gateways id: aws.ec2.vpn_gateways @@ -22830,7 +22351,7 @@ components: x-cfn-type-name: AWS::EC2::VPNGateway x-identifiers: - VPNGatewayId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -22847,9 +22368,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -22859,41 +22380,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/vpn_gateways/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/vpn_gateways/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.VPNGatewayId') as v_pn_gateway_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPNGateway' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'VPNGatewayId') as v_pn_gateway_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPNGateway' - AND region = 'us-east-1' - vpn_gateway: - name: vpn_gateway - id: aws.ec2.vpn_gateway - x-cfn-schema-name: VPNGateway - x-cfn-type-name: AWS::EC2::VPNGateway - x-identifiers: - - VPNGatewayId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -22904,12 +22393,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/vpn_gateways/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/vpn_gateways/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/vpn_gateway/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/vpn_gateways/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -22922,23 +22415,39 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'VPNGatewayId') as v_pn_gateway_id, - json_extract_path_text(Properties, 'AmazonSideAsn') as amazon_side_asn, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Type') as type - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VPNGateway' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.VPNGatewayId') as v_pn_gateway_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPNGateway' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'VPNGatewayId') as v_pn_gateway_id, + json_extract_path_text(Properties, 'AmazonSideAsn') as amazon_side_asn, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Type') as type + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EC2::VPNGateway' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'VPNGatewayId') as v_pn_gateway_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPNGateway' + AND region = 'us-east-1' snapshots: name: snapshots id: aws.ec2.snapshots x-cfn-schema-name: snapshots - x-type: custom_list + x-type: view config: views: select: @@ -25628,6 +25137,48 @@ paths: schema: $ref: '#/components/x-cloud-control-schemas/ProgressEvent' description: Success + /?Action=CreateResource&Version=2021-09-30&__TransitGatewayRoute&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTransitGatewayRoute + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTransitGatewayRouteRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success /?Action=CreateResource&Version=2021-09-30&__TransitGatewayRouteTable&__detailTransformed=true: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' @@ -25712,6 +25263,48 @@ paths: schema: $ref: '#/components/x-cloud-control-schemas/ProgressEvent' description: Success + /?Action=CreateResource&Version=2021-09-30&__TransitGatewayRouteTablePropagation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateTransitGatewayRouteTablePropagation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateTransitGatewayRouteTablePropagationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success /?Action=CreateResource&Version=2021-09-30&__TransitGatewayVpcAttachment&__detailTransformed=true: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' diff --git a/providers/src/aws/v00.00.00000/services/ecr.yaml b/providers/src/aws/v00.00.00000/services/ecr.yaml index a478ace2..4a1a3876 100644 --- a/providers/src/aws/v00.00.00000/services/ecr.yaml +++ b/providers/src/aws/v00.00.00000/services/ecr.yaml @@ -1240,7 +1240,7 @@ components: x-cfn-type-name: AWS::ECR::PublicRepository x-identifiers: - RepositoryName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1257,9 +1257,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1269,41 +1269,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/public_repositories/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/public_repositories/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.RepositoryName') as repository_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ECR::PublicRepository' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'RepositoryName') as repository_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ECR::PublicRepository' - AND region = 'us-east-1' - public_repository: - name: public_repository - id: aws.ecr.public_repository - x-cfn-schema-name: PublicRepository - x-cfn-type-name: AWS::ECR::PublicRepository - x-identifiers: - - RepositoryName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1314,12 +1282,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/public_repositories/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/public_repositories/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/public_repository/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/public_repositories/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1333,19 +1305,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'RepositoryName') as repository_name, - json_extract_path_text(Properties, 'RepositoryPolicyText') as repository_policy_text, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'RepositoryCatalogData') as repository_catalog_data, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ECR::PublicRepository' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.RepositoryName') as repository_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ECR::PublicRepository' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'RepositoryName') as repository_name, + json_extract_path_text(Properties, 'RepositoryPolicyText') as repository_policy_text, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'RepositoryCatalogData') as repository_catalog_data, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ECR::PublicRepository' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'RepositoryName') as repository_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ECR::PublicRepository' + AND region = 'us-east-1' pull_through_cache_rules: name: pull_through_cache_rules id: aws.ecr.pull_through_cache_rules @@ -1353,7 +1341,7 @@ components: x-cfn-type-name: AWS::ECR::PullThroughCacheRule x-identifiers: - EcrRepositoryPrefix - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1370,9 +1358,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1382,41 +1370,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/pull_through_cache_rules/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/pull_through_cache_rules/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.EcrRepositoryPrefix') as ecr_repository_prefix - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ECR::PullThroughCacheRule' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'EcrRepositoryPrefix') as ecr_repository_prefix - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ECR::PullThroughCacheRule' - AND region = 'us-east-1' - pull_through_cache_rule: - name: pull_through_cache_rule - id: aws.ecr.pull_through_cache_rule - x-cfn-schema-name: PullThroughCacheRule - x-cfn-type-name: AWS::ECR::PullThroughCacheRule - x-identifiers: - - EcrRepositoryPrefix - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1427,12 +1383,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/pull_through_cache_rules/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/pull_through_cache_rules/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/pull_through_cache_rule/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/pull_through_cache_rules/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1445,18 +1405,34 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'EcrRepositoryPrefix') as ecr_repository_prefix, - json_extract_path_text(Properties, 'UpstreamRegistryUrl') as upstream_registry_url, - json_extract_path_text(Properties, 'CredentialArn') as credential_arn, - json_extract_path_text(Properties, 'UpstreamRegistry') as upstream_registry - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ECR::PullThroughCacheRule' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.EcrRepositoryPrefix') as ecr_repository_prefix + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ECR::PullThroughCacheRule' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'EcrRepositoryPrefix') as ecr_repository_prefix, + json_extract_path_text(Properties, 'UpstreamRegistryUrl') as upstream_registry_url, + json_extract_path_text(Properties, 'CredentialArn') as credential_arn, + json_extract_path_text(Properties, 'UpstreamRegistry') as upstream_registry + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ECR::PullThroughCacheRule' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'EcrRepositoryPrefix') as ecr_repository_prefix + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ECR::PullThroughCacheRule' + AND region = 'us-east-1' registry_policies: name: registry_policies id: aws.ecr.registry_policies @@ -1464,7 +1440,7 @@ components: x-cfn-type-name: AWS::ECR::RegistryPolicy x-identifiers: - RegistryId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1481,9 +1457,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1493,41 +1469,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/registry_policies/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/registry_policies/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.RegistryId') as registry_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ECR::RegistryPolicy' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'RegistryId') as registry_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ECR::RegistryPolicy' - AND region = 'us-east-1' - registry_policy: - name: registry_policy - id: aws.ecr.registry_policy - x-cfn-schema-name: RegistryPolicy - x-cfn-type-name: AWS::ECR::RegistryPolicy - x-identifiers: - - RegistryId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1538,12 +1482,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/registry_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/registry_policies/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/registry_policy/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/registry_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1554,16 +1502,32 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'RegistryId') as registry_id, - json_extract_path_text(Properties, 'PolicyText') as policy_text - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ECR::RegistryPolicy' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.RegistryId') as registry_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ECR::RegistryPolicy' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'RegistryId') as registry_id, + json_extract_path_text(Properties, 'PolicyText') as policy_text + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ECR::RegistryPolicy' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'RegistryId') as registry_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ECR::RegistryPolicy' + AND region = 'us-east-1' replication_configurations: name: replication_configurations id: aws.ecr.replication_configurations @@ -1571,7 +1535,7 @@ components: x-cfn-type-name: AWS::ECR::ReplicationConfiguration x-identifiers: - RegistryId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1588,9 +1552,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1600,41 +1564,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/replication_configurations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/replication_configurations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.RegistryId') as registry_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ECR::ReplicationConfiguration' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'RegistryId') as registry_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ECR::ReplicationConfiguration' - AND region = 'us-east-1' - replication_configuration: - name: replication_configuration - id: aws.ecr.replication_configuration - x-cfn-schema-name: ReplicationConfiguration - x-cfn-type-name: AWS::ECR::ReplicationConfiguration - x-identifiers: - - RegistryId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1645,12 +1577,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/replication_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/replication_configurations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/replication_configuration/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/replication_configurations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1661,16 +1597,32 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ReplicationConfiguration') as replication_configuration, - json_extract_path_text(Properties, 'RegistryId') as registry_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ECR::ReplicationConfiguration' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.RegistryId') as registry_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ECR::ReplicationConfiguration' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ReplicationConfiguration') as replication_configuration, + json_extract_path_text(Properties, 'RegistryId') as registry_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ECR::ReplicationConfiguration' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'RegistryId') as registry_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ECR::ReplicationConfiguration' + AND region = 'us-east-1' repositories: name: repositories id: aws.ecr.repositories @@ -1678,7 +1630,7 @@ components: x-cfn-type-name: AWS::ECR::Repository x-identifiers: - RepositoryName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1695,9 +1647,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1707,41 +1659,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/repositories/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/repositories/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.RepositoryName') as repository_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ECR::Repository' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'RepositoryName') as repository_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ECR::Repository' - AND region = 'us-east-1' - repository: - name: repository - id: aws.ecr.repository - x-cfn-schema-name: Repository - x-cfn-type-name: AWS::ECR::Repository - x-identifiers: - - RepositoryName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1752,12 +1672,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/repositories/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/repositories/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/repository/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/repositories/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1776,24 +1700,40 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'EmptyOnDelete') as empty_on_delete, - json_extract_path_text(Properties, 'LifecyclePolicy') as lifecycle_policy, - json_extract_path_text(Properties, 'RepositoryName') as repository_name, - json_extract_path_text(Properties, 'RepositoryPolicyText') as repository_policy_text, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'RepositoryUri') as repository_uri, - json_extract_path_text(Properties, 'ImageTagMutability') as image_tag_mutability, - json_extract_path_text(Properties, 'ImageScanningConfiguration') as image_scanning_configuration, - json_extract_path_text(Properties, 'EncryptionConfiguration') as encryption_configuration - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ECR::Repository' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.RepositoryName') as repository_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ECR::Repository' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'EmptyOnDelete') as empty_on_delete, + json_extract_path_text(Properties, 'LifecyclePolicy') as lifecycle_policy, + json_extract_path_text(Properties, 'RepositoryName') as repository_name, + json_extract_path_text(Properties, 'RepositoryPolicyText') as repository_policy_text, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'RepositoryUri') as repository_uri, + json_extract_path_text(Properties, 'ImageTagMutability') as image_tag_mutability, + json_extract_path_text(Properties, 'ImageScanningConfiguration') as image_scanning_configuration, + json_extract_path_text(Properties, 'EncryptionConfiguration') as encryption_configuration + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ECR::Repository' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'RepositoryName') as repository_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ECR::Repository' + AND region = 'us-east-1' repository_creation_templates: name: repository_creation_templates id: aws.ecr.repository_creation_templates @@ -1801,7 +1741,7 @@ components: x-cfn-type-name: AWS::ECR::RepositoryCreationTemplate x-identifiers: - Prefix - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1818,9 +1758,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1830,41 +1770,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/repository_creation_templates/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/repository_creation_templates/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Prefix') as prefix - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ECR::RepositoryCreationTemplate' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Prefix') as prefix - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ECR::RepositoryCreationTemplate' - AND region = 'us-east-1' - repository_creation_template: - name: repository_creation_template - id: aws.ecr.repository_creation_template - x-cfn-schema-name: RepositoryCreationTemplate - x-cfn-type-name: AWS::ECR::RepositoryCreationTemplate - x-identifiers: - - Prefix - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1875,12 +1783,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/repository_creation_templates/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/repository_creation_templates/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/repository_creation_template/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/repository_creation_templates/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1899,24 +1811,40 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Prefix') as prefix, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'ImageTagMutability') as image_tag_mutability, - json_extract_path_text(Properties, 'RepositoryPolicy') as repository_policy, - json_extract_path_text(Properties, 'LifecyclePolicy') as lifecycle_policy, - json_extract_path_text(Properties, 'EncryptionConfiguration') as encryption_configuration, - json_extract_path_text(Properties, 'ResourceTags') as resource_tags, - json_extract_path_text(Properties, 'AppliedFor') as applied_for, - json_extract_path_text(Properties, 'CreatedAt') as created_at, - json_extract_path_text(Properties, 'UpdatedAt') as updated_at - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ECR::RepositoryCreationTemplate' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Prefix') as prefix + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ECR::RepositoryCreationTemplate' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Prefix') as prefix, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'ImageTagMutability') as image_tag_mutability, + json_extract_path_text(Properties, 'RepositoryPolicy') as repository_policy, + json_extract_path_text(Properties, 'LifecyclePolicy') as lifecycle_policy, + json_extract_path_text(Properties, 'EncryptionConfiguration') as encryption_configuration, + json_extract_path_text(Properties, 'ResourceTags') as resource_tags, + json_extract_path_text(Properties, 'AppliedFor') as applied_for, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'UpdatedAt') as updated_at + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ECR::RepositoryCreationTemplate' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Prefix') as prefix + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ECR::RepositoryCreationTemplate' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/ecs.yaml b/providers/src/aws/v00.00.00000/services/ecs.yaml index 23a06df9..1300e80d 100644 --- a/providers/src/aws/v00.00.00000/services/ecs.yaml +++ b/providers/src/aws/v00.00.00000/services/ecs.yaml @@ -1842,8 +1842,10 @@ components: properties: CredentialsParameter: type: string + description: '' Domain: type: string + description: '' additionalProperties: false description: '' FSxWindowsFileServerVolumeConfiguration: @@ -1854,12 +1856,17 @@ components: properties: FileSystemId: type: string + description: The Amazon FSx for Windows File Server file system ID to use. RootDirectory: type: string + description: The directory within the Amazon FSx for Windows File Server file system to mount as the root directory inside the host. AuthorizationConfig: $ref: '#/components/schemas/FSxAuthorizationConfig' + description: The authorization configuration details for the Amazon FSx for Windows File Server file system. additionalProperties: false - description: '' + description: |- + This parameter is specified when you're using [Amazon FSx for Windows File Server](https://docs.aws.amazon.com/fsx/latest/WindowsGuide/what-is.html) file system for task storage. + For more information and the input format, see [Amazon FSx for Windows File Server volumes](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/wfsx-volumes.html) in the *Amazon Elastic Container Service Developer Guide*. FirelensConfiguration: type: object properties: @@ -2268,7 +2275,7 @@ components: description: This parameter is specified when you use an Amazon Elastic File System file system for task storage. FSxWindowsFileServerVolumeConfiguration: $ref: '#/components/schemas/FSxWindowsFileServerVolumeConfiguration' - description: '' + description: This parameter is specified when you use Amazon FSx for Windows File Server file system for task storage. Host: $ref: '#/components/schemas/HostVolumeProperties' description: |- @@ -2414,9 +2421,7 @@ components: This parameter is only supported for tasks that are hosted on FARGATElong if the tasks are using platform version ``1.4.0`` or later (Linux). This isn't supported for Windows containers on Fargate. RuntimePlatform: $ref: '#/components/schemas/RuntimePlatform' - description: |- - The operating system that your tasks definitions run on. A platform family is specified only for tasks using the Fargate launch type. - When you specify a task definition in a service, this value must match the ``runtimePlatform`` value of the service. + description: The operating system that your tasks definitions run on. A platform family is specified only for tasks using the Fargate launch type. IpcMode: type: string description: >- @@ -2941,9 +2946,7 @@ components: This parameter is only supported for tasks that are hosted on FARGATElong if the tasks are using platform version ``1.4.0`` or later (Linux). This isn't supported for Windows containers on Fargate. RuntimePlatform: $ref: '#/components/schemas/RuntimePlatform' - description: |- - The operating system that your tasks definitions run on. A platform family is specified only for tasks using the Fargate launch type. - When you specify a task definition in a service, this value must match the ``runtimePlatform`` value of the service. + description: The operating system that your tasks definitions run on. A platform family is specified only for tasks using the Fargate launch type. IpcMode: type: string description: >- @@ -3048,8 +3051,23 @@ components: x-cfn-type-name: AWS::ECS::ClusterCapacityProviderAssociations x-identifiers: - Cluster - x-type: get + x-type: cloud_control methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ClusterCapacityProviderAssociations&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ECS::ClusterCapacityProviderAssociations" + } + response: + mediaType: application/json + openAPIDocKey: '200' update_resource: operation: $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' @@ -3062,13 +3080,29 @@ components: response: mediaType: application/json openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ECS::ClusterCapacityProviderAssociations" + } + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/cluster_capacity_provider_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/cluster_capacity_provider_associations/methods/delete_resource' update: - $ref: '#/components/x-stackQL-resources/cluster_capacity_provider_associations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3080,17 +3114,33 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'CapacityProviders') as capacity_providers, - json_extract_path_text(Properties, 'Cluster') as cluster, - json_extract_path_text(Properties, 'DefaultCapacityProviderStrategy') as default_capacity_provider_strategy - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ECS::ClusterCapacityProviderAssociations' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Cluster') as cluster + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ECS::ClusterCapacityProviderAssociations' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'CapacityProviders') as capacity_providers, + json_extract_path_text(Properties, 'Cluster') as cluster, + json_extract_path_text(Properties, 'DefaultCapacityProviderStrategy') as default_capacity_provider_strategy + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ECS::ClusterCapacityProviderAssociations' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Cluster') as cluster + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ECS::ClusterCapacityProviderAssociations' + AND region = 'us-east-1' primary_task_sets: name: primary_task_sets id: aws.ecs.primary_task_sets @@ -3099,7 +3149,7 @@ components: x-identifiers: - Cluster - Service - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3116,20 +3166,6 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/primary_task_sets/methods/create_resource' - delete: [] - primary_task_set: - name: primary_task_set - id: aws.ecs.primary_task_set - x-cfn-schema-name: PrimaryTaskSet - x-cfn-type-name: AWS::ECS::PrimaryTaskSet - x-identifiers: - - Cluster - - Service - x-type: get - methods: update_resource: operation: $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' @@ -3143,8 +3179,11 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/primary_task_sets/methods/create_resource' + delete: [] update: - - $ref: '#/components/x-stackQL-resources/primary_task_set/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/primary_task_sets/methods/update_resource' services: name: services id: aws.ecs.services @@ -3153,7 +3192,7 @@ components: x-identifiers: - ServiceArn - Cluster - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3170,9 +3209,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3182,44 +3221,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/services/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/services/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ServiceArn') as service_arn, - JSON_EXTRACT(Properties, '$.Cluster') as cluster - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ECS::Service' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ServiceArn') as service_arn, - json_extract_path_text(Properties, 'Cluster') as cluster - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ECS::Service' - AND region = 'us-east-1' - service: - name: service - id: aws.ecs.service - x-cfn-schema-name: Service - x-cfn-type-name: AWS::ECS::Service - x-identifiers: - - ServiceArn - - Cluster - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3230,12 +3234,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/services/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/services/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/service/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/services/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3269,39 +3277,57 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ServiceArn') as service_arn, - json_extract_path_text(Properties, 'CapacityProviderStrategy') as capacity_provider_strategy, - json_extract_path_text(Properties, 'Cluster') as cluster, - json_extract_path_text(Properties, 'DeploymentConfiguration') as deployment_configuration, - json_extract_path_text(Properties, 'DeploymentController') as deployment_controller, - json_extract_path_text(Properties, 'DesiredCount') as desired_count, - json_extract_path_text(Properties, 'EnableECSManagedTags') as enable_ecs_managed_tags, - json_extract_path_text(Properties, 'EnableExecuteCommand') as enable_execute_command, - json_extract_path_text(Properties, 'HealthCheckGracePeriodSeconds') as health_check_grace_period_seconds, - json_extract_path_text(Properties, 'LaunchType') as launch_type, - json_extract_path_text(Properties, 'LoadBalancers') as load_balancers, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'NetworkConfiguration') as network_configuration, - json_extract_path_text(Properties, 'PlacementConstraints') as placement_constraints, - json_extract_path_text(Properties, 'PlacementStrategies') as placement_strategies, - json_extract_path_text(Properties, 'PlatformVersion') as platform_version, - json_extract_path_text(Properties, 'PropagateTags') as propagate_tags, - json_extract_path_text(Properties, 'Role') as role, - json_extract_path_text(Properties, 'SchedulingStrategy') as scheduling_strategy, - json_extract_path_text(Properties, 'ServiceConnectConfiguration') as service_connect_configuration, - json_extract_path_text(Properties, 'ServiceName') as service_name, - json_extract_path_text(Properties, 'ServiceRegistries') as service_registries, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'TaskDefinition') as task_definition, - json_extract_path_text(Properties, 'VolumeConfigurations') as volume_configurations - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ECS::Service' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.ServiceArn') as service_arn, + JSON_EXTRACT(Properties, '$.Cluster') as cluster + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ECS::Service' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ServiceArn') as service_arn, + json_extract_path_text(Properties, 'CapacityProviderStrategy') as capacity_provider_strategy, + json_extract_path_text(Properties, 'Cluster') as cluster, + json_extract_path_text(Properties, 'DeploymentConfiguration') as deployment_configuration, + json_extract_path_text(Properties, 'DeploymentController') as deployment_controller, + json_extract_path_text(Properties, 'DesiredCount') as desired_count, + json_extract_path_text(Properties, 'EnableECSManagedTags') as enable_ecs_managed_tags, + json_extract_path_text(Properties, 'EnableExecuteCommand') as enable_execute_command, + json_extract_path_text(Properties, 'HealthCheckGracePeriodSeconds') as health_check_grace_period_seconds, + json_extract_path_text(Properties, 'LaunchType') as launch_type, + json_extract_path_text(Properties, 'LoadBalancers') as load_balancers, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'NetworkConfiguration') as network_configuration, + json_extract_path_text(Properties, 'PlacementConstraints') as placement_constraints, + json_extract_path_text(Properties, 'PlacementStrategies') as placement_strategies, + json_extract_path_text(Properties, 'PlatformVersion') as platform_version, + json_extract_path_text(Properties, 'PropagateTags') as propagate_tags, + json_extract_path_text(Properties, 'Role') as role, + json_extract_path_text(Properties, 'SchedulingStrategy') as scheduling_strategy, + json_extract_path_text(Properties, 'ServiceConnectConfiguration') as service_connect_configuration, + json_extract_path_text(Properties, 'ServiceName') as service_name, + json_extract_path_text(Properties, 'ServiceRegistries') as service_registries, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'TaskDefinition') as task_definition, + json_extract_path_text(Properties, 'VolumeConfigurations') as volume_configurations + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ECS::Service' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ServiceArn') as service_arn, + json_extract_path_text(Properties, 'Cluster') as cluster + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ECS::Service' + AND region = 'us-east-1' task_definitions: name: task_definitions id: aws.ecs.task_definitions @@ -3309,7 +3335,7 @@ components: x-cfn-type-name: AWS::ECS::TaskDefinition x-identifiers: - TaskDefinitionArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3326,9 +3352,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3338,41 +3364,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/task_definitions/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/task_definitions/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.TaskDefinitionArn') as task_definition_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ECS::TaskDefinition' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'TaskDefinitionArn') as task_definition_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ECS::TaskDefinition' - AND region = 'us-east-1' - task_definition: - name: task_definition - id: aws.ecs.task_definition - x-cfn-schema-name: TaskDefinition - x-cfn-type-name: AWS::ECS::TaskDefinition - x-identifiers: - - TaskDefinitionArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3383,12 +3377,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/task_definitions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/task_definitions/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/task_definition/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/task_definitions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3415,32 +3413,48 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'TaskDefinitionArn') as task_definition_arn, - json_extract_path_text(Properties, 'Family') as family, - json_extract_path_text(Properties, 'ContainerDefinitions') as container_definitions, - json_extract_path_text(Properties, 'Cpu') as cpu, - json_extract_path_text(Properties, 'ExecutionRoleArn') as execution_role_arn, - json_extract_path_text(Properties, 'EphemeralStorage') as ephemeral_storage, - json_extract_path_text(Properties, 'InferenceAccelerators') as inference_accelerators, - json_extract_path_text(Properties, 'Memory') as memory, - json_extract_path_text(Properties, 'NetworkMode') as network_mode, - json_extract_path_text(Properties, 'PlacementConstraints') as placement_constraints, - json_extract_path_text(Properties, 'ProxyConfiguration') as proxy_configuration, - json_extract_path_text(Properties, 'RequiresCompatibilities') as requires_compatibilities, - json_extract_path_text(Properties, 'TaskRoleArn') as task_role_arn, - json_extract_path_text(Properties, 'Volumes') as volumes, - json_extract_path_text(Properties, 'PidMode') as pid_mode, - json_extract_path_text(Properties, 'RuntimePlatform') as runtime_platform, - json_extract_path_text(Properties, 'IpcMode') as ipc_mode, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ECS::TaskDefinition' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.TaskDefinitionArn') as task_definition_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ECS::TaskDefinition' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'TaskDefinitionArn') as task_definition_arn, + json_extract_path_text(Properties, 'Family') as family, + json_extract_path_text(Properties, 'ContainerDefinitions') as container_definitions, + json_extract_path_text(Properties, 'Cpu') as cpu, + json_extract_path_text(Properties, 'ExecutionRoleArn') as execution_role_arn, + json_extract_path_text(Properties, 'EphemeralStorage') as ephemeral_storage, + json_extract_path_text(Properties, 'InferenceAccelerators') as inference_accelerators, + json_extract_path_text(Properties, 'Memory') as memory, + json_extract_path_text(Properties, 'NetworkMode') as network_mode, + json_extract_path_text(Properties, 'PlacementConstraints') as placement_constraints, + json_extract_path_text(Properties, 'ProxyConfiguration') as proxy_configuration, + json_extract_path_text(Properties, 'RequiresCompatibilities') as requires_compatibilities, + json_extract_path_text(Properties, 'TaskRoleArn') as task_role_arn, + json_extract_path_text(Properties, 'Volumes') as volumes, + json_extract_path_text(Properties, 'PidMode') as pid_mode, + json_extract_path_text(Properties, 'RuntimePlatform') as runtime_platform, + json_extract_path_text(Properties, 'IpcMode') as ipc_mode, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ECS::TaskDefinition' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'TaskDefinitionArn') as task_definition_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ECS::TaskDefinition' + AND region = 'us-east-1' task_sets: name: task_sets id: aws.ecs.task_sets @@ -3450,7 +3464,7 @@ components: - Cluster - Service - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3467,9 +3481,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3479,25 +3493,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/task_sets/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/task_sets/methods/delete_resource' - task_set: - name: task_set - id: aws.ecs.task_set - x-cfn-schema-name: TaskSet - x-cfn-type-name: AWS::ECS::TaskSet - x-identifiers: - - Cluster - - Service - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3508,12 +3506,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/task_sets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/task_sets/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/task_set/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/task_sets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3534,7 +3536,7 @@ components: AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, diff --git a/providers/src/aws/v00.00.00000/services/efs.yaml b/providers/src/aws/v00.00.00000/services/efs.yaml index 0fab1930..ddb3c502 100644 --- a/providers/src/aws/v00.00.00000/services/efs.yaml +++ b/providers/src/aws/v00.00.00000/services/efs.yaml @@ -1037,7 +1037,7 @@ components: x-cfn-type-name: AWS::EFS::AccessPoint x-identifiers: - AccessPointId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1054,9 +1054,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1066,41 +1066,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/access_points/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/access_points/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AccessPointId') as access_point_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EFS::AccessPoint' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AccessPointId') as access_point_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EFS::AccessPoint' - AND region = 'us-east-1' - access_point: - name: access_point - id: aws.efs.access_point - x-cfn-schema-name: AccessPoint - x-cfn-type-name: AWS::EFS::AccessPoint - x-identifiers: - - AccessPointId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1111,12 +1079,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/access_points/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/access_points/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/access_point/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/access_points/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1132,21 +1104,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AccessPointId') as access_point_id, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'ClientToken') as client_token, - json_extract_path_text(Properties, 'AccessPointTags') as access_point_tags, - json_extract_path_text(Properties, 'FileSystemId') as file_system_id, - json_extract_path_text(Properties, 'PosixUser') as posix_user, - json_extract_path_text(Properties, 'RootDirectory') as root_directory - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EFS::AccessPoint' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.AccessPointId') as access_point_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EFS::AccessPoint' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AccessPointId') as access_point_id, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'ClientToken') as client_token, + json_extract_path_text(Properties, 'AccessPointTags') as access_point_tags, + json_extract_path_text(Properties, 'FileSystemId') as file_system_id, + json_extract_path_text(Properties, 'PosixUser') as posix_user, + json_extract_path_text(Properties, 'RootDirectory') as root_directory + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EFS::AccessPoint' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AccessPointId') as access_point_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EFS::AccessPoint' + AND region = 'us-east-1' file_systems: name: file_systems id: aws.efs.file_systems @@ -1154,7 +1142,7 @@ components: x-cfn-type-name: AWS::EFS::FileSystem x-identifiers: - FileSystemId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1171,9 +1159,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1183,41 +1171,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/file_systems/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/file_systems/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.FileSystemId') as file_system_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EFS::FileSystem' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'FileSystemId') as file_system_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EFS::FileSystem' - AND region = 'us-east-1' - file_system: - name: file_system - id: aws.efs.file_system - x-cfn-schema-name: FileSystem - x-cfn-type-name: AWS::EFS::FileSystem - x-identifiers: - - FileSystemId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1228,12 +1184,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/file_systems/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/file_systems/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/file_system/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/file_systems/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1257,29 +1217,45 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'FileSystemId') as file_system_id, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Encrypted') as encrypted, - json_extract_path_text(Properties, 'FileSystemTags') as file_system_tags, - json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, - json_extract_path_text(Properties, 'LifecyclePolicies') as lifecycle_policies, - json_extract_path_text(Properties, 'FileSystemProtection') as file_system_protection, - json_extract_path_text(Properties, 'PerformanceMode') as performance_mode, - json_extract_path_text(Properties, 'ProvisionedThroughputInMibps') as provisioned_throughput_in_mibps, - json_extract_path_text(Properties, 'ThroughputMode') as throughput_mode, - json_extract_path_text(Properties, 'FileSystemPolicy') as file_system_policy, - json_extract_path_text(Properties, 'BypassPolicyLockoutSafetyCheck') as bypass_policy_lockout_safety_check, - json_extract_path_text(Properties, 'BackupPolicy') as backup_policy, - json_extract_path_text(Properties, 'AvailabilityZoneName') as availability_zone_name, - json_extract_path_text(Properties, 'ReplicationConfiguration') as replication_configuration - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EFS::FileSystem' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.FileSystemId') as file_system_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EFS::FileSystem' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'FileSystemId') as file_system_id, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Encrypted') as encrypted, + json_extract_path_text(Properties, 'FileSystemTags') as file_system_tags, + json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, + json_extract_path_text(Properties, 'LifecyclePolicies') as lifecycle_policies, + json_extract_path_text(Properties, 'FileSystemProtection') as file_system_protection, + json_extract_path_text(Properties, 'PerformanceMode') as performance_mode, + json_extract_path_text(Properties, 'ProvisionedThroughputInMibps') as provisioned_throughput_in_mibps, + json_extract_path_text(Properties, 'ThroughputMode') as throughput_mode, + json_extract_path_text(Properties, 'FileSystemPolicy') as file_system_policy, + json_extract_path_text(Properties, 'BypassPolicyLockoutSafetyCheck') as bypass_policy_lockout_safety_check, + json_extract_path_text(Properties, 'BackupPolicy') as backup_policy, + json_extract_path_text(Properties, 'AvailabilityZoneName') as availability_zone_name, + json_extract_path_text(Properties, 'ReplicationConfiguration') as replication_configuration + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EFS::FileSystem' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'FileSystemId') as file_system_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EFS::FileSystem' + AND region = 'us-east-1' mount_targets: name: mount_targets id: aws.efs.mount_targets @@ -1287,7 +1263,7 @@ components: x-cfn-type-name: AWS::EFS::MountTarget x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1304,9 +1280,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1316,41 +1292,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/mount_targets/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/mount_targets/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EFS::MountTarget' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EFS::MountTarget' - AND region = 'us-east-1' - mount_target: - name: mount_target - id: aws.efs.mount_target - x-cfn-schema-name: MountTarget - x-cfn-type-name: AWS::EFS::MountTarget - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1361,12 +1305,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/mount_targets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/mount_targets/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/mount_target/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/mount_targets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1380,19 +1328,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'IpAddress') as ip_address, - json_extract_path_text(Properties, 'FileSystemId') as file_system_id, - json_extract_path_text(Properties, 'SecurityGroups') as security_groups, - json_extract_path_text(Properties, 'SubnetId') as subnet_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EFS::MountTarget' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EFS::MountTarget' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'IpAddress') as ip_address, + json_extract_path_text(Properties, 'FileSystemId') as file_system_id, + json_extract_path_text(Properties, 'SecurityGroups') as security_groups, + json_extract_path_text(Properties, 'SubnetId') as subnet_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EFS::MountTarget' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EFS::MountTarget' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/eks.yaml b/providers/src/aws/v00.00.00000/services/eks.yaml index 2c721ab2..5cbfeabf 100644 --- a/providers/src/aws/v00.00.00000/services/eks.yaml +++ b/providers/src/aws/v00.00.00000/services/eks.yaml @@ -526,6 +526,86 @@ components: - eks:DescribeAccessEntry list: - eks:ListAccessEntries + PodIdentityAssociation: + type: object + properties: + ClusterName: + description: The cluster that the pod identity association is created for. + type: string + minLength: 1 + RoleArn: + description: The IAM role ARN that the pod identity association is created for. + type: string + Namespace: + description: The Kubernetes namespace that the pod identity association is created for. + type: string + ServiceAccount: + description: The Kubernetes service account that the pod identity association is created for. + type: string + AssociationArn: + description: The ARN of the pod identity association. + type: string + AssociationId: + description: The ID of the pod identity association. + type: string + minLength: 1 + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + required: + - ClusterName + - RoleArn + - Namespace + - ServiceAccount + x-stackql-resource-name: pod_identity_association + description: An object representing an Amazon EKS PodIdentityAssociation. + x-type-name: AWS::EKS::PodIdentityAssociation + x-stackql-primary-identifier: + - AssociationArn + x-create-only-properties: + - ClusterName + - Namespace + - ServiceAccount + x-read-only-properties: + - AssociationArn + - AssociationId + x-required-properties: + - ClusterName + - RoleArn + - Namespace + - ServiceAccount + x-replacement-strategy: create_then_delete + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + x-required-permissions: + create: + - eks:CreatePodIdentityAssociation + - eks:DescribePodIdentityAssociation + - eks:TagResource + - iam:PassRole + - iam:GetRole + read: + - eks:DescribePodIdentityAssociation + update: + - eks:DescribePodIdentityAssociation + - eks:UpdatePodIdentityAssociation + - eks:TagResource + - eks:UntagResource + - iam:PassRole + - iam:GetRole + delete: + - eks:DeletePodIdentityAssociation + - eks:DescribePodIdentityAssociation + list: + - eks:ListPodIdentityAssociations Addon: type: object properties: @@ -556,6 +636,13 @@ components: description: IAM role to bind to the add-on's service account type: string minLength: 1 + PodIdentityAssociations: + description: An array of pod identities to apply to this add-on. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/PodIdentityAssociation' ConfigurationValues: description: The configuration values to use with the add-on type: string @@ -585,6 +672,7 @@ components: x-write-only-properties: - ResolveConflicts - PreserveOnDelete + - PodIdentityAssociations x-read-only-properties: - Arn x-required-properties: @@ -602,113 +690,156 @@ components: - eks:DescribeAddon - eks:TagResource - iam:PassRole + - iam:GetRole + - eks:CreatePodIdentityAssociation read: - eks:DescribeAddon delete: - eks:DeleteAddon - eks:DescribeAddon + - eks:DeletePodIdentityAssociation list: - eks:ListAddons update: - iam:PassRole + - iam:GetRole - eks:UpdateAddon - eks:DescribeAddon - eks:DescribeUpdate - eks:ListTagsForResource - eks:TagResource - eks:UntagResource - Provider: + - eks:CreatePodIdentityAssociation + - eks:DeletePodIdentityAssociation + Logging: + description: Enable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs based on log types. By default, cluster control plane logs aren't exported to CloudWatch Logs. + additionalProperties: false type: object + properties: + ClusterLogging: + description: 'The cluster control plane logging configuration for your cluster. ' + $ref: '#/components/schemas/ClusterLogging' + EnabledTypes: + description: Enable control plane logs for your cluster, all log types will be disabled if the array is empty + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/LoggingTypeConfig' + ControlPlanePlacement: + description: Specify the placement group of the control plane machines for your cluster. additionalProperties: false + type: object properties: - KeyArn: - description: Amazon Resource Name (ARN) or alias of the KMS key. The KMS key must be symmetric, created in the same region as the cluster, and if the KMS key was created in a different account, the user must have access to the KMS key. + GroupName: + description: Specify the placement group name of the control place machines for your cluster. type: string + OutpostConfig: + description: An object representing the Outpost configuration to use for AWS EKS outpost cluster. + additionalProperties: false + type: object + properties: + OutpostArns: + description: Specify one or more Arn(s) of Outpost(s) on which you would like to create your cluster. + x-insertionOrder: false + type: array + items: + minItems: 1 + type: string + ControlPlanePlacement: + description: Specify the placement group of the control plane machines for your cluster. + $ref: '#/components/schemas/ControlPlanePlacement' + ControlPlaneInstanceType: + description: Specify the Instance type of the machines that should be used to create your cluster. + type: string + required: + - OutpostArns + - ControlPlaneInstanceType + AccessConfig: + description: An object representing the Access Config to use for the cluster. + additionalProperties: false + type: object + properties: + AuthenticationMode: + description: Specify the authentication mode that should be used to create your cluster. + type: string + enum: + - CONFIG_MAP + - API_AND_CONFIG_MAP + - API + BootstrapClusterCreatorAdminPermissions: + description: Set this value to false to avoid creating a default cluster admin Access Entry using the IAM principal used to create the cluster. + type: boolean EncryptionConfig: description: The encryption configuration for the cluster + additionalProperties: false type: object properties: - Provider: - description: The encryption provider for the cluster. - $ref: '#/components/schemas/Provider' Resources: description: Specifies the resources to be encrypted. The only supported value is "secrets". - type: array x-insertionOrder: false + type: array items: type: string + Provider: + description: The encryption provider for the cluster. + $ref: '#/components/schemas/Provider' + LoggingTypeConfig: + description: Enabled Logging Type additionalProperties: false + type: object + properties: + Type: + description: name of the log type + type: string + enum: + - api + - audit + - authenticator + - controllerManager + - scheduler ResourcesVpcConfig: description: An object representing the VPC configuration to use for an Amazon EKS cluster. - type: object additionalProperties: false + type: object properties: - EndpointPrivateAccess: - description: >- - Set this value to true to enable private access for your cluster's Kubernetes API server endpoint. If you enable private access, Kubernetes API requests from within your cluster's VPC use the private VPC endpoint. The default value for this parameter is false, which disables private access for your Kubernetes API server. If you disable private access and you have nodes or AWS Fargate pods in the cluster, then ensure that publicAccessCidrs includes the necessary CIDR blocks for - communication with the nodes or Fargate pods. - type: boolean EndpointPublicAccess: description: Set this value to false to disable public access to your cluster's Kubernetes API server endpoint. If you disable public access, your cluster's Kubernetes API server can only receive requests from within the cluster VPC. The default value for this parameter is true, which enables public access for your Kubernetes API server. type: boolean PublicAccessCidrs: description: The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint. Communication to the endpoint from addresses outside of the CIDR blocks that you specify is denied. The default value is 0.0.0.0/0. If you've disabled private endpoint access and you have nodes or AWS Fargate pods in the cluster, then ensure that you specify the necessary CIDR blocks. - type: array x-insertionOrder: false + type: array items: - type: string minItems: 1 + type: string + EndpointPrivateAccess: + description: >- + Set this value to true to enable private access for your cluster's Kubernetes API server endpoint. If you enable private access, Kubernetes API requests from within your cluster's VPC use the private VPC endpoint. The default value for this parameter is false, which disables private access for your Kubernetes API server. If you disable private access and you have nodes or AWS Fargate pods in the cluster, then ensure that publicAccessCidrs includes the necessary CIDR blocks for + communication with the nodes or Fargate pods. + type: boolean SecurityGroupIds: description: Specify one or more security groups for the cross-account elastic network interfaces that Amazon EKS creates to use to allow communication between your worker nodes and the Kubernetes control plane. If you don't specify a security group, the default security group for your VPC is used. - type: array x-insertionOrder: false + type: array items: - type: string minItems: 1 + type: string SubnetIds: description: Specify subnets for your Amazon EKS nodes. Amazon EKS creates cross-account elastic network interfaces in these subnets to allow communication between your nodes and the Kubernetes control plane. - type: array x-insertionOrder: false + type: array items: - type: string minItems: 1 + type: string required: - SubnetIds - LoggingTypeConfig: - description: Enabled Logging Type - type: object - properties: - Type: - description: name of the log type - type: string - enum: - - api - - audit - - authenticator - - controllerManager - - scheduler - additionalProperties: false - EnabledTypes: - description: Enable control plane logs for your cluster, all log types will be disabled if the array is empty - type: array - x-insertionOrder: false - items: - $ref: '#/components/schemas/LoggingTypeConfig' ClusterLogging: description: 'The cluster control plane logging configuration for your cluster. ' - type: object additionalProperties: false + type: object properties: EnabledTypes: $ref: '#/components/schemas/EnabledTypes' - Logging: - description: Enable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs based on log types. By default, cluster control plane logs aren't exported to CloudWatch Logs. - type: object - additionalProperties: false - properties: - ClusterLogging: - description: 'The cluster control plane logging configuration for your cluster. ' - $ref: '#/components/schemas/ClusterLogging' KubernetesNetworkConfig: description: The Kubernetes network configuration for the cluster. additionalProperties: false @@ -726,107 +857,70 @@ components: enum: - ipv4 - ipv6 - ControlPlanePlacement: - description: Specify the placement group of the control plane machines for your cluster. - type: object - additionalProperties: false - properties: - GroupName: - description: Specify the placement group name of the control place machines for your cluster. - type: string - OutpostConfig: - description: An object representing the Outpost configuration to use for AWS EKS outpost cluster. - additionalProperties: false - type: object - properties: - OutpostArns: - description: Specify one or more Arn(s) of Outpost(s) on which you would like to create your cluster. - type: array - x-insertionOrder: false - items: - type: string - minItems: 1 - ControlPlaneInstanceType: - description: Specify the Instance type of the machines that should be used to create your cluster. - type: string - ControlPlanePlacement: - description: Specify the placement group of the control plane machines for your cluster. - $ref: '#/components/schemas/ControlPlanePlacement' - required: - - OutpostArns - - ControlPlaneInstanceType - AccessConfig: - description: An object representing the Access Config to use for the cluster. + Provider: additionalProperties: false type: object properties: - BootstrapClusterCreatorAdminPermissions: - description: Set this value to false to avoid creating a default cluster admin Access Entry using the IAM principal used to create the cluster. - type: boolean - AuthenticationMode: - description: Specify the authentication mode that should be used to create your cluster. + KeyArn: + description: Amazon Resource Name (ARN) or alias of the KMS key. The KMS key must be symmetric, created in the same region as the cluster, and if the KMS key was created in a different account, the user must have access to the KMS key. type: string - enum: - - CONFIG_MAP - - API_AND_CONFIG_MAP - - API Cluster: type: object properties: + Logging: + $ref: '#/components/schemas/Logging' + EncryptionConfigKeyArn: + description: Amazon Resource Name (ARN) or alias of the customer master key (CMK). + type: string + AccessConfig: + $ref: '#/components/schemas/AccessConfig' + CertificateAuthorityData: + description: The certificate-authority-data for your cluster. + type: string EncryptionConfig: - type: array x-insertionOrder: false + type: array items: - $ref: '#/components/schemas/EncryptionConfig' maxItems: 1 + $ref: '#/components/schemas/EncryptionConfig' KubernetesNetworkConfig: $ref: '#/components/schemas/KubernetesNetworkConfig' - Logging: - $ref: '#/components/schemas/Logging' + RoleArn: + description: The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. + type: string Name: + minLength: 1 + pattern: ^[0-9A-Za-z][A-Za-z0-9\-_]* description: The unique name to give to your cluster. type: string - pattern: ^[0-9A-Za-z][A-Za-z0-9\-_]* - minLength: 1 maxLength: 100 + Endpoint: + description: The endpoint for your Kubernetes API server, such as https://5E1D0CEXAMPLEA591B746AFC5AB30262.yl4.us-west-2.eks.amazonaws.com. + type: string + Version: + pattern: 1\.\d\d + description: The desired Kubernetes version for your cluster. If you don't specify a value here, the latest version available in Amazon EKS is used. + type: string + ClusterSecurityGroupId: + description: The cluster security group that was created by Amazon EKS for the cluster. Managed node groups use this security group for control plane to data plane communication. + type: string Id: description: The unique ID given to your cluster. type: string - ResourcesVpcConfig: - $ref: '#/components/schemas/ResourcesVpcConfig' OutpostConfig: $ref: '#/components/schemas/OutpostConfig' - AccessConfig: - $ref: '#/components/schemas/AccessConfig' - RoleArn: - description: The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. - type: string - Version: - description: The desired Kubernetes version for your cluster. If you don't specify a value here, the latest version available in Amazon EKS is used. + Arn: + description: The ARN of the cluster, such as arn:aws:eks:us-west-2:666666666666:cluster/prod. type: string - pattern: 1\.\d\d + ResourcesVpcConfig: + $ref: '#/components/schemas/ResourcesVpcConfig' Tags: - description: An array of key-value pairs to apply to this resource. - type: array uniqueItems: true + description: An array of key-value pairs to apply to this resource. x-insertionOrder: false + type: array items: $ref: '#/components/schemas/Tag' - Arn: - description: The ARN of the cluster, such as arn:aws:eks:us-west-2:666666666666:cluster/prod. - type: string - Endpoint: - description: The endpoint for your Kubernetes API server, such as https://5E1D0CEXAMPLEA591B746AFC5AB30262.yl4.us-west-2.eks.amazonaws.com. - type: string - CertificateAuthorityData: - description: The certificate-authority-data for your cluster. - type: string - ClusterSecurityGroupId: - description: The cluster security group that was created by Amazon EKS for the cluster. Managed node groups use this security group for control plane to data plane communication. - type: string - EncryptionConfigKeyArn: - description: Amazon Resource Name (ARN) or alias of the customer master key (CMK). - type: string OpenIdConnectIssuerUrl: description: The issuer URL for the cluster's OIDC identity provider, such as https://oidc.eks.us-west-2.amazonaws.com/id/EXAMPLED539D4633E53DE1B716D3041E. If you need to remove https:// from this output value, you can include the following code in your template. type: string @@ -863,9 +957,11 @@ components: taggable: true tagOnCreate: true tagUpdatable: true - cloudFormationSystemTags: true tagProperty: /properties/Tags + cloudFormationSystemTags: true x-required-permissions: + read: + - eks:DescribeCluster create: - eks:CreateCluster - eks:DescribeCluster @@ -884,8 +980,6 @@ components: - ec2:DescribeVpcs - kms:DescribeKey - kms:CreateGrant - read: - - eks:DescribeCluster update: - iam:PassRole - eks:UpdateClusterConfig @@ -894,11 +988,11 @@ components: - eks:DescribeUpdate - eks:TagResource - eks:UntagResource + list: + - eks:ListClusters delete: - eks:DeleteCluster - eks:DescribeCluster - list: - - eks:ListClusters Selector: type: object additionalProperties: false @@ -1354,86 +1448,6 @@ components: - eks:UntagResource - eks:UpdateNodegroupConfig - eks:UpdateNodegroupVersion - PodIdentityAssociation: - type: object - properties: - ClusterName: - description: The cluster that the pod identity association is created for. - type: string - minLength: 1 - RoleArn: - description: The IAM role ARN that the pod identity association is created for. - type: string - Namespace: - description: The Kubernetes namespace that the pod identity association is created for. - type: string - ServiceAccount: - description: The Kubernetes service account that the pod identity association is created for. - type: string - AssociationArn: - description: The ARN of the pod identity association. - type: string - AssociationId: - description: The ID of the pod identity association. - type: string - minLength: 1 - Tags: - description: An array of key-value pairs to apply to this resource. - type: array - uniqueItems: true - x-insertionOrder: false - items: - $ref: '#/components/schemas/Tag' - required: - - ClusterName - - RoleArn - - Namespace - - ServiceAccount - x-stackql-resource-name: pod_identity_association - description: An object representing an Amazon EKS PodIdentityAssociation. - x-type-name: AWS::EKS::PodIdentityAssociation - x-stackql-primary-identifier: - - AssociationArn - x-create-only-properties: - - ClusterName - - Namespace - - ServiceAccount - x-read-only-properties: - - AssociationArn - - AssociationId - x-required-properties: - - ClusterName - - RoleArn - - Namespace - - ServiceAccount - x-replacement-strategy: create_then_delete - x-tagging: - taggable: true - tagOnCreate: true - tagUpdatable: true - cloudFormationSystemTags: true - tagProperty: /properties/Tags - x-required-permissions: - create: - - eks:CreatePodIdentityAssociation - - eks:DescribePodIdentityAssociation - - eks:TagResource - - iam:PassRole - - iam:GetRole - read: - - eks:DescribePodIdentityAssociation - update: - - eks:DescribePodIdentityAssociation - - eks:UpdatePodIdentityAssociation - - eks:TagResource - - eks:UntagResource - - iam:PassRole - - iam:GetRole - delete: - - eks:DeletePodIdentityAssociation - - eks:DescribePodIdentityAssociation - list: - - eks:ListPodIdentityAssociations CreateAccessEntryRequest: properties: ClientToken: @@ -1490,6 +1504,50 @@ components: x-title: CreateAccessEntryRequest type: object required: [] + CreatePodIdentityAssociationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ClusterName: + description: The cluster that the pod identity association is created for. + type: string + minLength: 1 + RoleArn: + description: The IAM role ARN that the pod identity association is created for. + type: string + Namespace: + description: The Kubernetes namespace that the pod identity association is created for. + type: string + ServiceAccount: + description: The Kubernetes service account that the pod identity association is created for. + type: string + AssociationArn: + description: The ARN of the pod identity association. + type: string + AssociationId: + description: The ID of the pod identity association. + type: string + minLength: 1 + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreatePodIdentityAssociationRequest + type: object + required: [] CreateAddonRequest: properties: ClientToken: @@ -1530,6 +1588,13 @@ components: description: IAM role to bind to the add-on's service account type: string minLength: 1 + PodIdentityAssociations: + description: An array of pod identities to apply to this add-on. + type: array + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/PodIdentityAssociation' ConfigurationValues: description: The configuration values to use with the add-on type: string @@ -1561,60 +1626,60 @@ components: DesiredState: type: object properties: - EncryptionConfig: - type: array - x-insertionOrder: false - items: - $ref: '#/components/schemas/EncryptionConfig' - maxItems: 1 - KubernetesNetworkConfig: - $ref: '#/components/schemas/KubernetesNetworkConfig' Logging: $ref: '#/components/schemas/Logging' - Name: - description: The unique name to give to your cluster. - type: string - pattern: ^[0-9A-Za-z][A-Za-z0-9\-_]* - minLength: 1 - maxLength: 100 - Id: - description: The unique ID given to your cluster. + EncryptionConfigKeyArn: + description: Amazon Resource Name (ARN) or alias of the customer master key (CMK). type: string - ResourcesVpcConfig: - $ref: '#/components/schemas/ResourcesVpcConfig' - OutpostConfig: - $ref: '#/components/schemas/OutpostConfig' AccessConfig: $ref: '#/components/schemas/AccessConfig' + CertificateAuthorityData: + description: The certificate-authority-data for your cluster. + type: string + EncryptionConfig: + x-insertionOrder: false + type: array + items: + maxItems: 1 + $ref: '#/components/schemas/EncryptionConfig' + KubernetesNetworkConfig: + $ref: '#/components/schemas/KubernetesNetworkConfig' RoleArn: description: The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. type: string - Version: - description: The desired Kubernetes version for your cluster. If you don't specify a value here, the latest version available in Amazon EKS is used. - type: string - pattern: 1\.\d\d - Tags: - description: An array of key-value pairs to apply to this resource. - type: array - uniqueItems: true - x-insertionOrder: false - items: - $ref: '#/components/schemas/Tag' - Arn: - description: The ARN of the cluster, such as arn:aws:eks:us-west-2:666666666666:cluster/prod. + Name: + minLength: 1 + pattern: ^[0-9A-Za-z][A-Za-z0-9\-_]* + description: The unique name to give to your cluster. type: string + maxLength: 100 Endpoint: description: The endpoint for your Kubernetes API server, such as https://5E1D0CEXAMPLEA591B746AFC5AB30262.yl4.us-west-2.eks.amazonaws.com. type: string - CertificateAuthorityData: - description: The certificate-authority-data for your cluster. + Version: + pattern: 1\.\d\d + description: The desired Kubernetes version for your cluster. If you don't specify a value here, the latest version available in Amazon EKS is used. type: string ClusterSecurityGroupId: description: The cluster security group that was created by Amazon EKS for the cluster. Managed node groups use this security group for control plane to data plane communication. type: string - EncryptionConfigKeyArn: - description: Amazon Resource Name (ARN) or alias of the customer master key (CMK). + Id: + description: The unique ID given to your cluster. + type: string + OutpostConfig: + $ref: '#/components/schemas/OutpostConfig' + Arn: + description: The ARN of the cluster, such as arn:aws:eks:us-west-2:666666666666:cluster/prod. type: string + ResourcesVpcConfig: + $ref: '#/components/schemas/ResourcesVpcConfig' + Tags: + uniqueItems: true + description: An array of key-value pairs to apply to this resource. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Tag' OpenIdConnectIssuerUrl: description: The issuer URL for the cluster's OIDC identity provider, such as https://oidc.eks.us-west-2.amazonaws.com/id/EXAMPLED539D4633E53DE1B716D3041E. If you need to remove https:// from this output value, you can include the following code in your template. type: string @@ -1805,50 +1870,6 @@ components: x-title: CreateNodegroupRequest type: object required: [] - CreatePodIdentityAssociationRequest: - properties: - ClientToken: - type: string - RoleArn: - type: string - TypeName: - type: string - TypeVersionId: - type: string - DesiredState: - type: object - properties: - ClusterName: - description: The cluster that the pod identity association is created for. - type: string - minLength: 1 - RoleArn: - description: The IAM role ARN that the pod identity association is created for. - type: string - Namespace: - description: The Kubernetes namespace that the pod identity association is created for. - type: string - ServiceAccount: - description: The Kubernetes service account that the pod identity association is created for. - type: string - AssociationArn: - description: The ARN of the pod identity association. - type: string - AssociationId: - description: The ID of the pod identity association. - type: string - minLength: 1 - Tags: - description: An array of key-value pairs to apply to this resource. - type: array - uniqueItems: true - x-insertionOrder: false - items: - $ref: '#/components/schemas/Tag' - x-stackQL-stringOnly: true - x-title: CreatePodIdentityAssociationRequest - type: object - required: [] securitySchemes: hmac: type: apiKey @@ -1865,7 +1886,7 @@ components: x-identifiers: - PrincipalArn - ClusterName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1882,9 +1903,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1894,44 +1915,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/access_entries/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/access_entries/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.PrincipalArn') as principal_arn, - JSON_EXTRACT(Properties, '$.ClusterName') as cluster_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EKS::AccessEntry' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'PrincipalArn') as principal_arn, - json_extract_path_text(Properties, 'ClusterName') as cluster_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EKS::AccessEntry' - AND region = 'us-east-1' - access_entry: - name: access_entry - id: aws.eks.access_entry - x-cfn-schema-name: AccessEntry - x-cfn-type-name: AWS::EKS::AccessEntry - x-identifiers: - - PrincipalArn - - ClusterName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1942,12 +1928,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/access_entries/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/access_entries/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/access_entry/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/access_entries/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1964,43 +1954,72 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ClusterName') as cluster_name, - json_extract_path_text(Properties, 'PrincipalArn') as principal_arn, - json_extract_path_text(Properties, 'Username') as username, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'AccessEntryArn') as access_entry_arn, - json_extract_path_text(Properties, 'KubernetesGroups') as kubernetes_groups, - json_extract_path_text(Properties, 'AccessPolicies') as access_policies, - json_extract_path_text(Properties, 'Type') as type - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EKS::AccessEntry' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.PrincipalArn') as principal_arn, + JSON_EXTRACT(Properties, '$.ClusterName') as cluster_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EKS::AccessEntry' AND region = 'us-east-1' - addons: - name: addons - id: aws.eks.addons - x-cfn-schema-name: Addon - x-cfn-type-name: AWS::EKS::Addon + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ClusterName') as cluster_name, + json_extract_path_text(Properties, 'PrincipalArn') as principal_arn, + json_extract_path_text(Properties, 'Username') as username, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'AccessEntryArn') as access_entry_arn, + json_extract_path_text(Properties, 'KubernetesGroups') as kubernetes_groups, + json_extract_path_text(Properties, 'AccessPolicies') as access_policies, + json_extract_path_text(Properties, 'Type') as type + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EKS::AccessEntry' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'PrincipalArn') as principal_arn, + json_extract_path_text(Properties, 'ClusterName') as cluster_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EKS::AccessEntry' + AND region = 'us-east-1' + pod_identity_associations: + name: pod_identity_associations + id: aws.eks.pod_identity_associations + x-cfn-schema-name: PodIdentityAssociation + x-cfn-type-name: AWS::EKS::PodIdentityAssociation x-identifiers: - - ClusterName - - AddonName - x-type: list + - AssociationArn + x-type: cloud_control methods: create_resource: config: requestBodyTranslate: algorithm: naive_DesiredState operation: - $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Addon&__detailTransformed=true/post' + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__PodIdentityAssociation&__detailTransformed=true/post' request: mediaType: application/x-amz-json-1.0 base: |- { - "TypeName": "AWS::EKS::Addon" + "TypeName": "AWS::EKS::PodIdentityAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EKS::PodIdentityAssociation" } response: mediaType: application/json @@ -2012,46 +2031,93 @@ components: mediaType: application/x-amz-json-1.0 base: |- { - "TypeName": "AWS::EKS::Addon" + "TypeName": "AWS::EKS::PodIdentityAssociation" } response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: insert: - - $ref: '#/components/x-stackQL-resources/addons/methods/create_resource' + - $ref: '#/components/x-stackQL-resources/pod_identity_associations/methods/create_resource' delete: - - $ref: '#/components/x-stackQL-resources/addons/methods/delete_resource' + - $ref: '#/components/x-stackQL-resources/pod_identity_associations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/pod_identity_associations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, + data__Identifier, JSON_EXTRACT(Properties, '$.ClusterName') as cluster_name, - JSON_EXTRACT(Properties, '$.AddonName') as addon_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EKS::Addon' + JSON_EXTRACT(Properties, '$.RoleArn') as role_arn, + JSON_EXTRACT(Properties, '$.Namespace') as namespace, + JSON_EXTRACT(Properties, '$.ServiceAccount') as service_account, + JSON_EXTRACT(Properties, '$.AssociationArn') as association_arn, + JSON_EXTRACT(Properties, '$.AssociationId') as association_id, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EKS::PodIdentityAssociation' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ClusterName') as cluster_name, - json_extract_path_text(Properties, 'AddonName') as addon_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EKS::Addon' + JSON_EXTRACT(Properties, '$.AssociationArn') as association_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EKS::PodIdentityAssociation' AND region = 'us-east-1' - addon: - name: addon - id: aws.eks.addon + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ClusterName') as cluster_name, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'Namespace') as namespace, + json_extract_path_text(Properties, 'ServiceAccount') as service_account, + json_extract_path_text(Properties, 'AssociationArn') as association_arn, + json_extract_path_text(Properties, 'AssociationId') as association_id, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EKS::PodIdentityAssociation' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AssociationArn') as association_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EKS::PodIdentityAssociation' + AND region = 'us-east-1' + addons: + name: addons + id: aws.eks.addons x-cfn-schema-name: Addon x-cfn-type-name: AWS::EKS::Addon x-identifiers: - ClusterName - AddonName - x-type: get + x-type: cloud_control methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Addon&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EKS::Addon" + } + response: + mediaType: application/json + openAPIDocKey: '200' update_resource: operation: $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' @@ -2064,13 +2130,29 @@ components: response: mediaType: application/json openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::EKS::Addon" + } + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/addons/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/addons/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/addon/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/addons/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2081,6 +2163,7 @@ components: JSON_EXTRACT(Properties, '$.PreserveOnDelete') as preserve_on_delete, JSON_EXTRACT(Properties, '$.ResolveConflicts') as resolve_conflicts, JSON_EXTRACT(Properties, '$.ServiceAccountRoleArn') as service_account_role_arn, + JSON_EXTRACT(Properties, '$.PodIdentityAssociations') as pod_identity_associations, JSON_EXTRACT(Properties, '$.ConfigurationValues') as configuration_values, JSON_EXTRACT(Properties, '$.Arn') as arn, JSON_EXTRACT(Properties, '$.Tags') as tags @@ -2088,23 +2171,42 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ClusterName') as cluster_name, - json_extract_path_text(Properties, 'AddonName') as addon_name, - json_extract_path_text(Properties, 'AddonVersion') as addon_version, - json_extract_path_text(Properties, 'PreserveOnDelete') as preserve_on_delete, - json_extract_path_text(Properties, 'ResolveConflicts') as resolve_conflicts, - json_extract_path_text(Properties, 'ServiceAccountRoleArn') as service_account_role_arn, - json_extract_path_text(Properties, 'ConfigurationValues') as configuration_values, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EKS::Addon' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.ClusterName') as cluster_name, + JSON_EXTRACT(Properties, '$.AddonName') as addon_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EKS::Addon' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ClusterName') as cluster_name, + json_extract_path_text(Properties, 'AddonName') as addon_name, + json_extract_path_text(Properties, 'AddonVersion') as addon_version, + json_extract_path_text(Properties, 'PreserveOnDelete') as preserve_on_delete, + json_extract_path_text(Properties, 'ResolveConflicts') as resolve_conflicts, + json_extract_path_text(Properties, 'ServiceAccountRoleArn') as service_account_role_arn, + json_extract_path_text(Properties, 'PodIdentityAssociations') as pod_identity_associations, + json_extract_path_text(Properties, 'ConfigurationValues') as configuration_values, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EKS::Addon' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ClusterName') as cluster_name, + json_extract_path_text(Properties, 'AddonName') as addon_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EKS::Addon' + AND region = 'us-east-1' clusters: name: clusters id: aws.eks.clusters @@ -2112,7 +2214,7 @@ components: x-cfn-type-name: AWS::EKS::Cluster x-identifiers: - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2129,9 +2231,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2141,41 +2243,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/clusters/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/clusters/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EKS::Cluster' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EKS::Cluster' - AND region = 'us-east-1' - cluster: - name: cluster - id: aws.eks.cluster - x-cfn-schema-name: Cluster - x-cfn-type-name: AWS::EKS::Cluster - x-identifiers: - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2186,62 +2256,82 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/clusters/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/clusters/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/cluster/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/clusters/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.EncryptionConfig') as encryption_config, - JSON_EXTRACT(Properties, '$.KubernetesNetworkConfig') as kubernetes_network_config, JSON_EXTRACT(Properties, '$.Logging') as logging, - JSON_EXTRACT(Properties, '$.Name') as name, - JSON_EXTRACT(Properties, '$.Id') as id, - JSON_EXTRACT(Properties, '$.ResourcesVpcConfig') as resources_vpc_config, - JSON_EXTRACT(Properties, '$.OutpostConfig') as outpost_config, + JSON_EXTRACT(Properties, '$.EncryptionConfigKeyArn') as encryption_config_key_arn, JSON_EXTRACT(Properties, '$.AccessConfig') as access_config, - JSON_EXTRACT(Properties, '$.RoleArn') as role_arn, - JSON_EXTRACT(Properties, '$.Version') as version, - JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.CertificateAuthorityData') as certificate_authority_data, + JSON_EXTRACT(Properties, '$.EncryptionConfig') as encryption_config, + JSON_EXTRACT(Properties, '$.KubernetesNetworkConfig') as kubernetes_network_config, + JSON_EXTRACT(Properties, '$.RoleArn') as role_arn, + JSON_EXTRACT(Properties, '$.Name') as name, JSON_EXTRACT(Properties, '$.Endpoint') as endpoint, - JSON_EXTRACT(Properties, '$.CertificateAuthorityData') as certificate_authority_data, + JSON_EXTRACT(Properties, '$.Version') as version, JSON_EXTRACT(Properties, '$.ClusterSecurityGroupId') as cluster_security_group_id, - JSON_EXTRACT(Properties, '$.EncryptionConfigKeyArn') as encryption_config_key_arn, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.OutpostConfig') as outpost_config, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.ResourcesVpcConfig') as resources_vpc_config, + JSON_EXTRACT(Properties, '$.Tags') as tags, JSON_EXTRACT(Properties, '$.OpenIdConnectIssuerUrl') as open_id_connect_issuer_url FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EKS::Cluster' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'EncryptionConfig') as encryption_config, - json_extract_path_text(Properties, 'KubernetesNetworkConfig') as kubernetes_network_config, - json_extract_path_text(Properties, 'Logging') as logging, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'ResourcesVpcConfig') as resources_vpc_config, - json_extract_path_text(Properties, 'OutpostConfig') as outpost_config, - json_extract_path_text(Properties, 'AccessConfig') as access_config, - json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'Version') as version, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Endpoint') as endpoint, - json_extract_path_text(Properties, 'CertificateAuthorityData') as certificate_authority_data, - json_extract_path_text(Properties, 'ClusterSecurityGroupId') as cluster_security_group_id, - json_extract_path_text(Properties, 'EncryptionConfigKeyArn') as encryption_config_key_arn, - json_extract_path_text(Properties, 'OpenIdConnectIssuerUrl') as open_id_connect_issuer_url - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EKS::Cluster' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EKS::Cluster' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Logging') as logging, + json_extract_path_text(Properties, 'EncryptionConfigKeyArn') as encryption_config_key_arn, + json_extract_path_text(Properties, 'AccessConfig') as access_config, + json_extract_path_text(Properties, 'CertificateAuthorityData') as certificate_authority_data, + json_extract_path_text(Properties, 'EncryptionConfig') as encryption_config, + json_extract_path_text(Properties, 'KubernetesNetworkConfig') as kubernetes_network_config, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Endpoint') as endpoint, + json_extract_path_text(Properties, 'Version') as version, + json_extract_path_text(Properties, 'ClusterSecurityGroupId') as cluster_security_group_id, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'OutpostConfig') as outpost_config, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'ResourcesVpcConfig') as resources_vpc_config, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'OpenIdConnectIssuerUrl') as open_id_connect_issuer_url + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EKS::Cluster' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EKS::Cluster' + AND region = 'us-east-1' fargate_profiles: name: fargate_profiles id: aws.eks.fargate_profiles @@ -2250,7 +2340,7 @@ components: x-identifiers: - ClusterName - FargateProfileName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2267,9 +2357,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2279,44 +2369,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/fargate_profiles/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/fargate_profiles/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ClusterName') as cluster_name, - JSON_EXTRACT(Properties, '$.FargateProfileName') as fargate_profile_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EKS::FargateProfile' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ClusterName') as cluster_name, - json_extract_path_text(Properties, 'FargateProfileName') as fargate_profile_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EKS::FargateProfile' - AND region = 'us-east-1' - fargate_profile: - name: fargate_profile - id: aws.eks.fargate_profile - x-cfn-schema-name: FargateProfile - x-cfn-type-name: AWS::EKS::FargateProfile - x-identifiers: - - ClusterName - - FargateProfileName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2327,12 +2382,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/fargate_profiles/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/fargate_profiles/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/fargate_profile/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/fargate_profiles/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2348,21 +2407,39 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ClusterName') as cluster_name, - json_extract_path_text(Properties, 'FargateProfileName') as fargate_profile_name, - json_extract_path_text(Properties, 'PodExecutionRoleArn') as pod_execution_role_arn, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Subnets') as subnets, - json_extract_path_text(Properties, 'Selectors') as selectors, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EKS::FargateProfile' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.ClusterName') as cluster_name, + JSON_EXTRACT(Properties, '$.FargateProfileName') as fargate_profile_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EKS::FargateProfile' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ClusterName') as cluster_name, + json_extract_path_text(Properties, 'FargateProfileName') as fargate_profile_name, + json_extract_path_text(Properties, 'PodExecutionRoleArn') as pod_execution_role_arn, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Subnets') as subnets, + json_extract_path_text(Properties, 'Selectors') as selectors, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EKS::FargateProfile' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ClusterName') as cluster_name, + json_extract_path_text(Properties, 'FargateProfileName') as fargate_profile_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EKS::FargateProfile' + AND region = 'us-east-1' identity_provider_configs: name: identity_provider_configs id: aws.eks.identity_provider_configs @@ -2372,7 +2449,7 @@ components: - IdentityProviderConfigName - ClusterName - Type - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2389,9 +2466,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2401,47 +2478,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/identity_provider_configs/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/identity_provider_configs/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.IdentityProviderConfigName') as identity_provider_config_name, - JSON_EXTRACT(Properties, '$.ClusterName') as cluster_name, - JSON_EXTRACT(Properties, '$.Type') as type - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EKS::IdentityProviderConfig' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'IdentityProviderConfigName') as identity_provider_config_name, - json_extract_path_text(Properties, 'ClusterName') as cluster_name, - json_extract_path_text(Properties, 'Type') as type - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EKS::IdentityProviderConfig' - AND region = 'us-east-1' - identity_provider_config: - name: identity_provider_config - id: aws.eks.identity_provider_config - x-cfn-schema-name: IdentityProviderConfig - x-cfn-type-name: AWS::EKS::IdentityProviderConfig - x-identifiers: - - IdentityProviderConfigName - - ClusterName - - Type - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2452,12 +2491,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/identity_provider_configs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/identity_provider_configs/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/identity_provider_config/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/identity_provider_configs/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2472,20 +2515,40 @@ components: AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ClusterName') as cluster_name, - json_extract_path_text(Properties, 'Type') as type, - json_extract_path_text(Properties, 'IdentityProviderConfigName') as identity_provider_config_name, - json_extract_path_text(Properties, 'Oidc') as oidc, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'IdentityProviderConfigArn') as identity_provider_config_arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EKS::IdentityProviderConfig' - AND data__Identifier = '||' + JSON_EXTRACT(Properties, '$.IdentityProviderConfigName') as identity_provider_config_name, + JSON_EXTRACT(Properties, '$.ClusterName') as cluster_name, + JSON_EXTRACT(Properties, '$.Type') as type + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EKS::IdentityProviderConfig' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ClusterName') as cluster_name, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'IdentityProviderConfigName') as identity_provider_config_name, + json_extract_path_text(Properties, 'Oidc') as oidc, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'IdentityProviderConfigArn') as identity_provider_config_arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EKS::IdentityProviderConfig' + AND data__Identifier = '||' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'IdentityProviderConfigName') as identity_provider_config_name, + json_extract_path_text(Properties, 'ClusterName') as cluster_name, + json_extract_path_text(Properties, 'Type') as type + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EKS::IdentityProviderConfig' + AND region = 'us-east-1' nodegroups: name: nodegroups id: aws.eks.nodegroups @@ -2493,7 +2556,7 @@ components: x-cfn-type-name: AWS::EKS::Nodegroup x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2510,9 +2573,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2522,41 +2585,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/nodegroups/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/nodegroups/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EKS::Nodegroup' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EKS::Nodegroup' - AND region = 'us-east-1' - nodegroup: - name: nodegroup - id: aws.eks.nodegroup - x-cfn-schema-name: Nodegroup - x-cfn-type-name: AWS::EKS::Nodegroup - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2567,12 +2598,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/nodegroups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/nodegroups/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/nodegroup/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/nodegroups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2601,151 +2636,50 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - data__Identifier, - json_extract_path_text(Properties, 'AmiType') as ami_type, - json_extract_path_text(Properties, 'CapacityType') as capacity_type, - json_extract_path_text(Properties, 'ClusterName') as cluster_name, - json_extract_path_text(Properties, 'DiskSize') as disk_size, - json_extract_path_text(Properties, 'ForceUpdateEnabled') as force_update_enabled, - json_extract_path_text(Properties, 'InstanceTypes') as instance_types, - json_extract_path_text(Properties, 'Labels') as labels, - json_extract_path_text(Properties, 'LaunchTemplate') as launch_template, - json_extract_path_text(Properties, 'NodegroupName') as nodegroup_name, - json_extract_path_text(Properties, 'NodeRole') as node_role, - json_extract_path_text(Properties, 'ReleaseVersion') as release_version, - json_extract_path_text(Properties, 'RemoteAccess') as remote_access, - json_extract_path_text(Properties, 'ScalingConfig') as scaling_config, - json_extract_path_text(Properties, 'Subnets') as subnets, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Taints') as taints, - json_extract_path_text(Properties, 'UpdateConfig') as update_config, - json_extract_path_text(Properties, 'Version') as version, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EKS::Nodegroup' - AND data__Identifier = '' - AND region = 'us-east-1' - pod_identity_associations: - name: pod_identity_associations - id: aws.eks.pod_identity_associations - x-cfn-schema-name: PodIdentityAssociation - x-cfn-type-name: AWS::EKS::PodIdentityAssociation - x-identifiers: - - AssociationArn - x-type: list - methods: - create_resource: - config: - requestBodyTranslate: - algorithm: naive_DesiredState - operation: - $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__PodIdentityAssociation&__detailTransformed=true/post' - request: - mediaType: application/x-amz-json-1.0 - base: |- - { - "TypeName": "AWS::EKS::PodIdentityAssociation" - } - response: - mediaType: application/json - openAPIDocKey: '200' - delete_resource: - operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' - request: - mediaType: application/x-amz-json-1.0 - base: |- - { - "TypeName": "AWS::EKS::PodIdentityAssociation" - } - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/pod_identity_associations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/pod_identity_associations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AssociationArn') as association_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EKS::PodIdentityAssociation' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AssociationArn') as association_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EKS::PodIdentityAssociation' - AND region = 'us-east-1' - pod_identity_association: - name: pod_identity_association - id: aws.eks.pod_identity_association - x-cfn-schema-name: PodIdentityAssociation - x-cfn-type-name: AWS::EKS::PodIdentityAssociation - x-identifiers: - - AssociationArn - x-type: get - methods: - update_resource: - operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' - request: - mediaType: application/x-amz-json-1.0 - base: |- - { - "TypeName": "AWS::EKS::PodIdentityAssociation" - } - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - update: - - $ref: '#/components/x-stackQL-resources/pod_identity_association/methods/update_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - data__Identifier, - JSON_EXTRACT(Properties, '$.ClusterName') as cluster_name, - JSON_EXTRACT(Properties, '$.RoleArn') as role_arn, - JSON_EXTRACT(Properties, '$.Namespace') as namespace, - JSON_EXTRACT(Properties, '$.ServiceAccount') as service_account, - JSON_EXTRACT(Properties, '$.AssociationArn') as association_arn, - JSON_EXTRACT(Properties, '$.AssociationId') as association_id, - JSON_EXTRACT(Properties, '$.Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EKS::PodIdentityAssociation' - AND data__Identifier = '' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ClusterName') as cluster_name, - json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'Namespace') as namespace, - json_extract_path_text(Properties, 'ServiceAccount') as service_account, - json_extract_path_text(Properties, 'AssociationArn') as association_arn, - json_extract_path_text(Properties, 'AssociationId') as association_id, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EKS::PodIdentityAssociation' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EKS::Nodegroup' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AmiType') as ami_type, + json_extract_path_text(Properties, 'CapacityType') as capacity_type, + json_extract_path_text(Properties, 'ClusterName') as cluster_name, + json_extract_path_text(Properties, 'DiskSize') as disk_size, + json_extract_path_text(Properties, 'ForceUpdateEnabled') as force_update_enabled, + json_extract_path_text(Properties, 'InstanceTypes') as instance_types, + json_extract_path_text(Properties, 'Labels') as labels, + json_extract_path_text(Properties, 'LaunchTemplate') as launch_template, + json_extract_path_text(Properties, 'NodegroupName') as nodegroup_name, + json_extract_path_text(Properties, 'NodeRole') as node_role, + json_extract_path_text(Properties, 'ReleaseVersion') as release_version, + json_extract_path_text(Properties, 'RemoteAccess') as remote_access, + json_extract_path_text(Properties, 'ScalingConfig') as scaling_config, + json_extract_path_text(Properties, 'Subnets') as subnets, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Taints') as taints, + json_extract_path_text(Properties, 'UpdateConfig') as update_config, + json_extract_path_text(Properties, 'Version') as version, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EKS::Nodegroup' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EKS::Nodegroup' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: @@ -2931,7 +2865,7 @@ paths: schema: $ref: '#/components/x-cloud-control-schemas/ProgressEvent' description: Success - /?Action=CreateResource&Version=2021-09-30&__Addon&__detailTransformed=true: + /?Action=CreateResource&Version=2021-09-30&__PodIdentityAssociation&__detailTransformed=true: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' @@ -2941,7 +2875,7 @@ paths: - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: - operationId: CreateAddon + operationId: CreatePodIdentityAssociation parameters: - description: Action Header in: header @@ -2964,7 +2898,7 @@ paths: content: application/x-amz-json-1.0: schema: - $ref: '#/components/schemas/CreateAddonRequest' + $ref: '#/components/schemas/CreatePodIdentityAssociationRequest' required: true responses: '200': @@ -2973,7 +2907,7 @@ paths: schema: $ref: '#/components/x-cloud-control-schemas/ProgressEvent' description: Success - /?Action=CreateResource&Version=2021-09-30&__Cluster&__detailTransformed=true: + /?Action=CreateResource&Version=2021-09-30&__Addon&__detailTransformed=true: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' @@ -2983,7 +2917,7 @@ paths: - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: - operationId: CreateCluster + operationId: CreateAddon parameters: - description: Action Header in: header @@ -3006,7 +2940,7 @@ paths: content: application/x-amz-json-1.0: schema: - $ref: '#/components/schemas/CreateClusterRequest' + $ref: '#/components/schemas/CreateAddonRequest' required: true responses: '200': @@ -3015,7 +2949,7 @@ paths: schema: $ref: '#/components/x-cloud-control-schemas/ProgressEvent' description: Success - /?Action=CreateResource&Version=2021-09-30&__FargateProfile&__detailTransformed=true: + /?Action=CreateResource&Version=2021-09-30&__Cluster&__detailTransformed=true: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' @@ -3025,7 +2959,7 @@ paths: - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: - operationId: CreateFargateProfile + operationId: CreateCluster parameters: - description: Action Header in: header @@ -3048,7 +2982,7 @@ paths: content: application/x-amz-json-1.0: schema: - $ref: '#/components/schemas/CreateFargateProfileRequest' + $ref: '#/components/schemas/CreateClusterRequest' required: true responses: '200': @@ -3057,7 +2991,7 @@ paths: schema: $ref: '#/components/x-cloud-control-schemas/ProgressEvent' description: Success - /?Action=CreateResource&Version=2021-09-30&__IdentityProviderConfig&__detailTransformed=true: + /?Action=CreateResource&Version=2021-09-30&__FargateProfile&__detailTransformed=true: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' @@ -3067,7 +3001,7 @@ paths: - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: - operationId: CreateIdentityProviderConfig + operationId: CreateFargateProfile parameters: - description: Action Header in: header @@ -3090,7 +3024,7 @@ paths: content: application/x-amz-json-1.0: schema: - $ref: '#/components/schemas/CreateIdentityProviderConfigRequest' + $ref: '#/components/schemas/CreateFargateProfileRequest' required: true responses: '200': @@ -3099,7 +3033,7 @@ paths: schema: $ref: '#/components/x-cloud-control-schemas/ProgressEvent' description: Success - /?Action=CreateResource&Version=2021-09-30&__Nodegroup&__detailTransformed=true: + /?Action=CreateResource&Version=2021-09-30&__IdentityProviderConfig&__detailTransformed=true: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' @@ -3109,7 +3043,7 @@ paths: - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: - operationId: CreateNodegroup + operationId: CreateIdentityProviderConfig parameters: - description: Action Header in: header @@ -3132,7 +3066,7 @@ paths: content: application/x-amz-json-1.0: schema: - $ref: '#/components/schemas/CreateNodegroupRequest' + $ref: '#/components/schemas/CreateIdentityProviderConfigRequest' required: true responses: '200': @@ -3141,7 +3075,7 @@ paths: schema: $ref: '#/components/x-cloud-control-schemas/ProgressEvent' description: Success - /?Action=CreateResource&Version=2021-09-30&__PodIdentityAssociation&__detailTransformed=true: + /?Action=CreateResource&Version=2021-09-30&__Nodegroup&__detailTransformed=true: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' @@ -3151,7 +3085,7 @@ paths: - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: - operationId: CreatePodIdentityAssociation + operationId: CreateNodegroup parameters: - description: Action Header in: header @@ -3174,7 +3108,7 @@ paths: content: application/x-amz-json-1.0: schema: - $ref: '#/components/schemas/CreatePodIdentityAssociationRequest' + $ref: '#/components/schemas/CreateNodegroupRequest' required: true responses: '200': diff --git a/providers/src/aws/v00.00.00000/services/elasticache.yaml b/providers/src/aws/v00.00.00000/services/elasticache.yaml index eb70dbaa..cdd3c3d8 100644 --- a/providers/src/aws/v00.00.00000/services/elasticache.yaml +++ b/providers/src/aws/v00.00.00000/services/elasticache.yaml @@ -512,6 +512,94 @@ components: - elasticache:DescribeGlobalReplicationGroups list: - elasticache:DescribeGlobalReplicationGroups + Tag: + description: A key-value pair to associate with a resource. + type: object + additionalProperties: false + properties: + Key: + description: 'The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with ''aws:''. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' + type: string + pattern: ^(?!aws:)[a-zA-Z0-9 _\.\/=+:\-@]*$ + minLength: 1 + maxLength: 128 + Value: + description: 'The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' + type: string + pattern: ^[a-zA-Z0-9 _\.\/=+:\-@]*$ + minLength: 0 + maxLength: 256 + required: + - Key + ParameterGroup: + type: object + properties: + Description: + type: string + description: The description for this cache parameter group. + Properties: + type: object + additionalProperties: false + x-patternProperties: + '[a-zA-Z0-9]+': + type: string + description: A comma-delimited list of parameter name/value pairs. For more information see ModifyCacheParameterGroup in the Amazon ElastiCache API Reference Guide. + Tags: + type: array + description: Tags are composed of a Key/Value pair. You can use tags to categorize and track each parameter group. The tag value null is permitted. + items: + $ref: '#/components/schemas/Tag' + x-insertionOrder: false + uniqueItems: false + CacheParameterGroupName: + type: string + description: The name of the Cache Parameter Group. + CacheParameterGroupFamily: + type: string + description: The name of the cache parameter group family that this cache parameter group is compatible with. + required: + - Description + - CacheParameterGroupFamily + x-stackql-resource-name: parameter_group + description: Resource Type definition for AWS::ElastiCache::ParameterGroup + x-type-name: AWS::ElastiCache::ParameterGroup + x-stackql-primary-identifier: + - CacheParameterGroupName + x-create-only-properties: + - CacheParameterGroupFamily + x-read-only-properties: + - CacheParameterGroupName + x-required-properties: + - Description + - CacheParameterGroupFamily + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + x-required-permissions: + create: + - ElastiCache:CreateCacheParameterGroup + - ElastiCache:DescribeCacheParameterGroups + - ElastiCache:AddTagsToResource + - ElastiCache:ModifyCacheParameterGroup + read: + - ElastiCache:DescribeCacheParameterGroups + - ElastiCache:DescribeCacheParameters + - ElastiCache:ListTagsForResource + update: + - ElastiCache:ModifyCacheParameterGroup + - ElastiCache:DescribeCacheParameterGroups + - ElastiCache:DescribeCacheParameters + - ElastiCache:DescribeEngineDefaultParameters + - ElastiCache:AddTagsToResource + - ElastiCache:RemoveTagsFromResource + delete: + - ElastiCache:DescribeCacheParameterGroups + - ElastiCache:DeleteCacheParameterGroup + list: + - ElastiCache:DescribeCacheParameterGroups CacheUsageLimits: description: The cache capacity limit of the Serverless Cache. type: object @@ -550,25 +638,6 @@ components: description: The maximum ECPU per second of the Serverless Cache. type: integer additionalProperties: false - Tag: - description: A key-value pair to associate with a resource. - type: object - additionalProperties: false - properties: - Key: - description: 'The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with ''aws:''. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' - type: string - pattern: ^(?!aws:)[a-zA-Z0-9 _\.\/=+:\-@]*$ - minLength: 1 - maxLength: 128 - Value: - description: 'The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' - type: string - pattern: ^[a-zA-Z0-9 _\.\/=+:\-@]*$ - minLength: 0 - maxLength: 256 - required: - - Key Endpoint: description: The address and the port. type: object @@ -1034,6 +1103,46 @@ components: x-title: CreateGlobalReplicationGroupRequest type: object required: [] + CreateParameterGroupRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Description: + type: string + description: The description for this cache parameter group. + Properties: + type: object + additionalProperties: false + x-patternProperties: + '[a-zA-Z0-9]+': + type: string + description: A comma-delimited list of parameter name/value pairs. For more information see ModifyCacheParameterGroup in the Amazon ElastiCache API Reference Guide. + Tags: + type: array + description: Tags are composed of a Key/Value pair. You can use tags to categorize and track each parameter group. The tag value null is permitted. + items: + $ref: '#/components/schemas/Tag' + x-insertionOrder: false + uniqueItems: false + CacheParameterGroupName: + type: string + description: The name of the Cache Parameter Group. + CacheParameterGroupFamily: + type: string + description: The name of the cache parameter group family that this cache parameter group is compatible with. + x-stackQL-stringOnly: true + x-title: CreateParameterGroupRequest + type: object + required: [] CreateServerlessCacheRequest: properties: ClientToken: @@ -1301,7 +1410,7 @@ components: x-cfn-type-name: AWS::ElastiCache::GlobalReplicationGroup x-identifiers: - GlobalReplicationGroupId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1318,9 +1427,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1330,41 +1439,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/global_replication_groups/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/global_replication_groups/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.GlobalReplicationGroupId') as global_replication_group_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ElastiCache::GlobalReplicationGroup' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'GlobalReplicationGroupId') as global_replication_group_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ElastiCache::GlobalReplicationGroup' - AND region = 'us-east-1' - global_replication_group: - name: global_replication_group - id: aws.elasticache.global_replication_group - x-cfn-schema-name: GlobalReplicationGroup - x-cfn-type-name: AWS::ElastiCache::GlobalReplicationGroup - x-identifiers: - - GlobalReplicationGroupId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1375,12 +1452,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/global_replication_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/global_replication_groups/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/global_replication_group/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/global_replication_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1400,45 +1481,73 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'GlobalReplicationGroupIdSuffix') as global_replication_group_id_suffix, - json_extract_path_text(Properties, 'AutomaticFailoverEnabled') as automatic_failover_enabled, - json_extract_path_text(Properties, 'CacheNodeType') as cache_node_type, - json_extract_path_text(Properties, 'EngineVersion') as engine_version, - json_extract_path_text(Properties, 'CacheParameterGroupName') as cache_parameter_group_name, - json_extract_path_text(Properties, 'GlobalNodeGroupCount') as global_node_group_count, - json_extract_path_text(Properties, 'GlobalReplicationGroupDescription') as global_replication_group_description, - json_extract_path_text(Properties, 'GlobalReplicationGroupId') as global_replication_group_id, - json_extract_path_text(Properties, 'Members') as members, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'RegionalConfigurations') as regional_configurations - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ElastiCache::GlobalReplicationGroup' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.GlobalReplicationGroupId') as global_replication_group_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ElastiCache::GlobalReplicationGroup' AND region = 'us-east-1' - serverless_caches: - name: serverless_caches - id: aws.elasticache.serverless_caches - x-cfn-schema-name: ServerlessCache - x-cfn-type-name: AWS::ElastiCache::ServerlessCache + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'GlobalReplicationGroupIdSuffix') as global_replication_group_id_suffix, + json_extract_path_text(Properties, 'AutomaticFailoverEnabled') as automatic_failover_enabled, + json_extract_path_text(Properties, 'CacheNodeType') as cache_node_type, + json_extract_path_text(Properties, 'EngineVersion') as engine_version, + json_extract_path_text(Properties, 'CacheParameterGroupName') as cache_parameter_group_name, + json_extract_path_text(Properties, 'GlobalNodeGroupCount') as global_node_group_count, + json_extract_path_text(Properties, 'GlobalReplicationGroupDescription') as global_replication_group_description, + json_extract_path_text(Properties, 'GlobalReplicationGroupId') as global_replication_group_id, + json_extract_path_text(Properties, 'Members') as members, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'RegionalConfigurations') as regional_configurations + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ElastiCache::GlobalReplicationGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'GlobalReplicationGroupId') as global_replication_group_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ElastiCache::GlobalReplicationGroup' + AND region = 'us-east-1' + parameter_groups: + name: parameter_groups + id: aws.elasticache.parameter_groups + x-cfn-schema-name: ParameterGroup + x-cfn-type-name: AWS::ElastiCache::ParameterGroup x-identifiers: - - ServerlessCacheName - x-type: list + - CacheParameterGroupName + x-type: cloud_control methods: create_resource: config: requestBodyTranslate: algorithm: naive_DesiredState operation: - $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ServerlessCache&__detailTransformed=true/post' + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ParameterGroup&__detailTransformed=true/post' request: mediaType: application/x-amz-json-1.0 base: |- { - "TypeName": "AWS::ElastiCache::ServerlessCache" + "TypeName": "AWS::ElastiCache::ParameterGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ElastiCache::ParameterGroup" } response: mediaType: application/json @@ -1450,43 +1559,88 @@ components: mediaType: application/x-amz-json-1.0 base: |- { - "TypeName": "AWS::ElastiCache::ServerlessCache" + "TypeName": "AWS::ElastiCache::ParameterGroup" } response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: insert: - - $ref: '#/components/x-stackQL-resources/serverless_caches/methods/create_resource' + - $ref: '#/components/x-stackQL-resources/parameter_groups/methods/create_resource' delete: - - $ref: '#/components/x-stackQL-resources/serverless_caches/methods/delete_resource' + - $ref: '#/components/x-stackQL-resources/parameter_groups/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/parameter_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ServerlessCacheName') as serverless_cache_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ElastiCache::ServerlessCache' + data__Identifier, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.Properties') as properties, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.CacheParameterGroupName') as cache_parameter_group_name, + JSON_EXTRACT(Properties, '$.CacheParameterGroupFamily') as cache_parameter_group_family + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ElastiCache::ParameterGroup' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ServerlessCacheName') as serverless_cache_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ElastiCache::ServerlessCache' + JSON_EXTRACT(Properties, '$.CacheParameterGroupName') as cache_parameter_group_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ElastiCache::ParameterGroup' AND region = 'us-east-1' - serverless_cache: - name: serverless_cache - id: aws.elasticache.serverless_cache + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Properties') as properties, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'CacheParameterGroupName') as cache_parameter_group_name, + json_extract_path_text(Properties, 'CacheParameterGroupFamily') as cache_parameter_group_family + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ElastiCache::ParameterGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'CacheParameterGroupName') as cache_parameter_group_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ElastiCache::ParameterGroup' + AND region = 'us-east-1' + serverless_caches: + name: serverless_caches + id: aws.elasticache.serverless_caches x-cfn-schema-name: ServerlessCache x-cfn-type-name: AWS::ElastiCache::ServerlessCache x-identifiers: - ServerlessCacheName - x-type: get + x-type: cloud_control methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ServerlessCache&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ElastiCache::ServerlessCache" + } + response: + mediaType: application/json + openAPIDocKey: '200' update_resource: operation: $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' @@ -1499,13 +1653,29 @@ components: response: mediaType: application/json openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::ElastiCache::ServerlessCache" + } + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/serverless_caches/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/serverless_caches/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/serverless_cache/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/serverless_caches/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1534,34 +1704,50 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ServerlessCacheName') as serverless_cache_name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Engine') as engine, - json_extract_path_text(Properties, 'MajorEngineVersion') as major_engine_version, - json_extract_path_text(Properties, 'FullEngineVersion') as full_engine_version, - json_extract_path_text(Properties, 'CacheUsageLimits') as cache_usage_limits, - json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, - json_extract_path_text(Properties, 'SecurityGroupIds') as security_group_ids, - json_extract_path_text(Properties, 'SnapshotArnsToRestore') as snapshot_arns_to_restore, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'UserGroupId') as user_group_id, - json_extract_path_text(Properties, 'SubnetIds') as subnet_ids, - json_extract_path_text(Properties, 'SnapshotRetentionLimit') as snapshot_retention_limit, - json_extract_path_text(Properties, 'DailySnapshotTime') as daily_snapshot_time, - json_extract_path_text(Properties, 'CreateTime') as create_time, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'Endpoint') as endpoint, - json_extract_path_text(Properties, 'ReaderEndpoint') as reader_endpoint, - json_extract_path_text(Properties, 'ARN') as arn, - json_extract_path_text(Properties, 'FinalSnapshotName') as final_snapshot_name - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ElastiCache::ServerlessCache' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ServerlessCacheName') as serverless_cache_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ElastiCache::ServerlessCache' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ServerlessCacheName') as serverless_cache_name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Engine') as engine, + json_extract_path_text(Properties, 'MajorEngineVersion') as major_engine_version, + json_extract_path_text(Properties, 'FullEngineVersion') as full_engine_version, + json_extract_path_text(Properties, 'CacheUsageLimits') as cache_usage_limits, + json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, + json_extract_path_text(Properties, 'SecurityGroupIds') as security_group_ids, + json_extract_path_text(Properties, 'SnapshotArnsToRestore') as snapshot_arns_to_restore, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'UserGroupId') as user_group_id, + json_extract_path_text(Properties, 'SubnetIds') as subnet_ids, + json_extract_path_text(Properties, 'SnapshotRetentionLimit') as snapshot_retention_limit, + json_extract_path_text(Properties, 'DailySnapshotTime') as daily_snapshot_time, + json_extract_path_text(Properties, 'CreateTime') as create_time, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'Endpoint') as endpoint, + json_extract_path_text(Properties, 'ReaderEndpoint') as reader_endpoint, + json_extract_path_text(Properties, 'ARN') as arn, + json_extract_path_text(Properties, 'FinalSnapshotName') as final_snapshot_name + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ElastiCache::ServerlessCache' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ServerlessCacheName') as serverless_cache_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ElastiCache::ServerlessCache' + AND region = 'us-east-1' subnet_groups: name: subnet_groups id: aws.elasticache.subnet_groups @@ -1569,7 +1755,7 @@ components: x-cfn-type-name: AWS::ElastiCache::SubnetGroup x-identifiers: - CacheSubnetGroupName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1586,9 +1772,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1598,41 +1784,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/subnet_groups/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/subnet_groups/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.CacheSubnetGroupName') as cache_subnet_group_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ElastiCache::SubnetGroup' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'CacheSubnetGroupName') as cache_subnet_group_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ElastiCache::SubnetGroup' - AND region = 'us-east-1' - subnet_group: - name: subnet_group - id: aws.elasticache.subnet_group - x-cfn-schema-name: SubnetGroup - x-cfn-type-name: AWS::ElastiCache::SubnetGroup - x-identifiers: - - CacheSubnetGroupName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1643,12 +1797,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/subnet_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/subnet_groups/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/subnet_group/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/subnet_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1661,18 +1819,34 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'SubnetIds') as subnet_ids, - json_extract_path_text(Properties, 'CacheSubnetGroupName') as cache_subnet_group_name, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ElastiCache::SubnetGroup' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.CacheSubnetGroupName') as cache_subnet_group_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ElastiCache::SubnetGroup' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'SubnetIds') as subnet_ids, + json_extract_path_text(Properties, 'CacheSubnetGroupName') as cache_subnet_group_name, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ElastiCache::SubnetGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'CacheSubnetGroupName') as cache_subnet_group_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ElastiCache::SubnetGroup' + AND region = 'us-east-1' users: name: users id: aws.elasticache.users @@ -1680,7 +1854,7 @@ components: x-cfn-type-name: AWS::ElastiCache::User x-identifiers: - UserId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1697,9 +1871,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1709,41 +1883,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/users/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/users/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.UserId') as user_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ElastiCache::User' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'UserId') as user_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ElastiCache::User' - AND region = 'us-east-1' - user: - name: user - id: aws.elasticache.user - x-cfn-schema-name: User - x-cfn-type-name: AWS::ElastiCache::User - x-identifiers: - - UserId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1754,12 +1896,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/users/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/users/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/user/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/users/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1778,24 +1924,40 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'UserId') as user_id, - json_extract_path_text(Properties, 'UserName') as user_name, - json_extract_path_text(Properties, 'Engine') as engine, - json_extract_path_text(Properties, 'AccessString') as access_string, - json_extract_path_text(Properties, 'NoPasswordRequired') as no_password_required, - json_extract_path_text(Properties, 'Passwords') as passwords, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'AuthenticationMode') as authentication_mode, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ElastiCache::User' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.UserId') as user_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ElastiCache::User' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'UserId') as user_id, + json_extract_path_text(Properties, 'UserName') as user_name, + json_extract_path_text(Properties, 'Engine') as engine, + json_extract_path_text(Properties, 'AccessString') as access_string, + json_extract_path_text(Properties, 'NoPasswordRequired') as no_password_required, + json_extract_path_text(Properties, 'Passwords') as passwords, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'AuthenticationMode') as authentication_mode, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ElastiCache::User' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'UserId') as user_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ElastiCache::User' + AND region = 'us-east-1' user_groups: name: user_groups id: aws.elasticache.user_groups @@ -1803,7 +1965,7 @@ components: x-cfn-type-name: AWS::ElastiCache::UserGroup x-identifiers: - UserGroupId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1820,9 +1982,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1832,41 +1994,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/user_groups/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/user_groups/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.UserGroupId') as user_group_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ElastiCache::UserGroup' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'UserGroupId') as user_group_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ElastiCache::UserGroup' - AND region = 'us-east-1' - user_group: - name: user_group - id: aws.elasticache.user_group - x-cfn-schema-name: UserGroup - x-cfn-type-name: AWS::ElastiCache::UserGroup - x-identifiers: - - UserGroupId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1877,12 +2007,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/user_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/user_groups/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/user_group/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/user_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1897,20 +2031,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'UserGroupId') as user_group_id, - json_extract_path_text(Properties, 'Engine') as engine, - json_extract_path_text(Properties, 'UserIds') as user_ids, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ElastiCache::UserGroup' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.UserGroupId') as user_group_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ElastiCache::UserGroup' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'UserGroupId') as user_group_id, + json_extract_path_text(Properties, 'Engine') as engine, + json_extract_path_text(Properties, 'UserIds') as user_ids, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ElastiCache::UserGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'UserGroupId') as user_group_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ElastiCache::UserGroup' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: @@ -2096,6 +2246,48 @@ paths: schema: $ref: '#/components/x-cloud-control-schemas/ProgressEvent' description: Success + /?Action=CreateResource&Version=2021-09-30&__ParameterGroup&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateParameterGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateParameterGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success /?Action=CreateResource&Version=2021-09-30&__ServerlessCache&__detailTransformed=true: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' diff --git a/providers/src/aws/v00.00.00000/services/elasticbeanstalk.yaml b/providers/src/aws/v00.00.00000/services/elasticbeanstalk.yaml index d5c3fd02..4dea387f 100644 --- a/providers/src/aws/v00.00.00000/services/elasticbeanstalk.yaml +++ b/providers/src/aws/v00.00.00000/services/elasticbeanstalk.yaml @@ -980,7 +980,7 @@ components: x-cfn-type-name: AWS::ElasticBeanstalk::Application x-identifiers: - ApplicationName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -997,9 +997,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1009,41 +1009,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/applications/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/applications/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ApplicationName') as application_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticBeanstalk::Application' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ApplicationName') as application_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticBeanstalk::Application' - AND region = 'us-east-1' - application: - name: application - id: aws.elasticbeanstalk.application - x-cfn-schema-name: Application - x-cfn-type-name: AWS::ElasticBeanstalk::Application - x-identifiers: - - ApplicationName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1054,12 +1022,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/applications/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/applications/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/application/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/applications/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1071,17 +1043,33 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ApplicationName') as application_name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'ResourceLifecycleConfig') as resource_lifecycle_config - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ElasticBeanstalk::Application' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ApplicationName') as application_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticBeanstalk::Application' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ApplicationName') as application_name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'ResourceLifecycleConfig') as resource_lifecycle_config + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ElasticBeanstalk::Application' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ApplicationName') as application_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticBeanstalk::Application' + AND region = 'us-east-1' application_versions: name: application_versions id: aws.elasticbeanstalk.application_versions @@ -1090,7 +1078,7 @@ components: x-identifiers: - ApplicationName - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1107,9 +1095,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1119,44 +1107,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/application_versions/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/application_versions/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ApplicationName') as application_name, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticBeanstalk::ApplicationVersion' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ApplicationName') as application_name, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticBeanstalk::ApplicationVersion' - AND region = 'us-east-1' - application_version: - name: application_version - id: aws.elasticbeanstalk.application_version - x-cfn-schema-name: ApplicationVersion - x-cfn-type-name: AWS::ElasticBeanstalk::ApplicationVersion - x-identifiers: - - ApplicationName - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1167,12 +1120,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/application_versions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/application_versions/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/application_version/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/application_versions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1185,18 +1142,36 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'ApplicationName') as application_name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'SourceBundle') as source_bundle - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ElasticBeanstalk::ApplicationVersion' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.ApplicationName') as application_name, + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticBeanstalk::ApplicationVersion' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'ApplicationName') as application_name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'SourceBundle') as source_bundle + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ElasticBeanstalk::ApplicationVersion' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ApplicationName') as application_name, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticBeanstalk::ApplicationVersion' + AND region = 'us-east-1' configuration_templates: name: configuration_templates id: aws.elasticbeanstalk.configuration_templates @@ -1205,7 +1180,7 @@ components: x-identifiers: - ApplicationName - TemplateName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1222,9 +1197,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1234,44 +1209,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/configuration_templates/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/configuration_templates/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ApplicationName') as application_name, - JSON_EXTRACT(Properties, '$.TemplateName') as template_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticBeanstalk::ConfigurationTemplate' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ApplicationName') as application_name, - json_extract_path_text(Properties, 'TemplateName') as template_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticBeanstalk::ConfigurationTemplate' - AND region = 'us-east-1' - configuration_template: - name: configuration_template - id: aws.elasticbeanstalk.configuration_template - x-cfn-schema-name: ConfigurationTemplate - x-cfn-type-name: AWS::ElasticBeanstalk::ConfigurationTemplate - x-identifiers: - - ApplicationName - - TemplateName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1282,12 +1222,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/configuration_templates/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/configuration_templates/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/configuration_template/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/configuration_templates/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1304,22 +1248,40 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ApplicationName') as application_name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'EnvironmentId') as environment_id, - json_extract_path_text(Properties, 'OptionSettings') as option_settings, - json_extract_path_text(Properties, 'PlatformArn') as platform_arn, - json_extract_path_text(Properties, 'SolutionStackName') as solution_stack_name, - json_extract_path_text(Properties, 'SourceConfiguration') as source_configuration, - json_extract_path_text(Properties, 'TemplateName') as template_name - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ElasticBeanstalk::ConfigurationTemplate' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.ApplicationName') as application_name, + JSON_EXTRACT(Properties, '$.TemplateName') as template_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticBeanstalk::ConfigurationTemplate' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ApplicationName') as application_name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'EnvironmentId') as environment_id, + json_extract_path_text(Properties, 'OptionSettings') as option_settings, + json_extract_path_text(Properties, 'PlatformArn') as platform_arn, + json_extract_path_text(Properties, 'SolutionStackName') as solution_stack_name, + json_extract_path_text(Properties, 'SourceConfiguration') as source_configuration, + json_extract_path_text(Properties, 'TemplateName') as template_name + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ElasticBeanstalk::ConfigurationTemplate' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ApplicationName') as application_name, + json_extract_path_text(Properties, 'TemplateName') as template_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticBeanstalk::ConfigurationTemplate' + AND region = 'us-east-1' environments: name: environments id: aws.elasticbeanstalk.environments @@ -1327,7 +1289,7 @@ components: x-cfn-type-name: AWS::ElasticBeanstalk::Environment x-identifiers: - EnvironmentName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1344,9 +1306,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1356,41 +1318,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/environments/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/environments/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.EnvironmentName') as environment_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticBeanstalk::Environment' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'EnvironmentName') as environment_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticBeanstalk::Environment' - AND region = 'us-east-1' - environment: - name: environment - id: aws.elasticbeanstalk.environment - x-cfn-schema-name: Environment - x-cfn-type-name: AWS::ElasticBeanstalk::Environment - x-identifiers: - - EnvironmentName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1401,12 +1331,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/environments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/environments/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/environment/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/environments/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1428,27 +1362,43 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'PlatformArn') as platform_arn, - json_extract_path_text(Properties, 'ApplicationName') as application_name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'EnvironmentName') as environment_name, - json_extract_path_text(Properties, 'OperationsRole') as operations_role, - json_extract_path_text(Properties, 'Tier') as tier, - json_extract_path_text(Properties, 'VersionLabel') as version_label, - json_extract_path_text(Properties, 'EndpointURL') as endpoint_url, - json_extract_path_text(Properties, 'OptionSettings') as option_settings, - json_extract_path_text(Properties, 'TemplateName') as template_name, - json_extract_path_text(Properties, 'SolutionStackName') as solution_stack_name, - json_extract_path_text(Properties, 'CNAMEPrefix') as cname_prefix, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ElasticBeanstalk::Environment' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.EnvironmentName') as environment_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticBeanstalk::Environment' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'PlatformArn') as platform_arn, + json_extract_path_text(Properties, 'ApplicationName') as application_name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'EnvironmentName') as environment_name, + json_extract_path_text(Properties, 'OperationsRole') as operations_role, + json_extract_path_text(Properties, 'Tier') as tier, + json_extract_path_text(Properties, 'VersionLabel') as version_label, + json_extract_path_text(Properties, 'EndpointURL') as endpoint_url, + json_extract_path_text(Properties, 'OptionSettings') as option_settings, + json_extract_path_text(Properties, 'TemplateName') as template_name, + json_extract_path_text(Properties, 'SolutionStackName') as solution_stack_name, + json_extract_path_text(Properties, 'CNAMEPrefix') as cname_prefix, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ElasticBeanstalk::Environment' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'EnvironmentName') as environment_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticBeanstalk::Environment' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/elasticloadbalancingv2.yaml b/providers/src/aws/v00.00.00000/services/elasticloadbalancingv2.yaml index 99f0f8b9..1ceaef48 100644 --- a/providers/src/aws/v00.00.00000/services/elasticloadbalancingv2.yaml +++ b/providers/src/aws/v00.00.00000/services/elasticloadbalancingv2.yaml @@ -386,19 +386,19 @@ components: type: object schemas: MutualAuthentication: - type: object + description: Specifies the configuration information for mutual authentication. additionalProperties: false + type: object properties: + IgnoreClientCertificateExpiry: + description: Indicates whether expired client certificates are ignored. + type: boolean Mode: - type: string description: The client certificate handling method. Options are ``off``, ``passthrough`` or ``verify``. The default value is ``off``. - TrustStoreArn: type: string + TrustStoreArn: description: The Amazon Resource Name (ARN) of the trust store. - IgnoreClientCertificateExpiry: - type: boolean - description: Indicates whether expired client certificates are ignored. - description: Specifies the configuration information for mutual authentication. + type: string FixedResponseConfig: type: object additionalProperties: false @@ -621,58 +621,65 @@ components: - AuthorizationEndpoint description: Specifies information required using an identity provide (IdP) that is compliant with OpenID Connect (OIDC) to authenticate users. Certificate: - type: object + description: Specifies an SSL server certificate to use as the default certificate for a secure listener. additionalProperties: false + type: object properties: CertificateArn: - type: string + anyOf: + - relationshipRef: + typeName: AWS::CertificateManager::Certificate + propertyPath: /properties/Id + - relationshipRef: + typeName: AWS::IAM::ServerCertificate + propertyPath: /properties/Arn description: The Amazon Resource Name (ARN) of the certificate. - description: Specifies an SSL server certificate to use as the default certificate for a secure listener. + type: string Listener: type: object properties: - SslPolicy: + ListenerArn: + description: '' type: string + MutualAuthentication: + description: The mutual authentication configuration information. + $ref: '#/components/schemas/MutualAuthentication' + AlpnPolicy: + description: '[TLS listener] The name of the Application-Layer Protocol Negotiation (ALPN) policy.' + type: array + items: + type: string + SslPolicy: description: |- [HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are supported. Updating the security policy can result in interruptions if the load balancer is handling a high volume of traffic. For more information, see [Security policies](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-https-listener.html#describe-ssl-policies) in the *Application Load Balancers Guide* and [Security policies](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html#describe-ssl-policies) in the *Network Load Balancers Guide*. - LoadBalancerArn: type: string + LoadBalancerArn: description: The Amazon Resource Name (ARN) of the load balancer. + type: string DefaultActions: - type: array uniqueItems: true - items: - $ref: '#/components/schemas/Action' description: |- The actions for the default rule. You cannot define a condition for a default rule. To create additional rules for an Application Load Balancer, use [AWS::ElasticLoadBalancingV2::ListenerRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenerrule.html). + type: array + items: + $ref: '#/components/schemas/Action' Port: - type: integer description: The port on which the load balancer is listening. You cannot specify a port for a Gateway Load Balancer. + type: integer Certificates: - type: array uniqueItems: true - items: - $ref: '#/components/schemas/Certificate' description: |- The default SSL server certificate for a secure listener. You must provide exactly one certificate if the listener protocol is HTTPS or TLS. To create a certificate list for a secure listener, use [AWS::ElasticLoadBalancingV2::ListenerCertificate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenercertificate.html). + type: array + items: + $ref: '#/components/schemas/Certificate' Protocol: - type: string description: The protocol for connections from clients to the load balancer. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols are TCP, TLS, UDP, and TCP_UDP. You can’t specify the UDP or TCP_UDP protocol if dual-stack mode is enabled. You cannot specify a protocol for a Gateway Load Balancer. - ListenerArn: type: string - description: '' - AlpnPolicy: - type: array - items: - type: string - description: '[TLS listener] The name of the Application-Layer Protocol Negotiation (ALPN) policy.' - MutualAuthentication: - $ref: '#/components/schemas/MutualAuthentication' - description: The mutual authentication configuration information. required: - LoadBalancerArn - DefaultActions @@ -696,21 +703,21 @@ components: tagUpdatable: false cloudFormationSystemTags: false x-required-permissions: + read: + - elasticloadbalancing:DescribeListeners create: - elasticloadbalancing:CreateListener - elasticloadbalancing:DescribeListeners - cognito-idp:DescribeUserPoolClient - delete: - - elasticloadbalancing:DeleteListener - - elasticloadbalancing:DescribeListeners - list: - - elasticloadbalancing:DescribeListeners - read: - - elasticloadbalancing:DescribeListeners update: - elasticloadbalancing:ModifyListener - elasticloadbalancing:DescribeListeners - cognito-idp:DescribeUserPoolClient + list: + - elasticloadbalancing:DescribeListeners + delete: + - elasticloadbalancing:DeleteListener + - elasticloadbalancing:DescribeListeners RuleCondition: type: object additionalProperties: false @@ -1489,48 +1496,48 @@ components: DesiredState: type: object properties: - SslPolicy: + ListenerArn: + description: '' type: string + MutualAuthentication: + description: The mutual authentication configuration information. + $ref: '#/components/schemas/MutualAuthentication' + AlpnPolicy: + description: '[TLS listener] The name of the Application-Layer Protocol Negotiation (ALPN) policy.' + type: array + items: + type: string + SslPolicy: description: |- [HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are supported. Updating the security policy can result in interruptions if the load balancer is handling a high volume of traffic. For more information, see [Security policies](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-https-listener.html#describe-ssl-policies) in the *Application Load Balancers Guide* and [Security policies](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html#describe-ssl-policies) in the *Network Load Balancers Guide*. - LoadBalancerArn: type: string + LoadBalancerArn: description: The Amazon Resource Name (ARN) of the load balancer. + type: string DefaultActions: - type: array uniqueItems: true - items: - $ref: '#/components/schemas/Action' description: |- The actions for the default rule. You cannot define a condition for a default rule. To create additional rules for an Application Load Balancer, use [AWS::ElasticLoadBalancingV2::ListenerRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenerrule.html). + type: array + items: + $ref: '#/components/schemas/Action' Port: - type: integer description: The port on which the load balancer is listening. You cannot specify a port for a Gateway Load Balancer. + type: integer Certificates: - type: array uniqueItems: true - items: - $ref: '#/components/schemas/Certificate' description: |- The default SSL server certificate for a secure listener. You must provide exactly one certificate if the listener protocol is HTTPS or TLS. To create a certificate list for a secure listener, use [AWS::ElasticLoadBalancingV2::ListenerCertificate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenercertificate.html). + type: array + items: + $ref: '#/components/schemas/Certificate' Protocol: - type: string description: The protocol for connections from clients to the load balancer. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols are TCP, TLS, UDP, and TCP_UDP. You can’t specify the UDP or TCP_UDP protocol if dual-stack mode is enabled. You cannot specify a protocol for a Gateway Load Balancer. - ListenerArn: type: string - description: '' - AlpnPolicy: - type: array - items: - type: string - description: '[TLS listener] The name of the Application-Layer Protocol Negotiation (ALPN) policy.' - MutualAuthentication: - $ref: '#/components/schemas/MutualAuthentication' - description: The mutual authentication configuration information. x-stackQL-stringOnly: true x-title: CreateListenerRequest type: object @@ -1886,7 +1893,7 @@ components: x-cfn-type-name: AWS::ElasticLoadBalancingV2::Listener x-identifiers: - ListenerArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1903,9 +1910,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1915,41 +1922,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/listeners/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/listeners/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ListenerArn') as listener_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::Listener' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ListenerArn') as listener_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::Listener' - AND region = 'us-east-1' - listener: - name: listener - id: aws.elasticloadbalancingv2.listener - x-cfn-schema-name: Listener - x-cfn-type-name: AWS::ElasticLoadBalancingV2::Listener - x-identifiers: - - ListenerArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1960,46 +1935,66 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/listeners/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/listeners/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/listener/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/listeners/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, + JSON_EXTRACT(Properties, '$.ListenerArn') as listener_arn, + JSON_EXTRACT(Properties, '$.MutualAuthentication') as mutual_authentication, + JSON_EXTRACT(Properties, '$.AlpnPolicy') as alpn_policy, JSON_EXTRACT(Properties, '$.SslPolicy') as ssl_policy, JSON_EXTRACT(Properties, '$.LoadBalancerArn') as load_balancer_arn, JSON_EXTRACT(Properties, '$.DefaultActions') as default_actions, JSON_EXTRACT(Properties, '$.Port') as port, JSON_EXTRACT(Properties, '$.Certificates') as certificates, - JSON_EXTRACT(Properties, '$.Protocol') as protocol, - JSON_EXTRACT(Properties, '$.ListenerArn') as listener_arn, - JSON_EXTRACT(Properties, '$.AlpnPolicy') as alpn_policy, - JSON_EXTRACT(Properties, '$.MutualAuthentication') as mutual_authentication + JSON_EXTRACT(Properties, '$.Protocol') as protocol FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::Listener' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'SslPolicy') as ssl_policy, - json_extract_path_text(Properties, 'LoadBalancerArn') as load_balancer_arn, - json_extract_path_text(Properties, 'DefaultActions') as default_actions, - json_extract_path_text(Properties, 'Port') as port, - json_extract_path_text(Properties, 'Certificates') as certificates, - json_extract_path_text(Properties, 'Protocol') as protocol, - json_extract_path_text(Properties, 'ListenerArn') as listener_arn, - json_extract_path_text(Properties, 'AlpnPolicy') as alpn_policy, - json_extract_path_text(Properties, 'MutualAuthentication') as mutual_authentication - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::Listener' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ListenerArn') as listener_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::Listener' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ListenerArn') as listener_arn, + json_extract_path_text(Properties, 'MutualAuthentication') as mutual_authentication, + json_extract_path_text(Properties, 'AlpnPolicy') as alpn_policy, + json_extract_path_text(Properties, 'SslPolicy') as ssl_policy, + json_extract_path_text(Properties, 'LoadBalancerArn') as load_balancer_arn, + json_extract_path_text(Properties, 'DefaultActions') as default_actions, + json_extract_path_text(Properties, 'Port') as port, + json_extract_path_text(Properties, 'Certificates') as certificates, + json_extract_path_text(Properties, 'Protocol') as protocol + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::Listener' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ListenerArn') as listener_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::Listener' + AND region = 'us-east-1' listener_rules: name: listener_rules id: aws.elasticloadbalancingv2.listener_rules @@ -2007,7 +2002,7 @@ components: x-cfn-type-name: AWS::ElasticLoadBalancingV2::ListenerRule x-identifiers: - RuleArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2024,9 +2019,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2036,41 +2031,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/listener_rules/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/listener_rules/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.RuleArn') as rule_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::ListenerRule' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'RuleArn') as rule_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::ListenerRule' - AND region = 'us-east-1' - listener_rule: - name: listener_rule - id: aws.elasticloadbalancingv2.listener_rule - x-cfn-schema-name: ListenerRule - x-cfn-type-name: AWS::ElasticLoadBalancingV2::ListenerRule - x-identifiers: - - RuleArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2081,12 +2044,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/listener_rules/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/listener_rules/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/listener_rule/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/listener_rules/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2101,20 +2068,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ListenerArn') as listener_arn, - json_extract_path_text(Properties, 'RuleArn') as rule_arn, - json_extract_path_text(Properties, 'Actions') as actions, - json_extract_path_text(Properties, 'Priority') as priority, - json_extract_path_text(Properties, 'Conditions') as conditions, - json_extract_path_text(Properties, 'IsDefault') as is_default - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::ListenerRule' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.RuleArn') as rule_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::ListenerRule' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ListenerArn') as listener_arn, + json_extract_path_text(Properties, 'RuleArn') as rule_arn, + json_extract_path_text(Properties, 'Actions') as actions, + json_extract_path_text(Properties, 'Priority') as priority, + json_extract_path_text(Properties, 'Conditions') as conditions, + json_extract_path_text(Properties, 'IsDefault') as is_default + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::ListenerRule' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'RuleArn') as rule_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::ListenerRule' + AND region = 'us-east-1' load_balancers: name: load_balancers id: aws.elasticloadbalancingv2.load_balancers @@ -2122,7 +2105,7 @@ components: x-cfn-type-name: AWS::ElasticLoadBalancingV2::LoadBalancer x-identifiers: - LoadBalancerArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2139,9 +2122,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2151,41 +2134,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/load_balancers/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/load_balancers/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.LoadBalancerArn') as load_balancer_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::LoadBalancer' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'LoadBalancerArn') as load_balancer_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::LoadBalancer' - AND region = 'us-east-1' - load_balancer: - name: load_balancer - id: aws.elasticloadbalancingv2.load_balancer - x-cfn-schema-name: LoadBalancer - x-cfn-type-name: AWS::ElasticLoadBalancingV2::LoadBalancer - x-identifiers: - - LoadBalancerArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2196,12 +2147,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/load_balancers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/load_balancers/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/load_balancer/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/load_balancers/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2225,29 +2180,45 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'IpAddressType') as ip_address_type, - json_extract_path_text(Properties, 'SecurityGroups') as security_groups, - json_extract_path_text(Properties, 'LoadBalancerAttributes') as load_balancer_attributes, - json_extract_path_text(Properties, 'Scheme') as scheme, - json_extract_path_text(Properties, 'DNSName') as dns_name, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'LoadBalancerName') as load_balancer_name, - json_extract_path_text(Properties, 'LoadBalancerFullName') as load_balancer_full_name, - json_extract_path_text(Properties, 'Subnets') as subnets, - json_extract_path_text(Properties, 'Type') as type, - json_extract_path_text(Properties, 'CanonicalHostedZoneID') as canonical_hosted_zone_id, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'LoadBalancerArn') as load_balancer_arn, - json_extract_path_text(Properties, 'SubnetMappings') as subnet_mappings, - json_extract_path_text(Properties, 'EnforceSecurityGroupInboundRulesOnPrivateLinkTraffic') as enforce_security_group_inbound_rules_on_private_link_traffic - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::LoadBalancer' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.LoadBalancerArn') as load_balancer_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::LoadBalancer' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'IpAddressType') as ip_address_type, + json_extract_path_text(Properties, 'SecurityGroups') as security_groups, + json_extract_path_text(Properties, 'LoadBalancerAttributes') as load_balancer_attributes, + json_extract_path_text(Properties, 'Scheme') as scheme, + json_extract_path_text(Properties, 'DNSName') as dns_name, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'LoadBalancerName') as load_balancer_name, + json_extract_path_text(Properties, 'LoadBalancerFullName') as load_balancer_full_name, + json_extract_path_text(Properties, 'Subnets') as subnets, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'CanonicalHostedZoneID') as canonical_hosted_zone_id, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'LoadBalancerArn') as load_balancer_arn, + json_extract_path_text(Properties, 'SubnetMappings') as subnet_mappings, + json_extract_path_text(Properties, 'EnforceSecurityGroupInboundRulesOnPrivateLinkTraffic') as enforce_security_group_inbound_rules_on_private_link_traffic + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::LoadBalancer' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'LoadBalancerArn') as load_balancer_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::LoadBalancer' + AND region = 'us-east-1' target_groups: name: target_groups id: aws.elasticloadbalancingv2.target_groups @@ -2255,7 +2226,7 @@ components: x-cfn-type-name: AWS::ElasticLoadBalancingV2::TargetGroup x-identifiers: - TargetGroupArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2272,9 +2243,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2284,41 +2255,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/target_groups/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/target_groups/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.TargetGroupArn') as target_group_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::TargetGroup' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'TargetGroupArn') as target_group_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::TargetGroup' - AND region = 'us-east-1' - target_group: - name: target_group - id: aws.elasticloadbalancingv2.target_group - x-cfn-schema-name: TargetGroup - x-cfn-type-name: AWS::ElasticLoadBalancingV2::TargetGroup - x-identifiers: - - TargetGroupArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2329,12 +2268,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/target_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/target_groups/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/target_group/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/target_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2366,37 +2309,53 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'IpAddressType') as ip_address_type, - json_extract_path_text(Properties, 'HealthCheckIntervalSeconds') as health_check_interval_seconds, - json_extract_path_text(Properties, 'LoadBalancerArns') as load_balancer_arns, - json_extract_path_text(Properties, 'Matcher') as matcher, - json_extract_path_text(Properties, 'HealthCheckPath') as health_check_path, - json_extract_path_text(Properties, 'Port') as port, - json_extract_path_text(Properties, 'Targets') as targets, - json_extract_path_text(Properties, 'HealthCheckEnabled') as health_check_enabled, - json_extract_path_text(Properties, 'ProtocolVersion') as protocol_version, - json_extract_path_text(Properties, 'UnhealthyThresholdCount') as unhealthy_threshold_count, - json_extract_path_text(Properties, 'HealthCheckTimeoutSeconds') as health_check_timeout_seconds, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'VpcId') as vpc_id, - json_extract_path_text(Properties, 'TargetGroupFullName') as target_group_full_name, - json_extract_path_text(Properties, 'HealthyThresholdCount') as healthy_threshold_count, - json_extract_path_text(Properties, 'HealthCheckProtocol') as health_check_protocol, - json_extract_path_text(Properties, 'TargetGroupAttributes') as target_group_attributes, - json_extract_path_text(Properties, 'TargetType') as target_type, - json_extract_path_text(Properties, 'HealthCheckPort') as health_check_port, - json_extract_path_text(Properties, 'TargetGroupArn') as target_group_arn, - json_extract_path_text(Properties, 'Protocol') as protocol, - json_extract_path_text(Properties, 'TargetGroupName') as target_group_name, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::TargetGroup' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.TargetGroupArn') as target_group_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::TargetGroup' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'IpAddressType') as ip_address_type, + json_extract_path_text(Properties, 'HealthCheckIntervalSeconds') as health_check_interval_seconds, + json_extract_path_text(Properties, 'LoadBalancerArns') as load_balancer_arns, + json_extract_path_text(Properties, 'Matcher') as matcher, + json_extract_path_text(Properties, 'HealthCheckPath') as health_check_path, + json_extract_path_text(Properties, 'Port') as port, + json_extract_path_text(Properties, 'Targets') as targets, + json_extract_path_text(Properties, 'HealthCheckEnabled') as health_check_enabled, + json_extract_path_text(Properties, 'ProtocolVersion') as protocol_version, + json_extract_path_text(Properties, 'UnhealthyThresholdCount') as unhealthy_threshold_count, + json_extract_path_text(Properties, 'HealthCheckTimeoutSeconds') as health_check_timeout_seconds, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'VpcId') as vpc_id, + json_extract_path_text(Properties, 'TargetGroupFullName') as target_group_full_name, + json_extract_path_text(Properties, 'HealthyThresholdCount') as healthy_threshold_count, + json_extract_path_text(Properties, 'HealthCheckProtocol') as health_check_protocol, + json_extract_path_text(Properties, 'TargetGroupAttributes') as target_group_attributes, + json_extract_path_text(Properties, 'TargetType') as target_type, + json_extract_path_text(Properties, 'HealthCheckPort') as health_check_port, + json_extract_path_text(Properties, 'TargetGroupArn') as target_group_arn, + json_extract_path_text(Properties, 'Protocol') as protocol, + json_extract_path_text(Properties, 'TargetGroupName') as target_group_name, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::TargetGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'TargetGroupArn') as target_group_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::TargetGroup' + AND region = 'us-east-1' trust_stores: name: trust_stores id: aws.elasticloadbalancingv2.trust_stores @@ -2404,7 +2363,7 @@ components: x-cfn-type-name: AWS::ElasticLoadBalancingV2::TrustStore x-identifiers: - TrustStoreArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2421,9 +2380,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2433,41 +2392,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/trust_stores/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/trust_stores/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.TrustStoreArn') as trust_store_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::TrustStore' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'TrustStoreArn') as trust_store_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::TrustStore' - AND region = 'us-east-1' - trust_store: - name: trust_store - id: aws.elasticloadbalancingv2.trust_store - x-cfn-schema-name: TrustStore - x-cfn-type-name: AWS::ElasticLoadBalancingV2::TrustStore - x-identifiers: - - TrustStoreArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2478,12 +2405,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/trust_stores/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/trust_stores/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/trust_store/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/trust_stores/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2500,22 +2431,38 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'CaCertificatesBundleS3Bucket') as ca_certificates_bundle_s3_bucket, - json_extract_path_text(Properties, 'CaCertificatesBundleS3Key') as ca_certificates_bundle_s3_key, - json_extract_path_text(Properties, 'CaCertificatesBundleS3ObjectVersion') as ca_certificates_bundle_s3_object_version, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'NumberOfCaCertificates') as number_of_ca_certificates, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'TrustStoreArn') as trust_store_arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::TrustStore' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.TrustStoreArn') as trust_store_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::TrustStore' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'CaCertificatesBundleS3Bucket') as ca_certificates_bundle_s3_bucket, + json_extract_path_text(Properties, 'CaCertificatesBundleS3Key') as ca_certificates_bundle_s3_key, + json_extract_path_text(Properties, 'CaCertificatesBundleS3ObjectVersion') as ca_certificates_bundle_s3_object_version, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'NumberOfCaCertificates') as number_of_ca_certificates, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'TrustStoreArn') as trust_store_arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::TrustStore' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'TrustStoreArn') as trust_store_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::TrustStore' + AND region = 'us-east-1' trust_store_revocations: name: trust_store_revocations id: aws.elasticloadbalancingv2.trust_store_revocations @@ -2524,7 +2471,7 @@ components: x-identifiers: - RevocationId - TrustStoreArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2558,42 +2505,11 @@ components: - $ref: '#/components/x-stackQL-resources/trust_store_revocations/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/trust_store_revocations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.RevocationId') as revocation_id, - JSON_EXTRACT(Properties, '$.TrustStoreArn') as trust_store_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::TrustStoreRevocation' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'RevocationId') as revocation_id, - json_extract_path_text(Properties, 'TrustStoreArn') as trust_store_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::TrustStoreRevocation' - AND region = 'us-east-1' - trust_store_revocation: - name: trust_store_revocation - id: aws.elasticloadbalancingv2.trust_store_revocation - x-cfn-schema-name: TrustStoreRevocation - x-cfn-type-name: AWS::ElasticLoadBalancingV2::TrustStoreRevocation - x-identifiers: - - RevocationId - - TrustStoreArn - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2606,18 +2522,36 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'RevocationContents') as revocation_contents, - json_extract_path_text(Properties, 'TrustStoreArn') as trust_store_arn, - json_extract_path_text(Properties, 'RevocationId') as revocation_id, - json_extract_path_text(Properties, 'TrustStoreRevocations') as trust_store_revocations - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::TrustStoreRevocation' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.RevocationId') as revocation_id, + JSON_EXTRACT(Properties, '$.TrustStoreArn') as trust_store_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::TrustStoreRevocation' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'RevocationContents') as revocation_contents, + json_extract_path_text(Properties, 'TrustStoreArn') as trust_store_arn, + json_extract_path_text(Properties, 'RevocationId') as revocation_id, + json_extract_path_text(Properties, 'TrustStoreRevocations') as trust_store_revocations + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::TrustStoreRevocation' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'RevocationId') as revocation_id, + json_extract_path_text(Properties, 'TrustStoreArn') as trust_store_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ElasticLoadBalancingV2::TrustStoreRevocation' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/emr.yaml b/providers/src/aws/v00.00.00000/services/emr.yaml index df96b761..75792a2b 100644 --- a/providers/src/aws/v00.00.00000/services/emr.yaml +++ b/providers/src/aws/v00.00.00000/services/emr.yaml @@ -953,7 +953,7 @@ components: x-cfn-type-name: AWS::EMR::SecurityConfiguration x-identifiers: - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -987,39 +987,11 @@ components: - $ref: '#/components/x-stackQL-resources/security_configurations/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/security_configurations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EMR::SecurityConfiguration' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EMR::SecurityConfiguration' - AND region = 'us-east-1' - security_configuration: - name: security_configuration - id: aws.emr.security_configuration - x-cfn-schema-name: SecurityConfiguration - x-cfn-type-name: AWS::EMR::SecurityConfiguration - x-identifiers: - - Name - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1030,16 +1002,32 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'SecurityConfiguration') as security_configuration - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EMR::SecurityConfiguration' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EMR::SecurityConfiguration' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'SecurityConfiguration') as security_configuration + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EMR::SecurityConfiguration' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EMR::SecurityConfiguration' + AND region = 'us-east-1' studios: name: studios id: aws.emr.studios @@ -1047,7 +1035,7 @@ components: x-cfn-type-name: AWS::EMR::Studio x-identifiers: - StudioId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1064,9 +1052,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1076,41 +1064,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/studios/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/studios/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.StudioId') as studio_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EMR::Studio' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'StudioId') as studio_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EMR::Studio' - AND region = 'us-east-1' - studio: - name: studio - id: aws.emr.studio - x-cfn-schema-name: Studio - x-cfn-type-name: AWS::EMR::Studio - x-identifiers: - - StudioId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1121,12 +1077,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/studios/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/studios/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/studio/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/studios/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1155,34 +1115,50 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'AuthMode') as auth_mode, - json_extract_path_text(Properties, 'DefaultS3Location') as default_s3_location, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'EngineSecurityGroupId') as engine_security_group_id, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'ServiceRole') as service_role, - json_extract_path_text(Properties, 'StudioId') as studio_id, - json_extract_path_text(Properties, 'SubnetIds') as subnet_ids, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Url') as url, - json_extract_path_text(Properties, 'UserRole') as user_role, - json_extract_path_text(Properties, 'VpcId') as vpc_id, - json_extract_path_text(Properties, 'WorkspaceSecurityGroupId') as workspace_security_group_id, - json_extract_path_text(Properties, 'IdpAuthUrl') as idp_auth_url, - json_extract_path_text(Properties, 'IdpRelayStateParameterName') as idp_relay_state_parameter_name, - json_extract_path_text(Properties, 'TrustedIdentityPropagationEnabled') as trusted_identity_propagation_enabled, - json_extract_path_text(Properties, 'IdcUserAssignment') as idc_user_assignment, - json_extract_path_text(Properties, 'IdcInstanceArn') as idc_instance_arn, - json_extract_path_text(Properties, 'EncryptionKeyArn') as encryption_key_arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EMR::Studio' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.StudioId') as studio_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EMR::Studio' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'AuthMode') as auth_mode, + json_extract_path_text(Properties, 'DefaultS3Location') as default_s3_location, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'EngineSecurityGroupId') as engine_security_group_id, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'ServiceRole') as service_role, + json_extract_path_text(Properties, 'StudioId') as studio_id, + json_extract_path_text(Properties, 'SubnetIds') as subnet_ids, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Url') as url, + json_extract_path_text(Properties, 'UserRole') as user_role, + json_extract_path_text(Properties, 'VpcId') as vpc_id, + json_extract_path_text(Properties, 'WorkspaceSecurityGroupId') as workspace_security_group_id, + json_extract_path_text(Properties, 'IdpAuthUrl') as idp_auth_url, + json_extract_path_text(Properties, 'IdpRelayStateParameterName') as idp_relay_state_parameter_name, + json_extract_path_text(Properties, 'TrustedIdentityPropagationEnabled') as trusted_identity_propagation_enabled, + json_extract_path_text(Properties, 'IdcUserAssignment') as idc_user_assignment, + json_extract_path_text(Properties, 'IdcInstanceArn') as idc_instance_arn, + json_extract_path_text(Properties, 'EncryptionKeyArn') as encryption_key_arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EMR::Studio' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'StudioId') as studio_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EMR::Studio' + AND region = 'us-east-1' studio_session_mappings: name: studio_session_mappings id: aws.emr.studio_session_mappings @@ -1192,7 +1168,7 @@ components: - StudioId - IdentityType - IdentityName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1209,9 +1185,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1221,47 +1197,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/studio_session_mappings/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/studio_session_mappings/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.StudioId') as studio_id, - JSON_EXTRACT(Properties, '$.IdentityType') as identity_type, - JSON_EXTRACT(Properties, '$.IdentityName') as identity_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EMR::StudioSessionMapping' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'StudioId') as studio_id, - json_extract_path_text(Properties, 'IdentityType') as identity_type, - json_extract_path_text(Properties, 'IdentityName') as identity_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EMR::StudioSessionMapping' - AND region = 'us-east-1' - studio_session_mapping: - name: studio_session_mapping - id: aws.emr.studio_session_mapping - x-cfn-schema-name: StudioSessionMapping - x-cfn-type-name: AWS::EMR::StudioSessionMapping - x-identifiers: - - StudioId - - IdentityType - - IdentityName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1272,12 +1210,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/studio_session_mappings/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/studio_session_mappings/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/studio_session_mapping/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/studio_session_mappings/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1290,18 +1232,38 @@ components: AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'IdentityName') as identity_name, - json_extract_path_text(Properties, 'IdentityType') as identity_type, - json_extract_path_text(Properties, 'SessionPolicyArn') as session_policy_arn, - json_extract_path_text(Properties, 'StudioId') as studio_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EMR::StudioSessionMapping' - AND data__Identifier = '||' + JSON_EXTRACT(Properties, '$.StudioId') as studio_id, + JSON_EXTRACT(Properties, '$.IdentityType') as identity_type, + JSON_EXTRACT(Properties, '$.IdentityName') as identity_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EMR::StudioSessionMapping' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'IdentityName') as identity_name, + json_extract_path_text(Properties, 'IdentityType') as identity_type, + json_extract_path_text(Properties, 'SessionPolicyArn') as session_policy_arn, + json_extract_path_text(Properties, 'StudioId') as studio_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EMR::StudioSessionMapping' + AND data__Identifier = '||' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'StudioId') as studio_id, + json_extract_path_text(Properties, 'IdentityType') as identity_type, + json_extract_path_text(Properties, 'IdentityName') as identity_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EMR::StudioSessionMapping' + AND region = 'us-east-1' wal_workspaces: name: wal_workspaces id: aws.emr.wal_workspaces @@ -1309,7 +1271,7 @@ components: x-cfn-type-name: AWS::EMR::WALWorkspace x-identifiers: - WALWorkspaceName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1326,9 +1288,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1338,41 +1300,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/wal_workspaces/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/wal_workspaces/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.WALWorkspaceName') as wal_workspace_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EMR::WALWorkspace' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'WALWorkspaceName') as wal_workspace_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EMR::WALWorkspace' - AND region = 'us-east-1' - wal_workspace: - name: wal_workspace - id: aws.emr.wal_workspace - x-cfn-schema-name: WALWorkspace - x-cfn-type-name: AWS::EMR::WALWorkspace - x-identifiers: - - WALWorkspaceName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1383,12 +1313,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/wal_workspaces/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/wal_workspaces/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/wal_workspace/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/wal_workspaces/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1399,16 +1333,32 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'WALWorkspaceName') as wal_workspace_name, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EMR::WALWorkspace' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.WALWorkspaceName') as wal_workspace_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EMR::WALWorkspace' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'WALWorkspaceName') as wal_workspace_name, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EMR::WALWorkspace' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'WALWorkspaceName') as wal_workspace_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EMR::WALWorkspace' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/emrcontainers.yaml b/providers/src/aws/v00.00.00000/services/emrcontainers.yaml index 67161689..b59fd1e1 100644 --- a/providers/src/aws/v00.00.00000/services/emrcontainers.yaml +++ b/providers/src/aws/v00.00.00000/services/emrcontainers.yaml @@ -551,7 +551,7 @@ components: x-cfn-type-name: AWS::EMRContainers::VirtualCluster x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -568,9 +568,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -580,41 +580,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/virtual_clusters/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/virtual_clusters/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EMRContainers::VirtualCluster' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EMRContainers::VirtualCluster' - AND region = 'us-east-1' - virtual_cluster: - name: virtual_cluster - id: aws.emrcontainers.virtual_cluster - x-cfn-schema-name: VirtualCluster - x-cfn-type-name: AWS::EMRContainers::VirtualCluster - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -625,12 +593,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/virtual_clusters/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/virtual_clusters/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/virtual_cluster/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/virtual_clusters/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -644,19 +616,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'ContainerProvider') as container_provider, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EMRContainers::VirtualCluster' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EMRContainers::VirtualCluster' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'ContainerProvider') as container_provider, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EMRContainers::VirtualCluster' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EMRContainers::VirtualCluster' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/emrserverless.yaml b/providers/src/aws/v00.00.00000/services/emrserverless.yaml index 0004d88c..33e60161 100644 --- a/providers/src/aws/v00.00.00000/services/emrserverless.yaml +++ b/providers/src/aws/v00.00.00000/services/emrserverless.yaml @@ -966,7 +966,7 @@ components: x-cfn-type-name: AWS::EMRServerless::Application x-identifiers: - ApplicationId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -983,9 +983,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -995,41 +995,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/applications/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/applications/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ApplicationId') as application_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EMRServerless::Application' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ApplicationId') as application_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EMRServerless::Application' - AND region = 'us-east-1' - application: - name: application - id: aws.emrserverless.application - x-cfn-schema-name: Application - x-cfn-type-name: AWS::EMRServerless::Application - x-identifiers: - - ApplicationId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1040,12 +1008,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/applications/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/applications/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/application/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/applications/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1070,30 +1042,46 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Architecture') as architecture, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'ReleaseLabel') as release_label, - json_extract_path_text(Properties, 'Type') as type, - json_extract_path_text(Properties, 'InitialCapacity') as initial_capacity, - json_extract_path_text(Properties, 'MaximumCapacity') as maximum_capacity, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'AutoStartConfiguration') as auto_start_configuration, - json_extract_path_text(Properties, 'AutoStopConfiguration') as auto_stop_configuration, - json_extract_path_text(Properties, 'ImageConfiguration') as image_configuration, - json_extract_path_text(Properties, 'MonitoringConfiguration') as monitoring_configuration, - json_extract_path_text(Properties, 'RuntimeConfiguration') as runtime_configuration, - json_extract_path_text(Properties, 'NetworkConfiguration') as network_configuration, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'ApplicationId') as application_id, - json_extract_path_text(Properties, 'WorkerTypeSpecifications') as worker_type_specifications - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EMRServerless::Application' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ApplicationId') as application_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EMRServerless::Application' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Architecture') as architecture, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'ReleaseLabel') as release_label, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'InitialCapacity') as initial_capacity, + json_extract_path_text(Properties, 'MaximumCapacity') as maximum_capacity, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'AutoStartConfiguration') as auto_start_configuration, + json_extract_path_text(Properties, 'AutoStopConfiguration') as auto_stop_configuration, + json_extract_path_text(Properties, 'ImageConfiguration') as image_configuration, + json_extract_path_text(Properties, 'MonitoringConfiguration') as monitoring_configuration, + json_extract_path_text(Properties, 'RuntimeConfiguration') as runtime_configuration, + json_extract_path_text(Properties, 'NetworkConfiguration') as network_configuration, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'ApplicationId') as application_id, + json_extract_path_text(Properties, 'WorkerTypeSpecifications') as worker_type_specifications + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EMRServerless::Application' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ApplicationId') as application_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EMRServerless::Application' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/entityresolution.yaml b/providers/src/aws/v00.00.00000/services/entityresolution.yaml index 690eb01e..fbb8ea81 100644 --- a/providers/src/aws/v00.00.00000/services/entityresolution.yaml +++ b/providers/src/aws/v00.00.00000/services/entityresolution.yaml @@ -1404,7 +1404,7 @@ components: x-cfn-type-name: AWS::EntityResolution::IdMappingWorkflow x-identifiers: - WorkflowName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1421,9 +1421,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1433,41 +1433,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/id_mapping_workflows/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/id_mapping_workflows/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.WorkflowName') as workflow_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EntityResolution::IdMappingWorkflow' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'WorkflowName') as workflow_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EntityResolution::IdMappingWorkflow' - AND region = 'us-east-1' - id_mapping_workflow: - name: id_mapping_workflow - id: aws.entityresolution.id_mapping_workflow - x-cfn-schema-name: IdMappingWorkflow - x-cfn-type-name: AWS::EntityResolution::IdMappingWorkflow - x-identifiers: - - WorkflowName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1478,12 +1446,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/id_mapping_workflows/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/id_mapping_workflows/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/id_mapping_workflow/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/id_mapping_workflows/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1502,24 +1474,40 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'WorkflowName') as workflow_name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'InputSourceConfig') as input_source_config, - json_extract_path_text(Properties, 'OutputSourceConfig') as output_source_config, - json_extract_path_text(Properties, 'IdMappingTechniques') as id_mapping_techniques, - json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'WorkflowArn') as workflow_arn, - json_extract_path_text(Properties, 'CreatedAt') as created_at, - json_extract_path_text(Properties, 'UpdatedAt') as updated_at - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EntityResolution::IdMappingWorkflow' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.WorkflowName') as workflow_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EntityResolution::IdMappingWorkflow' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'WorkflowName') as workflow_name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'InputSourceConfig') as input_source_config, + json_extract_path_text(Properties, 'OutputSourceConfig') as output_source_config, + json_extract_path_text(Properties, 'IdMappingTechniques') as id_mapping_techniques, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'WorkflowArn') as workflow_arn, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'UpdatedAt') as updated_at + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EntityResolution::IdMappingWorkflow' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'WorkflowName') as workflow_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EntityResolution::IdMappingWorkflow' + AND region = 'us-east-1' id_namespaces: name: id_namespaces id: aws.entityresolution.id_namespaces @@ -1527,7 +1515,7 @@ components: x-cfn-type-name: AWS::EntityResolution::IdNamespace x-identifiers: - IdNamespaceName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1544,9 +1532,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1556,41 +1544,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/id_namespaces/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/id_namespaces/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.IdNamespaceName') as id_namespace_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EntityResolution::IdNamespace' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'IdNamespaceName') as id_namespace_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EntityResolution::IdNamespace' - AND region = 'us-east-1' - id_namespace: - name: id_namespace - id: aws.entityresolution.id_namespace - x-cfn-schema-name: IdNamespace - x-cfn-type-name: AWS::EntityResolution::IdNamespace - x-identifiers: - - IdNamespaceName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1601,12 +1557,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/id_namespaces/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/id_namespaces/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/id_namespace/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/id_namespaces/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1625,24 +1585,40 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'IdNamespaceName') as id_namespace_name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'InputSourceConfig') as input_source_config, - json_extract_path_text(Properties, 'IdMappingWorkflowProperties') as id_mapping_workflow_properties, - json_extract_path_text(Properties, 'Type') as type, - json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'IdNamespaceArn') as id_namespace_arn, - json_extract_path_text(Properties, 'CreatedAt') as created_at, - json_extract_path_text(Properties, 'UpdatedAt') as updated_at, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EntityResolution::IdNamespace' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.IdNamespaceName') as id_namespace_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EntityResolution::IdNamespace' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'IdNamespaceName') as id_namespace_name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'InputSourceConfig') as input_source_config, + json_extract_path_text(Properties, 'IdMappingWorkflowProperties') as id_mapping_workflow_properties, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'IdNamespaceArn') as id_namespace_arn, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'UpdatedAt') as updated_at, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EntityResolution::IdNamespace' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'IdNamespaceName') as id_namespace_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EntityResolution::IdNamespace' + AND region = 'us-east-1' matching_workflows: name: matching_workflows id: aws.entityresolution.matching_workflows @@ -1650,7 +1626,7 @@ components: x-cfn-type-name: AWS::EntityResolution::MatchingWorkflow x-identifiers: - WorkflowName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1667,9 +1643,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1679,41 +1655,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/matching_workflows/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/matching_workflows/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.WorkflowName') as workflow_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EntityResolution::MatchingWorkflow' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'WorkflowName') as workflow_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EntityResolution::MatchingWorkflow' - AND region = 'us-east-1' - matching_workflow: - name: matching_workflow - id: aws.entityresolution.matching_workflow - x-cfn-schema-name: MatchingWorkflow - x-cfn-type-name: AWS::EntityResolution::MatchingWorkflow - x-identifiers: - - WorkflowName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1724,12 +1668,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/matching_workflows/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/matching_workflows/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/matching_workflow/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/matching_workflows/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1748,24 +1696,40 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'WorkflowName') as workflow_name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'InputSourceConfig') as input_source_config, - json_extract_path_text(Properties, 'OutputSourceConfig') as output_source_config, - json_extract_path_text(Properties, 'ResolutionTechniques') as resolution_techniques, - json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'WorkflowArn') as workflow_arn, - json_extract_path_text(Properties, 'CreatedAt') as created_at, - json_extract_path_text(Properties, 'UpdatedAt') as updated_at - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EntityResolution::MatchingWorkflow' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.WorkflowName') as workflow_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EntityResolution::MatchingWorkflow' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'WorkflowName') as workflow_name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'InputSourceConfig') as input_source_config, + json_extract_path_text(Properties, 'OutputSourceConfig') as output_source_config, + json_extract_path_text(Properties, 'ResolutionTechniques') as resolution_techniques, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'WorkflowArn') as workflow_arn, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'UpdatedAt') as updated_at + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EntityResolution::MatchingWorkflow' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'WorkflowName') as workflow_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EntityResolution::MatchingWorkflow' + AND region = 'us-east-1' policy_statements: name: policy_statements id: aws.entityresolution.policy_statements @@ -1774,7 +1738,7 @@ components: x-identifiers: - Arn - StatementId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1791,9 +1755,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1803,44 +1767,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/policy_statements/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/policy_statements/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn, - JSON_EXTRACT(Properties, '$.StatementId') as statement_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EntityResolution::PolicyStatement' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'StatementId') as statement_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EntityResolution::PolicyStatement' - AND region = 'us-east-1' - policy_statement: - name: policy_statement - id: aws.entityresolution.policy_statement - x-cfn-schema-name: PolicyStatement - x-cfn-type-name: AWS::EntityResolution::PolicyStatement - x-identifiers: - - Arn - - StatementId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1851,12 +1780,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/policy_statements/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/policy_statements/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/policy_statement/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/policy_statements/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1871,20 +1804,38 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'StatementId') as statement_id, - json_extract_path_text(Properties, 'Effect') as effect, - json_extract_path_text(Properties, 'Action') as action, - json_extract_path_text(Properties, 'Principal') as principal, - json_extract_path_text(Properties, 'Condition') as condition - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EntityResolution::PolicyStatement' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.StatementId') as statement_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EntityResolution::PolicyStatement' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'StatementId') as statement_id, + json_extract_path_text(Properties, 'Effect') as effect, + json_extract_path_text(Properties, 'Action') as action, + json_extract_path_text(Properties, 'Principal') as principal, + json_extract_path_text(Properties, 'Condition') as condition + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EntityResolution::PolicyStatement' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'StatementId') as statement_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EntityResolution::PolicyStatement' + AND region = 'us-east-1' schema_mappings: name: schema_mappings id: aws.entityresolution.schema_mappings @@ -1892,7 +1843,7 @@ components: x-cfn-type-name: AWS::EntityResolution::SchemaMapping x-identifiers: - SchemaName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1909,9 +1860,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1921,41 +1872,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/schema_mappings/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/schema_mappings/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.SchemaName') as schema_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EntityResolution::SchemaMapping' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'SchemaName') as schema_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EntityResolution::SchemaMapping' - AND region = 'us-east-1' - schema_mapping: - name: schema_mapping - id: aws.entityresolution.schema_mapping - x-cfn-schema-name: SchemaMapping - x-cfn-type-name: AWS::EntityResolution::SchemaMapping - x-identifiers: - - SchemaName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1966,12 +1885,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/schema_mappings/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/schema_mappings/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/schema_mapping/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/schema_mappings/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1988,22 +1911,38 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'SchemaName') as schema_name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'MappedInputFields') as mapped_input_fields, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'SchemaArn') as schema_arn, - json_extract_path_text(Properties, 'CreatedAt') as created_at, - json_extract_path_text(Properties, 'UpdatedAt') as updated_at, - json_extract_path_text(Properties, 'HasWorkflows') as has_workflows - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EntityResolution::SchemaMapping' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.SchemaName') as schema_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EntityResolution::SchemaMapping' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'SchemaName') as schema_name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'MappedInputFields') as mapped_input_fields, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'SchemaArn') as schema_arn, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'UpdatedAt') as updated_at, + json_extract_path_text(Properties, 'HasWorkflows') as has_workflows + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EntityResolution::SchemaMapping' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'SchemaName') as schema_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EntityResolution::SchemaMapping' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/events.yaml b/providers/src/aws/v00.00.00000/services/events.yaml index 47041968..e568e127 100644 --- a/providers/src/aws/v00.00.00000/services/events.yaml +++ b/providers/src/aws/v00.00.00000/services/events.yaml @@ -859,12 +859,25 @@ components: uniqueItems: false items: $ref: '#/components/schemas/Tag' + Description: + description: The description of the event bus. + type: string + KmsKeyIdentifier: + description: Kms Key Identifier used to encrypt events at rest in the event bus. + type: string Policy: description: A JSON string that describes the permission policy statement for the event bus. type: object Arn: description: The Amazon Resource Name (ARN) for the event bus. type: string + DeadLetterConfig: + description: Dead Letter Queue for the event bus. + type: object + additionalProperties: false + properties: + Arn: + type: string required: - Name x-stackql-resource-name: event_bus @@ -893,6 +906,9 @@ components: - events:PutPermission - events:ListTagsForResource - events:TagResource + - kms:DescribeKey + - kms:GenerateDataKey + - kms:Decrypt read: - events:DescribeEventBus - events:ListTagsForResource @@ -901,8 +917,16 @@ components: - events:UntagResource - events:PutPermission - events:DescribeEventBus + - events:UpdateEventBus + - kms:DescribeKey + - kms:GenerateDataKey + - kms:Decrypt delete: - events:DescribeEventBus + - events:UpdateEventBus + - events:ListTagsForResource + - events:UntagResource + - events:RemovePermission - events:DeleteEventBus list: - events:ListEventBuses @@ -1511,12 +1535,25 @@ components: uniqueItems: false items: $ref: '#/components/schemas/Tag' + Description: + description: The description of the event bus. + type: string + KmsKeyIdentifier: + description: Kms Key Identifier used to encrypt events at rest in the event bus. + type: string Policy: description: A JSON string that describes the permission policy statement for the event bus. type: object Arn: description: The Amazon Resource Name (ARN) for the event bus. type: string + DeadLetterConfig: + description: Dead Letter Queue for the event bus. + type: object + additionalProperties: false + properties: + Arn: + type: string x-stackQL-stringOnly: true x-title: CreateEventBusRequest type: object @@ -1590,7 +1627,7 @@ components: x-cfn-type-name: AWS::Events::ApiDestination x-identifiers: - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1607,9 +1644,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1619,41 +1656,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/api_destinations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/api_destinations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Events::ApiDestination' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Events::ApiDestination' - AND region = 'us-east-1' - api_destination: - name: api_destination - id: aws.events.api_destination - x-cfn-schema-name: ApiDestination - x-cfn-type-name: AWS::Events::ApiDestination - x-identifiers: - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1664,12 +1669,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/api_destinations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/api_destinations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/api_destination/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/api_destinations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1685,21 +1694,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'ConnectionArn') as connection_arn, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'InvocationRateLimitPerSecond') as invocation_rate_limit_per_second, - json_extract_path_text(Properties, 'InvocationEndpoint') as invocation_endpoint, - json_extract_path_text(Properties, 'HttpMethod') as http_method - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Events::ApiDestination' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Events::ApiDestination' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'ConnectionArn') as connection_arn, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'InvocationRateLimitPerSecond') as invocation_rate_limit_per_second, + json_extract_path_text(Properties, 'InvocationEndpoint') as invocation_endpoint, + json_extract_path_text(Properties, 'HttpMethod') as http_method + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Events::ApiDestination' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Events::ApiDestination' + AND region = 'us-east-1' archives: name: archives id: aws.events.archives @@ -1707,7 +1732,7 @@ components: x-cfn-type-name: AWS::Events::Archive x-identifiers: - ArchiveName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1724,9 +1749,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1736,41 +1761,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/archives/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/archives/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ArchiveName') as archive_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Events::Archive' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ArchiveName') as archive_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Events::Archive' - AND region = 'us-east-1' - archive: - name: archive - id: aws.events.archive - x-cfn-schema-name: Archive - x-cfn-type-name: AWS::Events::Archive - x-identifiers: - - ArchiveName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1781,12 +1774,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/archives/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/archives/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/archive/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/archives/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1801,20 +1798,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ArchiveName') as archive_name, - json_extract_path_text(Properties, 'SourceArn') as source_arn, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'EventPattern') as event_pattern, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'RetentionDays') as retention_days - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Events::Archive' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ArchiveName') as archive_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Events::Archive' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ArchiveName') as archive_name, + json_extract_path_text(Properties, 'SourceArn') as source_arn, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'EventPattern') as event_pattern, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'RetentionDays') as retention_days + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Events::Archive' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ArchiveName') as archive_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Events::Archive' + AND region = 'us-east-1' connections: name: connections id: aws.events.connections @@ -1822,7 +1835,7 @@ components: x-cfn-type-name: AWS::Events::Connection x-identifiers: - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1839,9 +1852,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1851,41 +1864,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/connections/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/connections/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Events::Connection' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Events::Connection' - AND region = 'us-east-1' - connection: - name: connection - id: aws.events.connection - x-cfn-schema-name: Connection - x-cfn-type-name: AWS::Events::Connection - x-identifiers: - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1896,12 +1877,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/connections/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/connections/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/connection/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/connections/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1916,20 +1901,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'SecretArn') as secret_arn, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'AuthorizationType') as authorization_type, - json_extract_path_text(Properties, 'AuthParameters') as auth_parameters - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Events::Connection' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Events::Connection' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'SecretArn') as secret_arn, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'AuthorizationType') as authorization_type, + json_extract_path_text(Properties, 'AuthParameters') as auth_parameters + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Events::Connection' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Events::Connection' + AND region = 'us-east-1' endpoints: name: endpoints id: aws.events.endpoints @@ -1937,7 +1938,7 @@ components: x-cfn-type-name: AWS::Events::Endpoint x-identifiers: - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1954,9 +1955,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1966,41 +1967,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/endpoints/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/endpoints/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Events::Endpoint' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Events::Endpoint' - AND region = 'us-east-1' - endpoint: - name: endpoint - id: aws.events.endpoint - x-cfn-schema-name: Endpoint - x-cfn-type-name: AWS::Events::Endpoint - x-identifiers: - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2011,12 +1980,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/endpoints/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/endpoints/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/endpoint/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/endpoints/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2036,25 +2009,41 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'RoutingConfig') as routing_config, - json_extract_path_text(Properties, 'ReplicationConfig') as replication_config, - json_extract_path_text(Properties, 'EventBuses') as event_buses, - json_extract_path_text(Properties, 'EndpointId') as endpoint_id, - json_extract_path_text(Properties, 'EndpointUrl') as endpoint_url, - json_extract_path_text(Properties, 'State') as state, - json_extract_path_text(Properties, 'StateReason') as state_reason - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Events::Endpoint' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Events::Endpoint' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'RoutingConfig') as routing_config, + json_extract_path_text(Properties, 'ReplicationConfig') as replication_config, + json_extract_path_text(Properties, 'EventBuses') as event_buses, + json_extract_path_text(Properties, 'EndpointId') as endpoint_id, + json_extract_path_text(Properties, 'EndpointUrl') as endpoint_url, + json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'StateReason') as state_reason + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Events::Endpoint' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Events::Endpoint' + AND region = 'us-east-1' event_buses: name: event_buses id: aws.events.event_buses @@ -2062,7 +2051,7 @@ components: x-cfn-type-name: AWS::Events::EventBus x-identifiers: - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2079,9 +2068,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2091,41 +2080,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/event_buses/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/event_buses/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Events::EventBus' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Events::EventBus' - AND region = 'us-east-1' - event_bus: - name: event_bus - id: aws.events.event_bus - x-cfn-schema-name: EventBus - x-cfn-type-name: AWS::Events::EventBus - x-identifiers: - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2136,12 +2093,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/event_buses/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/event_buses/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/event_bus/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/event_buses/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2149,25 +2110,47 @@ components: JSON_EXTRACT(Properties, '$.EventSourceName') as event_source_name, JSON_EXTRACT(Properties, '$.Name') as name, JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.KmsKeyIdentifier') as kms_key_identifier, JSON_EXTRACT(Properties, '$.Policy') as policy, - JSON_EXTRACT(Properties, '$.Arn') as arn + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.DeadLetterConfig') as dead_letter_config FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Events::EventBus' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'EventSourceName') as event_source_name, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Policy') as policy, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Events::EventBus' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Events::EventBus' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'EventSourceName') as event_source_name, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'KmsKeyIdentifier') as kms_key_identifier, + json_extract_path_text(Properties, 'Policy') as policy, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'DeadLetterConfig') as dead_letter_config + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Events::EventBus' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Events::EventBus' + AND region = 'us-east-1' rules: name: rules id: aws.events.rules @@ -2175,7 +2158,7 @@ components: x-cfn-type-name: AWS::Events::Rule x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2192,9 +2175,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2204,41 +2187,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/rules/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/rules/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Events::Rule' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Events::Rule' - AND region = 'us-east-1' - rule: - name: rule - id: aws.events.rule - x-cfn-schema-name: Rule - x-cfn-type-name: AWS::Events::Rule - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2249,12 +2200,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/rules/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/rules/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/rule/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/rules/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2272,23 +2227,39 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'EventBusName') as event_bus_name, - json_extract_path_text(Properties, 'EventPattern') as event_pattern, - json_extract_path_text(Properties, 'ScheduleExpression') as schedule_expression, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'State') as state, - json_extract_path_text(Properties, 'Targets') as targets, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Events::Rule' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Events::Rule' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'EventBusName') as event_bus_name, + json_extract_path_text(Properties, 'EventPattern') as event_pattern, + json_extract_path_text(Properties, 'ScheduleExpression') as schedule_expression, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'Targets') as targets, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Events::Rule' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Events::Rule' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/eventschemas.yaml b/providers/src/aws/v00.00.00000/services/eventschemas.yaml index 46cbfe30..d46bf66a 100644 --- a/providers/src/aws/v00.00.00000/services/eventschemas.yaml +++ b/providers/src/aws/v00.00.00000/services/eventschemas.yaml @@ -810,7 +810,7 @@ components: x-cfn-type-name: AWS::EventSchemas::Discoverer x-identifiers: - DiscovererArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -827,9 +827,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -839,41 +839,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/discoverers/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/discoverers/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.DiscovererArn') as discoverer_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EventSchemas::Discoverer' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'DiscovererArn') as discoverer_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EventSchemas::Discoverer' - AND region = 'us-east-1' - discoverer: - name: discoverer - id: aws.eventschemas.discoverer - x-cfn-schema-name: Discoverer - x-cfn-type-name: AWS::EventSchemas::Discoverer - x-identifiers: - - DiscovererArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -884,12 +852,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/discoverers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/discoverers/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/discoverer/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/discoverers/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -905,21 +877,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'DiscovererArn') as discoverer_arn, - json_extract_path_text(Properties, 'DiscovererId') as discoverer_id, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'SourceArn') as source_arn, - json_extract_path_text(Properties, 'CrossAccount') as cross_account, - json_extract_path_text(Properties, 'State') as state, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EventSchemas::Discoverer' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.DiscovererArn') as discoverer_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EventSchemas::Discoverer' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DiscovererArn') as discoverer_arn, + json_extract_path_text(Properties, 'DiscovererId') as discoverer_id, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'SourceArn') as source_arn, + json_extract_path_text(Properties, 'CrossAccount') as cross_account, + json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EventSchemas::Discoverer' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DiscovererArn') as discoverer_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EventSchemas::Discoverer' + AND region = 'us-east-1' registries: name: registries id: aws.eventschemas.registries @@ -927,7 +915,7 @@ components: x-cfn-type-name: AWS::EventSchemas::Registry x-identifiers: - RegistryArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -944,9 +932,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -956,41 +944,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/registries/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/registries/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.RegistryArn') as registry_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EventSchemas::Registry' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'RegistryArn') as registry_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EventSchemas::Registry' - AND region = 'us-east-1' - eventschemas_registry: - name: eventschemas_registry - id: aws.eventschemas.eventschemas_registry - x-cfn-schema-name: Registry - x-cfn-type-name: AWS::EventSchemas::Registry - x-identifiers: - - RegistryArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1001,12 +957,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/registries/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/registries/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/eventschemas_registry/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/registries/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1019,18 +979,34 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'RegistryName') as registry_name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'RegistryArn') as registry_arn, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EventSchemas::Registry' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.RegistryArn') as registry_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EventSchemas::Registry' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'RegistryName') as registry_name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'RegistryArn') as registry_arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EventSchemas::Registry' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'RegistryArn') as registry_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EventSchemas::Registry' + AND region = 'us-east-1' registry_policies: name: registry_policies id: aws.eventschemas.registry_policies @@ -1038,7 +1014,7 @@ components: x-cfn-type-name: AWS::EventSchemas::RegistryPolicy x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1055,9 +1031,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1067,23 +1043,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/registry_policies/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/registry_policies/methods/delete_resource' - registry_policy: - name: registry_policy - id: aws.eventschemas.registry_policy - x-cfn-schema-name: RegistryPolicy - x-cfn-type-name: AWS::EventSchemas::RegistryPolicy - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1094,12 +1056,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/registry_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/registry_policies/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/registry_policy/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/registry_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1112,7 +1078,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1131,7 +1097,7 @@ components: x-cfn-type-name: AWS::EventSchemas::Schema x-identifiers: - SchemaArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1148,9 +1114,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1160,41 +1126,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/schemata/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/schemata/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.SchemaArn') as schema_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EventSchemas::Schema' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'SchemaArn') as schema_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EventSchemas::Schema' - AND region = 'us-east-1' - schema: - name: schema - id: aws.eventschemas.schema - x-cfn-schema-name: Schema - x-cfn-type-name: AWS::EventSchemas::Schema - x-identifiers: - - SchemaArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1205,12 +1139,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/schemata/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/schemata/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/schema/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/schemata/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1229,24 +1167,40 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Type') as type, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'SchemaVersion') as schema_version, - json_extract_path_text(Properties, 'Content') as content, - json_extract_path_text(Properties, 'RegistryName') as registry_name, - json_extract_path_text(Properties, 'SchemaArn') as schema_arn, - json_extract_path_text(Properties, 'SchemaName') as schema_name, - json_extract_path_text(Properties, 'LastModified') as last_modified, - json_extract_path_text(Properties, 'VersionCreatedDate') as version_created_date, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EventSchemas::Schema' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.SchemaArn') as schema_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EventSchemas::Schema' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'SchemaVersion') as schema_version, + json_extract_path_text(Properties, 'Content') as content, + json_extract_path_text(Properties, 'RegistryName') as registry_name, + json_extract_path_text(Properties, 'SchemaArn') as schema_arn, + json_extract_path_text(Properties, 'SchemaName') as schema_name, + json_extract_path_text(Properties, 'LastModified') as last_modified, + json_extract_path_text(Properties, 'VersionCreatedDate') as version_created_date, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::EventSchemas::Schema' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'SchemaArn') as schema_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EventSchemas::Schema' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/evidently.yaml b/providers/src/aws/v00.00.00000/services/evidently.yaml index a5268783..ca3f78c1 100644 --- a/providers/src/aws/v00.00.00000/services/evidently.yaml +++ b/providers/src/aws/v00.00.00000/services/evidently.yaml @@ -1508,7 +1508,7 @@ components: x-cfn-type-name: AWS::Evidently::Experiment x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1525,9 +1525,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1537,23 +1537,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/experiments/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/experiments/methods/delete_resource' - experiment: - name: experiment - id: aws.evidently.experiment - x-cfn-schema-name: Experiment - x-cfn-type-name: AWS::Evidently::Experiment - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1564,12 +1550,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/experiments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/experiments/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/experiment/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/experiments/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1591,7 +1581,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1619,7 +1609,7 @@ components: x-cfn-type-name: AWS::Evidently::Feature x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1636,9 +1626,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1648,23 +1638,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/features/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/features/methods/delete_resource' - feature: - name: feature - id: aws.evidently.feature - x-cfn-schema-name: Feature - x-cfn-type-name: AWS::Evidently::Feature - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1675,12 +1651,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/features/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/features/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/feature/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/features/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1698,7 +1678,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1722,7 +1702,7 @@ components: x-cfn-type-name: AWS::Evidently::Launch x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1739,9 +1719,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1751,23 +1731,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/launches/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/launches/methods/delete_resource' - launch: - name: launch - id: aws.evidently.launch - x-cfn-schema-name: Launch - x-cfn-type-name: AWS::Evidently::Launch - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1778,12 +1744,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/launches/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/launches/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/launch/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/launches/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1802,7 +1772,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1827,7 +1797,7 @@ components: x-cfn-type-name: AWS::Evidently::Project x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1844,9 +1814,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1856,23 +1826,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/projects/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/projects/methods/delete_resource' - project: - name: project - id: aws.evidently.project - x-cfn-schema-name: Project - x-cfn-type-name: AWS::Evidently::Project - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1883,12 +1839,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/projects/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/projects/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/project/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/projects/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1903,7 +1863,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1924,7 +1884,7 @@ components: x-cfn-type-name: AWS::Evidently::Segment x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1958,39 +1918,11 @@ components: - $ref: '#/components/x-stackQL-resources/segments/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/segments/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Evidently::Segment' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Evidently::Segment' - AND region = 'us-east-1' - segment: - name: segment - id: aws.evidently.segment - x-cfn-schema-name: Segment - x-cfn-type-name: AWS::Evidently::Segment - x-identifiers: - - Arn - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2004,19 +1936,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Pattern') as pattern, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Evidently::Segment' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Evidently::Segment' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Pattern') as pattern, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Evidently::Segment' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Evidently::Segment' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/finspace.yaml b/providers/src/aws/v00.00.00000/services/finspace.yaml index 085c57de..9646bbcd 100644 --- a/providers/src/aws/v00.00.00000/services/finspace.yaml +++ b/providers/src/aws/v00.00.00000/services/finspace.yaml @@ -705,7 +705,7 @@ components: x-cfn-type-name: AWS::FinSpace::Environment x-identifiers: - EnvironmentId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -722,9 +722,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -734,41 +734,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/environments/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/environments/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.EnvironmentId') as environment_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::FinSpace::Environment' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'EnvironmentId') as environment_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::FinSpace::Environment' - AND region = 'us-east-1' - environment: - name: environment - id: aws.finspace.environment - x-cfn-schema-name: Environment - x-cfn-type-name: AWS::FinSpace::Environment - x-identifiers: - - EnvironmentId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -779,12 +747,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/environments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/environments/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/environment/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/environments/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -808,29 +780,45 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'EnvironmentId') as environment_id, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'EnvironmentUrl') as environment_url, - json_extract_path_text(Properties, 'EnvironmentArn') as environment_arn, - json_extract_path_text(Properties, 'SageMakerStudioDomainUrl') as sage_maker_studio_domain_url, - json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, - json_extract_path_text(Properties, 'DedicatedServiceAccountId') as dedicated_service_account_id, - json_extract_path_text(Properties, 'FederationMode') as federation_mode, - json_extract_path_text(Properties, 'FederationParameters') as federation_parameters, - json_extract_path_text(Properties, 'SuperuserParameters') as superuser_parameters, - json_extract_path_text(Properties, 'DataBundles') as data_bundles, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::FinSpace::Environment' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.EnvironmentId') as environment_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::FinSpace::Environment' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'EnvironmentId') as environment_id, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'EnvironmentUrl') as environment_url, + json_extract_path_text(Properties, 'EnvironmentArn') as environment_arn, + json_extract_path_text(Properties, 'SageMakerStudioDomainUrl') as sage_maker_studio_domain_url, + json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, + json_extract_path_text(Properties, 'DedicatedServiceAccountId') as dedicated_service_account_id, + json_extract_path_text(Properties, 'FederationMode') as federation_mode, + json_extract_path_text(Properties, 'FederationParameters') as federation_parameters, + json_extract_path_text(Properties, 'SuperuserParameters') as superuser_parameters, + json_extract_path_text(Properties, 'DataBundles') as data_bundles, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::FinSpace::Environment' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'EnvironmentId') as environment_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::FinSpace::Environment' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/fis.yaml b/providers/src/aws/v00.00.00000/services/fis.yaml index 315884e2..2055885e 100644 --- a/providers/src/aws/v00.00.00000/services/fis.yaml +++ b/providers/src/aws/v00.00.00000/services/fis.yaml @@ -652,6 +652,15 @@ components: - Targets - RoleArn - Tags + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + permissions: + - fis:TagResource + - fis:UntagResource + - fis:ListTagsForResource x-required-permissions: create: - fis:CreateExperimentTemplate @@ -809,7 +818,7 @@ components: x-cfn-type-name: AWS::FIS::ExperimentTemplate x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -826,9 +835,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -838,41 +847,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/experiment_templates/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/experiment_templates/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::FIS::ExperimentTemplate' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::FIS::ExperimentTemplate' - AND region = 'us-east-1' - experiment_template: - name: experiment_template - id: aws.fis.experiment_template - x-cfn-schema-name: ExperimentTemplate - x-cfn-type-name: AWS::FIS::ExperimentTemplate - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -883,12 +860,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/experiment_templates/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/experiment_templates/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/experiment_template/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/experiment_templates/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -906,23 +887,39 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Targets') as targets, - json_extract_path_text(Properties, 'Actions') as actions, - json_extract_path_text(Properties, 'StopConditions') as stop_conditions, - json_extract_path_text(Properties, 'LogConfiguration') as log_configuration, - json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'ExperimentOptions') as experiment_options - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::FIS::ExperimentTemplate' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::FIS::ExperimentTemplate' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Targets') as targets, + json_extract_path_text(Properties, 'Actions') as actions, + json_extract_path_text(Properties, 'StopConditions') as stop_conditions, + json_extract_path_text(Properties, 'LogConfiguration') as log_configuration, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'ExperimentOptions') as experiment_options + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::FIS::ExperimentTemplate' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::FIS::ExperimentTemplate' + AND region = 'us-east-1' target_account_configurations: name: target_account_configurations id: aws.fis.target_account_configurations @@ -931,7 +928,7 @@ components: x-identifiers: - ExperimentTemplateId - AccountId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -948,9 +945,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -960,44 +957,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/target_account_configurations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/target_account_configurations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ExperimentTemplateId') as experiment_template_id, - JSON_EXTRACT(Properties, '$.AccountId') as account_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::FIS::TargetAccountConfiguration' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ExperimentTemplateId') as experiment_template_id, - json_extract_path_text(Properties, 'AccountId') as account_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::FIS::TargetAccountConfiguration' - AND region = 'us-east-1' - target_account_configuration: - name: target_account_configuration - id: aws.fis.target_account_configuration - x-cfn-schema-name: TargetAccountConfiguration - x-cfn-type-name: AWS::FIS::TargetAccountConfiguration - x-identifiers: - - ExperimentTemplateId - - AccountId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1008,12 +970,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/target_account_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/target_account_configurations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/target_account_configuration/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/target_account_configurations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1026,18 +992,36 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ExperimentTemplateId') as experiment_template_id, - json_extract_path_text(Properties, 'AccountId') as account_id, - json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'Description') as description - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::FIS::TargetAccountConfiguration' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.ExperimentTemplateId') as experiment_template_id, + JSON_EXTRACT(Properties, '$.AccountId') as account_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::FIS::TargetAccountConfiguration' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ExperimentTemplateId') as experiment_template_id, + json_extract_path_text(Properties, 'AccountId') as account_id, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'Description') as description + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::FIS::TargetAccountConfiguration' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ExperimentTemplateId') as experiment_template_id, + json_extract_path_text(Properties, 'AccountId') as account_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::FIS::TargetAccountConfiguration' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/fms.yaml b/providers/src/aws/v00.00.00000/services/fms.yaml index 9a2e1ffe..31934be1 100644 --- a/providers/src/aws/v00.00.00000/services/fms.yaml +++ b/providers/src/aws/v00.00.00000/services/fms.yaml @@ -511,6 +511,100 @@ components: enum: - DISTRIBUTED - CENTRALIZED + NetworkAclEntry: + description: Network ACL entry. + type: object + properties: + CidrBlock: + description: CIDR block. + type: string + pattern: ^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(\/([0-9]|[1-2][0-9]|3[0-2]))$ + Egress: + description: Whether the entry is an egress entry. + type: boolean + IcmpTypeCode: + description: ICMP type and code. + type: object + properties: + Code: + description: Code. + type: integer + minimum: 0 + maximum: 255 + Type: + description: Type. + type: integer + minimum: 0 + maximum: 255 + additionalProperties: false + required: + - Code + - Type + Ipv6CidrBlock: + type: string + description: IPv6 CIDR block. + 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,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]))(/(1[0-2]|[0-9]))?$ + PortRange: + type: object + description: Port range. + properties: + From: + description: From Port. + type: integer + minimum: 0 + maximum: 65535 + To: + description: To Port. + type: integer + minimum: 0 + maximum: 65535 + additionalProperties: false + required: + - From + - To + Protocol: + description: Protocol. + type: string + pattern: ^(tcp|udp|icmp|([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5]))$ + RuleAction: + description: Rule Action. + type: string + enum: + - allow + - deny + additionalProperties: false + required: + - Egress + - Protocol + - RuleAction + NetworkAclEntryList: + description: NetworkAcl entry list. + type: array + items: + $ref: '#/components/schemas/NetworkAclEntry' + x-insertionOrder: true + NetworkAclEntrySet: + description: Network ACL entry set. + type: object + properties: + FirstEntries: + $ref: '#/components/schemas/NetworkAclEntryList' + ForceRemediateForFirstEntries: + type: boolean + LastEntries: + $ref: '#/components/schemas/NetworkAclEntryList' + ForceRemediateForLastEntries: + type: boolean + additionalProperties: false + required: + - ForceRemediateForFirstEntries + - ForceRemediateForLastEntries + anyOf: + - required: + - FirstEntries + - required: + - LastEntries ManagedServiceData: description: Firewall managed service data. type: string @@ -530,6 +624,7 @@ components: - THIRD_PARTY_FIREWALL - DNS_FIREWALL - IMPORT_NETWORK_FIREWALL + - NETWORK_ACL_COMMON NetworkFirewallPolicy: description: Network firewall policy. type: object @@ -548,6 +643,15 @@ components: additionalProperties: false required: - FirewallDeploymentModel + NetworkAclCommonPolicy: + description: Network ACL common policy. + type: object + properties: + NetworkAclEntrySet: + $ref: '#/components/schemas/NetworkAclEntrySet' + additionalProperties: false + required: + - NetworkAclEntrySet PolicyOption: description: Firewall policy option. type: object @@ -556,12 +660,16 @@ components: $ref: '#/components/schemas/NetworkFirewallPolicy' ThirdPartyFirewallPolicy: $ref: '#/components/schemas/ThirdPartyFirewallPolicy' + NetworkAclCommonPolicy: + $ref: '#/components/schemas/NetworkAclCommonPolicy' additionalProperties: false oneOf: - required: - NetworkFirewallPolicy - required: - ThirdPartyFirewallPolicy + - required: + - NetworkAclCommonPolicy Policy: type: object properties: @@ -929,7 +1037,7 @@ components: x-cfn-type-name: AWS::FMS::NotificationChannel x-identifiers: - SnsTopicArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -946,9 +1054,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -958,41 +1066,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/notification_channels/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/notification_channels/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.SnsTopicArn') as sns_topic_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::FMS::NotificationChannel' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'SnsTopicArn') as sns_topic_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::FMS::NotificationChannel' - AND region = 'us-east-1' - notification_channel: - name: notification_channel - id: aws.fms.notification_channel - x-cfn-schema-name: NotificationChannel - x-cfn-type-name: AWS::FMS::NotificationChannel - x-identifiers: - - SnsTopicArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1003,12 +1079,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/notification_channels/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/notification_channels/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/notification_channel/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/notification_channels/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1019,16 +1099,32 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'SnsRoleName') as sns_role_name, - json_extract_path_text(Properties, 'SnsTopicArn') as sns_topic_arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::FMS::NotificationChannel' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.SnsTopicArn') as sns_topic_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::FMS::NotificationChannel' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'SnsRoleName') as sns_role_name, + json_extract_path_text(Properties, 'SnsTopicArn') as sns_topic_arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::FMS::NotificationChannel' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'SnsTopicArn') as sns_topic_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::FMS::NotificationChannel' + AND region = 'us-east-1' policies: name: policies id: aws.fms.policies @@ -1036,7 +1132,7 @@ components: x-cfn-type-name: AWS::FMS::Policy x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1053,9 +1149,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1065,41 +1161,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/policies/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/policies/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::FMS::Policy' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::FMS::Policy' - AND region = 'us-east-1' - policy: - name: policy - id: aws.fms.policy - x-cfn-schema-name: Policy - x-cfn-type-name: AWS::FMS::Policy - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1110,12 +1174,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/policies/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/policy/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1140,30 +1208,46 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ExcludeMap') as exclude_map, - json_extract_path_text(Properties, 'ExcludeResourceTags') as exclude_resource_tags, - json_extract_path_text(Properties, 'IncludeMap') as include_map, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'PolicyName') as policy_name, - json_extract_path_text(Properties, 'PolicyDescription') as policy_description, - json_extract_path_text(Properties, 'RemediationEnabled') as remediation_enabled, - json_extract_path_text(Properties, 'ResourceTags') as resource_tags, - json_extract_path_text(Properties, 'ResourceType') as resource_type, - json_extract_path_text(Properties, 'ResourceTypeList') as resource_type_list, - json_extract_path_text(Properties, 'ResourceSetIds') as resource_set_ids, - json_extract_path_text(Properties, 'SecurityServicePolicyData') as security_service_policy_data, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'DeleteAllPolicyResources') as delete_all_policy_resources, - json_extract_path_text(Properties, 'ResourcesCleanUp') as resources_clean_up, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::FMS::Policy' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::FMS::Policy' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ExcludeMap') as exclude_map, + json_extract_path_text(Properties, 'ExcludeResourceTags') as exclude_resource_tags, + json_extract_path_text(Properties, 'IncludeMap') as include_map, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'PolicyName') as policy_name, + json_extract_path_text(Properties, 'PolicyDescription') as policy_description, + json_extract_path_text(Properties, 'RemediationEnabled') as remediation_enabled, + json_extract_path_text(Properties, 'ResourceTags') as resource_tags, + json_extract_path_text(Properties, 'ResourceType') as resource_type, + json_extract_path_text(Properties, 'ResourceTypeList') as resource_type_list, + json_extract_path_text(Properties, 'ResourceSetIds') as resource_set_ids, + json_extract_path_text(Properties, 'SecurityServicePolicyData') as security_service_policy_data, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'DeleteAllPolicyResources') as delete_all_policy_resources, + json_extract_path_text(Properties, 'ResourcesCleanUp') as resources_clean_up, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::FMS::Policy' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::FMS::Policy' + AND region = 'us-east-1' resource_sets: name: resource_sets id: aws.fms.resource_sets @@ -1171,7 +1255,7 @@ components: x-cfn-type-name: AWS::FMS::ResourceSet x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1188,9 +1272,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1200,41 +1284,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/resource_sets/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/resource_sets/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::FMS::ResourceSet' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::FMS::ResourceSet' - AND region = 'us-east-1' - resource_set: - name: resource_set - id: aws.fms.resource_set - x-cfn-schema-name: ResourceSet - x-cfn-type-name: AWS::FMS::ResourceSet - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1245,12 +1297,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/resource_sets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/resource_sets/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/resource_set/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/resource_sets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1265,20 +1321,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'ResourceTypeList') as resource_type_list, - json_extract_path_text(Properties, 'Resources') as resources, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::FMS::ResourceSet' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::FMS::ResourceSet' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'ResourceTypeList') as resource_type_list, + json_extract_path_text(Properties, 'Resources') as resources, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::FMS::ResourceSet' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::FMS::ResourceSet' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/forecast.yaml b/providers/src/aws/v00.00.00000/services/forecast.yaml index 6658df7c..3f28216b 100644 --- a/providers/src/aws/v00.00.00000/services/forecast.yaml +++ b/providers/src/aws/v00.00.00000/services/forecast.yaml @@ -767,7 +767,7 @@ components: x-cfn-type-name: AWS::Forecast::Dataset x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -801,39 +801,11 @@ components: - $ref: '#/components/x-stackQL-resources/datasets/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/datasets/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Forecast::Dataset' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Forecast::Dataset' - AND region = 'us-east-1' - dataset: - name: dataset - id: aws.forecast.dataset - x-cfn-schema-name: Dataset - x-cfn-type-name: AWS::Forecast::Dataset - x-identifiers: - - Arn - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -850,22 +822,38 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'DatasetName') as dataset_name, - json_extract_path_text(Properties, 'DatasetType') as dataset_type, - json_extract_path_text(Properties, 'DataFrequency') as data_frequency, - json_extract_path_text(Properties, 'Domain') as domain, - json_extract_path_text(Properties, 'EncryptionConfig') as encryption_config, - json_extract_path_text(Properties, 'Schema') as _schema, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Forecast::Dataset' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Forecast::Dataset' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'DatasetName') as dataset_name, + json_extract_path_text(Properties, 'DatasetType') as dataset_type, + json_extract_path_text(Properties, 'DataFrequency') as data_frequency, + json_extract_path_text(Properties, 'Domain') as domain, + json_extract_path_text(Properties, 'EncryptionConfig') as encryption_config, + json_extract_path_text(Properties, 'Schema') as _schema, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Forecast::Dataset' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Forecast::Dataset' + AND region = 'us-east-1' dataset_groups: name: dataset_groups id: aws.forecast.dataset_groups @@ -873,7 +861,7 @@ components: x-cfn-type-name: AWS::Forecast::DatasetGroup x-identifiers: - DatasetGroupArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -890,9 +878,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -902,41 +890,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/dataset_groups/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/dataset_groups/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.DatasetGroupArn') as dataset_group_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Forecast::DatasetGroup' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'DatasetGroupArn') as dataset_group_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Forecast::DatasetGroup' - AND region = 'us-east-1' - dataset_group: - name: dataset_group - id: aws.forecast.dataset_group - x-cfn-schema-name: DatasetGroup - x-cfn-type-name: AWS::Forecast::DatasetGroup - x-identifiers: - - DatasetGroupArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -947,12 +903,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/dataset_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/dataset_groups/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/dataset_group/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/dataset_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -966,19 +926,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'DatasetArns') as dataset_arns, - json_extract_path_text(Properties, 'DatasetGroupName') as dataset_group_name, - json_extract_path_text(Properties, 'Domain') as domain, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'DatasetGroupArn') as dataset_group_arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Forecast::DatasetGroup' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.DatasetGroupArn') as dataset_group_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Forecast::DatasetGroup' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DatasetArns') as dataset_arns, + json_extract_path_text(Properties, 'DatasetGroupName') as dataset_group_name, + json_extract_path_text(Properties, 'Domain') as domain, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'DatasetGroupArn') as dataset_group_arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Forecast::DatasetGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DatasetGroupArn') as dataset_group_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Forecast::DatasetGroup' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/frauddetector.yaml b/providers/src/aws/v00.00.00000/services/frauddetector.yaml index ffefb332..68e2b705 100644 --- a/providers/src/aws/v00.00.00000/services/frauddetector.yaml +++ b/providers/src/aws/v00.00.00000/services/frauddetector.yaml @@ -1661,7 +1661,7 @@ components: x-cfn-type-name: AWS::FraudDetector::Label x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1678,9 +1678,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1690,41 +1690,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/labels/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/labels/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::FraudDetector::Label' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::FraudDetector::Label' - AND region = 'us-east-1' - label: - name: label - id: aws.frauddetector.label - x-cfn-schema-name: Label - x-cfn-type-name: AWS::FraudDetector::Label - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1735,12 +1703,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/labels/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/labels/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/label/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/labels/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1755,20 +1727,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'CreatedTime') as created_time, - json_extract_path_text(Properties, 'LastUpdatedTime') as last_updated_time - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::FraudDetector::Label' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::FraudDetector::Label' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'CreatedTime') as created_time, + json_extract_path_text(Properties, 'LastUpdatedTime') as last_updated_time + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::FraudDetector::Label' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::FraudDetector::Label' + AND region = 'us-east-1' outcomes: name: outcomes id: aws.frauddetector.outcomes @@ -1776,7 +1764,7 @@ components: x-cfn-type-name: AWS::FraudDetector::Outcome x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1793,9 +1781,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1805,41 +1793,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/outcomes/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/outcomes/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::FraudDetector::Outcome' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::FraudDetector::Outcome' - AND region = 'us-east-1' - outcome: - name: outcome - id: aws.frauddetector.outcome - x-cfn-schema-name: Outcome - x-cfn-type-name: AWS::FraudDetector::Outcome - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1850,12 +1806,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/outcomes/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/outcomes/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/outcome/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/outcomes/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1870,20 +1830,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'CreatedTime') as created_time, - json_extract_path_text(Properties, 'LastUpdatedTime') as last_updated_time - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::FraudDetector::Outcome' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::FraudDetector::Outcome' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'CreatedTime') as created_time, + json_extract_path_text(Properties, 'LastUpdatedTime') as last_updated_time + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::FraudDetector::Outcome' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::FraudDetector::Outcome' + AND region = 'us-east-1' event_types: name: event_types id: aws.frauddetector.event_types @@ -1891,7 +1867,7 @@ components: x-cfn-type-name: AWS::FraudDetector::EventType x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1908,9 +1884,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1920,41 +1896,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/event_types/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/event_types/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::FraudDetector::EventType' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::FraudDetector::EventType' - AND region = 'us-east-1' - event_type: - name: event_type - id: aws.frauddetector.event_type - x-cfn-schema-name: EventType - x-cfn-type-name: AWS::FraudDetector::EventType - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1965,12 +1909,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/event_types/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/event_types/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/event_type/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/event_types/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1988,23 +1936,39 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'EventVariables') as event_variables, - json_extract_path_text(Properties, 'Labels') as labels, - json_extract_path_text(Properties, 'EntityTypes') as entity_types, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'CreatedTime') as created_time, - json_extract_path_text(Properties, 'LastUpdatedTime') as last_updated_time - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::FraudDetector::EventType' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::FraudDetector::EventType' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'EventVariables') as event_variables, + json_extract_path_text(Properties, 'Labels') as labels, + json_extract_path_text(Properties, 'EntityTypes') as entity_types, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'CreatedTime') as created_time, + json_extract_path_text(Properties, 'LastUpdatedTime') as last_updated_time + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::FraudDetector::EventType' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::FraudDetector::EventType' + AND region = 'us-east-1' detectors: name: detectors id: aws.frauddetector.detectors @@ -2012,7 +1976,7 @@ components: x-cfn-type-name: AWS::FraudDetector::Detector x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2029,9 +1993,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2041,41 +2005,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/detectors/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/detectors/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::FraudDetector::Detector' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::FraudDetector::Detector' - AND region = 'us-east-1' - detector: - name: detector - id: aws.frauddetector.detector - x-cfn-schema-name: Detector - x-cfn-type-name: AWS::FraudDetector::Detector - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2086,12 +2018,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/detectors/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/detectors/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/detector/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/detectors/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2112,26 +2048,42 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'DetectorId') as detector_id, - json_extract_path_text(Properties, 'DetectorVersionStatus') as detector_version_status, - json_extract_path_text(Properties, 'DetectorVersionId') as detector_version_id, - json_extract_path_text(Properties, 'RuleExecutionMode') as rule_execution_mode, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Rules') as rules, - json_extract_path_text(Properties, 'EventType') as event_type, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'CreatedTime') as created_time, - json_extract_path_text(Properties, 'LastUpdatedTime') as last_updated_time, - json_extract_path_text(Properties, 'AssociatedModels') as associated_models - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::FraudDetector::Detector' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::FraudDetector::Detector' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DetectorId') as detector_id, + json_extract_path_text(Properties, 'DetectorVersionStatus') as detector_version_status, + json_extract_path_text(Properties, 'DetectorVersionId') as detector_version_id, + json_extract_path_text(Properties, 'RuleExecutionMode') as rule_execution_mode, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Rules') as rules, + json_extract_path_text(Properties, 'EventType') as event_type, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'CreatedTime') as created_time, + json_extract_path_text(Properties, 'LastUpdatedTime') as last_updated_time, + json_extract_path_text(Properties, 'AssociatedModels') as associated_models + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::FraudDetector::Detector' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::FraudDetector::Detector' + AND region = 'us-east-1' lists: name: lists id: aws.frauddetector.lists @@ -2139,7 +2091,7 @@ components: x-cfn-type-name: AWS::FraudDetector::List x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2156,9 +2108,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2168,41 +2120,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/lists/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/lists/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::FraudDetector::List' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::FraudDetector::List' - AND region = 'us-east-1' - frauddetector_list: - name: frauddetector_list - id: aws.frauddetector.frauddetector_list - x-cfn-schema-name: List - x-cfn-type-name: AWS::FraudDetector::List - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2213,12 +2133,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/lists/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/lists/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/frauddetector_list/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/lists/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2235,22 +2159,38 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'VariableType') as variable_type, - json_extract_path_text(Properties, 'CreatedTime') as created_time, - json_extract_path_text(Properties, 'LastUpdatedTime') as last_updated_time, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Elements') as elements - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::FraudDetector::List' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::FraudDetector::List' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'VariableType') as variable_type, + json_extract_path_text(Properties, 'CreatedTime') as created_time, + json_extract_path_text(Properties, 'LastUpdatedTime') as last_updated_time, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Elements') as elements + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::FraudDetector::List' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::FraudDetector::List' + AND region = 'us-east-1' variables: name: variables id: aws.frauddetector.variables @@ -2258,7 +2198,7 @@ components: x-cfn-type-name: AWS::FraudDetector::Variable x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2275,9 +2215,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2287,41 +2227,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/variables/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/variables/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::FraudDetector::Variable' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::FraudDetector::Variable' - AND region = 'us-east-1' - variable: - name: variable - id: aws.frauddetector.variable - x-cfn-schema-name: Variable - x-cfn-type-name: AWS::FraudDetector::Variable - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2332,12 +2240,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/variables/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/variables/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/variable/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/variables/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2356,24 +2268,40 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'DataSource') as data_source, - json_extract_path_text(Properties, 'DataType') as data_type, - json_extract_path_text(Properties, 'DefaultValue') as default_value, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'VariableType') as variable_type, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'CreatedTime') as created_time, - json_extract_path_text(Properties, 'LastUpdatedTime') as last_updated_time - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::FraudDetector::Variable' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::FraudDetector::Variable' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'DataSource') as data_source, + json_extract_path_text(Properties, 'DataType') as data_type, + json_extract_path_text(Properties, 'DefaultValue') as default_value, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'VariableType') as variable_type, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'CreatedTime') as created_time, + json_extract_path_text(Properties, 'LastUpdatedTime') as last_updated_time + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::FraudDetector::Variable' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::FraudDetector::Variable' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/fsx.yaml b/providers/src/aws/v00.00.00000/services/fsx.yaml index c1563110..8ab01f56 100644 --- a/providers/src/aws/v00.00.00000/services/fsx.yaml +++ b/providers/src/aws/v00.00.00000/services/fsx.yaml @@ -636,7 +636,7 @@ components: x-cfn-type-name: AWS::FSx::DataRepositoryAssociation x-identifiers: - AssociationId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -653,9 +653,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -665,41 +665,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/data_repository_associations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/data_repository_associations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AssociationId') as association_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::FSx::DataRepositoryAssociation' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AssociationId') as association_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::FSx::DataRepositoryAssociation' - AND region = 'us-east-1' - data_repository_association: - name: data_repository_association - id: aws.fsx.data_repository_association - x-cfn-schema-name: DataRepositoryAssociation - x-cfn-type-name: AWS::FSx::DataRepositoryAssociation - x-identifiers: - - AssociationId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -710,12 +678,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/data_repository_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/data_repository_associations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/data_repository_association/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/data_repository_associations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -733,23 +705,39 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AssociationId') as association_id, - json_extract_path_text(Properties, 'ResourceARN') as resource_arn, - json_extract_path_text(Properties, 'FileSystemId') as file_system_id, - json_extract_path_text(Properties, 'FileSystemPath') as file_system_path, - json_extract_path_text(Properties, 'DataRepositoryPath') as data_repository_path, - json_extract_path_text(Properties, 'BatchImportMetaDataOnCreate') as batch_import_meta_data_on_create, - json_extract_path_text(Properties, 'ImportedFileChunkSize') as imported_file_chunk_size, - json_extract_path_text(Properties, 'S3') as s3, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::FSx::DataRepositoryAssociation' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.AssociationId') as association_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::FSx::DataRepositoryAssociation' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AssociationId') as association_id, + json_extract_path_text(Properties, 'ResourceARN') as resource_arn, + json_extract_path_text(Properties, 'FileSystemId') as file_system_id, + json_extract_path_text(Properties, 'FileSystemPath') as file_system_path, + json_extract_path_text(Properties, 'DataRepositoryPath') as data_repository_path, + json_extract_path_text(Properties, 'BatchImportMetaDataOnCreate') as batch_import_meta_data_on_create, + json_extract_path_text(Properties, 'ImportedFileChunkSize') as imported_file_chunk_size, + json_extract_path_text(Properties, 'S3') as s3, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::FSx::DataRepositoryAssociation' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AssociationId') as association_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::FSx::DataRepositoryAssociation' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/gamelift.yaml b/providers/src/aws/v00.00.00000/services/gamelift.yaml index 59c5b7d0..e64ee6c2 100644 --- a/providers/src/aws/v00.00.00000/services/gamelift.yaml +++ b/providers/src/aws/v00.00.00000/services/gamelift.yaml @@ -536,462 +536,877 @@ components: - gamelift:DeleteBuild list: - gamelift:ListBuilds - ScalingPolicy: - description: Rule that controls how a fleet is scaled. Scaling policies are uniquely identified by the combination of name and fleet ID. + ContainerDefinition: + description: Details about a container that is used in a container fleet + type: object + properties: + ContainerName: + description: A descriptive label for the container definition. Container definition names must be unique with a container group definition. + type: string + minLength: 1 + maxLength: 128 + pattern: ^[a-zA-Z0-9-]+$ + ImageUri: + description: Specifies the image URI of this container. + type: string + minLength: 1 + maxLength: 255 + pattern: ^[a-zA-Z0-9-_\.@\/:]+$ + ResolvedImageDigest: + description: The digest of the container image. + type: string + pattern: ^sha256:[a-fA-F0-9]{64}$ + MemoryLimits: + description: Specifies how much memory is available to the container. You must specify at least this parameter or the TotalMemoryLimit parameter of the ContainerGroupDefinition. + $ref: '#/components/schemas/MemoryLimits' + PortConfiguration: + description: Defines the ports on the container. + $ref: '#/components/schemas/PortConfiguration' + Cpu: + description: The maximum number of CPU units reserved for this container. The value is expressed as an integer amount of CPU units. 1 vCPU is equal to 1024 CPU units + type: integer + minimum: 1 + maximum: 10240 + HealthCheck: + description: Specifies how the health of the containers will be checked. + $ref: '#/components/schemas/ContainerHealthCheck' + Command: + description: The command that's passed to the container. + type: array + uniqueItems: false + x-insertionOrder: true + minItems: 1 + maxItems: 20 + items: + type: string + minLength: 1 + maxLength: 255 + pattern: ^.*$ + Essential: + description: Specifies if the container is essential. If an essential container fails a health check, then all containers in the container group will be restarted. You must specify exactly 1 essential container in a container group. + type: boolean + EntryPoint: + description: The entry point that's passed to the container so that it will run as an executable. If there are multiple arguments, each argument is a string in the array. + type: array + uniqueItems: false + x-insertionOrder: true + minItems: 1 + maxItems: 20 + items: + type: string + minLength: 1 + maxLength: 1024 + WorkingDirectory: + description: The working directory to run commands inside the container in. + type: string + minLength: 1 + maxLength: 255 + pattern: ^.*$ + Environment: + description: The environment variables to pass to a container. + type: array + uniqueItems: true + x-insertionOrder: false + minItems: 1 + maxItems: 20 + items: + $ref: '#/components/schemas/ContainerEnvironment' + DependsOn: + description: A list of container dependencies that determines when this container starts up and shuts down. For container groups with multiple containers, dependencies let you define a startup/shutdown sequence across the containers. + type: array + uniqueItems: true + x-insertionOrder: true + minItems: 1 + maxItems: 10 + items: + $ref: '#/components/schemas/ContainerDependency' + required: + - ContainerName + - ImageUri additionalProperties: false + MemoryLimits: + description: Specifies how much memory is available to the container. type: object properties: - Status: - description: Current status of the scaling policy. The scaling policy can be in force only when in an ACTIVE status. Scaling policies can be suspended for individual fleets. If the policy is suspended for a fleet, the policy status does not change. + SoftLimit: + description: The amount of memory that is reserved for the container. + type: integer + minimum: 4 + maximum: 1024000 + HardLimit: + description: The hard limit of memory to reserve for the container. + type: integer + minimum: 4 + maximum: 1024000 + additionalProperties: false + PortConfiguration: + description: Defines the ports on a container. + type: object + properties: + ContainerPortRanges: + description: Specifies one or more ranges of ports on a container. + type: array + uniqueItems: true + x-insertionOrder: false + minItems: 1 + maxItems: 100 + items: + $ref: '#/components/schemas/ContainerPortRange' + required: + - ContainerPortRanges + additionalProperties: false + ContainerPortRange: + description: A set of one or more port numbers that can be opened on the container. + type: object + properties: + FromPort: + description: A starting value for the range of allowed port numbers. + type: integer + minimum: 1 + maximum: 60000 + Protocol: + description: Defines the protocol of these ports. type: string enum: - - ACTIVE - - UPDATE_REQUESTED - - UPDATING - - DELETE_REQUESTED - - DELETING - - DELETED - - ERROR - MetricName: - description: Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment. + - TCP + - UDP + ToPort: + description: An ending value for the range of allowed port numbers. Port numbers are end-inclusive. This value must be equal to or greater than FromPort. + type: integer + minimum: 1 + maximum: 60000 + required: + - FromPort + - Protocol + - ToPort + additionalProperties: false + ContainerHealthCheck: + description: Specifies how the process manager checks the health of containers. + type: object + properties: + Command: + description: A string array representing the command that the container runs to determine if it is healthy. + type: array + uniqueItems: false + x-insertionOrder: true + minItems: 1 + maxItems: 20 + items: + type: string + minLength: 1 + maxLength: 255 + pattern: ^.*$ + Interval: + description: How often (in seconds) the health is checked. + type: integer + minimum: 60 + maximum: 300 + Timeout: + description: How many seconds the process manager allows the command to run before canceling it. + type: integer + minimum: 30 + maximum: 60 + Retries: + description: How many times the process manager will retry the command after a timeout. (The first run of the command does not count as a retry.) + type: integer + minimum: 5 + maximum: 10 + StartPeriod: + description: The optional grace period (in seconds) to give a container time to boostrap before teh health check is declared failed. + type: integer + minimum: 0 + maximum: 300 + required: + - Command + additionalProperties: false + ContainerEnvironment: + description: An environment variable to set inside a container, in the form of a key-value pair. + type: object + properties: + Name: + description: The environment variable name. type: string - enum: - - ActivatingGameSessions - - ActiveGameSessions - - ActiveInstances - - AvailableGameSessions - - AvailablePlayerSessions - - CurrentPlayerSessions - - IdleInstances - - PercentAvailableGameSessions - - PercentIdleInstances - - QueueDepth - - WaitTime - - ConcurrentActivatableGameSessions - PolicyType: - description: 'The type of scaling policy to create. For a target-based policy, set the parameter MetricName to ''PercentAvailableGameSessions'' and specify a TargetConfiguration. For a rule-based policy set the following parameters: MetricName, ComparisonOperator, Threshold, EvaluationPeriods, ScalingAdjustmentType, and ScalingAdjustment.' + minLength: 1 + maxLength: 255 + pattern: ^.*$ + Value: + description: The environment variable value. type: string - enum: - - RuleBased - - TargetBased - ComparisonOperator: - description: Comparison operator to use when measuring a metric against the threshold value. + minLength: 1 + maxLength: 255 + pattern: ^.*$ + required: + - Name + - Value + additionalProperties: false + ContainerDependency: + description: A dependency that impacts a container's startup and shutdown. + type: object + properties: + ContainerName: + description: A descriptive label for the container definition. The container being defined depends on this container's condition. + type: string + minLength: 1 + maxLength: 128 + pattern: ^[a-zA-Z0-9-]+$ + Condition: + description: The type of dependency. type: string enum: - - GreaterThanOrEqualToThreshold - - GreaterThanThreshold - - LessThanThreshold - - LessThanOrEqualToThreshold - TargetConfiguration: - description: An object that contains settings for a target-based scaling policy. - $ref: '#/components/schemas/TargetConfiguration' - UpdateStatus: - description: The current status of the fleet's scaling policies in a requested fleet location. The status PENDING_UPDATE indicates that an update was requested for the fleet but has not yet been completed for the location. + - START + - COMPLETE + - SUCCESS + - HEALTHY + required: + - ContainerName + - Condition + additionalProperties: false + Tag: + description: A key-value pair to associate with a resource. + type: object + properties: + Key: + type: string + description: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length. + minLength: 1 + maxLength: 128 + Value: + type: string + description: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. + minLength: 0 + maxLength: 256 + required: + - Key + - Value + additionalProperties: false + ContainerGroupDefinition: + type: object + properties: + ContainerGroupDefinitionArn: + description: The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift container group resource and uniquely identifies it across all AWS Regions. + type: string + minLength: 1 + maxLength: 512 + pattern: ^arn:.*:containergroupdefinition/containergroupdefinition-[a-zA-Z0-9-]+$ + Name: + description: A descriptive label for the container group definition. + type: string + minLength: 1 + maxLength: 128 + pattern: ^[a-zA-Z0-9-]+$ + CreationTime: + description: A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057"). + type: string + SchedulingStrategy: + description: Specifies whether the container group includes replica or daemon containers. type: string enum: - - PENDING_UPDATE - ScalingAdjustment: - description: Amount of adjustment to make, based on the scaling adjustment type. + - REPLICA + - DAEMON + TotalMemoryLimit: + description: The maximum amount of memory (in MiB) to allocate for this container group. type: integer - EvaluationPeriods: - description: Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered. + minimum: 4 + maximum: 1024000 + TotalCpuLimit: + description: The maximum number of CPU units reserved for this container group. The value is expressed as an integer amount of CPU units. (1 vCPU is equal to 1024 CPU units.) type: integer - minimum: 1 - Location: - $ref: '#/components/schemas/Location' - Name: - minLength: 1 - description: A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique. + minimum: 128 + maximum: 10240 + ContainerDefinitions: + description: A collection of container definitions that define the containers in this group. + type: array + uniqueItems: true + x-insertionOrder: false + minItems: 1 + maxItems: 10 + items: + $ref: '#/components/schemas/ContainerDefinition' + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + minItems: 0 + maxItems: 200 + items: + $ref: '#/components/schemas/Tag' + OperatingSystem: + description: The operating system of the container group type: string - maxLength: 1024 - ScalingAdjustmentType: - description: The type of adjustment to make to a fleet's instance count. + enum: + - AMAZON_LINUX_2023 + required: + - Name + - TotalMemoryLimit + - TotalCpuLimit + - ContainerDefinitions + - OperatingSystem + x-stackql-resource-name: container_group_definition + description: The AWS::GameLift::ContainerGroupDefinition resource creates an Amazon GameLift container group definition. + x-type-name: AWS::GameLift::ContainerGroupDefinition + x-stackql-primary-identifier: + - Name + x-create-only-properties: + - Name + - SchedulingStrategy + - TotalMemoryLimit + - TotalCpuLimit + - ContainerDefinitions + - OperatingSystem + x-read-only-properties: + - ContainerGroupDefinitionArn + - CreationTime + - ContainerDefinitions/*/ResolvedImageDigest + x-required-properties: + - Name + - TotalMemoryLimit + - TotalCpuLimit + - ContainerDefinitions + - OperatingSystem + x-tagging: + taggable: true + cloudFormationSystemTags: false + tagOnCreate: true + tagUpdatable: true + tagProperty: /properties/Tags + x-required-permissions: + create: + - gamelift:CreateContainerGroupDefinition + - gamelift:DescribeContainerGroupDefinition + - gamelift:ListTagsForResource + - gamelift:TagResource + - ecr:BatchCheckLayerAvailability + - ecr:BatchGetImage + - ecr:GetDownloadUrlForLayer + - ecr:DescribeImages + read: + - gamelift:DescribeContainerGroupDefinition + - gamelift:ListTagsForResource + update: + - gamelift:ListTagsForResource + - gamelift:TagResource + - gamelift:UntagResource + delete: + - gamelift:DescribeContainerGroupDefinition + - gamelift:DeleteContainerGroupDefinition + list: + - gamelift:ListContainerGroupDefinitions + AnywhereConfiguration: + description: Configuration for Anywhere fleet. + properties: + Cost: + description: Cost of compute can be specified on Anywhere Fleets to prioritize placement across Queue destinations based on Cost. + type: string + pattern: ^\d{1,5}(?:\.\d{1,5})?$ + minLength: 1 + maxLength: 11 + additionalProperties: false + required: + - Cost + CertificateConfiguration: + description: Information about the use of a TLS/SSL certificate for a fleet. TLS certificate generation is enabled at the fleet level, with one certificate generated for the fleet. When this feature is enabled, the certificate can be retrieved using the GameLift Server SDK call GetInstanceCertificate. All instances in a fleet share the same certificate. + type: object + properties: + CertificateType: type: string enum: - - ChangeInCapacity - - ExactCapacity - - PercentChangeInCapacity - Threshold: - description: Metric value used to trigger a scaling event. - type: number + - DISABLED + - GENERATED + additionalProperties: false + required: + - CertificateType + ConnectionPortRange: + description: Defines the range of ports on the instance that allow inbound traffic to connect with containers in a fleet. + type: object + properties: + FromPort: + description: A starting value for a range of allowed port numbers. + type: integer + minimum: 1 + maximum: 60000 + ToPort: + description: An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort. + type: integer + minimum: 1 + maximum: 60000 + additionalProperties: false + required: + - FromPort + - ToPort + ContainerGroupsConfiguration: + description: Specifies container groups that this instance will hold. You must specify exactly one replica group. Optionally, you may specify exactly one daemon group. You can't change this property after you create the fleet. + type: object + properties: + ContainerGroupDefinitionNames: + description: The names of the container group definitions that will be created in an instance. You must specify exactly one REPLICA container group. You have the option to also specify one DAEMON container group. + type: array + x-insertionOrder: false + minItems: 1 + maxItems: 2 + items: + type: string + minLength: 1 + maxLength: 128 + pattern: ^[a-zA-Z0-9\-]+$ + ConnectionPortRange: + $ref: '#/components/schemas/ConnectionPortRange' + ContainerGroupsPerInstance: + $ref: '#/components/schemas/ContainerGroupsPerInstance' + additionalProperties: false required: - - MetricName - - Name - ServerProcess: - description: A set of instructions for launching server processes on each instance in a fleet. Each instruction set identifies the location of the server executable, optional launch parameters, and the number of server processes with this configuration to maintain concurrently on the instance. Server process configurations make up a fleet's RuntimeConfiguration. + - ContainerGroupDefinitionNames + - ConnectionPortRange + ContainerGroupsPerInstance: + description: The number of container groups per instance. + type: object + properties: + DesiredReplicaContainerGroupsPerInstance: + description: Use this parameter to override the number of replica container groups GameLift will launch per instance with a number that is lower than that calculated maximum. + type: integer + minimum: 1 + maximum: 5000 + MaxReplicaContainerGroupsPerInstance: + description: GameLift calculates the maximum number of replica container groups it can launch per instance based on instance properties such as CPU, memory, and connection ports. + type: integer + minimum: 1 + maximum: 5000 additionalProperties: false + IpPermission: + description: >- + A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift hosting resource. New game sessions that are started on the fleet are assigned an IP address/port number combination, which must fall into the fleet's allowed ranges. For fleets created with a custom game server, the ranges reflect the server's game session assignments. For Realtime Servers fleets, Amazon GameLift automatically opens two port ranges, one for TCP + messaging and one for UDP, for use by the Realtime servers. type: object properties: - ConcurrentExecutions: - description: The number of server processes that use this configuration to run concurrently on an instance. + FromPort: + description: A starting value for a range of allowed port numbers. type: integer minimum: 1 - Parameters: - minLength: 1 - description: An optional list of parameters to pass to the server executable or Realtime script on launch. + maximum: 60000 + IpRange: + description: 'A range of allowed IP addresses. This value must be expressed in CIDR notation. Example: "000.000.000.000/[subnet mask]" or optionally the shortened version "0.0.0.0/[subnet mask]".' type: string - maxLength: 1024 - LaunchPath: - minLength: 1 - pattern: ^([Cc]:\\game\S+|/local/game/\S+) - description: |- - The location of the server executable in a custom game build or the name of the Realtime script file that contains the Init() function. Game builds and Realtime scripts are installed on instances at the root: - - Windows (for custom game builds only): C:\game. Example: "C:\game\MyGame\server.exe" - - Linux: /local/game. Examples: "/local/game/MyGame/server.exe" or "/local/game/MyRealtimeScript.js" + 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-9]|[1-2][0-9]|3[0-2]))$) + Protocol: + description: The network communication protocol used by the fleet. type: string - maxLength: 1024 - required: - - ConcurrentExecutions - - LaunchPath - TargetConfiguration: - description: Settings for a target-based scaling policy. A target-based policy tracks a particular fleet metric specifies a target value for the metric. As player usage changes, the policy triggers Amazon GameLift to adjust capacity so that the metric returns to the target value. The target configuration specifies settings as needed for the target based policy, including the target value. + enum: + - TCP + - UDP + ToPort: + description: An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort. + type: integer + minimum: 1 + maximum: 60000 additionalProperties: false - type: object - properties: - TargetValue: - description: Desired value to use with a target-based scaling policy. The value must be relevant for whatever metric the scaling policy is using. For example, in a policy using the metric PercentAvailableGameSessions, the target value should be the preferred size of the fleet's buffer (the percent of capacity that should be idle and ready for new game sessions). - type: number required: - - TargetValue - RuntimeConfiguration: - description: >- - A collection of server process configurations that describe the processes to run on each instance in a fleet. All fleets must have a runtime configuration. Each instance in the fleet maintains server processes as specified in the runtime configuration, launching new ones as existing processes end. Each instance regularly checks for an updated runtime configuration makes adjustments as called for. - - - The runtime configuration enables the instances in a fleet to run multiple processes simultaneously. Potential scenarios are as follows: (1) Run multiple processes of a single game server executable to maximize usage of your hosting resources. (2) Run one or more processes of different executables, such as your game server and a metrics tracking program. (3) Run multiple processes of a single game server but with different launch parameters, for example to run one process on each - instance in debug mode. - - - An Amazon GameLift instance is limited to 50 processes running simultaneously. A runtime configuration must specify fewer than this limit. To calculate the total number of processes specified in a runtime configuration, add the values of the ConcurrentExecutions parameter for each ServerProcess object in the runtime configuration. - additionalProperties: false + - FromPort + - IpRange + - Protocol + - ToPort + Location: type: object properties: - ServerProcesses: - maxItems: 50 - description: A collection of server process configurations that describe which server processes to run on each instance in a fleet. - x-insertionOrder: false + LocationName: + type: string + minLength: 8 + maxLength: 64 + pattern: ^custom-[A-Za-z0-9\-]+ + LocationArn: + type: string + pattern: ^arn:.*:location/custom-\S+ + Tags: + description: An array of key-value pairs to apply to this resource. type: array + uniqueItems: true + x-insertionOrder: false + maxItems: 200 items: - $ref: '#/components/schemas/ServerProcess' - MaxConcurrentGameSessionActivations: - description: The maximum number of game sessions with status ACTIVATING to allow on an instance simultaneously. This setting limits the amount of instance resources that can be used for new game activations at any one time. - maximum: 2147483647 + $ref: '#/components/schemas/Tag' + required: + - LocationName + x-stackql-resource-name: location + description: The AWS::GameLift::Location resource creates an Amazon GameLift (GameLift) custom location. + x-type-name: AWS::GameLift::Location + x-stackql-primary-identifier: + - LocationName + x-create-only-properties: + - LocationName + x-read-only-properties: + - LocationArn + x-required-properties: + - LocationName + x-tagging: + taggable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + x-required-permissions: + create: + - gamelift:CreateLocation + - gamelift:ListLocations + - gamelift:ListTagsForResource + - gamelift:TagResource + read: + - gamelift:ListLocations + - gamelift:ListTagsForResource + delete: + - gamelift:DeleteLocation + list: + - gamelift:ListLocations + update: + - gamelift:ListLocations + - gamelift:ListTagsForResource + - gamelift:TagResource + - gamelift:UntagResource + LocationCapacity: + description: Current resource capacity settings in a specified fleet or location. The location value might refer to a fleet's remote location or its home Region. + type: object + properties: + DesiredEC2Instances: + description: The number of EC2 instances you want to maintain in the specified fleet location. This value must fall between the minimum and maximum size limits. type: integer - minimum: 1 - GameSessionActivationTimeoutSeconds: - description: The maximum amount of time (in seconds) that a game session can remain in status ACTIVATING. If the game session is not active before the timeout, activation is terminated and the game session status is changed to TERMINATED. - maximum: 600 + minimum: 0 + MinSize: + description: The minimum value allowed for the fleet's instance count for a location. When creating a new fleet, GameLift automatically sets this value to "0". After the fleet is active, you can change this value. type: integer - minimum: 1 + minimum: 0 + MaxSize: + description: The maximum value that is allowed for the fleet's instance count for a location. When creating a new fleet, GameLift automatically sets this value to "1". Once the fleet is active, you can change this value. + type: integer + minimum: 0 + additionalProperties: false + required: + - DesiredEC2Instances + - MinSize + - MaxSize LocationConfiguration: description: A remote location where a multi-location fleet can deploy EC2 instances for game hosting. - additionalProperties: false type: object properties: - LocationCapacity: - $ref: '#/components/schemas/LocationCapacity' Location: $ref: '#/components/schemas/Location' - required: - - Location - AnywhereConfiguration: - description: Configuration for Anywhere fleet. + LocationCapacity: + $ref: '#/components/schemas/LocationCapacity' additionalProperties: false - properties: - Cost: - minLength: 1 - pattern: ^\d{1,5}(?:\.\d{1,5})?$ - description: Cost of compute can be specified on Anywhere Fleets to prioritize placement across Queue destinations based on Cost. - type: string - maxLength: 11 required: - - Cost + - Location ResourceCreationLimitPolicy: description: |- A policy that limits the number of game sessions a player can create on the same fleet. This optional policy gives game owners control over how players can consume available game server resources. A resource creation policy makes the following statement: "An individual player can create a maximum number of new game sessions within a specified time period". The policy is evaluated when a player tries to create a new game session. For example, assume you have a policy of 10 new game sessions and a time period of 60 minutes. On receiving a CreateGameSession request, Amazon GameLift checks that the player (identified by CreatorId) has created fewer than 10 game sessions in the past 60 minutes. - additionalProperties: false type: object properties: - PolicyPeriodInMinutes: - description: The time span used in evaluating the resource creation limit policy. - type: integer - minimum: 0 NewGameSessionsPerCreator: description: The maximum number of game sessions that an individual can create during the policy period. type: integer minimum: 0 - LocationCapacity: - description: Current resource capacity settings in a specified fleet or location. The location value might refer to a fleet's remote location or its home Region. + PolicyPeriodInMinutes: + description: The time span used in evaluating the resource creation limit policy. + type: integer + minimum: 0 additionalProperties: false + RuntimeConfiguration: + description: >- + A collection of server process configurations that describe the processes to run on each instance in a fleet. All fleets must have a runtime configuration. Each instance in the fleet maintains server processes as specified in the runtime configuration, launching new ones as existing processes end. Each instance regularly checks for an updated runtime configuration makes adjustments as called for. + + + The runtime configuration enables the instances in a fleet to run multiple processes simultaneously. Potential scenarios are as follows: (1) Run multiple processes of a single game server executable to maximize usage of your hosting resources. (2) Run one or more processes of different executables, such as your game server and a metrics tracking program. (3) Run multiple processes of a single game server but with different launch parameters, for example to run one process on each + instance in debug mode. + + + An Amazon GameLift instance is limited to 50 processes running simultaneously. A runtime configuration must specify fewer than this limit. To calculate the total number of processes specified in a runtime configuration, add the values of the ConcurrentExecutions parameter for each ServerProcess object in the runtime configuration. type: object properties: - MinSize: - description: The minimum value allowed for the fleet's instance count for a location. When creating a new fleet, GameLift automatically sets this value to "0". After the fleet is active, you can change this value. + GameSessionActivationTimeoutSeconds: + description: The maximum amount of time (in seconds) that a game session can remain in status ACTIVATING. If the game session is not active before the timeout, activation is terminated and the game session status is changed to TERMINATED. type: integer - minimum: 0 - DesiredEC2Instances: - description: The number of EC2 instances you want to maintain in the specified fleet location. This value must fall between the minimum and maximum size limits. + minimum: 1 + maximum: 600 + MaxConcurrentGameSessionActivations: + description: The maximum number of game sessions with status ACTIVATING to allow on an instance simultaneously. This setting limits the amount of instance resources that can be used for new game activations at any one time. type: integer - minimum: 0 - MaxSize: - description: The maximum value that is allowed for the fleet's instance count for a location. When creating a new fleet, GameLift automatically sets this value to "1". Once the fleet is active, you can change this value. + minimum: 1 + maximum: 2147483647 + ServerProcesses: + description: A collection of server process configurations that describe which server processes to run on each instance in a fleet. + type: array + maxItems: 50 + items: + $ref: '#/components/schemas/ServerProcess' + x-insertionOrder: false + additionalProperties: false + ScalingPolicy: + description: Rule that controls how a fleet is scaled. Scaling policies are uniquely identified by the combination of name and fleet ID. + type: object + properties: + ComparisonOperator: + description: Comparison operator to use when measuring a metric against the threshold value. + type: string + enum: + - GreaterThanOrEqualToThreshold + - GreaterThanThreshold + - LessThanThreshold + - LessThanOrEqualToThreshold + EvaluationPeriods: + description: Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered. + type: integer + minimum: 1 + Location: + $ref: '#/components/schemas/Location' + MetricName: + description: Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment. + type: string + enum: + - ActivatingGameSessions + - ActiveGameSessions + - ActiveInstances + - AvailableGameSessions + - AvailablePlayerSessions + - CurrentPlayerSessions + - IdleInstances + - PercentAvailableGameSessions + - PercentIdleInstances + - QueueDepth + - WaitTime + - ConcurrentActivatableGameSessions + Name: + description: A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique. + type: string + minLength: 1 + maxLength: 1024 + PolicyType: + description: 'The type of scaling policy to create. For a target-based policy, set the parameter MetricName to ''PercentAvailableGameSessions'' and specify a TargetConfiguration. For a rule-based policy set the following parameters: MetricName, ComparisonOperator, Threshold, EvaluationPeriods, ScalingAdjustmentType, and ScalingAdjustment.' + type: string + enum: + - RuleBased + - TargetBased + ScalingAdjustment: + description: Amount of adjustment to make, based on the scaling adjustment type. type: integer - minimum: 0 - required: - - DesiredEC2Instances - - MinSize - - MaxSize - CertificateConfiguration: - description: Information about the use of a TLS/SSL certificate for a fleet. TLS certificate generation is enabled at the fleet level, with one certificate generated for the fleet. When this feature is enabled, the certificate can be retrieved using the GameLift Server SDK call GetInstanceCertificate. All instances in a fleet share the same certificate. - additionalProperties: false - type: object - properties: - CertificateType: + ScalingAdjustmentType: + description: The type of adjustment to make to a fleet's instance count. type: string enum: - - DISABLED - - GENERATED - required: - - CertificateType - IpPermission: - description: >- - A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift hosting resource. New game sessions that are started on the fleet are assigned an IP address/port number combination, which must fall into the fleet's allowed ranges. For fleets created with a custom game server, the ranges reflect the server's game session assignments. For Realtime Servers fleets, Amazon GameLift automatically opens two port ranges, one for TCP - messaging and one for UDP, for use by the Realtime servers. + - ChangeInCapacity + - ExactCapacity + - PercentChangeInCapacity + Status: + description: Current status of the scaling policy. The scaling policy can be in force only when in an ACTIVE status. Scaling policies can be suspended for individual fleets. If the policy is suspended for a fleet, the policy status does not change. + type: string + enum: + - ACTIVE + - UPDATE_REQUESTED + - UPDATING + - DELETE_REQUESTED + - DELETING + - DELETED + - ERROR + TargetConfiguration: + description: An object that contains settings for a target-based scaling policy. + $ref: '#/components/schemas/TargetConfiguration' + Threshold: + description: Metric value used to trigger a scaling event. + type: number + UpdateStatus: + description: The current status of the fleet's scaling policies in a requested fleet location. The status PENDING_UPDATE indicates that an update was requested for the fleet but has not yet been completed for the location. + type: string + enum: + - PENDING_UPDATE additionalProperties: false + required: + - MetricName + - Name + ServerProcess: + description: A set of instructions for launching server processes on each instance in a fleet. Each instruction set identifies the location of the server executable, optional launch parameters, and the number of server processes with this configuration to maintain concurrently on the instance. Server process configurations make up a fleet's RuntimeConfiguration. type: object properties: - IpRange: - 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-9]|[1-2][0-9]|3[0-2]))$) - description: 'A range of allowed IP addresses. This value must be expressed in CIDR notation. Example: "000.000.000.000/[subnet mask]" or optionally the shortened version "0.0.0.0/[subnet mask]".' - type: string - FromPort: - description: A starting value for a range of allowed port numbers. - maximum: 60000 - type: integer - minimum: 1 - ToPort: - description: An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort. - maximum: 60000 + ConcurrentExecutions: + description: The number of server processes that use this configuration to run concurrently on an instance. type: integer minimum: 1 - Protocol: - description: The network communication protocol used by the fleet. + LaunchPath: + description: |- + The location of the server executable in a custom game build or the name of the Realtime script file that contains the Init() function. Game builds and Realtime scripts are installed on instances at the root: + + Windows (for custom game builds only): C:\game. Example: "C:\game\MyGame\server.exe" + + Linux: /local/game. Examples: "/local/game/MyGame/server.exe" or "/local/game/MyRealtimeScript.js" type: string - enum: - - TCP - - UDP + minLength: 1 + maxLength: 1024 + pattern: ^([Cc]:\\game\S+|/local/game/\S+) + Parameters: + description: An optional list of parameters to pass to the server executable or Realtime script on launch. + type: string + minLength: 1 + maxLength: 1024 + additionalProperties: false required: - - FromPort - - IpRange - - Protocol - - ToPort - Location: + - ConcurrentExecutions + - LaunchPath + TargetConfiguration: + description: Settings for a target-based scaling policy. A target-based policy tracks a particular fleet metric specifies a target value for the metric. As player usage changes, the policy triggers Amazon GameLift to adjust capacity so that the metric returns to the target value. The target configuration specifies settings as needed for the target based policy, including the target value. type: object properties: - LocationName: - type: string - minLength: 8 - maxLength: 64 - pattern: ^custom-[A-Za-z0-9\-]+ - LocationArn: - type: string - pattern: ^arn:.*:location/custom-\S+ - Tags: - description: An array of key-value pairs to apply to this resource. - type: array - uniqueItems: true - x-insertionOrder: false - maxItems: 200 - items: - $ref: '#/components/schemas/Tag' + TargetValue: + description: Desired value to use with a target-based scaling policy. The value must be relevant for whatever metric the scaling policy is using. For example, in a policy using the metric PercentAvailableGameSessions, the target value should be the preferred size of the fleet's buffer (the percent of capacity that should be idle and ready for new game sessions). + type: number + additionalProperties: false required: - - LocationName - x-stackql-resource-name: location - description: The AWS::GameLift::Location resource creates an Amazon GameLift (GameLift) custom location. - x-type-name: AWS::GameLift::Location - x-stackql-primary-identifier: - - LocationName - x-create-only-properties: - - LocationName - x-read-only-properties: - - LocationArn - x-required-properties: - - LocationName - x-tagging: - taggable: true - cloudFormationSystemTags: false - tagProperty: /properties/Tags - x-required-permissions: - create: - - gamelift:CreateLocation - - gamelift:ListLocations - - gamelift:ListTagsForResource - - gamelift:TagResource - read: - - gamelift:ListLocations - - gamelift:ListTagsForResource - delete: - - gamelift:DeleteLocation - list: - - gamelift:ListLocations - update: - - gamelift:ListLocations - - gamelift:ListTagsForResource - - gamelift:TagResource - - gamelift:UntagResource + - TargetValue Fleet: type: object properties: ScalingPolicies: - maxItems: 50 description: A list of rules that control how a fleet is scaled. - x-insertionOrder: false type: array + maxItems: 50 items: $ref: '#/components/schemas/ScalingPolicy' - Description: - minLength: 1 - description: A human-readable description of a fleet. - type: string - maxLength: 1024 - PeerVpcId: - minLength: 1 - pattern: ^vpc-\S+ - description: A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the AWS Management Console. - type: string - maxLength: 1024 + x-insertionOrder: false + AnywhereConfiguration: + description: Configuration for Anywhere fleet. + $ref: '#/components/schemas/AnywhereConfiguration' ApplyCapacity: description: Determines whether to apply fleet or location capacities on fleet creation. type: string enum: - ON_UPDATE - ON_CREATE_AND_UPDATE - EC2InboundPermissions: - maxItems: 50 - description: A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server. - x-insertionOrder: false - type: array - items: - $ref: '#/components/schemas/IpPermission' + CertificateConfiguration: + description: Indicates whether to generate a TLS/SSL certificate for the new fleet. TLS certificates are used for encrypting traffic between game clients and game servers running on GameLift. If this parameter is not set, certificate generation is disabled. This fleet setting cannot be changed once the fleet is created. + $ref: '#/components/schemas/CertificateConfiguration' ComputeType: description: ComputeType to differentiate EC2 hardware managed by GameLift and Anywhere hardware managed by the customer. type: string enum: - EC2 - ANYWHERE - Name: - minLength: 1 - description: A descriptive label that is associated with a fleet. Fleet names do not need to be unique. + - CONTAINER + ContainerGroupsConfiguration: + $ref: '#/components/schemas/ContainerGroupsConfiguration' + Description: + description: A human-readable description of a fleet. type: string - maxLength: 1024 - AnywhereConfiguration: - description: Configuration for Anywhere fleet. - $ref: '#/components/schemas/AnywhereConfiguration' - InstanceRoleARN: minLength: 1 - pattern: ^arn:aws(-.*)?:[a-z-]+:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$ - description: A unique identifier for an AWS IAM role that manages access to your AWS services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes). Create a role or look up a role's ARN from the IAM dashboard in the AWS Management Console. - type: string - FleetId: - pattern: ^fleet-\S+ - description: Unique fleet ID - type: string - CertificateConfiguration: - description: Indicates whether to generate a TLS/SSL certificate for the new fleet. TLS certificates are used for encrypting traffic between game clients and game servers running on GameLift. If this parameter is not set, certificate generation is disabled. This fleet setting cannot be changed once the fleet is created. - $ref: '#/components/schemas/CertificateConfiguration' - InstanceRoleCredentialsProvider: - description: Credentials provider implementation that loads credentials from the Amazon EC2 Instance Metadata Service. - type: string - enum: - - SHARED_CREDENTIAL_FILE + maxLength: 1024 DesiredEC2Instances: description: '[DEPRECATED] The number of EC2 instances that you want this fleet to host. When creating a new fleet, GameLift automatically sets this value to "1" and initiates a single instance. Once the fleet is active, update this value to trigger GameLift to add or remove instances from the fleet.' type: integer minimum: 0 - ServerLaunchParameters: - minLength: 1 - description: This parameter is no longer used but is retained for backward compatibility. Instead, specify server launch parameters in the RuntimeConfiguration parameter. A request must specify either a runtime configuration or values for both ServerLaunchParameters and ServerLaunchPath. + EC2InboundPermissions: + description: A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server. + type: array + maxItems: 50 + items: + $ref: '#/components/schemas/IpPermission' + x-insertionOrder: false + EC2InstanceType: + description: The name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions. type: string - maxLength: 1024 + pattern: ^.*..*$ FleetType: description: Indicates whether to use On-Demand instances or Spot instances for this fleet. If empty, the default is ON_DEMAND. Both categories of instances use identical hardware and configurations based on the instance type selected for this fleet. type: string enum: - ON_DEMAND - SPOT + InstanceRoleARN: + description: A unique identifier for an AWS IAM role that manages access to your AWS services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes). Create a role or look up a role's ARN from the IAM dashboard in the AWS Management Console. + type: string + minLength: 1 + pattern: ^arn:aws(-.*)?:[a-z-]+:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$ + InstanceRoleCredentialsProvider: + description: Credentials provider implementation that loads credentials from the Amazon EC2 Instance Metadata Service. + type: string + enum: + - SHARED_CREDENTIAL_FILE Locations: + type: array minItems: 1 maxItems: 100 + items: + $ref: '#/components/schemas/LocationConfiguration' x-insertionOrder: false + LogPaths: + description: This parameter is no longer used. When hosting a custom game build, specify where Amazon GameLift should store log files using the Amazon GameLift server API call ProcessReady() type: array items: - $ref: '#/components/schemas/LocationConfiguration' + type: string + x-insertionOrder: false + MaxSize: + description: '[DEPRECATED] The maximum value that is allowed for the fleet''s instance count. When creating a new fleet, GameLift automatically sets this value to "1". Once the fleet is active, you can change this value.' + type: integer + minimum: 0 + MetricGroups: + description: The name of an Amazon CloudWatch metric group. A metric group aggregates the metrics for all fleets in the group. Specify a string containing the metric group name. You can use an existing name or use a new name to create a new metric group. Currently, this parameter can have only one string. + type: array + maxItems: 1 + items: + type: string + x-insertionOrder: false + MinSize: + description: '[DEPRECATED] The minimum value allowed for the fleet''s instance count. When creating a new fleet, GameLift automatically sets this value to "0". After the fleet is active, you can change this value.' + type: integer + minimum: 0 + Name: + description: A descriptive label that is associated with a fleet. Fleet names do not need to be unique. + type: string + minLength: 1 + maxLength: 1024 NewGameSessionProtectionPolicy: description: A game session protection policy to apply to all game sessions hosted on instances in this fleet. When protected, active game sessions cannot be terminated during a scale-down event. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy to affect future game sessions on the fleet. You can also set protection for individual game sessions. type: string enum: - FullProtection - NoProtection + PeerVpcAwsAccountId: + description: A unique identifier for the AWS account with the VPC that you want to peer your Amazon GameLift fleet with. You can find your account ID in the AWS Management Console under account settings. + type: string + minLength: 1 + maxLength: 1024 + pattern: ^[0-9]{12}$ + PeerVpcId: + description: A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the AWS Management Console. + type: string + minLength: 1 + maxLength: 1024 + pattern: ^vpc-\S+ + ResourceCreationLimitPolicy: + description: A policy that limits the number of game sessions an individual player can create over a span of time for this fleet. + $ref: '#/components/schemas/ResourceCreationLimitPolicy' + FleetId: + description: Unique fleet ID + type: string + pattern: ^fleet-\S+ + BuildId: + description: A unique identifier for a build to be deployed on the new fleet. If you are deploying the fleet with a custom game build, you must specify this property. The build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created. + type: string + pattern: ^build-\S+|^arn:.*:build/build-\S+ ScriptId: - pattern: ^script-\S+|^arn:.*:script/script-\S+ description: |- A unique identifier for a Realtime script to be deployed on a new Realtime Servers fleet. The script must have been successfully uploaded to Amazon GameLift. This fleet setting cannot be changed once the fleet is created. Note: It is not currently possible to use the !Ref command to reference a script created with a CloudFormation template for the fleet property ScriptId. Instead, use Fn::GetAtt Script.Arn or Fn::GetAtt Script.Id to retrieve either of these properties as input for ScriptId. Alternatively, enter a ScriptId string manually. type: string - MaxSize: - description: '[DEPRECATED] The maximum value that is allowed for the fleet''s instance count. When creating a new fleet, GameLift automatically sets this value to "1". Once the fleet is active, you can change this value.' - type: integer - minimum: 0 + pattern: ^script-\S+|^arn:.*:script/script-\S+ RuntimeConfiguration: description: |- Instructions for launching server processes on each instance in the fleet. Server processes run either a custom game build executable or a Realtime script. The runtime configuration defines the server executables or launch script file, launch parameters, and the number of processes to run concurrently on each instance. When creating a fleet, the runtime configuration must have at least one server process configuration; otherwise the request fails with an invalid request exception. This parameter is required unless the parameters ServerLaunchPath and ServerLaunchParameters are defined. Runtime configuration has replaced these parameters, but fleets that use them will continue to work. $ref: '#/components/schemas/RuntimeConfiguration' - LogPaths: - description: This parameter is no longer used. When hosting a custom game build, specify where Amazon GameLift should store log files using the Amazon GameLift server API call ProcessReady() - x-insertionOrder: false - type: array - items: - type: string - ServerLaunchPath: + ServerLaunchParameters: + description: This parameter is no longer used but is retained for backward compatibility. Instead, specify server launch parameters in the RuntimeConfiguration parameter. A request must specify either a runtime configuration or values for both ServerLaunchParameters and ServerLaunchPath. + type: string minLength: 1 + maxLength: 1024 + ServerLaunchPath: description: This parameter is no longer used. Instead, specify a server launch path using the RuntimeConfiguration parameter. Requests that specify a server launch path and launch parameters instead of a runtime configuration will continue to work. type: string - maxLength: 1024 - MinSize: - description: '[DEPRECATED] The minimum value allowed for the fleet''s instance count. When creating a new fleet, GameLift automatically sets this value to "0". After the fleet is active, you can change this value.' - type: integer - minimum: 0 - PeerVpcAwsAccountId: minLength: 1 - pattern: ^[0-9]{12}$ - description: A unique identifier for the AWS account with the VPC that you want to peer your Amazon GameLift fleet with. You can find your account ID in the AWS Management Console under account settings. - type: string maxLength: 1024 - MetricGroups: - maxItems: 1 - description: The name of an Amazon CloudWatch metric group. A metric group aggregates the metrics for all fleets in the group. Specify a string containing the metric group name. You can use an existing name or use a new name to create a new metric group. Currently, this parameter can have only one string. - x-insertionOrder: false - type: array - items: - type: string - BuildId: - pattern: ^build-\S+|^arn:.*:build/build-\S+ - description: A unique identifier for a build to be deployed on the new fleet. If you are deploying the fleet with a custom game build, you must specify this property. The build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created. - type: string - ResourceCreationLimitPolicy: - description: A policy that limits the number of game sessions an individual player can create over a span of time for this fleet. - $ref: '#/components/schemas/ResourceCreationLimitPolicy' - EC2InstanceType: - pattern: ^.*..*$ - description: The name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions. - type: string required: - Name x-stackql-resource-name: fleet @@ -1003,6 +1418,7 @@ components: - ApplyCapacity - BuildId - CertificateConfiguration + - ContainerGroupsConfiguration - EC2InstanceType - FleetType - InstanceRoleARN @@ -1017,11 +1433,20 @@ components: x-write-only-properties: - ApplyCapacity x-read-only-properties: + - ContainerGroupsConfiguration/ContainerGroupsPerInstance/MaxReplicaContainerGroupsPerInstance - FleetId x-required-properties: - Name x-taggable: true x-required-permissions: + create: + - gamelift:CreateFleet + - gamelift:DescribeFleetAttributes + - gamelift:DescribeFleetLocationAttributes + - gamelift:UpdateFleetCapacity + - gamelift:DescribeFleetLocationCapacity + - gamelift:PutScalingPolicy + - gamelift:DescribeScalingPolicies read: - gamelift:DescribeFleetAttributes - gamelift:DescribeFleetLocationAttributes @@ -1032,14 +1457,6 @@ components: - gamelift:DescribeEC2InstanceLimits - gamelift:DescribeFleetEvents - gamelift:DescribeScalingPolicies - create: - - gamelift:CreateFleet - - gamelift:DescribeFleetAttributes - - gamelift:DescribeFleetLocationAttributes - - gamelift:UpdateFleetCapacity - - gamelift:DescribeFleetLocationCapacity - - gamelift:PutScalingPolicy - - gamelift:DescribeScalingPolicies update: - gamelift:UpdateFleetAttributes - gamelift:CreateFleetLocations @@ -1053,13 +1470,13 @@ components: - gamelift:PutScalingPolicy - gamelift:DescribeScalingPolicies - gamelift:DeleteScalingPolicy - list: - - gamelift:ListFleets delete: - gamelift:DeleteFleet - gamelift:DescribeFleetLocationCapacity - gamelift:DescribeScalingPolicies - gamelift:DeleteScalingPolicy + list: + - gamelift:ListFleets AutoScalingPolicy: type: object description: Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource. @@ -1186,24 +1603,6 @@ components: minItems: 0 maxItems: 200 x-insertionOrder: false - Tag: - description: A key-value pair to associate with a resource. - type: object - properties: - Key: - type: string - description: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length. - minLength: 1 - maxLength: 128 - Value: - type: string - description: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length. - minLength: 0 - maxLength: 256 - required: - - Key - - Value - additionalProperties: false VpcSubnets: type: array description: A list of virtual private cloud (VPC) subnets to use with instances in the game server group. Updating this game server group property will not take effect for the created EC2 Auto Scaling group, please update the EC2 Auto Scaling group directly after creating the resource. @@ -1956,6 +2355,77 @@ components: x-title: CreateBuildRequest type: object required: [] + CreateContainerGroupDefinitionRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ContainerGroupDefinitionArn: + description: The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift container group resource and uniquely identifies it across all AWS Regions. + type: string + minLength: 1 + maxLength: 512 + pattern: ^arn:.*:containergroupdefinition/containergroupdefinition-[a-zA-Z0-9-]+$ + Name: + description: A descriptive label for the container group definition. + type: string + minLength: 1 + maxLength: 128 + pattern: ^[a-zA-Z0-9-]+$ + CreationTime: + description: A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057"). + type: string + SchedulingStrategy: + description: Specifies whether the container group includes replica or daemon containers. + type: string + enum: + - REPLICA + - DAEMON + TotalMemoryLimit: + description: The maximum amount of memory (in MiB) to allocate for this container group. + type: integer + minimum: 4 + maximum: 1024000 + TotalCpuLimit: + description: The maximum number of CPU units reserved for this container group. The value is expressed as an integer amount of CPU units. (1 vCPU is equal to 1024 CPU units.) + type: integer + minimum: 128 + maximum: 10240 + ContainerDefinitions: + description: A collection of container definitions that define the containers in this group. + type: array + uniqueItems: true + x-insertionOrder: false + minItems: 1 + maxItems: 10 + items: + $ref: '#/components/schemas/ContainerDefinition' + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + x-insertionOrder: false + minItems: 0 + maxItems: 200 + items: + $ref: '#/components/schemas/Tag' + OperatingSystem: + description: The operating system of the container group + type: string + enum: + - AMAZON_LINUX_2023 + x-stackQL-stringOnly: true + x-title: CreateContainerGroupDefinitionRequest + type: object + required: [] CreateLocationRequest: properties: ClientToken: @@ -2003,106 +2473,138 @@ components: type: object properties: ScalingPolicies: - maxItems: 50 description: A list of rules that control how a fleet is scaled. - x-insertionOrder: false type: array + maxItems: 50 items: $ref: '#/components/schemas/ScalingPolicy' - Description: - minLength: 1 - description: A human-readable description of a fleet. - type: string - maxLength: 1024 - PeerVpcId: - minLength: 1 - pattern: ^vpc-\S+ - description: A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the AWS Management Console. - type: string - maxLength: 1024 + x-insertionOrder: false + AnywhereConfiguration: + description: Configuration for Anywhere fleet. + $ref: '#/components/schemas/AnywhereConfiguration' ApplyCapacity: description: Determines whether to apply fleet or location capacities on fleet creation. type: string enum: - ON_UPDATE - ON_CREATE_AND_UPDATE - EC2InboundPermissions: - maxItems: 50 - description: A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server. - x-insertionOrder: false - type: array - items: - $ref: '#/components/schemas/IpPermission' + CertificateConfiguration: + description: Indicates whether to generate a TLS/SSL certificate for the new fleet. TLS certificates are used for encrypting traffic between game clients and game servers running on GameLift. If this parameter is not set, certificate generation is disabled. This fleet setting cannot be changed once the fleet is created. + $ref: '#/components/schemas/CertificateConfiguration' ComputeType: description: ComputeType to differentiate EC2 hardware managed by GameLift and Anywhere hardware managed by the customer. type: string enum: - EC2 - ANYWHERE - Name: - minLength: 1 - description: A descriptive label that is associated with a fleet. Fleet names do not need to be unique. + - CONTAINER + ContainerGroupsConfiguration: + $ref: '#/components/schemas/ContainerGroupsConfiguration' + Description: + description: A human-readable description of a fleet. type: string + minLength: 1 maxLength: 1024 - AnywhereConfiguration: - description: Configuration for Anywhere fleet. - $ref: '#/components/schemas/AnywhereConfiguration' + DesiredEC2Instances: + description: '[DEPRECATED] The number of EC2 instances that you want this fleet to host. When creating a new fleet, GameLift automatically sets this value to "1" and initiates a single instance. Once the fleet is active, update this value to trigger GameLift to add or remove instances from the fleet.' + type: integer + minimum: 0 + EC2InboundPermissions: + description: A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server. + type: array + maxItems: 50 + items: + $ref: '#/components/schemas/IpPermission' + x-insertionOrder: false + EC2InstanceType: + description: The name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions. + type: string + pattern: ^.*..*$ + FleetType: + description: Indicates whether to use On-Demand instances or Spot instances for this fleet. If empty, the default is ON_DEMAND. Both categories of instances use identical hardware and configurations based on the instance type selected for this fleet. + type: string + enum: + - ON_DEMAND + - SPOT InstanceRoleARN: - minLength: 1 - pattern: ^arn:aws(-.*)?:[a-z-]+:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$ description: A unique identifier for an AWS IAM role that manages access to your AWS services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes). Create a role or look up a role's ARN from the IAM dashboard in the AWS Management Console. type: string - FleetId: - pattern: ^fleet-\S+ - description: Unique fleet ID - type: string - CertificateConfiguration: - description: Indicates whether to generate a TLS/SSL certificate for the new fleet. TLS certificates are used for encrypting traffic between game clients and game servers running on GameLift. If this parameter is not set, certificate generation is disabled. This fleet setting cannot be changed once the fleet is created. - $ref: '#/components/schemas/CertificateConfiguration' + minLength: 1 + pattern: ^arn:aws(-.*)?:[a-z-]+:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$ InstanceRoleCredentialsProvider: description: Credentials provider implementation that loads credentials from the Amazon EC2 Instance Metadata Service. type: string enum: - SHARED_CREDENTIAL_FILE - DesiredEC2Instances: - description: '[DEPRECATED] The number of EC2 instances that you want this fleet to host. When creating a new fleet, GameLift automatically sets this value to "1" and initiates a single instance. Once the fleet is active, update this value to trigger GameLift to add or remove instances from the fleet.' + Locations: + type: array + minItems: 1 + maxItems: 100 + items: + $ref: '#/components/schemas/LocationConfiguration' + x-insertionOrder: false + LogPaths: + description: This parameter is no longer used. When hosting a custom game build, specify where Amazon GameLift should store log files using the Amazon GameLift server API call ProcessReady() + type: array + items: + type: string + x-insertionOrder: false + MaxSize: + description: '[DEPRECATED] The maximum value that is allowed for the fleet''s instance count. When creating a new fleet, GameLift automatically sets this value to "1". Once the fleet is active, you can change this value.' + type: integer + minimum: 0 + MetricGroups: + description: The name of an Amazon CloudWatch metric group. A metric group aggregates the metrics for all fleets in the group. Specify a string containing the metric group name. You can use an existing name or use a new name to create a new metric group. Currently, this parameter can have only one string. + type: array + maxItems: 1 + items: + type: string + x-insertionOrder: false + MinSize: + description: '[DEPRECATED] The minimum value allowed for the fleet''s instance count. When creating a new fleet, GameLift automatically sets this value to "0". After the fleet is active, you can change this value.' type: integer minimum: 0 - ServerLaunchParameters: - minLength: 1 - description: This parameter is no longer used but is retained for backward compatibility. Instead, specify server launch parameters in the RuntimeConfiguration parameter. A request must specify either a runtime configuration or values for both ServerLaunchParameters and ServerLaunchPath. + Name: + description: A descriptive label that is associated with a fleet. Fleet names do not need to be unique. type: string + minLength: 1 maxLength: 1024 - FleetType: - description: Indicates whether to use On-Demand instances or Spot instances for this fleet. If empty, the default is ON_DEMAND. Both categories of instances use identical hardware and configurations based on the instance type selected for this fleet. - type: string - enum: - - ON_DEMAND - - SPOT - Locations: - minItems: 1 - maxItems: 100 - x-insertionOrder: false - type: array - items: - $ref: '#/components/schemas/LocationConfiguration' NewGameSessionProtectionPolicy: description: A game session protection policy to apply to all game sessions hosted on instances in this fleet. When protected, active game sessions cannot be terminated during a scale-down event. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy to affect future game sessions on the fleet. You can also set protection for individual game sessions. type: string enum: - FullProtection - NoProtection + PeerVpcAwsAccountId: + description: A unique identifier for the AWS account with the VPC that you want to peer your Amazon GameLift fleet with. You can find your account ID in the AWS Management Console under account settings. + type: string + minLength: 1 + maxLength: 1024 + pattern: ^[0-9]{12}$ + PeerVpcId: + description: A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the AWS Management Console. + type: string + minLength: 1 + maxLength: 1024 + pattern: ^vpc-\S+ + ResourceCreationLimitPolicy: + description: A policy that limits the number of game sessions an individual player can create over a span of time for this fleet. + $ref: '#/components/schemas/ResourceCreationLimitPolicy' + FleetId: + description: Unique fleet ID + type: string + pattern: ^fleet-\S+ + BuildId: + description: A unique identifier for a build to be deployed on the new fleet. If you are deploying the fleet with a custom game build, you must specify this property. The build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created. + type: string + pattern: ^build-\S+|^arn:.*:build/build-\S+ ScriptId: - pattern: ^script-\S+|^arn:.*:script/script-\S+ description: |- A unique identifier for a Realtime script to be deployed on a new Realtime Servers fleet. The script must have been successfully uploaded to Amazon GameLift. This fleet setting cannot be changed once the fleet is created. Note: It is not currently possible to use the !Ref command to reference a script created with a CloudFormation template for the fleet property ScriptId. Instead, use Fn::GetAtt Script.Arn or Fn::GetAtt Script.Id to retrieve either of these properties as input for ScriptId. Alternatively, enter a ScriptId string manually. type: string - MaxSize: - description: '[DEPRECATED] The maximum value that is allowed for the fleet''s instance count. When creating a new fleet, GameLift automatically sets this value to "1". Once the fleet is active, you can change this value.' - type: integer - minimum: 0 + pattern: ^script-\S+|^arn:.*:script/script-\S+ RuntimeConfiguration: description: >- Instructions for launching server processes on each instance in the fleet. Server processes run either a custom game build executable or a Realtime script. The runtime configuration defines the server executables or launch script file, launch parameters, and the number of processes to run concurrently on each instance. When creating a fleet, the runtime configuration must have at least one server process configuration; otherwise the request fails with an invalid request @@ -2111,45 +2613,16 @@ components: This parameter is required unless the parameters ServerLaunchPath and ServerLaunchParameters are defined. Runtime configuration has replaced these parameters, but fleets that use them will continue to work. $ref: '#/components/schemas/RuntimeConfiguration' - LogPaths: - description: This parameter is no longer used. When hosting a custom game build, specify where Amazon GameLift should store log files using the Amazon GameLift server API call ProcessReady() - x-insertionOrder: false - type: array - items: - type: string - ServerLaunchPath: + ServerLaunchParameters: + description: This parameter is no longer used but is retained for backward compatibility. Instead, specify server launch parameters in the RuntimeConfiguration parameter. A request must specify either a runtime configuration or values for both ServerLaunchParameters and ServerLaunchPath. + type: string minLength: 1 + maxLength: 1024 + ServerLaunchPath: description: This parameter is no longer used. Instead, specify a server launch path using the RuntimeConfiguration parameter. Requests that specify a server launch path and launch parameters instead of a runtime configuration will continue to work. type: string - maxLength: 1024 - MinSize: - description: '[DEPRECATED] The minimum value allowed for the fleet''s instance count. When creating a new fleet, GameLift automatically sets this value to "0". After the fleet is active, you can change this value.' - type: integer - minimum: 0 - PeerVpcAwsAccountId: minLength: 1 - pattern: ^[0-9]{12}$ - description: A unique identifier for the AWS account with the VPC that you want to peer your Amazon GameLift fleet with. You can find your account ID in the AWS Management Console under account settings. - type: string maxLength: 1024 - MetricGroups: - maxItems: 1 - description: The name of an Amazon CloudWatch metric group. A metric group aggregates the metrics for all fleets in the group. Specify a string containing the metric group name. You can use an existing name or use a new name to create a new metric group. Currently, this parameter can have only one string. - x-insertionOrder: false - type: array - items: - type: string - BuildId: - pattern: ^build-\S+|^arn:.*:build/build-\S+ - description: A unique identifier for a build to be deployed on the new fleet. If you are deploying the fleet with a custom game build, you must specify this property. The build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created. - type: string - ResourceCreationLimitPolicy: - description: A policy that limits the number of game sessions an individual player can create over a span of time for this fleet. - $ref: '#/components/schemas/ResourceCreationLimitPolicy' - EC2InstanceType: - pattern: ^.*..*$ - description: The name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions. - type: string x-stackQL-stringOnly: true x-title: CreateFleetRequest type: object @@ -2513,7 +2986,7 @@ components: x-cfn-type-name: AWS::GameLift::Alias x-identifiers: - AliasId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2530,9 +3003,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2542,41 +3015,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/aliases/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/aliases/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AliasId') as alias_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::Alias' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AliasId') as alias_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::Alias' - AND region = 'us-east-1' - alias: - name: alias - id: aws.gamelift.alias - x-cfn-schema-name: Alias - x-cfn-type-name: AWS::GameLift::Alias - x-identifiers: - - AliasId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2587,12 +3028,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/aliases/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/aliases/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/alias/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/aliases/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2605,18 +3050,34 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'RoutingStrategy') as routing_strategy, - json_extract_path_text(Properties, 'AliasId') as alias_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::GameLift::Alias' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.AliasId') as alias_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::Alias' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'RoutingStrategy') as routing_strategy, + json_extract_path_text(Properties, 'AliasId') as alias_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::GameLift::Alias' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AliasId') as alias_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::Alias' + AND region = 'us-east-1' builds: name: builds id: aws.gamelift.builds @@ -2624,7 +3085,7 @@ components: x-cfn-type-name: AWS::GameLift::Build x-identifiers: - BuildId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2641,6 +3102,18 @@ components: response: mediaType: application/json openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GameLift::Build" + } + response: + mediaType: application/json + openAPIDocKey: '200' delete_resource: operation: $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' @@ -2658,33 +3131,80 @@ components: - $ref: '#/components/x-stackQL-resources/builds/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/builds/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/builds/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.BuildId') as build_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::Build' + data__Identifier, + JSON_EXTRACT(Properties, '$.BuildId') as build_id, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.OperatingSystem') as operating_system, + JSON_EXTRACT(Properties, '$.StorageLocation') as storage_location, + JSON_EXTRACT(Properties, '$.Version') as version, + JSON_EXTRACT(Properties, '$.ServerSdkVersion') as server_sdk_version + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::GameLift::Build' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - json_extract_path_text(Properties, 'BuildId') as build_id + JSON_EXTRACT(Properties, '$.BuildId') as build_id FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::Build' AND region = 'us-east-1' - build: - name: build - id: aws.gamelift.build - x-cfn-schema-name: Build - x-cfn-type-name: AWS::GameLift::Build + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'BuildId') as build_id, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'OperatingSystem') as operating_system, + json_extract_path_text(Properties, 'StorageLocation') as storage_location, + json_extract_path_text(Properties, 'Version') as version, + json_extract_path_text(Properties, 'ServerSdkVersion') as server_sdk_version + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::GameLift::Build' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'BuildId') as build_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::Build' + AND region = 'us-east-1' + container_group_definitions: + name: container_group_definitions + id: aws.gamelift.container_group_definitions + x-cfn-schema-name: ContainerGroupDefinition + x-cfn-type-name: AWS::GameLift::ContainerGroupDefinition x-identifiers: - - BuildId - x-type: get + - Name + x-type: cloud_control methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ContainerGroupDefinition&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GameLift::ContainerGroupDefinition" + } + response: + mediaType: application/json + openAPIDocKey: '200' update_resource: operation: $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' @@ -2692,46 +3212,84 @@ components: mediaType: application/x-amz-json-1.0 base: |- { - "TypeName": "AWS::GameLift::Build" + "TypeName": "AWS::GameLift::ContainerGroupDefinition" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::GameLift::ContainerGroupDefinition" } response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/container_group_definitions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/container_group_definitions/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/build/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/container_group_definitions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.BuildId') as build_id, + JSON_EXTRACT(Properties, '$.ContainerGroupDefinitionArn') as container_group_definition_arn, JSON_EXTRACT(Properties, '$.Name') as name, - JSON_EXTRACT(Properties, '$.OperatingSystem') as operating_system, - JSON_EXTRACT(Properties, '$.StorageLocation') as storage_location, - JSON_EXTRACT(Properties, '$.Version') as version, - JSON_EXTRACT(Properties, '$.ServerSdkVersion') as server_sdk_version - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::GameLift::Build' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.CreationTime') as creation_time, + JSON_EXTRACT(Properties, '$.SchedulingStrategy') as scheduling_strategy, + JSON_EXTRACT(Properties, '$.TotalMemoryLimit') as total_memory_limit, + JSON_EXTRACT(Properties, '$.TotalCpuLimit') as total_cpu_limit, + JSON_EXTRACT(Properties, '$.ContainerDefinitions') as container_definitions, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.OperatingSystem') as operating_system + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::GameLift::ContainerGroupDefinition' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'BuildId') as build_id, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'OperatingSystem') as operating_system, - json_extract_path_text(Properties, 'StorageLocation') as storage_location, - json_extract_path_text(Properties, 'Version') as version, - json_extract_path_text(Properties, 'ServerSdkVersion') as server_sdk_version - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::GameLift::Build' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::ContainerGroupDefinition' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ContainerGroupDefinitionArn') as container_group_definition_arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'CreationTime') as creation_time, + json_extract_path_text(Properties, 'SchedulingStrategy') as scheduling_strategy, + json_extract_path_text(Properties, 'TotalMemoryLimit') as total_memory_limit, + json_extract_path_text(Properties, 'TotalCpuLimit') as total_cpu_limit, + json_extract_path_text(Properties, 'ContainerDefinitions') as container_definitions, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'OperatingSystem') as operating_system + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::GameLift::ContainerGroupDefinition' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::ContainerGroupDefinition' + AND region = 'us-east-1' locations: name: locations id: aws.gamelift.locations @@ -2739,7 +3297,7 @@ components: x-cfn-type-name: AWS::GameLift::Location x-identifiers: - LocationName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2756,9 +3314,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2768,41 +3326,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/locations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/locations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.LocationName') as location_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::Location' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'LocationName') as location_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::Location' - AND region = 'us-east-1' - location: - name: location - id: aws.gamelift.location - x-cfn-schema-name: Location - x-cfn-type-name: AWS::GameLift::Location - x-identifiers: - - LocationName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2813,12 +3339,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/locations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/locations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/location/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/locations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2830,17 +3360,33 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'LocationName') as location_name, - json_extract_path_text(Properties, 'LocationArn') as location_arn, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::GameLift::Location' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.LocationName') as location_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::Location' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'LocationName') as location_name, + json_extract_path_text(Properties, 'LocationArn') as location_arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::GameLift::Location' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'LocationName') as location_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::Location' + AND region = 'us-east-1' fleets: name: fleets id: aws.gamelift.fleets @@ -2848,7 +3394,7 @@ components: x-cfn-type-name: AWS::GameLift::Fleet x-identifiers: - FleetId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2865,9 +3411,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2877,41 +3423,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/fleets/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/fleets/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.FleetId') as fleet_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::Fleet' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'FleetId') as fleet_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::Fleet' - AND region = 'us-east-1' - fleet: - name: fleet - id: aws.gamelift.fleet - x-cfn-schema-name: Fleet - x-cfn-type-name: AWS::GameLift::Fleet - x-identifiers: - - FleetId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2922,84 +3436,106 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/fleets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/fleets/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/fleet/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/fleets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, JSON_EXTRACT(Properties, '$.ScalingPolicies') as scaling_policies, - JSON_EXTRACT(Properties, '$.Description') as description, - JSON_EXTRACT(Properties, '$.PeerVpcId') as peer_vpc_id, - JSON_EXTRACT(Properties, '$.ApplyCapacity') as apply_capacity, - JSON_EXTRACT(Properties, '$.EC2InboundPermissions') as e_c2_inbound_permissions, - JSON_EXTRACT(Properties, '$.ComputeType') as compute_type, - JSON_EXTRACT(Properties, '$.Name') as name, JSON_EXTRACT(Properties, '$.AnywhereConfiguration') as anywhere_configuration, - JSON_EXTRACT(Properties, '$.InstanceRoleARN') as instance_role_arn, - JSON_EXTRACT(Properties, '$.FleetId') as fleet_id, + JSON_EXTRACT(Properties, '$.ApplyCapacity') as apply_capacity, JSON_EXTRACT(Properties, '$.CertificateConfiguration') as certificate_configuration, - JSON_EXTRACT(Properties, '$.InstanceRoleCredentialsProvider') as instance_role_credentials_provider, + JSON_EXTRACT(Properties, '$.ComputeType') as compute_type, + JSON_EXTRACT(Properties, '$.ContainerGroupsConfiguration') as container_groups_configuration, + JSON_EXTRACT(Properties, '$.Description') as description, JSON_EXTRACT(Properties, '$.DesiredEC2Instances') as desired_ec2_instances, - JSON_EXTRACT(Properties, '$.ServerLaunchParameters') as server_launch_parameters, + JSON_EXTRACT(Properties, '$.EC2InboundPermissions') as e_c2_inbound_permissions, + JSON_EXTRACT(Properties, '$.EC2InstanceType') as e_c2_instance_type, JSON_EXTRACT(Properties, '$.FleetType') as fleet_type, + JSON_EXTRACT(Properties, '$.InstanceRoleARN') as instance_role_arn, + JSON_EXTRACT(Properties, '$.InstanceRoleCredentialsProvider') as instance_role_credentials_provider, JSON_EXTRACT(Properties, '$.Locations') as locations, - JSON_EXTRACT(Properties, '$.NewGameSessionProtectionPolicy') as new_game_session_protection_policy, - JSON_EXTRACT(Properties, '$.ScriptId') as script_id, - JSON_EXTRACT(Properties, '$.MaxSize') as max_size, - JSON_EXTRACT(Properties, '$.RuntimeConfiguration') as runtime_configuration, JSON_EXTRACT(Properties, '$.LogPaths') as log_paths, - JSON_EXTRACT(Properties, '$.ServerLaunchPath') as server_launch_path, + JSON_EXTRACT(Properties, '$.MaxSize') as max_size, + JSON_EXTRACT(Properties, '$.MetricGroups') as metric_groups, JSON_EXTRACT(Properties, '$.MinSize') as min_size, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.NewGameSessionProtectionPolicy') as new_game_session_protection_policy, JSON_EXTRACT(Properties, '$.PeerVpcAwsAccountId') as peer_vpc_aws_account_id, - JSON_EXTRACT(Properties, '$.MetricGroups') as metric_groups, - JSON_EXTRACT(Properties, '$.BuildId') as build_id, + JSON_EXTRACT(Properties, '$.PeerVpcId') as peer_vpc_id, JSON_EXTRACT(Properties, '$.ResourceCreationLimitPolicy') as resource_creation_limit_policy, - JSON_EXTRACT(Properties, '$.EC2InstanceType') as e_c2_instance_type + JSON_EXTRACT(Properties, '$.FleetId') as fleet_id, + JSON_EXTRACT(Properties, '$.BuildId') as build_id, + JSON_EXTRACT(Properties, '$.ScriptId') as script_id, + JSON_EXTRACT(Properties, '$.RuntimeConfiguration') as runtime_configuration, + JSON_EXTRACT(Properties, '$.ServerLaunchParameters') as server_launch_parameters, + JSON_EXTRACT(Properties, '$.ServerLaunchPath') as server_launch_path FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::GameLift::Fleet' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ScalingPolicies') as scaling_policies, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'PeerVpcId') as peer_vpc_id, - json_extract_path_text(Properties, 'ApplyCapacity') as apply_capacity, - json_extract_path_text(Properties, 'EC2InboundPermissions') as e_c2_inbound_permissions, - json_extract_path_text(Properties, 'ComputeType') as compute_type, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'AnywhereConfiguration') as anywhere_configuration, - json_extract_path_text(Properties, 'InstanceRoleARN') as instance_role_arn, - json_extract_path_text(Properties, 'FleetId') as fleet_id, - json_extract_path_text(Properties, 'CertificateConfiguration') as certificate_configuration, - json_extract_path_text(Properties, 'InstanceRoleCredentialsProvider') as instance_role_credentials_provider, - json_extract_path_text(Properties, 'DesiredEC2Instances') as desired_ec2_instances, - json_extract_path_text(Properties, 'ServerLaunchParameters') as server_launch_parameters, - json_extract_path_text(Properties, 'FleetType') as fleet_type, - json_extract_path_text(Properties, 'Locations') as locations, - json_extract_path_text(Properties, 'NewGameSessionProtectionPolicy') as new_game_session_protection_policy, - json_extract_path_text(Properties, 'ScriptId') as script_id, - json_extract_path_text(Properties, 'MaxSize') as max_size, - json_extract_path_text(Properties, 'RuntimeConfiguration') as runtime_configuration, - json_extract_path_text(Properties, 'LogPaths') as log_paths, - json_extract_path_text(Properties, 'ServerLaunchPath') as server_launch_path, - json_extract_path_text(Properties, 'MinSize') as min_size, - json_extract_path_text(Properties, 'PeerVpcAwsAccountId') as peer_vpc_aws_account_id, - json_extract_path_text(Properties, 'MetricGroups') as metric_groups, - json_extract_path_text(Properties, 'BuildId') as build_id, - json_extract_path_text(Properties, 'ResourceCreationLimitPolicy') as resource_creation_limit_policy, - json_extract_path_text(Properties, 'EC2InstanceType') as e_c2_instance_type - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::GameLift::Fleet' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.FleetId') as fleet_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::Fleet' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ScalingPolicies') as scaling_policies, + json_extract_path_text(Properties, 'AnywhereConfiguration') as anywhere_configuration, + json_extract_path_text(Properties, 'ApplyCapacity') as apply_capacity, + json_extract_path_text(Properties, 'CertificateConfiguration') as certificate_configuration, + json_extract_path_text(Properties, 'ComputeType') as compute_type, + json_extract_path_text(Properties, 'ContainerGroupsConfiguration') as container_groups_configuration, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'DesiredEC2Instances') as desired_ec2_instances, + json_extract_path_text(Properties, 'EC2InboundPermissions') as e_c2_inbound_permissions, + json_extract_path_text(Properties, 'EC2InstanceType') as e_c2_instance_type, + json_extract_path_text(Properties, 'FleetType') as fleet_type, + json_extract_path_text(Properties, 'InstanceRoleARN') as instance_role_arn, + json_extract_path_text(Properties, 'InstanceRoleCredentialsProvider') as instance_role_credentials_provider, + json_extract_path_text(Properties, 'Locations') as locations, + json_extract_path_text(Properties, 'LogPaths') as log_paths, + json_extract_path_text(Properties, 'MaxSize') as max_size, + json_extract_path_text(Properties, 'MetricGroups') as metric_groups, + json_extract_path_text(Properties, 'MinSize') as min_size, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'NewGameSessionProtectionPolicy') as new_game_session_protection_policy, + json_extract_path_text(Properties, 'PeerVpcAwsAccountId') as peer_vpc_aws_account_id, + json_extract_path_text(Properties, 'PeerVpcId') as peer_vpc_id, + json_extract_path_text(Properties, 'ResourceCreationLimitPolicy') as resource_creation_limit_policy, + json_extract_path_text(Properties, 'FleetId') as fleet_id, + json_extract_path_text(Properties, 'BuildId') as build_id, + json_extract_path_text(Properties, 'ScriptId') as script_id, + json_extract_path_text(Properties, 'RuntimeConfiguration') as runtime_configuration, + json_extract_path_text(Properties, 'ServerLaunchParameters') as server_launch_parameters, + json_extract_path_text(Properties, 'ServerLaunchPath') as server_launch_path + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::GameLift::Fleet' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'FleetId') as fleet_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::Fleet' + AND region = 'us-east-1' game_server_groups: name: game_server_groups id: aws.gamelift.game_server_groups @@ -3007,7 +3543,7 @@ components: x-cfn-type-name: AWS::GameLift::GameServerGroup x-identifiers: - GameServerGroupArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3024,9 +3560,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3036,41 +3572,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/game_server_groups/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/game_server_groups/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.GameServerGroupArn') as game_server_group_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::GameServerGroup' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'GameServerGroupArn') as game_server_group_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::GameServerGroup' - AND region = 'us-east-1' - game_server_group: - name: game_server_group - id: aws.gamelift.game_server_group - x-cfn-schema-name: GameServerGroup - x-cfn-type-name: AWS::GameLift::GameServerGroup - x-identifiers: - - GameServerGroupArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3081,12 +3585,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/game_server_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/game_server_groups/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/game_server_group/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/game_server_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3109,28 +3617,44 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AutoScalingGroupArn') as auto_scaling_group_arn, - json_extract_path_text(Properties, 'AutoScalingPolicy') as auto_scaling_policy, - json_extract_path_text(Properties, 'BalancingStrategy') as balancing_strategy, - json_extract_path_text(Properties, 'DeleteOption') as delete_option, - json_extract_path_text(Properties, 'GameServerGroupArn') as game_server_group_arn, - json_extract_path_text(Properties, 'GameServerGroupName') as game_server_group_name, - json_extract_path_text(Properties, 'GameServerProtectionPolicy') as game_server_protection_policy, - json_extract_path_text(Properties, 'InstanceDefinitions') as instance_definitions, - json_extract_path_text(Properties, 'LaunchTemplate') as launch_template, - json_extract_path_text(Properties, 'MaxSize') as max_size, - json_extract_path_text(Properties, 'MinSize') as min_size, - json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'VpcSubnets') as vpc_subnets - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::GameLift::GameServerGroup' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.GameServerGroupArn') as game_server_group_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::GameServerGroup' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AutoScalingGroupArn') as auto_scaling_group_arn, + json_extract_path_text(Properties, 'AutoScalingPolicy') as auto_scaling_policy, + json_extract_path_text(Properties, 'BalancingStrategy') as balancing_strategy, + json_extract_path_text(Properties, 'DeleteOption') as delete_option, + json_extract_path_text(Properties, 'GameServerGroupArn') as game_server_group_arn, + json_extract_path_text(Properties, 'GameServerGroupName') as game_server_group_name, + json_extract_path_text(Properties, 'GameServerProtectionPolicy') as game_server_protection_policy, + json_extract_path_text(Properties, 'InstanceDefinitions') as instance_definitions, + json_extract_path_text(Properties, 'LaunchTemplate') as launch_template, + json_extract_path_text(Properties, 'MaxSize') as max_size, + json_extract_path_text(Properties, 'MinSize') as min_size, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'VpcSubnets') as vpc_subnets + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::GameLift::GameServerGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'GameServerGroupArn') as game_server_group_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::GameServerGroup' + AND region = 'us-east-1' game_session_queues: name: game_session_queues id: aws.gamelift.game_session_queues @@ -3138,7 +3662,7 @@ components: x-cfn-type-name: AWS::GameLift::GameSessionQueue x-identifiers: - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3155,9 +3679,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3167,41 +3691,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/game_session_queues/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/game_session_queues/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::GameSessionQueue' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::GameSessionQueue' - AND region = 'us-east-1' - game_session_queue: - name: game_session_queue - id: aws.gamelift.game_session_queue - x-cfn-schema-name: GameSessionQueue - x-cfn-type-name: AWS::GameLift::GameSessionQueue - x-identifiers: - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3212,12 +3704,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/game_session_queues/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/game_session_queues/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/game_session_queue/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/game_session_queues/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3236,24 +3732,40 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'TimeoutInSeconds') as timeout_in_seconds, - json_extract_path_text(Properties, 'Destinations') as destinations, - json_extract_path_text(Properties, 'PlayerLatencyPolicies') as player_latency_policies, - json_extract_path_text(Properties, 'CustomEventData') as custom_event_data, - json_extract_path_text(Properties, 'NotificationTarget') as notification_target, - json_extract_path_text(Properties, 'FilterConfiguration') as filter_configuration, - json_extract_path_text(Properties, 'PriorityConfiguration') as priority_configuration, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::GameLift::GameSessionQueue' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::GameSessionQueue' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'TimeoutInSeconds') as timeout_in_seconds, + json_extract_path_text(Properties, 'Destinations') as destinations, + json_extract_path_text(Properties, 'PlayerLatencyPolicies') as player_latency_policies, + json_extract_path_text(Properties, 'CustomEventData') as custom_event_data, + json_extract_path_text(Properties, 'NotificationTarget') as notification_target, + json_extract_path_text(Properties, 'FilterConfiguration') as filter_configuration, + json_extract_path_text(Properties, 'PriorityConfiguration') as priority_configuration, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::GameLift::GameSessionQueue' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::GameSessionQueue' + AND region = 'us-east-1' matchmaking_configurations: name: matchmaking_configurations id: aws.gamelift.matchmaking_configurations @@ -3261,7 +3773,7 @@ components: x-cfn-type-name: AWS::GameLift::MatchmakingConfiguration x-identifiers: - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3278,9 +3790,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3290,41 +3802,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/matchmaking_configurations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/matchmaking_configurations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::MatchmakingConfiguration' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::MatchmakingConfiguration' - AND region = 'us-east-1' - matchmaking_configuration: - name: matchmaking_configuration - id: aws.gamelift.matchmaking_configuration - x-cfn-schema-name: MatchmakingConfiguration - x-cfn-type-name: AWS::GameLift::MatchmakingConfiguration - x-identifiers: - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3335,12 +3815,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/matchmaking_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/matchmaking_configurations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/matchmaking_configuration/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/matchmaking_configurations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3367,32 +3851,48 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AcceptanceRequired') as acceptance_required, - json_extract_path_text(Properties, 'AcceptanceTimeoutSeconds') as acceptance_timeout_seconds, - json_extract_path_text(Properties, 'AdditionalPlayerCount') as additional_player_count, - json_extract_path_text(Properties, 'BackfillMode') as backfill_mode, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'CreationTime') as creation_time, - json_extract_path_text(Properties, 'CustomEventData') as custom_event_data, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'FlexMatchMode') as flex_match_mode, - json_extract_path_text(Properties, 'GameProperties') as game_properties, - json_extract_path_text(Properties, 'GameSessionData') as game_session_data, - json_extract_path_text(Properties, 'GameSessionQueueArns') as game_session_queue_arns, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'NotificationTarget') as notification_target, - json_extract_path_text(Properties, 'RequestTimeoutSeconds') as request_timeout_seconds, - json_extract_path_text(Properties, 'RuleSetArn') as rule_set_arn, - json_extract_path_text(Properties, 'RuleSetName') as rule_set_name, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::GameLift::MatchmakingConfiguration' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::MatchmakingConfiguration' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AcceptanceRequired') as acceptance_required, + json_extract_path_text(Properties, 'AcceptanceTimeoutSeconds') as acceptance_timeout_seconds, + json_extract_path_text(Properties, 'AdditionalPlayerCount') as additional_player_count, + json_extract_path_text(Properties, 'BackfillMode') as backfill_mode, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'CreationTime') as creation_time, + json_extract_path_text(Properties, 'CustomEventData') as custom_event_data, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'FlexMatchMode') as flex_match_mode, + json_extract_path_text(Properties, 'GameProperties') as game_properties, + json_extract_path_text(Properties, 'GameSessionData') as game_session_data, + json_extract_path_text(Properties, 'GameSessionQueueArns') as game_session_queue_arns, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'NotificationTarget') as notification_target, + json_extract_path_text(Properties, 'RequestTimeoutSeconds') as request_timeout_seconds, + json_extract_path_text(Properties, 'RuleSetArn') as rule_set_arn, + json_extract_path_text(Properties, 'RuleSetName') as rule_set_name, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::GameLift::MatchmakingConfiguration' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::MatchmakingConfiguration' + AND region = 'us-east-1' matchmaking_rule_sets: name: matchmaking_rule_sets id: aws.gamelift.matchmaking_rule_sets @@ -3400,7 +3900,7 @@ components: x-cfn-type-name: AWS::GameLift::MatchmakingRuleSet x-identifiers: - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3417,9 +3917,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3429,41 +3929,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/matchmaking_rule_sets/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/matchmaking_rule_sets/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::MatchmakingRuleSet' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::MatchmakingRuleSet' - AND region = 'us-east-1' - matchmaking_rule_set: - name: matchmaking_rule_set - id: aws.gamelift.matchmaking_rule_set - x-cfn-schema-name: MatchmakingRuleSet - x-cfn-type-name: AWS::GameLift::MatchmakingRuleSet - x-identifiers: - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3474,12 +3942,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/matchmaking_rule_sets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/matchmaking_rule_sets/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/matchmaking_rule_set/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/matchmaking_rule_sets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3493,19 +3965,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'RuleSetBody') as rule_set_body, - json_extract_path_text(Properties, 'CreationTime') as creation_time, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::GameLift::MatchmakingRuleSet' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::MatchmakingRuleSet' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'RuleSetBody') as rule_set_body, + json_extract_path_text(Properties, 'CreationTime') as creation_time, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::GameLift::MatchmakingRuleSet' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::MatchmakingRuleSet' + AND region = 'us-east-1' scripts: name: scripts id: aws.gamelift.scripts @@ -3513,7 +4001,7 @@ components: x-cfn-type-name: AWS::GameLift::Script x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3530,9 +4018,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3542,41 +4030,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/scripts/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/scripts/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::Script' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::Script' - AND region = 'us-east-1' - script: - name: script - id: aws.gamelift.script - x-cfn-schema-name: Script - x-cfn-type-name: AWS::GameLift::Script - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3587,12 +4043,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/scripts/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/scripts/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/script/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/scripts/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3609,22 +4069,38 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'StorageLocation') as storage_location, - json_extract_path_text(Properties, 'Version') as version, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'CreationTime') as creation_time, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'SizeOnDisk') as size_on_disk - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::GameLift::Script' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::Script' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'StorageLocation') as storage_location, + json_extract_path_text(Properties, 'Version') as version, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'CreationTime') as creation_time, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'SizeOnDisk') as size_on_disk + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::GameLift::Script' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GameLift::Script' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: @@ -3852,6 +4328,48 @@ paths: schema: $ref: '#/components/x-cloud-control-schemas/ProgressEvent' description: Success + /?Action=CreateResource&Version=2021-09-30&__ContainerGroupDefinition&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateContainerGroupDefinition + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateContainerGroupDefinitionRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success /?Action=CreateResource&Version=2021-09-30&__Location&__detailTransformed=true: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' diff --git a/providers/src/aws/v00.00.00000/services/globalaccelerator.yaml b/providers/src/aws/v00.00.00000/services/globalaccelerator.yaml index d4bddbfd..e51e5321 100644 --- a/providers/src/aws/v00.00.00000/services/globalaccelerator.yaml +++ b/providers/src/aws/v00.00.00000/services/globalaccelerator.yaml @@ -476,6 +476,12 @@ components: - DualStackDnsName x-required-properties: - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags x-required-permissions: create: - globalaccelerator:CreateAccelerator @@ -544,6 +550,12 @@ components: - AttachmentArn x-required-properties: - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags x-required-permissions: create: - globalaccelerator:DescribeCrossAccountAttachment @@ -672,6 +684,8 @@ components: x-required-properties: - ListenerArn - EndpointGroupRegion + x-tagging: + taggable: false x-required-permissions: create: - globalaccelerator:CreateEndpointGroup @@ -749,6 +763,8 @@ components: - AcceleratorArn - PortRanges - Protocol + x-tagging: + taggable: false x-required-permissions: create: - globalaccelerator:CreateListener @@ -997,7 +1013,7 @@ components: x-cfn-type-name: AWS::GlobalAccelerator::Accelerator x-identifiers: - AcceleratorArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1014,9 +1030,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1026,41 +1042,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/accelerators/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/accelerators/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AcceleratorArn') as accelerator_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GlobalAccelerator::Accelerator' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AcceleratorArn') as accelerator_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GlobalAccelerator::Accelerator' - AND region = 'us-east-1' - accelerator: - name: accelerator - id: aws.globalaccelerator.accelerator - x-cfn-schema-name: Accelerator - x-cfn-type-name: AWS::GlobalAccelerator::Accelerator - x-identifiers: - - AcceleratorArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1071,12 +1055,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/accelerators/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/accelerators/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/accelerator/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/accelerators/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1095,24 +1083,40 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'IpAddressType') as ip_address_type, - json_extract_path_text(Properties, 'IpAddresses') as ip_addresses, - json_extract_path_text(Properties, 'Enabled') as enabled, - json_extract_path_text(Properties, 'DnsName') as dns_name, - json_extract_path_text(Properties, 'Ipv4Addresses') as ipv4_addresses, - json_extract_path_text(Properties, 'Ipv6Addresses') as ipv6_addresses, - json_extract_path_text(Properties, 'DualStackDnsName') as dual_stack_dns_name, - json_extract_path_text(Properties, 'AcceleratorArn') as accelerator_arn, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::GlobalAccelerator::Accelerator' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.AcceleratorArn') as accelerator_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GlobalAccelerator::Accelerator' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'IpAddressType') as ip_address_type, + json_extract_path_text(Properties, 'IpAddresses') as ip_addresses, + json_extract_path_text(Properties, 'Enabled') as enabled, + json_extract_path_text(Properties, 'DnsName') as dns_name, + json_extract_path_text(Properties, 'Ipv4Addresses') as ipv4_addresses, + json_extract_path_text(Properties, 'Ipv6Addresses') as ipv6_addresses, + json_extract_path_text(Properties, 'DualStackDnsName') as dual_stack_dns_name, + json_extract_path_text(Properties, 'AcceleratorArn') as accelerator_arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::GlobalAccelerator::Accelerator' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AcceleratorArn') as accelerator_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GlobalAccelerator::Accelerator' + AND region = 'us-east-1' cross_account_attachments: name: cross_account_attachments id: aws.globalaccelerator.cross_account_attachments @@ -1120,7 +1124,7 @@ components: x-cfn-type-name: AWS::GlobalAccelerator::CrossAccountAttachment x-identifiers: - AttachmentArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1137,9 +1141,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1149,41 +1153,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/cross_account_attachments/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/cross_account_attachments/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AttachmentArn') as attachment_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GlobalAccelerator::CrossAccountAttachment' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AttachmentArn') as attachment_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GlobalAccelerator::CrossAccountAttachment' - AND region = 'us-east-1' - cross_account_attachment: - name: cross_account_attachment - id: aws.globalaccelerator.cross_account_attachment - x-cfn-schema-name: CrossAccountAttachment - x-cfn-type-name: AWS::GlobalAccelerator::CrossAccountAttachment - x-identifiers: - - AttachmentArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1194,12 +1166,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/cross_account_attachments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/cross_account_attachments/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/cross_account_attachment/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/cross_account_attachments/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1213,19 +1189,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'AttachmentArn') as attachment_arn, - json_extract_path_text(Properties, 'Principals') as principals, - json_extract_path_text(Properties, 'Resources') as resources, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::GlobalAccelerator::CrossAccountAttachment' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.AttachmentArn') as attachment_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GlobalAccelerator::CrossAccountAttachment' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'AttachmentArn') as attachment_arn, + json_extract_path_text(Properties, 'Principals') as principals, + json_extract_path_text(Properties, 'Resources') as resources, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::GlobalAccelerator::CrossAccountAttachment' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AttachmentArn') as attachment_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GlobalAccelerator::CrossAccountAttachment' + AND region = 'us-east-1' endpoint_groups: name: endpoint_groups id: aws.globalaccelerator.endpoint_groups @@ -1233,7 +1225,7 @@ components: x-cfn-type-name: AWS::GlobalAccelerator::EndpointGroup x-identifiers: - EndpointGroupArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1250,9 +1242,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1262,41 +1254,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/endpoint_groups/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/endpoint_groups/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.EndpointGroupArn') as endpoint_group_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GlobalAccelerator::EndpointGroup' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'EndpointGroupArn') as endpoint_group_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GlobalAccelerator::EndpointGroup' - AND region = 'us-east-1' - endpoint_group: - name: endpoint_group - id: aws.globalaccelerator.endpoint_group - x-cfn-schema-name: EndpointGroup - x-cfn-type-name: AWS::GlobalAccelerator::EndpointGroup - x-identifiers: - - EndpointGroupArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1307,12 +1267,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/endpoint_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/endpoint_groups/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/endpoint_group/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/endpoint_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1332,25 +1296,41 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ListenerArn') as listener_arn, - json_extract_path_text(Properties, 'EndpointGroupRegion') as endpoint_group_region, - json_extract_path_text(Properties, 'EndpointConfigurations') as endpoint_configurations, - json_extract_path_text(Properties, 'TrafficDialPercentage') as traffic_dial_percentage, - json_extract_path_text(Properties, 'HealthCheckPort') as health_check_port, - json_extract_path_text(Properties, 'HealthCheckProtocol') as health_check_protocol, - json_extract_path_text(Properties, 'HealthCheckPath') as health_check_path, - json_extract_path_text(Properties, 'HealthCheckIntervalSeconds') as health_check_interval_seconds, - json_extract_path_text(Properties, 'ThresholdCount') as threshold_count, - json_extract_path_text(Properties, 'EndpointGroupArn') as endpoint_group_arn, - json_extract_path_text(Properties, 'PortOverrides') as port_overrides - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::GlobalAccelerator::EndpointGroup' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.EndpointGroupArn') as endpoint_group_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GlobalAccelerator::EndpointGroup' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ListenerArn') as listener_arn, + json_extract_path_text(Properties, 'EndpointGroupRegion') as endpoint_group_region, + json_extract_path_text(Properties, 'EndpointConfigurations') as endpoint_configurations, + json_extract_path_text(Properties, 'TrafficDialPercentage') as traffic_dial_percentage, + json_extract_path_text(Properties, 'HealthCheckPort') as health_check_port, + json_extract_path_text(Properties, 'HealthCheckProtocol') as health_check_protocol, + json_extract_path_text(Properties, 'HealthCheckPath') as health_check_path, + json_extract_path_text(Properties, 'HealthCheckIntervalSeconds') as health_check_interval_seconds, + json_extract_path_text(Properties, 'ThresholdCount') as threshold_count, + json_extract_path_text(Properties, 'EndpointGroupArn') as endpoint_group_arn, + json_extract_path_text(Properties, 'PortOverrides') as port_overrides + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::GlobalAccelerator::EndpointGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'EndpointGroupArn') as endpoint_group_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GlobalAccelerator::EndpointGroup' + AND region = 'us-east-1' listeners: name: listeners id: aws.globalaccelerator.listeners @@ -1358,7 +1338,7 @@ components: x-cfn-type-name: AWS::GlobalAccelerator::Listener x-identifiers: - ListenerArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1375,9 +1355,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1387,41 +1367,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/listeners/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/listeners/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ListenerArn') as listener_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GlobalAccelerator::Listener' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ListenerArn') as listener_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GlobalAccelerator::Listener' - AND region = 'us-east-1' - listener: - name: listener - id: aws.globalaccelerator.listener - x-cfn-schema-name: Listener - x-cfn-type-name: AWS::GlobalAccelerator::Listener - x-identifiers: - - ListenerArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1432,12 +1380,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/listeners/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/listeners/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/listener/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/listeners/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1451,19 +1403,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ListenerArn') as listener_arn, - json_extract_path_text(Properties, 'AcceleratorArn') as accelerator_arn, - json_extract_path_text(Properties, 'PortRanges') as port_ranges, - json_extract_path_text(Properties, 'Protocol') as protocol, - json_extract_path_text(Properties, 'ClientAffinity') as client_affinity - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::GlobalAccelerator::Listener' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ListenerArn') as listener_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GlobalAccelerator::Listener' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ListenerArn') as listener_arn, + json_extract_path_text(Properties, 'AcceleratorArn') as accelerator_arn, + json_extract_path_text(Properties, 'PortRanges') as port_ranges, + json_extract_path_text(Properties, 'Protocol') as protocol, + json_extract_path_text(Properties, 'ClientAffinity') as client_affinity + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::GlobalAccelerator::Listener' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ListenerArn') as listener_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GlobalAccelerator::Listener' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/glue.yaml b/providers/src/aws/v00.00.00000/services/glue.yaml index 4a61eba4..06172270 100644 --- a/providers/src/aws/v00.00.00000/services/glue.yaml +++ b/providers/src/aws/v00.00.00000/services/glue.yaml @@ -596,7 +596,7 @@ components: x-cfn-type-name: AWS::Glue::SchemaVersion x-identifiers: - VersionId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -630,39 +630,11 @@ components: - $ref: '#/components/x-stackQL-resources/schema_versions/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/schema_versions/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.VersionId') as version_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Glue::SchemaVersion' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'VersionId') as version_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Glue::SchemaVersion' - AND region = 'us-east-1' - schema_version: - name: schema_version - id: aws.glue.schema_version - x-cfn-schema-name: SchemaVersion - x-cfn-type-name: AWS::Glue::SchemaVersion - x-identifiers: - - VersionId - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -674,17 +646,33 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Schema') as _schema, - json_extract_path_text(Properties, 'SchemaDefinition') as schema_definition, - json_extract_path_text(Properties, 'VersionId') as version_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Glue::SchemaVersion' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.VersionId') as version_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Glue::SchemaVersion' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Schema') as _schema, + json_extract_path_text(Properties, 'SchemaDefinition') as schema_definition, + json_extract_path_text(Properties, 'VersionId') as version_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Glue::SchemaVersion' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'VersionId') as version_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Glue::SchemaVersion' + AND region = 'us-east-1' schema_version_metadata: name: schema_version_metadata id: aws.glue.schema_version_metadata @@ -694,14 +682,45 @@ components: - SchemaVersionId - Key - Value - x-type: get - methods: {} + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__SchemaVersionMetadata&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Glue::SchemaVersionMetadata" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Glue::SchemaVersionMetadata" + } + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/schema_version_metadata/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/schema_version_metadata/methods/delete_resource' update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -713,17 +732,37 @@ components: AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'SchemaVersionId') as schema_version_id, - json_extract_path_text(Properties, 'Key') as key, - json_extract_path_text(Properties, 'Value') as value - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Glue::SchemaVersionMetadata' - AND data__Identifier = '||' + JSON_EXTRACT(Properties, '$.SchemaVersionId') as schema_version_id, + JSON_EXTRACT(Properties, '$.Key') as key, + JSON_EXTRACT(Properties, '$.Value') as value + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Glue::SchemaVersionMetadata' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'SchemaVersionId') as schema_version_id, + json_extract_path_text(Properties, 'Key') as key, + json_extract_path_text(Properties, 'Value') as value + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Glue::SchemaVersionMetadata' + AND data__Identifier = '||' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'SchemaVersionId') as schema_version_id, + json_extract_path_text(Properties, 'Key') as key, + json_extract_path_text(Properties, 'Value') as value + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Glue::SchemaVersionMetadata' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/grafana.yaml b/providers/src/aws/v00.00.00000/services/grafana.yaml index d8ac9575..ed2206ec 100644 --- a/providers/src/aws/v00.00.00000/services/grafana.yaml +++ b/providers/src/aws/v00.00.00000/services/grafana.yaml @@ -904,7 +904,7 @@ components: x-cfn-type-name: AWS::Grafana::Workspace x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -921,9 +921,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -933,41 +933,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/workspaces/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/workspaces/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Grafana::Workspace' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Grafana::Workspace' - AND region = 'us-east-1' - workspace: - name: workspace - id: aws.grafana.workspace - x-cfn-schema-name: Workspace - x-cfn-type-name: AWS::Grafana::Workspace - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -978,12 +946,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/workspaces/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/workspaces/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/workspace/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/workspaces/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1016,38 +988,54 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AuthenticationProviders') as authentication_providers, - json_extract_path_text(Properties, 'SsoClientId') as sso_client_id, - json_extract_path_text(Properties, 'SamlConfiguration') as saml_configuration, - json_extract_path_text(Properties, 'NetworkAccessControl') as network_access_control, - json_extract_path_text(Properties, 'VpcConfiguration') as vpc_configuration, - json_extract_path_text(Properties, 'SamlConfigurationStatus') as saml_configuration_status, - json_extract_path_text(Properties, 'ClientToken') as client_token, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'CreationTimestamp') as creation_timestamp, - json_extract_path_text(Properties, 'ModificationTimestamp') as modification_timestamp, - json_extract_path_text(Properties, 'GrafanaVersion') as grafana_version, - json_extract_path_text(Properties, 'Endpoint') as endpoint, - json_extract_path_text(Properties, 'AccountAccessType') as account_access_type, - json_extract_path_text(Properties, 'OrganizationRoleName') as organization_role_name, - json_extract_path_text(Properties, 'PermissionType') as permission_type, - json_extract_path_text(Properties, 'StackSetName') as stack_set_name, - json_extract_path_text(Properties, 'DataSources') as data_sources, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'NotificationDestinations') as notification_destinations, - json_extract_path_text(Properties, 'OrganizationalUnits') as organizational_units, - json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'PluginAdminEnabled') as plugin_admin_enabled - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Grafana::Workspace' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Grafana::Workspace' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AuthenticationProviders') as authentication_providers, + json_extract_path_text(Properties, 'SsoClientId') as sso_client_id, + json_extract_path_text(Properties, 'SamlConfiguration') as saml_configuration, + json_extract_path_text(Properties, 'NetworkAccessControl') as network_access_control, + json_extract_path_text(Properties, 'VpcConfiguration') as vpc_configuration, + json_extract_path_text(Properties, 'SamlConfigurationStatus') as saml_configuration_status, + json_extract_path_text(Properties, 'ClientToken') as client_token, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'CreationTimestamp') as creation_timestamp, + json_extract_path_text(Properties, 'ModificationTimestamp') as modification_timestamp, + json_extract_path_text(Properties, 'GrafanaVersion') as grafana_version, + json_extract_path_text(Properties, 'Endpoint') as endpoint, + json_extract_path_text(Properties, 'AccountAccessType') as account_access_type, + json_extract_path_text(Properties, 'OrganizationRoleName') as organization_role_name, + json_extract_path_text(Properties, 'PermissionType') as permission_type, + json_extract_path_text(Properties, 'StackSetName') as stack_set_name, + json_extract_path_text(Properties, 'DataSources') as data_sources, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'NotificationDestinations') as notification_destinations, + json_extract_path_text(Properties, 'OrganizationalUnits') as organizational_units, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'PluginAdminEnabled') as plugin_admin_enabled + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Grafana::Workspace' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Grafana::Workspace' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/greengrassv2.yaml b/providers/src/aws/v00.00.00000/services/greengrassv2.yaml index ba68f621..e99933ce 100644 --- a/providers/src/aws/v00.00.00000/services/greengrassv2.yaml +++ b/providers/src/aws/v00.00.00000/services/greengrassv2.yaml @@ -988,7 +988,7 @@ components: x-cfn-type-name: AWS::GreengrassV2::ComponentVersion x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1005,9 +1005,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1017,41 +1017,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/component_versions/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/component_versions/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GreengrassV2::ComponentVersion' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GreengrassV2::ComponentVersion' - AND region = 'us-east-1' - component_version: - name: component_version - id: aws.greengrassv2.component_version - x-cfn-schema-name: ComponentVersion - x-cfn-type-name: AWS::GreengrassV2::ComponentVersion - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1062,12 +1030,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/component_versions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/component_versions/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/component_version/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/component_versions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1082,20 +1054,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'ComponentName') as component_name, - json_extract_path_text(Properties, 'ComponentVersion') as component_version, - json_extract_path_text(Properties, 'InlineRecipe') as inline_recipe, - json_extract_path_text(Properties, 'LambdaFunction') as lambda_function, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::GreengrassV2::ComponentVersion' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GreengrassV2::ComponentVersion' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'ComponentName') as component_name, + json_extract_path_text(Properties, 'ComponentVersion') as component_version, + json_extract_path_text(Properties, 'InlineRecipe') as inline_recipe, + json_extract_path_text(Properties, 'LambdaFunction') as lambda_function, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::GreengrassV2::ComponentVersion' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GreengrassV2::ComponentVersion' + AND region = 'us-east-1' deployments: name: deployments id: aws.greengrassv2.deployments @@ -1103,7 +1091,7 @@ components: x-cfn-type-name: AWS::GreengrassV2::Deployment x-identifiers: - DeploymentId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1120,9 +1108,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1132,41 +1120,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/deployments/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/deployments/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.DeploymentId') as deployment_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GreengrassV2::Deployment' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'DeploymentId') as deployment_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GreengrassV2::Deployment' - AND region = 'us-east-1' - deployment: - name: deployment - id: aws.greengrassv2.deployment - x-cfn-schema-name: Deployment - x-cfn-type-name: AWS::GreengrassV2::Deployment - x-identifiers: - - DeploymentId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1177,12 +1133,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/deployments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/deployments/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/deployment/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/deployments/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1199,22 +1159,38 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'TargetArn') as target_arn, - json_extract_path_text(Properties, 'ParentTargetArn') as parent_target_arn, - json_extract_path_text(Properties, 'DeploymentId') as deployment_id, - json_extract_path_text(Properties, 'DeploymentName') as deployment_name, - json_extract_path_text(Properties, 'Components') as components, - json_extract_path_text(Properties, 'IotJobConfiguration') as iot_job_configuration, - json_extract_path_text(Properties, 'DeploymentPolicies') as deployment_policies, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::GreengrassV2::Deployment' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.DeploymentId') as deployment_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GreengrassV2::Deployment' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'TargetArn') as target_arn, + json_extract_path_text(Properties, 'ParentTargetArn') as parent_target_arn, + json_extract_path_text(Properties, 'DeploymentId') as deployment_id, + json_extract_path_text(Properties, 'DeploymentName') as deployment_name, + json_extract_path_text(Properties, 'Components') as components, + json_extract_path_text(Properties, 'IotJobConfiguration') as iot_job_configuration, + json_extract_path_text(Properties, 'DeploymentPolicies') as deployment_policies, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::GreengrassV2::Deployment' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DeploymentId') as deployment_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GreengrassV2::Deployment' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/groundstation.yaml b/providers/src/aws/v00.00.00000/services/groundstation.yaml index 24b18689..6ba7c21e 100644 --- a/providers/src/aws/v00.00.00000/services/groundstation.yaml +++ b/providers/src/aws/v00.00.00000/services/groundstation.yaml @@ -459,8 +459,10 @@ components: pattern: ^([a-zA-Z0-9_\-=/]|\{satellite_id\}|\{config\-name}|\{s3\-config-id}|\{year\}|\{month\}|\{day\}){1,900}$ BucketArn: type: string + pattern: ^arn:aws[A-Za-z0-9-]{0,64}:s3:::[A-Za-z0-9-]{1,64}$ RoleArn: type: string + pattern: ^arn:[^:\n]+:iam::[^:\n]+:role\/.+$ UplinkSpectrumConfig: type: object properties: @@ -542,6 +544,7 @@ components: type: boolean AntennaUplinkConfigArn: type: string + pattern: ^(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()$ additionalProperties: false S3RecordingConfig: type: object @@ -582,6 +585,7 @@ components: $ref: '#/components/schemas/ConfigData' Arn: type: string + pattern: ^(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()$ Id: type: string required: @@ -721,6 +725,7 @@ components: type: string RoleArn: type: string + pattern: ^(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()$ additionalProperties: false EndpointDetails: type: object @@ -745,6 +750,7 @@ components: type: string Arn: type: string + pattern: ^(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()$ EndpointDetails: type: array minItems: 1 @@ -802,8 +808,10 @@ components: properties: KmsKeyArn: type: string + pattern: ^(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()$ KmsAliasArn: type: string + pattern: ^(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()$ oneOf: - required: - KmsKeyArn @@ -840,6 +848,7 @@ components: $ref: '#/components/schemas/DataflowEdge' TrackingConfigArn: type: string + pattern: ^(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()$ Tags: type: array items: @@ -848,6 +857,7 @@ components: type: string Arn: type: string + pattern: ^(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()$ Region: type: string required: @@ -923,6 +933,7 @@ components: $ref: '#/components/schemas/ConfigData' Arn: type: string + pattern: ^(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()$ Id: type: string x-stackQL-stringOnly: true @@ -946,6 +957,7 @@ components: type: string Arn: type: string + pattern: ^(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()$ EndpointDetails: type: array minItems: 1 @@ -1005,6 +1017,7 @@ components: $ref: '#/components/schemas/DataflowEdge' TrackingConfigArn: type: string + pattern: ^(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()$ Tags: type: array items: @@ -1013,6 +1026,7 @@ components: type: string Arn: type: string + pattern: ^(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()$ Region: type: string x-stackQL-stringOnly: true @@ -1034,7 +1048,7 @@ components: x-cfn-type-name: AWS::GroundStation::Config x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1051,9 +1065,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1063,41 +1077,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/configs/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/configs/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GroundStation::Config' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GroundStation::Config' - AND region = 'us-east-1' - config: - name: config - id: aws.groundstation.config - x-cfn-schema-name: Config - x-cfn-type-name: AWS::GroundStation::Config - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1108,12 +1090,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/configs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/configs/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/config/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/configs/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1128,20 +1114,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Type') as type, - json_extract_path_text(Properties, 'ConfigData') as config_data, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::GroundStation::Config' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GroundStation::Config' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'ConfigData') as config_data, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::GroundStation::Config' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GroundStation::Config' + AND region = 'us-east-1' dataflow_endpoint_groups: name: dataflow_endpoint_groups id: aws.groundstation.dataflow_endpoint_groups @@ -1149,7 +1151,7 @@ components: x-cfn-type-name: AWS::GroundStation::DataflowEndpointGroup x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1183,39 +1185,11 @@ components: - $ref: '#/components/x-stackQL-resources/dataflow_endpoint_groups/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/dataflow_endpoint_groups/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GroundStation::DataflowEndpointGroup' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GroundStation::DataflowEndpointGroup' - AND region = 'us-east-1' - dataflow_endpoint_group: - name: dataflow_endpoint_group - id: aws.groundstation.dataflow_endpoint_group - x-cfn-schema-name: DataflowEndpointGroup - x-cfn-type-name: AWS::GroundStation::DataflowEndpointGroup - x-identifiers: - - Id - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1230,20 +1204,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'EndpointDetails') as endpoint_details, - json_extract_path_text(Properties, 'ContactPrePassDurationSeconds') as contact_pre_pass_duration_seconds, - json_extract_path_text(Properties, 'ContactPostPassDurationSeconds') as contact_post_pass_duration_seconds, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::GroundStation::DataflowEndpointGroup' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GroundStation::DataflowEndpointGroup' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'EndpointDetails') as endpoint_details, + json_extract_path_text(Properties, 'ContactPrePassDurationSeconds') as contact_pre_pass_duration_seconds, + json_extract_path_text(Properties, 'ContactPostPassDurationSeconds') as contact_post_pass_duration_seconds, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::GroundStation::DataflowEndpointGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GroundStation::DataflowEndpointGroup' + AND region = 'us-east-1' mission_profiles: name: mission_profiles id: aws.groundstation.mission_profiles @@ -1252,7 +1242,7 @@ components: x-identifiers: - Id - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1269,9 +1259,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1281,44 +1271,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/mission_profiles/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/mission_profiles/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GroundStation::MissionProfile' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GroundStation::MissionProfile' - AND region = 'us-east-1' - mission_profile: - name: mission_profile - id: aws.groundstation.mission_profile - x-cfn-schema-name: MissionProfile - x-cfn-type-name: AWS::GroundStation::MissionProfile - x-identifiers: - - Id - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1329,12 +1284,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/mission_profiles/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/mission_profiles/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/mission_profile/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/mission_profiles/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1355,26 +1314,44 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'ContactPrePassDurationSeconds') as contact_pre_pass_duration_seconds, - json_extract_path_text(Properties, 'ContactPostPassDurationSeconds') as contact_post_pass_duration_seconds, - json_extract_path_text(Properties, 'MinimumViableContactDurationSeconds') as minimum_viable_contact_duration_seconds, - json_extract_path_text(Properties, 'StreamsKmsKey') as streams_kms_key, - json_extract_path_text(Properties, 'StreamsKmsRole') as streams_kms_role, - json_extract_path_text(Properties, 'DataflowEdges') as dataflow_edges, - json_extract_path_text(Properties, 'TrackingConfigArn') as tracking_config_arn, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Region') as region - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::GroundStation::MissionProfile' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GroundStation::MissionProfile' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'ContactPrePassDurationSeconds') as contact_pre_pass_duration_seconds, + json_extract_path_text(Properties, 'ContactPostPassDurationSeconds') as contact_post_pass_duration_seconds, + json_extract_path_text(Properties, 'MinimumViableContactDurationSeconds') as minimum_viable_contact_duration_seconds, + json_extract_path_text(Properties, 'StreamsKmsKey') as streams_kms_key, + json_extract_path_text(Properties, 'StreamsKmsRole') as streams_kms_role, + json_extract_path_text(Properties, 'DataflowEdges') as dataflow_edges, + json_extract_path_text(Properties, 'TrackingConfigArn') as tracking_config_arn, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Region') as region + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::GroundStation::MissionProfile' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GroundStation::MissionProfile' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/guardduty.yaml b/providers/src/aws/v00.00.00000/services/guardduty.yaml index 7120421c..ae4ffc7d 100644 --- a/providers/src/aws/v00.00.00000/services/guardduty.yaml +++ b/providers/src/aws/v00.00.00000/services/guardduty.yaml @@ -1108,7 +1108,7 @@ components: x-cfn-type-name: AWS::GuardDuty::Detector x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1125,9 +1125,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1137,41 +1137,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/detectors/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/detectors/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GuardDuty::Detector' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GuardDuty::Detector' - AND region = 'us-east-1' - detector: - name: detector - id: aws.guardduty.detector - x-cfn-schema-name: Detector - x-cfn-type-name: AWS::GuardDuty::Detector - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1182,12 +1150,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/detectors/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/detectors/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/detector/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/detectors/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1202,20 +1174,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'FindingPublishingFrequency') as finding_publishing_frequency, - json_extract_path_text(Properties, 'Enable') as enable, - json_extract_path_text(Properties, 'DataSources') as data_sources, - json_extract_path_text(Properties, 'Features') as features, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::GuardDuty::Detector' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GuardDuty::Detector' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'FindingPublishingFrequency') as finding_publishing_frequency, + json_extract_path_text(Properties, 'Enable') as enable, + json_extract_path_text(Properties, 'DataSources') as data_sources, + json_extract_path_text(Properties, 'Features') as features, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::GuardDuty::Detector' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GuardDuty::Detector' + AND region = 'us-east-1' filters: name: filters id: aws.guardduty.filters @@ -1224,7 +1212,7 @@ components: x-identifiers: - DetectorId - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1241,9 +1229,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1253,44 +1241,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/filters/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/filters/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.DetectorId') as detector_id, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GuardDuty::Filter' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'DetectorId') as detector_id, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GuardDuty::Filter' - AND region = 'us-east-1' - filter: - name: filter - id: aws.guardduty.filter - x-cfn-schema-name: Filter - x-cfn-type-name: AWS::GuardDuty::Filter - x-identifiers: - - DetectorId - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1301,12 +1254,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/filters/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/filters/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/filter/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/filters/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1322,21 +1279,39 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Action') as action, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'DetectorId') as detector_id, - json_extract_path_text(Properties, 'FindingCriteria') as finding_criteria, - json_extract_path_text(Properties, 'Rank') as rank, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::GuardDuty::Filter' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.DetectorId') as detector_id, + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GuardDuty::Filter' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Action') as action, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'DetectorId') as detector_id, + json_extract_path_text(Properties, 'FindingCriteria') as finding_criteria, + json_extract_path_text(Properties, 'Rank') as rank, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::GuardDuty::Filter' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DetectorId') as detector_id, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GuardDuty::Filter' + AND region = 'us-east-1' ip_sets: name: ip_sets id: aws.guardduty.ip_sets @@ -1345,7 +1320,7 @@ components: x-identifiers: - Id - DetectorId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1362,9 +1337,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1374,44 +1349,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/ip_sets/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/ip_sets/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id, - JSON_EXTRACT(Properties, '$.DetectorId') as detector_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GuardDuty::IPSet' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'DetectorId') as detector_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GuardDuty::IPSet' - AND region = 'us-east-1' - ip_set: - name: ip_set - id: aws.guardduty.ip_set - x-cfn-schema-name: IPSet - x-cfn-type-name: AWS::GuardDuty::IPSet - x-identifiers: - - Id - - DetectorId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1422,12 +1362,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/ip_sets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/ip_sets/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/ip_set/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/ip_sets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1443,21 +1387,39 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Format') as _format, - json_extract_path_text(Properties, 'Activate') as activate, - json_extract_path_text(Properties, 'DetectorId') as detector_id, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Location') as location, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::GuardDuty::IPSet' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.DetectorId') as detector_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GuardDuty::IPSet' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Format') as _format, + json_extract_path_text(Properties, 'Activate') as activate, + json_extract_path_text(Properties, 'DetectorId') as detector_id, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Location') as location, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::GuardDuty::IPSet' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'DetectorId') as detector_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GuardDuty::IPSet' + AND region = 'us-east-1' masters: name: masters id: aws.guardduty.masters @@ -1466,7 +1428,7 @@ components: x-identifiers: - DetectorId - MasterId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1500,42 +1462,11 @@ components: - $ref: '#/components/x-stackQL-resources/masters/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/masters/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.DetectorId') as detector_id, - JSON_EXTRACT(Properties, '$.MasterId') as master_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GuardDuty::Master' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'DetectorId') as detector_id, - json_extract_path_text(Properties, 'MasterId') as master_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GuardDuty::Master' - AND region = 'us-east-1' - master: - name: master - id: aws.guardduty.master - x-cfn-schema-name: Master - x-cfn-type-name: AWS::GuardDuty::Master - x-identifiers: - - DetectorId - - MasterId - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1547,17 +1478,35 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'MasterId') as master_id, - json_extract_path_text(Properties, 'InvitationId') as invitation_id, - json_extract_path_text(Properties, 'DetectorId') as detector_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::GuardDuty::Master' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.DetectorId') as detector_id, + JSON_EXTRACT(Properties, '$.MasterId') as master_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GuardDuty::Master' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'MasterId') as master_id, + json_extract_path_text(Properties, 'InvitationId') as invitation_id, + json_extract_path_text(Properties, 'DetectorId') as detector_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::GuardDuty::Master' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DetectorId') as detector_id, + json_extract_path_text(Properties, 'MasterId') as master_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GuardDuty::Master' + AND region = 'us-east-1' members: name: members id: aws.guardduty.members @@ -1566,7 +1515,7 @@ components: x-identifiers: - DetectorId - MemberId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1583,9 +1532,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1595,44 +1544,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/members/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/members/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.DetectorId') as detector_id, - JSON_EXTRACT(Properties, '$.MemberId') as member_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GuardDuty::Member' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'DetectorId') as detector_id, - json_extract_path_text(Properties, 'MemberId') as member_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GuardDuty::Member' - AND region = 'us-east-1' - member: - name: member - id: aws.guardduty.member - x-cfn-schema-name: Member - x-cfn-type-name: AWS::GuardDuty::Member - x-identifiers: - - DetectorId - - MemberId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1643,12 +1557,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/members/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/members/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/member/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/members/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1663,20 +1581,38 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'MemberId') as member_id, - json_extract_path_text(Properties, 'Email') as email, - json_extract_path_text(Properties, 'Message') as message, - json_extract_path_text(Properties, 'DisableEmailNotification') as disable_email_notification, - json_extract_path_text(Properties, 'DetectorId') as detector_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::GuardDuty::Member' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.DetectorId') as detector_id, + JSON_EXTRACT(Properties, '$.MemberId') as member_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GuardDuty::Member' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'MemberId') as member_id, + json_extract_path_text(Properties, 'Email') as email, + json_extract_path_text(Properties, 'Message') as message, + json_extract_path_text(Properties, 'DisableEmailNotification') as disable_email_notification, + json_extract_path_text(Properties, 'DetectorId') as detector_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::GuardDuty::Member' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DetectorId') as detector_id, + json_extract_path_text(Properties, 'MemberId') as member_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GuardDuty::Member' + AND region = 'us-east-1' threat_intel_sets: name: threat_intel_sets id: aws.guardduty.threat_intel_sets @@ -1685,7 +1621,7 @@ components: x-identifiers: - Id - DetectorId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1702,9 +1638,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1714,44 +1650,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/threat_intel_sets/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/threat_intel_sets/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id, - JSON_EXTRACT(Properties, '$.DetectorId') as detector_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GuardDuty::ThreatIntelSet' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'DetectorId') as detector_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GuardDuty::ThreatIntelSet' - AND region = 'us-east-1' - threat_intel_set: - name: threat_intel_set - id: aws.guardduty.threat_intel_set - x-cfn-schema-name: ThreatIntelSet - x-cfn-type-name: AWS::GuardDuty::ThreatIntelSet - x-identifiers: - - Id - - DetectorId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1762,12 +1663,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/threat_intel_sets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/threat_intel_sets/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/threat_intel_set/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/threat_intel_sets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1783,21 +1688,39 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Format') as _format, - json_extract_path_text(Properties, 'Activate') as activate, - json_extract_path_text(Properties, 'DetectorId') as detector_id, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Location') as location, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::GuardDuty::ThreatIntelSet' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.DetectorId') as detector_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GuardDuty::ThreatIntelSet' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Format') as _format, + json_extract_path_text(Properties, 'Activate') as activate, + json_extract_path_text(Properties, 'DetectorId') as detector_id, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Location') as location, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::GuardDuty::ThreatIntelSet' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'DetectorId') as detector_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::GuardDuty::ThreatIntelSet' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/healthimaging.yaml b/providers/src/aws/v00.00.00000/services/healthimaging.yaml index 040a3ec1..261c274b 100644 --- a/providers/src/aws/v00.00.00000/services/healthimaging.yaml +++ b/providers/src/aws/v00.00.00000/services/healthimaging.yaml @@ -550,7 +550,7 @@ components: x-cfn-type-name: AWS::HealthImaging::Datastore x-identifiers: - DatastoreId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -584,39 +584,11 @@ components: - $ref: '#/components/x-stackQL-resources/datastores/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/datastores/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.DatastoreId') as datastore_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::HealthImaging::Datastore' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'DatastoreId') as datastore_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::HealthImaging::Datastore' - AND region = 'us-east-1' - datastore: - name: datastore - id: aws.healthimaging.datastore - x-cfn-schema-name: Datastore - x-cfn-type-name: AWS::HealthImaging::Datastore - x-identifiers: - - DatastoreId - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -633,22 +605,38 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'DatastoreArn') as datastore_arn, - json_extract_path_text(Properties, 'DatastoreName') as datastore_name, - json_extract_path_text(Properties, 'DatastoreId') as datastore_id, - json_extract_path_text(Properties, 'DatastoreStatus') as datastore_status, - json_extract_path_text(Properties, 'KmsKeyArn') as kms_key_arn, - json_extract_path_text(Properties, 'CreatedAt') as created_at, - json_extract_path_text(Properties, 'UpdatedAt') as updated_at, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::HealthImaging::Datastore' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.DatastoreId') as datastore_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::HealthImaging::Datastore' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DatastoreArn') as datastore_arn, + json_extract_path_text(Properties, 'DatastoreName') as datastore_name, + json_extract_path_text(Properties, 'DatastoreId') as datastore_id, + json_extract_path_text(Properties, 'DatastoreStatus') as datastore_status, + json_extract_path_text(Properties, 'KmsKeyArn') as kms_key_arn, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'UpdatedAt') as updated_at, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::HealthImaging::Datastore' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DatastoreId') as datastore_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::HealthImaging::Datastore' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/healthlake.yaml b/providers/src/aws/v00.00.00000/services/healthlake.yaml index 249364ee..62fbab1a 100644 --- a/providers/src/aws/v00.00.00000/services/healthlake.yaml +++ b/providers/src/aws/v00.00.00000/services/healthlake.yaml @@ -554,7 +554,6 @@ components: - DatastoreTypeVersion - PreloadDataConfig - SseConfiguration - - KmsEncryptionConfig - IdentityProviderConfiguration x-read-only-properties: - CreatedAt @@ -664,7 +663,7 @@ components: x-cfn-type-name: AWS::HealthLake::FHIRDatastore x-identifiers: - DatastoreId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -681,9 +680,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -693,41 +692,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/fhir_datastores/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/fhir_datastores/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.DatastoreId') as datastore_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::HealthLake::FHIRDatastore' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'DatastoreId') as datastore_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::HealthLake::FHIRDatastore' - AND region = 'us-east-1' - fhir_datastore: - name: fhir_datastore - id: aws.healthlake.fhir_datastore - x-cfn-schema-name: FHIRDatastore - x-cfn-type-name: AWS::HealthLake::FHIRDatastore - x-identifiers: - - DatastoreId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -738,12 +705,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/fhir_datastores/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/fhir_datastores/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/fhir_datastore/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/fhir_datastores/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -763,25 +734,41 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'CreatedAt') as created_at, - json_extract_path_text(Properties, 'DatastoreArn') as datastore_arn, - json_extract_path_text(Properties, 'DatastoreEndpoint') as datastore_endpoint, - json_extract_path_text(Properties, 'DatastoreId') as datastore_id, - json_extract_path_text(Properties, 'DatastoreName') as datastore_name, - json_extract_path_text(Properties, 'DatastoreStatus') as datastore_status, - json_extract_path_text(Properties, 'DatastoreTypeVersion') as datastore_type_version, - json_extract_path_text(Properties, 'PreloadDataConfig') as preload_data_config, - json_extract_path_text(Properties, 'SseConfiguration') as sse_configuration, - json_extract_path_text(Properties, 'IdentityProviderConfiguration') as identity_provider_configuration, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::HealthLake::FHIRDatastore' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.DatastoreId') as datastore_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::HealthLake::FHIRDatastore' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'DatastoreArn') as datastore_arn, + json_extract_path_text(Properties, 'DatastoreEndpoint') as datastore_endpoint, + json_extract_path_text(Properties, 'DatastoreId') as datastore_id, + json_extract_path_text(Properties, 'DatastoreName') as datastore_name, + json_extract_path_text(Properties, 'DatastoreStatus') as datastore_status, + json_extract_path_text(Properties, 'DatastoreTypeVersion') as datastore_type_version, + json_extract_path_text(Properties, 'PreloadDataConfig') as preload_data_config, + json_extract_path_text(Properties, 'SseConfiguration') as sse_configuration, + json_extract_path_text(Properties, 'IdentityProviderConfiguration') as identity_provider_configuration, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::HealthLake::FHIRDatastore' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DatastoreId') as datastore_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::HealthLake::FHIRDatastore' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/iam.yaml b/providers/src/aws/v00.00.00000/services/iam.yaml index 4759a5ce..b4e5ad13 100644 --- a/providers/src/aws/v00.00.00000/services/iam.yaml +++ b/providers/src/aws/v00.00.00000/services/iam.yaml @@ -385,595 +385,830 @@ components: $ref: '#/components/x-cloud-control-schemas/ProgressEvent' type: object schemas: - Policy: - description: |- - Contains information about an attached policy. - An attached policy is a managed policy that has been attached to a user, group, or role. - For more information about managed policies, refer to [Managed Policies and Inline Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *User Guide*. + AttachGroupPolicyRequest: + properties: + GroupName: + allOf: + - $ref: '#/components/schemas/groupNameType' + - description: '

The name (friendly name, not ARN) of the group to attach the policy to.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

' + PolicyArn: + allOf: + - $ref: '#/components/schemas/arnType' + - description:

The Amazon Resource Name (ARN) of the IAM policy you want to attach.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

+ required: + - GroupName + - PolicyArn + title: AttachGroupPolicyRequest type: object - additionalProperties: false + AttachRolePolicyRequest: + properties: + PolicyArn: + allOf: + - $ref: '#/components/schemas/arnType' + - description:

The Amazon Resource Name (ARN) of the IAM policy you want to attach.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

+ RoleName: + allOf: + - $ref: '#/components/schemas/roleNameType' + - description: '

The name (friendly name, not ARN) of the role to attach the policy to.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

' + required: + - RoleName + - PolicyArn + title: AttachRolePolicyRequest + type: object + AttachUserPolicyRequest: + properties: + PolicyArn: + allOf: + - $ref: '#/components/schemas/arnType' + - description:

The Amazon Resource Name (ARN) of the IAM policy you want to attach.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

+ UserName: + allOf: + - $ref: '#/components/schemas/userNameType' + - description: '

The name (friendly name, not ARN) of the IAM user to attach the policy to.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

' + required: + - UserName + - PolicyArn + title: AttachUserPolicyRequest + type: object + ConcurrentModificationException: {} + CreatePolicyRequest: properties: + Description: + allOf: + - $ref: '#/components/schemas/policyDescriptionType' + - description:

A friendly description of the policy.

Typically used to store information about the permissions defined in the policy. For example, "Grants access to production DynamoDB tables."

The policy description is immutable. After a value is assigned, it cannot be changed.

+ Path: + allOf: + - $ref: '#/components/schemas/policyPathType' + - description: >- +

The path for the policy.

For more information about paths, see IAM identifiers in the IAM User Guide.

This parameter is optional. If it is not included, it defaults to a slash (/).

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that + must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.

You cannot use an asterisk (*) in the path name.

 PolicyDocument: - description: The entire contents of the policy that defines permissions. For more information, see [Overview of JSON policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json). - type: object + allOf: + - $ref: '#/components/schemas/policyDocumentType' + - description: >- +

The JSON policy document that you want to use as the content for the new policy.

You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum + character counts of a managed policy with no whitespaces, see IAM and STS character quotas.

To learn more about JSON policy grammar, see Grammar of the IAM JSON policy language in the IAM User Guide.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)

  • The special characters tab + (\u0009), line feed (\u000A), and carriage return (\u000D)

PolicyName: - description: The friendly name (not ARN) identifying the policy. - type: string + allOf: + - $ref: '#/components/schemas/policyNameType' + - description:

The friendly name of the policy.

IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource".

+ Tags: + allOf: + - $ref: '#/components/schemas/tagListType' + - description:

A list of tags that you want to attach to the new IAM customer managed policy. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.

 required: - PolicyName - PolicyDocument - Group: + title: CreatePolicyRequest type: object + CreatePolicyResponse: + description: 'Contains the response to a successful CreatePolicy request. ' + properties: + Policy: + allOf: + - $ref: '#/components/schemas/Policy' + - description: A structure containing details about the new policy. + type: object + DeleteConflictException: {} + DeleteGroupPolicyRequest: properties: - Arn: - description: '' - type: string GroupName: - description: |- - The name of the group to create. Do not include the path in this value. - The group name must be unique within the account. Group names are not distinguished by case. For example, you cannot create groups named both "ADMINS" and "admins". If you don't specify a name, CFN generates a unique physical ID and uses that ID for the group name. - If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. - If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities). - Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using ``Fn::Join`` and ``AWS::Region`` to create a Region-specific name, as in the following example: ``{"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]}``. - type: string - ManagedPolicyArns: - description: |- - The Amazon Resource Name (ARN) of the IAM policy you want to attach. - For more information about ARNs, see [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*. - type: array - uniqueItems: true - x-insertionOrder: false - items: - type: string - Path: - description: |- - The path to the group. For more information about paths, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*. - This parameter is optional. If it is not included, it defaults to a slash (/). - This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\u0021``) through the DEL character (``\u007F``), including most punctuation characters, digits, and upper and lowercased letters. - type: string - Policies: - description: |- - Adds or updates an inline policy document that is embedded in the specified IAM group. To view AWS::IAM::Group snippets, see [Declaring an Group Resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-iam-group). - The name of each inline policy for a role, user, or group must be unique. If you don't choose unique names, updates to the IAM identity will fail. - For information about limits on the number of inline policies that you can embed in a group, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*. - type: array - uniqueItems: false - x-insertionOrder: false - items: - $ref: '#/components/schemas/Policy' - x-stackql-resource-name: group - description: |- - Creates a new group. - For information about the number of groups you can create, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*. - x-type-name: AWS::IAM::Group - x-stackql-primary-identifier: - - GroupName - x-create-only-properties: + allOf: + - $ref: '#/components/schemas/groupNameType' + - description: '

The name (friendly name, not ARN) identifying the group that the policy is embedded in.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

' + PolicyName: + allOf: + - $ref: '#/components/schemas/policyNameType' + - description: '

The name identifying the policy document to delete.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

' + required: - GroupName - x-read-only-properties: - - Arn - x-tagging: - taggable: false - tagOnCreate: false - tagUpdatable: false - cloudFormationSystemTags: false - x-required-permissions: - create: - - iam:CreateGroup - - iam:PutGroupPolicy - - iam:AttachGroupPolicy - - iam:GetGroupPolicy - - iam:GetGroup - read: - - iam:GetGroup - - iam:ListGroupPolicies - - iam:GetGroupPolicy - - iam:ListAttachedGroupPolicies - update: - - iam:GetGroup - - iam:UpdateGroup - - iam:DetachGroupPolicy - - iam:AttachGroupPolicy - - iam:DeleteGroupPolicy - - iam:PutGroupPolicy - - iam:GetGroupPolicy - delete: - - iam:GetGroup - - iam:DeleteGroup - - iam:ListAttachedGroupPolicies - - iam:ListGroupPolicies - - iam:DetachGroupPolicy - - iam:DeleteGroupPolicy - - iam:GetGroupPolicy - list: - - iam:ListGroups - GroupPolicy: + - PolicyName + title: DeleteGroupPolicyRequest type: object + DeletePolicyRequest: + properties: + PolicyArn: + allOf: + - $ref: '#/components/schemas/arnType' + - description:

The Amazon Resource Name (ARN) of the IAM policy you want to delete.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

+ required: + - PolicyArn + title: DeletePolicyRequest + type: object + DeleteRolePolicyRequest: properties: - PolicyDocument: - description: |- - The policy document. - You must provide policies in JSON format in IAM. However, for CFN templates formatted in YAML, you can provide the policy in JSON or YAML format. CFN always converts a YAML policy to JSON format before submitting it to IAM. - The [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex) used to validate this parameter is a string of characters consisting of the following: - + Any printable ASCII character ranging from the space character (``\u0020``) through the end of the ASCII character range - + The printable characters in the Basic Latin and Latin-1 Supplement character set (through ``\u00FF``) - + The special characters tab (``\u0009``), line feed (``\u000A``), and carriage return (``\u000D``) - type: object PolicyName: - description: |- - The name of the policy document. - This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- - type: string - GroupName: - description: |- - The name of the group to associate the policy with. - This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-. - type: string + allOf: + - $ref: '#/components/schemas/policyNameType' + - description: '

The name of the inline policy to delete from the specified IAM role.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

' + RoleName: + allOf: + - $ref: '#/components/schemas/roleNameType' + - description: '

The name (friendly name, not ARN) identifying the role that the policy is embedded in.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

' required: + - RoleName - PolicyName - - GroupName - x-stackql-resource-name: group_policy - description: |- - Adds or updates an inline policy document that is embedded in the specified IAM group. - A group can also have managed policies attached to it. To attach a managed policy to a group, use [AWS::IAM::Group](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html). To create a new managed policy, use [AWS::IAM::ManagedPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html). For information about policies, see [Managed policies and inline policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *IAM User Guide*. - For information about the maximum number of inline policies that you can embed in a group, see [IAM and quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*. - x-type-name: AWS::IAM::GroupPolicy - x-stackql-primary-identifier: + title: DeleteRolePolicyRequest + type: object + DeleteUserPolicyRequest: + properties: + PolicyName: + allOf: + - $ref: '#/components/schemas/policyNameType' + - description: '

The name identifying the policy document to delete.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

' + UserName: + allOf: + - $ref: '#/components/schemas/existingUserNameType' + - description: '

The name (friendly name, not ARN) identifying the user that the policy is embedded in.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

' + required: + - UserName - PolicyName + title: DeleteUserPolicyRequest + type: object + DetachGroupPolicyRequest: + properties: + GroupName: + allOf: + - $ref: '#/components/schemas/groupNameType' + - description: '

The name (friendly name, not ARN) of the IAM group to detach the policy from.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

' + PolicyArn: + allOf: + - $ref: '#/components/schemas/arnType' + - description:

The Amazon Resource Name (ARN) of the IAM policy you want to detach.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

+ required: - GroupName - x-create-only-properties: - - PolicyName + - PolicyArn + title: DetachGroupPolicyRequest + type: object + DetachRolePolicyRequest: + properties: + PolicyArn: + allOf: + - $ref: '#/components/schemas/arnType' + - description:

The Amazon Resource Name (ARN) of the IAM policy you want to detach.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

+ RoleName: + allOf: + - $ref: '#/components/schemas/roleNameType' + - description: '

The name (friendly name, not ARN) of the IAM role to detach the policy from.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

' + required: + - RoleName + - PolicyArn + title: DetachRolePolicyRequest + type: object + DetachUserPolicyRequest: + properties: + PolicyArn: + allOf: + - $ref: '#/components/schemas/arnType' + - description:

The Amazon Resource Name (ARN) of the IAM policy you want to detach.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

+ UserName: + allOf: + - $ref: '#/components/schemas/userNameType' + - description: '

The name (friendly name, not ARN) of the IAM user to detach the policy from.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

' + required: + - UserName + - PolicyArn + title: DetachUserPolicyRequest + type: object + EntityAlreadyExistsException: {} + GetGroupPolicyRequest: + properties: + GroupName: + allOf: + - $ref: '#/components/schemas/groupNameType' + - description: '

The name of the group the policy is associated with.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

' + PolicyName: + allOf: + - $ref: '#/components/schemas/policyNameType' + - description: '

The name of the policy document to get.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

' + required: - GroupName - x-required-properties: - PolicyName + title: GetGroupPolicyRequest + type: object + GetGroupPolicyResponse: + description: 'Contains the response to a successful GetGroupPolicy request. ' + properties: + GroupName: + allOf: + - $ref: '#/components/schemas/groupNameType' + - description: The group the policy is associated with. + PolicyDocument: + allOf: + - $ref: '#/components/schemas/policyDocumentType' + - description:

The policy document.

IAM stores policies in JSON format. However, resources that were created using CloudFormation templates can be formatted in YAML. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

+ PolicyName: + allOf: + - $ref: '#/components/schemas/policyNameType' + - description: The name of the policy. + required: - GroupName - x-tagging: - taggable: false - tagOnCreate: false - tagUpdatable: false - cloudFormationSystemTags: false - x-required-permissions: - create: - - iam:PutGroupPolicy - - iam:GetGroupPolicy - read: - - iam:GetGroupPolicy - update: - - iam:PutGroupPolicy - - iam:GetGroupPolicy - delete: - - iam:DeleteGroupPolicy - - iam:GetGroupPolicy - InstanceProfile: + - PolicyName + - PolicyDocument type: object + GetPolicyRequest: properties: - Path: - type: string - description: |- - The path to the instance profile. For more information about paths, see [IAM Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*. - This parameter is optional. If it is not included, it defaults to a slash (/). - This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\u0021``) through the DEL character (``\u007F``), including most punctuation characters, digits, and upper and lowercased letters. - Roles: - type: array - description: The name of the role to associate with the instance profile. Only one role can be assigned to an EC2 instance at a time, and all applications on the instance share the same role and permissions. - uniqueItems: true - x-insertionOrder: false - items: - type: string - InstanceProfileName: - type: string - description: |- - The name of the instance profile to create. - This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- - Arn: - type: string - description: '' + PolicyArn: + allOf: + - $ref: '#/components/schemas/arnType' + - description:

The Amazon Resource Name (ARN) of the managed policy that you want information about.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

required: - - Roles - x-stackql-resource-name: instance_profile - description: |- - Creates a new instance profile. For information about instance profiles, see [Using instance profiles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html). - For information about the number of instance profiles you can create, see [object quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *User Guide*. - x-type-name: AWS::IAM::InstanceProfile - x-stackql-primary-identifier: - - InstanceProfileName - x-create-only-properties: - - InstanceProfileName - - Path - x-read-only-properties: - - Arn - x-required-properties: - - Roles - x-required-permissions: - create: - - iam:CreateInstanceProfile - - iam:PassRole - - iam:AddRoleToInstanceProfile - - iam:GetInstanceProfile - read: - - iam:GetInstanceProfile - update: - - iam:PassRole - - iam:RemoveRoleFromInstanceProfile - - iam:AddRoleToInstanceProfile - - iam:GetInstanceProfile - delete: - - iam:GetInstanceProfile - - iam:RemoveRoleFromInstanceProfile - - iam:DeleteInstanceProfile - list: - - iam:ListInstanceProfiles - ManagedPolicy: + - PolicyArn + title: GetPolicyRequest type: object + GetPolicyResponse: + description: 'Contains the response to a successful GetPolicy request. ' + properties: + Policy: + allOf: + - $ref: '#/components/schemas/Policy' + - description: A structure containing details about the policy. + type: object + GetRolePolicyRequest: + properties: + PolicyName: + allOf: + - $ref: '#/components/schemas/policyNameType' + - description: '

The name of the policy document to get.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

' + RoleName: + allOf: + - $ref: '#/components/schemas/roleNameType' + - description: '

The name of the role associated with the policy.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

' + required: + - RoleName + - PolicyName + title: GetRolePolicyRequest + type: object + GetRolePolicyResponse: + description: 'Contains the response to a successful GetRolePolicy request. ' properties: - Description: - type: string - description: |- - A friendly description of the policy. - Typically used to store information about the permissions defined in the policy. For example, "Grants access to production DynamoDB tables." - The policy description is immutable. After a value is assigned, it cannot be changed. - Groups: - x-insertionOrder: false - type: array - description: |- - The name (friendly name, not ARN) of the group to attach the policy to. - This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- - uniqueItems: true - items: - type: string - ManagedPolicyName: - type: string - description: |- - The friendly name of the policy. - If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. - If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities). - Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using ``Fn::Join`` and ``AWS::Region`` to create a Region-specific name, as in the following example: ``{"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]}``. - Path: - type: string - default: / - description: |- - The path for the policy. - For more information about paths, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*. - This parameter is optional. If it is not included, it defaults to a slash (/). - This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\u0021``) through the DEL character (``\u007F``), including most punctuation characters, digits, and upper and lowercased letters. - You cannot use an asterisk (*) in the path name. PolicyDocument: - type: object - description: |- - The JSON policy document that you want to use as the content for the new policy. - You must provide policies in JSON format in IAM. However, for CFN templates formatted in YAML, you can provide the policy in JSON or YAML format. CFN always converts a YAML policy to JSON format before submitting it to IAM. - The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see [IAM and character quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length). - To learn more about JSON policy grammar, see [Grammar of the IAM JSON policy language](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_grammar.html) in the *IAM User Guide*. - The [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex) used to validate this parameter is a string of characters consisting of the following: - + Any printable ASCII character ranging from the space character (``\u0020``) through the end of the ASCII character range - + The printable characters in the Basic Latin and Latin-1 Supplement character set (through ``\u00FF``) - + The special characters tab (``\u0009``), line feed (``\u000A``), and carriage return (``\u000D``) - Roles: - x-insertionOrder: false - type: array - description: |- - The name (friendly name, not ARN) of the role to attach the policy to. - This parameter allows (per its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- - If an external policy (such as ``AWS::IAM::Policy`` or ``AWS::IAM::ManagedPolicy``) has a ``Ref`` to a role and if a resource (such as ``AWS::ECS::Service``) also has a ``Ref`` to the same role, add a ``DependsOn`` attribute to the resource to make the resource depend on the external policy. This dependency ensures that the role's policy is available throughout the resource's lifecycle. For example, when you delete a stack with an ``AWS::ECS::Service`` resource, the ``DependsOn`` attribute ensures that CFN deletes the ``AWS::ECS::Service`` resource before deleting its role's policy. - uniqueItems: true - items: - type: string - Users: - x-insertionOrder: false - type: array - description: |- - The name (friendly name, not ARN) of the IAM user to attach the policy to. - This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- - uniqueItems: true - items: - type: string - PolicyArn: - type: string - description: '' - AttachmentCount: - type: integer - description: '' - CreateDate: - type: string - description: '' - UpdateDate: - type: string - description: '' - DefaultVersionId: - type: string - description: '' - IsAttachable: - type: boolean - description: '' - PermissionsBoundaryUsageCount: - type: integer - description: '' - PolicyId: - type: string - description: '' + allOf: + - $ref: '#/components/schemas/policyDocumentType' + - description:

The policy document.

IAM stores policies in JSON format. However, resources that were created using CloudFormation templates can be formatted in YAML. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

+ PolicyName: + allOf: + - $ref: '#/components/schemas/policyNameType' + - description: The name of the policy. + RoleName: + allOf: + - $ref: '#/components/schemas/roleNameType' + - description: The role the policy is associated with. required: + - RoleName + - PolicyName - PolicyDocument - x-stackql-resource-name: managed_policy - description: |- - Creates a new managed policy for your AWS-account. - This operation creates a policy version with a version identifier of ``v1`` and sets v1 as the policy's default version. For more information about policy versions, see [Versioning for managed policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html) in the *IAM User Guide*. - As a best practice, you can validate your IAM policies. To learn more, see [Validating IAM policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_policy-validator.html) in the *IAM User Guide*. - For more information about managed policies in general, see [Managed policies and inline policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *IAM User Guide*. - x-type-name: AWS::IAM::ManagedPolicy - x-stackql-primary-identifier: - - PolicyArn - x-create-only-properties: - - ManagedPolicyName - - Description - - Path - x-read-only-properties: - - PolicyArn - - AttachmentCount - - CreateDate - - DefaultVersionId - - IsAttachable - - PermissionsBoundaryUsageCount - - PolicyId - - UpdateDate - x-required-properties: + type: object + GetUserPolicyRequest: + properties: + PolicyName: + allOf: + - $ref: '#/components/schemas/policyNameType' + - description: '

The name of the policy document to get.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

' + UserName: + allOf: + - $ref: '#/components/schemas/existingUserNameType' + - description: '

The name of the user who the policy is associated with.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

' + required: + - UserName + - PolicyName + title: GetUserPolicyRequest + type: object + GetUserPolicyResponse: + description: 'Contains the response to a successful GetUserPolicy request. ' + properties: + PolicyDocument: + allOf: + - $ref: '#/components/schemas/policyDocumentType' + - description:

The policy document.

IAM stores policies in JSON format. However, resources that were created using CloudFormation templates can be formatted in YAML. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

+ PolicyName: + allOf: + - $ref: '#/components/schemas/policyNameType' + - description: The name of the policy. + UserName: + allOf: + - $ref: '#/components/schemas/existingUserNameType' + - description: The user the policy is associated with. + required: + - UserName + - PolicyName - PolicyDocument - x-tagging: - taggable: false - tagOnCreate: false - tagUpdatable: false - cloudFormationSystemTags: false - x-required-permissions: - create: - - iam:CreatePolicy - - iam:AttachGroupPolicy - - iam:AttachUserPolicy - - iam:AttachRolePolicy - read: - - iam:GetPolicy - - iam:ListEntitiesForPolicy - - iam:GetPolicyVersion - update: - - iam:DetachRolePolicy - - iam:GetPolicy - - iam:ListPolicyVersions - - iam:DetachGroupPolicy - - iam:DetachUserPolicy - - iam:CreatePolicyVersion - - iam:DeletePolicyVersion - - iam:AttachGroupPolicy - - iam:AttachUserPolicy - - iam:AttachRolePolicy - delete: - - iam:DetachRolePolicy - - iam:GetPolicy - - iam:ListPolicyVersions - - iam:DetachGroupPolicy - - iam:DetachUserPolicy - - iam:DeletePolicyVersion - - iam:DeletePolicy - - iam:ListEntitiesForPolicy - list: - - iam:ListPolicies - Tag: - description: A key-value pair to associate with a resource. type: object - additionalProperties: false + InvalidInputException: {} + LimitExceededException: {} + ListGroupPoliciesRequest: properties: - Value: - description: 'The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' - type: string - minLength: 1 - maxLength: 256 - Key: - description: 'The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' - type: string - minLength: 1 - maxLength: 128 + GroupName: + allOf: + - $ref: '#/components/schemas/groupNameType' + - description: '

The name of the group to list policies for.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

' + Marker: + allOf: + - $ref: '#/components/schemas/markerType' + - description: Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start. + MaxItems: + allOf: + - $ref: '#/components/schemas/maxItemsType' + - description: >- +

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns + true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

required: - - Value - - Key - OIDCProvider: + - GroupName + title: ListGroupPoliciesRequest type: object + ListGroupPoliciesResponse: + description: 'Contains the response to a successful ListGroupPolicies request. ' + example: + PolicyNames: + - AdminRoot + - KeyPolicy properties: - ClientIdList: - type: array - x-insertionOrder: false - items: - minLength: 1 - maxLength: 255 - type: string - Url: + IsTruncated: + allOf: + - $ref: '#/components/schemas/booleanType' + - description: A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results. + Marker: + allOf: + - $ref: '#/components/schemas/responseMarkerType' + - description: When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request. + PolicyNames: + allOf: + - $ref: '#/components/schemas/policyNameListType' + - description: '

A list of policy names.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

' + required: + - PolicyNames + type: object + ListPoliciesRequest: + properties: + Marker: + allOf: + - $ref: '#/components/schemas/markerType' + - description: Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start. + MaxItems: + allOf: + - $ref: '#/components/schemas/maxItemsType' + - description: >- +

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns + true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

+ OnlyAttached: + allOf: + - $ref: '#/components/schemas/booleanType' + - description:

A flag to filter the results to only the attached policies.

When OnlyAttached is true, the returned list contains only the policies that are attached to an IAM user, group, or role. When OnlyAttached is false, or when the parameter is not included, all policies are returned.

+ PathPrefix: + allOf: + - $ref: '#/components/schemas/policyPathType' + - description: >- + The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies. This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character + (\u007F), including most punctuation characters, digits, and upper and lowercased letters. + PolicyUsageFilter: + allOf: + - $ref: '#/components/schemas/PolicyUsageType' + - description: "

The policy usage method to use for filtering the results.

To list only permissions policies, set\_PolicyUsageFilter\_to\_PermissionsPolicy. To list only the policies used to set permissions boundaries, set\_the value to\_PermissionsBoundary.

This parameter is optional. If it is not included, all policies are returned.

" + Scope: + allOf: + - $ref: '#/components/schemas/policyScopeType' + - description:

The scope to use for filtering the results.

To list only Amazon Web Services managed policies, set Scope to AWS. To list only the customer managed policies in your Amazon Web Services account, set Scope to Local.

This parameter is optional. If it is not included, or if it is set to All, all policies are returned.

+ title: ListPoliciesRequest + type: object + ListPoliciesResponse: + description: 'Contains the response to a successful ListPolicies request. ' + properties: + IsTruncated: + allOf: + - $ref: '#/components/schemas/booleanType' + - description: A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results. + Marker: + allOf: + - $ref: '#/components/schemas/responseMarkerType' + - description: When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request. + Policies: + allOf: + - $ref: '#/components/schemas/policyListType' + - description: A list of policies. + type: object + ListRolePoliciesRequest: + properties: + Marker: + allOf: + - $ref: '#/components/schemas/markerType' + - description: Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start. + MaxItems: + allOf: + - $ref: '#/components/schemas/maxItemsType' + - description: >- +

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns + true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

+ RoleName: + allOf: + - $ref: '#/components/schemas/roleNameType' + - description: '

The name of the role to list policies for.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

' + required: + - RoleName + title: ListRolePoliciesRequest + type: object + ListRolePoliciesResponse: + description: 'Contains the response to a successful ListRolePolicies request. ' + properties: + IsTruncated: + allOf: + - $ref: '#/components/schemas/booleanType' + - description: A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results. + Marker: + allOf: + - $ref: '#/components/schemas/responseMarkerType' + - description: When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request. + PolicyNames: + allOf: + - $ref: '#/components/schemas/policyNameListType' + - description: A list of policy names. + required: + - PolicyNames + type: object + ListUserPoliciesRequest: + properties: + Marker: + allOf: + - $ref: '#/components/schemas/markerType' + - description: Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start. + MaxItems: + allOf: + - $ref: '#/components/schemas/maxItemsType' + - description: >- +

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns + true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

+ UserName: + allOf: + - $ref: '#/components/schemas/existingUserNameType' + - description: '

The name of the user to list policies for.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

' + required: + - UserName + title: ListUserPoliciesRequest + type: object + ListUserPoliciesResponse: + description: 'Contains the response to a successful ListUserPolicies request. ' + properties: + IsTruncated: + allOf: + - $ref: '#/components/schemas/booleanType' + - description: A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results. + Marker: + allOf: + - $ref: '#/components/schemas/responseMarkerType' + - description: When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request. + PolicyNames: + allOf: + - $ref: '#/components/schemas/policyNameListType' + - description: A list of policy names. + required: + - PolicyNames + type: object + MalformedPolicyDocumentException: {} + NoSuchEntityException: {} + Policy: + description: |- + Contains information about an attached policy. + An attached policy is a managed policy that has been attached to a user, group, or role. + For more information about managed policies, refer to [Managed Policies and Inline Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *User Guide*. + type: object + additionalProperties: false + properties: + PolicyDocument: + description: The entire contents of the policy that defines permissions. For more information, see [Overview of JSON policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json). + type: object + PolicyName: + description: The friendly name (not ARN) identifying the policy. + type: string + required: + - PolicyName + - PolicyDocument + PolicyNotAttachableException: {} + PolicyUsageType: + description:

The policy usage type that indicates whether the policy is used as a permissions policy or as the permissions boundary for an entity.

For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.

+ enum: + - PermissionsPolicy + - PermissionsBoundary + type: string + PutGroupPolicyRequest: + properties: + GroupName: + allOf: + - $ref: '#/components/schemas/groupNameType' + - description: '

The name of the group to associate the policy with.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-.

' + PolicyDocument: + allOf: + - $ref: '#/components/schemas/policyDocumentType' + - description: >- +

The policy document.

You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to = IAM.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character + ranging from the space character (\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)

  • The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)

+ PolicyName: + allOf: + - $ref: '#/components/schemas/policyNameType' + - description: '

The name of the policy document.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

' + required: + - GroupName + - PolicyName + - PolicyDocument + title: PutGroupPolicyRequest + type: object + PutRolePolicyRequest: + properties: + PolicyDocument: + allOf: + - $ref: '#/components/schemas/policyDocumentType' + - description: >- +

The policy document.

You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character + ranging from the space character (\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)

  • The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)

+ PolicyName: + allOf: + - $ref: '#/components/schemas/policyNameType' + - description: '

The name of the policy document.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

' + RoleName: + allOf: + - $ref: '#/components/schemas/roleNameType' + - description: '

The name of the role to associate the policy with.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

' + required: + - RoleName + - PolicyName + - PolicyDocument + title: PutRolePolicyRequest + type: object + PutUserPolicyRequest: + properties: + PolicyDocument: + allOf: + - $ref: '#/components/schemas/policyDocumentType' + - description: >- +

The policy document.

You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character + ranging from the space character (\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)

  • The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)

+ PolicyName: + allOf: + - $ref: '#/components/schemas/policyNameType' + - description: '

The name of the policy document.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

' + UserName: + allOf: + - $ref: '#/components/schemas/existingUserNameType' + - description: '

The name of the user to associate the policy with.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

' + required: + - UserName + - PolicyName + - PolicyDocument + title: PutUserPolicyRequest + type: object + ServiceFailureException: {} + Tag: + description: A key-value pair to associate with a resource. + type: object + additionalProperties: false + properties: + Value: + description: 'The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' + type: string minLength: 1 - maxLength: 255 + maxLength: 256 + Key: + description: 'The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' type: string - ThumbprintList: + minLength: 1 + maxLength: 128 + required: + - Value + - Key + TagPolicyRequest: + properties: + PolicyArn: + allOf: + - $ref: '#/components/schemas/arnType' + - description: '

The ARN of the IAM customer managed policy to which you want to add tags.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

' + Tags: + allOf: + - $ref: '#/components/schemas/tagListType' + - description: The list of tags that you want to attach to the IAM customer managed policy. Each tag consists of a key name and an associated value. + required: + - PolicyArn + - Tags + title: TagPolicyRequest + type: object + UnmodifiableEntityException: {} + UntagPolicyRequest: + properties: + PolicyArn: + allOf: + - $ref: '#/components/schemas/arnType' + - description: '

The ARN of the IAM customer managed policy from which you want to remove tags.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

' + TagKeys: + allOf: + - $ref: '#/components/schemas/tagKeyListType' + - description: A list of key names as a simple array of strings. The tags with matching keys are removed from the specified policy. + required: + - PolicyArn + - TagKeys + title: UntagPolicyRequest + type: object + arnType: + description:

The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.

For more information about ARNs, go to Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

+ maxLength: 2048 + minLength: 20 + type: string + attachmentCountType: + type: integer + booleanType: + type: boolean + dateType: + format: date-time + type: string + existingUserNameType: + maxLength: 128 + minLength: 1 + pattern: '[\w+=,.@-]+' + type: string + groupNameType: + maxLength: 128 + minLength: 1 + pattern: '[\w+=,.@-]+' + type: string + idType: + maxLength: 128 + minLength: 16 + pattern: '[\w]+' + type: string + markerType: + maxLength: 320 + minLength: 1 + pattern: '[\u0020-\u00FF]+' + type: string + maxItemsType: + maximum: 1000 + minimum: 1 + type: integer + policyDescriptionType: + maxLength: 1000 + type: string + policyDocumentType: + maxLength: 131072 + minLength: 1 + pattern: '[\u0009\u000A\u000D\u0020-\u00FF]+' + type: string + policyListType: + items: + allOf: + - $ref: '#/components/schemas/Policy' + - xml: + name: member + type: array + policyNameListType: + description:

Contains a list of policy names.

This data type is used as a response element in the ListPolicies operation.

+ items: + allOf: + - $ref: '#/components/schemas/policyNameType' + - xml: + name: member + type: array + policyNameType: + maxLength: 128 + minLength: 1 + pattern: '[\w+=,.@-]+' + type: string + policyPathType: + maxLength: 512 + minLength: 1 + pattern: ((/[A-Za-z0-9\.,\+@=_-]+)*)/ + type: string + policyScopeType: + enum: + - All + - AWS + - Local + type: string + policyVersionIdType: + pattern: v[1-9][0-9]*(\.[A-Za-z0-9-]*)? + type: string + responseMarkerType: + type: string + roleNameType: + maxLength: 64 + minLength: 1 + pattern: '[\w+=,.@-]+' + type: string + tagKeyListType: + items: + allOf: + - $ref: '#/components/schemas/tagKeyType' + - xml: + name: member + maxItems: 50 + type: array + tagKeyType: + maxLength: 128 + minLength: 1 + pattern: '[\p{L}\p{Z}\p{N}_.:/=+\-@]+' + type: string + tagListType: + items: + allOf: + - $ref: '#/components/schemas/Tag' + - xml: + name: member + maxItems: 50 + type: array + tagValueType: + maxLength: 256 + minLength: 0 + pattern: '[\p{L}\p{Z}\p{N}_.:/=+\-@]*' + type: string + userNameType: + maxLength: 64 + minLength: 1 + pattern: '[\w+=,.@-]+' + type: string + Group: + type: object + properties: + Arn: + description: '' + type: string + GroupName: + description: |- + The name of the group to create. Do not include the path in this value. + The group name must be unique within the account. Group names are not distinguished by case. For example, you cannot create groups named both "ADMINS" and "admins". If you don't specify a name, CFN generates a unique physical ID and uses that ID for the group name. + If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. + If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities). + Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using ``Fn::Join`` and ``AWS::Region`` to create a Region-specific name, as in the following example: ``{"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]}``. + type: string + ManagedPolicyArns: + description: |- + The Amazon Resource Name (ARN) of the IAM policy you want to attach. + For more information about ARNs, see [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*. type: array + uniqueItems: true x-insertionOrder: false items: - minLength: 40 - maxLength: 40 - pattern: '[0-9A-Fa-f]{40}' type: string - maxItems: 5 - Arn: - description: Amazon Resource Name (ARN) of the OIDC provider - minLength: 20 - maxLength: 2048 + Path: + description: |- + The path to the group. For more information about paths, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*. + This parameter is optional. If it is not included, it defaults to a slash (/). + This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\u0021``) through the DEL character (``\u007F``), including most punctuation characters, digits, and upper and lowercased letters. type: string - Tags: + Policies: + description: |- + Adds or updates an inline policy document that is embedded in the specified IAM group. To view AWS::IAM::Group snippets, see [Declaring an Group Resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-iam-group). + The name of each inline policy for a role, user, or group must be unique. If you don't choose unique names, updates to the IAM identity will fail. + For information about limits on the number of inline policies that you can embed in a group, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*. type: array uniqueItems: false x-insertionOrder: false items: - $ref: '#/components/schemas/Tag' - required: - - ThumbprintList - x-stackql-resource-name: oidc_provider - description: Resource Type definition for AWS::IAM::OIDCProvider - x-type-name: AWS::IAM::OIDCProvider + $ref: '#/components/schemas/Policy' + x-stackql-resource-name: group + description: |- + Creates a new group. + For information about the number of groups you can create, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*. + x-type-name: AWS::IAM::Group x-stackql-primary-identifier: - - Arn + - GroupName x-create-only-properties: - - Url + - GroupName x-read-only-properties: - Arn - x-required-properties: - - ThumbprintList x-tagging: - taggable: true - tagOnCreate: true - tagUpdatable: true - cloudFormationSystemTags: false - x-required-permissions: - create: - - iam:CreateOpenIDConnectProvider - - iam:TagOpenIDConnectProvider - - iam:GetOpenIDConnectProvider - read: - - iam:GetOpenIDConnectProvider - update: - - iam:UpdateOpenIDConnectProviderThumbprint - - iam:RemoveClientIDFromOpenIDConnectProvider - - iam:AddClientIDToOpenIDConnectProvider - - iam:GetOpenIDConnectProvider - - iam:TagOpenIDConnectProvider - - iam:UntagOpenIDConnectProvider - - iam:ListOpenIDConnectProviderTags - delete: - - iam:DeleteOpenIDConnectProvider - list: - - iam:ListOpenIDConnectProvider - - iam:GetOpenIDConnectProvider - Role: - type: object - properties: - Arn: - description: '' - type: string - AssumeRolePolicyDocument: - description: >- - The trust policy that is associated with this role. Trust policies define which entities can assume the role. You can associate only one trust policy with a role. For an example of a policy that can be used to assume a role, see [Template Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#aws-resource-iam-role--examples). For more information about the elements that you can use in an IAM policy, see [Policy Elements - Reference](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements.html) in the *User Guide*. - type: object - Description: - description: A description of the role that you provide. - type: string - ManagedPolicyArns: - description: |- - A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the role. - For more information about ARNs, see [Amazon Resource Names (ARNs) and Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*. - type: array - uniqueItems: true - x-insertionOrder: false - items: - type: string - MaxSessionDuration: - description: |- - The maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default value of one hour is applied. This setting can have a value from 1 hour to 12 hours. - Anyone who assumes the role from the CLI or API can use the ``DurationSeconds`` API parameter or the ``duration-seconds`` CLI parameter to request a longer session. The ``MaxSessionDuration`` setting determines the maximum duration that can be requested using the ``DurationSeconds`` parameter. If users don't specify a value for the ``DurationSeconds`` parameter, their security credentials are valid for one hour by default. This applies when you use the ``AssumeRole*`` API operations or the ``assume-role*`` CLI operations but does not apply when you use those operations to create a console URL. For more information, see [Using IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html) in the *IAM User Guide*. - type: integer - Path: - description: |- - The path to the role. For more information about paths, see [IAM Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*. - This parameter is optional. If it is not included, it defaults to a slash (/). - This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\u0021``) through the DEL character (``\u007F``), including most punctuation characters, digits, and upper and lowercased letters. - default: / - type: string - PermissionsBoundary: - description: |- - The ARN of the policy used to set the permissions boundary for the role. - For more information about permissions boundaries, see [Permissions boundaries for IAM identities](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) in the *IAM User Guide*. - type: string - Policies: - description: |- - Adds or updates an inline policy document that is embedded in the specified IAM role. - When you embed an inline policy in a role, the inline policy is used as part of the role's access (permissions) policy. The role's trust policy is created at the same time as the role. You can update a role's trust policy later. For more information about IAM roles, go to [Using Roles to Delegate Permissions and Federate Identities](https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html). - A role can also have an attached managed policy. For information about policies, see [Managed Policies and Inline Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *User Guide*. - For information about limits on the number of inline policies that you can embed with a role, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*. - If an external policy (such as ``AWS::IAM::Policy`` or - type: array - x-insertionOrder: false - uniqueItems: false - items: - $ref: '#/components/schemas/Policy' - RoleId: - description: '' - type: string - RoleName: - description: |- - A name for the IAM role, up to 64 characters in length. For valid values, see the ``RoleName`` parameter for the [CreateRole](https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html) action in the *User Guide*. - This parameter allows (per its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-. The role name must be unique within the account. Role names are not distinguished by case. For example, you cannot create roles named both "Role1" and "role1". - If you don't specify a name, CFN generates a unique physical ID and uses that ID for the role name. - If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/Use - type: string - Tags: - description: A list of tags that are attached to the role. For more information about tagging, see [Tagging IAM resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the *IAM User Guide*. - type: array - uniqueItems: false - x-insertionOrder: false - items: - $ref: '#/components/schemas/Tag' - required: - - AssumeRolePolicyDocument - x-stackql-resource-name: role - description: |- - Creates a new role for your AWS-account. - For more information about roles, see [IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) in the *IAM User Guide*. For information about quotas for role names and the number of roles you can create, see [IAM and quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*. - x-type-name: AWS::IAM::Role - x-stackql-primary-identifier: - - RoleName - x-create-only-properties: - - Path - - RoleName - x-read-only-properties: - - Arn - - RoleId - x-required-properties: - - AssumeRolePolicyDocument - x-tagging: - taggable: true - tagOnCreate: true - tagUpdatable: true + taggable: false + tagOnCreate: false + tagUpdatable: false cloudFormationSystemTags: false - tagProperty: /properties/Tags x-required-permissions: create: - - iam:CreateRole - - iam:PutRolePolicy - - iam:AttachRolePolicy - - iam:GetRolePolicy - - iam:TagRole - - iam:UntagRole - - iam:GetRole + - iam:CreateGroup + - iam:PutGroupPolicy + - iam:AttachGroupPolicy + - iam:GetGroupPolicy + - iam:GetGroup read: - - iam:GetRole - - iam:ListAttachedRolePolicies - - iam:ListRolePolicies - - iam:GetRolePolicy + - iam:GetGroup + - iam:ListGroupPolicies + - iam:GetGroupPolicy + - iam:ListAttachedGroupPolicies update: - - iam:UpdateRole - - iam:UpdateRoleDescription - - iam:UpdateAssumeRolePolicy - - iam:DetachRolePolicy - - iam:AttachRolePolicy - - iam:DeleteRolePermissionsBoundary - - iam:PutRolePermissionsBoundary - - iam:DeleteRolePolicy - - iam:PutRolePolicy - - iam:TagRole - - iam:UntagRole + - iam:GetGroup + - iam:UpdateGroup + - iam:DetachGroupPolicy + - iam:AttachGroupPolicy + - iam:DeleteGroupPolicy + - iam:PutGroupPolicy + - iam:GetGroupPolicy delete: - - iam:DeleteRole - - iam:DetachRolePolicy - - iam:DeleteRolePolicy - - iam:GetRole - - iam:ListAttachedRolePolicies - - iam:ListRolePolicies - - iam:TagRole - - iam:UntagRole + - iam:GetGroup + - iam:DeleteGroup + - iam:ListAttachedGroupPolicies + - iam:ListGroupPolicies + - iam:DetachGroupPolicy + - iam:DeleteGroupPolicy + - iam:GetGroupPolicy list: - - iam:ListRoles - RolePolicy: + - iam:ListGroups + GroupPolicy: type: object properties: PolicyDocument: @@ -990,30 +1225,29 @@ components: The name of the policy document. This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- type: string - RoleName: + GroupName: description: |- - The name of the role to associate the policy with. - This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + The name of the group to associate the policy with. + This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-. type: string required: - PolicyName - - RoleName - x-stackql-resource-name: role_policy + - GroupName + x-stackql-resource-name: group_policy description: |- - Adds or updates an inline policy document that is embedded in the specified IAM role. - When you embed an inline policy in a role, the inline policy is used as part of the role's access (permissions) policy. The role's trust policy is created at the same time as the role, using [CreateRole](https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html). You can update a role's trust policy using [UpdateAssumeRolePolicy](https://docs.aws.amazon.com/IAM/latest/APIReference/API_UpdateAssumeRolePolicy.html). For information about roles, see [roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html) in the *IAM User Guide*. - A role can also have a managed policy attached to it. To attach a managed policy to a role, use [AWS::IAM::Role](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html). To create a new managed policy, use [AWS::IAM::ManagedPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html). For information about policies, see [Managed policies and inline policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *IAM User Guide*. - For information about the maximum number of inline policies that you can embed with a role, see [IAM and quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*. - x-type-name: AWS::IAM::RolePolicy + Adds or updates an inline policy document that is embedded in the specified IAM group. + A group can also have managed policies attached to it. To attach a managed policy to a group, use [AWS::IAM::Group](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html). To create a new managed policy, use [AWS::IAM::ManagedPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html). For information about policies, see [Managed policies and inline policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *IAM User Guide*. + For information about the maximum number of inline policies that you can embed in a group, see [IAM and quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*. + x-type-name: AWS::IAM::GroupPolicy x-stackql-primary-identifier: - PolicyName - - RoleName + - GroupName x-create-only-properties: - PolicyName - - RoleName + - GroupName x-required-properties: - PolicyName - - RoleName + - GroupName x-tagging: taggable: false tagOnCreate: false @@ -1021,107 +1255,253 @@ components: cloudFormationSystemTags: false x-required-permissions: create: - - iam:PutRolePolicy - - iam:GetRolePolicy + - iam:PutGroupPolicy + - iam:GetGroupPolicy read: - - iam:GetRolePolicy + - iam:GetGroupPolicy update: - - iam:PutRolePolicy - - iam:GetRolePolicy + - iam:PutGroupPolicy + - iam:GetGroupPolicy delete: - - iam:DeleteRolePolicy - - iam:GetRolePolicy - SAMLProvider: + - iam:DeleteGroupPolicy + - iam:GetGroupPolicy + InstanceProfile: type: object properties: - Name: - minLength: 1 - maxLength: 128 - pattern: '[\w._-]+' - type: string - SamlMetadataDocument: - minLength: 1000 - maxLength: 10000000 - type: string - Arn: - description: Amazon Resource Name (ARN) of the SAML provider - minLength: 1 - maxLength: 1600 + Path: type: string - Tags: + description: |- + The path to the instance profile. For more information about paths, see [IAM Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*. + This parameter is optional. If it is not included, it defaults to a slash (/). + This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\u0021``) through the DEL character (``\u007F``), including most punctuation characters, digits, and upper and lowercased letters. + Roles: type: array - uniqueItems: false + description: The name of the role to associate with the instance profile. Only one role can be assigned to an EC2 instance at a time, and all applications on the instance share the same role and permissions. + uniqueItems: true x-insertionOrder: false items: - $ref: '#/components/schemas/Tag' + type: string + InstanceProfileName: + type: string + description: |- + The name of the instance profile to create. + This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + Arn: + type: string + description: '' required: - - SamlMetadataDocument - x-stackql-resource-name: saml_provider - description: Resource Type definition for AWS::IAM::SAMLProvider - x-type-name: AWS::IAM::SAMLProvider + - Roles + x-stackql-resource-name: instance_profile + description: |- + Creates a new instance profile. For information about instance profiles, see [Using instance profiles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html). + For information about the number of instance profiles you can create, see [object quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *User Guide*. + x-type-name: AWS::IAM::InstanceProfile x-stackql-primary-identifier: - - Arn + - InstanceProfileName x-create-only-properties: - - Name + - InstanceProfileName + - Path x-read-only-properties: - Arn x-required-properties: - - SamlMetadataDocument - x-tagging: - taggable: true - tagOnCreate: true - tagUpdatable: true - cloudFormationSystemTags: false + - Roles x-required-permissions: create: - - iam:CreateSAMLProvider - - iam:GetSAMLProvider - - iam:TagSAMLProvider + - iam:CreateInstanceProfile + - iam:PassRole + - iam:AddRoleToInstanceProfile + - iam:GetInstanceProfile read: - - iam:GetSAMLProvider + - iam:GetInstanceProfile update: - - iam:UpdateSAMLProvider - - iam:GetSAMLProvider - - iam:TagSAMLProvider - - iam:ListSAMLProviderTags - - iam:UntagSAMLProvider + - iam:PassRole + - iam:RemoveRoleFromInstanceProfile + - iam:AddRoleToInstanceProfile + - iam:GetInstanceProfile delete: - - iam:DeleteSAMLProvider + - iam:GetInstanceProfile + - iam:RemoveRoleFromInstanceProfile + - iam:DeleteInstanceProfile list: - - iam:ListSAMLProviders - - iam:GetSAMLProvider - ServerCertificate: + - iam:ListInstanceProfiles + ManagedPolicy: type: object properties: - CertificateBody: - minLength: 1 - maxLength: 16384 - pattern: '[\u0009\u000A\u000D\u0020-\u00FF]+' - type: string - CertificateChain: - minLength: 1 - maxLength: 2097152 - pattern: '[\u0009\u000A\u000D\u0020-\u00FF]+' + Description: type: string - ServerCertificateName: - minLength: 1 - maxLength: 128 - pattern: '[\w+=,.@-]+' + description: |- + A friendly description of the policy. + Typically used to store information about the permissions defined in the policy. For example, "Grants access to production DynamoDB tables." + The policy description is immutable. After a value is assigned, it cannot be changed. + Groups: + x-insertionOrder: false + type: array + description: |- + The name (friendly name, not ARN) of the group to attach the policy to. + This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + uniqueItems: true + items: + type: string + ManagedPolicyName: type: string + description: |- + The friendly name of the policy. + If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. + If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities). + Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using ``Fn::Join`` and ``AWS::Region`` to create a Region-specific name, as in the following example: ``{"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]}``. Path: - minLength: 1 - maxLength: 512 - pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F) type: string - PrivateKey: + default: / + description: |- + The path for the policy. + For more information about paths, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*. + This parameter is optional. If it is not included, it defaults to a slash (/). + This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\u0021``) through the DEL character (``\u007F``), including most punctuation characters, digits, and upper and lowercased letters. + You cannot use an asterisk (*) in the path name. + PolicyDocument: + type: object + description: |- + The JSON policy document that you want to use as the content for the new policy. + You must provide policies in JSON format in IAM. However, for CFN templates formatted in YAML, you can provide the policy in JSON or YAML format. CFN always converts a YAML policy to JSON format before submitting it to IAM. + The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see [IAM and character quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length). + To learn more about JSON policy grammar, see [Grammar of the IAM JSON policy language](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_grammar.html) in the *IAM User Guide*. + The [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex) used to validate this parameter is a string of characters consisting of the following: + + Any printable ASCII character ranging from the space character (``\u0020``) through the end of the ASCII character range + + The printable characters in the Basic Latin and Latin-1 Supplement character set (through ``\u00FF``) + + The special characters tab (``\u0009``), line feed (``\u000A``), and carriage return (``\u000D``) + Roles: + x-insertionOrder: false + type: array + description: |- + The name (friendly name, not ARN) of the role to attach the policy to. + This parameter allows (per its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + If an external policy (such as ``AWS::IAM::Policy`` or ``AWS::IAM::ManagedPolicy``) has a ``Ref`` to a role and if a resource (such as ``AWS::ECS::Service``) also has a ``Ref`` to the same role, add a ``DependsOn`` attribute to the resource to make the resource depend on the external policy. This dependency ensures that the role's policy is available throughout the resource's lifecycle. For example, when you delete a stack with an ``AWS::ECS::Service`` resource, the ``DependsOn`` attribute ensures that CFN deletes the ``AWS::ECS::Service`` resource before deleting its role's policy. + uniqueItems: true + items: + type: string + Users: + x-insertionOrder: false + type: array + description: |- + The name (friendly name, not ARN) of the IAM user to attach the policy to. + This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + uniqueItems: true + items: + type: string + PolicyArn: + type: string + description: '' + AttachmentCount: + type: integer + description: '' + CreateDate: + type: string + description: '' + UpdateDate: + type: string + description: '' + DefaultVersionId: + type: string + description: '' + IsAttachable: + type: boolean + description: '' + PermissionsBoundaryUsageCount: + type: integer + description: '' + PolicyId: + type: string + description: '' + required: + - PolicyDocument + x-stackql-resource-name: managed_policy + description: |- + Creates a new managed policy for your AWS-account. + This operation creates a policy version with a version identifier of ``v1`` and sets v1 as the policy's default version. For more information about policy versions, see [Versioning for managed policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html) in the *IAM User Guide*. + As a best practice, you can validate your IAM policies. To learn more, see [Validating IAM policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_policy-validator.html) in the *IAM User Guide*. + For more information about managed policies in general, see [Managed policies and inline policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *IAM User Guide*. + x-type-name: AWS::IAM::ManagedPolicy + x-stackql-primary-identifier: + - PolicyArn + x-create-only-properties: + - ManagedPolicyName + - Description + - Path + x-read-only-properties: + - PolicyArn + - AttachmentCount + - CreateDate + - DefaultVersionId + - IsAttachable + - PermissionsBoundaryUsageCount + - PolicyId + - UpdateDate + x-required-properties: + - PolicyDocument + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - iam:CreatePolicy + - iam:AttachGroupPolicy + - iam:AttachUserPolicy + - iam:AttachRolePolicy + read: + - iam:GetPolicy + - iam:ListEntitiesForPolicy + - iam:GetPolicyVersion + update: + - iam:DetachRolePolicy + - iam:GetPolicy + - iam:ListPolicyVersions + - iam:DetachGroupPolicy + - iam:DetachUserPolicy + - iam:CreatePolicyVersion + - iam:DeletePolicyVersion + - iam:AttachGroupPolicy + - iam:AttachUserPolicy + - iam:AttachRolePolicy + delete: + - iam:DetachRolePolicy + - iam:GetPolicy + - iam:ListPolicyVersions + - iam:DetachGroupPolicy + - iam:DetachUserPolicy + - iam:DeletePolicyVersion + - iam:DeletePolicy + - iam:ListEntitiesForPolicy + list: + - iam:ListPolicies + OIDCProvider: + type: object + properties: + ClientIdList: + type: array + x-insertionOrder: false + items: + minLength: 1 + maxLength: 255 + type: string + Url: minLength: 1 - maxLength: 16384 - pattern: '[\u0009\u000A\u000D\u0020-\u00FF]+' + maxLength: 255 type: string + ThumbprintList: + type: array + x-insertionOrder: false + items: + minLength: 40 + maxLength: 40 + pattern: '[0-9A-Fa-f]{40}' + type: string + maxItems: 5 Arn: - description: Amazon Resource Name (ARN) of the server certificate - minLength: 1 - maxLength: 1600 + description: Amazon Resource Name (ARN) of the OIDC provider + minLength: 20 + maxLength: 2048 type: string Tags: type: array @@ -1129,22 +1509,19 @@ components: x-insertionOrder: false items: $ref: '#/components/schemas/Tag' - x-stackql-resource-name: server_certificate - description: Resource Type definition for AWS::IAM::ServerCertificate - x-type-name: AWS::IAM::ServerCertificate + required: + - ThumbprintList + x-stackql-resource-name: oidc_provider + description: Resource Type definition for AWS::IAM::OIDCProvider + x-type-name: AWS::IAM::OIDCProvider x-stackql-primary-identifier: - - ServerCertificateName + - Arn x-create-only-properties: - - ServerCertificateName - - PrivateKey - - CertificateBody - - CertificateChain - x-write-only-properties: - - PrivateKey - - CertificateBody - - CertificateChain + - Url x-read-only-properties: - Arn + x-required-properties: + - ThumbprintList x-tagging: taggable: true tagOnCreate: true @@ -1152,162 +1529,110 @@ components: cloudFormationSystemTags: false x-required-permissions: create: - - iam:UploadServerCertificate - - iam:TagServerCertificate - - iam:GetServerCertificate + - iam:CreateOpenIDConnectProvider + - iam:TagOpenIDConnectProvider + - iam:GetOpenIDConnectProvider read: - - iam:GetServerCertificate + - iam:GetOpenIDConnectProvider update: - - iam:TagServerCertificate - - iam:UntagServerCertificate - - iam:ListServerCertificateTags - - iam:GetServerCertificate + - iam:UpdateOpenIDConnectProviderThumbprint + - iam:RemoveClientIDFromOpenIDConnectProvider + - iam:AddClientIDToOpenIDConnectProvider + - iam:GetOpenIDConnectProvider + - iam:TagOpenIDConnectProvider + - iam:UntagOpenIDConnectProvider + - iam:ListOpenIDConnectProviderTags delete: - - iam:DeleteServerCertificate + - iam:DeleteOpenIDConnectProvider list: - - iam:ListServerCertificates - - iam:GetServerCertificate - ServiceLinkedRole: + - iam:ListOpenIDConnectProvider + - iam:GetOpenIDConnectProvider + Role: type: object properties: - RoleName: - description: The name of the role. - type: string - CustomSuffix: - description: A string that you provide, which is combined with the service-provided prefix to form the complete role name. + Arn: + description: '' type: string + AssumeRolePolicyDocument: + description: >- + The trust policy that is associated with this role. Trust policies define which entities can assume the role. You can associate only one trust policy with a role. For an example of a policy that can be used to assume a role, see [Template Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#aws-resource-iam-role--examples). For more information about the elements that you can use in an IAM policy, see [Policy Elements + Reference](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements.html) in the *User Guide*. + type: object Description: - description: The description of the role. - type: string - AWSServiceName: - description: The service principal for the AWS service to which this role is attached. - type: string - required: [] - x-stackql-resource-name: service_linked_role - description: Resource Type definition for AWS::IAM::ServiceLinkedRole - x-type-name: AWS::IAM::ServiceLinkedRole - x-stackql-primary-identifier: - - RoleName - x-create-only-properties: - - CustomSuffix - - AWSServiceName - x-write-only-properties: - - CustomSuffix - - AWSServiceName - x-read-only-properties: - - RoleName - x-required-properties: [] - x-tagging: - taggable: false - tagOnCreate: false - tagUpdatable: false - cloudFormationSystemTags: false - x-required-permissions: - create: - - iam:CreateServiceLinkedRole - - iam:GetRole - read: - - iam:GetRole - update: - - iam:UpdateRole - - iam:GetRole - delete: - - iam:DeleteServiceLinkedRole - - iam:GetServiceLinkedRoleDeletionStatus - - iam:GetRole - LoginProfile: - description: Creates a password for the specified user, giving the user the ability to access AWS services through the console. For more information about managing passwords, see [Managing Passwords](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html) in the *User Guide*. - type: object - additionalProperties: false - properties: - PasswordResetRequired: - description: Specifies whether the user is required to set a new password on next sign-in. - type: boolean - Password: - description: The user's password. - type: string - required: - - Password - User: - type: object - properties: - Path: - description: |- - The path for the user name. For more information about paths, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*. - This parameter is optional. If it is not included, it defaults to a slash (/). - This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\u0021``) through the DEL character (``\u007F``), including most punctuation characters, digits, and upper and lowercased letters. + description: A description of the role that you provide. type: string ManagedPolicyArns: description: |- - A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the user. + A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the role. For more information about ARNs, see [Amazon Resource Names (ARNs) and Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*. type: array uniqueItems: true x-insertionOrder: false items: type: string - Policies: + MaxSessionDuration: description: |- - Adds or updates an inline policy document that is embedded in the specified IAM user. To view AWS::IAM::User snippets, see [Declaring an User Resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-iam-user). - The name of each policy for a role, user, or group must be unique. If you don't choose unique names, updates to the IAM identity will fail. - For information about limits on the number of inline policies that you can embed in a user, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*. - type: array - uniqueItems: false - x-insertionOrder: false - items: - $ref: '#/components/schemas/Policy' - UserName: + The maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default value of one hour is applied. This setting can have a value from 1 hour to 12 hours. + Anyone who assumes the role from the CLI or API can use the ``DurationSeconds`` API parameter or the ``duration-seconds`` CLI parameter to request a longer session. The ``MaxSessionDuration`` setting determines the maximum duration that can be requested using the ``DurationSeconds`` parameter. If users don't specify a value for the ``DurationSeconds`` parameter, their security credentials are valid for one hour by default. This applies when you use the ``AssumeRole*`` API operations or the ``assume-role*`` CLI operations but does not apply when you use those operations to create a console URL. For more information, see [Using IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html) in the *IAM User Guide*. + type: integer + Path: description: |- - The name of the user to create. Do not include the path in this value. - This parameter allows (per its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-. The user name must be unique within the account. User names are not distinguished by case. For example, you cannot create users named both "John" and "john". - If you don't specify a name, CFN generates a unique physical ID and uses that ID for the user name. - If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities). - Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using ``Fn::Join`` and ``AWS::Region`` to create a Region-specific name, as in the following example: ``{"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]}``. + The path to the role. For more information about paths, see [IAM Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*. + This parameter is optional. If it is not included, it defaults to a slash (/). + This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\u0021``) through the DEL character (``\u007F``), including most punctuation characters, digits, and upper and lowercased letters. + default: / type: string - Groups: - description: A list of group names to which you want to add the user. + PermissionsBoundary: + description: |- + The ARN of the policy used to set the permissions boundary for the role. + For more information about permissions boundaries, see [Permissions boundaries for IAM identities](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) in the *IAM User Guide*. + type: string + Policies: + description: |- + Adds or updates an inline policy document that is embedded in the specified IAM role. + When you embed an inline policy in a role, the inline policy is used as part of the role's access (permissions) policy. The role's trust policy is created at the same time as the role. You can update a role's trust policy later. For more information about IAM roles, go to [Using Roles to Delegate Permissions and Federate Identities](https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html). + A role can also have an attached managed policy. For information about policies, see [Managed Policies and Inline Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *User Guide*. + For information about limits on the number of inline policies that you can embed with a role, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*. + If an external policy (such as ``AWS::IAM::Policy`` or type: array - uniqueItems: false x-insertionOrder: false + uniqueItems: false items: - type: string - Arn: + $ref: '#/components/schemas/Policy' + RoleId: description: '' type: string - LoginProfile: + RoleName: description: |- - Creates a password for the specified IAM user. A password allows an IAM user to access AWS services through the console. - You can use the CLI, the AWS API, or the *Users* page in the IAM console to create a password for any IAM user. Use [ChangePassword](https://docs.aws.amazon.com/IAM/latest/APIReference/API_ChangePassword.html) to update your own existing password in the *My Security Credentials* page in the console. - For more information about managing passwords, see [Managing passwords](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html) in the *User Guide*. - $ref: '#/components/schemas/LoginProfile' + A name for the IAM role, up to 64 characters in length. For valid values, see the ``RoleName`` parameter for the [CreateRole](https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html) action in the *User Guide*. + This parameter allows (per its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-. The role name must be unique within the account. Role names are not distinguished by case. For example, you cannot create roles named both "Role1" and "role1". + If you don't specify a name, CFN generates a unique physical ID and uses that ID for the role name. + If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/Use + type: string Tags: - description: |- - A list of tags that you want to attach to the new user. Each tag consists of a key name and an associated value. For more information about tagging, see [Tagging IAM resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the *IAM User Guide*. - If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. + description: A list of tags that are attached to the role. For more information about tagging, see [Tagging IAM resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the *IAM User Guide*. type: array uniqueItems: false x-insertionOrder: false items: $ref: '#/components/schemas/Tag' - PermissionsBoundary: - description: |- - The ARN of the managed policy that is used to set the permissions boundary for the user. - A permissions boundary policy defines the maximum permissions that identity-based policies can grant to an entity, but does not grant permissions. Permissions boundaries do not define the maximum permissions that a resource-based policy can grant to an entity. To learn more, see [Permissions boundaries for IAM entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) in the *IAM User Guide*. - For more information about policy types, see [Policy types](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policy-types) in the *IAM User Guide*. - type: string - x-stackql-resource-name: user + required: + - AssumeRolePolicyDocument + x-stackql-resource-name: role description: |- - Creates a new IAM user for your AWS-account. - For information about quotas for the number of IAM users you can create, see [IAM and quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*. - x-type-name: AWS::IAM::User + Creates a new role for your AWS-account. + For more information about roles, see [IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) in the *IAM User Guide*. For information about quotas for role names and the number of roles you can create, see [IAM and quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*. + x-type-name: AWS::IAM::Role x-stackql-primary-identifier: - - UserName + - RoleName x-create-only-properties: - - UserName - x-write-only-properties: - - LoginProfile/Password + - Path + - RoleName x-read-only-properties: - Arn + - RoleId + x-required-properties: + - AssumeRolePolicyDocument x-tagging: taggable: true tagOnCreate: true @@ -1316,55 +1641,42 @@ components: tagProperty: /properties/Tags x-required-permissions: create: - - iam:CreateLoginProfile - - iam:AddUserToGroup - - iam:PutUserPolicy - - iam:AttachUserPolicy - - iam:CreateUser - - iam:GetUser - - iam:TagUser + - iam:CreateRole + - iam:PutRolePolicy + - iam:AttachRolePolicy + - iam:GetRolePolicy + - iam:TagRole + - iam:UntagRole + - iam:GetRole read: - - iam:GetUserPolicy - - iam:ListGroupsForUser - - iam:ListAttachedUserPolicies - - iam:ListUserPolicies - - iam:GetUser - - iam:GetLoginProfile + - iam:GetRole + - iam:ListAttachedRolePolicies + - iam:ListRolePolicies + - iam:GetRolePolicy update: - - iam:UpdateLoginProfile - - iam:UpdateUser - - iam:PutUserPermissionsBoundary - - iam:AttachUserPolicy - - iam:DeleteUserPolicy - - iam:DeleteUserPermissionsBoundary - - iam:TagUser - - iam:UntagUser - - iam:CreateLoginProfile - - iam:RemoveUserFromGroup - - iam:AddUserToGroup - - iam:PutUserPolicy - - iam:DetachUserPolicy - - iam:GetLoginProfile - - iam:DeleteLoginProfile - - iam:GetUser - - iam:ListUserTags + - iam:UpdateRole + - iam:UpdateRoleDescription + - iam:UpdateAssumeRolePolicy + - iam:DetachRolePolicy + - iam:AttachRolePolicy + - iam:DeleteRolePermissionsBoundary + - iam:PutRolePermissionsBoundary + - iam:DeleteRolePolicy + - iam:PutRolePolicy + - iam:TagRole + - iam:UntagRole delete: - - iam:DeleteAccessKey - - iam:RemoveUserFromGroup - - iam:DeleteUserPolicy - - iam:DeleteUser - - iam:DetachUserPolicy - - iam:DeleteLoginProfile - - iam:ListAccessKeys - - iam:GetUserPolicy - - iam:ListGroupsForUser - - iam:ListAttachedUserPolicies - - iam:ListUserPolicies - - iam:GetUser - - iam:GetLoginProfile + - iam:DeleteRole + - iam:DetachRolePolicy + - iam:DeleteRolePolicy + - iam:GetRole + - iam:ListAttachedRolePolicies + - iam:ListRolePolicies + - iam:TagRole + - iam:UntagRole list: - - iam:listUsers - UserPolicy: + - iam:ListRoles + RolePolicy: type: object properties: PolicyDocument: @@ -1381,29 +1693,30 @@ components: The name of the policy document. This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- type: string - UserName: + RoleName: description: |- - The name of the user to associate the policy with. + The name of the role to associate the policy with. This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- type: string required: - PolicyName - - UserName - x-stackql-resource-name: user_policy + - RoleName + x-stackql-resource-name: role_policy description: |- - Adds or updates an inline policy document that is embedded in the specified IAM user. - An IAM user can also have a managed policy attached to it. To attach a managed policy to a user, use [AWS::IAM::User](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html). To create a new managed policy, use [AWS::IAM::ManagedPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html). For information about policies, see [Managed policies and inline policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *IAM User Guide*. - For information about the maximum number of inline policies that you can embed in a user, see [IAM and quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*. - x-type-name: AWS::IAM::UserPolicy + Adds or updates an inline policy document that is embedded in the specified IAM role. + When you embed an inline policy in a role, the inline policy is used as part of the role's access (permissions) policy. The role's trust policy is created at the same time as the role, using [CreateRole](https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html). You can update a role's trust policy using [UpdateAssumeRolePolicy](https://docs.aws.amazon.com/IAM/latest/APIReference/API_UpdateAssumeRolePolicy.html). For information about roles, see [roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html) in the *IAM User Guide*. + A role can also have a managed policy attached to it. To attach a managed policy to a role, use [AWS::IAM::Role](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html). To create a new managed policy, use [AWS::IAM::ManagedPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html). For information about policies, see [Managed policies and inline policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *IAM User Guide*. + For information about the maximum number of inline policies that you can embed with a role, see [IAM and quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*. + x-type-name: AWS::IAM::RolePolicy x-stackql-primary-identifier: - PolicyName - - UserName + - RoleName x-create-only-properties: - PolicyName - - UserName + - RoleName x-required-properties: - PolicyName - - UserName + - RoleName x-tagging: taggable: false tagOnCreate: false @@ -1411,352 +1724,465 @@ components: cloudFormationSystemTags: false x-required-permissions: create: - - iam:PutUserPolicy - - iam:GetUserPolicy + - iam:PutRolePolicy + - iam:GetRolePolicy read: - - iam:GetUserPolicy + - iam:GetRolePolicy update: - - iam:PutUserPolicy - - iam:GetUserPolicy + - iam:PutRolePolicy + - iam:GetRolePolicy delete: - - iam:DeleteUserPolicy - - iam:GetUserPolicy - VirtualMFADevice: + - iam:DeleteRolePolicy + - iam:GetRolePolicy + SAMLProvider: type: object properties: - VirtualMfaDeviceName: + Name: minLength: 1 - maxLength: 226 - pattern: '[\w+=,.@-]+' + maxLength: 128 + pattern: '[\w._-]+' type: string - Path: - minLength: 1 - maxLength: 512 - pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F) + SamlMetadataDocument: + minLength: 1000 + maxLength: 10000000 type: string - SerialNumber: - minLength: 9 - maxLength: 256 - pattern: '[\w+=/:,.@-]+' + Arn: + description: Amazon Resource Name (ARN) of the SAML provider + minLength: 1 + maxLength: 1600 type: string - Users: - type: array - uniqueItems: false - items: - type: string Tags: type: array uniqueItems: false + x-insertionOrder: false items: $ref: '#/components/schemas/Tag' required: - - Users - x-stackql-resource-name: virtualmfa_device - description: Resource Type definition for AWS::IAM::VirtualMFADevice - x-type-name: AWS::IAM::VirtualMFADevice + - SamlMetadataDocument + x-stackql-resource-name: saml_provider + description: Resource Type definition for AWS::IAM::SAMLProvider + x-type-name: AWS::IAM::SAMLProvider x-stackql-primary-identifier: - - SerialNumber + - Arn x-create-only-properties: - - VirtualMfaDeviceName - - Base32StringSeed - - Path + - Name x-read-only-properties: - - SerialNumber + - Arn x-required-properties: - - Users + - SamlMetadataDocument + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false x-required-permissions: create: - - iam:CreateVirtualMFADevice - - iam:EnableMFADevice - - iam:ListVirtualMFADevices + - iam:CreateSAMLProvider + - iam:GetSAMLProvider + - iam:TagSAMLProvider read: - - iam:ListVirtualMFADevices + - iam:GetSAMLProvider update: - - iam:TagMFADevice - - iam:UntagMFADevice + - iam:UpdateSAMLProvider + - iam:GetSAMLProvider + - iam:TagSAMLProvider + - iam:ListSAMLProviderTags + - iam:UntagSAMLProvider delete: - - iam:DeleteVirtualMFADevice - - iam:DeactivateMFADevice + - iam:DeleteSAMLProvider list: - - iam:ListVirtualMFADevices - CreateGroupRequest: + - iam:ListSAMLProviders + - iam:GetSAMLProvider + ServerCertificate: + type: object properties: - ClientToken: + CertificateBody: + minLength: 1 + maxLength: 16384 + pattern: '[\u0009\u000A\u000D\u0020-\u00FF]+' type: string - RoleArn: + CertificateChain: + minLength: 1 + maxLength: 2097152 + pattern: '[\u0009\u000A\u000D\u0020-\u00FF]+' type: string - TypeName: + ServerCertificateName: + minLength: 1 + maxLength: 128 + pattern: '[\w+=,.@-]+' type: string - TypeVersionId: + Path: + minLength: 1 + maxLength: 512 + pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F) type: string - DesiredState: - type: object - properties: - Arn: - description: '' - type: string - GroupName: - description: |- - The name of the group to create. Do not include the path in this value. - The group name must be unique within the account. Group names are not distinguished by case. For example, you cannot create groups named both "ADMINS" and "admins". If you don't specify a name, CFN generates a unique physical ID and uses that ID for the group name. - If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. - If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities). - Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using ``Fn::Join`` and ``AWS::Region`` to create a Region-specific name, as in the following example: ``{"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]}``. - type: string - ManagedPolicyArns: - description: |- - The Amazon Resource Name (ARN) of the IAM policy you want to attach. - For more information about ARNs, see [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*. - type: array - uniqueItems: true - x-insertionOrder: false - items: - type: string - Path: - description: |- - The path to the group. For more information about paths, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*. - This parameter is optional. If it is not included, it defaults to a slash (/). - This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\u0021``) through the DEL character (``\u007F``), including most punctuation characters, digits, and upper and lowercased letters. - type: string - Policies: - description: |- - Adds or updates an inline policy document that is embedded in the specified IAM group. To view AWS::IAM::Group snippets, see [Declaring an Group Resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-iam-group). - The name of each inline policy for a role, user, or group must be unique. If you don't choose unique names, updates to the IAM identity will fail. - For information about limits on the number of inline policies that you can embed in a group, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*. - type: array - uniqueItems: false - x-insertionOrder: false - items: - $ref: '#/components/schemas/Policy' - x-stackQL-stringOnly: true - x-title: CreateGroupRequest + PrivateKey: + minLength: 1 + maxLength: 16384 + pattern: '[\u0009\u000A\u000D\u0020-\u00FF]+' + type: string + Arn: + description: Amazon Resource Name (ARN) of the server certificate + minLength: 1 + maxLength: 1600 + type: string + Tags: + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackql-resource-name: server_certificate + description: Resource Type definition for AWS::IAM::ServerCertificate + x-type-name: AWS::IAM::ServerCertificate + x-stackql-primary-identifier: + - ServerCertificateName + x-create-only-properties: + - ServerCertificateName + - PrivateKey + - CertificateBody + - CertificateChain + x-write-only-properties: + - PrivateKey + - CertificateBody + - CertificateChain + x-read-only-properties: + - Arn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + x-required-permissions: + create: + - iam:UploadServerCertificate + - iam:TagServerCertificate + - iam:GetServerCertificate + read: + - iam:GetServerCertificate + update: + - iam:TagServerCertificate + - iam:UntagServerCertificate + - iam:ListServerCertificateTags + - iam:GetServerCertificate + delete: + - iam:DeleteServerCertificate + list: + - iam:ListServerCertificates + - iam:GetServerCertificate + ServiceLinkedRole: type: object - required: [] - CreateGroupPolicyRequest: properties: - ClientToken: + RoleName: + description: The name of the role. type: string - RoleArn: + CustomSuffix: + description: A string that you provide, which is combined with the service-provided prefix to form the complete role name. type: string - TypeName: + Description: + description: The description of the role. type: string - TypeVersionId: + AWSServiceName: + description: The service principal for the AWS service to which this role is attached. type: string - DesiredState: - type: object - properties: - PolicyDocument: - description: |- - The policy document. - You must provide policies in JSON format in IAM. However, for CFN templates formatted in YAML, you can provide the policy in JSON or YAML format. CFN always converts a YAML policy to JSON format before submitting it to IAM. - The [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex) used to validate this parameter is a string of characters consisting of the following: - + Any printable ASCII character ranging from the space character (``\u0020``) through the end of the ASCII character range - + The printable characters in the Basic Latin and Latin-1 Supplement character set (through ``\u00FF``) - + The special characters tab (``\u0009``), line feed (``\u000A``), and carriage return (``\u000D``) - type: object - PolicyName: - description: |- - The name of the policy document. - This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- - type: string - GroupName: - description: |- - The name of the group to associate the policy with. - This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-. - type: string - x-stackQL-stringOnly: true - x-title: CreateGroupPolicyRequest - type: object required: [] - CreateInstanceProfileRequest: - properties: - ClientToken: - type: string - RoleArn: - type: string - TypeName: - type: string - TypeVersionId: - type: string - DesiredState: - type: object - properties: - Path: - type: string - description: |- - The path to the instance profile. For more information about paths, see [IAM Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*. - This parameter is optional. If it is not included, it defaults to a slash (/). - This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\u0021``) through the DEL character (``\u007F``), including most punctuation characters, digits, and upper and lowercased letters. - Roles: - type: array - description: The name of the role to associate with the instance profile. Only one role can be assigned to an EC2 instance at a time, and all applications on the instance share the same role and permissions. - uniqueItems: true - x-insertionOrder: false - items: - type: string - InstanceProfileName: - type: string - description: |- - The name of the instance profile to create. - This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- - Arn: - type: string - description: '' - x-stackQL-stringOnly: true - x-title: CreateInstanceProfileRequest + x-stackql-resource-name: service_linked_role + description: Resource Type definition for AWS::IAM::ServiceLinkedRole + x-type-name: AWS::IAM::ServiceLinkedRole + x-stackql-primary-identifier: + - RoleName + x-create-only-properties: + - CustomSuffix + - AWSServiceName + x-write-only-properties: + - CustomSuffix + - AWSServiceName + x-read-only-properties: + - RoleName + x-required-properties: [] + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - iam:CreateServiceLinkedRole + - iam:GetRole + read: + - iam:GetRole + update: + - iam:UpdateRole + - iam:GetRole + delete: + - iam:DeleteServiceLinkedRole + - iam:GetServiceLinkedRoleDeletionStatus + - iam:GetRole + LoginProfile: + description: Creates a password for the specified user, giving the user the ability to access AWS services through the console. For more information about managing passwords, see [Managing Passwords](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html) in the *User Guide*. type: object - required: [] - CreateManagedPolicyRequest: + additionalProperties: false properties: - ClientToken: - type: string - RoleArn: - type: string - TypeName: - type: string - TypeVersionId: + PasswordResetRequired: + description: Specifies whether the user is required to set a new password on next sign-in. + type: boolean + Password: + description: The user's password. type: string - DesiredState: - type: object - properties: - Description: - type: string - description: |- - A friendly description of the policy. - Typically used to store information about the permissions defined in the policy. For example, "Grants access to production DynamoDB tables." - The policy description is immutable. After a value is assigned, it cannot be changed. - Groups: - x-insertionOrder: false - type: array - description: |- - The name (friendly name, not ARN) of the group to attach the policy to. - This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- - uniqueItems: true - items: - type: string - ManagedPolicyName: - type: string - description: |- - The friendly name of the policy. - If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. - If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities). - Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using ``Fn::Join`` and ``AWS::Region`` to create a Region-specific name, as in the following example: ``{"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]}``. - Path: - type: string - default: / - description: |- - The path for the policy. - For more information about paths, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*. - This parameter is optional. If it is not included, it defaults to a slash (/). - This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\u0021``) through the DEL character (``\u007F``), including most punctuation characters, digits, and upper and lowercased letters. - You cannot use an asterisk (*) in the path name. - PolicyDocument: - type: object - description: |- - The JSON policy document that you want to use as the content for the new policy. - You must provide policies in JSON format in IAM. However, for CFN templates formatted in YAML, you can provide the policy in JSON or YAML format. CFN always converts a YAML policy to JSON format before submitting it to IAM. - The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see [IAM and character quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length). - To learn more about JSON policy grammar, see [Grammar of the IAM JSON policy language](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_grammar.html) in the *IAM User Guide*. - The [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex) used to validate this parameter is a string of characters consisting of the following: - + Any printable ASCII character ranging from the space character (``\u0020``) through the end of the ASCII character range - + The printable characters in the Basic Latin and Latin-1 Supplement character set (through ``\u00FF``) - + The special characters tab (``\u0009``), line feed (``\u000A``), and carriage return (``\u000D``) - Roles: - x-insertionOrder: false - type: array - description: |- - The name (friendly name, not ARN) of the role to attach the policy to. - This parameter allows (per its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- - If an external policy (such as ``AWS::IAM::Policy`` or ``AWS::IAM::ManagedPolicy``) has a ``Ref`` to a role and if a resource (such as ``AWS::ECS::Service``) also has a ``Ref`` to the same role, add a ``DependsOn`` attribute to the resource to make the resource depend on the external policy. This dependency ensures that the role's policy is available throughout the resource's lifecycle. For example, when you delete a stack with an ``AWS::ECS::Service`` resource, the ``DependsOn`` attribute ensures that CFN deletes the ``AWS::ECS::Service`` resource before deleting its role's policy. - uniqueItems: true - items: - type: string - Users: - x-insertionOrder: false - type: array - description: |- - The name (friendly name, not ARN) of the IAM user to attach the policy to. - This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- - uniqueItems: true - items: - type: string - PolicyArn: - type: string - description: '' - AttachmentCount: - type: integer - description: '' - CreateDate: - type: string - description: '' - UpdateDate: - type: string - description: '' - DefaultVersionId: - type: string - description: '' - IsAttachable: - type: boolean - description: '' - PermissionsBoundaryUsageCount: - type: integer - description: '' - PolicyId: - type: string - description: '' - x-stackQL-stringOnly: true - x-title: CreateManagedPolicyRequest + required: + - Password + User: type: object - required: [] - CreateOIDCProviderRequest: properties: - ClientToken: + Path: + description: |- + The path for the user name. For more information about paths, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*. + This parameter is optional. If it is not included, it defaults to a slash (/). + This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\u0021``) through the DEL character (``\u007F``), including most punctuation characters, digits, and upper and lowercased letters. type: string - RoleArn: + ManagedPolicyArns: + description: |- + A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the user. + For more information about ARNs, see [Amazon Resource Names (ARNs) and Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*. + type: array + uniqueItems: true + x-insertionOrder: false + items: + type: string + Policies: + description: |- + Adds or updates an inline policy document that is embedded in the specified IAM user. To view AWS::IAM::User snippets, see [Declaring an User Resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-iam-user). + The name of each policy for a role, user, or group must be unique. If you don't choose unique names, updates to the IAM identity will fail. + For information about limits on the number of inline policies that you can embed in a user, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*. + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Policy' + UserName: + description: |- + The name of the user to create. Do not include the path in this value. + This parameter allows (per its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-. The user name must be unique within the account. User names are not distinguished by case. For example, you cannot create users named both "John" and "john". + If you don't specify a name, CFN generates a unique physical ID and uses that ID for the user name. + If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities). + Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using ``Fn::Join`` and ``AWS::Region`` to create a Region-specific name, as in the following example: ``{"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]}``. type: string - TypeName: + Groups: + description: A list of group names to which you want to add the user. + type: array + uniqueItems: false + x-insertionOrder: false + items: + type: string + Arn: + description: '' type: string - TypeVersionId: + LoginProfile: + description: |- + Creates a password for the specified IAM user. A password allows an IAM user to access AWS services through the console. + You can use the CLI, the AWS API, or the *Users* page in the IAM console to create a password for any IAM user. Use [ChangePassword](https://docs.aws.amazon.com/IAM/latest/APIReference/API_ChangePassword.html) to update your own existing password in the *My Security Credentials* page in the console. + For more information about managing passwords, see [Managing passwords](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html) in the *User Guide*. + $ref: '#/components/schemas/LoginProfile' + Tags: + description: |- + A list of tags that you want to attach to the new user. Each tag consists of a key name and an associated value. For more information about tagging, see [Tagging IAM resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the *IAM User Guide*. + If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + PermissionsBoundary: + description: |- + The ARN of the managed policy that is used to set the permissions boundary for the user. + A permissions boundary policy defines the maximum permissions that identity-based policies can grant to an entity, but does not grant permissions. Permissions boundaries do not define the maximum permissions that a resource-based policy can grant to an entity. To learn more, see [Permissions boundaries for IAM entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) in the *IAM User Guide*. + For more information about policy types, see [Policy types](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policy-types) in the *IAM User Guide*. type: string - DesiredState: + x-stackql-resource-name: user + description: |- + Creates a new IAM user for your AWS-account. + For information about quotas for the number of IAM users you can create, see [IAM and quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*. + x-type-name: AWS::IAM::User + x-stackql-primary-identifier: + - UserName + x-create-only-properties: + - UserName + x-write-only-properties: + - LoginProfile/Password + x-read-only-properties: + - Arn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + x-required-permissions: + create: + - iam:CreateLoginProfile + - iam:AddUserToGroup + - iam:PutUserPolicy + - iam:AttachUserPolicy + - iam:CreateUser + - iam:GetUser + - iam:TagUser + read: + - iam:GetUserPolicy + - iam:ListGroupsForUser + - iam:ListAttachedUserPolicies + - iam:ListUserPolicies + - iam:GetUser + - iam:GetLoginProfile + update: + - iam:UpdateLoginProfile + - iam:UpdateUser + - iam:PutUserPermissionsBoundary + - iam:AttachUserPolicy + - iam:DeleteUserPolicy + - iam:DeleteUserPermissionsBoundary + - iam:TagUser + - iam:UntagUser + - iam:CreateLoginProfile + - iam:RemoveUserFromGroup + - iam:AddUserToGroup + - iam:PutUserPolicy + - iam:DetachUserPolicy + - iam:GetLoginProfile + - iam:DeleteLoginProfile + - iam:GetUser + - iam:ListUserTags + delete: + - iam:DeleteAccessKey + - iam:RemoveUserFromGroup + - iam:DeleteUserPolicy + - iam:DeleteUser + - iam:DetachUserPolicy + - iam:DeleteLoginProfile + - iam:ListAccessKeys + - iam:GetUserPolicy + - iam:ListGroupsForUser + - iam:ListAttachedUserPolicies + - iam:ListUserPolicies + - iam:GetUser + - iam:GetLoginProfile + list: + - iam:listUsers + UserPolicy: + type: object + properties: + PolicyDocument: + description: |- + The policy document. + You must provide policies in JSON format in IAM. However, for CFN templates formatted in YAML, you can provide the policy in JSON or YAML format. CFN always converts a YAML policy to JSON format before submitting it to IAM. + The [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex) used to validate this parameter is a string of characters consisting of the following: + + Any printable ASCII character ranging from the space character (``\u0020``) through the end of the ASCII character range + + The printable characters in the Basic Latin and Latin-1 Supplement character set (through ``\u00FF``) + + The special characters tab (``\u0009``), line feed (``\u000A``), and carriage return (``\u000D``) type: object - properties: - ClientIdList: - type: array - x-insertionOrder: false - items: - minLength: 1 - maxLength: 255 - type: string - Url: - minLength: 1 - maxLength: 255 - type: string - ThumbprintList: - type: array - x-insertionOrder: false - items: - minLength: 40 - maxLength: 40 - pattern: '[0-9A-Fa-f]{40}' - type: string - maxItems: 5 - Arn: - description: Amazon Resource Name (ARN) of the OIDC provider - minLength: 20 - maxLength: 2048 - type: string - Tags: - type: array - uniqueItems: false - x-insertionOrder: false - items: - $ref: '#/components/schemas/Tag' - x-stackQL-stringOnly: true - x-title: CreateOIDCProviderRequest + PolicyName: + description: |- + The name of the policy document. + This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + type: string + UserName: + description: |- + The name of the user to associate the policy with. + This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + type: string + required: + - PolicyName + - UserName + x-stackql-resource-name: user_policy + description: |- + Adds or updates an inline policy document that is embedded in the specified IAM user. + An IAM user can also have a managed policy attached to it. To attach a managed policy to a user, use [AWS::IAM::User](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html). To create a new managed policy, use [AWS::IAM::ManagedPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html). For information about policies, see [Managed policies and inline policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *IAM User Guide*. + For information about the maximum number of inline policies that you can embed in a user, see [IAM and quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*. + x-type-name: AWS::IAM::UserPolicy + x-stackql-primary-identifier: + - PolicyName + - UserName + x-create-only-properties: + - PolicyName + - UserName + x-required-properties: + - PolicyName + - UserName + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - iam:PutUserPolicy + - iam:GetUserPolicy + read: + - iam:GetUserPolicy + update: + - iam:PutUserPolicy + - iam:GetUserPolicy + delete: + - iam:DeleteUserPolicy + - iam:GetUserPolicy + VirtualMFADevice: type: object - required: [] - CreateRoleRequest: + properties: + VirtualMfaDeviceName: + minLength: 1 + maxLength: 226 + pattern: '[\w+=,.@-]+' + type: string + Path: + minLength: 1 + maxLength: 512 + pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F) + type: string + SerialNumber: + minLength: 9 + maxLength: 256 + pattern: '[\w+=/:,.@-]+' + type: string + Users: + type: array + uniqueItems: false + items: + type: string + Tags: + type: array + uniqueItems: false + items: + $ref: '#/components/schemas/Tag' + required: + - Users + x-stackql-resource-name: virtualmfa_device + description: Resource Type definition for AWS::IAM::VirtualMFADevice + x-type-name: AWS::IAM::VirtualMFADevice + x-stackql-primary-identifier: + - SerialNumber + x-create-only-properties: + - VirtualMfaDeviceName + - Base32StringSeed + - Path + x-read-only-properties: + - SerialNumber + x-required-properties: + - Users + x-required-permissions: + create: + - iam:CreateVirtualMFADevice + - iam:EnableMFADevice + - iam:ListVirtualMFADevices + read: + - iam:ListVirtualMFADevices + update: + - iam:TagMFADevice + - iam:UntagMFADevice + delete: + - iam:DeleteVirtualMFADevice + - iam:DeactivateMFADevice + list: + - iam:ListVirtualMFADevices + CreateGroupRequest: properties: ClientToken: type: string @@ -1772,74 +2198,44 @@ components: Arn: description: '' type: string - AssumeRolePolicyDocument: - description: >- - The trust policy that is associated with this role. Trust policies define which entities can assume the role. You can associate only one trust policy with a role. For an example of a policy that can be used to assume a role, see [Template Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#aws-resource-iam-role--examples). For more information about the elements that you can use in an IAM policy, see [Policy Elements - Reference](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements.html) in the *User Guide*. - type: object - Description: - description: A description of the role that you provide. + GroupName: + description: |- + The name of the group to create. Do not include the path in this value. + The group name must be unique within the account. Group names are not distinguished by case. For example, you cannot create groups named both "ADMINS" and "admins". If you don't specify a name, CFN generates a unique physical ID and uses that ID for the group name. + If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. + If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities). + Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using ``Fn::Join`` and ``AWS::Region`` to create a Region-specific name, as in the following example: ``{"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]}``. type: string ManagedPolicyArns: description: |- - A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the role. - For more information about ARNs, see [Amazon Resource Names (ARNs) and Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*. + The Amazon Resource Name (ARN) of the IAM policy you want to attach. + For more information about ARNs, see [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*. type: array uniqueItems: true x-insertionOrder: false items: type: string - MaxSessionDuration: - description: |- - The maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default value of one hour is applied. This setting can have a value from 1 hour to 12 hours. - Anyone who assumes the role from the CLI or API can use the ``DurationSeconds`` API parameter or the ``duration-seconds`` CLI parameter to request a longer session. The ``MaxSessionDuration`` setting determines the maximum duration that can be requested using the ``DurationSeconds`` parameter. If users don't specify a value for the ``DurationSeconds`` parameter, their security credentials are valid for one hour by default. This applies when you use the ``AssumeRole*`` API operations or the ``assume-role*`` CLI operations but does not apply when you use those operations to create a console URL. For more information, see [Using IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html) in the *IAM User Guide*. - type: integer Path: description: |- - The path to the role. For more information about paths, see [IAM Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*. + The path to the group. For more information about paths, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*. This parameter is optional. If it is not included, it defaults to a slash (/). This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\u0021``) through the DEL character (``\u007F``), including most punctuation characters, digits, and upper and lowercased letters. - default: / - type: string - PermissionsBoundary: - description: |- - The ARN of the policy used to set the permissions boundary for the role. - For more information about permissions boundaries, see [Permissions boundaries for IAM identities](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) in the *IAM User Guide*. type: string Policies: description: |- - Adds or updates an inline policy document that is embedded in the specified IAM role. - When you embed an inline policy in a role, the inline policy is used as part of the role's access (permissions) policy. The role's trust policy is created at the same time as the role. You can update a role's trust policy later. For more information about IAM roles, go to [Using Roles to Delegate Permissions and Federate Identities](https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html). - A role can also have an attached managed policy. For information about policies, see [Managed Policies and Inline Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *User Guide*. - For information about limits on the number of inline policies that you can embed with a role, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*. - If an external policy (such as ``AWS::IAM::Policy`` or - type: array - x-insertionOrder: false - uniqueItems: false - items: - $ref: '#/components/schemas/Policy' - RoleId: - description: '' - type: string - RoleName: - description: |- - A name for the IAM role, up to 64 characters in length. For valid values, see the ``RoleName`` parameter for the [CreateRole](https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html) action in the *User Guide*. - This parameter allows (per its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-. The role name must be unique within the account. Role names are not distinguished by case. For example, you cannot create roles named both "Role1" and "role1". - If you don't specify a name, CFN generates a unique physical ID and uses that ID for the role name. - If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/Use - type: string - Tags: - description: A list of tags that are attached to the role. For more information about tagging, see [Tagging IAM resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the *IAM User Guide*. + Adds or updates an inline policy document that is embedded in the specified IAM group. To view AWS::IAM::Group snippets, see [Declaring an Group Resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-iam-group). + The name of each inline policy for a role, user, or group must be unique. If you don't choose unique names, updates to the IAM identity will fail. + For information about limits on the number of inline policies that you can embed in a group, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*. type: array uniqueItems: false x-insertionOrder: false items: - $ref: '#/components/schemas/Tag' + $ref: '#/components/schemas/Policy' x-stackQL-stringOnly: true - x-title: CreateRoleRequest + x-title: CreateGroupRequest type: object required: [] - CreateRolePolicyRequest: + CreateGroupPolicyRequest: properties: ClientToken: type: string @@ -1866,16 +2262,16 @@ components: The name of the policy document. This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- type: string - RoleName: + GroupName: description: |- - The name of the role to associate the policy with. - This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + The name of the group to associate the policy with. + This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-. type: string x-stackQL-stringOnly: true - x-title: CreateRolePolicyRequest + x-title: CreateGroupPolicyRequest type: object required: [] - CreateSAMLProviderRequest: + CreateInstanceProfileRequest: properties: ClientToken: type: string @@ -1888,31 +2284,32 @@ components: DesiredState: type: object properties: - Name: - minLength: 1 - maxLength: 128 - pattern: '[\w._-]+' - type: string - SamlMetadataDocument: - minLength: 1000 - maxLength: 10000000 - type: string - Arn: - description: Amazon Resource Name (ARN) of the SAML provider - minLength: 1 - maxLength: 1600 + Path: type: string - Tags: + description: |- + The path to the instance profile. For more information about paths, see [IAM Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*. + This parameter is optional. If it is not included, it defaults to a slash (/). + This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\u0021``) through the DEL character (``\u007F``), including most punctuation characters, digits, and upper and lowercased letters. + Roles: type: array - uniqueItems: false + description: The name of the role to associate with the instance profile. Only one role can be assigned to an EC2 instance at a time, and all applications on the instance share the same role and permissions. + uniqueItems: true x-insertionOrder: false items: - $ref: '#/components/schemas/Tag' + type: string + InstanceProfileName: + type: string + description: |- + The name of the instance profile to create. + This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + Arn: + type: string + description: '' x-stackQL-stringOnly: true - x-title: CreateSAMLProviderRequest + x-title: CreateInstanceProfileRequest type: object required: [] - CreateServerCertificateRequest: + CreateManagedPolicyRequest: properties: ClientToken: type: string @@ -1925,47 +2322,96 @@ components: DesiredState: type: object properties: - CertificateBody: - minLength: 1 - maxLength: 16384 - pattern: '[\u0009\u000A\u000D\u0020-\u00FF]+' - type: string - CertificateChain: - minLength: 1 - maxLength: 2097152 - pattern: '[\u0009\u000A\u000D\u0020-\u00FF]+' + Description: type: string - ServerCertificateName: - minLength: 1 - maxLength: 128 - pattern: '[\w+=,.@-]+' + description: |- + A friendly description of the policy. + Typically used to store information about the permissions defined in the policy. For example, "Grants access to production DynamoDB tables." + The policy description is immutable. After a value is assigned, it cannot be changed. + Groups: + x-insertionOrder: false + type: array + description: |- + The name (friendly name, not ARN) of the group to attach the policy to. + This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + uniqueItems: true + items: + type: string + ManagedPolicyName: type: string + description: |- + The friendly name of the policy. + If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. + If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities). + Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using ``Fn::Join`` and ``AWS::Region`` to create a Region-specific name, as in the following example: ``{"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]}``. Path: - minLength: 1 - maxLength: 512 - pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F) - type: string - PrivateKey: - minLength: 1 - maxLength: 16384 - pattern: '[\u0009\u000A\u000D\u0020-\u00FF]+' - type: string - Arn: - description: Amazon Resource Name (ARN) of the server certificate - minLength: 1 - maxLength: 1600 type: string - Tags: + default: / + description: |- + The path for the policy. + For more information about paths, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*. + This parameter is optional. If it is not included, it defaults to a slash (/). + This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\u0021``) through the DEL character (``\u007F``), including most punctuation characters, digits, and upper and lowercased letters. + You cannot use an asterisk (*) in the path name. + PolicyDocument: + type: object + description: |- + The JSON policy document that you want to use as the content for the new policy. + You must provide policies in JSON format in IAM. However, for CFN templates formatted in YAML, you can provide the policy in JSON or YAML format. CFN always converts a YAML policy to JSON format before submitting it to IAM. + The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see [IAM and character quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length). + To learn more about JSON policy grammar, see [Grammar of the IAM JSON policy language](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_grammar.html) in the *IAM User Guide*. + The [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex) used to validate this parameter is a string of characters consisting of the following: + + Any printable ASCII character ranging from the space character (``\u0020``) through the end of the ASCII character range + + The printable characters in the Basic Latin and Latin-1 Supplement character set (through ``\u00FF``) + + The special characters tab (``\u0009``), line feed (``\u000A``), and carriage return (``\u000D``) + Roles: + x-insertionOrder: false type: array - uniqueItems: false + description: |- + The name (friendly name, not ARN) of the role to attach the policy to. + This parameter allows (per its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + If an external policy (such as ``AWS::IAM::Policy`` or ``AWS::IAM::ManagedPolicy``) has a ``Ref`` to a role and if a resource (such as ``AWS::ECS::Service``) also has a ``Ref`` to the same role, add a ``DependsOn`` attribute to the resource to make the resource depend on the external policy. This dependency ensures that the role's policy is available throughout the resource's lifecycle. For example, when you delete a stack with an ``AWS::ECS::Service`` resource, the ``DependsOn`` attribute ensures that CFN deletes the ``AWS::ECS::Service`` resource before deleting its role's policy. + uniqueItems: true + items: + type: string + Users: x-insertionOrder: false + type: array + description: |- + The name (friendly name, not ARN) of the IAM user to attach the policy to. + This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + uniqueItems: true items: - $ref: '#/components/schemas/Tag' + type: string + PolicyArn: + type: string + description: '' + AttachmentCount: + type: integer + description: '' + CreateDate: + type: string + description: '' + UpdateDate: + type: string + description: '' + DefaultVersionId: + type: string + description: '' + IsAttachable: + type: boolean + description: '' + PermissionsBoundaryUsageCount: + type: integer + description: '' + PolicyId: + type: string + description: '' x-stackQL-stringOnly: true - x-title: CreateServerCertificateRequest + x-title: CreateManagedPolicyRequest type: object required: [] - CreateServiceLinkedRoleRequest: + CreateOIDCProviderRequest: properties: ClientToken: type: string @@ -1978,23 +2424,42 @@ components: DesiredState: type: object properties: - RoleName: - description: The name of the role. - type: string - CustomSuffix: - description: A string that you provide, which is combined with the service-provided prefix to form the complete role name. - type: string - Description: - description: The description of the role. + ClientIdList: + type: array + x-insertionOrder: false + items: + minLength: 1 + maxLength: 255 + type: string + Url: + minLength: 1 + maxLength: 255 type: string - AWSServiceName: - description: The service principal for the AWS service to which this role is attached. + ThumbprintList: + type: array + x-insertionOrder: false + items: + minLength: 40 + maxLength: 40 + pattern: '[0-9A-Fa-f]{40}' + type: string + maxItems: 5 + Arn: + description: Amazon Resource Name (ARN) of the OIDC provider + minLength: 20 + maxLength: 2048 type: string + Tags: + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' x-stackQL-stringOnly: true - x-title: CreateServiceLinkedRoleRequest + x-title: CreateOIDCProviderRequest type: object required: [] - CreateUserRequest: + CreateRoleRequest: properties: ClientToken: type: string @@ -2007,32 +2472,270 @@ components: DesiredState: type: object properties: - Path: - description: |- - The path for the user name. For more information about paths, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*. - This parameter is optional. If it is not included, it defaults to a slash (/). - This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\u0021``) through the DEL character (``\u007F``), including most punctuation characters, digits, and upper and lowercased letters. + Arn: + description: '' + type: string + AssumeRolePolicyDocument: + description: >- + The trust policy that is associated with this role. Trust policies define which entities can assume the role. You can associate only one trust policy with a role. For an example of a policy that can be used to assume a role, see [Template Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#aws-resource-iam-role--examples). For more information about the elements that you can use in an IAM policy, see [Policy Elements + Reference](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements.html) in the *User Guide*. + type: object + Description: + description: A description of the role that you provide. type: string ManagedPolicyArns: description: |- - A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the user. + A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the role. For more information about ARNs, see [Amazon Resource Names (ARNs) and Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*. type: array uniqueItems: true x-insertionOrder: false items: type: string - Policies: - description: |- - Adds or updates an inline policy document that is embedded in the specified IAM user. To view AWS::IAM::User snippets, see [Declaring an User Resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-iam-user). - The name of each policy for a role, user, or group must be unique. If you don't choose unique names, updates to the IAM identity will fail. - For information about limits on the number of inline policies that you can embed in a user, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*. - type: array - uniqueItems: false - x-insertionOrder: false - items: - $ref: '#/components/schemas/Policy' - UserName: + MaxSessionDuration: + description: |- + The maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default value of one hour is applied. This setting can have a value from 1 hour to 12 hours. + Anyone who assumes the role from the CLI or API can use the ``DurationSeconds`` API parameter or the ``duration-seconds`` CLI parameter to request a longer session. The ``MaxSessionDuration`` setting determines the maximum duration that can be requested using the ``DurationSeconds`` parameter. If users don't specify a value for the ``DurationSeconds`` parameter, their security credentials are valid for one hour by default. This applies when you use the ``AssumeRole*`` API operations or the ``assume-role*`` CLI operations but does not apply when you use those operations to create a console URL. For more information, see [Using IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html) in the *IAM User Guide*. + type: integer + Path: + description: |- + The path to the role. For more information about paths, see [IAM Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*. + This parameter is optional. If it is not included, it defaults to a slash (/). + This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\u0021``) through the DEL character (``\u007F``), including most punctuation characters, digits, and upper and lowercased letters. + default: / + type: string + PermissionsBoundary: + description: |- + The ARN of the policy used to set the permissions boundary for the role. + For more information about permissions boundaries, see [Permissions boundaries for IAM identities](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) in the *IAM User Guide*. + type: string + Policies: + description: |- + Adds or updates an inline policy document that is embedded in the specified IAM role. + When you embed an inline policy in a role, the inline policy is used as part of the role's access (permissions) policy. The role's trust policy is created at the same time as the role. You can update a role's trust policy later. For more information about IAM roles, go to [Using Roles to Delegate Permissions and Federate Identities](https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html). + A role can also have an attached managed policy. For information about policies, see [Managed Policies and Inline Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *User Guide*. + For information about limits on the number of inline policies that you can embed with a role, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*. + If an external policy (such as ``AWS::IAM::Policy`` or + type: array + x-insertionOrder: false + uniqueItems: false + items: + $ref: '#/components/schemas/Policy' + RoleId: + description: '' + type: string + RoleName: + description: |- + A name for the IAM role, up to 64 characters in length. For valid values, see the ``RoleName`` parameter for the [CreateRole](https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html) action in the *User Guide*. + This parameter allows (per its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-. The role name must be unique within the account. Role names are not distinguished by case. For example, you cannot create roles named both "Role1" and "role1". + If you don't specify a name, CFN generates a unique physical ID and uses that ID for the role name. + If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/Use + type: string + Tags: + description: A list of tags that are attached to the role. For more information about tagging, see [Tagging IAM resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the *IAM User Guide*. + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateRoleRequest + type: object + required: [] + CreateRolePolicyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + PolicyDocument: + description: |- + The policy document. + You must provide policies in JSON format in IAM. However, for CFN templates formatted in YAML, you can provide the policy in JSON or YAML format. CFN always converts a YAML policy to JSON format before submitting it to IAM. + The [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex) used to validate this parameter is a string of characters consisting of the following: + + Any printable ASCII character ranging from the space character (``\u0020``) through the end of the ASCII character range + + The printable characters in the Basic Latin and Latin-1 Supplement character set (through ``\u00FF``) + + The special characters tab (``\u0009``), line feed (``\u000A``), and carriage return (``\u000D``) + type: object + PolicyName: + description: |- + The name of the policy document. + This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + type: string + RoleName: + description: |- + The name of the role to associate the policy with. + This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- + type: string + x-stackQL-stringOnly: true + x-title: CreateRolePolicyRequest + type: object + required: [] + CreateSAMLProviderRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + minLength: 1 + maxLength: 128 + pattern: '[\w._-]+' + type: string + SamlMetadataDocument: + minLength: 1000 + maxLength: 10000000 + type: string + Arn: + description: Amazon Resource Name (ARN) of the SAML provider + minLength: 1 + maxLength: 1600 + type: string + Tags: + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateSAMLProviderRequest + type: object + required: [] + CreateServerCertificateRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + CertificateBody: + minLength: 1 + maxLength: 16384 + pattern: '[\u0009\u000A\u000D\u0020-\u00FF]+' + type: string + CertificateChain: + minLength: 1 + maxLength: 2097152 + pattern: '[\u0009\u000A\u000D\u0020-\u00FF]+' + type: string + ServerCertificateName: + minLength: 1 + maxLength: 128 + pattern: '[\w+=,.@-]+' + type: string + Path: + minLength: 1 + maxLength: 512 + pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F) + type: string + PrivateKey: + minLength: 1 + maxLength: 16384 + pattern: '[\u0009\u000A\u000D\u0020-\u00FF]+' + type: string + Arn: + description: Amazon Resource Name (ARN) of the server certificate + minLength: 1 + maxLength: 1600 + type: string + Tags: + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + x-stackQL-stringOnly: true + x-title: CreateServerCertificateRequest + type: object + required: [] + CreateServiceLinkedRoleRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + RoleName: + description: The name of the role. + type: string + CustomSuffix: + description: A string that you provide, which is combined with the service-provided prefix to form the complete role name. + type: string + Description: + description: The description of the role. + type: string + AWSServiceName: + description: The service principal for the AWS service to which this role is attached. + type: string + x-stackQL-stringOnly: true + x-title: CreateServiceLinkedRoleRequest + type: object + required: [] + CreateUserRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Path: + description: |- + The path for the user name. For more information about paths, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*. + This parameter is optional. If it is not included, it defaults to a slash (/). + This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\u0021``) through the DEL character (``\u007F``), including most punctuation characters, digits, and upper and lowercased letters. + type: string + ManagedPolicyArns: + description: |- + A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the user. + For more information about ARNs, see [Amazon Resource Names (ARNs) and Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*. + type: array + uniqueItems: true + x-insertionOrder: false + items: + type: string + Policies: + description: |- + Adds or updates an inline policy document that is embedded in the specified IAM user. To view AWS::IAM::User snippets, see [Declaring an User Resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-iam-user). + The name of each policy for a role, user, or group must be unique. If you don't choose unique names, updates to the IAM identity will fail. + For information about limits on the number of inline policies that you can embed in a user, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*. + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Policy' + UserName: description: |- The name of the user to create. Do not include the path in this value. This parameter allows (per its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-. The user name must be unique within the account. User names are not distinguished by case. For example, you cannot create users named both "John" and "john". @@ -2153,101 +2856,6 @@ components: x-title: CreateVirtualMFADeviceRequest type: object required: [] - region: - type: string - description: The AWS region (always `us-east-1` for IAM resources) - user_policies: - description: List of user policies by UserName (requires `aws` provider to be installed) - type: object - additionalProperties: false - properties: - UserName: - type: string - description: The IAM user name - member: - type: string - description: The user policy name - region: - $ref: '#/components/schemas/region' - x-example-where-clause: WHERE UserName = '' - group_policies: - description: List of group policies by GroupName (requires `aws` provider to be installed) - type: object - additionalProperties: false - properties: - GroupName: - type: string - description: The IAM group name - PolicyName: - type: string - description: The group policy name - PolicyDocument: - type: string - description: The group policy document - region: - $ref: '#/components/schemas/region' - x-example-where-clause: WHERE GroupName = '' - role_policies: - description: List of policies by RoleName (requires `aws` provider to be installed) - type: object - additionalProperties: false - properties: - RoleName: - type: string - description: The IAM role name - PolicyName: - type: string - description: The role policy name - PolicyDocument: - type: string - description: The role policy document - region: - $ref: '#/components/schemas/region' - x-example-where-clause: WHERE RoleName = '' - policies: - description: List of policies (requires `aws` provider to be installed) - type: object - additionalProperties: false - properties: - PolicyName: - type: string - description: The name for the policy - Arn: - type: string - description: The ARN - AttachmentCount: - type: number - description: The attachment count for the policy - CreateDate: - type: string - description: The creation date for the policy - DefaultVersionId: - type: string - description: The default version id for the policy - Description: - type: string - description: The description for the policy - IsAttachable: - type: boolean - description: Is the policy attachable? - Path: - type: string - description: The path for the policy - PermissionsBoundaryUsageCount: - type: number - description: The permissions boundary usage count for the policy - PolicyId: - type: string - description: The id for the policy - Tags: - type: array - description: Tags for the policy - UpdateDate: - type: string - description: The update date for the policy - region: - $ref: '#/components/schemas/region' - x-example-where-clause: '' securitySchemes: hmac: type: apiKey @@ -2263,7 +2871,7 @@ components: x-cfn-type-name: AWS::IAM::Group x-identifiers: - GroupName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2280,9 +2888,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2292,41 +2900,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/groups/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/groups/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.GroupName') as group_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::Group' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'GroupName') as group_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::Group' - AND region = 'us-east-1' - group: - name: group - id: aws.iam.group - x-cfn-schema-name: Group - x-cfn-type-name: AWS::IAM::Group - x-identifiers: - - GroupName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2337,12 +2913,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/groups/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/group/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2356,88 +2936,92 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'GroupName') as group_name, - json_extract_path_text(Properties, 'ManagedPolicyArns') as managed_policy_arns, - json_extract_path_text(Properties, 'Path') as path, - json_extract_path_text(Properties, 'Policies') as policies - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IAM::Group' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.GroupName') as group_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::Group' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'GroupName') as group_name, + json_extract_path_text(Properties, 'ManagedPolicyArns') as managed_policy_arns, + json_extract_path_text(Properties, 'Path') as path, + json_extract_path_text(Properties, 'Policies') as policies + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IAM::Group' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'GroupName') as group_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::Group' + AND region = 'us-east-1' group_policies: - name: group_policies id: aws.iam.group_policies - x-cfn-schema-name: group_policies - x-type: custom_list - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - GroupName, - PolicyName, - PolicyDocument, - region - FROM aws.iam_api.group_policies - WHERE GroupName = '' - AND region = 'us-east-1' - group_policy: - name: group_policy - id: aws.iam.group_policy - x-cfn-schema-name: GroupPolicy - x-cfn-type-name: AWS::IAM::GroupPolicy - x-identifiers: - - PolicyName - - GroupName - x-type: get + x-cfn-schema-name: GetGroupPolicyResponse + x-example-where-clause: WHERE region = 'us-east-1' /* always 'us-east-1' for iam */ AND GroupName = '' AND PolicyName = '' + x-type: native methods: - update_resource: + attach: + serviceName: iam operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' - request: - mediaType: application/x-amz-json-1.0 - base: |- - { - "TypeName": "AWS::IAM::GroupPolicy" - } + $ref: '#/paths/~1?Action=AttachGroupPolicy&Version=2010-05-08&__nativeEndpoint=true/get' response: - mediaType: application/json openAPIDocKey: '200' + delete: + serviceName: iam + operation: + $ref: '#/paths/~1?Action=DeleteGroupPolicy&Version=2010-05-08&__nativeEndpoint=true/get' + response: + openAPIDocKey: '200' + detach: + serviceName: iam + operation: + $ref: '#/paths/~1?Action=DetachGroupPolicy&Version=2010-05-08&__nativeEndpoint=true/get' + response: + openAPIDocKey: '200' + get: + serviceName: iam + operation: + $ref: '#/paths/~1?Action=GetGroupPolicy&Version=2010-05-08&__nativeEndpoint=true/get' + response: + mediaType: text/xml + objectKey: /*/GetGroupPolicyResult + openAPIDocKey: '200' + list: + serviceName: iam + operation: + $ref: '#/paths/~1?Action=ListGroupPolicies&Version=2010-05-08&__nativeEndpoint=true/get' + response: + mediaType: text/xml + objectKey: /*/ListGroupPoliciesResult/PolicyNames/member + openAPIDocKey: '200' + put: + serviceName: iam + operation: + $ref: '#/paths/~1?Action=PutGroupPolicy&Version=2010-05-08&__nativeEndpoint=true/get' + response: + openAPIDocKey: '200' + name: group_policies sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/group_policies/methods/delete' + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/group_policies/methods/get' + - $ref: '#/components/x-stackQL-resources/group_policies/methods/list' update: - - $ref: '#/components/x-stackQL-resources/group_policy/methods/update_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - data__Identifier, - JSON_EXTRACT(Properties, '$.PolicyDocument') as policy_document, - JSON_EXTRACT(Properties, '$.PolicyName') as policy_name, - JSON_EXTRACT(Properties, '$.GroupName') as group_name - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IAM::GroupPolicy' - AND data__Identifier = '|' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - data__Identifier, - json_extract_path_text(Properties, 'PolicyDocument') as policy_document, - json_extract_path_text(Properties, 'PolicyName') as policy_name, - json_extract_path_text(Properties, 'GroupName') as group_name - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IAM::GroupPolicy' - AND data__Identifier = '|' - AND region = 'us-east-1' + - $ref: '#/components/x-stackQL-resources/group_policies/methods/put' + title: group_policies instance_profiles: name: instance_profiles id: aws.iam.instance_profiles @@ -2445,7 +3029,7 @@ components: x-cfn-type-name: AWS::IAM::InstanceProfile x-identifiers: - InstanceProfileName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2462,9 +3046,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2474,41 +3058,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/instance_profiles/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/instance_profiles/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.InstanceProfileName') as instance_profile_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::InstanceProfile' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'InstanceProfileName') as instance_profile_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::InstanceProfile' - AND region = 'us-east-1' - instance_profile: - name: instance_profile - id: aws.iam.instance_profile - x-cfn-schema-name: InstanceProfile - x-cfn-type-name: AWS::IAM::InstanceProfile - x-identifiers: - - InstanceProfileName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2519,12 +3071,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/instance_profiles/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/instance_profiles/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/instance_profile/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/instance_profiles/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2537,18 +3093,34 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Path') as path, - json_extract_path_text(Properties, 'Roles') as roles, - json_extract_path_text(Properties, 'InstanceProfileName') as instance_profile_name, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IAM::InstanceProfile' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.InstanceProfileName') as instance_profile_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::InstanceProfile' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Path') as path, + json_extract_path_text(Properties, 'Roles') as roles, + json_extract_path_text(Properties, 'InstanceProfileName') as instance_profile_name, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IAM::InstanceProfile' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'InstanceProfileName') as instance_profile_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::InstanceProfile' + AND region = 'us-east-1' managed_policies: name: managed_policies id: aws.iam.managed_policies @@ -2556,7 +3128,7 @@ components: x-cfn-type-name: AWS::IAM::ManagedPolicy x-identifiers: - PolicyArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2573,9 +3145,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2585,41 +3157,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/managed_policies/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/managed_policies/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.PolicyArn') as policy_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::ManagedPolicy' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'PolicyArn') as policy_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::ManagedPolicy' - AND region = 'us-east-1' - managed_policy: - name: managed_policy - id: aws.iam.managed_policy - x-cfn-schema-name: ManagedPolicy - x-cfn-type-name: AWS::IAM::ManagedPolicy - x-identifiers: - - PolicyArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2630,12 +3170,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/managed_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/managed_policies/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/managed_policy/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/managed_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2659,29 +3203,45 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Groups') as groups, - json_extract_path_text(Properties, 'ManagedPolicyName') as managed_policy_name, - json_extract_path_text(Properties, 'Path') as path, - json_extract_path_text(Properties, 'PolicyDocument') as policy_document, - json_extract_path_text(Properties, 'Roles') as roles, - json_extract_path_text(Properties, 'Users') as users, - json_extract_path_text(Properties, 'PolicyArn') as policy_arn, - json_extract_path_text(Properties, 'AttachmentCount') as attachment_count, - json_extract_path_text(Properties, 'CreateDate') as create_date, - json_extract_path_text(Properties, 'UpdateDate') as update_date, - json_extract_path_text(Properties, 'DefaultVersionId') as default_version_id, - json_extract_path_text(Properties, 'IsAttachable') as is_attachable, - json_extract_path_text(Properties, 'PermissionsBoundaryUsageCount') as permissions_boundary_usage_count, - json_extract_path_text(Properties, 'PolicyId') as policy_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IAM::ManagedPolicy' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.PolicyArn') as policy_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::ManagedPolicy' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Groups') as groups, + json_extract_path_text(Properties, 'ManagedPolicyName') as managed_policy_name, + json_extract_path_text(Properties, 'Path') as path, + json_extract_path_text(Properties, 'PolicyDocument') as policy_document, + json_extract_path_text(Properties, 'Roles') as roles, + json_extract_path_text(Properties, 'Users') as users, + json_extract_path_text(Properties, 'PolicyArn') as policy_arn, + json_extract_path_text(Properties, 'AttachmentCount') as attachment_count, + json_extract_path_text(Properties, 'CreateDate') as create_date, + json_extract_path_text(Properties, 'UpdateDate') as update_date, + json_extract_path_text(Properties, 'DefaultVersionId') as default_version_id, + json_extract_path_text(Properties, 'IsAttachable') as is_attachable, + json_extract_path_text(Properties, 'PermissionsBoundaryUsageCount') as permissions_boundary_usage_count, + json_extract_path_text(Properties, 'PolicyId') as policy_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IAM::ManagedPolicy' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'PolicyArn') as policy_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::ManagedPolicy' + AND region = 'us-east-1' oidc_providers: name: oidc_providers id: aws.iam.oidc_providers @@ -2689,7 +3249,7 @@ components: x-cfn-type-name: AWS::IAM::OIDCProvider x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2706,9 +3266,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2718,41 +3278,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/oidc_providers/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/oidc_providers/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::OIDCProvider' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::OIDCProvider' - AND region = 'us-east-1' - oidc_provider: - name: oidc_provider - id: aws.iam.oidc_provider - x-cfn-schema-name: OIDCProvider - x-cfn-type-name: AWS::IAM::OIDCProvider - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2763,12 +3291,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/oidc_providers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/oidc_providers/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/oidc_provider/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/oidc_providers/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2782,19 +3314,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ClientIdList') as client_id_list, - json_extract_path_text(Properties, 'Url') as url, - json_extract_path_text(Properties, 'ThumbprintList') as thumbprint_list, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IAM::OIDCProvider' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::OIDCProvider' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ClientIdList') as client_id_list, + json_extract_path_text(Properties, 'Url') as url, + json_extract_path_text(Properties, 'ThumbprintList') as thumbprint_list, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IAM::OIDCProvider' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::OIDCProvider' + AND region = 'us-east-1' roles: name: roles id: aws.iam.roles @@ -2802,7 +3350,7 @@ components: x-cfn-type-name: AWS::IAM::Role x-identifiers: - RoleName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2819,9 +3367,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2831,41 +3379,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/roles/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/roles/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.RoleName') as role_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::Role' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'RoleName') as role_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::Role' - AND region = 'us-east-1' - role: - name: role - id: aws.iam.role - x-cfn-schema-name: Role - x-cfn-type-name: AWS::IAM::Role - x-identifiers: - - RoleName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2876,12 +3392,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/roles/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/roles/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/role/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/roles/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2901,94 +3421,98 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'AssumeRolePolicyDocument') as assume_role_policy_document, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'ManagedPolicyArns') as managed_policy_arns, - json_extract_path_text(Properties, 'MaxSessionDuration') as max_session_duration, - json_extract_path_text(Properties, 'Path') as path, - json_extract_path_text(Properties, 'PermissionsBoundary') as permissions_boundary, - json_extract_path_text(Properties, 'Policies') as policies, - json_extract_path_text(Properties, 'RoleId') as role_id, - json_extract_path_text(Properties, 'RoleName') as role_name, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IAM::Role' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.RoleName') as role_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::Role' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'AssumeRolePolicyDocument') as assume_role_policy_document, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'ManagedPolicyArns') as managed_policy_arns, + json_extract_path_text(Properties, 'MaxSessionDuration') as max_session_duration, + json_extract_path_text(Properties, 'Path') as path, + json_extract_path_text(Properties, 'PermissionsBoundary') as permissions_boundary, + json_extract_path_text(Properties, 'Policies') as policies, + json_extract_path_text(Properties, 'RoleId') as role_id, + json_extract_path_text(Properties, 'RoleName') as role_name, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IAM::Role' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'RoleName') as role_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::Role' + AND region = 'us-east-1' role_policies: - name: role_policies id: aws.iam.role_policies - x-cfn-schema-name: role_policies - x-type: custom_list - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - RoleName, - PolicyName, - PolicyDocument, - region - FROM aws.iam_api.role_policies - WHERE RoleName = '' - AND region = 'us-east-1' - role_policy: - name: role_policy - id: aws.iam.role_policy - x-cfn-schema-name: RolePolicy - x-cfn-type-name: AWS::IAM::RolePolicy - x-identifiers: - - PolicyName - - RoleName - x-type: get + x-cfn-schema-name: GetRolePolicyResponse + x-example-where-clause: WHERE region = 'us-east-1' /* always 'us-east-1' for iam */ AND RoleName = '' AND PolicyName = '' + x-type: native methods: - update_resource: + attach: + serviceName: iam operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' - request: - mediaType: application/x-amz-json-1.0 - base: |- - { - "TypeName": "AWS::IAM::RolePolicy" - } + $ref: '#/paths/~1?Action=AttachRolePolicy&Version=2010-05-08&__nativeEndpoint=true/get' + response: + openAPIDocKey: '200' + delete: + serviceName: iam + operation: + $ref: '#/paths/~1?Action=DeleteRolePolicy&Version=2010-05-08&__nativeEndpoint=true/get' + response: + openAPIDocKey: '200' + detach: + serviceName: iam + operation: + $ref: '#/paths/~1?Action=DetachRolePolicy&Version=2010-05-08&__nativeEndpoint=true/get' + response: + openAPIDocKey: '200' + get: + serviceName: iam + operation: + $ref: '#/paths/~1?Action=GetRolePolicy&Version=2010-05-08&__nativeEndpoint=true/get' + response: + mediaType: text/xml + objectKey: /*/GetRolePolicyResult + openAPIDocKey: '200' + list: + serviceName: iam + operation: + $ref: '#/paths/~1?Action=ListRolePolicies&Version=2010-05-08&__nativeEndpoint=true/get' + response: + mediaType: text/xml + objectKey: /*/ListRolePoliciesResult/PolicyNames/member + openAPIDocKey: '200' + put: + serviceName: iam + operation: + $ref: '#/paths/~1?Action=PutRolePolicy&Version=2010-05-08&__nativeEndpoint=true/get' response: - mediaType: application/json openAPIDocKey: '200' + name: role_policies sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/role_policies/methods/delete' + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/role_policies/methods/get' + - $ref: '#/components/x-stackQL-resources/role_policies/methods/list' update: - - $ref: '#/components/x-stackQL-resources/role_policy/methods/update_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - data__Identifier, - JSON_EXTRACT(Properties, '$.PolicyDocument') as policy_document, - JSON_EXTRACT(Properties, '$.PolicyName') as policy_name, - JSON_EXTRACT(Properties, '$.RoleName') as role_name - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IAM::RolePolicy' - AND data__Identifier = '|' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - data__Identifier, - json_extract_path_text(Properties, 'PolicyDocument') as policy_document, - json_extract_path_text(Properties, 'PolicyName') as policy_name, - json_extract_path_text(Properties, 'RoleName') as role_name - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IAM::RolePolicy' - AND data__Identifier = '|' - AND region = 'us-east-1' + - $ref: '#/components/x-stackQL-resources/role_policies/methods/put' + title: role_policies saml_providers: name: saml_providers id: aws.iam.saml_providers @@ -2996,7 +3520,7 @@ components: x-cfn-type-name: AWS::IAM::SAMLProvider x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3013,9 +3537,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3025,41 +3549,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/saml_providers/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/saml_providers/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::SAMLProvider' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::SAMLProvider' - AND region = 'us-east-1' - saml_provider: - name: saml_provider - id: aws.iam.saml_provider - x-cfn-schema-name: SAMLProvider - x-cfn-type-name: AWS::IAM::SAMLProvider - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3070,12 +3562,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/saml_providers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/saml_providers/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/saml_provider/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/saml_providers/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3088,18 +3584,34 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'SamlMetadataDocument') as saml_metadata_document, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IAM::SAMLProvider' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::SAMLProvider' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'SamlMetadataDocument') as saml_metadata_document, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IAM::SAMLProvider' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::SAMLProvider' + AND region = 'us-east-1' server_certificates: name: server_certificates id: aws.iam.server_certificates @@ -3107,7 +3619,7 @@ components: x-cfn-type-name: AWS::IAM::ServerCertificate x-identifiers: - ServerCertificateName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3124,9 +3636,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3136,41 +3648,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/server_certificates/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/server_certificates/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ServerCertificateName') as server_certificate_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::ServerCertificate' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ServerCertificateName') as server_certificate_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::ServerCertificate' - AND region = 'us-east-1' - server_certificate: - name: server_certificate - id: aws.iam.server_certificate - x-cfn-schema-name: ServerCertificate - x-cfn-type-name: AWS::IAM::ServerCertificate - x-identifiers: - - ServerCertificateName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3181,12 +3661,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/server_certificates/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/server_certificates/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/server_certificate/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/server_certificates/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3202,21 +3686,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'CertificateBody') as certificate_body, - json_extract_path_text(Properties, 'CertificateChain') as certificate_chain, - json_extract_path_text(Properties, 'ServerCertificateName') as server_certificate_name, - json_extract_path_text(Properties, 'Path') as path, - json_extract_path_text(Properties, 'PrivateKey') as private_key, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IAM::ServerCertificate' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ServerCertificateName') as server_certificate_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::ServerCertificate' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'CertificateBody') as certificate_body, + json_extract_path_text(Properties, 'CertificateChain') as certificate_chain, + json_extract_path_text(Properties, 'ServerCertificateName') as server_certificate_name, + json_extract_path_text(Properties, 'Path') as path, + json_extract_path_text(Properties, 'PrivateKey') as private_key, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IAM::ServerCertificate' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ServerCertificateName') as server_certificate_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::ServerCertificate' + AND region = 'us-east-1' service_linked_roles: name: service_linked_roles id: aws.iam.service_linked_roles @@ -3224,7 +3724,7 @@ components: x-cfn-type-name: AWS::IAM::ServiceLinkedRole x-identifiers: - RoleName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3241,9 +3741,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3253,23 +3753,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/service_linked_roles/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/service_linked_roles/methods/delete_resource' - service_linked_role: - name: service_linked_role - id: aws.iam.service_linked_role - x-cfn-schema-name: ServiceLinkedRole - x-cfn-type-name: AWS::IAM::ServiceLinkedRole - x-identifiers: - - RoleName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3280,12 +3766,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/service_linked_roles/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/service_linked_roles/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/service_linked_role/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/service_linked_roles/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3298,7 +3788,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3317,7 +3807,7 @@ components: x-cfn-type-name: AWS::IAM::User x-identifiers: - UserName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3334,9 +3824,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3346,41 +3836,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/users/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/users/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.UserName') as user_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::User' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'UserName') as user_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::User' - AND region = 'us-east-1' - user: - name: user - id: aws.iam.user - x-cfn-schema-name: User - x-cfn-type-name: AWS::IAM::User - x-identifiers: - - UserName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3391,12 +3849,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/users/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/users/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/user/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/users/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3414,91 +3876,96 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Path') as path, - json_extract_path_text(Properties, 'ManagedPolicyArns') as managed_policy_arns, - json_extract_path_text(Properties, 'Policies') as policies, - json_extract_path_text(Properties, 'UserName') as user_name, - json_extract_path_text(Properties, 'Groups') as groups, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'LoginProfile') as login_profile, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'PermissionsBoundary') as permissions_boundary - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IAM::User' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.UserName') as user_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::User' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Path') as path, + json_extract_path_text(Properties, 'ManagedPolicyArns') as managed_policy_arns, + json_extract_path_text(Properties, 'Policies') as policies, + json_extract_path_text(Properties, 'UserName') as user_name, + json_extract_path_text(Properties, 'Groups') as groups, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'LoginProfile') as login_profile, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'PermissionsBoundary') as permissions_boundary + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IAM::User' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'UserName') as user_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::User' + AND region = 'us-east-1' user_policies: - name: user_policies id: aws.iam.user_policies - x-cfn-schema-name: user_policies - x-type: custom_list - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - UserName, - member, - region - FROM aws.iam_api.user_policies - WHERE UserName = '' - AND region = 'us-east-1' - user_policy: - name: user_policy - id: aws.iam.user_policy - x-cfn-schema-name: UserPolicy - x-cfn-type-name: AWS::IAM::UserPolicy - x-identifiers: - - PolicyName - - UserName - x-type: get + x-cfn-schema-name: GetUserPolicyResponse + x-example-where-clause: WHERE region = 'us-east-1' /* always 'us-east-1' for iam */ AND UserName = '' AND PolicyName = '' + x-type: native methods: - update_resource: + attach: + serviceName: iam operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' - request: - mediaType: application/x-amz-json-1.0 - base: |- - { - "TypeName": "AWS::IAM::UserPolicy" - } + $ref: '#/paths/~1?Action=AttachUserPolicy&Version=2010-05-08&__nativeEndpoint=true/get' + response: + openAPIDocKey: '200' + delete: + serviceName: iam + operation: + $ref: '#/paths/~1?Action=DeleteUserPolicy&Version=2010-05-08&__nativeEndpoint=true/get' + response: + openAPIDocKey: '200' + detach: + serviceName: iam + operation: + $ref: '#/paths/~1?Action=DetachUserPolicy&Version=2010-05-08&__nativeEndpoint=true/get' response: - mediaType: application/json openAPIDocKey: '200' + get: + serviceName: iam + operation: + $ref: '#/paths/~1?Action=GetUserPolicy&Version=2010-05-08&__nativeEndpoint=true/get' + response: + mediaType: text/xml + objectKey: /*/GetUserPolicyResult + openAPIDocKey: '200' + list: + serviceName: iam + operation: + $ref: '#/paths/~1?Action=ListUserPolicies&Version=2010-05-08&__nativeEndpoint=true/get' + response: + mediaType: text/xml + objectKey: /*/ListUserPoliciesResult/PolicyNames/member + openAPIDocKey: '200' + put: + serviceName: iam + operation: + $ref: '#/paths/~1?Action=PutUserPolicy&Version=2010-05-08&__nativeEndpoint=true/get' + response: + openAPIDocKey: '200' + name: user_policies sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/user_policies/methods/delete' + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/user_policies/methods/get' + - $ref: '#/components/x-stackQL-resources/user_policies/methods/list' update: - - $ref: '#/components/x-stackQL-resources/user_policy/methods/update_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - data__Identifier, - JSON_EXTRACT(Properties, '$.PolicyDocument') as policy_document, - JSON_EXTRACT(Properties, '$.PolicyName') as policy_name, - JSON_EXTRACT(Properties, '$.UserName') as user_name - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IAM::UserPolicy' - AND data__Identifier = '|' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - data__Identifier, - json_extract_path_text(Properties, 'PolicyDocument') as policy_document, - json_extract_path_text(Properties, 'PolicyName') as policy_name, - json_extract_path_text(Properties, 'UserName') as user_name - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IAM::UserPolicy' - AND data__Identifier = '|' - AND region = 'us-east-1' + - $ref: '#/components/x-stackQL-resources/user_policies/methods/put' + title: user_policies virtualmfa_devices: name: virtualmfa_devices id: aws.iam.virtualmfa_devices @@ -3506,7 +3973,7 @@ components: x-cfn-type-name: AWS::IAM::VirtualMFADevice x-identifiers: - SerialNumber - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3523,9 +3990,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3535,41 +4002,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/virtualmfa_devices/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/virtualmfa_devices/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.SerialNumber') as serial_number - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::VirtualMFADevice' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'SerialNumber') as serial_number - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::VirtualMFADevice' - AND region = 'us-east-1' - virtualmfa_device: - name: virtualmfa_device - id: aws.iam.virtualmfa_device - x-cfn-schema-name: VirtualMFADevice - x-cfn-type-name: AWS::IAM::VirtualMFADevice - x-identifiers: - - SerialNumber - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3580,12 +4015,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/virtualmfa_devices/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/virtualmfa_devices/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/virtualmfa_device/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/virtualmfa_devices/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3599,45 +4038,93 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'VirtualMfaDeviceName') as virtual_mfa_device_name, - json_extract_path_text(Properties, 'Path') as path, - json_extract_path_text(Properties, 'SerialNumber') as serial_number, - json_extract_path_text(Properties, 'Users') as users, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IAM::VirtualMFADevice' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.SerialNumber') as serial_number + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::VirtualMFADevice' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'VirtualMfaDeviceName') as virtual_mfa_device_name, + json_extract_path_text(Properties, 'Path') as path, + json_extract_path_text(Properties, 'SerialNumber') as serial_number, + json_extract_path_text(Properties, 'Users') as users, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IAM::VirtualMFADevice' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'SerialNumber') as serial_number + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::VirtualMFADevice' + AND region = 'us-east-1' policies: - name: policies id: aws.iam.policies - x-cfn-schema-name: policies - x-type: custom_list - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - PolicyName, - Arn, - AttachmentCount, - CreateDate, - DefaultVersionId, - Description, - IsAttachable, - Path, - PermissionsBoundaryUsageCount, - PolicyId, - Tags, - UpdateDate, - region - FROM aws.iam_api.policies - WHERE region = 'us-east-1' + x-cfn-schema-name: GetPolicyResponse + x-example-where-clause: WHERE region = 'us-east-1' /* always 'us-east-1' for iam */ AND PolicyArn = '' + x-type: native + methods: + create: + serviceName: iam + operation: + $ref: '#/paths/~1?Action=CreatePolicy&Version=2010-05-08&__nativeEndpoint=true/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + delete: + serviceName: iam + operation: + $ref: '#/paths/~1?Action=DeletePolicy&Version=2010-05-08&__nativeEndpoint=true/get' + response: + openAPIDocKey: '200' + get: + serviceName: iam + operation: + $ref: '#/paths/~1?Action=GetPolicy&Version=2010-05-08&__nativeEndpoint=true/get' + response: + mediaType: text/xml + objectKey: /*/GetPolicyResult + openAPIDocKey: '200' + list: + serviceName: iam + operation: + $ref: '#/paths/~1?Action=ListPolicies&Version=2010-05-08&__nativeEndpoint=true/get' + response: + mediaType: text/xml + objectKey: /*/ListPoliciesResult/Policies/member + openAPIDocKey: '200' + tag: + serviceName: iam + operation: + $ref: '#/paths/~1?Action=TagPolicy&Version=2010-05-08&__nativeEndpoint=true/get' + response: + openAPIDocKey: '200' + untag: + serviceName: iam + operation: + $ref: '#/paths/~1?Action=UntagPolicy&Version=2010-05-08&__nativeEndpoint=true/get' + response: + openAPIDocKey: '200' + name: policies + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/policies/methods/delete' + insert: + - $ref: '#/components/x-stackQL-resources/policies/methods/create' + select: + - $ref: '#/components/x-stackQL-resources/policies/methods/get' + - $ref: '#/components/x-stackQL-resources/policies/methods/list' + update: [] + title: policies paths: /?Action=CreateResource&Version=2021-09-30: parameters: @@ -3649,39 +4136,2171 @@ paths: - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: - operationId: CreateResource + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Group&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateGroup + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateGroupRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__GroupPolicy&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateGroupPolicy + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateGroupPolicyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__InstanceProfile&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateInstanceProfile + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateInstanceProfileRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ManagedPolicy&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateManagedPolicy + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateManagedPolicyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__OIDCProvider&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateOIDCProvider + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateOIDCProviderRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Role&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateRole + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateRoleRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__RolePolicy&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateRolePolicy + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateRolePolicyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__SAMLProvider&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSAMLProvider + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSAMLProviderRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ServerCertificate&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateServerCertificate + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateServerCertificateRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ServiceLinkedRole&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateServiceLinkedRole + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateServiceLinkedRoleRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__User&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateUser + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateUserRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__UserPolicy&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateUserPolicy + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateUserPolicyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__VirtualMFADevice&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateVirtualMFADevice + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateVirtualMFADeviceRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=AttachGroupPolicy&Version=2010-05-08&__nativeEndpoint=true: + servers: + - description: The general IAM multi-region endpoint + url: https://iam.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + get: + description: >- +

Attaches the specified managed policy to the specified IAM group.

You use this operation to attach a managed policy to a group. To embed an inline policy in a group, use PutGroupPolicy.

As a best practice, you can validate your IAM policies. To learn more, see Validating IAM policies in the IAM User Guide.

For more information about policies, see Managed policies and inline policies in the IAM User Guide.

+ operationId: GET_AttachGroupPolicy + parameters: + - description: '

The name (friendly name, not ARN) of the group to attach the policy to.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

' + in: query + name: GroupName + required: true + schema: + maxLength: 128 + minLength: 1 + pattern: '[\w+=,.@-]+' + type: string + - description:

The Amazon Resource Name (ARN) of the IAM policy you want to attach.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

+ in: query + name: PolicyArn + required: true + schema: + description:

The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.

For more information about ARNs, go to Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

+ maxLength: 2048 + minLength: 20 + type: string + responses: + '200': + description: Success + '480': + content: + text/xml: + schema: + $ref: '#/components/schemas/NoSuchEntityException' + description: NoSuchEntityException + '481': + content: + text/xml: + schema: + $ref: '#/components/schemas/LimitExceededException' + description: LimitExceededException + '482': + content: + text/xml: + schema: + $ref: '#/components/schemas/InvalidInputException' + description: InvalidInputException + '483': + content: + text/xml: + schema: + $ref: '#/components/schemas/PolicyNotAttachableException' + description: PolicyNotAttachableException + '484': + content: + text/xml: + schema: + $ref: '#/components/schemas/ServiceFailureException' + description: ServiceFailureException + x-aws-operation-name: AttachGroupPolicy + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + description: >- +

Attaches the specified managed policy to the specified IAM group.

You use this operation to attach a managed policy to a group. To embed an inline policy in a group, use PutGroupPolicy.

As a best practice, you can validate your IAM policies. To learn more, see Validating IAM policies in the IAM User Guide.

For more information about policies, see Managed policies and inline policies in the IAM User Guide.

+ operationId: POST_AttachGroupPolicy + parameters: [] + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/AttachGroupPolicyRequest' + responses: + '200': + description: Success + '480': + content: + text/xml: + schema: + $ref: '#/components/schemas/NoSuchEntityException' + description: NoSuchEntityException + '481': + content: + text/xml: + schema: + $ref: '#/components/schemas/LimitExceededException' + description: LimitExceededException + '482': + content: + text/xml: + schema: + $ref: '#/components/schemas/InvalidInputException' + description: InvalidInputException + '483': + content: + text/xml: + schema: + $ref: '#/components/schemas/PolicyNotAttachableException' + description: PolicyNotAttachableException + '484': + content: + text/xml: + schema: + $ref: '#/components/schemas/ServiceFailureException' + description: ServiceFailureException + x-aws-operation-name: AttachGroupPolicy + /?Action=AttachRolePolicy&Version=2010-05-08&__nativeEndpoint=true: + servers: + - description: The general IAM multi-region endpoint + url: https://iam.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + get: + description: >- +

Attaches the specified managed policy to the specified IAM role. When you attach a managed policy to a role, the managed policy becomes part of the role's permission (access) policy.

You cannot use a managed policy as the role's trust policy. The role's trust policy is created at the same time as the role, using CreateRole. You can update a role's trust policy using UpdateAssumeRolePolicy.

Use this operation to attach a managed policy + to a role. To embed an inline policy in a role, use PutRolePolicy. For more information about policies, see Managed policies and inline policies in the IAM User Guide.

As a best practice, you can validate your IAM policies. To learn more, see Validating IAM policies in the + IAM User Guide.

+ operationId: GET_AttachRolePolicy + parameters: + - description: '

The name (friendly name, not ARN) of the role to attach the policy to.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

' + in: query + name: RoleName + required: true + schema: + maxLength: 64 + minLength: 1 + pattern: '[\w+=,.@-]+' + type: string + - description:

The Amazon Resource Name (ARN) of the IAM policy you want to attach.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

+ in: query + name: PolicyArn + required: true + schema: + description:

The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.

For more information about ARNs, go to Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

+ maxLength: 2048 + minLength: 20 + type: string + responses: + '200': + description: Success + '480': + content: + text/xml: + schema: + $ref: '#/components/schemas/NoSuchEntityException' + description: NoSuchEntityException + '481': + content: + text/xml: + schema: + $ref: '#/components/schemas/LimitExceededException' + description: LimitExceededException + '482': + content: + text/xml: + schema: + $ref: '#/components/schemas/InvalidInputException' + description: InvalidInputException + '483': + content: + text/xml: + schema: + $ref: '#/components/schemas/UnmodifiableEntityException' + description: UnmodifiableEntityException + '484': + content: + text/xml: + schema: + $ref: '#/components/schemas/PolicyNotAttachableException' + description: PolicyNotAttachableException + '485': + content: + text/xml: + schema: + $ref: '#/components/schemas/ServiceFailureException' + description: ServiceFailureException + x-aws-operation-name: AttachRolePolicy + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + description: >- +

Attaches the specified managed policy to the specified IAM role. When you attach a managed policy to a role, the managed policy becomes part of the role's permission (access) policy.

You cannot use a managed policy as the role's trust policy. The role's trust policy is created at the same time as the role, using CreateRole. You can update a role's trust policy using UpdateAssumeRolePolicy.

Use this operation to attach a managed policy + to a role. To embed an inline policy in a role, use PutRolePolicy. For more information about policies, see Managed policies and inline policies in the IAM User Guide.

As a best practice, you can validate your IAM policies. To learn more, see Validating IAM policies in the + IAM User Guide.

+ operationId: POST_AttachRolePolicy + parameters: [] + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/AttachRolePolicyRequest' + responses: + '200': + description: Success + '480': + content: + text/xml: + schema: + $ref: '#/components/schemas/NoSuchEntityException' + description: NoSuchEntityException + '481': + content: + text/xml: + schema: + $ref: '#/components/schemas/LimitExceededException' + description: LimitExceededException + '482': + content: + text/xml: + schema: + $ref: '#/components/schemas/InvalidInputException' + description: InvalidInputException + '483': + content: + text/xml: + schema: + $ref: '#/components/schemas/UnmodifiableEntityException' + description: UnmodifiableEntityException + '484': + content: + text/xml: + schema: + $ref: '#/components/schemas/PolicyNotAttachableException' + description: PolicyNotAttachableException + '485': + content: + text/xml: + schema: + $ref: '#/components/schemas/ServiceFailureException' + description: ServiceFailureException + x-aws-operation-name: AttachRolePolicy + /?Action=AttachUserPolicy&Version=2010-05-08&__nativeEndpoint=true: + servers: + - description: The general IAM multi-region endpoint + url: https://iam.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + get: + description: >- +

Attaches the specified managed policy to the specified user.

You use this operation to attach a managed policy to a user. To embed an inline policy in a user, use PutUserPolicy.

As a best practice, you can validate your IAM policies. To learn more, see Validating IAM policies in the IAM User Guide.

For more information about policies, see Managed policies and inline policies in the IAM User Guide.

+ operationId: GET_AttachUserPolicy + parameters: + - description: '

The name (friendly name, not ARN) of the IAM user to attach the policy to.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

' + in: query + name: UserName + required: true + schema: + maxLength: 64 + minLength: 1 + pattern: '[\w+=,.@-]+' + type: string + - description:

The Amazon Resource Name (ARN) of the IAM policy you want to attach.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

+ in: query + name: PolicyArn + required: true + schema: + description:

The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.

For more information about ARNs, go to Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

+ maxLength: 2048 + minLength: 20 + type: string + responses: + '200': + description: Success + '480': + content: + text/xml: + schema: + $ref: '#/components/schemas/NoSuchEntityException' + description: NoSuchEntityException + '481': + content: + text/xml: + schema: + $ref: '#/components/schemas/LimitExceededException' + description: LimitExceededException + '482': + content: + text/xml: + schema: + $ref: '#/components/schemas/InvalidInputException' + description: InvalidInputException + '483': + content: + text/xml: + schema: + $ref: '#/components/schemas/PolicyNotAttachableException' + description: PolicyNotAttachableException + '484': + content: + text/xml: + schema: + $ref: '#/components/schemas/ServiceFailureException' + description: ServiceFailureException + x-aws-operation-name: AttachUserPolicy + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + description: >- +

Attaches the specified managed policy to the specified user.

You use this operation to attach a managed policy to a user. To embed an inline policy in a user, use PutUserPolicy.

As a best practice, you can validate your IAM policies. To learn more, see Validating IAM policies in the IAM User Guide.

For more information about policies, see Managed policies and inline policies in the IAM User Guide.

+ operationId: POST_AttachUserPolicy + parameters: [] + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/AttachUserPolicyRequest' + responses: + '200': + description: Success + '480': + content: + text/xml: + schema: + $ref: '#/components/schemas/NoSuchEntityException' + description: NoSuchEntityException + '481': + content: + text/xml: + schema: + $ref: '#/components/schemas/LimitExceededException' + description: LimitExceededException + '482': + content: + text/xml: + schema: + $ref: '#/components/schemas/InvalidInputException' + description: InvalidInputException + '483': + content: + text/xml: + schema: + $ref: '#/components/schemas/PolicyNotAttachableException' + description: PolicyNotAttachableException + '484': + content: + text/xml: + schema: + $ref: '#/components/schemas/ServiceFailureException' + description: ServiceFailureException + x-aws-operation-name: AttachUserPolicy + /?Action=CreatePolicy&Version=2010-05-08&__nativeEndpoint=true: + servers: + - description: The general IAM multi-region endpoint + url: https://iam.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + get: + description: >- +

Creates a new managed policy for your Amazon Web Services account.

This operation creates a policy version with a version identifier of v1 and sets v1 as the policy's default version. For more information about policy versions, see Versioning for managed policies in the IAM User Guide.

As a best practice, you can validate your IAM policies. To learn more, see + Validating IAM policies in the IAM User Guide.

For more information about managed policies in general, see Managed policies and inline policies in the IAM User Guide.

+ operationId: GET_CreatePolicy + parameters: + - description:

The friendly name of the policy.

IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource".

+ in: query + name: PolicyName + required: true + schema: + maxLength: 128 + minLength: 1 + pattern: '[\w+=,.@-]+' + type: string + - description: >- +

The path for the policy.

For more information about paths, see IAM identifiers in the IAM User Guide.

This parameter is optional. If it is not included, it defaults to a slash (/).

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that + must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.

You cannot use an asterisk (*) in the path name.

 + in: query + name: Path + required: false + schema: + maxLength: 512 + minLength: 1 + pattern: ((/[A-Za-z0-9\.,\+@=_-]+)*)/ + type: string + - description: >- +

The JSON policy document that you want to use as the content for the new policy.

You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum + character counts of a managed policy with no whitespaces, see IAM and STS character quotas.

To learn more about JSON policy grammar, see Grammar of the IAM JSON policy language in the IAM User Guide.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)

  • The special characters tab (\u0009), + line feed (\u000A), and carriage return (\u000D)

+ in: query + name: PolicyDocument + required: true + schema: + maxLength: 131072 + minLength: 1 + pattern: '[\u0009\u000A\u000D\u0020-\u00FF]+' + type: string + - description:

A friendly description of the policy.

Typically used to store information about the permissions defined in the policy. For example, "Grants access to production DynamoDB tables."

The policy description is immutable. After a value is assigned, it cannot be changed.

+ in: query + name: Description + required: false + schema: + maxLength: 1000 + type: string + - description:

A list of tags that you want to attach to the new IAM customer managed policy. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.

 + in: query + name: Tags + required: false + schema: + items: + allOf: + - $ref: '#/components/schemas/Tag' + - xml: + name: member + maxItems: 50 + type: array + responses: + '200': + content: + text/xml: + schema: + properties: + CreatePolicyResult: + $ref: '#/components/schemas/CreatePolicyResponse' + type: object + description: Success + '480': + content: + text/xml: + schema: + $ref: '#/components/schemas/InvalidInputException' + description: InvalidInputException + '481': + content: + text/xml: + schema: + $ref: '#/components/schemas/LimitExceededException' + description: LimitExceededException + '482': + content: + text/xml: + schema: + $ref: '#/components/schemas/EntityAlreadyExistsException' + description: EntityAlreadyExistsException + '483': + content: + text/xml: + schema: + $ref: '#/components/schemas/MalformedPolicyDocumentException' + description: MalformedPolicyDocumentException + '484': + content: + text/xml: + schema: + $ref: '#/components/schemas/ConcurrentModificationException' + description: ConcurrentModificationException + '485': + content: + text/xml: + schema: + $ref: '#/components/schemas/ServiceFailureException' + description: ServiceFailureException + x-aws-operation-name: CreatePolicy + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + description: >- +

Creates a new managed policy for your Amazon Web Services account.

This operation creates a policy version with a version identifier of v1 and sets v1 as the policy's default version. For more information about policy versions, see Versioning for managed policies in the IAM User Guide.

As a best practice, you can validate your IAM policies. To learn more, see + Validating IAM policies in the IAM User Guide.

For more information about managed policies in general, see Managed policies and inline policies in the IAM User Guide.

+ operationId: POST_CreatePolicy + parameters: [] + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/CreatePolicyRequest' + responses: + '200': + content: + text/xml: + schema: + properties: + CreatePolicyResult: + $ref: '#/components/schemas/CreatePolicyResponse' + type: object + description: Success + '480': + content: + text/xml: + schema: + $ref: '#/components/schemas/InvalidInputException' + description: InvalidInputException + '481': + content: + text/xml: + schema: + $ref: '#/components/schemas/LimitExceededException' + description: LimitExceededException + '482': + content: + text/xml: + schema: + $ref: '#/components/schemas/EntityAlreadyExistsException' + description: EntityAlreadyExistsException + '483': + content: + text/xml: + schema: + $ref: '#/components/schemas/MalformedPolicyDocumentException' + description: MalformedPolicyDocumentException + '484': + content: + text/xml: + schema: + $ref: '#/components/schemas/ConcurrentModificationException' + description: ConcurrentModificationException + '485': + content: + text/xml: + schema: + $ref: '#/components/schemas/ServiceFailureException' + description: ServiceFailureException + x-aws-operation-name: CreatePolicy + /?Action=DeleteGroupPolicy&Version=2010-05-08&__nativeEndpoint=true: + servers: + - description: The general IAM multi-region endpoint + url: https://iam.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + get: + description:

Deletes the specified inline policy that is embedded in the specified IAM group.

A group can also have managed policies attached to it. To detach a managed policy from a group, use DetachGroupPolicy. For more information about policies, refer to Managed policies and inline policies in the IAM User Guide.

+ operationId: GET_DeleteGroupPolicy + parameters: + - description: '

The name (friendly name, not ARN) identifying the group that the policy is embedded in.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

' + in: query + name: GroupName + required: true + schema: + maxLength: 128 + minLength: 1 + pattern: '[\w+=,.@-]+' + type: string + - description: '

The name identifying the policy document to delete.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

' + in: query + name: PolicyName + required: true + schema: + maxLength: 128 + minLength: 1 + pattern: '[\w+=,.@-]+' + type: string + responses: + '200': + description: Success + '480': + content: + text/xml: + schema: + $ref: '#/components/schemas/NoSuchEntityException' + description: NoSuchEntityException + '481': + content: + text/xml: + schema: + $ref: '#/components/schemas/LimitExceededException' + description: LimitExceededException + '482': + content: + text/xml: + schema: + $ref: '#/components/schemas/ServiceFailureException' + description: ServiceFailureException + x-aws-operation-name: DeleteGroupPolicy + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + description:

Deletes the specified inline policy that is embedded in the specified IAM group.

A group can also have managed policies attached to it. To detach a managed policy from a group, use DetachGroupPolicy. For more information about policies, refer to Managed policies and inline policies in the IAM User Guide.

+ operationId: POST_DeleteGroupPolicy + parameters: [] + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DeleteGroupPolicyRequest' + responses: + '200': + description: Success + '480': + content: + text/xml: + schema: + $ref: '#/components/schemas/NoSuchEntityException' + description: NoSuchEntityException + '481': + content: + text/xml: + schema: + $ref: '#/components/schemas/LimitExceededException' + description: LimitExceededException + '482': + content: + text/xml: + schema: + $ref: '#/components/schemas/ServiceFailureException' + description: ServiceFailureException + x-aws-operation-name: DeleteGroupPolicy + /?Action=DeletePolicy&Version=2010-05-08&__nativeEndpoint=true: + servers: + - description: The general IAM multi-region endpoint + url: https://iam.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + get: + description: >- +

Deletes the specified managed policy.

Before you can delete a managed policy, you must first detach the policy from all users, groups, and roles that it is attached to. In addition, you must delete all the policy's versions. The following steps describe the process for deleting a managed policy:

  • Detach the policy from all users, groups, and roles that the policy is attached to, using DetachUserPolicy, DetachGroupPolicy, or DetachRolePolicy. + To list all the users, groups, and roles that a policy is attached to, use ListEntitiesForPolicy.

  • Delete all versions of the policy using DeletePolicyVersion. To list the policy's versions, use ListPolicyVersions. You cannot use DeletePolicyVersion to delete the version that is marked as the default version. You delete the policy's default version in the next step of the process.

  • Delete the policy (this automatically deletes + the policy's default version) using this operation.

For information about managed policies, see Managed policies and inline policies in the IAM User Guide.

+ operationId: GET_DeletePolicy + parameters: + - description:

The Amazon Resource Name (ARN) of the IAM policy you want to delete.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

+ in: query + name: PolicyArn + required: true + schema: + description:

The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.

For more information about ARNs, go to Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

+ maxLength: 2048 + minLength: 20 + type: string + responses: + '200': + description: Success + '480': + content: + text/xml: + schema: + $ref: '#/components/schemas/NoSuchEntityException' + description: NoSuchEntityException + '481': + content: + text/xml: + schema: + $ref: '#/components/schemas/LimitExceededException' + description: LimitExceededException + '482': + content: + text/xml: + schema: + $ref: '#/components/schemas/InvalidInputException' + description: InvalidInputException + '483': + content: + text/xml: + schema: + $ref: '#/components/schemas/DeleteConflictException' + description: DeleteConflictException + '484': + content: + text/xml: + schema: + $ref: '#/components/schemas/ServiceFailureException' + description: ServiceFailureException + x-aws-operation-name: DeletePolicy + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + description: >- +

Deletes the specified managed policy.

Before you can delete a managed policy, you must first detach the policy from all users, groups, and roles that it is attached to. In addition, you must delete all the policy's versions. The following steps describe the process for deleting a managed policy:

  • Detach the policy from all users, groups, and roles that the policy is attached to, using DetachUserPolicy, DetachGroupPolicy, or DetachRolePolicy. + To list all the users, groups, and roles that a policy is attached to, use ListEntitiesForPolicy.

  • Delete all versions of the policy using DeletePolicyVersion. To list the policy's versions, use ListPolicyVersions. You cannot use DeletePolicyVersion to delete the version that is marked as the default version. You delete the policy's default version in the next step of the process.

  • Delete the policy (this automatically deletes + the policy's default version) using this operation.

For information about managed policies, see Managed policies and inline policies in the IAM User Guide.

+ operationId: POST_DeletePolicy + parameters: [] + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DeletePolicyRequest' + responses: + '200': + description: Success + '480': + content: + text/xml: + schema: + $ref: '#/components/schemas/NoSuchEntityException' + description: NoSuchEntityException + '481': + content: + text/xml: + schema: + $ref: '#/components/schemas/LimitExceededException' + description: LimitExceededException + '482': + content: + text/xml: + schema: + $ref: '#/components/schemas/InvalidInputException' + description: InvalidInputException + '483': + content: + text/xml: + schema: + $ref: '#/components/schemas/DeleteConflictException' + description: DeleteConflictException + '484': + content: + text/xml: + schema: + $ref: '#/components/schemas/ServiceFailureException' + description: ServiceFailureException + x-aws-operation-name: DeletePolicy + /?Action=DeleteRolePolicy&Version=2010-05-08&__nativeEndpoint=true: + servers: + - description: The general IAM multi-region endpoint + url: https://iam.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + get: + description:

Deletes the specified inline policy that is embedded in the specified IAM role.

A role can also have managed policies attached to it. To detach a managed policy from a role, use DetachRolePolicy. For more information about policies, refer to Managed policies and inline policies in the IAM User Guide.

+ operationId: GET_DeleteRolePolicy + parameters: + - description: '

The name (friendly name, not ARN) identifying the role that the policy is embedded in.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

' + in: query + name: RoleName + required: true + schema: + maxLength: 64 + minLength: 1 + pattern: '[\w+=,.@-]+' + type: string + - description: '

The name of the inline policy to delete from the specified IAM role.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

' + in: query + name: PolicyName + required: true + schema: + maxLength: 128 + minLength: 1 + pattern: '[\w+=,.@-]+' + type: string + responses: + '200': + description: Success + '480': + content: + text/xml: + schema: + $ref: '#/components/schemas/NoSuchEntityException' + description: NoSuchEntityException + '481': + content: + text/xml: + schema: + $ref: '#/components/schemas/LimitExceededException' + description: LimitExceededException + '482': + content: + text/xml: + schema: + $ref: '#/components/schemas/UnmodifiableEntityException' + description: UnmodifiableEntityException + '483': + content: + text/xml: + schema: + $ref: '#/components/schemas/ServiceFailureException' + description: ServiceFailureException + x-aws-operation-name: DeleteRolePolicy + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + description:

Deletes the specified inline policy that is embedded in the specified IAM role.

A role can also have managed policies attached to it. To detach a managed policy from a role, use DetachRolePolicy. For more information about policies, refer to Managed policies and inline policies in the IAM User Guide.

+ operationId: POST_DeleteRolePolicy + parameters: [] + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DeleteRolePolicyRequest' + responses: + '200': + description: Success + '480': + content: + text/xml: + schema: + $ref: '#/components/schemas/NoSuchEntityException' + description: NoSuchEntityException + '481': + content: + text/xml: + schema: + $ref: '#/components/schemas/LimitExceededException' + description: LimitExceededException + '482': + content: + text/xml: + schema: + $ref: '#/components/schemas/UnmodifiableEntityException' + description: UnmodifiableEntityException + '483': + content: + text/xml: + schema: + $ref: '#/components/schemas/ServiceFailureException' + description: ServiceFailureException + x-aws-operation-name: DeleteRolePolicy + /?Action=DeleteUserPolicy&Version=2010-05-08&__nativeEndpoint=true: + servers: + - description: The general IAM multi-region endpoint + url: https://iam.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + get: + description:

Deletes the specified inline policy that is embedded in the specified IAM user.

A user can also have managed policies attached to it. To detach a managed policy from a user, use DetachUserPolicy. For more information about policies, refer to Managed policies and inline policies in the IAM User Guide.

+ operationId: GET_DeleteUserPolicy + parameters: + - description: '

The name (friendly name, not ARN) identifying the user that the policy is embedded in.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

' + in: query + name: UserName + required: true + schema: + maxLength: 128 + minLength: 1 + pattern: '[\w+=,.@-]+' + type: string + - description: '

The name identifying the policy document to delete.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

' + in: query + name: PolicyName + required: true + schema: + maxLength: 128 + minLength: 1 + pattern: '[\w+=,.@-]+' + type: string + responses: + '200': + description: Success + '480': + content: + text/xml: + schema: + $ref: '#/components/schemas/NoSuchEntityException' + description: NoSuchEntityException + '481': + content: + text/xml: + schema: + $ref: '#/components/schemas/LimitExceededException' + description: LimitExceededException + '482': + content: + text/xml: + schema: + $ref: '#/components/schemas/ServiceFailureException' + description: ServiceFailureException + x-aws-operation-name: DeleteUserPolicy + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + description:

Deletes the specified inline policy that is embedded in the specified IAM user.

A user can also have managed policies attached to it. To detach a managed policy from a user, use DetachUserPolicy. For more information about policies, refer to Managed policies and inline policies in the IAM User Guide.

+ operationId: POST_DeleteUserPolicy + parameters: [] + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DeleteUserPolicyRequest' + responses: + '200': + description: Success + '480': + content: + text/xml: + schema: + $ref: '#/components/schemas/NoSuchEntityException' + description: NoSuchEntityException + '481': + content: + text/xml: + schema: + $ref: '#/components/schemas/LimitExceededException' + description: LimitExceededException + '482': + content: + text/xml: + schema: + $ref: '#/components/schemas/ServiceFailureException' + description: ServiceFailureException + x-aws-operation-name: DeleteUserPolicy + /?Action=DetachGroupPolicy&Version=2010-05-08&__nativeEndpoint=true: + servers: + - description: The general IAM multi-region endpoint + url: https://iam.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + get: + description:

Removes the specified managed policy from the specified IAM group.

A group can also have inline policies embedded with it. To delete an inline policy, use DeleteGroupPolicy. For information about policies, see Managed policies and inline policies in the IAM User Guide.

+ operationId: GET_DetachGroupPolicy + parameters: + - description: '

The name (friendly name, not ARN) of the IAM group to detach the policy from.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

' + in: query + name: GroupName + required: true + schema: + maxLength: 128 + minLength: 1 + pattern: '[\w+=,.@-]+' + type: string + - description:

The Amazon Resource Name (ARN) of the IAM policy you want to detach.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

+ in: query + name: PolicyArn + required: true + schema: + description:

The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.

For more information about ARNs, go to Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

+ maxLength: 2048 + minLength: 20 + type: string + responses: + '200': + description: Success + '480': + content: + text/xml: + schema: + $ref: '#/components/schemas/NoSuchEntityException' + description: NoSuchEntityException + '481': + content: + text/xml: + schema: + $ref: '#/components/schemas/LimitExceededException' + description: LimitExceededException + '482': + content: + text/xml: + schema: + $ref: '#/components/schemas/InvalidInputException' + description: InvalidInputException + '483': + content: + text/xml: + schema: + $ref: '#/components/schemas/ServiceFailureException' + description: ServiceFailureException + x-aws-operation-name: DetachGroupPolicy + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + description:

Removes the specified managed policy from the specified IAM group.

A group can also have inline policies embedded with it. To delete an inline policy, use DeleteGroupPolicy. For information about policies, see Managed policies and inline policies in the IAM User Guide.

+ operationId: POST_DetachGroupPolicy + parameters: [] + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DetachGroupPolicyRequest' + responses: + '200': + description: Success + '480': + content: + text/xml: + schema: + $ref: '#/components/schemas/NoSuchEntityException' + description: NoSuchEntityException + '481': + content: + text/xml: + schema: + $ref: '#/components/schemas/LimitExceededException' + description: LimitExceededException + '482': + content: + text/xml: + schema: + $ref: '#/components/schemas/InvalidInputException' + description: InvalidInputException + '483': + content: + text/xml: + schema: + $ref: '#/components/schemas/ServiceFailureException' + description: ServiceFailureException + x-aws-operation-name: DetachGroupPolicy + /?Action=DetachRolePolicy&Version=2010-05-08&__nativeEndpoint=true: + servers: + - description: The general IAM multi-region endpoint + url: https://iam.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + get: + description:

Removes the specified managed policy from the specified role.

A role can also have inline policies embedded with it. To delete an inline policy, use DeleteRolePolicy. For information about policies, see Managed policies and inline policies in the IAM User Guide.

+ operationId: GET_DetachRolePolicy parameters: - - description: Action Header - in: header - name: X-Amz-Target - required: false + - description: '

The name (friendly name, not ARN) of the IAM role to detach the policy from.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

' + in: query + name: RoleName + required: true schema: - default: CloudApiService.CreateResource - enum: - - CloudApiService.CreateResource + maxLength: 64 + minLength: 1 + pattern: '[\w+=,.@-]+' type: string - - in: header - name: Content-Type - required: false + - description:

The Amazon Resource Name (ARN) of the IAM policy you want to detach.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

+ in: query + name: PolicyArn + required: true schema: - default: application/x-amz-json-1.0 - enum: - - application/x-amz-json-1.0 + description:

The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.

For more information about ARNs, go to Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

+ maxLength: 2048 + minLength: 20 type: string + responses: + '200': + description: Success + '480': + content: + text/xml: + schema: + $ref: '#/components/schemas/NoSuchEntityException' + description: NoSuchEntityException + '481': + content: + text/xml: + schema: + $ref: '#/components/schemas/LimitExceededException' + description: LimitExceededException + '482': + content: + text/xml: + schema: + $ref: '#/components/schemas/InvalidInputException' + description: InvalidInputException + '483': + content: + text/xml: + schema: + $ref: '#/components/schemas/UnmodifiableEntityException' + description: UnmodifiableEntityException + '484': + content: + text/xml: + schema: + $ref: '#/components/schemas/ServiceFailureException' + description: ServiceFailureException + x-aws-operation-name: DetachRolePolicy + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + description:

Removes the specified managed policy from the specified role.

A role can also have inline policies embedded with it. To delete an inline policy, use DeleteRolePolicy. For information about policies, see Managed policies and inline policies in the IAM User Guide.

+ operationId: POST_DetachRolePolicy + parameters: [] requestBody: content: - application/x-amz-json-1.0: + text/xml: schema: - $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' - required: true + $ref: '#/components/schemas/DetachRolePolicyRequest' responses: '200': + description: Success + '480': content: - application/json: + text/xml: schema: - $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + $ref: '#/components/schemas/NoSuchEntityException' + description: NoSuchEntityException + '481': + content: + text/xml: + schema: + $ref: '#/components/schemas/LimitExceededException' + description: LimitExceededException + '482': + content: + text/xml: + schema: + $ref: '#/components/schemas/InvalidInputException' + description: InvalidInputException + '483': + content: + text/xml: + schema: + $ref: '#/components/schemas/UnmodifiableEntityException' + description: UnmodifiableEntityException + '484': + content: + text/xml: + schema: + $ref: '#/components/schemas/ServiceFailureException' + description: ServiceFailureException + x-aws-operation-name: DetachRolePolicy + /?Action=DetachUserPolicy&Version=2010-05-08&__nativeEndpoint=true: + servers: + - description: The general IAM multi-region endpoint + url: https://iam.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + get: + description:

Removes the specified managed policy from the specified user.

A user can also have inline policies embedded with it. To delete an inline policy, use DeleteUserPolicy. For information about policies, see Managed policies and inline policies in the IAM User Guide.

+ operationId: GET_DetachUserPolicy + parameters: + - description: '

The name (friendly name, not ARN) of the IAM user to detach the policy from.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

' + in: query + name: UserName + required: true + schema: + maxLength: 64 + minLength: 1 + pattern: '[\w+=,.@-]+' + type: string + - description:

The Amazon Resource Name (ARN) of the IAM policy you want to detach.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

+ in: query + name: PolicyArn + required: true + schema: + description:

The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.

For more information about ARNs, go to Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

+ maxLength: 2048 + minLength: 20 + type: string + responses: + '200': description: Success - /?Action=DeleteResource&Version=2021-09-30: + '480': + content: + text/xml: + schema: + $ref: '#/components/schemas/NoSuchEntityException' + description: NoSuchEntityException + '481': + content: + text/xml: + schema: + $ref: '#/components/schemas/LimitExceededException' + description: LimitExceededException + '482': + content: + text/xml: + schema: + $ref: '#/components/schemas/InvalidInputException' + description: InvalidInputException + '483': + content: + text/xml: + schema: + $ref: '#/components/schemas/ServiceFailureException' + description: ServiceFailureException + x-aws-operation-name: DetachUserPolicy parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' @@ -3691,39 +6310,241 @@ paths: - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: - operationId: DeleteResource + description:

Removes the specified managed policy from the specified user.

A user can also have inline policies embedded with it. To delete an inline policy, use DeleteUserPolicy. For information about policies, see Managed policies and inline policies in the IAM User Guide.

+ operationId: POST_DetachUserPolicy + parameters: [] + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/DetachUserPolicyRequest' + responses: + '200': + description: Success + '480': + content: + text/xml: + schema: + $ref: '#/components/schemas/NoSuchEntityException' + description: NoSuchEntityException + '481': + content: + text/xml: + schema: + $ref: '#/components/schemas/LimitExceededException' + description: LimitExceededException + '482': + content: + text/xml: + schema: + $ref: '#/components/schemas/InvalidInputException' + description: InvalidInputException + '483': + content: + text/xml: + schema: + $ref: '#/components/schemas/ServiceFailureException' + description: ServiceFailureException + x-aws-operation-name: DetachUserPolicy + /?Action=GetGroupPolicy&Version=2010-05-08&__nativeEndpoint=true: + servers: + - description: The general IAM multi-region endpoint + url: https://iam.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + get: + description: >- +

Retrieves the specified inline policy document that is embedded in the specified IAM group.

Policies returned by this operation are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs + provide similar functionality.

An IAM group can also have managed policies attached to it. To retrieve a managed policy document that is attached to a group, use GetPolicy to determine the policy's default version, then use GetPolicyVersion to retrieve the policy document.

For more information about policies, see Managed policies and inline policies in the + IAM User Guide.

+ operationId: GET_GetGroupPolicy parameters: - - description: Action Header - in: header - name: X-Amz-Target - required: false + - description: '

The name of the group the policy is associated with.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

' + in: query + name: GroupName + required: true schema: - default: CloudApiService.DeleteResource - enum: - - CloudApiService.DeleteResource + maxLength: 128 + minLength: 1 + pattern: '[\w+=,.@-]+' type: string - - in: header - name: Content-Type - required: false + - description: '

The name of the policy document to get.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

' + in: query + name: PolicyName + required: true schema: - default: application/x-amz-json-1.0 - enum: - - application/x-amz-json-1.0 + maxLength: 128 + minLength: 1 + pattern: '[\w+=,.@-]+' type: string + responses: + '200': + content: + text/xml: + schema: + properties: + GetGroupPolicyResult: + $ref: '#/components/schemas/GetGroupPolicyResponse' + type: object + description: Success + '480': + content: + text/xml: + schema: + $ref: '#/components/schemas/NoSuchEntityException' + description: NoSuchEntityException + '481': + content: + text/xml: + schema: + $ref: '#/components/schemas/ServiceFailureException' + description: ServiceFailureException + x-aws-operation-name: GetGroupPolicy + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + description: >- +

Retrieves the specified inline policy document that is embedded in the specified IAM group.

Policies returned by this operation are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs + provide similar functionality.

An IAM group can also have managed policies attached to it. To retrieve a managed policy document that is attached to a group, use GetPolicy to determine the policy's default version, then use GetPolicyVersion to retrieve the policy document.

For more information about policies, see Managed policies and inline policies in the + IAM User Guide.

+ operationId: POST_GetGroupPolicy + parameters: [] requestBody: content: - application/x-amz-json-1.0: + text/xml: schema: - $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' - required: true + $ref: '#/components/schemas/GetGroupPolicyRequest' responses: '200': content: - application/json: + text/xml: schema: - $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + properties: + GetGroupPolicyResult: + $ref: '#/components/schemas/GetGroupPolicyResponse' + type: object description: Success - /?Action=UpdateResource&Version=2021-09-30: + '480': + content: + text/xml: + schema: + $ref: '#/components/schemas/NoSuchEntityException' + description: NoSuchEntityException + '481': + content: + text/xml: + schema: + $ref: '#/components/schemas/ServiceFailureException' + description: ServiceFailureException + x-aws-operation-name: GetGroupPolicy + /?Action=GetPolicy&Version=2010-05-08&__nativeEndpoint=true: + servers: + - description: The general IAM multi-region endpoint + url: https://iam.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + get: + description: >- +

Retrieves information about the specified managed policy, including the policy's default version and the total number of IAM users, groups, and roles to which the policy is attached. To retrieve the list of the specific users, groups, and roles that the policy is attached to, use ListEntitiesForPolicy. This operation returns metadata about the policy. To retrieve the actual policy document for a specific version of the policy, use GetPolicyVersion.

This operation + retrieves information about managed policies. To retrieve information about an inline policy that is embedded with an IAM user, group, or role, use GetUserPolicy, GetGroupPolicy, or GetRolePolicy.

For more information about policies, see Managed policies and inline policies in the IAM User Guide.

+ operationId: GET_GetPolicy + parameters: + - description:

The Amazon Resource Name (ARN) of the managed policy that you want information about.

For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

+ in: query + name: PolicyArn + required: true + schema: + description:

The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.

For more information about ARNs, go to Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

+ maxLength: 2048 + minLength: 20 + type: string + responses: + '200': + content: + text/xml: + schema: + properties: + GetPolicyResult: + $ref: '#/components/schemas/GetPolicyResponse' + type: object + description: Success + '480': + content: + text/xml: + schema: + $ref: '#/components/schemas/NoSuchEntityException' + description: NoSuchEntityException + '481': + content: + text/xml: + schema: + $ref: '#/components/schemas/InvalidInputException' + description: InvalidInputException + '482': + content: + text/xml: + schema: + $ref: '#/components/schemas/ServiceFailureException' + description: ServiceFailureException + x-aws-operation-name: GetPolicy parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' @@ -3733,55 +6554,125 @@ paths: - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: - operationId: UpdateResource + description: >- +

Retrieves information about the specified managed policy, including the policy's default version and the total number of IAM users, groups, and roles to which the policy is attached. To retrieve the list of the specific users, groups, and roles that the policy is attached to, use ListEntitiesForPolicy. This operation returns metadata about the policy. To retrieve the actual policy document for a specific version of the policy, use GetPolicyVersion.

This operation + retrieves information about managed policies. To retrieve information about an inline policy that is embedded with an IAM user, group, or role, use GetUserPolicy, GetGroupPolicy, or GetRolePolicy.

For more information about policies, see Managed policies and inline policies in the IAM User Guide.

+ operationId: POST_GetPolicy + parameters: [] + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/GetPolicyRequest' + responses: + '200': + content: + text/xml: + schema: + properties: + GetPolicyResult: + $ref: '#/components/schemas/GetPolicyResponse' + type: object + description: Success + '480': + content: + text/xml: + schema: + $ref: '#/components/schemas/NoSuchEntityException' + description: NoSuchEntityException + '481': + content: + text/xml: + schema: + $ref: '#/components/schemas/InvalidInputException' + description: InvalidInputException + '482': + content: + text/xml: + schema: + $ref: '#/components/schemas/ServiceFailureException' + description: ServiceFailureException + x-aws-operation-name: GetPolicy + /?Action=GetRolePolicy&Version=2010-05-08&__nativeEndpoint=true: + servers: + - description: The general IAM multi-region endpoint + url: https://iam.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + get: + description: >- +

Retrieves the specified inline policy document that is embedded with the specified IAM role.

Policies returned by this operation are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs + provide similar functionality.

An IAM role can also have managed policies attached to it. To retrieve a managed policy document that is attached to a role, use GetPolicy to determine the policy's default version, then use GetPolicyVersion to retrieve the policy document.

For more information about policies, see Managed policies and inline policies in the + IAM User Guide.

For more information about roles, see Using roles to delegate permissions and federate identities.

+ operationId: GET_GetRolePolicy parameters: - - description: Action Header - in: header - name: X-Amz-Target - required: false + - description: '

The name of the role associated with the policy.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

' + in: query + name: RoleName + required: true schema: - default: CloudApiService.UpdateResource - enum: - - CloudApiService.UpdateResource + maxLength: 64 + minLength: 1 + pattern: '[\w+=,.@-]+' type: string - - in: header - name: Content-Type - required: false + - description: '

The name of the policy document to get.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

' + in: query + name: PolicyName + required: true schema: - default: application/x-amz-json-1.0 - enum: - - application/x-amz-json-1.0 + maxLength: 128 + minLength: 1 + pattern: '[\w+=,.@-]+' type: string - requestBody: - content: - application/x-amz-json-1.0: - schema: - properties: - ClientName: - type: string - Identifier: - $ref: '#/components/x-cloud-control-schemas/Identifier' - PatchDocument: - type: string - RoleArn: - $ref: '#/components/x-cloud-control-schemas/RoleArn' - TypeName: - $ref: '#/components/x-cloud-control-schemas/TypeName' - TypeVersionId: - $ref: '#/components/x-cloud-control-schemas/TypeVersionId' - required: - - Identifier - - PatchDocument - type: object - required: true responses: '200': content: - application/json: + text/xml: schema: - $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + properties: + GetRolePolicyResult: + $ref: '#/components/schemas/GetRolePolicyResponse' + type: object description: Success - /?Action=CreateResource&Version=2021-09-30&__Group&__detailTransformed=true: + '480': + content: + text/xml: + schema: + $ref: '#/components/schemas/NoSuchEntityException' + description: NoSuchEntityException + '481': + content: + text/xml: + schema: + $ref: '#/components/schemas/ServiceFailureException' + description: ServiceFailureException + x-aws-operation-name: GetRolePolicy parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' @@ -3791,39 +6682,120 @@ paths: - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: - operationId: CreateGroup + description: >- +

Retrieves the specified inline policy document that is embedded with the specified IAM role.

Policies returned by this operation are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs + provide similar functionality.

An IAM role can also have managed policies attached to it. To retrieve a managed policy document that is attached to a role, use GetPolicy to determine the policy's default version, then use GetPolicyVersion to retrieve the policy document.

For more information about policies, see Managed policies and inline policies in the + IAM User Guide.

For more information about roles, see Using roles to delegate permissions and federate identities.

+ operationId: POST_GetRolePolicy + parameters: [] + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/GetRolePolicyRequest' + responses: + '200': + content: + text/xml: + schema: + properties: + GetRolePolicyResult: + $ref: '#/components/schemas/GetRolePolicyResponse' + type: object + description: Success + '480': + content: + text/xml: + schema: + $ref: '#/components/schemas/NoSuchEntityException' + description: NoSuchEntityException + '481': + content: + text/xml: + schema: + $ref: '#/components/schemas/ServiceFailureException' + description: ServiceFailureException + x-aws-operation-name: GetRolePolicy + /?Action=GetUserPolicy&Version=2010-05-08&__nativeEndpoint=true: + servers: + - description: The general IAM multi-region endpoint + url: https://iam.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + get: + description: >- +

Retrieves the specified inline policy document that is embedded in the specified IAM user.

Policies returned by this operation are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide + similar functionality.

An IAM user can also have managed policies attached to it. To retrieve a managed policy document that is attached to a user, use GetPolicy to determine the policy's default version. Then use GetPolicyVersion to retrieve the policy document.

For more information about policies, see Managed policies and inline policies in the IAM User + Guide.

+ operationId: GET_GetUserPolicy parameters: - - description: Action Header - in: header - name: X-Amz-Target - required: false + - description: '

The name of the user who the policy is associated with.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

' + in: query + name: UserName + required: true schema: - default: CloudApiService.CreateResource - enum: - - CloudApiService.CreateResource - type: string - - in: header - name: Content-Type - required: false + maxLength: 128 + minLength: 1 + pattern: '[\w+=,.@-]+' + type: string + - description: '

The name of the policy document to get.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

' + in: query + name: PolicyName + required: true schema: - default: application/x-amz-json-1.0 - enum: - - application/x-amz-json-1.0 + maxLength: 128 + minLength: 1 + pattern: '[\w+=,.@-]+' type: string - requestBody: - content: - application/x-amz-json-1.0: - schema: - $ref: '#/components/schemas/CreateGroupRequest' - required: true responses: '200': content: - application/json: + text/xml: schema: - $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + properties: + GetUserPolicyResult: + $ref: '#/components/schemas/GetUserPolicyResponse' + type: object description: Success - /?Action=CreateResource&Version=2021-09-30&__GroupPolicy&__detailTransformed=true: + '480': + content: + text/xml: + schema: + $ref: '#/components/schemas/NoSuchEntityException' + description: NoSuchEntityException + '481': + content: + text/xml: + schema: + $ref: '#/components/schemas/ServiceFailureException' + description: ServiceFailureException + x-aws-operation-name: GetUserPolicy parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' @@ -3833,39 +6805,129 @@ paths: - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: - operationId: CreateGroupPolicy + description: >- +

Retrieves the specified inline policy document that is embedded in the specified IAM user.

Policies returned by this operation are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide + similar functionality.

An IAM user can also have managed policies attached to it. To retrieve a managed policy document that is attached to a user, use GetPolicy to determine the policy's default version. Then use GetPolicyVersion to retrieve the policy document.

For more information about policies, see Managed policies and inline policies in the IAM User + Guide.

+ operationId: POST_GetUserPolicy + parameters: [] + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/GetUserPolicyRequest' + responses: + '200': + content: + text/xml: + schema: + properties: + GetUserPolicyResult: + $ref: '#/components/schemas/GetUserPolicyResponse' + type: object + description: Success + '480': + content: + text/xml: + schema: + $ref: '#/components/schemas/NoSuchEntityException' + description: NoSuchEntityException + '481': + content: + text/xml: + schema: + $ref: '#/components/schemas/ServiceFailureException' + description: ServiceFailureException + x-aws-operation-name: GetUserPolicy + /?Action=ListGroupPolicies&Version=2010-05-08&__nativeEndpoint=true: + servers: + - description: The general IAM multi-region endpoint + url: https://iam.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + get: + description: >- +

Lists the names of the inline policies that are embedded in the specified IAM group.

An IAM group can also have managed policies attached to it. To list the managed policies that are attached to a group, use ListAttachedGroupPolicies. For more information about policies, see Managed policies and inline policies in the IAM User Guide.

You can paginate the results + using the MaxItems and Marker parameters. If there are no inline policies embedded with the specified group, the operation returns an empty list.

+ operationId: GET_ListGroupPolicies parameters: - - description: Action Header - in: header - name: X-Amz-Target - required: false + - description: '

The name of the group to list policies for.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

' + in: query + name: GroupName + required: true schema: - default: CloudApiService.CreateResource - enum: - - CloudApiService.CreateResource + maxLength: 128 + minLength: 1 + pattern: '[\w+=,.@-]+' type: string - - in: header - name: Content-Type + - description: Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start. + in: query + name: Marker required: false schema: - default: application/x-amz-json-1.0 - enum: - - application/x-amz-json-1.0 + maxLength: 320 + minLength: 1 + pattern: '[\u0020-\u00FF]+' type: string - requestBody: - content: - application/x-amz-json-1.0: - schema: - $ref: '#/components/schemas/CreateGroupPolicyRequest' - required: true + - description: >- +

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, + and Marker contains a value to include in the subsequent call that tells the service where to continue from.

+ in: query + name: MaxItems + required: false + schema: + maximum: 1000 + minimum: 1 + type: integer responses: '200': content: - application/json: + text/xml: schema: - $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + properties: + ListGroupPoliciesResult: + $ref: '#/components/schemas/ListGroupPoliciesResponse' + type: object description: Success - /?Action=CreateResource&Version=2021-09-30&__InstanceProfile&__detailTransformed=true: + '480': + content: + text/xml: + schema: + $ref: '#/components/schemas/NoSuchEntityException' + description: NoSuchEntityException + '481': + content: + text/xml: + schema: + $ref: '#/components/schemas/ServiceFailureException' + description: ServiceFailureException + x-aws-operation-name: ListGroupPolicies parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' @@ -3875,81 +6937,163 @@ paths: - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: - operationId: CreateInstanceProfile + description: >- +

Lists the names of the inline policies that are embedded in the specified IAM group.

An IAM group can also have managed policies attached to it. To list the managed policies that are attached to a group, use ListAttachedGroupPolicies. For more information about policies, see Managed policies and inline policies in the IAM User Guide.

You can paginate the results + using the MaxItems and Marker parameters. If there are no inline policies embedded with the specified group, the operation returns an empty list.

+ operationId: POST_ListGroupPolicies parameters: - - description: Action Header - in: header - name: X-Amz-Target + - description: Pagination limit + in: query + name: MaxItems required: false schema: - default: CloudApiService.CreateResource - enum: - - CloudApiService.CreateResource type: string - - in: header - name: Content-Type + - description: Pagination token + in: query + name: Marker required: false schema: - default: application/x-amz-json-1.0 - enum: - - application/x-amz-json-1.0 type: string requestBody: content: - application/x-amz-json-1.0: + text/xml: schema: - $ref: '#/components/schemas/CreateInstanceProfileRequest' - required: true + $ref: '#/components/schemas/ListGroupPoliciesRequest' responses: '200': content: - application/json: + text/xml: schema: - $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + properties: + ListGroupPoliciesResult: + $ref: '#/components/schemas/ListGroupPoliciesResponse' + type: object description: Success - /?Action=CreateResource&Version=2021-09-30&__ManagedPolicy&__detailTransformed=true: - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - operationId: CreateManagedPolicy + '480': + content: + text/xml: + schema: + $ref: '#/components/schemas/NoSuchEntityException' + description: NoSuchEntityException + '481': + content: + text/xml: + schema: + $ref: '#/components/schemas/ServiceFailureException' + description: ServiceFailureException + x-aws-operation-name: ListGroupPolicies + /?Action=ListPolicies&Version=2010-05-08&__nativeEndpoint=true: + servers: + - description: The general IAM multi-region endpoint + url: https://iam.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + get: + description: >- +

Lists all the managed policies that are available in your Amazon Web Services account, including your own customer-defined managed policies and all Amazon Web Services managed policies.

You can filter the list of policies that is returned using the optional OnlyAttached, Scope, and PathPrefix parameters. For example, to list only the customer managed policies in your Amazon Web Services account, set Scope to + Local. To list only Amazon Web Services managed policies, set Scope to AWS.

You can paginate the results using the MaxItems and Marker parameters.

For more information about managed policies, see Managed policies and inline policies in the IAM User Guide.

IAM resource-listing operations return a + subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a customer manged policy, see GetPolicy.

 + operationId: GET_ListPolicies parameters: - - description: Action Header - in: header - name: X-Amz-Target + - description:

The scope to use for filtering the results.

To list only Amazon Web Services managed policies, set Scope to AWS. To list only the customer managed policies in your Amazon Web Services account, set Scope to Local.

This parameter is optional. If it is not included, or if it is set to All, all policies are returned.

+ in: query + name: Scope required: false schema: - default: CloudApiService.CreateResource enum: - - CloudApiService.CreateResource + - All + - AWS + - Local type: string - - in: header - name: Content-Type + - description:

A flag to filter the results to only the attached policies.

When OnlyAttached is true, the returned list contains only the policies that are attached to an IAM user, group, or role. When OnlyAttached is false, or when the parameter is not included, all policies are returned.

+ in: query + name: OnlyAttached required: false schema: - default: application/x-amz-json-1.0 + type: boolean + - description: >- + The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies. This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character + (\u007F), including most punctuation characters, digits, and upper and lowercased letters. + in: query + name: PathPrefix + required: false + schema: + maxLength: 512 + minLength: 1 + pattern: ((/[A-Za-z0-9\.,\+@=_-]+)*)/ + type: string + - description: "

The policy usage method to use for filtering the results.

To list only permissions policies, set\_PolicyUsageFilter\_to\_PermissionsPolicy. To list only the policies used to set permissions boundaries, set\_the value to\_PermissionsBoundary.

This parameter is optional. If it is not included, all policies are returned.

" + in: query + name: PolicyUsageFilter + required: false + schema: + description:

The policy usage type that indicates whether the policy is used as a permissions policy or as the permissions boundary for an entity.

For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.

enum: - - application/x-amz-json-1.0 + - PermissionsPolicy + - PermissionsBoundary type: string - requestBody: - content: - application/x-amz-json-1.0: - schema: - $ref: '#/components/schemas/CreateManagedPolicyRequest' - required: true + - description: Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start. + in: query + name: Marker + required: false + schema: + maxLength: 320 + minLength: 1 + pattern: '[\u0020-\u00FF]+' + type: string + - description: >- +

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, + and Marker contains a value to include in the subsequent call that tells the service where to continue from.

+ in: query + name: MaxItems + required: false + schema: + maximum: 1000 + minimum: 1 + type: integer responses: '200': content: - application/json: + text/xml: schema: - $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + properties: + ListPoliciesResult: + $ref: '#/components/schemas/ListPoliciesResponse' + type: object description: Success - /?Action=CreateResource&Version=2021-09-30&__OIDCProvider&__detailTransformed=true: + '480': + content: + text/xml: + schema: + $ref: '#/components/schemas/ServiceFailureException' + description: ServiceFailureException + x-aws-operation-name: ListPolicies parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' @@ -3959,39 +7103,135 @@ paths: - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: - operationId: CreateOIDCProvider + description: >- +

Lists all the managed policies that are available in your Amazon Web Services account, including your own customer-defined managed policies and all Amazon Web Services managed policies.

You can filter the list of policies that is returned using the optional OnlyAttached, Scope, and PathPrefix parameters. For example, to list only the customer managed policies in your Amazon Web Services account, set Scope to + Local. To list only Amazon Web Services managed policies, set Scope to AWS.

You can paginate the results using the MaxItems and Marker parameters.

For more information about managed policies, see Managed policies and inline policies in the IAM User Guide.

IAM resource-listing operations return a + subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a customer manged policy, see GetPolicy.

 + operationId: POST_ListPolicies parameters: - - description: Action Header - in: header - name: X-Amz-Target + - description: Pagination limit + in: query + name: MaxItems required: false schema: - default: CloudApiService.CreateResource - enum: - - CloudApiService.CreateResource type: string - - in: header - name: Content-Type + - description: Pagination token + in: query + name: Marker required: false schema: - default: application/x-amz-json-1.0 - enum: - - application/x-amz-json-1.0 type: string requestBody: content: - application/x-amz-json-1.0: + text/xml: schema: - $ref: '#/components/schemas/CreateOIDCProviderRequest' - required: true + $ref: '#/components/schemas/ListPoliciesRequest' responses: '200': content: - application/json: + text/xml: schema: - $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + properties: + ListPoliciesResult: + $ref: '#/components/schemas/ListPoliciesResponse' + type: object description: Success - /?Action=CreateResource&Version=2021-09-30&__Role&__detailTransformed=true: + '480': + content: + text/xml: + schema: + $ref: '#/components/schemas/ServiceFailureException' + description: ServiceFailureException + x-aws-operation-name: ListPolicies + /?Action=ListRolePolicies&Version=2010-05-08&__nativeEndpoint=true: + servers: + - description: The general IAM multi-region endpoint + url: https://iam.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + get: + description: >- +

Lists the names of the inline policies that are embedded in the specified IAM role.

An IAM role can also have managed policies attached to it. To list the managed policies that are attached to a role, use ListAttachedRolePolicies. For more information about policies, see Managed policies and inline policies in the IAM User Guide.

You can paginate the results using + the MaxItems and Marker parameters. If there are no inline policies embedded with the specified role, the operation returns an empty list.

+ operationId: GET_ListRolePolicies + parameters: + - description: '

The name of the role to list policies for.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

' + in: query + name: RoleName + required: true + schema: + maxLength: 64 + minLength: 1 + pattern: '[\w+=,.@-]+' + type: string + - description: Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start. + in: query + name: Marker + required: false + schema: + maxLength: 320 + minLength: 1 + pattern: '[\u0020-\u00FF]+' + type: string + - description: >- +

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, + and Marker contains a value to include in the subsequent call that tells the service where to continue from.

+ in: query + name: MaxItems + required: false + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + '200': + content: + text/xml: + schema: + properties: + ListRolePoliciesResult: + $ref: '#/components/schemas/ListRolePoliciesResponse' + type: object + description: Success + '480': + content: + text/xml: + schema: + $ref: '#/components/schemas/NoSuchEntityException' + description: NoSuchEntityException + '481': + content: + text/xml: + schema: + $ref: '#/components/schemas/ServiceFailureException' + description: ServiceFailureException + x-aws-operation-name: ListRolePolicies parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' @@ -4001,39 +7241,140 @@ paths: - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: - operationId: CreateRole + description: >- +

Lists the names of the inline policies that are embedded in the specified IAM role.

An IAM role can also have managed policies attached to it. To list the managed policies that are attached to a role, use ListAttachedRolePolicies. For more information about policies, see Managed policies and inline policies in the IAM User Guide.

You can paginate the results using + the MaxItems and Marker parameters. If there are no inline policies embedded with the specified role, the operation returns an empty list.

+ operationId: POST_ListRolePolicies parameters: - - description: Action Header - in: header - name: X-Amz-Target + - description: Pagination limit + in: query + name: MaxItems required: false schema: - default: CloudApiService.CreateResource - enum: - - CloudApiService.CreateResource type: string - - in: header - name: Content-Type + - description: Pagination token + in: query + name: Marker required: false schema: - default: application/x-amz-json-1.0 - enum: - - application/x-amz-json-1.0 type: string requestBody: content: - application/x-amz-json-1.0: + text/xml: schema: - $ref: '#/components/schemas/CreateRoleRequest' - required: true + $ref: '#/components/schemas/ListRolePoliciesRequest' responses: '200': content: - application/json: + text/xml: schema: - $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + properties: + ListRolePoliciesResult: + $ref: '#/components/schemas/ListRolePoliciesResponse' + type: object description: Success - /?Action=CreateResource&Version=2021-09-30&__RolePolicy&__detailTransformed=true: + '480': + content: + text/xml: + schema: + $ref: '#/components/schemas/NoSuchEntityException' + description: NoSuchEntityException + '481': + content: + text/xml: + schema: + $ref: '#/components/schemas/ServiceFailureException' + description: ServiceFailureException + x-aws-operation-name: ListRolePolicies + /?Action=ListUserPolicies&Version=2010-05-08&__nativeEndpoint=true: + servers: + - description: The general IAM multi-region endpoint + url: https://iam.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + get: + description: >- +

Lists the names of the inline policies embedded in the specified IAM user.

An IAM user can also have managed policies attached to it. To list the managed policies that are attached to a user, use ListAttachedUserPolicies. For more information about policies, see Managed policies and inline policies in the IAM User Guide.

You can paginate the results using the + MaxItems and Marker parameters. If there are no inline policies embedded with the specified user, the operation returns an empty list.

+ operationId: GET_ListUserPolicies + parameters: + - description: '

The name of the user to list policies for.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

' + in: query + name: UserName + required: true + schema: + maxLength: 128 + minLength: 1 + pattern: '[\w+=,.@-]+' + type: string + - description: Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start. + in: query + name: Marker + required: false + schema: + maxLength: 320 + minLength: 1 + pattern: '[\u0020-\u00FF]+' + type: string + - description: >- +

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, + and Marker contains a value to include in the subsequent call that tells the service where to continue from.

+ in: query + name: MaxItems + required: false + schema: + maximum: 1000 + minimum: 1 + type: integer + responses: + '200': + content: + text/xml: + schema: + properties: + ListUserPoliciesResult: + $ref: '#/components/schemas/ListUserPoliciesResponse' + type: object + description: Success + '480': + content: + text/xml: + schema: + $ref: '#/components/schemas/NoSuchEntityException' + description: NoSuchEntityException + '481': + content: + text/xml: + schema: + $ref: '#/components/schemas/ServiceFailureException' + description: ServiceFailureException + x-aws-operation-name: ListUserPolicies parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' @@ -4043,81 +7384,147 @@ paths: - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: - operationId: CreateRolePolicy + description: >- +

Lists the names of the inline policies embedded in the specified IAM user.

An IAM user can also have managed policies attached to it. To list the managed policies that are attached to a user, use ListAttachedUserPolicies. For more information about policies, see Managed policies and inline policies in the IAM User Guide.

You can paginate the results using the + MaxItems and Marker parameters. If there are no inline policies embedded with the specified user, the operation returns an empty list.

+ operationId: POST_ListUserPolicies parameters: - - description: Action Header - in: header - name: X-Amz-Target + - description: Pagination limit + in: query + name: MaxItems required: false schema: - default: CloudApiService.CreateResource - enum: - - CloudApiService.CreateResource type: string - - in: header - name: Content-Type + - description: Pagination token + in: query + name: Marker required: false schema: - default: application/x-amz-json-1.0 - enum: - - application/x-amz-json-1.0 type: string requestBody: content: - application/x-amz-json-1.0: + text/xml: schema: - $ref: '#/components/schemas/CreateRolePolicyRequest' - required: true + $ref: '#/components/schemas/ListUserPoliciesRequest' responses: '200': content: - application/json: + text/xml: schema: - $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + properties: + ListUserPoliciesResult: + $ref: '#/components/schemas/ListUserPoliciesResponse' + type: object description: Success - /?Action=CreateResource&Version=2021-09-30&__SAMLProvider&__detailTransformed=true: - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - operationId: CreateSAMLProvider + '480': + content: + text/xml: + schema: + $ref: '#/components/schemas/NoSuchEntityException' + description: NoSuchEntityException + '481': + content: + text/xml: + schema: + $ref: '#/components/schemas/ServiceFailureException' + description: ServiceFailureException + x-aws-operation-name: ListUserPolicies + /?Action=PutGroupPolicy&Version=2010-05-08&__nativeEndpoint=true: + servers: + - description: The general IAM multi-region endpoint + url: https://iam.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + get: + description: >- +

Adds or updates an inline policy document that is embedded in the specified IAM group.

A user can also have managed policies attached to it. To attach a managed policy to a group, use AttachGroupPolicy. To create a new managed policy, use CreatePolicy. For information about policies, see Managed policies and inline policies in the IAM User Guide.

For + information about the maximum number of inline policies that you can embed in a group, see IAM and STS quotas in the IAM User Guide.

Because policy documents can be large, you should use POST rather than GET when calling PutGroupPolicy. For general information about using the Query API with IAM, see Making query requests in the IAM User Guide.

 + operationId: GET_PutGroupPolicy parameters: - - description: Action Header - in: header - name: X-Amz-Target - required: false + - description: '

The name of the group to associate the policy with.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-.

' + in: query + name: GroupName + required: true schema: - default: CloudApiService.CreateResource - enum: - - CloudApiService.CreateResource + maxLength: 128 + minLength: 1 + pattern: '[\w+=,.@-]+' type: string - - in: header - name: Content-Type - required: false + - description: '

The name of the policy document.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

' + in: query + name: PolicyName + required: true schema: - default: application/x-amz-json-1.0 - enum: - - application/x-amz-json-1.0 + maxLength: 128 + minLength: 1 + pattern: '[\w+=,.@-]+' + type: string + - description: >- +

The policy document.

You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to = IAM.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character + ranging from the space character (\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)

  • The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)

+ in: query + name: PolicyDocument + required: true + schema: + maxLength: 131072 + minLength: 1 + pattern: '[\u0009\u000A\u000D\u0020-\u00FF]+' type: string - requestBody: - content: - application/x-amz-json-1.0: - schema: - $ref: '#/components/schemas/CreateSAMLProviderRequest' - required: true responses: '200': + description: Success + '480': content: - application/json: + text/xml: schema: - $ref: '#/components/x-cloud-control-schemas/ProgressEvent' - description: Success - /?Action=CreateResource&Version=2021-09-30&__ServerCertificate&__detailTransformed=true: + $ref: '#/components/schemas/LimitExceededException' + description: LimitExceededException + '481': + content: + text/xml: + schema: + $ref: '#/components/schemas/MalformedPolicyDocumentException' + description: MalformedPolicyDocumentException + '482': + content: + text/xml: + schema: + $ref: '#/components/schemas/NoSuchEntityException' + description: NoSuchEntityException + '483': + content: + text/xml: + schema: + $ref: '#/components/schemas/ServiceFailureException' + description: ServiceFailureException + x-aws-operation-name: PutGroupPolicy parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' @@ -4127,39 +7534,148 @@ paths: - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: - operationId: CreateServerCertificate + description: >- +

Adds or updates an inline policy document that is embedded in the specified IAM group.

A user can also have managed policies attached to it. To attach a managed policy to a group, use AttachGroupPolicy. To create a new managed policy, use CreatePolicy. For information about policies, see Managed policies and inline policies in the IAM User Guide.

For + information about the maximum number of inline policies that you can embed in a group, see IAM and STS quotas in the IAM User Guide.

Because policy documents can be large, you should use POST rather than GET when calling PutGroupPolicy. For general information about using the Query API with IAM, see Making query requests in the IAM User Guide.

 + operationId: POST_PutGroupPolicy + parameters: [] + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/PutGroupPolicyRequest' + responses: + '200': + description: Success + '480': + content: + text/xml: + schema: + $ref: '#/components/schemas/LimitExceededException' + description: LimitExceededException + '481': + content: + text/xml: + schema: + $ref: '#/components/schemas/MalformedPolicyDocumentException' + description: MalformedPolicyDocumentException + '482': + content: + text/xml: + schema: + $ref: '#/components/schemas/NoSuchEntityException' + description: NoSuchEntityException + '483': + content: + text/xml: + schema: + $ref: '#/components/schemas/ServiceFailureException' + description: ServiceFailureException + x-aws-operation-name: PutGroupPolicy + /?Action=PutRolePolicy&Version=2010-05-08&__nativeEndpoint=true: + servers: + - description: The general IAM multi-region endpoint + url: https://iam.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + get: + description: >- +

Adds or updates an inline policy document that is embedded in the specified IAM role.

When you embed an inline policy in a role, the inline policy is used as part of the role's access (permissions) policy. The role's trust policy is created at the same time as the role, using CreateRole. You can update a role's trust policy using UpdateAssumeRolePolicy. For more information about IAM roles, see Using roles to delegate permissions and federate identities.

A role can also have a managed policy attached to it. To attach a managed policy to a role, use AttachRolePolicy. To create a new managed policy, use CreatePolicy. For information about policies, see Managed policies and inline + policies in the IAM User Guide.

For information about the maximum number of inline policies that you can embed with a role, see IAM and STS quotas in the IAM User Guide.

Because policy documents can be large, you should use POST rather than GET when calling PutRolePolicy. For general information about using the Query API with IAM, see Making query requests in the IAM User Guide.

 + operationId: GET_PutRolePolicy parameters: - - description: Action Header - in: header - name: X-Amz-Target - required: false + - description: '

The name of the role to associate the policy with.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

' + in: query + name: RoleName + required: true schema: - default: CloudApiService.CreateResource - enum: - - CloudApiService.CreateResource + maxLength: 64 + minLength: 1 + pattern: '[\w+=,.@-]+' type: string - - in: header - name: Content-Type - required: false + - description: '

The name of the policy document.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

' + in: query + name: PolicyName + required: true schema: - default: application/x-amz-json-1.0 - enum: - - application/x-amz-json-1.0 + maxLength: 128 + minLength: 1 + pattern: '[\w+=,.@-]+' + type: string + - description: >- +

The policy document.

You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character + ranging from the space character (\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)

  • The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)

+ in: query + name: PolicyDocument + required: true + schema: + maxLength: 131072 + minLength: 1 + pattern: '[\u0009\u000A\u000D\u0020-\u00FF]+' type: string - requestBody: - content: - application/x-amz-json-1.0: - schema: - $ref: '#/components/schemas/CreateServerCertificateRequest' - required: true responses: '200': + description: Success + '480': content: - application/json: + text/xml: schema: - $ref: '#/components/x-cloud-control-schemas/ProgressEvent' - description: Success - /?Action=CreateResource&Version=2021-09-30&__ServiceLinkedRole&__detailTransformed=true: + $ref: '#/components/schemas/LimitExceededException' + description: LimitExceededException + '481': + content: + text/xml: + schema: + $ref: '#/components/schemas/MalformedPolicyDocumentException' + description: MalformedPolicyDocumentException + '482': + content: + text/xml: + schema: + $ref: '#/components/schemas/NoSuchEntityException' + description: NoSuchEntityException + '483': + content: + text/xml: + schema: + $ref: '#/components/schemas/UnmodifiableEntityException' + description: UnmodifiableEntityException + '484': + content: + text/xml: + schema: + $ref: '#/components/schemas/ServiceFailureException' + description: ServiceFailureException + x-aws-operation-name: PutRolePolicy parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' @@ -4169,39 +7685,148 @@ paths: - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: - operationId: CreateServiceLinkedRole + description: >- +

Adds or updates an inline policy document that is embedded in the specified IAM role.

When you embed an inline policy in a role, the inline policy is used as part of the role's access (permissions) policy. The role's trust policy is created at the same time as the role, using CreateRole. You can update a role's trust policy using UpdateAssumeRolePolicy. For more information about IAM roles, see Using roles to delegate permissions and federate identities.

A role can also have a managed policy attached to it. To attach a managed policy to a role, use AttachRolePolicy. To create a new managed policy, use CreatePolicy. For information about policies, see Managed policies and inline + policies in the IAM User Guide.

For information about the maximum number of inline policies that you can embed with a role, see IAM and STS quotas in the IAM User Guide.

Because policy documents can be large, you should use POST rather than GET when calling PutRolePolicy. For general information about using the Query API with IAM, see Making query requests in the IAM User Guide.

 + operationId: POST_PutRolePolicy + parameters: [] + requestBody: + content: + text/xml: + schema: + $ref: '#/components/schemas/PutRolePolicyRequest' + responses: + '200': + description: Success + '480': + content: + text/xml: + schema: + $ref: '#/components/schemas/LimitExceededException' + description: LimitExceededException + '481': + content: + text/xml: + schema: + $ref: '#/components/schemas/MalformedPolicyDocumentException' + description: MalformedPolicyDocumentException + '482': + content: + text/xml: + schema: + $ref: '#/components/schemas/NoSuchEntityException' + description: NoSuchEntityException + '483': + content: + text/xml: + schema: + $ref: '#/components/schemas/UnmodifiableEntityException' + description: UnmodifiableEntityException + '484': + content: + text/xml: + schema: + $ref: '#/components/schemas/ServiceFailureException' + description: ServiceFailureException + x-aws-operation-name: PutRolePolicy + /?Action=PutUserPolicy&Version=2010-05-08&__nativeEndpoint=true: + servers: + - description: The general IAM multi-region endpoint + url: https://iam.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + get: + description: >- +

Adds or updates an inline policy document that is embedded in the specified IAM user.

An IAM user can also have a managed policy attached to it. To attach a managed policy to a user, use AttachUserPolicy. To create a new managed policy, use CreatePolicy. For information about policies, see Managed policies and inline policies in the IAM User Guide.

For + information about the maximum number of inline policies that you can embed in a user, see IAM and STS quotas in the IAM User Guide.

Because policy documents can be large, you should use POST rather than GET when calling PutUserPolicy. For general information about using the Query API with IAM, see Making query requests in the IAM User Guide.

 + operationId: GET_PutUserPolicy parameters: - - description: Action Header - in: header - name: X-Amz-Target - required: false + - description: '

The name of the user to associate the policy with.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

' + in: query + name: UserName + required: true schema: - default: CloudApiService.CreateResource - enum: - - CloudApiService.CreateResource + maxLength: 128 + minLength: 1 + pattern: '[\w+=,.@-]+' type: string - - in: header - name: Content-Type - required: false + - description: '

The name of the policy document.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

' + in: query + name: PolicyName + required: true schema: - default: application/x-amz-json-1.0 - enum: - - application/x-amz-json-1.0 + maxLength: 128 + minLength: 1 + pattern: '[\w+=,.@-]+' + type: string + - description: >- +

The policy document.

You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character + ranging from the space character (\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)

  • The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)

+ in: query + name: PolicyDocument + required: true + schema: + maxLength: 131072 + minLength: 1 + pattern: '[\u0009\u000A\u000D\u0020-\u00FF]+' type: string - requestBody: - content: - application/x-amz-json-1.0: - schema: - $ref: '#/components/schemas/CreateServiceLinkedRoleRequest' - required: true responses: '200': + description: Success + '480': content: - application/json: + text/xml: schema: - $ref: '#/components/x-cloud-control-schemas/ProgressEvent' - description: Success - /?Action=CreateResource&Version=2021-09-30&__User&__detailTransformed=true: + $ref: '#/components/schemas/LimitExceededException' + description: LimitExceededException + '481': + content: + text/xml: + schema: + $ref: '#/components/schemas/MalformedPolicyDocumentException' + description: MalformedPolicyDocumentException + '482': + content: + text/xml: + schema: + $ref: '#/components/schemas/NoSuchEntityException' + description: NoSuchEntityException + '483': + content: + text/xml: + schema: + $ref: '#/components/schemas/ServiceFailureException' + description: ServiceFailureException + x-aws-operation-name: PutUserPolicy parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' @@ -4211,39 +7836,130 @@ paths: - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: - operationId: CreateUser - parameters: - - description: Action Header - in: header - name: X-Amz-Target - required: false - schema: - default: CloudApiService.CreateResource - enum: - - CloudApiService.CreateResource - type: string - - in: header - name: Content-Type - required: false - schema: - default: application/x-amz-json-1.0 - enum: - - application/x-amz-json-1.0 - type: string + description: >- +

Adds or updates an inline policy document that is embedded in the specified IAM user.

An IAM user can also have a managed policy attached to it. To attach a managed policy to a user, use AttachUserPolicy. To create a new managed policy, use CreatePolicy. For information about policies, see Managed policies and inline policies in the IAM User Guide.

For + information about the maximum number of inline policies that you can embed in a user, see IAM and STS quotas in the IAM User Guide.

Because policy documents can be large, you should use POST rather than GET when calling PutUserPolicy. For general information about using the Query API with IAM, see Making query requests in the IAM User Guide.

 + operationId: POST_PutUserPolicy + parameters: [] requestBody: content: - application/x-amz-json-1.0: + text/xml: schema: - $ref: '#/components/schemas/CreateUserRequest' - required: true + $ref: '#/components/schemas/PutUserPolicyRequest' responses: '200': + description: Success + '480': content: - application/json: + text/xml: schema: - $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + $ref: '#/components/schemas/LimitExceededException' + description: LimitExceededException + '481': + content: + text/xml: + schema: + $ref: '#/components/schemas/MalformedPolicyDocumentException' + description: MalformedPolicyDocumentException + '482': + content: + text/xml: + schema: + $ref: '#/components/schemas/NoSuchEntityException' + description: NoSuchEntityException + '483': + content: + text/xml: + schema: + $ref: '#/components/schemas/ServiceFailureException' + description: ServiceFailureException + x-aws-operation-name: PutUserPolicy + /?Action=UntagPolicy&Version=2010-05-08&__nativeEndpoint=true: + servers: + - description: The general IAM multi-region endpoint + url: https://iam.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + get: + description: Removes the specified tags from the customer managed policy. For more information about tagging, see Tagging IAM resources in the IAM User Guide. + operationId: GET_UntagPolicy + parameters: + - description: '

The ARN of the IAM customer managed policy from which you want to remove tags.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

' + in: query + name: PolicyArn + required: true + schema: + description:

The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.

For more information about ARNs, go to Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

+ maxLength: 2048 + minLength: 20 + type: string + - description: A list of key names as a simple array of strings. The tags with matching keys are removed from the specified policy. + in: query + name: TagKeys + required: true + schema: + items: + allOf: + - $ref: '#/components/schemas/tagKeyType' + - xml: + name: member + maxItems: 50 + type: array + responses: + '200': description: Success - /?Action=CreateResource&Version=2021-09-30&__UserPolicy&__detailTransformed=true: + '480': + content: + text/xml: + schema: + $ref: '#/components/schemas/NoSuchEntityException' + description: NoSuchEntityException + '481': + content: + text/xml: + schema: + $ref: '#/components/schemas/InvalidInputException' + description: InvalidInputException + '482': + content: + text/xml: + schema: + $ref: '#/components/schemas/ConcurrentModificationException' + description: ConcurrentModificationException + '483': + content: + text/xml: + schema: + $ref: '#/components/schemas/ServiceFailureException' + description: ServiceFailureException + x-aws-operation-name: UntagPolicy parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' @@ -4253,39 +7969,137 @@ paths: - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: - operationId: CreateUserPolicy - parameters: - - description: Action Header - in: header - name: X-Amz-Target - required: false - schema: - default: CloudApiService.CreateResource - enum: - - CloudApiService.CreateResource - type: string - - in: header - name: Content-Type - required: false - schema: - default: application/x-amz-json-1.0 - enum: - - application/x-amz-json-1.0 - type: string + description: Removes the specified tags from the customer managed policy. For more information about tagging, see Tagging IAM resources in the IAM User Guide. + operationId: POST_UntagPolicy + parameters: [] requestBody: content: - application/x-amz-json-1.0: + text/xml: schema: - $ref: '#/components/schemas/CreateUserPolicyRequest' - required: true + $ref: '#/components/schemas/UntagPolicyRequest' responses: '200': + description: Success + '480': content: - application/json: + text/xml: schema: - $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + $ref: '#/components/schemas/NoSuchEntityException' + description: NoSuchEntityException + '481': + content: + text/xml: + schema: + $ref: '#/components/schemas/InvalidInputException' + description: InvalidInputException + '482': + content: + text/xml: + schema: + $ref: '#/components/schemas/ConcurrentModificationException' + description: ConcurrentModificationException + '483': + content: + text/xml: + schema: + $ref: '#/components/schemas/ServiceFailureException' + description: ServiceFailureException + x-aws-operation-name: UntagPolicy + /?Action=TagPolicy&Version=2010-05-08&__nativeEndpoint=true: + servers: + - description: The general IAM multi-region endpoint + url: https://iam.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + get: + description: >- +

Adds one or more tags to an IAM customer managed policy. If a tag with the same key name already exists, then that tag is overwritten with the new value.

A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:

  • Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and + the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.

  • Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM customer managed policy that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.

  • If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User + Guide.

  • Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.

 + operationId: GET_TagPolicy + parameters: + - description: '

The ARN of the IAM customer managed policy to which you want to add tags.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

' + in: query + name: PolicyArn + required: true + schema: + description:

The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.

For more information about ARNs, go to Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

+ maxLength: 2048 + minLength: 20 + type: string + - description: The list of tags that you want to attach to the IAM customer managed policy. Each tag consists of a key name and an associated value. + in: query + name: Tags + required: true + schema: + items: + allOf: + - $ref: '#/components/schemas/Tag' + - xml: + name: member + maxItems: 50 + type: array + responses: + '200': description: Success - /?Action=CreateResource&Version=2021-09-30&__VirtualMFADevice&__detailTransformed=true: + '480': + content: + text/xml: + schema: + $ref: '#/components/schemas/NoSuchEntityException' + description: NoSuchEntityException + '481': + content: + text/xml: + schema: + $ref: '#/components/schemas/LimitExceededException' + description: LimitExceededException + '482': + content: + text/xml: + schema: + $ref: '#/components/schemas/InvalidInputException' + description: InvalidInputException + '483': + content: + text/xml: + schema: + $ref: '#/components/schemas/ConcurrentModificationException' + description: ConcurrentModificationException + '484': + content: + text/xml: + schema: + $ref: '#/components/schemas/ServiceFailureException' + description: ServiceFailureException + x-aws-operation-name: TagPolicy parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' @@ -4295,38 +8109,52 @@ paths: - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: - operationId: CreateVirtualMFADevice - parameters: - - description: Action Header - in: header - name: X-Amz-Target - required: false - schema: - default: CloudApiService.CreateResource - enum: - - CloudApiService.CreateResource - type: string - - in: header - name: Content-Type - required: false - schema: - default: application/x-amz-json-1.0 - enum: - - application/x-amz-json-1.0 - type: string + description: >- +

Adds one or more tags to an IAM customer managed policy. If a tag with the same key name already exists, then that tag is overwritten with the new value.

A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:

  • Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and + the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.

  • Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM customer managed policy that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.

  • If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User + Guide.

  • Amazon Web Services always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.

 + operationId: POST_TagPolicy + parameters: [] requestBody: content: - application/x-amz-json-1.0: + text/xml: schema: - $ref: '#/components/schemas/CreateVirtualMFADeviceRequest' - required: true + $ref: '#/components/schemas/TagPolicyRequest' responses: '200': + description: Success + '480': content: - application/json: + text/xml: schema: - $ref: '#/components/x-cloud-control-schemas/ProgressEvent' - description: Success + $ref: '#/components/schemas/NoSuchEntityException' + description: NoSuchEntityException + '481': + content: + text/xml: + schema: + $ref: '#/components/schemas/LimitExceededException' + description: LimitExceededException + '482': + content: + text/xml: + schema: + $ref: '#/components/schemas/InvalidInputException' + description: InvalidInputException + '483': + content: + text/xml: + schema: + $ref: '#/components/schemas/ConcurrentModificationException' + description: ConcurrentModificationException + '484': + content: + text/xml: + schema: + $ref: '#/components/schemas/ServiceFailureException' + description: ServiceFailureException + x-aws-operation-name: TagPolicy x-stackQL-config: requestTranslate: algorithm: drop_double_underscore_params @@ -4337,3 +8165,5 @@ x-stackQL-config: responseToken: key: NextToken location: body + queryParamTranspose: + algorithm: AWSCanonical diff --git a/providers/src/aws/v00.00.00000/services/iam_api.yaml b/providers/src/aws/v00.00.00000/services/iam_api.yaml deleted file mode 100644 index 7b27bb4b..00000000 --- a/providers/src/aws/v00.00.00000/services/iam_api.yaml +++ /dev/null @@ -1,31632 +0,0 @@ -components: - parameters: - X-Amz-Algorithm: - in: header - name: X-Amz-Algorithm - required: false - schema: - type: string - X-Amz-Content-Sha256: - in: header - name: X-Amz-Content-Sha256 - required: false - schema: - type: string - X-Amz-Credential: - in: header - name: X-Amz-Credential - required: false - schema: - type: string - X-Amz-Date: - in: header - name: X-Amz-Date - required: false - schema: - type: string - X-Amz-Security-Token: - in: header - name: X-Amz-Security-Token - required: false - schema: - type: string - X-Amz-Signature: - in: header - name: X-Amz-Signature - required: false - schema: - type: string - X-Amz-SignedHeaders: - in: header - name: X-Amz-SignedHeaders - required: false - schema: - type: string - schemas: - AccessAdvisorUsageGranularityType: - enum: - - SERVICE_LEVEL - - ACTION_LEVEL - type: string - AccessDetail: - description:

An object that contains details about when a principal in the - reported Organizations entity last attempted to access an Amazon Web Services - service. A principal can be an IAM user, an IAM role, or the Amazon Web Services - account root user within the reported Organizations entity.

This data - type is a response element in the GetOrganizationsAccessReport operation.

- properties: - EntityPath: - allOf: - - $ref: '#/components/schemas/organizationsEntityPathType' - - description:

The path of the Organizations entity (root, organizational - unit, or account) from which an authenticated principal last attempted - to access the service. Amazon Web Services does not report unauthenticated - requests.

This field is null if no principals (IAM users, IAM - roles, or root users) in the reported Organizations entity attempted - to access the service within the reporting - period.

- LastAuthenticatedTime: - allOf: - - $ref: '#/components/schemas/dateType' - - description: "

The date and time, in\_ISO 8601 date-time format, when an authenticated principal most\ - \ recently attempted to access the service. Amazon Web Services does\ - \ not report unauthenticated requests.

This field is null if\ - \ no principals in the reported Organizations entity attempted to access\ - \ the service within the reporting period.

" - Region: - allOf: - - $ref: '#/components/schemas/stringType' - - description:

The Region where the last service access attempt occurred.

-

This field is null if no principals in the reported Organizations - entity attempted to access the service within the reporting - period.

- ServiceName: - allOf: - - $ref: '#/components/schemas/serviceNameType' - - description: The name of the service in which access was attempted. - ServiceNamespace: - allOf: - - $ref: '#/components/schemas/serviceNamespaceType' - - description: "

The namespace of the service in which access was attempted.

\ - \

To learn the service namespace of a service, see Actions, resources, and condition keys for Amazon Web Services services\ - \ in the Service Authorization Reference. Choose the name of\ - \ the service to view details for that service. In the first paragraph,\ - \ find the service prefix. For example, (service prefix: a4b).\ - \ For more information about service namespaces, see Amazon Web Services service namespaces in the\_Amazon Web Services\ - \ General Reference.

" - TotalAuthenticatedEntities: - allOf: - - $ref: '#/components/schemas/integerType' - - description: The number of accounts with authenticated principals (root - users, IAM users, and IAM roles) that attempted to access the service - in the reporting period. - required: - - ServiceName - - ServiceNamespace - type: object - AccessDetails: - items: - allOf: - - $ref: '#/components/schemas/AccessDetail' - - xml: - name: member - type: array - AccessKey: - description:

Contains information about an Amazon Web Services access key.

-

This data type is used as a response element in the CreateAccessKey - and ListAccessKeys operations.

The SecretAccessKey - value is returned only in response to CreateAccessKey. You can get - a secret access key only when you first create an access key; you cannot recover - the secret access key later. If you lose a secret access key, you must create - a new access key.

 - properties: - AccessKeyId: - allOf: - - $ref: '#/components/schemas/accessKeyIdType' - - description: The ID for this access key. - CreateDate: - allOf: - - $ref: '#/components/schemas/dateType' - - description: The date when the access key was created. - SecretAccessKey: - allOf: - - $ref: '#/components/schemas/accessKeySecretType' - - description: The secret key used to sign requests. - Status: - allOf: - - $ref: '#/components/schemas/statusType' - - description: 'The status of the access key. Active means - that the key is valid for API calls, while Inactive means - it is not. ' - UserName: - allOf: - - $ref: '#/components/schemas/userNameType' - - description: The name of the IAM user that the access key is associated - with. - required: - - UserName - - AccessKeyId - - Status - - SecretAccessKey - type: object - AccessKeyLastUsed: - description:

Contains information about the last time an Amazon Web Services - access key was used since IAM began tracking this information on April 22, - 2015.

This data type is used as a response element in the GetAccessKeyLastUsed - operation.

- properties: - LastUsedDate: - allOf: - - $ref: '#/components/schemas/dateType' - - description:

The date and time, in ISO - 8601 date-time format, when the access key was most recently used. - This field is null in the following situations:

  • The - user does not have an access key.

  • An access key exists - but has not been used since IAM began tracking this information.

    -

  • There is no sign-in data associated with the user.

    -
- Region: - allOf: - - $ref: '#/components/schemas/stringType' - - description:

The Amazon Web Services Region where this access key was - most recently used. The value for this field is "N/A" in the following - situations:

  • The user does not have an access key.

    -

  • An access key exists but has not been used since IAM began - tracking this information.

  • There is no sign-in data - associated with the user.

For more information about - Amazon Web Services Regions, see Regions - and endpoints in the Amazon Web Services General Reference.

- ServiceName: - allOf: - - $ref: '#/components/schemas/stringType' - - description:

The name of the Amazon Web Services service with which - this access key was most recently used. The value of this field is "N/A" - in the following situations:

  • The user does not have - an access key.

  • An access key exists but has not been - used since IAM started tracking this information.

  • There - is no sign-in data associated with the user.

- required: - - LastUsedDate - - ServiceName - - Region - type: object - AccessKeyMetadata: - description:

Contains information about an Amazon Web Services access key, - without its secret key.

This data type is used as a response element - in the ListAccessKeys operation.

- properties: - AccessKeyId: - allOf: - - $ref: '#/components/schemas/accessKeyIdType' - - description: The ID for this access key. - CreateDate: - allOf: - - $ref: '#/components/schemas/dateType' - - description: The date when the access key was created. - Status: - allOf: - - $ref: '#/components/schemas/statusType' - - description: The status of the access key. Active means that - the key is valid for API calls; Inactive means it is not. - UserName: - allOf: - - $ref: '#/components/schemas/userNameType' - - description: The name of the IAM user that the key is associated with. - type: object - ActionNameListType: - items: - allOf: - - $ref: '#/components/schemas/ActionNameType' - - xml: - name: member - type: array - ActionNameType: - maxLength: 128 - minLength: 3 - type: string - AddClientIDToOpenIDConnectProviderRequest: - properties: - ClientID: - allOf: - - $ref: '#/components/schemas/clientIDType' - - description: The client ID (also known as audience) to add to the IAM - OpenID Connect provider resource. - OpenIDConnectProviderArn: - allOf: - - $ref: '#/components/schemas/arnType' - - description: The Amazon Resource Name (ARN) of the IAM OpenID Connect - (OIDC) provider resource to add the client ID to. You can get a list - of OIDC provider ARNs by using the ListOpenIDConnectProviders - operation. - required: - - OpenIDConnectProviderArn - - ClientID - title: AddClientIDToOpenIDConnectProviderRequest - type: object - AddRoleToInstanceProfileRequest: - properties: - InstanceProfileName: - allOf: - - $ref: '#/components/schemas/instanceProfileNameType' - - description: '

The name of the instance profile to update.

This - parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - RoleName: - allOf: - - $ref: '#/components/schemas/roleNameType' - - description: '

The name of the role to add.

This parameter allows - (through its regex pattern) - a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following - characters: _+=,.@-

' - required: - - InstanceProfileName - - RoleName - title: AddRoleToInstanceProfileRequest - type: object - AddUserToGroupRequest: - properties: - GroupName: - allOf: - - $ref: '#/components/schemas/groupNameType' - - description: '

The name of the group to update.

This parameter - allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - UserName: - allOf: - - $ref: '#/components/schemas/existingUserNameType' - - description: '

The name of the user to add.

This parameter allows - (through its regex pattern) - a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following - characters: _+=,.@-

' - required: - - GroupName - - UserName - title: AddUserToGroupRequest - type: object - ArnListType: - items: - allOf: - - $ref: '#/components/schemas/arnType' - - xml: - name: member - type: array - AttachGroupPolicyRequest: - properties: - GroupName: - allOf: - - $ref: '#/components/schemas/groupNameType' - - description: '

The name (friendly name, not ARN) of the group to attach - the policy to.

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - PolicyArn: - allOf: - - $ref: '#/components/schemas/arnType' - - description:

The Amazon Resource Name (ARN) of the IAM policy you want - to attach.

For more information about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.

- required: - - GroupName - - PolicyArn - title: AttachGroupPolicyRequest - type: object - AttachRolePolicyRequest: - properties: - PolicyArn: - allOf: - - $ref: '#/components/schemas/arnType' - - description:

The Amazon Resource Name (ARN) of the IAM policy you want - to attach.

For more information about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.

- RoleName: - allOf: - - $ref: '#/components/schemas/roleNameType' - - description: '

The name (friendly name, not ARN) of the role to attach - the policy to.

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - required: - - RoleName - - PolicyArn - title: AttachRolePolicyRequest - type: object - AttachUserPolicyRequest: - properties: - PolicyArn: - allOf: - - $ref: '#/components/schemas/arnType' - - description:

The Amazon Resource Name (ARN) of the IAM policy you want - to attach.

For more information about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.

- UserName: - allOf: - - $ref: '#/components/schemas/userNameType' - - description: '

The name (friendly name, not ARN) of the IAM user to - attach the policy to.

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - required: - - UserName - - PolicyArn - title: AttachUserPolicyRequest - type: object - AttachedPermissionsBoundary: - description:

Contains information about an attached permissions boundary.

-

An attached permissions boundary is a managed policy that has been attached - to a user or role to set the permissions boundary.

For more information - about permissions boundaries, see Permissions - boundaries for IAM identities in the IAM User Guide.

- properties: - PermissionsBoundaryArn: - allOf: - - $ref: '#/components/schemas/arnType' - - description: ' The ARN of the policy used to set the permissions boundary - for the user or role.' - PermissionsBoundaryType: - allOf: - - $ref: '#/components/schemas/PermissionsBoundaryAttachmentType' - - description: ' The permissions boundary usage type that indicates what - type of IAM resource is used as the permissions boundary for an entity. - This data type can only have a value of Policy.' - type: object - AttachedPolicy: - description:

Contains information about an attached policy.

An attached - policy is a managed policy that has been attached to a user, group, or role. - This data type is used as a response element in the ListAttachedGroupPolicies, - ListAttachedRolePolicies, ListAttachedUserPolicies, and GetAccountAuthorizationDetails - operations.

For more information about managed policies, refer to - Managed - policies and inline policies in the IAM User Guide.

- properties: - PolicyArn: - $ref: '#/components/schemas/arnType' - PolicyName: - allOf: - - $ref: '#/components/schemas/policyNameType' - - description: The friendly name of the attached policy. - type: object - BootstrapDatum: - format: password - type: string - ChangePasswordRequest: - properties: - NewPassword: - allOf: - - $ref: '#/components/schemas/passwordType' - - description:

The new password. The new password must conform to the - Amazon Web Services account's password policy, if one exists.

The - regex pattern that is - used to validate this parameter is a string of characters. That string - can include almost any printable ASCII character from the space (\u0020) - through the end of the ASCII character range (\u00FF). - You can also include the tab (\u0009), line feed (\u000A), - and carriage return (\u000D) characters. Any of these characters - are valid in a password. However, many tools, such as the Amazon Web - Services Management Console, might restrict the ability to type certain - characters because they have special meaning within that tool.

- OldPassword: - allOf: - - $ref: '#/components/schemas/passwordType' - - description: The IAM user's current password. - required: - - OldPassword - - NewPassword - title: ChangePasswordRequest - type: object - ColumnNumber: - type: integer - ConcurrentModificationException: {} - ContextEntry: - description:

Contains information about a condition context key. It includes - the name of the key and specifies the value (or values, if the context key - supports multiple values) to use in the simulation. This information is used - when evaluating the Condition elements of the input policies.

-

This data type is used as an input parameter to SimulateCustomPolicy - and SimulatePrincipalPolicy.

- properties: - ContextKeyName: - allOf: - - $ref: '#/components/schemas/ContextKeyNameType' - - description: The full name of a condition context key, including the service - prefix. For example, aws:SourceIp or s3:VersionId. - ContextKeyType: - allOf: - - $ref: '#/components/schemas/ContextKeyTypeEnum' - - description: The data type of the value (or values) specified in the ContextKeyValues - parameter. - ContextKeyValues: - allOf: - - $ref: '#/components/schemas/ContextKeyValueListType' - - description: The value (or values, if the condition context key supports - multiple values) to provide to the simulation when the key is referenced - by a Condition element in an input policy. - type: object - ContextEntryListType: - items: - allOf: - - $ref: '#/components/schemas/ContextEntry' - - xml: - name: member - type: array - ContextKeyNameType: - maxLength: 256 - minLength: 5 - type: string - ContextKeyNamesResultListType: - items: - allOf: - - $ref: '#/components/schemas/ContextKeyNameType' - - xml: - name: member - type: array - ContextKeyTypeEnum: - enum: - - string - - stringList - - numeric - - numericList - - boolean - - booleanList - - ip - - ipList - - binary - - binaryList - - date - - dateList - type: string - ContextKeyValueListType: - items: - allOf: - - $ref: '#/components/schemas/ContextKeyValueType' - - xml: - name: member - type: array - ContextKeyValueType: - type: string - CreateAccessKeyRequest: - properties: - UserName: - allOf: - - $ref: '#/components/schemas/existingUserNameType' - - description: '

The name of the IAM user that the new key will belong - to.

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - title: CreateAccessKeyRequest - type: object - CreateAccessKeyResponse: - description: 'Contains the response to a successful CreateAccessKey request. ' - example: - AccessKey: - AccessKeyId: AKIAIOSFODNN7EXAMPLE - CreateDate: '2015-03-09T18:39:23.411Z' - SecretAccessKey: wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY - Status: Active - UserName: Bob - properties: - AccessKey: - allOf: - - $ref: '#/components/schemas/AccessKey' - - description: A structure with details about the access key. - required: - - AccessKey - type: object - CreateAccountAliasRequest: - properties: - AccountAlias: - allOf: - - $ref: '#/components/schemas/accountAliasType' - - description:

The account alias to create.

This parameter allows - (through its regex pattern) - a string of characters consisting of lowercase letters, digits, and - dashes. You cannot start or finish with a dash, nor can you have two - dashes in a row.

- required: - - AccountAlias - title: CreateAccountAliasRequest - type: object - CreateGroupRequest: - properties: - GroupName: - allOf: - - $ref: '#/components/schemas/groupNameType' - - description:

The name of the group to create. Do not include the path - in this value.

IAM user, group, role, and policy names must be - unique within the account. Names are not distinguished by case. For - example, you cannot create resources named both "MyResource" and "myresource".

- Path: - allOf: - - $ref: '#/components/schemas/pathType' - - description:

The path to the group. For more information about paths, - see IAM - identifiers in the IAM User Guide.

This parameter - is optional. If it is not included, it defaults to a slash (/).

-

This parameter allows (through its regex - pattern) a string of characters consisting of either a forward slash - (/) by itself or a string that must begin and end with forward slashes. - In addition, it can contain any ASCII character from the ! (\u0021) - through the DEL character (\u007F), including most punctuation - characters, digits, and upper and lowercased letters.

- required: - - GroupName - title: CreateGroupRequest - type: object - CreateGroupResponse: - description: 'Contains the response to a successful CreateGroup request. ' - example: - Group: - Arn: arn:aws:iam::123456789012:group/Admins - CreateDate: '2015-03-09T20:30:24.940Z' - GroupId: AIDGPMS9RO4H3FEXAMPLE - GroupName: Admins - Path: / - properties: - Group: - allOf: - - $ref: '#/components/schemas/Group' - - description: A structure containing details about the new group. - required: - - Group - type: object - CreateInstanceProfileRequest: - properties: - InstanceProfileName: - allOf: - - $ref: '#/components/schemas/instanceProfileNameType' - - description: '

The name of the instance profile to create.

This - parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - Path: - allOf: - - $ref: '#/components/schemas/pathType' - - description:

The path to the instance profile. For more information - about paths, see IAM - Identifiers in the IAM User Guide.

This parameter - is optional. If it is not included, it defaults to a slash (/).

-

This parameter allows (through its regex - pattern) a string of characters consisting of either a forward slash - (/) by itself or a string that must begin and end with forward slashes. - In addition, it can contain any ASCII character from the ! (\u0021) - through the DEL character (\u007F), including most punctuation - characters, digits, and upper and lowercased letters.

- Tags: - allOf: - - $ref: '#/components/schemas/tagListType' - - description:

A list of tags that you want to attach to the newly created - IAM instance profile. Each tag consists of a key name and an associated - value. For more information about tagging, see Tagging - IAM resources in the IAM User Guide.

If any - one of the tags is invalid or if you exceed the allowed maximum number - of tags, then the entire request fails and the resource is not created.

- - required: - - InstanceProfileName - title: CreateInstanceProfileRequest - type: object - CreateInstanceProfileResponse: - description: 'Contains the response to a successful CreateInstanceProfile - request. ' - example: - InstanceProfile: - Arn: arn:aws:iam::123456789012:instance-profile/Webserver - CreateDate: '2015-03-09T20:33:19.626Z' - InstanceProfileId: AIPAJMBYC7DLSPEXAMPLE - InstanceProfileName: Webserver - Path: / - Roles: [] - properties: - InstanceProfile: - allOf: - - $ref: '#/components/schemas/InstanceProfile' - - description: A structure containing details about the new instance profile. - required: - - InstanceProfile - type: object - CreateLoginProfileRequest: - properties: - Password: - allOf: - - $ref: '#/components/schemas/passwordType' - - description:

The new password for the user.

The regex - pattern that is used to validate this parameter is a string of characters. - That string can include almost any printable ASCII character from the - space (\u0020) through the end of the ASCII character range - (\u00FF). You can also include the tab (\u0009), - line feed (\u000A), and carriage return (\u000D) - characters. Any of these characters are valid in a password. However, - many tools, such as the Amazon Web Services Management Console, might - restrict the ability to type certain characters because they have special - meaning within that tool.

- PasswordResetRequired: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: Specifies whether the user is required to set a new password - on next sign-in. - UserName: - allOf: - - $ref: '#/components/schemas/userNameType' - - description: '

The name of the IAM user to create a password for. The - user must already exist.

This parameter allows (through its regex pattern) a string of - characters consisting of upper and lowercase alphanumeric characters - with no spaces. You can also include any of the following characters: - _+=,.@-

' - required: - - UserName - - Password - title: CreateLoginProfileRequest - type: object - CreateLoginProfileResponse: - description: 'Contains the response to a successful CreateLoginProfile - request. ' - example: - LoginProfile: - CreateDate: '2015-03-10T20:55:40.274Z' - PasswordResetRequired: true - UserName: Bob - properties: - LoginProfile: - allOf: - - $ref: '#/components/schemas/LoginProfile' - - description: A structure containing the user name and password create - date. - required: - - LoginProfile - type: object - CreateOpenIDConnectProviderRequest: - properties: - ClientIDList: - allOf: - - $ref: '#/components/schemas/clientIDListType' - - description:

Provides a list of client IDs, also known as audiences. - When a mobile or web app registers with an OpenID Connect provider, - they establish a value that identifies the application. This is the - value that's sent as the client_id parameter on OAuth requests.

-

You can register multiple client IDs with the same provider. For - example, you might have multiple applications that use the same OIDC - provider. You cannot register more than 100 client IDs with a single - IAM OIDC provider.

There is no defined format for a client ID. - The CreateOpenIDConnectProviderRequest operation accepts - client IDs up to 255 characters long.

- Tags: - allOf: - - $ref: '#/components/schemas/tagListType' - - description:

A list of tags that you want to attach to the new IAM - OpenID Connect (OIDC) provider. Each tag consists of a key name and - an associated value. For more information about tagging, see Tagging - IAM resources in the IAM User Guide.

If any - one of the tags is invalid or if you exceed the allowed maximum number - of tags, then the entire request fails and the resource is not created.

- - ThumbprintList: - allOf: - - $ref: '#/components/schemas/thumbprintListType' - - description:

A list of server certificate thumbprints for the OpenID - Connect (OIDC) identity provider's server certificates. Typically this - list includes only one entry. However, IAM lets you have up to five - thumbprints for an OIDC provider. This lets you maintain multiple thumbprints - if the identity provider is rotating certificates.

The server - certificate thumbprint is the hex-encoded SHA-1 hash value of the X.509 - certificate used by the domain where the OpenID Connect provider makes - its keys available. It is always a 40-character string.

You must - provide at least one thumbprint when creating an IAM OIDC provider. - For example, assume that the OIDC provider is server.example.com - and the provider stores its keys at https://keys.server.example.com/openid-connect. - In that case, the thumbprint string would be the hex-encoded SHA-1 hash - value of the certificate used by https://keys.server.example.com. -

For more information about obtaining the OIDC provider thumbprint, - see Obtaining - the thumbprint for an OpenID Connect provider in the IAM User - Guide.

- Url: - allOf: - - $ref: '#/components/schemas/OpenIDConnectProviderUrlType' - - description:

The URL of the identity provider. The URL must begin with - https:// and should correspond to the iss - claim in the provider's OpenID Connect ID tokens. Per the OIDC standard, - path components are allowed but query parameters are not. Typically - the URL consists of only a hostname, like https://server.example.org - or https://example.com. The URL should not contain a port - number.

You cannot register the same provider multiple times - in a single Amazon Web Services account. If you try to submit a URL - that has already been used for an OpenID Connect provider in the Amazon - Web Services account, you will get an error.

- required: - - Url - - ThumbprintList - title: CreateOpenIDConnectProviderRequest - type: object - CreateOpenIDConnectProviderResponse: - description: 'Contains the response to a successful CreateOpenIDConnectProvider - request. ' - example: - OpenIDConnectProviderArn: arn:aws:iam::123456789012:oidc-provider/server.example.com - properties: - OpenIDConnectProviderArn: - allOf: - - $ref: '#/components/schemas/arnType' - - description: 'The Amazon Resource Name (ARN) of the new IAM OpenID Connect - provider that is created. For more information, see OpenIDConnectProviderListEntry. ' - Tags: - allOf: - - $ref: '#/components/schemas/tagListType' - - description: A list of tags that are attached to the new IAM OIDC provider. - The returned list of tags is sorted by tag key. For more information - about tagging, see Tagging - IAM resources in the IAM User Guide. - type: object - CreatePolicyRequest: - properties: - Description: - allOf: - - $ref: '#/components/schemas/policyDescriptionType' - - description:

A friendly description of the policy.

Typically - used to store information about the permissions defined in the policy. - For example, "Grants access to production DynamoDB tables."

The - policy description is immutable. After a value is assigned, it cannot - be changed.

- Path: - allOf: - - $ref: '#/components/schemas/policyPathType' - - description:

The path for the policy.

For more information about - paths, see IAM - identifiers in the IAM User Guide.

This parameter - is optional. If it is not included, it defaults to a slash (/).

-

This parameter allows (through its regex - pattern) a string of characters consisting of either a forward slash - (/) by itself or a string that must begin and end with forward slashes. - In addition, it can contain any ASCII character from the ! (\u0021) - through the DEL character (\u007F), including most punctuation - characters, digits, and upper and lowercased letters.

You - cannot use an asterisk (*) in the path name.

 - PolicyDocument: - allOf: - - $ref: '#/components/schemas/policyDocumentType' - - description:

The JSON policy document that you want to use as the content - for the new policy.

You must provide policies in JSON format - in IAM. However, for CloudFormation templates formatted in YAML, you - can provide the policy in JSON or YAML format. CloudFormation always - converts a YAML policy to JSON format before submitting it to IAM.

-

The maximum length of the policy document that you can pass in this - operation, including whitespace, is listed below. To view the maximum - character counts of a managed policy with no whitespaces, see IAM - and STS character quotas.

To learn more about JSON policy - grammar, see Grammar - of the IAM JSON policy language in the IAM User Guide.

-

The regex pattern used - to validate this parameter is a string of characters consisting of the - following:

  • Any printable ASCII character ranging from - the space character (\u0020) through the end of the ASCII - character range

  • The printable characters in the Basic - Latin and Latin-1 Supplement character set (through \u00FF)

    -

  • The special characters tab (\u0009), line - feed (\u000A), and carriage return (\u000D)

    -
- PolicyName: - allOf: - - $ref: '#/components/schemas/policyNameType' - - description:

The friendly name of the policy.

IAM user, group, - role, and policy names must be unique within the account. Names are - not distinguished by case. For example, you cannot create resources - named both "MyResource" and "myresource".

- Tags: - allOf: - - $ref: '#/components/schemas/tagListType' - - description:

A list of tags that you want to attach to the new IAM - customer managed policy. Each tag consists of a key name and an associated - value. For more information about tagging, see Tagging - IAM resources in the IAM User Guide.

If any - one of the tags is invalid or if you exceed the allowed maximum number - of tags, then the entire request fails and the resource is not created.

- - required: - - PolicyName - - PolicyDocument - title: CreatePolicyRequest - type: object - CreatePolicyResponse: - description: 'Contains the response to a successful CreatePolicy request. ' - properties: - Policy: - allOf: - - $ref: '#/components/schemas/Policy' - - description: A structure containing details about the new policy. - type: object - CreatePolicyVersionRequest: - properties: - PolicyArn: - allOf: - - $ref: '#/components/schemas/arnType' - - description:

The Amazon Resource Name (ARN) of the IAM policy to which - you want to add a new version.

For more information about ARNs, - see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.

- PolicyDocument: - allOf: - - $ref: '#/components/schemas/policyDocumentType' - - description:

The JSON policy document that you want to use as the content - for this new version of the policy.

You must provide policies - in JSON format in IAM. However, for CloudFormation templates formatted - in YAML, you can provide the policy in JSON or YAML format. CloudFormation - always converts a YAML policy to JSON format before submitting it to - IAM.

The maximum length of the policy document that you can pass - in this operation, including whitespace, is listed below. To view the - maximum character counts of a managed policy with no whitespaces, see - IAM - and STS character quotas.

The regex - pattern used to validate this parameter is a string of characters - consisting of the following:

  • Any printable ASCII character - ranging from the space character (\u0020) through the end - of the ASCII character range

  • The printable characters - in the Basic Latin and Latin-1 Supplement character set (through \u00FF)

    -

  • The special characters tab (\u0009), line - feed (\u000A), and carriage return (\u000D)

    -
- SetAsDefault: - allOf: - - $ref: '#/components/schemas/booleanType' - - description:

Specifies whether to set this version as the policy's - default version.

When this parameter is true, the - new policy version becomes the operative version. That is, it becomes - the version that is in effect for the IAM users, groups, and roles that - the policy is attached to.

For more information about managed - policy versions, see Versioning - for managed policies in the IAM User Guide.

- required: - - PolicyArn - - PolicyDocument - title: CreatePolicyVersionRequest - type: object - CreatePolicyVersionResponse: - description: 'Contains the response to a successful CreatePolicyVersion - request. ' - properties: - PolicyVersion: - allOf: - - $ref: '#/components/schemas/PolicyVersion' - - description: A structure containing details about the new policy version. - type: object - CreateRoleRequest: - properties: - AssumeRolePolicyDocument: - allOf: - - $ref: '#/components/schemas/policyDocumentType' - - description:

The trust relationship policy document that grants an - entity permission to assume the role.

In IAM, you must provide - a JSON policy that has been converted to a string. However, for CloudFormation - templates formatted in YAML, you can provide the policy in JSON or YAML - format. CloudFormation always converts a YAML policy to JSON format - before submitting it to IAM.

The regex - pattern used to validate this parameter is a string of characters - consisting of the following:

  • Any printable ASCII character - ranging from the space character (\u0020) through the end - of the ASCII character range

  • The printable characters - in the Basic Latin and Latin-1 Supplement character set (through \u00FF)

    -

  • The special characters tab (\u0009), line - feed (\u000A), and carriage return (\u000D)

    -

Upon success, the response includes the same trust policy - in JSON format.

- Description: - allOf: - - $ref: '#/components/schemas/roleDescriptionType' - - description: A description of the role. - MaxSessionDuration: - allOf: - - $ref: '#/components/schemas/roleMaxSessionDurationType' - - description:

The maximum session duration (in seconds) that you want - to set for the specified role. If you do not specify a value for this - setting, the default maximum of one hour is applied. This setting can - have a value from 1 hour to 12 hours.

Anyone who assumes the - role from the or API can use the DurationSeconds API parameter - or the duration-seconds CLI parameter to request a longer - session. The MaxSessionDuration setting determines the - maximum duration that can be requested using the DurationSeconds - parameter. If users don't specify a value for the DurationSeconds - parameter, their security credentials are valid for one hour by default. - This applies when you use the AssumeRole* API operations - or the assume-role* CLI operations but does not apply when - you use those operations to create a console URL. For more information, - see Using - IAM roles in the IAM User Guide.

- Path: - allOf: - - $ref: '#/components/schemas/pathType' - - description:

The path to the role. For more information about paths, - see IAM - Identifiers in the IAM User Guide.

This parameter - is optional. If it is not included, it defaults to a slash (/).

-

This parameter allows (through its regex - pattern) a string of characters consisting of either a forward slash - (/) by itself or a string that must begin and end with forward slashes. - In addition, it can contain any ASCII character from the ! (\u0021) - through the DEL character (\u007F), including most punctuation - characters, digits, and upper and lowercased letters.

- PermissionsBoundary: - allOf: - - $ref: '#/components/schemas/arnType' - - description: The ARN of the policy that is used to set the permissions - boundary for the role. - RoleName: - allOf: - - $ref: '#/components/schemas/roleNameType' - - description:

The name of the role to create.

IAM user, group, - role, and policy names must be unique within the account. Names are - not distinguished by case. For example, you cannot create resources - named both "MyResource" and "myresource".

- Tags: - allOf: - - $ref: '#/components/schemas/tagListType' - - description:

A list of tags that you want to attach to the new role. - Each tag consists of a key name and an associated value. For more information - about tagging, see Tagging - IAM resources in the IAM User Guide.

If any - one of the tags is invalid or if you exceed the allowed maximum number - of tags, then the entire request fails and the resource is not created.

- - required: - - RoleName - - AssumeRolePolicyDocument - title: CreateRoleRequest - type: object - CreateRoleResponse: - description: 'Contains the response to a successful CreateRole request. ' - example: - Role: - Arn: arn:aws:iam::123456789012:role/Test-Role - AssumeRolePolicyDocument: - CreateDate: '2013-06-07T20:43:32.821Z' - Path: / - RoleId: AKIAIOSFODNN7EXAMPLE - RoleName: Test-Role - properties: - Role: - allOf: - - $ref: '#/components/schemas/Role' - - description: A structure containing details about the new role. - required: - - Role - type: object - CreateSAMLProviderRequest: - properties: - Name: - allOf: - - $ref: '#/components/schemas/SAMLProviderNameType' - - description: '

The name of the provider to create.

This parameter - allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - SAMLMetadataDocument: - allOf: - - $ref: '#/components/schemas/SAMLMetadataDocumentType' - - description:

An XML document generated by an identity provider (IdP) - that supports SAML 2.0. The document includes the issuer's name, expiration - information, and keys that can be used to validate the SAML authentication - response (assertions) that are received from the IdP. You must generate - the metadata document using the identity management software that is - used as your organization's IdP.

For more information, see About - SAML 2.0-based federation in the IAM User Guide

- Tags: - allOf: - - $ref: '#/components/schemas/tagListType' - - description:

A list of tags that you want to attach to the new IAM - SAML provider. Each tag consists of a key name and an associated value. - For more information about tagging, see Tagging - IAM resources in the IAM User Guide.

If any - one of the tags is invalid or if you exceed the allowed maximum number - of tags, then the entire request fails and the resource is not created.

- - required: - - SAMLMetadataDocument - - Name - title: CreateSAMLProviderRequest - type: object - CreateSAMLProviderResponse: - description: 'Contains the response to a successful CreateSAMLProvider - request. ' - properties: - SAMLProviderArn: - allOf: - - $ref: '#/components/schemas/arnType' - - description: The Amazon Resource Name (ARN) of the new SAML provider resource - in IAM. - Tags: - allOf: - - $ref: '#/components/schemas/tagListType' - - description: A list of tags that are attached to the new IAM SAML provider. - The returned list of tags is sorted by tag key. For more information - about tagging, see Tagging - IAM resources in the IAM User Guide. - type: object - CreateServiceLinkedRoleRequest: - properties: - AWSServiceName: - allOf: - - $ref: '#/components/schemas/groupNameType' - - description: '

The service principal for the Amazon Web Services service - to which this role is attached. You use a string similar to a URL but - without the http:// in front. For example: elasticbeanstalk.amazonaws.com. -

Service principals are unique and case-sensitive. To find the - exact service principal for your service-linked role, see Amazon - Web Services services that work with IAM in the IAM User Guide. - Look for the services that have Yes in the Service-Linked - Role column. Choose the Yes link to view the service-linked - role documentation for that service.

' - CustomSuffix: - allOf: - - $ref: '#/components/schemas/customSuffixType' - - description:

A string that you provide, which is combined with - the service-provided prefix to form the complete role name. If you make - multiple requests for the same service, then you must supply a different - CustomSuffix for each request. Otherwise the request fails - with a duplicate role name error. For example, you could add -1 - or -debug to the suffix.

Some services do not support - the CustomSuffix parameter. If you provide an optional - suffix and the operation fails, try the operation again without the - suffix.

- Description: - allOf: - - $ref: '#/components/schemas/roleDescriptionType' - - description: The description of the role. - required: - - AWSServiceName - title: CreateServiceLinkedRoleRequest - type: object - CreateServiceLinkedRoleResponse: - properties: - Role: - allOf: - - $ref: '#/components/schemas/Role' - - description: A Role object that contains details about the newly - created role. - type: object - CreateServiceSpecificCredentialRequest: - properties: - ServiceName: - allOf: - - $ref: '#/components/schemas/serviceName' - - description: The name of the Amazon Web Services service that is to be - associated with the credentials. The service you specify here is the - only service that can be accessed using these credentials. - UserName: - allOf: - - $ref: '#/components/schemas/userNameType' - - description: '

The name of the IAM user that is to be associated with - the credentials. The new service-specific credentials have the same - permissions as the associated user except that they can be used only - to access the specified service.

This parameter allows (through - its regex pattern) a string - of characters consisting of upper and lowercase alphanumeric characters - with no spaces. You can also include any of the following characters: - _+=,.@-

' - required: - - UserName - - ServiceName - title: CreateServiceSpecificCredentialRequest - type: object - CreateServiceSpecificCredentialResponse: - properties: - ServiceSpecificCredential: - allOf: - - $ref: '#/components/schemas/ServiceSpecificCredential' - - description:

A structure that contains information about the newly - created service-specific credential.

This is the - only time that the password for this credential set is available. It - cannot be recovered later. Instead, you must reset the password with - ResetServiceSpecificCredential.

 - type: object - CreateUserRequest: - properties: - Path: - allOf: - - $ref: '#/components/schemas/pathType' - - description:

The path for the user name. For more information about - paths, see IAM - identifiers in the IAM User Guide.

This parameter - is optional. If it is not included, it defaults to a slash (/).

-

This parameter allows (through its regex - pattern) a string of characters consisting of either a forward slash - (/) by itself or a string that must begin and end with forward slashes. - In addition, it can contain any ASCII character from the ! (\u0021) - through the DEL character (\u007F), including most punctuation - characters, digits, and upper and lowercased letters.

- PermissionsBoundary: - allOf: - - $ref: '#/components/schemas/arnType' - - description: The ARN of the policy that is used to set the permissions - boundary for the user. - Tags: - allOf: - - $ref: '#/components/schemas/tagListType' - - description:

A list of tags that you want to attach to the new user. - Each tag consists of a key name and an associated value. For more information - about tagging, see Tagging - IAM resources in the IAM User Guide.

If any - one of the tags is invalid or if you exceed the allowed maximum number - of tags, then the entire request fails and the resource is not created.

- - UserName: - allOf: - - $ref: '#/components/schemas/userNameType' - - description:

The name of the user to create.

IAM user, group, - role, and policy names must be unique within the account. Names are - not distinguished by case. For example, you cannot create resources - named both "MyResource" and "myresource".

- required: - - UserName - title: CreateUserRequest - type: object - CreateUserResponse: - description: 'Contains the response to a successful CreateUser request. ' - example: - User: - Arn: arn:aws:iam::123456789012:user/Bob - CreateDate: '2013-06-08T03:20:41.270Z' - Path: / - UserId: AKIAIOSFODNN7EXAMPLE - UserName: Bob - properties: - User: - allOf: - - $ref: '#/components/schemas/User' - - description: A structure with details about the new IAM user. - type: object - CreateVirtualMFADeviceRequest: - properties: - Path: - allOf: - - $ref: '#/components/schemas/pathType' - - description:

The path for the virtual MFA device. For more information - about paths, see IAM - identifiers in the IAM User Guide.

This parameter - is optional. If it is not included, it defaults to a slash (/).

-

This parameter allows (through its regex - pattern) a string of characters consisting of either a forward slash - (/) by itself or a string that must begin and end with forward slashes. - In addition, it can contain any ASCII character from the ! (\u0021) - through the DEL character (\u007F), including most punctuation - characters, digits, and upper and lowercased letters.

- Tags: - allOf: - - $ref: '#/components/schemas/tagListType' - - description:

A list of tags that you want to attach to the new IAM - virtual MFA device. Each tag consists of a key name and an associated - value. For more information about tagging, see Tagging - IAM resources in the IAM User Guide.

If any - one of the tags is invalid or if you exceed the allowed maximum number - of tags, then the entire request fails and the resource is not created.

- - VirtualMFADeviceName: - allOf: - - $ref: '#/components/schemas/virtualMFADeviceName' - - description: '

The name of the virtual MFA device. Use with path to - uniquely identify a virtual MFA device.

This parameter allows - (through its regex pattern) - a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following - characters: _+=,.@-

' - required: - - VirtualMFADeviceName - title: CreateVirtualMFADeviceRequest - type: object - CreateVirtualMFADeviceResponse: - description: 'Contains the response to a successful CreateVirtualMFADevice - request. ' - properties: - VirtualMFADevice: - allOf: - - $ref: '#/components/schemas/VirtualMFADevice' - - description: A structure containing details about the new virtual MFA - device. - required: - - VirtualMFADevice - type: object - CredentialReportExpiredException: {} - CredentialReportNotPresentException: {} - CredentialReportNotReadyException: {} - DeactivateMFADeviceRequest: - properties: - SerialNumber: - allOf: - - $ref: '#/components/schemas/serialNumberType' - - description: '

The serial number that uniquely identifies the MFA device. - For virtual MFA devices, the serial number is the device ARN.

This - parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: =,.@:/-

' - UserName: - allOf: - - $ref: '#/components/schemas/existingUserNameType' - - description: '

The name of the user whose MFA device you want to deactivate.

-

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - required: - - UserName - - SerialNumber - title: DeactivateMFADeviceRequest - type: object - DeleteAccessKeyRequest: - properties: - AccessKeyId: - allOf: - - $ref: '#/components/schemas/accessKeyIdType' - - description:

The access key ID for the access key ID and secret access - key you want to delete.

This parameter allows (through its regex pattern) a string of - characters that can consist of any upper or lowercased letter or digit.

- UserName: - allOf: - - $ref: '#/components/schemas/existingUserNameType' - - description: '

The name of the user whose access key pair you want to - delete.

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - required: - - AccessKeyId - title: DeleteAccessKeyRequest - type: object - DeleteAccountAliasRequest: - properties: - AccountAlias: - allOf: - - $ref: '#/components/schemas/accountAliasType' - - description:

The name of the account alias to delete.

This parameter - allows (through its regex - pattern) a string of characters consisting of lowercase letters, - digits, and dashes. You cannot start or finish with a dash, nor can - you have two dashes in a row.

- required: - - AccountAlias - title: DeleteAccountAliasRequest - type: object - DeleteConflictException: {} - DeleteGroupPolicyRequest: - properties: - GroupName: - allOf: - - $ref: '#/components/schemas/groupNameType' - - description: '

The name (friendly name, not ARN) identifying the group - that the policy is embedded in.

This parameter allows (through - its regex pattern) a string - of characters consisting of upper and lowercase alphanumeric characters - with no spaces. You can also include any of the following characters: - _+=,.@-

' - PolicyName: - allOf: - - $ref: '#/components/schemas/policyNameType' - - description: '

The name identifying the policy document to delete.

-

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - required: - - GroupName - - PolicyName - title: DeleteGroupPolicyRequest - type: object - DeleteGroupRequest: - properties: - GroupName: - allOf: - - $ref: '#/components/schemas/groupNameType' - - description: '

The name of the IAM group to delete.

This parameter - allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - required: - - GroupName - title: DeleteGroupRequest - type: object - DeleteInstanceProfileRequest: - properties: - InstanceProfileName: - allOf: - - $ref: '#/components/schemas/instanceProfileNameType' - - description: '

The name of the instance profile to delete.

This - parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - required: - - InstanceProfileName - title: DeleteInstanceProfileRequest - type: object - DeleteLoginProfileRequest: - properties: - UserName: - allOf: - - $ref: '#/components/schemas/userNameType' - - description: '

The name of the user whose password you want to delete.

-

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - required: - - UserName - title: DeleteLoginProfileRequest - type: object - DeleteOpenIDConnectProviderRequest: - properties: - OpenIDConnectProviderArn: - allOf: - - $ref: '#/components/schemas/arnType' - - description: The Amazon Resource Name (ARN) of the IAM OpenID Connect - provider resource object to delete. You can get a list of OpenID Connect - provider resource ARNs by using the ListOpenIDConnectProviders - operation. - required: - - OpenIDConnectProviderArn - title: DeleteOpenIDConnectProviderRequest - type: object - DeletePolicyRequest: - properties: - PolicyArn: - allOf: - - $ref: '#/components/schemas/arnType' - - description:

The Amazon Resource Name (ARN) of the IAM policy you want - to delete.

For more information about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.

- required: - - PolicyArn - title: DeletePolicyRequest - type: object - DeletePolicyVersionRequest: - properties: - PolicyArn: - allOf: - - $ref: '#/components/schemas/arnType' - - description:

The Amazon Resource Name (ARN) of the IAM policy from - which you want to delete a version.

For more information about - ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.

- VersionId: - allOf: - - $ref: '#/components/schemas/policyVersionIdType' - - description:

The policy version to delete.

This parameter allows - (through its regex pattern) - a string of characters that consists of the lowercase letter 'v' followed - by one or two digits, and optionally followed by a period '.' and a - string of letters and digits.

For more information about managed - policy versions, see Versioning - for managed policies in the IAM User Guide.

- required: - - PolicyArn - - VersionId - title: DeletePolicyVersionRequest - type: object - DeleteRolePermissionsBoundaryRequest: - properties: - RoleName: - allOf: - - $ref: '#/components/schemas/roleNameType' - - description: The name (friendly name, not ARN) of the IAM role from which - you want to remove the permissions boundary. - required: - - RoleName - title: DeleteRolePermissionsBoundaryRequest - type: object - DeleteRolePolicyRequest: - properties: - PolicyName: - allOf: - - $ref: '#/components/schemas/policyNameType' - - description: '

The name of the inline policy to delete from the specified - IAM role.

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - RoleName: - allOf: - - $ref: '#/components/schemas/roleNameType' - - description: '

The name (friendly name, not ARN) identifying the role - that the policy is embedded in.

This parameter allows (through - its regex pattern) a string - of characters consisting of upper and lowercase alphanumeric characters - with no spaces. You can also include any of the following characters: - _+=,.@-

' - required: - - RoleName - - PolicyName - title: DeleteRolePolicyRequest - type: object - DeleteRoleRequest: - properties: - RoleName: - allOf: - - $ref: '#/components/schemas/roleNameType' - - description: '

The name of the role to delete.

This parameter - allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - required: - - RoleName - title: DeleteRoleRequest - type: object - DeleteSAMLProviderRequest: - properties: - SAMLProviderArn: - allOf: - - $ref: '#/components/schemas/arnType' - - description: The Amazon Resource Name (ARN) of the SAML provider to delete. - required: - - SAMLProviderArn - title: DeleteSAMLProviderRequest - type: object - DeleteSSHPublicKeyRequest: - properties: - SSHPublicKeyId: - allOf: - - $ref: '#/components/schemas/publicKeyIdType' - - description:

The unique identifier for the SSH public key.

This - parameter allows (through its regex - pattern) a string of characters that can consist of any upper or - lowercased letter or digit.

- UserName: - allOf: - - $ref: '#/components/schemas/userNameType' - - description: '

The name of the IAM user associated with the SSH public - key.

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - required: - - UserName - - SSHPublicKeyId - title: DeleteSSHPublicKeyRequest - type: object - DeleteServerCertificateRequest: - properties: - ServerCertificateName: - allOf: - - $ref: '#/components/schemas/serverCertificateNameType' - - description: '

The name of the server certificate you want to delete.

-

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - required: - - ServerCertificateName - title: DeleteServerCertificateRequest - type: object - DeleteServiceLinkedRoleRequest: - properties: - RoleName: - allOf: - - $ref: '#/components/schemas/roleNameType' - - description: The name of the service-linked role to be deleted. - required: - - RoleName - title: DeleteServiceLinkedRoleRequest - type: object - DeleteServiceLinkedRoleResponse: - properties: - DeletionTaskId: - allOf: - - $ref: '#/components/schemas/DeletionTaskIdType' - - description: The deletion task identifier that you can use to check the - status of the deletion. This identifier is returned in the format task/aws-service-role/<service-principal-name>/<role-name>/<task-uuid>. - required: - - DeletionTaskId - type: object - DeleteServiceSpecificCredentialRequest: - properties: - ServiceSpecificCredentialId: - allOf: - - $ref: '#/components/schemas/serviceSpecificCredentialId' - - description:

The unique identifier of the service-specific credential. - You can get this value by calling ListServiceSpecificCredentials.

-

This parameter allows (through its regex - pattern) a string of characters that can consist of any upper or - lowercased letter or digit.

- UserName: - allOf: - - $ref: '#/components/schemas/userNameType' - - description: '

The name of the IAM user associated with the service-specific - credential. If this value is not specified, then the operation assumes - the user whose credentials are used to call the operation.

This - parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - required: - - ServiceSpecificCredentialId - title: DeleteServiceSpecificCredentialRequest - type: object - DeleteSigningCertificateRequest: - properties: - CertificateId: - allOf: - - $ref: '#/components/schemas/certificateIdType' - - description:

The ID of the signing certificate to delete.

The - format of this parameter, as described by its regex - pattern, is a string of characters that can be upper- or lower-cased - letters or digits.

- UserName: - allOf: - - $ref: '#/components/schemas/existingUserNameType' - - description: '

The name of the user the signing certificate belongs - to.

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - required: - - CertificateId - title: DeleteSigningCertificateRequest - type: object - DeleteUserPermissionsBoundaryRequest: - properties: - UserName: - allOf: - - $ref: '#/components/schemas/userNameType' - - description: The name (friendly name, not ARN) of the IAM user from which - you want to remove the permissions boundary. - required: - - UserName - title: DeleteUserPermissionsBoundaryRequest - type: object - DeleteUserPolicyRequest: - properties: - PolicyName: - allOf: - - $ref: '#/components/schemas/policyNameType' - - description: '

The name identifying the policy document to delete.

-

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - UserName: - allOf: - - $ref: '#/components/schemas/existingUserNameType' - - description: '

The name (friendly name, not ARN) identifying the user - that the policy is embedded in.

This parameter allows (through - its regex pattern) a string - of characters consisting of upper and lowercase alphanumeric characters - with no spaces. You can also include any of the following characters: - _+=,.@-

' - required: - - UserName - - PolicyName - title: DeleteUserPolicyRequest - type: object - DeleteUserRequest: - properties: - UserName: - allOf: - - $ref: '#/components/schemas/existingUserNameType' - - description: '

The name of the user to delete.

This parameter - allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - required: - - UserName - title: DeleteUserRequest - type: object - DeleteVirtualMFADeviceRequest: - properties: - SerialNumber: - allOf: - - $ref: '#/components/schemas/serialNumberType' - - description: '

The serial number that uniquely identifies the MFA device. - For virtual MFA devices, the serial number is the same as the ARN.

-

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: =,.@:/-

' - required: - - SerialNumber - title: DeleteVirtualMFADeviceRequest - type: object - DeletionTaskFailureReasonType: - description:

The reason that the service-linked role deletion failed.

-

This data type is used as a response element in the GetServiceLinkedRoleDeletionStatus - operation.

- properties: - Reason: - allOf: - - $ref: '#/components/schemas/ReasonType' - - description: A short description of the reason that the service-linked - role deletion failed. - RoleUsageList: - allOf: - - $ref: '#/components/schemas/RoleUsageListType' - - description: A list of objects that contains details about the service-linked - role deletion failure, if that information is returned by the service. - If the service-linked role has active sessions or if any resources that - were used by the role have not been deleted from the linked service, - the role can't be deleted. This parameter includes a list of the resources - that are associated with the role and the Region in which the resources - are being used. - type: object - DeletionTaskIdType: - maxLength: 1000 - minLength: 1 - type: string - DeletionTaskStatusType: - enum: - - SUCCEEDED - - IN_PROGRESS - - FAILED - - NOT_STARTED - type: string - DetachGroupPolicyRequest: - properties: - GroupName: - allOf: - - $ref: '#/components/schemas/groupNameType' - - description: '

The name (friendly name, not ARN) of the IAM group to - detach the policy from.

This parameter allows (through its regex pattern) a string of - characters consisting of upper and lowercase alphanumeric characters - with no spaces. You can also include any of the following characters: - _+=,.@-

' - PolicyArn: - allOf: - - $ref: '#/components/schemas/arnType' - - description:

The Amazon Resource Name (ARN) of the IAM policy you want - to detach.

For more information about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.

- required: - - GroupName - - PolicyArn - title: DetachGroupPolicyRequest - type: object - DetachRolePolicyRequest: - properties: - PolicyArn: - allOf: - - $ref: '#/components/schemas/arnType' - - description:

The Amazon Resource Name (ARN) of the IAM policy you want - to detach.

For more information about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.

- RoleName: - allOf: - - $ref: '#/components/schemas/roleNameType' - - description: '

The name (friendly name, not ARN) of the IAM role to - detach the policy from.

This parameter allows (through its regex pattern) a string of - characters consisting of upper and lowercase alphanumeric characters - with no spaces. You can also include any of the following characters: - _+=,.@-

' - required: - - RoleName - - PolicyArn - title: DetachRolePolicyRequest - type: object - DetachUserPolicyRequest: - properties: - PolicyArn: - allOf: - - $ref: '#/components/schemas/arnType' - - description:

The Amazon Resource Name (ARN) of the IAM policy you want - to detach.

For more information about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.

- UserName: - allOf: - - $ref: '#/components/schemas/userNameType' - - description: '

The name (friendly name, not ARN) of the IAM user to - detach the policy from.

This parameter allows (through its regex pattern) a string of - characters consisting of upper and lowercase alphanumeric characters - with no spaces. You can also include any of the following characters: - _+=,.@-

' - required: - - UserName - - PolicyArn - title: DetachUserPolicyRequest - type: object - DuplicateCertificateException: {} - DuplicateSSHPublicKeyException: {} - EnableMFADeviceRequest: - properties: - AuthenticationCode1: - allOf: - - $ref: '#/components/schemas/authenticationCodeType' - - description:

An authentication code emitted by the device.

The - format for this parameter is a string of six digits.

-

Submit your request immediately after generating the authentication - codes. If you generate the codes and then wait too long to submit the - request, the MFA device successfully associates with the user but the - MFA device becomes out of sync. This happens because time-based one-time - passwords (TOTP) expire after a short period of time. If this happens, - you can resync - the device.

 - AuthenticationCode2: - allOf: - - $ref: '#/components/schemas/authenticationCodeType' - - description:

A subsequent authentication code emitted by the device.

-

The format for this parameter is a string of six digits.

-

Submit your request immediately after generating the authentication - codes. If you generate the codes and then wait too long to submit the - request, the MFA device successfully associates with the user but the - MFA device becomes out of sync. This happens because time-based one-time - passwords (TOTP) expire after a short period of time. If this happens, - you can resync - the device.

 - SerialNumber: - allOf: - - $ref: '#/components/schemas/serialNumberType' - - description: '

The serial number that uniquely identifies the MFA device. - For virtual MFA devices, the serial number is the device ARN.

This - parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: =,.@:/-

' - UserName: - allOf: - - $ref: '#/components/schemas/existingUserNameType' - - description: '

The name of the IAM user for whom you want to enable - the MFA device.

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - required: - - UserName - - SerialNumber - - AuthenticationCode1 - - AuthenticationCode2 - title: EnableMFADeviceRequest - type: object - EntityAlreadyExistsException: {} - EntityDetails: - description:

An object that contains details about when the IAM entities - (users or roles) were last used in an attempt to access the specified Amazon - Web Services service.

This data type is a response element in the GetServiceLastAccessedDetailsWithEntities - operation.

- properties: - EntityInfo: - allOf: - - $ref: '#/components/schemas/EntityInfo' - - description: "The\_EntityInfo object that contains details\ - \ about the entity (user or role)." - LastAuthenticated: - allOf: - - $ref: '#/components/schemas/dateType' - - description: "

The date and time, in\_ISO 8601 date-time format, when the authenticated entity last attempted\ - \ to access Amazon Web Services. Amazon Web Services does not report\ - \ unauthenticated requests.

This field is null if no IAM entities\ - \ attempted to access the service within the reporting period.

" - required: - - EntityInfo - type: object - EntityInfo: - description:

Contains details about the specified entity (user or role).

-

This data type is an element of the EntityDetails object.

- properties: - Arn: - $ref: '#/components/schemas/arnType' - Id: - allOf: - - $ref: '#/components/schemas/idType' - - description: The identifier of the entity (user or role). - Name: - allOf: - - $ref: '#/components/schemas/userNameType' - - description: The name of the entity (user or role). - Path: - allOf: - - $ref: '#/components/schemas/pathType' - - description: 'The path to the entity (user or role). For more information - about paths, see IAM - identifiers in the IAM User Guide. ' - Type: - allOf: - - $ref: '#/components/schemas/policyOwnerEntityType' - - description: The type of entity (user or role). - required: - - Arn - - Name - - Type - - Id - type: object - EntityTemporarilyUnmodifiableException: {} - EntityType: - enum: - - User - - Role - - Group - - LocalManagedPolicy - - AWSManagedPolicy - type: string - ErrorDetails: - description:

Contains information about the reason that the operation failed.

-

This data type is used as a response element in the GetOrganizationsAccessReport, - GetServiceLastAccessedDetails, and GetServiceLastAccessedDetailsWithEntities - operations.

- properties: - Code: - allOf: - - $ref: '#/components/schemas/stringType' - - description: The error code associated with the operation failure. - Message: - allOf: - - $ref: '#/components/schemas/stringType' - - description: Detailed information about the reason that the operation - failed. - required: - - Message - - Code - type: object - EvalDecisionDetailsType: - additionalProperties: - $ref: '#/components/schemas/PolicyEvaluationDecisionType' - type: object - EvalDecisionSourceType: - maxLength: 256 - minLength: 3 - type: string - EvaluationResult: - description:

Contains the results of a simulation.

This data type - is used by the return parameter of SimulateCustomPolicy - and SimulatePrincipalPolicy .

- properties: - EvalActionName: - allOf: - - $ref: '#/components/schemas/ActionNameType' - - description: The name of the API operation tested on the indicated resource. - EvalDecision: - allOf: - - $ref: '#/components/schemas/PolicyEvaluationDecisionType' - - description: The result of the simulation. - EvalDecisionDetails: - allOf: - - $ref: '#/components/schemas/EvalDecisionDetailsType' - - description:

Additional details about the results of the cross-account - evaluation decision. This parameter is populated for only cross-account - simulations. It contains a brief summary of how each policy type contributes - to the final evaluation decision.

If the simulation evaluates - policies within the same account and includes a resource ARN, then the - parameter is present but the response is empty. If the simulation evaluates - policies within the same account and specifies all resources (*), - then the parameter is not returned.

When you make a cross-account - request, Amazon Web Services evaluates the request in the trusting account - and the trusted account. The request is allowed only if both evaluations - return true. For more information about how policies are - evaluated, see Evaluating - policies within a single account.

If an Organizations SCP - included in the evaluation denies access, the simulation ends. In this - case, policy evaluation does not proceed any further and this parameter - is not returned.

- EvalResourceName: - allOf: - - $ref: '#/components/schemas/ResourceNameType' - - description: The ARN of the resource that the indicated API operation - was tested on. - MatchedStatements: - allOf: - - $ref: '#/components/schemas/StatementListType' - - description: A list of the statements in the input policies that determine - the result for this scenario. Remember that even if multiple statements - allow the operation on the resource, if only one statement denies that - operation, then the explicit deny overrides any allow. In addition, - the deny statement is the only entry included in the result. - MissingContextValues: - allOf: - - $ref: '#/components/schemas/ContextKeyNamesResultListType' - - description: A list of context keys that are required by the included - input policies but that were not provided by one of the input parameters. - This list is used when the resource in a simulation is "*", either explicitly, - or when the ResourceArns parameter blank. If you include - a list of resources, then any missing context values are instead included - under the ResourceSpecificResults section. To discover - the context keys used by a set of policies, you can call GetContextKeysForCustomPolicy - or GetContextKeysForPrincipalPolicy. - OrganizationsDecisionDetail: - allOf: - - $ref: '#/components/schemas/OrganizationsDecisionDetail' - - description: A structure that details how Organizations and its service - control policies affect the results of the simulation. Only applies - if the simulated user's account is part of an organization. - PermissionsBoundaryDecisionDetail: - allOf: - - $ref: '#/components/schemas/PermissionsBoundaryDecisionDetail' - - description: Contains information about the effect that a permissions - boundary has on a policy simulation when the boundary is applied to - an IAM entity. - ResourceSpecificResults: - allOf: - - $ref: '#/components/schemas/ResourceSpecificResultListType' - - description: The individual results of the simulation of the API operation - specified in EvalActionName on each resource. - required: - - EvalActionName - - EvalDecision - type: object - EvaluationResultsListType: - items: - allOf: - - $ref: '#/components/schemas/EvaluationResult' - - xml: - name: member - type: array - GenerateCredentialReportResponse: - description: 'Contains the response to a successful GenerateCredentialReport - request. ' - properties: - Description: - allOf: - - $ref: '#/components/schemas/ReportStateDescriptionType' - - description: Information about the credential report. - State: - allOf: - - $ref: '#/components/schemas/ReportStateType' - - description: Information about the state of the credential report. - type: object - GenerateOrganizationsAccessReportRequest: - properties: - EntityPath: - allOf: - - $ref: '#/components/schemas/organizationsEntityPathType' - - description: The path of the Organizations entity (root, OU, or account). - You can build an entity path using the known structure of your organization. - For example, assume that your account ID is 123456789012 - and its parent OU ID is ou-rge0-awsabcde. The organization - root ID is r-f6g7h8i9j0example and your organization ID - is o-a1b2c3d4e5. Your entity path is o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-rge0-awsabcde/123456789012. - OrganizationsPolicyId: - allOf: - - $ref: '#/components/schemas/organizationsPolicyIdType' - - description:

The identifier of the Organizations service control policy - (SCP). This parameter is optional.

This ID is used to generate - information about when an account principal that is limited by the SCP - attempted to access an Amazon Web Services service.

- required: - - EntityPath - title: GenerateOrganizationsAccessReportRequest - type: object - GenerateOrganizationsAccessReportResponse: - example: - JobId: examplea-1234-b567-cde8-90fg123abcd4 - properties: - JobId: - allOf: - - $ref: '#/components/schemas/jobIDType' - - description: The job identifier that you can use in the GetOrganizationsAccessReport - operation. - type: object - GenerateServiceLastAccessedDetailsRequest: - properties: - Arn: - allOf: - - $ref: '#/components/schemas/arnType' - - description: The ARN of the IAM resource (user, group, role, or managed - policy) used to generate information about when the resource was last - used in an attempt to access an Amazon Web Services service. - Granularity: - allOf: - - $ref: '#/components/schemas/AccessAdvisorUsageGranularityType' - - description: The level of detail that you want to generate. You can specify - whether you want to generate information about the last attempt to access - services or actions. If you specify service-level granularity, this - operation generates only service data. If you specify action-level granularity, - it generates service and action data. If you don't include this optional - parameter, the operation generates service data. - required: - - Arn - title: GenerateServiceLastAccessedDetailsRequest - type: object - GenerateServiceLastAccessedDetailsResponse: - example: - JobId: examplef-1305-c245-eba4-71fe298bcda7 - properties: - JobId: - allOf: - - $ref: '#/components/schemas/jobIDType' - - description: The JobId that you can use in the GetServiceLastAccessedDetails - or GetServiceLastAccessedDetailsWithEntities operations. The - JobId returned by GenerateServiceLastAccessedDetail - must be used by the same role within a session, or by the same user - when used to call GetServiceLastAccessedDetail. - type: object - GetAccessKeyLastUsedRequest: - properties: - AccessKeyId: - allOf: - - $ref: '#/components/schemas/accessKeyIdType' - - description:

The identifier of an access key.

This parameter - allows (through its regex - pattern) a string of characters that can consist of any upper or - lowercased letter or digit.

- required: - - AccessKeyId - title: GetAccessKeyLastUsedRequest - type: object - GetAccessKeyLastUsedResponse: - description: Contains the response to a successful GetAccessKeyLastUsed - request. It is also returned as a member of the AccessKeyMetaData structure - returned by the ListAccessKeys action. - properties: - AccessKeyLastUsed: - allOf: - - $ref: '#/components/schemas/AccessKeyLastUsed' - - description: Contains information about the last time the access key was - used. - UserName: - allOf: - - $ref: '#/components/schemas/existingUserNameType' - - description:

The name of the IAM user that owns this access key.

-

- type: object - GetAccountAuthorizationDetailsRequest: - properties: - Filter: - allOf: - - $ref: '#/components/schemas/entityListType' - - description:

A list of entity types used to filter the results. Only - the entities that match the types you specify are included in the output. - Use the value LocalManagedPolicy to include customer managed - policies.

The format for this parameter is a comma-separated - (if more than one) list of strings. Each string value in the list must - be one of the valid values listed below.

- Marker: - allOf: - - $ref: '#/components/schemas/markerType' - - description: Use this parameter only when paginating results and only - after you receive a response indicating that the results are truncated. - Set it to the value of the Marker element in the response - that you received to indicate where the next call should start. - MaxItems: - allOf: - - $ref: '#/components/schemas/maxItemsType' - - description:

Use this only when paginating results to indicate the - maximum number of items you want in the response. If additional items - exist beyond the maximum you specify, the IsTruncated response - element is true.

If you do not include this parameter, - the number of items defaults to 100. Note that IAM might return fewer - results, even when there are more results available. In that case, the - IsTruncated response element returns true, - and Marker contains a value to include in the subsequent - call that tells the service where to continue from.

- title: GetAccountAuthorizationDetailsRequest - type: object - GetAccountAuthorizationDetailsResponse: - description: 'Contains the response to a successful GetAccountAuthorizationDetails - request. ' - properties: - GroupDetailList: - allOf: - - $ref: '#/components/schemas/groupDetailListType' - - description: A list containing information about IAM groups. - IsTruncated: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: A flag that indicates whether there are more items to return. - If your results were truncated, you can make a subsequent pagination - request using the Marker request parameter to retrieve - more items. Note that IAM might return fewer than the MaxItems - number of results even when there are more results available. We recommend - that you check IsTruncated after every call to ensure that - you receive all your results. - Marker: - allOf: - - $ref: '#/components/schemas/responseMarkerType' - - description: When IsTruncated is true, this - element is present and contains the value to use for the Marker - parameter in a subsequent pagination request. - Policies: - allOf: - - $ref: '#/components/schemas/ManagedPolicyDetailListType' - - description: A list containing information about managed policies. - RoleDetailList: - allOf: - - $ref: '#/components/schemas/roleDetailListType' - - description: A list containing information about IAM roles. - UserDetailList: - allOf: - - $ref: '#/components/schemas/userDetailListType' - - description: A list containing information about IAM users. - type: object - GetAccountPasswordPolicyResponse: - description: 'Contains the response to a successful GetAccountPasswordPolicy - request. ' - example: - PasswordPolicy: - AllowUsersToChangePassword: false - ExpirePasswords: false - HardExpiry: false - MaxPasswordAge: 90 - MinimumPasswordLength: 8 - PasswordReusePrevention: 12 - RequireLowercaseCharacters: false - RequireNumbers: true - RequireSymbols: true - RequireUppercaseCharacters: false - properties: - PasswordPolicy: - allOf: - - $ref: '#/components/schemas/PasswordPolicy' - - description: A structure that contains details about the account's password - policy. - required: - - PasswordPolicy - type: object - GetAccountSummaryResponse: - description: 'Contains the response to a successful GetAccountSummary - request. ' - example: - SummaryMap: - AccessKeysPerUserQuota: 2 - AccountAccessKeysPresent: 1 - AccountMFAEnabled: 0 - AccountSigningCertificatesPresent: 0 - AttachedPoliciesPerGroupQuota: 10 - AttachedPoliciesPerRoleQuota: 10 - AttachedPoliciesPerUserQuota: 10 - GlobalEndpointTokenVersion: 2 - GroupPolicySizeQuota: 5120 - Groups: 15 - GroupsPerUserQuota: 10 - GroupsQuota: 100 - MFADevices: 6 - MFADevicesInUse: 3 - Policies: 8 - PoliciesQuota: 1000 - PolicySizeQuota: 5120 - PolicyVersionsInUse: 22 - PolicyVersionsInUseQuota: 10000 - ServerCertificates: 1 - ServerCertificatesQuota: 20 - SigningCertificatesPerUserQuota: 2 - UserPolicySizeQuota: 2048 - Users: 27 - UsersQuota: 5000 - VersionsPerPolicyQuota: 5 - properties: - SummaryMap: - allOf: - - $ref: '#/components/schemas/summaryMapType' - - description: "A set of key\u2013value pairs containing information about\ - \ IAM entity usage and IAM quotas." - type: object - GetContextKeysForCustomPolicyRequest: - properties: - PolicyInputList: - allOf: - - $ref: '#/components/schemas/SimulationPolicyListType' - - description:

A list of policies for which you want the list of context - keys referenced in those policies. Each document is specified as a string - containing the complete, valid JSON text of an IAM policy.

The - regex pattern used to - validate this parameter is a string of characters consisting of the - following:

  • Any printable ASCII character ranging from - the space character (\u0020) through the end of the ASCII - character range

  • The printable characters in the Basic - Latin and Latin-1 Supplement character set (through \u00FF)

    -

  • The special characters tab (\u0009), line - feed (\u000A), and carriage return (\u000D)

    -
- required: - - PolicyInputList - title: GetContextKeysForCustomPolicyRequest - type: object - GetContextKeysForPolicyResponse: - description: 'Contains the response to a successful GetContextKeysForPrincipalPolicy - or GetContextKeysForCustomPolicy request. ' - properties: - ContextKeyNames: - allOf: - - $ref: '#/components/schemas/ContextKeyNamesResultListType' - - description: The list of context keys that are referenced in the input - policies. - type: object - GetContextKeysForPrincipalPolicyRequest: - properties: - PolicyInputList: - allOf: - - $ref: '#/components/schemas/SimulationPolicyListType' - - description:

An optional list of additional policies for which you - want the list of context keys that are referenced.

The regex - pattern used to validate this parameter is a string of characters - consisting of the following:

  • Any printable ASCII character - ranging from the space character (\u0020) through the end - of the ASCII character range

  • The printable characters - in the Basic Latin and Latin-1 Supplement character set (through \u00FF)

    -

  • The special characters tab (\u0009), line - feed (\u000A), and carriage return (\u000D)

    -
- PolicySourceArn: - allOf: - - $ref: '#/components/schemas/arnType' - - description:

The ARN of a user, group, or role whose policies contain - the context keys that you want listed. If you specify a user, the list - includes context keys that are found in all policies that are attached - to the user. The list also includes all groups that the user is a member - of. If you pick a group or a role, then it includes only those context - keys that are found in policies attached to that entity. Note that all - parameters are shown in unencoded form here for clarity, but must be - URL encoded to be included as a part of a real HTML request.

For - more information about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.

- required: - - PolicySourceArn - title: GetContextKeysForPrincipalPolicyRequest - type: object - GetCredentialReportResponse: - description: 'Contains the response to a successful GetCredentialReport - request. ' - properties: - Content: - allOf: - - $ref: '#/components/schemas/ReportContentType' - - description: Contains the credential report. The report is Base64-encoded. - GeneratedTime: - allOf: - - $ref: '#/components/schemas/dateType' - - description: ' The date and time when the credential report was created, - in ISO 8601 date-time format.' - ReportFormat: - allOf: - - $ref: '#/components/schemas/ReportFormatType' - - description: The format (MIME type) of the credential report. - type: object - GetGroupPolicyRequest: - properties: - GroupName: - allOf: - - $ref: '#/components/schemas/groupNameType' - - description: '

The name of the group the policy is associated with.

-

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - PolicyName: - allOf: - - $ref: '#/components/schemas/policyNameType' - - description: '

The name of the policy document to get.

This parameter - allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - required: - - GroupName - - PolicyName - title: GetGroupPolicyRequest - type: object - GetGroupPolicyResponse: - description: 'Contains the response to a successful GetGroupPolicy request. ' - properties: - GroupName: - allOf: - - $ref: '#/components/schemas/groupNameType' - - description: The group the policy is associated with. - PolicyDocument: - allOf: - - $ref: '#/components/schemas/policyDocumentType' - - description:

The policy document.

IAM stores policies in JSON - format. However, resources that were created using CloudFormation templates - can be formatted in YAML. CloudFormation always converts a YAML policy - to JSON format before submitting it to IAM.

- PolicyName: - allOf: - - $ref: '#/components/schemas/policyNameType' - - description: The name of the policy. - required: - - GroupName - - PolicyName - - PolicyDocument - type: object - GetGroupRequest: - properties: - GroupName: - allOf: - - $ref: '#/components/schemas/groupNameType' - - description: '

The name of the group.

This parameter allows (through - its regex pattern) a string - of characters consisting of upper and lowercase alphanumeric characters - with no spaces. You can also include any of the following characters: - _+=,.@-

' - Marker: - allOf: - - $ref: '#/components/schemas/markerType' - - description: Use this parameter only when paginating results and only - after you receive a response indicating that the results are truncated. - Set it to the value of the Marker element in the response - that you received to indicate where the next call should start. - MaxItems: - allOf: - - $ref: '#/components/schemas/maxItemsType' - - description:

Use this only when paginating results to indicate the - maximum number of items you want in the response. If additional items - exist beyond the maximum you specify, the IsTruncated response - element is true.

If you do not include this parameter, - the number of items defaults to 100. Note that IAM might return fewer - results, even when there are more results available. In that case, the - IsTruncated response element returns true, - and Marker contains a value to include in the subsequent - call that tells the service where to continue from.

- required: - - GroupName - title: GetGroupRequest - type: object - GetGroupResponse: - description: 'Contains the response to a successful GetGroup request. ' - properties: - Group: - allOf: - - $ref: '#/components/schemas/Group' - - description: A structure that contains details about the group. - IsTruncated: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: A flag that indicates whether there are more items to return. - If your results were truncated, you can make a subsequent pagination - request using the Marker request parameter to retrieve - more items. Note that IAM might return fewer than the MaxItems - number of results even when there are more results available. We recommend - that you check IsTruncated after every call to ensure that - you receive all your results. - Marker: - allOf: - - $ref: '#/components/schemas/responseMarkerType' - - description: When IsTruncated is true, this - element is present and contains the value to use for the Marker - parameter in a subsequent pagination request. - Users: - allOf: - - $ref: '#/components/schemas/userListType' - - description: A list of users in the group. - required: - - Group - - Users - type: object - GetInstanceProfileRequest: - properties: - InstanceProfileName: - allOf: - - $ref: '#/components/schemas/instanceProfileNameType' - - description: '

The name of the instance profile to get information about.

-

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - required: - - InstanceProfileName - title: GetInstanceProfileRequest - type: object - GetInstanceProfileResponse: - description: 'Contains the response to a successful GetInstanceProfile - request. ' - example: - InstanceProfile: - Arn: arn:aws:iam::336924118301:instance-profile/ExampleInstanceProfile - CreateDate: '2013-06-12T23:52:02Z' - InstanceProfileId: AID2MAB8DPLSRHEXAMPLE - InstanceProfileName: ExampleInstanceProfile - Path: / - Roles: - - Arn: arn:aws:iam::336924118301:role/Test-Role - AssumeRolePolicyDocument: - CreateDate: '2013-01-09T06:33:26Z' - Path: / - RoleId: AIDGPMS9RO4H3FEXAMPLE - RoleName: Test-Role - properties: - InstanceProfile: - allOf: - - $ref: '#/components/schemas/InstanceProfile' - - description: A structure containing details about the instance profile. - required: - - InstanceProfile - type: object - GetLoginProfileRequest: - properties: - UserName: - allOf: - - $ref: '#/components/schemas/userNameType' - - description: '

The name of the user whose login profile you want to - retrieve.

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - required: - - UserName - title: GetLoginProfileRequest - type: object - GetLoginProfileResponse: - description: 'Contains the response to a successful GetLoginProfile request. ' - example: - LoginProfile: - CreateDate: '2012-09-21T23:03:39Z' - UserName: Anika - properties: - LoginProfile: - allOf: - - $ref: '#/components/schemas/LoginProfile' - - description: A structure containing the user name and the profile creation - date for the user. - required: - - LoginProfile - type: object - GetOpenIDConnectProviderRequest: - properties: - OpenIDConnectProviderArn: - allOf: - - $ref: '#/components/schemas/arnType' - - description:

The Amazon Resource Name (ARN) of the OIDC provider resource - object in IAM to get information for. You can get a list of OIDC provider - resource ARNs by using the ListOpenIDConnectProviders operation.

-

For more information about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.

- required: - - OpenIDConnectProviderArn - title: GetOpenIDConnectProviderRequest - type: object - GetOpenIDConnectProviderResponse: - description: 'Contains the response to a successful GetOpenIDConnectProvider - request. ' - properties: - ClientIDList: - allOf: - - $ref: '#/components/schemas/clientIDListType' - - description: A list of client IDs (also known as audiences) that are associated - with the specified IAM OIDC provider resource object. For more information, - see CreateOpenIDConnectProvider. - CreateDate: - allOf: - - $ref: '#/components/schemas/dateType' - - description: The date and time when the IAM OIDC provider resource object - was created in the Amazon Web Services account. - Tags: - allOf: - - $ref: '#/components/schemas/tagListType' - - description: A list of tags that are attached to the specified IAM OIDC - provider. The returned list of tags is sorted by tag key. For more information - about tagging, see Tagging - IAM resources in the IAM User Guide. - ThumbprintList: - allOf: - - $ref: '#/components/schemas/thumbprintListType' - - description: 'A list of certificate thumbprints that are associated with - the specified IAM OIDC provider resource object. For more information, - see CreateOpenIDConnectProvider. ' - Url: - allOf: - - $ref: '#/components/schemas/OpenIDConnectProviderUrlType' - - description: The URL that the IAM OIDC provider resource object is associated - with. For more information, see CreateOpenIDConnectProvider. - type: object - GetOrganizationsAccessReportRequest: - properties: - JobId: - allOf: - - $ref: '#/components/schemas/jobIDType' - - description: The identifier of the request generated by the GenerateOrganizationsAccessReport - operation. - Marker: - allOf: - - $ref: '#/components/schemas/markerType' - - description: Use this parameter only when paginating results and only - after you receive a response indicating that the results are truncated. - Set it to the value of the Marker element in the response - that you received to indicate where the next call should start. - MaxItems: - allOf: - - $ref: '#/components/schemas/maxItemsType' - - description:

Use this only when paginating results to indicate the - maximum number of items you want in the response. If additional items - exist beyond the maximum you specify, the IsTruncated response - element is true.

If you do not include this parameter, - the number of items defaults to 100. Note that IAM might return fewer - results, even when there are more results available. In that case, the - IsTruncated response element returns true, - and Marker contains a value to include in the subsequent - call that tells the service where to continue from.

- SortKey: - allOf: - - $ref: '#/components/schemas/sortKeyType' - - description: The key that is used to sort the results. If you choose the - namespace key, the results are returned in alphabetical order. If you - choose the time key, the results are sorted numerically by the date - and time. - required: - - JobId - title: GetOrganizationsAccessReportRequest - type: object - GetOrganizationsAccessReportResponse: - example: - AccessDetails: - - EntityPath: o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-1a2b3c-k9l8m7n6o5example/111122223333 - LastAuthenticatedTime: '2019-05-25T16:29:52Z' - Region: us-east-1 - ServiceName: Amazon DynamoDB - ServiceNamespace: dynamodb - TotalAuthenticatedEntities: 2 - - EntityPath: o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-1a2b3c-k9l8m7n6o5example/123456789012 - LastAuthenticatedTime: '2019-06-15T13:12:06Z' - Region: us-east-1 - ServiceName: AWS Identity and Access Management - ServiceNamespace: iam - TotalAuthenticatedEntities: 4 - - ServiceName: Amazon Simple Storage Service - ServiceNamespace: s3 - TotalAuthenticatedEntities: 0 - IsTruncated: false - JobCompletionDate: '2019-06-18T19:47:35.241Z' - JobCreationDate: '2019-06-18T19:47:31.466Z' - JobStatus: COMPLETED - NumberOfServicesAccessible: 3 - NumberOfServicesNotAccessed: 1 - properties: - AccessDetails: - allOf: - - $ref: '#/components/schemas/AccessDetails' - - description: "An\_object that contains details about the most recent attempt\ - \ to access the service." - ErrorDetails: - $ref: '#/components/schemas/ErrorDetails' - IsTruncated: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: A flag that indicates whether there are more items to return. - If your results were truncated, you can make a subsequent pagination - request using the Marker request parameter to retrieve - more items. Note that IAM might return fewer than the MaxItems - number of results even when there are more results available. We recommend - that you check IsTruncated after every call to ensure that - you receive all your results. - JobCompletionDate: - allOf: - - $ref: '#/components/schemas/dateType' - - description: "

The date and time, in\_ISO 8601 date-time format, when the generated report job was completed\ - \ or failed.

This field is null if the job is still in progress,\ - \ as indicated by a job status value of IN_PROGRESS.

" - JobCreationDate: - allOf: - - $ref: '#/components/schemas/dateType' - - description: "The date and time, in\_ISO 8601 date-time format, when the report job was created." - JobStatus: - allOf: - - $ref: '#/components/schemas/jobStatusType' - - description: The status of the job. - Marker: - allOf: - - $ref: '#/components/schemas/markerType' - - description: When IsTruncated is true, this - element is present and contains the value to use for the Marker - parameter in a subsequent pagination request. - NumberOfServicesAccessible: - allOf: - - $ref: '#/components/schemas/integerType' - - description: The number of services that the applicable SCPs allow account - principals to access. - NumberOfServicesNotAccessed: - allOf: - - $ref: '#/components/schemas/integerType' - - description: The number of services that account principals are allowed - but did not attempt to access. - required: - - JobStatus - - JobCreationDate - type: object - GetPolicyRequest: - properties: - PolicyArn: - allOf: - - $ref: '#/components/schemas/arnType' - - description:

The Amazon Resource Name (ARN) of the managed policy that - you want information about.

For more information about ARNs, - see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.

- required: - - PolicyArn - title: GetPolicyRequest - type: object - GetPolicyResponse: - description: 'Contains the response to a successful GetPolicy request. ' - properties: - Policy: - allOf: - - $ref: '#/components/schemas/Policy' - - description: A structure containing details about the policy. - type: object - GetPolicyVersionRequest: - properties: - PolicyArn: - allOf: - - $ref: '#/components/schemas/arnType' - - description:

The Amazon Resource Name (ARN) of the managed policy that - you want information about.

For more information about ARNs, - see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.

- VersionId: - allOf: - - $ref: '#/components/schemas/policyVersionIdType' - - description:

Identifies the policy version to retrieve.

This - parameter allows (through its regex - pattern) a string of characters that consists of the lowercase letter - 'v' followed by one or two digits, and optionally followed by a period - '.' and a string of letters and digits.

- required: - - PolicyArn - - VersionId - title: GetPolicyVersionRequest - type: object - GetPolicyVersionResponse: - description: 'Contains the response to a successful GetPolicyVersion - request. ' - properties: - PolicyVersion: - allOf: - - $ref: '#/components/schemas/PolicyVersion' - - description: A structure containing details about the policy version. - type: object - GetRolePolicyRequest: - properties: - PolicyName: - allOf: - - $ref: '#/components/schemas/policyNameType' - - description: '

The name of the policy document to get.

This parameter - allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - RoleName: - allOf: - - $ref: '#/components/schemas/roleNameType' - - description: '

The name of the role associated with the policy.

-

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - required: - - RoleName - - PolicyName - title: GetRolePolicyRequest - type: object - GetRolePolicyResponse: - description: 'Contains the response to a successful GetRolePolicy request. ' - properties: - PolicyDocument: - allOf: - - $ref: '#/components/schemas/policyDocumentType' - - description:

The policy document.

IAM stores policies in JSON - format. However, resources that were created using CloudFormation templates - can be formatted in YAML. CloudFormation always converts a YAML policy - to JSON format before submitting it to IAM.

- PolicyName: - allOf: - - $ref: '#/components/schemas/policyNameType' - - description: The name of the policy. - RoleName: - allOf: - - $ref: '#/components/schemas/roleNameType' - - description: The role the policy is associated with. - required: - - RoleName - - PolicyName - - PolicyDocument - type: object - GetRoleRequest: - properties: - RoleName: - allOf: - - $ref: '#/components/schemas/roleNameType' - - description: '

The name of the IAM role to get information about.

-

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - required: - - RoleName - title: GetRoleRequest - type: object - GetRoleResponse: - description: 'Contains the response to a successful GetRole request. ' - example: - Role: - Arn: arn:aws:iam::123456789012:role/Test-Role - AssumeRolePolicyDocument: - CreateDate: '2013-04-18T05:01:58Z' - MaxSessionDuration: 3600 - Path: / - RoleId: AROADBQP57FF2AEXAMPLE - RoleLastUsed: - LastUsedDate: '2019-11-18T05:01:58Z' - Region: us-east-1 - RoleName: Test-Role - properties: - Role: - allOf: - - $ref: '#/components/schemas/Role' - - description: A structure containing details about the IAM role. - required: - - Role - type: object - GetSAMLProviderRequest: - properties: - SAMLProviderArn: - allOf: - - $ref: '#/components/schemas/arnType' - - description:

The Amazon Resource Name (ARN) of the SAML provider resource - object in IAM to get information about.

For more information - about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.

- required: - - SAMLProviderArn - title: GetSAMLProviderRequest - type: object - GetSAMLProviderResponse: - description: 'Contains the response to a successful GetSAMLProvider request. ' - properties: - CreateDate: - allOf: - - $ref: '#/components/schemas/dateType' - - description: The date and time when the SAML provider was created. - SAMLMetadataDocument: - allOf: - - $ref: '#/components/schemas/SAMLMetadataDocumentType' - - description: The XML metadata document that includes information about - an identity provider. - Tags: - allOf: - - $ref: '#/components/schemas/tagListType' - - description: A list of tags that are attached to the specified IAM SAML - provider. The returned list of tags is sorted by tag key. For more information - about tagging, see Tagging - IAM resources in the IAM User Guide. - ValidUntil: - allOf: - - $ref: '#/components/schemas/dateType' - - description: The expiration date and time for the SAML provider. - type: object - GetSSHPublicKeyRequest: - properties: - Encoding: - allOf: - - $ref: '#/components/schemas/encodingType' - - description: Specifies the public key encoding format to use in the response. - To retrieve the public key in ssh-rsa format, use SSH. - To retrieve the public key in PEM format, use PEM. - SSHPublicKeyId: - allOf: - - $ref: '#/components/schemas/publicKeyIdType' - - description:

The unique identifier for the SSH public key.

This - parameter allows (through its regex - pattern) a string of characters that can consist of any upper or - lowercased letter or digit.

- UserName: - allOf: - - $ref: '#/components/schemas/userNameType' - - description: '

The name of the IAM user associated with the SSH public - key.

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - required: - - UserName - - SSHPublicKeyId - - Encoding - title: GetSSHPublicKeyRequest - type: object - GetSSHPublicKeyResponse: - description: Contains the response to a successful GetSSHPublicKey request. - properties: - SSHPublicKey: - allOf: - - $ref: '#/components/schemas/SSHPublicKey' - - description: A structure containing details about the SSH public key. - type: object - GetServerCertificateRequest: - properties: - ServerCertificateName: - allOf: - - $ref: '#/components/schemas/serverCertificateNameType' - - description: '

The name of the server certificate you want to retrieve - information about.

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - required: - - ServerCertificateName - title: GetServerCertificateRequest - type: object - GetServerCertificateResponse: - description: 'Contains the response to a successful GetServerCertificate - request. ' - properties: - ServerCertificate: - allOf: - - $ref: '#/components/schemas/ServerCertificate' - - description: A structure containing details about the server certificate. - required: - - ServerCertificate - type: object - GetServiceLastAccessedDetailsRequest: - properties: - JobId: - allOf: - - $ref: '#/components/schemas/jobIDType' - - description: The ID of the request generated by the GenerateServiceLastAccessedDetails - operation. The JobId returned by GenerateServiceLastAccessedDetail - must be used by the same role within a session, or by the same user - when used to call GetServiceLastAccessedDetail. - Marker: - allOf: - - $ref: '#/components/schemas/markerType' - - description: Use this parameter only when paginating results and only - after you receive a response indicating that the results are truncated. - Set it to the value of the Marker element in the response - that you received to indicate where the next call should start. - MaxItems: - allOf: - - $ref: '#/components/schemas/maxItemsType' - - description:

Use this only when paginating results to indicate the - maximum number of items you want in the response. If additional items - exist beyond the maximum you specify, the IsTruncated response - element is true.

If you do not include this parameter, - the number of items defaults to 100. Note that IAM might return fewer - results, even when there are more results available. In that case, the - IsTruncated response element returns true, - and Marker contains a value to include in the subsequent - call that tells the service where to continue from.

- required: - - JobId - title: GetServiceLastAccessedDetailsRequest - type: object - GetServiceLastAccessedDetailsResponse: - example: - IsTruncated: false - JobCompletionDate: '2018-10-24T19:47:35.241Z' - JobCreationDate: '2018-10-24T19:47:31.466Z' - JobStatus: COMPLETED - ServicesLastAccessed: - - LastAuthenticated: '2018-10-24T19:11:00Z' - LastAuthenticatedEntity: arn:aws:iam::123456789012:user/AWSExampleUser01 - ServiceName: AWS Identity and Access Management - ServiceNamespace: iam - TotalAuthenticatedEntities: 2 - - ServiceName: Amazon Simple Storage Service - ServiceNamespace: s3 - TotalAuthenticatedEntities: 0 - properties: - Error: - allOf: - - $ref: '#/components/schemas/ErrorDetails' - - description: An object that contains details about the reason the operation - failed. - IsTruncated: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: A flag that indicates whether there are more items to return. - If your results were truncated, you can make a subsequent pagination - request using the Marker request parameter to retrieve - more items. Note that IAM might return fewer than the MaxItems - number of results even when there are more results available. We recommend - that you check IsTruncated after every call to ensure that - you receive all your results. - JobCompletionDate: - allOf: - - $ref: '#/components/schemas/dateType' - - description: "

The date and time, in\_ISO 8601 date-time format, when the generated report job was completed\ - \ or failed.

This field is null if the job is still in progress,\ - \ as indicated by a job status value of IN_PROGRESS.

" - JobCreationDate: - allOf: - - $ref: '#/components/schemas/dateType' - - description: "The date and time, in\_ISO 8601 date-time format, when the report job was created." - JobStatus: - allOf: - - $ref: '#/components/schemas/jobStatusType' - - description: The status of the job. - JobType: - allOf: - - $ref: '#/components/schemas/AccessAdvisorUsageGranularityType' - - description: The type of job. Service jobs return information about when - each service was last accessed. Action jobs also include information - about when tracked actions within the service were last accessed. - Marker: - allOf: - - $ref: '#/components/schemas/responseMarkerType' - - description: When IsTruncated is true, this - element is present and contains the value to use for the Marker - parameter in a subsequent pagination request. - ServicesLastAccessed: - allOf: - - $ref: '#/components/schemas/ServicesLastAccessed' - - description: " A\_ServiceLastAccessed object that contains\ - \ details about the most recent attempt to access the service." - required: - - JobStatus - - JobCreationDate - - ServicesLastAccessed - - JobCompletionDate - type: object - GetServiceLastAccessedDetailsWithEntitiesRequest: - properties: - JobId: - allOf: - - $ref: '#/components/schemas/jobIDType' - - description: The ID of the request generated by the GenerateServiceLastAccessedDetails - operation. - Marker: - allOf: - - $ref: '#/components/schemas/markerType' - - description: Use this parameter only when paginating results and only - after you receive a response indicating that the results are truncated. - Set it to the value of the Marker element in the response - that you received to indicate where the next call should start. - MaxItems: - allOf: - - $ref: '#/components/schemas/maxItemsType' - - description:

Use this only when paginating results to indicate the - maximum number of items you want in the response. If additional items - exist beyond the maximum you specify, the IsTruncated response - element is true.

If you do not include this parameter, - the number of items defaults to 100. Note that IAM might return fewer - results, even when there are more results available. In that case, the - IsTruncated response element returns true, - and Marker contains a value to include in the subsequent - call that tells the service where to continue from.

- ServiceNamespace: - allOf: - - $ref: '#/components/schemas/serviceNamespaceType' - - description: "

The service namespace for an Amazon Web Services service.\ - \ Provide the service namespace to learn when the IAM entity last attempted\ - \ to access the specified service.

To learn the service namespace\ - \ for a service, see Actions, resources, and condition keys for Amazon Web Services services\ - \ in the IAM User Guide. Choose the name of the service to view\ - \ details for that service. In the first paragraph, find the service\ - \ prefix. For example, (service prefix: a4b). For more\ - \ information about service namespaces, see Amazon Web Services service namespaces in the\_Amazon Web Services\ - \ General Reference.

" - required: - - JobId - - ServiceNamespace - title: GetServiceLastAccessedDetailsWithEntitiesRequest - type: object - GetServiceLastAccessedDetailsWithEntitiesResponse: - example: - EntityDetailsList: - - EntityInfo: - Arn: arn:aws:iam::123456789012:user/AWSExampleUser01 - Id: AIDAEX2EXAMPLEB6IGCDC - Name: AWSExampleUser01 - Path: / - Type: USER - LastAuthenticated: '2018-10-24T19:10:00Z' - - EntityInfo: - Arn: arn:aws:iam::123456789012:role/AWSExampleRole01 - Id: AROAEAEXAMPLEIANXSIU4 - Name: AWSExampleRole01 - Path: / - Type: ROLE - IsTruncated: false - JobCompletionDate: '2018-10-24T19:47:35.241Z' - JobCreationDate: '2018-10-24T19:47:31.466Z' - JobStatus: COMPLETED - properties: - EntityDetailsList: - allOf: - - $ref: '#/components/schemas/entityDetailsListType' - - description: "An\_EntityDetailsList object that contains\ - \ details about when an IAM entity (user or role) used group or policy\ - \ permissions in an attempt to access the specified Amazon Web Services\ - \ service." - Error: - allOf: - - $ref: '#/components/schemas/ErrorDetails' - - description: An object that contains details about the reason the operation - failed. - IsTruncated: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: A flag that indicates whether there are more items to return. - If your results were truncated, you can make a subsequent pagination - request using the Marker request parameter to retrieve - more items. Note that IAM might return fewer than the MaxItems - number of results even when there are more results available. We recommend - that you check IsTruncated after every call to ensure that - you receive all your results. - JobCompletionDate: - allOf: - - $ref: '#/components/schemas/dateType' - - description: "

The date and time, in\_ISO 8601 date-time format, when the generated report job was completed\ - \ or failed.

This field is null if the job is still in progress,\ - \ as indicated by a job status value of IN_PROGRESS.

" - JobCreationDate: - allOf: - - $ref: '#/components/schemas/dateType' - - description: "The date and time, in\_ISO 8601 date-time format, when the report job was created." - JobStatus: - allOf: - - $ref: '#/components/schemas/jobStatusType' - - description: The status of the job. - Marker: - allOf: - - $ref: '#/components/schemas/responseMarkerType' - - description: When IsTruncated is true, this - element is present and contains the value to use for the Marker - parameter in a subsequent pagination request. - required: - - JobStatus - - JobCreationDate - - JobCompletionDate - - EntityDetailsList - type: object - GetServiceLinkedRoleDeletionStatusRequest: - properties: - DeletionTaskId: - allOf: - - $ref: '#/components/schemas/DeletionTaskIdType' - - description: The deletion task identifier. This identifier is returned - by the DeleteServiceLinkedRole operation in the format task/aws-service-role/<service-principal-name>/<role-name>/<task-uuid>. - required: - - DeletionTaskId - title: GetServiceLinkedRoleDeletionStatusRequest - type: object - GetServiceLinkedRoleDeletionStatusResponse: - properties: - Reason: - allOf: - - $ref: '#/components/schemas/DeletionTaskFailureReasonType' - - description: An object that contains details about the reason the deletion - failed. - Status: - allOf: - - $ref: '#/components/schemas/DeletionTaskStatusType' - - description: The status of the deletion. - required: - - Status - type: object - GetUserPolicyRequest: - properties: - PolicyName: - allOf: - - $ref: '#/components/schemas/policyNameType' - - description: '

The name of the policy document to get.

This parameter - allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - UserName: - allOf: - - $ref: '#/components/schemas/existingUserNameType' - - description: '

The name of the user who the policy is associated with.

-

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - required: - - UserName - - PolicyName - title: GetUserPolicyRequest - type: object - GetUserPolicyResponse: - description: 'Contains the response to a successful GetUserPolicy request. ' - properties: - PolicyDocument: - allOf: - - $ref: '#/components/schemas/policyDocumentType' - - description:

The policy document.

IAM stores policies in JSON - format. However, resources that were created using CloudFormation templates - can be formatted in YAML. CloudFormation always converts a YAML policy - to JSON format before submitting it to IAM.

- PolicyName: - allOf: - - $ref: '#/components/schemas/policyNameType' - - description: The name of the policy. - UserName: - allOf: - - $ref: '#/components/schemas/existingUserNameType' - - description: The user the policy is associated with. - required: - - UserName - - PolicyName - - PolicyDocument - type: object - GetUserRequest: - properties: - UserName: - allOf: - - $ref: '#/components/schemas/existingUserNameType' - - description: '

The name of the user to get information about.

This - parameter is optional. If it is not included, it defaults to the user - making the request. This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - title: GetUserRequest - type: object - GetUserResponse: - description: 'Contains the response to a successful GetUser request. ' - example: - User: - Arn: arn:aws:iam::123456789012:user/Bob - CreateDate: '2012-09-21T23:03:13Z' - Path: / - UserId: AKIAIOSFODNN7EXAMPLE - UserName: Bob - properties: - User: - allOf: - - $ref: '#/components/schemas/User' - - description:

A structure containing details about the IAM user.

-

Due to a service issue, password last used data does - not include password use from May 3, 2018 22:50 PDT to May 23, 2018 - 14:08 PDT. This affects last - sign-in dates shown in the IAM console and password last used dates - in the IAM - credential report, and returned by this operation. If users signed - in during the affected time, the password last used date that is returned - is the date the user last signed in before May 3, 2018. For users that - signed in after May 23, 2018 14:08 PDT, the returned password last used - date is accurate.

You can use password last used information - to identify unused credentials for deletion. For example, you might - delete users who did not sign in to Amazon Web Services in the last - 90 days. In cases like this, we recommend that you adjust your evaluation - window to include dates after May 23, 2018. Alternatively, if your users - use access keys to access Amazon Web Services programmatically you can - refer to access key last used information because it is accurate for - all dates.

- required: - - User - type: object - Group: - description:

Contains information about an IAM group entity.

This - data type is used as a response element in the following operations:

- properties: - Arn: - allOf: - - $ref: '#/components/schemas/arnType' - - description: ' The Amazon Resource Name (ARN) specifying the group. For - more information about ARNs and how to use them in policies, see IAM - identifiers in the IAM User Guide. ' - CreateDate: - allOf: - - $ref: '#/components/schemas/dateType' - - description: The date and time, in ISO - 8601 date-time format, when the group was created. - GroupId: - allOf: - - $ref: '#/components/schemas/idType' - - description: ' The stable and unique string identifying the group. For - more information about IDs, see IAM - identifiers in the IAM User Guide. ' - GroupName: - allOf: - - $ref: '#/components/schemas/groupNameType' - - description: The friendly name that identifies the group. - Path: - allOf: - - $ref: '#/components/schemas/pathType' - - description: 'The path to the group. For more information about paths, - see IAM - identifiers in the IAM User Guide. ' - required: - - Path - - GroupName - - GroupId - - Arn - - CreateDate - type: object - GroupDetail: - description:

Contains information about an IAM group, including all of the - group's policies.

This data type is used as a response element in the - GetAccountAuthorizationDetails operation.

- properties: - Arn: - $ref: '#/components/schemas/arnType' - AttachedManagedPolicies: - allOf: - - $ref: '#/components/schemas/attachedPoliciesListType' - - description: A list of the managed policies attached to the group. - CreateDate: - allOf: - - $ref: '#/components/schemas/dateType' - - description: The date and time, in ISO - 8601 date-time format, when the group was created. - GroupId: - allOf: - - $ref: '#/components/schemas/idType' - - description: The stable and unique string identifying the group. For more - information about IDs, see IAM - identifiers in the IAM User Guide. - GroupName: - allOf: - - $ref: '#/components/schemas/groupNameType' - - description: The friendly name that identifies the group. - GroupPolicyList: - allOf: - - $ref: '#/components/schemas/policyDetailListType' - - description: A list of the inline policies embedded in the group. - Path: - allOf: - - $ref: '#/components/schemas/pathType' - - description: The path to the group. For more information about paths, - see IAM - identifiers in the IAM User Guide. - type: object - InstanceProfile: - description:

Contains information about an instance profile.

This - data type is used as a response element in the following operations:

- properties: - Arn: - allOf: - - $ref: '#/components/schemas/arnType' - - description: ' The Amazon Resource Name (ARN) specifying the instance - profile. For more information about ARNs and how to use them in policies, - see IAM - identifiers in the IAM User Guide. ' - CreateDate: - allOf: - - $ref: '#/components/schemas/dateType' - - description: The date when the instance profile was created. - InstanceProfileId: - allOf: - - $ref: '#/components/schemas/idType' - - description: ' The stable and unique string identifying the instance profile. - For more information about IDs, see IAM - identifiers in the IAM User Guide. ' - InstanceProfileName: - allOf: - - $ref: '#/components/schemas/instanceProfileNameType' - - description: The name identifying the instance profile. - Path: - allOf: - - $ref: '#/components/schemas/pathType' - - description: ' The path to the instance profile. For more information - about paths, see IAM - identifiers in the IAM User Guide. ' - Roles: - allOf: - - $ref: '#/components/schemas/roleListType' - - description: The role associated with the instance profile. - Tags: - allOf: - - $ref: '#/components/schemas/tagListType' - - description: A list of tags that are attached to the instance profile. - For more information about tagging, see Tagging - IAM resources in the IAM User Guide. - required: - - Path - - InstanceProfileName - - InstanceProfileId - - Arn - - CreateDate - - Roles - type: object - InvalidAuthenticationCodeException: {} - InvalidCertificateException: {} - InvalidInputException: {} - InvalidPublicKeyException: {} - InvalidUserTypeException: {} - KeyPairMismatchException: {} - LimitExceededException: {} - LineNumber: - type: integer - ListAccessKeysRequest: - properties: - Marker: - allOf: - - $ref: '#/components/schemas/markerType' - - description: Use this parameter only when paginating results and only - after you receive a response indicating that the results are truncated. - Set it to the value of the Marker element in the response - that you received to indicate where the next call should start. - MaxItems: - allOf: - - $ref: '#/components/schemas/maxItemsType' - - description:

Use this only when paginating results to indicate the - maximum number of items you want in the response. If additional items - exist beyond the maximum you specify, the IsTruncated response - element is true.

If you do not include this parameter, - the number of items defaults to 100. Note that IAM might return fewer - results, even when there are more results available. In that case, the - IsTruncated response element returns true, - and Marker contains a value to include in the subsequent - call that tells the service where to continue from.

- UserName: - allOf: - - $ref: '#/components/schemas/existingUserNameType' - - description: '

The name of the user.

This parameter allows (through - its regex pattern) a string - of characters consisting of upper and lowercase alphanumeric characters - with no spaces. You can also include any of the following characters: - _+=,.@-

' - title: ListAccessKeysRequest - type: object - ListAccessKeysResponse: - description: 'Contains the response to a successful ListAccessKeys request. ' - example: - AccessKeyMetadata: - - AccessKeyId: AKIA111111111EXAMPLE - CreateDate: '2016-12-01T22:19:58Z' - Status: Active - UserName: Alice - - AccessKeyId: AKIA222222222EXAMPLE - CreateDate: '2016-12-01T22:20:01Z' - Status: Active - UserName: Alice - properties: - AccessKeyMetadata: - allOf: - - $ref: '#/components/schemas/accessKeyMetadataListType' - - description: A list of objects containing metadata about the access keys. - IsTruncated: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: A flag that indicates whether there are more items to return. - If your results were truncated, you can make a subsequent pagination - request using the Marker request parameter to retrieve - more items. Note that IAM might return fewer than the MaxItems - number of results even when there are more results available. We recommend - that you check IsTruncated after every call to ensure that - you receive all your results. - Marker: - allOf: - - $ref: '#/components/schemas/responseMarkerType' - - description: When IsTruncated is true, this - element is present and contains the value to use for the Marker - parameter in a subsequent pagination request. - required: - - AccessKeyMetadata - type: object - ListAccountAliasesRequest: - properties: - Marker: - allOf: - - $ref: '#/components/schemas/markerType' - - description: Use this parameter only when paginating results and only - after you receive a response indicating that the results are truncated. - Set it to the value of the Marker element in the response - that you received to indicate where the next call should start. - MaxItems: - allOf: - - $ref: '#/components/schemas/maxItemsType' - - description:

Use this only when paginating results to indicate the - maximum number of items you want in the response. If additional items - exist beyond the maximum you specify, the IsTruncated response - element is true.

If you do not include this parameter, - the number of items defaults to 100. Note that IAM might return fewer - results, even when there are more results available. In that case, the - IsTruncated response element returns true, - and Marker contains a value to include in the subsequent - call that tells the service where to continue from.

- title: ListAccountAliasesRequest - type: object - ListAccountAliasesResponse: - description: 'Contains the response to a successful ListAccountAliases - request. ' - example: - AccountAliases: - - exmaple-corporation - properties: - AccountAliases: - allOf: - - $ref: '#/components/schemas/accountAliasListType' - - description: A list of aliases associated with the account. Amazon Web - Services supports only one alias per account. - IsTruncated: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: A flag that indicates whether there are more items to return. - If your results were truncated, you can make a subsequent pagination - request using the Marker request parameter to retrieve - more items. Note that IAM might return fewer than the MaxItems - number of results even when there are more results available. We recommend - that you check IsTruncated after every call to ensure that - you receive all your results. - Marker: - allOf: - - $ref: '#/components/schemas/responseMarkerType' - - description: When IsTruncated is true, this - element is present and contains the value to use for the Marker - parameter in a subsequent pagination request. - required: - - AccountAliases - type: object - ListAttachedGroupPoliciesRequest: - properties: - GroupName: - allOf: - - $ref: '#/components/schemas/groupNameType' - - description: '

The name (friendly name, not ARN) of the group to list - attached policies for.

This parameter allows (through its regex pattern) a string of - characters consisting of upper and lowercase alphanumeric characters - with no spaces. You can also include any of the following characters: - _+=,.@-

' - Marker: - allOf: - - $ref: '#/components/schemas/markerType' - - description: Use this parameter only when paginating results and only - after you receive a response indicating that the results are truncated. - Set it to the value of the Marker element in the response - that you received to indicate where the next call should start. - MaxItems: - allOf: - - $ref: '#/components/schemas/maxItemsType' - - description:

Use this only when paginating results to indicate the - maximum number of items you want in the response. If additional items - exist beyond the maximum you specify, the IsTruncated response - element is true.

If you do not include this parameter, - the number of items defaults to 100. Note that IAM might return fewer - results, even when there are more results available. In that case, the - IsTruncated response element returns true, - and Marker contains a value to include in the subsequent - call that tells the service where to continue from.

- PathPrefix: - allOf: - - $ref: '#/components/schemas/policyPathType' - - description:

The path prefix for filtering the results. This parameter - is optional. If it is not included, it defaults to a slash (/), listing - all policies.

This parameter allows (through its regex - pattern) a string of characters consisting of either a forward slash - (/) by itself or a string that must begin and end with forward slashes. - In addition, it can contain any ASCII character from the ! (\u0021) - through the DEL character (\u007F), including most punctuation - characters, digits, and upper and lowercased letters.

- required: - - GroupName - title: ListAttachedGroupPoliciesRequest - type: object - ListAttachedGroupPoliciesResponse: - description: 'Contains the response to a successful ListAttachedGroupPolicies - request. ' - properties: - AttachedPolicies: - allOf: - - $ref: '#/components/schemas/attachedPoliciesListType' - - description: A list of the attached policies. - IsTruncated: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: A flag that indicates whether there are more items to return. - If your results were truncated, you can make a subsequent pagination - request using the Marker request parameter to retrieve - more items. Note that IAM might return fewer than the MaxItems - number of results even when there are more results available. We recommend - that you check IsTruncated after every call to ensure that - you receive all your results. - Marker: - allOf: - - $ref: '#/components/schemas/responseMarkerType' - - description: When IsTruncated is true, this - element is present and contains the value to use for the Marker - parameter in a subsequent pagination request. - type: object - ListAttachedRolePoliciesRequest: - properties: - Marker: - allOf: - - $ref: '#/components/schemas/markerType' - - description: Use this parameter only when paginating results and only - after you receive a response indicating that the results are truncated. - Set it to the value of the Marker element in the response - that you received to indicate where the next call should start. - MaxItems: - allOf: - - $ref: '#/components/schemas/maxItemsType' - - description:

Use this only when paginating results to indicate the - maximum number of items you want in the response. If additional items - exist beyond the maximum you specify, the IsTruncated response - element is true.

If you do not include this parameter, - the number of items defaults to 100. Note that IAM might return fewer - results, even when there are more results available. In that case, the - IsTruncated response element returns true, - and Marker contains a value to include in the subsequent - call that tells the service where to continue from.

- PathPrefix: - allOf: - - $ref: '#/components/schemas/policyPathType' - - description:

The path prefix for filtering the results. This parameter - is optional. If it is not included, it defaults to a slash (/), listing - all policies.

This parameter allows (through its regex - pattern) a string of characters consisting of either a forward slash - (/) by itself or a string that must begin and end with forward slashes. - In addition, it can contain any ASCII character from the ! (\u0021) - through the DEL character (\u007F), including most punctuation - characters, digits, and upper and lowercased letters.

- RoleName: - allOf: - - $ref: '#/components/schemas/roleNameType' - - description: '

The name (friendly name, not ARN) of the role to list - attached policies for.

This parameter allows (through its regex pattern) a string of - characters consisting of upper and lowercase alphanumeric characters - with no spaces. You can also include any of the following characters: - _+=,.@-

' - required: - - RoleName - title: ListAttachedRolePoliciesRequest - type: object - ListAttachedRolePoliciesResponse: - description: 'Contains the response to a successful ListAttachedRolePolicies - request. ' - properties: - AttachedPolicies: - allOf: - - $ref: '#/components/schemas/attachedPoliciesListType' - - description: A list of the attached policies. - IsTruncated: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: A flag that indicates whether there are more items to return. - If your results were truncated, you can make a subsequent pagination - request using the Marker request parameter to retrieve - more items. Note that IAM might return fewer than the MaxItems - number of results even when there are more results available. We recommend - that you check IsTruncated after every call to ensure that - you receive all your results. - Marker: - allOf: - - $ref: '#/components/schemas/responseMarkerType' - - description: When IsTruncated is true, this - element is present and contains the value to use for the Marker - parameter in a subsequent pagination request. - type: object - ListAttachedUserPoliciesRequest: - properties: - Marker: - allOf: - - $ref: '#/components/schemas/markerType' - - description: Use this parameter only when paginating results and only - after you receive a response indicating that the results are truncated. - Set it to the value of the Marker element in the response - that you received to indicate where the next call should start. - MaxItems: - allOf: - - $ref: '#/components/schemas/maxItemsType' - - description:

Use this only when paginating results to indicate the - maximum number of items you want in the response. If additional items - exist beyond the maximum you specify, the IsTruncated response - element is true.

If you do not include this parameter, - the number of items defaults to 100. Note that IAM might return fewer - results, even when there are more results available. In that case, the - IsTruncated response element returns true, - and Marker contains a value to include in the subsequent - call that tells the service where to continue from.

- PathPrefix: - allOf: - - $ref: '#/components/schemas/policyPathType' - - description:

The path prefix for filtering the results. This parameter - is optional. If it is not included, it defaults to a slash (/), listing - all policies.

This parameter allows (through its regex - pattern) a string of characters consisting of either a forward slash - (/) by itself or a string that must begin and end with forward slashes. - In addition, it can contain any ASCII character from the ! (\u0021) - through the DEL character (\u007F), including most punctuation - characters, digits, and upper and lowercased letters.

- UserName: - allOf: - - $ref: '#/components/schemas/userNameType' - - description: '

The name (friendly name, not ARN) of the user to list - attached policies for.

This parameter allows (through its regex pattern) a string of - characters consisting of upper and lowercase alphanumeric characters - with no spaces. You can also include any of the following characters: - _+=,.@-

' - required: - - UserName - title: ListAttachedUserPoliciesRequest - type: object - ListAttachedUserPoliciesResponse: - description: 'Contains the response to a successful ListAttachedUserPolicies - request. ' - properties: - AttachedPolicies: - allOf: - - $ref: '#/components/schemas/attachedPoliciesListType' - - description: A list of the attached policies. - IsTruncated: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: A flag that indicates whether there are more items to return. - If your results were truncated, you can make a subsequent pagination - request using the Marker request parameter to retrieve - more items. Note that IAM might return fewer than the MaxItems - number of results even when there are more results available. We recommend - that you check IsTruncated after every call to ensure that - you receive all your results. - Marker: - allOf: - - $ref: '#/components/schemas/responseMarkerType' - - description: When IsTruncated is true, this - element is present and contains the value to use for the Marker - parameter in a subsequent pagination request. - type: object - ListEntitiesForPolicyRequest: - properties: - EntityFilter: - allOf: - - $ref: '#/components/schemas/EntityType' - - description:

The entity type to use for filtering the results.

-

For example, when EntityFilter is Role, - only the roles that are attached to the specified policy are returned. - This parameter is optional. If it is not included, all attached entities - (users, groups, and roles) are returned. The argument for this parameter - must be one of the valid values listed below.

- Marker: - allOf: - - $ref: '#/components/schemas/markerType' - - description: Use this parameter only when paginating results and only - after you receive a response indicating that the results are truncated. - Set it to the value of the Marker element in the response - that you received to indicate where the next call should start. - MaxItems: - allOf: - - $ref: '#/components/schemas/maxItemsType' - - description:

Use this only when paginating results to indicate the - maximum number of items you want in the response. If additional items - exist beyond the maximum you specify, the IsTruncated response - element is true.

If you do not include this parameter, - the number of items defaults to 100. Note that IAM might return fewer - results, even when there are more results available. In that case, the - IsTruncated response element returns true, - and Marker contains a value to include in the subsequent - call that tells the service where to continue from.

- PathPrefix: - allOf: - - $ref: '#/components/schemas/pathType' - - description:

The path prefix for filtering the results. This parameter - is optional. If it is not included, it defaults to a slash (/), listing - all entities.

This parameter allows (through its regex - pattern) a string of characters consisting of either a forward slash - (/) by itself or a string that must begin and end with forward slashes. - In addition, it can contain any ASCII character from the ! (\u0021) - through the DEL character (\u007F), including most punctuation - characters, digits, and upper and lowercased letters.

- PolicyArn: - allOf: - - $ref: '#/components/schemas/arnType' - - description:

The Amazon Resource Name (ARN) of the IAM policy for which - you want the versions.

For more information about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.

- PolicyUsageFilter: - allOf: - - $ref: '#/components/schemas/PolicyUsageType' - - description: "

The policy usage method to use for filtering the results.

\ - \

To list only permissions policies, set\_PolicyUsageFilter\_\ - to\_PermissionsPolicy. To list only the policies used to\ - \ set permissions boundaries, set\_the value to\_PermissionsBoundary.

\ - \

This parameter is optional. If it is not included, all policies\ - \ are returned.

" - required: - - PolicyArn - title: ListEntitiesForPolicyRequest - type: object - ListEntitiesForPolicyResponse: - description: 'Contains the response to a successful ListEntitiesForPolicy - request. ' - properties: - IsTruncated: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: A flag that indicates whether there are more items to return. - If your results were truncated, you can make a subsequent pagination - request using the Marker request parameter to retrieve - more items. Note that IAM might return fewer than the MaxItems - number of results even when there are more results available. We recommend - that you check IsTruncated after every call to ensure that - you receive all your results. - Marker: - allOf: - - $ref: '#/components/schemas/responseMarkerType' - - description: When IsTruncated is true, this - element is present and contains the value to use for the Marker - parameter in a subsequent pagination request. - PolicyGroups: - allOf: - - $ref: '#/components/schemas/PolicyGroupListType' - - description: A list of IAM groups that the policy is attached to. - PolicyRoles: - allOf: - - $ref: '#/components/schemas/PolicyRoleListType' - - description: A list of IAM roles that the policy is attached to. - PolicyUsers: - allOf: - - $ref: '#/components/schemas/PolicyUserListType' - - description: A list of IAM users that the policy is attached to. - type: object - ListGroupPoliciesRequest: - properties: - GroupName: - allOf: - - $ref: '#/components/schemas/groupNameType' - - description: '

The name of the group to list policies for.

This - parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - Marker: - allOf: - - $ref: '#/components/schemas/markerType' - - description: Use this parameter only when paginating results and only - after you receive a response indicating that the results are truncated. - Set it to the value of the Marker element in the response - that you received to indicate where the next call should start. - MaxItems: - allOf: - - $ref: '#/components/schemas/maxItemsType' - - description:

Use this only when paginating results to indicate the - maximum number of items you want in the response. If additional items - exist beyond the maximum you specify, the IsTruncated response - element is true.

If you do not include this parameter, - the number of items defaults to 100. Note that IAM might return fewer - results, even when there are more results available. In that case, the - IsTruncated response element returns true, - and Marker contains a value to include in the subsequent - call that tells the service where to continue from.

- required: - - GroupName - title: ListGroupPoliciesRequest - type: object - ListGroupPoliciesResponse: - description: 'Contains the response to a successful ListGroupPolicies - request. ' - example: - PolicyNames: - - AdminRoot - - KeyPolicy - properties: - IsTruncated: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: A flag that indicates whether there are more items to return. - If your results were truncated, you can make a subsequent pagination - request using the Marker request parameter to retrieve - more items. Note that IAM might return fewer than the MaxItems - number of results even when there are more results available. We recommend - that you check IsTruncated after every call to ensure that - you receive all your results. - Marker: - allOf: - - $ref: '#/components/schemas/responseMarkerType' - - description: When IsTruncated is true, this - element is present and contains the value to use for the Marker - parameter in a subsequent pagination request. - PolicyNames: - allOf: - - $ref: '#/components/schemas/policyNameListType' - - description: '

A list of policy names.

This parameter allows - (through its regex pattern) - a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following - characters: _+=,.@-

' - required: - - PolicyNames - type: object - ListGroupsForUserRequest: - properties: - Marker: - allOf: - - $ref: '#/components/schemas/markerType' - - description: Use this parameter only when paginating results and only - after you receive a response indicating that the results are truncated. - Set it to the value of the Marker element in the response - that you received to indicate where the next call should start. - MaxItems: - allOf: - - $ref: '#/components/schemas/maxItemsType' - - description:

Use this only when paginating results to indicate the - maximum number of items you want in the response. If additional items - exist beyond the maximum you specify, the IsTruncated response - element is true.

If you do not include this parameter, - the number of items defaults to 100. Note that IAM might return fewer - results, even when there are more results available. In that case, the - IsTruncated response element returns true, - and Marker contains a value to include in the subsequent - call that tells the service where to continue from.

- UserName: - allOf: - - $ref: '#/components/schemas/existingUserNameType' - - description: '

The name of the user to list groups for.

This - parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - required: - - UserName - title: ListGroupsForUserRequest - type: object - ListGroupsForUserResponse: - description: 'Contains the response to a successful ListGroupsForUser - request. ' - example: - Groups: - - Arn: arn:aws:iam::123456789012:group/division_abc/subdivision_xyz/product_1234/engineering/Test - CreateDate: '2016-11-30T14:10:01.156Z' - GroupId: AGP2111111111EXAMPLE - GroupName: Test - Path: /division_abc/subdivision_xyz/product_1234/engineering/ - - Arn: arn:aws:iam::123456789012:group/division_abc/subdivision_xyz/product_1234/Managers - CreateDate: '2016-06-12T20:14:52.032Z' - GroupId: AGPI222222222SEXAMPLE - GroupName: Managers - Path: /division_abc/subdivision_xyz/product_1234/ - properties: - Groups: - allOf: - - $ref: '#/components/schemas/groupListType' - - description: A list of groups. - IsTruncated: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: A flag that indicates whether there are more items to return. - If your results were truncated, you can make a subsequent pagination - request using the Marker request parameter to retrieve - more items. Note that IAM might return fewer than the MaxItems - number of results even when there are more results available. We recommend - that you check IsTruncated after every call to ensure that - you receive all your results. - Marker: - allOf: - - $ref: '#/components/schemas/responseMarkerType' - - description: When IsTruncated is true, this - element is present and contains the value to use for the Marker - parameter in a subsequent pagination request. - required: - - Groups - type: object - ListGroupsRequest: - properties: - Marker: - allOf: - - $ref: '#/components/schemas/markerType' - - description: Use this parameter only when paginating results and only - after you receive a response indicating that the results are truncated. - Set it to the value of the Marker element in the response - that you received to indicate where the next call should start. - MaxItems: - allOf: - - $ref: '#/components/schemas/maxItemsType' - - description:

Use this only when paginating results to indicate the - maximum number of items you want in the response. If additional items - exist beyond the maximum you specify, the IsTruncated response - element is true.

If you do not include this parameter, - the number of items defaults to 100. Note that IAM might return fewer - results, even when there are more results available. In that case, the - IsTruncated response element returns true, - and Marker contains a value to include in the subsequent - call that tells the service where to continue from.

- PathPrefix: - allOf: - - $ref: '#/components/schemas/pathPrefixType' - - description:

The path prefix for filtering the results. For example, - the prefix /division_abc/subdivision_xyz/ gets all groups - whose path starts with /division_abc/subdivision_xyz/.

-

This parameter is optional. If it is not included, it defaults to - a slash (/), listing all groups. This parameter allows (through its - regex pattern) a string - of characters consisting of either a forward slash (/) by itself or - a string that must begin and end with forward slashes. In addition, - it can contain any ASCII character from the ! (\u0021) - through the DEL character (\u007F), including most punctuation - characters, digits, and upper and lowercased letters.

- title: ListGroupsRequest - type: object - ListGroupsResponse: - description: 'Contains the response to a successful ListGroups request. ' - example: - Groups: - - Arn: arn:aws:iam::123456789012:group/Admins - CreateDate: '2016-12-15T21:40:08.121Z' - GroupId: AGPA1111111111EXAMPLE - GroupName: Admins - Path: /division_abc/subdivision_xyz/ - - Arn: arn:aws:iam::123456789012:group/division_abc/subdivision_xyz/product_1234/engineering/Test - CreateDate: '2016-11-30T14:10:01.156Z' - GroupId: AGP22222222222EXAMPLE - GroupName: Test - Path: /division_abc/subdivision_xyz/product_1234/engineering/ - - Arn: arn:aws:iam::123456789012:group/division_abc/subdivision_xyz/product_1234/Managers - CreateDate: '2016-06-12T20:14:52.032Z' - GroupId: AGPI3333333333EXAMPLE - GroupName: Managers - Path: /division_abc/subdivision_xyz/product_1234/ - properties: - Groups: - allOf: - - $ref: '#/components/schemas/groupListType' - - description: A list of groups. - IsTruncated: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: A flag that indicates whether there are more items to return. - If your results were truncated, you can make a subsequent pagination - request using the Marker request parameter to retrieve - more items. Note that IAM might return fewer than the MaxItems - number of results even when there are more results available. We recommend - that you check IsTruncated after every call to ensure that - you receive all your results. - Marker: - allOf: - - $ref: '#/components/schemas/responseMarkerType' - - description: When IsTruncated is true, this - element is present and contains the value to use for the Marker - parameter in a subsequent pagination request. - required: - - Groups - type: object - ListInstanceProfileTagsRequest: - properties: - InstanceProfileName: - allOf: - - $ref: '#/components/schemas/instanceProfileNameType' - - description: '

The name of the IAM instance profile whose tags you want - to see.

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - Marker: - allOf: - - $ref: '#/components/schemas/markerType' - - description: Use this parameter only when paginating results and only - after you receive a response indicating that the results are truncated. - Set it to the value of the Marker element in the response - that you received to indicate where the next call should start. - MaxItems: - allOf: - - $ref: '#/components/schemas/maxItemsType' - - description:

Use this only when paginating results to indicate the - maximum number of items you want in the response. If additional items - exist beyond the maximum you specify, the IsTruncated response - element is true.

If you do not include this parameter, - the number of items defaults to 100. Note that IAM might return fewer - results, even when there are more results available. In that case, the - IsTruncated response element returns true, - and Marker contains a value to include in the subsequent - call that tells the service where to continue from.

- required: - - InstanceProfileName - title: ListInstanceProfileTagsRequest - type: object - ListInstanceProfileTagsResponse: - properties: - IsTruncated: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: A flag that indicates whether there are more items to return. - If your results were truncated, you can make a subsequent pagination - request using the Marker request parameter to retrieve - more items. Note that IAM might return fewer than the MaxItems - number of results even when there are more results available. We recommend - that you check IsTruncated after every call to ensure that - you receive all your results. - Marker: - allOf: - - $ref: '#/components/schemas/responseMarkerType' - - description: When IsTruncated is true, this - element is present and contains the value to use for the Marker - parameter in a subsequent pagination request. - Tags: - allOf: - - $ref: '#/components/schemas/tagListType' - - description: The list of tags that are currently attached to the IAM instance - profile. Each tag consists of a key name and an associated value. If - no tags are attached to the specified resource, the response contains - an empty list. - required: - - Tags - type: object - ListInstanceProfilesForRoleRequest: - properties: - Marker: - allOf: - - $ref: '#/components/schemas/markerType' - - description: Use this parameter only when paginating results and only - after you receive a response indicating that the results are truncated. - Set it to the value of the Marker element in the response - that you received to indicate where the next call should start. - MaxItems: - allOf: - - $ref: '#/components/schemas/maxItemsType' - - description:

Use this only when paginating results to indicate the - maximum number of items you want in the response. If additional items - exist beyond the maximum you specify, the IsTruncated response - element is true.

If you do not include this parameter, - the number of items defaults to 100. Note that IAM might return fewer - results, even when there are more results available. In that case, the - IsTruncated response element returns true, - and Marker contains a value to include in the subsequent - call that tells the service where to continue from.

- RoleName: - allOf: - - $ref: '#/components/schemas/roleNameType' - - description: '

The name of the role to list instance profiles for.

-

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - required: - - RoleName - title: ListInstanceProfilesForRoleRequest - type: object - ListInstanceProfilesForRoleResponse: - description: 'Contains the response to a successful ListInstanceProfilesForRole - request. ' - properties: - InstanceProfiles: - allOf: - - $ref: '#/components/schemas/instanceProfileListType' - - description: A list of instance profiles. - IsTruncated: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: A flag that indicates whether there are more items to return. - If your results were truncated, you can make a subsequent pagination - request using the Marker request parameter to retrieve - more items. Note that IAM might return fewer than the MaxItems - number of results even when there are more results available. We recommend - that you check IsTruncated after every call to ensure that - you receive all your results. - Marker: - allOf: - - $ref: '#/components/schemas/responseMarkerType' - - description: When IsTruncated is true, this - element is present and contains the value to use for the Marker - parameter in a subsequent pagination request. - required: - - InstanceProfiles - type: object - ListInstanceProfilesRequest: - properties: - Marker: - allOf: - - $ref: '#/components/schemas/markerType' - - description: Use this parameter only when paginating results and only - after you receive a response indicating that the results are truncated. - Set it to the value of the Marker element in the response - that you received to indicate where the next call should start. - MaxItems: - allOf: - - $ref: '#/components/schemas/maxItemsType' - - description:

Use this only when paginating results to indicate the - maximum number of items you want in the response. If additional items - exist beyond the maximum you specify, the IsTruncated response - element is true.

If you do not include this parameter, - the number of items defaults to 100. Note that IAM might return fewer - results, even when there are more results available. In that case, the - IsTruncated response element returns true, - and Marker contains a value to include in the subsequent - call that tells the service where to continue from.

- PathPrefix: - allOf: - - $ref: '#/components/schemas/pathPrefixType' - - description:

The path prefix for filtering the results. For example, - the prefix /application_abc/component_xyz/ gets all instance - profiles whose path starts with /application_abc/component_xyz/.

-

This parameter is optional. If it is not included, it defaults to - a slash (/), listing all instance profiles. This parameter allows (through - its regex pattern) a string - of characters consisting of either a forward slash (/) by itself or - a string that must begin and end with forward slashes. In addition, - it can contain any ASCII character from the ! (\u0021) - through the DEL character (\u007F), including most punctuation - characters, digits, and upper and lowercased letters.

- title: ListInstanceProfilesRequest - type: object - ListInstanceProfilesResponse: - description: 'Contains the response to a successful ListInstanceProfiles - request. ' - properties: - InstanceProfiles: - allOf: - - $ref: '#/components/schemas/instanceProfileListType' - - description: A list of instance profiles. - IsTruncated: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: A flag that indicates whether there are more items to return. - If your results were truncated, you can make a subsequent pagination - request using the Marker request parameter to retrieve - more items. Note that IAM might return fewer than the MaxItems - number of results even when there are more results available. We recommend - that you check IsTruncated after every call to ensure that - you receive all your results. - Marker: - allOf: - - $ref: '#/components/schemas/responseMarkerType' - - description: When IsTruncated is true, this - element is present and contains the value to use for the Marker - parameter in a subsequent pagination request. - required: - - InstanceProfiles - type: object - ListMFADeviceTagsRequest: - properties: - Marker: - allOf: - - $ref: '#/components/schemas/markerType' - - description: Use this parameter only when paginating results and only - after you receive a response indicating that the results are truncated. - Set it to the value of the Marker element in the response - that you received to indicate where the next call should start. - MaxItems: - allOf: - - $ref: '#/components/schemas/maxItemsType' - - description:

Use this only when paginating results to indicate the - maximum number of items you want in the response. If additional items - exist beyond the maximum you specify, the IsTruncated response - element is true.

If you do not include this parameter, - the number of items defaults to 100. Note that IAM might return fewer - results, even when there are more results available. In that case, the - IsTruncated response element returns true, - and Marker contains a value to include in the subsequent - call that tells the service where to continue from.

- SerialNumber: - allOf: - - $ref: '#/components/schemas/serialNumberType' - - description: '

The unique identifier for the IAM virtual MFA device - whose tags you want to see. For virtual MFA devices, the serial number - is the same as the ARN.

This parameter allows (through its regex pattern) a string of - characters consisting of upper and lowercase alphanumeric characters - with no spaces. You can also include any of the following characters: - _+=,.@-

' - required: - - SerialNumber - title: ListMFADeviceTagsRequest - type: object - ListMFADeviceTagsResponse: - properties: - IsTruncated: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: A flag that indicates whether there are more items to return. - If your results were truncated, you can make a subsequent pagination - request using the Marker request parameter to retrieve - more items. Note that IAM might return fewer than the MaxItems - number of results even when there are more results available. We recommend - that you check IsTruncated after every call to ensure that - you receive all your results. - Marker: - allOf: - - $ref: '#/components/schemas/responseMarkerType' - - description: When IsTruncated is true, this - element is present and contains the value to use for the Marker - parameter in a subsequent pagination request. - Tags: - allOf: - - $ref: '#/components/schemas/tagListType' - - description: The list of tags that are currently attached to the virtual - MFA device. Each tag consists of a key name and an associated value. - If no tags are attached to the specified resource, the response contains - an empty list. - required: - - Tags - type: object - ListMFADevicesRequest: - properties: - Marker: - allOf: - - $ref: '#/components/schemas/markerType' - - description: Use this parameter only when paginating results and only - after you receive a response indicating that the results are truncated. - Set it to the value of the Marker element in the response - that you received to indicate where the next call should start. - MaxItems: - allOf: - - $ref: '#/components/schemas/maxItemsType' - - description:

Use this only when paginating results to indicate the - maximum number of items you want in the response. If additional items - exist beyond the maximum you specify, the IsTruncated response - element is true.

If you do not include this parameter, - the number of items defaults to 100. Note that IAM might return fewer - results, even when there are more results available. In that case, the - IsTruncated response element returns true, - and Marker contains a value to include in the subsequent - call that tells the service where to continue from.

- UserName: - allOf: - - $ref: '#/components/schemas/existingUserNameType' - - description: '

The name of the user whose MFA devices you want to list.

-

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - title: ListMFADevicesRequest - type: object - ListMFADevicesResponse: - description: 'Contains the response to a successful ListMFADevices request. ' - properties: - IsTruncated: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: A flag that indicates whether there are more items to return. - If your results were truncated, you can make a subsequent pagination - request using the Marker request parameter to retrieve - more items. Note that IAM might return fewer than the MaxItems - number of results even when there are more results available. We recommend - that you check IsTruncated after every call to ensure that - you receive all your results. - MFADevices: - allOf: - - $ref: '#/components/schemas/mfaDeviceListType' - - description: A list of MFA devices. - Marker: - allOf: - - $ref: '#/components/schemas/responseMarkerType' - - description: When IsTruncated is true, this - element is present and contains the value to use for the Marker - parameter in a subsequent pagination request. - required: - - MFADevices - type: object - ListOpenIDConnectProviderTagsRequest: - properties: - Marker: - allOf: - - $ref: '#/components/schemas/markerType' - - description: Use this parameter only when paginating results and only - after you receive a response indicating that the results are truncated. - Set it to the value of the Marker element in the response - that you received to indicate where the next call should start. - MaxItems: - allOf: - - $ref: '#/components/schemas/maxItemsType' - - description:

Use this only when paginating results to indicate the - maximum number of items you want in the response. If additional items - exist beyond the maximum you specify, the IsTruncated response - element is true.

If you do not include this parameter, - the number of items defaults to 100. Note that IAM might return fewer - results, even when there are more results available. In that case, the - IsTruncated response element returns true, - and Marker contains a value to include in the subsequent - call that tells the service where to continue from.

- OpenIDConnectProviderArn: - allOf: - - $ref: '#/components/schemas/arnType' - - description: '

The ARN of the OpenID Connect (OIDC) identity provider - whose tags you want to see.

This parameter allows (through its - regex pattern) a string - of characters consisting of upper and lowercase alphanumeric characters - with no spaces. You can also include any of the following characters: - _+=,.@-

' - required: - - OpenIDConnectProviderArn - title: ListOpenIDConnectProviderTagsRequest - type: object - ListOpenIDConnectProviderTagsResponse: - properties: - IsTruncated: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: A flag that indicates whether there are more items to return. - If your results were truncated, you can make a subsequent pagination - request using the Marker request parameter to retrieve - more items. Note that IAM might return fewer than the MaxItems - number of results even when there are more results available. We recommend - that you check IsTruncated after every call to ensure that - you receive all your results. - Marker: - allOf: - - $ref: '#/components/schemas/responseMarkerType' - - description: When IsTruncated is true, this - element is present and contains the value to use for the Marker - parameter in a subsequent pagination request. - Tags: - allOf: - - $ref: '#/components/schemas/tagListType' - - description: The list of tags that are currently attached to the OpenID - Connect (OIDC) identity provider. Each tag consists of a key name and - an associated value. If no tags are attached to the specified resource, - the response contains an empty list. - required: - - Tags - type: object - ListOpenIDConnectProvidersRequest: - properties: {} - title: ListOpenIDConnectProvidersRequest - type: object - ListOpenIDConnectProvidersResponse: - description: 'Contains the response to a successful ListOpenIDConnectProviders - request. ' - properties: - OpenIDConnectProviderList: - allOf: - - $ref: '#/components/schemas/OpenIDConnectProviderListType' - - description: The list of IAM OIDC provider resource objects defined in - the Amazon Web Services account. - type: object - ListPoliciesGrantingServiceAccessEntry: - description:

Contains details about the permissions policies that are attached - to the specified identity (user, group, or role).

This data type is - used as a response element in the ListPoliciesGrantingServiceAccess - operation.

- properties: - Policies: - allOf: - - $ref: '#/components/schemas/policyGrantingServiceAccessListType' - - description: "The\_PoliciesGrantingServiceAccess object that\ - \ contains details about the policy." - ServiceNamespace: - allOf: - - $ref: '#/components/schemas/serviceNamespaceType' - - description: "

The namespace of the service that was accessed.

To\ - \ learn the service namespace of a service, see Actions, resources, and condition keys for Amazon Web Services services\ - \ in the Service Authorization Reference. Choose the name of\ - \ the service to view details for that service. In the first paragraph,\ - \ find the service prefix. For example, (service prefix: a4b).\ - \ For more information about service namespaces, see Amazon Web Services service namespaces in the\_Amazon Web Services\ - \ General Reference.

" - type: object - ListPoliciesGrantingServiceAccessRequest: - properties: - Arn: - allOf: - - $ref: '#/components/schemas/arnType' - - description: The ARN of the IAM identity (user, group, or role) whose - policies you want to list. - Marker: - allOf: - - $ref: '#/components/schemas/markerType' - - description: Use this parameter only when paginating results and only - after you receive a response indicating that the results are truncated. - Set it to the value of the Marker element in the response - that you received to indicate where the next call should start. - ServiceNamespaces: - allOf: - - $ref: '#/components/schemas/serviceNamespaceListType' - - description: "

The service namespace for the Amazon Web Services services\ - \ whose policies you want to list.

To learn the service namespace\ - \ for a service, see Actions, resources, and condition keys for Amazon Web Services services\ - \ in the IAM User Guide. Choose the name of the service to view\ - \ details for that service. In the first paragraph, find the service\ - \ prefix. For example, (service prefix: a4b). For more\ - \ information about service namespaces, see Amazon Web Services service namespaces in the\_Amazon Web Services\ - \ General Reference.

" - required: - - Arn - - ServiceNamespaces - title: ListPoliciesGrantingServiceAccessRequest - type: object - ListPoliciesGrantingServiceAccessResponse: - example: - IsTruncated: false - PoliciesGrantingServiceAccess: - - Policies: - - PolicyArn: arn:aws:iam::123456789012:policy/ExampleIamPolicy - PolicyName: ExampleIamPolicy - PolicyType: MANAGED - - EntityName: AWSExampleGroup1 - EntityType: GROUP - PolicyName: ExampleGroup1Policy - PolicyType: INLINE - ServiceNamespace: iam - - Policies: - - PolicyArn: arn:aws:iam::123456789012:policy/ExampleEc2Policy - PolicyName: ExampleEc2Policy - PolicyType: MANAGED - ServiceNamespace: ec2 - properties: - IsTruncated: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: A flag that indicates whether there are more items to return. - If your results were truncated, you can make a subsequent pagination - request using the Marker request parameter to retrieve - more items. We recommend that you check IsTruncated after - every call to ensure that you receive all your results. - Marker: - allOf: - - $ref: '#/components/schemas/responseMarkerType' - - description: When IsTruncated is true, this - element is present and contains the value to use for the Marker - parameter in a subsequent pagination request. - PoliciesGrantingServiceAccess: - allOf: - - $ref: '#/components/schemas/listPolicyGrantingServiceAccessResponseListType' - - description: "A\_ListPoliciesGrantingServiceAccess object\ - \ that contains details about the permissions policies attached to the\ - \ specified identity (user, group, or role)." - required: - - PoliciesGrantingServiceAccess - type: object - ListPoliciesRequest: - properties: - Marker: - allOf: - - $ref: '#/components/schemas/markerType' - - description: Use this parameter only when paginating results and only - after you receive a response indicating that the results are truncated. - Set it to the value of the Marker element in the response - that you received to indicate where the next call should start. - MaxItems: - allOf: - - $ref: '#/components/schemas/maxItemsType' - - description:

Use this only when paginating results to indicate the - maximum number of items you want in the response. If additional items - exist beyond the maximum you specify, the IsTruncated response - element is true.

If you do not include this parameter, - the number of items defaults to 100. Note that IAM might return fewer - results, even when there are more results available. In that case, the - IsTruncated response element returns true, - and Marker contains a value to include in the subsequent - call that tells the service where to continue from.

- OnlyAttached: - allOf: - - $ref: '#/components/schemas/booleanType' - - description:

A flag to filter the results to only the attached policies.

-

When OnlyAttached is true, the returned - list contains only the policies that are attached to an IAM user, group, - or role. When OnlyAttached is false, or when - the parameter is not included, all policies are returned.

- PathPrefix: - allOf: - - $ref: '#/components/schemas/policyPathType' - - description: The path prefix for filtering the results. This parameter - is optional. If it is not included, it defaults to a slash (/), listing - all policies. This parameter allows (through its regex - pattern) a string of characters consisting of either a forward slash - (/) by itself or a string that must begin and end with forward slashes. - In addition, it can contain any ASCII character from the ! (\u0021) - through the DEL character (\u007F), including most punctuation - characters, digits, and upper and lowercased letters. - PolicyUsageFilter: - allOf: - - $ref: '#/components/schemas/PolicyUsageType' - - description: "

The policy usage method to use for filtering the results.

\ - \

To list only permissions policies, set\_PolicyUsageFilter\_\ - to\_PermissionsPolicy. To list only the policies used to\ - \ set permissions boundaries, set\_the value to\_PermissionsBoundary.

\ - \

This parameter is optional. If it is not included, all policies\ - \ are returned.

" - Scope: - allOf: - - $ref: '#/components/schemas/policyScopeType' - - description:

The scope to use for filtering the results.

To - list only Amazon Web Services managed policies, set Scope - to AWS. To list only the customer managed policies in your - Amazon Web Services account, set Scope to Local.

-

This parameter is optional. If it is not included, or if it is set - to All, all policies are returned.

- title: ListPoliciesRequest - type: object - ListPoliciesResponse: - description: 'Contains the response to a successful ListPolicies request. ' - properties: - IsTruncated: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: A flag that indicates whether there are more items to return. - If your results were truncated, you can make a subsequent pagination - request using the Marker request parameter to retrieve - more items. Note that IAM might return fewer than the MaxItems - number of results even when there are more results available. We recommend - that you check IsTruncated after every call to ensure that - you receive all your results. - Marker: - allOf: - - $ref: '#/components/schemas/responseMarkerType' - - description: When IsTruncated is true, this - element is present and contains the value to use for the Marker - parameter in a subsequent pagination request. - Policies: - allOf: - - $ref: '#/components/schemas/policyListType' - - description: A list of policies. - type: object - ListPolicyTagsRequest: - properties: - Marker: - allOf: - - $ref: '#/components/schemas/markerType' - - description: Use this parameter only when paginating results and only - after you receive a response indicating that the results are truncated. - Set it to the value of the Marker element in the response - that you received to indicate where the next call should start. - MaxItems: - allOf: - - $ref: '#/components/schemas/maxItemsType' - - description:

Use this only when paginating results to indicate the - maximum number of items you want in the response. If additional items - exist beyond the maximum you specify, the IsTruncated response - element is true.

If you do not include this parameter, - the number of items defaults to 100. Note that IAM might return fewer - results, even when there are more results available. In that case, the - IsTruncated response element returns true, - and Marker contains a value to include in the subsequent - call that tells the service where to continue from.

- PolicyArn: - allOf: - - $ref: '#/components/schemas/arnType' - - description: '

The ARN of the IAM customer managed policy whose tags - you want to see.

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - required: - - PolicyArn - title: ListPolicyTagsRequest - type: object - ListPolicyTagsResponse: - properties: - IsTruncated: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: A flag that indicates whether there are more items to return. - If your results were truncated, you can make a subsequent pagination - request using the Marker request parameter to retrieve - more items. Note that IAM might return fewer than the MaxItems - number of results even when there are more results available. We recommend - that you check IsTruncated after every call to ensure that - you receive all your results. - Marker: - allOf: - - $ref: '#/components/schemas/responseMarkerType' - - description: When IsTruncated is true, this - element is present and contains the value to use for the Marker - parameter in a subsequent pagination request. - Tags: - allOf: - - $ref: '#/components/schemas/tagListType' - - description: The list of tags that are currently attached to the IAM customer - managed policy. Each tag consists of a key name and an associated value. - If no tags are attached to the specified resource, the response contains - an empty list. - required: - - Tags - type: object - ListPolicyVersionsRequest: - properties: - Marker: - allOf: - - $ref: '#/components/schemas/markerType' - - description: Use this parameter only when paginating results and only - after you receive a response indicating that the results are truncated. - Set it to the value of the Marker element in the response - that you received to indicate where the next call should start. - MaxItems: - allOf: - - $ref: '#/components/schemas/maxItemsType' - - description:

Use this only when paginating results to indicate the - maximum number of items you want in the response. If additional items - exist beyond the maximum you specify, the IsTruncated response - element is true.

If you do not include this parameter, - the number of items defaults to 100. Note that IAM might return fewer - results, even when there are more results available. In that case, the - IsTruncated response element returns true, - and Marker contains a value to include in the subsequent - call that tells the service where to continue from.

- PolicyArn: - allOf: - - $ref: '#/components/schemas/arnType' - - description:

The Amazon Resource Name (ARN) of the IAM policy for which - you want the versions.

For more information about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.

- required: - - PolicyArn - title: ListPolicyVersionsRequest - type: object - ListPolicyVersionsResponse: - description: 'Contains the response to a successful ListPolicyVersions - request. ' - properties: - IsTruncated: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: A flag that indicates whether there are more items to return. - If your results were truncated, you can make a subsequent pagination - request using the Marker request parameter to retrieve - more items. Note that IAM might return fewer than the MaxItems - number of results even when there are more results available. We recommend - that you check IsTruncated after every call to ensure that - you receive all your results. - Marker: - allOf: - - $ref: '#/components/schemas/responseMarkerType' - - description: When IsTruncated is true, this - element is present and contains the value to use for the Marker - parameter in a subsequent pagination request. - Versions: - allOf: - - $ref: '#/components/schemas/policyDocumentVersionListType' - - description:

A list of policy versions.

For more information - about managed policy versions, see Versioning - for managed policies in the IAM User Guide.

- type: object - ListRolePoliciesRequest: - properties: - Marker: - allOf: - - $ref: '#/components/schemas/markerType' - - description: Use this parameter only when paginating results and only - after you receive a response indicating that the results are truncated. - Set it to the value of the Marker element in the response - that you received to indicate where the next call should start. - MaxItems: - allOf: - - $ref: '#/components/schemas/maxItemsType' - - description:

Use this only when paginating results to indicate the - maximum number of items you want in the response. If additional items - exist beyond the maximum you specify, the IsTruncated response - element is true.

If you do not include this parameter, - the number of items defaults to 100. Note that IAM might return fewer - results, even when there are more results available. In that case, the - IsTruncated response element returns true, - and Marker contains a value to include in the subsequent - call that tells the service where to continue from.

- RoleName: - allOf: - - $ref: '#/components/schemas/roleNameType' - - description: '

The name of the role to list policies for.

This - parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - required: - - RoleName - title: ListRolePoliciesRequest - type: object - ListRolePoliciesResponse: - description: 'Contains the response to a successful ListRolePolicies - request. ' - properties: - IsTruncated: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: A flag that indicates whether there are more items to return. - If your results were truncated, you can make a subsequent pagination - request using the Marker request parameter to retrieve - more items. Note that IAM might return fewer than the MaxItems - number of results even when there are more results available. We recommend - that you check IsTruncated after every call to ensure that - you receive all your results. - Marker: - allOf: - - $ref: '#/components/schemas/responseMarkerType' - - description: When IsTruncated is true, this - element is present and contains the value to use for the Marker - parameter in a subsequent pagination request. - PolicyNames: - allOf: - - $ref: '#/components/schemas/policyNameListType' - - description: A list of policy names. - required: - - PolicyNames - type: object - ListRoleTagsRequest: - properties: - Marker: - allOf: - - $ref: '#/components/schemas/markerType' - - description: Use this parameter only when paginating results and only - after you receive a response indicating that the results are truncated. - Set it to the value of the Marker element in the response - that you received to indicate where the next call should start. - MaxItems: - allOf: - - $ref: '#/components/schemas/maxItemsType' - - description:

Use this only when paginating results to indicate the - maximum number of items you want in the response. If additional items - exist beyond the maximum you specify, the IsTruncated response - element is true.

If you do not include this parameter, - the number of items defaults to 100. Note that IAM might return fewer - results, even when there are more results available. In that case, the - IsTruncated response element returns true, - and Marker contains a value to include in the subsequent - call that tells the service where to continue from.

- RoleName: - allOf: - - $ref: '#/components/schemas/roleNameType' - - description: '

The name of the IAM role for which you want to see the - list of tags.

This parameter accepts (through its regex - pattern) a string of characters that consist of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - required: - - RoleName - title: ListRoleTagsRequest - type: object - ListRoleTagsResponse: - example: - IsTruncated: false - Tags: - - Key: Dept - Value: '12345' - - Key: Team - Value: Accounting - properties: - IsTruncated: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: A flag that indicates whether there are more items to return. - If your results were truncated, you can make a subsequent pagination - request using the Marker request parameter to retrieve - more items. Note that IAM might return fewer than the MaxItems - number of results even when there are more results available. We recommend - that you check IsTruncated after every call to ensure that - you receive all your results. - Marker: - allOf: - - $ref: '#/components/schemas/responseMarkerType' - - description: When IsTruncated is true, this - element is present and contains the value to use for the Marker - parameter in a subsequent pagination request. - Tags: - allOf: - - $ref: '#/components/schemas/tagListType' - - description: The list of tags that are currently attached to the role. - Each tag consists of a key name and an associated value. If no tags - are attached to the specified resource, the response contains an empty - list. - required: - - Tags - type: object - ListRolesRequest: - properties: - Marker: - allOf: - - $ref: '#/components/schemas/markerType' - - description: Use this parameter only when paginating results and only - after you receive a response indicating that the results are truncated. - Set it to the value of the Marker element in the response - that you received to indicate where the next call should start. - MaxItems: - allOf: - - $ref: '#/components/schemas/maxItemsType' - - description:

Use this only when paginating results to indicate the - maximum number of items you want in the response. If additional items - exist beyond the maximum you specify, the IsTruncated response - element is true.

If you do not include this parameter, - the number of items defaults to 100. Note that IAM might return fewer - results, even when there are more results available. In that case, the - IsTruncated response element returns true, - and Marker contains a value to include in the subsequent - call that tells the service where to continue from.

- PathPrefix: - allOf: - - $ref: '#/components/schemas/pathPrefixType' - - description:

The path prefix for filtering the results. For example, - the prefix /application_abc/component_xyz/ gets all roles - whose path starts with /application_abc/component_xyz/.

-

This parameter is optional. If it is not included, it defaults to - a slash (/), listing all roles. This parameter allows (through its regex pattern) a string of - characters consisting of either a forward slash (/) by itself or a string - that must begin and end with forward slashes. In addition, it can contain - any ASCII character from the ! (\u0021) through the DEL - character (\u007F), including most punctuation characters, - digits, and upper and lowercased letters.

- title: ListRolesRequest - type: object - ListRolesResponse: - description: 'Contains the response to a successful ListRoles request. ' - properties: - IsTruncated: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: A flag that indicates whether there are more items to return. - If your results were truncated, you can make a subsequent pagination - request using the Marker request parameter to retrieve - more items. Note that IAM might return fewer than the MaxItems - number of results even when there are more results available. We recommend - that you check IsTruncated after every call to ensure that - you receive all your results. - Marker: - allOf: - - $ref: '#/components/schemas/responseMarkerType' - - description: When IsTruncated is true, this - element is present and contains the value to use for the Marker - parameter in a subsequent pagination request. - Roles: - allOf: - - $ref: '#/components/schemas/roleListType' - - description: A list of roles. - required: - - Roles - type: object - ListSAMLProviderTagsRequest: - properties: - Marker: - allOf: - - $ref: '#/components/schemas/markerType' - - description: Use this parameter only when paginating results and only - after you receive a response indicating that the results are truncated. - Set it to the value of the Marker element in the response - that you received to indicate where the next call should start. - MaxItems: - allOf: - - $ref: '#/components/schemas/maxItemsType' - - description:

Use this only when paginating results to indicate the - maximum number of items you want in the response. If additional items - exist beyond the maximum you specify, the IsTruncated response - element is true.

If you do not include this parameter, - the number of items defaults to 100. Note that IAM might return fewer - results, even when there are more results available. In that case, the - IsTruncated response element returns true, - and Marker contains a value to include in the subsequent - call that tells the service where to continue from.

- SAMLProviderArn: - allOf: - - $ref: '#/components/schemas/arnType' - - description: '

The ARN of the Security Assertion Markup Language (SAML) - identity provider whose tags you want to see.

This parameter - allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - required: - - SAMLProviderArn - title: ListSAMLProviderTagsRequest - type: object - ListSAMLProviderTagsResponse: - properties: - IsTruncated: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: A flag that indicates whether there are more items to return. - If your results were truncated, you can make a subsequent pagination - request using the Marker request parameter to retrieve - more items. Note that IAM might return fewer than the MaxItems - number of results even when there are more results available. We recommend - that you check IsTruncated after every call to ensure that - you receive all your results. - Marker: - allOf: - - $ref: '#/components/schemas/responseMarkerType' - - description: When IsTruncated is true, this - element is present and contains the value to use for the Marker - parameter in a subsequent pagination request. - Tags: - allOf: - - $ref: '#/components/schemas/tagListType' - - description: The list of tags that are currently attached to the Security - Assertion Markup Language (SAML) identity provider. Each tag consists - of a key name and an associated value. If no tags are attached to the - specified resource, the response contains an empty list. - required: - - Tags - type: object - ListSAMLProvidersRequest: - properties: {} - title: ListSAMLProvidersRequest - type: object - ListSAMLProvidersResponse: - description: 'Contains the response to a successful ListSAMLProviders - request. ' - properties: - SAMLProviderList: - allOf: - - $ref: '#/components/schemas/SAMLProviderListType' - - description: The list of SAML provider resource objects defined in IAM - for this Amazon Web Services account. - type: object - ListSSHPublicKeysRequest: - properties: - Marker: - allOf: - - $ref: '#/components/schemas/markerType' - - description: Use this parameter only when paginating results and only - after you receive a response indicating that the results are truncated. - Set it to the value of the Marker element in the response - that you received to indicate where the next call should start. - MaxItems: - allOf: - - $ref: '#/components/schemas/maxItemsType' - - description:

Use this only when paginating results to indicate the - maximum number of items you want in the response. If additional items - exist beyond the maximum you specify, the IsTruncated response - element is true.

If you do not include this parameter, - the number of items defaults to 100. Note that IAM might return fewer - results, even when there are more results available. In that case, the - IsTruncated response element returns true, - and Marker contains a value to include in the subsequent - call that tells the service where to continue from.

- UserName: - allOf: - - $ref: '#/components/schemas/userNameType' - - description: '

The name of the IAM user to list SSH public keys for. - If none is specified, the UserName field is determined - implicitly based on the Amazon Web Services access key used to sign - the request.

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - title: ListSSHPublicKeysRequest - type: object - ListSSHPublicKeysResponse: - description: Contains the response to a successful ListSSHPublicKeys - request. - properties: - IsTruncated: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: A flag that indicates whether there are more items to return. - If your results were truncated, you can make a subsequent pagination - request using the Marker request parameter to retrieve - more items. Note that IAM might return fewer than the MaxItems - number of results even when there are more results available. We recommend - that you check IsTruncated after every call to ensure that - you receive all your results. - Marker: - allOf: - - $ref: '#/components/schemas/responseMarkerType' - - description: When IsTruncated is true, this - element is present and contains the value to use for the Marker - parameter in a subsequent pagination request. - SSHPublicKeys: - allOf: - - $ref: '#/components/schemas/SSHPublicKeyListType' - - description: A list of the SSH public keys assigned to IAM user. - type: object - ListServerCertificateTagsRequest: - properties: - Marker: - allOf: - - $ref: '#/components/schemas/markerType' - - description: Use this parameter only when paginating results and only - after you receive a response indicating that the results are truncated. - Set it to the value of the Marker element in the response - that you received to indicate where the next call should start. - MaxItems: - allOf: - - $ref: '#/components/schemas/maxItemsType' - - description:

Use this only when paginating results to indicate the - maximum number of items you want in the response. If additional items - exist beyond the maximum you specify, the IsTruncated response - element is true.

If you do not include this parameter, - the number of items defaults to 100. Note that IAM might return fewer - results, even when there are more results available. In that case, the - IsTruncated response element returns true, - and Marker contains a value to include in the subsequent - call that tells the service where to continue from.

- ServerCertificateName: - allOf: - - $ref: '#/components/schemas/serverCertificateNameType' - - description: '

The name of the IAM server certificate whose tags you - want to see.

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - required: - - ServerCertificateName - title: ListServerCertificateTagsRequest - type: object - ListServerCertificateTagsResponse: - properties: - IsTruncated: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: A flag that indicates whether there are more items to return. - If your results were truncated, you can make a subsequent pagination - request using the Marker request parameter to retrieve - more items. Note that IAM might return fewer than the MaxItems - number of results even when there are more results available. We recommend - that you check IsTruncated after every call to ensure that - you receive all your results. - Marker: - allOf: - - $ref: '#/components/schemas/responseMarkerType' - - description: When IsTruncated is true, this - element is present and contains the value to use for the Marker - parameter in a subsequent pagination request. - Tags: - allOf: - - $ref: '#/components/schemas/tagListType' - - description: The list of tags that are currently attached to the IAM server - certificate. Each tag consists of a key name and an associated value. - If no tags are attached to the specified resource, the response contains - an empty list. - required: - - Tags - type: object - ListServerCertificatesRequest: - properties: - Marker: - allOf: - - $ref: '#/components/schemas/markerType' - - description: Use this parameter only when paginating results and only - after you receive a response indicating that the results are truncated. - Set it to the value of the Marker element in the response - that you received to indicate where the next call should start. - MaxItems: - allOf: - - $ref: '#/components/schemas/maxItemsType' - - description:

Use this only when paginating results to indicate the - maximum number of items you want in the response. If additional items - exist beyond the maximum you specify, the IsTruncated response - element is true.

If you do not include this parameter, - the number of items defaults to 100. Note that IAM might return fewer - results, even when there are more results available. In that case, the - IsTruncated response element returns true, - and Marker contains a value to include in the subsequent - call that tells the service where to continue from.

- PathPrefix: - allOf: - - $ref: '#/components/schemas/pathPrefixType' - - description: '

The path prefix for filtering the results. For example: - /company/servercerts would get all server certificates - for which the path starts with /company/servercerts.

-

This parameter is optional. If it is not included, it defaults to - a slash (/), listing all server certificates. This parameter allows - (through its regex pattern) - a string of characters consisting of either a forward slash (/) by itself - or a string that must begin and end with forward slashes. In addition, - it can contain any ASCII character from the ! (\u0021) - through the DEL character (\u007F), including most punctuation - characters, digits, and upper and lowercased letters.

' - title: ListServerCertificatesRequest - type: object - ListServerCertificatesResponse: - description: 'Contains the response to a successful ListServerCertificates - request. ' - properties: - IsTruncated: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: A flag that indicates whether there are more items to return. - If your results were truncated, you can make a subsequent pagination - request using the Marker request parameter to retrieve - more items. Note that IAM might return fewer than the MaxItems - number of results even when there are more results available. We recommend - that you check IsTruncated after every call to ensure that - you receive all your results. - Marker: - allOf: - - $ref: '#/components/schemas/responseMarkerType' - - description: When IsTruncated is true, this - element is present and contains the value to use for the Marker - parameter in a subsequent pagination request. - ServerCertificateMetadataList: - allOf: - - $ref: '#/components/schemas/serverCertificateMetadataListType' - - description: A list of server certificates. - required: - - ServerCertificateMetadataList - type: object - ListServiceSpecificCredentialsRequest: - properties: - ServiceName: - allOf: - - $ref: '#/components/schemas/serviceName' - - description: Filters the returned results to only those for the specified - Amazon Web Services service. If not specified, then Amazon Web Services - returns service-specific credentials for all services. - UserName: - allOf: - - $ref: '#/components/schemas/userNameType' - - description: '

The name of the user whose service-specific credentials - you want information about. If this value is not specified, then the - operation assumes the user whose credentials are used to call the operation.

-

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - title: ListServiceSpecificCredentialsRequest - type: object - ListServiceSpecificCredentialsResponse: - properties: - ServiceSpecificCredentials: - allOf: - - $ref: '#/components/schemas/ServiceSpecificCredentialsListType' - - description: A list of structures that each contain details about a service-specific - credential. - type: object - ListSigningCertificatesRequest: - properties: - Marker: - allOf: - - $ref: '#/components/schemas/markerType' - - description: Use this parameter only when paginating results and only - after you receive a response indicating that the results are truncated. - Set it to the value of the Marker element in the response - that you received to indicate where the next call should start. - MaxItems: - allOf: - - $ref: '#/components/schemas/maxItemsType' - - description:

Use this only when paginating results to indicate the - maximum number of items you want in the response. If additional items - exist beyond the maximum you specify, the IsTruncated response - element is true.

If you do not include this parameter, - the number of items defaults to 100. Note that IAM might return fewer - results, even when there are more results available. In that case, the - IsTruncated response element returns true, - and Marker contains a value to include in the subsequent - call that tells the service where to continue from.

- UserName: - allOf: - - $ref: '#/components/schemas/existingUserNameType' - - description: '

The name of the IAM user whose signing certificates you - want to examine.

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - title: ListSigningCertificatesRequest - type: object - ListSigningCertificatesResponse: - description: 'Contains the response to a successful ListSigningCertificates - request. ' - example: - Certificates: - - CertificateBody: '-----BEGIN CERTIFICATE----------END - CERTIFICATE-----' - CertificateId: TA7SMP42TDN5Z26OBPJE7EXAMPLE - Status: Active - UploadDate: '2013-06-06T21:40:08Z' - UserName: Bob - properties: - Certificates: - allOf: - - $ref: '#/components/schemas/certificateListType' - - description: A list of the user's signing certificate information. - IsTruncated: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: A flag that indicates whether there are more items to return. - If your results were truncated, you can make a subsequent pagination - request using the Marker request parameter to retrieve - more items. Note that IAM might return fewer than the MaxItems - number of results even when there are more results available. We recommend - that you check IsTruncated after every call to ensure that - you receive all your results. - Marker: - allOf: - - $ref: '#/components/schemas/responseMarkerType' - - description: When IsTruncated is true, this - element is present and contains the value to use for the Marker - parameter in a subsequent pagination request. - required: - - Certificates - type: object - ListUserPoliciesRequest: - properties: - Marker: - allOf: - - $ref: '#/components/schemas/markerType' - - description: Use this parameter only when paginating results and only - after you receive a response indicating that the results are truncated. - Set it to the value of the Marker element in the response - that you received to indicate where the next call should start. - MaxItems: - allOf: - - $ref: '#/components/schemas/maxItemsType' - - description:

Use this only when paginating results to indicate the - maximum number of items you want in the response. If additional items - exist beyond the maximum you specify, the IsTruncated response - element is true.

If you do not include this parameter, - the number of items defaults to 100. Note that IAM might return fewer - results, even when there are more results available. In that case, the - IsTruncated response element returns true, - and Marker contains a value to include in the subsequent - call that tells the service where to continue from.

- UserName: - allOf: - - $ref: '#/components/schemas/existingUserNameType' - - description: '

The name of the user to list policies for.

This - parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - required: - - UserName - title: ListUserPoliciesRequest - type: object - ListUserPoliciesResponse: - description: 'Contains the response to a successful ListUserPolicies - request. ' - properties: - IsTruncated: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: A flag that indicates whether there are more items to return. - If your results were truncated, you can make a subsequent pagination - request using the Marker request parameter to retrieve - more items. Note that IAM might return fewer than the MaxItems - number of results even when there are more results available. We recommend - that you check IsTruncated after every call to ensure that - you receive all your results. - Marker: - allOf: - - $ref: '#/components/schemas/responseMarkerType' - - description: When IsTruncated is true, this - element is present and contains the value to use for the Marker - parameter in a subsequent pagination request. - PolicyNames: - allOf: - - $ref: '#/components/schemas/policyNameListType' - - description: A list of policy names. - required: - - PolicyNames - type: object - ListUserTagsRequest: - properties: - Marker: - allOf: - - $ref: '#/components/schemas/markerType' - - description: Use this parameter only when paginating results and only - after you receive a response indicating that the results are truncated. - Set it to the value of the Marker element in the response - that you received to indicate where the next call should start. - MaxItems: - allOf: - - $ref: '#/components/schemas/maxItemsType' - - description:

Use this only when paginating results to indicate the - maximum number of items you want in the response. If additional items - exist beyond the maximum you specify, the IsTruncated response - element is true.

If you do not include this parameter, - the number of items defaults to 100. Note that IAM might return fewer - results, even when there are more results available. In that case, the - IsTruncated response element returns true, - and Marker contains a value to include in the subsequent - call that tells the service where to continue from.

- UserName: - allOf: - - $ref: '#/components/schemas/existingUserNameType' - - description: '

The name of the IAM user whose tags you want to see.

-

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - required: - - UserName - title: ListUserTagsRequest - type: object - ListUserTagsResponse: - example: - IsTruncated: false - Tags: - - Key: Dept - Value: '12345' - - Key: Team - Value: Accounting - properties: - IsTruncated: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: A flag that indicates whether there are more items to return. - If your results were truncated, you can make a subsequent pagination - request using the Marker request parameter to retrieve - more items. Note that IAM might return fewer than the MaxItems - number of results even when there are more results available. We recommend - that you check IsTruncated after every call to ensure that - you receive all your results. - Marker: - allOf: - - $ref: '#/components/schemas/responseMarkerType' - - description: When IsTruncated is true, this - element is present and contains the value to use for the Marker - parameter in a subsequent pagination request. - Tags: - allOf: - - $ref: '#/components/schemas/tagListType' - - description: The list of tags that are currently attached to the user. - Each tag consists of a key name and an associated value. If no tags - are attached to the specified resource, the response contains an empty - list. - required: - - Tags - type: object - ListUsersRequest: - properties: - Marker: - allOf: - - $ref: '#/components/schemas/markerType' - - description: Use this parameter only when paginating results and only - after you receive a response indicating that the results are truncated. - Set it to the value of the Marker element in the response - that you received to indicate where the next call should start. - MaxItems: - allOf: - - $ref: '#/components/schemas/maxItemsType' - - description:

Use this only when paginating results to indicate the - maximum number of items you want in the response. If additional items - exist beyond the maximum you specify, the IsTruncated response - element is true.

If you do not include this parameter, - the number of items defaults to 100. Note that IAM might return fewer - results, even when there are more results available. In that case, the - IsTruncated response element returns true, - and Marker contains a value to include in the subsequent - call that tells the service where to continue from.

- PathPrefix: - allOf: - - $ref: '#/components/schemas/pathPrefixType' - - description: '

The path prefix for filtering the results. For example: - /division_abc/subdivision_xyz/, which would get all user - names whose path starts with /division_abc/subdivision_xyz/.

-

This parameter is optional. If it is not included, it defaults to - a slash (/), listing all user names. This parameter allows (through - its regex pattern) a string - of characters consisting of either a forward slash (/) by itself or - a string that must begin and end with forward slashes. In addition, - it can contain any ASCII character from the ! (\u0021) - through the DEL character (\u007F), including most punctuation - characters, digits, and upper and lowercased letters.

' - title: ListUsersRequest - type: object - ListUsersResponse: - description: 'Contains the response to a successful ListUsers request. ' - example: - Users: - - Arn: arn:aws:iam::123456789012:user/division_abc/subdivision_xyz/engineering/Juan - CreateDate: '2012-09-05T19:38:48Z' - PasswordLastUsed: '2016-09-08T21:47:36Z' - Path: /division_abc/subdivision_xyz/engineering/ - UserId: AID2MAB8DPLSRHEXAMPLE - UserName: Juan - - Arn: arn:aws:iam::123456789012:user/division_abc/subdivision_xyz/engineering/Anika - CreateDate: '2014-04-09T15:43:45Z' - PasswordLastUsed: '2016-09-24T16:18:07Z' - Path: /division_abc/subdivision_xyz/engineering/ - UserId: AIDIODR4TAW7CSEXAMPLE - UserName: Anika - properties: - IsTruncated: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: A flag that indicates whether there are more items to return. - If your results were truncated, you can make a subsequent pagination - request using the Marker request parameter to retrieve - more items. Note that IAM might return fewer than the MaxItems - number of results even when there are more results available. We recommend - that you check IsTruncated after every call to ensure that - you receive all your results. - Marker: - allOf: - - $ref: '#/components/schemas/responseMarkerType' - - description: When IsTruncated is true, this - element is present and contains the value to use for the Marker - parameter in a subsequent pagination request. - Users: - allOf: - - $ref: '#/components/schemas/userListType' - - description: A list of users. - required: - - Users - type: object - ListVirtualMFADevicesRequest: - properties: - AssignmentStatus: - allOf: - - $ref: '#/components/schemas/assignmentStatusType' - - description: ' The status (Unassigned or Assigned) - of the devices to list. If you do not specify an AssignmentStatus, - the operation defaults to Any, which lists both assigned - and unassigned virtual MFA devices.,' - Marker: - allOf: - - $ref: '#/components/schemas/markerType' - - description: Use this parameter only when paginating results and only - after you receive a response indicating that the results are truncated. - Set it to the value of the Marker element in the response - that you received to indicate where the next call should start. - MaxItems: - allOf: - - $ref: '#/components/schemas/maxItemsType' - - description:

Use this only when paginating results to indicate the - maximum number of items you want in the response. If additional items - exist beyond the maximum you specify, the IsTruncated response - element is true.

If you do not include this parameter, - the number of items defaults to 100. Note that IAM might return fewer - results, even when there are more results available. In that case, the - IsTruncated response element returns true, - and Marker contains a value to include in the subsequent - call that tells the service where to continue from.

- title: ListVirtualMFADevicesRequest - type: object - ListVirtualMFADevicesResponse: - description: 'Contains the response to a successful ListVirtualMFADevices - request. ' - example: - VirtualMFADevices: - - SerialNumber: arn:aws:iam::123456789012:mfa/ExampleMFADevice - - SerialNumber: arn:aws:iam::123456789012:mfa/Juan - properties: - IsTruncated: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: A flag that indicates whether there are more items to return. - If your results were truncated, you can make a subsequent pagination - request using the Marker request parameter to retrieve - more items. Note that IAM might return fewer than the MaxItems - number of results even when there are more results available. We recommend - that you check IsTruncated after every call to ensure that - you receive all your results. - Marker: - allOf: - - $ref: '#/components/schemas/responseMarkerType' - - description: When IsTruncated is true, this - element is present and contains the value to use for the Marker - parameter in a subsequent pagination request. - VirtualMFADevices: - allOf: - - $ref: '#/components/schemas/virtualMFADeviceListType' - - description: ' The list of virtual MFA devices in the current account - that match the AssignmentStatus value that was passed in - the request.' - required: - - VirtualMFADevices - type: object - LoginProfile: - description:

Contains the user name and password create date for a user.

-

This data type is used as a response element in the CreateLoginProfile - and GetLoginProfile operations.

- properties: - CreateDate: - allOf: - - $ref: '#/components/schemas/dateType' - - description: The date when the password for the user was created. - PasswordResetRequired: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: Specifies whether the user is required to set a new password - on next sign-in. - UserName: - allOf: - - $ref: '#/components/schemas/userNameType' - - description: The name of the user, which can be used for signing in to - the Amazon Web Services Management Console. - required: - - UserName - - CreateDate - type: object - MFADevice: - description:

Contains information about an MFA device.

This data type - is used as a response element in the ListMFADevices operation.

- properties: - EnableDate: - allOf: - - $ref: '#/components/schemas/dateType' - - description: The date when the MFA device was enabled for the user. - SerialNumber: - allOf: - - $ref: '#/components/schemas/serialNumberType' - - description: The serial number that uniquely identifies the MFA device. - For virtual MFA devices, the serial number is the device ARN. - UserName: - allOf: - - $ref: '#/components/schemas/userNameType' - - description: The user with whom the MFA device is associated. - required: - - UserName - - SerialNumber - - EnableDate - type: object - MalformedCertificateException: {} - MalformedPolicyDocumentException: {} - ManagedPolicyDetail: - description:

Contains information about a managed policy, including the policy's - ARN, versions, and the number of principal entities (users, groups, and roles) - that the policy is attached to.

This data type is used as a response - element in the GetAccountAuthorizationDetails operation.

For - more information about managed policies, see Managed - policies and inline policies in the IAM User Guide.

- properties: - Arn: - $ref: '#/components/schemas/arnType' - AttachmentCount: - allOf: - - $ref: '#/components/schemas/attachmentCountType' - - description: The number of principal entities (users, groups, and roles) - that the policy is attached to. - CreateDate: - allOf: - - $ref: '#/components/schemas/dateType' - - description: The date and time, in ISO - 8601 date-time format, when the policy was created. - DefaultVersionId: - allOf: - - $ref: '#/components/schemas/policyVersionIdType' - - description:

The identifier for the version of the policy that is set - as the default (operative) version.

For more information about - policy versions, see Versioning - for managed policies in the IAM User Guide.

- Description: - allOf: - - $ref: '#/components/schemas/policyDescriptionType' - - description: A friendly description of the policy. - IsAttachable: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: Specifies whether the policy can be attached to an IAM user, - group, or role. - Path: - allOf: - - $ref: '#/components/schemas/policyPathType' - - description:

The path to the policy.

For more information about - paths, see IAM - identifiers in the IAM User Guide.

- PermissionsBoundaryUsageCount: - allOf: - - $ref: '#/components/schemas/attachmentCountType' - - description:

The number of entities (users and roles) for which the - policy is used as the permissions boundary.

For more information - about permissions boundaries, see Permissions - boundaries for IAM identities in the IAM User Guide.

- PolicyId: - allOf: - - $ref: '#/components/schemas/idType' - - description:

The stable and unique string identifying the policy.

-

For more information about IDs, see IAM - identifiers in the IAM User Guide.

- PolicyName: - allOf: - - $ref: '#/components/schemas/policyNameType' - - description: The friendly name (not ARN) identifying the policy. - PolicyVersionList: - allOf: - - $ref: '#/components/schemas/policyDocumentVersionListType' - - description: A list containing information about the versions of the policy. - UpdateDate: - allOf: - - $ref: '#/components/schemas/dateType' - - description:

The date and time, in ISO - 8601 date-time format, when the policy was last updated.

When - a policy has only one version, this field contains the date and time - when the policy was created. When a policy has more than one version, - this field contains the date and time when the most recent policy version - was created.

- type: object - ManagedPolicyDetailListType: - items: - allOf: - - $ref: '#/components/schemas/ManagedPolicyDetail' - - xml: - name: member - type: array - NoSuchEntityException: {} - OpenIDConnectProviderListEntry: - description: Contains the Amazon Resource Name (ARN) for an IAM OpenID Connect - provider. - properties: - Arn: - $ref: '#/components/schemas/arnType' - type: object - OpenIDConnectProviderListType: - description: Contains a list of IAM OpenID Connect providers. - items: - allOf: - - $ref: '#/components/schemas/OpenIDConnectProviderListEntry' - - xml: - name: member - type: array - OpenIDConnectProviderUrlType: - description: Contains a URL that specifies the endpoint for an OpenID Connect - provider. - maxLength: 255 - minLength: 1 - type: string - OrganizationsDecisionDetail: - description: Contains information about the effect that Organizations has on - a policy simulation. - properties: - AllowedByOrganizations: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: Specifies whether the simulated operation is allowed by the - Organizations service control policies that impact the simulated user's - account. - type: object - PasswordPolicy: - description:

Contains information about the account password policy.

-

This data type is used as a response element in the GetAccountPasswordPolicy - operation.

- properties: - AllowUsersToChangePassword: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: Specifies whether IAM users are allowed to change their own - password. Gives IAM users permissions to iam:ChangePassword - for only their user and to the iam:GetAccountPasswordPolicy - action. This option does not attach a permissions policy to each user, - rather the permissions are applied at the account-level for all users - by IAM. - ExpirePasswords: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: Indicates whether passwords in the account expire. Returns - true if MaxPasswordAge contains a value greater than 0. - Returns false if MaxPasswordAge is 0 or not present. - HardExpiry: - allOf: - - $ref: '#/components/schemas/booleanObjectType' - - description: Specifies whether IAM users are prevented from setting a - new password via the Amazon Web Services Management Console after their - password has expired. The IAM user cannot access the console until an - administrator resets the password. IAM users with iam:ChangePassword - permission and active access keys can reset their own expired console - password using the CLI or API. - MaxPasswordAge: - allOf: - - $ref: '#/components/schemas/maxPasswordAgeType' - - description: The number of days that an IAM user password is valid. - MinimumPasswordLength: - allOf: - - $ref: '#/components/schemas/minimumPasswordLengthType' - - description: Minimum length to require for IAM user passwords. - PasswordReusePrevention: - allOf: - - $ref: '#/components/schemas/passwordReusePreventionType' - - description: Specifies the number of previous passwords that IAM users - are prevented from reusing. - RequireLowercaseCharacters: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: Specifies whether IAM user passwords must contain at least - one lowercase character (a to z). - RequireNumbers: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: Specifies whether IAM user passwords must contain at least - one numeric character (0 to 9). - RequireSymbols: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: '

Specifies whether IAM user passwords must contain at - least one of the following symbols:

! @ # $ % ^ & * ( ) _ - + - = [ ] { } | ''

' - RequireUppercaseCharacters: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: Specifies whether IAM user passwords must contain at least - one uppercase character (A to Z). - type: object - PasswordPolicyViolationException: {} - PermissionsBoundaryAttachmentType: - enum: - - PermissionsBoundaryPolicy - type: string - PermissionsBoundaryDecisionDetail: - description: Contains information about the effect that a permissions boundary - has on a policy simulation when the boundary is applied to an IAM entity. - properties: - AllowedByPermissionsBoundary: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: Specifies whether an action is allowed by a permissions boundary - that is applied to an IAM entity (user or role). A value of true - means that the permissions boundary does not deny the action. This means - that the policy includes an Allow statement that matches - the request. In this case, if an identity-based policy also allows the - action, the request is allowed. A value of false means - that either the requested action is not allowed (implicitly denied) - or that the action is explicitly denied by the permissions boundary. - In both of these cases, the action is not allowed, regardless of the - identity-based policy. - type: object - Policy: - description:

Contains information about a managed policy.

This data - type is used as a response element in the CreatePolicy, GetPolicy, - and ListPolicies operations.

For more information about managed - policies, refer to Managed - policies and inline policies in the IAM User Guide.

- properties: - Arn: - $ref: '#/components/schemas/arnType' - AttachmentCount: - allOf: - - $ref: '#/components/schemas/attachmentCountType' - - description: The number of entities (users, groups, and roles) that the - policy is attached to. - CreateDate: - allOf: - - $ref: '#/components/schemas/dateType' - - description: The date and time, in ISO - 8601 date-time format, when the policy was created. - DefaultVersionId: - allOf: - - $ref: '#/components/schemas/policyVersionIdType' - - description: The identifier for the version of the policy that is set - as the default version. - Description: - allOf: - - $ref: '#/components/schemas/policyDescriptionType' - - description:

A friendly description of the policy.

This element - is included in the response to the GetPolicy operation. It is - not included in the response to the ListPolicies operation.

- IsAttachable: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: Specifies whether the policy can be attached to an IAM user, - group, or role. - Path: - allOf: - - $ref: '#/components/schemas/policyPathType' - - description:

The path to the policy.

For more information about - paths, see IAM - identifiers in the IAM User Guide.

- PermissionsBoundaryUsageCount: - allOf: - - $ref: '#/components/schemas/attachmentCountType' - - description:

The number of entities (users and roles) for which the - policy is used to set the permissions boundary.

For more information - about permissions boundaries, see Permissions - boundaries for IAM identities in the IAM User Guide.

- PolicyId: - allOf: - - $ref: '#/components/schemas/idType' - - description:

The stable and unique string identifying the policy.

-

For more information about IDs, see IAM - identifiers in the IAM User Guide.

- PolicyName: - allOf: - - $ref: '#/components/schemas/policyNameType' - - description: The friendly name (not ARN) identifying the policy. - Tags: - allOf: - - $ref: '#/components/schemas/tagListType' - - description: A list of tags that are attached to the instance profile. - For more information about tagging, see Tagging - IAM resources in the IAM User Guide. - UpdateDate: - allOf: - - $ref: '#/components/schemas/dateType' - - description:

The date and time, in ISO - 8601 date-time format, when the policy was last updated.

When - a policy has only one version, this field contains the date and time - when the policy was created. When a policy has more than one version, - this field contains the date and time when the most recent policy version - was created.

- type: object - PolicyDetail: - description:

Contains information about an IAM policy, including the policy - document.

This data type is used as a response element in the GetAccountAuthorizationDetails - operation.

- properties: - PolicyDocument: - allOf: - - $ref: '#/components/schemas/policyDocumentType' - - description: The policy document. - PolicyName: - allOf: - - $ref: '#/components/schemas/policyNameType' - - description: The name of the policy. - type: object - PolicyEvaluationDecisionType: - enum: - - allowed - - explicitDeny - - implicitDeny - type: string - PolicyEvaluationException: {} - PolicyGrantingServiceAccess: - description:

Contains details about the permissions policies that are attached - to the specified identity (user, group, or role).

This data type is - an element of the ListPoliciesGrantingServiceAccessEntry object.

- properties: - EntityName: - allOf: - - $ref: '#/components/schemas/entityNameType' - - description:

The name of the entity (user or role) to which the inline - policy is attached.

This field is null for managed policies. - For more information about these policy types, see Managed - policies and inline policies in the IAM User Guide.

- EntityType: - allOf: - - $ref: '#/components/schemas/policyOwnerEntityType' - - description:

The type of entity (user or role) that used the policy - to access the service to which the inline policy is attached.

This - field is null for managed policies. For more information about these - policy types, see Managed - policies and inline policies in the IAM User Guide.

- PolicyArn: - $ref: '#/components/schemas/arnType' - PolicyName: - allOf: - - $ref: '#/components/schemas/policyNameType' - - description: The policy name. - PolicyType: - allOf: - - $ref: '#/components/schemas/policyType' - - description: The policy type. For more information about these policy - types, see Managed - policies and inline policies in the IAM User Guide. - required: - - PolicyName - - PolicyType - type: object - PolicyGroup: - description:

Contains information about a group that a managed policy is - attached to.

This data type is used as a response element in the ListEntitiesForPolicy - operation.

For more information about managed policies, refer to Managed - policies and inline policies in the IAM User Guide.

- properties: - GroupId: - allOf: - - $ref: '#/components/schemas/idType' - - description: The stable and unique string identifying the group. For more - information about IDs, see IAM - identifiers in the IAM User Guide. - GroupName: - allOf: - - $ref: '#/components/schemas/groupNameType' - - description: The name (friendly name, not ARN) identifying the group. - type: object - PolicyGroupListType: - items: - allOf: - - $ref: '#/components/schemas/PolicyGroup' - - xml: - name: member - type: array - PolicyIdentifierType: - type: string - PolicyNotAttachableException: {} - PolicyRole: - description:

Contains information about a role that a managed policy is attached - to.

This data type is used as a response element in the ListEntitiesForPolicy - operation.

For more information about managed policies, refer to Managed - policies and inline policies in the IAM User Guide.

- properties: - RoleId: - allOf: - - $ref: '#/components/schemas/idType' - - description: The stable and unique string identifying the role. For more - information about IDs, see IAM - identifiers in the IAM User Guide. - RoleName: - allOf: - - $ref: '#/components/schemas/roleNameType' - - description: The name (friendly name, not ARN) identifying the role. - type: object - PolicyRoleListType: - items: - allOf: - - $ref: '#/components/schemas/PolicyRole' - - xml: - name: member - type: array - PolicySourceType: - enum: - - user - - group - - role - - aws-managed - - user-managed - - resource - - none - type: string - PolicyUsageType: - description:

The policy usage type that indicates whether the policy is used - as a permissions policy or as the permissions boundary for an entity.

-

For more information about permissions boundaries, see Permissions - boundaries for IAM identities in the IAM User Guide.

- enum: - - PermissionsPolicy - - PermissionsBoundary - type: string - PolicyUser: - description:

Contains information about a user that a managed policy is attached - to.

This data type is used as a response element in the ListEntitiesForPolicy - operation.

For more information about managed policies, refer to Managed - policies and inline policies in the IAM User Guide.

- properties: - UserId: - allOf: - - $ref: '#/components/schemas/idType' - - description: The stable and unique string identifying the user. For more - information about IDs, see IAM - identifiers in the IAM User Guide. - UserName: - allOf: - - $ref: '#/components/schemas/userNameType' - - description: The name (friendly name, not ARN) identifying the user. - type: object - PolicyUserListType: - items: - allOf: - - $ref: '#/components/schemas/PolicyUser' - - xml: - name: member - type: array - PolicyVersion: - description:

Contains information about a version of a managed policy.

-

This data type is used as a response element in the CreatePolicyVersion, - GetPolicyVersion, ListPolicyVersions, and GetAccountAuthorizationDetails - operations.

For more information about managed policies, refer to - Managed - policies and inline policies in the IAM User Guide.

- properties: - CreateDate: - allOf: - - $ref: '#/components/schemas/dateType' - - description: The date and time, in ISO - 8601 date-time format, when the policy version was created. - Document: - allOf: - - $ref: '#/components/schemas/policyDocumentType' - - description:

The policy document.

The policy document is returned - in the response to the GetPolicyVersion and GetAccountAuthorizationDetails - operations. It is not returned in the response to the CreatePolicyVersion - or ListPolicyVersions operations.

The policy document - returned in this structure is URL-encoded compliant with RFC - 3986. You can use a URL decoding method to convert the policy back - to plain JSON text. For example, if you use Java, you can use the decode - method of the java.net.URLDecoder utility class in the - Java SDK. Other languages and SDKs provide similar functionality.

- IsDefaultVersion: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: Specifies whether the policy version is set as the policy's - default version. - VersionId: - allOf: - - $ref: '#/components/schemas/policyVersionIdType' - - description:

The identifier for the policy version.

Policy version - identifiers always begin with v (always lowercase). When - a policy is created, the first policy version is v1.

- type: object - Position: - description:

Contains the row and column of a location of a Statement - element in a policy document.

This data type is used as a member of - the Statement type.

- properties: - Column: - allOf: - - $ref: '#/components/schemas/ColumnNumber' - - description: The column in the line containing the specified position - in the document. - Line: - allOf: - - $ref: '#/components/schemas/LineNumber' - - description: The line containing the specified position in the document. - type: object - PutGroupPolicyRequest: - properties: - GroupName: - allOf: - - $ref: '#/components/schemas/groupNameType' - - description: '

The name of the group to associate the policy with.

-

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-.

' - PolicyDocument: - allOf: - - $ref: '#/components/schemas/policyDocumentType' - - description:

The policy document.

You must provide policies - in JSON format in IAM. However, for CloudFormation templates formatted - in YAML, you can provide the policy in JSON or YAML format. CloudFormation - always converts a YAML policy to JSON format before submitting it to - = IAM.

The regex pattern - used to validate this parameter is a string of characters consisting - of the following:

  • Any printable ASCII character ranging - from the space character (\u0020) through the end of the - ASCII character range

  • The printable characters in - the Basic Latin and Latin-1 Supplement character set (through \u00FF)

    -

  • The special characters tab (\u0009), line - feed (\u000A), and carriage return (\u000D)

    -
- PolicyName: - allOf: - - $ref: '#/components/schemas/policyNameType' - - description: '

The name of the policy document.

This parameter - allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - required: - - GroupName - - PolicyName - - PolicyDocument - title: PutGroupPolicyRequest - type: object - PutRolePermissionsBoundaryRequest: - properties: - PermissionsBoundary: - allOf: - - $ref: '#/components/schemas/arnType' - - description: The ARN of the policy that is used to set the permissions - boundary for the role. - RoleName: - allOf: - - $ref: '#/components/schemas/roleNameType' - - description: The name (friendly name, not ARN) of the IAM role for which - you want to set the permissions boundary. - required: - - RoleName - - PermissionsBoundary - title: PutRolePermissionsBoundaryRequest - type: object - PutRolePolicyRequest: - properties: - PolicyDocument: - allOf: - - $ref: '#/components/schemas/policyDocumentType' - - description:

The policy document.

You must provide policies - in JSON format in IAM. However, for CloudFormation templates formatted - in YAML, you can provide the policy in JSON or YAML format. CloudFormation - always converts a YAML policy to JSON format before submitting it to - IAM.

The regex pattern - used to validate this parameter is a string of characters consisting - of the following:

  • Any printable ASCII character ranging - from the space character (\u0020) through the end of the - ASCII character range

  • The printable characters in - the Basic Latin and Latin-1 Supplement character set (through \u00FF)

    -

  • The special characters tab (\u0009), line - feed (\u000A), and carriage return (\u000D)

    -
- PolicyName: - allOf: - - $ref: '#/components/schemas/policyNameType' - - description: '

The name of the policy document.

This parameter - allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - RoleName: - allOf: - - $ref: '#/components/schemas/roleNameType' - - description: '

The name of the role to associate the policy with.

-

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - required: - - RoleName - - PolicyName - - PolicyDocument - title: PutRolePolicyRequest - type: object - PutUserPermissionsBoundaryRequest: - properties: - PermissionsBoundary: - allOf: - - $ref: '#/components/schemas/arnType' - - description: The ARN of the policy that is used to set the permissions - boundary for the user. - UserName: - allOf: - - $ref: '#/components/schemas/userNameType' - - description: The name (friendly name, not ARN) of the IAM user for which - you want to set the permissions boundary. - required: - - UserName - - PermissionsBoundary - title: PutUserPermissionsBoundaryRequest - type: object - PutUserPolicyRequest: - properties: - PolicyDocument: - allOf: - - $ref: '#/components/schemas/policyDocumentType' - - description:

The policy document.

You must provide policies - in JSON format in IAM. However, for CloudFormation templates formatted - in YAML, you can provide the policy in JSON or YAML format. CloudFormation - always converts a YAML policy to JSON format before submitting it to - IAM.

The regex pattern - used to validate this parameter is a string of characters consisting - of the following:

  • Any printable ASCII character ranging - from the space character (\u0020) through the end of the - ASCII character range

  • The printable characters in - the Basic Latin and Latin-1 Supplement character set (through \u00FF)

    -

  • The special characters tab (\u0009), line - feed (\u000A), and carriage return (\u000D)

    -
- PolicyName: - allOf: - - $ref: '#/components/schemas/policyNameType' - - description: '

The name of the policy document.

This parameter - allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - UserName: - allOf: - - $ref: '#/components/schemas/existingUserNameType' - - description: '

The name of the user to associate the policy with.

-

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - required: - - UserName - - PolicyName - - PolicyDocument - title: PutUserPolicyRequest - type: object - ReasonType: - maxLength: 1000 - type: string - RegionNameType: - maxLength: 100 - minLength: 1 - type: string - RemoveClientIDFromOpenIDConnectProviderRequest: - properties: - ClientID: - allOf: - - $ref: '#/components/schemas/clientIDType' - - description: The client ID (also known as audience) to remove from the - IAM OIDC provider resource. For more information about client IDs, see - CreateOpenIDConnectProvider. - OpenIDConnectProviderArn: - allOf: - - $ref: '#/components/schemas/arnType' - - description:

The Amazon Resource Name (ARN) of the IAM OIDC provider - resource to remove the client ID from. You can get a list of OIDC provider - ARNs by using the ListOpenIDConnectProviders operation.

For - more information about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.

- required: - - OpenIDConnectProviderArn - - ClientID - title: RemoveClientIDFromOpenIDConnectProviderRequest - type: object - RemoveRoleFromInstanceProfileRequest: - properties: - InstanceProfileName: - allOf: - - $ref: '#/components/schemas/instanceProfileNameType' - - description: '

The name of the instance profile to update.

This - parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - RoleName: - allOf: - - $ref: '#/components/schemas/roleNameType' - - description: '

The name of the role to remove.

This parameter - allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - required: - - InstanceProfileName - - RoleName - title: RemoveRoleFromInstanceProfileRequest - type: object - RemoveUserFromGroupRequest: - properties: - GroupName: - allOf: - - $ref: '#/components/schemas/groupNameType' - - description: '

The name of the group to update.

This parameter - allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - UserName: - allOf: - - $ref: '#/components/schemas/existingUserNameType' - - description: '

The name of the user to remove.

This parameter - allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - required: - - GroupName - - UserName - title: RemoveUserFromGroupRequest - type: object - ReportContentType: - type: string - ReportFormatType: - enum: - - text/csv - type: string - ReportGenerationLimitExceededException: {} - ReportStateDescriptionType: - type: string - ReportStateType: - enum: - - STARTED - - INPROGRESS - - COMPLETE - type: string - ResetServiceSpecificCredentialRequest: - properties: - ServiceSpecificCredentialId: - allOf: - - $ref: '#/components/schemas/serviceSpecificCredentialId' - - description:

The unique identifier of the service-specific credential.

-

This parameter allows (through its regex - pattern) a string of characters that can consist of any upper or - lowercased letter or digit.

- UserName: - allOf: - - $ref: '#/components/schemas/userNameType' - - description: '

The name of the IAM user associated with the service-specific - credential. If this value is not specified, then the operation assumes - the user whose credentials are used to call the operation.

This - parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - required: - - ServiceSpecificCredentialId - title: ResetServiceSpecificCredentialRequest - type: object - ResetServiceSpecificCredentialResponse: - properties: - ServiceSpecificCredential: - allOf: - - $ref: '#/components/schemas/ServiceSpecificCredential' - - description:

A structure with details about the updated service-specific - credential, including the new password.

This is the - only time that you can access the password. You cannot recover - the password later, but you can reset it again.

 - type: object - ResourceHandlingOptionType: - maxLength: 64 - minLength: 1 - type: string - ResourceNameListType: - items: - allOf: - - $ref: '#/components/schemas/ResourceNameType' - - xml: - name: member - type: array - ResourceNameType: - maxLength: 2048 - minLength: 1 - type: string - ResourceSpecificResult: - description:

Contains the result of the simulation of a single API operation - call on a single resource.

This data type is used by a member of the - EvaluationResult data type.

- properties: - EvalDecisionDetails: - allOf: - - $ref: '#/components/schemas/EvalDecisionDetailsType' - - description: Additional details about the results of the evaluation decision - on a single resource. This parameter is returned only for cross-account - simulations. This parameter explains how each policy type contributes - to the resource-specific evaluation decision. - EvalResourceDecision: - allOf: - - $ref: '#/components/schemas/PolicyEvaluationDecisionType' - - description: The result of the simulation of the simulated API operation - on the resource specified in EvalResourceName. - EvalResourceName: - allOf: - - $ref: '#/components/schemas/ResourceNameType' - - description: The name of the simulated resource, in Amazon Resource Name - (ARN) format. - MatchedStatements: - allOf: - - $ref: '#/components/schemas/StatementListType' - - description: A list of the statements in the input policies that determine - the result for this part of the simulation. Remember that even if multiple - statements allow the operation on the resource, if any statement - denies that operation, then the explicit deny overrides any allow. In - addition, the deny statement is the only entry included in the result. - MissingContextValues: - allOf: - - $ref: '#/components/schemas/ContextKeyNamesResultListType' - - description: A list of context keys that are required by the included - input policies but that were not provided by one of the input parameters. - This list is used when a list of ARNs is included in the ResourceArns - parameter instead of "*". If you do not specify individual resources, - by setting ResourceArns to "*" or by not including the - ResourceArns parameter, then any missing context values - are instead included under the EvaluationResults section. - To discover the context keys used by a set of policies, you can call - GetContextKeysForCustomPolicy or GetContextKeysForPrincipalPolicy. - PermissionsBoundaryDecisionDetail: - allOf: - - $ref: '#/components/schemas/PermissionsBoundaryDecisionDetail' - - description: Contains information about the effect that a permissions - boundary has on a policy simulation when that boundary is applied to - an IAM entity. - required: - - EvalResourceName - - EvalResourceDecision - type: object - ResourceSpecificResultListType: - items: - allOf: - - $ref: '#/components/schemas/ResourceSpecificResult' - - xml: - name: member - type: array - ResyncMFADeviceRequest: - properties: - AuthenticationCode1: - allOf: - - $ref: '#/components/schemas/authenticationCodeType' - - description:

An authentication code emitted by the device.

The - format for this parameter is a sequence of six digits.

- AuthenticationCode2: - allOf: - - $ref: '#/components/schemas/authenticationCodeType' - - description:

A subsequent authentication code emitted by the device.

-

The format for this parameter is a sequence of six digits.

- SerialNumber: - allOf: - - $ref: '#/components/schemas/serialNumberType' - - description: '

Serial number that uniquely identifies the MFA device.

-

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - UserName: - allOf: - - $ref: '#/components/schemas/existingUserNameType' - - description: '

The name of the user whose MFA device you want to resynchronize.

-

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - required: - - UserName - - SerialNumber - - AuthenticationCode1 - - AuthenticationCode2 - title: ResyncMFADeviceRequest - type: object - Role: - description: Contains information about an IAM role. This structure is returned - as a response element in several API operations that interact with roles. - properties: - Arn: - allOf: - - $ref: '#/components/schemas/arnType' - - description: ' The Amazon Resource Name (ARN) specifying the role. For - more information about ARNs and how to use them in policies, see IAM - identifiers in the IAM User Guide guide. ' - AssumeRolePolicyDocument: - allOf: - - $ref: '#/components/schemas/policyDocumentType' - - description: The policy that grants an entity permission to assume the - role. - CreateDate: - allOf: - - $ref: '#/components/schemas/dateType' - - description: The date and time, in ISO - 8601 date-time format, when the role was created. - Description: - allOf: - - $ref: '#/components/schemas/roleDescriptionType' - - description: A description of the role that you provide. - MaxSessionDuration: - allOf: - - $ref: '#/components/schemas/roleMaxSessionDurationType' - - description: The maximum session duration (in seconds) for the specified - role. Anyone who uses the CLI, or API to assume the role can specify - the duration using the optional DurationSeconds API parameter - or duration-seconds CLI parameter. - Path: - allOf: - - $ref: '#/components/schemas/pathType' - - description: ' The path to the role. For more information about paths, - see IAM - identifiers in the IAM User Guide. ' - PermissionsBoundary: - allOf: - - $ref: '#/components/schemas/AttachedPermissionsBoundary' - - description:

The ARN of the policy used to set the permissions boundary - for the role.

For more information about permissions boundaries, - see Permissions - boundaries for IAM identities in the IAM User Guide.

- RoleId: - allOf: - - $ref: '#/components/schemas/idType' - - description: ' The stable and unique string identifying the role. For - more information about IDs, see IAM - identifiers in the IAM User Guide. ' - RoleLastUsed: - allOf: - - $ref: '#/components/schemas/RoleLastUsed' - - description: Contains information about the last time that an IAM role - was used. This includes the date and time and the Region in which the - role was last used. Activity is only reported for the trailing 400 days. - This period can be shorter if your Region began supporting these features - within the last year. The role might have been used more than 400 days - ago. For more information, see Regions - where data is tracked in the IAM User Guide. - RoleName: - allOf: - - $ref: '#/components/schemas/roleNameType' - - description: The friendly name that identifies the role. - Tags: - allOf: - - $ref: '#/components/schemas/tagListType' - - description: A list of tags that are attached to the role. For more information - about tagging, see Tagging - IAM resources in the IAM User Guide. - required: - - Path - - RoleName - - RoleId - - Arn - - CreateDate - type: object - RoleDetail: - description:

Contains information about an IAM role, including all of the - role's policies.

This data type is used as a response element in the - GetAccountAuthorizationDetails operation.

- properties: - Arn: - $ref: '#/components/schemas/arnType' - AssumeRolePolicyDocument: - allOf: - - $ref: '#/components/schemas/policyDocumentType' - - description: The trust policy that grants permission to assume the role. - AttachedManagedPolicies: - allOf: - - $ref: '#/components/schemas/attachedPoliciesListType' - - description: A list of managed policies attached to the role. These policies - are the role's access (permissions) policies. - CreateDate: - allOf: - - $ref: '#/components/schemas/dateType' - - description: The date and time, in ISO - 8601 date-time format, when the role was created. - InstanceProfileList: - allOf: - - $ref: '#/components/schemas/instanceProfileListType' - - description: A list of instance profiles that contain this role. - Path: - allOf: - - $ref: '#/components/schemas/pathType' - - description: The path to the role. For more information about paths, see - IAM - identifiers in the IAM User Guide. - PermissionsBoundary: - allOf: - - $ref: '#/components/schemas/AttachedPermissionsBoundary' - - description:

The ARN of the policy used to set the permissions boundary - for the role.

For more information about permissions boundaries, - see Permissions - boundaries for IAM identities in the IAM User Guide.

- RoleId: - allOf: - - $ref: '#/components/schemas/idType' - - description: The stable and unique string identifying the role. For more - information about IDs, see IAM - identifiers in the IAM User Guide. - RoleLastUsed: - allOf: - - $ref: '#/components/schemas/RoleLastUsed' - - description: Contains information about the last time that an IAM role - was used. This includes the date and time and the Region in which the - role was last used. Activity is only reported for the trailing 400 days. - This period can be shorter if your Region began supporting these features - within the last year. The role might have been used more than 400 days - ago. For more information, see Regions - where data is tracked in the IAM User Guide. - RoleName: - allOf: - - $ref: '#/components/schemas/roleNameType' - - description: The friendly name that identifies the role. - RolePolicyList: - allOf: - - $ref: '#/components/schemas/policyDetailListType' - - description: A list of inline policies embedded in the role. These policies - are the role's access (permissions) policies. - Tags: - allOf: - - $ref: '#/components/schemas/tagListType' - - description: A list of tags that are attached to the role. For more information - about tagging, see Tagging - IAM resources in the IAM User Guide. - type: object - RoleLastUsed: - description:

Contains information about the last time that an IAM role was - used. This includes the date and time and the Region in which the role was - last used. Activity is only reported for the trailing 400 days. This period - can be shorter if your Region began supporting these features within the last - year. The role might have been used more than 400 days ago. For more information, - see Regions - where data is tracked in the IAM User Guide.

This data type - is returned as a response element in the GetRole and GetAccountAuthorizationDetails - operations.

- properties: - LastUsedDate: - allOf: - - $ref: '#/components/schemas/dateType' - - description: "

The date and time, in\_ISO 8601 date-time format that the role was last used.

This\ - \ field is null if the role has not been used within the IAM tracking\ - \ period. For more information about the tracking period, see Regions where data is tracked in the IAM User Guide.

" - Region: - allOf: - - $ref: '#/components/schemas/stringType' - - description: The name of the Amazon Web Services Region in which the role - was last used. - type: object - RoleUsageListType: - items: - allOf: - - $ref: '#/components/schemas/RoleUsageType' - - xml: - name: member - type: array - RoleUsageType: - description:

An object that contains details about how a service-linked role - is used, if that information is returned by the service.

This data - type is used as a response element in the GetServiceLinkedRoleDeletionStatus - operation.

- properties: - Region: - allOf: - - $ref: '#/components/schemas/RegionNameType' - - description: The name of the Region where the service-linked role is being - used. - Resources: - allOf: - - $ref: '#/components/schemas/ArnListType' - - description: The name of the resource that is using the service-linked - role. - type: object - SAMLMetadataDocumentType: - maxLength: 10000000 - minLength: 1000 - type: string - SAMLProviderListEntry: - description: Contains the list of SAML providers for this account. - properties: - Arn: - allOf: - - $ref: '#/components/schemas/arnType' - - description: The Amazon Resource Name (ARN) of the SAML provider. - CreateDate: - allOf: - - $ref: '#/components/schemas/dateType' - - description: The date and time when the SAML provider was created. - ValidUntil: - allOf: - - $ref: '#/components/schemas/dateType' - - description: The expiration date and time for the SAML provider. - type: object - SAMLProviderListType: - items: - allOf: - - $ref: '#/components/schemas/SAMLProviderListEntry' - - xml: - name: member - type: array - SAMLProviderNameType: - maxLength: 128 - minLength: 1 - pattern: '[\w._-]+' - type: string - SSHPublicKey: - description:

Contains information about an SSH public key.

This data - type is used as a response element in the GetSSHPublicKey and UploadSSHPublicKey - operations.

- properties: - Fingerprint: - allOf: - - $ref: '#/components/schemas/publicKeyFingerprintType' - - description: The MD5 message digest of the SSH public key. - SSHPublicKeyBody: - allOf: - - $ref: '#/components/schemas/publicKeyMaterialType' - - description: The SSH public key. - SSHPublicKeyId: - allOf: - - $ref: '#/components/schemas/publicKeyIdType' - - description: The unique identifier for the SSH public key. - Status: - allOf: - - $ref: '#/components/schemas/statusType' - - description: The status of the SSH public key. Active means - that the key can be used for authentication with an CodeCommit repository. - Inactive means that the key cannot be used. - UploadDate: - allOf: - - $ref: '#/components/schemas/dateType' - - description: The date and time, in ISO - 8601 date-time format, when the SSH public key was uploaded. - UserName: - allOf: - - $ref: '#/components/schemas/userNameType' - - description: The name of the IAM user associated with the SSH public key. - required: - - UserName - - SSHPublicKeyId - - Fingerprint - - SSHPublicKeyBody - - Status - type: object - SSHPublicKeyListType: - items: - allOf: - - $ref: '#/components/schemas/SSHPublicKeyMetadata' - - xml: - name: member - type: array - SSHPublicKeyMetadata: - description:

Contains information about an SSH public key, without the key's - body or fingerprint.

This data type is used as a response element in - the ListSSHPublicKeys operation.

- properties: - SSHPublicKeyId: - allOf: - - $ref: '#/components/schemas/publicKeyIdType' - - description: The unique identifier for the SSH public key. - Status: - allOf: - - $ref: '#/components/schemas/statusType' - - description: The status of the SSH public key. Active means - that the key can be used for authentication with an CodeCommit repository. - Inactive means that the key cannot be used. - UploadDate: - allOf: - - $ref: '#/components/schemas/dateType' - - description: The date and time, in ISO - 8601 date-time format, when the SSH public key was uploaded. - UserName: - allOf: - - $ref: '#/components/schemas/userNameType' - - description: The name of the IAM user associated with the SSH public key. - required: - - UserName - - SSHPublicKeyId - - Status - - UploadDate - type: object - ServerCertificate: - description:

Contains information about a server certificate.

This - data type is used as a response element in the GetServerCertificate - operation.

- properties: - CertificateBody: - allOf: - - $ref: '#/components/schemas/certificateBodyType' - - description: The contents of the public key certificate. - CertificateChain: - allOf: - - $ref: '#/components/schemas/certificateChainType' - - description: The contents of the public key certificate chain. - ServerCertificateMetadata: - allOf: - - $ref: '#/components/schemas/ServerCertificateMetadata' - - description: The meta information of the server certificate, such as its - name, path, ID, and ARN. - Tags: - allOf: - - $ref: '#/components/schemas/tagListType' - - description: A list of tags that are attached to the server certificate. - For more information about tagging, see Tagging - IAM resources in the IAM User Guide. - required: - - ServerCertificateMetadata - - CertificateBody - type: object - ServerCertificateMetadata: - description:

Contains information about a server certificate without its - certificate body, certificate chain, and private key.

This data type - is used as a response element in the UploadServerCertificate and ListServerCertificates - operations.

- properties: - Arn: - allOf: - - $ref: '#/components/schemas/arnType' - - description: ' The Amazon Resource Name (ARN) specifying the server certificate. - For more information about ARNs and how to use them in policies, see - IAM - identifiers in the IAM User Guide. ' - Expiration: - allOf: - - $ref: '#/components/schemas/dateType' - - description: The date on which the certificate is set to expire. - Path: - allOf: - - $ref: '#/components/schemas/pathType' - - description: ' The path to the server certificate. For more information - about paths, see IAM - identifiers in the IAM User Guide. ' - ServerCertificateId: - allOf: - - $ref: '#/components/schemas/idType' - - description: ' The stable and unique string identifying the server certificate. - For more information about IDs, see IAM - identifiers in the IAM User Guide. ' - ServerCertificateName: - allOf: - - $ref: '#/components/schemas/serverCertificateNameType' - - description: The name that identifies the server certificate. - UploadDate: - allOf: - - $ref: '#/components/schemas/dateType' - - description: The date when the server certificate was uploaded. - required: - - Path - - ServerCertificateName - - ServerCertificateId - - Arn - type: object - ServiceFailureException: {} - ServiceLastAccessed: - description:

Contains details about the most recent attempt to access the - service.

This data type is used as a response element in the GetServiceLastAccessedDetails - operation.

- properties: - LastAuthenticated: - allOf: - - $ref: '#/components/schemas/dateType' - - description: "

The date and time, in\_ISO 8601 date-time format, when an authenticated entity most recently\ - \ attempted to access the service. Amazon Web Services does not report\ - \ unauthenticated requests.

This field is null if no IAM entities\ - \ attempted to access the service within the reporting period.

" - LastAuthenticatedEntity: - allOf: - - $ref: '#/components/schemas/arnType' - - description:

The ARN of the authenticated entity (user or role) that - last attempted to access the service. Amazon Web Services does not report - unauthenticated requests.

This field is null if no IAM entities - attempted to access the service within the reporting - period.

- LastAuthenticatedRegion: - allOf: - - $ref: '#/components/schemas/stringType' - - description:

The Region from which the authenticated entity (user or - role) last attempted to access the service. Amazon Web Services does - not report unauthenticated requests.

This field is null if no - IAM entities attempted to access the service within the reporting - period.

- ServiceName: - allOf: - - $ref: '#/components/schemas/serviceNameType' - - description: The name of the service in which access was attempted. - ServiceNamespace: - allOf: - - $ref: '#/components/schemas/serviceNamespaceType' - - description: "

The namespace of the service in which access was attempted.

\ - \

To learn the service namespace of a service, see Actions, resources, and condition keys for Amazon Web Services services\ - \ in the Service Authorization Reference. Choose the name of\ - \ the service to view details for that service. In the first paragraph,\ - \ find the service prefix. For example, (service prefix: a4b).\ - \ For more information about service namespaces, see Amazon Web Services Service Namespaces in the\_Amazon Web Services\ - \ General Reference.

" - TotalAuthenticatedEntities: - allOf: - - $ref: '#/components/schemas/integerType' - - description:

The total number of authenticated principals (root user, - IAM users, or IAM roles) that have attempted to access the service.

-

This field is null if no principals attempted to access the service - within the reporting - period.

- TrackedActionsLastAccessed: - allOf: - - $ref: '#/components/schemas/TrackedActionsLastAccessed' - - description:

An object that contains details about the most recent - attempt to access a tracked action within the service.

This field - is null if there no tracked actions or if the principal did not use - the tracked actions within the reporting - period. This field is also null if the report was generated at the - service level and not the action level. For more information, see the - Granularity field in GenerateServiceLastAccessedDetails.

- required: - - ServiceName - - ServiceNamespace - type: object - ServiceNotSupportedException: {} - ServiceSpecificCredential: - description: Contains the details of a service-specific credential. - properties: - CreateDate: - allOf: - - $ref: '#/components/schemas/dateType' - - description: The date and time, in ISO - 8601 date-time format, when the service-specific credential were - created. - ServiceName: - allOf: - - $ref: '#/components/schemas/serviceName' - - description: The name of the service associated with the service-specific - credential. - ServicePassword: - allOf: - - $ref: '#/components/schemas/servicePassword' - - description: The generated password for the service-specific credential. - ServiceSpecificCredentialId: - allOf: - - $ref: '#/components/schemas/serviceSpecificCredentialId' - - description: The unique identifier for the service-specific credential. - ServiceUserName: - allOf: - - $ref: '#/components/schemas/serviceUserName' - - description: The generated user name for the service-specific credential. - This value is generated by combining the IAM user's name combined with - the ID number of the Amazon Web Services account, as in jane-at-123456789012, - for example. This value cannot be configured by the user. - Status: - allOf: - - $ref: '#/components/schemas/statusType' - - description: The status of the service-specific credential. Active - means that the key is valid for API calls, while Inactive - means it is not. - UserName: - allOf: - - $ref: '#/components/schemas/userNameType' - - description: The name of the IAM user associated with the service-specific - credential. - required: - - CreateDate - - ServiceName - - ServiceUserName - - ServicePassword - - ServiceSpecificCredentialId - - UserName - - Status - type: object - ServiceSpecificCredentialMetadata: - description: Contains additional details about a service-specific credential. - properties: - CreateDate: - allOf: - - $ref: '#/components/schemas/dateType' - - description: The date and time, in ISO - 8601 date-time format, when the service-specific credential were - created. - ServiceName: - allOf: - - $ref: '#/components/schemas/serviceName' - - description: The name of the service associated with the service-specific - credential. - ServiceSpecificCredentialId: - allOf: - - $ref: '#/components/schemas/serviceSpecificCredentialId' - - description: The unique identifier for the service-specific credential. - ServiceUserName: - allOf: - - $ref: '#/components/schemas/serviceUserName' - - description: The generated user name for the service-specific credential. - Status: - allOf: - - $ref: '#/components/schemas/statusType' - - description: The status of the service-specific credential. Active - means that the key is valid for API calls, while Inactive - means it is not. - UserName: - allOf: - - $ref: '#/components/schemas/userNameType' - - description: The name of the IAM user associated with the service-specific - credential. - required: - - UserName - - Status - - ServiceUserName - - CreateDate - - ServiceSpecificCredentialId - - ServiceName - type: object - ServiceSpecificCredentialsListType: - items: - allOf: - - $ref: '#/components/schemas/ServiceSpecificCredentialMetadata' - - xml: - name: member - type: array - ServicesLastAccessed: - items: - allOf: - - $ref: '#/components/schemas/ServiceLastAccessed' - - xml: - name: member - type: array - SetDefaultPolicyVersionRequest: - properties: - PolicyArn: - allOf: - - $ref: '#/components/schemas/arnType' - - description:

The Amazon Resource Name (ARN) of the IAM policy whose - default version you want to set.

For more information about ARNs, - see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.

- VersionId: - allOf: - - $ref: '#/components/schemas/policyVersionIdType' - - description:

The version of the policy to set as the default (operative) - version.

For more information about managed policy versions, - see Versioning - for managed policies in the IAM User Guide.

- required: - - PolicyArn - - VersionId - title: SetDefaultPolicyVersionRequest - type: object - SetSecurityTokenServicePreferencesRequest: - properties: - GlobalEndpointTokenVersion: - allOf: - - $ref: '#/components/schemas/globalEndpointTokenVersion' - - description:

The version of the global endpoint token. Version 1 tokens - are valid only in Amazon Web Services Regions that are available by - default. These tokens do not work in manually enabled Regions, such - as Asia Pacific (Hong Kong). Version 2 tokens are valid in all Regions. - However, version 2 tokens are longer and might affect systems where - you temporarily store tokens.

For information, see Activating - and deactivating STS in an Amazon Web Services Region in the IAM - User Guide.

- required: - - GlobalEndpointTokenVersion - title: SetSecurityTokenServicePreferencesRequest - type: object - SigningCertificate: - description:

Contains information about an X.509 signing certificate.

-

This data type is used as a response element in the UploadSigningCertificate - and ListSigningCertificates operations.

- properties: - CertificateBody: - allOf: - - $ref: '#/components/schemas/certificateBodyType' - - description: The contents of the signing certificate. - CertificateId: - allOf: - - $ref: '#/components/schemas/certificateIdType' - - description: The ID for the signing certificate. - Status: - allOf: - - $ref: '#/components/schemas/statusType' - - description: The status of the signing certificate. Active - means that the key is valid for API calls, while Inactive - means it is not. - UploadDate: - allOf: - - $ref: '#/components/schemas/dateType' - - description: The date when the signing certificate was uploaded. - UserName: - allOf: - - $ref: '#/components/schemas/userNameType' - - description: The name of the user the signing certificate is associated - with. - required: - - UserName - - CertificateId - - CertificateBody - - Status - type: object - SimulateCustomPolicyRequest: - properties: - ActionNames: - allOf: - - $ref: '#/components/schemas/ActionNameListType' - - description: A list of names of API operations to evaluate in the simulation. - Each operation is evaluated against each resource. Each operation must - include the service identifier, such as iam:CreateUser. - This operation does not support using wildcards (*) in an action name. - CallerArn: - allOf: - - $ref: '#/components/schemas/ResourceNameType' - - description:

The ARN of the IAM user that you want to use as the simulated - caller of the API operations. CallerArn is required if - you include a ResourcePolicy so that the policy's Principal - element has a value to use in evaluating the policy.

You can - specify only the ARN of an IAM user. You cannot specify the ARN of an - assumed role, federated user, or a service principal.

- ContextEntries: - allOf: - - $ref: '#/components/schemas/ContextEntryListType' - - description: A list of context keys and corresponding values for the simulation - to use. Whenever a context key is evaluated in one of the simulated - IAM permissions policies, the corresponding value is supplied. - Marker: - allOf: - - $ref: '#/components/schemas/markerType' - - description: Use this parameter only when paginating results and only - after you receive a response indicating that the results are truncated. - Set it to the value of the Marker element in the response - that you received to indicate where the next call should start. - MaxItems: - allOf: - - $ref: '#/components/schemas/maxItemsType' - - description:

Use this only when paginating results to indicate the - maximum number of items you want in the response. If additional items - exist beyond the maximum you specify, the IsTruncated response - element is true.

If you do not include this parameter, - the number of items defaults to 100. Note that IAM might return fewer - results, even when there are more results available. In that case, the - IsTruncated response element returns true, - and Marker contains a value to include in the subsequent - call that tells the service where to continue from.

- PermissionsBoundaryPolicyInputList: - allOf: - - $ref: '#/components/schemas/SimulationPolicyListType' - - description:

The IAM permissions boundary policy to simulate. The permissions - boundary sets the maximum permissions that an IAM entity can have. You - can input only one permissions boundary when you pass a policy to this - operation. For more information about permissions boundaries, see Permissions - boundaries for IAM entities in the IAM User Guide. The policy - input is specified as a string that contains the complete, valid JSON - text of a permissions boundary policy.

The maximum length of - the policy document that you can pass in this operation, including whitespace, - is listed below. To view the maximum character counts of a managed policy - with no whitespaces, see IAM - and STS character quotas.

The regex - pattern used to validate this parameter is a string of characters - consisting of the following:

  • Any printable ASCII character - ranging from the space character (\u0020) through the end - of the ASCII character range

  • The printable characters - in the Basic Latin and Latin-1 Supplement character set (through \u00FF)

    -

  • The special characters tab (\u0009), line - feed (\u000A), and carriage return (\u000D)

    -
- PolicyInputList: - allOf: - - $ref: '#/components/schemas/SimulationPolicyListType' - - description:

A list of policy documents to include in the simulation. - Each document is specified as a string containing the complete, valid - JSON text of an IAM policy. Do not include any resource-based policies - in this parameter. Any resource-based policy must be submitted with - the ResourcePolicy parameter. The policies cannot be "scope-down" - policies, such as you could include in a call to GetFederationToken - or one of the AssumeRole - API operations. In other words, do not use policies designed to restrict - what a user can do while using the temporary credentials.

The - maximum length of the policy document that you can pass in this operation, - including whitespace, is listed below. To view the maximum character - counts of a managed policy with no whitespaces, see IAM - and STS character quotas.

The regex - pattern used to validate this parameter is a string of characters - consisting of the following:

  • Any printable ASCII character - ranging from the space character (\u0020) through the end - of the ASCII character range

  • The printable characters - in the Basic Latin and Latin-1 Supplement character set (through \u00FF)

    -

  • The special characters tab (\u0009), line - feed (\u000A), and carriage return (\u000D)

    -
- ResourceArns: - allOf: - - $ref: '#/components/schemas/ResourceNameListType' - - description:

A list of ARNs of Amazon Web Services resources to include - in the simulation. If this parameter is not provided, then the value - defaults to * (all resources). Each API in the ActionNames - parameter is evaluated for each resource in this list. The simulation - determines the access result (allowed or denied) of each combination - and reports it in the response. You can simulate resources that don't - exist in your account.

The simulation does not automatically - retrieve policies for the specified resources. If you want to include - a resource policy in the simulation, then you must include the policy - as a string in the ResourcePolicy parameter.

If - you include a ResourcePolicy, then it must be applicable - to all of the resources included in the simulation or you receive an - invalid input error.

For more information about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.

- ResourceHandlingOption: - allOf: - - $ref: '#/components/schemas/ResourceHandlingOptionType' - - description:

Specifies the type of simulation to run. Different API - operations that support resource-based policies require different combinations - of resources. By specifying the type of simulation to run, you enable - the policy simulator to enforce the presence of the required resources - to ensure reliable simulation results. If your simulation does not match - one of the following scenarios, then you can omit this parameter. The - following list shows each of the supported scenario values and the resources - that you must define to run the simulation.

Each of the EC2 scenarios - requires that you specify instance, image, and security-group resources. - If your scenario includes an EBS volume, then you must specify that - volume as a resource. If the EC2 scenario includes VPC, then you must - supply the network-interface resource. If it includes an IP subnet, - then you must specify the subnet resource. For more information on the - EC2 scenario options, see Supported - platforms in the Amazon EC2 User Guide.

  • - EC2-Classic-InstanceStore

    instance, image, security-group

    -

  • EC2-Classic-EBS

    instance, image, security-group, - volume

  • EC2-VPC-InstanceStore

    instance, - image, security-group, network-interface

  • EC2-VPC-InstanceStore-Subnet -

    instance, image, security-group, network-interface, subnet

    -

  • EC2-VPC-EBS

    instance, image, security-group, - network-interface, volume

  • EC2-VPC-EBS-Subnet -

    instance, image, security-group, network-interface, subnet, - volume

- ResourceOwner: - allOf: - - $ref: '#/components/schemas/ResourceNameType' - - description: '

An ARN representing the Amazon Web Services account ID - that specifies the owner of any simulated resource that does not identify - its owner in the resource ARN. Examples of resource ARNs include an - S3 bucket or object. If ResourceOwner is specified, it - is also used as the account owner of any ResourcePolicy - included in the simulation. If the ResourceOwner parameter - is not specified, then the owner of the resources and the resource policy - defaults to the account of the identity provided in CallerArn. - This parameter is required only if you specify a resource-based policy - and account that owns the resource is different from the account that - owns the simulated calling user CallerArn.

The ARN - for an account uses the following syntax: arn:aws:iam::AWS-account-ID:root. - For example, to represent the account with the 112233445566 ID, use - the following ARN: arn:aws:iam::112233445566-ID:root.

' - ResourcePolicy: - allOf: - - $ref: '#/components/schemas/policyDocumentType' - - description:

A resource-based policy to include in the simulation provided - as a string. Each resource in the simulation is treated as if it had - this policy attached. You can include only one resource-based policy - in a simulation.

The maximum length of the policy document that - you can pass in this operation, including whitespace, is listed below. - To view the maximum character counts of a managed policy with no whitespaces, - see IAM - and STS character quotas.

The regex - pattern used to validate this parameter is a string of characters - consisting of the following:

  • Any printable ASCII character - ranging from the space character (\u0020) through the end - of the ASCII character range

  • The printable characters - in the Basic Latin and Latin-1 Supplement character set (through \u00FF)

    -

  • The special characters tab (\u0009), line - feed (\u000A), and carriage return (\u000D)

    -
- required: - - PolicyInputList - - ActionNames - title: SimulateCustomPolicyRequest - type: object - SimulatePolicyResponse: - description: Contains the response to a successful SimulatePrincipalPolicy - or SimulateCustomPolicy request. - properties: - EvaluationResults: - allOf: - - $ref: '#/components/schemas/EvaluationResultsListType' - - description: The results of the simulation. - IsTruncated: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: A flag that indicates whether there are more items to return. - If your results were truncated, you can make a subsequent pagination - request using the Marker request parameter to retrieve - more items. Note that IAM might return fewer than the MaxItems - number of results even when there are more results available. We recommend - that you check IsTruncated after every call to ensure that - you receive all your results. - Marker: - allOf: - - $ref: '#/components/schemas/responseMarkerType' - - description: When IsTruncated is true, this - element is present and contains the value to use for the Marker - parameter in a subsequent pagination request. - type: object - SimulatePrincipalPolicyRequest: - properties: - ActionNames: - allOf: - - $ref: '#/components/schemas/ActionNameListType' - - description: A list of names of API operations to evaluate in the simulation. - Each operation is evaluated for each resource. Each operation must include - the service identifier, such as iam:CreateUser. - CallerArn: - allOf: - - $ref: '#/components/schemas/ResourceNameType' - - description:

The ARN of the IAM user that you want to specify as the - simulated caller of the API operations. If you do not specify a CallerArn, - it defaults to the ARN of the user that you specify in PolicySourceArn, - if you specified a user. If you include both a PolicySourceArn - (for example, arn:aws:iam::123456789012:user/David) and - a CallerArn (for example, arn:aws:iam::123456789012:user/Bob), - the result is that you simulate calling the API operations as Bob, as - if Bob had David's policies.

You can specify only the ARN of - an IAM user. You cannot specify the ARN of an assumed role, federated - user, or a service principal.

CallerArn is required - if you include a ResourcePolicy and the PolicySourceArn - is not the ARN for an IAM user. This is required so that the resource-based - policy's Principal element has a value to use in evaluating - the policy.

For more information about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.

- ContextEntries: - allOf: - - $ref: '#/components/schemas/ContextEntryListType' - - description: A list of context keys and corresponding values for the simulation - to use. Whenever a context key is evaluated in one of the simulated - IAM permissions policies, the corresponding value is supplied. - Marker: - allOf: - - $ref: '#/components/schemas/markerType' - - description: Use this parameter only when paginating results and only - after you receive a response indicating that the results are truncated. - Set it to the value of the Marker element in the response - that you received to indicate where the next call should start. - MaxItems: - allOf: - - $ref: '#/components/schemas/maxItemsType' - - description:

Use this only when paginating results to indicate the - maximum number of items you want in the response. If additional items - exist beyond the maximum you specify, the IsTruncated response - element is true.

If you do not include this parameter, - the number of items defaults to 100. Note that IAM might return fewer - results, even when there are more results available. In that case, the - IsTruncated response element returns true, - and Marker contains a value to include in the subsequent - call that tells the service where to continue from.

- PermissionsBoundaryPolicyInputList: - allOf: - - $ref: '#/components/schemas/SimulationPolicyListType' - - description:

The IAM permissions boundary policy to simulate. The permissions - boundary sets the maximum permissions that the entity can have. You - can input only one permissions boundary when you pass a policy to this - operation. An IAM entity can only have one permissions boundary in effect - at a time. For example, if a permissions boundary is attached to an - entity and you pass in a different permissions boundary policy using - this parameter, then the new permissions boundary policy is used for - the simulation. For more information about permissions boundaries, see - Permissions - boundaries for IAM entities in the IAM User Guide. The policy - input is specified as a string containing the complete, valid JSON text - of a permissions boundary policy.

The maximum length of the policy - document that you can pass in this operation, including whitespace, - is listed below. To view the maximum character counts of a managed policy - with no whitespaces, see IAM - and STS character quotas.

The regex - pattern used to validate this parameter is a string of characters - consisting of the following:

  • Any printable ASCII character - ranging from the space character (\u0020) through the end - of the ASCII character range

  • The printable characters - in the Basic Latin and Latin-1 Supplement character set (through \u00FF)

    -

  • The special characters tab (\u0009), line - feed (\u000A), and carriage return (\u000D)

    -
- PolicyInputList: - allOf: - - $ref: '#/components/schemas/SimulationPolicyListType' - - description:

An optional list of additional policy documents to include - in the simulation. Each document is specified as a string containing - the complete, valid JSON text of an IAM policy.

The regex - pattern used to validate this parameter is a string of characters - consisting of the following:

  • Any printable ASCII character - ranging from the space character (\u0020) through the end - of the ASCII character range

  • The printable characters - in the Basic Latin and Latin-1 Supplement character set (through \u00FF)

    -

  • The special characters tab (\u0009), line - feed (\u000A), and carriage return (\u000D)

    -
- PolicySourceArn: - allOf: - - $ref: '#/components/schemas/arnType' - - description:

The Amazon Resource Name (ARN) of a user, group, or role - whose policies you want to include in the simulation. If you specify - a user, group, or role, the simulation includes all policies that are - associated with that entity. If you specify a user, the simulation also - includes all policies that are attached to any groups the user belongs - to.

The maximum length of the policy document that you can pass - in this operation, including whitespace, is listed below. To view the - maximum character counts of a managed policy with no whitespaces, see - IAM - and STS character quotas.

For more information about ARNs, - see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.

- ResourceArns: - allOf: - - $ref: '#/components/schemas/ResourceNameListType' - - description:

A list of ARNs of Amazon Web Services resources to include - in the simulation. If this parameter is not provided, then the value - defaults to * (all resources). Each API in the ActionNames - parameter is evaluated for each resource in this list. The simulation - determines the access result (allowed or denied) of each combination - and reports it in the response. You can simulate resources that don't - exist in your account.

The simulation does not automatically - retrieve policies for the specified resources. If you want to include - a resource policy in the simulation, then you must include the policy - as a string in the ResourcePolicy parameter.

For - more information about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.

- ResourceHandlingOption: - allOf: - - $ref: '#/components/schemas/ResourceHandlingOptionType' - - description:

Specifies the type of simulation to run. Different API - operations that support resource-based policies require different combinations - of resources. By specifying the type of simulation to run, you enable - the policy simulator to enforce the presence of the required resources - to ensure reliable simulation results. If your simulation does not match - one of the following scenarios, then you can omit this parameter. The - following list shows each of the supported scenario values and the resources - that you must define to run the simulation.

Each of the EC2 scenarios - requires that you specify instance, image, and security group resources. - If your scenario includes an EBS volume, then you must specify that - volume as a resource. If the EC2 scenario includes VPC, then you must - supply the network interface resource. If it includes an IP subnet, - then you must specify the subnet resource. For more information on the - EC2 scenario options, see Supported - platforms in the Amazon EC2 User Guide.

  • - EC2-Classic-InstanceStore

    instance, image, security group

    -

  • EC2-Classic-EBS

    instance, image, security - group, volume

  • EC2-VPC-InstanceStore

    instance, - image, security group, network interface

  • EC2-VPC-InstanceStore-Subnet -

    instance, image, security group, network interface, subnet

    -

  • EC2-VPC-EBS

    instance, image, security - group, network interface, volume

  • EC2-VPC-EBS-Subnet -

    instance, image, security group, network interface, subnet, - volume

- ResourceOwner: - allOf: - - $ref: '#/components/schemas/ResourceNameType' - - description: An Amazon Web Services account ID that specifies the owner - of any simulated resource that does not identify its owner in the resource - ARN. Examples of resource ARNs include an S3 bucket or object. If ResourceOwner - is specified, it is also used as the account owner of any ResourcePolicy - included in the simulation. If the ResourceOwner parameter - is not specified, then the owner of the resources and the resource policy - defaults to the account of the identity provided in CallerArn. - This parameter is required only if you specify a resource-based policy - and account that owns the resource is different from the account that - owns the simulated calling user CallerArn. - ResourcePolicy: - allOf: - - $ref: '#/components/schemas/policyDocumentType' - - description:

A resource-based policy to include in the simulation provided - as a string. Each resource in the simulation is treated as if it had - this policy attached. You can include only one resource-based policy - in a simulation.

The maximum length of the policy document that - you can pass in this operation, including whitespace, is listed below. - To view the maximum character counts of a managed policy with no whitespaces, - see IAM - and STS character quotas.

The regex - pattern used to validate this parameter is a string of characters - consisting of the following:

  • Any printable ASCII character - ranging from the space character (\u0020) through the end - of the ASCII character range

  • The printable characters - in the Basic Latin and Latin-1 Supplement character set (through \u00FF)

    -

  • The special characters tab (\u0009), line - feed (\u000A), and carriage return (\u000D)

    -
- required: - - PolicySourceArn - - ActionNames - title: SimulatePrincipalPolicyRequest - type: object - SimulationPolicyListType: - items: - allOf: - - $ref: '#/components/schemas/policyDocumentType' - - xml: - name: member - type: array - Statement: - description:

Contains a reference to a Statement element in - a policy document that determines the result of the simulation.

This - data type is used by the MatchedStatements member of the - EvaluationResult type.

- properties: - EndPosition: - allOf: - - $ref: '#/components/schemas/Position' - - description: The row and column of the end of a Statement - in an IAM policy. - SourcePolicyId: - allOf: - - $ref: '#/components/schemas/PolicyIdentifierType' - - description: The identifier of the policy that was provided as an input. - SourcePolicyType: - allOf: - - $ref: '#/components/schemas/PolicySourceType' - - description: The type of the policy. - StartPosition: - allOf: - - $ref: '#/components/schemas/Position' - - description: The row and column of the beginning of the Statement - in an IAM policy. - type: object - StatementListType: - items: - allOf: - - $ref: '#/components/schemas/Statement' - - xml: - name: member - type: array - Tag: - description: A structure that represents user-provided metadata that can be - associated with an IAM resource. For more information about tagging, see Tagging - IAM resources in the IAM User Guide. - properties: - Key: - allOf: - - $ref: '#/components/schemas/tagKeyType' - - description: The key name that can be used to look up or retrieve the - associated value. For example, Department or Cost - Center are common choices. - Value: - allOf: - - $ref: '#/components/schemas/tagValueType' - - description:

The value associated with this tag. For example, tags - with a key name of Department could have values such as - Human Resources, Accounting, and Support. - Tags with a key name of Cost Center might have values that - consist of the number associated with the different cost centers in - your company. Typically, many resources have tags with the same key - name but with different values.

Amazon Web Services always - interprets the tag Value as a single string. If you need - to store an array, you can store comma-separated values in the string. - However, you must interpret the value in your code.

 - required: - - Key - - Value - type: object - TagInstanceProfileRequest: - properties: - InstanceProfileName: - allOf: - - $ref: '#/components/schemas/instanceProfileNameType' - - description: '

The name of the IAM instance profile to which you want - to add tags.

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - Tags: - allOf: - - $ref: '#/components/schemas/tagListType' - - description: The list of tags that you want to attach to the IAM instance - profile. Each tag consists of a key name and an associated value. - required: - - InstanceProfileName - - Tags - title: TagInstanceProfileRequest - type: object - TagMFADeviceRequest: - properties: - SerialNumber: - allOf: - - $ref: '#/components/schemas/serialNumberType' - - description: '

The unique identifier for the IAM virtual MFA device - to which you want to add tags. For virtual MFA devices, the serial number - is the same as the ARN.

This parameter allows (through its regex pattern) a string of - characters consisting of upper and lowercase alphanumeric characters - with no spaces. You can also include any of the following characters: - _+=,.@-

' - Tags: - allOf: - - $ref: '#/components/schemas/tagListType' - - description: The list of tags that you want to attach to the IAM virtual - MFA device. Each tag consists of a key name and an associated value. - required: - - SerialNumber - - Tags - title: TagMFADeviceRequest - type: object - TagOpenIDConnectProviderRequest: - properties: - OpenIDConnectProviderArn: - allOf: - - $ref: '#/components/schemas/arnType' - - description: '

The ARN of the OIDC identity provider in IAM to which - you want to add tags.

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - Tags: - allOf: - - $ref: '#/components/schemas/tagListType' - - description: The list of tags that you want to attach to the OIDC identity - provider in IAM. Each tag consists of a key name and an associated value. - required: - - OpenIDConnectProviderArn - - Tags - title: TagOpenIDConnectProviderRequest - type: object - TagPolicyRequest: - properties: - PolicyArn: - allOf: - - $ref: '#/components/schemas/arnType' - - description: '

The ARN of the IAM customer managed policy to which you - want to add tags.

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - Tags: - allOf: - - $ref: '#/components/schemas/tagListType' - - description: The list of tags that you want to attach to the IAM customer - managed policy. Each tag consists of a key name and an associated value. - required: - - PolicyArn - - Tags - title: TagPolicyRequest - type: object - TagRoleRequest: - properties: - RoleName: - allOf: - - $ref: '#/components/schemas/roleNameType' - - description: '

The name of the IAM role to which you want to add tags.

-

This parameter accepts (through its regex - pattern) a string of characters that consist of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - Tags: - allOf: - - $ref: '#/components/schemas/tagListType' - - description: The list of tags that you want to attach to the IAM role. - Each tag consists of a key name and an associated value. - required: - - RoleName - - Tags - title: TagRoleRequest - type: object - TagSAMLProviderRequest: - properties: - SAMLProviderArn: - allOf: - - $ref: '#/components/schemas/arnType' - - description: '

The ARN of the SAML identity provider in IAM to which - you want to add tags.

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - Tags: - allOf: - - $ref: '#/components/schemas/tagListType' - - description: The list of tags that you want to attach to the SAML identity - provider in IAM. Each tag consists of a key name and an associated value. - required: - - SAMLProviderArn - - Tags - title: TagSAMLProviderRequest - type: object - TagServerCertificateRequest: - properties: - ServerCertificateName: - allOf: - - $ref: '#/components/schemas/serverCertificateNameType' - - description: '

The name of the IAM server certificate to which you want - to add tags.

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - Tags: - allOf: - - $ref: '#/components/schemas/tagListType' - - description: The list of tags that you want to attach to the IAM server - certificate. Each tag consists of a key name and an associated value. - required: - - ServerCertificateName - - Tags - title: TagServerCertificateRequest - type: object - TagUserRequest: - properties: - Tags: - allOf: - - $ref: '#/components/schemas/tagListType' - - description: The list of tags that you want to attach to the IAM user. - Each tag consists of a key name and an associated value. - UserName: - allOf: - - $ref: '#/components/schemas/existingUserNameType' - - description: '

The name of the IAM user to which you want to add tags.

-

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - required: - - UserName - - Tags - title: TagUserRequest - type: object - TrackedActionLastAccessed: - description:

Contains details about the most recent attempt to access an - action within the service.

This data type is used as a response element - in the GetServiceLastAccessedDetails operation.

- properties: - ActionName: - allOf: - - $ref: '#/components/schemas/stringType' - - description: The name of the tracked action to which access was attempted. - Tracked actions are actions that report activity to IAM. - LastAccessedEntity: - $ref: '#/components/schemas/arnType' - LastAccessedRegion: - allOf: - - $ref: '#/components/schemas/stringType' - - description:

The Region from which the authenticated entity (user or - role) last attempted to access the tracked action. Amazon Web Services - does not report unauthenticated requests.

This field is null - if no IAM entities attempted to access the service within the reporting - period.

- LastAccessedTime: - allOf: - - $ref: '#/components/schemas/dateType' - - description: "

The date and time, in\_ISO 8601 date-time format, when an authenticated entity most recently\ - \ attempted to access the tracked service. Amazon Web Services does\ - \ not report unauthenticated requests.

This field is null if\ - \ no IAM entities attempted to access the service within the reporting period.

" - type: object - TrackedActionsLastAccessed: - items: - allOf: - - $ref: '#/components/schemas/TrackedActionLastAccessed' - - xml: - name: member - type: array - UnmodifiableEntityException: {} - UnrecognizedPublicKeyEncodingException: {} - UntagInstanceProfileRequest: - properties: - InstanceProfileName: - allOf: - - $ref: '#/components/schemas/instanceProfileNameType' - - description: '

The name of the IAM instance profile from which you want - to remove tags.

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - TagKeys: - allOf: - - $ref: '#/components/schemas/tagKeyListType' - - description: A list of key names as a simple array of strings. The tags - with matching keys are removed from the specified instance profile. - required: - - InstanceProfileName - - TagKeys - title: UntagInstanceProfileRequest - type: object - UntagMFADeviceRequest: - properties: - SerialNumber: - allOf: - - $ref: '#/components/schemas/serialNumberType' - - description: '

The unique identifier for the IAM virtual MFA device - from which you want to remove tags. For virtual MFA devices, the serial - number is the same as the ARN.

This parameter allows (through - its regex pattern) a string - of characters consisting of upper and lowercase alphanumeric characters - with no spaces. You can also include any of the following characters: - _+=,.@-

' - TagKeys: - allOf: - - $ref: '#/components/schemas/tagKeyListType' - - description: A list of key names as a simple array of strings. The tags - with matching keys are removed from the specified instance profile. - required: - - SerialNumber - - TagKeys - title: UntagMFADeviceRequest - type: object - UntagOpenIDConnectProviderRequest: - properties: - OpenIDConnectProviderArn: - allOf: - - $ref: '#/components/schemas/arnType' - - description: '

The ARN of the OIDC provider in IAM from which you want - to remove tags.

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - TagKeys: - allOf: - - $ref: '#/components/schemas/tagKeyListType' - - description: A list of key names as a simple array of strings. The tags - with matching keys are removed from the specified OIDC provider. - required: - - OpenIDConnectProviderArn - - TagKeys - title: UntagOpenIDConnectProviderRequest - type: object - UntagPolicyRequest: - properties: - PolicyArn: - allOf: - - $ref: '#/components/schemas/arnType' - - description: '

The ARN of the IAM customer managed policy from which - you want to remove tags.

This parameter allows (through its regex pattern) a string of - characters consisting of upper and lowercase alphanumeric characters - with no spaces. You can also include any of the following characters: - _+=,.@-

' - TagKeys: - allOf: - - $ref: '#/components/schemas/tagKeyListType' - - description: A list of key names as a simple array of strings. The tags - with matching keys are removed from the specified policy. - required: - - PolicyArn - - TagKeys - title: UntagPolicyRequest - type: object - UntagRoleRequest: - properties: - RoleName: - allOf: - - $ref: '#/components/schemas/roleNameType' - - description: '

The name of the IAM role from which you want to remove - tags.

This parameter accepts (through its regex - pattern) a string of characters that consist of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - TagKeys: - allOf: - - $ref: '#/components/schemas/tagKeyListType' - - description: A list of key names as a simple array of strings. The tags - with matching keys are removed from the specified role. - required: - - RoleName - - TagKeys - title: UntagRoleRequest - type: object - UntagSAMLProviderRequest: - properties: - SAMLProviderArn: - allOf: - - $ref: '#/components/schemas/arnType' - - description: '

The ARN of the SAML identity provider in IAM from which - you want to remove tags.

This parameter allows (through its regex pattern) a string of - characters consisting of upper and lowercase alphanumeric characters - with no spaces. You can also include any of the following characters: - _+=,.@-

' - TagKeys: - allOf: - - $ref: '#/components/schemas/tagKeyListType' - - description: A list of key names as a simple array of strings. The tags - with matching keys are removed from the specified SAML identity provider. - required: - - SAMLProviderArn - - TagKeys - title: UntagSAMLProviderRequest - type: object - UntagServerCertificateRequest: - properties: - ServerCertificateName: - allOf: - - $ref: '#/components/schemas/serverCertificateNameType' - - description: '

The name of the IAM server certificate from which you - want to remove tags.

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - TagKeys: - allOf: - - $ref: '#/components/schemas/tagKeyListType' - - description: A list of key names as a simple array of strings. The tags - with matching keys are removed from the specified IAM server certificate. - required: - - ServerCertificateName - - TagKeys - title: UntagServerCertificateRequest - type: object - UntagUserRequest: - properties: - TagKeys: - allOf: - - $ref: '#/components/schemas/tagKeyListType' - - description: A list of key names as a simple array of strings. The tags - with matching keys are removed from the specified user. - UserName: - allOf: - - $ref: '#/components/schemas/existingUserNameType' - - description: '

The name of the IAM user from which you want to remove - tags.

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - required: - - UserName - - TagKeys - title: UntagUserRequest - type: object - UpdateAccessKeyRequest: - properties: - AccessKeyId: - allOf: - - $ref: '#/components/schemas/accessKeyIdType' - - description:

The access key ID of the secret access key you want to - update.

This parameter allows (through its regex - pattern) a string of characters that can consist of any upper or - lowercased letter or digit.

- Status: - allOf: - - $ref: '#/components/schemas/statusType' - - description: ' The status you want to assign to the secret access key. - Active means that the key can be used for programmatic - calls to Amazon Web Services, while Inactive means that - the key cannot be used.' - UserName: - allOf: - - $ref: '#/components/schemas/existingUserNameType' - - description: '

The name of the user whose key you want to update.

-

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - required: - - AccessKeyId - - Status - title: UpdateAccessKeyRequest - type: object - UpdateAccountPasswordPolicyRequest: - properties: - AllowUsersToChangePassword: - allOf: - - $ref: '#/components/schemas/booleanType' - - description:

Allows all IAM users in your account to use the Amazon - Web Services Management Console to change their own passwords. For more - information, see Permitting - IAM users to change their own passwords in the IAM User Guide.

-

If you do not specify a value for this parameter, then the operation - uses the default value of false. The result is that IAM - users in the account do not automatically have permissions to change - their own password.

- HardExpiry: - allOf: - - $ref: '#/components/schemas/booleanObjectType' - - description:

Prevents IAM users who are accessing the account via - the Amazon Web Services Management Console from setting a new console - password after their password has expired. The IAM user cannot access - the console until an administrator resets the password.

If you - do not specify a value for this parameter, then the operation uses the - default value of false. The result is that IAM users can - change their passwords after they expire and continue to sign in as - the user.

In the Amazon Web Services Management Console, - the custom password policy option Allow users to change their own - password gives IAM users permissions to iam:ChangePassword - for only their user and to the iam:GetAccountPasswordPolicy - action. This option does not attach a permissions policy to each user, - rather the permissions are applied at the account-level for all users - by IAM. IAM users with iam:ChangePassword permission and - active access keys can reset their own expired console password using - the CLI or API.

 - MaxPasswordAge: - allOf: - - $ref: '#/components/schemas/maxPasswordAgeType' - - description:

The number of days that an IAM user password is valid.

-

If you do not specify a value for this parameter, then the operation - uses the default value of 0. The result is that IAM user - passwords never expire.

- MinimumPasswordLength: - allOf: - - $ref: '#/components/schemas/minimumPasswordLengthType' - - description:

The minimum number of characters allowed in an IAM user - password.

If you do not specify a value for this parameter, then - the operation uses the default value of 6.

- PasswordReusePrevention: - allOf: - - $ref: '#/components/schemas/passwordReusePreventionType' - - description:

Specifies the number of previous passwords that IAM users - are prevented from reusing.

If you do not specify a value for - this parameter, then the operation uses the default value of 0. - The result is that IAM users are not prevented from reusing previous - passwords.

- RequireLowercaseCharacters: - allOf: - - $ref: '#/components/schemas/booleanType' - - description:

Specifies whether IAM user passwords must contain at least - one lowercase character from the ISO basic Latin alphabet (a to z).

-

If you do not specify a value for this parameter, then the operation - uses the default value of false. The result is that passwords - do not require at least one lowercase character.

- RequireNumbers: - allOf: - - $ref: '#/components/schemas/booleanType' - - description:

Specifies whether IAM user passwords must contain at least - one numeric character (0 to 9).

If you do not specify a value - for this parameter, then the operation uses the default value of false. - The result is that passwords do not require at least one numeric character.

- RequireSymbols: - allOf: - - $ref: '#/components/schemas/booleanType' - - description: '

Specifies whether IAM user passwords must contain at - least one of the following non-alphanumeric characters:

! @ # - $ % ^ & * ( ) _ + - = [ ] { } | ''

If you do not specify - a value for this parameter, then the operation uses the default value - of false. The result is that passwords do not require at - least one symbol character.

' - RequireUppercaseCharacters: - allOf: - - $ref: '#/components/schemas/booleanType' - - description:

Specifies whether IAM user passwords must contain at least - one uppercase character from the ISO basic Latin alphabet (A to Z).

-

If you do not specify a value for this parameter, then the operation - uses the default value of false. The result is that passwords - do not require at least one uppercase character.

- title: UpdateAccountPasswordPolicyRequest - type: object - UpdateAssumeRolePolicyRequest: - properties: - PolicyDocument: - allOf: - - $ref: '#/components/schemas/policyDocumentType' - - description:

The policy that grants an entity permission to assume - the role.

You must provide policies in JSON format in IAM. However, - for CloudFormation templates formatted in YAML, you can provide the - policy in JSON or YAML format. CloudFormation always converts a YAML - policy to JSON format before submitting it to IAM.

The regex - pattern used to validate this parameter is a string of characters - consisting of the following:

  • Any printable ASCII character - ranging from the space character (\u0020) through the end - of the ASCII character range

  • The printable characters - in the Basic Latin and Latin-1 Supplement character set (through \u00FF)

    -

  • The special characters tab (\u0009), line - feed (\u000A), and carriage return (\u000D)

    -
- RoleName: - allOf: - - $ref: '#/components/schemas/roleNameType' - - description: '

The name of the role to update with the new policy.

-

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - required: - - RoleName - - PolicyDocument - title: UpdateAssumeRolePolicyRequest - type: object - UpdateGroupRequest: - properties: - GroupName: - allOf: - - $ref: '#/components/schemas/groupNameType' - - description: '

Name of the IAM group to update. If you''re changing - the name of the group, this is the original name.

This parameter - allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - NewGroupName: - allOf: - - $ref: '#/components/schemas/groupNameType' - - description:

New name for the IAM group. Only include this if changing - the group's name.

IAM user, group, role, and policy names must - be unique within the account. Names are not distinguished by case. For - example, you cannot create resources named both "MyResource" and "myresource".

- NewPath: - allOf: - - $ref: '#/components/schemas/pathType' - - description:

New path for the IAM group. Only include this if changing - the group's path.

This parameter allows (through its regex - pattern) a string of characters consisting of either a forward slash - (/) by itself or a string that must begin and end with forward slashes. - In addition, it can contain any ASCII character from the ! (\u0021) - through the DEL character (\u007F), including most punctuation - characters, digits, and upper and lowercased letters.

- required: - - GroupName - title: UpdateGroupRequest - type: object - UpdateLoginProfileRequest: - properties: - Password: - allOf: - - $ref: '#/components/schemas/passwordType' - - description:

The new password for the specified IAM user.

The - regex pattern used to - validate this parameter is a string of characters consisting of the - following:

  • Any printable ASCII character ranging from - the space character (\u0020) through the end of the ASCII - character range

  • The printable characters in the Basic - Latin and Latin-1 Supplement character set (through \u00FF)

    -

  • The special characters tab (\u0009), line - feed (\u000A), and carriage return (\u000D)

    -

However, the format can be further restricted by the - account administrator by setting a password policy on the Amazon Web - Services account. For more information, see UpdateAccountPasswordPolicy.

- PasswordResetRequired: - allOf: - - $ref: '#/components/schemas/booleanObjectType' - - description: Allows this new password to be used only once by requiring - the specified IAM user to set a new password on next sign-in. - UserName: - allOf: - - $ref: '#/components/schemas/userNameType' - - description: '

The name of the user whose password you want to update.

-

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - required: - - UserName - title: UpdateLoginProfileRequest - type: object - UpdateOpenIDConnectProviderThumbprintRequest: - properties: - OpenIDConnectProviderArn: - allOf: - - $ref: '#/components/schemas/arnType' - - description:

The Amazon Resource Name (ARN) of the IAM OIDC provider - resource object for which you want to update the thumbprint. You can - get a list of OIDC provider ARNs by using the ListOpenIDConnectProviders - operation.

For more information about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.

- ThumbprintList: - allOf: - - $ref: '#/components/schemas/thumbprintListType' - - description: 'A list of certificate thumbprints that are associated with - the specified IAM OpenID Connect provider. For more information, see - CreateOpenIDConnectProvider. ' - required: - - OpenIDConnectProviderArn - - ThumbprintList - title: UpdateOpenIDConnectProviderThumbprintRequest - type: object - UpdateRoleDescriptionRequest: - properties: - Description: - allOf: - - $ref: '#/components/schemas/roleDescriptionType' - - description: The new description that you want to apply to the specified - role. - RoleName: - allOf: - - $ref: '#/components/schemas/roleNameType' - - description: The name of the role that you want to modify. - required: - - RoleName - - Description - title: UpdateRoleDescriptionRequest - type: object - UpdateRoleDescriptionResponse: - properties: - Role: - allOf: - - $ref: '#/components/schemas/Role' - - description: A structure that contains details about the modified role. - type: object - UpdateRoleRequest: - properties: - Description: - allOf: - - $ref: '#/components/schemas/roleDescriptionType' - - description: The new description that you want to apply to the specified - role. - MaxSessionDuration: - allOf: - - $ref: '#/components/schemas/roleMaxSessionDurationType' - - description:

The maximum session duration (in seconds) that you want - to set for the specified role. If you do not specify a value for this - setting, the default maximum of one hour is applied. This setting can - have a value from 1 hour to 12 hours.

Anyone who assumes the - role from the CLI or API can use the DurationSeconds API - parameter or the duration-seconds CLI parameter to request - a longer session. The MaxSessionDuration setting determines - the maximum duration that can be requested using the DurationSeconds - parameter. If users don't specify a value for the DurationSeconds - parameter, their security credentials are valid for one hour by default. - This applies when you use the AssumeRole* API operations - or the assume-role* CLI operations but does not apply when - you use those operations to create a console URL. For more information, - see Using - IAM roles in the IAM User Guide.

- RoleName: - allOf: - - $ref: '#/components/schemas/roleNameType' - - description: The name of the role that you want to modify. - required: - - RoleName - title: UpdateRoleRequest - type: object - UpdateRoleResponse: - properties: {} - type: object - UpdateSAMLProviderRequest: - properties: - SAMLMetadataDocument: - allOf: - - $ref: '#/components/schemas/SAMLMetadataDocumentType' - - description: An XML document generated by an identity provider (IdP) that - supports SAML 2.0. The document includes the issuer's name, expiration - information, and keys that can be used to validate the SAML authentication - response (assertions) that are received from the IdP. You must generate - the metadata document using the identity management software that is - used as your organization's IdP. - SAMLProviderArn: - allOf: - - $ref: '#/components/schemas/arnType' - - description:

The Amazon Resource Name (ARN) of the SAML provider to - update.

For more information about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.

- required: - - SAMLMetadataDocument - - SAMLProviderArn - title: UpdateSAMLProviderRequest - type: object - UpdateSAMLProviderResponse: - description: 'Contains the response to a successful UpdateSAMLProvider - request. ' - properties: - SAMLProviderArn: - allOf: - - $ref: '#/components/schemas/arnType' - - description: The Amazon Resource Name (ARN) of the SAML provider that - was updated. - type: object - UpdateSSHPublicKeyRequest: - properties: - SSHPublicKeyId: - allOf: - - $ref: '#/components/schemas/publicKeyIdType' - - description:

The unique identifier for the SSH public key.

This - parameter allows (through its regex - pattern) a string of characters that can consist of any upper or - lowercased letter or digit.

- Status: - allOf: - - $ref: '#/components/schemas/statusType' - - description: The status to assign to the SSH public key. Active - means that the key can be used for authentication with an CodeCommit - repository. Inactive means that the key cannot be used. - UserName: - allOf: - - $ref: '#/components/schemas/userNameType' - - description: '

The name of the IAM user associated with the SSH public - key.

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - required: - - UserName - - SSHPublicKeyId - - Status - title: UpdateSSHPublicKeyRequest - type: object - UpdateServerCertificateRequest: - properties: - NewPath: - allOf: - - $ref: '#/components/schemas/pathType' - - description:

The new path for the server certificate. Include this - only if you are updating the server certificate's path.

This - parameter allows (through its regex - pattern) a string of characters consisting of either a forward slash - (/) by itself or a string that must begin and end with forward slashes. - In addition, it can contain any ASCII character from the ! (\u0021) - through the DEL character (\u007F), including most punctuation - characters, digits, and upper and lowercased letters.

- NewServerCertificateName: - allOf: - - $ref: '#/components/schemas/serverCertificateNameType' - - description: '

The new name for the server certificate. Include this - only if you are updating the server certificate''s name. The name of - the certificate cannot contain any spaces.

This parameter allows - (through its regex pattern) - a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following - characters: _+=,.@-

' - ServerCertificateName: - allOf: - - $ref: '#/components/schemas/serverCertificateNameType' - - description: '

The name of the server certificate that you want to update.

-

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - required: - - ServerCertificateName - title: UpdateServerCertificateRequest - type: object - UpdateServiceSpecificCredentialRequest: - properties: - ServiceSpecificCredentialId: - allOf: - - $ref: '#/components/schemas/serviceSpecificCredentialId' - - description:

The unique identifier of the service-specific credential.

-

This parameter allows (through its regex - pattern) a string of characters that can consist of any upper or - lowercased letter or digit.

- Status: - allOf: - - $ref: '#/components/schemas/statusType' - - description: The status to be assigned to the service-specific credential. - UserName: - allOf: - - $ref: '#/components/schemas/userNameType' - - description: '

The name of the IAM user associated with the service-specific - credential. If you do not specify this value, then the operation assumes - the user whose credentials are used to call the operation.

This - parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - required: - - ServiceSpecificCredentialId - - Status - title: UpdateServiceSpecificCredentialRequest - type: object - UpdateSigningCertificateRequest: - properties: - CertificateId: - allOf: - - $ref: '#/components/schemas/certificateIdType' - - description:

The ID of the signing certificate you want to update.

-

This parameter allows (through its regex - pattern) a string of characters that can consist of any upper or - lowercased letter or digit.

- Status: - allOf: - - $ref: '#/components/schemas/statusType' - - description: ' The status you want to assign to the certificate. Active - means that the certificate can be used for programmatic calls to Amazon - Web Services Inactive means that the certificate cannot - be used.' - UserName: - allOf: - - $ref: '#/components/schemas/existingUserNameType' - - description: '

The name of the IAM user the signing certificate belongs - to.

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - required: - - CertificateId - - Status - title: UpdateSigningCertificateRequest - type: object - UpdateUserRequest: - properties: - NewPath: - allOf: - - $ref: '#/components/schemas/pathType' - - description:

New path for the IAM user. Include this parameter only - if you're changing the user's path.

This parameter allows (through - its regex pattern) a string - of characters consisting of either a forward slash (/) by itself or - a string that must begin and end with forward slashes. In addition, - it can contain any ASCII character from the ! (\u0021) - through the DEL character (\u007F), including most punctuation - characters, digits, and upper and lowercased letters.

- NewUserName: - allOf: - - $ref: '#/components/schemas/userNameType' - - description:

New name for the user. Include this parameter only if - you're changing the user's name.

IAM user, group, role, and policy - names must be unique within the account. Names are not distinguished - by case. For example, you cannot create resources named both "MyResource" - and "myresource".

- UserName: - allOf: - - $ref: '#/components/schemas/existingUserNameType' - - description: '

Name of the user to update. If you''re changing the name - of the user, this is the original user name.

This parameter allows - (through its regex pattern) - a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following - characters: _+=,.@-

' - required: - - UserName - title: UpdateUserRequest - type: object - UploadSSHPublicKeyRequest: - properties: - SSHPublicKeyBody: - allOf: - - $ref: '#/components/schemas/publicKeyMaterialType' - - description:

The SSH public key. The public key must be encoded in - ssh-rsa format or PEM format. The minimum bit-length of the public key - is 2048 bits. For example, you can generate a 2048-bit key, and the - resulting PEM file is 1679 bytes long.

The regex - pattern used to validate this parameter is a string of characters - consisting of the following:

  • Any printable ASCII character - ranging from the space character (\u0020) through the end - of the ASCII character range

  • The printable characters - in the Basic Latin and Latin-1 Supplement character set (through \u00FF)

    -

  • The special characters tab (\u0009), line - feed (\u000A), and carriage return (\u000D)

    -
- UserName: - allOf: - - $ref: '#/components/schemas/userNameType' - - description: '

The name of the IAM user to associate the SSH public - key with.

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - required: - - UserName - - SSHPublicKeyBody - title: UploadSSHPublicKeyRequest - type: object - UploadSSHPublicKeyResponse: - description: Contains the response to a successful UploadSSHPublicKey - request. - properties: - SSHPublicKey: - allOf: - - $ref: '#/components/schemas/SSHPublicKey' - - description: Contains information about the SSH public key. - type: object - UploadServerCertificateRequest: - properties: - CertificateBody: - allOf: - - $ref: '#/components/schemas/certificateBodyType' - - description:

The contents of the public key certificate in PEM-encoded - format.

The regex pattern - used to validate this parameter is a string of characters consisting - of the following:

  • Any printable ASCII character ranging - from the space character (\u0020) through the end of the - ASCII character range

  • The printable characters in - the Basic Latin and Latin-1 Supplement character set (through \u00FF)

    -

  • The special characters tab (\u0009), line - feed (\u000A), and carriage return (\u000D)

    -
- CertificateChain: - allOf: - - $ref: '#/components/schemas/certificateChainType' - - description:

The contents of the certificate chain. This is typically - a concatenation of the PEM-encoded public key certificates of the chain.

-

The regex pattern used - to validate this parameter is a string of characters consisting of the - following:

  • Any printable ASCII character ranging from - the space character (\u0020) through the end of the ASCII - character range

  • The printable characters in the Basic - Latin and Latin-1 Supplement character set (through \u00FF)

    -

  • The special characters tab (\u0009), line - feed (\u000A), and carriage return (\u000D)

    -
- Path: - allOf: - - $ref: '#/components/schemas/pathType' - - description:

The path for the server certificate. For more information - about paths, see IAM - identifiers in the IAM User Guide.

This parameter - is optional. If it is not included, it defaults to a slash (/). This - parameter allows (through its regex - pattern) a string of characters consisting of either a forward slash - (/) by itself or a string that must begin and end with forward slashes. - In addition, it can contain any ASCII character from the ! (\u0021) - through the DEL character (\u007F), including most punctuation - characters, digits, and upper and lowercased letters.

- If you are uploading a server certificate specifically for use with - Amazon CloudFront distributions, you must specify a path using the path - parameter. The path must begin with /cloudfront and must - include a trailing slash (for example, /cloudfront/test/).

- - PrivateKey: - allOf: - - $ref: '#/components/schemas/privateKeyType' - - description:

The contents of the private key in PEM-encoded format.

-

The regex pattern used - to validate this parameter is a string of characters consisting of the - following:

  • Any printable ASCII character ranging from - the space character (\u0020) through the end of the ASCII - character range

  • The printable characters in the Basic - Latin and Latin-1 Supplement character set (through \u00FF)

    -

  • The special characters tab (\u0009), line - feed (\u000A), and carriage return (\u000D)

    -
- ServerCertificateName: - allOf: - - $ref: '#/components/schemas/serverCertificateNameType' - - description: '

The name for the server certificate. Do not include the - path in this value. The name of the certificate cannot contain any spaces.

-

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - Tags: - allOf: - - $ref: '#/components/schemas/tagListType' - - description:

A list of tags that you want to attach to the new IAM - server certificate resource. Each tag consists of a key name and an - associated value. For more information about tagging, see Tagging - IAM resources in the IAM User Guide.

If any - one of the tags is invalid or if you exceed the allowed maximum number - of tags, then the entire request fails and the resource is not created.

- - required: - - ServerCertificateName - - CertificateBody - - PrivateKey - title: UploadServerCertificateRequest - type: object - UploadServerCertificateResponse: - description: 'Contains the response to a successful UploadServerCertificate - request. ' - example: - ServerCertificateMetadata: - Arn: arn:aws:iam::123456789012:server-certificate/company/servercerts/ProdServerCert - Expiration: '2012-05-08T01:02:03.004Z' - Path: /company/servercerts/ - ServerCertificateId: ASCA1111111111EXAMPLE - ServerCertificateName: ProdServerCert - UploadDate: '2010-05-08T01:02:03.004Z' - properties: - ServerCertificateMetadata: - allOf: - - $ref: '#/components/schemas/ServerCertificateMetadata' - - description: The meta information of the uploaded server certificate without - its certificate body, certificate chain, and private key. - Tags: - allOf: - - $ref: '#/components/schemas/tagListType' - - description: A list of tags that are attached to the new IAM server certificate. - The returned list of tags is sorted by tag key. For more information - about tagging, see Tagging - IAM resources in the IAM User Guide. - type: object - UploadSigningCertificateRequest: - properties: - CertificateBody: - allOf: - - $ref: '#/components/schemas/certificateBodyType' - - description:

The contents of the signing certificate.

The regex pattern used to validate - this parameter is a string of characters consisting of the following:

-

  • Any printable ASCII character ranging from the space character - (\u0020) through the end of the ASCII character range

    -

  • The printable characters in the Basic Latin and Latin-1 - Supplement character set (through \u00FF)

  • -

    The special characters tab (\u0009), line feed (\u000A), - and carriage return (\u000D)

- UserName: - allOf: - - $ref: '#/components/schemas/existingUserNameType' - - description: '

The name of the user the signing certificate is for.

-

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase - alphanumeric characters with no spaces. You can also include any of - the following characters: _+=,.@-

' - required: - - CertificateBody - title: UploadSigningCertificateRequest - type: object - UploadSigningCertificateResponse: - description: 'Contains the response to a successful UploadSigningCertificate - request. ' - example: - Certificate: - CertificateBody: '-----BEGIN CERTIFICATE----------END - CERTIFICATE-----' - CertificateId: ID123456789012345EXAMPLE - Status: Active - UploadDate: '2015-06-06T21:40:08.121Z' - UserName: Bob - properties: - Certificate: - allOf: - - $ref: '#/components/schemas/SigningCertificate' - - description: Information about the certificate. - required: - - Certificate - type: object - User: - description:

Contains information about an IAM user entity.

This data - type is used as a response element in the following operations:

- properties: - Arn: - allOf: - - $ref: '#/components/schemas/arnType' - - description: 'The Amazon Resource Name (ARN) that identifies the user. - For more information about ARNs and how to use ARNs in policies, see - IAM - Identifiers in the IAM User Guide. ' - CreateDate: - allOf: - - $ref: '#/components/schemas/dateType' - - description: The date and time, in ISO - 8601 date-time format, when the user was created. - PasswordLastUsed: - allOf: - - $ref: '#/components/schemas/dateType' - - description:

The date and time, in ISO - 8601 date-time format, when the user's password was last used to - sign in to an Amazon Web Services website. For a list of Amazon Web - Services websites that capture a user's last sign-in time, see the Credential - reports topic in the IAM User Guide. If a password is used - more than once in a five-minute span, only the first use is returned - in this field. If the field is null (no value), then it indicates that - they never signed in with a password. This can be because:

    -

  • The user never had a password.

  • A password - exists but has not been used since IAM started tracking this information - on October 20, 2014.

A null value does not mean that - the user never had a password. Also, if the user does not currently - have a password but had one in the past, then this field contains the - date and time the most recent password was used.

This value is - returned only in the GetUser and ListUsers operations. -

- Path: - allOf: - - $ref: '#/components/schemas/pathType' - - description:

The path to the user. For more information about paths, - see IAM - identifiers in the IAM User Guide.

The ARN of the - policy used to set the permissions boundary for the user.

- PermissionsBoundary: - allOf: - - $ref: '#/components/schemas/AttachedPermissionsBoundary' - - description: For more information about permissions boundaries, see Permissions - boundaries for IAM identities in the IAM User Guide. - Tags: - allOf: - - $ref: '#/components/schemas/tagListType' - - description: A list of tags that are associated with the user. For more - information about tagging, see Tagging - IAM resources in the IAM User Guide. - UserId: - allOf: - - $ref: '#/components/schemas/idType' - - description: The stable and unique string identifying the user. For more - information about IDs, see IAM - identifiers in the IAM User Guide. - UserName: - allOf: - - $ref: '#/components/schemas/userNameType' - - description: The friendly name identifying the user. - required: - - Path - - UserName - - UserId - - Arn - - CreateDate - type: object - UserDetail: - description:

Contains information about an IAM user, including all the user's - policies and all the IAM groups the user is in.

This data type is used - as a response element in the GetAccountAuthorizationDetails operation.

- properties: - Arn: - $ref: '#/components/schemas/arnType' - AttachedManagedPolicies: - allOf: - - $ref: '#/components/schemas/attachedPoliciesListType' - - description: A list of the managed policies attached to the user. - CreateDate: - allOf: - - $ref: '#/components/schemas/dateType' - - description: The date and time, in ISO - 8601 date-time format, when the user was created. - GroupList: - allOf: - - $ref: '#/components/schemas/groupNameListType' - - description: A list of IAM groups that the user is in. - Path: - allOf: - - $ref: '#/components/schemas/pathType' - - description: The path to the user. For more information about paths, see - IAM - identifiers in the IAM User Guide. - PermissionsBoundary: - allOf: - - $ref: '#/components/schemas/AttachedPermissionsBoundary' - - description:

The ARN of the policy used to set the permissions boundary - for the user.

For more information about permissions boundaries, - see Permissions - boundaries for IAM identities in the IAM User Guide.

- Tags: - allOf: - - $ref: '#/components/schemas/tagListType' - - description: A list of tags that are associated with the user. For more - information about tagging, see Tagging - IAM resources in the IAM User Guide. - UserId: - allOf: - - $ref: '#/components/schemas/idType' - - description: The stable and unique string identifying the user. For more - information about IDs, see IAM - identifiers in the IAM User Guide. - UserName: - allOf: - - $ref: '#/components/schemas/userNameType' - - description: The friendly name identifying the user. - UserPolicyList: - allOf: - - $ref: '#/components/schemas/policyDetailListType' - - description: A list of the inline policies embedded in the user. - type: object - VirtualMFADevice: - description: Contains information about a virtual MFA device. - properties: - Base32StringSeed: - allOf: - - $ref: '#/components/schemas/BootstrapDatum' - - description: ' The base32 seed defined as specified in RFC3548. - The Base32StringSeed is base64-encoded. ' - EnableDate: - allOf: - - $ref: '#/components/schemas/dateType' - - description: The date and time on which the virtual MFA device was enabled. - QRCodePNG: - allOf: - - $ref: '#/components/schemas/BootstrapDatum' - - description: ' A QR code PNG image that encodes otpauth://totp/$virtualMFADeviceName@$AccountName?secret=$Base32String - where $virtualMFADeviceName is one of the create call arguments. - AccountName is the user name if set (otherwise, the account - ID otherwise), and Base32String is the seed in base32 format. - The Base32String value is base64-encoded. ' - SerialNumber: - allOf: - - $ref: '#/components/schemas/serialNumberType' - - description: The serial number associated with VirtualMFADevice. - Tags: - allOf: - - $ref: '#/components/schemas/tagListType' - - description: A list of tags that are attached to the virtual MFA device. - For more information about tagging, see Tagging - IAM resources in the IAM User Guide. - User: - allOf: - - $ref: '#/components/schemas/User' - - description: The IAM user associated with this virtual MFA device. - required: - - SerialNumber - type: object - accessKeyIdType: - maxLength: 128 - minLength: 16 - pattern: '[\w]+' - type: string - accessKeyMetadataListType: - description:

Contains a list of access key metadata.

This data type - is used as a response element in the ListAccessKeys operation.

- items: - allOf: - - $ref: '#/components/schemas/AccessKeyMetadata' - - xml: - name: member - type: array - accessKeySecretType: - format: password - type: string - accountAliasListType: - items: - allOf: - - $ref: '#/components/schemas/accountAliasType' - - xml: - name: member - type: array - accountAliasType: - maxLength: 63 - minLength: 3 - pattern: ^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$ - type: string - arnType: - description:

The Amazon Resource Name (ARN). ARNs are unique identifiers - for Amazon Web Services resources.

For more information about ARNs, - go to Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference. -

- maxLength: 2048 - minLength: 20 - type: string - assignmentStatusType: - enum: - - Assigned - - Unassigned - - Any - type: string - attachedPoliciesListType: - items: - allOf: - - $ref: '#/components/schemas/AttachedPolicy' - - xml: - name: member - type: array - attachmentCountType: - type: integer - authenticationCodeType: - maxLength: 6 - minLength: 6 - pattern: '[\d]+' - type: string - booleanObjectType: - type: boolean - booleanType: - type: boolean - certificateBodyType: - maxLength: 16384 - minLength: 1 - pattern: '[\u0009\u000A\u000D\u0020-\u00FF]+' - type: string - certificateChainType: - maxLength: 2097152 - minLength: 1 - pattern: '[\u0009\u000A\u000D\u0020-\u00FF]+' - type: string - certificateIdType: - maxLength: 128 - minLength: 24 - pattern: '[\w]+' - type: string - certificateListType: - description:

Contains a list of signing certificates.

This data type - is used as a response element in the ListSigningCertificates operation.

- items: - allOf: - - $ref: '#/components/schemas/SigningCertificate' - - xml: - name: member - type: array - clientIDListType: - items: - allOf: - - $ref: '#/components/schemas/clientIDType' - - xml: - name: member - type: array - clientIDType: - maxLength: 255 - minLength: 1 - type: string - customSuffixType: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - dateType: - format: date-time - type: string - encodingType: - enum: - - SSH - - PEM - type: string - entityDetailsListType: - items: - allOf: - - $ref: '#/components/schemas/EntityDetails' - - xml: - name: member - type: array - entityListType: - items: - allOf: - - $ref: '#/components/schemas/EntityType' - - xml: - name: member - type: array - entityNameType: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - existingUserNameType: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - globalEndpointTokenVersion: - enum: - - v1Token - - v2Token - type: string - groupDetailListType: - items: - allOf: - - $ref: '#/components/schemas/GroupDetail' - - xml: - name: member - type: array - groupListType: - description:

Contains a list of IAM groups.

This data type is used - as a response element in the ListGroups operation.

- items: - allOf: - - $ref: '#/components/schemas/Group' - - xml: - name: member - type: array - groupNameListType: - items: - allOf: - - $ref: '#/components/schemas/groupNameType' - - xml: - name: member - type: array - groupNameType: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - idType: - maxLength: 128 - minLength: 16 - pattern: '[\w]+' - type: string - instanceProfileListType: - description: Contains a list of instance profiles. - items: - allOf: - - $ref: '#/components/schemas/InstanceProfile' - - xml: - name: member - type: array - instanceProfileNameType: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - integerType: - type: integer - jobIDType: - maxLength: 36 - minLength: 36 - type: string - jobStatusType: - enum: - - IN_PROGRESS - - COMPLETED - - FAILED - type: string - listPolicyGrantingServiceAccessResponseListType: - items: - allOf: - - $ref: '#/components/schemas/ListPoliciesGrantingServiceAccessEntry' - - xml: - name: member - type: array - markerType: - maxLength: 320 - minLength: 1 - pattern: '[\u0020-\u00FF]+' - type: string - maxItemsType: - maximum: 1000 - minimum: 1 - type: integer - maxPasswordAgeType: - maximum: 1095 - minimum: 1 - type: integer - mfaDeviceListType: - description:

Contains a list of MFA devices.

This data type is used - as a response element in the ListMFADevices and ListVirtualMFADevices - operations.

- items: - allOf: - - $ref: '#/components/schemas/MFADevice' - - xml: - name: member - type: array - minimumPasswordLengthType: - maximum: 128 - minimum: 6 - type: integer - organizationsEntityPathType: - maxLength: 427 - minLength: 19 - pattern: ^o-[0-9a-z]{10,32}\/r-[0-9a-z]{4,32}[0-9a-z-\/]* - type: string - organizationsPolicyIdType: - pattern: ^p-[0-9a-zA-Z_]{8,128}$ - type: string - passwordReusePreventionType: - maximum: 24 - minimum: 1 - type: integer - passwordType: - format: password - maxLength: 128 - minLength: 1 - pattern: '[\u0009\u000A\u000D\u0020-\u00FF]+' - type: string - pathPrefixType: - maxLength: 512 - minLength: 1 - pattern: \u002F[\u0021-\u007F]* - type: string - pathType: - maxLength: 512 - minLength: 1 - pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F) - type: string - policyDescriptionType: - maxLength: 1000 - type: string - policyDetailListType: - items: - allOf: - - $ref: '#/components/schemas/PolicyDetail' - - xml: - name: member - type: array - policyDocumentType: - maxLength: 131072 - minLength: 1 - pattern: '[\u0009\u000A\u000D\u0020-\u00FF]+' - type: string - policyDocumentVersionListType: - items: - allOf: - - $ref: '#/components/schemas/PolicyVersion' - - xml: - name: member - type: array - policyGrantingServiceAccessListType: - items: - allOf: - - $ref: '#/components/schemas/PolicyGrantingServiceAccess' - - xml: - name: member - type: array - policyListType: - items: - allOf: - - $ref: '#/components/schemas/Policy' - - xml: - name: member - type: array - policyNameListType: - description:

Contains a list of policy names.

This data type is used - as a response element in the ListPolicies operation.

- items: - allOf: - - $ref: '#/components/schemas/policyNameType' - - xml: - name: member - type: array - policyNameType: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - policyOwnerEntityType: - enum: - - USER - - ROLE - - GROUP - type: string - policyPathType: - maxLength: 512 - minLength: 1 - pattern: ((/[A-Za-z0-9\.,\+@=_-]+)*)/ - type: string - policyScopeType: - enum: - - All - - AWS - - Local - type: string - policyType: - enum: - - INLINE - - MANAGED - type: string - policyVersionIdType: - pattern: v[1-9][0-9]*(\.[A-Za-z0-9-]*)? - type: string - privateKeyType: - format: password - maxLength: 16384 - minLength: 1 - pattern: '[\u0009\u000A\u000D\u0020-\u00FF]+' - type: string - publicKeyFingerprintType: - maxLength: 48 - minLength: 48 - pattern: '[:\w]+' - type: string - publicKeyIdType: - maxLength: 128 - minLength: 20 - pattern: '[\w]+' - type: string - publicKeyMaterialType: - maxLength: 16384 - minLength: 1 - pattern: '[\u0009\u000A\u000D\u0020-\u00FF]+' - type: string - responseMarkerType: - type: string - roleDescriptionType: - maxLength: 1000 - pattern: '[\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}]*' - type: string - roleDetailListType: - items: - allOf: - - $ref: '#/components/schemas/RoleDetail' - - xml: - name: member - type: array - roleListType: - description:

Contains a list of IAM roles.

This data type is used - as a response element in the ListRoles operation.

- items: - allOf: - - $ref: '#/components/schemas/Role' - - xml: - name: member - type: array - roleMaxSessionDurationType: - maximum: 43200 - minimum: 3600 - type: integer - roleNameType: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - serialNumberType: - maxLength: 256 - minLength: 9 - pattern: '[\w+=/:,.@-]+' - type: string - serverCertificateMetadataListType: - items: - allOf: - - $ref: '#/components/schemas/ServerCertificateMetadata' - - xml: - name: member - type: array - serverCertificateNameType: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - serviceName: - type: string - serviceNameType: - type: string - serviceNamespaceListType: - items: - allOf: - - $ref: '#/components/schemas/serviceNamespaceType' - - xml: - name: member - maxItems: 200 - minItems: 1 - type: array - serviceNamespaceType: - maxLength: 64 - minLength: 1 - pattern: '[\w-]*' - type: string - servicePassword: - format: password - type: string - serviceSpecificCredentialId: - maxLength: 128 - minLength: 20 - pattern: '[\w]+' - type: string - serviceUserName: - maxLength: 200 - minLength: 17 - pattern: '[\w+=,.@-]+' - type: string - sortKeyType: - enum: - - SERVICE_NAMESPACE_ASCENDING - - SERVICE_NAMESPACE_DESCENDING - - LAST_AUTHENTICATED_TIME_ASCENDING - - LAST_AUTHENTICATED_TIME_DESCENDING - type: string - statusType: - enum: - - Active - - Inactive - type: string - stringType: - type: string - summaryKeyType: - enum: - - Users - - UsersQuota - - Groups - - GroupsQuota - - ServerCertificates - - ServerCertificatesQuota - - UserPolicySizeQuota - - GroupPolicySizeQuota - - GroupsPerUserQuota - - SigningCertificatesPerUserQuota - - AccessKeysPerUserQuota - - MFADevices - - MFADevicesInUse - - AccountMFAEnabled - - AccountAccessKeysPresent - - AccountSigningCertificatesPresent - - AttachedPoliciesPerGroupQuota - - AttachedPoliciesPerRoleQuota - - AttachedPoliciesPerUserQuota - - Policies - - PoliciesQuota - - PolicySizeQuota - - PolicyVersionsInUse - - PolicyVersionsInUseQuota - - VersionsPerPolicyQuota - - GlobalEndpointTokenVersion - type: string - summaryMapType: - additionalProperties: - $ref: '#/components/schemas/summaryValueType' - type: object - summaryValueType: - type: integer - tagKeyListType: - items: - allOf: - - $ref: '#/components/schemas/tagKeyType' - - xml: - name: member - maxItems: 50 - type: array - tagKeyType: - maxLength: 128 - minLength: 1 - pattern: '[\p{L}\p{Z}\p{N}_.:/=+\-@]+' - type: string - tagListType: - items: - allOf: - - $ref: '#/components/schemas/Tag' - - xml: - name: member - maxItems: 50 - type: array - tagValueType: - maxLength: 256 - minLength: 0 - pattern: '[\p{L}\p{Z}\p{N}_.:/=+\-@]*' - type: string - thumbprintListType: - description: Contains a list of thumbprints of identity provider server certificates. - items: - allOf: - - $ref: '#/components/schemas/thumbprintType' - - xml: - name: member - type: array - thumbprintType: - description:

Contains a thumbprint for an identity provider's server certificate.

-

The identity provider's server certificate thumbprint is the hex-encoded - SHA-1 hash value of the self-signed X.509 certificate. This thumbprint is - used by the domain where the OpenID Connect provider makes its keys available. - The thumbprint is always a 40-character string.

- maxLength: 40 - minLength: 40 - type: string - userDetailListType: - items: - allOf: - - $ref: '#/components/schemas/UserDetail' - - xml: - name: member - type: array - userListType: - description:

Contains a list of users.

This data type is used as a - response element in the GetGroup and ListUsers operations.

- items: - allOf: - - $ref: '#/components/schemas/User' - - xml: - name: member - type: array - userNameType: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - virtualMFADeviceListType: - items: - allOf: - - $ref: '#/components/schemas/VirtualMFADevice' - - xml: - name: member - type: array - virtualMFADeviceName: - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - securitySchemes: - hmac: - description: Amazon Signature authorization v4 - in: header - name: Authorization - type: apiKey - x-amazon-apigateway-authtype: awsSigv4 - x-stackQL-resources: - access_key_last_useds: - id: aws.iam_api.access_key_last_useds - methods: - access_key_last_useds_Get: - operation: - $ref: '#/paths/~1?Action=GetAccessKeyLastUsed&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/GetAccessKeyLastUsedResult - openAPIDocKey: '200' - name: access_key_last_useds - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/access_key_last_useds/methods/access_key_last_useds_Get' - update: [] - title: access_key_last_useds - access_keys: - id: aws.iam_api.access_keys - methods: - access_keys_Create: - operation: - $ref: '#/paths/~1?Action=CreateAccessKey&Version=2010-05-08/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - access_keys_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteAccessKey&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - access_keys_List: - operation: - $ref: '#/paths/~1?Action=ListAccessKeys&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListAccessKeysResult/AccessKeyMetadata/member - openAPIDocKey: '200' - access_keys_Update: - operation: - $ref: '#/paths/~1?Action=UpdateAccessKey&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - name: access_keys - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/access_keys/methods/access_keys_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/access_keys/methods/access_keys_Create' - select: - - $ref: '#/components/x-stackQL-resources/access_keys/methods/access_keys_List' - update: [] - title: access_keys - account_alias: - id: aws.iam_api.account_alias - methods: - account_alias_Create: - operation: - $ref: '#/paths/~1?Action=CreateAccountAlias&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - account_alias_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteAccountAlias&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - name: account_alias - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/account_alias/methods/account_alias_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/account_alias/methods/account_alias_Create' - select: [] - update: [] - title: account_alias - account_aliases: - id: aws.iam_api.account_aliases - methods: - account_aliases_List: - operation: - $ref: '#/paths/~1?Action=ListAccountAliases&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListAccountAliasesResult/AccountAliases/member - openAPIDocKey: '200' - name: account_aliases - sqlVerbs: - delete: [] - insert: [] - select: [] - # - $ref: '#/components/x-stackQL-resources/account_aliases/methods/account_aliases_List' - update: [] - title: account_aliases - account_authorization_details: - id: aws.iam_api.account_authorization_details - methods: - account_authorization_details_Get: - operation: - $ref: '#/paths/~1?Action=GetAccountAuthorizationDetails&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/GetAccountAuthorizationDetailsResult - openAPIDocKey: '200' - name: account_authorization_details - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/account_authorization_details/methods/account_authorization_details_Get' - update: [] - title: account_authorization_details - account_password_policies: - id: aws.iam_api.account_password_policies - methods: - account_password_policies_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteAccountPasswordPolicy&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - account_password_policies_Get: - operation: - $ref: '#/paths/~1?Action=GetAccountPasswordPolicy&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/GetAccountPasswordPolicyResult - openAPIDocKey: '200' - account_password_policies_Update: - operation: - $ref: '#/paths/~1?Action=UpdateAccountPasswordPolicy&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - name: account_password_policies - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/account_password_policies/methods/account_password_policies_Delete' - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/account_password_policies/methods/account_password_policies_Get' - update: [] - title: account_password_policies - account_summaries: - id: aws.iam_api.account_summaries - methods: - account_summaries_Get: - operation: - $ref: '#/paths/~1?Action=GetAccountSummary&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/GetAccountSummaryResult - openAPIDocKey: '200' - name: account_summaries - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/account_summaries/methods/account_summaries_Get' - update: [] - title: account_summaries - assume_role_policies: - id: aws.iam_api.assume_role_policies - methods: - assume_role_policies_Update: - operation: - $ref: '#/paths/~1?Action=UpdateAssumeRolePolicy&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - name: assume_role_policies - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: assume_role_policies - attached_group_policies: - id: aws.iam_api.attached_group_policies - methods: - attached_group_policies_List: - operation: - $ref: '#/paths/~1?Action=ListAttachedGroupPolicies&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListAttachedGroupPoliciesResult/AttachedPolicies/member - openAPIDocKey: '200' - name: attached_group_policies - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/attached_group_policies/methods/attached_group_policies_List' - update: [] - title: attached_group_policies - attached_role_policies: - id: aws.iam_api.attached_role_policies - methods: - attached_role_policies_List: - operation: - $ref: '#/paths/~1?Action=ListAttachedRolePolicies&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListAttachedRolePoliciesResult/AttachedPolicies/member - openAPIDocKey: '200' - name: attached_role_policies - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/attached_role_policies/methods/attached_role_policies_List' - update: [] - title: attached_role_policies - attached_user_policies: - id: aws.iam_api.attached_user_policies - methods: - attached_user_policies_List: - operation: - $ref: '#/paths/~1?Action=ListAttachedUserPolicies&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListAttachedUserPoliciesResult/AttachedPolicies/member - openAPIDocKey: '200' - name: attached_user_policies - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/attached_user_policies/methods/attached_user_policies_List' - update: [] - title: attached_user_policies - client_id_from_open_id_connect_providers: - id: aws.iam_api.client_id_from_open_id_connect_providers - methods: - client_id_from_open_id_connect_providers_Remove: - operation: - $ref: '#/paths/~1?Action=RemoveClientIDFromOpenIDConnectProvider&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - name: client_id_from_open_id_connect_providers - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: client_id_from_open_id_connect_providers - # client_id_to_open_id_connect_providers: - # id: aws.iam_api.client_id_to_open_id_connect_providers - # methods: {} - # name: client_id_to_open_id_connect_providers - # sqlVerbs: - # delete: [] - # insert: [] - # select: [] - # update: [] - # title: client_id_to_open_id_connect_providers - context_keys_for_custom_policies: - id: aws.iam_api.context_keys_for_custom_policies - methods: - context_keys_for_custom_policies_Get: - operation: - $ref: '#/paths/~1?Action=GetContextKeysForCustomPolicy&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/GetContextKeysForCustomPolicyResult - openAPIDocKey: '200' - name: context_keys_for_custom_policies - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/context_keys_for_custom_policies/methods/context_keys_for_custom_policies_Get' - update: [] - title: context_keys_for_custom_policies - context_keys_for_principal_policies: - id: aws.iam_api.context_keys_for_principal_policies - methods: - context_keys_for_principal_policies_Get: - operation: - $ref: '#/paths/~1?Action=GetContextKeysForPrincipalPolicy&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/GetContextKeysForPrincipalPolicyResult - openAPIDocKey: '200' - name: context_keys_for_principal_policies - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/context_keys_for_principal_policies/methods/context_keys_for_principal_policies_Get' - update: [] - title: context_keys_for_principal_policies - credential_reports: - id: aws.iam_api.credential_reports - methods: - credential_reports_Generate: - operation: - $ref: '#/paths/~1?Action=GenerateCredentialReport&Version=2010-05-08/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - credential_reports_Get: - operation: - $ref: '#/paths/~1?Action=GetCredentialReport&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/GetCredentialReportResult - openAPIDocKey: '200' - name: credential_reports - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/credential_reports/methods/credential_reports_Get' - update: [] - title: credential_reports - custom_policies: - id: aws.iam_api.custom_policies - methods: - custom_policies_Simulate: - operation: - $ref: '#/paths/~1?Action=SimulateCustomPolicy&Version=2010-05-08/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - name: custom_policies - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: custom_policies - default_policy_versions: - id: aws.iam_api.default_policy_versions - methods: - default_policy_versions_Set: - operation: - $ref: '#/paths/~1?Action=SetDefaultPolicyVersion&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - name: default_policy_versions - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: default_policy_versions - entities_for_policies: - id: aws.iam_api.entities_for_policies - methods: - entities_for_policies_List: - operation: - $ref: '#/paths/~1?Action=ListEntitiesForPolicy&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListEntitiesForPolicyResult/PolicyGroups/member - openAPIDocKey: '200' - name: entities_for_policies - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/entities_for_policies/methods/entities_for_policies_List' - update: [] - title: entities_for_policies - group_policies: - id: aws.iam_api.group_policies - methods: - group_policies_Attach: - operation: - $ref: '#/paths/~1?Action=AttachGroupPolicy&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - group_policies_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteGroupPolicy&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - group_policies_Detach: - operation: - $ref: '#/paths/~1?Action=DetachGroupPolicy&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - group_policies_Get: - operation: - $ref: '#/paths/~1?Action=GetGroupPolicy&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/GetGroupPolicyResult - openAPIDocKey: '200' - group_policies_List: - operation: - $ref: '#/paths/~1?Action=ListGroupPolicies&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListGroupPoliciesResult/PolicyNames/member - openAPIDocKey: '200' - group_policies_Put: - operation: - $ref: '#/paths/~1?Action=PutGroupPolicy&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - name: group_policies - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/group_policies/methods/group_policies_Delete' - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/group_policies/methods/group_policies_Get' - - $ref: '#/components/x-stackQL-resources/group_policies/methods/group_policies_List' - update: [] - title: group_policies - groups: - id: aws.iam_api.groups - methods: - groups_Create: - operation: - $ref: '#/paths/~1?Action=CreateGroup&Version=2010-05-08/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - groups_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteGroup&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - groups_Get: - operation: - $ref: '#/paths/~1?Action=GetGroup&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/GetGroupResult/Group - openAPIDocKey: '200' - groups_List: - operation: - $ref: '#/paths/~1?Action=ListGroups&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListGroupsResult/Groups/member - openAPIDocKey: '200' - groups_Update: - operation: - $ref: '#/paths/~1?Action=UpdateGroup&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - name: groups - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/groups/methods/groups_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/groups/methods/groups_Create' - select: - - $ref: '#/components/x-stackQL-resources/groups/methods/groups_Get' - - $ref: '#/components/x-stackQL-resources/groups/methods/groups_List' - update: [] - title: groups - groups_for_users: - id: aws.iam_api.groups_for_users - methods: - groups_for_users_List: - operation: - $ref: '#/paths/~1?Action=ListGroupsForUser&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListGroupsForUserResult/Groups/member - openAPIDocKey: '200' - name: groups_for_users - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/groups_for_users/methods/groups_for_users_List' - update: [] - title: groups_for_users - instance_profile_tags: - id: aws.iam_api.instance_profile_tags - methods: - instance_profile_tags_List: - operation: - $ref: '#/paths/~1?Action=ListInstanceProfileTags&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListInstanceProfileTagsResult/Tags/member - openAPIDocKey: '200' - name: instance_profile_tags - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/instance_profile_tags/methods/instance_profile_tags_List' - update: [] - title: instance_profile_tags - instance_profiles: - id: aws.iam_api.instance_profiles - methods: - instance_profiles_Create: - operation: - $ref: '#/paths/~1?Action=CreateInstanceProfile&Version=2010-05-08/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - instance_profiles_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteInstanceProfile&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - instance_profiles_Get: - operation: - $ref: '#/paths/~1?Action=GetInstanceProfile&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/GetInstanceProfileResult - openAPIDocKey: '200' - instance_profiles_List: - operation: - $ref: '#/paths/~1?Action=ListInstanceProfiles&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListInstanceProfilesResult/InstanceProfiles/member - openAPIDocKey: '200' - instance_profiles_Tag: - operation: - $ref: '#/paths/~1?Action=TagInstanceProfile&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - instance_profiles_Untag: - operation: - $ref: '#/paths/~1?Action=UntagInstanceProfile&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - name: instance_profiles - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/instance_profiles/methods/instance_profiles_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/instance_profiles/methods/instance_profiles_Create' - select: - - $ref: '#/components/x-stackQL-resources/instance_profiles/methods/instance_profiles_Get' - - $ref: '#/components/x-stackQL-resources/instance_profiles/methods/instance_profiles_List' - update: [] - title: instance_profiles - instance_profiles_for_roles: - id: aws.iam_api.instance_profiles_for_roles - methods: - instance_profiles_for_roles_List: - operation: - $ref: '#/paths/~1?Action=ListInstanceProfilesForRole&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListInstanceProfilesForRoleResult/InstanceProfiles/member - openAPIDocKey: '200' - name: instance_profiles_for_roles - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/instance_profiles_for_roles/methods/instance_profiles_for_roles_List' - update: [] - title: instance_profiles_for_roles - login_profiles: - id: aws.iam_api.login_profiles - methods: - login_profiles_Create: - operation: - $ref: '#/paths/~1?Action=CreateLoginProfile&Version=2010-05-08/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - login_profiles_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteLoginProfile&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - login_profiles_Get: - operation: - $ref: '#/paths/~1?Action=GetLoginProfile&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/GetLoginProfileResult - openAPIDocKey: '200' - login_profiles_Update: - operation: - $ref: '#/paths/~1?Action=UpdateLoginProfile&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - name: login_profiles - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/login_profiles/methods/login_profiles_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/login_profiles/methods/login_profiles_Create' - select: - - $ref: '#/components/x-stackQL-resources/login_profiles/methods/login_profiles_Get' - update: [] - title: login_profiles - mfa_device_tags: - id: aws.iam_api.mfa_device_tags - methods: - mfa_device_tags_List: - operation: - $ref: '#/paths/~1?Action=ListMFADeviceTags&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListMFADeviceTagsResult/Tags/member - openAPIDocKey: '200' - name: mfa_device_tags - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/mfa_device_tags/methods/mfa_device_tags_List' - update: [] - title: mfa_device_tags - mfa_devices: - id: aws.iam_api.mfa_devices - methods: - mfa_devices_Deactivate: - operation: - $ref: '#/paths/~1?Action=DeactivateMFADevice&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - mfa_devices_Enable: - operation: - $ref: '#/paths/~1?Action=EnableMFADevice&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - mfa_devices_List: - operation: - $ref: '#/paths/~1?Action=ListMFADevices&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListMFADevicesResult/MFADevices/member - openAPIDocKey: '200' - mfa_devices_Resync: - operation: - $ref: '#/paths/~1?Action=ResyncMFADevice&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - mfa_devices_Tag: - operation: - $ref: '#/paths/~1?Action=TagMFADevice&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - mfa_devices_Untag: - operation: - $ref: '#/paths/~1?Action=UntagMFADevice&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - name: mfa_devices - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/mfa_devices/methods/mfa_devices_List' - update: [] - title: mfa_devices - open_id_connect_provider_tags: - id: aws.iam_api.open_id_connect_provider_tags - methods: - open_id_connect_provider_tags_List: - operation: - $ref: '#/paths/~1?Action=ListOpenIDConnectProviderTags&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListOpenIDConnectProviderTagsResult/Tags/member - openAPIDocKey: '200' - name: open_id_connect_provider_tags - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/open_id_connect_provider_tags/methods/open_id_connect_provider_tags_List' - update: [] - title: open_id_connect_provider_tags - open_id_connect_provider_thumbprints: - id: aws.iam_api.open_id_connect_provider_thumbprints - methods: - open_id_connect_provider_thumbprints_Update: - operation: - $ref: '#/paths/~1?Action=UpdateOpenIDConnectProviderThumbprint&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - name: open_id_connect_provider_thumbprints - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: open_id_connect_provider_thumbprints - open_id_connect_providers: - id: aws.iam_api.open_id_connect_providers - methods: - open_id_connect_providers_Create: - operation: - $ref: '#/paths/~1?Action=CreateOpenIDConnectProvider&Version=2010-05-08/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - open_id_connect_providers_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteOpenIDConnectProvider&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - open_id_connect_providers_Get: - operation: - $ref: '#/paths/~1?Action=GetOpenIDConnectProvider&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/GetOpenIDConnectProviderResult - openAPIDocKey: '200' - open_id_connect_providers_List: - operation: - $ref: '#/paths/~1?Action=ListOpenIDConnectProviders&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListOpenIDConnectProvidersResult/OpenIDConnectProviderList/member - openAPIDocKey: '200' - open_id_connect_providers_Tag: - operation: - $ref: '#/paths/~1?Action=TagOpenIDConnectProvider&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - open_id_connect_providers_Untag: - operation: - $ref: '#/paths/~1?Action=UntagOpenIDConnectProvider&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - name: open_id_connect_providers - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/open_id_connect_providers/methods/open_id_connect_providers_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/open_id_connect_providers/methods/open_id_connect_providers_Create' - select: - - $ref: '#/components/x-stackQL-resources/open_id_connect_providers/methods/open_id_connect_providers_Get' - - $ref: '#/components/x-stackQL-resources/open_id_connect_providers/methods/open_id_connect_providers_List' - update: [] - title: open_id_connect_providers - organizations_access_reports: - id: aws.iam_api.organizations_access_reports - methods: - organizations_access_reports_Generate: - operation: - $ref: '#/paths/~1?Action=GenerateOrganizationsAccessReport&Version=2010-05-08/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - organizations_access_reports_Get: - operation: - $ref: '#/paths/~1?Action=GetOrganizationsAccessReport&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/GetOrganizationsAccessReportResult - openAPIDocKey: '200' - name: organizations_access_reports - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/organizations_access_reports/methods/organizations_access_reports_Get' - update: [] - title: organizations_access_reports - passwords: - id: aws.iam_api.passwords - methods: - passwords_Change: - operation: - $ref: '#/paths/~1?Action=ChangePassword&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - name: passwords - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: passwords - policies: - id: aws.iam_api.policies - methods: - policies_Create: - operation: - $ref: '#/paths/~1?Action=CreatePolicy&Version=2010-05-08/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - policies_Delete: - operation: - $ref: '#/paths/~1?Action=DeletePolicy&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - policies_Get: - operation: - $ref: '#/paths/~1?Action=GetPolicy&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/GetPolicyResult - openAPIDocKey: '200' - policies_List: - operation: - $ref: '#/paths/~1?Action=ListPolicies&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListPoliciesResult/Policies/member - openAPIDocKey: '200' - policies_Tag: - operation: - $ref: '#/paths/~1?Action=TagPolicy&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - policies_Untag: - operation: - $ref: '#/paths/~1?Action=UntagPolicy&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - name: policies - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/policies/methods/policies_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/policies/methods/policies_Create' - select: - - $ref: '#/components/x-stackQL-resources/policies/methods/policies_Get' - - $ref: '#/components/x-stackQL-resources/policies/methods/policies_List' - update: [] - title: policies - policy_tags: - id: aws.iam_api.policy_tags - methods: - policy_tags_List: - operation: - $ref: '#/paths/~1?Action=ListPolicyTags&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListPolicyTagsResult/Tags/member - openAPIDocKey: '200' - name: policy_tags - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/policy_tags/methods/policy_tags_List' - update: [] - title: policy_tags - policy_versions: - id: aws.iam_api.policy_versions - methods: - policy_versions_Create: - operation: - $ref: '#/paths/~1?Action=CreatePolicyVersion&Version=2010-05-08/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - policy_versions_Delete: - operation: - $ref: '#/paths/~1?Action=DeletePolicyVersion&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - policy_versions_Get: - operation: - $ref: '#/paths/~1?Action=GetPolicyVersion&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/GetPolicyVersionResult - openAPIDocKey: '200' - policy_versions_List: - operation: - $ref: '#/paths/~1?Action=ListPolicyVersions&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListPolicyVersionsResult/Versions/member - openAPIDocKey: '200' - name: policy_versions - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/policy_versions/methods/policy_versions_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/policy_versions/methods/policy_versions_Create' - select: - - $ref: '#/components/x-stackQL-resources/policy_versions/methods/policy_versions_Get' - - $ref: '#/components/x-stackQL-resources/policy_versions/methods/policy_versions_List' - update: [] - title: policy_versions - principal_policies: - id: aws.iam_api.principal_policies - methods: - principal_policies_Simulate: - operation: - $ref: '#/paths/~1?Action=SimulatePrincipalPolicy&Version=2010-05-08/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - name: principal_policies - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: principal_policies - role_descriptions: - id: aws.iam_api.role_descriptions - methods: - role_descriptions_Update: - operation: - $ref: '#/paths/~1?Action=UpdateRoleDescription&Version=2010-05-08/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - name: role_descriptions - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: role_descriptions - role_from_instance_profiles: - id: aws.iam_api.role_from_instance_profiles - methods: - role_from_instance_profiles_Remove: - operation: - $ref: '#/paths/~1?Action=RemoveRoleFromInstanceProfile&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - name: role_from_instance_profiles - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: role_from_instance_profiles - role_permissions_boundaries: - id: aws.iam_api.role_permissions_boundaries - methods: - role_permissions_boundaries_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteRolePermissionsBoundary&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - role_permissions_boundaries_Put: - operation: - $ref: '#/paths/~1?Action=PutRolePermissionsBoundary&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - name: role_permissions_boundaries - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/role_permissions_boundaries/methods/role_permissions_boundaries_Delete' - insert: [] - select: [] - update: [] - title: role_permissions_boundaries - role_policies: - id: aws.iam_api.role_policies - methods: - role_policies_Attach: - operation: - $ref: '#/paths/~1?Action=AttachRolePolicy&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - role_policies_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteRolePolicy&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - role_policies_Detach: - operation: - $ref: '#/paths/~1?Action=DetachRolePolicy&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - role_policies_Get: - operation: - $ref: '#/paths/~1?Action=GetRolePolicy&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/GetRolePolicyResult - openAPIDocKey: '200' - role_policies_List: - operation: - $ref: '#/paths/~1?Action=ListRolePolicies&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListRolePoliciesResult/PolicyNames/member - openAPIDocKey: '200' - role_policies_Put: - operation: - $ref: '#/paths/~1?Action=PutRolePolicy&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - name: role_policies - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/role_policies/methods/role_policies_Delete' - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/role_policies/methods/role_policies_Get' - - $ref: '#/components/x-stackQL-resources/role_policies/methods/role_policies_List' - update: [] - title: role_policies - role_tags: - id: aws.iam_api.role_tags - methods: - role_tags_List: - operation: - $ref: '#/paths/~1?Action=ListRoleTags&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListRoleTagsResult/Tags/member - openAPIDocKey: '200' - name: role_tags - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/role_tags/methods/role_tags_List' - update: [] - title: role_tags - role_to_instance_profiles: - id: aws.iam_api.role_to_instance_profiles - methods: - role_to_instance_profiles_Add: - operation: - $ref: '#/paths/~1?Action=AddRoleToInstanceProfile&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - name: role_to_instance_profiles - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: role_to_instance_profiles - roles: - id: aws.iam_api.roles - methods: - roles_Create: - operation: - $ref: '#/paths/~1?Action=CreateRole&Version=2010-05-08/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - roles_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteRole&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - roles_Get: - operation: - $ref: '#/paths/~1?Action=GetRole&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/GetRoleResult/Role - openAPIDocKey: '200' - roles_List: - operation: - $ref: '#/paths/~1?Action=ListRoles&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListRolesResult/Roles/member - openAPIDocKey: '200' - roles_Tag: - operation: - $ref: '#/paths/~1?Action=TagRole&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - roles_Untag: - operation: - $ref: '#/paths/~1?Action=UntagRole&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - roles_Update: - operation: - $ref: '#/paths/~1?Action=UpdateRole&Version=2010-05-08/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - name: roles - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/roles/methods/roles_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/roles/methods/roles_Create' - select: - - $ref: '#/components/x-stackQL-resources/roles/methods/roles_Get' - - $ref: '#/components/x-stackQL-resources/roles/methods/roles_List' - update: [] - title: roles - saml_provider_tags: - id: aws.iam_api.saml_provider_tags - methods: - saml_provider_tags_List: - operation: - $ref: '#/paths/~1?Action=ListSAMLProviderTags&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListSAMLProviderTagsResult/Tags/member - openAPIDocKey: '200' - name: saml_provider_tags - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/saml_provider_tags/methods/saml_provider_tags_List' - update: [] - title: saml_provider_tags - saml_providers: - id: aws.iam_api.saml_providers - methods: - saml_providers_Create: - operation: - $ref: '#/paths/~1?Action=CreateSAMLProvider&Version=2010-05-08/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - saml_providers_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteSAMLProvider&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - saml_providers_Get: - operation: - $ref: '#/paths/~1?Action=GetSAMLProvider&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/GetSAMLProviderResult - openAPIDocKey: '200' - saml_providers_List: - operation: - $ref: '#/paths/~1?Action=ListSAMLProviders&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListSAMLProvidersResult/SAMLProviderList/member - openAPIDocKey: '200' - saml_providers_Tag: - operation: - $ref: '#/paths/~1?Action=TagSAMLProvider&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - saml_providers_Untag: - operation: - $ref: '#/paths/~1?Action=UntagSAMLProvider&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - saml_providers_Update: - operation: - $ref: '#/paths/~1?Action=UpdateSAMLProvider&Version=2010-05-08/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - name: saml_providers - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/saml_providers/methods/saml_providers_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/saml_providers/methods/saml_providers_Create' - select: - - $ref: '#/components/x-stackQL-resources/saml_providers/methods/saml_providers_Get' - - $ref: '#/components/x-stackQL-resources/saml_providers/methods/saml_providers_List' - update: [] - title: saml_providers - security_token_service_preferences: - id: aws.iam_api.security_token_service_preferences - methods: - security_token_service_preferences_Set: - operation: - $ref: '#/paths/~1?Action=SetSecurityTokenServicePreferences&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - name: security_token_service_preferences - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: security_token_service_preferences - server_certificate_tags: - id: aws.iam_api.server_certificate_tags - methods: - server_certificate_tags_List: - operation: - $ref: '#/paths/~1?Action=ListServerCertificateTags&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListServerCertificateTagsResult/Tags/member - openAPIDocKey: '200' - name: server_certificate_tags - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/server_certificate_tags/methods/server_certificate_tags_List' - update: [] - title: server_certificate_tags - server_certificates: - id: aws.iam_api.server_certificates - methods: - server_certificates_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteServerCertificate&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - server_certificates_Get: - operation: - $ref: '#/paths/~1?Action=GetServerCertificate&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/GetServerCertificateResult - openAPIDocKey: '200' - server_certificates_List: - operation: - $ref: '#/paths/~1?Action=ListServerCertificates&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListServerCertificatesResult/ServerCertificateMetadataList/member - openAPIDocKey: '200' - server_certificates_Tag: - operation: - $ref: '#/paths/~1?Action=TagServerCertificate&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - server_certificates_Untag: - operation: - $ref: '#/paths/~1?Action=UntagServerCertificate&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - server_certificates_Update: - operation: - $ref: '#/paths/~1?Action=UpdateServerCertificate&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - server_certificates_Upload: - operation: - $ref: '#/paths/~1?Action=UploadServerCertificate&Version=2010-05-08/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - name: server_certificates - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/server_certificates/methods/server_certificates_Delete' - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/server_certificates/methods/server_certificates_Get' - - $ref: '#/components/x-stackQL-resources/server_certificates/methods/server_certificates_List' - update: [] - title: server_certificates - service_last_accessed_details: - id: aws.iam_api.service_last_accessed_details - methods: - service_last_accessed_details_Generate: - operation: - $ref: '#/paths/~1?Action=GenerateServiceLastAccessedDetails&Version=2010-05-08/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - service_last_accessed_details_Get: - operation: - $ref: '#/paths/~1?Action=GetServiceLastAccessedDetails&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/GetServiceLastAccessedDetailsResult - openAPIDocKey: '200' - name: service_last_accessed_details - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/service_last_accessed_details/methods/service_last_accessed_details_Get' - update: [] - title: service_last_accessed_details - service_last_accessed_details_with_entities: - id: aws.iam_api.service_last_accessed_details_with_entities - methods: - service_last_accessed_details_with_entities_Get: - operation: - $ref: '#/paths/~1?Action=GetServiceLastAccessedDetailsWithEntities&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/GetServiceLastAccessedDetailsWithEntitiesResult - openAPIDocKey: '200' - name: service_last_accessed_details_with_entities - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/service_last_accessed_details_with_entities/methods/service_last_accessed_details_with_entities_Get' - update: [] - title: service_last_accessed_details_with_entities - service_linked_role_deletion_status: - id: aws.iam_api.service_linked_role_deletion_status - methods: - service_linked_role_deletion_status_Get: - operation: - $ref: '#/paths/~1?Action=GetServiceLinkedRoleDeletionStatus&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/GetServiceLinkedRoleDeletionStatusResult - openAPIDocKey: '200' - name: service_linked_role_deletion_status - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/service_linked_role_deletion_status/methods/service_linked_role_deletion_status_Get' - update: [] - title: service_linked_role_deletion_status - service_linked_roles: - id: aws.iam_api.service_linked_roles - methods: - service_linked_roles_Create: - operation: - $ref: '#/paths/~1?Action=CreateServiceLinkedRole&Version=2010-05-08/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - service_linked_roles_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteServiceLinkedRole&Version=2010-05-08/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - name: service_linked_roles - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/service_linked_roles/methods/service_linked_roles_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/service_linked_roles/methods/service_linked_roles_Create' - select: [] - update: [] - title: service_linked_roles - service_specific_credentials: - id: aws.iam_api.service_specific_credentials - methods: - service_specific_credentials_Create: - operation: - $ref: '#/paths/~1?Action=CreateServiceSpecificCredential&Version=2010-05-08/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - service_specific_credentials_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteServiceSpecificCredential&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - service_specific_credentials_List: - operation: - $ref: '#/paths/~1?Action=ListServiceSpecificCredentials&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListServiceSpecificCredentialsResult/ServiceSpecificCredentials/member - openAPIDocKey: '200' - service_specific_credentials_Reset: - operation: - $ref: '#/paths/~1?Action=ResetServiceSpecificCredential&Version=2010-05-08/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - service_specific_credentials_Update: - operation: - $ref: '#/paths/~1?Action=UpdateServiceSpecificCredential&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - name: service_specific_credentials - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/service_specific_credentials/methods/service_specific_credentials_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/service_specific_credentials/methods/service_specific_credentials_Create' - select: - - $ref: '#/components/x-stackQL-resources/service_specific_credentials/methods/service_specific_credentials_List' - update: [] - title: service_specific_credentials - signing_certificates: - id: aws.iam_api.signing_certificates - methods: - signing_certificates_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteSigningCertificate&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - signing_certificates_List: - operation: - $ref: '#/paths/~1?Action=ListSigningCertificates&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListSigningCertificatesResult/Certificates/member - openAPIDocKey: '200' - signing_certificates_Update: - operation: - $ref: '#/paths/~1?Action=UpdateSigningCertificate&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - signing_certificates_Upload: - operation: - $ref: '#/paths/~1?Action=UploadSigningCertificate&Version=2010-05-08/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - name: signing_certificates - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/signing_certificates/methods/signing_certificates_Delete' - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/signing_certificates/methods/signing_certificates_List' - update: [] - title: signing_certificates - ssh_public_keys: - id: aws.iam_api.ssh_public_keys - methods: - ssh_public_keys_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteSSHPublicKey&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - ssh_public_keys_Get: - operation: - $ref: '#/paths/~1?Action=GetSSHPublicKey&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/GetSSHPublicKeyResult - openAPIDocKey: '200' - ssh_public_keys_List: - operation: - $ref: '#/paths/~1?Action=ListSSHPublicKeys&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListSSHPublicKeysResult/SSHPublicKeys/member - openAPIDocKey: '200' - ssh_public_keys_Update: - operation: - $ref: '#/paths/~1?Action=UpdateSSHPublicKey&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - ssh_public_keys_Upload: - operation: - $ref: '#/paths/~1?Action=UploadSSHPublicKey&Version=2010-05-08/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - name: ssh_public_keys - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/ssh_public_keys/methods/ssh_public_keys_Delete' - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/ssh_public_keys/methods/ssh_public_keys_Get' - - $ref: '#/components/x-stackQL-resources/ssh_public_keys/methods/ssh_public_keys_List' - update: [] - title: ssh_public_keys - user_from_groups: - id: aws.iam_api.user_from_groups - methods: - user_from_groups_Remove: - operation: - $ref: '#/paths/~1?Action=RemoveUserFromGroup&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - name: user_from_groups - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: user_from_groups - user_permissions_boundaries: - id: aws.iam_api.user_permissions_boundaries - methods: - user_permissions_boundaries_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteUserPermissionsBoundary&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - user_permissions_boundaries_Put: - operation: - $ref: '#/paths/~1?Action=PutUserPermissionsBoundary&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - name: user_permissions_boundaries - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/user_permissions_boundaries/methods/user_permissions_boundaries_Delete' - insert: [] - select: [] - update: [] - title: user_permissions_boundaries - user_policies: - id: aws.iam_api.user_policies - methods: - user_policies_Attach: - operation: - $ref: '#/paths/~1?Action=AttachUserPolicy&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - user_policies_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteUserPolicy&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - user_policies_Detach: - operation: - $ref: '#/paths/~1?Action=DetachUserPolicy&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - user_policies_Get: - operation: - $ref: '#/paths/~1?Action=GetUserPolicy&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/GetUserPolicyResult - openAPIDocKey: '200' - user_policies_List: - operation: - $ref: '#/paths/~1?Action=ListUserPolicies&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListUserPoliciesResult/PolicyNames/member - openAPIDocKey: '200' - user_policies_Put: - operation: - $ref: '#/paths/~1?Action=PutUserPolicy&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - name: user_policies - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/user_policies/methods/user_policies_Delete' - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/user_policies/methods/user_policies_Get' - - $ref: '#/components/x-stackQL-resources/user_policies/methods/user_policies_List' - update: [] - title: user_policies - user_tags: - id: aws.iam_api.user_tags - methods: - user_tags_List: - operation: - $ref: '#/paths/~1?Action=ListUserTags&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListUserTagsResult/Tags/member - openAPIDocKey: '200' - name: user_tags - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/user_tags/methods/user_tags_List' - update: [] - title: user_tags - user_to_groups: - id: aws.iam_api.user_to_groups - methods: - user_to_groups_Add: - operation: - $ref: '#/paths/~1?Action=AddUserToGroup&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - name: user_to_groups - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: user_to_groups - users: - id: aws.iam_api.users - methods: - users_Create: - operation: - $ref: '#/paths/~1?Action=CreateUser&Version=2010-05-08/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - users_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteUser&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - users_Get: - operation: - $ref: '#/paths/~1?Action=GetUser&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/GetUserResult/User - openAPIDocKey: '200' - users_List: - operation: - $ref: '#/paths/~1?Action=ListUsers&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListUsersResult/Users/member - openAPIDocKey: '200' - users_Tag: - operation: - $ref: '#/paths/~1?Action=TagUser&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - users_Untag: - operation: - $ref: '#/paths/~1?Action=UntagUser&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - users_Update: - operation: - $ref: '#/paths/~1?Action=UpdateUser&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - name: users - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/users/methods/users_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/users/methods/users_Create' - select: - - $ref: '#/components/x-stackQL-resources/users/methods/users_List' - update: [] - title: users - virtual_mfa_devices: - id: aws.iam_api.virtual_mfa_devices - methods: - virtual_mfa_devices_Create: - operation: - $ref: '#/paths/~1?Action=CreateVirtualMFADevice&Version=2010-05-08/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - virtual_mfa_devices_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteVirtualMFADevice&Version=2010-05-08/get' - response: - openAPIDocKey: '200' - virtual_mfa_devices_List: - operation: - $ref: '#/paths/~1?Action=ListVirtualMFADevices&Version=2010-05-08/get' - response: - mediaType: text/xml - objectKey: /*/ListVirtualMFADevicesResult/VirtualMFADevices/member - openAPIDocKey: '200' - name: virtual_mfa_devices - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/virtual_mfa_devices/methods/virtual_mfa_devices_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/virtual_mfa_devices/methods/virtual_mfa_devices_Create' - select: - - $ref: '#/components/x-stackQL-resources/virtual_mfa_devices/methods/virtual_mfa_devices_List' - update: [] - title: virtual_mfa_devices -externalDocs: - description: Amazon Web Services documentation - url: https://docs.aws.amazon.com/iam/ -info: - contact: - email: mike.ralphson@gmail.com - name: Mike Ralphson - url: https://github.com/mermade/aws2openapi - x-twitter: PermittedSoc - description: Identity and Access Management

Identity and - Access Management (IAM) is a web service for securely controlling access to Amazon - Web Services services. With IAM, you can centrally manage users, security credentials - such as access keys, and permissions that control which Amazon Web Services resources - users and applications can access. For more information about IAM, see Identity - and Access Management (IAM) and the Identity - and Access Management User Guide.

- license: - name: Apache 2.0 License - url: http://www.apache.org/licenses/ - termsOfService: https://aws.amazon.com/service-terms/ - title: AWS Identity and Access Management - version: '2010-05-08' - x-apiClientRegistration: - url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct - x-apisguru-categories: - - cloud - x-logo: - backgroundColor: '#FFFFFF' - url: https://twitter.com/awscloud/profile_image?size=original - x-origin: - - contentType: application/json - converter: - url: https://github.com/mermade/aws2openapi - version: 1.0.0 - url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/iam-2010-05-08.normal.json - x-apisguru-driver: external - x-preferred: true - x-providerName: amazonaws.com - x-release: v4 - x-serviceName: iam -openapi: 3.0.0 -paths: - /?Action=AddClientIDToOpenIDConnectProvider&Version=2010-05-08: - get: - description:

Adds a new client ID (also known as audience) to the list of - client IDs already registered for the specified IAM OpenID Connect (OIDC) - provider resource.

This operation is idempotent; it does not fail or - return an error if you add an existing client ID to the provider.

- operationId: GET_AddClientIDToOpenIDConnectProvider - parameters: - - description: The Amazon Resource Name (ARN) of the IAM OpenID Connect (OIDC) - provider resource to add the client ID to. You can get a list of OIDC provider - ARNs by using the ListOpenIDConnectProviders operation. - in: query - name: OpenIDConnectProviderArn - required: true - schema: - description:

The Amazon Resource Name (ARN). ARNs are unique identifiers - for Amazon Web Services resources.

For more information about ARNs, - go to Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference. -

- maxLength: 2048 - minLength: 20 - type: string - - description: The client ID (also known as audience) to add to the IAM OpenID - Connect provider resource. - in: query - name: ClientID - required: true - schema: - maxLength: 255 - minLength: 1 - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: AddClientIDToOpenIDConnectProvider - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Adds a new client ID (also known as audience) to the list of - client IDs already registered for the specified IAM OpenID Connect (OIDC) - provider resource.

This operation is idempotent; it does not fail or - return an error if you add an existing client ID to the provider.

- operationId: POST_AddClientIDToOpenIDConnectProvider - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/AddClientIDToOpenIDConnectProviderRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: AddClientIDToOpenIDConnectProvider - /?Action=AddRoleToInstanceProfile&Version=2010-05-08: - get: - description:

Adds the specified IAM role to the specified instance profile. - An instance profile can contain only one role, and this quota cannot be increased. - You can remove the existing role and then add a different role to an instance - profile. You must then wait for the change to appear across all of Amazon - Web Services because of eventual - consistency. To force the change, you must disassociate - the instance profile and then associate - the instance profile, or you can stop your instance and then restart it.

-

The caller of this operation must be granted the PassRole - permission on the IAM role by a permissions policy.

For more - information about roles, see Working - with roles. For more information about instance profiles, see About - instance profiles.

- operationId: GET_AddRoleToInstanceProfile - parameters: - - description: '

The name of the instance profile to update.

This parameter - allows (through its regex pattern) - a string of characters consisting of upper and lowercase alphanumeric characters - with no spaces. You can also include any of the following characters: _+=,.@-

' - in: query - name: InstanceProfileName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: '

The name of the role to add.

This parameter allows - (through its regex pattern) - a string of characters consisting of upper and lowercase alphanumeric characters - with no spaces. You can also include any of the following characters: _+=,.@-

' - in: query - name: RoleName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityAlreadyExistsException' - description: EntityAlreadyExistsException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/UnmodifiableEntityException' - description: UnmodifiableEntityException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: AddRoleToInstanceProfile - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Adds the specified IAM role to the specified instance profile. - An instance profile can contain only one role, and this quota cannot be increased. - You can remove the existing role and then add a different role to an instance - profile. You must then wait for the change to appear across all of Amazon - Web Services because of eventual - consistency. To force the change, you must disassociate - the instance profile and then associate - the instance profile, or you can stop your instance and then restart it.

-

The caller of this operation must be granted the PassRole - permission on the IAM role by a permissions policy.

For more - information about roles, see Working - with roles. For more information about instance profiles, see About - instance profiles.

- operationId: POST_AddRoleToInstanceProfile - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/AddRoleToInstanceProfileRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityAlreadyExistsException' - description: EntityAlreadyExistsException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/UnmodifiableEntityException' - description: UnmodifiableEntityException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: AddRoleToInstanceProfile - /?Action=AddUserToGroup&Version=2010-05-08: - get: - description: Adds the specified user to the specified group. - operationId: GET_AddUserToGroup - parameters: - - description: '

The name of the group to update.

This parameter allows - (through its regex pattern) - a string of characters consisting of upper and lowercase alphanumeric characters - with no spaces. You can also include any of the following characters: _+=,.@-

' - in: query - name: GroupName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: '

The name of the user to add.

This parameter allows - (through its regex pattern) - a string of characters consisting of upper and lowercase alphanumeric characters - with no spaces. You can also include any of the following characters: _+=,.@-

' - in: query - name: UserName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: AddUserToGroup - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description: Adds the specified user to the specified group. - operationId: POST_AddUserToGroup - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/AddUserToGroupRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: AddUserToGroup - /?Action=AttachGroupPolicy&Version=2010-05-08: - get: - description:

Attaches the specified managed policy to the specified IAM group.

-

You use this operation to attach a managed policy to a group. To embed - an inline policy in a group, use PutGroupPolicy.

As a best practice, - you can validate your IAM policies. To learn more, see Validating - IAM policies in the IAM User Guide.

For more information - about policies, see Managed - policies and inline policies in the IAM User Guide.

- operationId: GET_AttachGroupPolicy - parameters: - - description: '

The name (friendly name, not ARN) of the group to attach - the policy to.

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: GroupName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description:

The Amazon Resource Name (ARN) of the IAM policy you want - to attach.

For more information about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.

- in: query - name: PolicyArn - required: true - schema: - description:

The Amazon Resource Name (ARN). ARNs are unique identifiers - for Amazon Web Services resources.

For more information about ARNs, - go to Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference. -

- maxLength: 2048 - minLength: 20 - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/PolicyNotAttachableException' - description: PolicyNotAttachableException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: AttachGroupPolicy - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Attaches the specified managed policy to the specified IAM group.

-

You use this operation to attach a managed policy to a group. To embed - an inline policy in a group, use PutGroupPolicy.

As a best practice, - you can validate your IAM policies. To learn more, see Validating - IAM policies in the IAM User Guide.

For more information - about policies, see Managed - policies and inline policies in the IAM User Guide.

- operationId: POST_AttachGroupPolicy - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/AttachGroupPolicyRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/PolicyNotAttachableException' - description: PolicyNotAttachableException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: AttachGroupPolicy - /?Action=AttachRolePolicy&Version=2010-05-08: - get: - description:

Attaches the specified managed policy to the specified IAM role. - When you attach a managed policy to a role, the managed policy becomes part - of the role's permission (access) policy.

You cannot use a managed - policy as the role's trust policy. The role's trust policy is created at the - same time as the role, using CreateRole. You can update a role's trust - policy using UpdateAssumeRolePolicy.

Use this operation - to attach a managed policy to a role. To embed an inline policy in - a role, use PutRolePolicy. For more information about policies, see - Managed - policies and inline policies in the IAM User Guide.

As a - best practice, you can validate your IAM policies. To learn more, see Validating - IAM policies in the IAM User Guide.

- operationId: GET_AttachRolePolicy - parameters: - - description: '

The name (friendly name, not ARN) of the role to attach the - policy to.

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: RoleName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description:

The Amazon Resource Name (ARN) of the IAM policy you want - to attach.

For more information about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.

- in: query - name: PolicyArn - required: true - schema: - description:

The Amazon Resource Name (ARN). ARNs are unique identifiers - for Amazon Web Services resources.

For more information about ARNs, - go to Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference. -

- maxLength: 2048 - minLength: 20 - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/UnmodifiableEntityException' - description: UnmodifiableEntityException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/PolicyNotAttachableException' - description: PolicyNotAttachableException - '485': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: AttachRolePolicy - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Attaches the specified managed policy to the specified IAM role. - When you attach a managed policy to a role, the managed policy becomes part - of the role's permission (access) policy.

You cannot use a managed - policy as the role's trust policy. The role's trust policy is created at the - same time as the role, using CreateRole. You can update a role's trust - policy using UpdateAssumeRolePolicy.

Use this operation - to attach a managed policy to a role. To embed an inline policy in - a role, use PutRolePolicy. For more information about policies, see - Managed - policies and inline policies in the IAM User Guide.

As a - best practice, you can validate your IAM policies. To learn more, see Validating - IAM policies in the IAM User Guide.

- operationId: POST_AttachRolePolicy - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/AttachRolePolicyRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/UnmodifiableEntityException' - description: UnmodifiableEntityException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/PolicyNotAttachableException' - description: PolicyNotAttachableException - '485': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: AttachRolePolicy - /?Action=AttachUserPolicy&Version=2010-05-08: - get: - description:

Attaches the specified managed policy to the specified user.

-

You use this operation to attach a managed policy to a user. To - embed an inline policy in a user, use PutUserPolicy.

As a best - practice, you can validate your IAM policies. To learn more, see Validating - IAM policies in the IAM User Guide.

For more information - about policies, see Managed - policies and inline policies in the IAM User Guide.

- operationId: GET_AttachUserPolicy - parameters: - - description: '

The name (friendly name, not ARN) of the IAM user to attach - the policy to.

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: UserName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description:

The Amazon Resource Name (ARN) of the IAM policy you want - to attach.

For more information about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.

- in: query - name: PolicyArn - required: true - schema: - description:

The Amazon Resource Name (ARN). ARNs are unique identifiers - for Amazon Web Services resources.

For more information about ARNs, - go to Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference. -

- maxLength: 2048 - minLength: 20 - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/PolicyNotAttachableException' - description: PolicyNotAttachableException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: AttachUserPolicy - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Attaches the specified managed policy to the specified user.

-

You use this operation to attach a managed policy to a user. To - embed an inline policy in a user, use PutUserPolicy.

As a best - practice, you can validate your IAM policies. To learn more, see Validating - IAM policies in the IAM User Guide.

For more information - about policies, see Managed - policies and inline policies in the IAM User Guide.

- operationId: POST_AttachUserPolicy - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/AttachUserPolicyRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/PolicyNotAttachableException' - description: PolicyNotAttachableException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: AttachUserPolicy - /?Action=ChangePassword&Version=2010-05-08: - get: - description:

Changes the password of the IAM user who is calling this operation. - This operation can be performed using the CLI, the Amazon Web Services API, - or the My Security Credentials page in the Amazon Web Services Management - Console. The Amazon Web Services account root user password is not affected - by this operation.

Use UpdateLoginProfile to use the CLI, the - Amazon Web Services API, or the Users page in the IAM console to change - the password for any IAM user. For more information about modifying passwords, - see Managing - passwords in the IAM User Guide.

- operationId: GET_ChangePassword - parameters: - - description: The IAM user's current password. - in: query - name: OldPassword - required: true - schema: - format: password - maxLength: 128 - minLength: 1 - pattern: '[\u0009\u000A\u000D\u0020-\u00FF]+' - type: string - - description:

The new password. The new password must conform to the Amazon - Web Services account's password policy, if one exists.

The regex - pattern that is used to validate this parameter is a string of characters. - That string can include almost any printable ASCII character from the space - (\u0020) through the end of the ASCII character range (\u00FF). - You can also include the tab (\u0009), line feed (\u000A), - and carriage return (\u000D) characters. Any of these characters - are valid in a password. However, many tools, such as the Amazon Web Services - Management Console, might restrict the ability to type certain characters - because they have special meaning within that tool.

- in: query - name: NewPassword - required: true - schema: - format: password - maxLength: 128 - minLength: 1 - pattern: '[\u0009\u000A\u000D\u0020-\u00FF]+' - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidUserTypeException' - description: InvalidUserTypeException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityTemporarilyUnmodifiableException' - description: EntityTemporarilyUnmodifiableException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/PasswordPolicyViolationException' - description: PasswordPolicyViolationException - '485': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: ChangePassword - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Changes the password of the IAM user who is calling this operation. - This operation can be performed using the CLI, the Amazon Web Services API, - or the My Security Credentials page in the Amazon Web Services Management - Console. The Amazon Web Services account root user password is not affected - by this operation.

Use UpdateLoginProfile to use the CLI, the - Amazon Web Services API, or the Users page in the IAM console to change - the password for any IAM user. For more information about modifying passwords, - see Managing - passwords in the IAM User Guide.

- operationId: POST_ChangePassword - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ChangePasswordRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidUserTypeException' - description: InvalidUserTypeException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityTemporarilyUnmodifiableException' - description: EntityTemporarilyUnmodifiableException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/PasswordPolicyViolationException' - description: PasswordPolicyViolationException - '485': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: ChangePassword - /?Action=CreateAccessKey&Version=2010-05-08: - get: - description:

Creates a new Amazon Web Services secret access key and corresponding - Amazon Web Services access key ID for the specified user. The default status - for new keys is Active.

If you do not specify a user name, - IAM determines the user name implicitly based on the Amazon Web Services access - key ID signing the request. This operation works for access keys under the - Amazon Web Services account. Consequently, you can use this operation to manage - Amazon Web Services account root user credentials. This is true even if the - Amazon Web Services account has no associated users.

For information - about quotas on the number of keys you can create, see IAM - and STS quotas in the IAM User Guide.

To ensure - the security of your Amazon Web Services account, the secret access key is - accessible only during key and user creation. You must save the key (for example, - in a text file) if you want to be able to access it again. If a secret key - is lost, you can delete the access keys for the associated user and then create - new keys.

 - operationId: GET_CreateAccessKey - parameters: - - description: '

The name of the IAM user that the new key will belong to.

-

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: UserName - required: false - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - responses: - '200': - content: - text/xml: - schema: - properties: - CreateAccessKeyResult: - $ref: '#/components/schemas/CreateAccessKeyResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: CreateAccessKey - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Creates a new Amazon Web Services secret access key and corresponding - Amazon Web Services access key ID for the specified user. The default status - for new keys is Active.

If you do not specify a user name, - IAM determines the user name implicitly based on the Amazon Web Services access - key ID signing the request. This operation works for access keys under the - Amazon Web Services account. Consequently, you can use this operation to manage - Amazon Web Services account root user credentials. This is true even if the - Amazon Web Services account has no associated users.

For information - about quotas on the number of keys you can create, see IAM - and STS quotas in the IAM User Guide.

To ensure - the security of your Amazon Web Services account, the secret access key is - accessible only during key and user creation. You must save the key (for example, - in a text file) if you want to be able to access it again. If a secret key - is lost, you can delete the access keys for the associated user and then create - new keys.

 - operationId: POST_CreateAccessKey - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateAccessKeyRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - CreateAccessKeyResult: - $ref: '#/components/schemas/CreateAccessKeyResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: CreateAccessKey - /?Action=CreateAccountAlias&Version=2010-05-08: - get: - description: Creates an alias for your Amazon Web Services account. For information - about using an Amazon Web Services account alias, see Using - an alias for your Amazon Web Services account ID in the IAM User Guide. - operationId: GET_CreateAccountAlias - parameters: - - description:

The account alias to create.

This parameter allows - (through its regex pattern) - a string of characters consisting of lowercase letters, digits, and dashes. - You cannot start or finish with a dash, nor can you have two dashes in a - row.

- in: query - name: AccountAlias - required: true - schema: - maxLength: 63 - minLength: 3 - pattern: ^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$ - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityAlreadyExistsException' - description: EntityAlreadyExistsException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: CreateAccountAlias - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description: Creates an alias for your Amazon Web Services account. For information - about using an Amazon Web Services account alias, see Using - an alias for your Amazon Web Services account ID in the IAM User Guide. - operationId: POST_CreateAccountAlias - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateAccountAliasRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityAlreadyExistsException' - description: EntityAlreadyExistsException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: CreateAccountAlias - /?Action=CreateGroup&Version=2010-05-08: - get: - description:

Creates a new group.

For information about the number - of groups you can create, see IAM - and STS quotas in the IAM User Guide.

- operationId: GET_CreateGroup - parameters: - - description:

The path to the group. For more information about paths, - see IAM - identifiers in the IAM User Guide.

This parameter is optional. - If it is not included, it defaults to a slash (/).

This parameter - allows (through its regex pattern) - a string of characters consisting of either a forward slash (/) by itself - or a string that must begin and end with forward slashes. In addition, it - can contain any ASCII character from the ! (\u0021) through - the DEL character (\u007F), including most punctuation characters, - digits, and upper and lowercased letters.

- in: query - name: Path - required: false - schema: - maxLength: 512 - minLength: 1 - pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F) - type: string - - description:

The name of the group to create. Do not include the path in - this value.

IAM user, group, role, and policy names must be unique - within the account. Names are not distinguished by case. For example, you - cannot create resources named both "MyResource" and "myresource".

- in: query - name: GroupName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - responses: - '200': - content: - text/xml: - schema: - properties: - CreateGroupResult: - $ref: '#/components/schemas/CreateGroupResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityAlreadyExistsException' - description: EntityAlreadyExistsException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: CreateGroup - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Creates a new group.

For information about the number - of groups you can create, see IAM - and STS quotas in the IAM User Guide.

- operationId: POST_CreateGroup - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateGroupRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - CreateGroupResult: - $ref: '#/components/schemas/CreateGroupResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityAlreadyExistsException' - description: EntityAlreadyExistsException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: CreateGroup - /?Action=CreateInstanceProfile&Version=2010-05-08: - get: - description:

Creates a new instance profile. For information about instance - profiles, see Using - roles for applications on Amazon EC2 in the IAM User Guide, and - Instance - profiles in the Amazon EC2 User Guide.

For information - about the number of instance profiles you can create, see IAM - object quotas in the IAM User Guide.

- operationId: GET_CreateInstanceProfile - parameters: - - description: '

The name of the instance profile to create.

This parameter - allows (through its regex pattern) - a string of characters consisting of upper and lowercase alphanumeric characters - with no spaces. You can also include any of the following characters: _+=,.@-

' - in: query - name: InstanceProfileName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description:

The path to the instance profile. For more information about - paths, see IAM - Identifiers in the IAM User Guide.

This parameter is optional. - If it is not included, it defaults to a slash (/).

This parameter - allows (through its regex pattern) - a string of characters consisting of either a forward slash (/) by itself - or a string that must begin and end with forward slashes. In addition, it - can contain any ASCII character from the ! (\u0021) through - the DEL character (\u007F), including most punctuation characters, - digits, and upper and lowercased letters.

- in: query - name: Path - required: false - schema: - maxLength: 512 - minLength: 1 - pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F) - type: string - - description:

A list of tags that you want to attach to the newly created - IAM instance profile. Each tag consists of a key name and an associated - value. For more information about tagging, see Tagging - IAM resources in the IAM User Guide.

If any one - of the tags is invalid or if you exceed the allowed maximum number of tags, - then the entire request fails and the resource is not created.

 - in: query - name: Tags - required: false - schema: - items: - allOf: - - $ref: '#/components/schemas/Tag' - - xml: - name: member - maxItems: 50 - type: array - responses: - '200': - content: - text/xml: - schema: - properties: - CreateInstanceProfileResult: - $ref: '#/components/schemas/CreateInstanceProfileResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityAlreadyExistsException' - description: EntityAlreadyExistsException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: CreateInstanceProfile - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Creates a new instance profile. For information about instance - profiles, see Using - roles for applications on Amazon EC2 in the IAM User Guide, and - Instance - profiles in the Amazon EC2 User Guide.

For information - about the number of instance profiles you can create, see IAM - object quotas in the IAM User Guide.

- operationId: POST_CreateInstanceProfile - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateInstanceProfileRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - CreateInstanceProfileResult: - $ref: '#/components/schemas/CreateInstanceProfileResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityAlreadyExistsException' - description: EntityAlreadyExistsException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: CreateInstanceProfile - /?Action=CreateLoginProfile&Version=2010-05-08: - get: - description:

Creates a password for the specified IAM user. A password allows - an IAM user to access Amazon Web Services services through the Amazon Web - Services Management Console.

You can use the CLI, the Amazon Web Services - API, or the Users page in the IAM console to create a password for - any IAM user. Use ChangePassword to update your own existing password - in the My Security Credentials page in the Amazon Web Services Management - Console.

For more information about managing passwords, see Managing - passwords in the IAM User Guide.

- operationId: GET_CreateLoginProfile - parameters: - - description: '

The name of the IAM user to create a password for. The user - must already exist.

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: UserName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description:

The new password for the user.

The regex - pattern that is used to validate this parameter is a string of characters. - That string can include almost any printable ASCII character from the space - (\u0020) through the end of the ASCII character range (\u00FF). - You can also include the tab (\u0009), line feed (\u000A), - and carriage return (\u000D) characters. Any of these characters - are valid in a password. However, many tools, such as the Amazon Web Services - Management Console, might restrict the ability to type certain characters - because they have special meaning within that tool.

- in: query - name: Password - required: true - schema: - format: password - maxLength: 128 - minLength: 1 - pattern: '[\u0009\u000A\u000D\u0020-\u00FF]+' - type: string - - description: Specifies whether the user is required to set a new password - on next sign-in. - in: query - name: PasswordResetRequired - required: false - schema: - type: boolean - responses: - '200': - content: - text/xml: - schema: - properties: - CreateLoginProfileResult: - $ref: '#/components/schemas/CreateLoginProfileResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityAlreadyExistsException' - description: EntityAlreadyExistsException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/PasswordPolicyViolationException' - description: PasswordPolicyViolationException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: CreateLoginProfile - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Creates a password for the specified IAM user. A password allows - an IAM user to access Amazon Web Services services through the Amazon Web - Services Management Console.

You can use the CLI, the Amazon Web Services - API, or the Users page in the IAM console to create a password for - any IAM user. Use ChangePassword to update your own existing password - in the My Security Credentials page in the Amazon Web Services Management - Console.

For more information about managing passwords, see Managing - passwords in the IAM User Guide.

- operationId: POST_CreateLoginProfile - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateLoginProfileRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - CreateLoginProfileResult: - $ref: '#/components/schemas/CreateLoginProfileResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityAlreadyExistsException' - description: EntityAlreadyExistsException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/PasswordPolicyViolationException' - description: PasswordPolicyViolationException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: CreateLoginProfile - /?Action=CreateOpenIDConnectProvider&Version=2010-05-08: - get: - description:

Creates an IAM entity to describe an identity provider (IdP) - that supports OpenID Connect (OIDC).

-

The OIDC provider that you create with this operation can be used as a - principal in a role's trust policy. Such a policy establishes a trust relationship - between Amazon Web Services and the OIDC provider.

If you are using - an OIDC identity provider from Google, Facebook, or Amazon Cognito, you don't - need to create a separate IAM identity provider. These OIDC identity providers - are already built-in to Amazon Web Services and are available for your use. - Instead, you can move directly to creating new roles using your identity provider. - To learn more, see Creating - a role for web identity or OpenID connect federation in the IAM User - Guide.

When you create the IAM OIDC provider, you specify the following:

-

  • The URL of the OIDC identity provider (IdP) to trust

    • -

  • A list of client IDs (also known as audiences) that identify the application - or applications allowed to authenticate using the OIDC provider

    • -

  • A list of thumbprints of one or more server certificates that the - IdP uses

You get all of this information from the OIDC - IdP you want to use to access Amazon Web Services.

Amazon Web - Services secures communication with some OIDC identity providers (IdPs) through - our library of trusted certificate authorities (CAs) instead of using a certificate - thumbprint to verify your IdP server certificate. These OIDC IdPs include - Google, and those that use an Amazon S3 bucket to host a JSON Web Key Set - (JWKS) endpoint. In these cases, your legacy thumbprint remains in your configuration, - but is no longer used for validation.

The trust for - the OIDC provider is derived from the IAM provider that this operation creates. - Therefore, it is best to limit access to the CreateOpenIDConnectProvider - operation to highly privileged users.

 - operationId: GET_CreateOpenIDConnectProvider - parameters: - - description:

The URL of the identity provider. The URL must begin with - https:// and should correspond to the iss claim - in the provider's OpenID Connect ID tokens. Per the OIDC standard, path - components are allowed but query parameters are not. Typically the URL consists - of only a hostname, like https://server.example.org or https://example.com. - The URL should not contain a port number.

You cannot register the - same provider multiple times in a single Amazon Web Services account. If - you try to submit a URL that has already been used for an OpenID Connect - provider in the Amazon Web Services account, you will get an error.

- in: query - name: Url - required: true - schema: - description: Contains a URL that specifies the endpoint for an OpenID Connect - provider. - maxLength: 255 - minLength: 1 - type: string - - description:

Provides a list of client IDs, also known as audiences. When - a mobile or web app registers with an OpenID Connect provider, they establish - a value that identifies the application. This is the value that's sent as - the client_id parameter on OAuth requests.

You can register - multiple client IDs with the same provider. For example, you might have - multiple applications that use the same OIDC provider. You cannot register - more than 100 client IDs with a single IAM OIDC provider.

There is - no defined format for a client ID. The CreateOpenIDConnectProviderRequest - operation accepts client IDs up to 255 characters long.

- in: query - name: ClientIDList - required: false - schema: - items: - allOf: - - $ref: '#/components/schemas/clientIDType' - - xml: - name: member - type: array - - description:

A list of server certificate thumbprints for the OpenID Connect - (OIDC) identity provider's server certificates. Typically this list includes - only one entry. However, IAM lets you have up to five thumbprints for an - OIDC provider. This lets you maintain multiple thumbprints if the identity - provider is rotating certificates.

The server certificate thumbprint - is the hex-encoded SHA-1 hash value of the X.509 certificate used by the - domain where the OpenID Connect provider makes its keys available. It is - always a 40-character string.

You must provide at least one thumbprint - when creating an IAM OIDC provider. For example, assume that the OIDC provider - is server.example.com and the provider stores its keys at https://keys.server.example.com/openid-connect. - In that case, the thumbprint string would be the hex-encoded SHA-1 hash - value of the certificate used by https://keys.server.example.com. -

For more information about obtaining the OIDC provider thumbprint, - see Obtaining - the thumbprint for an OpenID Connect provider in the IAM User Guide.

- in: query - name: ThumbprintList - required: true - schema: - description: Contains a list of thumbprints of identity provider server - certificates. - items: - allOf: - - $ref: '#/components/schemas/thumbprintType' - - xml: - name: member - type: array - - description:

A list of tags that you want to attach to the new IAM OpenID - Connect (OIDC) provider. Each tag consists of a key name and an associated - value. For more information about tagging, see Tagging - IAM resources in the IAM User Guide.

If any one - of the tags is invalid or if you exceed the allowed maximum number of tags, - then the entire request fails and the resource is not created.

 - in: query - name: Tags - required: false - schema: - items: - allOf: - - $ref: '#/components/schemas/Tag' - - xml: - name: member - maxItems: 50 - type: array - responses: - '200': - content: - text/xml: - schema: - properties: - CreateOpenIDConnectProviderResult: - $ref: '#/components/schemas/CreateOpenIDConnectProviderResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityAlreadyExistsException' - description: EntityAlreadyExistsException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: CreateOpenIDConnectProvider - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Creates an IAM entity to describe an identity provider (IdP) - that supports OpenID Connect (OIDC).

-

The OIDC provider that you create with this operation can be used as a - principal in a role's trust policy. Such a policy establishes a trust relationship - between Amazon Web Services and the OIDC provider.

If you are using - an OIDC identity provider from Google, Facebook, or Amazon Cognito, you don't - need to create a separate IAM identity provider. These OIDC identity providers - are already built-in to Amazon Web Services and are available for your use. - Instead, you can move directly to creating new roles using your identity provider. - To learn more, see Creating - a role for web identity or OpenID connect federation in the IAM User - Guide.

When you create the IAM OIDC provider, you specify the following:

-

  • The URL of the OIDC identity provider (IdP) to trust

    • -

  • A list of client IDs (also known as audiences) that identify the application - or applications allowed to authenticate using the OIDC provider

    • -

  • A list of thumbprints of one or more server certificates that the - IdP uses

You get all of this information from the OIDC - IdP you want to use to access Amazon Web Services.

Amazon Web - Services secures communication with some OIDC identity providers (IdPs) through - our library of trusted certificate authorities (CAs) instead of using a certificate - thumbprint to verify your IdP server certificate. These OIDC IdPs include - Google, and those that use an Amazon S3 bucket to host a JSON Web Key Set - (JWKS) endpoint. In these cases, your legacy thumbprint remains in your configuration, - but is no longer used for validation.

The trust for - the OIDC provider is derived from the IAM provider that this operation creates. - Therefore, it is best to limit access to the CreateOpenIDConnectProvider - operation to highly privileged users.

 - operationId: POST_CreateOpenIDConnectProvider - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateOpenIDConnectProviderRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - CreateOpenIDConnectProviderResult: - $ref: '#/components/schemas/CreateOpenIDConnectProviderResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityAlreadyExistsException' - description: EntityAlreadyExistsException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: CreateOpenIDConnectProvider - /?Action=CreatePolicy&Version=2010-05-08: - get: - description:

Creates a new managed policy for your Amazon Web Services account.

-

This operation creates a policy version with a version identifier of v1 - and sets v1 as the policy's default version. For more information about policy - versions, see Versioning - for managed policies in the IAM User Guide.

As a best practice, - you can validate your IAM policies. To learn more, see Validating - IAM policies in the IAM User Guide.

For more information - about managed policies in general, see Managed - policies and inline policies in the IAM User Guide.

- operationId: GET_CreatePolicy - parameters: - - description:

The friendly name of the policy.

IAM user, group, role, - and policy names must be unique within the account. Names are not distinguished - by case. For example, you cannot create resources named both "MyResource" - and "myresource".

- in: query - name: PolicyName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description:

The path for the policy.

For more information about - paths, see IAM - identifiers in the IAM User Guide.

This parameter is optional. - If it is not included, it defaults to a slash (/).

This parameter - allows (through its regex pattern) - a string of characters consisting of either a forward slash (/) by itself - or a string that must begin and end with forward slashes. In addition, it - can contain any ASCII character from the ! (\u0021) through - the DEL character (\u007F), including most punctuation characters, - digits, and upper and lowercased letters.

You cannot use an - asterisk (*) in the path name.

 - in: query - name: Path - required: false - schema: - maxLength: 512 - minLength: 1 - pattern: ((/[A-Za-z0-9\.,\+@=_-]+)*)/ - type: string - - description:

The JSON policy document that you want to use as the content - for the new policy.

You must provide policies in JSON format in IAM. - However, for CloudFormation templates formatted in YAML, you can provide - the policy in JSON or YAML format. CloudFormation always converts a YAML - policy to JSON format before submitting it to IAM.

The maximum length - of the policy document that you can pass in this operation, including whitespace, - is listed below. To view the maximum character counts of a managed policy - with no whitespaces, see IAM - and STS character quotas.

To learn more about JSON policy grammar, - see Grammar - of the IAM JSON policy language in the IAM User Guide.

The - regex pattern used to validate - this parameter is a string of characters consisting of the following:

-

  • Any printable ASCII character ranging from the space character - (\u0020) through the end of the ASCII character range

    • -

  • The printable characters in the Basic Latin and Latin-1 Supplement - character set (through \u00FF)

  • The special - characters tab (\u0009), line feed (\u000A), and - carriage return (\u000D)

- in: query - name: PolicyDocument - required: true - schema: - maxLength: 131072 - minLength: 1 - pattern: '[\u0009\u000A\u000D\u0020-\u00FF]+' - type: string - - description:

A friendly description of the policy.

Typically used - to store information about the permissions defined in the policy. For example, - "Grants access to production DynamoDB tables."

The policy description - is immutable. After a value is assigned, it cannot be changed.

- in: query - name: Description - required: false - schema: - maxLength: 1000 - type: string - - description:

A list of tags that you want to attach to the new IAM customer - managed policy. Each tag consists of a key name and an associated value. - For more information about tagging, see Tagging - IAM resources in the IAM User Guide.

If any one - of the tags is invalid or if you exceed the allowed maximum number of tags, - then the entire request fails and the resource is not created.

 - in: query - name: Tags - required: false - schema: - items: - allOf: - - $ref: '#/components/schemas/Tag' - - xml: - name: member - maxItems: 50 - type: array - responses: - '200': - content: - text/xml: - schema: - properties: - CreatePolicyResult: - $ref: '#/components/schemas/CreatePolicyResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityAlreadyExistsException' - description: EntityAlreadyExistsException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/MalformedPolicyDocumentException' - description: MalformedPolicyDocumentException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '485': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: CreatePolicy - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Creates a new managed policy for your Amazon Web Services account.

-

This operation creates a policy version with a version identifier of v1 - and sets v1 as the policy's default version. For more information about policy - versions, see Versioning - for managed policies in the IAM User Guide.

As a best practice, - you can validate your IAM policies. To learn more, see Validating - IAM policies in the IAM User Guide.

For more information - about managed policies in general, see Managed - policies and inline policies in the IAM User Guide.

- operationId: POST_CreatePolicy - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreatePolicyRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - CreatePolicyResult: - $ref: '#/components/schemas/CreatePolicyResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityAlreadyExistsException' - description: EntityAlreadyExistsException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/MalformedPolicyDocumentException' - description: MalformedPolicyDocumentException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '485': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: CreatePolicy - /?Action=CreatePolicyVersion&Version=2010-05-08: - get: - description:

Creates a new version of the specified managed policy. To update - a managed policy, you create a new policy version. A managed policy can have - up to five versions. If the policy has five versions, you must delete an existing - version using DeletePolicyVersion before you create a new version.

-

Optionally, you can set the new version as the policy's default version. - The default version is the version that is in effect for the IAM users, groups, - and roles to which the policy is attached.

For more information about - managed policy versions, see Versioning - for managed policies in the IAM User Guide.

- operationId: GET_CreatePolicyVersion - parameters: - - description:

The Amazon Resource Name (ARN) of the IAM policy to which - you want to add a new version.

For more information about ARNs, see - Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.

- in: query - name: PolicyArn - required: true - schema: - description:

The Amazon Resource Name (ARN). ARNs are unique identifiers - for Amazon Web Services resources.

For more information about ARNs, - go to Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference. -

- maxLength: 2048 - minLength: 20 - type: string - - description:

The JSON policy document that you want to use as the content - for this new version of the policy.

You must provide policies in - JSON format in IAM. However, for CloudFormation templates formatted in YAML, - you can provide the policy in JSON or YAML format. CloudFormation always - converts a YAML policy to JSON format before submitting it to IAM.

The - maximum length of the policy document that you can pass in this operation, - including whitespace, is listed below. To view the maximum character counts - of a managed policy with no whitespaces, see IAM - and STS character quotas.

The regex - pattern used to validate this parameter is a string of characters consisting - of the following:

  • Any printable ASCII character ranging - from the space character (\u0020) through the end of the ASCII - character range

  • The printable characters in the Basic - Latin and Latin-1 Supplement character set (through \u00FF)

    -

  • The special characters tab (\u0009), line feed - (\u000A), and carriage return (\u000D)

    • -
- in: query - name: PolicyDocument - required: true - schema: - maxLength: 131072 - minLength: 1 - pattern: '[\u0009\u000A\u000D\u0020-\u00FF]+' - type: string - - description:

Specifies whether to set this version as the policy's default - version.

When this parameter is true, the new policy - version becomes the operative version. That is, it becomes the version that - is in effect for the IAM users, groups, and roles that the policy is attached - to.

For more information about managed policy versions, see Versioning - for managed policies in the IAM User Guide.

- in: query - name: SetAsDefault - required: false - schema: - type: boolean - responses: - '200': - content: - text/xml: - schema: - properties: - CreatePolicyVersionResult: - $ref: '#/components/schemas/CreatePolicyVersionResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/MalformedPolicyDocumentException' - description: MalformedPolicyDocumentException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: CreatePolicyVersion - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Creates a new version of the specified managed policy. To update - a managed policy, you create a new policy version. A managed policy can have - up to five versions. If the policy has five versions, you must delete an existing - version using DeletePolicyVersion before you create a new version.

-

Optionally, you can set the new version as the policy's default version. - The default version is the version that is in effect for the IAM users, groups, - and roles to which the policy is attached.

For more information about - managed policy versions, see Versioning - for managed policies in the IAM User Guide.

- operationId: POST_CreatePolicyVersion - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreatePolicyVersionRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - CreatePolicyVersionResult: - $ref: '#/components/schemas/CreatePolicyVersionResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/MalformedPolicyDocumentException' - description: MalformedPolicyDocumentException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: CreatePolicyVersion - /?Action=CreateRole&Version=2010-05-08: - get: - description: Creates a new role for your Amazon Web Services account. For more - information about roles, see IAM - roles. For information about quotas for role names and the number of roles - you can create, see IAM - and STS quotas in the IAM User Guide. - operationId: GET_CreateRole - parameters: - - description:

The path to the role. For more information about paths, see - IAM - Identifiers in the IAM User Guide.

This parameter is optional. - If it is not included, it defaults to a slash (/).

This parameter - allows (through its regex pattern) - a string of characters consisting of either a forward slash (/) by itself - or a string that must begin and end with forward slashes. In addition, it - can contain any ASCII character from the ! (\u0021) through - the DEL character (\u007F), including most punctuation characters, - digits, and upper and lowercased letters.

- in: query - name: Path - required: false - schema: - maxLength: 512 - minLength: 1 - pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F) - type: string - - description:

The name of the role to create.

IAM user, group, role, - and policy names must be unique within the account. Names are not distinguished - by case. For example, you cannot create resources named both "MyResource" - and "myresource".

- in: query - name: RoleName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description:

The trust relationship policy document that grants an entity - permission to assume the role.

In IAM, you must provide a JSON policy - that has been converted to a string. However, for CloudFormation templates - formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation - always converts a YAML policy to JSON format before submitting it to IAM.

-

The regex pattern used - to validate this parameter is a string of characters consisting of the following:

-

  • Any printable ASCII character ranging from the space character - (\u0020) through the end of the ASCII character range

    • -

  • The printable characters in the Basic Latin and Latin-1 Supplement - character set (through \u00FF)

  • The special - characters tab (\u0009), line feed (\u000A), and - carriage return (\u000D)

Upon success, - the response includes the same trust policy in JSON format.

- in: query - name: AssumeRolePolicyDocument - required: true - schema: - maxLength: 131072 - minLength: 1 - pattern: '[\u0009\u000A\u000D\u0020-\u00FF]+' - type: string - - description: A description of the role. - in: query - name: Description - required: false - schema: - maxLength: 1000 - pattern: '[\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}]*' - type: string - - description:

The maximum session duration (in seconds) that you want to - set for the specified role. If you do not specify a value for this setting, - the default maximum of one hour is applied. This setting can have a value - from 1 hour to 12 hours.

Anyone who assumes the role from the or - API can use the DurationSeconds API parameter or the duration-seconds - CLI parameter to request a longer session. The MaxSessionDuration - setting determines the maximum duration that can be requested using the - DurationSeconds parameter. If users don't specify a value for - the DurationSeconds parameter, their security credentials are - valid for one hour by default. This applies when you use the AssumeRole* - API operations or the assume-role* CLI operations but does - not apply when you use those operations to create a console URL. For more - information, see Using - IAM roles in the IAM User Guide.

- in: query - name: MaxSessionDuration - required: false - schema: - maximum: 43200 - minimum: 3600 - type: integer - - description: The ARN of the policy that is used to set the permissions boundary - for the role. - in: query - name: PermissionsBoundary - required: false - schema: - description:

The Amazon Resource Name (ARN). ARNs are unique identifiers - for Amazon Web Services resources.

For more information about ARNs, - go to Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference. -

- maxLength: 2048 - minLength: 20 - type: string - - description:

A list of tags that you want to attach to the new role. Each - tag consists of a key name and an associated value. For more information - about tagging, see Tagging - IAM resources in the IAM User Guide.

If any one - of the tags is invalid or if you exceed the allowed maximum number of tags, - then the entire request fails and the resource is not created.

 - in: query - name: Tags - required: false - schema: - items: - allOf: - - $ref: '#/components/schemas/Tag' - - xml: - name: member - maxItems: 50 - type: array - responses: - '200': - content: - text/xml: - schema: - properties: - CreateRoleResult: - $ref: '#/components/schemas/CreateRoleResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityAlreadyExistsException' - description: EntityAlreadyExistsException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/MalformedPolicyDocumentException' - description: MalformedPolicyDocumentException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '485': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: CreateRole - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description: Creates a new role for your Amazon Web Services account. For more - information about roles, see IAM - roles. For information about quotas for role names and the number of roles - you can create, see IAM - and STS quotas in the IAM User Guide. - operationId: POST_CreateRole - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateRoleRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - CreateRoleResult: - $ref: '#/components/schemas/CreateRoleResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityAlreadyExistsException' - description: EntityAlreadyExistsException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/MalformedPolicyDocumentException' - description: MalformedPolicyDocumentException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '485': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: CreateRole - /?Action=CreateSAMLProvider&Version=2010-05-08: - get: - description:

Creates an IAM resource that describes an identity provider - (IdP) that supports SAML 2.0.

The SAML provider resource that you create - with this operation can be used as a principal in an IAM role's trust policy. - Such a policy can enable federated users who sign in using the SAML IdP to - assume the role. You can create an IAM role that supports Web-based single - sign-on (SSO) to the Amazon Web Services Management Console or one that supports - API access to Amazon Web Services.

When you create the SAML provider - resource, you upload a SAML metadata document that you get from your IdP. - That document includes the issuer's name, expiration information, and keys - that can be used to validate the SAML authentication response (assertions) - that the IdP sends. You must generate the metadata document using the identity - management software that is used as your organization's IdP.

- This operation requires Signature - Version 4.

For more information, see Enabling - SAML 2.0 federated users to access the Amazon Web Services Management Console - and About - SAML 2.0-based federation in the IAM User Guide.

- operationId: GET_CreateSAMLProvider - parameters: - - description:

An XML document generated by an identity provider (IdP) that - supports SAML 2.0. The document includes the issuer's name, expiration information, - and keys that can be used to validate the SAML authentication response (assertions) - that are received from the IdP. You must generate the metadata document - using the identity management software that is used as your organization's - IdP.

For more information, see About - SAML 2.0-based federation in the IAM User Guide

- in: query - name: SAMLMetadataDocument - required: true - schema: - maxLength: 10000000 - minLength: 1000 - type: string - - description: '

The name of the provider to create.

This parameter - allows (through its regex pattern) - a string of characters consisting of upper and lowercase alphanumeric characters - with no spaces. You can also include any of the following characters: _+=,.@-

' - in: query - name: Name - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w._-]+' - type: string - - description:

A list of tags that you want to attach to the new IAM SAML - provider. Each tag consists of a key name and an associated value. For more - information about tagging, see Tagging - IAM resources in the IAM User Guide.

If any one - of the tags is invalid or if you exceed the allowed maximum number of tags, - then the entire request fails and the resource is not created.

 - in: query - name: Tags - required: false - schema: - items: - allOf: - - $ref: '#/components/schemas/Tag' - - xml: - name: member - maxItems: 50 - type: array - responses: - '200': - content: - text/xml: - schema: - properties: - CreateSAMLProviderResult: - $ref: '#/components/schemas/CreateSAMLProviderResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityAlreadyExistsException' - description: EntityAlreadyExistsException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: CreateSAMLProvider - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Creates an IAM resource that describes an identity provider - (IdP) that supports SAML 2.0.

The SAML provider resource that you create - with this operation can be used as a principal in an IAM role's trust policy. - Such a policy can enable federated users who sign in using the SAML IdP to - assume the role. You can create an IAM role that supports Web-based single - sign-on (SSO) to the Amazon Web Services Management Console or one that supports - API access to Amazon Web Services.

When you create the SAML provider - resource, you upload a SAML metadata document that you get from your IdP. - That document includes the issuer's name, expiration information, and keys - that can be used to validate the SAML authentication response (assertions) - that the IdP sends. You must generate the metadata document using the identity - management software that is used as your organization's IdP.

- This operation requires Signature - Version 4.

For more information, see Enabling - SAML 2.0 federated users to access the Amazon Web Services Management Console - and About - SAML 2.0-based federation in the IAM User Guide.

- operationId: POST_CreateSAMLProvider - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateSAMLProviderRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - CreateSAMLProviderResult: - $ref: '#/components/schemas/CreateSAMLProviderResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityAlreadyExistsException' - description: EntityAlreadyExistsException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: CreateSAMLProvider - /?Action=CreateServiceLinkedRole&Version=2010-05-08: - get: - description:

Creates an IAM role that is linked to a specific Amazon Web - Services service. The service controls the attached policies and when the - role can be deleted. This helps ensure that the service is not broken by an - unexpectedly changed or deleted role, which could put your Amazon Web Services - resources into an unknown state. Allowing the service to control the role - helps improve service stability and proper cleanup when a service and its - role are no longer needed. For more information, see Using - service-linked roles in the IAM User Guide.

To attach a - policy to this service-linked role, you must make the request using the Amazon - Web Services service that depends on this role.

- operationId: GET_CreateServiceLinkedRole - parameters: - - description: '

The service principal for the Amazon Web Services service - to which this role is attached. You use a string similar to a URL but without - the http:// in front. For example: elasticbeanstalk.amazonaws.com. -

Service principals are unique and case-sensitive. To find the exact - service principal for your service-linked role, see Amazon - Web Services services that work with IAM in the IAM User Guide. - Look for the services that have Yes in the Service-Linked Role - column. Choose the Yes link to view the service-linked role documentation - for that service.

' - in: query - name: AWSServiceName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: The description of the role. - in: query - name: Description - required: false - schema: - maxLength: 1000 - pattern: '[\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}]*' - type: string - - description:

A string that you provide, which is combined with the - service-provided prefix to form the complete role name. If you make multiple - requests for the same service, then you must supply a different CustomSuffix - for each request. Otherwise the request fails with a duplicate role name - error. For example, you could add -1 or -debug - to the suffix.

Some services do not support the CustomSuffix - parameter. If you provide an optional suffix and the operation fails, try - the operation again without the suffix.

- in: query - name: CustomSuffix - required: false - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - responses: - '200': - content: - text/xml: - schema: - properties: - CreateServiceLinkedRoleResult: - $ref: '#/components/schemas/CreateServiceLinkedRoleResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: CreateServiceLinkedRole - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Creates an IAM role that is linked to a specific Amazon Web - Services service. The service controls the attached policies and when the - role can be deleted. This helps ensure that the service is not broken by an - unexpectedly changed or deleted role, which could put your Amazon Web Services - resources into an unknown state. Allowing the service to control the role - helps improve service stability and proper cleanup when a service and its - role are no longer needed. For more information, see Using - service-linked roles in the IAM User Guide.

To attach a - policy to this service-linked role, you must make the request using the Amazon - Web Services service that depends on this role.

- operationId: POST_CreateServiceLinkedRole - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateServiceLinkedRoleRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - CreateServiceLinkedRoleResult: - $ref: '#/components/schemas/CreateServiceLinkedRoleResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: CreateServiceLinkedRole - /?Action=CreateServiceSpecificCredential&Version=2010-05-08: - get: - description: '

Generates a set of credentials consisting of a user name and - password that can be used to access the service specified in the request. - These credentials are generated by IAM, and can be used only for the specified - service.

You can have a maximum of two sets of service-specific credentials - for each supported service per user.

You can create service-specific - credentials for CodeCommit and Amazon Keyspaces (for Apache Cassandra).

-

You can reset the password to a new service-generated value by calling - ResetServiceSpecificCredential.

For more information about service-specific - credentials, see Using - IAM with CodeCommit: Git credentials, SSH keys, and Amazon Web Services access - keys in the IAM User Guide.

' - operationId: GET_CreateServiceSpecificCredential - parameters: - - description: '

The name of the IAM user that is to be associated with the - credentials. The new service-specific credentials have the same permissions - as the associated user except that they can be used only to access the specified - service.

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: UserName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: The name of the Amazon Web Services service that is to be associated - with the credentials. The service you specify here is the only service that - can be accessed using these credentials. - in: query - name: ServiceName - required: true - schema: - type: string - responses: - '200': - content: - text/xml: - schema: - properties: - CreateServiceSpecificCredentialResult: - $ref: '#/components/schemas/CreateServiceSpecificCredentialResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceNotSupportedException' - description: ServiceNotSupportedException - x-aws-operation-name: CreateServiceSpecificCredential - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description: '

Generates a set of credentials consisting of a user name and - password that can be used to access the service specified in the request. - These credentials are generated by IAM, and can be used only for the specified - service.

You can have a maximum of two sets of service-specific credentials - for each supported service per user.

You can create service-specific - credentials for CodeCommit and Amazon Keyspaces (for Apache Cassandra).

-

You can reset the password to a new service-generated value by calling - ResetServiceSpecificCredential.

For more information about service-specific - credentials, see Using - IAM with CodeCommit: Git credentials, SSH keys, and Amazon Web Services access - keys in the IAM User Guide.

' - operationId: POST_CreateServiceSpecificCredential - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateServiceSpecificCredentialRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - CreateServiceSpecificCredentialResult: - $ref: '#/components/schemas/CreateServiceSpecificCredentialResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceNotSupportedException' - description: ServiceNotSupportedException - x-aws-operation-name: CreateServiceSpecificCredential - /?Action=CreateUser&Version=2010-05-08: - get: - description:

Creates a new IAM user for your Amazon Web Services account.

-

For information about quotas for the number of IAM users you can create, - see IAM - and STS quotas in the IAM User Guide.

- operationId: GET_CreateUser - parameters: - - description:

The path for the user name. For more information about paths, - see IAM - identifiers in the IAM User Guide.

This parameter is optional. - If it is not included, it defaults to a slash (/).

This parameter - allows (through its regex pattern) - a string of characters consisting of either a forward slash (/) by itself - or a string that must begin and end with forward slashes. In addition, it - can contain any ASCII character from the ! (\u0021) through - the DEL character (\u007F), including most punctuation characters, - digits, and upper and lowercased letters.

- in: query - name: Path - required: false - schema: - maxLength: 512 - minLength: 1 - pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F) - type: string - - description:

The name of the user to create.

IAM user, group, role, - and policy names must be unique within the account. Names are not distinguished - by case. For example, you cannot create resources named both "MyResource" - and "myresource".

- in: query - name: UserName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: The ARN of the policy that is used to set the permissions boundary - for the user. - in: query - name: PermissionsBoundary - required: false - schema: - description:

The Amazon Resource Name (ARN). ARNs are unique identifiers - for Amazon Web Services resources.

For more information about ARNs, - go to Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference. -

- maxLength: 2048 - minLength: 20 - type: string - - description:

A list of tags that you want to attach to the new user. Each - tag consists of a key name and an associated value. For more information - about tagging, see Tagging - IAM resources in the IAM User Guide.

If any one - of the tags is invalid or if you exceed the allowed maximum number of tags, - then the entire request fails and the resource is not created.

 - in: query - name: Tags - required: false - schema: - items: - allOf: - - $ref: '#/components/schemas/Tag' - - xml: - name: member - maxItems: 50 - type: array - responses: - '200': - content: - text/xml: - schema: - properties: - CreateUserResult: - $ref: '#/components/schemas/CreateUserResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityAlreadyExistsException' - description: EntityAlreadyExistsException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '485': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: CreateUser - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Creates a new IAM user for your Amazon Web Services account.

-

For information about quotas for the number of IAM users you can create, - see IAM - and STS quotas in the IAM User Guide.

- operationId: POST_CreateUser - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateUserRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - CreateUserResult: - $ref: '#/components/schemas/CreateUserResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityAlreadyExistsException' - description: EntityAlreadyExistsException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '485': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: CreateUser - /?Action=CreateVirtualMFADevice&Version=2010-05-08: - get: - description:

Creates a new virtual MFA device for the Amazon Web Services - account. After creating the virtual MFA, use EnableMFADevice to attach - the MFA device to an IAM user. For more information about creating and working - with virtual MFA devices, see Using - a virtual MFA device in the IAM User Guide.

For information - about the maximum number of MFA devices you can create, see IAM - and STS quotas in the IAM User Guide.

The seed - information contained in the QR code and the Base32 string should be treated - like any other secret access information. In other words, protect the seed - information as you would your Amazon Web Services access keys or your passwords. - After you provision your virtual device, you should ensure that the information - is destroyed following secure procedures.

 - operationId: GET_CreateVirtualMFADevice - parameters: - - description:

The path for the virtual MFA device. For more information - about paths, see IAM - identifiers in the IAM User Guide.

This parameter is optional. - If it is not included, it defaults to a slash (/).

This parameter - allows (through its regex pattern) - a string of characters consisting of either a forward slash (/) by itself - or a string that must begin and end with forward slashes. In addition, it - can contain any ASCII character from the ! (\u0021) through - the DEL character (\u007F), including most punctuation characters, - digits, and upper and lowercased letters.

- in: query - name: Path - required: false - schema: - maxLength: 512 - minLength: 1 - pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F) - type: string - - description: '

The name of the virtual MFA device. Use with path to uniquely - identify a virtual MFA device.

This parameter allows (through its - regex pattern) a string of - characters consisting of upper and lowercase alphanumeric characters with - no spaces. You can also include any of the following characters: _+=,.@-

' - in: query - name: VirtualMFADeviceName - required: true - schema: - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description:

A list of tags that you want to attach to the new IAM virtual - MFA device. Each tag consists of a key name and an associated value. For - more information about tagging, see Tagging - IAM resources in the IAM User Guide.

If any one - of the tags is invalid or if you exceed the allowed maximum number of tags, - then the entire request fails and the resource is not created.

 - in: query - name: Tags - required: false - schema: - items: - allOf: - - $ref: '#/components/schemas/Tag' - - xml: - name: member - maxItems: 50 - type: array - responses: - '200': - content: - text/xml: - schema: - properties: - CreateVirtualMFADeviceResult: - $ref: '#/components/schemas/CreateVirtualMFADeviceResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityAlreadyExistsException' - description: EntityAlreadyExistsException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: CreateVirtualMFADevice - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Creates a new virtual MFA device for the Amazon Web Services - account. After creating the virtual MFA, use EnableMFADevice to attach - the MFA device to an IAM user. For more information about creating and working - with virtual MFA devices, see Using - a virtual MFA device in the IAM User Guide.

For information - about the maximum number of MFA devices you can create, see IAM - and STS quotas in the IAM User Guide.

The seed - information contained in the QR code and the Base32 string should be treated - like any other secret access information. In other words, protect the seed - information as you would your Amazon Web Services access keys or your passwords. - After you provision your virtual device, you should ensure that the information - is destroyed following secure procedures.

 - operationId: POST_CreateVirtualMFADevice - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateVirtualMFADeviceRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - CreateVirtualMFADeviceResult: - $ref: '#/components/schemas/CreateVirtualMFADeviceResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityAlreadyExistsException' - description: EntityAlreadyExistsException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: CreateVirtualMFADevice - /?Action=DeactivateMFADevice&Version=2010-05-08: - get: - description:

Deactivates the specified MFA device and removes it from association - with the user name for which it was originally enabled.

For more information - about creating and working with virtual MFA devices, see Enabling - a virtual multi-factor authentication (MFA) device in the IAM User - Guide.

- operationId: GET_DeactivateMFADevice - parameters: - - description: '

The name of the user whose MFA device you want to deactivate.

-

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: UserName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: '

The serial number that uniquely identifies the MFA device. - For virtual MFA devices, the serial number is the device ARN.

This - parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - =,.@:/-

' - in: query - name: SerialNumber - required: true - schema: - maxLength: 256 - minLength: 9 - pattern: '[\w+=/:,.@-]+' - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityTemporarilyUnmodifiableException' - description: EntityTemporarilyUnmodifiableException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeactivateMFADevice - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Deactivates the specified MFA device and removes it from association - with the user name for which it was originally enabled.

For more information - about creating and working with virtual MFA devices, see Enabling - a virtual multi-factor authentication (MFA) device in the IAM User - Guide.

- operationId: POST_DeactivateMFADevice - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeactivateMFADeviceRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityTemporarilyUnmodifiableException' - description: EntityTemporarilyUnmodifiableException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeactivateMFADevice - /?Action=DeleteAccessKey&Version=2010-05-08: - get: - description:

Deletes the access key pair associated with the specified IAM - user.

If you do not specify a user name, IAM determines the user name - implicitly based on the Amazon Web Services access key ID signing the request. - This operation works for access keys under the Amazon Web Services account. - Consequently, you can use this operation to manage Amazon Web Services account - root user credentials even if the Amazon Web Services account has no associated - users.

- operationId: GET_DeleteAccessKey - parameters: - - description: '

The name of the user whose access key pair you want to delete.

-

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: UserName - required: false - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description:

The access key ID for the access key ID and secret access - key you want to delete.

This parameter allows (through its regex - pattern) a string of characters that can consist of any upper or lowercased - letter or digit.

- in: query - name: AccessKeyId - required: true - schema: - maxLength: 128 - minLength: 16 - pattern: '[\w]+' - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteAccessKey - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Deletes the access key pair associated with the specified IAM - user.

If you do not specify a user name, IAM determines the user name - implicitly based on the Amazon Web Services access key ID signing the request. - This operation works for access keys under the Amazon Web Services account. - Consequently, you can use this operation to manage Amazon Web Services account - root user credentials even if the Amazon Web Services account has no associated - users.

- operationId: POST_DeleteAccessKey - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteAccessKeyRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteAccessKey - /?Action=DeleteAccountAlias&Version=2010-05-08: - get: - description: ' Deletes the specified Amazon Web Services account alias. For - information about using an Amazon Web Services account alias, see Using - an alias for your Amazon Web Services account ID in the IAM User Guide.' - operationId: GET_DeleteAccountAlias - parameters: - - description:

The name of the account alias to delete.

This parameter - allows (through its regex pattern) - a string of characters consisting of lowercase letters, digits, and dashes. - You cannot start or finish with a dash, nor can you have two dashes in a - row.

- in: query - name: AccountAlias - required: true - schema: - maxLength: 63 - minLength: 3 - pattern: ^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$ - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteAccountAlias - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description: ' Deletes the specified Amazon Web Services account alias. For - information about using an Amazon Web Services account alias, see Using - an alias for your Amazon Web Services account ID in the IAM User Guide.' - operationId: POST_DeleteAccountAlias - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteAccountAliasRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteAccountAlias - /?Action=DeleteAccountPasswordPolicy&Version=2010-05-08: - get: - description: Deletes the password policy for the Amazon Web Services account. - There are no parameters. - operationId: GET_DeleteAccountPasswordPolicy - parameters: [] - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteAccountPasswordPolicy - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description: Deletes the password policy for the Amazon Web Services account. - There are no parameters. - operationId: POST_DeleteAccountPasswordPolicy - parameters: [] - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteAccountPasswordPolicy - /?Action=DeleteGroup&Version=2010-05-08: - get: - description: Deletes the specified IAM group. The group must not contain any - users or have any attached policies. - operationId: GET_DeleteGroup - parameters: - - description: '

The name of the IAM group to delete.

This parameter - allows (through its regex pattern) - a string of characters consisting of upper and lowercase alphanumeric characters - with no spaces. You can also include any of the following characters: _+=,.@-

' - in: query - name: GroupName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteConflictException' - description: DeleteConflictException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteGroup - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description: Deletes the specified IAM group. The group must not contain any - users or have any attached policies. - operationId: POST_DeleteGroup - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteGroupRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteConflictException' - description: DeleteConflictException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteGroup - /?Action=DeleteGroupPolicy&Version=2010-05-08: - get: - description:

Deletes the specified inline policy that is embedded in the - specified IAM group.

A group can also have managed policies attached - to it. To detach a managed policy from a group, use DetachGroupPolicy. - For more information about policies, refer to Managed - policies and inline policies in the IAM User Guide.

- operationId: GET_DeleteGroupPolicy - parameters: - - description: '

The name (friendly name, not ARN) identifying the group that - the policy is embedded in.

This parameter allows (through its regex pattern) a string of characters - consisting of upper and lowercase alphanumeric characters with no spaces. - You can also include any of the following characters: _+=,.@-

' - in: query - name: GroupName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: '

The name identifying the policy document to delete.

This - parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: PolicyName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteGroupPolicy - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Deletes the specified inline policy that is embedded in the - specified IAM group.

A group can also have managed policies attached - to it. To detach a managed policy from a group, use DetachGroupPolicy. - For more information about policies, refer to Managed - policies and inline policies in the IAM User Guide.

- operationId: POST_DeleteGroupPolicy - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteGroupPolicyRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteGroupPolicy - /?Action=DeleteInstanceProfile&Version=2010-05-08: - get: - description:

Deletes the specified instance profile. The instance profile - must not have an associated role.

Make sure that you do - not have any Amazon EC2 instances running with the instance profile you are - about to delete. Deleting a role or instance profile that is associated with - a running instance will break any applications running on the instance.

-

For more information about instance profiles, see About - instance profiles.

- operationId: GET_DeleteInstanceProfile - parameters: - - description: '

The name of the instance profile to delete.

This parameter - allows (through its regex pattern) - a string of characters consisting of upper and lowercase alphanumeric characters - with no spaces. You can also include any of the following characters: _+=,.@-

' - in: query - name: InstanceProfileName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteConflictException' - description: DeleteConflictException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteInstanceProfile - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Deletes the specified instance profile. The instance profile - must not have an associated role.

Make sure that you do - not have any Amazon EC2 instances running with the instance profile you are - about to delete. Deleting a role or instance profile that is associated with - a running instance will break any applications running on the instance.

-

For more information about instance profiles, see About - instance profiles.

- operationId: POST_DeleteInstanceProfile - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteInstanceProfileRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteConflictException' - description: DeleteConflictException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteInstanceProfile - /?Action=DeleteLoginProfile&Version=2010-05-08: - get: - description:

Deletes the password for the specified IAM user, which terminates - the user's ability to access Amazon Web Services services through the Amazon - Web Services Management Console.

You can use the CLI, the Amazon Web - Services API, or the Users page in the IAM console to delete a password - for any IAM user. You can use ChangePassword to update, but not delete, - your own password in the My Security Credentials page in the Amazon - Web Services Management Console.

Deleting a user's password - does not prevent a user from accessing Amazon Web Services through the command - line interface or the API. To prevent all user access, you must also either - make any access keys inactive or delete them. For more information about making - keys inactive or deleting them, see UpdateAccessKey and DeleteAccessKey. -

- operationId: GET_DeleteLoginProfile - parameters: - - description: '

The name of the user whose password you want to delete.

-

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: UserName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityTemporarilyUnmodifiableException' - description: EntityTemporarilyUnmodifiableException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteLoginProfile - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Deletes the password for the specified IAM user, which terminates - the user's ability to access Amazon Web Services services through the Amazon - Web Services Management Console.

You can use the CLI, the Amazon Web - Services API, or the Users page in the IAM console to delete a password - for any IAM user. You can use ChangePassword to update, but not delete, - your own password in the My Security Credentials page in the Amazon - Web Services Management Console.

Deleting a user's password - does not prevent a user from accessing Amazon Web Services through the command - line interface or the API. To prevent all user access, you must also either - make any access keys inactive or delete them. For more information about making - keys inactive or deleting them, see UpdateAccessKey and DeleteAccessKey. -

- operationId: POST_DeleteLoginProfile - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteLoginProfileRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityTemporarilyUnmodifiableException' - description: EntityTemporarilyUnmodifiableException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteLoginProfile - /?Action=DeleteOpenIDConnectProvider&Version=2010-05-08: - get: - description:

Deletes an OpenID Connect identity provider (IdP) resource object - in IAM.

Deleting an IAM OIDC provider resource does not update any - roles that reference the provider as a principal in their trust policies. - Any attempt to assume a role that references a deleted provider fails.

-

This operation is idempotent; it does not fail or return an error if you - call the operation for a provider that does not exist.

- operationId: GET_DeleteOpenIDConnectProvider - parameters: - - description: The Amazon Resource Name (ARN) of the IAM OpenID Connect provider - resource object to delete. You can get a list of OpenID Connect provider - resource ARNs by using the ListOpenIDConnectProviders operation. - in: query - name: OpenIDConnectProviderArn - required: true - schema: - description:

The Amazon Resource Name (ARN). ARNs are unique identifiers - for Amazon Web Services resources.

For more information about ARNs, - go to Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference. -

- maxLength: 2048 - minLength: 20 - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteOpenIDConnectProvider - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Deletes an OpenID Connect identity provider (IdP) resource object - in IAM.

Deleting an IAM OIDC provider resource does not update any - roles that reference the provider as a principal in their trust policies. - Any attempt to assume a role that references a deleted provider fails.

-

This operation is idempotent; it does not fail or return an error if you - call the operation for a provider that does not exist.

- operationId: POST_DeleteOpenIDConnectProvider - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteOpenIDConnectProviderRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteOpenIDConnectProvider - /?Action=DeletePolicy&Version=2010-05-08: - get: - description:

Deletes the specified managed policy.

Before you can - delete a managed policy, you must first detach the policy from all users, - groups, and roles that it is attached to. In addition, you must delete all - the policy's versions. The following steps describe the process for deleting - a managed policy:

  • Detach the policy from all users, groups, - and roles that the policy is attached to, using DetachUserPolicy, DetachGroupPolicy, - or DetachRolePolicy. To list all the users, groups, and roles that - a policy is attached to, use ListEntitiesForPolicy.

  • -

    Delete all versions of the policy using DeletePolicyVersion. To - list the policy's versions, use ListPolicyVersions. You cannot use - DeletePolicyVersion to delete the version that is marked as the default - version. You delete the policy's default version in the next step of the process.

    -

  • Delete the policy (this automatically deletes the policy's default - version) using this operation.

For information about managed - policies, see Managed - policies and inline policies in the IAM User Guide.

- operationId: GET_DeletePolicy - parameters: - - description:

The Amazon Resource Name (ARN) of the IAM policy you want - to delete.

For more information about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.

- in: query - name: PolicyArn - required: true - schema: - description:

The Amazon Resource Name (ARN). ARNs are unique identifiers - for Amazon Web Services resources.

For more information about ARNs, - go to Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference. -

- maxLength: 2048 - minLength: 20 - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteConflictException' - description: DeleteConflictException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeletePolicy - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Deletes the specified managed policy.

Before you can - delete a managed policy, you must first detach the policy from all users, - groups, and roles that it is attached to. In addition, you must delete all - the policy's versions. The following steps describe the process for deleting - a managed policy:

  • Detach the policy from all users, groups, - and roles that the policy is attached to, using DetachUserPolicy, DetachGroupPolicy, - or DetachRolePolicy. To list all the users, groups, and roles that - a policy is attached to, use ListEntitiesForPolicy.

  • -

    Delete all versions of the policy using DeletePolicyVersion. To - list the policy's versions, use ListPolicyVersions. You cannot use - DeletePolicyVersion to delete the version that is marked as the default - version. You delete the policy's default version in the next step of the process.

    -

  • Delete the policy (this automatically deletes the policy's default - version) using this operation.

For information about managed - policies, see Managed - policies and inline policies in the IAM User Guide.

- operationId: POST_DeletePolicy - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeletePolicyRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteConflictException' - description: DeleteConflictException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeletePolicy - /?Action=DeletePolicyVersion&Version=2010-05-08: - get: - description:

Deletes the specified version from the specified managed policy.

-

You cannot delete the default version from a policy using this operation. - To delete the default version from a policy, use DeletePolicy. To find - out which version of a policy is marked as the default version, use ListPolicyVersions.

-

For information about versions for managed policies, see Versioning - for managed policies in the IAM User Guide.

- operationId: GET_DeletePolicyVersion - parameters: - - description:

The Amazon Resource Name (ARN) of the IAM policy from which - you want to delete a version.

For more information about ARNs, see - Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.

- in: query - name: PolicyArn - required: true - schema: - description:

The Amazon Resource Name (ARN). ARNs are unique identifiers - for Amazon Web Services resources.

For more information about ARNs, - go to Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference. -

- maxLength: 2048 - minLength: 20 - type: string - - description:

The policy version to delete.

This parameter allows - (through its regex pattern) - a string of characters that consists of the lowercase letter 'v' followed - by one or two digits, and optionally followed by a period '.' and a string - of letters and digits.

For more information about managed policy - versions, see Versioning - for managed policies in the IAM User Guide.

- in: query - name: VersionId - required: true - schema: - pattern: v[1-9][0-9]*(\.[A-Za-z0-9-]*)? - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteConflictException' - description: DeleteConflictException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeletePolicyVersion - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Deletes the specified version from the specified managed policy.

-

You cannot delete the default version from a policy using this operation. - To delete the default version from a policy, use DeletePolicy. To find - out which version of a policy is marked as the default version, use ListPolicyVersions.

-

For information about versions for managed policies, see Versioning - for managed policies in the IAM User Guide.

- operationId: POST_DeletePolicyVersion - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeletePolicyVersionRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteConflictException' - description: DeleteConflictException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeletePolicyVersion - /?Action=DeleteRole&Version=2010-05-08: - get: - description:

Deletes the specified role. The role must not have any policies - attached. For more information about roles, see Working - with roles.

Make sure that you do not have any Amazon - EC2 instances running with the role you are about to delete. Deleting a role - or instance profile that is associated with a running instance will break - any applications running on the instance.

 - operationId: GET_DeleteRole - parameters: - - description: '

The name of the role to delete.

This parameter allows - (through its regex pattern) - a string of characters consisting of upper and lowercase alphanumeric characters - with no spaces. You can also include any of the following characters: _+=,.@-

' - in: query - name: RoleName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteConflictException' - description: DeleteConflictException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/UnmodifiableEntityException' - description: UnmodifiableEntityException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '485': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteRole - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Deletes the specified role. The role must not have any policies - attached. For more information about roles, see Working - with roles.

Make sure that you do not have any Amazon - EC2 instances running with the role you are about to delete. Deleting a role - or instance profile that is associated with a running instance will break - any applications running on the instance.

 - operationId: POST_DeleteRole - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteRoleRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteConflictException' - description: DeleteConflictException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/UnmodifiableEntityException' - description: UnmodifiableEntityException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '485': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteRole - /?Action=DeleteRolePermissionsBoundary&Version=2010-05-08: - get: - description:

Deletes the permissions boundary for the specified IAM role. -

Deleting the permissions boundary for a role might increase - its permissions. For example, it might allow anyone who assumes the role to - perform all the actions granted in its permissions policies.

- operationId: GET_DeleteRolePermissionsBoundary - parameters: - - description: The name (friendly name, not ARN) of the IAM role from which - you want to remove the permissions boundary. - in: query - name: RoleName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/UnmodifiableEntityException' - description: UnmodifiableEntityException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteRolePermissionsBoundary - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Deletes the permissions boundary for the specified IAM role. -

Deleting the permissions boundary for a role might increase - its permissions. For example, it might allow anyone who assumes the role to - perform all the actions granted in its permissions policies.

- operationId: POST_DeleteRolePermissionsBoundary - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteRolePermissionsBoundaryRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/UnmodifiableEntityException' - description: UnmodifiableEntityException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteRolePermissionsBoundary - /?Action=DeleteRolePolicy&Version=2010-05-08: - get: - description:

Deletes the specified inline policy that is embedded in the - specified IAM role.

A role can also have managed policies attached - to it. To detach a managed policy from a role, use DetachRolePolicy. - For more information about policies, refer to Managed - policies and inline policies in the IAM User Guide.

- operationId: GET_DeleteRolePolicy - parameters: - - description: '

The name (friendly name, not ARN) identifying the role that - the policy is embedded in.

This parameter allows (through its regex pattern) a string of characters - consisting of upper and lowercase alphanumeric characters with no spaces. - You can also include any of the following characters: _+=,.@-

' - in: query - name: RoleName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: '

The name of the inline policy to delete from the specified - IAM role.

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: PolicyName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/UnmodifiableEntityException' - description: UnmodifiableEntityException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteRolePolicy - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Deletes the specified inline policy that is embedded in the - specified IAM role.

A role can also have managed policies attached - to it. To detach a managed policy from a role, use DetachRolePolicy. - For more information about policies, refer to Managed - policies and inline policies in the IAM User Guide.

- operationId: POST_DeleteRolePolicy - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteRolePolicyRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/UnmodifiableEntityException' - description: UnmodifiableEntityException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteRolePolicy - /?Action=DeleteSAMLProvider&Version=2010-05-08: - get: - description:

Deletes a SAML provider resource in IAM.

Deleting the - provider resource from IAM does not update any roles that reference the SAML - provider resource's ARN as a principal in their trust policies. Any attempt - to assume a role that references a non-existent provider resource ARN fails.

-

This operation requires Signature - Version 4.

 - operationId: GET_DeleteSAMLProvider - parameters: - - description: The Amazon Resource Name (ARN) of the SAML provider to delete. - in: query - name: SAMLProviderArn - required: true - schema: - description:

The Amazon Resource Name (ARN). ARNs are unique identifiers - for Amazon Web Services resources.

For more information about ARNs, - go to Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference. -

- maxLength: 2048 - minLength: 20 - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteSAMLProvider - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Deletes a SAML provider resource in IAM.

Deleting the - provider resource from IAM does not update any roles that reference the SAML - provider resource's ARN as a principal in their trust policies. Any attempt - to assume a role that references a non-existent provider resource ARN fails.

-

This operation requires Signature - Version 4.

 - operationId: POST_DeleteSAMLProvider - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteSAMLProviderRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteSAMLProvider - /?Action=DeleteSSHPublicKey&Version=2010-05-08: - get: - description:

Deletes the specified SSH public key.

The SSH public - key deleted by this operation is used only for authenticating the associated - IAM user to an CodeCommit repository. For more information about using SSH - keys to authenticate to an CodeCommit repository, see Set - up CodeCommit for SSH connections in the CodeCommit User Guide.

- operationId: GET_DeleteSSHPublicKey - parameters: - - description: '

The name of the IAM user associated with the SSH public key.

-

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: UserName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description:

The unique identifier for the SSH public key.

This - parameter allows (through its regex - pattern) a string of characters that can consist of any upper or lowercased - letter or digit.

- in: query - name: SSHPublicKeyId - required: true - schema: - maxLength: 128 - minLength: 20 - pattern: '[\w]+' - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - x-aws-operation-name: DeleteSSHPublicKey - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Deletes the specified SSH public key.

The SSH public - key deleted by this operation is used only for authenticating the associated - IAM user to an CodeCommit repository. For more information about using SSH - keys to authenticate to an CodeCommit repository, see Set - up CodeCommit for SSH connections in the CodeCommit User Guide.

- operationId: POST_DeleteSSHPublicKey - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteSSHPublicKeyRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - x-aws-operation-name: DeleteSSHPublicKey - /?Action=DeleteServerCertificate&Version=2010-05-08: - get: - description:

Deletes the specified server certificate.

For more information - about working with server certificates, see Working - with server certificates in the IAM User Guide. This topic also - includes a list of Amazon Web Services services that can use the server certificates - that you manage with IAM.

If you are using a server certificate - with Elastic Load Balancing, deleting the certificate could have implications - for your application. If Elastic Load Balancing doesn't detect the deletion - of bound certificates, it may continue to use the certificates. This could - cause Elastic Load Balancing to stop accepting traffic. We recommend that - you remove the reference to the certificate from Elastic Load Balancing before - using this command to delete the certificate. For more information, see DeleteLoadBalancerListeners - in the Elastic Load Balancing API Reference.

 - operationId: GET_DeleteServerCertificate - parameters: - - description: '

The name of the server certificate you want to delete.

-

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: ServerCertificateName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteConflictException' - description: DeleteConflictException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteServerCertificate - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Deletes the specified server certificate.

For more information - about working with server certificates, see Working - with server certificates in the IAM User Guide. This topic also - includes a list of Amazon Web Services services that can use the server certificates - that you manage with IAM.

If you are using a server certificate - with Elastic Load Balancing, deleting the certificate could have implications - for your application. If Elastic Load Balancing doesn't detect the deletion - of bound certificates, it may continue to use the certificates. This could - cause Elastic Load Balancing to stop accepting traffic. We recommend that - you remove the reference to the certificate from Elastic Load Balancing before - using this command to delete the certificate. For more information, see DeleteLoadBalancerListeners - in the Elastic Load Balancing API Reference.

 - operationId: POST_DeleteServerCertificate - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteServerCertificateRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteConflictException' - description: DeleteConflictException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteServerCertificate - /?Action=DeleteServiceLinkedRole&Version=2010-05-08: - get: - description: '

Submits a service-linked role deletion request and returns - a DeletionTaskId, which you can use to check the status of the - deletion. Before you call this operation, confirm that the role has no active - sessions and that any resources used by the role in the linked service are - deleted. If you call this operation more than once for the same service-linked - role and an earlier deletion task is not complete, then the DeletionTaskId - of the earlier request is returned.

If you submit a deletion request - for a service-linked role whose linked service is still accessing a resource, - then the deletion task fails. If it fails, the GetServiceLinkedRoleDeletionStatus - operation returns the reason for the failure, usually including the resources - that must be deleted. To delete the service-linked role, you must first remove - those resources from the linked service and then submit the deletion request - again. Resources are specific to the service that is linked to the role. For - more information about removing resources from a service, see the Amazon - Web Services documentation for your service.

For more information - about service-linked roles, see Roles - terms and concepts: Amazon Web Services service-linked role in the IAM - User Guide.

' - operationId: GET_DeleteServiceLinkedRole - parameters: - - description: The name of the service-linked role to be deleted. - in: query - name: RoleName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - responses: - '200': - content: - text/xml: - schema: - properties: - DeleteServiceLinkedRoleResult: - $ref: '#/components/schemas/DeleteServiceLinkedRoleResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteServiceLinkedRole - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description: '

Submits a service-linked role deletion request and returns - a DeletionTaskId, which you can use to check the status of the - deletion. Before you call this operation, confirm that the role has no active - sessions and that any resources used by the role in the linked service are - deleted. If you call this operation more than once for the same service-linked - role and an earlier deletion task is not complete, then the DeletionTaskId - of the earlier request is returned.

If you submit a deletion request - for a service-linked role whose linked service is still accessing a resource, - then the deletion task fails. If it fails, the GetServiceLinkedRoleDeletionStatus - operation returns the reason for the failure, usually including the resources - that must be deleted. To delete the service-linked role, you must first remove - those resources from the linked service and then submit the deletion request - again. Resources are specific to the service that is linked to the role. For - more information about removing resources from a service, see the Amazon - Web Services documentation for your service.

For more information - about service-linked roles, see Roles - terms and concepts: Amazon Web Services service-linked role in the IAM - User Guide.

' - operationId: POST_DeleteServiceLinkedRole - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteServiceLinkedRoleRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - DeleteServiceLinkedRoleResult: - $ref: '#/components/schemas/DeleteServiceLinkedRoleResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteServiceLinkedRole - /?Action=DeleteServiceSpecificCredential&Version=2010-05-08: - get: - description: Deletes the specified service-specific credential. - operationId: GET_DeleteServiceSpecificCredential - parameters: - - description: '

The name of the IAM user associated with the service-specific - credential. If this value is not specified, then the operation assumes the - user whose credentials are used to call the operation.

This parameter - allows (through its regex pattern) - a string of characters consisting of upper and lowercase alphanumeric characters - with no spaces. You can also include any of the following characters: _+=,.@-

' - in: query - name: UserName - required: false - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description:

The unique identifier of the service-specific credential. - You can get this value by calling ListServiceSpecificCredentials.

-

This parameter allows (through its regex - pattern) a string of characters that can consist of any upper or lowercased - letter or digit.

- in: query - name: ServiceSpecificCredentialId - required: true - schema: - maxLength: 128 - minLength: 20 - pattern: '[\w]+' - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - x-aws-operation-name: DeleteServiceSpecificCredential - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description: Deletes the specified service-specific credential. - operationId: POST_DeleteServiceSpecificCredential - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteServiceSpecificCredentialRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - x-aws-operation-name: DeleteServiceSpecificCredential - /?Action=DeleteSigningCertificate&Version=2010-05-08: - get: - description:

Deletes a signing certificate associated with the specified - IAM user.

If you do not specify a user name, IAM determines the user - name implicitly based on the Amazon Web Services access key ID signing the - request. This operation works for access keys under the Amazon Web Services - account. Consequently, you can use this operation to manage Amazon Web Services - account root user credentials even if the Amazon Web Services account has - no associated IAM users.

- operationId: GET_DeleteSigningCertificate - parameters: - - description: '

The name of the user the signing certificate belongs to.

-

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: UserName - required: false - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description:

The ID of the signing certificate to delete.

The format - of this parameter, as described by its regex - pattern, is a string of characters that can be upper- or lower-cased letters - or digits.

- in: query - name: CertificateId - required: true - schema: - maxLength: 128 - minLength: 24 - pattern: '[\w]+' - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteSigningCertificate - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Deletes a signing certificate associated with the specified - IAM user.

If you do not specify a user name, IAM determines the user - name implicitly based on the Amazon Web Services access key ID signing the - request. This operation works for access keys under the Amazon Web Services - account. Consequently, you can use this operation to manage Amazon Web Services - account root user credentials even if the Amazon Web Services account has - no associated IAM users.

- operationId: POST_DeleteSigningCertificate - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteSigningCertificateRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteSigningCertificate - /?Action=DeleteUser&Version=2010-05-08: - get: - description:

Deletes the specified IAM user. Unlike the Amazon Web Services - Management Console, when you delete a user programmatically, you must delete - the items attached to the user manually, or the deletion fails. For more information, - see Deleting - an IAM user. Before attempting to delete a user, remove the following - items:

- operationId: GET_DeleteUser - parameters: - - description: '

The name of the user to delete.

This parameter allows - (through its regex pattern) - a string of characters consisting of upper and lowercase alphanumeric characters - with no spaces. You can also include any of the following characters: _+=,.@-

' - in: query - name: UserName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteConflictException' - description: DeleteConflictException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteUser - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Deletes the specified IAM user. Unlike the Amazon Web Services - Management Console, when you delete a user programmatically, you must delete - the items attached to the user manually, or the deletion fails. For more information, - see Deleting - an IAM user. Before attempting to delete a user, remove the following - items:

- operationId: POST_DeleteUser - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteUserRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteConflictException' - description: DeleteConflictException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteUser - /?Action=DeleteUserPermissionsBoundary&Version=2010-05-08: - get: - description:

Deletes the permissions boundary for the specified IAM user.

-

Deleting the permissions boundary for a user might increase - its permissions by allowing the user to perform all the actions granted in - its permissions policies.

- operationId: GET_DeleteUserPermissionsBoundary - parameters: - - description: The name (friendly name, not ARN) of the IAM user from which - you want to remove the permissions boundary. - in: query - name: UserName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteUserPermissionsBoundary - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Deletes the permissions boundary for the specified IAM user.

-

Deleting the permissions boundary for a user might increase - its permissions by allowing the user to perform all the actions granted in - its permissions policies.

- operationId: POST_DeleteUserPermissionsBoundary - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteUserPermissionsBoundaryRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteUserPermissionsBoundary - /?Action=DeleteUserPolicy&Version=2010-05-08: - get: - description:

Deletes the specified inline policy that is embedded in the - specified IAM user.

A user can also have managed policies attached - to it. To detach a managed policy from a user, use DetachUserPolicy. - For more information about policies, refer to Managed - policies and inline policies in the IAM User Guide.

- operationId: GET_DeleteUserPolicy - parameters: - - description: '

The name (friendly name, not ARN) identifying the user that - the policy is embedded in.

This parameter allows (through its regex pattern) a string of characters - consisting of upper and lowercase alphanumeric characters with no spaces. - You can also include any of the following characters: _+=,.@-

' - in: query - name: UserName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: '

The name identifying the policy document to delete.

This - parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: PolicyName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteUserPolicy - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Deletes the specified inline policy that is embedded in the - specified IAM user.

A user can also have managed policies attached - to it. To detach a managed policy from a user, use DetachUserPolicy. - For more information about policies, refer to Managed - policies and inline policies in the IAM User Guide.

- operationId: POST_DeleteUserPolicy - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteUserPolicyRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteUserPolicy - /?Action=DeleteVirtualMFADevice&Version=2010-05-08: - get: - description:

Deletes a virtual MFA device.

You must deactivate - a user's virtual MFA device before you can delete it. For information about - deactivating MFA devices, see DeactivateMFADevice.

- operationId: GET_DeleteVirtualMFADevice - parameters: - - description: '

The serial number that uniquely identifies the MFA device. - For virtual MFA devices, the serial number is the same as the ARN.

This - parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - =,.@:/-

' - in: query - name: SerialNumber - required: true - schema: - maxLength: 256 - minLength: 9 - pattern: '[\w+=/:,.@-]+' - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteConflictException' - description: DeleteConflictException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteVirtualMFADevice - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Deletes a virtual MFA device.

You must deactivate - a user's virtual MFA device before you can delete it. For information about - deactivating MFA devices, see DeactivateMFADevice.

- operationId: POST_DeleteVirtualMFADevice - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteVirtualMFADeviceRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteConflictException' - description: DeleteConflictException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DeleteVirtualMFADevice - /?Action=DetachGroupPolicy&Version=2010-05-08: - get: - description:

Removes the specified managed policy from the specified IAM - group.

A group can also have inline policies embedded with it. To delete - an inline policy, use DeleteGroupPolicy. For information about policies, - see Managed - policies and inline policies in the IAM User Guide.

- operationId: GET_DetachGroupPolicy - parameters: - - description: '

The name (friendly name, not ARN) of the IAM group to detach - the policy from.

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: GroupName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description:

The Amazon Resource Name (ARN) of the IAM policy you want - to detach.

For more information about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.

- in: query - name: PolicyArn - required: true - schema: - description:

The Amazon Resource Name (ARN). ARNs are unique identifiers - for Amazon Web Services resources.

For more information about ARNs, - go to Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference. -

- maxLength: 2048 - minLength: 20 - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DetachGroupPolicy - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Removes the specified managed policy from the specified IAM - group.

A group can also have inline policies embedded with it. To delete - an inline policy, use DeleteGroupPolicy. For information about policies, - see Managed - policies and inline policies in the IAM User Guide.

- operationId: POST_DetachGroupPolicy - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DetachGroupPolicyRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DetachGroupPolicy - /?Action=DetachRolePolicy&Version=2010-05-08: - get: - description:

Removes the specified managed policy from the specified role.

-

A role can also have inline policies embedded with it. To delete an inline - policy, use DeleteRolePolicy. For information about policies, see Managed - policies and inline policies in the IAM User Guide.

- operationId: GET_DetachRolePolicy - parameters: - - description: '

The name (friendly name, not ARN) of the IAM role to detach - the policy from.

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: RoleName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description:

The Amazon Resource Name (ARN) of the IAM policy you want - to detach.

For more information about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.

- in: query - name: PolicyArn - required: true - schema: - description:

The Amazon Resource Name (ARN). ARNs are unique identifiers - for Amazon Web Services resources.

For more information about ARNs, - go to Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference. -

- maxLength: 2048 - minLength: 20 - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/UnmodifiableEntityException' - description: UnmodifiableEntityException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DetachRolePolicy - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Removes the specified managed policy from the specified role.

-

A role can also have inline policies embedded with it. To delete an inline - policy, use DeleteRolePolicy. For information about policies, see Managed - policies and inline policies in the IAM User Guide.

- operationId: POST_DetachRolePolicy - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DetachRolePolicyRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/UnmodifiableEntityException' - description: UnmodifiableEntityException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DetachRolePolicy - /?Action=DetachUserPolicy&Version=2010-05-08: - get: - description:

Removes the specified managed policy from the specified user.

-

A user can also have inline policies embedded with it. To delete an inline - policy, use DeleteUserPolicy. For information about policies, see Managed - policies and inline policies in the IAM User Guide.

- operationId: GET_DetachUserPolicy - parameters: - - description: '

The name (friendly name, not ARN) of the IAM user to detach - the policy from.

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: UserName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description:

The Amazon Resource Name (ARN) of the IAM policy you want - to detach.

For more information about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.

- in: query - name: PolicyArn - required: true - schema: - description:

The Amazon Resource Name (ARN). ARNs are unique identifiers - for Amazon Web Services resources.

For more information about ARNs, - go to Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference. -

- maxLength: 2048 - minLength: 20 - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DetachUserPolicy - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Removes the specified managed policy from the specified user.

-

A user can also have inline policies embedded with it. To delete an inline - policy, use DeleteUserPolicy. For information about policies, see Managed - policies and inline policies in the IAM User Guide.

- operationId: POST_DetachUserPolicy - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DetachUserPolicyRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: DetachUserPolicy - /?Action=EnableMFADevice&Version=2010-05-08: - get: - description: Enables the specified MFA device and associates it with the specified - IAM user. When enabled, the MFA device is required for every subsequent login - by the IAM user associated with the device. - operationId: GET_EnableMFADevice - parameters: - - description: '

The name of the IAM user for whom you want to enable the - MFA device.

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: UserName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: '

The serial number that uniquely identifies the MFA device. - For virtual MFA devices, the serial number is the device ARN.

This - parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - =,.@:/-

' - in: query - name: SerialNumber - required: true - schema: - maxLength: 256 - minLength: 9 - pattern: '[\w+=/:,.@-]+' - type: string - - description:

An authentication code emitted by the device.

The - format for this parameter is a string of six digits.

Submit - your request immediately after generating the authentication codes. If you - generate the codes and then wait too long to submit the request, the MFA - device successfully associates with the user but the MFA device becomes - out of sync. This happens because time-based one-time passwords (TOTP) expire - after a short period of time. If this happens, you can resync - the device.

 - in: query - name: AuthenticationCode1 - required: true - schema: - maxLength: 6 - minLength: 6 - pattern: '[\d]+' - type: string - - description:

A subsequent authentication code emitted by the device.

-

The format for this parameter is a string of six digits.

-

Submit your request immediately after generating the authentication codes. - If you generate the codes and then wait too long to submit the request, - the MFA device successfully associates with the user but the MFA device - becomes out of sync. This happens because time-based one-time passwords - (TOTP) expire after a short period of time. If this happens, you can resync - the device.

 - in: query - name: AuthenticationCode2 - required: true - schema: - maxLength: 6 - minLength: 6 - pattern: '[\d]+' - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityAlreadyExistsException' - description: EntityAlreadyExistsException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityTemporarilyUnmodifiableException' - description: EntityTemporarilyUnmodifiableException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidAuthenticationCodeException' - description: InvalidAuthenticationCodeException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '485': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: EnableMFADevice - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description: Enables the specified MFA device and associates it with the specified - IAM user. When enabled, the MFA device is required for every subsequent login - by the IAM user associated with the device. - operationId: POST_EnableMFADevice - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/EnableMFADeviceRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityAlreadyExistsException' - description: EntityAlreadyExistsException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityTemporarilyUnmodifiableException' - description: EntityTemporarilyUnmodifiableException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidAuthenticationCodeException' - description: InvalidAuthenticationCodeException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '485': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: EnableMFADevice - /?Action=GenerateCredentialReport&Version=2010-05-08: - get: - description: ' Generates a credential report for the Amazon Web Services account. - For more information about the credential report, see Getting - credential reports in the IAM User Guide.' - operationId: GET_GenerateCredentialReport - parameters: [] - responses: - '200': - content: - text/xml: - schema: - properties: - GenerateCredentialReportResult: - $ref: '#/components/schemas/GenerateCredentialReportResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: GenerateCredentialReport - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description: ' Generates a credential report for the Amazon Web Services account. - For more information about the credential report, see Getting - credential reports in the IAM User Guide.' - operationId: POST_GenerateCredentialReport - parameters: [] - responses: - '200': - content: - text/xml: - schema: - properties: - GenerateCredentialReportResult: - $ref: '#/components/schemas/GenerateCredentialReportResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: GenerateCredentialReport - /?Action=GenerateOrganizationsAccessReport&Version=2010-05-08: - get: - description: "

Generates a report for service last accessed data for Organizations.\ - \ You can generate a report for any entities (organization root, organizational\ - \ unit, or account) or policies in your organization.

To call this\ - \ operation, you must be signed in using your Organizations management account\ - \ credentials. You can use your long-term IAM user or root user credentials,\ - \ or temporary credentials from assuming an IAM role. SCPs must be enabled\ - \ for your organization root. You must have the required IAM and Organizations\ - \ permissions. For more information, see Refining permissions using service last accessed data in the IAM User\ - \ Guide.

You can generate a service last accessed data report for\ - \ entities by specifying only the entity's path. This data includes a list\ - \ of services that are allowed by any service control policies (SCPs) that\ - \ apply to the entity.

You can generate a service last accessed data\ - \ report for a policy by specifying an entity's path and an optional Organizations\ - \ policy ID. This data includes a list of services that are allowed by the\ - \ specified SCP.

For each service in both report types, the data includes\ - \ the most recent account activity that the policy allows to account principals\ - \ in the entity or the entity's children. For important information about\ - \ the data, reporting period, permissions required, troubleshooting, and supported\ - \ Regions see Reducing permissions using service last accessed data in the IAM User\ - \ Guide.

The data includes\_all\_attempts to access\ - \ Amazon Web Services, not just the successful ones. This includes all attempts\ - \ that were made using the Amazon Web Services Management Console, the Amazon\ - \ Web Services API through any of the SDKs, or any of the command line tools.\ - \ An unexpected entry in the service last accessed data does not mean that\ - \ an account has been compromised, because the request might have been denied.\ - \ Refer to your CloudTrail logs as the authoritative source for information\ - \ about all API calls and whether they were successful or denied access. For\ - \ more information, see\_Logging IAM events with CloudTrail in the IAM User Guide.

\ - \

This operation returns a JobId. Use this parameter\ - \ in the GetOrganizationsAccessReport operation to check\ - \ the status of the report generation. To check the status of this request,\ - \ use the JobId parameter in the GetOrganizationsAccessReport\ - \ operation and test the JobStatus response parameter.\ - \ When the job is complete, you can retrieve the report.

To generate\ - \ a service last accessed data report for entities, specify an entity path\ - \ without specifying the optional Organizations policy ID. The type of entity\ - \ that you specify determines the data returned in the report.

  • \ - \

    Root \u2013 When you specify the organizations root as the entity,\ - \ the resulting report lists all of the services allowed by SCPs that are\ - \ attached to your root. For each service, the report includes data for all\ - \ accounts in your organization except the management account, because the\ - \ management account is not limited by SCPs.

  • OU\ - \ \u2013 When you specify an organizational unit (OU) as the entity, the resulting\ - \ report lists all of the services allowed by SCPs that are attached to the\ - \ OU and its parents. For each service, the report includes data for all accounts\ - \ in the OU or its children. This data excludes the management account, because\ - \ the management account is not limited by SCPs.

  • management\ - \ account \u2013 When you specify the management account, the resulting\ - \ report lists all Amazon Web Services services, because the management account\ - \ is not limited by SCPs. For each service, the report includes data for only\ - \ the management account.

  • Account \u2013 When you\ - \ specify another account as the entity, the resulting report lists all of\ - \ the services allowed by SCPs that are attached to the account and its parents.\ - \ For each service, the report includes data for only the specified account.

    \ - \

To generate a service last accessed data report for policies,\ - \ specify an entity path and the optional Organizations policy ID. The type\ - \ of entity that you specify determines the data returned for each service.

\ - \

  • Root \u2013 When you specify the root entity and a\ - \ policy ID, the resulting report lists all of the services that are allowed\ - \ by the specified SCP. For each service, the report includes data for all\ - \ accounts in your organization to which the SCP applies. This data excludes\ - \ the management account, because the management account is not limited by\ - \ SCPs. If the SCP is not attached to any entities in the organization, then\ - \ the report will return a list of services with no data.

  • \ - \ OU \u2013 When you specify an OU entity and a policy ID, the resulting\ - \ report lists all of the services that are allowed by the specified SCP.\ - \ For each service, the report includes data for all accounts in the OU or\ - \ its children to which the SCP applies. This means that other accounts outside\ - \ the OU that are affected by the SCP might not be included in the data. This\ - \ data excludes the management account, because the management account is\ - \ not limited by SCPs. If the SCP is not attached to the OU or one of its\ - \ children, the report will return a list of services with no data.

    • \ - \

  • management account \u2013 When you specify the management\ - \ account, the resulting report lists all Amazon Web Services services, because\ - \ the management account is not limited by SCPs. If you specify a policy ID\ - \ in the CLI or API, the policy is ignored. For each service, the report includes\ - \ data for only the management account.

  • Account\ - \ \u2013 When you specify another account entity and a policy ID, the resulting\ - \ report lists all of the services that are allowed by the specified SCP.\ - \ For each service, the report includes data for only the specified account.\ - \ This means that other accounts in the organization that are affected by\ - \ the SCP might not be included in the data. If the SCP is not attached to\ - \ the account, the report will return a list of services with no data.

    \ - \

Service last accessed data does not use other policy\ - \ types when determining whether a principal could access a service. These\ - \ other policy types include identity-based policies, resource-based policies,\ - \ access control lists, IAM permissions boundaries, and STS assume role policies.\ - \ It only applies SCP logic. For more about the evaluation of policy types,\ - \ see Evaluating policies in the IAM User Guide.

For\ - \ more information about service last accessed data, see Reducing policy scope by viewing user activity in the IAM User Guide.

" - operationId: GET_GenerateOrganizationsAccessReport - parameters: - - description: The path of the Organizations entity (root, OU, or account). - You can build an entity path using the known structure of your organization. - For example, assume that your account ID is 123456789012 and - its parent OU ID is ou-rge0-awsabcde. The organization root - ID is r-f6g7h8i9j0example and your organization ID is o-a1b2c3d4e5. - Your entity path is o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-rge0-awsabcde/123456789012. - in: query - name: EntityPath - required: true - schema: - maxLength: 427 - minLength: 19 - pattern: ^o-[0-9a-z]{10,32}\/r-[0-9a-z]{4,32}[0-9a-z-\/]* - type: string - - description:

The identifier of the Organizations service control policy - (SCP). This parameter is optional.

This ID is used to generate information - about when an account principal that is limited by the SCP attempted to - access an Amazon Web Services service.

- in: query - name: OrganizationsPolicyId - required: false - schema: - pattern: ^p-[0-9a-zA-Z_]{8,128}$ - type: string - responses: - '200': - content: - text/xml: - schema: - properties: - GenerateOrganizationsAccessReportResult: - $ref: '#/components/schemas/GenerateOrganizationsAccessReportResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/ReportGenerationLimitExceededException' - description: ReportGenerationLimitExceededException - x-aws-operation-name: GenerateOrganizationsAccessReport - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description: "

Generates a report for service last accessed data for Organizations.\ - \ You can generate a report for any entities (organization root, organizational\ - \ unit, or account) or policies in your organization.

To call this\ - \ operation, you must be signed in using your Organizations management account\ - \ credentials. You can use your long-term IAM user or root user credentials,\ - \ or temporary credentials from assuming an IAM role. SCPs must be enabled\ - \ for your organization root. You must have the required IAM and Organizations\ - \ permissions. For more information, see Refining permissions using service last accessed data in the IAM User\ - \ Guide.

You can generate a service last accessed data report for\ - \ entities by specifying only the entity's path. This data includes a list\ - \ of services that are allowed by any service control policies (SCPs) that\ - \ apply to the entity.

You can generate a service last accessed data\ - \ report for a policy by specifying an entity's path and an optional Organizations\ - \ policy ID. This data includes a list of services that are allowed by the\ - \ specified SCP.

For each service in both report types, the data includes\ - \ the most recent account activity that the policy allows to account principals\ - \ in the entity or the entity's children. For important information about\ - \ the data, reporting period, permissions required, troubleshooting, and supported\ - \ Regions see Reducing permissions using service last accessed data in the IAM User\ - \ Guide.

The data includes\_all\_attempts to access\ - \ Amazon Web Services, not just the successful ones. This includes all attempts\ - \ that were made using the Amazon Web Services Management Console, the Amazon\ - \ Web Services API through any of the SDKs, or any of the command line tools.\ - \ An unexpected entry in the service last accessed data does not mean that\ - \ an account has been compromised, because the request might have been denied.\ - \ Refer to your CloudTrail logs as the authoritative source for information\ - \ about all API calls and whether they were successful or denied access. For\ - \ more information, see\_Logging IAM events with CloudTrail in the IAM User Guide.

\ - \

This operation returns a JobId. Use this parameter\ - \ in the GetOrganizationsAccessReport operation to check\ - \ the status of the report generation. To check the status of this request,\ - \ use the JobId parameter in the GetOrganizationsAccessReport\ - \ operation and test the JobStatus response parameter.\ - \ When the job is complete, you can retrieve the report.

To generate\ - \ a service last accessed data report for entities, specify an entity path\ - \ without specifying the optional Organizations policy ID. The type of entity\ - \ that you specify determines the data returned in the report.

  • \ - \

    Root \u2013 When you specify the organizations root as the entity,\ - \ the resulting report lists all of the services allowed by SCPs that are\ - \ attached to your root. For each service, the report includes data for all\ - \ accounts in your organization except the management account, because the\ - \ management account is not limited by SCPs.

  • OU\ - \ \u2013 When you specify an organizational unit (OU) as the entity, the resulting\ - \ report lists all of the services allowed by SCPs that are attached to the\ - \ OU and its parents. For each service, the report includes data for all accounts\ - \ in the OU or its children. This data excludes the management account, because\ - \ the management account is not limited by SCPs.

  • management\ - \ account \u2013 When you specify the management account, the resulting\ - \ report lists all Amazon Web Services services, because the management account\ - \ is not limited by SCPs. For each service, the report includes data for only\ - \ the management account.

  • Account \u2013 When you\ - \ specify another account as the entity, the resulting report lists all of\ - \ the services allowed by SCPs that are attached to the account and its parents.\ - \ For each service, the report includes data for only the specified account.

    \ - \

To generate a service last accessed data report for policies,\ - \ specify an entity path and the optional Organizations policy ID. The type\ - \ of entity that you specify determines the data returned for each service.

\ - \

  • Root \u2013 When you specify the root entity and a\ - \ policy ID, the resulting report lists all of the services that are allowed\ - \ by the specified SCP. For each service, the report includes data for all\ - \ accounts in your organization to which the SCP applies. This data excludes\ - \ the management account, because the management account is not limited by\ - \ SCPs. If the SCP is not attached to any entities in the organization, then\ - \ the report will return a list of services with no data.

  • \ - \ OU \u2013 When you specify an OU entity and a policy ID, the resulting\ - \ report lists all of the services that are allowed by the specified SCP.\ - \ For each service, the report includes data for all accounts in the OU or\ - \ its children to which the SCP applies. This means that other accounts outside\ - \ the OU that are affected by the SCP might not be included in the data. This\ - \ data excludes the management account, because the management account is\ - \ not limited by SCPs. If the SCP is not attached to the OU or one of its\ - \ children, the report will return a list of services with no data.

    • \ - \

  • management account \u2013 When you specify the management\ - \ account, the resulting report lists all Amazon Web Services services, because\ - \ the management account is not limited by SCPs. If you specify a policy ID\ - \ in the CLI or API, the policy is ignored. For each service, the report includes\ - \ data for only the management account.

  • Account\ - \ \u2013 When you specify another account entity and a policy ID, the resulting\ - \ report lists all of the services that are allowed by the specified SCP.\ - \ For each service, the report includes data for only the specified account.\ - \ This means that other accounts in the organization that are affected by\ - \ the SCP might not be included in the data. If the SCP is not attached to\ - \ the account, the report will return a list of services with no data.

    \ - \

Service last accessed data does not use other policy\ - \ types when determining whether a principal could access a service. These\ - \ other policy types include identity-based policies, resource-based policies,\ - \ access control lists, IAM permissions boundaries, and STS assume role policies.\ - \ It only applies SCP logic. For more about the evaluation of policy types,\ - \ see Evaluating policies in the IAM User Guide.

For\ - \ more information about service last accessed data, see Reducing policy scope by viewing user activity in the IAM User Guide.

" - operationId: POST_GenerateOrganizationsAccessReport - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GenerateOrganizationsAccessReportRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - GenerateOrganizationsAccessReportResult: - $ref: '#/components/schemas/GenerateOrganizationsAccessReportResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/ReportGenerationLimitExceededException' - description: ReportGenerationLimitExceededException - x-aws-operation-name: GenerateOrganizationsAccessReport - /?Action=GenerateServiceLastAccessedDetails&Version=2010-05-08: - get: - description: "

Generates a report that includes details about when an IAM\ - \ resource (user, group, role, or policy) was last used in an attempt to access\ - \ Amazon Web Services services. Recent activity usually appears within four\ - \ hours. IAM reports activity for at least the last 400 days, or less if your\ - \ Region began supporting this feature within the last year. For more information,\ - \ see Regions where data is tracked.

The service last accessed\ - \ data includes\_all\_attempts to access an Amazon Web Services API, not just\ - \ the successful ones. This includes all attempts that were made using the\ - \ Amazon Web Services Management Console, the Amazon Web Services API through\ - \ any of the SDKs, or any of the command line tools. An unexpected entry in\ - \ the service last accessed data does not mean that your account has been\ - \ compromised, because the request might have been denied. Refer to your CloudTrail\ - \ logs as the authoritative source for information about all API calls and\ - \ whether they were successful or denied access. For more information, see\_\ - Logging IAM events with CloudTrail in the IAM User Guide.

\ - \

The GenerateServiceLastAccessedDetails operation\ - \ returns a JobId. Use this parameter in the following operations\ - \ to retrieve the following details from your report:

  • GetServiceLastAccessedDetails\ - \ \u2013 Use this operation for users, groups, roles, or policies to list\ - \ every Amazon Web Services service that the resource could access using permissions\ - \ policies. For each service, the response includes information about the\ - \ most recent access attempt.

    The JobId returned by GenerateServiceLastAccessedDetail\ - \ must be used by the same role within a session, or by the same user when\ - \ used to call GetServiceLastAccessedDetail.

  • \ - \ GetServiceLastAccessedDetailsWithEntities \u2013 Use this operation\ - \ for groups and policies to list information about the associated entities\ - \ (users or roles) that attempted to access a specific Amazon Web Services\ - \ service.

To check the status of the GenerateServiceLastAccessedDetails\ - \ request, use the JobId parameter in the same operations and\ - \ test the JobStatus response parameter.

For additional\ - \ information about the permissions policies that allow an identity (user,\ - \ group, or role) to access specific services, use the ListPoliciesGrantingServiceAccess\ - \ operation.

Service last accessed data does not use other policy\ - \ types when determining whether a resource could access a service. These\ - \ other policy types include resource-based policies, access control lists,\ - \ Organizations policies, IAM permissions boundaries, and STS assume role\ - \ policies. It only applies permissions policy logic. For more about the evaluation\ - \ of policy types, see Evaluating policies in the IAM User Guide.

For\ - \ more information about service and action last accessed data, see Reducing permissions using service last accessed data in the IAM User\ - \ Guide.

" - operationId: GET_GenerateServiceLastAccessedDetails - parameters: - - description: The ARN of the IAM resource (user, group, role, or managed policy) - used to generate information about when the resource was last used in an - attempt to access an Amazon Web Services service. - in: query - name: Arn - required: true - schema: - description:

The Amazon Resource Name (ARN). ARNs are unique identifiers - for Amazon Web Services resources.

For more information about ARNs, - go to Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference. -

- maxLength: 2048 - minLength: 20 - type: string - - description: The level of detail that you want to generate. You can specify - whether you want to generate information about the last attempt to access - services or actions. If you specify service-level granularity, this operation - generates only service data. If you specify action-level granularity, it - generates service and action data. If you don't include this optional parameter, - the operation generates service data. - in: query - name: Granularity - required: false - schema: - enum: - - SERVICE_LEVEL - - ACTION_LEVEL - type: string - responses: - '200': - content: - text/xml: - schema: - properties: - GenerateServiceLastAccessedDetailsResult: - $ref: '#/components/schemas/GenerateServiceLastAccessedDetailsResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - x-aws-operation-name: GenerateServiceLastAccessedDetails - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description: "

Generates a report that includes details about when an IAM\ - \ resource (user, group, role, or policy) was last used in an attempt to access\ - \ Amazon Web Services services. Recent activity usually appears within four\ - \ hours. IAM reports activity for at least the last 400 days, or less if your\ - \ Region began supporting this feature within the last year. For more information,\ - \ see Regions where data is tracked.

The service last accessed\ - \ data includes\_all\_attempts to access an Amazon Web Services API, not just\ - \ the successful ones. This includes all attempts that were made using the\ - \ Amazon Web Services Management Console, the Amazon Web Services API through\ - \ any of the SDKs, or any of the command line tools. An unexpected entry in\ - \ the service last accessed data does not mean that your account has been\ - \ compromised, because the request might have been denied. Refer to your CloudTrail\ - \ logs as the authoritative source for information about all API calls and\ - \ whether they were successful or denied access. For more information, see\_\ - Logging IAM events with CloudTrail in the IAM User Guide.

\ - \

The GenerateServiceLastAccessedDetails operation\ - \ returns a JobId. Use this parameter in the following operations\ - \ to retrieve the following details from your report:

  • GetServiceLastAccessedDetails\ - \ \u2013 Use this operation for users, groups, roles, or policies to list\ - \ every Amazon Web Services service that the resource could access using permissions\ - \ policies. For each service, the response includes information about the\ - \ most recent access attempt.

    The JobId returned by GenerateServiceLastAccessedDetail\ - \ must be used by the same role within a session, or by the same user when\ - \ used to call GetServiceLastAccessedDetail.

  • \ - \ GetServiceLastAccessedDetailsWithEntities \u2013 Use this operation\ - \ for groups and policies to list information about the associated entities\ - \ (users or roles) that attempted to access a specific Amazon Web Services\ - \ service.

To check the status of the GenerateServiceLastAccessedDetails\ - \ request, use the JobId parameter in the same operations and\ - \ test the JobStatus response parameter.

For additional\ - \ information about the permissions policies that allow an identity (user,\ - \ group, or role) to access specific services, use the ListPoliciesGrantingServiceAccess\ - \ operation.

Service last accessed data does not use other policy\ - \ types when determining whether a resource could access a service. These\ - \ other policy types include resource-based policies, access control lists,\ - \ Organizations policies, IAM permissions boundaries, and STS assume role\ - \ policies. It only applies permissions policy logic. For more about the evaluation\ - \ of policy types, see Evaluating policies in the IAM User Guide.

For\ - \ more information about service and action last accessed data, see Reducing permissions using service last accessed data in the IAM User\ - \ Guide.

" - operationId: POST_GenerateServiceLastAccessedDetails - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GenerateServiceLastAccessedDetailsRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - GenerateServiceLastAccessedDetailsResult: - $ref: '#/components/schemas/GenerateServiceLastAccessedDetailsResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - x-aws-operation-name: GenerateServiceLastAccessedDetails - /?Action=GetAccessKeyLastUsed&Version=2010-05-08: - get: - description: Retrieves information about when the specified access key was last - used. The information includes the date and time of last use, along with the - Amazon Web Services service and Region that were specified in the last request - made with that key. - operationId: GET_GetAccessKeyLastUsed - parameters: - - description:

The identifier of an access key.

This parameter allows - (through its regex pattern) - a string of characters that can consist of any upper or lowercased letter - or digit.

- in: query - name: AccessKeyId - required: true - schema: - maxLength: 128 - minLength: 16 - pattern: '[\w]+' - type: string - responses: - '200': - content: - text/xml: - schema: - properties: - GetAccessKeyLastUsedResult: - $ref: '#/components/schemas/GetAccessKeyLastUsedResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - x-aws-operation-name: GetAccessKeyLastUsed - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description: Retrieves information about when the specified access key was last - used. The information includes the date and time of last use, along with the - Amazon Web Services service and Region that were specified in the last request - made with that key. - operationId: POST_GetAccessKeyLastUsed - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetAccessKeyLastUsedRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - GetAccessKeyLastUsedResult: - $ref: '#/components/schemas/GetAccessKeyLastUsedResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - x-aws-operation-name: GetAccessKeyLastUsed - /?Action=GetAccountAuthorizationDetails&Version=2010-05-08: - get: - description:

Retrieves information about all IAM users, groups, roles, and - policies in your Amazon Web Services account, including their relationships - to one another. Use this operation to obtain a snapshot of the configuration - of IAM permissions (users, groups, roles, and policies) in your account.

-

Policies returned by this operation are URL-encoded compliant with - RFC 3986. You can use a - URL decoding method to convert the policy back to plain JSON text. For example, - if you use Java, you can use the decode method of the java.net.URLDecoder - utility class in the Java SDK. Other languages and SDKs provide similar functionality.

-

You can optionally filter the results using the Filter - parameter. You can paginate the results using the MaxItems and - Marker parameters.

- operationId: GET_GetAccountAuthorizationDetails - parameters: - - description:

A list of entity types used to filter the results. Only the - entities that match the types you specify are included in the output. Use - the value LocalManagedPolicy to include customer managed policies.

-

The format for this parameter is a comma-separated (if more than one) - list of strings. Each string value in the list must be one of the valid - values listed below.

- in: query - name: Filter - required: false - schema: - items: - allOf: - - $ref: '#/components/schemas/EntityType' - - xml: - name: member - type: array - - description:

Use this only when paginating results to indicate the maximum - number of items you want in the response. If additional items exist beyond - the maximum you specify, the IsTruncated response element is - true.

If you do not include this parameter, the number - of items defaults to 100. Note that IAM might return fewer results, even - when there are more results available. In that case, the IsTruncated - response element returns true, and Marker contains - a value to include in the subsequent call that tells the service where to - continue from.

- in: query - name: MaxItems - required: false - schema: - maximum: 1000 - minimum: 1 - type: integer - - description: Use this parameter only when paginating results and only after - you receive a response indicating that the results are truncated. Set it - to the value of the Marker element in the response that you - received to indicate where the next call should start. - in: query - name: Marker - required: false - schema: - maxLength: 320 - minLength: 1 - pattern: '[\u0020-\u00FF]+' - type: string - responses: - '200': - content: - text/xml: - schema: - properties: - GetAccountAuthorizationDetailsResult: - $ref: '#/components/schemas/GetAccountAuthorizationDetailsResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: GetAccountAuthorizationDetails - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Retrieves information about all IAM users, groups, roles, and - policies in your Amazon Web Services account, including their relationships - to one another. Use this operation to obtain a snapshot of the configuration - of IAM permissions (users, groups, roles, and policies) in your account.

-

Policies returned by this operation are URL-encoded compliant with - RFC 3986. You can use a - URL decoding method to convert the policy back to plain JSON text. For example, - if you use Java, you can use the decode method of the java.net.URLDecoder - utility class in the Java SDK. Other languages and SDKs provide similar functionality.

-

You can optionally filter the results using the Filter - parameter. You can paginate the results using the MaxItems and - Marker parameters.

- operationId: POST_GetAccountAuthorizationDetails - parameters: - - description: Pagination limit - in: query - name: MaxItems - required: false - schema: - type: string - - description: Pagination token - in: query - name: Marker - required: false - schema: - type: string - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetAccountAuthorizationDetailsRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - GetAccountAuthorizationDetailsResult: - $ref: '#/components/schemas/GetAccountAuthorizationDetailsResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: GetAccountAuthorizationDetails - /?Action=GetAccountPasswordPolicy&Version=2010-05-08: - get: - description: Retrieves the password policy for the Amazon Web Services account. - This tells you the complexity requirements and mandatory rotation periods - for the IAM user passwords in your account. For more information about using - a password policy, see Managing - an IAM password policy. - operationId: GET_GetAccountPasswordPolicy - parameters: [] - responses: - '200': - content: - text/xml: - schema: - properties: - GetAccountPasswordPolicyResult: - $ref: '#/components/schemas/GetAccountPasswordPolicyResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: GetAccountPasswordPolicy - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description: Retrieves the password policy for the Amazon Web Services account. - This tells you the complexity requirements and mandatory rotation periods - for the IAM user passwords in your account. For more information about using - a password policy, see Managing - an IAM password policy. - operationId: POST_GetAccountPasswordPolicy - parameters: [] - responses: - '200': - content: - text/xml: - schema: - properties: - GetAccountPasswordPolicyResult: - $ref: '#/components/schemas/GetAccountPasswordPolicyResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: GetAccountPasswordPolicy - /?Action=GetAccountSummary&Version=2010-05-08: - get: - description:

Retrieves information about IAM entity usage and IAM quotas - in the Amazon Web Services account.

For information about IAM quotas, - see IAM - and STS quotas in the IAM User Guide.

- operationId: GET_GetAccountSummary - parameters: [] - responses: - '200': - content: - text/xml: - schema: - properties: - GetAccountSummaryResult: - $ref: '#/components/schemas/GetAccountSummaryResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: GetAccountSummary - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Retrieves information about IAM entity usage and IAM quotas - in the Amazon Web Services account.

For information about IAM quotas, - see IAM - and STS quotas in the IAM User Guide.

- operationId: POST_GetAccountSummary - parameters: [] - responses: - '200': - content: - text/xml: - schema: - properties: - GetAccountSummaryResult: - $ref: '#/components/schemas/GetAccountSummaryResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: GetAccountSummary - /?Action=GetContextKeysForCustomPolicy&Version=2010-05-08: - get: - description:

Gets a list of all of the context keys referenced in the input - policies. The policies are supplied as a list of one or more strings. To get - the context keys from policies associated with an IAM user, group, or role, - use GetContextKeysForPrincipalPolicy.

Context keys are variables - maintained by Amazon Web Services and its services that provide details about - the context of an API query request. Context keys can be evaluated by testing - against a value specified in an IAM policy. Use GetContextKeysForCustomPolicy - to understand what key names and values you must supply when you call SimulateCustomPolicy. - Note that all parameters are shown in unencoded form here for clarity but - must be URL encoded to be included as a part of a real HTML request.

- operationId: GET_GetContextKeysForCustomPolicy - parameters: - - description:

A list of policies for which you want the list of context - keys referenced in those policies. Each document is specified as a string - containing the complete, valid JSON text of an IAM policy.

The regex pattern used to validate - this parameter is a string of characters consisting of the following:

-

  • Any printable ASCII character ranging from the space character - (\u0020) through the end of the ASCII character range

    • -

  • The printable characters in the Basic Latin and Latin-1 Supplement - character set (through \u00FF)

  • The special - characters tab (\u0009), line feed (\u000A), and - carriage return (\u000D)

- in: query - name: PolicyInputList - required: true - schema: - items: - allOf: - - $ref: '#/components/schemas/policyDocumentType' - - xml: - name: member - type: array - responses: - '200': - content: - text/xml: - schema: - properties: - GetContextKeysForCustomPolicyResult: - $ref: '#/components/schemas/GetContextKeysForPolicyResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - x-aws-operation-name: GetContextKeysForCustomPolicy - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Gets a list of all of the context keys referenced in the input - policies. The policies are supplied as a list of one or more strings. To get - the context keys from policies associated with an IAM user, group, or role, - use GetContextKeysForPrincipalPolicy.

Context keys are variables - maintained by Amazon Web Services and its services that provide details about - the context of an API query request. Context keys can be evaluated by testing - against a value specified in an IAM policy. Use GetContextKeysForCustomPolicy - to understand what key names and values you must supply when you call SimulateCustomPolicy. - Note that all parameters are shown in unencoded form here for clarity but - must be URL encoded to be included as a part of a real HTML request.

- operationId: POST_GetContextKeysForCustomPolicy - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetContextKeysForCustomPolicyRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - GetContextKeysForCustomPolicyResult: - $ref: '#/components/schemas/GetContextKeysForPolicyResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - x-aws-operation-name: GetContextKeysForCustomPolicy - /?Action=GetContextKeysForPrincipalPolicy&Version=2010-05-08: - get: - description:

Gets a list of all of the context keys referenced in all the - IAM policies that are attached to the specified IAM entity. The entity can - be an IAM user, group, or role. If you specify a user, then the request also - includes all of the policies attached to groups that the user is a member - of.

You can optionally include a list of one or more additional policies, - specified as strings. If you want to include only a list of policies - by string, use GetContextKeysForCustomPolicy instead.

Note: - This operation discloses information about the permissions granted to other - users. If you do not want users to see other user's permissions, then consider - allowing them to use GetContextKeysForCustomPolicy instead.

Context - keys are variables maintained by Amazon Web Services and its services that - provide details about the context of an API query request. Context keys can - be evaluated by testing against a value in an IAM policy. Use GetContextKeysForPrincipalPolicy - to understand what key names and values you must supply when you call SimulatePrincipalPolicy.

- operationId: GET_GetContextKeysForPrincipalPolicy - parameters: - - description:

The ARN of a user, group, or role whose policies contain the - context keys that you want listed. If you specify a user, the list includes - context keys that are found in all policies that are attached to the user. - The list also includes all groups that the user is a member of. If you pick - a group or a role, then it includes only those context keys that are found - in policies attached to that entity. Note that all parameters are shown - in unencoded form here for clarity, but must be URL encoded to be included - as a part of a real HTML request.

For more information about ARNs, - see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.

- in: query - name: PolicySourceArn - required: true - schema: - description:

The Amazon Resource Name (ARN). ARNs are unique identifiers - for Amazon Web Services resources.

For more information about ARNs, - go to Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference. -

- maxLength: 2048 - minLength: 20 - type: string - - description:

An optional list of additional policies for which you want - the list of context keys that are referenced.

The regex - pattern used to validate this parameter is a string of characters consisting - of the following:

  • Any printable ASCII character ranging - from the space character (\u0020) through the end of the ASCII - character range

  • The printable characters in the Basic - Latin and Latin-1 Supplement character set (through \u00FF)

    -

  • The special characters tab (\u0009), line feed - (\u000A), and carriage return (\u000D)

    • -
- in: query - name: PolicyInputList - required: false - schema: - items: - allOf: - - $ref: '#/components/schemas/policyDocumentType' - - xml: - name: member - type: array - responses: - '200': - content: - text/xml: - schema: - properties: - GetContextKeysForPrincipalPolicyResult: - $ref: '#/components/schemas/GetContextKeysForPolicyResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - x-aws-operation-name: GetContextKeysForPrincipalPolicy - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Gets a list of all of the context keys referenced in all the - IAM policies that are attached to the specified IAM entity. The entity can - be an IAM user, group, or role. If you specify a user, then the request also - includes all of the policies attached to groups that the user is a member - of.

You can optionally include a list of one or more additional policies, - specified as strings. If you want to include only a list of policies - by string, use GetContextKeysForCustomPolicy instead.

Note: - This operation discloses information about the permissions granted to other - users. If you do not want users to see other user's permissions, then consider - allowing them to use GetContextKeysForCustomPolicy instead.

Context - keys are variables maintained by Amazon Web Services and its services that - provide details about the context of an API query request. Context keys can - be evaluated by testing against a value in an IAM policy. Use GetContextKeysForPrincipalPolicy - to understand what key names and values you must supply when you call SimulatePrincipalPolicy.

- operationId: POST_GetContextKeysForPrincipalPolicy - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetContextKeysForPrincipalPolicyRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - GetContextKeysForPrincipalPolicyResult: - $ref: '#/components/schemas/GetContextKeysForPolicyResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - x-aws-operation-name: GetContextKeysForPrincipalPolicy - /?Action=GetCredentialReport&Version=2010-05-08: - get: - description: ' Retrieves a credential report for the Amazon Web Services account. - For more information about the credential report, see Getting - credential reports in the IAM User Guide.' - operationId: GET_GetCredentialReport - parameters: [] - responses: - '200': - content: - text/xml: - schema: - properties: - GetCredentialReportResult: - $ref: '#/components/schemas/GetCredentialReportResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/CredentialReportNotPresentException' - description: CredentialReportNotPresentException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/CredentialReportExpiredException' - description: CredentialReportExpiredException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/CredentialReportNotReadyException' - description: CredentialReportNotReadyException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: GetCredentialReport - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description: ' Retrieves a credential report for the Amazon Web Services account. - For more information about the credential report, see Getting - credential reports in the IAM User Guide.' - operationId: POST_GetCredentialReport - parameters: [] - responses: - '200': - content: - text/xml: - schema: - properties: - GetCredentialReportResult: - $ref: '#/components/schemas/GetCredentialReportResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/CredentialReportNotPresentException' - description: CredentialReportNotPresentException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/CredentialReportExpiredException' - description: CredentialReportExpiredException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/CredentialReportNotReadyException' - description: CredentialReportNotReadyException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: GetCredentialReport - /?Action=GetGroup&Version=2010-05-08: - get: - description: ' Returns a list of IAM users that are in the specified IAM group. - You can paginate the results using the MaxItems and Marker - parameters.' - operationId: GET_GetGroup - parameters: - - description: '

The name of the group.

This parameter allows (through - its regex pattern) a string - of characters consisting of upper and lowercase alphanumeric characters - with no spaces. You can also include any of the following characters: _+=,.@-

' - in: query - name: GroupName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: Use this parameter only when paginating results and only after - you receive a response indicating that the results are truncated. Set it - to the value of the Marker element in the response that you - received to indicate where the next call should start. - in: query - name: Marker - required: false - schema: - maxLength: 320 - minLength: 1 - pattern: '[\u0020-\u00FF]+' - type: string - - description:

Use this only when paginating results to indicate the maximum - number of items you want in the response. If additional items exist beyond - the maximum you specify, the IsTruncated response element is - true.

If you do not include this parameter, the number - of items defaults to 100. Note that IAM might return fewer results, even - when there are more results available. In that case, the IsTruncated - response element returns true, and Marker contains - a value to include in the subsequent call that tells the service where to - continue from.

- in: query - name: MaxItems - required: false - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - '200': - content: - text/xml: - schema: - properties: - GetGroupResult: - $ref: '#/components/schemas/GetGroupResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: GetGroup - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description: ' Returns a list of IAM users that are in the specified IAM group. - You can paginate the results using the MaxItems and Marker - parameters.' - operationId: POST_GetGroup - parameters: - - description: Pagination limit - in: query - name: MaxItems - required: false - schema: - type: string - - description: Pagination token - in: query - name: Marker - required: false - schema: - type: string - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetGroupRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - GetGroupResult: - $ref: '#/components/schemas/GetGroupResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: GetGroup - /?Action=GetGroupPolicy&Version=2010-05-08: - get: - description:

Retrieves the specified inline policy document that is embedded - in the specified IAM group.

Policies returned by this operation - are URL-encoded compliant with RFC - 3986. You can use a URL decoding method to convert the policy back to - plain JSON text. For example, if you use Java, you can use the decode - method of the java.net.URLDecoder utility class in the Java SDK. - Other languages and SDKs provide similar functionality.

An - IAM group can also have managed policies attached to it. To retrieve a managed - policy document that is attached to a group, use GetPolicy to determine - the policy's default version, then use GetPolicyVersion to retrieve - the policy document.

For more information about policies, see Managed - policies and inline policies in the IAM User Guide.

- operationId: GET_GetGroupPolicy - parameters: - - description: '

The name of the group the policy is associated with.

-

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: GroupName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: '

The name of the policy document to get.

This parameter - allows (through its regex pattern) - a string of characters consisting of upper and lowercase alphanumeric characters - with no spaces. You can also include any of the following characters: _+=,.@-

' - in: query - name: PolicyName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - responses: - '200': - content: - text/xml: - schema: - properties: - GetGroupPolicyResult: - $ref: '#/components/schemas/GetGroupPolicyResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: GetGroupPolicy - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Retrieves the specified inline policy document that is embedded - in the specified IAM group.

Policies returned by this operation - are URL-encoded compliant with RFC - 3986. You can use a URL decoding method to convert the policy back to - plain JSON text. For example, if you use Java, you can use the decode - method of the java.net.URLDecoder utility class in the Java SDK. - Other languages and SDKs provide similar functionality.

An - IAM group can also have managed policies attached to it. To retrieve a managed - policy document that is attached to a group, use GetPolicy to determine - the policy's default version, then use GetPolicyVersion to retrieve - the policy document.

For more information about policies, see Managed - policies and inline policies in the IAM User Guide.

- operationId: POST_GetGroupPolicy - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetGroupPolicyRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - GetGroupPolicyResult: - $ref: '#/components/schemas/GetGroupPolicyResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: GetGroupPolicy - /?Action=GetInstanceProfile&Version=2010-05-08: - get: - description: ' Retrieves information about the specified instance profile, including - the instance profile''s path, GUID, ARN, and role. For more information about - instance profiles, see About - instance profiles in the IAM User Guide.' - operationId: GET_GetInstanceProfile - parameters: - - description: '

The name of the instance profile to get information about.

-

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: InstanceProfileName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - responses: - '200': - content: - text/xml: - schema: - properties: - GetInstanceProfileResult: - $ref: '#/components/schemas/GetInstanceProfileResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: GetInstanceProfile - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description: ' Retrieves information about the specified instance profile, including - the instance profile''s path, GUID, ARN, and role. For more information about - instance profiles, see About - instance profiles in the IAM User Guide.' - operationId: POST_GetInstanceProfile - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetInstanceProfileRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - GetInstanceProfileResult: - $ref: '#/components/schemas/GetInstanceProfileResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: GetInstanceProfile - /?Action=GetLoginProfile&Version=2010-05-08: - get: - description:

Retrieves the user name for the specified IAM user. A login - profile is created when you create a password for the user to access the Amazon - Web Services Management Console. If the user does not exist or does not have - a password, the operation returns a 404 (NoSuchEntity) error.

-

If you create an IAM user with access to the console, the CreateDate - reflects the date you created the initial password for the user.

If - you create an IAM user with programmatic access, and then later add a password - for the user to access the Amazon Web Services Management Console, the CreateDate - reflects the initial password creation date. A user with programmatic access - does not have a login profile unless you create a password for the user to - access the Amazon Web Services Management Console.

- operationId: GET_GetLoginProfile - parameters: - - description: '

The name of the user whose login profile you want to retrieve.

-

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: UserName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - responses: - '200': - content: - text/xml: - schema: - properties: - GetLoginProfileResult: - $ref: '#/components/schemas/GetLoginProfileResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: GetLoginProfile - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Retrieves the user name for the specified IAM user. A login - profile is created when you create a password for the user to access the Amazon - Web Services Management Console. If the user does not exist or does not have - a password, the operation returns a 404 (NoSuchEntity) error.

-

If you create an IAM user with access to the console, the CreateDate - reflects the date you created the initial password for the user.

If - you create an IAM user with programmatic access, and then later add a password - for the user to access the Amazon Web Services Management Console, the CreateDate - reflects the initial password creation date. A user with programmatic access - does not have a login profile unless you create a password for the user to - access the Amazon Web Services Management Console.

- operationId: POST_GetLoginProfile - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetLoginProfileRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - GetLoginProfileResult: - $ref: '#/components/schemas/GetLoginProfileResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: GetLoginProfile - /?Action=GetOpenIDConnectProvider&Version=2010-05-08: - get: - description: Returns information about the specified OpenID Connect (OIDC) provider - resource object in IAM. - operationId: GET_GetOpenIDConnectProvider - parameters: - - description:

The Amazon Resource Name (ARN) of the OIDC provider resource - object in IAM to get information for. You can get a list of OIDC provider - resource ARNs by using the ListOpenIDConnectProviders operation.

-

For more information about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.

- in: query - name: OpenIDConnectProviderArn - required: true - schema: - description:

The Amazon Resource Name (ARN). ARNs are unique identifiers - for Amazon Web Services resources.

For more information about ARNs, - go to Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference. -

- maxLength: 2048 - minLength: 20 - type: string - responses: - '200': - content: - text/xml: - schema: - properties: - GetOpenIDConnectProviderResult: - $ref: '#/components/schemas/GetOpenIDConnectProviderResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: GetOpenIDConnectProvider - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description: Returns information about the specified OpenID Connect (OIDC) provider - resource object in IAM. - operationId: POST_GetOpenIDConnectProvider - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetOpenIDConnectProviderRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - GetOpenIDConnectProviderResult: - $ref: '#/components/schemas/GetOpenIDConnectProviderResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: GetOpenIDConnectProvider - /?Action=GetOrganizationsAccessReport&Version=2010-05-08: - get: - description:

Retrieves the service last accessed data report for Organizations - that was previously generated using the GenerateOrganizationsAccessReport - operation. This operation retrieves the status of your report job - and the report contents.

Depending on the parameters that you passed - when you generated the report, the data returned could include different information. - For details, see GenerateOrganizationsAccessReport.

To call - this operation, you must be signed in to the management account in your organization. - SCPs must be enabled for your organization root. You must have permissions - to perform this operation. For more information, see Refining - permissions using service last accessed data in the IAM User Guide.

-

For each service that principals in an account (root users, IAM users, - or IAM roles) could access using SCPs, the operation returns details about - the most recent access attempt. If there was no attempt, the service is listed - without details about the most recent attempt to access the service. If the - operation fails, it returns the reason that it failed.

By default, - the list is sorted by service namespace.

- operationId: GET_GetOrganizationsAccessReport - parameters: - - description: The identifier of the request generated by the GenerateOrganizationsAccessReport - operation. - in: query - name: JobId - required: true - schema: - maxLength: 36 - minLength: 36 - type: string - - description:

Use this only when paginating results to indicate the maximum - number of items you want in the response. If additional items exist beyond - the maximum you specify, the IsTruncated response element is - true.

If you do not include this parameter, the number - of items defaults to 100. Note that IAM might return fewer results, even - when there are more results available. In that case, the IsTruncated - response element returns true, and Marker contains - a value to include in the subsequent call that tells the service where to - continue from.

- in: query - name: MaxItems - required: false - schema: - maximum: 1000 - minimum: 1 - type: integer - - description: Use this parameter only when paginating results and only after - you receive a response indicating that the results are truncated. Set it - to the value of the Marker element in the response that you - received to indicate where the next call should start. - in: query - name: Marker - required: false - schema: - maxLength: 320 - minLength: 1 - pattern: '[\u0020-\u00FF]+' - type: string - - description: The key that is used to sort the results. If you choose the namespace - key, the results are returned in alphabetical order. If you choose the time - key, the results are sorted numerically by the date and time. - in: query - name: SortKey - required: false - schema: - enum: - - SERVICE_NAMESPACE_ASCENDING - - SERVICE_NAMESPACE_DESCENDING - - LAST_AUTHENTICATED_TIME_ASCENDING - - LAST_AUTHENTICATED_TIME_DESCENDING - type: string - responses: - '200': - content: - text/xml: - schema: - properties: - GetOrganizationsAccessReportResult: - $ref: '#/components/schemas/GetOrganizationsAccessReportResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - x-aws-operation-name: GetOrganizationsAccessReport - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Retrieves the service last accessed data report for Organizations - that was previously generated using the GenerateOrganizationsAccessReport - operation. This operation retrieves the status of your report job - and the report contents.

Depending on the parameters that you passed - when you generated the report, the data returned could include different information. - For details, see GenerateOrganizationsAccessReport.

To call - this operation, you must be signed in to the management account in your organization. - SCPs must be enabled for your organization root. You must have permissions - to perform this operation. For more information, see Refining - permissions using service last accessed data in the IAM User Guide.

-

For each service that principals in an account (root users, IAM users, - or IAM roles) could access using SCPs, the operation returns details about - the most recent access attempt. If there was no attempt, the service is listed - without details about the most recent attempt to access the service. If the - operation fails, it returns the reason that it failed.

By default, - the list is sorted by service namespace.

- operationId: POST_GetOrganizationsAccessReport - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetOrganizationsAccessReportRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - GetOrganizationsAccessReportResult: - $ref: '#/components/schemas/GetOrganizationsAccessReportResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - x-aws-operation-name: GetOrganizationsAccessReport - /?Action=GetPolicy&Version=2010-05-08: - get: - description:

Retrieves information about the specified managed policy, including - the policy's default version and the total number of IAM users, groups, and - roles to which the policy is attached. To retrieve the list of the specific - users, groups, and roles that the policy is attached to, use ListEntitiesForPolicy. - This operation returns metadata about the policy. To retrieve the actual policy - document for a specific version of the policy, use GetPolicyVersion.

-

This operation retrieves information about managed policies. To retrieve - information about an inline policy that is embedded with an IAM user, group, - or role, use GetUserPolicy, GetGroupPolicy, or GetRolePolicy.

-

For more information about policies, see Managed - policies and inline policies in the IAM User Guide.

- operationId: GET_GetPolicy - parameters: - - description:

The Amazon Resource Name (ARN) of the managed policy that - you want information about.

For more information about ARNs, see - Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.

- in: query - name: PolicyArn - required: true - schema: - description:

The Amazon Resource Name (ARN). ARNs are unique identifiers - for Amazon Web Services resources.

For more information about ARNs, - go to Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference. -

- maxLength: 2048 - minLength: 20 - type: string - responses: - '200': - content: - text/xml: - schema: - properties: - GetPolicyResult: - $ref: '#/components/schemas/GetPolicyResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: GetPolicy - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Retrieves information about the specified managed policy, including - the policy's default version and the total number of IAM users, groups, and - roles to which the policy is attached. To retrieve the list of the specific - users, groups, and roles that the policy is attached to, use ListEntitiesForPolicy. - This operation returns metadata about the policy. To retrieve the actual policy - document for a specific version of the policy, use GetPolicyVersion.

-

This operation retrieves information about managed policies. To retrieve - information about an inline policy that is embedded with an IAM user, group, - or role, use GetUserPolicy, GetGroupPolicy, or GetRolePolicy.

-

For more information about policies, see Managed - policies and inline policies in the IAM User Guide.

- operationId: POST_GetPolicy - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetPolicyRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - GetPolicyResult: - $ref: '#/components/schemas/GetPolicyResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: GetPolicy - /?Action=GetPolicyVersion&Version=2010-05-08: - get: - description:

Retrieves information about the specified version of the specified - managed policy, including the policy document.

Policies returned - by this operation are URL-encoded compliant with RFC - 3986. You can use a URL decoding method to convert the policy back to - plain JSON text. For example, if you use Java, you can use the decode - method of the java.net.URLDecoder utility class in the Java SDK. - Other languages and SDKs provide similar functionality.

To - list the available versions for a policy, use ListPolicyVersions.

-

This operation retrieves information about managed policies. To retrieve - information about an inline policy that is embedded in a user, group, or role, - use GetUserPolicy, GetGroupPolicy, or GetRolePolicy.

-

For more information about the types of policies, see Managed - policies and inline policies in the IAM User Guide.

For - more information about managed policy versions, see Versioning - for managed policies in the IAM User Guide.

- operationId: GET_GetPolicyVersion - parameters: - - description:

The Amazon Resource Name (ARN) of the managed policy that - you want information about.

For more information about ARNs, see - Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.

- in: query - name: PolicyArn - required: true - schema: - description:

The Amazon Resource Name (ARN). ARNs are unique identifiers - for Amazon Web Services resources.

For more information about ARNs, - go to Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference. -

- maxLength: 2048 - minLength: 20 - type: string - - description:

Identifies the policy version to retrieve.

This parameter - allows (through its regex pattern) - a string of characters that consists of the lowercase letter 'v' followed - by one or two digits, and optionally followed by a period '.' and a string - of letters and digits.

- in: query - name: VersionId - required: true - schema: - pattern: v[1-9][0-9]*(\.[A-Za-z0-9-]*)? - type: string - responses: - '200': - content: - text/xml: - schema: - properties: - GetPolicyVersionResult: - $ref: '#/components/schemas/GetPolicyVersionResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: GetPolicyVersion - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Retrieves information about the specified version of the specified - managed policy, including the policy document.

Policies returned - by this operation are URL-encoded compliant with RFC - 3986. You can use a URL decoding method to convert the policy back to - plain JSON text. For example, if you use Java, you can use the decode - method of the java.net.URLDecoder utility class in the Java SDK. - Other languages and SDKs provide similar functionality.

To - list the available versions for a policy, use ListPolicyVersions.

-

This operation retrieves information about managed policies. To retrieve - information about an inline policy that is embedded in a user, group, or role, - use GetUserPolicy, GetGroupPolicy, or GetRolePolicy.

-

For more information about the types of policies, see Managed - policies and inline policies in the IAM User Guide.

For - more information about managed policy versions, see Versioning - for managed policies in the IAM User Guide.

- operationId: POST_GetPolicyVersion - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetPolicyVersionRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - GetPolicyVersionResult: - $ref: '#/components/schemas/GetPolicyVersionResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: GetPolicyVersion - /?Action=GetRole&Version=2010-05-08: - get: - description:

Retrieves information about the specified role, including the - role's path, GUID, ARN, and the role's trust policy that grants permission - to assume the role. For more information about roles, see Working - with roles.

Policies returned by this operation are URL-encoded - compliant with RFC 3986. - You can use a URL decoding method to convert the policy back to plain JSON - text. For example, if you use Java, you can use the decode method - of the java.net.URLDecoder utility class in the Java SDK. Other - languages and SDKs provide similar functionality.

 - operationId: GET_GetRole - parameters: - - description: '

The name of the IAM role to get information about.

This - parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: RoleName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - responses: - '200': - content: - text/xml: - schema: - properties: - GetRoleResult: - $ref: '#/components/schemas/GetRoleResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: GetRole - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Retrieves information about the specified role, including the - role's path, GUID, ARN, and the role's trust policy that grants permission - to assume the role. For more information about roles, see Working - with roles.

Policies returned by this operation are URL-encoded - compliant with RFC 3986. - You can use a URL decoding method to convert the policy back to plain JSON - text. For example, if you use Java, you can use the decode method - of the java.net.URLDecoder utility class in the Java SDK. Other - languages and SDKs provide similar functionality.

 - operationId: POST_GetRole - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetRoleRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - GetRoleResult: - $ref: '#/components/schemas/GetRoleResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: GetRole - /?Action=GetRolePolicy&Version=2010-05-08: - get: - description:

Retrieves the specified inline policy document that is embedded - with the specified IAM role.

Policies returned by this operation - are URL-encoded compliant with RFC - 3986. You can use a URL decoding method to convert the policy back to - plain JSON text. For example, if you use Java, you can use the decode - method of the java.net.URLDecoder utility class in the Java SDK. - Other languages and SDKs provide similar functionality.

An - IAM role can also have managed policies attached to it. To retrieve a managed - policy document that is attached to a role, use GetPolicy to determine - the policy's default version, then use GetPolicyVersion to retrieve - the policy document.

For more information about policies, see Managed - policies and inline policies in the IAM User Guide.

For - more information about roles, see Using - roles to delegate permissions and federate identities.

- operationId: GET_GetRolePolicy - parameters: - - description: '

The name of the role associated with the policy.

This - parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: RoleName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: '

The name of the policy document to get.

This parameter - allows (through its regex pattern) - a string of characters consisting of upper and lowercase alphanumeric characters - with no spaces. You can also include any of the following characters: _+=,.@-

' - in: query - name: PolicyName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - responses: - '200': - content: - text/xml: - schema: - properties: - GetRolePolicyResult: - $ref: '#/components/schemas/GetRolePolicyResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: GetRolePolicy - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Retrieves the specified inline policy document that is embedded - with the specified IAM role.

Policies returned by this operation - are URL-encoded compliant with RFC - 3986. You can use a URL decoding method to convert the policy back to - plain JSON text. For example, if you use Java, you can use the decode - method of the java.net.URLDecoder utility class in the Java SDK. - Other languages and SDKs provide similar functionality.

An - IAM role can also have managed policies attached to it. To retrieve a managed - policy document that is attached to a role, use GetPolicy to determine - the policy's default version, then use GetPolicyVersion to retrieve - the policy document.

For more information about policies, see Managed - policies and inline policies in the IAM User Guide.

For - more information about roles, see Using - roles to delegate permissions and federate identities.

- operationId: POST_GetRolePolicy - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetRolePolicyRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - GetRolePolicyResult: - $ref: '#/components/schemas/GetRolePolicyResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: GetRolePolicy - /?Action=GetSAMLProvider&Version=2010-05-08: - get: - description:

Returns the SAML provider metadocument that was uploaded when - the IAM SAML provider resource object was created or updated.

This - operation requires Signature - Version 4.

 - operationId: GET_GetSAMLProvider - parameters: - - description:

The Amazon Resource Name (ARN) of the SAML provider resource - object in IAM to get information about.

For more information about - ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.

- in: query - name: SAMLProviderArn - required: true - schema: - description:

The Amazon Resource Name (ARN). ARNs are unique identifiers - for Amazon Web Services resources.

For more information about ARNs, - go to Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference. -

- maxLength: 2048 - minLength: 20 - type: string - responses: - '200': - content: - text/xml: - schema: - properties: - GetSAMLProviderResult: - $ref: '#/components/schemas/GetSAMLProviderResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: GetSAMLProvider - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Returns the SAML provider metadocument that was uploaded when - the IAM SAML provider resource object was created or updated.

This - operation requires Signature - Version 4.

 - operationId: POST_GetSAMLProvider - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetSAMLProviderRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - GetSAMLProviderResult: - $ref: '#/components/schemas/GetSAMLProviderResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: GetSAMLProvider - /?Action=GetSSHPublicKey&Version=2010-05-08: - get: - description:

Retrieves the specified SSH public key, including metadata about - the key.

The SSH public key retrieved by this operation is used only - for authenticating the associated IAM user to an CodeCommit repository. For - more information about using SSH keys to authenticate to an CodeCommit repository, - see Set - up CodeCommit for SSH connections in the CodeCommit User Guide.

- operationId: GET_GetSSHPublicKey - parameters: - - description: '

The name of the IAM user associated with the SSH public key.

-

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: UserName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description:

The unique identifier for the SSH public key.

This - parameter allows (through its regex - pattern) a string of characters that can consist of any upper or lowercased - letter or digit.

- in: query - name: SSHPublicKeyId - required: true - schema: - maxLength: 128 - minLength: 20 - pattern: '[\w]+' - type: string - - description: Specifies the public key encoding format to use in the response. - To retrieve the public key in ssh-rsa format, use SSH. To retrieve - the public key in PEM format, use PEM. - in: query - name: Encoding - required: true - schema: - enum: - - SSH - - PEM - type: string - responses: - '200': - content: - text/xml: - schema: - properties: - GetSSHPublicKeyResult: - $ref: '#/components/schemas/GetSSHPublicKeyResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/UnrecognizedPublicKeyEncodingException' - description: UnrecognizedPublicKeyEncodingException - x-aws-operation-name: GetSSHPublicKey - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Retrieves the specified SSH public key, including metadata about - the key.

The SSH public key retrieved by this operation is used only - for authenticating the associated IAM user to an CodeCommit repository. For - more information about using SSH keys to authenticate to an CodeCommit repository, - see Set - up CodeCommit for SSH connections in the CodeCommit User Guide.

- operationId: POST_GetSSHPublicKey - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetSSHPublicKeyRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - GetSSHPublicKeyResult: - $ref: '#/components/schemas/GetSSHPublicKeyResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/UnrecognizedPublicKeyEncodingException' - description: UnrecognizedPublicKeyEncodingException - x-aws-operation-name: GetSSHPublicKey - /?Action=GetServerCertificate&Version=2010-05-08: - get: - description:

Retrieves information about the specified server certificate - stored in IAM.

For more information about working with server certificates, - see Working - with server certificates in the IAM User Guide. This topic includes - a list of Amazon Web Services services that can use the server certificates - that you manage with IAM.

- operationId: GET_GetServerCertificate - parameters: - - description: '

The name of the server certificate you want to retrieve information - about.

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: ServerCertificateName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - responses: - '200': - content: - text/xml: - schema: - properties: - GetServerCertificateResult: - $ref: '#/components/schemas/GetServerCertificateResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: GetServerCertificate - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Retrieves information about the specified server certificate - stored in IAM.

For more information about working with server certificates, - see Working - with server certificates in the IAM User Guide. This topic includes - a list of Amazon Web Services services that can use the server certificates - that you manage with IAM.

- operationId: POST_GetServerCertificate - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetServerCertificateRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - GetServerCertificateResult: - $ref: '#/components/schemas/GetServerCertificateResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: GetServerCertificate - /?Action=GetServiceLastAccessedDetails&Version=2010-05-08: - get: - description: "

Retrieves a service last accessed report that was created using\ - \ the GenerateServiceLastAccessedDetails operation. You can use\ - \ the JobId parameter in GetServiceLastAccessedDetails\ - \ to retrieve the status of your report job. When the report is complete,\ - \ you can retrieve the generated report. The report includes a list of Amazon\ - \ Web Services services that the resource (user, group, role, or managed policy)\ - \ can access.

Service last accessed data does not use other\ - \ policy types when determining whether a resource could access a service.\ - \ These other policy types include resource-based policies, access control\ - \ lists, Organizations policies, IAM permissions boundaries, and STS assume\ - \ role policies. It only applies permissions policy logic. For more about\ - \ the evaluation of policy types, see Evaluating policies in the IAM User Guide.

For\ - \ each service that the resource could access using permissions policies,\ - \ the operation returns details about the most recent access attempt. If there\ - \ was no attempt, the service is listed without details about the most recent\ - \ attempt to access the service. If the operation fails, the GetServiceLastAccessedDetails\ - \ operation returns the reason that it failed.

The GetServiceLastAccessedDetails\ - \ operation returns a list of services. This list includes the number of entities\ - \ that have attempted to access the service and the date and time of the last\ - \ attempt. It also returns the ARN of the following entity, depending on the\ - \ resource ARN that you used to generate the report:

  • User\ - \ \u2013 Returns the user ARN that you used to generate the report

    • \ - \

  • Group \u2013 Returns the ARN of the group member (user)\ - \ that last attempted to access the service

  • Role\ - \ \u2013 Returns the role ARN that you used to generate the report

    • \ - \

  • Policy \u2013 Returns the ARN of the user or role that last\ - \ used the policy to attempt to access the service

By default,\ - \ the list is sorted by service namespace.

If you specified ACTION_LEVEL\ - \ granularity when you generated the report, this operation returns service\ - \ and action last accessed data. This includes the most recent access attempt\ - \ for each tracked action within a service. Otherwise, this operation returns\ - \ only service data.

For more information about service and action\ - \ last accessed data, see Reducing permissions using service last accessed data in the IAM User\ - \ Guide.

" - operationId: GET_GetServiceLastAccessedDetails - parameters: - - description: The ID of the request generated by the GenerateServiceLastAccessedDetails - operation. The JobId returned by GenerateServiceLastAccessedDetail - must be used by the same role within a session, or by the same user when - used to call GetServiceLastAccessedDetail. - in: query - name: JobId - required: true - schema: - maxLength: 36 - minLength: 36 - type: string - - description:

Use this only when paginating results to indicate the maximum - number of items you want in the response. If additional items exist beyond - the maximum you specify, the IsTruncated response element is - true.

If you do not include this parameter, the number - of items defaults to 100. Note that IAM might return fewer results, even - when there are more results available. In that case, the IsTruncated - response element returns true, and Marker contains - a value to include in the subsequent call that tells the service where to - continue from.

- in: query - name: MaxItems - required: false - schema: - maximum: 1000 - minimum: 1 - type: integer - - description: Use this parameter only when paginating results and only after - you receive a response indicating that the results are truncated. Set it - to the value of the Marker element in the response that you - received to indicate where the next call should start. - in: query - name: Marker - required: false - schema: - maxLength: 320 - minLength: 1 - pattern: '[\u0020-\u00FF]+' - type: string - responses: - '200': - content: - text/xml: - schema: - properties: - GetServiceLastAccessedDetailsResult: - $ref: '#/components/schemas/GetServiceLastAccessedDetailsResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - x-aws-operation-name: GetServiceLastAccessedDetails - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description: "

Retrieves a service last accessed report that was created using\ - \ the GenerateServiceLastAccessedDetails operation. You can use\ - \ the JobId parameter in GetServiceLastAccessedDetails\ - \ to retrieve the status of your report job. When the report is complete,\ - \ you can retrieve the generated report. The report includes a list of Amazon\ - \ Web Services services that the resource (user, group, role, or managed policy)\ - \ can access.

Service last accessed data does not use other\ - \ policy types when determining whether a resource could access a service.\ - \ These other policy types include resource-based policies, access control\ - \ lists, Organizations policies, IAM permissions boundaries, and STS assume\ - \ role policies. It only applies permissions policy logic. For more about\ - \ the evaluation of policy types, see Evaluating policies in the IAM User Guide.

For\ - \ each service that the resource could access using permissions policies,\ - \ the operation returns details about the most recent access attempt. If there\ - \ was no attempt, the service is listed without details about the most recent\ - \ attempt to access the service. If the operation fails, the GetServiceLastAccessedDetails\ - \ operation returns the reason that it failed.

The GetServiceLastAccessedDetails\ - \ operation returns a list of services. This list includes the number of entities\ - \ that have attempted to access the service and the date and time of the last\ - \ attempt. It also returns the ARN of the following entity, depending on the\ - \ resource ARN that you used to generate the report:

  • User\ - \ \u2013 Returns the user ARN that you used to generate the report

    • \ - \

  • Group \u2013 Returns the ARN of the group member (user)\ - \ that last attempted to access the service

  • Role\ - \ \u2013 Returns the role ARN that you used to generate the report

    • \ - \

  • Policy \u2013 Returns the ARN of the user or role that last\ - \ used the policy to attempt to access the service

By default,\ - \ the list is sorted by service namespace.

If you specified ACTION_LEVEL\ - \ granularity when you generated the report, this operation returns service\ - \ and action last accessed data. This includes the most recent access attempt\ - \ for each tracked action within a service. Otherwise, this operation returns\ - \ only service data.

For more information about service and action\ - \ last accessed data, see Reducing permissions using service last accessed data in the IAM User\ - \ Guide.

" - operationId: POST_GetServiceLastAccessedDetails - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetServiceLastAccessedDetailsRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - GetServiceLastAccessedDetailsResult: - $ref: '#/components/schemas/GetServiceLastAccessedDetailsResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - x-aws-operation-name: GetServiceLastAccessedDetails - /?Action=GetServiceLastAccessedDetailsWithEntities&Version=2010-05-08: - get: - description: "

After you generate a group or policy report using the GenerateServiceLastAccessedDetails\ - \ operation, you can use the JobId parameter in GetServiceLastAccessedDetailsWithEntities.\ - \ This operation retrieves the status of your report job and a list of entities\ - \ that could have used group or policy permissions to access the specified\ - \ service.

  • Group \u2013 For a group report, this\ - \ operation returns a list of users in the group that could have used the\ - \ group\u2019s policies in an attempt to access the service.

  • \ - \

    Policy \u2013 For a policy report, this operation returns a list\ - \ of entities (users or roles) that could have used the policy in an attempt\ - \ to access the service.

You can also use this operation\ - \ for user or role reports to retrieve details about those entities.

If\ - \ the operation fails, the GetServiceLastAccessedDetailsWithEntities\ - \ operation returns the reason that it failed.

By default, the list\ - \ of associated entities is sorted by date, with the most recent access listed\ - \ first.

" - operationId: GET_GetServiceLastAccessedDetailsWithEntities - parameters: - - description: The ID of the request generated by the GenerateServiceLastAccessedDetails - operation. - in: query - name: JobId - required: true - schema: - maxLength: 36 - minLength: 36 - type: string - - description: "

The service namespace for an Amazon Web Services service.\ - \ Provide the service namespace to learn when the IAM entity last attempted\ - \ to access the specified service.

To learn the service namespace\ - \ for a service, see Actions, resources, and condition keys for Amazon Web Services services\ - \ in the IAM User Guide. Choose the name of the service to view details\ - \ for that service. In the first paragraph, find the service prefix. For\ - \ example, (service prefix: a4b). For more information about\ - \ service namespaces, see Amazon Web Services service namespaces in the\_Amazon Web Services\ - \ General Reference.

" - in: query - name: ServiceNamespace - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w-]*' - type: string - - description:

Use this only when paginating results to indicate the maximum - number of items you want in the response. If additional items exist beyond - the maximum you specify, the IsTruncated response element is - true.

If you do not include this parameter, the number - of items defaults to 100. Note that IAM might return fewer results, even - when there are more results available. In that case, the IsTruncated - response element returns true, and Marker contains - a value to include in the subsequent call that tells the service where to - continue from.

- in: query - name: MaxItems - required: false - schema: - maximum: 1000 - minimum: 1 - type: integer - - description: Use this parameter only when paginating results and only after - you receive a response indicating that the results are truncated. Set it - to the value of the Marker element in the response that you - received to indicate where the next call should start. - in: query - name: Marker - required: false - schema: - maxLength: 320 - minLength: 1 - pattern: '[\u0020-\u00FF]+' - type: string - responses: - '200': - content: - text/xml: - schema: - properties: - GetServiceLastAccessedDetailsWithEntitiesResult: - $ref: '#/components/schemas/GetServiceLastAccessedDetailsWithEntitiesResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - x-aws-operation-name: GetServiceLastAccessedDetailsWithEntities - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description: "

After you generate a group or policy report using the GenerateServiceLastAccessedDetails\ - \ operation, you can use the JobId parameter in GetServiceLastAccessedDetailsWithEntities.\ - \ This operation retrieves the status of your report job and a list of entities\ - \ that could have used group or policy permissions to access the specified\ - \ service.

  • Group \u2013 For a group report, this\ - \ operation returns a list of users in the group that could have used the\ - \ group\u2019s policies in an attempt to access the service.

  • \ - \

    Policy \u2013 For a policy report, this operation returns a list\ - \ of entities (users or roles) that could have used the policy in an attempt\ - \ to access the service.

You can also use this operation\ - \ for user or role reports to retrieve details about those entities.

If\ - \ the operation fails, the GetServiceLastAccessedDetailsWithEntities\ - \ operation returns the reason that it failed.

By default, the list\ - \ of associated entities is sorted by date, with the most recent access listed\ - \ first.

" - operationId: POST_GetServiceLastAccessedDetailsWithEntities - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetServiceLastAccessedDetailsWithEntitiesRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - GetServiceLastAccessedDetailsWithEntitiesResult: - $ref: '#/components/schemas/GetServiceLastAccessedDetailsWithEntitiesResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - x-aws-operation-name: GetServiceLastAccessedDetailsWithEntities - /?Action=GetServiceLinkedRoleDeletionStatus&Version=2010-05-08: - get: - description: Retrieves the status of your service-linked role deletion. After - you use DeleteServiceLinkedRole to submit a service-linked role for - deletion, you can use the DeletionTaskId parameter in GetServiceLinkedRoleDeletionStatus - to check the status of the deletion. If the deletion fails, this operation - returns the reason that it failed, if that information is returned by the - service. - operationId: GET_GetServiceLinkedRoleDeletionStatus - parameters: - - description: The deletion task identifier. This identifier is returned by - the DeleteServiceLinkedRole operation in the format task/aws-service-role/<service-principal-name>/<role-name>/<task-uuid>. - in: query - name: DeletionTaskId - required: true - schema: - maxLength: 1000 - minLength: 1 - type: string - responses: - '200': - content: - text/xml: - schema: - properties: - GetServiceLinkedRoleDeletionStatusResult: - $ref: '#/components/schemas/GetServiceLinkedRoleDeletionStatusResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: GetServiceLinkedRoleDeletionStatus - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description: Retrieves the status of your service-linked role deletion. After - you use DeleteServiceLinkedRole to submit a service-linked role for - deletion, you can use the DeletionTaskId parameter in GetServiceLinkedRoleDeletionStatus - to check the status of the deletion. If the deletion fails, this operation - returns the reason that it failed, if that information is returned by the - service. - operationId: POST_GetServiceLinkedRoleDeletionStatus - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetServiceLinkedRoleDeletionStatusRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - GetServiceLinkedRoleDeletionStatusResult: - $ref: '#/components/schemas/GetServiceLinkedRoleDeletionStatusResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: GetServiceLinkedRoleDeletionStatus - /?Action=GetUser&Version=2010-05-08: - get: - description:

Retrieves information about the specified IAM user, including - the user's creation date, path, unique ID, and ARN.

If you do not specify - a user name, IAM determines the user name implicitly based on the Amazon Web - Services access key ID used to sign the request to this operation.

- operationId: GET_GetUser - parameters: - - description: '

The name of the user to get information about.

This - parameter is optional. If it is not included, it defaults to the user making - the request. This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: UserName - required: false - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - responses: - '200': - content: - text/xml: - schema: - properties: - GetUserResult: - $ref: '#/components/schemas/GetUserResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: GetUser - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Retrieves information about the specified IAM user, including - the user's creation date, path, unique ID, and ARN.

If you do not specify - a user name, IAM determines the user name implicitly based on the Amazon Web - Services access key ID used to sign the request to this operation.

- operationId: POST_GetUser - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetUserRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - GetUserResult: - $ref: '#/components/schemas/GetUserResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: GetUser - /?Action=GetUserPolicy&Version=2010-05-08: - get: - description:

Retrieves the specified inline policy document that is embedded - in the specified IAM user.

Policies returned by this operation - are URL-encoded compliant with RFC - 3986. You can use a URL decoding method to convert the policy back to - plain JSON text. For example, if you use Java, you can use the decode - method of the java.net.URLDecoder utility class in the Java SDK. - Other languages and SDKs provide similar functionality.

An - IAM user can also have managed policies attached to it. To retrieve a managed - policy document that is attached to a user, use GetPolicy to determine - the policy's default version. Then use GetPolicyVersion to retrieve - the policy document.

For more information about policies, see Managed - policies and inline policies in the IAM User Guide.

- operationId: GET_GetUserPolicy - parameters: - - description: '

The name of the user who the policy is associated with.

-

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: UserName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: '

The name of the policy document to get.

This parameter - allows (through its regex pattern) - a string of characters consisting of upper and lowercase alphanumeric characters - with no spaces. You can also include any of the following characters: _+=,.@-

' - in: query - name: PolicyName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - responses: - '200': - content: - text/xml: - schema: - properties: - GetUserPolicyResult: - $ref: '#/components/schemas/GetUserPolicyResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: GetUserPolicy - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Retrieves the specified inline policy document that is embedded - in the specified IAM user.

Policies returned by this operation - are URL-encoded compliant with RFC - 3986. You can use a URL decoding method to convert the policy back to - plain JSON text. For example, if you use Java, you can use the decode - method of the java.net.URLDecoder utility class in the Java SDK. - Other languages and SDKs provide similar functionality.

An - IAM user can also have managed policies attached to it. To retrieve a managed - policy document that is attached to a user, use GetPolicy to determine - the policy's default version. Then use GetPolicyVersion to retrieve - the policy document.

For more information about policies, see Managed - policies and inline policies in the IAM User Guide.

- operationId: POST_GetUserPolicy - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetUserPolicyRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - GetUserPolicyResult: - $ref: '#/components/schemas/GetUserPolicyResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: GetUserPolicy - /?Action=ListAccessKeys&Version=2010-05-08: - get: - description:

Returns information about the access key IDs associated with - the specified IAM user. If there is none, the operation returns an empty list.

-

Although each user is limited to a small number of keys, you can still - paginate the results using the MaxItems and Marker - parameters.

If the UserName field is not specified, the - user name is determined implicitly based on the Amazon Web Services access - key ID used to sign the request. This operation works for access keys under - the Amazon Web Services account. Consequently, you can use this operation - to manage Amazon Web Services account root user credentials even if the Amazon - Web Services account has no associated users.

To ensure the - security of your Amazon Web Services account, the secret access key is accessible - only during key and user creation.

 - operationId: GET_ListAccessKeys - parameters: - - description: '

The name of the user.

This parameter allows (through - its regex pattern) a string - of characters consisting of upper and lowercase alphanumeric characters - with no spaces. You can also include any of the following characters: _+=,.@-

' - in: query - name: UserName - required: false - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: Use this parameter only when paginating results and only after - you receive a response indicating that the results are truncated. Set it - to the value of the Marker element in the response that you - received to indicate where the next call should start. - in: query - name: Marker - required: false - schema: - maxLength: 320 - minLength: 1 - pattern: '[\u0020-\u00FF]+' - type: string - - description:

Use this only when paginating results to indicate the maximum - number of items you want in the response. If additional items exist beyond - the maximum you specify, the IsTruncated response element is - true.

If you do not include this parameter, the number - of items defaults to 100. Note that IAM might return fewer results, even - when there are more results available. In that case, the IsTruncated - response element returns true, and Marker contains - a value to include in the subsequent call that tells the service where to - continue from.

- in: query - name: MaxItems - required: false - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - '200': - content: - text/xml: - schema: - properties: - ListAccessKeysResult: - $ref: '#/components/schemas/ListAccessKeysResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: ListAccessKeys - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Returns information about the access key IDs associated with - the specified IAM user. If there is none, the operation returns an empty list.

-

Although each user is limited to a small number of keys, you can still - paginate the results using the MaxItems and Marker - parameters.

If the UserName field is not specified, the - user name is determined implicitly based on the Amazon Web Services access - key ID used to sign the request. This operation works for access keys under - the Amazon Web Services account. Consequently, you can use this operation - to manage Amazon Web Services account root user credentials even if the Amazon - Web Services account has no associated users.

To ensure the - security of your Amazon Web Services account, the secret access key is accessible - only during key and user creation.

 - operationId: POST_ListAccessKeys - parameters: - - description: Pagination limit - in: query - name: MaxItems - required: false - schema: - type: string - - description: Pagination token - in: query - name: Marker - required: false - schema: - type: string - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ListAccessKeysRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - ListAccessKeysResult: - $ref: '#/components/schemas/ListAccessKeysResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: ListAccessKeys - /?Action=ListAccountAliases&Version=2010-05-08: - get: - description: 'Lists the account alias associated with the Amazon Web Services - account (Note: you can have only one). For information about using an Amazon - Web Services account alias, see Using - an alias for your Amazon Web Services account ID in the IAM User Guide.' - operationId: GET_ListAccountAliases - parameters: - - description: Use this parameter only when paginating results and only after - you receive a response indicating that the results are truncated. Set it - to the value of the Marker element in the response that you - received to indicate where the next call should start. - in: query - name: Marker - required: false - schema: - maxLength: 320 - minLength: 1 - pattern: '[\u0020-\u00FF]+' - type: string - - description:

Use this only when paginating results to indicate the maximum - number of items you want in the response. If additional items exist beyond - the maximum you specify, the IsTruncated response element is - true.

If you do not include this parameter, the number - of items defaults to 100. Note that IAM might return fewer results, even - when there are more results available. In that case, the IsTruncated - response element returns true, and Marker contains - a value to include in the subsequent call that tells the service where to - continue from.

- in: query - name: MaxItems - required: false - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - '200': - content: - text/xml: - schema: - properties: - ListAccountAliasesResult: - $ref: '#/components/schemas/ListAccountAliasesResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: ListAccountAliases - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description: 'Lists the account alias associated with the Amazon Web Services - account (Note: you can have only one). For information about using an Amazon - Web Services account alias, see Using - an alias for your Amazon Web Services account ID in the IAM User Guide.' - operationId: POST_ListAccountAliases - parameters: - - description: Pagination limit - in: query - name: MaxItems - required: false - schema: - type: string - - description: Pagination token - in: query - name: Marker - required: false - schema: - type: string - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ListAccountAliasesRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - ListAccountAliasesResult: - $ref: '#/components/schemas/ListAccountAliasesResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: ListAccountAliases - /?Action=ListAttachedGroupPolicies&Version=2010-05-08: - get: - description:

Lists all managed policies that are attached to the specified - IAM group.

An IAM group can also have inline policies embedded with - it. To list the inline policies for a group, use ListGroupPolicies. - For information about policies, see Managed - policies and inline policies in the IAM User Guide.

You - can paginate the results using the MaxItems and Marker - parameters. You can use the PathPrefix parameter to limit the - list of policies to only those matching the specified path prefix. If there - are no policies attached to the specified group (or none that match the specified - path prefix), the operation returns an empty list.

- operationId: GET_ListAttachedGroupPolicies - parameters: - - description: '

The name (friendly name, not ARN) of the group to list attached - policies for.

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: GroupName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description:

The path prefix for filtering the results. This parameter - is optional. If it is not included, it defaults to a slash (/), listing - all policies.

This parameter allows (through its regex - pattern) a string of characters consisting of either a forward slash - (/) by itself or a string that must begin and end with forward slashes. - In addition, it can contain any ASCII character from the ! (\u0021) - through the DEL character (\u007F), including most punctuation - characters, digits, and upper and lowercased letters.

- in: query - name: PathPrefix - required: false - schema: - maxLength: 512 - minLength: 1 - pattern: ((/[A-Za-z0-9\.,\+@=_-]+)*)/ - type: string - - description: Use this parameter only when paginating results and only after - you receive a response indicating that the results are truncated. Set it - to the value of the Marker element in the response that you - received to indicate where the next call should start. - in: query - name: Marker - required: false - schema: - maxLength: 320 - minLength: 1 - pattern: '[\u0020-\u00FF]+' - type: string - - description:

Use this only when paginating results to indicate the maximum - number of items you want in the response. If additional items exist beyond - the maximum you specify, the IsTruncated response element is - true.

If you do not include this parameter, the number - of items defaults to 100. Note that IAM might return fewer results, even - when there are more results available. In that case, the IsTruncated - response element returns true, and Marker contains - a value to include in the subsequent call that tells the service where to - continue from.

- in: query - name: MaxItems - required: false - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - '200': - content: - text/xml: - schema: - properties: - ListAttachedGroupPoliciesResult: - $ref: '#/components/schemas/ListAttachedGroupPoliciesResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: ListAttachedGroupPolicies - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Lists all managed policies that are attached to the specified - IAM group.

An IAM group can also have inline policies embedded with - it. To list the inline policies for a group, use ListGroupPolicies. - For information about policies, see Managed - policies and inline policies in the IAM User Guide.

You - can paginate the results using the MaxItems and Marker - parameters. You can use the PathPrefix parameter to limit the - list of policies to only those matching the specified path prefix. If there - are no policies attached to the specified group (or none that match the specified - path prefix), the operation returns an empty list.

- operationId: POST_ListAttachedGroupPolicies - parameters: - - description: Pagination limit - in: query - name: MaxItems - required: false - schema: - type: string - - description: Pagination token - in: query - name: Marker - required: false - schema: - type: string - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ListAttachedGroupPoliciesRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - ListAttachedGroupPoliciesResult: - $ref: '#/components/schemas/ListAttachedGroupPoliciesResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: ListAttachedGroupPolicies - /?Action=ListAttachedRolePolicies&Version=2010-05-08: - get: - description:

Lists all managed policies that are attached to the specified - IAM role.

An IAM role can also have inline policies embedded with it. - To list the inline policies for a role, use ListRolePolicies. For information - about policies, see Managed - policies and inline policies in the IAM User Guide.

You - can paginate the results using the MaxItems and Marker - parameters. You can use the PathPrefix parameter to limit the - list of policies to only those matching the specified path prefix. If there - are no policies attached to the specified role (or none that match the specified - path prefix), the operation returns an empty list.

- operationId: GET_ListAttachedRolePolicies - parameters: - - description: '

The name (friendly name, not ARN) of the role to list attached - policies for.

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: RoleName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description:

The path prefix for filtering the results. This parameter - is optional. If it is not included, it defaults to a slash (/), listing - all policies.

This parameter allows (through its regex - pattern) a string of characters consisting of either a forward slash - (/) by itself or a string that must begin and end with forward slashes. - In addition, it can contain any ASCII character from the ! (\u0021) - through the DEL character (\u007F), including most punctuation - characters, digits, and upper and lowercased letters.

- in: query - name: PathPrefix - required: false - schema: - maxLength: 512 - minLength: 1 - pattern: ((/[A-Za-z0-9\.,\+@=_-]+)*)/ - type: string - - description: Use this parameter only when paginating results and only after - you receive a response indicating that the results are truncated. Set it - to the value of the Marker element in the response that you - received to indicate where the next call should start. - in: query - name: Marker - required: false - schema: - maxLength: 320 - minLength: 1 - pattern: '[\u0020-\u00FF]+' - type: string - - description:

Use this only when paginating results to indicate the maximum - number of items you want in the response. If additional items exist beyond - the maximum you specify, the IsTruncated response element is - true.

If you do not include this parameter, the number - of items defaults to 100. Note that IAM might return fewer results, even - when there are more results available. In that case, the IsTruncated - response element returns true, and Marker contains - a value to include in the subsequent call that tells the service where to - continue from.

- in: query - name: MaxItems - required: false - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - '200': - content: - text/xml: - schema: - properties: - ListAttachedRolePoliciesResult: - $ref: '#/components/schemas/ListAttachedRolePoliciesResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: ListAttachedRolePolicies - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Lists all managed policies that are attached to the specified - IAM role.

An IAM role can also have inline policies embedded with it. - To list the inline policies for a role, use ListRolePolicies. For information - about policies, see Managed - policies and inline policies in the IAM User Guide.

You - can paginate the results using the MaxItems and Marker - parameters. You can use the PathPrefix parameter to limit the - list of policies to only those matching the specified path prefix. If there - are no policies attached to the specified role (or none that match the specified - path prefix), the operation returns an empty list.

- operationId: POST_ListAttachedRolePolicies - parameters: - - description: Pagination limit - in: query - name: MaxItems - required: false - schema: - type: string - - description: Pagination token - in: query - name: Marker - required: false - schema: - type: string - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ListAttachedRolePoliciesRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - ListAttachedRolePoliciesResult: - $ref: '#/components/schemas/ListAttachedRolePoliciesResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: ListAttachedRolePolicies - /?Action=ListAttachedUserPolicies&Version=2010-05-08: - get: - description:

Lists all managed policies that are attached to the specified - IAM user.

An IAM user can also have inline policies embedded with it. - To list the inline policies for a user, use ListUserPolicies. For information - about policies, see Managed - policies and inline policies in the IAM User Guide.

You - can paginate the results using the MaxItems and Marker - parameters. You can use the PathPrefix parameter to limit the - list of policies to only those matching the specified path prefix. If there - are no policies attached to the specified group (or none that match the specified - path prefix), the operation returns an empty list.

- operationId: GET_ListAttachedUserPolicies - parameters: - - description: '

The name (friendly name, not ARN) of the user to list attached - policies for.

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: UserName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description:

The path prefix for filtering the results. This parameter - is optional. If it is not included, it defaults to a slash (/), listing - all policies.

This parameter allows (through its regex - pattern) a string of characters consisting of either a forward slash - (/) by itself or a string that must begin and end with forward slashes. - In addition, it can contain any ASCII character from the ! (\u0021) - through the DEL character (\u007F), including most punctuation - characters, digits, and upper and lowercased letters.

- in: query - name: PathPrefix - required: false - schema: - maxLength: 512 - minLength: 1 - pattern: ((/[A-Za-z0-9\.,\+@=_-]+)*)/ - type: string - - description: Use this parameter only when paginating results and only after - you receive a response indicating that the results are truncated. Set it - to the value of the Marker element in the response that you - received to indicate where the next call should start. - in: query - name: Marker - required: false - schema: - maxLength: 320 - minLength: 1 - pattern: '[\u0020-\u00FF]+' - type: string - - description:

Use this only when paginating results to indicate the maximum - number of items you want in the response. If additional items exist beyond - the maximum you specify, the IsTruncated response element is - true.

If you do not include this parameter, the number - of items defaults to 100. Note that IAM might return fewer results, even - when there are more results available. In that case, the IsTruncated - response element returns true, and Marker contains - a value to include in the subsequent call that tells the service where to - continue from.

- in: query - name: MaxItems - required: false - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - '200': - content: - text/xml: - schema: - properties: - ListAttachedUserPoliciesResult: - $ref: '#/components/schemas/ListAttachedUserPoliciesResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: ListAttachedUserPolicies - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Lists all managed policies that are attached to the specified - IAM user.

An IAM user can also have inline policies embedded with it. - To list the inline policies for a user, use ListUserPolicies. For information - about policies, see Managed - policies and inline policies in the IAM User Guide.

You - can paginate the results using the MaxItems and Marker - parameters. You can use the PathPrefix parameter to limit the - list of policies to only those matching the specified path prefix. If there - are no policies attached to the specified group (or none that match the specified - path prefix), the operation returns an empty list.

- operationId: POST_ListAttachedUserPolicies - parameters: - - description: Pagination limit - in: query - name: MaxItems - required: false - schema: - type: string - - description: Pagination token - in: query - name: Marker - required: false - schema: - type: string - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ListAttachedUserPoliciesRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - ListAttachedUserPoliciesResult: - $ref: '#/components/schemas/ListAttachedUserPoliciesResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: ListAttachedUserPolicies - /?Action=ListEntitiesForPolicy&Version=2010-05-08: - get: - description:

Lists all IAM users, groups, and roles that the specified managed - policy is attached to.

You can use the optional EntityFilter - parameter to limit the results to a particular type of entity (users, groups, - or roles). For example, to list only the roles that are attached to the specified - policy, set EntityFilter to Role.

You can - paginate the results using the MaxItems and Marker - parameters.

- operationId: GET_ListEntitiesForPolicy - parameters: - - description:

The Amazon Resource Name (ARN) of the IAM policy for which - you want the versions.

For more information about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.

- in: query - name: PolicyArn - required: true - schema: - description:

The Amazon Resource Name (ARN). ARNs are unique identifiers - for Amazon Web Services resources.

For more information about ARNs, - go to Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference. -

- maxLength: 2048 - minLength: 20 - type: string - - description:

The entity type to use for filtering the results.

For - example, when EntityFilter is Role, only the roles - that are attached to the specified policy are returned. This parameter is - optional. If it is not included, all attached entities (users, groups, and - roles) are returned. The argument for this parameter must be one of the - valid values listed below.

- in: query - name: EntityFilter - required: false - schema: - enum: - - User - - Role - - Group - - LocalManagedPolicy - - AWSManagedPolicy - type: string - - description:

The path prefix for filtering the results. This parameter - is optional. If it is not included, it defaults to a slash (/), listing - all entities.

This parameter allows (through its regex - pattern) a string of characters consisting of either a forward slash - (/) by itself or a string that must begin and end with forward slashes. - In addition, it can contain any ASCII character from the ! (\u0021) - through the DEL character (\u007F), including most punctuation - characters, digits, and upper and lowercased letters.

- in: query - name: PathPrefix - required: false - schema: - maxLength: 512 - minLength: 1 - pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F) - type: string - - description: "

The policy usage method to use for filtering the results.

\ - \

To list only permissions policies, set\_PolicyUsageFilter\_\ - to\_PermissionsPolicy. To list only the policies used to set\ - \ permissions boundaries, set\_the value to\_PermissionsBoundary.

\ - \

This parameter is optional. If it is not included, all policies are\ - \ returned.

" - in: query - name: PolicyUsageFilter - required: false - schema: - description:

The policy usage type that indicates whether the policy - is used as a permissions policy or as the permissions boundary for an - entity.

For more information about permissions boundaries, see - Permissions - boundaries for IAM identities in the IAM User Guide.

- enum: - - PermissionsPolicy - - PermissionsBoundary - type: string - - description: Use this parameter only when paginating results and only after - you receive a response indicating that the results are truncated. Set it - to the value of the Marker element in the response that you - received to indicate where the next call should start. - in: query - name: Marker - required: false - schema: - maxLength: 320 - minLength: 1 - pattern: '[\u0020-\u00FF]+' - type: string - - description:

Use this only when paginating results to indicate the maximum - number of items you want in the response. If additional items exist beyond - the maximum you specify, the IsTruncated response element is - true.

If you do not include this parameter, the number - of items defaults to 100. Note that IAM might return fewer results, even - when there are more results available. In that case, the IsTruncated - response element returns true, and Marker contains - a value to include in the subsequent call that tells the service where to - continue from.

- in: query - name: MaxItems - required: false - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - '200': - content: - text/xml: - schema: - properties: - ListEntitiesForPolicyResult: - $ref: '#/components/schemas/ListEntitiesForPolicyResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: ListEntitiesForPolicy - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Lists all IAM users, groups, and roles that the specified managed - policy is attached to.

You can use the optional EntityFilter - parameter to limit the results to a particular type of entity (users, groups, - or roles). For example, to list only the roles that are attached to the specified - policy, set EntityFilter to Role.

You can - paginate the results using the MaxItems and Marker - parameters.

- operationId: POST_ListEntitiesForPolicy - parameters: - - description: Pagination limit - in: query - name: MaxItems - required: false - schema: - type: string - - description: Pagination token - in: query - name: Marker - required: false - schema: - type: string - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ListEntitiesForPolicyRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - ListEntitiesForPolicyResult: - $ref: '#/components/schemas/ListEntitiesForPolicyResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: ListEntitiesForPolicy - /?Action=ListGroupPolicies&Version=2010-05-08: - get: - description:

Lists the names of the inline policies that are embedded in - the specified IAM group.

An IAM group can also have managed policies - attached to it. To list the managed policies that are attached to a group, - use ListAttachedGroupPolicies. For more information about policies, - see Managed - policies and inline policies in the IAM User Guide.

You - can paginate the results using the MaxItems and Marker - parameters. If there are no inline policies embedded with the specified group, - the operation returns an empty list.

- operationId: GET_ListGroupPolicies - parameters: - - description: '

The name of the group to list policies for.

This parameter - allows (through its regex pattern) - a string of characters consisting of upper and lowercase alphanumeric characters - with no spaces. You can also include any of the following characters: _+=,.@-

' - in: query - name: GroupName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: Use this parameter only when paginating results and only after - you receive a response indicating that the results are truncated. Set it - to the value of the Marker element in the response that you - received to indicate where the next call should start. - in: query - name: Marker - required: false - schema: - maxLength: 320 - minLength: 1 - pattern: '[\u0020-\u00FF]+' - type: string - - description:

Use this only when paginating results to indicate the maximum - number of items you want in the response. If additional items exist beyond - the maximum you specify, the IsTruncated response element is - true.

If you do not include this parameter, the number - of items defaults to 100. Note that IAM might return fewer results, even - when there are more results available. In that case, the IsTruncated - response element returns true, and Marker contains - a value to include in the subsequent call that tells the service where to - continue from.

- in: query - name: MaxItems - required: false - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - '200': - content: - text/xml: - schema: - properties: - ListGroupPoliciesResult: - $ref: '#/components/schemas/ListGroupPoliciesResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: ListGroupPolicies - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Lists the names of the inline policies that are embedded in - the specified IAM group.

An IAM group can also have managed policies - attached to it. To list the managed policies that are attached to a group, - use ListAttachedGroupPolicies. For more information about policies, - see Managed - policies and inline policies in the IAM User Guide.

You - can paginate the results using the MaxItems and Marker - parameters. If there are no inline policies embedded with the specified group, - the operation returns an empty list.

- operationId: POST_ListGroupPolicies - parameters: - - description: Pagination limit - in: query - name: MaxItems - required: false - schema: - type: string - - description: Pagination token - in: query - name: Marker - required: false - schema: - type: string - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ListGroupPoliciesRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - ListGroupPoliciesResult: - $ref: '#/components/schemas/ListGroupPoliciesResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: ListGroupPolicies - /?Action=ListGroups&Version=2010-05-08: - get: - description:

Lists the IAM groups that have the specified path prefix.

-

You can paginate the results using the MaxItems and Marker - parameters.

- operationId: GET_ListGroups - parameters: - - description:

The path prefix for filtering the results. For example, the - prefix /division_abc/subdivision_xyz/ gets all groups whose - path starts with /division_abc/subdivision_xyz/.

This - parameter is optional. If it is not included, it defaults to a slash (/), - listing all groups. This parameter allows (through its regex - pattern) a string of characters consisting of either a forward slash - (/) by itself or a string that must begin and end with forward slashes. - In addition, it can contain any ASCII character from the ! (\u0021) - through the DEL character (\u007F), including most punctuation - characters, digits, and upper and lowercased letters.

- in: query - name: PathPrefix - required: false - schema: - maxLength: 512 - minLength: 1 - pattern: \u002F[\u0021-\u007F]* - type: string - - description: Use this parameter only when paginating results and only after - you receive a response indicating that the results are truncated. Set it - to the value of the Marker element in the response that you - received to indicate where the next call should start. - in: query - name: Marker - required: false - schema: - maxLength: 320 - minLength: 1 - pattern: '[\u0020-\u00FF]+' - type: string - - description:

Use this only when paginating results to indicate the maximum - number of items you want in the response. If additional items exist beyond - the maximum you specify, the IsTruncated response element is - true.

If you do not include this parameter, the number - of items defaults to 100. Note that IAM might return fewer results, even - when there are more results available. In that case, the IsTruncated - response element returns true, and Marker contains - a value to include in the subsequent call that tells the service where to - continue from.

- in: query - name: MaxItems - required: false - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - '200': - content: - text/xml: - schema: - properties: - ListGroupsResult: - $ref: '#/components/schemas/ListGroupsResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: ListGroups - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Lists the IAM groups that have the specified path prefix.

-

You can paginate the results using the MaxItems and Marker - parameters.

- operationId: POST_ListGroups - parameters: - - description: Pagination limit - in: query - name: MaxItems - required: false - schema: - type: string - - description: Pagination token - in: query - name: Marker - required: false - schema: - type: string - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ListGroupsRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - ListGroupsResult: - $ref: '#/components/schemas/ListGroupsResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: ListGroups - /?Action=ListGroupsForUser&Version=2010-05-08: - get: - description:

Lists the IAM groups that the specified IAM user belongs to.

-

You can paginate the results using the MaxItems and Marker - parameters.

- operationId: GET_ListGroupsForUser - parameters: - - description: '

The name of the user to list groups for.

This parameter - allows (through its regex pattern) - a string of characters consisting of upper and lowercase alphanumeric characters - with no spaces. You can also include any of the following characters: _+=,.@-

' - in: query - name: UserName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: Use this parameter only when paginating results and only after - you receive a response indicating that the results are truncated. Set it - to the value of the Marker element in the response that you - received to indicate where the next call should start. - in: query - name: Marker - required: false - schema: - maxLength: 320 - minLength: 1 - pattern: '[\u0020-\u00FF]+' - type: string - - description:

Use this only when paginating results to indicate the maximum - number of items you want in the response. If additional items exist beyond - the maximum you specify, the IsTruncated response element is - true.

If you do not include this parameter, the number - of items defaults to 100. Note that IAM might return fewer results, even - when there are more results available. In that case, the IsTruncated - response element returns true, and Marker contains - a value to include in the subsequent call that tells the service where to - continue from.

- in: query - name: MaxItems - required: false - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - '200': - content: - text/xml: - schema: - properties: - ListGroupsForUserResult: - $ref: '#/components/schemas/ListGroupsForUserResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: ListGroupsForUser - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Lists the IAM groups that the specified IAM user belongs to.

-

You can paginate the results using the MaxItems and Marker - parameters.

- operationId: POST_ListGroupsForUser - parameters: - - description: Pagination limit - in: query - name: MaxItems - required: false - schema: - type: string - - description: Pagination token - in: query - name: Marker - required: false - schema: - type: string - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ListGroupsForUserRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - ListGroupsForUserResult: - $ref: '#/components/schemas/ListGroupsForUserResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: ListGroupsForUser - /?Action=ListInstanceProfileTags&Version=2010-05-08: - get: - description: Lists the tags that are attached to the specified IAM instance - profile. The returned list of tags is sorted by tag key. For more information - about tagging, see Tagging - IAM resources in the IAM User Guide. - operationId: GET_ListInstanceProfileTags - parameters: - - description: '

The name of the IAM instance profile whose tags you want - to see.

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: InstanceProfileName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: Use this parameter only when paginating results and only after - you receive a response indicating that the results are truncated. Set it - to the value of the Marker element in the response that you - received to indicate where the next call should start. - in: query - name: Marker - required: false - schema: - maxLength: 320 - minLength: 1 - pattern: '[\u0020-\u00FF]+' - type: string - - description:

Use this only when paginating results to indicate the maximum - number of items you want in the response. If additional items exist beyond - the maximum you specify, the IsTruncated response element is - true.

If you do not include this parameter, the number - of items defaults to 100. Note that IAM might return fewer results, even - when there are more results available. In that case, the IsTruncated - response element returns true, and Marker contains - a value to include in the subsequent call that tells the service where to - continue from.

- in: query - name: MaxItems - required: false - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - '200': - content: - text/xml: - schema: - properties: - ListInstanceProfileTagsResult: - $ref: '#/components/schemas/ListInstanceProfileTagsResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: ListInstanceProfileTags - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description: Lists the tags that are attached to the specified IAM instance - profile. The returned list of tags is sorted by tag key. For more information - about tagging, see Tagging - IAM resources in the IAM User Guide. - operationId: POST_ListInstanceProfileTags - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ListInstanceProfileTagsRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - ListInstanceProfileTagsResult: - $ref: '#/components/schemas/ListInstanceProfileTagsResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: ListInstanceProfileTags - /?Action=ListInstanceProfiles&Version=2010-05-08: - get: - description:

Lists the instance profiles that have the specified path prefix. - If there are none, the operation returns an empty list. For more information - about instance profiles, see About - instance profiles.

IAM resource-listing operations return - a subset of the available attributes for the resource. For example, this operation - does not return tags, even though they are an attribute of the returned object. - To view all of the information for an instance profile, see GetInstanceProfile.

-

You can paginate the results using the MaxItems and - Marker parameters.

- operationId: GET_ListInstanceProfiles - parameters: - - description:

The path prefix for filtering the results. For example, the - prefix /application_abc/component_xyz/ gets all instance profiles - whose path starts with /application_abc/component_xyz/.

-

This parameter is optional. If it is not included, it defaults to a slash - (/), listing all instance profiles. This parameter allows (through its regex pattern) a string of characters - consisting of either a forward slash (/) by itself or a string that must - begin and end with forward slashes. In addition, it can contain any ASCII - character from the ! (\u0021) through the DEL character (\u007F), - including most punctuation characters, digits, and upper and lowercased - letters.

- in: query - name: PathPrefix - required: false - schema: - maxLength: 512 - minLength: 1 - pattern: \u002F[\u0021-\u007F]* - type: string - - description: Use this parameter only when paginating results and only after - you receive a response indicating that the results are truncated. Set it - to the value of the Marker element in the response that you - received to indicate where the next call should start. - in: query - name: Marker - required: false - schema: - maxLength: 320 - minLength: 1 - pattern: '[\u0020-\u00FF]+' - type: string - - description:

Use this only when paginating results to indicate the maximum - number of items you want in the response. If additional items exist beyond - the maximum you specify, the IsTruncated response element is - true.

If you do not include this parameter, the number - of items defaults to 100. Note that IAM might return fewer results, even - when there are more results available. In that case, the IsTruncated - response element returns true, and Marker contains - a value to include in the subsequent call that tells the service where to - continue from.

- in: query - name: MaxItems - required: false - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - '200': - content: - text/xml: - schema: - properties: - ListInstanceProfilesResult: - $ref: '#/components/schemas/ListInstanceProfilesResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: ListInstanceProfiles - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Lists the instance profiles that have the specified path prefix. - If there are none, the operation returns an empty list. For more information - about instance profiles, see About - instance profiles.

IAM resource-listing operations return - a subset of the available attributes for the resource. For example, this operation - does not return tags, even though they are an attribute of the returned object. - To view all of the information for an instance profile, see GetInstanceProfile.

-

You can paginate the results using the MaxItems and - Marker parameters.

- operationId: POST_ListInstanceProfiles - parameters: - - description: Pagination limit - in: query - name: MaxItems - required: false - schema: - type: string - - description: Pagination token - in: query - name: Marker - required: false - schema: - type: string - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ListInstanceProfilesRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - ListInstanceProfilesResult: - $ref: '#/components/schemas/ListInstanceProfilesResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: ListInstanceProfiles - /?Action=ListInstanceProfilesForRole&Version=2010-05-08: - get: - description:

Lists the instance profiles that have the specified associated - IAM role. If there are none, the operation returns an empty list. For more - information about instance profiles, go to About - instance profiles.

You can paginate the results using the MaxItems - and Marker parameters.

- operationId: GET_ListInstanceProfilesForRole - parameters: - - description: '

The name of the role to list instance profiles for.

This - parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: RoleName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: Use this parameter only when paginating results and only after - you receive a response indicating that the results are truncated. Set it - to the value of the Marker element in the response that you - received to indicate where the next call should start. - in: query - name: Marker - required: false - schema: - maxLength: 320 - minLength: 1 - pattern: '[\u0020-\u00FF]+' - type: string - - description:

Use this only when paginating results to indicate the maximum - number of items you want in the response. If additional items exist beyond - the maximum you specify, the IsTruncated response element is - true.

If you do not include this parameter, the number - of items defaults to 100. Note that IAM might return fewer results, even - when there are more results available. In that case, the IsTruncated - response element returns true, and Marker contains - a value to include in the subsequent call that tells the service where to - continue from.

- in: query - name: MaxItems - required: false - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - '200': - content: - text/xml: - schema: - properties: - ListInstanceProfilesForRoleResult: - $ref: '#/components/schemas/ListInstanceProfilesForRoleResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: ListInstanceProfilesForRole - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Lists the instance profiles that have the specified associated - IAM role. If there are none, the operation returns an empty list. For more - information about instance profiles, go to About - instance profiles.

You can paginate the results using the MaxItems - and Marker parameters.

- operationId: POST_ListInstanceProfilesForRole - parameters: - - description: Pagination limit - in: query - name: MaxItems - required: false - schema: - type: string - - description: Pagination token - in: query - name: Marker - required: false - schema: - type: string - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ListInstanceProfilesForRoleRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - ListInstanceProfilesForRoleResult: - $ref: '#/components/schemas/ListInstanceProfilesForRoleResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: ListInstanceProfilesForRole - /?Action=ListMFADeviceTags&Version=2010-05-08: - get: - description: Lists the tags that are attached to the specified IAM virtual multi-factor - authentication (MFA) device. The returned list of tags is sorted by tag key. - For more information about tagging, see Tagging - IAM resources in the IAM User Guide. - operationId: GET_ListMFADeviceTags - parameters: - - description: '

The unique identifier for the IAM virtual MFA device whose - tags you want to see. For virtual MFA devices, the serial number is the - same as the ARN.

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: SerialNumber - required: true - schema: - maxLength: 256 - minLength: 9 - pattern: '[\w+=/:,.@-]+' - type: string - - description: Use this parameter only when paginating results and only after - you receive a response indicating that the results are truncated. Set it - to the value of the Marker element in the response that you - received to indicate where the next call should start. - in: query - name: Marker - required: false - schema: - maxLength: 320 - minLength: 1 - pattern: '[\u0020-\u00FF]+' - type: string - - description:

Use this only when paginating results to indicate the maximum - number of items you want in the response. If additional items exist beyond - the maximum you specify, the IsTruncated response element is - true.

If you do not include this parameter, the number - of items defaults to 100. Note that IAM might return fewer results, even - when there are more results available. In that case, the IsTruncated - response element returns true, and Marker contains - a value to include in the subsequent call that tells the service where to - continue from.

- in: query - name: MaxItems - required: false - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - '200': - content: - text/xml: - schema: - properties: - ListMFADeviceTagsResult: - $ref: '#/components/schemas/ListMFADeviceTagsResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: ListMFADeviceTags - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description: Lists the tags that are attached to the specified IAM virtual multi-factor - authentication (MFA) device. The returned list of tags is sorted by tag key. - For more information about tagging, see Tagging - IAM resources in the IAM User Guide. - operationId: POST_ListMFADeviceTags - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ListMFADeviceTagsRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - ListMFADeviceTagsResult: - $ref: '#/components/schemas/ListMFADeviceTagsResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: ListMFADeviceTags - /?Action=ListMFADevices&Version=2010-05-08: - get: - description:

Lists the MFA devices for an IAM user. If the request includes - a IAM user name, then this operation lists all the MFA devices associated - with the specified user. If you do not specify a user name, IAM determines - the user name implicitly based on the Amazon Web Services access key ID signing - the request for this operation.

You can paginate the results using - the MaxItems and Marker parameters.

- operationId: GET_ListMFADevices - parameters: - - description: '

The name of the user whose MFA devices you want to list.

-

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: UserName - required: false - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: Use this parameter only when paginating results and only after - you receive a response indicating that the results are truncated. Set it - to the value of the Marker element in the response that you - received to indicate where the next call should start. - in: query - name: Marker - required: false - schema: - maxLength: 320 - minLength: 1 - pattern: '[\u0020-\u00FF]+' - type: string - - description:

Use this only when paginating results to indicate the maximum - number of items you want in the response. If additional items exist beyond - the maximum you specify, the IsTruncated response element is - true.

If you do not include this parameter, the number - of items defaults to 100. Note that IAM might return fewer results, even - when there are more results available. In that case, the IsTruncated - response element returns true, and Marker contains - a value to include in the subsequent call that tells the service where to - continue from.

- in: query - name: MaxItems - required: false - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - '200': - content: - text/xml: - schema: - properties: - ListMFADevicesResult: - $ref: '#/components/schemas/ListMFADevicesResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: ListMFADevices - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Lists the MFA devices for an IAM user. If the request includes - a IAM user name, then this operation lists all the MFA devices associated - with the specified user. If you do not specify a user name, IAM determines - the user name implicitly based on the Amazon Web Services access key ID signing - the request for this operation.

You can paginate the results using - the MaxItems and Marker parameters.

- operationId: POST_ListMFADevices - parameters: - - description: Pagination limit - in: query - name: MaxItems - required: false - schema: - type: string - - description: Pagination token - in: query - name: Marker - required: false - schema: - type: string - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ListMFADevicesRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - ListMFADevicesResult: - $ref: '#/components/schemas/ListMFADevicesResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: ListMFADevices - /?Action=ListOpenIDConnectProviderTags&Version=2010-05-08: - get: - description:

Lists the tags that are attached to the specified OpenID Connect - (OIDC)-compatible identity provider. The returned list of tags is sorted by - tag key. For more information, see About - web identity federation.

For more information about tagging, see - Tagging - IAM resources in the IAM User Guide.

- operationId: GET_ListOpenIDConnectProviderTags - parameters: - - description: '

The ARN of the OpenID Connect (OIDC) identity provider whose - tags you want to see.

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: OpenIDConnectProviderArn - required: true - schema: - description:

The Amazon Resource Name (ARN). ARNs are unique identifiers - for Amazon Web Services resources.

For more information about ARNs, - go to Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference. -

- maxLength: 2048 - minLength: 20 - type: string - - description: Use this parameter only when paginating results and only after - you receive a response indicating that the results are truncated. Set it - to the value of the Marker element in the response that you - received to indicate where the next call should start. - in: query - name: Marker - required: false - schema: - maxLength: 320 - minLength: 1 - pattern: '[\u0020-\u00FF]+' - type: string - - description:

Use this only when paginating results to indicate the maximum - number of items you want in the response. If additional items exist beyond - the maximum you specify, the IsTruncated response element is - true.

If you do not include this parameter, the number - of items defaults to 100. Note that IAM might return fewer results, even - when there are more results available. In that case, the IsTruncated - response element returns true, and Marker contains - a value to include in the subsequent call that tells the service where to - continue from.

- in: query - name: MaxItems - required: false - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - '200': - content: - text/xml: - schema: - properties: - ListOpenIDConnectProviderTagsResult: - $ref: '#/components/schemas/ListOpenIDConnectProviderTagsResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - x-aws-operation-name: ListOpenIDConnectProviderTags - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Lists the tags that are attached to the specified OpenID Connect - (OIDC)-compatible identity provider. The returned list of tags is sorted by - tag key. For more information, see About - web identity federation.

For more information about tagging, see - Tagging - IAM resources in the IAM User Guide.

- operationId: POST_ListOpenIDConnectProviderTags - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ListOpenIDConnectProviderTagsRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - ListOpenIDConnectProviderTagsResult: - $ref: '#/components/schemas/ListOpenIDConnectProviderTagsResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - x-aws-operation-name: ListOpenIDConnectProviderTags - /?Action=ListOpenIDConnectProviders&Version=2010-05-08: - get: - description:

Lists information about the IAM OpenID Connect (OIDC) provider - resource objects defined in the Amazon Web Services account.

IAM - resource-listing operations return a subset of the available attributes for - the resource. For example, this operation does not return tags, even though - they are an attribute of the returned object. To view all of the information - for an OIDC provider, see GetOpenIDConnectProvider.

 - operationId: GET_ListOpenIDConnectProviders - parameters: [] - responses: - '200': - content: - text/xml: - schema: - properties: - ListOpenIDConnectProvidersResult: - $ref: '#/components/schemas/ListOpenIDConnectProvidersResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: ListOpenIDConnectProviders - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Lists information about the IAM OpenID Connect (OIDC) provider - resource objects defined in the Amazon Web Services account.

IAM - resource-listing operations return a subset of the available attributes for - the resource. For example, this operation does not return tags, even though - they are an attribute of the returned object. To view all of the information - for an OIDC provider, see GetOpenIDConnectProvider.

 - operationId: POST_ListOpenIDConnectProviders - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ListOpenIDConnectProvidersRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - ListOpenIDConnectProvidersResult: - $ref: '#/components/schemas/ListOpenIDConnectProvidersResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: ListOpenIDConnectProviders - /?Action=ListPolicies&Version=2010-05-08: - get: - description:

Lists all the managed policies that are available in your Amazon - Web Services account, including your own customer-defined managed policies - and all Amazon Web Services managed policies.

You can filter the list - of policies that is returned using the optional OnlyAttached, - Scope, and PathPrefix parameters. For example, to - list only the customer managed policies in your Amazon Web Services account, - set Scope to Local. To list only Amazon Web Services - managed policies, set Scope to AWS.

You can - paginate the results using the MaxItems and Marker - parameters.

For more information about managed policies, see Managed - policies and inline policies in the IAM User Guide.

-

IAM resource-listing operations return a subset of the available attributes - for the resource. For example, this operation does not return tags, even though - they are an attribute of the returned object. To view all of the information - for a customer manged policy, see GetPolicy.

 - operationId: GET_ListPolicies - parameters: - - description:

The scope to use for filtering the results.

To list - only Amazon Web Services managed policies, set Scope to AWS. - To list only the customer managed policies in your Amazon Web Services account, - set Scope to Local.

This parameter is optional. - If it is not included, or if it is set to All, all policies - are returned.

- in: query - name: Scope - required: false - schema: - enum: - - All - - AWS - - Local - type: string - - description:

A flag to filter the results to only the attached policies.

-

When OnlyAttached is true, the returned list - contains only the policies that are attached to an IAM user, group, or role. - When OnlyAttached is false, or when the parameter - is not included, all policies are returned.

- in: query - name: OnlyAttached - required: false - schema: - type: boolean - - description: The path prefix for filtering the results. This parameter is - optional. If it is not included, it defaults to a slash (/), listing all - policies. This parameter allows (through its regex - pattern) a string of characters consisting of either a forward slash - (/) by itself or a string that must begin and end with forward slashes. - In addition, it can contain any ASCII character from the ! (\u0021) - through the DEL character (\u007F), including most punctuation - characters, digits, and upper and lowercased letters. - in: query - name: PathPrefix - required: false - schema: - maxLength: 512 - minLength: 1 - pattern: ((/[A-Za-z0-9\.,\+@=_-]+)*)/ - type: string - - description: "

The policy usage method to use for filtering the results.

\ - \

To list only permissions policies, set\_PolicyUsageFilter\_\ - to\_PermissionsPolicy. To list only the policies used to set\ - \ permissions boundaries, set\_the value to\_PermissionsBoundary.

\ - \

This parameter is optional. If it is not included, all policies are\ - \ returned.

" - in: query - name: PolicyUsageFilter - required: false - schema: - description:

The policy usage type that indicates whether the policy - is used as a permissions policy or as the permissions boundary for an - entity.

For more information about permissions boundaries, see - Permissions - boundaries for IAM identities in the IAM User Guide.

- enum: - - PermissionsPolicy - - PermissionsBoundary - type: string - - description: Use this parameter only when paginating results and only after - you receive a response indicating that the results are truncated. Set it - to the value of the Marker element in the response that you - received to indicate where the next call should start. - in: query - name: Marker - required: false - schema: - maxLength: 320 - minLength: 1 - pattern: '[\u0020-\u00FF]+' - type: string - - description:

Use this only when paginating results to indicate the maximum - number of items you want in the response. If additional items exist beyond - the maximum you specify, the IsTruncated response element is - true.

If you do not include this parameter, the number - of items defaults to 100. Note that IAM might return fewer results, even - when there are more results available. In that case, the IsTruncated - response element returns true, and Marker contains - a value to include in the subsequent call that tells the service where to - continue from.

- in: query - name: MaxItems - required: false - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - '200': - content: - text/xml: - schema: - properties: - ListPoliciesResult: - $ref: '#/components/schemas/ListPoliciesResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: ListPolicies - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Lists all the managed policies that are available in your Amazon - Web Services account, including your own customer-defined managed policies - and all Amazon Web Services managed policies.

You can filter the list - of policies that is returned using the optional OnlyAttached, - Scope, and PathPrefix parameters. For example, to - list only the customer managed policies in your Amazon Web Services account, - set Scope to Local. To list only Amazon Web Services - managed policies, set Scope to AWS.

You can - paginate the results using the MaxItems and Marker - parameters.

For more information about managed policies, see Managed - policies and inline policies in the IAM User Guide.

-

IAM resource-listing operations return a subset of the available attributes - for the resource. For example, this operation does not return tags, even though - they are an attribute of the returned object. To view all of the information - for a customer manged policy, see GetPolicy.

 - operationId: POST_ListPolicies - parameters: - - description: Pagination limit - in: query - name: MaxItems - required: false - schema: - type: string - - description: Pagination token - in: query - name: Marker - required: false - schema: - type: string - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ListPoliciesRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - ListPoliciesResult: - $ref: '#/components/schemas/ListPoliciesResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: ListPolicies - /?Action=ListPoliciesGrantingServiceAccess&Version=2010-05-08: - get: - description: "

Retrieves a list of policies that the IAM identity (user, group,\ - \ or role) can use to access each specified service.

This operation\ - \ does not use other policy types when determining whether a resource could\ - \ access a service. These other policy types include resource-based policies,\ - \ access control lists, Organizations policies, IAM permissions boundaries,\ - \ and STS assume role policies. It only applies permissions policy logic.\ - \ For more about the evaluation of policy types, see Evaluating policies in the IAM User Guide.

The\ - \ list of policies returned by the operation depends on the ARN of the identity\ - \ that you provide.

  • User \u2013 The list of policies\ - \ includes the managed and inline policies that are attached to the user directly.\ - \ The list also includes any additional managed and inline policies that are\ - \ attached to the group to which the user belongs.

  • Group\ - \ \u2013 The list of policies includes only the managed and inline policies\ - \ that are attached to the group directly. Policies that are attached to the\ - \ group\u2019s user are not included.

  • Role \u2013\ - \ The list of policies includes only the managed and inline policies that\ - \ are attached to the role.

For each managed policy, this\ - \ operation returns the ARN and policy name. For each inline policy, it returns\ - \ the policy name and the entity to which it is attached. Inline policies\ - \ do not have an ARN. For more information about these policy types, see Managed policies and inline policies in the IAM User Guide.

\ - \

Policies that are attached to users and roles as permissions boundaries\ - \ are not returned. To view which managed policy is currently used to set\ - \ the permissions boundary for a user or role, use the GetUser or GetRole\ - \ operations.

" - operationId: GET_ListPoliciesGrantingServiceAccess - parameters: - - description: Use this parameter only when paginating results and only after - you receive a response indicating that the results are truncated. Set it - to the value of the Marker element in the response that you - received to indicate where the next call should start. - in: query - name: Marker - required: false - schema: - maxLength: 320 - minLength: 1 - pattern: '[\u0020-\u00FF]+' - type: string - - description: The ARN of the IAM identity (user, group, or role) whose policies - you want to list. - in: query - name: Arn - required: true - schema: - description:

The Amazon Resource Name (ARN). ARNs are unique identifiers - for Amazon Web Services resources.

For more information about ARNs, - go to Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference. -

- maxLength: 2048 - minLength: 20 - type: string - - description: "

The service namespace for the Amazon Web Services services\ - \ whose policies you want to list.

To learn the service namespace\ - \ for a service, see Actions, resources, and condition keys for Amazon Web Services services\ - \ in the IAM User Guide. Choose the name of the service to view details\ - \ for that service. In the first paragraph, find the service prefix. For\ - \ example, (service prefix: a4b). For more information about\ - \ service namespaces, see Amazon Web Services service namespaces in the\_Amazon Web Services\ - \ General Reference.

" - in: query - name: ServiceNamespaces - required: true - schema: - items: - allOf: - - $ref: '#/components/schemas/serviceNamespaceType' - - xml: - name: member - maxItems: 200 - minItems: 1 - type: array - responses: - '200': - content: - text/xml: - schema: - properties: - ListPoliciesGrantingServiceAccessResult: - $ref: '#/components/schemas/ListPoliciesGrantingServiceAccessResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - x-aws-operation-name: ListPoliciesGrantingServiceAccess - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description: "

Retrieves a list of policies that the IAM identity (user, group,\ - \ or role) can use to access each specified service.

This operation\ - \ does not use other policy types when determining whether a resource could\ - \ access a service. These other policy types include resource-based policies,\ - \ access control lists, Organizations policies, IAM permissions boundaries,\ - \ and STS assume role policies. It only applies permissions policy logic.\ - \ For more about the evaluation of policy types, see Evaluating policies in the IAM User Guide.

The\ - \ list of policies returned by the operation depends on the ARN of the identity\ - \ that you provide.

  • User \u2013 The list of policies\ - \ includes the managed and inline policies that are attached to the user directly.\ - \ The list also includes any additional managed and inline policies that are\ - \ attached to the group to which the user belongs.

  • Group\ - \ \u2013 The list of policies includes only the managed and inline policies\ - \ that are attached to the group directly. Policies that are attached to the\ - \ group\u2019s user are not included.

  • Role \u2013\ - \ The list of policies includes only the managed and inline policies that\ - \ are attached to the role.

For each managed policy, this\ - \ operation returns the ARN and policy name. For each inline policy, it returns\ - \ the policy name and the entity to which it is attached. Inline policies\ - \ do not have an ARN. For more information about these policy types, see Managed policies and inline policies in the IAM User Guide.

\ - \

Policies that are attached to users and roles as permissions boundaries\ - \ are not returned. To view which managed policy is currently used to set\ - \ the permissions boundary for a user or role, use the GetUser or GetRole\ - \ operations.

" - operationId: POST_ListPoliciesGrantingServiceAccess - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ListPoliciesGrantingServiceAccessRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - ListPoliciesGrantingServiceAccessResult: - $ref: '#/components/schemas/ListPoliciesGrantingServiceAccessResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - x-aws-operation-name: ListPoliciesGrantingServiceAccess - /?Action=ListPolicyTags&Version=2010-05-08: - get: - description: Lists the tags that are attached to the specified IAM customer - managed policy. The returned list of tags is sorted by tag key. For more information - about tagging, see Tagging - IAM resources in the IAM User Guide. - operationId: GET_ListPolicyTags - parameters: - - description: '

The ARN of the IAM customer managed policy whose tags you - want to see.

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: PolicyArn - required: true - schema: - description:

The Amazon Resource Name (ARN). ARNs are unique identifiers - for Amazon Web Services resources.

For more information about ARNs, - go to Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference. -

- maxLength: 2048 - minLength: 20 - type: string - - description: Use this parameter only when paginating results and only after - you receive a response indicating that the results are truncated. Set it - to the value of the Marker element in the response that you - received to indicate where the next call should start. - in: query - name: Marker - required: false - schema: - maxLength: 320 - minLength: 1 - pattern: '[\u0020-\u00FF]+' - type: string - - description:

Use this only when paginating results to indicate the maximum - number of items you want in the response. If additional items exist beyond - the maximum you specify, the IsTruncated response element is - true.

If you do not include this parameter, the number - of items defaults to 100. Note that IAM might return fewer results, even - when there are more results available. In that case, the IsTruncated - response element returns true, and Marker contains - a value to include in the subsequent call that tells the service where to - continue from.

- in: query - name: MaxItems - required: false - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - '200': - content: - text/xml: - schema: - properties: - ListPolicyTagsResult: - $ref: '#/components/schemas/ListPolicyTagsResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - x-aws-operation-name: ListPolicyTags - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description: Lists the tags that are attached to the specified IAM customer - managed policy. The returned list of tags is sorted by tag key. For more information - about tagging, see Tagging - IAM resources in the IAM User Guide. - operationId: POST_ListPolicyTags - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ListPolicyTagsRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - ListPolicyTagsResult: - $ref: '#/components/schemas/ListPolicyTagsResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - x-aws-operation-name: ListPolicyTags - /?Action=ListPolicyVersions&Version=2010-05-08: - get: - description:

Lists information about the versions of the specified managed - policy, including the version that is currently set as the policy's default - version.

For more information about managed policies, see Managed - policies and inline policies in the IAM User Guide.

- operationId: GET_ListPolicyVersions - parameters: - - description:

The Amazon Resource Name (ARN) of the IAM policy for which - you want the versions.

For more information about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.

- in: query - name: PolicyArn - required: true - schema: - description:

The Amazon Resource Name (ARN). ARNs are unique identifiers - for Amazon Web Services resources.

For more information about ARNs, - go to Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference. -

- maxLength: 2048 - minLength: 20 - type: string - - description: Use this parameter only when paginating results and only after - you receive a response indicating that the results are truncated. Set it - to the value of the Marker element in the response that you - received to indicate where the next call should start. - in: query - name: Marker - required: false - schema: - maxLength: 320 - minLength: 1 - pattern: '[\u0020-\u00FF]+' - type: string - - description:

Use this only when paginating results to indicate the maximum - number of items you want in the response. If additional items exist beyond - the maximum you specify, the IsTruncated response element is - true.

If you do not include this parameter, the number - of items defaults to 100. Note that IAM might return fewer results, even - when there are more results available. In that case, the IsTruncated - response element returns true, and Marker contains - a value to include in the subsequent call that tells the service where to - continue from.

- in: query - name: MaxItems - required: false - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - '200': - content: - text/xml: - schema: - properties: - ListPolicyVersionsResult: - $ref: '#/components/schemas/ListPolicyVersionsResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: ListPolicyVersions - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Lists information about the versions of the specified managed - policy, including the version that is currently set as the policy's default - version.

For more information about managed policies, see Managed - policies and inline policies in the IAM User Guide.

- operationId: POST_ListPolicyVersions - parameters: - - description: Pagination limit - in: query - name: MaxItems - required: false - schema: - type: string - - description: Pagination token - in: query - name: Marker - required: false - schema: - type: string - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ListPolicyVersionsRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - ListPolicyVersionsResult: - $ref: '#/components/schemas/ListPolicyVersionsResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: ListPolicyVersions - /?Action=ListRolePolicies&Version=2010-05-08: - get: - description:

Lists the names of the inline policies that are embedded in - the specified IAM role.

An IAM role can also have managed policies - attached to it. To list the managed policies that are attached to a role, - use ListAttachedRolePolicies. For more information about policies, - see Managed - policies and inline policies in the IAM User Guide.

You - can paginate the results using the MaxItems and Marker - parameters. If there are no inline policies embedded with the specified role, - the operation returns an empty list.

- operationId: GET_ListRolePolicies - parameters: - - description: '

The name of the role to list policies for.

This parameter - allows (through its regex pattern) - a string of characters consisting of upper and lowercase alphanumeric characters - with no spaces. You can also include any of the following characters: _+=,.@-

' - in: query - name: RoleName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: Use this parameter only when paginating results and only after - you receive a response indicating that the results are truncated. Set it - to the value of the Marker element in the response that you - received to indicate where the next call should start. - in: query - name: Marker - required: false - schema: - maxLength: 320 - minLength: 1 - pattern: '[\u0020-\u00FF]+' - type: string - - description:

Use this only when paginating results to indicate the maximum - number of items you want in the response. If additional items exist beyond - the maximum you specify, the IsTruncated response element is - true.

If you do not include this parameter, the number - of items defaults to 100. Note that IAM might return fewer results, even - when there are more results available. In that case, the IsTruncated - response element returns true, and Marker contains - a value to include in the subsequent call that tells the service where to - continue from.

- in: query - name: MaxItems - required: false - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - '200': - content: - text/xml: - schema: - properties: - ListRolePoliciesResult: - $ref: '#/components/schemas/ListRolePoliciesResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: ListRolePolicies - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Lists the names of the inline policies that are embedded in - the specified IAM role.

An IAM role can also have managed policies - attached to it. To list the managed policies that are attached to a role, - use ListAttachedRolePolicies. For more information about policies, - see Managed - policies and inline policies in the IAM User Guide.

You - can paginate the results using the MaxItems and Marker - parameters. If there are no inline policies embedded with the specified role, - the operation returns an empty list.

- operationId: POST_ListRolePolicies - parameters: - - description: Pagination limit - in: query - name: MaxItems - required: false - schema: - type: string - - description: Pagination token - in: query - name: Marker - required: false - schema: - type: string - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ListRolePoliciesRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - ListRolePoliciesResult: - $ref: '#/components/schemas/ListRolePoliciesResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: ListRolePolicies - /?Action=ListRoleTags&Version=2010-05-08: - get: - description: Lists the tags that are attached to the specified role. The returned - list of tags is sorted by tag key. For more information about tagging, see - Tagging - IAM resources in the IAM User Guide. - operationId: GET_ListRoleTags - parameters: - - description: '

The name of the IAM role for which you want to see the list - of tags.

This parameter accepts (through its regex - pattern) a string of characters that consist of upper and lowercase - alphanumeric characters with no spaces. You can also include any of the - following characters: _+=,.@-

' - in: query - name: RoleName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: Use this parameter only when paginating results and only after - you receive a response indicating that the results are truncated. Set it - to the value of the Marker element in the response that you - received to indicate where the next call should start. - in: query - name: Marker - required: false - schema: - maxLength: 320 - minLength: 1 - pattern: '[\u0020-\u00FF]+' - type: string - - description:

Use this only when paginating results to indicate the maximum - number of items you want in the response. If additional items exist beyond - the maximum you specify, the IsTruncated response element is - true.

If you do not include this parameter, the number - of items defaults to 100. Note that IAM might return fewer results, even - when there are more results available. In that case, the IsTruncated - response element returns true, and Marker contains - a value to include in the subsequent call that tells the service where to - continue from.

- in: query - name: MaxItems - required: false - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - '200': - content: - text/xml: - schema: - properties: - ListRoleTagsResult: - $ref: '#/components/schemas/ListRoleTagsResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: ListRoleTags - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description: Lists the tags that are attached to the specified role. The returned - list of tags is sorted by tag key. For more information about tagging, see - Tagging - IAM resources in the IAM User Guide. - operationId: POST_ListRoleTags - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ListRoleTagsRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - ListRoleTagsResult: - $ref: '#/components/schemas/ListRoleTagsResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: ListRoleTags - /?Action=ListRoles&Version=2010-05-08: - get: - description:

Lists the IAM roles that have the specified path prefix. If - there are none, the operation returns an empty list. For more information - about roles, see Working - with roles.

IAM resource-listing operations return a subset - of the available attributes for the resource. For example, this operation - does not return tags, even though they are an attribute of the returned object. - To view all of the information for a role, see GetRole.

 -

You can paginate the results using the MaxItems and Marker - parameters.

- operationId: GET_ListRoles - parameters: - - description:

The path prefix for filtering the results. For example, the - prefix /application_abc/component_xyz/ gets all roles whose - path starts with /application_abc/component_xyz/.

This - parameter is optional. If it is not included, it defaults to a slash (/), - listing all roles. This parameter allows (through its regex - pattern) a string of characters consisting of either a forward slash - (/) by itself or a string that must begin and end with forward slashes. - In addition, it can contain any ASCII character from the ! (\u0021) - through the DEL character (\u007F), including most punctuation - characters, digits, and upper and lowercased letters.

- in: query - name: PathPrefix - required: false - schema: - maxLength: 512 - minLength: 1 - pattern: \u002F[\u0021-\u007F]* - type: string - - description: Use this parameter only when paginating results and only after - you receive a response indicating that the results are truncated. Set it - to the value of the Marker element in the response that you - received to indicate where the next call should start. - in: query - name: Marker - required: false - schema: - maxLength: 320 - minLength: 1 - pattern: '[\u0020-\u00FF]+' - type: string - - description:

Use this only when paginating results to indicate the maximum - number of items you want in the response. If additional items exist beyond - the maximum you specify, the IsTruncated response element is - true.

If you do not include this parameter, the number - of items defaults to 100. Note that IAM might return fewer results, even - when there are more results available. In that case, the IsTruncated - response element returns true, and Marker contains - a value to include in the subsequent call that tells the service where to - continue from.

- in: query - name: MaxItems - required: false - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - '200': - content: - text/xml: - schema: - properties: - ListRolesResult: - $ref: '#/components/schemas/ListRolesResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: ListRoles - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Lists the IAM roles that have the specified path prefix. If - there are none, the operation returns an empty list. For more information - about roles, see Working - with roles.

IAM resource-listing operations return a subset - of the available attributes for the resource. For example, this operation - does not return tags, even though they are an attribute of the returned object. - To view all of the information for a role, see GetRole.

 -

You can paginate the results using the MaxItems and Marker - parameters.

- operationId: POST_ListRoles - parameters: - - description: Pagination limit - in: query - name: MaxItems - required: false - schema: - type: string - - description: Pagination token - in: query - name: Marker - required: false - schema: - type: string - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ListRolesRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - ListRolesResult: - $ref: '#/components/schemas/ListRolesResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: ListRoles - /?Action=ListSAMLProviderTags&Version=2010-05-08: - get: - description:

Lists the tags that are attached to the specified Security Assertion - Markup Language (SAML) identity provider. The returned list of tags is sorted - by tag key. For more information, see About - SAML 2.0-based federation.

For more information about tagging, - see Tagging - IAM resources in the IAM User Guide.

- operationId: GET_ListSAMLProviderTags - parameters: - - description: '

The ARN of the Security Assertion Markup Language (SAML) - identity provider whose tags you want to see.

This parameter allows - (through its regex pattern) - a string of characters consisting of upper and lowercase alphanumeric characters - with no spaces. You can also include any of the following characters: _+=,.@-

' - in: query - name: SAMLProviderArn - required: true - schema: - description:

The Amazon Resource Name (ARN). ARNs are unique identifiers - for Amazon Web Services resources.

For more information about ARNs, - go to Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference. -

- maxLength: 2048 - minLength: 20 - type: string - - description: Use this parameter only when paginating results and only after - you receive a response indicating that the results are truncated. Set it - to the value of the Marker element in the response that you - received to indicate where the next call should start. - in: query - name: Marker - required: false - schema: - maxLength: 320 - minLength: 1 - pattern: '[\u0020-\u00FF]+' - type: string - - description:

Use this only when paginating results to indicate the maximum - number of items you want in the response. If additional items exist beyond - the maximum you specify, the IsTruncated response element is - true.

If you do not include this parameter, the number - of items defaults to 100. Note that IAM might return fewer results, even - when there are more results available. In that case, the IsTruncated - response element returns true, and Marker contains - a value to include in the subsequent call that tells the service where to - continue from.

- in: query - name: MaxItems - required: false - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - '200': - content: - text/xml: - schema: - properties: - ListSAMLProviderTagsResult: - $ref: '#/components/schemas/ListSAMLProviderTagsResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - x-aws-operation-name: ListSAMLProviderTags - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Lists the tags that are attached to the specified Security Assertion - Markup Language (SAML) identity provider. The returned list of tags is sorted - by tag key. For more information, see About - SAML 2.0-based federation.

For more information about tagging, - see Tagging - IAM resources in the IAM User Guide.

- operationId: POST_ListSAMLProviderTags - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ListSAMLProviderTagsRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - ListSAMLProviderTagsResult: - $ref: '#/components/schemas/ListSAMLProviderTagsResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - x-aws-operation-name: ListSAMLProviderTags - /?Action=ListSAMLProviders&Version=2010-05-08: - get: - description:

Lists the SAML provider resource objects defined in IAM in the - account. IAM resource-listing operations return a subset of the available - attributes for the resource. For example, this operation does not return tags, - even though they are an attribute of the returned object. To view all of the - information for a SAML provider, see GetSAMLProvider.

-

This operation requires Signature - Version 4.

 - operationId: GET_ListSAMLProviders - parameters: [] - responses: - '200': - content: - text/xml: - schema: - properties: - ListSAMLProvidersResult: - $ref: '#/components/schemas/ListSAMLProvidersResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: ListSAMLProviders - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Lists the SAML provider resource objects defined in IAM in the - account. IAM resource-listing operations return a subset of the available - attributes for the resource. For example, this operation does not return tags, - even though they are an attribute of the returned object. To view all of the - information for a SAML provider, see GetSAMLProvider.

-

This operation requires Signature - Version 4.

 - operationId: POST_ListSAMLProviders - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ListSAMLProvidersRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - ListSAMLProvidersResult: - $ref: '#/components/schemas/ListSAMLProvidersResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: ListSAMLProviders - /?Action=ListSSHPublicKeys&Version=2010-05-08: - get: - description:

Returns information about the SSH public keys associated with - the specified IAM user. If none exists, the operation returns an empty list.

-

The SSH public keys returned by this operation are used only for authenticating - the IAM user to an CodeCommit repository. For more information about using - SSH keys to authenticate to an CodeCommit repository, see Set - up CodeCommit for SSH connections in the CodeCommit User Guide.

-

Although each user is limited to a small number of keys, you can still - paginate the results using the MaxItems and Marker - parameters.

- operationId: GET_ListSSHPublicKeys - parameters: - - description: '

The name of the IAM user to list SSH public keys for. If - none is specified, the UserName field is determined implicitly - based on the Amazon Web Services access key used to sign the request.

-

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: UserName - required: false - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: Use this parameter only when paginating results and only after - you receive a response indicating that the results are truncated. Set it - to the value of the Marker element in the response that you - received to indicate where the next call should start. - in: query - name: Marker - required: false - schema: - maxLength: 320 - minLength: 1 - pattern: '[\u0020-\u00FF]+' - type: string - - description:

Use this only when paginating results to indicate the maximum - number of items you want in the response. If additional items exist beyond - the maximum you specify, the IsTruncated response element is - true.

If you do not include this parameter, the number - of items defaults to 100. Note that IAM might return fewer results, even - when there are more results available. In that case, the IsTruncated - response element returns true, and Marker contains - a value to include in the subsequent call that tells the service where to - continue from.

- in: query - name: MaxItems - required: false - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - '200': - content: - text/xml: - schema: - properties: - ListSSHPublicKeysResult: - $ref: '#/components/schemas/ListSSHPublicKeysResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - x-aws-operation-name: ListSSHPublicKeys - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Returns information about the SSH public keys associated with - the specified IAM user. If none exists, the operation returns an empty list.

-

The SSH public keys returned by this operation are used only for authenticating - the IAM user to an CodeCommit repository. For more information about using - SSH keys to authenticate to an CodeCommit repository, see Set - up CodeCommit for SSH connections in the CodeCommit User Guide.

-

Although each user is limited to a small number of keys, you can still - paginate the results using the MaxItems and Marker - parameters.

- operationId: POST_ListSSHPublicKeys - parameters: - - description: Pagination limit - in: query - name: MaxItems - required: false - schema: - type: string - - description: Pagination token - in: query - name: Marker - required: false - schema: - type: string - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ListSSHPublicKeysRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - ListSSHPublicKeysResult: - $ref: '#/components/schemas/ListSSHPublicKeysResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - x-aws-operation-name: ListSSHPublicKeys - /?Action=ListServerCertificateTags&Version=2010-05-08: - get: - description:

Lists the tags that are attached to the specified IAM server - certificate. The returned list of tags is sorted by tag key. For more information - about tagging, see Tagging - IAM resources in the IAM User Guide.

For certificates - in a Region supported by Certificate Manager (ACM), we recommend that you - don't use IAM server certificates. Instead, use ACM to provision, manage, - and deploy your server certificates. For more information about IAM server - certificates, Working - with server certificates in the IAM User Guide.

 - operationId: GET_ListServerCertificateTags - parameters: - - description: '

The name of the IAM server certificate whose tags you want - to see.

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: ServerCertificateName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: Use this parameter only when paginating results and only after - you receive a response indicating that the results are truncated. Set it - to the value of the Marker element in the response that you - received to indicate where the next call should start. - in: query - name: Marker - required: false - schema: - maxLength: 320 - minLength: 1 - pattern: '[\u0020-\u00FF]+' - type: string - - description:

Use this only when paginating results to indicate the maximum - number of items you want in the response. If additional items exist beyond - the maximum you specify, the IsTruncated response element is - true.

If you do not include this parameter, the number - of items defaults to 100. Note that IAM might return fewer results, even - when there are more results available. In that case, the IsTruncated - response element returns true, and Marker contains - a value to include in the subsequent call that tells the service where to - continue from.

- in: query - name: MaxItems - required: false - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - '200': - content: - text/xml: - schema: - properties: - ListServerCertificateTagsResult: - $ref: '#/components/schemas/ListServerCertificateTagsResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: ListServerCertificateTags - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Lists the tags that are attached to the specified IAM server - certificate. The returned list of tags is sorted by tag key. For more information - about tagging, see Tagging - IAM resources in the IAM User Guide.

For certificates - in a Region supported by Certificate Manager (ACM), we recommend that you - don't use IAM server certificates. Instead, use ACM to provision, manage, - and deploy your server certificates. For more information about IAM server - certificates, Working - with server certificates in the IAM User Guide.

 - operationId: POST_ListServerCertificateTags - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ListServerCertificateTagsRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - ListServerCertificateTagsResult: - $ref: '#/components/schemas/ListServerCertificateTagsResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: ListServerCertificateTags - /?Action=ListServerCertificates&Version=2010-05-08: - get: - description:

Lists the server certificates stored in IAM that have the specified - path prefix. If none exist, the operation returns an empty list.

You - can paginate the results using the MaxItems and Marker - parameters.

For more information about working with server certificates, - see Working - with server certificates in the IAM User Guide. This topic also - includes a list of Amazon Web Services services that can use the server certificates - that you manage with IAM.

IAM resource-listing operations return - a subset of the available attributes for the resource. For example, this operation - does not return tags, even though they are an attribute of the returned object. - To view all of the information for a servercertificate, see GetServerCertificate.

- - operationId: GET_ListServerCertificates - parameters: - - description: '

The path prefix for filtering the results. For example: - /company/servercerts would get all server certificates for - which the path starts with /company/servercerts.

This - parameter is optional. If it is not included, it defaults to a slash (/), - listing all server certificates. This parameter allows (through its regex - pattern) a string of characters consisting of either a forward slash - (/) by itself or a string that must begin and end with forward slashes. - In addition, it can contain any ASCII character from the ! (\u0021) - through the DEL character (\u007F), including most punctuation - characters, digits, and upper and lowercased letters.

' - in: query - name: PathPrefix - required: false - schema: - maxLength: 512 - minLength: 1 - pattern: \u002F[\u0021-\u007F]* - type: string - - description: Use this parameter only when paginating results and only after - you receive a response indicating that the results are truncated. Set it - to the value of the Marker element in the response that you - received to indicate where the next call should start. - in: query - name: Marker - required: false - schema: - maxLength: 320 - minLength: 1 - pattern: '[\u0020-\u00FF]+' - type: string - - description:

Use this only when paginating results to indicate the maximum - number of items you want in the response. If additional items exist beyond - the maximum you specify, the IsTruncated response element is - true.

If you do not include this parameter, the number - of items defaults to 100. Note that IAM might return fewer results, even - when there are more results available. In that case, the IsTruncated - response element returns true, and Marker contains - a value to include in the subsequent call that tells the service where to - continue from.

- in: query - name: MaxItems - required: false - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - '200': - content: - text/xml: - schema: - properties: - ListServerCertificatesResult: - $ref: '#/components/schemas/ListServerCertificatesResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: ListServerCertificates - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Lists the server certificates stored in IAM that have the specified - path prefix. If none exist, the operation returns an empty list.

You - can paginate the results using the MaxItems and Marker - parameters.

For more information about working with server certificates, - see Working - with server certificates in the IAM User Guide. This topic also - includes a list of Amazon Web Services services that can use the server certificates - that you manage with IAM.

IAM resource-listing operations return - a subset of the available attributes for the resource. For example, this operation - does not return tags, even though they are an attribute of the returned object. - To view all of the information for a servercertificate, see GetServerCertificate.

- - operationId: POST_ListServerCertificates - parameters: - - description: Pagination limit - in: query - name: MaxItems - required: false - schema: - type: string - - description: Pagination token - in: query - name: Marker - required: false - schema: - type: string - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ListServerCertificatesRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - ListServerCertificatesResult: - $ref: '#/components/schemas/ListServerCertificatesResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: ListServerCertificates - /?Action=ListServiceSpecificCredentials&Version=2010-05-08: - get: - description: Returns information about the service-specific credentials associated - with the specified IAM user. If none exists, the operation returns an empty - list. The service-specific credentials returned by this operation are used - only for authenticating the IAM user to a specific service. For more information - about using service-specific credentials to authenticate to an Amazon Web - Services service, see Set - up service-specific credentials in the CodeCommit User Guide. - operationId: GET_ListServiceSpecificCredentials - parameters: - - description: '

The name of the user whose service-specific credentials you - want information about. If this value is not specified, then the operation - assumes the user whose credentials are used to call the operation.

This - parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: UserName - required: false - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: Filters the returned results to only those for the specified - Amazon Web Services service. If not specified, then Amazon Web Services - returns service-specific credentials for all services. - in: query - name: ServiceName - required: false - schema: - type: string - responses: - '200': - content: - text/xml: - schema: - properties: - ListServiceSpecificCredentialsResult: - $ref: '#/components/schemas/ListServiceSpecificCredentialsResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceNotSupportedException' - description: ServiceNotSupportedException - x-aws-operation-name: ListServiceSpecificCredentials - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description: Returns information about the service-specific credentials associated - with the specified IAM user. If none exists, the operation returns an empty - list. The service-specific credentials returned by this operation are used - only for authenticating the IAM user to a specific service. For more information - about using service-specific credentials to authenticate to an Amazon Web - Services service, see Set - up service-specific credentials in the CodeCommit User Guide. - operationId: POST_ListServiceSpecificCredentials - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ListServiceSpecificCredentialsRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - ListServiceSpecificCredentialsResult: - $ref: '#/components/schemas/ListServiceSpecificCredentialsResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceNotSupportedException' - description: ServiceNotSupportedException - x-aws-operation-name: ListServiceSpecificCredentials - /?Action=ListSigningCertificates&Version=2010-05-08: - get: - description:

Returns information about the signing certificates associated - with the specified IAM user. If none exists, the operation returns an empty - list.

Although each user is limited to a small number of signing certificates, - you can still paginate the results using the MaxItems and Marker - parameters.

If the UserName field is not specified, the - user name is determined implicitly based on the Amazon Web Services access - key ID used to sign the request for this operation. This operation works for - access keys under the Amazon Web Services account. Consequently, you can use - this operation to manage Amazon Web Services account root user credentials - even if the Amazon Web Services account has no associated users.

- operationId: GET_ListSigningCertificates - parameters: - - description: '

The name of the IAM user whose signing certificates you want - to examine.

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: UserName - required: false - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: Use this parameter only when paginating results and only after - you receive a response indicating that the results are truncated. Set it - to the value of the Marker element in the response that you - received to indicate where the next call should start. - in: query - name: Marker - required: false - schema: - maxLength: 320 - minLength: 1 - pattern: '[\u0020-\u00FF]+' - type: string - - description:

Use this only when paginating results to indicate the maximum - number of items you want in the response. If additional items exist beyond - the maximum you specify, the IsTruncated response element is - true.

If you do not include this parameter, the number - of items defaults to 100. Note that IAM might return fewer results, even - when there are more results available. In that case, the IsTruncated - response element returns true, and Marker contains - a value to include in the subsequent call that tells the service where to - continue from.

- in: query - name: MaxItems - required: false - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - '200': - content: - text/xml: - schema: - properties: - ListSigningCertificatesResult: - $ref: '#/components/schemas/ListSigningCertificatesResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: ListSigningCertificates - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Returns information about the signing certificates associated - with the specified IAM user. If none exists, the operation returns an empty - list.

Although each user is limited to a small number of signing certificates, - you can still paginate the results using the MaxItems and Marker - parameters.

If the UserName field is not specified, the - user name is determined implicitly based on the Amazon Web Services access - key ID used to sign the request for this operation. This operation works for - access keys under the Amazon Web Services account. Consequently, you can use - this operation to manage Amazon Web Services account root user credentials - even if the Amazon Web Services account has no associated users.

- operationId: POST_ListSigningCertificates - parameters: - - description: Pagination limit - in: query - name: MaxItems - required: false - schema: - type: string - - description: Pagination token - in: query - name: Marker - required: false - schema: - type: string - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ListSigningCertificatesRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - ListSigningCertificatesResult: - $ref: '#/components/schemas/ListSigningCertificatesResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: ListSigningCertificates - /?Action=ListUserPolicies&Version=2010-05-08: - get: - description:

Lists the names of the inline policies embedded in the specified - IAM user.

An IAM user can also have managed policies attached to it. - To list the managed policies that are attached to a user, use ListAttachedUserPolicies. - For more information about policies, see Managed - policies and inline policies in the IAM User Guide.

You - can paginate the results using the MaxItems and Marker - parameters. If there are no inline policies embedded with the specified user, - the operation returns an empty list.

- operationId: GET_ListUserPolicies - parameters: - - description: '

The name of the user to list policies for.

This parameter - allows (through its regex pattern) - a string of characters consisting of upper and lowercase alphanumeric characters - with no spaces. You can also include any of the following characters: _+=,.@-

' - in: query - name: UserName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: Use this parameter only when paginating results and only after - you receive a response indicating that the results are truncated. Set it - to the value of the Marker element in the response that you - received to indicate where the next call should start. - in: query - name: Marker - required: false - schema: - maxLength: 320 - minLength: 1 - pattern: '[\u0020-\u00FF]+' - type: string - - description:

Use this only when paginating results to indicate the maximum - number of items you want in the response. If additional items exist beyond - the maximum you specify, the IsTruncated response element is - true.

If you do not include this parameter, the number - of items defaults to 100. Note that IAM might return fewer results, even - when there are more results available. In that case, the IsTruncated - response element returns true, and Marker contains - a value to include in the subsequent call that tells the service where to - continue from.

- in: query - name: MaxItems - required: false - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - '200': - content: - text/xml: - schema: - properties: - ListUserPoliciesResult: - $ref: '#/components/schemas/ListUserPoliciesResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: ListUserPolicies - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Lists the names of the inline policies embedded in the specified - IAM user.

An IAM user can also have managed policies attached to it. - To list the managed policies that are attached to a user, use ListAttachedUserPolicies. - For more information about policies, see Managed - policies and inline policies in the IAM User Guide.

You - can paginate the results using the MaxItems and Marker - parameters. If there are no inline policies embedded with the specified user, - the operation returns an empty list.

- operationId: POST_ListUserPolicies - parameters: - - description: Pagination limit - in: query - name: MaxItems - required: false - schema: - type: string - - description: Pagination token - in: query - name: Marker - required: false - schema: - type: string - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ListUserPoliciesRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - ListUserPoliciesResult: - $ref: '#/components/schemas/ListUserPoliciesResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: ListUserPolicies - /?Action=ListUserTags&Version=2010-05-08: - get: - description: Lists the tags that are attached to the specified IAM user. The - returned list of tags is sorted by tag key. For more information about tagging, - see Tagging - IAM resources in the IAM User Guide. - operationId: GET_ListUserTags - parameters: - - description: '

The name of the IAM user whose tags you want to see.

-

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: UserName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: Use this parameter only when paginating results and only after - you receive a response indicating that the results are truncated. Set it - to the value of the Marker element in the response that you - received to indicate where the next call should start. - in: query - name: Marker - required: false - schema: - maxLength: 320 - minLength: 1 - pattern: '[\u0020-\u00FF]+' - type: string - - description:

Use this only when paginating results to indicate the maximum - number of items you want in the response. If additional items exist beyond - the maximum you specify, the IsTruncated response element is - true.

If you do not include this parameter, the number - of items defaults to 100. Note that IAM might return fewer results, even - when there are more results available. In that case, the IsTruncated - response element returns true, and Marker contains - a value to include in the subsequent call that tells the service where to - continue from.

- in: query - name: MaxItems - required: false - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - '200': - content: - text/xml: - schema: - properties: - ListUserTagsResult: - $ref: '#/components/schemas/ListUserTagsResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: ListUserTags - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description: Lists the tags that are attached to the specified IAM user. The - returned list of tags is sorted by tag key. For more information about tagging, - see Tagging - IAM resources in the IAM User Guide. - operationId: POST_ListUserTags - parameters: - - description: Pagination limit - in: query - name: MaxItems - required: false - schema: - type: string - - description: Pagination token - in: query - name: Marker - required: false - schema: - type: string - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ListUserTagsRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - ListUserTagsResult: - $ref: '#/components/schemas/ListUserTagsResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: ListUserTags - /?Action=ListUsers&Version=2010-05-08: - get: - description:

Lists the IAM users that have the specified path prefix. If - no path prefix is specified, the operation returns all users in the Amazon - Web Services account. If there are none, the operation returns an empty list.

-

IAM resource-listing operations return a subset of the available - attributes for the resource. For example, this operation does not return tags, - even though they are an attribute of the returned object. To view all of the - information for a user, see GetUser.

You can paginate - the results using the MaxItems and Marker parameters.

- operationId: GET_ListUsers - parameters: - - description: '

The path prefix for filtering the results. For example: - /division_abc/subdivision_xyz/, which would get all user names - whose path starts with /division_abc/subdivision_xyz/.

-

This parameter is optional. If it is not included, it defaults to a slash - (/), listing all user names. This parameter allows (through its regex - pattern) a string of characters consisting of either a forward slash - (/) by itself or a string that must begin and end with forward slashes. - In addition, it can contain any ASCII character from the ! (\u0021) - through the DEL character (\u007F), including most punctuation - characters, digits, and upper and lowercased letters.

' - in: query - name: PathPrefix - required: false - schema: - maxLength: 512 - minLength: 1 - pattern: \u002F[\u0021-\u007F]* - type: string - - description: Use this parameter only when paginating results and only after - you receive a response indicating that the results are truncated. Set it - to the value of the Marker element in the response that you - received to indicate where the next call should start. - in: query - name: Marker - required: false - schema: - maxLength: 320 - minLength: 1 - pattern: '[\u0020-\u00FF]+' - type: string - - description:

Use this only when paginating results to indicate the maximum - number of items you want in the response. If additional items exist beyond - the maximum you specify, the IsTruncated response element is - true.

If you do not include this parameter, the number - of items defaults to 100. Note that IAM might return fewer results, even - when there are more results available. In that case, the IsTruncated - response element returns true, and Marker contains - a value to include in the subsequent call that tells the service where to - continue from.

- in: query - name: MaxItems - required: false - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - '200': - content: - text/xml: - schema: - properties: - ListUsersResult: - $ref: '#/components/schemas/ListUsersResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: ListUsers - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Lists the IAM users that have the specified path prefix. If - no path prefix is specified, the operation returns all users in the Amazon - Web Services account. If there are none, the operation returns an empty list.

-

IAM resource-listing operations return a subset of the available - attributes for the resource. For example, this operation does not return tags, - even though they are an attribute of the returned object. To view all of the - information for a user, see GetUser.

You can paginate - the results using the MaxItems and Marker parameters.

- operationId: POST_ListUsers - parameters: - - description: Pagination limit - in: query - name: MaxItems - required: false - schema: - type: string - - description: Pagination token - in: query - name: Marker - required: false - schema: - type: string - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ListUsersRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - ListUsersResult: - $ref: '#/components/schemas/ListUsersResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: ListUsers - /?Action=ListVirtualMFADevices&Version=2010-05-08: - get: - description:

Lists the virtual MFA devices defined in the Amazon Web Services - account by assignment status. If you do not specify an assignment status, - the operation returns a list of all virtual MFA devices. Assignment status - can be Assigned, Unassigned, or Any.

-

IAM resource-listing operations return a subset of the available - attributes for the resource. For example, this operation does not return tags, - even though they are an attribute of the returned object. To view tag information - for a virtual MFA device, see ListMFADeviceTags.

You - can paginate the results using the MaxItems and Marker - parameters.

- operationId: GET_ListVirtualMFADevices - parameters: - - description: ' The status (Unassigned or Assigned) - of the devices to list. If you do not specify an AssignmentStatus, - the operation defaults to Any, which lists both assigned and - unassigned virtual MFA devices.,' - in: query - name: AssignmentStatus - required: false - schema: - enum: - - Assigned - - Unassigned - - Any - type: string - - description: Use this parameter only when paginating results and only after - you receive a response indicating that the results are truncated. Set it - to the value of the Marker element in the response that you - received to indicate where the next call should start. - in: query - name: Marker - required: false - schema: - maxLength: 320 - minLength: 1 - pattern: '[\u0020-\u00FF]+' - type: string - - description:

Use this only when paginating results to indicate the maximum - number of items you want in the response. If additional items exist beyond - the maximum you specify, the IsTruncated response element is - true.

If you do not include this parameter, the number - of items defaults to 100. Note that IAM might return fewer results, even - when there are more results available. In that case, the IsTruncated - response element returns true, and Marker contains - a value to include in the subsequent call that tells the service where to - continue from.

- in: query - name: MaxItems - required: false - schema: - maximum: 1000 - minimum: 1 - type: integer - responses: - '200': - content: - text/xml: - schema: - properties: - ListVirtualMFADevicesResult: - $ref: '#/components/schemas/ListVirtualMFADevicesResponse' - type: object - description: Success - x-aws-operation-name: ListVirtualMFADevices - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Lists the virtual MFA devices defined in the Amazon Web Services - account by assignment status. If you do not specify an assignment status, - the operation returns a list of all virtual MFA devices. Assignment status - can be Assigned, Unassigned, or Any.

-

IAM resource-listing operations return a subset of the available - attributes for the resource. For example, this operation does not return tags, - even though they are an attribute of the returned object. To view tag information - for a virtual MFA device, see ListMFADeviceTags.

You - can paginate the results using the MaxItems and Marker - parameters.

- operationId: POST_ListVirtualMFADevices - parameters: - - description: Pagination limit - in: query - name: MaxItems - required: false - schema: - type: string - - description: Pagination token - in: query - name: Marker - required: false - schema: - type: string - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ListVirtualMFADevicesRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - ListVirtualMFADevicesResult: - $ref: '#/components/schemas/ListVirtualMFADevicesResponse' - type: object - description: Success - x-aws-operation-name: ListVirtualMFADevices - /?Action=PutGroupPolicy&Version=2010-05-08: - get: - description:

Adds or updates an inline policy document that is embedded in - the specified IAM group.

A user can also have managed policies attached - to it. To attach a managed policy to a group, use AttachGroupPolicy. - To create a new managed policy, use CreatePolicy. For information about - policies, see Managed - policies and inline policies in the IAM User Guide.

For - information about the maximum number of inline policies that you can embed - in a group, see IAM - and STS quotas in the IAM User Guide.

Because policy - documents can be large, you should use POST rather than GET when calling PutGroupPolicy. - For general information about using the Query API with IAM, see Making - query requests in the IAM User Guide.

 - operationId: GET_PutGroupPolicy - parameters: - - description: '

The name of the group to associate the policy with.

This - parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-.

' - in: query - name: GroupName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: '

The name of the policy document.

This parameter allows - (through its regex pattern) - a string of characters consisting of upper and lowercase alphanumeric characters - with no spaces. You can also include any of the following characters: _+=,.@-

' - in: query - name: PolicyName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description:

The policy document.

You must provide policies in JSON - format in IAM. However, for CloudFormation templates formatted in YAML, - you can provide the policy in JSON or YAML format. CloudFormation always - converts a YAML policy to JSON format before submitting it to = IAM.

-

The regex pattern used - to validate this parameter is a string of characters consisting of the following:

-

  • Any printable ASCII character ranging from the space character - (\u0020) through the end of the ASCII character range

    • -

  • The printable characters in the Basic Latin and Latin-1 Supplement - character set (through \u00FF)

  • The special - characters tab (\u0009), line feed (\u000A), and - carriage return (\u000D)

- in: query - name: PolicyDocument - required: true - schema: - maxLength: 131072 - minLength: 1 - pattern: '[\u0009\u000A\u000D\u0020-\u00FF]+' - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/MalformedPolicyDocumentException' - description: MalformedPolicyDocumentException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: PutGroupPolicy - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Adds or updates an inline policy document that is embedded in - the specified IAM group.

A user can also have managed policies attached - to it. To attach a managed policy to a group, use AttachGroupPolicy. - To create a new managed policy, use CreatePolicy. For information about - policies, see Managed - policies and inline policies in the IAM User Guide.

For - information about the maximum number of inline policies that you can embed - in a group, see IAM - and STS quotas in the IAM User Guide.

Because policy - documents can be large, you should use POST rather than GET when calling PutGroupPolicy. - For general information about using the Query API with IAM, see Making - query requests in the IAM User Guide.

 - operationId: POST_PutGroupPolicy - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/PutGroupPolicyRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/MalformedPolicyDocumentException' - description: MalformedPolicyDocumentException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: PutGroupPolicy - /?Action=PutRolePermissionsBoundary&Version=2010-05-08: - get: - description:

Adds or updates the policy that is specified as the IAM role's - permissions boundary. You can use an Amazon Web Services managed policy or - a customer managed policy to set the boundary for a role. Use the boundary - to control the maximum permissions that the role can have. Setting a permissions - boundary is an advanced feature that can affect the permissions for the role.

-

You cannot set the boundary for a service-linked role.

-

Policies used as permissions boundaries do not provide permissions. You - must also attach a permissions 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.

- operationId: GET_PutRolePermissionsBoundary - parameters: - - description: The name (friendly name, not ARN) of the IAM role for which you - want to set the permissions boundary. - in: query - name: RoleName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: The ARN of the policy that is used to set the permissions boundary - for the role. - in: query - name: PermissionsBoundary - required: true - schema: - description:

The Amazon Resource Name (ARN). ARNs are unique identifiers - for Amazon Web Services resources.

For more information about ARNs, - go to Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference. -

- maxLength: 2048 - minLength: 20 - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/UnmodifiableEntityException' - description: UnmodifiableEntityException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/PolicyNotAttachableException' - description: PolicyNotAttachableException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: PutRolePermissionsBoundary - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Adds or updates the policy that is specified as the IAM role's - permissions boundary. You can use an Amazon Web Services managed policy or - a customer managed policy to set the boundary for a role. Use the boundary - to control the maximum permissions that the role can have. Setting a permissions - boundary is an advanced feature that can affect the permissions for the role.

-

You cannot set the boundary for a service-linked role.

-

Policies used as permissions boundaries do not provide permissions. You - must also attach a permissions 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.

- operationId: POST_PutRolePermissionsBoundary - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/PutRolePermissionsBoundaryRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/UnmodifiableEntityException' - description: UnmodifiableEntityException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/PolicyNotAttachableException' - description: PolicyNotAttachableException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: PutRolePermissionsBoundary - /?Action=PutRolePolicy&Version=2010-05-08: - get: - description:

Adds or updates an inline policy document that is embedded in - the specified IAM role.

When you embed an inline policy in a role, - the inline policy is used as part of the role's access (permissions) policy. - The role's trust policy is created at the same time as the role, using CreateRole. - You can update a role's trust policy using UpdateAssumeRolePolicy. - For more information about IAM roles, see Using - roles to delegate permissions and federate identities.

A role can - also have a managed policy attached to it. To attach a managed policy to a - role, use AttachRolePolicy. To create a new managed policy, use CreatePolicy. - For information about policies, see Managed - policies and inline policies in the IAM User Guide.

For - information about the maximum number of inline policies that you can embed - with a role, see IAM - and STS quotas in the IAM User Guide.

Because policy - documents can be large, you should use POST rather than GET when calling PutRolePolicy. - For general information about using the Query API with IAM, see Making - query requests in the IAM User Guide.

 - operationId: GET_PutRolePolicy - parameters: - - description: '

The name of the role to associate the policy with.

This - parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: RoleName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: '

The name of the policy document.

This parameter allows - (through its regex pattern) - a string of characters consisting of upper and lowercase alphanumeric characters - with no spaces. You can also include any of the following characters: _+=,.@-

' - in: query - name: PolicyName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description:

The policy document.

You must provide policies in JSON - format in IAM. However, for CloudFormation templates formatted in YAML, - you can provide the policy in JSON or YAML format. CloudFormation always - converts a YAML policy to JSON format before submitting it to IAM.

The - regex pattern used to validate - this parameter is a string of characters consisting of the following:

-

  • Any printable ASCII character ranging from the space character - (\u0020) through the end of the ASCII character range

    • -

  • The printable characters in the Basic Latin and Latin-1 Supplement - character set (through \u00FF)

  • The special - characters tab (\u0009), line feed (\u000A), and - carriage return (\u000D)

- in: query - name: PolicyDocument - required: true - schema: - maxLength: 131072 - minLength: 1 - pattern: '[\u0009\u000A\u000D\u0020-\u00FF]+' - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/MalformedPolicyDocumentException' - description: MalformedPolicyDocumentException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/UnmodifiableEntityException' - description: UnmodifiableEntityException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: PutRolePolicy - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Adds or updates an inline policy document that is embedded in - the specified IAM role.

When you embed an inline policy in a role, - the inline policy is used as part of the role's access (permissions) policy. - The role's trust policy is created at the same time as the role, using CreateRole. - You can update a role's trust policy using UpdateAssumeRolePolicy. - For more information about IAM roles, see Using - roles to delegate permissions and federate identities.

A role can - also have a managed policy attached to it. To attach a managed policy to a - role, use AttachRolePolicy. To create a new managed policy, use CreatePolicy. - For information about policies, see Managed - policies and inline policies in the IAM User Guide.

For - information about the maximum number of inline policies that you can embed - with a role, see IAM - and STS quotas in the IAM User Guide.

Because policy - documents can be large, you should use POST rather than GET when calling PutRolePolicy. - For general information about using the Query API with IAM, see Making - query requests in the IAM User Guide.

 - operationId: POST_PutRolePolicy - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/PutRolePolicyRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/MalformedPolicyDocumentException' - description: MalformedPolicyDocumentException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/UnmodifiableEntityException' - description: UnmodifiableEntityException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: PutRolePolicy - /?Action=PutUserPermissionsBoundary&Version=2010-05-08: - get: - description:

Adds or updates the policy that is specified as the IAM user's - permissions boundary. You can use an Amazon Web Services managed policy or - a customer managed policy to set the boundary for a user. Use the boundary - to control the maximum permissions that the user can have. Setting a permissions - boundary is an advanced feature that can affect the permissions for the user.

-

Policies that are used as permissions boundaries do not provide - permissions. You must also attach a permissions policy to the user. To learn - how the effective permissions for a user are evaluated, see IAM - JSON policy evaluation logic in the IAM User Guide.

- operationId: GET_PutUserPermissionsBoundary - parameters: - - description: The name (friendly name, not ARN) of the IAM user for which you - want to set the permissions boundary. - in: query - name: UserName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: The ARN of the policy that is used to set the permissions boundary - for the user. - in: query - name: PermissionsBoundary - required: true - schema: - description:

The Amazon Resource Name (ARN). ARNs are unique identifiers - for Amazon Web Services resources.

For more information about ARNs, - go to Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference. -

- maxLength: 2048 - minLength: 20 - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/PolicyNotAttachableException' - description: PolicyNotAttachableException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: PutUserPermissionsBoundary - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Adds or updates the policy that is specified as the IAM user's - permissions boundary. You can use an Amazon Web Services managed policy or - a customer managed policy to set the boundary for a user. Use the boundary - to control the maximum permissions that the user can have. Setting a permissions - boundary is an advanced feature that can affect the permissions for the user.

-

Policies that are used as permissions boundaries do not provide - permissions. You must also attach a permissions policy to the user. To learn - how the effective permissions for a user are evaluated, see IAM - JSON policy evaluation logic in the IAM User Guide.

- operationId: POST_PutUserPermissionsBoundary - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/PutUserPermissionsBoundaryRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/PolicyNotAttachableException' - description: PolicyNotAttachableException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: PutUserPermissionsBoundary - /?Action=PutUserPolicy&Version=2010-05-08: - get: - description:

Adds or updates an inline policy document that is embedded in - the specified IAM user.

An IAM user can also have a managed policy - attached to it. To attach a managed policy to a user, use AttachUserPolicy. - To create a new managed policy, use CreatePolicy. For information about - policies, see Managed - policies and inline policies in the IAM User Guide.

For - information about the maximum number of inline policies that you can embed - in a user, see IAM - and STS quotas in the IAM User Guide.

Because policy - documents can be large, you should use POST rather than GET when calling PutUserPolicy. - For general information about using the Query API with IAM, see Making - query requests in the IAM User Guide.

 - operationId: GET_PutUserPolicy - parameters: - - description: '

The name of the user to associate the policy with.

This - parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: UserName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: '

The name of the policy document.

This parameter allows - (through its regex pattern) - a string of characters consisting of upper and lowercase alphanumeric characters - with no spaces. You can also include any of the following characters: _+=,.@-

' - in: query - name: PolicyName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description:

The policy document.

You must provide policies in JSON - format in IAM. However, for CloudFormation templates formatted in YAML, - you can provide the policy in JSON or YAML format. CloudFormation always - converts a YAML policy to JSON format before submitting it to IAM.

The - regex pattern used to validate - this parameter is a string of characters consisting of the following:

-

  • Any printable ASCII character ranging from the space character - (\u0020) through the end of the ASCII character range

    • -

  • The printable characters in the Basic Latin and Latin-1 Supplement - character set (through \u00FF)

  • The special - characters tab (\u0009), line feed (\u000A), and - carriage return (\u000D)

- in: query - name: PolicyDocument - required: true - schema: - maxLength: 131072 - minLength: 1 - pattern: '[\u0009\u000A\u000D\u0020-\u00FF]+' - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/MalformedPolicyDocumentException' - description: MalformedPolicyDocumentException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: PutUserPolicy - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Adds or updates an inline policy document that is embedded in - the specified IAM user.

An IAM user can also have a managed policy - attached to it. To attach a managed policy to a user, use AttachUserPolicy. - To create a new managed policy, use CreatePolicy. For information about - policies, see Managed - policies and inline policies in the IAM User Guide.

For - information about the maximum number of inline policies that you can embed - in a user, see IAM - and STS quotas in the IAM User Guide.

Because policy - documents can be large, you should use POST rather than GET when calling PutUserPolicy. - For general information about using the Query API with IAM, see Making - query requests in the IAM User Guide.

 - operationId: POST_PutUserPolicy - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/PutUserPolicyRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/MalformedPolicyDocumentException' - description: MalformedPolicyDocumentException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: PutUserPolicy - /?Action=RemoveClientIDFromOpenIDConnectProvider&Version=2010-05-08: - get: - description:

Removes the specified client ID (also known as audience) from - the list of client IDs registered for the specified IAM OpenID Connect (OIDC) - provider resource object.

This operation is idempotent; it does not - fail or return an error if you try to remove a client ID that does not exist.

- operationId: GET_RemoveClientIDFromOpenIDConnectProvider - parameters: - - description:

The Amazon Resource Name (ARN) of the IAM OIDC provider resource - to remove the client ID from. You can get a list of OIDC provider ARNs by - using the ListOpenIDConnectProviders operation.

For more information - about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.

- in: query - name: OpenIDConnectProviderArn - required: true - schema: - description:

The Amazon Resource Name (ARN). ARNs are unique identifiers - for Amazon Web Services resources.

For more information about ARNs, - go to Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference. -

- maxLength: 2048 - minLength: 20 - type: string - - description: The client ID (also known as audience) to remove from the IAM - OIDC provider resource. For more information about client IDs, see CreateOpenIDConnectProvider. - in: query - name: ClientID - required: true - schema: - maxLength: 255 - minLength: 1 - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: RemoveClientIDFromOpenIDConnectProvider - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Removes the specified client ID (also known as audience) from - the list of client IDs registered for the specified IAM OpenID Connect (OIDC) - provider resource object.

This operation is idempotent; it does not - fail or return an error if you try to remove a client ID that does not exist.

- operationId: POST_RemoveClientIDFromOpenIDConnectProvider - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/RemoveClientIDFromOpenIDConnectProviderRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: RemoveClientIDFromOpenIDConnectProvider - /?Action=RemoveRoleFromInstanceProfile&Version=2010-05-08: - get: - description:

Removes the specified IAM role from the specified EC2 instance - profile.

Make sure that you do not have any Amazon EC2 - instances running with the role you are about to remove from the instance - profile. Removing a role from an instance profile that is associated with - a running instance might break any applications running on the instance.

-

For more information about IAM roles, see Working - with roles. For more information about instance profiles, see About - instance profiles.

- operationId: GET_RemoveRoleFromInstanceProfile - parameters: - - description: '

The name of the instance profile to update.

This parameter - allows (through its regex pattern) - a string of characters consisting of upper and lowercase alphanumeric characters - with no spaces. You can also include any of the following characters: _+=,.@-

' - in: query - name: InstanceProfileName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: '

The name of the role to remove.

This parameter allows - (through its regex pattern) - a string of characters consisting of upper and lowercase alphanumeric characters - with no spaces. You can also include any of the following characters: _+=,.@-

' - in: query - name: RoleName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/UnmodifiableEntityException' - description: UnmodifiableEntityException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: RemoveRoleFromInstanceProfile - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Removes the specified IAM role from the specified EC2 instance - profile.

Make sure that you do not have any Amazon EC2 - instances running with the role you are about to remove from the instance - profile. Removing a role from an instance profile that is associated with - a running instance might break any applications running on the instance.

-

For more information about IAM roles, see Working - with roles. For more information about instance profiles, see About - instance profiles.

- operationId: POST_RemoveRoleFromInstanceProfile - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/RemoveRoleFromInstanceProfileRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/UnmodifiableEntityException' - description: UnmodifiableEntityException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: RemoveRoleFromInstanceProfile - /?Action=RemoveUserFromGroup&Version=2010-05-08: - get: - description: Removes the specified user from the specified group. - operationId: GET_RemoveUserFromGroup - parameters: - - description: '

The name of the group to update.

This parameter allows - (through its regex pattern) - a string of characters consisting of upper and lowercase alphanumeric characters - with no spaces. You can also include any of the following characters: _+=,.@-

' - in: query - name: GroupName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: '

The name of the user to remove.

This parameter allows - (through its regex pattern) - a string of characters consisting of upper and lowercase alphanumeric characters - with no spaces. You can also include any of the following characters: _+=,.@-

' - in: query - name: UserName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: RemoveUserFromGroup - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description: Removes the specified user from the specified group. - operationId: POST_RemoveUserFromGroup - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/RemoveUserFromGroupRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: RemoveUserFromGroup - /?Action=ResetServiceSpecificCredential&Version=2010-05-08: - get: - description: Resets the password for a service-specific credential. The new - password is Amazon Web Services generated and cryptographically strong. It - cannot be configured by the user. Resetting the password immediately invalidates - the previous password associated with this user. - operationId: GET_ResetServiceSpecificCredential - parameters: - - description: '

The name of the IAM user associated with the service-specific - credential. If this value is not specified, then the operation assumes the - user whose credentials are used to call the operation.

This parameter - allows (through its regex pattern) - a string of characters consisting of upper and lowercase alphanumeric characters - with no spaces. You can also include any of the following characters: _+=,.@-

' - in: query - name: UserName - required: false - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description:

The unique identifier of the service-specific credential.

-

This parameter allows (through its regex - pattern) a string of characters that can consist of any upper or lowercased - letter or digit.

- in: query - name: ServiceSpecificCredentialId - required: true - schema: - maxLength: 128 - minLength: 20 - pattern: '[\w]+' - type: string - responses: - '200': - content: - text/xml: - schema: - properties: - ResetServiceSpecificCredentialResult: - $ref: '#/components/schemas/ResetServiceSpecificCredentialResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - x-aws-operation-name: ResetServiceSpecificCredential - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description: Resets the password for a service-specific credential. The new - password is Amazon Web Services generated and cryptographically strong. It - cannot be configured by the user. Resetting the password immediately invalidates - the previous password associated with this user. - operationId: POST_ResetServiceSpecificCredential - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ResetServiceSpecificCredentialRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - ResetServiceSpecificCredentialResult: - $ref: '#/components/schemas/ResetServiceSpecificCredentialResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - x-aws-operation-name: ResetServiceSpecificCredential - /?Action=ResyncMFADevice&Version=2010-05-08: - get: - description:

Synchronizes the specified MFA device with its IAM resource - object on the Amazon Web Services servers.

For more information about - creating and working with virtual MFA devices, see Using - a virtual MFA device in the IAM User Guide.

- operationId: GET_ResyncMFADevice - parameters: - - description: '

The name of the user whose MFA device you want to resynchronize.

-

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: UserName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: '

Serial number that uniquely identifies the MFA device.

-

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: SerialNumber - required: true - schema: - maxLength: 256 - minLength: 9 - pattern: '[\w+=/:,.@-]+' - type: string - - description:

An authentication code emitted by the device.

The format - for this parameter is a sequence of six digits.

- in: query - name: AuthenticationCode1 - required: true - schema: - maxLength: 6 - minLength: 6 - pattern: '[\d]+' - type: string - - description:

A subsequent authentication code emitted by the device.

-

The format for this parameter is a sequence of six digits.

- in: query - name: AuthenticationCode2 - required: true - schema: - maxLength: 6 - minLength: 6 - pattern: '[\d]+' - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidAuthenticationCodeException' - description: InvalidAuthenticationCodeException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: ResyncMFADevice - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Synchronizes the specified MFA device with its IAM resource - object on the Amazon Web Services servers.

For more information about - creating and working with virtual MFA devices, see Using - a virtual MFA device in the IAM User Guide.

- operationId: POST_ResyncMFADevice - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ResyncMFADeviceRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidAuthenticationCodeException' - description: InvalidAuthenticationCodeException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: ResyncMFADevice - /?Action=SetDefaultPolicyVersion&Version=2010-05-08: - get: - description:

Sets the specified version of the specified policy as the policy's - default (operative) version.

This operation affects all users, groups, - and roles that the policy is attached to. To list the users, groups, and roles - that the policy is attached to, use ListEntitiesForPolicy.

For - information about managed policies, see Managed - policies and inline policies in the IAM User Guide.

- operationId: GET_SetDefaultPolicyVersion - parameters: - - description:

The Amazon Resource Name (ARN) of the IAM policy whose default - version you want to set.

For more information about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.

- in: query - name: PolicyArn - required: true - schema: - description:

The Amazon Resource Name (ARN). ARNs are unique identifiers - for Amazon Web Services resources.

For more information about ARNs, - go to Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference. -

- maxLength: 2048 - minLength: 20 - type: string - - description:

The version of the policy to set as the default (operative) - version.

For more information about managed policy versions, see - Versioning - for managed policies in the IAM User Guide.

- in: query - name: VersionId - required: true - schema: - pattern: v[1-9][0-9]*(\.[A-Za-z0-9-]*)? - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: SetDefaultPolicyVersion - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Sets the specified version of the specified policy as the policy's - default (operative) version.

This operation affects all users, groups, - and roles that the policy is attached to. To list the users, groups, and roles - that the policy is attached to, use ListEntitiesForPolicy.

For - information about managed policies, see Managed - policies and inline policies in the IAM User Guide.

- operationId: POST_SetDefaultPolicyVersion - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/SetDefaultPolicyVersionRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: SetDefaultPolicyVersion - /?Action=SetSecurityTokenServicePreferences&Version=2010-05-08: - get: - description:

Sets the specified version of the global endpoint token as the - token version used for the Amazon Web Services account.

By default, - Security Token Service (STS) is available as a global service, and all STS - requests go to a single endpoint at https://sts.amazonaws.com. - Amazon Web Services recommends using Regional STS endpoints to reduce latency, - build in redundancy, and increase session token availability. For information - about Regional endpoints for STS, see Security - Token Service endpoints and quotas in the Amazon Web Services General - Reference.

If you make an STS call to the global endpoint, the - resulting session tokens might be valid in some Regions but not others. It - depends on the version that is set in this operation. Version 1 tokens are - valid only in Amazon Web Services Regions that are available by default. These - tokens do not work in manually enabled Regions, such as Asia Pacific (Hong - Kong). Version 2 tokens are valid in all Regions. However, version 2 tokens - are longer and might affect systems where you temporarily store tokens. For - information, see Activating - and deactivating STS in an Amazon Web Services Region in the IAM User - Guide.

To view the current session token version, see the GlobalEndpointTokenVersion - entry in the response of the GetAccountSummary operation.

- operationId: GET_SetSecurityTokenServicePreferences - parameters: - - description:

The version of the global endpoint token. Version 1 tokens - are valid only in Amazon Web Services Regions that are available by default. - These tokens do not work in manually enabled Regions, such as Asia Pacific - (Hong Kong). Version 2 tokens are valid in all Regions. However, version - 2 tokens are longer and might affect systems where you temporarily store - tokens.

For information, see Activating - and deactivating STS in an Amazon Web Services Region in the IAM - User Guide.

- in: query - name: GlobalEndpointTokenVersion - required: true - schema: - enum: - - v1Token - - v2Token - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: SetSecurityTokenServicePreferences - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Sets the specified version of the global endpoint token as the - token version used for the Amazon Web Services account.

By default, - Security Token Service (STS) is available as a global service, and all STS - requests go to a single endpoint at https://sts.amazonaws.com. - Amazon Web Services recommends using Regional STS endpoints to reduce latency, - build in redundancy, and increase session token availability. For information - about Regional endpoints for STS, see Security - Token Service endpoints and quotas in the Amazon Web Services General - Reference.

If you make an STS call to the global endpoint, the - resulting session tokens might be valid in some Regions but not others. It - depends on the version that is set in this operation. Version 1 tokens are - valid only in Amazon Web Services Regions that are available by default. These - tokens do not work in manually enabled Regions, such as Asia Pacific (Hong - Kong). Version 2 tokens are valid in all Regions. However, version 2 tokens - are longer and might affect systems where you temporarily store tokens. For - information, see Activating - and deactivating STS in an Amazon Web Services Region in the IAM User - Guide.

To view the current session token version, see the GlobalEndpointTokenVersion - entry in the response of the GetAccountSummary operation.

- operationId: POST_SetSecurityTokenServicePreferences - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/SetSecurityTokenServicePreferencesRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: SetSecurityTokenServicePreferences - /?Action=SimulateCustomPolicy&Version=2010-05-08: - get: - description:

Simulate how a set of IAM policies and optionally a resource-based - policy works with a list of API operations and Amazon Web Services resources - to determine the policies' effective permissions. The policies are provided - as strings.

The simulation does not perform the API operations; it - only checks the authorization to determine if the simulated policies allow - or deny the operations. You can simulate resources that don't exist in your - account.

If you want to simulate existing policies that are attached - to an IAM user, group, or role, use SimulatePrincipalPolicy instead.

-

Context keys are variables that are maintained by Amazon Web Services and - its services and which provide details about the context of an API query request. - You can use the Condition element of an IAM policy to evaluate - context keys. To get the list of context keys that the policies require for - correct simulation, use GetContextKeysForCustomPolicy.

If the - output is long, you can use MaxItems and Marker - parameters to paginate the results.

For more information about using - the policy simulator, see Testing - IAM policies with the IAM policy simulator in the IAM User Guide.

- operationId: GET_SimulateCustomPolicy - parameters: - - description:

A list of policy documents to include in the simulation. Each - document is specified as a string containing the complete, valid JSON text - of an IAM policy. Do not include any resource-based policies in this parameter. - Any resource-based policy must be submitted with the ResourcePolicy - parameter. The policies cannot be "scope-down" policies, such as you could - include in a call to GetFederationToken - or one of the AssumeRole - API operations. In other words, do not use policies designed to restrict - what a user can do while using the temporary credentials.

The maximum - length of the policy document that you can pass in this operation, including - whitespace, is listed below. To view the maximum character counts of a managed - policy with no whitespaces, see IAM - and STS character quotas.

The regex - pattern used to validate this parameter is a string of characters consisting - of the following:

  • Any printable ASCII character ranging - from the space character (\u0020) through the end of the ASCII - character range

  • The printable characters in the Basic - Latin and Latin-1 Supplement character set (through \u00FF)

    -

  • The special characters tab (\u0009), line feed - (\u000A), and carriage return (\u000D)

    • -
- in: query - name: PolicyInputList - required: true - schema: - items: - allOf: - - $ref: '#/components/schemas/policyDocumentType' - - xml: - name: member - type: array - - description:

The IAM permissions boundary policy to simulate. The permissions - boundary sets the maximum permissions that an IAM entity can have. You can - input only one permissions boundary when you pass a policy to this operation. - For more information about permissions boundaries, see Permissions - boundaries for IAM entities in the IAM User Guide. The policy - input is specified as a string that contains the complete, valid JSON text - of a permissions boundary policy.

The maximum length of the policy - document that you can pass in this operation, including whitespace, is listed - below. To view the maximum character counts of a managed policy with no - whitespaces, see IAM - and STS character quotas.

The regex - pattern used to validate this parameter is a string of characters consisting - of the following:

  • Any printable ASCII character ranging - from the space character (\u0020) through the end of the ASCII - character range

  • The printable characters in the Basic - Latin and Latin-1 Supplement character set (through \u00FF)

    -

  • The special characters tab (\u0009), line feed - (\u000A), and carriage return (\u000D)

    • -
- in: query - name: PermissionsBoundaryPolicyInputList - required: false - schema: - items: - allOf: - - $ref: '#/components/schemas/policyDocumentType' - - xml: - name: member - type: array - - description: A list of names of API operations to evaluate in the simulation. - Each operation is evaluated against each resource. Each operation must include - the service identifier, such as iam:CreateUser. This operation - does not support using wildcards (*) in an action name. - in: query - name: ActionNames - required: true - schema: - items: - allOf: - - $ref: '#/components/schemas/ActionNameType' - - xml: - name: member - type: array - - description:

A list of ARNs of Amazon Web Services resources to include - in the simulation. If this parameter is not provided, then the value defaults - to * (all resources). Each API in the ActionNames - parameter is evaluated for each resource in this list. The simulation determines - the access result (allowed or denied) of each combination and reports it - in the response. You can simulate resources that don't exist in your account.

-

The simulation does not automatically retrieve policies for the specified - resources. If you want to include a resource policy in the simulation, then - you must include the policy as a string in the ResourcePolicy - parameter.

If you include a ResourcePolicy, then it - must be applicable to all of the resources included in the simulation or - you receive an invalid input error.

For more information about ARNs, - see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.

- in: query - name: ResourceArns - required: false - schema: - items: - allOf: - - $ref: '#/components/schemas/ResourceNameType' - - xml: - name: member - type: array - - description:

A resource-based policy to include in the simulation provided - as a string. Each resource in the simulation is treated as if it had this - policy attached. You can include only one resource-based policy in a simulation.

-

The maximum length of the policy document that you can pass in this operation, - including whitespace, is listed below. To view the maximum character counts - of a managed policy with no whitespaces, see IAM - and STS character quotas.

The regex - pattern used to validate this parameter is a string of characters consisting - of the following:

  • Any printable ASCII character ranging - from the space character (\u0020) through the end of the ASCII - character range

  • The printable characters in the Basic - Latin and Latin-1 Supplement character set (through \u00FF)

    -

  • The special characters tab (\u0009), line feed - (\u000A), and carriage return (\u000D)

    • -
- in: query - name: ResourcePolicy - required: false - schema: - maxLength: 131072 - minLength: 1 - pattern: '[\u0009\u000A\u000D\u0020-\u00FF]+' - type: string - - description: '

An ARN representing the Amazon Web Services account ID that - specifies the owner of any simulated resource that does not identify its - owner in the resource ARN. Examples of resource ARNs include an S3 bucket - or object. If ResourceOwner is specified, it is also used as - the account owner of any ResourcePolicy included in the simulation. - If the ResourceOwner parameter is not specified, then the owner - of the resources and the resource policy defaults to the account of the - identity provided in CallerArn. This parameter is required - only if you specify a resource-based policy and account that owns the resource - is different from the account that owns the simulated calling user CallerArn.

-

The ARN for an account uses the following syntax: arn:aws:iam::AWS-account-ID:root. - For example, to represent the account with the 112233445566 ID, use the - following ARN: arn:aws:iam::112233445566-ID:root.

' - in: query - name: ResourceOwner - required: false - schema: - maxLength: 2048 - minLength: 1 - type: string - - description:

The ARN of the IAM user that you want to use as the simulated - caller of the API operations. CallerArn is required if you - include a ResourcePolicy so that the policy's Principal - element has a value to use in evaluating the policy.

You can specify - only the ARN of an IAM user. You cannot specify the ARN of an assumed role, - federated user, or a service principal.

- in: query - name: CallerArn - required: false - schema: - maxLength: 2048 - minLength: 1 - type: string - - description: A list of context keys and corresponding values for the simulation - to use. Whenever a context key is evaluated in one of the simulated IAM - permissions policies, the corresponding value is supplied. - in: query - name: ContextEntries - required: false - schema: - items: - allOf: - - $ref: '#/components/schemas/ContextEntry' - - xml: - name: member - type: array - - description:

Specifies the type of simulation to run. Different API operations - that support resource-based policies require different combinations of resources. - By specifying the type of simulation to run, you enable the policy simulator - to enforce the presence of the required resources to ensure reliable simulation - results. If your simulation does not match one of the following scenarios, - then you can omit this parameter. The following list shows each of the supported - scenario values and the resources that you must define to run the simulation.

-

Each of the EC2 scenarios requires that you specify instance, image, - and security-group resources. If your scenario includes an EBS volume, then - you must specify that volume as a resource. If the EC2 scenario includes - VPC, then you must supply the network-interface resource. If it includes - an IP subnet, then you must specify the subnet resource. For more information - on the EC2 scenario options, see Supported - platforms in the Amazon EC2 User Guide.

  • EC2-Classic-InstanceStore -

    instance, image, security-group

  • EC2-Classic-EBS -

    instance, image, security-group, volume

  • EC2-VPC-InstanceStore -

    instance, image, security-group, network-interface

  • -

    EC2-VPC-InstanceStore-Subnet

    instance, image, security-group, - network-interface, subnet

  • EC2-VPC-EBS

    instance, - image, security-group, network-interface, volume

  • EC2-VPC-EBS-Subnet -

    instance, image, security-group, network-interface, subnet, volume

    -
- in: query - name: ResourceHandlingOption - required: false - schema: - maxLength: 64 - minLength: 1 - type: string - - description:

Use this only when paginating results to indicate the maximum - number of items you want in the response. If additional items exist beyond - the maximum you specify, the IsTruncated response element is - true.

If you do not include this parameter, the number - of items defaults to 100. Note that IAM might return fewer results, even - when there are more results available. In that case, the IsTruncated - response element returns true, and Marker contains - a value to include in the subsequent call that tells the service where to - continue from.

- in: query - name: MaxItems - required: false - schema: - maximum: 1000 - minimum: 1 - type: integer - - description: Use this parameter only when paginating results and only after - you receive a response indicating that the results are truncated. Set it - to the value of the Marker element in the response that you - received to indicate where the next call should start. - in: query - name: Marker - required: false - schema: - maxLength: 320 - minLength: 1 - pattern: '[\u0020-\u00FF]+' - type: string - responses: - '200': - content: - text/xml: - schema: - properties: - SimulateCustomPolicyResult: - $ref: '#/components/schemas/SimulatePolicyResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/PolicyEvaluationException' - description: PolicyEvaluationException - x-aws-operation-name: SimulateCustomPolicy - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Simulate how a set of IAM policies and optionally a resource-based - policy works with a list of API operations and Amazon Web Services resources - to determine the policies' effective permissions. The policies are provided - as strings.

The simulation does not perform the API operations; it - only checks the authorization to determine if the simulated policies allow - or deny the operations. You can simulate resources that don't exist in your - account.

If you want to simulate existing policies that are attached - to an IAM user, group, or role, use SimulatePrincipalPolicy instead.

-

Context keys are variables that are maintained by Amazon Web Services and - its services and which provide details about the context of an API query request. - You can use the Condition element of an IAM policy to evaluate - context keys. To get the list of context keys that the policies require for - correct simulation, use GetContextKeysForCustomPolicy.

If the - output is long, you can use MaxItems and Marker - parameters to paginate the results.

For more information about using - the policy simulator, see Testing - IAM policies with the IAM policy simulator in the IAM User Guide.

- operationId: POST_SimulateCustomPolicy - parameters: - - description: Pagination limit - in: query - name: MaxItems - required: false - schema: - type: string - - description: Pagination token - in: query - name: Marker - required: false - schema: - type: string - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/SimulateCustomPolicyRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - SimulateCustomPolicyResult: - $ref: '#/components/schemas/SimulatePolicyResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/PolicyEvaluationException' - description: PolicyEvaluationException - x-aws-operation-name: SimulateCustomPolicy - /?Action=SimulatePrincipalPolicy&Version=2010-05-08: - get: - description:

Simulate how a set of IAM policies attached to an IAM entity - works with a list of API operations and Amazon Web Services resources to determine - the policies' effective permissions. The entity can be an IAM user, group, - or role. If you specify a user, then the simulation also includes all of the - policies that are attached to groups that the user belongs to. You can simulate - resources that don't exist in your account.

You can optionally include - a list of one or more additional policies specified as strings to include - in the simulation. If you want to simulate only policies specified as strings, - use SimulateCustomPolicy instead.

You can also optionally include - one resource-based policy to be evaluated with each of the resources included - in the simulation.

The simulation does not perform the API operations; - it only checks the authorization to determine if the simulated policies allow - or deny the operations.

Note: This operation discloses information - about the permissions granted to other users. If you do not want users to - see other user's permissions, then consider allowing them to use SimulateCustomPolicy - instead.

Context keys are variables maintained by Amazon Web Services - and its services that provide details about the context of an API query request. - You can use the Condition element of an IAM policy to evaluate - context keys. To get the list of context keys that the policies require for - correct simulation, use GetContextKeysForPrincipalPolicy.

If - the output is long, you can use the MaxItems and Marker - parameters to paginate the results.

For more information about using - the policy simulator, see Testing - IAM policies with the IAM policy simulator in the IAM User Guide.

- operationId: GET_SimulatePrincipalPolicy - parameters: - - description:

The Amazon Resource Name (ARN) of a user, group, or role whose - policies you want to include in the simulation. If you specify a user, group, - or role, the simulation includes all policies that are associated with that - entity. If you specify a user, the simulation also includes all policies - that are attached to any groups the user belongs to.

The maximum - length of the policy document that you can pass in this operation, including - whitespace, is listed below. To view the maximum character counts of a managed - policy with no whitespaces, see IAM - and STS character quotas.

For more information about ARNs, see - Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.

- in: query - name: PolicySourceArn - required: true - schema: - description:

The Amazon Resource Name (ARN). ARNs are unique identifiers - for Amazon Web Services resources.

For more information about ARNs, - go to Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference. -

- maxLength: 2048 - minLength: 20 - type: string - - description:

An optional list of additional policy documents to include - in the simulation. Each document is specified as a string containing the - complete, valid JSON text of an IAM policy.

The regex - pattern used to validate this parameter is a string of characters consisting - of the following:

  • Any printable ASCII character ranging - from the space character (\u0020) through the end of the ASCII - character range

  • The printable characters in the Basic - Latin and Latin-1 Supplement character set (through \u00FF)

    -

  • The special characters tab (\u0009), line feed - (\u000A), and carriage return (\u000D)

    • -
- in: query - name: PolicyInputList - required: false - schema: - items: - allOf: - - $ref: '#/components/schemas/policyDocumentType' - - xml: - name: member - type: array - - description:

The IAM permissions boundary policy to simulate. The permissions - boundary sets the maximum permissions that the entity can have. You can - input only one permissions boundary when you pass a policy to this operation. - An IAM entity can only have one permissions boundary in effect at a time. - For example, if a permissions boundary is attached to an entity and you - pass in a different permissions boundary policy using this parameter, then - the new permissions boundary policy is used for the simulation. For more - information about permissions boundaries, see Permissions - boundaries for IAM entities in the IAM User Guide. The policy - input is specified as a string containing the complete, valid JSON text - of a permissions boundary policy.

The maximum length of the policy - document that you can pass in this operation, including whitespace, is listed - below. To view the maximum character counts of a managed policy with no - whitespaces, see IAM - and STS character quotas.

The regex - pattern used to validate this parameter is a string of characters consisting - of the following:

  • Any printable ASCII character ranging - from the space character (\u0020) through the end of the ASCII - character range

  • The printable characters in the Basic - Latin and Latin-1 Supplement character set (through \u00FF)

    -

  • The special characters tab (\u0009), line feed - (\u000A), and carriage return (\u000D)

    • -
- in: query - name: PermissionsBoundaryPolicyInputList - required: false - schema: - items: - allOf: - - $ref: '#/components/schemas/policyDocumentType' - - xml: - name: member - type: array - - description: A list of names of API operations to evaluate in the simulation. - Each operation is evaluated for each resource. Each operation must include - the service identifier, such as iam:CreateUser. - in: query - name: ActionNames - required: true - schema: - items: - allOf: - - $ref: '#/components/schemas/ActionNameType' - - xml: - name: member - type: array - - description:

A list of ARNs of Amazon Web Services resources to include - in the simulation. If this parameter is not provided, then the value defaults - to * (all resources). Each API in the ActionNames - parameter is evaluated for each resource in this list. The simulation determines - the access result (allowed or denied) of each combination and reports it - in the response. You can simulate resources that don't exist in your account.

-

The simulation does not automatically retrieve policies for the specified - resources. If you want to include a resource policy in the simulation, then - you must include the policy as a string in the ResourcePolicy - parameter.

For more information about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.

- in: query - name: ResourceArns - required: false - schema: - items: - allOf: - - $ref: '#/components/schemas/ResourceNameType' - - xml: - name: member - type: array - - description:

A resource-based policy to include in the simulation provided - as a string. Each resource in the simulation is treated as if it had this - policy attached. You can include only one resource-based policy in a simulation.

-

The maximum length of the policy document that you can pass in this operation, - including whitespace, is listed below. To view the maximum character counts - of a managed policy with no whitespaces, see IAM - and STS character quotas.

The regex - pattern used to validate this parameter is a string of characters consisting - of the following:

  • Any printable ASCII character ranging - from the space character (\u0020) through the end of the ASCII - character range

  • The printable characters in the Basic - Latin and Latin-1 Supplement character set (through \u00FF)

    -

  • The special characters tab (\u0009), line feed - (\u000A), and carriage return (\u000D)

    • -
- in: query - name: ResourcePolicy - required: false - schema: - maxLength: 131072 - minLength: 1 - pattern: '[\u0009\u000A\u000D\u0020-\u00FF]+' - type: string - - description: An Amazon Web Services account ID that specifies the owner of - any simulated resource that does not identify its owner in the resource - ARN. Examples of resource ARNs include an S3 bucket or object. If ResourceOwner - is specified, it is also used as the account owner of any ResourcePolicy - included in the simulation. If the ResourceOwner parameter - is not specified, then the owner of the resources and the resource policy - defaults to the account of the identity provided in CallerArn. - This parameter is required only if you specify a resource-based policy and - account that owns the resource is different from the account that owns the - simulated calling user CallerArn. - in: query - name: ResourceOwner - required: false - schema: - maxLength: 2048 - minLength: 1 - type: string - - description:

The ARN of the IAM user that you want to specify as the simulated - caller of the API operations. If you do not specify a CallerArn, - it defaults to the ARN of the user that you specify in PolicySourceArn, - if you specified a user. If you include both a PolicySourceArn - (for example, arn:aws:iam::123456789012:user/David) and a CallerArn - (for example, arn:aws:iam::123456789012:user/Bob), the result - is that you simulate calling the API operations as Bob, as if Bob had David's - policies.

You can specify only the ARN of an IAM user. You cannot - specify the ARN of an assumed role, federated user, or a service principal.

-

CallerArn is required if you include a ResourcePolicy - and the PolicySourceArn is not the ARN for an IAM user. This - is required so that the resource-based policy's Principal element - has a value to use in evaluating the policy.

For more information - about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.

- in: query - name: CallerArn - required: false - schema: - maxLength: 2048 - minLength: 1 - type: string - - description: A list of context keys and corresponding values for the simulation - to use. Whenever a context key is evaluated in one of the simulated IAM - permissions policies, the corresponding value is supplied. - in: query - name: ContextEntries - required: false - schema: - items: - allOf: - - $ref: '#/components/schemas/ContextEntry' - - xml: - name: member - type: array - - description:

Specifies the type of simulation to run. Different API operations - that support resource-based policies require different combinations of resources. - By specifying the type of simulation to run, you enable the policy simulator - to enforce the presence of the required resources to ensure reliable simulation - results. If your simulation does not match one of the following scenarios, - then you can omit this parameter. The following list shows each of the supported - scenario values and the resources that you must define to run the simulation.

-

Each of the EC2 scenarios requires that you specify instance, image, - and security group resources. If your scenario includes an EBS volume, then - you must specify that volume as a resource. If the EC2 scenario includes - VPC, then you must supply the network interface resource. If it includes - an IP subnet, then you must specify the subnet resource. For more information - on the EC2 scenario options, see Supported - platforms in the Amazon EC2 User Guide.

  • EC2-Classic-InstanceStore -

    instance, image, security group

  • EC2-Classic-EBS -

    instance, image, security group, volume

  • EC2-VPC-InstanceStore -

    instance, image, security group, network interface

  • -

    EC2-VPC-InstanceStore-Subnet

    instance, image, security - group, network interface, subnet

  • EC2-VPC-EBS

    -

    instance, image, security group, network interface, volume

    • -

  • EC2-VPC-EBS-Subnet

    instance, image, security group, - network interface, subnet, volume

- in: query - name: ResourceHandlingOption - required: false - schema: - maxLength: 64 - minLength: 1 - type: string - - description:

Use this only when paginating results to indicate the maximum - number of items you want in the response. If additional items exist beyond - the maximum you specify, the IsTruncated response element is - true.

If you do not include this parameter, the number - of items defaults to 100. Note that IAM might return fewer results, even - when there are more results available. In that case, the IsTruncated - response element returns true, and Marker contains - a value to include in the subsequent call that tells the service where to - continue from.

- in: query - name: MaxItems - required: false - schema: - maximum: 1000 - minimum: 1 - type: integer - - description: Use this parameter only when paginating results and only after - you receive a response indicating that the results are truncated. Set it - to the value of the Marker element in the response that you - received to indicate where the next call should start. - in: query - name: Marker - required: false - schema: - maxLength: 320 - minLength: 1 - pattern: '[\u0020-\u00FF]+' - type: string - responses: - '200': - content: - text/xml: - schema: - properties: - SimulatePrincipalPolicyResult: - $ref: '#/components/schemas/SimulatePolicyResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/PolicyEvaluationException' - description: PolicyEvaluationException - x-aws-operation-name: SimulatePrincipalPolicy - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Simulate how a set of IAM policies attached to an IAM entity - works with a list of API operations and Amazon Web Services resources to determine - the policies' effective permissions. The entity can be an IAM user, group, - or role. If you specify a user, then the simulation also includes all of the - policies that are attached to groups that the user belongs to. You can simulate - resources that don't exist in your account.

You can optionally include - a list of one or more additional policies specified as strings to include - in the simulation. If you want to simulate only policies specified as strings, - use SimulateCustomPolicy instead.

You can also optionally include - one resource-based policy to be evaluated with each of the resources included - in the simulation.

The simulation does not perform the API operations; - it only checks the authorization to determine if the simulated policies allow - or deny the operations.

Note: This operation discloses information - about the permissions granted to other users. If you do not want users to - see other user's permissions, then consider allowing them to use SimulateCustomPolicy - instead.

Context keys are variables maintained by Amazon Web Services - and its services that provide details about the context of an API query request. - You can use the Condition element of an IAM policy to evaluate - context keys. To get the list of context keys that the policies require for - correct simulation, use GetContextKeysForPrincipalPolicy.

If - the output is long, you can use the MaxItems and Marker - parameters to paginate the results.

For more information about using - the policy simulator, see Testing - IAM policies with the IAM policy simulator in the IAM User Guide.

- operationId: POST_SimulatePrincipalPolicy - parameters: - - description: Pagination limit - in: query - name: MaxItems - required: false - schema: - type: string - - description: Pagination token - in: query - name: Marker - required: false - schema: - type: string - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/SimulatePrincipalPolicyRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - SimulatePrincipalPolicyResult: - $ref: '#/components/schemas/SimulatePolicyResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/PolicyEvaluationException' - description: PolicyEvaluationException - x-aws-operation-name: SimulatePrincipalPolicy - /?Action=TagInstanceProfile&Version=2010-05-08: - get: - description:

Adds one or more tags to an IAM instance profile. If a tag with - the same key name already exists, then that tag is overwritten with the new - value.

Each tag consists of a key name and an associated value. By - assigning tags to your resources, you can do the following:

  • -

    Administrative grouping and discovery - Attach tags to resources - to aid in organization and search. For example, you could search for all resources - with the key name Project and the value MyImportantProject. - Or search for all resources with the key name Cost Center and the value - 41200.

  • Access control - Include tags in - IAM user-based and resource-based policies. You can use tags to restrict access - to only an IAM instance profile that has a specified tag attached. For examples - of policies that show how to use tags to control access, see Control - access using IAM tags in the IAM User Guide.

-

  • If any one of the tags is invalid or if you exceed the allowed - maximum number of tags, then the entire request fails and the resource is - not created. For more information about tagging, see Tagging - IAM resources in the IAM User Guide.

  • Amazon Web - Services always interprets the tag Value as a single string. - If you need to store an array, you can store comma-separated values in the - string. However, you must interpret the value in your code.

- - operationId: GET_TagInstanceProfile - parameters: - - description: '

The name of the IAM instance profile to which you want to - add tags.

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: InstanceProfileName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: The list of tags that you want to attach to the IAM instance - profile. Each tag consists of a key name and an associated value. - in: query - name: Tags - required: true - schema: - items: - allOf: - - $ref: '#/components/schemas/Tag' - - xml: - name: member - maxItems: 50 - type: array - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: TagInstanceProfile - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Adds one or more tags to an IAM instance profile. If a tag with - the same key name already exists, then that tag is overwritten with the new - value.

Each tag consists of a key name and an associated value. By - assigning tags to your resources, you can do the following:

  • -

    Administrative grouping and discovery - Attach tags to resources - to aid in organization and search. For example, you could search for all resources - with the key name Project and the value MyImportantProject. - Or search for all resources with the key name Cost Center and the value - 41200.

  • Access control - Include tags in - IAM user-based and resource-based policies. You can use tags to restrict access - to only an IAM instance profile that has a specified tag attached. For examples - of policies that show how to use tags to control access, see Control - access using IAM tags in the IAM User Guide.

-

  • If any one of the tags is invalid or if you exceed the allowed - maximum number of tags, then the entire request fails and the resource is - not created. For more information about tagging, see Tagging - IAM resources in the IAM User Guide.

  • Amazon Web - Services always interprets the tag Value as a single string. - If you need to store an array, you can store comma-separated values in the - string. However, you must interpret the value in your code.

- - operationId: POST_TagInstanceProfile - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/TagInstanceProfileRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: TagInstanceProfile - /?Action=TagMFADevice&Version=2010-05-08: - get: - description:

Adds one or more tags to an IAM virtual multi-factor authentication - (MFA) device. If a tag with the same key name already exists, then that tag - is overwritten with the new value.

A tag consists of a key name and - an associated value. By assigning tags to your resources, you can do the following:

-

  • Administrative grouping and discovery - Attach tags to - resources to aid in organization and search. For example, you could search - for all resources with the key name Project and the value MyImportantProject. - Or search for all resources with the key name Cost Center and the value - 41200.

  • Access control - Include tags in - IAM user-based and resource-based policies. You can use tags to restrict access - to only an IAM virtual MFA device that has a specified tag attached. For examples - of policies that show how to use tags to control access, see Control - access using IAM tags in the IAM User Guide.

-

  • If any one of the tags is invalid or if you exceed the allowed - maximum number of tags, then the entire request fails and the resource is - not created. For more information about tagging, see Tagging - IAM resources in the IAM User Guide.

  • Amazon Web - Services always interprets the tag Value as a single string. - If you need to store an array, you can store comma-separated values in the - string. However, you must interpret the value in your code.

- - operationId: GET_TagMFADevice - parameters: - - description: '

The unique identifier for the IAM virtual MFA device to which - you want to add tags. For virtual MFA devices, the serial number is the - same as the ARN.

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: SerialNumber - required: true - schema: - maxLength: 256 - minLength: 9 - pattern: '[\w+=/:,.@-]+' - type: string - - description: The list of tags that you want to attach to the IAM virtual MFA - device. Each tag consists of a key name and an associated value. - in: query - name: Tags - required: true - schema: - items: - allOf: - - $ref: '#/components/schemas/Tag' - - xml: - name: member - maxItems: 50 - type: array - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: TagMFADevice - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Adds one or more tags to an IAM virtual multi-factor authentication - (MFA) device. If a tag with the same key name already exists, then that tag - is overwritten with the new value.

A tag consists of a key name and - an associated value. By assigning tags to your resources, you can do the following:

-

  • Administrative grouping and discovery - Attach tags to - resources to aid in organization and search. For example, you could search - for all resources with the key name Project and the value MyImportantProject. - Or search for all resources with the key name Cost Center and the value - 41200.

  • Access control - Include tags in - IAM user-based and resource-based policies. You can use tags to restrict access - to only an IAM virtual MFA device that has a specified tag attached. For examples - of policies that show how to use tags to control access, see Control - access using IAM tags in the IAM User Guide.

-

  • If any one of the tags is invalid or if you exceed the allowed - maximum number of tags, then the entire request fails and the resource is - not created. For more information about tagging, see Tagging - IAM resources in the IAM User Guide.

  • Amazon Web - Services always interprets the tag Value as a single string. - If you need to store an array, you can store comma-separated values in the - string. However, you must interpret the value in your code.

- - operationId: POST_TagMFADevice - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/TagMFADeviceRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: TagMFADevice - /?Action=TagOpenIDConnectProvider&Version=2010-05-08: - get: - description:

Adds one or more tags to an OpenID Connect (OIDC)-compatible - identity provider. For more information about these providers, see About - web identity federation. If a tag with the same key name already exists, - then that tag is overwritten with the new value.

A tag consists of - a key name and an associated value. By assigning tags to your resources, you - can do the following:

  • Administrative grouping and discovery - - Attach tags to resources to aid in organization and search. For example, - you could search for all resources with the key name Project and the - value MyImportantProject. Or search for all resources with the key - name Cost Center and the value 41200.

  • Access - control - Include tags in IAM user-based and resource-based policies. - You can use tags to restrict access to only an OIDC provider that has a specified - tag attached. For examples of policies that show how to use tags to control - access, see Control - access using IAM tags in the IAM User Guide.

-

  • If any one of the tags is invalid or if you exceed the allowed - maximum number of tags, then the entire request fails and the resource is - not created. For more information about tagging, see Tagging - IAM resources in the IAM User Guide.

  • Amazon Web - Services always interprets the tag Value as a single string. - If you need to store an array, you can store comma-separated values in the - string. However, you must interpret the value in your code.

- - operationId: GET_TagOpenIDConnectProvider - parameters: - - description: '

The ARN of the OIDC identity provider in IAM to which you - want to add tags.

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: OpenIDConnectProviderArn - required: true - schema: - description:

The Amazon Resource Name (ARN). ARNs are unique identifiers - for Amazon Web Services resources.

For more information about ARNs, - go to Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference. -

- maxLength: 2048 - minLength: 20 - type: string - - description: The list of tags that you want to attach to the OIDC identity - provider in IAM. Each tag consists of a key name and an associated value. - in: query - name: Tags - required: true - schema: - items: - allOf: - - $ref: '#/components/schemas/Tag' - - xml: - name: member - maxItems: 50 - type: array - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: TagOpenIDConnectProvider - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Adds one or more tags to an OpenID Connect (OIDC)-compatible - identity provider. For more information about these providers, see About - web identity federation. If a tag with the same key name already exists, - then that tag is overwritten with the new value.

A tag consists of - a key name and an associated value. By assigning tags to your resources, you - can do the following:

  • Administrative grouping and discovery - - Attach tags to resources to aid in organization and search. For example, - you could search for all resources with the key name Project and the - value MyImportantProject. Or search for all resources with the key - name Cost Center and the value 41200.

  • Access - control - Include tags in IAM user-based and resource-based policies. - You can use tags to restrict access to only an OIDC provider that has a specified - tag attached. For examples of policies that show how to use tags to control - access, see Control - access using IAM tags in the IAM User Guide.

-

  • If any one of the tags is invalid or if you exceed the allowed - maximum number of tags, then the entire request fails and the resource is - not created. For more information about tagging, see Tagging - IAM resources in the IAM User Guide.

  • Amazon Web - Services always interprets the tag Value as a single string. - If you need to store an array, you can store comma-separated values in the - string. However, you must interpret the value in your code.

- - operationId: POST_TagOpenIDConnectProvider - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/TagOpenIDConnectProviderRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: TagOpenIDConnectProvider - /?Action=TagPolicy&Version=2010-05-08: - get: - description:

Adds one or more tags to an IAM customer managed policy. If - a tag with the same key name already exists, then that tag is overwritten - with the new value.

A tag consists of a key name and an associated - value. By assigning tags to your resources, you can do the following:

-

  • Administrative grouping and discovery - Attach tags to - resources to aid in organization and search. For example, you could search - for all resources with the key name Project and the value MyImportantProject. - Or search for all resources with the key name Cost Center and the value - 41200.

  • Access control - Include tags in - IAM user-based and resource-based policies. You can use tags to restrict access - to only an IAM customer managed policy that has a specified tag attached. - For examples of policies that show how to use tags to control access, see - Control - access using IAM tags in the IAM User Guide.

-

  • If any one of the tags is invalid or if you exceed the allowed - maximum number of tags, then the entire request fails and the resource is - not created. For more information about tagging, see Tagging - IAM resources in the IAM User Guide.

  • Amazon Web - Services always interprets the tag Value as a single string. - If you need to store an array, you can store comma-separated values in the - string. However, you must interpret the value in your code.

- - operationId: GET_TagPolicy - parameters: - - description: '

The ARN of the IAM customer managed policy to which you want - to add tags.

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: PolicyArn - required: true - schema: - description:

The Amazon Resource Name (ARN). ARNs are unique identifiers - for Amazon Web Services resources.

For more information about ARNs, - go to Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference. -

- maxLength: 2048 - minLength: 20 - type: string - - description: The list of tags that you want to attach to the IAM customer - managed policy. Each tag consists of a key name and an associated value. - in: query - name: Tags - required: true - schema: - items: - allOf: - - $ref: '#/components/schemas/Tag' - - xml: - name: member - maxItems: 50 - type: array - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: TagPolicy - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Adds one or more tags to an IAM customer managed policy. If - a tag with the same key name already exists, then that tag is overwritten - with the new value.

A tag consists of a key name and an associated - value. By assigning tags to your resources, you can do the following:

-

  • Administrative grouping and discovery - Attach tags to - resources to aid in organization and search. For example, you could search - for all resources with the key name Project and the value MyImportantProject. - Or search for all resources with the key name Cost Center and the value - 41200.

  • Access control - Include tags in - IAM user-based and resource-based policies. You can use tags to restrict access - to only an IAM customer managed policy that has a specified tag attached. - For examples of policies that show how to use tags to control access, see - Control - access using IAM tags in the IAM User Guide.

-

  • If any one of the tags is invalid or if you exceed the allowed - maximum number of tags, then the entire request fails and the resource is - not created. For more information about tagging, see Tagging - IAM resources in the IAM User Guide.

  • Amazon Web - Services always interprets the tag Value as a single string. - If you need to store an array, you can store comma-separated values in the - string. However, you must interpret the value in your code.

- - operationId: POST_TagPolicy - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/TagPolicyRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: TagPolicy - /?Action=TagRole&Version=2010-05-08: - get: - description:

Adds one or more tags to an IAM role. The role can be a regular - role or a service-linked role. If a tag with the same key name already exists, - then that tag is overwritten with the new value.

A tag consists of - a key name and an associated value. By assigning tags to your resources, you - can do the following:

  • Administrative grouping and discovery - - Attach tags to resources to aid in organization and search. For example, - you could search for all resources with the key name Project and the - value MyImportantProject. Or search for all resources with the key - name Cost Center and the value 41200.

  • Access - control - Include tags in IAM user-based and resource-based policies. - You can use tags to restrict access to only an IAM role that has a specified - tag attached. You can also restrict access to only those resources that have - a certain tag attached. For examples of policies that show how to use tags - to control access, see Control - access using IAM tags in the IAM User Guide.

  • - Cost allocation - Use tags to help track which individuals and teams - are using which Amazon Web Services resources.

    -

  • If any one of the tags is invalid or if you exceed the allowed maximum - number of tags, then the entire request fails and the resource is not created. - For more information about tagging, see Tagging - IAM resources in the IAM User Guide.

  • Amazon Web - Services always interprets the tag Value as a single string. - If you need to store an array, you can store comma-separated values in the - string. However, you must interpret the value in your code.

-

For more information about tagging, see Tagging - IAM identities in the IAM User Guide.

- operationId: GET_TagRole - parameters: - - description: '

The name of the IAM role to which you want to add tags.

-

This parameter accepts (through its regex - pattern) a string of characters that consist of upper and lowercase - alphanumeric characters with no spaces. You can also include any of the - following characters: _+=,.@-

' - in: query - name: RoleName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: The list of tags that you want to attach to the IAM role. Each - tag consists of a key name and an associated value. - in: query - name: Tags - required: true - schema: - items: - allOf: - - $ref: '#/components/schemas/Tag' - - xml: - name: member - maxItems: 50 - type: array - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: TagRole - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Adds one or more tags to an IAM role. The role can be a regular - role or a service-linked role. If a tag with the same key name already exists, - then that tag is overwritten with the new value.

A tag consists of - a key name and an associated value. By assigning tags to your resources, you - can do the following:

  • Administrative grouping and discovery - - Attach tags to resources to aid in organization and search. For example, - you could search for all resources with the key name Project and the - value MyImportantProject. Or search for all resources with the key - name Cost Center and the value 41200.

  • Access - control - Include tags in IAM user-based and resource-based policies. - You can use tags to restrict access to only an IAM role that has a specified - tag attached. You can also restrict access to only those resources that have - a certain tag attached. For examples of policies that show how to use tags - to control access, see Control - access using IAM tags in the IAM User Guide.

  • - Cost allocation - Use tags to help track which individuals and teams - are using which Amazon Web Services resources.

    -

  • If any one of the tags is invalid or if you exceed the allowed maximum - number of tags, then the entire request fails and the resource is not created. - For more information about tagging, see Tagging - IAM resources in the IAM User Guide.

  • Amazon Web - Services always interprets the tag Value as a single string. - If you need to store an array, you can store comma-separated values in the - string. However, you must interpret the value in your code.

-

For more information about tagging, see Tagging - IAM identities in the IAM User Guide.

- operationId: POST_TagRole - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/TagRoleRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: TagRole - /?Action=TagSAMLProvider&Version=2010-05-08: - get: - description:

Adds one or more tags to a Security Assertion Markup Language - (SAML) identity provider. For more information about these providers, see - About - SAML 2.0-based federation . If a tag with the same key name already exists, - then that tag is overwritten with the new value.

A tag consists of - a key name and an associated value. By assigning tags to your resources, you - can do the following:

  • Administrative grouping and discovery - - Attach tags to resources to aid in organization and search. For example, - you could search for all resources with the key name Project and the - value MyImportantProject. Or search for all resources with the key - name Cost Center and the value 41200.

  • Access - control - Include tags in IAM user-based and resource-based policies. - You can use tags to restrict access to only a SAML identity provider that - has a specified tag attached. For examples of policies that show how to use - tags to control access, see Control - access using IAM tags in the IAM User Guide.

-

  • If any one of the tags is invalid or if you exceed the allowed - maximum number of tags, then the entire request fails and the resource is - not created. For more information about tagging, see Tagging - IAM resources in the IAM User Guide.

  • Amazon Web - Services always interprets the tag Value as a single string. - If you need to store an array, you can store comma-separated values in the - string. However, you must interpret the value in your code.

- - operationId: GET_TagSAMLProvider - parameters: - - description: '

The ARN of the SAML identity provider in IAM to which you - want to add tags.

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: SAMLProviderArn - required: true - schema: - description:

The Amazon Resource Name (ARN). ARNs are unique identifiers - for Amazon Web Services resources.

For more information about ARNs, - go to Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference. -

- maxLength: 2048 - minLength: 20 - type: string - - description: The list of tags that you want to attach to the SAML identity - provider in IAM. Each tag consists of a key name and an associated value. - in: query - name: Tags - required: true - schema: - items: - allOf: - - $ref: '#/components/schemas/Tag' - - xml: - name: member - maxItems: 50 - type: array - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: TagSAMLProvider - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Adds one or more tags to a Security Assertion Markup Language - (SAML) identity provider. For more information about these providers, see - About - SAML 2.0-based federation . If a tag with the same key name already exists, - then that tag is overwritten with the new value.

A tag consists of - a key name and an associated value. By assigning tags to your resources, you - can do the following:

  • Administrative grouping and discovery - - Attach tags to resources to aid in organization and search. For example, - you could search for all resources with the key name Project and the - value MyImportantProject. Or search for all resources with the key - name Cost Center and the value 41200.

  • Access - control - Include tags in IAM user-based and resource-based policies. - You can use tags to restrict access to only a SAML identity provider that - has a specified tag attached. For examples of policies that show how to use - tags to control access, see Control - access using IAM tags in the IAM User Guide.

-

  • If any one of the tags is invalid or if you exceed the allowed - maximum number of tags, then the entire request fails and the resource is - not created. For more information about tagging, see Tagging - IAM resources in the IAM User Guide.

  • Amazon Web - Services always interprets the tag Value as a single string. - If you need to store an array, you can store comma-separated values in the - string. However, you must interpret the value in your code.

- - operationId: POST_TagSAMLProvider - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/TagSAMLProviderRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: TagSAMLProvider - /?Action=TagServerCertificate&Version=2010-05-08: - get: - description:

Adds one or more tags to an IAM server certificate. If a tag - with the same key name already exists, then that tag is overwritten with the - new value.

For certificates in a Region supported by Certificate - Manager (ACM), we recommend that you don't use IAM server certificates. Instead, - use ACM to provision, manage, and deploy your server certificates. For more - information about IAM server certificates, Working - with server certificates in the IAM User Guide.

A - tag consists of a key name and an associated value. By assigning tags to your - resources, you can do the following:

  • Administrative grouping - and discovery - Attach tags to resources to aid in organization and search. - For example, you could search for all resources with the key name Project - and the value MyImportantProject. Or search for all resources with - the key name Cost Center and the value 41200.

  • -

    Access control - Include tags in IAM user-based and resource-based - policies. You can use tags to restrict access to only a server certificate - that has a specified tag attached. For examples of policies that show how - to use tags to control access, see Control - access using IAM tags in the IAM User Guide.

  • - Cost allocation - Use tags to help track which individuals and teams - are using which Amazon Web Services resources.

    -

  • If any one of the tags is invalid or if you exceed the allowed maximum - number of tags, then the entire request fails and the resource is not created. - For more information about tagging, see Tagging - IAM resources in the IAM User Guide.

  • Amazon Web - Services always interprets the tag Value as a single string. - If you need to store an array, you can store comma-separated values in the - string. However, you must interpret the value in your code.

- - operationId: GET_TagServerCertificate - parameters: - - description: '

The name of the IAM server certificate to which you want - to add tags.

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: ServerCertificateName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: The list of tags that you want to attach to the IAM server certificate. - Each tag consists of a key name and an associated value. - in: query - name: Tags - required: true - schema: - items: - allOf: - - $ref: '#/components/schemas/Tag' - - xml: - name: member - maxItems: 50 - type: array - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: TagServerCertificate - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Adds one or more tags to an IAM server certificate. If a tag - with the same key name already exists, then that tag is overwritten with the - new value.

For certificates in a Region supported by Certificate - Manager (ACM), we recommend that you don't use IAM server certificates. Instead, - use ACM to provision, manage, and deploy your server certificates. For more - information about IAM server certificates, Working - with server certificates in the IAM User Guide.

A - tag consists of a key name and an associated value. By assigning tags to your - resources, you can do the following:

  • Administrative grouping - and discovery - Attach tags to resources to aid in organization and search. - For example, you could search for all resources with the key name Project - and the value MyImportantProject. Or search for all resources with - the key name Cost Center and the value 41200.

  • -

    Access control - Include tags in IAM user-based and resource-based - policies. You can use tags to restrict access to only a server certificate - that has a specified tag attached. For examples of policies that show how - to use tags to control access, see Control - access using IAM tags in the IAM User Guide.

  • - Cost allocation - Use tags to help track which individuals and teams - are using which Amazon Web Services resources.

    -

  • If any one of the tags is invalid or if you exceed the allowed maximum - number of tags, then the entire request fails and the resource is not created. - For more information about tagging, see Tagging - IAM resources in the IAM User Guide.

  • Amazon Web - Services always interprets the tag Value as a single string. - If you need to store an array, you can store comma-separated values in the - string. However, you must interpret the value in your code.

- - operationId: POST_TagServerCertificate - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/TagServerCertificateRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: TagServerCertificate - /?Action=TagUser&Version=2010-05-08: - get: - description:

Adds one or more tags to an IAM user. If a tag with the same - key name already exists, then that tag is overwritten with the new value.

-

A tag consists of a key name and an associated value. By assigning tags - to your resources, you can do the following:

  • Administrative - grouping and discovery - Attach tags to resources to aid in organization - and search. For example, you could search for all resources with the key name - Project and the value MyImportantProject. Or search for all - resources with the key name Cost Center and the value 41200. -

  • Access control - Include tags in IAM user-based - and resource-based policies. You can use tags to restrict access to only an - IAM requesting user that has a specified tag attached. You can also restrict - access to only those resources that have a certain tag attached. For examples - of policies that show how to use tags to control access, see Control - access using IAM tags in the IAM User Guide.

  • - Cost allocation - Use tags to help track which individuals and teams - are using which Amazon Web Services resources.

    -

  • If any one of the tags is invalid or if you exceed the allowed maximum - number of tags, then the entire request fails and the resource is not created. - For more information about tagging, see Tagging - IAM resources in the IAM User Guide.

  • Amazon Web - Services always interprets the tag Value as a single string. - If you need to store an array, you can store comma-separated values in the - string. However, you must interpret the value in your code.

-

For more information about tagging, see Tagging - IAM identities in the IAM User Guide.

- operationId: GET_TagUser - parameters: - - description: '

The name of the IAM user to which you want to add tags.

-

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: UserName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: The list of tags that you want to attach to the IAM user. Each - tag consists of a key name and an associated value. - in: query - name: Tags - required: true - schema: - items: - allOf: - - $ref: '#/components/schemas/Tag' - - xml: - name: member - maxItems: 50 - type: array - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: TagUser - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Adds one or more tags to an IAM user. If a tag with the same - key name already exists, then that tag is overwritten with the new value.

-

A tag consists of a key name and an associated value. By assigning tags - to your resources, you can do the following:

  • Administrative - grouping and discovery - Attach tags to resources to aid in organization - and search. For example, you could search for all resources with the key name - Project and the value MyImportantProject. Or search for all - resources with the key name Cost Center and the value 41200. -

  • Access control - Include tags in IAM user-based - and resource-based policies. You can use tags to restrict access to only an - IAM requesting user that has a specified tag attached. You can also restrict - access to only those resources that have a certain tag attached. For examples - of policies that show how to use tags to control access, see Control - access using IAM tags in the IAM User Guide.

  • - Cost allocation - Use tags to help track which individuals and teams - are using which Amazon Web Services resources.

    -

  • If any one of the tags is invalid or if you exceed the allowed maximum - number of tags, then the entire request fails and the resource is not created. - For more information about tagging, see Tagging - IAM resources in the IAM User Guide.

  • Amazon Web - Services always interprets the tag Value as a single string. - If you need to store an array, you can store comma-separated values in the - string. However, you must interpret the value in your code.

-

For more information about tagging, see Tagging - IAM identities in the IAM User Guide.

- operationId: POST_TagUser - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/TagUserRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: TagUser - /?Action=UntagInstanceProfile&Version=2010-05-08: - get: - description: Removes the specified tags from the IAM instance profile. For more - information about tagging, see Tagging - IAM resources in the IAM User Guide. - operationId: GET_UntagInstanceProfile - parameters: - - description: '

The name of the IAM instance profile from which you want - to remove tags.

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: InstanceProfileName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: A list of key names as a simple array of strings. The tags with - matching keys are removed from the specified instance profile. - in: query - name: TagKeys - required: true - schema: - items: - allOf: - - $ref: '#/components/schemas/tagKeyType' - - xml: - name: member - maxItems: 50 - type: array - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UntagInstanceProfile - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description: Removes the specified tags from the IAM instance profile. For more - information about tagging, see Tagging - IAM resources in the IAM User Guide. - operationId: POST_UntagInstanceProfile - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/UntagInstanceProfileRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UntagInstanceProfile - /?Action=UntagMFADevice&Version=2010-05-08: - get: - description: Removes the specified tags from the IAM virtual multi-factor authentication - (MFA) device. For more information about tagging, see Tagging - IAM resources in the IAM User Guide. - operationId: GET_UntagMFADevice - parameters: - - description: '

The unique identifier for the IAM virtual MFA device from - which you want to remove tags. For virtual MFA devices, the serial number - is the same as the ARN.

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: SerialNumber - required: true - schema: - maxLength: 256 - minLength: 9 - pattern: '[\w+=/:,.@-]+' - type: string - - description: A list of key names as a simple array of strings. The tags with - matching keys are removed from the specified instance profile. - in: query - name: TagKeys - required: true - schema: - items: - allOf: - - $ref: '#/components/schemas/tagKeyType' - - xml: - name: member - maxItems: 50 - type: array - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UntagMFADevice - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description: Removes the specified tags from the IAM virtual multi-factor authentication - (MFA) device. For more information about tagging, see Tagging - IAM resources in the IAM User Guide. - operationId: POST_UntagMFADevice - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/UntagMFADeviceRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UntagMFADevice - /?Action=UntagOpenIDConnectProvider&Version=2010-05-08: - get: - description: Removes the specified tags from the specified OpenID Connect (OIDC)-compatible - identity provider in IAM. For more information about OIDC providers, see About - web identity federation. For more information about tagging, see Tagging - IAM resources in the IAM User Guide. - operationId: GET_UntagOpenIDConnectProvider - parameters: - - description: '

The ARN of the OIDC provider in IAM from which you want to - remove tags.

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: OpenIDConnectProviderArn - required: true - schema: - description:

The Amazon Resource Name (ARN). ARNs are unique identifiers - for Amazon Web Services resources.

For more information about ARNs, - go to Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference. -

- maxLength: 2048 - minLength: 20 - type: string - - description: A list of key names as a simple array of strings. The tags with - matching keys are removed from the specified OIDC provider. - in: query - name: TagKeys - required: true - schema: - items: - allOf: - - $ref: '#/components/schemas/tagKeyType' - - xml: - name: member - maxItems: 50 - type: array - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UntagOpenIDConnectProvider - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description: Removes the specified tags from the specified OpenID Connect (OIDC)-compatible - identity provider in IAM. For more information about OIDC providers, see About - web identity federation. For more information about tagging, see Tagging - IAM resources in the IAM User Guide. - operationId: POST_UntagOpenIDConnectProvider - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/UntagOpenIDConnectProviderRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UntagOpenIDConnectProvider - /?Action=UntagPolicy&Version=2010-05-08: - get: - description: Removes the specified tags from the customer managed policy. For - more information about tagging, see Tagging - IAM resources in the IAM User Guide. - operationId: GET_UntagPolicy - parameters: - - description: '

The ARN of the IAM customer managed policy from which you - want to remove tags.

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: PolicyArn - required: true - schema: - description:

The Amazon Resource Name (ARN). ARNs are unique identifiers - for Amazon Web Services resources.

For more information about ARNs, - go to Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference. -

- maxLength: 2048 - minLength: 20 - type: string - - description: A list of key names as a simple array of strings. The tags with - matching keys are removed from the specified policy. - in: query - name: TagKeys - required: true - schema: - items: - allOf: - - $ref: '#/components/schemas/tagKeyType' - - xml: - name: member - maxItems: 50 - type: array - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UntagPolicy - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description: Removes the specified tags from the customer managed policy. For - more information about tagging, see Tagging - IAM resources in the IAM User Guide. - operationId: POST_UntagPolicy - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/UntagPolicyRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UntagPolicy - /?Action=UntagRole&Version=2010-05-08: - get: - description: Removes the specified tags from the role. For more information - about tagging, see Tagging - IAM resources in the IAM User Guide. - operationId: GET_UntagRole - parameters: - - description: '

The name of the IAM role from which you want to remove tags.

-

This parameter accepts (through its regex - pattern) a string of characters that consist of upper and lowercase - alphanumeric characters with no spaces. You can also include any of the - following characters: _+=,.@-

' - in: query - name: RoleName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: A list of key names as a simple array of strings. The tags with - matching keys are removed from the specified role. - in: query - name: TagKeys - required: true - schema: - items: - allOf: - - $ref: '#/components/schemas/tagKeyType' - - xml: - name: member - maxItems: 50 - type: array - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UntagRole - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description: Removes the specified tags from the role. For more information - about tagging, see Tagging - IAM resources in the IAM User Guide. - operationId: POST_UntagRole - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/UntagRoleRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UntagRole - /?Action=UntagSAMLProvider&Version=2010-05-08: - get: - description: Removes the specified tags from the specified Security Assertion - Markup Language (SAML) identity provider in IAM. For more information about - these providers, see About - web identity federation. For more information about tagging, see Tagging - IAM resources in the IAM User Guide. - operationId: GET_UntagSAMLProvider - parameters: - - description: '

The ARN of the SAML identity provider in IAM from which you - want to remove tags.

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: SAMLProviderArn - required: true - schema: - description:

The Amazon Resource Name (ARN). ARNs are unique identifiers - for Amazon Web Services resources.

For more information about ARNs, - go to Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference. -

- maxLength: 2048 - minLength: 20 - type: string - - description: A list of key names as a simple array of strings. The tags with - matching keys are removed from the specified SAML identity provider. - in: query - name: TagKeys - required: true - schema: - items: - allOf: - - $ref: '#/components/schemas/tagKeyType' - - xml: - name: member - maxItems: 50 - type: array - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UntagSAMLProvider - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description: Removes the specified tags from the specified Security Assertion - Markup Language (SAML) identity provider in IAM. For more information about - these providers, see About - web identity federation. For more information about tagging, see Tagging - IAM resources in the IAM User Guide. - operationId: POST_UntagSAMLProvider - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/UntagSAMLProviderRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UntagSAMLProvider - /?Action=UntagServerCertificate&Version=2010-05-08: - get: - description:

Removes the specified tags from the IAM server certificate. - For more information about tagging, see Tagging - IAM resources in the IAM User Guide.

For certificates - in a Region supported by Certificate Manager (ACM), we recommend that you - don't use IAM server certificates. Instead, use ACM to provision, manage, - and deploy your server certificates. For more information about IAM server - certificates, Working - with server certificates in the IAM User Guide.

 - operationId: GET_UntagServerCertificate - parameters: - - description: '

The name of the IAM server certificate from which you want - to remove tags.

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: ServerCertificateName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: A list of key names as a simple array of strings. The tags with - matching keys are removed from the specified IAM server certificate. - in: query - name: TagKeys - required: true - schema: - items: - allOf: - - $ref: '#/components/schemas/tagKeyType' - - xml: - name: member - maxItems: 50 - type: array - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UntagServerCertificate - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Removes the specified tags from the IAM server certificate. - For more information about tagging, see Tagging - IAM resources in the IAM User Guide.

For certificates - in a Region supported by Certificate Manager (ACM), we recommend that you - don't use IAM server certificates. Instead, use ACM to provision, manage, - and deploy your server certificates. For more information about IAM server - certificates, Working - with server certificates in the IAM User Guide.

 - operationId: POST_UntagServerCertificate - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/UntagServerCertificateRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UntagServerCertificate - /?Action=UntagUser&Version=2010-05-08: - get: - description: Removes the specified tags from the user. For more information - about tagging, see Tagging - IAM resources in the IAM User Guide. - operationId: GET_UntagUser - parameters: - - description: '

The name of the IAM user from which you want to remove tags.

-

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: UserName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: A list of key names as a simple array of strings. The tags with - matching keys are removed from the specified user. - in: query - name: TagKeys - required: true - schema: - items: - allOf: - - $ref: '#/components/schemas/tagKeyType' - - xml: - name: member - maxItems: 50 - type: array - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UntagUser - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description: Removes the specified tags from the user. For more information - about tagging, see Tagging - IAM resources in the IAM User Guide. - operationId: POST_UntagUser - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/UntagUserRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UntagUser - /?Action=UpdateAccessKey&Version=2010-05-08: - get: - description:

Changes the status of the specified access key from Active to - Inactive, or vice versa. This operation can be used to disable a user's key - as part of a key rotation workflow.

If the UserName is - not specified, the user name is determined implicitly based on the Amazon - Web Services access key ID used to sign the request. This operation works - for access keys under the Amazon Web Services account. Consequently, you can - use this operation to manage Amazon Web Services account root user credentials - even if the Amazon Web Services account has no associated users.

For - information about rotating keys, see Managing - keys and certificates in the IAM User Guide.

- operationId: GET_UpdateAccessKey - parameters: - - description: '

The name of the user whose key you want to update.

This - parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: UserName - required: false - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description:

The access key ID of the secret access key you want to update.

-

This parameter allows (through its regex - pattern) a string of characters that can consist of any upper or lowercased - letter or digit.

- in: query - name: AccessKeyId - required: true - schema: - maxLength: 128 - minLength: 16 - pattern: '[\w]+' - type: string - - description: ' The status you want to assign to the secret access key. Active - means that the key can be used for programmatic calls to Amazon Web Services, - while Inactive means that the key cannot be used.' - in: query - name: Status - required: true - schema: - enum: - - Active - - Inactive - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UpdateAccessKey - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Changes the status of the specified access key from Active to - Inactive, or vice versa. This operation can be used to disable a user's key - as part of a key rotation workflow.

If the UserName is - not specified, the user name is determined implicitly based on the Amazon - Web Services access key ID used to sign the request. This operation works - for access keys under the Amazon Web Services account. Consequently, you can - use this operation to manage Amazon Web Services account root user credentials - even if the Amazon Web Services account has no associated users.

For - information about rotating keys, see Managing - keys and certificates in the IAM User Guide.

- operationId: POST_UpdateAccessKey - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/UpdateAccessKeyRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UpdateAccessKey - /?Action=UpdateAccountPasswordPolicy&Version=2010-05-08: - get: - description:

Updates the password policy settings for the Amazon Web Services - account.

This operation does not support partial updates. No - parameters are required, but if you do not specify a parameter, that parameter's - value reverts to its default value. See the Request Parameters section - for each parameter's default value. Also note that some parameters do not - allow the default parameter to be explicitly set. Instead, to invoke the default - value, do not include that parameter when you invoke the operation.

 -

For more information about using a password policy, see Managing - an IAM password policy in the IAM User Guide.

- operationId: GET_UpdateAccountPasswordPolicy - parameters: - - description:

The minimum number of characters allowed in an IAM user password.

-

If you do not specify a value for this parameter, then the operation - uses the default value of 6.

- in: query - name: MinimumPasswordLength - required: false - schema: - maximum: 128 - minimum: 6 - type: integer - - description: '

Specifies whether IAM user passwords must contain at least - one of the following non-alphanumeric characters:

! @ # $ % ^ & - * ( ) _ + - = [ ] { } | ''

If you do not specify a value for this - parameter, then the operation uses the default value of false. - The result is that passwords do not require at least one symbol character.

' - in: query - name: RequireSymbols - required: false - schema: - type: boolean - - description:

Specifies whether IAM user passwords must contain at least - one numeric character (0 to 9).

If you do not specify a value for - this parameter, then the operation uses the default value of false. - The result is that passwords do not require at least one numeric character.

- in: query - name: RequireNumbers - required: false - schema: - type: boolean - - description:

Specifies whether IAM user passwords must contain at least - one uppercase character from the ISO basic Latin alphabet (A to Z).

-

If you do not specify a value for this parameter, then the operation - uses the default value of false. The result is that passwords - do not require at least one uppercase character.

- in: query - name: RequireUppercaseCharacters - required: false - schema: - type: boolean - - description:

Specifies whether IAM user passwords must contain at least - one lowercase character from the ISO basic Latin alphabet (a to z).

-

If you do not specify a value for this parameter, then the operation - uses the default value of false. The result is that passwords - do not require at least one lowercase character.

- in: query - name: RequireLowercaseCharacters - required: false - schema: - type: boolean - - description:

Allows all IAM users in your account to use the Amazon Web - Services Management Console to change their own passwords. For more information, - see Permitting - IAM users to change their own passwords in the IAM User Guide.

-

If you do not specify a value for this parameter, then the operation - uses the default value of false. The result is that IAM users - in the account do not automatically have permissions to change their own - password.

- in: query - name: AllowUsersToChangePassword - required: false - schema: - type: boolean - - description:

The number of days that an IAM user password is valid.

-

If you do not specify a value for this parameter, then the operation - uses the default value of 0. The result is that IAM user passwords - never expire.

- in: query - name: MaxPasswordAge - required: false - schema: - maximum: 1095 - minimum: 1 - type: integer - - description:

Specifies the number of previous passwords that IAM users - are prevented from reusing.

If you do not specify a value for this - parameter, then the operation uses the default value of 0. - The result is that IAM users are not prevented from reusing previous passwords.

- in: query - name: PasswordReusePrevention - required: false - schema: - maximum: 24 - minimum: 1 - type: integer - - description:

Prevents IAM users who are accessing the account via the - Amazon Web Services Management Console from setting a new console password - after their password has expired. The IAM user cannot access the console - until an administrator resets the password.

If you do not specify - a value for this parameter, then the operation uses the default value of - false. The result is that IAM users can change their passwords - after they expire and continue to sign in as the user.

In - the Amazon Web Services Management Console, the custom password policy option - Allow users to change their own password gives IAM users permissions - to iam:ChangePassword for only their user and to the iam:GetAccountPasswordPolicy - action. This option does not attach a permissions policy to each user, rather - the permissions are applied at the account-level for all users by IAM. IAM - users with iam:ChangePassword permission and active access - keys can reset their own expired console password using the CLI or API.

- - in: query - name: HardExpiry - required: false - schema: - type: boolean - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/MalformedPolicyDocumentException' - description: MalformedPolicyDocumentException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UpdateAccountPasswordPolicy - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Updates the password policy settings for the Amazon Web Services - account.

This operation does not support partial updates. No - parameters are required, but if you do not specify a parameter, that parameter's - value reverts to its default value. See the Request Parameters section - for each parameter's default value. Also note that some parameters do not - allow the default parameter to be explicitly set. Instead, to invoke the default - value, do not include that parameter when you invoke the operation.

 -

For more information about using a password policy, see Managing - an IAM password policy in the IAM User Guide.

- operationId: POST_UpdateAccountPasswordPolicy - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/UpdateAccountPasswordPolicyRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/MalformedPolicyDocumentException' - description: MalformedPolicyDocumentException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UpdateAccountPasswordPolicy - /?Action=UpdateAssumeRolePolicy&Version=2010-05-08: - get: - description: Updates the policy that grants an IAM entity permission to assume - a role. This is typically referred to as the "role trust policy". For more - information about roles, see Using - roles to delegate permissions and federate identities. - operationId: GET_UpdateAssumeRolePolicy - parameters: - - description: '

The name of the role to update with the new policy.

This - parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: RoleName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description:

The policy that grants an entity permission to assume the - role.

You must provide policies in JSON format in IAM. However, for - CloudFormation templates formatted in YAML, you can provide the policy in - JSON or YAML format. CloudFormation always converts a YAML policy to JSON - format before submitting it to IAM.

The regex - pattern used to validate this parameter is a string of characters consisting - of the following:

  • Any printable ASCII character ranging - from the space character (\u0020) through the end of the ASCII - character range

  • The printable characters in the Basic - Latin and Latin-1 Supplement character set (through \u00FF)

    -

  • The special characters tab (\u0009), line feed - (\u000A), and carriage return (\u000D)

    • -
- in: query - name: PolicyDocument - required: true - schema: - maxLength: 131072 - minLength: 1 - pattern: '[\u0009\u000A\u000D\u0020-\u00FF]+' - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/MalformedPolicyDocumentException' - description: MalformedPolicyDocumentException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/UnmodifiableEntityException' - description: UnmodifiableEntityException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UpdateAssumeRolePolicy - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description: Updates the policy that grants an IAM entity permission to assume - a role. This is typically referred to as the "role trust policy". For more - information about roles, see Using - roles to delegate permissions and federate identities. - operationId: POST_UpdateAssumeRolePolicy - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/UpdateAssumeRolePolicyRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/MalformedPolicyDocumentException' - description: MalformedPolicyDocumentException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/UnmodifiableEntityException' - description: UnmodifiableEntityException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UpdateAssumeRolePolicy - /?Action=UpdateGroup&Version=2010-05-08: - get: - description:

Updates the name and/or the path of the specified IAM group.

-

You should understand the implications of changing a group's - path or name. For more information, see Renaming - users and groups in the IAM User Guide.

 -

The person making the request (the principal), must have permission to - change the role group with the old name and the new name. For example, to - change the group named Managers to MGRs, the principal - must have a policy that allows them to update both groups. If the principal - has permission to update the Managers group, but not the MGRs - group, then the update fails. For more information about permissions, see - Access - management.

- operationId: GET_UpdateGroup - parameters: - - description: '

Name of the IAM group to update. If you''re changing the - name of the group, this is the original name.

This parameter allows - (through its regex pattern) - a string of characters consisting of upper and lowercase alphanumeric characters - with no spaces. You can also include any of the following characters: _+=,.@-

' - in: query - name: GroupName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description:

New path for the IAM group. Only include this if changing - the group's path.

This parameter allows (through its regex - pattern) a string of characters consisting of either a forward slash - (/) by itself or a string that must begin and end with forward slashes. - In addition, it can contain any ASCII character from the ! (\u0021) - through the DEL character (\u007F), including most punctuation - characters, digits, and upper and lowercased letters.

- in: query - name: NewPath - required: false - schema: - maxLength: 512 - minLength: 1 - pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F) - type: string - - description:

New name for the IAM group. Only include this if changing - the group's name.

IAM user, group, role, and policy names must be - unique within the account. Names are not distinguished by case. For example, - you cannot create resources named both "MyResource" and "myresource".

- in: query - name: NewGroupName - required: false - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityAlreadyExistsException' - description: EntityAlreadyExistsException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UpdateGroup - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Updates the name and/or the path of the specified IAM group.

-

You should understand the implications of changing a group's - path or name. For more information, see Renaming - users and groups in the IAM User Guide.

 -

The person making the request (the principal), must have permission to - change the role group with the old name and the new name. For example, to - change the group named Managers to MGRs, the principal - must have a policy that allows them to update both groups. If the principal - has permission to update the Managers group, but not the MGRs - group, then the update fails. For more information about permissions, see - Access - management.

- operationId: POST_UpdateGroup - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/UpdateGroupRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityAlreadyExistsException' - description: EntityAlreadyExistsException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UpdateGroup - /?Action=UpdateLoginProfile&Version=2010-05-08: - get: - description:

Changes the password for the specified IAM user. You can use - the CLI, the Amazon Web Services API, or the Users page in the IAM - console to change the password for any IAM user. Use ChangePassword - to change your own password in the My Security Credentials page in - the Amazon Web Services Management Console.

For more information about - modifying passwords, see Managing - passwords in the IAM User Guide.

- operationId: GET_UpdateLoginProfile - parameters: - - description: '

The name of the user whose password you want to update.

-

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: UserName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description:

The new password for the specified IAM user.

The regex pattern used to validate - this parameter is a string of characters consisting of the following:

-

  • Any printable ASCII character ranging from the space character - (\u0020) through the end of the ASCII character range

    • -

  • The printable characters in the Basic Latin and Latin-1 Supplement - character set (through \u00FF)

  • The special - characters tab (\u0009), line feed (\u000A), and - carriage return (\u000D)

However, the format - can be further restricted by the account administrator by setting a password - policy on the Amazon Web Services account. For more information, see UpdateAccountPasswordPolicy.

- in: query - name: Password - required: false - schema: - format: password - maxLength: 128 - minLength: 1 - pattern: '[\u0009\u000A\u000D\u0020-\u00FF]+' - type: string - - description: Allows this new password to be used only once by requiring the - specified IAM user to set a new password on next sign-in. - in: query - name: PasswordResetRequired - required: false - schema: - type: boolean - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityTemporarilyUnmodifiableException' - description: EntityTemporarilyUnmodifiableException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/PasswordPolicyViolationException' - description: PasswordPolicyViolationException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UpdateLoginProfile - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Changes the password for the specified IAM user. You can use - the CLI, the Amazon Web Services API, or the Users page in the IAM - console to change the password for any IAM user. Use ChangePassword - to change your own password in the My Security Credentials page in - the Amazon Web Services Management Console.

For more information about - modifying passwords, see Managing - passwords in the IAM User Guide.

- operationId: POST_UpdateLoginProfile - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/UpdateLoginProfileRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityTemporarilyUnmodifiableException' - description: EntityTemporarilyUnmodifiableException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/PasswordPolicyViolationException' - description: PasswordPolicyViolationException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UpdateLoginProfile - /?Action=UpdateOpenIDConnectProviderThumbprint&Version=2010-05-08: - get: - description:

Replaces the existing list of server certificate thumbprints - associated with an OpenID Connect (OIDC) provider resource object with a new - list of thumbprints.

The list that you pass with this operation completely - replaces the existing list of thumbprints. (The lists are not merged.)

-

Typically, you need to update a thumbprint only when the identity provider - certificate changes, which occurs rarely. However, if the provider's certificate - does change, any attempt to assume an IAM role that specifies the OIDC - provider as a principal fails until the certificate thumbprint is updated.

-

Amazon Web Services secures communication with some OIDC identity - providers (IdPs) through our library of trusted certificate authorities (CAs) - instead of using a certificate thumbprint to verify your IdP server certificate. - These OIDC IdPs include Google, and those that use an Amazon S3 bucket to - host a JSON Web Key Set (JWKS) endpoint. In these cases, your legacy thumbprint - remains in your configuration, but is no longer used for validation.

 -

Trust for the OIDC provider is derived from the provider certificate - and is validated by the thumbprint. Therefore, it is best to limit access - to the UpdateOpenIDConnectProviderThumbprint operation to highly - privileged users.

 - operationId: GET_UpdateOpenIDConnectProviderThumbprint - parameters: - - description:

The Amazon Resource Name (ARN) of the IAM OIDC provider resource - object for which you want to update the thumbprint. You can get a list of - OIDC provider ARNs by using the ListOpenIDConnectProviders operation.

-

For more information about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.

- in: query - name: OpenIDConnectProviderArn - required: true - schema: - description:

The Amazon Resource Name (ARN). ARNs are unique identifiers - for Amazon Web Services resources.

For more information about ARNs, - go to Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference. -

- maxLength: 2048 - minLength: 20 - type: string - - description: 'A list of certificate thumbprints that are associated with the - specified IAM OpenID Connect provider. For more information, see CreateOpenIDConnectProvider. ' - in: query - name: ThumbprintList - required: true - schema: - description: Contains a list of thumbprints of identity provider server - certificates. - items: - allOf: - - $ref: '#/components/schemas/thumbprintType' - - xml: - name: member - type: array - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UpdateOpenIDConnectProviderThumbprint - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Replaces the existing list of server certificate thumbprints - associated with an OpenID Connect (OIDC) provider resource object with a new - list of thumbprints.

The list that you pass with this operation completely - replaces the existing list of thumbprints. (The lists are not merged.)

-

Typically, you need to update a thumbprint only when the identity provider - certificate changes, which occurs rarely. However, if the provider's certificate - does change, any attempt to assume an IAM role that specifies the OIDC - provider as a principal fails until the certificate thumbprint is updated.

-

Amazon Web Services secures communication with some OIDC identity - providers (IdPs) through our library of trusted certificate authorities (CAs) - instead of using a certificate thumbprint to verify your IdP server certificate. - These OIDC IdPs include Google, and those that use an Amazon S3 bucket to - host a JSON Web Key Set (JWKS) endpoint. In these cases, your legacy thumbprint - remains in your configuration, but is no longer used for validation.

 -

Trust for the OIDC provider is derived from the provider certificate - and is validated by the thumbprint. Therefore, it is best to limit access - to the UpdateOpenIDConnectProviderThumbprint operation to highly - privileged users.

 - operationId: POST_UpdateOpenIDConnectProviderThumbprint - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/UpdateOpenIDConnectProviderThumbprintRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UpdateOpenIDConnectProviderThumbprint - /?Action=UpdateRole&Version=2010-05-08: - get: - description: Updates the description or maximum session duration setting of - a role. - operationId: GET_UpdateRole - parameters: - - description: The name of the role that you want to modify. - in: query - name: RoleName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: The new description that you want to apply to the specified role. - in: query - name: Description - required: false - schema: - maxLength: 1000 - pattern: '[\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}]*' - type: string - - description:

The maximum session duration (in seconds) that you want to - set for the specified role. If you do not specify a value for this setting, - the default maximum of one hour is applied. This setting can have a value - from 1 hour to 12 hours.

Anyone who assumes the role from the CLI - or API can use the DurationSeconds API parameter or the duration-seconds - CLI parameter to request a longer session. The MaxSessionDuration - setting determines the maximum duration that can be requested using the - DurationSeconds parameter. If users don't specify a value for - the DurationSeconds parameter, their security credentials are - valid for one hour by default. This applies when you use the AssumeRole* - API operations or the assume-role* CLI operations but does - not apply when you use those operations to create a console URL. For more - information, see Using - IAM roles in the IAM User Guide.

- in: query - name: MaxSessionDuration - required: false - schema: - maximum: 43200 - minimum: 3600 - type: integer - responses: - '200': - content: - text/xml: - schema: - properties: - UpdateRoleResult: - $ref: '#/components/schemas/UpdateRoleResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/UnmodifiableEntityException' - description: UnmodifiableEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UpdateRole - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description: Updates the description or maximum session duration setting of - a role. - operationId: POST_UpdateRole - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/UpdateRoleRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - UpdateRoleResult: - $ref: '#/components/schemas/UpdateRoleResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/UnmodifiableEntityException' - description: UnmodifiableEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UpdateRole - /?Action=UpdateRoleDescription&Version=2010-05-08: - get: - description:

Use UpdateRole instead.

Modifies only the description - of a role. This operation performs the same function as the Description - parameter in the UpdateRole operation.

- operationId: GET_UpdateRoleDescription - parameters: - - description: The name of the role that you want to modify. - in: query - name: RoleName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description: The new description that you want to apply to the specified role. - in: query - name: Description - required: true - schema: - maxLength: 1000 - pattern: '[\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}]*' - type: string - responses: - '200': - content: - text/xml: - schema: - properties: - UpdateRoleDescriptionResult: - $ref: '#/components/schemas/UpdateRoleDescriptionResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/UnmodifiableEntityException' - description: UnmodifiableEntityException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UpdateRoleDescription - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Use UpdateRole instead.

Modifies only the description - of a role. This operation performs the same function as the Description - parameter in the UpdateRole operation.

- operationId: POST_UpdateRoleDescription - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/UpdateRoleDescriptionRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - UpdateRoleDescriptionResult: - $ref: '#/components/schemas/UpdateRoleDescriptionResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/UnmodifiableEntityException' - description: UnmodifiableEntityException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UpdateRoleDescription - /?Action=UpdateSAMLProvider&Version=2010-05-08: - get: - description:

Updates the metadata document for an existing SAML provider - resource object.

This operation requires Signature - Version 4.

 - operationId: GET_UpdateSAMLProvider - parameters: - - description: An XML document generated by an identity provider (IdP) that - supports SAML 2.0. The document includes the issuer's name, expiration information, - and keys that can be used to validate the SAML authentication response (assertions) - that are received from the IdP. You must generate the metadata document - using the identity management software that is used as your organization's - IdP. - in: query - name: SAMLMetadataDocument - required: true - schema: - maxLength: 10000000 - minLength: 1000 - type: string - - description:

The Amazon Resource Name (ARN) of the SAML provider to update.

-

For more information about ARNs, see Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference.

- in: query - name: SAMLProviderArn - required: true - schema: - description:

The Amazon Resource Name (ARN). ARNs are unique identifiers - for Amazon Web Services resources.

For more information about ARNs, - go to Amazon - Resource Names (ARNs) in the Amazon Web Services General Reference. -

- maxLength: 2048 - minLength: 20 - type: string - responses: - '200': - content: - text/xml: - schema: - properties: - UpdateSAMLProviderResult: - $ref: '#/components/schemas/UpdateSAMLProviderResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UpdateSAMLProvider - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Updates the metadata document for an existing SAML provider - resource object.

This operation requires Signature - Version 4.

 - operationId: POST_UpdateSAMLProvider - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/UpdateSAMLProviderRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - UpdateSAMLProviderResult: - $ref: '#/components/schemas/UpdateSAMLProviderResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UpdateSAMLProvider - /?Action=UpdateSSHPublicKey&Version=2010-05-08: - get: - description:

Sets the status of an IAM user's SSH public key to active or - inactive. SSH public keys that are inactive cannot be used for authentication. - This operation can be used to disable a user's SSH public key as part of a - key rotation work flow.

The SSH public key affected by this operation - is used only for authenticating the associated IAM user to an CodeCommit repository. - For more information about using SSH keys to authenticate to an CodeCommit - repository, see Set - up CodeCommit for SSH connections in the CodeCommit User Guide.

- operationId: GET_UpdateSSHPublicKey - parameters: - - description: '

The name of the IAM user associated with the SSH public key.

-

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: UserName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description:

The unique identifier for the SSH public key.

This - parameter allows (through its regex - pattern) a string of characters that can consist of any upper or lowercased - letter or digit.

- in: query - name: SSHPublicKeyId - required: true - schema: - maxLength: 128 - minLength: 20 - pattern: '[\w]+' - type: string - - description: The status to assign to the SSH public key. Active - means that the key can be used for authentication with an CodeCommit repository. - Inactive means that the key cannot be used. - in: query - name: Status - required: true - schema: - enum: - - Active - - Inactive - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - x-aws-operation-name: UpdateSSHPublicKey - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Sets the status of an IAM user's SSH public key to active or - inactive. SSH public keys that are inactive cannot be used for authentication. - This operation can be used to disable a user's SSH public key as part of a - key rotation work flow.

The SSH public key affected by this operation - is used only for authenticating the associated IAM user to an CodeCommit repository. - For more information about using SSH keys to authenticate to an CodeCommit - repository, see Set - up CodeCommit for SSH connections in the CodeCommit User Guide.

- operationId: POST_UpdateSSHPublicKey - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/UpdateSSHPublicKeyRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - x-aws-operation-name: UpdateSSHPublicKey - /?Action=UpdateServerCertificate&Version=2010-05-08: - get: - description:

Updates the name and/or the path of the specified server certificate - stored in IAM.

For more information about working with server certificates, - see Working - with server certificates in the IAM User Guide. This topic also - includes a list of Amazon Web Services services that can use the server certificates - that you manage with IAM.

You should understand the implications - of changing a server certificate's path or name. For more information, see - Renaming - a server certificate in the IAM User Guide.

 -

The person making the request (the principal), must have permission to - change the server certificate with the old name and the new name. For example, - to change the certificate named ProductionCert to ProdCert, - the principal must have a policy that allows them to update both certificates. - If the principal has permission to update the ProductionCert - group, but not the ProdCert certificate, then the update fails. - For more information about permissions, see Access - management in the IAM User Guide.

 - operationId: GET_UpdateServerCertificate - parameters: - - description: '

The name of the server certificate that you want to update.

-

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: ServerCertificateName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description:

The new path for the server certificate. Include this only - if you are updating the server certificate's path.

This parameter - allows (through its regex pattern) - a string of characters consisting of either a forward slash (/) by itself - or a string that must begin and end with forward slashes. In addition, it - can contain any ASCII character from the ! (\u0021) through - the DEL character (\u007F), including most punctuation characters, - digits, and upper and lowercased letters.

- in: query - name: NewPath - required: false - schema: - maxLength: 512 - minLength: 1 - pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F) - type: string - - description: '

The new name for the server certificate. Include this only - if you are updating the server certificate''s name. The name of the certificate - cannot contain any spaces.

This parameter allows (through its regex pattern) a string of characters - consisting of upper and lowercase alphanumeric characters with no spaces. - You can also include any of the following characters: _+=,.@-

' - in: query - name: NewServerCertificateName - required: false - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityAlreadyExistsException' - description: EntityAlreadyExistsException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UpdateServerCertificate - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Updates the name and/or the path of the specified server certificate - stored in IAM.

For more information about working with server certificates, - see Working - with server certificates in the IAM User Guide. This topic also - includes a list of Amazon Web Services services that can use the server certificates - that you manage with IAM.

You should understand the implications - of changing a server certificate's path or name. For more information, see - Renaming - a server certificate in the IAM User Guide.

 -

The person making the request (the principal), must have permission to - change the server certificate with the old name and the new name. For example, - to change the certificate named ProductionCert to ProdCert, - the principal must have a policy that allows them to update both certificates. - If the principal has permission to update the ProductionCert - group, but not the ProdCert certificate, then the update fails. - For more information about permissions, see Access - management in the IAM User Guide.

 - operationId: POST_UpdateServerCertificate - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/UpdateServerCertificateRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityAlreadyExistsException' - description: EntityAlreadyExistsException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UpdateServerCertificate - /?Action=UpdateServiceSpecificCredential&Version=2010-05-08: - get: - description: Sets the status of a service-specific credential to Active - or Inactive. Service-specific credentials that are inactive cannot - be used for authentication to the service. This operation can be used to disable - a user's service-specific credential as part of a credential rotation work - flow. - operationId: GET_UpdateServiceSpecificCredential - parameters: - - description: '

The name of the IAM user associated with the service-specific - credential. If you do not specify this value, then the operation assumes - the user whose credentials are used to call the operation.

This parameter - allows (through its regex pattern) - a string of characters consisting of upper and lowercase alphanumeric characters - with no spaces. You can also include any of the following characters: _+=,.@-

' - in: query - name: UserName - required: false - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description:

The unique identifier of the service-specific credential.

-

This parameter allows (through its regex - pattern) a string of characters that can consist of any upper or lowercased - letter or digit.

- in: query - name: ServiceSpecificCredentialId - required: true - schema: - maxLength: 128 - minLength: 20 - pattern: '[\w]+' - type: string - - description: The status to be assigned to the service-specific credential. - in: query - name: Status - required: true - schema: - enum: - - Active - - Inactive - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - x-aws-operation-name: UpdateServiceSpecificCredential - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description: Sets the status of a service-specific credential to Active - or Inactive. Service-specific credentials that are inactive cannot - be used for authentication to the service. This operation can be used to disable - a user's service-specific credential as part of a credential rotation work - flow. - operationId: POST_UpdateServiceSpecificCredential - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/UpdateServiceSpecificCredentialRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - x-aws-operation-name: UpdateServiceSpecificCredential - /?Action=UpdateSigningCertificate&Version=2010-05-08: - get: - description:

Changes the status of the specified user signing certificate - from active to disabled, or vice versa. This operation can be used to disable - an IAM user's signing certificate as part of a certificate rotation work flow.

-

If the UserName field is not specified, the user name is determined - implicitly based on the Amazon Web Services access key ID used to sign the - request. This operation works for access keys under the Amazon Web Services - account. Consequently, you can use this operation to manage Amazon Web Services - account root user credentials even if the Amazon Web Services account has - no associated users.

- operationId: GET_UpdateSigningCertificate - parameters: - - description: '

The name of the IAM user the signing certificate belongs - to.

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: UserName - required: false - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description:

The ID of the signing certificate you want to update.

-

This parameter allows (through its regex - pattern) a string of characters that can consist of any upper or lowercased - letter or digit.

- in: query - name: CertificateId - required: true - schema: - maxLength: 128 - minLength: 24 - pattern: '[\w]+' - type: string - - description: ' The status you want to assign to the certificate. Active - means that the certificate can be used for programmatic calls to Amazon - Web Services Inactive means that the certificate cannot be - used.' - in: query - name: Status - required: true - schema: - enum: - - Active - - Inactive - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UpdateSigningCertificate - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Changes the status of the specified user signing certificate - from active to disabled, or vice versa. This operation can be used to disable - an IAM user's signing certificate as part of a certificate rotation work flow.

-

If the UserName field is not specified, the user name is determined - implicitly based on the Amazon Web Services access key ID used to sign the - request. This operation works for access keys under the Amazon Web Services - account. Consequently, you can use this operation to manage Amazon Web Services - account root user credentials even if the Amazon Web Services account has - no associated users.

- operationId: POST_UpdateSigningCertificate - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/UpdateSigningCertificateRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UpdateSigningCertificate - /?Action=UpdateUser&Version=2010-05-08: - get: - description:

Updates the name and/or the path of the specified IAM user.

-

You should understand the implications of changing an IAM - user's path or name. For more information, see Renaming - an IAM user and Renaming - an IAM group in the IAM User Guide.

- To change a user name, the requester must have appropriate permissions on - both the source object and the target object. For example, to change Bob to - Robert, the entity making the request must have permission on Bob and Robert, - or must have permission on all (*). For more information about permissions, - see Permissions - and policies.

- operationId: GET_UpdateUser - parameters: - - description: '

Name of the user to update. If you''re changing the name - of the user, this is the original user name.

This parameter allows - (through its regex pattern) - a string of characters consisting of upper and lowercase alphanumeric characters - with no spaces. You can also include any of the following characters: _+=,.@-

' - in: query - name: UserName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description:

New path for the IAM user. Include this parameter only if - you're changing the user's path.

This parameter allows (through its - regex pattern) a string of - characters consisting of either a forward slash (/) by itself or a string - that must begin and end with forward slashes. In addition, it can contain - any ASCII character from the ! (\u0021) through the DEL character - (\u007F), including most punctuation characters, digits, and - upper and lowercased letters.

- in: query - name: NewPath - required: false - schema: - maxLength: 512 - minLength: 1 - pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F) - type: string - - description:

New name for the user. Include this parameter only if you're - changing the user's name.

IAM user, group, role, and policy names - must be unique within the account. Names are not distinguished by case. - For example, you cannot create resources named both "MyResource" and "myresource".

- in: query - name: NewUserName - required: false - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityAlreadyExistsException' - description: EntityAlreadyExistsException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityTemporarilyUnmodifiableException' - description: EntityTemporarilyUnmodifiableException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '485': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UpdateUser - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Updates the name and/or the path of the specified IAM user.

-

You should understand the implications of changing an IAM - user's path or name. For more information, see Renaming - an IAM user and Renaming - an IAM group in the IAM User Guide.

- To change a user name, the requester must have appropriate permissions on - both the source object and the target object. For example, to change Bob to - Robert, the entity making the request must have permission on Bob and Robert, - or must have permission on all (*). For more information about permissions, - see Permissions - and policies.

- operationId: POST_UpdateUser - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/UpdateUserRequest' - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityAlreadyExistsException' - description: EntityAlreadyExistsException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityTemporarilyUnmodifiableException' - description: EntityTemporarilyUnmodifiableException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '485': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UpdateUser - /?Action=UploadSSHPublicKey&Version=2010-05-08: - get: - description:

Uploads an SSH public key and associates it with the specified - IAM user.

The SSH public key uploaded by this operation can be used - only for authenticating the associated IAM user to an CodeCommit repository. - For more information about using SSH keys to authenticate to an CodeCommit - repository, see Set - up CodeCommit for SSH connections in the CodeCommit User Guide.

- operationId: GET_UploadSSHPublicKey - parameters: - - description: '

The name of the IAM user to associate the SSH public key - with.

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: UserName - required: true - schema: - maxLength: 64 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description:

The SSH public key. The public key must be encoded in ssh-rsa - format or PEM format. The minimum bit-length of the public key is 2048 bits. - For example, you can generate a 2048-bit key, and the resulting PEM file - is 1679 bytes long.

The regex - pattern used to validate this parameter is a string of characters consisting - of the following:

  • Any printable ASCII character ranging - from the space character (\u0020) through the end of the ASCII - character range

  • The printable characters in the Basic - Latin and Latin-1 Supplement character set (through \u00FF)

    -

  • The special characters tab (\u0009), line feed - (\u000A), and carriage return (\u000D)

    • -
- in: query - name: SSHPublicKeyBody - required: true - schema: - maxLength: 16384 - minLength: 1 - pattern: '[\u0009\u000A\u000D\u0020-\u00FF]+' - type: string - responses: - '200': - content: - text/xml: - schema: - properties: - UploadSSHPublicKeyResult: - $ref: '#/components/schemas/UploadSSHPublicKeyResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidPublicKeyException' - description: InvalidPublicKeyException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/DuplicateSSHPublicKeyException' - description: DuplicateSSHPublicKeyException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/UnrecognizedPublicKeyEncodingException' - description: UnrecognizedPublicKeyEncodingException - x-aws-operation-name: UploadSSHPublicKey - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Uploads an SSH public key and associates it with the specified - IAM user.

The SSH public key uploaded by this operation can be used - only for authenticating the associated IAM user to an CodeCommit repository. - For more information about using SSH keys to authenticate to an CodeCommit - repository, see Set - up CodeCommit for SSH connections in the CodeCommit User Guide.

- operationId: POST_UploadSSHPublicKey - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/UploadSSHPublicKeyRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - UploadSSHPublicKeyResult: - $ref: '#/components/schemas/UploadSSHPublicKeyResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidPublicKeyException' - description: InvalidPublicKeyException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/DuplicateSSHPublicKeyException' - description: DuplicateSSHPublicKeyException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/UnrecognizedPublicKeyEncodingException' - description: UnrecognizedPublicKeyEncodingException - x-aws-operation-name: UploadSSHPublicKey - /?Action=UploadServerCertificate&Version=2010-05-08: - get: - description:

Uploads a server certificate entity for the Amazon Web Services - account. The server certificate entity includes a public key certificate, - a private key, and an optional certificate chain, which should all be PEM-encoded.

-

We recommend that you use Certificate - Manager to provision, manage, and deploy your server certificates. With - ACM you can request a certificate, deploy it to Amazon Web Services resources, - and let ACM handle certificate renewals for you. Certificates provided by - ACM are free. For more information about using ACM, see the Certificate - Manager User Guide.

For more information about working with server - certificates, see Working - with server certificates in the IAM User Guide. This topic includes - a list of Amazon Web Services services that can use the server certificates - that you manage with IAM.

For information about the number of server - certificates you can upload, see IAM - and STS quotas in the IAM User Guide.

Because the - body of the public key certificate, private key, and the certificate chain - can be large, you should use POST rather than GET when calling UploadServerCertificate. - For information about setting up signatures and authorization through the - API, see Signing - Amazon Web Services API requests in the Amazon Web Services General - Reference. For general information about using the Query API with IAM, - see Calling - the API by making HTTP query requests in the IAM User Guide.

- - operationId: GET_UploadServerCertificate - parameters: - - description:

The path for the server certificate. For more information - about paths, see IAM - identifiers in the IAM User Guide.

This parameter is optional. - If it is not included, it defaults to a slash (/). This parameter allows - (through its regex pattern) - a string of characters consisting of either a forward slash (/) by itself - or a string that must begin and end with forward slashes. In addition, it - can contain any ASCII character from the ! (\u0021) through - the DEL character (\u007F), including most punctuation characters, - digits, and upper and lowercased letters.

If you are uploading - a server certificate specifically for use with Amazon CloudFront distributions, - you must specify a path using the path parameter. The path - must begin with /cloudfront and must include a trailing slash - (for example, /cloudfront/test/).

 - in: query - name: Path - required: false - schema: - maxLength: 512 - minLength: 1 - pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F) - type: string - - description: '

The name for the server certificate. Do not include the path - in this value. The name of the certificate cannot contain any spaces.

-

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: ServerCertificateName - required: true - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description:

The contents of the public key certificate in PEM-encoded - format.

The regex pattern - used to validate this parameter is a string of characters consisting of - the following:

  • Any printable ASCII character ranging from - the space character (\u0020) through the end of the ASCII character - range

  • The printable characters in the Basic Latin and - Latin-1 Supplement character set (through \u00FF)

    • -

  • The special characters tab (\u0009), line feed (\u000A), - and carriage return (\u000D)

- in: query - name: CertificateBody - required: true - schema: - maxLength: 16384 - minLength: 1 - pattern: '[\u0009\u000A\u000D\u0020-\u00FF]+' - type: string - - description:

The contents of the private key in PEM-encoded format.

-

The regex pattern used - to validate this parameter is a string of characters consisting of the following:

-

  • Any printable ASCII character ranging from the space character - (\u0020) through the end of the ASCII character range

    • -

  • The printable characters in the Basic Latin and Latin-1 Supplement - character set (through \u00FF)

  • The special - characters tab (\u0009), line feed (\u000A), and - carriage return (\u000D)

- in: query - name: PrivateKey - required: true - schema: - format: password - maxLength: 16384 - minLength: 1 - pattern: '[\u0009\u000A\u000D\u0020-\u00FF]+' - type: string - - description:

The contents of the certificate chain. This is typically a - concatenation of the PEM-encoded public key certificates of the chain.

-

The regex pattern used - to validate this parameter is a string of characters consisting of the following:

-

  • Any printable ASCII character ranging from the space character - (\u0020) through the end of the ASCII character range

    • -

  • The printable characters in the Basic Latin and Latin-1 Supplement - character set (through \u00FF)

  • The special - characters tab (\u0009), line feed (\u000A), and - carriage return (\u000D)

- in: query - name: CertificateChain - required: false - schema: - maxLength: 2097152 - minLength: 1 - pattern: '[\u0009\u000A\u000D\u0020-\u00FF]+' - type: string - - description:

A list of tags that you want to attach to the new IAM server - certificate resource. Each tag consists of a key name and an associated - value. For more information about tagging, see Tagging - IAM resources in the IAM User Guide.

If any one - of the tags is invalid or if you exceed the allowed maximum number of tags, - then the entire request fails and the resource is not created.

 - in: query - name: Tags - required: false - schema: - items: - allOf: - - $ref: '#/components/schemas/Tag' - - xml: - name: member - maxItems: 50 - type: array - responses: - '200': - content: - text/xml: - schema: - properties: - UploadServerCertificateResult: - $ref: '#/components/schemas/UploadServerCertificateResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityAlreadyExistsException' - description: EntityAlreadyExistsException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/MalformedCertificateException' - description: MalformedCertificateException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/KeyPairMismatchException' - description: KeyPairMismatchException - '485': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '486': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UploadServerCertificate - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Uploads a server certificate entity for the Amazon Web Services - account. The server certificate entity includes a public key certificate, - a private key, and an optional certificate chain, which should all be PEM-encoded.

-

We recommend that you use Certificate - Manager to provision, manage, and deploy your server certificates. With - ACM you can request a certificate, deploy it to Amazon Web Services resources, - and let ACM handle certificate renewals for you. Certificates provided by - ACM are free. For more information about using ACM, see the Certificate - Manager User Guide.

For more information about working with server - certificates, see Working - with server certificates in the IAM User Guide. This topic includes - a list of Amazon Web Services services that can use the server certificates - that you manage with IAM.

For information about the number of server - certificates you can upload, see IAM - and STS quotas in the IAM User Guide.

Because the - body of the public key certificate, private key, and the certificate chain - can be large, you should use POST rather than GET when calling UploadServerCertificate. - For information about setting up signatures and authorization through the - API, see Signing - Amazon Web Services API requests in the Amazon Web Services General - Reference. For general information about using the Query API with IAM, - see Calling - the API by making HTTP query requests in the IAM User Guide.

- - operationId: POST_UploadServerCertificate - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/UploadServerCertificateRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - UploadServerCertificateResult: - $ref: '#/components/schemas/UploadServerCertificateResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidInputException' - description: InvalidInputException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityAlreadyExistsException' - description: EntityAlreadyExistsException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/MalformedCertificateException' - description: MalformedCertificateException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/KeyPairMismatchException' - description: KeyPairMismatchException - '485': - content: - text/xml: - schema: - $ref: '#/components/schemas/ConcurrentModificationException' - description: ConcurrentModificationException - '486': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UploadServerCertificate - /?Action=UploadSigningCertificate&Version=2010-05-08: - get: - description:

Uploads an X.509 signing certificate and associates it with - the specified IAM user. Some Amazon Web Services services require you to use - certificates to validate requests that are signed with a corresponding private - key. When you upload the certificate, its default status is Active.

-

For information about when you would use an X.509 signing certificate, - see Managing - server certificates in IAM in the IAM User Guide.

If the - UserName is not specified, the IAM user name is determined implicitly - based on the Amazon Web Services access key ID used to sign the request. This - operation works for access keys under the Amazon Web Services account. Consequently, - you can use this operation to manage Amazon Web Services account root user - credentials even if the Amazon Web Services account has no associated users.

-

Because the body of an X.509 certificate can be large, you should - use POST rather than GET when calling UploadSigningCertificate. - For information about setting up signatures and authorization through the - API, see Signing - Amazon Web Services API requests in the Amazon Web Services General - Reference. For general information about using the Query API with IAM, - see Making - query requests in the IAM User Guide.

 - operationId: GET_UploadSigningCertificate - parameters: - - description: '

The name of the user the signing certificate is for.

-

This parameter allows (through its regex - pattern) a string of characters consisting of upper and lowercase alphanumeric - characters with no spaces. You can also include any of the following characters: - _+=,.@-

' - in: query - name: UserName - required: false - schema: - maxLength: 128 - minLength: 1 - pattern: '[\w+=,.@-]+' - type: string - - description:

The contents of the signing certificate.

The regex - pattern used to validate this parameter is a string of characters consisting - of the following:

  • Any printable ASCII character ranging - from the space character (\u0020) through the end of the ASCII - character range

  • The printable characters in the Basic - Latin and Latin-1 Supplement character set (through \u00FF)

    -

  • The special characters tab (\u0009), line feed - (\u000A), and carriage return (\u000D)

    • -
- in: query - name: CertificateBody - required: true - schema: - maxLength: 16384 - minLength: 1 - pattern: '[\u0009\u000A\u000D\u0020-\u00FF]+' - type: string - responses: - '200': - content: - text/xml: - schema: - properties: - UploadSigningCertificateResult: - $ref: '#/components/schemas/UploadSigningCertificateResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityAlreadyExistsException' - description: EntityAlreadyExistsException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/MalformedCertificateException' - description: MalformedCertificateException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidCertificateException' - description: InvalidCertificateException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/DuplicateCertificateException' - description: DuplicateCertificateException - '485': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '486': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UploadSigningCertificate - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - description:

Uploads an X.509 signing certificate and associates it with - the specified IAM user. Some Amazon Web Services services require you to use - certificates to validate requests that are signed with a corresponding private - key. When you upload the certificate, its default status is Active.

-

For information about when you would use an X.509 signing certificate, - see Managing - server certificates in IAM in the IAM User Guide.

If the - UserName is not specified, the IAM user name is determined implicitly - based on the Amazon Web Services access key ID used to sign the request. This - operation works for access keys under the Amazon Web Services account. Consequently, - you can use this operation to manage Amazon Web Services account root user - credentials even if the Amazon Web Services account has no associated users.

-

Because the body of an X.509 certificate can be large, you should - use POST rather than GET when calling UploadSigningCertificate. - For information about setting up signatures and authorization through the - API, see Signing - Amazon Web Services API requests in the Amazon Web Services General - Reference. For general information about using the Query API with IAM, - see Making - query requests in the IAM User Guide.

 - operationId: POST_UploadSigningCertificate - parameters: [] - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/UploadSigningCertificateRequest' - responses: - '200': - content: - text/xml: - schema: - properties: - UploadSigningCertificateResult: - $ref: '#/components/schemas/UploadSigningCertificateResponse' - type: object - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/LimitExceededException' - description: LimitExceededException - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/EntityAlreadyExistsException' - description: EntityAlreadyExistsException - '482': - content: - text/xml: - schema: - $ref: '#/components/schemas/MalformedCertificateException' - description: MalformedCertificateException - '483': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidCertificateException' - description: InvalidCertificateException - '484': - content: - text/xml: - schema: - $ref: '#/components/schemas/DuplicateCertificateException' - description: DuplicateCertificateException - '485': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchEntityException' - description: NoSuchEntityException - '486': - content: - text/xml: - schema: - $ref: '#/components/schemas/ServiceFailureException' - description: ServiceFailureException - x-aws-operation-name: UploadSigningCertificate -security: -- hmac: [] -servers: -- description: The general IAM multi-region endpoint - url: https://iam.amazonaws.com - variables: - region: - description: The AWS region - enum: - - us-east-1 - - us-east-2 - - us-west-1 - - us-west-2 - - us-gov-west-1 - - us-gov-east-1 - - ca-central-1 - - eu-north-1 - - eu-west-1 - - eu-west-2 - - eu-west-3 - - eu-central-1 - - eu-south-1 - - af-south-1 - - ap-northeast-1 - - ap-northeast-2 - - ap-northeast-3 - - ap-southeast-1 - - ap-southeast-2 - - ap-east-1 - - ap-south-1 - - sa-east-1 - - me-south-1 - default: us-east-1 -x-stackQL-config: - queryParamTranspose: - algorithm: AWSCanonical - requestTranslate: - algorithm: get_query_to_post_form_utf_8 \ No newline at end of file diff --git a/providers/src/aws/v00.00.00000/services/identitystore.yaml b/providers/src/aws/v00.00.00000/services/identitystore.yaml index 7181dda4..625eb085 100644 --- a/providers/src/aws/v00.00.00000/services/identitystore.yaml +++ b/providers/src/aws/v00.00.00000/services/identitystore.yaml @@ -616,7 +616,7 @@ components: x-identifiers: - GroupId - IdentityStoreId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -633,9 +633,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -645,44 +645,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/groups/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/groups/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.GroupId') as group_id, - JSON_EXTRACT(Properties, '$.IdentityStoreId') as identity_store_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IdentityStore::Group' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'GroupId') as group_id, - json_extract_path_text(Properties, 'IdentityStoreId') as identity_store_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IdentityStore::Group' - AND region = 'us-east-1' - group: - name: group - id: aws.identitystore.group - x-cfn-schema-name: Group - x-cfn-type-name: AWS::IdentityStore::Group - x-identifiers: - - GroupId - - IdentityStoreId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -693,12 +658,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/groups/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/group/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -711,18 +680,36 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'DisplayName') as display_name, - json_extract_path_text(Properties, 'GroupId') as group_id, - json_extract_path_text(Properties, 'IdentityStoreId') as identity_store_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IdentityStore::Group' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.GroupId') as group_id, + JSON_EXTRACT(Properties, '$.IdentityStoreId') as identity_store_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IdentityStore::Group' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'DisplayName') as display_name, + json_extract_path_text(Properties, 'GroupId') as group_id, + json_extract_path_text(Properties, 'IdentityStoreId') as identity_store_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IdentityStore::Group' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'GroupId') as group_id, + json_extract_path_text(Properties, 'IdentityStoreId') as identity_store_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IdentityStore::Group' + AND region = 'us-east-1' group_memberships: name: group_memberships id: aws.identitystore.group_memberships @@ -731,7 +718,7 @@ components: x-identifiers: - MembershipId - IdentityStoreId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -765,42 +752,11 @@ components: - $ref: '#/components/x-stackQL-resources/group_memberships/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/group_memberships/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.MembershipId') as membership_id, - JSON_EXTRACT(Properties, '$.IdentityStoreId') as identity_store_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IdentityStore::GroupMembership' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'MembershipId') as membership_id, - json_extract_path_text(Properties, 'IdentityStoreId') as identity_store_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IdentityStore::GroupMembership' - AND region = 'us-east-1' - group_membership: - name: group_membership - id: aws.identitystore.group_membership - x-cfn-schema-name: GroupMembership - x-cfn-type-name: AWS::IdentityStore::GroupMembership - x-identifiers: - - MembershipId - - IdentityStoreId - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -813,18 +769,36 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'GroupId') as group_id, - json_extract_path_text(Properties, 'IdentityStoreId') as identity_store_id, - json_extract_path_text(Properties, 'MemberId') as member_id, - json_extract_path_text(Properties, 'MembershipId') as membership_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IdentityStore::GroupMembership' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.MembershipId') as membership_id, + JSON_EXTRACT(Properties, '$.IdentityStoreId') as identity_store_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IdentityStore::GroupMembership' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'GroupId') as group_id, + json_extract_path_text(Properties, 'IdentityStoreId') as identity_store_id, + json_extract_path_text(Properties, 'MemberId') as member_id, + json_extract_path_text(Properties, 'MembershipId') as membership_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IdentityStore::GroupMembership' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'MembershipId') as membership_id, + json_extract_path_text(Properties, 'IdentityStoreId') as identity_store_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IdentityStore::GroupMembership' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/imagebuilder.yaml b/providers/src/aws/v00.00.00000/services/imagebuilder.yaml index e3713987..24bfaa22 100644 --- a/providers/src/aws/v00.00.00000/services/imagebuilder.yaml +++ b/providers/src/aws/v00.00.00000/services/imagebuilder.yaml @@ -2425,7 +2425,7 @@ components: x-cfn-type-name: AWS::ImageBuilder::Component x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2459,39 +2459,11 @@ components: - $ref: '#/components/x-stackQL-resources/components/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/components/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::Component' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::Component' - AND region = 'us-east-1' - component: - name: component - id: aws.imagebuilder.component - x-cfn-schema-name: Component - x-cfn-type-name: AWS::ImageBuilder::Component - x-identifiers: - - Arn - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2513,27 +2485,43 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Version') as version, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'ChangeDescription') as change_description, - json_extract_path_text(Properties, 'Type') as type, - json_extract_path_text(Properties, 'Platform') as platform, - json_extract_path_text(Properties, 'Data') as data, - json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, - json_extract_path_text(Properties, 'Encrypted') as encrypted, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Uri') as uri, - json_extract_path_text(Properties, 'SupportedOsVersions') as supported_os_versions - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ImageBuilder::Component' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::Component' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Version') as version, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'ChangeDescription') as change_description, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'Platform') as platform, + json_extract_path_text(Properties, 'Data') as data, + json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, + json_extract_path_text(Properties, 'Encrypted') as encrypted, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Uri') as uri, + json_extract_path_text(Properties, 'SupportedOsVersions') as supported_os_versions + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ImageBuilder::Component' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::Component' + AND region = 'us-east-1' container_recipes: name: container_recipes id: aws.imagebuilder.container_recipes @@ -2541,7 +2529,7 @@ components: x-cfn-type-name: AWS::ImageBuilder::ContainerRecipe x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2575,39 +2563,11 @@ components: - $ref: '#/components/x-stackQL-resources/container_recipes/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/container_recipes/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::ContainerRecipe' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::ContainerRecipe' - AND region = 'us-east-1' - container_recipe: - name: container_recipe - id: aws.imagebuilder.container_recipe - x-cfn-schema-name: ContainerRecipe - x-cfn-type-name: AWS::ImageBuilder::ContainerRecipe - x-identifiers: - - Arn - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2632,30 +2592,46 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Version') as version, - json_extract_path_text(Properties, 'Components') as components, - json_extract_path_text(Properties, 'InstanceConfiguration') as instance_configuration, - json_extract_path_text(Properties, 'DockerfileTemplateData') as dockerfile_template_data, - json_extract_path_text(Properties, 'DockerfileTemplateUri') as dockerfile_template_uri, - json_extract_path_text(Properties, 'PlatformOverride') as platform_override, - json_extract_path_text(Properties, 'ContainerType') as container_type, - json_extract_path_text(Properties, 'ImageOsVersionOverride') as image_os_version_override, - json_extract_path_text(Properties, 'TargetRepository') as target_repository, - json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, - json_extract_path_text(Properties, 'ParentImage') as parent_image, - json_extract_path_text(Properties, 'WorkingDirectory') as working_directory, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ImageBuilder::ContainerRecipe' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::ContainerRecipe' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Version') as version, + json_extract_path_text(Properties, 'Components') as components, + json_extract_path_text(Properties, 'InstanceConfiguration') as instance_configuration, + json_extract_path_text(Properties, 'DockerfileTemplateData') as dockerfile_template_data, + json_extract_path_text(Properties, 'DockerfileTemplateUri') as dockerfile_template_uri, + json_extract_path_text(Properties, 'PlatformOverride') as platform_override, + json_extract_path_text(Properties, 'ContainerType') as container_type, + json_extract_path_text(Properties, 'ImageOsVersionOverride') as image_os_version_override, + json_extract_path_text(Properties, 'TargetRepository') as target_repository, + json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, + json_extract_path_text(Properties, 'ParentImage') as parent_image, + json_extract_path_text(Properties, 'WorkingDirectory') as working_directory, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ImageBuilder::ContainerRecipe' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::ContainerRecipe' + AND region = 'us-east-1' distribution_configurations: name: distribution_configurations id: aws.imagebuilder.distribution_configurations @@ -2663,7 +2639,7 @@ components: x-cfn-type-name: AWS::ImageBuilder::DistributionConfiguration x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2680,9 +2656,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2692,41 +2668,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/distribution_configurations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/distribution_configurations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::DistributionConfiguration' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::DistributionConfiguration' - AND region = 'us-east-1' - distribution_configuration: - name: distribution_configuration - id: aws.imagebuilder.distribution_configuration - x-cfn-schema-name: DistributionConfiguration - x-cfn-type-name: AWS::ImageBuilder::DistributionConfiguration - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2737,12 +2681,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/distribution_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/distribution_configurations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/distribution_configuration/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/distribution_configurations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2756,19 +2704,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Distributions') as distributions, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ImageBuilder::DistributionConfiguration' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::DistributionConfiguration' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Distributions') as distributions, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ImageBuilder::DistributionConfiguration' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::DistributionConfiguration' + AND region = 'us-east-1' images: name: images id: aws.imagebuilder.images @@ -2776,7 +2740,7 @@ components: x-cfn-type-name: AWS::ImageBuilder::Image x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2810,39 +2774,11 @@ components: - $ref: '#/components/x-stackQL-resources/images/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/images/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::Image' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::Image' - AND region = 'us-east-1' - image: - name: image - id: aws.imagebuilder.image - x-cfn-schema-name: Image - x-cfn-type-name: AWS::ImageBuilder::Image - x-identifiers: - - Arn - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2865,28 +2801,44 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'ImageTestsConfiguration') as image_tests_configuration, - json_extract_path_text(Properties, 'ImageRecipeArn') as image_recipe_arn, - json_extract_path_text(Properties, 'ContainerRecipeArn') as container_recipe_arn, - json_extract_path_text(Properties, 'DistributionConfigurationArn') as distribution_configuration_arn, - json_extract_path_text(Properties, 'InfrastructureConfigurationArn') as infrastructure_configuration_arn, - json_extract_path_text(Properties, 'Workflows') as workflows, - json_extract_path_text(Properties, 'ImageId') as image_id, - json_extract_path_text(Properties, 'ImageUri') as image_uri, - json_extract_path_text(Properties, 'EnhancedImageMetadataEnabled') as enhanced_image_metadata_enabled, - json_extract_path_text(Properties, 'ImageScanningConfiguration') as image_scanning_configuration, - json_extract_path_text(Properties, 'ExecutionRole') as execution_role, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ImageBuilder::Image' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::Image' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'ImageTestsConfiguration') as image_tests_configuration, + json_extract_path_text(Properties, 'ImageRecipeArn') as image_recipe_arn, + json_extract_path_text(Properties, 'ContainerRecipeArn') as container_recipe_arn, + json_extract_path_text(Properties, 'DistributionConfigurationArn') as distribution_configuration_arn, + json_extract_path_text(Properties, 'InfrastructureConfigurationArn') as infrastructure_configuration_arn, + json_extract_path_text(Properties, 'Workflows') as workflows, + json_extract_path_text(Properties, 'ImageId') as image_id, + json_extract_path_text(Properties, 'ImageUri') as image_uri, + json_extract_path_text(Properties, 'EnhancedImageMetadataEnabled') as enhanced_image_metadata_enabled, + json_extract_path_text(Properties, 'ImageScanningConfiguration') as image_scanning_configuration, + json_extract_path_text(Properties, 'ExecutionRole') as execution_role, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ImageBuilder::Image' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::Image' + AND region = 'us-east-1' image_pipelines: name: image_pipelines id: aws.imagebuilder.image_pipelines @@ -2894,7 +2846,7 @@ components: x-cfn-type-name: AWS::ImageBuilder::ImagePipeline x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2911,9 +2863,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2923,41 +2875,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/image_pipelines/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/image_pipelines/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::ImagePipeline' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::ImagePipeline' - AND region = 'us-east-1' - image_pipeline: - name: image_pipeline - id: aws.imagebuilder.image_pipeline - x-cfn-schema-name: ImagePipeline - x-cfn-type-name: AWS::ImageBuilder::ImagePipeline - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2968,12 +2888,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/image_pipelines/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/image_pipelines/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/image_pipeline/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/image_pipelines/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2997,29 +2921,45 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'ImageTestsConfiguration') as image_tests_configuration, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'Schedule') as schedule, - json_extract_path_text(Properties, 'ImageRecipeArn') as image_recipe_arn, - json_extract_path_text(Properties, 'ContainerRecipeArn') as container_recipe_arn, - json_extract_path_text(Properties, 'DistributionConfigurationArn') as distribution_configuration_arn, - json_extract_path_text(Properties, 'InfrastructureConfigurationArn') as infrastructure_configuration_arn, - json_extract_path_text(Properties, 'Workflows') as workflows, - json_extract_path_text(Properties, 'EnhancedImageMetadataEnabled') as enhanced_image_metadata_enabled, - json_extract_path_text(Properties, 'ImageScanningConfiguration') as image_scanning_configuration, - json_extract_path_text(Properties, 'ExecutionRole') as execution_role, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ImageBuilder::ImagePipeline' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::ImagePipeline' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'ImageTestsConfiguration') as image_tests_configuration, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'Schedule') as schedule, + json_extract_path_text(Properties, 'ImageRecipeArn') as image_recipe_arn, + json_extract_path_text(Properties, 'ContainerRecipeArn') as container_recipe_arn, + json_extract_path_text(Properties, 'DistributionConfigurationArn') as distribution_configuration_arn, + json_extract_path_text(Properties, 'InfrastructureConfigurationArn') as infrastructure_configuration_arn, + json_extract_path_text(Properties, 'Workflows') as workflows, + json_extract_path_text(Properties, 'EnhancedImageMetadataEnabled') as enhanced_image_metadata_enabled, + json_extract_path_text(Properties, 'ImageScanningConfiguration') as image_scanning_configuration, + json_extract_path_text(Properties, 'ExecutionRole') as execution_role, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ImageBuilder::ImagePipeline' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::ImagePipeline' + AND region = 'us-east-1' image_recipes: name: image_recipes id: aws.imagebuilder.image_recipes @@ -3027,7 +2967,7 @@ components: x-cfn-type-name: AWS::ImageBuilder::ImageRecipe x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3061,39 +3001,11 @@ components: - $ref: '#/components/x-stackQL-resources/image_recipes/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/image_recipes/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::ImageRecipe' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::ImageRecipe' - AND region = 'us-east-1' - image_recipe: - name: image_recipe - id: aws.imagebuilder.image_recipe - x-cfn-schema-name: ImageRecipe - x-cfn-type-name: AWS::ImageBuilder::ImageRecipe - x-identifiers: - - Arn - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3112,24 +3024,40 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Version') as version, - json_extract_path_text(Properties, 'Components') as components, - json_extract_path_text(Properties, 'BlockDeviceMappings') as block_device_mappings, - json_extract_path_text(Properties, 'ParentImage') as parent_image, - json_extract_path_text(Properties, 'WorkingDirectory') as working_directory, - json_extract_path_text(Properties, 'AdditionalInstanceConfiguration') as additional_instance_configuration, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ImageBuilder::ImageRecipe' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::ImageRecipe' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Version') as version, + json_extract_path_text(Properties, 'Components') as components, + json_extract_path_text(Properties, 'BlockDeviceMappings') as block_device_mappings, + json_extract_path_text(Properties, 'ParentImage') as parent_image, + json_extract_path_text(Properties, 'WorkingDirectory') as working_directory, + json_extract_path_text(Properties, 'AdditionalInstanceConfiguration') as additional_instance_configuration, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ImageBuilder::ImageRecipe' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::ImageRecipe' + AND region = 'us-east-1' infrastructure_configurations: name: infrastructure_configurations id: aws.imagebuilder.infrastructure_configurations @@ -3137,7 +3065,7 @@ components: x-cfn-type-name: AWS::ImageBuilder::InfrastructureConfiguration x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3154,9 +3082,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3166,41 +3094,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/infrastructure_configurations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/infrastructure_configurations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::InfrastructureConfiguration' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::InfrastructureConfiguration' - AND region = 'us-east-1' - infrastructure_configuration: - name: infrastructure_configuration - id: aws.imagebuilder.infrastructure_configuration - x-cfn-schema-name: InfrastructureConfiguration - x-cfn-type-name: AWS::ImageBuilder::InfrastructureConfiguration - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3211,12 +3107,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/infrastructure_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/infrastructure_configurations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/infrastructure_configuration/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/infrastructure_configurations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3239,28 +3139,44 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'InstanceTypes') as instance_types, - json_extract_path_text(Properties, 'SecurityGroupIds') as security_group_ids, - json_extract_path_text(Properties, 'Logging') as logging, - json_extract_path_text(Properties, 'SubnetId') as subnet_id, - json_extract_path_text(Properties, 'KeyPair') as key_pair, - json_extract_path_text(Properties, 'TerminateInstanceOnFailure') as terminate_instance_on_failure, - json_extract_path_text(Properties, 'InstanceProfileName') as instance_profile_name, - json_extract_path_text(Properties, 'InstanceMetadataOptions') as instance_metadata_options, - json_extract_path_text(Properties, 'SnsTopicArn') as sns_topic_arn, - json_extract_path_text(Properties, 'ResourceTags') as resource_tags, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ImageBuilder::InfrastructureConfiguration' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::InfrastructureConfiguration' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'InstanceTypes') as instance_types, + json_extract_path_text(Properties, 'SecurityGroupIds') as security_group_ids, + json_extract_path_text(Properties, 'Logging') as logging, + json_extract_path_text(Properties, 'SubnetId') as subnet_id, + json_extract_path_text(Properties, 'KeyPair') as key_pair, + json_extract_path_text(Properties, 'TerminateInstanceOnFailure') as terminate_instance_on_failure, + json_extract_path_text(Properties, 'InstanceProfileName') as instance_profile_name, + json_extract_path_text(Properties, 'InstanceMetadataOptions') as instance_metadata_options, + json_extract_path_text(Properties, 'SnsTopicArn') as sns_topic_arn, + json_extract_path_text(Properties, 'ResourceTags') as resource_tags, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ImageBuilder::InfrastructureConfiguration' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::InfrastructureConfiguration' + AND region = 'us-east-1' lifecycle_policies: name: lifecycle_policies id: aws.imagebuilder.lifecycle_policies @@ -3268,7 +3184,7 @@ components: x-cfn-type-name: AWS::ImageBuilder::LifecyclePolicy x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3285,9 +3201,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3297,41 +3213,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/lifecycle_policies/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/lifecycle_policies/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::LifecyclePolicy' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::LifecyclePolicy' - AND region = 'us-east-1' - lifecycle_policy: - name: lifecycle_policy - id: aws.imagebuilder.lifecycle_policy - x-cfn-schema-name: LifecyclePolicy - x-cfn-type-name: AWS::ImageBuilder::LifecyclePolicy - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3342,12 +3226,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/lifecycle_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/lifecycle_policies/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/lifecycle_policy/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/lifecycle_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3365,23 +3253,39 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'ExecutionRole') as execution_role, - json_extract_path_text(Properties, 'ResourceType') as resource_type, - json_extract_path_text(Properties, 'PolicyDetails') as policy_details, - json_extract_path_text(Properties, 'ResourceSelection') as resource_selection, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ImageBuilder::LifecyclePolicy' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::LifecyclePolicy' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'ExecutionRole') as execution_role, + json_extract_path_text(Properties, 'ResourceType') as resource_type, + json_extract_path_text(Properties, 'PolicyDetails') as policy_details, + json_extract_path_text(Properties, 'ResourceSelection') as resource_selection, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ImageBuilder::LifecyclePolicy' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::LifecyclePolicy' + AND region = 'us-east-1' workflows: name: workflows id: aws.imagebuilder.workflows @@ -3389,7 +3293,7 @@ components: x-cfn-type-name: AWS::ImageBuilder::Workflow x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3423,39 +3327,11 @@ components: - $ref: '#/components/x-stackQL-resources/workflows/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/workflows/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::Workflow' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::Workflow' - AND region = 'us-east-1' - workflow: - name: workflow - id: aws.imagebuilder.workflow - x-cfn-schema-name: Workflow - x-cfn-type-name: AWS::ImageBuilder::Workflow - x-identifiers: - - Arn - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3474,24 +3350,40 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Version') as version, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'ChangeDescription') as change_description, - json_extract_path_text(Properties, 'Type') as type, - json_extract_path_text(Properties, 'Data') as data, - json_extract_path_text(Properties, 'Uri') as uri, - json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ImageBuilder::Workflow' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::Workflow' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Version') as version, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'ChangeDescription') as change_description, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'Data') as data, + json_extract_path_text(Properties, 'Uri') as uri, + json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ImageBuilder::Workflow' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ImageBuilder::Workflow' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/inspector.yaml b/providers/src/aws/v00.00.00000/services/inspector.yaml index 503d815c..bedd569f 100644 --- a/providers/src/aws/v00.00.00000/services/inspector.yaml +++ b/providers/src/aws/v00.00.00000/services/inspector.yaml @@ -608,7 +608,7 @@ components: x-cfn-type-name: AWS::Inspector::AssessmentTarget x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -625,9 +625,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -637,41 +637,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/assessment_targets/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/assessment_targets/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Inspector::AssessmentTarget' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Inspector::AssessmentTarget' - AND region = 'us-east-1' - assessment_target: - name: assessment_target - id: aws.inspector.assessment_target - x-cfn-schema-name: AssessmentTarget - x-cfn-type-name: AWS::Inspector::AssessmentTarget - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -682,12 +650,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/assessment_targets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/assessment_targets/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/assessment_target/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/assessment_targets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -699,17 +671,33 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'AssessmentTargetName') as assessment_target_name, - json_extract_path_text(Properties, 'ResourceGroupArn') as resource_group_arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Inspector::AssessmentTarget' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Inspector::AssessmentTarget' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'AssessmentTargetName') as assessment_target_name, + json_extract_path_text(Properties, 'ResourceGroupArn') as resource_group_arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Inspector::AssessmentTarget' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Inspector::AssessmentTarget' + AND region = 'us-east-1' assessment_templates: name: assessment_templates id: aws.inspector.assessment_templates @@ -717,7 +705,7 @@ components: x-cfn-type-name: AWS::Inspector::AssessmentTemplate x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -751,39 +739,11 @@ components: - $ref: '#/components/x-stackQL-resources/assessment_templates/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/assessment_templates/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Inspector::AssessmentTemplate' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Inspector::AssessmentTemplate' - AND region = 'us-east-1' - assessment_template: - name: assessment_template - id: aws.inspector.assessment_template - x-cfn-schema-name: AssessmentTemplate - x-cfn-type-name: AWS::Inspector::AssessmentTemplate - x-identifiers: - - Arn - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -798,20 +758,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'AssessmentTargetArn') as assessment_target_arn, - json_extract_path_text(Properties, 'DurationInSeconds') as duration_in_seconds, - json_extract_path_text(Properties, 'AssessmentTemplateName') as assessment_template_name, - json_extract_path_text(Properties, 'RulesPackageArns') as rules_package_arns, - json_extract_path_text(Properties, 'UserAttributesForFindings') as user_attributes_for_findings - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Inspector::AssessmentTemplate' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Inspector::AssessmentTemplate' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'AssessmentTargetArn') as assessment_target_arn, + json_extract_path_text(Properties, 'DurationInSeconds') as duration_in_seconds, + json_extract_path_text(Properties, 'AssessmentTemplateName') as assessment_template_name, + json_extract_path_text(Properties, 'RulesPackageArns') as rules_package_arns, + json_extract_path_text(Properties, 'UserAttributesForFindings') as user_attributes_for_findings + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Inspector::AssessmentTemplate' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Inspector::AssessmentTemplate' + AND region = 'us-east-1' resource_groups: name: resource_groups id: aws.inspector.resource_groups @@ -819,7 +795,7 @@ components: x-cfn-type-name: AWS::Inspector::ResourceGroup x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -853,21 +829,11 @@ components: - $ref: '#/components/x-stackQL-resources/resource_groups/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/resource_groups/methods/delete_resource' - resource_group: - name: resource_group - id: aws.inspector.resource_group - x-cfn-schema-name: ResourceGroup - x-cfn-type-name: AWS::Inspector::ResourceGroup - x-identifiers: - - Arn - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -878,7 +844,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, diff --git a/providers/src/aws/v00.00.00000/services/inspectorv2.yaml b/providers/src/aws/v00.00.00000/services/inspectorv2.yaml index 68193f49..ffb05c68 100644 --- a/providers/src/aws/v00.00.00000/services/inspectorv2.yaml +++ b/providers/src/aws/v00.00.00000/services/inspectorv2.yaml @@ -894,7 +894,7 @@ components: x-cfn-type-name: AWS::InspectorV2::CisScanConfiguration x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -911,9 +911,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -923,41 +923,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/cis_scan_configurations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/cis_scan_configurations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::InspectorV2::CisScanConfiguration' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::InspectorV2::CisScanConfiguration' - AND region = 'us-east-1' - cis_scan_configuration: - name: cis_scan_configuration - id: aws.inspectorv2.cis_scan_configuration - x-cfn-schema-name: CisScanConfiguration - x-cfn-type-name: AWS::InspectorV2::CisScanConfiguration - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -968,12 +936,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/cis_scan_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/cis_scan_configurations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/cis_scan_configuration/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/cis_scan_configurations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -988,20 +960,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ScanName') as scan_name, - json_extract_path_text(Properties, 'SecurityLevel') as security_level, - json_extract_path_text(Properties, 'Schedule') as schedule, - json_extract_path_text(Properties, 'Targets') as targets, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::InspectorV2::CisScanConfiguration' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::InspectorV2::CisScanConfiguration' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ScanName') as scan_name, + json_extract_path_text(Properties, 'SecurityLevel') as security_level, + json_extract_path_text(Properties, 'Schedule') as schedule, + json_extract_path_text(Properties, 'Targets') as targets, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::InspectorV2::CisScanConfiguration' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::InspectorV2::CisScanConfiguration' + AND region = 'us-east-1' filters: name: filters id: aws.inspectorv2.filters @@ -1009,7 +997,7 @@ components: x-cfn-type-name: AWS::InspectorV2::Filter x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1026,9 +1014,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1038,41 +1026,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/filters/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/filters/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::InspectorV2::Filter' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::InspectorV2::Filter' - AND region = 'us-east-1' - filter: - name: filter - id: aws.inspectorv2.filter - x-cfn-schema-name: Filter - x-cfn-type-name: AWS::InspectorV2::Filter - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1083,12 +1039,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/filters/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/filters/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/filter/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/filters/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1102,19 +1062,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'FilterCriteria') as filter_criteria, - json_extract_path_text(Properties, 'FilterAction') as filter_action, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::InspectorV2::Filter' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::InspectorV2::Filter' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'FilterCriteria') as filter_criteria, + json_extract_path_text(Properties, 'FilterAction') as filter_action, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::InspectorV2::Filter' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::InspectorV2::Filter' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/internetmonitor.yaml b/providers/src/aws/v00.00.00000/services/internetmonitor.yaml index d8b73500..7c6a9707 100644 --- a/providers/src/aws/v00.00.00000/services/internetmonitor.yaml +++ b/providers/src/aws/v00.00.00000/services/internetmonitor.yaml @@ -702,7 +702,7 @@ components: x-cfn-type-name: AWS::InternetMonitor::Monitor x-identifiers: - MonitorName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -719,9 +719,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -731,41 +731,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/monitors/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/monitors/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.MonitorName') as monitor_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::InternetMonitor::Monitor' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'MonitorName') as monitor_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::InternetMonitor::Monitor' - AND region = 'us-east-1' - monitor: - name: monitor - id: aws.internetmonitor.monitor - x-cfn-schema-name: Monitor - x-cfn-type-name: AWS::InternetMonitor::Monitor - x-identifiers: - - MonitorName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -776,12 +744,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/monitors/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/monitors/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/monitor/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/monitors/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -807,31 +779,47 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'CreatedAt') as created_at, - json_extract_path_text(Properties, 'ModifiedAt') as modified_at, - json_extract_path_text(Properties, 'MonitorArn') as monitor_arn, - json_extract_path_text(Properties, 'MonitorName') as monitor_name, - json_extract_path_text(Properties, 'LinkedAccountId') as linked_account_id, - json_extract_path_text(Properties, 'IncludeLinkedAccounts') as include_linked_accounts, - json_extract_path_text(Properties, 'ProcessingStatus') as processing_status, - json_extract_path_text(Properties, 'ProcessingStatusInfo') as processing_status_info, - json_extract_path_text(Properties, 'Resources') as resources, - json_extract_path_text(Properties, 'ResourcesToAdd') as resources_to_add, - json_extract_path_text(Properties, 'ResourcesToRemove') as resources_to_remove, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'MaxCityNetworksToMonitor') as max_city_networks_to_monitor, - json_extract_path_text(Properties, 'TrafficPercentageToMonitor') as traffic_percentage_to_monitor, - json_extract_path_text(Properties, 'InternetMeasurementsLogDelivery') as internet_measurements_log_delivery, - json_extract_path_text(Properties, 'HealthEventsConfig') as health_events_config - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::InternetMonitor::Monitor' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.MonitorName') as monitor_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::InternetMonitor::Monitor' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'ModifiedAt') as modified_at, + json_extract_path_text(Properties, 'MonitorArn') as monitor_arn, + json_extract_path_text(Properties, 'MonitorName') as monitor_name, + json_extract_path_text(Properties, 'LinkedAccountId') as linked_account_id, + json_extract_path_text(Properties, 'IncludeLinkedAccounts') as include_linked_accounts, + json_extract_path_text(Properties, 'ProcessingStatus') as processing_status, + json_extract_path_text(Properties, 'ProcessingStatusInfo') as processing_status_info, + json_extract_path_text(Properties, 'Resources') as resources, + json_extract_path_text(Properties, 'ResourcesToAdd') as resources_to_add, + json_extract_path_text(Properties, 'ResourcesToRemove') as resources_to_remove, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'MaxCityNetworksToMonitor') as max_city_networks_to_monitor, + json_extract_path_text(Properties, 'TrafficPercentageToMonitor') as traffic_percentage_to_monitor, + json_extract_path_text(Properties, 'InternetMeasurementsLogDelivery') as internet_measurements_log_delivery, + json_extract_path_text(Properties, 'HealthEventsConfig') as health_events_config + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::InternetMonitor::Monitor' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'MonitorName') as monitor_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::InternetMonitor::Monitor' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/iot.yaml b/providers/src/aws/v00.00.00000/services/iot.yaml index 5f76e75c..28aafa4d 100644 --- a/providers/src/aws/v00.00.00000/services/iot.yaml +++ b/providers/src/aws/v00.00.00000/services/iot.yaml @@ -4930,7 +4930,7 @@ components: x-cfn-type-name: AWS::IoT::AccountAuditConfiguration x-identifiers: - AccountId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -4947,9 +4947,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -4959,41 +4959,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/account_audit_configurations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/account_audit_configurations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AccountId') as account_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::AccountAuditConfiguration' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AccountId') as account_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::AccountAuditConfiguration' - AND region = 'us-east-1' - account_audit_configuration: - name: account_audit_configuration - id: aws.iot.account_audit_configuration - x-cfn-schema-name: AccountAuditConfiguration - x-cfn-type-name: AWS::IoT::AccountAuditConfiguration - x-identifiers: - - AccountId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -5004,12 +4972,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/account_audit_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/account_audit_configurations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/account_audit_configuration/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/account_audit_configurations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -5022,18 +4994,34 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AccountId') as account_id, - json_extract_path_text(Properties, 'AuditCheckConfigurations') as audit_check_configurations, - json_extract_path_text(Properties, 'AuditNotificationTargetConfigurations') as audit_notification_target_configurations, - json_extract_path_text(Properties, 'RoleArn') as role_arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::AccountAuditConfiguration' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.AccountId') as account_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::AccountAuditConfiguration' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AccountId') as account_id, + json_extract_path_text(Properties, 'AuditCheckConfigurations') as audit_check_configurations, + json_extract_path_text(Properties, 'AuditNotificationTargetConfigurations') as audit_notification_target_configurations, + json_extract_path_text(Properties, 'RoleArn') as role_arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::AccountAuditConfiguration' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AccountId') as account_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::AccountAuditConfiguration' + AND region = 'us-east-1' authorizers: name: authorizers id: aws.iot.authorizers @@ -5041,7 +5029,7 @@ components: x-cfn-type-name: AWS::IoT::Authorizer x-identifiers: - AuthorizerName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -5058,9 +5046,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -5070,41 +5058,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/authorizers/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/authorizers/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AuthorizerName') as authorizer_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::Authorizer' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AuthorizerName') as authorizer_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::Authorizer' - AND region = 'us-east-1' - authorizer: - name: authorizer - id: aws.iot.authorizer - x-cfn-schema-name: Authorizer - x-cfn-type-name: AWS::IoT::Authorizer - x-identifiers: - - AuthorizerName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -5115,12 +5071,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/authorizers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/authorizers/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/authorizer/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/authorizers/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -5138,23 +5098,39 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AuthorizerFunctionArn') as authorizer_function_arn, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'AuthorizerName') as authorizer_name, - json_extract_path_text(Properties, 'SigningDisabled') as signing_disabled, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'TokenKeyName') as token_key_name, - json_extract_path_text(Properties, 'TokenSigningPublicKeys') as token_signing_public_keys, - json_extract_path_text(Properties, 'EnableCachingForHttp') as enable_caching_for_http, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::Authorizer' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.AuthorizerName') as authorizer_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::Authorizer' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AuthorizerFunctionArn') as authorizer_function_arn, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'AuthorizerName') as authorizer_name, + json_extract_path_text(Properties, 'SigningDisabled') as signing_disabled, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'TokenKeyName') as token_key_name, + json_extract_path_text(Properties, 'TokenSigningPublicKeys') as token_signing_public_keys, + json_extract_path_text(Properties, 'EnableCachingForHttp') as enable_caching_for_http, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::Authorizer' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AuthorizerName') as authorizer_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::Authorizer' + AND region = 'us-east-1' billing_groups: name: billing_groups id: aws.iot.billing_groups @@ -5162,7 +5138,7 @@ components: x-cfn-type-name: AWS::IoT::BillingGroup x-identifiers: - BillingGroupName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -5179,9 +5155,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -5191,41 +5167,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/billing_groups/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/billing_groups/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.BillingGroupName') as billing_group_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::BillingGroup' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'BillingGroupName') as billing_group_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::BillingGroup' - AND region = 'us-east-1' - billing_group: - name: billing_group - id: aws.iot.billing_group - x-cfn-schema-name: BillingGroup - x-cfn-type-name: AWS::IoT::BillingGroup - x-identifiers: - - BillingGroupName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -5236,12 +5180,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/billing_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/billing_groups/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/billing_group/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/billing_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -5255,19 +5203,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'BillingGroupName') as billing_group_name, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'BillingGroupProperties') as billing_group_properties - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::BillingGroup' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.BillingGroupName') as billing_group_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::BillingGroup' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'BillingGroupName') as billing_group_name, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'BillingGroupProperties') as billing_group_properties + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::BillingGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'BillingGroupName') as billing_group_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::BillingGroup' + AND region = 'us-east-1' ca_certificates: name: ca_certificates id: aws.iot.ca_certificates @@ -5275,7 +5239,7 @@ components: x-cfn-type-name: AWS::IoT::CACertificate x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -5292,9 +5256,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -5304,41 +5268,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/ca_certificates/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/ca_certificates/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::CACertificate' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::CACertificate' - AND region = 'us-east-1' - ca_certificate: - name: ca_certificate - id: aws.iot.ca_certificate - x-cfn-schema-name: CACertificate - x-cfn-type-name: AWS::IoT::CACertificate - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -5349,12 +5281,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/ca_certificates/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/ca_certificates/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/ca_certificate/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/ca_certificates/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -5373,24 +5309,40 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'CACertificatePem') as ca_certificate_pem, - json_extract_path_text(Properties, 'VerificationCertificatePem') as verification_certificate_pem, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'CertificateMode') as certificate_mode, - json_extract_path_text(Properties, 'AutoRegistrationStatus') as auto_registration_status, - json_extract_path_text(Properties, 'RemoveAutoRegistration') as remove_auto_registration, - json_extract_path_text(Properties, 'RegistrationConfig') as registration_config, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::CACertificate' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::CACertificate' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'CACertificatePem') as ca_certificate_pem, + json_extract_path_text(Properties, 'VerificationCertificatePem') as verification_certificate_pem, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'CertificateMode') as certificate_mode, + json_extract_path_text(Properties, 'AutoRegistrationStatus') as auto_registration_status, + json_extract_path_text(Properties, 'RemoveAutoRegistration') as remove_auto_registration, + json_extract_path_text(Properties, 'RegistrationConfig') as registration_config, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::CACertificate' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::CACertificate' + AND region = 'us-east-1' certificates: name: certificates id: aws.iot.certificates @@ -5398,7 +5350,7 @@ components: x-cfn-type-name: AWS::IoT::Certificate x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -5415,9 +5367,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -5427,41 +5379,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/certificates/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/certificates/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::Certificate' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::Certificate' - AND region = 'us-east-1' - certificate: - name: certificate - id: aws.iot.certificate - x-cfn-schema-name: Certificate - x-cfn-type-name: AWS::IoT::Certificate - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -5472,12 +5392,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/certificates/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/certificates/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/certificate/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/certificates/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -5493,21 +5417,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'CACertificatePem') as ca_certificate_pem, - json_extract_path_text(Properties, 'CertificatePem') as certificate_pem, - json_extract_path_text(Properties, 'CertificateSigningRequest') as certificate_signing_request, - json_extract_path_text(Properties, 'CertificateMode') as certificate_mode, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::Certificate' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::Certificate' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'CACertificatePem') as ca_certificate_pem, + json_extract_path_text(Properties, 'CertificatePem') as certificate_pem, + json_extract_path_text(Properties, 'CertificateSigningRequest') as certificate_signing_request, + json_extract_path_text(Properties, 'CertificateMode') as certificate_mode, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::Certificate' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::Certificate' + AND region = 'us-east-1' certificate_providers: name: certificate_providers id: aws.iot.certificate_providers @@ -5515,7 +5455,7 @@ components: x-cfn-type-name: AWS::IoT::CertificateProvider x-identifiers: - CertificateProviderName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -5532,9 +5472,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -5544,41 +5484,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/certificate_providers/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/certificate_providers/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.CertificateProviderName') as certificate_provider_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::CertificateProvider' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'CertificateProviderName') as certificate_provider_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::CertificateProvider' - AND region = 'us-east-1' - certificate_provider: - name: certificate_provider - id: aws.iot.certificate_provider - x-cfn-schema-name: CertificateProvider - x-cfn-type-name: AWS::IoT::CertificateProvider - x-identifiers: - - CertificateProviderName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -5589,12 +5497,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/certificate_providers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/certificate_providers/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/certificate_provider/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/certificate_providers/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -5608,19 +5520,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'CertificateProviderName') as certificate_provider_name, - json_extract_path_text(Properties, 'LambdaFunctionArn') as lambda_function_arn, - json_extract_path_text(Properties, 'AccountDefaultForOperations') as account_default_for_operations, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::CertificateProvider' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.CertificateProviderName') as certificate_provider_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::CertificateProvider' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'CertificateProviderName') as certificate_provider_name, + json_extract_path_text(Properties, 'LambdaFunctionArn') as lambda_function_arn, + json_extract_path_text(Properties, 'AccountDefaultForOperations') as account_default_for_operations, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::CertificateProvider' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'CertificateProviderName') as certificate_provider_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::CertificateProvider' + AND region = 'us-east-1' custom_metrics: name: custom_metrics id: aws.iot.custom_metrics @@ -5628,7 +5556,7 @@ components: x-cfn-type-name: AWS::IoT::CustomMetric x-identifiers: - MetricName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -5645,9 +5573,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -5657,41 +5585,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/custom_metrics/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/custom_metrics/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.MetricName') as metric_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::CustomMetric' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'MetricName') as metric_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::CustomMetric' - AND region = 'us-east-1' - custom_metric: - name: custom_metric - id: aws.iot.custom_metric - x-cfn-schema-name: CustomMetric - x-cfn-type-name: AWS::IoT::CustomMetric - x-identifiers: - - MetricName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -5702,12 +5598,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/custom_metrics/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/custom_metrics/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/custom_metric/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/custom_metrics/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -5721,19 +5621,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'MetricName') as metric_name, - json_extract_path_text(Properties, 'DisplayName') as display_name, - json_extract_path_text(Properties, 'MetricType') as metric_type, - json_extract_path_text(Properties, 'MetricArn') as metric_arn, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::CustomMetric' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.MetricName') as metric_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::CustomMetric' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'MetricName') as metric_name, + json_extract_path_text(Properties, 'DisplayName') as display_name, + json_extract_path_text(Properties, 'MetricType') as metric_type, + json_extract_path_text(Properties, 'MetricArn') as metric_arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::CustomMetric' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'MetricName') as metric_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::CustomMetric' + AND region = 'us-east-1' dimensions: name: dimensions id: aws.iot.dimensions @@ -5741,7 +5657,7 @@ components: x-cfn-type-name: AWS::IoT::Dimension x-identifiers: - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -5758,9 +5674,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -5770,41 +5686,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/dimensions/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/dimensions/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::Dimension' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::Dimension' - AND region = 'us-east-1' - dimension: - name: dimension - id: aws.iot.dimension - x-cfn-schema-name: Dimension - x-cfn-type-name: AWS::IoT::Dimension - x-identifiers: - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -5815,12 +5699,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/dimensions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/dimensions/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/dimension/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/dimensions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -5834,19 +5722,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Type') as type, - json_extract_path_text(Properties, 'StringValues') as string_values, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::Dimension' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::Dimension' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'StringValues') as string_values, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::Dimension' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::Dimension' + AND region = 'us-east-1' domain_configurations: name: domain_configurations id: aws.iot.domain_configurations @@ -5854,7 +5758,7 @@ components: x-cfn-type-name: AWS::IoT::DomainConfiguration x-identifiers: - DomainConfigurationName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -5871,9 +5775,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -5883,41 +5787,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/domain_configurations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/domain_configurations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.DomainConfigurationName') as domain_configuration_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::DomainConfiguration' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'DomainConfigurationName') as domain_configuration_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::DomainConfiguration' - AND region = 'us-east-1' - domain_configuration: - name: domain_configuration - id: aws.iot.domain_configuration - x-cfn-schema-name: DomainConfiguration - x-cfn-type-name: AWS::IoT::DomainConfiguration - x-identifiers: - - DomainConfigurationName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -5928,12 +5800,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/domain_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/domain_configurations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/domain_configuration/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/domain_configurations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -5955,27 +5831,43 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'DomainConfigurationName') as domain_configuration_name, - json_extract_path_text(Properties, 'AuthorizerConfig') as authorizer_config, - json_extract_path_text(Properties, 'DomainName') as domain_name, - json_extract_path_text(Properties, 'ServerCertificateArns') as server_certificate_arns, - json_extract_path_text(Properties, 'ServiceType') as service_type, - json_extract_path_text(Properties, 'ValidationCertificateArn') as validation_certificate_arn, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'DomainConfigurationStatus') as domain_configuration_status, - json_extract_path_text(Properties, 'DomainType') as domain_type, - json_extract_path_text(Properties, 'ServerCertificateConfig') as server_certificate_config, - json_extract_path_text(Properties, 'ServerCertificates') as server_certificates, - json_extract_path_text(Properties, 'TlsConfig') as tls_config, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::DomainConfiguration' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.DomainConfigurationName') as domain_configuration_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::DomainConfiguration' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DomainConfigurationName') as domain_configuration_name, + json_extract_path_text(Properties, 'AuthorizerConfig') as authorizer_config, + json_extract_path_text(Properties, 'DomainName') as domain_name, + json_extract_path_text(Properties, 'ServerCertificateArns') as server_certificate_arns, + json_extract_path_text(Properties, 'ServiceType') as service_type, + json_extract_path_text(Properties, 'ValidationCertificateArn') as validation_certificate_arn, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'DomainConfigurationStatus') as domain_configuration_status, + json_extract_path_text(Properties, 'DomainType') as domain_type, + json_extract_path_text(Properties, 'ServerCertificateConfig') as server_certificate_config, + json_extract_path_text(Properties, 'ServerCertificates') as server_certificates, + json_extract_path_text(Properties, 'TlsConfig') as tls_config, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::DomainConfiguration' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DomainConfigurationName') as domain_configuration_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::DomainConfiguration' + AND region = 'us-east-1' fleet_metrics: name: fleet_metrics id: aws.iot.fleet_metrics @@ -5983,7 +5875,7 @@ components: x-cfn-type-name: AWS::IoT::FleetMetric x-identifiers: - MetricName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -6000,9 +5892,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -6012,41 +5904,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/fleet_metrics/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/fleet_metrics/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.MetricName') as metric_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::FleetMetric' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'MetricName') as metric_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::FleetMetric' - AND region = 'us-east-1' - fleet_metric: - name: fleet_metric - id: aws.iot.fleet_metric - x-cfn-schema-name: FleetMetric - x-cfn-type-name: AWS::IoT::FleetMetric - x-identifiers: - - MetricName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -6057,12 +5917,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/fleet_metrics/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/fleet_metrics/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/fleet_metric/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/fleet_metrics/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -6085,28 +5949,44 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'MetricName') as metric_name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'QueryString') as query_string, - json_extract_path_text(Properties, 'Period') as period, - json_extract_path_text(Properties, 'AggregationField') as aggregation_field, - json_extract_path_text(Properties, 'QueryVersion') as query_version, - json_extract_path_text(Properties, 'IndexName') as index_name, - json_extract_path_text(Properties, 'Unit') as unit, - json_extract_path_text(Properties, 'AggregationType') as aggregation_type, - json_extract_path_text(Properties, 'MetricArn') as metric_arn, - json_extract_path_text(Properties, 'CreationDate') as creation_date, - json_extract_path_text(Properties, 'LastModifiedDate') as last_modified_date, - json_extract_path_text(Properties, 'Version') as version, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::FleetMetric' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.MetricName') as metric_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::FleetMetric' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'MetricName') as metric_name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'QueryString') as query_string, + json_extract_path_text(Properties, 'Period') as period, + json_extract_path_text(Properties, 'AggregationField') as aggregation_field, + json_extract_path_text(Properties, 'QueryVersion') as query_version, + json_extract_path_text(Properties, 'IndexName') as index_name, + json_extract_path_text(Properties, 'Unit') as unit, + json_extract_path_text(Properties, 'AggregationType') as aggregation_type, + json_extract_path_text(Properties, 'MetricArn') as metric_arn, + json_extract_path_text(Properties, 'CreationDate') as creation_date, + json_extract_path_text(Properties, 'LastModifiedDate') as last_modified_date, + json_extract_path_text(Properties, 'Version') as version, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::FleetMetric' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'MetricName') as metric_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::FleetMetric' + AND region = 'us-east-1' job_templates: name: job_templates id: aws.iot.job_templates @@ -6114,7 +5994,7 @@ components: x-cfn-type-name: AWS::IoT::JobTemplate x-identifiers: - JobTemplateId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -6148,39 +6028,11 @@ components: - $ref: '#/components/x-stackQL-resources/job_templates/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/job_templates/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.JobTemplateId') as job_template_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::JobTemplate' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'JobTemplateId') as job_template_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::JobTemplate' - AND region = 'us-east-1' - job_template: - name: job_template - id: aws.iot.job_template - x-cfn-schema-name: JobTemplate - x-cfn-type-name: AWS::IoT::JobTemplate - x-identifiers: - - JobTemplateId - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -6203,28 +6055,44 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'JobArn') as job_arn, - json_extract_path_text(Properties, 'JobTemplateId') as job_template_id, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Document') as document, - json_extract_path_text(Properties, 'DocumentSource') as document_source, - json_extract_path_text(Properties, 'TimeoutConfig') as timeout_config, - json_extract_path_text(Properties, 'JobExecutionsRolloutConfig') as job_executions_rollout_config, - json_extract_path_text(Properties, 'AbortConfig') as abort_config, - json_extract_path_text(Properties, 'PresignedUrlConfig') as presigned_url_config, - json_extract_path_text(Properties, 'JobExecutionsRetryConfig') as job_executions_retry_config, - json_extract_path_text(Properties, 'MaintenanceWindows') as maintenance_windows, - json_extract_path_text(Properties, 'DestinationPackageVersions') as destination_package_versions, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::JobTemplate' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.JobTemplateId') as job_template_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::JobTemplate' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'JobArn') as job_arn, + json_extract_path_text(Properties, 'JobTemplateId') as job_template_id, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Document') as document, + json_extract_path_text(Properties, 'DocumentSource') as document_source, + json_extract_path_text(Properties, 'TimeoutConfig') as timeout_config, + json_extract_path_text(Properties, 'JobExecutionsRolloutConfig') as job_executions_rollout_config, + json_extract_path_text(Properties, 'AbortConfig') as abort_config, + json_extract_path_text(Properties, 'PresignedUrlConfig') as presigned_url_config, + json_extract_path_text(Properties, 'JobExecutionsRetryConfig') as job_executions_retry_config, + json_extract_path_text(Properties, 'MaintenanceWindows') as maintenance_windows, + json_extract_path_text(Properties, 'DestinationPackageVersions') as destination_package_versions, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::JobTemplate' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'JobTemplateId') as job_template_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::JobTemplate' + AND region = 'us-east-1' loggings: name: loggings id: aws.iot.loggings @@ -6232,7 +6100,7 @@ components: x-cfn-type-name: AWS::IoT::Logging x-identifiers: - AccountId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -6249,9 +6117,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -6261,41 +6129,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/loggings/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/loggings/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AccountId') as account_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::Logging' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AccountId') as account_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::Logging' - AND region = 'us-east-1' - logging: - name: logging - id: aws.iot.logging - x-cfn-schema-name: Logging - x-cfn-type-name: AWS::IoT::Logging - x-identifiers: - - AccountId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -6306,12 +6142,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/loggings/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/loggings/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/logging/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/loggings/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -6323,17 +6163,33 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AccountId') as account_id, - json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'DefaultLogLevel') as default_log_level - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::Logging' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.AccountId') as account_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::Logging' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AccountId') as account_id, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'DefaultLogLevel') as default_log_level + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::Logging' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AccountId') as account_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::Logging' + AND region = 'us-east-1' mitigation_actions: name: mitigation_actions id: aws.iot.mitigation_actions @@ -6341,7 +6197,7 @@ components: x-cfn-type-name: AWS::IoT::MitigationAction x-identifiers: - ActionName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -6358,9 +6214,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -6370,41 +6226,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/mitigation_actions/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/mitigation_actions/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ActionName') as action_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::MitigationAction' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ActionName') as action_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::MitigationAction' - AND region = 'us-east-1' - mitigation_action: - name: mitigation_action - id: aws.iot.mitigation_action - x-cfn-schema-name: MitigationAction - x-cfn-type-name: AWS::IoT::MitigationAction - x-identifiers: - - ActionName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -6415,12 +6239,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/mitigation_actions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/mitigation_actions/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/mitigation_action/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/mitigation_actions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -6435,20 +6263,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ActionName') as action_name, - json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'ActionParams') as action_params, - json_extract_path_text(Properties, 'MitigationActionArn') as mitigation_action_arn, - json_extract_path_text(Properties, 'MitigationActionId') as mitigation_action_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::MitigationAction' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ActionName') as action_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::MitigationAction' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ActionName') as action_name, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'ActionParams') as action_params, + json_extract_path_text(Properties, 'MitigationActionArn') as mitigation_action_arn, + json_extract_path_text(Properties, 'MitigationActionId') as mitigation_action_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::MitigationAction' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ActionName') as action_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::MitigationAction' + AND region = 'us-east-1' policies: name: policies id: aws.iot.policies @@ -6456,7 +6300,7 @@ components: x-cfn-type-name: AWS::IoT::Policy x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -6473,9 +6317,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -6485,41 +6329,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/policies/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/policies/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::Policy' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::Policy' - AND region = 'us-east-1' - policy: - name: policy - id: aws.iot.policy - x-cfn-schema-name: Policy - x-cfn-type-name: AWS::IoT::Policy - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -6530,12 +6342,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/policies/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/policy/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -6549,19 +6365,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'PolicyDocument') as policy_document, - json_extract_path_text(Properties, 'PolicyName') as policy_name, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::Policy' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::Policy' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'PolicyDocument') as policy_document, + json_extract_path_text(Properties, 'PolicyName') as policy_name, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::Policy' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::Policy' + AND region = 'us-east-1' provisioning_templates: name: provisioning_templates id: aws.iot.provisioning_templates @@ -6569,7 +6401,7 @@ components: x-cfn-type-name: AWS::IoT::ProvisioningTemplate x-identifiers: - TemplateName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -6586,6 +6418,18 @@ components: response: mediaType: application/json openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IoT::ProvisioningTemplate" + } + response: + mediaType: application/json + openAPIDocKey: '200' delete_resource: operation: $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' @@ -6603,86 +6447,62 @@ components: - $ref: '#/components/x-stackQL-resources/provisioning_templates/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/provisioning_templates/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/provisioning_templates/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.TemplateName') as template_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::ProvisioningTemplate' + data__Identifier, + JSON_EXTRACT(Properties, '$.TemplateArn') as template_arn, + JSON_EXTRACT(Properties, '$.TemplateName') as template_name, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.Enabled') as enabled, + JSON_EXTRACT(Properties, '$.ProvisioningRoleArn') as provisioning_role_arn, + JSON_EXTRACT(Properties, '$.TemplateBody') as template_body, + JSON_EXTRACT(Properties, '$.TemplateType') as template_type, + JSON_EXTRACT(Properties, '$.PreProvisioningHook') as pre_provisioning_hook, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::ProvisioningTemplate' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - json_extract_path_text(Properties, 'TemplateName') as template_name + JSON_EXTRACT(Properties, '$.TemplateName') as template_name FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::ProvisioningTemplate' AND region = 'us-east-1' - provisioning_template: - name: provisioning_template - id: aws.iot.provisioning_template - x-cfn-schema-name: ProvisioningTemplate - x-cfn-type-name: AWS::IoT::ProvisioningTemplate - x-identifiers: - - TemplateName - x-type: get - methods: - update_resource: - operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' - request: - mediaType: application/x-amz-json-1.0 - base: |- - { - "TypeName": "AWS::IoT::ProvisioningTemplate" - } - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - update: - - $ref: '#/components/x-stackQL-resources/provisioning_template/methods/update_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - data__Identifier, - JSON_EXTRACT(Properties, '$.TemplateArn') as template_arn, - JSON_EXTRACT(Properties, '$.TemplateName') as template_name, - JSON_EXTRACT(Properties, '$.Description') as description, - JSON_EXTRACT(Properties, '$.Enabled') as enabled, - JSON_EXTRACT(Properties, '$.ProvisioningRoleArn') as provisioning_role_arn, - JSON_EXTRACT(Properties, '$.TemplateBody') as template_body, - JSON_EXTRACT(Properties, '$.TemplateType') as template_type, - JSON_EXTRACT(Properties, '$.PreProvisioningHook') as pre_provisioning_hook, - JSON_EXTRACT(Properties, '$.Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::ProvisioningTemplate' - AND data__Identifier = '' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - data__Identifier, - json_extract_path_text(Properties, 'TemplateArn') as template_arn, - json_extract_path_text(Properties, 'TemplateName') as template_name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Enabled') as enabled, - json_extract_path_text(Properties, 'ProvisioningRoleArn') as provisioning_role_arn, - json_extract_path_text(Properties, 'TemplateBody') as template_body, - json_extract_path_text(Properties, 'TemplateType') as template_type, - json_extract_path_text(Properties, 'PreProvisioningHook') as pre_provisioning_hook, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::ProvisioningTemplate' - AND data__Identifier = '' - AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'TemplateArn') as template_arn, + json_extract_path_text(Properties, 'TemplateName') as template_name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Enabled') as enabled, + json_extract_path_text(Properties, 'ProvisioningRoleArn') as provisioning_role_arn, + json_extract_path_text(Properties, 'TemplateBody') as template_body, + json_extract_path_text(Properties, 'TemplateType') as template_type, + json_extract_path_text(Properties, 'PreProvisioningHook') as pre_provisioning_hook, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::ProvisioningTemplate' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'TemplateName') as template_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::ProvisioningTemplate' + AND region = 'us-east-1' resource_specific_loggings: name: resource_specific_loggings id: aws.iot.resource_specific_loggings @@ -6690,7 +6510,7 @@ components: x-cfn-type-name: AWS::IoT::ResourceSpecificLogging x-identifiers: - TargetId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -6707,9 +6527,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -6719,41 +6539,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/resource_specific_loggings/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/resource_specific_loggings/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.TargetId') as target_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::ResourceSpecificLogging' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'TargetId') as target_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::ResourceSpecificLogging' - AND region = 'us-east-1' - resource_specific_logging: - name: resource_specific_logging - id: aws.iot.resource_specific_logging - x-cfn-schema-name: ResourceSpecificLogging - x-cfn-type-name: AWS::IoT::ResourceSpecificLogging - x-identifiers: - - TargetId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -6764,12 +6552,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/resource_specific_loggings/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/resource_specific_loggings/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/resource_specific_logging/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/resource_specific_loggings/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -6782,18 +6574,34 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'TargetType') as target_type, - json_extract_path_text(Properties, 'TargetName') as target_name, - json_extract_path_text(Properties, 'LogLevel') as log_level, - json_extract_path_text(Properties, 'TargetId') as target_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::ResourceSpecificLogging' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.TargetId') as target_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::ResourceSpecificLogging' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'TargetType') as target_type, + json_extract_path_text(Properties, 'TargetName') as target_name, + json_extract_path_text(Properties, 'LogLevel') as log_level, + json_extract_path_text(Properties, 'TargetId') as target_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::ResourceSpecificLogging' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'TargetId') as target_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::ResourceSpecificLogging' + AND region = 'us-east-1' role_aliases: name: role_aliases id: aws.iot.role_aliases @@ -6801,7 +6609,7 @@ components: x-cfn-type-name: AWS::IoT::RoleAlias x-identifiers: - RoleAlias - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -6818,9 +6626,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -6830,41 +6638,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/role_aliases/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/role_aliases/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.RoleAlias') as role_alias - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::RoleAlias' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'RoleAlias') as role_alias - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::RoleAlias' - AND region = 'us-east-1' - role_alias: - name: role_alias - id: aws.iot.role_alias - x-cfn-schema-name: RoleAlias - x-cfn-type-name: AWS::IoT::RoleAlias - x-identifiers: - - RoleAlias - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -6875,12 +6651,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/role_aliases/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/role_aliases/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/role_alias/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/role_aliases/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -6894,19 +6674,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'RoleAlias') as role_alias, - json_extract_path_text(Properties, 'RoleAliasArn') as role_alias_arn, - json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'CredentialDurationSeconds') as credential_duration_seconds, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::RoleAlias' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.RoleAlias') as role_alias + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::RoleAlias' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'RoleAlias') as role_alias, + json_extract_path_text(Properties, 'RoleAliasArn') as role_alias_arn, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'CredentialDurationSeconds') as credential_duration_seconds, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::RoleAlias' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'RoleAlias') as role_alias + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::RoleAlias' + AND region = 'us-east-1' scheduled_audits: name: scheduled_audits id: aws.iot.scheduled_audits @@ -6914,7 +6710,7 @@ components: x-cfn-type-name: AWS::IoT::ScheduledAudit x-identifiers: - ScheduledAuditName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -6931,9 +6727,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -6943,41 +6739,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/scheduled_audits/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/scheduled_audits/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ScheduledAuditName') as scheduled_audit_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::ScheduledAudit' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ScheduledAuditName') as scheduled_audit_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::ScheduledAudit' - AND region = 'us-east-1' - scheduled_audit: - name: scheduled_audit - id: aws.iot.scheduled_audit - x-cfn-schema-name: ScheduledAudit - x-cfn-type-name: AWS::IoT::ScheduledAudit - x-identifiers: - - ScheduledAuditName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -6988,12 +6752,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/scheduled_audits/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/scheduled_audits/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/scheduled_audit/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/scheduled_audits/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -7009,21 +6777,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ScheduledAuditName') as scheduled_audit_name, - json_extract_path_text(Properties, 'Frequency') as frequency, - json_extract_path_text(Properties, 'DayOfMonth') as day_of_month, - json_extract_path_text(Properties, 'DayOfWeek') as day_of_week, - json_extract_path_text(Properties, 'TargetCheckNames') as target_check_names, - json_extract_path_text(Properties, 'ScheduledAuditArn') as scheduled_audit_arn, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::ScheduledAudit' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ScheduledAuditName') as scheduled_audit_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::ScheduledAudit' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ScheduledAuditName') as scheduled_audit_name, + json_extract_path_text(Properties, 'Frequency') as frequency, + json_extract_path_text(Properties, 'DayOfMonth') as day_of_month, + json_extract_path_text(Properties, 'DayOfWeek') as day_of_week, + json_extract_path_text(Properties, 'TargetCheckNames') as target_check_names, + json_extract_path_text(Properties, 'ScheduledAuditArn') as scheduled_audit_arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::ScheduledAudit' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ScheduledAuditName') as scheduled_audit_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::ScheduledAudit' + AND region = 'us-east-1' security_profiles: name: security_profiles id: aws.iot.security_profiles @@ -7031,7 +6815,7 @@ components: x-cfn-type-name: AWS::IoT::SecurityProfile x-identifiers: - SecurityProfileName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -7048,9 +6832,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -7060,41 +6844,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/security_profiles/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/security_profiles/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.SecurityProfileName') as security_profile_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::SecurityProfile' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'SecurityProfileName') as security_profile_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::SecurityProfile' - AND region = 'us-east-1' - security_profile: - name: security_profile - id: aws.iot.security_profile - x-cfn-schema-name: SecurityProfile - x-cfn-type-name: AWS::IoT::SecurityProfile - x-identifiers: - - SecurityProfileName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -7105,12 +6857,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/security_profiles/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/security_profiles/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/security_profile/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/security_profiles/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -7128,23 +6884,39 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'SecurityProfileName') as security_profile_name, - json_extract_path_text(Properties, 'SecurityProfileDescription') as security_profile_description, - json_extract_path_text(Properties, 'Behaviors') as behaviors, - json_extract_path_text(Properties, 'AlertTargets') as alert_targets, - json_extract_path_text(Properties, 'AdditionalMetricsToRetainV2') as additional_metrics_to_retain_v2, - json_extract_path_text(Properties, 'MetricsExportConfig') as metrics_export_config, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'TargetArns') as target_arns, - json_extract_path_text(Properties, 'SecurityProfileArn') as security_profile_arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::SecurityProfile' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.SecurityProfileName') as security_profile_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::SecurityProfile' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'SecurityProfileName') as security_profile_name, + json_extract_path_text(Properties, 'SecurityProfileDescription') as security_profile_description, + json_extract_path_text(Properties, 'Behaviors') as behaviors, + json_extract_path_text(Properties, 'AlertTargets') as alert_targets, + json_extract_path_text(Properties, 'AdditionalMetricsToRetainV2') as additional_metrics_to_retain_v2, + json_extract_path_text(Properties, 'MetricsExportConfig') as metrics_export_config, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'TargetArns') as target_arns, + json_extract_path_text(Properties, 'SecurityProfileArn') as security_profile_arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::SecurityProfile' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'SecurityProfileName') as security_profile_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::SecurityProfile' + AND region = 'us-east-1' software_packages: name: software_packages id: aws.iot.software_packages @@ -7152,7 +6924,7 @@ components: x-cfn-type-name: AWS::IoT::SoftwarePackage x-identifiers: - PackageName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -7169,9 +6941,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -7181,41 +6953,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/software_packages/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/software_packages/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.PackageName') as package_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::SoftwarePackage' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'PackageName') as package_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::SoftwarePackage' - AND region = 'us-east-1' - software_package: - name: software_package - id: aws.iot.software_package - x-cfn-schema-name: SoftwarePackage - x-cfn-type-name: AWS::IoT::SoftwarePackage - x-identifiers: - - PackageName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -7226,12 +6966,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/software_packages/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/software_packages/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/software_package/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/software_packages/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -7244,18 +6988,34 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'PackageArn') as package_arn, - json_extract_path_text(Properties, 'PackageName') as package_name, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::SoftwarePackage' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.PackageName') as package_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::SoftwarePackage' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'PackageArn') as package_arn, + json_extract_path_text(Properties, 'PackageName') as package_name, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::SoftwarePackage' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'PackageName') as package_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::SoftwarePackage' + AND region = 'us-east-1' software_package_versions: name: software_package_versions id: aws.iot.software_package_versions @@ -7264,7 +7024,7 @@ components: x-identifiers: - PackageName - VersionName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -7281,9 +7041,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -7293,44 +7053,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/software_package_versions/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/software_package_versions/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.PackageName') as package_name, - JSON_EXTRACT(Properties, '$.VersionName') as version_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::SoftwarePackageVersion' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'PackageName') as package_name, - json_extract_path_text(Properties, 'VersionName') as version_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::SoftwarePackageVersion' - AND region = 'us-east-1' - software_package_version: - name: software_package_version - id: aws.iot.software_package_version - x-cfn-schema-name: SoftwarePackageVersion - x-cfn-type-name: AWS::IoT::SoftwarePackageVersion - x-identifiers: - - PackageName - - VersionName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -7341,12 +7066,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/software_package_versions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/software_package_versions/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/software_package_version/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/software_package_versions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -7363,22 +7092,40 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Attributes') as attributes, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'ErrorReason') as error_reason, - json_extract_path_text(Properties, 'PackageName') as package_name, - json_extract_path_text(Properties, 'PackageVersionArn') as package_version_arn, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'VersionName') as version_name - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::SoftwarePackageVersion' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.PackageName') as package_name, + JSON_EXTRACT(Properties, '$.VersionName') as version_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::SoftwarePackageVersion' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Attributes') as attributes, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'ErrorReason') as error_reason, + json_extract_path_text(Properties, 'PackageName') as package_name, + json_extract_path_text(Properties, 'PackageVersionArn') as package_version_arn, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'VersionName') as version_name + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::SoftwarePackageVersion' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'PackageName') as package_name, + json_extract_path_text(Properties, 'VersionName') as version_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::SoftwarePackageVersion' + AND region = 'us-east-1' things: name: things id: aws.iot.things @@ -7386,7 +7133,7 @@ components: x-cfn-type-name: AWS::IoT::Thing x-identifiers: - ThingName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -7403,9 +7150,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -7415,41 +7162,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/things/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/things/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ThingName') as thing_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::Thing' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ThingName') as thing_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::Thing' - AND region = 'us-east-1' - thing: - name: thing - id: aws.iot.thing - x-cfn-schema-name: Thing - x-cfn-type-name: AWS::IoT::Thing - x-identifiers: - - ThingName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -7460,12 +7175,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/things/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/things/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/thing/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/things/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -7478,18 +7197,34 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'AttributePayload') as attribute_payload, - json_extract_path_text(Properties, 'ThingName') as thing_name - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::Thing' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ThingName') as thing_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::Thing' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'AttributePayload') as attribute_payload, + json_extract_path_text(Properties, 'ThingName') as thing_name + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::Thing' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ThingName') as thing_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::Thing' + AND region = 'us-east-1' thing_groups: name: thing_groups id: aws.iot.thing_groups @@ -7497,7 +7232,7 @@ components: x-cfn-type-name: AWS::IoT::ThingGroup x-identifiers: - ThingGroupName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -7514,9 +7249,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -7526,41 +7261,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/thing_groups/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/thing_groups/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ThingGroupName') as thing_group_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::ThingGroup' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ThingGroupName') as thing_group_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::ThingGroup' - AND region = 'us-east-1' - thing_group: - name: thing_group - id: aws.iot.thing_group - x-cfn-schema-name: ThingGroup - x-cfn-type-name: AWS::IoT::ThingGroup - x-identifiers: - - ThingGroupName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -7571,12 +7274,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/thing_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/thing_groups/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/thing_group/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/thing_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -7592,21 +7299,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'ThingGroupName') as thing_group_name, - json_extract_path_text(Properties, 'ParentGroupName') as parent_group_name, - json_extract_path_text(Properties, 'QueryString') as query_string, - json_extract_path_text(Properties, 'ThingGroupProperties') as thing_group_properties, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::ThingGroup' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ThingGroupName') as thing_group_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::ThingGroup' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'ThingGroupName') as thing_group_name, + json_extract_path_text(Properties, 'ParentGroupName') as parent_group_name, + json_extract_path_text(Properties, 'QueryString') as query_string, + json_extract_path_text(Properties, 'ThingGroupProperties') as thing_group_properties, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::ThingGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ThingGroupName') as thing_group_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::ThingGroup' + AND region = 'us-east-1' thing_types: name: thing_types id: aws.iot.thing_types @@ -7614,7 +7337,7 @@ components: x-cfn-type-name: AWS::IoT::ThingType x-identifiers: - ThingTypeName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -7631,9 +7354,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -7643,41 +7366,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/thing_types/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/thing_types/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ThingTypeName') as thing_type_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::ThingType' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ThingTypeName') as thing_type_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::ThingType' - AND region = 'us-east-1' - thing_type: - name: thing_type - id: aws.iot.thing_type - x-cfn-schema-name: ThingType - x-cfn-type-name: AWS::IoT::ThingType - x-identifiers: - - ThingTypeName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -7688,12 +7379,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/thing_types/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/thing_types/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/thing_type/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/thing_types/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -7708,20 +7403,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'ThingTypeName') as thing_type_name, - json_extract_path_text(Properties, 'DeprecateThingType') as deprecate_thing_type, - json_extract_path_text(Properties, 'ThingTypeProperties') as thing_type_properties, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::ThingType' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ThingTypeName') as thing_type_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::ThingType' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'ThingTypeName') as thing_type_name, + json_extract_path_text(Properties, 'DeprecateThingType') as deprecate_thing_type, + json_extract_path_text(Properties, 'ThingTypeProperties') as thing_type_properties, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::ThingType' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ThingTypeName') as thing_type_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::ThingType' + AND region = 'us-east-1' topic_rules: name: topic_rules id: aws.iot.topic_rules @@ -7729,7 +7440,7 @@ components: x-cfn-type-name: AWS::IoT::TopicRule x-identifiers: - RuleName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -7746,9 +7457,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -7758,41 +7469,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/topic_rules/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/topic_rules/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.RuleName') as rule_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::TopicRule' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'RuleName') as rule_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::TopicRule' - AND region = 'us-east-1' - topic_rule: - name: topic_rule - id: aws.iot.topic_rule - x-cfn-schema-name: TopicRule - x-cfn-type-name: AWS::IoT::TopicRule - x-identifiers: - - RuleName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -7803,12 +7482,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/topic_rules/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/topic_rules/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/topic_rule/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/topic_rules/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -7821,18 +7504,34 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'RuleName') as rule_name, - json_extract_path_text(Properties, 'TopicRulePayload') as topic_rule_payload, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::TopicRule' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.RuleName') as rule_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::TopicRule' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'RuleName') as rule_name, + json_extract_path_text(Properties, 'TopicRulePayload') as topic_rule_payload, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::TopicRule' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'RuleName') as rule_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::TopicRule' + AND region = 'us-east-1' topic_rule_destinations: name: topic_rule_destinations id: aws.iot.topic_rule_destinations @@ -7840,7 +7539,7 @@ components: x-cfn-type-name: AWS::IoT::TopicRuleDestination x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -7857,9 +7556,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -7869,41 +7568,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/topic_rule_destinations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/topic_rule_destinations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::TopicRuleDestination' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::TopicRuleDestination' - AND region = 'us-east-1' - topic_rule_destination: - name: topic_rule_destination - id: aws.iot.topic_rule_destination - x-cfn-schema-name: TopicRuleDestination - x-cfn-type-name: AWS::IoT::TopicRuleDestination - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -7914,12 +7581,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/topic_rule_destinations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/topic_rule_destinations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/topic_rule_destination/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/topic_rule_destinations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -7933,19 +7604,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'HttpUrlProperties') as http_url_properties, - json_extract_path_text(Properties, 'StatusReason') as status_reason, - json_extract_path_text(Properties, 'VpcProperties') as vpc_properties - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::TopicRuleDestination' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::TopicRuleDestination' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'HttpUrlProperties') as http_url_properties, + json_extract_path_text(Properties, 'StatusReason') as status_reason, + json_extract_path_text(Properties, 'VpcProperties') as vpc_properties + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoT::TopicRuleDestination' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoT::TopicRuleDestination' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/iotanalytics.yaml b/providers/src/aws/v00.00.00000/services/iotanalytics.yaml index 3b66e515..1e6a09ba 100644 --- a/providers/src/aws/v00.00.00000/services/iotanalytics.yaml +++ b/providers/src/aws/v00.00.00000/services/iotanalytics.yaml @@ -1337,7 +1337,7 @@ components: x-cfn-type-name: AWS::IoTAnalytics::Dataset x-identifiers: - DatasetName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1354,9 +1354,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1366,41 +1366,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/datasets/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/datasets/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.DatasetName') as dataset_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTAnalytics::Dataset' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'DatasetName') as dataset_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTAnalytics::Dataset' - AND region = 'us-east-1' - dataset: - name: dataset - id: aws.iotanalytics.dataset - x-cfn-schema-name: Dataset - x-cfn-type-name: AWS::IoTAnalytics::Dataset - x-identifiers: - - DatasetName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1411,12 +1379,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/datasets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/datasets/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/dataset/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/datasets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1434,23 +1406,39 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Actions') as actions, - json_extract_path_text(Properties, 'LateDataRules') as late_data_rules, - json_extract_path_text(Properties, 'DatasetName') as dataset_name, - json_extract_path_text(Properties, 'ContentDeliveryRules') as content_delivery_rules, - json_extract_path_text(Properties, 'Triggers') as triggers, - json_extract_path_text(Properties, 'VersioningConfiguration') as versioning_configuration, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'RetentionPeriod') as retention_period, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTAnalytics::Dataset' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.DatasetName') as dataset_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTAnalytics::Dataset' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Actions') as actions, + json_extract_path_text(Properties, 'LateDataRules') as late_data_rules, + json_extract_path_text(Properties, 'DatasetName') as dataset_name, + json_extract_path_text(Properties, 'ContentDeliveryRules') as content_delivery_rules, + json_extract_path_text(Properties, 'Triggers') as triggers, + json_extract_path_text(Properties, 'VersioningConfiguration') as versioning_configuration, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'RetentionPeriod') as retention_period, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTAnalytics::Dataset' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DatasetName') as dataset_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTAnalytics::Dataset' + AND region = 'us-east-1' pipelines: name: pipelines id: aws.iotanalytics.pipelines @@ -1458,7 +1446,7 @@ components: x-cfn-type-name: AWS::IoTAnalytics::Pipeline x-identifiers: - PipelineName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1475,9 +1463,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1487,41 +1475,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/pipelines/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/pipelines/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.PipelineName') as pipeline_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTAnalytics::Pipeline' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'PipelineName') as pipeline_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTAnalytics::Pipeline' - AND region = 'us-east-1' - pipeline: - name: pipeline - id: aws.iotanalytics.pipeline - x-cfn-schema-name: Pipeline - x-cfn-type-name: AWS::IoTAnalytics::Pipeline - x-identifiers: - - PipelineName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1532,12 +1488,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/pipelines/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/pipelines/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/pipeline/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/pipelines/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1550,18 +1510,34 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'PipelineName') as pipeline_name, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'PipelineActivities') as pipeline_activities - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTAnalytics::Pipeline' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.PipelineName') as pipeline_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTAnalytics::Pipeline' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'PipelineName') as pipeline_name, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'PipelineActivities') as pipeline_activities + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTAnalytics::Pipeline' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'PipelineName') as pipeline_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTAnalytics::Pipeline' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/iotcoredeviceadvisor.yaml b/providers/src/aws/v00.00.00000/services/iotcoredeviceadvisor.yaml index 6d677eee..41ca315d 100644 --- a/providers/src/aws/v00.00.00000/services/iotcoredeviceadvisor.yaml +++ b/providers/src/aws/v00.00.00000/services/iotcoredeviceadvisor.yaml @@ -603,7 +603,7 @@ components: x-cfn-type-name: AWS::IoTCoreDeviceAdvisor::SuiteDefinition x-identifiers: - SuiteDefinitionId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -620,9 +620,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -632,41 +632,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/suite_definitions/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/suite_definitions/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.SuiteDefinitionId') as suite_definition_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTCoreDeviceAdvisor::SuiteDefinition' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'SuiteDefinitionId') as suite_definition_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTCoreDeviceAdvisor::SuiteDefinition' - AND region = 'us-east-1' - suite_definition: - name: suite_definition - id: aws.iotcoredeviceadvisor.suite_definition - x-cfn-schema-name: SuiteDefinition - x-cfn-type-name: AWS::IoTCoreDeviceAdvisor::SuiteDefinition - x-identifiers: - - SuiteDefinitionId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -677,12 +645,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/suite_definitions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/suite_definitions/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/suite_definition/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/suite_definitions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -696,19 +668,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'SuiteDefinitionConfiguration') as suite_definition_configuration, - json_extract_path_text(Properties, 'SuiteDefinitionId') as suite_definition_id, - json_extract_path_text(Properties, 'SuiteDefinitionArn') as suite_definition_arn, - json_extract_path_text(Properties, 'SuiteDefinitionVersion') as suite_definition_version, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTCoreDeviceAdvisor::SuiteDefinition' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.SuiteDefinitionId') as suite_definition_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTCoreDeviceAdvisor::SuiteDefinition' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'SuiteDefinitionConfiguration') as suite_definition_configuration, + json_extract_path_text(Properties, 'SuiteDefinitionId') as suite_definition_id, + json_extract_path_text(Properties, 'SuiteDefinitionArn') as suite_definition_arn, + json_extract_path_text(Properties, 'SuiteDefinitionVersion') as suite_definition_version, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTCoreDeviceAdvisor::SuiteDefinition' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'SuiteDefinitionId') as suite_definition_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTCoreDeviceAdvisor::SuiteDefinition' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/iotevents.yaml b/providers/src/aws/v00.00.00000/services/iotevents.yaml index df97c6a1..022d37dd 100644 --- a/providers/src/aws/v00.00.00000/services/iotevents.yaml +++ b/providers/src/aws/v00.00.00000/services/iotevents.yaml @@ -1425,7 +1425,7 @@ components: x-cfn-type-name: AWS::IoTEvents::AlarmModel x-identifiers: - AlarmModelName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1442,9 +1442,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1454,41 +1454,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/alarm_models/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/alarm_models/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AlarmModelName') as alarm_model_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTEvents::AlarmModel' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AlarmModelName') as alarm_model_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTEvents::AlarmModel' - AND region = 'us-east-1' - alarm_model: - name: alarm_model - id: aws.iotevents.alarm_model - x-cfn-schema-name: AlarmModel - x-cfn-type-name: AWS::IoTEvents::AlarmModel - x-identifiers: - - AlarmModelName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1499,12 +1467,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/alarm_models/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/alarm_models/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/alarm_model/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/alarm_models/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1522,23 +1494,39 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AlarmModelName') as alarm_model_name, - json_extract_path_text(Properties, 'AlarmModelDescription') as alarm_model_description, - json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'Key') as key, - json_extract_path_text(Properties, 'Severity') as severity, - json_extract_path_text(Properties, 'AlarmRule') as alarm_rule, - json_extract_path_text(Properties, 'AlarmEventActions') as alarm_event_actions, - json_extract_path_text(Properties, 'AlarmCapabilities') as alarm_capabilities, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTEvents::AlarmModel' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.AlarmModelName') as alarm_model_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTEvents::AlarmModel' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AlarmModelName') as alarm_model_name, + json_extract_path_text(Properties, 'AlarmModelDescription') as alarm_model_description, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'Key') as key, + json_extract_path_text(Properties, 'Severity') as severity, + json_extract_path_text(Properties, 'AlarmRule') as alarm_rule, + json_extract_path_text(Properties, 'AlarmEventActions') as alarm_event_actions, + json_extract_path_text(Properties, 'AlarmCapabilities') as alarm_capabilities, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTEvents::AlarmModel' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AlarmModelName') as alarm_model_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTEvents::AlarmModel' + AND region = 'us-east-1' detector_models: name: detector_models id: aws.iotevents.detector_models @@ -1546,7 +1534,7 @@ components: x-cfn-type-name: AWS::IoTEvents::DetectorModel x-identifiers: - DetectorModelName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1563,9 +1551,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1575,41 +1563,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/detector_models/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/detector_models/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.DetectorModelName') as detector_model_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTEvents::DetectorModel' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'DetectorModelName') as detector_model_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTEvents::DetectorModel' - AND region = 'us-east-1' - detector_model: - name: detector_model - id: aws.iotevents.detector_model - x-cfn-schema-name: DetectorModel - x-cfn-type-name: AWS::IoTEvents::DetectorModel - x-identifiers: - - DetectorModelName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1620,12 +1576,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/detector_models/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/detector_models/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/detector_model/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/detector_models/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1641,21 +1601,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'DetectorModelDefinition') as detector_model_definition, - json_extract_path_text(Properties, 'DetectorModelDescription') as detector_model_description, - json_extract_path_text(Properties, 'DetectorModelName') as detector_model_name, - json_extract_path_text(Properties, 'EvaluationMethod') as evaluation_method, - json_extract_path_text(Properties, 'Key') as key, - json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTEvents::DetectorModel' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.DetectorModelName') as detector_model_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTEvents::DetectorModel' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DetectorModelDefinition') as detector_model_definition, + json_extract_path_text(Properties, 'DetectorModelDescription') as detector_model_description, + json_extract_path_text(Properties, 'DetectorModelName') as detector_model_name, + json_extract_path_text(Properties, 'EvaluationMethod') as evaluation_method, + json_extract_path_text(Properties, 'Key') as key, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTEvents::DetectorModel' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DetectorModelName') as detector_model_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTEvents::DetectorModel' + AND region = 'us-east-1' inputs: name: inputs id: aws.iotevents.inputs @@ -1663,7 +1639,7 @@ components: x-cfn-type-name: AWS::IoTEvents::Input x-identifiers: - InputName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1680,9 +1656,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1692,41 +1668,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/inputs/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/inputs/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.InputName') as input_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTEvents::Input' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'InputName') as input_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTEvents::Input' - AND region = 'us-east-1' - input: - name: input - id: aws.iotevents.input - x-cfn-schema-name: Input - x-cfn-type-name: AWS::IoTEvents::Input - x-identifiers: - - InputName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1737,12 +1681,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/inputs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/inputs/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/input/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/inputs/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1755,18 +1703,34 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'InputDefinition') as input_definition, - json_extract_path_text(Properties, 'InputDescription') as input_description, - json_extract_path_text(Properties, 'InputName') as input_name, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTEvents::Input' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.InputName') as input_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTEvents::Input' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'InputDefinition') as input_definition, + json_extract_path_text(Properties, 'InputDescription') as input_description, + json_extract_path_text(Properties, 'InputName') as input_name, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTEvents::Input' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'InputName') as input_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTEvents::Input' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/iotfleethub.yaml b/providers/src/aws/v00.00.00000/services/iotfleethub.yaml index 1b54c030..8c670d48 100644 --- a/providers/src/aws/v00.00.00000/services/iotfleethub.yaml +++ b/providers/src/aws/v00.00.00000/services/iotfleethub.yaml @@ -592,7 +592,7 @@ components: x-cfn-type-name: AWS::IoTFleetHub::Application x-identifiers: - ApplicationId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -609,9 +609,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -621,41 +621,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/applications/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/applications/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ApplicationId') as application_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTFleetHub::Application' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ApplicationId') as application_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTFleetHub::Application' - AND region = 'us-east-1' - application: - name: application - id: aws.iotfleethub.application - x-cfn-schema-name: Application - x-cfn-type-name: AWS::IoTFleetHub::Application - x-identifiers: - - ApplicationId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -666,12 +634,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/applications/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/applications/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/application/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/applications/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -692,26 +664,42 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ApplicationId') as application_id, - json_extract_path_text(Properties, 'ApplicationArn') as application_arn, - json_extract_path_text(Properties, 'ApplicationName') as application_name, - json_extract_path_text(Properties, 'ApplicationDescription') as application_description, - json_extract_path_text(Properties, 'ApplicationUrl') as application_url, - json_extract_path_text(Properties, 'ApplicationState') as application_state, - json_extract_path_text(Properties, 'ApplicationCreationDate') as application_creation_date, - json_extract_path_text(Properties, 'ApplicationLastUpdateDate') as application_last_update_date, - json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'SsoClientId') as sso_client_id, - json_extract_path_text(Properties, 'ErrorMessage') as error_message, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTFleetHub::Application' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ApplicationId') as application_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTFleetHub::Application' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ApplicationId') as application_id, + json_extract_path_text(Properties, 'ApplicationArn') as application_arn, + json_extract_path_text(Properties, 'ApplicationName') as application_name, + json_extract_path_text(Properties, 'ApplicationDescription') as application_description, + json_extract_path_text(Properties, 'ApplicationUrl') as application_url, + json_extract_path_text(Properties, 'ApplicationState') as application_state, + json_extract_path_text(Properties, 'ApplicationCreationDate') as application_creation_date, + json_extract_path_text(Properties, 'ApplicationLastUpdateDate') as application_last_update_date, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'SsoClientId') as sso_client_id, + json_extract_path_text(Properties, 'ErrorMessage') as error_message, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTFleetHub::Application' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ApplicationId') as application_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTFleetHub::Application' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/iotfleetwise.yaml b/providers/src/aws/v00.00.00000/services/iotfleetwise.yaml index bc45dc1a..99019fff 100644 --- a/providers/src/aws/v00.00.00000/services/iotfleetwise.yaml +++ b/providers/src/aws/v00.00.00000/services/iotfleetwise.yaml @@ -1899,7 +1899,7 @@ components: x-cfn-type-name: AWS::IoTFleetWise::Campaign x-identifiers: - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1916,9 +1916,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1928,41 +1928,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/campaigns/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/campaigns/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTFleetWise::Campaign' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTFleetWise::Campaign' - AND region = 'us-east-1' - campaign: - name: campaign - id: aws.iotfleetwise.campaign - x-cfn-schema-name: Campaign - x-cfn-type-name: AWS::IoTFleetWise::Campaign - x-identifiers: - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1973,12 +1941,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/campaigns/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/campaigns/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/campaign/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/campaigns/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2008,35 +1980,51 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'Action') as action, - json_extract_path_text(Properties, 'CreationTime') as creation_time, - json_extract_path_text(Properties, 'Compression') as compression, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Priority') as priority, - json_extract_path_text(Properties, 'SignalsToCollect') as signals_to_collect, - json_extract_path_text(Properties, 'DataDestinationConfigs') as data_destination_configs, - json_extract_path_text(Properties, 'StartTime') as start_time, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'ExpiryTime') as expiry_time, - json_extract_path_text(Properties, 'LastModificationTime') as last_modification_time, - json_extract_path_text(Properties, 'SpoolingMode') as spooling_mode, - json_extract_path_text(Properties, 'SignalCatalogArn') as signal_catalog_arn, - json_extract_path_text(Properties, 'PostTriggerCollectionDuration') as post_trigger_collection_duration, - json_extract_path_text(Properties, 'DataExtraDimensions') as data_extra_dimensions, - json_extract_path_text(Properties, 'DiagnosticsMode') as diagnostics_mode, - json_extract_path_text(Properties, 'TargetArn') as target_arn, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'CollectionScheme') as collection_scheme, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTFleetWise::Campaign' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTFleetWise::Campaign' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'Action') as action, + json_extract_path_text(Properties, 'CreationTime') as creation_time, + json_extract_path_text(Properties, 'Compression') as compression, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Priority') as priority, + json_extract_path_text(Properties, 'SignalsToCollect') as signals_to_collect, + json_extract_path_text(Properties, 'DataDestinationConfigs') as data_destination_configs, + json_extract_path_text(Properties, 'StartTime') as start_time, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'ExpiryTime') as expiry_time, + json_extract_path_text(Properties, 'LastModificationTime') as last_modification_time, + json_extract_path_text(Properties, 'SpoolingMode') as spooling_mode, + json_extract_path_text(Properties, 'SignalCatalogArn') as signal_catalog_arn, + json_extract_path_text(Properties, 'PostTriggerCollectionDuration') as post_trigger_collection_duration, + json_extract_path_text(Properties, 'DataExtraDimensions') as data_extra_dimensions, + json_extract_path_text(Properties, 'DiagnosticsMode') as diagnostics_mode, + json_extract_path_text(Properties, 'TargetArn') as target_arn, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'CollectionScheme') as collection_scheme, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTFleetWise::Campaign' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTFleetWise::Campaign' + AND region = 'us-east-1' decoder_manifests: name: decoder_manifests id: aws.iotfleetwise.decoder_manifests @@ -2044,7 +2032,7 @@ components: x-cfn-type-name: AWS::IoTFleetWise::DecoderManifest x-identifiers: - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2061,9 +2049,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2073,41 +2061,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/decoder_manifests/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/decoder_manifests/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTFleetWise::DecoderManifest' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTFleetWise::DecoderManifest' - AND region = 'us-east-1' - decoder_manifest: - name: decoder_manifest - id: aws.iotfleetwise.decoder_manifest - x-cfn-schema-name: DecoderManifest - x-cfn-type-name: AWS::IoTFleetWise::DecoderManifest - x-identifiers: - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2118,12 +2074,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/decoder_manifests/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/decoder_manifests/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/decoder_manifest/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/decoder_manifests/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2142,24 +2102,40 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'CreationTime') as creation_time, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'LastModificationTime') as last_modification_time, - json_extract_path_text(Properties, 'ModelManifestArn') as model_manifest_arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'NetworkInterfaces') as network_interfaces, - json_extract_path_text(Properties, 'SignalDecoders') as signal_decoders, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTFleetWise::DecoderManifest' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTFleetWise::DecoderManifest' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'CreationTime') as creation_time, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'LastModificationTime') as last_modification_time, + json_extract_path_text(Properties, 'ModelManifestArn') as model_manifest_arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'NetworkInterfaces') as network_interfaces, + json_extract_path_text(Properties, 'SignalDecoders') as signal_decoders, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTFleetWise::DecoderManifest' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTFleetWise::DecoderManifest' + AND region = 'us-east-1' fleets: name: fleets id: aws.iotfleetwise.fleets @@ -2167,7 +2143,7 @@ components: x-cfn-type-name: AWS::IoTFleetWise::Fleet x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2184,9 +2160,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2196,41 +2172,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/fleets/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/fleets/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTFleetWise::Fleet' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTFleetWise::Fleet' - AND region = 'us-east-1' - fleet: - name: fleet - id: aws.iotfleetwise.fleet - x-cfn-schema-name: Fleet - x-cfn-type-name: AWS::IoTFleetWise::Fleet - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2241,12 +2185,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/fleets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/fleets/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/fleet/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/fleets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2262,21 +2210,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'CreationTime') as creation_time, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'LastModificationTime') as last_modification_time, - json_extract_path_text(Properties, 'SignalCatalogArn') as signal_catalog_arn, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTFleetWise::Fleet' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTFleetWise::Fleet' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'CreationTime') as creation_time, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'LastModificationTime') as last_modification_time, + json_extract_path_text(Properties, 'SignalCatalogArn') as signal_catalog_arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTFleetWise::Fleet' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTFleetWise::Fleet' + AND region = 'us-east-1' model_manifests: name: model_manifests id: aws.iotfleetwise.model_manifests @@ -2284,7 +2248,7 @@ components: x-cfn-type-name: AWS::IoTFleetWise::ModelManifest x-identifiers: - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2301,9 +2265,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2313,41 +2277,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/model_manifests/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/model_manifests/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTFleetWise::ModelManifest' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTFleetWise::ModelManifest' - AND region = 'us-east-1' - model_manifest: - name: model_manifest - id: aws.iotfleetwise.model_manifest - x-cfn-schema-name: ModelManifest - x-cfn-type-name: AWS::IoTFleetWise::ModelManifest - x-identifiers: - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2358,12 +2290,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/model_manifests/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/model_manifests/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/model_manifest/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/model_manifests/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2381,23 +2317,39 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'CreationTime') as creation_time, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'LastModificationTime') as last_modification_time, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Nodes') as nodes, - json_extract_path_text(Properties, 'SignalCatalogArn') as signal_catalog_arn, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTFleetWise::ModelManifest' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTFleetWise::ModelManifest' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'CreationTime') as creation_time, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'LastModificationTime') as last_modification_time, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Nodes') as nodes, + json_extract_path_text(Properties, 'SignalCatalogArn') as signal_catalog_arn, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTFleetWise::ModelManifest' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTFleetWise::ModelManifest' + AND region = 'us-east-1' signal_catalogs: name: signal_catalogs id: aws.iotfleetwise.signal_catalogs @@ -2405,7 +2357,7 @@ components: x-cfn-type-name: AWS::IoTFleetWise::SignalCatalog x-identifiers: - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2422,9 +2374,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2434,41 +2386,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/signal_catalogs/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/signal_catalogs/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTFleetWise::SignalCatalog' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTFleetWise::SignalCatalog' - AND region = 'us-east-1' - signal_catalog: - name: signal_catalog - id: aws.iotfleetwise.signal_catalog - x-cfn-schema-name: SignalCatalog - x-cfn-type-name: AWS::IoTFleetWise::SignalCatalog - x-identifiers: - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2479,12 +2399,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/signal_catalogs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/signal_catalogs/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/signal_catalog/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/signal_catalogs/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2501,22 +2425,38 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'CreationTime') as creation_time, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'LastModificationTime') as last_modification_time, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'NodeCounts') as node_counts, - json_extract_path_text(Properties, 'Nodes') as nodes, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTFleetWise::SignalCatalog' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTFleetWise::SignalCatalog' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'CreationTime') as creation_time, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'LastModificationTime') as last_modification_time, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'NodeCounts') as node_counts, + json_extract_path_text(Properties, 'Nodes') as nodes, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTFleetWise::SignalCatalog' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTFleetWise::SignalCatalog' + AND region = 'us-east-1' vehicles: name: vehicles id: aws.iotfleetwise.vehicles @@ -2524,7 +2464,7 @@ components: x-cfn-type-name: AWS::IoTFleetWise::Vehicle x-identifiers: - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2541,9 +2481,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2553,41 +2493,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/vehicles/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/vehicles/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTFleetWise::Vehicle' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTFleetWise::Vehicle' - AND region = 'us-east-1' - vehicle: - name: vehicle - id: aws.iotfleetwise.vehicle - x-cfn-schema-name: Vehicle - x-cfn-type-name: AWS::IoTFleetWise::Vehicle - x-identifiers: - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2598,12 +2506,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/vehicles/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/vehicles/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/vehicle/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/vehicles/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2621,23 +2533,39 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'AssociationBehavior') as association_behavior, - json_extract_path_text(Properties, 'Attributes') as attributes, - json_extract_path_text(Properties, 'CreationTime') as creation_time, - json_extract_path_text(Properties, 'DecoderManifestArn') as decoder_manifest_arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'LastModificationTime') as last_modification_time, - json_extract_path_text(Properties, 'ModelManifestArn') as model_manifest_arn, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTFleetWise::Vehicle' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTFleetWise::Vehicle' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'AssociationBehavior') as association_behavior, + json_extract_path_text(Properties, 'Attributes') as attributes, + json_extract_path_text(Properties, 'CreationTime') as creation_time, + json_extract_path_text(Properties, 'DecoderManifestArn') as decoder_manifest_arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'LastModificationTime') as last_modification_time, + json_extract_path_text(Properties, 'ModelManifestArn') as model_manifest_arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTFleetWise::Vehicle' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTFleetWise::Vehicle' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/iotsitewise.yaml b/providers/src/aws/v00.00.00000/services/iotsitewise.yaml index 2797667f..b6050ce2 100644 --- a/providers/src/aws/v00.00.00000/services/iotsitewise.yaml +++ b/providers/src/aws/v00.00.00000/services/iotsitewise.yaml @@ -1842,7 +1842,7 @@ components: x-cfn-type-name: AWS::IoTSiteWise::Portal x-identifiers: - PortalId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1859,9 +1859,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1871,41 +1871,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/portals/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/portals/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.PortalId') as portal_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTSiteWise::Portal' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'PortalId') as portal_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTSiteWise::Portal' - AND region = 'us-east-1' - portal: - name: portal - id: aws.iotsitewise.portal - x-cfn-schema-name: Portal - x-cfn-type-name: AWS::IoTSiteWise::Portal - x-identifiers: - - PortalId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1916,12 +1884,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/portals/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/portals/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/portal/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/portals/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1942,26 +1914,42 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'PortalAuthMode') as portal_auth_mode, - json_extract_path_text(Properties, 'PortalArn') as portal_arn, - json_extract_path_text(Properties, 'PortalClientId') as portal_client_id, - json_extract_path_text(Properties, 'PortalContactEmail') as portal_contact_email, - json_extract_path_text(Properties, 'PortalDescription') as portal_description, - json_extract_path_text(Properties, 'PortalId') as portal_id, - json_extract_path_text(Properties, 'PortalName') as portal_name, - json_extract_path_text(Properties, 'PortalStartUrl') as portal_start_url, - json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'NotificationSenderEmail') as notification_sender_email, - json_extract_path_text(Properties, 'Alarms') as alarms, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTSiteWise::Portal' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.PortalId') as portal_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTSiteWise::Portal' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'PortalAuthMode') as portal_auth_mode, + json_extract_path_text(Properties, 'PortalArn') as portal_arn, + json_extract_path_text(Properties, 'PortalClientId') as portal_client_id, + json_extract_path_text(Properties, 'PortalContactEmail') as portal_contact_email, + json_extract_path_text(Properties, 'PortalDescription') as portal_description, + json_extract_path_text(Properties, 'PortalId') as portal_id, + json_extract_path_text(Properties, 'PortalName') as portal_name, + json_extract_path_text(Properties, 'PortalStartUrl') as portal_start_url, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'NotificationSenderEmail') as notification_sender_email, + json_extract_path_text(Properties, 'Alarms') as alarms, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTSiteWise::Portal' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'PortalId') as portal_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTSiteWise::Portal' + AND region = 'us-east-1' projects: name: projects id: aws.iotsitewise.projects @@ -1969,7 +1957,7 @@ components: x-cfn-type-name: AWS::IoTSiteWise::Project x-identifiers: - ProjectId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1986,9 +1974,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1998,41 +1986,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/projects/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/projects/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ProjectId') as project_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTSiteWise::Project' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ProjectId') as project_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTSiteWise::Project' - AND region = 'us-east-1' - project: - name: project - id: aws.iotsitewise.project - x-cfn-schema-name: Project - x-cfn-type-name: AWS::IoTSiteWise::Project - x-identifiers: - - ProjectId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2043,12 +1999,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/projects/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/projects/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/project/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/projects/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2064,21 +2024,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'PortalId') as portal_id, - json_extract_path_text(Properties, 'ProjectId') as project_id, - json_extract_path_text(Properties, 'ProjectName') as project_name, - json_extract_path_text(Properties, 'ProjectDescription') as project_description, - json_extract_path_text(Properties, 'ProjectArn') as project_arn, - json_extract_path_text(Properties, 'AssetIds') as asset_ids, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTSiteWise::Project' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ProjectId') as project_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTSiteWise::Project' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'PortalId') as portal_id, + json_extract_path_text(Properties, 'ProjectId') as project_id, + json_extract_path_text(Properties, 'ProjectName') as project_name, + json_extract_path_text(Properties, 'ProjectDescription') as project_description, + json_extract_path_text(Properties, 'ProjectArn') as project_arn, + json_extract_path_text(Properties, 'AssetIds') as asset_ids, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTSiteWise::Project' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ProjectId') as project_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTSiteWise::Project' + AND region = 'us-east-1' access_policies: name: access_policies id: aws.iotsitewise.access_policies @@ -2086,7 +2062,7 @@ components: x-cfn-type-name: AWS::IoTSiteWise::AccessPolicy x-identifiers: - AccessPolicyId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2103,9 +2079,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2115,41 +2091,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/access_policies/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/access_policies/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AccessPolicyId') as access_policy_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTSiteWise::AccessPolicy' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AccessPolicyId') as access_policy_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTSiteWise::AccessPolicy' - AND region = 'us-east-1' - access_policy: - name: access_policy - id: aws.iotsitewise.access_policy - x-cfn-schema-name: AccessPolicy - x-cfn-type-name: AWS::IoTSiteWise::AccessPolicy - x-identifiers: - - AccessPolicyId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2160,12 +2104,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/access_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/access_policies/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/access_policy/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/access_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2179,19 +2127,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AccessPolicyId') as access_policy_id, - json_extract_path_text(Properties, 'AccessPolicyArn') as access_policy_arn, - json_extract_path_text(Properties, 'AccessPolicyIdentity') as access_policy_identity, - json_extract_path_text(Properties, 'AccessPolicyPermission') as access_policy_permission, - json_extract_path_text(Properties, 'AccessPolicyResource') as access_policy_resource - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTSiteWise::AccessPolicy' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.AccessPolicyId') as access_policy_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTSiteWise::AccessPolicy' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AccessPolicyId') as access_policy_id, + json_extract_path_text(Properties, 'AccessPolicyArn') as access_policy_arn, + json_extract_path_text(Properties, 'AccessPolicyIdentity') as access_policy_identity, + json_extract_path_text(Properties, 'AccessPolicyPermission') as access_policy_permission, + json_extract_path_text(Properties, 'AccessPolicyResource') as access_policy_resource + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTSiteWise::AccessPolicy' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AccessPolicyId') as access_policy_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTSiteWise::AccessPolicy' + AND region = 'us-east-1' assets: name: assets id: aws.iotsitewise.assets @@ -2199,7 +2163,7 @@ components: x-cfn-type-name: AWS::IoTSiteWise::Asset x-identifiers: - AssetId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2216,9 +2180,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2228,41 +2192,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/assets/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/assets/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AssetId') as asset_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTSiteWise::Asset' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AssetId') as asset_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTSiteWise::Asset' - AND region = 'us-east-1' - asset: - name: asset - id: aws.iotsitewise.asset - x-cfn-schema-name: Asset - x-cfn-type-name: AWS::IoTSiteWise::Asset - x-identifiers: - - AssetId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2273,12 +2205,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/assets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/assets/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/asset/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/assets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2296,23 +2232,39 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AssetId') as asset_id, - json_extract_path_text(Properties, 'AssetExternalId') as asset_external_id, - json_extract_path_text(Properties, 'AssetModelId') as asset_model_id, - json_extract_path_text(Properties, 'AssetArn') as asset_arn, - json_extract_path_text(Properties, 'AssetName') as asset_name, - json_extract_path_text(Properties, 'AssetDescription') as asset_description, - json_extract_path_text(Properties, 'AssetProperties') as asset_properties, - json_extract_path_text(Properties, 'AssetHierarchies') as asset_hierarchies, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTSiteWise::Asset' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.AssetId') as asset_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTSiteWise::Asset' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AssetId') as asset_id, + json_extract_path_text(Properties, 'AssetExternalId') as asset_external_id, + json_extract_path_text(Properties, 'AssetModelId') as asset_model_id, + json_extract_path_text(Properties, 'AssetArn') as asset_arn, + json_extract_path_text(Properties, 'AssetName') as asset_name, + json_extract_path_text(Properties, 'AssetDescription') as asset_description, + json_extract_path_text(Properties, 'AssetProperties') as asset_properties, + json_extract_path_text(Properties, 'AssetHierarchies') as asset_hierarchies, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTSiteWise::Asset' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AssetId') as asset_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTSiteWise::Asset' + AND region = 'us-east-1' asset_models: name: asset_models id: aws.iotsitewise.asset_models @@ -2320,7 +2272,7 @@ components: x-cfn-type-name: AWS::IoTSiteWise::AssetModel x-identifiers: - AssetModelId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2337,9 +2289,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2349,41 +2301,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/asset_models/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/asset_models/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AssetModelId') as asset_model_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTSiteWise::AssetModel' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AssetModelId') as asset_model_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTSiteWise::AssetModel' - AND region = 'us-east-1' - asset_model: - name: asset_model - id: aws.iotsitewise.asset_model - x-cfn-schema-name: AssetModel - x-cfn-type-name: AWS::IoTSiteWise::AssetModel - x-identifiers: - - AssetModelId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2394,12 +2314,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/asset_models/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/asset_models/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/asset_model/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/asset_models/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2418,24 +2342,40 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AssetModelId') as asset_model_id, - json_extract_path_text(Properties, 'AssetModelType') as asset_model_type, - json_extract_path_text(Properties, 'AssetModelExternalId') as asset_model_external_id, - json_extract_path_text(Properties, 'AssetModelArn') as asset_model_arn, - json_extract_path_text(Properties, 'AssetModelName') as asset_model_name, - json_extract_path_text(Properties, 'AssetModelDescription') as asset_model_description, - json_extract_path_text(Properties, 'AssetModelProperties') as asset_model_properties, - json_extract_path_text(Properties, 'AssetModelCompositeModels') as asset_model_composite_models, - json_extract_path_text(Properties, 'AssetModelHierarchies') as asset_model_hierarchies, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTSiteWise::AssetModel' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.AssetModelId') as asset_model_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTSiteWise::AssetModel' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AssetModelId') as asset_model_id, + json_extract_path_text(Properties, 'AssetModelType') as asset_model_type, + json_extract_path_text(Properties, 'AssetModelExternalId') as asset_model_external_id, + json_extract_path_text(Properties, 'AssetModelArn') as asset_model_arn, + json_extract_path_text(Properties, 'AssetModelName') as asset_model_name, + json_extract_path_text(Properties, 'AssetModelDescription') as asset_model_description, + json_extract_path_text(Properties, 'AssetModelProperties') as asset_model_properties, + json_extract_path_text(Properties, 'AssetModelCompositeModels') as asset_model_composite_models, + json_extract_path_text(Properties, 'AssetModelHierarchies') as asset_model_hierarchies, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTSiteWise::AssetModel' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AssetModelId') as asset_model_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTSiteWise::AssetModel' + AND region = 'us-east-1' dashboards: name: dashboards id: aws.iotsitewise.dashboards @@ -2443,7 +2383,7 @@ components: x-cfn-type-name: AWS::IoTSiteWise::Dashboard x-identifiers: - DashboardId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2460,9 +2400,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2472,41 +2412,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/dashboards/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/dashboards/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.DashboardId') as dashboard_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTSiteWise::Dashboard' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'DashboardId') as dashboard_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTSiteWise::Dashboard' - AND region = 'us-east-1' - dashboard: - name: dashboard - id: aws.iotsitewise.dashboard - x-cfn-schema-name: Dashboard - x-cfn-type-name: AWS::IoTSiteWise::Dashboard - x-identifiers: - - DashboardId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2517,12 +2425,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/dashboards/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/dashboards/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/dashboard/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/dashboards/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2538,21 +2450,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ProjectId') as project_id, - json_extract_path_text(Properties, 'DashboardId') as dashboard_id, - json_extract_path_text(Properties, 'DashboardName') as dashboard_name, - json_extract_path_text(Properties, 'DashboardDescription') as dashboard_description, - json_extract_path_text(Properties, 'DashboardDefinition') as dashboard_definition, - json_extract_path_text(Properties, 'DashboardArn') as dashboard_arn, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTSiteWise::Dashboard' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.DashboardId') as dashboard_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTSiteWise::Dashboard' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ProjectId') as project_id, + json_extract_path_text(Properties, 'DashboardId') as dashboard_id, + json_extract_path_text(Properties, 'DashboardName') as dashboard_name, + json_extract_path_text(Properties, 'DashboardDescription') as dashboard_description, + json_extract_path_text(Properties, 'DashboardDefinition') as dashboard_definition, + json_extract_path_text(Properties, 'DashboardArn') as dashboard_arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTSiteWise::Dashboard' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DashboardId') as dashboard_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTSiteWise::Dashboard' + AND region = 'us-east-1' gateways: name: gateways id: aws.iotsitewise.gateways @@ -2560,7 +2488,7 @@ components: x-cfn-type-name: AWS::IoTSiteWise::Gateway x-identifiers: - GatewayId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2577,9 +2505,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2589,41 +2517,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/gateways/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/gateways/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.GatewayId') as gateway_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTSiteWise::Gateway' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'GatewayId') as gateway_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTSiteWise::Gateway' - AND region = 'us-east-1' - gateway: - name: gateway - id: aws.iotsitewise.gateway - x-cfn-schema-name: Gateway - x-cfn-type-name: AWS::IoTSiteWise::Gateway - x-identifiers: - - GatewayId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2634,12 +2530,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/gateways/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/gateways/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/gateway/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/gateways/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2653,19 +2553,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'GatewayName') as gateway_name, - json_extract_path_text(Properties, 'GatewayPlatform') as gateway_platform, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'GatewayId') as gateway_id, - json_extract_path_text(Properties, 'GatewayCapabilitySummaries') as gateway_capability_summaries - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTSiteWise::Gateway' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.GatewayId') as gateway_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTSiteWise::Gateway' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'GatewayName') as gateway_name, + json_extract_path_text(Properties, 'GatewayPlatform') as gateway_platform, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'GatewayId') as gateway_id, + json_extract_path_text(Properties, 'GatewayCapabilitySummaries') as gateway_capability_summaries + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTSiteWise::Gateway' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'GatewayId') as gateway_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTSiteWise::Gateway' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/iottwinmaker.yaml b/providers/src/aws/v00.00.00000/services/iottwinmaker.yaml index 3a83c23d..9280aa30 100644 --- a/providers/src/aws/v00.00.00000/services/iottwinmaker.yaml +++ b/providers/src/aws/v00.00.00000/services/iottwinmaker.yaml @@ -1826,7 +1826,7 @@ components: x-identifiers: - WorkspaceId - ComponentTypeId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1843,9 +1843,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1855,44 +1855,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/component_types/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/component_types/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.WorkspaceId') as workspace_id, - JSON_EXTRACT(Properties, '$.ComponentTypeId') as component_type_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTTwinMaker::ComponentType' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'WorkspaceId') as workspace_id, - json_extract_path_text(Properties, 'ComponentTypeId') as component_type_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTTwinMaker::ComponentType' - AND region = 'us-east-1' - component_type: - name: component_type - id: aws.iottwinmaker.component_type - x-cfn-schema-name: ComponentType - x-cfn-type-name: AWS::IoTTwinMaker::ComponentType - x-identifiers: - - WorkspaceId - - ComponentTypeId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1903,12 +1868,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/component_types/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/component_types/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/component_type/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/component_types/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1933,30 +1902,48 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'WorkspaceId') as workspace_id, - json_extract_path_text(Properties, 'ComponentTypeId') as component_type_id, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'ExtendsFrom') as extends_from, - json_extract_path_text(Properties, 'Functions') as functions, - json_extract_path_text(Properties, 'IsSingleton') as is_singleton, - json_extract_path_text(Properties, 'PropertyDefinitions') as property_definitions, - json_extract_path_text(Properties, 'PropertyGroups') as property_groups, - json_extract_path_text(Properties, 'CompositeComponentTypes') as composite_component_types, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'CreationDateTime') as creation_date_time, - json_extract_path_text(Properties, 'UpdateDateTime') as update_date_time, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'IsAbstract') as is_abstract, - json_extract_path_text(Properties, 'IsSchemaInitialized') as is_schema_initialized, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTTwinMaker::ComponentType' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.WorkspaceId') as workspace_id, + JSON_EXTRACT(Properties, '$.ComponentTypeId') as component_type_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTTwinMaker::ComponentType' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'WorkspaceId') as workspace_id, + json_extract_path_text(Properties, 'ComponentTypeId') as component_type_id, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'ExtendsFrom') as extends_from, + json_extract_path_text(Properties, 'Functions') as functions, + json_extract_path_text(Properties, 'IsSingleton') as is_singleton, + json_extract_path_text(Properties, 'PropertyDefinitions') as property_definitions, + json_extract_path_text(Properties, 'PropertyGroups') as property_groups, + json_extract_path_text(Properties, 'CompositeComponentTypes') as composite_component_types, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'CreationDateTime') as creation_date_time, + json_extract_path_text(Properties, 'UpdateDateTime') as update_date_time, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'IsAbstract') as is_abstract, + json_extract_path_text(Properties, 'IsSchemaInitialized') as is_schema_initialized, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTTwinMaker::ComponentType' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'WorkspaceId') as workspace_id, + json_extract_path_text(Properties, 'ComponentTypeId') as component_type_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTTwinMaker::ComponentType' + AND region = 'us-east-1' entities: name: entities id: aws.iottwinmaker.entities @@ -1965,7 +1952,7 @@ components: x-identifiers: - WorkspaceId - EntityId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1982,9 +1969,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1994,44 +1981,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/entities/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/entities/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.WorkspaceId') as workspace_id, - JSON_EXTRACT(Properties, '$.EntityId') as entity_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTTwinMaker::Entity' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'WorkspaceId') as workspace_id, - json_extract_path_text(Properties, 'EntityId') as entity_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTTwinMaker::Entity' - AND region = 'us-east-1' - entity: - name: entity - id: aws.iottwinmaker.entity - x-cfn-schema-name: Entity - x-cfn-type-name: AWS::IoTTwinMaker::Entity - x-identifiers: - - WorkspaceId - - EntityId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2042,12 +1994,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/entities/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/entities/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/entity/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/entities/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2069,27 +2025,45 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'EntityId') as entity_id, - json_extract_path_text(Properties, 'EntityName') as entity_name, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'HasChildEntities') as has_child_entities, - json_extract_path_text(Properties, 'ParentEntityId') as parent_entity_id, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'CreationDateTime') as creation_date_time, - json_extract_path_text(Properties, 'UpdateDateTime') as update_date_time, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'WorkspaceId') as workspace_id, - json_extract_path_text(Properties, 'Components') as components, - json_extract_path_text(Properties, 'CompositeComponents') as composite_components - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTTwinMaker::Entity' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.WorkspaceId') as workspace_id, + JSON_EXTRACT(Properties, '$.EntityId') as entity_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTTwinMaker::Entity' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'EntityId') as entity_id, + json_extract_path_text(Properties, 'EntityName') as entity_name, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'HasChildEntities') as has_child_entities, + json_extract_path_text(Properties, 'ParentEntityId') as parent_entity_id, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'CreationDateTime') as creation_date_time, + json_extract_path_text(Properties, 'UpdateDateTime') as update_date_time, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'WorkspaceId') as workspace_id, + json_extract_path_text(Properties, 'Components') as components, + json_extract_path_text(Properties, 'CompositeComponents') as composite_components + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTTwinMaker::Entity' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'WorkspaceId') as workspace_id, + json_extract_path_text(Properties, 'EntityId') as entity_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTTwinMaker::Entity' + AND region = 'us-east-1' scenes: name: scenes id: aws.iottwinmaker.scenes @@ -2098,7 +2072,7 @@ components: x-identifiers: - WorkspaceId - SceneId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2115,9 +2089,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2127,44 +2101,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/scenes/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/scenes/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.WorkspaceId') as workspace_id, - JSON_EXTRACT(Properties, '$.SceneId') as scene_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTTwinMaker::Scene' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'WorkspaceId') as workspace_id, - json_extract_path_text(Properties, 'SceneId') as scene_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTTwinMaker::Scene' - AND region = 'us-east-1' - scene: - name: scene - id: aws.iottwinmaker.scene - x-cfn-schema-name: Scene - x-cfn-type-name: AWS::IoTTwinMaker::Scene - x-identifiers: - - WorkspaceId - - SceneId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2175,12 +2114,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/scenes/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/scenes/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/scene/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/scenes/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2200,25 +2143,43 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'SceneId') as scene_id, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'ContentLocation') as content_location, - json_extract_path_text(Properties, 'CreationDateTime') as creation_date_time, - json_extract_path_text(Properties, 'UpdateDateTime') as update_date_time, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'WorkspaceId') as workspace_id, - json_extract_path_text(Properties, 'Capabilities') as capabilities, - json_extract_path_text(Properties, 'SceneMetadata') as scene_metadata, - json_extract_path_text(Properties, 'GeneratedSceneMetadata') as generated_scene_metadata - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTTwinMaker::Scene' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.WorkspaceId') as workspace_id, + JSON_EXTRACT(Properties, '$.SceneId') as scene_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTTwinMaker::Scene' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'SceneId') as scene_id, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'ContentLocation') as content_location, + json_extract_path_text(Properties, 'CreationDateTime') as creation_date_time, + json_extract_path_text(Properties, 'UpdateDateTime') as update_date_time, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'WorkspaceId') as workspace_id, + json_extract_path_text(Properties, 'Capabilities') as capabilities, + json_extract_path_text(Properties, 'SceneMetadata') as scene_metadata, + json_extract_path_text(Properties, 'GeneratedSceneMetadata') as generated_scene_metadata + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTTwinMaker::Scene' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'WorkspaceId') as workspace_id, + json_extract_path_text(Properties, 'SceneId') as scene_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTTwinMaker::Scene' + AND region = 'us-east-1' sync_jobs: name: sync_jobs id: aws.iottwinmaker.sync_jobs @@ -2227,7 +2188,7 @@ components: x-identifiers: - WorkspaceId - SyncSource - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2261,42 +2222,11 @@ components: - $ref: '#/components/x-stackQL-resources/sync_jobs/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/sync_jobs/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.WorkspaceId') as workspace_id, - JSON_EXTRACT(Properties, '$.SyncSource') as sync_source - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTTwinMaker::SyncJob' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'WorkspaceId') as workspace_id, - json_extract_path_text(Properties, 'SyncSource') as sync_source - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTTwinMaker::SyncJob' - AND region = 'us-east-1' - sync_job: - name: sync_job - id: aws.iottwinmaker.sync_job - x-cfn-schema-name: SyncJob - x-cfn-type-name: AWS::IoTTwinMaker::SyncJob - x-identifiers: - - WorkspaceId - - SyncSource - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2313,22 +2243,40 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'WorkspaceId') as workspace_id, - json_extract_path_text(Properties, 'SyncSource') as sync_source, - json_extract_path_text(Properties, 'SyncRole') as sync_role, - json_extract_path_text(Properties, 'CreationDateTime') as creation_date_time, - json_extract_path_text(Properties, 'UpdateDateTime') as update_date_time, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'State') as state, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTTwinMaker::SyncJob' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.WorkspaceId') as workspace_id, + JSON_EXTRACT(Properties, '$.SyncSource') as sync_source + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTTwinMaker::SyncJob' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'WorkspaceId') as workspace_id, + json_extract_path_text(Properties, 'SyncSource') as sync_source, + json_extract_path_text(Properties, 'SyncRole') as sync_role, + json_extract_path_text(Properties, 'CreationDateTime') as creation_date_time, + json_extract_path_text(Properties, 'UpdateDateTime') as update_date_time, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTTwinMaker::SyncJob' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'WorkspaceId') as workspace_id, + json_extract_path_text(Properties, 'SyncSource') as sync_source + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTTwinMaker::SyncJob' + AND region = 'us-east-1' workspaces: name: workspaces id: aws.iottwinmaker.workspaces @@ -2336,7 +2284,7 @@ components: x-cfn-type-name: AWS::IoTTwinMaker::Workspace x-identifiers: - WorkspaceId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2353,9 +2301,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2365,41 +2313,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/workspaces/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/workspaces/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.WorkspaceId') as workspace_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTTwinMaker::Workspace' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'WorkspaceId') as workspace_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTTwinMaker::Workspace' - AND region = 'us-east-1' - workspace: - name: workspace - id: aws.iottwinmaker.workspace - x-cfn-schema-name: Workspace - x-cfn-type-name: AWS::IoTTwinMaker::Workspace - x-identifiers: - - WorkspaceId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2410,12 +2326,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/workspaces/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/workspaces/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/workspace/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/workspaces/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2432,22 +2352,38 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'WorkspaceId') as workspace_id, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Role') as role, - json_extract_path_text(Properties, 'S3Location') as s3_location, - json_extract_path_text(Properties, 'CreationDateTime') as creation_date_time, - json_extract_path_text(Properties, 'UpdateDateTime') as update_date_time, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTTwinMaker::Workspace' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.WorkspaceId') as workspace_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTTwinMaker::Workspace' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'WorkspaceId') as workspace_id, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Role') as role, + json_extract_path_text(Properties, 'S3Location') as s3_location, + json_extract_path_text(Properties, 'CreationDateTime') as creation_date_time, + json_extract_path_text(Properties, 'UpdateDateTime') as update_date_time, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTTwinMaker::Workspace' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'WorkspaceId') as workspace_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTTwinMaker::Workspace' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/iotwireless.yaml b/providers/src/aws/v00.00.00000/services/iotwireless.yaml index 84565f02..04292e93 100644 --- a/providers/src/aws/v00.00.00000/services/iotwireless.yaml +++ b/providers/src/aws/v00.00.00000/services/iotwireless.yaml @@ -2316,7 +2316,7 @@ components: x-cfn-type-name: AWS::IoTWireless::Destination x-identifiers: - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2333,9 +2333,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2345,41 +2345,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/destinations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/destinations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::Destination' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::Destination' - AND region = 'us-east-1' - destination: - name: destination - id: aws.iotwireless.destination - x-cfn-schema-name: Destination - x-cfn-type-name: AWS::IoTWireless::Destination - x-identifiers: - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2390,12 +2358,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/destinations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/destinations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/destination/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/destinations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2411,21 +2383,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Expression') as expression, - json_extract_path_text(Properties, 'ExpressionType') as expression_type, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTWireless::Destination' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::Destination' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Expression') as expression, + json_extract_path_text(Properties, 'ExpressionType') as expression_type, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTWireless::Destination' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::Destination' + AND region = 'us-east-1' device_profiles: name: device_profiles id: aws.iotwireless.device_profiles @@ -2433,7 +2421,7 @@ components: x-cfn-type-name: AWS::IoTWireless::DeviceProfile x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2467,39 +2455,11 @@ components: - $ref: '#/components/x-stackQL-resources/device_profiles/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/device_profiles/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::DeviceProfile' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::DeviceProfile' - AND region = 'us-east-1' - device_profile: - name: device_profile - id: aws.iotwireless.device_profile - x-cfn-schema-name: DeviceProfile - x-cfn-type-name: AWS::IoTWireless::DeviceProfile - x-identifiers: - - Id - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2513,19 +2473,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'LoRaWAN') as lo_ra_wan, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTWireless::DeviceProfile' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::DeviceProfile' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'LoRaWAN') as lo_ra_wan, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTWireless::DeviceProfile' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::DeviceProfile' + AND region = 'us-east-1' fuota_tasks: name: fuota_tasks id: aws.iotwireless.fuota_tasks @@ -2533,7 +2509,7 @@ components: x-cfn-type-name: AWS::IoTWireless::FuotaTask x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2550,9 +2526,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2562,41 +2538,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/fuota_tasks/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/fuota_tasks/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::FuotaTask' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::FuotaTask' - AND region = 'us-east-1' - fuota_task: - name: fuota_task - id: aws.iotwireless.fuota_task - x-cfn-schema-name: FuotaTask - x-cfn-type-name: AWS::IoTWireless::FuotaTask - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2607,12 +2551,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/fuota_tasks/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/fuota_tasks/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/fuota_task/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/fuota_tasks/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2634,27 +2582,43 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'LoRaWAN') as lo_ra_wan, - json_extract_path_text(Properties, 'FirmwareUpdateImage') as firmware_update_image, - json_extract_path_text(Properties, 'FirmwareUpdateRole') as firmware_update_role, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'FuotaTaskStatus') as fuota_task_status, - json_extract_path_text(Properties, 'AssociateWirelessDevice') as associate_wireless_device, - json_extract_path_text(Properties, 'DisassociateWirelessDevice') as disassociate_wireless_device, - json_extract_path_text(Properties, 'AssociateMulticastGroup') as associate_multicast_group, - json_extract_path_text(Properties, 'DisassociateMulticastGroup') as disassociate_multicast_group - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTWireless::FuotaTask' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::FuotaTask' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'LoRaWAN') as lo_ra_wan, + json_extract_path_text(Properties, 'FirmwareUpdateImage') as firmware_update_image, + json_extract_path_text(Properties, 'FirmwareUpdateRole') as firmware_update_role, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'FuotaTaskStatus') as fuota_task_status, + json_extract_path_text(Properties, 'AssociateWirelessDevice') as associate_wireless_device, + json_extract_path_text(Properties, 'DisassociateWirelessDevice') as disassociate_wireless_device, + json_extract_path_text(Properties, 'AssociateMulticastGroup') as associate_multicast_group, + json_extract_path_text(Properties, 'DisassociateMulticastGroup') as disassociate_multicast_group + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTWireless::FuotaTask' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::FuotaTask' + AND region = 'us-east-1' multicast_groups: name: multicast_groups id: aws.iotwireless.multicast_groups @@ -2662,7 +2626,7 @@ components: x-cfn-type-name: AWS::IoTWireless::MulticastGroup x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2679,9 +2643,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2691,41 +2655,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/multicast_groups/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/multicast_groups/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::MulticastGroup' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::MulticastGroup' - AND region = 'us-east-1' - multicast_group: - name: multicast_group - id: aws.iotwireless.multicast_group - x-cfn-schema-name: MulticastGroup - x-cfn-type-name: AWS::IoTWireless::MulticastGroup - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2736,12 +2668,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/multicast_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/multicast_groups/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/multicast_group/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/multicast_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2759,23 +2695,39 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'LoRaWAN') as lo_ra_wan, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'AssociateWirelessDevice') as associate_wireless_device, - json_extract_path_text(Properties, 'DisassociateWirelessDevice') as disassociate_wireless_device - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTWireless::MulticastGroup' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::MulticastGroup' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'LoRaWAN') as lo_ra_wan, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'AssociateWirelessDevice') as associate_wireless_device, + json_extract_path_text(Properties, 'DisassociateWirelessDevice') as disassociate_wireless_device + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTWireless::MulticastGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::MulticastGroup' + AND region = 'us-east-1' network_analyzer_configurations: name: network_analyzer_configurations id: aws.iotwireless.network_analyzer_configurations @@ -2783,7 +2735,7 @@ components: x-cfn-type-name: AWS::IoTWireless::NetworkAnalyzerConfiguration x-identifiers: - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2800,9 +2752,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2812,41 +2764,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/network_analyzer_configurations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/network_analyzer_configurations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::NetworkAnalyzerConfiguration' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::NetworkAnalyzerConfiguration' - AND region = 'us-east-1' - network_analyzer_configuration: - name: network_analyzer_configuration - id: aws.iotwireless.network_analyzer_configuration - x-cfn-schema-name: NetworkAnalyzerConfiguration - x-cfn-type-name: AWS::IoTWireless::NetworkAnalyzerConfiguration - x-identifiers: - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2857,12 +2777,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/network_analyzer_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/network_analyzer_configurations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/network_analyzer_configuration/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/network_analyzer_configurations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2878,21 +2802,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'TraceContent') as trace_content, - json_extract_path_text(Properties, 'WirelessDevices') as wireless_devices, - json_extract_path_text(Properties, 'WirelessGateways') as wireless_gateways, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTWireless::NetworkAnalyzerConfiguration' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::NetworkAnalyzerConfiguration' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'TraceContent') as trace_content, + json_extract_path_text(Properties, 'WirelessDevices') as wireless_devices, + json_extract_path_text(Properties, 'WirelessGateways') as wireless_gateways, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTWireless::NetworkAnalyzerConfiguration' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::NetworkAnalyzerConfiguration' + AND region = 'us-east-1' partner_accounts: name: partner_accounts id: aws.iotwireless.partner_accounts @@ -2900,7 +2840,7 @@ components: x-cfn-type-name: AWS::IoTWireless::PartnerAccount x-identifiers: - PartnerAccountId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2917,9 +2857,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2929,41 +2869,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/partner_accounts/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/partner_accounts/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.PartnerAccountId') as partner_account_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::PartnerAccount' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'PartnerAccountId') as partner_account_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::PartnerAccount' - AND region = 'us-east-1' - partner_account: - name: partner_account - id: aws.iotwireless.partner_account - x-cfn-schema-name: PartnerAccount - x-cfn-type-name: AWS::IoTWireless::PartnerAccount - x-identifiers: - - PartnerAccountId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2974,12 +2882,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/partner_accounts/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/partner_accounts/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/partner_account/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/partner_accounts/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2997,23 +2909,39 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Sidewalk') as sidewalk, - json_extract_path_text(Properties, 'PartnerAccountId') as partner_account_id, - json_extract_path_text(Properties, 'PartnerType') as partner_type, - json_extract_path_text(Properties, 'SidewalkResponse') as sidewalk_response, - json_extract_path_text(Properties, 'AccountLinked') as account_linked, - json_extract_path_text(Properties, 'SidewalkUpdate') as sidewalk_update, - json_extract_path_text(Properties, 'Fingerprint') as fingerprint, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTWireless::PartnerAccount' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.PartnerAccountId') as partner_account_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::PartnerAccount' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Sidewalk') as sidewalk, + json_extract_path_text(Properties, 'PartnerAccountId') as partner_account_id, + json_extract_path_text(Properties, 'PartnerType') as partner_type, + json_extract_path_text(Properties, 'SidewalkResponse') as sidewalk_response, + json_extract_path_text(Properties, 'AccountLinked') as account_linked, + json_extract_path_text(Properties, 'SidewalkUpdate') as sidewalk_update, + json_extract_path_text(Properties, 'Fingerprint') as fingerprint, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTWireless::PartnerAccount' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'PartnerAccountId') as partner_account_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::PartnerAccount' + AND region = 'us-east-1' service_profiles: name: service_profiles id: aws.iotwireless.service_profiles @@ -3021,7 +2949,7 @@ components: x-cfn-type-name: AWS::IoTWireless::ServiceProfile x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3055,39 +2983,11 @@ components: - $ref: '#/components/x-stackQL-resources/service_profiles/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/service_profiles/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::ServiceProfile' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::ServiceProfile' - AND region = 'us-east-1' - service_profile: - name: service_profile - id: aws.iotwireless.service_profile - x-cfn-schema-name: ServiceProfile - x-cfn-type-name: AWS::IoTWireless::ServiceProfile - x-identifiers: - - Id - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3101,19 +3001,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'LoRaWAN') as lo_ra_wan, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTWireless::ServiceProfile' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::ServiceProfile' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'LoRaWAN') as lo_ra_wan, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTWireless::ServiceProfile' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::ServiceProfile' + AND region = 'us-east-1' task_definitions: name: task_definitions id: aws.iotwireless.task_definitions @@ -3121,7 +3037,7 @@ components: x-cfn-type-name: AWS::IoTWireless::TaskDefinition x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3155,39 +3071,11 @@ components: - $ref: '#/components/x-stackQL-resources/task_definitions/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/task_definitions/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::TaskDefinition' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::TaskDefinition' - AND region = 'us-east-1' - task_definition: - name: task_definition - id: aws.iotwireless.task_definition - x-cfn-schema-name: TaskDefinition - x-cfn-type-name: AWS::IoTWireless::TaskDefinition - x-identifiers: - - Id - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3204,22 +3092,38 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'AutoCreateTasks') as auto_create_tasks, - json_extract_path_text(Properties, 'Update') as _update, - json_extract_path_text(Properties, 'LoRaWANUpdateGatewayTaskEntry') as lo_ra_wan_update_gateway_task_entry, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'TaskDefinitionType') as task_definition_type, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTWireless::TaskDefinition' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::TaskDefinition' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'AutoCreateTasks') as auto_create_tasks, + json_extract_path_text(Properties, 'Update') as _update, + json_extract_path_text(Properties, 'LoRaWANUpdateGatewayTaskEntry') as lo_ra_wan_update_gateway_task_entry, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'TaskDefinitionType') as task_definition_type, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTWireless::TaskDefinition' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::TaskDefinition' + AND region = 'us-east-1' wireless_devices: name: wireless_devices id: aws.iotwireless.wireless_devices @@ -3227,7 +3131,7 @@ components: x-cfn-type-name: AWS::IoTWireless::WirelessDevice x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3244,9 +3148,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3256,41 +3160,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/wireless_devices/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/wireless_devices/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::WirelessDevice' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::WirelessDevice' - AND region = 'us-east-1' - wireless_device: - name: wireless_device - id: aws.iotwireless.wireless_device - x-cfn-schema-name: WirelessDevice - x-cfn-type-name: AWS::IoTWireless::WirelessDevice - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3301,12 +3173,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/wireless_devices/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/wireless_devices/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/wireless_device/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/wireless_devices/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3327,26 +3203,42 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Type') as type, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'DestinationName') as destination_name, - json_extract_path_text(Properties, 'LoRaWAN') as lo_ra_wan, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'ThingArn') as thing_arn, - json_extract_path_text(Properties, 'ThingName') as thing_name, - json_extract_path_text(Properties, 'LastUplinkReceivedAt') as last_uplink_received_at, - json_extract_path_text(Properties, 'Positioning') as positioning - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTWireless::WirelessDevice' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::WirelessDevice' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'DestinationName') as destination_name, + json_extract_path_text(Properties, 'LoRaWAN') as lo_ra_wan, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'ThingArn') as thing_arn, + json_extract_path_text(Properties, 'ThingName') as thing_name, + json_extract_path_text(Properties, 'LastUplinkReceivedAt') as last_uplink_received_at, + json_extract_path_text(Properties, 'Positioning') as positioning + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTWireless::WirelessDevice' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::WirelessDevice' + AND region = 'us-east-1' wireless_device_import_tasks: name: wireless_device_import_tasks id: aws.iotwireless.wireless_device_import_tasks @@ -3354,7 +3246,7 @@ components: x-cfn-type-name: AWS::IoTWireless::WirelessDeviceImportTask x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3371,9 +3263,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3383,41 +3275,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/wireless_device_import_tasks/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/wireless_device_import_tasks/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::WirelessDeviceImportTask' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::WirelessDeviceImportTask' - AND region = 'us-east-1' - wireless_device_import_task: - name: wireless_device_import_task - id: aws.iotwireless.wireless_device_import_task - x-cfn-schema-name: WirelessDeviceImportTask - x-cfn-type-name: AWS::IoTWireless::WirelessDeviceImportTask - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3428,12 +3288,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/wireless_device_import_tasks/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/wireless_device_import_tasks/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/wireless_device_import_task/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/wireless_device_import_tasks/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3454,26 +3318,42 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'DestinationName') as destination_name, - json_extract_path_text(Properties, 'CreationDate') as creation_date, - json_extract_path_text(Properties, 'Sidewalk') as sidewalk, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'StatusReason') as status_reason, - json_extract_path_text(Properties, 'InitializedImportedDevicesCount') as initialized_imported_devices_count, - json_extract_path_text(Properties, 'PendingImportedDevicesCount') as pending_imported_devices_count, - json_extract_path_text(Properties, 'OnboardedImportedDevicesCount') as onboarded_imported_devices_count, - json_extract_path_text(Properties, 'FailedImportedDevicesCount') as failed_imported_devices_count, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTWireless::WirelessDeviceImportTask' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::WirelessDeviceImportTask' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'DestinationName') as destination_name, + json_extract_path_text(Properties, 'CreationDate') as creation_date, + json_extract_path_text(Properties, 'Sidewalk') as sidewalk, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'StatusReason') as status_reason, + json_extract_path_text(Properties, 'InitializedImportedDevicesCount') as initialized_imported_devices_count, + json_extract_path_text(Properties, 'PendingImportedDevicesCount') as pending_imported_devices_count, + json_extract_path_text(Properties, 'OnboardedImportedDevicesCount') as onboarded_imported_devices_count, + json_extract_path_text(Properties, 'FailedImportedDevicesCount') as failed_imported_devices_count, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTWireless::WirelessDeviceImportTask' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::WirelessDeviceImportTask' + AND region = 'us-east-1' wireless_gateways: name: wireless_gateways id: aws.iotwireless.wireless_gateways @@ -3481,7 +3361,7 @@ components: x-cfn-type-name: AWS::IoTWireless::WirelessGateway x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3498,9 +3378,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3510,41 +3390,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/wireless_gateways/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/wireless_gateways/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::WirelessGateway' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::WirelessGateway' - AND region = 'us-east-1' - wireless_gateway: - name: wireless_gateway - id: aws.iotwireless.wireless_gateway - x-cfn-schema-name: WirelessGateway - x-cfn-type-name: AWS::IoTWireless::WirelessGateway - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3555,12 +3403,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/wireless_gateways/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/wireless_gateways/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/wireless_gateway/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/wireless_gateways/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3578,23 +3430,39 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'LoRaWAN') as lo_ra_wan, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'ThingArn') as thing_arn, - json_extract_path_text(Properties, 'ThingName') as thing_name, - json_extract_path_text(Properties, 'LastUplinkReceivedAt') as last_uplink_received_at - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTWireless::WirelessGateway' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::WirelessGateway' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'LoRaWAN') as lo_ra_wan, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'ThingArn') as thing_arn, + json_extract_path_text(Properties, 'ThingName') as thing_name, + json_extract_path_text(Properties, 'LastUplinkReceivedAt') as last_uplink_received_at + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IoTWireless::WirelessGateway' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IoTWireless::WirelessGateway' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/ivs.yaml b/providers/src/aws/v00.00.00000/services/ivs.yaml index a179d6e3..d314a0b7 100644 --- a/providers/src/aws/v00.00.00000/services/ivs.yaml +++ b/providers/src/aws/v00.00.00000/services/ivs.yaml @@ -1583,7 +1583,7 @@ components: x-cfn-type-name: AWS::IVS::Channel x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1600,9 +1600,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1612,41 +1612,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/channels/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/channels/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IVS::Channel' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IVS::Channel' - AND region = 'us-east-1' - channel: - name: channel - id: aws.ivs.channel - x-cfn-schema-name: Channel - x-cfn-type-name: AWS::IVS::Channel - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1657,12 +1625,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/channels/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/channels/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/channel/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/channels/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1682,25 +1654,41 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Authorized') as authorized, - json_extract_path_text(Properties, 'InsecureIngest') as insecure_ingest, - json_extract_path_text(Properties, 'LatencyMode') as latency_mode, - json_extract_path_text(Properties, 'Type') as type, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'PlaybackUrl') as playback_url, - json_extract_path_text(Properties, 'IngestEndpoint') as ingest_endpoint, - json_extract_path_text(Properties, 'RecordingConfigurationArn') as recording_configuration_arn, - json_extract_path_text(Properties, 'Preset') as preset - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IVS::Channel' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IVS::Channel' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Authorized') as authorized, + json_extract_path_text(Properties, 'InsecureIngest') as insecure_ingest, + json_extract_path_text(Properties, 'LatencyMode') as latency_mode, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'PlaybackUrl') as playback_url, + json_extract_path_text(Properties, 'IngestEndpoint') as ingest_endpoint, + json_extract_path_text(Properties, 'RecordingConfigurationArn') as recording_configuration_arn, + json_extract_path_text(Properties, 'Preset') as preset + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IVS::Channel' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IVS::Channel' + AND region = 'us-east-1' encoder_configurations: name: encoder_configurations id: aws.ivs.encoder_configurations @@ -1708,7 +1696,7 @@ components: x-cfn-type-name: AWS::IVS::EncoderConfiguration x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1725,9 +1713,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1737,41 +1725,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/encoder_configurations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/encoder_configurations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IVS::EncoderConfiguration' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IVS::EncoderConfiguration' - AND region = 'us-east-1' - encoder_configuration: - name: encoder_configuration - id: aws.ivs.encoder_configuration - x-cfn-schema-name: EncoderConfiguration - x-cfn-type-name: AWS::IVS::EncoderConfiguration - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1782,12 +1738,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/encoder_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/encoder_configurations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/encoder_configuration/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/encoder_configurations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1800,18 +1760,34 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Video') as video, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IVS::EncoderConfiguration' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IVS::EncoderConfiguration' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Video') as video, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IVS::EncoderConfiguration' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IVS::EncoderConfiguration' + AND region = 'us-east-1' playback_key_pairs: name: playback_key_pairs id: aws.ivs.playback_key_pairs @@ -1819,7 +1795,7 @@ components: x-cfn-type-name: AWS::IVS::PlaybackKeyPair x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1836,9 +1812,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1848,41 +1824,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/playback_key_pairs/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/playback_key_pairs/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IVS::PlaybackKeyPair' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IVS::PlaybackKeyPair' - AND region = 'us-east-1' - playback_key_pair: - name: playback_key_pair - id: aws.ivs.playback_key_pair - x-cfn-schema-name: PlaybackKeyPair - x-cfn-type-name: AWS::IVS::PlaybackKeyPair - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1893,12 +1837,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/playback_key_pairs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/playback_key_pairs/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/playback_key_pair/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/playback_key_pairs/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1912,19 +1860,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'PublicKeyMaterial') as public_key_material, - json_extract_path_text(Properties, 'Fingerprint') as fingerprint, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IVS::PlaybackKeyPair' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IVS::PlaybackKeyPair' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'PublicKeyMaterial') as public_key_material, + json_extract_path_text(Properties, 'Fingerprint') as fingerprint, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IVS::PlaybackKeyPair' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IVS::PlaybackKeyPair' + AND region = 'us-east-1' playback_restriction_policies: name: playback_restriction_policies id: aws.ivs.playback_restriction_policies @@ -1932,7 +1896,7 @@ components: x-cfn-type-name: AWS::IVS::PlaybackRestrictionPolicy x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1949,9 +1913,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1961,41 +1925,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/playback_restriction_policies/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/playback_restriction_policies/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IVS::PlaybackRestrictionPolicy' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IVS::PlaybackRestrictionPolicy' - AND region = 'us-east-1' - playback_restriction_policy: - name: playback_restriction_policy - id: aws.ivs.playback_restriction_policy - x-cfn-schema-name: PlaybackRestrictionPolicy - x-cfn-type-name: AWS::IVS::PlaybackRestrictionPolicy - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2006,12 +1938,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/playback_restriction_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/playback_restriction_policies/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/playback_restriction_policy/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/playback_restriction_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2026,20 +1962,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'AllowedCountries') as allowed_countries, - json_extract_path_text(Properties, 'AllowedOrigins') as allowed_origins, - json_extract_path_text(Properties, 'EnableStrictOriginEnforcement') as enable_strict_origin_enforcement, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IVS::PlaybackRestrictionPolicy' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IVS::PlaybackRestrictionPolicy' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'AllowedCountries') as allowed_countries, + json_extract_path_text(Properties, 'AllowedOrigins') as allowed_origins, + json_extract_path_text(Properties, 'EnableStrictOriginEnforcement') as enable_strict_origin_enforcement, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IVS::PlaybackRestrictionPolicy' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IVS::PlaybackRestrictionPolicy' + AND region = 'us-east-1' recording_configurations: name: recording_configurations id: aws.ivs.recording_configurations @@ -2047,7 +1999,7 @@ components: x-cfn-type-name: AWS::IVS::RecordingConfiguration x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2064,9 +2016,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2076,41 +2028,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/recording_configurations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/recording_configurations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IVS::RecordingConfiguration' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IVS::RecordingConfiguration' - AND region = 'us-east-1' - recording_configuration: - name: recording_configuration - id: aws.ivs.recording_configuration - x-cfn-schema-name: RecordingConfiguration - x-cfn-type-name: AWS::IVS::RecordingConfiguration - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2121,12 +2041,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/recording_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/recording_configurations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/recording_configuration/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/recording_configurations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2143,22 +2067,38 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'State') as state, - json_extract_path_text(Properties, 'RecordingReconnectWindowSeconds') as recording_reconnect_window_seconds, - json_extract_path_text(Properties, 'DestinationConfiguration') as destination_configuration, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'ThumbnailConfiguration') as thumbnail_configuration, - json_extract_path_text(Properties, 'RenditionConfiguration') as rendition_configuration - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IVS::RecordingConfiguration' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IVS::RecordingConfiguration' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'RecordingReconnectWindowSeconds') as recording_reconnect_window_seconds, + json_extract_path_text(Properties, 'DestinationConfiguration') as destination_configuration, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'ThumbnailConfiguration') as thumbnail_configuration, + json_extract_path_text(Properties, 'RenditionConfiguration') as rendition_configuration + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IVS::RecordingConfiguration' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IVS::RecordingConfiguration' + AND region = 'us-east-1' stages: name: stages id: aws.ivs.stages @@ -2166,7 +2106,7 @@ components: x-cfn-type-name: AWS::IVS::Stage x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2183,9 +2123,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2195,41 +2135,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/stages/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/stages/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IVS::Stage' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IVS::Stage' - AND region = 'us-east-1' - stage: - name: stage - id: aws.ivs.stage - x-cfn-schema-name: Stage - x-cfn-type-name: AWS::IVS::Stage - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2240,12 +2148,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/stages/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/stages/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/stage/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/stages/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2258,18 +2170,34 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'ActiveSessionId') as active_session_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IVS::Stage' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IVS::Stage' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'ActiveSessionId') as active_session_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IVS::Stage' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IVS::Stage' + AND region = 'us-east-1' storage_configurations: name: storage_configurations id: aws.ivs.storage_configurations @@ -2277,7 +2205,7 @@ components: x-cfn-type-name: AWS::IVS::StorageConfiguration x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2294,9 +2222,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2306,41 +2234,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/storage_configurations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/storage_configurations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IVS::StorageConfiguration' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IVS::StorageConfiguration' - AND region = 'us-east-1' - storage_configuration: - name: storage_configuration - id: aws.ivs.storage_configuration - x-cfn-schema-name: StorageConfiguration - x-cfn-type-name: AWS::IVS::StorageConfiguration - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2351,12 +2247,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/storage_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/storage_configurations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/storage_configuration/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/storage_configurations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2369,18 +2269,34 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'S3') as s3, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IVS::StorageConfiguration' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IVS::StorageConfiguration' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'S3') as s3, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IVS::StorageConfiguration' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IVS::StorageConfiguration' + AND region = 'us-east-1' stream_keys: name: stream_keys id: aws.ivs.stream_keys @@ -2388,7 +2304,7 @@ components: x-cfn-type-name: AWS::IVS::StreamKey x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2405,9 +2321,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2417,41 +2333,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/stream_keys/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/stream_keys/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IVS::StreamKey' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IVS::StreamKey' - AND region = 'us-east-1' - stream_key: - name: stream_key - id: aws.ivs.stream_key - x-cfn-schema-name: StreamKey - x-cfn-type-name: AWS::IVS::StreamKey - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2462,12 +2346,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/stream_keys/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/stream_keys/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/stream_key/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/stream_keys/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2480,18 +2368,34 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'ChannelArn') as channel_arn, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Value') as value - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IVS::StreamKey' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IVS::StreamKey' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'ChannelArn') as channel_arn, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Value') as value + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IVS::StreamKey' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IVS::StreamKey' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/ivschat.yaml b/providers/src/aws/v00.00.00000/services/ivschat.yaml index 996d0af1..1e5724aa 100644 --- a/providers/src/aws/v00.00.00000/services/ivschat.yaml +++ b/providers/src/aws/v00.00.00000/services/ivschat.yaml @@ -803,7 +803,7 @@ components: x-cfn-type-name: AWS::IVSChat::LoggingConfiguration x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -820,9 +820,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -832,41 +832,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/logging_configurations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/logging_configurations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IVSChat::LoggingConfiguration' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IVSChat::LoggingConfiguration' - AND region = 'us-east-1' - logging_configuration: - name: logging_configuration - id: aws.ivschat.logging_configuration - x-cfn-schema-name: LoggingConfiguration - x-cfn-type-name: AWS::IVSChat::LoggingConfiguration - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -877,12 +845,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/logging_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/logging_configurations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/logging_configuration/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/logging_configurations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -897,20 +869,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'DestinationConfiguration') as destination_configuration, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'State') as state, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IVSChat::LoggingConfiguration' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IVSChat::LoggingConfiguration' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'DestinationConfiguration') as destination_configuration, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IVSChat::LoggingConfiguration' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IVSChat::LoggingConfiguration' + AND region = 'us-east-1' rooms: name: rooms id: aws.ivschat.rooms @@ -918,7 +906,7 @@ components: x-cfn-type-name: AWS::IVSChat::Room x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -935,9 +923,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -947,41 +935,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/rooms/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/rooms/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IVSChat::Room' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IVSChat::Room' - AND region = 'us-east-1' - room: - name: room - id: aws.ivschat.room - x-cfn-schema-name: Room - x-cfn-type-name: AWS::IVSChat::Room - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -992,12 +948,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/rooms/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/rooms/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/room/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/rooms/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1014,22 +974,38 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'LoggingConfigurationIdentifiers') as logging_configuration_identifiers, - json_extract_path_text(Properties, 'MaximumMessageLength') as maximum_message_length, - json_extract_path_text(Properties, 'MaximumMessageRatePerSecond') as maximum_message_rate_per_second, - json_extract_path_text(Properties, 'MessageReviewHandler') as message_review_handler, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IVSChat::Room' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IVSChat::Room' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'LoggingConfigurationIdentifiers') as logging_configuration_identifiers, + json_extract_path_text(Properties, 'MaximumMessageLength') as maximum_message_length, + json_extract_path_text(Properties, 'MaximumMessageRatePerSecond') as maximum_message_rate_per_second, + json_extract_path_text(Properties, 'MessageReviewHandler') as message_review_handler, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IVSChat::Room' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IVSChat::Room' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/kafkaconnect.yaml b/providers/src/aws/v00.00.00000/services/kafkaconnect.yaml index 87c287c7..2a231f7b 100644 --- a/providers/src/aws/v00.00.00000/services/kafkaconnect.yaml +++ b/providers/src/aws/v00.00.00000/services/kafkaconnect.yaml @@ -1167,7 +1167,7 @@ components: x-cfn-type-name: AWS::KafkaConnect::CustomPlugin x-identifiers: - CustomPluginArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1184,9 +1184,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1196,41 +1196,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/custom_plugins/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/custom_plugins/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.CustomPluginArn') as custom_plugin_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::KafkaConnect::CustomPlugin' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'CustomPluginArn') as custom_plugin_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::KafkaConnect::CustomPlugin' - AND region = 'us-east-1' - custom_plugin: - name: custom_plugin - id: aws.kafkaconnect.custom_plugin - x-cfn-schema-name: CustomPlugin - x-cfn-type-name: AWS::KafkaConnect::CustomPlugin - x-identifiers: - - CustomPluginArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1241,12 +1209,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/custom_plugins/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/custom_plugins/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/custom_plugin/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/custom_plugins/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1263,22 +1235,38 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'CustomPluginArn') as custom_plugin_arn, - json_extract_path_text(Properties, 'ContentType') as content_type, - json_extract_path_text(Properties, 'FileDescription') as file_description, - json_extract_path_text(Properties, 'Location') as location, - json_extract_path_text(Properties, 'Revision') as revision, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::KafkaConnect::CustomPlugin' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.CustomPluginArn') as custom_plugin_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::KafkaConnect::CustomPlugin' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'CustomPluginArn') as custom_plugin_arn, + json_extract_path_text(Properties, 'ContentType') as content_type, + json_extract_path_text(Properties, 'FileDescription') as file_description, + json_extract_path_text(Properties, 'Location') as location, + json_extract_path_text(Properties, 'Revision') as revision, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::KafkaConnect::CustomPlugin' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'CustomPluginArn') as custom_plugin_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::KafkaConnect::CustomPlugin' + AND region = 'us-east-1' worker_configurations: name: worker_configurations id: aws.kafkaconnect.worker_configurations @@ -1286,7 +1274,7 @@ components: x-cfn-type-name: AWS::KafkaConnect::WorkerConfiguration x-identifiers: - WorkerConfigurationArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1303,9 +1291,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1315,41 +1303,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/worker_configurations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/worker_configurations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.WorkerConfigurationArn') as worker_configuration_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::KafkaConnect::WorkerConfiguration' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'WorkerConfigurationArn') as worker_configuration_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::KafkaConnect::WorkerConfiguration' - AND region = 'us-east-1' - worker_configuration: - name: worker_configuration - id: aws.kafkaconnect.worker_configuration - x-cfn-schema-name: WorkerConfiguration - x-cfn-type-name: AWS::KafkaConnect::WorkerConfiguration - x-identifiers: - - WorkerConfigurationArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1360,12 +1316,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/worker_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/worker_configurations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/worker_configuration/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/worker_configurations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1380,20 +1340,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'WorkerConfigurationArn') as worker_configuration_arn, - json_extract_path_text(Properties, 'PropertiesFileContent') as properties_file_content, - json_extract_path_text(Properties, 'Revision') as revision, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::KafkaConnect::WorkerConfiguration' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.WorkerConfigurationArn') as worker_configuration_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::KafkaConnect::WorkerConfiguration' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'WorkerConfigurationArn') as worker_configuration_arn, + json_extract_path_text(Properties, 'PropertiesFileContent') as properties_file_content, + json_extract_path_text(Properties, 'Revision') as revision, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::KafkaConnect::WorkerConfiguration' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'WorkerConfigurationArn') as worker_configuration_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::KafkaConnect::WorkerConfiguration' + AND region = 'us-east-1' connectors: name: connectors id: aws.kafkaconnect.connectors @@ -1401,7 +1377,7 @@ components: x-cfn-type-name: AWS::KafkaConnect::Connector x-identifiers: - ConnectorArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1418,9 +1394,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1430,41 +1406,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/connectors/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/connectors/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ConnectorArn') as connector_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::KafkaConnect::Connector' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ConnectorArn') as connector_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::KafkaConnect::Connector' - AND region = 'us-east-1' - connector: - name: connector - id: aws.kafkaconnect.connector - x-cfn-schema-name: Connector - x-cfn-type-name: AWS::KafkaConnect::Connector - x-identifiers: - - ConnectorArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1475,12 +1419,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/connectors/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/connectors/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/connector/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/connectors/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1503,28 +1451,44 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Capacity') as capacity, - json_extract_path_text(Properties, 'ConnectorArn') as connector_arn, - json_extract_path_text(Properties, 'ConnectorConfiguration') as connector_configuration, - json_extract_path_text(Properties, 'ConnectorDescription') as connector_description, - json_extract_path_text(Properties, 'ConnectorName') as connector_name, - json_extract_path_text(Properties, 'KafkaCluster') as kafka_cluster, - json_extract_path_text(Properties, 'KafkaClusterClientAuthentication') as kafka_cluster_client_authentication, - json_extract_path_text(Properties, 'KafkaClusterEncryptionInTransit') as kafka_cluster_encryption_in_transit, - json_extract_path_text(Properties, 'KafkaConnectVersion') as kafka_connect_version, - json_extract_path_text(Properties, 'LogDelivery') as log_delivery, - json_extract_path_text(Properties, 'Plugins') as plugins, - json_extract_path_text(Properties, 'ServiceExecutionRoleArn') as service_execution_role_arn, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'WorkerConfiguration') as worker_configuration - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::KafkaConnect::Connector' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ConnectorArn') as connector_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::KafkaConnect::Connector' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Capacity') as capacity, + json_extract_path_text(Properties, 'ConnectorArn') as connector_arn, + json_extract_path_text(Properties, 'ConnectorConfiguration') as connector_configuration, + json_extract_path_text(Properties, 'ConnectorDescription') as connector_description, + json_extract_path_text(Properties, 'ConnectorName') as connector_name, + json_extract_path_text(Properties, 'KafkaCluster') as kafka_cluster, + json_extract_path_text(Properties, 'KafkaClusterClientAuthentication') as kafka_cluster_client_authentication, + json_extract_path_text(Properties, 'KafkaClusterEncryptionInTransit') as kafka_cluster_encryption_in_transit, + json_extract_path_text(Properties, 'KafkaConnectVersion') as kafka_connect_version, + json_extract_path_text(Properties, 'LogDelivery') as log_delivery, + json_extract_path_text(Properties, 'Plugins') as plugins, + json_extract_path_text(Properties, 'ServiceExecutionRoleArn') as service_execution_role_arn, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'WorkerConfiguration') as worker_configuration + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::KafkaConnect::Connector' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ConnectorArn') as connector_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::KafkaConnect::Connector' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/kendra.yaml b/providers/src/aws/v00.00.00000/services/kendra.yaml index 217a136b..43aae834 100644 --- a/providers/src/aws/v00.00.00000/services/kendra.yaml +++ b/providers/src/aws/v00.00.00000/services/kendra.yaml @@ -2151,7 +2151,7 @@ components: x-identifiers: - Id - IndexId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2168,9 +2168,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2180,44 +2180,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/data_sources/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/data_sources/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id, - JSON_EXTRACT(Properties, '$.IndexId') as index_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Kendra::DataSource' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'IndexId') as index_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Kendra::DataSource' - AND region = 'us-east-1' - data_source: - name: data_source - id: aws.kendra.data_source - x-cfn-schema-name: DataSource - x-cfn-type-name: AWS::Kendra::DataSource - x-identifiers: - - Id - - IndexId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2228,12 +2193,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/data_sources/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/data_sources/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/data_source/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/data_sources/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2254,26 +2223,44 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'IndexId') as index_id, - json_extract_path_text(Properties, 'Type') as type, - json_extract_path_text(Properties, 'DataSourceConfiguration') as data_source_configuration, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Schedule') as schedule, - json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'CustomDocumentEnrichmentConfiguration') as custom_document_enrichment_configuration, - json_extract_path_text(Properties, 'LanguageCode') as language_code - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Kendra::DataSource' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.IndexId') as index_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Kendra::DataSource' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'IndexId') as index_id, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'DataSourceConfiguration') as data_source_configuration, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Schedule') as schedule, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'CustomDocumentEnrichmentConfiguration') as custom_document_enrichment_configuration, + json_extract_path_text(Properties, 'LanguageCode') as language_code + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Kendra::DataSource' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'IndexId') as index_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Kendra::DataSource' + AND region = 'us-east-1' faqs: name: faqs id: aws.kendra.faqs @@ -2282,7 +2269,7 @@ components: x-identifiers: - Id - IndexId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2299,9 +2286,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2311,44 +2298,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/faqs/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/faqs/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id, - JSON_EXTRACT(Properties, '$.IndexId') as index_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Kendra::Faq' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'IndexId') as index_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Kendra::Faq' - AND region = 'us-east-1' - faq: - name: faq - id: aws.kendra.faq - x-cfn-schema-name: Faq - x-cfn-type-name: AWS::Kendra::Faq - x-identifiers: - - Id - - IndexId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2359,12 +2311,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/faqs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/faqs/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/faq/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/faqs/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2383,24 +2339,42 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'IndexId') as index_id, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'FileFormat') as file_format, - json_extract_path_text(Properties, 'S3Path') as s3_path, - json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'LanguageCode') as language_code - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Kendra::Faq' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.IndexId') as index_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Kendra::Faq' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'IndexId') as index_id, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'FileFormat') as file_format, + json_extract_path_text(Properties, 'S3Path') as s3_path, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'LanguageCode') as language_code + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Kendra::Faq' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'IndexId') as index_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Kendra::Faq' + AND region = 'us-east-1' indices: name: indices id: aws.kendra.indices @@ -2408,7 +2382,7 @@ components: x-cfn-type-name: AWS::Kendra::Index x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2425,9 +2399,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2437,41 +2411,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/indices/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/indices/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Kendra::Index' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Kendra::Index' - AND region = 'us-east-1' - index: - name: index - id: aws.kendra.index - x-cfn-schema-name: Index - x-cfn-type-name: AWS::Kendra::Index - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2482,12 +2424,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/indices/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/indices/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/index/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/indices/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2508,26 +2454,42 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'ServerSideEncryptionConfiguration') as server_side_encryption_configuration, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'Edition') as edition, - json_extract_path_text(Properties, 'DocumentMetadataConfigurations') as document_metadata_configurations, - json_extract_path_text(Properties, 'CapacityUnits') as capacity_units, - json_extract_path_text(Properties, 'UserContextPolicy') as user_context_policy, - json_extract_path_text(Properties, 'UserTokenConfigurations') as user_token_configurations - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Kendra::Index' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Kendra::Index' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'ServerSideEncryptionConfiguration') as server_side_encryption_configuration, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'Edition') as edition, + json_extract_path_text(Properties, 'DocumentMetadataConfigurations') as document_metadata_configurations, + json_extract_path_text(Properties, 'CapacityUnits') as capacity_units, + json_extract_path_text(Properties, 'UserContextPolicy') as user_context_policy, + json_extract_path_text(Properties, 'UserTokenConfigurations') as user_token_configurations + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Kendra::Index' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Kendra::Index' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/kendraranking.yaml b/providers/src/aws/v00.00.00000/services/kendraranking.yaml index b70c0c40..b2b541e7 100644 --- a/providers/src/aws/v00.00.00000/services/kendraranking.yaml +++ b/providers/src/aws/v00.00.00000/services/kendraranking.yaml @@ -541,7 +541,7 @@ components: x-cfn-type-name: AWS::KendraRanking::ExecutionPlan x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -558,9 +558,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -570,41 +570,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/execution_plans/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/execution_plans/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::KendraRanking::ExecutionPlan' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::KendraRanking::ExecutionPlan' - AND region = 'us-east-1' - execution_plan: - name: execution_plan - id: aws.kendraranking.execution_plan - x-cfn-schema-name: ExecutionPlan - x-cfn-type-name: AWS::KendraRanking::ExecutionPlan - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -615,12 +583,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/execution_plans/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/execution_plans/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/execution_plan/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/execution_plans/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -635,20 +607,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'CapacityUnits') as capacity_units - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::KendraRanking::ExecutionPlan' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::KendraRanking::ExecutionPlan' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'CapacityUnits') as capacity_units + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::KendraRanking::ExecutionPlan' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::KendraRanking::ExecutionPlan' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/kinesis.yaml b/providers/src/aws/v00.00.00000/services/kinesis.yaml index 3cf78d45..e5eeaae4 100644 --- a/providers/src/aws/v00.00.00000/services/kinesis.yaml +++ b/providers/src/aws/v00.00.00000/services/kinesis.yaml @@ -588,7 +588,7 @@ components: x-cfn-type-name: AWS::Kinesis::Stream x-identifiers: - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -605,9 +605,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -617,41 +617,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/streams/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/streams/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Kinesis::Stream' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Kinesis::Stream' - AND region = 'us-east-1' - kinesis_stream: - name: kinesis_stream - id: aws.kinesis.kinesis_stream - x-cfn-schema-name: Stream - x-cfn-type-name: AWS::Kinesis::Stream - x-identifiers: - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -662,12 +630,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/streams/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/streams/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/kinesis_stream/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/streams/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -683,21 +655,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'StreamModeDetails') as stream_mode_details, - json_extract_path_text(Properties, 'StreamEncryption') as stream_encryption, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'RetentionPeriodHours') as retention_period_hours, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'ShardCount') as shard_count - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Kinesis::Stream' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Kinesis::Stream' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'StreamModeDetails') as stream_mode_details, + json_extract_path_text(Properties, 'StreamEncryption') as stream_encryption, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'RetentionPeriodHours') as retention_period_hours, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'ShardCount') as shard_count + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Kinesis::Stream' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Kinesis::Stream' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/kinesisanalyticsv2.yaml b/providers/src/aws/v00.00.00000/services/kinesisanalyticsv2.yaml index ba1318da..fca1de30 100644 --- a/providers/src/aws/v00.00.00000/services/kinesisanalyticsv2.yaml +++ b/providers/src/aws/v00.00.00000/services/kinesisanalyticsv2.yaml @@ -1208,7 +1208,7 @@ components: x-cfn-type-name: AWS::KinesisAnalyticsV2::Application x-identifiers: - ApplicationName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1225,9 +1225,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1237,41 +1237,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/applications/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/applications/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ApplicationName') as application_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::KinesisAnalyticsV2::Application' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ApplicationName') as application_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::KinesisAnalyticsV2::Application' - AND region = 'us-east-1' - application: - name: application - id: aws.kinesisanalyticsv2.application - x-cfn-schema-name: Application - x-cfn-type-name: AWS::KinesisAnalyticsV2::Application - x-identifiers: - - ApplicationName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1282,12 +1250,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/applications/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/applications/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/application/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/applications/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1305,23 +1277,39 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ApplicationConfiguration') as application_configuration, - json_extract_path_text(Properties, 'ApplicationDescription') as application_description, - json_extract_path_text(Properties, 'ApplicationMode') as application_mode, - json_extract_path_text(Properties, 'ApplicationName') as application_name, - json_extract_path_text(Properties, 'RuntimeEnvironment') as runtime_environment, - json_extract_path_text(Properties, 'ServiceExecutionRole') as service_execution_role, - json_extract_path_text(Properties, 'RunConfiguration') as run_configuration, - json_extract_path_text(Properties, 'ApplicationMaintenanceConfiguration') as application_maintenance_configuration, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::KinesisAnalyticsV2::Application' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ApplicationName') as application_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::KinesisAnalyticsV2::Application' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ApplicationConfiguration') as application_configuration, + json_extract_path_text(Properties, 'ApplicationDescription') as application_description, + json_extract_path_text(Properties, 'ApplicationMode') as application_mode, + json_extract_path_text(Properties, 'ApplicationName') as application_name, + json_extract_path_text(Properties, 'RuntimeEnvironment') as runtime_environment, + json_extract_path_text(Properties, 'ServiceExecutionRole') as service_execution_role, + json_extract_path_text(Properties, 'RunConfiguration') as run_configuration, + json_extract_path_text(Properties, 'ApplicationMaintenanceConfiguration') as application_maintenance_configuration, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::KinesisAnalyticsV2::Application' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ApplicationName') as application_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::KinesisAnalyticsV2::Application' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/kinesisfirehose.yaml b/providers/src/aws/v00.00.00000/services/kinesisfirehose.yaml index c759dfb3..798417a0 100644 --- a/providers/src/aws/v00.00.00000/services/kinesisfirehose.yaml +++ b/providers/src/aws/v00.00.00000/services/kinesisfirehose.yaml @@ -1497,7 +1497,7 @@ components: x-cfn-type-name: AWS::KinesisFirehose::DeliveryStream x-identifiers: - DeliveryStreamName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1514,9 +1514,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1526,41 +1526,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/delivery_streams/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/delivery_streams/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.DeliveryStreamName') as delivery_stream_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::KinesisFirehose::DeliveryStream' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'DeliveryStreamName') as delivery_stream_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::KinesisFirehose::DeliveryStream' - AND region = 'us-east-1' - delivery_stream: - name: delivery_stream - id: aws.kinesisfirehose.delivery_stream - x-cfn-schema-name: DeliveryStream - x-cfn-type-name: AWS::KinesisFirehose::DeliveryStream - x-identifiers: - - DeliveryStreamName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1571,12 +1539,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/delivery_streams/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/delivery_streams/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/delivery_stream/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/delivery_streams/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1601,30 +1573,46 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'DeliveryStreamEncryptionConfigurationInput') as delivery_stream_encryption_configuration_input, - json_extract_path_text(Properties, 'DeliveryStreamName') as delivery_stream_name, - json_extract_path_text(Properties, 'DeliveryStreamType') as delivery_stream_type, - json_extract_path_text(Properties, 'ElasticsearchDestinationConfiguration') as elasticsearch_destination_configuration, - json_extract_path_text(Properties, 'AmazonopensearchserviceDestinationConfiguration') as amazonopensearchservice_destination_configuration, - json_extract_path_text(Properties, 'AmazonOpenSearchServerlessDestinationConfiguration') as amazon_open_search_serverless_destination_configuration, - json_extract_path_text(Properties, 'ExtendedS3DestinationConfiguration') as extended_s3_destination_configuration, - json_extract_path_text(Properties, 'KinesisStreamSourceConfiguration') as kinesis_stream_source_configuration, - json_extract_path_text(Properties, 'MSKSourceConfiguration') as msk_source_configuration, - json_extract_path_text(Properties, 'RedshiftDestinationConfiguration') as redshift_destination_configuration, - json_extract_path_text(Properties, 'S3DestinationConfiguration') as s3_destination_configuration, - json_extract_path_text(Properties, 'SplunkDestinationConfiguration') as splunk_destination_configuration, - json_extract_path_text(Properties, 'HttpEndpointDestinationConfiguration') as http_endpoint_destination_configuration, - json_extract_path_text(Properties, 'SnowflakeDestinationConfiguration') as snowflake_destination_configuration, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::KinesisFirehose::DeliveryStream' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.DeliveryStreamName') as delivery_stream_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::KinesisFirehose::DeliveryStream' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'DeliveryStreamEncryptionConfigurationInput') as delivery_stream_encryption_configuration_input, + json_extract_path_text(Properties, 'DeliveryStreamName') as delivery_stream_name, + json_extract_path_text(Properties, 'DeliveryStreamType') as delivery_stream_type, + json_extract_path_text(Properties, 'ElasticsearchDestinationConfiguration') as elasticsearch_destination_configuration, + json_extract_path_text(Properties, 'AmazonopensearchserviceDestinationConfiguration') as amazonopensearchservice_destination_configuration, + json_extract_path_text(Properties, 'AmazonOpenSearchServerlessDestinationConfiguration') as amazon_open_search_serverless_destination_configuration, + json_extract_path_text(Properties, 'ExtendedS3DestinationConfiguration') as extended_s3_destination_configuration, + json_extract_path_text(Properties, 'KinesisStreamSourceConfiguration') as kinesis_stream_source_configuration, + json_extract_path_text(Properties, 'MSKSourceConfiguration') as msk_source_configuration, + json_extract_path_text(Properties, 'RedshiftDestinationConfiguration') as redshift_destination_configuration, + json_extract_path_text(Properties, 'S3DestinationConfiguration') as s3_destination_configuration, + json_extract_path_text(Properties, 'SplunkDestinationConfiguration') as splunk_destination_configuration, + json_extract_path_text(Properties, 'HttpEndpointDestinationConfiguration') as http_endpoint_destination_configuration, + json_extract_path_text(Properties, 'SnowflakeDestinationConfiguration') as snowflake_destination_configuration, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::KinesisFirehose::DeliveryStream' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DeliveryStreamName') as delivery_stream_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::KinesisFirehose::DeliveryStream' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/kinesisvideo.yaml b/providers/src/aws/v00.00.00000/services/kinesisvideo.yaml index ee23d758..28a28cb4 100644 --- a/providers/src/aws/v00.00.00000/services/kinesisvideo.yaml +++ b/providers/src/aws/v00.00.00000/services/kinesisvideo.yaml @@ -643,7 +643,7 @@ components: x-cfn-type-name: AWS::KinesisVideo::SignalingChannel x-identifiers: - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -660,9 +660,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -672,23 +672,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/signaling_channels/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/signaling_channels/methods/delete_resource' - signaling_channel: - name: signaling_channel - id: aws.kinesisvideo.signaling_channel - x-cfn-schema-name: SignalingChannel - x-cfn-type-name: AWS::KinesisVideo::SignalingChannel - x-identifiers: - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -699,12 +685,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/signaling_channels/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/signaling_channels/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/signaling_channel/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/signaling_channels/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -718,7 +708,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -738,7 +728,7 @@ components: x-cfn-type-name: AWS::KinesisVideo::Stream x-identifiers: - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -755,9 +745,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -767,23 +757,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/streams/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/streams/methods/delete_resource' - kinesisvideo_stream: - name: kinesisvideo_stream - id: aws.kinesisvideo.kinesisvideo_stream - x-cfn-schema-name: Stream - x-cfn-type-name: AWS::KinesisVideo::Stream - x-identifiers: - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -794,12 +770,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/streams/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/streams/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/kinesisvideo_stream/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/streams/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -815,7 +795,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, diff --git a/providers/src/aws/v00.00.00000/services/kms.yaml b/providers/src/aws/v00.00.00000/services/kms.yaml index 93ccd7e2..c59ebf7c 100644 --- a/providers/src/aws/v00.00.00000/services/kms.yaml +++ b/providers/src/aws/v00.00.00000/services/kms.yaml @@ -419,7 +419,15 @@ components: The ``AWS::KMS::Alias`` resource specifies a display name for a [KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys). You can use an alias to identify a KMS key in the KMS console, in the [DescribeKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html) operation, and in [cryptographic operations](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations), such as [Decrypt](https://docs.aws.amazon.com/kms/latest/APIReference/API_Decrypt.html) and [GenerateDataKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_GenerateDataKey.html). Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see [ABAC for](https://docs.aws.amazon.com/kms/latest/developerguide/abac.html) in the *Developer Guide*. - Using an alias to refer to a KMS key can help you simplify key management. For example, an alias in your code can be associated with different KMS keys i + Using an alias to refer to a KMS key can help you simplify key management. For example, an alias in your code can be associated with different KMS keys in different AWS-Regions. For more information, see [Using aliases](https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html) in the *Developer Guide*. + When specifying an alias, observe the following rules. + + Each alias is associated with one KMS key, but multiple aliases can be associated with the same KMS key. + + The alias and its associated KMS key must be in the same AWS-account and Region. + + The alias name must be unique in the AWS-account and Region. However, you can create aliases with the same name in different AWS-Regions. For example, you can have an ``alias/projectKey`` in multiple Regions, each of which is associated with a KMS key in its Region. + + Each alias name must begin with ``alias/`` followed by a name, such as ``alias/exampleKey``. The alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). Alias names cannot begin with ``alias/aws/``. That alias name prefix is reserved for [](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk). + + *Regions* + KMS CloudFormation resources are available in all AWS-Regions in which KMS and CFN are supported. x-type-name: AWS::KMS::Alias x-stackql-primary-identifier: - AliasName @@ -477,7 +485,7 @@ components: EnableKeyRotation: description: |- Enables automatic rotation of the key material for the specified KMS key. By default, automatic key rotation is not enabled. - KMS supports automatic rotation only for symmetric encryption KMS keys (``KeySpec`` = ``SYMMETRIC_DEFAULT``). For asymmetric KMS keys, HMAC KMS keys, and KMS keys with Origin ``EXTERNAL``, omit the ``EnableKeyRotation`` property or set it to ``false``. + KMS supports automatic rotation only for symmetric encryption KMS keys (``KeySpec`` = ``SYMMETRIC_DEFAULT``). For asymmetric KMS keys, HMAC KMS keys, and KMS keys with Origin ``EXTERNAL``, omit the ``EnableKeyRotation`` property or set it to ``false``. To enable automatic key rotation of the key material for a multi-Region KMS key, set ``EnableKeyRotation`` to ``true`` on the primary key (created by using ``AWS::KMS::Key``). KMS copies the rotation status to all replica keys. For details, see [Rotating multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-rotate) in the *Developer Guide*. When you enable automatic rotation, KMS automatically creates new key material for the KMS key one year after the enable date and every year thereafter. KMS retains all key material until you delete the KMS key. For detailed information about automatic key rotation, see [Rotating KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html) in the *Developer Guide*. type: boolean @@ -494,8 +502,8 @@ components: + Printable characters in the Basic Latin and Latin-1 Supplement character set + The tab (``\u0009``), line feed (``\u000A``), and carriage return (``\u000D``) special characters - *Minimum*: ``1`` - *Maximum*: ``32768`` + *Minimum*: ``1`` + *Maximum*: ``32768`` type: object default: |- { @@ -534,7 +542,7 @@ components: The source of the key material for the KMS key. You cannot change the origin after you create the KMS key. The default is ``AWS_KMS``, which means that KMS creates the key material. To [create a KMS key with no key material](https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys-create-cmk.html) (for imported key material), set this value to ``EXTERNAL``. For more information about importing key material into KMS, see [Importing Key Material](https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) in the *Developer Guide*. You can ignore ``ENABLED`` when Origin is ``EXTERNAL``. When a KMS key with Origin ``EXTERNAL`` is created, the key state is ``PENDING_IMPORT`` and ``ENABLED`` is ``false``. After you import the key material, ``ENABLED`` updated to ``true``. The KMS key can then be used for Cryptographic Operations. - CFN doesn't support creating an ``Origin`` parameter of the ``AWS_CLOUDHSM`` or ``EXTERNAL_KEY_STORE`` values. + CFN doesn't support creating an ``Origin`` parameter of the ``AWS_CLOUDHSM`` or ``EXTERNAL_KEY_STORE`` values. type: string default: AWS_KMS enum: @@ -546,7 +554,7 @@ components: the *Developer Guide*. The ``KeySpec`` property determines the type of key material in the KMS key and the algorithms that the KMS key supports. To further restrict the algorithms that can be used with the KMS key, use a condition key in its key policy or IAM policy. For more information, see [condition keys](https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms) in the *Developer Guide*. If you change the value of the ``KeySpec`` property on an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing an immutable property value. - [services that are integrated with](https://docs.aws.amazon.com/kms/features/#AWS_Service_Integration) use symmetric encryption KMS keys to protect your data. These services do not support encryption with asymmetric KMS keys. For help determining whether a KMS key is asymmetric, see [Identifying asymmetric KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/find-symm-asymm.html) in the *Developer Guide*. + [services that are integrated with](https://docs.aws.amazon.com/kms/features/#AWS_Service_Integration) use symmetric encryption KMS keys to protect your data. These services do not support encryption with asymmetric KMS keys. For help determining whether a KMS key is asymmetric, see [Identifying asymmetric KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/find-symm-asymm.html) in the *Developer Guide*. KMS supports the following key specs for KMS keys: + Symmetric encryption key (default) + ``SYMMETRIC_DEFAULT`` (AES-256-GCM) @@ -570,8 +578,8 @@ components: + Other asymmetric elliptic curve key pairs + ``ECC_SECG_P256K1`` (secp256k1), commonly used for cryptocurrencies. - + SM2 key pairs (China Regions only) - + ``SM2`` + + SM2 key pairs (China Regions only) + + ``SM2`` type: string default: SYMMETRIC_DEFAULT enum: @@ -594,7 +602,7 @@ components: For a list of AWS-Regions in which multi-Region keys are supported, see [Multi-Region keys in](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the **. If you change the value of the ``MultiRegion`` property on an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing an immutable property value. For a multi-Region key, set to this property to ``true``. For a single-Region key, omit this property or set it to ``false``. The default value is ``false``. - *Multi-Region keys* are an KMS feature that lets you create multiple interoperable KMS keys in different AWS-Regions. Because these KMS keys have the same key ID, key material, and other metadata, you can use them to encrypt data in one AWS-Region and decrypt it in a different AWS-Region without making a cross-Region call or exposing the plaintext data. For more information, see [Multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the *Developer Guide*. + *Multi-Region keys* are an KMS feature that lets you create multiple interoperable KMS keys in different AWS-Regions. Because these KMS keys have the same key ID, key material, and other metadata, you can use them to encrypt data in one AWS-Region and decrypt it in a different AWS-Region without making a cross-Region call or exposing the plaintext data. For more information, see [Multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the *Developer Guide*. You can create a symmetric encryption, HMAC, or asymmetric multi-Region KMS key, and you can create a multi-Region key with imported key material. However, you cannot create a multi-Region key in a custom key store. To create a replica of this primary key in a different AWS-Region , create an [AWS::KMS::ReplicaKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-replicakey.html) resource in a CloudFormation stack in the replica Region. Specify the key ARN of this primary key. type: boolean @@ -603,7 +611,7 @@ components: description: |- Specifies the number of days in the waiting period before KMS deletes a KMS key that has been removed from a CloudFormation stack. Enter a value between 7 and 30 days. The default value is 30 days. When you remove a KMS key from a CloudFormation stack, KMS schedules the KMS key for deletion and starts the mandatory waiting period. The ``PendingWindowInDays`` property determines the length of waiting period. During the waiting period, the key state of KMS key is ``Pending Deletion`` or ``Pending Replica Deletion``, which prevents the KMS key from being used in cryptographic operations. When the waiting period expires, KMS permanently deletes the KMS key. - KMS will not delete a [multi-Region primary key](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) that has replica keys. If you remove a multi-Region primary key from a CloudFormation stack, its key state changes to ``PendingReplicaDeletion`` so it cannot be replicated or used in cryptographic operations. This state can persist indefinitely. When the last of its replica keys is deleted, the key state of the primary key changes to ``PendingDeletion`` and the waiting period specified by ``PendingWindowInDays`` begins. When this waiting period expires, KMS deletes the primary key. For details, see [Deleting multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html) in the *Developer Guide*. + KMS will not delete a [multi-Region primary key](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) that has replica keys. If you remove a multi-Region primary key from a CloudFormation stack, its key state changes to ``PendingReplicaDeletion`` so it cannot be replicated or used in cryptographic operations. This state can persist indefinitely. When the last of its replica keys is deleted, the key state of the primary key changes to ``PendingDeletion`` and the waiting period specified by ``PendingWindowInDays`` begins. When this waiting period expires, KMS deletes the primary key. For details, see [Deleting multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html) in the *Developer Guide*. You cannot use a CloudFormation template to cancel deletion of the KMS key after you remove it from the stack, regardless of the waiting period. If you specify a KMS key in your template, even one with the same name, CloudFormation creates a new KMS key. To cancel deletion of a KMS key, use the KMS console or the [CancelKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_CancelKeyDeletion.html) operation. For information about the ``Pending Deletion`` and ``Pending Replica Deletion`` key states, see [Key state: Effect on your KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the *Developer Guide*. For more information about deleting KMS keys, see the [ScheduleKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html) operation in the *API Reference* and [Deleting KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html) in the *Developer Guide*. type: integer @@ -634,7 +642,11 @@ components: type: boolean default: false RotationPeriodInDays: - description: '' + description: |- + Specifies a custom period of time between each rotation date. If no value is specified, the default value is 365 days. + The rotation period defines the number of days after you enable automatic key rotation that KMS will rotate your key material, and the number of days between each automatic rotation thereafter. + You can use the [kms:RotationPeriodInDays](https://docs.aws.amazon.com/kms/latest/developerguide/conditions-kms.html#conditions-kms-rotation-period-in-days) condition key to further constrain the values that principals can specify in the ``RotationPeriodInDays`` parameter. + For more information about rotating KMS keys and automatic rotation, see [Rotating keys](https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html) in the *Developer Guide*. type: integer minimum: 90 maximum: 2560 @@ -644,14 +656,14 @@ components: The ``AWS::KMS::Key`` resource specifies an [KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys) in KMSlong. You can use this resource to create symmetric encryption KMS keys, asymmetric KMS keys for encryption or signing, and symmetric HMAC KMS keys. You can use ``AWS::KMS::Key`` to create [multi-Region primary keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html#mrk-primary-key) of all supported types. To replicate a multi-Region key, use the ``AWS::KMS::ReplicaKey`` resource. If you change the value of the ``KeySpec``, ``KeyUsage``, ``Origin``, or ``MultiRegion`` properties of an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing any of its immutable property values. - KMS replaced the term *customer master key (CMK)* with ** and *KMS key*. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term. + KMS replaced the term *customer master key (CMK)* with ** and *KMS key*. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term. You can use symmetric encryption KMS keys to encrypt and decrypt small amounts of data, but they are more commonly used to generate data keys and data key pairs. You can also use a symmetric encryption KMS key to encrypt data stored in AWS services that are [integrated with](https://docs.aws.amazon.com//kms/features/#AWS_Service_Integration). For more information, see [Symmetric encryption KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#symmetric-cmks) in the *Developer Guide*. You can use asymmetric KMS keys to encrypt and decrypt data or sign messages and verify signatures. To create an asymmetric key, you must specify an asymmetric ``KeySpec`` value and a ``KeyUsage`` value. For details, see [Asymmetric keys in](https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) in the *Developer Guide*. You can use HMAC KMS keys (which are also symmetric keys) to generate and verify hash-based message authentication codes. To create an HMAC key, you must specify an HMAC ``KeySpec`` value and a ``KeyUsage`` value of ``GENERATE_VERIFY_MAC``. For details, see [HMAC keys in](https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html) in the *Developer Guide*. You can also create symmetric encryption, asymmetric, and HMAC multi-Region primary keys. To create a multi-Region primary key, set the ``MultiRegion`` property to ``true``. For information about multi-Region keys, see [Multi-Region keys in](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the *Developer Guide*. You cannot use the ``AWS::KMS::Key`` resource to specify a KMS key with [imported key material](https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) or a KMS key in a [custom key store](https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html). - *Regions* - KMS CloudFormation resources are available in all Regions in which KMS and CFN are supported. You can use the ``AWS::KMS::Key`` resource to create and manage all KMS key types that are supported in a Region. + *Regions* + KMS CloudFormation resources are available in all Regions in which KMS and CFN are supported. You can use the ``AWS::KMS::Key`` resource to create and manage all KMS key types that are supported in a Region. x-type-name: AWS::KMS::Key x-stackql-primary-identifier: - KeyId @@ -667,6 +679,7 @@ components: tagOnCreate: true tagUpdatable: true cloudFormationSystemTags: false + tagProperty: /properties/Tags x-required-permissions: create: - kms:CreateKey @@ -847,7 +860,7 @@ components: EnableKeyRotation: description: |- Enables automatic rotation of the key material for the specified KMS key. By default, automatic key rotation is not enabled. - KMS supports automatic rotation only for symmetric encryption KMS keys (``KeySpec`` = ``SYMMETRIC_DEFAULT``). For asymmetric KMS keys, HMAC KMS keys, and KMS keys with Origin ``EXTERNAL``, omit the ``EnableKeyRotation`` property or set it to ``false``. + KMS supports automatic rotation only for symmetric encryption KMS keys (``KeySpec`` = ``SYMMETRIC_DEFAULT``). For asymmetric KMS keys, HMAC KMS keys, and KMS keys with Origin ``EXTERNAL``, omit the ``EnableKeyRotation`` property or set it to ``false``. To enable automatic key rotation of the key material for a multi-Region KMS key, set ``EnableKeyRotation`` to ``true`` on the primary key (created by using ``AWS::KMS::Key``). KMS copies the rotation status to all replica keys. For details, see [Rotating multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-rotate) in the *Developer Guide*. When you enable automatic rotation, KMS automatically creates new key material for the KMS key one year after the enable date and every year thereafter. KMS retains all key material until you delete the KMS key. For detailed information about automatic key rotation, see [Rotating KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html) in the *Developer Guide*. type: boolean @@ -864,8 +877,8 @@ components: + Printable characters in the Basic Latin and Latin-1 Supplement character set + The tab (``\u0009``), line feed (``\u000A``), and carriage return (``\u000D``) special characters - *Minimum*: ``1`` - *Maximum*: ``32768`` + *Minimum*: ``1`` + *Maximum*: ``32768`` type: object default: |- { @@ -904,7 +917,7 @@ components: The source of the key material for the KMS key. You cannot change the origin after you create the KMS key. The default is ``AWS_KMS``, which means that KMS creates the key material. To [create a KMS key with no key material](https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys-create-cmk.html) (for imported key material), set this value to ``EXTERNAL``. For more information about importing key material into KMS, see [Importing Key Material](https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) in the *Developer Guide*. You can ignore ``ENABLED`` when Origin is ``EXTERNAL``. When a KMS key with Origin ``EXTERNAL`` is created, the key state is ``PENDING_IMPORT`` and ``ENABLED`` is ``false``. After you import the key material, ``ENABLED`` updated to ``true``. The KMS key can then be used for Cryptographic Operations. - CFN doesn't support creating an ``Origin`` parameter of the ``AWS_CLOUDHSM`` or ``EXTERNAL_KEY_STORE`` values. + CFN doesn't support creating an ``Origin`` parameter of the ``AWS_CLOUDHSM`` or ``EXTERNAL_KEY_STORE`` values. type: string default: AWS_KMS enum: @@ -916,7 +929,7 @@ components: in the *Developer Guide*. The ``KeySpec`` property determines the type of key material in the KMS key and the algorithms that the KMS key supports. To further restrict the algorithms that can be used with the KMS key, use a condition key in its key policy or IAM policy. For more information, see [condition keys](https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms) in the *Developer Guide*. If you change the value of the ``KeySpec`` property on an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing an immutable property value. - [services that are integrated with](https://docs.aws.amazon.com/kms/features/#AWS_Service_Integration) use symmetric encryption KMS keys to protect your data. These services do not support encryption with asymmetric KMS keys. For help determining whether a KMS key is asymmetric, see [Identifying asymmetric KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/find-symm-asymm.html) in the *Developer Guide*. + [services that are integrated with](https://docs.aws.amazon.com/kms/features/#AWS_Service_Integration) use symmetric encryption KMS keys to protect your data. These services do not support encryption with asymmetric KMS keys. For help determining whether a KMS key is asymmetric, see [Identifying asymmetric KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/find-symm-asymm.html) in the *Developer Guide*. KMS supports the following key specs for KMS keys: + Symmetric encryption key (default) + ``SYMMETRIC_DEFAULT`` (AES-256-GCM) @@ -940,8 +953,8 @@ components: + Other asymmetric elliptic curve key pairs + ``ECC_SECG_P256K1`` (secp256k1), commonly used for cryptocurrencies. - + SM2 key pairs (China Regions only) - + ``SM2`` + + SM2 key pairs (China Regions only) + + ``SM2`` type: string default: SYMMETRIC_DEFAULT enum: @@ -964,7 +977,7 @@ components: For a list of AWS-Regions in which multi-Region keys are supported, see [Multi-Region keys in](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the **. If you change the value of the ``MultiRegion`` property on an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing an immutable property value. For a multi-Region key, set to this property to ``true``. For a single-Region key, omit this property or set it to ``false``. The default value is ``false``. - *Multi-Region keys* are an KMS feature that lets you create multiple interoperable KMS keys in different AWS-Regions. Because these KMS keys have the same key ID, key material, and other metadata, you can use them to encrypt data in one AWS-Region and decrypt it in a different AWS-Region without making a cross-Region call or exposing the plaintext data. For more information, see [Multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the *Developer Guide*. + *Multi-Region keys* are an KMS feature that lets you create multiple interoperable KMS keys in different AWS-Regions. Because these KMS keys have the same key ID, key material, and other metadata, you can use them to encrypt data in one AWS-Region and decrypt it in a different AWS-Region without making a cross-Region call or exposing the plaintext data. For more information, see [Multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the *Developer Guide*. You can create a symmetric encryption, HMAC, or asymmetric multi-Region KMS key, and you can create a multi-Region key with imported key material. However, you cannot create a multi-Region key in a custom key store. To create a replica of this primary key in a different AWS-Region , create an [AWS::KMS::ReplicaKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-replicakey.html) resource in a CloudFormation stack in the replica Region. Specify the key ARN of this primary key. type: boolean @@ -973,7 +986,7 @@ components: description: |- Specifies the number of days in the waiting period before KMS deletes a KMS key that has been removed from a CloudFormation stack. Enter a value between 7 and 30 days. The default value is 30 days. When you remove a KMS key from a CloudFormation stack, KMS schedules the KMS key for deletion and starts the mandatory waiting period. The ``PendingWindowInDays`` property determines the length of waiting period. During the waiting period, the key state of KMS key is ``Pending Deletion`` or ``Pending Replica Deletion``, which prevents the KMS key from being used in cryptographic operations. When the waiting period expires, KMS permanently deletes the KMS key. - KMS will not delete a [multi-Region primary key](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) that has replica keys. If you remove a multi-Region primary key from a CloudFormation stack, its key state changes to ``PendingReplicaDeletion`` so it cannot be replicated or used in cryptographic operations. This state can persist indefinitely. When the last of its replica keys is deleted, the key state of the primary key changes to ``PendingDeletion`` and the waiting period specified by ``PendingWindowInDays`` begins. When this waiting period expires, KMS deletes the primary key. For details, see [Deleting multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html) in the *Developer Guide*. + KMS will not delete a [multi-Region primary key](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) that has replica keys. If you remove a multi-Region primary key from a CloudFormation stack, its key state changes to ``PendingReplicaDeletion`` so it cannot be replicated or used in cryptographic operations. This state can persist indefinitely. When the last of its replica keys is deleted, the key state of the primary key changes to ``PendingDeletion`` and the waiting period specified by ``PendingWindowInDays`` begins. When this waiting period expires, KMS deletes the primary key. For details, see [Deleting multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html) in the *Developer Guide*. You cannot use a CloudFormation template to cancel deletion of the KMS key after you remove it from the stack, regardless of the waiting period. If you specify a KMS key in your template, even one with the same name, CloudFormation creates a new KMS key. To cancel deletion of a KMS key, use the KMS console or the [CancelKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_CancelKeyDeletion.html) operation. For information about the ``Pending Deletion`` and ``Pending Replica Deletion`` key states, see [Key state: Effect on your KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the *Developer Guide*. For more information about deleting KMS keys, see the [ScheduleKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html) operation in the *API Reference* and [Deleting KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html) in the *Developer Guide*. type: integer @@ -1004,7 +1017,11 @@ components: type: boolean default: false RotationPeriodInDays: - description: '' + description: |- + Specifies a custom period of time between each rotation date. If no value is specified, the default value is 365 days. + The rotation period defines the number of days after you enable automatic key rotation that KMS will rotate your key material, and the number of days between each automatic rotation thereafter. + You can use the [kms:RotationPeriodInDays](https://docs.aws.amazon.com/kms/latest/developerguide/conditions-kms.html#conditions-kms-rotation-period-in-days) condition key to further constrain the values that principals can specify in the ``RotationPeriodInDays`` parameter. + For more information about rotating KMS keys and automatic rotation, see [Rotating keys](https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html) in the *Developer Guide*. type: integer minimum: 90 maximum: 2560 @@ -1077,7 +1094,7 @@ components: x-cfn-type-name: AWS::KMS::Alias x-identifiers: - AliasName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1094,9 +1111,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1106,41 +1123,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/aliases/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/aliases/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AliasName') as alias_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::KMS::Alias' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AliasName') as alias_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::KMS::Alias' - AND region = 'us-east-1' - alias: - name: alias - id: aws.kms.alias - x-cfn-schema-name: Alias - x-cfn-type-name: AWS::KMS::Alias - x-identifiers: - - AliasName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1151,12 +1136,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/aliases/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/aliases/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/alias/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/aliases/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1167,16 +1156,32 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'TargetKeyId') as target_key_id, - json_extract_path_text(Properties, 'AliasName') as alias_name - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::KMS::Alias' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.AliasName') as alias_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::KMS::Alias' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'TargetKeyId') as target_key_id, + json_extract_path_text(Properties, 'AliasName') as alias_name + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::KMS::Alias' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AliasName') as alias_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::KMS::Alias' + AND region = 'us-east-1' keys: name: keys id: aws.kms.keys @@ -1184,7 +1189,7 @@ components: x-cfn-type-name: AWS::KMS::Key x-identifiers: - KeyId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1201,9 +1206,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1213,41 +1218,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/keys/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/keys/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.KeyId') as key_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::KMS::Key' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'KeyId') as key_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::KMS::Key' - AND region = 'us-east-1' - key: - name: key - id: aws.kms.key - x-cfn-schema-name: Key - x-cfn-type-name: AWS::KMS::Key - x-identifiers: - - KeyId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1258,12 +1231,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/keys/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/keys/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/key/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/keys/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1286,28 +1263,44 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Enabled') as enabled, - json_extract_path_text(Properties, 'EnableKeyRotation') as enable_key_rotation, - json_extract_path_text(Properties, 'KeyPolicy') as key_policy, - json_extract_path_text(Properties, 'KeyUsage') as key_usage, - json_extract_path_text(Properties, 'Origin') as origin, - json_extract_path_text(Properties, 'KeySpec') as key_spec, - json_extract_path_text(Properties, 'MultiRegion') as multi_region, - json_extract_path_text(Properties, 'PendingWindowInDays') as pending_window_in_days, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'KeyId') as key_id, - json_extract_path_text(Properties, 'BypassPolicyLockoutSafetyCheck') as bypass_policy_lockout_safety_check, - json_extract_path_text(Properties, 'RotationPeriodInDays') as rotation_period_in_days - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::KMS::Key' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.KeyId') as key_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::KMS::Key' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Enabled') as enabled, + json_extract_path_text(Properties, 'EnableKeyRotation') as enable_key_rotation, + json_extract_path_text(Properties, 'KeyPolicy') as key_policy, + json_extract_path_text(Properties, 'KeyUsage') as key_usage, + json_extract_path_text(Properties, 'Origin') as origin, + json_extract_path_text(Properties, 'KeySpec') as key_spec, + json_extract_path_text(Properties, 'MultiRegion') as multi_region, + json_extract_path_text(Properties, 'PendingWindowInDays') as pending_window_in_days, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'KeyId') as key_id, + json_extract_path_text(Properties, 'BypassPolicyLockoutSafetyCheck') as bypass_policy_lockout_safety_check, + json_extract_path_text(Properties, 'RotationPeriodInDays') as rotation_period_in_days + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::KMS::Key' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'KeyId') as key_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::KMS::Key' + AND region = 'us-east-1' replica_keys: name: replica_keys id: aws.kms.replica_keys @@ -1315,7 +1308,7 @@ components: x-cfn-type-name: AWS::KMS::ReplicaKey x-identifiers: - KeyId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1332,9 +1325,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1344,41 +1337,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/replica_keys/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/replica_keys/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.KeyId') as key_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::KMS::ReplicaKey' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'KeyId') as key_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::KMS::ReplicaKey' - AND region = 'us-east-1' - replica_key: - name: replica_key - id: aws.kms.replica_key - x-cfn-schema-name: ReplicaKey - x-cfn-type-name: AWS::KMS::ReplicaKey - x-identifiers: - - KeyId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1389,12 +1350,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/replica_keys/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/replica_keys/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/replica_key/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/replica_keys/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1411,22 +1376,38 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'PendingWindowInDays') as pending_window_in_days, - json_extract_path_text(Properties, 'KeyPolicy') as key_policy, - json_extract_path_text(Properties, 'PrimaryKeyArn') as primary_key_arn, - json_extract_path_text(Properties, 'Enabled') as enabled, - json_extract_path_text(Properties, 'KeyId') as key_id, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::KMS::ReplicaKey' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.KeyId') as key_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::KMS::ReplicaKey' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'PendingWindowInDays') as pending_window_in_days, + json_extract_path_text(Properties, 'KeyPolicy') as key_policy, + json_extract_path_text(Properties, 'PrimaryKeyArn') as primary_key_arn, + json_extract_path_text(Properties, 'Enabled') as enabled, + json_extract_path_text(Properties, 'KeyId') as key_id, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::KMS::ReplicaKey' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'KeyId') as key_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::KMS::ReplicaKey' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/lakeformation.yaml b/providers/src/aws/v00.00.00000/services/lakeformation.yaml index eb57ac4b..42154467 100644 --- a/providers/src/aws/v00.00.00000/services/lakeformation.yaml +++ b/providers/src/aws/v00.00.00000/services/lakeformation.yaml @@ -1039,7 +1039,7 @@ components: - DatabaseName - TableName - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1073,48 +1073,11 @@ components: - $ref: '#/components/x-stackQL-resources/data_cells_filters/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/data_cells_filters/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.TableCatalogId') as table_catalog_id, - JSON_EXTRACT(Properties, '$.DatabaseName') as database_name, - JSON_EXTRACT(Properties, '$.TableName') as table_name, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::LakeFormation::DataCellsFilter' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'TableCatalogId') as table_catalog_id, - json_extract_path_text(Properties, 'DatabaseName') as database_name, - json_extract_path_text(Properties, 'TableName') as table_name, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::LakeFormation::DataCellsFilter' - AND region = 'us-east-1' - data_cells_filter: - name: data_cells_filter - id: aws.lakeformation.data_cells_filter - x-cfn-schema-name: DataCellsFilter - x-cfn-type-name: AWS::LakeFormation::DataCellsFilter - x-identifiers: - - TableCatalogId - - DatabaseName - - TableName - - Name - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1130,21 +1093,43 @@ components: AND data__Identifier = '|||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'TableCatalogId') as table_catalog_id, - json_extract_path_text(Properties, 'DatabaseName') as database_name, - json_extract_path_text(Properties, 'TableName') as table_name, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'RowFilter') as row_filter, - json_extract_path_text(Properties, 'ColumnNames') as column_names, - json_extract_path_text(Properties, 'ColumnWildcard') as column_wildcard - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::LakeFormation::DataCellsFilter' - AND data__Identifier = '|||' + JSON_EXTRACT(Properties, '$.TableCatalogId') as table_catalog_id, + JSON_EXTRACT(Properties, '$.DatabaseName') as database_name, + JSON_EXTRACT(Properties, '$.TableName') as table_name, + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::LakeFormation::DataCellsFilter' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'TableCatalogId') as table_catalog_id, + json_extract_path_text(Properties, 'DatabaseName') as database_name, + json_extract_path_text(Properties, 'TableName') as table_name, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'RowFilter') as row_filter, + json_extract_path_text(Properties, 'ColumnNames') as column_names, + json_extract_path_text(Properties, 'ColumnWildcard') as column_wildcard + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::LakeFormation::DataCellsFilter' + AND data__Identifier = '|||' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'TableCatalogId') as table_catalog_id, + json_extract_path_text(Properties, 'DatabaseName') as database_name, + json_extract_path_text(Properties, 'TableName') as table_name, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::LakeFormation::DataCellsFilter' + AND region = 'us-east-1' principal_permissions: name: principal_permissions id: aws.lakeformation.principal_permissions @@ -1153,14 +1138,45 @@ components: x-identifiers: - PrincipalIdentifier - ResourceIdentifier - x-type: get - methods: {} + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__PrincipalPermissions&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::LakeFormation::PrincipalPermissions" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::LakeFormation::PrincipalPermissions" + } + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/principal_permissions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/principal_permissions/methods/delete_resource' update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1176,7 +1192,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1198,7 +1214,7 @@ components: x-cfn-type-name: AWS::LakeFormation::Tag x-identifiers: - TagKey - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1215,9 +1231,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1227,41 +1243,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/tags/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/tags/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.TagKey') as tag_key - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::LakeFormation::Tag' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'TagKey') as tag_key - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::LakeFormation::Tag' - AND region = 'us-east-1' - tag: - name: tag - id: aws.lakeformation.tag - x-cfn-schema-name: Tag - x-cfn-type-name: AWS::LakeFormation::Tag - x-identifiers: - - TagKey - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1272,12 +1256,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/tags/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/tags/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/tag/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/tags/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1289,17 +1277,33 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'CatalogId') as catalog_id, - json_extract_path_text(Properties, 'TagKey') as tag_key, - json_extract_path_text(Properties, 'TagValues') as tag_values - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::LakeFormation::Tag' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.TagKey') as tag_key + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::LakeFormation::Tag' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'CatalogId') as catalog_id, + json_extract_path_text(Properties, 'TagKey') as tag_key, + json_extract_path_text(Properties, 'TagValues') as tag_values + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::LakeFormation::Tag' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'TagKey') as tag_key + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::LakeFormation::Tag' + AND region = 'us-east-1' tag_associations: name: tag_associations id: aws.lakeformation.tag_associations @@ -1308,7 +1312,7 @@ components: x-identifiers: - ResourceIdentifier - TagsIdentifier - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1342,22 +1346,11 @@ components: - $ref: '#/components/x-stackQL-resources/tag_associations/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/tag_associations/methods/delete_resource' - tag_association: - name: tag_association - id: aws.lakeformation.tag_association - x-cfn-schema-name: TagAssociation - x-cfn-type-name: AWS::LakeFormation::TagAssociation - x-identifiers: - - ResourceIdentifier - - TagsIdentifier - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1370,7 +1363,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, diff --git a/providers/src/aws/v00.00.00000/services/lambda.yaml b/providers/src/aws/v00.00.00000/services/lambda.yaml index acc412cf..2d33598b 100644 --- a/providers/src/aws/v00.00.00000/services/lambda.yaml +++ b/providers/src/aws/v00.00.00000/services/lambda.yaml @@ -462,27 +462,27 @@ components: list: - lambda:ListCodeSigningConfigs DestinationConfig: - type: object - additionalProperties: false description: A configuration object that specifies the destination of an event after Lambda processes it. + additionalProperties: false + type: object properties: OnFailure: description: The destination configuration for failed invocations. $ref: '#/components/schemas/OnFailure' OnFailure: - type: object description: A destination for events that failed processing. additionalProperties: false + type: object properties: Destination: + minLength: 12 + pattern: arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?(-iso([a-z])?)?-[a-z]+-\d{1})?:(\d{12})?:(.*) description: |- The Amazon Resource Name (ARN) of the destination resource. To retain records of [asynchronous invocations](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-async-destinations), you can configure an Amazon SNS topic, Amazon SQS queue, Lambda function, or Amazon EventBridge event bus as the destination. To retain records of failed invocations from [Kinesis and DynamoDB event sources](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventsourcemapping.html#event-source-mapping-destinations), you can configure an Amazon SNS topic or Amazon SQS queue as the destination. To retain records of failed invocations from [self-managed Kafka](https://docs.aws.amazon.com/lambda/latest/dg/with-kafka.html#services-smaa-onfailure-destination) or [Amazon MSK](https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#services-msk-onfailure-destination), you can configure an Amazon SNS topic, Amazon SQS queue, or Amazon S3 bucket as the destination. type: string - pattern: arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?(-iso)?(-isob)?-[a-z]+-\d{1})?:(\d{12})?:(.*) - minLength: 12 maxLength: 1024 OnSuccess: description: The destination configuration for successful invocations. @@ -551,34 +551,31 @@ components: - lambda:DeleteFunctionEventInvokeConfig list: - lambda:ListFunctionEventInvokeConfigs - FilterCriteria: - type: object - description: An object that contains the filters for an event source. + ScalingConfig: + description: (Amazon SQS only) The scaling configuration for the event source. To remove the configuration, pass an empty value. additionalProperties: false - properties: - Filters: - description: A list of filters. - type: array - uniqueItems: true - items: - $ref: '#/components/schemas/Filter' - minItems: 1 - maxItems: 20 - Filter: type: object - description: A structure within a ``FilterCriteria`` object that defines an event filtering pattern. + properties: + MaximumConcurrency: + description: Limits the number of concurrent instances that the SQS event source can invoke. + $ref: '#/components/schemas/MaximumConcurrency' + SelfManagedEventSource: + description: The self-managed Apache Kafka cluster for your event source. additionalProperties: false + type: object properties: - Pattern: - type: string - description: A filter pattern. For more information on the syntax of a filter pattern, see [Filter rule syntax](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html#filtering-syntax). - pattern: .* - minLength: 0 - maxLength: 4096 + Endpoints: + description: 'The list of bootstrap servers for your Kafka brokers in the following format: ``"KafkaBootstrapServers": ["abc.xyz.com:xxxx","abc2.xyz.com:xxxx"]``.' + $ref: '#/components/schemas/Endpoints' + MaximumConcurrency: + description: The maximum number of concurrent functions that an event source can invoke. + maximum: 1000 + type: integer + minimum: 2 SourceAccessConfiguration: - type: object - additionalProperties: false description: An array of the authentication protocol, VPC components, or virtual host to secure and define your event source. + additionalProperties: false + type: object properties: Type: description: |- @@ -592,6 +589,7 @@ components: + ``VIRTUAL_HOST`` –- (RabbitMQ) The name of the virtual host in your RabbitMQ broker. Lambda uses this RabbitMQ host as the event source. This property cannot be specified in an UpdateEventSourceMapping API call. + ``CLIENT_CERTIFICATE_TLS_AUTH`` – (Amazon MSK, self-managed Apache Kafka) The Secrets Manager ARN of your secret key containing the certificate chain (X.509 PEM), private key (PKCS#8 PEM), and private key password (optional) used for mutual TLS authentication of your MSK/Apache Kafka brokers. + ``SERVER_ROOT_CA_CERTIFICATE`` – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key containing the root CA certificate (X.509 PEM) used for TLS encryption of your Apache Kafka brokers. + type: string enum: - BASIC_AUTH - VPC_SUBNET @@ -601,103 +599,157 @@ components: - VIRTUAL_HOST - CLIENT_CERTIFICATE_TLS_AUTH - SERVER_ROOT_CA_CERTIFICATE - type: string URI: + minLength: 1 + pattern: '[a-zA-Z0-9-\/*:_+=.@-]*' description: 'The value for your chosen configuration in ``Type``. For example: ``"URI": "arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName"``.' type: string - pattern: '[a-zA-Z0-9-\/*:_+=.@-]*' - minLength: 1 maxLength: 200 - SelfManagedEventSource: - type: object + FilterCriteria: + description: An object that contains the filters for an event source. additionalProperties: false - description: The self-managed Apache Kafka cluster for your event source. + type: object properties: - Endpoints: - description: 'The list of bootstrap servers for your Kafka brokers in the following format: ``"KafkaBootstrapServers": ["abc.xyz.com:xxxx","abc2.xyz.com:xxxx"]``.' - $ref: '#/components/schemas/Endpoints' - Endpoints: + Filters: + minItems: 1 + maxItems: 20 + uniqueItems: true + description: A list of filters. + type: array + items: + $ref: '#/components/schemas/Filter' + SelfManagedKafkaEventSourceConfig: + description: Specific configuration settings for a self-managed Apache Kafka event source. + additionalProperties: false type: object + properties: + ConsumerGroupId: + description: The identifier for the Kafka consumer group to join. The consumer group ID must be unique among all your Kafka event sources. After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value. For more information, see [Customizable consumer group ID](https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#services-msk-consumer-group-id). + $ref: '#/components/schemas/ConsumerGroupId' + DocumentDBEventSourceConfig: + description: Specific configuration settings for a DocumentDB event source. additionalProperties: false + type: object + properties: + FullDocument: + description: Determines what DocumentDB sends to your event stream during document update operations. If set to UpdateLookup, DocumentDB sends a delta describing the changes, along with a copy of the entire document. Otherwise, DocumentDB sends only a partial document that contains the changes. + type: string + enum: + - UpdateLookup + - Default + CollectionName: + minLength: 1 + description: The name of the collection to consume within the database. If you do not specify a collection, Lambda consumes all collections. + type: string + maxLength: 57 + DatabaseName: + minLength: 1 + description: The name of the database to consume within the DocumentDB cluster. + type: string + maxLength: 63 + Endpoints: description: 'The list of bootstrap servers for your Kafka brokers in the following format: ``"KafkaBootstrapServers": ["abc.xyz.com:xxxx","abc2.xyz.com:xxxx"]``.' + additionalProperties: false + type: object properties: KafkaBootstrapServers: - type: array - description: 'The list of bootstrap servers for your Kafka brokers in the following format: ``"KafkaBootstrapServers": ["abc.xyz.com:xxxx","abc2.xyz.com:xxxx"]``.' + minItems: 1 + maxItems: 10 uniqueItems: true + description: 'The list of bootstrap servers for your Kafka brokers in the following format: ``"KafkaBootstrapServers": ["abc.xyz.com:xxxx","abc2.xyz.com:xxxx"]``.' + type: array items: - type: string - description: The URL of a Kafka server. - pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9]):[0-9]{1,5} minLength: 1 + pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9]):[0-9]{1,5} + description: The URL of a Kafka server. + type: string maxLength: 300 - minItems: 1 - maxItems: 10 ConsumerGroupId: + minLength: 1 + pattern: '[a-zA-Z0-9-\/*:_+=.@-]*' description: The identifier for the Kafka Consumer Group to join. type: string - pattern: '[a-zA-Z0-9-\/*:_+=.@-]*' - minLength: 1 maxLength: 200 + Filter: + description: A structure within a ``FilterCriteria`` object that defines an event filtering pattern. + additionalProperties: false + type: object + properties: + Pattern: + minLength: 0 + pattern: .* + description: A filter pattern. For more information on the syntax of a filter pattern, see [Filter rule syntax](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html#filtering-syntax). + type: string + maxLength: 4096 AmazonManagedKafkaEventSourceConfig: description: Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source. - type: object additionalProperties: false - properties: - ConsumerGroupId: - description: The identifier for the Kafka consumer group to join. The consumer group ID must be unique among all your Kafka event sources. After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value. For more information, see [Customizable consumer group ID](https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#services-msk-consumer-group-id). - $ref: '#/components/schemas/ConsumerGroupId' - SelfManagedKafkaEventSourceConfig: - description: Specific configuration settings for a self-managed Apache Kafka event source. type: object - additionalProperties: false properties: ConsumerGroupId: description: The identifier for the Kafka consumer group to join. The consumer group ID must be unique among all your Kafka event sources. After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value. For more information, see [Customizable consumer group ID](https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#services-msk-consumer-group-id). $ref: '#/components/schemas/ConsumerGroupId' - MaximumConcurrency: - description: The maximum number of concurrent functions that an event source can invoke. - type: integer - minimum: 2 - maximum: 1000 - ScalingConfig: - description: (Amazon SQS only) The scaling configuration for the event source. To remove the configuration, pass an empty value. - type: object - additionalProperties: false - properties: - MaximumConcurrency: - description: Limits the number of concurrent instances that the SQS event source can invoke. - $ref: '#/components/schemas/MaximumConcurrency' - DocumentDBEventSourceConfig: - description: Specific configuration settings for a DocumentDB event source. + EventSourceMapping: type: object - additionalProperties: false properties: - DatabaseName: - description: The name of the database to consume within the DocumentDB cluster. - type: string - minLength: 1 - maxLength: 63 - CollectionName: - description: The name of the collection to consume within the database. If you do not specify a collection, Lambda consumes all collections. + StartingPosition: + minLength: 6 + pattern: (LATEST|TRIM_HORIZON|AT_TIMESTAMP)+ + description: |- + The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB. + + *LATEST* - Read only new records. + + *TRIM_HORIZON* - Process all available records. + + *AT_TIMESTAMP* - Specify a time from which to start reading records. type: string + maxLength: 12 + SelfManagedEventSource: + description: The self-managed Apache Kafka cluster for your event source. + $ref: '#/components/schemas/SelfManagedEventSource' + ParallelizationFactor: + description: (Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard. The default value is 1. + maximum: 10 + type: integer + minimum: 1 + FilterCriteria: + description: An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see [Lambda event filtering](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html). + $ref: '#/components/schemas/FilterCriteria' + FunctionName: minLength: 1 - maxLength: 57 - FullDocument: - description: Determines what DocumentDB sends to your event stream during document update operations. If set to UpdateLookup, DocumentDB sends a delta describing the changes, along with a copy of the entire document. Otherwise, DocumentDB sends only a partial document that contains the changes. - type: string - enum: - - UpdateLookup - - Default - EventSourceMapping: - type: object - properties: - Id: - description: '' + pattern: (arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}(-gov)?(-iso([a-z])?)?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))? + description: |- + The name or ARN of the Lambda function. + **Name formats** + + *Function name* – ``MyFunction``. + + *Function ARN* – ``arn:aws:lambda:us-west-2:123456789012:function:MyFunction``. + + *Version or Alias ARN* – ``arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD``. + + *Partial ARN* – ``123456789012:function:MyFunction``. + + The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length. type: string - pattern: '[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}' - minLength: 36 - maxLength: 36 + maxLength: 140 + DestinationConfig: + description: (Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka event sources only) A configuration object that specifies the destination of an event after Lambda processes it. + $ref: '#/components/schemas/DestinationConfig' + AmazonManagedKafkaEventSourceConfig: + description: Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source. + $ref: '#/components/schemas/AmazonManagedKafkaEventSourceConfig' + SourceAccessConfigurations: + minItems: 1 + maxItems: 22 + uniqueItems: true + description: An array of the authentication protocol, VPC components, or virtual host to secure and define your event source. + type: array + items: + $ref: '#/components/schemas/SourceAccessConfiguration' + MaximumBatchingWindowInSeconds: + description: |- + The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function. + *Default (, , event sources)*: 0 + *Default (, Kafka, , event sources)*: 500 ms + *Related setting:* For SQS event sources, when you set ``BatchSize`` to a value greater than 10, you must set ``MaximumBatchingWindowInSeconds`` to at least 1. + maximum: 300 + type: integer + minimum: 0 BatchSize: description: |- The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB). @@ -708,21 +760,36 @@ components: + *Self-managed Apache Kafka* – Default 100. Max 10,000. + *Amazon MQ (ActiveMQ and RabbitMQ)* – Default 100. Max 10,000. + *DocumentDB* – Default 100. Max 10,000. + maximum: 10000 type: integer minimum: 1 + MaximumRetryAttempts: + description: (Kinesis and DynamoDB Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, Lambda retries failed records until the record expires in the event source. maximum: 10000 - BisectBatchOnFunctionError: - description: (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry. The default value is false. - type: boolean - DestinationConfig: - description: (Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka event sources only) A configuration object that specifies the destination of an event after Lambda processes it. - $ref: '#/components/schemas/DestinationConfig' + type: integer + minimum: -1 + Topics: + minItems: 1 + maxItems: 1 + uniqueItems: true + description: The name of the Kafka topic. + type: array + items: + minLength: 1 + pattern: ^[^.]([a-zA-Z0-9\-_.]+) + type: string + maxLength: 249 + ScalingConfig: + description: (Amazon SQS only) The scaling configuration for the event source. For more information, see [Configuring maximum concurrency for Amazon SQS event sources](https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-max-concurrency). + $ref: '#/components/schemas/ScalingConfig' Enabled: description: |- When true, the event source mapping is active. When false, Lambda pauses polling and invocation. Default: True type: boolean EventSourceArn: + minLength: 12 + pattern: arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?(-iso([a-z])?)?-[a-z]+-\d{1})?:(\d{12})?:(.*) description: |- The Amazon Resource Name (ARN) of the event source. + *Amazon Kinesis* – The ARN of the data stream or a stream consumer. @@ -732,140 +799,73 @@ components: + *Amazon MQ* – The ARN of the broker. + *Amazon DocumentDB* – The ARN of the DocumentDB change stream. type: string - pattern: arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?(-iso)?(-isob)?-[a-z]+-\d{1})?:(\d{12})?:(.*) - minLength: 12 maxLength: 1024 - FilterCriteria: - description: An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see [Lambda event filtering](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html). - $ref: '#/components/schemas/FilterCriteria' - FunctionName: - description: |- - The name or ARN of the Lambda function. - **Name formats** - + *Function name* – ``MyFunction``. - + *Function ARN* – ``arn:aws:lambda:us-west-2:123456789012:function:MyFunction``. - + *Version or Alias ARN* – ``arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD``. - + *Partial ARN* – ``123456789012:function:MyFunction``. - - The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length. - type: string - pattern: (arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}(-gov)?(-iso)?(-isob)?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))? - minLength: 1 - maxLength: 140 - MaximumBatchingWindowInSeconds: - description: |- - The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function. - *Default (, , event sources)*: 0 - *Default (, Kafka, , event sources)*: 500 ms - *Related setting:* For SQS event sources, when you set ``BatchSize`` to a value greater than 10, you must set ``MaximumBatchingWindowInSeconds`` to at least 1. + SelfManagedKafkaEventSourceConfig: + description: Specific configuration settings for a self-managed Apache Kafka event source. + $ref: '#/components/schemas/SelfManagedKafkaEventSourceConfig' + DocumentDBEventSourceConfig: + description: Specific configuration settings for a DocumentDB event source. + $ref: '#/components/schemas/DocumentDBEventSourceConfig' + TumblingWindowInSeconds: + description: (Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources. A value of 0 seconds indicates no tumbling window. + maximum: 900 type: integer minimum: 0 - maximum: 300 + BisectBatchOnFunctionError: + description: (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry. The default value is false. + type: boolean MaximumRecordAgeInSeconds: description: |- (Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, Lambda never discards old records. The minimum valid value for maximum record age is 60s. Although values less than 60 and greater than -1 fall within the parameter's absolute range, they are not allowed - type: integer - minimum: -1 maximum: 604800 - MaximumRetryAttempts: - description: (Kinesis and DynamoDB Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, Lambda retries failed records until the record expires in the event source. type: integer minimum: -1 - maximum: 10000 - ParallelizationFactor: - description: (Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard. The default value is 1. - type: integer - minimum: 1 - maximum: 10 - StartingPosition: - description: |- - The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB. - + *LATEST* - Read only new records. - + *TRIM_HORIZON* - Process all available records. - + *AT_TIMESTAMP* - Specify a time from which to start reading records. - type: string - pattern: (LATEST|TRIM_HORIZON|AT_TIMESTAMP)+ - minLength: 6 - maxLength: 12 StartingPositionTimestamp: description: With ``StartingPosition`` set to ``AT_TIMESTAMP``, the time from which to start reading, in Unix time seconds. ``StartingPositionTimestamp`` cannot be in the future. type: number - Topics: - description: The name of the Kafka topic. - type: array - uniqueItems: true - items: - type: string - pattern: ^[^.]([a-zA-Z0-9\-_.]+) - minLength: 1 - maxLength: 249 + Queues: minItems: 1 maxItems: 1 - Queues: + uniqueItems: true description: (Amazon MQ) The name of the Amazon MQ broker destination queue to consume. type: array - uniqueItems: true items: - type: string - pattern: '[\s\S]*' minLength: 1 + pattern: '[\s\S]*' + type: string maxLength: 1000 - minItems: 1 - maxItems: 1 - SourceAccessConfigurations: - description: An array of the authentication protocol, VPC components, or virtual host to secure and define your event source. - type: array - uniqueItems: true - items: - $ref: '#/components/schemas/SourceAccessConfiguration' - minItems: 1 - maxItems: 22 - TumblingWindowInSeconds: - description: (Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources. A value of 0 seconds indicates no tumbling window. - type: integer - minimum: 0 - maximum: 900 + Id: + minLength: 36 + pattern: '[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}' + description: '' + type: string + maxLength: 36 FunctionResponseTypes: + uniqueItems: true + minLength: 0 description: |- (Streams and SQS) A list of current response type enums applied to the event source mapping. Valid Values: ``ReportBatchItemFailures`` type: array - uniqueItems: true items: type: string enum: - ReportBatchItemFailures - minLength: 0 maxLength: 1 - SelfManagedEventSource: - description: The self-managed Apache Kafka cluster for your event source. - $ref: '#/components/schemas/SelfManagedEventSource' - AmazonManagedKafkaEventSourceConfig: - description: Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source. - $ref: '#/components/schemas/AmazonManagedKafkaEventSourceConfig' - SelfManagedKafkaEventSourceConfig: - description: Specific configuration settings for a self-managed Apache Kafka event source. - $ref: '#/components/schemas/SelfManagedKafkaEventSourceConfig' - ScalingConfig: - description: (Amazon SQS only) The scaling configuration for the event source. For more information, see [Configuring maximum concurrency for Amazon SQS event sources](https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-max-concurrency). - $ref: '#/components/schemas/ScalingConfig' - DocumentDBEventSourceConfig: - description: Specific configuration settings for a DocumentDB event source. - $ref: '#/components/schemas/DocumentDBEventSourceConfig' required: - FunctionName x-stackql-resource-name: event_source_mapping description: |- The ``AWS::Lambda::EventSourceMapping`` resource creates a mapping between an event source and an LAMlong function. LAM reads items from the event source and triggers the function. For details about each event source type, see the following topics. In particular, each of the topics describes the required and optional parameters for the specific event source. - + [Configuring a Dynamo DB stream as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-dynamodb-eventsourcemapping) - + [Configuring a Kinesis stream as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#services-kinesis-eventsourcemapping) - + [Configuring an SQS queue as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-eventsource) - + [Configuring an MQ broker as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-mq.html#services-mq-eventsourcemapping) - + [Configuring MSK as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html) - + [Configuring Self-Managed Apache Kafka as an event source](https://docs.aws.amazon.com/lambda/latest/dg/kafka-smaa.html) - + [Configuring Amazon DocumentDB as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-documentdb.html) + + [Configuring a Dynamo DB stream as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-dynamodb-eventsourcemapping) + + [Configuring a Kinesis stream as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#services-kinesis-eventsourcemapping) + + [Configuring an SQS queue as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-eventsource) + + [Configuring an MQ broker as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-mq.html#services-mq-eventsourcemapping) + + [Configuring MSK as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html) + + [Configuring Self-Managed Apache Kafka as an event source](https://docs.aws.amazon.com/lambda/latest/dg/kafka-smaa.html) + + [Configuring Amazon DocumentDB as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-documentdb.html) x-type-name: AWS::Lambda::EventSourceMapping x-stackql-primary-identifier: - Id @@ -886,19 +886,19 @@ components: tagUpdatable: false cloudFormationSystemTags: false x-required-permissions: + read: + - lambda:GetEventSourceMapping create: - lambda:CreateEventSourceMapping - lambda:GetEventSourceMapping - delete: - - lambda:DeleteEventSourceMapping - - lambda:GetEventSourceMapping - list: - - lambda:ListEventSourceMappings - read: - - lambda:GetEventSourceMapping update: - lambda:UpdateEventSourceMapping - lambda:GetEventSourceMapping + list: + - lambda:ListEventSourceMappings + delete: + - lambda:DeleteEventSourceMapping + - lambda:GetEventSourceMapping ImageConfig: description: Configuration values that override the container image Dockerfile settings. For more information, see [Container image settings](https://docs.aws.amazon.com/lambda/latest/dg/images-create.html#images-parms). additionalProperties: false @@ -949,16 +949,6 @@ components: description: A list of VPC security group IDs. type: array items: - anyOf: - - relationshipRef: - typeName: AWS::EC2::SecurityGroup - propertyPath: /properties/GroupId - - relationshipRef: - typeName: AWS::EC2::SecurityGroup - propertyPath: /properties/Id - - relationshipRef: - typeName: AWS::EC2::VPC - propertyPath: /properties/DefaultSecurityGroup type: string SubnetIds: maxItems: 16 @@ -966,9 +956,6 @@ components: description: A list of VPC subnet IDs. type: array items: - relationshipRef: - typeName: AWS::EC2::Subnet - propertyPath: /properties/SubnetId type: string DeadLetterConfig: description: The [dead-letter queue](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#dlq) for failed asynchronous invocations. @@ -978,13 +965,6 @@ components: TargetArn: pattern: ^(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()$ description: The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic. - anyOf: - - relationshipRef: - typeName: AWS::SQS::Queue - propertyPath: /properties/Arn - - relationshipRef: - typeName: AWS::SNS::Topic - propertyPath: /properties/TopicArn type: string RuntimeManagementConfig: description: Sets the runtime management configuration for a function's version. For more information, see [Runtime updates](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html). @@ -1054,9 +1034,6 @@ components: type: string maxLength: 1024 S3Bucket: - x-relationshipRef: - typeName: AWS::S3::Bucket - propertyPath: /properties/BucketName minLength: 3 pattern: ^[0-9A-Za-z\.\-_]*(?' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'AllowedPublishers') as allowed_publishers, - json_extract_path_text(Properties, 'CodeSigningPolicies') as code_signing_policies, - json_extract_path_text(Properties, 'CodeSigningConfigId') as code_signing_config_id, - json_extract_path_text(Properties, 'CodeSigningConfigArn') as code_signing_config_arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Lambda::CodeSigningConfig' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.CodeSigningConfigArn') as code_signing_config_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::CodeSigningConfig' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'AllowedPublishers') as allowed_publishers, + json_extract_path_text(Properties, 'CodeSigningPolicies') as code_signing_policies, + json_extract_path_text(Properties, 'CodeSigningConfigId') as code_signing_config_id, + json_extract_path_text(Properties, 'CodeSigningConfigArn') as code_signing_config_arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Lambda::CodeSigningConfig' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'CodeSigningConfigArn') as code_signing_config_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::CodeSigningConfig' + AND region = 'us-east-1' event_invoke_configs: name: event_invoke_configs id: aws.lambda.event_invoke_configs @@ -2638,14 +2619,26 @@ components: x-identifiers: - FunctionName - Qualifier - x-type: list + x-type: cloud_control methods: create_resource: config: requestBodyTranslate: algorithm: naive_DesiredState operation: - $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__EventInvokeConfig&__detailTransformed=true/post' + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__EventInvokeConfig&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Lambda::EventInvokeConfig" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2672,55 +2665,12 @@ components: - $ref: '#/components/x-stackQL-resources/event_invoke_configs/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/event_invoke_configs/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.FunctionName') as function_name, - JSON_EXTRACT(Properties, '$.Qualifier') as qualifier - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::EventInvokeConfig' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'FunctionName') as function_name, - json_extract_path_text(Properties, 'Qualifier') as qualifier - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::EventInvokeConfig' - AND region = 'us-east-1' - event_invoke_config: - name: event_invoke_config - id: aws.lambda.event_invoke_config - x-cfn-schema-name: EventInvokeConfig - x-cfn-type-name: AWS::Lambda::EventInvokeConfig - x-identifiers: - - FunctionName - - Qualifier - x-type: get - methods: - update_resource: - operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' - request: - mediaType: application/x-amz-json-1.0 - base: |- - { - "TypeName": "AWS::Lambda::EventInvokeConfig" - } - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: update: - - $ref: '#/components/x-stackQL-resources/event_invoke_config/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/event_invoke_configs/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2734,19 +2684,37 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'DestinationConfig') as destination_config, - json_extract_path_text(Properties, 'FunctionName') as function_name, - json_extract_path_text(Properties, 'MaximumEventAgeInSeconds') as maximum_event_age_in_seconds, - json_extract_path_text(Properties, 'MaximumRetryAttempts') as maximum_retry_attempts, - json_extract_path_text(Properties, 'Qualifier') as qualifier - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Lambda::EventInvokeConfig' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.FunctionName') as function_name, + JSON_EXTRACT(Properties, '$.Qualifier') as qualifier + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::EventInvokeConfig' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DestinationConfig') as destination_config, + json_extract_path_text(Properties, 'FunctionName') as function_name, + json_extract_path_text(Properties, 'MaximumEventAgeInSeconds') as maximum_event_age_in_seconds, + json_extract_path_text(Properties, 'MaximumRetryAttempts') as maximum_retry_attempts, + json_extract_path_text(Properties, 'Qualifier') as qualifier + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Lambda::EventInvokeConfig' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'FunctionName') as function_name, + json_extract_path_text(Properties, 'Qualifier') as qualifier + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::EventInvokeConfig' + AND region = 'us-east-1' event_source_mappings: name: event_source_mappings id: aws.lambda.event_source_mappings @@ -2754,7 +2722,7 @@ components: x-cfn-type-name: AWS::Lambda::EventSourceMapping x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2771,9 +2739,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2783,41 +2751,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/event_source_mappings/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/event_source_mappings/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::EventSourceMapping' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::EventSourceMapping' - AND region = 'us-east-1' - event_source_mapping: - name: event_source_mapping - id: aws.lambda.event_source_mapping - x-cfn-schema-name: EventSourceMapping - x-cfn-type-name: AWS::Lambda::EventSourceMapping - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2828,76 +2764,96 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/event_source_mappings/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/event_source_mappings/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/event_source_mapping/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/event_source_mappings/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.Id') as id, - JSON_EXTRACT(Properties, '$.BatchSize') as batch_size, - JSON_EXTRACT(Properties, '$.BisectBatchOnFunctionError') as bisect_batch_on_function_error, - JSON_EXTRACT(Properties, '$.DestinationConfig') as destination_config, - JSON_EXTRACT(Properties, '$.Enabled') as enabled, - JSON_EXTRACT(Properties, '$.EventSourceArn') as event_source_arn, + JSON_EXTRACT(Properties, '$.StartingPosition') as starting_position, + JSON_EXTRACT(Properties, '$.SelfManagedEventSource') as self_managed_event_source, + JSON_EXTRACT(Properties, '$.ParallelizationFactor') as parallelization_factor, JSON_EXTRACT(Properties, '$.FilterCriteria') as filter_criteria, JSON_EXTRACT(Properties, '$.FunctionName') as function_name, + JSON_EXTRACT(Properties, '$.DestinationConfig') as destination_config, + JSON_EXTRACT(Properties, '$.AmazonManagedKafkaEventSourceConfig') as amazon_managed_kafka_event_source_config, + JSON_EXTRACT(Properties, '$.SourceAccessConfigurations') as source_access_configurations, JSON_EXTRACT(Properties, '$.MaximumBatchingWindowInSeconds') as maximum_batching_window_in_seconds, - JSON_EXTRACT(Properties, '$.MaximumRecordAgeInSeconds') as maximum_record_age_in_seconds, + JSON_EXTRACT(Properties, '$.BatchSize') as batch_size, JSON_EXTRACT(Properties, '$.MaximumRetryAttempts') as maximum_retry_attempts, - JSON_EXTRACT(Properties, '$.ParallelizationFactor') as parallelization_factor, - JSON_EXTRACT(Properties, '$.StartingPosition') as starting_position, - JSON_EXTRACT(Properties, '$.StartingPositionTimestamp') as starting_position_timestamp, JSON_EXTRACT(Properties, '$.Topics') as topics, - JSON_EXTRACT(Properties, '$.Queues') as queues, - JSON_EXTRACT(Properties, '$.SourceAccessConfigurations') as source_access_configurations, - JSON_EXTRACT(Properties, '$.TumblingWindowInSeconds') as tumbling_window_in_seconds, - JSON_EXTRACT(Properties, '$.FunctionResponseTypes') as function_response_types, - JSON_EXTRACT(Properties, '$.SelfManagedEventSource') as self_managed_event_source, - JSON_EXTRACT(Properties, '$.AmazonManagedKafkaEventSourceConfig') as amazon_managed_kafka_event_source_config, - JSON_EXTRACT(Properties, '$.SelfManagedKafkaEventSourceConfig') as self_managed_kafka_event_source_config, JSON_EXTRACT(Properties, '$.ScalingConfig') as scaling_config, - JSON_EXTRACT(Properties, '$.DocumentDBEventSourceConfig') as document_db_event_source_config + JSON_EXTRACT(Properties, '$.Enabled') as enabled, + JSON_EXTRACT(Properties, '$.EventSourceArn') as event_source_arn, + JSON_EXTRACT(Properties, '$.SelfManagedKafkaEventSourceConfig') as self_managed_kafka_event_source_config, + JSON_EXTRACT(Properties, '$.DocumentDBEventSourceConfig') as document_db_event_source_config, + JSON_EXTRACT(Properties, '$.TumblingWindowInSeconds') as tumbling_window_in_seconds, + JSON_EXTRACT(Properties, '$.BisectBatchOnFunctionError') as bisect_batch_on_function_error, + JSON_EXTRACT(Properties, '$.MaximumRecordAgeInSeconds') as maximum_record_age_in_seconds, + JSON_EXTRACT(Properties, '$.StartingPositionTimestamp') as starting_position_timestamp, + JSON_EXTRACT(Properties, '$.Queues') as queues, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.FunctionResponseTypes') as function_response_types FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Lambda::EventSourceMapping' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'BatchSize') as batch_size, - json_extract_path_text(Properties, 'BisectBatchOnFunctionError') as bisect_batch_on_function_error, - json_extract_path_text(Properties, 'DestinationConfig') as destination_config, - json_extract_path_text(Properties, 'Enabled') as enabled, - json_extract_path_text(Properties, 'EventSourceArn') as event_source_arn, - json_extract_path_text(Properties, 'FilterCriteria') as filter_criteria, - json_extract_path_text(Properties, 'FunctionName') as function_name, - json_extract_path_text(Properties, 'MaximumBatchingWindowInSeconds') as maximum_batching_window_in_seconds, - json_extract_path_text(Properties, 'MaximumRecordAgeInSeconds') as maximum_record_age_in_seconds, - json_extract_path_text(Properties, 'MaximumRetryAttempts') as maximum_retry_attempts, - json_extract_path_text(Properties, 'ParallelizationFactor') as parallelization_factor, - json_extract_path_text(Properties, 'StartingPosition') as starting_position, - json_extract_path_text(Properties, 'StartingPositionTimestamp') as starting_position_timestamp, - json_extract_path_text(Properties, 'Topics') as topics, - json_extract_path_text(Properties, 'Queues') as queues, - json_extract_path_text(Properties, 'SourceAccessConfigurations') as source_access_configurations, - json_extract_path_text(Properties, 'TumblingWindowInSeconds') as tumbling_window_in_seconds, - json_extract_path_text(Properties, 'FunctionResponseTypes') as function_response_types, - json_extract_path_text(Properties, 'SelfManagedEventSource') as self_managed_event_source, - json_extract_path_text(Properties, 'AmazonManagedKafkaEventSourceConfig') as amazon_managed_kafka_event_source_config, - json_extract_path_text(Properties, 'SelfManagedKafkaEventSourceConfig') as self_managed_kafka_event_source_config, - json_extract_path_text(Properties, 'ScalingConfig') as scaling_config, - json_extract_path_text(Properties, 'DocumentDBEventSourceConfig') as document_db_event_source_config - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Lambda::EventSourceMapping' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::EventSourceMapping' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'StartingPosition') as starting_position, + json_extract_path_text(Properties, 'SelfManagedEventSource') as self_managed_event_source, + json_extract_path_text(Properties, 'ParallelizationFactor') as parallelization_factor, + json_extract_path_text(Properties, 'FilterCriteria') as filter_criteria, + json_extract_path_text(Properties, 'FunctionName') as function_name, + json_extract_path_text(Properties, 'DestinationConfig') as destination_config, + json_extract_path_text(Properties, 'AmazonManagedKafkaEventSourceConfig') as amazon_managed_kafka_event_source_config, + json_extract_path_text(Properties, 'SourceAccessConfigurations') as source_access_configurations, + json_extract_path_text(Properties, 'MaximumBatchingWindowInSeconds') as maximum_batching_window_in_seconds, + json_extract_path_text(Properties, 'BatchSize') as batch_size, + json_extract_path_text(Properties, 'MaximumRetryAttempts') as maximum_retry_attempts, + json_extract_path_text(Properties, 'Topics') as topics, + json_extract_path_text(Properties, 'ScalingConfig') as scaling_config, + json_extract_path_text(Properties, 'Enabled') as enabled, + json_extract_path_text(Properties, 'EventSourceArn') as event_source_arn, + json_extract_path_text(Properties, 'SelfManagedKafkaEventSourceConfig') as self_managed_kafka_event_source_config, + json_extract_path_text(Properties, 'DocumentDBEventSourceConfig') as document_db_event_source_config, + json_extract_path_text(Properties, 'TumblingWindowInSeconds') as tumbling_window_in_seconds, + json_extract_path_text(Properties, 'BisectBatchOnFunctionError') as bisect_batch_on_function_error, + json_extract_path_text(Properties, 'MaximumRecordAgeInSeconds') as maximum_record_age_in_seconds, + json_extract_path_text(Properties, 'StartingPositionTimestamp') as starting_position_timestamp, + json_extract_path_text(Properties, 'Queues') as queues, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'FunctionResponseTypes') as function_response_types + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Lambda::EventSourceMapping' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::EventSourceMapping' + AND region = 'us-east-1' functions: name: functions id: aws.lambda.functions @@ -2905,7 +2861,7 @@ components: x-cfn-type-name: AWS::Lambda::Function x-identifiers: - FunctionName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2922,9 +2878,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2934,41 +2890,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/functions/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/functions/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.FunctionName') as function_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::Function' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'FunctionName') as function_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::Function' - AND region = 'us-east-1' - function: - name: function - id: aws.lambda.function - x-cfn-schema-name: Function - x-cfn-type-name: AWS::Lambda::Function - x-identifiers: - - FunctionName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2979,12 +2903,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/functions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/functions/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/function/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/functions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3020,41 +2948,57 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'TracingConfig') as tracing_config, - json_extract_path_text(Properties, 'VpcConfig') as vpc_config, - json_extract_path_text(Properties, 'RuntimeManagementConfig') as runtime_management_config, - json_extract_path_text(Properties, 'ReservedConcurrentExecutions') as reserved_concurrent_executions, - json_extract_path_text(Properties, 'SnapStart') as snap_start, - json_extract_path_text(Properties, 'FileSystemConfigs') as file_system_configs, - json_extract_path_text(Properties, 'FunctionName') as function_name, - json_extract_path_text(Properties, 'Runtime') as runtime, - json_extract_path_text(Properties, 'KmsKeyArn') as kms_key_arn, - json_extract_path_text(Properties, 'PackageType') as package_type, - json_extract_path_text(Properties, 'CodeSigningConfigArn') as code_signing_config_arn, - json_extract_path_text(Properties, 'Layers') as layers, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'ImageConfig') as image_config, - json_extract_path_text(Properties, 'MemorySize') as memory_size, - json_extract_path_text(Properties, 'DeadLetterConfig') as dead_letter_config, - json_extract_path_text(Properties, 'Timeout') as timeout, - json_extract_path_text(Properties, 'Handler') as handler, - json_extract_path_text(Properties, 'SnapStartResponse') as snap_start_response, - json_extract_path_text(Properties, 'Code') as code, - json_extract_path_text(Properties, 'Role') as role, - json_extract_path_text(Properties, 'LoggingConfig') as logging_config, - json_extract_path_text(Properties, 'Environment') as environment, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'EphemeralStorage') as ephemeral_storage, - json_extract_path_text(Properties, 'Architectures') as architectures - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Lambda::Function' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.FunctionName') as function_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::Function' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'TracingConfig') as tracing_config, + json_extract_path_text(Properties, 'VpcConfig') as vpc_config, + json_extract_path_text(Properties, 'RuntimeManagementConfig') as runtime_management_config, + json_extract_path_text(Properties, 'ReservedConcurrentExecutions') as reserved_concurrent_executions, + json_extract_path_text(Properties, 'SnapStart') as snap_start, + json_extract_path_text(Properties, 'FileSystemConfigs') as file_system_configs, + json_extract_path_text(Properties, 'FunctionName') as function_name, + json_extract_path_text(Properties, 'Runtime') as runtime, + json_extract_path_text(Properties, 'KmsKeyArn') as kms_key_arn, + json_extract_path_text(Properties, 'PackageType') as package_type, + json_extract_path_text(Properties, 'CodeSigningConfigArn') as code_signing_config_arn, + json_extract_path_text(Properties, 'Layers') as layers, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'ImageConfig') as image_config, + json_extract_path_text(Properties, 'MemorySize') as memory_size, + json_extract_path_text(Properties, 'DeadLetterConfig') as dead_letter_config, + json_extract_path_text(Properties, 'Timeout') as timeout, + json_extract_path_text(Properties, 'Handler') as handler, + json_extract_path_text(Properties, 'SnapStartResponse') as snap_start_response, + json_extract_path_text(Properties, 'Code') as code, + json_extract_path_text(Properties, 'Role') as role, + json_extract_path_text(Properties, 'LoggingConfig') as logging_config, + json_extract_path_text(Properties, 'Environment') as environment, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'EphemeralStorage') as ephemeral_storage, + json_extract_path_text(Properties, 'Architectures') as architectures + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Lambda::Function' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'FunctionName') as function_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::Function' + AND region = 'us-east-1' layer_versions: name: layer_versions id: aws.lambda.layer_versions @@ -3062,7 +3006,7 @@ components: x-cfn-type-name: AWS::Lambda::LayerVersion x-identifiers: - LayerVersionArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3096,39 +3040,11 @@ components: - $ref: '#/components/x-stackQL-resources/layer_versions/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/layer_versions/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.LayerVersionArn') as layer_version_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::LayerVersion' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'LayerVersionArn') as layer_version_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::LayerVersion' - AND region = 'us-east-1' - layer_version: - name: layer_version - id: aws.lambda.layer_version - x-cfn-schema-name: LayerVersion - x-cfn-type-name: AWS::Lambda::LayerVersion - x-identifiers: - - LayerVersionArn - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3144,21 +3060,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'CompatibleRuntimes') as compatible_runtimes, - json_extract_path_text(Properties, 'LicenseInfo') as license_info, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'LayerName') as layer_name, - json_extract_path_text(Properties, 'Content') as content, - json_extract_path_text(Properties, 'LayerVersionArn') as layer_version_arn, - json_extract_path_text(Properties, 'CompatibleArchitectures') as compatible_architectures - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Lambda::LayerVersion' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.LayerVersionArn') as layer_version_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::LayerVersion' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'CompatibleRuntimes') as compatible_runtimes, + json_extract_path_text(Properties, 'LicenseInfo') as license_info, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'LayerName') as layer_name, + json_extract_path_text(Properties, 'Content') as content, + json_extract_path_text(Properties, 'LayerVersionArn') as layer_version_arn, + json_extract_path_text(Properties, 'CompatibleArchitectures') as compatible_architectures + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Lambda::LayerVersion' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'LayerVersionArn') as layer_version_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::LayerVersion' + AND region = 'us-east-1' layer_version_permissions: name: layer_version_permissions id: aws.lambda.layer_version_permissions @@ -3166,7 +3098,7 @@ components: x-cfn-type-name: AWS::Lambda::LayerVersionPermission x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3200,39 +3132,11 @@ components: - $ref: '#/components/x-stackQL-resources/layer_version_permissions/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/layer_version_permissions/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::LayerVersionPermission' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::LayerVersionPermission' - AND region = 'us-east-1' - layer_version_permission: - name: layer_version_permission - id: aws.lambda.layer_version_permission - x-cfn-schema-name: LayerVersionPermission - x-cfn-type-name: AWS::Lambda::LayerVersionPermission - x-identifiers: - - Id - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3246,19 +3150,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Action') as action, - json_extract_path_text(Properties, 'LayerVersionArn') as layer_version_arn, - json_extract_path_text(Properties, 'OrganizationId') as organization_id, - json_extract_path_text(Properties, 'Principal') as principal - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Lambda::LayerVersionPermission' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::LayerVersionPermission' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Action') as action, + json_extract_path_text(Properties, 'LayerVersionArn') as layer_version_arn, + json_extract_path_text(Properties, 'OrganizationId') as organization_id, + json_extract_path_text(Properties, 'Principal') as principal + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Lambda::LayerVersionPermission' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::LayerVersionPermission' + AND region = 'us-east-1' permissions: name: permissions id: aws.lambda.permissions @@ -3267,7 +3187,7 @@ components: x-identifiers: - FunctionName - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3301,42 +3221,11 @@ components: - $ref: '#/components/x-stackQL-resources/permissions/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/permissions/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.FunctionName') as function_name, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::Permission' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'FunctionName') as function_name, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::Permission' - AND region = 'us-east-1' - permission: - name: permission - id: aws.lambda.permission - x-cfn-schema-name: Permission - x-cfn-type-name: AWS::Lambda::Permission - x-identifiers: - - FunctionName - - Id - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3354,23 +3243,41 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Action') as action, - json_extract_path_text(Properties, 'EventSourceToken') as event_source_token, - json_extract_path_text(Properties, 'FunctionName') as function_name, - json_extract_path_text(Properties, 'FunctionUrlAuthType') as function_url_auth_type, - json_extract_path_text(Properties, 'Principal') as principal, - json_extract_path_text(Properties, 'PrincipalOrgID') as principal_org_id, - json_extract_path_text(Properties, 'SourceAccount') as source_account, - json_extract_path_text(Properties, 'SourceArn') as source_arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Lambda::Permission' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.FunctionName') as function_name, + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::Permission' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Action') as action, + json_extract_path_text(Properties, 'EventSourceToken') as event_source_token, + json_extract_path_text(Properties, 'FunctionName') as function_name, + json_extract_path_text(Properties, 'FunctionUrlAuthType') as function_url_auth_type, + json_extract_path_text(Properties, 'Principal') as principal, + json_extract_path_text(Properties, 'PrincipalOrgID') as principal_org_id, + json_extract_path_text(Properties, 'SourceAccount') as source_account, + json_extract_path_text(Properties, 'SourceArn') as source_arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Lambda::Permission' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'FunctionName') as function_name, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::Permission' + AND region = 'us-east-1' urls: name: urls id: aws.lambda.urls @@ -3378,7 +3285,7 @@ components: x-cfn-type-name: AWS::Lambda::Url x-identifiers: - FunctionArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3395,9 +3302,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3407,41 +3314,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/urls/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/urls/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.FunctionArn') as function_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::Url' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'FunctionArn') as function_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::Url' - AND region = 'us-east-1' - url: - name: url - id: aws.lambda.url - x-cfn-schema-name: Url - x-cfn-type-name: AWS::Lambda::Url - x-identifiers: - - FunctionArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3452,12 +3327,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/urls/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/urls/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/url/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/urls/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3473,21 +3352,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'TargetFunctionArn') as target_function_arn, - json_extract_path_text(Properties, 'Qualifier') as qualifier, - json_extract_path_text(Properties, 'AuthType') as auth_type, - json_extract_path_text(Properties, 'InvokeMode') as invoke_mode, - json_extract_path_text(Properties, 'FunctionArn') as function_arn, - json_extract_path_text(Properties, 'FunctionUrl') as function_url, - json_extract_path_text(Properties, 'Cors') as cors - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Lambda::Url' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.FunctionArn') as function_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::Url' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'TargetFunctionArn') as target_function_arn, + json_extract_path_text(Properties, 'Qualifier') as qualifier, + json_extract_path_text(Properties, 'AuthType') as auth_type, + json_extract_path_text(Properties, 'InvokeMode') as invoke_mode, + json_extract_path_text(Properties, 'FunctionArn') as function_arn, + json_extract_path_text(Properties, 'FunctionUrl') as function_url, + json_extract_path_text(Properties, 'Cors') as cors + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Lambda::Url' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'FunctionArn') as function_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::Url' + AND region = 'us-east-1' versions: name: versions id: aws.lambda.versions @@ -3495,7 +3390,7 @@ components: x-cfn-type-name: AWS::Lambda::Version x-identifiers: - FunctionArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3529,39 +3424,11 @@ components: - $ref: '#/components/x-stackQL-resources/versions/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/versions/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.FunctionArn') as function_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::Version' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'FunctionArn') as function_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::Version' - AND region = 'us-east-1' - version: - name: version - id: aws.lambda.version - x-cfn-schema-name: Version - x-cfn-type-name: AWS::Lambda::Version - x-identifiers: - - FunctionArn - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3571,27 +3438,45 @@ components: JSON_EXTRACT(Properties, '$.CodeSha256') as code_sha256, JSON_EXTRACT(Properties, '$.Description') as description, JSON_EXTRACT(Properties, '$.FunctionName') as function_name, + JSON_EXTRACT(Properties, '$.Policy') as policy, JSON_EXTRACT(Properties, '$.ProvisionedConcurrencyConfig') as provisioned_concurrency_config, JSON_EXTRACT(Properties, '$.RuntimePolicy') as runtime_policy FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Lambda::Version' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'FunctionArn') as function_arn, - json_extract_path_text(Properties, 'Version') as version, - json_extract_path_text(Properties, 'CodeSha256') as code_sha256, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'FunctionName') as function_name, - json_extract_path_text(Properties, 'ProvisionedConcurrencyConfig') as provisioned_concurrency_config, - json_extract_path_text(Properties, 'RuntimePolicy') as runtime_policy - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Lambda::Version' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.FunctionArn') as function_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::Version' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'FunctionArn') as function_arn, + json_extract_path_text(Properties, 'Version') as version, + json_extract_path_text(Properties, 'CodeSha256') as code_sha256, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'FunctionName') as function_name, + json_extract_path_text(Properties, 'Policy') as policy, + json_extract_path_text(Properties, 'ProvisionedConcurrencyConfig') as provisioned_concurrency_config, + json_extract_path_text(Properties, 'RuntimePolicy') as runtime_policy + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Lambda::Version' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'FunctionArn') as function_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lambda::Version' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/lex.yaml b/providers/src/aws/v00.00.00000/services/lex.yaml index 7402dab2..fa91e5b0 100644 --- a/providers/src/aws/v00.00.00000/services/lex.yaml +++ b/providers/src/aws/v00.00.00000/services/lex.yaml @@ -2539,7 +2539,7 @@ components: x-cfn-type-name: AWS::Lex::Bot x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2556,9 +2556,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2568,41 +2568,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/bots/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/bots/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lex::Bot' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lex::Bot' - AND region = 'us-east-1' - bot: - name: bot - id: aws.lex.bot - x-cfn-schema-name: Bot - x-cfn-type-name: AWS::Lex::Bot - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2613,12 +2581,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/bots/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/bots/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/bot/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/bots/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2640,27 +2612,43 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'DataPrivacy') as data_privacy, - json_extract_path_text(Properties, 'IdleSessionTTLInSeconds') as idle_session_ttl_in_seconds, - json_extract_path_text(Properties, 'BotLocales') as bot_locales, - json_extract_path_text(Properties, 'BotFileS3Location') as bot_file_s3_location, - json_extract_path_text(Properties, 'BotTags') as bot_tags, - json_extract_path_text(Properties, 'TestBotAliasTags') as test_bot_alias_tags, - json_extract_path_text(Properties, 'AutoBuildBotLocales') as auto_build_bot_locales, - json_extract_path_text(Properties, 'TestBotAliasSettings') as test_bot_alias_settings - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Lex::Bot' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lex::Bot' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'DataPrivacy') as data_privacy, + json_extract_path_text(Properties, 'IdleSessionTTLInSeconds') as idle_session_ttl_in_seconds, + json_extract_path_text(Properties, 'BotLocales') as bot_locales, + json_extract_path_text(Properties, 'BotFileS3Location') as bot_file_s3_location, + json_extract_path_text(Properties, 'BotTags') as bot_tags, + json_extract_path_text(Properties, 'TestBotAliasTags') as test_bot_alias_tags, + json_extract_path_text(Properties, 'AutoBuildBotLocales') as auto_build_bot_locales, + json_extract_path_text(Properties, 'TestBotAliasSettings') as test_bot_alias_settings + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Lex::Bot' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lex::Bot' + AND region = 'us-east-1' bot_versions: name: bot_versions id: aws.lex.bot_versions @@ -2669,7 +2657,7 @@ components: x-identifiers: - BotId - BotVersion - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2703,42 +2691,11 @@ components: - $ref: '#/components/x-stackQL-resources/bot_versions/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/bot_versions/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.BotId') as bot_id, - JSON_EXTRACT(Properties, '$.BotVersion') as bot_version - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lex::BotVersion' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'BotId') as bot_id, - json_extract_path_text(Properties, 'BotVersion') as bot_version - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lex::BotVersion' - AND region = 'us-east-1' - bot_version: - name: bot_version - id: aws.lex.bot_version - x-cfn-schema-name: BotVersion - x-cfn-type-name: AWS::Lex::BotVersion - x-identifiers: - - BotId - - BotVersion - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2751,18 +2708,36 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'BotId') as bot_id, - json_extract_path_text(Properties, 'BotVersion') as bot_version, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'BotVersionLocaleSpecification') as bot_version_locale_specification - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Lex::BotVersion' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.BotId') as bot_id, + JSON_EXTRACT(Properties, '$.BotVersion') as bot_version + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lex::BotVersion' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'BotId') as bot_id, + json_extract_path_text(Properties, 'BotVersion') as bot_version, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'BotVersionLocaleSpecification') as bot_version_locale_specification + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Lex::BotVersion' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'BotId') as bot_id, + json_extract_path_text(Properties, 'BotVersion') as bot_version + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lex::BotVersion' + AND region = 'us-east-1' bot_aliases: name: bot_aliases id: aws.lex.bot_aliases @@ -2771,7 +2746,7 @@ components: x-identifiers: - BotAliasId - BotId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2788,9 +2763,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2800,44 +2775,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/bot_aliases/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/bot_aliases/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.BotAliasId') as bot_alias_id, - JSON_EXTRACT(Properties, '$.BotId') as bot_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lex::BotAlias' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'BotAliasId') as bot_alias_id, - json_extract_path_text(Properties, 'BotId') as bot_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lex::BotAlias' - AND region = 'us-east-1' - bot_alias: - name: bot_alias - id: aws.lex.bot_alias - x-cfn-schema-name: BotAlias - x-cfn-type-name: AWS::Lex::BotAlias - x-identifiers: - - BotAliasId - - BotId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2848,12 +2788,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/bot_aliases/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/bot_aliases/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/bot_alias/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/bot_aliases/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2873,25 +2817,43 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'BotAliasId') as bot_alias_id, - json_extract_path_text(Properties, 'BotId') as bot_id, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'BotAliasStatus') as bot_alias_status, - json_extract_path_text(Properties, 'BotAliasLocaleSettings') as bot_alias_locale_settings, - json_extract_path_text(Properties, 'BotAliasName') as bot_alias_name, - json_extract_path_text(Properties, 'BotVersion') as bot_version, - json_extract_path_text(Properties, 'ConversationLogSettings') as conversation_log_settings, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'SentimentAnalysisSettings') as sentiment_analysis_settings, - json_extract_path_text(Properties, 'BotAliasTags') as bot_alias_tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Lex::BotAlias' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.BotAliasId') as bot_alias_id, + JSON_EXTRACT(Properties, '$.BotId') as bot_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lex::BotAlias' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'BotAliasId') as bot_alias_id, + json_extract_path_text(Properties, 'BotId') as bot_id, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'BotAliasStatus') as bot_alias_status, + json_extract_path_text(Properties, 'BotAliasLocaleSettings') as bot_alias_locale_settings, + json_extract_path_text(Properties, 'BotAliasName') as bot_alias_name, + json_extract_path_text(Properties, 'BotVersion') as bot_version, + json_extract_path_text(Properties, 'ConversationLogSettings') as conversation_log_settings, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'SentimentAnalysisSettings') as sentiment_analysis_settings, + json_extract_path_text(Properties, 'BotAliasTags') as bot_alias_tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Lex::BotAlias' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'BotAliasId') as bot_alias_id, + json_extract_path_text(Properties, 'BotId') as bot_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lex::BotAlias' + AND region = 'us-east-1' resource_policies: name: resource_policies id: aws.lex.resource_policies @@ -2899,7 +2861,7 @@ components: x-cfn-type-name: AWS::Lex::ResourcePolicy x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2916,9 +2878,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2928,41 +2890,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/resource_policies/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/resource_policies/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lex::ResourcePolicy' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lex::ResourcePolicy' - AND region = 'us-east-1' - resource_policy: - name: resource_policy - id: aws.lex.resource_policy - x-cfn-schema-name: ResourcePolicy - x-cfn-type-name: AWS::Lex::ResourcePolicy - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2973,12 +2903,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/resource_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/resource_policies/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/resource_policy/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/resource_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2991,18 +2925,34 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ResourceArn') as resource_arn, - json_extract_path_text(Properties, 'RevisionId') as revision_id, - json_extract_path_text(Properties, 'Policy') as policy, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Lex::ResourcePolicy' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lex::ResourcePolicy' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ResourceArn') as resource_arn, + json_extract_path_text(Properties, 'RevisionId') as revision_id, + json_extract_path_text(Properties, 'Policy') as policy, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Lex::ResourcePolicy' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lex::ResourcePolicy' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/licensemanager.yaml b/providers/src/aws/v00.00.00000/services/licensemanager.yaml index 32341217..c12fcf0f 100644 --- a/providers/src/aws/v00.00.00000/services/licensemanager.yaml +++ b/providers/src/aws/v00.00.00000/services/licensemanager.yaml @@ -727,7 +727,7 @@ components: x-cfn-type-name: AWS::LicenseManager::Grant x-identifiers: - GrantArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -744,9 +744,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -756,41 +756,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/grants/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/grants/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.GrantArn') as grant_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::LicenseManager::Grant' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'GrantArn') as grant_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::LicenseManager::Grant' - AND region = 'us-east-1' - grant: - name: grant - id: aws.licensemanager.grant - x-cfn-schema-name: Grant - x-cfn-type-name: AWS::LicenseManager::Grant - x-identifiers: - - GrantArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -801,12 +769,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/grants/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/grants/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/grant/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/grants/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -823,22 +795,38 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'GrantArn') as grant_arn, - json_extract_path_text(Properties, 'GrantName') as grant_name, - json_extract_path_text(Properties, 'LicenseArn') as license_arn, - json_extract_path_text(Properties, 'HomeRegion') as home_region, - json_extract_path_text(Properties, 'Version') as version, - json_extract_path_text(Properties, 'AllowedOperations') as allowed_operations, - json_extract_path_text(Properties, 'Principals') as principals, - json_extract_path_text(Properties, 'Status') as status - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::LicenseManager::Grant' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.GrantArn') as grant_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::LicenseManager::Grant' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'GrantArn') as grant_arn, + json_extract_path_text(Properties, 'GrantName') as grant_name, + json_extract_path_text(Properties, 'LicenseArn') as license_arn, + json_extract_path_text(Properties, 'HomeRegion') as home_region, + json_extract_path_text(Properties, 'Version') as version, + json_extract_path_text(Properties, 'AllowedOperations') as allowed_operations, + json_extract_path_text(Properties, 'Principals') as principals, + json_extract_path_text(Properties, 'Status') as status + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::LicenseManager::Grant' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'GrantArn') as grant_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::LicenseManager::Grant' + AND region = 'us-east-1' licenses: name: licenses id: aws.licensemanager.licenses @@ -846,7 +834,7 @@ components: x-cfn-type-name: AWS::LicenseManager::License x-identifiers: - LicenseArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -863,9 +851,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -875,41 +863,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/licenses/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/licenses/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.LicenseArn') as license_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::LicenseManager::License' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'LicenseArn') as license_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::LicenseManager::License' - AND region = 'us-east-1' - license: - name: license - id: aws.licensemanager.license - x-cfn-schema-name: License - x-cfn-type-name: AWS::LicenseManager::License - x-identifiers: - - LicenseArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -920,12 +876,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/licenses/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/licenses/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/license/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/licenses/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -947,27 +907,43 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ProductSKU') as product_sku, - json_extract_path_text(Properties, 'Issuer') as issuer, - json_extract_path_text(Properties, 'LicenseName') as license_name, - json_extract_path_text(Properties, 'ProductName') as product_name, - json_extract_path_text(Properties, 'HomeRegion') as home_region, - json_extract_path_text(Properties, 'Validity') as validity, - json_extract_path_text(Properties, 'Entitlements') as entitlements, - json_extract_path_text(Properties, 'Beneficiary') as beneficiary, - json_extract_path_text(Properties, 'ConsumptionConfiguration') as consumption_configuration, - json_extract_path_text(Properties, 'LicenseMetadata') as license_metadata, - json_extract_path_text(Properties, 'LicenseArn') as license_arn, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'Version') as version - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::LicenseManager::License' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.LicenseArn') as license_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::LicenseManager::License' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ProductSKU') as product_sku, + json_extract_path_text(Properties, 'Issuer') as issuer, + json_extract_path_text(Properties, 'LicenseName') as license_name, + json_extract_path_text(Properties, 'ProductName') as product_name, + json_extract_path_text(Properties, 'HomeRegion') as home_region, + json_extract_path_text(Properties, 'Validity') as validity, + json_extract_path_text(Properties, 'Entitlements') as entitlements, + json_extract_path_text(Properties, 'Beneficiary') as beneficiary, + json_extract_path_text(Properties, 'ConsumptionConfiguration') as consumption_configuration, + json_extract_path_text(Properties, 'LicenseMetadata') as license_metadata, + json_extract_path_text(Properties, 'LicenseArn') as license_arn, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'Version') as version + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::LicenseManager::License' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'LicenseArn') as license_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::LicenseManager::License' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/lightsail.yaml b/providers/src/aws/v00.00.00000/services/lightsail.yaml index 0c941986..4048370a 100644 --- a/providers/src/aws/v00.00.00000/services/lightsail.yaml +++ b/providers/src/aws/v00.00.00000/services/lightsail.yaml @@ -1414,6 +1414,12 @@ components: PublicIpAddress: description: Public IP Address of the Instance type: string + Ipv6Addresses: + description: IPv6 addresses of the instance + type: array + x-insertionOrder: false + items: + type: string Location: $ref: '#/components/schemas/Location' Hardware: @@ -1494,6 +1500,7 @@ components: - IsStaticIp - PrivateIpAddress - PublicIpAddress + - Ipv6Addresses - Location/AvailabilityZone - Location/RegionName - Hardware/CpuCount @@ -2173,6 +2180,12 @@ components: PublicIpAddress: description: Public IP Address of the Instance type: string + Ipv6Addresses: + description: IPv6 addresses of the instance + type: array + x-insertionOrder: false + items: + type: string Location: $ref: '#/components/schemas/Location' Hardware: @@ -2379,7 +2392,7 @@ components: x-cfn-type-name: AWS::Lightsail::Alarm x-identifiers: - AlarmName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2396,9 +2409,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2408,41 +2421,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/alarms/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/alarms/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AlarmName') as alarm_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::Alarm' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AlarmName') as alarm_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::Alarm' - AND region = 'us-east-1' - alarm: - name: alarm - id: aws.lightsail.alarm - x-cfn-schema-name: Alarm - x-cfn-type-name: AWS::Lightsail::Alarm - x-identifiers: - - AlarmName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2453,12 +2434,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/alarms/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/alarms/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/alarm/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/alarms/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2480,27 +2465,43 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AlarmName') as alarm_name, - json_extract_path_text(Properties, 'MonitoredResourceName') as monitored_resource_name, - json_extract_path_text(Properties, 'MetricName') as metric_name, - json_extract_path_text(Properties, 'ComparisonOperator') as comparison_operator, - json_extract_path_text(Properties, 'ContactProtocols') as contact_protocols, - json_extract_path_text(Properties, 'AlarmArn') as alarm_arn, - json_extract_path_text(Properties, 'DatapointsToAlarm') as datapoints_to_alarm, - json_extract_path_text(Properties, 'EvaluationPeriods') as evaluation_periods, - json_extract_path_text(Properties, 'NotificationEnabled') as notification_enabled, - json_extract_path_text(Properties, 'NotificationTriggers') as notification_triggers, - json_extract_path_text(Properties, 'Threshold') as threshold, - json_extract_path_text(Properties, 'TreatMissingData') as treat_missing_data, - json_extract_path_text(Properties, 'State') as state - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Lightsail::Alarm' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.AlarmName') as alarm_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::Alarm' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AlarmName') as alarm_name, + json_extract_path_text(Properties, 'MonitoredResourceName') as monitored_resource_name, + json_extract_path_text(Properties, 'MetricName') as metric_name, + json_extract_path_text(Properties, 'ComparisonOperator') as comparison_operator, + json_extract_path_text(Properties, 'ContactProtocols') as contact_protocols, + json_extract_path_text(Properties, 'AlarmArn') as alarm_arn, + json_extract_path_text(Properties, 'DatapointsToAlarm') as datapoints_to_alarm, + json_extract_path_text(Properties, 'EvaluationPeriods') as evaluation_periods, + json_extract_path_text(Properties, 'NotificationEnabled') as notification_enabled, + json_extract_path_text(Properties, 'NotificationTriggers') as notification_triggers, + json_extract_path_text(Properties, 'Threshold') as threshold, + json_extract_path_text(Properties, 'TreatMissingData') as treat_missing_data, + json_extract_path_text(Properties, 'State') as state + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Lightsail::Alarm' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AlarmName') as alarm_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::Alarm' + AND region = 'us-east-1' buckets: name: buckets id: aws.lightsail.buckets @@ -2508,7 +2509,7 @@ components: x-cfn-type-name: AWS::Lightsail::Bucket x-identifiers: - BucketName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2525,9 +2526,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2537,41 +2538,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/buckets/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/buckets/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.BucketName') as bucket_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::Bucket' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'BucketName') as bucket_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::Bucket' - AND region = 'us-east-1' - bucket: - name: bucket - id: aws.lightsail.bucket - x-cfn-schema-name: Bucket - x-cfn-type-name: AWS::Lightsail::Bucket - x-identifiers: - - BucketName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2582,12 +2551,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/buckets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/buckets/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/bucket/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/buckets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2606,24 +2579,40 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'BucketName') as bucket_name, - json_extract_path_text(Properties, 'BundleId') as bundle_id, - json_extract_path_text(Properties, 'BucketArn') as bucket_arn, - json_extract_path_text(Properties, 'ObjectVersioning') as object_versioning, - json_extract_path_text(Properties, 'AccessRules') as access_rules, - json_extract_path_text(Properties, 'ResourcesReceivingAccess') as resources_receiving_access, - json_extract_path_text(Properties, 'ReadOnlyAccessAccounts') as read_only_access_accounts, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Url') as url, - json_extract_path_text(Properties, 'AbleToUpdateBundle') as able_to_update_bundle - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Lightsail::Bucket' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.BucketName') as bucket_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::Bucket' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'BucketName') as bucket_name, + json_extract_path_text(Properties, 'BundleId') as bundle_id, + json_extract_path_text(Properties, 'BucketArn') as bucket_arn, + json_extract_path_text(Properties, 'ObjectVersioning') as object_versioning, + json_extract_path_text(Properties, 'AccessRules') as access_rules, + json_extract_path_text(Properties, 'ResourcesReceivingAccess') as resources_receiving_access, + json_extract_path_text(Properties, 'ReadOnlyAccessAccounts') as read_only_access_accounts, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Url') as url, + json_extract_path_text(Properties, 'AbleToUpdateBundle') as able_to_update_bundle + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Lightsail::Bucket' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'BucketName') as bucket_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::Bucket' + AND region = 'us-east-1' certificates: name: certificates id: aws.lightsail.certificates @@ -2631,7 +2620,7 @@ components: x-cfn-type-name: AWS::Lightsail::Certificate x-identifiers: - CertificateName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2648,9 +2637,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2660,41 +2649,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/certificates/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/certificates/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.CertificateName') as certificate_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::Certificate' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'CertificateName') as certificate_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::Certificate' - AND region = 'us-east-1' - certificate: - name: certificate - id: aws.lightsail.certificate - x-cfn-schema-name: Certificate - x-cfn-type-name: AWS::Lightsail::Certificate - x-identifiers: - - CertificateName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2705,12 +2662,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/certificates/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/certificates/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/certificate/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/certificates/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2725,20 +2686,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'CertificateName') as certificate_name, - json_extract_path_text(Properties, 'DomainName') as domain_name, - json_extract_path_text(Properties, 'SubjectAlternativeNames') as subject_alternative_names, - json_extract_path_text(Properties, 'CertificateArn') as certificate_arn, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Lightsail::Certificate' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.CertificateName') as certificate_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::Certificate' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'CertificateName') as certificate_name, + json_extract_path_text(Properties, 'DomainName') as domain_name, + json_extract_path_text(Properties, 'SubjectAlternativeNames') as subject_alternative_names, + json_extract_path_text(Properties, 'CertificateArn') as certificate_arn, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Lightsail::Certificate' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'CertificateName') as certificate_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::Certificate' + AND region = 'us-east-1' containers: name: containers id: aws.lightsail.containers @@ -2746,7 +2723,7 @@ components: x-cfn-type-name: AWS::Lightsail::Container x-identifiers: - ServiceName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2763,9 +2740,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2775,41 +2752,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/containers/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/containers/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ServiceName') as service_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::Container' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ServiceName') as service_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::Container' - AND region = 'us-east-1' - container: - name: container - id: aws.lightsail.container - x-cfn-schema-name: Container - x-cfn-type-name: AWS::Lightsail::Container - x-identifiers: - - ServiceName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2820,12 +2765,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/containers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/containers/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/container/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/containers/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2845,25 +2794,41 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ServiceName') as service_name, - json_extract_path_text(Properties, 'Power') as power, - json_extract_path_text(Properties, 'ContainerArn') as container_arn, - json_extract_path_text(Properties, 'Scale') as scale, - json_extract_path_text(Properties, 'PublicDomainNames') as public_domain_names, - json_extract_path_text(Properties, 'ContainerServiceDeployment') as container_service_deployment, - json_extract_path_text(Properties, 'IsDisabled') as is_disabled, - json_extract_path_text(Properties, 'PrivateRegistryAccess') as private_registry_access, - json_extract_path_text(Properties, 'Url') as url, - json_extract_path_text(Properties, 'PrincipalArn') as principal_arn, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Lightsail::Container' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ServiceName') as service_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::Container' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ServiceName') as service_name, + json_extract_path_text(Properties, 'Power') as power, + json_extract_path_text(Properties, 'ContainerArn') as container_arn, + json_extract_path_text(Properties, 'Scale') as scale, + json_extract_path_text(Properties, 'PublicDomainNames') as public_domain_names, + json_extract_path_text(Properties, 'ContainerServiceDeployment') as container_service_deployment, + json_extract_path_text(Properties, 'IsDisabled') as is_disabled, + json_extract_path_text(Properties, 'PrivateRegistryAccess') as private_registry_access, + json_extract_path_text(Properties, 'Url') as url, + json_extract_path_text(Properties, 'PrincipalArn') as principal_arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Lightsail::Container' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ServiceName') as service_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::Container' + AND region = 'us-east-1' databases: name: databases id: aws.lightsail.databases @@ -2871,7 +2836,7 @@ components: x-cfn-type-name: AWS::Lightsail::Database x-identifiers: - RelationalDatabaseName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2888,9 +2853,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2900,41 +2865,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/databases/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/databases/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.RelationalDatabaseName') as relational_database_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::Database' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'RelationalDatabaseName') as relational_database_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::Database' - AND region = 'us-east-1' - database: - name: database - id: aws.lightsail.database - x-cfn-schema-name: Database - x-cfn-type-name: AWS::Lightsail::Database - x-identifiers: - - RelationalDatabaseName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2945,12 +2878,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/databases/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/databases/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/database/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/databases/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2975,30 +2912,46 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'RelationalDatabaseName') as relational_database_name, - json_extract_path_text(Properties, 'DatabaseArn') as database_arn, - json_extract_path_text(Properties, 'AvailabilityZone') as availability_zone, - json_extract_path_text(Properties, 'RelationalDatabaseBlueprintId') as relational_database_blueprint_id, - json_extract_path_text(Properties, 'RelationalDatabaseBundleId') as relational_database_bundle_id, - json_extract_path_text(Properties, 'MasterDatabaseName') as master_database_name, - json_extract_path_text(Properties, 'MasterUsername') as master_username, - json_extract_path_text(Properties, 'MasterUserPassword') as master_user_password, - json_extract_path_text(Properties, 'PreferredBackupWindow') as preferred_backup_window, - json_extract_path_text(Properties, 'PreferredMaintenanceWindow') as preferred_maintenance_window, - json_extract_path_text(Properties, 'PubliclyAccessible') as publicly_accessible, - json_extract_path_text(Properties, 'CaCertificateIdentifier') as ca_certificate_identifier, - json_extract_path_text(Properties, 'BackupRetention') as backup_retention, - json_extract_path_text(Properties, 'RotateMasterUserPassword') as rotate_master_user_password, - json_extract_path_text(Properties, 'RelationalDatabaseParameters') as relational_database_parameters, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Lightsail::Database' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.RelationalDatabaseName') as relational_database_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::Database' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'RelationalDatabaseName') as relational_database_name, + json_extract_path_text(Properties, 'DatabaseArn') as database_arn, + json_extract_path_text(Properties, 'AvailabilityZone') as availability_zone, + json_extract_path_text(Properties, 'RelationalDatabaseBlueprintId') as relational_database_blueprint_id, + json_extract_path_text(Properties, 'RelationalDatabaseBundleId') as relational_database_bundle_id, + json_extract_path_text(Properties, 'MasterDatabaseName') as master_database_name, + json_extract_path_text(Properties, 'MasterUsername') as master_username, + json_extract_path_text(Properties, 'MasterUserPassword') as master_user_password, + json_extract_path_text(Properties, 'PreferredBackupWindow') as preferred_backup_window, + json_extract_path_text(Properties, 'PreferredMaintenanceWindow') as preferred_maintenance_window, + json_extract_path_text(Properties, 'PubliclyAccessible') as publicly_accessible, + json_extract_path_text(Properties, 'CaCertificateIdentifier') as ca_certificate_identifier, + json_extract_path_text(Properties, 'BackupRetention') as backup_retention, + json_extract_path_text(Properties, 'RotateMasterUserPassword') as rotate_master_user_password, + json_extract_path_text(Properties, 'RelationalDatabaseParameters') as relational_database_parameters, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Lightsail::Database' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'RelationalDatabaseName') as relational_database_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::Database' + AND region = 'us-east-1' distributions: name: distributions id: aws.lightsail.distributions @@ -3006,7 +2959,7 @@ components: x-cfn-type-name: AWS::Lightsail::Distribution x-identifiers: - DistributionName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3023,9 +2976,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3035,41 +2988,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/distributions/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/distributions/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.DistributionName') as distribution_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::Distribution' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'DistributionName') as distribution_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::Distribution' - AND region = 'us-east-1' - distribution: - name: distribution - id: aws.lightsail.distribution - x-cfn-schema-name: Distribution - x-cfn-type-name: AWS::Lightsail::Distribution - x-identifiers: - - DistributionName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3080,12 +3001,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/distributions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/distributions/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/distribution/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/distributions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3107,27 +3032,43 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'DistributionName') as distribution_name, - json_extract_path_text(Properties, 'DistributionArn') as distribution_arn, - json_extract_path_text(Properties, 'BundleId') as bundle_id, - json_extract_path_text(Properties, 'IpAddressType') as ip_address_type, - json_extract_path_text(Properties, 'CacheBehaviors') as cache_behaviors, - json_extract_path_text(Properties, 'CacheBehaviorSettings') as cache_behavior_settings, - json_extract_path_text(Properties, 'DefaultCacheBehavior') as default_cache_behavior, - json_extract_path_text(Properties, 'Origin') as origin, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'AbleToUpdateBundle') as able_to_update_bundle, - json_extract_path_text(Properties, 'IsEnabled') as is_enabled, - json_extract_path_text(Properties, 'CertificateName') as certificate_name, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Lightsail::Distribution' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.DistributionName') as distribution_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::Distribution' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DistributionName') as distribution_name, + json_extract_path_text(Properties, 'DistributionArn') as distribution_arn, + json_extract_path_text(Properties, 'BundleId') as bundle_id, + json_extract_path_text(Properties, 'IpAddressType') as ip_address_type, + json_extract_path_text(Properties, 'CacheBehaviors') as cache_behaviors, + json_extract_path_text(Properties, 'CacheBehaviorSettings') as cache_behavior_settings, + json_extract_path_text(Properties, 'DefaultCacheBehavior') as default_cache_behavior, + json_extract_path_text(Properties, 'Origin') as origin, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'AbleToUpdateBundle') as able_to_update_bundle, + json_extract_path_text(Properties, 'IsEnabled') as is_enabled, + json_extract_path_text(Properties, 'CertificateName') as certificate_name, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Lightsail::Distribution' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DistributionName') as distribution_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::Distribution' + AND region = 'us-east-1' instances: name: instances id: aws.lightsail.instances @@ -3135,7 +3076,7 @@ components: x-cfn-type-name: AWS::Lightsail::Instance x-identifiers: - InstanceName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3152,9 +3093,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3164,41 +3105,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/instances/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/instances/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.InstanceName') as instance_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::Instance' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'InstanceName') as instance_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::Instance' - AND region = 'us-east-1' - instance: - name: instance - id: aws.lightsail.instance - x-cfn-schema-name: Instance - x-cfn-type-name: AWS::Lightsail::Instance - x-identifiers: - - InstanceName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3209,12 +3118,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/instances/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/instances/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/instance/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/instances/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3224,6 +3137,7 @@ components: JSON_EXTRACT(Properties, '$.IsStaticIp') as is_static_ip, JSON_EXTRACT(Properties, '$.PrivateIpAddress') as private_ip_address, JSON_EXTRACT(Properties, '$.PublicIpAddress') as public_ip_address, + JSON_EXTRACT(Properties, '$.Ipv6Addresses') as ipv6_addresses, JSON_EXTRACT(Properties, '$.Location') as location, JSON_EXTRACT(Properties, '$.Hardware') as hardware, JSON_EXTRACT(Properties, '$.State') as state, @@ -3243,34 +3157,51 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'SupportCode') as support_code, - json_extract_path_text(Properties, 'ResourceType') as resource_type, - json_extract_path_text(Properties, 'IsStaticIp') as is_static_ip, - json_extract_path_text(Properties, 'PrivateIpAddress') as private_ip_address, - json_extract_path_text(Properties, 'PublicIpAddress') as public_ip_address, - json_extract_path_text(Properties, 'Location') as location, - json_extract_path_text(Properties, 'Hardware') as hardware, - json_extract_path_text(Properties, 'State') as state, - json_extract_path_text(Properties, 'Networking') as networking, - json_extract_path_text(Properties, 'UserName') as user_name, - json_extract_path_text(Properties, 'SshKeyName') as ssh_key_name, - json_extract_path_text(Properties, 'InstanceName') as instance_name, - json_extract_path_text(Properties, 'AvailabilityZone') as availability_zone, - json_extract_path_text(Properties, 'BundleId') as bundle_id, - json_extract_path_text(Properties, 'BlueprintId') as blueprint_id, - json_extract_path_text(Properties, 'AddOns') as add_ons, - json_extract_path_text(Properties, 'UserData') as user_data, - json_extract_path_text(Properties, 'KeyPairName') as key_pair_name, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'InstanceArn') as instance_arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Lightsail::Instance' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.InstanceName') as instance_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::Instance' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'SupportCode') as support_code, + json_extract_path_text(Properties, 'ResourceType') as resource_type, + json_extract_path_text(Properties, 'IsStaticIp') as is_static_ip, + json_extract_path_text(Properties, 'PrivateIpAddress') as private_ip_address, + json_extract_path_text(Properties, 'PublicIpAddress') as public_ip_address, + json_extract_path_text(Properties, 'Ipv6Addresses') as ipv6_addresses, + json_extract_path_text(Properties, 'Location') as location, + json_extract_path_text(Properties, 'Hardware') as hardware, + json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'Networking') as networking, + json_extract_path_text(Properties, 'UserName') as user_name, + json_extract_path_text(Properties, 'SshKeyName') as ssh_key_name, + json_extract_path_text(Properties, 'InstanceName') as instance_name, + json_extract_path_text(Properties, 'AvailabilityZone') as availability_zone, + json_extract_path_text(Properties, 'BundleId') as bundle_id, + json_extract_path_text(Properties, 'BlueprintId') as blueprint_id, + json_extract_path_text(Properties, 'AddOns') as add_ons, + json_extract_path_text(Properties, 'UserData') as user_data, + json_extract_path_text(Properties, 'KeyPairName') as key_pair_name, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'InstanceArn') as instance_arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Lightsail::Instance' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'InstanceName') as instance_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::Instance' + AND region = 'us-east-1' load_balancers: name: load_balancers id: aws.lightsail.load_balancers @@ -3278,7 +3209,7 @@ components: x-cfn-type-name: AWS::Lightsail::LoadBalancer x-identifiers: - LoadBalancerName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3295,9 +3226,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3307,41 +3238,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/load_balancers/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/load_balancers/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.LoadBalancerName') as load_balancer_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::LoadBalancer' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'LoadBalancerName') as load_balancer_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::LoadBalancer' - AND region = 'us-east-1' - load_balancer: - name: load_balancer - id: aws.lightsail.load_balancer - x-cfn-schema-name: LoadBalancer - x-cfn-type-name: AWS::Lightsail::LoadBalancer - x-identifiers: - - LoadBalancerName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3352,12 +3251,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/load_balancers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/load_balancers/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/load_balancer/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/load_balancers/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3376,24 +3279,40 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'LoadBalancerName') as load_balancer_name, - json_extract_path_text(Properties, 'LoadBalancerArn') as load_balancer_arn, - json_extract_path_text(Properties, 'InstancePort') as instance_port, - json_extract_path_text(Properties, 'IpAddressType') as ip_address_type, - json_extract_path_text(Properties, 'AttachedInstances') as attached_instances, - json_extract_path_text(Properties, 'HealthCheckPath') as health_check_path, - json_extract_path_text(Properties, 'SessionStickinessEnabled') as session_stickiness_enabled, - json_extract_path_text(Properties, 'SessionStickinessLBCookieDurationSeconds') as session_stickiness_lb_cookie_duration_seconds, - json_extract_path_text(Properties, 'TlsPolicyName') as tls_policy_name, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Lightsail::LoadBalancer' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.LoadBalancerName') as load_balancer_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::LoadBalancer' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'LoadBalancerName') as load_balancer_name, + json_extract_path_text(Properties, 'LoadBalancerArn') as load_balancer_arn, + json_extract_path_text(Properties, 'InstancePort') as instance_port, + json_extract_path_text(Properties, 'IpAddressType') as ip_address_type, + json_extract_path_text(Properties, 'AttachedInstances') as attached_instances, + json_extract_path_text(Properties, 'HealthCheckPath') as health_check_path, + json_extract_path_text(Properties, 'SessionStickinessEnabled') as session_stickiness_enabled, + json_extract_path_text(Properties, 'SessionStickinessLBCookieDurationSeconds') as session_stickiness_lb_cookie_duration_seconds, + json_extract_path_text(Properties, 'TlsPolicyName') as tls_policy_name, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Lightsail::LoadBalancer' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'LoadBalancerName') as load_balancer_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::LoadBalancer' + AND region = 'us-east-1' load_balancer_tls_certificates: name: load_balancer_tls_certificates id: aws.lightsail.load_balancer_tls_certificates @@ -3402,7 +3321,7 @@ components: x-identifiers: - CertificateName - LoadBalancerName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3419,9 +3338,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3431,44 +3350,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/load_balancer_tls_certificates/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/load_balancer_tls_certificates/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.CertificateName') as certificate_name, - JSON_EXTRACT(Properties, '$.LoadBalancerName') as load_balancer_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::LoadBalancerTlsCertificate' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'CertificateName') as certificate_name, - json_extract_path_text(Properties, 'LoadBalancerName') as load_balancer_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::LoadBalancerTlsCertificate' - AND region = 'us-east-1' - load_balancer_tls_certificate: - name: load_balancer_tls_certificate - id: aws.lightsail.load_balancer_tls_certificate - x-cfn-schema-name: LoadBalancerTlsCertificate - x-cfn-type-name: AWS::Lightsail::LoadBalancerTlsCertificate - x-identifiers: - - CertificateName - - LoadBalancerName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3479,12 +3363,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/load_balancer_tls_certificates/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/load_balancer_tls_certificates/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/load_balancer_tls_certificate/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/load_balancer_tls_certificates/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3501,22 +3389,40 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'LoadBalancerName') as load_balancer_name, - json_extract_path_text(Properties, 'CertificateName') as certificate_name, - json_extract_path_text(Properties, 'CertificateDomainName') as certificate_domain_name, - json_extract_path_text(Properties, 'CertificateAlternativeNames') as certificate_alternative_names, - json_extract_path_text(Properties, 'LoadBalancerTlsCertificateArn') as load_balancer_tls_certificate_arn, - json_extract_path_text(Properties, 'IsAttached') as is_attached, - json_extract_path_text(Properties, 'HttpsRedirectionEnabled') as https_redirection_enabled, - json_extract_path_text(Properties, 'Status') as status - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Lightsail::LoadBalancerTlsCertificate' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.CertificateName') as certificate_name, + JSON_EXTRACT(Properties, '$.LoadBalancerName') as load_balancer_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::LoadBalancerTlsCertificate' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'LoadBalancerName') as load_balancer_name, + json_extract_path_text(Properties, 'CertificateName') as certificate_name, + json_extract_path_text(Properties, 'CertificateDomainName') as certificate_domain_name, + json_extract_path_text(Properties, 'CertificateAlternativeNames') as certificate_alternative_names, + json_extract_path_text(Properties, 'LoadBalancerTlsCertificateArn') as load_balancer_tls_certificate_arn, + json_extract_path_text(Properties, 'IsAttached') as is_attached, + json_extract_path_text(Properties, 'HttpsRedirectionEnabled') as https_redirection_enabled, + json_extract_path_text(Properties, 'Status') as status + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Lightsail::LoadBalancerTlsCertificate' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'CertificateName') as certificate_name, + json_extract_path_text(Properties, 'LoadBalancerName') as load_balancer_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::LoadBalancerTlsCertificate' + AND region = 'us-east-1' static_ips: name: static_ips id: aws.lightsail.static_ips @@ -3524,7 +3430,7 @@ components: x-cfn-type-name: AWS::Lightsail::StaticIp x-identifiers: - StaticIpName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3541,9 +3447,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3553,41 +3459,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/static_ips/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/static_ips/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.StaticIpName') as static_ip_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::StaticIp' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'StaticIpName') as static_ip_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::StaticIp' - AND region = 'us-east-1' - static_ip: - name: static_ip - id: aws.lightsail.static_ip - x-cfn-schema-name: StaticIp - x-cfn-type-name: AWS::Lightsail::StaticIp - x-identifiers: - - StaticIpName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3598,12 +3472,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/static_ips/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/static_ips/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/static_ip/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/static_ips/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3617,19 +3495,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'StaticIpName') as static_ip_name, - json_extract_path_text(Properties, 'AttachedTo') as attached_to, - json_extract_path_text(Properties, 'IsAttached') as is_attached, - json_extract_path_text(Properties, 'IpAddress') as ip_address, - json_extract_path_text(Properties, 'StaticIpArn') as static_ip_arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Lightsail::StaticIp' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.StaticIpName') as static_ip_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::StaticIp' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'StaticIpName') as static_ip_name, + json_extract_path_text(Properties, 'AttachedTo') as attached_to, + json_extract_path_text(Properties, 'IsAttached') as is_attached, + json_extract_path_text(Properties, 'IpAddress') as ip_address, + json_extract_path_text(Properties, 'StaticIpArn') as static_ip_arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Lightsail::StaticIp' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'StaticIpName') as static_ip_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Lightsail::StaticIp' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/location.yaml b/providers/src/aws/v00.00.00000/services/location.yaml index 3d380ee6..c129f19d 100644 --- a/providers/src/aws/v00.00.00000/services/location.yaml +++ b/providers/src/aws/v00.00.00000/services/location.yaml @@ -403,7 +403,7 @@ components: items: type: string maxLength: 1600 - pattern: ^arn(:[a-z0-9]+([.-][a-z0-9]+)*):geo(:([a-z0-9]+([.-][a-z0-9]+)*))(:[0-9]+):((\*)|([-a-z]+[/][*-._\w]+))$ + pattern: (^arn(:[a-z0-9]+([.-][a-z0-9]+)*):geo(:([a-z0-9]+([.-][a-z0-9]+)*))(:[0-9]+):((\*)|([-a-z]+[/][*-._\w]+))$)|(^arn(:[a-z0-9]+([.-][a-z0-9]+)*):(geo-routes|geo-places|geo-maps)(:((\*)|([a-z0-9]+([.-][a-z0-9]+)*)))::((provider[\/][*-._\w]+))$) maxItems: 5 minItems: 1 x-insertionOrder: false @@ -594,6 +594,7 @@ components: $ref: '#/components/schemas/PricingPlan' PricingPlanDataSource: type: string + description: 'This shape is deprecated since 2022-02-01: Deprecated. No longer allowed.' Tags: description: An array of key-value pairs to apply to this resource. type: array @@ -965,6 +966,7 @@ components: $ref: '#/components/schemas/PricingPlan' PricingPlanDataSource: type: string + description: 'This shape is deprecated since 2022-02-01: Deprecated. No longer allowed.' Tags: description: An array of key-value pairs to apply to this resource. type: array @@ -1172,6 +1174,7 @@ components: $ref: '#/components/schemas/PricingPlan' PricingPlanDataSource: type: string + description: 'This shape is deprecated since 2022-02-01: Deprecated. No longer allowed.' Tags: description: An array of key-value pairs to apply to this resource. type: array @@ -1379,6 +1382,7 @@ components: $ref: '#/components/schemas/PricingPlan' PricingPlanDataSource: type: string + description: 'This shape is deprecated since 2022-02-01: Deprecated. No longer allowed.' Tags: description: An array of key-value pairs to apply to this resource. type: array @@ -1448,7 +1452,7 @@ components: x-cfn-type-name: AWS::Location::APIKey x-identifiers: - KeyName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1465,9 +1469,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1477,41 +1481,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/api_keys/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/api_keys/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.KeyName') as key_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Location::APIKey' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'KeyName') as key_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Location::APIKey' - AND region = 'us-east-1' - api_key: - name: api_key - id: aws.location.api_key - x-cfn-schema-name: APIKey - x-cfn-type-name: AWS::Location::APIKey - x-identifiers: - - KeyName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1522,12 +1494,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/api_keys/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/api_keys/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/api_key/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/api_keys/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1548,26 +1524,42 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'CreateTime') as create_time, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'ExpireTime') as expire_time, - json_extract_path_text(Properties, 'ForceUpdate') as force_update, - json_extract_path_text(Properties, 'KeyArn') as key_arn, - json_extract_path_text(Properties, 'KeyName') as key_name, - json_extract_path_text(Properties, 'NoExpiry') as no_expiry, - json_extract_path_text(Properties, 'Restrictions') as restrictions, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'UpdateTime') as update_time, - json_extract_path_text(Properties, 'ForceDelete') as force_delete, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Location::APIKey' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.KeyName') as key_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Location::APIKey' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'CreateTime') as create_time, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'ExpireTime') as expire_time, + json_extract_path_text(Properties, 'ForceUpdate') as force_update, + json_extract_path_text(Properties, 'KeyArn') as key_arn, + json_extract_path_text(Properties, 'KeyName') as key_name, + json_extract_path_text(Properties, 'NoExpiry') as no_expiry, + json_extract_path_text(Properties, 'Restrictions') as restrictions, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'UpdateTime') as update_time, + json_extract_path_text(Properties, 'ForceDelete') as force_delete, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Location::APIKey' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'KeyName') as key_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Location::APIKey' + AND region = 'us-east-1' geofence_collections: name: geofence_collections id: aws.location.geofence_collections @@ -1575,7 +1567,7 @@ components: x-cfn-type-name: AWS::Location::GeofenceCollection x-identifiers: - CollectionName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1592,9 +1584,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1604,41 +1596,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/geofence_collections/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/geofence_collections/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.CollectionName') as collection_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Location::GeofenceCollection' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'CollectionName') as collection_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Location::GeofenceCollection' - AND region = 'us-east-1' - geofence_collection: - name: geofence_collection - id: aws.location.geofence_collection - x-cfn-schema-name: GeofenceCollection - x-cfn-type-name: AWS::Location::GeofenceCollection - x-identifiers: - - CollectionName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1649,12 +1609,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/geofence_collections/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/geofence_collections/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/geofence_collection/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/geofence_collections/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1673,24 +1637,40 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'CollectionArn') as collection_arn, - json_extract_path_text(Properties, 'CollectionName') as collection_name, - json_extract_path_text(Properties, 'CreateTime') as create_time, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, - json_extract_path_text(Properties, 'PricingPlan') as pricing_plan, - json_extract_path_text(Properties, 'PricingPlanDataSource') as pricing_plan_data_source, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'UpdateTime') as update_time, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Location::GeofenceCollection' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.CollectionName') as collection_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Location::GeofenceCollection' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'CollectionArn') as collection_arn, + json_extract_path_text(Properties, 'CollectionName') as collection_name, + json_extract_path_text(Properties, 'CreateTime') as create_time, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, + json_extract_path_text(Properties, 'PricingPlan') as pricing_plan, + json_extract_path_text(Properties, 'PricingPlanDataSource') as pricing_plan_data_source, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'UpdateTime') as update_time, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Location::GeofenceCollection' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'CollectionName') as collection_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Location::GeofenceCollection' + AND region = 'us-east-1' maps: name: maps id: aws.location.maps @@ -1698,7 +1678,7 @@ components: x-cfn-type-name: AWS::Location::Map x-identifiers: - MapName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1715,9 +1695,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1727,41 +1707,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/maps/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/maps/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.MapName') as map_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Location::Map' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'MapName') as map_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Location::Map' - AND region = 'us-east-1' - map: - name: map - id: aws.location.map - x-cfn-schema-name: Map - x-cfn-type-name: AWS::Location::Map - x-identifiers: - - MapName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1772,12 +1720,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/maps/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/maps/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/map/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/maps/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1795,23 +1747,39 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Configuration') as configuration, - json_extract_path_text(Properties, 'CreateTime') as create_time, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'MapArn') as map_arn, - json_extract_path_text(Properties, 'MapName') as map_name, - json_extract_path_text(Properties, 'PricingPlan') as pricing_plan, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'UpdateTime') as update_time, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Location::Map' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.MapName') as map_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Location::Map' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Configuration') as configuration, + json_extract_path_text(Properties, 'CreateTime') as create_time, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'MapArn') as map_arn, + json_extract_path_text(Properties, 'MapName') as map_name, + json_extract_path_text(Properties, 'PricingPlan') as pricing_plan, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'UpdateTime') as update_time, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Location::Map' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'MapName') as map_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Location::Map' + AND region = 'us-east-1' place_indices: name: place_indices id: aws.location.place_indices @@ -1819,7 +1787,7 @@ components: x-cfn-type-name: AWS::Location::PlaceIndex x-identifiers: - IndexName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1836,9 +1804,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1848,41 +1816,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/place_indices/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/place_indices/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.IndexName') as index_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Location::PlaceIndex' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'IndexName') as index_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Location::PlaceIndex' - AND region = 'us-east-1' - place_index: - name: place_index - id: aws.location.place_index - x-cfn-schema-name: PlaceIndex - x-cfn-type-name: AWS::Location::PlaceIndex - x-identifiers: - - IndexName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1893,12 +1829,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/place_indices/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/place_indices/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/place_index/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/place_indices/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1917,24 +1857,40 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'CreateTime') as create_time, - json_extract_path_text(Properties, 'DataSource') as data_source, - json_extract_path_text(Properties, 'DataSourceConfiguration') as data_source_configuration, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'IndexArn') as index_arn, - json_extract_path_text(Properties, 'IndexName') as index_name, - json_extract_path_text(Properties, 'PricingPlan') as pricing_plan, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'UpdateTime') as update_time, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Location::PlaceIndex' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.IndexName') as index_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Location::PlaceIndex' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'CreateTime') as create_time, + json_extract_path_text(Properties, 'DataSource') as data_source, + json_extract_path_text(Properties, 'DataSourceConfiguration') as data_source_configuration, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'IndexArn') as index_arn, + json_extract_path_text(Properties, 'IndexName') as index_name, + json_extract_path_text(Properties, 'PricingPlan') as pricing_plan, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'UpdateTime') as update_time, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Location::PlaceIndex' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'IndexName') as index_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Location::PlaceIndex' + AND region = 'us-east-1' route_calculators: name: route_calculators id: aws.location.route_calculators @@ -1942,7 +1898,7 @@ components: x-cfn-type-name: AWS::Location::RouteCalculator x-identifiers: - CalculatorName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1959,9 +1915,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1971,41 +1927,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/route_calculators/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/route_calculators/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.CalculatorName') as calculator_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Location::RouteCalculator' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'CalculatorName') as calculator_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Location::RouteCalculator' - AND region = 'us-east-1' - route_calculator: - name: route_calculator - id: aws.location.route_calculator - x-cfn-schema-name: RouteCalculator - x-cfn-type-name: AWS::Location::RouteCalculator - x-identifiers: - - CalculatorName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2016,12 +1940,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/route_calculators/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/route_calculators/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/route_calculator/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/route_calculators/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2039,23 +1967,39 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'CalculatorArn') as calculator_arn, - json_extract_path_text(Properties, 'CalculatorName') as calculator_name, - json_extract_path_text(Properties, 'CreateTime') as create_time, - json_extract_path_text(Properties, 'DataSource') as data_source, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'PricingPlan') as pricing_plan, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'UpdateTime') as update_time, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Location::RouteCalculator' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.CalculatorName') as calculator_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Location::RouteCalculator' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'CalculatorArn') as calculator_arn, + json_extract_path_text(Properties, 'CalculatorName') as calculator_name, + json_extract_path_text(Properties, 'CreateTime') as create_time, + json_extract_path_text(Properties, 'DataSource') as data_source, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'PricingPlan') as pricing_plan, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'UpdateTime') as update_time, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Location::RouteCalculator' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'CalculatorName') as calculator_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Location::RouteCalculator' + AND region = 'us-east-1' trackers: name: trackers id: aws.location.trackers @@ -2063,7 +2007,7 @@ components: x-cfn-type-name: AWS::Location::Tracker x-identifiers: - TrackerName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2080,9 +2024,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2092,41 +2036,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/trackers/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/trackers/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.TrackerName') as tracker_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Location::Tracker' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'TrackerName') as tracker_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Location::Tracker' - AND region = 'us-east-1' - tracker: - name: tracker - id: aws.location.tracker - x-cfn-schema-name: Tracker - x-cfn-type-name: AWS::Location::Tracker - x-identifiers: - - TrackerName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2137,12 +2049,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/trackers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/trackers/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/tracker/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/trackers/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2164,27 +2080,43 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'CreateTime') as create_time, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'EventBridgeEnabled') as event_bridge_enabled, - json_extract_path_text(Properties, 'KmsKeyEnableGeospatialQueries') as kms_key_enable_geospatial_queries, - json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, - json_extract_path_text(Properties, 'PositionFiltering') as position_filtering, - json_extract_path_text(Properties, 'PricingPlan') as pricing_plan, - json_extract_path_text(Properties, 'PricingPlanDataSource') as pricing_plan_data_source, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'TrackerArn') as tracker_arn, - json_extract_path_text(Properties, 'TrackerName') as tracker_name, - json_extract_path_text(Properties, 'UpdateTime') as update_time, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Location::Tracker' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.TrackerName') as tracker_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Location::Tracker' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'CreateTime') as create_time, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'EventBridgeEnabled') as event_bridge_enabled, + json_extract_path_text(Properties, 'KmsKeyEnableGeospatialQueries') as kms_key_enable_geospatial_queries, + json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, + json_extract_path_text(Properties, 'PositionFiltering') as position_filtering, + json_extract_path_text(Properties, 'PricingPlan') as pricing_plan, + json_extract_path_text(Properties, 'PricingPlanDataSource') as pricing_plan_data_source, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'TrackerArn') as tracker_arn, + json_extract_path_text(Properties, 'TrackerName') as tracker_name, + json_extract_path_text(Properties, 'UpdateTime') as update_time, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Location::Tracker' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'TrackerName') as tracker_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Location::Tracker' + AND region = 'us-east-1' tracker_consumers: name: tracker_consumers id: aws.location.tracker_consumers @@ -2193,7 +2125,7 @@ components: x-identifiers: - TrackerName - ConsumerArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2227,42 +2159,11 @@ components: - $ref: '#/components/x-stackQL-resources/tracker_consumers/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/tracker_consumers/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.TrackerName') as tracker_name, - JSON_EXTRACT(Properties, '$.ConsumerArn') as consumer_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Location::TrackerConsumer' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'TrackerName') as tracker_name, - json_extract_path_text(Properties, 'ConsumerArn') as consumer_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Location::TrackerConsumer' - AND region = 'us-east-1' - tracker_consumer: - name: tracker_consumer - id: aws.location.tracker_consumer - x-cfn-schema-name: TrackerConsumer - x-cfn-type-name: AWS::Location::TrackerConsumer - x-identifiers: - - TrackerName - - ConsumerArn - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2273,16 +2174,34 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ConsumerArn') as consumer_arn, - json_extract_path_text(Properties, 'TrackerName') as tracker_name - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Location::TrackerConsumer' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.TrackerName') as tracker_name, + JSON_EXTRACT(Properties, '$.ConsumerArn') as consumer_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Location::TrackerConsumer' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ConsumerArn') as consumer_arn, + json_extract_path_text(Properties, 'TrackerName') as tracker_name + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Location::TrackerConsumer' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'TrackerName') as tracker_name, + json_extract_path_text(Properties, 'ConsumerArn') as consumer_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Location::TrackerConsumer' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/logs.yaml b/providers/src/aws/v00.00.00000/services/logs.yaml index e1f50e71..d81f13b0 100644 --- a/providers/src/aws/v00.00.00000/services/logs.yaml +++ b/providers/src/aws/v00.00.00000/services/logs.yaml @@ -1789,7 +1789,7 @@ components: - AccountId - PolicyType - PolicyName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1806,9 +1806,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1818,47 +1818,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/account_policies/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/account_policies/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AccountId') as account_id, - JSON_EXTRACT(Properties, '$.PolicyType') as policy_type, - JSON_EXTRACT(Properties, '$.PolicyName') as policy_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::AccountPolicy' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AccountId') as account_id, - json_extract_path_text(Properties, 'PolicyType') as policy_type, - json_extract_path_text(Properties, 'PolicyName') as policy_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::AccountPolicy' - AND region = 'us-east-1' - account_policy: - name: account_policy - id: aws.logs.account_policy - x-cfn-schema-name: AccountPolicy - x-cfn-type-name: AWS::Logs::AccountPolicy - x-identifiers: - - AccountId - - PolicyType - - PolicyName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1869,12 +1831,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/account_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/account_policies/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/account_policy/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/account_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1889,20 +1855,40 @@ components: AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AccountId') as account_id, - json_extract_path_text(Properties, 'PolicyName') as policy_name, - json_extract_path_text(Properties, 'PolicyDocument') as policy_document, - json_extract_path_text(Properties, 'PolicyType') as policy_type, - json_extract_path_text(Properties, 'Scope') as scope, - json_extract_path_text(Properties, 'SelectionCriteria') as selection_criteria - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Logs::AccountPolicy' - AND data__Identifier = '||' + JSON_EXTRACT(Properties, '$.AccountId') as account_id, + JSON_EXTRACT(Properties, '$.PolicyType') as policy_type, + JSON_EXTRACT(Properties, '$.PolicyName') as policy_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::AccountPolicy' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AccountId') as account_id, + json_extract_path_text(Properties, 'PolicyName') as policy_name, + json_extract_path_text(Properties, 'PolicyDocument') as policy_document, + json_extract_path_text(Properties, 'PolicyType') as policy_type, + json_extract_path_text(Properties, 'Scope') as scope, + json_extract_path_text(Properties, 'SelectionCriteria') as selection_criteria + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Logs::AccountPolicy' + AND data__Identifier = '||' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AccountId') as account_id, + json_extract_path_text(Properties, 'PolicyType') as policy_type, + json_extract_path_text(Properties, 'PolicyName') as policy_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::AccountPolicy' + AND region = 'us-east-1' deliveries: name: deliveries id: aws.logs.deliveries @@ -1910,7 +1896,7 @@ components: x-cfn-type-name: AWS::Logs::Delivery x-identifiers: - DeliveryId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1927,9 +1913,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1939,41 +1925,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/deliveries/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/deliveries/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.DeliveryId') as delivery_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::Delivery' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'DeliveryId') as delivery_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::Delivery' - AND region = 'us-east-1' - delivery: - name: delivery - id: aws.logs.delivery - x-cfn-schema-name: Delivery - x-cfn-type-name: AWS::Logs::Delivery - x-identifiers: - - DeliveryId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1984,12 +1938,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/deliveries/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/deliveries/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/delivery/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/deliveries/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2004,20 +1962,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'DeliveryId') as delivery_id, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'DeliverySourceName') as delivery_source_name, - json_extract_path_text(Properties, 'DeliveryDestinationArn') as delivery_destination_arn, - json_extract_path_text(Properties, 'DeliveryDestinationType') as delivery_destination_type, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Logs::Delivery' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.DeliveryId') as delivery_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::Delivery' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DeliveryId') as delivery_id, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'DeliverySourceName') as delivery_source_name, + json_extract_path_text(Properties, 'DeliveryDestinationArn') as delivery_destination_arn, + json_extract_path_text(Properties, 'DeliveryDestinationType') as delivery_destination_type, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Logs::Delivery' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DeliveryId') as delivery_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::Delivery' + AND region = 'us-east-1' delivery_destinations: name: delivery_destinations id: aws.logs.delivery_destinations @@ -2025,7 +1999,7 @@ components: x-cfn-type-name: AWS::Logs::DeliveryDestination x-identifiers: - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2042,9 +2016,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2054,41 +2028,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/delivery_destinations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/delivery_destinations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::DeliveryDestination' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::DeliveryDestination' - AND region = 'us-east-1' - delivery_destination: - name: delivery_destination - id: aws.logs.delivery_destination - x-cfn-schema-name: DeliveryDestination - x-cfn-type-name: AWS::Logs::DeliveryDestination - x-identifiers: - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2099,12 +2041,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/delivery_destinations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/delivery_destinations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/delivery_destination/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/delivery_destinations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2119,20 +2065,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'DestinationResourceArn') as destination_resource_arn, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'DeliveryDestinationType') as delivery_destination_type, - json_extract_path_text(Properties, 'DeliveryDestinationPolicy') as delivery_destination_policy - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Logs::DeliveryDestination' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::DeliveryDestination' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'DestinationResourceArn') as destination_resource_arn, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'DeliveryDestinationType') as delivery_destination_type, + json_extract_path_text(Properties, 'DeliveryDestinationPolicy') as delivery_destination_policy + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Logs::DeliveryDestination' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::DeliveryDestination' + AND region = 'us-east-1' delivery_sources: name: delivery_sources id: aws.logs.delivery_sources @@ -2140,7 +2102,7 @@ components: x-cfn-type-name: AWS::Logs::DeliverySource x-identifiers: - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2157,9 +2119,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2169,41 +2131,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/delivery_sources/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/delivery_sources/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::DeliverySource' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::DeliverySource' - AND region = 'us-east-1' - delivery_source: - name: delivery_source - id: aws.logs.delivery_source - x-cfn-schema-name: DeliverySource - x-cfn-type-name: AWS::Logs::DeliverySource - x-identifiers: - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2214,12 +2144,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/delivery_sources/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/delivery_sources/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/delivery_source/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/delivery_sources/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2235,21 +2169,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'ResourceArns') as resource_arns, - json_extract_path_text(Properties, 'ResourceArn') as resource_arn, - json_extract_path_text(Properties, 'Service') as service, - json_extract_path_text(Properties, 'LogType') as log_type, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Logs::DeliverySource' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::DeliverySource' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'ResourceArns') as resource_arns, + json_extract_path_text(Properties, 'ResourceArn') as resource_arn, + json_extract_path_text(Properties, 'Service') as service, + json_extract_path_text(Properties, 'LogType') as log_type, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Logs::DeliverySource' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::DeliverySource' + AND region = 'us-east-1' destinations: name: destinations id: aws.logs.destinations @@ -2257,7 +2207,7 @@ components: x-cfn-type-name: AWS::Logs::Destination x-identifiers: - DestinationName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2274,9 +2224,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2286,41 +2236,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/destinations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/destinations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.DestinationName') as destination_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::Destination' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'DestinationName') as destination_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::Destination' - AND region = 'us-east-1' - destination: - name: destination - id: aws.logs.destination - x-cfn-schema-name: Destination - x-cfn-type-name: AWS::Logs::Destination - x-identifiers: - - DestinationName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2331,12 +2249,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/destinations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/destinations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/destination/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/destinations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2350,19 +2272,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'DestinationName') as destination_name, - json_extract_path_text(Properties, 'DestinationPolicy') as destination_policy, - json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'TargetArn') as target_arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Logs::Destination' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.DestinationName') as destination_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::Destination' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'DestinationName') as destination_name, + json_extract_path_text(Properties, 'DestinationPolicy') as destination_policy, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'TargetArn') as target_arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Logs::Destination' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DestinationName') as destination_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::Destination' + AND region = 'us-east-1' log_anomaly_detectors: name: log_anomaly_detectors id: aws.logs.log_anomaly_detectors @@ -2370,7 +2308,7 @@ components: x-cfn-type-name: AWS::Logs::LogAnomalyDetector x-identifiers: - AnomalyDetectorArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2387,9 +2325,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2399,41 +2337,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/log_anomaly_detectors/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/log_anomaly_detectors/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AnomalyDetectorArn') as anomaly_detector_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::LogAnomalyDetector' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AnomalyDetectorArn') as anomaly_detector_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::LogAnomalyDetector' - AND region = 'us-east-1' - log_anomaly_detector: - name: log_anomaly_detector - id: aws.logs.log_anomaly_detector - x-cfn-schema-name: LogAnomalyDetector - x-cfn-type-name: AWS::Logs::LogAnomalyDetector - x-identifiers: - - AnomalyDetectorArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2444,12 +2350,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/log_anomaly_detectors/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/log_anomaly_detectors/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/log_anomaly_detector/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/log_anomaly_detectors/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2469,25 +2379,41 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AccountId') as account_id, - json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, - json_extract_path_text(Properties, 'DetectorName') as detector_name, - json_extract_path_text(Properties, 'LogGroupArnList') as log_group_arn_list, - json_extract_path_text(Properties, 'EvaluationFrequency') as evaluation_frequency, - json_extract_path_text(Properties, 'FilterPattern') as filter_pattern, - json_extract_path_text(Properties, 'AnomalyDetectorStatus') as anomaly_detector_status, - json_extract_path_text(Properties, 'AnomalyVisibilityTime') as anomaly_visibility_time, - json_extract_path_text(Properties, 'CreationTimeStamp') as creation_time_stamp, - json_extract_path_text(Properties, 'LastModifiedTimeStamp') as last_modified_time_stamp, - json_extract_path_text(Properties, 'AnomalyDetectorArn') as anomaly_detector_arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Logs::LogAnomalyDetector' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.AnomalyDetectorArn') as anomaly_detector_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::LogAnomalyDetector' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AccountId') as account_id, + json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, + json_extract_path_text(Properties, 'DetectorName') as detector_name, + json_extract_path_text(Properties, 'LogGroupArnList') as log_group_arn_list, + json_extract_path_text(Properties, 'EvaluationFrequency') as evaluation_frequency, + json_extract_path_text(Properties, 'FilterPattern') as filter_pattern, + json_extract_path_text(Properties, 'AnomalyDetectorStatus') as anomaly_detector_status, + json_extract_path_text(Properties, 'AnomalyVisibilityTime') as anomaly_visibility_time, + json_extract_path_text(Properties, 'CreationTimeStamp') as creation_time_stamp, + json_extract_path_text(Properties, 'LastModifiedTimeStamp') as last_modified_time_stamp, + json_extract_path_text(Properties, 'AnomalyDetectorArn') as anomaly_detector_arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Logs::LogAnomalyDetector' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AnomalyDetectorArn') as anomaly_detector_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::LogAnomalyDetector' + AND region = 'us-east-1' log_streams: name: log_streams id: aws.logs.log_streams @@ -2496,7 +2422,7 @@ components: x-identifiers: - LogGroupName - LogStreamName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2530,42 +2456,11 @@ components: - $ref: '#/components/x-stackQL-resources/log_streams/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/log_streams/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.LogGroupName') as log_group_name, - JSON_EXTRACT(Properties, '$.LogStreamName') as log_stream_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::LogStream' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'LogGroupName') as log_group_name, - json_extract_path_text(Properties, 'LogStreamName') as log_stream_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::LogStream' - AND region = 'us-east-1' - log_stream: - name: log_stream - id: aws.logs.log_stream - x-cfn-schema-name: LogStream - x-cfn-type-name: AWS::Logs::LogStream - x-identifiers: - - LogGroupName - - LogStreamName - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2576,16 +2471,34 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'LogStreamName') as log_stream_name, - json_extract_path_text(Properties, 'LogGroupName') as log_group_name - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Logs::LogStream' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.LogGroupName') as log_group_name, + JSON_EXTRACT(Properties, '$.LogStreamName') as log_stream_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::LogStream' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'LogStreamName') as log_stream_name, + json_extract_path_text(Properties, 'LogGroupName') as log_group_name + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Logs::LogStream' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'LogGroupName') as log_group_name, + json_extract_path_text(Properties, 'LogStreamName') as log_stream_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::LogStream' + AND region = 'us-east-1' metric_filters: name: metric_filters id: aws.logs.metric_filters @@ -2594,7 +2507,7 @@ components: x-identifiers: - LogGroupName - FilterName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2611,9 +2524,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2623,44 +2536,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/metric_filters/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/metric_filters/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.LogGroupName') as log_group_name, - JSON_EXTRACT(Properties, '$.FilterName') as filter_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::MetricFilter' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'LogGroupName') as log_group_name, - json_extract_path_text(Properties, 'FilterName') as filter_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::MetricFilter' - AND region = 'us-east-1' - metric_filter: - name: metric_filter - id: aws.logs.metric_filter - x-cfn-schema-name: MetricFilter - x-cfn-type-name: AWS::Logs::MetricFilter - x-identifiers: - - LogGroupName - - FilterName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2671,12 +2549,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/metric_filters/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/metric_filters/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/metric_filter/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/metric_filters/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2689,18 +2571,36 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'MetricTransformations') as metric_transformations, - json_extract_path_text(Properties, 'FilterPattern') as filter_pattern, - json_extract_path_text(Properties, 'LogGroupName') as log_group_name, - json_extract_path_text(Properties, 'FilterName') as filter_name - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Logs::MetricFilter' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.LogGroupName') as log_group_name, + JSON_EXTRACT(Properties, '$.FilterName') as filter_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::MetricFilter' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'MetricTransformations') as metric_transformations, + json_extract_path_text(Properties, 'FilterPattern') as filter_pattern, + json_extract_path_text(Properties, 'LogGroupName') as log_group_name, + json_extract_path_text(Properties, 'FilterName') as filter_name + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Logs::MetricFilter' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'LogGroupName') as log_group_name, + json_extract_path_text(Properties, 'FilterName') as filter_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::MetricFilter' + AND region = 'us-east-1' query_definitions: name: query_definitions id: aws.logs.query_definitions @@ -2708,7 +2608,7 @@ components: x-cfn-type-name: AWS::Logs::QueryDefinition x-identifiers: - QueryDefinitionId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2725,9 +2625,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2737,41 +2637,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/query_definitions/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/query_definitions/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.QueryDefinitionId') as query_definition_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::QueryDefinition' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'QueryDefinitionId') as query_definition_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::QueryDefinition' - AND region = 'us-east-1' - query_definition: - name: query_definition - id: aws.logs.query_definition - x-cfn-schema-name: QueryDefinition - x-cfn-type-name: AWS::Logs::QueryDefinition - x-identifiers: - - QueryDefinitionId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2782,12 +2650,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/query_definitions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/query_definitions/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/query_definition/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/query_definitions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2800,18 +2672,34 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'QueryString') as query_string, - json_extract_path_text(Properties, 'LogGroupNames') as log_group_names, - json_extract_path_text(Properties, 'QueryDefinitionId') as query_definition_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Logs::QueryDefinition' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.QueryDefinitionId') as query_definition_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::QueryDefinition' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'QueryString') as query_string, + json_extract_path_text(Properties, 'LogGroupNames') as log_group_names, + json_extract_path_text(Properties, 'QueryDefinitionId') as query_definition_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Logs::QueryDefinition' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'QueryDefinitionId') as query_definition_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::QueryDefinition' + AND region = 'us-east-1' resource_policies: name: resource_policies id: aws.logs.resource_policies @@ -2819,7 +2707,7 @@ components: x-cfn-type-name: AWS::Logs::ResourcePolicy x-identifiers: - PolicyName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2836,9 +2724,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2848,41 +2736,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/resource_policies/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/resource_policies/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.PolicyName') as policy_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::ResourcePolicy' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'PolicyName') as policy_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::ResourcePolicy' - AND region = 'us-east-1' - resource_policy: - name: resource_policy - id: aws.logs.resource_policy - x-cfn-schema-name: ResourcePolicy - x-cfn-type-name: AWS::Logs::ResourcePolicy - x-identifiers: - - PolicyName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2893,12 +2749,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/resource_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/resource_policies/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/resource_policy/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/resource_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2909,16 +2769,32 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'PolicyName') as policy_name, - json_extract_path_text(Properties, 'PolicyDocument') as policy_document - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Logs::ResourcePolicy' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.PolicyName') as policy_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::ResourcePolicy' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'PolicyName') as policy_name, + json_extract_path_text(Properties, 'PolicyDocument') as policy_document + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Logs::ResourcePolicy' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'PolicyName') as policy_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::ResourcePolicy' + AND region = 'us-east-1' subscription_filters: name: subscription_filters id: aws.logs.subscription_filters @@ -2927,7 +2803,7 @@ components: x-identifiers: - FilterName - LogGroupName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2944,9 +2820,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2956,44 +2832,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/subscription_filters/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/subscription_filters/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.FilterName') as filter_name, - JSON_EXTRACT(Properties, '$.LogGroupName') as log_group_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::SubscriptionFilter' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'FilterName') as filter_name, - json_extract_path_text(Properties, 'LogGroupName') as log_group_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::SubscriptionFilter' - AND region = 'us-east-1' - subscription_filter: - name: subscription_filter - id: aws.logs.subscription_filter - x-cfn-schema-name: SubscriptionFilter - x-cfn-type-name: AWS::Logs::SubscriptionFilter - x-identifiers: - - FilterName - - LogGroupName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3004,12 +2845,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/subscription_filters/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/subscription_filters/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/subscription_filter/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/subscription_filters/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3024,20 +2869,38 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'FilterName') as filter_name, - json_extract_path_text(Properties, 'DestinationArn') as destination_arn, - json_extract_path_text(Properties, 'FilterPattern') as filter_pattern, - json_extract_path_text(Properties, 'LogGroupName') as log_group_name, - json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'Distribution') as distribution - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Logs::SubscriptionFilter' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.FilterName') as filter_name, + JSON_EXTRACT(Properties, '$.LogGroupName') as log_group_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::SubscriptionFilter' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'FilterName') as filter_name, + json_extract_path_text(Properties, 'DestinationArn') as destination_arn, + json_extract_path_text(Properties, 'FilterPattern') as filter_pattern, + json_extract_path_text(Properties, 'LogGroupName') as log_group_name, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'Distribution') as distribution + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Logs::SubscriptionFilter' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'FilterName') as filter_name, + json_extract_path_text(Properties, 'LogGroupName') as log_group_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Logs::SubscriptionFilter' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/lookoutequipment.yaml b/providers/src/aws/v00.00.00000/services/lookoutequipment.yaml index 7d04db24..e697233e 100644 --- a/providers/src/aws/v00.00.00000/services/lookoutequipment.yaml +++ b/providers/src/aws/v00.00.00000/services/lookoutequipment.yaml @@ -692,7 +692,7 @@ components: x-cfn-type-name: AWS::LookoutEquipment::InferenceScheduler x-identifiers: - InferenceSchedulerName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -709,9 +709,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -721,41 +721,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/inference_schedulers/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/inference_schedulers/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.InferenceSchedulerName') as inference_scheduler_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::LookoutEquipment::InferenceScheduler' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'InferenceSchedulerName') as inference_scheduler_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::LookoutEquipment::InferenceScheduler' - AND region = 'us-east-1' - inference_scheduler: - name: inference_scheduler - id: aws.lookoutequipment.inference_scheduler - x-cfn-schema-name: InferenceScheduler - x-cfn-type-name: AWS::LookoutEquipment::InferenceScheduler - x-identifiers: - - InferenceSchedulerName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -766,12 +734,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/inference_schedulers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/inference_schedulers/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/inference_scheduler/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/inference_schedulers/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -790,24 +762,40 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'DataDelayOffsetInMinutes') as data_delay_offset_in_minutes, - json_extract_path_text(Properties, 'DataInputConfiguration') as data_input_configuration, - json_extract_path_text(Properties, 'DataOutputConfiguration') as data_output_configuration, - json_extract_path_text(Properties, 'DataUploadFrequency') as data_upload_frequency, - json_extract_path_text(Properties, 'InferenceSchedulerName') as inference_scheduler_name, - json_extract_path_text(Properties, 'ModelName') as model_name, - json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'ServerSideKmsKeyId') as server_side_kms_key_id, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'InferenceSchedulerArn') as inference_scheduler_arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::LookoutEquipment::InferenceScheduler' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.InferenceSchedulerName') as inference_scheduler_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::LookoutEquipment::InferenceScheduler' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DataDelayOffsetInMinutes') as data_delay_offset_in_minutes, + json_extract_path_text(Properties, 'DataInputConfiguration') as data_input_configuration, + json_extract_path_text(Properties, 'DataOutputConfiguration') as data_output_configuration, + json_extract_path_text(Properties, 'DataUploadFrequency') as data_upload_frequency, + json_extract_path_text(Properties, 'InferenceSchedulerName') as inference_scheduler_name, + json_extract_path_text(Properties, 'ModelName') as model_name, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'ServerSideKmsKeyId') as server_side_kms_key_id, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'InferenceSchedulerArn') as inference_scheduler_arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::LookoutEquipment::InferenceScheduler' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'InferenceSchedulerName') as inference_scheduler_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::LookoutEquipment::InferenceScheduler' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/lookoutmetrics.yaml b/providers/src/aws/v00.00.00000/services/lookoutmetrics.yaml index 95e5c70f..0b32c1c3 100644 --- a/providers/src/aws/v00.00.00000/services/lookoutmetrics.yaml +++ b/providers/src/aws/v00.00.00000/services/lookoutmetrics.yaml @@ -987,7 +987,7 @@ components: x-cfn-type-name: AWS::LookoutMetrics::Alert x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1021,39 +1021,11 @@ components: - $ref: '#/components/x-stackQL-resources/alerts/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/alerts/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::LookoutMetrics::Alert' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::LookoutMetrics::Alert' - AND region = 'us-east-1' - alert: - name: alert - id: aws.lookoutmetrics.alert - x-cfn-schema-name: Alert - x-cfn-type-name: AWS::LookoutMetrics::Alert - x-identifiers: - - Arn - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1068,20 +1040,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AlertName') as alert_name, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'AlertDescription') as alert_description, - json_extract_path_text(Properties, 'AnomalyDetectorArn') as anomaly_detector_arn, - json_extract_path_text(Properties, 'AlertSensitivityThreshold') as alert_sensitivity_threshold, - json_extract_path_text(Properties, 'Action') as action - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::LookoutMetrics::Alert' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::LookoutMetrics::Alert' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AlertName') as alert_name, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'AlertDescription') as alert_description, + json_extract_path_text(Properties, 'AnomalyDetectorArn') as anomaly_detector_arn, + json_extract_path_text(Properties, 'AlertSensitivityThreshold') as alert_sensitivity_threshold, + json_extract_path_text(Properties, 'Action') as action + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::LookoutMetrics::Alert' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::LookoutMetrics::Alert' + AND region = 'us-east-1' anomaly_detectors: name: anomaly_detectors id: aws.lookoutmetrics.anomaly_detectors @@ -1089,7 +1077,7 @@ components: x-cfn-type-name: AWS::LookoutMetrics::AnomalyDetector x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1106,9 +1094,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1118,41 +1106,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/anomaly_detectors/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/anomaly_detectors/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::LookoutMetrics::AnomalyDetector' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::LookoutMetrics::AnomalyDetector' - AND region = 'us-east-1' - anomaly_detector: - name: anomaly_detector - id: aws.lookoutmetrics.anomaly_detector - x-cfn-schema-name: AnomalyDetector - x-cfn-type-name: AWS::LookoutMetrics::AnomalyDetector - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1163,12 +1119,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/anomaly_detectors/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/anomaly_detectors/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/anomaly_detector/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/anomaly_detectors/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1183,20 +1143,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'AnomalyDetectorName') as anomaly_detector_name, - json_extract_path_text(Properties, 'AnomalyDetectorDescription') as anomaly_detector_description, - json_extract_path_text(Properties, 'AnomalyDetectorConfig') as anomaly_detector_config, - json_extract_path_text(Properties, 'MetricSetList') as metric_set_list, - json_extract_path_text(Properties, 'KmsKeyArn') as kms_key_arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::LookoutMetrics::AnomalyDetector' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::LookoutMetrics::AnomalyDetector' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'AnomalyDetectorName') as anomaly_detector_name, + json_extract_path_text(Properties, 'AnomalyDetectorDescription') as anomaly_detector_description, + json_extract_path_text(Properties, 'AnomalyDetectorConfig') as anomaly_detector_config, + json_extract_path_text(Properties, 'MetricSetList') as metric_set_list, + json_extract_path_text(Properties, 'KmsKeyArn') as kms_key_arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::LookoutMetrics::AnomalyDetector' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::LookoutMetrics::AnomalyDetector' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/lookoutvision.yaml b/providers/src/aws/v00.00.00000/services/lookoutvision.yaml index b631d076..2a787845 100644 --- a/providers/src/aws/v00.00.00000/services/lookoutvision.yaml +++ b/providers/src/aws/v00.00.00000/services/lookoutvision.yaml @@ -460,7 +460,7 @@ components: x-cfn-type-name: AWS::LookoutVision::Project x-identifiers: - ProjectName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -494,39 +494,11 @@ components: - $ref: '#/components/x-stackQL-resources/projects/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/projects/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ProjectName') as project_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::LookoutVision::Project' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ProjectName') as project_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::LookoutVision::Project' - AND region = 'us-east-1' - project: - name: project - id: aws.lookoutvision.project - x-cfn-schema-name: Project - x-cfn-type-name: AWS::LookoutVision::Project - x-identifiers: - - ProjectName - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -537,16 +509,32 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'ProjectName') as project_name - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::LookoutVision::Project' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ProjectName') as project_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::LookoutVision::Project' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'ProjectName') as project_name + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::LookoutVision::Project' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ProjectName') as project_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::LookoutVision::Project' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/m2.yaml b/providers/src/aws/v00.00.00000/services/m2.yaml index 042ccff3..73e6fc65 100644 --- a/providers/src/aws/v00.00.00000/services/m2.yaml +++ b/providers/src/aws/v00.00.00000/services/m2.yaml @@ -677,6 +677,7 @@ components: - ec2:ModifyNetworkInterfaceAttribute - elasticfilesystem:DescribeMountTargets - elasticloadbalancing:CreateLoadBalancer + - elasticloadbalancing:DeleteLoadBalancer - elasticloadbalancing:AddTags - fsx:DescribeFileSystems - iam:CreateServiceLinkedRole @@ -695,6 +696,7 @@ components: - m2:ListTagsForResource - m2:GetEnvironment - m2:UpdateEnvironment + - kms:DescribeKey delete: - elasticloadbalancing:DeleteLoadBalancer - m2:DeleteEnvironment @@ -839,7 +841,7 @@ components: x-cfn-type-name: AWS::M2::Application x-identifiers: - ApplicationArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -856,9 +858,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -868,41 +870,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/applications/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/applications/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ApplicationArn') as application_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::M2::Application' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ApplicationArn') as application_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::M2::Application' - AND region = 'us-east-1' - application: - name: application - id: aws.m2.application - x-cfn-schema-name: Application - x-cfn-type-name: AWS::M2::Application - x-identifiers: - - ApplicationArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -913,12 +883,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/applications/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/applications/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/application/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/applications/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -936,23 +910,39 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ApplicationArn') as application_arn, - json_extract_path_text(Properties, 'ApplicationId') as application_id, - json_extract_path_text(Properties, 'Definition') as definition, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'EngineType') as engine_type, - json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::M2::Application' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ApplicationArn') as application_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::M2::Application' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ApplicationArn') as application_arn, + json_extract_path_text(Properties, 'ApplicationId') as application_id, + json_extract_path_text(Properties, 'Definition') as definition, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'EngineType') as engine_type, + json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::M2::Application' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ApplicationArn') as application_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::M2::Application' + AND region = 'us-east-1' environments: name: environments id: aws.m2.environments @@ -960,7 +950,7 @@ components: x-cfn-type-name: AWS::M2::Environment x-identifiers: - EnvironmentArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -977,9 +967,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -989,41 +979,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/environments/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/environments/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.EnvironmentArn') as environment_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::M2::Environment' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'EnvironmentArn') as environment_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::M2::Environment' - AND region = 'us-east-1' - environment: - name: environment - id: aws.m2.environment - x-cfn-schema-name: Environment - x-cfn-type-name: AWS::M2::Environment - x-identifiers: - - EnvironmentArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1034,12 +992,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/environments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/environments/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/environment/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/environments/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1063,29 +1025,45 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'EngineType') as engine_type, - json_extract_path_text(Properties, 'EngineVersion') as engine_version, - json_extract_path_text(Properties, 'EnvironmentArn') as environment_arn, - json_extract_path_text(Properties, 'EnvironmentId') as environment_id, - json_extract_path_text(Properties, 'HighAvailabilityConfig') as high_availability_config, - json_extract_path_text(Properties, 'InstanceType') as instance_type, - json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'PreferredMaintenanceWindow') as preferred_maintenance_window, - json_extract_path_text(Properties, 'PubliclyAccessible') as publicly_accessible, - json_extract_path_text(Properties, 'SecurityGroupIds') as security_group_ids, - json_extract_path_text(Properties, 'StorageConfigurations') as storage_configurations, - json_extract_path_text(Properties, 'SubnetIds') as subnet_ids, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::M2::Environment' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.EnvironmentArn') as environment_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::M2::Environment' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'EngineType') as engine_type, + json_extract_path_text(Properties, 'EngineVersion') as engine_version, + json_extract_path_text(Properties, 'EnvironmentArn') as environment_arn, + json_extract_path_text(Properties, 'EnvironmentId') as environment_id, + json_extract_path_text(Properties, 'HighAvailabilityConfig') as high_availability_config, + json_extract_path_text(Properties, 'InstanceType') as instance_type, + json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'PreferredMaintenanceWindow') as preferred_maintenance_window, + json_extract_path_text(Properties, 'PubliclyAccessible') as publicly_accessible, + json_extract_path_text(Properties, 'SecurityGroupIds') as security_group_ids, + json_extract_path_text(Properties, 'StorageConfigurations') as storage_configurations, + json_extract_path_text(Properties, 'SubnetIds') as subnet_ids, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::M2::Environment' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'EnvironmentArn') as environment_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::M2::Environment' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/macie.yaml b/providers/src/aws/v00.00.00000/services/macie.yaml index db6b4d6d..92b3f591 100644 --- a/providers/src/aws/v00.00.00000/services/macie.yaml +++ b/providers/src/aws/v00.00.00000/services/macie.yaml @@ -946,7 +946,7 @@ components: x-cfn-type-name: AWS::Macie::AllowList x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -963,9 +963,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -975,41 +975,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/allow_lists/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/allow_lists/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Macie::AllowList' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Macie::AllowList' - AND region = 'us-east-1' - allow_list: - name: allow_list - id: aws.macie.allow_list - x-cfn-schema-name: AllowList - x-cfn-type-name: AWS::Macie::AllowList - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1020,12 +988,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/allow_lists/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/allow_lists/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/allow_list/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/allow_lists/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1041,21 +1013,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Criteria') as criteria, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Macie::AllowList' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Macie::AllowList' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Criteria') as criteria, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Macie::AllowList' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Macie::AllowList' + AND region = 'us-east-1' custom_data_identifiers: name: custom_data_identifiers id: aws.macie.custom_data_identifiers @@ -1063,7 +1051,7 @@ components: x-cfn-type-name: AWS::Macie::CustomDataIdentifier x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1080,9 +1068,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1092,41 +1080,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/custom_data_identifiers/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/custom_data_identifiers/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Macie::CustomDataIdentifier' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Macie::CustomDataIdentifier' - AND region = 'us-east-1' - custom_data_identifier: - name: custom_data_identifier - id: aws.macie.custom_data_identifier - x-cfn-schema-name: CustomDataIdentifier - x-cfn-type-name: AWS::Macie::CustomDataIdentifier - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1137,12 +1093,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/custom_data_identifiers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/custom_data_identifiers/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/custom_data_identifier/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/custom_data_identifiers/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1160,23 +1120,39 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Regex') as regex, - json_extract_path_text(Properties, 'MaximumMatchDistance') as maximum_match_distance, - json_extract_path_text(Properties, 'Keywords') as keywords, - json_extract_path_text(Properties, 'IgnoreWords') as ignore_words, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Macie::CustomDataIdentifier' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Macie::CustomDataIdentifier' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Regex') as regex, + json_extract_path_text(Properties, 'MaximumMatchDistance') as maximum_match_distance, + json_extract_path_text(Properties, 'Keywords') as keywords, + json_extract_path_text(Properties, 'IgnoreWords') as ignore_words, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Macie::CustomDataIdentifier' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Macie::CustomDataIdentifier' + AND region = 'us-east-1' findings_filters: name: findings_filters id: aws.macie.findings_filters @@ -1184,7 +1160,7 @@ components: x-cfn-type-name: AWS::Macie::FindingsFilter x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1201,9 +1177,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1213,41 +1189,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/findings_filters/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/findings_filters/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Macie::FindingsFilter' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Macie::FindingsFilter' - AND region = 'us-east-1' - findings_filter: - name: findings_filter - id: aws.macie.findings_filter - x-cfn-schema-name: FindingsFilter - x-cfn-type-name: AWS::Macie::FindingsFilter - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1258,12 +1202,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/findings_filters/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/findings_filters/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/findings_filter/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/findings_filters/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1280,22 +1228,38 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'FindingCriteria') as finding_criteria, - json_extract_path_text(Properties, 'Action') as action, - json_extract_path_text(Properties, 'Position') as position, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Macie::FindingsFilter' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Macie::FindingsFilter' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'FindingCriteria') as finding_criteria, + json_extract_path_text(Properties, 'Action') as action, + json_extract_path_text(Properties, 'Position') as position, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Macie::FindingsFilter' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Macie::FindingsFilter' + AND region = 'us-east-1' sessions: name: sessions id: aws.macie.sessions @@ -1303,7 +1267,7 @@ components: x-cfn-type-name: AWS::Macie::Session x-identifiers: - AwsAccountId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1320,9 +1284,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1332,41 +1296,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/sessions/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/sessions/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AwsAccountId') as aws_account_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Macie::Session' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Macie::Session' - AND region = 'us-east-1' - session: - name: session - id: aws.macie.session - x-cfn-schema-name: Session - x-cfn-type-name: AWS::Macie::Session - x-identifiers: - - AwsAccountId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1377,12 +1309,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/sessions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/sessions/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/session/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/sessions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1395,18 +1331,34 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'FindingPublishingFrequency') as finding_publishing_frequency, - json_extract_path_text(Properties, 'ServiceRole') as service_role - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Macie::Session' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.AwsAccountId') as aws_account_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Macie::Session' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'FindingPublishingFrequency') as finding_publishing_frequency, + json_extract_path_text(Properties, 'ServiceRole') as service_role + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Macie::Session' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Macie::Session' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/managedblockchain.yaml b/providers/src/aws/v00.00.00000/services/managedblockchain.yaml index 3e7e574d..e8fa08d6 100644 --- a/providers/src/aws/v00.00.00000/services/managedblockchain.yaml +++ b/providers/src/aws/v00.00.00000/services/managedblockchain.yaml @@ -557,7 +557,7 @@ components: x-cfn-type-name: AWS::ManagedBlockchain::Accessor x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -574,9 +574,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -586,41 +586,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/accessors/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/accessors/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ManagedBlockchain::Accessor' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ManagedBlockchain::Accessor' - AND region = 'us-east-1' - accessor: - name: accessor - id: aws.managedblockchain.accessor - x-cfn-schema-name: Accessor - x-cfn-type-name: AWS::ManagedBlockchain::Accessor - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -631,12 +599,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/accessors/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/accessors/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/accessor/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/accessors/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -653,22 +625,38 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'BillingToken') as billing_token, - json_extract_path_text(Properties, 'CreationDate') as creation_date, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'AccessorType') as accessor_type, - json_extract_path_text(Properties, 'NetworkType') as network_type, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ManagedBlockchain::Accessor' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ManagedBlockchain::Accessor' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'BillingToken') as billing_token, + json_extract_path_text(Properties, 'CreationDate') as creation_date, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'AccessorType') as accessor_type, + json_extract_path_text(Properties, 'NetworkType') as network_type, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ManagedBlockchain::Accessor' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ManagedBlockchain::Accessor' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/mediaconnect.yaml b/providers/src/aws/v00.00.00000/services/mediaconnect.yaml index 34f78b41..e7141e54 100644 --- a/providers/src/aws/v00.00.00000/services/mediaconnect.yaml +++ b/providers/src/aws/v00.00.00000/services/mediaconnect.yaml @@ -730,11 +730,9 @@ components: MaxLatency: type: integer description: The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams. - default: 2000 MinLatency: type: integer description: The minimum latency in milliseconds. - default: 2000 Name: type: string description: The name of the source. @@ -748,6 +746,8 @@ components: - fujitsu-qos - srt-listener - srt-caller + - st2110-jpegxs + - cdi description: The protocol that is used by the source. SenderIpAddress: type: string @@ -773,6 +773,14 @@ components: WhitelistCidr: type: string description: The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16. + MaxSyncBuffer: + type: integer + description: The size of the buffer (in milliseconds) to use to sync incoming source data. + MediaStreamSourceConfigurations: + type: array + description: The media stream that is associated with the source, and the parameters for that association. + items: + $ref: '#/components/schemas/MediaStreamSourceConfiguration' additionalProperties: false Encryption: type: object @@ -830,12 +838,226 @@ components: additionalProperties: false required: - BridgeArn + VpcInterface: + type: object + description: The details of a VPC interface. + properties: + Name: + type: string + description: Immutable and has to be a unique against other VpcInterfaces in this Flow. + NetworkInterfaceType: + type: string + description: The type of network adapter that you want MediaConnect to use on this interface. If you don't set this value, it defaults to ENA. + enum: + - ena + - efa + RoleArn: + type: string + description: Role Arn MediaConnect can assume to create ENIs in customer's account. + SecurityGroupIds: + type: array + description: Security Group IDs to be used on ENI. + items: + type: string + SubnetId: + type: string + description: Subnet must be in the AZ of the Flow + NetworkInterfaceIds: + type: array + description: IDs of the network interfaces created in customer's account by MediaConnect. + items: + type: string + additionalProperties: false + required: + - Name + - RoleArn + - SecurityGroupIds + - SubnetId + Maintenance: + type: object + description: The maintenance setting of a flow. + properties: + MaintenanceDay: + type: string + description: A day of a week when the maintenance will happen. Use Monday/Tuesday/Wednesday/Thursday/Friday/Saturday/Sunday. + enum: + - Monday + - Tuesday + - Wednesday + - Thursday + - Friday + - Saturday + - Sunday + MaintenanceStartHour: + type: string + description: 'UTC time when the maintenance will happen. Use 24-hour HH:MM format. Minutes must be 00. Example: 13:00. The default value is 02:00.' + additionalProperties: false + required: + - MaintenanceDay + - MaintenanceStartHour + MediaStream: + type: object + description: A single track or stream of media that contains video, audio, or ancillary data. After you add a media stream to a flow, you can associate it with sources and outputs on that flow, as long as they use the CDI protocol or the ST 2110 JPEG XS protocol. Each source or output can consist of one or many media streams. + properties: + MediaStreamId: + type: integer + description: A unique identifier for the media stream. + MediaStreamType: + type: string + description: The type of media stream. + enum: + - video + - audio + - ancillary-data + VideoFormat: + type: string + description: The resolution of the video. + enum: + - 2160p + - 1080p + - 1080i + - 720p + - 480p + MediaStreamName: + type: string + description: A name that helps you distinguish one media stream from another. + Description: + type: string + description: A description that can help you quickly identify what your media stream is used for. + Attributes: + $ref: '#/components/schemas/MediaStreamAttributes' + description: Attributes that are related to the media stream. + ClockRate: + type: integer + description: The sample rate for the stream. This value in measured in kHz. + Fmt: + type: integer + description: The format type number (sometimes referred to as RTP payload type) of the media stream. MediaConnect assigns this value to the media stream. For ST 2110 JPEG XS outputs, you need to provide this value to the receiver. + additionalProperties: false + required: + - MediaStreamId + - MediaStreamType + - MediaStreamName + MediaStreamAttributes: + type: object + description: Attributes that are related to the media stream. + properties: + Fmtp: + $ref: '#/components/schemas/Fmtp' + description: A set of parameters that define the media stream. + Lang: + type: string + description: The audio language, in a format that is recognized by the receiver. + additionalProperties: false + Fmtp: + type: object + description: A set of parameters that define the media stream. + properties: + ExactFramerate: + type: string + description: 'The frame rate for the video stream, in frames/second. For example: 60000/1001.' + Colorimetry: + type: string + description: The format used for the representation of color. + enum: + - BT601 + - BT709 + - BT2020 + - BT2100 + - ST2065-1 + - ST2065-3 + - XYZ + ScanMode: + type: string + description: The type of compression that was used to smooth the video's appearance. + enum: + - progressive + - interlace + - progressive-segmented-frame + Tcs: + type: string + description: The transfer characteristic system (TCS) that is used in the video. + enum: + - SDR + - PQ + - HLG + - LINEAR + - BT2100LINPQ + - BT2100LINHLG + - ST2065-1 + - ST428-1 + - DENSITY + Range: + type: string + description: The encoding range of the video. + enum: + - NARROW + - FULL + - FULLPROTECT + Par: + type: string + description: The pixel aspect ratio (PAR) of the video. + ChannelOrder: + type: string + description: The format of the audio channel. + additionalProperties: false + MediaStreamSourceConfiguration: + type: object + description: The media stream that is associated with the source, and the parameters for that association. + properties: + EncodingName: + type: string + description: The format that was used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv. + enum: + - jxsv + - raw + - smpte291 + - pcm + InputConfigurations: + type: array + description: The media streams that you want to associate with the source. + items: + $ref: '#/components/schemas/InputConfiguration' + MediaStreamName: + type: string + description: A name that helps you distinguish one media stream from another. + additionalProperties: false + required: + - EncodingName + - MediaStreamName + InputConfiguration: + type: object + description: The transport parameters associated with an incoming media stream. + properties: + InputPort: + type: integer + description: The port that the flow listens on for an incoming media stream. + Interface: + $ref: '#/components/schemas/Interface' + description: The VPC interface where the media stream comes in from. + additionalProperties: false + required: + - InputPort + - Interface + Interface: + type: object + description: The VPC interface that you want to use for the media stream associated with the output. + properties: + Name: + type: string + description: The name of the VPC interface that you want to use for the media stream associated with the output. + additionalProperties: false + required: + - Name Flow: type: object properties: FlowArn: description: The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow. type: string + EgressIp: + description: The IP address from which video will be sent to output destinations. + type: string Name: description: The name of the flow. type: string @@ -851,6 +1073,19 @@ components: SourceFailoverConfig: description: The source failover config of the flow. $ref: '#/components/schemas/FailoverConfig' + VpcInterfaces: + type: array + description: The VPC interfaces that you added to this flow. + items: + $ref: '#/components/schemas/VpcInterface' + MediaStreams: + type: array + description: The media streams associated with the flow. You can associate any of these media streams with sources and outputs on the flow. + items: + $ref: '#/components/schemas/MediaStream' + Maintenance: + description: 'The maintenance settings you want to use for the flow. ' + $ref: '#/components/schemas/Maintenance' required: - Name - Source @@ -869,6 +1104,9 @@ components: - Source/SourceArn - Source/IngestIp - Source/SourceIngestPort + - VpcInterfaces/*/NetworkInterfaceIds + - MediaStreams/*/Fmt + - EgressIp x-required-properties: - Name - Source @@ -882,6 +1120,11 @@ components: - mediaconnect:DescribeFlow - mediaconnect:UpdateFlow - mediaconnect:UpdateFlowSource + - mediaconnect:UpdateFlowMediaStream + - mediaconnect:AddFlowMediaStreams + - mediaconnect:RemoveFlowMediaStream + - mediaconnect:AddFlowVpcInterfaces + - mediaconnect:RemoveFlowVpcInterface delete: - mediaconnect:DescribeFlow - mediaconnect:DeleteFlow @@ -954,6 +1197,67 @@ components: - mediaconnect:RevokeFlowEntitlement list: - mediaconnect:DescribeFlow + MediaStreamOutputConfiguration: + type: object + description: The media stream that is associated with the output, and the parameters for that association. + properties: + EncodingName: + type: string + description: The format that will be used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video streams on sources or outputs that use the CDI protocol, set the encoding name to raw. For video streams on sources or outputs that use the ST 2110 JPEG XS protocol, set the encoding name to jxsv. + enum: + - jxsv + - raw + - smpte291 + - pcm + DestinationConfigurations: + type: array + description: The media streams that you want to associate with the output. + items: + $ref: '#/components/schemas/DestinationConfiguration' + MediaStreamName: + type: string + description: A name that helps you distinguish one media stream from another. + EncodingParameters: + $ref: '#/components/schemas/EncodingParameters' + description: A collection of parameters that determine how MediaConnect will convert the content. These fields only apply to outputs on flows that have a CDI source. + additionalProperties: false + required: + - EncodingName + - MediaStreamName + DestinationConfiguration: + type: object + description: The definition of a media stream that is associated with the output. + properties: + DestinationIp: + type: string + description: The IP address where contents of the media stream will be sent. + DestinationPort: + type: integer + description: The port to use when the content of the media stream is distributed to the output. + Interface: + $ref: '#/components/schemas/Interface' + description: The VPC interface that is used for the media stream associated with the output. + additionalProperties: false + required: + - DestinationIp + - DestinationPort + - Interface + EncodingParameters: + type: object + description: A collection of parameters that determine how MediaConnect will convert the content. These fields only apply to outputs on flows that have a CDI source. + properties: + CompressionFactor: + type: number + description: 'A value that is used to calculate compression for an output. The bitrate of the output is calculated as follows: Output bitrate = (1 / compressionFactor) * (source bitrate) This property only applies to outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol. Valid values are in the range of 3.0 to 10.0, inclusive.' + EncoderProfile: + type: string + description: A setting on the encoder that drives compression settings. This property only applies to video media streams associated with outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol. + enum: + - main + - high + additionalProperties: false + required: + - CompressionFactor FlowOutput: type: object properties: @@ -1000,6 +1304,8 @@ components: - fujitsu-qos - srt-listener - srt-caller + - st2110-jpegxs + - cdi description: The protocol that is used by the source or output. RemoteId: type: string @@ -1013,6 +1319,11 @@ components: VpcInterfaceAttachment: $ref: '#/components/schemas/VpcInterfaceAttachment' description: The name of the VPC interface attachment to use for this output. + MediaStreamOutputConfigurations: + type: array + description: The definition for each media stream that is associated with the output. + items: + $ref: '#/components/schemas/MediaStreamOutputConfiguration' required: - FlowArn - Protocol @@ -1161,7 +1472,7 @@ components: description: Immutable and has to be a unique against other VpcInterfaces in this Flow. RoleArn: type: string - description: Role Arn MediaConnect can assumes to create ENIs in customer's account. + description: Role Arn MediaConnect can assume to create ENIs in customer's account. SecurityGroupIds: type: array description: Security Group IDs to be used on ENI. @@ -1419,6 +1730,9 @@ components: FlowArn: description: The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow. type: string + EgressIp: + description: The IP address from which video will be sent to output destinations. + type: string Name: description: The name of the flow. type: string @@ -1434,6 +1748,19 @@ components: SourceFailoverConfig: description: The source failover config of the flow. $ref: '#/components/schemas/FailoverConfig' + VpcInterfaces: + type: array + description: The VPC interfaces that you added to this flow. + items: + $ref: '#/components/schemas/VpcInterface' + MediaStreams: + type: array + description: The media streams associated with the flow. You can associate any of these media streams with sources and outputs on the flow. + items: + $ref: '#/components/schemas/MediaStream' + Maintenance: + description: 'The maintenance settings you want to use for the flow. ' + $ref: '#/components/schemas/Maintenance' x-stackQL-stringOnly: true x-title: CreateFlowRequest type: object @@ -1541,6 +1868,8 @@ components: - fujitsu-qos - srt-listener - srt-caller + - st2110-jpegxs + - cdi description: The protocol that is used by the source or output. RemoteId: type: string @@ -1554,6 +1883,11 @@ components: VpcInterfaceAttachment: $ref: '#/components/schemas/VpcInterfaceAttachment' description: The name of the VPC interface attachment to use for this output. + MediaStreamOutputConfigurations: + type: array + description: The definition for each media stream that is associated with the output. + items: + $ref: '#/components/schemas/MediaStreamOutputConfiguration' x-stackQL-stringOnly: true x-title: CreateFlowOutputRequest type: object @@ -1668,7 +2002,7 @@ components: description: Immutable and has to be a unique against other VpcInterfaces in this Flow. RoleArn: type: string - description: Role Arn MediaConnect can assumes to create ENIs in customer's account. + description: Role Arn MediaConnect can assume to create ENIs in customer's account. SecurityGroupIds: type: array description: Security Group IDs to be used on ENI. @@ -1749,7 +2083,7 @@ components: x-identifiers: - BridgeArn - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1766,9 +2100,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1778,24 +2112,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/bridge_outputs/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/bridge_outputs/methods/delete_resource' - bridge_output: - name: bridge_output - id: aws.mediaconnect.bridge_output - x-cfn-schema-name: BridgeOutput - x-cfn-type-name: AWS::MediaConnect::BridgeOutput - x-identifiers: - - BridgeArn - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1806,12 +2125,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/bridge_outputs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/bridge_outputs/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/bridge_output/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/bridge_outputs/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1823,7 +2146,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1842,7 +2165,7 @@ components: x-identifiers: - BridgeArn - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1859,9 +2182,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1871,24 +2194,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/bridge_sources/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/bridge_sources/methods/delete_resource' - bridge_source: - name: bridge_source - id: aws.mediaconnect.bridge_source - x-cfn-schema-name: BridgeSource - x-cfn-type-name: AWS::MediaConnect::BridgeSource - x-identifiers: - - BridgeArn - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1899,12 +2207,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/bridge_sources/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/bridge_sources/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/bridge_source/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/bridge_sources/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1917,7 +2229,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1936,7 +2248,7 @@ components: x-cfn-type-name: AWS::MediaConnect::Bridge x-identifiers: - BridgeArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1953,9 +2265,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1965,41 +2277,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/bridges/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/bridges/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.BridgeArn') as bridge_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaConnect::Bridge' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'BridgeArn') as bridge_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaConnect::Bridge' - AND region = 'us-east-1' - bridge: - name: bridge - id: aws.mediaconnect.bridge - x-cfn-schema-name: Bridge - x-cfn-type-name: AWS::MediaConnect::Bridge - x-identifiers: - - BridgeArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2010,12 +2290,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/bridges/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/bridges/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/bridge/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/bridges/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2033,23 +2317,39 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'BridgeArn') as bridge_arn, - json_extract_path_text(Properties, 'PlacementArn') as placement_arn, - json_extract_path_text(Properties, 'BridgeState') as bridge_state, - json_extract_path_text(Properties, 'SourceFailoverConfig') as source_failover_config, - json_extract_path_text(Properties, 'Outputs') as outputs, - json_extract_path_text(Properties, 'Sources') as sources, - json_extract_path_text(Properties, 'IngressGatewayBridge') as ingress_gateway_bridge, - json_extract_path_text(Properties, 'EgressGatewayBridge') as egress_gateway_bridge - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MediaConnect::Bridge' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.BridgeArn') as bridge_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaConnect::Bridge' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'BridgeArn') as bridge_arn, + json_extract_path_text(Properties, 'PlacementArn') as placement_arn, + json_extract_path_text(Properties, 'BridgeState') as bridge_state, + json_extract_path_text(Properties, 'SourceFailoverConfig') as source_failover_config, + json_extract_path_text(Properties, 'Outputs') as outputs, + json_extract_path_text(Properties, 'Sources') as sources, + json_extract_path_text(Properties, 'IngressGatewayBridge') as ingress_gateway_bridge, + json_extract_path_text(Properties, 'EgressGatewayBridge') as egress_gateway_bridge + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MediaConnect::Bridge' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'BridgeArn') as bridge_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaConnect::Bridge' + AND region = 'us-east-1' flows: name: flows id: aws.mediaconnect.flows @@ -2057,7 +2357,7 @@ components: x-cfn-type-name: AWS::MediaConnect::Flow x-identifiers: - FlowArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2074,9 +2374,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2086,41 +2386,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/flows/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/flows/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.FlowArn') as flow_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaConnect::Flow' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'FlowArn') as flow_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaConnect::Flow' - AND region = 'us-east-1' - flow: - name: flow - id: aws.mediaconnect.flow - x-cfn-schema-name: Flow - x-cfn-type-name: AWS::MediaConnect::Flow - x-identifiers: - - FlowArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2131,40 +2399,68 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/flows/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/flows/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/flow/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/flows/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, JSON_EXTRACT(Properties, '$.FlowArn') as flow_arn, + JSON_EXTRACT(Properties, '$.EgressIp') as egress_ip, JSON_EXTRACT(Properties, '$.Name') as name, JSON_EXTRACT(Properties, '$.AvailabilityZone') as availability_zone, JSON_EXTRACT(Properties, '$.FlowAvailabilityZone') as flow_availability_zone, JSON_EXTRACT(Properties, '$.Source') as source, - JSON_EXTRACT(Properties, '$.SourceFailoverConfig') as source_failover_config + JSON_EXTRACT(Properties, '$.SourceFailoverConfig') as source_failover_config, + JSON_EXTRACT(Properties, '$.VpcInterfaces') as vpc_interfaces, + JSON_EXTRACT(Properties, '$.MediaStreams') as media_streams, + JSON_EXTRACT(Properties, '$.Maintenance') as maintenance FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MediaConnect::Flow' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'FlowArn') as flow_arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'AvailabilityZone') as availability_zone, - json_extract_path_text(Properties, 'FlowAvailabilityZone') as flow_availability_zone, - json_extract_path_text(Properties, 'Source') as source, - json_extract_path_text(Properties, 'SourceFailoverConfig') as source_failover_config - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MediaConnect::Flow' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.FlowArn') as flow_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaConnect::Flow' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'FlowArn') as flow_arn, + json_extract_path_text(Properties, 'EgressIp') as egress_ip, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'AvailabilityZone') as availability_zone, + json_extract_path_text(Properties, 'FlowAvailabilityZone') as flow_availability_zone, + json_extract_path_text(Properties, 'Source') as source, + json_extract_path_text(Properties, 'SourceFailoverConfig') as source_failover_config, + json_extract_path_text(Properties, 'VpcInterfaces') as vpc_interfaces, + json_extract_path_text(Properties, 'MediaStreams') as media_streams, + json_extract_path_text(Properties, 'Maintenance') as maintenance + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MediaConnect::Flow' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'FlowArn') as flow_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaConnect::Flow' + AND region = 'us-east-1' flow_entitlements: name: flow_entitlements id: aws.mediaconnect.flow_entitlements @@ -2172,7 +2468,7 @@ components: x-cfn-type-name: AWS::MediaConnect::FlowEntitlement x-identifiers: - EntitlementArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2189,9 +2485,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2201,41 +2497,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/flow_entitlements/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/flow_entitlements/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.EntitlementArn') as entitlement_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaConnect::FlowEntitlement' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'EntitlementArn') as entitlement_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaConnect::FlowEntitlement' - AND region = 'us-east-1' - flow_entitlement: - name: flow_entitlement - id: aws.mediaconnect.flow_entitlement - x-cfn-schema-name: FlowEntitlement - x-cfn-type-name: AWS::MediaConnect::FlowEntitlement - x-identifiers: - - EntitlementArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2246,12 +2510,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/flow_entitlements/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/flow_entitlements/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/flow_entitlement/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/flow_entitlements/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2268,22 +2536,38 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'FlowArn') as flow_arn, - json_extract_path_text(Properties, 'EntitlementArn') as entitlement_arn, - json_extract_path_text(Properties, 'DataTransferSubscriberFeePercent') as data_transfer_subscriber_fee_percent, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Encryption') as encryption, - json_extract_path_text(Properties, 'EntitlementStatus') as entitlement_status, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Subscribers') as subscribers - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MediaConnect::FlowEntitlement' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.EntitlementArn') as entitlement_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaConnect::FlowEntitlement' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'FlowArn') as flow_arn, + json_extract_path_text(Properties, 'EntitlementArn') as entitlement_arn, + json_extract_path_text(Properties, 'DataTransferSubscriberFeePercent') as data_transfer_subscriber_fee_percent, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Encryption') as encryption, + json_extract_path_text(Properties, 'EntitlementStatus') as entitlement_status, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Subscribers') as subscribers + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MediaConnect::FlowEntitlement' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'EntitlementArn') as entitlement_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaConnect::FlowEntitlement' + AND region = 'us-east-1' flow_outputs: name: flow_outputs id: aws.mediaconnect.flow_outputs @@ -2291,7 +2575,7 @@ components: x-cfn-type-name: AWS::MediaConnect::FlowOutput x-identifiers: - OutputArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2308,9 +2592,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2320,41 +2604,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/flow_outputs/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/flow_outputs/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.OutputArn') as output_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaConnect::FlowOutput' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'OutputArn') as output_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaConnect::FlowOutput' - AND region = 'us-east-1' - flow_output: - name: flow_output - id: aws.mediaconnect.flow_output - x-cfn-schema-name: FlowOutput - x-cfn-type-name: AWS::MediaConnect::FlowOutput - x-identifiers: - - OutputArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2365,12 +2617,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/flow_outputs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/flow_outputs/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/flow_output/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/flow_outputs/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2389,34 +2645,52 @@ components: JSON_EXTRACT(Properties, '$.RemoteId') as remote_id, JSON_EXTRACT(Properties, '$.SmoothingLatency') as smoothing_latency, JSON_EXTRACT(Properties, '$.StreamId') as stream_id, - JSON_EXTRACT(Properties, '$.VpcInterfaceAttachment') as vpc_interface_attachment + JSON_EXTRACT(Properties, '$.VpcInterfaceAttachment') as vpc_interface_attachment, + JSON_EXTRACT(Properties, '$.MediaStreamOutputConfigurations') as media_stream_output_configurations FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MediaConnect::FlowOutput' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'FlowArn') as flow_arn, - json_extract_path_text(Properties, 'OutputArn') as output_arn, - json_extract_path_text(Properties, 'CidrAllowList') as cidr_allow_list, - json_extract_path_text(Properties, 'Encryption') as encryption, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Destination') as destination, - json_extract_path_text(Properties, 'MaxLatency') as max_latency, - json_extract_path_text(Properties, 'MinLatency') as min_latency, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Port') as port, - json_extract_path_text(Properties, 'Protocol') as protocol, - json_extract_path_text(Properties, 'RemoteId') as remote_id, - json_extract_path_text(Properties, 'SmoothingLatency') as smoothing_latency, - json_extract_path_text(Properties, 'StreamId') as stream_id, - json_extract_path_text(Properties, 'VpcInterfaceAttachment') as vpc_interface_attachment - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MediaConnect::FlowOutput' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.OutputArn') as output_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaConnect::FlowOutput' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'FlowArn') as flow_arn, + json_extract_path_text(Properties, 'OutputArn') as output_arn, + json_extract_path_text(Properties, 'CidrAllowList') as cidr_allow_list, + json_extract_path_text(Properties, 'Encryption') as encryption, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Destination') as destination, + json_extract_path_text(Properties, 'MaxLatency') as max_latency, + json_extract_path_text(Properties, 'MinLatency') as min_latency, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Port') as port, + json_extract_path_text(Properties, 'Protocol') as protocol, + json_extract_path_text(Properties, 'RemoteId') as remote_id, + json_extract_path_text(Properties, 'SmoothingLatency') as smoothing_latency, + json_extract_path_text(Properties, 'StreamId') as stream_id, + json_extract_path_text(Properties, 'VpcInterfaceAttachment') as vpc_interface_attachment, + json_extract_path_text(Properties, 'MediaStreamOutputConfigurations') as media_stream_output_configurations + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MediaConnect::FlowOutput' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'OutputArn') as output_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaConnect::FlowOutput' + AND region = 'us-east-1' flow_sources: name: flow_sources id: aws.mediaconnect.flow_sources @@ -2424,7 +2698,7 @@ components: x-cfn-type-name: AWS::MediaConnect::FlowSource x-identifiers: - SourceArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2441,9 +2715,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2453,41 +2727,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/flow_sources/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/flow_sources/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.SourceArn') as source_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaConnect::FlowSource' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'SourceArn') as source_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaConnect::FlowSource' - AND region = 'us-east-1' - flow_source: - name: flow_source - id: aws.mediaconnect.flow_source - x-cfn-schema-name: FlowSource - x-cfn-type-name: AWS::MediaConnect::FlowSource - x-identifiers: - - SourceArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2498,12 +2740,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/flow_sources/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/flow_sources/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/flow_source/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/flow_sources/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2533,35 +2779,51 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'FlowArn') as flow_arn, - json_extract_path_text(Properties, 'SourceArn') as source_arn, - json_extract_path_text(Properties, 'Decryption') as decryption, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'EntitlementArn') as entitlement_arn, - json_extract_path_text(Properties, 'GatewayBridgeSource') as gateway_bridge_source, - json_extract_path_text(Properties, 'IngestIp') as ingest_ip, - json_extract_path_text(Properties, 'IngestPort') as ingest_port, - json_extract_path_text(Properties, 'MaxBitrate') as max_bitrate, - json_extract_path_text(Properties, 'MaxLatency') as max_latency, - json_extract_path_text(Properties, 'MinLatency') as min_latency, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Protocol') as protocol, - json_extract_path_text(Properties, 'SenderIpAddress') as sender_ip_address, - json_extract_path_text(Properties, 'SenderControlPort') as sender_control_port, - json_extract_path_text(Properties, 'StreamId') as stream_id, - json_extract_path_text(Properties, 'SourceIngestPort') as source_ingest_port, - json_extract_path_text(Properties, 'SourceListenerAddress') as source_listener_address, - json_extract_path_text(Properties, 'SourceListenerPort') as source_listener_port, - json_extract_path_text(Properties, 'VpcInterfaceName') as vpc_interface_name, - json_extract_path_text(Properties, 'WhitelistCidr') as whitelist_cidr - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MediaConnect::FlowSource' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.SourceArn') as source_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaConnect::FlowSource' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'FlowArn') as flow_arn, + json_extract_path_text(Properties, 'SourceArn') as source_arn, + json_extract_path_text(Properties, 'Decryption') as decryption, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'EntitlementArn') as entitlement_arn, + json_extract_path_text(Properties, 'GatewayBridgeSource') as gateway_bridge_source, + json_extract_path_text(Properties, 'IngestIp') as ingest_ip, + json_extract_path_text(Properties, 'IngestPort') as ingest_port, + json_extract_path_text(Properties, 'MaxBitrate') as max_bitrate, + json_extract_path_text(Properties, 'MaxLatency') as max_latency, + json_extract_path_text(Properties, 'MinLatency') as min_latency, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Protocol') as protocol, + json_extract_path_text(Properties, 'SenderIpAddress') as sender_ip_address, + json_extract_path_text(Properties, 'SenderControlPort') as sender_control_port, + json_extract_path_text(Properties, 'StreamId') as stream_id, + json_extract_path_text(Properties, 'SourceIngestPort') as source_ingest_port, + json_extract_path_text(Properties, 'SourceListenerAddress') as source_listener_address, + json_extract_path_text(Properties, 'SourceListenerPort') as source_listener_port, + json_extract_path_text(Properties, 'VpcInterfaceName') as vpc_interface_name, + json_extract_path_text(Properties, 'WhitelistCidr') as whitelist_cidr + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MediaConnect::FlowSource' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'SourceArn') as source_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaConnect::FlowSource' + AND region = 'us-east-1' flow_vpc_interfaces: name: flow_vpc_interfaces id: aws.mediaconnect.flow_vpc_interfaces @@ -2570,7 +2832,7 @@ components: x-identifiers: - FlowArn - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2587,9 +2849,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2599,44 +2861,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/flow_vpc_interfaces/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/flow_vpc_interfaces/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.FlowArn') as flow_arn, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaConnect::FlowVpcInterface' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'FlowArn') as flow_arn, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaConnect::FlowVpcInterface' - AND region = 'us-east-1' - flow_vpc_interface: - name: flow_vpc_interface - id: aws.mediaconnect.flow_vpc_interface - x-cfn-schema-name: FlowVpcInterface - x-cfn-type-name: AWS::MediaConnect::FlowVpcInterface - x-identifiers: - - FlowArn - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2647,12 +2874,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/flow_vpc_interfaces/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/flow_vpc_interfaces/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/flow_vpc_interface/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/flow_vpc_interfaces/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2667,20 +2898,38 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'FlowArn') as flow_arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'SecurityGroupIds') as security_group_ids, - json_extract_path_text(Properties, 'SubnetId') as subnet_id, - json_extract_path_text(Properties, 'NetworkInterfaceIds') as network_interface_ids - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MediaConnect::FlowVpcInterface' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.FlowArn') as flow_arn, + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaConnect::FlowVpcInterface' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'FlowArn') as flow_arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'SecurityGroupIds') as security_group_ids, + json_extract_path_text(Properties, 'SubnetId') as subnet_id, + json_extract_path_text(Properties, 'NetworkInterfaceIds') as network_interface_ids + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MediaConnect::FlowVpcInterface' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'FlowArn') as flow_arn, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaConnect::FlowVpcInterface' + AND region = 'us-east-1' gateways: name: gateways id: aws.mediaconnect.gateways @@ -2688,7 +2937,7 @@ components: x-cfn-type-name: AWS::MediaConnect::Gateway x-identifiers: - GatewayArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2722,39 +2971,11 @@ components: - $ref: '#/components/x-stackQL-resources/gateways/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/gateways/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.GatewayArn') as gateway_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaConnect::Gateway' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'GatewayArn') as gateway_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaConnect::Gateway' - AND region = 'us-east-1' - gateway: - name: gateway - id: aws.mediaconnect.gateway - x-cfn-schema-name: Gateway - x-cfn-type-name: AWS::MediaConnect::Gateway - x-identifiers: - - GatewayArn - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2768,19 +2989,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'GatewayArn') as gateway_arn, - json_extract_path_text(Properties, 'GatewayState') as gateway_state, - json_extract_path_text(Properties, 'EgressCidrBlocks') as egress_cidr_blocks, - json_extract_path_text(Properties, 'Networks') as networks - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MediaConnect::Gateway' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.GatewayArn') as gateway_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaConnect::Gateway' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'GatewayArn') as gateway_arn, + json_extract_path_text(Properties, 'GatewayState') as gateway_state, + json_extract_path_text(Properties, 'EgressCidrBlocks') as egress_cidr_blocks, + json_extract_path_text(Properties, 'Networks') as networks + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MediaConnect::Gateway' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'GatewayArn') as gateway_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaConnect::Gateway' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/medialive.yaml b/providers/src/aws/v00.00.00000/services/medialive.yaml index 772d4185..be02e455 100644 --- a/providers/src/aws/v00.00.00000/services/medialive.yaml +++ b/providers/src/aws/v00.00.00000/services/medialive.yaml @@ -856,7 +856,7 @@ components: x-cfn-type-name: AWS::MediaLive::Multiplex x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -873,9 +873,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -885,41 +885,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/multiplexes/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/multiplexes/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaLive::Multiplex' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaLive::Multiplex' - AND region = 'us-east-1' - multiplex: - name: multiplex - id: aws.medialive.multiplex - x-cfn-schema-name: Multiplex - x-cfn-type-name: AWS::MediaLive::Multiplex - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -930,12 +898,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/multiplexes/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/multiplexes/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/multiplex/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/multiplexes/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -954,24 +926,40 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'AvailabilityZones') as availability_zones, - json_extract_path_text(Properties, 'Destinations') as destinations, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'MultiplexSettings') as multiplex_settings, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'PipelinesRunningCount') as pipelines_running_count, - json_extract_path_text(Properties, 'ProgramCount') as program_count, - json_extract_path_text(Properties, 'State') as state, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MediaLive::Multiplex' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaLive::Multiplex' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'AvailabilityZones') as availability_zones, + json_extract_path_text(Properties, 'Destinations') as destinations, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'MultiplexSettings') as multiplex_settings, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'PipelinesRunningCount') as pipelines_running_count, + json_extract_path_text(Properties, 'ProgramCount') as program_count, + json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MediaLive::Multiplex' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaLive::Multiplex' + AND region = 'us-east-1' multiplexprograms: name: multiplexprograms id: aws.medialive.multiplexprograms @@ -980,7 +968,7 @@ components: x-identifiers: - ProgramName - MultiplexId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -997,9 +985,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1009,44 +997,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/multiplexprograms/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/multiplexprograms/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ProgramName') as program_name, - JSON_EXTRACT(Properties, '$.MultiplexId') as multiplex_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaLive::Multiplexprogram' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ProgramName') as program_name, - json_extract_path_text(Properties, 'MultiplexId') as multiplex_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaLive::Multiplexprogram' - AND region = 'us-east-1' - multiplexprogram: - name: multiplexprogram - id: aws.medialive.multiplexprogram - x-cfn-schema-name: Multiplexprogram - x-cfn-type-name: AWS::MediaLive::Multiplexprogram - x-identifiers: - - ProgramName - - MultiplexId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1057,12 +1010,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/multiplexprograms/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/multiplexprograms/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/multiplexprogram/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/multiplexprograms/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1078,21 +1035,39 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ChannelId') as channel_id, - json_extract_path_text(Properties, 'MultiplexId') as multiplex_id, - json_extract_path_text(Properties, 'MultiplexProgramSettings') as multiplex_program_settings, - json_extract_path_text(Properties, 'PreferredChannelPipeline') as preferred_channel_pipeline, - json_extract_path_text(Properties, 'PacketIdentifiersMap') as packet_identifiers_map, - json_extract_path_text(Properties, 'PipelineDetails') as pipeline_details, - json_extract_path_text(Properties, 'ProgramName') as program_name - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MediaLive::Multiplexprogram' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.ProgramName') as program_name, + JSON_EXTRACT(Properties, '$.MultiplexId') as multiplex_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaLive::Multiplexprogram' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ChannelId') as channel_id, + json_extract_path_text(Properties, 'MultiplexId') as multiplex_id, + json_extract_path_text(Properties, 'MultiplexProgramSettings') as multiplex_program_settings, + json_extract_path_text(Properties, 'PreferredChannelPipeline') as preferred_channel_pipeline, + json_extract_path_text(Properties, 'PacketIdentifiersMap') as packet_identifiers_map, + json_extract_path_text(Properties, 'PipelineDetails') as pipeline_details, + json_extract_path_text(Properties, 'ProgramName') as program_name + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MediaLive::Multiplexprogram' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ProgramName') as program_name, + json_extract_path_text(Properties, 'MultiplexId') as multiplex_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaLive::Multiplexprogram' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/mediapackage.yaml b/providers/src/aws/v00.00.00000/services/mediapackage.yaml index 4d4e9ce1..60beb1b8 100644 --- a/providers/src/aws/v00.00.00000/services/mediapackage.yaml +++ b/providers/src/aws/v00.00.00000/services/mediapackage.yaml @@ -465,6 +465,12 @@ components: - PackagingGroupId - SourceArn - SourceRoleArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: false + cloudFormationSystemTags: false + tagProperty: /properties/Tags x-required-permissions: create: - mediapackage-vod:CreateAsset @@ -569,6 +575,12 @@ components: - HlsIngest/ingestEndpoints/*/Url x-required-properties: - Id + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: false + cloudFormationSystemTags: false + tagProperty: /properties/Tags x-required-permissions: create: - mediapackage:CreateChannel @@ -918,6 +930,12 @@ components: x-required-properties: - Id - ChannelId + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: false + cloudFormationSystemTags: false + tagProperty: /properties/Tags x-required-permissions: create: - mediapackage:CreateOriginEndpoint @@ -1028,6 +1046,12 @@ components: x-required-properties: - PackagingGroupId - Id + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: false + cloudFormationSystemTags: false + tagProperty: /properties/Tags x-required-permissions: create: - mediapackage-vod:CreatePackagingConfiguration @@ -1084,6 +1108,12 @@ components: - DomainName x-required-properties: - Id + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: false + cloudFormationSystemTags: false + tagProperty: /properties/Tags x-required-permissions: create: - mediapackage-vod:CreatePackagingGroup @@ -1370,7 +1400,7 @@ components: x-cfn-type-name: AWS::MediaPackage::Asset x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1404,39 +1434,11 @@ components: - $ref: '#/components/x-stackQL-resources/assets/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/assets/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackage::Asset' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackage::Asset' - AND region = 'us-east-1' - asset: - name: asset - id: aws.mediapackage.asset - x-cfn-schema-name: Asset - x-cfn-type-name: AWS::MediaPackage::Asset - x-identifiers: - - Id - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1454,23 +1456,39 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'CreatedAt') as created_at, - json_extract_path_text(Properties, 'EgressEndpoints') as egress_endpoints, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'PackagingGroupId') as packaging_group_id, - json_extract_path_text(Properties, 'ResourceId') as resource_id, - json_extract_path_text(Properties, 'SourceArn') as source_arn, - json_extract_path_text(Properties, 'SourceRoleArn') as source_role_arn, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MediaPackage::Asset' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackage::Asset' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'EgressEndpoints') as egress_endpoints, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'PackagingGroupId') as packaging_group_id, + json_extract_path_text(Properties, 'ResourceId') as resource_id, + json_extract_path_text(Properties, 'SourceArn') as source_arn, + json_extract_path_text(Properties, 'SourceRoleArn') as source_role_arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MediaPackage::Asset' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackage::Asset' + AND region = 'us-east-1' channels: name: channels id: aws.mediapackage.channels @@ -1478,7 +1496,7 @@ components: x-cfn-type-name: AWS::MediaPackage::Channel x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1495,9 +1513,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1507,41 +1525,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/channels/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/channels/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackage::Channel' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackage::Channel' - AND region = 'us-east-1' - channel: - name: channel - id: aws.mediapackage.channel - x-cfn-schema-name: Channel - x-cfn-type-name: AWS::MediaPackage::Channel - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1552,12 +1538,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/channels/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/channels/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/channel/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/channels/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1573,21 +1563,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'HlsIngest') as hls_ingest, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'EgressAccessLogs') as egress_access_logs, - json_extract_path_text(Properties, 'IngressAccessLogs') as ingress_access_logs - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MediaPackage::Channel' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackage::Channel' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'HlsIngest') as hls_ingest, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'EgressAccessLogs') as egress_access_logs, + json_extract_path_text(Properties, 'IngressAccessLogs') as ingress_access_logs + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MediaPackage::Channel' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackage::Channel' + AND region = 'us-east-1' origin_endpoints: name: origin_endpoints id: aws.mediapackage.origin_endpoints @@ -1595,7 +1601,7 @@ components: x-cfn-type-name: AWS::MediaPackage::OriginEndpoint x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1612,9 +1618,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1624,41 +1630,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/origin_endpoints/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/origin_endpoints/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackage::OriginEndpoint' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackage::OriginEndpoint' - AND region = 'us-east-1' - origin_endpoint: - name: origin_endpoint - id: aws.mediapackage.origin_endpoint - x-cfn-schema-name: OriginEndpoint - x-cfn-type-name: AWS::MediaPackage::OriginEndpoint - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1669,12 +1643,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/origin_endpoints/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/origin_endpoints/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/origin_endpoint/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/origin_endpoints/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1699,30 +1677,46 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Url') as url, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'ChannelId') as channel_id, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Whitelist') as whitelist, - json_extract_path_text(Properties, 'StartoverWindowSeconds') as startover_window_seconds, - json_extract_path_text(Properties, 'TimeDelaySeconds') as time_delay_seconds, - json_extract_path_text(Properties, 'ManifestName') as manifest_name, - json_extract_path_text(Properties, 'Origination') as origination, - json_extract_path_text(Properties, 'Authorization') as authorization, - json_extract_path_text(Properties, 'HlsPackage') as hls_package, - json_extract_path_text(Properties, 'DashPackage') as dash_package, - json_extract_path_text(Properties, 'MssPackage') as mss_package, - json_extract_path_text(Properties, 'CmafPackage') as cmaf_package, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MediaPackage::OriginEndpoint' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackage::OriginEndpoint' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Url') as url, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'ChannelId') as channel_id, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Whitelist') as whitelist, + json_extract_path_text(Properties, 'StartoverWindowSeconds') as startover_window_seconds, + json_extract_path_text(Properties, 'TimeDelaySeconds') as time_delay_seconds, + json_extract_path_text(Properties, 'ManifestName') as manifest_name, + json_extract_path_text(Properties, 'Origination') as origination, + json_extract_path_text(Properties, 'Authorization') as authorization, + json_extract_path_text(Properties, 'HlsPackage') as hls_package, + json_extract_path_text(Properties, 'DashPackage') as dash_package, + json_extract_path_text(Properties, 'MssPackage') as mss_package, + json_extract_path_text(Properties, 'CmafPackage') as cmaf_package, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MediaPackage::OriginEndpoint' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackage::OriginEndpoint' + AND region = 'us-east-1' packaging_configurations: name: packaging_configurations id: aws.mediapackage.packaging_configurations @@ -1730,7 +1724,7 @@ components: x-cfn-type-name: AWS::MediaPackage::PackagingConfiguration x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1764,39 +1758,11 @@ components: - $ref: '#/components/x-stackQL-resources/packaging_configurations/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/packaging_configurations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackage::PackagingConfiguration' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackage::PackagingConfiguration' - AND region = 'us-east-1' - packaging_configuration: - name: packaging_configuration - id: aws.mediapackage.packaging_configuration - x-cfn-schema-name: PackagingConfiguration - x-cfn-type-name: AWS::MediaPackage::PackagingConfiguration - x-identifiers: - - Id - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1813,22 +1779,38 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'PackagingGroupId') as packaging_group_id, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'CmafPackage') as cmaf_package, - json_extract_path_text(Properties, 'DashPackage') as dash_package, - json_extract_path_text(Properties, 'HlsPackage') as hls_package, - json_extract_path_text(Properties, 'MssPackage') as mss_package, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MediaPackage::PackagingConfiguration' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackage::PackagingConfiguration' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'PackagingGroupId') as packaging_group_id, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'CmafPackage') as cmaf_package, + json_extract_path_text(Properties, 'DashPackage') as dash_package, + json_extract_path_text(Properties, 'HlsPackage') as hls_package, + json_extract_path_text(Properties, 'MssPackage') as mss_package, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MediaPackage::PackagingConfiguration' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackage::PackagingConfiguration' + AND region = 'us-east-1' packaging_groups: name: packaging_groups id: aws.mediapackage.packaging_groups @@ -1836,7 +1818,7 @@ components: x-cfn-type-name: AWS::MediaPackage::PackagingGroup x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1853,9 +1835,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1865,41 +1847,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/packaging_groups/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/packaging_groups/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackage::PackagingGroup' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackage::PackagingGroup' - AND region = 'us-east-1' - packaging_group: - name: packaging_group - id: aws.mediapackage.packaging_group - x-cfn-schema-name: PackagingGroup - x-cfn-type-name: AWS::MediaPackage::PackagingGroup - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1910,12 +1860,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/packaging_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/packaging_groups/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/packaging_group/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/packaging_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1930,20 +1884,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'DomainName') as domain_name, - json_extract_path_text(Properties, 'Authorization') as authorization, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'EgressAccessLogs') as egress_access_logs - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MediaPackage::PackagingGroup' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackage::PackagingGroup' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'DomainName') as domain_name, + json_extract_path_text(Properties, 'Authorization') as authorization, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'EgressAccessLogs') as egress_access_logs + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MediaPackage::PackagingGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackage::PackagingGroup' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/mediapackagev2.yaml b/providers/src/aws/v00.00.00000/services/mediapackagev2.yaml index f133c13c..ae243b5e 100644 --- a/providers/src/aws/v00.00.00000/services/mediapackagev2.yaml +++ b/providers/src/aws/v00.00.00000/services/mediapackagev2.yaml @@ -608,6 +608,11 @@ components: delete: - mediapackagev2:GetChannelPolicy - mediapackagev2:DeleteChannelPolicy + AdMarkerDash: + type: string + enum: + - BINARY + - XML AdMarkerHls: type: string enum: @@ -622,6 +627,42 @@ components: enum: - TS - CMAF + DashDrmSignaling: + type: string + enum: + - INDIVIDUAL + - REFERENCED + DashPeriodTrigger: + type: string + enum: + - AVAILS + - DRM_KEY_ROTATION + - SOURCE_CHANGES + - SOURCE_DISRUPTIONS + - NONE + DashSegmentTemplateFormat: + type: string + enum: + - NUMBER_WITH_TIMELINE + DashUtcTiming: + type: object + description:

Determines the type of UTC timing included in the DASH Media Presentation Description (MPD).

+ properties: + TimingMode: + $ref: '#/components/schemas/DashUtcTimingMode' + TimingSource: + type: string + maxLength: 1024 + minLength: 1 + description:

The the method that the player uses to synchronize to coordinated universal time (UTC) wall clock time.

+ additionalProperties: false + DashUtcTimingMode: + type: string + enum: + - HTTP_HEAD + - HTTP_ISO + - HTTP_XSDATE + - UTC_DIRECT DrmSystem: type: string enum: @@ -699,6 +740,50 @@ components: minimum: 0 description:

Optionally specify the time delay for all of your manifest egress requests. Enter a value that is smaller than your endpoint's startover window. When you include time delay, note that you cannot use time delay query parameters for this manifest's endpoint URL.

additionalProperties: false + DashManifestConfiguration: + type: object + description:

Retrieve the DASH manifest configuration.

+ properties: + ManifestName: + type: string + maxLength: 256 + minLength: 1 + pattern: ^[a-zA-Z0-9_-]+$ + description:

A short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index.

+ ManifestWindowSeconds: + type: integer + description:

The total duration (in seconds) of the manifest's content.

+ FilterConfiguration: + $ref: '#/components/schemas/FilterConfiguration' + MinUpdatePeriodSeconds: + type: integer + description:

Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest.

+ MinBufferTimeSeconds: + type: integer + description:

Minimum amount of content (in seconds) that a player must keep available in the buffer.

+ SuggestedPresentationDelaySeconds: + type: integer + description:

The amount of time (in seconds) that the player should be from the end of the manifest.

+ SegmentTemplateFormat: + $ref: '#/components/schemas/DashSegmentTemplateFormat' + PeriodTriggers: + type: array + items: + $ref: '#/components/schemas/DashPeriodTrigger' + maxItems: 100 + minItems: 0 + description: |- +

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: + $ref: '#/components/schemas/ScteDash' + DrmSignaling: + $ref: '#/components/schemas/DashDrmSignaling' + UtcTiming: + $ref: '#/components/schemas/DashUtcTiming' + required: + - ManifestName + additionalProperties: false HlsManifestConfiguration: type: object description:

Retrieve the HTTP live streaming (HLS) manifest configuration.

@@ -806,6 +891,13 @@ components: minItems: 0 description:

The SCTE-35 message types that you want to be treated as ad markers in the output.

additionalProperties: false + ScteDash: + type: object + description:

The SCTE configuration.

+ properties: + AdMarkerDash: + $ref: '#/components/schemas/AdMarkerDash' + additionalProperties: false ScteFilter: type: string enum: @@ -926,6 +1018,11 @@ components: type: string description:

The date and time the origin endpoint was created.

format: date-time + DashManifests: + type: array + items: + $ref: '#/components/schemas/DashManifestConfiguration' + description:

A DASH manifest configuration.

Description: type: string maxLength: 1024 @@ -1231,6 +1328,11 @@ components: type: string description:

The date and time the origin endpoint was created.

format: date-time + DashManifests: + type: array + items: + $ref: '#/components/schemas/DashManifestConfiguration' + description:

A DASH manifest configuration.

Description: type: string maxLength: 1024 @@ -1320,7 +1422,7 @@ components: x-cfn-type-name: AWS::MediaPackageV2::Channel x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1337,9 +1439,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1349,41 +1451,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/channels/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/channels/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackageV2::Channel' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackageV2::Channel' - AND region = 'us-east-1' - channel: - name: channel - id: aws.mediapackagev2.channel - x-cfn-schema-name: Channel - x-cfn-type-name: AWS::MediaPackageV2::Channel - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1394,12 +1464,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/channels/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/channels/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/channel/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/channels/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1416,22 +1490,38 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'ChannelGroupName') as channel_group_name, - json_extract_path_text(Properties, 'ChannelName') as channel_name, - json_extract_path_text(Properties, 'CreatedAt') as created_at, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'IngestEndpoints') as ingest_endpoints, - json_extract_path_text(Properties, 'ModifiedAt') as modified_at, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MediaPackageV2::Channel' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackageV2::Channel' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'ChannelGroupName') as channel_group_name, + json_extract_path_text(Properties, 'ChannelName') as channel_name, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'IngestEndpoints') as ingest_endpoints, + json_extract_path_text(Properties, 'ModifiedAt') as modified_at, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MediaPackageV2::Channel' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackageV2::Channel' + AND region = 'us-east-1' channel_groups: name: channel_groups id: aws.mediapackagev2.channel_groups @@ -1439,7 +1529,7 @@ components: x-cfn-type-name: AWS::MediaPackageV2::ChannelGroup x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1456,9 +1546,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1468,41 +1558,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/channel_groups/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/channel_groups/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackageV2::ChannelGroup' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackageV2::ChannelGroup' - AND region = 'us-east-1' - channel_group: - name: channel_group - id: aws.mediapackagev2.channel_group - x-cfn-schema-name: ChannelGroup - x-cfn-type-name: AWS::MediaPackageV2::ChannelGroup - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1513,12 +1571,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/channel_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/channel_groups/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/channel_group/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/channel_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1534,21 +1596,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'ChannelGroupName') as channel_group_name, - json_extract_path_text(Properties, 'CreatedAt') as created_at, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'EgressDomain') as egress_domain, - json_extract_path_text(Properties, 'ModifiedAt') as modified_at, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MediaPackageV2::ChannelGroup' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackageV2::ChannelGroup' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'ChannelGroupName') as channel_group_name, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'EgressDomain') as egress_domain, + json_extract_path_text(Properties, 'ModifiedAt') as modified_at, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MediaPackageV2::ChannelGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackageV2::ChannelGroup' + AND region = 'us-east-1' channel_policies: name: channel_policies id: aws.mediapackagev2.channel_policies @@ -1557,7 +1635,7 @@ components: x-identifiers: - ChannelGroupName - ChannelName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1574,9 +1652,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1586,24 +1664,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/channel_policies/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/channel_policies/methods/delete_resource' - channel_policy: - name: channel_policy - id: aws.mediapackagev2.channel_policy - x-cfn-schema-name: ChannelPolicy - x-cfn-type-name: AWS::MediaPackageV2::ChannelPolicy - x-identifiers: - - ChannelGroupName - - ChannelName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1614,12 +1677,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/channel_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/channel_policies/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/channel_policy/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/channel_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1631,7 +1698,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1649,7 +1716,7 @@ components: x-cfn-type-name: AWS::MediaPackageV2::OriginEndpoint x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1666,9 +1733,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1678,41 +1745,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/origin_endpoints/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/origin_endpoints/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackageV2::OriginEndpoint' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackageV2::OriginEndpoint' - AND region = 'us-east-1' - origin_endpoint: - name: origin_endpoint - id: aws.mediapackagev2.origin_endpoint - x-cfn-schema-name: OriginEndpoint - x-cfn-type-name: AWS::MediaPackageV2::OriginEndpoint - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1723,12 +1758,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/origin_endpoints/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/origin_endpoints/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/origin_endpoint/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/origin_endpoints/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1738,6 +1777,7 @@ components: JSON_EXTRACT(Properties, '$.ChannelName') as channel_name, JSON_EXTRACT(Properties, '$.ContainerType') as container_type, JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.DashManifests') as dash_manifests, JSON_EXTRACT(Properties, '$.Description') as description, JSON_EXTRACT(Properties, '$.HlsManifests') as hls_manifests, JSON_EXTRACT(Properties, '$.LowLatencyHlsManifests') as low_latency_hls_manifests, @@ -1750,27 +1790,44 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'ChannelGroupName') as channel_group_name, - json_extract_path_text(Properties, 'ChannelName') as channel_name, - json_extract_path_text(Properties, 'ContainerType') as container_type, - json_extract_path_text(Properties, 'CreatedAt') as created_at, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'HlsManifests') as hls_manifests, - json_extract_path_text(Properties, 'LowLatencyHlsManifests') as low_latency_hls_manifests, - json_extract_path_text(Properties, 'ModifiedAt') as modified_at, - json_extract_path_text(Properties, 'OriginEndpointName') as origin_endpoint_name, - json_extract_path_text(Properties, 'Segment') as segment, - json_extract_path_text(Properties, 'StartoverWindowSeconds') as startover_window_seconds, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MediaPackageV2::OriginEndpoint' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackageV2::OriginEndpoint' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'ChannelGroupName') as channel_group_name, + json_extract_path_text(Properties, 'ChannelName') as channel_name, + json_extract_path_text(Properties, 'ContainerType') as container_type, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'DashManifests') as dash_manifests, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'HlsManifests') as hls_manifests, + json_extract_path_text(Properties, 'LowLatencyHlsManifests') as low_latency_hls_manifests, + json_extract_path_text(Properties, 'ModifiedAt') as modified_at, + json_extract_path_text(Properties, 'OriginEndpointName') as origin_endpoint_name, + json_extract_path_text(Properties, 'Segment') as segment, + json_extract_path_text(Properties, 'StartoverWindowSeconds') as startover_window_seconds, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MediaPackageV2::OriginEndpoint' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaPackageV2::OriginEndpoint' + AND region = 'us-east-1' origin_endpoint_policies: name: origin_endpoint_policies id: aws.mediapackagev2.origin_endpoint_policies @@ -1780,7 +1837,7 @@ components: - ChannelGroupName - ChannelName - OriginEndpointName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1797,9 +1854,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1809,25 +1866,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/origin_endpoint_policies/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/origin_endpoint_policies/methods/delete_resource' - origin_endpoint_policy: - name: origin_endpoint_policy - id: aws.mediapackagev2.origin_endpoint_policy - x-cfn-schema-name: OriginEndpointPolicy - x-cfn-type-name: AWS::MediaPackageV2::OriginEndpointPolicy - x-identifiers: - - ChannelGroupName - - ChannelName - - OriginEndpointName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1838,12 +1879,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/origin_endpoint_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/origin_endpoint_policies/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/origin_endpoint_policy/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/origin_endpoint_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1856,7 +1901,7 @@ components: AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, diff --git a/providers/src/aws/v00.00.00000/services/mediatailor.yaml b/providers/src/aws/v00.00.00000/services/mediatailor.yaml index 4485d7b5..0a10e784 100644 --- a/providers/src/aws/v00.00.00000/services/mediatailor.yaml +++ b/providers/src/aws/v00.00.00000/services/mediatailor.yaml @@ -708,16 +708,23 @@ components: additionalProperties: false properties: Mode: - description: Sets the ad suppression mode. By default, ad suppression is set to OFF and all ad breaks are filled with ads or slate. When Mode is set to BEHIND_LIVE_EDGE, ad suppression is active and MediaTailor won't fill ad breaks on or behind the ad suppression Value time in the manifest lookback window. + description: Sets the ad suppression mode. By default, ad suppression is off and all ad breaks are filled with ads or slate. When Mode is set to BEHIND_LIVE_EDGE, ad suppression is active and MediaTailor won't fill ad breaks on or behind the ad suppression Value time in the manifest lookback window. When Mode is set to AFTER_LIVE_EDGE, ad suppression is active and MediaTailor won't fill ad breaks that are within the live edge plus the avail suppression value. type: string enum: - 'OFF' - BEHIND_LIVE_EDGE + - AFTER_LIVE_EDGE Value: description: >- A live edge offset time in HH:MM:SS. MediaTailor won't fill ad breaks on or behind this time in the manifest lookback window. If Value is set to 00:00:00, it is in sync with the live edge, and MediaTailor won't fill any ad breaks on or behind the live edge. If you set a Value time, MediaTailor won't fill any ad breaks on or behind this time in the manifest lookback window. For example, if you set 00:45:00, then MediaTailor will fill ad breaks that occur within 45 minutes behind the live edge, but won't fill ad breaks on or behind 45 minutes behind the live edge. type: string + FillPolicy: + description: Defines the policy to apply to the avail suppression mode. BEHIND_LIVE_EDGE will always use the full avail suppression policy. AFTER_LIVE_EDGE mode can be used to invoke partial ad break fills when a session starts mid-break. Valid values are FULL_AVAIL_ONLY and PARTIAL_AVAIL + type: string + enum: + - PARTIAL_AVAIL + - FULL_AVAIL_ONLY Bumper: description: The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see Bumpers (https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html). type: object @@ -1381,7 +1388,7 @@ components: x-cfn-type-name: AWS::MediaTailor::Channel x-identifiers: - ChannelName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1398,9 +1405,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1410,41 +1417,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/channels/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/channels/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ChannelName') as channel_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaTailor::Channel' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ChannelName') as channel_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaTailor::Channel' - AND region = 'us-east-1' - channel: - name: channel - id: aws.mediatailor.channel - x-cfn-schema-name: Channel - x-cfn-type-name: AWS::MediaTailor::Channel - x-identifiers: - - ChannelName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1455,12 +1430,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/channels/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/channels/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/channel/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/channels/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1479,24 +1458,40 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Audiences') as audiences, - json_extract_path_text(Properties, 'ChannelName') as channel_name, - json_extract_path_text(Properties, 'FillerSlate') as filler_slate, - json_extract_path_text(Properties, 'LogConfiguration') as log_configuration, - json_extract_path_text(Properties, 'Outputs') as outputs, - json_extract_path_text(Properties, 'PlaybackMode') as playback_mode, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Tier') as tier, - json_extract_path_text(Properties, 'TimeShiftConfiguration') as time_shift_configuration - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MediaTailor::Channel' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ChannelName') as channel_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaTailor::Channel' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Audiences') as audiences, + json_extract_path_text(Properties, 'ChannelName') as channel_name, + json_extract_path_text(Properties, 'FillerSlate') as filler_slate, + json_extract_path_text(Properties, 'LogConfiguration') as log_configuration, + json_extract_path_text(Properties, 'Outputs') as outputs, + json_extract_path_text(Properties, 'PlaybackMode') as playback_mode, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Tier') as tier, + json_extract_path_text(Properties, 'TimeShiftConfiguration') as time_shift_configuration + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MediaTailor::Channel' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ChannelName') as channel_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaTailor::Channel' + AND region = 'us-east-1' channel_policies: name: channel_policies id: aws.mediatailor.channel_policies @@ -1504,7 +1499,7 @@ components: x-cfn-type-name: AWS::MediaTailor::ChannelPolicy x-identifiers: - ChannelName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1521,9 +1516,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1533,23 +1528,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/channel_policies/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/channel_policies/methods/delete_resource' - channel_policy: - name: channel_policy - id: aws.mediatailor.channel_policy - x-cfn-schema-name: ChannelPolicy - x-cfn-type-name: AWS::MediaTailor::ChannelPolicy - x-identifiers: - - ChannelName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1560,12 +1541,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/channel_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/channel_policies/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/channel_policy/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/channel_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1576,7 +1561,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1594,7 +1579,7 @@ components: x-identifiers: - LiveSourceName - SourceLocationName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1611,9 +1596,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1623,44 +1608,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/live_sources/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/live_sources/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.LiveSourceName') as live_source_name, - JSON_EXTRACT(Properties, '$.SourceLocationName') as source_location_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaTailor::LiveSource' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'LiveSourceName') as live_source_name, - json_extract_path_text(Properties, 'SourceLocationName') as source_location_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaTailor::LiveSource' - AND region = 'us-east-1' - live_source: - name: live_source - id: aws.mediatailor.live_source - x-cfn-schema-name: LiveSource - x-cfn-type-name: AWS::MediaTailor::LiveSource - x-identifiers: - - LiveSourceName - - SourceLocationName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1671,12 +1621,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/live_sources/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/live_sources/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/live_source/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/live_sources/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1690,19 +1644,37 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'HttpPackageConfigurations') as http_package_configurations, - json_extract_path_text(Properties, 'LiveSourceName') as live_source_name, - json_extract_path_text(Properties, 'SourceLocationName') as source_location_name, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MediaTailor::LiveSource' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.LiveSourceName') as live_source_name, + JSON_EXTRACT(Properties, '$.SourceLocationName') as source_location_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaTailor::LiveSource' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'HttpPackageConfigurations') as http_package_configurations, + json_extract_path_text(Properties, 'LiveSourceName') as live_source_name, + json_extract_path_text(Properties, 'SourceLocationName') as source_location_name, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MediaTailor::LiveSource' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'LiveSourceName') as live_source_name, + json_extract_path_text(Properties, 'SourceLocationName') as source_location_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaTailor::LiveSource' + AND region = 'us-east-1' playback_configurations: name: playback_configurations id: aws.mediatailor.playback_configurations @@ -1710,7 +1682,7 @@ components: x-cfn-type-name: AWS::MediaTailor::PlaybackConfiguration x-identifiers: - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1727,9 +1699,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1739,41 +1711,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/playback_configurations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/playback_configurations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaTailor::PlaybackConfiguration' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaTailor::PlaybackConfiguration' - AND region = 'us-east-1' - playback_configuration: - name: playback_configuration - id: aws.mediatailor.playback_configuration - x-cfn-schema-name: PlaybackConfiguration - x-cfn-type-name: AWS::MediaTailor::PlaybackConfiguration - x-identifiers: - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1784,12 +1724,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/playback_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/playback_configurations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/playback_configuration/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/playback_configurations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1816,32 +1760,48 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AdDecisionServerUrl') as ad_decision_server_url, - json_extract_path_text(Properties, 'AvailSuppression') as avail_suppression, - json_extract_path_text(Properties, 'Bumper') as bumper, - json_extract_path_text(Properties, 'CdnConfiguration') as cdn_configuration, - json_extract_path_text(Properties, 'ConfigurationAliases') as configuration_aliases, - json_extract_path_text(Properties, 'DashConfiguration') as dash_configuration, - json_extract_path_text(Properties, 'LivePreRollConfiguration') as live_pre_roll_configuration, - json_extract_path_text(Properties, 'ManifestProcessingRules') as manifest_processing_rules, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'PersonalizationThresholdSeconds') as personalization_threshold_seconds, - json_extract_path_text(Properties, 'SessionInitializationEndpointPrefix') as session_initialization_endpoint_prefix, - json_extract_path_text(Properties, 'HlsConfiguration') as hls_configuration, - json_extract_path_text(Properties, 'PlaybackConfigurationArn') as playback_configuration_arn, - json_extract_path_text(Properties, 'PlaybackEndpointPrefix') as playback_endpoint_prefix, - json_extract_path_text(Properties, 'SlateAdUrl') as slate_ad_url, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'TranscodeProfileName') as transcode_profile_name, - json_extract_path_text(Properties, 'VideoContentSourceUrl') as video_content_source_url - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MediaTailor::PlaybackConfiguration' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaTailor::PlaybackConfiguration' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AdDecisionServerUrl') as ad_decision_server_url, + json_extract_path_text(Properties, 'AvailSuppression') as avail_suppression, + json_extract_path_text(Properties, 'Bumper') as bumper, + json_extract_path_text(Properties, 'CdnConfiguration') as cdn_configuration, + json_extract_path_text(Properties, 'ConfigurationAliases') as configuration_aliases, + json_extract_path_text(Properties, 'DashConfiguration') as dash_configuration, + json_extract_path_text(Properties, 'LivePreRollConfiguration') as live_pre_roll_configuration, + json_extract_path_text(Properties, 'ManifestProcessingRules') as manifest_processing_rules, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'PersonalizationThresholdSeconds') as personalization_threshold_seconds, + json_extract_path_text(Properties, 'SessionInitializationEndpointPrefix') as session_initialization_endpoint_prefix, + json_extract_path_text(Properties, 'HlsConfiguration') as hls_configuration, + json_extract_path_text(Properties, 'PlaybackConfigurationArn') as playback_configuration_arn, + json_extract_path_text(Properties, 'PlaybackEndpointPrefix') as playback_endpoint_prefix, + json_extract_path_text(Properties, 'SlateAdUrl') as slate_ad_url, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'TranscodeProfileName') as transcode_profile_name, + json_extract_path_text(Properties, 'VideoContentSourceUrl') as video_content_source_url + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MediaTailor::PlaybackConfiguration' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaTailor::PlaybackConfiguration' + AND region = 'us-east-1' source_locations: name: source_locations id: aws.mediatailor.source_locations @@ -1849,7 +1809,7 @@ components: x-cfn-type-name: AWS::MediaTailor::SourceLocation x-identifiers: - SourceLocationName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1866,9 +1826,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1878,41 +1838,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/source_locations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/source_locations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.SourceLocationName') as source_location_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaTailor::SourceLocation' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'SourceLocationName') as source_location_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaTailor::SourceLocation' - AND region = 'us-east-1' - source_location: - name: source_location - id: aws.mediatailor.source_location - x-cfn-schema-name: SourceLocation - x-cfn-type-name: AWS::MediaTailor::SourceLocation - x-identifiers: - - SourceLocationName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1923,12 +1851,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/source_locations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/source_locations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/source_location/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/source_locations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1944,21 +1876,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AccessConfiguration') as access_configuration, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'DefaultSegmentDeliveryConfiguration') as default_segment_delivery_configuration, - json_extract_path_text(Properties, 'HttpConfiguration') as http_configuration, - json_extract_path_text(Properties, 'SegmentDeliveryConfigurations') as segment_delivery_configurations, - json_extract_path_text(Properties, 'SourceLocationName') as source_location_name, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MediaTailor::SourceLocation' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.SourceLocationName') as source_location_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaTailor::SourceLocation' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AccessConfiguration') as access_configuration, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'DefaultSegmentDeliveryConfiguration') as default_segment_delivery_configuration, + json_extract_path_text(Properties, 'HttpConfiguration') as http_configuration, + json_extract_path_text(Properties, 'SegmentDeliveryConfigurations') as segment_delivery_configurations, + json_extract_path_text(Properties, 'SourceLocationName') as source_location_name, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MediaTailor::SourceLocation' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'SourceLocationName') as source_location_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaTailor::SourceLocation' + AND region = 'us-east-1' vod_sources: name: vod_sources id: aws.mediatailor.vod_sources @@ -1967,7 +1915,7 @@ components: x-identifiers: - SourceLocationName - VodSourceName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1984,9 +1932,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1996,44 +1944,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/vod_sources/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/vod_sources/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.SourceLocationName') as source_location_name, - JSON_EXTRACT(Properties, '$.VodSourceName') as vod_source_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaTailor::VodSource' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'SourceLocationName') as source_location_name, - json_extract_path_text(Properties, 'VodSourceName') as vod_source_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaTailor::VodSource' - AND region = 'us-east-1' - vod_source: - name: vod_source - id: aws.mediatailor.vod_source - x-cfn-schema-name: VodSource - x-cfn-type-name: AWS::MediaTailor::VodSource - x-identifiers: - - SourceLocationName - - VodSourceName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2044,12 +1957,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/vod_sources/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/vod_sources/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/vod_source/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/vod_sources/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2063,19 +1980,37 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'HttpPackageConfigurations') as http_package_configurations, - json_extract_path_text(Properties, 'SourceLocationName') as source_location_name, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'VodSourceName') as vod_source_name - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MediaTailor::VodSource' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.SourceLocationName') as source_location_name, + JSON_EXTRACT(Properties, '$.VodSourceName') as vod_source_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaTailor::VodSource' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'HttpPackageConfigurations') as http_package_configurations, + json_extract_path_text(Properties, 'SourceLocationName') as source_location_name, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'VodSourceName') as vod_source_name + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MediaTailor::VodSource' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'SourceLocationName') as source_location_name, + json_extract_path_text(Properties, 'VodSourceName') as vod_source_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MediaTailor::VodSource' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/memorydb.yaml b/providers/src/aws/v00.00.00000/services/memorydb.yaml index 46dd56be..c531b454 100644 --- a/providers/src/aws/v00.00.00000/services/memorydb.yaml +++ b/providers/src/aws/v00.00.00000/services/memorydb.yaml @@ -1181,7 +1181,7 @@ components: x-cfn-type-name: AWS::MemoryDB::ACL x-identifiers: - ACLName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1198,9 +1198,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1210,41 +1210,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/acls/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/acls/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ACLName') as acl_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MemoryDB::ACL' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ACLName') as acl_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MemoryDB::ACL' - AND region = 'us-east-1' - acl: - name: acl - id: aws.memorydb.acl - x-cfn-schema-name: ACL - x-cfn-type-name: AWS::MemoryDB::ACL - x-identifiers: - - ACLName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1255,12 +1223,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/acls/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/acls/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/acl/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/acls/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1274,19 +1246,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'ACLName') as acl_name, - json_extract_path_text(Properties, 'UserNames') as user_names, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MemoryDB::ACL' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ACLName') as acl_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MemoryDB::ACL' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'ACLName') as acl_name, + json_extract_path_text(Properties, 'UserNames') as user_names, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MemoryDB::ACL' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ACLName') as acl_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MemoryDB::ACL' + AND region = 'us-east-1' clusters: name: clusters id: aws.memorydb.clusters @@ -1294,7 +1282,7 @@ components: x-cfn-type-name: AWS::MemoryDB::Cluster x-identifiers: - ClusterName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1311,9 +1299,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1323,41 +1311,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/clusters/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/clusters/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ClusterName') as cluster_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MemoryDB::Cluster' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ClusterName') as cluster_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MemoryDB::Cluster' - AND region = 'us-east-1' - cluster: - name: cluster - id: aws.memorydb.cluster - x-cfn-schema-name: Cluster - x-cfn-type-name: AWS::MemoryDB::Cluster - x-identifiers: - - ClusterName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1368,12 +1324,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/clusters/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/clusters/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/cluster/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/clusters/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1410,42 +1370,58 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ClusterName') as cluster_name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'NodeType') as node_type, - json_extract_path_text(Properties, 'NumShards') as num_shards, - json_extract_path_text(Properties, 'NumReplicasPerShard') as num_replicas_per_shard, - json_extract_path_text(Properties, 'SubnetGroupName') as subnet_group_name, - json_extract_path_text(Properties, 'SecurityGroupIds') as security_group_ids, - json_extract_path_text(Properties, 'MaintenanceWindow') as maintenance_window, - json_extract_path_text(Properties, 'ParameterGroupName') as parameter_group_name, - json_extract_path_text(Properties, 'ParameterGroupStatus') as parameter_group_status, - json_extract_path_text(Properties, 'Port') as port, - json_extract_path_text(Properties, 'SnapshotRetentionLimit') as snapshot_retention_limit, - json_extract_path_text(Properties, 'SnapshotWindow') as snapshot_window, - json_extract_path_text(Properties, 'ACLName') as acl_name, - json_extract_path_text(Properties, 'SnsTopicArn') as sns_topic_arn, - json_extract_path_text(Properties, 'SnsTopicStatus') as sns_topic_status, - json_extract_path_text(Properties, 'TLSEnabled') as tls_enabled, - json_extract_path_text(Properties, 'DataTiering') as data_tiering, - json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, - json_extract_path_text(Properties, 'SnapshotArns') as snapshot_arns, - json_extract_path_text(Properties, 'SnapshotName') as snapshot_name, - json_extract_path_text(Properties, 'FinalSnapshotName') as final_snapshot_name, - json_extract_path_text(Properties, 'ARN') as arn, - json_extract_path_text(Properties, 'EngineVersion') as engine_version, - json_extract_path_text(Properties, 'ClusterEndpoint') as cluster_endpoint, - json_extract_path_text(Properties, 'AutoMinorVersionUpgrade') as auto_minor_version_upgrade, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MemoryDB::Cluster' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ClusterName') as cluster_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MemoryDB::Cluster' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ClusterName') as cluster_name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'NodeType') as node_type, + json_extract_path_text(Properties, 'NumShards') as num_shards, + json_extract_path_text(Properties, 'NumReplicasPerShard') as num_replicas_per_shard, + json_extract_path_text(Properties, 'SubnetGroupName') as subnet_group_name, + json_extract_path_text(Properties, 'SecurityGroupIds') as security_group_ids, + json_extract_path_text(Properties, 'MaintenanceWindow') as maintenance_window, + json_extract_path_text(Properties, 'ParameterGroupName') as parameter_group_name, + json_extract_path_text(Properties, 'ParameterGroupStatus') as parameter_group_status, + json_extract_path_text(Properties, 'Port') as port, + json_extract_path_text(Properties, 'SnapshotRetentionLimit') as snapshot_retention_limit, + json_extract_path_text(Properties, 'SnapshotWindow') as snapshot_window, + json_extract_path_text(Properties, 'ACLName') as acl_name, + json_extract_path_text(Properties, 'SnsTopicArn') as sns_topic_arn, + json_extract_path_text(Properties, 'SnsTopicStatus') as sns_topic_status, + json_extract_path_text(Properties, 'TLSEnabled') as tls_enabled, + json_extract_path_text(Properties, 'DataTiering') as data_tiering, + json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, + json_extract_path_text(Properties, 'SnapshotArns') as snapshot_arns, + json_extract_path_text(Properties, 'SnapshotName') as snapshot_name, + json_extract_path_text(Properties, 'FinalSnapshotName') as final_snapshot_name, + json_extract_path_text(Properties, 'ARN') as arn, + json_extract_path_text(Properties, 'EngineVersion') as engine_version, + json_extract_path_text(Properties, 'ClusterEndpoint') as cluster_endpoint, + json_extract_path_text(Properties, 'AutoMinorVersionUpgrade') as auto_minor_version_upgrade, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MemoryDB::Cluster' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ClusterName') as cluster_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MemoryDB::Cluster' + AND region = 'us-east-1' parameter_groups: name: parameter_groups id: aws.memorydb.parameter_groups @@ -1453,7 +1429,7 @@ components: x-cfn-type-name: AWS::MemoryDB::ParameterGroup x-identifiers: - ParameterGroupName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1470,9 +1446,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1482,41 +1458,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/parameter_groups/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/parameter_groups/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ParameterGroupName') as parameter_group_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MemoryDB::ParameterGroup' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ParameterGroupName') as parameter_group_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MemoryDB::ParameterGroup' - AND region = 'us-east-1' - parameter_group: - name: parameter_group - id: aws.memorydb.parameter_group - x-cfn-schema-name: ParameterGroup - x-cfn-type-name: AWS::MemoryDB::ParameterGroup - x-identifiers: - - ParameterGroupName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1527,12 +1471,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/parameter_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/parameter_groups/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/parameter_group/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/parameter_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1547,20 +1495,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ParameterGroupName') as parameter_group_name, - json_extract_path_text(Properties, 'Family') as family, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Parameters') as parameters, - json_extract_path_text(Properties, 'ARN') as arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MemoryDB::ParameterGroup' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ParameterGroupName') as parameter_group_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MemoryDB::ParameterGroup' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ParameterGroupName') as parameter_group_name, + json_extract_path_text(Properties, 'Family') as family, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Parameters') as parameters, + json_extract_path_text(Properties, 'ARN') as arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MemoryDB::ParameterGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ParameterGroupName') as parameter_group_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MemoryDB::ParameterGroup' + AND region = 'us-east-1' subnet_groups: name: subnet_groups id: aws.memorydb.subnet_groups @@ -1568,7 +1532,7 @@ components: x-cfn-type-name: AWS::MemoryDB::SubnetGroup x-identifiers: - SubnetGroupName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1585,9 +1549,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1597,41 +1561,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/subnet_groups/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/subnet_groups/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.SubnetGroupName') as subnet_group_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MemoryDB::SubnetGroup' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'SubnetGroupName') as subnet_group_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MemoryDB::SubnetGroup' - AND region = 'us-east-1' - subnet_group: - name: subnet_group - id: aws.memorydb.subnet_group - x-cfn-schema-name: SubnetGroup - x-cfn-type-name: AWS::MemoryDB::SubnetGroup - x-identifiers: - - SubnetGroupName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1642,12 +1574,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/subnet_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/subnet_groups/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/subnet_group/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/subnet_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1661,19 +1597,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'SubnetGroupName') as subnet_group_name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'SubnetIds') as subnet_ids, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'ARN') as arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MemoryDB::SubnetGroup' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.SubnetGroupName') as subnet_group_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MemoryDB::SubnetGroup' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'SubnetGroupName') as subnet_group_name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'SubnetIds') as subnet_ids, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'ARN') as arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MemoryDB::SubnetGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'SubnetGroupName') as subnet_group_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MemoryDB::SubnetGroup' + AND region = 'us-east-1' users: name: users id: aws.memorydb.users @@ -1681,7 +1633,7 @@ components: x-cfn-type-name: AWS::MemoryDB::User x-identifiers: - UserName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1698,9 +1650,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1710,41 +1662,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/users/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/users/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.UserName') as user_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MemoryDB::User' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'UserName') as user_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MemoryDB::User' - AND region = 'us-east-1' - user: - name: user - id: aws.memorydb.user - x-cfn-schema-name: User - x-cfn-type-name: AWS::MemoryDB::User - x-identifiers: - - UserName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1755,12 +1675,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/users/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/users/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/user/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/users/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1775,20 +1699,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'UserName') as user_name, - json_extract_path_text(Properties, 'AccessString') as access_string, - json_extract_path_text(Properties, 'AuthenticationMode') as authentication_mode, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MemoryDB::User' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.UserName') as user_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MemoryDB::User' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'UserName') as user_name, + json_extract_path_text(Properties, 'AccessString') as access_string, + json_extract_path_text(Properties, 'AuthenticationMode') as authentication_mode, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MemoryDB::User' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'UserName') as user_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MemoryDB::User' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/msk.yaml b/providers/src/aws/v00.00.00000/services/msk.yaml index fa0b494e..57031bec 100644 --- a/providers/src/aws/v00.00.00000/services/msk.yaml +++ b/providers/src/aws/v00.00.00000/services/msk.yaml @@ -1797,7 +1797,7 @@ components: x-cfn-type-name: AWS::MSK::BatchScramSecret x-identifiers: - ClusterArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1814,9 +1814,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1826,41 +1826,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/batch_scram_secrets/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/batch_scram_secrets/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ClusterArn') as cluster_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MSK::BatchScramSecret' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ClusterArn') as cluster_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MSK::BatchScramSecret' - AND region = 'us-east-1' - batch_scram_secret: - name: batch_scram_secret - id: aws.msk.batch_scram_secret - x-cfn-schema-name: BatchScramSecret - x-cfn-type-name: AWS::MSK::BatchScramSecret - x-identifiers: - - ClusterArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1871,12 +1839,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/batch_scram_secrets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/batch_scram_secrets/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/batch_scram_secret/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/batch_scram_secrets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1887,16 +1859,32 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ClusterArn') as cluster_arn, - json_extract_path_text(Properties, 'SecretArnList') as secret_arn_list - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MSK::BatchScramSecret' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ClusterArn') as cluster_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MSK::BatchScramSecret' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ClusterArn') as cluster_arn, + json_extract_path_text(Properties, 'SecretArnList') as secret_arn_list + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MSK::BatchScramSecret' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ClusterArn') as cluster_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MSK::BatchScramSecret' + AND region = 'us-east-1' clusters: name: clusters id: aws.msk.clusters @@ -1904,7 +1892,7 @@ components: x-cfn-type-name: AWS::MSK::Cluster x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1921,9 +1909,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1933,41 +1921,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/clusters/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/clusters/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MSK::Cluster' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MSK::Cluster' - AND region = 'us-east-1' - cluster: - name: cluster - id: aws.msk.cluster - x-cfn-schema-name: Cluster - x-cfn-type-name: AWS::MSK::Cluster - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1978,12 +1934,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/clusters/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/clusters/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/cluster/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/clusters/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2006,28 +1966,44 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'BrokerNodeGroupInfo') as broker_node_group_info, - json_extract_path_text(Properties, 'EnhancedMonitoring') as enhanced_monitoring, - json_extract_path_text(Properties, 'KafkaVersion') as kafka_version, - json_extract_path_text(Properties, 'NumberOfBrokerNodes') as number_of_broker_nodes, - json_extract_path_text(Properties, 'EncryptionInfo') as encryption_info, - json_extract_path_text(Properties, 'OpenMonitoring') as open_monitoring, - json_extract_path_text(Properties, 'ClusterName') as cluster_name, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'CurrentVersion') as current_version, - json_extract_path_text(Properties, 'ClientAuthentication') as client_authentication, - json_extract_path_text(Properties, 'LoggingInfo') as logging_info, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'ConfigurationInfo') as configuration_info, - json_extract_path_text(Properties, 'StorageMode') as storage_mode - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MSK::Cluster' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MSK::Cluster' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'BrokerNodeGroupInfo') as broker_node_group_info, + json_extract_path_text(Properties, 'EnhancedMonitoring') as enhanced_monitoring, + json_extract_path_text(Properties, 'KafkaVersion') as kafka_version, + json_extract_path_text(Properties, 'NumberOfBrokerNodes') as number_of_broker_nodes, + json_extract_path_text(Properties, 'EncryptionInfo') as encryption_info, + json_extract_path_text(Properties, 'OpenMonitoring') as open_monitoring, + json_extract_path_text(Properties, 'ClusterName') as cluster_name, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'CurrentVersion') as current_version, + json_extract_path_text(Properties, 'ClientAuthentication') as client_authentication, + json_extract_path_text(Properties, 'LoggingInfo') as logging_info, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'ConfigurationInfo') as configuration_info, + json_extract_path_text(Properties, 'StorageMode') as storage_mode + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MSK::Cluster' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MSK::Cluster' + AND region = 'us-east-1' cluster_policies: name: cluster_policies id: aws.msk.cluster_policies @@ -2035,7 +2011,7 @@ components: x-cfn-type-name: AWS::MSK::ClusterPolicy x-identifiers: - ClusterArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2052,9 +2028,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2064,41 +2040,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/cluster_policies/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/cluster_policies/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ClusterArn') as cluster_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MSK::ClusterPolicy' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ClusterArn') as cluster_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MSK::ClusterPolicy' - AND region = 'us-east-1' - cluster_policy: - name: cluster_policy - id: aws.msk.cluster_policy - x-cfn-schema-name: ClusterPolicy - x-cfn-type-name: AWS::MSK::ClusterPolicy - x-identifiers: - - ClusterArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2109,12 +2053,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/cluster_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/cluster_policies/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/cluster_policy/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/cluster_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2126,17 +2074,33 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Policy') as policy, - json_extract_path_text(Properties, 'ClusterArn') as cluster_arn, - json_extract_path_text(Properties, 'CurrentVersion') as current_version - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MSK::ClusterPolicy' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ClusterArn') as cluster_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MSK::ClusterPolicy' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Policy') as policy, + json_extract_path_text(Properties, 'ClusterArn') as cluster_arn, + json_extract_path_text(Properties, 'CurrentVersion') as current_version + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MSK::ClusterPolicy' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ClusterArn') as cluster_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MSK::ClusterPolicy' + AND region = 'us-east-1' configurations: name: configurations id: aws.msk.configurations @@ -2144,7 +2108,7 @@ components: x-cfn-type-name: AWS::MSK::Configuration x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2161,9 +2125,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2173,41 +2137,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/configurations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/configurations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MSK::Configuration' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MSK::Configuration' - AND region = 'us-east-1' - configuration: - name: configuration - id: aws.msk.configuration - x-cfn-schema-name: Configuration - x-cfn-type-name: AWS::MSK::Configuration - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2218,12 +2150,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/configurations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/configuration/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/configurations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2238,20 +2174,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'ServerProperties') as server_properties, - json_extract_path_text(Properties, 'KafkaVersionsList') as kafka_versions_list, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'LatestRevision') as latest_revision - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MSK::Configuration' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MSK::Configuration' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'ServerProperties') as server_properties, + json_extract_path_text(Properties, 'KafkaVersionsList') as kafka_versions_list, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'LatestRevision') as latest_revision + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MSK::Configuration' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MSK::Configuration' + AND region = 'us-east-1' replicators: name: replicators id: aws.msk.replicators @@ -2259,7 +2211,7 @@ components: x-cfn-type-name: AWS::MSK::Replicator x-identifiers: - ReplicatorArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2276,9 +2228,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2288,41 +2240,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/replicators/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/replicators/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ReplicatorArn') as replicator_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MSK::Replicator' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ReplicatorArn') as replicator_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MSK::Replicator' - AND region = 'us-east-1' - replicator: - name: replicator - id: aws.msk.replicator - x-cfn-schema-name: Replicator - x-cfn-type-name: AWS::MSK::Replicator - x-identifiers: - - ReplicatorArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2333,12 +2253,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/replicators/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/replicators/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/replicator/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/replicators/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2355,22 +2279,38 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ReplicatorArn') as replicator_arn, - json_extract_path_text(Properties, 'ReplicatorName') as replicator_name, - json_extract_path_text(Properties, 'CurrentVersion') as current_version, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'KafkaClusters') as kafka_clusters, - json_extract_path_text(Properties, 'ReplicationInfoList') as replication_info_list, - json_extract_path_text(Properties, 'ServiceExecutionRoleArn') as service_execution_role_arn, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MSK::Replicator' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ReplicatorArn') as replicator_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MSK::Replicator' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ReplicatorArn') as replicator_arn, + json_extract_path_text(Properties, 'ReplicatorName') as replicator_name, + json_extract_path_text(Properties, 'CurrentVersion') as current_version, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'KafkaClusters') as kafka_clusters, + json_extract_path_text(Properties, 'ReplicationInfoList') as replication_info_list, + json_extract_path_text(Properties, 'ServiceExecutionRoleArn') as service_execution_role_arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MSK::Replicator' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ReplicatorArn') as replicator_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MSK::Replicator' + AND region = 'us-east-1' serverless_clusters: name: serverless_clusters id: aws.msk.serverless_clusters @@ -2378,7 +2318,7 @@ components: x-cfn-type-name: AWS::MSK::ServerlessCluster x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2412,39 +2352,11 @@ components: - $ref: '#/components/x-stackQL-resources/serverless_clusters/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/serverless_clusters/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MSK::ServerlessCluster' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MSK::ServerlessCluster' - AND region = 'us-east-1' - serverless_cluster: - name: serverless_cluster - id: aws.msk.serverless_cluster - x-cfn-schema-name: ServerlessCluster - x-cfn-type-name: AWS::MSK::ServerlessCluster - x-identifiers: - - Arn - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2458,19 +2370,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'ClusterName') as cluster_name, - json_extract_path_text(Properties, 'VpcConfigs') as vpc_configs, - json_extract_path_text(Properties, 'ClientAuthentication') as client_authentication, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MSK::ServerlessCluster' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MSK::ServerlessCluster' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'ClusterName') as cluster_name, + json_extract_path_text(Properties, 'VpcConfigs') as vpc_configs, + json_extract_path_text(Properties, 'ClientAuthentication') as client_authentication, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MSK::ServerlessCluster' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MSK::ServerlessCluster' + AND region = 'us-east-1' vpc_connections: name: vpc_connections id: aws.msk.vpc_connections @@ -2478,7 +2406,7 @@ components: x-cfn-type-name: AWS::MSK::VpcConnection x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2495,9 +2423,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2507,41 +2435,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/vpc_connections/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/vpc_connections/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MSK::VpcConnection' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MSK::VpcConnection' - AND region = 'us-east-1' - vpc_connection: - name: vpc_connection - id: aws.msk.vpc_connection - x-cfn-schema-name: VpcConnection - x-cfn-type-name: AWS::MSK::VpcConnection - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2552,12 +2448,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/vpc_connections/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/vpc_connections/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/vpc_connection/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/vpc_connections/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2573,21 +2473,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Authentication') as authentication, - json_extract_path_text(Properties, 'ClientSubnets') as client_subnets, - json_extract_path_text(Properties, 'TargetClusterArn') as target_cluster_arn, - json_extract_path_text(Properties, 'SecurityGroups') as security_groups, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'VpcId') as vpc_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MSK::VpcConnection' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MSK::VpcConnection' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Authentication') as authentication, + json_extract_path_text(Properties, 'ClientSubnets') as client_subnets, + json_extract_path_text(Properties, 'TargetClusterArn') as target_cluster_arn, + json_extract_path_text(Properties, 'SecurityGroups') as security_groups, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'VpcId') as vpc_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MSK::VpcConnection' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MSK::VpcConnection' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/mwaa.yaml b/providers/src/aws/v00.00.00000/services/mwaa.yaml index b999c9b5..ef0a709f 100644 --- a/providers/src/aws/v00.00.00000/services/mwaa.yaml +++ b/providers/src/aws/v00.00.00000/services/mwaa.yaml @@ -539,6 +539,14 @@ components: type: integer description: Minimum worker compute units. minimum: 1 + MaxWebservers: + type: integer + description: Maximum webserver compute units. + minimum: 2 + MinWebservers: + type: integer + description: Minimum webserver compute units. + minimum: 2 Schedulers: type: integer description: Scheduler compute units. @@ -716,6 +724,10 @@ components: $ref: '#/components/schemas/MaxWorkers' MinWorkers: $ref: '#/components/schemas/MinWorkers' + MaxWebservers: + $ref: '#/components/schemas/MaxWebservers' + MinWebservers: + $ref: '#/components/schemas/MinWebservers' Schedulers: $ref: '#/components/schemas/Schedulers' NetworkConfiguration: @@ -835,6 +847,10 @@ components: $ref: '#/components/schemas/MaxWorkers' MinWorkers: $ref: '#/components/schemas/MinWorkers' + MaxWebservers: + $ref: '#/components/schemas/MaxWebservers' + MinWebservers: + $ref: '#/components/schemas/MinWebservers' Schedulers: $ref: '#/components/schemas/Schedulers' NetworkConfiguration: @@ -875,7 +891,7 @@ components: x-cfn-type-name: AWS::MWAA::Environment x-identifiers: - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -892,9 +908,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -904,41 +920,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/environments/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/environments/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MWAA::Environment' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MWAA::Environment' - AND region = 'us-east-1' - environment: - name: environment - id: aws.mwaa.environment - x-cfn-schema-name: Environment - x-cfn-type-name: AWS::MWAA::Environment - x-identifiers: - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -949,12 +933,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/environments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/environments/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/environment/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/environments/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -977,6 +965,8 @@ components: JSON_EXTRACT(Properties, '$.EnvironmentClass') as environment_class, JSON_EXTRACT(Properties, '$.MaxWorkers') as max_workers, JSON_EXTRACT(Properties, '$.MinWorkers') as min_workers, + JSON_EXTRACT(Properties, '$.MaxWebservers') as max_webservers, + JSON_EXTRACT(Properties, '$.MinWebservers') as min_webservers, JSON_EXTRACT(Properties, '$.Schedulers') as schedulers, JSON_EXTRACT(Properties, '$.NetworkConfiguration') as network_configuration, JSON_EXTRACT(Properties, '$.LoggingConfiguration') as logging_configuration, @@ -991,42 +981,60 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'WebserverUrl') as webserver_url, - json_extract_path_text(Properties, 'ExecutionRoleArn') as execution_role_arn, - json_extract_path_text(Properties, 'KmsKey') as kms_key, - json_extract_path_text(Properties, 'AirflowVersion') as airflow_version, - json_extract_path_text(Properties, 'SourceBucketArn') as source_bucket_arn, - json_extract_path_text(Properties, 'DagS3Path') as dag_s3_path, - json_extract_path_text(Properties, 'PluginsS3Path') as plugins_s3_path, - json_extract_path_text(Properties, 'PluginsS3ObjectVersion') as plugins_s3_object_version, - json_extract_path_text(Properties, 'RequirementsS3Path') as requirements_s3_path, - json_extract_path_text(Properties, 'RequirementsS3ObjectVersion') as requirements_s3_object_version, - json_extract_path_text(Properties, 'StartupScriptS3Path') as startup_script_s3_path, - json_extract_path_text(Properties, 'StartupScriptS3ObjectVersion') as startup_script_s3_object_version, - json_extract_path_text(Properties, 'AirflowConfigurationOptions') as airflow_configuration_options, - json_extract_path_text(Properties, 'EnvironmentClass') as environment_class, - json_extract_path_text(Properties, 'MaxWorkers') as max_workers, - json_extract_path_text(Properties, 'MinWorkers') as min_workers, - json_extract_path_text(Properties, 'Schedulers') as schedulers, - json_extract_path_text(Properties, 'NetworkConfiguration') as network_configuration, - json_extract_path_text(Properties, 'LoggingConfiguration') as logging_configuration, - json_extract_path_text(Properties, 'WeeklyMaintenanceWindowStart') as weekly_maintenance_window_start, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'WebserverAccessMode') as webserver_access_mode, - json_extract_path_text(Properties, 'EndpointManagement') as endpoint_management, - json_extract_path_text(Properties, 'CeleryExecutorQueue') as celery_executor_queue, - json_extract_path_text(Properties, 'DatabaseVpcEndpointService') as database_vpc_endpoint_service, - json_extract_path_text(Properties, 'WebserverVpcEndpointService') as webserver_vpc_endpoint_service - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MWAA::Environment' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MWAA::Environment' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'WebserverUrl') as webserver_url, + json_extract_path_text(Properties, 'ExecutionRoleArn') as execution_role_arn, + json_extract_path_text(Properties, 'KmsKey') as kms_key, + json_extract_path_text(Properties, 'AirflowVersion') as airflow_version, + json_extract_path_text(Properties, 'SourceBucketArn') as source_bucket_arn, + json_extract_path_text(Properties, 'DagS3Path') as dag_s3_path, + json_extract_path_text(Properties, 'PluginsS3Path') as plugins_s3_path, + json_extract_path_text(Properties, 'PluginsS3ObjectVersion') as plugins_s3_object_version, + json_extract_path_text(Properties, 'RequirementsS3Path') as requirements_s3_path, + json_extract_path_text(Properties, 'RequirementsS3ObjectVersion') as requirements_s3_object_version, + json_extract_path_text(Properties, 'StartupScriptS3Path') as startup_script_s3_path, + json_extract_path_text(Properties, 'StartupScriptS3ObjectVersion') as startup_script_s3_object_version, + json_extract_path_text(Properties, 'AirflowConfigurationOptions') as airflow_configuration_options, + json_extract_path_text(Properties, 'EnvironmentClass') as environment_class, + json_extract_path_text(Properties, 'MaxWorkers') as max_workers, + json_extract_path_text(Properties, 'MinWorkers') as min_workers, + json_extract_path_text(Properties, 'MaxWebservers') as max_webservers, + json_extract_path_text(Properties, 'MinWebservers') as min_webservers, + json_extract_path_text(Properties, 'Schedulers') as schedulers, + json_extract_path_text(Properties, 'NetworkConfiguration') as network_configuration, + json_extract_path_text(Properties, 'LoggingConfiguration') as logging_configuration, + json_extract_path_text(Properties, 'WeeklyMaintenanceWindowStart') as weekly_maintenance_window_start, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'WebserverAccessMode') as webserver_access_mode, + json_extract_path_text(Properties, 'EndpointManagement') as endpoint_management, + json_extract_path_text(Properties, 'CeleryExecutorQueue') as celery_executor_queue, + json_extract_path_text(Properties, 'DatabaseVpcEndpointService') as database_vpc_endpoint_service, + json_extract_path_text(Properties, 'WebserverVpcEndpointService') as webserver_vpc_endpoint_service + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::MWAA::Environment' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::MWAA::Environment' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/neptune.yaml b/providers/src/aws/v00.00.00000/services/neptune.yaml index f529ce34..f2145ea5 100644 --- a/providers/src/aws/v00.00.00000/services/neptune.yaml +++ b/providers/src/aws/v00.00.00000/services/neptune.yaml @@ -846,7 +846,7 @@ components: x-cfn-type-name: AWS::Neptune::DBCluster x-identifiers: - DBClusterIdentifier - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -863,9 +863,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -875,41 +875,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/db_clusters/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/db_clusters/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.DBClusterIdentifier') as db_cluster_identifier - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Neptune::DBCluster' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'DBClusterIdentifier') as db_cluster_identifier - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Neptune::DBCluster' - AND region = 'us-east-1' - db_cluster: - name: db_cluster - id: aws.neptune.db_cluster - x-cfn-schema-name: DBCluster - x-cfn-type-name: AWS::Neptune::DBCluster - x-identifiers: - - DBClusterIdentifier - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -920,12 +888,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/db_clusters/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/db_clusters/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/db_cluster/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/db_clusters/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -963,43 +935,59 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Endpoint') as endpoint, - json_extract_path_text(Properties, 'ReadEndpoint') as read_endpoint, - json_extract_path_text(Properties, 'ClusterResourceId') as cluster_resource_id, - json_extract_path_text(Properties, 'AssociatedRoles') as associated_roles, - json_extract_path_text(Properties, 'AvailabilityZones') as availability_zones, - json_extract_path_text(Properties, 'BackupRetentionPeriod') as backup_retention_period, - json_extract_path_text(Properties, 'CopyTagsToSnapshot') as copy_tags_to_snapshot, - json_extract_path_text(Properties, 'DBClusterIdentifier') as db_cluster_identifier, - json_extract_path_text(Properties, 'DBClusterParameterGroupName') as db_cluster_parameter_group_name, - json_extract_path_text(Properties, 'DBInstanceParameterGroupName') as db_instance_parameter_group_name, - json_extract_path_text(Properties, 'DBPort') as db_port, - json_extract_path_text(Properties, 'DBSubnetGroupName') as db_subnet_group_name, - json_extract_path_text(Properties, 'DeletionProtection') as deletion_protection, - json_extract_path_text(Properties, 'EnableCloudwatchLogsExports') as enable_cloudwatch_logs_exports, - json_extract_path_text(Properties, 'EngineVersion') as engine_version, - json_extract_path_text(Properties, 'IamAuthEnabled') as iam_auth_enabled, - json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, - json_extract_path_text(Properties, 'Port') as port, - json_extract_path_text(Properties, 'PreferredBackupWindow') as preferred_backup_window, - json_extract_path_text(Properties, 'PreferredMaintenanceWindow') as preferred_maintenance_window, - json_extract_path_text(Properties, 'RestoreToTime') as restore_to_time, - json_extract_path_text(Properties, 'RestoreType') as restore_type, - json_extract_path_text(Properties, 'ServerlessScalingConfiguration') as serverless_scaling_configuration, - json_extract_path_text(Properties, 'SnapshotIdentifier') as snapshot_identifier, - json_extract_path_text(Properties, 'SourceDBClusterIdentifier') as source_db_cluster_identifier, - json_extract_path_text(Properties, 'StorageEncrypted') as storage_encrypted, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'UseLatestRestorableTime') as use_latest_restorable_time, - json_extract_path_text(Properties, 'VpcSecurityGroupIds') as vpc_security_group_ids - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Neptune::DBCluster' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.DBClusterIdentifier') as db_cluster_identifier + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Neptune::DBCluster' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Endpoint') as endpoint, + json_extract_path_text(Properties, 'ReadEndpoint') as read_endpoint, + json_extract_path_text(Properties, 'ClusterResourceId') as cluster_resource_id, + json_extract_path_text(Properties, 'AssociatedRoles') as associated_roles, + json_extract_path_text(Properties, 'AvailabilityZones') as availability_zones, + json_extract_path_text(Properties, 'BackupRetentionPeriod') as backup_retention_period, + json_extract_path_text(Properties, 'CopyTagsToSnapshot') as copy_tags_to_snapshot, + json_extract_path_text(Properties, 'DBClusterIdentifier') as db_cluster_identifier, + json_extract_path_text(Properties, 'DBClusterParameterGroupName') as db_cluster_parameter_group_name, + json_extract_path_text(Properties, 'DBInstanceParameterGroupName') as db_instance_parameter_group_name, + json_extract_path_text(Properties, 'DBPort') as db_port, + json_extract_path_text(Properties, 'DBSubnetGroupName') as db_subnet_group_name, + json_extract_path_text(Properties, 'DeletionProtection') as deletion_protection, + json_extract_path_text(Properties, 'EnableCloudwatchLogsExports') as enable_cloudwatch_logs_exports, + json_extract_path_text(Properties, 'EngineVersion') as engine_version, + json_extract_path_text(Properties, 'IamAuthEnabled') as iam_auth_enabled, + json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, + json_extract_path_text(Properties, 'Port') as port, + json_extract_path_text(Properties, 'PreferredBackupWindow') as preferred_backup_window, + json_extract_path_text(Properties, 'PreferredMaintenanceWindow') as preferred_maintenance_window, + json_extract_path_text(Properties, 'RestoreToTime') as restore_to_time, + json_extract_path_text(Properties, 'RestoreType') as restore_type, + json_extract_path_text(Properties, 'ServerlessScalingConfiguration') as serverless_scaling_configuration, + json_extract_path_text(Properties, 'SnapshotIdentifier') as snapshot_identifier, + json_extract_path_text(Properties, 'SourceDBClusterIdentifier') as source_db_cluster_identifier, + json_extract_path_text(Properties, 'StorageEncrypted') as storage_encrypted, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'UseLatestRestorableTime') as use_latest_restorable_time, + json_extract_path_text(Properties, 'VpcSecurityGroupIds') as vpc_security_group_ids + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Neptune::DBCluster' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DBClusterIdentifier') as db_cluster_identifier + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Neptune::DBCluster' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/neptunegraph.yaml b/providers/src/aws/v00.00.00000/services/neptunegraph.yaml index c07a6bc9..a807141a 100644 --- a/providers/src/aws/v00.00.00000/services/neptunegraph.yaml +++ b/providers/src/aws/v00.00.00000/services/neptunegraph.yaml @@ -768,7 +768,7 @@ components: x-cfn-type-name: AWS::NeptuneGraph::Graph x-identifiers: - GraphId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -785,9 +785,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -797,41 +797,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/graphs/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/graphs/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.GraphId') as graph_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NeptuneGraph::Graph' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'GraphId') as graph_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NeptuneGraph::Graph' - AND region = 'us-east-1' - graph: - name: graph - id: aws.neptunegraph.graph - x-cfn-schema-name: Graph - x-cfn-type-name: AWS::NeptuneGraph::Graph - x-identifiers: - - GraphId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -842,12 +810,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/graphs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/graphs/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/graph/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/graphs/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -866,24 +838,40 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'DeletionProtection') as deletion_protection, - json_extract_path_text(Properties, 'GraphName') as graph_name, - json_extract_path_text(Properties, 'ProvisionedMemory') as provisioned_memory, - json_extract_path_text(Properties, 'PublicConnectivity') as public_connectivity, - json_extract_path_text(Properties, 'ReplicaCount') as replica_count, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'VectorSearchConfiguration') as vector_search_configuration, - json_extract_path_text(Properties, 'Endpoint') as endpoint, - json_extract_path_text(Properties, 'GraphArn') as graph_arn, - json_extract_path_text(Properties, 'GraphId') as graph_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::NeptuneGraph::Graph' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.GraphId') as graph_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NeptuneGraph::Graph' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DeletionProtection') as deletion_protection, + json_extract_path_text(Properties, 'GraphName') as graph_name, + json_extract_path_text(Properties, 'ProvisionedMemory') as provisioned_memory, + json_extract_path_text(Properties, 'PublicConnectivity') as public_connectivity, + json_extract_path_text(Properties, 'ReplicaCount') as replica_count, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'VectorSearchConfiguration') as vector_search_configuration, + json_extract_path_text(Properties, 'Endpoint') as endpoint, + json_extract_path_text(Properties, 'GraphArn') as graph_arn, + json_extract_path_text(Properties, 'GraphId') as graph_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::NeptuneGraph::Graph' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'GraphId') as graph_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NeptuneGraph::Graph' + AND region = 'us-east-1' private_graph_endpoints: name: private_graph_endpoints id: aws.neptunegraph.private_graph_endpoints @@ -891,7 +879,7 @@ components: x-cfn-type-name: AWS::NeptuneGraph::PrivateGraphEndpoint x-identifiers: - PrivateGraphEndpointIdentifier - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -908,9 +896,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -920,41 +908,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/private_graph_endpoints/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/private_graph_endpoints/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.PrivateGraphEndpointIdentifier') as private_graph_endpoint_identifier - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NeptuneGraph::PrivateGraphEndpoint' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'PrivateGraphEndpointIdentifier') as private_graph_endpoint_identifier - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NeptuneGraph::PrivateGraphEndpoint' - AND region = 'us-east-1' - private_graph_endpoint: - name: private_graph_endpoint - id: aws.neptunegraph.private_graph_endpoint - x-cfn-schema-name: PrivateGraphEndpoint - x-cfn-type-name: AWS::NeptuneGraph::PrivateGraphEndpoint - x-identifiers: - - PrivateGraphEndpointIdentifier - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -965,12 +921,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/private_graph_endpoints/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/private_graph_endpoints/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/private_graph_endpoint/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/private_graph_endpoints/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -985,20 +945,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'GraphIdentifier') as graph_identifier, - json_extract_path_text(Properties, 'SecurityGroupIds') as security_group_ids, - json_extract_path_text(Properties, 'SubnetIds') as subnet_ids, - json_extract_path_text(Properties, 'VpcId') as vpc_id, - json_extract_path_text(Properties, 'PrivateGraphEndpointIdentifier') as private_graph_endpoint_identifier, - json_extract_path_text(Properties, 'VpcEndpointId') as vpc_endpoint_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::NeptuneGraph::PrivateGraphEndpoint' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.PrivateGraphEndpointIdentifier') as private_graph_endpoint_identifier + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NeptuneGraph::PrivateGraphEndpoint' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'GraphIdentifier') as graph_identifier, + json_extract_path_text(Properties, 'SecurityGroupIds') as security_group_ids, + json_extract_path_text(Properties, 'SubnetIds') as subnet_ids, + json_extract_path_text(Properties, 'VpcId') as vpc_id, + json_extract_path_text(Properties, 'PrivateGraphEndpointIdentifier') as private_graph_endpoint_identifier, + json_extract_path_text(Properties, 'VpcEndpointId') as vpc_endpoint_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::NeptuneGraph::PrivateGraphEndpoint' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'PrivateGraphEndpointIdentifier') as private_graph_endpoint_identifier + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NeptuneGraph::PrivateGraphEndpoint' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/networkfirewall.yaml b/providers/src/aws/v00.00.00000/services/networkfirewall.yaml index f0c7bc20..49e44f22 100644 --- a/providers/src/aws/v00.00.00000/services/networkfirewall.yaml +++ b/providers/src/aws/v00.00.00000/services/networkfirewall.yaml @@ -1629,7 +1629,7 @@ components: x-cfn-type-name: AWS::NetworkFirewall::Firewall x-identifiers: - FirewallArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1646,9 +1646,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1658,41 +1658,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/firewalls/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/firewalls/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.FirewallArn') as firewall_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkFirewall::Firewall' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'FirewallArn') as firewall_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkFirewall::Firewall' - AND region = 'us-east-1' - firewall: - name: firewall - id: aws.networkfirewall.firewall - x-cfn-schema-name: Firewall - x-cfn-type-name: AWS::NetworkFirewall::Firewall - x-identifiers: - - FirewallArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1703,12 +1671,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/firewalls/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/firewalls/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/firewall/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/firewalls/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1729,26 +1701,42 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'FirewallName') as firewall_name, - json_extract_path_text(Properties, 'FirewallArn') as firewall_arn, - json_extract_path_text(Properties, 'FirewallId') as firewall_id, - json_extract_path_text(Properties, 'FirewallPolicyArn') as firewall_policy_arn, - json_extract_path_text(Properties, 'VpcId') as vpc_id, - json_extract_path_text(Properties, 'SubnetMappings') as subnet_mappings, - json_extract_path_text(Properties, 'DeleteProtection') as delete_protection, - json_extract_path_text(Properties, 'SubnetChangeProtection') as subnet_change_protection, - json_extract_path_text(Properties, 'FirewallPolicyChangeProtection') as firewall_policy_change_protection, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'EndpointIds') as endpoint_ids, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkFirewall::Firewall' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.FirewallArn') as firewall_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkFirewall::Firewall' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'FirewallName') as firewall_name, + json_extract_path_text(Properties, 'FirewallArn') as firewall_arn, + json_extract_path_text(Properties, 'FirewallId') as firewall_id, + json_extract_path_text(Properties, 'FirewallPolicyArn') as firewall_policy_arn, + json_extract_path_text(Properties, 'VpcId') as vpc_id, + json_extract_path_text(Properties, 'SubnetMappings') as subnet_mappings, + json_extract_path_text(Properties, 'DeleteProtection') as delete_protection, + json_extract_path_text(Properties, 'SubnetChangeProtection') as subnet_change_protection, + json_extract_path_text(Properties, 'FirewallPolicyChangeProtection') as firewall_policy_change_protection, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'EndpointIds') as endpoint_ids, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkFirewall::Firewall' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'FirewallArn') as firewall_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkFirewall::Firewall' + AND region = 'us-east-1' firewall_policies: name: firewall_policies id: aws.networkfirewall.firewall_policies @@ -1756,7 +1744,7 @@ components: x-cfn-type-name: AWS::NetworkFirewall::FirewallPolicy x-identifiers: - FirewallPolicyArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1773,9 +1761,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1785,41 +1773,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/firewall_policies/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/firewall_policies/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.FirewallPolicyArn') as firewall_policy_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkFirewall::FirewallPolicy' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'FirewallPolicyArn') as firewall_policy_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkFirewall::FirewallPolicy' - AND region = 'us-east-1' - firewall_policy: - name: firewall_policy - id: aws.networkfirewall.firewall_policy - x-cfn-schema-name: FirewallPolicy - x-cfn-type-name: AWS::NetworkFirewall::FirewallPolicy - x-identifiers: - - FirewallPolicyArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1830,12 +1786,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/firewall_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/firewall_policies/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/firewall_policy/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/firewall_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1850,20 +1810,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'FirewallPolicyName') as firewall_policy_name, - json_extract_path_text(Properties, 'FirewallPolicyArn') as firewall_policy_arn, - json_extract_path_text(Properties, 'FirewallPolicy') as firewall_policy, - json_extract_path_text(Properties, 'FirewallPolicyId') as firewall_policy_id, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkFirewall::FirewallPolicy' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.FirewallPolicyArn') as firewall_policy_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkFirewall::FirewallPolicy' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'FirewallPolicyName') as firewall_policy_name, + json_extract_path_text(Properties, 'FirewallPolicyArn') as firewall_policy_arn, + json_extract_path_text(Properties, 'FirewallPolicy') as firewall_policy, + json_extract_path_text(Properties, 'FirewallPolicyId') as firewall_policy_id, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkFirewall::FirewallPolicy' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'FirewallPolicyArn') as firewall_policy_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkFirewall::FirewallPolicy' + AND region = 'us-east-1' logging_configurations: name: logging_configurations id: aws.networkfirewall.logging_configurations @@ -1871,7 +1847,7 @@ components: x-cfn-type-name: AWS::NetworkFirewall::LoggingConfiguration x-identifiers: - FirewallArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1888,9 +1864,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1900,41 +1876,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/logging_configurations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/logging_configurations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.FirewallArn') as firewall_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkFirewall::LoggingConfiguration' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'FirewallArn') as firewall_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkFirewall::LoggingConfiguration' - AND region = 'us-east-1' - logging_configuration: - name: logging_configuration - id: aws.networkfirewall.logging_configuration - x-cfn-schema-name: LoggingConfiguration - x-cfn-type-name: AWS::NetworkFirewall::LoggingConfiguration - x-identifiers: - - FirewallArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1945,12 +1889,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/logging_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/logging_configurations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/logging_configuration/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/logging_configurations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1962,17 +1910,33 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'FirewallName') as firewall_name, - json_extract_path_text(Properties, 'FirewallArn') as firewall_arn, - json_extract_path_text(Properties, 'LoggingConfiguration') as logging_configuration - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkFirewall::LoggingConfiguration' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.FirewallArn') as firewall_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkFirewall::LoggingConfiguration' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'FirewallName') as firewall_name, + json_extract_path_text(Properties, 'FirewallArn') as firewall_arn, + json_extract_path_text(Properties, 'LoggingConfiguration') as logging_configuration + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkFirewall::LoggingConfiguration' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'FirewallArn') as firewall_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkFirewall::LoggingConfiguration' + AND region = 'us-east-1' rule_groups: name: rule_groups id: aws.networkfirewall.rule_groups @@ -1980,7 +1944,7 @@ components: x-cfn-type-name: AWS::NetworkFirewall::RuleGroup x-identifiers: - RuleGroupArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1997,9 +1961,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2009,41 +1973,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/rule_groups/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/rule_groups/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.RuleGroupArn') as rule_group_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkFirewall::RuleGroup' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'RuleGroupArn') as rule_group_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkFirewall::RuleGroup' - AND region = 'us-east-1' - rule_group: - name: rule_group - id: aws.networkfirewall.rule_group - x-cfn-schema-name: RuleGroup - x-cfn-type-name: AWS::NetworkFirewall::RuleGroup - x-identifiers: - - RuleGroupArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2054,12 +1986,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/rule_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/rule_groups/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/rule_group/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/rule_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2076,22 +2012,38 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'RuleGroupName') as rule_group_name, - json_extract_path_text(Properties, 'RuleGroupArn') as rule_group_arn, - json_extract_path_text(Properties, 'RuleGroupId') as rule_group_id, - json_extract_path_text(Properties, 'RuleGroup') as rule_group, - json_extract_path_text(Properties, 'Type') as type, - json_extract_path_text(Properties, 'Capacity') as capacity, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkFirewall::RuleGroup' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.RuleGroupArn') as rule_group_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkFirewall::RuleGroup' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'RuleGroupName') as rule_group_name, + json_extract_path_text(Properties, 'RuleGroupArn') as rule_group_arn, + json_extract_path_text(Properties, 'RuleGroupId') as rule_group_id, + json_extract_path_text(Properties, 'RuleGroup') as rule_group, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'Capacity') as capacity, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkFirewall::RuleGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'RuleGroupArn') as rule_group_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkFirewall::RuleGroup' + AND region = 'us-east-1' tls_inspection_configurations: name: tls_inspection_configurations id: aws.networkfirewall.tls_inspection_configurations @@ -2099,7 +2051,7 @@ components: x-cfn-type-name: AWS::NetworkFirewall::TLSInspectionConfiguration x-identifiers: - TLSInspectionConfigurationArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2116,9 +2068,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2128,41 +2080,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/tls_inspection_configurations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/tls_inspection_configurations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.TLSInspectionConfigurationArn') as tls_inspection_configuration_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkFirewall::TLSInspectionConfiguration' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'TLSInspectionConfigurationArn') as tls_inspection_configuration_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkFirewall::TLSInspectionConfiguration' - AND region = 'us-east-1' - tls_inspection_configuration: - name: tls_inspection_configuration - id: aws.networkfirewall.tls_inspection_configuration - x-cfn-schema-name: TLSInspectionConfiguration - x-cfn-type-name: AWS::NetworkFirewall::TLSInspectionConfiguration - x-identifiers: - - TLSInspectionConfigurationArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2173,12 +2093,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/tls_inspection_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/tls_inspection_configurations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/tls_inspection_configuration/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/tls_inspection_configurations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2193,20 +2117,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'TLSInspectionConfigurationName') as tls_inspection_configuration_name, - json_extract_path_text(Properties, 'TLSInspectionConfigurationArn') as tls_inspection_configuration_arn, - json_extract_path_text(Properties, 'TLSInspectionConfiguration') as tls_inspection_configuration, - json_extract_path_text(Properties, 'TLSInspectionConfigurationId') as tls_inspection_configuration_id, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkFirewall::TLSInspectionConfiguration' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.TLSInspectionConfigurationArn') as tls_inspection_configuration_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkFirewall::TLSInspectionConfiguration' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'TLSInspectionConfigurationName') as tls_inspection_configuration_name, + json_extract_path_text(Properties, 'TLSInspectionConfigurationArn') as tls_inspection_configuration_arn, + json_extract_path_text(Properties, 'TLSInspectionConfiguration') as tls_inspection_configuration, + json_extract_path_text(Properties, 'TLSInspectionConfigurationId') as tls_inspection_configuration_id, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkFirewall::TLSInspectionConfiguration' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'TLSInspectionConfigurationArn') as tls_inspection_configuration_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkFirewall::TLSInspectionConfiguration' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/networkmanager.yaml b/providers/src/aws/v00.00.00000/services/networkmanager.yaml index c1637332..773716d4 100644 --- a/providers/src/aws/v00.00.00000/services/networkmanager.yaml +++ b/providers/src/aws/v00.00.00000/services/networkmanager.yaml @@ -2517,7 +2517,7 @@ components: x-cfn-type-name: AWS::NetworkManager::ConnectAttachment x-identifiers: - AttachmentId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2534,9 +2534,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2546,41 +2546,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/connect_attachments/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/connect_attachments/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AttachmentId') as attachment_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::ConnectAttachment' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AttachmentId') as attachment_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::ConnectAttachment' - AND region = 'us-east-1' - connect_attachment: - name: connect_attachment - id: aws.networkmanager.connect_attachment - x-cfn-schema-name: ConnectAttachment - x-cfn-type-name: AWS::NetworkManager::ConnectAttachment - x-identifiers: - - AttachmentId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2591,12 +2559,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/connect_attachments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/connect_attachments/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/connect_attachment/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/connect_attachments/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2621,30 +2593,46 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'CoreNetworkId') as core_network_id, - json_extract_path_text(Properties, 'CoreNetworkArn') as core_network_arn, - json_extract_path_text(Properties, 'AttachmentId') as attachment_id, - json_extract_path_text(Properties, 'OwnerAccountId') as owner_account_id, - json_extract_path_text(Properties, 'AttachmentType') as attachment_type, - json_extract_path_text(Properties, 'State') as state, - json_extract_path_text(Properties, 'EdgeLocation') as edge_location, - json_extract_path_text(Properties, 'ResourceArn') as resource_arn, - json_extract_path_text(Properties, 'AttachmentPolicyRuleNumber') as attachment_policy_rule_number, - json_extract_path_text(Properties, 'SegmentName') as segment_name, - json_extract_path_text(Properties, 'ProposedSegmentChange') as proposed_segment_change, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'CreatedAt') as created_at, - json_extract_path_text(Properties, 'UpdatedAt') as updated_at, - json_extract_path_text(Properties, 'TransportAttachmentId') as transport_attachment_id, - json_extract_path_text(Properties, 'Options') as options - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkManager::ConnectAttachment' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.AttachmentId') as attachment_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::ConnectAttachment' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'CoreNetworkId') as core_network_id, + json_extract_path_text(Properties, 'CoreNetworkArn') as core_network_arn, + json_extract_path_text(Properties, 'AttachmentId') as attachment_id, + json_extract_path_text(Properties, 'OwnerAccountId') as owner_account_id, + json_extract_path_text(Properties, 'AttachmentType') as attachment_type, + json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'EdgeLocation') as edge_location, + json_extract_path_text(Properties, 'ResourceArn') as resource_arn, + json_extract_path_text(Properties, 'AttachmentPolicyRuleNumber') as attachment_policy_rule_number, + json_extract_path_text(Properties, 'SegmentName') as segment_name, + json_extract_path_text(Properties, 'ProposedSegmentChange') as proposed_segment_change, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'UpdatedAt') as updated_at, + json_extract_path_text(Properties, 'TransportAttachmentId') as transport_attachment_id, + json_extract_path_text(Properties, 'Options') as options + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkManager::ConnectAttachment' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AttachmentId') as attachment_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::ConnectAttachment' + AND region = 'us-east-1' connect_peers: name: connect_peers id: aws.networkmanager.connect_peers @@ -2652,7 +2640,7 @@ components: x-cfn-type-name: AWS::NetworkManager::ConnectPeer x-identifiers: - ConnectPeerId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2669,9 +2657,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2681,41 +2669,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/connect_peers/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/connect_peers/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ConnectPeerId') as connect_peer_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::ConnectPeer' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ConnectPeerId') as connect_peer_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::ConnectPeer' - AND region = 'us-east-1' - connect_peer: - name: connect_peer - id: aws.networkmanager.connect_peer - x-cfn-schema-name: ConnectPeer - x-cfn-type-name: AWS::NetworkManager::ConnectPeer - x-identifiers: - - ConnectPeerId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2726,12 +2682,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/connect_peers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/connect_peers/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/connect_peer/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/connect_peers/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2753,27 +2713,43 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'PeerAddress') as peer_address, - json_extract_path_text(Properties, 'CoreNetworkAddress') as core_network_address, - json_extract_path_text(Properties, 'BgpOptions') as bgp_options, - json_extract_path_text(Properties, 'InsideCidrBlocks') as inside_cidr_blocks, - json_extract_path_text(Properties, 'CoreNetworkId') as core_network_id, - json_extract_path_text(Properties, 'ConnectAttachmentId') as connect_attachment_id, - json_extract_path_text(Properties, 'ConnectPeerId') as connect_peer_id, - json_extract_path_text(Properties, 'EdgeLocation') as edge_location, - json_extract_path_text(Properties, 'State') as state, - json_extract_path_text(Properties, 'CreatedAt') as created_at, - json_extract_path_text(Properties, 'Configuration') as configuration, - json_extract_path_text(Properties, 'SubnetArn') as subnet_arn, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkManager::ConnectPeer' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ConnectPeerId') as connect_peer_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::ConnectPeer' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'PeerAddress') as peer_address, + json_extract_path_text(Properties, 'CoreNetworkAddress') as core_network_address, + json_extract_path_text(Properties, 'BgpOptions') as bgp_options, + json_extract_path_text(Properties, 'InsideCidrBlocks') as inside_cidr_blocks, + json_extract_path_text(Properties, 'CoreNetworkId') as core_network_id, + json_extract_path_text(Properties, 'ConnectAttachmentId') as connect_attachment_id, + json_extract_path_text(Properties, 'ConnectPeerId') as connect_peer_id, + json_extract_path_text(Properties, 'EdgeLocation') as edge_location, + json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'Configuration') as configuration, + json_extract_path_text(Properties, 'SubnetArn') as subnet_arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkManager::ConnectPeer' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ConnectPeerId') as connect_peer_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::ConnectPeer' + AND region = 'us-east-1' core_networks: name: core_networks id: aws.networkmanager.core_networks @@ -2781,7 +2757,7 @@ components: x-cfn-type-name: AWS::NetworkManager::CoreNetwork x-identifiers: - CoreNetworkId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2798,9 +2774,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2810,41 +2786,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/core_networks/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/core_networks/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.CoreNetworkId') as core_network_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::CoreNetwork' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'CoreNetworkId') as core_network_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::CoreNetwork' - AND region = 'us-east-1' - core_network: - name: core_network - id: aws.networkmanager.core_network - x-cfn-schema-name: CoreNetwork - x-cfn-type-name: AWS::NetworkManager::CoreNetwork - x-identifiers: - - CoreNetworkId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2855,12 +2799,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/core_networks/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/core_networks/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/core_network/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/core_networks/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2880,25 +2828,41 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'GlobalNetworkId') as global_network_id, - json_extract_path_text(Properties, 'CoreNetworkId') as core_network_id, - json_extract_path_text(Properties, 'CoreNetworkArn') as core_network_arn, - json_extract_path_text(Properties, 'PolicyDocument') as policy_document, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'CreatedAt') as created_at, - json_extract_path_text(Properties, 'State') as state, - json_extract_path_text(Properties, 'Segments') as segments, - json_extract_path_text(Properties, 'Edges') as edges, - json_extract_path_text(Properties, 'OwnerAccount') as owner_account, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkManager::CoreNetwork' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.CoreNetworkId') as core_network_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::CoreNetwork' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'GlobalNetworkId') as global_network_id, + json_extract_path_text(Properties, 'CoreNetworkId') as core_network_id, + json_extract_path_text(Properties, 'CoreNetworkArn') as core_network_arn, + json_extract_path_text(Properties, 'PolicyDocument') as policy_document, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'Segments') as segments, + json_extract_path_text(Properties, 'Edges') as edges, + json_extract_path_text(Properties, 'OwnerAccount') as owner_account, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkManager::CoreNetwork' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'CoreNetworkId') as core_network_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::CoreNetwork' + AND region = 'us-east-1' customer_gateway_associations: name: customer_gateway_associations id: aws.networkmanager.customer_gateway_associations @@ -2907,7 +2871,7 @@ components: x-identifiers: - GlobalNetworkId - CustomerGatewayArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2941,42 +2905,11 @@ components: - $ref: '#/components/x-stackQL-resources/customer_gateway_associations/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/customer_gateway_associations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.GlobalNetworkId') as global_network_id, - JSON_EXTRACT(Properties, '$.CustomerGatewayArn') as customer_gateway_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::CustomerGatewayAssociation' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'GlobalNetworkId') as global_network_id, - json_extract_path_text(Properties, 'CustomerGatewayArn') as customer_gateway_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::CustomerGatewayAssociation' - AND region = 'us-east-1' - customer_gateway_association: - name: customer_gateway_association - id: aws.networkmanager.customer_gateway_association - x-cfn-schema-name: CustomerGatewayAssociation - x-cfn-type-name: AWS::NetworkManager::CustomerGatewayAssociation - x-identifiers: - - GlobalNetworkId - - CustomerGatewayArn - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2989,18 +2922,36 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'GlobalNetworkId') as global_network_id, - json_extract_path_text(Properties, 'CustomerGatewayArn') as customer_gateway_arn, - json_extract_path_text(Properties, 'DeviceId') as device_id, - json_extract_path_text(Properties, 'LinkId') as link_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkManager::CustomerGatewayAssociation' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.GlobalNetworkId') as global_network_id, + JSON_EXTRACT(Properties, '$.CustomerGatewayArn') as customer_gateway_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::CustomerGatewayAssociation' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'GlobalNetworkId') as global_network_id, + json_extract_path_text(Properties, 'CustomerGatewayArn') as customer_gateway_arn, + json_extract_path_text(Properties, 'DeviceId') as device_id, + json_extract_path_text(Properties, 'LinkId') as link_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkManager::CustomerGatewayAssociation' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'GlobalNetworkId') as global_network_id, + json_extract_path_text(Properties, 'CustomerGatewayArn') as customer_gateway_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::CustomerGatewayAssociation' + AND region = 'us-east-1' devices: name: devices id: aws.networkmanager.devices @@ -3009,7 +2960,7 @@ components: x-identifiers: - GlobalNetworkId - DeviceId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3026,9 +2977,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3038,44 +2989,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/devices/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/devices/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.GlobalNetworkId') as global_network_id, - JSON_EXTRACT(Properties, '$.DeviceId') as device_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::Device' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'GlobalNetworkId') as global_network_id, - json_extract_path_text(Properties, 'DeviceId') as device_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::Device' - AND region = 'us-east-1' - device: - name: device - id: aws.networkmanager.device - x-cfn-schema-name: Device - x-cfn-type-name: AWS::NetworkManager::Device - x-identifiers: - - GlobalNetworkId - - DeviceId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3086,12 +3002,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/devices/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/devices/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/device/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/devices/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3114,28 +3034,46 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'DeviceArn') as device_arn, - json_extract_path_text(Properties, 'DeviceId') as device_id, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'GlobalNetworkId') as global_network_id, - json_extract_path_text(Properties, 'AWSLocation') as aws_location, - json_extract_path_text(Properties, 'Location') as location, - json_extract_path_text(Properties, 'Model') as model, - json_extract_path_text(Properties, 'SerialNumber') as serial_number, - json_extract_path_text(Properties, 'SiteId') as site_id, - json_extract_path_text(Properties, 'Type') as type, - json_extract_path_text(Properties, 'Vendor') as vendor, - json_extract_path_text(Properties, 'CreatedAt') as created_at, - json_extract_path_text(Properties, 'State') as state - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkManager::Device' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.GlobalNetworkId') as global_network_id, + JSON_EXTRACT(Properties, '$.DeviceId') as device_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::Device' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DeviceArn') as device_arn, + json_extract_path_text(Properties, 'DeviceId') as device_id, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'GlobalNetworkId') as global_network_id, + json_extract_path_text(Properties, 'AWSLocation') as aws_location, + json_extract_path_text(Properties, 'Location') as location, + json_extract_path_text(Properties, 'Model') as model, + json_extract_path_text(Properties, 'SerialNumber') as serial_number, + json_extract_path_text(Properties, 'SiteId') as site_id, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'Vendor') as vendor, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'State') as state + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkManager::Device' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'GlobalNetworkId') as global_network_id, + json_extract_path_text(Properties, 'DeviceId') as device_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::Device' + AND region = 'us-east-1' global_networks: name: global_networks id: aws.networkmanager.global_networks @@ -3143,7 +3081,7 @@ components: x-cfn-type-name: AWS::NetworkManager::GlobalNetwork x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3160,9 +3098,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3172,41 +3110,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/global_networks/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/global_networks/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::GlobalNetwork' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::GlobalNetwork' - AND region = 'us-east-1' - global_network: - name: global_network - id: aws.networkmanager.global_network - x-cfn-schema-name: GlobalNetwork - x-cfn-type-name: AWS::NetworkManager::GlobalNetwork - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3217,12 +3123,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/global_networks/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/global_networks/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/global_network/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/global_networks/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3237,20 +3147,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'CreatedAt') as created_at, - json_extract_path_text(Properties, 'State') as state - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkManager::GlobalNetwork' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::GlobalNetwork' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'State') as state + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkManager::GlobalNetwork' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::GlobalNetwork' + AND region = 'us-east-1' links: name: links id: aws.networkmanager.links @@ -3259,7 +3185,7 @@ components: x-identifiers: - GlobalNetworkId - LinkId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3276,9 +3202,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3288,44 +3214,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/links/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/links/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.GlobalNetworkId') as global_network_id, - JSON_EXTRACT(Properties, '$.LinkId') as link_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::Link' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'GlobalNetworkId') as global_network_id, - json_extract_path_text(Properties, 'LinkId') as link_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::Link' - AND region = 'us-east-1' - link: - name: link - id: aws.networkmanager.link - x-cfn-schema-name: Link - x-cfn-type-name: AWS::NetworkManager::Link - x-identifiers: - - GlobalNetworkId - - LinkId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3336,12 +3227,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/links/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/links/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/link/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/links/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3361,25 +3256,43 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'LinkArn') as link_arn, - json_extract_path_text(Properties, 'LinkId') as link_id, - json_extract_path_text(Properties, 'GlobalNetworkId') as global_network_id, - json_extract_path_text(Properties, 'SiteId') as site_id, - json_extract_path_text(Properties, 'Bandwidth') as bandwidth, - json_extract_path_text(Properties, 'Provider') as provider, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Type') as type, - json_extract_path_text(Properties, 'CreatedAt') as created_at, - json_extract_path_text(Properties, 'State') as state - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkManager::Link' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.GlobalNetworkId') as global_network_id, + JSON_EXTRACT(Properties, '$.LinkId') as link_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::Link' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'LinkArn') as link_arn, + json_extract_path_text(Properties, 'LinkId') as link_id, + json_extract_path_text(Properties, 'GlobalNetworkId') as global_network_id, + json_extract_path_text(Properties, 'SiteId') as site_id, + json_extract_path_text(Properties, 'Bandwidth') as bandwidth, + json_extract_path_text(Properties, 'Provider') as provider, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'State') as state + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkManager::Link' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'GlobalNetworkId') as global_network_id, + json_extract_path_text(Properties, 'LinkId') as link_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::Link' + AND region = 'us-east-1' link_associations: name: link_associations id: aws.networkmanager.link_associations @@ -3389,7 +3302,7 @@ components: - GlobalNetworkId - DeviceId - LinkId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3423,45 +3336,11 @@ components: - $ref: '#/components/x-stackQL-resources/link_associations/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/link_associations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.GlobalNetworkId') as global_network_id, - JSON_EXTRACT(Properties, '$.DeviceId') as device_id, - JSON_EXTRACT(Properties, '$.LinkId') as link_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::LinkAssociation' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'GlobalNetworkId') as global_network_id, - json_extract_path_text(Properties, 'DeviceId') as device_id, - json_extract_path_text(Properties, 'LinkId') as link_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::LinkAssociation' - AND region = 'us-east-1' - link_association: - name: link_association - id: aws.networkmanager.link_association - x-cfn-schema-name: LinkAssociation - x-cfn-type-name: AWS::NetworkManager::LinkAssociation - x-identifiers: - - GlobalNetworkId - - DeviceId - - LinkId - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3473,17 +3352,37 @@ components: AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'GlobalNetworkId') as global_network_id, - json_extract_path_text(Properties, 'DeviceId') as device_id, - json_extract_path_text(Properties, 'LinkId') as link_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkManager::LinkAssociation' - AND data__Identifier = '||' + JSON_EXTRACT(Properties, '$.GlobalNetworkId') as global_network_id, + JSON_EXTRACT(Properties, '$.DeviceId') as device_id, + JSON_EXTRACT(Properties, '$.LinkId') as link_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::LinkAssociation' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'GlobalNetworkId') as global_network_id, + json_extract_path_text(Properties, 'DeviceId') as device_id, + json_extract_path_text(Properties, 'LinkId') as link_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkManager::LinkAssociation' + AND data__Identifier = '||' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'GlobalNetworkId') as global_network_id, + json_extract_path_text(Properties, 'DeviceId') as device_id, + json_extract_path_text(Properties, 'LinkId') as link_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::LinkAssociation' + AND region = 'us-east-1' sites: name: sites id: aws.networkmanager.sites @@ -3492,7 +3391,7 @@ components: x-identifiers: - GlobalNetworkId - SiteId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3509,9 +3408,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3521,44 +3420,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/sites/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/sites/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.GlobalNetworkId') as global_network_id, - JSON_EXTRACT(Properties, '$.SiteId') as site_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::Site' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'GlobalNetworkId') as global_network_id, - json_extract_path_text(Properties, 'SiteId') as site_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::Site' - AND region = 'us-east-1' - site: - name: site - id: aws.networkmanager.site - x-cfn-schema-name: Site - x-cfn-type-name: AWS::NetworkManager::Site - x-identifiers: - - GlobalNetworkId - - SiteId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3569,12 +3433,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/sites/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/sites/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/site/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/sites/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3591,22 +3459,40 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'SiteArn') as site_arn, - json_extract_path_text(Properties, 'SiteId') as site_id, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'GlobalNetworkId') as global_network_id, - json_extract_path_text(Properties, 'Location') as location, - json_extract_path_text(Properties, 'CreatedAt') as created_at, - json_extract_path_text(Properties, 'State') as state - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkManager::Site' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.GlobalNetworkId') as global_network_id, + JSON_EXTRACT(Properties, '$.SiteId') as site_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::Site' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'SiteArn') as site_arn, + json_extract_path_text(Properties, 'SiteId') as site_id, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'GlobalNetworkId') as global_network_id, + json_extract_path_text(Properties, 'Location') as location, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'State') as state + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkManager::Site' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'GlobalNetworkId') as global_network_id, + json_extract_path_text(Properties, 'SiteId') as site_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::Site' + AND region = 'us-east-1' site_to_site_vpn_attachments: name: site_to_site_vpn_attachments id: aws.networkmanager.site_to_site_vpn_attachments @@ -3614,7 +3500,7 @@ components: x-cfn-type-name: AWS::NetworkManager::SiteToSiteVpnAttachment x-identifiers: - AttachmentId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3631,9 +3517,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3643,41 +3529,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/site_to_site_vpn_attachments/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/site_to_site_vpn_attachments/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AttachmentId') as attachment_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::SiteToSiteVpnAttachment' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AttachmentId') as attachment_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::SiteToSiteVpnAttachment' - AND region = 'us-east-1' - site_to_site_vpn_attachment: - name: site_to_site_vpn_attachment - id: aws.networkmanager.site_to_site_vpn_attachment - x-cfn-schema-name: SiteToSiteVpnAttachment - x-cfn-type-name: AWS::NetworkManager::SiteToSiteVpnAttachment - x-identifiers: - - AttachmentId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3688,12 +3542,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/site_to_site_vpn_attachments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/site_to_site_vpn_attachments/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/site_to_site_vpn_attachment/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/site_to_site_vpn_attachments/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3717,29 +3575,45 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'CoreNetworkId') as core_network_id, - json_extract_path_text(Properties, 'CoreNetworkArn') as core_network_arn, - json_extract_path_text(Properties, 'AttachmentId') as attachment_id, - json_extract_path_text(Properties, 'OwnerAccountId') as owner_account_id, - json_extract_path_text(Properties, 'AttachmentType') as attachment_type, - json_extract_path_text(Properties, 'State') as state, - json_extract_path_text(Properties, 'EdgeLocation') as edge_location, - json_extract_path_text(Properties, 'ResourceArn') as resource_arn, - json_extract_path_text(Properties, 'AttachmentPolicyRuleNumber') as attachment_policy_rule_number, - json_extract_path_text(Properties, 'SegmentName') as segment_name, - json_extract_path_text(Properties, 'ProposedSegmentChange') as proposed_segment_change, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'CreatedAt') as created_at, - json_extract_path_text(Properties, 'UpdatedAt') as updated_at, - json_extract_path_text(Properties, 'VpnConnectionArn') as vpn_connection_arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkManager::SiteToSiteVpnAttachment' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.AttachmentId') as attachment_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::SiteToSiteVpnAttachment' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'CoreNetworkId') as core_network_id, + json_extract_path_text(Properties, 'CoreNetworkArn') as core_network_arn, + json_extract_path_text(Properties, 'AttachmentId') as attachment_id, + json_extract_path_text(Properties, 'OwnerAccountId') as owner_account_id, + json_extract_path_text(Properties, 'AttachmentType') as attachment_type, + json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'EdgeLocation') as edge_location, + json_extract_path_text(Properties, 'ResourceArn') as resource_arn, + json_extract_path_text(Properties, 'AttachmentPolicyRuleNumber') as attachment_policy_rule_number, + json_extract_path_text(Properties, 'SegmentName') as segment_name, + json_extract_path_text(Properties, 'ProposedSegmentChange') as proposed_segment_change, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'UpdatedAt') as updated_at, + json_extract_path_text(Properties, 'VpnConnectionArn') as vpn_connection_arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkManager::SiteToSiteVpnAttachment' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AttachmentId') as attachment_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::SiteToSiteVpnAttachment' + AND region = 'us-east-1' transit_gateway_peerings: name: transit_gateway_peerings id: aws.networkmanager.transit_gateway_peerings @@ -3747,7 +3621,7 @@ components: x-cfn-type-name: AWS::NetworkManager::TransitGatewayPeering x-identifiers: - PeeringId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3764,9 +3638,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3776,41 +3650,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/transit_gateway_peerings/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/transit_gateway_peerings/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.PeeringId') as peering_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::TransitGatewayPeering' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'PeeringId') as peering_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::TransitGatewayPeering' - AND region = 'us-east-1' - transit_gateway_peering: - name: transit_gateway_peering - id: aws.networkmanager.transit_gateway_peering - x-cfn-schema-name: TransitGatewayPeering - x-cfn-type-name: AWS::NetworkManager::TransitGatewayPeering - x-identifiers: - - PeeringId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3821,12 +3663,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/transit_gateway_peerings/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/transit_gateway_peerings/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/transit_gateway_peering/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/transit_gateway_peerings/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3847,26 +3693,42 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'CoreNetworkId') as core_network_id, - json_extract_path_text(Properties, 'CoreNetworkArn') as core_network_arn, - json_extract_path_text(Properties, 'TransitGatewayArn') as transit_gateway_arn, - json_extract_path_text(Properties, 'TransitGatewayPeeringAttachmentId') as transit_gateway_peering_attachment_id, - json_extract_path_text(Properties, 'PeeringId') as peering_id, - json_extract_path_text(Properties, 'State') as state, - json_extract_path_text(Properties, 'EdgeLocation') as edge_location, - json_extract_path_text(Properties, 'ResourceArn') as resource_arn, - json_extract_path_text(Properties, 'OwnerAccountId') as owner_account_id, - json_extract_path_text(Properties, 'PeeringType') as peering_type, - json_extract_path_text(Properties, 'CreatedAt') as created_at, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkManager::TransitGatewayPeering' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.PeeringId') as peering_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::TransitGatewayPeering' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'CoreNetworkId') as core_network_id, + json_extract_path_text(Properties, 'CoreNetworkArn') as core_network_arn, + json_extract_path_text(Properties, 'TransitGatewayArn') as transit_gateway_arn, + json_extract_path_text(Properties, 'TransitGatewayPeeringAttachmentId') as transit_gateway_peering_attachment_id, + json_extract_path_text(Properties, 'PeeringId') as peering_id, + json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'EdgeLocation') as edge_location, + json_extract_path_text(Properties, 'ResourceArn') as resource_arn, + json_extract_path_text(Properties, 'OwnerAccountId') as owner_account_id, + json_extract_path_text(Properties, 'PeeringType') as peering_type, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkManager::TransitGatewayPeering' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'PeeringId') as peering_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::TransitGatewayPeering' + AND region = 'us-east-1' transit_gateway_registrations: name: transit_gateway_registrations id: aws.networkmanager.transit_gateway_registrations @@ -3875,7 +3737,7 @@ components: x-identifiers: - GlobalNetworkId - TransitGatewayArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3909,42 +3771,11 @@ components: - $ref: '#/components/x-stackQL-resources/transit_gateway_registrations/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/transit_gateway_registrations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.GlobalNetworkId') as global_network_id, - JSON_EXTRACT(Properties, '$.TransitGatewayArn') as transit_gateway_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::TransitGatewayRegistration' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'GlobalNetworkId') as global_network_id, - json_extract_path_text(Properties, 'TransitGatewayArn') as transit_gateway_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::TransitGatewayRegistration' - AND region = 'us-east-1' - transit_gateway_registration: - name: transit_gateway_registration - id: aws.networkmanager.transit_gateway_registration - x-cfn-schema-name: TransitGatewayRegistration - x-cfn-type-name: AWS::NetworkManager::TransitGatewayRegistration - x-identifiers: - - GlobalNetworkId - - TransitGatewayArn - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3955,16 +3786,34 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'GlobalNetworkId') as global_network_id, - json_extract_path_text(Properties, 'TransitGatewayArn') as transit_gateway_arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkManager::TransitGatewayRegistration' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.GlobalNetworkId') as global_network_id, + JSON_EXTRACT(Properties, '$.TransitGatewayArn') as transit_gateway_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::TransitGatewayRegistration' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'GlobalNetworkId') as global_network_id, + json_extract_path_text(Properties, 'TransitGatewayArn') as transit_gateway_arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkManager::TransitGatewayRegistration' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'GlobalNetworkId') as global_network_id, + json_extract_path_text(Properties, 'TransitGatewayArn') as transit_gateway_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::TransitGatewayRegistration' + AND region = 'us-east-1' transit_gateway_route_table_attachments: name: transit_gateway_route_table_attachments id: aws.networkmanager.transit_gateway_route_table_attachments @@ -3972,7 +3821,7 @@ components: x-cfn-type-name: AWS::NetworkManager::TransitGatewayRouteTableAttachment x-identifiers: - AttachmentId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3989,9 +3838,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -4001,41 +3850,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/transit_gateway_route_table_attachments/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/transit_gateway_route_table_attachments/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AttachmentId') as attachment_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::TransitGatewayRouteTableAttachment' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AttachmentId') as attachment_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::TransitGatewayRouteTableAttachment' - AND region = 'us-east-1' - transit_gateway_route_table_attachment: - name: transit_gateway_route_table_attachment - id: aws.networkmanager.transit_gateway_route_table_attachment - x-cfn-schema-name: TransitGatewayRouteTableAttachment - x-cfn-type-name: AWS::NetworkManager::TransitGatewayRouteTableAttachment - x-identifiers: - - AttachmentId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -4046,12 +3863,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/transit_gateway_route_table_attachments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/transit_gateway_route_table_attachments/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/transit_gateway_route_table_attachment/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/transit_gateway_route_table_attachments/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -4076,30 +3897,46 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'PeeringId') as peering_id, - json_extract_path_text(Properties, 'TransitGatewayRouteTableArn') as transit_gateway_route_table_arn, - json_extract_path_text(Properties, 'CoreNetworkId') as core_network_id, - json_extract_path_text(Properties, 'CoreNetworkArn') as core_network_arn, - json_extract_path_text(Properties, 'AttachmentId') as attachment_id, - json_extract_path_text(Properties, 'OwnerAccountId') as owner_account_id, - json_extract_path_text(Properties, 'AttachmentType') as attachment_type, - json_extract_path_text(Properties, 'State') as state, - json_extract_path_text(Properties, 'EdgeLocation') as edge_location, - json_extract_path_text(Properties, 'ResourceArn') as resource_arn, - json_extract_path_text(Properties, 'AttachmentPolicyRuleNumber') as attachment_policy_rule_number, - json_extract_path_text(Properties, 'SegmentName') as segment_name, - json_extract_path_text(Properties, 'ProposedSegmentChange') as proposed_segment_change, - json_extract_path_text(Properties, 'CreatedAt') as created_at, - json_extract_path_text(Properties, 'UpdatedAt') as updated_at, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkManager::TransitGatewayRouteTableAttachment' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.AttachmentId') as attachment_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::TransitGatewayRouteTableAttachment' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'PeeringId') as peering_id, + json_extract_path_text(Properties, 'TransitGatewayRouteTableArn') as transit_gateway_route_table_arn, + json_extract_path_text(Properties, 'CoreNetworkId') as core_network_id, + json_extract_path_text(Properties, 'CoreNetworkArn') as core_network_arn, + json_extract_path_text(Properties, 'AttachmentId') as attachment_id, + json_extract_path_text(Properties, 'OwnerAccountId') as owner_account_id, + json_extract_path_text(Properties, 'AttachmentType') as attachment_type, + json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'EdgeLocation') as edge_location, + json_extract_path_text(Properties, 'ResourceArn') as resource_arn, + json_extract_path_text(Properties, 'AttachmentPolicyRuleNumber') as attachment_policy_rule_number, + json_extract_path_text(Properties, 'SegmentName') as segment_name, + json_extract_path_text(Properties, 'ProposedSegmentChange') as proposed_segment_change, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'UpdatedAt') as updated_at, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkManager::TransitGatewayRouteTableAttachment' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AttachmentId') as attachment_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::TransitGatewayRouteTableAttachment' + AND region = 'us-east-1' vpc_attachments: name: vpc_attachments id: aws.networkmanager.vpc_attachments @@ -4107,7 +3944,7 @@ components: x-cfn-type-name: AWS::NetworkManager::VpcAttachment x-identifiers: - AttachmentId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -4124,9 +3961,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -4136,41 +3973,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/vpc_attachments/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/vpc_attachments/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AttachmentId') as attachment_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::VpcAttachment' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AttachmentId') as attachment_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::VpcAttachment' - AND region = 'us-east-1' - vpc_attachment: - name: vpc_attachment - id: aws.networkmanager.vpc_attachment - x-cfn-schema-name: VpcAttachment - x-cfn-type-name: AWS::NetworkManager::VpcAttachment - x-identifiers: - - AttachmentId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -4181,12 +3986,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/vpc_attachments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/vpc_attachments/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/vpc_attachment/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/vpc_attachments/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -4212,31 +4021,47 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'CoreNetworkId') as core_network_id, - json_extract_path_text(Properties, 'CoreNetworkArn') as core_network_arn, - json_extract_path_text(Properties, 'AttachmentId') as attachment_id, - json_extract_path_text(Properties, 'OwnerAccountId') as owner_account_id, - json_extract_path_text(Properties, 'AttachmentType') as attachment_type, - json_extract_path_text(Properties, 'State') as state, - json_extract_path_text(Properties, 'EdgeLocation') as edge_location, - json_extract_path_text(Properties, 'VpcArn') as vpc_arn, - json_extract_path_text(Properties, 'ResourceArn') as resource_arn, - json_extract_path_text(Properties, 'AttachmentPolicyRuleNumber') as attachment_policy_rule_number, - json_extract_path_text(Properties, 'SegmentName') as segment_name, - json_extract_path_text(Properties, 'ProposedSegmentChange') as proposed_segment_change, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'CreatedAt') as created_at, - json_extract_path_text(Properties, 'UpdatedAt') as updated_at, - json_extract_path_text(Properties, 'SubnetArns') as subnet_arns, - json_extract_path_text(Properties, 'Options') as options - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkManager::VpcAttachment' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.AttachmentId') as attachment_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::VpcAttachment' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'CoreNetworkId') as core_network_id, + json_extract_path_text(Properties, 'CoreNetworkArn') as core_network_arn, + json_extract_path_text(Properties, 'AttachmentId') as attachment_id, + json_extract_path_text(Properties, 'OwnerAccountId') as owner_account_id, + json_extract_path_text(Properties, 'AttachmentType') as attachment_type, + json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'EdgeLocation') as edge_location, + json_extract_path_text(Properties, 'VpcArn') as vpc_arn, + json_extract_path_text(Properties, 'ResourceArn') as resource_arn, + json_extract_path_text(Properties, 'AttachmentPolicyRuleNumber') as attachment_policy_rule_number, + json_extract_path_text(Properties, 'SegmentName') as segment_name, + json_extract_path_text(Properties, 'ProposedSegmentChange') as proposed_segment_change, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'UpdatedAt') as updated_at, + json_extract_path_text(Properties, 'SubnetArns') as subnet_arns, + json_extract_path_text(Properties, 'Options') as options + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::NetworkManager::VpcAttachment' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AttachmentId') as attachment_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NetworkManager::VpcAttachment' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/nimblestudio.yaml b/providers/src/aws/v00.00.00000/services/nimblestudio.yaml index 2dd61e51..9ef3e33d 100644 --- a/providers/src/aws/v00.00.00000/services/nimblestudio.yaml +++ b/providers/src/aws/v00.00.00000/services/nimblestudio.yaml @@ -1484,7 +1484,7 @@ components: x-identifiers: - LaunchProfileId - StudioId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1501,9 +1501,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1513,44 +1513,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/launch_profiles/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/launch_profiles/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.LaunchProfileId') as launch_profile_id, - JSON_EXTRACT(Properties, '$.StudioId') as studio_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NimbleStudio::LaunchProfile' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'LaunchProfileId') as launch_profile_id, - json_extract_path_text(Properties, 'StudioId') as studio_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NimbleStudio::LaunchProfile' - AND region = 'us-east-1' - launch_profile: - name: launch_profile - id: aws.nimblestudio.launch_profile - x-cfn-schema-name: LaunchProfile - x-cfn-type-name: AWS::NimbleStudio::LaunchProfile - x-identifiers: - - LaunchProfileId - - StudioId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1561,12 +1526,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/launch_profiles/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/launch_profiles/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/launch_profile/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/launch_profiles/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1584,23 +1553,41 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Ec2SubnetIds') as ec2_subnet_ids, - json_extract_path_text(Properties, 'LaunchProfileId') as launch_profile_id, - json_extract_path_text(Properties, 'LaunchProfileProtocolVersions') as launch_profile_protocol_versions, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'StreamConfiguration') as stream_configuration, - json_extract_path_text(Properties, 'StudioComponentIds') as studio_component_ids, - json_extract_path_text(Properties, 'StudioId') as studio_id, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::NimbleStudio::LaunchProfile' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.LaunchProfileId') as launch_profile_id, + JSON_EXTRACT(Properties, '$.StudioId') as studio_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NimbleStudio::LaunchProfile' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Ec2SubnetIds') as ec2_subnet_ids, + json_extract_path_text(Properties, 'LaunchProfileId') as launch_profile_id, + json_extract_path_text(Properties, 'LaunchProfileProtocolVersions') as launch_profile_protocol_versions, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'StreamConfiguration') as stream_configuration, + json_extract_path_text(Properties, 'StudioComponentIds') as studio_component_ids, + json_extract_path_text(Properties, 'StudioId') as studio_id, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::NimbleStudio::LaunchProfile' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'LaunchProfileId') as launch_profile_id, + json_extract_path_text(Properties, 'StudioId') as studio_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NimbleStudio::LaunchProfile' + AND region = 'us-east-1' streaming_images: name: streaming_images id: aws.nimblestudio.streaming_images @@ -1609,7 +1596,7 @@ components: x-identifiers: - StudioId - StreamingImageId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1626,9 +1613,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1638,44 +1625,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/streaming_images/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/streaming_images/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.StudioId') as studio_id, - JSON_EXTRACT(Properties, '$.StreamingImageId') as streaming_image_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NimbleStudio::StreamingImage' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'StudioId') as studio_id, - json_extract_path_text(Properties, 'StreamingImageId') as streaming_image_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NimbleStudio::StreamingImage' - AND region = 'us-east-1' - streaming_image: - name: streaming_image - id: aws.nimblestudio.streaming_image - x-cfn-schema-name: StreamingImage - x-cfn-type-name: AWS::NimbleStudio::StreamingImage - x-identifiers: - - StudioId - - StreamingImageId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1686,12 +1638,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/streaming_images/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/streaming_images/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/streaming_image/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/streaming_images/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1710,24 +1666,42 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Ec2ImageId') as ec2_image_id, - json_extract_path_text(Properties, 'EncryptionConfiguration') as encryption_configuration, - json_extract_path_text(Properties, 'EulaIds') as eula_ids, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Owner') as owner, - json_extract_path_text(Properties, 'Platform') as platform, - json_extract_path_text(Properties, 'StreamingImageId') as streaming_image_id, - json_extract_path_text(Properties, 'StudioId') as studio_id, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::NimbleStudio::StreamingImage' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.StudioId') as studio_id, + JSON_EXTRACT(Properties, '$.StreamingImageId') as streaming_image_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NimbleStudio::StreamingImage' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Ec2ImageId') as ec2_image_id, + json_extract_path_text(Properties, 'EncryptionConfiguration') as encryption_configuration, + json_extract_path_text(Properties, 'EulaIds') as eula_ids, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Owner') as owner, + json_extract_path_text(Properties, 'Platform') as platform, + json_extract_path_text(Properties, 'StreamingImageId') as streaming_image_id, + json_extract_path_text(Properties, 'StudioId') as studio_id, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::NimbleStudio::StreamingImage' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'StudioId') as studio_id, + json_extract_path_text(Properties, 'StreamingImageId') as streaming_image_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NimbleStudio::StreamingImage' + AND region = 'us-east-1' studios: name: studios id: aws.nimblestudio.studios @@ -1735,7 +1709,7 @@ components: x-cfn-type-name: AWS::NimbleStudio::Studio x-identifiers: - StudioId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1752,9 +1726,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1764,41 +1738,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/studios/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/studios/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.StudioId') as studio_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NimbleStudio::Studio' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'StudioId') as studio_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NimbleStudio::Studio' - AND region = 'us-east-1' - studio: - name: studio - id: aws.nimblestudio.studio - x-cfn-schema-name: Studio - x-cfn-type-name: AWS::NimbleStudio::Studio - x-identifiers: - - StudioId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1809,12 +1751,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/studios/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/studios/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/studio/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/studios/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1833,24 +1779,40 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AdminRoleArn') as admin_role_arn, - json_extract_path_text(Properties, 'DisplayName') as display_name, - json_extract_path_text(Properties, 'HomeRegion') as home_region, - json_extract_path_text(Properties, 'SsoClientId') as sso_client_id, - json_extract_path_text(Properties, 'StudioEncryptionConfiguration') as studio_encryption_configuration, - json_extract_path_text(Properties, 'StudioId') as studio_id, - json_extract_path_text(Properties, 'StudioName') as studio_name, - json_extract_path_text(Properties, 'StudioUrl') as studio_url, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'UserRoleArn') as user_role_arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::NimbleStudio::Studio' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.StudioId') as studio_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NimbleStudio::Studio' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AdminRoleArn') as admin_role_arn, + json_extract_path_text(Properties, 'DisplayName') as display_name, + json_extract_path_text(Properties, 'HomeRegion') as home_region, + json_extract_path_text(Properties, 'SsoClientId') as sso_client_id, + json_extract_path_text(Properties, 'StudioEncryptionConfiguration') as studio_encryption_configuration, + json_extract_path_text(Properties, 'StudioId') as studio_id, + json_extract_path_text(Properties, 'StudioName') as studio_name, + json_extract_path_text(Properties, 'StudioUrl') as studio_url, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'UserRoleArn') as user_role_arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::NimbleStudio::Studio' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'StudioId') as studio_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NimbleStudio::Studio' + AND region = 'us-east-1' studio_components: name: studio_components id: aws.nimblestudio.studio_components @@ -1859,7 +1821,7 @@ components: x-identifiers: - StudioComponentId - StudioId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1876,9 +1838,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1888,44 +1850,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/studio_components/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/studio_components/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.StudioComponentId') as studio_component_id, - JSON_EXTRACT(Properties, '$.StudioId') as studio_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NimbleStudio::StudioComponent' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'StudioComponentId') as studio_component_id, - json_extract_path_text(Properties, 'StudioId') as studio_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NimbleStudio::StudioComponent' - AND region = 'us-east-1' - studio_component: - name: studio_component - id: aws.nimblestudio.studio_component - x-cfn-schema-name: StudioComponent - x-cfn-type-name: AWS::NimbleStudio::StudioComponent - x-identifiers: - - StudioComponentId - - StudioId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1936,12 +1863,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/studio_components/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/studio_components/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/studio_component/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/studio_components/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1963,27 +1894,45 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Configuration') as configuration, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Ec2SecurityGroupIds') as ec2_security_group_ids, - json_extract_path_text(Properties, 'InitializationScripts') as initialization_scripts, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'RuntimeRoleArn') as runtime_role_arn, - json_extract_path_text(Properties, 'ScriptParameters') as script_parameters, - json_extract_path_text(Properties, 'SecureInitializationRoleArn') as secure_initialization_role_arn, - json_extract_path_text(Properties, 'StudioComponentId') as studio_component_id, - json_extract_path_text(Properties, 'StudioId') as studio_id, - json_extract_path_text(Properties, 'Subtype') as subtype, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Type') as type - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::NimbleStudio::StudioComponent' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.StudioComponentId') as studio_component_id, + JSON_EXTRACT(Properties, '$.StudioId') as studio_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NimbleStudio::StudioComponent' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Configuration') as configuration, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Ec2SecurityGroupIds') as ec2_security_group_ids, + json_extract_path_text(Properties, 'InitializationScripts') as initialization_scripts, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'RuntimeRoleArn') as runtime_role_arn, + json_extract_path_text(Properties, 'ScriptParameters') as script_parameters, + json_extract_path_text(Properties, 'SecureInitializationRoleArn') as secure_initialization_role_arn, + json_extract_path_text(Properties, 'StudioComponentId') as studio_component_id, + json_extract_path_text(Properties, 'StudioId') as studio_id, + json_extract_path_text(Properties, 'Subtype') as subtype, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Type') as type + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::NimbleStudio::StudioComponent' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'StudioComponentId') as studio_component_id, + json_extract_path_text(Properties, 'StudioId') as studio_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::NimbleStudio::StudioComponent' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/oam.yaml b/providers/src/aws/v00.00.00000/services/oam.yaml index caf98ad5..63a76781 100644 --- a/providers/src/aws/v00.00.00000/services/oam.yaml +++ b/providers/src/aws/v00.00.00000/services/oam.yaml @@ -442,10 +442,10 @@ components: type: object additionalProperties: false x-patternProperties: - ^(?!aws:.*)[a-zA-Z0-9\s\_\.\/\=\+\-]{1,128}$: + ^(?!aws:.*).{1,128}$: type: string - description: 'The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' - pattern: ^(?!aws:.*)[a-zA-Z0-9\s\_\.\/\=\+\-]{0,256}$ + description: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. + pattern: ^(?!aws:.*).{0,256}$ minLength: 0 maxLength: 256 required: @@ -520,10 +520,10 @@ components: type: object additionalProperties: false x-patternProperties: - ^(?!aws:.*)[a-zA-Z0-9\s\_\.\/\=\+\-]{1,128}$: + ^(?!aws:.*).{1,128}$: type: string - description: 'The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' - pattern: ^(?!aws:.*)[a-zA-Z0-9\s\_\.\/\=\+\-]{0,256}$ + description: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. + pattern: ^(?!aws:.*).{0,256}$ minLength: 0 maxLength: 256 required: @@ -606,10 +606,10 @@ components: type: object additionalProperties: false x-patternProperties: - ^(?!aws:.*)[a-zA-Z0-9\s\_\.\/\=\+\-]{1,128}$: + ^(?!aws:.*).{1,128}$: type: string - description: 'The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' - pattern: ^(?!aws:.*)[a-zA-Z0-9\s\_\.\/\=\+\-]{0,256}$ + description: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. + pattern: ^(?!aws:.*).{0,256}$ minLength: 0 maxLength: 256 x-stackQL-stringOnly: true @@ -647,10 +647,10 @@ components: type: object additionalProperties: false x-patternProperties: - ^(?!aws:.*)[a-zA-Z0-9\s\_\.\/\=\+\-]{1,128}$: + ^(?!aws:.*).{1,128}$: type: string - description: 'The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' - pattern: ^(?!aws:.*)[a-zA-Z0-9\s\_\.\/\=\+\-]{0,256}$ + description: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. + pattern: ^(?!aws:.*).{0,256}$ minLength: 0 maxLength: 256 x-stackQL-stringOnly: true @@ -672,7 +672,7 @@ components: x-cfn-type-name: AWS::Oam::Link x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -689,9 +689,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -701,41 +701,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/links/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/links/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Oam::Link' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Oam::Link' - AND region = 'us-east-1' - link: - name: link - id: aws.oam.link - x-cfn-schema-name: Link - x-cfn-type-name: AWS::Oam::Link - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -746,12 +714,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/links/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/links/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/link/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/links/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -767,21 +739,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Label') as label, - json_extract_path_text(Properties, 'LabelTemplate') as label_template, - json_extract_path_text(Properties, 'ResourceTypes') as resource_types, - json_extract_path_text(Properties, 'SinkIdentifier') as sink_identifier, - json_extract_path_text(Properties, 'LinkConfiguration') as link_configuration, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Oam::Link' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Oam::Link' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Label') as label, + json_extract_path_text(Properties, 'LabelTemplate') as label_template, + json_extract_path_text(Properties, 'ResourceTypes') as resource_types, + json_extract_path_text(Properties, 'SinkIdentifier') as sink_identifier, + json_extract_path_text(Properties, 'LinkConfiguration') as link_configuration, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Oam::Link' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Oam::Link' + AND region = 'us-east-1' sinks: name: sinks id: aws.oam.sinks @@ -789,7 +777,7 @@ components: x-cfn-type-name: AWS::Oam::Sink x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -806,9 +794,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -818,41 +806,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/sinks/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/sinks/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Oam::Sink' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Oam::Sink' - AND region = 'us-east-1' - sink: - name: sink - id: aws.oam.sink - x-cfn-schema-name: Sink - x-cfn-type-name: AWS::Oam::Sink - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -863,12 +819,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/sinks/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/sinks/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/sink/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/sinks/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -881,18 +841,34 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Policy') as policy, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Oam::Sink' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Oam::Sink' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Policy') as policy, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Oam::Sink' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Oam::Sink' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/omics.yaml b/providers/src/aws/v00.00.00000/services/omics.yaml index cc6bfeee..709e2c38 100644 --- a/providers/src/aws/v00.00.00000/services/omics.yaml +++ b/providers/src/aws/v00.00.00000/services/omics.yaml @@ -1430,7 +1430,7 @@ components: x-cfn-type-name: AWS::Omics::AnnotationStore x-identifiers: - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1447,9 +1447,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1459,41 +1459,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/annotation_stores/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/annotation_stores/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Omics::AnnotationStore' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Omics::AnnotationStore' - AND region = 'us-east-1' - annotation_store: - name: annotation_store - id: aws.omics.annotation_store - x-cfn-schema-name: AnnotationStore - x-cfn-type-name: AWS::Omics::AnnotationStore - x-identifiers: - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1504,12 +1472,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/annotation_stores/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/annotation_stores/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/annotation_store/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/annotation_stores/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1532,28 +1504,44 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'CreationTime') as creation_time, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Reference') as reference, - json_extract_path_text(Properties, 'SseConfig') as sse_config, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'StatusMessage') as status_message, - json_extract_path_text(Properties, 'StoreArn') as store_arn, - json_extract_path_text(Properties, 'StoreFormat') as store_format, - json_extract_path_text(Properties, 'StoreOptions') as store_options, - json_extract_path_text(Properties, 'StoreSizeBytes') as store_size_bytes, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'UpdateTime') as update_time - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Omics::AnnotationStore' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Omics::AnnotationStore' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'CreationTime') as creation_time, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Reference') as reference, + json_extract_path_text(Properties, 'SseConfig') as sse_config, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'StatusMessage') as status_message, + json_extract_path_text(Properties, 'StoreArn') as store_arn, + json_extract_path_text(Properties, 'StoreFormat') as store_format, + json_extract_path_text(Properties, 'StoreOptions') as store_options, + json_extract_path_text(Properties, 'StoreSizeBytes') as store_size_bytes, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'UpdateTime') as update_time + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Omics::AnnotationStore' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Omics::AnnotationStore' + AND region = 'us-east-1' reference_stores: name: reference_stores id: aws.omics.reference_stores @@ -1561,7 +1549,7 @@ components: x-cfn-type-name: AWS::Omics::ReferenceStore x-identifiers: - ReferenceStoreId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1595,39 +1583,11 @@ components: - $ref: '#/components/x-stackQL-resources/reference_stores/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/reference_stores/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ReferenceStoreId') as reference_store_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Omics::ReferenceStore' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ReferenceStoreId') as reference_store_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Omics::ReferenceStore' - AND region = 'us-east-1' - reference_store: - name: reference_store - id: aws.omics.reference_store - x-cfn-schema-name: ReferenceStore - x-cfn-type-name: AWS::Omics::ReferenceStore - x-identifiers: - - ReferenceStoreId - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1643,21 +1603,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'CreationTime') as creation_time, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'ReferenceStoreId') as reference_store_id, - json_extract_path_text(Properties, 'SseConfig') as sse_config, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Omics::ReferenceStore' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ReferenceStoreId') as reference_store_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Omics::ReferenceStore' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'CreationTime') as creation_time, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'ReferenceStoreId') as reference_store_id, + json_extract_path_text(Properties, 'SseConfig') as sse_config, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Omics::ReferenceStore' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ReferenceStoreId') as reference_store_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Omics::ReferenceStore' + AND region = 'us-east-1' run_groups: name: run_groups id: aws.omics.run_groups @@ -1665,7 +1641,7 @@ components: x-cfn-type-name: AWS::Omics::RunGroup x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1682,9 +1658,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1694,41 +1670,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/run_groups/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/run_groups/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Omics::RunGroup' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Omics::RunGroup' - AND region = 'us-east-1' - run_group: - name: run_group - id: aws.omics.run_group - x-cfn-schema-name: RunGroup - x-cfn-type-name: AWS::Omics::RunGroup - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1739,12 +1683,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/run_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/run_groups/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/run_group/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/run_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1762,23 +1710,39 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'CreationTime') as creation_time, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'MaxCpus') as max_cpus, - json_extract_path_text(Properties, 'MaxGpus') as max_gpus, - json_extract_path_text(Properties, 'MaxDuration') as max_duration, - json_extract_path_text(Properties, 'MaxRuns') as max_runs, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Omics::RunGroup' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Omics::RunGroup' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'CreationTime') as creation_time, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'MaxCpus') as max_cpus, + json_extract_path_text(Properties, 'MaxGpus') as max_gpus, + json_extract_path_text(Properties, 'MaxDuration') as max_duration, + json_extract_path_text(Properties, 'MaxRuns') as max_runs, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Omics::RunGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Omics::RunGroup' + AND region = 'us-east-1' sequence_stores: name: sequence_stores id: aws.omics.sequence_stores @@ -1786,7 +1750,7 @@ components: x-cfn-type-name: AWS::Omics::SequenceStore x-identifiers: - SequenceStoreId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1820,39 +1784,11 @@ components: - $ref: '#/components/x-stackQL-resources/sequence_stores/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/sequence_stores/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.SequenceStoreId') as sequence_store_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Omics::SequenceStore' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'SequenceStoreId') as sequence_store_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Omics::SequenceStore' - AND region = 'us-east-1' - sequence_store: - name: sequence_store - id: aws.omics.sequence_store - x-cfn-schema-name: SequenceStore - x-cfn-type-name: AWS::Omics::SequenceStore - x-identifiers: - - SequenceStoreId - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1869,22 +1805,38 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'CreationTime') as creation_time, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'FallbackLocation') as fallback_location, - json_extract_path_text(Properties, 'SequenceStoreId') as sequence_store_id, - json_extract_path_text(Properties, 'SseConfig') as sse_config, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Omics::SequenceStore' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.SequenceStoreId') as sequence_store_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Omics::SequenceStore' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'CreationTime') as creation_time, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'FallbackLocation') as fallback_location, + json_extract_path_text(Properties, 'SequenceStoreId') as sequence_store_id, + json_extract_path_text(Properties, 'SseConfig') as sse_config, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Omics::SequenceStore' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'SequenceStoreId') as sequence_store_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Omics::SequenceStore' + AND region = 'us-east-1' variant_stores: name: variant_stores id: aws.omics.variant_stores @@ -1892,7 +1844,7 @@ components: x-cfn-type-name: AWS::Omics::VariantStore x-identifiers: - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1909,9 +1861,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1921,41 +1873,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/variant_stores/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/variant_stores/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Omics::VariantStore' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Omics::VariantStore' - AND region = 'us-east-1' - variant_store: - name: variant_store - id: aws.omics.variant_store - x-cfn-schema-name: VariantStore - x-cfn-type-name: AWS::Omics::VariantStore - x-identifiers: - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1966,12 +1886,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/variant_stores/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/variant_stores/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/variant_store/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/variant_stores/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1992,26 +1916,42 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'CreationTime') as creation_time, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Reference') as reference, - json_extract_path_text(Properties, 'SseConfig') as sse_config, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'StatusMessage') as status_message, - json_extract_path_text(Properties, 'StoreArn') as store_arn, - json_extract_path_text(Properties, 'StoreSizeBytes') as store_size_bytes, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'UpdateTime') as update_time - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Omics::VariantStore' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Omics::VariantStore' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'CreationTime') as creation_time, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Reference') as reference, + json_extract_path_text(Properties, 'SseConfig') as sse_config, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'StatusMessage') as status_message, + json_extract_path_text(Properties, 'StoreArn') as store_arn, + json_extract_path_text(Properties, 'StoreSizeBytes') as store_size_bytes, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'UpdateTime') as update_time + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Omics::VariantStore' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Omics::VariantStore' + AND region = 'us-east-1' workflows: name: workflows id: aws.omics.workflows @@ -2019,7 +1959,7 @@ components: x-cfn-type-name: AWS::Omics::Workflow x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2036,9 +1976,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2048,41 +1988,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/workflows/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/workflows/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Omics::Workflow' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Omics::Workflow' - AND region = 'us-east-1' - workflow: - name: workflow - id: aws.omics.workflow - x-cfn-schema-name: Workflow - x-cfn-type-name: AWS::Omics::Workflow - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2093,12 +2001,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/workflows/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/workflows/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/workflow/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/workflows/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2121,28 +2033,44 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'CreationTime') as creation_time, - json_extract_path_text(Properties, 'DefinitionUri') as definition_uri, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Engine') as engine, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Main') as main, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'ParameterTemplate') as parameter_template, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'Accelerators') as accelerators, - json_extract_path_text(Properties, 'StorageCapacity') as storage_capacity, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Type') as type - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Omics::Workflow' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Omics::Workflow' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'CreationTime') as creation_time, + json_extract_path_text(Properties, 'DefinitionUri') as definition_uri, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Engine') as engine, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Main') as main, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'ParameterTemplate') as parameter_template, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'Accelerators') as accelerators, + json_extract_path_text(Properties, 'StorageCapacity') as storage_capacity, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Type') as type + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Omics::Workflow' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Omics::Workflow' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/opensearchserverless.yaml b/providers/src/aws/v00.00.00000/services/opensearchserverless.yaml index 72568204..584b1100 100644 --- a/providers/src/aws/v00.00.00000/services/opensearchserverless.yaml +++ b/providers/src/aws/v00.00.00000/services/opensearchserverless.yaml @@ -1195,7 +1195,7 @@ components: x-identifiers: - Type - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1212,9 +1212,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1224,44 +1224,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/access_policies/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/access_policies/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Type') as type, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::OpenSearchServerless::AccessPolicy' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Type') as type, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::OpenSearchServerless::AccessPolicy' - AND region = 'us-east-1' - access_policy: - name: access_policy - id: aws.opensearchserverless.access_policy - x-cfn-schema-name: AccessPolicy - x-cfn-type-name: AWS::OpenSearchServerless::AccessPolicy - x-identifiers: - - Type - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1272,12 +1237,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/access_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/access_policies/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/access_policy/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/access_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1290,18 +1259,36 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Type') as type, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Policy') as policy - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::OpenSearchServerless::AccessPolicy' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.Type') as type, + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::OpenSearchServerless::AccessPolicy' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Policy') as policy + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::OpenSearchServerless::AccessPolicy' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::OpenSearchServerless::AccessPolicy' + AND region = 'us-east-1' collections: name: collections id: aws.opensearchserverless.collections @@ -1309,7 +1296,7 @@ components: x-cfn-type-name: AWS::OpenSearchServerless::Collection x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1326,9 +1313,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1338,41 +1325,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/collections/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/collections/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::OpenSearchServerless::Collection' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::OpenSearchServerless::Collection' - AND region = 'us-east-1' - collection: - name: collection - id: aws.opensearchserverless.collection - x-cfn-schema-name: Collection - x-cfn-type-name: AWS::OpenSearchServerless::Collection - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1383,12 +1338,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/collections/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/collections/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/collection/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/collections/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1406,23 +1365,39 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'CollectionEndpoint') as collection_endpoint, - json_extract_path_text(Properties, 'DashboardEndpoint') as dashboard_endpoint, - json_extract_path_text(Properties, 'Type') as type, - json_extract_path_text(Properties, 'StandbyReplicas') as standby_replicas - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::OpenSearchServerless::Collection' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::OpenSearchServerless::Collection' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'CollectionEndpoint') as collection_endpoint, + json_extract_path_text(Properties, 'DashboardEndpoint') as dashboard_endpoint, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'StandbyReplicas') as standby_replicas + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::OpenSearchServerless::Collection' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::OpenSearchServerless::Collection' + AND region = 'us-east-1' lifecycle_policies: name: lifecycle_policies id: aws.opensearchserverless.lifecycle_policies @@ -1431,7 +1406,7 @@ components: x-identifiers: - Type - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1448,9 +1423,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1460,44 +1435,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/lifecycle_policies/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/lifecycle_policies/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Type') as type, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::OpenSearchServerless::LifecyclePolicy' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Type') as type, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::OpenSearchServerless::LifecyclePolicy' - AND region = 'us-east-1' - lifecycle_policy: - name: lifecycle_policy - id: aws.opensearchserverless.lifecycle_policy - x-cfn-schema-name: LifecyclePolicy - x-cfn-type-name: AWS::OpenSearchServerless::LifecyclePolicy - x-identifiers: - - Type - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1508,12 +1448,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/lifecycle_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/lifecycle_policies/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/lifecycle_policy/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/lifecycle_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1526,18 +1470,36 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Type') as type, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Policy') as policy - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::OpenSearchServerless::LifecyclePolicy' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.Type') as type, + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::OpenSearchServerless::LifecyclePolicy' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Policy') as policy + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::OpenSearchServerless::LifecyclePolicy' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::OpenSearchServerless::LifecyclePolicy' + AND region = 'us-east-1' security_configs: name: security_configs id: aws.opensearchserverless.security_configs @@ -1545,7 +1507,7 @@ components: x-cfn-type-name: AWS::OpenSearchServerless::SecurityConfig x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1562,9 +1524,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1574,41 +1536,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/security_configs/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/security_configs/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::OpenSearchServerless::SecurityConfig' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::OpenSearchServerless::SecurityConfig' - AND region = 'us-east-1' - security_config: - name: security_config - id: aws.opensearchserverless.security_config - x-cfn-schema-name: SecurityConfig - x-cfn-type-name: AWS::OpenSearchServerless::SecurityConfig - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1619,12 +1549,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/security_configs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/security_configs/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/security_config/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/security_configs/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1638,19 +1572,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'SamlOptions') as saml_options, - json_extract_path_text(Properties, 'Type') as type - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::OpenSearchServerless::SecurityConfig' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::OpenSearchServerless::SecurityConfig' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'SamlOptions') as saml_options, + json_extract_path_text(Properties, 'Type') as type + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::OpenSearchServerless::SecurityConfig' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::OpenSearchServerless::SecurityConfig' + AND region = 'us-east-1' security_policies: name: security_policies id: aws.opensearchserverless.security_policies @@ -1659,7 +1609,7 @@ components: x-identifiers: - Type - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1676,9 +1626,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1688,44 +1638,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/security_policies/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/security_policies/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Type') as type, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::OpenSearchServerless::SecurityPolicy' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Type') as type, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::OpenSearchServerless::SecurityPolicy' - AND region = 'us-east-1' - security_policy: - name: security_policy - id: aws.opensearchserverless.security_policy - x-cfn-schema-name: SecurityPolicy - x-cfn-type-name: AWS::OpenSearchServerless::SecurityPolicy - x-identifiers: - - Type - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1736,12 +1651,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/security_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/security_policies/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/security_policy/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/security_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1754,18 +1673,36 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Policy') as policy, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Type') as type - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::OpenSearchServerless::SecurityPolicy' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.Type') as type, + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::OpenSearchServerless::SecurityPolicy' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Policy') as policy, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Type') as type + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::OpenSearchServerless::SecurityPolicy' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::OpenSearchServerless::SecurityPolicy' + AND region = 'us-east-1' vpc_endpoints: name: vpc_endpoints id: aws.opensearchserverless.vpc_endpoints @@ -1773,7 +1710,7 @@ components: x-cfn-type-name: AWS::OpenSearchServerless::VpcEndpoint x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1790,9 +1727,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1802,41 +1739,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/vpc_endpoints/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/vpc_endpoints/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::OpenSearchServerless::VpcEndpoint' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::OpenSearchServerless::VpcEndpoint' - AND region = 'us-east-1' - vpc_endpoint: - name: vpc_endpoint - id: aws.opensearchserverless.vpc_endpoint - x-cfn-schema-name: VpcEndpoint - x-cfn-type-name: AWS::OpenSearchServerless::VpcEndpoint - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1847,12 +1752,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/vpc_endpoints/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/vpc_endpoints/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/vpc_endpoint/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/vpc_endpoints/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1866,19 +1775,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'SecurityGroupIds') as security_group_ids, - json_extract_path_text(Properties, 'SubnetIds') as subnet_ids, - json_extract_path_text(Properties, 'VpcId') as vpc_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::OpenSearchServerless::VpcEndpoint' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::OpenSearchServerless::VpcEndpoint' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'SecurityGroupIds') as security_group_ids, + json_extract_path_text(Properties, 'SubnetIds') as subnet_ids, + json_extract_path_text(Properties, 'VpcId') as vpc_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::OpenSearchServerless::VpcEndpoint' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::OpenSearchServerless::VpcEndpoint' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/opensearchservice.yaml b/providers/src/aws/v00.00.00000/services/opensearchservice.yaml index 4d494954..5b5d7145 100644 --- a/providers/src/aws/v00.00.00000/services/opensearchservice.yaml +++ b/providers/src/aws/v00.00.00000/services/opensearchservice.yaml @@ -846,7 +846,7 @@ components: x-cfn-type-name: AWS::OpenSearchService::Domain x-identifiers: - DomainName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -863,9 +863,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -875,23 +875,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/domains/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/domains/methods/delete_resource' - domain: - name: domain - id: aws.opensearchservice.domain - x-cfn-schema-name: Domain - x-cfn-type-name: AWS::OpenSearchService::Domain - x-identifiers: - - DomainName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -902,12 +888,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/domains/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/domains/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/domain/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/domains/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -941,7 +931,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, diff --git a/providers/src/aws/v00.00.00000/services/opsworkscm.yaml b/providers/src/aws/v00.00.00000/services/opsworkscm.yaml index aeb463a9..a8cdce6c 100644 --- a/providers/src/aws/v00.00.00000/services/opsworkscm.yaml +++ b/providers/src/aws/v00.00.00000/services/opsworkscm.yaml @@ -685,7 +685,7 @@ components: x-cfn-type-name: AWS::OpsWorksCM::Server x-identifiers: - ServerName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -702,9 +702,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -714,41 +714,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/servers/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/servers/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ServerName') as server_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::OpsWorksCM::Server' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ServerName') as server_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::OpsWorksCM::Server' - AND region = 'us-east-1' - server: - name: server - id: aws.opsworkscm.server - x-cfn-schema-name: Server - x-cfn-type-name: AWS::OpsWorksCM::Server - x-identifiers: - - ServerName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -759,12 +727,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/servers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/servers/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/server/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/servers/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -796,37 +768,53 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'KeyPair') as key_pair, - json_extract_path_text(Properties, 'EngineVersion') as engine_version, - json_extract_path_text(Properties, 'ServiceRoleArn') as service_role_arn, - json_extract_path_text(Properties, 'DisableAutomatedBackup') as disable_automated_backup, - json_extract_path_text(Properties, 'BackupId') as backup_id, - json_extract_path_text(Properties, 'EngineModel') as engine_model, - json_extract_path_text(Properties, 'PreferredMaintenanceWindow') as preferred_maintenance_window, - json_extract_path_text(Properties, 'AssociatePublicIpAddress') as associate_public_ip_address, - json_extract_path_text(Properties, 'InstanceProfileArn') as instance_profile_arn, - json_extract_path_text(Properties, 'CustomCertificate') as custom_certificate, - json_extract_path_text(Properties, 'PreferredBackupWindow') as preferred_backup_window, - json_extract_path_text(Properties, 'SecurityGroupIds') as security_group_ids, - json_extract_path_text(Properties, 'SubnetIds') as subnet_ids, - json_extract_path_text(Properties, 'CustomDomain') as custom_domain, - json_extract_path_text(Properties, 'Endpoint') as endpoint, - json_extract_path_text(Properties, 'CustomPrivateKey') as custom_private_key, - json_extract_path_text(Properties, 'ServerName') as server_name, - json_extract_path_text(Properties, 'EngineAttributes') as engine_attributes, - json_extract_path_text(Properties, 'BackupRetentionCount') as backup_retention_count, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'InstanceType') as instance_type, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Engine') as engine - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::OpsWorksCM::Server' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ServerName') as server_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::OpsWorksCM::Server' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'KeyPair') as key_pair, + json_extract_path_text(Properties, 'EngineVersion') as engine_version, + json_extract_path_text(Properties, 'ServiceRoleArn') as service_role_arn, + json_extract_path_text(Properties, 'DisableAutomatedBackup') as disable_automated_backup, + json_extract_path_text(Properties, 'BackupId') as backup_id, + json_extract_path_text(Properties, 'EngineModel') as engine_model, + json_extract_path_text(Properties, 'PreferredMaintenanceWindow') as preferred_maintenance_window, + json_extract_path_text(Properties, 'AssociatePublicIpAddress') as associate_public_ip_address, + json_extract_path_text(Properties, 'InstanceProfileArn') as instance_profile_arn, + json_extract_path_text(Properties, 'CustomCertificate') as custom_certificate, + json_extract_path_text(Properties, 'PreferredBackupWindow') as preferred_backup_window, + json_extract_path_text(Properties, 'SecurityGroupIds') as security_group_ids, + json_extract_path_text(Properties, 'SubnetIds') as subnet_ids, + json_extract_path_text(Properties, 'CustomDomain') as custom_domain, + json_extract_path_text(Properties, 'Endpoint') as endpoint, + json_extract_path_text(Properties, 'CustomPrivateKey') as custom_private_key, + json_extract_path_text(Properties, 'ServerName') as server_name, + json_extract_path_text(Properties, 'EngineAttributes') as engine_attributes, + json_extract_path_text(Properties, 'BackupRetentionCount') as backup_retention_count, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'InstanceType') as instance_type, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Engine') as engine + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::OpsWorksCM::Server' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ServerName') as server_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::OpsWorksCM::Server' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/organizations.yaml b/providers/src/aws/v00.00.00000/services/organizations.yaml index ef25dca3..68512df7 100644 --- a/providers/src/aws/v00.00.00000/services/organizations.yaml +++ b/providers/src/aws/v00.00.00000/services/organizations.yaml @@ -1119,7 +1119,7 @@ components: x-cfn-type-name: AWS::Organizations::Account x-identifiers: - AccountId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1136,9 +1136,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1148,41 +1148,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/accounts/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/accounts/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AccountId') as account_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Organizations::Account' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AccountId') as account_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Organizations::Account' - AND region = 'us-east-1' - account: - name: account - id: aws.organizations.account - x-cfn-schema-name: Account - x-cfn-type-name: AWS::Organizations::Account - x-identifiers: - - AccountId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1193,12 +1161,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/accounts/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/accounts/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/account/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/accounts/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1217,24 +1189,40 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AccountName') as account_name, - json_extract_path_text(Properties, 'Email') as email, - json_extract_path_text(Properties, 'RoleName') as role_name, - json_extract_path_text(Properties, 'ParentIds') as parent_ids, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'AccountId') as account_id, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'JoinedMethod') as joined_method, - json_extract_path_text(Properties, 'JoinedTimestamp') as joined_timestamp, - json_extract_path_text(Properties, 'Status') as status - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Organizations::Account' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.AccountId') as account_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Organizations::Account' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AccountName') as account_name, + json_extract_path_text(Properties, 'Email') as email, + json_extract_path_text(Properties, 'RoleName') as role_name, + json_extract_path_text(Properties, 'ParentIds') as parent_ids, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'AccountId') as account_id, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'JoinedMethod') as joined_method, + json_extract_path_text(Properties, 'JoinedTimestamp') as joined_timestamp, + json_extract_path_text(Properties, 'Status') as status + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Organizations::Account' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AccountId') as account_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Organizations::Account' + AND region = 'us-east-1' organizations: name: organizations id: aws.organizations.organizations @@ -1242,7 +1230,7 @@ components: x-cfn-type-name: AWS::Organizations::Organization x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1276,39 +1264,11 @@ components: - $ref: '#/components/x-stackQL-resources/organizations/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/organizations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Organizations::Organization' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Organizations::Organization' - AND region = 'us-east-1' - organization: - name: organization - id: aws.organizations.organization - x-cfn-schema-name: Organization - x-cfn-type-name: AWS::Organizations::Organization - x-identifiers: - - Id - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1324,21 +1284,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'FeatureSet') as feature_set, - json_extract_path_text(Properties, 'ManagementAccountArn') as management_account_arn, - json_extract_path_text(Properties, 'ManagementAccountId') as management_account_id, - json_extract_path_text(Properties, 'ManagementAccountEmail') as management_account_email, - json_extract_path_text(Properties, 'RootId') as root_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Organizations::Organization' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Organizations::Organization' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'FeatureSet') as feature_set, + json_extract_path_text(Properties, 'ManagementAccountArn') as management_account_arn, + json_extract_path_text(Properties, 'ManagementAccountId') as management_account_id, + json_extract_path_text(Properties, 'ManagementAccountEmail') as management_account_email, + json_extract_path_text(Properties, 'RootId') as root_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Organizations::Organization' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Organizations::Organization' + AND region = 'us-east-1' organizational_units: name: organizational_units id: aws.organizations.organizational_units @@ -1346,7 +1322,7 @@ components: x-cfn-type-name: AWS::Organizations::OrganizationalUnit x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1363,9 +1339,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1375,41 +1351,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/organizational_units/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/organizational_units/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Organizations::OrganizationalUnit' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Organizations::OrganizationalUnit' - AND region = 'us-east-1' - organizational_unit: - name: organizational_unit - id: aws.organizations.organizational_unit - x-cfn-schema-name: OrganizationalUnit - x-cfn-type-name: AWS::Organizations::OrganizationalUnit - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1420,12 +1364,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/organizational_units/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/organizational_units/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/organizational_unit/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/organizational_units/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1439,19 +1387,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'ParentId') as parent_id, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Organizations::OrganizationalUnit' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Organizations::OrganizationalUnit' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'ParentId') as parent_id, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Organizations::OrganizationalUnit' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Organizations::OrganizationalUnit' + AND region = 'us-east-1' policies: name: policies id: aws.organizations.policies @@ -1459,7 +1423,7 @@ components: x-cfn-type-name: AWS::Organizations::Policy x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1476,9 +1440,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1488,41 +1452,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/policies/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/policies/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Organizations::Policy' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Organizations::Policy' - AND region = 'us-east-1' - policy: - name: policy - id: aws.organizations.policy - x-cfn-schema-name: Policy - x-cfn-type-name: AWS::Organizations::Policy - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1533,12 +1465,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/policies/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/policy/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1556,23 +1492,39 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Type') as type, - json_extract_path_text(Properties, 'Content') as content, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'TargetIds') as target_ids, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'AwsManaged') as aws_managed - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Organizations::Policy' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Organizations::Policy' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'Content') as content, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'TargetIds') as target_ids, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'AwsManaged') as aws_managed + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Organizations::Policy' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Organizations::Policy' + AND region = 'us-east-1' resource_policies: name: resource_policies id: aws.organizations.resource_policies @@ -1580,7 +1532,7 @@ components: x-cfn-type-name: AWS::Organizations::ResourcePolicy x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1597,9 +1549,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1609,41 +1561,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/resource_policies/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/resource_policies/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Organizations::ResourcePolicy' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Organizations::ResourcePolicy' - AND region = 'us-east-1' - resource_policy: - name: resource_policy - id: aws.organizations.resource_policy - x-cfn-schema-name: ResourcePolicy - x-cfn-type-name: AWS::Organizations::ResourcePolicy - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1654,12 +1574,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/resource_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/resource_policies/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/resource_policy/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/resource_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1672,18 +1596,34 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Content') as content, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Organizations::ResourcePolicy' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Organizations::ResourcePolicy' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Content') as content, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Organizations::ResourcePolicy' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Organizations::ResourcePolicy' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/osis.yaml b/providers/src/aws/v00.00.00000/services/osis.yaml index 4c0b9709..0f7f9138 100644 --- a/providers/src/aws/v00.00.00000/services/osis.yaml +++ b/providers/src/aws/v00.00.00000/services/osis.yaml @@ -685,7 +685,7 @@ components: x-cfn-type-name: AWS::OSIS::Pipeline x-identifiers: - PipelineArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -702,9 +702,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -714,41 +714,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/pipelines/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/pipelines/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.PipelineArn') as pipeline_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::OSIS::Pipeline' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'PipelineArn') as pipeline_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::OSIS::Pipeline' - AND region = 'us-east-1' - pipeline: - name: pipeline - id: aws.osis.pipeline - x-cfn-schema-name: Pipeline - x-cfn-type-name: AWS::OSIS::Pipeline - x-identifiers: - - PipelineArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -759,12 +727,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/pipelines/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/pipelines/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/pipeline/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/pipelines/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -785,26 +757,42 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'BufferOptions') as buffer_options, - json_extract_path_text(Properties, 'EncryptionAtRestOptions') as encryption_at_rest_options, - json_extract_path_text(Properties, 'LogPublishingOptions') as log_publishing_options, - json_extract_path_text(Properties, 'MaxUnits') as max_units, - json_extract_path_text(Properties, 'MinUnits') as min_units, - json_extract_path_text(Properties, 'PipelineConfigurationBody') as pipeline_configuration_body, - json_extract_path_text(Properties, 'PipelineName') as pipeline_name, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'VpcOptions') as vpc_options, - json_extract_path_text(Properties, 'VpcEndpoints') as vpc_endpoints, - json_extract_path_text(Properties, 'PipelineArn') as pipeline_arn, - json_extract_path_text(Properties, 'IngestEndpointUrls') as ingest_endpoint_urls - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::OSIS::Pipeline' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.PipelineArn') as pipeline_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::OSIS::Pipeline' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'BufferOptions') as buffer_options, + json_extract_path_text(Properties, 'EncryptionAtRestOptions') as encryption_at_rest_options, + json_extract_path_text(Properties, 'LogPublishingOptions') as log_publishing_options, + json_extract_path_text(Properties, 'MaxUnits') as max_units, + json_extract_path_text(Properties, 'MinUnits') as min_units, + json_extract_path_text(Properties, 'PipelineConfigurationBody') as pipeline_configuration_body, + json_extract_path_text(Properties, 'PipelineName') as pipeline_name, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'VpcOptions') as vpc_options, + json_extract_path_text(Properties, 'VpcEndpoints') as vpc_endpoints, + json_extract_path_text(Properties, 'PipelineArn') as pipeline_arn, + json_extract_path_text(Properties, 'IngestEndpointUrls') as ingest_endpoint_urls + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::OSIS::Pipeline' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'PipelineArn') as pipeline_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::OSIS::Pipeline' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/panorama.yaml b/providers/src/aws/v00.00.00000/services/panorama.yaml index acc9381b..ce612f07 100644 --- a/providers/src/aws/v00.00.00000/services/panorama.yaml +++ b/providers/src/aws/v00.00.00000/services/panorama.yaml @@ -964,7 +964,7 @@ components: x-cfn-type-name: AWS::Panorama::ApplicationInstance x-identifiers: - ApplicationInstanceId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -981,9 +981,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -993,41 +993,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/application_instances/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/application_instances/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ApplicationInstanceId') as application_instance_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Panorama::ApplicationInstance' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ApplicationInstanceId') as application_instance_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Panorama::ApplicationInstance' - AND region = 'us-east-1' - application_instance: - name: application_instance - id: aws.panorama.application_instance - x-cfn-schema-name: ApplicationInstance - x-cfn-type-name: AWS::Panorama::ApplicationInstance - x-identifiers: - - ApplicationInstanceId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1038,12 +1006,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/application_instances/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/application_instances/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/application_instance/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/application_instances/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1068,30 +1040,46 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'DefaultRuntimeContextDeviceName') as default_runtime_context_device_name, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'DefaultRuntimeContextDevice') as default_runtime_context_device, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'ApplicationInstanceIdToReplace') as application_instance_id_to_replace, - json_extract_path_text(Properties, 'CreatedTime') as created_time, - json_extract_path_text(Properties, 'HealthStatus') as health_status, - json_extract_path_text(Properties, 'ManifestOverridesPayload') as manifest_overrides_payload, - json_extract_path_text(Properties, 'LastUpdatedTime') as last_updated_time, - json_extract_path_text(Properties, 'RuntimeRoleArn') as runtime_role_arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'ApplicationInstanceId') as application_instance_id, - json_extract_path_text(Properties, 'StatusDescription') as status_description, - json_extract_path_text(Properties, 'ManifestPayload') as manifest_payload, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Panorama::ApplicationInstance' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ApplicationInstanceId') as application_instance_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Panorama::ApplicationInstance' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DefaultRuntimeContextDeviceName') as default_runtime_context_device_name, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'DefaultRuntimeContextDevice') as default_runtime_context_device, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'ApplicationInstanceIdToReplace') as application_instance_id_to_replace, + json_extract_path_text(Properties, 'CreatedTime') as created_time, + json_extract_path_text(Properties, 'HealthStatus') as health_status, + json_extract_path_text(Properties, 'ManifestOverridesPayload') as manifest_overrides_payload, + json_extract_path_text(Properties, 'LastUpdatedTime') as last_updated_time, + json_extract_path_text(Properties, 'RuntimeRoleArn') as runtime_role_arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'ApplicationInstanceId') as application_instance_id, + json_extract_path_text(Properties, 'StatusDescription') as status_description, + json_extract_path_text(Properties, 'ManifestPayload') as manifest_payload, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Panorama::ApplicationInstance' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ApplicationInstanceId') as application_instance_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Panorama::ApplicationInstance' + AND region = 'us-east-1' packages: name: packages id: aws.panorama.packages @@ -1099,7 +1087,7 @@ components: x-cfn-type-name: AWS::Panorama::Package x-identifiers: - PackageId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1116,9 +1104,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1128,41 +1116,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/packages/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/packages/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.PackageId') as package_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Panorama::Package' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'PackageId') as package_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Panorama::Package' - AND region = 'us-east-1' - package: - name: package - id: aws.panorama.package - x-cfn-schema-name: Package - x-cfn-type-name: AWS::Panorama::Package - x-identifiers: - - PackageId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1173,12 +1129,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/packages/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/packages/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/package/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/packages/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1193,20 +1153,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'PackageName') as package_name, - json_extract_path_text(Properties, 'PackageId') as package_id, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'StorageLocation') as storage_location, - json_extract_path_text(Properties, 'CreatedTime') as created_time, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Panorama::Package' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.PackageId') as package_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Panorama::Package' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'PackageName') as package_name, + json_extract_path_text(Properties, 'PackageId') as package_id, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'StorageLocation') as storage_location, + json_extract_path_text(Properties, 'CreatedTime') as created_time, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Panorama::Package' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'PackageId') as package_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Panorama::Package' + AND region = 'us-east-1' package_versions: name: package_versions id: aws.panorama.package_versions @@ -1216,7 +1192,7 @@ components: - PackageId - PackageVersion - PatchVersion - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1233,9 +1209,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1245,25 +1221,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/package_versions/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/package_versions/methods/delete_resource' - package_version: - name: package_version - id: aws.panorama.package_version - x-cfn-schema-name: PackageVersion - x-cfn-type-name: AWS::Panorama::PackageVersion - x-identifiers: - - PackageId - - PackageVersion - - PatchVersion - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1274,12 +1234,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/package_versions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/package_versions/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/package_version/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/package_versions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1300,7 +1264,7 @@ components: AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, diff --git a/providers/src/aws/v00.00.00000/services/paymentcryptography.yaml b/providers/src/aws/v00.00.00000/services/paymentcryptography.yaml new file mode 100644 index 00000000..669bc0f2 --- /dev/null +++ b/providers/src/aws/v00.00.00000/services/paymentcryptography.yaml @@ -0,0 +1,1132 @@ +openapi: 3.0.0 +info: + title: PaymentCryptography + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) +components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + schemas: + Alias: + type: object + properties: + AliasName: + type: string + maxLength: 256 + minLength: 7 + pattern: ^alias/[a-zA-Z0-9/_-]+$ + KeyArn: + type: string + maxLength: 150 + minLength: 70 + pattern: ^arn:aws:payment-cryptography:[a-z]{2}-[a-z]{1,16}-[0-9]+:[0-9]{12}:key/[0-9a-zA-Z]{16,64}$ + required: + - AliasName + x-stackql-resource-name: alias + description: Definition of AWS::PaymentCryptography::Alias Resource Type + x-type-name: AWS::PaymentCryptography::Alias + x-stackql-primary-identifier: + - AliasName + x-create-only-properties: + - AliasName + x-required-properties: + - AliasName + x-tagging: + taggable: false + x-required-permissions: + create: + - payment-cryptography:CreateAlias + read: + - payment-cryptography:GetAlias + update: + - payment-cryptography:UpdateAlias + delete: + - payment-cryptography:DeleteAlias + list: + - payment-cryptography:ListAliases + KeyAlgorithm: + type: string + enum: + - TDES_2KEY + - TDES_3KEY + - AES_128 + - AES_192 + - AES_256 + - RSA_2048 + - RSA_3072 + - RSA_4096 + KeyAttributes: + type: object + properties: + KeyUsage: + $ref: '#/components/schemas/KeyUsage' + KeyClass: + $ref: '#/components/schemas/KeyClass' + KeyAlgorithm: + $ref: '#/components/schemas/KeyAlgorithm' + KeyModesOfUse: + $ref: '#/components/schemas/KeyModesOfUse' + required: + - KeyAlgorithm + - KeyClass + - KeyModesOfUse + - KeyUsage + additionalProperties: false + KeyCheckValueAlgorithm: + type: string + enum: + - CMAC + - ANSI_X9_24 + KeyClass: + type: string + enum: + - SYMMETRIC_KEY + - ASYMMETRIC_KEY_PAIR + - PRIVATE_KEY + - PUBLIC_KEY + KeyModesOfUse: + type: object + properties: + Encrypt: + type: boolean + default: false + Decrypt: + type: boolean + default: false + Wrap: + type: boolean + default: false + Unwrap: + type: boolean + default: false + Generate: + type: boolean + default: false + Sign: + type: boolean + default: false + Verify: + type: boolean + default: false + DeriveKey: + type: boolean + default: false + NoRestrictions: + type: boolean + default: false + additionalProperties: false + KeyOrigin: + type: string + description: Defines the source of a key + enum: + - EXTERNAL + - AWS_PAYMENT_CRYPTOGRAPHY + KeyState: + type: string + description: Defines the state of a key + enum: + - CREATE_IN_PROGRESS + - CREATE_COMPLETE + - DELETE_PENDING + - DELETE_COMPLETE + KeyUsage: + type: string + enum: + - TR31_B0_BASE_DERIVATION_KEY + - TR31_C0_CARD_VERIFICATION_KEY + - TR31_D0_SYMMETRIC_DATA_ENCRYPTION_KEY + - TR31_D1_ASYMMETRIC_KEY_FOR_DATA_ENCRYPTION + - TR31_E0_EMV_MKEY_APP_CRYPTOGRAMS + - TR31_E1_EMV_MKEY_CONFIDENTIALITY + - TR31_E2_EMV_MKEY_INTEGRITY + - TR31_E4_EMV_MKEY_DYNAMIC_NUMBERS + - TR31_E5_EMV_MKEY_CARD_PERSONALIZATION + - TR31_E6_EMV_MKEY_OTHER + - TR31_K0_KEY_ENCRYPTION_KEY + - TR31_K1_KEY_BLOCK_PROTECTION_KEY + - TR31_K3_ASYMMETRIC_KEY_FOR_KEY_AGREEMENT + - TR31_M3_ISO_9797_3_MAC_KEY + - TR31_M1_ISO_9797_1_MAC_KEY + - TR31_M6_ISO_9797_5_CMAC_KEY + - TR31_M7_HMAC_KEY + - TR31_P0_PIN_ENCRYPTION_KEY + - TR31_P1_PIN_GENERATION_KEY + - TR31_S0_ASYMMETRIC_KEY_FOR_DIGITAL_SIGNATURE + - TR31_V1_IBM3624_PIN_VERIFICATION_KEY + - TR31_V2_VISA_PIN_VERIFICATION_KEY + - TR31_K2_TR34_ASYMMETRIC_KEY + Tag: + type: object + properties: + Key: + type: string + maxLength: 128 + minLength: 1 + Value: + type: string + maxLength: 256 + minLength: 0 + required: + - Key + additionalProperties: false + Key: + type: object + properties: + Enabled: + type: boolean + Exportable: + type: boolean + KeyAttributes: + $ref: '#/components/schemas/KeyAttributes' + KeyCheckValueAlgorithm: + $ref: '#/components/schemas/KeyCheckValueAlgorithm' + KeyIdentifier: + type: string + maxLength: 322 + minLength: 7 + pattern: ^arn:aws:payment-cryptography:[a-z]{2}-[a-z]{1,16}-[0-9]+:[0-9]{12}:(key/[0-9a-zA-Z]{16,64}|alias/[a-zA-Z0-9/_-]+)$|^alias/[a-zA-Z0-9/_-]+$ + KeyOrigin: + $ref: '#/components/schemas/KeyOrigin' + KeyState: + $ref: '#/components/schemas/KeyState' + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + x-insertionOrder: false + required: + - Exportable + - KeyAttributes + x-stackql-resource-name: key + description: Definition of AWS::PaymentCryptography::Key Resource Type + x-type-name: AWS::PaymentCryptography::Key + x-stackql-primary-identifier: + - KeyIdentifier + x-read-only-properties: + - KeyIdentifier + - KeyOrigin + - KeyState + x-required-properties: + - Exportable + - KeyAttributes + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + x-required-permissions: + create: + - payment-cryptography:GetKey + - payment-cryptography:CreateKey + - payment-cryptography:TagResource + read: + - payment-cryptography:GetKey + - payment-cryptography:ListTagsForResource + update: + - payment-cryptography:GetKey + - payment-cryptography:ListTagsForResource + - payment-cryptography:TagResource + - payment-cryptography:UntagResource + - payment-cryptography:StartKeyUsage + - payment-cryptography:StopKeyUsage + delete: + - payment-cryptography:GetKey + - payment-cryptography:DeleteKey + list: + - payment-cryptography:ListKeys + CreateAliasRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AliasName: + type: string + maxLength: 256 + minLength: 7 + pattern: ^alias/[a-zA-Z0-9/_-]+$ + KeyArn: + type: string + maxLength: 150 + minLength: 70 + pattern: ^arn:aws:payment-cryptography:[a-z]{2}-[a-z]{1,16}-[0-9]+:[0-9]{12}:key/[0-9a-zA-Z]{16,64}$ + x-stackQL-stringOnly: true + x-title: CreateAliasRequest + type: object + required: [] + CreateKeyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Enabled: + type: boolean + Exportable: + type: boolean + KeyAttributes: + $ref: '#/components/schemas/KeyAttributes' + KeyCheckValueAlgorithm: + $ref: '#/components/schemas/KeyCheckValueAlgorithm' + KeyIdentifier: + type: string + maxLength: 322 + minLength: 7 + pattern: ^arn:aws:payment-cryptography:[a-z]{2}-[a-z]{1,16}-[0-9]+:[0-9]{12}:(key/[0-9a-zA-Z]{16,64}|alias/[a-zA-Z0-9/_-]+)$|^alias/[a-zA-Z0-9/_-]+$ + KeyOrigin: + $ref: '#/components/schemas/KeyOrigin' + KeyState: + $ref: '#/components/schemas/KeyState' + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + x-insertionOrder: false + x-stackQL-stringOnly: true + x-title: CreateKeyRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 + x-stackQL-resources: + aliases: + name: aliases + id: aws.paymentcryptography.aliases + x-cfn-schema-name: Alias + x-cfn-type-name: AWS::PaymentCryptography::Alias + x-identifiers: + - AliasName + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Alias&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::PaymentCryptography::Alias" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::PaymentCryptography::Alias" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::PaymentCryptography::Alias" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/aliases/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/aliases/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/aliases/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.AliasName') as alias_name, + JSON_EXTRACT(Properties, '$.KeyArn') as key_arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::PaymentCryptography::Alias' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.AliasName') as alias_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::PaymentCryptography::Alias' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AliasName') as alias_name, + json_extract_path_text(Properties, 'KeyArn') as key_arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::PaymentCryptography::Alias' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AliasName') as alias_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::PaymentCryptography::Alias' + AND region = 'us-east-1' + keys: + name: keys + id: aws.paymentcryptography.keys + x-cfn-schema-name: Key + x-cfn-type-name: AWS::PaymentCryptography::Key + x-identifiers: + - KeyIdentifier + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Key&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::PaymentCryptography::Key" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::PaymentCryptography::Key" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::PaymentCryptography::Key" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/keys/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/keys/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/keys/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Enabled') as enabled, + JSON_EXTRACT(Properties, '$.Exportable') as exportable, + JSON_EXTRACT(Properties, '$.KeyAttributes') as key_attributes, + JSON_EXTRACT(Properties, '$.KeyCheckValueAlgorithm') as key_check_value_algorithm, + JSON_EXTRACT(Properties, '$.KeyIdentifier') as key_identifier, + JSON_EXTRACT(Properties, '$.KeyOrigin') as key_origin, + JSON_EXTRACT(Properties, '$.KeyState') as key_state, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::PaymentCryptography::Key' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.KeyIdentifier') as key_identifier + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::PaymentCryptography::Key' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Enabled') as enabled, + json_extract_path_text(Properties, 'Exportable') as exportable, + json_extract_path_text(Properties, 'KeyAttributes') as key_attributes, + json_extract_path_text(Properties, 'KeyCheckValueAlgorithm') as key_check_value_algorithm, + json_extract_path_text(Properties, 'KeyIdentifier') as key_identifier, + json_extract_path_text(Properties, 'KeyOrigin') as key_origin, + json_extract_path_text(Properties, 'KeyState') as key_state, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::PaymentCryptography::Key' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'KeyIdentifier') as key_identifier + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::PaymentCryptography::Key' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Alias&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAlias + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAliasRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Key&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateKey + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateKeyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/aws/v00.00.00000/services/pcaconnectorad.yaml b/providers/src/aws/v00.00.00000/services/pcaconnectorad.yaml index f349a659..71f66385 100644 --- a/providers/src/aws/v00.00.00000/services/pcaconnectorad.yaml +++ b/providers/src/aws/v00.00.00000/services/pcaconnectorad.yaml @@ -1551,7 +1551,7 @@ components: x-cfn-type-name: AWS::PCAConnectorAD::Connector x-identifiers: - ConnectorArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1568,9 +1568,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1580,41 +1580,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/connectors/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/connectors/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ConnectorArn') as connector_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::PCAConnectorAD::Connector' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ConnectorArn') as connector_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::PCAConnectorAD::Connector' - AND region = 'us-east-1' - connector: - name: connector - id: aws.pcaconnectorad.connector - x-cfn-schema-name: Connector - x-cfn-type-name: AWS::PCAConnectorAD::Connector - x-identifiers: - - ConnectorArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1625,12 +1593,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/connectors/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/connectors/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/connector/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/connectors/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1644,19 +1616,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'CertificateAuthorityArn') as certificate_authority_arn, - json_extract_path_text(Properties, 'ConnectorArn') as connector_arn, - json_extract_path_text(Properties, 'DirectoryId') as directory_id, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'VpcInformation') as vpc_information - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::PCAConnectorAD::Connector' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ConnectorArn') as connector_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::PCAConnectorAD::Connector' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'CertificateAuthorityArn') as certificate_authority_arn, + json_extract_path_text(Properties, 'ConnectorArn') as connector_arn, + json_extract_path_text(Properties, 'DirectoryId') as directory_id, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'VpcInformation') as vpc_information + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::PCAConnectorAD::Connector' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ConnectorArn') as connector_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::PCAConnectorAD::Connector' + AND region = 'us-east-1' directory_registrations: name: directory_registrations id: aws.pcaconnectorad.directory_registrations @@ -1664,7 +1652,7 @@ components: x-cfn-type-name: AWS::PCAConnectorAD::DirectoryRegistration x-identifiers: - DirectoryRegistrationArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1681,9 +1669,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1693,41 +1681,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/directory_registrations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/directory_registrations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.DirectoryRegistrationArn') as directory_registration_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::PCAConnectorAD::DirectoryRegistration' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'DirectoryRegistrationArn') as directory_registration_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::PCAConnectorAD::DirectoryRegistration' - AND region = 'us-east-1' - directory_registration: - name: directory_registration - id: aws.pcaconnectorad.directory_registration - x-cfn-schema-name: DirectoryRegistration - x-cfn-type-name: AWS::PCAConnectorAD::DirectoryRegistration - x-identifiers: - - DirectoryRegistrationArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1738,12 +1694,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/directory_registrations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/directory_registrations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/directory_registration/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/directory_registrations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1755,17 +1715,33 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'DirectoryId') as directory_id, - json_extract_path_text(Properties, 'DirectoryRegistrationArn') as directory_registration_arn, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::PCAConnectorAD::DirectoryRegistration' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.DirectoryRegistrationArn') as directory_registration_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::PCAConnectorAD::DirectoryRegistration' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DirectoryId') as directory_id, + json_extract_path_text(Properties, 'DirectoryRegistrationArn') as directory_registration_arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::PCAConnectorAD::DirectoryRegistration' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DirectoryRegistrationArn') as directory_registration_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::PCAConnectorAD::DirectoryRegistration' + AND region = 'us-east-1' service_principal_names: name: service_principal_names id: aws.pcaconnectorad.service_principal_names @@ -1774,7 +1750,7 @@ components: x-identifiers: - ConnectorArn - DirectoryRegistrationArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1808,42 +1784,11 @@ components: - $ref: '#/components/x-stackQL-resources/service_principal_names/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/service_principal_names/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ConnectorArn') as connector_arn, - JSON_EXTRACT(Properties, '$.DirectoryRegistrationArn') as directory_registration_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::PCAConnectorAD::ServicePrincipalName' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ConnectorArn') as connector_arn, - json_extract_path_text(Properties, 'DirectoryRegistrationArn') as directory_registration_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::PCAConnectorAD::ServicePrincipalName' - AND region = 'us-east-1' - service_principal_name: - name: service_principal_name - id: aws.pcaconnectorad.service_principal_name - x-cfn-schema-name: ServicePrincipalName - x-cfn-type-name: AWS::PCAConnectorAD::ServicePrincipalName - x-identifiers: - - ConnectorArn - - DirectoryRegistrationArn - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1854,16 +1799,34 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ConnectorArn') as connector_arn, - json_extract_path_text(Properties, 'DirectoryRegistrationArn') as directory_registration_arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::PCAConnectorAD::ServicePrincipalName' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.ConnectorArn') as connector_arn, + JSON_EXTRACT(Properties, '$.DirectoryRegistrationArn') as directory_registration_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::PCAConnectorAD::ServicePrincipalName' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ConnectorArn') as connector_arn, + json_extract_path_text(Properties, 'DirectoryRegistrationArn') as directory_registration_arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::PCAConnectorAD::ServicePrincipalName' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ConnectorArn') as connector_arn, + json_extract_path_text(Properties, 'DirectoryRegistrationArn') as directory_registration_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::PCAConnectorAD::ServicePrincipalName' + AND region = 'us-east-1' templates: name: templates id: aws.pcaconnectorad.templates @@ -1871,7 +1834,7 @@ components: x-cfn-type-name: AWS::PCAConnectorAD::Template x-identifiers: - TemplateArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1888,9 +1851,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1900,41 +1863,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/templates/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/templates/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.TemplateArn') as template_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::PCAConnectorAD::Template' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'TemplateArn') as template_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::PCAConnectorAD::Template' - AND region = 'us-east-1' - template: - name: template - id: aws.pcaconnectorad.template - x-cfn-schema-name: Template - x-cfn-type-name: AWS::PCAConnectorAD::Template - x-identifiers: - - TemplateArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1945,12 +1876,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/templates/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/templates/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/template/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/templates/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1965,20 +1900,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ConnectorArn') as connector_arn, - json_extract_path_text(Properties, 'Definition') as definition, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'ReenrollAllCertificateHolders') as reenroll_all_certificate_holders, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'TemplateArn') as template_arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::PCAConnectorAD::Template' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.TemplateArn') as template_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::PCAConnectorAD::Template' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ConnectorArn') as connector_arn, + json_extract_path_text(Properties, 'Definition') as definition, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'ReenrollAllCertificateHolders') as reenroll_all_certificate_holders, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'TemplateArn') as template_arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::PCAConnectorAD::Template' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'TemplateArn') as template_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::PCAConnectorAD::Template' + AND region = 'us-east-1' template_group_access_control_entries: name: template_group_access_control_entries id: aws.pcaconnectorad.template_group_access_control_entries @@ -1987,7 +1938,7 @@ components: x-identifiers: - GroupSecurityIdentifier - TemplateArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2004,9 +1955,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2016,44 +1967,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/template_group_access_control_entries/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/template_group_access_control_entries/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.GroupSecurityIdentifier') as group_security_identifier, - JSON_EXTRACT(Properties, '$.TemplateArn') as template_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::PCAConnectorAD::TemplateGroupAccessControlEntry' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'GroupSecurityIdentifier') as group_security_identifier, - json_extract_path_text(Properties, 'TemplateArn') as template_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::PCAConnectorAD::TemplateGroupAccessControlEntry' - AND region = 'us-east-1' - template_group_access_control_entry: - name: template_group_access_control_entry - id: aws.pcaconnectorad.template_group_access_control_entry - x-cfn-schema-name: TemplateGroupAccessControlEntry - x-cfn-type-name: AWS::PCAConnectorAD::TemplateGroupAccessControlEntry - x-identifiers: - - GroupSecurityIdentifier - - TemplateArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2064,12 +1980,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/template_group_access_control_entries/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/template_group_access_control_entries/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/template_group_access_control_entry/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/template_group_access_control_entries/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2082,18 +2002,36 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AccessRights') as access_rights, - json_extract_path_text(Properties, 'GroupDisplayName') as group_display_name, - json_extract_path_text(Properties, 'GroupSecurityIdentifier') as group_security_identifier, - json_extract_path_text(Properties, 'TemplateArn') as template_arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::PCAConnectorAD::TemplateGroupAccessControlEntry' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.GroupSecurityIdentifier') as group_security_identifier, + JSON_EXTRACT(Properties, '$.TemplateArn') as template_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::PCAConnectorAD::TemplateGroupAccessControlEntry' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AccessRights') as access_rights, + json_extract_path_text(Properties, 'GroupDisplayName') as group_display_name, + json_extract_path_text(Properties, 'GroupSecurityIdentifier') as group_security_identifier, + json_extract_path_text(Properties, 'TemplateArn') as template_arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::PCAConnectorAD::TemplateGroupAccessControlEntry' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'GroupSecurityIdentifier') as group_security_identifier, + json_extract_path_text(Properties, 'TemplateArn') as template_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::PCAConnectorAD::TemplateGroupAccessControlEntry' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/personalize.yaml b/providers/src/aws/v00.00.00000/services/personalize.yaml index 713f14ab..3a494ffa 100644 --- a/providers/src/aws/v00.00.00000/services/personalize.yaml +++ b/providers/src/aws/v00.00.00000/services/personalize.yaml @@ -1028,7 +1028,7 @@ components: x-cfn-type-name: AWS::Personalize::Dataset x-identifiers: - DatasetArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1045,9 +1045,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1057,41 +1057,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/datasets/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/datasets/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.DatasetArn') as dataset_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Personalize::Dataset' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'DatasetArn') as dataset_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Personalize::Dataset' - AND region = 'us-east-1' - dataset: - name: dataset - id: aws.personalize.dataset - x-cfn-schema-name: Dataset - x-cfn-type-name: AWS::Personalize::Dataset - x-identifiers: - - DatasetArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1102,12 +1070,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/datasets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/datasets/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/dataset/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/datasets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1122,20 +1094,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'DatasetArn') as dataset_arn, - json_extract_path_text(Properties, 'DatasetType') as dataset_type, - json_extract_path_text(Properties, 'DatasetGroupArn') as dataset_group_arn, - json_extract_path_text(Properties, 'SchemaArn') as schema_arn, - json_extract_path_text(Properties, 'DatasetImportJob') as dataset_import_job - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Personalize::Dataset' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.DatasetArn') as dataset_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Personalize::Dataset' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'DatasetArn') as dataset_arn, + json_extract_path_text(Properties, 'DatasetType') as dataset_type, + json_extract_path_text(Properties, 'DatasetGroupArn') as dataset_group_arn, + json_extract_path_text(Properties, 'SchemaArn') as schema_arn, + json_extract_path_text(Properties, 'DatasetImportJob') as dataset_import_job + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Personalize::Dataset' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DatasetArn') as dataset_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Personalize::Dataset' + AND region = 'us-east-1' dataset_groups: name: dataset_groups id: aws.personalize.dataset_groups @@ -1143,7 +1131,7 @@ components: x-cfn-type-name: AWS::Personalize::DatasetGroup x-identifiers: - DatasetGroupArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1177,39 +1165,11 @@ components: - $ref: '#/components/x-stackQL-resources/dataset_groups/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/dataset_groups/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.DatasetGroupArn') as dataset_group_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Personalize::DatasetGroup' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'DatasetGroupArn') as dataset_group_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Personalize::DatasetGroup' - AND region = 'us-east-1' - dataset_group: - name: dataset_group - id: aws.personalize.dataset_group - x-cfn-schema-name: DatasetGroup - x-cfn-type-name: AWS::Personalize::DatasetGroup - x-identifiers: - - DatasetGroupArn - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1223,19 +1183,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'DatasetGroupArn') as dataset_group_arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'KmsKeyArn') as kms_key_arn, - json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'Domain') as domain - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Personalize::DatasetGroup' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.DatasetGroupArn') as dataset_group_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Personalize::DatasetGroup' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DatasetGroupArn') as dataset_group_arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'KmsKeyArn') as kms_key_arn, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'Domain') as domain + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Personalize::DatasetGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DatasetGroupArn') as dataset_group_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Personalize::DatasetGroup' + AND region = 'us-east-1' schemata: name: schemata id: aws.personalize.schemata @@ -1243,7 +1219,7 @@ components: x-cfn-type-name: AWS::Personalize::Schema x-identifiers: - SchemaArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1277,39 +1253,11 @@ components: - $ref: '#/components/x-stackQL-resources/schemata/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/schemata/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.SchemaArn') as schema_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Personalize::Schema' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'SchemaArn') as schema_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Personalize::Schema' - AND region = 'us-east-1' - schema: - name: schema - id: aws.personalize.schema - x-cfn-schema-name: Schema - x-cfn-type-name: AWS::Personalize::Schema - x-identifiers: - - SchemaArn - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1322,18 +1270,34 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'SchemaArn') as schema_arn, - json_extract_path_text(Properties, 'Schema') as _schema, - json_extract_path_text(Properties, 'Domain') as domain - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Personalize::Schema' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.SchemaArn') as schema_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Personalize::Schema' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'SchemaArn') as schema_arn, + json_extract_path_text(Properties, 'Schema') as _schema, + json_extract_path_text(Properties, 'Domain') as domain + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Personalize::Schema' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'SchemaArn') as schema_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Personalize::Schema' + AND region = 'us-east-1' solutions: name: solutions id: aws.personalize.solutions @@ -1341,7 +1305,7 @@ components: x-cfn-type-name: AWS::Personalize::Solution x-identifiers: - SolutionArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1375,39 +1339,11 @@ components: - $ref: '#/components/x-stackQL-resources/solutions/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/solutions/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.SolutionArn') as solution_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Personalize::Solution' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'SolutionArn') as solution_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Personalize::Solution' - AND region = 'us-east-1' - solution: - name: solution - id: aws.personalize.solution - x-cfn-schema-name: Solution - x-cfn-type-name: AWS::Personalize::Solution - x-identifiers: - - SolutionArn - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1424,22 +1360,38 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'SolutionArn') as solution_arn, - json_extract_path_text(Properties, 'EventType') as event_type, - json_extract_path_text(Properties, 'DatasetGroupArn') as dataset_group_arn, - json_extract_path_text(Properties, 'PerformAutoML') as perform_auto_ml, - json_extract_path_text(Properties, 'PerformHPO') as perform_hpo, - json_extract_path_text(Properties, 'RecipeArn') as recipe_arn, - json_extract_path_text(Properties, 'SolutionConfig') as solution_config - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Personalize::Solution' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.SolutionArn') as solution_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Personalize::Solution' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'SolutionArn') as solution_arn, + json_extract_path_text(Properties, 'EventType') as event_type, + json_extract_path_text(Properties, 'DatasetGroupArn') as dataset_group_arn, + json_extract_path_text(Properties, 'PerformAutoML') as perform_auto_ml, + json_extract_path_text(Properties, 'PerformHPO') as perform_hpo, + json_extract_path_text(Properties, 'RecipeArn') as recipe_arn, + json_extract_path_text(Properties, 'SolutionConfig') as solution_config + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Personalize::Solution' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'SolutionArn') as solution_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Personalize::Solution' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/pinpoint.yaml b/providers/src/aws/v00.00.00000/services/pinpoint.yaml index fb45eb4f..1f3894ac 100644 --- a/providers/src/aws/v00.00.00000/services/pinpoint.yaml +++ b/providers/src/aws/v00.00.00000/services/pinpoint.yaml @@ -583,7 +583,7 @@ components: x-cfn-type-name: AWS::Pinpoint::InAppTemplate x-identifiers: - TemplateName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -600,9 +600,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -612,41 +612,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/in_app_templates/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/in_app_templates/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.TemplateName') as template_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Pinpoint::InAppTemplate' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'TemplateName') as template_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Pinpoint::InAppTemplate' - AND region = 'us-east-1' - in_app_template: - name: in_app_template - id: aws.pinpoint.in_app_template - x-cfn-schema-name: InAppTemplate - x-cfn-type-name: AWS::Pinpoint::InAppTemplate - x-identifiers: - - TemplateName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -657,12 +625,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/in_app_templates/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/in_app_templates/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/in_app_template/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/in_app_templates/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -678,21 +650,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Content') as content, - json_extract_path_text(Properties, 'CustomConfig') as custom_config, - json_extract_path_text(Properties, 'Layout') as layout, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'TemplateDescription') as template_description, - json_extract_path_text(Properties, 'TemplateName') as template_name - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Pinpoint::InAppTemplate' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.TemplateName') as template_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Pinpoint::InAppTemplate' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Content') as content, + json_extract_path_text(Properties, 'CustomConfig') as custom_config, + json_extract_path_text(Properties, 'Layout') as layout, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'TemplateDescription') as template_description, + json_extract_path_text(Properties, 'TemplateName') as template_name + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Pinpoint::InAppTemplate' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'TemplateName') as template_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Pinpoint::InAppTemplate' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/pipes.yaml b/providers/src/aws/v00.00.00000/services/pipes.yaml index 796f82e0..0900be83 100644 --- a/providers/src/aws/v00.00.00000/services/pipes.yaml +++ b/providers/src/aws/v00.00.00000/services/pipes.yaml @@ -534,6 +534,28 @@ components: minLength: 1 pattern: ^arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-]+):([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1})?:(\d{12})?:(.+)$ additionalProperties: false + DimensionMapping: + type: object + properties: + DimensionValue: + type: string + maxLength: 2048 + minLength: 1 + DimensionValueType: + $ref: '#/components/schemas/DimensionValueType' + DimensionName: + type: string + maxLength: 256 + minLength: 1 + required: + - DimensionName + - DimensionValue + - DimensionValueType + additionalProperties: false + DimensionValueType: + type: string + enum: + - VARCHAR DynamoDBStreamStartPosition: type: string enum: @@ -653,6 +675,13 @@ components: minLength: 1 pattern: ^arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-]+):([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1})?:(\d{12})?:(.+)|(\$(\.[\w/_-]+(\[(\d+|\*)\])*)*)$ additionalProperties: false + EpochTimeUnit: + type: string + enum: + - MILLISECONDS + - SECONDS + - MICROSECONDS + - NANOSECONDS Filter: type: object properties: @@ -757,6 +786,49 @@ components: enum: - TRIM_HORIZON - LATEST + MeasureValueType: + type: string + enum: + - DOUBLE + - BIGINT + - VARCHAR + - BOOLEAN + - TIMESTAMP + MultiMeasureAttributeMapping: + type: object + properties: + MeasureValue: + type: string + maxLength: 2048 + minLength: 1 + MeasureValueType: + $ref: '#/components/schemas/MeasureValueType' + MultiMeasureAttributeName: + type: string + maxLength: 256 + minLength: 1 + required: + - MeasureValue + - MeasureValueType + - MultiMeasureAttributeName + additionalProperties: false + MultiMeasureMapping: + type: object + properties: + MultiMeasureName: + type: string + maxLength: 256 + minLength: 1 + MultiMeasureAttributeMappings: + type: array + items: + $ref: '#/components/schemas/MultiMeasureAttributeMapping' + maxItems: 256 + minItems: 1 + required: + - MultiMeasureAttributeMappings + - MultiMeasureName + additionalProperties: false NetworkConfiguration: type: object properties: @@ -1237,6 +1309,8 @@ components: $ref: '#/components/schemas/PipeTargetEventBridgeEventBusParameters' CloudWatchLogsParameters: $ref: '#/components/schemas/PipeTargetCloudWatchLogsParameters' + TimestreamParameters: + $ref: '#/components/schemas/PipeTargetTimestreamParameters' additionalProperties: false PipeTargetRedshiftDataParameters: type: object @@ -1307,6 +1381,48 @@ components: InvocationType: $ref: '#/components/schemas/PipeTargetInvocationType' additionalProperties: false + PipeTargetTimestreamParameters: + type: object + properties: + TimeValue: + type: string + maxLength: 256 + minLength: 1 + EpochTimeUnit: + $ref: '#/components/schemas/EpochTimeUnit' + TimeFieldType: + $ref: '#/components/schemas/TimeFieldType' + TimestampFormat: + type: string + maxLength: 256 + minLength: 1 + VersionValue: + type: string + maxLength: 256 + minLength: 1 + DimensionMappings: + type: array + items: + $ref: '#/components/schemas/DimensionMapping' + maxItems: 128 + minItems: 1 + SingleMeasureMappings: + type: array + items: + $ref: '#/components/schemas/SingleMeasureMapping' + maxItems: 8192 + minItems: 0 + MultiMeasureMappings: + type: array + items: + $ref: '#/components/schemas/MultiMeasureMapping' + maxItems: 1024 + minItems: 0 + required: + - DimensionMappings + - TimeValue + - VersionValue + additionalProperties: false PlacementConstraint: type: object properties: @@ -1469,6 +1585,24 @@ components: enum: - TRIM_HORIZON - LATEST + SingleMeasureMapping: + type: object + properties: + MeasureValue: + type: string + maxLength: 2048 + minLength: 1 + MeasureValueType: + $ref: '#/components/schemas/MeasureValueType' + MeasureName: + type: string + maxLength: 1024 + minLength: 1 + required: + - MeasureName + - MeasureValue + - MeasureValueType + additionalProperties: false Tag: type: object properties: @@ -1494,6 +1628,11 @@ components: maxLength: 256 minLength: 0 additionalProperties: false + TimeFieldType: + type: string + enum: + - EPOCH + - TIMESTAMP_FORMAT Pipe: type: object properties: @@ -1741,7 +1880,7 @@ components: x-cfn-type-name: AWS::Pipes::Pipe x-identifiers: - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1758,9 +1897,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1770,41 +1909,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/pipes/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/pipes/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Pipes::Pipe' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Pipes::Pipe' - AND region = 'us-east-1' - pipe: - name: pipe - id: aws.pipes.pipe - x-cfn-schema-name: Pipe - x-cfn-type-name: AWS::Pipes::Pipe - x-identifiers: - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1815,12 +1922,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/pipes/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/pipes/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/pipe/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/pipes/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1846,31 +1957,47 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'CreationTime') as creation_time, - json_extract_path_text(Properties, 'CurrentState') as current_state, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'DesiredState') as desired_state, - json_extract_path_text(Properties, 'Enrichment') as enrichment, - json_extract_path_text(Properties, 'EnrichmentParameters') as enrichment_parameters, - json_extract_path_text(Properties, 'LastModifiedTime') as last_modified_time, - json_extract_path_text(Properties, 'LogConfiguration') as log_configuration, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'Source') as source, - json_extract_path_text(Properties, 'SourceParameters') as source_parameters, - json_extract_path_text(Properties, 'StateReason') as state_reason, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Target') as target, - json_extract_path_text(Properties, 'TargetParameters') as target_parameters - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Pipes::Pipe' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Pipes::Pipe' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'CreationTime') as creation_time, + json_extract_path_text(Properties, 'CurrentState') as current_state, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'DesiredState') as desired_state, + json_extract_path_text(Properties, 'Enrichment') as enrichment, + json_extract_path_text(Properties, 'EnrichmentParameters') as enrichment_parameters, + json_extract_path_text(Properties, 'LastModifiedTime') as last_modified_time, + json_extract_path_text(Properties, 'LogConfiguration') as log_configuration, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'Source') as source, + json_extract_path_text(Properties, 'SourceParameters') as source_parameters, + json_extract_path_text(Properties, 'StateReason') as state_reason, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Target') as target, + json_extract_path_text(Properties, 'TargetParameters') as target_parameters + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Pipes::Pipe' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Pipes::Pipe' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/proton.yaml b/providers/src/aws/v00.00.00000/services/proton.yaml index 1baea61a..bc346c06 100644 --- a/providers/src/aws/v00.00.00000/services/proton.yaml +++ b/providers/src/aws/v00.00.00000/services/proton.yaml @@ -878,7 +878,7 @@ components: x-cfn-type-name: AWS::Proton::EnvironmentAccountConnection x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -895,9 +895,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -907,41 +907,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/environment_account_connections/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/environment_account_connections/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Proton::EnvironmentAccountConnection' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Proton::EnvironmentAccountConnection' - AND region = 'us-east-1' - environment_account_connection: - name: environment_account_connection - id: aws.proton.environment_account_connection - x-cfn-schema-name: EnvironmentAccountConnection - x-cfn-type-name: AWS::Proton::EnvironmentAccountConnection - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -952,12 +920,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/environment_account_connections/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/environment_account_connections/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/environment_account_connection/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/environment_account_connections/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -976,24 +948,40 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'CodebuildRoleArn') as codebuild_role_arn, - json_extract_path_text(Properties, 'ComponentRoleArn') as component_role_arn, - json_extract_path_text(Properties, 'EnvironmentAccountId') as environment_account_id, - json_extract_path_text(Properties, 'EnvironmentName') as environment_name, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'ManagementAccountId') as management_account_id, - json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Proton::EnvironmentAccountConnection' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Proton::EnvironmentAccountConnection' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'CodebuildRoleArn') as codebuild_role_arn, + json_extract_path_text(Properties, 'ComponentRoleArn') as component_role_arn, + json_extract_path_text(Properties, 'EnvironmentAccountId') as environment_account_id, + json_extract_path_text(Properties, 'EnvironmentName') as environment_name, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'ManagementAccountId') as management_account_id, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Proton::EnvironmentAccountConnection' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Proton::EnvironmentAccountConnection' + AND region = 'us-east-1' environment_templates: name: environment_templates id: aws.proton.environment_templates @@ -1001,7 +989,7 @@ components: x-cfn-type-name: AWS::Proton::EnvironmentTemplate x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1018,9 +1006,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1030,41 +1018,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/environment_templates/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/environment_templates/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Proton::EnvironmentTemplate' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Proton::EnvironmentTemplate' - AND region = 'us-east-1' - environment_template: - name: environment_template - id: aws.proton.environment_template - x-cfn-schema-name: EnvironmentTemplate - x-cfn-type-name: AWS::Proton::EnvironmentTemplate - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1075,12 +1031,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/environment_templates/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/environment_templates/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/environment_template/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/environment_templates/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1096,21 +1056,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'DisplayName') as display_name, - json_extract_path_text(Properties, 'EncryptionKey') as encryption_key, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Provisioning') as provisioning, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Proton::EnvironmentTemplate' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Proton::EnvironmentTemplate' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'DisplayName') as display_name, + json_extract_path_text(Properties, 'EncryptionKey') as encryption_key, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Provisioning') as provisioning, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Proton::EnvironmentTemplate' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Proton::EnvironmentTemplate' + AND region = 'us-east-1' service_templates: name: service_templates id: aws.proton.service_templates @@ -1118,7 +1094,7 @@ components: x-cfn-type-name: AWS::Proton::ServiceTemplate x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1135,9 +1111,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1147,41 +1123,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/service_templates/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/service_templates/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Proton::ServiceTemplate' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Proton::ServiceTemplate' - AND region = 'us-east-1' - service_template: - name: service_template - id: aws.proton.service_template - x-cfn-schema-name: ServiceTemplate - x-cfn-type-name: AWS::Proton::ServiceTemplate - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1192,12 +1136,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/service_templates/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/service_templates/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/service_template/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/service_templates/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1213,21 +1161,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'DisplayName') as display_name, - json_extract_path_text(Properties, 'EncryptionKey') as encryption_key, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'PipelineProvisioning') as pipeline_provisioning, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Proton::ServiceTemplate' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Proton::ServiceTemplate' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'DisplayName') as display_name, + json_extract_path_text(Properties, 'EncryptionKey') as encryption_key, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'PipelineProvisioning') as pipeline_provisioning, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Proton::ServiceTemplate' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Proton::ServiceTemplate' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/qbusiness.yaml b/providers/src/aws/v00.00.00000/services/qbusiness.yaml new file mode 100644 index 00000000..cc67d421 --- /dev/null +++ b/providers/src/aws/v00.00.00000/services/qbusiness.yaml @@ -0,0 +1,3061 @@ +openapi: 3.0.0 +info: + title: QBusiness + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) +components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + schemas: + ApplicationStatus: + type: string + enum: + - CREATING + - ACTIVE + - DELETING + - FAILED + - UPDATING + AttachmentsConfiguration: + type: object + properties: + AttachmentsControlMode: + $ref: '#/components/schemas/AttachmentsControlMode' + required: + - AttachmentsControlMode + additionalProperties: false + AttachmentsControlMode: + type: string + enum: + - ENABLED + - DISABLED + EncryptionConfiguration: + type: object + properties: + KmsKeyId: + type: string + maxLength: 2048 + minLength: 1 + additionalProperties: false + Tag: + type: object + properties: + Key: + type: string + maxLength: 128 + minLength: 1 + Value: + type: string + maxLength: 256 + minLength: 0 + required: + - Key + - Value + additionalProperties: false + Application: + type: object + properties: + ApplicationArn: + type: string + maxLength: 1284 + minLength: 0 + pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$ + ApplicationId: + type: string + maxLength: 36 + minLength: 36 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$ + AttachmentsConfiguration: + $ref: '#/components/schemas/AttachmentsConfiguration' + CreatedAt: + type: string + format: date-time + Description: + type: string + maxLength: 1000 + minLength: 0 + pattern: ^[\s\S]*$ + DisplayName: + type: string + maxLength: 1000 + minLength: 1 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$ + EncryptionConfiguration: + $ref: '#/components/schemas/EncryptionConfiguration' + IdentityCenterApplicationArn: + type: string + maxLength: 1224 + minLength: 10 + pattern: ^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}$ + IdentityCenterInstanceArn: + type: string + maxLength: 1224 + minLength: 10 + pattern: ^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}$ + RoleArn: + type: string + maxLength: 1284 + minLength: 0 + pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$ + Status: + $ref: '#/components/schemas/ApplicationStatus' + Tags: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + UpdatedAt: + type: string + format: date-time + required: + - DisplayName + x-stackql-resource-name: application + description: Definition of AWS::QBusiness::Application Resource Type + x-type-name: AWS::QBusiness::Application + x-stackql-primary-identifier: + - ApplicationId + x-create-only-properties: + - EncryptionConfiguration + x-write-only-properties: + - IdentityCenterInstanceArn + x-read-only-properties: + - ApplicationArn + - ApplicationId + - CreatedAt + - IdentityCenterApplicationArn + - Status + - UpdatedAt + x-required-properties: + - DisplayName + x-tagging: + taggable: true + x-required-permissions: + create: + - iam:PassRole + - kms:CreateGrant + - kms:DescribeKey + - qbusiness:CreateApplication + - qbusiness:GetApplication + - qbusiness:ListTagsForResource + - qbusiness:TagResource + - sso:CreateApplication + - sso:DeleteApplication + - sso:PutApplicationAccessScope + - sso:PutApplicationAuthenticationMethod + - sso:PutApplicationGrant + read: + - qbusiness:GetApplication + - qbusiness:ListTagsForResource + update: + - iam:PassRole + - qbusiness:GetApplication + - qbusiness:ListTagsForResource + - qbusiness:TagResource + - qbusiness:UntagResource + - qbusiness:UpdateApplication + - sso:CreateApplication + - sso:DeleteApplication + - sso:PutApplicationAccessScope + - sso:PutApplicationAuthenticationMethod + - sso:PutApplicationGrant + delete: + - kms:RetireGrant + - qbusiness:DeleteApplication + - qbusiness:GetApplication + - sso:DeleteApplication + list: + - qbusiness:ListApplications + AttributeValueOperator: + type: string + enum: + - DELETE + DataSourceStatus: + type: string + enum: + - PENDING_CREATION + - CREATING + - ACTIVE + - DELETING + - FAILED + - UPDATING + DataSourceVpcConfiguration: + type: object + properties: + SubnetIds: + type: array + x-insertionOrder: false + items: + type: string + maxLength: 200 + minLength: 1 + pattern: ^[-0-9a-zA-Z]+$ + SecurityGroupIds: + type: array + x-insertionOrder: false + items: + type: string + maxLength: 200 + minLength: 1 + pattern: ^[-0-9a-zA-Z]+$ + maxItems: 10 + minItems: 1 + required: + - SecurityGroupIds + - SubnetIds + additionalProperties: false + DocumentAttributeCondition: + type: object + properties: + Key: + type: string + maxLength: 200 + minLength: 1 + pattern: ^[a-zA-Z0-9_][a-zA-Z0-9_-]*$ + Operator: + $ref: '#/components/schemas/DocumentEnrichmentConditionOperator' + Value: + $ref: '#/components/schemas/DocumentAttributeValue' + required: + - Key + - Operator + additionalProperties: false + DocumentAttributeTarget: + type: object + properties: + Key: + type: string + maxLength: 200 + minLength: 1 + pattern: ^[a-zA-Z0-9_][a-zA-Z0-9_-]*$ + Value: + $ref: '#/components/schemas/DocumentAttributeValue' + AttributeValueOperator: + $ref: '#/components/schemas/AttributeValueOperator' + required: + - Key + additionalProperties: false + DocumentAttributeValue: + oneOf: + - type: object + title: StringValue + properties: + StringValue: + type: string + maxLength: 2048 + required: + - StringValue + additionalProperties: false + - type: object + title: StringListValue + properties: + StringListValue: + type: array + x-insertionOrder: true + items: + type: string + maxLength: 2048 + minLength: 1 + required: + - StringListValue + additionalProperties: false + - type: object + title: LongValue + properties: + LongValue: + type: number + required: + - LongValue + additionalProperties: false + - type: object + title: DateValue + properties: + DateValue: + type: string + format: date-time + required: + - DateValue + additionalProperties: false + DocumentContentOperator: + type: string + enum: + - DELETE + DocumentEnrichmentConditionOperator: + type: string + enum: + - GREATER_THAN + - GREATER_THAN_OR_EQUALS + - LESS_THAN + - LESS_THAN_OR_EQUALS + - EQUALS + - NOT_EQUALS + - CONTAINS + - NOT_CONTAINS + - EXISTS + - NOT_EXISTS + - BEGINS_WITH + DocumentEnrichmentConfiguration: + type: object + properties: + InlineConfigurations: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/InlineDocumentEnrichmentConfiguration' + maxItems: 100 + minItems: 1 + PreExtractionHookConfiguration: + $ref: '#/components/schemas/HookConfiguration' + PostExtractionHookConfiguration: + $ref: '#/components/schemas/HookConfiguration' + additionalProperties: false + HookConfiguration: + type: object + properties: + InvocationCondition: + $ref: '#/components/schemas/DocumentAttributeCondition' + LambdaArn: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^arn:aws[a-zA-Z-]*:lambda:[a-z-]*-[0-9]:[0-9]{12}:function:[a-zA-Z0-9-_]+(/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})?(:[a-zA-Z0-9-_]+)?$ + S3BucketName: + type: string + maxLength: 63 + minLength: 1 + pattern: ^[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]$ + RoleArn: + type: string + maxLength: 1284 + minLength: 0 + pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$ + additionalProperties: false + InlineDocumentEnrichmentConfiguration: + type: object + properties: + Condition: + $ref: '#/components/schemas/DocumentAttributeCondition' + Target: + $ref: '#/components/schemas/DocumentAttributeTarget' + DocumentContentOperator: + $ref: '#/components/schemas/DocumentContentOperator' + additionalProperties: false + DataSource: + type: object + properties: + ApplicationId: + type: string + maxLength: 36 + minLength: 36 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$ + Configuration: {} + CreatedAt: + type: string + format: date-time + DataSourceArn: + type: string + maxLength: 1284 + minLength: 0 + pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$ + DataSourceId: + type: string + maxLength: 36 + minLength: 36 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$ + Description: + type: string + maxLength: 1000 + minLength: 0 + pattern: ^[\s\S]*$ + DisplayName: + type: string + maxLength: 1000 + minLength: 1 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$ + DocumentEnrichmentConfiguration: + $ref: '#/components/schemas/DocumentEnrichmentConfiguration' + IndexId: + type: string + maxLength: 36 + minLength: 36 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$ + RoleArn: + type: string + maxLength: 1284 + minLength: 0 + pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$ + Status: + $ref: '#/components/schemas/DataSourceStatus' + SyncSchedule: + type: string + maxLength: 998 + pattern: ^[\s\S]*$ + Tags: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + Type: + type: string + maxLength: 2048 + minLength: 1 + UpdatedAt: + type: string + format: date-time + VpcConfiguration: + $ref: '#/components/schemas/DataSourceVpcConfiguration' + required: + - ApplicationId + - IndexId + - Configuration + - DisplayName + x-stackql-resource-name: data_source + description: Definition of AWS::QBusiness::DataSource Resource Type + x-type-name: AWS::QBusiness::DataSource + x-stackql-primary-identifier: + - ApplicationId + - DataSourceId + - IndexId + x-create-only-properties: + - ApplicationId + - IndexId + x-read-only-properties: + - CreatedAt + - DataSourceArn + - DataSourceId + - Status + - Type + - UpdatedAt + x-required-properties: + - ApplicationId + - IndexId + - Configuration + - DisplayName + x-tagging: + taggable: true + x-required-permissions: + create: + - iam:PassRole + - qbusiness:CreateDataSource + - qbusiness:GetDataSource + - qbusiness:ListTagsForResource + - qbusiness:TagResource + read: + - qbusiness:GetDataSource + - qbusiness:ListTagsForResource + update: + - iam:PassRole + - qbusiness:GetDataSource + - qbusiness:ListTagsForResource + - qbusiness:TagResource + - qbusiness:UntagResource + - qbusiness:UpdateDataSource + delete: + - qbusiness:DeleteDataSource + - qbusiness:GetDataSource + list: + - qbusiness:ListDataSources + AttributeType: + type: string + enum: + - STRING + - STRING_LIST + - NUMBER + - DATE + DocumentAttributeConfiguration: + type: object + properties: + Name: + type: string + maxLength: 30 + minLength: 1 + pattern: ^[a-zA-Z0-9_][a-zA-Z0-9_-]*$ + Type: + $ref: '#/components/schemas/AttributeType' + Search: + $ref: '#/components/schemas/Status' + additionalProperties: false + IndexCapacityConfiguration: + type: object + properties: + Units: + type: number + minimum: 1 + additionalProperties: false + IndexStatistics: + type: object + properties: + TextDocumentStatistics: + $ref: '#/components/schemas/TextDocumentStatistics' + additionalProperties: false + IndexStatus: + type: string + enum: + - CREATING + - ACTIVE + - DELETING + - FAILED + - UPDATING + IndexType: + type: string + enum: + - ENTERPRISE + - STARTER + Status: + type: string + enum: + - ENABLED + - DISABLED + TextDocumentStatistics: + type: object + properties: + IndexedTextBytes: + type: number + minimum: 0 + IndexedTextDocumentCount: + type: number + minimum: 0 + additionalProperties: false + Index: + type: object + properties: + ApplicationId: + type: string + maxLength: 36 + minLength: 36 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$ + CapacityConfiguration: + $ref: '#/components/schemas/IndexCapacityConfiguration' + CreatedAt: + type: string + format: date-time + Description: + type: string + maxLength: 1000 + minLength: 0 + pattern: ^[\s\S]*$ + DisplayName: + type: string + maxLength: 1000 + minLength: 1 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$ + DocumentAttributeConfigurations: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/DocumentAttributeConfiguration' + maxItems: 500 + minItems: 1 + IndexArn: + type: string + maxLength: 1284 + minLength: 0 + pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$ + IndexId: + type: string + maxLength: 36 + minLength: 36 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$ + IndexStatistics: + $ref: '#/components/schemas/IndexStatistics' + Type: + $ref: '#/components/schemas/IndexType' + Status: + $ref: '#/components/schemas/IndexStatus' + Tags: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + UpdatedAt: + type: string + format: date-time + required: + - ApplicationId + - DisplayName + x-stackql-resource-name: index + description: Definition of AWS::QBusiness::Index Resource Type + x-type-name: AWS::QBusiness::Index + x-stackql-primary-identifier: + - ApplicationId + - IndexId + x-create-only-properties: + - ApplicationId + - Type + x-read-only-properties: + - CreatedAt + - IndexArn + - IndexId + - IndexStatistics + - Status + - UpdatedAt + x-required-properties: + - ApplicationId + - DisplayName + x-tagging: + taggable: true + x-required-permissions: + create: + - qbusiness:CreateIndex + - qbusiness:GetIndex + - qbusiness:ListTagsForResource + - qbusiness:TagResource + - qbusiness:UpdateIndex + read: + - qbusiness:GetIndex + - qbusiness:ListTagsForResource + update: + - qbusiness:GetIndex + - qbusiness:ListTagsForResource + - qbusiness:TagResource + - qbusiness:UntagResource + - qbusiness:UpdateIndex + delete: + - qbusiness:DeleteIndex + - qbusiness:GetIndex + list: + - qbusiness:ListIndices + APISchema: + oneOf: + - type: object + title: Payload + properties: + Payload: + type: string + required: + - Payload + additionalProperties: false + - type: object + title: S3 + properties: + S3: + $ref: '#/components/schemas/S3' + required: + - S3 + additionalProperties: false + APISchemaType: + type: string + enum: + - OPEN_API_V3 + BasicAuthConfiguration: + type: object + properties: + SecretArn: + type: string + maxLength: 1284 + minLength: 0 + pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$ + RoleArn: + type: string + maxLength: 1284 + minLength: 0 + pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$ + required: + - RoleArn + - SecretArn + additionalProperties: false + CustomPluginConfiguration: + type: object + properties: + Description: + type: string + maxLength: 200 + minLength: 1 + ApiSchemaType: + $ref: '#/components/schemas/APISchemaType' + ApiSchema: + $ref: '#/components/schemas/APISchema' + required: + - ApiSchema + - ApiSchemaType + - Description + additionalProperties: false + NoAuthConfiguration: + type: object + additionalProperties: false + OAuth2ClientCredentialConfiguration: + type: object + properties: + SecretArn: + type: string + maxLength: 1284 + minLength: 0 + pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$ + RoleArn: + type: string + maxLength: 1284 + minLength: 0 + pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$ + required: + - RoleArn + - SecretArn + additionalProperties: false + PluginAuthConfiguration: + oneOf: + - type: object + title: BasicAuthConfiguration + properties: + BasicAuthConfiguration: + $ref: '#/components/schemas/BasicAuthConfiguration' + required: + - BasicAuthConfiguration + additionalProperties: false + - type: object + title: OAuth2ClientCredentialConfiguration + properties: + OAuth2ClientCredentialConfiguration: + $ref: '#/components/schemas/OAuth2ClientCredentialConfiguration' + required: + - OAuth2ClientCredentialConfiguration + additionalProperties: false + - type: object + title: NoAuthConfiguration + properties: + NoAuthConfiguration: + $ref: '#/components/schemas/NoAuthConfiguration' + required: + - NoAuthConfiguration + additionalProperties: false + PluginBuildStatus: + type: string + enum: + - READY + - CREATE_IN_PROGRESS + - CREATE_FAILED + - UPDATE_IN_PROGRESS + - UPDATE_FAILED + - DELETE_IN_PROGRESS + - DELETE_FAILED + PluginState: + type: string + enum: + - ENABLED + - DISABLED + PluginType: + type: string + enum: + - SERVICE_NOW + - SALESFORCE + - JIRA + - ZENDESK + - CUSTOM + S3: + type: object + properties: + Bucket: + type: string + maxLength: 63 + minLength: 1 + pattern: ^[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]$ + Key: + type: string + maxLength: 1024 + minLength: 1 + required: + - Bucket + - Key + additionalProperties: false + Plugin: + type: object + properties: + ApplicationId: + type: string + maxLength: 36 + minLength: 36 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$ + AuthConfiguration: + $ref: '#/components/schemas/PluginAuthConfiguration' + BuildStatus: + $ref: '#/components/schemas/PluginBuildStatus' + CreatedAt: + type: string + format: date-time + CustomPluginConfiguration: + $ref: '#/components/schemas/CustomPluginConfiguration' + DisplayName: + type: string + maxLength: 100 + minLength: 1 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$ + PluginArn: + type: string + maxLength: 1284 + minLength: 0 + pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$ + PluginId: + type: string + maxLength: 36 + minLength: 36 + pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ + ServerUrl: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^(https?|ftp|file)://([^\s]*)$ + State: + $ref: '#/components/schemas/PluginState' + Tags: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + Type: + $ref: '#/components/schemas/PluginType' + UpdatedAt: + type: string + format: date-time + required: + - ApplicationId + - AuthConfiguration + - DisplayName + - Type + x-stackql-resource-name: plugin + description: Definition of AWS::QBusiness::Plugin Resource Type + x-type-name: AWS::QBusiness::Plugin + x-stackql-primary-identifier: + - ApplicationId + - PluginId + x-create-only-properties: + - ApplicationId + - Type + x-read-only-properties: + - BuildStatus + - CreatedAt + - PluginArn + - PluginId + - UpdatedAt + x-required-properties: + - ApplicationId + - AuthConfiguration + - DisplayName + - Type + x-tagging: + taggable: true + x-required-permissions: + create: + - iam:PassRole + - qbusiness:CreatePlugin + - qbusiness:GetPlugin + - qbusiness:ListTagsForResource + - qbusiness:TagResource + - qbusiness:UpdatePlugin + read: + - qbusiness:GetPlugin + - qbusiness:ListTagsForResource + update: + - iam:PassRole + - qbusiness:GetPlugin + - qbusiness:ListTagsForResource + - qbusiness:TagResource + - qbusiness:UntagResource + - qbusiness:UpdatePlugin + delete: + - qbusiness:DeletePlugin + - qbusiness:GetPlugin + list: + - qbusiness:ListPlugins + KendraIndexConfiguration: + type: object + properties: + IndexId: + type: string + maxLength: 36 + minLength: 36 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$ + required: + - IndexId + additionalProperties: false + NativeIndexConfiguration: + type: object + properties: + IndexId: + type: string + maxLength: 36 + minLength: 36 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$ + required: + - IndexId + additionalProperties: false + RetrieverConfiguration: + oneOf: + - type: object + title: NativeIndexConfiguration + properties: + NativeIndexConfiguration: + $ref: '#/components/schemas/NativeIndexConfiguration' + required: + - NativeIndexConfiguration + additionalProperties: false + - type: object + title: KendraIndexConfiguration + properties: + KendraIndexConfiguration: + $ref: '#/components/schemas/KendraIndexConfiguration' + required: + - KendraIndexConfiguration + additionalProperties: false + RetrieverStatus: + type: string + enum: + - CREATING + - ACTIVE + - FAILED + RetrieverType: + type: string + enum: + - NATIVE_INDEX + - KENDRA_INDEX + Retriever: + type: object + properties: + ApplicationId: + type: string + maxLength: 36 + minLength: 36 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$ + Configuration: + $ref: '#/components/schemas/RetrieverConfiguration' + CreatedAt: + type: string + format: date-time + DisplayName: + type: string + maxLength: 1000 + minLength: 1 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$ + RetrieverArn: + type: string + maxLength: 1284 + minLength: 0 + pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$ + RetrieverId: + type: string + maxLength: 36 + minLength: 36 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$ + RoleArn: + type: string + maxLength: 1284 + minLength: 0 + pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$ + Status: + $ref: '#/components/schemas/RetrieverStatus' + Tags: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + Type: + $ref: '#/components/schemas/RetrieverType' + UpdatedAt: + type: string + format: date-time + required: + - ApplicationId + - Configuration + - DisplayName + - Type + x-stackql-resource-name: retriever + description: Definition of AWS::QBusiness::Retriever Resource Type + x-type-name: AWS::QBusiness::Retriever + x-stackql-primary-identifier: + - ApplicationId + - RetrieverId + x-create-only-properties: + - ApplicationId + - Type + x-read-only-properties: + - CreatedAt + - RetrieverArn + - RetrieverId + - Status + - UpdatedAt + x-required-properties: + - ApplicationId + - Configuration + - DisplayName + - Type + x-tagging: + taggable: true + x-required-permissions: + create: + - iam:PassRole + - qbusiness:CreateRetriever + - qbusiness:GetRetriever + - qbusiness:ListTagsForResource + - qbusiness:TagResource + read: + - qbusiness:GetRetriever + - qbusiness:ListTagsForResource + update: + - iam:PassRole + - qbusiness:GetRetriever + - qbusiness:ListTagsForResource + - qbusiness:TagResource + - qbusiness:UntagResource + - qbusiness:UpdateRetriever + delete: + - qbusiness:DeleteRetriever + - qbusiness:GetRetriever + list: + - qbusiness:ListRetrievers + WebExperienceSamplePromptsControlMode: + type: string + enum: + - ENABLED + - DISABLED + WebExperienceStatus: + type: string + enum: + - CREATING + - ACTIVE + - DELETING + - FAILED + - PENDING_AUTH_CONFIG + WebExperience: + type: object + properties: + ApplicationId: + type: string + maxLength: 36 + minLength: 36 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$ + CreatedAt: + type: string + format: date-time + DefaultEndpoint: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^(https?|ftp|file)://([^\s]*)$ + RoleArn: + type: string + maxLength: 1284 + minLength: 0 + pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$ + SamplePromptsControlMode: + $ref: '#/components/schemas/WebExperienceSamplePromptsControlMode' + Status: + $ref: '#/components/schemas/WebExperienceStatus' + Subtitle: + type: string + maxLength: 500 + minLength: 0 + pattern: ^[\s\S]*$ + Tags: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + Title: + type: string + maxLength: 500 + minLength: 0 + pattern: ^[\s\S]*$ + UpdatedAt: + type: string + format: date-time + WebExperienceArn: + type: string + maxLength: 1284 + minLength: 0 + pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$ + WebExperienceId: + type: string + maxLength: 36 + minLength: 36 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$ + WelcomeMessage: + type: string + maxLength: 300 + minLength: 0 + required: + - ApplicationId + x-stackql-resource-name: web_experience + description: Definition of AWS::QBusiness::WebExperience Resource Type + x-type-name: AWS::QBusiness::WebExperience + x-stackql-primary-identifier: + - ApplicationId + - WebExperienceId + x-create-only-properties: + - ApplicationId + x-read-only-properties: + - CreatedAt + - DefaultEndpoint + - Status + - UpdatedAt + - WebExperienceArn + - WebExperienceId + x-required-properties: + - ApplicationId + x-tagging: + taggable: true + x-required-permissions: + create: + - iam:PassRole + - qbusiness:CreateWebExperience + - qbusiness:GetWebExperience + - qbusiness:ListTagsForResource + - qbusiness:TagResource + - sso:PutApplicationGrant + - sso:UpdateApplication + read: + - qbusiness:GetWebExperience + - qbusiness:ListTagsForResource + update: + - iam:PassRole + - qbusiness:GetWebExperience + - qbusiness:ListTagsForResource + - qbusiness:TagResource + - qbusiness:UntagResource + - qbusiness:UpdateWebExperience + - sso:PutApplicationGrant + - sso:UpdateApplication + delete: + - qbusiness:DeleteWebExperience + - qbusiness:GetWebExperience + list: + - qbusiness:ListWebExperiences + CreateApplicationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ApplicationArn: + type: string + maxLength: 1284 + minLength: 0 + pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$ + ApplicationId: + type: string + maxLength: 36 + minLength: 36 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$ + AttachmentsConfiguration: + $ref: '#/components/schemas/AttachmentsConfiguration' + CreatedAt: + type: string + format: date-time + Description: + type: string + maxLength: 1000 + minLength: 0 + pattern: ^[\s\S]*$ + DisplayName: + type: string + maxLength: 1000 + minLength: 1 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$ + EncryptionConfiguration: + $ref: '#/components/schemas/EncryptionConfiguration' + IdentityCenterApplicationArn: + type: string + maxLength: 1224 + minLength: 10 + pattern: ^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}$ + IdentityCenterInstanceArn: + type: string + maxLength: 1224 + minLength: 10 + pattern: ^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}$ + RoleArn: + type: string + maxLength: 1284 + minLength: 0 + pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$ + Status: + $ref: '#/components/schemas/ApplicationStatus' + Tags: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + UpdatedAt: + type: string + format: date-time + x-stackQL-stringOnly: true + x-title: CreateApplicationRequest + type: object + required: [] + CreateDataSourceRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ApplicationId: + type: string + maxLength: 36 + minLength: 36 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$ + Configuration: {} + CreatedAt: + type: string + format: date-time + DataSourceArn: + type: string + maxLength: 1284 + minLength: 0 + pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$ + DataSourceId: + type: string + maxLength: 36 + minLength: 36 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$ + Description: + type: string + maxLength: 1000 + minLength: 0 + pattern: ^[\s\S]*$ + DisplayName: + type: string + maxLength: 1000 + minLength: 1 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$ + DocumentEnrichmentConfiguration: + $ref: '#/components/schemas/DocumentEnrichmentConfiguration' + IndexId: + type: string + maxLength: 36 + minLength: 36 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$ + RoleArn: + type: string + maxLength: 1284 + minLength: 0 + pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$ + Status: + $ref: '#/components/schemas/DataSourceStatus' + SyncSchedule: + type: string + maxLength: 998 + pattern: ^[\s\S]*$ + Tags: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + Type: + type: string + maxLength: 2048 + minLength: 1 + UpdatedAt: + type: string + format: date-time + VpcConfiguration: + $ref: '#/components/schemas/DataSourceVpcConfiguration' + x-stackQL-stringOnly: true + x-title: CreateDataSourceRequest + type: object + required: [] + CreateIndexRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ApplicationId: + type: string + maxLength: 36 + minLength: 36 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$ + CapacityConfiguration: + $ref: '#/components/schemas/IndexCapacityConfiguration' + CreatedAt: + type: string + format: date-time + Description: + type: string + maxLength: 1000 + minLength: 0 + pattern: ^[\s\S]*$ + DisplayName: + type: string + maxLength: 1000 + minLength: 1 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$ + DocumentAttributeConfigurations: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/DocumentAttributeConfiguration' + maxItems: 500 + minItems: 1 + IndexArn: + type: string + maxLength: 1284 + minLength: 0 + pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$ + IndexId: + type: string + maxLength: 36 + minLength: 36 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$ + IndexStatistics: + $ref: '#/components/schemas/IndexStatistics' + Type: + $ref: '#/components/schemas/IndexType' + Status: + $ref: '#/components/schemas/IndexStatus' + Tags: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + UpdatedAt: + type: string + format: date-time + x-stackQL-stringOnly: true + x-title: CreateIndexRequest + type: object + required: [] + CreatePluginRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ApplicationId: + type: string + maxLength: 36 + minLength: 36 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$ + AuthConfiguration: + $ref: '#/components/schemas/PluginAuthConfiguration' + BuildStatus: + $ref: '#/components/schemas/PluginBuildStatus' + CreatedAt: + type: string + format: date-time + CustomPluginConfiguration: + $ref: '#/components/schemas/CustomPluginConfiguration' + DisplayName: + type: string + maxLength: 100 + minLength: 1 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$ + PluginArn: + type: string + maxLength: 1284 + minLength: 0 + pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$ + PluginId: + type: string + maxLength: 36 + minLength: 36 + pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ + ServerUrl: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^(https?|ftp|file)://([^\s]*)$ + State: + $ref: '#/components/schemas/PluginState' + Tags: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + Type: + $ref: '#/components/schemas/PluginType' + UpdatedAt: + type: string + format: date-time + x-stackQL-stringOnly: true + x-title: CreatePluginRequest + type: object + required: [] + CreateRetrieverRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ApplicationId: + type: string + maxLength: 36 + minLength: 36 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$ + Configuration: + $ref: '#/components/schemas/RetrieverConfiguration' + CreatedAt: + type: string + format: date-time + DisplayName: + type: string + maxLength: 1000 + minLength: 1 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$ + RetrieverArn: + type: string + maxLength: 1284 + minLength: 0 + pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$ + RetrieverId: + type: string + maxLength: 36 + minLength: 36 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$ + RoleArn: + type: string + maxLength: 1284 + minLength: 0 + pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$ + Status: + $ref: '#/components/schemas/RetrieverStatus' + Tags: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + Type: + $ref: '#/components/schemas/RetrieverType' + UpdatedAt: + type: string + format: date-time + x-stackQL-stringOnly: true + x-title: CreateRetrieverRequest + type: object + required: [] + CreateWebExperienceRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ApplicationId: + type: string + maxLength: 36 + minLength: 36 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$ + CreatedAt: + type: string + format: date-time + DefaultEndpoint: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^(https?|ftp|file)://([^\s]*)$ + RoleArn: + type: string + maxLength: 1284 + minLength: 0 + pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$ + SamplePromptsControlMode: + $ref: '#/components/schemas/WebExperienceSamplePromptsControlMode' + Status: + $ref: '#/components/schemas/WebExperienceStatus' + Subtitle: + type: string + maxLength: 500 + minLength: 0 + pattern: ^[\s\S]*$ + Tags: + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 0 + Title: + type: string + maxLength: 500 + minLength: 0 + pattern: ^[\s\S]*$ + UpdatedAt: + type: string + format: date-time + WebExperienceArn: + type: string + maxLength: 1284 + minLength: 0 + pattern: ^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$ + WebExperienceId: + type: string + maxLength: 36 + minLength: 36 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$ + WelcomeMessage: + type: string + maxLength: 300 + minLength: 0 + x-stackQL-stringOnly: true + x-title: CreateWebExperienceRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 + x-stackQL-resources: + applications: + name: applications + id: aws.qbusiness.applications + x-cfn-schema-name: Application + x-cfn-type-name: AWS::QBusiness::Application + x-identifiers: + - ApplicationId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Application&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QBusiness::Application" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QBusiness::Application" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QBusiness::Application" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/applications/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/applications/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/applications/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.ApplicationArn') as application_arn, + JSON_EXTRACT(Properties, '$.ApplicationId') as application_id, + JSON_EXTRACT(Properties, '$.AttachmentsConfiguration') as attachments_configuration, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.DisplayName') as display_name, + JSON_EXTRACT(Properties, '$.EncryptionConfiguration') as encryption_configuration, + JSON_EXTRACT(Properties, '$.IdentityCenterApplicationArn') as identity_center_application_arn, + JSON_EXTRACT(Properties, '$.IdentityCenterInstanceArn') as identity_center_instance_arn, + JSON_EXTRACT(Properties, '$.RoleArn') as role_arn, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::QBusiness::Application' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ApplicationId') as application_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::QBusiness::Application' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ApplicationArn') as application_arn, + json_extract_path_text(Properties, 'ApplicationId') as application_id, + json_extract_path_text(Properties, 'AttachmentsConfiguration') as attachments_configuration, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'DisplayName') as display_name, + json_extract_path_text(Properties, 'EncryptionConfiguration') as encryption_configuration, + json_extract_path_text(Properties, 'IdentityCenterApplicationArn') as identity_center_application_arn, + json_extract_path_text(Properties, 'IdentityCenterInstanceArn') as identity_center_instance_arn, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'UpdatedAt') as updated_at + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::QBusiness::Application' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ApplicationId') as application_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::QBusiness::Application' + AND region = 'us-east-1' + data_sources: + name: data_sources + id: aws.qbusiness.data_sources + x-cfn-schema-name: DataSource + x-cfn-type-name: AWS::QBusiness::DataSource + x-identifiers: + - ApplicationId + - DataSourceId + - IndexId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DataSource&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QBusiness::DataSource" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QBusiness::DataSource" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QBusiness::DataSource" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/data_sources/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/data_sources/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/data_sources/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.ApplicationId') as application_id, + JSON_EXTRACT(Properties, '$.Configuration') as configuration, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.DataSourceArn') as data_source_arn, + JSON_EXTRACT(Properties, '$.DataSourceId') as data_source_id, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.DisplayName') as display_name, + JSON_EXTRACT(Properties, '$.DocumentEnrichmentConfiguration') as document_enrichment_configuration, + JSON_EXTRACT(Properties, '$.IndexId') as index_id, + JSON_EXTRACT(Properties, '$.RoleArn') as role_arn, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.SyncSchedule') as sync_schedule, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.Type') as type, + JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at, + JSON_EXTRACT(Properties, '$.VpcConfiguration') as vpc_configuration + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::QBusiness::DataSource' + AND data__Identifier = '||' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ApplicationId') as application_id, + JSON_EXTRACT(Properties, '$.DataSourceId') as data_source_id, + JSON_EXTRACT(Properties, '$.IndexId') as index_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::QBusiness::DataSource' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ApplicationId') as application_id, + json_extract_path_text(Properties, 'Configuration') as configuration, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'DataSourceArn') as data_source_arn, + json_extract_path_text(Properties, 'DataSourceId') as data_source_id, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'DisplayName') as display_name, + json_extract_path_text(Properties, 'DocumentEnrichmentConfiguration') as document_enrichment_configuration, + json_extract_path_text(Properties, 'IndexId') as index_id, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'SyncSchedule') as sync_schedule, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'UpdatedAt') as updated_at, + json_extract_path_text(Properties, 'VpcConfiguration') as vpc_configuration + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::QBusiness::DataSource' + AND data__Identifier = '||' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ApplicationId') as application_id, + json_extract_path_text(Properties, 'DataSourceId') as data_source_id, + json_extract_path_text(Properties, 'IndexId') as index_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::QBusiness::DataSource' + AND region = 'us-east-1' + indices: + name: indices + id: aws.qbusiness.indices + x-cfn-schema-name: Index + x-cfn-type-name: AWS::QBusiness::Index + x-identifiers: + - ApplicationId + - IndexId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Index&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QBusiness::Index" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QBusiness::Index" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QBusiness::Index" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/indices/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/indices/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/indices/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.ApplicationId') as application_id, + JSON_EXTRACT(Properties, '$.CapacityConfiguration') as capacity_configuration, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.DisplayName') as display_name, + JSON_EXTRACT(Properties, '$.DocumentAttributeConfigurations') as document_attribute_configurations, + JSON_EXTRACT(Properties, '$.IndexArn') as index_arn, + JSON_EXTRACT(Properties, '$.IndexId') as index_id, + JSON_EXTRACT(Properties, '$.IndexStatistics') as index_statistics, + JSON_EXTRACT(Properties, '$.Type') as type, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::QBusiness::Index' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ApplicationId') as application_id, + JSON_EXTRACT(Properties, '$.IndexId') as index_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::QBusiness::Index' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ApplicationId') as application_id, + json_extract_path_text(Properties, 'CapacityConfiguration') as capacity_configuration, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'DisplayName') as display_name, + json_extract_path_text(Properties, 'DocumentAttributeConfigurations') as document_attribute_configurations, + json_extract_path_text(Properties, 'IndexArn') as index_arn, + json_extract_path_text(Properties, 'IndexId') as index_id, + json_extract_path_text(Properties, 'IndexStatistics') as index_statistics, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'UpdatedAt') as updated_at + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::QBusiness::Index' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ApplicationId') as application_id, + json_extract_path_text(Properties, 'IndexId') as index_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::QBusiness::Index' + AND region = 'us-east-1' + plugins: + name: plugins + id: aws.qbusiness.plugins + x-cfn-schema-name: Plugin + x-cfn-type-name: AWS::QBusiness::Plugin + x-identifiers: + - ApplicationId + - PluginId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Plugin&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QBusiness::Plugin" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QBusiness::Plugin" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QBusiness::Plugin" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/plugins/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/plugins/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/plugins/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.ApplicationId') as application_id, + JSON_EXTRACT(Properties, '$.AuthConfiguration') as auth_configuration, + JSON_EXTRACT(Properties, '$.BuildStatus') as build_status, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.CustomPluginConfiguration') as custom_plugin_configuration, + JSON_EXTRACT(Properties, '$.DisplayName') as display_name, + JSON_EXTRACT(Properties, '$.PluginArn') as plugin_arn, + JSON_EXTRACT(Properties, '$.PluginId') as plugin_id, + JSON_EXTRACT(Properties, '$.ServerUrl') as server_url, + JSON_EXTRACT(Properties, '$.State') as state, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.Type') as type, + JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::QBusiness::Plugin' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ApplicationId') as application_id, + JSON_EXTRACT(Properties, '$.PluginId') as plugin_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::QBusiness::Plugin' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ApplicationId') as application_id, + json_extract_path_text(Properties, 'AuthConfiguration') as auth_configuration, + json_extract_path_text(Properties, 'BuildStatus') as build_status, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'CustomPluginConfiguration') as custom_plugin_configuration, + json_extract_path_text(Properties, 'DisplayName') as display_name, + json_extract_path_text(Properties, 'PluginArn') as plugin_arn, + json_extract_path_text(Properties, 'PluginId') as plugin_id, + json_extract_path_text(Properties, 'ServerUrl') as server_url, + json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'UpdatedAt') as updated_at + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::QBusiness::Plugin' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ApplicationId') as application_id, + json_extract_path_text(Properties, 'PluginId') as plugin_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::QBusiness::Plugin' + AND region = 'us-east-1' + retrievers: + name: retrievers + id: aws.qbusiness.retrievers + x-cfn-schema-name: Retriever + x-cfn-type-name: AWS::QBusiness::Retriever + x-identifiers: + - ApplicationId + - RetrieverId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Retriever&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QBusiness::Retriever" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QBusiness::Retriever" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QBusiness::Retriever" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/retrievers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/retrievers/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/retrievers/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.ApplicationId') as application_id, + JSON_EXTRACT(Properties, '$.Configuration') as configuration, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.DisplayName') as display_name, + JSON_EXTRACT(Properties, '$.RetrieverArn') as retriever_arn, + JSON_EXTRACT(Properties, '$.RetrieverId') as retriever_id, + JSON_EXTRACT(Properties, '$.RoleArn') as role_arn, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.Type') as type, + JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::QBusiness::Retriever' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ApplicationId') as application_id, + JSON_EXTRACT(Properties, '$.RetrieverId') as retriever_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::QBusiness::Retriever' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ApplicationId') as application_id, + json_extract_path_text(Properties, 'Configuration') as configuration, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'DisplayName') as display_name, + json_extract_path_text(Properties, 'RetrieverArn') as retriever_arn, + json_extract_path_text(Properties, 'RetrieverId') as retriever_id, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'UpdatedAt') as updated_at + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::QBusiness::Retriever' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ApplicationId') as application_id, + json_extract_path_text(Properties, 'RetrieverId') as retriever_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::QBusiness::Retriever' + AND region = 'us-east-1' + web_experiences: + name: web_experiences + id: aws.qbusiness.web_experiences + x-cfn-schema-name: WebExperience + x-cfn-type-name: AWS::QBusiness::WebExperience + x-identifiers: + - ApplicationId + - WebExperienceId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__WebExperience&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QBusiness::WebExperience" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QBusiness::WebExperience" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QBusiness::WebExperience" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/web_experiences/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/web_experiences/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/web_experiences/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.ApplicationId') as application_id, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.DefaultEndpoint') as default_endpoint, + JSON_EXTRACT(Properties, '$.RoleArn') as role_arn, + JSON_EXTRACT(Properties, '$.SamplePromptsControlMode') as sample_prompts_control_mode, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.Subtitle') as subtitle, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.Title') as title, + JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at, + JSON_EXTRACT(Properties, '$.WebExperienceArn') as web_experience_arn, + JSON_EXTRACT(Properties, '$.WebExperienceId') as web_experience_id, + JSON_EXTRACT(Properties, '$.WelcomeMessage') as welcome_message + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::QBusiness::WebExperience' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ApplicationId') as application_id, + JSON_EXTRACT(Properties, '$.WebExperienceId') as web_experience_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::QBusiness::WebExperience' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ApplicationId') as application_id, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'DefaultEndpoint') as default_endpoint, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'SamplePromptsControlMode') as sample_prompts_control_mode, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'Subtitle') as subtitle, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Title') as title, + json_extract_path_text(Properties, 'UpdatedAt') as updated_at, + json_extract_path_text(Properties, 'WebExperienceArn') as web_experience_arn, + json_extract_path_text(Properties, 'WebExperienceId') as web_experience_id, + json_extract_path_text(Properties, 'WelcomeMessage') as welcome_message + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::QBusiness::WebExperience' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ApplicationId') as application_id, + json_extract_path_text(Properties, 'WebExperienceId') as web_experience_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::QBusiness::WebExperience' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Application&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateApplication + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateApplicationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__DataSource&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateDataSource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateDataSourceRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Index&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateIndex + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateIndexRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Plugin&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreatePlugin + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreatePluginRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Retriever&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateRetriever + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateRetrieverRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__WebExperience&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateWebExperience + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateWebExperienceRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/aws/v00.00.00000/services/qldb.yaml b/providers/src/aws/v00.00.00000/services/qldb.yaml index 38ac5834..b13a3d6f 100644 --- a/providers/src/aws/v00.00.00000/services/qldb.yaml +++ b/providers/src/aws/v00.00.00000/services/qldb.yaml @@ -470,6 +470,16 @@ components: - RoleArn - KinesisConfiguration - InclusiveStartTime + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + permissions: + - qldb:TagResource + - qldb:UntagResource + - qldb:ListTagsForResource x-required-permissions: create: - iam:PassRole @@ -544,7 +554,7 @@ components: x-identifiers: - LedgerName - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -561,9 +571,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -573,44 +583,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/streams/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/streams/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.LedgerName') as ledger_name, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::QLDB::Stream' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'LedgerName') as ledger_name, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::QLDB::Stream' - AND region = 'us-east-1' - qldb_stream: - name: qldb_stream - id: aws.qldb.qldb_stream - x-cfn-schema-name: Stream - x-cfn-type-name: AWS::QLDB::Stream - x-identifiers: - - LedgerName - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -621,12 +596,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/streams/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/streams/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/qldb_stream/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/streams/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -644,23 +623,41 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'LedgerName') as ledger_name, - json_extract_path_text(Properties, 'StreamName') as stream_name, - json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'InclusiveStartTime') as inclusive_start_time, - json_extract_path_text(Properties, 'ExclusiveEndTime') as exclusive_end_time, - json_extract_path_text(Properties, 'KinesisConfiguration') as kinesis_configuration, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::QLDB::Stream' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.LedgerName') as ledger_name, + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::QLDB::Stream' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'LedgerName') as ledger_name, + json_extract_path_text(Properties, 'StreamName') as stream_name, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'InclusiveStartTime') as inclusive_start_time, + json_extract_path_text(Properties, 'ExclusiveEndTime') as exclusive_end_time, + json_extract_path_text(Properties, 'KinesisConfiguration') as kinesis_configuration, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::QLDB::Stream' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'LedgerName') as ledger_name, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::QLDB::Stream' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/quicksight.yaml b/providers/src/aws/v00.00.00000/services/quicksight.yaml index e1deb05d..f761daf3 100644 --- a/providers/src/aws/v00.00.00000/services/quicksight.yaml +++ b/providers/src/aws/v00.00.00000/services/quicksight.yaml @@ -385,2076 +385,2094 @@ components: $ref: '#/components/x-cloud-control-schemas/ProgressEvent' type: object schemas: - AggregationFunction: - type: object - properties: - NumericalAggregationFunction: - $ref: '#/components/schemas/NumericalAggregationFunction' - CategoricalAggregationFunction: - $ref: '#/components/schemas/CategoricalAggregationFunction' - DateAggregationFunction: - $ref: '#/components/schemas/DateAggregationFunction' - AttributeAggregationFunction: - $ref: '#/components/schemas/AttributeAggregationFunction' + PivotTotalOptions: additionalProperties: false - AggregationSortConfiguration: type: object properties: - Column: - $ref: '#/components/schemas/ColumnIdentifier' - SortDirection: - $ref: '#/components/schemas/SortDirection' - AggregationFunction: - $ref: '#/components/schemas/AggregationFunction' - required: - - Column - - SortDirection - additionalProperties: false - AllSheetsFilterScopeConfiguration: - type: object + TotalAggregationOptions: + minItems: 0 + maxItems: 200 + type: array + items: + $ref: '#/components/schemas/TotalAggregationOption' + CustomLabel: + type: string + ValueCellStyle: + $ref: '#/components/schemas/TableCellStyle' + ScrollStatus: + $ref: '#/components/schemas/TableTotalsScrollStatus' + Placement: + $ref: '#/components/schemas/TableTotalsPlacement' + TotalCellStyle: + $ref: '#/components/schemas/TableCellStyle' + TotalsVisibility: + $ref: '#/components/schemas/Visibility' + MetricHeaderCellStyle: + $ref: '#/components/schemas/TableCellStyle' + Entity: additionalProperties: false - AnalysisDefaults: type: object properties: - DefaultNewSheetConfiguration: - $ref: '#/components/schemas/DefaultNewSheetConfiguration' - required: - - DefaultNewSheetConfiguration + Path: + pattern: \S + type: string + DateTimePickerControlDisplayOptions: additionalProperties: false - AnalysisDefinition: type: object properties: - DataSetIdentifierDeclarations: - type: array - items: - $ref: '#/components/schemas/DataSetIdentifierDeclaration' - maxItems: 50 - minItems: 1 - Sheets: - type: array - items: - $ref: '#/components/schemas/SheetDefinition' - maxItems: 20 - minItems: 0 - CalculatedFields: - type: array - items: - $ref: '#/components/schemas/CalculatedField' - maxItems: 500 - minItems: 0 - ParameterDeclarations: - type: array - items: - $ref: '#/components/schemas/ParameterDeclaration' - maxItems: 200 - minItems: 0 - FilterGroups: - type: array - items: - $ref: '#/components/schemas/FilterGroup' - maxItems: 2000 - minItems: 0 - ColumnConfigurations: - type: array - items: - $ref: '#/components/schemas/ColumnConfiguration' - maxItems: 200 - minItems: 0 - AnalysisDefaults: - $ref: '#/components/schemas/AnalysisDefaults' - Options: - $ref: '#/components/schemas/AssetOptions' - required: - - DataSetIdentifierDeclarations - additionalProperties: false + TitleOptions: + $ref: '#/components/schemas/LabelOptions' + InfoIconLabelOptions: + $ref: '#/components/schemas/SheetControlInfoIconLabelOptions' + DateTimeFormat: + minLength: 1 + type: string + maxLength: 128 AnalysisError: + description:

Analysis error.

+ additionalProperties: false type: object properties: Type: $ref: '#/components/schemas/AnalysisErrorType' Message: + pattern: \S + description:

The message associated with the analysis error.

type: string - pattern: .*\S.* ViolatedEntities: + minItems: 0 + maxItems: 200 + description:

Lists the violated entities that caused the analysis error

type: array items: $ref: '#/components/schemas/Entity' - maxItems: 200 - minItems: 0 + GeospatialMapConfiguration: additionalProperties: false - AnalysisErrorType: - type: string - enum: - - ACCESS_DENIED - - SOURCE_NOT_FOUND - - DATA_SET_NOT_FOUND - - INTERNAL_FAILURE - - PARAMETER_VALUE_INCOMPATIBLE - - PARAMETER_TYPE_INVALID - - PARAMETER_NOT_FOUND - - COLUMN_TYPE_MISMATCH - - COLUMN_GEOGRAPHIC_ROLE_MISMATCH - - COLUMN_REPLACEMENT_MISSING - AnalysisSourceEntity: type: object properties: - SourceTemplate: - $ref: '#/components/schemas/AnalysisSourceTemplate' + Legend: + $ref: '#/components/schemas/LegendOptions' + MapStyleOptions: + $ref: '#/components/schemas/GeospatialMapStyleOptions' + FieldWells: + $ref: '#/components/schemas/GeospatialMapFieldWells' + Tooltip: + $ref: '#/components/schemas/TooltipOptions' + WindowOptions: + $ref: '#/components/schemas/GeospatialWindowOptions' + PointStyleOptions: + $ref: '#/components/schemas/GeospatialPointStyleOptions' + VisualPalette: + $ref: '#/components/schemas/VisualPalette' + ThousandSeparatorOptions: additionalProperties: false - AnalysisSourceTemplate: type: object properties: - DataSetReferences: + Symbol: + $ref: '#/components/schemas/NumericSeparatorSymbol' + Visibility: + $ref: '#/components/schemas/Visibility' + PredefinedHierarchy: + additionalProperties: false + type: object + properties: + HierarchyId: + minLength: 1 + type: string + maxLength: 512 + DrillDownFilters: + minItems: 0 + maxItems: 10 type: array items: - $ref: '#/components/schemas/DataSetReference' + $ref: '#/components/schemas/DrillDownFilter' + Columns: minItems: 1 - Arn: - type: string + maxItems: 10 + type: array + items: + $ref: '#/components/schemas/ColumnIdentifier' required: - - Arn - - DataSetReferences + - Columns + - HierarchyId + DateTimeFormatConfiguration: additionalProperties: false - AnchorDateConfiguration: type: object properties: - AnchorOption: - $ref: '#/components/schemas/AnchorOption' - ParameterName: - type: string - maxLength: 2048 + NumericFormatConfiguration: + $ref: '#/components/schemas/NumericFormatConfiguration' + NullValueFormatConfiguration: + $ref: '#/components/schemas/NullValueFormatConfiguration' + DateTimeFormat: minLength: 1 - pattern: ^[a-zA-Z0-9]+$ + type: string + maxLength: 128 + FilterControl: additionalProperties: false - AnchorOption: - type: string - enum: - - NOW - ArcAxisConfiguration: type: object properties: - Range: - $ref: '#/components/schemas/ArcAxisDisplayRange' - ReserveRange: - type: number - default: 0 + Slider: + $ref: '#/components/schemas/FilterSliderControl' + TextArea: + $ref: '#/components/schemas/FilterTextAreaControl' + Dropdown: + $ref: '#/components/schemas/FilterDropDownControl' + TextField: + $ref: '#/components/schemas/FilterTextFieldControl' + List: + $ref: '#/components/schemas/FilterListControl' + DateTimePicker: + $ref: '#/components/schemas/FilterDateTimePickerControl' + RelativeDateTime: + $ref: '#/components/schemas/FilterRelativeDateTimeControl' + CrossSheet: + $ref: '#/components/schemas/FilterCrossSheetControl' + PivotTableSubtotalLevel: + type: string + enum: + - ALL + - CUSTOM + - LAST + FormatConfiguration: additionalProperties: false - ArcAxisDisplayRange: type: object properties: - Min: - type: number - default: null - Max: - type: number - default: null + NumberFormatConfiguration: + $ref: '#/components/schemas/NumberFormatConfiguration' + DateTimeFormatConfiguration: + $ref: '#/components/schemas/DateTimeFormatConfiguration' + StringFormatConfiguration: + $ref: '#/components/schemas/StringFormatConfiguration' + ResourceStatus: + type: string + enum: + - CREATION_IN_PROGRESS + - CREATION_SUCCESSFUL + - CREATION_FAILED + - UPDATE_IN_PROGRESS + - UPDATE_SUCCESSFUL + - UPDATE_FAILED + - DELETED + RadarChartFieldWells: additionalProperties: false - ArcConfiguration: type: object properties: - ArcAngle: - type: number - default: null - ArcThickness: - $ref: '#/components/schemas/ArcThicknessOptions' + RadarChartAggregatedFieldWells: + $ref: '#/components/schemas/RadarChartAggregatedFieldWells' + RollingDateConfiguration: additionalProperties: false - ArcOptions: type: object properties: - ArcThickness: - $ref: '#/components/schemas/ArcThickness' + Expression: + minLength: 1 + type: string + maxLength: 4096 + DataSetIdentifier: + minLength: 1 + type: string + maxLength: 2048 + required: + - Expression + SeriesItem: additionalProperties: false - ArcThickness: - type: string - enum: - - SMALL - - MEDIUM - - LARGE - - WHOLE - ArcThicknessOptions: - type: string - enum: - - SMALL - - MEDIUM - - LARGE - AssetOptions: type: object properties: - Timezone: - type: string - WeekStart: - $ref: '#/components/schemas/DayOfTheWeek' + FieldSeriesItem: + $ref: '#/components/schemas/FieldSeriesItem' + DataFieldSeriesItem: + $ref: '#/components/schemas/DataFieldSeriesItem' + LineChartLineStyleSettings: additionalProperties: false - AttributeAggregationFunction: type: object properties: - SimpleAttributeAggregation: - $ref: '#/components/schemas/SimpleAttributeAggregationFunction' - ValueForMultipleValues: + LineInterpolation: + $ref: '#/components/schemas/LineInterpolation' + LineStyle: + $ref: '#/components/schemas/LineChartLineStyle' + LineVisibility: + $ref: '#/components/schemas/Visibility' + LineWidth: + description: String based length that is composed of value and unit in px type: string + FilledMapSortConfiguration: additionalProperties: false - AxisBinding: - type: string - enum: - - PRIMARY_YAXIS - - SECONDARY_YAXIS - AxisDataOptions: type: object properties: - NumericAxisOptions: - $ref: '#/components/schemas/NumericAxisOptions' - DateAxisOptions: - $ref: '#/components/schemas/DateAxisOptions' + CategorySort: + minItems: 0 + maxItems: 100 + type: array + items: + $ref: '#/components/schemas/FieldSortOptions' + Parameters: + description:

A list of Amazon QuickSight parameters and the list's override values.

additionalProperties: false - AxisDisplayDataDrivenRange: type: object + properties: + StringParameters: + minItems: 0 + maxItems: 100 + description:

The parameters that have a data type of string.

+ type: array + items: + $ref: '#/components/schemas/StringParameter' + DecimalParameters: + minItems: 0 + maxItems: 100 + description:

The parameters that have a data type of decimal.

+ type: array + items: + $ref: '#/components/schemas/DecimalParameter' + IntegerParameters: + minItems: 0 + maxItems: 100 + description:

The parameters that have a data type of integer.

+ type: array + items: + $ref: '#/components/schemas/IntegerParameter' + DateTimeParameters: + minItems: 0 + maxItems: 100 + description:

The parameters that have a data type of date-time.

+ type: array + items: + $ref: '#/components/schemas/DateTimeParameter' + MappedDataSetParameter: additionalProperties: false - AxisDisplayMinMaxRange: type: object properties: - Minimum: - type: number - default: null - Maximum: - type: number - default: null + DataSetParameterName: + minLength: 1 + pattern: ^[a-zA-Z0-9]+$ + type: string + maxLength: 2048 + DataSetIdentifier: + minLength: 1 + type: string + maxLength: 2048 + required: + - DataSetIdentifier + - DataSetParameterName + ReferenceLineLabelHorizontalPosition: + type: string + enum: + - LEFT + - CENTER + - RIGHT + RelativeDateTimeControlDisplayOptions: additionalProperties: false - AxisDisplayOptions: type: object properties: - TickLabelOptions: - $ref: '#/components/schemas/AxisTickLabelOptions' - AxisLineVisibility: - $ref: '#/components/schemas/Visibility' - GridLineVisibility: - $ref: '#/components/schemas/Visibility' - DataOptions: - $ref: '#/components/schemas/AxisDataOptions' - ScrollbarOptions: - $ref: '#/components/schemas/ScrollBarOptions' - AxisOffset: + TitleOptions: + $ref: '#/components/schemas/LabelOptions' + InfoIconLabelOptions: + $ref: '#/components/schemas/SheetControlInfoIconLabelOptions' + DateTimeFormat: + minLength: 1 type: string - description: String based length that is composed of value and unit in px + maxLength: 128 + BarChartVisual: additionalProperties: false - AxisDisplayRange: type: object properties: - MinMax: - $ref: '#/components/schemas/AxisDisplayMinMaxRange' - DataDriven: - $ref: '#/components/schemas/AxisDisplayDataDrivenRange' + Subtitle: + $ref: '#/components/schemas/VisualSubtitleLabelOptions' + VisualId: + minLength: 1 + pattern: ^[\w\-]+$ + type: string + maxLength: 512 + ChartConfiguration: + $ref: '#/components/schemas/BarChartConfiguration' + Actions: + minItems: 0 + maxItems: 10 + type: array + items: + $ref: '#/components/schemas/VisualCustomAction' + Title: + $ref: '#/components/schemas/VisualTitleLabelOptions' + ColumnHierarchies: + minItems: 0 + maxItems: 2 + type: array + items: + $ref: '#/components/schemas/ColumnHierarchy' + required: + - VisualId + ClusterMarkerConfiguration: additionalProperties: false - AxisLabelOptions: type: object properties: - FontConfiguration: - $ref: '#/components/schemas/FontConfiguration' - CustomLabel: - type: string - ApplyTo: - $ref: '#/components/schemas/AxisLabelReferenceOptions' + ClusterMarker: + $ref: '#/components/schemas/ClusterMarker' + TableCellConditionalFormatting: additionalProperties: false - AxisLabelReferenceOptions: type: object properties: FieldId: + minLength: 1 type: string maxLength: 512 - minLength: 1 - Column: - $ref: '#/components/schemas/ColumnIdentifier' + TextFormat: + $ref: '#/components/schemas/TextConditionalFormat' required: - - Column - FieldId + AssetOptions: additionalProperties: false - AxisLinearScale: type: object properties: - StepCount: - type: number - default: null - StepSize: - type: number - default: null + Timezone: + type: string + WeekStart: + $ref: '#/components/schemas/DayOfTheWeek' + DateAxisOptions: additionalProperties: false - AxisLogarithmicScale: type: object properties: - Base: - type: number - default: null + MissingDateVisibility: + $ref: '#/components/schemas/Visibility' + KPIActualValueConditionalFormatting: additionalProperties: false - AxisScale: type: object properties: - Linear: - $ref: '#/components/schemas/AxisLinearScale' - Logarithmic: - $ref: '#/components/schemas/AxisLogarithmicScale' + TextColor: + $ref: '#/components/schemas/ConditionalFormattingColor' + Icon: + $ref: '#/components/schemas/ConditionalFormattingIcon' + TableUnaggregatedFieldWells: additionalProperties: false - AxisTickLabelOptions: type: object properties: - LabelOptions: - $ref: '#/components/schemas/LabelOptions' - RotationAngle: - type: number - default: null + Values: + minItems: 0 + maxItems: 200 + type: array + items: + $ref: '#/components/schemas/UnaggregatedField' + TreeMapVisual: additionalProperties: false - BarChartAggregatedFieldWells: type: object properties: - Category: - type: array - items: - $ref: '#/components/schemas/DimensionField' - maxItems: 200 + Subtitle: + $ref: '#/components/schemas/VisualSubtitleLabelOptions' + VisualId: + minLength: 1 + pattern: ^[\w\-]+$ + type: string + maxLength: 512 + ChartConfiguration: + $ref: '#/components/schemas/TreeMapConfiguration' + Actions: minItems: 0 - Values: + maxItems: 10 type: array items: - $ref: '#/components/schemas/MeasureField' - maxItems: 200 + $ref: '#/components/schemas/VisualCustomAction' + Title: + $ref: '#/components/schemas/VisualTitleLabelOptions' + ColumnHierarchies: minItems: 0 - Colors: + maxItems: 2 type: array items: - $ref: '#/components/schemas/DimensionField' - maxItems: 200 - minItems: 0 - SmallMultiples: - type: array - items: - $ref: '#/components/schemas/DimensionField' - maxItems: 1 - minItems: 0 + $ref: '#/components/schemas/ColumnHierarchy' + required: + - VisualId + AxisDisplayOptions: additionalProperties: false - BarChartConfiguration: type: object properties: - FieldWells: - $ref: '#/components/schemas/BarChartFieldWells' - SortConfiguration: - $ref: '#/components/schemas/BarChartSortConfiguration' - Orientation: - $ref: '#/components/schemas/BarChartOrientation' - BarsArrangement: - $ref: '#/components/schemas/BarsArrangement' - VisualPalette: - $ref: '#/components/schemas/VisualPalette' - SmallMultiplesOptions: - $ref: '#/components/schemas/SmallMultiplesOptions' - CategoryAxis: - $ref: '#/components/schemas/AxisDisplayOptions' - CategoryLabelOptions: - $ref: '#/components/schemas/ChartAxisLabelOptions' - ValueAxis: - $ref: '#/components/schemas/AxisDisplayOptions' - ValueLabelOptions: - $ref: '#/components/schemas/ChartAxisLabelOptions' - ColorLabelOptions: - $ref: '#/components/schemas/ChartAxisLabelOptions' - Legend: - $ref: '#/components/schemas/LegendOptions' - DataLabels: - $ref: '#/components/schemas/DataLabelOptions' - Tooltip: - $ref: '#/components/schemas/TooltipOptions' - ReferenceLines: - type: array - items: - $ref: '#/components/schemas/ReferenceLine' - maxItems: 20 + DataOptions: + $ref: '#/components/schemas/AxisDataOptions' + TickLabelOptions: + $ref: '#/components/schemas/AxisTickLabelOptions' + AxisOffset: + description: String based length that is composed of value and unit in px + type: string + AxisLineVisibility: + $ref: '#/components/schemas/Visibility' + GridLineVisibility: + $ref: '#/components/schemas/Visibility' + ScrollbarOptions: + $ref: '#/components/schemas/ScrollBarOptions' + DataPathLabelType: + additionalProperties: false + type: object + properties: + FieldId: + minLength: 1 + type: string + maxLength: 512 + Visibility: + $ref: '#/components/schemas/Visibility' + FieldValue: + minLength: 0 + type: string + maxLength: 2048 + FreeFormSectionLayoutConfiguration: + additionalProperties: false + type: object + properties: + Elements: minItems: 0 - ContributionAnalysisDefaults: + maxItems: 430 type: array items: - $ref: '#/components/schemas/ContributionAnalysisDefault' - maxItems: 200 - minItems: 1 + $ref: '#/components/schemas/FreeFormLayoutElement' + required: + - Elements + DrillDownFilter: additionalProperties: false - BarChartFieldWells: type: object properties: - BarChartAggregatedFieldWells: - $ref: '#/components/schemas/BarChartAggregatedFieldWells' + NumericEqualityFilter: + $ref: '#/components/schemas/NumericEqualityDrillDownFilter' + TimeRangeFilter: + $ref: '#/components/schemas/TimeRangeDrillDownFilter' + CategoryFilter: + $ref: '#/components/schemas/CategoryDrillDownFilter' + CustomNarrativeOptions: additionalProperties: false - BarChartOrientation: + type: object + properties: + Narrative: + minLength: 0 + type: string + maxLength: 150000 + required: + - Narrative + LineChartDefaultSeriesSettings: + additionalProperties: false + type: object + properties: + LineStyleSettings: + $ref: '#/components/schemas/LineChartLineStyleSettings' + AxisBinding: + $ref: '#/components/schemas/AxisBinding' + MarkerStyleSettings: + $ref: '#/components/schemas/LineChartMarkerStyleSettings' + MaximumMinimumComputationType: type: string enum: - - HORIZONTAL - - VERTICAL - BarChartSortConfiguration: + - MAXIMUM + - MINIMUM + IntegerParameter: + description:

An integer parameter.

+ additionalProperties: false type: object properties: - CategorySort: - type: array - items: - $ref: '#/components/schemas/FieldSortOptions' - maxItems: 100 - minItems: 0 - CategoryItemsLimit: - $ref: '#/components/schemas/ItemsLimitConfiguration' - ColorSort: - type: array - items: - $ref: '#/components/schemas/FieldSortOptions' - maxItems: 100 - minItems: 0 - ColorItemsLimit: - $ref: '#/components/schemas/ItemsLimitConfiguration' - SmallMultiplesSort: + Values: + description:

The values for the integer parameter.

type: array items: - $ref: '#/components/schemas/FieldSortOptions' - maxItems: 100 - minItems: 0 - SmallMultiplesLimitConfiguration: - $ref: '#/components/schemas/ItemsLimitConfiguration' + default: 0 + type: number + Name: + pattern: \S + description:

The name of the integer parameter.

+ type: string + required: + - Name + - Values + FunnelChartVisual: additionalProperties: false - BarChartVisual: type: object properties: + Subtitle: + $ref: '#/components/schemas/VisualSubtitleLabelOptions' VisualId: + minLength: 1 + pattern: ^[\w\-]+$ type: string maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Title: - $ref: '#/components/schemas/VisualTitleLabelOptions' - Subtitle: - $ref: '#/components/schemas/VisualSubtitleLabelOptions' ChartConfiguration: - $ref: '#/components/schemas/BarChartConfiguration' + $ref: '#/components/schemas/FunnelChartConfiguration' Actions: + minItems: 0 + maxItems: 10 type: array items: $ref: '#/components/schemas/VisualCustomAction' - maxItems: 10 - minItems: 0 + Title: + $ref: '#/components/schemas/VisualTitleLabelOptions' ColumnHierarchies: + minItems: 0 + maxItems: 2 type: array items: $ref: '#/components/schemas/ColumnHierarchy' - maxItems: 2 - minItems: 0 required: - VisualId + FilterSelectableValues: additionalProperties: false - BarsArrangement: - type: string - enum: - - CLUSTERED - - STACKED - - STACKED_PERCENT - BaseMapStyleType: - type: string - enum: - - LIGHT_GRAY - - DARK_GRAY - - STREET - - IMAGERY - BinCountOptions: - type: object - properties: - Value: - type: number - minimum: 0 - additionalProperties: false - BinWidthOptions: - type: object - properties: - Value: - type: number - minimum: 0 - BinCountLimit: - type: number - maximum: 1000 - minimum: 0 - additionalProperties: false - BodySectionConfiguration: - type: object - properties: - SectionId: - type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Content: - $ref: '#/components/schemas/BodySectionContent' - Style: - $ref: '#/components/schemas/SectionStyle' - PageBreakConfiguration: - $ref: '#/components/schemas/SectionPageBreakConfiguration' - required: - - Content - - SectionId - additionalProperties: false - BodySectionContent: - type: object - properties: - Layout: - $ref: '#/components/schemas/SectionLayoutConfiguration' - additionalProperties: false - BoxPlotAggregatedFieldWells: type: object properties: - GroupBy: - type: array - items: - $ref: '#/components/schemas/DimensionField' - maxItems: 1 - minItems: 0 Values: + minItems: 0 + maxItems: 50000 type: array items: - $ref: '#/components/schemas/MeasureField' - maxItems: 5 - minItems: 0 + type: string + LineChartConfiguration: additionalProperties: false - BoxPlotChartConfiguration: type: object properties: - FieldWells: - $ref: '#/components/schemas/BoxPlotFieldWells' SortConfiguration: - $ref: '#/components/schemas/BoxPlotSortConfiguration' - BoxPlotOptions: - $ref: '#/components/schemas/BoxPlotOptions' - CategoryAxis: - $ref: '#/components/schemas/AxisDisplayOptions' - CategoryLabelOptions: - $ref: '#/components/schemas/ChartAxisLabelOptions' - PrimaryYAxisDisplayOptions: - $ref: '#/components/schemas/AxisDisplayOptions' - PrimaryYAxisLabelOptions: - $ref: '#/components/schemas/ChartAxisLabelOptions' + $ref: '#/components/schemas/LineChartSortConfiguration' Legend: $ref: '#/components/schemas/LegendOptions' - Tooltip: - $ref: '#/components/schemas/TooltipOptions' ReferenceLines: + minItems: 0 + maxItems: 20 type: array items: $ref: '#/components/schemas/ReferenceLine' - maxItems: 20 - minItems: 0 + DataLabels: + $ref: '#/components/schemas/DataLabelOptions' + Tooltip: + $ref: '#/components/schemas/TooltipOptions' + SmallMultiplesOptions: + $ref: '#/components/schemas/SmallMultiplesOptions' + PrimaryYAxisDisplayOptions: + $ref: '#/components/schemas/LineSeriesAxisDisplayOptions' VisualPalette: $ref: '#/components/schemas/VisualPalette' + XAxisDisplayOptions: + $ref: '#/components/schemas/AxisDisplayOptions' + DefaultSeriesSettings: + $ref: '#/components/schemas/LineChartDefaultSeriesSettings' + SecondaryYAxisLabelOptions: + $ref: '#/components/schemas/ChartAxisLabelOptions' + ForecastConfigurations: + minItems: 0 + maxItems: 10 + type: array + items: + $ref: '#/components/schemas/ForecastConfiguration' + Series: + minItems: 0 + maxItems: 2000 + type: array + items: + $ref: '#/components/schemas/SeriesItem' + Type: + $ref: '#/components/schemas/LineChartType' + PrimaryYAxisLabelOptions: + $ref: '#/components/schemas/ChartAxisLabelOptions' + ContributionAnalysisDefaults: + minItems: 1 + maxItems: 200 + type: array + items: + $ref: '#/components/schemas/ContributionAnalysisDefault' + FieldWells: + $ref: '#/components/schemas/LineChartFieldWells' + SecondaryYAxisDisplayOptions: + $ref: '#/components/schemas/LineSeriesAxisDisplayOptions' + XAxisLabelOptions: + $ref: '#/components/schemas/ChartAxisLabelOptions' + SectionAfterPageBreak: additionalProperties: false - BoxPlotFieldWells: - type: object - properties: - BoxPlotAggregatedFieldWells: - $ref: '#/components/schemas/BoxPlotAggregatedFieldWells' - additionalProperties: false - BoxPlotFillStyle: - type: string - enum: - - SOLID - - TRANSPARENT - BoxPlotOptions: type: object properties: - StyleOptions: - $ref: '#/components/schemas/BoxPlotStyleOptions' - OutlierVisibility: - $ref: '#/components/schemas/Visibility' - AllDataPointsVisibility: - $ref: '#/components/schemas/Visibility' + Status: + $ref: '#/components/schemas/SectionPageBreakStatus' + ComboChartAggregatedFieldWells: additionalProperties: false - BoxPlotSortConfiguration: type: object properties: - CategorySort: + BarValues: + minItems: 0 + maxItems: 200 type: array items: - $ref: '#/components/schemas/FieldSortOptions' - maxItems: 100 + $ref: '#/components/schemas/MeasureField' + Category: minItems: 0 - PaginationConfiguration: - $ref: '#/components/schemas/PaginationConfiguration' + maxItems: 200 + type: array + items: + $ref: '#/components/schemas/DimensionField' + Colors: + minItems: 0 + maxItems: 200 + type: array + items: + $ref: '#/components/schemas/DimensionField' + LineValues: + minItems: 0 + maxItems: 200 + type: array + items: + $ref: '#/components/schemas/MeasureField' + RelativeDateType: + type: string + enum: + - PREVIOUS + - THIS + - LAST + - NOW + - NEXT + GaugeChartOptions: additionalProperties: false - BoxPlotStyleOptions: type: object properties: - FillStyle: - $ref: '#/components/schemas/BoxPlotFillStyle' + Arc: + $ref: '#/components/schemas/ArcConfiguration' + Comparison: + $ref: '#/components/schemas/ComparisonConfiguration' + PrimaryValueDisplayType: + $ref: '#/components/schemas/PrimaryValueDisplayType' + ArcAxis: + $ref: '#/components/schemas/ArcAxisConfiguration' + PrimaryValueFontConfiguration: + $ref: '#/components/schemas/FontConfiguration' + MeasureField: + additionalProperties: false + type: object + properties: + DateMeasureField: + $ref: '#/components/schemas/DateMeasureField' + NumericalMeasureField: + $ref: '#/components/schemas/NumericalMeasureField' + CategoricalMeasureField: + $ref: '#/components/schemas/CategoricalMeasureField' + CalculatedMeasureField: + $ref: '#/components/schemas/CalculatedMeasureField' + ScatterPlotVisual: additionalProperties: false - BoxPlotVisual: type: object properties: + Subtitle: + $ref: '#/components/schemas/VisualSubtitleLabelOptions' VisualId: + minLength: 1 + pattern: ^[\w\-]+$ type: string maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Title: - $ref: '#/components/schemas/VisualTitleLabelOptions' - Subtitle: - $ref: '#/components/schemas/VisualSubtitleLabelOptions' ChartConfiguration: - $ref: '#/components/schemas/BoxPlotChartConfiguration' + $ref: '#/components/schemas/ScatterPlotConfiguration' Actions: + minItems: 0 + maxItems: 10 type: array items: $ref: '#/components/schemas/VisualCustomAction' - maxItems: 10 - minItems: 0 + Title: + $ref: '#/components/schemas/VisualTitleLabelOptions' ColumnHierarchies: + minItems: 0 + maxItems: 2 type: array items: $ref: '#/components/schemas/ColumnHierarchy' - maxItems: 2 - minItems: 0 required: - VisualId + AxisScale: additionalProperties: false - CalculatedField: type: object properties: - DataSetIdentifier: - type: string - maxLength: 2048 - minLength: 1 - Name: - type: string - maxLength: 127 - minLength: 1 - Expression: - type: string - maxLength: 32000 - minLength: 1 - required: - - DataSetIdentifier - - Expression - - Name + Logarithmic: + $ref: '#/components/schemas/AxisLogarithmicScale' + Linear: + $ref: '#/components/schemas/AxisLinearScale' + HeatMapAggregatedFieldWells: additionalProperties: false - CalculatedMeasureField: type: object properties: - FieldId: - type: string - maxLength: 512 - minLength: 1 - Expression: - type: string - maxLength: 4096 - minLength: 1 - required: - - Expression - - FieldId + Values: + minItems: 0 + maxItems: 1 + type: array + items: + $ref: '#/components/schemas/MeasureField' + Columns: + minItems: 0 + maxItems: 1 + type: array + items: + $ref: '#/components/schemas/DimensionField' + Rows: + minItems: 0 + maxItems: 1 + type: array + items: + $ref: '#/components/schemas/DimensionField' + DefaultFilterDropDownControlOptions: additionalProperties: false - CascadingControlConfiguration: type: object properties: - SourceControls: + Type: + $ref: '#/components/schemas/SheetControlListType' + DisplayOptions: + $ref: '#/components/schemas/DropDownControlDisplayOptions' + SelectableValues: + $ref: '#/components/schemas/FilterSelectableValues' + GaugeChartFieldWells: + additionalProperties: false + type: object + properties: + TargetValues: + minItems: 0 + maxItems: 200 type: array items: - $ref: '#/components/schemas/CascadingControlSource' - maxItems: 200 + $ref: '#/components/schemas/MeasureField' + Values: minItems: 0 + maxItems: 200 + type: array + items: + $ref: '#/components/schemas/MeasureField' + DateTimeParameter: + description:

A date-time parameter.

additionalProperties: false - CascadingControlSource: type: object properties: - SourceSheetControlId: + Values: + description:

The values for the date-time parameter.

+ type: array + items: + type: string + Name: + pattern: \S + description:

A display name for the date-time parameter.

type: string - ColumnToMatch: - $ref: '#/components/schemas/ColumnIdentifier' + required: + - Name + - Values + AxisLinearScale: additionalProperties: false - CategoricalAggregationFunction: - type: string - enum: - - COUNT - - DISTINCT_COUNT - CategoricalDimensionField: type: object properties: - FieldId: - type: string - maxLength: 512 - minLength: 1 - Column: + StepSize: + default: null + type: number + StepCount: + default: null + type: number + ColumnRole: + type: string + enum: + - DIMENSION + - MEASURE + NegativeValueConfiguration: + additionalProperties: false + type: object + properties: + DisplayMode: + $ref: '#/components/schemas/NegativeValueDisplayMode' + required: + - DisplayMode + PivotTableTotalOptions: + additionalProperties: false + type: object + properties: + ColumnSubtotalOptions: + $ref: '#/components/schemas/SubtotalOptions' + RowSubtotalOptions: + $ref: '#/components/schemas/SubtotalOptions' + RowTotalOptions: + $ref: '#/components/schemas/PivotTotalOptions' + ColumnTotalOptions: + $ref: '#/components/schemas/PivotTotalOptions' + DynamicDefaultValue: + additionalProperties: false + type: object + properties: + GroupNameColumn: + $ref: '#/components/schemas/ColumnIdentifier' + DefaultValueColumn: + $ref: '#/components/schemas/ColumnIdentifier' + UserNameColumn: $ref: '#/components/schemas/ColumnIdentifier' - HierarchyId: - type: string - maxLength: 512 - minLength: 1 - FormatConfiguration: - $ref: '#/components/schemas/StringFormatConfiguration' required: - - Column - - FieldId + - DefaultValueColumn + BodySectionConfiguration: additionalProperties: false - CategoricalMeasureField: type: object properties: - FieldId: + Content: + $ref: '#/components/schemas/BodySectionContent' + Style: + $ref: '#/components/schemas/SectionStyle' + PageBreakConfiguration: + $ref: '#/components/schemas/SectionPageBreakConfiguration' + SectionId: + minLength: 1 + pattern: ^[\w\-]+$ type: string maxLength: 512 - minLength: 1 - Column: - $ref: '#/components/schemas/ColumnIdentifier' - AggregationFunction: - $ref: '#/components/schemas/CategoricalAggregationFunction' - FormatConfiguration: - $ref: '#/components/schemas/StringFormatConfiguration' required: - - Column - - FieldId + - Content + - SectionId + WordCloudAggregatedFieldWells: additionalProperties: false - CategoryDrillDownFilter: type: object properties: - Column: - $ref: '#/components/schemas/ColumnIdentifier' - CategoryValues: + GroupBy: + minItems: 0 + maxItems: 10 type: array items: - type: string - maxLength: 512 - minLength: 0 - maxItems: 100000 + $ref: '#/components/schemas/DimensionField' + Size: minItems: 0 + maxItems: 1 + type: array + items: + $ref: '#/components/schemas/MeasureField' + DefaultGridLayoutConfiguration: + additionalProperties: false + type: object + properties: + CanvasSizeOptions: + $ref: '#/components/schemas/GridLayoutCanvasSizeOptions' required: - - CategoryValues - - Column + - CanvasSizeOptions + GradientStop: additionalProperties: false - CategoryFilter: type: object properties: - FilterId: + GradientOffset: + default: 0 + type: number + DataValue: + default: null + type: number + Color: + pattern: ^#[A-F0-9]{6}$ type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Column: - $ref: '#/components/schemas/ColumnIdentifier' - Configuration: - $ref: '#/components/schemas/CategoryFilterConfiguration' required: - - Column - - Configuration - - FilterId + - GradientOffset + GaugeChartPrimaryValueConditionalFormatting: additionalProperties: false - CategoryFilterConfiguration: type: object properties: - FilterListConfiguration: - $ref: '#/components/schemas/FilterListConfiguration' - CustomFilterListConfiguration: - $ref: '#/components/schemas/CustomFilterListConfiguration' - CustomFilterConfiguration: - $ref: '#/components/schemas/CustomFilterConfiguration' - additionalProperties: false - CategoryFilterMatchOperator: + TextColor: + $ref: '#/components/schemas/ConditionalFormattingColor' + Icon: + $ref: '#/components/schemas/ConditionalFormattingIcon' + BoxPlotFillStyle: type: string enum: - - EQUALS - - DOES_NOT_EQUAL - - CONTAINS - - DOES_NOT_CONTAIN - - STARTS_WITH - - ENDS_WITH - CategoryFilterSelectAllOptions: + - SOLID + - TRANSPARENT + DataLabelType: + additionalProperties: false + type: object + properties: + MaximumLabelType: + $ref: '#/components/schemas/MaximumLabelType' + DataPathLabelType: + $ref: '#/components/schemas/DataPathLabelType' + RangeEndsLabelType: + $ref: '#/components/schemas/RangeEndsLabelType' + FieldLabelType: + $ref: '#/components/schemas/FieldLabelType' + MinimumLabelType: + $ref: '#/components/schemas/MinimumLabelType' + WordCloudCloudLayout: type: string enum: - - FILTER_ALL_VALUES - ChartAxisLabelOptions: + - FLUID + - NORMAL + MaximumLabelType: + additionalProperties: false type: object properties: Visibility: $ref: '#/components/schemas/Visibility' - SortIconVisibility: - $ref: '#/components/schemas/Visibility' - AxisLabelOptions: + DataLabelPosition: + type: string + enum: + - INSIDE + - OUTSIDE + - LEFT + - TOP + - BOTTOM + - RIGHT + DecimalParameter: + description:

A decimal parameter.

+ additionalProperties: false + type: object + properties: + Values: + description:

The values for the decimal parameter.

type: array items: - $ref: '#/components/schemas/AxisLabelOptions' - maxItems: 100 - minItems: 0 + default: 0 + type: number + Name: + pattern: \S + description:

A display name for the decimal parameter.

+ type: string + required: + - Name + - Values + GeospatialMapStyleOptions: additionalProperties: false - ClusterMarker: type: object properties: - SimpleClusterMarker: - $ref: '#/components/schemas/SimpleClusterMarker' + BaseMapStyle: + $ref: '#/components/schemas/BaseMapStyleType' + Layout: additionalProperties: false - ClusterMarkerConfiguration: type: object properties: - ClusterMarker: - $ref: '#/components/schemas/ClusterMarker' + Configuration: + $ref: '#/components/schemas/LayoutConfiguration' + required: + - Configuration + ReferenceLineValueLabelConfiguration: additionalProperties: false - ColorFillType: - type: string - enum: - - DISCRETE - - GRADIENT - ColorScale: type: object properties: - Colors: - type: array - items: - $ref: '#/components/schemas/DataColor' - maxItems: 3 - minItems: 2 - ColorFillType: - $ref: '#/components/schemas/ColorFillType' - NullValueColor: - $ref: '#/components/schemas/DataColor' - required: - - ColorFillType - - Colors + FormatConfiguration: + $ref: '#/components/schemas/NumericFormatConfiguration' + RelativePosition: + $ref: '#/components/schemas/ReferenceLineValueLabelRelativePosition' + StringValueWhenUnsetConfiguration: additionalProperties: false - ColorsConfiguration: type: object properties: - CustomColors: - type: array - items: - $ref: '#/components/schemas/CustomColor' - maxItems: 50 - minItems: 0 + ValueWhenUnsetOption: + $ref: '#/components/schemas/ValueWhenUnsetOption' + CustomValue: + type: string + PivotTableSortBy: additionalProperties: false - ColumnConfiguration: type: object properties: + Field: + $ref: '#/components/schemas/FieldSort' + DataPath: + $ref: '#/components/schemas/DataPathSort' Column: - $ref: '#/components/schemas/ColumnIdentifier' - FormatConfiguration: - $ref: '#/components/schemas/FormatConfiguration' - Role: - $ref: '#/components/schemas/ColumnRole' - ColorsConfiguration: - $ref: '#/components/schemas/ColorsConfiguration' - required: - - Column + $ref: '#/components/schemas/ColumnSort' + SimpleClusterMarker: additionalProperties: false - ColumnHierarchy: type: object properties: - ExplicitHierarchy: - $ref: '#/components/schemas/ExplicitHierarchy' - DateTimeHierarchy: - $ref: '#/components/schemas/DateTimeHierarchy' - PredefinedHierarchy: - $ref: '#/components/schemas/PredefinedHierarchy' + Color: + pattern: ^#[A-F0-9]{6}$ + type: string + FilterDateTimePickerControl: additionalProperties: false - ColumnIdentifier: type: object properties: - DataSetIdentifier: + FilterControlId: + minLength: 1 + pattern: ^[\w\-]+$ type: string - maxLength: 2048 + maxLength: 512 + Type: + $ref: '#/components/schemas/SheetControlDateTimePickerType' + DisplayOptions: + $ref: '#/components/schemas/DateTimePickerControlDisplayOptions' + Title: minLength: 1 - ColumnName: type: string - maxLength: 127 + maxLength: 2048 + SourceFilterId: minLength: 1 + pattern: ^[\w\-]+$ + type: string + maxLength: 512 required: - - ColumnName - - DataSetIdentifier - additionalProperties: false - ColumnRole: + - FilterControlId + - SourceFilterId + - Title + LegendPosition: type: string enum: - - DIMENSION - - MEASURE - ColumnSort: + - AUTO + - RIGHT + - BOTTOM + - TOP + KPIVisualLayoutOptions: + additionalProperties: false type: object properties: - SortBy: - $ref: '#/components/schemas/ColumnIdentifier' - Direction: - $ref: '#/components/schemas/SortDirection' - AggregationFunction: - $ref: '#/components/schemas/AggregationFunction' - required: - - Direction - - SortBy + StandardLayout: + $ref: '#/components/schemas/KPIVisualStandardLayout' + TimeRangeFilterValue: additionalProperties: false - ColumnTooltipItem: type: object properties: - Column: - $ref: '#/components/schemas/ColumnIdentifier' - Label: + RollingDate: + $ref: '#/components/schemas/RollingDateConfiguration' + StaticValue: + format: date-time + type: string + Parameter: + minLength: 1 + pattern: ^[a-zA-Z0-9]+$ + type: string + maxLength: 2048 + PivotTableRowsLabelOptions: + additionalProperties: false + type: object + properties: + CustomLabel: + minLength: 1 type: string + maxLength: 1024 Visibility: $ref: '#/components/schemas/Visibility' - Aggregation: - $ref: '#/components/schemas/AggregationFunction' - required: - - Column + WordCloudOptions: additionalProperties: false - ComboChartAggregatedFieldWells: type: object properties: - Category: - type: array - items: - $ref: '#/components/schemas/DimensionField' - maxItems: 200 - minItems: 0 - BarValues: - type: array - items: - $ref: '#/components/schemas/MeasureField' - maxItems: 200 - minItems: 0 - Colors: - type: array - items: - $ref: '#/components/schemas/DimensionField' - maxItems: 200 - minItems: 0 - LineValues: - type: array - items: - $ref: '#/components/schemas/MeasureField' - maxItems: 200 - minItems: 0 + WordOrientation: + $ref: '#/components/schemas/WordCloudWordOrientation' + WordScaling: + $ref: '#/components/schemas/WordCloudWordScaling' + CloudLayout: + $ref: '#/components/schemas/WordCloudCloudLayout' + MaximumStringLength: + maximum: 100 + type: number + minimum: 1 + WordCasing: + $ref: '#/components/schemas/WordCloudWordCasing' + WordPadding: + $ref: '#/components/schemas/WordCloudWordPadding' + ParameterDropDownControl: additionalProperties: false - ComboChartConfiguration: type: object properties: - FieldWells: - $ref: '#/components/schemas/ComboChartFieldWells' - SortConfiguration: - $ref: '#/components/schemas/ComboChartSortConfiguration' - BarsArrangement: - $ref: '#/components/schemas/BarsArrangement' - CategoryAxis: - $ref: '#/components/schemas/AxisDisplayOptions' - CategoryLabelOptions: - $ref: '#/components/schemas/ChartAxisLabelOptions' - PrimaryYAxisDisplayOptions: - $ref: '#/components/schemas/AxisDisplayOptions' - PrimaryYAxisLabelOptions: - $ref: '#/components/schemas/ChartAxisLabelOptions' - SecondaryYAxisDisplayOptions: - $ref: '#/components/schemas/AxisDisplayOptions' - SecondaryYAxisLabelOptions: - $ref: '#/components/schemas/ChartAxisLabelOptions' - ColorLabelOptions: - $ref: '#/components/schemas/ChartAxisLabelOptions' - Legend: - $ref: '#/components/schemas/LegendOptions' - BarDataLabels: - $ref: '#/components/schemas/DataLabelOptions' - LineDataLabels: - $ref: '#/components/schemas/DataLabelOptions' - Tooltip: - $ref: '#/components/schemas/TooltipOptions' - ReferenceLines: - type: array - items: - $ref: '#/components/schemas/ReferenceLine' - maxItems: 20 - minItems: 0 - VisualPalette: - $ref: '#/components/schemas/VisualPalette' + ParameterControlId: + minLength: 1 + pattern: ^[\w\-]+$ + type: string + maxLength: 512 + Type: + $ref: '#/components/schemas/SheetControlListType' + DisplayOptions: + $ref: '#/components/schemas/DropDownControlDisplayOptions' + SourceParameterName: + minLength: 1 + pattern: ^[a-zA-Z0-9]+$ + type: string + maxLength: 2048 + CascadingControlConfiguration: + $ref: '#/components/schemas/CascadingControlConfiguration' + Title: + minLength: 1 + type: string + maxLength: 2048 + SelectableValues: + $ref: '#/components/schemas/ParameterSelectableValues' + required: + - ParameterControlId + - SourceParameterName + - Title + TableFieldOption: additionalProperties: false - ComboChartFieldWells: type: object properties: - ComboChartAggregatedFieldWells: - $ref: '#/components/schemas/ComboChartAggregatedFieldWells' + CustomLabel: + minLength: 1 + type: string + maxLength: 2048 + URLStyling: + $ref: '#/components/schemas/TableFieldURLConfiguration' + FieldId: + minLength: 1 + type: string + maxLength: 512 + Visibility: + $ref: '#/components/schemas/Visibility' + Width: + description: String based length that is composed of value and unit in px + type: string + required: + - FieldId + IntegerParameterDeclaration: additionalProperties: false - ComboChartSortConfiguration: type: object properties: - CategorySort: - type: array - items: - $ref: '#/components/schemas/FieldSortOptions' - maxItems: 100 + MappedDataSetParameters: minItems: 0 - CategoryItemsLimit: - $ref: '#/components/schemas/ItemsLimitConfiguration' - ColorSort: + maxItems: 150 type: array items: - $ref: '#/components/schemas/FieldSortOptions' - maxItems: 100 - minItems: 0 - ColorItemsLimit: - $ref: '#/components/schemas/ItemsLimitConfiguration' + $ref: '#/components/schemas/MappedDataSetParameter' + DefaultValues: + $ref: '#/components/schemas/IntegerDefaultValues' + ParameterValueType: + $ref: '#/components/schemas/ParameterValueType' + ValueWhenUnset: + $ref: '#/components/schemas/IntegerValueWhenUnsetConfiguration' + Name: + minLength: 1 + pattern: ^[a-zA-Z0-9]+$ + type: string + maxLength: 2048 + required: + - Name + - ParameterValueType + FontConfiguration: additionalProperties: false - ComboChartVisual: type: object properties: - VisualId: + FontStyle: + $ref: '#/components/schemas/FontStyle' + FontSize: + $ref: '#/components/schemas/FontSize' + FontDecoration: + $ref: '#/components/schemas/FontDecoration' + FontColor: + pattern: ^#[A-F0-9]{6}$ type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Title: - $ref: '#/components/schemas/VisualTitleLabelOptions' - Subtitle: - $ref: '#/components/schemas/VisualSubtitleLabelOptions' - ChartConfiguration: - $ref: '#/components/schemas/ComboChartConfiguration' - Actions: - type: array - items: - $ref: '#/components/schemas/VisualCustomAction' - maxItems: 10 - minItems: 0 - ColumnHierarchies: - type: array - items: - $ref: '#/components/schemas/ColumnHierarchy' - maxItems: 2 - minItems: 0 - required: - - VisualId - additionalProperties: false - ComparisonConfiguration: - type: object - properties: - ComparisonMethod: - $ref: '#/components/schemas/ComparisonMethod' - ComparisonFormat: - $ref: '#/components/schemas/ComparisonFormatConfiguration' + FontWeight: + $ref: '#/components/schemas/FontWeight' + VisualSubtitleLabelOptions: additionalProperties: false - ComparisonFormatConfiguration: type: object properties: - NumberDisplayFormatConfiguration: - $ref: '#/components/schemas/NumberDisplayFormatConfiguration' - PercentageDisplayFormatConfiguration: - $ref: '#/components/schemas/PercentageDisplayFormatConfiguration' + Visibility: + $ref: '#/components/schemas/Visibility' + FormatText: + $ref: '#/components/schemas/LongFormatText' + DataPathType: additionalProperties: false - ComparisonMethod: - type: string - enum: - - DIFFERENCE - - PERCENT_DIFFERENCE - - PERCENT - Computation: type: object properties: - TopBottomRanked: - $ref: '#/components/schemas/TopBottomRankedComputation' - TopBottomMovers: - $ref: '#/components/schemas/TopBottomMoversComputation' - TotalAggregation: - $ref: '#/components/schemas/TotalAggregationComputation' - MaximumMinimum: - $ref: '#/components/schemas/MaximumMinimumComputation' - MetricComparison: - $ref: '#/components/schemas/MetricComparisonComputation' - PeriodOverPeriod: - $ref: '#/components/schemas/PeriodOverPeriodComputation' - PeriodToDate: - $ref: '#/components/schemas/PeriodToDateComputation' - GrowthRate: - $ref: '#/components/schemas/GrowthRateComputation' - UniqueValues: - $ref: '#/components/schemas/UniqueValuesComputation' - Forecast: - $ref: '#/components/schemas/ForecastComputation' + PivotTableDataPathType: + $ref: '#/components/schemas/PivotTableDataPathType' + ArcAxisConfiguration: additionalProperties: false - ConditionalFormattingColor: type: object properties: - Solid: - $ref: '#/components/schemas/ConditionalFormattingSolidColor' - Gradient: - $ref: '#/components/schemas/ConditionalFormattingGradientColor' + Range: + $ref: '#/components/schemas/ArcAxisDisplayRange' + ReserveRange: + default: 0 + type: number + NumericEqualityFilter: additionalProperties: false - ConditionalFormattingCustomIconCondition: type: object properties: - Expression: + AggregationFunction: + $ref: '#/components/schemas/AggregationFunction' + Column: + $ref: '#/components/schemas/ColumnIdentifier' + Value: + default: null + type: number + ParameterName: + minLength: 1 + pattern: ^[a-zA-Z0-9]+$ type: string - maxLength: 4096 + maxLength: 2048 + NullOption: + $ref: '#/components/schemas/FilterNullOption' + MatchOperator: + $ref: '#/components/schemas/NumericEqualityMatchOperator' + SelectAllOptions: + $ref: '#/components/schemas/NumericFilterSelectAllOptions' + DefaultFilterControlConfiguration: + $ref: '#/components/schemas/DefaultFilterControlConfiguration' + FilterId: minLength: 1 - IconOptions: - $ref: '#/components/schemas/ConditionalFormattingCustomIconOptions' - Color: + pattern: ^[\w\-]+$ type: string - pattern: ^#[A-F0-9]{6}$ - DisplayConfiguration: - $ref: '#/components/schemas/ConditionalFormattingIconDisplayConfiguration' + maxLength: 512 required: - - Expression - - IconOptions - additionalProperties: false - ConditionalFormattingCustomIconOptions: - type: object - properties: - Icon: - $ref: '#/components/schemas/Icon' - UnicodeIcon: - type: string - pattern: ^[^\u0000-\u00FF]$ + - Column + - FilterId + - MatchOperator + - NullOption + ShapeConditionalFormat: additionalProperties: false - ConditionalFormattingGradientColor: type: object properties: - Expression: - type: string - maxLength: 4096 - minLength: 1 - Color: - $ref: '#/components/schemas/GradientColor' + BackgroundColor: + $ref: '#/components/schemas/ConditionalFormattingColor' required: - - Color - - Expression - additionalProperties: false - ConditionalFormattingIcon: - type: object - properties: - IconSet: - $ref: '#/components/schemas/ConditionalFormattingIconSet' - CustomCondition: - $ref: '#/components/schemas/ConditionalFormattingCustomIconCondition' + - BackgroundColor + GaugeChartArcConditionalFormatting: additionalProperties: false - ConditionalFormattingIconDisplayConfiguration: type: object properties: - IconDisplayOption: - $ref: '#/components/schemas/ConditionalFormattingIconDisplayOption' + ForegroundColor: + $ref: '#/components/schemas/ConditionalFormattingColor' + AxisLabelOptions: additionalProperties: false - ConditionalFormattingIconDisplayOption: - type: string - enum: - - ICON_ONLY - ConditionalFormattingIconSet: type: object properties: - Expression: + CustomLabel: type: string - maxLength: 4096 - minLength: 1 - IconSetType: - $ref: '#/components/schemas/ConditionalFormattingIconSetType' - required: - - Expression + ApplyTo: + $ref: '#/components/schemas/AxisLabelReferenceOptions' + FontConfiguration: + $ref: '#/components/schemas/FontConfiguration' + DataSetReference: + description:

Dataset reference.

additionalProperties: false - ConditionalFormattingIconSetType: - type: string - enum: - - PLUS_MINUS - - CHECK_X - - THREE_COLOR_ARROW - - THREE_GRAY_ARROW - - CARET_UP_MINUS_DOWN - - THREE_SHAPE - - THREE_CIRCLE - - FLAGS - - BARS - - FOUR_COLOR_ARROW - - FOUR_GRAY_ARROW - ConditionalFormattingSolidColor: type: object properties: - Expression: + DataSetArn: + description:

Dataset Amazon Resource Name (ARN).

type: string - maxLength: 4096 - minLength: 1 - Color: + DataSetPlaceholder: + pattern: \S + description:

Dataset placeholder.

type: string - pattern: ^#[A-F0-9]{6}$ required: - - Expression + - DataSetArn + - DataSetPlaceholder + ScatterPlotCategoricallyAggregatedFieldWells: additionalProperties: false - ContributionAnalysisDefault: type: object properties: - MeasureFieldId: - type: string - maxLength: 512 - minLength: 1 - ContributorDimensions: + Category: + minItems: 0 + maxItems: 200 type: array items: - $ref: '#/components/schemas/ColumnIdentifier' - maxItems: 4 - minItems: 1 - required: - - ContributorDimensions - - MeasureFieldId + $ref: '#/components/schemas/DimensionField' + Size: + minItems: 0 + maxItems: 200 + type: array + items: + $ref: '#/components/schemas/MeasureField' + Label: + minItems: 0 + maxItems: 200 + type: array + items: + $ref: '#/components/schemas/DimensionField' + XAxis: + minItems: 0 + maxItems: 200 + type: array + items: + $ref: '#/components/schemas/MeasureField' + YAxis: + minItems: 0 + maxItems: 200 + type: array + items: + $ref: '#/components/schemas/MeasureField' + LongFormatText: additionalProperties: false - CrossDatasetTypes: - type: string - enum: - - ALL_DATASETS - - SINGLE_DATASET - CurrencyDisplayFormatConfiguration: type: object properties: - Prefix: - type: string - maxLength: 128 + RichText: minLength: 1 - Suffix: type: string - maxLength: 128 + maxLength: 2048 + PlainText: minLength: 1 - SeparatorConfiguration: - $ref: '#/components/schemas/NumericSeparatorConfiguration' - Symbol: type: string - pattern: '[A-Z]{3}' - DecimalPlacesConfiguration: - $ref: '#/components/schemas/DecimalPlacesConfiguration' - NumberScale: - $ref: '#/components/schemas/NumberScale' - NegativeValueConfiguration: - $ref: '#/components/schemas/NegativeValueConfiguration' - NullValueFormatConfiguration: - $ref: '#/components/schemas/NullValueFormatConfiguration' - additionalProperties: false - CustomActionFilterOperation: - type: object - properties: - SelectedFieldsConfiguration: - $ref: '#/components/schemas/FilterOperationSelectedFieldsConfiguration' - TargetVisualsConfiguration: - $ref: '#/components/schemas/FilterOperationTargetVisualsConfiguration' - required: - - SelectedFieldsConfiguration - - TargetVisualsConfiguration - additionalProperties: false - CustomActionNavigationOperation: - type: object - properties: - LocalNavigationConfiguration: - $ref: '#/components/schemas/LocalNavigationConfiguration' + maxLength: 1024 + RadarChartAggregatedFieldWells: additionalProperties: false - CustomActionSetParametersOperation: type: object properties: - ParameterValueConfigurations: + Category: + minItems: 0 + maxItems: 1 type: array items: - $ref: '#/components/schemas/SetParameterValueConfiguration' - maxItems: 200 - minItems: 1 - required: - - ParameterValueConfigurations + $ref: '#/components/schemas/DimensionField' + Color: + minItems: 0 + maxItems: 1 + type: array + items: + $ref: '#/components/schemas/DimensionField' + Values: + minItems: 0 + maxItems: 20 + type: array + items: + $ref: '#/components/schemas/MeasureField' + FilterOperationTargetVisualsConfiguration: additionalProperties: false - CustomActionURLOperation: type: object properties: - URLTemplate: - type: string - maxLength: 2048 - minLength: 1 - URLTarget: - $ref: '#/components/schemas/URLTargetConfiguration' - required: - - URLTarget - - URLTemplate + SameSheetTargetVisualConfiguration: + $ref: '#/components/schemas/SameSheetTargetVisualConfiguration' + GrowthRateComputation: additionalProperties: false - CustomColor: type: object properties: - FieldValue: + Value: + $ref: '#/components/schemas/MeasureField' + Time: + $ref: '#/components/schemas/DimensionField' + PeriodSize: + default: 0 + maximum: 52 + type: number + minimum: 2 + ComputationId: + minLength: 1 + pattern: ^[\w\-]+$ type: string - maxLength: 2048 - minLength: 0 - Color: + maxLength: 512 + Name: type: string - pattern: ^#[A-F0-9]{6}$ - SpecialValue: - $ref: '#/components/schemas/SpecialValue' required: - - Color + - ComputationId + KPIOptions: additionalProperties: false - CustomContentConfiguration: type: object properties: - ContentUrl: - type: string - maxLength: 2048 - minLength: 1 - ContentType: - $ref: '#/components/schemas/CustomContentType' - ImageScaling: - $ref: '#/components/schemas/CustomContentImageScalingConfiguration' + SecondaryValueFontConfiguration: + $ref: '#/components/schemas/FontConfiguration' + VisualLayoutOptions: + $ref: '#/components/schemas/KPIVisualLayoutOptions' + TrendArrows: + $ref: '#/components/schemas/TrendArrowOptions' + SecondaryValue: + $ref: '#/components/schemas/SecondaryValueOptions' + Comparison: + $ref: '#/components/schemas/ComparisonConfiguration' + PrimaryValueDisplayType: + $ref: '#/components/schemas/PrimaryValueDisplayType' + ProgressBar: + $ref: '#/components/schemas/ProgressBarOptions' + PrimaryValueFontConfiguration: + $ref: '#/components/schemas/FontConfiguration' + Sparkline: + $ref: '#/components/schemas/KPISparklineOptions' + AttributeAggregationFunction: additionalProperties: false - CustomContentImageScalingConfiguration: - type: string - enum: - - FIT_TO_HEIGHT - - FIT_TO_WIDTH - - DO_NOT_SCALE - - SCALE_TO_VISUAL - CustomContentType: - type: string - enum: - - IMAGE - - OTHER_EMBEDDED_CONTENT - CustomContentVisual: type: object properties: - VisualId: - type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Title: - $ref: '#/components/schemas/VisualTitleLabelOptions' - Subtitle: - $ref: '#/components/schemas/VisualSubtitleLabelOptions' - ChartConfiguration: - $ref: '#/components/schemas/CustomContentConfiguration' - Actions: - type: array - items: - $ref: '#/components/schemas/VisualCustomAction' - maxItems: 10 - minItems: 0 - DataSetIdentifier: + SimpleAttributeAggregation: + $ref: '#/components/schemas/SimpleAttributeAggregationFunction' + ValueForMultipleValues: type: string - maxLength: 2048 - minLength: 1 - required: - - DataSetIdentifier - - VisualId + SectionBasedLayoutCanvasSizeOptions: additionalProperties: false - CustomFilterConfiguration: type: object properties: - MatchOperator: - $ref: '#/components/schemas/CategoryFilterMatchOperator' - CategoryValue: - type: string - maxLength: 512 - minLength: 0 - SelectAllOptions: - $ref: '#/components/schemas/CategoryFilterSelectAllOptions' - ParameterName: - type: string - maxLength: 2048 - minLength: 1 - pattern: ^[a-zA-Z0-9]+$ - NullOption: - $ref: '#/components/schemas/FilterNullOption' - required: - - MatchOperator - - NullOption + PaperCanvasSizeOptions: + $ref: '#/components/schemas/SectionBasedLayoutPaperCanvasSizeOptions' + NumericRangeFilter: additionalProperties: false - CustomFilterListConfiguration: type: object properties: - MatchOperator: - $ref: '#/components/schemas/CategoryFilterMatchOperator' - CategoryValues: - type: array - items: - type: string - maxLength: 512 - minLength: 0 - maxItems: 100000 - minItems: 0 - SelectAllOptions: - $ref: '#/components/schemas/CategoryFilterSelectAllOptions' + AggregationFunction: + $ref: '#/components/schemas/AggregationFunction' + Column: + $ref: '#/components/schemas/ColumnIdentifier' + IncludeMaximum: + default: null + type: boolean + RangeMinimum: + $ref: '#/components/schemas/NumericRangeFilterValue' NullOption: $ref: '#/components/schemas/FilterNullOption' + SelectAllOptions: + $ref: '#/components/schemas/NumericFilterSelectAllOptions' + DefaultFilterControlConfiguration: + $ref: '#/components/schemas/DefaultFilterControlConfiguration' + FilterId: + minLength: 1 + pattern: ^[\w\-]+$ + type: string + maxLength: 512 + RangeMaximum: + $ref: '#/components/schemas/NumericRangeFilterValue' + IncludeMinimum: + default: null + type: boolean required: - - MatchOperator + - Column + - FilterId - NullOption + FieldSortOptions: additionalProperties: false - CustomNarrativeOptions: type: object properties: - Narrative: - type: string - maxLength: 150000 - minLength: 0 - required: - - Narrative + FieldSort: + $ref: '#/components/schemas/FieldSort' + ColumnSort: + $ref: '#/components/schemas/ColumnSort' + ColorsConfiguration: additionalProperties: false - CustomParameterValues: type: object properties: - StringValues: + CustomColors: + minItems: 0 + maxItems: 50 type: array items: - type: string - maxItems: 50000 + $ref: '#/components/schemas/CustomColor' + HistogramBinType: + type: string + enum: + - BIN_COUNT + - BIN_WIDTH + ComboChartConfiguration: + additionalProperties: false + type: object + properties: + SortConfiguration: + $ref: '#/components/schemas/ComboChartSortConfiguration' + Legend: + $ref: '#/components/schemas/LegendOptions' + ReferenceLines: minItems: 0 - IntegerValues: + maxItems: 20 type: array items: - type: number - maxItems: 50000 - minItems: 0 - DecimalValues: - type: array - items: - type: number - maxItems: 50000 + $ref: '#/components/schemas/ReferenceLine' + ColorLabelOptions: + $ref: '#/components/schemas/ChartAxisLabelOptions' + BarDataLabels: + $ref: '#/components/schemas/DataLabelOptions' + CategoryLabelOptions: + $ref: '#/components/schemas/ChartAxisLabelOptions' + Tooltip: + $ref: '#/components/schemas/TooltipOptions' + PrimaryYAxisDisplayOptions: + $ref: '#/components/schemas/AxisDisplayOptions' + VisualPalette: + $ref: '#/components/schemas/VisualPalette' + BarsArrangement: + $ref: '#/components/schemas/BarsArrangement' + SecondaryYAxisLabelOptions: + $ref: '#/components/schemas/ChartAxisLabelOptions' + LineDataLabels: + $ref: '#/components/schemas/DataLabelOptions' + CategoryAxis: + $ref: '#/components/schemas/AxisDisplayOptions' + PrimaryYAxisLabelOptions: + $ref: '#/components/schemas/ChartAxisLabelOptions' + FieldWells: + $ref: '#/components/schemas/ComboChartFieldWells' + SecondaryYAxisDisplayOptions: + $ref: '#/components/schemas/AxisDisplayOptions' + TreeMapFieldWells: + additionalProperties: false + type: object + properties: + TreeMapAggregatedFieldWells: + $ref: '#/components/schemas/TreeMapAggregatedFieldWells' + DateTimeHierarchy: + additionalProperties: false + type: object + properties: + HierarchyId: + minLength: 1 + type: string + maxLength: 512 + DrillDownFilters: minItems: 0 - DateTimeValues: + maxItems: 10 type: array items: - type: string - format: date-time - maxItems: 50000 - minItems: 0 + $ref: '#/components/schemas/DrillDownFilter' + required: + - HierarchyId + PercentileAggregation: additionalProperties: false - CustomValuesConfiguration: type: object properties: - IncludeNullValue: - type: boolean - CustomValues: - $ref: '#/components/schemas/CustomParameterValues' - required: - - CustomValues + PercentileValue: + maximum: 100 + type: number + minimum: 0 + WaterfallChartGroupColorConfiguration: additionalProperties: false - DataBarsOptions: type: object properties: - FieldId: - type: string - maxLength: 512 - minLength: 1 - PositiveColor: + NegativeBarColor: + pattern: ^#[A-F0-9]{6}$ type: string + TotalBarColor: pattern: ^#[A-F0-9]{6}$ - NegativeColor: type: string + PositiveBarColor: pattern: ^#[A-F0-9]{6}$ - required: - - FieldId + type: string + FunnelChartFieldWells: additionalProperties: false - DataColor: type: object properties: - Color: - type: string - pattern: ^#[A-F0-9]{6}$ - DataValue: - type: number - default: null + FunnelChartAggregatedFieldWells: + $ref: '#/components/schemas/FunnelChartAggregatedFieldWells' + StringParameterDeclaration: additionalProperties: false - DataFieldSeriesItem: type: object properties: - FieldId: - type: string - maxLength: 512 + MappedDataSetParameters: + minItems: 0 + maxItems: 150 + type: array + items: + $ref: '#/components/schemas/MappedDataSetParameter' + DefaultValues: + $ref: '#/components/schemas/StringDefaultValues' + ParameterValueType: + $ref: '#/components/schemas/ParameterValueType' + ValueWhenUnset: + $ref: '#/components/schemas/StringValueWhenUnsetConfiguration' + Name: minLength: 1 - FieldValue: + pattern: ^[a-zA-Z0-9]+$ type: string - AxisBinding: - $ref: '#/components/schemas/AxisBinding' - Settings: - $ref: '#/components/schemas/LineChartSeriesSettings' + maxLength: 2048 required: - - AxisBinding - - FieldId - additionalProperties: false - DataLabelContent: - type: string - enum: - - VALUE - - PERCENT - - VALUE_AND_PERCENT + - Name + - ParameterValueType DataLabelOptions: + additionalProperties: false type: object properties: - Visibility: - $ref: '#/components/schemas/Visibility' - CategoryLabelVisibility: - $ref: '#/components/schemas/Visibility' - MeasureLabelVisibility: - $ref: '#/components/schemas/Visibility' DataLabelTypes: + minItems: 0 + maxItems: 100 type: array items: $ref: '#/components/schemas/DataLabelType' - maxItems: 100 - minItems: 0 + MeasureLabelVisibility: + $ref: '#/components/schemas/Visibility' Position: $ref: '#/components/schemas/DataLabelPosition' LabelContent: $ref: '#/components/schemas/DataLabelContent' - LabelFontConfiguration: - $ref: '#/components/schemas/FontConfiguration' - LabelColor: - type: string - pattern: ^#[A-F0-9]{6}$ + Visibility: + $ref: '#/components/schemas/Visibility' + TotalsVisibility: + $ref: '#/components/schemas/Visibility' Overlap: $ref: '#/components/schemas/DataLabelOverlap' - TotalsVisibility: + CategoryLabelVisibility: $ref: '#/components/schemas/Visibility' + LabelColor: + pattern: ^#[A-F0-9]{6}$ + type: string + LabelFontConfiguration: + $ref: '#/components/schemas/FontConfiguration' + TreeMapConfiguration: additionalProperties: false - DataLabelOverlap: - type: string - enum: - - DISABLE_OVERLAP - - ENABLE_OVERLAP - DataLabelPosition: - type: string - enum: - - INSIDE - - OUTSIDE - - LEFT - - TOP - - BOTTOM - - RIGHT - DataLabelType: type: object properties: - FieldLabelType: - $ref: '#/components/schemas/FieldLabelType' - DataPathLabelType: - $ref: '#/components/schemas/DataPathLabelType' - RangeEndsLabelType: - $ref: '#/components/schemas/RangeEndsLabelType' - MinimumLabelType: - $ref: '#/components/schemas/MinimumLabelType' - MaximumLabelType: - $ref: '#/components/schemas/MaximumLabelType' + SortConfiguration: + $ref: '#/components/schemas/TreeMapSortConfiguration' + Legend: + $ref: '#/components/schemas/LegendOptions' + DataLabels: + $ref: '#/components/schemas/DataLabelOptions' + ColorLabelOptions: + $ref: '#/components/schemas/ChartAxisLabelOptions' + SizeLabelOptions: + $ref: '#/components/schemas/ChartAxisLabelOptions' + FieldWells: + $ref: '#/components/schemas/TreeMapFieldWells' + Tooltip: + $ref: '#/components/schemas/TooltipOptions' + ColorScale: + $ref: '#/components/schemas/ColorScale' + GroupLabelOptions: + $ref: '#/components/schemas/ChartAxisLabelOptions' + FontSize: additionalProperties: false - DataPathColor: type: object properties: - Element: - $ref: '#/components/schemas/DataPathValue' - Color: - type: string - pattern: ^#[A-F0-9]{6}$ - TimeGranularity: - $ref: '#/components/schemas/TimeGranularity' - required: - - Color - - Element + Relative: + $ref: '#/components/schemas/RelativeFontSize' + PivotTableFieldCollapseStateTarget: additionalProperties: false - DataPathLabelType: type: object properties: FieldId: type: string - maxLength: 512 - minLength: 1 - FieldValue: - type: string - maxLength: 2048 - minLength: 0 - Visibility: - $ref: '#/components/schemas/Visibility' - additionalProperties: false - DataPathSort: - type: object - properties: - Direction: - $ref: '#/components/schemas/SortDirection' - SortPaths: + FieldDataPathValues: + minItems: 0 + maxItems: 20 type: array items: $ref: '#/components/schemas/DataPathValue' - maxItems: 20 - minItems: 0 - required: - - Direction - - SortPaths - additionalProperties: false - DataPathType: - type: object - properties: - PivotTableDataPathType: - $ref: '#/components/schemas/PivotTableDataPathType' + SheetVisualScopingConfiguration: additionalProperties: false - DataPathValue: type: object properties: - FieldId: - type: string - maxLength: 512 + Scope: + $ref: '#/components/schemas/FilterVisualScope' + SheetId: minLength: 1 - FieldValue: + pattern: ^[\w\-]+$ type: string - maxLength: 2048 - minLength: 0 - DataPathType: - $ref: '#/components/schemas/DataPathType' + maxLength: 512 + VisualIds: + minItems: 0 + maxItems: 50 + type: array + items: + minLength: 1 + pattern: ^[\w\-]+$ + type: string + maxLength: 512 + required: + - Scope + - SheetId + WidgetStatus: + type: string + enum: + - ENABLED + - DISABLED + SheetControlSliderType: + type: string + enum: + - SINGLE_POINT + - RANGE + TableBorderOptions: additionalProperties: false - DataSetIdentifierDeclaration: type: object properties: - Identifier: + Thickness: + maximum: 4 + type: number + minimum: 1 + Color: + pattern: ^#[A-F0-9]{6}$ type: string - maxLength: 2048 + Style: + $ref: '#/components/schemas/TableBorderStyle' + Icon: + type: string + enum: + - CARET_UP + - CARET_DOWN + - PLUS + - MINUS + - ARROW_UP + - ARROW_DOWN + - ARROW_LEFT + - ARROW_UP_LEFT + - ARROW_DOWN_LEFT + - ARROW_RIGHT + - ARROW_UP_RIGHT + - ARROW_DOWN_RIGHT + - FACE_UP + - FACE_DOWN + - FACE_FLAT + - ONE_BAR + - TWO_BAR + - THREE_BAR + - CIRCLE + - TRIANGLE + - SQUARE + - FLAG + - THUMBS_UP + - THUMBS_DOWN + - CHECKMARK + - X + DefaultFilterControlConfiguration: + additionalProperties: false + type: object + properties: + ControlOptions: + $ref: '#/components/schemas/DefaultFilterControlOptions' + Title: minLength: 1 - DataSetArn: type: string + maxLength: 2048 required: - - DataSetArn - - Identifier + - ControlOptions + - Title + DataBarsOptions: additionalProperties: false - DataSetReference: type: object properties: - DataSetPlaceholder: + PositiveColor: + pattern: ^#[A-F0-9]{6}$ type: string - pattern: .*\S.* - DataSetArn: + FieldId: + minLength: 1 + type: string + maxLength: 512 + NegativeColor: + pattern: ^#[A-F0-9]{6}$ type: string required: - - DataSetArn - - DataSetPlaceholder + - FieldId + TablePaginatedReportOptions: additionalProperties: false - DateAggregationFunction: - type: string - enum: - - COUNT - - DISTINCT_COUNT - - MIN - - MAX - DateAxisOptions: type: object properties: - MissingDateVisibility: + OverflowColumnHeaderVisibility: + $ref: '#/components/schemas/Visibility' + VerticalOverflowVisibility: $ref: '#/components/schemas/Visibility' + EmptyVisual: additionalProperties: false - DateDimensionField: type: object properties: - FieldId: - type: string - maxLength: 512 + VisualId: minLength: 1 - Column: - $ref: '#/components/schemas/ColumnIdentifier' - DateGranularity: - $ref: '#/components/schemas/TimeGranularity' - HierarchyId: + pattern: ^[\w\-]+$ type: string maxLength: 512 + Actions: + minItems: 0 + maxItems: 10 + type: array + items: + $ref: '#/components/schemas/VisualCustomAction' + DataSetIdentifier: minLength: 1 - FormatConfiguration: - $ref: '#/components/schemas/DateTimeFormatConfiguration' + type: string + maxLength: 2048 required: - - Column - - FieldId + - DataSetIdentifier + - VisualId + KPISparklineOptions: additionalProperties: false - DateMeasureField: type: object properties: - FieldId: + Type: + $ref: '#/components/schemas/KPISparklineType' + Color: + pattern: ^#[A-F0-9]{6}$ + type: string + TooltipVisibility: + $ref: '#/components/schemas/Visibility' + Visibility: + $ref: '#/components/schemas/Visibility' + required: + - Type + CustomFilterConfiguration: + additionalProperties: false + type: object + properties: + CategoryValue: + minLength: 0 type: string maxLength: 512 + ParameterName: minLength: 1 - Column: - $ref: '#/components/schemas/ColumnIdentifier' - AggregationFunction: - $ref: '#/components/schemas/DateAggregationFunction' - FormatConfiguration: - $ref: '#/components/schemas/DateTimeFormatConfiguration' + pattern: ^[a-zA-Z0-9]+$ + type: string + maxLength: 2048 + NullOption: + $ref: '#/components/schemas/FilterNullOption' + MatchOperator: + $ref: '#/components/schemas/CategoryFilterMatchOperator' + SelectAllOptions: + $ref: '#/components/schemas/CategoryFilterSelectAllOptions' required: - - Column - - FieldId + - MatchOperator + - NullOption + CustomContentImageScalingConfiguration: + type: string + enum: + - FIT_TO_HEIGHT + - FIT_TO_WIDTH + - DO_NOT_SCALE + - SCALE_TO_VISUAL + DecimalDefaultValues: additionalProperties: false - DateTimeDefaultValues: type: object properties: DynamicValue: $ref: '#/components/schemas/DynamicDefaultValue' StaticValues: + minItems: 0 + maxItems: 50000 type: array items: - type: string - format: date-time - maxItems: 50000 - minItems: 0 - RollingDate: - $ref: '#/components/schemas/RollingDateConfiguration' + type: number + TimeRangeFilter: additionalProperties: false - DateTimeFormatConfiguration: type: object properties: - DateTimeFormat: - type: string - maxLength: 128 + RangeMinimumValue: + $ref: '#/components/schemas/TimeRangeFilterValue' + Column: + $ref: '#/components/schemas/ColumnIdentifier' + RangeMaximumValue: + $ref: '#/components/schemas/TimeRangeFilterValue' + IncludeMaximum: + default: null + type: boolean + TimeGranularity: + $ref: '#/components/schemas/TimeGranularity' + NullOption: + $ref: '#/components/schemas/FilterNullOption' + DefaultFilterControlConfiguration: + $ref: '#/components/schemas/DefaultFilterControlConfiguration' + FilterId: minLength: 1 - NullValueFormatConfiguration: - $ref: '#/components/schemas/NullValueFormatConfiguration' - NumericFormatConfiguration: - $ref: '#/components/schemas/NumericFormatConfiguration' - additionalProperties: false - DateTimeHierarchy: - type: object - properties: - HierarchyId: + pattern: ^[\w\-]+$ type: string maxLength: 512 - minLength: 1 - DrillDownFilters: - type: array - items: - $ref: '#/components/schemas/DrillDownFilter' - maxItems: 10 - minItems: 0 + IncludeMinimum: + default: null + type: boolean + ExcludePeriodConfiguration: + $ref: '#/components/schemas/ExcludePeriodConfiguration' required: - - HierarchyId + - Column + - FilterId + - NullOption + WordCloudSortConfiguration: additionalProperties: false - DateTimeParameter: type: object properties: - Name: - type: string - pattern: .*\S.* - Values: + CategoryItemsLimit: + $ref: '#/components/schemas/ItemsLimitConfiguration' + CategorySort: + minItems: 0 + maxItems: 100 type: array items: - type: string - required: - - Name - - Values + $ref: '#/components/schemas/FieldSortOptions' + RadarChartAreaStyleSettings: additionalProperties: false - DateTimeParameterDeclaration: type: object properties: - Name: - type: string - maxLength: 2048 - minLength: 1 - pattern: ^[a-zA-Z0-9]+$ - DefaultValues: - $ref: '#/components/schemas/DateTimeDefaultValues' - TimeGranularity: - $ref: '#/components/schemas/TimeGranularity' - ValueWhenUnset: - $ref: '#/components/schemas/DateTimeValueWhenUnsetConfiguration' - MappedDataSetParameters: + Visibility: + $ref: '#/components/schemas/Visibility' + AxisDisplayDataDrivenRange: + additionalProperties: false + type: object + FilterGroup: + additionalProperties: false + type: object + properties: + Status: + $ref: '#/components/schemas/WidgetStatus' + Filters: + minItems: 0 + maxItems: 20 type: array items: - $ref: '#/components/schemas/MappedDataSetParameter' - maxItems: 150 - minItems: 0 + $ref: '#/components/schemas/Filter' + CrossDataset: + $ref: '#/components/schemas/CrossDatasetTypes' + ScopeConfiguration: + $ref: '#/components/schemas/FilterScopeConfiguration' + FilterGroupId: + minLength: 1 + pattern: ^[\w\-]+$ + type: string + maxLength: 512 required: - - Name + - CrossDataset + - FilterGroupId + - Filters + - ScopeConfiguration + FontWeight: additionalProperties: false - DateTimePickerControlDisplayOptions: type: object properties: - TitleOptions: - $ref: '#/components/schemas/LabelOptions' - DateTimeFormat: - type: string - maxLength: 128 - minLength: 1 - InfoIconLabelOptions: - $ref: '#/components/schemas/SheetControlInfoIconLabelOptions' + Name: + $ref: '#/components/schemas/FontWeightName' + TooltipItem: additionalProperties: false - DateTimeValueWhenUnsetConfiguration: type: object properties: - ValueWhenUnsetOption: - $ref: '#/components/schemas/ValueWhenUnsetOption' - CustomValue: - type: string - format: date-time + FieldTooltipItem: + $ref: '#/components/schemas/FieldTooltipItem' + ColumnTooltipItem: + $ref: '#/components/schemas/ColumnTooltipItem' + AxisDataOptions: additionalProperties: false - DayOfTheWeek: - type: string - enum: - - SUNDAY - - MONDAY - - TUESDAY - - WEDNESDAY - - THURSDAY - - FRIDAY - - SATURDAY - DecimalDefaultValues: type: object properties: - DynamicValue: - $ref: '#/components/schemas/DynamicDefaultValue' - StaticValues: - type: array - items: - type: number - maxItems: 50000 - minItems: 0 + DateAxisOptions: + $ref: '#/components/schemas/DateAxisOptions' + NumericAxisOptions: + $ref: '#/components/schemas/NumericAxisOptions' + FilterOperationSelectedFieldsConfiguration: additionalProperties: false - DecimalParameter: type: object properties: - Name: - type: string - pattern: .*\S.* - Values: + SelectedColumns: + minItems: 0 + maxItems: 10 + description:

The selected columns of a dataset.

type: array items: - type: number - default: 0 - required: - - Name - - Values - additionalProperties: false - DecimalParameterDeclaration: - type: object - properties: - ParameterValueType: - $ref: '#/components/schemas/ParameterValueType' - Name: - type: string - maxLength: 2048 - minLength: 1 - pattern: ^[a-zA-Z0-9]+$ - DefaultValues: - $ref: '#/components/schemas/DecimalDefaultValues' - ValueWhenUnset: - $ref: '#/components/schemas/DecimalValueWhenUnsetConfiguration' - MappedDataSetParameters: + $ref: '#/components/schemas/ColumnIdentifier' + SelectedFields: + minItems: 1 + maxItems: 20 type: array items: - $ref: '#/components/schemas/MappedDataSetParameter' - maxItems: 150 - minItems: 0 - required: - - Name - - ParameterValueType + minLength: 1 + type: string + maxLength: 512 + SelectedFieldOptions: + $ref: '#/components/schemas/SelectedFieldOptions' + BarsArrangement: + type: string + enum: + - CLUSTERED + - STACKED + - STACKED_PERCENT + ExcludePeriodConfiguration: additionalProperties: false - DecimalPlacesConfiguration: type: object properties: - DecimalPlaces: + Status: + $ref: '#/components/schemas/WidgetStatus' + Amount: + default: null type: number - maximum: 20 - minimum: 0 + Granularity: + $ref: '#/components/schemas/TimeGranularity' required: - - DecimalPlaces - additionalProperties: false - DecimalValueWhenUnsetConfiguration: - type: object - properties: - ValueWhenUnsetOption: - $ref: '#/components/schemas/ValueWhenUnsetOption' - CustomValue: - type: number - default: null + - Amount + - Granularity + RadarChartShape: + type: string + enum: + - CIRCLE + - POLYGON + ScrollBarOptions: additionalProperties: false - DefaultFreeFormLayoutConfiguration: type: object properties: - CanvasSizeOptions: - $ref: '#/components/schemas/FreeFormLayoutCanvasSizeOptions' - required: - - CanvasSizeOptions + VisibleRange: + $ref: '#/components/schemas/VisibleRangeOptions' + Visibility: + $ref: '#/components/schemas/Visibility' + ConditionalFormattingCustomIconOptions: additionalProperties: false - DefaultGridLayoutConfiguration: type: object properties: - CanvasSizeOptions: - $ref: '#/components/schemas/GridLayoutCanvasSizeOptions' - required: - - CanvasSizeOptions - additionalProperties: false + UnicodeIcon: + pattern: ^[^\u0000-\u00FF]$ + type: string + Icon: + $ref: '#/components/schemas/Icon' DefaultInteractiveLayoutConfiguration: + additionalProperties: false type: object properties: - Grid: - $ref: '#/components/schemas/DefaultGridLayoutConfiguration' FreeForm: $ref: '#/components/schemas/DefaultFreeFormLayoutConfiguration' + Grid: + $ref: '#/components/schemas/DefaultGridLayoutConfiguration' + LineChartSeriesSettings: additionalProperties: false - DefaultNewSheetConfiguration: type: object properties: - InteractiveLayoutConfiguration: - $ref: '#/components/schemas/DefaultInteractiveLayoutConfiguration' - PaginatedLayoutConfiguration: - $ref: '#/components/schemas/DefaultPaginatedLayoutConfiguration' - SheetContentType: - $ref: '#/components/schemas/SheetContentType' + LineStyleSettings: + $ref: '#/components/schemas/LineChartLineStyleSettings' + MarkerStyleSettings: + $ref: '#/components/schemas/LineChartMarkerStyleSettings' + SortDirection: + type: string + enum: + - ASC + - DESC + ScatterPlotConfiguration: additionalProperties: false - DefaultPaginatedLayoutConfiguration: type: object properties: - SectionBased: - $ref: '#/components/schemas/DefaultSectionBasedLayoutConfiguration' + YAxisLabelOptions: + $ref: '#/components/schemas/ChartAxisLabelOptions' + Legend: + $ref: '#/components/schemas/LegendOptions' + YAxisDisplayOptions: + $ref: '#/components/schemas/AxisDisplayOptions' + DataLabels: + $ref: '#/components/schemas/DataLabelOptions' + FieldWells: + $ref: '#/components/schemas/ScatterPlotFieldWells' + Tooltip: + $ref: '#/components/schemas/TooltipOptions' + XAxisLabelOptions: + $ref: '#/components/schemas/ChartAxisLabelOptions' + VisualPalette: + $ref: '#/components/schemas/VisualPalette' + XAxisDisplayOptions: + $ref: '#/components/schemas/AxisDisplayOptions' + CustomContentType: + type: string + enum: + - IMAGE + - OTHER_EMBEDDED_CONTENT + DefaultTextAreaControlOptions: additionalProperties: false - DefaultSectionBasedLayoutConfiguration: type: object properties: - CanvasSizeOptions: - $ref: '#/components/schemas/SectionBasedLayoutCanvasSizeOptions' - required: - - CanvasSizeOptions + Delimiter: + minLength: 1 + type: string + maxLength: 2048 + DisplayOptions: + $ref: '#/components/schemas/TextAreaControlDisplayOptions' + VisualCustomActionTrigger: + type: string + enum: + - DATA_POINT_CLICK + - DATA_POINT_MENU + SankeyDiagramAggregatedFieldWells: additionalProperties: false - DestinationParameterValueConfiguration: type: object properties: - CustomValuesConfiguration: - $ref: '#/components/schemas/CustomValuesConfiguration' - SelectAllValueOptions: - $ref: '#/components/schemas/SelectAllValueOptions' - SourceParameterName: - type: string - SourceField: - type: string - maxLength: 512 - minLength: 1 - SourceColumn: - $ref: '#/components/schemas/ColumnIdentifier' - additionalProperties: false - DimensionField: - type: object - properties: - NumericalDimensionField: - $ref: '#/components/schemas/NumericalDimensionField' - CategoricalDimensionField: - $ref: '#/components/schemas/CategoricalDimensionField' - DateDimensionField: - $ref: '#/components/schemas/DateDimensionField' - additionalProperties: false - DonutCenterOptions: - type: object - properties: - LabelVisibility: - $ref: '#/components/schemas/Visibility' - additionalProperties: false - DonutOptions: - type: object - properties: - ArcOptions: - $ref: '#/components/schemas/ArcOptions' - DonutCenterOptions: - $ref: '#/components/schemas/DonutCenterOptions' - additionalProperties: false - DrillDownFilter: - type: object - properties: - NumericEqualityFilter: - $ref: '#/components/schemas/NumericEqualityDrillDownFilter' - CategoryFilter: - $ref: '#/components/schemas/CategoryDrillDownFilter' - TimeRangeFilter: - $ref: '#/components/schemas/TimeRangeDrillDownFilter' - additionalProperties: false - DropDownControlDisplayOptions: - type: object - properties: - SelectAllOptions: - $ref: '#/components/schemas/ListControlSelectAllOptions' - TitleOptions: - $ref: '#/components/schemas/LabelOptions' - InfoIconLabelOptions: - $ref: '#/components/schemas/SheetControlInfoIconLabelOptions' - additionalProperties: false - DynamicDefaultValue: - type: object - properties: - UserNameColumn: - $ref: '#/components/schemas/ColumnIdentifier' - GroupNameColumn: - $ref: '#/components/schemas/ColumnIdentifier' - DefaultValueColumn: - $ref: '#/components/schemas/ColumnIdentifier' - required: - - DefaultValueColumn - additionalProperties: false - EmptyVisual: - type: object - properties: - VisualId: - type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - DataSetIdentifier: - type: string - maxLength: 2048 - minLength: 1 - Actions: + Destination: + minItems: 0 + maxItems: 200 type: array items: - $ref: '#/components/schemas/VisualCustomAction' - maxItems: 10 + $ref: '#/components/schemas/DimensionField' + Source: minItems: 0 - required: - - DataSetIdentifier - - VisualId - additionalProperties: false - Entity: - type: object - properties: - Path: - type: string - pattern: .*\S.* - additionalProperties: false - ExcludePeriodConfiguration: - type: object - properties: - Amount: - type: number - default: null - Granularity: - $ref: '#/components/schemas/TimeGranularity' - Status: - $ref: '#/components/schemas/WidgetStatus' - required: - - Amount - - Granularity - additionalProperties: false - ExplicitHierarchy: - type: object - properties: - HierarchyId: - type: string - maxLength: 512 - minLength: 1 - Columns: + maxItems: 200 type: array items: - $ref: '#/components/schemas/ColumnIdentifier' - maxItems: 10 - minItems: 2 - DrillDownFilters: + $ref: '#/components/schemas/DimensionField' + Weight: + minItems: 0 + maxItems: 200 type: array items: - $ref: '#/components/schemas/DrillDownFilter' - maxItems: 10 - minItems: 0 - required: - - Columns - - HierarchyId + $ref: '#/components/schemas/MeasureField' + TableConditionalFormattingOption: additionalProperties: false - FieldBasedTooltip: type: object properties: - AggregationVisibility: - $ref: '#/components/schemas/Visibility' - TooltipTitleType: - $ref: '#/components/schemas/TooltipTitleType' - TooltipFields: - type: array - items: - $ref: '#/components/schemas/TooltipItem' - maxItems: 100 - minItems: 0 + Row: + $ref: '#/components/schemas/TableRowConditionalFormatting' + Cell: + $ref: '#/components/schemas/TableCellConditionalFormatting' + ArcThickness: + type: string + enum: + - SMALL + - MEDIUM + - LARGE + - WHOLE + CalculatedMeasureField: additionalProperties: false - FieldLabelType: type: object properties: + Expression: + minLength: 1 + type: string + maxLength: 4096 FieldId: + minLength: 1 type: string maxLength: 512 - minLength: 1 - Visibility: - $ref: '#/components/schemas/Visibility' - additionalProperties: false + required: + - Expression + - FieldId FieldSeriesItem: + additionalProperties: false type: object properties: FieldId: + minLength: 1 type: string maxLength: 512 - minLength: 1 AxisBinding: $ref: '#/components/schemas/AxisBinding' Settings: @@ -2462,2614 +2480,2663 @@ components: required: - AxisBinding - FieldId + FilterDropDownControl: additionalProperties: false - FieldSort: type: object properties: - FieldId: + FilterControlId: + minLength: 1 + pattern: ^[\w\-]+$ type: string maxLength: 512 + Type: + $ref: '#/components/schemas/SheetControlListType' + DisplayOptions: + $ref: '#/components/schemas/DropDownControlDisplayOptions' + CascadingControlConfiguration: + $ref: '#/components/schemas/CascadingControlConfiguration' + Title: minLength: 1 - Direction: - $ref: '#/components/schemas/SortDirection' - required: - - Direction - - FieldId - additionalProperties: false - FieldSortOptions: - type: object - properties: - FieldSort: - $ref: '#/components/schemas/FieldSort' - ColumnSort: - $ref: '#/components/schemas/ColumnSort' - additionalProperties: false - FieldTooltipItem: - type: object - properties: - FieldId: type: string - maxLength: 512 + maxLength: 2048 + SourceFilterId: minLength: 1 - Label: + pattern: ^[\w\-]+$ type: string - Visibility: - $ref: '#/components/schemas/Visibility' + maxLength: 512 + SelectableValues: + $ref: '#/components/schemas/FilterSelectableValues' required: - - FieldId + - FilterControlId + - SourceFilterId + - Title + BoxPlotAggregatedFieldWells: additionalProperties: false - FilledMapAggregatedFieldWells: type: object properties: - Geospatial: + GroupBy: + minItems: 0 + maxItems: 1 type: array items: $ref: '#/components/schemas/DimensionField' - maxItems: 1 - minItems: 0 Values: + minItems: 0 + maxItems: 5 type: array items: $ref: '#/components/schemas/MeasureField' - maxItems: 1 - minItems: 0 + RelativeDatesFilter: additionalProperties: false - FilledMapConditionalFormatting: type: object properties: - ConditionalFormattingOptions: - type: array - items: - $ref: '#/components/schemas/FilledMapConditionalFormattingOption' - maxItems: 200 - minItems: 0 + RelativeDateValue: + default: null + type: number + Column: + $ref: '#/components/schemas/ColumnIdentifier' + RelativeDateType: + $ref: '#/components/schemas/RelativeDateType' + TimeGranularity: + $ref: '#/components/schemas/TimeGranularity' + ParameterName: + minLength: 1 + pattern: ^[a-zA-Z0-9]+$ + type: string + maxLength: 2048 + NullOption: + $ref: '#/components/schemas/FilterNullOption' + DefaultFilterControlConfiguration: + $ref: '#/components/schemas/DefaultFilterControlConfiguration' + FilterId: + minLength: 1 + pattern: ^[\w\-]+$ + type: string + maxLength: 512 + AnchorDateConfiguration: + $ref: '#/components/schemas/AnchorDateConfiguration' + MinimumGranularity: + $ref: '#/components/schemas/TimeGranularity' + ExcludePeriodConfiguration: + $ref: '#/components/schemas/ExcludePeriodConfiguration' required: - - ConditionalFormattingOptions - additionalProperties: false - FilledMapConditionalFormattingOption: - type: object - properties: - Shape: - $ref: '#/components/schemas/FilledMapShapeConditionalFormatting' - required: - - Shape + - AnchorDateConfiguration + - Column + - FilterId + - NullOption + - RelativeDateType + - TimeGranularity + ParameterControl: additionalProperties: false - FilledMapConfiguration: type: object properties: - FieldWells: - $ref: '#/components/schemas/FilledMapFieldWells' - SortConfiguration: - $ref: '#/components/schemas/FilledMapSortConfiguration' - Legend: - $ref: '#/components/schemas/LegendOptions' - Tooltip: - $ref: '#/components/schemas/TooltipOptions' - WindowOptions: - $ref: '#/components/schemas/GeospatialWindowOptions' - MapStyleOptions: - $ref: '#/components/schemas/GeospatialMapStyleOptions' + Slider: + $ref: '#/components/schemas/ParameterSliderControl' + TextArea: + $ref: '#/components/schemas/ParameterTextAreaControl' + Dropdown: + $ref: '#/components/schemas/ParameterDropDownControl' + TextField: + $ref: '#/components/schemas/ParameterTextFieldControl' + List: + $ref: '#/components/schemas/ParameterListControl' + DateTimePicker: + $ref: '#/components/schemas/ParameterDateTimePickerControl' + ReferenceLineLabelConfiguration: additionalProperties: false - FilledMapFieldWells: type: object properties: - FilledMapAggregatedFieldWells: - $ref: '#/components/schemas/FilledMapAggregatedFieldWells' + HorizontalPosition: + $ref: '#/components/schemas/ReferenceLineLabelHorizontalPosition' + ValueLabelConfiguration: + $ref: '#/components/schemas/ReferenceLineValueLabelConfiguration' + CustomLabelConfiguration: + $ref: '#/components/schemas/ReferenceLineCustomLabelConfiguration' + FontColor: + pattern: ^#[A-F0-9]{6}$ + type: string + FontConfiguration: + $ref: '#/components/schemas/FontConfiguration' + VerticalPosition: + $ref: '#/components/schemas/ReferenceLineLabelVerticalPosition' + HistogramVisual: additionalProperties: false - FilledMapShapeConditionalFormatting: type: object properties: - FieldId: + Subtitle: + $ref: '#/components/schemas/VisualSubtitleLabelOptions' + VisualId: + minLength: 1 + pattern: ^[\w\-]+$ type: string maxLength: 512 - minLength: 1 - Format: - $ref: '#/components/schemas/ShapeConditionalFormat' + ChartConfiguration: + $ref: '#/components/schemas/HistogramConfiguration' + Actions: + minItems: 0 + maxItems: 10 + type: array + items: + $ref: '#/components/schemas/VisualCustomAction' + Title: + $ref: '#/components/schemas/VisualTitleLabelOptions' required: - - FieldId + - VisualId + DateTimeValueWhenUnsetConfiguration: additionalProperties: false - FilledMapSortConfiguration: type: object properties: - CategorySort: - type: array - items: - $ref: '#/components/schemas/FieldSortOptions' - maxItems: 100 - minItems: 0 + ValueWhenUnsetOption: + $ref: '#/components/schemas/ValueWhenUnsetOption' + CustomValue: + format: date-time + type: string + PivotTableVisual: additionalProperties: false - FilledMapVisual: type: object properties: + Subtitle: + $ref: '#/components/schemas/VisualSubtitleLabelOptions' + ConditionalFormatting: + $ref: '#/components/schemas/PivotTableConditionalFormatting' VisualId: + minLength: 1 + pattern: ^[\w\-]+$ type: string maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Title: - $ref: '#/components/schemas/VisualTitleLabelOptions' - Subtitle: - $ref: '#/components/schemas/VisualSubtitleLabelOptions' ChartConfiguration: - $ref: '#/components/schemas/FilledMapConfiguration' - ConditionalFormatting: - $ref: '#/components/schemas/FilledMapConditionalFormatting' - ColumnHierarchies: - type: array - items: - $ref: '#/components/schemas/ColumnHierarchy' - maxItems: 2 - minItems: 0 + $ref: '#/components/schemas/PivotTableConfiguration' Actions: + minItems: 0 + maxItems: 10 type: array items: $ref: '#/components/schemas/VisualCustomAction' - maxItems: 10 - minItems: 0 + Title: + $ref: '#/components/schemas/VisualTitleLabelOptions' required: - VisualId + GridLayoutElement: additionalProperties: false - Filter: - type: object - properties: - CategoryFilter: - $ref: '#/components/schemas/CategoryFilter' - NumericRangeFilter: - $ref: '#/components/schemas/NumericRangeFilter' - NumericEqualityFilter: - $ref: '#/components/schemas/NumericEqualityFilter' - TimeEqualityFilter: - $ref: '#/components/schemas/TimeEqualityFilter' - TimeRangeFilter: - $ref: '#/components/schemas/TimeRangeFilter' - RelativeDatesFilter: - $ref: '#/components/schemas/RelativeDatesFilter' - TopBottomFilter: - $ref: '#/components/schemas/TopBottomFilter' - additionalProperties: false - FilterControl: - type: object - properties: - DateTimePicker: - $ref: '#/components/schemas/FilterDateTimePickerControl' - List: - $ref: '#/components/schemas/FilterListControl' - Dropdown: - $ref: '#/components/schemas/FilterDropDownControl' - TextField: - $ref: '#/components/schemas/FilterTextFieldControl' - TextArea: - $ref: '#/components/schemas/FilterTextAreaControl' - Slider: - $ref: '#/components/schemas/FilterSliderControl' - RelativeDateTime: - $ref: '#/components/schemas/FilterRelativeDateTimeControl' - additionalProperties: false - FilterDateTimePickerControl: type: object properties: - FilterControlId: - type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Title: - type: string - maxLength: 2048 + ElementType: + $ref: '#/components/schemas/LayoutElementType' + ColumnSpan: + maximum: 36 + type: number + minimum: 1 + ColumnIndex: + maximum: 35 + type: number + minimum: 0 + RowIndex: + maximum: 9009 + type: number + minimum: 0 + RowSpan: + maximum: 21 + type: number + minimum: 1 + ElementId: minLength: 1 - SourceFilterId: + pattern: ^[\w\-]+$ type: string maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - DisplayOptions: - $ref: '#/components/schemas/DateTimePickerControlDisplayOptions' - Type: - $ref: '#/components/schemas/SheetControlDateTimePickerType' required: - - FilterControlId - - SourceFilterId - - Title + - ColumnSpan + - ElementId + - ElementType + - RowSpan + FreeFormLayoutElement: additionalProperties: false - FilterDropDownControl: type: object properties: - FilterControlId: + ElementType: + $ref: '#/components/schemas/LayoutElementType' + BorderStyle: + $ref: '#/components/schemas/FreeFormLayoutElementBorderStyle' + Height: + description: String based length that is composed of value and unit in px type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Title: + Visibility: + $ref: '#/components/schemas/Visibility' + RenderingRules: + minItems: 0 + maxItems: 10000 + type: array + items: + $ref: '#/components/schemas/SheetElementRenderingRule' + YAxisLocation: + description: String based length that is composed of value and unit in px with Integer.MAX_VALUE as maximum value type: string - maxLength: 2048 - minLength: 1 - SourceFilterId: + LoadingAnimation: + $ref: '#/components/schemas/LoadingAnimation' + Width: + description: String based length that is composed of value and unit in px type: string - maxLength: 512 + BackgroundStyle: + $ref: '#/components/schemas/FreeFormLayoutElementBackgroundStyle' + ElementId: minLength: 1 - pattern: '[\w\-]+' - DisplayOptions: - $ref: '#/components/schemas/DropDownControlDisplayOptions' - Type: - $ref: '#/components/schemas/SheetControlListType' - SelectableValues: - $ref: '#/components/schemas/FilterSelectableValues' - CascadingControlConfiguration: - $ref: '#/components/schemas/CascadingControlConfiguration' - required: - - FilterControlId - - SourceFilterId - - Title - additionalProperties: false - FilterGroup: - type: object - properties: - FilterGroupId: + pattern: ^[\w\-]+$ type: string maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Filters: - type: array - items: - $ref: '#/components/schemas/Filter' - maxItems: 20 - minItems: 0 - ScopeConfiguration: - $ref: '#/components/schemas/FilterScopeConfiguration' - Status: - $ref: '#/components/schemas/WidgetStatus' - CrossDataset: - $ref: '#/components/schemas/CrossDatasetTypes' + XAxisLocation: + description: String based length that is composed of value and unit in px + type: string + SelectedBorderStyle: + $ref: '#/components/schemas/FreeFormLayoutElementBorderStyle' required: - - CrossDataset - - FilterGroupId - - Filters - - ScopeConfiguration + - ElementId + - ElementType + - Height + - Width + - XAxisLocation + - YAxisLocation + LineInterpolation: + type: string + enum: + - LINEAR + - SMOOTH + - STEPPED + CustomValuesConfiguration: additionalProperties: false - FilterListConfiguration: type: object properties: - MatchOperator: - $ref: '#/components/schemas/CategoryFilterMatchOperator' - CategoryValues: - type: array - items: - type: string - maxLength: 512 - minLength: 0 - maxItems: 100000 - minItems: 0 - SelectAllOptions: - $ref: '#/components/schemas/CategoryFilterSelectAllOptions' - NullOption: - $ref: '#/components/schemas/FilterNullOption' + IncludeNullValue: + type: boolean + CustomValues: + $ref: '#/components/schemas/CustomParameterValues' required: - - MatchOperator + - CustomValues + DefaultNewSheetConfiguration: additionalProperties: false - FilterListControl: type: object properties: - FilterControlId: - type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Title: - type: string - maxLength: 2048 - minLength: 1 - SourceFilterId: - type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - DisplayOptions: - $ref: '#/components/schemas/ListControlDisplayOptions' - Type: - $ref: '#/components/schemas/SheetControlListType' - SelectableValues: - $ref: '#/components/schemas/FilterSelectableValues' - CascadingControlConfiguration: - $ref: '#/components/schemas/CascadingControlConfiguration' - required: - - FilterControlId - - SourceFilterId - - Title + SheetContentType: + $ref: '#/components/schemas/SheetContentType' + InteractiveLayoutConfiguration: + $ref: '#/components/schemas/DefaultInteractiveLayoutConfiguration' + PaginatedLayoutConfiguration: + $ref: '#/components/schemas/DefaultPaginatedLayoutConfiguration' + GaugeChartConditionalFormatting: additionalProperties: false - FilterNullOption: - type: string - enum: - - ALL_VALUES - - NULLS_ONLY - - NON_NULLS_ONLY - FilterOperationSelectedFieldsConfiguration: type: object properties: - SelectedFields: - type: array - items: - type: string - maxLength: 512 - minLength: 1 - maxItems: 20 - minItems: 1 - SelectedFieldOptions: - $ref: '#/components/schemas/SelectedFieldOptions' - SelectedColumns: + ConditionalFormattingOptions: + minItems: 0 + maxItems: 100 type: array items: - $ref: '#/components/schemas/ColumnIdentifier' - maxItems: 10 - minItems: 0 + $ref: '#/components/schemas/GaugeChartConditionalFormattingOption' + FilledMapFieldWells: additionalProperties: false - FilterOperationTargetVisualsConfiguration: type: object properties: - SameSheetTargetVisualConfiguration: - $ref: '#/components/schemas/SameSheetTargetVisualConfiguration' + FilledMapAggregatedFieldWells: + $ref: '#/components/schemas/FilledMapAggregatedFieldWells' + AxisDisplayRange: additionalProperties: false - FilterRelativeDateTimeControl: type: object properties: - FilterControlId: + DataDriven: + $ref: '#/components/schemas/AxisDisplayDataDrivenRange' + MinMax: + $ref: '#/components/schemas/AxisDisplayMinMaxRange' + ForecastComputation: + additionalProperties: false + type: object + properties: + PeriodsBackward: + maximum: 1000 + type: number + minimum: 0 + PeriodsForward: + maximum: 1000 + type: number + minimum: 1 + PredictionInterval: + maximum: 95 + type: number + minimum: 50 + Seasonality: + $ref: '#/components/schemas/ForecastComputationSeasonality' + CustomSeasonalityValue: + default: null + maximum: 180 + type: number + minimum: 1 + Value: + $ref: '#/components/schemas/MeasureField' + Time: + $ref: '#/components/schemas/DimensionField' + UpperBoundary: + default: null + type: number + ComputationId: + minLength: 1 + pattern: ^[\w\-]+$ type: string maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Title: + Name: type: string - maxLength: 2048 - minLength: 1 - SourceFilterId: + LowerBoundary: + default: null + type: number + required: + - ComputationId + WordCloudWordPadding: + type: string + enum: + - NONE + - SMALL + - MEDIUM + - LARGE + PivotTableDataPathOption: + additionalProperties: false + type: object + properties: + DataPathList: + minItems: 0 + maxItems: 20 + type: array + items: + $ref: '#/components/schemas/DataPathValue' + Width: + description: String based length that is composed of value and unit in px type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - DisplayOptions: - $ref: '#/components/schemas/RelativeDateTimeControlDisplayOptions' required: - - FilterControlId - - SourceFilterId - - Title + - DataPathList + TextFieldControlDisplayOptions: additionalProperties: false - FilterScopeConfiguration: type: object properties: - SelectedSheets: - $ref: '#/components/schemas/SelectedSheetsFilterScopeConfiguration' - AllSheets: - $ref: '#/components/schemas/AllSheetsFilterScopeConfiguration' + TitleOptions: + $ref: '#/components/schemas/LabelOptions' + PlaceholderOptions: + $ref: '#/components/schemas/TextControlPlaceholderOptions' + InfoIconLabelOptions: + $ref: '#/components/schemas/SheetControlInfoIconLabelOptions' + AxisBinding: + type: string + enum: + - PRIMARY_YAXIS + - SECONDARY_YAXIS + PivotTableSortConfiguration: additionalProperties: false - FilterSelectableValues: type: object properties: - Values: + FieldSortOptions: + minItems: 0 + maxItems: 200 type: array items: - type: string - maxItems: 50000 - minItems: 0 + $ref: '#/components/schemas/PivotFieldSortOptions' + ReferenceLinePatternType: + type: string + enum: + - SOLID + - DASHED + - DOTTED + NumericAxisOptions: additionalProperties: false - FilterSliderControl: type: object properties: - FilterControlId: - type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Title: - type: string - maxLength: 2048 - minLength: 1 - SourceFilterId: - type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - DisplayOptions: - $ref: '#/components/schemas/SliderControlDisplayOptions' - Type: - $ref: '#/components/schemas/SheetControlSliderType' - MaximumValue: - type: number - default: 0 - MinimumValue: - type: number - default: 0 - StepSize: - type: number - default: 0 - required: - - FilterControlId - - MaximumValue - - MinimumValue - - SourceFilterId - - StepSize - - Title + Scale: + $ref: '#/components/schemas/AxisScale' + Range: + $ref: '#/components/schemas/AxisDisplayRange' + VisualCustomActionOperation: additionalProperties: false - FilterTextAreaControl: type: object properties: - FilterControlId: - type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Title: - type: string - maxLength: 2048 - minLength: 1 - SourceFilterId: - type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Delimiter: - type: string - maxLength: 2048 - minLength: 1 - DisplayOptions: - $ref: '#/components/schemas/TextAreaControlDisplayOptions' - required: - - FilterControlId - - SourceFilterId - - Title + NavigationOperation: + $ref: '#/components/schemas/CustomActionNavigationOperation' + SetParametersOperation: + $ref: '#/components/schemas/CustomActionSetParametersOperation' + FilterOperation: + $ref: '#/components/schemas/CustomActionFilterOperation' + URLOperation: + $ref: '#/components/schemas/CustomActionURLOperation' + NumericRangeFilterValue: additionalProperties: false - FilterTextFieldControl: type: object properties: - FilterControlId: - type: string - maxLength: 512 + StaticValue: + default: null + type: number + Parameter: minLength: 1 - pattern: '[\w\-]+' - Title: + pattern: ^[a-zA-Z0-9]+$ type: string maxLength: 2048 + BoxPlotVisual: + additionalProperties: false + type: object + properties: + Subtitle: + $ref: '#/components/schemas/VisualSubtitleLabelOptions' + VisualId: minLength: 1 - SourceFilterId: + pattern: ^[\w\-]+$ type: string maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - DisplayOptions: - $ref: '#/components/schemas/TextFieldControlDisplayOptions' + ChartConfiguration: + $ref: '#/components/schemas/BoxPlotChartConfiguration' + Actions: + minItems: 0 + maxItems: 10 + type: array + items: + $ref: '#/components/schemas/VisualCustomAction' + Title: + $ref: '#/components/schemas/VisualTitleLabelOptions' + ColumnHierarchies: + minItems: 0 + maxItems: 2 + type: array + items: + $ref: '#/components/schemas/ColumnHierarchy' required: - - FilterControlId - - SourceFilterId - - Title + - VisualId + CustomFilterListConfiguration: additionalProperties: false - FilterVisualScope: - type: string - enum: - - ALL_VISUALS - - SELECTED_VISUALS - FontConfiguration: type: object properties: - FontSize: - $ref: '#/components/schemas/FontSize' - FontDecoration: - $ref: '#/components/schemas/FontDecoration' - FontColor: - type: string - pattern: ^#[A-F0-9]{6}$ - FontWeight: - $ref: '#/components/schemas/FontWeight' - FontStyle: - $ref: '#/components/schemas/FontStyle' + CategoryValues: + minItems: 0 + maxItems: 100000 + type: array + items: + minLength: 0 + type: string + maxLength: 512 + NullOption: + $ref: '#/components/schemas/FilterNullOption' + MatchOperator: + $ref: '#/components/schemas/CategoryFilterMatchOperator' + SelectAllOptions: + $ref: '#/components/schemas/CategoryFilterSelectAllOptions' + required: + - MatchOperator + - NullOption + FreeFormLayoutElementBackgroundStyle: additionalProperties: false - FontDecoration: - type: string - enum: - - UNDERLINE - - NONE - FontSize: type: object properties: - Relative: - $ref: '#/components/schemas/RelativeFontSize' + Color: + pattern: ^#[A-F0-9]{6}(?:[A-F0-9]{2})?$ + type: string + Visibility: + $ref: '#/components/schemas/Visibility' + BoxPlotFieldWells: additionalProperties: false - FontStyle: - type: string - enum: - - NORMAL - - ITALIC - FontWeight: type: object properties: - Name: - $ref: '#/components/schemas/FontWeightName' + BoxPlotAggregatedFieldWells: + $ref: '#/components/schemas/BoxPlotAggregatedFieldWells' + SheetElementRenderingRule: additionalProperties: false - FontWeightName: - type: string - enum: - - NORMAL - - BOLD - ForecastComputation: type: object properties: - ComputationId: - type: string - maxLength: 512 + Expression: minLength: 1 - pattern: '[\w\-]+' - Name: type: string - Time: - $ref: '#/components/schemas/DimensionField' - Value: - $ref: '#/components/schemas/MeasureField' - PeriodsForward: - type: number - maximum: 1000 - minimum: 1 - PeriodsBackward: - type: number - maximum: 1000 - minimum: 0 - UpperBoundary: - type: number - default: null - LowerBoundary: - type: number - default: null - PredictionInterval: - type: number - maximum: 95 - minimum: 50 - Seasonality: - $ref: '#/components/schemas/ForecastComputationSeasonality' - CustomSeasonalityValue: - type: number - default: null - maximum: 180 - minimum: 1 + maxLength: 4096 + ConfigurationOverrides: + $ref: '#/components/schemas/SheetElementConfigurationOverrides' required: - - ComputationId + - ConfigurationOverrides + - Expression + TrendArrowOptions: additionalProperties: false - ForecastComputationSeasonality: - type: string - enum: - - AUTOMATIC - - CUSTOM - ForecastConfiguration: type: object properties: - ForecastProperties: - $ref: '#/components/schemas/TimeBasedForecastProperties' - Scenario: - $ref: '#/components/schemas/ForecastScenario' + Visibility: + $ref: '#/components/schemas/Visibility' + ValidationStrategy: + description:

The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. When you set this value to LENIENT, validation is skipped for specific errors.

additionalProperties: false - ForecastScenario: type: object properties: - WhatIfPointScenario: - $ref: '#/components/schemas/WhatIfPointScenario' - WhatIfRangeScenario: - $ref: '#/components/schemas/WhatIfRangeScenario' + Mode: + $ref: '#/components/schemas/ValidationStrategyMode' + required: + - Mode + ConditionalFormattingIconSetType: + type: string + enum: + - PLUS_MINUS + - CHECK_X + - THREE_COLOR_ARROW + - THREE_GRAY_ARROW + - CARET_UP_MINUS_DOWN + - THREE_SHAPE + - THREE_CIRCLE + - FLAGS + - BARS + - FOUR_COLOR_ARROW + - FOUR_GRAY_ARROW + TableCellImageSizingConfiguration: additionalProperties: false - FormatConfiguration: type: object properties: - StringFormatConfiguration: - $ref: '#/components/schemas/StringFormatConfiguration' - NumberFormatConfiguration: - $ref: '#/components/schemas/NumberFormatConfiguration' - DateTimeFormatConfiguration: - $ref: '#/components/schemas/DateTimeFormatConfiguration' + TableCellImageScalingConfiguration: + $ref: '#/components/schemas/TableCellImageScalingConfiguration' + GeospatialHeatmapConfiguration: additionalProperties: false - FreeFormLayoutCanvasSizeOptions: type: object properties: - ScreenCanvasSizeOptions: - $ref: '#/components/schemas/FreeFormLayoutScreenCanvasSizeOptions' + HeatmapColor: + $ref: '#/components/schemas/GeospatialHeatmapColorScale' + PanelTitleOptions: additionalProperties: false - FreeFormLayoutConfiguration: type: object properties: - Elements: - type: array - items: - $ref: '#/components/schemas/FreeFormLayoutElement' - maxItems: 430 - minItems: 0 - CanvasSizeOptions: - $ref: '#/components/schemas/FreeFormLayoutCanvasSizeOptions' - required: - - Elements + Visibility: + $ref: '#/components/schemas/Visibility' + FontConfiguration: + $ref: '#/components/schemas/FontConfiguration' + HorizontalTextAlignment: + $ref: '#/components/schemas/HorizontalTextAlignment' + FunnelChartAggregatedFieldWells: additionalProperties: false - FreeFormLayoutElement: type: object properties: - ElementId: - type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - ElementType: - $ref: '#/components/schemas/LayoutElementType' - XAxisLocation: - type: string - description: String based length that is composed of value and unit in px - YAxisLocation: - type: string - description: String based length that is composed of value and unit in px with Integer.MAX_VALUE as maximum value - Width: - type: string - description: String based length that is composed of value and unit in px - Height: - type: string - description: String based length that is composed of value and unit in px - Visibility: - $ref: '#/components/schemas/Visibility' - RenderingRules: + Category: + minItems: 0 + maxItems: 1 type: array items: - $ref: '#/components/schemas/SheetElementRenderingRule' - maxItems: 10000 + $ref: '#/components/schemas/DimensionField' + Values: minItems: 0 - BorderStyle: - $ref: '#/components/schemas/FreeFormLayoutElementBorderStyle' - SelectedBorderStyle: - $ref: '#/components/schemas/FreeFormLayoutElementBorderStyle' - BackgroundStyle: - $ref: '#/components/schemas/FreeFormLayoutElementBackgroundStyle' - LoadingAnimation: - $ref: '#/components/schemas/LoadingAnimation' - required: - - ElementId - - ElementType - - Height - - Width - - XAxisLocation - - YAxisLocation - additionalProperties: false - FreeFormLayoutElementBackgroundStyle: - type: object - properties: - Visibility: - $ref: '#/components/schemas/Visibility' - Color: - type: string - pattern: ^#[A-F0-9]{6}(?:[A-F0-9]{2})?$ - additionalProperties: false - FreeFormLayoutElementBorderStyle: - type: object - properties: - Visibility: - $ref: '#/components/schemas/Visibility' - Color: - type: string - pattern: ^#[A-F0-9]{6}(?:[A-F0-9]{2})?$ + maxItems: 1 + type: array + items: + $ref: '#/components/schemas/MeasureField' + SelectAllValueOptions: + type: string + enum: + - ALL_VALUES + GeospatialCoordinateBounds: additionalProperties: false - FreeFormLayoutScreenCanvasSizeOptions: type: object properties: - OptimizedViewPortWidth: - type: string - description: String based length that is composed of value and unit in px + West: + maximum: 1800 + type: number + minimum: -1800 + South: + maximum: 90 + type: number + minimum: -90 + North: + maximum: 90 + type: number + minimum: -90 + East: + maximum: 1800 + type: number + minimum: -1800 required: - - OptimizedViewPortWidth + - East + - North + - South + - West + PivotTableConditionalFormattingScopeRole: + type: string + enum: + - FIELD + - FIELD_TOTAL + - GRAND_TOTAL + BoxPlotStyleOptions: additionalProperties: false - FreeFormSectionLayoutConfiguration: type: object properties: - Elements: - type: array - items: - $ref: '#/components/schemas/FreeFormLayoutElement' - maxItems: 430 - minItems: 0 - required: - - Elements + FillStyle: + $ref: '#/components/schemas/BoxPlotFillStyle' + StringDefaultValues: additionalProperties: false - FunnelChartAggregatedFieldWells: type: object properties: - Category: - type: array - items: - $ref: '#/components/schemas/DimensionField' - maxItems: 1 + DynamicValue: + $ref: '#/components/schemas/DynamicDefaultValue' + StaticValues: minItems: 0 - Values: + maxItems: 50000 type: array items: - $ref: '#/components/schemas/MeasureField' - maxItems: 1 - minItems: 0 - additionalProperties: false - FunnelChartConfiguration: - type: object - properties: - FieldWells: - $ref: '#/components/schemas/FunnelChartFieldWells' - SortConfiguration: - $ref: '#/components/schemas/FunnelChartSortConfiguration' - CategoryLabelOptions: - $ref: '#/components/schemas/ChartAxisLabelOptions' - ValueLabelOptions: - $ref: '#/components/schemas/ChartAxisLabelOptions' - Tooltip: - $ref: '#/components/schemas/TooltipOptions' - DataLabelOptions: - $ref: '#/components/schemas/FunnelChartDataLabelOptions' - VisualPalette: - $ref: '#/components/schemas/VisualPalette' + type: string + FreeFormLayoutElementBorderStyle: additionalProperties: false - FunnelChartDataLabelOptions: type: object properties: + Color: + pattern: ^#[A-F0-9]{6}(?:[A-F0-9]{2})?$ + type: string Visibility: $ref: '#/components/schemas/Visibility' - CategoryLabelVisibility: - $ref: '#/components/schemas/Visibility' - MeasureLabelVisibility: - $ref: '#/components/schemas/Visibility' - Position: - $ref: '#/components/schemas/DataLabelPosition' - LabelFontConfiguration: - $ref: '#/components/schemas/FontConfiguration' - LabelColor: - type: string - pattern: ^#[A-F0-9]{6}$ - MeasureDataLabelStyle: - $ref: '#/components/schemas/FunnelChartMeasureDataLabelStyle' + CategoryFilter: additionalProperties: false - FunnelChartFieldWells: type: object properties: - FunnelChartAggregatedFieldWells: - $ref: '#/components/schemas/FunnelChartAggregatedFieldWells' - additionalProperties: false - FunnelChartMeasureDataLabelStyle: + Configuration: + $ref: '#/components/schemas/CategoryFilterConfiguration' + Column: + $ref: '#/components/schemas/ColumnIdentifier' + DefaultFilterControlConfiguration: + $ref: '#/components/schemas/DefaultFilterControlConfiguration' + FilterId: + minLength: 1 + pattern: ^[\w\-]+$ + type: string + maxLength: 512 + required: + - Column + - Configuration + - FilterId + VerticalTextAlignment: type: string enum: - - VALUE_ONLY - - PERCENTAGE_BY_FIRST_STAGE - - PERCENTAGE_BY_PREVIOUS_STAGE - - VALUE_AND_PERCENTAGE_BY_FIRST_STAGE - - VALUE_AND_PERCENTAGE_BY_PREVIOUS_STAGE - FunnelChartSortConfiguration: - type: object - properties: - CategorySort: - type: array - items: - $ref: '#/components/schemas/FieldSortOptions' - maxItems: 100 - minItems: 0 - CategoryItemsLimit: - $ref: '#/components/schemas/ItemsLimitConfiguration' + - TOP + - MIDDLE + - BOTTOM + - AUTO + FilterNullOption: + type: string + enum: + - ALL_VALUES + - NULLS_ONLY + - NON_NULLS_ONLY + FilledMapVisual: additionalProperties: false - FunnelChartVisual: type: object properties: + Subtitle: + $ref: '#/components/schemas/VisualSubtitleLabelOptions' + ConditionalFormatting: + $ref: '#/components/schemas/FilledMapConditionalFormatting' VisualId: + minLength: 1 + pattern: ^[\w\-]+$ type: string maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Title: - $ref: '#/components/schemas/VisualTitleLabelOptions' - Subtitle: - $ref: '#/components/schemas/VisualSubtitleLabelOptions' ChartConfiguration: - $ref: '#/components/schemas/FunnelChartConfiguration' + $ref: '#/components/schemas/FilledMapConfiguration' Actions: + minItems: 0 + maxItems: 10 type: array items: $ref: '#/components/schemas/VisualCustomAction' - maxItems: 10 - minItems: 0 + Title: + $ref: '#/components/schemas/VisualTitleLabelOptions' ColumnHierarchies: + minItems: 0 + maxItems: 2 type: array items: $ref: '#/components/schemas/ColumnHierarchy' - maxItems: 2 - minItems: 0 required: - VisualId - additionalProperties: false - GaugeChartArcConditionalFormatting: + SmallMultiplesAxisScale: + type: string + enum: + - SHARED + - INDEPENDENT + FilterSliderControl: + additionalProperties: false type: object properties: - ForegroundColor: - $ref: '#/components/schemas/ConditionalFormattingColor' + FilterControlId: + minLength: 1 + pattern: ^[\w\-]+$ + type: string + maxLength: 512 + Type: + $ref: '#/components/schemas/SheetControlSliderType' + StepSize: + default: 0 + type: number + DisplayOptions: + $ref: '#/components/schemas/SliderControlDisplayOptions' + Title: + minLength: 1 + type: string + maxLength: 2048 + MaximumValue: + default: 0 + type: number + SourceFilterId: + minLength: 1 + pattern: ^[\w\-]+$ + type: string + maxLength: 512 + MinimumValue: + default: 0 + type: number + required: + - FilterControlId + - MaximumValue + - MinimumValue + - SourceFilterId + - StepSize + - Title + PivotTableConditionalFormattingOption: additionalProperties: false - GaugeChartConditionalFormatting: type: object properties: - ConditionalFormattingOptions: - type: array - items: - $ref: '#/components/schemas/GaugeChartConditionalFormattingOption' - maxItems: 100 - minItems: 0 + Cell: + $ref: '#/components/schemas/PivotTableCellConditionalFormatting' + DataLabelOverlap: + type: string + enum: + - DISABLE_OVERLAP + - ENABLE_OVERLAP + ConditionalFormattingIconDisplayConfiguration: additionalProperties: false - GaugeChartConditionalFormattingOption: type: object properties: - PrimaryValue: - $ref: '#/components/schemas/GaugeChartPrimaryValueConditionalFormatting' - Arc: - $ref: '#/components/schemas/GaugeChartArcConditionalFormatting' + IconDisplayOption: + $ref: '#/components/schemas/ConditionalFormattingIconDisplayOption' + SelectedFieldOptions: + type: string + enum: + - ALL_FIELDS + TableFieldLinkConfiguration: additionalProperties: false - GaugeChartConfiguration: type: object properties: - FieldWells: - $ref: '#/components/schemas/GaugeChartFieldWells' - GaugeChartOptions: - $ref: '#/components/schemas/GaugeChartOptions' - DataLabels: - $ref: '#/components/schemas/DataLabelOptions' - TooltipOptions: - $ref: '#/components/schemas/TooltipOptions' - VisualPalette: - $ref: '#/components/schemas/VisualPalette' + Target: + $ref: '#/components/schemas/URLTargetConfiguration' + Content: + $ref: '#/components/schemas/TableFieldLinkContentConfiguration' + required: + - Content + - Target + GeospatialHeatmapDataColor: additionalProperties: false - GaugeChartFieldWells: type: object properties: - Values: - type: array - items: - $ref: '#/components/schemas/MeasureField' - maxItems: 200 - minItems: 0 - TargetValues: - type: array - items: - $ref: '#/components/schemas/MeasureField' - maxItems: 200 - minItems: 0 + Color: + pattern: ^#[A-F0-9]{6}$ + type: string + required: + - Color + LineChartType: + type: string + enum: + - LINE + - AREA + - STACKED_AREA + DefaultTextFieldControlOptions: additionalProperties: false - GaugeChartOptions: type: object properties: - PrimaryValueDisplayType: - $ref: '#/components/schemas/PrimaryValueDisplayType' - Comparison: - $ref: '#/components/schemas/ComparisonConfiguration' - ArcAxis: - $ref: '#/components/schemas/ArcAxisConfiguration' - Arc: - $ref: '#/components/schemas/ArcConfiguration' - PrimaryValueFontConfiguration: - $ref: '#/components/schemas/FontConfiguration' + DisplayOptions: + $ref: '#/components/schemas/TextFieldControlDisplayOptions' + TableTotalsPlacement: + type: string + enum: + - START + - END + - AUTO + LayoutConfiguration: additionalProperties: false - GaugeChartPrimaryValueConditionalFormatting: type: object properties: - TextColor: - $ref: '#/components/schemas/ConditionalFormattingColor' - Icon: - $ref: '#/components/schemas/ConditionalFormattingIcon' + GridLayout: + $ref: '#/components/schemas/GridLayoutConfiguration' + FreeFormLayout: + $ref: '#/components/schemas/FreeFormLayoutConfiguration' + SectionBasedLayout: + $ref: '#/components/schemas/SectionBasedLayoutConfiguration' + PivotFieldSortOptions: additionalProperties: false - GaugeChartVisual: type: object properties: - VisualId: + SortBy: + $ref: '#/components/schemas/PivotTableSortBy' + FieldId: + minLength: 1 type: string maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Title: - $ref: '#/components/schemas/VisualTitleLabelOptions' - Subtitle: - $ref: '#/components/schemas/VisualSubtitleLabelOptions' - ChartConfiguration: - $ref: '#/components/schemas/GaugeChartConfiguration' - ConditionalFormatting: - $ref: '#/components/schemas/GaugeChartConditionalFormatting' - Actions: - type: array - items: - $ref: '#/components/schemas/VisualCustomAction' - maxItems: 10 - minItems: 0 - required: - - VisualId - additionalProperties: false - GeospatialCoordinateBounds: - type: object - properties: - North: - type: number - maximum: 90 - minimum: -90 - South: - type: number - maximum: 90 - minimum: -90 - West: - type: number - maximum: 1800 - minimum: -1800 - East: - type: number - maximum: 1800 - minimum: -1800 required: - - East - - North - - South - - West + - FieldId + - SortBy + SimpleAttributeAggregationFunction: + type: string + enum: + - UNIQUE_VALUE + ColorScale: additionalProperties: false - GeospatialHeatmapColorScale: type: object properties: Colors: + minItems: 2 + maxItems: 3 type: array items: - $ref: '#/components/schemas/GeospatialHeatmapDataColor' - maxItems: 2 - minItems: 2 + $ref: '#/components/schemas/DataColor' + ColorFillType: + $ref: '#/components/schemas/ColorFillType' + NullValueColor: + $ref: '#/components/schemas/DataColor' + required: + - ColorFillType + - Colors + WordCloudWordOrientation: + type: string + enum: + - HORIZONTAL + - HORIZONTAL_AND_VERTICAL + GridLayoutCanvasSizeOptions: additionalProperties: false - GeospatialHeatmapConfiguration: type: object properties: - HeatmapColor: - $ref: '#/components/schemas/GeospatialHeatmapColorScale' + ScreenCanvasSizeOptions: + $ref: '#/components/schemas/GridLayoutScreenCanvasSizeOptions' + ValueWhenUnsetOption: + type: string + enum: + - RECOMMENDED_VALUE + - 'NULL' + CategoryFilterMatchOperator: + type: string + enum: + - EQUALS + - DOES_NOT_EQUAL + - CONTAINS + - DOES_NOT_CONTAIN + - STARTS_WITH + - ENDS_WITH + ConditionalFormattingIconDisplayOption: + type: string + enum: + - ICON_ONLY + KPIProgressBarConditionalFormatting: additionalProperties: false - GeospatialHeatmapDataColor: type: object properties: - Color: - type: string - pattern: ^#[A-F0-9]{6}$ - required: - - Color + ForegroundColor: + $ref: '#/components/schemas/ConditionalFormattingColor' + WaterfallChartAggregatedFieldWells: additionalProperties: false - GeospatialMapAggregatedFieldWells: type: object properties: - Geospatial: - type: array - items: - $ref: '#/components/schemas/DimensionField' - maxItems: 200 + Categories: minItems: 0 - Values: + maxItems: 200 type: array items: - $ref: '#/components/schemas/MeasureField' - maxItems: 200 + $ref: '#/components/schemas/DimensionField' + Breakdowns: minItems: 0 - Colors: + maxItems: 200 type: array items: $ref: '#/components/schemas/DimensionField' - maxItems: 200 + Values: minItems: 0 + maxItems: 200 + type: array + items: + $ref: '#/components/schemas/MeasureField' + MissingDataConfiguration: additionalProperties: false - GeospatialMapConfiguration: type: object properties: - FieldWells: - $ref: '#/components/schemas/GeospatialMapFieldWells' - Legend: - $ref: '#/components/schemas/LegendOptions' - Tooltip: - $ref: '#/components/schemas/TooltipOptions' - WindowOptions: - $ref: '#/components/schemas/GeospatialWindowOptions' - MapStyleOptions: - $ref: '#/components/schemas/GeospatialMapStyleOptions' - PointStyleOptions: - $ref: '#/components/schemas/GeospatialPointStyleOptions' - VisualPalette: - $ref: '#/components/schemas/VisualPalette' + TreatmentOption: + $ref: '#/components/schemas/MissingDataTreatmentOption' + TableCellImageScalingConfiguration: + type: string + enum: + - FIT_TO_CELL_HEIGHT + - FIT_TO_CELL_WIDTH + - DO_NOT_SCALE + HeatMapSortConfiguration: additionalProperties: false + type: object + properties: + HeatMapRowSort: + minItems: 0 + maxItems: 100 + type: array + items: + $ref: '#/components/schemas/FieldSortOptions' + HeatMapRowItemsLimitConfiguration: + $ref: '#/components/schemas/ItemsLimitConfiguration' + HeatMapColumnItemsLimitConfiguration: + $ref: '#/components/schemas/ItemsLimitConfiguration' + HeatMapColumnSort: + minItems: 0 + maxItems: 100 + type: array + items: + $ref: '#/components/schemas/FieldSortOptions' + CategoricalAggregationFunction: + type: string + enum: + - COUNT + - DISTINCT_COUNT GeospatialMapFieldWells: + additionalProperties: false type: object properties: GeospatialMapAggregatedFieldWells: $ref: '#/components/schemas/GeospatialMapAggregatedFieldWells' + SelectedSheetsFilterScopeConfiguration: additionalProperties: false - GeospatialMapStyleOptions: type: object properties: - BaseMapStyle: - $ref: '#/components/schemas/BaseMapStyleType' + SheetVisualScopingConfigurations: + minItems: 1 + maxItems: 50 + type: array + items: + $ref: '#/components/schemas/SheetVisualScopingConfiguration' + PieChartSortConfiguration: additionalProperties: false - GeospatialMapVisual: type: object properties: - VisualId: - type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Title: - $ref: '#/components/schemas/VisualTitleLabelOptions' - Subtitle: - $ref: '#/components/schemas/VisualSubtitleLabelOptions' - ChartConfiguration: - $ref: '#/components/schemas/GeospatialMapConfiguration' - ColumnHierarchies: + SmallMultiplesSort: + minItems: 0 + maxItems: 100 type: array items: - $ref: '#/components/schemas/ColumnHierarchy' - maxItems: 2 + $ref: '#/components/schemas/FieldSortOptions' + CategoryItemsLimit: + $ref: '#/components/schemas/ItemsLimitConfiguration' + CategorySort: minItems: 0 - Actions: + maxItems: 100 type: array items: - $ref: '#/components/schemas/VisualCustomAction' - maxItems: 10 - minItems: 0 + $ref: '#/components/schemas/FieldSortOptions' + SmallMultiplesLimitConfiguration: + $ref: '#/components/schemas/ItemsLimitConfiguration' + FunnelChartConfiguration: + additionalProperties: false + type: object + properties: + SortConfiguration: + $ref: '#/components/schemas/FunnelChartSortConfiguration' + DataLabelOptions: + $ref: '#/components/schemas/FunnelChartDataLabelOptions' + CategoryLabelOptions: + $ref: '#/components/schemas/ChartAxisLabelOptions' + FieldWells: + $ref: '#/components/schemas/FunnelChartFieldWells' + Tooltip: + $ref: '#/components/schemas/TooltipOptions' + ValueLabelOptions: + $ref: '#/components/schemas/ChartAxisLabelOptions' + VisualPalette: + $ref: '#/components/schemas/VisualPalette' + FilterCrossSheetControl: + additionalProperties: false + type: object + properties: + FilterControlId: + minLength: 1 + pattern: ^[\w\-]+$ + type: string + maxLength: 512 + CascadingControlConfiguration: + $ref: '#/components/schemas/CascadingControlConfiguration' + SourceFilterId: + minLength: 1 + pattern: ^[\w\-]+$ + type: string + maxLength: 512 required: - - VisualId + - FilterControlId + - SourceFilterId + TotalAggregationFunction: additionalProperties: false - GeospatialPointStyleOptions: type: object properties: - SelectedPointStyle: - $ref: '#/components/schemas/GeospatialSelectedPointStyle' - ClusterMarkerConfiguration: - $ref: '#/components/schemas/ClusterMarkerConfiguration' - HeatmapConfiguration: - $ref: '#/components/schemas/GeospatialHeatmapConfiguration' + SimpleTotalAggregationFunction: + $ref: '#/components/schemas/SimpleTotalAggregationFunction' + GaugeChartConfiguration: additionalProperties: false - GeospatialSelectedPointStyle: - type: string - enum: - - POINT - - CLUSTER - - HEATMAP - GeospatialWindowOptions: type: object properties: - Bounds: - $ref: '#/components/schemas/GeospatialCoordinateBounds' - MapZoomMode: - $ref: '#/components/schemas/MapZoomMode' + DataLabels: + $ref: '#/components/schemas/DataLabelOptions' + FieldWells: + $ref: '#/components/schemas/GaugeChartFieldWells' + TooltipOptions: + $ref: '#/components/schemas/TooltipOptions' + GaugeChartOptions: + $ref: '#/components/schemas/GaugeChartOptions' + VisualPalette: + $ref: '#/components/schemas/VisualPalette' + NumericalAggregationFunction: additionalProperties: false - GlobalTableBorderOptions: type: object properties: - UniformBorder: - $ref: '#/components/schemas/TableBorderOptions' - SideSpecificBorder: - $ref: '#/components/schemas/TableSideBorderOptions' + PercentileAggregation: + $ref: '#/components/schemas/PercentileAggregation' + SimpleNumericalAggregation: + $ref: '#/components/schemas/SimpleNumericalAggregationFunction' + CustomActionNavigationOperation: additionalProperties: false - GradientColor: type: object properties: - Stops: - type: array - items: - $ref: '#/components/schemas/GradientStop' - maxItems: 100 - minItems: 0 + LocalNavigationConfiguration: + $ref: '#/components/schemas/LocalNavigationConfiguration' + HorizontalTextAlignment: + type: string + enum: + - LEFT + - CENTER + - RIGHT + - AUTO + DecimalPlacesConfiguration: additionalProperties: false - GradientStop: type: object properties: - GradientOffset: - type: number - default: 0 - DataValue: + DecimalPlaces: + maximum: 20 type: number - default: null - Color: - type: string - pattern: ^#[A-F0-9]{6}$ + minimum: 0 required: - - GradientOffset + - DecimalPlaces + SectionBasedLayoutPaperCanvasSizeOptions: additionalProperties: false - GridLayoutCanvasSizeOptions: type: object properties: - ScreenCanvasSizeOptions: - $ref: '#/components/schemas/GridLayoutScreenCanvasSizeOptions' + PaperMargin: + $ref: '#/components/schemas/Spacing' + PaperSize: + $ref: '#/components/schemas/PaperSize' + PaperOrientation: + $ref: '#/components/schemas/PaperOrientation' + FilledMapConditionalFormatting: additionalProperties: false - GridLayoutConfiguration: type: object properties: - Elements: + ConditionalFormattingOptions: + minItems: 0 + maxItems: 200 type: array items: - $ref: '#/components/schemas/GridLayoutElement' - maxItems: 430 - minItems: 0 - CanvasSizeOptions: - $ref: '#/components/schemas/GridLayoutCanvasSizeOptions' + $ref: '#/components/schemas/FilledMapConditionalFormattingOption' required: - - Elements + - ConditionalFormattingOptions + BarChartSortConfiguration: additionalProperties: false - GridLayoutElement: type: object properties: - ElementId: - type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - ElementType: - $ref: '#/components/schemas/LayoutElementType' - ColumnIndex: - type: number - maximum: 35 - minimum: 0 - ColumnSpan: - type: number - maximum: 36 - minimum: 1 - RowIndex: - type: number - maximum: 9009 - minimum: 0 - RowSpan: - type: number - maximum: 21 - minimum: 1 - required: - - ColumnSpan - - ElementId - - ElementType - - RowSpan + SmallMultiplesSort: + minItems: 0 + maxItems: 100 + type: array + items: + $ref: '#/components/schemas/FieldSortOptions' + ColorSort: + minItems: 0 + maxItems: 100 + type: array + items: + $ref: '#/components/schemas/FieldSortOptions' + ColorItemsLimit: + $ref: '#/components/schemas/ItemsLimitConfiguration' + CategoryItemsLimit: + $ref: '#/components/schemas/ItemsLimitConfiguration' + CategorySort: + minItems: 0 + maxItems: 100 + type: array + items: + $ref: '#/components/schemas/FieldSortOptions' + SmallMultiplesLimitConfiguration: + $ref: '#/components/schemas/ItemsLimitConfiguration' + SheetElementConfigurationOverrides: additionalProperties: false - GridLayoutScreenCanvasSizeOptions: type: object properties: - ResizeOption: - $ref: '#/components/schemas/ResizeOption' - OptimizedViewPortWidth: - type: string - description: String based length that is composed of value and unit in px - required: - - ResizeOption + Visibility: + $ref: '#/components/schemas/Visibility' + DonutCenterOptions: additionalProperties: false - GrowthRateComputation: type: object properties: - ComputationId: - type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Name: - type: string - Time: - $ref: '#/components/schemas/DimensionField' - Value: - $ref: '#/components/schemas/MeasureField' - PeriodSize: - type: number - default: 0 - maximum: 52 - minimum: 2 - required: - - ComputationId + LabelVisibility: + $ref: '#/components/schemas/Visibility' + BodySectionContent: additionalProperties: false - HeaderFooterSectionConfiguration: type: object properties: - SectionId: - type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' Layout: $ref: '#/components/schemas/SectionLayoutConfiguration' - Style: - $ref: '#/components/schemas/SectionStyle' + TableRowConditionalFormatting: + additionalProperties: false + type: object + properties: + TextColor: + $ref: '#/components/schemas/ConditionalFormattingColor' + BackgroundColor: + $ref: '#/components/schemas/ConditionalFormattingColor' + PivotTableCellConditionalFormatting: + additionalProperties: false + type: object + properties: + Scope: + $ref: '#/components/schemas/PivotTableConditionalFormattingScope' + Scopes: + minItems: 0 + maxItems: 3 + type: array + items: + $ref: '#/components/schemas/PivotTableConditionalFormattingScope' + FieldId: + minLength: 1 + type: string + maxLength: 512 + TextFormat: + $ref: '#/components/schemas/TextConditionalFormat' required: - - Layout - - SectionId + - FieldId + ListControlDisplayOptions: additionalProperties: false - HeatMapAggregatedFieldWells: type: object properties: - Rows: + TitleOptions: + $ref: '#/components/schemas/LabelOptions' + SearchOptions: + $ref: '#/components/schemas/ListControlSearchOptions' + SelectAllOptions: + $ref: '#/components/schemas/ListControlSelectAllOptions' + InfoIconLabelOptions: + $ref: '#/components/schemas/SheetControlInfoIconLabelOptions' + ScatterPlotUnaggregatedFieldWells: + additionalProperties: false + type: object + properties: + Category: + minItems: 0 + maxItems: 200 type: array items: $ref: '#/components/schemas/DimensionField' - maxItems: 1 + Size: minItems: 0 - Columns: + maxItems: 200 + type: array + items: + $ref: '#/components/schemas/MeasureField' + Label: + minItems: 0 + maxItems: 200 type: array items: $ref: '#/components/schemas/DimensionField' - maxItems: 1 + XAxis: minItems: 0 - Values: + maxItems: 200 type: array items: - $ref: '#/components/schemas/MeasureField' - maxItems: 1 + $ref: '#/components/schemas/DimensionField' + YAxis: minItems: 0 + maxItems: 200 + type: array + items: + $ref: '#/components/schemas/DimensionField' + PieChartAggregatedFieldWells: additionalProperties: false - HeatMapConfiguration: - type: object - properties: - FieldWells: - $ref: '#/components/schemas/HeatMapFieldWells' - SortConfiguration: - $ref: '#/components/schemas/HeatMapSortConfiguration' - RowLabelOptions: - $ref: '#/components/schemas/ChartAxisLabelOptions' - ColumnLabelOptions: - $ref: '#/components/schemas/ChartAxisLabelOptions' - ColorScale: - $ref: '#/components/schemas/ColorScale' - Legend: - $ref: '#/components/schemas/LegendOptions' - DataLabels: - $ref: '#/components/schemas/DataLabelOptions' - Tooltip: - $ref: '#/components/schemas/TooltipOptions' - additionalProperties: false - HeatMapFieldWells: - type: object - properties: - HeatMapAggregatedFieldWells: - $ref: '#/components/schemas/HeatMapAggregatedFieldWells' - additionalProperties: false - HeatMapSortConfiguration: type: object properties: - HeatMapRowSort: + Category: + minItems: 0 + maxItems: 200 type: array items: - $ref: '#/components/schemas/FieldSortOptions' - maxItems: 100 + $ref: '#/components/schemas/DimensionField' + Values: minItems: 0 - HeatMapColumnSort: + maxItems: 200 type: array items: - $ref: '#/components/schemas/FieldSortOptions' - maxItems: 100 + $ref: '#/components/schemas/MeasureField' + SmallMultiples: minItems: 0 - HeatMapRowItemsLimitConfiguration: - $ref: '#/components/schemas/ItemsLimitConfiguration' - HeatMapColumnItemsLimitConfiguration: - $ref: '#/components/schemas/ItemsLimitConfiguration' + maxItems: 1 + type: array + items: + $ref: '#/components/schemas/DimensionField' + LineChartVisual: additionalProperties: false - HeatMapVisual: type: object properties: + Subtitle: + $ref: '#/components/schemas/VisualSubtitleLabelOptions' VisualId: + minLength: 1 + pattern: ^[\w\-]+$ type: string maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Title: - $ref: '#/components/schemas/VisualTitleLabelOptions' - Subtitle: - $ref: '#/components/schemas/VisualSubtitleLabelOptions' ChartConfiguration: - $ref: '#/components/schemas/HeatMapConfiguration' - ColumnHierarchies: - type: array - items: - $ref: '#/components/schemas/ColumnHierarchy' - maxItems: 2 - minItems: 0 + $ref: '#/components/schemas/LineChartConfiguration' Actions: + minItems: 0 + maxItems: 10 type: array items: $ref: '#/components/schemas/VisualCustomAction' - maxItems: 10 + Title: + $ref: '#/components/schemas/VisualTitleLabelOptions' + ColumnHierarchies: minItems: 0 + maxItems: 2 + type: array + items: + $ref: '#/components/schemas/ColumnHierarchy' required: - VisualId + ScatterPlotFieldWells: additionalProperties: false - HistogramAggregatedFieldWells: type: object properties: - Values: - type: array - items: - $ref: '#/components/schemas/MeasureField' - maxItems: 1 - minItems: 0 + ScatterPlotUnaggregatedFieldWells: + $ref: '#/components/schemas/ScatterPlotUnaggregatedFieldWells' + ScatterPlotCategoricallyAggregatedFieldWells: + $ref: '#/components/schemas/ScatterPlotCategoricallyAggregatedFieldWells' + FontStyle: + type: string + enum: + - NORMAL + - ITALIC + BarChartOrientation: + type: string + enum: + - HORIZONTAL + - VERTICAL + DataColor: additionalProperties: false - HistogramBinOptions: type: object properties: - SelectedBinType: - $ref: '#/components/schemas/HistogramBinType' - BinCount: - $ref: '#/components/schemas/BinCountOptions' - BinWidth: - $ref: '#/components/schemas/BinWidthOptions' - StartValue: - type: number + DataValue: default: null + type: number + Color: + pattern: ^#[A-F0-9]{6}$ + type: string + SetParameterValueConfiguration: additionalProperties: false - HistogramBinType: + type: object + properties: + DestinationParameterName: + minLength: 1 + pattern: ^[a-zA-Z0-9]+$ + type: string + maxLength: 2048 + Value: + $ref: '#/components/schemas/DestinationParameterValueConfiguration' + required: + - DestinationParameterName + - Value + KPISparklineType: type: string enum: - - BIN_COUNT - - BIN_WIDTH - HistogramConfiguration: + - LINE + - AREA + BoxPlotChartConfiguration: + additionalProperties: false type: object properties: - FieldWells: - $ref: '#/components/schemas/HistogramFieldWells' - XAxisDisplayOptions: + SortConfiguration: + $ref: '#/components/schemas/BoxPlotSortConfiguration' + Legend: + $ref: '#/components/schemas/LegendOptions' + ReferenceLines: + minItems: 0 + maxItems: 20 + type: array + items: + $ref: '#/components/schemas/ReferenceLine' + CategoryAxis: $ref: '#/components/schemas/AxisDisplayOptions' - XAxisLabelOptions: + PrimaryYAxisLabelOptions: $ref: '#/components/schemas/ChartAxisLabelOptions' - YAxisDisplayOptions: - $ref: '#/components/schemas/AxisDisplayOptions' - BinOptions: - $ref: '#/components/schemas/HistogramBinOptions' - DataLabels: - $ref: '#/components/schemas/DataLabelOptions' + CategoryLabelOptions: + $ref: '#/components/schemas/ChartAxisLabelOptions' + FieldWells: + $ref: '#/components/schemas/BoxPlotFieldWells' Tooltip: $ref: '#/components/schemas/TooltipOptions' + BoxPlotOptions: + $ref: '#/components/schemas/BoxPlotOptions' + PrimaryYAxisDisplayOptions: + $ref: '#/components/schemas/AxisDisplayOptions' VisualPalette: $ref: '#/components/schemas/VisualPalette' + TimeRangeDrillDownFilter: additionalProperties: false - HistogramFieldWells: type: object properties: - HistogramAggregatedFieldWells: - $ref: '#/components/schemas/HistogramAggregatedFieldWells' + Column: + $ref: '#/components/schemas/ColumnIdentifier' + RangeMinimum: + format: date-time + type: string + TimeGranularity: + $ref: '#/components/schemas/TimeGranularity' + RangeMaximum: + format: date-time + type: string + required: + - Column + - RangeMaximum + - RangeMinimum + - TimeGranularity + DataFieldSeriesItem: additionalProperties: false - HistogramVisual: type: object properties: - VisualId: + FieldId: + minLength: 1 type: string maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Title: - $ref: '#/components/schemas/VisualTitleLabelOptions' - Subtitle: - $ref: '#/components/schemas/VisualSubtitleLabelOptions' - ChartConfiguration: - $ref: '#/components/schemas/HistogramConfiguration' - Actions: - type: array - items: - $ref: '#/components/schemas/VisualCustomAction' - maxItems: 10 - minItems: 0 + AxisBinding: + $ref: '#/components/schemas/AxisBinding' + FieldValue: + type: string + Settings: + $ref: '#/components/schemas/LineChartSeriesSettings' required: - - VisualId + - AxisBinding + - FieldId + BinWidthOptions: additionalProperties: false - HorizontalTextAlignment: + type: object + properties: + BinCountLimit: + maximum: 1000 + type: number + minimum: 0 + Value: + type: number + minimum: 0 + CascadingControlSource: + additionalProperties: false + type: object + properties: + SourceSheetControlId: + type: string + ColumnToMatch: + $ref: '#/components/schemas/ColumnIdentifier' + TableOptions: + additionalProperties: false + type: object + properties: + HeaderStyle: + $ref: '#/components/schemas/TableCellStyle' + CellStyle: + $ref: '#/components/schemas/TableCellStyle' + Orientation: + $ref: '#/components/schemas/TableOrientation' + RowAlternateColorOptions: + $ref: '#/components/schemas/RowAlternateColorOptions' + ColumnConfiguration: + additionalProperties: false + type: object + properties: + Role: + $ref: '#/components/schemas/ColumnRole' + FormatConfiguration: + $ref: '#/components/schemas/FormatConfiguration' + Column: + $ref: '#/components/schemas/ColumnIdentifier' + ColorsConfiguration: + $ref: '#/components/schemas/ColorsConfiguration' + required: + - Column + ListControlSelectAllOptions: + additionalProperties: false + type: object + properties: + Visibility: + $ref: '#/components/schemas/Visibility' + NumericFilterSelectAllOptions: type: string enum: - - LEFT - - CENTER - - RIGHT - - AUTO - Icon: + - FILTER_ALL_VALUES + TableFieldIconSetType: type: string enum: - - CARET_UP - - CARET_DOWN - - PLUS - - MINUS - - ARROW_UP - - ARROW_DOWN - - ARROW_LEFT - - ARROW_UP_LEFT - - ARROW_DOWN_LEFT - - ARROW_RIGHT - - ARROW_UP_RIGHT - - ARROW_DOWN_RIGHT - - FACE_UP - - FACE_DOWN - - FACE_FLAT - - ONE_BAR - - TWO_BAR - - THREE_BAR - - CIRCLE - - TRIANGLE - - SQUARE - - FLAG - - THUMBS_UP - - THUMBS_DOWN - - CHECKMARK - - X - InsightConfiguration: + - LINK + ProgressBarOptions: + additionalProperties: false type: object properties: - Computations: - type: array - items: - $ref: '#/components/schemas/Computation' - maxItems: 100 - minItems: 0 - CustomNarrative: - $ref: '#/components/schemas/CustomNarrativeOptions' + Visibility: + $ref: '#/components/schemas/Visibility' + SheetControlLayoutConfiguration: additionalProperties: false - InsightVisual: type: object properties: - VisualId: + GridLayout: + $ref: '#/components/schemas/GridLayoutConfiguration' + ResourcePermission: + type: object + description:

Permission for the resource.

+ properties: + Principal: type: string - maxLength: 512 + maxLength: 256 minLength: 1 - pattern: '[\w\-]+' - Title: - $ref: '#/components/schemas/VisualTitleLabelOptions' - Subtitle: - $ref: '#/components/schemas/VisualSubtitleLabelOptions' - InsightConfiguration: - $ref: '#/components/schemas/InsightConfiguration' + description: |- +

The Amazon Resource Name (ARN) of the principal. This can be one of the + following:

+
    +
  • +

    The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)

    +
    • +
  • +

    The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)

    +
    • +
  • +

    The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight + ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. + (This is less common.)

    +
    • +
Actions: type: array items: - $ref: '#/components/schemas/VisualCustomAction' - maxItems: 10 - minItems: 0 - DataSetIdentifier: - type: string - maxLength: 2048 - minLength: 1 + type: string + maxItems: 20 + minItems: 1 + description:

The IAM action to grant or revoke permissions on.

required: - - DataSetIdentifier - - VisualId + - Actions + - Principal additionalProperties: false - IntegerDefaultValues: - type: object - properties: - DynamicValue: - $ref: '#/components/schemas/DynamicDefaultValue' - StaticValues: - type: array - items: - type: number - maxItems: 50000 - minItems: 0 + SubtotalOptions: additionalProperties: false - IntegerParameter: type: object properties: - Name: + CustomLabel: type: string - pattern: .*\S.* - Values: + FieldLevelOptions: + minItems: 0 + maxItems: 100 type: array items: - type: number - default: 0 - required: - - Name - - Values + $ref: '#/components/schemas/PivotTableFieldSubtotalOptions' + ValueCellStyle: + $ref: '#/components/schemas/TableCellStyle' + TotalCellStyle: + $ref: '#/components/schemas/TableCellStyle' + TotalsVisibility: + $ref: '#/components/schemas/Visibility' + FieldLevel: + $ref: '#/components/schemas/PivotTableSubtotalLevel' + MetricHeaderCellStyle: + $ref: '#/components/schemas/TableCellStyle' + StyleTargets: + minItems: 0 + maxItems: 3 + type: array + items: + $ref: '#/components/schemas/TableStyleTarget' + PivotTablePaginatedReportOptions: additionalProperties: false - IntegerParameterDeclaration: type: object properties: - ParameterValueType: - $ref: '#/components/schemas/ParameterValueType' - Name: - type: string - maxLength: 2048 - minLength: 1 - pattern: ^[a-zA-Z0-9]+$ - DefaultValues: - $ref: '#/components/schemas/IntegerDefaultValues' - ValueWhenUnset: - $ref: '#/components/schemas/IntegerValueWhenUnsetConfiguration' - MappedDataSetParameters: - type: array - items: - $ref: '#/components/schemas/MappedDataSetParameter' - maxItems: 150 - minItems: 0 - required: - - Name - - ParameterValueType + OverflowColumnHeaderVisibility: + $ref: '#/components/schemas/Visibility' + VerticalOverflowVisibility: + $ref: '#/components/schemas/Visibility' + TableOrientation: + type: string + enum: + - VERTICAL + - HORIZONTAL + ClusterMarker: additionalProperties: false - IntegerValueWhenUnsetConfiguration: type: object properties: - ValueWhenUnsetOption: - $ref: '#/components/schemas/ValueWhenUnsetOption' - CustomValue: - type: number - default: null + SimpleClusterMarker: + $ref: '#/components/schemas/SimpleClusterMarker' + FunnelChartMeasureDataLabelStyle: + type: string + enum: + - VALUE_ONLY + - PERCENTAGE_BY_FIRST_STAGE + - PERCENTAGE_BY_PREVIOUS_STAGE + - VALUE_AND_PERCENTAGE_BY_FIRST_STAGE + - VALUE_AND_PERCENTAGE_BY_PREVIOUS_STAGE + ParameterValueType: + type: string + enum: + - MULTI_VALUED + - SINGLE_VALUED + ParameterSelectableValues: additionalProperties: false - ItemsLimitConfiguration: type: object properties: - ItemsLimit: - type: number - default: null - OtherCategories: - $ref: '#/components/schemas/OtherCategories' + LinkToDataSetColumn: + $ref: '#/components/schemas/ColumnIdentifier' + Values: + minItems: 0 + maxItems: 50000 + type: array + items: + type: string + SectionLayoutConfiguration: additionalProperties: false - KPIActualValueConditionalFormatting: type: object properties: - TextColor: - $ref: '#/components/schemas/ConditionalFormattingColor' - Icon: - $ref: '#/components/schemas/ConditionalFormattingIcon' + FreeFormLayout: + $ref: '#/components/schemas/FreeFormSectionLayoutConfiguration' + required: + - FreeFormLayout + SheetControlLayout: additionalProperties: false - KPIComparisonValueConditionalFormatting: type: object properties: - TextColor: - $ref: '#/components/schemas/ConditionalFormattingColor' - Icon: - $ref: '#/components/schemas/ConditionalFormattingIcon' + Configuration: + $ref: '#/components/schemas/SheetControlLayoutConfiguration' + required: + - Configuration + FontWeightName: + type: string + enum: + - NORMAL + - BOLD + HeatMapFieldWells: additionalProperties: false - KPIConditionalFormatting: type: object properties: - ConditionalFormattingOptions: - type: array - items: - $ref: '#/components/schemas/KPIConditionalFormattingOption' - maxItems: 100 - minItems: 0 + HeatMapAggregatedFieldWells: + $ref: '#/components/schemas/HeatMapAggregatedFieldWells' + PercentVisibleRange: additionalProperties: false - KPIConditionalFormattingOption: type: object properties: - PrimaryValue: - $ref: '#/components/schemas/KPIPrimaryValueConditionalFormatting' - ProgressBar: - $ref: '#/components/schemas/KPIProgressBarConditionalFormatting' - ActualValue: - $ref: '#/components/schemas/KPIActualValueConditionalFormatting' - ComparisonValue: - $ref: '#/components/schemas/KPIComparisonValueConditionalFormatting' + From: + default: null + maximum: 100 + type: number + minimum: 0 + To: + default: null + maximum: 100 + type: number + minimum: 0 + PivotTableMetricPlacement: + type: string + enum: + - ROW + - COLUMN + Computation: additionalProperties: false - KPIConfiguration: type: object properties: - FieldWells: - $ref: '#/components/schemas/KPIFieldWells' - SortConfiguration: - $ref: '#/components/schemas/KPISortConfiguration' - KPIOptions: - $ref: '#/components/schemas/KPIOptions' + PeriodToDate: + $ref: '#/components/schemas/PeriodToDateComputation' + GrowthRate: + $ref: '#/components/schemas/GrowthRateComputation' + TopBottomRanked: + $ref: '#/components/schemas/TopBottomRankedComputation' + TotalAggregation: + $ref: '#/components/schemas/TotalAggregationComputation' + Forecast: + $ref: '#/components/schemas/ForecastComputation' + MaximumMinimum: + $ref: '#/components/schemas/MaximumMinimumComputation' + PeriodOverPeriod: + $ref: '#/components/schemas/PeriodOverPeriodComputation' + MetricComparison: + $ref: '#/components/schemas/MetricComparisonComputation' + TopBottomMovers: + $ref: '#/components/schemas/TopBottomMoversComputation' + UniqueValues: + $ref: '#/components/schemas/UniqueValuesComputation' + RelativeFontSize: + type: string + enum: + - EXTRA_SMALL + - SMALL + - MEDIUM + - LARGE + - EXTRA_LARGE + CascadingControlConfiguration: additionalProperties: false - KPIFieldWells: type: object properties: - Values: - type: array - items: - $ref: '#/components/schemas/MeasureField' - maxItems: 200 + SourceControls: minItems: 0 - TargetValues: - type: array - items: - $ref: '#/components/schemas/MeasureField' maxItems: 200 - minItems: 0 - TrendGroups: type: array items: - $ref: '#/components/schemas/DimensionField' - maxItems: 200 - minItems: 0 - additionalProperties: false - KPIOptions: - type: object - properties: - ProgressBar: - $ref: '#/components/schemas/ProgressBarOptions' - TrendArrows: - $ref: '#/components/schemas/TrendArrowOptions' - SecondaryValue: - $ref: '#/components/schemas/SecondaryValueOptions' - Comparison: - $ref: '#/components/schemas/ComparisonConfiguration' - PrimaryValueDisplayType: - $ref: '#/components/schemas/PrimaryValueDisplayType' - PrimaryValueFontConfiguration: - $ref: '#/components/schemas/FontConfiguration' - SecondaryValueFontConfiguration: - $ref: '#/components/schemas/FontConfiguration' - Sparkline: - $ref: '#/components/schemas/KPISparklineOptions' - VisualLayoutOptions: - $ref: '#/components/schemas/KPIVisualLayoutOptions' + $ref: '#/components/schemas/CascadingControlSource' + LineChartLineStyle: + type: string + enum: + - SOLID + - DOTTED + - DASHED + Visibility: + type: string + enum: + - HIDDEN + - VISIBLE + ComparisonMethod: + type: string + enum: + - DIFFERENCE + - PERCENT_DIFFERENCE + - PERCENT + CustomColor: additionalProperties: false - KPIPrimaryValueConditionalFormatting: type: object properties: - TextColor: - $ref: '#/components/schemas/ConditionalFormattingColor' - Icon: - $ref: '#/components/schemas/ConditionalFormattingIcon' - additionalProperties: false - KPIProgressBarConditionalFormatting: - type: object + Color: + pattern: ^#[A-F0-9]{6}$ + type: string + FieldValue: + minLength: 0 + type: string + maxLength: 2048 + SpecialValue: + $ref: '#/components/schemas/SpecialValue' + required: + - Color + SpecialValue: + type: string + enum: + - EMPTY + - 'NULL' + - OTHER + DefaultSliderControlOptions: + additionalProperties: false + type: object properties: - ForegroundColor: - $ref: '#/components/schemas/ConditionalFormattingColor' + Type: + $ref: '#/components/schemas/SheetControlSliderType' + StepSize: + default: 0 + type: number + DisplayOptions: + $ref: '#/components/schemas/SliderControlDisplayOptions' + MaximumValue: + default: 0 + type: number + MinimumValue: + default: 0 + type: number + required: + - MaximumValue + - MinimumValue + - StepSize + WaterfallChartColorConfiguration: additionalProperties: false - KPISortConfiguration: type: object properties: - TrendGroupSort: - type: array - items: - $ref: '#/components/schemas/FieldSortOptions' - maxItems: 100 - minItems: 0 + GroupColorConfiguration: + $ref: '#/components/schemas/WaterfallChartGroupColorConfiguration' + ParameterListControl: additionalProperties: false - KPISparklineOptions: type: object properties: - Visibility: - $ref: '#/components/schemas/Visibility' + ParameterControlId: + minLength: 1 + pattern: ^[\w\-]+$ + type: string + maxLength: 512 Type: - $ref: '#/components/schemas/KPISparklineType' - Color: + $ref: '#/components/schemas/SheetControlListType' + DisplayOptions: + $ref: '#/components/schemas/ListControlDisplayOptions' + SourceParameterName: + minLength: 1 + pattern: ^[a-zA-Z0-9]+$ type: string - pattern: ^#[A-F0-9]{6}$ - TooltipVisibility: - $ref: '#/components/schemas/Visibility' + maxLength: 2048 + CascadingControlConfiguration: + $ref: '#/components/schemas/CascadingControlConfiguration' + Title: + minLength: 1 + type: string + maxLength: 2048 + SelectableValues: + $ref: '#/components/schemas/ParameterSelectableValues' required: - - Type + - ParameterControlId + - SourceParameterName + - Title + ParameterDateTimePickerControl: additionalProperties: false - KPISparklineType: - type: string - enum: - - LINE - - AREA - KPIVisual: type: object properties: - VisualId: + ParameterControlId: + minLength: 1 + pattern: ^[\w\-]+$ type: string maxLength: 512 + DisplayOptions: + $ref: '#/components/schemas/DateTimePickerControlDisplayOptions' + SourceParameterName: minLength: 1 - pattern: '[\w\-]+' + pattern: ^[a-zA-Z0-9]+$ + type: string + maxLength: 2048 Title: - $ref: '#/components/schemas/VisualTitleLabelOptions' - Subtitle: - $ref: '#/components/schemas/VisualSubtitleLabelOptions' - ChartConfiguration: - $ref: '#/components/schemas/KPIConfiguration' - ConditionalFormatting: - $ref: '#/components/schemas/KPIConditionalFormatting' - Actions: - type: array - items: - $ref: '#/components/schemas/VisualCustomAction' - maxItems: 10 + minLength: 1 + type: string + maxLength: 2048 + required: + - ParameterControlId + - SourceParameterName + - Title + TreeMapSortConfiguration: + additionalProperties: false + type: object + properties: + TreeMapSort: minItems: 0 - ColumnHierarchies: + maxItems: 100 type: array items: - $ref: '#/components/schemas/ColumnHierarchy' - maxItems: 2 - minItems: 0 - required: - - VisualId + $ref: '#/components/schemas/FieldSortOptions' + TreeMapGroupItemsLimitConfiguration: + $ref: '#/components/schemas/ItemsLimitConfiguration' + LineChartFieldWells: additionalProperties: false - KPIVisualLayoutOptions: type: object properties: - StandardLayout: - $ref: '#/components/schemas/KPIVisualStandardLayout' + LineChartAggregatedFieldWells: + $ref: '#/components/schemas/LineChartAggregatedFieldWells' + RadarChartSeriesSettings: additionalProperties: false - KPIVisualStandardLayout: type: object properties: - Type: - $ref: '#/components/schemas/KPIVisualStandardLayoutType' - required: - - Type - additionalProperties: false - KPIVisualStandardLayoutType: + AreaStyleSettings: + $ref: '#/components/schemas/RadarChartAreaStyleSettings' + NumberScale: type: string enum: - - CLASSIC - - VERTICAL - LabelOptions: + - NONE + - AUTO + - THOUSANDS + - MILLIONS + - BILLIONS + - TRILLIONS + BoxPlotSortConfiguration: + additionalProperties: false type: object properties: - Visibility: - $ref: '#/components/schemas/Visibility' - FontConfiguration: - $ref: '#/components/schemas/FontConfiguration' - CustomLabel: - type: string + CategorySort: + minItems: 0 + maxItems: 100 + type: array + items: + $ref: '#/components/schemas/FieldSortOptions' + PaginationConfiguration: + $ref: '#/components/schemas/PaginationConfiguration' + CategoryDrillDownFilter: additionalProperties: false - Layout: type: object properties: - Configuration: - $ref: '#/components/schemas/LayoutConfiguration' + Column: + $ref: '#/components/schemas/ColumnIdentifier' + CategoryValues: + minItems: 0 + maxItems: 100000 + type: array + items: + minLength: 0 + type: string + maxLength: 512 required: - - Configuration + - CategoryValues + - Column + PivotTableFieldCollapseStateOption: additionalProperties: false - LayoutConfiguration: type: object properties: - GridLayout: - $ref: '#/components/schemas/GridLayoutConfiguration' - FreeFormLayout: - $ref: '#/components/schemas/FreeFormLayoutConfiguration' - SectionBasedLayout: - $ref: '#/components/schemas/SectionBasedLayoutConfiguration' + Target: + $ref: '#/components/schemas/PivotTableFieldCollapseStateTarget' + State: + $ref: '#/components/schemas/PivotTableFieldCollapseState' + required: + - Target + GridLayoutScreenCanvasSizeOptions: additionalProperties: false - LayoutElementType: - type: string - enum: - - VISUAL - - FILTER_CONTROL - - PARAMETER_CONTROL - - TEXT_BOX - LegendOptions: type: object properties: - Visibility: - $ref: '#/components/schemas/Visibility' - Title: - $ref: '#/components/schemas/LabelOptions' - Position: - $ref: '#/components/schemas/LegendPosition' - Width: - type: string + OptimizedViewPortWidth: description: String based length that is composed of value and unit in px - Height: type: string - description: String based length that is composed of value and unit in px + ResizeOption: + $ref: '#/components/schemas/ResizeOption' + required: + - ResizeOption + SankeyDiagramChartConfiguration: additionalProperties: false - LegendPosition: - type: string - enum: - - AUTO - - RIGHT - - BOTTOM - - TOP - LineChartAggregatedFieldWells: type: object properties: - Category: + SortConfiguration: + $ref: '#/components/schemas/SankeyDiagramSortConfiguration' + DataLabels: + $ref: '#/components/schemas/DataLabelOptions' + FieldWells: + $ref: '#/components/schemas/SankeyDiagramFieldWells' + WordCloudVisual: + additionalProperties: false + type: object + properties: + Subtitle: + $ref: '#/components/schemas/VisualSubtitleLabelOptions' + VisualId: + minLength: 1 + pattern: ^[\w\-]+$ + type: string + maxLength: 512 + ChartConfiguration: + $ref: '#/components/schemas/WordCloudChartConfiguration' + Actions: + minItems: 0 + maxItems: 10 type: array items: - $ref: '#/components/schemas/DimensionField' - maxItems: 200 - minItems: 0 - Values: - type: array - items: - $ref: '#/components/schemas/MeasureField' - maxItems: 200 + $ref: '#/components/schemas/VisualCustomAction' + Title: + $ref: '#/components/schemas/VisualTitleLabelOptions' + ColumnHierarchies: minItems: 0 - Colors: + maxItems: 2 type: array items: - $ref: '#/components/schemas/DimensionField' - maxItems: 200 + $ref: '#/components/schemas/ColumnHierarchy' + required: + - VisualId + FilterListConfiguration: + additionalProperties: false + type: object + properties: + CategoryValues: minItems: 0 - SmallMultiples: + maxItems: 100000 type: array items: - $ref: '#/components/schemas/DimensionField' - maxItems: 1 - minItems: 0 + minLength: 0 + type: string + maxLength: 512 + NullOption: + $ref: '#/components/schemas/FilterNullOption' + MatchOperator: + $ref: '#/components/schemas/CategoryFilterMatchOperator' + SelectAllOptions: + $ref: '#/components/schemas/CategoryFilterSelectAllOptions' + required: + - MatchOperator + SankeyDiagramVisual: additionalProperties: false - LineChartConfiguration: type: object properties: - FieldWells: - $ref: '#/components/schemas/LineChartFieldWells' - SortConfiguration: - $ref: '#/components/schemas/LineChartSortConfiguration' - ForecastConfigurations: - type: array - items: - $ref: '#/components/schemas/ForecastConfiguration' - maxItems: 10 + Subtitle: + $ref: '#/components/schemas/VisualSubtitleLabelOptions' + VisualId: + minLength: 1 + pattern: ^[\w\-]+$ + type: string + maxLength: 512 + ChartConfiguration: + $ref: '#/components/schemas/SankeyDiagramChartConfiguration' + Actions: minItems: 0 - Type: - $ref: '#/components/schemas/LineChartType' - SmallMultiplesOptions: - $ref: '#/components/schemas/SmallMultiplesOptions' - XAxisDisplayOptions: - $ref: '#/components/schemas/AxisDisplayOptions' - XAxisLabelOptions: - $ref: '#/components/schemas/ChartAxisLabelOptions' - PrimaryYAxisDisplayOptions: - $ref: '#/components/schemas/LineSeriesAxisDisplayOptions' - PrimaryYAxisLabelOptions: - $ref: '#/components/schemas/ChartAxisLabelOptions' - SecondaryYAxisDisplayOptions: - $ref: '#/components/schemas/LineSeriesAxisDisplayOptions' - SecondaryYAxisLabelOptions: - $ref: '#/components/schemas/ChartAxisLabelOptions' - DefaultSeriesSettings: - $ref: '#/components/schemas/LineChartDefaultSeriesSettings' - Series: - type: array - items: - $ref: '#/components/schemas/SeriesItem' maxItems: 10 - minItems: 0 - Legend: - $ref: '#/components/schemas/LegendOptions' - DataLabels: - $ref: '#/components/schemas/DataLabelOptions' - ReferenceLines: - type: array - items: - $ref: '#/components/schemas/ReferenceLine' - maxItems: 20 - minItems: 0 - Tooltip: - $ref: '#/components/schemas/TooltipOptions' - ContributionAnalysisDefaults: type: array items: - $ref: '#/components/schemas/ContributionAnalysisDefault' - maxItems: 200 - minItems: 1 - VisualPalette: - $ref: '#/components/schemas/VisualPalette' + $ref: '#/components/schemas/VisualCustomAction' + Title: + $ref: '#/components/schemas/VisualTitleLabelOptions' + required: + - VisualId + TopBottomComputationType: + type: string + enum: + - TOP + - BOTTOM + ForecastConfiguration: additionalProperties: false - LineChartDefaultSeriesSettings: type: object properties: - AxisBinding: - $ref: '#/components/schemas/AxisBinding' - LineStyleSettings: - $ref: '#/components/schemas/LineChartLineStyleSettings' - MarkerStyleSettings: - $ref: '#/components/schemas/LineChartMarkerStyleSettings' + ForecastProperties: + $ref: '#/components/schemas/TimeBasedForecastProperties' + Scenario: + $ref: '#/components/schemas/ForecastScenario' + SimpleTotalAggregationFunction: + type: string + enum: + - DEFAULT + - SUM + - AVERAGE + - MIN + - MAX + - NONE + ConditionalFormattingSolidColor: additionalProperties: false - LineChartFieldWells: type: object properties: - LineChartAggregatedFieldWells: - $ref: '#/components/schemas/LineChartAggregatedFieldWells' + Expression: + minLength: 1 + type: string + maxLength: 4096 + Color: + pattern: ^#[A-F0-9]{6}$ + type: string + required: + - Expression + WaterfallChartFieldWells: additionalProperties: false - LineChartLineStyle: - type: string - enum: - - SOLID - - DOTTED - - DASHED - LineChartLineStyleSettings: type: object properties: - LineVisibility: - $ref: '#/components/schemas/Visibility' - LineInterpolation: - $ref: '#/components/schemas/LineInterpolation' - LineStyle: - $ref: '#/components/schemas/LineChartLineStyle' - LineWidth: - type: string - description: String based length that is composed of value and unit in px + WaterfallChartAggregatedFieldWells: + $ref: '#/components/schemas/WaterfallChartAggregatedFieldWells' + GeospatialHeatmapColorScale: additionalProperties: false - LineChartMarkerShape: + type: object + properties: + Colors: + minItems: 2 + maxItems: 2 + type: array + items: + $ref: '#/components/schemas/GeospatialHeatmapDataColor' + AnalysisErrorType: type: string enum: - - CIRCLE - - TRIANGLE - - SQUARE - - DIAMOND - - ROUNDED_SQUARE - LineChartMarkerStyleSettings: + - ACCESS_DENIED + - SOURCE_NOT_FOUND + - DATA_SET_NOT_FOUND + - INTERNAL_FAILURE + - PARAMETER_VALUE_INCOMPATIBLE + - PARAMETER_TYPE_INVALID + - PARAMETER_NOT_FOUND + - COLUMN_TYPE_MISMATCH + - COLUMN_GEOGRAPHIC_ROLE_MISMATCH + - COLUMN_REPLACEMENT_MISSING + DefaultFreeFormLayoutConfiguration: + additionalProperties: false type: object properties: - MarkerVisibility: - $ref: '#/components/schemas/Visibility' - MarkerShape: - $ref: '#/components/schemas/LineChartMarkerShape' - MarkerSize: - type: string - description: String based length that is composed of value and unit in px - MarkerColor: - type: string - pattern: ^#[A-F0-9]{6}$ + CanvasSizeOptions: + $ref: '#/components/schemas/FreeFormLayoutCanvasSizeOptions' + required: + - CanvasSizeOptions + FilledMapShapeConditionalFormatting: additionalProperties: false - LineChartSeriesSettings: type: object properties: - LineStyleSettings: - $ref: '#/components/schemas/LineChartLineStyleSettings' - MarkerStyleSettings: - $ref: '#/components/schemas/LineChartMarkerStyleSettings' + Format: + $ref: '#/components/schemas/ShapeConditionalFormat' + FieldId: + minLength: 1 + type: string + maxLength: 512 + required: + - FieldId + InsightConfiguration: additionalProperties: false - LineChartSortConfiguration: type: object properties: - CategorySort: - type: array - items: - $ref: '#/components/schemas/FieldSortOptions' - maxItems: 100 + Computations: minItems: 0 - CategoryItemsLimitConfiguration: - $ref: '#/components/schemas/ItemsLimitConfiguration' - ColorItemsLimitConfiguration: - $ref: '#/components/schemas/ItemsLimitConfiguration' - SmallMultiplesSort: + maxItems: 100 type: array items: - $ref: '#/components/schemas/FieldSortOptions' - maxItems: 100 - minItems: 0 - SmallMultiplesLimitConfiguration: - $ref: '#/components/schemas/ItemsLimitConfiguration' + $ref: '#/components/schemas/Computation' + CustomNarrative: + $ref: '#/components/schemas/CustomNarrativeOptions' + ReferenceLineStyleConfiguration: additionalProperties: false - LineChartType: - type: string - enum: - - LINE - - AREA - - STACKED_AREA - LineChartVisual: type: object properties: - VisualId: + Pattern: + $ref: '#/components/schemas/ReferenceLinePatternType' + Color: + pattern: ^#[A-F0-9]{6}$ type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Title: - $ref: '#/components/schemas/VisualTitleLabelOptions' - Subtitle: - $ref: '#/components/schemas/VisualSubtitleLabelOptions' - ChartConfiguration: - $ref: '#/components/schemas/LineChartConfiguration' - Actions: - type: array - items: - $ref: '#/components/schemas/VisualCustomAction' - maxItems: 10 - minItems: 0 - ColumnHierarchies: - type: array - items: - $ref: '#/components/schemas/ColumnHierarchy' - maxItems: 2 - minItems: 0 - required: - - VisualId - additionalProperties: false - LineInterpolation: + ResizeOption: type: string enum: - - LINEAR - - SMOOTH - - STEPPED - LineSeriesAxisDisplayOptions: - type: object - properties: - AxisOptions: - $ref: '#/components/schemas/AxisDisplayOptions' - MissingDataConfigurations: - type: array - items: - $ref: '#/components/schemas/MissingDataConfiguration' - maxItems: 100 - minItems: 0 - additionalProperties: false - ListControlDisplayOptions: - type: object - properties: - SearchOptions: - $ref: '#/components/schemas/ListControlSearchOptions' - SelectAllOptions: - $ref: '#/components/schemas/ListControlSelectAllOptions' - TitleOptions: - $ref: '#/components/schemas/LabelOptions' - InfoIconLabelOptions: - $ref: '#/components/schemas/SheetControlInfoIconLabelOptions' + - FIXED + - RESPONSIVE + FunnelChartDataLabelOptions: additionalProperties: false - ListControlSearchOptions: type: object properties: - Visibility: + MeasureLabelVisibility: $ref: '#/components/schemas/Visibility' - additionalProperties: false - ListControlSelectAllOptions: - type: object - properties: + Position: + $ref: '#/components/schemas/DataLabelPosition' Visibility: $ref: '#/components/schemas/Visibility' + CategoryLabelVisibility: + $ref: '#/components/schemas/Visibility' + LabelColor: + pattern: ^#[A-F0-9]{6}$ + type: string + MeasureDataLabelStyle: + $ref: '#/components/schemas/FunnelChartMeasureDataLabelStyle' + LabelFontConfiguration: + $ref: '#/components/schemas/FontConfiguration' + NumericEqualityMatchOperator: + type: string + enum: + - EQUALS + - DOES_NOT_EQUAL + SecondaryValueOptions: additionalProperties: false - LoadingAnimation: type: object properties: Visibility: $ref: '#/components/schemas/Visibility' + HeaderFooterSectionConfiguration: additionalProperties: false - LocalNavigationConfiguration: type: object properties: - TargetSheetId: + Layout: + $ref: '#/components/schemas/SectionLayoutConfiguration' + Style: + $ref: '#/components/schemas/SectionStyle' + SectionId: + minLength: 1 + pattern: ^[\w\-]+$ type: string maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' required: - - TargetSheetId + - Layout + - SectionId + HeatMapConfiguration: additionalProperties: false - LongFormatText: type: object properties: - PlainText: - type: string - maxLength: 1024 - minLength: 1 - RichText: - type: string - maxLength: 2048 - minLength: 1 + SortConfiguration: + $ref: '#/components/schemas/HeatMapSortConfiguration' + ColumnLabelOptions: + $ref: '#/components/schemas/ChartAxisLabelOptions' + Legend: + $ref: '#/components/schemas/LegendOptions' + DataLabels: + $ref: '#/components/schemas/DataLabelOptions' + FieldWells: + $ref: '#/components/schemas/HeatMapFieldWells' + Tooltip: + $ref: '#/components/schemas/TooltipOptions' + ColorScale: + $ref: '#/components/schemas/ColorScale' + RowLabelOptions: + $ref: '#/components/schemas/ChartAxisLabelOptions' + FilterListControl: additionalProperties: false - MapZoomMode: - type: string - enum: - - AUTO - - MANUAL - MappedDataSetParameter: type: object properties: - DataSetIdentifier: + FilterControlId: + minLength: 1 + pattern: ^[\w\-]+$ type: string - maxLength: 2048 + maxLength: 512 + Type: + $ref: '#/components/schemas/SheetControlListType' + DisplayOptions: + $ref: '#/components/schemas/ListControlDisplayOptions' + CascadingControlConfiguration: + $ref: '#/components/schemas/CascadingControlConfiguration' + Title: minLength: 1 - DataSetParameterName: type: string maxLength: 2048 + SourceFilterId: minLength: 1 - pattern: ^[a-zA-Z0-9]+$ + pattern: ^[\w\-]+$ + type: string + maxLength: 512 + SelectableValues: + $ref: '#/components/schemas/FilterSelectableValues' required: - - DataSetIdentifier - - DataSetParameterName - additionalProperties: false - MaximumLabelType: - type: object - properties: - Visibility: - $ref: '#/components/schemas/Visibility' + - FilterControlId + - SourceFilterId + - Title + PeriodOverPeriodComputation: additionalProperties: false - MaximumMinimumComputation: type: object properties: + Value: + $ref: '#/components/schemas/MeasureField' + Time: + $ref: '#/components/schemas/DimensionField' ComputationId: + minLength: 1 + pattern: ^[\w\-]+$ type: string maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' Name: type: string - Time: - $ref: '#/components/schemas/DimensionField' - Value: - $ref: '#/components/schemas/MeasureField' - Type: - $ref: '#/components/schemas/MaximumMinimumComputationType' required: - ComputationId - - Type - additionalProperties: false - MaximumMinimumComputationType: - type: string - enum: - - MAXIMUM - - MINIMUM - MeasureField: - type: object - properties: - NumericalMeasureField: - $ref: '#/components/schemas/NumericalMeasureField' - CategoricalMeasureField: - $ref: '#/components/schemas/CategoricalMeasureField' - DateMeasureField: - $ref: '#/components/schemas/DateMeasureField' - CalculatedMeasureField: - $ref: '#/components/schemas/CalculatedMeasureField' + Sheet: + description: |- +

A sheet, which is an object that contains a set of visuals that + are viewed together on one page in Amazon QuickSight. Every analysis and dashboard + contains at least one sheet. Each sheet contains at least one visualization widget, for + example a chart, pivot table, or narrative insight. Sheets can be associated with other + components, such as controls, filters, and so on.

additionalProperties: false - MetricComparisonComputation: type: object properties: - ComputationId: + SheetId: + minLength: 1 + pattern: ^[\w\-]+$ + description:

The unique identifier associated with a sheet.

type: string maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' Name: + minLength: 1 + description: |- +

The name of a sheet. This name is displayed on the sheet's tab in the Amazon QuickSight + console.

type: string - Time: - $ref: '#/components/schemas/DimensionField' - FromValue: - $ref: '#/components/schemas/MeasureField' - TargetValue: - $ref: '#/components/schemas/MeasureField' - required: - - ComputationId - additionalProperties: false - MinimumLabelType: - type: object - properties: - Visibility: - $ref: '#/components/schemas/Visibility' + maxLength: 2048 + ArcOptions: additionalProperties: false - MissingDataConfiguration: type: object properties: - TreatmentOption: - $ref: '#/components/schemas/MissingDataTreatmentOption' + ArcThickness: + $ref: '#/components/schemas/ArcThickness' + DefaultSectionBasedLayoutConfiguration: additionalProperties: false - MissingDataTreatmentOption: - type: string - enum: - - INTERPOLATE - - SHOW_AS_ZERO - - SHOW_AS_BLANK - NegativeValueConfiguration: type: object properties: - DisplayMode: - $ref: '#/components/schemas/NegativeValueDisplayMode' + CanvasSizeOptions: + $ref: '#/components/schemas/SectionBasedLayoutCanvasSizeOptions' required: - - DisplayMode + - CanvasSizeOptions + SectionStyle: additionalProperties: false - NegativeValueDisplayMode: - type: string - enum: - - POSITIVE - - NEGATIVE - NullValueFormatConfiguration: type: object properties: - NullString: + Padding: + $ref: '#/components/schemas/Spacing' + Height: + description: String based length that is composed of value and unit in px type: string - maxLength: 128 - minLength: 1 - required: - - NullString + BarChartFieldWells: additionalProperties: false - NumberDisplayFormatConfiguration: type: object properties: - Prefix: - type: string - maxLength: 128 - minLength: 1 - Suffix: - type: string - maxLength: 128 - minLength: 1 - SeparatorConfiguration: - $ref: '#/components/schemas/NumericSeparatorConfiguration' - DecimalPlacesConfiguration: - $ref: '#/components/schemas/DecimalPlacesConfiguration' - NumberScale: - $ref: '#/components/schemas/NumberScale' - NegativeValueConfiguration: - $ref: '#/components/schemas/NegativeValueConfiguration' - NullValueFormatConfiguration: - $ref: '#/components/schemas/NullValueFormatConfiguration' - additionalProperties: false - NumberFormatConfiguration: - type: object - properties: - FormatConfiguration: - $ref: '#/components/schemas/NumericFormatConfiguration' + BarChartAggregatedFieldWells: + $ref: '#/components/schemas/BarChartAggregatedFieldWells' + GeospatialMapAggregatedFieldWells: additionalProperties: false - NumberScale: - type: string - enum: - - NONE - - AUTO - - THOUSANDS - - MILLIONS - - BILLIONS - - TRILLIONS - NumericAxisOptions: type: object properties: - Scale: - $ref: '#/components/schemas/AxisScale' - Range: - $ref: '#/components/schemas/AxisDisplayRange' + Colors: + minItems: 0 + maxItems: 200 + type: array + items: + $ref: '#/components/schemas/DimensionField' + Values: + minItems: 0 + maxItems: 200 + type: array + items: + $ref: '#/components/schemas/MeasureField' + Geospatial: + minItems: 0 + maxItems: 200 + type: array + items: + $ref: '#/components/schemas/DimensionField' + DateMeasureField: additionalProperties: false - NumericEqualityDrillDownFilter: type: object properties: + AggregationFunction: + $ref: '#/components/schemas/DateAggregationFunction' + FormatConfiguration: + $ref: '#/components/schemas/DateTimeFormatConfiguration' Column: $ref: '#/components/schemas/ColumnIdentifier' - Value: - type: number - default: 0 + FieldId: + minLength: 1 + type: string + maxLength: 512 required: - Column - - Value + - FieldId + TooltipTitleType: + type: string + enum: + - NONE + - PRIMARY_VALUE + GeospatialMapVisual: additionalProperties: false - NumericEqualityFilter: type: object properties: - FilterId: - type: string - maxLength: 512 + Subtitle: + $ref: '#/components/schemas/VisualSubtitleLabelOptions' + VisualId: minLength: 1 - pattern: '[\w\-]+' - Column: - $ref: '#/components/schemas/ColumnIdentifier' - Value: - type: number - default: null - SelectAllOptions: - $ref: '#/components/schemas/NumericFilterSelectAllOptions' - MatchOperator: - $ref: '#/components/schemas/NumericEqualityMatchOperator' - AggregationFunction: - $ref: '#/components/schemas/AggregationFunction' - ParameterName: + pattern: ^[\w\-]+$ type: string - maxLength: 2048 - minLength: 1 - pattern: ^[a-zA-Z0-9]+$ - NullOption: - $ref: '#/components/schemas/FilterNullOption' + maxLength: 512 + ChartConfiguration: + $ref: '#/components/schemas/GeospatialMapConfiguration' + Actions: + minItems: 0 + maxItems: 10 + type: array + items: + $ref: '#/components/schemas/VisualCustomAction' + Title: + $ref: '#/components/schemas/VisualTitleLabelOptions' + ColumnHierarchies: + minItems: 0 + maxItems: 2 + type: array + items: + $ref: '#/components/schemas/ColumnHierarchy' required: - - Column - - FilterId - - MatchOperator - - NullOption + - VisualId + DefaultPaginatedLayoutConfiguration: additionalProperties: false - NumericEqualityMatchOperator: - type: string - enum: - - EQUALS - - DOES_NOT_EQUAL - NumericFilterSelectAllOptions: - type: string - enum: - - FILTER_ALL_VALUES - NumericFormatConfiguration: type: object properties: - NumberDisplayFormatConfiguration: - $ref: '#/components/schemas/NumberDisplayFormatConfiguration' - CurrencyDisplayFormatConfiguration: - $ref: '#/components/schemas/CurrencyDisplayFormatConfiguration' - PercentageDisplayFormatConfiguration: - $ref: '#/components/schemas/PercentageDisplayFormatConfiguration' + SectionBased: + $ref: '#/components/schemas/DefaultSectionBasedLayoutConfiguration' + AnalysisSourceTemplate: + description:

The source template of an analysis.

additionalProperties: false - NumericRangeFilter: type: object properties: - FilterId: + DataSetReferences: + minItems: 1 + description:

The dataset references of the source template of an analysis.

+ type: array + items: + $ref: '#/components/schemas/DataSetReference' + Arn: + description:

The Amazon Resource Name (ARN) of the source template of an analysis.

type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Column: - $ref: '#/components/schemas/ColumnIdentifier' - IncludeMinimum: - type: boolean - default: null - IncludeMaximum: - type: boolean - default: null - RangeMinimum: - $ref: '#/components/schemas/NumericRangeFilterValue' - RangeMaximum: - $ref: '#/components/schemas/NumericRangeFilterValue' - SelectAllOptions: - $ref: '#/components/schemas/NumericFilterSelectAllOptions' - AggregationFunction: - $ref: '#/components/schemas/AggregationFunction' - NullOption: - $ref: '#/components/schemas/FilterNullOption' required: - - Column - - FilterId - - NullOption + - Arn + - DataSetReferences + ChartAxisLabelOptions: additionalProperties: false - NumericRangeFilterValue: type: object properties: - StaticValue: - type: number - default: null - Parameter: - type: string - maxLength: 2048 - minLength: 1 - pattern: ^[a-zA-Z0-9]+$ + Visibility: + $ref: '#/components/schemas/Visibility' + SortIconVisibility: + $ref: '#/components/schemas/Visibility' + AxisLabelOptions: + minItems: 0 + maxItems: 100 + type: array + items: + $ref: '#/components/schemas/AxisLabelOptions' + PivotTableRowsLayout: + type: string + enum: + - TABULAR + - HIERARCHY + WaterfallChartConfiguration: additionalProperties: false - NumericSeparatorConfiguration: type: object properties: - DecimalSeparator: - $ref: '#/components/schemas/NumericSeparatorSymbol' - ThousandsSeparator: - $ref: '#/components/schemas/ThousandSeparatorOptions' + CategoryAxisLabelOptions: + $ref: '#/components/schemas/ChartAxisLabelOptions' + SortConfiguration: + $ref: '#/components/schemas/WaterfallChartSortConfiguration' + Legend: + $ref: '#/components/schemas/LegendOptions' + DataLabels: + $ref: '#/components/schemas/DataLabelOptions' + PrimaryYAxisLabelOptions: + $ref: '#/components/schemas/ChartAxisLabelOptions' + FieldWells: + $ref: '#/components/schemas/WaterfallChartFieldWells' + WaterfallChartOptions: + $ref: '#/components/schemas/WaterfallChartOptions' + ColorConfiguration: + $ref: '#/components/schemas/WaterfallChartColorConfiguration' + CategoryAxisDisplayOptions: + $ref: '#/components/schemas/AxisDisplayOptions' + PrimaryYAxisDisplayOptions: + $ref: '#/components/schemas/AxisDisplayOptions' + VisualPalette: + $ref: '#/components/schemas/VisualPalette' + WhatIfPointScenario: additionalProperties: false - NumericSeparatorSymbol: - type: string - enum: - - COMMA - - DOT - - SPACE - NumericalAggregationFunction: type: object properties: - SimpleNumericalAggregation: - $ref: '#/components/schemas/SimpleNumericalAggregationFunction' - PercentileAggregation: - $ref: '#/components/schemas/PercentileAggregation' + Value: + default: 0 + type: number + Date: + format: date-time + type: string + required: + - Date + - Value + AnalysisDefaults: additionalProperties: false - NumericalDimensionField: type: object properties: - FieldId: - type: string - maxLength: 512 - minLength: 1 - Column: - $ref: '#/components/schemas/ColumnIdentifier' - HierarchyId: - type: string - maxLength: 512 - minLength: 1 - FormatConfiguration: - $ref: '#/components/schemas/NumberFormatConfiguration' + DefaultNewSheetConfiguration: + $ref: '#/components/schemas/DefaultNewSheetConfiguration' required: - - Column - - FieldId + - DefaultNewSheetConfiguration + NumericalDimensionField: additionalProperties: false - NumericalMeasureField: type: object properties: - FieldId: + HierarchyId: + minLength: 1 type: string maxLength: 512 - minLength: 1 - Column: - $ref: '#/components/schemas/ColumnIdentifier' - AggregationFunction: - $ref: '#/components/schemas/NumericalAggregationFunction' FormatConfiguration: $ref: '#/components/schemas/NumberFormatConfiguration' + Column: + $ref: '#/components/schemas/ColumnIdentifier' + FieldId: + minLength: 1 + type: string + maxLength: 512 required: - Column - FieldId + TableConfiguration: additionalProperties: false - OtherCategories: - type: string - enum: - - INCLUDE - - EXCLUDE - PaginationConfiguration: type: object properties: - PageSize: - type: number - default: null - PageNumber: - type: number - minimum: 0 - required: - - PageNumber - - PageSize + SortConfiguration: + $ref: '#/components/schemas/TableSortConfiguration' + PaginatedReportOptions: + $ref: '#/components/schemas/TablePaginatedReportOptions' + TableOptions: + $ref: '#/components/schemas/TableOptions' + TableInlineVisualizations: + minItems: 0 + maxItems: 200 + type: array + items: + $ref: '#/components/schemas/TableInlineVisualization' + FieldWells: + $ref: '#/components/schemas/TableFieldWells' + FieldOptions: + $ref: '#/components/schemas/TableFieldOptions' + TotalOptions: + $ref: '#/components/schemas/TotalOptions' + HistogramConfiguration: additionalProperties: false - PanelBorderStyle: - type: string - enum: - - SOLID - - DASHED - - DOTTED - PanelConfiguration: type: object properties: - Title: - $ref: '#/components/schemas/PanelTitleOptions' - BorderVisibility: - $ref: '#/components/schemas/Visibility' - BorderThickness: - type: string - description: String based length that is composed of value and unit in px - BorderStyle: - $ref: '#/components/schemas/PanelBorderStyle' - BorderColor: - type: string - pattern: ^#[A-F0-9]{6}(?:[A-F0-9]{2})?$ - GutterVisibility: - $ref: '#/components/schemas/Visibility' - GutterSpacing: - type: string - description: String based length that is composed of value and unit in px - BackgroundVisibility: - $ref: '#/components/schemas/Visibility' - BackgroundColor: - type: string - pattern: ^#[A-F0-9]{6}(?:[A-F0-9]{2})?$ + YAxisDisplayOptions: + $ref: '#/components/schemas/AxisDisplayOptions' + DataLabels: + $ref: '#/components/schemas/DataLabelOptions' + BinOptions: + $ref: '#/components/schemas/HistogramBinOptions' + FieldWells: + $ref: '#/components/schemas/HistogramFieldWells' + Tooltip: + $ref: '#/components/schemas/TooltipOptions' + XAxisLabelOptions: + $ref: '#/components/schemas/ChartAxisLabelOptions' + VisualPalette: + $ref: '#/components/schemas/VisualPalette' + XAxisDisplayOptions: + $ref: '#/components/schemas/AxisDisplayOptions' + TreeMapAggregatedFieldWells: additionalProperties: false - PanelTitleOptions: type: object properties: - Visibility: - $ref: '#/components/schemas/Visibility' - FontConfiguration: - $ref: '#/components/schemas/FontConfiguration' - HorizontalTextAlignment: - $ref: '#/components/schemas/HorizontalTextAlignment' + Sizes: + minItems: 0 + maxItems: 1 + type: array + items: + $ref: '#/components/schemas/MeasureField' + Colors: + minItems: 0 + maxItems: 1 + type: array + items: + $ref: '#/components/schemas/MeasureField' + Groups: + minItems: 0 + maxItems: 1 + type: array + items: + $ref: '#/components/schemas/DimensionField' + ConditionalFormattingIcon: additionalProperties: false - PaperOrientation: - type: string - enum: - - PORTRAIT - - LANDSCAPE - PaperSize: - type: string - enum: - - US_LETTER - - US_LEGAL - - US_TABLOID_LEDGER - - A0 - - A1 - - A2 - - A3 - - A4 - - A5 - - JIS_B4 - - JIS_B5 - ParameterControl: type: object properties: - DateTimePicker: - $ref: '#/components/schemas/ParameterDateTimePickerControl' - List: - $ref: '#/components/schemas/ParameterListControl' - Dropdown: - $ref: '#/components/schemas/ParameterDropDownControl' - TextField: - $ref: '#/components/schemas/ParameterTextFieldControl' - TextArea: - $ref: '#/components/schemas/ParameterTextAreaControl' - Slider: - $ref: '#/components/schemas/ParameterSliderControl' + CustomCondition: + $ref: '#/components/schemas/ConditionalFormattingCustomIconCondition' + IconSet: + $ref: '#/components/schemas/ConditionalFormattingIconSet' + NumberFormatConfiguration: additionalProperties: false - ParameterDateTimePickerControl: type: object properties: - ParameterControlId: + FormatConfiguration: + $ref: '#/components/schemas/NumericFormatConfiguration' + LayoutElementType: + type: string + enum: + - VISUAL + - FILTER_CONTROL + - PARAMETER_CONTROL + - TEXT_BOX + WaterfallVisual: + additionalProperties: false + type: object + properties: + Subtitle: + $ref: '#/components/schemas/VisualSubtitleLabelOptions' + VisualId: + minLength: 1 + pattern: ^[\w\-]+$ type: string maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' + ChartConfiguration: + $ref: '#/components/schemas/WaterfallChartConfiguration' + Actions: + minItems: 0 + maxItems: 10 + type: array + items: + $ref: '#/components/schemas/VisualCustomAction' Title: - type: string - maxLength: 2048 - minLength: 1 - SourceParameterName: - type: string - maxLength: 2048 - minLength: 1 - pattern: ^[a-zA-Z0-9]+$ - DisplayOptions: - $ref: '#/components/schemas/DateTimePickerControlDisplayOptions' + $ref: '#/components/schemas/VisualTitleLabelOptions' + ColumnHierarchies: + minItems: 0 + maxItems: 2 + type: array + items: + $ref: '#/components/schemas/ColumnHierarchy' required: - - ParameterControlId - - SourceParameterName - - Title + - VisualId + DateTimeDefaultValues: additionalProperties: false - ParameterDeclaration: type: object properties: - StringParameterDeclaration: - $ref: '#/components/schemas/StringParameterDeclaration' - DecimalParameterDeclaration: - $ref: '#/components/schemas/DecimalParameterDeclaration' - IntegerParameterDeclaration: - $ref: '#/components/schemas/IntegerParameterDeclaration' - DateTimeParameterDeclaration: - $ref: '#/components/schemas/DateTimeParameterDeclaration' + RollingDate: + $ref: '#/components/schemas/RollingDateConfiguration' + DynamicValue: + $ref: '#/components/schemas/DynamicDefaultValue' + StaticValues: + minItems: 0 + maxItems: 50000 + type: array + items: + format: date-time + type: string + ReferenceLineValueLabelRelativePosition: + type: string + enum: + - BEFORE_CUSTOM_LABEL + - AFTER_CUSTOM_LABEL + BinCountOptions: additionalProperties: false - ParameterDropDownControl: type: object properties: - ParameterControlId: - type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Title: - type: string - maxLength: 2048 - minLength: 1 - SourceParameterName: - type: string - maxLength: 2048 - minLength: 1 - pattern: ^[a-zA-Z0-9]+$ - DisplayOptions: - $ref: '#/components/schemas/DropDownControlDisplayOptions' - Type: - $ref: '#/components/schemas/SheetControlListType' - SelectableValues: - $ref: '#/components/schemas/ParameterSelectableValues' - CascadingControlConfiguration: - $ref: '#/components/schemas/CascadingControlConfiguration' - required: - - ParameterControlId - - SourceParameterName - - Title + Value: + type: number + minimum: 0 + PivotTableOptions: additionalProperties: false - ParameterListControl: type: object properties: - ParameterControlId: + RowFieldNamesStyle: + $ref: '#/components/schemas/TableCellStyle' + RowHeaderStyle: + $ref: '#/components/schemas/TableCellStyle' + CollapsedRowDimensionsVisibility: + $ref: '#/components/schemas/Visibility' + RowsLayout: + $ref: '#/components/schemas/PivotTableRowsLayout' + MetricPlacement: + $ref: '#/components/schemas/PivotTableMetricPlacement' + DefaultCellWidth: + description: String based length that is composed of value and unit in px type: string - maxLength: 512 + ColumnNamesVisibility: + $ref: '#/components/schemas/Visibility' + RowsLabelOptions: + $ref: '#/components/schemas/PivotTableRowsLabelOptions' + SingleMetricVisibility: + $ref: '#/components/schemas/Visibility' + ColumnHeaderStyle: + $ref: '#/components/schemas/TableCellStyle' + ToggleButtonsVisibility: + $ref: '#/components/schemas/Visibility' + CellStyle: + $ref: '#/components/schemas/TableCellStyle' + RowAlternateColorOptions: + $ref: '#/components/schemas/RowAlternateColorOptions' + PeriodToDateComputation: + additionalProperties: false + type: object + properties: + PeriodTimeGranularity: + $ref: '#/components/schemas/TimeGranularity' + Value: + $ref: '#/components/schemas/MeasureField' + Time: + $ref: '#/components/schemas/DimensionField' + ComputationId: minLength: 1 - pattern: '[\w\-]+' - Title: + pattern: ^[\w\-]+$ type: string - maxLength: 2048 - minLength: 1 - SourceParameterName: + maxLength: 512 + Name: type: string - maxLength: 2048 - minLength: 1 - pattern: ^[a-zA-Z0-9]+$ - DisplayOptions: - $ref: '#/components/schemas/ListControlDisplayOptions' - Type: - $ref: '#/components/schemas/SheetControlListType' - SelectableValues: - $ref: '#/components/schemas/ParameterSelectableValues' - CascadingControlConfiguration: - $ref: '#/components/schemas/CascadingControlConfiguration' required: - - ParameterControlId - - SourceParameterName - - Title + - ComputationId + TableAggregatedFieldWells: additionalProperties: false - ParameterSelectableValues: type: object properties: - Values: + GroupBy: + minItems: 0 + maxItems: 200 type: array items: - type: string - maxItems: 50000 + $ref: '#/components/schemas/DimensionField' + Values: minItems: 0 - LinkToDataSetColumn: - $ref: '#/components/schemas/ColumnIdentifier' + maxItems: 200 + type: array + items: + $ref: '#/components/schemas/MeasureField' + ReferenceLineStaticDataConfiguration: + additionalProperties: false + type: object + properties: + Value: + default: 0 + type: number + required: + - Value + DayOfTheWeek: + type: string + enum: + - SUNDAY + - MONDAY + - TUESDAY + - WEDNESDAY + - THURSDAY + - FRIDAY + - SATURDAY + TopBottomRankedComputation: additionalProperties: false + type: object + properties: + Type: + $ref: '#/components/schemas/TopBottomComputationType' + Category: + $ref: '#/components/schemas/DimensionField' + ResultSize: + default: 0 + maximum: 20 + type: number + minimum: 1 + Value: + $ref: '#/components/schemas/MeasureField' + ComputationId: + minLength: 1 + pattern: ^[\w\-]+$ + type: string + maxLength: 512 + Name: + type: string + required: + - ComputationId + - Type ParameterSliderControl: + additionalProperties: false type: object properties: ParameterControlId: + minLength: 1 + pattern: ^[\w\-]+$ type: string maxLength: 512 + StepSize: + default: 0 + type: number + DisplayOptions: + $ref: '#/components/schemas/SliderControlDisplayOptions' + SourceParameterName: minLength: 1 - pattern: '[\w\-]+' - Title: + pattern: ^[a-zA-Z0-9]+$ type: string maxLength: 2048 + Title: minLength: 1 - SourceParameterName: type: string maxLength: 2048 - minLength: 1 - pattern: ^[a-zA-Z0-9]+$ - DisplayOptions: - $ref: '#/components/schemas/SliderControlDisplayOptions' MaximumValue: - type: number default: 0 - MinimumValue: type: number + MinimumValue: default: 0 - StepSize: type: number - default: 0 required: - MaximumValue - MinimumValue @@ -5077,391 +5144,194 @@ components: - SourceParameterName - StepSize - Title + NegativeValueDisplayMode: + type: string + enum: + - POSITIVE + - NEGATIVE + ColorFillType: + type: string + enum: + - DISCRETE + - GRADIENT + TableFieldCustomIconContent: additionalProperties: false - ParameterTextAreaControl: type: object properties: - ParameterControlId: - type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Title: - type: string - maxLength: 2048 - minLength: 1 - SourceParameterName: - type: string - maxLength: 2048 - minLength: 1 - pattern: ^[a-zA-Z0-9]+$ - Delimiter: - type: string - maxLength: 2048 - minLength: 1 - DisplayOptions: - $ref: '#/components/schemas/TextAreaControlDisplayOptions' - required: - - ParameterControlId - - SourceParameterName - - Title + Icon: + $ref: '#/components/schemas/TableFieldIconSetType' + TableFieldURLConfiguration: additionalProperties: false - ParameterTextFieldControl: type: object properties: - ParameterControlId: - type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Title: - type: string - maxLength: 2048 + LinkConfiguration: + $ref: '#/components/schemas/TableFieldLinkConfiguration' + ImageConfiguration: + $ref: '#/components/schemas/TableFieldImageConfiguration' + SheetControlInfoIconLabelOptions: + additionalProperties: false + type: object + properties: + Visibility: + $ref: '#/components/schemas/Visibility' + InfoIconText: minLength: 1 - SourceParameterName: type: string - maxLength: 2048 - minLength: 1 - pattern: ^[a-zA-Z0-9]+$ - DisplayOptions: - $ref: '#/components/schemas/TextFieldControlDisplayOptions' - required: - - ParameterControlId - - SourceParameterName - - Title + maxLength: 100 + VisualPalette: additionalProperties: false - ParameterValueType: - type: string - enum: - - MULTI_VALUED - - SINGLE_VALUED - Parameters: type: object properties: - StringParameters: - type: array - items: - $ref: '#/components/schemas/StringParameter' - maxItems: 100 + ChartColor: + pattern: ^#[A-F0-9]{6}$ + type: string + ColorMap: minItems: 0 - IntegerParameters: + maxItems: 5000 type: array items: - $ref: '#/components/schemas/IntegerParameter' - maxItems: 100 - minItems: 0 - DecimalParameters: - type: array - items: - $ref: '#/components/schemas/DecimalParameter' - maxItems: 100 - minItems: 0 - DateTimeParameters: - type: array - items: - $ref: '#/components/schemas/DateTimeParameter' - maxItems: 100 - minItems: 0 + $ref: '#/components/schemas/DataPathColor' + MissingDataTreatmentOption: + type: string + enum: + - INTERPOLATE + - SHOW_AS_ZERO + - SHOW_AS_BLANK + ReferenceLineLabelVerticalPosition: + type: string + enum: + - ABOVE + - BELOW + ItemsLimitConfiguration: additionalProperties: false - PercentVisibleRange: type: object properties: - From: - type: number + ItemsLimit: default: null - maximum: 100 - minimum: 0 - To: type: number - default: null - maximum: 100 - minimum: 0 + OtherCategories: + $ref: '#/components/schemas/OtherCategories' + FilterTextFieldControl: additionalProperties: false - PercentageDisplayFormatConfiguration: type: object properties: - Prefix: - type: string - maxLength: 128 - minLength: 1 - Suffix: - type: string - maxLength: 128 + FilterControlId: minLength: 1 - SeparatorConfiguration: - $ref: '#/components/schemas/NumericSeparatorConfiguration' - DecimalPlacesConfiguration: - $ref: '#/components/schemas/DecimalPlacesConfiguration' - NegativeValueConfiguration: - $ref: '#/components/schemas/NegativeValueConfiguration' - NullValueFormatConfiguration: - $ref: '#/components/schemas/NullValueFormatConfiguration' - additionalProperties: false - PercentileAggregation: - type: object - properties: - PercentileValue: - type: number - maximum: 100 - minimum: 0 - additionalProperties: false - PeriodOverPeriodComputation: - type: object - properties: - ComputationId: + pattern: ^[\w\-]+$ type: string maxLength: 512 + DisplayOptions: + $ref: '#/components/schemas/TextFieldControlDisplayOptions' + Title: minLength: 1 - pattern: '[\w\-]+' - Name: - type: string - Time: - $ref: '#/components/schemas/DimensionField' - Value: - $ref: '#/components/schemas/MeasureField' - required: - - ComputationId - additionalProperties: false - PeriodToDateComputation: - type: object - properties: - ComputationId: type: string - maxLength: 512 + maxLength: 2048 + SourceFilterId: minLength: 1 - pattern: '[\w\-]+' - Name: + pattern: ^[\w\-]+$ type: string - Time: - $ref: '#/components/schemas/DimensionField' - Value: - $ref: '#/components/schemas/MeasureField' - PeriodTimeGranularity: - $ref: '#/components/schemas/TimeGranularity' + maxLength: 512 required: - - ComputationId + - FilterControlId + - SourceFilterId + - Title + TablePinnedFieldOptions: additionalProperties: false - PieChartAggregatedFieldWells: type: object properties: - Category: - type: array - items: - $ref: '#/components/schemas/DimensionField' - maxItems: 200 - minItems: 0 - Values: - type: array - items: - $ref: '#/components/schemas/MeasureField' - maxItems: 200 - minItems: 0 - SmallMultiples: - type: array - items: - $ref: '#/components/schemas/DimensionField' - maxItems: 1 + PinnedLeftFields: minItems: 0 - additionalProperties: false - PieChartConfiguration: - type: object - properties: - FieldWells: - $ref: '#/components/schemas/PieChartFieldWells' - SortConfiguration: - $ref: '#/components/schemas/PieChartSortConfiguration' - DonutOptions: - $ref: '#/components/schemas/DonutOptions' - SmallMultiplesOptions: - $ref: '#/components/schemas/SmallMultiplesOptions' - CategoryLabelOptions: - $ref: '#/components/schemas/ChartAxisLabelOptions' - ValueLabelOptions: - $ref: '#/components/schemas/ChartAxisLabelOptions' - Legend: - $ref: '#/components/schemas/LegendOptions' - DataLabels: - $ref: '#/components/schemas/DataLabelOptions' - Tooltip: - $ref: '#/components/schemas/TooltipOptions' - VisualPalette: - $ref: '#/components/schemas/VisualPalette' - ContributionAnalysisDefaults: + maxItems: 201 type: array items: - $ref: '#/components/schemas/ContributionAnalysisDefault' - maxItems: 200 - minItems: 1 + minLength: 1 + type: string + maxLength: 512 + OtherCategories: + type: string + enum: + - INCLUDE + - EXCLUDE + TimeEqualityFilter: additionalProperties: false - PieChartFieldWells: type: object properties: - PieChartAggregatedFieldWells: - $ref: '#/components/schemas/PieChartAggregatedFieldWells' + Column: + $ref: '#/components/schemas/ColumnIdentifier' + RollingDate: + $ref: '#/components/schemas/RollingDateConfiguration' + Value: + format: date-time + type: string + TimeGranularity: + $ref: '#/components/schemas/TimeGranularity' + ParameterName: + minLength: 1 + pattern: ^[a-zA-Z0-9]+$ + type: string + maxLength: 2048 + DefaultFilterControlConfiguration: + $ref: '#/components/schemas/DefaultFilterControlConfiguration' + FilterId: + minLength: 1 + pattern: ^[\w\-]+$ + type: string + maxLength: 512 + required: + - Column + - FilterId + NumericFormatConfiguration: additionalProperties: false - PieChartSortConfiguration: type: object properties: - CategorySort: - type: array - items: - $ref: '#/components/schemas/FieldSortOptions' - maxItems: 100 - minItems: 0 - CategoryItemsLimit: - $ref: '#/components/schemas/ItemsLimitConfiguration' - SmallMultiplesSort: - type: array - items: - $ref: '#/components/schemas/FieldSortOptions' - maxItems: 100 - minItems: 0 - SmallMultiplesLimitConfiguration: - $ref: '#/components/schemas/ItemsLimitConfiguration' + NumberDisplayFormatConfiguration: + $ref: '#/components/schemas/NumberDisplayFormatConfiguration' + CurrencyDisplayFormatConfiguration: + $ref: '#/components/schemas/CurrencyDisplayFormatConfiguration' + PercentageDisplayFormatConfiguration: + $ref: '#/components/schemas/PercentageDisplayFormatConfiguration' + DataPathColor: additionalProperties: false - PieChartVisual: type: object properties: - VisualId: + Element: + $ref: '#/components/schemas/DataPathValue' + Color: + pattern: ^#[A-F0-9]{6}$ type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Title: - $ref: '#/components/schemas/VisualTitleLabelOptions' - Subtitle: - $ref: '#/components/schemas/VisualSubtitleLabelOptions' - ChartConfiguration: - $ref: '#/components/schemas/PieChartConfiguration' - Actions: - type: array - items: - $ref: '#/components/schemas/VisualCustomAction' - maxItems: 10 - minItems: 0 - ColumnHierarchies: - type: array - items: - $ref: '#/components/schemas/ColumnHierarchy' - maxItems: 2 - minItems: 0 + TimeGranularity: + $ref: '#/components/schemas/TimeGranularity' required: - - VisualId + - Color + - Element + CustomContentConfiguration: additionalProperties: false - PivotFieldSortOptions: type: object properties: - FieldId: - type: string - maxLength: 512 + ContentUrl: minLength: 1 - SortBy: - $ref: '#/components/schemas/PivotTableSortBy' - required: - - FieldId - - SortBy - additionalProperties: false - PivotTableAggregatedFieldWells: - type: object - properties: - Rows: - type: array - items: - $ref: '#/components/schemas/DimensionField' - maxItems: 40 - minItems: 0 - Columns: - type: array - items: - $ref: '#/components/schemas/DimensionField' - maxItems: 40 - minItems: 0 - Values: - type: array - items: - $ref: '#/components/schemas/MeasureField' - maxItems: 40 - minItems: 0 - additionalProperties: false - PivotTableCellConditionalFormatting: - type: object - properties: - FieldId: type: string - maxLength: 512 - minLength: 1 - TextFormat: - $ref: '#/components/schemas/TextConditionalFormat' - Scope: - $ref: '#/components/schemas/PivotTableConditionalFormattingScope' - Scopes: - type: array - items: - $ref: '#/components/schemas/PivotTableConditionalFormattingScope' - maxItems: 3 - minItems: 0 - required: - - FieldId - additionalProperties: false - PivotTableConditionalFormatting: - type: object - properties: - ConditionalFormattingOptions: - type: array - items: - $ref: '#/components/schemas/PivotTableConditionalFormattingOption' - maxItems: 100 - minItems: 0 - additionalProperties: false - PivotTableConditionalFormattingOption: - type: object - properties: - Cell: - $ref: '#/components/schemas/PivotTableCellConditionalFormatting' - additionalProperties: false - PivotTableConditionalFormattingScope: - type: object - properties: - Role: - $ref: '#/components/schemas/PivotTableConditionalFormattingScopeRole' - additionalProperties: false - PivotTableConditionalFormattingScopeRole: + maxLength: 2048 + ContentType: + $ref: '#/components/schemas/CustomContentType' + ImageScaling: + $ref: '#/components/schemas/CustomContentImageScalingConfiguration' + MapZoomMode: type: string enum: - - FIELD - - FIELD_TOTAL - - GRAND_TOTAL - PivotTableConfiguration: - type: object - properties: - FieldWells: - $ref: '#/components/schemas/PivotTableFieldWells' - SortConfiguration: - $ref: '#/components/schemas/PivotTableSortConfiguration' - TableOptions: - $ref: '#/components/schemas/PivotTableOptions' - TotalOptions: - $ref: '#/components/schemas/PivotTableTotalOptions' - FieldOptions: - $ref: '#/components/schemas/PivotTableFieldOptions' - PaginatedReportOptions: - $ref: '#/components/schemas/PivotTablePaginatedReportOptions' - additionalProperties: false - PivotTableDataPathOption: - type: object - properties: - DataPathList: - type: array - items: - $ref: '#/components/schemas/DataPathValue' - maxItems: 20 - minItems: 0 - Width: - type: string - description: String based length that is composed of value and unit in px - required: - - DataPathList - additionalProperties: false + - AUTO + - MANUAL + SheetControlListType: + type: string + enum: + - MULTI_SELECT + - SINGLE_SELECT + ArcThicknessOptions: + type: string + enum: + - SMALL + - MEDIUM + - LARGE PivotTableDataPathType: type: string enum: @@ -5469,2745 +5339,3103 @@ components: - MULTIPLE_ROW_METRICS_COLUMN - EMPTY_COLUMN_HEADER - COUNT_METRIC_COLUMN - PivotTableFieldCollapseState: + RadarChartAxesRangeScale: type: string enum: - - COLLAPSED - - EXPANDED - PivotTableFieldCollapseStateOption: - type: object - properties: - Target: - $ref: '#/components/schemas/PivotTableFieldCollapseStateTarget' - State: - $ref: '#/components/schemas/PivotTableFieldCollapseState' - required: - - Target + - AUTO + - INDEPENDENT + - SHARED + ConditionalFormattingCustomIconCondition: additionalProperties: false - PivotTableFieldCollapseStateTarget: type: object properties: - FieldId: + Expression: + minLength: 1 type: string - FieldDataPathValues: - type: array - items: - $ref: '#/components/schemas/DataPathValue' - maxItems: 20 - minItems: 0 + maxLength: 4096 + Color: + pattern: ^#[A-F0-9]{6}$ + type: string + DisplayConfiguration: + $ref: '#/components/schemas/ConditionalFormattingIconDisplayConfiguration' + IconOptions: + $ref: '#/components/schemas/ConditionalFormattingCustomIconOptions' + required: + - Expression + - IconOptions + FilterTextAreaControl: additionalProperties: false - PivotTableFieldOption: type: object properties: - FieldId: + FilterControlId: + minLength: 1 + pattern: ^[\w\-]+$ type: string maxLength: 512 + Delimiter: minLength: 1 - CustomLabel: type: string maxLength: 2048 + DisplayOptions: + $ref: '#/components/schemas/TextAreaControlDisplayOptions' + Title: minLength: 1 - Visibility: - $ref: '#/components/schemas/Visibility' + type: string + maxLength: 2048 + SourceFilterId: + minLength: 1 + pattern: ^[\w\-]+$ + type: string + maxLength: 512 required: - - FieldId + - FilterControlId + - SourceFilterId + - Title + BaseMapStyleType: + type: string + enum: + - LIGHT_GRAY + - DARK_GRAY + - STREET + - IMAGERY + InsightVisual: additionalProperties: false - PivotTableFieldOptions: type: object properties: - SelectedFieldOptions: - type: array - items: - $ref: '#/components/schemas/PivotTableFieldOption' - maxItems: 100 + Subtitle: + $ref: '#/components/schemas/VisualSubtitleLabelOptions' + VisualId: + minLength: 1 + pattern: ^[\w\-]+$ + type: string + maxLength: 512 + Actions: minItems: 0 - DataPathOptions: + maxItems: 10 type: array items: - $ref: '#/components/schemas/PivotTableDataPathOption' - maxItems: 100 + $ref: '#/components/schemas/VisualCustomAction' + DataSetIdentifier: + minLength: 1 + type: string + maxLength: 2048 + InsightConfiguration: + $ref: '#/components/schemas/InsightConfiguration' + Title: + $ref: '#/components/schemas/VisualTitleLabelOptions' + required: + - DataSetIdentifier + - VisualId + TableSortConfiguration: + additionalProperties: false + type: object + properties: + RowSort: minItems: 0 - CollapseStateOptions: + maxItems: 100 type: array items: - $ref: '#/components/schemas/PivotTableFieldCollapseStateOption' + $ref: '#/components/schemas/FieldSortOptions' + PaginationConfiguration: + $ref: '#/components/schemas/PaginationConfiguration' + FreeFormLayoutScreenCanvasSizeOptions: additionalProperties: false - PivotTableFieldSubtotalOptions: type: object properties: - FieldId: + OptimizedViewPortWidth: + description: String based length that is composed of value and unit in px type: string - maxLength: 512 - minLength: 1 + required: + - OptimizedViewPortWidth + ContributionAnalysisDefault: additionalProperties: false - PivotTableFieldWells: type: object properties: - PivotTableAggregatedFieldWells: - $ref: '#/components/schemas/PivotTableAggregatedFieldWells' + MeasureFieldId: + minLength: 1 + type: string + maxLength: 512 + ContributorDimensions: + minItems: 1 + maxItems: 4 + type: array + items: + $ref: '#/components/schemas/ColumnIdentifier' + required: + - ContributorDimensions + - MeasureFieldId + GradientColor: additionalProperties: false - PivotTableMetricPlacement: - type: string - enum: - - ROW - - COLUMN - PivotTableOptions: type: object properties: - MetricPlacement: - $ref: '#/components/schemas/PivotTableMetricPlacement' - SingleMetricVisibility: - $ref: '#/components/schemas/Visibility' - ColumnNamesVisibility: - $ref: '#/components/schemas/Visibility' - ToggleButtonsVisibility: - $ref: '#/components/schemas/Visibility' - ColumnHeaderStyle: - $ref: '#/components/schemas/TableCellStyle' - RowHeaderStyle: - $ref: '#/components/schemas/TableCellStyle' - CellStyle: - $ref: '#/components/schemas/TableCellStyle' - RowFieldNamesStyle: - $ref: '#/components/schemas/TableCellStyle' - RowAlternateColorOptions: - $ref: '#/components/schemas/RowAlternateColorOptions' - CollapsedRowDimensionsVisibility: - $ref: '#/components/schemas/Visibility' - RowsLayout: - $ref: '#/components/schemas/PivotTableRowsLayout' - RowsLabelOptions: - $ref: '#/components/schemas/PivotTableRowsLabelOptions' - DefaultCellWidth: - type: string - description: String based length that is composed of value and unit in px - additionalProperties: false - PivotTablePaginatedReportOptions: - type: object - properties: - VerticalOverflowVisibility: - $ref: '#/components/schemas/Visibility' - OverflowColumnHeaderVisibility: - $ref: '#/components/schemas/Visibility' - additionalProperties: false - PivotTableRowsLabelOptions: - type: object - properties: - Visibility: - $ref: '#/components/schemas/Visibility' - CustomLabel: - type: string - maxLength: 1024 - minLength: 1 + Stops: + minItems: 0 + maxItems: 100 + type: array + items: + $ref: '#/components/schemas/GradientStop' + TableFieldImageConfiguration: additionalProperties: false - PivotTableRowsLayout: - type: string - enum: - - TABULAR - - HIERARCHY - PivotTableSortBy: type: object properties: - Field: - $ref: '#/components/schemas/FieldSort' - Column: - $ref: '#/components/schemas/ColumnSort' - DataPath: - $ref: '#/components/schemas/DataPathSort' + SizingOptions: + $ref: '#/components/schemas/TableCellImageSizingConfiguration' + GaugeChartConditionalFormattingOption: additionalProperties: false - PivotTableSortConfiguration: type: object properties: - FieldSortOptions: - type: array - items: - $ref: '#/components/schemas/PivotFieldSortOptions' - maxItems: 200 - minItems: 0 + Arc: + $ref: '#/components/schemas/GaugeChartArcConditionalFormatting' + PrimaryValue: + $ref: '#/components/schemas/GaugeChartPrimaryValueConditionalFormatting' + PieChartFieldWells: additionalProperties: false - PivotTableSubtotalLevel: - type: string - enum: - - ALL - - CUSTOM - - LAST - PivotTableTotalOptions: type: object properties: - RowSubtotalOptions: - $ref: '#/components/schemas/SubtotalOptions' - ColumnSubtotalOptions: - $ref: '#/components/schemas/SubtotalOptions' - RowTotalOptions: - $ref: '#/components/schemas/PivotTotalOptions' - ColumnTotalOptions: - $ref: '#/components/schemas/PivotTotalOptions' + PieChartAggregatedFieldWells: + $ref: '#/components/schemas/PieChartAggregatedFieldWells' + VisualCustomAction: additionalProperties: false - PivotTableVisual: type: object properties: - VisualId: + Status: + $ref: '#/components/schemas/WidgetStatus' + Trigger: + $ref: '#/components/schemas/VisualCustomActionTrigger' + CustomActionId: + minLength: 1 + pattern: ^[\w\-]+$ type: string maxLength: 512 + Name: minLength: 1 - pattern: '[\w\-]+' - Title: - $ref: '#/components/schemas/VisualTitleLabelOptions' - Subtitle: - $ref: '#/components/schemas/VisualSubtitleLabelOptions' - ChartConfiguration: - $ref: '#/components/schemas/PivotTableConfiguration' - ConditionalFormatting: - $ref: '#/components/schemas/PivotTableConditionalFormatting' - Actions: + type: string + maxLength: 256 + ActionOperations: + minItems: 1 + maxItems: 2 type: array items: - $ref: '#/components/schemas/VisualCustomAction' - maxItems: 10 - minItems: 0 + $ref: '#/components/schemas/VisualCustomActionOperation' required: - - VisualId + - ActionOperations + - CustomActionId + - Name + - Trigger + TopBottomFilter: additionalProperties: false - PivotTotalOptions: type: object properties: - TotalsVisibility: - $ref: '#/components/schemas/Visibility' - TotalAggregationOptions: + AggregationSortConfigurations: + minItems: 0 + maxItems: 100 type: array items: - $ref: '#/components/schemas/TotalAggregationOption' - maxItems: 200 - minItems: 0 - Placement: - $ref: '#/components/schemas/TableTotalsPlacement' - ScrollStatus: - $ref: '#/components/schemas/TableTotalsScrollStatus' - CustomLabel: + $ref: '#/components/schemas/AggregationSortConfiguration' + Column: + $ref: '#/components/schemas/ColumnIdentifier' + TimeGranularity: + $ref: '#/components/schemas/TimeGranularity' + ParameterName: + minLength: 1 + pattern: ^[a-zA-Z0-9]+$ type: string - TotalCellStyle: - $ref: '#/components/schemas/TableCellStyle' - ValueCellStyle: - $ref: '#/components/schemas/TableCellStyle' - MetricHeaderCellStyle: - $ref: '#/components/schemas/TableCellStyle' - additionalProperties: false - PredefinedHierarchy: - type: object - properties: - HierarchyId: + maxLength: 2048 + Limit: + default: null + type: number + DefaultFilterControlConfiguration: + $ref: '#/components/schemas/DefaultFilterControlConfiguration' + FilterId: + minLength: 1 + pattern: ^[\w\-]+$ type: string maxLength: 512 - minLength: 1 - Columns: - type: array - items: - $ref: '#/components/schemas/ColumnIdentifier' - maxItems: 10 - minItems: 1 - DrillDownFilters: - type: array - items: - $ref: '#/components/schemas/DrillDownFilter' - maxItems: 10 - minItems: 0 required: - - Columns - - HierarchyId + - AggregationSortConfigurations + - Column + - FilterId + KPIConfiguration: additionalProperties: false - PrimaryValueDisplayType: + type: object + properties: + SortConfiguration: + $ref: '#/components/schemas/KPISortConfiguration' + KPIOptions: + $ref: '#/components/schemas/KPIOptions' + FieldWells: + $ref: '#/components/schemas/KPIFieldWells' + PivotTableFieldCollapseState: type: string enum: - - HIDDEN - - COMPARISON - - ACTUAL - ProgressBarOptions: + - COLLAPSED + - EXPANDED + MinimumLabelType: + additionalProperties: false type: object properties: Visibility: $ref: '#/components/schemas/Visibility' + CategoryFilterConfiguration: additionalProperties: false - RadarChartAggregatedFieldWells: type: object properties: - Category: - type: array - items: - $ref: '#/components/schemas/DimensionField' - maxItems: 1 - minItems: 0 - Color: - type: array - items: - $ref: '#/components/schemas/DimensionField' - maxItems: 1 - minItems: 0 - Values: - type: array - items: - $ref: '#/components/schemas/MeasureField' - maxItems: 20 - minItems: 0 + CustomFilterListConfiguration: + $ref: '#/components/schemas/CustomFilterListConfiguration' + CustomFilterConfiguration: + $ref: '#/components/schemas/CustomFilterConfiguration' + FilterListConfiguration: + $ref: '#/components/schemas/FilterListConfiguration' + NumericEqualityDrillDownFilter: additionalProperties: false - RadarChartAreaStyleSettings: type: object properties: - Visibility: - $ref: '#/components/schemas/Visibility' - additionalProperties: false - RadarChartAxesRangeScale: + Column: + $ref: '#/components/schemas/ColumnIdentifier' + Value: + default: 0 + type: number + required: + - Column + - Value + TimeGranularity: type: string enum: - - AUTO - - INDEPENDENT - - SHARED - RadarChartConfiguration: - type: object - properties: - FieldWells: - $ref: '#/components/schemas/RadarChartFieldWells' - SortConfiguration: - $ref: '#/components/schemas/RadarChartSortConfiguration' - Shape: - $ref: '#/components/schemas/RadarChartShape' - BaseSeriesSettings: - $ref: '#/components/schemas/RadarChartSeriesSettings' - StartAngle: - type: number - maximum: 360 - minimum: -360 - VisualPalette: - $ref: '#/components/schemas/VisualPalette' - AlternateBandColorsVisibility: - $ref: '#/components/schemas/Visibility' - AlternateBandEvenColor: - type: string - pattern: ^#[A-F0-9]{6}$ - AlternateBandOddColor: + - YEAR + - QUARTER + - MONTH + - WEEK + - DAY + - HOUR + - MINUTE + - SECOND + - MILLISECOND + GaugeChartVisual: + additionalProperties: false + type: object + properties: + Subtitle: + $ref: '#/components/schemas/VisualSubtitleLabelOptions' + ConditionalFormatting: + $ref: '#/components/schemas/GaugeChartConditionalFormatting' + VisualId: + minLength: 1 + pattern: ^[\w\-]+$ type: string - pattern: ^#[A-F0-9]{6}$ - CategoryAxis: - $ref: '#/components/schemas/AxisDisplayOptions' - CategoryLabelOptions: - $ref: '#/components/schemas/ChartAxisLabelOptions' - ColorAxis: - $ref: '#/components/schemas/AxisDisplayOptions' - ColorLabelOptions: - $ref: '#/components/schemas/ChartAxisLabelOptions' + maxLength: 512 + ChartConfiguration: + $ref: '#/components/schemas/GaugeChartConfiguration' + Actions: + minItems: 0 + maxItems: 10 + type: array + items: + $ref: '#/components/schemas/VisualCustomAction' + Title: + $ref: '#/components/schemas/VisualTitleLabelOptions' + required: + - VisualId + FilledMapConfiguration: + additionalProperties: false + type: object + properties: + SortConfiguration: + $ref: '#/components/schemas/FilledMapSortConfiguration' Legend: $ref: '#/components/schemas/LegendOptions' - AxesRangeScale: - $ref: '#/components/schemas/RadarChartAxesRangeScale' + MapStyleOptions: + $ref: '#/components/schemas/GeospatialMapStyleOptions' + FieldWells: + $ref: '#/components/schemas/FilledMapFieldWells' + Tooltip: + $ref: '#/components/schemas/TooltipOptions' + WindowOptions: + $ref: '#/components/schemas/GeospatialWindowOptions' + VisibleRangeOptions: additionalProperties: false - RadarChartFieldWells: type: object properties: - RadarChartAggregatedFieldWells: - $ref: '#/components/schemas/RadarChartAggregatedFieldWells' + PercentRange: + $ref: '#/components/schemas/PercentVisibleRange' + ForecastComputationSeasonality: + type: string + enum: + - AUTOMATIC + - CUSTOM + KPIComparisonValueConditionalFormatting: additionalProperties: false - RadarChartSeriesSettings: type: object properties: - AreaStyleSettings: - $ref: '#/components/schemas/RadarChartAreaStyleSettings' + TextColor: + $ref: '#/components/schemas/ConditionalFormattingColor' + Icon: + $ref: '#/components/schemas/ConditionalFormattingIcon' + RangeEndsLabelType: additionalProperties: false - RadarChartShape: - type: string - enum: - - CIRCLE - - POLYGON - RadarChartSortConfiguration: type: object properties: - CategorySort: - type: array - items: - $ref: '#/components/schemas/FieldSortOptions' - maxItems: 100 - minItems: 0 - CategoryItemsLimit: - $ref: '#/components/schemas/ItemsLimitConfiguration' - ColorSort: - type: array - items: - $ref: '#/components/schemas/FieldSortOptions' - maxItems: 100 - minItems: 0 - ColorItemsLimit: - $ref: '#/components/schemas/ItemsLimitConfiguration' + Visibility: + $ref: '#/components/schemas/Visibility' + LegendOptions: additionalProperties: false - RadarChartVisual: type: object properties: - VisualId: + Position: + $ref: '#/components/schemas/LegendPosition' + Title: + $ref: '#/components/schemas/LabelOptions' + Visibility: + $ref: '#/components/schemas/Visibility' + Height: + description: String based length that is composed of value and unit in px type: string - maxLength: 512 + Width: + description: String based length that is composed of value and unit in px + type: string + ShortFormatText: + additionalProperties: false + type: object + properties: + RichText: minLength: 1 - pattern: '[\w\-]+' - Title: - $ref: '#/components/schemas/VisualTitleLabelOptions' + type: string + maxLength: 1024 + PlainText: + minLength: 1 + type: string + maxLength: 512 + PieChartVisual: + additionalProperties: false + type: object + properties: Subtitle: $ref: '#/components/schemas/VisualSubtitleLabelOptions' + VisualId: + minLength: 1 + pattern: ^[\w\-]+$ + type: string + maxLength: 512 ChartConfiguration: - $ref: '#/components/schemas/RadarChartConfiguration' + $ref: '#/components/schemas/PieChartConfiguration' Actions: + minItems: 0 + maxItems: 10 type: array items: $ref: '#/components/schemas/VisualCustomAction' - maxItems: 10 - minItems: 0 + Title: + $ref: '#/components/schemas/VisualTitleLabelOptions' ColumnHierarchies: + minItems: 0 + maxItems: 2 type: array items: $ref: '#/components/schemas/ColumnHierarchy' - maxItems: 2 - minItems: 0 required: - VisualId + ComparisonConfiguration: additionalProperties: false - RangeEndsLabelType: type: object properties: - Visibility: - $ref: '#/components/schemas/Visibility' + ComparisonMethod: + $ref: '#/components/schemas/ComparisonMethod' + ComparisonFormat: + $ref: '#/components/schemas/ComparisonFormatConfiguration' + ConditionalFormattingGradientColor: additionalProperties: false - ReferenceLine: type: object properties: - Status: - $ref: '#/components/schemas/WidgetStatus' - DataConfiguration: - $ref: '#/components/schemas/ReferenceLineDataConfiguration' - StyleConfiguration: - $ref: '#/components/schemas/ReferenceLineStyleConfiguration' - LabelConfiguration: - $ref: '#/components/schemas/ReferenceLineLabelConfiguration' + Expression: + minLength: 1 + type: string + maxLength: 4096 + Color: + $ref: '#/components/schemas/GradientColor' required: - - DataConfiguration + - Color + - Expression + TableFieldCustomTextContent: additionalProperties: false - ReferenceLineCustomLabelConfiguration: type: object properties: - CustomLabel: + Value: type: string - pattern: .*\S.* + FontConfiguration: + $ref: '#/components/schemas/FontConfiguration' required: - - CustomLabel + - FontConfiguration + ArcConfiguration: additionalProperties: false - ReferenceLineDataConfiguration: type: object properties: - StaticConfiguration: - $ref: '#/components/schemas/ReferenceLineStaticDataConfiguration' - DynamicConfiguration: - $ref: '#/components/schemas/ReferenceLineDynamicDataConfiguration' - AxisBinding: - $ref: '#/components/schemas/AxisBinding' - SeriesType: - $ref: '#/components/schemas/ReferenceLineSeriesType' + ArcAngle: + default: null + type: number + ArcThickness: + $ref: '#/components/schemas/ArcThicknessOptions' + LineChartSortConfiguration: additionalProperties: false - ReferenceLineDynamicDataConfiguration: type: object properties: - Column: - $ref: '#/components/schemas/ColumnIdentifier' - MeasureAggregationFunction: - $ref: '#/components/schemas/AggregationFunction' - Calculation: - $ref: '#/components/schemas/NumericalAggregationFunction' - required: - - Calculation - - Column + CategoryItemsLimitConfiguration: + $ref: '#/components/schemas/ItemsLimitConfiguration' + ColorItemsLimitConfiguration: + $ref: '#/components/schemas/ItemsLimitConfiguration' + SmallMultiplesSort: + minItems: 0 + maxItems: 100 + type: array + items: + $ref: '#/components/schemas/FieldSortOptions' + CategorySort: + minItems: 0 + maxItems: 100 + type: array + items: + $ref: '#/components/schemas/FieldSortOptions' + SmallMultiplesLimitConfiguration: + $ref: '#/components/schemas/ItemsLimitConfiguration' + TotalAggregationComputation: additionalProperties: false - ReferenceLineLabelConfiguration: type: object properties: - ValueLabelConfiguration: - $ref: '#/components/schemas/ReferenceLineValueLabelConfiguration' - CustomLabelConfiguration: - $ref: '#/components/schemas/ReferenceLineCustomLabelConfiguration' - FontConfiguration: - $ref: '#/components/schemas/FontConfiguration' - FontColor: + Value: + $ref: '#/components/schemas/MeasureField' + ComputationId: + minLength: 1 + pattern: ^[\w\-]+$ type: string - pattern: ^#[A-F0-9]{6}$ - HorizontalPosition: - $ref: '#/components/schemas/ReferenceLineLabelHorizontalPosition' - VerticalPosition: - $ref: '#/components/schemas/ReferenceLineLabelVerticalPosition' + maxLength: 512 + Name: + type: string + required: + - ComputationId + DateTimeParameterDeclaration: additionalProperties: false - ReferenceLineLabelHorizontalPosition: - type: string - enum: - - LEFT - - CENTER - - RIGHT - ReferenceLineLabelVerticalPosition: - type: string - enum: - - ABOVE - - BELOW - ReferenceLinePatternType: - type: string - enum: - - SOLID - - DASHED - - DOTTED - ReferenceLineSeriesType: - type: string - enum: - - BAR - - LINE - ReferenceLineStaticDataConfiguration: type: object properties: - Value: - type: number - default: 0 + MappedDataSetParameters: + minItems: 0 + maxItems: 150 + type: array + items: + $ref: '#/components/schemas/MappedDataSetParameter' + DefaultValues: + $ref: '#/components/schemas/DateTimeDefaultValues' + TimeGranularity: + $ref: '#/components/schemas/TimeGranularity' + ValueWhenUnset: + $ref: '#/components/schemas/DateTimeValueWhenUnsetConfiguration' + Name: + minLength: 1 + pattern: ^[a-zA-Z0-9]+$ + type: string + maxLength: 2048 required: - - Value + - Name + ParameterTextAreaControl: additionalProperties: false - ReferenceLineStyleConfiguration: type: object properties: - Pattern: - $ref: '#/components/schemas/ReferenceLinePatternType' - Color: + ParameterControlId: + minLength: 1 + pattern: ^[\w\-]+$ type: string - pattern: ^#[A-F0-9]{6}$ + maxLength: 512 + Delimiter: + minLength: 1 + type: string + maxLength: 2048 + DisplayOptions: + $ref: '#/components/schemas/TextAreaControlDisplayOptions' + SourceParameterName: + minLength: 1 + pattern: ^[a-zA-Z0-9]+$ + type: string + maxLength: 2048 + Title: + minLength: 1 + type: string + maxLength: 2048 + required: + - ParameterControlId + - SourceParameterName + - Title + TableCellStyle: additionalProperties: false - ReferenceLineValueLabelConfiguration: type: object properties: - RelativePosition: - $ref: '#/components/schemas/ReferenceLineValueLabelRelativePosition' - FormatConfiguration: - $ref: '#/components/schemas/NumericFormatConfiguration' + VerticalTextAlignment: + $ref: '#/components/schemas/VerticalTextAlignment' + Visibility: + $ref: '#/components/schemas/Visibility' + Height: + maximum: 500 + type: number + minimum: 8 + FontConfiguration: + $ref: '#/components/schemas/FontConfiguration' + Border: + $ref: '#/components/schemas/GlobalTableBorderOptions' + TextWrap: + $ref: '#/components/schemas/TextWrap' + HorizontalTextAlignment: + $ref: '#/components/schemas/HorizontalTextAlignment' + BackgroundColor: + pattern: ^#[A-F0-9]{6}$ + type: string + IntegerValueWhenUnsetConfiguration: additionalProperties: false - ReferenceLineValueLabelRelativePosition: + type: object + properties: + ValueWhenUnsetOption: + $ref: '#/components/schemas/ValueWhenUnsetOption' + CustomValue: + default: null + type: number + PaperSize: type: string enum: - - BEFORE_CUSTOM_LABEL - - AFTER_CUSTOM_LABEL - RelativeDateTimeControlDisplayOptions: + - US_LETTER + - US_LEGAL + - US_TABLOID_LEDGER + - A0 + - A1 + - A2 + - A3 + - A4 + - A5 + - JIS_B4 + - JIS_B5 + ReferenceLine: + additionalProperties: false type: object properties: - TitleOptions: - $ref: '#/components/schemas/LabelOptions' - DateTimeFormat: + Status: + $ref: '#/components/schemas/WidgetStatus' + DataConfiguration: + $ref: '#/components/schemas/ReferenceLineDataConfiguration' + LabelConfiguration: + $ref: '#/components/schemas/ReferenceLineLabelConfiguration' + StyleConfiguration: + $ref: '#/components/schemas/ReferenceLineStyleConfiguration' + required: + - DataConfiguration + HistogramAggregatedFieldWells: + additionalProperties: false + type: object + properties: + Values: + minItems: 0 + maxItems: 1 + type: array + items: + $ref: '#/components/schemas/MeasureField' + ColumnIdentifier: + additionalProperties: false + type: object + properties: + ColumnName: + minLength: 1 type: string - maxLength: 128 + maxLength: 127 + DataSetIdentifier: minLength: 1 - InfoIconLabelOptions: - $ref: '#/components/schemas/SheetControlInfoIconLabelOptions' + type: string + maxLength: 2048 + required: + - ColumnName + - DataSetIdentifier + PivotTableConfiguration: additionalProperties: false - RelativeDateType: + type: object + properties: + SortConfiguration: + $ref: '#/components/schemas/PivotTableSortConfiguration' + PaginatedReportOptions: + $ref: '#/components/schemas/PivotTablePaginatedReportOptions' + TableOptions: + $ref: '#/components/schemas/PivotTableOptions' + FieldWells: + $ref: '#/components/schemas/PivotTableFieldWells' + FieldOptions: + $ref: '#/components/schemas/PivotTableFieldOptions' + TotalOptions: + $ref: '#/components/schemas/PivotTableTotalOptions' + LoadingAnimation: + additionalProperties: false + type: object + properties: + Visibility: + $ref: '#/components/schemas/Visibility' + TotalOptions: + additionalProperties: false + type: object + properties: + TotalAggregationOptions: + minItems: 0 + maxItems: 200 + type: array + items: + $ref: '#/components/schemas/TotalAggregationOption' + CustomLabel: + type: string + ScrollStatus: + $ref: '#/components/schemas/TableTotalsScrollStatus' + Placement: + $ref: '#/components/schemas/TableTotalsPlacement' + TotalCellStyle: + $ref: '#/components/schemas/TableCellStyle' + TotalsVisibility: + $ref: '#/components/schemas/Visibility' + ForecastScenario: + additionalProperties: false + type: object + properties: + WhatIfRangeScenario: + $ref: '#/components/schemas/WhatIfRangeScenario' + WhatIfPointScenario: + $ref: '#/components/schemas/WhatIfPointScenario' + RowAlternateColorOptions: + additionalProperties: false + type: object + properties: + Status: + $ref: '#/components/schemas/WidgetStatus' + UsePrimaryBackgroundColor: + $ref: '#/components/schemas/WidgetStatus' + RowAlternateColors: + minItems: 0 + maxItems: 1 + type: array + items: + pattern: ^#[A-F0-9]{6}$ + type: string + DefaultRelativeDateTimeControlOptions: + additionalProperties: false + type: object + properties: + DisplayOptions: + $ref: '#/components/schemas/RelativeDateTimeControlDisplayOptions' + SectionPageBreakConfiguration: + additionalProperties: false + type: object + properties: + After: + $ref: '#/components/schemas/SectionAfterPageBreak' + SheetContentType: type: string enum: - - PREVIOUS - - THIS - - LAST - - NOW - - NEXT - RelativeDatesFilter: + - PAGINATED + - INTERACTIVE + TextControlPlaceholderOptions: + additionalProperties: false type: object properties: - FilterId: + Visibility: + $ref: '#/components/schemas/Visibility' + DonutOptions: + additionalProperties: false + type: object + properties: + DonutCenterOptions: + $ref: '#/components/schemas/DonutCenterOptions' + ArcOptions: + $ref: '#/components/schemas/ArcOptions' + TableInlineVisualization: + additionalProperties: false + type: object + properties: + DataBars: + $ref: '#/components/schemas/DataBarsOptions' + CustomActionFilterOperation: + additionalProperties: false + type: object + properties: + SelectedFieldsConfiguration: + $ref: '#/components/schemas/FilterOperationSelectedFieldsConfiguration' + TargetVisualsConfiguration: + $ref: '#/components/schemas/FilterOperationTargetVisualsConfiguration' + required: + - SelectedFieldsConfiguration + - TargetVisualsConfiguration + RadarChartVisual: + additionalProperties: false + type: object + properties: + Subtitle: + $ref: '#/components/schemas/VisualSubtitleLabelOptions' + VisualId: + minLength: 1 + pattern: ^[\w\-]+$ type: string maxLength: 512 + ChartConfiguration: + $ref: '#/components/schemas/RadarChartConfiguration' + Actions: + minItems: 0 + maxItems: 10 + type: array + items: + $ref: '#/components/schemas/VisualCustomAction' + Title: + $ref: '#/components/schemas/VisualTitleLabelOptions' + ColumnHierarchies: + minItems: 0 + maxItems: 2 + type: array + items: + $ref: '#/components/schemas/ColumnHierarchy' + required: + - VisualId + CalculatedField: + additionalProperties: false + type: object + properties: + Expression: + minLength: 1 + type: string + maxLength: 32000 + DataSetIdentifier: minLength: 1 - pattern: '[\w\-]+' - Column: - $ref: '#/components/schemas/ColumnIdentifier' - AnchorDateConfiguration: - $ref: '#/components/schemas/AnchorDateConfiguration' - MinimumGranularity: - $ref: '#/components/schemas/TimeGranularity' - TimeGranularity: - $ref: '#/components/schemas/TimeGranularity' - RelativeDateType: - $ref: '#/components/schemas/RelativeDateType' - RelativeDateValue: - type: number - default: null - ParameterName: type: string maxLength: 2048 + Name: minLength: 1 - pattern: ^[a-zA-Z0-9]+$ - NullOption: - $ref: '#/components/schemas/FilterNullOption' - ExcludePeriodConfiguration: - $ref: '#/components/schemas/ExcludePeriodConfiguration' + type: string + maxLength: 127 required: - - AnchorDateConfiguration - - Column - - FilterId - - NullOption - - RelativeDateType - - TimeGranularity - additionalProperties: false - RelativeFontSize: - type: string - enum: - - EXTRA_SMALL - - SMALL - - MEDIUM - - LARGE - - EXTRA_LARGE - ResizeOption: + - DataSetIdentifier + - Expression + - Name + ValidationStrategyMode: type: string enum: - - FIXED - - RESPONSIVE - ResourcePermission: + - STRICT + - LENIENT + WaterfallChartSortConfiguration: + additionalProperties: false type: object properties: - Principal: + BreakdownItemsLimit: + $ref: '#/components/schemas/ItemsLimitConfiguration' + CategorySort: + minItems: 0 + maxItems: 100 + type: array + items: + $ref: '#/components/schemas/FieldSortOptions' + ColumnHierarchy: + additionalProperties: false + type: object + properties: + DateTimeHierarchy: + $ref: '#/components/schemas/DateTimeHierarchy' + ExplicitHierarchy: + $ref: '#/components/schemas/ExplicitHierarchy' + PredefinedHierarchy: + $ref: '#/components/schemas/PredefinedHierarchy' + StringParameter: + description:

A string parameter.

+ additionalProperties: false + type: object + properties: + Values: + description:

The values of a string parameter.

+ type: array + items: + type: string + Name: + pattern: \S + description:

A display name for a string parameter.

type: string - maxLength: 256 + required: + - Name + - Values + MaximumMinimumComputation: + additionalProperties: false + type: object + properties: + Type: + $ref: '#/components/schemas/MaximumMinimumComputationType' + Value: + $ref: '#/components/schemas/MeasureField' + Time: + $ref: '#/components/schemas/DimensionField' + ComputationId: minLength: 1 - Actions: + pattern: ^[\w\-]+$ + type: string + maxLength: 512 + Name: + type: string + required: + - ComputationId + - Type + RadarChartSortConfiguration: + additionalProperties: false + type: object + properties: + ColorSort: + minItems: 0 + maxItems: 100 type: array items: - type: string - maxItems: 20 - minItems: 1 + $ref: '#/components/schemas/FieldSortOptions' + ColorItemsLimit: + $ref: '#/components/schemas/ItemsLimitConfiguration' + CategoryItemsLimit: + $ref: '#/components/schemas/ItemsLimitConfiguration' + CategorySort: + minItems: 0 + maxItems: 100 + type: array + items: + $ref: '#/components/schemas/FieldSortOptions' + GridLayoutConfiguration: + additionalProperties: false + type: object + properties: + CanvasSizeOptions: + $ref: '#/components/schemas/GridLayoutCanvasSizeOptions' + Elements: + minItems: 0 + maxItems: 430 + type: array + items: + $ref: '#/components/schemas/GridLayoutElement' required: - - Actions - - Principal + - Elements + HistogramBinOptions: additionalProperties: false - ResourceStatus: + type: object + properties: + BinWidth: + $ref: '#/components/schemas/BinWidthOptions' + StartValue: + default: null + type: number + SelectedBinType: + $ref: '#/components/schemas/HistogramBinType' + BinCount: + $ref: '#/components/schemas/BinCountOptions' + TableBorderStyle: + type: string + enum: + - NONE + - SOLID + PivotTableFieldSubtotalOptions: + additionalProperties: false + type: object + properties: + FieldId: + minLength: 1 + type: string + maxLength: 512 + TimeBasedForecastProperties: + additionalProperties: false + type: object + properties: + PeriodsBackward: + maximum: 1000 + type: number + minimum: 0 + PeriodsForward: + maximum: 1000 + type: number + minimum: 1 + PredictionInterval: + maximum: 95 + type: number + minimum: 50 + Seasonality: + maximum: 180 + type: number + minimum: 1 + UpperBoundary: + default: null + type: number + LowerBoundary: + default: null + type: number + SelectedTooltipType: type: string enum: - - CREATION_IN_PROGRESS - - CREATION_SUCCESSFUL - - CREATION_FAILED - - UPDATE_IN_PROGRESS - - UPDATE_SUCCESSFUL - - UPDATE_FAILED - - DELETED - RollingDateConfiguration: + - BASIC + - DETAILED + SheetDefinition: + additionalProperties: false type: object properties: - DataSetIdentifier: - type: string - maxLength: 2048 + Description: minLength: 1 - Expression: type: string - maxLength: 4096 - minLength: 1 - required: - - Expression - additionalProperties: false - RowAlternateColorOptions: - type: object - properties: - Status: - $ref: '#/components/schemas/WidgetStatus' - RowAlternateColors: + maxLength: 1024 + ParameterControls: + minItems: 0 + maxItems: 200 type: array items: - type: string - pattern: ^#[A-F0-9]{6}$ - maxItems: 1 + $ref: '#/components/schemas/ParameterControl' + TextBoxes: minItems: 0 - UsePrimaryBackgroundColor: - $ref: '#/components/schemas/WidgetStatus' - additionalProperties: false - SameSheetTargetVisualConfiguration: - type: object - properties: - TargetVisuals: + maxItems: 100 type: array items: - type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - maxItems: 50 + $ref: '#/components/schemas/SheetTextBox' + Layouts: minItems: 1 - TargetVisualOptions: - $ref: '#/components/schemas/TargetVisualOptions' - additionalProperties: false - SankeyDiagramAggregatedFieldWells: - type: object - properties: - Source: + maxItems: 1 type: array items: - $ref: '#/components/schemas/DimensionField' - maxItems: 200 + $ref: '#/components/schemas/Layout' + ContentType: + $ref: '#/components/schemas/SheetContentType' + SheetId: + minLength: 1 + pattern: ^[\w\-]+$ + type: string + maxLength: 512 + FilterControls: minItems: 0 - Destination: + maxItems: 200 type: array items: - $ref: '#/components/schemas/DimensionField' - maxItems: 200 + $ref: '#/components/schemas/FilterControl' + SheetControlLayouts: minItems: 0 - Weight: + maxItems: 1 type: array items: - $ref: '#/components/schemas/MeasureField' - maxItems: 200 + $ref: '#/components/schemas/SheetControlLayout' + Title: + minLength: 1 + type: string + maxLength: 1024 + Visuals: minItems: 0 + maxItems: 50 + type: array + items: + $ref: '#/components/schemas/Visual' + Name: + minLength: 1 + type: string + maxLength: 2048 + required: + - SheetId + Filter: additionalProperties: false - SankeyDiagramChartConfiguration: - type: object - properties: - FieldWells: - $ref: '#/components/schemas/SankeyDiagramFieldWells' - SortConfiguration: - $ref: '#/components/schemas/SankeyDiagramSortConfiguration' - DataLabels: - $ref: '#/components/schemas/DataLabelOptions' - additionalProperties: false - SankeyDiagramFieldWells: - type: object - properties: - SankeyDiagramAggregatedFieldWells: - $ref: '#/components/schemas/SankeyDiagramAggregatedFieldWells' - additionalProperties: false - SankeyDiagramSortConfiguration: type: object properties: - WeightSort: - type: array - items: - $ref: '#/components/schemas/FieldSortOptions' - maxItems: 100 - minItems: 0 - SourceItemsLimit: - $ref: '#/components/schemas/ItemsLimitConfiguration' - DestinationItemsLimit: - $ref: '#/components/schemas/ItemsLimitConfiguration' + NumericEqualityFilter: + $ref: '#/components/schemas/NumericEqualityFilter' + NumericRangeFilter: + $ref: '#/components/schemas/NumericRangeFilter' + TimeRangeFilter: + $ref: '#/components/schemas/TimeRangeFilter' + RelativeDatesFilter: + $ref: '#/components/schemas/RelativeDatesFilter' + TopBottomFilter: + $ref: '#/components/schemas/TopBottomFilter' + TimeEqualityFilter: + $ref: '#/components/schemas/TimeEqualityFilter' + CategoryFilter: + $ref: '#/components/schemas/CategoryFilter' + ReferenceLineCustomLabelConfiguration: additionalProperties: false - SankeyDiagramVisual: type: object properties: - VisualId: + CustomLabel: + pattern: \S type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Title: - $ref: '#/components/schemas/VisualTitleLabelOptions' - Subtitle: - $ref: '#/components/schemas/VisualSubtitleLabelOptions' - ChartConfiguration: - $ref: '#/components/schemas/SankeyDiagramChartConfiguration' - Actions: - type: array - items: - $ref: '#/components/schemas/VisualCustomAction' - maxItems: 10 - minItems: 0 required: - - VisualId + - CustomLabel + KPIFieldWells: additionalProperties: false - ScatterPlotCategoricallyAggregatedFieldWells: type: object properties: - XAxis: - type: array - items: - $ref: '#/components/schemas/MeasureField' - maxItems: 200 + TargetValues: minItems: 0 - YAxis: + maxItems: 200 type: array items: $ref: '#/components/schemas/MeasureField' - maxItems: 200 + TrendGroups: minItems: 0 - Category: + maxItems: 200 type: array items: $ref: '#/components/schemas/DimensionField' - maxItems: 200 + Values: minItems: 0 - Size: - type: array - items: - $ref: '#/components/schemas/MeasureField' maxItems: 200 - minItems: 0 - Label: type: array items: - $ref: '#/components/schemas/DimensionField' - maxItems: 200 - minItems: 0 + $ref: '#/components/schemas/MeasureField' + WordCloudWordCasing: + type: string + enum: + - LOWER_CASE + - EXISTING_CASE + PaginationConfiguration: additionalProperties: false - ScatterPlotConfiguration: type: object properties: - FieldWells: - $ref: '#/components/schemas/ScatterPlotFieldWells' - XAxisLabelOptions: - $ref: '#/components/schemas/ChartAxisLabelOptions' - XAxisDisplayOptions: - $ref: '#/components/schemas/AxisDisplayOptions' - YAxisLabelOptions: - $ref: '#/components/schemas/ChartAxisLabelOptions' - YAxisDisplayOptions: - $ref: '#/components/schemas/AxisDisplayOptions' - Legend: - $ref: '#/components/schemas/LegendOptions' - DataLabels: - $ref: '#/components/schemas/DataLabelOptions' - Tooltip: - $ref: '#/components/schemas/TooltipOptions' - VisualPalette: - $ref: '#/components/schemas/VisualPalette' + PageSize: + default: null + type: number + PageNumber: + type: number + minimum: 0 + required: + - PageNumber + - PageSize + ComboChartFieldWells: additionalProperties: false - ScatterPlotFieldWells: type: object properties: - ScatterPlotCategoricallyAggregatedFieldWells: - $ref: '#/components/schemas/ScatterPlotCategoricallyAggregatedFieldWells' - ScatterPlotUnaggregatedFieldWells: - $ref: '#/components/schemas/ScatterPlotUnaggregatedFieldWells' + ComboChartAggregatedFieldWells: + $ref: '#/components/schemas/ComboChartAggregatedFieldWells' + CrossDatasetTypes: + type: string + enum: + - ALL_DATASETS + - SINGLE_DATASET + CustomActionSetParametersOperation: additionalProperties: false - ScatterPlotUnaggregatedFieldWells: type: object properties: - XAxis: - type: array - items: - $ref: '#/components/schemas/DimensionField' - maxItems: 200 - minItems: 0 - YAxis: - type: array - items: - $ref: '#/components/schemas/DimensionField' - maxItems: 200 - minItems: 0 - Size: - type: array - items: - $ref: '#/components/schemas/MeasureField' + ParameterValueConfigurations: + minItems: 1 maxItems: 200 - minItems: 0 - Category: type: array items: - $ref: '#/components/schemas/DimensionField' - maxItems: 200 + $ref: '#/components/schemas/SetParameterValueConfiguration' + required: + - ParameterValueConfigurations + TableConditionalFormatting: + additionalProperties: false + type: object + properties: + ConditionalFormattingOptions: minItems: 0 - Label: + maxItems: 500 type: array items: - $ref: '#/components/schemas/DimensionField' - maxItems: 200 - minItems: 0 + $ref: '#/components/schemas/TableConditionalFormattingOption' + WhatIfRangeScenario: additionalProperties: false - ScatterPlotVisual: type: object properties: - VisualId: + StartDate: + format: date-time type: string - maxLength: 512 + Value: + default: 0 + type: number + EndDate: + format: date-time + type: string + required: + - EndDate + - StartDate + - Value + CategoricalMeasureField: + additionalProperties: false + type: object + properties: + AggregationFunction: + $ref: '#/components/schemas/CategoricalAggregationFunction' + FormatConfiguration: + $ref: '#/components/schemas/StringFormatConfiguration' + Column: + $ref: '#/components/schemas/ColumnIdentifier' + FieldId: minLength: 1 - pattern: '[\w\-]+' - Title: - $ref: '#/components/schemas/VisualTitleLabelOptions' - Subtitle: - $ref: '#/components/schemas/VisualSubtitleLabelOptions' - ChartConfiguration: - $ref: '#/components/schemas/ScatterPlotConfiguration' - Actions: - type: array - items: - $ref: '#/components/schemas/VisualCustomAction' - maxItems: 10 - minItems: 0 - ColumnHierarchies: - type: array - items: - $ref: '#/components/schemas/ColumnHierarchy' - maxItems: 2 - minItems: 0 + type: string + maxLength: 512 required: - - VisualId + - Column + - FieldId + ListControlSearchOptions: additionalProperties: false - ScrollBarOptions: type: object properties: Visibility: $ref: '#/components/schemas/Visibility' - VisibleRange: - $ref: '#/components/schemas/VisibleRangeOptions' + UniqueValuesComputation: additionalProperties: false - SecondaryValueOptions: type: object properties: - Visibility: - $ref: '#/components/schemas/Visibility' + Category: + $ref: '#/components/schemas/DimensionField' + ComputationId: + minLength: 1 + pattern: ^[\w\-]+$ + type: string + maxLength: 512 + Name: + type: string + required: + - ComputationId + SmallMultiplesAxisProperties: additionalProperties: false - SectionAfterPageBreak: type: object properties: - Status: - $ref: '#/components/schemas/SectionPageBreakStatus' + Placement: + $ref: '#/components/schemas/SmallMultiplesAxisPlacement' + Scale: + $ref: '#/components/schemas/SmallMultiplesAxisScale' + KPIVisualStandardLayoutType: + type: string + enum: + - CLASSIC + - VERTICAL + LabelOptions: additionalProperties: false - SectionBasedLayoutCanvasSizeOptions: type: object properties: - PaperCanvasSizeOptions: - $ref: '#/components/schemas/SectionBasedLayoutPaperCanvasSizeOptions' + CustomLabel: + type: string + Visibility: + $ref: '#/components/schemas/Visibility' + FontConfiguration: + $ref: '#/components/schemas/FontConfiguration' + UnaggregatedField: additionalProperties: false - SectionBasedLayoutConfiguration: type: object properties: - HeaderSections: - type: array - items: - $ref: '#/components/schemas/HeaderFooterSectionConfiguration' - maxItems: 1 + FormatConfiguration: + $ref: '#/components/schemas/FormatConfiguration' + Column: + $ref: '#/components/schemas/ColumnIdentifier' + FieldId: + minLength: 1 + type: string + maxLength: 512 + required: + - Column + - FieldId + BarChartConfiguration: + additionalProperties: false + type: object + properties: + SortConfiguration: + $ref: '#/components/schemas/BarChartSortConfiguration' + Legend: + $ref: '#/components/schemas/LegendOptions' + ReferenceLines: minItems: 0 - BodySections: + maxItems: 20 type: array items: - $ref: '#/components/schemas/BodySectionConfiguration' - maxItems: 28 - minItems: 0 - FooterSections: + $ref: '#/components/schemas/ReferenceLine' + DataLabels: + $ref: '#/components/schemas/DataLabelOptions' + ColorLabelOptions: + $ref: '#/components/schemas/ChartAxisLabelOptions' + CategoryLabelOptions: + $ref: '#/components/schemas/ChartAxisLabelOptions' + Tooltip: + $ref: '#/components/schemas/TooltipOptions' + SmallMultiplesOptions: + $ref: '#/components/schemas/SmallMultiplesOptions' + Orientation: + $ref: '#/components/schemas/BarChartOrientation' + VisualPalette: + $ref: '#/components/schemas/VisualPalette' + ValueLabelOptions: + $ref: '#/components/schemas/ChartAxisLabelOptions' + BarsArrangement: + $ref: '#/components/schemas/BarsArrangement' + CategoryAxis: + $ref: '#/components/schemas/AxisDisplayOptions' + ContributionAnalysisDefaults: + minItems: 1 + maxItems: 200 type: array items: - $ref: '#/components/schemas/HeaderFooterSectionConfiguration' - maxItems: 1 - minItems: 0 - CanvasSizeOptions: - $ref: '#/components/schemas/SectionBasedLayoutCanvasSizeOptions' + $ref: '#/components/schemas/ContributionAnalysisDefault' + FieldWells: + $ref: '#/components/schemas/BarChartFieldWells' + ValueAxis: + $ref: '#/components/schemas/AxisDisplayOptions' + FieldTooltipItem: + additionalProperties: false + type: object + properties: + FieldId: + minLength: 1 + type: string + maxLength: 512 + Label: + type: string + Visibility: + $ref: '#/components/schemas/Visibility' required: - - BodySections - - CanvasSizeOptions - - FooterSections - - HeaderSections + - FieldId + TableSideBorderOptions: additionalProperties: false - SectionBasedLayoutPaperCanvasSizeOptions: type: object properties: - PaperSize: - $ref: '#/components/schemas/PaperSize' - PaperOrientation: - $ref: '#/components/schemas/PaperOrientation' - PaperMargin: - $ref: '#/components/schemas/Spacing' + Left: + $ref: '#/components/schemas/TableBorderOptions' + Top: + $ref: '#/components/schemas/TableBorderOptions' + InnerHorizontal: + $ref: '#/components/schemas/TableBorderOptions' + Right: + $ref: '#/components/schemas/TableBorderOptions' + Bottom: + $ref: '#/components/schemas/TableBorderOptions' + InnerVertical: + $ref: '#/components/schemas/TableBorderOptions' + LineChartMarkerStyleSettings: additionalProperties: false - SectionLayoutConfiguration: type: object properties: - FreeFormLayout: - $ref: '#/components/schemas/FreeFormSectionLayoutConfiguration' - required: - - FreeFormLayout + MarkerShape: + $ref: '#/components/schemas/LineChartMarkerShape' + MarkerSize: + description: String based length that is composed of value and unit in px + type: string + MarkerVisibility: + $ref: '#/components/schemas/Visibility' + MarkerColor: + pattern: ^#[A-F0-9]{6}$ + type: string + ComparisonFormatConfiguration: additionalProperties: false - SectionPageBreakConfiguration: type: object properties: - After: - $ref: '#/components/schemas/SectionAfterPageBreak' + NumberDisplayFormatConfiguration: + $ref: '#/components/schemas/NumberDisplayFormatConfiguration' + PercentageDisplayFormatConfiguration: + $ref: '#/components/schemas/PercentageDisplayFormatConfiguration' + FilterRelativeDateTimeControl: + additionalProperties: false + type: object + properties: + FilterControlId: + minLength: 1 + pattern: ^[\w\-]+$ + type: string + maxLength: 512 + DisplayOptions: + $ref: '#/components/schemas/RelativeDateTimeControlDisplayOptions' + Title: + minLength: 1 + type: string + maxLength: 2048 + SourceFilterId: + minLength: 1 + pattern: ^[\w\-]+$ + type: string + maxLength: 512 + required: + - FilterControlId + - SourceFilterId + - Title + PivotTableConditionalFormatting: additionalProperties: false - SectionPageBreakStatus: - type: string - enum: - - ENABLED - - DISABLED - SectionStyle: type: object properties: - Height: - type: string - description: String based length that is composed of value and unit in px - Padding: - $ref: '#/components/schemas/Spacing' + ConditionalFormattingOptions: + minItems: 0 + maxItems: 500 + type: array + items: + $ref: '#/components/schemas/PivotTableConditionalFormattingOption' + TableFieldOptions: additionalProperties: false - SelectAllValueOptions: - type: string - enum: - - ALL_VALUES - SelectedFieldOptions: - type: string - enum: - - ALL_FIELDS - SelectedSheetsFilterScopeConfiguration: type: object properties: - SheetVisualScopingConfigurations: + Order: + minItems: 0 + maxItems: 200 type: array items: - $ref: '#/components/schemas/SheetVisualScopingConfiguration' - maxItems: 50 - minItems: 1 - additionalProperties: false - SelectedTooltipType: + minLength: 1 + type: string + maxLength: 512 + PinnedFieldOptions: + $ref: '#/components/schemas/TablePinnedFieldOptions' + SelectedFieldOptions: + minItems: 0 + maxItems: 100 + type: array + items: + $ref: '#/components/schemas/TableFieldOption' + ReferenceLineSeriesType: type: string enum: - - BASIC - - DETAILED - SeriesItem: - type: object - properties: - FieldSeriesItem: - $ref: '#/components/schemas/FieldSeriesItem' - DataFieldSeriesItem: - $ref: '#/components/schemas/DataFieldSeriesItem' + - BAR + - LINE + ReferenceLineDynamicDataConfiguration: additionalProperties: false - SetParameterValueConfiguration: type: object properties: - DestinationParameterName: - type: string - maxLength: 2048 - minLength: 1 - pattern: ^[a-zA-Z0-9]+$ - Value: - $ref: '#/components/schemas/DestinationParameterValueConfiguration' + Column: + $ref: '#/components/schemas/ColumnIdentifier' + MeasureAggregationFunction: + $ref: '#/components/schemas/AggregationFunction' + Calculation: + $ref: '#/components/schemas/NumericalAggregationFunction' required: - - DestinationParameterName - - Value + - Calculation + - Column + SheetTextBox: additionalProperties: false - ShapeConditionalFormat: type: object properties: - BackgroundColor: - $ref: '#/components/schemas/ConditionalFormattingColor' + SheetTextBoxId: + minLength: 1 + pattern: ^[\w\-]+$ + type: string + maxLength: 512 + Content: + minLength: 0 + type: string + maxLength: 150000 required: - - BackgroundColor + - SheetTextBoxId + DateDimensionField: additionalProperties: false - Sheet: type: object properties: - SheetId: + HierarchyId: + minLength: 1 type: string maxLength: 512 + FormatConfiguration: + $ref: '#/components/schemas/DateTimeFormatConfiguration' + Column: + $ref: '#/components/schemas/ColumnIdentifier' + FieldId: minLength: 1 - pattern: '[\w\-]+' - Name: type: string - maxLength: 2048 - minLength: 1 + maxLength: 512 + DateGranularity: + $ref: '#/components/schemas/TimeGranularity' + required: + - Column + - FieldId + DefaultFilterListControlOptions: additionalProperties: false - SheetContentType: - type: string - enum: - - PAGINATED - - INTERACTIVE - SheetControlDateTimePickerType: - type: string - enum: - - SINGLE_VALUED - - DATE_RANGE - SheetControlInfoIconLabelOptions: type: object properties: - Visibility: - $ref: '#/components/schemas/Visibility' - InfoIconText: - type: string - maxLength: 100 - minLength: 1 + Type: + $ref: '#/components/schemas/SheetControlListType' + DisplayOptions: + $ref: '#/components/schemas/ListControlDisplayOptions' + SelectableValues: + $ref: '#/components/schemas/FilterSelectableValues' + PrimaryValueDisplayType: + type: string + enum: + - HIDDEN + - COMPARISON + - ACTUAL + KPIVisual: additionalProperties: false - SheetControlLayout: type: object properties: - Configuration: - $ref: '#/components/schemas/SheetControlLayoutConfiguration' + Subtitle: + $ref: '#/components/schemas/VisualSubtitleLabelOptions' + ConditionalFormatting: + $ref: '#/components/schemas/KPIConditionalFormatting' + VisualId: + minLength: 1 + pattern: ^[\w\-]+$ + type: string + maxLength: 512 + ChartConfiguration: + $ref: '#/components/schemas/KPIConfiguration' + Actions: + minItems: 0 + maxItems: 10 + type: array + items: + $ref: '#/components/schemas/VisualCustomAction' + Title: + $ref: '#/components/schemas/VisualTitleLabelOptions' + ColumnHierarchies: + minItems: 0 + maxItems: 2 + type: array + items: + $ref: '#/components/schemas/ColumnHierarchy' required: - - Configuration + - VisualId + AggregationSortConfiguration: additionalProperties: false - SheetControlLayoutConfiguration: type: object properties: - GridLayout: - $ref: '#/components/schemas/GridLayoutConfiguration' + AggregationFunction: + $ref: '#/components/schemas/AggregationFunction' + SortDirection: + $ref: '#/components/schemas/SortDirection' + Column: + $ref: '#/components/schemas/ColumnIdentifier' + required: + - Column + - SortDirection + PercentageDisplayFormatConfiguration: additionalProperties: false - SheetControlListType: - type: string - enum: - - MULTI_SELECT - - SINGLE_SELECT - SheetControlSliderType: - type: string - enum: - - SINGLE_POINT - - RANGE - SheetDefinition: type: object properties: - SheetId: - type: string - maxLength: 512 + NegativeValueConfiguration: + $ref: '#/components/schemas/NegativeValueConfiguration' + DecimalPlacesConfiguration: + $ref: '#/components/schemas/DecimalPlacesConfiguration' + NullValueFormatConfiguration: + $ref: '#/components/schemas/NullValueFormatConfiguration' + Suffix: minLength: 1 - pattern: '[\w\-]+' - Title: type: string - maxLength: 1024 + maxLength: 128 + SeparatorConfiguration: + $ref: '#/components/schemas/NumericSeparatorConfiguration' + Prefix: minLength: 1 - Description: type: string - maxLength: 1024 + maxLength: 128 + TableVisual: + additionalProperties: false + type: object + properties: + Subtitle: + $ref: '#/components/schemas/VisualSubtitleLabelOptions' + ConditionalFormatting: + $ref: '#/components/schemas/TableConditionalFormatting' + VisualId: minLength: 1 - Name: + pattern: ^[\w\-]+$ type: string - maxLength: 2048 - minLength: 1 - ParameterControls: - type: array - items: - $ref: '#/components/schemas/ParameterControl' - maxItems: 200 + maxLength: 512 + ChartConfiguration: + $ref: '#/components/schemas/TableConfiguration' + Actions: minItems: 0 - FilterControls: + maxItems: 10 type: array items: - $ref: '#/components/schemas/FilterControl' - maxItems: 200 + $ref: '#/components/schemas/VisualCustomAction' + Title: + $ref: '#/components/schemas/VisualTitleLabelOptions' + required: + - VisualId + ComboChartSortConfiguration: + additionalProperties: false + type: object + properties: + ColorSort: minItems: 0 - Visuals: + maxItems: 100 type: array items: - $ref: '#/components/schemas/Visual' - maxItems: 50 + $ref: '#/components/schemas/FieldSortOptions' + ColorItemsLimit: + $ref: '#/components/schemas/ItemsLimitConfiguration' + CategoryItemsLimit: + $ref: '#/components/schemas/ItemsLimitConfiguration' + CategorySort: minItems: 0 - TextBoxes: - type: array - items: - $ref: '#/components/schemas/SheetTextBox' maxItems: 100 - minItems: 0 - Layouts: - type: array - items: - $ref: '#/components/schemas/Layout' - maxItems: 1 - minItems: 1 - SheetControlLayouts: type: array items: - $ref: '#/components/schemas/SheetControlLayout' - maxItems: 1 - minItems: 0 - ContentType: - $ref: '#/components/schemas/SheetContentType' - required: - - SheetId + $ref: '#/components/schemas/FieldSortOptions' + TextAreaControlDisplayOptions: additionalProperties: false - SheetElementConfigurationOverrides: type: object properties: - Visibility: - $ref: '#/components/schemas/Visibility' + TitleOptions: + $ref: '#/components/schemas/LabelOptions' + PlaceholderOptions: + $ref: '#/components/schemas/TextControlPlaceholderOptions' + InfoIconLabelOptions: + $ref: '#/components/schemas/SheetControlInfoIconLabelOptions' + DataPathSort: additionalProperties: false - SheetElementRenderingRule: type: object properties: - Expression: - type: string - maxLength: 4096 - minLength: 1 - ConfigurationOverrides: - $ref: '#/components/schemas/SheetElementConfigurationOverrides' + SortPaths: + minItems: 0 + maxItems: 20 + type: array + items: + $ref: '#/components/schemas/DataPathValue' + Direction: + $ref: '#/components/schemas/SortDirection' required: - - ConfigurationOverrides - - Expression + - Direction + - SortPaths + DecimalParameterDeclaration: additionalProperties: false - SheetTextBox: type: object properties: - SheetTextBoxId: - type: string - maxLength: 512 + MappedDataSetParameters: + minItems: 0 + maxItems: 150 + type: array + items: + $ref: '#/components/schemas/MappedDataSetParameter' + DefaultValues: + $ref: '#/components/schemas/DecimalDefaultValues' + ParameterValueType: + $ref: '#/components/schemas/ParameterValueType' + ValueWhenUnset: + $ref: '#/components/schemas/DecimalValueWhenUnsetConfiguration' + Name: minLength: 1 - pattern: '[\w\-]+' - Content: + pattern: ^[a-zA-Z0-9]+$ type: string - maxLength: 150000 - minLength: 0 + maxLength: 2048 required: - - SheetTextBoxId + - Name + - ParameterValueType + FilterVisualScope: + type: string + enum: + - ALL_VISUALS + - SELECTED_VISUALS + TopBottomMoversComputation: additionalProperties: false - SheetVisualScopingConfiguration: type: object properties: - SheetId: + Type: + $ref: '#/components/schemas/TopBottomComputationType' + Category: + $ref: '#/components/schemas/DimensionField' + Value: + $ref: '#/components/schemas/MeasureField' + SortOrder: + $ref: '#/components/schemas/TopBottomSortOrder' + Time: + $ref: '#/components/schemas/DimensionField' + MoverSize: + default: 0 + maximum: 20 + type: number + minimum: 1 + ComputationId: + minLength: 1 + pattern: ^[\w\-]+$ type: string maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Scope: - $ref: '#/components/schemas/FilterVisualScope' - VisualIds: - type: array - items: - type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - maxItems: 50 - minItems: 0 + Name: + type: string required: - - Scope - - SheetId + - ComputationId + - Type + TextWrap: + type: string + enum: + - NONE + - WRAP + AnchorOption: + type: string + enum: + - NOW + FieldSort: additionalProperties: false - ShortFormatText: type: object properties: - PlainText: - type: string - maxLength: 512 + FieldId: minLength: 1 - RichText: type: string - maxLength: 1024 - minLength: 1 + maxLength: 512 + Direction: + $ref: '#/components/schemas/SortDirection' + required: + - Direction + - FieldId + AxisDisplayMinMaxRange: additionalProperties: false - SimpleAttributeAggregationFunction: + type: object + properties: + Minimum: + default: null + type: number + Maximum: + default: null + type: number + SectionPageBreakStatus: type: string enum: - - UNIQUE_VALUE - SimpleClusterMarker: + - ENABLED + - DISABLED + AxisLabelReferenceOptions: + additionalProperties: false type: object properties: - Color: + Column: + $ref: '#/components/schemas/ColumnIdentifier' + FieldId: + minLength: 1 type: string - pattern: ^#[A-F0-9]{6}$ - additionalProperties: false - SimpleNumericalAggregationFunction: + maxLength: 512 + required: + - Column + - FieldId + DateAggregationFunction: type: string enum: - - SUM - - AVERAGE - - MIN - - MAX - COUNT - DISTINCT_COUNT - - VAR - - VARP - - STDEV - - STDEVP - - MEDIAN - SimpleTotalAggregationFunction: - type: string - enum: - - DEFAULT - - SUM - - AVERAGE - MIN - MAX - - NONE - SliderControlDisplayOptions: + TopBottomSortOrder: + type: string + enum: + - PERCENT_DIFFERENCE + - ABSOLUTE_DIFFERENCE + DropDownControlDisplayOptions: + additionalProperties: false type: object properties: TitleOptions: $ref: '#/components/schemas/LabelOptions' + SelectAllOptions: + $ref: '#/components/schemas/ListControlSelectAllOptions' InfoIconLabelOptions: $ref: '#/components/schemas/SheetControlInfoIconLabelOptions' - additionalProperties: false - SmallMultiplesAxisPlacement: - type: string - enum: - - OUTSIDE - - INSIDE - SmallMultiplesAxisProperties: - type: object - properties: - Scale: - $ref: '#/components/schemas/SmallMultiplesAxisScale' - Placement: - $ref: '#/components/schemas/SmallMultiplesAxisPlacement' - additionalProperties: false - SmallMultiplesAxisScale: - type: string - enum: - - SHARED - - INDEPENDENT - SmallMultiplesOptions: - type: object - properties: - MaxVisibleRows: - type: number - maximum: 10 - minimum: 1 - MaxVisibleColumns: - type: number - maximum: 10 - minimum: 1 - PanelConfiguration: - $ref: '#/components/schemas/PanelConfiguration' - XAxis: - $ref: '#/components/schemas/SmallMultiplesAxisProperties' - YAxis: - $ref: '#/components/schemas/SmallMultiplesAxisProperties' - additionalProperties: false - SortDirection: - type: string - enum: - - ASC - - DESC - Spacing: + FieldLabelType: + additionalProperties: false type: object properties: - Top: - type: string - description: String based length that is composed of value and unit - Bottom: - type: string - description: String based length that is composed of value and unit - Left: - type: string - description: String based length that is composed of value and unit - Right: + FieldId: + minLength: 1 type: string - description: String based length that is composed of value and unit + maxLength: 512 + Visibility: + $ref: '#/components/schemas/Visibility' + AxisLogarithmicScale: additionalProperties: false - SpecialValue: - type: string - enum: - - EMPTY - - 'NULL' - - OTHER - StringDefaultValues: type: object properties: - DynamicValue: - $ref: '#/components/schemas/DynamicDefaultValue' - StaticValues: + Base: + default: null + type: number + KPISortConfiguration: + additionalProperties: false + type: object + properties: + TrendGroupSort: + minItems: 0 + maxItems: 100 type: array items: - type: string - maxItems: 50000 - minItems: 0 + $ref: '#/components/schemas/FieldSortOptions' + GlobalTableBorderOptions: additionalProperties: false - StringFormatConfiguration: type: object properties: - NullValueFormatConfiguration: - $ref: '#/components/schemas/NullValueFormatConfiguration' - NumericFormatConfiguration: - $ref: '#/components/schemas/NumericFormatConfiguration' + UniformBorder: + $ref: '#/components/schemas/TableBorderOptions' + SideSpecificBorder: + $ref: '#/components/schemas/TableSideBorderOptions' + DataSetIdentifierDeclaration: additionalProperties: false - StringParameter: type: object properties: - Name: + Identifier: + minLength: 1 + type: string + maxLength: 2048 + DataSetArn: type: string - pattern: .*\S.* - Values: - type: array - items: - type: string required: - - Name - - Values + - DataSetArn + - Identifier + TableTotalsScrollStatus: + type: string + enum: + - PINNED + - SCROLLED + StyledCellType: + type: string + enum: + - TOTAL + - METRIC_HEADER + - VALUE + TotalAggregationOption: additionalProperties: false - StringParameterDeclaration: type: object properties: - ParameterValueType: - $ref: '#/components/schemas/ParameterValueType' - Name: + TotalAggregationFunction: + $ref: '#/components/schemas/TotalAggregationFunction' + FieldId: + minLength: 1 + type: string + maxLength: 512 + required: + - FieldId + - TotalAggregationFunction + DataPathValue: + additionalProperties: false + type: object + properties: + DataPathType: + $ref: '#/components/schemas/DataPathType' + FieldId: + minLength: 1 + type: string + maxLength: 512 + FieldValue: + minLength: 0 type: string maxLength: 2048 + PivotTableFieldOption: + additionalProperties: false + type: object + properties: + CustomLabel: minLength: 1 - pattern: ^[a-zA-Z0-9]+$ - DefaultValues: - $ref: '#/components/schemas/StringDefaultValues' - ValueWhenUnset: - $ref: '#/components/schemas/StringValueWhenUnsetConfiguration' - MappedDataSetParameters: + type: string + maxLength: 2048 + FieldId: + minLength: 1 + type: string + maxLength: 512 + Visibility: + $ref: '#/components/schemas/Visibility' + required: + - FieldId + SectionBasedLayoutConfiguration: + additionalProperties: false + type: object + properties: + CanvasSizeOptions: + $ref: '#/components/schemas/SectionBasedLayoutCanvasSizeOptions' + FooterSections: + minItems: 0 + maxItems: 1 type: array items: - $ref: '#/components/schemas/MappedDataSetParameter' - maxItems: 150 + $ref: '#/components/schemas/HeaderFooterSectionConfiguration' + BodySections: + minItems: 0 + maxItems: 28 + type: array + items: + $ref: '#/components/schemas/BodySectionConfiguration' + HeaderSections: minItems: 0 + maxItems: 1 + type: array + items: + $ref: '#/components/schemas/HeaderFooterSectionConfiguration' required: - - Name - - ParameterValueType + - BodySections + - CanvasSizeOptions + - FooterSections + - HeaderSections + ConditionalFormattingColor: + additionalProperties: false + type: object + properties: + Gradient: + $ref: '#/components/schemas/ConditionalFormattingGradientColor' + Solid: + $ref: '#/components/schemas/ConditionalFormattingSolidColor' + FreeFormLayoutCanvasSizeOptions: + additionalProperties: false + type: object + properties: + ScreenCanvasSizeOptions: + $ref: '#/components/schemas/FreeFormLayoutScreenCanvasSizeOptions' + NumericSeparatorSymbol: + type: string + enum: + - COMMA + - DOT + - SPACE + TargetVisualOptions: + type: string + enum: + - ALL_VISUALS + DecimalValueWhenUnsetConfiguration: additionalProperties: false - StringValueWhenUnsetConfiguration: type: object properties: ValueWhenUnsetOption: $ref: '#/components/schemas/ValueWhenUnsetOption' CustomValue: - type: string + default: null + type: number + ColumnSort: additionalProperties: false - StyledCellType: + type: object + properties: + AggregationFunction: + $ref: '#/components/schemas/AggregationFunction' + SortBy: + $ref: '#/components/schemas/ColumnIdentifier' + Direction: + $ref: '#/components/schemas/SortDirection' + required: + - Direction + - SortBy + DefaultDateTimePickerControlOptions: + additionalProperties: false + type: object + properties: + Type: + $ref: '#/components/schemas/SheetControlDateTimePickerType' + DisplayOptions: + $ref: '#/components/schemas/DateTimePickerControlDisplayOptions' + NumericalMeasureField: + additionalProperties: false + type: object + properties: + AggregationFunction: + $ref: '#/components/schemas/NumericalAggregationFunction' + FormatConfiguration: + $ref: '#/components/schemas/NumberFormatConfiguration' + Column: + $ref: '#/components/schemas/ColumnIdentifier' + FieldId: + minLength: 1 + type: string + maxLength: 512 + required: + - Column + - FieldId + PanelBorderStyle: type: string enum: - - TOTAL - - METRIC_HEADER - - VALUE - SubtotalOptions: + - SOLID + - DASHED + - DOTTED + Spacing: + additionalProperties: false type: object properties: - TotalsVisibility: - $ref: '#/components/schemas/Visibility' - CustomLabel: - type: string - FieldLevel: - $ref: '#/components/schemas/PivotTableSubtotalLevel' - FieldLevelOptions: - type: array - items: - $ref: '#/components/schemas/PivotTableFieldSubtotalOptions' - maxItems: 100 - minItems: 0 - TotalCellStyle: - $ref: '#/components/schemas/TableCellStyle' - ValueCellStyle: - $ref: '#/components/schemas/TableCellStyle' - MetricHeaderCellStyle: - $ref: '#/components/schemas/TableCellStyle' - StyleTargets: - type: array - items: - $ref: '#/components/schemas/TableStyleTarget' - maxItems: 3 - minItems: 0 + Left: + description: String based length that is composed of value and unit + type: string + Top: + description: String based length that is composed of value and unit + type: string + Right: + description: String based length that is composed of value and unit + type: string + Bottom: + description: String based length that is composed of value and unit + type: string + KPIVisualStandardLayout: additionalProperties: false - TableAggregatedFieldWells: type: object properties: - GroupBy: + Type: + $ref: '#/components/schemas/KPIVisualStandardLayoutType' + required: + - Type + LineChartAggregatedFieldWells: + additionalProperties: false + type: object + properties: + Category: + minItems: 0 + maxItems: 200 type: array items: $ref: '#/components/schemas/DimensionField' - maxItems: 200 + Colors: minItems: 0 + maxItems: 200 + type: array + items: + $ref: '#/components/schemas/DimensionField' Values: + minItems: 0 + maxItems: 200 type: array items: $ref: '#/components/schemas/MeasureField' - maxItems: 200 + SmallMultiples: minItems: 0 + maxItems: 1 + type: array + items: + $ref: '#/components/schemas/DimensionField' + CategoryFilterSelectAllOptions: + type: string + enum: + - FILTER_ALL_VALUES + CustomActionURLOperation: additionalProperties: false - TableBorderOptions: type: object properties: - Color: + URLTemplate: + minLength: 1 type: string - pattern: ^#[A-F0-9]{6}$ - Thickness: - type: number - maximum: 4 - minimum: 1 - Style: - $ref: '#/components/schemas/TableBorderStyle' + maxLength: 2048 + URLTarget: + $ref: '#/components/schemas/URLTargetConfiguration' + required: + - URLTarget + - URLTemplate + FreeFormLayoutConfiguration: additionalProperties: false - TableBorderStyle: - type: string - enum: - - NONE - - SOLID - TableCellConditionalFormatting: type: object properties: - FieldId: + CanvasSizeOptions: + $ref: '#/components/schemas/FreeFormLayoutCanvasSizeOptions' + Elements: + minItems: 0 + maxItems: 430 + type: array + items: + $ref: '#/components/schemas/FreeFormLayoutElement' + required: + - Elements + MetricComparisonComputation: + additionalProperties: false + type: object + properties: + TargetValue: + $ref: '#/components/schemas/MeasureField' + Time: + $ref: '#/components/schemas/DimensionField' + ComputationId: + minLength: 1 + pattern: ^[\w\-]+$ type: string maxLength: 512 - minLength: 1 - TextFormat: - $ref: '#/components/schemas/TextConditionalFormat' + FromValue: + $ref: '#/components/schemas/MeasureField' + Name: + type: string required: - - FieldId + - ComputationId + TableFieldLinkContentConfiguration: additionalProperties: false - TableCellImageScalingConfiguration: - type: string - enum: - - FIT_TO_CELL_HEIGHT - - FIT_TO_CELL_WIDTH - - DO_NOT_SCALE - TableCellImageSizingConfiguration: type: object properties: - TableCellImageScalingConfiguration: - $ref: '#/components/schemas/TableCellImageScalingConfiguration' + CustomIconContent: + $ref: '#/components/schemas/TableFieldCustomIconContent' + CustomTextContent: + $ref: '#/components/schemas/TableFieldCustomTextContent' + TextConditionalFormat: additionalProperties: false - TableCellStyle: type: object properties: - Visibility: - $ref: '#/components/schemas/Visibility' - FontConfiguration: - $ref: '#/components/schemas/FontConfiguration' - TextWrap: - $ref: '#/components/schemas/TextWrap' - HorizontalTextAlignment: - $ref: '#/components/schemas/HorizontalTextAlignment' - VerticalTextAlignment: - $ref: '#/components/schemas/VerticalTextAlignment' + TextColor: + $ref: '#/components/schemas/ConditionalFormattingColor' + Icon: + $ref: '#/components/schemas/ConditionalFormattingIcon' BackgroundColor: - type: string - pattern: ^#[A-F0-9]{6}$ - Height: - type: number - maximum: 500 - minimum: 8 - Border: - $ref: '#/components/schemas/GlobalTableBorderOptions' + $ref: '#/components/schemas/ConditionalFormattingColor' + PivotTableConditionalFormattingScope: additionalProperties: false - TableConditionalFormatting: type: object properties: - ConditionalFormattingOptions: - type: array - items: - $ref: '#/components/schemas/TableConditionalFormattingOption' - maxItems: 100 - minItems: 0 + Role: + $ref: '#/components/schemas/PivotTableConditionalFormattingScopeRole' + ColumnTooltipItem: additionalProperties: false - TableConditionalFormattingOption: type: object properties: - Cell: - $ref: '#/components/schemas/TableCellConditionalFormatting' - Row: - $ref: '#/components/schemas/TableRowConditionalFormatting' + Aggregation: + $ref: '#/components/schemas/AggregationFunction' + Column: + $ref: '#/components/schemas/ColumnIdentifier' + Label: + type: string + Visibility: + $ref: '#/components/schemas/Visibility' + required: + - Column + PivotTableFieldOptions: additionalProperties: false - TableConfiguration: type: object properties: - FieldWells: - $ref: '#/components/schemas/TableFieldWells' - SortConfiguration: - $ref: '#/components/schemas/TableSortConfiguration' - TableOptions: - $ref: '#/components/schemas/TableOptions' - TotalOptions: - $ref: '#/components/schemas/TotalOptions' - FieldOptions: - $ref: '#/components/schemas/TableFieldOptions' - PaginatedReportOptions: - $ref: '#/components/schemas/TablePaginatedReportOptions' - TableInlineVisualizations: + CollapseStateOptions: type: array items: - $ref: '#/components/schemas/TableInlineVisualization' - maxItems: 200 + $ref: '#/components/schemas/PivotTableFieldCollapseStateOption' + DataPathOptions: minItems: 0 - additionalProperties: false - TableFieldCustomIconContent: - type: object - properties: - Icon: - $ref: '#/components/schemas/TableFieldIconSetType' - additionalProperties: false - TableFieldCustomTextContent: + maxItems: 100 + type: array + items: + $ref: '#/components/schemas/PivotTableDataPathOption' + SelectedFieldOptions: + minItems: 0 + maxItems: 100 + type: array + items: + $ref: '#/components/schemas/PivotTableFieldOption' + Tag: type: object + description: |- +

The key or keys of the key-value pairs for the resource tag or tags assigned to the + resource.

properties: + Key: + type: string + maxLength: 128 + minLength: 1 + description:

Tag key.

Value: type: string - FontConfiguration: - $ref: '#/components/schemas/FontConfiguration' + maxLength: 256 + minLength: 1 + description:

Tag value.

required: - - FontConfiguration + - Key + - Value + additionalProperties: false + FilterScopeConfiguration: additionalProperties: false - TableFieldIconSetType: - type: string - enum: - - LINK - TableFieldImageConfiguration: type: object properties: - SizingOptions: - $ref: '#/components/schemas/TableCellImageSizingConfiguration' + AllSheets: + $ref: '#/components/schemas/AllSheetsFilterScopeConfiguration' + SelectedSheets: + $ref: '#/components/schemas/SelectedSheetsFilterScopeConfiguration' + AnchorDateConfiguration: additionalProperties: false - TableFieldLinkConfiguration: type: object properties: - Target: - $ref: '#/components/schemas/URLTargetConfiguration' - Content: - $ref: '#/components/schemas/TableFieldLinkContentConfiguration' - required: - - Content - - Target + AnchorOption: + $ref: '#/components/schemas/AnchorOption' + ParameterName: + minLength: 1 + pattern: ^[a-zA-Z0-9]+$ + type: string + maxLength: 2048 + DestinationParameterValueConfiguration: + additionalProperties: false + type: object + properties: + CustomValuesConfiguration: + $ref: '#/components/schemas/CustomValuesConfiguration' + SourceParameterName: + type: string + SelectAllValueOptions: + $ref: '#/components/schemas/SelectAllValueOptions' + SourceField: + minLength: 1 + type: string + maxLength: 512 + SourceColumn: + $ref: '#/components/schemas/ColumnIdentifier' + FilledMapConditionalFormattingOption: additionalProperties: false - TableFieldLinkContentConfiguration: type: object properties: - CustomTextContent: - $ref: '#/components/schemas/TableFieldCustomTextContent' - CustomIconContent: - $ref: '#/components/schemas/TableFieldCustomIconContent' + Shape: + $ref: '#/components/schemas/FilledMapShapeConditionalFormatting' + required: + - Shape + CategoricalDimensionField: additionalProperties: false - TableFieldOption: type: object properties: - FieldId: + HierarchyId: + minLength: 1 type: string maxLength: 512 + FormatConfiguration: + $ref: '#/components/schemas/StringFormatConfiguration' + Column: + $ref: '#/components/schemas/ColumnIdentifier' + FieldId: minLength: 1 - Width: type: string - description: String based length that is composed of value and unit in px - CustomLabel: - type: string - maxLength: 2048 - minLength: 1 - Visibility: - $ref: '#/components/schemas/Visibility' - URLStyling: - $ref: '#/components/schemas/TableFieldURLConfiguration' + maxLength: 512 required: + - Column - FieldId + IntegerDefaultValues: additionalProperties: false - TableFieldOptions: type: object properties: - SelectedFieldOptions: - type: array - items: - $ref: '#/components/schemas/TableFieldOption' - maxItems: 100 + DynamicValue: + $ref: '#/components/schemas/DynamicDefaultValue' + StaticValues: minItems: 0 - Order: + maxItems: 50000 type: array items: - type: string - maxLength: 512 - minLength: 1 - maxItems: 200 - minItems: 0 - PinnedFieldOptions: - $ref: '#/components/schemas/TablePinnedFieldOptions' + type: number + StringFormatConfiguration: additionalProperties: false - TableFieldURLConfiguration: type: object properties: - LinkConfiguration: - $ref: '#/components/schemas/TableFieldLinkConfiguration' - ImageConfiguration: - $ref: '#/components/schemas/TableFieldImageConfiguration' + NumericFormatConfiguration: + $ref: '#/components/schemas/NumericFormatConfiguration' + NullValueFormatConfiguration: + $ref: '#/components/schemas/NullValueFormatConfiguration' + GeospatialPointStyleOptions: additionalProperties: false - TableFieldWells: type: object properties: - TableAggregatedFieldWells: - $ref: '#/components/schemas/TableAggregatedFieldWells' - TableUnaggregatedFieldWells: - $ref: '#/components/schemas/TableUnaggregatedFieldWells' + SelectedPointStyle: + $ref: '#/components/schemas/GeospatialSelectedPointStyle' + ClusterMarkerConfiguration: + $ref: '#/components/schemas/ClusterMarkerConfiguration' + HeatmapConfiguration: + $ref: '#/components/schemas/GeospatialHeatmapConfiguration' + NullValueFormatConfiguration: additionalProperties: false - TableInlineVisualization: type: object properties: - DataBars: - $ref: '#/components/schemas/DataBarsOptions' + NullString: + minLength: 1 + type: string + maxLength: 128 + required: + - NullString + DefaultFilterControlOptions: + additionalProperties: false + type: object + properties: + DefaultSliderOptions: + $ref: '#/components/schemas/DefaultSliderControlOptions' + DefaultRelativeDateTimeOptions: + $ref: '#/components/schemas/DefaultRelativeDateTimeControlOptions' + DefaultTextFieldOptions: + $ref: '#/components/schemas/DefaultTextFieldControlOptions' + DefaultTextAreaOptions: + $ref: '#/components/schemas/DefaultTextAreaControlOptions' + DefaultDropdownOptions: + $ref: '#/components/schemas/DefaultFilterDropDownControlOptions' + DefaultDateTimePickerOptions: + $ref: '#/components/schemas/DefaultDateTimePickerControlOptions' + DefaultListOptions: + $ref: '#/components/schemas/DefaultFilterListControlOptions' + ExplicitHierarchy: additionalProperties: false - TableOptions: type: object properties: - Orientation: - $ref: '#/components/schemas/TableOrientation' - HeaderStyle: - $ref: '#/components/schemas/TableCellStyle' - CellStyle: - $ref: '#/components/schemas/TableCellStyle' - RowAlternateColorOptions: - $ref: '#/components/schemas/RowAlternateColorOptions' + HierarchyId: + minLength: 1 + type: string + maxLength: 512 + DrillDownFilters: + minItems: 0 + maxItems: 10 + type: array + items: + $ref: '#/components/schemas/DrillDownFilter' + Columns: + minItems: 2 + maxItems: 10 + type: array + items: + $ref: '#/components/schemas/ColumnIdentifier' + required: + - Columns + - HierarchyId + TooltipOptions: additionalProperties: false - TableOrientation: - type: string - enum: - - VERTICAL - - HORIZONTAL - TablePaginatedReportOptions: type: object properties: - VerticalOverflowVisibility: - $ref: '#/components/schemas/Visibility' - OverflowColumnHeaderVisibility: + SelectedTooltipType: + $ref: '#/components/schemas/SelectedTooltipType' + TooltipVisibility: $ref: '#/components/schemas/Visibility' + FieldBasedTooltip: + $ref: '#/components/schemas/FieldBasedTooltip' + FieldBasedTooltip: additionalProperties: false - TablePinnedFieldOptions: type: object properties: - PinnedLeftFields: + TooltipFields: + minItems: 0 + maxItems: 100 type: array items: - type: string - maxLength: 512 - minLength: 1 - maxItems: 201 - minItems: 0 - additionalProperties: false - TableRowConditionalFormatting: - type: object - properties: - BackgroundColor: - $ref: '#/components/schemas/ConditionalFormattingColor' - TextColor: - $ref: '#/components/schemas/ConditionalFormattingColor' - additionalProperties: false - TableSideBorderOptions: - type: object - properties: - InnerVertical: - $ref: '#/components/schemas/TableBorderOptions' - InnerHorizontal: - $ref: '#/components/schemas/TableBorderOptions' - Left: - $ref: '#/components/schemas/TableBorderOptions' - Right: - $ref: '#/components/schemas/TableBorderOptions' - Top: - $ref: '#/components/schemas/TableBorderOptions' - Bottom: - $ref: '#/components/schemas/TableBorderOptions' + $ref: '#/components/schemas/TooltipItem' + AggregationVisibility: + $ref: '#/components/schemas/Visibility' + TooltipTitleType: + $ref: '#/components/schemas/TooltipTitleType' + FilledMapAggregatedFieldWells: additionalProperties: false - TableSortConfiguration: type: object properties: - RowSort: + Values: + minItems: 0 + maxItems: 1 type: array items: - $ref: '#/components/schemas/FieldSortOptions' - maxItems: 100 + $ref: '#/components/schemas/MeasureField' + Geospatial: minItems: 0 - PaginationConfiguration: - $ref: '#/components/schemas/PaginationConfiguration' - additionalProperties: false - TableStyleTarget: - type: object - properties: - CellType: - $ref: '#/components/schemas/StyledCellType' - required: - - CellType + maxItems: 1 + type: array + items: + $ref: '#/components/schemas/DimensionField' + BarChartAggregatedFieldWells: additionalProperties: false - TableTotalsPlacement: - type: string - enum: - - START - - END - - AUTO - TableTotalsScrollStatus: - type: string - enum: - - PINNED - - SCROLLED - TableUnaggregatedFieldWells: type: object properties: - Values: + Category: + minItems: 0 + maxItems: 200 type: array items: - $ref: '#/components/schemas/UnaggregatedField' + $ref: '#/components/schemas/DimensionField' + Colors: + minItems: 0 maxItems: 200 + type: array + items: + $ref: '#/components/schemas/DimensionField' + Values: + minItems: 0 + maxItems: 200 + type: array + items: + $ref: '#/components/schemas/MeasureField' + SmallMultiples: minItems: 0 + maxItems: 1 + type: array + items: + $ref: '#/components/schemas/DimensionField' + WordCloudWordScaling: + type: string + enum: + - EMPHASIZE + - NORMAL + GeospatialSelectedPointStyle: + type: string + enum: + - POINT + - CLUSTER + - HEATMAP + ComboChartVisual: additionalProperties: false - TableVisual: type: object properties: + Subtitle: + $ref: '#/components/schemas/VisualSubtitleLabelOptions' VisualId: + minLength: 1 + pattern: ^[\w\-]+$ type: string maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Title: - $ref: '#/components/schemas/VisualTitleLabelOptions' - Subtitle: - $ref: '#/components/schemas/VisualSubtitleLabelOptions' ChartConfiguration: - $ref: '#/components/schemas/TableConfiguration' - ConditionalFormatting: - $ref: '#/components/schemas/TableConditionalFormatting' + $ref: '#/components/schemas/ComboChartConfiguration' Actions: + minItems: 0 + maxItems: 10 type: array items: $ref: '#/components/schemas/VisualCustomAction' - maxItems: 10 + Title: + $ref: '#/components/schemas/VisualTitleLabelOptions' + ColumnHierarchies: minItems: 0 + maxItems: 2 + type: array + items: + $ref: '#/components/schemas/ColumnHierarchy' required: - VisualId + ConditionalFormattingIconSet: additionalProperties: false - Tag: type: object properties: - Value: - type: string - maxLength: 256 + Expression: minLength: 1 - Key: type: string - maxLength: 128 - minLength: 1 - additionalProperties: false + maxLength: 4096 + IconSetType: + $ref: '#/components/schemas/ConditionalFormattingIconSetType' required: - - Key - - Value - TargetVisualOptions: - type: string - enum: - - ALL_VISUALS - TextAreaControlDisplayOptions: + - Expression + AxisTickLabelOptions: + additionalProperties: false type: object properties: - TitleOptions: + RotationAngle: + default: null + type: number + LabelOptions: $ref: '#/components/schemas/LabelOptions' - PlaceholderOptions: - $ref: '#/components/schemas/TextControlPlaceholderOptions' - InfoIconLabelOptions: - $ref: '#/components/schemas/SheetControlInfoIconLabelOptions' + DimensionField: additionalProperties: false - TextConditionalFormat: type: object properties: - BackgroundColor: - $ref: '#/components/schemas/ConditionalFormattingColor' - TextColor: - $ref: '#/components/schemas/ConditionalFormattingColor' - Icon: - $ref: '#/components/schemas/ConditionalFormattingIcon' + DateDimensionField: + $ref: '#/components/schemas/DateDimensionField' + NumericalDimensionField: + $ref: '#/components/schemas/NumericalDimensionField' + CategoricalDimensionField: + $ref: '#/components/schemas/CategoricalDimensionField' + FontDecoration: + type: string + enum: + - UNDERLINE + - NONE + PivotTableAggregatedFieldWells: additionalProperties: false - TextControlPlaceholderOptions: type: object properties: - Visibility: - $ref: '#/components/schemas/Visibility' + Values: + minItems: 0 + maxItems: 40 + type: array + items: + $ref: '#/components/schemas/MeasureField' + Columns: + minItems: 0 + maxItems: 40 + type: array + items: + $ref: '#/components/schemas/DimensionField' + Rows: + minItems: 0 + maxItems: 40 + type: array + items: + $ref: '#/components/schemas/DimensionField' + FunnelChartSortConfiguration: additionalProperties: false - TextFieldControlDisplayOptions: type: object properties: - TitleOptions: - $ref: '#/components/schemas/LabelOptions' - PlaceholderOptions: - $ref: '#/components/schemas/TextControlPlaceholderOptions' - InfoIconLabelOptions: - $ref: '#/components/schemas/SheetControlInfoIconLabelOptions' + CategoryItemsLimit: + $ref: '#/components/schemas/ItemsLimitConfiguration' + CategorySort: + minItems: 0 + maxItems: 100 + type: array + items: + $ref: '#/components/schemas/FieldSortOptions' + AllSheetsFilterScopeConfiguration: additionalProperties: false - TextWrap: - type: string - enum: - - NONE - - WRAP - ThousandSeparatorOptions: type: object - properties: - Symbol: - $ref: '#/components/schemas/NumericSeparatorSymbol' - Visibility: - $ref: '#/components/schemas/Visibility' + HistogramFieldWells: additionalProperties: false - TimeBasedForecastProperties: type: object properties: - PeriodsForward: - type: number - maximum: 1000 - minimum: 1 - PeriodsBackward: - type: number - maximum: 1000 - minimum: 0 - UpperBoundary: - type: number - default: null - LowerBoundary: - type: number - default: null - PredictionInterval: - type: number - maximum: 95 - minimum: 50 - Seasonality: - type: number - maximum: 180 - minimum: 1 + HistogramAggregatedFieldWells: + $ref: '#/components/schemas/HistogramAggregatedFieldWells' + PieChartConfiguration: additionalProperties: false - TimeEqualityFilter: type: object properties: - FilterId: - type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Column: - $ref: '#/components/schemas/ColumnIdentifier' - Value: - type: string - format: date-time - RollingDate: - $ref: '#/components/schemas/RollingDateConfiguration' - ParameterName: - type: string - maxLength: 2048 - minLength: 1 - pattern: ^[a-zA-Z0-9]+$ - TimeGranularity: - $ref: '#/components/schemas/TimeGranularity' - required: - - Column - - FilterId - additionalProperties: false - TimeGranularity: + SortConfiguration: + $ref: '#/components/schemas/PieChartSortConfiguration' + Legend: + $ref: '#/components/schemas/LegendOptions' + DataLabels: + $ref: '#/components/schemas/DataLabelOptions' + ContributionAnalysisDefaults: + minItems: 1 + maxItems: 200 + type: array + items: + $ref: '#/components/schemas/ContributionAnalysisDefault' + CategoryLabelOptions: + $ref: '#/components/schemas/ChartAxisLabelOptions' + FieldWells: + $ref: '#/components/schemas/PieChartFieldWells' + Tooltip: + $ref: '#/components/schemas/TooltipOptions' + DonutOptions: + $ref: '#/components/schemas/DonutOptions' + SmallMultiplesOptions: + $ref: '#/components/schemas/SmallMultiplesOptions' + ValueLabelOptions: + $ref: '#/components/schemas/ChartAxisLabelOptions' + VisualPalette: + $ref: '#/components/schemas/VisualPalette' + SheetControlDateTimePickerType: type: string enum: - - YEAR - - QUARTER - - MONTH - - WEEK - - DAY - - HOUR - - MINUTE - - SECOND - - MILLISECOND - TimeRangeDrillDownFilter: - type: object - properties: - Column: - $ref: '#/components/schemas/ColumnIdentifier' - RangeMinimum: - type: string - format: date-time - RangeMaximum: - type: string - format: date-time - TimeGranularity: - $ref: '#/components/schemas/TimeGranularity' - required: - - Column - - RangeMaximum - - RangeMinimum - - TimeGranularity + - SINGLE_VALUED + - DATE_RANGE + ReferenceLineDataConfiguration: additionalProperties: false - TimeRangeFilter: type: object properties: - FilterId: - type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Column: - $ref: '#/components/schemas/ColumnIdentifier' - IncludeMinimum: - type: boolean - default: null - IncludeMaximum: - type: boolean - default: null - RangeMinimumValue: - $ref: '#/components/schemas/TimeRangeFilterValue' - RangeMaximumValue: - $ref: '#/components/schemas/TimeRangeFilterValue' - NullOption: - $ref: '#/components/schemas/FilterNullOption' - ExcludePeriodConfiguration: - $ref: '#/components/schemas/ExcludePeriodConfiguration' - TimeGranularity: - $ref: '#/components/schemas/TimeGranularity' - required: - - Column - - FilterId - - NullOption + DynamicConfiguration: + $ref: '#/components/schemas/ReferenceLineDynamicDataConfiguration' + AxisBinding: + $ref: '#/components/schemas/AxisBinding' + SeriesType: + $ref: '#/components/schemas/ReferenceLineSeriesType' + StaticConfiguration: + $ref: '#/components/schemas/ReferenceLineStaticDataConfiguration' + CurrencyDisplayFormatConfiguration: additionalProperties: false - TimeRangeFilterValue: type: object properties: - StaticValue: + NegativeValueConfiguration: + $ref: '#/components/schemas/NegativeValueConfiguration' + DecimalPlacesConfiguration: + $ref: '#/components/schemas/DecimalPlacesConfiguration' + NumberScale: + $ref: '#/components/schemas/NumberScale' + NullValueFormatConfiguration: + $ref: '#/components/schemas/NullValueFormatConfiguration' + Suffix: + minLength: 1 type: string - format: date-time - RollingDate: - $ref: '#/components/schemas/RollingDateConfiguration' - Parameter: + maxLength: 128 + SeparatorConfiguration: + $ref: '#/components/schemas/NumericSeparatorConfiguration' + Symbol: + pattern: ^[A-Z]{3}$ type: string - maxLength: 2048 + Prefix: minLength: 1 - pattern: ^[a-zA-Z0-9]+$ + type: string + maxLength: 128 + SameSheetTargetVisualConfiguration: additionalProperties: false - TooltipItem: type: object properties: - FieldTooltipItem: - $ref: '#/components/schemas/FieldTooltipItem' - ColumnTooltipItem: - $ref: '#/components/schemas/ColumnTooltipItem' + TargetVisualOptions: + $ref: '#/components/schemas/TargetVisualOptions' + TargetVisuals: + minItems: 1 + maxItems: 50 + type: array + items: + minLength: 1 + pattern: ^[\w\-]+$ + type: string + maxLength: 512 + SliderControlDisplayOptions: additionalProperties: false - TooltipOptions: type: object properties: - TooltipVisibility: - $ref: '#/components/schemas/Visibility' - SelectedTooltipType: - $ref: '#/components/schemas/SelectedTooltipType' - FieldBasedTooltip: - $ref: '#/components/schemas/FieldBasedTooltip' + TitleOptions: + $ref: '#/components/schemas/LabelOptions' + InfoIconLabelOptions: + $ref: '#/components/schemas/SheetControlInfoIconLabelOptions' + LineSeriesAxisDisplayOptions: additionalProperties: false - TooltipTitleType: - type: string - enum: - - NONE - - PRIMARY_VALUE - TopBottomComputationType: - type: string - enum: - - TOP - - BOTTOM - TopBottomFilter: type: object properties: - FilterId: - type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Column: - $ref: '#/components/schemas/ColumnIdentifier' - Limit: - type: number - default: null - AggregationSortConfigurations: + MissingDataConfigurations: + minItems: 0 + maxItems: 100 type: array items: - $ref: '#/components/schemas/AggregationSortConfiguration' - maxItems: 100 - minItems: 0 - TimeGranularity: - $ref: '#/components/schemas/TimeGranularity' - ParameterName: - type: string - maxLength: 2048 - minLength: 1 - pattern: ^[a-zA-Z0-9]+$ - required: - - AggregationSortConfigurations - - Column - - FilterId + $ref: '#/components/schemas/MissingDataConfiguration' + AxisOptions: + $ref: '#/components/schemas/AxisDisplayOptions' + HeatMapVisual: additionalProperties: false - TopBottomMoversComputation: type: object properties: - ComputationId: - type: string - maxLength: 512 + Subtitle: + $ref: '#/components/schemas/VisualSubtitleLabelOptions' + VisualId: minLength: 1 - pattern: '[\w\-]+' - Name: + pattern: ^[\w\-]+$ type: string - Time: - $ref: '#/components/schemas/DimensionField' - Category: - $ref: '#/components/schemas/DimensionField' - Value: - $ref: '#/components/schemas/MeasureField' - MoverSize: - type: number - default: 0 - maximum: 20 - minimum: 1 - SortOrder: - $ref: '#/components/schemas/TopBottomSortOrder' - Type: - $ref: '#/components/schemas/TopBottomComputationType' + maxLength: 512 + ChartConfiguration: + $ref: '#/components/schemas/HeatMapConfiguration' + Actions: + minItems: 0 + maxItems: 10 + type: array + items: + $ref: '#/components/schemas/VisualCustomAction' + Title: + $ref: '#/components/schemas/VisualTitleLabelOptions' + ColumnHierarchies: + minItems: 0 + maxItems: 2 + type: array + items: + $ref: '#/components/schemas/ColumnHierarchy' required: - - ComputationId - - Type + - VisualId + SankeyDiagramSortConfiguration: additionalProperties: false - TopBottomRankedComputation: type: object properties: - ComputationId: - type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Name: - type: string - Category: - $ref: '#/components/schemas/DimensionField' - Value: - $ref: '#/components/schemas/MeasureField' - ResultSize: - type: number - default: 0 - maximum: 20 - minimum: 1 - Type: - $ref: '#/components/schemas/TopBottomComputationType' - required: - - ComputationId - - Type + WeightSort: + minItems: 0 + maxItems: 100 + type: array + items: + $ref: '#/components/schemas/FieldSortOptions' + SourceItemsLimit: + $ref: '#/components/schemas/ItemsLimitConfiguration' + DestinationItemsLimit: + $ref: '#/components/schemas/ItemsLimitConfiguration' + LocalNavigationConfiguration: additionalProperties: false - TopBottomSortOrder: - type: string - enum: - - PERCENT_DIFFERENCE - - ABSOLUTE_DIFFERENCE - TotalAggregationComputation: type: object properties: - ComputationId: - type: string - maxLength: 512 + TargetSheetId: minLength: 1 - pattern: '[\w\-]+' - Name: + pattern: ^[\w\-]+$ type: string - Value: - $ref: '#/components/schemas/MeasureField' + maxLength: 512 required: - - ComputationId - additionalProperties: false - TotalAggregationFunction: - type: object - properties: - SimpleTotalAggregationFunction: - $ref: '#/components/schemas/SimpleTotalAggregationFunction' + - TargetSheetId + AnalysisSourceEntity: + description:

The source entity of an analysis.

additionalProperties: false - TotalAggregationOption: type: object properties: - FieldId: - type: string - maxLength: 512 - minLength: 1 - TotalAggregationFunction: - $ref: '#/components/schemas/TotalAggregationFunction' - required: - - FieldId - - TotalAggregationFunction + SourceTemplate: + $ref: '#/components/schemas/AnalysisSourceTemplate' + DataLabelContent: + type: string + enum: + - VALUE + - PERCENT + - VALUE_AND_PERCENT + WaterfallChartOptions: additionalProperties: false - TotalOptions: type: object properties: - TotalsVisibility: - $ref: '#/components/schemas/Visibility' - TotalAggregationOptions: - type: array - items: - $ref: '#/components/schemas/TotalAggregationOption' - maxItems: 200 - minItems: 0 - Placement: - $ref: '#/components/schemas/TableTotalsPlacement' - ScrollStatus: - $ref: '#/components/schemas/TableTotalsScrollStatus' - CustomLabel: + TotalBarLabel: type: string - TotalCellStyle: - $ref: '#/components/schemas/TableCellStyle' + SankeyDiagramFieldWells: additionalProperties: false - TreeMapAggregatedFieldWells: type: object properties: - Groups: - type: array - items: - $ref: '#/components/schemas/DimensionField' - maxItems: 1 - minItems: 0 - Sizes: - type: array - items: - $ref: '#/components/schemas/MeasureField' - maxItems: 1 - minItems: 0 - Colors: - type: array - items: - $ref: '#/components/schemas/MeasureField' - maxItems: 1 - minItems: 0 + SankeyDiagramAggregatedFieldWells: + $ref: '#/components/schemas/SankeyDiagramAggregatedFieldWells' + SmallMultiplesAxisPlacement: + type: string + enum: + - OUTSIDE + - INSIDE + TableFieldWells: additionalProperties: false - TreeMapConfiguration: type: object properties: - FieldWells: - $ref: '#/components/schemas/TreeMapFieldWells' - SortConfiguration: - $ref: '#/components/schemas/TreeMapSortConfiguration' - GroupLabelOptions: - $ref: '#/components/schemas/ChartAxisLabelOptions' - SizeLabelOptions: - $ref: '#/components/schemas/ChartAxisLabelOptions' - ColorLabelOptions: - $ref: '#/components/schemas/ChartAxisLabelOptions' - ColorScale: - $ref: '#/components/schemas/ColorScale' - Legend: - $ref: '#/components/schemas/LegendOptions' - DataLabels: - $ref: '#/components/schemas/DataLabelOptions' - Tooltip: - $ref: '#/components/schemas/TooltipOptions' + TableUnaggregatedFieldWells: + $ref: '#/components/schemas/TableUnaggregatedFieldWells' + TableAggregatedFieldWells: + $ref: '#/components/schemas/TableAggregatedFieldWells' + RadarChartConfiguration: additionalProperties: false - TreeMapFieldWells: type: object properties: - TreeMapAggregatedFieldWells: - $ref: '#/components/schemas/TreeMapAggregatedFieldWells' + SortConfiguration: + $ref: '#/components/schemas/RadarChartSortConfiguration' + Legend: + $ref: '#/components/schemas/LegendOptions' + Shape: + $ref: '#/components/schemas/RadarChartShape' + BaseSeriesSettings: + $ref: '#/components/schemas/RadarChartSeriesSettings' + ColorLabelOptions: + $ref: '#/components/schemas/ChartAxisLabelOptions' + CategoryLabelOptions: + $ref: '#/components/schemas/ChartAxisLabelOptions' + AxesRangeScale: + $ref: '#/components/schemas/RadarChartAxesRangeScale' + VisualPalette: + $ref: '#/components/schemas/VisualPalette' + AlternateBandColorsVisibility: + $ref: '#/components/schemas/Visibility' + StartAngle: + maximum: 360 + type: number + minimum: -360 + CategoryAxis: + $ref: '#/components/schemas/AxisDisplayOptions' + FieldWells: + $ref: '#/components/schemas/RadarChartFieldWells' + ColorAxis: + $ref: '#/components/schemas/AxisDisplayOptions' + AlternateBandOddColor: + pattern: ^#[A-F0-9]{6}$ + type: string + AlternateBandEvenColor: + pattern: ^#[A-F0-9]{6}$ + type: string + VisualTitleLabelOptions: additionalProperties: false - TreeMapSortConfiguration: type: object properties: - TreeMapSort: - type: array - items: - $ref: '#/components/schemas/FieldSortOptions' - maxItems: 100 - minItems: 0 - TreeMapGroupItemsLimitConfiguration: - $ref: '#/components/schemas/ItemsLimitConfiguration' + Visibility: + $ref: '#/components/schemas/Visibility' + FormatText: + $ref: '#/components/schemas/ShortFormatText' + ParameterTextFieldControl: additionalProperties: false - TreeMapVisual: type: object properties: - VisualId: + ParameterControlId: + minLength: 1 + pattern: ^[\w\-]+$ type: string maxLength: 512 + DisplayOptions: + $ref: '#/components/schemas/TextFieldControlDisplayOptions' + SourceParameterName: minLength: 1 - pattern: '[\w\-]+' + pattern: ^[a-zA-Z0-9]+$ + type: string + maxLength: 2048 Title: - $ref: '#/components/schemas/VisualTitleLabelOptions' - Subtitle: - $ref: '#/components/schemas/VisualSubtitleLabelOptions' - ChartConfiguration: - $ref: '#/components/schemas/TreeMapConfiguration' - Actions: - type: array - items: - $ref: '#/components/schemas/VisualCustomAction' - maxItems: 10 - minItems: 0 - ColumnHierarchies: - type: array - items: - $ref: '#/components/schemas/ColumnHierarchy' - maxItems: 2 - minItems: 0 + minLength: 1 + type: string + maxLength: 2048 required: - - VisualId - additionalProperties: false - TrendArrowOptions: - type: object - properties: - Visibility: - $ref: '#/components/schemas/Visibility' - additionalProperties: false + - ParameterControlId + - SourceParameterName + - Title URLTargetConfiguration: type: string enum: - NEW_TAB - NEW_WINDOW - SAME_TAB - UnaggregatedField: + WordCloudFieldWells: + additionalProperties: false type: object properties: - FieldId: - type: string - maxLength: 512 - minLength: 1 - Column: - $ref: '#/components/schemas/ColumnIdentifier' - FormatConfiguration: - $ref: '#/components/schemas/FormatConfiguration' - required: - - Column - - FieldId + WordCloudAggregatedFieldWells: + $ref: '#/components/schemas/WordCloudAggregatedFieldWells' + AggregationFunction: additionalProperties: false - UniqueValuesComputation: type: object properties: - ComputationId: - type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Name: - type: string - Category: - $ref: '#/components/schemas/DimensionField' - required: - - ComputationId + AttributeAggregationFunction: + $ref: '#/components/schemas/AttributeAggregationFunction' + DateAggregationFunction: + $ref: '#/components/schemas/DateAggregationFunction' + NumericalAggregationFunction: + $ref: '#/components/schemas/NumericalAggregationFunction' + CategoricalAggregationFunction: + $ref: '#/components/schemas/CategoricalAggregationFunction' + TableStyleTarget: additionalProperties: false - ValidationStrategy: type: object properties: - Mode: - $ref: '#/components/schemas/ValidationStrategyMode' + CellType: + $ref: '#/components/schemas/StyledCellType' required: - - Mode + - CellType + GeospatialWindowOptions: additionalProperties: false - ValidationStrategyMode: - type: string - enum: - - STRICT - - LENIENT - ValueWhenUnsetOption: - type: string - enum: - - RECOMMENDED_VALUE - - 'NULL' - VerticalTextAlignment: - type: string - enum: - - TOP - - MIDDLE - - BOTTOM - - AUTO - Visibility: + type: object + properties: + Bounds: + $ref: '#/components/schemas/GeospatialCoordinateBounds' + MapZoomMode: + $ref: '#/components/schemas/MapZoomMode' + KPIConditionalFormatting: + additionalProperties: false + type: object + properties: + ConditionalFormattingOptions: + minItems: 0 + maxItems: 100 + type: array + items: + $ref: '#/components/schemas/KPIConditionalFormattingOption' + KPIConditionalFormattingOption: + additionalProperties: false + type: object + properties: + PrimaryValue: + $ref: '#/components/schemas/KPIPrimaryValueConditionalFormatting' + ActualValue: + $ref: '#/components/schemas/KPIActualValueConditionalFormatting' + ComparisonValue: + $ref: '#/components/schemas/KPIComparisonValueConditionalFormatting' + ProgressBar: + $ref: '#/components/schemas/KPIProgressBarConditionalFormatting' + LineChartMarkerShape: type: string enum: - - HIDDEN - - VISIBLE - VisibleRangeOptions: + - CIRCLE + - TRIANGLE + - SQUARE + - DIAMOND + - ROUNDED_SQUARE + ArcAxisDisplayRange: + additionalProperties: false type: object properties: - PercentRange: - $ref: '#/components/schemas/PercentVisibleRange' + Min: + default: null + type: number + Max: + default: null + type: number + ParameterDeclaration: additionalProperties: false + type: object + properties: + StringParameterDeclaration: + $ref: '#/components/schemas/StringParameterDeclaration' + DateTimeParameterDeclaration: + $ref: '#/components/schemas/DateTimeParameterDeclaration' + DecimalParameterDeclaration: + $ref: '#/components/schemas/DecimalParameterDeclaration' + IntegerParameterDeclaration: + $ref: '#/components/schemas/IntegerParameterDeclaration' Visual: + additionalProperties: false type: object properties: + FunnelChartVisual: + $ref: '#/components/schemas/FunnelChartVisual' + FilledMapVisual: + $ref: '#/components/schemas/FilledMapVisual' + BoxPlotVisual: + $ref: '#/components/schemas/BoxPlotVisual' + WaterfallVisual: + $ref: '#/components/schemas/WaterfallVisual' + CustomContentVisual: + $ref: '#/components/schemas/CustomContentVisual' + PieChartVisual: + $ref: '#/components/schemas/PieChartVisual' + KPIVisual: + $ref: '#/components/schemas/KPIVisual' + HistogramVisual: + $ref: '#/components/schemas/HistogramVisual' TableVisual: $ref: '#/components/schemas/TableVisual' PivotTableVisual: $ref: '#/components/schemas/PivotTableVisual' + GeospatialMapVisual: + $ref: '#/components/schemas/GeospatialMapVisual' BarChartVisual: $ref: '#/components/schemas/BarChartVisual' - KPIVisual: - $ref: '#/components/schemas/KPIVisual' - PieChartVisual: - $ref: '#/components/schemas/PieChartVisual' - GaugeChartVisual: - $ref: '#/components/schemas/GaugeChartVisual' - LineChartVisual: - $ref: '#/components/schemas/LineChartVisual' + ScatterPlotVisual: + $ref: '#/components/schemas/ScatterPlotVisual' + RadarChartVisual: + $ref: '#/components/schemas/RadarChartVisual' HeatMapVisual: $ref: '#/components/schemas/HeatMapVisual' TreeMapVisual: $ref: '#/components/schemas/TreeMapVisual' - GeospatialMapVisual: - $ref: '#/components/schemas/GeospatialMapVisual' - FilledMapVisual: - $ref: '#/components/schemas/FilledMapVisual' - FunnelChartVisual: - $ref: '#/components/schemas/FunnelChartVisual' - ScatterPlotVisual: - $ref: '#/components/schemas/ScatterPlotVisual' ComboChartVisual: $ref: '#/components/schemas/ComboChartVisual' - BoxPlotVisual: - $ref: '#/components/schemas/BoxPlotVisual' - WaterfallVisual: - $ref: '#/components/schemas/WaterfallVisual' - HistogramVisual: - $ref: '#/components/schemas/HistogramVisual' WordCloudVisual: $ref: '#/components/schemas/WordCloudVisual' InsightVisual: $ref: '#/components/schemas/InsightVisual' SankeyDiagramVisual: $ref: '#/components/schemas/SankeyDiagramVisual' - CustomContentVisual: - $ref: '#/components/schemas/CustomContentVisual' + GaugeChartVisual: + $ref: '#/components/schemas/GaugeChartVisual' + LineChartVisual: + $ref: '#/components/schemas/LineChartVisual' EmptyVisual: $ref: '#/components/schemas/EmptyVisual' - RadarChartVisual: - $ref: '#/components/schemas/RadarChartVisual' - additionalProperties: false - VisualCustomAction: - type: object - properties: - CustomActionId: - type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Name: - type: string - maxLength: 256 - minLength: 1 - Status: - $ref: '#/components/schemas/WidgetStatus' - Trigger: - $ref: '#/components/schemas/VisualCustomActionTrigger' - ActionOperations: - type: array - items: - $ref: '#/components/schemas/VisualCustomActionOperation' - maxItems: 2 - minItems: 1 - required: - - ActionOperations - - CustomActionId - - Name - - Trigger + WordCloudChartConfiguration: additionalProperties: false - VisualCustomActionOperation: type: object properties: - FilterOperation: - $ref: '#/components/schemas/CustomActionFilterOperation' - NavigationOperation: - $ref: '#/components/schemas/CustomActionNavigationOperation' - URLOperation: - $ref: '#/components/schemas/CustomActionURLOperation' - SetParametersOperation: - $ref: '#/components/schemas/CustomActionSetParametersOperation' + SortConfiguration: + $ref: '#/components/schemas/WordCloudSortConfiguration' + CategoryLabelOptions: + $ref: '#/components/schemas/ChartAxisLabelOptions' + FieldWells: + $ref: '#/components/schemas/WordCloudFieldWells' + WordCloudOptions: + $ref: '#/components/schemas/WordCloudOptions' + CustomContentVisual: additionalProperties: false - VisualCustomActionTrigger: - type: string - enum: - - DATA_POINT_CLICK - - DATA_POINT_MENU - VisualPalette: type: object properties: - ChartColor: + Subtitle: + $ref: '#/components/schemas/VisualSubtitleLabelOptions' + VisualId: + minLength: 1 + pattern: ^[\w\-]+$ type: string - pattern: ^#[A-F0-9]{6}$ - ColorMap: + maxLength: 512 + ChartConfiguration: + $ref: '#/components/schemas/CustomContentConfiguration' + Actions: + minItems: 0 + maxItems: 10 type: array items: - $ref: '#/components/schemas/DataPathColor' - maxItems: 5000 - minItems: 0 + $ref: '#/components/schemas/VisualCustomAction' + DataSetIdentifier: + minLength: 1 + type: string + maxLength: 2048 + Title: + $ref: '#/components/schemas/VisualTitleLabelOptions' + required: + - DataSetIdentifier + - VisualId + PanelConfiguration: additionalProperties: false - VisualSubtitleLabelOptions: type: object properties: - Visibility: + BorderThickness: + description: String based length that is composed of value and unit in px + type: string + BorderStyle: + $ref: '#/components/schemas/PanelBorderStyle' + GutterSpacing: + description: String based length that is composed of value and unit in px + type: string + BackgroundVisibility: $ref: '#/components/schemas/Visibility' - FormatText: - $ref: '#/components/schemas/LongFormatText' + BorderVisibility: + $ref: '#/components/schemas/Visibility' + BorderColor: + pattern: ^#[A-F0-9]{6}(?:[A-F0-9]{2})?$ + type: string + Title: + $ref: '#/components/schemas/PanelTitleOptions' + GutterVisibility: + $ref: '#/components/schemas/Visibility' + BackgroundColor: + pattern: ^#[A-F0-9]{6}(?:[A-F0-9]{2})?$ + type: string + SmallMultiplesOptions: additionalProperties: false - VisualTitleLabelOptions: type: object properties: - Visibility: - $ref: '#/components/schemas/Visibility' - FormatText: - $ref: '#/components/schemas/ShortFormatText' + MaxVisibleRows: + maximum: 10 + type: number + minimum: 1 + PanelConfiguration: + $ref: '#/components/schemas/PanelConfiguration' + MaxVisibleColumns: + maximum: 10 + type: number + minimum: 1 + XAxis: + $ref: '#/components/schemas/SmallMultiplesAxisProperties' + YAxis: + $ref: '#/components/schemas/SmallMultiplesAxisProperties' + AnalysisDefinition: additionalProperties: false - WaterfallChartAggregatedFieldWells: type: object properties: - Categories: - type: array - items: - $ref: '#/components/schemas/DimensionField' - maxItems: 200 - minItems: 0 - Values: - type: array - items: - $ref: '#/components/schemas/MeasureField' - maxItems: 200 + Options: + $ref: '#/components/schemas/AssetOptions' + FilterGroups: minItems: 0 - Breakdowns: + maxItems: 2000 type: array items: - $ref: '#/components/schemas/DimensionField' - maxItems: 200 + $ref: '#/components/schemas/FilterGroup' + CalculatedFields: minItems: 0 - additionalProperties: false - WaterfallChartConfiguration: - type: object - properties: - FieldWells: - $ref: '#/components/schemas/WaterfallChartFieldWells' - SortConfiguration: - $ref: '#/components/schemas/WaterfallChartSortConfiguration' - WaterfallChartOptions: - $ref: '#/components/schemas/WaterfallChartOptions' - CategoryAxisLabelOptions: - $ref: '#/components/schemas/ChartAxisLabelOptions' - CategoryAxisDisplayOptions: - $ref: '#/components/schemas/AxisDisplayOptions' - PrimaryYAxisLabelOptions: - $ref: '#/components/schemas/ChartAxisLabelOptions' - PrimaryYAxisDisplayOptions: - $ref: '#/components/schemas/AxisDisplayOptions' - Legend: - $ref: '#/components/schemas/LegendOptions' - DataLabels: - $ref: '#/components/schemas/DataLabelOptions' - VisualPalette: - $ref: '#/components/schemas/VisualPalette' - additionalProperties: false - WaterfallChartFieldWells: - type: object - properties: - WaterfallChartAggregatedFieldWells: - $ref: '#/components/schemas/WaterfallChartAggregatedFieldWells' - additionalProperties: false - WaterfallChartOptions: - type: object - properties: - TotalBarLabel: - type: string - additionalProperties: false - WaterfallChartSortConfiguration: - type: object - properties: - CategorySort: + maxItems: 500 type: array items: - $ref: '#/components/schemas/FieldSortOptions' - maxItems: 100 - minItems: 0 - BreakdownItemsLimit: - $ref: '#/components/schemas/ItemsLimitConfiguration' - additionalProperties: false - WaterfallVisual: - type: object - properties: - VisualId: - type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Title: - $ref: '#/components/schemas/VisualTitleLabelOptions' - Subtitle: - $ref: '#/components/schemas/VisualSubtitleLabelOptions' - ChartConfiguration: - $ref: '#/components/schemas/WaterfallChartConfiguration' - Actions: + $ref: '#/components/schemas/CalculatedField' + DataSetIdentifierDeclarations: + minItems: 1 + maxItems: 50 type: array items: - $ref: '#/components/schemas/VisualCustomAction' - maxItems: 10 + $ref: '#/components/schemas/DataSetIdentifierDeclaration' + ColumnConfigurations: minItems: 0 - ColumnHierarchies: + maxItems: 2000 type: array items: - $ref: '#/components/schemas/ColumnHierarchy' - maxItems: 2 + $ref: '#/components/schemas/ColumnConfiguration' + AnalysisDefaults: + $ref: '#/components/schemas/AnalysisDefaults' + Sheets: minItems: 0 + maxItems: 20 + type: array + items: + $ref: '#/components/schemas/SheetDefinition' + ParameterDeclarations: + minItems: 0 + maxItems: 200 + type: array + items: + $ref: '#/components/schemas/ParameterDeclaration' required: - - VisualId - additionalProperties: false - WhatIfPointScenario: - type: object - properties: - Date: - type: string - format: date-time - Value: - type: number - default: 0 - required: - - Date - - Value + - DataSetIdentifierDeclarations + PaperOrientation: + type: string + enum: + - PORTRAIT + - LANDSCAPE + NumericSeparatorConfiguration: additionalProperties: false - WhatIfRangeScenario: type: object properties: - StartDate: - type: string - format: date-time - EndDate: - type: string - format: date-time - Value: - type: number - default: 0 - required: - - EndDate - - StartDate - - Value + DecimalSeparator: + $ref: '#/components/schemas/NumericSeparatorSymbol' + ThousandsSeparator: + $ref: '#/components/schemas/ThousandSeparatorOptions' + CustomParameterValues: additionalProperties: false - WidgetStatus: - type: string - enum: - - ENABLED - - DISABLED - WordCloudAggregatedFieldWells: type: object properties: - GroupBy: + DecimalValues: + minItems: 0 + maxItems: 50000 type: array items: - $ref: '#/components/schemas/DimensionField' - maxItems: 10 + type: number + IntegerValues: minItems: 0 - Size: + maxItems: 50000 type: array items: - $ref: '#/components/schemas/MeasureField' - maxItems: 1 + type: number + StringValues: minItems: 0 - additionalProperties: false - WordCloudChartConfiguration: - type: object - properties: - FieldWells: - $ref: '#/components/schemas/WordCloudFieldWells' - SortConfiguration: - $ref: '#/components/schemas/WordCloudSortConfiguration' - CategoryLabelOptions: - $ref: '#/components/schemas/ChartAxisLabelOptions' - WordCloudOptions: - $ref: '#/components/schemas/WordCloudOptions' - additionalProperties: false - WordCloudCloudLayout: + maxItems: 50000 + type: array + items: + type: string + DateTimeValues: + minItems: 0 + maxItems: 50000 + type: array + items: + format: date-time + type: string + SimpleNumericalAggregationFunction: type: string enum: - - FLUID - - NORMAL - WordCloudFieldWells: - type: object - properties: - WordCloudAggregatedFieldWells: - $ref: '#/components/schemas/WordCloudAggregatedFieldWells' + - SUM + - AVERAGE + - MIN + - MAX + - COUNT + - DISTINCT_COUNT + - VAR + - VARP + - STDEV + - STDEVP + - MEDIAN + BoxPlotOptions: additionalProperties: false - WordCloudOptions: type: object properties: - WordOrientation: - $ref: '#/components/schemas/WordCloudWordOrientation' - WordScaling: - $ref: '#/components/schemas/WordCloudWordScaling' - CloudLayout: - $ref: '#/components/schemas/WordCloudCloudLayout' - WordCasing: - $ref: '#/components/schemas/WordCloudWordCasing' - WordPadding: - $ref: '#/components/schemas/WordCloudWordPadding' - MaximumStringLength: - type: number - maximum: 100 - minimum: 1 + StyleOptions: + $ref: '#/components/schemas/BoxPlotStyleOptions' + OutlierVisibility: + $ref: '#/components/schemas/Visibility' + AllDataPointsVisibility: + $ref: '#/components/schemas/Visibility' + KPIPrimaryValueConditionalFormatting: additionalProperties: false - WordCloudSortConfiguration: type: object properties: - CategoryItemsLimit: - $ref: '#/components/schemas/ItemsLimitConfiguration' - CategorySort: - type: array - items: - $ref: '#/components/schemas/FieldSortOptions' - maxItems: 100 - minItems: 0 + TextColor: + $ref: '#/components/schemas/ConditionalFormattingColor' + Icon: + $ref: '#/components/schemas/ConditionalFormattingIcon' + NumberDisplayFormatConfiguration: additionalProperties: false - WordCloudVisual: type: object properties: - VisualId: + NegativeValueConfiguration: + $ref: '#/components/schemas/NegativeValueConfiguration' + DecimalPlacesConfiguration: + $ref: '#/components/schemas/DecimalPlacesConfiguration' + NumberScale: + $ref: '#/components/schemas/NumberScale' + NullValueFormatConfiguration: + $ref: '#/components/schemas/NullValueFormatConfiguration' + Suffix: + minLength: 1 type: string - maxLength: 512 + maxLength: 128 + SeparatorConfiguration: + $ref: '#/components/schemas/NumericSeparatorConfiguration' + Prefix: minLength: 1 - pattern: '[\w\-]+' - Title: - $ref: '#/components/schemas/VisualTitleLabelOptions' - Subtitle: - $ref: '#/components/schemas/VisualSubtitleLabelOptions' - ChartConfiguration: - $ref: '#/components/schemas/WordCloudChartConfiguration' - Actions: - type: array - items: - $ref: '#/components/schemas/VisualCustomAction' - maxItems: 10 - minItems: 0 - ColumnHierarchies: - type: array - items: - $ref: '#/components/schemas/ColumnHierarchy' - maxItems: 2 - minItems: 0 - required: - - VisualId + type: string + maxLength: 128 + PivotTableFieldWells: additionalProperties: false - WordCloudWordCasing: - type: string - enum: - - LOWER_CASE - - EXISTING_CASE - WordCloudWordOrientation: - type: string - enum: - - HORIZONTAL - - HORIZONTAL_AND_VERTICAL - WordCloudWordPadding: - type: string - enum: - - NONE - - SMALL - - MEDIUM - - LARGE - WordCloudWordScaling: - type: string - enum: - - EMPHASIZE - - NORMAL + type: object + properties: + PivotTableAggregatedFieldWells: + $ref: '#/components/schemas/PivotTableAggregatedFieldWells' Analysis: type: object properties: - AnalysisId: - type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Arn: - type: string - AwsAccountId: - type: string - maxLength: 12 - minLength: 12 - pattern: ^[0-9]{12}$ + Status: + $ref: '#/components/schemas/ResourceStatus' CreatedTime: - type: string format: date-time + description:

The time that the analysis was created.

+ type: string + Parameters: + $ref: '#/components/schemas/Parameters' DataSetArns: + minItems: 0 + maxItems: 100 + description:

The ARNs of the datasets of the analysis.

type: array items: type: string - maxItems: 100 - minItems: 0 + SourceEntity: + $ref: '#/components/schemas/AnalysisSourceEntity' + ThemeArn: + description:

The ARN of the theme of the analysis.

+ type: string Definition: $ref: '#/components/schemas/AnalysisDefinition' - Errors: - type: array - items: - $ref: '#/components/schemas/AnalysisError' - minItems: 1 LastUpdatedTime: - type: string format: date-time + description:

The time that the analysis was last updated.

+ type: string + ValidationStrategy: + $ref: '#/components/schemas/ValidationStrategy' Name: + minLength: 1 + description:

The descriptive name of the analysis.

type: string maxLength: 2048 + Errors: + minItems: 1 + description:

Errors associated with the analysis.

+ type: array + items: + $ref: '#/components/schemas/AnalysisError' + AnalysisId: minLength: 1 - Parameters: - $ref: '#/components/schemas/Parameters' + pattern: ^[\w\-]+$ + type: string + maxLength: 512 + AwsAccountId: + minLength: 12 + pattern: ^[0-9]{12}$ + type: string + maxLength: 12 Permissions: + minItems: 1 + maxItems: 64 type: array items: $ref: '#/components/schemas/ResourcePermission' - maxItems: 64 + Arn: + description:

The Amazon Resource Name (ARN) of the analysis.

+ type: string + Tags: minItems: 1 - Sheets: + maxItems: 200 type: array items: - $ref: '#/components/schemas/Sheet' - maxItems: 20 + $ref: '#/components/schemas/Tag' + Sheets: minItems: 0 - SourceEntity: - $ref: '#/components/schemas/AnalysisSourceEntity' - Status: - $ref: '#/components/schemas/ResourceStatus' - Tags: + maxItems: 20 + description:

A list of the associated sheets with the unique identifier and name of each sheet.

type: array items: - $ref: '#/components/schemas/Tag' - maxItems: 200 - minItems: 1 - ThemeArn: - type: string - ValidationStrategy: - $ref: '#/components/schemas/ValidationStrategy' + $ref: '#/components/schemas/Sheet' required: - AwsAccountId - AnalysisId @@ -8237,6 +8465,10 @@ components: - AnalysisId - Name x-required-permissions: + read: + - quicksight:DescribeAnalysis + - quicksight:DescribeAnalysisPermissions + - quicksight:ListTagsForResource create: - quicksight:DescribeAnalysis - quicksight:DescribeAnalysisPermissions @@ -8247,10 +8479,6 @@ components: - quicksight:TagResource - quicksight:UntagResource - quicksight:ListTagsForResource - read: - - quicksight:DescribeAnalysis - - quicksight:DescribeAnalysisPermissions - - quicksight:ListTagsForResource update: - quicksight:DescribeAnalysis - quicksight:DescribeAnalysisPermissions @@ -8262,331 +8490,365 @@ components: - quicksight:TagResource - quicksight:UntagResource - quicksight:ListTagsForResource + list: + - quicksight:ListAnalyses delete: - quicksight:DescribeAnalysis - quicksight:DeleteAnalysis - list: - - quicksight:ListAnalyses - AdHocFilteringOption: + ExportToCSVOption: + description:

Export to .csv option.

+ additionalProperties: false type: object properties: AvailabilityStatus: $ref: '#/components/schemas/DashboardBehavior' + DataPointDrillUpDownOption: + description:

The drill down options for data points in a dashbaord.

additionalProperties: false - DashboardBehavior: - type: string - enum: - - ENABLED - - DISABLED + type: object + properties: + AvailabilityStatus: + $ref: '#/components/schemas/DashboardBehavior' + VisualAxisSortOption: + additionalProperties: false + type: object + properties: + AvailabilityStatus: + $ref: '#/components/schemas/DashboardBehavior' DashboardError: + description:

Dashboard error.

+ additionalProperties: false type: object properties: Type: $ref: '#/components/schemas/DashboardErrorType' Message: + pattern: \S + description:

Message.

type: string - pattern: .*\S.* ViolatedEntities: + minItems: 0 + maxItems: 200 + description:

Lists the violated entities that caused the dashboard error.

type: array items: $ref: '#/components/schemas/Entity' - maxItems: 200 - minItems: 0 + ExportWithHiddenFieldsOption: + description:

Determines whether or not hidden fields are visible on exported dashbaords.

additionalProperties: false - DashboardErrorType: - type: string - enum: - - ACCESS_DENIED - - SOURCE_NOT_FOUND - - DATA_SET_NOT_FOUND - - INTERNAL_FAILURE - - PARAMETER_VALUE_INCOMPATIBLE - - PARAMETER_TYPE_INVALID - - PARAMETER_NOT_FOUND - - COLUMN_TYPE_MISMATCH - - COLUMN_GEOGRAPHIC_ROLE_MISMATCH - - COLUMN_REPLACEMENT_MISSING + type: object + properties: + AvailabilityStatus: + $ref: '#/components/schemas/DashboardBehavior' DashboardPublishOptions: + description:

Dashboard publish options.

+ additionalProperties: false type: object properties: - AdHocFilteringOption: - $ref: '#/components/schemas/AdHocFilteringOption' - ExportToCSVOption: - $ref: '#/components/schemas/ExportToCSVOption' SheetControlsOption: $ref: '#/components/schemas/SheetControlsOption' + ExportToCSVOption: + $ref: '#/components/schemas/ExportToCSVOption' + DataPointMenuLabelOption: + $ref: '#/components/schemas/DataPointMenuLabelOption' + DataPointDrillUpDownOption: + $ref: '#/components/schemas/DataPointDrillUpDownOption' + AdHocFilteringOption: + $ref: '#/components/schemas/AdHocFilteringOption' VisualPublishOptions: $ref: '#/components/schemas/DashboardVisualPublishOptions' - SheetLayoutElementMaximizationOption: - $ref: '#/components/schemas/SheetLayoutElementMaximizationOption' VisualMenuOption: $ref: '#/components/schemas/VisualMenuOption' + DataPointTooltipOption: + $ref: '#/components/schemas/DataPointTooltipOption' VisualAxisSortOption: $ref: '#/components/schemas/VisualAxisSortOption' ExportWithHiddenFieldsOption: $ref: '#/components/schemas/ExportWithHiddenFieldsOption' - DataPointDrillUpDownOption: - $ref: '#/components/schemas/DataPointDrillUpDownOption' - DataPointMenuLabelOption: - $ref: '#/components/schemas/DataPointMenuLabelOption' - DataPointTooltipOption: - $ref: '#/components/schemas/DataPointTooltipOption' + SheetLayoutElementMaximizationOption: + $ref: '#/components/schemas/SheetLayoutElementMaximizationOption' + DataPointTooltipOption: + description:

The data point tooltip options.

additionalProperties: false - DashboardSourceEntity: type: object properties: - SourceTemplate: - $ref: '#/components/schemas/DashboardSourceTemplate' - additionalProperties: false + AvailabilityStatus: + $ref: '#/components/schemas/DashboardBehavior' DashboardSourceTemplate: + description:

Dashboard source template.

+ additionalProperties: false type: object properties: DataSetReferences: + minItems: 1 + description:

Dataset references.

type: array items: $ref: '#/components/schemas/DataSetReference' - minItems: 1 Arn: + description:

The Amazon Resource Name (ARN) of the resource.

type: string required: - Arn - DataSetReferences + LinkSharingConfiguration: additionalProperties: false - DashboardUIState: - type: string - enum: - - EXPANDED - - COLLAPSED + type: object + properties: + Permissions: + minItems: 1 + maxItems: 64 + type: array + items: + $ref: '#/components/schemas/ResourcePermission' DashboardVersion: + description:

Dashboard version.

+ additionalProperties: false type: object properties: - CreatedTime: - type: string - format: date-time + Status: + $ref: '#/components/schemas/ResourceStatus' Errors: + minItems: 1 + description:

Errors associated with this dashboard version.

type: array items: $ref: '#/components/schemas/DashboardError' - minItems: 1 - VersionNumber: - type: number - minimum: 1 - Status: - $ref: '#/components/schemas/ResourceStatus' - Arn: + CreatedTime: + format: date-time + description:

The time that this dashboard version was created.

type: string - SourceEntityArn: + Description: + minLength: 1 + description:

Description.

type: string + maxLength: 512 DataSetArns: + minItems: 0 + maxItems: 100 + description: |- +

The Amazon Resource Numbers (ARNs) for the datasets that are associated with this + version of the dashboard.

type: array items: type: string - maxItems: 100 - minItems: 0 - Description: - type: string - maxLength: 512 - minLength: 1 ThemeArn: + description:

The ARN of the theme associated with a version of the dashboard.

+ type: string + Arn: + description:

The Amazon Resource Name (ARN) of the resource.

+ type: string + SourceEntityArn: + description:

Source entity ARN.

type: string + VersionNumber: + description:

Version number for this version of the dashboard.

+ type: number + minimum: 1 Sheets: + minItems: 0 + maxItems: 20 + description:

A list of the associated sheets with the unique identifier and name of each sheet.

type: array items: $ref: '#/components/schemas/Sheet' - maxItems: 20 - minItems: 0 + VisualMenuOption: additionalProperties: false + type: object + properties: + AvailabilityStatus: + $ref: '#/components/schemas/DashboardBehavior' + SheetLayoutElementMaximizationOption: + description:

The sheet layout maximization options of a dashbaord.

+ additionalProperties: false + type: object + properties: + AvailabilityStatus: + $ref: '#/components/schemas/DashboardBehavior' + DashboardBehavior: + type: string + enum: + - ENABLED + - DISABLED DashboardVersionDefinition: + additionalProperties: false type: object properties: - DataSetIdentifierDeclarations: - type: array - items: - $ref: '#/components/schemas/DataSetIdentifierDeclaration' - maxItems: 50 - minItems: 1 - Sheets: + Options: + $ref: '#/components/schemas/AssetOptions' + FilterGroups: + minItems: 0 + maxItems: 2000 type: array items: - $ref: '#/components/schemas/SheetDefinition' - maxItems: 20 - minItems: 0 + $ref: '#/components/schemas/FilterGroup' CalculatedFields: + minItems: 0 + maxItems: 500 type: array items: $ref: '#/components/schemas/CalculatedField' - maxItems: 500 + DataSetIdentifierDeclarations: + minItems: 1 + maxItems: 50 + type: array + items: + $ref: '#/components/schemas/DataSetIdentifierDeclaration' + ColumnConfigurations: minItems: 0 - ParameterDeclarations: + maxItems: 2000 type: array items: - $ref: '#/components/schemas/ParameterDeclaration' - maxItems: 200 + $ref: '#/components/schemas/ColumnConfiguration' + AnalysisDefaults: + $ref: '#/components/schemas/AnalysisDefaults' + Sheets: minItems: 0 - FilterGroups: + maxItems: 20 type: array items: - $ref: '#/components/schemas/FilterGroup' - maxItems: 2000 + $ref: '#/components/schemas/SheetDefinition' + ParameterDeclarations: minItems: 0 - ColumnConfigurations: + maxItems: 200 type: array items: - $ref: '#/components/schemas/ColumnConfiguration' - maxItems: 200 - minItems: 0 - AnalysisDefaults: - $ref: '#/components/schemas/AnalysisDefaults' - Options: - $ref: '#/components/schemas/AssetOptions' + $ref: '#/components/schemas/ParameterDeclaration' required: - DataSetIdentifierDeclarations + AdHocFilteringOption: + description:

An ad hoc (one-time) filtering option.

additionalProperties: false - DashboardVisualPublishOptions: - type: object - properties: - ExportHiddenFieldsOption: - $ref: '#/components/schemas/ExportHiddenFieldsOption' - additionalProperties: false - DataPointDrillUpDownOption: - type: object - properties: - AvailabilityStatus: - $ref: '#/components/schemas/DashboardBehavior' - additionalProperties: false - DataPointMenuLabelOption: - type: object - properties: - AvailabilityStatus: - $ref: '#/components/schemas/DashboardBehavior' - additionalProperties: false - DataPointTooltipOption: type: object properties: AvailabilityStatus: $ref: '#/components/schemas/DashboardBehavior' - additionalProperties: false ExportHiddenFieldsOption: - type: object - properties: - AvailabilityStatus: - $ref: '#/components/schemas/DashboardBehavior' + description:

Determines if hidden fields are included in an exported dashboard.

additionalProperties: false - ExportToCSVOption: type: object properties: AvailabilityStatus: $ref: '#/components/schemas/DashboardBehavior' + DashboardUIState: + type: string + enum: + - EXPANDED + - COLLAPSED + DataPointMenuLabelOption: + description:

The data point menu options of a dashboard.

additionalProperties: false - ExportWithHiddenFieldsOption: type: object properties: AvailabilityStatus: $ref: '#/components/schemas/DashboardBehavior' - additionalProperties: false - LinkSharingConfiguration: - type: object - properties: - Permissions: - type: array - items: - $ref: '#/components/schemas/ResourcePermission' - maxItems: 64 - minItems: 1 - additionalProperties: false + DashboardErrorType: + type: string + enum: + - ACCESS_DENIED + - SOURCE_NOT_FOUND + - DATA_SET_NOT_FOUND + - INTERNAL_FAILURE + - PARAMETER_VALUE_INCOMPATIBLE + - PARAMETER_TYPE_INVALID + - PARAMETER_NOT_FOUND + - COLUMN_TYPE_MISMATCH + - COLUMN_GEOGRAPHIC_ROLE_MISMATCH + - COLUMN_REPLACEMENT_MISSING SheetControlsOption: + description:

Sheet controls option.

+ additionalProperties: false type: object properties: VisibilityState: $ref: '#/components/schemas/DashboardUIState' + DashboardSourceEntity: + description:

Dashboard source entity.

additionalProperties: false - SheetLayoutElementMaximizationOption: - type: object - properties: - AvailabilityStatus: - $ref: '#/components/schemas/DashboardBehavior' - additionalProperties: false - VisualAxisSortOption: type: object properties: - AvailabilityStatus: - $ref: '#/components/schemas/DashboardBehavior' + SourceTemplate: + $ref: '#/components/schemas/DashboardSourceTemplate' + DashboardVisualPublishOptions: + description:

The visual publish options of a visual in a dashboard

additionalProperties: false - VisualMenuOption: type: object properties: - AvailabilityStatus: - $ref: '#/components/schemas/DashboardBehavior' - additionalProperties: false + ExportHiddenFieldsOption: + $ref: '#/components/schemas/ExportHiddenFieldsOption' Dashboard: type: object properties: - Arn: + CreatedTime: + format: date-time + description:

The time that this dashboard was created.

type: string - AwsAccountId: + Parameters: + $ref: '#/components/schemas/Parameters' + VersionDescription: + minLength: 1 type: string - maxLength: 12 - minLength: 12 - pattern: ^[0-9]{12}$ - CreatedTime: + maxLength: 512 + SourceEntity: + $ref: '#/components/schemas/DashboardSourceEntity' + ThemeArn: type: string + Definition: + $ref: '#/components/schemas/DashboardVersionDefinition' + LastUpdatedTime: format: date-time + description:

The last time that this dashboard was updated.

+ type: string + ValidationStrategy: + $ref: '#/components/schemas/ValidationStrategy' DashboardId: + minLength: 1 + pattern: ^[\w\-]+$ type: string maxLength: 512 + LinkSharingConfiguration: + $ref: '#/components/schemas/LinkSharingConfiguration' + Name: minLength: 1 - pattern: '[\w\-]+' + type: string + maxLength: 2048 DashboardPublishOptions: $ref: '#/components/schemas/DashboardPublishOptions' - Definition: - $ref: '#/components/schemas/DashboardVersionDefinition' LastPublishedTime: - type: string format: date-time - LastUpdatedTime: + description:

The last time that this dashboard was published.

type: string - format: date-time + Version: + $ref: '#/components/schemas/DashboardVersion' + AwsAccountId: + minLength: 12 + pattern: ^[0-9]{12}$ + type: string + maxLength: 12 + Permissions: + minItems: 1 + maxItems: 64 + type: array + items: + $ref: '#/components/schemas/ResourcePermission' LinkEntities: + minItems: 0 + maxItems: 5 type: array items: + minLength: 1 + pattern: ^arn:aws[\w\-]*:quicksight:[\w\-]+:\d+:analysis/[\w\-]{1,512}$ type: string maxLength: 1024 - minLength: 1 - pattern: ^arn:aws[\w\-]*:quicksight:[\w\-]+:\d+:analysis/[\w\-]{1,512} - maxItems: 5 - minItems: 0 - LinkSharingConfiguration: - $ref: '#/components/schemas/LinkSharingConfiguration' - Name: + Arn: + description:

The Amazon Resource Name (ARN) of the resource.

type: string - maxLength: 2048 - minLength: 1 - Parameters: - $ref: '#/components/schemas/Parameters' - Permissions: - type: array - items: - $ref: '#/components/schemas/ResourcePermission' - maxItems: 64 - minItems: 1 - SourceEntity: - $ref: '#/components/schemas/DashboardSourceEntity' Tags: + minItems: 1 + maxItems: 200 type: array items: $ref: '#/components/schemas/Tag' - maxItems: 200 - minItems: 1 - ThemeArn: - type: string - ValidationStrategy: - $ref: '#/components/schemas/ValidationStrategy' - Version: - $ref: '#/components/schemas/DashboardVersion' - VersionDescription: - type: string - maxLength: 512 - minLength: 1 required: - AwsAccountId - DashboardId @@ -8620,6 +8882,10 @@ components: - DashboardId - Name x-required-permissions: + read: + - quicksight:DescribeDashboard + - quicksight:DescribeDashboardPermissions + - quicksight:ListTagsForResource create: - quicksight:DescribeDashboard - quicksight:DescribeDashboardPermissions @@ -8630,10 +8896,6 @@ components: - quicksight:TagResource - quicksight:UntagResource - quicksight:ListTagsForResource - read: - - quicksight:DescribeDashboard - - quicksight:DescribeDashboardPermissions - - quicksight:ListTagsForResource update: - quicksight:DescribeDashboard - quicksight:DescribeDashboardPermissions @@ -8647,15 +8909,20 @@ components: - quicksight:TagResource - quicksight:UntagResource - quicksight:ListTagsForResource + list: + - quicksight:ListDashboards delete: - quicksight:DescribeDashboard - quicksight:DeleteDashboard - list: - - quicksight:ListDashboards CalculatedColumn: type: object description:

A calculated column for a dataset.

properties: + ColumnName: + type: string + maxLength: 127 + minLength: 1 + description:

Column name.

ColumnId: type: string maxLength: 64 @@ -8664,11 +8931,6 @@ components:

A unique ID to identify a calculated column. During a dataset update, if the column ID of a calculated column matches that of an existing calculated column, Amazon QuickSight preserves the existing calculated column.

- ColumnName: - type: string - maxLength: 128 - minLength: 1 - description:

Column name.

Expression: type: string maxLength: 4096 @@ -8685,9 +8947,13 @@ components: properties: ColumnName: type: string - maxLength: 128 + maxLength: 127 minLength: 1 description:

Column name.

+ NewColumnType: + $ref: '#/components/schemas/ColumnDataType' + SubType: + $ref: '#/components/schemas/ColumnDataSubType' Format: type: string maxLength: 32 @@ -8695,14 +8961,15 @@ components: description: |-

When casting a column from string to datetime type, you can supply a string in a format supported by Amazon QuickSight to denote the source data format.

- NewColumnType: - $ref: '#/components/schemas/ColumnDataType' - SubType: - $ref: '#/components/schemas/ColumnSubDataType' required: - ColumnName - NewColumnType additionalProperties: false + ColumnDataSubType: + type: string + enum: + - FLOAT + - FIXED ColumnDataType: type: string enum: @@ -8710,11 +8977,6 @@ components: - INTEGER - DECIMAL - DATETIME - ColumnSubDataType: - type: string - enum: - - FIXED - - FLOAT ColumnDescription: type: object description:

Metadata that contains a description for a column.

@@ -8737,23 +8999,36 @@ components: additionalProperties: false ColumnLevelPermissionRule: type: object + description: |- +

A rule defined to grant access on one or more restricted columns. + Each dataset can have multiple rules. + To create a restricted column, you add it to one or more rules. + Each rule must contain at least one column and at least one user or group. + To be able to see a restricted column, a user or group needs to be added + to a rule for that column.

properties: - ColumnNames: + Principals: type: array items: type: string + maxItems: 100 minItems: 1 - Principals: + description:

An array of Amazon Resource Names (ARNs) for Amazon QuickSight users or groups.

+ ColumnNames: type: array items: type: string - maxItems: 100 minItems: 1 + description:

An array of column names.

additionalProperties: false ColumnTag: type: object description: |- -

A tag for a column in a TagColumnOperation structure. This is a +

A tag for a column in a + + TagColumnOperation + + structure. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

properties: @@ -8762,6 +9037,11 @@ components: ColumnDescription: $ref: '#/components/schemas/ColumnDescription' additionalProperties: false + ColumnTagName: + type: string + enum: + - COLUMN_GEOGRAPHIC_ROLE + - COLUMN_DESCRIPTION CreateColumnsOperation: type: object description: |- @@ -8785,9 +9065,14 @@ components: DataSourceArn: type: string description:

The Amazon Resource Name (ARN) of the data source.

+ Name: + type: string + maxLength: 128 + minLength: 1 + description:

A display name for the SQL query result.

SqlQuery: type: string - maxLength: 65536 + maxLength: 168000 minLength: 1 description:

The SQL query.

Columns: @@ -8797,11 +9082,6 @@ components: maxItems: 2048 minItems: 1 description:

The column schema from the SQL query result set.

- Name: - type: string - maxLength: 128 - minLength: 1 - description:

A display name for the SQL query result.

required: - Columns - DataSourceArn @@ -8813,45 +9093,62 @@ components: enum: - SPICE - DIRECT_QUERY + DataSetRefreshProperties: + type: object + description:

The refresh properties of a dataset.

+ properties: + RefreshConfiguration: + $ref: '#/components/schemas/RefreshConfiguration' + required: + - RefreshConfiguration + additionalProperties: false + DataSetUsageConfiguration: + type: object + description:

The usage configuration to apply to child datasets that reference this dataset as a source.

+ properties: + DisableUseAsDirectQuerySource: + type: boolean + default: false + description:

An option that controls whether a child dataset of a direct query can use this dataset as a source.

+ DisableUseAsImportedSource: + type: boolean + default: false + description:

An option that controls whether a child dataset that's stored in QuickSight can use this dataset as a source.

+ additionalProperties: false DatasetParameter: type: object - description:

A parameter created in the dataset that could be of any one data type such as string, integer, decimal or datetime.

+ description:

A dataset parameter.

properties: StringDatasetParameter: $ref: '#/components/schemas/StringDatasetParameter' DecimalDatasetParameter: $ref: '#/components/schemas/DecimalDatasetParameter' - IntegerDatasetParameter: - $ref: '#/components/schemas/IntegerDatasetParameter' - DateTimeDatasetParameter: - $ref: '#/components/schemas/DateTimeDatasetParameter' - additionalProperties: false - DatasetParameterId: - type: string - maxLength: 128 - minLength: 1 - pattern: ^[a-zA-Z0-9-]+$ - description:

Identifier of the parameter created in the dataset.

- DatasetParameterName: - type: string - maxLength: 2048 - minLength: 1 - pattern: ^[a-zA-Z0-9]+$ - description:

Name of the parameter created in the dataset.

+ IntegerDatasetParameter: + $ref: '#/components/schemas/IntegerDatasetParameter' + DateTimeDatasetParameter: + $ref: '#/components/schemas/DateTimeDatasetParameter' + additionalProperties: false DatasetParameterValueType: type: string enum: - MULTI_VALUED - SINGLE_VALUED - description:

Every parameter value could be either a single value or multi value which helps to validate before evaluation.

DateTimeDatasetParameter: type: object - description:

A parameter created in the dataset of date time data type.

+ description:

A date time parameter for a dataset.

properties: Id: - $ref: '#/components/schemas/DatasetParameterId' + type: string + maxLength: 128 + minLength: 1 + pattern: ^[a-zA-Z0-9-]+$ + description:

An identifier for the parameter that is created in the dataset.

Name: - $ref: '#/components/schemas/DatasetParameterName' + type: string + maxLength: 2048 + minLength: 1 + pattern: ^[a-zA-Z0-9]+$ + description:

The name of the date time parameter that is created in the dataset.

ValueType: $ref: '#/components/schemas/DatasetParameterValueType' TimeGranularity: @@ -8865,27 +9162,33 @@ components: additionalProperties: false DateTimeDatasetParameterDefaultValues: type: object - description:

List of default values defined for a given string date time parameter type. Currently only static values are supported.

+ description:

The default values of a date time parameter.

properties: StaticValues: - $ref: '#/components/schemas/DateTimeDatasetParameterValueList' - description:

List of static default values defined for a given string date time parameter type.

+ type: array + items: + type: string + description:

The default value for the date time parameter.

+ maxItems: 32 + minItems: 0 + description:

A list of static default values for a given date time parameter.

additionalProperties: false - DateTimeDatasetParameterValueList: - type: array - items: - type: string - description:

Default value defined for the dataset parameter of date time type.

- maxItems: 32 - minItems: 1 DecimalDatasetParameter: type: object - description:

A parameter created in the dataset of decimal data type.

+ description:

A decimal parameter for a dataset.

properties: Id: - $ref: '#/components/schemas/DatasetParameterId' + type: string + maxLength: 128 + minLength: 1 + pattern: ^[a-zA-Z0-9-]+$ + description:

An identifier for the decimal parameter created in the dataset.

Name: - $ref: '#/components/schemas/DatasetParameterName' + type: string + maxLength: 2048 + minLength: 1 + pattern: ^[a-zA-Z0-9]+$ + description:

The name of the decimal parameter that is created in the dataset.

ValueType: $ref: '#/components/schemas/DatasetParameterValueType' DefaultValues: @@ -8897,96 +9200,34 @@ components: additionalProperties: false DecimalDatasetParameterDefaultValues: type: object - description:

List of default values defined for a given decimal dataset parameter type. Currently only static values are supported.

- properties: - StaticValues: - $ref: '#/components/schemas/DecimalDatasetParameterValueList' - description:

List of static default values defined for a given decimal dataset parameter type.

- additionalProperties: false - DecimalDatasetParameterValueList: - type: array - items: - type: number - description:

Default value defined for the dataset parameter of decimal type.

- maxItems: 32 - minItems: 1 - IntegerDatasetParameter: - type: object - description:

A parameter created in the dataset of integer data type.

- properties: - Id: - $ref: '#/components/schemas/DatasetParameterId' - Name: - $ref: '#/components/schemas/DatasetParameterName' - ValueType: - $ref: '#/components/schemas/DatasetParameterValueType' - DefaultValues: - $ref: '#/components/schemas/IntegerDatasetParameterDefaultValues' - required: - - Id - - Name - - ValueType - additionalProperties: false - IntegerDatasetParameterDefaultValues: - type: object - description:

List of default values defined for a given integer dataset parameter type. Currently only static values are supported.

- properties: - StaticValues: - $ref: '#/components/schemas/IntegerDatasetParameterValueList' - description:

List of static default values defined for a given integer dataset parameter type.

- additionalProperties: false - IntegerDatasetParameterValueList: - type: array - items: - type: number - description:

Default value defined for the dataset parameter of integer type.

- maxItems: 32 - minItems: 1 - StringDatasetParameter: - type: object - description:

A parameter created in the dataset of string data type.

- properties: - Id: - $ref: '#/components/schemas/DatasetParameterId' - Name: - $ref: '#/components/schemas/DatasetParameterName' - ValueType: - $ref: '#/components/schemas/DatasetParameterValueType' - DefaultValues: - $ref: '#/components/schemas/StringDatasetParameterDefaultValues' - required: - - Id - - Name - - ValueType - additionalProperties: false - StringDatasetParameterDefaultValues: - type: object - description:

List of default values defined for a given string dataset parameter type. Currently only static values are supported.

+ description:

The default values of a decimal parameter.

properties: StaticValues: - $ref: '#/components/schemas/StringDatasetParameterValueList' - description:

List of static default values defined for a given string dataset parameter type.

+ type: array + items: + type: number + default: 0 + description:

The default value for the decimal parameter.

+ maxItems: 32 + minItems: 0 + description:

A list of static default values for a given decimal parameter.

additionalProperties: false - StringDatasetParameterValueList: - type: array - items: - type: string - description:

Default value defined for the dataset parameter of string type.

- maxItems: 32 - minItems: 1 FieldFolder: type: object + description:

A FieldFolder element is a folder that contains fields and nested subfolders.

properties: Description: type: string maxLength: 500 minLength: 0 + description:

The description for a field folder.

Columns: type: array items: type: string maxItems: 5000 minItems: 0 + description:

A folder has a list of columns. A column can only be in one folder.

additionalProperties: false FieldFolderMap: type: object @@ -9021,22 +9262,22 @@ components: type: object description:

Geospatial column group that denotes a hierarchy.

properties: + Name: + type: string + maxLength: 64 + minLength: 1 + description:

A display name for the hierarchy.

+ CountryCode: + $ref: '#/components/schemas/GeoSpatialCountryCode' Columns: type: array items: type: string - maxLength: 128 + maxLength: 127 minLength: 1 maxItems: 16 minItems: 1 description:

Columns in this hierarchy.

- CountryCode: - $ref: '#/components/schemas/GeoSpatialCountryCode' - Name: - type: string - maxLength: 64 - minLength: 1 - description:

A display name for the hierarchy.

required: - Columns - Name @@ -9056,19 +9297,31 @@ components: - LONGITUDE - LATITUDE - POLITICAL1 + - CENSUS_TRACT + - CENSUS_BLOCK_GROUP + - CENSUS_BLOCK + IncrementalRefresh: + type: object + description:

The incremental refresh configuration for a dataset.

+ properties: + LookbackWindow: + $ref: '#/components/schemas/LookbackWindow' + required: + - LookbackWindow + additionalProperties: false InputColumn: type: object description:

Metadata for a column that is used as the input of a transform operation.

properties: - Type: - $ref: '#/components/schemas/InputColumnDataType' - SubType: - $ref: '#/components/schemas/ColumnSubDataType' Name: type: string - maxLength: 128 + maxLength: 127 minLength: 1 description:

The name of this column in the underlying data source.

+ Type: + $ref: '#/components/schemas/InputColumnDataType' + SubType: + $ref: '#/components/schemas/ColumnDataSubType' required: - Name - Type @@ -9083,66 +9336,72 @@ components: - BIT - BOOLEAN - JSON - RefreshConfiguration: - type: object - description:

Refresh Configuration.

- properties: - IncrementalRefresh: - $ref: '#/components/schemas/IncrementalRefresh' - additionalProperties: false - IncrementalRefresh: + IntegerDatasetParameter: type: object - description:

Incremental Refresh

+ description:

An integer parameter for a dataset.

properties: - LookbackWindow: - $ref: '#/components/schemas/LookbackWindow' + Id: + type: string + maxLength: 128 + minLength: 1 + pattern: ^[a-zA-Z0-9-]+$ + description:

An identifier for the integer parameter created in the dataset.

+ Name: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^[a-zA-Z0-9]+$ + description:

The name of the integer parameter that is created in the dataset.

+ ValueType: + $ref: '#/components/schemas/DatasetParameterValueType' + DefaultValues: + $ref: '#/components/schemas/IntegerDatasetParameterDefaultValues' + required: + - Id + - Name + - ValueType additionalProperties: false - LookbackWindow: + IntegerDatasetParameterDefaultValues: type: object + description:

The default values of an integer parameter.

properties: - ColumnName: - type: string - description:

Column Name

- Size: - type: number - description:

Size

- minimum: 1 - SizeUnit: - $ref: '#/components/schemas/SizeUnit' + StaticValues: + type: array + items: + type: number + default: 0 + description:

The default value for the integer parameter.

+ maxItems: 32 + minItems: 0 + description:

A list of static default values for a given integer parameter.

additionalProperties: false - SizeUnit: - type: string - enum: - - HOUR - - DAY - - WEEK JoinInstruction: type: object - description:

Join instruction.

+ description:

The instructions associated with a join.

properties: - OnClause: - type: string - maxLength: 512 - minLength: 1 - description:

On Clause.

- Type: - $ref: '#/components/schemas/JoinType' - LeftJoinKeyProperties: - $ref: '#/components/schemas/JoinKeyProperties' LeftOperand: type: string maxLength: 64 minLength: 1 - pattern: '[0-9a-zA-Z-]*' - description:

Left operand.

+ pattern: ^[0-9a-zA-Z-]*$ + description:

The operand on the left side of a join.

RightOperand: type: string maxLength: 64 minLength: 1 - pattern: '[0-9a-zA-Z-]*' - description:

Right operand.

+ pattern: ^[0-9a-zA-Z-]*$ + description:

The operand on the right side of a join.

+ LeftJoinKeyProperties: + $ref: '#/components/schemas/JoinKeyProperties' RightJoinKeyProperties: $ref: '#/components/schemas/JoinKeyProperties' + Type: + $ref: '#/components/schemas/JoinType' + OnClause: + type: string + maxLength: 512 + minLength: 1 + description:

The join instructions provided in the ON clause of a join.

required: - LeftOperand - OnClause @@ -9151,9 +9410,13 @@ components: additionalProperties: false JoinKeyProperties: type: object + description:

Properties associated with the columns participating in a join.

properties: UniqueKey: type: boolean + description: |- +

A value that indicates that a row in a table is uniquely identified by the columns in + a join key. This is used by Amazon QuickSight to optimize query performance.

additionalProperties: false JoinType: type: string @@ -9181,7 +9444,7 @@ components: $ref: '#/components/schemas/TransformOperation' maxItems: 2048 minItems: 1 - description:

Transform operations that act on this logical table.

+ description:

Transform operations that act on this logical table. For this structure to be valid, only one of the attributes can be non-null.

Source: $ref: '#/components/schemas/LogicalTableSource' required: @@ -9193,7 +9456,7 @@ components: maxProperties: 64 minProperties: 1 x-patternProperties: - '[0-9a-zA-Z-]*': + ^[0-9a-zA-Z-]*$: $ref: '#/components/schemas/LogicalTable' additionalProperties: false LogicalTableSource: @@ -9202,62 +9465,121 @@ components:

Information about the source of a logical table. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

properties: + JoinInstruction: + $ref: '#/components/schemas/JoinInstruction' PhysicalTableId: type: string maxLength: 64 minLength: 1 - pattern: '[0-9a-zA-Z-]*' + pattern: ^[0-9a-zA-Z-]*$ description:

Physical table ID.

- JoinInstruction: - $ref: '#/components/schemas/JoinInstruction' DataSetArn: type: string - description:

The Amazon Resource Name (ARN) for the dataset.

+ description:

The Amazon Resource Number (ARN) of the parent dataset.

+ additionalProperties: false + LookbackWindow: + type: object + description:

The lookback window setup of an incremental refresh configuration.

+ properties: + ColumnName: + type: string + description:

The name of the lookback window column.

+ Size: + type: number + default: 0 + minimum: 1 + description:

The lookback window column size.

+ SizeUnit: + $ref: '#/components/schemas/LookbackWindowSizeUnit' + required: + - ColumnName + - Size + - SizeUnit additionalProperties: false + LookbackWindowSizeUnit: + type: string + enum: + - HOUR + - DAY + - WEEK NewDefaultValues: type: object + description:

The configuration that overrides the existing default values for a dataset parameter that is inherited from another dataset.

properties: StringStaticValues: - $ref: '#/components/schemas/StringDatasetParameterValueList' + type: array + items: + type: string + maxLength: 512 + minLength: 0 + description:

The default value for the string parameter.

+ maxItems: 32 + minItems: 0 + description:

A list of static default values for a given string parameter.

DecimalStaticValues: - $ref: '#/components/schemas/DecimalDatasetParameterValueList' + type: array + items: + type: number + default: 0 + description:

The default value for the decimal parameter.

+ maxItems: 32 + minItems: 0 + description:

A list of static default values for a given decimal parameter.

DateTimeStaticValues: - $ref: '#/components/schemas/DateTimeDatasetParameterValueList' + type: array + items: + type: string + description:

The default value for the date time parameter.

+ maxItems: 32 + minItems: 0 + description:

A list of static default values for a given date time parameter.

IntegerStaticValues: - $ref: '#/components/schemas/IntegerDatasetParameterValueList' + type: array + items: + type: number + default: 0 + description:

The default value for the integer parameter.

+ maxItems: 32 + minItems: 0 + description:

A list of static default values for a given integer parameter.

additionalProperties: false OutputColumn: type: object description:

Output column.

properties: - Type: - $ref: '#/components/schemas/ColumnDataType' - SubType: - $ref: '#/components/schemas/ColumnSubDataType' + Name: + type: string + maxLength: 127 + minLength: 1 + description:

The display name of the column..

Description: type: string maxLength: 500 minLength: 0 description:

A description for a column.

- Name: - type: string - maxLength: 128 - minLength: 1 - description:

A display name for the dataset.

+ Type: + $ref: '#/components/schemas/ColumnDataType' + SubType: + $ref: '#/components/schemas/ColumnDataSubType' additionalProperties: false OverrideDatasetParameterOperation: type: object - description:

A transform operation that overrides the dataset parameter values defined in another dataset.

+ description:

A transform operation that overrides the dataset parameter values that are defined in another dataset.

properties: ParameterName: - $ref: '#/components/schemas/DatasetParameterName' + type: string + maxLength: 2048 + minLength: 1 + pattern: ^[a-zA-Z0-9]+$ description:

The name of the parameter to be overridden with different values.

NewParameterName: - $ref: '#/components/schemas/DatasetParameterName' + type: string + maxLength: 2048 + minLength: 1 + pattern: ^[a-zA-Z0-9]+$ description:

The new name for the parameter.

NewDefaultValues: $ref: '#/components/schemas/NewDefaultValues' - description:

The new default values for the parameter.

required: - ParameterName additionalProperties: false @@ -9280,7 +9602,7 @@ components: maxProperties: 32 minProperties: 0 x-patternProperties: - '[0-9a-zA-Z-]*': + ^[0-9a-zA-Z-]*$: $ref: '#/components/schemas/PhysicalTable' additionalProperties: false ProjectOperation: @@ -9299,35 +9621,44 @@ components: required: - ProjectedColumns additionalProperties: false + RefreshConfiguration: + type: object + description:

The refresh configuration of a dataset.

+ properties: + IncrementalRefresh: + $ref: '#/components/schemas/IncrementalRefresh' + required: + - IncrementalRefresh + additionalProperties: false RelationalTable: type: object description:

A physical table type for relational data sources.

properties: DataSourceArn: type: string - description:

The Amazon Resource Name (ARN) for the data source.

- InputColumns: - type: array - items: - $ref: '#/components/schemas/InputColumn' - maxItems: 2048 - minItems: 1 - description:

The column schema of the table.

- Schema: - type: string - maxLength: 64 - minLength: 0 - description:

The schema name. This name applies to certain relational database engines.

+ description:

The Amazon Resource Name (ARN) for the data source.

Catalog: type: string + maxLength: 256 + minLength: 0 description:

The catalog associated with a table.

+ Schema: + type: string maxLength: 256 minLength: 0 + description:

The schema name. This name applies to certain relational database engines.

Name: type: string - maxLength: 64 + maxLength: 256 minLength: 1 description:

The name of the relational table.

+ InputColumns: + type: array + items: + $ref: '#/components/schemas/InputColumn' + maxItems: 2048 + minItems: 1 + description:

The column schema of the table.

required: - DataSourceArn - InputColumns @@ -9337,33 +9668,39 @@ components: type: object description:

A transform operation that renames a column.

properties: - NewColumnName: - type: string - maxLength: 128 - minLength: 1 - description:

The new name for the column.

ColumnName: type: string - maxLength: 128 + maxLength: 127 minLength: 1 description:

The name of the column to be renamed.

+ NewColumnName: + type: string + maxLength: 127 + minLength: 1 + description:

The new name for the column.

required: - ColumnName - NewColumnName additionalProperties: false RowLevelPermissionDataSet: type: object - description:

The row-level security configuration for the dataset.

+ description: |- +

Information about a dataset that contains permissions for row-level security (RLS). + The permissions dataset maps fields to users or groups. For more information, see + Using Row-Level Security (RLS) to Restrict Access to a Dataset in the Amazon QuickSight User + Guide.

+

The option to deny permissions by setting PermissionPolicy to DENY_ACCESS is + not supported for new RLS datasets.

properties: - Arn: - type: string - description:

The Amazon Resource Name (ARN) of the permission dataset.

Namespace: type: string maxLength: 64 minLength: 0 pattern: ^[a-zA-Z0-9._-]*$ - description:

The namespace associated with the row-level permissions dataset.

+ description:

The namespace associated with the dataset that contains permissions for RLS.

+ Arn: + type: string + description:

The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.

PermissionPolicy: $ref: '#/components/schemas/RowLevelPermissionPolicy' FormatVersion: @@ -9374,19 +9711,19 @@ components: - Arn - PermissionPolicy additionalProperties: false - RowLevelPermissionPolicy: - type: string - enum: - - GRANT_ACCESS - - DENY_ACCESS RowLevelPermissionFormatVersion: type: string enum: - VERSION_1 - VERSION_2 + RowLevelPermissionPolicy: + type: string + enum: + - GRANT_ACCESS + - DENY_ACCESS RowLevelPermissionTagConfiguration: type: object - description:

The configuration of tags on a dataset to set row-level security.

+ description:

The configuration of tags on a dataset to set row-level security.

properties: Status: $ref: '#/components/schemas/Status' @@ -9400,78 +9737,121 @@ components: TagRuleConfigurations: type: array items: - $ref: '#/components/schemas/RowLevelPermissionTagRuleConfiguration' + type: array + items: + type: string + maxLength: 128 + minLength: 1 + maxItems: 50 + minItems: 1 maxItems: 50 minItems: 1 description:

A list of tag configuration rules to apply to a dataset. All tag configurations have the OR condition. Tags within each tile will be joined (AND). At least one rule in this structure must have all tag values assigned to it to apply Row-level security (RLS) to the dataset.

required: - TagRules additionalProperties: false - Status: - type: string - enum: - - ENABLED - - DISABLED RowLevelPermissionTagRule: type: object - description:

Permission for the resource.

+ description:

A set of rules associated with a tag.

properties: - ColumnName: - type: string - description:

The column name that a tag key is assigned to.

TagKey: type: string maxLength: 128 minLength: 1 description:

The unique key for a tag.

- MatchAllValue: + ColumnName: type: string - maxLength: 256 - minLength: 1 - description:

A string that you want to use to filter by all the values in a column in the dataset and don’t want to list the values one by one. For example, you can use an asterisk as your match all value.

+ description:

The column name that a tag key is assigned to.

TagMultiValueDelimiter: type: string maxLength: 10 + minLength: 0 description:

A string that you want to use to delimit the values when you pass the values at run time. For example, you can delimit the values with a comma.

+ MatchAllValue: + type: string + maxLength: 256 + minLength: 1 + description:

A string that you want to use to filter by all the values in a column in the dataset and don’t want to list the values one by one. For example, you can use an asterisk as your match all value.

required: - ColumnName - TagKey additionalProperties: false - RowLevelPermissionTagRuleConfiguration: - type: array - items: - type: string - maxLength: 128 - minLength: 1 - maxItems: 50 - minItems: 1 S3Source: type: object - description:

A physical table type for as S3 data source.

+ description:

A physical table type for an S3 data source.

properties: DataSourceArn: type: string - description:

The amazon Resource Name (ARN) for the data source.

+ description:

The Amazon Resource Name (ARN) for the data source.

+ UploadSettings: + $ref: '#/components/schemas/UploadSettings' InputColumns: type: array items: $ref: '#/components/schemas/InputColumn' maxItems: 2048 minItems: 1 - description:

A physical table type for as S3 data source.

- UploadSettings: - $ref: '#/components/schemas/UploadSettings' + description: |- +

A physical table type for an S3 data source.

+ +

For files that aren't JSON, only STRING data types are supported in input columns.

+ required: - DataSourceArn - InputColumns additionalProperties: false + Status: + type: string + enum: + - ENABLED + - DISABLED + StringDatasetParameter: + type: object + description:

A string parameter for a dataset.

+ properties: + Id: + type: string + maxLength: 128 + minLength: 1 + pattern: ^[a-zA-Z0-9-]+$ + description:

An identifier for the string parameter that is created in the dataset.

+ Name: + type: string + maxLength: 2048 + minLength: 1 + pattern: ^[a-zA-Z0-9]+$ + description:

The name of the string parameter that is created in the dataset.

+ ValueType: + $ref: '#/components/schemas/DatasetParameterValueType' + DefaultValues: + $ref: '#/components/schemas/StringDatasetParameterDefaultValues' + required: + - Id + - Name + - ValueType + additionalProperties: false + StringDatasetParameterDefaultValues: + type: object + description:

The default values of a string parameter.

+ properties: + StaticValues: + type: array + items: + type: string + maxLength: 512 + minLength: 0 + description:

The default value for the string parameter.

+ maxItems: 32 + minItems: 0 + description:

A list of static default values for a given string parameter.

+ additionalProperties: false TagColumnOperation: type: object description:

A transform operation that tags a column with additional information.

properties: ColumnName: type: string - maxLength: 128 + maxLength: 127 minLength: 1 description:

The column that this operation acts on.

Tags: @@ -9481,10 +9861,10 @@ components: maxItems: 16 minItems: 1 description: |- -

The dataset column tag, currently only used for geospatial type tagging. .

- -

This is not tags for the AWS tagging feature. .

- +

The dataset column tag, currently only used for geospatial type tagging.

+ +

This is not tags for the Amazon Web Services tagging feature.

+ required: - ColumnName - Tags @@ -9500,36 +9880,56 @@ components:

A data transformation on a logical table. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

properties: - TagColumnOperation: - $ref: '#/components/schemas/TagColumnOperation' + ProjectOperation: + $ref: '#/components/schemas/ProjectOperation' FilterOperation: $ref: '#/components/schemas/FilterOperation' - CastColumnTypeOperation: - $ref: '#/components/schemas/CastColumnTypeOperation' CreateColumnsOperation: $ref: '#/components/schemas/CreateColumnsOperation' RenameColumnOperation: $ref: '#/components/schemas/RenameColumnOperation' - ProjectOperation: - $ref: '#/components/schemas/ProjectOperation' + CastColumnTypeOperation: + $ref: '#/components/schemas/CastColumnTypeOperation' + TagColumnOperation: + $ref: '#/components/schemas/TagColumnOperation' + UntagColumnOperation: + $ref: '#/components/schemas/UntagColumnOperation' OverrideDatasetParameterOperation: $ref: '#/components/schemas/OverrideDatasetParameterOperation' additionalProperties: false + UntagColumnOperation: + type: object + description:

A transform operation that removes tags associated with a column.

+ properties: + ColumnName: + type: string + maxLength: 127 + minLength: 1 + description:

The column that this operation acts on.

+ TagNames: + type: array + items: + $ref: '#/components/schemas/ColumnTagName' + description:

The column tags to remove from this column.

+ required: + - ColumnName + - TagNames + additionalProperties: false UploadSettings: type: object description:

Information about the format for a source file or files.

properties: - ContainsHeader: - type: boolean - description:

Whether the file has a header row, or the files each have a header row.

- TextQualifier: - $ref: '#/components/schemas/TextQualifier' Format: $ref: '#/components/schemas/FileFormat' StartFromRow: type: number minimum: 1 description:

A row number to start reading data from.

+ ContainsHeader: + type: boolean + description:

Whether the file has a header row, or the files each have a header row.

+ TextQualifier: + $ref: '#/components/schemas/TextQualifier' Delimiter: type: string maxLength: 1 @@ -9555,22 +9955,6 @@ components: maximum: 36 default: 36 additionalProperties: false - DataSetUsageConfiguration: - type: object - description:

The dataset usage configuration for the dataset.

- properties: - DisableUseAsDirectQuerySource: - type: boolean - DisableUseAsImportedSource: - type: boolean - additionalProperties: false - DataSetRefreshProperties: - type: object - description:

The dataset refresh properties for the dataset.

- properties: - RefreshConfiguration: - $ref: '#/components/schemas/RefreshConfiguration' - additionalProperties: false DataSet: type: object properties: @@ -9588,14 +9972,19 @@ components: $ref: '#/components/schemas/ColumnGroup' maxItems: 8 minItems: 1 - description:

Groupings of columns that work together in certain QuickSight features. Currently, only geospatial hierarchy is supported.

+ description:

Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.

ColumnLevelPermissionRules: type: array items: $ref: '#/components/schemas/ColumnLevelPermissionRule' minItems: 1 + description: |- +

A set of one or more definitions of a + ColumnLevelPermissionRule + .

ConsumedSpiceCapacityInBytes: type: number + default: 0 description: |-

The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't imported into SPICE.

@@ -9605,13 +9994,17 @@ components: format: string DataSetId: type: string + DataSetRefreshProperties: + $ref: '#/components/schemas/DataSetRefreshProperties' + DataSetUsageConfiguration: + $ref: '#/components/schemas/DataSetUsageConfiguration' DatasetParameters: type: array items: $ref: '#/components/schemas/DatasetParameter' maxItems: 32 - minItems: 1 - description:

The parameters declared in the dataset.

+ minItems: 0 + description:

The parameter declarations of the dataset.

FieldFolders: $ref: '#/components/schemas/FieldFolderMap' ImportMode: @@ -9656,10 +10049,6 @@ components: description:

Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.

IngestionWaitPolicy: $ref: '#/components/schemas/IngestionWaitPolicy' - DataSetUsageConfiguration: - $ref: '#/components/schemas/DataSetUsageConfiguration' - DataSetRefreshProperties: - $ref: '#/components/schemas/DataSetRefreshProperties' x-stackql-resource-name: data_set description: Definition of the AWS::QuickSight::DataSet Resource Type. x-type-name: AWS::QuickSight::DataSet @@ -9678,6 +10067,12 @@ components: - CreatedTime - LastUpdatedTime - OutputColumns + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags x-required-permissions: create: - quicksight:DescribeDataSet @@ -9724,29 +10119,31 @@ components: - quicksight:ListDataSets AmazonElasticsearchParameters: type: object - description:

Amazon Elasticsearch Service parameters.

+ description:

The parameters for OpenSearch.

properties: Domain: type: string maxLength: 64 minLength: 1 - description:

The Amazon Elasticsearch Service domain.

+ description:

The OpenSearch domain.

required: - Domain + additionalProperties: false AmazonOpenSearchParameters: type: object - description:

Amazon OpenSearch Service parameters.

+ description:

The parameters for OpenSearch.

properties: Domain: type: string maxLength: 64 minLength: 1 - description:

The Amazon OpenSearch Service domain.

+ description:

The OpenSearch domain.

required: - Domain + additionalProperties: false AthenaParameters: type: object - description:

Amazon Athena parameters.

+ description:

Parameters for Amazon Athena.

properties: WorkGroup: type: string @@ -9758,12 +10155,19 @@ components: maxLength: 2048 minLength: 20 description:

Use the RoleArn structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.

+ additionalProperties: false AuroraParameters: type: object - description:

Amazon Aurora parameters.

+ description:

Parameters for Amazon Aurora.

properties: + Host: + type: string + maxLength: 256 + minLength: 1 + description:

Host.

Port: type: number + default: 0 maximum: 65535 minimum: 1 description:

Port.

@@ -9772,41 +10176,39 @@ components: maxLength: 128 minLength: 1 description:

Database.

- Host: - type: string - maxLength: 256 - minLength: 1 - description:

Host.

required: - Database - Host - Port + additionalProperties: false AuroraPostgreSqlParameters: type: object - description:

Amazon Aurora with PostgreSQL compatibility parameters.

+ description:

Parameters for Amazon Aurora PostgreSQL-Compatible Edition.

properties: + Host: + type: string + maxLength: 256 + minLength: 1 + description:

The Amazon Aurora PostgreSQL-Compatible host to connect to.

Port: type: number + default: 0 maximum: 65535 minimum: 1 - description:

Port.

+ description:

The port that Amazon Aurora PostgreSQL is listening on.

Database: type: string maxLength: 128 minLength: 1 - description:

Database.

- Host: - type: string - maxLength: 256 - minLength: 1 - description:

Host.

+ description:

The Amazon Aurora PostgreSQL database to connect to.

required: - Database - Host - Port + additionalProperties: false AwsIotAnalyticsParameters: type: object - description:

AWS IoT Analytics parameters.

+ description:

The parameters for IoT Analytics.

properties: DataSetName: type: string @@ -9815,10 +10217,21 @@ components: description:

Dataset name.

required: - DataSetName + additionalProperties: false CredentialPair: type: object description:

The combination of user name and password that are used as credentials.

properties: + Username: + type: string + maxLength: 64 + minLength: 1 + description:

User name.

+ Password: + type: string + maxLength: 1024 + minLength: 1 + description:

Password.

AlternateDataSourceParameters: type: array items: @@ -9832,67 +10245,36 @@ components: the DataSourceParameters structure that's in the request with the structures in the AlternateDataSourceParameters allow list. If the structures are an exact match, the request is allowed to use the new data source with - the existing credentials. If the AlternateDataSourceParameters list is - null, the DataSourceParameters originally used with these - Credentials is automatically allowed.

- Username: - type: string - maxLength: 64 - minLength: 1 - description:

User name.

- Password: - type: string - maxLength: 1024 - minLength: 1 - description:

Password.

- required: - - Password - - Username - DatabricksParameters: - type: object - description:

Databricks parameters.

- properties: - Host: - type: string - maxLength: 256 - minLength: 1 - description:

Host.

- Port: - type: number - maximum: 65535 - minimum: 1 - description:

Port.

- SqlEndpointPath: - type: string - maxLength: 4096 - minLength: 1 - description:

The HTTP Path of the Databricks data source.

+ the existing credentials. If the AlternateDataSourceParameters list is + null, the DataSourceParameters originally used with these + Credentials is automatically allowed.

required: - - Host - - Port - - SqlEndpointPath + - Password + - Username + additionalProperties: false DataSourceCredentials: type: object description: |-

Data source credentials. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

properties: + CredentialPair: + $ref: '#/components/schemas/CredentialPair' CopySourceArn: type: string - pattern: ^arn:[-a-z0-9]*:quicksight:[-a-z0-9]*:[0-9]{12}:datasource/.+ + pattern: ^arn:[-a-z0-9]*:quicksight:[-a-z0-9]*:[0-9]{12}:datasource/.+$ description: |-

The Amazon Resource Name (ARN) of a data source that has the credential pair that you want to use. When CopySourceArn is not null, the credential pair from the data source in the ARN is used as the credentials for the DataSourceCredentials structure.

- CredentialPair: - $ref: '#/components/schemas/CredentialPair' SecretArn: type: string - pattern: ^arn:[-a-z0-9]*:secretsmanager:[-a-z0-9]*:[0-9]{12}:secret:.+ maxLength: 2048 minLength: 1 + pattern: ^arn:[-a-z0-9]*:secretsmanager:[-a-z0-9]*:[0-9]{12}:secret:.+$ description:

The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.

+ additionalProperties: false DataSourceErrorInfo: type: object description:

Error information for the data source creation or update.

@@ -9902,6 +10284,7 @@ components: Message: type: string description:

Error message.

+ additionalProperties: false DataSourceErrorInfoType: type: string enum: @@ -9920,46 +10303,47 @@ components: This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

properties: - AuroraPostgreSqlParameters: - $ref: '#/components/schemas/AuroraPostgreSqlParameters' - TeradataParameters: - $ref: '#/components/schemas/TeradataParameters' - RdsParameters: - $ref: '#/components/schemas/RdsParameters' + AmazonElasticsearchParameters: + $ref: '#/components/schemas/AmazonElasticsearchParameters' AthenaParameters: $ref: '#/components/schemas/AthenaParameters' - SparkParameters: - $ref: '#/components/schemas/SparkParameters' + AuroraParameters: + $ref: '#/components/schemas/AuroraParameters' + AuroraPostgreSqlParameters: + $ref: '#/components/schemas/AuroraPostgreSqlParameters' MariaDbParameters: $ref: '#/components/schemas/MariaDbParameters' + MySqlParameters: + $ref: '#/components/schemas/MySqlParameters' OracleParameters: $ref: '#/components/schemas/OracleParameters' + PostgreSqlParameters: + $ref: '#/components/schemas/PostgreSqlParameters' PrestoParameters: $ref: '#/components/schemas/PrestoParameters' + RdsParameters: + $ref: '#/components/schemas/RdsParameters' RedshiftParameters: $ref: '#/components/schemas/RedshiftParameters' - MySqlParameters: - $ref: '#/components/schemas/MySqlParameters' - SqlServerParameters: - $ref: '#/components/schemas/SqlServerParameters' + S3Parameters: + $ref: '#/components/schemas/S3Parameters' SnowflakeParameters: $ref: '#/components/schemas/SnowflakeParameters' - AmazonElasticsearchParameters: - $ref: '#/components/schemas/AmazonElasticsearchParameters' + SparkParameters: + $ref: '#/components/schemas/SparkParameters' + SqlServerParameters: + $ref: '#/components/schemas/SqlServerParameters' + TeradataParameters: + $ref: '#/components/schemas/TeradataParameters' AmazonOpenSearchParameters: $ref: '#/components/schemas/AmazonOpenSearchParameters' - PostgreSqlParameters: - $ref: '#/components/schemas/PostgreSqlParameters' - AuroraParameters: - $ref: '#/components/schemas/AuroraParameters' - S3Parameters: - $ref: '#/components/schemas/S3Parameters' DatabricksParameters: $ref: '#/components/schemas/DatabricksParameters' StarburstParameters: $ref: '#/components/schemas/StarburstParameters' TrinoParameters: $ref: '#/components/schemas/TrinoParameters' + additionalProperties: false DataSourceType: type: string enum: @@ -9971,6 +10355,13 @@ components: - AURORA_POSTGRESQL - AWS_IOT_ANALYTICS - DATABRICKS + - DENODO + - DREMIO + - DYNAMODB + - SAPHANA + - DB2_AS400 + - EXASOL + - FILE - GITHUB - JIRA - MARIADB @@ -9986,10 +10377,50 @@ components: - SPARK - SQLSERVER - TERADATA - - TWITTER - TIMESTREAM - - STARBURST + - TWITTER + - BIGQUERY + - GOOGLE_ANALYTICS - TRINO + - STARBURST + - MONGO + - MONGO_ATLAS + - DOCUMENTDB + - APPFLOW + DatabricksParameters: + type: object + description:

The parameters that are required to connect to a Databricks data source.

+ properties: + Host: + type: string + maxLength: 256 + minLength: 1 + description:

The host name of the Databricks data source.

+ Port: + type: number + default: 0 + maximum: 65535 + minimum: 1 + description:

The port for the Databricks data source.

+ SqlEndpointPath: + type: string + maxLength: 4096 + minLength: 1 + description:

The HTTP path of the Databricks data source.

+ required: + - Host + - Port + - SqlEndpointPath + additionalProperties: false + IdentityCenterConfiguration: + type: object + description:

The parameters for an IAM Identity Center configuration.

+ properties: + EnableIdentityPropagation: + type: boolean + default: null + description:

A Boolean option that controls whether Trusted Identity Propagation should be used.

+ additionalProperties: false ManifestFileLocation: type: object description:

Amazon S3 manifest file location.

@@ -10007,12 +10438,19 @@ components: required: - Bucket - Key + additionalProperties: false MariaDbParameters: type: object - description:

MariaDB parameters.

+ description:

The parameters for MariaDB.

properties: + Host: + type: string + maxLength: 256 + minLength: 1 + description:

Host.

Port: type: number + default: 0 maximum: 65535 minimum: 1 description:

Port.

@@ -10021,21 +10459,23 @@ components: maxLength: 128 minLength: 1 description:

Database.

- Host: - type: string - maxLength: 256 - minLength: 1 - description:

Host.

required: - Database - Host - Port + additionalProperties: false MySqlParameters: type: object - description:

MySQL parameters.

+ description:

The parameters for MySQL.

properties: + Host: + type: string + maxLength: 256 + minLength: 1 + description:

Host.

Port: type: number + default: 0 maximum: 65535 minimum: 1 description:

Port.

@@ -10044,40 +10484,48 @@ components: maxLength: 128 minLength: 1 description:

Database.

- Host: - type: string - maxLength: 256 - minLength: 1 - description:

Host.

required: - Database - Host - Port + additionalProperties: false OracleParameters: type: object + description:

The parameters for Oracle.

properties: + Host: + type: string + maxLength: 256 + minLength: 1 + description:

An Oracle host.

Port: type: number + default: 0 maximum: 65535 minimum: 1 + description:

The port.

Database: type: string maxLength: 128 minLength: 1 - Host: - type: string - maxLength: 256 - minLength: 1 + description:

The database.

required: - Database - Host - Port + additionalProperties: false PostgreSqlParameters: type: object - description:

PostgreSQL parameters.

+ description:

The parameters for PostgreSQL.

properties: + Host: + type: string + maxLength: 256 + minLength: 1 + description:

Host.

Port: type: number + default: 0 maximum: 65535 minimum: 1 description:

Port.

@@ -10086,29 +10534,26 @@ components: maxLength: 128 minLength: 1 description:

Database.

- Host: - type: string - maxLength: 256 - minLength: 1 - description:

Host.

required: - Database - Host - Port + additionalProperties: false PrestoParameters: type: object - description:

Presto parameters.

+ description:

The parameters for Presto.

properties: - Port: - type: number - maximum: 65535 - minimum: 1 - description:

Port.

Host: type: string maxLength: 256 minLength: 1 description:

Host.

+ Port: + type: number + default: 0 + maximum: 65535 + minimum: 1 + description:

Port.

Catalog: type: string maxLength: 128 @@ -10118,9 +10563,10 @@ components: - Catalog - Host - Port + additionalProperties: false RdsParameters: type: object - description:

Amazon RDS parameters.

+ description:

The parameters for Amazon RDS.

properties: InstanceId: type: string @@ -10135,22 +10581,54 @@ components: required: - Database - InstanceId - RedshiftParameters: + additionalProperties: false + RedshiftIAMParameters: type: object description: |- -

Amazon Redshift parameters. The ClusterId field can be blank if - Host and Port are both set. The Host and - Port fields can be blank if the ClusterId field is set.

+

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

properties: - ClusterId: + RoleArn: + type: string + maxLength: 2048 + minLength: 20 + description:

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.

+ DatabaseUser: type: string maxLength: 64 minLength: 1 - description: |- -

Cluster ID. This field can be blank if the Host and Port are - provided.

+ description:

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.

+ DatabaseGroups: + type: array + items: + type: string + maxLength: 64 + minLength: 1 + maxItems: 50 + minItems: 1 + description:

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.

+ AutoCreateDatabaseUser: + type: boolean + default: false + description:

Automatically creates a database user. If your database doesn't have a DatabaseUser, set this parameter to True. If there is no DatabaseUser, Amazon QuickSight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.

+ required: + - RoleArn + additionalProperties: false + RedshiftParameters: + type: object + description: |- +

The parameters for Amazon Redshift. The ClusterId field can be blank if + Host and Port are both set. The Host and Port fields can be blank if the ClusterId field is set.

+ properties: + Host: + type: string + maxLength: 256 + minLength: 1 + description:

Host. This field can be blank if ClusterId is provided.

Port: type: number + default: 0 maximum: 65535 minimum: 0 description:

Port. This field can be blank if the ClusterId is provided.

@@ -10159,16 +10637,23 @@ components: maxLength: 128 minLength: 1 description:

Database.

- Host: + ClusterId: type: string - maxLength: 256 + maxLength: 64 minLength: 1 - description:

Host. This field can be blank if ClusterId is provided.

+ description: |- +

Cluster ID. This field can be blank if the Host and Port are + provided.

+ IAMParameters: + $ref: '#/components/schemas/RedshiftIAMParameters' + IdentityCenterConfiguration: + $ref: '#/components/schemas/IdentityCenterConfiguration' required: - Database + additionalProperties: false S3Parameters: type: object - description:

S3 parameters.

+ description:

The parameters for S3.

properties: ManifestFileLocation: $ref: '#/components/schemas/ManifestFileLocation' @@ -10179,32 +10664,53 @@ components: description:

Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.

required: - ManifestFileLocation + additionalProperties: false SnowflakeParameters: type: object - description:

Snowflake parameters.

+ description:

The parameters for Snowflake.

properties: - Warehouse: + Host: type: string - maxLength: 128 - minLength: 0 - description:

Warehouse.

+ maxLength: 256 + minLength: 1 + description:

Host.

Database: type: string maxLength: 128 minLength: 1 description:

Database.

+ Warehouse: + type: string + maxLength: 128 + minLength: 0 + description:

Warehouse.

+ required: + - Database + - Host + - Warehouse + additionalProperties: false + SparkParameters: + type: object + description:

The parameters for Spark.

+ properties: Host: type: string maxLength: 256 minLength: 1 description:

Host.

+ Port: + type: number + default: 0 + maximum: 65535 + minimum: 1 + description:

Port.

required: - - Database - Host - - Warehouse - StarburstParameters: + - Port + additionalProperties: false + SqlServerParameters: type: object - description:

Starburst parameters.

+ description:

The parameters for SQL Server.

properties: Host: type: string @@ -10213,71 +10719,75 @@ components: description:

Host.

Port: type: number + default: 0 maximum: 65535 minimum: 1 description:

Port.

- Catalog: + Database: type: string maxLength: 128 - minLength: 0 - description:

Catalog.

- ProductType: - $ref: '#/components/schemas/StarburstProductType' + minLength: 1 + description:

Database.

required: + - Database - Host - Port - - Catalog - StarburstProductType: - type: string - enum: - - GALAXY - - ENTERPRISE - TrinoParameters: + additionalProperties: false + SslProperties: + type: object + description: |- +

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your + underlying data source.

+ properties: + DisableSsl: + type: boolean + default: false + description:

A Boolean option to control whether SSL should be disabled.

+ additionalProperties: false + StarburstParameters: type: object - description:

Trino parameters.

+ description:

The parameters that are required to connect to a Starburst data source.

properties: Host: type: string maxLength: 256 minLength: 1 - description:

Host.

+ description:

The host name of the Starburst data source.

Port: type: number + default: 0 maximum: 65535 minimum: 1 - description:

Port.

+ description:

The port for the Starburst data source.

Catalog: type: string maxLength: 128 minLength: 0 - description:

Catalog.

+ description:

The catalog name for the Starburst data source.

+ ProductType: + $ref: '#/components/schemas/StarburstProductType' required: + - Catalog - Host - Port - - Catalog - SparkParameters: + additionalProperties: false + StarburstProductType: + type: string + enum: + - GALAXY + - ENTERPRISE + TeradataParameters: type: object - description:

Spark parameters.

+ description:

The parameters for Teradata.

properties: - Port: - type: number - maximum: 65535 - minimum: 1 - description:

Port.

Host: type: string maxLength: 256 minLength: 1 description:

Host.

- required: - - Host - - Port - SqlServerParameters: - type: object - description:

SQL Server parameters.

- properties: Port: type: number + default: 0 maximum: 65535 minimum: 1 description:

Port.

@@ -10286,47 +10796,36 @@ components: maxLength: 128 minLength: 1 description:

Database.

- Host: - type: string - maxLength: 256 - minLength: 1 - description:

Host.

required: - Database - Host - Port - SslProperties: - type: object - description: |- -

Secure Socket Layer (SSL) properties that apply when QuickSight connects to your - underlying data source.

- properties: - DisableSsl: - type: boolean - description:

A Boolean option to control whether SSL should be disabled.

- TeradataParameters: + additionalProperties: false + TrinoParameters: type: object - description:

Teradata parameters.

+ description:

The parameters that are required to connect to a Trino data source.

properties: + Host: + type: string + maxLength: 256 + minLength: 1 + description:

The host name of the Trino data source.

Port: type: number + default: 0 maximum: 65535 minimum: 1 - description:

Port.

- Database: + description:

The port for the Trino data source.

+ Catalog: type: string maxLength: 128 - minLength: 1 - description:

Database.

- Host: - type: string - maxLength: 256 - minLength: 1 - description:

Host.

+ minLength: 0 + description:

The catalog name for the Trino data source.

required: - - Database + - Catalog - Host - Port + additionalProperties: false VpcConnectionProperties: type: object description:

VPC connection properties.

@@ -10336,6 +10835,7 @@ components: description:

The Amazon Resource Name (ARN) for the VPC connection.

required: - VpcConnectionArn + additionalProperties: false DataSource: type: object properties: @@ -10383,14 +10883,12 @@ components: type: string maxLength: 128 minLength: 1 - description:

A display name for the data source.

Permissions: type: array items: $ref: '#/components/schemas/ResourcePermission' maxItems: 64 minItems: 1 - description:

A list of resource permissions on the data source.

SslProperties: $ref: '#/components/schemas/SslProperties' Status: @@ -10401,11 +10899,13 @@ components: $ref: '#/components/schemas/Tag' maxItems: 200 minItems: 1 - description:

Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.

Type: $ref: '#/components/schemas/DataSourceType' VpcConnectionProperties: $ref: '#/components/schemas/VpcConnectionProperties' + required: + - Name + - Type x-stackql-resource-name: data_source description: Definition of the AWS::QuickSight::DataSource Resource Type. x-type-name: AWS::QuickSight::DataSource @@ -10423,16 +10923,19 @@ components: - CreatedTime - LastUpdatedTime - Status + x-required-properties: + - Name + - Type x-required-permissions: - create: - - quicksight:CreateDataSource + read: - quicksight:DescribeDataSource - quicksight:DescribeDataSourcePermissions - - quicksight:TagResource - quicksight:ListTagsForResource - read: + create: + - quicksight:CreateDataSource - quicksight:DescribeDataSource - quicksight:DescribeDataSourcePermissions + - quicksight:TagResource - quicksight:ListTagsForResource update: - quicksight:DescribeDataSource @@ -10565,242 +11068,284 @@ components: - quicksight:ListRefreshSchedules read: - quicksight:DescribeRefreshSchedule - ColumnGroupColumnSchema: - type: object - properties: - Name: - type: string + TemplateVersionDefinition: additionalProperties: false - ColumnGroupSchema: type: object properties: - Name: - type: string - ColumnGroupColumnSchemaList: + Options: + $ref: '#/components/schemas/AssetOptions' + FilterGroups: + minItems: 0 + maxItems: 2000 type: array items: - $ref: '#/components/schemas/ColumnGroupColumnSchema' + $ref: '#/components/schemas/FilterGroup' + CalculatedFields: + minItems: 0 maxItems: 500 + type: array + items: + $ref: '#/components/schemas/CalculatedField' + DataSetConfigurations: minItems: 0 - additionalProperties: false + maxItems: 30 + type: array + items: + $ref: '#/components/schemas/DataSetConfiguration' + ColumnConfigurations: + minItems: 0 + maxItems: 2000 + type: array + items: + $ref: '#/components/schemas/ColumnConfiguration' + AnalysisDefaults: + $ref: '#/components/schemas/AnalysisDefaults' + Sheets: + minItems: 0 + maxItems: 20 + type: array + items: + $ref: '#/components/schemas/SheetDefinition' + ParameterDeclarations: + minItems: 0 + maxItems: 200 + type: array + items: + $ref: '#/components/schemas/ParameterDeclaration' + required: + - DataSetConfigurations ColumnSchema: + description:

The column schema.

+ additionalProperties: false type: object properties: - Name: - type: string DataType: + description:

The data type of the column schema.

type: string GeographicRole: + description:

The geographic role of the column schema.

+ type: string + Name: + description:

The name of the column schema.

type: string + ColumnGroupColumnSchema: + description:

A structure describing the name, data type, and geographic role of the columns.

additionalProperties: false - DataSetConfiguration: type: object properties: - Placeholder: + Name: + description:

The name of the column group's column schema.

type: string - DataSetSchema: - $ref: '#/components/schemas/DataSetSchema' - ColumnGroupSchemaList: - type: array - items: - $ref: '#/components/schemas/ColumnGroupSchema' - maxItems: 500 - minItems: 0 + TemplateVersion: + description:

A version of a template.

additionalProperties: false - DataSetSchema: type: object properties: - ColumnSchemaList: + Status: + $ref: '#/components/schemas/ResourceStatus' + Errors: + minItems: 1 + description:

Errors associated with this template version.

type: array items: - $ref: '#/components/schemas/ColumnSchema' - maxItems: 500 - minItems: 0 - additionalProperties: false - TemplateError: - type: object - properties: - Type: - $ref: '#/components/schemas/TemplateErrorType' - Message: + $ref: '#/components/schemas/TemplateError' + CreatedTime: + format: date-time + description:

The time that this template version was created.

type: string - pattern: .*\S.* - ViolatedEntities: + Description: + minLength: 1 + description:

The description of the template.

+ type: string + maxLength: 512 + ThemeArn: + description:

The ARN of the theme associated with this version of the template.

+ type: string + DataSetConfigurations: + minItems: 0 + maxItems: 30 + description: |- +

Schema of the dataset identified by the placeholder. Any dashboard created from this + template should be bound to new datasets matching the same schema described through this + API operation.

type: array items: - $ref: '#/components/schemas/Entity' - maxItems: 200 - minItems: 0 - additionalProperties: false - TemplateErrorType: - type: string - enum: - - SOURCE_NOT_FOUND - - DATA_SET_NOT_FOUND - - INTERNAL_FAILURE - - ACCESS_DENIED - TemplateSourceAnalysis: - type: object - properties: - Arn: + $ref: '#/components/schemas/DataSetConfiguration' + SourceEntityArn: + description: |- +

The Amazon Resource Name (ARN) of an analysis or template that was used to create this + template.

type: string - DataSetReferences: + VersionNumber: + description:

The version number of the template version.

+ type: number + minimum: 1 + Sheets: + minItems: 0 + maxItems: 20 + description:

A list of the associated sheets with the unique identifier and name of each sheet.

type: array items: - $ref: '#/components/schemas/DataSetReference' - minItems: 1 - required: - - Arn - - DataSetReferences + $ref: '#/components/schemas/Sheet' + DataSetSchema: + description:

Dataset schema.

additionalProperties: false - TemplateSourceEntity: type: object properties: - SourceAnalysis: - $ref: '#/components/schemas/TemplateSourceAnalysis' - SourceTemplate: - $ref: '#/components/schemas/TemplateSourceTemplate' - additionalProperties: false + ColumnSchemaList: + minItems: 0 + maxItems: 500 + description:

A structure containing the list of column schemas.

+ type: array + items: + $ref: '#/components/schemas/ColumnSchema' TemplateSourceTemplate: + description:

The source template of the template.

+ additionalProperties: false type: object properties: Arn: + description:

The Amazon Resource Name (ARN) of the resource.

type: string required: - Arn + ColumnGroupSchema: + description:

The column group schema.

additionalProperties: false - TemplateVersion: type: object properties: - CreatedTime: - type: string - format: date-time - Errors: - type: array - items: - $ref: '#/components/schemas/TemplateError' - minItems: 1 - VersionNumber: - type: number - minimum: 1 - Status: - $ref: '#/components/schemas/ResourceStatus' - DataSetConfigurations: + ColumnGroupColumnSchemaList: + minItems: 0 + maxItems: 500 + description:

A structure containing the list of schemas for column group columns.

type: array items: - $ref: '#/components/schemas/DataSetConfiguration' - maxItems: 30 - minItems: 0 - Description: - type: string - maxLength: 512 - minLength: 1 - SourceEntityArn: + $ref: '#/components/schemas/ColumnGroupColumnSchema' + Name: + description:

The name of the column group schema.

type: string - ThemeArn: + TemplateErrorType: + type: string + enum: + - SOURCE_NOT_FOUND + - DATA_SET_NOT_FOUND + - INTERNAL_FAILURE + - ACCESS_DENIED + TemplateError: + description:

List of errors that occurred when the template version creation failed.

+ additionalProperties: false + type: object + properties: + Type: + $ref: '#/components/schemas/TemplateErrorType' + Message: + pattern: \S + description:

Description of the error type.

type: string - Sheets: + ViolatedEntities: + minItems: 0 + maxItems: 200 + description:

An error path that shows which entities caused the template error.

type: array items: - $ref: '#/components/schemas/Sheet' - maxItems: 20 - minItems: 0 + $ref: '#/components/schemas/Entity' + TemplateSourceAnalysis: + description:

The source analysis of the template.

additionalProperties: false - TemplateVersionDefinition: type: object properties: - DataSetConfigurations: - type: array - items: - $ref: '#/components/schemas/DataSetConfiguration' - maxItems: 30 - minItems: 0 - Sheets: + DataSetReferences: + minItems: 1 + description: |- +

A structure containing information about the dataset references used as placeholders + in the template.

type: array items: - $ref: '#/components/schemas/SheetDefinition' - maxItems: 20 + $ref: '#/components/schemas/DataSetReference' + Arn: + description:

The Amazon Resource Name (ARN) of the resource.

+ type: string + required: + - Arn + - DataSetReferences + DataSetConfiguration: + description:

Dataset configuration.

+ additionalProperties: false + type: object + properties: + Placeholder: + description:

Placeholder.

+ type: string + DataSetSchema: + $ref: '#/components/schemas/DataSetSchema' + ColumnGroupSchemaList: minItems: 0 - CalculatedFields: - type: array - items: - $ref: '#/components/schemas/CalculatedField' maxItems: 500 - minItems: 0 - ParameterDeclarations: - type: array - items: - $ref: '#/components/schemas/ParameterDeclaration' - maxItems: 200 - minItems: 0 - FilterGroups: - type: array - items: - $ref: '#/components/schemas/FilterGroup' - maxItems: 2000 - minItems: 0 - ColumnConfigurations: + description:

A structure containing the list of column group schemas.

type: array items: - $ref: '#/components/schemas/ColumnConfiguration' - maxItems: 200 - minItems: 0 - AnalysisDefaults: - $ref: '#/components/schemas/AnalysisDefaults' - Options: - $ref: '#/components/schemas/AssetOptions' - required: - - DataSetConfigurations + $ref: '#/components/schemas/ColumnGroupSchema' + TemplateSourceEntity: + description:

The source entity of the template.

additionalProperties: false + type: object + properties: + SourceAnalysis: + $ref: '#/components/schemas/TemplateSourceAnalysis' + SourceTemplate: + $ref: '#/components/schemas/TemplateSourceTemplate' Template: type: object properties: - Arn: - type: string - AwsAccountId: - type: string - maxLength: 12 - minLength: 12 - pattern: ^[0-9]{12}$ CreatedTime: - type: string format: date-time + description:

Time when this was created.

+ type: string + VersionDescription: + minLength: 1 + type: string + maxLength: 512 + SourceEntity: + $ref: '#/components/schemas/TemplateSourceEntity' Definition: $ref: '#/components/schemas/TemplateVersionDefinition' LastUpdatedTime: - type: string format: date-time + description:

Time when this was last updated.

+ type: string + ValidationStrategy: + $ref: '#/components/schemas/ValidationStrategy' Name: + minLength: 1 type: string maxLength: 2048 - minLength: 1 + Version: + $ref: '#/components/schemas/TemplateVersion' + AwsAccountId: + minLength: 12 + pattern: ^[0-9]{12}$ + type: string + maxLength: 12 Permissions: + minItems: 1 + maxItems: 64 type: array items: $ref: '#/components/schemas/ResourcePermission' - maxItems: 64 - minItems: 1 - SourceEntity: - $ref: '#/components/schemas/TemplateSourceEntity' + Arn: + description:

The Amazon Resource Name (ARN) of the template.

+ type: string Tags: + minItems: 1 + maxItems: 200 type: array items: $ref: '#/components/schemas/Tag' - maxItems: 200 - minItems: 1 TemplateId: - type: string - maxLength: 512 minLength: 1 - pattern: '[\w\-]+' - ValidationStrategy: - $ref: '#/components/schemas/ValidationStrategy' - Version: - $ref: '#/components/schemas/TemplateVersion' - VersionDescription: + pattern: ^[\w\-]+$ type: string maxLength: 512 - minLength: 1 required: - AwsAccountId - TemplateId @@ -10827,6 +11372,10 @@ components: - AwsAccountId - TemplateId x-required-permissions: + read: + - quicksight:DescribeTemplate + - quicksight:DescribeTemplatePermissions + - quicksight:ListTagsForResource create: - quicksight:DescribeTemplate - quicksight:DescribeTemplatePermissions @@ -10835,10 +11384,6 @@ components: - quicksight:TagResource - quicksight:UntagResource - quicksight:ListTagsForResource - read: - - quicksight:DescribeTemplate - - quicksight:DescribeTemplatePermissions - - quicksight:ListTagsForResource update: - quicksight:DescribeTemplate - quicksight:DescribeTemplatePermissions @@ -10848,20 +11393,26 @@ components: - quicksight:TagResource - quicksight:UntagResource - quicksight:ListTagsForResource + list: + - quicksight:ListTemplates delete: - quicksight:DescribeTemplate - quicksight:DeleteTemplate - list: - - quicksight:ListTemplates BorderStyle: type: object + description:

The display options for tile borders for visuals.

properties: Show: type: boolean default: null + description:

The option to enable display of borders for visuals.

additionalProperties: false DataColorPalette: type: object + description: |- +

The theme colors that are used for data colors in charts. The colors description is a + hexadecimal color code that consists of six alphanumerical characters, prefixed with + #, for example #37BFF5.

properties: Colors: type: array @@ -10870,6 +11421,7 @@ components: pattern: ^#[A-F0-9]{6}$ maxItems: 100 minItems: 0 + description:

The hexadecimal codes for the colors.

MinMaxGradient: type: array items: @@ -10877,9 +11429,13 @@ components: pattern: ^#[A-F0-9]{6}$ maxItems: 100 minItems: 0 + description:

The minimum and maximum hexadecimal codes that describe a color gradient.

EmptyFillColor: type: string pattern: ^#[A-F0-9]{6}$ + description: |- +

The hexadecimal code of a color that applies to charts where a lack of data is + highlighted.

additionalProperties: false Font: type: object @@ -10889,20 +11445,27 @@ components: additionalProperties: false GutterStyle: type: object + description:

The display options for gutter spacing between tiles on a sheet.

properties: Show: type: boolean default: null + description: |- +

This Boolean value controls whether to display a gutter space between sheet tiles. +

additionalProperties: false MarginStyle: type: object + description:

The display options for margins around the outside edge of sheets.

properties: Show: type: boolean default: null + description:

This Boolean value controls whether to display sheet margins.

additionalProperties: false SheetStyle: type: object + description:

The theme display options for sheets.

properties: Tile: $ref: '#/components/schemas/TileStyle' @@ -10911,6 +11474,9 @@ components: additionalProperties: false ThemeConfiguration: type: object + description: |- +

The theme configuration. This configuration contains all of the display properties for + a theme.

properties: DataColorPalette: $ref: '#/components/schemas/DataColorPalette' @@ -10923,12 +11489,14 @@ components: additionalProperties: false ThemeError: type: object + description:

Theme error.

properties: Type: $ref: '#/components/schemas/ThemeErrorType' Message: type: string - pattern: .*\S.* + pattern: \S + description:

The error message.

additionalProperties: false ThemeErrorType: type: string @@ -10942,23 +11510,31 @@ components: - ALL ThemeVersion: type: object + description:

A version of a theme.

properties: VersionNumber: type: number minimum: 1 + description:

The version number of the theme.

Arn: type: string + description:

The Amazon Resource Name (ARN) of the resource.

Description: type: string maxLength: 512 minLength: 1 + description:

The description of the theme.

BaseThemeId: type: string maxLength: 512 minLength: 1 - pattern: '[\w\-]+' + pattern: ^[\w\-]+$ + description: |- +

The Amazon QuickSight-defined ID of the theme that a custom theme inherits from. All + themes initially inherit from a default Amazon QuickSight theme.

CreatedTime: type: string + description:

The date and time that this theme version was created.

format: date-time Configuration: $ref: '#/components/schemas/ThemeConfiguration' @@ -10967,11 +11543,13 @@ components: items: $ref: '#/components/schemas/ThemeError' minItems: 1 + description:

Errors associated with the theme.

Status: $ref: '#/components/schemas/ResourceStatus' additionalProperties: false TileLayoutStyle: type: object + description:

The display options for the layout of tiles on a sheet.

properties: Gutter: $ref: '#/components/schemas/GutterStyle' @@ -10980,6 +11558,7 @@ components: additionalProperties: false TileStyle: type: object + description:

Display options related to tiles on a sheet.

properties: Border: $ref: '#/components/schemas/BorderStyle' @@ -10996,61 +11575,104 @@ components: additionalProperties: false UIColorPalette: type: object + description: |- +

The theme colors that apply to UI and to charts, excluding data colors. The colors + description is a hexadecimal color code that consists of six alphanumerical characters, + prefixed with #, for example #37BFF5. For more information, see Using Themes in Amazon QuickSight in the Amazon QuickSight User + Guide. +

properties: PrimaryForeground: type: string pattern: ^#[A-F0-9]{6}$ + description: |- +

The color of text and other foreground elements that appear over the primary + background regions, such as grid lines, borders, table banding, icons, and so on.

PrimaryBackground: type: string pattern: ^#[A-F0-9]{6}$ + description:

The background color that applies to visuals and other high emphasis UI.

SecondaryForeground: type: string pattern: ^#[A-F0-9]{6}$ + description: |- +

The foreground color that applies to any sheet title, sheet control text, or UI that + appears over the secondary background.

SecondaryBackground: type: string pattern: ^#[A-F0-9]{6}$ + description:

The background color that applies to the sheet background and sheet controls.

Accent: type: string pattern: ^#[A-F0-9]{6}$ + description:

This color is that applies to selected states and buttons.

AccentForeground: type: string pattern: ^#[A-F0-9]{6}$ + description: |- +

The foreground color that applies to any text or other elements that appear over the + accent color.

Danger: type: string pattern: ^#[A-F0-9]{6}$ + description:

The color that applies to error messages.

DangerForeground: type: string pattern: ^#[A-F0-9]{6}$ + description: |- +

The foreground color that applies to any text or other elements that appear over the + error color.

Warning: type: string pattern: ^#[A-F0-9]{6}$ + description:

This color that applies to warning and informational messages.

WarningForeground: type: string pattern: ^#[A-F0-9]{6}$ + description: |- +

The foreground color that applies to any text or other elements that appear over the + warning color.

Success: type: string pattern: ^#[A-F0-9]{6}$ + description: |- +

The color that applies to success messages, for example the check mark for a + successful download.

SuccessForeground: type: string pattern: ^#[A-F0-9]{6}$ + description: |- +

The foreground color that applies to any text or other elements that appear over the + success color.

Dimension: type: string pattern: ^#[A-F0-9]{6}$ + description: |- +

The color that applies to the names of fields that are identified as + dimensions.

DimensionForeground: type: string pattern: ^#[A-F0-9]{6}$ + description: |- +

The foreground color that applies to any text or other elements that appear over the + dimension color.

Measure: type: string pattern: ^#[A-F0-9]{6}$ + description:

The color that applies to the names of fields that are identified as measures.

MeasureForeground: type: string pattern: ^#[A-F0-9]{6}$ + description: |- +

The foreground color that applies to any text or other elements that appear over the + measure color.

additionalProperties: false Theme: type: object properties: Arn: type: string + description:

The Amazon Resource Name (ARN) of the theme.

AwsAccountId: type: string maxLength: 12 @@ -11060,14 +11682,16 @@ components: type: string maxLength: 512 minLength: 1 - pattern: '[\w\-]+' + pattern: ^[\w\-]+$ Configuration: $ref: '#/components/schemas/ThemeConfiguration' CreatedTime: type: string + description:

The date and time that the theme was created.

format: date-time LastUpdatedTime: type: string + description:

The date and time that the theme was last updated.

format: date-time Name: type: string @@ -11089,7 +11713,7 @@ components: type: string maxLength: 512 minLength: 1 - pattern: '[\w\-]+' + pattern: ^[\w\-]+$ Type: $ref: '#/components/schemas/ThemeType' Version: @@ -11525,6 +12149,8 @@ components: IsIncludedInTopic: type: boolean default: false + DisableIndexing: + type: boolean ColumnDataRole: $ref: '#/components/schemas/ColumnDataRole' TimeGranularity: @@ -11548,13 +12174,13 @@ components: NeverAggregateInFilter: type: boolean default: false - NonAdditive: - type: boolean - default: false CellValueSynonyms: type: array items: $ref: '#/components/schemas/CellValueSynonym' + NonAdditive: + type: boolean + default: false required: - CalculatedFieldName - Expression @@ -11612,6 +12238,8 @@ components: IsIncludedInTopic: type: boolean default: false + DisableIndexing: + type: boolean ComparativeOrder: $ref: '#/components/schemas/ComparativeOrder' SemanticType: @@ -11631,13 +12259,13 @@ components: NeverAggregateInFilter: type: boolean default: false - NonAdditive: - type: boolean - default: false CellValueSynonyms: type: array items: $ref: '#/components/schemas/CellValueSynonym' + NonAdditive: + type: boolean + default: false required: - ColumnName additionalProperties: false @@ -11661,12 +12289,12 @@ components: type: string maxLength: 256 minLength: 0 + UserExperienceVersion: + $ref: '#/components/schemas/TopicUserExperienceVersion' DataSets: type: array items: $ref: '#/components/schemas/DatasetMetadata' - UserExperienceVersion: - $ref: '#/components/schemas/TopicUserExperienceVersion' additionalProperties: false TopicFilter: type: object @@ -11882,89 +12510,50 @@ components: - quicksight:DeleteTopic list: - quicksight:ListTopics - Arn: - type: string - DnsResolvers: - type: array - items: - type: string - x-insertionOrder: false - NetworkInterfaces: - type: array - items: - $ref: '#/components/schemas/NetworkInterface' - maxItems: 15 - x-insertionOrder: false NetworkInterface: type: object + description:

The structure that contains information about a network interface.

properties: SubnetId: - $ref: '#/components/schemas/SubnetId' + type: string + maxLength: 255 + minLength: 1 + pattern: ^subnet-[0-9a-z]*$ + description:

The subnet ID associated with the network interface.

AvailabilityZone: type: string + description:

The availability zone that the network interface resides in.

ErrorMessage: type: string + description:

An error message.

Status: - type: string - enum: - - CREATING - - AVAILABLE - - CREATION_FAILED - - UPDATING - - UPDATE_FAILED - - DELETING - - DELETED - - DELETION_FAILED - - DELETION_SCHEDULED - - ATTACHMENT_FAILED_ROLLBACK_FAILED + $ref: '#/components/schemas/NetworkInterfaceStatus' NetworkInterfaceId: - $ref: '#/components/schemas/NetworkInterfaceId' + type: string + maxLength: 255 + minLength: 0 + pattern: ^eni-[0-9a-z]*$ + description:

The network interface ID.

additionalProperties: false - required: [] - NetworkInterfaceId: - type: string - pattern: ^eni-[0-9a-z]*$ - maxLength: 255 - RoleArn: - type: string - SecurityGroupIds: - type: array - items: - $ref: '#/components/schemas/SecurityGroupId' - maxItems: 16 - minItems: 1 - x-insertionOrder: false - SecurityGroupId: - type: string - pattern: ^sg-[0-9a-z]*$ - maxItems: 255 - minItems: 1 - SubnetIds: - type: array - items: - $ref: '#/components/schemas/SubnetId' - maxItems: 15 - minItems: 2 - x-insertionOrder: false - SubnetId: - type: string - pattern: ^subnet-[0-9a-z]*$ - maxLength: 255 - minLength: 1 - Tags: - type: array - items: - $ref: '#/components/schemas/Tag' - maxItems: 200 - minItems: 1 - x-insertionOrder: false - VPCConnectionId: + NetworkInterfaceStatus: type: string - maxLength: 1000 - minLength: 1 - pattern: '[\w\-]+' - VPCId: + enum: + - CREATING + - AVAILABLE + - CREATION_FAILED + - UPDATING + - UPDATE_FAILED + - DELETING + - DELETED + - DELETION_FAILED + - DELETION_SCHEDULED + - ATTACHMENT_FAILED_ROLLBACK_FAILED + VPCConnectionAvailabilityStatus: type: string + enum: + - AVAILABLE + - UNAVAILABLE + - PARTIALLY_AVAILABLE VPCConnectionResourceStatus: type: string enum: @@ -11977,52 +12566,83 @@ components: - DELETION_IN_PROGRESS - DELETION_FAILED - DELETED - VPCConnectionAvailabilityStatus: - type: string - enum: - - AVAILABLE - - UNAVAILABLE - - PARTIALLY_AVAILABLE VPCConnection: type: object properties: Arn: - $ref: '#/components/schemas/Arn' + type: string + description:

The Amazon Resource Name (ARN) of the VPC connection.

+ AvailabilityStatus: + $ref: '#/components/schemas/VPCConnectionAvailabilityStatus' AwsAccountId: type: string maxLength: 12 minLength: 12 pattern: ^[0-9]{12}$ + CreatedTime: + type: string + description:

The time that the VPC connection was created.

+ format: date-time + DnsResolvers: + type: array + items: + type: string + x-insertionOrder: false + LastUpdatedTime: + type: string + description:

The time that the VPC connection was last updated.

+ format: date-time Name: type: string - maxLength: 128 + maxLength: 128 + minLength: 1 + NetworkInterfaces: + type: array + items: + $ref: '#/components/schemas/NetworkInterface' + maxItems: 15 + minItems: 0 + description:

A list of network interfaces.

+ x-insertionOrder: false + RoleArn: + type: string + SecurityGroupIds: + type: array + items: + type: string + maxLength: 255 + minLength: 1 + pattern: ^sg-[0-9a-z]*$ + maxItems: 16 + minItems: 1 + x-insertionOrder: false + Status: + $ref: '#/components/schemas/VPCConnectionResourceStatus' + SubnetIds: + type: array + items: + type: string + maxLength: 255 + minLength: 1 + pattern: ^subnet-[0-9a-z]*$ + maxItems: 15 + minItems: 2 + x-insertionOrder: false + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 1 + x-insertionOrder: false + VPCConnectionId: + type: string + maxLength: 1000 minLength: 1 - VPCConnectionId: - $ref: '#/components/schemas/VPCConnectionId' + pattern: '[\w\-]+' VPCId: - $ref: '#/components/schemas/VPCId' - SecurityGroupIds: - $ref: '#/components/schemas/SecurityGroupIds' - SubnetIds: - $ref: '#/components/schemas/SubnetIds' - DnsResolvers: - $ref: '#/components/schemas/DnsResolvers' - Status: - $ref: '#/components/schemas/VPCConnectionResourceStatus' - AvailabilityStatus: - $ref: '#/components/schemas/VPCConnectionAvailabilityStatus' - NetworkInterfaces: - $ref: '#/components/schemas/NetworkInterfaces' - RoleArn: - $ref: '#/components/schemas/RoleArn' - CreatedTime: - type: string - format: date-time - LastUpdatedTime: type: string - format: date-time - Tags: - $ref: '#/components/schemas/Tags' + description:

The Amazon EC2 VPC ID associated with the VPC connection.

x-stackql-resource-name: vpc_connection description: Definition of the AWS::QuickSight::VPCConnection Resource Type. x-type-name: AWS::QuickSight::VPCConnection @@ -12084,69 +12704,77 @@ components: DesiredState: type: object properties: - AnalysisId: - type: string - maxLength: 512 - minLength: 1 - pattern: '[\w\-]+' - Arn: - type: string - AwsAccountId: - type: string - maxLength: 12 - minLength: 12 - pattern: ^[0-9]{12}$ + Status: + $ref: '#/components/schemas/ResourceStatus' CreatedTime: - type: string format: date-time + description:

The time that the analysis was created.

+ type: string + Parameters: + $ref: '#/components/schemas/Parameters' DataSetArns: + minItems: 0 + maxItems: 100 + description:

The ARNs of the datasets of the analysis.

type: array items: type: string - maxItems: 100 - minItems: 0 + SourceEntity: + $ref: '#/components/schemas/AnalysisSourceEntity' + ThemeArn: + description:

The ARN of the theme of the analysis.

+ type: string Definition: $ref: '#/components/schemas/AnalysisDefinition' - Errors: - type: array - items: - $ref: '#/components/schemas/AnalysisError' - minItems: 1 LastUpdatedTime: - type: string format: date-time + description:

The time that the analysis was last updated.

+ type: string + ValidationStrategy: + $ref: '#/components/schemas/ValidationStrategy' Name: + minLength: 1 + description:

The descriptive name of the analysis.

type: string maxLength: 2048 + Errors: + minItems: 1 + description:

Errors associated with the analysis.

+ type: array + items: + $ref: '#/components/schemas/AnalysisError' + AnalysisId: minLength: 1 - Parameters: - $ref: '#/components/schemas/Parameters' + pattern: ^[\w\-]+$ + type: string + maxLength: 512 + AwsAccountId: + minLength: 12 + pattern: ^[0-9]{12}$ + type: string + maxLength: 12 Permissions: + minItems: 1 + maxItems: 64 type: array items: $ref: '#/components/schemas/ResourcePermission' - maxItems: 64 + Arn: + description:

The Amazon Resource Name (ARN) of the analysis.

+ type: string + Tags: minItems: 1 - Sheets: + maxItems: 200 type: array items: - $ref: '#/components/schemas/Sheet' - maxItems: 20 + $ref: '#/components/schemas/Tag' + Sheets: minItems: 0 - SourceEntity: - $ref: '#/components/schemas/AnalysisSourceEntity' - Status: - $ref: '#/components/schemas/ResourceStatus' - Tags: + maxItems: 20 + description:

A list of the associated sheets with the unique identifier and name of each sheet.

type: array items: - $ref: '#/components/schemas/Tag' - maxItems: 200 - minItems: 1 - ThemeArn: - type: string - ValidationStrategy: - $ref: '#/components/schemas/ValidationStrategy' + $ref: '#/components/schemas/Sheet' x-stackQL-stringOnly: true x-title: CreateAnalysisRequest type: object @@ -12164,72 +12792,76 @@ components: DesiredState: type: object properties: - Arn: + CreatedTime: + format: date-time + description:

The time that this dashboard was created.

type: string - AwsAccountId: + Parameters: + $ref: '#/components/schemas/Parameters' + VersionDescription: + minLength: 1 type: string - maxLength: 12 - minLength: 12 - pattern: ^[0-9]{12}$ - CreatedTime: + maxLength: 512 + SourceEntity: + $ref: '#/components/schemas/DashboardSourceEntity' + ThemeArn: type: string + Definition: + $ref: '#/components/schemas/DashboardVersionDefinition' + LastUpdatedTime: format: date-time + description:

The last time that this dashboard was updated.

+ type: string + ValidationStrategy: + $ref: '#/components/schemas/ValidationStrategy' DashboardId: + minLength: 1 + pattern: ^[\w\-]+$ type: string maxLength: 512 + LinkSharingConfiguration: + $ref: '#/components/schemas/LinkSharingConfiguration' + Name: minLength: 1 - pattern: '[\w\-]+' + type: string + maxLength: 2048 DashboardPublishOptions: $ref: '#/components/schemas/DashboardPublishOptions' - Definition: - $ref: '#/components/schemas/DashboardVersionDefinition' LastPublishedTime: - type: string format: date-time - LastUpdatedTime: + description:

The last time that this dashboard was published.

type: string - format: date-time + Version: + $ref: '#/components/schemas/DashboardVersion' + AwsAccountId: + minLength: 12 + pattern: ^[0-9]{12}$ + type: string + maxLength: 12 + Permissions: + minItems: 1 + maxItems: 64 + type: array + items: + $ref: '#/components/schemas/ResourcePermission' LinkEntities: + minItems: 0 + maxItems: 5 type: array items: + minLength: 1 + pattern: ^arn:aws[\w\-]*:quicksight:[\w\-]+:\d+:analysis/[\w\-]{1,512}$ type: string maxLength: 1024 - minLength: 1 - pattern: ^arn:aws[\w\-]*:quicksight:[\w\-]+:\d+:analysis/[\w\-]{1,512} - maxItems: 5 - minItems: 0 - LinkSharingConfiguration: - $ref: '#/components/schemas/LinkSharingConfiguration' - Name: + Arn: + description:

The Amazon Resource Name (ARN) of the resource.

type: string - maxLength: 2048 - minLength: 1 - Parameters: - $ref: '#/components/schemas/Parameters' - Permissions: - type: array - items: - $ref: '#/components/schemas/ResourcePermission' - maxItems: 64 - minItems: 1 - SourceEntity: - $ref: '#/components/schemas/DashboardSourceEntity' Tags: + minItems: 1 + maxItems: 200 type: array items: $ref: '#/components/schemas/Tag' - maxItems: 200 - minItems: 1 - ThemeArn: - type: string - ValidationStrategy: - $ref: '#/components/schemas/ValidationStrategy' - Version: - $ref: '#/components/schemas/DashboardVersion' - VersionDescription: - type: string - maxLength: 512 - minLength: 1 x-stackQL-stringOnly: true x-title: CreateDashboardRequest type: object @@ -12261,14 +12893,19 @@ components: $ref: '#/components/schemas/ColumnGroup' maxItems: 8 minItems: 1 - description:

Groupings of columns that work together in certain QuickSight features. Currently, only geospatial hierarchy is supported.

+ description:

Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.

ColumnLevelPermissionRules: type: array items: $ref: '#/components/schemas/ColumnLevelPermissionRule' minItems: 1 + description: |- +

A set of one or more definitions of a + ColumnLevelPermissionRule + .

ConsumedSpiceCapacityInBytes: type: number + default: 0 description: |-

The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't imported into SPICE.

@@ -12278,13 +12915,17 @@ components: format: string DataSetId: type: string + DataSetRefreshProperties: + $ref: '#/components/schemas/DataSetRefreshProperties' + DataSetUsageConfiguration: + $ref: '#/components/schemas/DataSetUsageConfiguration' DatasetParameters: type: array items: $ref: '#/components/schemas/DatasetParameter' maxItems: 32 - minItems: 1 - description:

The parameters declared in the dataset.

+ minItems: 0 + description:

The parameter declarations of the dataset.

FieldFolders: $ref: '#/components/schemas/FieldFolderMap' ImportMode: @@ -12329,10 +12970,6 @@ components: description:

Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.

IngestionWaitPolicy: $ref: '#/components/schemas/IngestionWaitPolicy' - DataSetUsageConfiguration: - $ref: '#/components/schemas/DataSetUsageConfiguration' - DataSetRefreshProperties: - $ref: '#/components/schemas/DataSetRefreshProperties' x-stackQL-stringOnly: true x-title: CreateDataSetRequest type: object @@ -12394,14 +13031,12 @@ components: type: string maxLength: 128 minLength: 1 - description:

A display name for the data source.

Permissions: type: array items: $ref: '#/components/schemas/ResourcePermission' maxItems: 64 minItems: 1 - description:

A list of resource permissions on the data source.

SslProperties: $ref: '#/components/schemas/SslProperties' Status: @@ -12412,7 +13047,6 @@ components: $ref: '#/components/schemas/Tag' maxItems: 200 minItems: 1 - description:

Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.

Type: $ref: '#/components/schemas/DataSourceType' VpcConnectionProperties: @@ -12463,52 +13097,55 @@ components: DesiredState: type: object properties: - Arn: - type: string - AwsAccountId: - type: string - maxLength: 12 - minLength: 12 - pattern: ^[0-9]{12}$ CreatedTime: - type: string format: date-time + description:

Time when this was created.

+ type: string + VersionDescription: + minLength: 1 + type: string + maxLength: 512 + SourceEntity: + $ref: '#/components/schemas/TemplateSourceEntity' Definition: $ref: '#/components/schemas/TemplateVersionDefinition' LastUpdatedTime: - type: string format: date-time + description:

Time when this was last updated.

+ type: string + ValidationStrategy: + $ref: '#/components/schemas/ValidationStrategy' Name: + minLength: 1 type: string maxLength: 2048 - minLength: 1 + Version: + $ref: '#/components/schemas/TemplateVersion' + AwsAccountId: + minLength: 12 + pattern: ^[0-9]{12}$ + type: string + maxLength: 12 Permissions: + minItems: 1 + maxItems: 64 type: array items: $ref: '#/components/schemas/ResourcePermission' - maxItems: 64 - minItems: 1 - SourceEntity: - $ref: '#/components/schemas/TemplateSourceEntity' + Arn: + description:

The Amazon Resource Name (ARN) of the template.

+ type: string Tags: + minItems: 1 + maxItems: 200 type: array items: $ref: '#/components/schemas/Tag' - maxItems: 200 - minItems: 1 TemplateId: - type: string - maxLength: 512 minLength: 1 - pattern: '[\w\-]+' - ValidationStrategy: - $ref: '#/components/schemas/ValidationStrategy' - Version: - $ref: '#/components/schemas/TemplateVersion' - VersionDescription: + pattern: ^[\w\-]+$ type: string maxLength: 512 - minLength: 1 x-stackQL-stringOnly: true x-title: CreateTemplateRequest type: object @@ -12528,6 +13165,7 @@ components: properties: Arn: type: string + description:

The Amazon Resource Name (ARN) of the theme.

AwsAccountId: type: string maxLength: 12 @@ -12537,14 +13175,16 @@ components: type: string maxLength: 512 minLength: 1 - pattern: '[\w\-]+' + pattern: ^[\w\-]+$ Configuration: $ref: '#/components/schemas/ThemeConfiguration' CreatedTime: type: string + description:

The date and time that the theme was created.

format: date-time LastUpdatedTime: type: string + description:

The date and time that the theme was last updated.

format: date-time Name: type: string @@ -12566,7 +13206,7 @@ components: type: string maxLength: 512 minLength: 1 - pattern: '[\w\-]+' + pattern: ^[\w\-]+$ Type: $ref: '#/components/schemas/ThemeType' Version: @@ -12636,42 +13276,79 @@ components: type: object properties: Arn: - $ref: '#/components/schemas/Arn' + type: string + description:

The Amazon Resource Name (ARN) of the VPC connection.

+ AvailabilityStatus: + $ref: '#/components/schemas/VPCConnectionAvailabilityStatus' AwsAccountId: type: string - maxLength: 12 - minLength: 12 - pattern: ^[0-9]{12}$ + maxLength: 12 + minLength: 12 + pattern: ^[0-9]{12}$ + CreatedTime: + type: string + description:

The time that the VPC connection was created.

+ format: date-time + DnsResolvers: + type: array + items: + type: string + x-insertionOrder: false + LastUpdatedTime: + type: string + description:

The time that the VPC connection was last updated.

+ format: date-time Name: type: string maxLength: 128 minLength: 1 - VPCConnectionId: - $ref: '#/components/schemas/VPCConnectionId' - VPCId: - $ref: '#/components/schemas/VPCId' + NetworkInterfaces: + type: array + items: + $ref: '#/components/schemas/NetworkInterface' + maxItems: 15 + minItems: 0 + description:

A list of network interfaces.

+ x-insertionOrder: false + RoleArn: + type: string SecurityGroupIds: - $ref: '#/components/schemas/SecurityGroupIds' - SubnetIds: - $ref: '#/components/schemas/SubnetIds' - DnsResolvers: - $ref: '#/components/schemas/DnsResolvers' + type: array + items: + type: string + maxLength: 255 + minLength: 1 + pattern: ^sg-[0-9a-z]*$ + maxItems: 16 + minItems: 1 + x-insertionOrder: false Status: $ref: '#/components/schemas/VPCConnectionResourceStatus' - AvailabilityStatus: - $ref: '#/components/schemas/VPCConnectionAvailabilityStatus' - NetworkInterfaces: - $ref: '#/components/schemas/NetworkInterfaces' - RoleArn: - $ref: '#/components/schemas/RoleArn' - CreatedTime: + SubnetIds: + type: array + items: + type: string + maxLength: 255 + minLength: 1 + pattern: ^subnet-[0-9a-z]*$ + maxItems: 15 + minItems: 2 + x-insertionOrder: false + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + maxItems: 200 + minItems: 1 + x-insertionOrder: false + VPCConnectionId: type: string - format: date-time - LastUpdatedTime: + maxLength: 1000 + minLength: 1 + pattern: '[\w\-]+' + VPCId: type: string - format: date-time - Tags: - $ref: '#/components/schemas/Tags' + description:

The Amazon EC2 VPC ID associated with the VPC connection.

x-stackQL-stringOnly: true x-title: CreateVPCConnectionRequest type: object @@ -12692,7 +13369,7 @@ components: x-identifiers: - AnalysisId - AwsAccountId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -12709,9 +13386,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -12721,44 +13398,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/analyses/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/analyses/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AnalysisId') as analysis_id, - JSON_EXTRACT(Properties, '$.AwsAccountId') as aws_account_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::Analysis' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AnalysisId') as analysis_id, - json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::Analysis' - AND region = 'us-east-1' - analysis: - name: analysis - id: aws.quicksight.analysis - x-cfn-schema-name: Analysis - x-cfn-type-name: AWS::QuickSight::Analysis - x-identifiers: - - AnalysisId - - AwsAccountId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -12769,62 +13411,84 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/analyses/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/analyses/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/analysis/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/analyses/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.AnalysisId') as analysis_id, - JSON_EXTRACT(Properties, '$.Arn') as arn, - JSON_EXTRACT(Properties, '$.AwsAccountId') as aws_account_id, + JSON_EXTRACT(Properties, '$.Status') as status, JSON_EXTRACT(Properties, '$.CreatedTime') as created_time, + JSON_EXTRACT(Properties, '$.Parameters') as parameters, JSON_EXTRACT(Properties, '$.DataSetArns') as data_set_arns, + JSON_EXTRACT(Properties, '$.SourceEntity') as source_entity, + JSON_EXTRACT(Properties, '$.ThemeArn') as theme_arn, JSON_EXTRACT(Properties, '$.Definition') as definition, - JSON_EXTRACT(Properties, '$.Errors') as errors, JSON_EXTRACT(Properties, '$.LastUpdatedTime') as last_updated_time, + JSON_EXTRACT(Properties, '$.ValidationStrategy') as validation_strategy, JSON_EXTRACT(Properties, '$.Name') as name, - JSON_EXTRACT(Properties, '$.Parameters') as parameters, + JSON_EXTRACT(Properties, '$.Errors') as errors, + JSON_EXTRACT(Properties, '$.AnalysisId') as analysis_id, + JSON_EXTRACT(Properties, '$.AwsAccountId') as aws_account_id, JSON_EXTRACT(Properties, '$.Permissions') as permissions, - JSON_EXTRACT(Properties, '$.Sheets') as sheets, - JSON_EXTRACT(Properties, '$.SourceEntity') as source_entity, - JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.Arn') as arn, JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.ThemeArn') as theme_arn, - JSON_EXTRACT(Properties, '$.ValidationStrategy') as validation_strategy + JSON_EXTRACT(Properties, '$.Sheets') as sheets FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::QuickSight::Analysis' AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AnalysisId') as analysis_id, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, - json_extract_path_text(Properties, 'CreatedTime') as created_time, - json_extract_path_text(Properties, 'DataSetArns') as data_set_arns, - json_extract_path_text(Properties, 'Definition') as definition, - json_extract_path_text(Properties, 'Errors') as errors, - json_extract_path_text(Properties, 'LastUpdatedTime') as last_updated_time, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Parameters') as parameters, - json_extract_path_text(Properties, 'Permissions') as permissions, - json_extract_path_text(Properties, 'Sheets') as sheets, - json_extract_path_text(Properties, 'SourceEntity') as source_entity, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'ThemeArn') as theme_arn, - json_extract_path_text(Properties, 'ValidationStrategy') as validation_strategy - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::QuickSight::Analysis' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.AnalysisId') as analysis_id, + JSON_EXTRACT(Properties, '$.AwsAccountId') as aws_account_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::Analysis' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'CreatedTime') as created_time, + json_extract_path_text(Properties, 'Parameters') as parameters, + json_extract_path_text(Properties, 'DataSetArns') as data_set_arns, + json_extract_path_text(Properties, 'SourceEntity') as source_entity, + json_extract_path_text(Properties, 'ThemeArn') as theme_arn, + json_extract_path_text(Properties, 'Definition') as definition, + json_extract_path_text(Properties, 'LastUpdatedTime') as last_updated_time, + json_extract_path_text(Properties, 'ValidationStrategy') as validation_strategy, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Errors') as errors, + json_extract_path_text(Properties, 'AnalysisId') as analysis_id, + json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, + json_extract_path_text(Properties, 'Permissions') as permissions, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Sheets') as sheets + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::QuickSight::Analysis' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AnalysisId') as analysis_id, + json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::Analysis' + AND region = 'us-east-1' dashboards: name: dashboards id: aws.quicksight.dashboards @@ -12833,7 +13497,7 @@ components: x-identifiers: - AwsAccountId - DashboardId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -12850,9 +13514,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -12862,44 +13526,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/dashboards/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/dashboards/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AwsAccountId') as aws_account_id, - JSON_EXTRACT(Properties, '$.DashboardId') as dashboard_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::Dashboard' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, - json_extract_path_text(Properties, 'DashboardId') as dashboard_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::Dashboard' - AND region = 'us-east-1' - dashboard: - name: dashboard - id: aws.quicksight.dashboard - x-cfn-schema-name: Dashboard - x-cfn-type-name: AWS::QuickSight::Dashboard - x-identifiers: - - AwsAccountId - - DashboardId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -12910,66 +13539,88 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/dashboards/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/dashboards/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/dashboard/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/dashboards/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.Arn') as arn, - JSON_EXTRACT(Properties, '$.AwsAccountId') as aws_account_id, JSON_EXTRACT(Properties, '$.CreatedTime') as created_time, - JSON_EXTRACT(Properties, '$.DashboardId') as dashboard_id, - JSON_EXTRACT(Properties, '$.DashboardPublishOptions') as dashboard_publish_options, - JSON_EXTRACT(Properties, '$.Definition') as definition, - JSON_EXTRACT(Properties, '$.LastPublishedTime') as last_published_time, - JSON_EXTRACT(Properties, '$.LastUpdatedTime') as last_updated_time, - JSON_EXTRACT(Properties, '$.LinkEntities') as link_entities, - JSON_EXTRACT(Properties, '$.LinkSharingConfiguration') as link_sharing_configuration, - JSON_EXTRACT(Properties, '$.Name') as name, JSON_EXTRACT(Properties, '$.Parameters') as parameters, - JSON_EXTRACT(Properties, '$.Permissions') as permissions, + JSON_EXTRACT(Properties, '$.VersionDescription') as version_description, JSON_EXTRACT(Properties, '$.SourceEntity') as source_entity, - JSON_EXTRACT(Properties, '$.Tags') as tags, JSON_EXTRACT(Properties, '$.ThemeArn') as theme_arn, + JSON_EXTRACT(Properties, '$.Definition') as definition, + JSON_EXTRACT(Properties, '$.LastUpdatedTime') as last_updated_time, JSON_EXTRACT(Properties, '$.ValidationStrategy') as validation_strategy, + JSON_EXTRACT(Properties, '$.DashboardId') as dashboard_id, + JSON_EXTRACT(Properties, '$.LinkSharingConfiguration') as link_sharing_configuration, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.DashboardPublishOptions') as dashboard_publish_options, + JSON_EXTRACT(Properties, '$.LastPublishedTime') as last_published_time, JSON_EXTRACT(Properties, '$.Version') as version, - JSON_EXTRACT(Properties, '$.VersionDescription') as version_description + JSON_EXTRACT(Properties, '$.AwsAccountId') as aws_account_id, + JSON_EXTRACT(Properties, '$.Permissions') as permissions, + JSON_EXTRACT(Properties, '$.LinkEntities') as link_entities, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.Tags') as tags FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::QuickSight::Dashboard' AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, - json_extract_path_text(Properties, 'CreatedTime') as created_time, - json_extract_path_text(Properties, 'DashboardId') as dashboard_id, - json_extract_path_text(Properties, 'DashboardPublishOptions') as dashboard_publish_options, - json_extract_path_text(Properties, 'Definition') as definition, - json_extract_path_text(Properties, 'LastPublishedTime') as last_published_time, - json_extract_path_text(Properties, 'LastUpdatedTime') as last_updated_time, - json_extract_path_text(Properties, 'LinkEntities') as link_entities, - json_extract_path_text(Properties, 'LinkSharingConfiguration') as link_sharing_configuration, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Parameters') as parameters, - json_extract_path_text(Properties, 'Permissions') as permissions, - json_extract_path_text(Properties, 'SourceEntity') as source_entity, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'ThemeArn') as theme_arn, - json_extract_path_text(Properties, 'ValidationStrategy') as validation_strategy, - json_extract_path_text(Properties, 'Version') as version, - json_extract_path_text(Properties, 'VersionDescription') as version_description - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::QuickSight::Dashboard' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.AwsAccountId') as aws_account_id, + JSON_EXTRACT(Properties, '$.DashboardId') as dashboard_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::Dashboard' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'CreatedTime') as created_time, + json_extract_path_text(Properties, 'Parameters') as parameters, + json_extract_path_text(Properties, 'VersionDescription') as version_description, + json_extract_path_text(Properties, 'SourceEntity') as source_entity, + json_extract_path_text(Properties, 'ThemeArn') as theme_arn, + json_extract_path_text(Properties, 'Definition') as definition, + json_extract_path_text(Properties, 'LastUpdatedTime') as last_updated_time, + json_extract_path_text(Properties, 'ValidationStrategy') as validation_strategy, + json_extract_path_text(Properties, 'DashboardId') as dashboard_id, + json_extract_path_text(Properties, 'LinkSharingConfiguration') as link_sharing_configuration, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'DashboardPublishOptions') as dashboard_publish_options, + json_extract_path_text(Properties, 'LastPublishedTime') as last_published_time, + json_extract_path_text(Properties, 'Version') as version, + json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, + json_extract_path_text(Properties, 'Permissions') as permissions, + json_extract_path_text(Properties, 'LinkEntities') as link_entities, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::QuickSight::Dashboard' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, + json_extract_path_text(Properties, 'DashboardId') as dashboard_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::Dashboard' + AND region = 'us-east-1' data_sets: name: data_sets id: aws.quicksight.data_sets @@ -12978,7 +13629,7 @@ components: x-identifiers: - AwsAccountId - DataSetId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -12995,9 +13646,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -13007,44 +13658,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/data_sets/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/data_sets/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AwsAccountId') as aws_account_id, - JSON_EXTRACT(Properties, '$.DataSetId') as data_set_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::DataSet' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, - json_extract_path_text(Properties, 'DataSetId') as data_set_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::DataSet' - AND region = 'us-east-1' - data_set: - name: data_set - id: aws.quicksight.data_set - x-cfn-schema-name: DataSet - x-cfn-type-name: AWS::QuickSight::DataSet - x-identifiers: - - AwsAccountId - - DataSetId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -13055,12 +13671,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/data_sets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/data_sets/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/data_set/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/data_sets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -13072,6 +13692,8 @@ components: JSON_EXTRACT(Properties, '$.ConsumedSpiceCapacityInBytes') as consumed_spice_capacity_in_bytes, JSON_EXTRACT(Properties, '$.CreatedTime') as created_time, JSON_EXTRACT(Properties, '$.DataSetId') as data_set_id, + JSON_EXTRACT(Properties, '$.DataSetRefreshProperties') as data_set_refresh_properties, + JSON_EXTRACT(Properties, '$.DataSetUsageConfiguration') as data_set_usage_configuration, JSON_EXTRACT(Properties, '$.DatasetParameters') as dataset_parameters, JSON_EXTRACT(Properties, '$.FieldFolders') as field_folders, JSON_EXTRACT(Properties, '$.ImportMode') as import_mode, @@ -13084,115 +13706,84 @@ components: JSON_EXTRACT(Properties, '$.RowLevelPermissionDataSet') as row_level_permission_data_set, JSON_EXTRACT(Properties, '$.RowLevelPermissionTagConfiguration') as row_level_permission_tag_configuration, JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.IngestionWaitPolicy') as ingestion_wait_policy, - JSON_EXTRACT(Properties, '$.DataSetUsageConfiguration') as data_set_usage_configuration, - JSON_EXTRACT(Properties, '$.DataSetRefreshProperties') as data_set_refresh_properties + JSON_EXTRACT(Properties, '$.IngestionWaitPolicy') as ingestion_wait_policy FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::QuickSight::DataSet' AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, - json_extract_path_text(Properties, 'ColumnGroups') as column_groups, - json_extract_path_text(Properties, 'ColumnLevelPermissionRules') as column_level_permission_rules, - json_extract_path_text(Properties, 'ConsumedSpiceCapacityInBytes') as consumed_spice_capacity_in_bytes, - json_extract_path_text(Properties, 'CreatedTime') as created_time, - json_extract_path_text(Properties, 'DataSetId') as data_set_id, - json_extract_path_text(Properties, 'DatasetParameters') as dataset_parameters, - json_extract_path_text(Properties, 'FieldFolders') as field_folders, - json_extract_path_text(Properties, 'ImportMode') as import_mode, - json_extract_path_text(Properties, 'LastUpdatedTime') as last_updated_time, - json_extract_path_text(Properties, 'LogicalTableMap') as logical_table_map, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'OutputColumns') as output_columns, - json_extract_path_text(Properties, 'Permissions') as permissions, - json_extract_path_text(Properties, 'PhysicalTableMap') as physical_table_map, - json_extract_path_text(Properties, 'RowLevelPermissionDataSet') as row_level_permission_data_set, - json_extract_path_text(Properties, 'RowLevelPermissionTagConfiguration') as row_level_permission_tag_configuration, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'IngestionWaitPolicy') as ingestion_wait_policy, - json_extract_path_text(Properties, 'DataSetUsageConfiguration') as data_set_usage_configuration, - json_extract_path_text(Properties, 'DataSetRefreshProperties') as data_set_refresh_properties - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::QuickSight::DataSet' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.AwsAccountId') as aws_account_id, + JSON_EXTRACT(Properties, '$.DataSetId') as data_set_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::DataSet' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, + json_extract_path_text(Properties, 'ColumnGroups') as column_groups, + json_extract_path_text(Properties, 'ColumnLevelPermissionRules') as column_level_permission_rules, + json_extract_path_text(Properties, 'ConsumedSpiceCapacityInBytes') as consumed_spice_capacity_in_bytes, + json_extract_path_text(Properties, 'CreatedTime') as created_time, + json_extract_path_text(Properties, 'DataSetId') as data_set_id, + json_extract_path_text(Properties, 'DataSetRefreshProperties') as data_set_refresh_properties, + json_extract_path_text(Properties, 'DataSetUsageConfiguration') as data_set_usage_configuration, + json_extract_path_text(Properties, 'DatasetParameters') as dataset_parameters, + json_extract_path_text(Properties, 'FieldFolders') as field_folders, + json_extract_path_text(Properties, 'ImportMode') as import_mode, + json_extract_path_text(Properties, 'LastUpdatedTime') as last_updated_time, + json_extract_path_text(Properties, 'LogicalTableMap') as logical_table_map, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'OutputColumns') as output_columns, + json_extract_path_text(Properties, 'Permissions') as permissions, + json_extract_path_text(Properties, 'PhysicalTableMap') as physical_table_map, + json_extract_path_text(Properties, 'RowLevelPermissionDataSet') as row_level_permission_data_set, + json_extract_path_text(Properties, 'RowLevelPermissionTagConfiguration') as row_level_permission_tag_configuration, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'IngestionWaitPolicy') as ingestion_wait_policy + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::QuickSight::DataSet' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, + json_extract_path_text(Properties, 'DataSetId') as data_set_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::DataSet' + AND region = 'us-east-1' data_sources: name: data_sources - id: aws.quicksight.data_sources - x-cfn-schema-name: DataSource - x-cfn-type-name: AWS::QuickSight::DataSource - x-identifiers: - - AwsAccountId - - DataSourceId - x-type: list - methods: - create_resource: - config: - requestBodyTranslate: - algorithm: naive_DesiredState - operation: - $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DataSource&__detailTransformed=true/post' - request: - mediaType: application/x-amz-json-1.0 - base: |- - { - "TypeName": "AWS::QuickSight::DataSource" - } - response: - mediaType: application/json - openAPIDocKey: '200' - delete_resource: - operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' - request: - mediaType: application/x-amz-json-1.0 - base: |- - { - "TypeName": "AWS::QuickSight::DataSource" - } - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/data_sources/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/data_sources/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AwsAccountId') as aws_account_id, - JSON_EXTRACT(Properties, '$.DataSourceId') as data_source_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::DataSource' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, - json_extract_path_text(Properties, 'DataSourceId') as data_source_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::DataSource' - AND region = 'us-east-1' - data_source: - name: data_source - id: aws.quicksight.data_source + id: aws.quicksight.data_sources x-cfn-schema-name: DataSource x-cfn-type-name: AWS::QuickSight::DataSource x-identifiers: - AwsAccountId - DataSourceId - x-type: get + x-type: cloud_control methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DataSource&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QuickSight::DataSource" + } + response: + mediaType: application/json + openAPIDocKey: '200' update_resource: operation: $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' @@ -13205,13 +13796,29 @@ components: response: mediaType: application/json openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::QuickSight::DataSource" + } + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/data_sources/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/data_sources/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/data_source/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/data_sources/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -13236,30 +13843,48 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AlternateDataSourceParameters') as alternate_data_source_parameters, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, - json_extract_path_text(Properties, 'CreatedTime') as created_time, - json_extract_path_text(Properties, 'Credentials') as credentials, - json_extract_path_text(Properties, 'DataSourceId') as data_source_id, - json_extract_path_text(Properties, 'DataSourceParameters') as data_source_parameters, - json_extract_path_text(Properties, 'ErrorInfo') as error_info, - json_extract_path_text(Properties, 'LastUpdatedTime') as last_updated_time, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Permissions') as permissions, - json_extract_path_text(Properties, 'SslProperties') as ssl_properties, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Type') as type, - json_extract_path_text(Properties, 'VpcConnectionProperties') as vpc_connection_properties - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::QuickSight::DataSource' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.AwsAccountId') as aws_account_id, + JSON_EXTRACT(Properties, '$.DataSourceId') as data_source_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::DataSource' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AlternateDataSourceParameters') as alternate_data_source_parameters, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, + json_extract_path_text(Properties, 'CreatedTime') as created_time, + json_extract_path_text(Properties, 'Credentials') as credentials, + json_extract_path_text(Properties, 'DataSourceId') as data_source_id, + json_extract_path_text(Properties, 'DataSourceParameters') as data_source_parameters, + json_extract_path_text(Properties, 'ErrorInfo') as error_info, + json_extract_path_text(Properties, 'LastUpdatedTime') as last_updated_time, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Permissions') as permissions, + json_extract_path_text(Properties, 'SslProperties') as ssl_properties, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'VpcConnectionProperties') as vpc_connection_properties + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::QuickSight::DataSource' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, + json_extract_path_text(Properties, 'DataSourceId') as data_source_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::DataSource' + AND region = 'us-east-1' refresh_schedules: name: refresh_schedules id: aws.quicksight.refresh_schedules @@ -13269,7 +13894,7 @@ components: - AwsAccountId - DataSetId - Schedule/ScheduleId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -13286,9 +13911,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -13298,47 +13923,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/refresh_schedules/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/refresh_schedules/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AwsAccountId') as aws_account_id, - JSON_EXTRACT(Properties, '$.DataSetId') as data_set_id, - JSON_EXTRACT(Properties, '$.Schedule.ScheduleId') as schedule__schedule_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::RefreshSchedule' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, - json_extract_path_text(Properties, 'DataSetId') as data_set_id, - json_extract_path_text(Properties, 'Schedule', 'ScheduleId') as schedule__schedule_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::RefreshSchedule' - AND region = 'us-east-1' - refresh_schedule: - name: refresh_schedule - id: aws.quicksight.refresh_schedule - x-cfn-schema-name: RefreshSchedule - x-cfn-type-name: AWS::QuickSight::RefreshSchedule - x-identifiers: - - AwsAccountId - - DataSetId - - Schedule/ScheduleId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -13349,12 +13936,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/refresh_schedules/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/refresh_schedules/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/refresh_schedule/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/refresh_schedules/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -13367,18 +13958,38 @@ components: AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, - json_extract_path_text(Properties, 'DataSetId') as data_set_id, - json_extract_path_text(Properties, 'Schedule') as schedule - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::QuickSight::RefreshSchedule' - AND data__Identifier = '||' + JSON_EXTRACT(Properties, '$.AwsAccountId') as aws_account_id, + JSON_EXTRACT(Properties, '$.DataSetId') as data_set_id, + JSON_EXTRACT(Properties, '$.Schedule.ScheduleId') as schedule__schedule_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::RefreshSchedule' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, + json_extract_path_text(Properties, 'DataSetId') as data_set_id, + json_extract_path_text(Properties, 'Schedule') as schedule + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::QuickSight::RefreshSchedule' + AND data__Identifier = '||' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, + json_extract_path_text(Properties, 'DataSetId') as data_set_id, + json_extract_path_text(Properties, 'Schedule', 'ScheduleId') as schedule__schedule_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::RefreshSchedule' + AND region = 'us-east-1' templates: name: templates id: aws.quicksight.templates @@ -13387,7 +13998,7 @@ components: x-identifiers: - AwsAccountId - TemplateId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -13404,9 +14015,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -13416,44 +14027,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/templates/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/templates/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AwsAccountId') as aws_account_id, - JSON_EXTRACT(Properties, '$.TemplateId') as template_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::Template' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, - json_extract_path_text(Properties, 'TemplateId') as template_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::Template' - AND region = 'us-east-1' - template: - name: template - id: aws.quicksight.template - x-cfn-schema-name: Template - x-cfn-type-name: AWS::QuickSight::Template - x-identifiers: - - AwsAccountId - - TemplateId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -13464,54 +14040,76 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/templates/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/templates/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/template/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/templates/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.Arn') as arn, - JSON_EXTRACT(Properties, '$.AwsAccountId') as aws_account_id, JSON_EXTRACT(Properties, '$.CreatedTime') as created_time, + JSON_EXTRACT(Properties, '$.VersionDescription') as version_description, + JSON_EXTRACT(Properties, '$.SourceEntity') as source_entity, JSON_EXTRACT(Properties, '$.Definition') as definition, JSON_EXTRACT(Properties, '$.LastUpdatedTime') as last_updated_time, + JSON_EXTRACT(Properties, '$.ValidationStrategy') as validation_strategy, JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Version') as version, + JSON_EXTRACT(Properties, '$.AwsAccountId') as aws_account_id, JSON_EXTRACT(Properties, '$.Permissions') as permissions, - JSON_EXTRACT(Properties, '$.SourceEntity') as source_entity, + JSON_EXTRACT(Properties, '$.Arn') as arn, JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.TemplateId') as template_id, - JSON_EXTRACT(Properties, '$.ValidationStrategy') as validation_strategy, - JSON_EXTRACT(Properties, '$.Version') as version, - JSON_EXTRACT(Properties, '$.VersionDescription') as version_description + JSON_EXTRACT(Properties, '$.TemplateId') as template_id FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::QuickSight::Template' AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, - json_extract_path_text(Properties, 'CreatedTime') as created_time, - json_extract_path_text(Properties, 'Definition') as definition, - json_extract_path_text(Properties, 'LastUpdatedTime') as last_updated_time, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Permissions') as permissions, - json_extract_path_text(Properties, 'SourceEntity') as source_entity, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'TemplateId') as template_id, - json_extract_path_text(Properties, 'ValidationStrategy') as validation_strategy, - json_extract_path_text(Properties, 'Version') as version, - json_extract_path_text(Properties, 'VersionDescription') as version_description - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::QuickSight::Template' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.AwsAccountId') as aws_account_id, + JSON_EXTRACT(Properties, '$.TemplateId') as template_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::Template' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'CreatedTime') as created_time, + json_extract_path_text(Properties, 'VersionDescription') as version_description, + json_extract_path_text(Properties, 'SourceEntity') as source_entity, + json_extract_path_text(Properties, 'Definition') as definition, + json_extract_path_text(Properties, 'LastUpdatedTime') as last_updated_time, + json_extract_path_text(Properties, 'ValidationStrategy') as validation_strategy, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Version') as version, + json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, + json_extract_path_text(Properties, 'Permissions') as permissions, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'TemplateId') as template_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::QuickSight::Template' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, + json_extract_path_text(Properties, 'TemplateId') as template_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::Template' + AND region = 'us-east-1' themes: name: themes id: aws.quicksight.themes @@ -13520,7 +14118,7 @@ components: x-identifiers: - ThemeId - AwsAccountId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -13537,9 +14135,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -13549,44 +14147,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/themes/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/themes/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ThemeId') as theme_id, - JSON_EXTRACT(Properties, '$.AwsAccountId') as aws_account_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::Theme' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ThemeId') as theme_id, - json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::Theme' - AND region = 'us-east-1' - theme: - name: theme - id: aws.quicksight.theme - x-cfn-schema-name: Theme - x-cfn-type-name: AWS::QuickSight::Theme - x-identifiers: - - ThemeId - - AwsAccountId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -13597,12 +14160,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/themes/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/themes/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/theme/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/themes/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -13624,27 +14191,45 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, - json_extract_path_text(Properties, 'BaseThemeId') as base_theme_id, - json_extract_path_text(Properties, 'Configuration') as configuration, - json_extract_path_text(Properties, 'CreatedTime') as created_time, - json_extract_path_text(Properties, 'LastUpdatedTime') as last_updated_time, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Permissions') as permissions, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'ThemeId') as theme_id, - json_extract_path_text(Properties, 'Type') as type, - json_extract_path_text(Properties, 'Version') as version, - json_extract_path_text(Properties, 'VersionDescription') as version_description - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::QuickSight::Theme' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.ThemeId') as theme_id, + JSON_EXTRACT(Properties, '$.AwsAccountId') as aws_account_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::Theme' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, + json_extract_path_text(Properties, 'BaseThemeId') as base_theme_id, + json_extract_path_text(Properties, 'Configuration') as configuration, + json_extract_path_text(Properties, 'CreatedTime') as created_time, + json_extract_path_text(Properties, 'LastUpdatedTime') as last_updated_time, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Permissions') as permissions, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'ThemeId') as theme_id, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'Version') as version, + json_extract_path_text(Properties, 'VersionDescription') as version_description + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::QuickSight::Theme' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ThemeId') as theme_id, + json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::Theme' + AND region = 'us-east-1' topics: name: topics id: aws.quicksight.topics @@ -13653,7 +14238,7 @@ components: x-identifiers: - AwsAccountId - TopicId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -13670,9 +14255,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -13682,44 +14267,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/topics/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/topics/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AwsAccountId') as aws_account_id, - JSON_EXTRACT(Properties, '$.TopicId') as topic_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::Topic' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, - json_extract_path_text(Properties, 'TopicId') as topic_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::Topic' - AND region = 'us-east-1' - topic: - name: topic - id: aws.quicksight.topic - x-cfn-schema-name: Topic - x-cfn-type-name: AWS::QuickSight::Topic - x-identifiers: - - AwsAccountId - - TopicId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -13730,12 +14280,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/topics/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/topics/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/topic/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/topics/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -13751,21 +14305,39 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, - json_extract_path_text(Properties, 'DataSets') as data_sets, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'TopicId') as topic_id, - json_extract_path_text(Properties, 'UserExperienceVersion') as user_experience_version - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::QuickSight::Topic' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.AwsAccountId') as aws_account_id, + JSON_EXTRACT(Properties, '$.TopicId') as topic_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::Topic' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, + json_extract_path_text(Properties, 'DataSets') as data_sets, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'TopicId') as topic_id, + json_extract_path_text(Properties, 'UserExperienceVersion') as user_experience_version + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::QuickSight::Topic' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, + json_extract_path_text(Properties, 'TopicId') as topic_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::Topic' + AND region = 'us-east-1' vpc_connections: name: vpc_connections id: aws.quicksight.vpc_connections @@ -13774,7 +14346,7 @@ components: x-identifiers: - AwsAccountId - VPCConnectionId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -13791,9 +14363,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -13803,44 +14375,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/vpc_connections/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/vpc_connections/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AwsAccountId') as aws_account_id, - JSON_EXTRACT(Properties, '$.VPCConnectionId') as vpc_connection_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::VPCConnection' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, - json_extract_path_text(Properties, 'VPCConnectionId') as vpc_connection_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::VPCConnection' - AND region = 'us-east-1' - vpc_connection: - name: vpc_connection - id: aws.quicksight.vpc_connection - x-cfn-schema-name: VPCConnection - x-cfn-type-name: AWS::QuickSight::VPCConnection - x-identifiers: - - AwsAccountId - - VPCConnectionId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -13851,58 +14388,80 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/vpc_connections/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/vpc_connections/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/vpc_connection/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/vpc_connections/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.AvailabilityStatus') as availability_status, JSON_EXTRACT(Properties, '$.AwsAccountId') as aws_account_id, - JSON_EXTRACT(Properties, '$.Name') as name, - JSON_EXTRACT(Properties, '$.VPCConnectionId') as vpc_connection_id, - JSON_EXTRACT(Properties, '$.VPCId') as vpc_id, - JSON_EXTRACT(Properties, '$.SecurityGroupIds') as security_group_ids, - JSON_EXTRACT(Properties, '$.SubnetIds') as subnet_ids, + JSON_EXTRACT(Properties, '$.CreatedTime') as created_time, JSON_EXTRACT(Properties, '$.DnsResolvers') as dns_resolvers, - JSON_EXTRACT(Properties, '$.Status') as status, - JSON_EXTRACT(Properties, '$.AvailabilityStatus') as availability_status, + JSON_EXTRACT(Properties, '$.LastUpdatedTime') as last_updated_time, + JSON_EXTRACT(Properties, '$.Name') as name, JSON_EXTRACT(Properties, '$.NetworkInterfaces') as network_interfaces, JSON_EXTRACT(Properties, '$.RoleArn') as role_arn, - JSON_EXTRACT(Properties, '$.CreatedTime') as created_time, - JSON_EXTRACT(Properties, '$.LastUpdatedTime') as last_updated_time, - JSON_EXTRACT(Properties, '$.Tags') as tags + JSON_EXTRACT(Properties, '$.SecurityGroupIds') as security_group_ids, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.SubnetIds') as subnet_ids, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.VPCConnectionId') as vpc_connection_id, + JSON_EXTRACT(Properties, '$.VPCId') as vpc_id FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::QuickSight::VPCConnection' AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'VPCConnectionId') as vpc_connection_id, - json_extract_path_text(Properties, 'VPCId') as vpc_id, - json_extract_path_text(Properties, 'SecurityGroupIds') as security_group_ids, - json_extract_path_text(Properties, 'SubnetIds') as subnet_ids, - json_extract_path_text(Properties, 'DnsResolvers') as dns_resolvers, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'AvailabilityStatus') as availability_status, - json_extract_path_text(Properties, 'NetworkInterfaces') as network_interfaces, - json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'CreatedTime') as created_time, - json_extract_path_text(Properties, 'LastUpdatedTime') as last_updated_time, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::QuickSight::VPCConnection' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.AwsAccountId') as aws_account_id, + JSON_EXTRACT(Properties, '$.VPCConnectionId') as vpc_connection_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::VPCConnection' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'AvailabilityStatus') as availability_status, + json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, + json_extract_path_text(Properties, 'CreatedTime') as created_time, + json_extract_path_text(Properties, 'DnsResolvers') as dns_resolvers, + json_extract_path_text(Properties, 'LastUpdatedTime') as last_updated_time, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'NetworkInterfaces') as network_interfaces, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'SecurityGroupIds') as security_group_ids, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'SubnetIds') as subnet_ids, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'VPCConnectionId') as vpc_connection_id, + json_extract_path_text(Properties, 'VPCId') as vpc_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::QuickSight::VPCConnection' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AwsAccountId') as aws_account_id, + json_extract_path_text(Properties, 'VPCConnectionId') as vpc_connection_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::QuickSight::VPCConnection' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/ram.yaml b/providers/src/aws/v00.00.00000/services/ram.yaml index 78748564..fd32824c 100644 --- a/providers/src/aws/v00.00.00000/services/ram.yaml +++ b/providers/src/aws/v00.00.00000/services/ram.yaml @@ -536,7 +536,7 @@ components: x-cfn-type-name: AWS::RAM::Permission x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -553,9 +553,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -565,41 +565,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/permissions/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/permissions/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RAM::Permission' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RAM::Permission' - AND region = 'us-east-1' - permission: - name: permission - id: aws.ram.permission - x-cfn-schema-name: Permission - x-cfn-type-name: AWS::RAM::Permission - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -610,12 +578,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/permissions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/permissions/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/permission/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/permissions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -632,22 +604,38 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Version') as version, - json_extract_path_text(Properties, 'IsResourceTypeDefault') as is_resource_type_default, - json_extract_path_text(Properties, 'PermissionType') as permission_type, - json_extract_path_text(Properties, 'ResourceType') as resource_type, - json_extract_path_text(Properties, 'PolicyTemplate') as policy_template, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::RAM::Permission' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RAM::Permission' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Version') as version, + json_extract_path_text(Properties, 'IsResourceTypeDefault') as is_resource_type_default, + json_extract_path_text(Properties, 'PermissionType') as permission_type, + json_extract_path_text(Properties, 'ResourceType') as resource_type, + json_extract_path_text(Properties, 'PolicyTemplate') as policy_template, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::RAM::Permission' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RAM::Permission' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/rds.yaml b/providers/src/aws/v00.00.00000/services/rds.yaml index 8ec10cba..ced735a6 100644 --- a/providers/src/aws/v00.00.00000/services/rds.yaml +++ b/providers/src/aws/v00.00.00000/services/rds.yaml @@ -532,19 +532,27 @@ components: - rds:DescribeDBEngineVersions list: - rds:DescribeDBEngineVersions - Endpoint: - type: object + MasterUserSecret: + description: |- + The ``MasterUserSecret`` return value specifies the secret managed by RDS in AWS Secrets Manager for the master user password. + For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide* and [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) in the *Amazon Aurora User Guide.* additionalProperties: false + type: object properties: - Address: - type: string - description: Specifies the DNS address of the DB instance. - Port: + SecretArn: + description: The Amazon Resource Name (ARN) of the secret. type: string - description: Specifies the port that the database engine is listening on. - HostedZoneId: + KmsKeyId: + description: The AWS KMS key identifier that is used to encrypt the secret. + anyOf: + - relationshipRef: + typeName: AWS::KMS::Key + propertyPath: /properties/KeyId + - relationshipRef: + typeName: AWS::KMS::Key + propertyPath: /properties/Arn type: string - description: Specifies the ID that Amazon Route 53 assigns when you create a hosted zone. + Endpoint: description: |- This data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a response element in the following actions: + ``CreateDBInstance`` @@ -552,30 +560,22 @@ components: + ``DeleteDBInstance`` For the data structure that represents Amazon Aurora DB cluster endpoints, see ``DBClusterEndpoint``. - ReadEndpoint: - type: object additionalProperties: false + type: object properties: Address: - description: The reader endpoint for the DB cluster. + description: Specifies the DNS address of the DB instance. type: string - DBClusterRole: - description: Describes an AWS Identity and Access Management (IAM) role that is associated with a DB cluster. - type: object - additionalProperties: false - properties: - FeatureName: - description: The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion in the Amazon RDS API Reference. + Port: + description: Specifies the port that the database engine is listening on. type: string - RoleArn: - description: The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster. + HostedZoneId: + description: Specifies the ID that Amazon Route 53 assigns when you create a hosted zone. type: string - required: - - RoleArn ServerlessV2ScalingConfiguration: description: Contains the scaling configuration of an Aurora Serverless v2 DB cluster. - type: object additionalProperties: false + type: object properties: MinCapacity: description: The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5. @@ -585,19 +585,28 @@ components: type: number ScalingConfiguration: description: The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster. - type: object additionalProperties: false + type: object properties: + TimeoutAction: + description: |- + The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange. + ForceApplyCapacityChange sets the capacity to the specified value as soon as possible. + RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period. + + For more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide. + type: string + SecondsBeforeTimeout: + description: |- + The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. + The default is 300. + type: integer + SecondsUntilAutoPause: + description: The time, in seconds, before an Aurora DB cluster in serverless mode is paused. + type: integer AutoPause: description: A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections). type: boolean - MaxCapacity: - description: |- - The maximum capacity for an Aurora DB cluster in serverless DB engine mode. - For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. - For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384. - The maximum capacity must be greater than or equal to the minimum capacity. - type: integer MinCapacity: description: |- The minimum capacity for an Aurora DB cluster in serverless DB engine mode. @@ -605,259 +614,274 @@ components: For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384. The minimum capacity must be less than or equal to the maximum capacity. type: integer - SecondsBeforeTimeout: + MaxCapacity: description: |- - The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. - The default is 300. - type: integer - SecondsUntilAutoPause: - description: The time, in seconds, before an Aurora DB cluster in serverless mode is paused. + The maximum capacity for an Aurora DB cluster in serverless DB engine mode. + For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. + For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384. + The maximum capacity must be greater than or equal to the minimum capacity. type: integer - TimeoutAction: - description: |- - The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange. - ForceApplyCapacityChange sets the capacity to the specified value as soon as possible. - RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period. - - For more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide. - type: string - MasterUserSecret: + ReadEndpoint: + additionalProperties: false type: object + properties: + Address: + description: The reader endpoint for the DB cluster. + type: string + DBClusterRole: + description: Describes an AWS Identity and Access Management (IAM) role that is associated with a DB cluster. additionalProperties: false + type: object properties: - SecretArn: + RoleArn: + x-relationshipRef: + typeName: AWS::IAM::Role + propertyPath: /properties/Arn + description: The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster. type: string - description: The Amazon Resource Name (ARN) of the secret. - KmsKeyId: + FeatureName: + description: The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion in the Amazon RDS API Reference. type: string - description: The AWS KMS key identifier that is used to encrypt the secret. - description: |- - The ``MasterUserSecret`` return value specifies the secret managed by RDS in AWS Secrets Manager for the master user password. - For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide* and [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) in the *Amazon Aurora User Guide.* + required: + - RoleArn DBCluster: type: object properties: + StorageEncrypted: + description: |- + Indicates whether the DB instance is encrypted. + If you specify the DBClusterIdentifier, SnapshotIdentifier, or SourceDBInstanceIdentifier property, don't specify this property. The value is inherited from the cluster, snapshot, or source DB instance. + type: boolean + DBSystemId: + description: Reserved for future use. + type: string + RestoreToTime: + description: 'The date and time to restore the DB cluster to. Value must be a time in Universal Coordinated Time (UTC) format. An example: 2015-03-07T23:45:00Z' + type: string + EngineMode: + description: The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster. + type: string + Port: + description: 'The port number on which the instances in the DB cluster accept connections. Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql.' + type: integer + DBClusterIdentifier: + minLength: 1 + pattern: ^[a-zA-Z]{1}(?:-?[a-zA-Z0-9]){0,62}$ + description: The DB cluster identifier. This parameter is stored as a lowercase string. + type: string + maxLength: 63 + StorageThroughput: + description: Specifies the storage throughput value for the DB cluster. This setting applies only to the gp3 storage type. + type: integer + MonitoringInterval: + default: 0 + description: The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0. The default is 0. + type: integer Endpoint: $ref: '#/components/schemas/Endpoint' - ReadEndpoint: - $ref: '#/components/schemas/ReadEndpoint' - AllocatedStorage: - description: The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster. - type: integer - AssociatedRoles: - description: Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf. - type: array + ReplicationSourceIdentifier: + description: The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica. + type: string + Engine: + description: 'The name of the database engine to be used for this DB cluster. Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql' + type: string + Tags: + maxItems: 50 uniqueItems: true - items: - $ref: '#/components/schemas/DBClusterRole' - AvailabilityZones: - description: A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide. + description: An array of key-value pairs to apply to this resource. + x-insertionOrder: false type: array - uniqueItems: true items: - type: string - AutoMinorVersionUpgrade: - description: A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically. - type: boolean - BacktrackWindow: - description: The target backtrack window, in seconds. To disable backtracking, set this value to 0. - default: 0 - minimum: 0 - type: integer - BackupRetentionPeriod: - description: The number of days for which automated backups are retained. - default: 1 - minimum: 1 + $ref: '#/components/schemas/Tag' + EngineVersion: + description: The version number of the database engine to use. + type: string + StorageType: + description: Specifies the storage type to be associated with the DB cluster. + type: string + KmsKeyId: + description: The Amazon Resource Name (ARN) of the AWS Key Management Service master key that is used to encrypt the database instances in the DB cluster, such as arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. If you enable the StorageEncrypted property but don't specify this property, the default master key is used. If you specify this property, you must set the StorageEncrypted property to true. + anyOf: + - relationshipRef: + typeName: AWS::KMS::Key + propertyPath: /properties/Arn + - relationshipRef: + typeName: AWS::KMS::Key + propertyPath: /properties/KeyId + type: string + ServerlessV2ScalingConfiguration: + description: Contains the scaling configuration of an Aurora Serverless v2 DB cluster. + $ref: '#/components/schemas/ServerlessV2ScalingConfiguration' + PerformanceInsightsRetentionPeriod: + description: The amount of time, in days, to retain Performance Insights data. type: integer - CopyTagsToSnapshot: - description: A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them. - type: boolean DatabaseName: description: The name of your database. If you don't provide a name, then Amazon RDS won't create a database in this DB cluster. For naming constraints, see Naming Constraints in the Amazon RDS User Guide. type: string - DBClusterArn: - type: string - description: The Amazon Resource Name (ARN) for the DB cluster. - DBClusterInstanceClass: - description: The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge. - type: string DBClusterResourceId: description: The AWS Region-unique, immutable identifier for the DB cluster. type: string - DBInstanceParameterGroupName: - description: The name of the DB parameter group to apply to all instances of the DB cluster. - type: string - DBSystemId: - description: Reserved for future use. + AutoMinorVersionUpgrade: + description: A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically. + type: boolean + DBSubnetGroupName: + description: A DB subnet group that you want to associate with this DB cluster. type: string - GlobalClusterIdentifier: - description: |- - If you are configuring an Aurora global database cluster and want your Aurora DB cluster to be a secondary member in the global database cluster, specify the global cluster ID of the global database cluster. To define the primary database cluster of the global cluster, use the AWS::RDS::GlobalCluster resource. - - If you aren't configuring a global database cluster, don't specify this property. + DeletionProtection: + description: A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. + type: boolean + AllocatedStorage: + description: The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster. + type: integer + MasterUserPassword: + description: The master password for the DB instance. type: string - pattern: ^$|^[a-zA-Z]{1}(?:-?[a-zA-Z0-9]){0,62}$ - minLength: 0 - maxLength: 63 - DBClusterIdentifier: - description: The DB cluster identifier. This parameter is stored as a lowercase string. + MasterUserSecret: + description: Contains the secret managed by RDS in AWS Secrets Manager for the master user password. + $ref: '#/components/schemas/MasterUserSecret' + SourceDBClusterIdentifier: + description: The identifier of the source DB cluster from which to restore. type: string - pattern: ^[a-zA-Z]{1}(?:-?[a-zA-Z0-9]){0,62}$ + MasterUsername: minLength: 1 - maxLength: 63 - DBClusterParameterGroupName: - description: The name of the DB cluster parameter group to associate with this DB cluster. + pattern: ^[a-zA-Z]{1}[a-zA-Z0-9_]*$ + description: The name of the master user for the DB cluster. You must specify MasterUsername, unless you specify SnapshotIdentifier. In that case, don't specify MasterUsername. type: string - default: default.aurora5.6 - DBSubnetGroupName: - description: A DB subnet group that you want to associate with this DB cluster. + ScalingConfiguration: + description: The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster. + $ref: '#/components/schemas/ScalingConfiguration' + ReadEndpoint: + $ref: '#/components/schemas/ReadEndpoint' + PerformanceInsightsKmsKeyId: + description: The Amazon Web Services KMS key identifier for encryption of Performance Insights data. type: string - DeletionProtection: - description: A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. + PubliclyAccessible: + description: A value that indicates whether the DB cluster is publicly accessible. type: boolean Domain: description: The Active Directory directory ID to create the DB cluster in. type: string - DomainIAMRoleName: - description: Specify the name of the IAM role to be used when making API calls to the Directory Service. - type: string - EnableCloudwatchLogsExports: - description: The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide. - type: array - uniqueItems: true - items: - type: string + BacktrackWindow: + default: 0 + description: The target backtrack window, in seconds. To disable backtracking, set this value to 0. + type: integer + minimum: 0 + DBInstanceParameterGroupName: + description: The name of the DB parameter group to apply to all instances of the DB cluster. + type: string EnableGlobalWriteForwarding: description: Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database. type: boolean - EnableHttpEndpoint: - description: A value that indicates whether to enable the HTTP endpoint for DB cluster. By default, the HTTP endpoint is disabled. - type: boolean - EnableIAMDatabaseAuthentication: - description: A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. - type: boolean - Engine: - description: 'The name of the database engine to be used for this DB cluster. Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql' - type: string - EngineMode: - description: The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster. - type: string - EngineVersion: - description: The version number of the database engine to use. - type: string - ManageMasterUserPassword: - description: A value that indicates whether to manage the master user password with AWS Secrets Manager. - type: boolean - Iops: - description: The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster. - type: integer - KmsKeyId: - description: The Amazon Resource Name (ARN) of the AWS Key Management Service master key that is used to encrypt the database instances in the DB cluster, such as arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. If you enable the StorageEncrypted property but don't specify this property, the default master key is used. If you specify this property, you must set the StorageEncrypted property to true. - type: string - MasterUsername: - description: The name of the master user for the DB cluster. You must specify MasterUsername, unless you specify SnapshotIdentifier. In that case, don't specify MasterUsername. - type: string - pattern: ^[a-zA-Z]{1}[a-zA-Z0-9_]*$ - minLength: 1 - MasterUserPassword: - description: The master password for the DB instance. - type: string - MasterUserSecret: - $ref: '#/components/schemas/MasterUserSecret' - description: Contains the secret managed by RDS in AWS Secrets Manager for the master user password. - MonitoringInterval: - description: The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0. The default is 0. - type: integer - default: 0 MonitoringRoleArn: description: The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. type: string - NetworkType: - description: The network type of the DB cluster. - type: string - PerformanceInsightsEnabled: - description: A value that indicates whether to turn on Performance Insights for the DB cluster. + AssociatedRoles: + uniqueItems: true + description: Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf. + type: array + items: + $ref: '#/components/schemas/DBClusterRole' + EnableHttpEndpoint: + description: A value that indicates whether to enable the HTTP endpoint for DB cluster. By default, the HTTP endpoint is disabled. type: boolean - PerformanceInsightsKmsKeyId: - description: The Amazon Web Services KMS key identifier for encryption of Performance Insights data. + SnapshotIdentifier: + description: >- + The identifier for the DB snapshot or DB cluster snapshot to restore from. + + You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot. + + After you restore a DB cluster with a SnapshotIdentifier property, you must specify the same SnapshotIdentifier property for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed. However, if you don't specify the SnapshotIdentifier property, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different + from the previous snapshot restore property, the DB cluster is restored from the specified SnapshotIdentifier property, and the original DB cluster is deleted. type: string - PerformanceInsightsRetentionPeriod: - description: The amount of time, in days, to retain Performance Insights data. - type: integer - Port: - description: 'The port number on which the instances in the DB cluster accept connections. Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql.' - type: integer PreferredBackupWindow: description: The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide. type: string - PreferredMaintenanceWindow: - description: The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide. + NetworkType: + description: The network type of the DB cluster. type: string - PubliclyAccessible: - description: A value that indicates whether the DB cluster is publicly accessible. + VpcSecurityGroupIds: + uniqueItems: true + description: A list of EC2 VPC security groups to associate with this DB cluster. + type: array + items: + anyOf: + - relationshipRef: + typeName: AWS::EC2::SecurityGroup + propertyPath: /properties/GroupId + - relationshipRef: + typeName: AWS::EC2::SecurityGroup + propertyPath: /properties/Id + type: string + CopyTagsToSnapshot: + description: A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them. type: boolean - ReplicationSourceIdentifier: - description: The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica. - type: string - RestoreToTime: - description: 'The date and time to restore the DB cluster to. Value must be a time in Universal Coordinated Time (UTC) format. An example: 2015-03-07T23:45:00Z' + GlobalClusterIdentifier: + minLength: 0 + pattern: ^$|^[a-zA-Z]{1}(?:-?[a-zA-Z0-9]){0,62}$ + description: |- + If you are configuring an Aurora global database cluster and want your Aurora DB cluster to be a secondary member in the global database cluster, specify the global cluster ID of the global database cluster. To define the primary database cluster of the global cluster, use the AWS::RDS::GlobalCluster resource. + + If you aren't configuring a global database cluster, don't specify this property. type: string + maxLength: 63 RestoreType: + default: full-copy description: |- The type of restore to be performed. You can specify one of the following values: full-copy - The new DB cluster is restored as a full copy of the source DB cluster. copy-on-write - The new DB cluster is restored as a clone of the source DB cluster. type: string - default: full-copy - ServerlessV2ScalingConfiguration: - description: Contains the scaling configuration of an Aurora Serverless v2 DB cluster. - $ref: '#/components/schemas/ServerlessV2ScalingConfiguration' - ScalingConfiguration: - description: The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster. - $ref: '#/components/schemas/ScalingConfiguration' - SnapshotIdentifier: - description: >- - The identifier for the DB snapshot or DB cluster snapshot to restore from. - - You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot. - - After you restore a DB cluster with a SnapshotIdentifier property, you must specify the same SnapshotIdentifier property for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed. However, if you don't specify the SnapshotIdentifier property, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different - from the previous snapshot restore property, the DB cluster is restored from the specified SnapshotIdentifier property, and the original DB cluster is deleted. + DomainIAMRoleName: + description: Specify the name of the IAM role to be used when making API calls to the Directory Service. type: string - SourceDBClusterIdentifier: - description: The identifier of the source DB cluster from which to restore. + DBClusterInstanceClass: + description: The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge. type: string - SourceRegion: - description: The AWS Region which contains the source DB cluster when replicating a DB cluster. For example, us-east-1. + AvailabilityZones: + uniqueItems: true + description: A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide. + type: array + items: + type: string + DBClusterArn: + description: The Amazon Resource Name (ARN) for the DB cluster. type: string - StorageEncrypted: - description: |- - Indicates whether the DB instance is encrypted. - If you specify the DBClusterIdentifier, SnapshotIdentifier, or SourceDBInstanceIdentifier property, don't specify this property. The value is inherited from the cluster, snapshot, or source DB instance. - type: boolean - StorageThroughput: - description: Specifies the storage throughput value for the DB cluster. This setting applies only to the gp3 storage type. + PreferredMaintenanceWindow: + description: The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide. + type: string + Iops: + description: The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster. type: integer - StorageType: - description: Specifies the storage type to be associated with the DB cluster. + SourceRegion: + description: The AWS Region which contains the source DB cluster when replicating a DB cluster. For example, us-east-1. type: string - Tags: - type: array - maxItems: 50 - uniqueItems: true - x-insertionOrder: false - description: An array of key-value pairs to apply to this resource. - items: - $ref: '#/components/schemas/Tag' UseLatestRestorableTime: description: A value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster is not restored to the latest restorable backup time. type: boolean - VpcSecurityGroupIds: - description: A list of EC2 VPC security groups to associate with this DB cluster. + ManageMasterUserPassword: + description: A value that indicates whether to manage the master user password with AWS Secrets Manager. + type: boolean + EnableIAMDatabaseAuthentication: + description: A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. + type: boolean + DBClusterParameterGroupName: + default: default.aurora5.6 + description: The name of the DB cluster parameter group to associate with this DB cluster. + type: string + PerformanceInsightsEnabled: + description: A value that indicates whether to turn on Performance Insights for the DB cluster. + type: boolean + BackupRetentionPeriod: + default: 1 + description: The number of days for which automated backups are retained. + type: integer + minimum: 1 + EnableCloudwatchLogsExports: uniqueItems: true + description: The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide. + type: array items: type: string - type: array x-stackql-resource-name: db_cluster description: The AWS::RDS::DBCluster resource creates an Amazon Aurora DB cluster. x-type-name: AWS::RDS::DBCluster @@ -903,6 +927,8 @@ components: - MasterUserSecret/SecretArn - StorageThroughput x-required-permissions: + read: + - rds:DescribeDBClusters create: - iam:CreateServiceLinkedRole - iam:PassRole @@ -918,8 +944,6 @@ components: - rds:RestoreDBClusterToPointInTime - secretsmanager:CreateSecret - secretsmanager:TagResource - read: - - rds:DescribeDBClusters update: - ec2:DescribeSecurityGroups - iam:PassRole @@ -938,6 +962,8 @@ components: - rds:RemoveTagsFromResource - secretsmanager:CreateSecret - secretsmanager:TagResource + list: + - rds:DescribeDBClusters delete: - rds:CreateDBClusterSnapshot - rds:DeleteDBCluster @@ -945,8 +971,6 @@ components: - rds:DescribeDBClusters - rds:DescribeGlobalClusters - rds:RemoveFromGlobalCluster - list: - - rds:DescribeDBClusters DBClusterParameterGroup: type: object properties: @@ -1018,430 +1042,426 @@ components: list: - rds:DescribeDBClusterParameterGroups CertificateDetails: - type: object + description: |- + Returns the details of the DB instance’s server certificate. + For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) in the *Amazon RDS User Guide* and [Using SSL/TLS to encrypt a connection to a DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) in the *Amazon Aurora User Guide*. additionalProperties: false + type: object properties: - CAIdentifier: - type: string - description: The CA identifier of the CA certificate used for the DB instance's server certificate. ValidTill: - type: string format: date-time description: The expiration date of the DB instance’s server certificate. - description: |- - Returns the details of the DB instance’s server certificate. - For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) in the *Amazon RDS User Guide* and [Using SSL/TLS to encrypt a connection to a DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) in the *Amazon Aurora User Guide*. + type: string + CAIdentifier: + description: The CA identifier of the CA certificate used for the DB instance's server certificate. + type: string DBInstanceRole: - type: object + description: Information about an AWS Identity and Access Management (IAM) role that is associated with a DB instance. additionalProperties: false + type: object properties: - FeatureName: + RoleArn: + description: The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance. type: string + FeatureName: description: The name of the feature associated with the AWS Identity and Access Management (IAM) role. IAM roles that are associated with a DB instance grant permission for the DB instance to access other AWS services on your behalf. For the list of supported feature names, see the ``SupportedFeatureNames`` description in [DBEngineVersion](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DBEngineVersion.html) in the *Amazon RDS API Reference*. - RoleArn: type: string - description: The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance. required: - FeatureName - RoleArn - description: Information about an AWS Identity and Access Management (IAM) role that is associated with a DB instance. ProcessorFeature: - type: object + description: The ``ProcessorFeature`` property type specifies the processor features of a DB instance class status. additionalProperties: false + type: object properties: + Value: + description: The value of a processor feature name. + type: string Name: + description: The name of the processor feature. Valid names are ``coreCount`` and ``threadsPerCore``. type: string enum: - coreCount - threadsPerCore - description: The name of the processor feature. Valid names are ``coreCount`` and ``threadsPerCore``. - Value: - type: string - description: The value of a processor feature name. - description: The ``ProcessorFeature`` property type specifies the processor features of a DB instance class status. DBInstance: type: object properties: - AllocatedStorage: - type: string + StorageEncrypted: description: |- - The amount of storage in gibibytes (GiB) to be initially allocated for the database instance. - If any value is set in the ``Iops`` parameter, ``AllocatedStorage`` must be at least 100 GiB, which corresponds to the minimum Iops value of 1,000. If you increase the ``Iops`` value (in 1,000 IOPS increments), then you must also increase the ``AllocatedStorage`` value (in 100-GiB increments). - *Amazon Aurora* - Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume. - *Db2* - Constraints to the amount of storage for each storage type are the following: - + General Purpose (SSD) storage (gp3): Must be an integer from 20 to 64000. - + Provisioned IOPS storage (io1): Must be an integer from 100 to 64000. - - *MySQL* - Constraints to the amount of storage for each storage type are the following: - + General Purpose (SSD) storage (gp2): Must be an integer fro - pattern: ^[0-9]*$ - AllowMajorVersionUpgrade: + A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted. + If you specify the ``KmsKeyId`` property, then you must enable encryption. + If you specify the ``SourceDBInstanceIdentifier`` property, don't specify this property. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specified ``KmsKeyId`` property is used. + If you specify ``DBSnapshotIdentifier`` property, don't specify this property. The value is inherited from the snapshot. + *Amazon Aurora* + Not applicable. The encryption for DB instances is managed by the DB cluster. type: boolean + Timezone: + description: The time zone of the DB instance. The time zone parameter is currently supported only by [RDS for Db2](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-time-zone) and [RDS for SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone). + type: string + DBSystemId: + description: The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. In this context, the term "Oracle database instance" refers exclusively to the system global area (SGA) and Oracle background processes. If you don't specify a SID, the value defaults to ``RDSCDB``. The Oracle SID is also the name of your CDB. + type: string + CertificateDetails: + description: The details of the DB instance's server certificate. + $ref: '#/components/schemas/CertificateDetails' + Port: + pattern: ^\d*$ description: |- - A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. - Constraints: Major version upgrades must be allowed when specifying a value for the ``EngineVersion`` parameter that is a different major version than the DB instance's current version. - AssociatedRoles: - type: array - items: - $ref: '#/components/schemas/DBInstanceRole' - description: |- - The IAMlong (IAM) roles associated with the DB instance. + The port number on which the database accepts connections. *Amazon Aurora* - Not applicable. The associated roles are managed by the DB cluster. - AutoMinorVersionUpgrade: - type: boolean - description: A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically. - AutomaticBackupReplicationRegion: + Not applicable. The port number is managed by the DB cluster. + *Db2* + Default value: ``50000`` type: string - description: The destination region for the backup replication of the DB instance. For more info, see [Replicating automated backups to another Region](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReplicateBackups.html) in the *Amazon RDS User Guide*. - AvailabilityZone: + DBClusterIdentifier: + description: The identifier of the DB cluster that the instance will belong to. type: string + StorageThroughput: description: |- - The Availability Zone (AZ) where the database will be created. For information on AWS-Regions and Availability Zones, see [Regions and Availability Zones](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html). - For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one. - Default: A random, system-chosen Availability Zone in the endpoint's AWS-Region. - Constraints: - + The ``AvailabilityZone`` parameter can't be specified if the DB instance is a Multi-AZ deployment. - + The specified Availability Zone must be in the same AWS-Region as the current endpoint. - - Example: ``us-east-1d`` - BackupRetentionPeriod: + Specifies the storage throughput value for the DB instance. This setting applies only to the ``gp3`` storage type. + This setting doesn't apply to RDS Custom or Amazon Aurora. type: integer - minimum: 0 - default: 1 - description: |- - The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. - *Amazon Aurora* - Not applicable. The retention period for automated backups is managed by the DB cluster. - Default: 1 - Constraints: - + Must be a value from 0 to 35 - + Can't be set to 0 if the DB instance is a source to read replicas - CACertificateIdentifier: + DbiResourceId: + description: '' type: string + MonitoringInterval: + default: 0 description: |- - The identifier of the CA certificate for this DB instance. - For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) in the *Amazon RDS User Guide* and [Using SSL/TLS to encrypt a connection to a DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) in the *Amazon Aurora User Guide*. - CertificateDetails: - $ref: '#/components/schemas/CertificateDetails' - description: The details of the DB instance's server certificate. - CertificateRotationRestart: - type: boolean + The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0. The default is 0. + If ``MonitoringRoleArn`` is specified, then you must set ``MonitoringInterval`` to a value other than 0. + This setting doesn't apply to RDS Custom. + Valid Values: ``0, 1, 5, 10, 15, 30, 60`` + type: integer + DBParameterGroupName: description: |- - Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate. - By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted. - Set this parameter only if you are *not* using SSL/TLS to connect to the DB instance. - If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate: - + For more information about rotating your SSL/TLS certificate for RDS DB engines, see [Rotating Your SSL/TLS Certificate.](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon RDS User Guide.* - + For more information about rotating your SSL/TLS certificate for Aurora DB engines, see [Rotating Your SSL/TLS Certificate](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon Aurora User Gui - CharacterSetName: + The name of an existing DB parameter group or a reference to an [AWS::RDS::DBParameterGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html) resource created in the template. + To list all of the available DB parameter group names, use the following command: + ``aws rds describe-db-parameter-groups --query "DBParameterGroups[].DBParameterGroupName" --output text`` + If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot. + If you don't specify a value for ``DBParameterGroupName`` property, the default DB parameter group for the specified engine and engine version is used. + type: string + DBInstanceArn: + description: '' type: string + Endpoint: description: |- - For supported engines, indicates that the DB instance should be associated with the specified character set. + The connection endpoint for the DB instance. + The endpoint might not be shown for instances with the status of ``creating``. + $ref: '#/components/schemas/Endpoint' + TdeCredentialArn: + description: '' + type: string + AutomaticBackupReplicationKmsKeyId: + description: The AWS KMS key identifier for encryption of the replicated automated backups. The KMS key ID is the Amazon Resource Name (ARN) for the KMS encryption key in the destination AWS-Region, for example, ``arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE``. + type: string + MultiAZ: + description: |- + Specifies whether the database instance is a Multi-AZ DB instance deployment. You can't set the ``AvailabilityZone`` parameter if the ``MultiAZ`` parameter is set to true. + For more information, see [Multi-AZ deployments for high availability](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.MultiAZ.html) in the *Amazon RDS User Guide*. *Amazon Aurora* - Not applicable. The character set is managed by the DB cluster. For more information, see [AWS::RDS::DBCluster](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html). - CopyTagsToSnapshot: + Not applicable. Amazon Aurora storage is replicated across all of the Availability Zones and doesn't require the ``MultiAZ`` option to be set. type: boolean + Engine: description: |- - Specifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied. - This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. - CustomIAMInstanceProfile: + The name of the database engine to use for this DB instance. Not every database engine is available in every AWS Region. + This property is required when creating a DB instance. + You can convert an Oracle database from the non-CDB architecture to the container database (CDB) architecture by updating the ``Engine`` value in your templates from ``oracle-ee`` to ``oracle-ee-cdb`` or from ``oracle-se2`` to ``oracle-se2-cdb``. Converting to the CDB architecture requires an interruption. + Valid Values: + + ``aurora-mysql`` (for Aurora MySQL DB instances) + + ``aurora-postgresql`` (for Aurora PostgreSQL DB instances) + + ``custom-oracle-ee`` (for RDS Custom for Oracle DB instances) + + ``custom-oracle-ee-cdb`` (for RDS Custom for Oracle DB instances) + + ``custom-sqlserver-ee`` (for RDS Custom for SQL Server DB instances) + + ``custom-sqlserver-se`` (for RDS Custom for SQL Server DB instances) + + ``custom-sqlserver-web`` (for RDS Custom for SQL Server DB instances) + + ``db2-ae`` + + ``db2-se`` + + ``mariadb`` + + ``mysql`` + + ``oracle-ee`` + + ``oracle-ee-cdb`` + + ``oracle-se2`` + + ``oracle-se2-cdb`` + + ``postgres`` + + ``sqlserver-ee`` + + ``sqlserver-se`` + + ``sqlserver-ex`` + + ``sqlserver-web`` type: string + Tags: + uniqueItems: false + description: An optional array of key-value pairs to apply to this DB instance. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Tag' + PerformanceInsightsKMSKeyId: description: |- - The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. - This setting is required for RDS Custom. - Constraints: - + The profile must exist in your account. - + The profile must have an IAM role that Amazon EC2 has permissions to assume. - + The instance profile name and the associated IAM role name must start with the prefix ``AWSRDSCustom``. - - For the list of permissions required for the IAM role, see [Configure IAM and your VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc) in the *Amazon RDS User Guide*. - DBClusterIdentifier: + The AWS KMS key identifier for encryption of Performance Insights data. + The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. + If you do not specify a value for ``PerformanceInsightsKMSKeyId``, then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region. + For information about enabling Performance Insights, see [EnablePerformanceInsights](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-enableperformanceinsights). + anyOf: + - relationshipRef: + typeName: AWS::KMS::Key + propertyPath: /properties/Arn + - relationshipRef: + typeName: AWS::KMS::Key + propertyPath: /properties/KeyId type: string - description: The identifier of the DB cluster that the instance will belong to. - DBClusterSnapshotIdentifier: + TdeCredentialPassword: + description: '' type: string + SourceDBInstanceIdentifier: description: |- - The identifier for the RDS for MySQL Multi-AZ DB cluster snapshot to restore from. - For more information on Multi-AZ DB clusters, see [Multi-AZ DB cluster deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User Guide*. - Constraints: - + Must match the identifier of an existing Multi-AZ DB cluster snapshot. - + Can't be specified when ``DBSnapshotIdentifier`` is specified. - + Must be specified when ``DBSnapshotIdentifier`` isn't specified. - + If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the ``DBClusterSnapshotIdentifier`` must be the ARN of the shared snapshot. - + Can't be the identifier of an Aurora DB cluster snapshot. - + Can't be the identifier of an RDS for PostgreSQL Multi-AZ DB cluster snapshot. - DBInstanceArn: + If you want to create a read replica DB instance, specify the ID of the source DB instance. Each DB instance can have a limited number of read replicas. For more information, see [Working with Read Replicas](https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/USER_ReadRepl.html) in the *Amazon RDS User Guide*. + For information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide*. + The ``SourceDBInstanceIdentifier`` property determines whether a DB instance is a read replica. If you remove the ``SourceDBInstanceIdentifier`` property from your template and then update your stack, AWS CloudFormation promotes the Read Replica to a standalone DB instance. + + If you specify a source DB instance that uses VPC security groups, we recommend that you specify the ``VPCSecurityGroups`` property. If you don't specify the property, the read replica inherits the value of the ``VPCSecurityGroups`` property from the source DB when you create the replica. However, if you update the stack, AWS CloudFormation reverts the replica's ``VPCSecurityGroups`` property to the default value because it's not defined in the stack's template. This change might cause unexpected issues. + + Read replicas don't support deletion policies. AWS CloudFormation ignores any deletion policy that's associated with a read replica. + + If you specify ``SourceDBInstanceIdentifier``, don't specify the ``DBSnapshotIdentifier`` property. You can't create a read replica from a snapshot. + + Don't set the ``BackupRetentionPeriod``, ``DBName``, ``MasterUsername``, ``MasterUserPassword``, and ``PreferredBackupWindow`` properties. The database attributes are inherited from the source DB instance, and backups are disabled for read replicas. + + If the source DB instance is in a different region than the read replica, specify the source region in ``SourceRegion``, and specify an ARN for a valid DB instance in ``SourceDBInstanceIdentifier``. For more information, see [Constructing a Amazon RDS Amazon Resource Name (ARN)](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html#USER_Tagging.ARN) in the *Amazon RDS User Guide*. + + For DB instances in Amazon Aurora clusters, don't specify this property. Amazon RDS automatically assigns writer and reader DB instances. type: string - description: '' - DBInstanceClass: + EngineVersion: + description: |- + The version number of the database engine to use. + For a list of valid engine versions, use the ``DescribeDBEngineVersions`` action. + The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region. + *Amazon Aurora* + Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster. + *Db2* + See [Amazon RDS for Db2](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Db2.html#Db2.Concepts.VersionMgmt) in the *Amazon RDS User Guide.* + *MariaDB* + See [MariaDB on Amazon RDS Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt) in the *Amazon RDS User Guide.* + *Microsoft SQL Server* + See [Microsoft SQL Server Versions on Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport) in the *Amazon RDS User Guide.* + *MySQL* + See [MySQL on Amazon RDS Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt) in the *Amazon RDS User Guide.* + *Oracle* + See [Oracle Database Engine Release Notes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html) in the *Amazon RDS User Guide.* + *PostgreSQL* + See [Supported PostgreSQL Database Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts.General.DBVersions) in the *Amazon RDS User Guide.* type: string + StorageType: description: |- - The compute and memory capacity of the DB instance, for example, ``db.m4.large``. Not all DB instance classes are available in all AWS Regions, or for all database engines. - For the full list of DB instance classes, and availability for your engine, see [DB Instance Class](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide.* For more information about DB instance class pricing and AWS Region support for DB instance classes, see [Amazon RDS Pricing](https://docs.aws.amazon.com/rds/pricing/). - DBInstanceIdentifier: + The storage type to associate with the DB instance. + If you specify ``io1``, ``io2``, or ``gp3``, you must also include a value for the ``Iops`` parameter. + This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster. + Valid Values: ``gp2 | gp3 | io1 | io2 | standard`` + Default: ``io1``, if the ``Iops`` parameter is specified. Otherwise, ``gp2``. type: string - pattern: ^$|^[a-zA-Z]{1}(?:-?[a-zA-Z0-9]){0,62}$ - minLength: 1 - maxLength: 63 + KmsKeyId: description: |- - A name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html). - For information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide*. - If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. - DbiResourceId: + The ARN of the AWS KMS key that's used to encrypt the DB instance, such as ``arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef``. If you enable the StorageEncrypted property but don't specify this property, AWS CloudFormation uses the default KMS key. If you specify this property, you must set the StorageEncrypted property to true. + If you specify the ``SourceDBInstanceIdentifier`` property, the value is inherited from the source DB instance if the read replica is created in the same region. + If you create an encrypted read replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the region that they're created in, and you can't use encryption keys from one region in another region. + If you specify the ``DBSnapshotIdentifier`` property, don't specify this property. The ``StorageEncrypted`` property value is inherited from the snapshot. If the DB instance is encrypted, the specified ``KmsKeyId`` property is also inherited from the snapshot. + If you specify ``DBSecurityGroups``, AWS CloudFormation ignores this property. To specify both a security group and this property, you must use a VPC security group. For more information about Amazon RDS and VPC, see [Using Amazon RDS with Amazon VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html) in the *Amazon RDS User Guide*. + *Amazon Aurora* + Not applicable. The KMS key identifier is managed by the DB cluster. + anyOf: + - relationshipRef: + typeName: AWS::KMS::Key + propertyPath: /properties/KeyId + - relationshipRef: + typeName: AWS::KMS::Key + propertyPath: /properties/Arn type: string - description: '' - DBName: + DBInstanceClass: + description: >- + The compute and memory capacity of the DB instance, for example ``db.m5.large``. Not all DB instance classes are available in all AWS-Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see [DB instance classes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide* or [Aurora DB instance + classes](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.DBInstanceClass.html) in the *Amazon Aurora User Guide*. type: string + DeleteAutomatedBackups: description: |- - The meaning of this parameter differs according to the database engine you use. - If you specify the ``DBSnapshotIdentifier`` property, this property only applies to RDS for Oracle. - *Amazon Aurora* - Not applicable. The database name is managed by the DB cluster. - *Db2* - The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance. - Constraints: - + Must contain 1 to 64 letters or numbers. - + Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). - + Can't be a word reserved by the specified database engine. - - *MySQL* - The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. + A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted. + *Amazon Aurora* + Not applicable. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the DB cluster are not deleted. + type: boolean + PerformanceInsightsRetentionPeriod: + description: |- + The number of days to retain Performance Insights data. + This setting doesn't apply to RDS Custom DB instances. + Valid Values: + + ``7`` + + *month* * 31, where *month* is a number of months from 1-23. Examples: ``93`` (3 months * 31), ``341`` (11 months * 31), ``589`` (19 months * 31) + + ``731`` + + Default: ``7`` days + If you specify a retention period that isn't valid, such as ``94``, Amazon RDS returns an error. + type: integer + AvailabilityZone: + description: |- + The Availability Zone (AZ) where the database will be created. For information on AWS-Regions and Availability Zones, see [Regions and Availability Zones](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html). + For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one. + Default: A random, system-chosen Availability Zone in the endpoint's AWS-Region. Constraints: - + Must contain 1 to 64 letters or numbers. - + Can't be a word reserved by the specified database engine + + The ``AvailabilityZone`` parameter can't be specified if the DB instance is a Multi-AZ deployment. + + The specified Availability Zone must be in the same AWS-Region as the current endpoint. - *MariaDB* - The name of the database to create when the DB instance is - DBParameterGroupName: + Example: ``us-east-1d`` type: string + OptionGroupName: description: |- - The name of an existing DB parameter group or a reference to an [AWS::RDS::DBParameterGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html) resource created in the template. - To list all of the available DB parameter group names, use the following command: - ``aws rds describe-db-parameter-groups --query "DBParameterGroups[].DBParameterGroupName" --output text`` - If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot. - If you don't specify a value for ``DBParameterGroupName`` property, the default DB parameter group for the specified engine and engine version is used. - DBSecurityGroups: - type: array - uniqueItems: true - items: - type: string - description: |- - A list of the DB security groups to assign to the DB instance. The list can include both the name of existing DB security groups or references to AWS::RDS::DBSecurityGroup resources created in the template. - If you set DBSecurityGroups, you must not set VPCSecurityGroups, and vice versa. Also, note that the DBSecurityGroups property exists only for backwards compatibility with older regions and is no longer recommended for providing security information to an RDS DB instance. Instead, use VPCSecurityGroups. - If you specify this property, AWS CloudFormation sends only the following properties (if specified) to Amazon RDS during create operations: - + ``AllocatedStorage`` - + ``AutoMinorVersionUpgrade`` - + ``AvailabilityZone`` - + ``BackupRetentionPeriod`` - + ``CharacterSetName`` - + ``DBInstanceClass`` - + ``DBName`` - + ``DBParameterGroupName`` - + ``DBSecurityGroups`` - + ``DBSubnetGroupName`` - + ``Engine`` - + ``EngineVersion`` - + ``Iops`` - + ``LicenseModel`` - + - DBSnapshotIdentifier: + Indicates that the DB instance should be associated with the specified option group. + Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance. type: string + EnablePerformanceInsights: description: |- - The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance. If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot. - By specifying this property, you can create a DB instance from the specified DB snapshot. If the ``DBSnapshotIdentifier`` property is an empty string or the ``AWS::RDS::DBInstance`` declaration has no ``DBSnapshotIdentifier`` property, AWS CloudFormation creates a new database. If the property contains a value (other than an empty string), AWS CloudFormation creates a database from the specified snapshot. If a snapshot with the specified name doesn't exist, AWS CloudFormation can't create the database and it rolls back the stack. - Some DB instance properties aren't valid when you restore from a snapshot, such as the ``MasterUsername`` and ``MasterUserPassword`` properties. For information about the properties that you can specify, see the ``RestoreDBInstanceFromDBSnapshot`` action in the *Amazo + Specifies whether to enable Performance Insights for the DB instance. For more information, see [Using Amazon Performance Insights](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) in the *Amazon RDS User Guide*. + This setting doesn't apply to RDS Custom DB instances. + type: boolean + AutoMinorVersionUpgrade: + description: A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically. + type: boolean DBSubnetGroupName: - type: string description: |- A DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new VPC. If there's no DB subnet group, then the DB instance isn't a VPC DB instance. For more information about using Amazon RDS in a VPC, see [Using Amazon RDS with Amazon Virtual Private Cloud (VPC)](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html) in the *Amazon RDS User Guide*. - *Amazon Aurora* + *Amazon Aurora* Not applicable. The DB subnet group is managed by the DB cluster. If specified, the setting must match the DB cluster setting. - DBSystemId: type: string - description: The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. In this context, the term "Oracle database instance" refers exclusively to the system global area (SGA) and Oracle background processes. If you don't specify a SID, the value defaults to ``RDSCDB``. The Oracle SID is also the name of your CDB. - DedicatedLogVolume: - type: boolean - description: Indicates whether the DB instance has a dedicated log volume (DLV) enabled. - DeleteAutomatedBackups: - type: boolean - description: |- - A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted. - *Amazon Aurora* - Not applicable. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the DB cluster are not deleted. DeletionProtection: - type: boolean description: |- A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see [Deleting a DB Instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html). *Amazon Aurora* Not applicable. You can enable or disable deletion protection for the DB cluster. For more information, see ``CreateDBCluster``. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster. - Domain: - type: string + type: boolean + DBInstanceIdentifier: + minLength: 1 + pattern: ^$|^[a-zA-Z]{1}(?:-?[a-zA-Z0-9]){0,62}$ description: |- - The Active Directory directory ID to create the DB instance in. Currently, only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain. - For more information, see [Kerberos Authentication](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html) in the *Amazon RDS User Guide*. - DomainAuthSecretArn: - type: string - description: |- - The ARN for the Secrets Manager secret with the credentials for the user joining the domain. - Example: ``arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456`` - DomainDnsIps: - type: array - items: - type: string - description: |- - The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers. - Constraints: - + 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. - - Example: ``123.124.125.126,234.235.236.237`` - DomainFqdn: + A name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html). + For information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide*. + If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. type: string + maxLength: 63 + AllocatedStorage: + pattern: ^[0-9]*$ description: |- - The fully qualified domain name (FQDN) of an Active Directory domain. - Constraints: - + Can't be longer than 64 characters. + The amount of storage in gibibytes (GiB) to be initially allocated for the database instance. + If any value is set in the ``Iops`` parameter, ``AllocatedStorage`` must be at least 100 GiB, which corresponds to the minimum Iops value of 1,000. If you increase the ``Iops`` value (in 1,000 IOPS increments), then you must also increase the ``AllocatedStorage`` value (in 100-GiB increments). + *Amazon Aurora* + Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume. + *Db2* + Constraints to the amount of storage for each storage type are the following: + + General Purpose (SSD) storage (gp3): Must be an integer from 20 to 64000. + + Provisioned IOPS storage (io1): Must be an integer from 100 to 64000. - Example: ``mymanagedADtest.mymanagedAD.mydomain`` - DomainIAMRoleName: - type: string - description: |- - The name of the IAM role to use when making API calls to the Directory Service. - This setting doesn't apply to the following DB instances: - + Amazon Aurora (The domain is managed by the DB cluster.) - + RDS Custom - DomainOu: - type: string - description: |- - The Active Directory organizational unit for your DB instance to join. - Constraints: - + Must be in the distinguished name format. - + Can't be longer than 64 characters. + *MySQL* + Constraints to the amount of storage for each storage type are the following: + + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + + Magnetic storage (standard): Must be an integer from 5 to 3072. - Example: ``OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain`` - EnableCloudwatchLogsExports: - type: array - items: - type: string - description: |- - The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see [Publishing Database Logs to Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the *Amazon Relational Database Service User Guide*. - *Amazon Aurora* - Not applicable. CloudWatch Logs exports are managed by the DB cluster. - *Db2* - Valid values: ``diag.log``, ``notify.log`` *MariaDB* - Valid values: ``audit``, ``error``, ``general``, ``slowquery`` - *Microsoft SQL Server* - Valid values: ``agent``, ``error`` - *MySQL* - Valid values: ``audit``, ``error``, ``general``, ``slowquery`` - *Oracle* - Valid values: ``alert``, ``audit``, ``listener``, ``trace``, ``oemagent`` + Constraints to the amount of storage for each storage type are the following: + + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + + Magnetic storage (standard): Must be an integer from 5 to 3072. + *PostgreSQL* - Valid values: ``postgresql``, ``upgrade`` - EnableIAMDatabaseAuthentication: - type: boolean - description: |- - A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. - This property is supported for RDS for MariaDB, RDS for MySQL, and RDS for PostgreSQL. For more information, see [IAM Database Authentication for MariaDB, MySQL, and PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon RDS User Guide.* - *Amazon Aurora* - Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster. - EnablePerformanceInsights: - type: boolean - description: |- - Specifies whether to enable Performance Insights for the DB instance. For more information, see [Using Amazon Performance Insights](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) in the *Amazon RDS User Guide*. - This setting doesn't apply to RDS Custom DB instances. - Endpoint: - $ref: '#/components/schemas/Endpoint' - description: |- - The connection endpoint for the DB instance. - The endpoint might not be shown for instances with the status of ``creating``. - Engine: - type: string - description: |- - The name of the database engine that you want to use for this DB instance. - Not every database engine is available in every AWS Region. - When you are creating a DB instance, the ``Engine`` property is required. - Valid Values: - + ``aurora-mysql`` (for Aurora MySQL DB instances) - + ``aurora-postgresql`` (for Aurora PostgreSQL DB instances) - + ``custom-oracle-ee`` (for RDS Custom for Oracle DB instances) - + ``custom-oracle-ee-cdb`` (for RDS Custom for Oracle DB instances) - + ``custom-sqlserver-ee`` (for RDS Custom for SQL Server DB instances) - + ``custom-sqlserver-se`` (for RDS Custom for SQL Server DB instances) - + ``custom-sqlserver-web`` (for RDS Custom for SQL Server DB instances) - + ``db2-ae`` - + ``db2-se`` - + ``mariadb`` - + ``mysql`` - + ``oracle-ee`` - + ``oracle-ee-cdb`` - + ``oracle-se2`` - + ``oracle-se2-cdb`` - + ``postgres`` - + ``sqlserver-ee`` - + ``sqlserver-se`` - + ``sqlserver-ex`` - + ``sqlserver-web`` - EngineVersion: + Constraints to the amount of storage for each storage type are the following: + + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + + Magnetic storage (standard): Must be an integer from 5 to 3072. + + *Oracle* + Constraints to the amount of storage for each storage type are the following: + + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + + Magnetic storage (standard): Must be an integer from 10 to 3072. + + *SQL Server* + Constraints to the amount of storage for each storage type are the following: + + General Purpose (SSD) storage (gp2): + + Enterprise and Standard editions: Must be an integer from 20 to 16384. + + Web and Express editions: Must be an integer from 20 to 16384. + + + Provisioned IOPS storage (io1): + + Enterprise and Standard editions: Must be an integer from 20 to 16384. + + Web and Express editions: Must be an integer from 20 to 16384. + + + Magnetic storage (standard): + + Enterprise and Standard editions: Must be an integer from 20 to 1024. + + Web and Express editions: Must be an integer from 20 to 1024. type: string + MasterUserPassword: description: |- - The version number of the database engine to use. - For a list of valid engine versions, use the ``DescribeDBEngineVersions`` action. - The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region. + The password for the master user. The password can include any printable ASCII character except "/", """, or "@". *Amazon Aurora* - Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster. - *Db2* - See [Amazon RDS for Db2](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Db2.html#Db2.Concepts.VersionMgmt) in the *Amazon RDS User Guide.* - *MariaDB* - See [MariaDB on Amazon RDS Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt) in the *Amazon RDS User Guide.* - *Microsoft SQL Server* - See [Microsoft SQL Server Versions on Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSu - ManageMasterUserPassword: - type: boolean + Not applicable. The password for the master user is managed by the DB cluster. + *RDS for Db2* + Must contain from 8 to 255 characters. + *RDS for MariaDB* + Constraints: Must contain from 8 to 41 characters. + *RDS for Microsoft SQL Server* + Constraints: Must contain from 8 to 128 characters. + *RDS for MySQL* + Constraints: Must contain from 8 to 41 characters. + *RDS for Oracle* + Constraints: Must contain from 8 to 30 characters. + *RDS for PostgreSQL* + Constraints: Must contain from 8 to 128 characters. + type: string + MasterUserSecret: description: |- - Specifies whether to manage the master user password with AWS Secrets Manager. - For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide.* - Constraints: - + Can't manage the master user password with AWS Secrets Manager if ``MasterUserPassword`` is specified. - Iops: - type: integer + The secret managed by RDS in AWS Secrets Manager for the master user password. + For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide.* + $ref: '#/components/schemas/MasterUserSecret' + NcharCharacterSetName: description: |- - The number of I/O operations per second (IOPS) that the database provisions. The value must be equal to or greater than 1000. - If you specify this property, you must follow the range of allowed ratios of your requested IOPS rate to the amount of storage that you allocate (IOPS to allocated storage). For example, you can provision an Oracle database instance with 1000 IOPS and 200 GiB of storage (a ratio of 5:1), or specify 2000 IOPS with 200 GiB of storage (a ratio of 10:1). For more information, see [Amazon RDS Provisioned IOPS Storage to Improve Performance](https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/CHAP_Storage.html#USER_PIOPS) in the *Amazon RDS User Guide*. - If you specify ``io1`` for the ``StorageType`` property, then you must also specify the ``Iops`` property. - Constraints: - + For RDS for Db2, MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 of the storage amount for the DB instance. - + For RDS for SQL Server - Must be a multip - KmsKeyId: + The name of the NCHAR character set for the Oracle DB instance. + This setting doesn't apply to RDS Custom DB instances. type: string + SourceDBClusterIdentifier: description: |- - The ARN of the AWS KMS key that's used to encrypt the DB instance, such as ``arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef``. If you enable the StorageEncrypted property but don't specify this property, AWS CloudFormation uses the default KMS key. If you specify this property, you must set the StorageEncrypted property to true. - If you specify the ``SourceDBInstanceIdentifier`` property, the value is inherited from the source DB instance if the read replica is created in the same region. - If you create an encrypted read replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the region that they're created in, and you can't use encryption keys from one region in another region. - If you specify the ``SnapshotIdentifier`` property, the ``StorageEncrypted`` property value is inherited from the snapshot, and if the DB instance is encrypted, the specified ``KmsKeyId`` property is us - LicenseModel: + The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas. + Constraints: + + Must be the identifier of an existing Multi-AZ DB cluster. + + Can't be specified if the ``SourceDBInstanceIdentifier`` parameter is also specified. + + The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0. + + The source DB cluster must be in the same AWS-Region as the read replica. Cross-Region replication isn't supported. type: string + DBSecurityGroups: + uniqueItems: true description: |- - License model information for this DB instance. - Valid Values: - + Aurora MySQL - ``general-public-license`` - + Aurora PostgreSQL - ``postgresql-license`` - + RDS for Db2 - ``bring-your-own-license``. For more information about RDS for Db2 licensing, see [](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-licensing.html) in the *Amazon RDS User Guide.* - + RDS for MariaDB - ``general-public-license`` - + RDS for Microsoft SQL Server - ``license-included`` - + RDS for MySQL - ``general-public-license`` - + RDS for Oracle - ``bring-your-own-license`` or ``license-included`` - + RDS for PostgreSQL - ``postgresql-license`` + A list of the DB security groups to assign to the DB instance. The list can include both the name of existing DB security groups or references to AWS::RDS::DBSecurityGroup resources created in the template. + If you set DBSecurityGroups, you must not set VPCSecurityGroups, and vice versa. Also, note that the DBSecurityGroups property exists only for backwards compatibility with older regions and is no longer recommended for providing security information to an RDS DB instance. Instead, use VPCSecurityGroups. + If you specify this property, AWS CloudFormation sends only the following properties (if specified) to Amazon RDS during create operations: + + ``AllocatedStorage`` + + ``AutoMinorVersionUpgrade`` + + ``AvailabilityZone`` + + ``BackupRetentionPeriod`` + + ``CharacterSetName`` + + ``DBInstanceClass`` + + ``DBName`` + + ``DBParameterGroupName`` + + ``DBSecurityGroups`` + + ``DBSubnetGroupName`` + + ``Engine`` + + ``EngineVersion`` + + ``Iops`` + + ``LicenseModel`` + + ``MasterUsername`` + + ``MasterUserPassword`` + + ``MultiAZ`` + + ``OptionGroupName`` + + ``PreferredBackupWindow`` + + ``PreferredMaintenanceWindow`` - If you've specified ``DBSecurityGroups`` and then you update the license model, AWS CloudFormation replaces the underlying DB instance. This will incur some interruptions to database availability. + All other properties are ignored. Specify a virtual private cloud (VPC) security group if you want to submit other properties, such as ``StorageType``, ``StorageEncrypted``, or ``KmsKeyId``. If you're already using the ``DBSecurityGroups`` property, you can't use these other properties by updating your DB instance to use a VPC security group. You must recreate the DB instance. + type: array + items: + relationshipRef: + typeName: AWS::RDS::DBSecurityGroup + propertyPath: /properties/Id + type: string MasterUsername: - type: string + minLength: 1 pattern: ^[a-zA-Z][a-zA-Z0-9_]{0,127}$ description: |- The master user name for the DB instance. @@ -1467,158 +1487,125 @@ components: + Can't be a reserved word for the chosen database engine. *RDS for MySQL* - Constrain - minLength: 1 - maxLength: 128 - MasterUserPassword: - type: string - description: |- - The password for the master user. The password can include any printable ASCII character except "/", """, or "@". - *Amazon Aurora* - Not applicable. The password for the master user is managed by the DB cluster. - *RDS for Db2* - Must contain from 8 to 255 characters. - *RDS for MariaDB* - Constraints: Must contain from 8 to 41 characters. - *RDS for Microsoft SQL Server* - Constraints: Must contain from 8 to 128 characters. - *RDS for MySQL* - Constraints: Must contain from 8 to 41 characters. + Constraints: + + Must be 1 to 16 letters or numbers. + + First character must be a letter. + + Can't be a reserved word for the chosen database engine. + *RDS for Oracle* - Constraints: Must contain from 8 to 30 characters. + Constraints: + + Must be 1 to 30 letters or numbers. + + First character must be a letter. + + Can't be a reserved word for the chosen database engine. + *RDS for PostgreSQL* - Constraints: Must contain from 8 to 128 characters. - MasterUserSecret: - $ref: '#/components/schemas/MasterUserSecret' - description: |- - The secret managed by RDS in AWS Secrets Manager for the master user password. - For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide.* + Constraints: + + Must be 1 to 63 letters or numbers. + + First character must be a letter. + + Can't be a reserved word for the chosen database engine. + type: string + maxLength: 128 MaxAllocatedStorage: - type: integer description: |- The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. For more information about this setting, including limitations that apply to it, see [Managing capacity automatically with Amazon RDS storage autoscaling](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling) in the *Amazon RDS User Guide*. This setting doesn't apply to the following DB instances: + Amazon Aurora (Storage is managed by the DB cluster.) + RDS Custom - MonitoringInterval: type: integer - default: 0 - description: |- - The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0. The default is 0. - If ``MonitoringRoleArn`` is specified, then you must set ``MonitoringInterval`` to a value other than 0. - This setting doesn't apply to RDS Custom. - Valid Values: ``0, 1, 5, 10, 15, 30, 60`` - MonitoringRoleArn: - type: string + PromotionTier: + default: 1 description: |- - The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, ``arn:aws:iam:123456789012:role/emaccess``. For information on creating a monitoring role, see [Setting Up and Enabling Enhanced Monitoring](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling) in the *Amazon RDS User Guide*. - If ``MonitoringInterval`` is set to a value other than ``0``, then you must supply a ``MonitoringRoleArn`` value. + The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see [Fault Tolerance for an Aurora DB Cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.AuroraHighAvailability.html#Aurora.Managing.FaultTolerance) in the *Amazon Aurora User Guide*. This setting doesn't apply to RDS Custom DB instances. - MultiAZ: + Default: ``1`` + Valid Values: ``0 - 15`` + type: integer + minimum: 0 + PubliclyAccessible: + description: |- + Indicates whether the DB instance is an internet-facing instance. If you specify true, AWS CloudFormation creates an instance with a publicly resolvable DNS name, which resolves to a public IP address. If you specify false, AWS CloudFormation creates an internal instance with a DNS name that resolves to a private IP address. + The default behavior value depends on your VPC setup and the database subnet group. For more information, see the ``PubliclyAccessible`` parameter in the [CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) in the *Amazon RDS API Reference*. type: boolean + Domain: description: |- - Specifies whether the database instance is a Multi-AZ DB instance deployment. You can't set the ``AvailabilityZone`` parameter if the ``MultiAZ`` parameter is set to true. - For more information, see [Multi-AZ deployments for high availability](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.MultiAZ.html) in the *Amazon RDS User Guide*. - *Amazon Aurora* - Not applicable. Amazon Aurora storage is replicated across all of the Availability Zones and doesn't require the ``MultiAZ`` option to be set. - NcharCharacterSetName: + The Active Directory directory ID to create the DB instance in. Currently, only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain. + For more information, see [Kerberos Authentication](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html) in the *Amazon RDS User Guide*. type: string + DomainFqdn: description: |- - The name of the NCHAR character set for the Oracle DB instance. - This setting doesn't apply to RDS Custom DB instances. - NetworkType: - description: |- - The network type of the DB instance. - Valid values: - + ``IPV4`` - + ``DUAL`` + The fully qualified domain name (FQDN) of an Active Directory domain. + Constraints: + + Can't be longer than 64 characters. - The network type is determined by the ``DBSubnetGroup`` specified for the DB instance. A ``DBSubnetGroup`` can support only the IPv4 protocol or the IPv4 and IPv6 protocols (``DUAL``). - For more information, see [Working with a DB instance in a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the *Amazon RDS User Guide.* - type: string - OptionGroupName: + Example: ``mymanagedADtest.mymanagedAD.mydomain`` type: string + CharacterSetName: description: |- - Indicates that the DB instance should be associated with the specified option group. - Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance. - PerformanceInsightsKMSKeyId: + For supported engines, indicates that the DB instance should be associated with the specified character set. + *Amazon Aurora* + Not applicable. The character set is managed by the DB cluster. For more information, see [AWS::RDS::DBCluster](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html). type: string + MonitoringRoleArn: description: |- - The AWS KMS key identifier for encryption of Performance Insights data. - The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. - If you do not specify a value for ``PerformanceInsightsKMSKeyId``, then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region. - For information about enabling Performance Insights, see [EnablePerformanceInsights](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-enableperformanceinsights). - PerformanceInsightsRetentionPeriod: - type: integer - description: |- - The number of days to retain Performance Insights data. + The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, ``arn:aws:iam:123456789012:role/emaccess``. For information on creating a monitoring role, see [Setting Up and Enabling Enhanced Monitoring](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling) in the *Amazon RDS User Guide*. + If ``MonitoringInterval`` is set to a value other than ``0``, then you must supply a ``MonitoringRoleArn`` value. This setting doesn't apply to RDS Custom DB instances. - Valid Values: - + ``7`` - + *month* * 31, where *month* is a number of months from 1-23. Examples: ``93`` (3 months * 31), ``341`` (11 months * 31), ``589`` (19 months * 31) - + ``731`` - - Default: ``7`` days - If you specify a retention period that isn't valid, such as ``94``, Amazon RDS returns an error. - Port: type: string + AssociatedRoles: description: |- - The port number on which the database accepts connections. + The IAMlong (IAM) roles associated with the DB instance. *Amazon Aurora* - Not applicable. The port number is managed by the DB cluster. - *Db2* - Default value: ``50000`` - pattern: ^\d*$ - PreferredBackupWindow: - type: string + Not applicable. The associated roles are managed by the DB cluster. + type: array + items: + $ref: '#/components/schemas/DBInstanceRole' + DomainOu: description: |- - The daily time range during which automated backups are created if automated backups are enabled, using the ``BackupRetentionPeriod`` parameter. For more information, see [Backup Window](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow) in the *Amazon RDS User Guide.* + The Active Directory organizational unit for your DB instance to join. Constraints: - + Must be in the format ``hh24:mi-hh24:mi``. - + Must be in Universal Coordinated Time (UTC). - + Must not conflict with the preferred maintenance window. - + Must be at least 30 minutes. + + Must be in the distinguished name format. + + Can't be longer than 64 characters. - *Amazon Aurora* - Not applicable. The daily time range for creating automated backups is managed by the DB cluster. - PreferredMaintenanceWindow: + Example: ``OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain`` type: string + DBClusterSnapshotIdentifier: description: |- - The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). - Format: ``ddd:hh24:mi-ddd:hh24:mi`` - The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see [Adjusting the Preferred DB Instance Maintenance Window](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow) in the *Amazon RDS User Guide.* - This property applies when AWS CloudFormation initially creates the DB instance. If you use AWS CloudFormation to update the DB instance, those updates are applied immediately. - Constraints: Minimum 30-minute window. + The identifier for the Multi-AZ DB cluster snapshot to restore from. + For more information on Multi-AZ DB clusters, see [Multi-AZ DB cluster deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User Guide*. + Constraints: + + Must match the identifier of an existing Multi-AZ DB cluster snapshot. + + Can't be specified when ``DBSnapshotIdentifier`` is specified. + + Must be specified when ``DBSnapshotIdentifier`` isn't specified. + + If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the ``DBClusterSnapshotIdentifier`` must be the ARN of the shared snapshot. + + Can't be the identifier of an Aurora DB cluster snapshot. + type: string + SourceDBInstanceAutomatedBackupsArn: + description: |- + The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, ``arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE``. + This setting doesn't apply to RDS Custom. + type: string ProcessorFeatures: - type: array - items: - $ref: '#/components/schemas/ProcessorFeature' description: |- The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. - PromotionTier: - type: integer - minimum: 0 - default: 1 - description: |- - The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see [Fault Tolerance for an Aurora DB Cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.AuroraHighAvailability.html#Aurora.Managing.FaultTolerance) in the *Amazon Aurora User Guide*. - This setting doesn't apply to RDS Custom DB instances. - Default: ``1`` - Valid Values: ``0 - 15`` - PubliclyAccessible: - type: boolean - description: |- - Indicates whether the DB instance is an internet-facing instance. If you specify true, AWS CloudFormation creates an instance with a publicly resolvable DNS name, which resolves to a public IP address. If you specify false, AWS CloudFormation creates an internal instance with a DNS name that resolves to a private IP address. - The default behavior value depends on your VPC setup and the database subnet group. For more information, see the ``PubliclyAccessible`` parameter in the [CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) in the *Amazon RDS API Reference*. - ReplicaMode: + type: array + items: + $ref: '#/components/schemas/ProcessorFeature' + PreferredBackupWindow: description: |- - The open mode of an Oracle read replica. For more information, see [Working with Oracle Read Replicas for Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html) in the *Amazon RDS User Guide*. - This setting is only supported in RDS for Oracle. - Default: ``open-read-only`` - Valid Values: ``open-read-only`` or ``mounted`` + The daily time range during which automated backups are created if automated backups are enabled, using the ``BackupRetentionPeriod`` parameter. For more information, see [Backup Window](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow) in the *Amazon RDS User Guide.* + Constraints: + + Must be in the format ``hh24:mi-hh24:mi``. + + Must be in Universal Coordinated Time (UTC). + + Must not conflict with the preferred maintenance window. + + Must be at least 30 minutes. + + *Amazon Aurora* + Not applicable. The daily time range for creating automated backups is managed by the DB cluster. type: string RestoreTime: + format: date-time description: |- The date and time to restore from. Constraints: @@ -1628,125 +1615,312 @@ components: Example: ``2009-09-07T23:45:00Z`` type: string - format: date-time - SourceDBClusterIdentifier: + CertificateRotationRestart: description: |- - The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas. - Constraints: - + Must be the identifier of an existing Multi-AZ DB cluster. - + Can't be specified if the ``SourceDBInstanceIdentifier`` parameter is also specified. - + The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0. - + The source DB cluster must be in the same AWS-Region as the read replica. Cross-Region replication isn't supported. - type: string - SourceDbiResourceId: - type: string - description: The resource ID of the source DB instance from which to restore. - SourceDBInstanceAutomatedBackupsArn: - type: string + Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate. + By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted. + Set this parameter only if you are *not* using SSL/TLS to connect to the DB instance. + If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate: + + For more information about rotating your SSL/TLS certificate for RDS DB engines, see [Rotating Your SSL/TLS Certificate.](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon RDS User Guide.* + + For more information about rotating your SSL/TLS certificate for Aurora DB engines, see [Rotating Your SSL/TLS Certificate](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon Aurora User Guide*. + + This setting doesn't apply to RDS Custom DB instances. + type: boolean + NetworkType: description: |- - The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, ``arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE``. - This setting doesn't apply to RDS Custom. - SourceDBInstanceIdentifier: + The network type of the DB instance. + Valid values: + + ``IPV4`` + + ``DUAL`` + + The network type is determined by the ``DBSubnetGroup`` specified for the DB instance. A ``DBSubnetGroup`` can support only the IPv4 protocol or the IPv4 and IPv6 protocols (``DUAL``). + For more information, see [Working with a DB instance in a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the *Amazon RDS User Guide.* type: string + DedicatedLogVolume: + description: Indicates whether the DB instance has a dedicated log volume (DLV) enabled. + type: boolean + CopyTagsToSnapshot: description: |- - If you want to create a read replica DB instance, specify the ID of the source DB instance. Each DB instance can have a limited number of read replicas. For more information, see [Working with Read Replicas](https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/USER_ReadRepl.html) in the *Amazon RDS User Guide*. - For information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide*. - The ``SourceDBInstanceIdentifier`` property determines whether a DB instance is a read replica. If you remove the ``SourceDBInstanceIdentifier`` property from your template and then update your stack, AWS CloudFormation promotes the Read Replica to a standalone DB instance. - + If you specify a source DB instance that uses VPC security groups, we recommend that you specify the ``VPCSecurityGroups`` property. If you don't specify the - SourceRegion: - type: string - description: The ID of the region that contains the source DB instance for the read replica. - StorageEncrypted: + Specifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied. + This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. type: boolean + DomainIAMRoleName: description: |- - A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted. - If you specify the ``KmsKeyId`` property, then you must enable encryption. - If you specify the ``SourceDBInstanceIdentifier`` property, don't specify this property. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specified ``KmsKeyId`` property is used. - If you specify the ``DBSnapshotIdentifier`` and the specified snapshot is encrypted, don't specify this property. The value is inherited from the snapshot, and the specified ``KmsKeyId`` property is used. - If you specify the ``DBSnapshotIdentifier`` and the specified snapshot isn't encrypted, you can use this property to specify that the restored DB instance is encrypted. Specify the ``KmsKeyId`` property for the KMS key to use for encryption. If you don't want the restored DB instance to be encrypted, then don't set this property or set it to ``false``. - *Amazon Aurora* - Not applicable. The encrypt - StorageType: + The name of the IAM role to use when making API calls to the Directory Service. + This setting doesn't apply to the following DB instances: + + Amazon Aurora (The domain is managed by the DB cluster.) + + RDS Custom type: string + ReplicaMode: description: |- - Specifies the storage type to be associated with the DB instance. - Valid values: ``gp2 | gp3 | io1 | standard`` - The ``standard`` value is also known as magnetic. - If you specify ``io1`` or ``gp3``, you must also include a value for the ``Iops`` parameter. - Default: ``io1`` if the ``Iops`` parameter is specified, otherwise ``gp2`` - For more information, see [Amazon RDS DB Instance Storage](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html) in the *Amazon RDS User Guide*. - *Amazon Aurora* - Not applicable. Aurora data is stored in the cluster volume, which is a single, virtual volume that uses solid state drives (SSDs). - StorageThroughput: - type: integer + The open mode of an Oracle read replica. For more information, see [Working with Oracle Read Replicas for Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html) in the *Amazon RDS User Guide*. + This setting is only supported in RDS for Oracle. + Default: ``open-read-only`` + Valid Values: ``open-read-only`` or ``mounted`` + type: string + LicenseModel: description: |- - Specifies the storage throughput value for the DB instance. This setting applies only to the ``gp3`` storage type. - This setting doesn't apply to RDS Custom or Amazon Aurora. - Tags: + License model information for this DB instance. + Valid Values: + + Aurora MySQL - ``general-public-license`` + + Aurora PostgreSQL - ``postgresql-license`` + + RDS for Db2 - ``bring-your-own-license``. For more information about RDS for Db2 licensing, see [](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-licensing.html) in the *Amazon RDS User Guide.* + + RDS for MariaDB - ``general-public-license`` + + RDS for Microsoft SQL Server - ``license-included`` + + RDS for MySQL - ``general-public-license`` + + RDS for Oracle - ``bring-your-own-license`` or ``license-included`` + + RDS for PostgreSQL - ``postgresql-license`` + + If you've specified ``DBSecurityGroups`` and then you update the license model, AWS CloudFormation replaces the underlying DB instance. This will incur some interruptions to database availability. + type: string + DomainDnsIps: + description: |- + The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers. + Constraints: + + 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. + + Example: ``123.124.125.126,234.235.236.237`` type: array - x-insertionOrder: false - uniqueItems: false items: - $ref: '#/components/schemas/Tag' - description: An optional array of key-value pairs to apply to this DB instance. - TdeCredentialArn: - type: string - description: '' - TdeCredentialPassword: - type: string - description: '' - Timezone: + type: string + PreferredMaintenanceWindow: + description: |- + The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). + Format: ``ddd:hh24:mi-ddd:hh24:mi`` + The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see [Adjusting the Preferred DB Instance Maintenance Window](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow) in the *Amazon RDS User Guide.* + This property applies when AWS CloudFormation initially creates the DB instance. If you use AWS CloudFormation to update the DB instance, those updates are applied immediately. + Constraints: Minimum 30-minute window. type: string - description: The time zone of the DB instance. The time zone parameter is currently supported only by [Microsoft SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone). - UseDefaultProcessorFeatures: - type: boolean + Iops: description: |- - Specifies whether the DB instance class of the DB instance uses its default processor features. - This setting doesn't apply to RDS Custom DB instances. + The number of I/O operations per second (IOPS) that the database provisions. The value must be equal to or greater than 1000. + If you specify this property, you must follow the range of allowed ratios of your requested IOPS rate to the amount of storage that you allocate (IOPS to allocated storage). For example, you can provision an Oracle database instance with 1000 IOPS and 200 GiB of storage (a ratio of 5:1), or specify 2000 IOPS with 200 GiB of storage (a ratio of 10:1). For more information, see [Amazon RDS Provisioned IOPS Storage to Improve Performance](https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/CHAP_Storage.html#USER_PIOPS) in the *Amazon RDS User Guide*. + If you specify ``io1`` for the ``StorageType`` property, then you must also specify the ``Iops`` property. + Constraints: + + For RDS for Db2, MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 of the storage amount for the DB instance. + + For RDS for SQL Server - Must be a multiple between 1 and 50 of the storage amount for the DB instance. + type: integer + SourceRegion: + description: The ID of the region that contains the source DB instance for the read replica. + type: string UseLatestRestorableTime: - type: boolean description: |- Specifies whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time. Constraints: + Can't be specified if the ``RestoreTime`` parameter is provided. + type: boolean + CACertificateIdentifier: + description: |- + The identifier of the CA certificate for this DB instance. + For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) in the *Amazon RDS User Guide* and [Using SSL/TLS to encrypt a connection to a DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) in the *Amazon Aurora User Guide*. + type: string + ManageMasterUserPassword: + description: |- + Specifies whether to manage the master user password with AWS Secrets Manager. + For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide.* + Constraints: + + Can't manage the master user password with AWS Secrets Manager if ``MasterUserPassword`` is specified. + type: boolean + SourceDbiResourceId: + description: The resource ID of the source DB instance from which to restore. + type: string + DomainAuthSecretArn: + description: |- + The ARN for the Secrets Manager secret with the credentials for the user joining the domain. + Example: ``arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456`` + type: string + AutomaticBackupReplicationRegion: + description: The destination region for the backup replication of the DB instance. For more info, see [Replicating automated backups to another Region](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReplicateBackups.html) in the *Amazon RDS User Guide*. + type: string VPCSecurityGroups: - type: array uniqueItems: true - items: - type: string description: |- A list of the VPC security group IDs to assign to the DB instance. The list can include both the physical IDs of existing VPC security groups and references to [AWS::EC2::SecurityGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html) resources created in the template. If you plan to update the resource, don't specify VPC security groups in a shared VPC. If you set ``VPCSecurityGroups``, you must not set [DBSecurityGroups](https://docs.aws.amazon.com//AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsecuritygroups), and vice versa. You can migrate a DB instance in your stack from an RDS DB security group to a VPC security group, but keep the following in mind: + You can't revert to using an RDS security group after you establish a VPC security group membership. - + When you migrate your DB instance to VPC security groups, if your stack update rolls back because the DB instanc - x-stackql-resource-name: db_instance - description: |- - The ``AWS::RDS::DBInstance`` resource creates an Amazon DB instance. The new DB instance can be an RDS DB instance, or it can be a DB instance in an Aurora DB cluster. - For more information about creating an RDS DB instance, see [Creating an Amazon RDS DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateDBInstance.html) in the *Amazon RDS User Guide*. - For more information about creating a DB instance in an Aurora DB cluster, see [Creating an Amazon Aurora DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.CreateInstance.html) in the *Amazon Aurora User Guide*. - If you import an existing DB instance, and the template configuration doesn't match the actual configuration of the DB instance, AWS CloudFormation applies the changes in the template during the import operation. - If a DB instance is deleted or replaced during an update, AWS CloudFormation deletes all automated snapshots. However, it retains manual DB snapshots. During an - x-type-name: AWS::RDS::DBInstance - x-stackql-primary-identifier: - - DBInstanceIdentifier - x-create-only-properties: - - CharacterSetName - - CustomIAMInstanceProfile - - DBClusterIdentifier - - DBInstanceIdentifier - - DBName - - DBSubnetGroupName - - KmsKeyId - - MasterUsername - - NcharCharacterSetName - - Port - - SourceRegion - - StorageEncrypted - - Timezone - x-conditional-create-only-properties: - - AutoMinorVersionUpgrade + + When you migrate your DB instance to VPC security groups, if your stack update rolls back because the DB instance update fails or because an update fails in another AWS CloudFormation resource, the rollback fails because it can't revert to an RDS security group. + + To use the properties that are available when you use a VPC security group, you must recreate the DB instance. If you don't, AWS CloudFormation submits only the property values that are listed in the [DBSecurityGroups](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsecuritygroups) property. + + To avoid this situation, migrate your DB instance to using VPC security groups only when that is the only change in your stack template. + *Amazon Aurora* + Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. If specified, the setting must match the DB cluster setting. + type: array + items: + relationshipRef: + typeName: AWS::EC2::SecurityGroup + propertyPath: /properties/GroupId + type: string + AllowMajorVersionUpgrade: + description: |- + A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. + Constraints: Major version upgrades must be allowed when specifying a value for the ``EngineVersion`` parameter that is a different major version than the DB instance's current version. + type: boolean + DBName: + description: |- + The meaning of this parameter differs according to the database engine you use. + If you specify the ``DBSnapshotIdentifier`` property, this property only applies to RDS for Oracle. + *Amazon Aurora* + Not applicable. The database name is managed by the DB cluster. + *Db2* + The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance. + Constraints: + + Must contain 1 to 64 letters or numbers. + + Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). + + Can't be a word reserved by the specified database engine. + + *MySQL* + The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. + Constraints: + + Must contain 1 to 64 letters or numbers. + + Can't be a word reserved by the specified database engine + + *MariaDB* + The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. + Constraints: + + Must contain 1 to 64 letters or numbers. + + Can't be a word reserved by the specified database engine + + *PostgreSQL* + The name of the database to create when the DB instance is created. If this parameter is not specified, the default ``postgres`` database is created in the DB instance. + Constraints: + + Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). + + Must contain 1 to 63 characters. + + Can't be a word reserved by the specified database engine + + *Oracle* + The Oracle System ID (SID) of the created DB instance. If you specify ``null``, the default value ``ORCL`` is used. You can't specify the string NULL, or any other reserved word, for ``DBName``. + Default: ``ORCL`` + Constraints: + + Can't be longer than 8 characters + + *SQL Server* + Not applicable. Must be null. + type: string + EnableIAMDatabaseAuthentication: + description: |- + A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. + This property is supported for RDS for MariaDB, RDS for MySQL, and RDS for PostgreSQL. For more information, see [IAM Database Authentication for MariaDB, MySQL, and PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon RDS User Guide.* + *Amazon Aurora* + Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster. + type: boolean + BackupRetentionPeriod: + default: 1 + description: |- + The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. + *Amazon Aurora* + Not applicable. The retention period for automated backups is managed by the DB cluster. + Default: 1 + Constraints: + + Must be a value from 0 to 35 + + Can't be set to 0 if the DB instance is a source to read replicas + type: integer + minimum: 0 + CustomIAMInstanceProfile: + description: |- + The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. + This setting is required for RDS Custom. + Constraints: + + The profile must exist in your account. + + The profile must have an IAM role that Amazon EC2 has permissions to assume. + + The instance profile name and the associated IAM role name must start with the prefix ``AWSRDSCustom``. + + For the list of permissions required for the IAM role, see [Configure IAM and your VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc) in the *Amazon RDS User Guide*. + type: string + DBSnapshotIdentifier: + description: |- + The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance. If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot. + By specifying this property, you can create a DB instance from the specified DB snapshot. If the ``DBSnapshotIdentifier`` property is an empty string or the ``AWS::RDS::DBInstance`` declaration has no ``DBSnapshotIdentifier`` property, AWS CloudFormation creates a new database. If the property contains a value (other than an empty string), AWS CloudFormation creates a database from the specified snapshot. If a snapshot with the specified name doesn't exist, AWS CloudFormation can't create the database and it rolls back the stack. + Some DB instance properties aren't valid when you restore from a snapshot, such as the ``MasterUsername`` and ``MasterUserPassword`` properties. For information about the properties that you can specify, see the ``RestoreDBInstanceFromDBSnapshot`` action in the *Amazon RDS API Reference*. + After you restore a DB instance with a ``DBSnapshotIdentifier`` property, you must specify the same ``DBSnapshotIdentifier`` property for any future updates to the DB instance. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify the ``DBSnapshotIdentifier`` property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specified ``DBSnapshotIdentifier`` property, and the original DB instance is deleted. + If you specify the ``DBSnapshotIdentifier`` property to restore a DB instance (as opposed to specifying it for DB instance updates), then don't specify the following properties: + + ``CharacterSetName`` + + ``DBClusterIdentifier`` + + ``DBName`` + + ``DeleteAutomatedBackups`` + + ``EnablePerformanceInsights`` + + ``KmsKeyId`` + + ``MasterUsername`` + + ``MasterUserPassword`` + + ``PerformanceInsightsKMSKeyId`` + + ``PerformanceInsightsRetentionPeriod`` + + ``PromotionTier`` + + ``SourceDBInstanceIdentifier`` + + ``SourceRegion`` + + ``StorageEncrypted`` (for an encrypted snapshot) + + ``Timezone`` + + *Amazon Aurora* + Not applicable. Snapshot restore is managed by the DB cluster. + type: string + EnableCloudwatchLogsExports: + description: |- + The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see [Publishing Database Logs to Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the *Amazon Relational Database Service User Guide*. + *Amazon Aurora* + Not applicable. CloudWatch Logs exports are managed by the DB cluster. + *Db2* + Valid values: ``diag.log``, ``notify.log`` + *MariaDB* + Valid values: ``audit``, ``error``, ``general``, ``slowquery`` + *Microsoft SQL Server* + Valid values: ``agent``, ``error`` + *MySQL* + Valid values: ``audit``, ``error``, ``general``, ``slowquery`` + *Oracle* + Valid values: ``alert``, ``audit``, ``listener``, ``trace``, ``oemagent`` + *PostgreSQL* + Valid values: ``postgresql``, ``upgrade`` + type: array + items: + type: string + UseDefaultProcessorFeatures: + description: |- + Specifies whether the DB instance class of the DB instance uses its default processor features. + This setting doesn't apply to RDS Custom DB instances. + type: boolean + x-stackql-resource-name: db_instance + description: |- + The ``AWS::RDS::DBInstance`` resource creates an Amazon DB instance. The new DB instance can be an RDS DB instance, or it can be a DB instance in an Aurora DB cluster. + For more information about creating an RDS DB instance, see [Creating an Amazon RDS DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateDBInstance.html) in the *Amazon RDS User Guide*. + For more information about creating a DB instance in an Aurora DB cluster, see [Creating an Amazon Aurora DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.CreateInstance.html) in the *Amazon Aurora User Guide*. + If you import an existing DB instance, and the template configuration doesn't match the actual configuration of the DB instance, AWS CloudFormation applies the changes in the template during the import operation. + If a DB instance is deleted or replaced during an update, AWS CloudFormation deletes all automated snapshots. However, it retains manual DB snapshots. During an update that requires replacement, you can apply a stack policy to prevent DB instances from being replaced. For more information, see [Prevent Updates to Stack Resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html). + *Updating DB instances* + When properties labeled "*Update requires:* [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" are updated, AWS CloudFormation first creates a replacement DB instance, then changes references from other dependent resources to point to the replacement DB instance, and finally deletes the old DB instance. + We highly recommend that you take a snapshot of the database before updating the stack. If you don't, you lose the data when AWS CloudFormation replaces your DB instance. To preserve your data, perform the following procedure: + 1. Deactivate any applications that are using the DB instance so that there's no activity on the DB instance. + 1. Create a snapshot of the DB instance. For more information, see [Creating a DB Snapshot](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateSnapshot.html). + 1. If you want to restore your instance using a DB snapshot, modify the updated template with your DB instance changes and add the ``DBSnapshotIdentifier`` property with the ID of the DB snapshot that you want to use. + After you restore a DB instance with a ``DBSnapshotIdentifier`` property, you can delete the ``DBSnapshotIdentifier`` property. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify the ``DBSnapshotIdentifier`` property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specified ``DBSnapshotIdentifier`` property, and the original DB instance is deleted. + 1. Update the stack. + + For more information about updating other properties of this resource, see ``ModifyDBInstance``. For more information about updating stacks, see [CloudFormation Stacks Updates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html). + *Deleting DB instances* + For DB instances that are part of an Aurora DB cluster, you can set a deletion policy for your DB instance to control how AWS CloudFormation handles the DB instance when the stack is deleted. For Amazon RDS DB instances, you can choose to *retain* the DB instance, to *delete* the DB instance, or to *create a snapshot* of the DB instance. The default AWS CloudFormation behavior depends on the ``DBClusterIdentifier`` property: + 1. For ``AWS::RDS::DBInstance`` resources that don't specify the ``DBClusterIdentifier`` property, AWS CloudFormation saves a snapshot of the DB instance. + 1. For ``AWS::RDS::DBInstance`` resources that do specify the ``DBClusterIdentifier`` property, AWS CloudFormation deletes the DB instance. + + For more information, see [DeletionPolicy Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html). + x-type-name: AWS::RDS::DBInstance + x-stackql-primary-identifier: + - DBInstanceIdentifier + x-create-only-properties: + - CharacterSetName + - CustomIAMInstanceProfile + - DBClusterIdentifier + - DBInstanceIdentifier + - DBName + - DBSubnetGroupName + - KmsKeyId + - MasterUsername + - NcharCharacterSetName + - Port + - SourceRegion + - StorageEncrypted + - Timezone + x-conditional-create-only-properties: + - AutoMinorVersionUpgrade - AvailabilityZone - BackupRetentionPeriod - DBClusterSnapshotIdentifier @@ -1765,6 +1939,7 @@ components: - UseLatestRestorableTime x-write-only-properties: - AllowMajorVersionUpgrade + - AutomaticBackupReplicationKmsKeyId - CertificateRotationRestart - DBSnapshotIdentifier - DeleteAutomatedBackups @@ -1789,6 +1964,15 @@ components: - CertificateDetails/CAIdentifier - CertificateDetails/ValidTill x-required-permissions: + read: + - ec2:DescribeAccountAttributes + - ec2:DescribeAvailabilityZones + - ec2:DescribeInternetGateways + - ec2:DescribeSecurityGroups + - ec2:DescribeSubnets + - ec2:DescribeVpcAttribute + - ec2:DescribeVpcs + - rds:DescribeDBInstances create: - ec2:DescribeAccountAttributes - ec2:DescribeAvailabilityZones @@ -1820,15 +2004,6 @@ components: - rds:StartDBInstanceAutomatedBackupsReplication - secretsmanager:CreateSecret - secretsmanager:TagResource - read: - - ec2:DescribeAccountAttributes - - ec2:DescribeAvailabilityZones - - ec2:DescribeInternetGateways - - ec2:DescribeSecurityGroups - - ec2:DescribeSubnets - - ec2:DescribeVpcAttribute - - ec2:DescribeVpcs - - rds:DescribeDBInstances update: - ec2:DescribeAccountAttributes - ec2:DescribeAvailabilityZones @@ -1859,12 +2034,12 @@ components: - rds:StopDBInstanceAutomatedBackupsReplication - secretsmanager:CreateSecret - secretsmanager:TagResource + list: + - rds:DescribeDBInstances delete: - rds:CreateDBSnapshot - rds:DeleteDBInstance - rds:DescribeDBInstances - list: - - rds:DescribeDBInstances DBParameterGroup: type: object properties: @@ -1888,7 +2063,7 @@ components: The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a DB engine and engine version compatible with that DB parameter group family. The DB parameter group family can't be changed when updating a DB parameter group. To list all of the available parameter group families, use the following command: - ``aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily"`` + ``aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily"`` The output contains duplicates. For more information, see ``CreateDBParameterGroup``. type: string @@ -1898,12 +2073,12 @@ components: RDS for Db2 requires you to bring your own Db2 license. You must enter your IBM customer ID (``rds.ibm_customer_id``) and site number (``rds.ibm_site_id``) before starting a Db2 instance. For more information about DB parameters and DB parameter groups for Amazon RDS DB engines, see [Working with DB Parameter Groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) in the *Amazon RDS User Guide*. For more information about DB cluster and DB instance parameters and parameter groups for Amazon Aurora DB engines, see [Working with DB Parameter Groups and DB Cluster Parameter Groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*. - AWS CloudFormation doesn't support specifying an apply method for each individual + AWS CloudFormation doesn't support specifying an apply method for each individual parameter. The default apply method for each parameter is used. type: object Tags: description: |- An optional array of key-value pairs to apply to this DB parameter group. - Currently, this is the only property that supports drift detection. + Currently, this is the only property that supports drift detection. type: array maxItems: 50 uniqueItems: false @@ -2817,184 +2992,143 @@ components: DesiredState: type: object properties: + StorageEncrypted: + description: |- + Indicates whether the DB instance is encrypted. + If you specify the DBClusterIdentifier, SnapshotIdentifier, or SourceDBInstanceIdentifier property, don't specify this property. The value is inherited from the cluster, snapshot, or source DB instance. + type: boolean + DBSystemId: + description: Reserved for future use. + type: string + RestoreToTime: + description: 'The date and time to restore the DB cluster to. Value must be a time in Universal Coordinated Time (UTC) format. An example: 2015-03-07T23:45:00Z' + type: string + EngineMode: + description: The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster. + type: string + Port: + description: 'The port number on which the instances in the DB cluster accept connections. Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql.' + type: integer + DBClusterIdentifier: + minLength: 1 + pattern: ^[a-zA-Z]{1}(?:-?[a-zA-Z0-9]){0,62}$ + description: The DB cluster identifier. This parameter is stored as a lowercase string. + type: string + maxLength: 63 + StorageThroughput: + description: Specifies the storage throughput value for the DB cluster. This setting applies only to the gp3 storage type. + type: integer + MonitoringInterval: + default: 0 + description: The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0. The default is 0. + type: integer Endpoint: $ref: '#/components/schemas/Endpoint' - ReadEndpoint: - $ref: '#/components/schemas/ReadEndpoint' - AllocatedStorage: - description: The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster. - type: integer - AssociatedRoles: - description: Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf. - type: array + ReplicationSourceIdentifier: + description: The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica. + type: string + Engine: + description: 'The name of the database engine to be used for this DB cluster. Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql' + type: string + Tags: + maxItems: 50 uniqueItems: true - items: - $ref: '#/components/schemas/DBClusterRole' - AvailabilityZones: - description: A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide. + description: An array of key-value pairs to apply to this resource. + x-insertionOrder: false type: array - uniqueItems: true items: - type: string - AutoMinorVersionUpgrade: - description: A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically. - type: boolean - BacktrackWindow: - description: The target backtrack window, in seconds. To disable backtracking, set this value to 0. - default: 0 - minimum: 0 - type: integer - BackupRetentionPeriod: - description: The number of days for which automated backups are retained. - default: 1 - minimum: 1 + $ref: '#/components/schemas/Tag' + EngineVersion: + description: The version number of the database engine to use. + type: string + StorageType: + description: Specifies the storage type to be associated with the DB cluster. + type: string + KmsKeyId: + description: The Amazon Resource Name (ARN) of the AWS Key Management Service master key that is used to encrypt the database instances in the DB cluster, such as arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. If you enable the StorageEncrypted property but don't specify this property, the default master key is used. If you specify this property, you must set the StorageEncrypted property to true. + anyOf: + - relationshipRef: + typeName: AWS::KMS::Key + propertyPath: /properties/Arn + - relationshipRef: + typeName: AWS::KMS::Key + propertyPath: /properties/KeyId + type: string + ServerlessV2ScalingConfiguration: + description: Contains the scaling configuration of an Aurora Serverless v2 DB cluster. + $ref: '#/components/schemas/ServerlessV2ScalingConfiguration' + PerformanceInsightsRetentionPeriod: + description: The amount of time, in days, to retain Performance Insights data. type: integer - CopyTagsToSnapshot: - description: A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them. - type: boolean DatabaseName: description: The name of your database. If you don't provide a name, then Amazon RDS won't create a database in this DB cluster. For naming constraints, see Naming Constraints in the Amazon RDS User Guide. type: string - DBClusterArn: - type: string - description: The Amazon Resource Name (ARN) for the DB cluster. - DBClusterInstanceClass: - description: The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge. - type: string DBClusterResourceId: description: The AWS Region-unique, immutable identifier for the DB cluster. type: string - DBInstanceParameterGroupName: - description: The name of the DB parameter group to apply to all instances of the DB cluster. - type: string - DBSystemId: - description: Reserved for future use. - type: string - GlobalClusterIdentifier: - description: |- - If you are configuring an Aurora global database cluster and want your Aurora DB cluster to be a secondary member in the global database cluster, specify the global cluster ID of the global database cluster. To define the primary database cluster of the global cluster, use the AWS::RDS::GlobalCluster resource. - - If you aren't configuring a global database cluster, don't specify this property. - type: string - pattern: ^$|^[a-zA-Z]{1}(?:-?[a-zA-Z0-9]){0,62}$ - minLength: 0 - maxLength: 63 - DBClusterIdentifier: - description: The DB cluster identifier. This parameter is stored as a lowercase string. - type: string - pattern: ^[a-zA-Z]{1}(?:-?[a-zA-Z0-9]){0,62}$ - minLength: 1 - maxLength: 63 - DBClusterParameterGroupName: - description: The name of the DB cluster parameter group to associate with this DB cluster. - type: string - default: default.aurora5.6 - DBSubnetGroupName: - description: A DB subnet group that you want to associate with this DB cluster. + AutoMinorVersionUpgrade: + description: A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically. + type: boolean + DBSubnetGroupName: + description: A DB subnet group that you want to associate with this DB cluster. type: string DeletionProtection: description: A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. type: boolean - Domain: - description: The Active Directory directory ID to create the DB cluster in. - type: string - DomainIAMRoleName: - description: Specify the name of the IAM role to be used when making API calls to the Directory Service. - type: string - EnableCloudwatchLogsExports: - description: The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide. - type: array - uniqueItems: true - items: - type: string - EnableGlobalWriteForwarding: - description: Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database. - type: boolean - EnableHttpEndpoint: - description: A value that indicates whether to enable the HTTP endpoint for DB cluster. By default, the HTTP endpoint is disabled. - type: boolean - EnableIAMDatabaseAuthentication: - description: A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. - type: boolean - Engine: - description: 'The name of the database engine to be used for this DB cluster. Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql' - type: string - EngineMode: - description: The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster. - type: string - EngineVersion: - description: The version number of the database engine to use. - type: string - ManageMasterUserPassword: - description: A value that indicates whether to manage the master user password with AWS Secrets Manager. - type: boolean - Iops: - description: The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster. + AllocatedStorage: + description: The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster. type: integer - KmsKeyId: - description: The Amazon Resource Name (ARN) of the AWS Key Management Service master key that is used to encrypt the database instances in the DB cluster, such as arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. If you enable the StorageEncrypted property but don't specify this property, the default master key is used. If you specify this property, you must set the StorageEncrypted property to true. - type: string - MasterUsername: - description: The name of the master user for the DB cluster. You must specify MasterUsername, unless you specify SnapshotIdentifier. In that case, don't specify MasterUsername. - type: string - pattern: ^[a-zA-Z]{1}[a-zA-Z0-9_]*$ - minLength: 1 MasterUserPassword: description: The master password for the DB instance. type: string MasterUserSecret: - $ref: '#/components/schemas/MasterUserSecret' description: Contains the secret managed by RDS in AWS Secrets Manager for the master user password. - MonitoringInterval: - description: The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0. The default is 0. - type: integer - default: 0 - MonitoringRoleArn: - description: The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. + $ref: '#/components/schemas/MasterUserSecret' + SourceDBClusterIdentifier: + description: The identifier of the source DB cluster from which to restore. type: string - NetworkType: - description: The network type of the DB cluster. + MasterUsername: + minLength: 1 + pattern: ^[a-zA-Z]{1}[a-zA-Z0-9_]*$ + description: The name of the master user for the DB cluster. You must specify MasterUsername, unless you specify SnapshotIdentifier. In that case, don't specify MasterUsername. type: string - PerformanceInsightsEnabled: - description: A value that indicates whether to turn on Performance Insights for the DB cluster. - type: boolean + ScalingConfiguration: + description: The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster. + $ref: '#/components/schemas/ScalingConfiguration' + ReadEndpoint: + $ref: '#/components/schemas/ReadEndpoint' PerformanceInsightsKmsKeyId: description: The Amazon Web Services KMS key identifier for encryption of Performance Insights data. type: string - PerformanceInsightsRetentionPeriod: - description: The amount of time, in days, to retain Performance Insights data. - type: integer - Port: - description: 'The port number on which the instances in the DB cluster accept connections. Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql.' - type: integer - PreferredBackupWindow: - description: The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide. - type: string - PreferredMaintenanceWindow: - description: The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide. - type: string PubliclyAccessible: description: A value that indicates whether the DB cluster is publicly accessible. type: boolean - ReplicationSourceIdentifier: - description: The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica. + Domain: + description: The Active Directory directory ID to create the DB cluster in. type: string - RestoreToTime: - description: 'The date and time to restore the DB cluster to. Value must be a time in Universal Coordinated Time (UTC) format. An example: 2015-03-07T23:45:00Z' + BacktrackWindow: + default: 0 + description: The target backtrack window, in seconds. To disable backtracking, set this value to 0. + type: integer + minimum: 0 + DBInstanceParameterGroupName: + description: The name of the DB parameter group to apply to all instances of the DB cluster. type: string - RestoreType: - description: |- - The type of restore to be performed. You can specify one of the following values: - full-copy - The new DB cluster is restored as a full copy of the source DB cluster. - copy-on-write - The new DB cluster is restored as a clone of the source DB cluster. + EnableGlobalWriteForwarding: + description: Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database. + type: boolean + MonitoringRoleArn: + description: The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. type: string - default: full-copy - ServerlessV2ScalingConfiguration: - description: Contains the scaling configuration of an Aurora Serverless v2 DB cluster. - $ref: '#/components/schemas/ServerlessV2ScalingConfiguration' - ScalingConfiguration: - description: The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster. - $ref: '#/components/schemas/ScalingConfiguration' + AssociatedRoles: + uniqueItems: true + description: Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf. + type: array + items: + $ref: '#/components/schemas/DBClusterRole' + EnableHttpEndpoint: + description: A value that indicates whether to enable the HTTP endpoint for DB cluster. By default, the HTTP endpoint is disabled. + type: boolean SnapshotIdentifier: description: >- The identifier for the DB snapshot or DB cluster snapshot to restore from. @@ -3004,40 +3138,95 @@ components: After you restore a DB cluster with a SnapshotIdentifier property, you must specify the same SnapshotIdentifier property for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed. However, if you don't specify the SnapshotIdentifier property, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the specified SnapshotIdentifier property, and the original DB cluster is deleted. type: string - SourceDBClusterIdentifier: - description: The identifier of the source DB cluster from which to restore. + PreferredBackupWindow: + description: The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide. type: string - SourceRegion: - description: The AWS Region which contains the source DB cluster when replicating a DB cluster. For example, us-east-1. + NetworkType: + description: The network type of the DB cluster. type: string - StorageEncrypted: - description: |- - Indicates whether the DB instance is encrypted. - If you specify the DBClusterIdentifier, SnapshotIdentifier, or SourceDBInstanceIdentifier property, don't specify this property. The value is inherited from the cluster, snapshot, or source DB instance. + VpcSecurityGroupIds: + uniqueItems: true + description: A list of EC2 VPC security groups to associate with this DB cluster. + type: array + items: + anyOf: + - relationshipRef: + typeName: AWS::EC2::SecurityGroup + propertyPath: /properties/GroupId + - relationshipRef: + typeName: AWS::EC2::SecurityGroup + propertyPath: /properties/Id + type: string + CopyTagsToSnapshot: + description: A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them. type: boolean - StorageThroughput: - description: Specifies the storage throughput value for the DB cluster. This setting applies only to the gp3 storage type. - type: integer - StorageType: - description: Specifies the storage type to be associated with the DB cluster. + GlobalClusterIdentifier: + minLength: 0 + pattern: ^$|^[a-zA-Z]{1}(?:-?[a-zA-Z0-9]){0,62}$ + description: |- + If you are configuring an Aurora global database cluster and want your Aurora DB cluster to be a secondary member in the global database cluster, specify the global cluster ID of the global database cluster. To define the primary database cluster of the global cluster, use the AWS::RDS::GlobalCluster resource. + + If you aren't configuring a global database cluster, don't specify this property. type: string - Tags: - type: array - maxItems: 50 + maxLength: 63 + RestoreType: + default: full-copy + description: |- + The type of restore to be performed. You can specify one of the following values: + full-copy - The new DB cluster is restored as a full copy of the source DB cluster. + copy-on-write - The new DB cluster is restored as a clone of the source DB cluster. + type: string + DomainIAMRoleName: + description: Specify the name of the IAM role to be used when making API calls to the Directory Service. + type: string + DBClusterInstanceClass: + description: The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge. + type: string + AvailabilityZones: uniqueItems: true - x-insertionOrder: false - description: An array of key-value pairs to apply to this resource. + description: A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide. + type: array items: - $ref: '#/components/schemas/Tag' + type: string + DBClusterArn: + description: The Amazon Resource Name (ARN) for the DB cluster. + type: string + PreferredMaintenanceWindow: + description: The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide. + type: string + Iops: + description: The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster. + type: integer + SourceRegion: + description: The AWS Region which contains the source DB cluster when replicating a DB cluster. For example, us-east-1. + type: string UseLatestRestorableTime: description: A value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster is not restored to the latest restorable backup time. type: boolean - VpcSecurityGroupIds: - description: A list of EC2 VPC security groups to associate with this DB cluster. + ManageMasterUserPassword: + description: A value that indicates whether to manage the master user password with AWS Secrets Manager. + type: boolean + EnableIAMDatabaseAuthentication: + description: A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. + type: boolean + DBClusterParameterGroupName: + default: default.aurora5.6 + description: The name of the DB cluster parameter group to associate with this DB cluster. + type: string + PerformanceInsightsEnabled: + description: A value that indicates whether to turn on Performance Insights for the DB cluster. + type: boolean + BackupRetentionPeriod: + default: 1 + description: The number of days for which automated backups are retained. + type: integer + minimum: 1 + EnableCloudwatchLogsExports: uniqueItems: true + description: The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide. + type: array items: type: string - type: array x-stackQL-stringOnly: true x-title: CreateDBClusterRequest type: object @@ -3091,386 +3280,382 @@ components: DesiredState: type: object properties: - AllocatedStorage: + StorageEncrypted: + description: |- + A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted. + If you specify the ``KmsKeyId`` property, then you must enable encryption. + If you specify the ``SourceDBInstanceIdentifier`` property, don't specify this property. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specified ``KmsKeyId`` property is used. + If you specify ``DBSnapshotIdentifier`` property, don't specify this property. The value is inherited from the snapshot. + *Amazon Aurora* + Not applicable. The encryption for DB instances is managed by the DB cluster. + type: boolean + Timezone: + description: The time zone of the DB instance. The time zone parameter is currently supported only by [RDS for Db2](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-time-zone) and [RDS for SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone). + type: string + DBSystemId: + description: The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. In this context, the term "Oracle database instance" refers exclusively to the system global area (SGA) and Oracle background processes. If you don't specify a SID, the value defaults to ``RDSCDB``. The Oracle SID is also the name of your CDB. type: string + CertificateDetails: + description: The details of the DB instance's server certificate. + $ref: '#/components/schemas/CertificateDetails' + Port: + pattern: ^\d*$ description: |- - The amount of storage in gibibytes (GiB) to be initially allocated for the database instance. - If any value is set in the ``Iops`` parameter, ``AllocatedStorage`` must be at least 100 GiB, which corresponds to the minimum Iops value of 1,000. If you increase the ``Iops`` value (in 1,000 IOPS increments), then you must also increase the ``AllocatedStorage`` value (in 100-GiB increments). - *Amazon Aurora* - Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume. + The port number on which the database accepts connections. + *Amazon Aurora* + Not applicable. The port number is managed by the DB cluster. *Db2* - Constraints to the amount of storage for each storage type are the following: - + General Purpose (SSD) storage (gp3): Must be an integer from 20 to 64000. - + Provisioned IOPS storage (io1): Must be an integer from 100 to 64000. - - *MySQL* - Constraints to the amount of storage for each storage type are the following: - + General Purpose (SSD) storage (gp2): Must be an integer fro - pattern: ^[0-9]*$ - AllowMajorVersionUpgrade: - type: boolean - description: |- - A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. - Constraints: Major version upgrades must be allowed when specifying a value for the ``EngineVersion`` parameter that is a different major version than the DB instance's current version. - AssociatedRoles: - type: array - items: - $ref: '#/components/schemas/DBInstanceRole' - description: |- - The IAMlong (IAM) roles associated with the DB instance. - *Amazon Aurora* - Not applicable. The associated roles are managed by the DB cluster. - AutoMinorVersionUpgrade: - type: boolean - description: A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically. - AutomaticBackupReplicationRegion: + Default value: ``50000`` type: string - description: The destination region for the backup replication of the DB instance. For more info, see [Replicating automated backups to another Region](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReplicateBackups.html) in the *Amazon RDS User Guide*. - AvailabilityZone: + DBClusterIdentifier: + description: The identifier of the DB cluster that the instance will belong to. type: string + StorageThroughput: description: |- - The Availability Zone (AZ) where the database will be created. For information on AWS-Regions and Availability Zones, see [Regions and Availability Zones](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html). - For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one. - Default: A random, system-chosen Availability Zone in the endpoint's AWS-Region. - Constraints: - + The ``AvailabilityZone`` parameter can't be specified if the DB instance is a Multi-AZ deployment. - + The specified Availability Zone must be in the same AWS-Region as the current endpoint. - - Example: ``us-east-1d`` - BackupRetentionPeriod: + Specifies the storage throughput value for the DB instance. This setting applies only to the ``gp3`` storage type. + This setting doesn't apply to RDS Custom or Amazon Aurora. type: integer - minimum: 0 - default: 1 - description: |- - The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. - *Amazon Aurora* - Not applicable. The retention period for automated backups is managed by the DB cluster. - Default: 1 - Constraints: - + Must be a value from 0 to 35 - + Can't be set to 0 if the DB instance is a source to read replicas - CACertificateIdentifier: + DbiResourceId: + description: '' type: string + MonitoringInterval: + default: 0 description: |- - The identifier of the CA certificate for this DB instance. - For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) in the *Amazon RDS User Guide* and [Using SSL/TLS to encrypt a connection to a DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) in the *Amazon Aurora User Guide*. - CertificateDetails: - $ref: '#/components/schemas/CertificateDetails' - description: The details of the DB instance's server certificate. - CertificateRotationRestart: - type: boolean + The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0. The default is 0. + If ``MonitoringRoleArn`` is specified, then you must set ``MonitoringInterval`` to a value other than 0. + This setting doesn't apply to RDS Custom. + Valid Values: ``0, 1, 5, 10, 15, 30, 60`` + type: integer + DBParameterGroupName: description: |- - Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate. - By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted. - Set this parameter only if you are *not* using SSL/TLS to connect to the DB instance. - If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate: - + For more information about rotating your SSL/TLS certificate for RDS DB engines, see [Rotating Your SSL/TLS Certificate.](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon RDS User Guide.* - + For more information about rotating your SSL/TLS certificate for Aurora DB engines, see [Rotating Your SSL/TLS Certificate](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon Aurora User Gui - CharacterSetName: + The name of an existing DB parameter group or a reference to an [AWS::RDS::DBParameterGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html) resource created in the template. + To list all of the available DB parameter group names, use the following command: + ``aws rds describe-db-parameter-groups --query "DBParameterGroups[].DBParameterGroupName" --output text`` + If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot. + If you don't specify a value for ``DBParameterGroupName`` property, the default DB parameter group for the specified engine and engine version is used. type: string + DBInstanceArn: + description: '' + type: string + Endpoint: description: |- - For supported engines, indicates that the DB instance should be associated with the specified character set. + The connection endpoint for the DB instance. + The endpoint might not be shown for instances with the status of ``creating``. + $ref: '#/components/schemas/Endpoint' + TdeCredentialArn: + description: '' + type: string + AutomaticBackupReplicationKmsKeyId: + description: The AWS KMS key identifier for encryption of the replicated automated backups. The KMS key ID is the Amazon Resource Name (ARN) for the KMS encryption key in the destination AWS-Region, for example, ``arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE``. + type: string + MultiAZ: + description: |- + Specifies whether the database instance is a Multi-AZ DB instance deployment. You can't set the ``AvailabilityZone`` parameter if the ``MultiAZ`` parameter is set to true. + For more information, see [Multi-AZ deployments for high availability](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.MultiAZ.html) in the *Amazon RDS User Guide*. *Amazon Aurora* - Not applicable. The character set is managed by the DB cluster. For more information, see [AWS::RDS::DBCluster](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html). - CopyTagsToSnapshot: + Not applicable. Amazon Aurora storage is replicated across all of the Availability Zones and doesn't require the ``MultiAZ`` option to be set. type: boolean + Engine: description: |- - Specifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied. - This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. - CustomIAMInstanceProfile: - type: string - description: |- - The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. - This setting is required for RDS Custom. - Constraints: - + The profile must exist in your account. - + The profile must have an IAM role that Amazon EC2 has permissions to assume. - + The instance profile name and the associated IAM role name must start with the prefix ``AWSRDSCustom``. - - For the list of permissions required for the IAM role, see [Configure IAM and your VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc) in the *Amazon RDS User Guide*. - DBClusterIdentifier: - type: string - description: The identifier of the DB cluster that the instance will belong to. - DBClusterSnapshotIdentifier: + The name of the database engine to use for this DB instance. Not every database engine is available in every AWS Region. + This property is required when creating a DB instance. + You can convert an Oracle database from the non-CDB architecture to the container database (CDB) architecture by updating the ``Engine`` value in your templates from ``oracle-ee`` to ``oracle-ee-cdb`` or from ``oracle-se2`` to ``oracle-se2-cdb``. Converting to the CDB architecture requires an interruption. + Valid Values: + + ``aurora-mysql`` (for Aurora MySQL DB instances) + + ``aurora-postgresql`` (for Aurora PostgreSQL DB instances) + + ``custom-oracle-ee`` (for RDS Custom for Oracle DB instances) + + ``custom-oracle-ee-cdb`` (for RDS Custom for Oracle DB instances) + + ``custom-sqlserver-ee`` (for RDS Custom for SQL Server DB instances) + + ``custom-sqlserver-se`` (for RDS Custom for SQL Server DB instances) + + ``custom-sqlserver-web`` (for RDS Custom for SQL Server DB instances) + + ``db2-ae`` + + ``db2-se`` + + ``mariadb`` + + ``mysql`` + + ``oracle-ee`` + + ``oracle-ee-cdb`` + + ``oracle-se2`` + + ``oracle-se2-cdb`` + + ``postgres`` + + ``sqlserver-ee`` + + ``sqlserver-se`` + + ``sqlserver-ex`` + + ``sqlserver-web`` type: string + Tags: + uniqueItems: false + description: An optional array of key-value pairs to apply to this DB instance. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/Tag' + PerformanceInsightsKMSKeyId: description: |- - The identifier for the RDS for MySQL Multi-AZ DB cluster snapshot to restore from. - For more information on Multi-AZ DB clusters, see [Multi-AZ DB cluster deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User Guide*. - Constraints: - + Must match the identifier of an existing Multi-AZ DB cluster snapshot. - + Can't be specified when ``DBSnapshotIdentifier`` is specified. - + Must be specified when ``DBSnapshotIdentifier`` isn't specified. - + If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the ``DBClusterSnapshotIdentifier`` must be the ARN of the shared snapshot. - + Can't be the identifier of an Aurora DB cluster snapshot. - + Can't be the identifier of an RDS for PostgreSQL Multi-AZ DB cluster snapshot. - DBInstanceArn: + The AWS KMS key identifier for encryption of Performance Insights data. + The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. + If you do not specify a value for ``PerformanceInsightsKMSKeyId``, then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region. + For information about enabling Performance Insights, see [EnablePerformanceInsights](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-enableperformanceinsights). + anyOf: + - relationshipRef: + typeName: AWS::KMS::Key + propertyPath: /properties/Arn + - relationshipRef: + typeName: AWS::KMS::Key + propertyPath: /properties/KeyId type: string + TdeCredentialPassword: description: '' - DBInstanceClass: - type: string - description: |- - The compute and memory capacity of the DB instance, for example, ``db.m4.large``. Not all DB instance classes are available in all AWS Regions, or for all database engines. - For the full list of DB instance classes, and availability for your engine, see [DB Instance Class](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide.* For more information about DB instance class pricing and AWS Region support for DB instance classes, see [Amazon RDS Pricing](https://docs.aws.amazon.com/rds/pricing/). - DBInstanceIdentifier: type: string - pattern: ^$|^[a-zA-Z]{1}(?:-?[a-zA-Z0-9]){0,62}$ - minLength: 1 - maxLength: 63 + SourceDBInstanceIdentifier: description: |- - A name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html). + If you want to create a read replica DB instance, specify the ID of the source DB instance. Each DB instance can have a limited number of read replicas. For more information, see [Working with Read Replicas](https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/USER_ReadRepl.html) in the *Amazon RDS User Guide*. For information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide*. - If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. - DbiResourceId: - type: string - description: '' - DBName: + The ``SourceDBInstanceIdentifier`` property determines whether a DB instance is a read replica. If you remove the ``SourceDBInstanceIdentifier`` property from your template and then update your stack, AWS CloudFormation promotes the Read Replica to a standalone DB instance. + + If you specify a source DB instance that uses VPC security groups, we recommend that you specify the ``VPCSecurityGroups`` property. If you don't specify the property, the read replica inherits the value of the ``VPCSecurityGroups`` property from the source DB when you create the replica. However, if you update the stack, AWS CloudFormation reverts the replica's ``VPCSecurityGroups`` property to the default value because it's not defined in the stack's template. This change might cause unexpected issues. + + Read replicas don't support deletion policies. AWS CloudFormation ignores any deletion policy that's associated with a read replica. + + If you specify ``SourceDBInstanceIdentifier``, don't specify the ``DBSnapshotIdentifier`` property. You can't create a read replica from a snapshot. + + Don't set the ``BackupRetentionPeriod``, ``DBName``, ``MasterUsername``, ``MasterUserPassword``, and ``PreferredBackupWindow`` properties. The database attributes are inherited from the source DB instance, and backups are disabled for read replicas. + + If the source DB instance is in a different region than the read replica, specify the source region in ``SourceRegion``, and specify an ARN for a valid DB instance in ``SourceDBInstanceIdentifier``. For more information, see [Constructing a Amazon RDS Amazon Resource Name (ARN)](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html#USER_Tagging.ARN) in the *Amazon RDS User Guide*. + + For DB instances in Amazon Aurora clusters, don't specify this property. Amazon RDS automatically assigns writer and reader DB instances. type: string + EngineVersion: description: |- - The meaning of this parameter differs according to the database engine you use. - If you specify the ``DBSnapshotIdentifier`` property, this property only applies to RDS for Oracle. - *Amazon Aurora* - Not applicable. The database name is managed by the DB cluster. + The version number of the database engine to use. + For a list of valid engine versions, use the ``DescribeDBEngineVersions`` action. + The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region. + *Amazon Aurora* + Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster. *Db2* - The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance. - Constraints: - + Must contain 1 to 64 letters or numbers. - + Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). - + Can't be a word reserved by the specified database engine. - - *MySQL* - The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. - Constraints: - + Must contain 1 to 64 letters or numbers. - + Can't be a word reserved by the specified database engine - + See [Amazon RDS for Db2](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Db2.html#Db2.Concepts.VersionMgmt) in the *Amazon RDS User Guide.* *MariaDB* - The name of the database to create when the DB instance is - DBParameterGroupName: + See [MariaDB on Amazon RDS Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt) in the *Amazon RDS User Guide.* + *Microsoft SQL Server* + See [Microsoft SQL Server Versions on Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport) in the *Amazon RDS User Guide.* + *MySQL* + See [MySQL on Amazon RDS Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt) in the *Amazon RDS User Guide.* + *Oracle* + See [Oracle Database Engine Release Notes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html) in the *Amazon RDS User Guide.* + *PostgreSQL* + See [Supported PostgreSQL Database Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts.General.DBVersions) in the *Amazon RDS User Guide.* type: string + StorageType: description: |- - The name of an existing DB parameter group or a reference to an [AWS::RDS::DBParameterGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html) resource created in the template. - To list all of the available DB parameter group names, use the following command: - ``aws rds describe-db-parameter-groups --query "DBParameterGroups[].DBParameterGroupName" --output text`` - If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot. - If you don't specify a value for ``DBParameterGroupName`` property, the default DB parameter group for the specified engine and engine version is used. - DBSecurityGroups: - type: array - uniqueItems: true - items: - type: string - description: |- - A list of the DB security groups to assign to the DB instance. The list can include both the name of existing DB security groups or references to AWS::RDS::DBSecurityGroup resources created in the template. - If you set DBSecurityGroups, you must not set VPCSecurityGroups, and vice versa. Also, note that the DBSecurityGroups property exists only for backwards compatibility with older regions and is no longer recommended for providing security information to an RDS DB instance. Instead, use VPCSecurityGroups. - If you specify this property, AWS CloudFormation sends only the following properties (if specified) to Amazon RDS during create operations: - + ``AllocatedStorage`` - + ``AutoMinorVersionUpgrade`` - + ``AvailabilityZone`` - + ``BackupRetentionPeriod`` - + ``CharacterSetName`` - + ``DBInstanceClass`` - + ``DBName`` - + ``DBParameterGroupName`` - + ``DBSecurityGroups`` - + ``DBSubnetGroupName`` - + ``Engine`` - + ``EngineVersion`` - + ``Iops`` - + ``LicenseModel`` - + - DBSnapshotIdentifier: + The storage type to associate with the DB instance. + If you specify ``io1``, ``io2``, or ``gp3``, you must also include a value for the ``Iops`` parameter. + This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster. + Valid Values: ``gp2 | gp3 | io1 | io2 | standard`` + Default: ``io1``, if the ``Iops`` parameter is specified. Otherwise, ``gp2``. type: string + KmsKeyId: description: |- - The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance. If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot. - By specifying this property, you can create a DB instance from the specified DB snapshot. If the ``DBSnapshotIdentifier`` property is an empty string or the ``AWS::RDS::DBInstance`` declaration has no ``DBSnapshotIdentifier`` property, AWS CloudFormation creates a new database. If the property contains a value (other than an empty string), AWS CloudFormation creates a database from the specified snapshot. If a snapshot with the specified name doesn't exist, AWS CloudFormation can't create the database and it rolls back the stack. - Some DB instance properties aren't valid when you restore from a snapshot, such as the ``MasterUsername`` and ``MasterUserPassword`` properties. For information about the properties that you can specify, see the ``RestoreDBInstanceFromDBSnapshot`` action in the *Amazo - DBSubnetGroupName: + The ARN of the AWS KMS key that's used to encrypt the DB instance, such as ``arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef``. If you enable the StorageEncrypted property but don't specify this property, AWS CloudFormation uses the default KMS key. If you specify this property, you must set the StorageEncrypted property to true. + If you specify the ``SourceDBInstanceIdentifier`` property, the value is inherited from the source DB instance if the read replica is created in the same region. + If you create an encrypted read replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the region that they're created in, and you can't use encryption keys from one region in another region. + If you specify the ``DBSnapshotIdentifier`` property, don't specify this property. The ``StorageEncrypted`` property value is inherited from the snapshot. If the DB instance is encrypted, the specified ``KmsKeyId`` property is also inherited from the snapshot. + If you specify ``DBSecurityGroups``, AWS CloudFormation ignores this property. To specify both a security group and this property, you must use a VPC security group. For more information about Amazon RDS and VPC, see [Using Amazon RDS with Amazon VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html) in the *Amazon RDS User Guide*. + *Amazon Aurora* + Not applicable. The KMS key identifier is managed by the DB cluster. + anyOf: + - relationshipRef: + typeName: AWS::KMS::Key + propertyPath: /properties/KeyId + - relationshipRef: + typeName: AWS::KMS::Key + propertyPath: /properties/Arn type: string - description: |- - A DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new VPC. - If there's no DB subnet group, then the DB instance isn't a VPC DB instance. - For more information about using Amazon RDS in a VPC, see [Using Amazon RDS with Amazon Virtual Private Cloud (VPC)](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html) in the *Amazon RDS User Guide*. - *Amazon Aurora* - Not applicable. The DB subnet group is managed by the DB cluster. If specified, the setting must match the DB cluster setting. - DBSystemId: + DBInstanceClass: + description: >- + The compute and memory capacity of the DB instance, for example ``db.m5.large``. Not all DB instance classes are available in all AWS-Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see [DB instance classes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide* or [Aurora DB instance + classes](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.DBInstanceClass.html) in the *Amazon Aurora User Guide*. type: string - description: The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. In this context, the term "Oracle database instance" refers exclusively to the system global area (SGA) and Oracle background processes. If you don't specify a SID, the value defaults to ``RDSCDB``. The Oracle SID is also the name of your CDB. - DedicatedLogVolume: - type: boolean - description: Indicates whether the DB instance has a dedicated log volume (DLV) enabled. DeleteAutomatedBackups: - type: boolean description: |- A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted. - *Amazon Aurora* + *Amazon Aurora* Not applicable. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the DB cluster are not deleted. - DeletionProtection: type: boolean + PerformanceInsightsRetentionPeriod: description: |- - A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see [Deleting a DB Instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html). - *Amazon Aurora* - Not applicable. You can enable or disable deletion protection for the DB cluster. For more information, see ``CreateDBCluster``. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster. - Domain: - type: string - description: |- - The Active Directory directory ID to create the DB instance in. Currently, only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain. - For more information, see [Kerberos Authentication](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html) in the *Amazon RDS User Guide*. - DomainAuthSecretArn: - type: string - description: |- - The ARN for the Secrets Manager secret with the credentials for the user joining the domain. - Example: ``arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456`` - DomainDnsIps: - type: array - items: - type: string - description: |- - The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers. - Constraints: - + 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. - - Example: ``123.124.125.126,234.235.236.237`` - DomainFqdn: - type: string - description: |- - The fully qualified domain name (FQDN) of an Active Directory domain. - Constraints: - + Can't be longer than 64 characters. + The number of days to retain Performance Insights data. + This setting doesn't apply to RDS Custom DB instances. + Valid Values: + + ``7`` + + *month* * 31, where *month* is a number of months from 1-23. Examples: ``93`` (3 months * 31), ``341`` (11 months * 31), ``589`` (19 months * 31) + + ``731`` - Example: ``mymanagedADtest.mymanagedAD.mydomain`` - DomainIAMRoleName: - type: string - description: |- - The name of the IAM role to use when making API calls to the Directory Service. - This setting doesn't apply to the following DB instances: - + Amazon Aurora (The domain is managed by the DB cluster.) - + RDS Custom - DomainOu: - type: string + Default: ``7`` days + If you specify a retention period that isn't valid, such as ``94``, Amazon RDS returns an error. + type: integer + AvailabilityZone: description: |- - The Active Directory organizational unit for your DB instance to join. + The Availability Zone (AZ) where the database will be created. For information on AWS-Regions and Availability Zones, see [Regions and Availability Zones](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html). + For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one. + Default: A random, system-chosen Availability Zone in the endpoint's AWS-Region. Constraints: - + Must be in the distinguished name format. - + Can't be longer than 64 characters. + + The ``AvailabilityZone`` parameter can't be specified if the DB instance is a Multi-AZ deployment. + + The specified Availability Zone must be in the same AWS-Region as the current endpoint. - Example: ``OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain`` - EnableCloudwatchLogsExports: - type: array - items: - type: string - description: |- - The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see [Publishing Database Logs to Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the *Amazon Relational Database Service User Guide*. - *Amazon Aurora* - Not applicable. CloudWatch Logs exports are managed by the DB cluster. - *Db2* - Valid values: ``diag.log``, ``notify.log`` - *MariaDB* - Valid values: ``audit``, ``error``, ``general``, ``slowquery`` - *Microsoft SQL Server* - Valid values: ``agent``, ``error`` - *MySQL* - Valid values: ``audit``, ``error``, ``general``, ``slowquery`` - *Oracle* - Valid values: ``alert``, ``audit``, ``listener``, ``trace``, ``oemagent`` - *PostgreSQL* - Valid values: ``postgresql``, ``upgrade`` - EnableIAMDatabaseAuthentication: - type: boolean + Example: ``us-east-1d`` + type: string + OptionGroupName: description: |- - A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. - This property is supported for RDS for MariaDB, RDS for MySQL, and RDS for PostgreSQL. For more information, see [IAM Database Authentication for MariaDB, MySQL, and PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon RDS User Guide.* - *Amazon Aurora* - Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster. + Indicates that the DB instance should be associated with the specified option group. + Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance. + type: string EnablePerformanceInsights: - type: boolean description: |- Specifies whether to enable Performance Insights for the DB instance. For more information, see [Using Amazon Performance Insights](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) in the *Amazon RDS User Guide*. This setting doesn't apply to RDS Custom DB instances. - Endpoint: - $ref: '#/components/schemas/Endpoint' + type: boolean + AutoMinorVersionUpgrade: + description: A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically. + type: boolean + DBSubnetGroupName: description: |- - The connection endpoint for the DB instance. - The endpoint might not be shown for instances with the status of ``creating``. - Engine: + A DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new VPC. + If there's no DB subnet group, then the DB instance isn't a VPC DB instance. + For more information about using Amazon RDS in a VPC, see [Using Amazon RDS with Amazon Virtual Private Cloud (VPC)](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html) in the *Amazon RDS User Guide*. + *Amazon Aurora* + Not applicable. The DB subnet group is managed by the DB cluster. If specified, the setting must match the DB cluster setting. type: string + DeletionProtection: description: |- - The name of the database engine that you want to use for this DB instance. - Not every database engine is available in every AWS Region. - When you are creating a DB instance, the ``Engine`` property is required. - Valid Values: - + ``aurora-mysql`` (for Aurora MySQL DB instances) - + ``aurora-postgresql`` (for Aurora PostgreSQL DB instances) - + ``custom-oracle-ee`` (for RDS Custom for Oracle DB instances) - + ``custom-oracle-ee-cdb`` (for RDS Custom for Oracle DB instances) - + ``custom-sqlserver-ee`` (for RDS Custom for SQL Server DB instances) - + ``custom-sqlserver-se`` (for RDS Custom for SQL Server DB instances) - + ``custom-sqlserver-web`` (for RDS Custom for SQL Server DB instances) - + ``db2-ae`` - + ``db2-se`` - + ``mariadb`` - + ``mysql`` - + ``oracle-ee`` - + ``oracle-ee-cdb`` - + ``oracle-se2`` - + ``oracle-se2-cdb`` - + ``postgres`` - + ``sqlserver-ee`` - + ``sqlserver-se`` - + ``sqlserver-ex`` - + ``sqlserver-web`` - EngineVersion: + A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see [Deleting a DB Instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html). + *Amazon Aurora* + Not applicable. You can enable or disable deletion protection for the DB cluster. For more information, see ``CreateDBCluster``. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster. + type: boolean + DBInstanceIdentifier: + minLength: 1 + pattern: ^$|^[a-zA-Z]{1}(?:-?[a-zA-Z0-9]){0,62}$ + description: |- + A name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html). + For information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide*. + If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. type: string + maxLength: 63 + AllocatedStorage: + pattern: ^[0-9]*$ description: |- - The version number of the database engine to use. - For a list of valid engine versions, use the ``DescribeDBEngineVersions`` action. - The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region. - *Amazon Aurora* - Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster. + The amount of storage in gibibytes (GiB) to be initially allocated for the database instance. + If any value is set in the ``Iops`` parameter, ``AllocatedStorage`` must be at least 100 GiB, which corresponds to the minimum Iops value of 1,000. If you increase the ``Iops`` value (in 1,000 IOPS increments), then you must also increase the ``AllocatedStorage`` value (in 100-GiB increments). + *Amazon Aurora* + Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume. *Db2* - See [Amazon RDS for Db2](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Db2.html#Db2.Concepts.VersionMgmt) in the *Amazon RDS User Guide.* - *MariaDB* - See [MariaDB on Amazon RDS Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt) in the *Amazon RDS User Guide.* - *Microsoft SQL Server* - See [Microsoft SQL Server Versions on Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSu - ManageMasterUserPassword: - type: boolean + Constraints to the amount of storage for each storage type are the following: + + General Purpose (SSD) storage (gp3): Must be an integer from 20 to 64000. + + Provisioned IOPS storage (io1): Must be an integer from 100 to 64000. + + *MySQL* + Constraints to the amount of storage for each storage type are the following: + + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + + Magnetic storage (standard): Must be an integer from 5 to 3072. + + *MariaDB* + Constraints to the amount of storage for each storage type are the following: + + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + + Magnetic storage (standard): Must be an integer from 5 to 3072. + + *PostgreSQL* + Constraints to the amount of storage for each storage type are the following: + + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + + Magnetic storage (standard): Must be an integer from 5 to 3072. + + *Oracle* + Constraints to the amount of storage for each storage type are the following: + + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + + Magnetic storage (standard): Must be an integer from 10 to 3072. + + *SQL Server* + Constraints to the amount of storage for each storage type are the following: + + General Purpose (SSD) storage (gp2): + + Enterprise and Standard editions: Must be an integer from 20 to 16384. + + Web and Express editions: Must be an integer from 20 to 16384. + + + Provisioned IOPS storage (io1): + + Enterprise and Standard editions: Must be an integer from 20 to 16384. + + Web and Express editions: Must be an integer from 20 to 16384. + + + Magnetic storage (standard): + + Enterprise and Standard editions: Must be an integer from 20 to 1024. + + Web and Express editions: Must be an integer from 20 to 1024. + type: string + MasterUserPassword: description: |- - Specifies whether to manage the master user password with AWS Secrets Manager. - For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide.* - Constraints: - + Can't manage the master user password with AWS Secrets Manager if ``MasterUserPassword`` is specified. - Iops: - type: integer + The password for the master user. The password can include any printable ASCII character except "/", """, or "@". + *Amazon Aurora* + Not applicable. The password for the master user is managed by the DB cluster. + *RDS for Db2* + Must contain from 8 to 255 characters. + *RDS for MariaDB* + Constraints: Must contain from 8 to 41 characters. + *RDS for Microsoft SQL Server* + Constraints: Must contain from 8 to 128 characters. + *RDS for MySQL* + Constraints: Must contain from 8 to 41 characters. + *RDS for Oracle* + Constraints: Must contain from 8 to 30 characters. + *RDS for PostgreSQL* + Constraints: Must contain from 8 to 128 characters. + type: string + MasterUserSecret: description: |- - The number of I/O operations per second (IOPS) that the database provisions. The value must be equal to or greater than 1000. - If you specify this property, you must follow the range of allowed ratios of your requested IOPS rate to the amount of storage that you allocate (IOPS to allocated storage). For example, you can provision an Oracle database instance with 1000 IOPS and 200 GiB of storage (a ratio of 5:1), or specify 2000 IOPS with 200 GiB of storage (a ratio of 10:1). For more information, see [Amazon RDS Provisioned IOPS Storage to Improve Performance](https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/CHAP_Storage.html#USER_PIOPS) in the *Amazon RDS User Guide*. - If you specify ``io1`` for the ``StorageType`` property, then you must also specify the ``Iops`` property. - Constraints: - + For RDS for Db2, MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 of the storage amount for the DB instance. - + For RDS for SQL Server - Must be a multip - KmsKeyId: + The secret managed by RDS in AWS Secrets Manager for the master user password. + For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide.* + $ref: '#/components/schemas/MasterUserSecret' + NcharCharacterSetName: + description: |- + The name of the NCHAR character set for the Oracle DB instance. + This setting doesn't apply to RDS Custom DB instances. type: string + SourceDBClusterIdentifier: description: |- - The ARN of the AWS KMS key that's used to encrypt the DB instance, such as ``arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef``. If you enable the StorageEncrypted property but don't specify this property, AWS CloudFormation uses the default KMS key. If you specify this property, you must set the StorageEncrypted property to true. - If you specify the ``SourceDBInstanceIdentifier`` property, the value is inherited from the source DB instance if the read replica is created in the same region. - If you create an encrypted read replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the region that they're created in, and you can't use encryption keys from one region in another region. - If you specify the ``SnapshotIdentifier`` property, the ``StorageEncrypted`` property value is inherited from the snapshot, and if the DB instance is encrypted, the specified ``KmsKeyId`` property is us - LicenseModel: + The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas. + Constraints: + + Must be the identifier of an existing Multi-AZ DB cluster. + + Can't be specified if the ``SourceDBInstanceIdentifier`` parameter is also specified. + + The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0. + + The source DB cluster must be in the same AWS-Region as the read replica. Cross-Region replication isn't supported. type: string + DBSecurityGroups: + uniqueItems: true description: |- - License model information for this DB instance. - Valid Values: - + Aurora MySQL - ``general-public-license`` - + Aurora PostgreSQL - ``postgresql-license`` - + RDS for Db2 - ``bring-your-own-license``. For more information about RDS for Db2 licensing, see [](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-licensing.html) in the *Amazon RDS User Guide.* - + RDS for MariaDB - ``general-public-license`` - + RDS for Microsoft SQL Server - ``license-included`` - + RDS for MySQL - ``general-public-license`` - + RDS for Oracle - ``bring-your-own-license`` or ``license-included`` - + RDS for PostgreSQL - ``postgresql-license`` + A list of the DB security groups to assign to the DB instance. The list can include both the name of existing DB security groups or references to AWS::RDS::DBSecurityGroup resources created in the template. + If you set DBSecurityGroups, you must not set VPCSecurityGroups, and vice versa. Also, note that the DBSecurityGroups property exists only for backwards compatibility with older regions and is no longer recommended for providing security information to an RDS DB instance. Instead, use VPCSecurityGroups. + If you specify this property, AWS CloudFormation sends only the following properties (if specified) to Amazon RDS during create operations: + + ``AllocatedStorage`` + + ``AutoMinorVersionUpgrade`` + + ``AvailabilityZone`` + + ``BackupRetentionPeriod`` + + ``CharacterSetName`` + + ``DBInstanceClass`` + + ``DBName`` + + ``DBParameterGroupName`` + + ``DBSecurityGroups`` + + ``DBSubnetGroupName`` + + ``Engine`` + + ``EngineVersion`` + + ``Iops`` + + ``LicenseModel`` + + ``MasterUsername`` + + ``MasterUserPassword`` + + ``MultiAZ`` + + ``OptionGroupName`` + + ``PreferredBackupWindow`` + + ``PreferredMaintenanceWindow`` - If you've specified ``DBSecurityGroups`` and then you update the license model, AWS CloudFormation replaces the underlying DB instance. This will incur some interruptions to database availability. + All other properties are ignored. Specify a virtual private cloud (VPC) security group if you want to submit other properties, such as ``StorageType``, ``StorageEncrypted``, or ``KmsKeyId``. If you're already using the ``DBSecurityGroups`` property, you can't use these other properties by updating your DB instance to use a VPC security group. You must recreate the DB instance. + type: array + items: + relationshipRef: + typeName: AWS::RDS::DBSecurityGroup + propertyPath: /properties/Id + type: string MasterUsername: - type: string + minLength: 1 pattern: ^[a-zA-Z][a-zA-Z0-9_]{0,127}$ description: |- The master user name for the DB instance. @@ -3496,66 +3681,145 @@ components: + Can't be a reserved word for the chosen database engine. *RDS for MySQL* - Constrain - minLength: 1 - maxLength: 128 - MasterUserPassword: - type: string - description: |- - The password for the master user. The password can include any printable ASCII character except "/", """, or "@". - *Amazon Aurora* - Not applicable. The password for the master user is managed by the DB cluster. - *RDS for Db2* - Must contain from 8 to 255 characters. - *RDS for MariaDB* - Constraints: Must contain from 8 to 41 characters. - *RDS for Microsoft SQL Server* - Constraints: Must contain from 8 to 128 characters. - *RDS for MySQL* - Constraints: Must contain from 8 to 41 characters. + Constraints: + + Must be 1 to 16 letters or numbers. + + First character must be a letter. + + Can't be a reserved word for the chosen database engine. + *RDS for Oracle* - Constraints: Must contain from 8 to 30 characters. + Constraints: + + Must be 1 to 30 letters or numbers. + + First character must be a letter. + + Can't be a reserved word for the chosen database engine. + *RDS for PostgreSQL* - Constraints: Must contain from 8 to 128 characters. - MasterUserSecret: - $ref: '#/components/schemas/MasterUserSecret' - description: |- - The secret managed by RDS in AWS Secrets Manager for the master user password. - For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide.* + Constraints: + + Must be 1 to 63 letters or numbers. + + First character must be a letter. + + Can't be a reserved word for the chosen database engine. + type: string + maxLength: 128 MaxAllocatedStorage: - type: integer description: |- The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. For more information about this setting, including limitations that apply to it, see [Managing capacity automatically with Amazon RDS storage autoscaling](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling) in the *Amazon RDS User Guide*. This setting doesn't apply to the following DB instances: + Amazon Aurora (Storage is managed by the DB cluster.) + RDS Custom - MonitoringInterval: type: integer - default: 0 + PromotionTier: + default: 1 description: |- - The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0. The default is 0. - If ``MonitoringRoleArn`` is specified, then you must set ``MonitoringInterval`` to a value other than 0. - This setting doesn't apply to RDS Custom. - Valid Values: ``0, 1, 5, 10, 15, 30, 60`` - MonitoringRoleArn: + The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see [Fault Tolerance for an Aurora DB Cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.AuroraHighAvailability.html#Aurora.Managing.FaultTolerance) in the *Amazon Aurora User Guide*. + This setting doesn't apply to RDS Custom DB instances. + Default: ``1`` + Valid Values: ``0 - 15`` + type: integer + minimum: 0 + PubliclyAccessible: + description: |- + Indicates whether the DB instance is an internet-facing instance. If you specify true, AWS CloudFormation creates an instance with a publicly resolvable DNS name, which resolves to a public IP address. If you specify false, AWS CloudFormation creates an internal instance with a DNS name that resolves to a private IP address. + The default behavior value depends on your VPC setup and the database subnet group. For more information, see the ``PubliclyAccessible`` parameter in the [CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) in the *Amazon RDS API Reference*. + type: boolean + Domain: + description: |- + The Active Directory directory ID to create the DB instance in. Currently, only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain. + For more information, see [Kerberos Authentication](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html) in the *Amazon RDS User Guide*. + type: string + DomainFqdn: + description: |- + The fully qualified domain name (FQDN) of an Active Directory domain. + Constraints: + + Can't be longer than 64 characters. + + Example: ``mymanagedADtest.mymanagedAD.mydomain`` + type: string + CharacterSetName: + description: |- + For supported engines, indicates that the DB instance should be associated with the specified character set. + *Amazon Aurora* + Not applicable. The character set is managed by the DB cluster. For more information, see [AWS::RDS::DBCluster](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html). type: string + MonitoringRoleArn: description: |- The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, ``arn:aws:iam:123456789012:role/emaccess``. For information on creating a monitoring role, see [Setting Up and Enabling Enhanced Monitoring](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling) in the *Amazon RDS User Guide*. If ``MonitoringInterval`` is set to a value other than ``0``, then you must supply a ``MonitoringRoleArn`` value. This setting doesn't apply to RDS Custom DB instances. - MultiAZ: - type: boolean + type: string + AssociatedRoles: description: |- - Specifies whether the database instance is a Multi-AZ DB instance deployment. You can't set the ``AvailabilityZone`` parameter if the ``MultiAZ`` parameter is set to true. - For more information, see [Multi-AZ deployments for high availability](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.MultiAZ.html) in the *Amazon RDS User Guide*. + The IAMlong (IAM) roles associated with the DB instance. + *Amazon Aurora* + Not applicable. The associated roles are managed by the DB cluster. + type: array + items: + $ref: '#/components/schemas/DBInstanceRole' + DomainOu: + description: |- + The Active Directory organizational unit for your DB instance to join. + Constraints: + + Must be in the distinguished name format. + + Can't be longer than 64 characters. + + Example: ``OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain`` + type: string + DBClusterSnapshotIdentifier: + description: |- + The identifier for the Multi-AZ DB cluster snapshot to restore from. + For more information on Multi-AZ DB clusters, see [Multi-AZ DB cluster deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User Guide*. + Constraints: + + Must match the identifier of an existing Multi-AZ DB cluster snapshot. + + Can't be specified when ``DBSnapshotIdentifier`` is specified. + + Must be specified when ``DBSnapshotIdentifier`` isn't specified. + + If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the ``DBClusterSnapshotIdentifier`` must be the ARN of the shared snapshot. + + Can't be the identifier of an Aurora DB cluster snapshot. + type: string + SourceDBInstanceAutomatedBackupsArn: + description: |- + The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, ``arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE``. + This setting doesn't apply to RDS Custom. + type: string + ProcessorFeatures: + description: |- + The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. + This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. + type: array + items: + $ref: '#/components/schemas/ProcessorFeature' + PreferredBackupWindow: + description: |- + The daily time range during which automated backups are created if automated backups are enabled, using the ``BackupRetentionPeriod`` parameter. For more information, see [Backup Window](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow) in the *Amazon RDS User Guide.* + Constraints: + + Must be in the format ``hh24:mi-hh24:mi``. + + Must be in Universal Coordinated Time (UTC). + + Must not conflict with the preferred maintenance window. + + Must be at least 30 minutes. + *Amazon Aurora* - Not applicable. Amazon Aurora storage is replicated across all of the Availability Zones and doesn't require the ``MultiAZ`` option to be set. - NcharCharacterSetName: + Not applicable. The daily time range for creating automated backups is managed by the DB cluster. type: string + RestoreTime: + format: date-time description: |- - The name of the NCHAR character set for the Oracle DB instance. + The date and time to restore from. + Constraints: + + Must be a time in Universal Coordinated Time (UTC) format. + + Must be before the latest restorable time for the DB instance. + + Can't be specified if the ``UseLatestRestorableTime`` parameter is enabled. + + Example: ``2009-09-07T23:45:00Z`` + type: string + CertificateRotationRestart: + description: |- + Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate. + By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted. + Set this parameter only if you are *not* using SSL/TLS to connect to the DB instance. + If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate: + + For more information about rotating your SSL/TLS certificate for RDS DB engines, see [Rotating Your SSL/TLS Certificate.](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon RDS User Guide.* + + For more information about rotating your SSL/TLS certificate for Aurora DB engines, see [Rotating Your SSL/TLS Certificate](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon Aurora User Guide*. + This setting doesn't apply to RDS Custom DB instances. + type: boolean NetworkType: description: |- The network type of the DB instance. @@ -3566,190 +3830,249 @@ components: The network type is determined by the ``DBSubnetGroup`` specified for the DB instance. A ``DBSubnetGroup`` can support only the IPv4 protocol or the IPv4 and IPv6 protocols (``DUAL``). For more information, see [Working with a DB instance in a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the *Amazon RDS User Guide.* type: string - OptionGroupName: - type: string + DedicatedLogVolume: + description: Indicates whether the DB instance has a dedicated log volume (DLV) enabled. + type: boolean + CopyTagsToSnapshot: description: |- - Indicates that the DB instance should be associated with the specified option group. - Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance. - PerformanceInsightsKMSKeyId: - type: string + Specifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied. + This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. + type: boolean + DomainIAMRoleName: description: |- - The AWS KMS key identifier for encryption of Performance Insights data. - The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. - If you do not specify a value for ``PerformanceInsightsKMSKeyId``, then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region. - For information about enabling Performance Insights, see [EnablePerformanceInsights](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-enableperformanceinsights). - PerformanceInsightsRetentionPeriod: - type: integer + The name of the IAM role to use when making API calls to the Directory Service. + This setting doesn't apply to the following DB instances: + + Amazon Aurora (The domain is managed by the DB cluster.) + + RDS Custom + type: string + ReplicaMode: description: |- - The number of days to retain Performance Insights data. - This setting doesn't apply to RDS Custom DB instances. - Valid Values: - + ``7`` - + *month* * 31, where *month* is a number of months from 1-23. Examples: ``93`` (3 months * 31), ``341`` (11 months * 31), ``589`` (19 months * 31) - + ``731`` - - Default: ``7`` days - If you specify a retention period that isn't valid, such as ``94``, Amazon RDS returns an error. - Port: + The open mode of an Oracle read replica. For more information, see [Working with Oracle Read Replicas for Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html) in the *Amazon RDS User Guide*. + This setting is only supported in RDS for Oracle. + Default: ``open-read-only`` + Valid Values: ``open-read-only`` or ``mounted`` type: string + LicenseModel: description: |- - The port number on which the database accepts connections. - *Amazon Aurora* - Not applicable. The port number is managed by the DB cluster. - *Db2* - Default value: ``50000`` - pattern: ^\d*$ - PreferredBackupWindow: + License model information for this DB instance. + Valid Values: + + Aurora MySQL - ``general-public-license`` + + Aurora PostgreSQL - ``postgresql-license`` + + RDS for Db2 - ``bring-your-own-license``. For more information about RDS for Db2 licensing, see [](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-licensing.html) in the *Amazon RDS User Guide.* + + RDS for MariaDB - ``general-public-license`` + + RDS for Microsoft SQL Server - ``license-included`` + + RDS for MySQL - ``general-public-license`` + + RDS for Oracle - ``bring-your-own-license`` or ``license-included`` + + RDS for PostgreSQL - ``postgresql-license`` + + If you've specified ``DBSecurityGroups`` and then you update the license model, AWS CloudFormation replaces the underlying DB instance. This will incur some interruptions to database availability. type: string + DomainDnsIps: description: |- - The daily time range during which automated backups are created if automated backups are enabled, using the ``BackupRetentionPeriod`` parameter. For more information, see [Backup Window](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow) in the *Amazon RDS User Guide.* + The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers. Constraints: - + Must be in the format ``hh24:mi-hh24:mi``. - + Must be in Universal Coordinated Time (UTC). - + Must not conflict with the preferred maintenance window. - + Must be at least 30 minutes. + + 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. - *Amazon Aurora* - Not applicable. The daily time range for creating automated backups is managed by the DB cluster. + Example: ``123.124.125.126,234.235.236.237`` + type: array + items: + type: string PreferredMaintenanceWindow: - type: string description: |- The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ``ddd:hh24:mi-ddd:hh24:mi`` The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see [Adjusting the Preferred DB Instance Maintenance Window](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow) in the *Amazon RDS User Guide.* This property applies when AWS CloudFormation initially creates the DB instance. If you use AWS CloudFormation to update the DB instance, those updates are applied immediately. Constraints: Minimum 30-minute window. - ProcessorFeatures: - type: array - items: - $ref: '#/components/schemas/ProcessorFeature' + type: string + Iops: description: |- - The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. - This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. - PromotionTier: + The number of I/O operations per second (IOPS) that the database provisions. The value must be equal to or greater than 1000. + If you specify this property, you must follow the range of allowed ratios of your requested IOPS rate to the amount of storage that you allocate (IOPS to allocated storage). For example, you can provision an Oracle database instance with 1000 IOPS and 200 GiB of storage (a ratio of 5:1), or specify 2000 IOPS with 200 GiB of storage (a ratio of 10:1). For more information, see [Amazon RDS Provisioned IOPS Storage to Improve Performance](https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/CHAP_Storage.html#USER_PIOPS) in the *Amazon RDS User Guide*. + If you specify ``io1`` for the ``StorageType`` property, then you must also specify the ``Iops`` property. + Constraints: + + For RDS for Db2, MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 of the storage amount for the DB instance. + + For RDS for SQL Server - Must be a multiple between 1 and 50 of the storage amount for the DB instance. type: integer - minimum: 0 - default: 1 - description: |- - The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see [Fault Tolerance for an Aurora DB Cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.AuroraHighAvailability.html#Aurora.Managing.FaultTolerance) in the *Amazon Aurora User Guide*. - This setting doesn't apply to RDS Custom DB instances. - Default: ``1`` - Valid Values: ``0 - 15`` - PubliclyAccessible: - type: boolean - description: |- - Indicates whether the DB instance is an internet-facing instance. If you specify true, AWS CloudFormation creates an instance with a publicly resolvable DNS name, which resolves to a public IP address. If you specify false, AWS CloudFormation creates an internal instance with a DNS name that resolves to a private IP address. - The default behavior value depends on your VPC setup and the database subnet group. For more information, see the ``PubliclyAccessible`` parameter in the [CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) in the *Amazon RDS API Reference*. - ReplicaMode: - description: |- - The open mode of an Oracle read replica. For more information, see [Working with Oracle Read Replicas for Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html) in the *Amazon RDS User Guide*. - This setting is only supported in RDS for Oracle. - Default: ``open-read-only`` - Valid Values: ``open-read-only`` or ``mounted`` + SourceRegion: + description: The ID of the region that contains the source DB instance for the read replica. type: string - RestoreTime: + UseLatestRestorableTime: description: |- - The date and time to restore from. + Specifies whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time. Constraints: - + Must be a time in Universal Coordinated Time (UTC) format. - + Must be before the latest restorable time for the DB instance. - + Can't be specified if the ``UseLatestRestorableTime`` parameter is enabled. - - Example: ``2009-09-07T23:45:00Z`` + + Can't be specified if the ``RestoreTime`` parameter is provided. + type: boolean + CACertificateIdentifier: + description: |- + The identifier of the CA certificate for this DB instance. + For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) in the *Amazon RDS User Guide* and [Using SSL/TLS to encrypt a connection to a DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) in the *Amazon Aurora User Guide*. type: string - format: date-time - SourceDBClusterIdentifier: + ManageMasterUserPassword: description: |- - The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas. + Specifies whether to manage the master user password with AWS Secrets Manager. + For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide.* Constraints: - + Must be the identifier of an existing Multi-AZ DB cluster. - + Can't be specified if the ``SourceDBInstanceIdentifier`` parameter is also specified. - + The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0. - + The source DB cluster must be in the same AWS-Region as the read replica. Cross-Region replication isn't supported. - type: string + + Can't manage the master user password with AWS Secrets Manager if ``MasterUserPassword`` is specified. + type: boolean SourceDbiResourceId: - type: string description: The resource ID of the source DB instance from which to restore. - SourceDBInstanceAutomatedBackupsArn: type: string + DomainAuthSecretArn: description: |- - The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, ``arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE``. - This setting doesn't apply to RDS Custom. - SourceDBInstanceIdentifier: + The ARN for the Secrets Manager secret with the credentials for the user joining the domain. + Example: ``arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456`` type: string - description: |- - If you want to create a read replica DB instance, specify the ID of the source DB instance. Each DB instance can have a limited number of read replicas. For more information, see [Working with Read Replicas](https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/USER_ReadRepl.html) in the *Amazon RDS User Guide*. - For information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide*. - The ``SourceDBInstanceIdentifier`` property determines whether a DB instance is a read replica. If you remove the ``SourceDBInstanceIdentifier`` property from your template and then update your stack, AWS CloudFormation promotes the Read Replica to a standalone DB instance. - + If you specify a source DB instance that uses VPC security groups, we recommend that you specify the ``VPCSecurityGroups`` property. If you don't specify the - SourceRegion: + AutomaticBackupReplicationRegion: + description: The destination region for the backup replication of the DB instance. For more info, see [Replicating automated backups to another Region](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReplicateBackups.html) in the *Amazon RDS User Guide*. type: string - description: The ID of the region that contains the source DB instance for the read replica. - StorageEncrypted: + VPCSecurityGroups: + uniqueItems: true + description: |- + A list of the VPC security group IDs to assign to the DB instance. The list can include both the physical IDs of existing VPC security groups and references to [AWS::EC2::SecurityGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html) resources created in the template. + If you plan to update the resource, don't specify VPC security groups in a shared VPC. + If you set ``VPCSecurityGroups``, you must not set [DBSecurityGroups](https://docs.aws.amazon.com//AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsecuritygroups), and vice versa. + You can migrate a DB instance in your stack from an RDS DB security group to a VPC security group, but keep the following in mind: + + You can't revert to using an RDS security group after you establish a VPC security group membership. + + When you migrate your DB instance to VPC security groups, if your stack update rolls back because the DB instance update fails or because an update fails in another AWS CloudFormation resource, the rollback fails because it can't revert to an RDS security group. + + To use the properties that are available when you use a VPC security group, you must recreate the DB instance. If you don't, AWS CloudFormation submits only the property values that are listed in the [DBSecurityGroups](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsecuritygroups) property. + + To avoid this situation, migrate your DB instance to using VPC security groups only when that is the only change in your stack template. + *Amazon Aurora* + Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. If specified, the setting must match the DB cluster setting. + type: array + items: + relationshipRef: + typeName: AWS::EC2::SecurityGroup + propertyPath: /properties/GroupId + type: string + AllowMajorVersionUpgrade: + description: |- + A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. + Constraints: Major version upgrades must be allowed when specifying a value for the ``EngineVersion`` parameter that is a different major version than the DB instance's current version. type: boolean + DBName: description: |- - A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted. - If you specify the ``KmsKeyId`` property, then you must enable encryption. - If you specify the ``SourceDBInstanceIdentifier`` property, don't specify this property. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specified ``KmsKeyId`` property is used. - If you specify the ``DBSnapshotIdentifier`` and the specified snapshot is encrypted, don't specify this property. The value is inherited from the snapshot, and the specified ``KmsKeyId`` property is used. - If you specify the ``DBSnapshotIdentifier`` and the specified snapshot isn't encrypted, you can use this property to specify that the restored DB instance is encrypted. Specify the ``KmsKeyId`` property for the KMS key to use for encryption. If you don't want the restored DB instance to be encrypted, then don't set this property or set it to ``false``. - *Amazon Aurora* - Not applicable. The encrypt - StorageType: + The meaning of this parameter differs according to the database engine you use. + If you specify the ``DBSnapshotIdentifier`` property, this property only applies to RDS for Oracle. + *Amazon Aurora* + Not applicable. The database name is managed by the DB cluster. + *Db2* + The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance. + Constraints: + + Must contain 1 to 64 letters or numbers. + + Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). + + Can't be a word reserved by the specified database engine. + + *MySQL* + The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. + Constraints: + + Must contain 1 to 64 letters or numbers. + + Can't be a word reserved by the specified database engine + + *MariaDB* + The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. + Constraints: + + Must contain 1 to 64 letters or numbers. + + Can't be a word reserved by the specified database engine + + *PostgreSQL* + The name of the database to create when the DB instance is created. If this parameter is not specified, the default ``postgres`` database is created in the DB instance. + Constraints: + + Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). + + Must contain 1 to 63 characters. + + Can't be a word reserved by the specified database engine + + *Oracle* + The Oracle System ID (SID) of the created DB instance. If you specify ``null``, the default value ``ORCL`` is used. You can't specify the string NULL, or any other reserved word, for ``DBName``. + Default: ``ORCL`` + Constraints: + + Can't be longer than 8 characters + + *SQL Server* + Not applicable. Must be null. type: string + EnableIAMDatabaseAuthentication: description: |- - Specifies the storage type to be associated with the DB instance. - Valid values: ``gp2 | gp3 | io1 | standard`` - The ``standard`` value is also known as magnetic. - If you specify ``io1`` or ``gp3``, you must also include a value for the ``Iops`` parameter. - Default: ``io1`` if the ``Iops`` parameter is specified, otherwise ``gp2`` - For more information, see [Amazon RDS DB Instance Storage](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html) in the *Amazon RDS User Guide*. + A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. + This property is supported for RDS for MariaDB, RDS for MySQL, and RDS for PostgreSQL. For more information, see [IAM Database Authentication for MariaDB, MySQL, and PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon RDS User Guide.* *Amazon Aurora* - Not applicable. Aurora data is stored in the cluster volume, which is a single, virtual volume that uses solid state drives (SSDs). - StorageThroughput: + Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster. + type: boolean + BackupRetentionPeriod: + default: 1 + description: |- + The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. + *Amazon Aurora* + Not applicable. The retention period for automated backups is managed by the DB cluster. + Default: 1 + Constraints: + + Must be a value from 0 to 35 + + Can't be set to 0 if the DB instance is a source to read replicas type: integer + minimum: 0 + CustomIAMInstanceProfile: description: |- - Specifies the storage throughput value for the DB instance. This setting applies only to the ``gp3`` storage type. - This setting doesn't apply to RDS Custom or Amazon Aurora. - Tags: - type: array - x-insertionOrder: false - uniqueItems: false - items: - $ref: '#/components/schemas/Tag' - description: An optional array of key-value pairs to apply to this DB instance. - TdeCredentialArn: - type: string - description: '' - TdeCredentialPassword: - type: string - description: '' - Timezone: + The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. + This setting is required for RDS Custom. + Constraints: + + The profile must exist in your account. + + The profile must have an IAM role that Amazon EC2 has permissions to assume. + + The instance profile name and the associated IAM role name must start with the prefix ``AWSRDSCustom``. + + For the list of permissions required for the IAM role, see [Configure IAM and your VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc) in the *Amazon RDS User Guide*. type: string - description: The time zone of the DB instance. The time zone parameter is currently supported only by [Microsoft SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone). - UseDefaultProcessorFeatures: - type: boolean + DBSnapshotIdentifier: description: |- - Specifies whether the DB instance class of the DB instance uses its default processor features. - This setting doesn't apply to RDS Custom DB instances. - UseLatestRestorableTime: - type: boolean + The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance. If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot. + By specifying this property, you can create a DB instance from the specified DB snapshot. If the ``DBSnapshotIdentifier`` property is an empty string or the ``AWS::RDS::DBInstance`` declaration has no ``DBSnapshotIdentifier`` property, AWS CloudFormation creates a new database. If the property contains a value (other than an empty string), AWS CloudFormation creates a database from the specified snapshot. If a snapshot with the specified name doesn't exist, AWS CloudFormation can't create the database and it rolls back the stack. + Some DB instance properties aren't valid when you restore from a snapshot, such as the ``MasterUsername`` and ``MasterUserPassword`` properties. For information about the properties that you can specify, see the ``RestoreDBInstanceFromDBSnapshot`` action in the *Amazon RDS API Reference*. + After you restore a DB instance with a ``DBSnapshotIdentifier`` property, you must specify the same ``DBSnapshotIdentifier`` property for any future updates to the DB instance. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify the ``DBSnapshotIdentifier`` property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specified ``DBSnapshotIdentifier`` property, and the original DB instance is deleted. + If you specify the ``DBSnapshotIdentifier`` property to restore a DB instance (as opposed to specifying it for DB instance updates), then don't specify the following properties: + + ``CharacterSetName`` + + ``DBClusterIdentifier`` + + ``DBName`` + + ``DeleteAutomatedBackups`` + + ``EnablePerformanceInsights`` + + ``KmsKeyId`` + + ``MasterUsername`` + + ``MasterUserPassword`` + + ``PerformanceInsightsKMSKeyId`` + + ``PerformanceInsightsRetentionPeriod`` + + ``PromotionTier`` + + ``SourceDBInstanceIdentifier`` + + ``SourceRegion`` + + ``StorageEncrypted`` (for an encrypted snapshot) + + ``Timezone`` + + *Amazon Aurora* + Not applicable. Snapshot restore is managed by the DB cluster. + type: string + EnableCloudwatchLogsExports: description: |- - Specifies whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time. - Constraints: - + Can't be specified if the ``RestoreTime`` parameter is provided. - VPCSecurityGroups: + The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see [Publishing Database Logs to Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the *Amazon Relational Database Service User Guide*. + *Amazon Aurora* + Not applicable. CloudWatch Logs exports are managed by the DB cluster. + *Db2* + Valid values: ``diag.log``, ``notify.log`` + *MariaDB* + Valid values: ``audit``, ``error``, ``general``, ``slowquery`` + *Microsoft SQL Server* + Valid values: ``agent``, ``error`` + *MySQL* + Valid values: ``audit``, ``error``, ``general``, ``slowquery`` + *Oracle* + Valid values: ``alert``, ``audit``, ``listener``, ``trace``, ``oemagent`` + *PostgreSQL* + Valid values: ``postgresql``, ``upgrade`` type: array - uniqueItems: true items: type: string + UseDefaultProcessorFeatures: description: |- - A list of the VPC security group IDs to assign to the DB instance. The list can include both the physical IDs of existing VPC security groups and references to [AWS::EC2::SecurityGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html) resources created in the template. - If you plan to update the resource, don't specify VPC security groups in a shared VPC. - If you set ``VPCSecurityGroups``, you must not set [DBSecurityGroups](https://docs.aws.amazon.com//AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsecuritygroups), and vice versa. - You can migrate a DB instance in your stack from an RDS DB security group to a VPC security group, but keep the following in mind: - + You can't revert to using an RDS security group after you establish a VPC security group membership. - + When you migrate your DB instance to VPC security groups, if your stack update rolls back because the DB instanc + Specifies whether the DB instance class of the DB instance uses its default processor features. + This setting doesn't apply to RDS Custom DB instances. + type: boolean x-stackQL-stringOnly: true x-title: CreateDBInstanceRequest type: object @@ -3787,7 +4110,7 @@ components: The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a DB engine and engine version compatible with that DB parameter group family. The DB parameter group family can't be changed when updating a DB parameter group. To list all of the available parameter group families, use the following command: - ``aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily"`` + ``aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily"`` The output contains duplicates. For more information, see ``CreateDBParameterGroup``. type: string @@ -3797,12 +4120,12 @@ components: RDS for Db2 requires you to bring your own Db2 license. You must enter your IBM customer ID (``rds.ibm_customer_id``) and site number (``rds.ibm_site_id``) before starting a Db2 instance. For more information about DB parameters and DB parameter groups for Amazon RDS DB engines, see [Working with DB Parameter Groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) in the *Amazon RDS User Guide*. For more information about DB cluster and DB instance parameters and parameter groups for Amazon Aurora DB engines, see [Working with DB Parameter Groups and DB Cluster Parameter Groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*. - AWS CloudFormation doesn't support specifying an apply method for each individual + AWS CloudFormation doesn't support specifying an apply method for each individual parameter. The default apply method for each parameter is used. type: object Tags: description: |- An optional array of key-value pairs to apply to this DB parameter group. - Currently, this is the only property that supports drift detection. + Currently, this is the only property that supports drift detection. type: array maxItems: 50 uniqueItems: false @@ -4254,7 +4577,7 @@ components: x-identifiers: - Engine - EngineVersion - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -4271,9 +4594,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -4283,44 +4606,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/customdb_engine_versions/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/customdb_engine_versions/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Engine') as engine, - JSON_EXTRACT(Properties, '$.EngineVersion') as engine_version - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::CustomDBEngineVersion' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Engine') as engine, - json_extract_path_text(Properties, 'EngineVersion') as engine_version - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::CustomDBEngineVersion' - AND region = 'us-east-1' - customdb_engine_version: - name: customdb_engine_version - id: aws.rds.customdb_engine_version - x-cfn-schema-name: CustomDBEngineVersion - x-cfn-type-name: AWS::RDS::CustomDBEngineVersion - x-identifiers: - - Engine - - EngineVersion - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -4331,12 +4619,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/customdb_engine_versions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/customdb_engine_versions/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/customdb_engine_version/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/customdb_engine_versions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -4358,27 +4650,45 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'DatabaseInstallationFilesS3BucketName') as database_installation_files_s3_bucket_name, - json_extract_path_text(Properties, 'DatabaseInstallationFilesS3Prefix') as database_installation_files_s3_prefix, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Engine') as engine, - json_extract_path_text(Properties, 'EngineVersion') as engine_version, - json_extract_path_text(Properties, 'KMSKeyId') as kms_key_id, - json_extract_path_text(Properties, 'Manifest') as manifest, - json_extract_path_text(Properties, 'DBEngineVersionArn') as db_engine_version_arn, - json_extract_path_text(Properties, 'SourceCustomDbEngineVersionIdentifier') as source_custom_db_engine_version_identifier, - json_extract_path_text(Properties, 'UseAwsProvidedLatestImage') as use_aws_provided_latest_image, - json_extract_path_text(Properties, 'ImageId') as image_id, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::RDS::CustomDBEngineVersion' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.Engine') as engine, + JSON_EXTRACT(Properties, '$.EngineVersion') as engine_version + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::CustomDBEngineVersion' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DatabaseInstallationFilesS3BucketName') as database_installation_files_s3_bucket_name, + json_extract_path_text(Properties, 'DatabaseInstallationFilesS3Prefix') as database_installation_files_s3_prefix, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Engine') as engine, + json_extract_path_text(Properties, 'EngineVersion') as engine_version, + json_extract_path_text(Properties, 'KMSKeyId') as kms_key_id, + json_extract_path_text(Properties, 'Manifest') as manifest, + json_extract_path_text(Properties, 'DBEngineVersionArn') as db_engine_version_arn, + json_extract_path_text(Properties, 'SourceCustomDbEngineVersionIdentifier') as source_custom_db_engine_version_identifier, + json_extract_path_text(Properties, 'UseAwsProvidedLatestImage') as use_aws_provided_latest_image, + json_extract_path_text(Properties, 'ImageId') as image_id, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::RDS::CustomDBEngineVersion' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Engine') as engine, + json_extract_path_text(Properties, 'EngineVersion') as engine_version + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::CustomDBEngineVersion' + AND region = 'us-east-1' db_clusters: name: db_clusters id: aws.rds.db_clusters @@ -4386,7 +4696,7 @@ components: x-cfn-type-name: AWS::RDS::DBCluster x-identifiers: - DBClusterIdentifier - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -4403,9 +4713,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -4415,41 +4725,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/db_clusters/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/db_clusters/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.DBClusterIdentifier') as db_cluster_identifier - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBCluster' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'DBClusterIdentifier') as db_cluster_identifier - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBCluster' - AND region = 'us-east-1' - db_cluster: - name: db_cluster - id: aws.rds.db_cluster - x-cfn-schema-name: DBCluster - x-cfn-type-name: AWS::RDS::DBCluster - x-identifiers: - - DBClusterIdentifier - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -4460,146 +4738,166 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/db_clusters/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/db_clusters/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/db_cluster/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/db_clusters/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.Endpoint') as endpoint, - JSON_EXTRACT(Properties, '$.ReadEndpoint') as read_endpoint, - JSON_EXTRACT(Properties, '$.AllocatedStorage') as allocated_storage, - JSON_EXTRACT(Properties, '$.AssociatedRoles') as associated_roles, - JSON_EXTRACT(Properties, '$.AvailabilityZones') as availability_zones, - JSON_EXTRACT(Properties, '$.AutoMinorVersionUpgrade') as auto_minor_version_upgrade, - JSON_EXTRACT(Properties, '$.BacktrackWindow') as backtrack_window, - JSON_EXTRACT(Properties, '$.BackupRetentionPeriod') as backup_retention_period, - JSON_EXTRACT(Properties, '$.CopyTagsToSnapshot') as copy_tags_to_snapshot, - JSON_EXTRACT(Properties, '$.DatabaseName') as database_name, - JSON_EXTRACT(Properties, '$.DBClusterArn') as db_cluster_arn, - JSON_EXTRACT(Properties, '$.DBClusterInstanceClass') as db_cluster_instance_class, - JSON_EXTRACT(Properties, '$.DBClusterResourceId') as db_cluster_resource_id, - JSON_EXTRACT(Properties, '$.DBInstanceParameterGroupName') as db_instance_parameter_group_name, + JSON_EXTRACT(Properties, '$.StorageEncrypted') as storage_encrypted, JSON_EXTRACT(Properties, '$.DBSystemId') as db_system_id, - JSON_EXTRACT(Properties, '$.GlobalClusterIdentifier') as global_cluster_identifier, + JSON_EXTRACT(Properties, '$.RestoreToTime') as restore_to_time, + JSON_EXTRACT(Properties, '$.EngineMode') as engine_mode, + JSON_EXTRACT(Properties, '$.Port') as port, JSON_EXTRACT(Properties, '$.DBClusterIdentifier') as db_cluster_identifier, - JSON_EXTRACT(Properties, '$.DBClusterParameterGroupName') as db_cluster_parameter_group_name, - JSON_EXTRACT(Properties, '$.DBSubnetGroupName') as db_subnet_group_name, - JSON_EXTRACT(Properties, '$.DeletionProtection') as deletion_protection, - JSON_EXTRACT(Properties, '$.Domain') as domain, - JSON_EXTRACT(Properties, '$.DomainIAMRoleName') as domain_iam_role_name, - JSON_EXTRACT(Properties, '$.EnableCloudwatchLogsExports') as enable_cloudwatch_logs_exports, - JSON_EXTRACT(Properties, '$.EnableGlobalWriteForwarding') as enable_global_write_forwarding, - JSON_EXTRACT(Properties, '$.EnableHttpEndpoint') as enable_http_endpoint, - JSON_EXTRACT(Properties, '$.EnableIAMDatabaseAuthentication') as enable_iam_database_authentication, + JSON_EXTRACT(Properties, '$.StorageThroughput') as storage_throughput, + JSON_EXTRACT(Properties, '$.MonitoringInterval') as monitoring_interval, + JSON_EXTRACT(Properties, '$.Endpoint') as endpoint, + JSON_EXTRACT(Properties, '$.ReplicationSourceIdentifier') as replication_source_identifier, JSON_EXTRACT(Properties, '$.Engine') as engine, - JSON_EXTRACT(Properties, '$.EngineMode') as engine_mode, + JSON_EXTRACT(Properties, '$.Tags') as tags, JSON_EXTRACT(Properties, '$.EngineVersion') as engine_version, - JSON_EXTRACT(Properties, '$.ManageMasterUserPassword') as manage_master_user_password, - JSON_EXTRACT(Properties, '$.Iops') as iops, + JSON_EXTRACT(Properties, '$.StorageType') as storage_type, JSON_EXTRACT(Properties, '$.KmsKeyId') as kms_key_id, - JSON_EXTRACT(Properties, '$.MasterUsername') as master_username, + JSON_EXTRACT(Properties, '$.ServerlessV2ScalingConfiguration') as serverless_v2_scaling_configuration, + JSON_EXTRACT(Properties, '$.PerformanceInsightsRetentionPeriod') as performance_insights_retention_period, + JSON_EXTRACT(Properties, '$.DatabaseName') as database_name, + JSON_EXTRACT(Properties, '$.DBClusterResourceId') as db_cluster_resource_id, + JSON_EXTRACT(Properties, '$.AutoMinorVersionUpgrade') as auto_minor_version_upgrade, + JSON_EXTRACT(Properties, '$.DBSubnetGroupName') as db_subnet_group_name, + JSON_EXTRACT(Properties, '$.DeletionProtection') as deletion_protection, + JSON_EXTRACT(Properties, '$.AllocatedStorage') as allocated_storage, JSON_EXTRACT(Properties, '$.MasterUserPassword') as master_user_password, JSON_EXTRACT(Properties, '$.MasterUserSecret') as master_user_secret, - JSON_EXTRACT(Properties, '$.MonitoringInterval') as monitoring_interval, - JSON_EXTRACT(Properties, '$.MonitoringRoleArn') as monitoring_role_arn, - JSON_EXTRACT(Properties, '$.NetworkType') as network_type, - JSON_EXTRACT(Properties, '$.PerformanceInsightsEnabled') as performance_insights_enabled, + JSON_EXTRACT(Properties, '$.SourceDBClusterIdentifier') as source_db_cluster_identifier, + JSON_EXTRACT(Properties, '$.MasterUsername') as master_username, + JSON_EXTRACT(Properties, '$.ScalingConfiguration') as scaling_configuration, + JSON_EXTRACT(Properties, '$.ReadEndpoint') as read_endpoint, JSON_EXTRACT(Properties, '$.PerformanceInsightsKmsKeyId') as performance_insights_kms_key_id, - JSON_EXTRACT(Properties, '$.PerformanceInsightsRetentionPeriod') as performance_insights_retention_period, - JSON_EXTRACT(Properties, '$.Port') as port, - JSON_EXTRACT(Properties, '$.PreferredBackupWindow') as preferred_backup_window, - JSON_EXTRACT(Properties, '$.PreferredMaintenanceWindow') as preferred_maintenance_window, JSON_EXTRACT(Properties, '$.PubliclyAccessible') as publicly_accessible, - JSON_EXTRACT(Properties, '$.ReplicationSourceIdentifier') as replication_source_identifier, - JSON_EXTRACT(Properties, '$.RestoreToTime') as restore_to_time, - JSON_EXTRACT(Properties, '$.RestoreType') as restore_type, - JSON_EXTRACT(Properties, '$.ServerlessV2ScalingConfiguration') as serverless_v2_scaling_configuration, - JSON_EXTRACT(Properties, '$.ScalingConfiguration') as scaling_configuration, + JSON_EXTRACT(Properties, '$.Domain') as domain, + JSON_EXTRACT(Properties, '$.BacktrackWindow') as backtrack_window, + JSON_EXTRACT(Properties, '$.DBInstanceParameterGroupName') as db_instance_parameter_group_name, + JSON_EXTRACT(Properties, '$.EnableGlobalWriteForwarding') as enable_global_write_forwarding, + JSON_EXTRACT(Properties, '$.MonitoringRoleArn') as monitoring_role_arn, + JSON_EXTRACT(Properties, '$.AssociatedRoles') as associated_roles, + JSON_EXTRACT(Properties, '$.EnableHttpEndpoint') as enable_http_endpoint, JSON_EXTRACT(Properties, '$.SnapshotIdentifier') as snapshot_identifier, - JSON_EXTRACT(Properties, '$.SourceDBClusterIdentifier') as source_db_cluster_identifier, + JSON_EXTRACT(Properties, '$.PreferredBackupWindow') as preferred_backup_window, + JSON_EXTRACT(Properties, '$.NetworkType') as network_type, + JSON_EXTRACT(Properties, '$.VpcSecurityGroupIds') as vpc_security_group_ids, + JSON_EXTRACT(Properties, '$.CopyTagsToSnapshot') as copy_tags_to_snapshot, + JSON_EXTRACT(Properties, '$.GlobalClusterIdentifier') as global_cluster_identifier, + JSON_EXTRACT(Properties, '$.RestoreType') as restore_type, + JSON_EXTRACT(Properties, '$.DomainIAMRoleName') as domain_iam_role_name, + JSON_EXTRACT(Properties, '$.DBClusterInstanceClass') as db_cluster_instance_class, + JSON_EXTRACT(Properties, '$.AvailabilityZones') as availability_zones, + JSON_EXTRACT(Properties, '$.DBClusterArn') as db_cluster_arn, + JSON_EXTRACT(Properties, '$.PreferredMaintenanceWindow') as preferred_maintenance_window, + JSON_EXTRACT(Properties, '$.Iops') as iops, JSON_EXTRACT(Properties, '$.SourceRegion') as source_region, - JSON_EXTRACT(Properties, '$.StorageEncrypted') as storage_encrypted, - JSON_EXTRACT(Properties, '$.StorageThroughput') as storage_throughput, - JSON_EXTRACT(Properties, '$.StorageType') as storage_type, - JSON_EXTRACT(Properties, '$.Tags') as tags, JSON_EXTRACT(Properties, '$.UseLatestRestorableTime') as use_latest_restorable_time, - JSON_EXTRACT(Properties, '$.VpcSecurityGroupIds') as vpc_security_group_ids + JSON_EXTRACT(Properties, '$.ManageMasterUserPassword') as manage_master_user_password, + JSON_EXTRACT(Properties, '$.EnableIAMDatabaseAuthentication') as enable_iam_database_authentication, + JSON_EXTRACT(Properties, '$.DBClusterParameterGroupName') as db_cluster_parameter_group_name, + JSON_EXTRACT(Properties, '$.PerformanceInsightsEnabled') as performance_insights_enabled, + JSON_EXTRACT(Properties, '$.BackupRetentionPeriod') as backup_retention_period, + JSON_EXTRACT(Properties, '$.EnableCloudwatchLogsExports') as enable_cloudwatch_logs_exports FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::RDS::DBCluster' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Endpoint') as endpoint, - json_extract_path_text(Properties, 'ReadEndpoint') as read_endpoint, - json_extract_path_text(Properties, 'AllocatedStorage') as allocated_storage, - json_extract_path_text(Properties, 'AssociatedRoles') as associated_roles, - json_extract_path_text(Properties, 'AvailabilityZones') as availability_zones, - json_extract_path_text(Properties, 'AutoMinorVersionUpgrade') as auto_minor_version_upgrade, - json_extract_path_text(Properties, 'BacktrackWindow') as backtrack_window, - json_extract_path_text(Properties, 'BackupRetentionPeriod') as backup_retention_period, - json_extract_path_text(Properties, 'CopyTagsToSnapshot') as copy_tags_to_snapshot, - json_extract_path_text(Properties, 'DatabaseName') as database_name, - json_extract_path_text(Properties, 'DBClusterArn') as db_cluster_arn, - json_extract_path_text(Properties, 'DBClusterInstanceClass') as db_cluster_instance_class, - json_extract_path_text(Properties, 'DBClusterResourceId') as db_cluster_resource_id, - json_extract_path_text(Properties, 'DBInstanceParameterGroupName') as db_instance_parameter_group_name, - json_extract_path_text(Properties, 'DBSystemId') as db_system_id, - json_extract_path_text(Properties, 'GlobalClusterIdentifier') as global_cluster_identifier, - json_extract_path_text(Properties, 'DBClusterIdentifier') as db_cluster_identifier, - json_extract_path_text(Properties, 'DBClusterParameterGroupName') as db_cluster_parameter_group_name, - json_extract_path_text(Properties, 'DBSubnetGroupName') as db_subnet_group_name, - json_extract_path_text(Properties, 'DeletionProtection') as deletion_protection, - json_extract_path_text(Properties, 'Domain') as domain, - json_extract_path_text(Properties, 'DomainIAMRoleName') as domain_iam_role_name, - json_extract_path_text(Properties, 'EnableCloudwatchLogsExports') as enable_cloudwatch_logs_exports, - json_extract_path_text(Properties, 'EnableGlobalWriteForwarding') as enable_global_write_forwarding, - json_extract_path_text(Properties, 'EnableHttpEndpoint') as enable_http_endpoint, - json_extract_path_text(Properties, 'EnableIAMDatabaseAuthentication') as enable_iam_database_authentication, - json_extract_path_text(Properties, 'Engine') as engine, - json_extract_path_text(Properties, 'EngineMode') as engine_mode, - json_extract_path_text(Properties, 'EngineVersion') as engine_version, - json_extract_path_text(Properties, 'ManageMasterUserPassword') as manage_master_user_password, - json_extract_path_text(Properties, 'Iops') as iops, - json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, - json_extract_path_text(Properties, 'MasterUsername') as master_username, - json_extract_path_text(Properties, 'MasterUserPassword') as master_user_password, - json_extract_path_text(Properties, 'MasterUserSecret') as master_user_secret, - json_extract_path_text(Properties, 'MonitoringInterval') as monitoring_interval, - json_extract_path_text(Properties, 'MonitoringRoleArn') as monitoring_role_arn, - json_extract_path_text(Properties, 'NetworkType') as network_type, - json_extract_path_text(Properties, 'PerformanceInsightsEnabled') as performance_insights_enabled, - json_extract_path_text(Properties, 'PerformanceInsightsKmsKeyId') as performance_insights_kms_key_id, - json_extract_path_text(Properties, 'PerformanceInsightsRetentionPeriod') as performance_insights_retention_period, - json_extract_path_text(Properties, 'Port') as port, - json_extract_path_text(Properties, 'PreferredBackupWindow') as preferred_backup_window, - json_extract_path_text(Properties, 'PreferredMaintenanceWindow') as preferred_maintenance_window, - json_extract_path_text(Properties, 'PubliclyAccessible') as publicly_accessible, - json_extract_path_text(Properties, 'ReplicationSourceIdentifier') as replication_source_identifier, - json_extract_path_text(Properties, 'RestoreToTime') as restore_to_time, - json_extract_path_text(Properties, 'RestoreType') as restore_type, - json_extract_path_text(Properties, 'ServerlessV2ScalingConfiguration') as serverless_v2_scaling_configuration, - json_extract_path_text(Properties, 'ScalingConfiguration') as scaling_configuration, - json_extract_path_text(Properties, 'SnapshotIdentifier') as snapshot_identifier, - json_extract_path_text(Properties, 'SourceDBClusterIdentifier') as source_db_cluster_identifier, - json_extract_path_text(Properties, 'SourceRegion') as source_region, - json_extract_path_text(Properties, 'StorageEncrypted') as storage_encrypted, - json_extract_path_text(Properties, 'StorageThroughput') as storage_throughput, - json_extract_path_text(Properties, 'StorageType') as storage_type, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'UseLatestRestorableTime') as use_latest_restorable_time, - json_extract_path_text(Properties, 'VpcSecurityGroupIds') as vpc_security_group_ids - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::RDS::DBCluster' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.DBClusterIdentifier') as db_cluster_identifier + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBCluster' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'StorageEncrypted') as storage_encrypted, + json_extract_path_text(Properties, 'DBSystemId') as db_system_id, + json_extract_path_text(Properties, 'RestoreToTime') as restore_to_time, + json_extract_path_text(Properties, 'EngineMode') as engine_mode, + json_extract_path_text(Properties, 'Port') as port, + json_extract_path_text(Properties, 'DBClusterIdentifier') as db_cluster_identifier, + json_extract_path_text(Properties, 'StorageThroughput') as storage_throughput, + json_extract_path_text(Properties, 'MonitoringInterval') as monitoring_interval, + json_extract_path_text(Properties, 'Endpoint') as endpoint, + json_extract_path_text(Properties, 'ReplicationSourceIdentifier') as replication_source_identifier, + json_extract_path_text(Properties, 'Engine') as engine, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'EngineVersion') as engine_version, + json_extract_path_text(Properties, 'StorageType') as storage_type, + json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, + json_extract_path_text(Properties, 'ServerlessV2ScalingConfiguration') as serverless_v2_scaling_configuration, + json_extract_path_text(Properties, 'PerformanceInsightsRetentionPeriod') as performance_insights_retention_period, + json_extract_path_text(Properties, 'DatabaseName') as database_name, + json_extract_path_text(Properties, 'DBClusterResourceId') as db_cluster_resource_id, + json_extract_path_text(Properties, 'AutoMinorVersionUpgrade') as auto_minor_version_upgrade, + json_extract_path_text(Properties, 'DBSubnetGroupName') as db_subnet_group_name, + json_extract_path_text(Properties, 'DeletionProtection') as deletion_protection, + json_extract_path_text(Properties, 'AllocatedStorage') as allocated_storage, + json_extract_path_text(Properties, 'MasterUserPassword') as master_user_password, + json_extract_path_text(Properties, 'MasterUserSecret') as master_user_secret, + json_extract_path_text(Properties, 'SourceDBClusterIdentifier') as source_db_cluster_identifier, + json_extract_path_text(Properties, 'MasterUsername') as master_username, + json_extract_path_text(Properties, 'ScalingConfiguration') as scaling_configuration, + json_extract_path_text(Properties, 'ReadEndpoint') as read_endpoint, + json_extract_path_text(Properties, 'PerformanceInsightsKmsKeyId') as performance_insights_kms_key_id, + json_extract_path_text(Properties, 'PubliclyAccessible') as publicly_accessible, + json_extract_path_text(Properties, 'Domain') as domain, + json_extract_path_text(Properties, 'BacktrackWindow') as backtrack_window, + json_extract_path_text(Properties, 'DBInstanceParameterGroupName') as db_instance_parameter_group_name, + json_extract_path_text(Properties, 'EnableGlobalWriteForwarding') as enable_global_write_forwarding, + json_extract_path_text(Properties, 'MonitoringRoleArn') as monitoring_role_arn, + json_extract_path_text(Properties, 'AssociatedRoles') as associated_roles, + json_extract_path_text(Properties, 'EnableHttpEndpoint') as enable_http_endpoint, + json_extract_path_text(Properties, 'SnapshotIdentifier') as snapshot_identifier, + json_extract_path_text(Properties, 'PreferredBackupWindow') as preferred_backup_window, + json_extract_path_text(Properties, 'NetworkType') as network_type, + json_extract_path_text(Properties, 'VpcSecurityGroupIds') as vpc_security_group_ids, + json_extract_path_text(Properties, 'CopyTagsToSnapshot') as copy_tags_to_snapshot, + json_extract_path_text(Properties, 'GlobalClusterIdentifier') as global_cluster_identifier, + json_extract_path_text(Properties, 'RestoreType') as restore_type, + json_extract_path_text(Properties, 'DomainIAMRoleName') as domain_iam_role_name, + json_extract_path_text(Properties, 'DBClusterInstanceClass') as db_cluster_instance_class, + json_extract_path_text(Properties, 'AvailabilityZones') as availability_zones, + json_extract_path_text(Properties, 'DBClusterArn') as db_cluster_arn, + json_extract_path_text(Properties, 'PreferredMaintenanceWindow') as preferred_maintenance_window, + json_extract_path_text(Properties, 'Iops') as iops, + json_extract_path_text(Properties, 'SourceRegion') as source_region, + json_extract_path_text(Properties, 'UseLatestRestorableTime') as use_latest_restorable_time, + json_extract_path_text(Properties, 'ManageMasterUserPassword') as manage_master_user_password, + json_extract_path_text(Properties, 'EnableIAMDatabaseAuthentication') as enable_iam_database_authentication, + json_extract_path_text(Properties, 'DBClusterParameterGroupName') as db_cluster_parameter_group_name, + json_extract_path_text(Properties, 'PerformanceInsightsEnabled') as performance_insights_enabled, + json_extract_path_text(Properties, 'BackupRetentionPeriod') as backup_retention_period, + json_extract_path_text(Properties, 'EnableCloudwatchLogsExports') as enable_cloudwatch_logs_exports + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::RDS::DBCluster' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DBClusterIdentifier') as db_cluster_identifier + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBCluster' + AND region = 'us-east-1' db_cluster_parameter_groups: name: db_cluster_parameter_groups id: aws.rds.db_cluster_parameter_groups @@ -4607,67 +4905,23 @@ components: x-cfn-type-name: AWS::RDS::DBClusterParameterGroup x-identifiers: - DBClusterParameterGroupName - x-type: list + x-type: cloud_control methods: create_resource: config: - requestBodyTranslate: - algorithm: naive_DesiredState - operation: - $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DBClusterParameterGroup&__detailTransformed=true/post' - request: - mediaType: application/x-amz-json-1.0 - base: |- - { - "TypeName": "AWS::RDS::DBClusterParameterGroup" - } - response: - mediaType: application/json - openAPIDocKey: '200' - delete_resource: - operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' - request: - mediaType: application/x-amz-json-1.0 - base: |- - { - "TypeName": "AWS::RDS::DBClusterParameterGroup" - } - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/db_cluster_parameter_groups/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/db_cluster_parameter_groups/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.DBClusterParameterGroupName') as db_cluster_parameter_group_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBClusterParameterGroup' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'DBClusterParameterGroupName') as db_cluster_parameter_group_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBClusterParameterGroup' - AND region = 'us-east-1' - db_cluster_parameter_group: - name: db_cluster_parameter_group - id: aws.rds.db_cluster_parameter_group - x-cfn-schema-name: DBClusterParameterGroup - x-cfn-type-name: AWS::RDS::DBClusterParameterGroup - x-identifiers: - - DBClusterParameterGroupName - x-type: get - methods: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__DBClusterParameterGroup&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RDS::DBClusterParameterGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' update_resource: operation: $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' @@ -4680,13 +4934,29 @@ components: response: mediaType: application/json openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::RDS::DBClusterParameterGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/db_cluster_parameter_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/db_cluster_parameter_groups/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/db_cluster_parameter_group/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/db_cluster_parameter_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -4700,19 +4970,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Family') as family, - json_extract_path_text(Properties, 'Parameters') as parameters, - json_extract_path_text(Properties, 'DBClusterParameterGroupName') as db_cluster_parameter_group_name, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::RDS::DBClusterParameterGroup' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.DBClusterParameterGroupName') as db_cluster_parameter_group_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBClusterParameterGroup' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Family') as family, + json_extract_path_text(Properties, 'Parameters') as parameters, + json_extract_path_text(Properties, 'DBClusterParameterGroupName') as db_cluster_parameter_group_name, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::RDS::DBClusterParameterGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DBClusterParameterGroupName') as db_cluster_parameter_group_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBClusterParameterGroup' + AND region = 'us-east-1' db_instances: name: db_instances id: aws.rds.db_instances @@ -4720,7 +5006,7 @@ components: x-cfn-type-name: AWS::RDS::DBInstance x-identifiers: - DBInstanceIdentifier - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -4737,9 +5023,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -4749,41 +5035,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/db_instances/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/db_instances/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.DBInstanceIdentifier') as db_instance_identifier - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBInstance' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'DBInstanceIdentifier') as db_instance_identifier - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBInstance' - AND region = 'us-east-1' - db_instance: - name: db_instance - id: aws.rds.db_instance - x-cfn-schema-name: DBInstance - x-cfn-type-name: AWS::RDS::DBInstance - x-identifiers: - - DBInstanceIdentifier - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -4794,186 +5048,208 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/db_instances/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/db_instances/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/db_instance/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/db_instances/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.AllocatedStorage') as allocated_storage, - JSON_EXTRACT(Properties, '$.AllowMajorVersionUpgrade') as allow_major_version_upgrade, - JSON_EXTRACT(Properties, '$.AssociatedRoles') as associated_roles, - JSON_EXTRACT(Properties, '$.AutoMinorVersionUpgrade') as auto_minor_version_upgrade, - JSON_EXTRACT(Properties, '$.AutomaticBackupReplicationRegion') as automatic_backup_replication_region, - JSON_EXTRACT(Properties, '$.AvailabilityZone') as availability_zone, - JSON_EXTRACT(Properties, '$.BackupRetentionPeriod') as backup_retention_period, - JSON_EXTRACT(Properties, '$.CACertificateIdentifier') as ca_certificate_identifier, + JSON_EXTRACT(Properties, '$.StorageEncrypted') as storage_encrypted, + JSON_EXTRACT(Properties, '$.Timezone') as timezone, + JSON_EXTRACT(Properties, '$.DBSystemId') as db_system_id, JSON_EXTRACT(Properties, '$.CertificateDetails') as certificate_details, - JSON_EXTRACT(Properties, '$.CertificateRotationRestart') as certificate_rotation_restart, - JSON_EXTRACT(Properties, '$.CharacterSetName') as character_set_name, - JSON_EXTRACT(Properties, '$.CopyTagsToSnapshot') as copy_tags_to_snapshot, - JSON_EXTRACT(Properties, '$.CustomIAMInstanceProfile') as custom_iam_instance_profile, + JSON_EXTRACT(Properties, '$.Port') as port, JSON_EXTRACT(Properties, '$.DBClusterIdentifier') as db_cluster_identifier, - JSON_EXTRACT(Properties, '$.DBClusterSnapshotIdentifier') as db_cluster_snapshot_identifier, - JSON_EXTRACT(Properties, '$.DBInstanceArn') as db_instance_arn, - JSON_EXTRACT(Properties, '$.DBInstanceClass') as db_instance_class, - JSON_EXTRACT(Properties, '$.DBInstanceIdentifier') as db_instance_identifier, + JSON_EXTRACT(Properties, '$.StorageThroughput') as storage_throughput, JSON_EXTRACT(Properties, '$.DbiResourceId') as dbi_resource_id, - JSON_EXTRACT(Properties, '$.DBName') as db_name, + JSON_EXTRACT(Properties, '$.MonitoringInterval') as monitoring_interval, JSON_EXTRACT(Properties, '$.DBParameterGroupName') as db_parameter_group_name, - JSON_EXTRACT(Properties, '$.DBSecurityGroups') as db_security_groups, - JSON_EXTRACT(Properties, '$.DBSnapshotIdentifier') as db_snapshot_identifier, - JSON_EXTRACT(Properties, '$.DBSubnetGroupName') as db_subnet_group_name, - JSON_EXTRACT(Properties, '$.DBSystemId') as db_system_id, - JSON_EXTRACT(Properties, '$.DedicatedLogVolume') as dedicated_log_volume, - JSON_EXTRACT(Properties, '$.DeleteAutomatedBackups') as delete_automated_backups, - JSON_EXTRACT(Properties, '$.DeletionProtection') as deletion_protection, - JSON_EXTRACT(Properties, '$.Domain') as domain, - JSON_EXTRACT(Properties, '$.DomainAuthSecretArn') as domain_auth_secret_arn, - JSON_EXTRACT(Properties, '$.DomainDnsIps') as domain_dns_ips, - JSON_EXTRACT(Properties, '$.DomainFqdn') as domain_fqdn, - JSON_EXTRACT(Properties, '$.DomainIAMRoleName') as domain_iam_role_name, - JSON_EXTRACT(Properties, '$.DomainOu') as domain_ou, - JSON_EXTRACT(Properties, '$.EnableCloudwatchLogsExports') as enable_cloudwatch_logs_exports, - JSON_EXTRACT(Properties, '$.EnableIAMDatabaseAuthentication') as enable_iam_database_authentication, - JSON_EXTRACT(Properties, '$.EnablePerformanceInsights') as enable_performance_insights, + JSON_EXTRACT(Properties, '$.DBInstanceArn') as db_instance_arn, JSON_EXTRACT(Properties, '$.Endpoint') as endpoint, + JSON_EXTRACT(Properties, '$.TdeCredentialArn') as tde_credential_arn, + JSON_EXTRACT(Properties, '$.AutomaticBackupReplicationKmsKeyId') as automatic_backup_replication_kms_key_id, + JSON_EXTRACT(Properties, '$.MultiAZ') as multi_az, JSON_EXTRACT(Properties, '$.Engine') as engine, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.PerformanceInsightsKMSKeyId') as performance_insights_kms_key_id, + JSON_EXTRACT(Properties, '$.TdeCredentialPassword') as tde_credential_password, + JSON_EXTRACT(Properties, '$.SourceDBInstanceIdentifier') as source_db_instance_identifier, JSON_EXTRACT(Properties, '$.EngineVersion') as engine_version, - JSON_EXTRACT(Properties, '$.ManageMasterUserPassword') as manage_master_user_password, - JSON_EXTRACT(Properties, '$.Iops') as iops, + JSON_EXTRACT(Properties, '$.StorageType') as storage_type, JSON_EXTRACT(Properties, '$.KmsKeyId') as kms_key_id, - JSON_EXTRACT(Properties, '$.LicenseModel') as license_model, - JSON_EXTRACT(Properties, '$.MasterUsername') as master_username, + JSON_EXTRACT(Properties, '$.DBInstanceClass') as db_instance_class, + JSON_EXTRACT(Properties, '$.DeleteAutomatedBackups') as delete_automated_backups, + JSON_EXTRACT(Properties, '$.PerformanceInsightsRetentionPeriod') as performance_insights_retention_period, + JSON_EXTRACT(Properties, '$.AvailabilityZone') as availability_zone, + JSON_EXTRACT(Properties, '$.OptionGroupName') as option_group_name, + JSON_EXTRACT(Properties, '$.EnablePerformanceInsights') as enable_performance_insights, + JSON_EXTRACT(Properties, '$.AutoMinorVersionUpgrade') as auto_minor_version_upgrade, + JSON_EXTRACT(Properties, '$.DBSubnetGroupName') as db_subnet_group_name, + JSON_EXTRACT(Properties, '$.DeletionProtection') as deletion_protection, + JSON_EXTRACT(Properties, '$.DBInstanceIdentifier') as db_instance_identifier, + JSON_EXTRACT(Properties, '$.AllocatedStorage') as allocated_storage, JSON_EXTRACT(Properties, '$.MasterUserPassword') as master_user_password, JSON_EXTRACT(Properties, '$.MasterUserSecret') as master_user_secret, - JSON_EXTRACT(Properties, '$.MaxAllocatedStorage') as max_allocated_storage, - JSON_EXTRACT(Properties, '$.MonitoringInterval') as monitoring_interval, - JSON_EXTRACT(Properties, '$.MonitoringRoleArn') as monitoring_role_arn, - JSON_EXTRACT(Properties, '$.MultiAZ') as multi_az, JSON_EXTRACT(Properties, '$.NcharCharacterSetName') as nchar_character_set_name, - JSON_EXTRACT(Properties, '$.NetworkType') as network_type, - JSON_EXTRACT(Properties, '$.OptionGroupName') as option_group_name, - JSON_EXTRACT(Properties, '$.PerformanceInsightsKMSKeyId') as performance_insights_kms_key_id, - JSON_EXTRACT(Properties, '$.PerformanceInsightsRetentionPeriod') as performance_insights_retention_period, - JSON_EXTRACT(Properties, '$.Port') as port, - JSON_EXTRACT(Properties, '$.PreferredBackupWindow') as preferred_backup_window, - JSON_EXTRACT(Properties, '$.PreferredMaintenanceWindow') as preferred_maintenance_window, - JSON_EXTRACT(Properties, '$.ProcessorFeatures') as processor_features, + JSON_EXTRACT(Properties, '$.SourceDBClusterIdentifier') as source_db_cluster_identifier, + JSON_EXTRACT(Properties, '$.DBSecurityGroups') as db_security_groups, + JSON_EXTRACT(Properties, '$.MasterUsername') as master_username, + JSON_EXTRACT(Properties, '$.MaxAllocatedStorage') as max_allocated_storage, JSON_EXTRACT(Properties, '$.PromotionTier') as promotion_tier, JSON_EXTRACT(Properties, '$.PubliclyAccessible') as publicly_accessible, - JSON_EXTRACT(Properties, '$.ReplicaMode') as replica_mode, - JSON_EXTRACT(Properties, '$.RestoreTime') as restore_time, - JSON_EXTRACT(Properties, '$.SourceDBClusterIdentifier') as source_db_cluster_identifier, - JSON_EXTRACT(Properties, '$.SourceDbiResourceId') as source_dbi_resource_id, + JSON_EXTRACT(Properties, '$.Domain') as domain, + JSON_EXTRACT(Properties, '$.DomainFqdn') as domain_fqdn, + JSON_EXTRACT(Properties, '$.CharacterSetName') as character_set_name, + JSON_EXTRACT(Properties, '$.MonitoringRoleArn') as monitoring_role_arn, + JSON_EXTRACT(Properties, '$.AssociatedRoles') as associated_roles, + JSON_EXTRACT(Properties, '$.DomainOu') as domain_ou, + JSON_EXTRACT(Properties, '$.DBClusterSnapshotIdentifier') as db_cluster_snapshot_identifier, JSON_EXTRACT(Properties, '$.SourceDBInstanceAutomatedBackupsArn') as source_db_instance_automated_backups_arn, - JSON_EXTRACT(Properties, '$.SourceDBInstanceIdentifier') as source_db_instance_identifier, + JSON_EXTRACT(Properties, '$.ProcessorFeatures') as processor_features, + JSON_EXTRACT(Properties, '$.PreferredBackupWindow') as preferred_backup_window, + JSON_EXTRACT(Properties, '$.RestoreTime') as restore_time, + JSON_EXTRACT(Properties, '$.CertificateRotationRestart') as certificate_rotation_restart, + JSON_EXTRACT(Properties, '$.NetworkType') as network_type, + JSON_EXTRACT(Properties, '$.DedicatedLogVolume') as dedicated_log_volume, + JSON_EXTRACT(Properties, '$.CopyTagsToSnapshot') as copy_tags_to_snapshot, + JSON_EXTRACT(Properties, '$.DomainIAMRoleName') as domain_iam_role_name, + JSON_EXTRACT(Properties, '$.ReplicaMode') as replica_mode, + JSON_EXTRACT(Properties, '$.LicenseModel') as license_model, + JSON_EXTRACT(Properties, '$.DomainDnsIps') as domain_dns_ips, + JSON_EXTRACT(Properties, '$.PreferredMaintenanceWindow') as preferred_maintenance_window, + JSON_EXTRACT(Properties, '$.Iops') as iops, JSON_EXTRACT(Properties, '$.SourceRegion') as source_region, - JSON_EXTRACT(Properties, '$.StorageEncrypted') as storage_encrypted, - JSON_EXTRACT(Properties, '$.StorageType') as storage_type, - JSON_EXTRACT(Properties, '$.StorageThroughput') as storage_throughput, - JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.TdeCredentialArn') as tde_credential_arn, - JSON_EXTRACT(Properties, '$.TdeCredentialPassword') as tde_credential_password, - JSON_EXTRACT(Properties, '$.Timezone') as timezone, - JSON_EXTRACT(Properties, '$.UseDefaultProcessorFeatures') as use_default_processor_features, JSON_EXTRACT(Properties, '$.UseLatestRestorableTime') as use_latest_restorable_time, - JSON_EXTRACT(Properties, '$.VPCSecurityGroups') as vpc_security_groups + JSON_EXTRACT(Properties, '$.CACertificateIdentifier') as ca_certificate_identifier, + JSON_EXTRACT(Properties, '$.ManageMasterUserPassword') as manage_master_user_password, + JSON_EXTRACT(Properties, '$.SourceDbiResourceId') as source_dbi_resource_id, + JSON_EXTRACT(Properties, '$.DomainAuthSecretArn') as domain_auth_secret_arn, + JSON_EXTRACT(Properties, '$.AutomaticBackupReplicationRegion') as automatic_backup_replication_region, + JSON_EXTRACT(Properties, '$.VPCSecurityGroups') as vpc_security_groups, + JSON_EXTRACT(Properties, '$.AllowMajorVersionUpgrade') as allow_major_version_upgrade, + JSON_EXTRACT(Properties, '$.DBName') as db_name, + JSON_EXTRACT(Properties, '$.EnableIAMDatabaseAuthentication') as enable_iam_database_authentication, + JSON_EXTRACT(Properties, '$.BackupRetentionPeriod') as backup_retention_period, + JSON_EXTRACT(Properties, '$.CustomIAMInstanceProfile') as custom_iam_instance_profile, + JSON_EXTRACT(Properties, '$.DBSnapshotIdentifier') as db_snapshot_identifier, + JSON_EXTRACT(Properties, '$.EnableCloudwatchLogsExports') as enable_cloudwatch_logs_exports, + JSON_EXTRACT(Properties, '$.UseDefaultProcessorFeatures') as use_default_processor_features FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::RDS::DBInstance' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AllocatedStorage') as allocated_storage, - json_extract_path_text(Properties, 'AllowMajorVersionUpgrade') as allow_major_version_upgrade, - json_extract_path_text(Properties, 'AssociatedRoles') as associated_roles, - json_extract_path_text(Properties, 'AutoMinorVersionUpgrade') as auto_minor_version_upgrade, - json_extract_path_text(Properties, 'AutomaticBackupReplicationRegion') as automatic_backup_replication_region, - json_extract_path_text(Properties, 'AvailabilityZone') as availability_zone, - json_extract_path_text(Properties, 'BackupRetentionPeriod') as backup_retention_period, - json_extract_path_text(Properties, 'CACertificateIdentifier') as ca_certificate_identifier, - json_extract_path_text(Properties, 'CertificateDetails') as certificate_details, - json_extract_path_text(Properties, 'CertificateRotationRestart') as certificate_rotation_restart, - json_extract_path_text(Properties, 'CharacterSetName') as character_set_name, - json_extract_path_text(Properties, 'CopyTagsToSnapshot') as copy_tags_to_snapshot, - json_extract_path_text(Properties, 'CustomIAMInstanceProfile') as custom_iam_instance_profile, - json_extract_path_text(Properties, 'DBClusterIdentifier') as db_cluster_identifier, - json_extract_path_text(Properties, 'DBClusterSnapshotIdentifier') as db_cluster_snapshot_identifier, - json_extract_path_text(Properties, 'DBInstanceArn') as db_instance_arn, - json_extract_path_text(Properties, 'DBInstanceClass') as db_instance_class, - json_extract_path_text(Properties, 'DBInstanceIdentifier') as db_instance_identifier, - json_extract_path_text(Properties, 'DbiResourceId') as dbi_resource_id, - json_extract_path_text(Properties, 'DBName') as db_name, - json_extract_path_text(Properties, 'DBParameterGroupName') as db_parameter_group_name, - json_extract_path_text(Properties, 'DBSecurityGroups') as db_security_groups, - json_extract_path_text(Properties, 'DBSnapshotIdentifier') as db_snapshot_identifier, - json_extract_path_text(Properties, 'DBSubnetGroupName') as db_subnet_group_name, - json_extract_path_text(Properties, 'DBSystemId') as db_system_id, - json_extract_path_text(Properties, 'DedicatedLogVolume') as dedicated_log_volume, - json_extract_path_text(Properties, 'DeleteAutomatedBackups') as delete_automated_backups, - json_extract_path_text(Properties, 'DeletionProtection') as deletion_protection, - json_extract_path_text(Properties, 'Domain') as domain, - json_extract_path_text(Properties, 'DomainAuthSecretArn') as domain_auth_secret_arn, - json_extract_path_text(Properties, 'DomainDnsIps') as domain_dns_ips, - json_extract_path_text(Properties, 'DomainFqdn') as domain_fqdn, - json_extract_path_text(Properties, 'DomainIAMRoleName') as domain_iam_role_name, - json_extract_path_text(Properties, 'DomainOu') as domain_ou, - json_extract_path_text(Properties, 'EnableCloudwatchLogsExports') as enable_cloudwatch_logs_exports, - json_extract_path_text(Properties, 'EnableIAMDatabaseAuthentication') as enable_iam_database_authentication, - json_extract_path_text(Properties, 'EnablePerformanceInsights') as enable_performance_insights, - json_extract_path_text(Properties, 'Endpoint') as endpoint, - json_extract_path_text(Properties, 'Engine') as engine, - json_extract_path_text(Properties, 'EngineVersion') as engine_version, - json_extract_path_text(Properties, 'ManageMasterUserPassword') as manage_master_user_password, - json_extract_path_text(Properties, 'Iops') as iops, - json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, - json_extract_path_text(Properties, 'LicenseModel') as license_model, - json_extract_path_text(Properties, 'MasterUsername') as master_username, - json_extract_path_text(Properties, 'MasterUserPassword') as master_user_password, - json_extract_path_text(Properties, 'MasterUserSecret') as master_user_secret, - json_extract_path_text(Properties, 'MaxAllocatedStorage') as max_allocated_storage, - json_extract_path_text(Properties, 'MonitoringInterval') as monitoring_interval, - json_extract_path_text(Properties, 'MonitoringRoleArn') as monitoring_role_arn, - json_extract_path_text(Properties, 'MultiAZ') as multi_az, - json_extract_path_text(Properties, 'NcharCharacterSetName') as nchar_character_set_name, - json_extract_path_text(Properties, 'NetworkType') as network_type, - json_extract_path_text(Properties, 'OptionGroupName') as option_group_name, - json_extract_path_text(Properties, 'PerformanceInsightsKMSKeyId') as performance_insights_kms_key_id, - json_extract_path_text(Properties, 'PerformanceInsightsRetentionPeriod') as performance_insights_retention_period, - json_extract_path_text(Properties, 'Port') as port, - json_extract_path_text(Properties, 'PreferredBackupWindow') as preferred_backup_window, - json_extract_path_text(Properties, 'PreferredMaintenanceWindow') as preferred_maintenance_window, - json_extract_path_text(Properties, 'ProcessorFeatures') as processor_features, - json_extract_path_text(Properties, 'PromotionTier') as promotion_tier, - json_extract_path_text(Properties, 'PubliclyAccessible') as publicly_accessible, - json_extract_path_text(Properties, 'ReplicaMode') as replica_mode, - json_extract_path_text(Properties, 'RestoreTime') as restore_time, - json_extract_path_text(Properties, 'SourceDBClusterIdentifier') as source_db_cluster_identifier, - json_extract_path_text(Properties, 'SourceDbiResourceId') as source_dbi_resource_id, - json_extract_path_text(Properties, 'SourceDBInstanceAutomatedBackupsArn') as source_db_instance_automated_backups_arn, - json_extract_path_text(Properties, 'SourceDBInstanceIdentifier') as source_db_instance_identifier, - json_extract_path_text(Properties, 'SourceRegion') as source_region, - json_extract_path_text(Properties, 'StorageEncrypted') as storage_encrypted, - json_extract_path_text(Properties, 'StorageType') as storage_type, - json_extract_path_text(Properties, 'StorageThroughput') as storage_throughput, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'TdeCredentialArn') as tde_credential_arn, - json_extract_path_text(Properties, 'TdeCredentialPassword') as tde_credential_password, - json_extract_path_text(Properties, 'Timezone') as timezone, - json_extract_path_text(Properties, 'UseDefaultProcessorFeatures') as use_default_processor_features, - json_extract_path_text(Properties, 'UseLatestRestorableTime') as use_latest_restorable_time, - json_extract_path_text(Properties, 'VPCSecurityGroups') as vpc_security_groups - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::RDS::DBInstance' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.DBInstanceIdentifier') as db_instance_identifier + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBInstance' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'StorageEncrypted') as storage_encrypted, + json_extract_path_text(Properties, 'Timezone') as timezone, + json_extract_path_text(Properties, 'DBSystemId') as db_system_id, + json_extract_path_text(Properties, 'CertificateDetails') as certificate_details, + json_extract_path_text(Properties, 'Port') as port, + json_extract_path_text(Properties, 'DBClusterIdentifier') as db_cluster_identifier, + json_extract_path_text(Properties, 'StorageThroughput') as storage_throughput, + json_extract_path_text(Properties, 'DbiResourceId') as dbi_resource_id, + json_extract_path_text(Properties, 'MonitoringInterval') as monitoring_interval, + json_extract_path_text(Properties, 'DBParameterGroupName') as db_parameter_group_name, + json_extract_path_text(Properties, 'DBInstanceArn') as db_instance_arn, + json_extract_path_text(Properties, 'Endpoint') as endpoint, + json_extract_path_text(Properties, 'TdeCredentialArn') as tde_credential_arn, + json_extract_path_text(Properties, 'AutomaticBackupReplicationKmsKeyId') as automatic_backup_replication_kms_key_id, + json_extract_path_text(Properties, 'MultiAZ') as multi_az, + json_extract_path_text(Properties, 'Engine') as engine, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'PerformanceInsightsKMSKeyId') as performance_insights_kms_key_id, + json_extract_path_text(Properties, 'TdeCredentialPassword') as tde_credential_password, + json_extract_path_text(Properties, 'SourceDBInstanceIdentifier') as source_db_instance_identifier, + json_extract_path_text(Properties, 'EngineVersion') as engine_version, + json_extract_path_text(Properties, 'StorageType') as storage_type, + json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, + json_extract_path_text(Properties, 'DBInstanceClass') as db_instance_class, + json_extract_path_text(Properties, 'DeleteAutomatedBackups') as delete_automated_backups, + json_extract_path_text(Properties, 'PerformanceInsightsRetentionPeriod') as performance_insights_retention_period, + json_extract_path_text(Properties, 'AvailabilityZone') as availability_zone, + json_extract_path_text(Properties, 'OptionGroupName') as option_group_name, + json_extract_path_text(Properties, 'EnablePerformanceInsights') as enable_performance_insights, + json_extract_path_text(Properties, 'AutoMinorVersionUpgrade') as auto_minor_version_upgrade, + json_extract_path_text(Properties, 'DBSubnetGroupName') as db_subnet_group_name, + json_extract_path_text(Properties, 'DeletionProtection') as deletion_protection, + json_extract_path_text(Properties, 'DBInstanceIdentifier') as db_instance_identifier, + json_extract_path_text(Properties, 'AllocatedStorage') as allocated_storage, + json_extract_path_text(Properties, 'MasterUserPassword') as master_user_password, + json_extract_path_text(Properties, 'MasterUserSecret') as master_user_secret, + json_extract_path_text(Properties, 'NcharCharacterSetName') as nchar_character_set_name, + json_extract_path_text(Properties, 'SourceDBClusterIdentifier') as source_db_cluster_identifier, + json_extract_path_text(Properties, 'DBSecurityGroups') as db_security_groups, + json_extract_path_text(Properties, 'MasterUsername') as master_username, + json_extract_path_text(Properties, 'MaxAllocatedStorage') as max_allocated_storage, + json_extract_path_text(Properties, 'PromotionTier') as promotion_tier, + json_extract_path_text(Properties, 'PubliclyAccessible') as publicly_accessible, + json_extract_path_text(Properties, 'Domain') as domain, + json_extract_path_text(Properties, 'DomainFqdn') as domain_fqdn, + json_extract_path_text(Properties, 'CharacterSetName') as character_set_name, + json_extract_path_text(Properties, 'MonitoringRoleArn') as monitoring_role_arn, + json_extract_path_text(Properties, 'AssociatedRoles') as associated_roles, + json_extract_path_text(Properties, 'DomainOu') as domain_ou, + json_extract_path_text(Properties, 'DBClusterSnapshotIdentifier') as db_cluster_snapshot_identifier, + json_extract_path_text(Properties, 'SourceDBInstanceAutomatedBackupsArn') as source_db_instance_automated_backups_arn, + json_extract_path_text(Properties, 'ProcessorFeatures') as processor_features, + json_extract_path_text(Properties, 'PreferredBackupWindow') as preferred_backup_window, + json_extract_path_text(Properties, 'RestoreTime') as restore_time, + json_extract_path_text(Properties, 'CertificateRotationRestart') as certificate_rotation_restart, + json_extract_path_text(Properties, 'NetworkType') as network_type, + json_extract_path_text(Properties, 'DedicatedLogVolume') as dedicated_log_volume, + json_extract_path_text(Properties, 'CopyTagsToSnapshot') as copy_tags_to_snapshot, + json_extract_path_text(Properties, 'DomainIAMRoleName') as domain_iam_role_name, + json_extract_path_text(Properties, 'ReplicaMode') as replica_mode, + json_extract_path_text(Properties, 'LicenseModel') as license_model, + json_extract_path_text(Properties, 'DomainDnsIps') as domain_dns_ips, + json_extract_path_text(Properties, 'PreferredMaintenanceWindow') as preferred_maintenance_window, + json_extract_path_text(Properties, 'Iops') as iops, + json_extract_path_text(Properties, 'SourceRegion') as source_region, + json_extract_path_text(Properties, 'UseLatestRestorableTime') as use_latest_restorable_time, + json_extract_path_text(Properties, 'CACertificateIdentifier') as ca_certificate_identifier, + json_extract_path_text(Properties, 'ManageMasterUserPassword') as manage_master_user_password, + json_extract_path_text(Properties, 'SourceDbiResourceId') as source_dbi_resource_id, + json_extract_path_text(Properties, 'DomainAuthSecretArn') as domain_auth_secret_arn, + json_extract_path_text(Properties, 'AutomaticBackupReplicationRegion') as automatic_backup_replication_region, + json_extract_path_text(Properties, 'VPCSecurityGroups') as vpc_security_groups, + json_extract_path_text(Properties, 'AllowMajorVersionUpgrade') as allow_major_version_upgrade, + json_extract_path_text(Properties, 'DBName') as db_name, + json_extract_path_text(Properties, 'EnableIAMDatabaseAuthentication') as enable_iam_database_authentication, + json_extract_path_text(Properties, 'BackupRetentionPeriod') as backup_retention_period, + json_extract_path_text(Properties, 'CustomIAMInstanceProfile') as custom_iam_instance_profile, + json_extract_path_text(Properties, 'DBSnapshotIdentifier') as db_snapshot_identifier, + json_extract_path_text(Properties, 'EnableCloudwatchLogsExports') as enable_cloudwatch_logs_exports, + json_extract_path_text(Properties, 'UseDefaultProcessorFeatures') as use_default_processor_features + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::RDS::DBInstance' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DBInstanceIdentifier') as db_instance_identifier + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBInstance' + AND region = 'us-east-1' db_parameter_groups: name: db_parameter_groups id: aws.rds.db_parameter_groups @@ -4981,7 +5257,7 @@ components: x-cfn-type-name: AWS::RDS::DBParameterGroup x-identifiers: - DBParameterGroupName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -4998,9 +5274,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -5010,41 +5286,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/db_parameter_groups/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/db_parameter_groups/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.DBParameterGroupName') as db_parameter_group_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBParameterGroup' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'DBParameterGroupName') as db_parameter_group_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBParameterGroup' - AND region = 'us-east-1' - db_parameter_group: - name: db_parameter_group - id: aws.rds.db_parameter_group - x-cfn-schema-name: DBParameterGroup - x-cfn-type-name: AWS::RDS::DBParameterGroup - x-identifiers: - - DBParameterGroupName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -5055,12 +5299,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/db_parameter_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/db_parameter_groups/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/db_parameter_group/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/db_parameter_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -5074,19 +5322,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'DBParameterGroupName') as db_parameter_group_name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Family') as family, - json_extract_path_text(Properties, 'Parameters') as parameters, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::RDS::DBParameterGroup' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.DBParameterGroupName') as db_parameter_group_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBParameterGroup' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DBParameterGroupName') as db_parameter_group_name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Family') as family, + json_extract_path_text(Properties, 'Parameters') as parameters, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::RDS::DBParameterGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DBParameterGroupName') as db_parameter_group_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBParameterGroup' + AND region = 'us-east-1' db_proxies: name: db_proxies id: aws.rds.db_proxies @@ -5094,7 +5358,7 @@ components: x-cfn-type-name: AWS::RDS::DBProxy x-identifiers: - DBProxyName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -5111,9 +5375,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -5123,41 +5387,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/db_proxies/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/db_proxies/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.DBProxyName') as db_proxy_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBProxy' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'DBProxyName') as db_proxy_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBProxy' - AND region = 'us-east-1' - db_proxy: - name: db_proxy - id: aws.rds.db_proxy - x-cfn-schema-name: DBProxy - x-cfn-type-name: AWS::RDS::DBProxy - x-identifiers: - - DBProxyName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -5168,12 +5400,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/db_proxies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/db_proxies/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/db_proxy/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/db_proxies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -5195,27 +5431,43 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Auth') as auth, - json_extract_path_text(Properties, 'DBProxyArn') as db_proxy_arn, - json_extract_path_text(Properties, 'DBProxyName') as db_proxy_name, - json_extract_path_text(Properties, 'DebugLogging') as debug_logging, - json_extract_path_text(Properties, 'Endpoint') as endpoint, - json_extract_path_text(Properties, 'EngineFamily') as engine_family, - json_extract_path_text(Properties, 'IdleClientTimeout') as idle_client_timeout, - json_extract_path_text(Properties, 'RequireTLS') as require_tls, - json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'VpcId') as vpc_id, - json_extract_path_text(Properties, 'VpcSecurityGroupIds') as vpc_security_group_ids, - json_extract_path_text(Properties, 'VpcSubnetIds') as vpc_subnet_ids - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::RDS::DBProxy' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.DBProxyName') as db_proxy_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBProxy' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Auth') as auth, + json_extract_path_text(Properties, 'DBProxyArn') as db_proxy_arn, + json_extract_path_text(Properties, 'DBProxyName') as db_proxy_name, + json_extract_path_text(Properties, 'DebugLogging') as debug_logging, + json_extract_path_text(Properties, 'Endpoint') as endpoint, + json_extract_path_text(Properties, 'EngineFamily') as engine_family, + json_extract_path_text(Properties, 'IdleClientTimeout') as idle_client_timeout, + json_extract_path_text(Properties, 'RequireTLS') as require_tls, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'VpcId') as vpc_id, + json_extract_path_text(Properties, 'VpcSecurityGroupIds') as vpc_security_group_ids, + json_extract_path_text(Properties, 'VpcSubnetIds') as vpc_subnet_ids + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::RDS::DBProxy' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DBProxyName') as db_proxy_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBProxy' + AND region = 'us-east-1' db_proxy_endpoints: name: db_proxy_endpoints id: aws.rds.db_proxy_endpoints @@ -5223,7 +5475,7 @@ components: x-cfn-type-name: AWS::RDS::DBProxyEndpoint x-identifiers: - DBProxyEndpointName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -5240,9 +5492,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -5252,41 +5504,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/db_proxy_endpoints/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/db_proxy_endpoints/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.DBProxyEndpointName') as db_proxy_endpoint_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBProxyEndpoint' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'DBProxyEndpointName') as db_proxy_endpoint_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBProxyEndpoint' - AND region = 'us-east-1' - db_proxy_endpoint: - name: db_proxy_endpoint - id: aws.rds.db_proxy_endpoint - x-cfn-schema-name: DBProxyEndpoint - x-cfn-type-name: AWS::RDS::DBProxyEndpoint - x-identifiers: - - DBProxyEndpointName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -5297,12 +5517,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/db_proxy_endpoints/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/db_proxy_endpoints/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/db_proxy_endpoint/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/db_proxy_endpoints/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -5321,24 +5545,40 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'DBProxyEndpointName') as db_proxy_endpoint_name, - json_extract_path_text(Properties, 'DBProxyEndpointArn') as db_proxy_endpoint_arn, - json_extract_path_text(Properties, 'DBProxyName') as db_proxy_name, - json_extract_path_text(Properties, 'VpcId') as vpc_id, - json_extract_path_text(Properties, 'VpcSecurityGroupIds') as vpc_security_group_ids, - json_extract_path_text(Properties, 'VpcSubnetIds') as vpc_subnet_ids, - json_extract_path_text(Properties, 'Endpoint') as endpoint, - json_extract_path_text(Properties, 'TargetRole') as target_role, - json_extract_path_text(Properties, 'IsDefault') as is_default, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::RDS::DBProxyEndpoint' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.DBProxyEndpointName') as db_proxy_endpoint_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBProxyEndpoint' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DBProxyEndpointName') as db_proxy_endpoint_name, + json_extract_path_text(Properties, 'DBProxyEndpointArn') as db_proxy_endpoint_arn, + json_extract_path_text(Properties, 'DBProxyName') as db_proxy_name, + json_extract_path_text(Properties, 'VpcId') as vpc_id, + json_extract_path_text(Properties, 'VpcSecurityGroupIds') as vpc_security_group_ids, + json_extract_path_text(Properties, 'VpcSubnetIds') as vpc_subnet_ids, + json_extract_path_text(Properties, 'Endpoint') as endpoint, + json_extract_path_text(Properties, 'TargetRole') as target_role, + json_extract_path_text(Properties, 'IsDefault') as is_default, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::RDS::DBProxyEndpoint' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DBProxyEndpointName') as db_proxy_endpoint_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBProxyEndpoint' + AND region = 'us-east-1' db_proxy_target_groups: name: db_proxy_target_groups id: aws.rds.db_proxy_target_groups @@ -5346,7 +5586,7 @@ components: x-cfn-type-name: AWS::RDS::DBProxyTargetGroup x-identifiers: - TargetGroupArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -5363,9 +5603,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -5375,41 +5615,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/db_proxy_target_groups/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/db_proxy_target_groups/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.TargetGroupArn') as target_group_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBProxyTargetGroup' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'TargetGroupArn') as target_group_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBProxyTargetGroup' - AND region = 'us-east-1' - db_proxy_target_group: - name: db_proxy_target_group - id: aws.rds.db_proxy_target_group - x-cfn-schema-name: DBProxyTargetGroup - x-cfn-type-name: AWS::RDS::DBProxyTargetGroup - x-identifiers: - - TargetGroupArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -5420,12 +5628,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/db_proxy_target_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/db_proxy_target_groups/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/db_proxy_target_group/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/db_proxy_target_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -5440,20 +5652,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'DBProxyName') as db_proxy_name, - json_extract_path_text(Properties, 'TargetGroupArn') as target_group_arn, - json_extract_path_text(Properties, 'TargetGroupName') as target_group_name, - json_extract_path_text(Properties, 'ConnectionPoolConfigurationInfo') as connection_pool_configuration_info, - json_extract_path_text(Properties, 'DBInstanceIdentifiers') as db_instance_identifiers, - json_extract_path_text(Properties, 'DBClusterIdentifiers') as db_cluster_identifiers - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::RDS::DBProxyTargetGroup' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.TargetGroupArn') as target_group_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBProxyTargetGroup' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DBProxyName') as db_proxy_name, + json_extract_path_text(Properties, 'TargetGroupArn') as target_group_arn, + json_extract_path_text(Properties, 'TargetGroupName') as target_group_name, + json_extract_path_text(Properties, 'ConnectionPoolConfigurationInfo') as connection_pool_configuration_info, + json_extract_path_text(Properties, 'DBInstanceIdentifiers') as db_instance_identifiers, + json_extract_path_text(Properties, 'DBClusterIdentifiers') as db_cluster_identifiers + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::RDS::DBProxyTargetGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'TargetGroupArn') as target_group_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBProxyTargetGroup' + AND region = 'us-east-1' db_subnet_groups: name: db_subnet_groups id: aws.rds.db_subnet_groups @@ -5461,7 +5689,7 @@ components: x-cfn-type-name: AWS::RDS::DBSubnetGroup x-identifiers: - DBSubnetGroupName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -5478,9 +5706,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -5490,41 +5718,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/db_subnet_groups/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/db_subnet_groups/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.DBSubnetGroupName') as db_subnet_group_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBSubnetGroup' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'DBSubnetGroupName') as db_subnet_group_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBSubnetGroup' - AND region = 'us-east-1' - db_subnet_group: - name: db_subnet_group - id: aws.rds.db_subnet_group - x-cfn-schema-name: DBSubnetGroup - x-cfn-type-name: AWS::RDS::DBSubnetGroup - x-identifiers: - - DBSubnetGroupName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -5535,12 +5731,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/db_subnet_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/db_subnet_groups/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/db_subnet_group/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/db_subnet_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -5553,18 +5753,34 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'DBSubnetGroupDescription') as db_subnet_group_description, - json_extract_path_text(Properties, 'DBSubnetGroupName') as db_subnet_group_name, - json_extract_path_text(Properties, 'SubnetIds') as subnet_ids, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::RDS::DBSubnetGroup' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.DBSubnetGroupName') as db_subnet_group_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBSubnetGroup' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DBSubnetGroupDescription') as db_subnet_group_description, + json_extract_path_text(Properties, 'DBSubnetGroupName') as db_subnet_group_name, + json_extract_path_text(Properties, 'SubnetIds') as subnet_ids, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::RDS::DBSubnetGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DBSubnetGroupName') as db_subnet_group_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::DBSubnetGroup' + AND region = 'us-east-1' event_subscriptions: name: event_subscriptions id: aws.rds.event_subscriptions @@ -5572,7 +5788,7 @@ components: x-cfn-type-name: AWS::RDS::EventSubscription x-identifiers: - SubscriptionName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -5589,9 +5805,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -5601,41 +5817,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/event_subscriptions/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/event_subscriptions/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.SubscriptionName') as subscription_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::EventSubscription' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'SubscriptionName') as subscription_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::EventSubscription' - AND region = 'us-east-1' - event_subscription: - name: event_subscription - id: aws.rds.event_subscription - x-cfn-schema-name: EventSubscription - x-cfn-type-name: AWS::RDS::EventSubscription - x-identifiers: - - SubscriptionName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -5646,12 +5830,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/event_subscriptions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/event_subscriptions/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/event_subscription/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/event_subscriptions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -5667,21 +5855,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'SubscriptionName') as subscription_name, - json_extract_path_text(Properties, 'Enabled') as enabled, - json_extract_path_text(Properties, 'EventCategories') as event_categories, - json_extract_path_text(Properties, 'SnsTopicArn') as sns_topic_arn, - json_extract_path_text(Properties, 'SourceIds') as source_ids, - json_extract_path_text(Properties, 'SourceType') as source_type - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::RDS::EventSubscription' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.SubscriptionName') as subscription_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::EventSubscription' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'SubscriptionName') as subscription_name, + json_extract_path_text(Properties, 'Enabled') as enabled, + json_extract_path_text(Properties, 'EventCategories') as event_categories, + json_extract_path_text(Properties, 'SnsTopicArn') as sns_topic_arn, + json_extract_path_text(Properties, 'SourceIds') as source_ids, + json_extract_path_text(Properties, 'SourceType') as source_type + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::RDS::EventSubscription' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'SubscriptionName') as subscription_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::EventSubscription' + AND region = 'us-east-1' global_clusters: name: global_clusters id: aws.rds.global_clusters @@ -5689,7 +5893,7 @@ components: x-cfn-type-name: AWS::RDS::GlobalCluster x-identifiers: - GlobalClusterIdentifier - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -5706,9 +5910,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -5718,41 +5922,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/global_clusters/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/global_clusters/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.GlobalClusterIdentifier') as global_cluster_identifier - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::GlobalCluster' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'GlobalClusterIdentifier') as global_cluster_identifier - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::GlobalCluster' - AND region = 'us-east-1' - global_cluster: - name: global_cluster - id: aws.rds.global_cluster - x-cfn-schema-name: GlobalCluster - x-cfn-type-name: AWS::RDS::GlobalCluster - x-identifiers: - - GlobalClusterIdentifier - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -5763,12 +5935,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/global_clusters/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/global_clusters/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/global_cluster/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/global_clusters/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -5783,20 +5959,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Engine') as engine, - json_extract_path_text(Properties, 'EngineVersion') as engine_version, - json_extract_path_text(Properties, 'DeletionProtection') as deletion_protection, - json_extract_path_text(Properties, 'GlobalClusterIdentifier') as global_cluster_identifier, - json_extract_path_text(Properties, 'SourceDBClusterIdentifier') as source_db_cluster_identifier, - json_extract_path_text(Properties, 'StorageEncrypted') as storage_encrypted - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::RDS::GlobalCluster' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.GlobalClusterIdentifier') as global_cluster_identifier + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::GlobalCluster' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Engine') as engine, + json_extract_path_text(Properties, 'EngineVersion') as engine_version, + json_extract_path_text(Properties, 'DeletionProtection') as deletion_protection, + json_extract_path_text(Properties, 'GlobalClusterIdentifier') as global_cluster_identifier, + json_extract_path_text(Properties, 'SourceDBClusterIdentifier') as source_db_cluster_identifier, + json_extract_path_text(Properties, 'StorageEncrypted') as storage_encrypted + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::RDS::GlobalCluster' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'GlobalClusterIdentifier') as global_cluster_identifier + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::GlobalCluster' + AND region = 'us-east-1' integrations: name: integrations id: aws.rds.integrations @@ -5804,7 +5996,7 @@ components: x-cfn-type-name: AWS::RDS::Integration x-identifiers: - IntegrationArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -5821,9 +6013,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -5833,41 +6025,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/integrations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/integrations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.IntegrationArn') as integration_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::Integration' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'IntegrationArn') as integration_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::Integration' - AND region = 'us-east-1' - integration: - name: integration - id: aws.rds.integration - x-cfn-schema-name: Integration - x-cfn-type-name: AWS::RDS::Integration - x-identifiers: - - IntegrationArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -5878,12 +6038,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/integrations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/integrations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/integration/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/integrations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -5902,24 +6066,40 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'IntegrationName') as integration_name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'DataFilter') as data_filter, - json_extract_path_text(Properties, 'SourceArn') as source_arn, - json_extract_path_text(Properties, 'TargetArn') as target_arn, - json_extract_path_text(Properties, 'IntegrationArn') as integration_arn, - json_extract_path_text(Properties, 'KMSKeyId') as kms_key_id, - json_extract_path_text(Properties, 'AdditionalEncryptionContext') as additional_encryption_context, - json_extract_path_text(Properties, 'CreateTime') as create_time - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::RDS::Integration' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.IntegrationArn') as integration_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::Integration' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'IntegrationName') as integration_name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'DataFilter') as data_filter, + json_extract_path_text(Properties, 'SourceArn') as source_arn, + json_extract_path_text(Properties, 'TargetArn') as target_arn, + json_extract_path_text(Properties, 'IntegrationArn') as integration_arn, + json_extract_path_text(Properties, 'KMSKeyId') as kms_key_id, + json_extract_path_text(Properties, 'AdditionalEncryptionContext') as additional_encryption_context, + json_extract_path_text(Properties, 'CreateTime') as create_time + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::RDS::Integration' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'IntegrationArn') as integration_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::Integration' + AND region = 'us-east-1' option_groups: name: option_groups id: aws.rds.option_groups @@ -5927,7 +6107,7 @@ components: x-cfn-type-name: AWS::RDS::OptionGroup x-identifiers: - OptionGroupName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -5944,9 +6124,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -5956,41 +6136,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/option_groups/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/option_groups/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.OptionGroupName') as option_group_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::OptionGroup' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'OptionGroupName') as option_group_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::OptionGroup' - AND region = 'us-east-1' - option_group: - name: option_group - id: aws.rds.option_group - x-cfn-schema-name: OptionGroup - x-cfn-type-name: AWS::RDS::OptionGroup - x-identifiers: - - OptionGroupName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -6001,12 +6149,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/option_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/option_groups/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/option_group/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/option_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -6021,20 +6173,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'OptionGroupName') as option_group_name, - json_extract_path_text(Properties, 'OptionGroupDescription') as option_group_description, - json_extract_path_text(Properties, 'EngineName') as engine_name, - json_extract_path_text(Properties, 'MajorEngineVersion') as major_engine_version, - json_extract_path_text(Properties, 'OptionConfigurations') as option_configurations, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::RDS::OptionGroup' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.OptionGroupName') as option_group_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::OptionGroup' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'OptionGroupName') as option_group_name, + json_extract_path_text(Properties, 'OptionGroupDescription') as option_group_description, + json_extract_path_text(Properties, 'EngineName') as engine_name, + json_extract_path_text(Properties, 'MajorEngineVersion') as major_engine_version, + json_extract_path_text(Properties, 'OptionConfigurations') as option_configurations, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::RDS::OptionGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'OptionGroupName') as option_group_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RDS::OptionGroup' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/redshift.yaml b/providers/src/aws/v00.00.00000/services/redshift.yaml index 63cdf892..a3600218 100644 --- a/providers/src/aws/v00.00.00000/services/redshift.yaml +++ b/providers/src/aws/v00.00.00000/services/redshift.yaml @@ -385,167 +385,162 @@ components: $ref: '#/components/x-cloud-control-schemas/ProgressEvent' type: object schemas: - Tag: - description: A key-value pair to associate with a resource. + Endpoint: + additionalProperties: false type: object properties: - Key: + Address: type: string - description: 'The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' - minLength: 1 - maxLength: 128 - Value: + Port: type: string - description: 'The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' - minLength: 0 - maxLength: 256 - required: - - Key - - Value - additionalProperties: false LoggingProperties: - type: object additionalProperties: false + type: object properties: BucketName: + x-relationshipRef: + typeName: AWS::S3::Bucket + propertyPath: /properties/BucketName type: string S3KeyPrefix: type: string - Endpoint: - type: object + Tag: + description: A key-value pair to associate with a resource. additionalProperties: false + type: object properties: - Port: + Value: + minLength: 0 + description: 'The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' type: string - Address: + maxLength: 256 + Key: + minLength: 1 + description: 'The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' type: string + maxLength: 128 + required: + - Key + - Value Cluster: type: object properties: - ClusterIdentifier: - description: A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. All alphabetical characters must be lower case, no hypens at the end, no two consecutive hyphens. Cluster name should be unique for all clusters within an AWS account - type: string - maxLength: 63 - ClusterNamespaceArn: - description: The Amazon Resource Name (ARN) of the cluster namespace. - type: string - MasterUsername: - description: The user name associated with the master user account for the cluster that is being created. The user name can't be PUBLIC and first character must be a letter. - type: string - maxLength: 128 - MasterUserPassword: - description: The password associated with the master user account for the cluster that is being created. You can't use MasterUserPassword if ManageMasterPassword is true. Password must be between 8 and 64 characters in length, should have at least one uppercase letter.Must contain at least one lowercase letter.Must contain one number.Can be any printable ASCII character. - type: string - maxLength: 64 - NodeType: - description: 'The node type to be provisioned for the cluster.Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.4xlarge | ra3.16xlarge' + RevisionTarget: + description: The identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request. type: string - AllowVersionUpgrade: - description: Major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. Default value is True - type: boolean AutomatedSnapshotRetentionPeriod: description: The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Default value is 1 type: integer - AvailabilityZone: - description: 'The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint' - type: string - ClusterParameterGroupName: - description: The name of the parameter group to be associated with this cluster. - type: string - maxLength: 255 - ClusterType: - description: The type of the cluster. When cluster type is specified as single-node, the NumberOfNodes parameter is not required and if multi-node, the NumberOfNodes parameter is required - type: string - ClusterVersion: - description: The version of the Amazon Redshift engine software that you want to deploy on the cluster.The version selected runs on all the nodes in the cluster. - type: string - ClusterSubnetGroupName: - description: The name of a cluster subnet group to be associated with this cluster. - type: string - DBName: - description: The name of the first database to be created when the cluster is created. To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. - type: string - ElasticIp: - description: The Elastic IP (EIP) address for the cluster. - type: string Encrypted: description: If true, the data in the cluster is encrypted at rest. type: boolean - HsmClientCertificateIdentifier: - description: Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM - type: string - HsmConfigurationIdentifier: - description: Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM. - type: string - KmsKeyId: - description: The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster. - type: string - NumberOfNodes: - description: The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node. - type: integer Port: description: The port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings type: integer - PreferredMaintenanceWindow: - description: The weekly time range (in UTC) during which automated cluster maintenance can occur. + NumberOfNodes: + description: The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node. + type: integer + DestinationRegion: + description: 'The destination AWS Region that you want to copy snapshots to. Constraints: Must be the name of a valid AWS Region. For more information, see Regions and Endpoints in the Amazon Web Services [https://docs.aws.amazon.com/general/latest/gr/rande.html#redshift_region] General Reference' type: string - PubliclyAccessible: - description: If true, the cluster can be accessed from a public network. + AllowVersionUpgrade: + description: Major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. Default value is True type: boolean - ClusterSecurityGroups: - description: A list of security groups to be associated with this cluster. - type: array - x-insertionOrder: false + Endpoint: + $ref: '#/components/schemas/Endpoint' + NamespaceResourcePolicy: + description: The namespace resource policy document that will be attached to a Redshift cluster. + type: object + MaintenanceTrackName: + description: The name for the maintenance track that you want to assign for the cluster. This name change is asynchronous. The new track name stays in the PendingModifiedValues for the cluster until the next maintenance window. When the maintenance track changes, the cluster is switched to the latest cluster release available for the maintenance track. At this point, the maintenance track name is applied. + type: string + OwnerAccount: + type: string + MultiAZ: + description: A boolean indicating if the redshift cluster is multi-az or not. If you don't provide this parameter or set the value to false, the redshift cluster will be single-az. + type: boolean + Tags: + maxItems: 50 uniqueItems: false + description: The list of tags for the cluster parameter group. + x-insertionOrder: false + type: array items: - type: string + $ref: '#/components/schemas/Tag' + SnapshotClusterIdentifier: + description: The name of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name. + type: string IamRoles: + maxItems: 50 description: A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 50 IAM roles in a single request - type: array x-insertionOrder: false - maxItems: 50 + type: array items: + relationshipRef: + typeName: AWS::IAM::Role + propertyPath: /properties/Arn type: string - Tags: - description: The list of tags for the cluster parameter group. - type: array - x-insertionOrder: false - maxItems: 50 + KmsKeyId: + description: The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster. + anyOf: + - relationshipRef: + typeName: AWS::KMS::Key + propertyPath: /properties/Arn + - relationshipRef: + typeName: AWS::KMS::Key + propertyPath: /properties/KeyId + type: string + SnapshotCopyManual: + description: Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots. + type: boolean + ManageMasterPassword: + description: A boolean indicating if the redshift cluster's admin user credentials is managed by Redshift or not. You can't use MasterUserPassword if ManageMasterPassword is true. If ManageMasterPassword is false or not set, Amazon Redshift uses MasterUserPassword for the admin user account's password. + type: boolean + AvailabilityZone: + description: 'The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint' + type: string + ClusterSecurityGroups: uniqueItems: false - items: - $ref: '#/components/schemas/Tag' - VpcSecurityGroupIds: - description: A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster. - type: array + description: A list of security groups to be associated with this cluster. x-insertionOrder: false - uniqueItems: false + type: array items: + anyOf: + - relationshipRef: + typeName: AWS::EC2::SecurityGroup + propertyPath: /properties/Id + - relationshipRef: + typeName: AWS::Redshift::ClusterSecurityGroup + propertyPath: /properties/Id type: string - SnapshotClusterIdentifier: - description: The name of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name. + ClusterIdentifier: + description: A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. All alphabetical characters must be lower case, no hypens at the end, no two consecutive hyphens. Cluster name should be unique for all clusters within an AWS account type: string - SnapshotIdentifier: - description: The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive. + maxLength: 63 + MasterUserPassword: + description: The password associated with the master user account for the cluster that is being created. You can't use MasterUserPassword if ManageMasterPassword is true. Password must be between 8 and 64 characters in length, should have at least one uppercase letter.Must contain at least one lowercase letter.Must contain one number.Can be any printable ASCII character. type: string - OwnerAccount: + maxLength: 64 + ClusterSubnetGroupName: + description: The name of a cluster subnet group to be associated with this cluster. type: string LoggingProperties: $ref: '#/components/schemas/LoggingProperties' - Endpoint: - $ref: '#/components/schemas/Endpoint' - DestinationRegion: - description: 'The destination AWS Region that you want to copy snapshots to. Constraints: Must be the name of a valid AWS Region. For more information, see Regions and Endpoints in the Amazon Web Services [https://docs.aws.amazon.com/general/latest/gr/rande.html#redshift_region] General Reference' + DeferMaintenance: + description: A boolean indicating whether to enable the deferred maintenance window. + type: boolean + NodeType: + description: 'The node type to be provisioned for the cluster.Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.4xlarge | ra3.16xlarge' type: string - SnapshotCopyRetentionPeriod: - description: |- - The number of days to retain automated snapshots in the destination region after they are copied from the source region. - - Default is 7. - - Constraints: Must be at least 1 and no more than 35. - type: integer - SnapshotCopyGrantName: - description: The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region. + MasterUsername: + description: The user name associated with the master user account for the cluster that is being created. The user name can't be PUBLIC and first character must be a letter. + type: string + maxLength: 128 + PubliclyAccessible: + description: If true, the cluster can be accessed from a public network. + type: boolean + DeferMaintenanceIdentifier: + description: A unique identifier for the deferred maintenance window. type: string ManualSnapshotRetentionPeriod: description: |- @@ -553,12 +548,15 @@ components: The value must be either -1 or an integer between 1 and 3,653. type: integer - SnapshotCopyManual: - description: Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots. - type: boolean - AvailabilityZoneRelocation: - description: The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete. - type: boolean + ResourceAction: + description: The Redshift operation to be performed. Resource Action supports pause-cluster, resume-cluster, failover-primary-compute APIs + type: string + HsmClientCertificateIdentifier: + description: Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM + type: string + ElasticIp: + description: The Elastic IP (EIP) address for the cluster. + type: string AvailabilityZoneRelocationStatus: description: The availability zone relocation status of the cluster type: string @@ -570,9 +568,15 @@ components: disabled - Don't use AQUA. auto - Amazon Redshift determines whether to use AQUA. type: string - Classic: - description: A boolean value indicating whether the resize operation is using the classic resize process. If you don't provide this parameter or set the value to false , the resize type is elastic. + SnapshotIdentifier: + description: The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive. + type: string + AvailabilityZoneRelocation: + description: The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete. type: boolean + SnapshotCopyGrantName: + description: The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region. + type: string EnhancedVpcRouting: description: |- An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide. @@ -581,48 +585,74 @@ components: Default: false type: boolean - MaintenanceTrackName: - description: The name for the maintenance track that you want to assign for the cluster. This name change is asynchronous. The new track name stays in the PendingModifiedValues for the cluster until the next maintenance window. When the maintenance track changes, the cluster is switched to the latest cluster release available for the maintenance track. At this point, the maintenance track name is applied. - type: string - DeferMaintenance: - description: A boolean indicating whether to enable the deferred maintenance window. - type: boolean - DeferMaintenanceIdentifier: - description: A unique identifier for the deferred maintenance window. - type: string - DeferMaintenanceStartTime: - description: A timestamp indicating the start time for the deferred maintenance window. + ClusterParameterGroupName: + description: The name of the parameter group to be associated with this cluster. type: string + maxLength: 255 DeferMaintenanceEndTime: description: A timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can't specify a duration. type: string - DeferMaintenanceDuration: - description: An integer indicating the duration of the maintenance window in days. If you specify a duration, you can't specify an end time. The duration must be 45 days or less. - type: integer - RevisionTarget: - description: The identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request. - type: string - ResourceAction: - description: The Redshift operation to be performed. Resource Action supports pause-cluster, resume-cluster, failover-primary-compute APIs - type: string RotateEncryptionKey: description: A boolean indicating if we want to rotate Encryption Keys. type: boolean - MultiAZ: - description: A boolean indicating if the redshift cluster is multi-az or not. If you don't provide this parameter or set the value to false, the redshift cluster will be single-az. - type: boolean - NamespaceResourcePolicy: - description: The namespace resource policy document that will be attached to a Redshift cluster. - type: object - ManageMasterPassword: - description: A boolean indicating if the redshift cluster's admin user credentials is managed by Redshift or not. You can't use MasterUserPassword if ManageMasterPassword is true. If ManageMasterPassword is false or not set, Amazon Redshift uses MasterUserPassword for the admin user account's password. + VpcSecurityGroupIds: + uniqueItems: false + description: A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster. + x-insertionOrder: false + type: array + items: + relationshipRef: + typeName: AWS::EC2::VPC + propertyPath: /properties/VpcId + type: string + ClusterNamespaceArn: + description: The Amazon Resource Name (ARN) of the cluster namespace. + type: string + MasterPasswordSecretArn: + description: The Amazon Resource Name (ARN) for the cluster's admin user credentials secret. + type: string + ClusterVersion: + description: The version of the Amazon Redshift engine software that you want to deploy on the cluster.The version selected runs on all the nodes in the cluster. + type: string + HsmConfigurationIdentifier: + description: Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM. + type: string + PreferredMaintenanceWindow: + description: The weekly time range (in UTC) during which automated cluster maintenance can occur. + type: string + DeferMaintenanceStartTime: + description: A timestamp indicating the start time for the deferred maintenance window. + type: string + ClusterType: + description: The type of the cluster. When cluster type is specified as single-node, the NumberOfNodes parameter is not required and if multi-node, the NumberOfNodes parameter is required + type: string + Classic: + description: A boolean value indicating whether the resize operation is using the classic resize process. If you don't provide this parameter or set the value to false , the resize type is elastic. type: boolean MasterPasswordSecretKmsKeyId: description: The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin user credentials secret. + anyOf: + - relationshipRef: + typeName: AWS::KMS::Key + propertyPath: /properties/Arn + - relationshipRef: + typeName: AWS::KMS::Key + propertyPath: /properties/KeyId type: string - MasterPasswordSecretArn: - description: The Amazon Resource Name (ARN) for the cluster's admin user credentials secret. + DeferMaintenanceDuration: + description: An integer indicating the duration of the maintenance window in days. If you specify a duration, you can't specify an end time. The duration must be 45 days or less. + type: integer + DBName: + description: The name of the first database to be created when the cluster is created. To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. type: string + SnapshotCopyRetentionPeriod: + description: |- + The number of days to retain automated snapshots in the destination region after they are copied from the source region. + + Default is 7. + + Constraints: Must be at least 1 and no more than 35. + type: integer required: - NodeType - MasterUsername @@ -662,6 +692,13 @@ components: x-tagging: taggable: true x-required-permissions: + read: + - redshift:DescribeClusters + - redshift:DescribeLoggingStatus + - redshift:DescribeSnapshotCopyGrant + - redshift:DescribeClusterDbRevisions + - redshift:DescribeTags + - redshift:GetResourcePolicy create: - iam:PassRole - iam:CreateServiceLinkedRole @@ -695,13 +732,6 @@ components: - ec2:DescribeNetworkAcls - ec2:DescribeRouteTables - cloudwatch:PutMetricData - read: - - redshift:DescribeClusters - - redshift:DescribeLoggingStatus - - redshift:DescribeSnapshotCopyGrant - - redshift:DescribeClusterDbRevisions - - redshift:DescribeTags - - redshift:GetResourcePolicy update: - iam:PassRole - redshift:DescribeClusters @@ -730,13 +760,13 @@ components: - redshift:GetResourcePolicy - redshift:DeleteResourcePolicy - cloudwatch:PutMetricData - delete: + list: - redshift:DescribeTags - redshift:DescribeClusters - - redshift:DeleteCluster - list: + delete: - redshift:DescribeTags - redshift:DescribeClusters + - redshift:DeleteCluster Parameter: type: object additionalProperties: false @@ -852,6 +882,9 @@ components: maxItems: 20 items: type: string + relationshipRef: + typeName: AWS::EC2::Subnet + propertyPath: /properties/SubnetId Tags: description: The list of tags for the cluster parameter group. type: array @@ -956,91 +989,109 @@ components: - ec2:DescribeVpcs VpcSecurityGroup: description: Describes the members of a VPC security group. + additionalProperties: false type: object properties: - VpcSecurityGroupId: + Status: + description: The status of the VPC security group. type: string + VpcSecurityGroupId: + x-relationshipRef: + typeName: AWS::EC2::SecurityGroup + propertyPath: /properties/Id description: The identifier of the VPC security group. - Status: type: string - description: The status of the VPC security group. - additionalProperties: false NetworkInterface: description: Describes a network interface. + additionalProperties: false type: object properties: - NetworkInterfaceId: + PrivateIpAddress: + x-relationshipRef: + typeName: AWS::EC2::NetworkInterface + propertyPath: /properties/PrivateIpAddress + description: The IPv4 address of the network interface within the subnet. type: string - description: The network interface identifier. - SubnetId: + AvailabilityZone: + description: The Availability Zone. type: string + SubnetId: + x-relationshipRef: + typeName: AWS::EC2::NetworkInterface + propertyPath: /properties/SubnetId description: The subnet identifier. - PrivateIpAddress: type: string - description: The IPv4 address of the network interface within the subnet. - AvailabilityZone: + NetworkInterfaceId: + x-relationshipRef: + typeName: AWS::EC2::NetworkInterface + propertyPath: /properties/Id + description: The network interface identifier. type: string - description: The Availability Zone. - additionalProperties: false EndpointAccess: type: object properties: + EndpointStatus: + description: The status of the endpoint. + type: string + VpcEndpoint: + description: The connection endpoint for connecting to an Amazon Redshift cluster through the proxy. + additionalProperties: false + type: object + properties: + VpcId: + x-relationshipRef: + typeName: AWS::EC2::VPCEndpoint + propertyPath: /properties/VpcId + description: The VPC identifier that the endpoint is associated. + type: string + NetworkInterfaces: + description: One or more network interfaces of the endpoint. Also known as an interface endpoint. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/NetworkInterface' + VpcEndpointId: + x-relationshipRef: + typeName: AWS::EC2::VPCEndpoint + propertyPath: /properties/Id + description: The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy. + type: string Address: description: The DNS address of the endpoint. type: string - ClusterIdentifier: - description: A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. All alphabetical characters must be lower case, no hypens at the end, no two consecutive hyphens. Cluster name should be unique for all clusters within an AWS account + EndpointName: + pattern: ^(?=^[a-z][a-z0-9]*(-[a-z0-9]+)*$).{1,30}$ + description: The name of the endpoint. type: string - VpcSecurityGroups: - description: A list of Virtual Private Cloud (VPC) security groups to be associated with the endpoint. - type: array + VpcSecurityGroupIds: + description: A list of vpc security group ids to apply to the created endpoint access. x-insertionOrder: false + type: array items: - $ref: '#/components/schemas/VpcSecurityGroup' + type: string ResourceOwner: - description: The AWS account ID of the owner of the cluster. - type: string pattern: ^\d{12}$ - EndpointStatus: - description: The status of the endpoint. - type: string - EndpointName: - description: The name of the endpoint. - type: string - pattern: ^(?=^[a-z][a-z0-9]*(-[a-z0-9]+)*$).{1,30}$ - EndpointCreateTime: - description: The time (UTC) that the endpoint was created. + description: The AWS account ID of the owner of the cluster. type: string SubnetGroupName: + pattern: ^(?=^[a-zA-Z0-9-]+$).{1,255}$ description: The subnet group name where Amazon Redshift chooses to deploy the endpoint. type: string - pattern: ^(?=^[a-zA-Z0-9-]+$).{1,255}$ Port: description: The port number on which the cluster accepts incoming connections. type: integer - VpcSecurityGroupIds: - description: A list of vpc security group ids to apply to the created endpoint access. - type: array + EndpointCreateTime: + description: The time (UTC) that the endpoint was created. + type: string + ClusterIdentifier: + description: A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. All alphabetical characters must be lower case, no hypens at the end, no two consecutive hyphens. Cluster name should be unique for all clusters within an AWS account + type: string + VpcSecurityGroups: + description: A list of Virtual Private Cloud (VPC) security groups to be associated with the endpoint. x-insertionOrder: false + type: array items: - type: string - VpcEndpoint: - description: The connection endpoint for connecting to an Amazon Redshift cluster through the proxy. - type: object - properties: - VpcEndpointId: - type: string - description: The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy. - VpcId: - type: string - description: The VPC identifier that the endpoint is associated. - NetworkInterfaces: - type: array - x-insertionOrder: false - description: One or more network interfaces of the endpoint. Also known as an interface endpoint. - items: - $ref: '#/components/schemas/NetworkInterface' - additionalProperties: false + $ref: '#/components/schemas/VpcSecurityGroup' required: - ClusterIdentifier - SubnetGroupName @@ -1079,20 +1130,20 @@ components: x-tagging: taggable: false x-required-permissions: - create: - - redshift:CreateEndpointAccess + read: - redshift:DescribeEndpointAccess - - ec2:CreateClientVpnEndpoint - - ec2:CreateVpcEndpoint + - ec2:DescribeClientVpnEndpoints + - ec2:DescribeVpcEndpoint - ec2:DescribeVpcAttribute - ec2:DescribeSecurityGroups - ec2:DescribeAddresses - ec2:DescribeInternetGateways - ec2:DescribeSubnets - read: + create: + - redshift:CreateEndpointAccess - redshift:DescribeEndpointAccess - - ec2:DescribeClientVpnEndpoints - - ec2:DescribeVpcEndpoint + - ec2:CreateClientVpnEndpoint + - ec2:CreateVpcEndpoint - ec2:DescribeVpcAttribute - ec2:DescribeSecurityGroups - ec2:DescribeAddresses @@ -1108,78 +1159,81 @@ components: - ec2:DescribeAddresses - ec2:DescribeInternetGateways - ec2:DescribeSubnets - delete: - - redshift:DeleteEndpointAccess + list: - redshift:DescribeEndpointAccess - - ec2:DeleteClientVpnEndpoint - - ec2:DeleteVpcEndpoint + - ec2:DescribeClientVpnEndpoints + - ec2:DescribeVpcEndpoints - ec2:DescribeVpcAttribute - ec2:DescribeSecurityGroups - ec2:DescribeAddresses - ec2:DescribeInternetGateways - ec2:DescribeSubnets - - ec2:DescribeVpcEndpoint - list: + delete: + - redshift:DeleteEndpointAccess - redshift:DescribeEndpointAccess - - ec2:DescribeClientVpnEndpoints - - ec2:DescribeVpcEndpoints + - ec2:DeleteClientVpnEndpoint + - ec2:DeleteVpcEndpoint - ec2:DescribeVpcAttribute - ec2:DescribeSecurityGroups - ec2:DescribeAddresses - ec2:DescribeInternetGateways - ec2:DescribeSubnets - AwsAccount: + - ec2:DescribeVpcEndpoint + VpcId: + x-relationshipRef: + typeName: AWS::EC2::VPC + propertyPath: /properties/VpcId + pattern: ^vpc-[A-Za-z0-9]{1,17}$ type: string + AwsAccount: pattern: ^\d{12}$ - VpcId: type: string - pattern: ^vpc-[A-Za-z0-9]{1,17}$ EndpointAuthorization: type: object properties: - Grantor: - description: The AWS account ID of the cluster owner. - $ref: '#/components/schemas/AwsAccount' + Status: + description: The status of the authorization action. + type: string Grantee: description: The AWS account ID of the grantee of the cluster. $ref: '#/components/schemas/AwsAccount' - ClusterIdentifier: - description: The cluster identifier. - type: string - pattern: ^(?=^[a-z][a-z0-9]*(-[a-z0-9]+)*$).{1,63}$ + Account: + description: The target AWS account ID to grant or revoke access for. + $ref: '#/components/schemas/AwsAccount' + Grantor: + description: The AWS account ID of the cluster owner. + $ref: '#/components/schemas/AwsAccount' + EndpointCount: + description: The number of Redshift-managed VPC endpoints created for the authorization. + type: integer AuthorizeTime: description: The time (UTC) when the authorization was created. type: string - ClusterStatus: - description: The status of the cluster. - type: string - Status: - description: The status of the authorization action. - type: string - AllowedAllVPCs: - description: Indicates whether all VPCs in the grantee account are allowed access to the cluster. - type: boolean AllowedVPCs: description: The VPCs allowed access to the cluster. - type: array x-insertionOrder: false + type: array items: $ref: '#/components/schemas/VpcId' - EndpointCount: - description: The number of Redshift-managed VPC endpoints created for the authorization. - type: integer - Account: - description: The target AWS account ID to grant or revoke access for. - $ref: '#/components/schemas/AwsAccount' + Force: + description: ' Indicates whether to force the revoke action. If true, the Redshift-managed VPC endpoints associated with the endpoint authorization are also deleted.' + type: boolean + AllowedAllVPCs: + description: Indicates whether all VPCs in the grantee account are allowed access to the cluster. + type: boolean VpcIds: description: The virtual private cloud (VPC) identifiers to grant or revoke access to. - type: array x-insertionOrder: false + type: array items: $ref: '#/components/schemas/VpcId' - Force: - description: ' Indicates whether to force the revoke action. If true, the Redshift-managed VPC endpoints associated with the endpoint authorization are also deleted.' - type: boolean + ClusterIdentifier: + pattern: ^(?=^[a-z][a-z0-9]*(-[a-z0-9]+)*$).{1,63}$ + description: The cluster identifier. + type: string + ClusterStatus: + description: The status of the cluster. + type: string required: - ClusterIdentifier - Account @@ -1209,15 +1263,17 @@ components: x-tagging: taggable: false x-required-permissions: + read: + - redshift:DescribeEndpointAuthorization create: - redshift:AuthorizeEndpointAccess - redshift:DescribeEndpointAuthorization - read: - - redshift:DescribeEndpointAuthorization update: - redshift:AuthorizeEndpointAccess - redshift:DescribeEndpointAuthorization - redshift:RevokeEndpointAccess + list: + - redshift:DescribeEndpointAuthorization delete: - redshift:RevokeEndpointAccess - redshift:DeleteEndpointAccess @@ -1228,18 +1284,26 @@ components: - ec2:DescribeAddresses - ec2:DescribeInternetGateways - ec2:DescribeSubnets - list: - - redshift:DescribeEndpointAuthorization EventSubscription: type: object properties: - SubscriptionName: - description: The name of the Amazon Redshift event notification subscription + Status: + description: The status of the Amazon Redshift event notification subscription. type: string - pattern: ^(?=^[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$).{1,255}$ - SnsTopicArn: - description: The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications. + enum: + - active + - no-permission + - topic-not-exist + CustSubscriptionId: + description: The name of the Amazon Redshift event notification subscription. type: string + EventCategoriesList: + uniqueItems: true + description: The list of Amazon Redshift event categories specified in the event notification subscription. + x-insertionOrder: false + type: array + items: + type: string SourceType: description: The type of source that will be generating the events. type: string @@ -1249,17 +1313,11 @@ components: - cluster-security-group - cluster-snapshot - scheduled-action - SourceIds: - description: A list of one or more identifiers of Amazon Redshift source objects. - type: array - x-insertionOrder: false - items: - type: string EventCategories: + uniqueItems: true description: Specifies the Amazon Redshift event categories to be published by the event notification subscription. - type: array x-insertionOrder: false - uniqueItems: true + type: array items: type: string enum: @@ -1268,50 +1326,46 @@ components: - monitoring - security - pending + Enabled: + description: A boolean value; set to true to activate the subscription, and set to false to create the subscription but not activate it. + type: boolean Severity: description: Specifies the Amazon Redshift event severity to be published by the event notification subscription. type: string enum: - ERROR - INFO - Enabled: - description: A boolean value; set to true to activate the subscription, and set to false to create the subscription but not activate it. - type: boolean - Tags: - description: An array of key-value pairs to apply to this resource. - type: array + SubscriptionName: + pattern: ^(?=^[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$).{1,255}$ + description: The name of the Amazon Redshift event notification subscription + type: string + SourceIds: + description: A list of one or more identifiers of Amazon Redshift source objects. x-insertionOrder: false + type: array items: - $ref: '#/components/schemas/Tag' + type: string CustomerAwsId: description: The AWS account associated with the Amazon Redshift event notification subscription. type: string - CustSubscriptionId: - description: The name of the Amazon Redshift event notification subscription. - type: string - Status: - description: The status of the Amazon Redshift event notification subscription. - type: string - enum: - - active - - no-permission - - topic-not-exist - SubscriptionCreationTime: - description: The date and time the Amazon Redshift event notification subscription was created. - type: string SourceIdsList: description: A list of the sources that publish events to the Amazon Redshift event notification subscription. - type: array x-insertionOrder: false + type: array items: type: string - EventCategoriesList: - description: The list of Amazon Redshift event categories specified in the event notification subscription. - type: array + SnsTopicArn: + description: The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications. + type: string + SubscriptionCreationTime: + description: The date and time the Amazon Redshift event notification subscription was created. + type: string + Tags: + description: An array of key-value pairs to apply to this resource. x-insertionOrder: false - uniqueItems: true + type: array items: - type: string + $ref: '#/components/schemas/Tag' required: - SubscriptionName x-stackql-resource-name: event_subscription @@ -1337,117 +1391,135 @@ components: x-tagging: taggable: true x-required-permissions: + read: + - redshift:DescribeEventSubscriptions + - redshift:DescribeTags create: - redshift:CreateEventSubscription - redshift:CreateTags - redshift:DescribeTags - redshift:DescribeEventSubscriptions - read: - - redshift:DescribeEventSubscriptions - - redshift:DescribeTags update: - redshift:ModifyEventSubscription - redshift:CreateTags - redshift:DescribeTags - redshift:DescribeEventSubscriptions - redshift:DeleteTags + list: + - redshift:DescribeTags + - redshift:DescribeEventSubscriptions delete: - redshift:DescribeEventSubscriptions - redshift:DeleteEventSubscription - redshift:DescribeTags - redshift:DeleteTags - list: - - redshift:DescribeTags - - redshift:DescribeEventSubscriptions + ScheduledActionType: + oneOf: + - additionalProperties: false + properties: + ResizeCluster: + $ref: '#/components/schemas/ResizeClusterMessage' + - additionalProperties: false + properties: + PauseCluster: + $ref: '#/components/schemas/PauseClusterMessage' + - additionalProperties: false + properties: + ResumeCluster: + $ref: '#/components/schemas/ResumeClusterMessage' + type: object ResizeClusterMessage: description: Describes a resize cluster operation. For example, a scheduled action to run the `ResizeCluster` API operation. + additionalProperties: false type: object properties: - ClusterIdentifier: - type: string - ClusterType: - type: string NodeType: + x-relationshipRef: + typeName: AWS::Redshift::Cluster + propertyPath: /properties/NodeType type: string NumberOfNodes: + x-relationshipRef: + typeName: AWS::Redshift::Cluster + propertyPath: /properties/NumberOfNodes type: integer + ClusterType: + x-relationshipRef: + typeName: AWS::Redshift::Cluster + propertyPath: /properties/ClusterType + type: string Classic: type: boolean + ClusterIdentifier: + x-relationshipRef: + typeName: AWS::Redshift::Cluster + propertyPath: /properties/ClusterIdentifier + type: string required: - ClusterIdentifier - additionalProperties: false PauseClusterMessage: description: Describes a pause cluster operation. For example, a scheduled action to run the `PauseCluster` API operation. + additionalProperties: false type: object properties: ClusterIdentifier: + x-relationshipRef: + typeName: AWS::Redshift::Cluster + propertyPath: /properties/ClusterIdentifier type: string required: - ClusterIdentifier - additionalProperties: false ResumeClusterMessage: description: Describes a resume cluster operation. For example, a scheduled action to run the `ResumeCluster` API operation. + additionalProperties: false type: object properties: ClusterIdentifier: + x-relationshipRef: + typeName: AWS::Redshift::Cluster + propertyPath: /properties/ClusterIdentifier type: string required: - ClusterIdentifier - additionalProperties: false - ScheduledActionType: - type: object - oneOf: - - properties: - ResizeCluster: - $ref: '#/components/schemas/ResizeClusterMessage' - additionalProperties: false - - properties: - PauseCluster: - $ref: '#/components/schemas/PauseClusterMessage' - additionalProperties: false - - properties: - ResumeCluster: - $ref: '#/components/schemas/ResumeClusterMessage' - additionalProperties: false timestamp: type: string ScheduledAction: type: object properties: + ScheduledActionDescription: + description: The description of the scheduled action. + type: string ScheduledActionName: description: The name of the scheduled action. The name must be unique within an account. type: string - TargetAction: - description: A JSON format string of the Amazon Redshift API operation with input parameters. - $ref: '#/components/schemas/ScheduledActionType' + EndTime: + description: The end time in UTC of the scheduled action. After this time, the scheduled action does not trigger. + $ref: '#/components/schemas/timestamp' + State: + description: The state of the scheduled action. + type: string + enum: + - ACTIVE + - DISABLED Schedule: description: The schedule in `at( )` or `cron( )` format. type: string IamRole: description: The IAM role to assume to run the target action. type: string - ScheduledActionDescription: - description: The description of the scheduled action. - type: string StartTime: description: The start time in UTC of the scheduled action. Before this time, the scheduled action does not trigger. $ref: '#/components/schemas/timestamp' - EndTime: - description: The end time in UTC of the scheduled action. After this time, the scheduled action does not trigger. - $ref: '#/components/schemas/timestamp' Enable: description: If true, the schedule is enabled. If false, the scheduled action does not trigger. type: boolean - State: - description: The state of the scheduled action. - type: string - enum: - - ACTIVE - - DISABLED + TargetAction: + description: A JSON format string of the Amazon Redshift API operation with input parameters. + $ref: '#/components/schemas/ScheduledActionType' NextInvocations: description: List of times when the scheduled action will run. - type: array x-insertionOrder: false + type: array items: $ref: '#/components/schemas/timestamp' required: @@ -1467,6 +1539,9 @@ components: x-tagging: taggable: false x-required-permissions: + read: + - redshift:DescribeScheduledActions + - redshift:DescribeTags create: - redshift:CreateScheduledAction - redshift:DescribeScheduledActions @@ -1475,9 +1550,6 @@ components: - redshift:ResumeCluster - redshift:ResizeCluster - iam:PassRole - read: - - redshift:DescribeScheduledActions - - redshift:DescribeTags update: - redshift:DescribeScheduledActions - redshift:ModifyScheduledAction @@ -1486,13 +1558,13 @@ components: - redshift:ResizeCluster - redshift:DescribeTags - iam:PassRole - delete: + list: - redshift:DescribeTags - redshift:DescribeScheduledActions - - redshift:DeleteScheduledAction - list: + delete: - redshift:DescribeTags - redshift:DescribeScheduledActions + - redshift:DeleteScheduledAction CreateClusterRequest: properties: ClientToken: @@ -1506,130 +1578,122 @@ components: DesiredState: type: object properties: - ClusterIdentifier: - description: A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. All alphabetical characters must be lower case, no hypens at the end, no two consecutive hyphens. Cluster name should be unique for all clusters within an AWS account - type: string - maxLength: 63 - ClusterNamespaceArn: - description: The Amazon Resource Name (ARN) of the cluster namespace. - type: string - MasterUsername: - description: The user name associated with the master user account for the cluster that is being created. The user name can't be PUBLIC and first character must be a letter. - type: string - maxLength: 128 - MasterUserPassword: - description: The password associated with the master user account for the cluster that is being created. You can't use MasterUserPassword if ManageMasterPassword is true. Password must be between 8 and 64 characters in length, should have at least one uppercase letter.Must contain at least one lowercase letter.Must contain one number.Can be any printable ASCII character. - type: string - maxLength: 64 - NodeType: - description: 'The node type to be provisioned for the cluster.Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.4xlarge | ra3.16xlarge' + RevisionTarget: + description: The identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request. type: string - AllowVersionUpgrade: - description: Major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. Default value is True - type: boolean AutomatedSnapshotRetentionPeriod: description: The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Default value is 1 type: integer - AvailabilityZone: - description: 'The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint' - type: string - ClusterParameterGroupName: - description: The name of the parameter group to be associated with this cluster. - type: string - maxLength: 255 - ClusterType: - description: The type of the cluster. When cluster type is specified as single-node, the NumberOfNodes parameter is not required and if multi-node, the NumberOfNodes parameter is required - type: string - ClusterVersion: - description: The version of the Amazon Redshift engine software that you want to deploy on the cluster.The version selected runs on all the nodes in the cluster. - type: string - ClusterSubnetGroupName: - description: The name of a cluster subnet group to be associated with this cluster. - type: string - DBName: - description: The name of the first database to be created when the cluster is created. To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. - type: string - ElasticIp: - description: The Elastic IP (EIP) address for the cluster. - type: string Encrypted: description: If true, the data in the cluster is encrypted at rest. type: boolean - HsmClientCertificateIdentifier: - description: Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM - type: string - HsmConfigurationIdentifier: - description: Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM. - type: string - KmsKeyId: - description: The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster. - type: string - NumberOfNodes: - description: The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node. - type: integer Port: description: The port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings type: integer - PreferredMaintenanceWindow: - description: The weekly time range (in UTC) during which automated cluster maintenance can occur. + NumberOfNodes: + description: The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node. + type: integer + DestinationRegion: + description: 'The destination AWS Region that you want to copy snapshots to. Constraints: Must be the name of a valid AWS Region. For more information, see Regions and Endpoints in the Amazon Web Services [https://docs.aws.amazon.com/general/latest/gr/rande.html#redshift_region] General Reference' type: string - PubliclyAccessible: - description: If true, the cluster can be accessed from a public network. + AllowVersionUpgrade: + description: Major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. Default value is True type: boolean - ClusterSecurityGroups: - description: A list of security groups to be associated with this cluster. - type: array - x-insertionOrder: false + Endpoint: + $ref: '#/components/schemas/Endpoint' + NamespaceResourcePolicy: + description: The namespace resource policy document that will be attached to a Redshift cluster. + type: object + MaintenanceTrackName: + description: The name for the maintenance track that you want to assign for the cluster. This name change is asynchronous. The new track name stays in the PendingModifiedValues for the cluster until the next maintenance window. When the maintenance track changes, the cluster is switched to the latest cluster release available for the maintenance track. At this point, the maintenance track name is applied. + type: string + OwnerAccount: + type: string + MultiAZ: + description: A boolean indicating if the redshift cluster is multi-az or not. If you don't provide this parameter or set the value to false, the redshift cluster will be single-az. + type: boolean + Tags: + maxItems: 50 uniqueItems: false + description: The list of tags for the cluster parameter group. + x-insertionOrder: false + type: array items: - type: string + $ref: '#/components/schemas/Tag' + SnapshotClusterIdentifier: + description: The name of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name. + type: string IamRoles: + maxItems: 50 description: A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 50 IAM roles in a single request - type: array x-insertionOrder: false - maxItems: 50 + type: array items: + relationshipRef: + typeName: AWS::IAM::Role + propertyPath: /properties/Arn type: string - Tags: - description: The list of tags for the cluster parameter group. - type: array - x-insertionOrder: false - maxItems: 50 + KmsKeyId: + description: The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster. + anyOf: + - relationshipRef: + typeName: AWS::KMS::Key + propertyPath: /properties/Arn + - relationshipRef: + typeName: AWS::KMS::Key + propertyPath: /properties/KeyId + type: string + SnapshotCopyManual: + description: Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots. + type: boolean + ManageMasterPassword: + description: A boolean indicating if the redshift cluster's admin user credentials is managed by Redshift or not. You can't use MasterUserPassword if ManageMasterPassword is true. If ManageMasterPassword is false or not set, Amazon Redshift uses MasterUserPassword for the admin user account's password. + type: boolean + AvailabilityZone: + description: 'The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint' + type: string + ClusterSecurityGroups: uniqueItems: false - items: - $ref: '#/components/schemas/Tag' - VpcSecurityGroupIds: - description: A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster. - type: array + description: A list of security groups to be associated with this cluster. x-insertionOrder: false - uniqueItems: false + type: array items: + anyOf: + - relationshipRef: + typeName: AWS::EC2::SecurityGroup + propertyPath: /properties/Id + - relationshipRef: + typeName: AWS::Redshift::ClusterSecurityGroup + propertyPath: /properties/Id type: string - SnapshotClusterIdentifier: - description: The name of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name. + ClusterIdentifier: + description: A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. All alphabetical characters must be lower case, no hypens at the end, no two consecutive hyphens. Cluster name should be unique for all clusters within an AWS account type: string - SnapshotIdentifier: - description: The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive. + maxLength: 63 + MasterUserPassword: + description: The password associated with the master user account for the cluster that is being created. You can't use MasterUserPassword if ManageMasterPassword is true. Password must be between 8 and 64 characters in length, should have at least one uppercase letter.Must contain at least one lowercase letter.Must contain one number.Can be any printable ASCII character. type: string - OwnerAccount: + maxLength: 64 + ClusterSubnetGroupName: + description: The name of a cluster subnet group to be associated with this cluster. type: string LoggingProperties: $ref: '#/components/schemas/LoggingProperties' - Endpoint: - $ref: '#/components/schemas/Endpoint' - DestinationRegion: - description: 'The destination AWS Region that you want to copy snapshots to. Constraints: Must be the name of a valid AWS Region. For more information, see Regions and Endpoints in the Amazon Web Services [https://docs.aws.amazon.com/general/latest/gr/rande.html#redshift_region] General Reference' + DeferMaintenance: + description: A boolean indicating whether to enable the deferred maintenance window. + type: boolean + NodeType: + description: 'The node type to be provisioned for the cluster.Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.4xlarge | ra3.16xlarge' type: string - SnapshotCopyRetentionPeriod: - description: |- - The number of days to retain automated snapshots in the destination region after they are copied from the source region. - - Default is 7. - - Constraints: Must be at least 1 and no more than 35. - type: integer - SnapshotCopyGrantName: - description: The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region. + MasterUsername: + description: The user name associated with the master user account for the cluster that is being created. The user name can't be PUBLIC and first character must be a letter. + type: string + maxLength: 128 + PubliclyAccessible: + description: If true, the cluster can be accessed from a public network. + type: boolean + DeferMaintenanceIdentifier: + description: A unique identifier for the deferred maintenance window. type: string ManualSnapshotRetentionPeriod: description: |- @@ -1637,12 +1701,15 @@ components: The value must be either -1 or an integer between 1 and 3,653. type: integer - SnapshotCopyManual: - description: Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots. - type: boolean - AvailabilityZoneRelocation: - description: The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete. - type: boolean + ResourceAction: + description: The Redshift operation to be performed. Resource Action supports pause-cluster, resume-cluster, failover-primary-compute APIs + type: string + HsmClientCertificateIdentifier: + description: Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM + type: string + ElasticIp: + description: The Elastic IP (EIP) address for the cluster. + type: string AvailabilityZoneRelocationStatus: description: The availability zone relocation status of the cluster type: string @@ -1654,9 +1721,15 @@ components: disabled - Don't use AQUA. auto - Amazon Redshift determines whether to use AQUA. type: string - Classic: - description: A boolean value indicating whether the resize operation is using the classic resize process. If you don't provide this parameter or set the value to false , the resize type is elastic. + SnapshotIdentifier: + description: The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive. + type: string + AvailabilityZoneRelocation: + description: The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete. type: boolean + SnapshotCopyGrantName: + description: The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region. + type: string EnhancedVpcRouting: description: |- An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide. @@ -1665,48 +1738,74 @@ components: Default: false type: boolean - MaintenanceTrackName: - description: The name for the maintenance track that you want to assign for the cluster. This name change is asynchronous. The new track name stays in the PendingModifiedValues for the cluster until the next maintenance window. When the maintenance track changes, the cluster is switched to the latest cluster release available for the maintenance track. At this point, the maintenance track name is applied. - type: string - DeferMaintenance: - description: A boolean indicating whether to enable the deferred maintenance window. - type: boolean - DeferMaintenanceIdentifier: - description: A unique identifier for the deferred maintenance window. - type: string - DeferMaintenanceStartTime: - description: A timestamp indicating the start time for the deferred maintenance window. + ClusterParameterGroupName: + description: The name of the parameter group to be associated with this cluster. type: string + maxLength: 255 DeferMaintenanceEndTime: description: A timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can't specify a duration. type: string - DeferMaintenanceDuration: - description: An integer indicating the duration of the maintenance window in days. If you specify a duration, you can't specify an end time. The duration must be 45 days or less. - type: integer - RevisionTarget: - description: The identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request. - type: string - ResourceAction: - description: The Redshift operation to be performed. Resource Action supports pause-cluster, resume-cluster, failover-primary-compute APIs - type: string RotateEncryptionKey: description: A boolean indicating if we want to rotate Encryption Keys. type: boolean - MultiAZ: - description: A boolean indicating if the redshift cluster is multi-az or not. If you don't provide this parameter or set the value to false, the redshift cluster will be single-az. - type: boolean - NamespaceResourcePolicy: - description: The namespace resource policy document that will be attached to a Redshift cluster. - type: object - ManageMasterPassword: - description: A boolean indicating if the redshift cluster's admin user credentials is managed by Redshift or not. You can't use MasterUserPassword if ManageMasterPassword is true. If ManageMasterPassword is false or not set, Amazon Redshift uses MasterUserPassword for the admin user account's password. + VpcSecurityGroupIds: + uniqueItems: false + description: A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster. + x-insertionOrder: false + type: array + items: + relationshipRef: + typeName: AWS::EC2::VPC + propertyPath: /properties/VpcId + type: string + ClusterNamespaceArn: + description: The Amazon Resource Name (ARN) of the cluster namespace. + type: string + MasterPasswordSecretArn: + description: The Amazon Resource Name (ARN) for the cluster's admin user credentials secret. + type: string + ClusterVersion: + description: The version of the Amazon Redshift engine software that you want to deploy on the cluster.The version selected runs on all the nodes in the cluster. + type: string + HsmConfigurationIdentifier: + description: Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM. + type: string + PreferredMaintenanceWindow: + description: The weekly time range (in UTC) during which automated cluster maintenance can occur. + type: string + DeferMaintenanceStartTime: + description: A timestamp indicating the start time for the deferred maintenance window. + type: string + ClusterType: + description: The type of the cluster. When cluster type is specified as single-node, the NumberOfNodes parameter is not required and if multi-node, the NumberOfNodes parameter is required + type: string + Classic: + description: A boolean value indicating whether the resize operation is using the classic resize process. If you don't provide this parameter or set the value to false , the resize type is elastic. type: boolean MasterPasswordSecretKmsKeyId: description: The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin user credentials secret. + anyOf: + - relationshipRef: + typeName: AWS::KMS::Key + propertyPath: /properties/Arn + - relationshipRef: + typeName: AWS::KMS::Key + propertyPath: /properties/KeyId type: string - MasterPasswordSecretArn: - description: The Amazon Resource Name (ARN) for the cluster's admin user credentials secret. + DeferMaintenanceDuration: + description: An integer indicating the duration of the maintenance window in days. If you specify a duration, you can't specify an end time. The duration must be 45 days or less. + type: integer + DBName: + description: The name of the first database to be created when the cluster is created. To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. type: string + SnapshotCopyRetentionPeriod: + description: |- + The number of days to retain automated snapshots in the destination region after they are copied from the source region. + + Default is 7. + + Constraints: Must be at least 1 and no more than 35. + type: integer x-stackQL-stringOnly: true x-title: CreateClusterRequest type: object @@ -1773,6 +1872,9 @@ components: maxItems: 20 items: type: string + relationshipRef: + typeName: AWS::EC2::Subnet + propertyPath: /properties/SubnetId Tags: description: The list of tags for the cluster parameter group. type: array @@ -1801,62 +1903,68 @@ components: DesiredState: type: object properties: + EndpointStatus: + description: The status of the endpoint. + type: string + VpcEndpoint: + description: The connection endpoint for connecting to an Amazon Redshift cluster through the proxy. + additionalProperties: false + type: object + properties: + VpcId: + x-relationshipRef: + typeName: AWS::EC2::VPCEndpoint + propertyPath: /properties/VpcId + description: The VPC identifier that the endpoint is associated. + type: string + NetworkInterfaces: + description: One or more network interfaces of the endpoint. Also known as an interface endpoint. + x-insertionOrder: false + type: array + items: + $ref: '#/components/schemas/NetworkInterface' + VpcEndpointId: + x-relationshipRef: + typeName: AWS::EC2::VPCEndpoint + propertyPath: /properties/Id + description: The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy. + type: string Address: description: The DNS address of the endpoint. type: string - ClusterIdentifier: - description: A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. All alphabetical characters must be lower case, no hypens at the end, no two consecutive hyphens. Cluster name should be unique for all clusters within an AWS account + EndpointName: + pattern: ^(?=^[a-z][a-z0-9]*(-[a-z0-9]+)*$).{1,30}$ + description: The name of the endpoint. type: string - VpcSecurityGroups: - description: A list of Virtual Private Cloud (VPC) security groups to be associated with the endpoint. - type: array + VpcSecurityGroupIds: + description: A list of vpc security group ids to apply to the created endpoint access. x-insertionOrder: false + type: array items: - $ref: '#/components/schemas/VpcSecurityGroup' + type: string ResourceOwner: - description: The AWS account ID of the owner of the cluster. - type: string pattern: ^\d{12}$ - EndpointStatus: - description: The status of the endpoint. - type: string - EndpointName: - description: The name of the endpoint. - type: string - pattern: ^(?=^[a-z][a-z0-9]*(-[a-z0-9]+)*$).{1,30}$ - EndpointCreateTime: - description: The time (UTC) that the endpoint was created. + description: The AWS account ID of the owner of the cluster. type: string SubnetGroupName: + pattern: ^(?=^[a-zA-Z0-9-]+$).{1,255}$ description: The subnet group name where Amazon Redshift chooses to deploy the endpoint. type: string - pattern: ^(?=^[a-zA-Z0-9-]+$).{1,255}$ Port: description: The port number on which the cluster accepts incoming connections. type: integer - VpcSecurityGroupIds: - description: A list of vpc security group ids to apply to the created endpoint access. - type: array + EndpointCreateTime: + description: The time (UTC) that the endpoint was created. + type: string + ClusterIdentifier: + description: A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. All alphabetical characters must be lower case, no hypens at the end, no two consecutive hyphens. Cluster name should be unique for all clusters within an AWS account + type: string + VpcSecurityGroups: + description: A list of Virtual Private Cloud (VPC) security groups to be associated with the endpoint. x-insertionOrder: false + type: array items: - type: string - VpcEndpoint: - description: The connection endpoint for connecting to an Amazon Redshift cluster through the proxy. - type: object - properties: - VpcEndpointId: - type: string - description: The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy. - VpcId: - type: string - description: The VPC identifier that the endpoint is associated. - NetworkInterfaces: - type: array - x-insertionOrder: false - description: One or more network interfaces of the endpoint. Also known as an interface endpoint. - items: - $ref: '#/components/schemas/NetworkInterface' - additionalProperties: false + $ref: '#/components/schemas/VpcSecurityGroup' x-stackQL-stringOnly: true x-title: CreateEndpointAccessRequest type: object @@ -1874,49 +1982,49 @@ components: DesiredState: type: object properties: - Grantor: - description: The AWS account ID of the cluster owner. - $ref: '#/components/schemas/AwsAccount' + Status: + description: The status of the authorization action. + type: string Grantee: description: The AWS account ID of the grantee of the cluster. $ref: '#/components/schemas/AwsAccount' - ClusterIdentifier: - description: The cluster identifier. - type: string - pattern: ^(?=^[a-z][a-z0-9]*(-[a-z0-9]+)*$).{1,63}$ + Account: + description: The target AWS account ID to grant or revoke access for. + $ref: '#/components/schemas/AwsAccount' + Grantor: + description: The AWS account ID of the cluster owner. + $ref: '#/components/schemas/AwsAccount' + EndpointCount: + description: The number of Redshift-managed VPC endpoints created for the authorization. + type: integer AuthorizeTime: description: The time (UTC) when the authorization was created. type: string - ClusterStatus: - description: The status of the cluster. - type: string - Status: - description: The status of the authorization action. - type: string - AllowedAllVPCs: - description: Indicates whether all VPCs in the grantee account are allowed access to the cluster. - type: boolean AllowedVPCs: description: The VPCs allowed access to the cluster. - type: array x-insertionOrder: false + type: array items: $ref: '#/components/schemas/VpcId' - EndpointCount: - description: The number of Redshift-managed VPC endpoints created for the authorization. - type: integer - Account: - description: The target AWS account ID to grant or revoke access for. - $ref: '#/components/schemas/AwsAccount' + Force: + description: ' Indicates whether to force the revoke action. If true, the Redshift-managed VPC endpoints associated with the endpoint authorization are also deleted.' + type: boolean + AllowedAllVPCs: + description: Indicates whether all VPCs in the grantee account are allowed access to the cluster. + type: boolean VpcIds: description: The virtual private cloud (VPC) identifiers to grant or revoke access to. - type: array x-insertionOrder: false + type: array items: $ref: '#/components/schemas/VpcId' - Force: - description: ' Indicates whether to force the revoke action. If true, the Redshift-managed VPC endpoints associated with the endpoint authorization are also deleted.' - type: boolean + ClusterIdentifier: + pattern: ^(?=^[a-z][a-z0-9]*(-[a-z0-9]+)*$).{1,63}$ + description: The cluster identifier. + type: string + ClusterStatus: + description: The status of the cluster. + type: string x-stackQL-stringOnly: true x-title: CreateEndpointAuthorizationRequest type: object @@ -1934,13 +2042,23 @@ components: DesiredState: type: object properties: - SubscriptionName: - description: The name of the Amazon Redshift event notification subscription + Status: + description: The status of the Amazon Redshift event notification subscription. type: string - pattern: ^(?=^[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$).{1,255}$ - SnsTopicArn: - description: The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications. + enum: + - active + - no-permission + - topic-not-exist + CustSubscriptionId: + description: The name of the Amazon Redshift event notification subscription. type: string + EventCategoriesList: + uniqueItems: true + description: The list of Amazon Redshift event categories specified in the event notification subscription. + x-insertionOrder: false + type: array + items: + type: string SourceType: description: The type of source that will be generating the events. type: string @@ -1950,17 +2068,11 @@ components: - cluster-security-group - cluster-snapshot - scheduled-action - SourceIds: - description: A list of one or more identifiers of Amazon Redshift source objects. - type: array - x-insertionOrder: false - items: - type: string EventCategories: + uniqueItems: true description: Specifies the Amazon Redshift event categories to be published by the event notification subscription. - type: array x-insertionOrder: false - uniqueItems: true + type: array items: type: string enum: @@ -1969,50 +2081,46 @@ components: - monitoring - security - pending + Enabled: + description: A boolean value; set to true to activate the subscription, and set to false to create the subscription but not activate it. + type: boolean Severity: description: Specifies the Amazon Redshift event severity to be published by the event notification subscription. type: string enum: - ERROR - INFO - Enabled: - description: A boolean value; set to true to activate the subscription, and set to false to create the subscription but not activate it. - type: boolean - Tags: - description: An array of key-value pairs to apply to this resource. - type: array + SubscriptionName: + pattern: ^(?=^[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$).{1,255}$ + description: The name of the Amazon Redshift event notification subscription + type: string + SourceIds: + description: A list of one or more identifiers of Amazon Redshift source objects. x-insertionOrder: false + type: array items: - $ref: '#/components/schemas/Tag' + type: string CustomerAwsId: description: The AWS account associated with the Amazon Redshift event notification subscription. type: string - CustSubscriptionId: - description: The name of the Amazon Redshift event notification subscription. - type: string - Status: - description: The status of the Amazon Redshift event notification subscription. - type: string - enum: - - active - - no-permission - - topic-not-exist - SubscriptionCreationTime: - description: The date and time the Amazon Redshift event notification subscription was created. - type: string SourceIdsList: description: A list of the sources that publish events to the Amazon Redshift event notification subscription. - type: array x-insertionOrder: false + type: array items: type: string - EventCategoriesList: - description: The list of Amazon Redshift event categories specified in the event notification subscription. - type: array + SnsTopicArn: + description: The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications. + type: string + SubscriptionCreationTime: + description: The date and time the Amazon Redshift event notification subscription was created. + type: string + Tags: + description: An array of key-value pairs to apply to this resource. x-insertionOrder: false - uniqueItems: true + type: array items: - type: string + $ref: '#/components/schemas/Tag' x-stackQL-stringOnly: true x-title: CreateEventSubscriptionRequest type: object @@ -2030,40 +2138,40 @@ components: DesiredState: type: object properties: + ScheduledActionDescription: + description: The description of the scheduled action. + type: string ScheduledActionName: description: The name of the scheduled action. The name must be unique within an account. type: string - TargetAction: - description: A JSON format string of the Amazon Redshift API operation with input parameters. - $ref: '#/components/schemas/ScheduledActionType' + EndTime: + description: The end time in UTC of the scheduled action. After this time, the scheduled action does not trigger. + $ref: '#/components/schemas/timestamp' + State: + description: The state of the scheduled action. + type: string + enum: + - ACTIVE + - DISABLED Schedule: description: The schedule in `at( )` or `cron( )` format. type: string IamRole: description: The IAM role to assume to run the target action. type: string - ScheduledActionDescription: - description: The description of the scheduled action. - type: string StartTime: description: The start time in UTC of the scheduled action. Before this time, the scheduled action does not trigger. $ref: '#/components/schemas/timestamp' - EndTime: - description: The end time in UTC of the scheduled action. After this time, the scheduled action does not trigger. - $ref: '#/components/schemas/timestamp' Enable: description: If true, the schedule is enabled. If false, the scheduled action does not trigger. type: boolean - State: - description: The state of the scheduled action. - type: string - enum: - - ACTIVE - - DISABLED + TargetAction: + description: A JSON format string of the Amazon Redshift API operation with input parameters. + $ref: '#/components/schemas/ScheduledActionType' NextInvocations: description: List of times when the scheduled action will run. - type: array x-insertionOrder: false + type: array items: $ref: '#/components/schemas/timestamp' x-stackQL-stringOnly: true @@ -2085,7 +2193,7 @@ components: x-cfn-type-name: AWS::Redshift::Cluster x-identifiers: - ClusterIdentifier - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2102,9 +2210,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2114,41 +2222,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/clusters/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/clusters/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ClusterIdentifier') as cluster_identifier - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Redshift::Cluster' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ClusterIdentifier') as cluster_identifier - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Redshift::Cluster' - AND region = 'us-east-1' - cluster: - name: cluster - id: aws.redshift.cluster - x-cfn-schema-name: Cluster - x-cfn-type-name: AWS::Redshift::Cluster - x-identifiers: - - ClusterIdentifier - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2159,138 +2235,158 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/clusters/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/clusters/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/cluster/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/clusters/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.ClusterIdentifier') as cluster_identifier, - JSON_EXTRACT(Properties, '$.ClusterNamespaceArn') as cluster_namespace_arn, - JSON_EXTRACT(Properties, '$.MasterUsername') as master_username, - JSON_EXTRACT(Properties, '$.MasterUserPassword') as master_user_password, - JSON_EXTRACT(Properties, '$.NodeType') as node_type, - JSON_EXTRACT(Properties, '$.AllowVersionUpgrade') as allow_version_upgrade, + JSON_EXTRACT(Properties, '$.RevisionTarget') as revision_target, JSON_EXTRACT(Properties, '$.AutomatedSnapshotRetentionPeriod') as automated_snapshot_retention_period, - JSON_EXTRACT(Properties, '$.AvailabilityZone') as availability_zone, - JSON_EXTRACT(Properties, '$.ClusterParameterGroupName') as cluster_parameter_group_name, - JSON_EXTRACT(Properties, '$.ClusterType') as cluster_type, - JSON_EXTRACT(Properties, '$.ClusterVersion') as cluster_version, - JSON_EXTRACT(Properties, '$.ClusterSubnetGroupName') as cluster_subnet_group_name, - JSON_EXTRACT(Properties, '$.DBName') as db_name, - JSON_EXTRACT(Properties, '$.ElasticIp') as elastic_ip, JSON_EXTRACT(Properties, '$.Encrypted') as encrypted, - JSON_EXTRACT(Properties, '$.HsmClientCertificateIdentifier') as hsm_client_certificate_identifier, - JSON_EXTRACT(Properties, '$.HsmConfigurationIdentifier') as hsm_configuration_identifier, - JSON_EXTRACT(Properties, '$.KmsKeyId') as kms_key_id, - JSON_EXTRACT(Properties, '$.NumberOfNodes') as number_of_nodes, JSON_EXTRACT(Properties, '$.Port') as port, - JSON_EXTRACT(Properties, '$.PreferredMaintenanceWindow') as preferred_maintenance_window, - JSON_EXTRACT(Properties, '$.PubliclyAccessible') as publicly_accessible, - JSON_EXTRACT(Properties, '$.ClusterSecurityGroups') as cluster_security_groups, - JSON_EXTRACT(Properties, '$.IamRoles') as iam_roles, + JSON_EXTRACT(Properties, '$.NumberOfNodes') as number_of_nodes, + JSON_EXTRACT(Properties, '$.DestinationRegion') as destination_region, + JSON_EXTRACT(Properties, '$.AllowVersionUpgrade') as allow_version_upgrade, + JSON_EXTRACT(Properties, '$.Endpoint') as endpoint, + JSON_EXTRACT(Properties, '$.NamespaceResourcePolicy') as namespace_resource_policy, + JSON_EXTRACT(Properties, '$.MaintenanceTrackName') as maintenance_track_name, + JSON_EXTRACT(Properties, '$.OwnerAccount') as owner_account, + JSON_EXTRACT(Properties, '$.MultiAZ') as multi_az, JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.VpcSecurityGroupIds') as vpc_security_group_ids, JSON_EXTRACT(Properties, '$.SnapshotClusterIdentifier') as snapshot_cluster_identifier, - JSON_EXTRACT(Properties, '$.SnapshotIdentifier') as snapshot_identifier, - JSON_EXTRACT(Properties, '$.OwnerAccount') as owner_account, + JSON_EXTRACT(Properties, '$.IamRoles') as iam_roles, + JSON_EXTRACT(Properties, '$.KmsKeyId') as kms_key_id, + JSON_EXTRACT(Properties, '$.SnapshotCopyManual') as snapshot_copy_manual, + JSON_EXTRACT(Properties, '$.ManageMasterPassword') as manage_master_password, + JSON_EXTRACT(Properties, '$.AvailabilityZone') as availability_zone, + JSON_EXTRACT(Properties, '$.ClusterSecurityGroups') as cluster_security_groups, + JSON_EXTRACT(Properties, '$.ClusterIdentifier') as cluster_identifier, + JSON_EXTRACT(Properties, '$.MasterUserPassword') as master_user_password, + JSON_EXTRACT(Properties, '$.ClusterSubnetGroupName') as cluster_subnet_group_name, JSON_EXTRACT(Properties, '$.LoggingProperties') as logging_properties, - JSON_EXTRACT(Properties, '$.Endpoint') as endpoint, - JSON_EXTRACT(Properties, '$.DestinationRegion') as destination_region, - JSON_EXTRACT(Properties, '$.SnapshotCopyRetentionPeriod') as snapshot_copy_retention_period, - JSON_EXTRACT(Properties, '$.SnapshotCopyGrantName') as snapshot_copy_grant_name, + JSON_EXTRACT(Properties, '$.DeferMaintenance') as defer_maintenance, + JSON_EXTRACT(Properties, '$.NodeType') as node_type, + JSON_EXTRACT(Properties, '$.MasterUsername') as master_username, + JSON_EXTRACT(Properties, '$.PubliclyAccessible') as publicly_accessible, + JSON_EXTRACT(Properties, '$.DeferMaintenanceIdentifier') as defer_maintenance_identifier, JSON_EXTRACT(Properties, '$.ManualSnapshotRetentionPeriod') as manual_snapshot_retention_period, - JSON_EXTRACT(Properties, '$.SnapshotCopyManual') as snapshot_copy_manual, - JSON_EXTRACT(Properties, '$.AvailabilityZoneRelocation') as availability_zone_relocation, + JSON_EXTRACT(Properties, '$.ResourceAction') as resource_action, + JSON_EXTRACT(Properties, '$.HsmClientCertificateIdentifier') as hsm_client_certificate_identifier, + JSON_EXTRACT(Properties, '$.ElasticIp') as elastic_ip, JSON_EXTRACT(Properties, '$.AvailabilityZoneRelocationStatus') as availability_zone_relocation_status, JSON_EXTRACT(Properties, '$.AquaConfigurationStatus') as aqua_configuration_status, - JSON_EXTRACT(Properties, '$.Classic') as classic, + JSON_EXTRACT(Properties, '$.SnapshotIdentifier') as snapshot_identifier, + JSON_EXTRACT(Properties, '$.AvailabilityZoneRelocation') as availability_zone_relocation, + JSON_EXTRACT(Properties, '$.SnapshotCopyGrantName') as snapshot_copy_grant_name, JSON_EXTRACT(Properties, '$.EnhancedVpcRouting') as enhanced_vpc_routing, - JSON_EXTRACT(Properties, '$.MaintenanceTrackName') as maintenance_track_name, - JSON_EXTRACT(Properties, '$.DeferMaintenance') as defer_maintenance, - JSON_EXTRACT(Properties, '$.DeferMaintenanceIdentifier') as defer_maintenance_identifier, - JSON_EXTRACT(Properties, '$.DeferMaintenanceStartTime') as defer_maintenance_start_time, + JSON_EXTRACT(Properties, '$.ClusterParameterGroupName') as cluster_parameter_group_name, JSON_EXTRACT(Properties, '$.DeferMaintenanceEndTime') as defer_maintenance_end_time, - JSON_EXTRACT(Properties, '$.DeferMaintenanceDuration') as defer_maintenance_duration, - JSON_EXTRACT(Properties, '$.RevisionTarget') as revision_target, - JSON_EXTRACT(Properties, '$.ResourceAction') as resource_action, JSON_EXTRACT(Properties, '$.RotateEncryptionKey') as rotate_encryption_key, - JSON_EXTRACT(Properties, '$.MultiAZ') as multi_az, - JSON_EXTRACT(Properties, '$.NamespaceResourcePolicy') as namespace_resource_policy, - JSON_EXTRACT(Properties, '$.ManageMasterPassword') as manage_master_password, + JSON_EXTRACT(Properties, '$.VpcSecurityGroupIds') as vpc_security_group_ids, + JSON_EXTRACT(Properties, '$.ClusterNamespaceArn') as cluster_namespace_arn, + JSON_EXTRACT(Properties, '$.MasterPasswordSecretArn') as master_password_secret_arn, + JSON_EXTRACT(Properties, '$.ClusterVersion') as cluster_version, + JSON_EXTRACT(Properties, '$.HsmConfigurationIdentifier') as hsm_configuration_identifier, + JSON_EXTRACT(Properties, '$.PreferredMaintenanceWindow') as preferred_maintenance_window, + JSON_EXTRACT(Properties, '$.DeferMaintenanceStartTime') as defer_maintenance_start_time, + JSON_EXTRACT(Properties, '$.ClusterType') as cluster_type, + JSON_EXTRACT(Properties, '$.Classic') as classic, JSON_EXTRACT(Properties, '$.MasterPasswordSecretKmsKeyId') as master_password_secret_kms_key_id, - JSON_EXTRACT(Properties, '$.MasterPasswordSecretArn') as master_password_secret_arn + JSON_EXTRACT(Properties, '$.DeferMaintenanceDuration') as defer_maintenance_duration, + JSON_EXTRACT(Properties, '$.DBName') as db_name, + JSON_EXTRACT(Properties, '$.SnapshotCopyRetentionPeriod') as snapshot_copy_retention_period FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Redshift::Cluster' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ClusterIdentifier') as cluster_identifier, - json_extract_path_text(Properties, 'ClusterNamespaceArn') as cluster_namespace_arn, - json_extract_path_text(Properties, 'MasterUsername') as master_username, - json_extract_path_text(Properties, 'MasterUserPassword') as master_user_password, - json_extract_path_text(Properties, 'NodeType') as node_type, - json_extract_path_text(Properties, 'AllowVersionUpgrade') as allow_version_upgrade, - json_extract_path_text(Properties, 'AutomatedSnapshotRetentionPeriod') as automated_snapshot_retention_period, - json_extract_path_text(Properties, 'AvailabilityZone') as availability_zone, - json_extract_path_text(Properties, 'ClusterParameterGroupName') as cluster_parameter_group_name, - json_extract_path_text(Properties, 'ClusterType') as cluster_type, - json_extract_path_text(Properties, 'ClusterVersion') as cluster_version, - json_extract_path_text(Properties, 'ClusterSubnetGroupName') as cluster_subnet_group_name, - json_extract_path_text(Properties, 'DBName') as db_name, - json_extract_path_text(Properties, 'ElasticIp') as elastic_ip, - json_extract_path_text(Properties, 'Encrypted') as encrypted, - json_extract_path_text(Properties, 'HsmClientCertificateIdentifier') as hsm_client_certificate_identifier, - json_extract_path_text(Properties, 'HsmConfigurationIdentifier') as hsm_configuration_identifier, - json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, - json_extract_path_text(Properties, 'NumberOfNodes') as number_of_nodes, - json_extract_path_text(Properties, 'Port') as port, - json_extract_path_text(Properties, 'PreferredMaintenanceWindow') as preferred_maintenance_window, - json_extract_path_text(Properties, 'PubliclyAccessible') as publicly_accessible, - json_extract_path_text(Properties, 'ClusterSecurityGroups') as cluster_security_groups, - json_extract_path_text(Properties, 'IamRoles') as iam_roles, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'VpcSecurityGroupIds') as vpc_security_group_ids, - json_extract_path_text(Properties, 'SnapshotClusterIdentifier') as snapshot_cluster_identifier, - json_extract_path_text(Properties, 'SnapshotIdentifier') as snapshot_identifier, - json_extract_path_text(Properties, 'OwnerAccount') as owner_account, - json_extract_path_text(Properties, 'LoggingProperties') as logging_properties, - json_extract_path_text(Properties, 'Endpoint') as endpoint, - json_extract_path_text(Properties, 'DestinationRegion') as destination_region, - json_extract_path_text(Properties, 'SnapshotCopyRetentionPeriod') as snapshot_copy_retention_period, - json_extract_path_text(Properties, 'SnapshotCopyGrantName') as snapshot_copy_grant_name, - json_extract_path_text(Properties, 'ManualSnapshotRetentionPeriod') as manual_snapshot_retention_period, - json_extract_path_text(Properties, 'SnapshotCopyManual') as snapshot_copy_manual, - json_extract_path_text(Properties, 'AvailabilityZoneRelocation') as availability_zone_relocation, - json_extract_path_text(Properties, 'AvailabilityZoneRelocationStatus') as availability_zone_relocation_status, - json_extract_path_text(Properties, 'AquaConfigurationStatus') as aqua_configuration_status, - json_extract_path_text(Properties, 'Classic') as classic, - json_extract_path_text(Properties, 'EnhancedVpcRouting') as enhanced_vpc_routing, - json_extract_path_text(Properties, 'MaintenanceTrackName') as maintenance_track_name, - json_extract_path_text(Properties, 'DeferMaintenance') as defer_maintenance, - json_extract_path_text(Properties, 'DeferMaintenanceIdentifier') as defer_maintenance_identifier, - json_extract_path_text(Properties, 'DeferMaintenanceStartTime') as defer_maintenance_start_time, - json_extract_path_text(Properties, 'DeferMaintenanceEndTime') as defer_maintenance_end_time, - json_extract_path_text(Properties, 'DeferMaintenanceDuration') as defer_maintenance_duration, - json_extract_path_text(Properties, 'RevisionTarget') as revision_target, - json_extract_path_text(Properties, 'ResourceAction') as resource_action, - json_extract_path_text(Properties, 'RotateEncryptionKey') as rotate_encryption_key, - json_extract_path_text(Properties, 'MultiAZ') as multi_az, - json_extract_path_text(Properties, 'NamespaceResourcePolicy') as namespace_resource_policy, - json_extract_path_text(Properties, 'ManageMasterPassword') as manage_master_password, - json_extract_path_text(Properties, 'MasterPasswordSecretKmsKeyId') as master_password_secret_kms_key_id, - json_extract_path_text(Properties, 'MasterPasswordSecretArn') as master_password_secret_arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Redshift::Cluster' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ClusterIdentifier') as cluster_identifier + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Redshift::Cluster' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'RevisionTarget') as revision_target, + json_extract_path_text(Properties, 'AutomatedSnapshotRetentionPeriod') as automated_snapshot_retention_period, + json_extract_path_text(Properties, 'Encrypted') as encrypted, + json_extract_path_text(Properties, 'Port') as port, + json_extract_path_text(Properties, 'NumberOfNodes') as number_of_nodes, + json_extract_path_text(Properties, 'DestinationRegion') as destination_region, + json_extract_path_text(Properties, 'AllowVersionUpgrade') as allow_version_upgrade, + json_extract_path_text(Properties, 'Endpoint') as endpoint, + json_extract_path_text(Properties, 'NamespaceResourcePolicy') as namespace_resource_policy, + json_extract_path_text(Properties, 'MaintenanceTrackName') as maintenance_track_name, + json_extract_path_text(Properties, 'OwnerAccount') as owner_account, + json_extract_path_text(Properties, 'MultiAZ') as multi_az, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'SnapshotClusterIdentifier') as snapshot_cluster_identifier, + json_extract_path_text(Properties, 'IamRoles') as iam_roles, + json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, + json_extract_path_text(Properties, 'SnapshotCopyManual') as snapshot_copy_manual, + json_extract_path_text(Properties, 'ManageMasterPassword') as manage_master_password, + json_extract_path_text(Properties, 'AvailabilityZone') as availability_zone, + json_extract_path_text(Properties, 'ClusterSecurityGroups') as cluster_security_groups, + json_extract_path_text(Properties, 'ClusterIdentifier') as cluster_identifier, + json_extract_path_text(Properties, 'MasterUserPassword') as master_user_password, + json_extract_path_text(Properties, 'ClusterSubnetGroupName') as cluster_subnet_group_name, + json_extract_path_text(Properties, 'LoggingProperties') as logging_properties, + json_extract_path_text(Properties, 'DeferMaintenance') as defer_maintenance, + json_extract_path_text(Properties, 'NodeType') as node_type, + json_extract_path_text(Properties, 'MasterUsername') as master_username, + json_extract_path_text(Properties, 'PubliclyAccessible') as publicly_accessible, + json_extract_path_text(Properties, 'DeferMaintenanceIdentifier') as defer_maintenance_identifier, + json_extract_path_text(Properties, 'ManualSnapshotRetentionPeriod') as manual_snapshot_retention_period, + json_extract_path_text(Properties, 'ResourceAction') as resource_action, + json_extract_path_text(Properties, 'HsmClientCertificateIdentifier') as hsm_client_certificate_identifier, + json_extract_path_text(Properties, 'ElasticIp') as elastic_ip, + json_extract_path_text(Properties, 'AvailabilityZoneRelocationStatus') as availability_zone_relocation_status, + json_extract_path_text(Properties, 'AquaConfigurationStatus') as aqua_configuration_status, + json_extract_path_text(Properties, 'SnapshotIdentifier') as snapshot_identifier, + json_extract_path_text(Properties, 'AvailabilityZoneRelocation') as availability_zone_relocation, + json_extract_path_text(Properties, 'SnapshotCopyGrantName') as snapshot_copy_grant_name, + json_extract_path_text(Properties, 'EnhancedVpcRouting') as enhanced_vpc_routing, + json_extract_path_text(Properties, 'ClusterParameterGroupName') as cluster_parameter_group_name, + json_extract_path_text(Properties, 'DeferMaintenanceEndTime') as defer_maintenance_end_time, + json_extract_path_text(Properties, 'RotateEncryptionKey') as rotate_encryption_key, + json_extract_path_text(Properties, 'VpcSecurityGroupIds') as vpc_security_group_ids, + json_extract_path_text(Properties, 'ClusterNamespaceArn') as cluster_namespace_arn, + json_extract_path_text(Properties, 'MasterPasswordSecretArn') as master_password_secret_arn, + json_extract_path_text(Properties, 'ClusterVersion') as cluster_version, + json_extract_path_text(Properties, 'HsmConfigurationIdentifier') as hsm_configuration_identifier, + json_extract_path_text(Properties, 'PreferredMaintenanceWindow') as preferred_maintenance_window, + json_extract_path_text(Properties, 'DeferMaintenanceStartTime') as defer_maintenance_start_time, + json_extract_path_text(Properties, 'ClusterType') as cluster_type, + json_extract_path_text(Properties, 'Classic') as classic, + json_extract_path_text(Properties, 'MasterPasswordSecretKmsKeyId') as master_password_secret_kms_key_id, + json_extract_path_text(Properties, 'DeferMaintenanceDuration') as defer_maintenance_duration, + json_extract_path_text(Properties, 'DBName') as db_name, + json_extract_path_text(Properties, 'SnapshotCopyRetentionPeriod') as snapshot_copy_retention_period + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Redshift::Cluster' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ClusterIdentifier') as cluster_identifier + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Redshift::Cluster' + AND region = 'us-east-1' cluster_parameter_groups: name: cluster_parameter_groups id: aws.redshift.cluster_parameter_groups @@ -2298,67 +2394,23 @@ components: x-cfn-type-name: AWS::Redshift::ClusterParameterGroup x-identifiers: - ParameterGroupName - x-type: list + x-type: cloud_control methods: create_resource: config: requestBodyTranslate: algorithm: naive_DesiredState operation: - $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ClusterParameterGroup&__detailTransformed=true/post' - request: - mediaType: application/x-amz-json-1.0 - base: |- - { - "TypeName": "AWS::Redshift::ClusterParameterGroup" - } - response: - mediaType: application/json - openAPIDocKey: '200' - delete_resource: - operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' - request: - mediaType: application/x-amz-json-1.0 - base: |- - { - "TypeName": "AWS::Redshift::ClusterParameterGroup" - } - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/cluster_parameter_groups/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/cluster_parameter_groups/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ParameterGroupName') as parameter_group_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Redshift::ClusterParameterGroup' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ParameterGroupName') as parameter_group_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Redshift::ClusterParameterGroup' - AND region = 'us-east-1' - cluster_parameter_group: - name: cluster_parameter_group - id: aws.redshift.cluster_parameter_group - x-cfn-schema-name: ClusterParameterGroup - x-cfn-type-name: AWS::Redshift::ClusterParameterGroup - x-identifiers: - - ParameterGroupName - x-type: get - methods: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ClusterParameterGroup&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Redshift::ClusterParameterGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' update_resource: operation: $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' @@ -2371,13 +2423,29 @@ components: response: mediaType: application/json openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Redshift::ClusterParameterGroup" + } + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/cluster_parameter_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/cluster_parameter_groups/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/cluster_parameter_group/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/cluster_parameter_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2391,19 +2459,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ParameterGroupName') as parameter_group_name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'ParameterGroupFamily') as parameter_group_family, - json_extract_path_text(Properties, 'Parameters') as parameters, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Redshift::ClusterParameterGroup' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ParameterGroupName') as parameter_group_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Redshift::ClusterParameterGroup' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ParameterGroupName') as parameter_group_name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'ParameterGroupFamily') as parameter_group_family, + json_extract_path_text(Properties, 'Parameters') as parameters, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Redshift::ClusterParameterGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ParameterGroupName') as parameter_group_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Redshift::ClusterParameterGroup' + AND region = 'us-east-1' cluster_subnet_groups: name: cluster_subnet_groups id: aws.redshift.cluster_subnet_groups @@ -2411,7 +2495,7 @@ components: x-cfn-type-name: AWS::Redshift::ClusterSubnetGroup x-identifiers: - ClusterSubnetGroupName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2428,9 +2512,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2440,41 +2524,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/cluster_subnet_groups/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/cluster_subnet_groups/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ClusterSubnetGroupName') as cluster_subnet_group_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Redshift::ClusterSubnetGroup' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ClusterSubnetGroupName') as cluster_subnet_group_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Redshift::ClusterSubnetGroup' - AND region = 'us-east-1' - cluster_subnet_group: - name: cluster_subnet_group - id: aws.redshift.cluster_subnet_group - x-cfn-schema-name: ClusterSubnetGroup - x-cfn-type-name: AWS::Redshift::ClusterSubnetGroup - x-identifiers: - - ClusterSubnetGroupName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2485,12 +2537,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/cluster_subnet_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/cluster_subnet_groups/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/cluster_subnet_group/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/cluster_subnet_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2503,18 +2559,34 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'SubnetIds') as subnet_ids, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'ClusterSubnetGroupName') as cluster_subnet_group_name - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Redshift::ClusterSubnetGroup' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ClusterSubnetGroupName') as cluster_subnet_group_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Redshift::ClusterSubnetGroup' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'SubnetIds') as subnet_ids, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'ClusterSubnetGroupName') as cluster_subnet_group_name + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Redshift::ClusterSubnetGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ClusterSubnetGroupName') as cluster_subnet_group_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Redshift::ClusterSubnetGroup' + AND region = 'us-east-1' endpoint_accesses: name: endpoint_accesses id: aws.redshift.endpoint_accesses @@ -2522,7 +2594,7 @@ components: x-cfn-type-name: AWS::Redshift::EndpointAccess x-identifiers: - EndpointName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2539,9 +2611,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2551,41 +2623,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/endpoint_accesses/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/endpoint_accesses/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.EndpointName') as endpoint_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Redshift::EndpointAccess' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'EndpointName') as endpoint_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Redshift::EndpointAccess' - AND region = 'us-east-1' - endpoint_access: - name: endpoint_access - id: aws.redshift.endpoint_access - x-cfn-schema-name: EndpointAccess - x-cfn-type-name: AWS::Redshift::EndpointAccess - x-identifiers: - - EndpointName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2596,50 +2636,70 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/endpoint_accesses/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/endpoint_accesses/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/endpoint_access/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/endpoint_accesses/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.Address') as address, - JSON_EXTRACT(Properties, '$.ClusterIdentifier') as cluster_identifier, - JSON_EXTRACT(Properties, '$.VpcSecurityGroups') as vpc_security_groups, - JSON_EXTRACT(Properties, '$.ResourceOwner') as resource_owner, JSON_EXTRACT(Properties, '$.EndpointStatus') as endpoint_status, + JSON_EXTRACT(Properties, '$.VpcEndpoint') as vpc_endpoint, + JSON_EXTRACT(Properties, '$.Address') as address, JSON_EXTRACT(Properties, '$.EndpointName') as endpoint_name, - JSON_EXTRACT(Properties, '$.EndpointCreateTime') as endpoint_create_time, + JSON_EXTRACT(Properties, '$.VpcSecurityGroupIds') as vpc_security_group_ids, + JSON_EXTRACT(Properties, '$.ResourceOwner') as resource_owner, JSON_EXTRACT(Properties, '$.SubnetGroupName') as subnet_group_name, JSON_EXTRACT(Properties, '$.Port') as port, - JSON_EXTRACT(Properties, '$.VpcSecurityGroupIds') as vpc_security_group_ids, - JSON_EXTRACT(Properties, '$.VpcEndpoint') as vpc_endpoint + JSON_EXTRACT(Properties, '$.EndpointCreateTime') as endpoint_create_time, + JSON_EXTRACT(Properties, '$.ClusterIdentifier') as cluster_identifier, + JSON_EXTRACT(Properties, '$.VpcSecurityGroups') as vpc_security_groups FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Redshift::EndpointAccess' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Address') as address, - json_extract_path_text(Properties, 'ClusterIdentifier') as cluster_identifier, - json_extract_path_text(Properties, 'VpcSecurityGroups') as vpc_security_groups, - json_extract_path_text(Properties, 'ResourceOwner') as resource_owner, - json_extract_path_text(Properties, 'EndpointStatus') as endpoint_status, - json_extract_path_text(Properties, 'EndpointName') as endpoint_name, - json_extract_path_text(Properties, 'EndpointCreateTime') as endpoint_create_time, - json_extract_path_text(Properties, 'SubnetGroupName') as subnet_group_name, - json_extract_path_text(Properties, 'Port') as port, - json_extract_path_text(Properties, 'VpcSecurityGroupIds') as vpc_security_group_ids, - json_extract_path_text(Properties, 'VpcEndpoint') as vpc_endpoint - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Redshift::EndpointAccess' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.EndpointName') as endpoint_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Redshift::EndpointAccess' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'EndpointStatus') as endpoint_status, + json_extract_path_text(Properties, 'VpcEndpoint') as vpc_endpoint, + json_extract_path_text(Properties, 'Address') as address, + json_extract_path_text(Properties, 'EndpointName') as endpoint_name, + json_extract_path_text(Properties, 'VpcSecurityGroupIds') as vpc_security_group_ids, + json_extract_path_text(Properties, 'ResourceOwner') as resource_owner, + json_extract_path_text(Properties, 'SubnetGroupName') as subnet_group_name, + json_extract_path_text(Properties, 'Port') as port, + json_extract_path_text(Properties, 'EndpointCreateTime') as endpoint_create_time, + json_extract_path_text(Properties, 'ClusterIdentifier') as cluster_identifier, + json_extract_path_text(Properties, 'VpcSecurityGroups') as vpc_security_groups + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Redshift::EndpointAccess' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'EndpointName') as endpoint_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Redshift::EndpointAccess' + AND region = 'us-east-1' endpoint_authorizations: name: endpoint_authorizations id: aws.redshift.endpoint_authorizations @@ -2648,7 +2708,7 @@ components: x-identifiers: - ClusterIdentifier - Account - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2665,9 +2725,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2677,44 +2737,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/endpoint_authorizations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/endpoint_authorizations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ClusterIdentifier') as cluster_identifier, - JSON_EXTRACT(Properties, '$.Account') as account - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Redshift::EndpointAuthorization' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ClusterIdentifier') as cluster_identifier, - json_extract_path_text(Properties, 'Account') as account - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Redshift::EndpointAuthorization' - AND region = 'us-east-1' - endpoint_authorization: - name: endpoint_authorization - id: aws.redshift.endpoint_authorization - x-cfn-schema-name: EndpointAuthorization - x-cfn-type-name: AWS::Redshift::EndpointAuthorization - x-identifiers: - - ClusterIdentifier - - Account - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2725,52 +2750,74 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/endpoint_authorizations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/endpoint_authorizations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/endpoint_authorization/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/endpoint_authorizations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.Grantor') as grantor, + JSON_EXTRACT(Properties, '$.Status') as status, JSON_EXTRACT(Properties, '$.Grantee') as grantee, - JSON_EXTRACT(Properties, '$.ClusterIdentifier') as cluster_identifier, + JSON_EXTRACT(Properties, '$.Account') as account, + JSON_EXTRACT(Properties, '$.Grantor') as grantor, + JSON_EXTRACT(Properties, '$.EndpointCount') as endpoint_count, JSON_EXTRACT(Properties, '$.AuthorizeTime') as authorize_time, - JSON_EXTRACT(Properties, '$.ClusterStatus') as cluster_status, - JSON_EXTRACT(Properties, '$.Status') as status, - JSON_EXTRACT(Properties, '$.AllowedAllVPCs') as allowed_all_vpcs, JSON_EXTRACT(Properties, '$.AllowedVPCs') as allowed_vpcs, - JSON_EXTRACT(Properties, '$.EndpointCount') as endpoint_count, - JSON_EXTRACT(Properties, '$.Account') as account, + JSON_EXTRACT(Properties, '$.Force') as _force, + JSON_EXTRACT(Properties, '$.AllowedAllVPCs') as allowed_all_vpcs, JSON_EXTRACT(Properties, '$.VpcIds') as vpc_ids, - JSON_EXTRACT(Properties, '$.Force') as _force + JSON_EXTRACT(Properties, '$.ClusterIdentifier') as cluster_identifier, + JSON_EXTRACT(Properties, '$.ClusterStatus') as cluster_status FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Redshift::EndpointAuthorization' AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Grantor') as grantor, - json_extract_path_text(Properties, 'Grantee') as grantee, - json_extract_path_text(Properties, 'ClusterIdentifier') as cluster_identifier, - json_extract_path_text(Properties, 'AuthorizeTime') as authorize_time, - json_extract_path_text(Properties, 'ClusterStatus') as cluster_status, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'AllowedAllVPCs') as allowed_all_vpcs, - json_extract_path_text(Properties, 'AllowedVPCs') as allowed_vpcs, - json_extract_path_text(Properties, 'EndpointCount') as endpoint_count, - json_extract_path_text(Properties, 'Account') as account, - json_extract_path_text(Properties, 'VpcIds') as vpc_ids, - json_extract_path_text(Properties, 'Force') as _force - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Redshift::EndpointAuthorization' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.ClusterIdentifier') as cluster_identifier, + JSON_EXTRACT(Properties, '$.Account') as account + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Redshift::EndpointAuthorization' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'Grantee') as grantee, + json_extract_path_text(Properties, 'Account') as account, + json_extract_path_text(Properties, 'Grantor') as grantor, + json_extract_path_text(Properties, 'EndpointCount') as endpoint_count, + json_extract_path_text(Properties, 'AuthorizeTime') as authorize_time, + json_extract_path_text(Properties, 'AllowedVPCs') as allowed_vpcs, + json_extract_path_text(Properties, 'Force') as _force, + json_extract_path_text(Properties, 'AllowedAllVPCs') as allowed_all_vpcs, + json_extract_path_text(Properties, 'VpcIds') as vpc_ids, + json_extract_path_text(Properties, 'ClusterIdentifier') as cluster_identifier, + json_extract_path_text(Properties, 'ClusterStatus') as cluster_status + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Redshift::EndpointAuthorization' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ClusterIdentifier') as cluster_identifier, + json_extract_path_text(Properties, 'Account') as account + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Redshift::EndpointAuthorization' + AND region = 'us-east-1' event_subscriptions: name: event_subscriptions id: aws.redshift.event_subscriptions @@ -2778,7 +2825,7 @@ components: x-cfn-type-name: AWS::Redshift::EventSubscription x-identifiers: - SubscriptionName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2795,9 +2842,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2807,41 +2854,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/event_subscriptions/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/event_subscriptions/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.SubscriptionName') as subscription_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Redshift::EventSubscription' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'SubscriptionName') as subscription_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Redshift::EventSubscription' - AND region = 'us-east-1' - event_subscription: - name: event_subscription - id: aws.redshift.event_subscription - x-cfn-schema-name: EventSubscription - x-cfn-type-name: AWS::Redshift::EventSubscription - x-identifiers: - - SubscriptionName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2852,56 +2867,76 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/event_subscriptions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/event_subscriptions/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/event_subscription/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/event_subscriptions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.SubscriptionName') as subscription_name, - JSON_EXTRACT(Properties, '$.SnsTopicArn') as sns_topic_arn, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.CustSubscriptionId') as cust_subscription_id, + JSON_EXTRACT(Properties, '$.EventCategoriesList') as event_categories_list, JSON_EXTRACT(Properties, '$.SourceType') as source_type, - JSON_EXTRACT(Properties, '$.SourceIds') as source_ids, JSON_EXTRACT(Properties, '$.EventCategories') as event_categories, - JSON_EXTRACT(Properties, '$.Severity') as severity, JSON_EXTRACT(Properties, '$.Enabled') as enabled, - JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.Severity') as severity, + JSON_EXTRACT(Properties, '$.SubscriptionName') as subscription_name, + JSON_EXTRACT(Properties, '$.SourceIds') as source_ids, JSON_EXTRACT(Properties, '$.CustomerAwsId') as customer_aws_id, - JSON_EXTRACT(Properties, '$.CustSubscriptionId') as cust_subscription_id, - JSON_EXTRACT(Properties, '$.Status') as status, - JSON_EXTRACT(Properties, '$.SubscriptionCreationTime') as subscription_creation_time, JSON_EXTRACT(Properties, '$.SourceIdsList') as source_ids_list, - JSON_EXTRACT(Properties, '$.EventCategoriesList') as event_categories_list + JSON_EXTRACT(Properties, '$.SnsTopicArn') as sns_topic_arn, + JSON_EXTRACT(Properties, '$.SubscriptionCreationTime') as subscription_creation_time, + JSON_EXTRACT(Properties, '$.Tags') as tags FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Redshift::EventSubscription' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'SubscriptionName') as subscription_name, - json_extract_path_text(Properties, 'SnsTopicArn') as sns_topic_arn, - json_extract_path_text(Properties, 'SourceType') as source_type, - json_extract_path_text(Properties, 'SourceIds') as source_ids, - json_extract_path_text(Properties, 'EventCategories') as event_categories, - json_extract_path_text(Properties, 'Severity') as severity, - json_extract_path_text(Properties, 'Enabled') as enabled, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'CustomerAwsId') as customer_aws_id, - json_extract_path_text(Properties, 'CustSubscriptionId') as cust_subscription_id, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'SubscriptionCreationTime') as subscription_creation_time, - json_extract_path_text(Properties, 'SourceIdsList') as source_ids_list, - json_extract_path_text(Properties, 'EventCategoriesList') as event_categories_list - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Redshift::EventSubscription' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.SubscriptionName') as subscription_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Redshift::EventSubscription' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'CustSubscriptionId') as cust_subscription_id, + json_extract_path_text(Properties, 'EventCategoriesList') as event_categories_list, + json_extract_path_text(Properties, 'SourceType') as source_type, + json_extract_path_text(Properties, 'EventCategories') as event_categories, + json_extract_path_text(Properties, 'Enabled') as enabled, + json_extract_path_text(Properties, 'Severity') as severity, + json_extract_path_text(Properties, 'SubscriptionName') as subscription_name, + json_extract_path_text(Properties, 'SourceIds') as source_ids, + json_extract_path_text(Properties, 'CustomerAwsId') as customer_aws_id, + json_extract_path_text(Properties, 'SourceIdsList') as source_ids_list, + json_extract_path_text(Properties, 'SnsTopicArn') as sns_topic_arn, + json_extract_path_text(Properties, 'SubscriptionCreationTime') as subscription_creation_time, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Redshift::EventSubscription' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'SubscriptionName') as subscription_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Redshift::EventSubscription' + AND region = 'us-east-1' scheduled_actions: name: scheduled_actions id: aws.redshift.scheduled_actions @@ -2909,7 +2944,7 @@ components: x-cfn-type-name: AWS::Redshift::ScheduledAction x-identifiers: - ScheduledActionName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2926,9 +2961,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2938,41 +2973,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/scheduled_actions/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/scheduled_actions/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ScheduledActionName') as scheduled_action_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Redshift::ScheduledAction' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ScheduledActionName') as scheduled_action_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Redshift::ScheduledAction' - AND region = 'us-east-1' - scheduled_action: - name: scheduled_action - id: aws.redshift.scheduled_action - x-cfn-schema-name: ScheduledAction - x-cfn-type-name: AWS::Redshift::ScheduledAction - x-identifiers: - - ScheduledActionName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2983,48 +2986,68 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/scheduled_actions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/scheduled_actions/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/scheduled_action/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/scheduled_actions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, + JSON_EXTRACT(Properties, '$.ScheduledActionDescription') as scheduled_action_description, JSON_EXTRACT(Properties, '$.ScheduledActionName') as scheduled_action_name, - JSON_EXTRACT(Properties, '$.TargetAction') as target_action, + JSON_EXTRACT(Properties, '$.EndTime') as end_time, + JSON_EXTRACT(Properties, '$.State') as state, JSON_EXTRACT(Properties, '$.Schedule') as schedule, JSON_EXTRACT(Properties, '$.IamRole') as iam_role, - JSON_EXTRACT(Properties, '$.ScheduledActionDescription') as scheduled_action_description, JSON_EXTRACT(Properties, '$.StartTime') as start_time, - JSON_EXTRACT(Properties, '$.EndTime') as end_time, JSON_EXTRACT(Properties, '$.Enable') as enable, - JSON_EXTRACT(Properties, '$.State') as state, + JSON_EXTRACT(Properties, '$.TargetAction') as target_action, JSON_EXTRACT(Properties, '$.NextInvocations') as next_invocations FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Redshift::ScheduledAction' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ScheduledActionName') as scheduled_action_name, - json_extract_path_text(Properties, 'TargetAction') as target_action, - json_extract_path_text(Properties, 'Schedule') as schedule, - json_extract_path_text(Properties, 'IamRole') as iam_role, - json_extract_path_text(Properties, 'ScheduledActionDescription') as scheduled_action_description, - json_extract_path_text(Properties, 'StartTime') as start_time, - json_extract_path_text(Properties, 'EndTime') as end_time, - json_extract_path_text(Properties, 'Enable') as enable, - json_extract_path_text(Properties, 'State') as state, - json_extract_path_text(Properties, 'NextInvocations') as next_invocations - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Redshift::ScheduledAction' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ScheduledActionName') as scheduled_action_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Redshift::ScheduledAction' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ScheduledActionDescription') as scheduled_action_description, + json_extract_path_text(Properties, 'ScheduledActionName') as scheduled_action_name, + json_extract_path_text(Properties, 'EndTime') as end_time, + json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'Schedule') as schedule, + json_extract_path_text(Properties, 'IamRole') as iam_role, + json_extract_path_text(Properties, 'StartTime') as start_time, + json_extract_path_text(Properties, 'Enable') as enable, + json_extract_path_text(Properties, 'TargetAction') as target_action, + json_extract_path_text(Properties, 'NextInvocations') as next_invocations + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Redshift::ScheduledAction' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ScheduledActionName') as scheduled_action_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Redshift::ScheduledAction' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/redshiftserverless.yaml b/providers/src/aws/v00.00.00000/services/redshiftserverless.yaml index c1c0c915..40a1ceed 100644 --- a/providers/src/aws/v00.00.00000/services/redshiftserverless.yaml +++ b/providers/src/aws/v00.00.00000/services/redshiftserverless.yaml @@ -799,6 +799,7 @@ components: - redshift-serverless:CreateNamespace - redshift-serverless:CreateWorkgroup - redshift-serverless:GetWorkgroup + - redshift-serverless:GetNamespace read: - ec2:DescribeVpcAttribute - ec2:DescribeSecurityGroups @@ -830,6 +831,7 @@ components: - ec2:DescribeAccountAttributes - ec2:DescribeAvailabilityZones - redshift-serverless:GetWorkgroup + - redshift-serverless:GetNamespace - redshift-serverless:DeleteWorkgroup list: - ec2:DescribeVpcAttribute @@ -1048,7 +1050,7 @@ components: x-cfn-type-name: AWS::RedshiftServerless::Namespace x-identifiers: - NamespaceName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1065,9 +1067,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1077,41 +1079,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/namespaces/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/namespaces/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.NamespaceName') as namespace_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RedshiftServerless::Namespace' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'NamespaceName') as namespace_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RedshiftServerless::Namespace' - AND region = 'us-east-1' - namespace: - name: namespace - id: aws.redshiftserverless.namespace - x-cfn-schema-name: Namespace - x-cfn-type-name: AWS::RedshiftServerless::Namespace - x-identifiers: - - NamespaceName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1122,12 +1092,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/namespaces/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/namespaces/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/namespace/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/namespaces/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1153,31 +1127,47 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AdminPasswordSecretKmsKeyId') as admin_password_secret_kms_key_id, - json_extract_path_text(Properties, 'AdminUserPassword') as admin_user_password, - json_extract_path_text(Properties, 'AdminUsername') as admin_username, - json_extract_path_text(Properties, 'DbName') as db_name, - json_extract_path_text(Properties, 'DefaultIamRoleArn') as default_iam_role_arn, - json_extract_path_text(Properties, 'IamRoles') as iam_roles, - json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, - json_extract_path_text(Properties, 'LogExports') as log_exports, - json_extract_path_text(Properties, 'ManageAdminPassword') as manage_admin_password, - json_extract_path_text(Properties, 'Namespace') as namespace, - json_extract_path_text(Properties, 'NamespaceName') as namespace_name, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'FinalSnapshotName') as final_snapshot_name, - json_extract_path_text(Properties, 'FinalSnapshotRetentionPeriod') as final_snapshot_retention_period, - json_extract_path_text(Properties, 'NamespaceResourcePolicy') as namespace_resource_policy, - json_extract_path_text(Properties, 'RedshiftIdcApplicationArn') as redshift_idc_application_arn, - json_extract_path_text(Properties, 'SnapshotCopyConfigurations') as snapshot_copy_configurations - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::RedshiftServerless::Namespace' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.NamespaceName') as namespace_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RedshiftServerless::Namespace' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AdminPasswordSecretKmsKeyId') as admin_password_secret_kms_key_id, + json_extract_path_text(Properties, 'AdminUserPassword') as admin_user_password, + json_extract_path_text(Properties, 'AdminUsername') as admin_username, + json_extract_path_text(Properties, 'DbName') as db_name, + json_extract_path_text(Properties, 'DefaultIamRoleArn') as default_iam_role_arn, + json_extract_path_text(Properties, 'IamRoles') as iam_roles, + json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, + json_extract_path_text(Properties, 'LogExports') as log_exports, + json_extract_path_text(Properties, 'ManageAdminPassword') as manage_admin_password, + json_extract_path_text(Properties, 'Namespace') as namespace, + json_extract_path_text(Properties, 'NamespaceName') as namespace_name, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'FinalSnapshotName') as final_snapshot_name, + json_extract_path_text(Properties, 'FinalSnapshotRetentionPeriod') as final_snapshot_retention_period, + json_extract_path_text(Properties, 'NamespaceResourcePolicy') as namespace_resource_policy, + json_extract_path_text(Properties, 'RedshiftIdcApplicationArn') as redshift_idc_application_arn, + json_extract_path_text(Properties, 'SnapshotCopyConfigurations') as snapshot_copy_configurations + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::RedshiftServerless::Namespace' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'NamespaceName') as namespace_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RedshiftServerless::Namespace' + AND region = 'us-east-1' workgroups: name: workgroups id: aws.redshiftserverless.workgroups @@ -1185,7 +1175,7 @@ components: x-cfn-type-name: AWS::RedshiftServerless::Workgroup x-identifiers: - WorkgroupName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1202,9 +1192,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1214,41 +1204,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/workgroups/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/workgroups/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.WorkgroupName') as workgroup_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RedshiftServerless::Workgroup' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'WorkgroupName') as workgroup_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RedshiftServerless::Workgroup' - AND region = 'us-east-1' - workgroup: - name: workgroup - id: aws.redshiftserverless.workgroup - x-cfn-schema-name: Workgroup - x-cfn-type-name: AWS::RedshiftServerless::Workgroup - x-identifiers: - - WorkgroupName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1259,12 +1217,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/workgroups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/workgroups/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/workgroup/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/workgroups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1285,26 +1247,42 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'WorkgroupName') as workgroup_name, - json_extract_path_text(Properties, 'NamespaceName') as namespace_name, - json_extract_path_text(Properties, 'BaseCapacity') as base_capacity, - json_extract_path_text(Properties, 'MaxCapacity') as max_capacity, - json_extract_path_text(Properties, 'EnhancedVpcRouting') as enhanced_vpc_routing, - json_extract_path_text(Properties, 'ConfigParameters') as config_parameters, - json_extract_path_text(Properties, 'SecurityGroupIds') as security_group_ids, - json_extract_path_text(Properties, 'SubnetIds') as subnet_ids, - json_extract_path_text(Properties, 'PubliclyAccessible') as publicly_accessible, - json_extract_path_text(Properties, 'Port') as port, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Workgroup') as workgroup - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::RedshiftServerless::Workgroup' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.WorkgroupName') as workgroup_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RedshiftServerless::Workgroup' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'WorkgroupName') as workgroup_name, + json_extract_path_text(Properties, 'NamespaceName') as namespace_name, + json_extract_path_text(Properties, 'BaseCapacity') as base_capacity, + json_extract_path_text(Properties, 'MaxCapacity') as max_capacity, + json_extract_path_text(Properties, 'EnhancedVpcRouting') as enhanced_vpc_routing, + json_extract_path_text(Properties, 'ConfigParameters') as config_parameters, + json_extract_path_text(Properties, 'SecurityGroupIds') as security_group_ids, + json_extract_path_text(Properties, 'SubnetIds') as subnet_ids, + json_extract_path_text(Properties, 'PubliclyAccessible') as publicly_accessible, + json_extract_path_text(Properties, 'Port') as port, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Workgroup') as workgroup + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::RedshiftServerless::Workgroup' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'WorkgroupName') as workgroup_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RedshiftServerless::Workgroup' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/refactorspaces.yaml b/providers/src/aws/v00.00.00000/services/refactorspaces.yaml index 2f519814..a841c6e7 100644 --- a/providers/src/aws/v00.00.00000/services/refactorspaces.yaml +++ b/providers/src/aws/v00.00.00000/services/refactorspaces.yaml @@ -1318,7 +1318,7 @@ components: x-identifiers: - EnvironmentIdentifier - ApplicationIdentifier - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1352,42 +1352,11 @@ components: - $ref: '#/components/x-stackQL-resources/applications/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/applications/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.EnvironmentIdentifier') as environment_identifier, - JSON_EXTRACT(Properties, '$.ApplicationIdentifier') as application_identifier - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RefactorSpaces::Application' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'EnvironmentIdentifier') as environment_identifier, - json_extract_path_text(Properties, 'ApplicationIdentifier') as application_identifier - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RefactorSpaces::Application' - AND region = 'us-east-1' - application: - name: application - id: aws.refactorspaces.application - x-cfn-schema-name: Application - x-cfn-type-name: AWS::RefactorSpaces::Application - x-identifiers: - - EnvironmentIdentifier - - ApplicationIdentifier - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1410,28 +1379,46 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ApiGatewayProxy') as api_gateway_proxy, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'ApiGatewayId') as api_gateway_id, - json_extract_path_text(Properties, 'VpcLinkId') as vpc_link_id, - json_extract_path_text(Properties, 'NlbArn') as nlb_arn, - json_extract_path_text(Properties, 'NlbName') as nlb_name, - json_extract_path_text(Properties, 'ApplicationIdentifier') as application_identifier, - json_extract_path_text(Properties, 'EnvironmentIdentifier') as environment_identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'ProxyType') as proxy_type, - json_extract_path_text(Properties, 'VpcId') as vpc_id, - json_extract_path_text(Properties, 'StageName') as stage_name, - json_extract_path_text(Properties, 'ProxyUrl') as proxy_url, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::RefactorSpaces::Application' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.EnvironmentIdentifier') as environment_identifier, + JSON_EXTRACT(Properties, '$.ApplicationIdentifier') as application_identifier + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RefactorSpaces::Application' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ApiGatewayProxy') as api_gateway_proxy, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'ApiGatewayId') as api_gateway_id, + json_extract_path_text(Properties, 'VpcLinkId') as vpc_link_id, + json_extract_path_text(Properties, 'NlbArn') as nlb_arn, + json_extract_path_text(Properties, 'NlbName') as nlb_name, + json_extract_path_text(Properties, 'ApplicationIdentifier') as application_identifier, + json_extract_path_text(Properties, 'EnvironmentIdentifier') as environment_identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'ProxyType') as proxy_type, + json_extract_path_text(Properties, 'VpcId') as vpc_id, + json_extract_path_text(Properties, 'StageName') as stage_name, + json_extract_path_text(Properties, 'ProxyUrl') as proxy_url, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::RefactorSpaces::Application' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'EnvironmentIdentifier') as environment_identifier, + json_extract_path_text(Properties, 'ApplicationIdentifier') as application_identifier + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RefactorSpaces::Application' + AND region = 'us-east-1' environments: name: environments id: aws.refactorspaces.environments @@ -1439,7 +1426,7 @@ components: x-cfn-type-name: AWS::RefactorSpaces::Environment x-identifiers: - EnvironmentIdentifier - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1473,39 +1460,11 @@ components: - $ref: '#/components/x-stackQL-resources/environments/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/environments/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.EnvironmentIdentifier') as environment_identifier - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RefactorSpaces::Environment' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'EnvironmentIdentifier') as environment_identifier - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RefactorSpaces::Environment' - AND region = 'us-east-1' - environment: - name: environment - id: aws.refactorspaces.environment - x-cfn-schema-name: Environment - x-cfn-type-name: AWS::RefactorSpaces::Environment - x-identifiers: - - EnvironmentIdentifier - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1521,21 +1480,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'EnvironmentIdentifier') as environment_identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'NetworkFabricType') as network_fabric_type, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'TransitGatewayId') as transit_gateway_id, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::RefactorSpaces::Environment' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.EnvironmentIdentifier') as environment_identifier + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RefactorSpaces::Environment' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'EnvironmentIdentifier') as environment_identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'NetworkFabricType') as network_fabric_type, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'TransitGatewayId') as transit_gateway_id, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::RefactorSpaces::Environment' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'EnvironmentIdentifier') as environment_identifier + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RefactorSpaces::Environment' + AND region = 'us-east-1' routes: name: routes id: aws.refactorspaces.routes @@ -1545,7 +1520,7 @@ components: - EnvironmentIdentifier - ApplicationIdentifier - RouteIdentifier - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1562,9 +1537,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1574,47 +1549,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/routes/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/routes/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.EnvironmentIdentifier') as environment_identifier, - JSON_EXTRACT(Properties, '$.ApplicationIdentifier') as application_identifier, - JSON_EXTRACT(Properties, '$.RouteIdentifier') as route_identifier - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RefactorSpaces::Route' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'EnvironmentIdentifier') as environment_identifier, - json_extract_path_text(Properties, 'ApplicationIdentifier') as application_identifier, - json_extract_path_text(Properties, 'RouteIdentifier') as route_identifier - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RefactorSpaces::Route' - AND region = 'us-east-1' - route: - name: route - id: aws.refactorspaces.route - x-cfn-schema-name: Route - x-cfn-type-name: AWS::RefactorSpaces::Route - x-identifiers: - - EnvironmentIdentifier - - ApplicationIdentifier - - RouteIdentifier - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1625,12 +1562,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/routes/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/routes/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/route/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/routes/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1649,24 +1590,44 @@ components: AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'PathResourceToId') as path_resource_to_id, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'ApplicationIdentifier') as application_identifier, - json_extract_path_text(Properties, 'EnvironmentIdentifier') as environment_identifier, - json_extract_path_text(Properties, 'RouteIdentifier') as route_identifier, - json_extract_path_text(Properties, 'RouteType') as route_type, - json_extract_path_text(Properties, 'ServiceIdentifier') as service_identifier, - json_extract_path_text(Properties, 'DefaultRoute') as default_route, - json_extract_path_text(Properties, 'UriPathRoute') as uri_path_route, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::RefactorSpaces::Route' - AND data__Identifier = '||' + JSON_EXTRACT(Properties, '$.EnvironmentIdentifier') as environment_identifier, + JSON_EXTRACT(Properties, '$.ApplicationIdentifier') as application_identifier, + JSON_EXTRACT(Properties, '$.RouteIdentifier') as route_identifier + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RefactorSpaces::Route' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'PathResourceToId') as path_resource_to_id, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'ApplicationIdentifier') as application_identifier, + json_extract_path_text(Properties, 'EnvironmentIdentifier') as environment_identifier, + json_extract_path_text(Properties, 'RouteIdentifier') as route_identifier, + json_extract_path_text(Properties, 'RouteType') as route_type, + json_extract_path_text(Properties, 'ServiceIdentifier') as service_identifier, + json_extract_path_text(Properties, 'DefaultRoute') as default_route, + json_extract_path_text(Properties, 'UriPathRoute') as uri_path_route, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::RefactorSpaces::Route' + AND data__Identifier = '||' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'EnvironmentIdentifier') as environment_identifier, + json_extract_path_text(Properties, 'ApplicationIdentifier') as application_identifier, + json_extract_path_text(Properties, 'RouteIdentifier') as route_identifier + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RefactorSpaces::Route' + AND region = 'us-east-1' services: name: services id: aws.refactorspaces.services @@ -1676,7 +1637,7 @@ components: - EnvironmentIdentifier - ApplicationIdentifier - ServiceIdentifier - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1710,45 +1671,11 @@ components: - $ref: '#/components/x-stackQL-resources/services/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/services/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.EnvironmentIdentifier') as environment_identifier, - JSON_EXTRACT(Properties, '$.ApplicationIdentifier') as application_identifier, - JSON_EXTRACT(Properties, '$.ServiceIdentifier') as service_identifier - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RefactorSpaces::Service' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'EnvironmentIdentifier') as environment_identifier, - json_extract_path_text(Properties, 'ApplicationIdentifier') as application_identifier, - json_extract_path_text(Properties, 'ServiceIdentifier') as service_identifier - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RefactorSpaces::Service' - AND region = 'us-east-1' - service: - name: service - id: aws.refactorspaces.service - x-cfn-schema-name: Service - x-cfn-type-name: AWS::RefactorSpaces::Service - x-identifiers: - - EnvironmentIdentifier - - ApplicationIdentifier - - ServiceIdentifier - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1768,25 +1695,45 @@ components: AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'ApplicationIdentifier') as application_identifier, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'EndpointType') as endpoint_type, - json_extract_path_text(Properties, 'EnvironmentIdentifier') as environment_identifier, - json_extract_path_text(Properties, 'LambdaEndpoint') as lambda_endpoint, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'ServiceIdentifier') as service_identifier, - json_extract_path_text(Properties, 'UrlEndpoint') as url_endpoint, - json_extract_path_text(Properties, 'VpcId') as vpc_id, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::RefactorSpaces::Service' - AND data__Identifier = '||' + JSON_EXTRACT(Properties, '$.EnvironmentIdentifier') as environment_identifier, + JSON_EXTRACT(Properties, '$.ApplicationIdentifier') as application_identifier, + JSON_EXTRACT(Properties, '$.ServiceIdentifier') as service_identifier + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RefactorSpaces::Service' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'ApplicationIdentifier') as application_identifier, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'EndpointType') as endpoint_type, + json_extract_path_text(Properties, 'EnvironmentIdentifier') as environment_identifier, + json_extract_path_text(Properties, 'LambdaEndpoint') as lambda_endpoint, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'ServiceIdentifier') as service_identifier, + json_extract_path_text(Properties, 'UrlEndpoint') as url_endpoint, + json_extract_path_text(Properties, 'VpcId') as vpc_id, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::RefactorSpaces::Service' + AND data__Identifier = '||' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'EnvironmentIdentifier') as environment_identifier, + json_extract_path_text(Properties, 'ApplicationIdentifier') as application_identifier, + json_extract_path_text(Properties, 'ServiceIdentifier') as service_identifier + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RefactorSpaces::Service' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/rekognition.yaml b/providers/src/aws/v00.00.00000/services/rekognition.yaml index fec11c38..2c73db9b 100644 --- a/providers/src/aws/v00.00.00000/services/rekognition.yaml +++ b/providers/src/aws/v00.00.00000/services/rekognition.yaml @@ -907,7 +907,7 @@ components: x-cfn-type-name: AWS::Rekognition::Collection x-identifiers: - CollectionId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -924,9 +924,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -936,41 +936,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/collections/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/collections/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.CollectionId') as collection_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Rekognition::Collection' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'CollectionId') as collection_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Rekognition::Collection' - AND region = 'us-east-1' - collection: - name: collection - id: aws.rekognition.collection - x-cfn-schema-name: Collection - x-cfn-type-name: AWS::Rekognition::Collection - x-identifiers: - - CollectionId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -981,12 +949,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/collections/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/collections/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/collection/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/collections/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -998,17 +970,33 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'CollectionId') as collection_id, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Rekognition::Collection' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.CollectionId') as collection_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Rekognition::Collection' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'CollectionId') as collection_id, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Rekognition::Collection' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'CollectionId') as collection_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Rekognition::Collection' + AND region = 'us-east-1' projects: name: projects id: aws.rekognition.projects @@ -1016,7 +1004,7 @@ components: x-cfn-type-name: AWS::Rekognition::Project x-identifiers: - ProjectName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1050,39 +1038,11 @@ components: - $ref: '#/components/x-stackQL-resources/projects/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/projects/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ProjectName') as project_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Rekognition::Project' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ProjectName') as project_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Rekognition::Project' - AND region = 'us-east-1' - project: - name: project - id: aws.rekognition.project - x-cfn-schema-name: Project - x-cfn-type-name: AWS::Rekognition::Project - x-identifiers: - - ProjectName - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1093,16 +1053,32 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'ProjectName') as project_name - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Rekognition::Project' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ProjectName') as project_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Rekognition::Project' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'ProjectName') as project_name + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Rekognition::Project' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ProjectName') as project_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Rekognition::Project' + AND region = 'us-east-1' stream_processors: name: stream_processors id: aws.rekognition.stream_processors @@ -1110,7 +1086,7 @@ components: x-cfn-type-name: AWS::Rekognition::StreamProcessor x-identifiers: - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1127,9 +1103,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1139,41 +1115,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/stream_processors/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/stream_processors/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Rekognition::StreamProcessor' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Rekognition::StreamProcessor' - AND region = 'us-east-1' - stream_processor: - name: stream_processor - id: aws.rekognition.stream_processor - x-cfn-schema-name: StreamProcessor - x-cfn-type-name: AWS::Rekognition::StreamProcessor - x-identifiers: - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1184,12 +1128,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/stream_processors/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/stream_processors/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/stream_processor/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/stream_processors/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1214,30 +1162,46 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, - json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'KinesisVideoStream') as kinesis_video_stream, - json_extract_path_text(Properties, 'FaceSearchSettings') as face_search_settings, - json_extract_path_text(Properties, 'ConnectedHomeSettings') as connected_home_settings, - json_extract_path_text(Properties, 'KinesisDataStream') as kinesis_data_stream, - json_extract_path_text(Properties, 'S3Destination') as s3_destination, - json_extract_path_text(Properties, 'NotificationChannel') as notification_channel, - json_extract_path_text(Properties, 'DataSharingPreference') as data_sharing_preference, - json_extract_path_text(Properties, 'PolygonRegionsOfInterest') as polygon_regions_of_interest, - json_extract_path_text(Properties, 'BoundingBoxRegionsOfInterest') as bounding_box_regions_of_interest, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'StatusMessage') as status_message, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Rekognition::StreamProcessor' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Rekognition::StreamProcessor' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'KinesisVideoStream') as kinesis_video_stream, + json_extract_path_text(Properties, 'FaceSearchSettings') as face_search_settings, + json_extract_path_text(Properties, 'ConnectedHomeSettings') as connected_home_settings, + json_extract_path_text(Properties, 'KinesisDataStream') as kinesis_data_stream, + json_extract_path_text(Properties, 'S3Destination') as s3_destination, + json_extract_path_text(Properties, 'NotificationChannel') as notification_channel, + json_extract_path_text(Properties, 'DataSharingPreference') as data_sharing_preference, + json_extract_path_text(Properties, 'PolygonRegionsOfInterest') as polygon_regions_of_interest, + json_extract_path_text(Properties, 'BoundingBoxRegionsOfInterest') as bounding_box_regions_of_interest, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'StatusMessage') as status_message, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Rekognition::StreamProcessor' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Rekognition::StreamProcessor' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/resiliencehub.yaml b/providers/src/aws/v00.00.00000/services/resiliencehub.yaml index ff1a1783..4b4e357d 100644 --- a/providers/src/aws/v00.00.00000/services/resiliencehub.yaml +++ b/providers/src/aws/v00.00.00000/services/resiliencehub.yaml @@ -860,7 +860,7 @@ components: x-cfn-type-name: AWS::ResilienceHub::App x-identifiers: - AppArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -877,9 +877,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -889,41 +889,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/apps/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/apps/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AppArn') as app_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ResilienceHub::App' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AppArn') as app_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ResilienceHub::App' - AND region = 'us-east-1' - app: - name: app - id: aws.resiliencehub.app - x-cfn-schema-name: App - x-cfn-type-name: AWS::ResilienceHub::App - x-identifiers: - - AppArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -934,12 +902,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/apps/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/apps/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/app/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/apps/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -959,25 +931,41 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'AppArn') as app_arn, - json_extract_path_text(Properties, 'ResiliencyPolicyArn') as resiliency_policy_arn, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'AppTemplateBody') as app_template_body, - json_extract_path_text(Properties, 'ResourceMappings') as resource_mappings, - json_extract_path_text(Properties, 'AppAssessmentSchedule') as app_assessment_schedule, - json_extract_path_text(Properties, 'PermissionModel') as permission_model, - json_extract_path_text(Properties, 'EventSubscriptions') as event_subscriptions, - json_extract_path_text(Properties, 'DriftStatus') as drift_status - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ResilienceHub::App' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.AppArn') as app_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ResilienceHub::App' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'AppArn') as app_arn, + json_extract_path_text(Properties, 'ResiliencyPolicyArn') as resiliency_policy_arn, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'AppTemplateBody') as app_template_body, + json_extract_path_text(Properties, 'ResourceMappings') as resource_mappings, + json_extract_path_text(Properties, 'AppAssessmentSchedule') as app_assessment_schedule, + json_extract_path_text(Properties, 'PermissionModel') as permission_model, + json_extract_path_text(Properties, 'EventSubscriptions') as event_subscriptions, + json_extract_path_text(Properties, 'DriftStatus') as drift_status + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ResilienceHub::App' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AppArn') as app_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ResilienceHub::App' + AND region = 'us-east-1' resiliency_policies: name: resiliency_policies id: aws.resiliencehub.resiliency_policies @@ -985,7 +973,7 @@ components: x-cfn-type-name: AWS::ResilienceHub::ResiliencyPolicy x-identifiers: - PolicyArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1002,9 +990,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1014,41 +1002,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/resiliency_policies/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/resiliency_policies/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.PolicyArn') as policy_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ResilienceHub::ResiliencyPolicy' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'PolicyArn') as policy_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ResilienceHub::ResiliencyPolicy' - AND region = 'us-east-1' - resiliency_policy: - name: resiliency_policy - id: aws.resiliencehub.resiliency_policy - x-cfn-schema-name: ResiliencyPolicy - x-cfn-type-name: AWS::ResilienceHub::ResiliencyPolicy - x-identifiers: - - PolicyArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1059,12 +1015,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/resiliency_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/resiliency_policies/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/resiliency_policy/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/resiliency_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1080,21 +1040,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'PolicyName') as policy_name, - json_extract_path_text(Properties, 'PolicyDescription') as policy_description, - json_extract_path_text(Properties, 'DataLocationConstraint') as data_location_constraint, - json_extract_path_text(Properties, 'Tier') as tier, - json_extract_path_text(Properties, 'Policy') as policy, - json_extract_path_text(Properties, 'PolicyArn') as policy_arn, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ResilienceHub::ResiliencyPolicy' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.PolicyArn') as policy_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ResilienceHub::ResiliencyPolicy' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'PolicyName') as policy_name, + json_extract_path_text(Properties, 'PolicyDescription') as policy_description, + json_extract_path_text(Properties, 'DataLocationConstraint') as data_location_constraint, + json_extract_path_text(Properties, 'Tier') as tier, + json_extract_path_text(Properties, 'Policy') as policy, + json_extract_path_text(Properties, 'PolicyArn') as policy_arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ResilienceHub::ResiliencyPolicy' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'PolicyArn') as policy_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ResilienceHub::ResiliencyPolicy' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/resourceexplorer2.yaml b/providers/src/aws/v00.00.00000/services/resourceexplorer2.yaml index 2eefd26d..c7c47d66 100644 --- a/providers/src/aws/v00.00.00000/services/resourceexplorer2.yaml +++ b/providers/src/aws/v00.00.00000/services/resourceexplorer2.yaml @@ -659,7 +659,7 @@ components: x-cfn-type-name: AWS::ResourceExplorer2::DefaultViewAssociation x-identifiers: - AssociatedAwsPrincipal - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -676,9 +676,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -688,23 +688,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/default_view_associations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/default_view_associations/methods/delete_resource' - default_view_association: - name: default_view_association - id: aws.resourceexplorer2.default_view_association - x-cfn-schema-name: DefaultViewAssociation - x-cfn-type-name: AWS::ResourceExplorer2::DefaultViewAssociation - x-identifiers: - - AssociatedAwsPrincipal - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -715,12 +701,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/default_view_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/default_view_associations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/default_view_association/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/default_view_associations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -731,7 +721,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -748,7 +738,7 @@ components: x-cfn-type-name: AWS::ResourceExplorer2::Index x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -765,9 +755,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -777,41 +767,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/indices/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/indices/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ResourceExplorer2::Index' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ResourceExplorer2::Index' - AND region = 'us-east-1' - index: - name: index - id: aws.resourceexplorer2.index - x-cfn-schema-name: Index - x-cfn-type-name: AWS::ResourceExplorer2::Index - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -822,12 +780,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/indices/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/indices/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/index/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/indices/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -840,18 +802,34 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Type') as type, - json_extract_path_text(Properties, 'IndexState') as index_state - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ResourceExplorer2::Index' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ResourceExplorer2::Index' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'IndexState') as index_state + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ResourceExplorer2::Index' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ResourceExplorer2::Index' + AND region = 'us-east-1' views: name: views id: aws.resourceexplorer2.views @@ -859,7 +837,7 @@ components: x-cfn-type-name: AWS::ResourceExplorer2::View x-identifiers: - ViewArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -876,9 +854,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -888,41 +866,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/views/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/views/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ViewArn') as view_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ResourceExplorer2::View' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ViewArn') as view_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ResourceExplorer2::View' - AND region = 'us-east-1' - view: - name: view - id: aws.resourceexplorer2.view - x-cfn-schema-name: View - x-cfn-type-name: AWS::ResourceExplorer2::View - x-identifiers: - - ViewArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -933,12 +879,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/views/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/views/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/view/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/views/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -953,20 +903,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Filters') as filters, - json_extract_path_text(Properties, 'IncludedProperties') as included_properties, - json_extract_path_text(Properties, 'Scope') as scope, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'ViewArn') as view_arn, - json_extract_path_text(Properties, 'ViewName') as view_name - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ResourceExplorer2::View' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ViewArn') as view_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ResourceExplorer2::View' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Filters') as filters, + json_extract_path_text(Properties, 'IncludedProperties') as included_properties, + json_extract_path_text(Properties, 'Scope') as scope, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'ViewArn') as view_arn, + json_extract_path_text(Properties, 'ViewName') as view_name + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ResourceExplorer2::View' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ViewArn') as view_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ResourceExplorer2::View' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/resourcegroups.yaml b/providers/src/aws/v00.00.00000/services/resourcegroups.yaml index cfbdb067..4e82d1d1 100644 --- a/providers/src/aws/v00.00.00000/services/resourcegroups.yaml +++ b/providers/src/aws/v00.00.00000/services/resourcegroups.yaml @@ -584,7 +584,7 @@ components: x-cfn-type-name: AWS::ResourceGroups::Group x-identifiers: - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -601,9 +601,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -613,41 +613,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/groups/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/groups/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ResourceGroups::Group' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ResourceGroups::Group' - AND region = 'us-east-1' - group: - name: group - id: aws.resourcegroups.group - x-cfn-schema-name: Group - x-cfn-type-name: AWS::ResourceGroups::Group - x-identifiers: - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -658,12 +626,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/groups/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/group/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -679,21 +651,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'ResourceQuery') as resource_query, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Configuration') as configuration, - json_extract_path_text(Properties, 'Resources') as resources - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ResourceGroups::Group' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ResourceGroups::Group' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'ResourceQuery') as resource_query, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Configuration') as configuration, + json_extract_path_text(Properties, 'Resources') as resources + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ResourceGroups::Group' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ResourceGroups::Group' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/robomaker.yaml b/providers/src/aws/v00.00.00000/services/robomaker.yaml index d412e4b1..7a54d596 100644 --- a/providers/src/aws/v00.00.00000/services/robomaker.yaml +++ b/providers/src/aws/v00.00.00000/services/robomaker.yaml @@ -1054,7 +1054,7 @@ components: x-cfn-type-name: AWS::RoboMaker::Fleet x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1071,9 +1071,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1083,41 +1083,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/fleets/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/fleets/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RoboMaker::Fleet' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RoboMaker::Fleet' - AND region = 'us-east-1' - fleet: - name: fleet - id: aws.robomaker.fleet - x-cfn-schema-name: Fleet - x-cfn-type-name: AWS::RoboMaker::Fleet - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1128,12 +1096,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/fleets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/fleets/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/fleet/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/fleets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1145,17 +1117,33 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::RoboMaker::Fleet' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RoboMaker::Fleet' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::RoboMaker::Fleet' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RoboMaker::Fleet' + AND region = 'us-east-1' robots: name: robots id: aws.robomaker.robots @@ -1163,7 +1151,7 @@ components: x-cfn-type-name: AWS::RoboMaker::Robot x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1180,9 +1168,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1192,41 +1180,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/robots/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/robots/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RoboMaker::Robot' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RoboMaker::Robot' - AND region = 'us-east-1' - robot: - name: robot - id: aws.robomaker.robot - x-cfn-schema-name: Robot - x-cfn-type-name: AWS::RoboMaker::Robot - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1237,12 +1193,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/robots/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/robots/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/robot/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/robots/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1257,20 +1217,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Fleet') as fleet, - json_extract_path_text(Properties, 'Architecture') as architecture, - json_extract_path_text(Properties, 'GreengrassGroupId') as greengrass_group_id, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::RoboMaker::Robot' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RoboMaker::Robot' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Fleet') as fleet, + json_extract_path_text(Properties, 'Architecture') as architecture, + json_extract_path_text(Properties, 'GreengrassGroupId') as greengrass_group_id, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::RoboMaker::Robot' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RoboMaker::Robot' + AND region = 'us-east-1' robot_applications: name: robot_applications id: aws.robomaker.robot_applications @@ -1278,7 +1254,7 @@ components: x-cfn-type-name: AWS::RoboMaker::RobotApplication x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1295,9 +1271,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1307,41 +1283,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/robot_applications/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/robot_applications/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RoboMaker::RobotApplication' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RoboMaker::RobotApplication' - AND region = 'us-east-1' - robot_application: - name: robot_application - id: aws.robomaker.robot_application - x-cfn-schema-name: RobotApplication - x-cfn-type-name: AWS::RoboMaker::RobotApplication - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1352,12 +1296,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/robot_applications/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/robot_applications/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/robot_application/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/robot_applications/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1373,21 +1321,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Sources') as sources, - json_extract_path_text(Properties, 'Environment') as environment, - json_extract_path_text(Properties, 'RobotSoftwareSuite') as robot_software_suite, - json_extract_path_text(Properties, 'CurrentRevisionId') as current_revision_id, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::RoboMaker::RobotApplication' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RoboMaker::RobotApplication' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Sources') as sources, + json_extract_path_text(Properties, 'Environment') as environment, + json_extract_path_text(Properties, 'RobotSoftwareSuite') as robot_software_suite, + json_extract_path_text(Properties, 'CurrentRevisionId') as current_revision_id, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::RoboMaker::RobotApplication' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RoboMaker::RobotApplication' + AND region = 'us-east-1' robot_application_versions: name: robot_application_versions id: aws.robomaker.robot_application_versions @@ -1395,7 +1359,7 @@ components: x-cfn-type-name: AWS::RoboMaker::RobotApplicationVersion x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1429,21 +1393,11 @@ components: - $ref: '#/components/x-stackQL-resources/robot_application_versions/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/robot_application_versions/methods/delete_resource' - robot_application_version: - name: robot_application_version - id: aws.robomaker.robot_application_version - x-cfn-schema-name: RobotApplicationVersion - x-cfn-type-name: AWS::RoboMaker::RobotApplicationVersion - x-identifiers: - - Arn - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1456,7 +1410,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1475,7 +1429,7 @@ components: x-cfn-type-name: AWS::RoboMaker::SimulationApplication x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1492,9 +1446,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1504,41 +1458,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/simulation_applications/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/simulation_applications/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RoboMaker::SimulationApplication' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RoboMaker::SimulationApplication' - AND region = 'us-east-1' - simulation_application: - name: simulation_application - id: aws.robomaker.simulation_application - x-cfn-schema-name: SimulationApplication - x-cfn-type-name: AWS::RoboMaker::SimulationApplication - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1549,12 +1471,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/simulation_applications/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/simulation_applications/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/simulation_application/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/simulation_applications/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1572,23 +1498,39 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'CurrentRevisionId') as current_revision_id, - json_extract_path_text(Properties, 'RenderingEngine') as rendering_engine, - json_extract_path_text(Properties, 'RobotSoftwareSuite') as robot_software_suite, - json_extract_path_text(Properties, 'SimulationSoftwareSuite') as simulation_software_suite, - json_extract_path_text(Properties, 'Sources') as sources, - json_extract_path_text(Properties, 'Environment') as environment, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::RoboMaker::SimulationApplication' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RoboMaker::SimulationApplication' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'CurrentRevisionId') as current_revision_id, + json_extract_path_text(Properties, 'RenderingEngine') as rendering_engine, + json_extract_path_text(Properties, 'RobotSoftwareSuite') as robot_software_suite, + json_extract_path_text(Properties, 'SimulationSoftwareSuite') as simulation_software_suite, + json_extract_path_text(Properties, 'Sources') as sources, + json_extract_path_text(Properties, 'Environment') as environment, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::RoboMaker::SimulationApplication' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RoboMaker::SimulationApplication' + AND region = 'us-east-1' simulation_application_versions: name: simulation_application_versions id: aws.robomaker.simulation_application_versions @@ -1596,7 +1538,7 @@ components: x-cfn-type-name: AWS::RoboMaker::SimulationApplicationVersion x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1630,21 +1572,11 @@ components: - $ref: '#/components/x-stackQL-resources/simulation_application_versions/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/simulation_application_versions/methods/delete_resource' - simulation_application_version: - name: simulation_application_version - id: aws.robomaker.simulation_application_version - x-cfn-schema-name: SimulationApplicationVersion - x-cfn-type-name: AWS::RoboMaker::SimulationApplicationVersion - x-identifiers: - - Arn - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1657,7 +1589,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, diff --git a/providers/src/aws/v00.00.00000/services/rolesanywhere.yaml b/providers/src/aws/v00.00.00000/services/rolesanywhere.yaml index bed5e58b..d5505e00 100644 --- a/providers/src/aws/v00.00.00000/services/rolesanywhere.yaml +++ b/providers/src/aws/v00.00.00000/services/rolesanywhere.yaml @@ -460,6 +460,33 @@ components: list: - rolesanywhere:ListCrls - rolesanywhere:ListTagsForResource + AttributeMapping: + type: object + properties: + MappingRules: + type: array + items: + $ref: '#/components/schemas/MappingRule' + CertificateField: + $ref: '#/components/schemas/CertificateField' + required: + - CertificateField + - MappingRules + additionalProperties: false + MappingRule: + type: object + properties: + Specifier: + type: string + required: + - Specifier + additionalProperties: false + CertificateField: + type: string + enum: + - x509Subject + - x509Issuer + - x509SAN Profile: type: object properties: @@ -496,6 +523,10 @@ components: $ref: '#/components/schemas/Tag' maxItems: 200 minItems: 0 + AttributeMappings: + type: array + items: + $ref: '#/components/schemas/AttributeMapping' required: - Name - RoleArns @@ -518,6 +549,8 @@ components: - rolesanywhere:CreateProfile - rolesanywhere:TagResource - rolesanywhere:ListTagsForResource + - rolesanywhere:PutAttributeMapping + - rolesanywhere:DeleteAttributeMapping read: - rolesanywhere:GetProfile - rolesanywhere:ListTagsForResource @@ -525,12 +558,15 @@ components: - iam:GetRole - iam:GetPolicy - iam:PassRole + - rolesanywhere:GetProfile - rolesanywhere:UpdateProfile - rolesanywhere:EnableProfile - rolesanywhere:DisableProfile - rolesanywhere:TagResource - rolesanywhere:UntagResource - rolesanywhere:ListTagsForResource + - rolesanywhere:PutAttributeMapping + - rolesanywhere:DeleteAttributeMapping delete: - rolesanywhere:DeleteProfile list: @@ -747,6 +783,10 @@ components: $ref: '#/components/schemas/Tag' maxItems: 200 minItems: 0 + AttributeMappings: + type: array + items: + $ref: '#/components/schemas/AttributeMapping' x-stackQL-stringOnly: true x-title: CreateProfileRequest type: object @@ -807,7 +847,7 @@ components: x-cfn-type-name: AWS::RolesAnywhere::CRL x-identifiers: - CrlId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -824,9 +864,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -836,41 +876,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/crls/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/crls/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.CrlId') as crl_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RolesAnywhere::CRL' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'CrlId') as crl_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RolesAnywhere::CRL' - AND region = 'us-east-1' - crl: - name: crl - id: aws.rolesanywhere.crl - x-cfn-schema-name: CRL - x-cfn-type-name: AWS::RolesAnywhere::CRL - x-identifiers: - - CrlId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -881,12 +889,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/crls/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/crls/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/crl/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/crls/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -901,20 +913,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'CrlData') as crl_data, - json_extract_path_text(Properties, 'CrlId') as crl_id, - json_extract_path_text(Properties, 'Enabled') as enabled, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'TrustAnchorArn') as trust_anchor_arn, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::RolesAnywhere::CRL' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.CrlId') as crl_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RolesAnywhere::CRL' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'CrlData') as crl_data, + json_extract_path_text(Properties, 'CrlId') as crl_id, + json_extract_path_text(Properties, 'Enabled') as enabled, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'TrustAnchorArn') as trust_anchor_arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::RolesAnywhere::CRL' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'CrlId') as crl_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RolesAnywhere::CRL' + AND region = 'us-east-1' profiles: name: profiles id: aws.rolesanywhere.profiles @@ -922,7 +950,7 @@ components: x-cfn-type-name: AWS::RolesAnywhere::Profile x-identifiers: - ProfileId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -939,9 +967,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -951,41 +979,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/profiles/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/profiles/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ProfileId') as profile_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RolesAnywhere::Profile' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ProfileId') as profile_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RolesAnywhere::Profile' - AND region = 'us-east-1' - profile: - name: profile - id: aws.rolesanywhere.profile - x-cfn-schema-name: Profile - x-cfn-type-name: AWS::RolesAnywhere::Profile - x-identifiers: - - ProfileId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -996,12 +992,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/profiles/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/profiles/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/profile/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/profiles/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1015,29 +1015,47 @@ components: JSON_EXTRACT(Properties, '$.RequireInstanceProperties') as require_instance_properties, JSON_EXTRACT(Properties, '$.RoleArns') as role_arns, JSON_EXTRACT(Properties, '$.SessionPolicy') as session_policy, - JSON_EXTRACT(Properties, '$.Tags') as tags + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.AttributeMappings') as attribute_mappings FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::RolesAnywhere::Profile' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'DurationSeconds') as duration_seconds, - json_extract_path_text(Properties, 'Enabled') as enabled, - json_extract_path_text(Properties, 'ManagedPolicyArns') as managed_policy_arns, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'ProfileArn') as profile_arn, - json_extract_path_text(Properties, 'ProfileId') as profile_id, - json_extract_path_text(Properties, 'RequireInstanceProperties') as require_instance_properties, - json_extract_path_text(Properties, 'RoleArns') as role_arns, - json_extract_path_text(Properties, 'SessionPolicy') as session_policy, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::RolesAnywhere::Profile' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ProfileId') as profile_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RolesAnywhere::Profile' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DurationSeconds') as duration_seconds, + json_extract_path_text(Properties, 'Enabled') as enabled, + json_extract_path_text(Properties, 'ManagedPolicyArns') as managed_policy_arns, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'ProfileArn') as profile_arn, + json_extract_path_text(Properties, 'ProfileId') as profile_id, + json_extract_path_text(Properties, 'RequireInstanceProperties') as require_instance_properties, + json_extract_path_text(Properties, 'RoleArns') as role_arns, + json_extract_path_text(Properties, 'SessionPolicy') as session_policy, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'AttributeMappings') as attribute_mappings + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::RolesAnywhere::Profile' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ProfileId') as profile_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RolesAnywhere::Profile' + AND region = 'us-east-1' trust_anchors: name: trust_anchors id: aws.rolesanywhere.trust_anchors @@ -1045,7 +1063,7 @@ components: x-cfn-type-name: AWS::RolesAnywhere::TrustAnchor x-identifiers: - TrustAnchorId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1062,9 +1080,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1074,41 +1092,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/trust_anchors/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/trust_anchors/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.TrustAnchorId') as trust_anchor_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RolesAnywhere::TrustAnchor' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'TrustAnchorId') as trust_anchor_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RolesAnywhere::TrustAnchor' - AND region = 'us-east-1' - trust_anchor: - name: trust_anchor - id: aws.rolesanywhere.trust_anchor - x-cfn-schema-name: TrustAnchor - x-cfn-type-name: AWS::RolesAnywhere::TrustAnchor - x-identifiers: - - TrustAnchorId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1119,12 +1105,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/trust_anchors/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/trust_anchors/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/trust_anchor/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/trust_anchors/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1140,21 +1130,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Enabled') as enabled, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'NotificationSettings') as notification_settings, - json_extract_path_text(Properties, 'Source') as source, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'TrustAnchorId') as trust_anchor_id, - json_extract_path_text(Properties, 'TrustAnchorArn') as trust_anchor_arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::RolesAnywhere::TrustAnchor' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.TrustAnchorId') as trust_anchor_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RolesAnywhere::TrustAnchor' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Enabled') as enabled, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'NotificationSettings') as notification_settings, + json_extract_path_text(Properties, 'Source') as source, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'TrustAnchorId') as trust_anchor_id, + json_extract_path_text(Properties, 'TrustAnchorArn') as trust_anchor_arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::RolesAnywhere::TrustAnchor' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'TrustAnchorId') as trust_anchor_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RolesAnywhere::TrustAnchor' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/route53.yaml b/providers/src/aws/v00.00.00000/services/route53.yaml index 8e613578..071a0811 100644 --- a/providers/src/aws/v00.00.00000/services/route53.yaml +++ b/providers/src/aws/v00.00.00000/services/route53.yaml @@ -385,6 +385,476 @@ components: $ref: '#/components/x-cloud-control-schemas/ProgressEvent' type: object schemas: + AliasHealthEnabled: + type: boolean + AliasTarget: + type: object + required: + - HostedZoneId + - DNSName + - EvaluateTargetHealth + properties: + HostedZoneId: + allOf: + - $ref: '#/components/schemas/ResourceId' + - description: >- +

Alias resource records sets only: The value used depends on where you want to route traffic:

Amazon API Gateway custom regional APIs and edge-optimized APIs

Specify the hosted zone ID for your API. You can get the applicable value using the CLI command get-domain-names:

  • For regional APIs, specify the value of + regionalHostedZoneId.

  • For edge-optimized APIs, specify the value of distributionHostedZoneId.

Amazon Virtual Private Cloud interface VPC endpoint

Specify the hosted zone ID for your interface endpoint. You can get the value of HostedZoneId using the CLI command describe-vpc-endpoints.

+
CloudFront distribution

Specify Z2FDTNDATAQYW2.

Alias resource record sets for CloudFront can't be created in a private zone.
Elastic Beanstalk environment

Specify the hosted zone ID for the region that you created the environment in. The environment must have a regionalized subdomain. For a list of regions and the corresponding hosted zone IDs, see Elastic Beanstalk endpoints and quotas in the the Amazon Web Services General Reference.

ELB load balancer

Specify the value of the hosted zone ID for the load balancer. Use the following methods to get the hosted zone ID:

  • Elastic Load Balancing endpoints and quotas topic in the + Amazon Web Services General Reference: Use the value that corresponds with the region that you created your load balancer in. Note that there are separate columns for Application and Classic Load Balancers and for Network Load Balancers.

  • Amazon Web Services Management Console: Go to the Amazon EC2 page, choose Load Balancers in the navigation pane, select the load balancer, and get the value of the Hosted zone field on the + Description tab.

  • Elastic Load Balancing API: Use DescribeLoadBalancers to get the applicable value. For more information, see the applicable guide:

  • CLI: Use describe-load-balancers to get the applicable value. For more information, see the applicable guide:

Global Accelerator + accelerator

Specify Z2BJ6XQ5FK7U4H.

An Amazon S3 bucket configured as a static website

Specify the hosted zone ID for the region that you created the bucket in. For more information about valid values, see the table Amazon S3 Website Endpoints in the Amazon Web Services General Reference.

Another Route 53 + resource record set in your hosted zone

Specify the hosted zone ID of your hosted zone. (An alias resource record set can't reference a resource record set in a different hosted zone.)

+ DNSName: + allOf: + - $ref: '#/components/schemas/DNSName' + - description: >- +

Alias resource record sets only: The value that you specify depends on where you want to route queries:

Amazon API Gateway custom regional APIs and edge-optimized APIs

Specify the applicable domain name for your API. You can get the applicable value using the CLI command get-domain-names:

  • For regional APIs, specify the value of + regionalDomainName.

  • For edge-optimized APIs, specify the value of distributionDomainName. This is the name of the associated CloudFront distribution, such as da1b2c3d4e5.cloudfront.net.

The name of the record that you're creating must match a custom domain name for your API, such as api.example.com.
Amazon Virtual Private Cloud interface VPC endpoint
+

Enter the API endpoint for the interface endpoint, such as vpce-123456789abcdef01-example-us-east-1a.elasticloadbalancing.us-east-1.vpce.amazonaws.com. For edge-optimized APIs, this is the domain name for the corresponding CloudFront distribution. You can get the value of DnsName using the CLI command describe-vpc-endpoints.

CloudFront + distribution

Specify the domain name that CloudFront assigned when you created your distribution.

Your CloudFront distribution must include an alternate domain name that matches the name of the resource record set. For example, if the name of the resource record set is acme.example.com, your CloudFront distribution must include acme.example.com as one of the alternate domain names. For more information, see Using Alternate Domain Names (CNAMEs) in the Amazon CloudFront Developer Guide.

You can't create a resource record set in a private hosted zone to route traffic to a CloudFront distribution.

For failover alias records, you can't specify a CloudFront distribution for both the primary and secondary records. A distribution must include an alternate domain name that + matches the name of the record. However, the primary and secondary records have the same name, and you can't include the same alternate domain name in more than one distribution.

Elastic Beanstalk environment

If the domain name for your Elastic Beanstalk environment includes the region that you deployed the environment in, you can create an alias record that routes traffic to the environment. For example, the domain name + my-environment.us-west-2.elasticbeanstalk.com is a regionalized domain name.

For environments that were created before early 2016, the domain name doesn't include the region. To route traffic to these environments, you must create a CNAME record instead of an alias record. Note that you can't create a CNAME record for the root domain name. For example, if your domain name is example.com, you can create a record that routes traffic for + acme.example.com to your Elastic Beanstalk environment, but you can't create a record that routes traffic for example.com to your Elastic Beanstalk environment.

For Elastic Beanstalk environments that have regionalized subdomains, specify the CNAME attribute for the environment. You can use the following methods to get the value of the CNAME attribute:

  • Amazon Web Services Management Console: For information about how to + get the value by using the console, see Using Custom Domains with Elastic Beanstalk in the Elastic Beanstalk Developer Guide.

  • Elastic Beanstalk API: Use the DescribeEnvironments action to get the value of the CNAME attribute. For more information, see DescribeEnvironments in the Elastic Beanstalk API Reference.

  • CLI: Use the describe-environments command to get the value of the CNAME attribute. For more information, see describe-environments in the CLI Command + Reference.

ELB load balancer

Specify the DNS name that is associated with the load balancer. Get the DNS name by using the Amazon Web Services Management Console, the ELB API, or the CLI.

  • Amazon Web Services Management Console: Go to the EC2 page, choose Load Balancers in the navigation pane, choose the load balancer, choose the Description tab, and get the value of the DNS name field.

    +

    If you're routing traffic to a Classic Load Balancer, get the value that begins with dualstack. If you're routing traffic to another type of load balancer, get the value that applies to the record type, A or AAAA.

  • Elastic Load Balancing API: Use DescribeLoadBalancers to get the value of DNSName. For more information, see the applicable guide:

  • CLI: Use describe-load-balancers to get the value of DNSName. For more information, see + the applicable guide:

Global Accelerator accelerator

Specify the DNS name for your + accelerator:

Amazon S3 bucket that is configured as a static website
+

Specify the domain name of the Amazon S3 website endpoint that you created the bucket in, for example, s3-website.us-east-2.amazonaws.com. For more information about valid values, see the table Amazon S3 Website Endpoints in the Amazon Web Services General Reference. For more information about using S3 buckets for websites, see Getting Started with Amazon Route 53 in the Amazon Route 53 Developer Guide.

Another Route 53 resource record set

Specify the value of the Name element for a resource record set in the current hosted zone.

If you're creating an alias record that has the same name as the hosted zone (known as the zone apex), you can't specify the + domain name for a record for which the value of Type is CNAME. This is because the alias record must have the same type as the record that you're routing traffic to, and creating a CNAME record for the zone apex isn't supported even for an alias record.
+ EvaluateTargetHealth: + allOf: + - $ref: '#/components/schemas/AliasHealthEnabled' + - description: >- +

Applies only to alias, failover alias, geolocation alias, latency alias, and weighted alias resource record sets: When EvaluateTargetHealth is true, an alias resource record set inherits the health of the referenced Amazon Web Services resource, such as an ELB load balancer or another resource record set in the hosted zone.

Note the following:

CloudFront distributions

You can't set + EvaluateTargetHealth to true when the alias target is a CloudFront distribution.

Elastic Beanstalk environments that have regionalized subdomains

If you specify an Elastic Beanstalk environment in DNSName and the environment contains an ELB load balancer, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. (An environment automatically contains + an ELB load balancer if it includes more than one Amazon EC2 instance.) If you set EvaluateTargetHealth to true and either no Amazon EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other available resources that are healthy, if any.

If the environment contains a single Amazon EC2 instance, there are no special requirements.

ELB load balancers

Health checking behavior + depends on the type of load balancer:

  • Classic Load Balancers: If you specify an ELB Classic Load Balancer in DNSName, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. If you set EvaluateTargetHealth to true and either no EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other resources.

    • +

  • Application and Network Load Balancers: If you specify an ELB Application or Network Load Balancer and you set EvaluateTargetHealth to true, Route 53 routes queries to the load balancer based on the health of the target groups that are associated with the load balancer:

    • For an Application or Network Load Balancer to be considered healthy, every target group that contains targets must contain at least one healthy target. + If any target group contains only unhealthy targets, the load balancer is considered unhealthy, and Route 53 routes queries to other resources.

    • A target group that has no registered targets is considered unhealthy.

When you create a load balancer, you configure settings for Elastic Load Balancing health checks; they're not Route 53 health checks, but they perform a similar function. Do not create Route 53 health checks for + the EC2 instances that you register with an ELB load balancer.

S3 buckets

There are no special requirements for setting EvaluateTargetHealth to true when the alias target is an S3 bucket.

Other records in the same hosted zone

If the Amazon Web Services resource that you specify in DNSName is a record or a group of records (for example, a group of weighted records) but is not + another alias record, we recommend that you associate a health check with all of the records in the alias target. For more information, see What Happens When You Omit Health Checks? in the Amazon Route 53 Developer Guide.

For more information and examples, see Amazon Route 53 Health Checks and DNS Failover in the Amazon Route 53 Developer Guide.

+ description: >- +

Alias resource record sets only: Information about the Amazon Web Services resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to.

When creating resource record sets for a private hosted zone, note the following:

+ Change: + type: object + required: + - Action + - ResourceRecordSet + properties: + Action: + allOf: + - $ref: '#/components/schemas/ChangeAction' + - description: >- +

The action to perform:

  • CREATE: Creates a resource record set that has the specified values.

  • DELETE: Deletes a existing resource record set.

    To delete the resource record set that is associated with a traffic policy instance, use DeleteTrafficPolicyInstance. Amazon Route 53 will delete the + resource record set automatically. If you delete the resource record set by using ChangeResourceRecordSets, Route 53 doesn't automatically delete the traffic policy instance, and you'll continue to be charged for it even though it's no longer in use.

  • UPSERT: If a resource record set doesn't already exist, Route 53 creates it. If a resource record set does exist, Route 53 updates it with the values in the request.

    +
+ ResourceRecordSet: + allOf: + - $ref: '#/components/schemas/ResourceRecordSet' + - description: Information about the resource record set to create, delete, or update. + description: The information for each resource record set that you want to change. + ChangeAction: + type: string + enum: + - CREATE + - DELETE + - UPSERT + ChangeInfo: + type: object + required: + - Id + - Status + - SubmittedAt + properties: + Id: + allOf: + - $ref: '#/components/schemas/ResourceId' + - description: This element contains an ID that you use when performing a GetChange action to get detailed information about the change. + Status: + allOf: + - $ref: '#/components/schemas/ChangeStatus' + - description: The current state of the request. PENDING indicates that this request has not yet been applied to all Amazon Route 53 DNS servers. + SubmittedAt: + allOf: + - $ref: '#/components/schemas/TimeStamp' + - description: The date and time that the change request was submitted in ISO 8601 format and Coordinated Universal Time (UTC). For example, the value 2017-03-27T17:48:16.751Z represents March 27, 2017 at 17:48:16.751 UTC. + Comment: + allOf: + - $ref: '#/components/schemas/ResourceDescription' + - description: A comment you can provide. + description: A complex type that describes change information about changes made to your hosted zone. + ChangeResourceRecordSetsResponse: + type: object + required: + - ChangeInfo + example: + ChangeInfo: + Comment: Geolocation alias configuration for example.com + Id: /change/C2682N5HXP0BZ4 + Status: PENDING + SubmittedAt: '2017-02-10T01:36:41.958Z' + properties: + ChangeInfo: + allOf: + - $ref: '#/components/schemas/ChangeInfo' + - description:

A complex type that contains information about changes made to your hosted zone.

This element contains an ID that you use when performing a GetChange action to get detailed information about the change.

+ description: A complex type containing the response for the request. + ChangeStatus: + type: string + enum: + - PENDING + - INSYNC + Changes: + type: array + items: + allOf: + - $ref: '#/components/schemas/Change' + - xml: + name: Change + minItems: 1 + CidrLocationNameDefaultAllowed: + type: string + pattern: '[0-9A-Za-z_\-\*]+' + minLength: 1 + maxLength: 16 + CidrRoutingConfig: + type: object + required: + - CollectionId + - LocationName + properties: + CollectionId: + allOf: + - $ref: '#/components/schemas/UUID' + - description: The CIDR collection ID. + LocationName: + allOf: + - $ref: '#/components/schemas/CidrLocationNameDefaultAllowed' + - description: The CIDR collection location name. + description:

The object that is specified in resource record set object when you are linking a resource record set to a CIDR location.

A LocationName with an asterisk “*” can be used to create a default CIDR record. CollectionId is still required for default record.

+ DNSName: + type: string + maxLength: 1024 + GeoLocation: + type: object + properties: + ContinentCode: + allOf: + - $ref: '#/components/schemas/GeoLocationContinentCode' + - description: >- +

The two-letter code for the continent.

Amazon Route 53 supports the following continent codes:

  • AF: Africa

  • AN: Antarctica

  • AS: Asia

  • EU: Europe

  • OC: Oceania

  • NA: North America

  • SA: South America

Constraint: Specifying ContinentCode with either + CountryCode or SubdivisionCode returns an InvalidInput error.

+ CountryCode: + allOf: + - $ref: '#/components/schemas/GeoLocationCountryCode' + - description:

For geolocation resource record sets, the two-letter code for a country.

Amazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1 alpha-2.

+ SubdivisionCode: + allOf: + - $ref: '#/components/schemas/GeoLocationSubdivisionCode' + - description: >- +

For geolocation resource record sets, the two-letter code for a state of the United States. Route 53 doesn't support any other values for SubdivisionCode. For a list of state abbreviations, see Appendix B: Two–Letter State and Possession Abbreviations on the United States Postal Service website.

If you specify subdivisioncode, you must also specify US for + CountryCode.

+ description: A complex type that contains information about a geographic location. + GeoLocationContinentCode: + type: string + minLength: 2 + maxLength: 2 + GeoLocationCountryCode: + type: string + minLength: 1 + maxLength: 2 + GeoLocationSubdivisionCode: + type: string + minLength: 1 + maxLength: 3 + HealthCheckId: + type: string + maxLength: 64 + InvalidChangeBatch: {} + InvalidInput: {} + ListResourceRecordSetsResponse: + type: object + required: + - ResourceRecordSets + - IsTruncated + - MaxItems + properties: + ResourceRecordSets: + allOf: + - $ref: '#/components/schemas/ResourceRecordSets' + - description: Information about multiple resource record sets. + IsTruncated: + allOf: + - $ref: '#/components/schemas/PageTruncated' + - description: A flag that indicates whether more resource record sets remain to be listed. If your results were truncated, you can make a follow-up pagination request by using the NextRecordName element. + NextRecordName: + allOf: + - $ref: '#/components/schemas/DNSName' + - description:

If the results were truncated, the name of the next record in the list.

This element is present only if IsTruncated is true.

+ NextRecordType: + allOf: + - $ref: '#/components/schemas/RRType' + - description:

If the results were truncated, the type of the next record in the list.

This element is present only if IsTruncated is true.

+ NextRecordIdentifier: + allOf: + - $ref: '#/components/schemas/ResourceRecordSetIdentifier' + - description:

Resource record sets that have a routing policy other than simple: If results were truncated for a given DNS name and type, the value of SetIdentifier for the next resource record set that has the current DNS name and type.

For information about routing policies, see Choosing a Routing Policy in the Amazon Route 53 Developer Guide.

+ MaxItems: + allOf: + - $ref: '#/components/schemas/PageMaxItems' + - description: The maximum number of records you requested. + description: A complex type that contains list information for the resource record set. + NoSuchHealthCheck: {} + NoSuchHostedZone: {} + PageMaxItems: + type: string + PageTruncated: + type: boolean + PriorRequestNotComplete: {} + RData: + type: string + maxLength: 4000 + RRType: + type: string + enum: + - SOA + - A + - TXT + - NS + - CNAME + - MX + - NAPTR + - PTR + - SRV + - SPF + - AAAA + - CAA + - DS + ResourceDescription: + type: string + maxLength: 256 + ResourceId: + type: string + maxLength: 32 + ResourceRecord: + type: object + required: + - Value + properties: + Value: + allOf: + - $ref: '#/components/schemas/RData' + - description: >- +

The current or new DNS record value, not to exceed 4,000 characters. In the case of a DELETE action, if the current value does not match the actual value, an error is returned. For descriptions about how to format Value for different record types, see Supported DNS Resource Record Types in the Amazon Route 53 Developer Guide.

You can specify + more than one value for all record types except CNAME and SOA.

If you're creating an alias resource record set, omit Value.

 + description:

Information specific to the resource record.

If you're creating an alias resource record set, omit ResourceRecord.

 + ResourceRecordSet: + type: object + required: + - Name + - Type + properties: + Name: + allOf: + - $ref: '#/components/schemas/DNSName' + - description: >- +

For ChangeResourceRecordSets requests, the name of the record that you want to create, update, or delete. For ListResourceRecordSets responses, the name of a record in the specified hosted zone.

ChangeResourceRecordSets Only

Enter a fully qualified domain name, for example, www.example.com. You can optionally include a trailing dot. If you omit the trailing dot, Amazon Route 53 assumes that the domain name that you + specify is fully qualified. This means that Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.

For information about how to specify characters other than a-z, 0-9, and - (hyphen) and how to specify internationalized domain names, see DNS Domain Name + Format in the Amazon Route 53 Developer Guide.

You can use the asterisk (*) wildcard to replace the leftmost label in a domain name, for example, *.example.com. Note the following:

  • The * must replace the entire label. For example, you can't specify *prod.example.com or prod*.example.com.

  • The * can't replace any of the middle labels, for example, marketing.*.example.com.

  • +

    If you include * in any position other than the leftmost label in a domain name, DNS treats it as an * character (ASCII 42), not as a wildcard.

    You can't use the * wildcard for resource records sets that have a type of NS.

You can use the * wildcard as the leftmost label in a domain name, for example, *.example.com. You can't use an * for one of the middle labels, for example, marketing.*.example.com. + In addition, the * must replace the entire label; for example, you can't specify prod*.example.com.

+ Type: + allOf: + - $ref: '#/components/schemas/RRType' + - description: >- +

The DNS record type. For information about different record types and how data is encoded for them, see Supported DNS Resource Record Types in the Amazon Route 53 Developer Guide.

Valid values for basic resource record sets: A | AAAA | CAA | CNAME | DS |MX | NAPTR | + NS | PTR | SOA | SPF | SRV | TXT

Values for weighted, latency, geolocation, and failover resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | PTR | SPF | SRV | TXT. When creating a group of weighted, latency, geolocation, or failover resource record sets, + specify the same value for all of the resource record sets in the group.

Valid values for multivalue answer resource record sets: A | AAAA | MX | NAPTR | PTR | SPF | SRV | TXT

SPF records were formerly used to verify the identity of the sender of email messages. However, we no longer recommend that you create resource record sets for which the value of + Type is SPF. RFC 7208, Sender Policy Framework (SPF) for Authorizing Use of Domains in Email, Version 1, has been updated to say, "...[I]ts existence and mechanism defined in [RFC4408] have led to some interoperability issues. Accordingly, its use is no longer appropriate for SPF version 1; implementations are not to use it." In RFC 7208, see section 14.1, The SPF DNS Record Type.

+

Values for alias resource record sets:

  • Amazon API Gateway custom regional APIs and edge-optimized APIs: A

  • CloudFront distributions: A

    If IPv6 is enabled for the distribution, create two resource record sets to route traffic to your distribution, one with a value of A and one with a value of AAAA.

  • Amazon API Gateway environment that has + a regionalized subdomain: A

  • ELB load balancers: A | AAAA

  • Amazon S3 buckets: A

  • Amazon Virtual Private Cloud interface VPC endpoints A

  • Another resource record set in this hosted zone: Specify the type of the resource record set that you're creating the alias for. All values are supported except + NS and SOA.

    If you're creating an alias record that has the same name as the hosted zone (known as the zone apex), you can't route traffic to a record for which the value of Type is CNAME. This is because the alias record must have the same type as the record you're routing traffic to, and creating a CNAME record for the zone apex isn't supported even for an alias record.
+ SetIdentifier: + allOf: + - $ref: '#/components/schemas/ResourceRecordSetIdentifier' + - description: >- +

Resource record sets that have a routing policy other than simple: An identifier that differentiates among multiple resource record sets that have the same combination of name and type, such as multiple weighted resource record sets named acme.example.com that have a type of A. In a group of resource record sets that have the same name and type, the value of SetIdentifier must be unique for each resource record set.

For information about routing + policies, see Choosing a Routing Policy in the Amazon Route 53 Developer Guide.

+ Weight: + allOf: + - $ref: '#/components/schemas/ResourceRecordSetWeight' + - description: >- +

Weighted resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that determines the proportion of DNS queries that Amazon Route 53 responds to using the current resource record set. Route 53 calculates the sum of the weights for the resource record sets that have the same combination of DNS name and type. Route 53 then responds to queries based on the ratio of a resource's weight to the total. Note the + following:

  • You must specify a value for the Weight element for every weighted resource record set.

  • You can only specify one ResourceRecord per weighted resource record set.

  • You can't create latency, failover, or geolocation resource record sets that have the same values for the Name and Type elements as weighted resource record sets.

  • You can create a maximum + of 100 weighted resource record sets that have the same values for the Name and Type elements.

  • For weighted (but not weighted alias) resource record sets, if you set Weight to 0 for a resource record set, Route 53 never responds to queries with the applicable value for that resource record set. However, if you set Weight to 0 for all resource record sets that have the same combination + of DNS name and type, traffic is routed to all resources with equal probability.

    The effect of setting Weight to 0 is different when you associate health checks with weighted resource record sets. For more information, see Options for Configuring Route 53 Active-Active and Active-Passive Failover in the Amazon Route 53 Developer + Guide.

+ Region: + allOf: + - $ref: '#/components/schemas/ResourceRecordSetRegion' + - description: >- +

Latency-based resource record sets only: The Amazon EC2 Region where you created the resource that this resource record set refers to. The resource typically is an Amazon Web Services resource, such as an EC2 instance or an ELB load balancer, and is referred to by an IP address or a DNS domain name, depending on the record type.

When Amazon Route 53 receives a DNS query for a domain name and type for which you have created latency resource record sets, Route 53 + selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 Region. Route 53 then returns the value that is associated with the selected resource record set.

Note the following:

  • You can only specify one ResourceRecord per latency resource record set.

  • You can only create one latency resource record set for each Amazon EC2 Region.

  • You aren't required + to create latency resource record sets for all Amazon EC2 Regions. Route 53 will choose the region with the best latency from among the regions that you create latency resource record sets for.

  • You can't create non-latency resource record sets that have the same values for the Name and Type elements as latency resource record sets.

+ GeoLocation: + allOf: + - $ref: '#/components/schemas/GeoLocation' + - description: >- +

Geolocation resource record sets only: A complex type that lets you control how Amazon Route 53 responds to DNS queries based on the geographic origin of the query. For example, if you want all queries from Africa to be routed to a web server with an IP address of 192.0.2.111, create a resource record set with a Type of A and a ContinentCode of AF.

Although creating geolocation and + geolocation alias resource record sets in a private hosted zone is allowed, it's not supported.

If you create separate resource record sets for overlapping geographic regions (for example, one resource record set for a continent and one for a country on the same continent), priority goes to the smallest geographic region. This allows you to route most queries for a continent to one resource and to route queries for a country on that continent to a different + resource.

You can't create two geolocation resource record sets that specify the same geographic location.

The value * in the CountryCode element matches all geographic locations that aren't specified in other geolocation resource record sets that have the same values for the Name and Type elements.

Geolocation works by mapping IP addresses to locations. However, some IP addresses aren't mapped + to geographic locations, so even if you create geolocation resource record sets that cover all seven continents, Route 53 will receive some DNS queries from locations that it can't identify. We recommend that you create a resource record set for which the value of CountryCode is *. Two groups of queries are routed to the resource that you specify in this record: queries that come from locations for which you haven't created geolocation resource record + sets and queries from IP addresses that aren't mapped to a location. If you don't create a * resource record set, Route 53 returns a "no answer" response for queries from those locations.

You can't create non-geolocation resource record sets that have the same values for the Name and Type elements as geolocation resource record sets.

+ Failover: + allOf: + - $ref: '#/components/schemas/ResourceRecordSetFailover' + - description: >- +

Failover resource record sets only: To configure failover, you add the Failover element to two resource record sets. For one resource record set, you specify PRIMARY as the value for Failover; for the other resource record set, you specify SECONDARY. In addition, you include the HealthCheckId element and specify the health check that you want Amazon Route 53 to perform for each resource record set.

+

Except where noted, the following failover behaviors assume that you have included the HealthCheckId element in both resource record sets:

  • When the primary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the secondary resource record set.

  • When the primary resource record set is unhealthy and the secondary resource record + set is healthy, Route 53 responds to DNS queries with the applicable value from the secondary resource record set.

  • When the secondary resource record set is unhealthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the primary resource record set.

  • If you omit the HealthCheckId element for the secondary resource record set, and if the primary resource + record set is unhealthy, Route 53 always responds to DNS queries with the applicable value from the secondary resource record set. This is true regardless of the health of the associated endpoint.

You can't create non-failover resource record sets that have the same values for the Name and Type elements as failover resource record sets.

For failover alias resource record sets, you must also include the + EvaluateTargetHealth element and set the value to true.

For more information about configuring failover for Route 53, see the following topics in the Amazon Route 53 Developer Guide:

+ MultiValueAnswer: + allOf: + - $ref: '#/components/schemas/ResourceRecordSetMultiValueAnswer' + - description: >- +

Multivalue answer resource record sets only: To route traffic approximately randomly to multiple resources, such as web servers, create one multivalue answer record for each resource and specify true for MultiValueAnswer. Note the following:

  • If you associate a health check with a multivalue answer resource record set, Amazon Route 53 responds to DNS queries with the corresponding IP address only when the health check is + healthy.

  • If you don't associate a health check with a multivalue answer record, Route 53 always considers the record to be healthy.

  • Route 53 responds to DNS queries with up to eight healthy records; if you have eight or fewer healthy records, Route 53 responds to all DNS queries with all the healthy records.

  • If you have more than eight healthy records, Route 53 responds to different DNS resolvers with different combinations of + healthy records.

  • When all records are unhealthy, Route 53 responds to DNS queries with up to eight unhealthy records.

  • If a resource becomes unavailable after a resolver caches a response, client software typically tries another of the IP addresses in the response.

You can't create multivalue answer alias records.

+ TTL: + allOf: + - $ref: '#/components/schemas/TTL' + - description: >- +

The resource record cache time to live (TTL), in seconds. Note the following:

  • If you're creating or updating an alias resource record set, omit TTL. Amazon Route 53 uses the value of TTL for the alias target.

  • If you're associating this resource record set with a health check (if you're adding a HealthCheckId element), we recommend that you specify a TTL of 60 seconds or less so clients + respond quickly to changes in health status.

  • All of the resource record sets in a group of weighted resource record sets must have the same value for TTL.

  • If a group of weighted resource record sets includes one or more weighted alias resource record sets for which the alias target is an ELB load balancer, we recommend that you specify a TTL of 60 seconds for all of the non-alias weighted resource record sets that have + the same name and type. Values other than 60 seconds (the TTL for load balancers) will change the effect of the values that you specify for Weight.

+ ResourceRecords: + allOf: + - $ref: '#/components/schemas/ResourceRecords' + - description:

Information about the resource records to act upon.

If you're creating an alias resource record set, omit ResourceRecords.

 + AliasTarget: + allOf: + - $ref: '#/components/schemas/AliasTarget' + - description: >- +

Alias resource record sets only: Information about the Amazon Web Services resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to.

If you're creating resource records sets for a private hosted zone, note the following:

  • You can't create an alias resource record set in a private hosted zone to route traffic to a CloudFront distribution.

  • For information about creating failover + resource record sets in a private hosted zone, see Configuring Failover in a Private Hosted Zone in the Amazon Route 53 Developer Guide.

+ HealthCheckId: + allOf: + - $ref: '#/components/schemas/HealthCheckId' + - description: >- +

If you want Amazon Route 53 to return this resource record set in response to a DNS query only when the status of a health check is healthy, include the HealthCheckId element and specify the ID of the applicable health check.

Route 53 determines whether a resource record set is healthy based on one of the following:

  • By periodically sending a request to the endpoint that is specified in the health check

  • By aggregating the + status of a specified group of health checks (calculated health checks)

  • By determining the current state of a CloudWatch alarm (CloudWatch metric health checks)

Route 53 doesn't check the health of the endpoint that is specified in the resource record set, for example, the endpoint specified by the IP address in the Value element. When you add a HealthCheckId element to a resource record set, Route 53 + checks the health of the endpoint that you specified in the health check.

For more information, see the following topics in the Amazon Route 53 Developer Guide:

When to Specify HealthCheckId

Specifying a value for HealthCheckId is useful only when Route 53 is choosing between two or more + resource record sets to respond to a DNS query, and you want Route 53 to base the choice in part on the status of a health check. Configuring health checks makes sense only in the following configurations:

  • Non-alias resource record sets: You're checking the health of a group of non-alias resource record sets that have the same routing policy, name, and type (such as multiple weighted records named www.example.com with a type of A) and you specify health + check IDs for all the resource record sets.

    If the health check status for a resource record set is healthy, Route 53 includes the record among the records that it responds to DNS queries with.

    If the health check status for a resource record set is unhealthy, Route 53 stops responding to DNS queries using the value for that resource record set.

    If the health check status for all resource record sets in the group is unhealthy, Route 53 considers all resource + record sets in the group healthy and responds to DNS queries accordingly.

  • Alias resource record sets: You specify the following settings:

    • You set EvaluateTargetHealth to true for an alias resource record set in a group of resource record sets that have the same routing policy, name, and type (such as multiple weighted records named www.example.com with a type of A).

    • You configure the alias resource record + set to route traffic to a non-alias resource record set in the same hosted zone.

    • You specify a health check ID for the non-alias resource record set.

    If the health check status is healthy, Route 53 considers the alias resource record set to be healthy and includes the alias record among the records that it responds to DNS queries with.

    If the health check status is unhealthy, Route 53 stops responding to DNS queries using the alias + resource record set.

    The alias resource record set can also route traffic to a group of non-alias resource record sets that have the same routing policy, name, and type. In that configuration, associate health checks with all of the resource record sets in the group of non-alias resource record sets.

Geolocation Routing

For geolocation resource record sets, if an endpoint is unhealthy, Route 53 looks for a resource + record set for the larger, associated geographic region. For example, suppose you have resource record sets for a state in the United States, for the entire United States, for North America, and a resource record set that has * for CountryCode is *, which applies to all locations. If the endpoint for the state resource record set is unhealthy, Route 53 checks for healthy resource record sets in the following order until it finds a resource + record set for which the endpoint is healthy:

  • The United States

  • North America

  • The default resource record set

Specifying the Health Check Endpoint by Domain Name

If your health checks specify the endpoint only by domain name, we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for + www.example.com. For the value of FullyQualifiedDomainName, specify the domain name of the server (such as us-east-2-www.example.com), not the name of the resource record sets (www.example.com).

Health check results will be unpredictable if you do the following:

  • Create a health check that has the same value for FullyQualifiedDomainName as the name of a resource record set.

    +

  • Associate that health check with the resource record set.

 + TrafficPolicyInstanceId: + allOf: + - $ref: '#/components/schemas/TrafficPolicyInstanceId' + - description: >- +

When you create a traffic policy instance, Amazon Route 53 automatically creates a resource record set. TrafficPolicyInstanceId is the ID of the traffic policy instance that Route 53 created this resource record set for.

To delete the resource record set that is associated with a traffic policy instance, use DeleteTrafficPolicyInstance. Route 53 will delete the resource record set automatically. If you delete the resource record set + by using ChangeResourceRecordSets, Route 53 doesn't automatically delete the traffic policy instance, and you'll continue to be charged for it even though it's no longer in use.

+ CidrRoutingConfig: + $ref: '#/components/schemas/CidrRoutingConfig' + description: Information about the resource record set to create or delete. + ResourceRecordSetFailover: + type: string + enum: + - PRIMARY + - SECONDARY + ResourceRecordSetIdentifier: + type: string + minLength: 1 + maxLength: 128 + ResourceRecordSetMultiValueAnswer: + type: boolean + ResourceRecordSetRegion: + type: string + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - ca-central-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-central-2 + - ap-southeast-1 + - ap-southeast-2 + - ap-southeast-3 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - eu-north-1 + - sa-east-1 + - cn-north-1 + - cn-northwest-1 + - ap-east-1 + - me-south-1 + - me-central-1 + - ap-south-1 + - ap-south-2 + - af-south-1 + - eu-south-1 + - eu-south-2 + - ap-southeast-4 + - il-central-1 + minLength: 1 + maxLength: 64 + ResourceRecordSetWeight: + type: integer + minimum: 0 + maximum: 255 + ResourceRecordSets: + type: array + items: + allOf: + - $ref: '#/components/schemas/ResourceRecordSet' + - xml: + name: ResourceRecordSet + ResourceRecords: + type: array + items: + allOf: + - $ref: '#/components/schemas/ResourceRecord' + - xml: + name: ResourceRecord + minItems: 1 + TTL: + type: integer + minimum: 0 + maximum: 2147483647 + TimeStamp: + type: string + format: date-time + TrafficPolicyInstanceId: + type: string + minLength: 1 + maxLength: 36 + UUID: + type: string + pattern: '[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}' Location: type: object additionalProperties: false @@ -696,6 +1166,9 @@ components: CloudWatchLogsLogGroupArn: description: The Amazon Resource Name (ARN) of the CloudWatch Logs log group that Amazon Route 53 is publishing logs to. type: string + x-relationshipRef: + typeName: AWS::Logs::LogGroup + propertyPath: /properties/Arn required: - CloudWatchLogsLogGroupArn VPC: @@ -710,6 +1183,9 @@ components: *Private hosted zones only:* The ID of an Amazon VPC. For public hosted zones, omit ``VPCs``, ``VPCId``, and ``VPCRegion``. type: string + x-relationshipRef: + typeName: AWS::EC2::VPC + propertyPath: /properties/VpcId VPCRegion: description: |- *Private hosted zones only:* The region that an Amazon VPC was created in. @@ -754,7 +1230,7 @@ components: + DNS record type, such as A or AAAA + DNS response code, such as ``NoError`` or ``ServFail`` - + Log Group and Resource Policy Before you create a query logging configuration, perform the following operations. If you create a query logging configuration using the Route 53 console, Route 53 performs these operations automatically. Create a CloudWatch Logs log group, and make note of the ARN, which you specify when you create a query logging configuration. Note the following: You must create the log group in the us-east-1 region. You must use the same to create the log group and the hosted zone that you want to configure query logging for. When you create log groups for query logging, we recommend that you use a consistent prefix, for example: /aws/route53/hosted zone name In the next step, you'll create a resource policy, which controls access to one or more log groups and the associated resources, such as Route 53 hosted zones. There's a limit on the number of resource policies that you can create, so we recommend that you use a consistent prefix so you can use the same resource policy for all the log groups that you create for query logging. Create a CloudWatch Logs resource policy, and give it the permissions that Route 53 needs to create log streams and to send query logs to log streams. For the value of Resource, specify the ARN for the log group that you created in the previous step. To use the same resource policy for all the CloudWatch Logs log groups that you created for query logging configurations, replace the hosted zone name with *, for example: arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/* To avoid the confused deputy problem, a security issue where an entity without a permission for an action can coerce a more-privileged entity to perform it, you can optionally limit the permissions that a service has to a resource in a resource-based policy by supplying the following values: For aws:SourceArn, supply the hosted zone ARN used in creating the query logging configuration. For example, aws:SourceArn: arn:aws:route53:::hostedzone/hosted zone ID. For aws:SourceAccount, supply the account ID for the account that creates the query logging configuration. For example, aws:SourceAccount:111111111111. For more information, see The confused deputy problem in the IAM User Guide. You can't use the CloudWatch console to create or edit a resource policy. You must use the CloudWatch API, one of the SDKs, or the . + Log Streams and Edge Locations When Route 53 finishes creating the configuration for DNS query logging, it does the following: Creates a log stream for an edge location the first time that the edge location responds to DNS queries for the specified hosted zone. That log stream is used to log all queries that Route 53 responds to for that edge location. Begins to send query logs to the applicable log stream. The name of each log stream is in the following format: hosted zone ID/edge location code The edge location code is a three-letter code and an arbitrarily assigned number, for example, DFW3. The three-letter code typically corresponds with the International Air Transport Association airport code for an airport near the edge location. (These abbreviations might change in the future.) For a list of edge locations, see "The Route 53 Global Network" on the Route 53 Product Details page. + Queries That Are Logged Query logs contain only the queries that DNS resolvers forward to Route 53. If a DNS resolver has already cached the response to a query (such as the IP address for a load balancer for example.com), the resolver will continue to return the cached response. It doesn't forward another query to Route 53 until the TTL for the corresponding resource record set expires. Depending on how many DNS queries are submitted for a resource record set, and depending on the TTL for that resource record set, query logs might contain information about only one query out of every several thousand queries that are submitted to DNS. For more information about how DNS works, see Routing Internet Traffic to Your Website or Web Application in the Amazon Route 53 Developer Guide. + Log File Format For a list of the values in each query log and the format of each value, see Logging DNS Queries in the Amazon Route 53 Developer Guide. + Pricing For information about charges for query logs, see Amazon CloudWatch Pricing. + How to Stop Logging If you want Route 53 to stop sending query logs to CloudWatch Logs, delete the query logging configuration. For more information, see DeleteQueryLoggingConfig. + + Log Group and Resource Policy Before you create a query logging configuration, perform the following operations. If you create a query logging configuration using the Route 53 console, Route 53 performs these operations automatically. Create a CloudWatch Logs log group, and make note of the ARN, which you specify when you create a query logging configuration. Note the following: You must create the log group in the us-east-1 region. You must use the same to create the log group and the hosted zone that you want to configure query logging for. When you create log groups for query logging, we recommend that you use a consistent prefix, for example: /aws/route53/hosted zone name In the next step, you'll create a resource policy, which controls access to one or more log groups and the associated resources, such as Route 53 hosted zones. There's a limit on the number of resource policies that you can create, so we recommend that you use a consistent prefix so you can use the same resource policy for all the log groups that you create for query logging. Create a CloudWatch Logs resource policy, and give it the permissions that Route 53 needs to create log streams and to send query logs to log streams. You must create the CloudWatch Logs resource policy in the us-east-1 region. For the value of Resource, specify the ARN for the log group that you created in the previous step. To use the same resource policy for all the CloudWatch Logs log groups that you created for query logging configurations, replace the hosted zone name with *, for example: arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/* To avoid the confused deputy problem, a security issue where an entity without a permission for an action can coerce a more-privileged entity to perform it, you can optionally limit the permissions that a service has to a resource in a resource-based policy by supplying the following values: For aws:SourceArn, supply the hosted zone ARN used in creating the query logging configuration. For example, aws:SourceArn: arn:aws:route53:::hostedzone/hosted zone ID. For aws:SourceAccount, supply the account ID for the account that creates the query logging configuration. For example, aws:SourceAccount:111111111111. For more information, see The confused deputy problem in the IAM User Guide. You can't use the CloudWatch console to create or edit a resource policy. You must use the CloudWatch API, one of the SDKs, or the . + Log Streams and Edge Locations When Route 53 finishes creating the configuration for DNS query logging, it does the following: Creates a log stream for an edge location the first time that the edge location responds to DNS queries for the specified hosted zone. That log stream is used to log all queries that Route 53 responds to for that edge location. Begins to send query logs to the applicable log stream. The name of each log stream is in the following format: hosted zone ID/edge location code The edge location code is a three-letter code and an arbitrarily assigned number, for example, DFW3. The three-letter code typically corresponds with the International Air Transport Association airport code for an airport near the edge location. (These abbreviations might change in the future.) For a list of edge locations, see "The Route 53 Global Network" on the Route 53 Product Details page. + Queries That Are Logged Query logs contain only the queries that DNS resolvers forward to Route 53. If a DNS resolver has already cached the response to a query (such as the IP address for a load balancer for example.com), the resolver will continue to return the cached response. It doesn't forward another query to Route 53 until the TTL for the corresponding resource record set expires. Depending on how many DNS queries are submitted for a resource record set, and depending on the TTL for that resource record set, query logs might contain information about only one query out of every several thousand queries that are submitted to DNS. For more information about how DNS works, see Routing Internet Traffic to Your Website or Web Application in the Amazon Route 53 Developer Guide. + Log File Format For a list of the values in each query log and the format of each value, see Logging DNS Queries in the Amazon Route 53 Developer Guide. + Pricing For information about charges for query logs, see Amazon CloudWatch Pricing. + How to Stop Logging If you want Route 53 to stop sending query logs to CloudWatch Logs, delete the query logging configuration. For more information, see DeleteQueryLoggingConfig. VPCs: description: |- *Private hosted zones:* A complex type that contains information about the VPCs that are associated with the specified hosted zone. @@ -1107,7 +1583,7 @@ components: + DNS record type, such as A or AAAA + DNS response code, such as ``NoError`` or ``ServFail`` - + Log Group and Resource Policy Before you create a query logging configuration, perform the following operations. If you create a query logging configuration using the Route 53 console, Route 53 performs these operations automatically. Create a CloudWatch Logs log group, and make note of the ARN, which you specify when you create a query logging configuration. Note the following: You must create the log group in the us-east-1 region. You must use the same to create the log group and the hosted zone that you want to configure query logging for. When you create log groups for query logging, we recommend that you use a consistent prefix, for example: /aws/route53/hosted zone name In the next step, you'll create a resource policy, which controls access to one or more log groups and the associated resources, such as Route 53 hosted zones. There's a limit on the number of resource policies that you can create, so we recommend that you use a consistent prefix so you can use the same resource policy for all the log groups that you create for query logging. Create a CloudWatch Logs resource policy, and give it the permissions that Route 53 needs to create log streams and to send query logs to log streams. For the value of Resource, specify the ARN for the log group that you created in the previous step. To use the same resource policy for all the CloudWatch Logs log groups that you created for query logging configurations, replace the hosted zone name with *, for example: arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/* To avoid the confused deputy problem, a security issue where an entity without a permission for an action can coerce a more-privileged entity to perform it, you can optionally limit the permissions that a service has to a resource in a resource-based policy by supplying the following values: For aws:SourceArn, supply the hosted zone ARN used in creating the query logging configuration. For example, aws:SourceArn: arn:aws:route53:::hostedzone/hosted zone ID. For aws:SourceAccount, supply the account ID for the account that creates the query logging configuration. For example, aws:SourceAccount:111111111111. For more information, see The confused deputy problem in the IAM User Guide. You can't use the CloudWatch console to create or edit a resource policy. You must use the CloudWatch API, one of the SDKs, or the . + Log Streams and Edge Locations When Route 53 finishes creating the configuration for DNS query logging, it does the following: Creates a log stream for an edge location the first time that the edge location responds to DNS queries for the specified hosted zone. That log stream is used to log all queries that Route 53 responds to for that edge location. Begins to send query logs to the applicable log stream. The name of each log stream is in the following format: hosted zone ID/edge location code The edge location code is a three-letter code and an arbitrarily assigned number, for example, DFW3. The three-letter code typically corresponds with the International Air Transport Association airport code for an airport near the edge location. (These abbreviations might change in the future.) For a list of edge locations, see "The Route 53 Global Network" on the Route 53 Product Details page. + Queries That Are Logged Query logs contain only the queries that DNS resolvers forward to Route 53. If a DNS resolver has already cached the response to a query (such as the IP address for a load balancer for example.com), the resolver will continue to return the cached response. It doesn't forward another query to Route 53 until the TTL for the corresponding resource record set expires. Depending on how many DNS queries are submitted for a resource record set, and depending on the TTL for that resource record set, query logs might contain information about only one query out of every several thousand queries that are submitted to DNS. For more information about how DNS works, see Routing Internet Traffic to Your Website or Web Application in the Amazon Route 53 Developer Guide. + Log File Format For a list of the values in each query log and the format of each value, see Logging DNS Queries in the Amazon Route 53 Developer Guide. + Pricing For information about charges for query logs, see Amazon CloudWatch Pricing. + How to Stop Logging If you want Route 53 to stop sending query logs to CloudWatch Logs, delete the query logging configuration. For more information, see DeleteQueryLoggingConfig. + + Log Group and Resource Policy Before you create a query logging configuration, perform the following operations. If you create a query logging configuration using the Route 53 console, Route 53 performs these operations automatically. Create a CloudWatch Logs log group, and make note of the ARN, which you specify when you create a query logging configuration. Note the following: You must create the log group in the us-east-1 region. You must use the same to create the log group and the hosted zone that you want to configure query logging for. When you create log groups for query logging, we recommend that you use a consistent prefix, for example: /aws/route53/hosted zone name In the next step, you'll create a resource policy, which controls access to one or more log groups and the associated resources, such as Route 53 hosted zones. There's a limit on the number of resource policies that you can create, so we recommend that you use a consistent prefix so you can use the same resource policy for all the log groups that you create for query logging. Create a CloudWatch Logs resource policy, and give it the permissions that Route 53 needs to create log streams and to send query logs to log streams. You must create the CloudWatch Logs resource policy in the us-east-1 region. For the value of Resource, specify the ARN for the log group that you created in the previous step. To use the same resource policy for all the CloudWatch Logs log groups that you created for query logging configurations, replace the hosted zone name with *, for example: arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/* To avoid the confused deputy problem, a security issue where an entity without a permission for an action can coerce a more-privileged entity to perform it, you can optionally limit the permissions that a service has to a resource in a resource-based policy by supplying the following values: For aws:SourceArn, supply the hosted zone ARN used in creating the query logging configuration. For example, aws:SourceArn: arn:aws:route53:::hostedzone/hosted zone ID. For aws:SourceAccount, supply the account ID for the account that creates the query logging configuration. For example, aws:SourceAccount:111111111111. For more information, see The confused deputy problem in the IAM User Guide. You can't use the CloudWatch console to create or edit a resource policy. You must use the CloudWatch API, one of the SDKs, or the . + Log Streams and Edge Locations When Route 53 finishes creating the configuration for DNS query logging, it does the following: Creates a log stream for an edge location the first time that the edge location responds to DNS queries for the specified hosted zone. That log stream is used to log all queries that Route 53 responds to for that edge location. Begins to send query logs to the applicable log stream. The name of each log stream is in the following format: hosted zone ID/edge location code The edge location code is a three-letter code and an arbitrarily assigned number, for example, DFW3. The three-letter code typically corresponds with the International Air Transport Association airport code for an airport near the edge location. (These abbreviations might change in the future.) For a list of edge locations, see "The Route 53 Global Network" on the Route 53 Product Details page. + Queries That Are Logged Query logs contain only the queries that DNS resolvers forward to Route 53. If a DNS resolver has already cached the response to a query (such as the IP address for a load balancer for example.com), the resolver will continue to return the cached response. It doesn't forward another query to Route 53 until the TTL for the corresponding resource record set expires. Depending on how many DNS queries are submitted for a resource record set, and depending on the TTL for that resource record set, query logs might contain information about only one query out of every several thousand queries that are submitted to DNS. For more information about how DNS works, see Routing Internet Traffic to Your Website or Web Application in the Amazon Route 53 Developer Guide. + Log File Format For a list of the values in each query log and the format of each value, see Logging DNS Queries in the Amazon Route 53 Developer Guide. + Pricing For information about charges for query logs, see Amazon CloudWatch Pricing. + How to Stop Logging If you want Route 53 to stop sending query logs to CloudWatch Logs, delete the query logging configuration. For more information, see DeleteQueryLoggingConfig. VPCs: description: |- *Private hosted zones:* A complex type that contains information about the VPCs that are associated with the specified hosted zone. @@ -1163,76 +1639,6 @@ components: x-title: CreateKeySigningKeyRequest type: object required: [] - resource_record_sets: - description: Resource Record Sets in a Hosted Zone - type: object - additionalProperties: false - properties: - Id: - type: string - description: The ID of the Hosted Zone - alias_target: - type: object - description: 'Alias resource record sets only: Information about the Amazon Web Services resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to.' - cidr_routing_config: - type: object - description: The object that is specified in resource record set object when you are linking a resource record set to a CIDR location. - failover: - type: string - description: >- - Failover resource record sets only: To configure failover, you add the Failover element to two resource record sets. For one resource record set, you specify PRIMARY as the value for Failover; for the other resource record set, you specify SECONDARY. In addition, you include the HealthCheckId element and specify the health check that you want Amazon Route 53 to perform for each resource record set. Except where noted, the following failover behaviors assume that you have included the - HealthCheckId element in both resource record sets: When the primary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the secondary resource record set. When the primary resource record set is unhealthy and the secondary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the secondary resource record set. When the secondary resource - record set is unhealthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the primary resource record set. If you omit the HealthCheckId element for the secondary resource record set, and if the primary resource record set is unhealthy, Route 53 always responds to DNS queries with the applicable value from the secondary resource record set. This is true regardless of the health of the associated endpoint. You - can't create non-failover resource record sets that have the same values for the Name and Type elements as failover resource record sets. For failover alias resource record sets, you must also include the EvaluateTargetHealth element and set the value to true. For more information about configuring failover for Route 53, see the following topics in the Amazon Route 53 Developer Guide: Route 53 Health Checks and DNS Failover Configuring Failover in a Private Hosted Zone - geo_location: - type: object - description: A complex type that contains information about a geographic location. - health_check_id: - type: string - description: >- - If you want Amazon Route 53 to return this resource record set in response to a DNS query only when the status of a health check is healthy, include the HealthCheckId element and specify the ID of the applicable health check. Route 53 determines whether a resource record set is healthy based on one of the following: By periodically sending a request to the endpoint that is specified in the health check By aggregating the status of a specified group of health checks (calculated health - checks) By determining the current state of a CloudWatch alarm (CloudWatch metric health checks) Route 53 doesn't check the health of the endpoint that is specified in the resource record set, for example, the endpoint specified by the IP address in the Value element. When you add a HealthCheckId element to a resource record set, Route 53 checks the health of the endpoint that you specified in the health check. For more information, see the following topics in the Amazon Route 53 - Developer Guide: How Amazon Route 53 Determines Whether an Endpoint Is Healthy Route 53 Health Checks and DNS Failover Configuring Failover in a Private Hosted Zone When to Specify HealthCheckId Specifying a value for HealthCheckId is useful only when Route 53 is choosing between two or more resource record sets to respond to a DNS query, and you want Route 53 to base the choice in part on the status of a health check. Configuring health checks makes sense only in the following - configurations: Non-alias resource record sets: You're checking the health of a group of non-alias resource record sets that have the same routing policy, name, and type (such as multiple weighted records named www.example.com with a type of A) and you specify health check IDs for all the resource record sets. If the health check status for a resource record set is healthy, Route 53 includes the record among the records that it responds to DNS queries with. If the health check status - for a resource record set is unhealthy, Route 53 stops responding to DNS queries using the value for that resource record set. If the health check status for all resource record sets in the group is unhealthy, Route 53 considers all resource record sets in the group healthy and responds to DNS queries accordingly. Alias resource record sets: You specify the following settings: You set EvaluateTargetHealth to true for an alias resource record set in a group of resource record sets - that have the same routing policy - multi_value_answer: - type: boolean - description: >- - Multivalue answer resource record sets only: To route traffic approximately randomly to multiple resources, such as web servers, create one multivalue answer record for each resource and specify true for MultiValueAnswer. Note the following: If you associate a health check with a multivalue answer resource record set, Amazon Route 53 responds to DNS queries with the corresponding IP address only when the health check is healthy. If you don't associate a health check with a multivalue - answer record, Route 53 always considers the record to be healthy. Route 53 responds to DNS queries with up to eight healthy records; if you have eight or fewer healthy records, Route 53 responds to all DNS queries with all the healthy records. If you have more than eight healthy records, Route 53 responds to different DNS resolvers with different combinations of healthy records. When all records are unhealthy, Route 53 responds to DNS queries with up to eight unhealthy records. If a - resource becomes unavailable after a resolver caches a response, client software typically tries another of the IP addresses in the response. You can't create multivalue answer alias records. - name: - type: string - description: >- - For ChangeResourceRecordSets requests, the name of the record that you want to create, update, or delete. For ListResourceRecordSets responses, the name of a record in the specified hosted zone. ChangeResourceRecordSets Only Enter a fully qualified domain name, for example, www.example.com. You can optionally include a trailing dot. If you omit the trailing dot, Amazon Route 53 assumes that the domain name that you specify is fully qualified. This means that Route 53 treats - www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical. For information about how to specify characters other than a-z, 0-9, and - (hyphen) and how to specify internationalized domain names, see DNS Domain Name Format in the Amazon Route 53 Developer Guide. You can use the asterisk (*) wildcard to replace the leftmost label in a domain name, for example, *.example.com. Note the following: The * must replace the entire label. For example, you - can't specify *prod.example.com or prod*.example.com. The * can't replace any of the middle labels, for example, marketing.*.example.com. If you include * in any position other than the leftmost label in a domain name, DNS treats it as an * character (ASCII 42), not as a wildcard. You can't use the * wildcard for resource records sets that have a type of NS. - resource_records: - type: array - description: Information about the resource records to act upon. - items: - type: object - set_identifier: - type: string - description: An identifier that differentiates among multiple resource record sets that have the same combination of DNS name and type. The value of SetIdentifier must be unique for each resource record set that has the same combination of DNS name and type. Omit SetIdentifier for any other resource record set that has the same combination of DNS name and type. You can't use SetIdentifier to differentiate among resource record sets that have the same DNS name and type. - ttl: - type: integer - description: >- - The resource record cache time to live (TTL), in seconds. Note the following: If you're creating an alias resource record set, omit TTL. Amazon Route 53 uses the TTL for the alias target. If you're associating this resource record set with a health check (if you're adding a HealthCheckId element), we recommend that you specify a TTL of 60 seconds or less so clients respond quickly to changes in health status. All of the resource record sets in a group of weighted, latency, - geolocation, or failover resource record sets must have the same value for TTL. - traffic_policy_instance_id: - type: string - description: When you create a traffic policy instance, Amazon Route 53 automatically creates a resource record set. TrafficPolicyInstanceId is the ID of the traffic policy instance that Route 53 created this resource record set for. - type: - type: string - description: The DNS record type. For information about different record types and how data is encoded for them, see Supported DNS Resource Record Types in the Amazon Route 53 Developer Guide. - weight: - type: integer - description: >- - If you want to create a weighted resource record set, an alias resource record set, or a latency resource record set and specify weighted routing, specify a value between 0 and 255. You can't specify this value for other types of resource record sets. For weighted resource record sets, Route 53 uses the value to determine how often the response is served from this resource record set compared to other resource record sets in the same group. For example, suppose the following weighted - resource record sets are configured for a domain, and the domain contains a CNAME record: example.com A - x-example-where-clause: WHERE Id = '' securitySchemes: hmac: type: apiKey @@ -1248,7 +1654,7 @@ components: x-cfn-type-name: AWS::Route53::CidrCollection x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1265,9 +1671,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1277,41 +1683,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/cidr_collections/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/cidr_collections/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53::CidrCollection' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53::CidrCollection' - AND region = 'us-east-1' - cidr_collection: - name: cidr_collection - id: aws.route53.cidr_collection - x-cfn-schema-name: CidrCollection - x-cfn-type-name: AWS::Route53::CidrCollection - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1322,12 +1696,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/cidr_collections/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/cidr_collections/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/cidr_collection/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/cidr_collections/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1340,18 +1718,34 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Locations') as locations - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Route53::CidrCollection' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53::CidrCollection' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Locations') as locations + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Route53::CidrCollection' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53::CidrCollection' + AND region = 'us-east-1' dnssecs: name: dnssecs id: aws.route53.dnssecs @@ -1359,7 +1753,7 @@ components: x-cfn-type-name: AWS::Route53::DNSSEC x-identifiers: - HostedZoneId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1393,39 +1787,11 @@ components: - $ref: '#/components/x-stackQL-resources/dnssecs/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/dnssecs/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.HostedZoneId') as hosted_zone_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53::DNSSEC' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'HostedZoneId') as hosted_zone_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53::DNSSEC' - AND region = 'us-east-1' - dnssec: - name: dnssec - id: aws.route53.dnssec - x-cfn-schema-name: DNSSEC - x-cfn-type-name: AWS::Route53::DNSSEC - x-identifiers: - - HostedZoneId - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1435,15 +1801,31 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'HostedZoneId') as hosted_zone_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Route53::DNSSEC' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.HostedZoneId') as hosted_zone_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53::DNSSEC' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'HostedZoneId') as hosted_zone_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Route53::DNSSEC' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'HostedZoneId') as hosted_zone_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53::DNSSEC' + AND region = 'us-east-1' health_checks: name: health_checks id: aws.route53.health_checks @@ -1451,7 +1833,7 @@ components: x-cfn-type-name: AWS::Route53::HealthCheck x-identifiers: - HealthCheckId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1468,9 +1850,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1480,41 +1862,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/health_checks/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/health_checks/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.HealthCheckId') as health_check_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53::HealthCheck' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'HealthCheckId') as health_check_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53::HealthCheck' - AND region = 'us-east-1' - health_check: - name: health_check - id: aws.route53.health_check - x-cfn-schema-name: HealthCheck - x-cfn-type-name: AWS::Route53::HealthCheck - x-identifiers: - - HealthCheckId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1525,12 +1875,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/health_checks/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/health_checks/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/health_check/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/health_checks/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1542,17 +1896,33 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'HealthCheckId') as health_check_id, - json_extract_path_text(Properties, 'HealthCheckConfig') as health_check_config, - json_extract_path_text(Properties, 'HealthCheckTags') as health_check_tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Route53::HealthCheck' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.HealthCheckId') as health_check_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53::HealthCheck' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'HealthCheckId') as health_check_id, + json_extract_path_text(Properties, 'HealthCheckConfig') as health_check_config, + json_extract_path_text(Properties, 'HealthCheckTags') as health_check_tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Route53::HealthCheck' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'HealthCheckId') as health_check_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53::HealthCheck' + AND region = 'us-east-1' hosted_zones: name: hosted_zones id: aws.route53.hosted_zones @@ -1560,7 +1930,7 @@ components: x-cfn-type-name: AWS::Route53::HostedZone x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1577,9 +1947,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1589,41 +1959,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/hosted_zones/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/hosted_zones/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53::HostedZone' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53::HostedZone' - AND region = 'us-east-1' - hosted_zone: - name: hosted_zone - id: aws.route53.hosted_zone - x-cfn-schema-name: HostedZone - x-cfn-type-name: AWS::Route53::HostedZone - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1634,12 +1972,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/hosted_zones/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/hosted_zones/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/hosted_zone/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/hosted_zones/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1655,21 +1997,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'HostedZoneConfig') as hosted_zone_config, - json_extract_path_text(Properties, 'HostedZoneTags') as hosted_zone_tags, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'QueryLoggingConfig') as query_logging_config, - json_extract_path_text(Properties, 'VPCs') as vpcs, - json_extract_path_text(Properties, 'NameServers') as name_servers - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Route53::HostedZone' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53::HostedZone' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'HostedZoneConfig') as hosted_zone_config, + json_extract_path_text(Properties, 'HostedZoneTags') as hosted_zone_tags, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'QueryLoggingConfig') as query_logging_config, + json_extract_path_text(Properties, 'VPCs') as vpcs, + json_extract_path_text(Properties, 'NameServers') as name_servers + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Route53::HostedZone' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53::HostedZone' + AND region = 'us-east-1' key_signing_keys: name: key_signing_keys id: aws.route53.key_signing_keys @@ -1678,7 +2036,7 @@ components: x-identifiers: - HostedZoneId - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1695,9 +2053,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1707,44 +2065,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/key_signing_keys/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/key_signing_keys/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.HostedZoneId') as hosted_zone_id, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53::KeySigningKey' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'HostedZoneId') as hosted_zone_id, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53::KeySigningKey' - AND region = 'us-east-1' - key_signing_key: - name: key_signing_key - id: aws.route53.key_signing_key - x-cfn-schema-name: KeySigningKey - x-cfn-type-name: AWS::Route53::KeySigningKey - x-identifiers: - - HostedZoneId - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1755,12 +2078,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/key_signing_keys/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/key_signing_keys/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/key_signing_key/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/key_signing_keys/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1773,45 +2100,69 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'HostedZoneId') as hosted_zone_id, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'KeyManagementServiceArn') as key_management_service_arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Route53::KeySigningKey' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.HostedZoneId') as hosted_zone_id, + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53::KeySigningKey' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'HostedZoneId') as hosted_zone_id, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'KeyManagementServiceArn') as key_management_service_arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Route53::KeySigningKey' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'HostedZoneId') as hosted_zone_id, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53::KeySigningKey' + AND region = 'us-east-1' resource_record_sets: name: resource_record_sets + x-cfn-schema-name: ResourceRecordSet + x-example-where-clause: WHERE region = 'us-east-1' /* always us-east-1 for route53 */ AND Id = '' + x-type: native + methods: + create_record_set: + serviceName: route53 + operation: + $ref: '#/paths/~12013-04-01~1hostedzone~1{Id}~1rrset~1?__nativeEndpoint=true/post' + request: + mediaType: text/xml + xmlRootAnnotation: xmlns="https://route53.amazonaws.com/doc/2013-04-01/" + response: + mediaType: text/xml + openAPIDocKey: '200' + list_record_sets: + serviceName: route53 + operation: + $ref: '#/paths/~12013-04-01~1hostedzone~1{Id}~1rrset?__nativeEndpoint=true/get' + response: + objectKey: /*/ResourceRecordSets/ResourceRecordSet + mediaType: text/xml + openAPIDocKey: '200' id: aws.route53.resource_record_sets - x-cfn-schema-name: resource_record_sets - x-type: custom_list - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - Id, - AliasTarget as alias_target, - CidrRoutingConfig as cidr_routing_config, - Failover as failover, - GeoLocation as geo_location, - HealthCheckId as health_check_id, - MultiValueAnswer as multi_value_answer, - Name as name, - ResourceRecords as resource_records, - SetIdentifier as set_identifier, - TTL as ttl, - TrafficPolicyInstanceId as traffic_policy_instance_id, - Type as type, - Weight as weight - FROM aws.route53_api.resource_record_sets - WHERE Id = 'HOSTEDZONEID' and region = 'us-east-1' + sqlVerbs: + delete: [] + insert: + - $ref: '#/components/x-stackQL-resources/resource_record_sets/methods/create_record_set' + select: + - $ref: '#/components/x-stackQL-resources/resource_record_sets/methods/list_record_sets' + update: [] + title: resource_record_sets paths: /?Action=CreateResource&Version=2021-09-30: parameters: @@ -2165,6 +2516,226 @@ paths: schema: $ref: '#/components/x-cloud-control-schemas/ProgressEvent' description: Success + /2013-04-01/hostedzone/{Id}/rrset/?__nativeEndpoint=true: + post: + operationId: ChangeResourceRecordSets + description: >- +

Creates, changes, or deletes a resource record set, which contains authoritative DNS information for a specified domain name or subdomain name. For example, you can use ChangeResourceRecordSets to create a resource record set that routes traffic for test.example.com to a web server that has an IP address of 192.0.2.44.

Deleting Resource Record Sets

To delete a resource record set, you must specify all the same values that you specified when you + created it.

Change Batches and Transactional Changes

The request body must include a document with a ChangeResourceRecordSetsRequest element. The request body contains a list of change items, known as a change batch. Change batches are considered transactional changes. Route 53 validates the changes in the request and then either makes all or none of the changes in the change batch request. This ensures that DNS routing isn't adversely affected by + partial changes to the resource record sets in a hosted zone.

For example, suppose a change batch request contains two changes: it deletes the CNAME resource record set for www.example.com and creates an alias resource record set for www.example.com. If validation for both records succeeds, Route 53 deletes the first resource record set and creates the second resource record set in a single operation. If validation for either the DELETE or the + CREATE action fails, then the request is canceled, and the original CNAME record continues to exist.

If you try to delete the same resource record set more than once in a single change batch, Route 53 returns an InvalidChangeBatch error.

Traffic Flow

To create resource record sets for complex routing configurations, use either the traffic flow visual editor in the Route 53 console or the API actions for + traffic policies and traffic policy instances. Save the configuration as a traffic policy, then associate the traffic policy with one or more domain names (such as example.com) or subdomain names (such as www.example.com), in the same hosted zone or in multiple hosted zones. You can roll back the updates if the new configuration isn't performing as expected. For more information, see Using Traffic Flow + to Route DNS Traffic in the Amazon Route 53 Developer Guide.

Create, Delete, and Upsert

Use ChangeResourceRecordsSetsRequest to perform the following actions:

  • CREATE: Creates a resource record set that has the specified values.

  • DELETE: Deletes an existing resource record set that has the specified values.

  • UPSERT: If a resource set exists Route 53 + updates it with the values in the request.

Syntaxes for Creating, Updating, and Deleting Resource Record Sets

The syntax for a request depends on the type of resource record set that you want to create, delete, or update, such as weighted, alias, or failover. The XML elements in your request must appear in the order listed in the syntax.

For an example for each type of resource record set, see "Examples."

Don't refer to the syntax in the + "Parameter Syntax" section, which includes all of the elements for every kind of resource record set that you can create, delete, or update by using ChangeResourceRecordSets.

Change Propagation to Route 53 DNS Servers

When you submit a ChangeResourceRecordSets request, Route 53 propagates your changes to all of the Route 53 authoritative DNS servers. While your changes are propagating, GetChange returns a status of + PENDING. When propagation is complete, GetChange returns a status of INSYNC. Changes generally propagate to all Route 53 name servers within 60 seconds. For more information, see GetChange.

Limits on ChangeResourceRecordSets Requests

For information about the limits on a ChangeResourceRecordSets request, see Limits in the Amazon Route 53 Developer Guide.

+ responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ChangeResourceRecordSetsResponse' + '480': + description: NoSuchHostedZone + content: + text/xml: + schema: + $ref: '#/components/schemas/NoSuchHostedZone' + '481': + description: NoSuchHealthCheck + content: + text/xml: + schema: + $ref: '#/components/schemas/NoSuchHealthCheck' + '482': + description: InvalidChangeBatch + content: + text/xml: + schema: + $ref: '#/components/schemas/InvalidChangeBatch' + '483': + description: InvalidInput + content: + text/xml: + schema: + $ref: '#/components/schemas/InvalidInput' + '484': + description: PriorRequestNotComplete + content: + text/xml: + schema: + $ref: '#/components/schemas/PriorRequestNotComplete' + parameters: + - name: Id + in: path + required: true + description: The ID of the hosted zone that contains the resource record sets that you want to change. + schema: + type: string + maxLength: 32 + - in: header + name: region + required: false + schema: + default: us-east-1 + type: string + requestBody: + required: true + content: + text/xml: + schema: + xml: + name: ChangeResourceRecordSetsRequest + type: object + required: + - ChangeBatch + properties: + ChangeBatch: + description: The information for a change request. + type: object + xml: + name: ChangeBatch + properties: + Comment: + $ref: '#/components/schemas/ResourceDescription' + Changes: + $ref: '#/components/schemas/Changes' + servers: + - url: https://route53.amazonaws.com + description: The general Route 53 multi-region endpoint + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + /2013-04-01/hostedzone/{Id}/rrset?__nativeEndpoint=true: + get: + operationId: ListResourceRecordSets + description: >- +

Lists the resource record sets in a specified hosted zone.

ListResourceRecordSets returns up to 300 resource record sets at a time in ASCII order, beginning at a position specified by the name and type elements.

Sort order

ListResourceRecordSets sorts results first by DNS name with the labels reversed, for example:

com.example.www.

Note the trailing dot, which can change + the sort order when the record name contains characters that appear before . (decimal 46) in the ASCII table. These characters include the following: ! " # $ % & ' ( ) * + , -

When multiple records have the same DNS name, ListResourceRecordSets sorts results by the record type.

Specifying where to start listing records

You can use the name and type elements to specify the resource record set that the list begins + with:

If you do not specify Name or Type

The results begin with the first resource record set that the hosted zone contains.

If you specify Name but not Type

The results begin with the first resource record set in the list whose name is greater than or equal to Name.

If you specify Type but not Name

Amazon Route 53 returns the InvalidInput error.

If you specify both + Name and Type

The results begin with the first resource record set in the list whose name is greater than or equal to Name, and whose type is greater than or equal to Type.

Resource record sets that are PENDING

This action returns the most current version of the records. This includes records that are PENDING, and that are not yet available on all Route 53 DNS servers.

Changing resource + record sets

To ensure that you get an accurate listing of the resource record sets for a hosted zone at a point in time, do not submit a ChangeResourceRecordSets request while you're paging through the results of a ListResourceRecordSets request. If you do, some pages may display results without the latest changes while other pages display results with the latest changes.

Displaying the next page of results

If a + ListResourceRecordSets command returns more than one page of results, the value of IsTruncated is true. To display the next page of results, get the values of NextRecordName, NextRecordType, and NextRecordIdentifier (if any) from the response. Then submit another ListResourceRecordSets request, and specify those values for StartRecordName, StartRecordType, and + StartRecordIdentifier.

+ responses: + '200': + description: Success + content: + text/xml: + schema: + $ref: '#/components/schemas/ListResourceRecordSetsResponse' + '480': + description: NoSuchHostedZone + content: + text/xml: + schema: + $ref: '#/components/schemas/NoSuchHostedZone' + '481': + description: InvalidInput + content: + text/xml: + schema: + $ref: '#/components/schemas/InvalidInput' + parameters: + - name: Id + in: path + required: true + description: The ID of the hosted zone that contains the resource record sets that you want to list. + schema: + type: string + maxLength: 32 + - name: name + in: query + required: false + description: The first name in the lexicographic ordering of resource record sets that you want to list. If the specified record name doesn't exist, the results begin with the first resource record set that has a name greater than the value of name. + schema: + type: string + maxLength: 1024 + - name: type + in: query + required: false + description: >- +

The type of resource record set to begin the record listing from.

Valid values for basic resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | NS | PTR | SOA | SPF | SRV | TXT

Values for weighted, latency, geolocation, and failover resource record sets: A | AAAA | CAA + | CNAME | MX | NAPTR | PTR | SPF | SRV | TXT

Values for alias resource record sets:

  • API Gateway custom regional API or edge-optimized API: A

  • CloudFront distribution: A or AAAA

  • Elastic Beanstalk environment that has a regionalized subdomain: A

  • Elastic Load Balancing load balancer: A | + AAAA

  • S3 bucket: A

  • VPC interface VPC endpoint: A

  • Another resource record set in this hosted zone: The type of the resource record set that the alias references.

Constraint: Specifying type without specifying name returns an InvalidInput error.

+ schema: + type: string + enum: + - SOA + - A + - TXT + - NS + - CNAME + - MX + - NAPTR + - PTR + - SRV + - SPF + - AAAA + - CAA + - DS + - name: identifier + in: query + required: false + description: ' Resource record sets that have a routing policy other than simple: If results were truncated for a given DNS name and type, specify the value of NextRecordIdentifier from the previous response to get the next resource record set that has the current DNS name and type.' + schema: + type: string + minLength: 1 + maxLength: 128 + - name: maxitems + in: query + required: false + description: (Optional) The maximum number of resource records sets to include in the response body for this request. If the response includes more than maxitems resource record sets, the value of the IsTruncated element in the response is true, and the values of the NextRecordName and NextRecordType elements in the response identify the first resource record set in the next group of maxitems resource record sets. + schema: + type: string + - name: MaxItems + in: query + schema: + type: string + description: Pagination limit + required: false + - name: StartRecordName + in: query + schema: + type: string + description: Pagination token + required: false + - name: StartRecordType + in: query + schema: + type: string + description: Pagination token + required: false + - name: StartRecordIdentifier + in: query + schema: + type: string + description: Pagination token + required: false + - name: region + in: header + schema: + type: string + default: us-east-1 + required: false + servers: + - url: https://route53.amazonaws.com + description: The general Route 53 multi-region endpoint + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' x-stackQL-config: requestTranslate: algorithm: drop_double_underscore_params @@ -2175,3 +2746,5 @@ x-stackQL-config: responseToken: key: NextToken location: body + queryParamTranspose: + algorithm: AWSCanonical diff --git a/providers/src/aws/v00.00.00000/services/route53_api.yaml b/providers/src/aws/v00.00.00000/services/route53_api.yaml deleted file mode 100644 index 05b9c83f..00000000 --- a/providers/src/aws/v00.00.00000/services/route53_api.yaml +++ /dev/null @@ -1,7824 +0,0 @@ -openapi: 3.0.0 -info: - version: 2013-04-01 - x-release: v4 - title: Amazon Route 53 - description:

Amazon Route 53 is a highly available and scalable Domain Name System (DNS) web service.

You can use Route 53 to:

- x-logo: - url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png - backgroundColor: "#FFFFFF" - termsOfService: https://aws.amazon.com/service-terms/ - contact: - name: Mike Ralphson - email: mike.ralphson@gmail.com - url: https://github.com/mermade/aws2openapi - x-twitter: PermittedSoc - license: - name: Apache 2.0 License - url: http://www.apache.org/licenses/ - x-providerName: amazonaws.com - x-serviceName: route53 - x-origin: - - contentType: application/json - url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/route53-2013-04-01.normal.json - converter: - url: https://github.com/mermade/aws2openapi - version: 1.0.0 - x-apisguru-driver: external - x-apiClientRegistration: - url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct - x-apisguru-categories: - - cloud - x-preferred: true -externalDocs: - description: Amazon Web Services documentation - url: https://docs.aws.amazon.com/route53/ -servers: - - url: https://route53.amazonaws.com - description: The general Route 53 multi-region endpoint -paths: - "/2013-04-01/keysigningkey/{HostedZoneId}/{Name}/activate": - post: - operationId: ActivateKeySigningKey - description: Activates a key-signing key (KSK) so that it can be used for signing by DNSSEC. This operation changes the KSK status to ACTIVE. - responses: - "200": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/ActivateKeySigningKeyResponse" - "480": - description: ConcurrentModification - content: - text/xml: - schema: - $ref: "#/components/schemas/ConcurrentModification" - "481": - description: NoSuchKeySigningKey - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchKeySigningKey" - "482": - description: InvalidKeySigningKeyStatus - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidKeySigningKeyStatus" - "483": - description: InvalidSigningStatus - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidSigningStatus" - "484": - description: InvalidKMSArn - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidKMSArn" - "485": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - parameters: - - name: HostedZoneId - in: path - required: true - description: A unique string used to identify a hosted zone. - schema: - type: string - maxLength: 32 - - name: Name - in: path - required: true - description: A string used to identify a key-signing key (KSK). Name can include numbers, letters, and underscores (_). Name must be unique for each key-signing key in the same hosted zone. - schema: - type: string - minLength: 3 - maxLength: 128 - parameters: - - $ref: "#/components/parameters/X-Amz-Content-Sha256" - - $ref: "#/components/parameters/X-Amz-Date" - - $ref: "#/components/parameters/X-Amz-Algorithm" - - $ref: "#/components/parameters/X-Amz-Credential" - - $ref: "#/components/parameters/X-Amz-Security-Token" - - $ref: "#/components/parameters/X-Amz-Signature" - - $ref: "#/components/parameters/X-Amz-SignedHeaders" - "/2013-04-01/hostedzone/{Id}/associatevpc": - post: - operationId: AssociateVPCWithHostedZone - description:

Associates an Amazon VPC with a private hosted zone.

To perform the association, the VPC and the private hosted zone must already exist. You can't convert a public hosted zone into a private hosted zone.

If you want to associate a VPC that was created by using one Amazon Web Services account with a private hosted zone that was created by using a different account, the Amazon Web Services account that created the private hosted zone must first submit a CreateVPCAssociationAuthorization request. Then the account that created the VPC must submit an AssociateVPCWithHostedZone request.

When granting access, the hosted zone and the Amazon VPC must belong to the same partition. A partition is a group of Amazon Web Services Regions. Each Amazon Web Services account is scoped to one partition.

The following are the supported partitions:

  • aws - Amazon Web Services Regions

  • aws-cn - China Regions

  • aws-us-gov - Amazon Web Services GovCloud (US) Region

For more information, see Access Management in the Amazon Web Services General Reference.

 - responses: - "200": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/AssociateVPCWithHostedZoneResponse" - "480": - description: NoSuchHostedZone - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchHostedZone" - "481": - description: NotAuthorizedException - content: - text/xml: - schema: - $ref: "#/components/schemas/NotAuthorizedException" - "482": - description: InvalidVPCId - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidVPCId" - "483": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - "484": - description: PublicZoneVPCAssociation - content: - text/xml: - schema: - $ref: "#/components/schemas/PublicZoneVPCAssociation" - "485": - description: ConflictingDomainExists - content: - text/xml: - schema: - $ref: "#/components/schemas/ConflictingDomainExists" - "486": - description: LimitsExceeded - content: - text/xml: - schema: - $ref: "#/components/schemas/LimitsExceeded" - "487": - description: PriorRequestNotComplete - content: - text/xml: - schema: - $ref: "#/components/schemas/PriorRequestNotComplete" - parameters: - - name: Id - in: path - required: true - description:

The ID of the private hosted zone that you want to associate an Amazon VPC with.

Note that you can't associate a VPC with a hosted zone that doesn't have an existing VPC association.

- schema: - type: string - maxLength: 32 - requestBody: - required: true - content: - text/xml: - schema: - type: object - required: - - VPC - properties: - VPC: - description:

(Private hosted zones only) A complex type that contains information about an Amazon VPC.

If you associate a private hosted zone with an Amazon VPC when you make a CreateHostedZone request, the following parameters are also required.

- type: object - properties: - VPCRegion: - allOf: - - $ref: "#/components/schemas/VPCRegion" - - description: (Private hosted zones only) The region that an Amazon VPC was created in. - VPCId: - $ref: "#/components/schemas/VPCId" - Comment: - description: " Optional: A comment about the association request." - type: string - parameters: - - $ref: "#/components/parameters/X-Amz-Content-Sha256" - - $ref: "#/components/parameters/X-Amz-Date" - - $ref: "#/components/parameters/X-Amz-Algorithm" - - $ref: "#/components/parameters/X-Amz-Credential" - - $ref: "#/components/parameters/X-Amz-Security-Token" - - $ref: "#/components/parameters/X-Amz-Signature" - - $ref: "#/components/parameters/X-Amz-SignedHeaders" - "/2013-04-01/cidrcollection/{CidrCollectionId}": - post: - operationId: ChangeCidrCollection - description: "

Creates, changes, or deletes CIDR blocks within a collection. Contains authoritative IP information mapping blocks to one or multiple locations.

A change request can update multiple locations in a collection at a time, which is helpful if you want to move one or more CIDR blocks from one location to another in one transaction, without downtime.

Limits

The max number of CIDR blocks included in the request is 1000. As a result, big updates require multiple API calls.

PUT and DELETE_IF_EXISTS

Use ChangeCidrCollection to perform the following actions:

  • PUT: Create a CIDR block within the specified collection.

  • DELETE_IF_EXISTS: Delete an existing CIDR block from the collection.

" - responses: - "200": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/ChangeCidrCollectionResponse" - "480": - description: NoSuchCidrCollectionException - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchCidrCollectionException" - "481": - description: CidrCollectionVersionMismatchException - content: - text/xml: - schema: - $ref: "#/components/schemas/CidrCollectionVersionMismatchException" - "482": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - "483": - description: CidrBlockInUseException - content: - text/xml: - schema: - $ref: "#/components/schemas/CidrBlockInUseException" - "484": - description: LimitsExceeded - content: - text/xml: - schema: - $ref: "#/components/schemas/LimitsExceeded" - "485": - description: ConcurrentModification - content: - text/xml: - schema: - $ref: "#/components/schemas/ConcurrentModification" - parameters: - - name: CidrCollectionId - in: path - required: true - description: The UUID of the CIDR collection to update. - schema: - type: string - pattern: "[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}" - requestBody: - required: true - content: - text/xml: - schema: - type: object - required: - - Changes - properties: - CollectionVersion: - description: "

A sequential counter that Amazon Route 53 sets to 1 when you create a collection and increments it by 1 each time you update the collection.

We recommend that you use ListCidrCollection to get the current value of CollectionVersion for the collection that you want to update, and then include that value with the change request. This prevents Route 53 from overwriting an intervening update:

  • If the value in the request matches the value of CollectionVersion in the collection, Route 53 updates the collection.

  • If the value of CollectionVersion in the collection is greater than the value in the request, the collection was changed after you got the version number. Route 53 does not update the collection, and it returns a CidrCollectionVersionMismatch error.

" - type: integer - minimum: 1 - Changes: - description: " Information about changes to a CIDR collection." - type: array - items: - $ref: "#/components/schemas/CidrCollectionChange" - minItems: 1 - maxItems: 1000 - parameters: - - $ref: "#/components/parameters/X-Amz-Content-Sha256" - - $ref: "#/components/parameters/X-Amz-Date" - - $ref: "#/components/parameters/X-Amz-Algorithm" - - $ref: "#/components/parameters/X-Amz-Credential" - - $ref: "#/components/parameters/X-Amz-Security-Token" - - $ref: "#/components/parameters/X-Amz-Signature" - - $ref: "#/components/parameters/X-Amz-SignedHeaders" - delete: - operationId: DeleteCidrCollection - description: Deletes a CIDR collection in the current Amazon Web Services account. The collection must be empty before it can be deleted. - responses: - "200": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/DeleteCidrCollectionResponse" - "480": - description: NoSuchCidrCollectionException - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchCidrCollectionException" - "481": - description: CidrCollectionInUseException - content: - text/xml: - schema: - $ref: "#/components/schemas/CidrCollectionInUseException" - "482": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - "483": - description: ConcurrentModification - content: - text/xml: - schema: - $ref: "#/components/schemas/ConcurrentModification" - parameters: - - name: CidrCollectionId - in: path - required: true - description: The UUID of the collection to delete. - schema: - type: string - pattern: "[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}" - get: - operationId: ListCidrLocations - description: Returns a paginated list of CIDR locations for the given collection (metadata only, does not include CIDR blocks). - responses: - "200": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/ListCidrLocationsResponse" - "480": - description: NoSuchCidrCollectionException - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchCidrCollectionException" - "481": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - parameters: - - name: CidrCollectionId - in: path - required: true - description: The CIDR collection ID. - schema: - type: string - pattern: "[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}" - - name: nexttoken - in: query - required: false - description:

An opaque pagination token to indicate where the service is to begin enumerating results.

If no value is provided, the listing of results starts from the beginning.

- schema: - type: string - maxLength: 1024 - - name: maxresults - in: query - required: false - description: The maximum number of CIDR collection locations to return in the response. - schema: - type: string - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - "/2013-04-01/hostedzone/{Id}/rrset/": - post: - operationId: ChangeResourceRecordSets - description: "

Creates, changes, or deletes a resource record set, which contains authoritative DNS information for a specified domain name or subdomain name. For example, you can use ChangeResourceRecordSets to create a resource record set that routes traffic for test.example.com to a web server that has an IP address of 192.0.2.44.

Deleting Resource Record Sets

To delete a resource record set, you must specify all the same values that you specified when you created it.

Change Batches and Transactional Changes

The request body must include a document with a ChangeResourceRecordSetsRequest element. The request body contains a list of change items, known as a change batch. Change batches are considered transactional changes. Route 53 validates the changes in the request and then either makes all or none of the changes in the change batch request. This ensures that DNS routing isn't adversely affected by partial changes to the resource record sets in a hosted zone.

For example, suppose a change batch request contains two changes: it deletes the CNAME resource record set for www.example.com and creates an alias resource record set for www.example.com. If validation for both records succeeds, Route 53 deletes the first resource record set and creates the second resource record set in a single operation. If validation for either the DELETE or the CREATE action fails, then the request is canceled, and the original CNAME record continues to exist.

If you try to delete the same resource record set more than once in a single change batch, Route 53 returns an InvalidChangeBatch error.

Traffic Flow

To create resource record sets for complex routing configurations, use either the traffic flow visual editor in the Route 53 console or the API actions for traffic policies and traffic policy instances. Save the configuration as a traffic policy, then associate the traffic policy with one or more domain names (such as example.com) or subdomain names (such as www.example.com), in the same hosted zone or in multiple hosted zones. You can roll back the updates if the new configuration isn't performing as expected. For more information, see Using Traffic Flow to Route DNS Traffic in the Amazon Route 53 Developer Guide.

Create, Delete, and Upsert

Use ChangeResourceRecordsSetsRequest to perform the following actions:

  • CREATE: Creates a resource record set that has the specified values.

  • DELETE: Deletes an existing resource record set that has the specified values.

  • UPSERT: If a resource set exists Route 53 updates it with the values in the request.

Syntaxes for Creating, Updating, and Deleting Resource Record Sets

The syntax for a request depends on the type of resource record set that you want to create, delete, or update, such as weighted, alias, or failover. The XML elements in your request must appear in the order listed in the syntax.

For an example for each type of resource record set, see \"Examples.\"

Don't refer to the syntax in the \"Parameter Syntax\" section, which includes all of the elements for every kind of resource record set that you can create, delete, or update by using ChangeResourceRecordSets.

Change Propagation to Route 53 DNS Servers

When you submit a ChangeResourceRecordSets request, Route 53 propagates your changes to all of the Route 53 authoritative DNS servers. While your changes are propagating, GetChange returns a status of PENDING. When propagation is complete, GetChange returns a status of INSYNC. Changes generally propagate to all Route 53 name servers within 60 seconds. For more information, see GetChange.

Limits on ChangeResourceRecordSets Requests

For information about the limits on a ChangeResourceRecordSets request, see Limits in the Amazon Route 53 Developer Guide.

" - responses: - "200": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/ChangeResourceRecordSetsResponse" - "480": - description: NoSuchHostedZone - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchHostedZone" - "481": - description: NoSuchHealthCheck - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchHealthCheck" - "482": - description: InvalidChangeBatch - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidChangeBatch" - "483": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - "484": - description: PriorRequestNotComplete - content: - text/xml: - schema: - $ref: "#/components/schemas/PriorRequestNotComplete" - parameters: - - name: Id - in: path - required: true - description: The ID of the hosted zone that contains the resource record sets that you want to change. - schema: - type: string - maxLength: 32 - - in: header - name: region - required: false - schema: - default: us-east-1 - type: string - requestBody: - required: true - content: - text/xml: - schema: - xml: - name: ChangeResourceRecordSetsRequest - type: object - required: - - ChangeBatch - properties: - ChangeBatch: - description: The information for a change request. - type: object - xml: - name: ChangeBatch - properties: - Comment: - $ref: "#/components/schemas/ResourceDescription" - Changes: - $ref: "#/components/schemas/Changes" - parameters: - - $ref: "#/components/parameters/X-Amz-Content-Sha256" - - $ref: "#/components/parameters/X-Amz-Date" - - $ref: "#/components/parameters/X-Amz-Algorithm" - - $ref: "#/components/parameters/X-Amz-Credential" - - $ref: "#/components/parameters/X-Amz-Security-Token" - - $ref: "#/components/parameters/X-Amz-Signature" - - $ref: "#/components/parameters/X-Amz-SignedHeaders" - "/2013-04-01/tags/{ResourceType}/{ResourceId}": - post: - operationId: ChangeTagsForResource - description:

Adds, edits, or deletes tags for a health check or a hosted zone.

For information about using tags for cost allocation, see Using Cost Allocation Tags in the Billing and Cost Management User Guide.

- responses: - "200": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/ChangeTagsForResourceResponse" - "480": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - "481": - description: NoSuchHealthCheck - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchHealthCheck" - "482": - description: NoSuchHostedZone - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchHostedZone" - "483": - description: PriorRequestNotComplete - content: - text/xml: - schema: - $ref: "#/components/schemas/PriorRequestNotComplete" - "484": - description: ThrottlingException - content: - text/xml: - schema: - $ref: "#/components/schemas/ThrottlingException" - parameters: - - name: ResourceType - in: path - required: true - description:

The type of the resource.

  • The resource type for health checks is healthcheck.

  • The resource type for hosted zones is hostedzone.

- schema: - type: string - enum: - - healthcheck - - hostedzone - - name: ResourceId - in: path - required: true - description: The ID of the resource for which you want to add, change, or delete tags. - schema: - type: string - maxLength: 64 - requestBody: - required: true - content: - text/xml: - schema: - type: object - properties: - AddTags: - description:

A complex type that contains a list of the tags that you want to add to the specified health check or hosted zone and/or the tags that you want to edit Value for.

You can add a maximum of 10 tags to a health check or a hosted zone.

- type: array - items: - allOf: - - $ref: "#/components/schemas/Tag" - - xml: - name: Tag - minItems: 1 - maxItems: 10 - RemoveTagKeys: - description: A complex type that contains a list of the tags that you want to delete from the specified health check or hosted zone. You can specify up to 10 keys. - type: array - items: - allOf: - - $ref: "#/components/schemas/TagKey" - - xml: - name: Key - minItems: 1 - maxItems: 10 - parameters: - - $ref: "#/components/parameters/X-Amz-Content-Sha256" - - $ref: "#/components/parameters/X-Amz-Date" - - $ref: "#/components/parameters/X-Amz-Algorithm" - - $ref: "#/components/parameters/X-Amz-Credential" - - $ref: "#/components/parameters/X-Amz-Security-Token" - - $ref: "#/components/parameters/X-Amz-Signature" - - $ref: "#/components/parameters/X-Amz-SignedHeaders" - get: - operationId: ListTagsForResource - description:

Lists tags for one health check or hosted zone.

For information about using tags for cost allocation, see Using Cost Allocation Tags in the Billing and Cost Management User Guide.

- responses: - "200": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/ListTagsForResourceResponse" - "480": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - "481": - description: NoSuchHealthCheck - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchHealthCheck" - "482": - description: NoSuchHostedZone - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchHostedZone" - "483": - description: PriorRequestNotComplete - content: - text/xml: - schema: - $ref: "#/components/schemas/PriorRequestNotComplete" - "484": - description: ThrottlingException - content: - text/xml: - schema: - $ref: "#/components/schemas/ThrottlingException" - parameters: - - name: ResourceType - in: path - required: true - description:

The type of the resource.

  • The resource type for health checks is healthcheck.

  • The resource type for hosted zones is hostedzone.

- schema: - type: string - enum: - - healthcheck - - hostedzone - - name: ResourceId - in: path - required: true - description: The ID of the resource for which you want to retrieve tags. - schema: - type: string - maxLength: 64 - /2013-04-01/cidrcollection: - post: - operationId: CreateCidrCollection - description: Creates a CIDR collection in the current Amazon Web Services account. - responses: - "201": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/CreateCidrCollectionResponse" - "480": - description: LimitsExceeded - content: - text/xml: - schema: - $ref: "#/components/schemas/LimitsExceeded" - "481": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - "482": - description: CidrCollectionAlreadyExistsException - content: - text/xml: - schema: - $ref: "#/components/schemas/CidrCollectionAlreadyExistsException" - "483": - description: ConcurrentModification - content: - text/xml: - schema: - $ref: "#/components/schemas/ConcurrentModification" - parameters: [] - requestBody: - required: true - content: - text/xml: - schema: - type: object - required: - - Name - - CallerReference - properties: - Name: - description: A unique identifier for the account that can be used to reference the collection from other API calls. - type: string - pattern: "[0-9A-Za-z_\\-]+" - minLength: 1 - maxLength: 64 - CallerReference: - description: A client-specific token that allows requests to be securely retried so that the intended outcome will only occur once, retries receive a similar response, and there are no additional edge cases to handle. - type: string - pattern: \p{ASCII}+ - minLength: 1 - maxLength: 64 - parameters: - - $ref: "#/components/parameters/X-Amz-Content-Sha256" - - $ref: "#/components/parameters/X-Amz-Date" - - $ref: "#/components/parameters/X-Amz-Algorithm" - - $ref: "#/components/parameters/X-Amz-Credential" - - $ref: "#/components/parameters/X-Amz-Security-Token" - - $ref: "#/components/parameters/X-Amz-Signature" - - $ref: "#/components/parameters/X-Amz-SignedHeaders" - get: - operationId: ListCidrCollections - description: Returns a paginated list of CIDR collections in the Amazon Web Services account (metadata only). - responses: - "200": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/ListCidrCollectionsResponse" - "480": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - parameters: - - name: nexttoken - in: query - required: false - description:

An opaque pagination token to indicate where the service is to begin enumerating results.

If no value is provided, the listing of results starts from the beginning.

- schema: - type: string - maxLength: 1024 - - name: maxresults - in: query - required: false - description: The maximum number of CIDR collections to return in the response. - schema: - type: string - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /2013-04-01/healthcheck: - post: - operationId: CreateHealthCheck - description:

Creates a new health check.

For information about adding health checks to resource record sets, see HealthCheckId in ChangeResourceRecordSets.

ELB Load Balancers

If you're registering EC2 instances with an Elastic Load Balancing (ELB) load balancer, do not create Amazon Route 53 health checks for the EC2 instances. When you register an EC2 instance with a load balancer, you configure settings for an ELB health check, which performs a similar function to a Route 53 health check.

Private Hosted Zones

You can associate health checks with failover resource record sets in a private hosted zone. Note the following:

  • Route 53 health checkers are outside the VPC. To check the health of an endpoint within a VPC by IP address, you must assign a public IP address to the instance in the VPC.

  • You can configure a health checker to check the health of an external resource that the instance relies on, such as a database server.

  • You can create a CloudWatch metric, associate an alarm with the metric, and then create a health check that is based on the state of the alarm. For example, you might create a CloudWatch metric that checks the status of the Amazon EC2 StatusCheckFailed metric, add an alarm to the metric, and then create a health check that is based on the state of the alarm. For information about creating CloudWatch metrics and alarms by using the CloudWatch console, see the Amazon CloudWatch User Guide.

- responses: - "201": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/CreateHealthCheckResponse" - "480": - description: TooManyHealthChecks - content: - text/xml: - schema: - $ref: "#/components/schemas/TooManyHealthChecks" - "481": - description: HealthCheckAlreadyExists - content: - text/xml: - schema: - $ref: "#/components/schemas/HealthCheckAlreadyExists" - "482": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - parameters: [] - requestBody: - required: true - content: - text/xml: - schema: - type: object - required: - - CallerReference - - HealthCheckConfig - properties: - CallerReference: - description:

A unique string that identifies the request and that allows you to retry a failed CreateHealthCheck request without the risk of creating two identical health checks:

  • If you send a CreateHealthCheck request with the same CallerReference and settings as a previous request, and if the health check doesn't exist, Amazon Route 53 creates the health check. If the health check does exist, Route 53 returns the settings for the existing health check.

  • If you send a CreateHealthCheck request with the same CallerReference as a deleted health check, regardless of the settings, Route 53 returns a HealthCheckAlreadyExists error.

  • If you send a CreateHealthCheck request with the same CallerReference as an existing health check but with different settings, Route 53 returns a HealthCheckAlreadyExists error.

  • If you send a CreateHealthCheck request with a unique CallerReference but settings identical to an existing health check, Route 53 creates the health check.

- type: string - minLength: 1 - maxLength: 64 - HealthCheckConfig: - description: A complex type that contains information about the health check. - type: object - properties: - IPAddress: - allOf: - - $ref: "#/components/schemas/IPAddress" - - description: "

The IPv4 or IPv6 IP address of the endpoint that you want Amazon Route 53 to perform health checks on. If you don't specify a value for IPAddress, Route 53 sends a DNS request to resolve the domain name that you specify in FullyQualifiedDomainName at the interval that you specify in RequestInterval. Using an IP address returned by DNS, Route 53 then checks the health of the endpoint.

Use one of the following formats for the value of IPAddress:

  • IPv4 address: four values between 0 and 255, separated by periods (.), for example, 192.0.2.44.

  • IPv6 address: eight groups of four hexadecimal values, separated by colons (:), for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345. You can also shorten IPv6 addresses as described in RFC 5952, for example, 2001:db8:85a3::abcd:1:2345.

If the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with your EC2 instance, and specify the Elastic IP address for IPAddress. This ensures that the IP address of your instance will never change.

For more information, see FullyQualifiedDomainName.

Constraints: Route 53 can't check the health of endpoints for which the IP address is in local, private, non-routable, or multicast ranges. For more information about IP addresses for which you can't create health checks, see the following documents:

When the value of Type is CALCULATED or CLOUDWATCH_METRIC, omit IPAddress.

" - Port: - allOf: - - $ref: "#/components/schemas/Port" - - description:

The port on the endpoint that you want Amazon Route 53 to perform health checks on.

Don't specify a value for Port when you specify a value for Type of CLOUDWATCH_METRIC or CALCULATED.

 - Type: - allOf: - - $ref: "#/components/schemas/HealthCheckType" - - description: "

The type of health check that you want to create, which indicates how Amazon Route 53 determines whether an endpoint is healthy.

You can't change the value of Type after you create a health check.

You can create the following types of health checks:

  • HTTP: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.

  • HTTPS: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.

    If you specify HTTPS for the value of Type, the endpoint must support TLS v1.0 or later.

  • HTTP_STR_MATCH: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString.

  • HTTPS_STR_MATCH: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString.

  • TCP: Route 53 tries to establish a TCP connection.

  • CLOUDWATCH_METRIC: The health check is associated with a CloudWatch alarm. If the state of the alarm is OK, the health check is considered healthy. If the state is ALARM, the health check is considered unhealthy. If CloudWatch doesn't have sufficient data to determine whether the state is OK or ALARM, the health check status depends on the setting for InsufficientDataHealthStatus: Healthy, Unhealthy, or LastKnownStatus.

  • CALCULATED: For health checks that monitor the status of other health checks, Route 53 adds up the number of health checks that Route 53 health checkers consider to be healthy and compares that number with the value of HealthThreshold.

  • RECOVERY_CONTROL: The health check is assocated with a Route53 Application Recovery Controller routing control. If the routing control state is ON, the health check is considered healthy. If the state is OFF, the health check is considered unhealthy.

For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.

" - ResourcePath: - allOf: - - $ref: "#/components/schemas/ResourcePath" - - description: "The path, if any, that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example, the file /docs/route53-health-check.html. You can also include query string parameters, for example, /welcome.html?language=jp&login=y. " - FullyQualifiedDomainName: - allOf: - - $ref: "#/components/schemas/FullyQualifiedDomainName" - - description:

Amazon Route 53 behavior depends on whether you specify a value for IPAddress.

If you specify a value for IPAddress:

Amazon Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of FullyQualifiedDomainName in the Host header for all health checks except TCP health checks. This is typically the fully qualified DNS name of the endpoint on which you want Route 53 to perform health checks.

When Route 53 checks the health of an endpoint, here is how it constructs the Host header:

  • If you specify a value of 80 for Port and HTTP or HTTP_STR_MATCH for Type, Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

  • If you specify a value of 443 for Port and HTTPS or HTTPS_STR_MATCH for Type, Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

  • If you specify another value for Port and any value except TCP for Type, Route 53 passes FullyQualifiedDomainName:Port to the endpoint in the Host header.

If you don't specify a value for FullyQualifiedDomainName, Route 53 substitutes the value of IPAddress in the Host header in each of the preceding cases.

If you don't specify a value for IPAddress:

Route 53 sends a DNS request to the domain that you specify for FullyQualifiedDomainName at the interval that you specify for RequestInterval. Using an IPv4 address that DNS returns, Route 53 then checks the health of the endpoint.

If you don't specify a value for IPAddress, Route 53 uses only IPv4 to send health checks to the endpoint. If there's no resource record set with a type of A for the name that you specify for FullyQualifiedDomainName, the health check fails with a "DNS resolution failed" error.

If you want to check the health of weighted, latency, or failover resource record sets and you choose to specify the endpoint only by FullyQualifiedDomainName, we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName, specify the domain name of the server (such as us-east-2-www.example.com), not the name of the resource record sets (www.example.com).

In this configuration, if you create a health check for which the value of FullyQualifiedDomainName matches the name of the resource record sets and you then associate the health check with those resource record sets, health check results will be unpredictable.

In addition, if the value that you specify for Type is HTTP, HTTPS, HTTP_STR_MATCH, or HTTPS_STR_MATCH, Route 53 passes the value of FullyQualifiedDomainName in the Host header, as it does when you specify a value for IPAddress. If the value of Type is TCP, Route 53 doesn't pass a Host header.

- SearchString: - allOf: - - $ref: "#/components/schemas/SearchString" - - description:

If the value of Type is HTTP_STR_MATCH or HTTPS_STR_MATCH, the string that you want Amazon Route 53 to search for in the response body from the specified resource. If the string appears in the response body, Route 53 considers the resource healthy.

Route 53 considers case when searching for SearchString in the response body.

- RequestInterval: - allOf: - - $ref: "#/components/schemas/RequestInterval" - - description:

The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health check request. Each Route 53 health checker makes requests at this interval.

You can't change the value of RequestInterval after you create a health check.

If you don't specify a value for RequestInterval, the default value is 30 seconds.

- FailureThreshold: - allOf: - - $ref: "#/components/schemas/FailureThreshold" - - description:

The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.

If you don't specify a value for FailureThreshold, the default value is three health checks.

- MeasureLatency: - allOf: - - $ref: "#/components/schemas/MeasureLatency" - - description:

Specify whether you want Amazon Route 53 to measure the latency between health checkers in multiple Amazon Web Services regions and your endpoint, and to display CloudWatch latency graphs on the Health Checks page in the Route 53 console.

You can't change the value of MeasureLatency after you create a health check.

 - Inverted: - allOf: - - $ref: "#/components/schemas/Inverted" - - description: Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider a health check unhealthy when it otherwise would be considered healthy. - Disabled: - allOf: - - $ref: "#/components/schemas/Disabled" - - description:

Stops Route 53 from performing health checks. When you disable a health check, here's what happens:

  • Health checks that check the health of endpoints: Route 53 stops submitting requests to your application, server, or other resource.

  • Calculated health checks: Route 53 stops aggregating the status of the referenced health checks.

  • Health checks that monitor CloudWatch alarms: Route 53 stops monitoring the corresponding CloudWatch metrics.

After you disable a health check, Route 53 considers the status of the health check to always be healthy. If you configured DNS failover, Route 53 continues to route traffic to the corresponding resources. If you want to stop routing traffic to a resource, change the value of Inverted.

Charges for a health check still apply when the health check is disabled. For more information, see Amazon Route 53 Pricing.

- HealthThreshold: - allOf: - - $ref: "#/components/schemas/HealthThreshold" - - description:

The number of child health checks that are associated with a CALCULATED health check that Amazon Route 53 must consider healthy for the CALCULATED health check to be considered healthy. To specify the child health checks that you want to associate with a CALCULATED health check, use the ChildHealthChecks element.

Note the following:

  • If you specify a number greater than the number of child health checks, Route 53 always considers this health check to be unhealthy.

  • If you specify 0, Route 53 always considers this health check to be healthy.

- ChildHealthChecks: - allOf: - - $ref: "#/components/schemas/ChildHealthCheckList" - - description: (CALCULATED Health Checks Only) A complex type that contains one ChildHealthCheck element for each health check that you want to associate with a CALCULATED health check. - EnableSNI: - allOf: - - $ref: "#/components/schemas/EnableSNI" - - description:

Specify whether you want Amazon Route 53 to send the value of FullyQualifiedDomainName to the endpoint in the client_hello message during TLS negotiation. This allows the endpoint to respond to HTTPS health check requests with the applicable SSL/TLS certificate.

Some endpoints require that HTTPS requests include the host name in the client_hello message. If you don't enable SNI, the status of the health check will be SSL alert handshake_failure. A health check can also have that status for other reasons. If SNI is enabled and you're still getting the error, check the SSL/TLS configuration on your endpoint and confirm that your certificate is valid.

The SSL/TLS certificate on your endpoint includes a domain name in the Common Name field and possibly several more in the Subject Alternative Names field. One of the domain names in the certificate should match the value that you specify for FullyQualifiedDomainName. If the endpoint responds to the client_hello message with a certificate that does not include the domain name that you specified in FullyQualifiedDomainName, a health checker will retry the handshake. In the second attempt, the health checker will omit FullyQualifiedDomainName from the client_hello message.

- Regions: - allOf: - - $ref: "#/components/schemas/HealthCheckRegionList" - - description:

A complex type that contains one Region element for each region from which you want Amazon Route 53 health checkers to check the specified endpoint.

If you don't specify any regions, Route 53 health checkers automatically performs checks from all of the regions that are listed under Valid Values.

If you update a health check to remove a region that has been performing health checks, Route 53 will briefly continue to perform checks from that region to ensure that some health checkers are always checking the endpoint (for example, if you replace three regions with four different regions).

- AlarmIdentifier: - allOf: - - $ref: "#/components/schemas/AlarmIdentifier" - - description: A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether the specified health check is healthy. - InsufficientDataHealthStatus: - allOf: - - $ref: "#/components/schemas/InsufficientDataHealthStatus" - - description: "

When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign to the health check:

  • Healthy: Route 53 considers the health check to be healthy.

  • Unhealthy: Route 53 considers the health check to be unhealthy.

  • LastKnownStatus: Route 53 uses the status of the health check from the last time that CloudWatch had sufficient data to determine the alarm state. For new health checks that have no last known status, the default status for the health check is healthy.

" - RoutingControlArn: - allOf: - - $ref: "#/components/schemas/RoutingControlArn" - - description:

The Amazon Resource Name (ARN) for the Route 53 Application Recovery Controller routing control.

For more information about Route 53 Application Recovery Controller, see Route 53 Application Recovery Controller Developer Guide..

- parameters: - - $ref: "#/components/parameters/X-Amz-Content-Sha256" - - $ref: "#/components/parameters/X-Amz-Date" - - $ref: "#/components/parameters/X-Amz-Algorithm" - - $ref: "#/components/parameters/X-Amz-Credential" - - $ref: "#/components/parameters/X-Amz-Security-Token" - - $ref: "#/components/parameters/X-Amz-Signature" - - $ref: "#/components/parameters/X-Amz-SignedHeaders" - get: - operationId: ListHealthChecks - description: "Retrieve a list of the health checks that are associated with the current Amazon Web Services account. " - responses: - "200": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/ListHealthChecksResponse" - "480": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - "481": - description: IncompatibleVersion - content: - text/xml: - schema: - $ref: "#/components/schemas/IncompatibleVersion" - parameters: - - name: marker - in: query - required: false - description:

If the value of IsTruncated in the previous response was true, you have more health checks. To get another group, submit another ListHealthChecks request.

For the value of marker, specify the value of NextMarker from the previous response, which is the ID of the first health check that Amazon Route 53 will return if you submit another request.

If the value of IsTruncated in the previous response was false, there are no more health checks to get.

- schema: - type: string - maxLength: 64 - - name: maxitems - in: query - required: false - description: "The maximum number of health checks that you want ListHealthChecks to return in response to the current request. Amazon Route 53 returns a maximum of 100 items. If you set MaxItems to a value greater than 100, Route 53 returns only the first 100 health checks. " - schema: - type: string - - name: MaxItems - in: query - schema: - type: string - description: Pagination limit - required: false - - name: Marker - in: query - schema: - type: string - description: Pagination token - required: false - /2013-04-01/hostedzone: - post: - operationId: CreateHostedZone - description:

Creates a new public or private hosted zone. You create records in a public hosted zone to define how you want to route traffic on the internet for a domain, such as example.com, and its subdomains (apex.example.com, acme.example.com). You create records in a private hosted zone to define how you want to route traffic for a domain and its subdomains within one or more Amazon Virtual Private Clouds (Amazon VPCs).

You can't convert a public hosted zone to a private hosted zone or vice versa. Instead, you must create a new hosted zone with the same name and create new resource record sets.

For more information about charges for hosted zones, see Amazon Route 53 Pricing.

Note the following:

  • You can't create a hosted zone for a top-level domain (TLD) such as .com.

  • For public hosted zones, Route 53 automatically creates a default SOA record and four NS records for the zone. For more information about SOA and NS records, see NS and SOA Records that Route 53 Creates for a Hosted Zone in the Amazon Route 53 Developer Guide.

    If you want to use the same name servers for multiple public hosted zones, you can optionally associate a reusable delegation set with the hosted zone. See the DelegationSetId element.

  • If your domain is registered with a registrar other than Route 53, you must update the name servers with your registrar to make Route 53 the DNS service for the domain. For more information, see Migrating DNS Service for an Existing Domain to Amazon Route 53 in the Amazon Route 53 Developer Guide.

When you submit a CreateHostedZone request, the initial status of the hosted zone is PENDING. For public hosted zones, this means that the NS and SOA records are not yet available on all Route 53 DNS servers. When the NS and SOA records are available, the status of the zone changes to INSYNC.

The CreateHostedZone request requires the caller to have an ec2:DescribeVpcs permission.

When creating private hosted zones, the Amazon VPC must belong to the same partition where the hosted zone is created. A partition is a group of Amazon Web Services Regions. Each Amazon Web Services account is scoped to one partition.

The following are the supported partitions:

  • aws - Amazon Web Services Regions

  • aws-cn - China Regions

  • aws-us-gov - Amazon Web Services GovCloud (US) Region

For more information, see Access Management in the Amazon Web Services General Reference.

 - responses: - "201": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/CreateHostedZoneResponse" - "480": - description: InvalidDomainName - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidDomainName" - "481": - description: HostedZoneAlreadyExists - content: - text/xml: - schema: - $ref: "#/components/schemas/HostedZoneAlreadyExists" - "482": - description: TooManyHostedZones - content: - text/xml: - schema: - $ref: "#/components/schemas/TooManyHostedZones" - "483": - description: InvalidVPCId - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidVPCId" - "484": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - "485": - description: DelegationSetNotAvailable - content: - text/xml: - schema: - $ref: "#/components/schemas/DelegationSetNotAvailable" - "486": - description: ConflictingDomainExists - content: - text/xml: - schema: - $ref: "#/components/schemas/ConflictingDomainExists" - "487": - description: NoSuchDelegationSet - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchDelegationSet" - "488": - description: DelegationSetNotReusable - content: - text/xml: - schema: - $ref: "#/components/schemas/DelegationSetNotReusable" - parameters: [] - requestBody: - required: true - content: - text/xml: - schema: - type: object - required: - - Name - - CallerReference - properties: - Name: - description:

The name of the domain. Specify a fully qualified domain name, for example, www.example.com. The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.

If you're creating a public hosted zone, this is the name you have registered with your DNS registrar. If your domain name is registered with a registrar other than Route 53, change the name servers for your domain to the set of NameServers that CreateHostedZone returns in DelegationSet.

- type: string - maxLength: 1024 - VPC: - description:

(Private hosted zones only) A complex type that contains information about an Amazon VPC.

If you associate a private hosted zone with an Amazon VPC when you make a CreateHostedZone request, the following parameters are also required.

- type: object - properties: - VPCRegion: - allOf: - - $ref: "#/components/schemas/VPCRegion" - - description: (Private hosted zones only) The region that an Amazon VPC was created in. - VPCId: - $ref: "#/components/schemas/VPCId" - CallerReference: - description: A unique string that identifies the request and that allows failed CreateHostedZone requests to be retried without the risk of executing the operation twice. You must use a unique CallerReference string every time you submit a CreateHostedZone request. CallerReference can be any unique string, for example, a date/time stamp. - type: string - minLength: 1 - maxLength: 128 - HostedZoneConfig: - description: A complex type that contains an optional comment about your hosted zone. If you don't want to specify a comment, omit both the HostedZoneConfig and Comment elements. - type: object - properties: - Comment: - allOf: - - $ref: "#/components/schemas/ResourceDescription" - - description: Any comments that you want to include about the hosted zone. - PrivateZone: - allOf: - - $ref: "#/components/schemas/IsPrivateZone" - - description: A value that indicates whether this is a private hosted zone. - DelegationSetId: - description: If you want to associate a reusable delegation set with this hosted zone, the ID that Amazon Route 53 assigned to the reusable delegation set when you created it. For more information about reusable delegation sets, see CreateReusableDelegationSet. - type: string - maxLength: 32 - parameters: - - $ref: "#/components/parameters/X-Amz-Content-Sha256" - - $ref: "#/components/parameters/X-Amz-Date" - - $ref: "#/components/parameters/X-Amz-Algorithm" - - $ref: "#/components/parameters/X-Amz-Credential" - - $ref: "#/components/parameters/X-Amz-Security-Token" - - $ref: "#/components/parameters/X-Amz-Signature" - - $ref: "#/components/parameters/X-Amz-SignedHeaders" - get: - operationId: ListHostedZones - description:

Retrieves a list of the public and private hosted zones that are associated with the current Amazon Web Services account. The response includes a HostedZones child element for each hosted zone.

Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of hosted zones, you can use the maxitems parameter to list them in groups of up to 100.

- responses: - "200": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/ListHostedZonesResponse" - "480": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - "481": - description: NoSuchDelegationSet - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchDelegationSet" - "482": - description: DelegationSetNotReusable - content: - text/xml: - schema: - $ref: "#/components/schemas/DelegationSetNotReusable" - parameters: - - name: marker - in: query - required: false - description:

If the value of IsTruncated in the previous response was true, you have more hosted zones. To get more hosted zones, submit another ListHostedZones request.

For the value of marker, specify the value of NextMarker from the previous response, which is the ID of the first hosted zone that Amazon Route 53 will return if you submit another request.

If the value of IsTruncated in the previous response was false, there are no more hosted zones to get.

- schema: - type: string - maxLength: 64 - - name: maxitems - in: query - required: false - description: (Optional) The maximum number of hosted zones that you want Amazon Route 53 to return. If you have more than maxitems hosted zones, the value of IsTruncated in the response is true, and the value of NextMarker is the hosted zone ID of the first hosted zone that Route 53 will return if you submit another request. - schema: - type: string - - name: delegationsetid - in: query - required: false - description: "If you're using reusable delegation sets and you want to list all of the hosted zones that are associated with a reusable delegation set, specify the ID of that reusable delegation set. " - schema: - type: string - maxLength: 32 - - name: MaxItems - in: query - schema: - type: string - description: Pagination limit - required: false - - name: Marker - in: query - schema: - type: string - description: Pagination token - required: false - /2013-04-01/keysigningkey: - post: - operationId: CreateKeySigningKey - description: Creates a new key-signing key (KSK) associated with a hosted zone. You can only have two KSKs per hosted zone. - responses: - "201": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/CreateKeySigningKeyResponse" - "480": - description: NoSuchHostedZone - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchHostedZone" - "481": - description: InvalidArgument - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidArgument" - "482": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - "483": - description: InvalidKMSArn - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidKMSArn" - "484": - description: InvalidKeySigningKeyStatus - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidKeySigningKeyStatus" - "485": - description: InvalidSigningStatus - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidSigningStatus" - "486": - description: InvalidKeySigningKeyName - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidKeySigningKeyName" - "487": - description: KeySigningKeyAlreadyExists - content: - text/xml: - schema: - $ref: "#/components/schemas/KeySigningKeyAlreadyExists" - "488": - description: TooManyKeySigningKeys - content: - text/xml: - schema: - $ref: "#/components/schemas/TooManyKeySigningKeys" - "489": - description: ConcurrentModification - content: - text/xml: - schema: - $ref: "#/components/schemas/ConcurrentModification" - parameters: [] - requestBody: - required: true - content: - text/xml: - schema: - type: object - required: - - CallerReference - - HostedZoneId - - KeyManagementServiceArn - - Name - - Status - properties: - CallerReference: - description: A unique string that identifies the request. - type: string - minLength: 1 - maxLength: 128 - HostedZoneId: - description: The unique string (ID) used to identify a hosted zone. - type: string - maxLength: 32 - KeyManagementServiceArn: - description: '

The Amazon resource name (ARN) for a customer managed key in Key Management Service (KMS). The KeyManagementServiceArn must be unique for each key-signing key (KSK) in a single hosted zone. To see an example of KeyManagementServiceArn that grants the correct permissions for DNSSEC, scroll down to Example.

You must configure the customer managed customer managed key as follows:

Status

Enabled

Key spec

ECC_NIST_P256

Key usage

Sign and verify

Key policy

The key policy must give permission for the following actions:

  • DescribeKey

  • GetPublicKey

  • Sign

The key policy must also include the Amazon Route 53 service in the principal for your account. Specify the following:

  • "Service": "dnssec-route53.amazonaws.com"

For more information about working with a customer managed key in KMS, see Key Management Service concepts.

' - type: string - Name: - description: A string used to identify a key-signing key (KSK). Name can include numbers, letters, and underscores (_). Name must be unique for each key-signing key in the same hosted zone. - type: string - minLength: 3 - maxLength: 128 - Status: - description: A string specifying the initial status of the key-signing key (KSK). You can set the value to ACTIVE or INACTIVE. - type: string - minLength: 5 - maxLength: 150 - parameters: - - $ref: "#/components/parameters/X-Amz-Content-Sha256" - - $ref: "#/components/parameters/X-Amz-Date" - - $ref: "#/components/parameters/X-Amz-Algorithm" - - $ref: "#/components/parameters/X-Amz-Credential" - - $ref: "#/components/parameters/X-Amz-Security-Token" - - $ref: "#/components/parameters/X-Amz-Signature" - - $ref: "#/components/parameters/X-Amz-SignedHeaders" - /2013-04-01/queryloggingconfig: - post: - operationId: CreateQueryLoggingConfig - description: "

Creates a configuration for DNS query logging. After you create a query logging configuration, Amazon Route 53 begins to publish log data to an Amazon CloudWatch Logs log group.

DNS query logs contain information about the queries that Route 53 receives for a specified public hosted zone, such as the following:

  • Route 53 edge location that responded to the DNS query

  • Domain or subdomain that was requested

  • DNS record type, such as A or AAAA

  • DNS response code, such as NoError or ServFail

Log Group and Resource Policy

Before you create a query logging configuration, perform the following operations.

If you create a query logging configuration using the Route 53 console, Route 53 performs these operations automatically.

  1. Create a CloudWatch Logs log group, and make note of the ARN, which you specify when you create a query logging configuration. Note the following:

    • You must create the log group in the us-east-1 region.

    • You must use the same Amazon Web Services account to create the log group and the hosted zone that you want to configure query logging for.

    • When you create log groups for query logging, we recommend that you use a consistent prefix, for example:

      /aws/route53/hosted zone name

      In the next step, you'll create a resource policy, which controls access to one or more log groups and the associated Amazon Web Services resources, such as Route 53 hosted zones. There's a limit on the number of resource policies that you can create, so we recommend that you use a consistent prefix so you can use the same resource policy for all the log groups that you create for query logging.

  2. Create a CloudWatch Logs resource policy, and give it the permissions that Route 53 needs to create log streams and to send query logs to log streams. For the value of Resource, specify the ARN for the log group that you created in the previous step. To use the same resource policy for all the CloudWatch Logs log groups that you created for query logging configurations, replace the hosted zone name with *, for example:

    arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/*

    To avoid the confused deputy problem, a security issue where an entity without a permission for an action can coerce a more-privileged entity to perform it, you can optionally limit the permissions that a service has to a resource in a resource-based policy by supplying the following values:

    • For aws:SourceArn, supply the hosted zone ARN used in creating the query logging configuration. For example, aws:SourceArn: arn:aws:route53:::hostedzone/hosted zone ID.

    • For aws:SourceAccount, supply the account ID for the account that creates the query logging configuration. For example, aws:SourceAccount:111111111111.

    For more information, see The confused deputy problem in the Amazon Web Services IAM User Guide.

    You can't use the CloudWatch console to create or edit a resource policy. You must use the CloudWatch API, one of the Amazon Web Services SDKs, or the CLI.
Log Streams and Edge Locations

When Route 53 finishes creating the configuration for DNS query logging, it does the following:

  • Creates a log stream for an edge location the first time that the edge location responds to DNS queries for the specified hosted zone. That log stream is used to log all queries that Route 53 responds to for that edge location.

  • Begins to send query logs to the applicable log stream.

The name of each log stream is in the following format:

hosted zone ID/edge location code

The edge location code is a three-letter code and an arbitrarily assigned number, for example, DFW3. The three-letter code typically corresponds with the International Air Transport Association airport code for an airport near the edge location. (These abbreviations might change in the future.) For a list of edge locations, see \"The Route 53 Global Network\" on the Route 53 Product Details page.

Queries That Are Logged

Query logs contain only the queries that DNS resolvers forward to Route 53. If a DNS resolver has already cached the response to a query (such as the IP address for a load balancer for example.com), the resolver will continue to return the cached response. It doesn't forward another query to Route 53 until the TTL for the corresponding resource record set expires. Depending on how many DNS queries are submitted for a resource record set, and depending on the TTL for that resource record set, query logs might contain information about only one query out of every several thousand queries that are submitted to DNS. For more information about how DNS works, see Routing Internet Traffic to Your Website or Web Application in the Amazon Route 53 Developer Guide.

Log File Format

For a list of the values in each query log and the format of each value, see Logging DNS Queries in the Amazon Route 53 Developer Guide.

Pricing

For information about charges for query logs, see Amazon CloudWatch Pricing.

How to Stop Logging

If you want Route 53 to stop sending query logs to CloudWatch Logs, delete the query logging configuration. For more information, see DeleteQueryLoggingConfig.

" - responses: - "201": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/CreateQueryLoggingConfigResponse" - "480": - description: ConcurrentModification - content: - text/xml: - schema: - $ref: "#/components/schemas/ConcurrentModification" - "481": - description: NoSuchHostedZone - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchHostedZone" - "482": - description: NoSuchCloudWatchLogsLogGroup - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchCloudWatchLogsLogGroup" - "483": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - "484": - description: QueryLoggingConfigAlreadyExists - content: - text/xml: - schema: - $ref: "#/components/schemas/QueryLoggingConfigAlreadyExists" - "485": - description: InsufficientCloudWatchLogsResourcePolicy - content: - text/xml: - schema: - $ref: "#/components/schemas/InsufficientCloudWatchLogsResourcePolicy" - parameters: [] - requestBody: - required: true - content: - text/xml: - schema: - type: object - required: - - HostedZoneId - - CloudWatchLogsLogGroupArn - properties: - HostedZoneId: - description: The ID of the hosted zone that you want to log queries for. You can log queries only for public hosted zones. - type: string - maxLength: 32 - CloudWatchLogsLogGroupArn: - description:

The Amazon Resource Name (ARN) for the log group that you want to Amazon Route 53 to send query logs to. This is the format of the ARN:

arn:aws:logs:region:account-id:log-group:log_group_name

To get the ARN for a log group, you can use the CloudWatch console, the DescribeLogGroups API action, the describe-log-groups command, or the applicable command in one of the Amazon Web Services SDKs.

- type: string - parameters: - - $ref: "#/components/parameters/X-Amz-Content-Sha256" - - $ref: "#/components/parameters/X-Amz-Date" - - $ref: "#/components/parameters/X-Amz-Algorithm" - - $ref: "#/components/parameters/X-Amz-Credential" - - $ref: "#/components/parameters/X-Amz-Security-Token" - - $ref: "#/components/parameters/X-Amz-Signature" - - $ref: "#/components/parameters/X-Amz-SignedHeaders" - get: - operationId: ListQueryLoggingConfigs - description:

Lists the configurations for DNS query logging that are associated with the current Amazon Web Services account or the configuration that is associated with a specified hosted zone.

For more information about DNS query logs, see CreateQueryLoggingConfig. Additional information, including the format of DNS query logs, appears in Logging DNS Queries in the Amazon Route 53 Developer Guide.

- responses: - "200": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/ListQueryLoggingConfigsResponse" - "480": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - "481": - description: InvalidPaginationToken - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidPaginationToken" - "482": - description: NoSuchHostedZone - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchHostedZone" - parameters: - - name: hostedzoneid - in: query - required: false - description:

(Optional) If you want to list the query logging configuration that is associated with a hosted zone, specify the ID in HostedZoneId.

If you don't specify a hosted zone ID, ListQueryLoggingConfigs returns all of the configurations that are associated with the current Amazon Web Services account.

- schema: - type: string - maxLength: 32 - - name: nexttoken - in: query - required: false - description:

(Optional) If the current Amazon Web Services account has more than MaxResults query logging configurations, use NextToken to get the second and subsequent pages of results.

For the first ListQueryLoggingConfigs 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.

- schema: - type: string - maxLength: 1024 - - name: maxresults - in: query - required: false - description:

(Optional) The maximum number of query logging configurations that you want Amazon Route 53 to return in response to the current request. If the current Amazon Web Services account has more than MaxResults configurations, use the value of NextToken in the response to get the next page of results.

If you don't specify a value for MaxResults, Route 53 returns up to 100 configurations.

- schema: - type: string - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /2013-04-01/delegationset: - post: - operationId: CreateReusableDelegationSet - description:

Creates a delegation set (a group of four name servers) that can be reused by multiple hosted zones that were created by the same Amazon Web Services account.

You can also create a reusable delegation set that uses the four name servers that are associated with an existing hosted zone. Specify the hosted zone ID in the CreateReusableDelegationSet request.

You can't associate a reusable delegation set with a private hosted zone.

For information about using a reusable delegation set to configure white label name servers, see Configuring White Label Name Servers.

The process for migrating existing hosted zones to use a reusable delegation set is comparable to the process for configuring white label name servers. You need to perform the following steps:

  1. Create a reusable delegation set.

  2. Recreate hosted zones, and reduce the TTL to 60 seconds or less.

  3. Recreate resource record sets in the new hosted zones.

  4. Change the registrar's name servers to use the name servers for the new hosted zones.

  5. Monitor traffic for the website or application.

  6. Change TTLs back to their original values.

If you want to migrate existing hosted zones to use a reusable delegation set, the existing hosted zones can't use any of the name servers that are assigned to the reusable delegation set. If one or more hosted zones do use one or more name servers that are assigned to the reusable delegation set, you can do one of the following:

  • For small numbers of hosted zones—up to a few hundred—it's relatively easy to create reusable delegation sets until you get one that has four name servers that don't overlap with any of the name servers in your hosted zones.

  • For larger numbers of hosted zones, the easiest solution is to use more than one reusable delegation set.

  • For larger numbers of hosted zones, you can also migrate hosted zones that have overlapping name servers to hosted zones that don't have overlapping name servers, then migrate the hosted zones again to use the reusable delegation set.

- responses: - "201": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/CreateReusableDelegationSetResponse" - "480": - description: DelegationSetAlreadyCreated - content: - text/xml: - schema: - $ref: "#/components/schemas/DelegationSetAlreadyCreated" - "481": - description: LimitsExceeded - content: - text/xml: - schema: - $ref: "#/components/schemas/LimitsExceeded" - "482": - description: HostedZoneNotFound - content: - text/xml: - schema: - $ref: "#/components/schemas/HostedZoneNotFound" - "483": - description: InvalidArgument - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidArgument" - "484": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - "485": - description: DelegationSetNotAvailable - content: - text/xml: - schema: - $ref: "#/components/schemas/DelegationSetNotAvailable" - "486": - description: DelegationSetAlreadyReusable - content: - text/xml: - schema: - $ref: "#/components/schemas/DelegationSetAlreadyReusable" - parameters: [] - requestBody: - required: true - content: - text/xml: - schema: - type: object - required: - - CallerReference - properties: - CallerReference: - description: A unique string that identifies the request, and that allows you to retry failed CreateReusableDelegationSet requests without the risk of executing the operation twice. You must use a unique CallerReference string every time you submit a CreateReusableDelegationSet request. CallerReference can be any unique string, for example a date/time stamp. - type: string - minLength: 1 - maxLength: 128 - HostedZoneId: - description: If you want to mark the delegation set for an existing hosted zone as reusable, the ID for that hosted zone. - type: string - maxLength: 32 - parameters: - - $ref: "#/components/parameters/X-Amz-Content-Sha256" - - $ref: "#/components/parameters/X-Amz-Date" - - $ref: "#/components/parameters/X-Amz-Algorithm" - - $ref: "#/components/parameters/X-Amz-Credential" - - $ref: "#/components/parameters/X-Amz-Security-Token" - - $ref: "#/components/parameters/X-Amz-Signature" - - $ref: "#/components/parameters/X-Amz-SignedHeaders" - get: - operationId: ListReusableDelegationSets - description: Retrieves a list of the reusable delegation sets that are associated with the current Amazon Web Services account. - responses: - "200": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/ListReusableDelegationSetsResponse" - "480": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - parameters: - - name: marker - in: query - required: false - description:

If the value of IsTruncated in the previous response was true, you have more reusable delegation sets. To get another group, submit another ListReusableDelegationSets request.

For the value of marker, specify the value of NextMarker from the previous response, which is the ID of the first reusable delegation set that Amazon Route 53 will return if you submit another request.

If the value of IsTruncated in the previous response was false, there are no more reusable delegation sets to get.

- schema: - type: string - maxLength: 64 - - name: maxitems - in: query - required: false - description: The number of reusable delegation sets that you want Amazon Route 53 to return in the response to this request. If you specify a value greater than 100, Route 53 returns only the first 100 reusable delegation sets. - schema: - type: string - /2013-04-01/trafficpolicy: - post: - operationId: CreateTrafficPolicy - description: Creates a traffic policy, which you use to create multiple DNS resource record sets for one domain name (such as example.com) or one subdomain name (such as www.example.com). - responses: - "201": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/CreateTrafficPolicyResponse" - "480": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - "481": - description: TooManyTrafficPolicies - content: - text/xml: - schema: - $ref: "#/components/schemas/TooManyTrafficPolicies" - "482": - description: TrafficPolicyAlreadyExists - content: - text/xml: - schema: - $ref: "#/components/schemas/TrafficPolicyAlreadyExists" - "483": - description: InvalidTrafficPolicyDocument - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidTrafficPolicyDocument" - parameters: [] - requestBody: - required: true - content: - text/xml: - schema: - type: object - required: - - Name - - Document - properties: - Name: - description: The name of the traffic policy. - type: string - maxLength: 512 - Document: - description: The definition of this traffic policy in JSON format. For more information, see Traffic Policy Document Format. - type: string - maxLength: 102400 - Comment: - description: (Optional) Any comments that you want to include about the traffic policy. - type: string - maxLength: 1024 - parameters: - - $ref: "#/components/parameters/X-Amz-Content-Sha256" - - $ref: "#/components/parameters/X-Amz-Date" - - $ref: "#/components/parameters/X-Amz-Algorithm" - - $ref: "#/components/parameters/X-Amz-Credential" - - $ref: "#/components/parameters/X-Amz-Security-Token" - - $ref: "#/components/parameters/X-Amz-Signature" - - $ref: "#/components/parameters/X-Amz-SignedHeaders" - /2013-04-01/trafficpolicyinstance: - post: - operationId: CreateTrafficPolicyInstance - description: Creates resource record sets in a specified hosted zone based on the settings in a specified traffic policy version. In addition, CreateTrafficPolicyInstance associates the resource record sets with a specified domain name (such as example.com) or subdomain name (such as www.example.com). Amazon Route 53 responds to DNS queries for the domain or subdomain name by using the resource record sets that CreateTrafficPolicyInstance created. - responses: - "201": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/CreateTrafficPolicyInstanceResponse" - "480": - description: NoSuchHostedZone - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchHostedZone" - "481": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - "482": - description: TooManyTrafficPolicyInstances - content: - text/xml: - schema: - $ref: "#/components/schemas/TooManyTrafficPolicyInstances" - "483": - description: NoSuchTrafficPolicy - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchTrafficPolicy" - "484": - description: TrafficPolicyInstanceAlreadyExists - content: - text/xml: - schema: - $ref: "#/components/schemas/TrafficPolicyInstanceAlreadyExists" - parameters: [] - requestBody: - required: true - content: - text/xml: - schema: - type: object - required: - - HostedZoneId - - Name - - TTL - - TrafficPolicyId - - TrafficPolicyVersion - properties: - HostedZoneId: - description: The ID of the hosted zone that you want Amazon Route 53 to create resource record sets in by using the configuration in a traffic policy. - type: string - maxLength: 32 - Name: - description: The domain name (such as example.com) or subdomain name (such as www.example.com) for which Amazon Route 53 responds to DNS queries by using the resource record sets that Route 53 creates for this traffic policy instance. - type: string - maxLength: 1024 - TTL: - description: (Optional) The TTL that you want Amazon Route 53 to assign to all of the resource record sets that it creates in the specified hosted zone. - type: integer - minimum: 0 - maximum: 2147483647 - TrafficPolicyId: - description: The ID of the traffic policy that you want to use to create resource record sets in the specified hosted zone. - type: string - minLength: 1 - maxLength: 36 - TrafficPolicyVersion: - description: The version of the traffic policy that you want to use to create resource record sets in the specified hosted zone. - type: integer - minimum: 1 - maximum: 1000 - parameters: - - $ref: "#/components/parameters/X-Amz-Content-Sha256" - - $ref: "#/components/parameters/X-Amz-Date" - - $ref: "#/components/parameters/X-Amz-Algorithm" - - $ref: "#/components/parameters/X-Amz-Credential" - - $ref: "#/components/parameters/X-Amz-Security-Token" - - $ref: "#/components/parameters/X-Amz-Signature" - - $ref: "#/components/parameters/X-Amz-SignedHeaders" - "/2013-04-01/trafficpolicy/{Id}": - post: - operationId: CreateTrafficPolicyVersion - description: Creates a new version of an existing traffic policy. When you create a new version of a traffic policy, you specify the ID of the traffic policy that you want to update and a JSON-formatted document that describes the new version. You use traffic policies to create multiple DNS resource record sets for one domain name (such as example.com) or one subdomain name (such as www.example.com). You can create a maximum of 1000 versions of a traffic policy. If you reach the limit and need to create another version, you'll need to start a new traffic policy. - responses: - "201": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/CreateTrafficPolicyVersionResponse" - "480": - description: NoSuchTrafficPolicy - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchTrafficPolicy" - "481": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - "482": - description: TooManyTrafficPolicyVersionsForCurrentPolicy - content: - text/xml: - schema: - $ref: "#/components/schemas/TooManyTrafficPolicyVersionsForCurrentPolicy" - "483": - description: ConcurrentModification - content: - text/xml: - schema: - $ref: "#/components/schemas/ConcurrentModification" - "484": - description: InvalidTrafficPolicyDocument - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidTrafficPolicyDocument" - parameters: - - name: Id - in: path - required: true - description: The ID of the traffic policy for which you want to create a new version. - schema: - type: string - minLength: 1 - maxLength: 36 - requestBody: - required: true - content: - text/xml: - schema: - type: object - required: - - Document - properties: - Document: - description: The definition of this version of the traffic policy, in JSON format. You specified the JSON in the CreateTrafficPolicyVersion request. For more information about the JSON format, see CreateTrafficPolicy. - type: string - maxLength: 102400 - Comment: - description: The comment that you specified in the CreateTrafficPolicyVersion request, if any. - type: string - maxLength: 1024 - parameters: - - $ref: "#/components/parameters/X-Amz-Content-Sha256" - - $ref: "#/components/parameters/X-Amz-Date" - - $ref: "#/components/parameters/X-Amz-Algorithm" - - $ref: "#/components/parameters/X-Amz-Credential" - - $ref: "#/components/parameters/X-Amz-Security-Token" - - $ref: "#/components/parameters/X-Amz-Signature" - - $ref: "#/components/parameters/X-Amz-SignedHeaders" - "/2013-04-01/hostedzone/{Id}/authorizevpcassociation": - post: - operationId: CreateVPCAssociationAuthorization - description:

Authorizes the Amazon Web Services account that created a specified VPC to submit an AssociateVPCWithHostedZone request to associate the VPC with a specified hosted zone that was created by a different account. To submit a CreateVPCAssociationAuthorization request, you must use the account that created the hosted zone. After you authorize the association, use the account that created the VPC to submit an AssociateVPCWithHostedZone request.

If you want to associate multiple VPCs that you created by using one account with a hosted zone that you created by using a different account, you must submit one authorization request for each VPC.

 - responses: - "200": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/CreateVPCAssociationAuthorizationResponse" - "480": - description: ConcurrentModification - content: - text/xml: - schema: - $ref: "#/components/schemas/ConcurrentModification" - "481": - description: TooManyVPCAssociationAuthorizations - content: - text/xml: - schema: - $ref: "#/components/schemas/TooManyVPCAssociationAuthorizations" - "482": - description: NoSuchHostedZone - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchHostedZone" - "483": - description: InvalidVPCId - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidVPCId" - "484": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - parameters: - - name: Id - in: path - required: true - description: The ID of the private hosted zone that you want to authorize associating a VPC with. - schema: - type: string - maxLength: 32 - requestBody: - required: true - content: - text/xml: - schema: - type: object - required: - - VPC - properties: - VPC: - description:

(Private hosted zones only) A complex type that contains information about an Amazon VPC.

If you associate a private hosted zone with an Amazon VPC when you make a CreateHostedZone request, the following parameters are also required.

- type: object - properties: - VPCRegion: - allOf: - - $ref: "#/components/schemas/VPCRegion" - - description: (Private hosted zones only) The region that an Amazon VPC was created in. - VPCId: - $ref: "#/components/schemas/VPCId" - parameters: - - $ref: "#/components/parameters/X-Amz-Content-Sha256" - - $ref: "#/components/parameters/X-Amz-Date" - - $ref: "#/components/parameters/X-Amz-Algorithm" - - $ref: "#/components/parameters/X-Amz-Credential" - - $ref: "#/components/parameters/X-Amz-Security-Token" - - $ref: "#/components/parameters/X-Amz-Signature" - - $ref: "#/components/parameters/X-Amz-SignedHeaders" - get: - operationId: ListVPCAssociationAuthorizations - description:

Gets a list of the VPCs that were created by other accounts and that can be associated with a specified hosted zone because you've submitted one or more CreateVPCAssociationAuthorization requests.

The response includes a VPCs element with a VPC child element for each VPC that can be associated with the hosted zone.

- responses: - "200": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/ListVPCAssociationAuthorizationsResponse" - "480": - description: NoSuchHostedZone - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchHostedZone" - "481": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - "482": - description: InvalidPaginationToken - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidPaginationToken" - parameters: - - name: Id - in: path - required: true - description: The ID of the hosted zone for which you want a list of VPCs that can be associated with the hosted zone. - schema: - type: string - maxLength: 32 - - name: nexttoken - in: query - required: false - description: " Optional: If a response includes a NextToken element, there are more VPCs that can be associated with the specified hosted zone. To get the next page of results, submit another request, and include the value of NextToken from the response in the nexttoken parameter in another ListVPCAssociationAuthorizations request." - schema: - type: string - maxLength: 1024 - - name: maxresults - in: query - required: false - description: " Optional: An integer that specifies the maximum number of VPCs that you want Amazon Route 53 to return. If you don't specify a value for MaxResults, Route 53 returns up to 50 VPCs per page." - schema: - type: string - "/2013-04-01/keysigningkey/{HostedZoneId}/{Name}/deactivate": - post: - operationId: DeactivateKeySigningKey - description: Deactivates a key-signing key (KSK) so that it will not be used for signing by DNSSEC. This operation changes the KSK status to INACTIVE. - responses: - "200": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/DeactivateKeySigningKeyResponse" - "480": - description: ConcurrentModification - content: - text/xml: - schema: - $ref: "#/components/schemas/ConcurrentModification" - "481": - description: NoSuchKeySigningKey - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchKeySigningKey" - "482": - description: InvalidKeySigningKeyStatus - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidKeySigningKeyStatus" - "483": - description: InvalidSigningStatus - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidSigningStatus" - "484": - description: KeySigningKeyInUse - content: - text/xml: - schema: - $ref: "#/components/schemas/KeySigningKeyInUse" - "485": - description: KeySigningKeyInParentDSRecord - content: - text/xml: - schema: - $ref: "#/components/schemas/KeySigningKeyInParentDSRecord" - "486": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - parameters: - - name: HostedZoneId - in: path - required: true - description: A unique string used to identify a hosted zone. - schema: - type: string - maxLength: 32 - - name: Name - in: path - required: true - description: A string used to identify a key-signing key (KSK). - schema: - type: string - minLength: 3 - maxLength: 128 - parameters: - - $ref: "#/components/parameters/X-Amz-Content-Sha256" - - $ref: "#/components/parameters/X-Amz-Date" - - $ref: "#/components/parameters/X-Amz-Algorithm" - - $ref: "#/components/parameters/X-Amz-Credential" - - $ref: "#/components/parameters/X-Amz-Security-Token" - - $ref: "#/components/parameters/X-Amz-Signature" - - $ref: "#/components/parameters/X-Amz-SignedHeaders" - "/2013-04-01/healthcheck/{HealthCheckId}": - delete: - operationId: DeleteHealthCheck - description:

Deletes a health check.

Amazon Route 53 does not prevent you from deleting a health check even if the health check is associated with one or more resource record sets. If you delete a health check and you don't update the associated resource record sets, the future status of the health check can't be predicted and may change. This will affect the routing of DNS queries for your DNS failover configuration. For more information, see Replacing and Deleting Health Checks in the Amazon Route 53 Developer Guide.

If you're using Cloud Map and you configured Cloud Map to create a Route 53 health check when you register an instance, you can't use the Route 53 DeleteHealthCheck command to delete the health check. The health check is deleted automatically when you deregister the instance; there can be a delay of several hours before the health check is deleted from Route 53.

- responses: - "200": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/DeleteHealthCheckResponse" - "480": - description: NoSuchHealthCheck - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchHealthCheck" - "481": - description: HealthCheckInUse - content: - text/xml: - schema: - $ref: "#/components/schemas/HealthCheckInUse" - "482": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - parameters: - - name: HealthCheckId - in: path - required: true - description: The ID of the health check that you want to delete. - schema: - type: string - maxLength: 64 - parameters: - - $ref: "#/components/parameters/X-Amz-Content-Sha256" - - $ref: "#/components/parameters/X-Amz-Date" - - $ref: "#/components/parameters/X-Amz-Algorithm" - - $ref: "#/components/parameters/X-Amz-Credential" - - $ref: "#/components/parameters/X-Amz-Security-Token" - - $ref: "#/components/parameters/X-Amz-Signature" - - $ref: "#/components/parameters/X-Amz-SignedHeaders" - get: - operationId: GetHealthCheck - description: Gets information about a specified health check. - responses: - "200": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/GetHealthCheckResponse" - "480": - description: NoSuchHealthCheck - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchHealthCheck" - "481": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - "482": - description: IncompatibleVersion - content: - text/xml: - schema: - $ref: "#/components/schemas/IncompatibleVersion" - parameters: - - name: HealthCheckId - in: path - required: true - description: The identifier that Amazon Route 53 assigned to the health check when you created it. When you add or update a resource record set, you use this value to specify which health check to use. The value can be up to 64 characters long. - schema: - type: string - maxLength: 64 - post: - operationId: UpdateHealthCheck - description:

Updates an existing health check. Note that some values can't be updated.

For more information about updating health checks, see Creating, Updating, and Deleting Health Checks in the Amazon Route 53 Developer Guide.

- responses: - "200": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/UpdateHealthCheckResponse" - "480": - description: NoSuchHealthCheck - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchHealthCheck" - "481": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - "482": - description: HealthCheckVersionMismatch - content: - text/xml: - schema: - $ref: "#/components/schemas/HealthCheckVersionMismatch" - parameters: - - name: HealthCheckId - in: path - required: true - description: The ID for the health check for which you want detailed information. When you created the health check, CreateHealthCheck returned the ID in the response, in the HealthCheckId element. - schema: - type: string - maxLength: 64 - requestBody: - required: true - content: - text/xml: - schema: - type: object - properties: - HealthCheckVersion: - description:

A sequential counter that Amazon Route 53 sets to 1 when you create a health check and increments by 1 each time you update settings for the health check.

We recommend that you use GetHealthCheck or ListHealthChecks to get the current value of HealthCheckVersion for the health check that you want to update, and that you include that value in your UpdateHealthCheck request. This prevents Route 53 from overwriting an intervening update:

  • If the value in the UpdateHealthCheck request matches the value of HealthCheckVersion in the health check, Route 53 updates the health check with the new settings.

  • If the value of HealthCheckVersion in the health check is greater, the health check was changed after you got the version number. Route 53 does not update the health check, and it returns a HealthCheckVersionMismatch error.

- type: integer - minimum: 1 - IPAddress: - description: "

The IPv4 or IPv6 IP address for the endpoint that you want Amazon Route 53 to perform health checks on. If you don't specify a value for IPAddress, Route 53 sends a DNS request to resolve the domain name that you specify in FullyQualifiedDomainName at the interval that you specify in RequestInterval. Using an IP address that is returned by DNS, Route 53 then checks the health of the endpoint.

Use one of the following formats for the value of IPAddress:

  • IPv4 address: four values between 0 and 255, separated by periods (.), for example, 192.0.2.44.

  • IPv6 address: eight groups of four hexadecimal values, separated by colons (:), for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345. You can also shorten IPv6 addresses as described in RFC 5952, for example, 2001:db8:85a3::abcd:1:2345.

If the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with your EC2 instance, and specify the Elastic IP address for IPAddress. This ensures that the IP address of your instance never changes. For more information, see the applicable documentation:

If a health check already has a value for IPAddress, you can change the value. However, you can't update an existing health check to add or remove the value of IPAddress.

For more information, see FullyQualifiedDomainName.

Constraints: Route 53 can't check the health of endpoints for which the IP address is in local, private, non-routable, or multicast ranges. For more information about IP addresses for which you can't create health checks, see the following documents:

" - type: string - 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]))$) - maxLength: 45 - Port: - description:

The port on the endpoint that you want Amazon Route 53 to perform health checks on.

Don't specify a value for Port when you specify a value for Type of CLOUDWATCH_METRIC or CALCULATED.

 - type: integer - minimum: 1 - maximum: 65535 - ResourcePath: - description:

The path that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example the file /docs/route53-health-check.html. You can also include query string parameters, for example, /welcome.html?language=jp&login=y.

Specify this value only if you want to change it.

- type: string - maxLength: 255 - FullyQualifiedDomainName: - description:

Amazon Route 53 behavior depends on whether you specify a value for IPAddress.

If a health check already has a value for IPAddress, you can change the value. However, you can't update an existing health check to add or remove the value of IPAddress.

If you specify a value for IPAddress:

Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of FullyQualifiedDomainName in the Host header for all health checks except TCP health checks. This is typically the fully qualified DNS name of the endpoint on which you want Route 53 to perform health checks.

When Route 53 checks the health of an endpoint, here is how it constructs the Host header:

  • If you specify a value of 80 for Port and HTTP or HTTP_STR_MATCH for Type, Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

  • If you specify a value of 443 for Port and HTTPS or HTTPS_STR_MATCH for Type, Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

  • If you specify another value for Port and any value except TCP for Type, Route 53 passes FullyQualifiedDomainName:Port to the endpoint in the Host header.

If you don't specify a value for FullyQualifiedDomainName, Route 53 substitutes the value of IPAddress in the Host header in each of the above cases.

If you don't specify a value for IPAddress:

If you don't specify a value for IPAddress, Route 53 sends a DNS request to the domain that you specify in FullyQualifiedDomainName at the interval you specify in RequestInterval. Using an IPv4 address that is returned by DNS, Route 53 then checks the health of the endpoint.

If you don't specify a value for IPAddress, Route 53 uses only IPv4 to send health checks to the endpoint. If there's no resource record set with a type of A for the name that you specify for FullyQualifiedDomainName, the health check fails with a "DNS resolution failed" error.

If you want to check the health of weighted, latency, or failover resource record sets and you choose to specify the endpoint only by FullyQualifiedDomainName, we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName, specify the domain name of the server (such as us-east-2-www.example.com), not the name of the resource record sets (www.example.com).

In this configuration, if the value of FullyQualifiedDomainName matches the name of the resource record sets and you then associate the health check with those resource record sets, health check results will be unpredictable.

In addition, if the value of Type is HTTP, HTTPS, HTTP_STR_MATCH, or HTTPS_STR_MATCH, Route 53 passes the value of FullyQualifiedDomainName in the Host header, as it does when you specify a value for IPAddress. If the value of Type is TCP, Route 53 doesn't pass a Host header.

- type: string - maxLength: 255 - SearchString: - description: If the value of Type is HTTP_STR_MATCH or HTTPS_STR_MATCH, the string that you want Amazon Route 53 to search for in the response body from the specified resource. If the string appears in the response body, Route 53 considers the resource healthy. (You can't change the value of Type when you update a health check.) - type: string - maxLength: 255 - FailureThreshold: - description:

The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.

If you don't specify a value for FailureThreshold, the default value is three health checks.

- type: integer - minimum: 1 - maximum: 10 - Inverted: - description: Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider a health check unhealthy when it otherwise would be considered healthy. - type: boolean - Disabled: - description:

Stops Route 53 from performing health checks. When you disable a health check, here's what happens:

  • Health checks that check the health of endpoints: Route 53 stops submitting requests to your application, server, or other resource.

  • Calculated health checks: Route 53 stops aggregating the status of the referenced health checks.

  • Health checks that monitor CloudWatch alarms: Route 53 stops monitoring the corresponding CloudWatch metrics.

After you disable a health check, Route 53 considers the status of the health check to always be healthy. If you configured DNS failover, Route 53 continues to route traffic to the corresponding resources. If you want to stop routing traffic to a resource, change the value of Inverted.

Charges for a health check still apply when the health check is disabled. For more information, see Amazon Route 53 Pricing.

- type: boolean - HealthThreshold: - description:

The number of child health checks that are associated with a CALCULATED health that Amazon Route 53 must consider healthy for the CALCULATED health check to be considered healthy. To specify the child health checks that you want to associate with a CALCULATED health check, use the ChildHealthChecks and ChildHealthCheck elements.

Note the following:

  • If you specify a number greater than the number of child health checks, Route 53 always considers this health check to be unhealthy.

  • If you specify 0, Route 53 always considers this health check to be healthy.

- type: integer - minimum: 0 - maximum: 256 - ChildHealthChecks: - description: A complex type that contains one ChildHealthCheck element for each health check that you want to associate with a CALCULATED health check. - type: array - items: - allOf: - - $ref: "#/components/schemas/HealthCheckId" - - xml: - name: ChildHealthCheck - maxItems: 256 - EnableSNI: - description:

Specify whether you want Amazon Route 53 to send the value of FullyQualifiedDomainName to the endpoint in the client_hello message during TLS negotiation. This allows the endpoint to respond to HTTPS health check requests with the applicable SSL/TLS certificate.

Some endpoints require that HTTPS requests include the host name in the client_hello message. If you don't enable SNI, the status of the health check will be SSL alert handshake_failure. A health check can also have that status for other reasons. If SNI is enabled and you're still getting the error, check the SSL/TLS configuration on your endpoint and confirm that your certificate is valid.

The SSL/TLS certificate on your endpoint includes a domain name in the Common Name field and possibly several more in the Subject Alternative Names field. One of the domain names in the certificate should match the value that you specify for FullyQualifiedDomainName. If the endpoint responds to the client_hello message with a certificate that does not include the domain name that you specified in FullyQualifiedDomainName, a health checker will retry the handshake. In the second attempt, the health checker will omit FullyQualifiedDomainName from the client_hello message.

- type: boolean - Regions: - description: A complex type that contains one Region element for each region that you want Amazon Route 53 health checkers to check the specified endpoint from. - type: array - items: - allOf: - - $ref: "#/components/schemas/HealthCheckRegion" - - xml: - name: Region - minItems: 3 - maxItems: 64 - AlarmIdentifier: - description: A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether the specified health check is healthy. - type: object - properties: - Region: - allOf: - - $ref: "#/components/schemas/CloudWatchRegion" - - description:

For the CloudWatch alarm that you want Route 53 health checkers to use to determine whether this health check is healthy, the region that the alarm was created in.

For the current list of CloudWatch regions, see Amazon CloudWatch endpoints and quotas in the Amazon Web Services General Reference.

- Name: - allOf: - - $ref: "#/components/schemas/AlarmName" - - description: "

The name of the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.

Route 53 supports CloudWatch alarms with the following features:

  • Standard-resolution metrics. High-resolution metrics aren't supported. For more information, see High-Resolution Metrics in the Amazon CloudWatch User Guide.

  • Statistics: Average, Minimum, Maximum, Sum, and SampleCount. Extended statistics aren't supported.

" - InsufficientDataHealthStatus: - description: "

When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign to the health check:

  • Healthy: Route 53 considers the health check to be healthy.

  • Unhealthy: Route 53 considers the health check to be unhealthy.

  • LastKnownStatus: By default, Route 53 uses the status of the health check from the last time CloudWatch had sufficient data to determine the alarm state. For new health checks that have no last known status, the status for the health check is healthy.

" - type: string - enum: - - Healthy - - Unhealthy - - LastKnownStatus - ResetElements: - description: '

A complex type that contains one ResettableElementName element for each element that you want to reset to the default value. Valid values for ResettableElementName include the following:

' - type: array - items: - allOf: - - $ref: "#/components/schemas/ResettableElementName" - - xml: - name: ResettableElementName - maxItems: 64 - "/2013-04-01/hostedzone/{Id}": - delete: - operationId: DeleteHostedZone - description:

Deletes a hosted zone.

If the hosted zone was created by another service, such as Cloud Map, see Deleting Public Hosted Zones That Were Created by Another Service in the Amazon Route 53 Developer Guide for information about how to delete it. (The process is the same for public and private hosted zones that were created by another service.)

If you want to keep your domain registration but you want to stop routing internet traffic to your website or web application, we recommend that you delete resource record sets in the hosted zone instead of deleting the hosted zone.

If you delete a hosted zone, you can't undelete it. You must create a new hosted zone and update the name servers for your domain registration, which can require up to 48 hours to take effect. (If you delegated responsibility for a subdomain to a hosted zone and you delete the child hosted zone, you must update the name servers in the parent hosted zone.) In addition, if you delete a hosted zone, someone could hijack the domain and route traffic to their own resources using your domain name.

If you want to avoid the monthly charge for the hosted zone, you can transfer DNS service for the domain to a free DNS service. When you transfer DNS service, you have to update the name servers for the domain registration. If the domain is registered with Route 53, see UpdateDomainNameservers for information about how to replace Route 53 name servers with name servers for the new DNS service. If the domain is registered with another registrar, use the method provided by the registrar to update name servers for the domain registration. For more information, perform an internet search on "free DNS service."

You can delete a hosted zone only if it contains only the default SOA record and NS resource record sets. If the hosted zone contains other resource record sets, you must delete them before you can delete the hosted zone. If you try to delete a hosted zone that contains other resource record sets, the request fails, and Route 53 returns a HostedZoneNotEmpty error. For information about deleting records from your hosted zone, see ChangeResourceRecordSets.

To verify that the hosted zone has been deleted, do one of the following:

  • Use the GetHostedZone action to request information about the hosted zone.

  • Use the ListHostedZones action to get a list of the hosted zones associated with the current Amazon Web Services account.

- responses: - "200": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/DeleteHostedZoneResponse" - "480": - description: NoSuchHostedZone - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchHostedZone" - "481": - description: HostedZoneNotEmpty - content: - text/xml: - schema: - $ref: "#/components/schemas/HostedZoneNotEmpty" - "482": - description: PriorRequestNotComplete - content: - text/xml: - schema: - $ref: "#/components/schemas/PriorRequestNotComplete" - "483": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - "484": - description: InvalidDomainName - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidDomainName" - parameters: - - name: Id - in: path - required: true - description: The ID of the hosted zone you want to delete. - schema: - type: string - maxLength: 32 - parameters: - - $ref: "#/components/parameters/X-Amz-Content-Sha256" - - $ref: "#/components/parameters/X-Amz-Date" - - $ref: "#/components/parameters/X-Amz-Algorithm" - - $ref: "#/components/parameters/X-Amz-Credential" - - $ref: "#/components/parameters/X-Amz-Security-Token" - - $ref: "#/components/parameters/X-Amz-Signature" - - $ref: "#/components/parameters/X-Amz-SignedHeaders" - get: - operationId: GetHostedZone - description: Gets information about a specified hosted zone including the four name servers assigned to the hosted zone. - responses: - "200": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/GetHostedZoneResponse" - "480": - description: NoSuchHostedZone - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchHostedZone" - "481": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - parameters: - - name: Id - in: path - required: true - description: The ID of the hosted zone that you want to get information about. - schema: - type: string - maxLength: 32 - post: - operationId: UpdateHostedZoneComment - description: Updates the comment for a specified hosted zone. - responses: - "200": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/UpdateHostedZoneCommentResponse" - "480": - description: NoSuchHostedZone - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchHostedZone" - "481": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - "482": - description: PriorRequestNotComplete - content: - text/xml: - schema: - $ref: "#/components/schemas/PriorRequestNotComplete" - parameters: - - name: Id - in: path - required: true - description: The ID for the hosted zone that you want to update the comment for. - schema: - type: string - maxLength: 32 - requestBody: - required: true - content: - text/xml: - schema: - type: object - properties: - Comment: - description: The new comment for the hosted zone. If you don't specify a value for Comment, Amazon Route 53 deletes the existing value of the Comment element, if any. - type: string - maxLength: 256 - "/2013-04-01/keysigningkey/{HostedZoneId}/{Name}": - delete: - operationId: DeleteKeySigningKey - description:

Deletes a key-signing key (KSK). Before you can delete a KSK, you must deactivate it. The KSK must be deactivated before you can delete it regardless of whether the hosted zone is enabled for DNSSEC signing.

You can use DeactivateKeySigningKey to deactivate the key before you delete it.

Use GetDNSSEC to verify that the KSK is in an INACTIVE status.

- responses: - "200": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/DeleteKeySigningKeyResponse" - "480": - description: ConcurrentModification - content: - text/xml: - schema: - $ref: "#/components/schemas/ConcurrentModification" - "481": - description: NoSuchKeySigningKey - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchKeySigningKey" - "482": - description: InvalidKeySigningKeyStatus - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidKeySigningKeyStatus" - "483": - description: InvalidSigningStatus - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidSigningStatus" - "484": - description: InvalidKMSArn - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidKMSArn" - "485": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - parameters: - - name: HostedZoneId - in: path - required: true - description: A unique string used to identify a hosted zone. - schema: - type: string - maxLength: 32 - - name: Name - in: path - required: true - description: A string used to identify a key-signing key (KSK). - schema: - type: string - minLength: 3 - maxLength: 128 - parameters: - - $ref: "#/components/parameters/X-Amz-Content-Sha256" - - $ref: "#/components/parameters/X-Amz-Date" - - $ref: "#/components/parameters/X-Amz-Algorithm" - - $ref: "#/components/parameters/X-Amz-Credential" - - $ref: "#/components/parameters/X-Amz-Security-Token" - - $ref: "#/components/parameters/X-Amz-Signature" - - $ref: "#/components/parameters/X-Amz-SignedHeaders" - "/2013-04-01/queryloggingconfig/{Id}": - delete: - operationId: DeleteQueryLoggingConfig - description:

Deletes a configuration for DNS query logging. If you delete a configuration, Amazon Route 53 stops sending query logs to CloudWatch Logs. Route 53 doesn't delete any logs that are already in CloudWatch Logs.

For more information about DNS query logs, see CreateQueryLoggingConfig.

- responses: - "200": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/DeleteQueryLoggingConfigResponse" - "480": - description: ConcurrentModification - content: - text/xml: - schema: - $ref: "#/components/schemas/ConcurrentModification" - "481": - description: NoSuchQueryLoggingConfig - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchQueryLoggingConfig" - "482": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - parameters: - - name: Id - in: path - required: true - description: "The ID of the configuration that you want to delete. " - schema: - type: string - minLength: 1 - maxLength: 36 - parameters: - - $ref: "#/components/parameters/X-Amz-Content-Sha256" - - $ref: "#/components/parameters/X-Amz-Date" - - $ref: "#/components/parameters/X-Amz-Algorithm" - - $ref: "#/components/parameters/X-Amz-Credential" - - $ref: "#/components/parameters/X-Amz-Security-Token" - - $ref: "#/components/parameters/X-Amz-Signature" - - $ref: "#/components/parameters/X-Amz-SignedHeaders" - get: - operationId: GetQueryLoggingConfig - description:

Gets information about a specified configuration for DNS query logging.

For more information about DNS query logs, see CreateQueryLoggingConfig and Logging DNS Queries.

- responses: - "200": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/GetQueryLoggingConfigResponse" - "480": - description: NoSuchQueryLoggingConfig - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchQueryLoggingConfig" - "481": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - parameters: - - name: Id - in: path - required: true - description: The ID of the configuration for DNS query logging that you want to get information about. - schema: - type: string - minLength: 1 - maxLength: 36 - "/2013-04-01/delegationset/{Id}": - delete: - operationId: DeleteReusableDelegationSet - description:

Deletes a reusable delegation set.

You can delete a reusable delegation set only if it isn't associated with any hosted zones.

To verify that the reusable delegation set is not associated with any hosted zones, submit a GetReusableDelegationSet request and specify the ID of the reusable delegation set that you want to delete.

- responses: - "200": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/DeleteReusableDelegationSetResponse" - "480": - description: NoSuchDelegationSet - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchDelegationSet" - "481": - description: DelegationSetInUse - content: - text/xml: - schema: - $ref: "#/components/schemas/DelegationSetInUse" - "482": - description: DelegationSetNotReusable - content: - text/xml: - schema: - $ref: "#/components/schemas/DelegationSetNotReusable" - "483": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - parameters: - - name: Id - in: path - required: true - description: The ID of the reusable delegation set that you want to delete. - schema: - type: string - maxLength: 32 - parameters: - - $ref: "#/components/parameters/X-Amz-Content-Sha256" - - $ref: "#/components/parameters/X-Amz-Date" - - $ref: "#/components/parameters/X-Amz-Algorithm" - - $ref: "#/components/parameters/X-Amz-Credential" - - $ref: "#/components/parameters/X-Amz-Security-Token" - - $ref: "#/components/parameters/X-Amz-Signature" - - $ref: "#/components/parameters/X-Amz-SignedHeaders" - get: - operationId: GetReusableDelegationSet - description: Retrieves information about a specified reusable delegation set, including the four name servers that are assigned to the delegation set. - responses: - "200": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/GetReusableDelegationSetResponse" - "480": - description: NoSuchDelegationSet - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchDelegationSet" - "481": - description: DelegationSetNotReusable - content: - text/xml: - schema: - $ref: "#/components/schemas/DelegationSetNotReusable" - "482": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - parameters: - - name: Id - in: path - required: true - description: The ID of the reusable delegation set that you want to get a list of name servers for. - schema: - type: string - maxLength: 32 - "/2013-04-01/trafficpolicy/{Id}/{Version}": - delete: - operationId: DeleteTrafficPolicy - description:

Deletes a traffic policy.

When you delete a traffic policy, Route 53 sets a flag on the policy to indicate that it has been deleted. However, Route 53 never fully deletes the traffic policy. Note the following:

  • Deleted traffic policies aren't listed if you run ListTrafficPolicies.

  • There's no way to get a list of deleted policies.

  • If you retain the ID of the policy, you can get information about the policy, including the traffic policy document, by running GetTrafficPolicy.

- responses: - "200": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/DeleteTrafficPolicyResponse" - "480": - description: NoSuchTrafficPolicy - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchTrafficPolicy" - "481": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - "482": - description: TrafficPolicyInUse - content: - text/xml: - schema: - $ref: "#/components/schemas/TrafficPolicyInUse" - "483": - description: ConcurrentModification - content: - text/xml: - schema: - $ref: "#/components/schemas/ConcurrentModification" - parameters: - - name: Id - in: path - required: true - description: The ID of the traffic policy that you want to delete. - schema: - type: string - minLength: 1 - maxLength: 36 - - name: Version - in: path - required: true - description: The version number of the traffic policy that you want to delete. - schema: - type: integer - minimum: 1 - maximum: 1000 - parameters: - - $ref: "#/components/parameters/X-Amz-Content-Sha256" - - $ref: "#/components/parameters/X-Amz-Date" - - $ref: "#/components/parameters/X-Amz-Algorithm" - - $ref: "#/components/parameters/X-Amz-Credential" - - $ref: "#/components/parameters/X-Amz-Security-Token" - - $ref: "#/components/parameters/X-Amz-Signature" - - $ref: "#/components/parameters/X-Amz-SignedHeaders" - get: - operationId: GetTrafficPolicy - description:

Gets information about a specific traffic policy version.

For information about how of deleting a traffic policy affects the response from GetTrafficPolicy, see DeleteTrafficPolicy.

- responses: - "200": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/GetTrafficPolicyResponse" - "480": - description: NoSuchTrafficPolicy - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchTrafficPolicy" - "481": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - parameters: - - name: Id - in: path - required: true - description: The ID of the traffic policy that you want to get information about. - schema: - type: string - minLength: 1 - maxLength: 36 - - name: Version - in: path - required: true - description: The version number of the traffic policy that you want to get information about. - schema: - type: integer - minimum: 1 - maximum: 1000 - post: - operationId: UpdateTrafficPolicyComment - description: Updates the comment for a specified traffic policy version. - responses: - "200": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/UpdateTrafficPolicyCommentResponse" - "480": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - "481": - description: NoSuchTrafficPolicy - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchTrafficPolicy" - "482": - description: ConcurrentModification - content: - text/xml: - schema: - $ref: "#/components/schemas/ConcurrentModification" - parameters: - - name: Id - in: path - required: true - description: The value of Id for the traffic policy that you want to update the comment for. - schema: - type: string - minLength: 1 - maxLength: 36 - - name: Version - in: path - required: true - description: The value of Version for the traffic policy that you want to update the comment for. - schema: - type: integer - minimum: 1 - maximum: 1000 - requestBody: - required: true - content: - text/xml: - schema: - type: object - required: - - Comment - properties: - Comment: - description: The new comment for the specified traffic policy and version. - type: string - maxLength: 1024 - "/2013-04-01/trafficpolicyinstance/{Id}": - delete: - operationId: DeleteTrafficPolicyInstance - description:

Deletes a traffic policy instance and all of the resource record sets that Amazon Route 53 created when you created the instance.

In the Route 53 console, traffic policy instances are known as policy records.

 - responses: - "200": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/DeleteTrafficPolicyInstanceResponse" - "480": - description: NoSuchTrafficPolicyInstance - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchTrafficPolicyInstance" - "481": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - "482": - description: PriorRequestNotComplete - content: - text/xml: - schema: - $ref: "#/components/schemas/PriorRequestNotComplete" - parameters: - - name: Id - in: path - required: true - description:

The ID of the traffic policy instance that you want to delete.

When you delete a traffic policy instance, Amazon Route 53 also deletes all of the resource record sets that were created when you created the traffic policy instance.

 - schema: - type: string - minLength: 1 - maxLength: 36 - parameters: - - $ref: "#/components/parameters/X-Amz-Content-Sha256" - - $ref: "#/components/parameters/X-Amz-Date" - - $ref: "#/components/parameters/X-Amz-Algorithm" - - $ref: "#/components/parameters/X-Amz-Credential" - - $ref: "#/components/parameters/X-Amz-Security-Token" - - $ref: "#/components/parameters/X-Amz-Signature" - - $ref: "#/components/parameters/X-Amz-SignedHeaders" - get: - operationId: GetTrafficPolicyInstance - description:

Gets information about a specified traffic policy instance.

After you submit a CreateTrafficPolicyInstance or an UpdateTrafficPolicyInstance request, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see the State response element.

In the Route 53 console, traffic policy instances are known as policy records.

 - responses: - "200": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/GetTrafficPolicyInstanceResponse" - "480": - description: NoSuchTrafficPolicyInstance - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchTrafficPolicyInstance" - "481": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - parameters: - - name: Id - in: path - required: true - description: The ID of the traffic policy instance that you want to get information about. - schema: - type: string - minLength: 1 - maxLength: 36 - post: - operationId: UpdateTrafficPolicyInstance - description:

Updates the resource record sets in a specified hosted zone that were created based on the settings in a specified traffic policy version.

When you update a traffic policy instance, Amazon Route 53 continues to respond to DNS queries for the root resource record set name (such as example.com) while it replaces one group of resource record sets with another. Route 53 performs the following operations:

  1. Route 53 creates a new group of resource record sets based on the specified traffic policy. This is true regardless of how significant the differences are between the existing resource record sets and the new resource record sets.

  2. When all of the new resource record sets have been created, Route 53 starts to respond to DNS queries for the root resource record set name (such as example.com) by using the new resource record sets.

  3. Route 53 deletes the old group of resource record sets that are associated with the root resource record set name.

- responses: - "200": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/UpdateTrafficPolicyInstanceResponse" - "480": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - "481": - description: NoSuchTrafficPolicy - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchTrafficPolicy" - "482": - description: NoSuchTrafficPolicyInstance - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchTrafficPolicyInstance" - "483": - description: PriorRequestNotComplete - content: - text/xml: - schema: - $ref: "#/components/schemas/PriorRequestNotComplete" - "484": - description: ConflictingTypes - content: - text/xml: - schema: - $ref: "#/components/schemas/ConflictingTypes" - parameters: - - name: Id - in: path - required: true - description: The ID of the traffic policy instance that you want to update. - schema: - type: string - minLength: 1 - maxLength: 36 - requestBody: - required: true - content: - text/xml: - schema: - type: object - required: - - TTL - - TrafficPolicyId - - TrafficPolicyVersion - properties: - TTL: - description: The TTL that you want Amazon Route 53 to assign to all of the updated resource record sets. - type: integer - minimum: 0 - maximum: 2147483647 - TrafficPolicyId: - description: The ID of the traffic policy that you want Amazon Route 53 to use to update resource record sets for the specified traffic policy instance. - type: string - minLength: 1 - maxLength: 36 - TrafficPolicyVersion: - description: The version of the traffic policy that you want Amazon Route 53 to use to update resource record sets for the specified traffic policy instance. - type: integer - minimum: 1 - maximum: 1000 - "/2013-04-01/hostedzone/{Id}/deauthorizevpcassociation": - post: - operationId: DeleteVPCAssociationAuthorization - description:

Removes authorization to submit an AssociateVPCWithHostedZone request to associate a specified VPC with a hosted zone that was created by a different account. You must use the account that created the hosted zone to submit a DeleteVPCAssociationAuthorization request.

Sending this request only prevents the Amazon Web Services account that created the VPC from associating the VPC with the Amazon Route 53 hosted zone in the future. If the VPC is already associated with the hosted zone, DeleteVPCAssociationAuthorization won't disassociate the VPC from the hosted zone. If you want to delete an existing association, use DisassociateVPCFromHostedZone.

 - responses: - "200": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/DeleteVPCAssociationAuthorizationResponse" - "480": - description: ConcurrentModification - content: - text/xml: - schema: - $ref: "#/components/schemas/ConcurrentModification" - "481": - description: VPCAssociationAuthorizationNotFound - content: - text/xml: - schema: - $ref: "#/components/schemas/VPCAssociationAuthorizationNotFound" - "482": - description: NoSuchHostedZone - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchHostedZone" - "483": - description: InvalidVPCId - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidVPCId" - "484": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - parameters: - - name: Id - in: path - required: true - description: When removing authorization to associate a VPC that was created by one Amazon Web Services account with a hosted zone that was created with a different Amazon Web Services account, the ID of the hosted zone. - schema: - type: string - maxLength: 32 - requestBody: - required: true - content: - text/xml: - schema: - type: object - required: - - VPC - properties: - VPC: - description:

(Private hosted zones only) A complex type that contains information about an Amazon VPC.

If you associate a private hosted zone with an Amazon VPC when you make a CreateHostedZone request, the following parameters are also required.

- type: object - properties: - VPCRegion: - allOf: - - $ref: "#/components/schemas/VPCRegion" - - description: (Private hosted zones only) The region that an Amazon VPC was created in. - VPCId: - $ref: "#/components/schemas/VPCId" - parameters: - - $ref: "#/components/parameters/X-Amz-Content-Sha256" - - $ref: "#/components/parameters/X-Amz-Date" - - $ref: "#/components/parameters/X-Amz-Algorithm" - - $ref: "#/components/parameters/X-Amz-Credential" - - $ref: "#/components/parameters/X-Amz-Security-Token" - - $ref: "#/components/parameters/X-Amz-Signature" - - $ref: "#/components/parameters/X-Amz-SignedHeaders" - "/2013-04-01/hostedzone/{Id}/disable-dnssec": - post: - operationId: DisableHostedZoneDNSSEC - description: Disables DNSSEC signing in a specific hosted zone. This action does not deactivate any key-signing keys (KSKs) that are active in the hosted zone. - responses: - "200": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/DisableHostedZoneDNSSECResponse" - "480": - description: NoSuchHostedZone - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchHostedZone" - "481": - description: InvalidArgument - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidArgument" - "482": - description: ConcurrentModification - content: - text/xml: - schema: - $ref: "#/components/schemas/ConcurrentModification" - "483": - description: KeySigningKeyInParentDSRecord - content: - text/xml: - schema: - $ref: "#/components/schemas/KeySigningKeyInParentDSRecord" - "484": - description: DNSSECNotFound - content: - text/xml: - schema: - $ref: "#/components/schemas/DNSSECNotFound" - "485": - description: InvalidKeySigningKeyStatus - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidKeySigningKeyStatus" - "486": - description: InvalidKMSArn - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidKMSArn" - "487": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - parameters: - - name: Id - in: path - required: true - description: A unique string used to identify a hosted zone. - schema: - type: string - maxLength: 32 - parameters: - - $ref: "#/components/parameters/X-Amz-Content-Sha256" - - $ref: "#/components/parameters/X-Amz-Date" - - $ref: "#/components/parameters/X-Amz-Algorithm" - - $ref: "#/components/parameters/X-Amz-Credential" - - $ref: "#/components/parameters/X-Amz-Security-Token" - - $ref: "#/components/parameters/X-Amz-Signature" - - $ref: "#/components/parameters/X-Amz-SignedHeaders" - "/2013-04-01/hostedzone/{Id}/disassociatevpc": - post: - operationId: DisassociateVPCFromHostedZone - description:

Disassociates an Amazon Virtual Private Cloud (Amazon VPC) from an Amazon Route 53 private hosted zone. Note the following:

  • You can't disassociate the last Amazon VPC from a private hosted zone.

  • You can't convert a private hosted zone into a public hosted zone.

  • You can submit a DisassociateVPCFromHostedZone request using either the account that created the hosted zone or the account that created the Amazon VPC.

  • Some services, such as Cloud Map and Amazon Elastic File System (Amazon EFS) automatically create hosted zones and associate VPCs with the hosted zones. A service can create a hosted zone using your account or using its own account. You can disassociate a VPC from a hosted zone only if the service created the hosted zone using your account.

    When you run DisassociateVPCFromHostedZone, if the hosted zone has a value for OwningAccount, you can use DisassociateVPCFromHostedZone. If the hosted zone has a value for OwningService, you can't use DisassociateVPCFromHostedZone.

When revoking access, the hosted zone and the Amazon VPC must belong to the same partition. A partition is a group of Amazon Web Services Regions. Each Amazon Web Services account is scoped to one partition.

The following are the supported partitions:

  • aws - Amazon Web Services Regions

  • aws-cn - China Regions

  • aws-us-gov - Amazon Web Services GovCloud (US) Region

For more information, see Access Management in the Amazon Web Services General Reference.

 - responses: - "200": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/DisassociateVPCFromHostedZoneResponse" - "480": - description: NoSuchHostedZone - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchHostedZone" - "481": - description: InvalidVPCId - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidVPCId" - "482": - description: VPCAssociationNotFound - content: - text/xml: - schema: - $ref: "#/components/schemas/VPCAssociationNotFound" - "483": - description: LastVPCAssociation - content: - text/xml: - schema: - $ref: "#/components/schemas/LastVPCAssociation" - "484": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - parameters: - - name: Id - in: path - required: true - description: The ID of the private hosted zone that you want to disassociate a VPC from. - schema: - type: string - maxLength: 32 - requestBody: - required: true - content: - text/xml: - schema: - type: object - required: - - VPC - properties: - VPC: - description:

(Private hosted zones only) A complex type that contains information about an Amazon VPC.

If you associate a private hosted zone with an Amazon VPC when you make a CreateHostedZone request, the following parameters are also required.

- type: object - properties: - VPCRegion: - allOf: - - $ref: "#/components/schemas/VPCRegion" - - description: (Private hosted zones only) The region that an Amazon VPC was created in. - VPCId: - $ref: "#/components/schemas/VPCId" - Comment: - description: " Optional: A comment about the disassociation request." - type: string - parameters: - - $ref: "#/components/parameters/X-Amz-Content-Sha256" - - $ref: "#/components/parameters/X-Amz-Date" - - $ref: "#/components/parameters/X-Amz-Algorithm" - - $ref: "#/components/parameters/X-Amz-Credential" - - $ref: "#/components/parameters/X-Amz-Security-Token" - - $ref: "#/components/parameters/X-Amz-Signature" - - $ref: "#/components/parameters/X-Amz-SignedHeaders" - "/2013-04-01/hostedzone/{Id}/enable-dnssec": - post: - operationId: EnableHostedZoneDNSSEC - description: Enables DNSSEC signing in a specific hosted zone. - responses: - "200": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/EnableHostedZoneDNSSECResponse" - "480": - description: NoSuchHostedZone - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchHostedZone" - "481": - description: InvalidArgument - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidArgument" - "482": - description: ConcurrentModification - content: - text/xml: - schema: - $ref: "#/components/schemas/ConcurrentModification" - "483": - description: KeySigningKeyWithActiveStatusNotFound - content: - text/xml: - schema: - $ref: "#/components/schemas/KeySigningKeyWithActiveStatusNotFound" - "484": - description: InvalidKMSArn - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidKMSArn" - "485": - description: HostedZonePartiallyDelegated - content: - text/xml: - schema: - $ref: "#/components/schemas/HostedZonePartiallyDelegated" - "486": - description: DNSSECNotFound - content: - text/xml: - schema: - $ref: "#/components/schemas/DNSSECNotFound" - "487": - description: InvalidKeySigningKeyStatus - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidKeySigningKeyStatus" - "488": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - parameters: - - name: Id - in: path - required: true - description: A unique string used to identify a hosted zone. - schema: - type: string - maxLength: 32 - parameters: - - $ref: "#/components/parameters/X-Amz-Content-Sha256" - - $ref: "#/components/parameters/X-Amz-Date" - - $ref: "#/components/parameters/X-Amz-Algorithm" - - $ref: "#/components/parameters/X-Amz-Credential" - - $ref: "#/components/parameters/X-Amz-Security-Token" - - $ref: "#/components/parameters/X-Amz-Signature" - - $ref: "#/components/parameters/X-Amz-SignedHeaders" - "/2013-04-01/accountlimit/{Type}": - get: - operationId: GetAccountLimit - description:

Gets the specified limit for the current account, for example, the maximum number of health checks that you can create using the account.

For the default limit, see Limits in the Amazon Route 53 Developer Guide. To request a higher limit, open a case.

You can also view account limits in Amazon Web Services Trusted Advisor. Sign in to the Amazon Web Services Management Console and open the Trusted Advisor console at https://console.aws.amazon.com/trustedadvisor/. Then choose Service limits in the navigation pane.

 - responses: - "200": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/GetAccountLimitResponse" - "480": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - parameters: - - name: Type - in: path - required: true - description: "

The limit that you want to get. Valid values include the following:

  • MAX_HEALTH_CHECKS_BY_OWNER: The maximum number of health checks that you can create using the current account.

  • MAX_HOSTED_ZONES_BY_OWNER: The maximum number of hosted zones that you can create using the current account.

  • MAX_REUSABLE_DELEGATION_SETS_BY_OWNER: The maximum number of reusable delegation sets that you can create using the current account.

  • MAX_TRAFFIC_POLICIES_BY_OWNER: The maximum number of traffic policies that you can create using the current account.

  • MAX_TRAFFIC_POLICY_INSTANCES_BY_OWNER: The maximum number of traffic policy instances that you can create using the current account. (Traffic policy instances are referred to as traffic flow policy records in the Amazon Route 53 console.)

" - schema: - type: string - enum: - - MAX_HEALTH_CHECKS_BY_OWNER - - MAX_HOSTED_ZONES_BY_OWNER - - MAX_TRAFFIC_POLICY_INSTANCES_BY_OWNER - - MAX_REUSABLE_DELEGATION_SETS_BY_OWNER - - MAX_TRAFFIC_POLICIES_BY_OWNER - parameters: - - $ref: "#/components/parameters/X-Amz-Content-Sha256" - - $ref: "#/components/parameters/X-Amz-Date" - - $ref: "#/components/parameters/X-Amz-Algorithm" - - $ref: "#/components/parameters/X-Amz-Credential" - - $ref: "#/components/parameters/X-Amz-Security-Token" - - $ref: "#/components/parameters/X-Amz-Signature" - - $ref: "#/components/parameters/X-Amz-SignedHeaders" - "/2013-04-01/change/{Id}": - get: - operationId: GetChange - description:

Returns the current status of a change batch request. The status is one of the following values:

  • PENDING indicates that the changes in this request have not propagated to all Amazon Route 53 DNS servers. This is the initial status of all change batch requests.

  • INSYNC indicates that the changes have propagated to all Route 53 DNS servers.

- responses: - "200": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/GetChangeResponse" - "480": - description: NoSuchChange - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchChange" - "481": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - parameters: - - name: Id - in: path - required: true - description: The ID of the change batch request. The value that you specify here is the value that ChangeResourceRecordSets returned in the Id element when you submitted the request. - schema: - type: string - minLength: 1 - maxLength: 6500 - parameters: - - $ref: "#/components/parameters/X-Amz-Content-Sha256" - - $ref: "#/components/parameters/X-Amz-Date" - - $ref: "#/components/parameters/X-Amz-Algorithm" - - $ref: "#/components/parameters/X-Amz-Credential" - - $ref: "#/components/parameters/X-Amz-Security-Token" - - $ref: "#/components/parameters/X-Amz-Signature" - - $ref: "#/components/parameters/X-Amz-SignedHeaders" - /2013-04-01/checkeripranges: - get: - operationId: GetCheckerIpRanges - description:

Route 53 does not perform authorization for this API because it retrieves information that is already available to the public.

GetCheckerIpRanges still works, but we recommend that you download ip-ranges.json, which includes IP address ranges for all Amazon Web Services services. For more information, see IP Address Ranges of Amazon Route 53 Servers in the Amazon Route 53 Developer Guide.

 - responses: - "200": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/GetCheckerIpRangesResponse" - parameters: [] - parameters: - - $ref: "#/components/parameters/X-Amz-Content-Sha256" - - $ref: "#/components/parameters/X-Amz-Date" - - $ref: "#/components/parameters/X-Amz-Algorithm" - - $ref: "#/components/parameters/X-Amz-Credential" - - $ref: "#/components/parameters/X-Amz-Security-Token" - - $ref: "#/components/parameters/X-Amz-Signature" - - $ref: "#/components/parameters/X-Amz-SignedHeaders" - "/2013-04-01/hostedzone/{Id}/dnssec": - get: - operationId: GetDNSSEC - description: Returns information about DNSSEC for a specific hosted zone, including the key-signing keys (KSKs) in the hosted zone. - responses: - "200": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/GetDNSSECResponse" - "480": - description: NoSuchHostedZone - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchHostedZone" - "481": - description: InvalidArgument - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidArgument" - "482": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - parameters: - - name: Id - in: path - required: true - description: A unique string used to identify a hosted zone. - schema: - type: string - maxLength: 32 - parameters: - - $ref: "#/components/parameters/X-Amz-Content-Sha256" - - $ref: "#/components/parameters/X-Amz-Date" - - $ref: "#/components/parameters/X-Amz-Algorithm" - - $ref: "#/components/parameters/X-Amz-Credential" - - $ref: "#/components/parameters/X-Amz-Security-Token" - - $ref: "#/components/parameters/X-Amz-Signature" - - $ref: "#/components/parameters/X-Amz-SignedHeaders" - /2013-04-01/geolocation: - get: - operationId: GetGeoLocation - description:

Gets information about whether a specified geographic location is supported for Amazon Route 53 geolocation resource record sets.

Route 53 does not perform authorization for this API because it retrieves information that is already available to the public.

Use the following syntax to determine whether a continent is supported for geolocation:

GET /2013-04-01/geolocation?continentcode=two-letter abbreviation for a continent

Use the following syntax to determine whether a country is supported for geolocation:

GET /2013-04-01/geolocation?countrycode=two-character country code

Use the following syntax to determine whether a subdivision of a country is supported for geolocation:

GET /2013-04-01/geolocation?countrycode=two-character country code&subdivisioncode=subdivision code

- responses: - "200": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/GetGeoLocationResponse" - "480": - description: NoSuchGeoLocation - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchGeoLocation" - "481": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - parameters: - - name: continentcode - in: query - required: false - description: "

For geolocation resource record sets, a two-letter abbreviation that identifies a continent. Amazon Route 53 supports the following continent codes:

  • AF: Africa

  • AN: Antarctica

  • AS: Asia

  • EU: Europe

  • OC: Oceania

  • NA: North America

  • SA: South America

" - schema: - type: string - minLength: 2 - maxLength: 2 - - name: countrycode - in: query - required: false - description: Amazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1 alpha-2. - schema: - type: string - minLength: 1 - maxLength: 2 - - name: subdivisioncode - in: query - required: false - description: 'The code for the subdivision, such as a particular state within the United States. For a list of US state abbreviations, see Appendix B: Two–Letter State and Possession Abbreviations on the United States Postal Service website. For a list of all supported subdivision codes, use the ListGeoLocations API.' - schema: - type: string - minLength: 1 - maxLength: 3 - parameters: - - $ref: "#/components/parameters/X-Amz-Content-Sha256" - - $ref: "#/components/parameters/X-Amz-Date" - - $ref: "#/components/parameters/X-Amz-Algorithm" - - $ref: "#/components/parameters/X-Amz-Credential" - - $ref: "#/components/parameters/X-Amz-Security-Token" - - $ref: "#/components/parameters/X-Amz-Signature" - - $ref: "#/components/parameters/X-Amz-SignedHeaders" - /2013-04-01/healthcheckcount: - get: - operationId: GetHealthCheckCount - description: Retrieves the number of health checks that are associated with the current Amazon Web Services account. - responses: - "200": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/GetHealthCheckCountResponse" - parameters: [] - parameters: - - $ref: "#/components/parameters/X-Amz-Content-Sha256" - - $ref: "#/components/parameters/X-Amz-Date" - - $ref: "#/components/parameters/X-Amz-Algorithm" - - $ref: "#/components/parameters/X-Amz-Credential" - - $ref: "#/components/parameters/X-Amz-Security-Token" - - $ref: "#/components/parameters/X-Amz-Signature" - - $ref: "#/components/parameters/X-Amz-SignedHeaders" - "/2013-04-01/healthcheck/{HealthCheckId}/lastfailurereason": - get: - operationId: GetHealthCheckLastFailureReason - description: Gets the reason that a specified health check failed most recently. - responses: - "200": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/GetHealthCheckLastFailureReasonResponse" - "480": - description: NoSuchHealthCheck - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchHealthCheck" - "481": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - parameters: - - name: HealthCheckId - in: path - required: true - description:

The ID for the health check for which you want the last failure reason. When you created the health check, CreateHealthCheck returned the ID in the response, in the HealthCheckId element.

If you want to get the last failure reason for a calculated health check, you must use the Amazon Route 53 console or the CloudWatch console. You can't use GetHealthCheckLastFailureReason for a calculated health check.

 - schema: - type: string - maxLength: 64 - parameters: - - $ref: "#/components/parameters/X-Amz-Content-Sha256" - - $ref: "#/components/parameters/X-Amz-Date" - - $ref: "#/components/parameters/X-Amz-Algorithm" - - $ref: "#/components/parameters/X-Amz-Credential" - - $ref: "#/components/parameters/X-Amz-Security-Token" - - $ref: "#/components/parameters/X-Amz-Signature" - - $ref: "#/components/parameters/X-Amz-SignedHeaders" - "/2013-04-01/healthcheck/{HealthCheckId}/status": - get: - operationId: GetHealthCheckStatus - description:

Gets status of a specified health check.

This API is intended for use during development to diagnose behavior. It doesn’t support production use-cases with high query rates that require immediate and actionable responses.

 - responses: - "200": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/GetHealthCheckStatusResponse" - "480": - description: NoSuchHealthCheck - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchHealthCheck" - "481": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - parameters: - - name: HealthCheckId - in: path - required: true - description:

The ID for the health check that you want the current status for. When you created the health check, CreateHealthCheck returned the ID in the response, in the HealthCheckId element.

If you want to check the status of a calculated health check, you must use the Amazon Route 53 console or the CloudWatch console. You can't use GetHealthCheckStatus to get the status of a calculated health check.

 - schema: - type: string - maxLength: 64 - parameters: - - $ref: "#/components/parameters/X-Amz-Content-Sha256" - - $ref: "#/components/parameters/X-Amz-Date" - - $ref: "#/components/parameters/X-Amz-Algorithm" - - $ref: "#/components/parameters/X-Amz-Credential" - - $ref: "#/components/parameters/X-Amz-Security-Token" - - $ref: "#/components/parameters/X-Amz-Signature" - - $ref: "#/components/parameters/X-Amz-SignedHeaders" - /2013-04-01/hostedzonecount: - get: - operationId: GetHostedZoneCount - description: Retrieves the number of hosted zones that are associated with the current Amazon Web Services account. - responses: - "200": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/GetHostedZoneCountResponse" - "480": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - parameters: [] - parameters: - - $ref: "#/components/parameters/X-Amz-Content-Sha256" - - $ref: "#/components/parameters/X-Amz-Date" - - $ref: "#/components/parameters/X-Amz-Algorithm" - - $ref: "#/components/parameters/X-Amz-Credential" - - $ref: "#/components/parameters/X-Amz-Security-Token" - - $ref: "#/components/parameters/X-Amz-Signature" - - $ref: "#/components/parameters/X-Amz-SignedHeaders" - "/2013-04-01/hostedzonelimit/{Id}/{Type}": - get: - operationId: GetHostedZoneLimit - description:

Gets the specified limit for a specified hosted zone, for example, the maximum number of records that you can create in the hosted zone.

For the default limit, see Limits in the Amazon Route 53 Developer Guide. To request a higher limit, open a case.

- responses: - "200": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/GetHostedZoneLimitResponse" - "480": - description: NoSuchHostedZone - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchHostedZone" - "481": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - "482": - description: HostedZoneNotPrivate - content: - text/xml: - schema: - $ref: "#/components/schemas/HostedZoneNotPrivate" - parameters: - - name: Type - in: path - required: true - description: "

The limit that you want to get. Valid values include the following:

  • MAX_RRSETS_BY_ZONE: The maximum number of records that you can create in the specified hosted zone.

  • MAX_VPCS_ASSOCIATED_BY_ZONE: The maximum number of Amazon VPCs that you can associate with the specified private hosted zone.

" - schema: - type: string - enum: - - MAX_RRSETS_BY_ZONE - - MAX_VPCS_ASSOCIATED_BY_ZONE - - name: Id - in: path - required: true - description: The ID of the hosted zone that you want to get a limit for. - schema: - type: string - maxLength: 32 - parameters: - - $ref: "#/components/parameters/X-Amz-Content-Sha256" - - $ref: "#/components/parameters/X-Amz-Date" - - $ref: "#/components/parameters/X-Amz-Algorithm" - - $ref: "#/components/parameters/X-Amz-Credential" - - $ref: "#/components/parameters/X-Amz-Security-Token" - - $ref: "#/components/parameters/X-Amz-Signature" - - $ref: "#/components/parameters/X-Amz-SignedHeaders" - "/2013-04-01/reusabledelegationsetlimit/{Id}/{Type}": - get: - operationId: GetReusableDelegationSetLimit - description:

Gets the maximum number of hosted zones that you can associate with the specified reusable delegation set.

For the default limit, see Limits in the Amazon Route 53 Developer Guide. To request a higher limit, open a case.

- responses: - "200": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/GetReusableDelegationSetLimitResponse" - "480": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - "481": - description: NoSuchDelegationSet - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchDelegationSet" - parameters: - - name: Type - in: path - required: true - description: Specify MAX_ZONES_BY_REUSABLE_DELEGATION_SET to get the maximum number of hosted zones that you can associate with the specified reusable delegation set. - schema: - type: string - enum: - - MAX_ZONES_BY_REUSABLE_DELEGATION_SET - - name: Id - in: path - required: true - description: The ID of the delegation set that you want to get the limit for. - schema: - type: string - maxLength: 32 - parameters: - - $ref: "#/components/parameters/X-Amz-Content-Sha256" - - $ref: "#/components/parameters/X-Amz-Date" - - $ref: "#/components/parameters/X-Amz-Algorithm" - - $ref: "#/components/parameters/X-Amz-Credential" - - $ref: "#/components/parameters/X-Amz-Security-Token" - - $ref: "#/components/parameters/X-Amz-Signature" - - $ref: "#/components/parameters/X-Amz-SignedHeaders" - /2013-04-01/trafficpolicyinstancecount: - get: - operationId: GetTrafficPolicyInstanceCount - description: Gets the number of traffic policy instances that are associated with the current Amazon Web Services account. - responses: - "200": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/GetTrafficPolicyInstanceCountResponse" - parameters: [] - parameters: - - $ref: "#/components/parameters/X-Amz-Content-Sha256" - - $ref: "#/components/parameters/X-Amz-Date" - - $ref: "#/components/parameters/X-Amz-Algorithm" - - $ref: "#/components/parameters/X-Amz-Credential" - - $ref: "#/components/parameters/X-Amz-Security-Token" - - $ref: "#/components/parameters/X-Amz-Signature" - - $ref: "#/components/parameters/X-Amz-SignedHeaders" - "/2013-04-01/cidrcollection/{CidrCollectionId}/cidrblocks": - get: - operationId: ListCidrBlocks - description: Returns a paginated list of location objects and their CIDR blocks. - responses: - "200": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/ListCidrBlocksResponse" - "480": - description: NoSuchCidrCollectionException - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchCidrCollectionException" - "481": - description: NoSuchCidrLocationException - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchCidrLocationException" - "482": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - parameters: - - name: CidrCollectionId - in: path - required: true - description: The UUID of the CIDR collection. - schema: - type: string - pattern: "[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}" - - name: location - in: query - required: false - description: The name of the CIDR collection location. - schema: - type: string - pattern: "[0-9A-Za-z_\\-]+" - minLength: 1 - maxLength: 16 - - name: nexttoken - in: query - required: false - description: An opaque pagination token to indicate where the service is to begin enumerating results. - schema: - type: string - maxLength: 1024 - - name: maxresults - in: query - required: false - description: Maximum number of results you want returned. - schema: - type: string - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - parameters: - - $ref: "#/components/parameters/X-Amz-Content-Sha256" - - $ref: "#/components/parameters/X-Amz-Date" - - $ref: "#/components/parameters/X-Amz-Algorithm" - - $ref: "#/components/parameters/X-Amz-Credential" - - $ref: "#/components/parameters/X-Amz-Security-Token" - - $ref: "#/components/parameters/X-Amz-Signature" - - $ref: "#/components/parameters/X-Amz-SignedHeaders" - /2013-04-01/geolocations: - get: - operationId: ListGeoLocations - description:

Retrieves a list of supported geographic locations.

Countries are listed first, and continents are listed last. If Amazon Route 53 supports subdivisions for a country (for example, states or provinces), the subdivisions for that country are listed in alphabetical order immediately after the corresponding country.

Route 53 does not perform authorization for this API because it retrieves information that is already available to the public.

For a list of supported geolocation codes, see the GeoLocation data type.

- responses: - "200": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/ListGeoLocationsResponse" - "480": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - parameters: - - name: startcontinentcode - in: query - required: false - description:

The code for the continent with which you want to start listing locations that Amazon Route 53 supports for geolocation. If Route 53 has already returned a page or more of results, if IsTruncated is true, and if NextContinentCode from the previous response has a value, enter that value in startcontinentcode to return the next page of results.

Include startcontinentcode only if you want to list continents. Don't include startcontinentcode when you're listing countries or countries with their subdivisions.

- schema: - type: string - minLength: 2 - maxLength: 2 - - name: startcountrycode - in: query - required: false - description: The code for the country with which you want to start listing locations that Amazon Route 53 supports for geolocation. If Route 53 has already returned a page or more of results, if IsTruncated is true, and if NextCountryCode from the previous response has a value, enter that value in startcountrycode to return the next page of results. - schema: - type: string - minLength: 1 - maxLength: 2 - - name: startsubdivisioncode - in: query - required: false - description:

The code for the state of the United States with which you want to start listing locations that Amazon Route 53 supports for geolocation. If Route 53 has already returned a page or more of results, if IsTruncated is true, and if NextSubdivisionCode from the previous response has a value, enter that value in startsubdivisioncode to return the next page of results.

To list subdivisions (U.S. states), you must include both startcountrycode and startsubdivisioncode.

- schema: - type: string - minLength: 1 - maxLength: 3 - - name: maxitems - in: query - required: false - description: (Optional) The maximum number of geolocations to be included in the response body for this request. If more than maxitems geolocations remain to be listed, then the value of the IsTruncated element in the response is true. - schema: - type: string - parameters: - - $ref: "#/components/parameters/X-Amz-Content-Sha256" - - $ref: "#/components/parameters/X-Amz-Date" - - $ref: "#/components/parameters/X-Amz-Algorithm" - - $ref: "#/components/parameters/X-Amz-Credential" - - $ref: "#/components/parameters/X-Amz-Security-Token" - - $ref: "#/components/parameters/X-Amz-Signature" - - $ref: "#/components/parameters/X-Amz-SignedHeaders" - /2013-04-01/hostedzonesbyname: - get: - operationId: ListHostedZonesByName - description:

Retrieves a list of your hosted zones in lexicographic order. The response includes a HostedZones child element for each hosted zone created by the current Amazon Web Services account.

ListHostedZonesByName sorts hosted zones by name with the labels reversed. For example:

com.example.www.

Note the trailing dot, which can change the sort order in some circumstances.

If the domain name includes escape characters or Punycode, ListHostedZonesByName alphabetizes the domain name using the escaped or Punycoded value, which is the format that Amazon Route 53 saves in its database. For example, to create a hosted zone for exämple.com, you specify ex\344mple.com for the domain name. ListHostedZonesByName alphabetizes it as:

com.ex\344mple.

The labels are reversed and alphabetized using the escaped value. For more information about valid domain name formats, including internationalized domain names, see DNS Domain Name Format in the Amazon Route 53 Developer Guide.

Route 53 returns up to 100 items in each response. If you have a lot of hosted zones, use the MaxItems parameter to list them in groups of up to 100. The response includes values that help navigate from one group of MaxItems hosted zones to the next:

  • The DNSName and HostedZoneId elements in the response contain the values, if any, specified for the dnsname and hostedzoneid parameters in the request that produced the current response.

  • The MaxItems element in the response contains the value, if any, that you specified for the maxitems parameter in the request that produced the current response.

  • If the value of IsTruncated in the response is true, there are more hosted zones associated with the current Amazon Web Services account.

    If IsTruncated is false, this response includes the last hosted zone that is associated with the current account. The NextDNSName element and NextHostedZoneId elements are omitted from the response.

  • The NextDNSName and NextHostedZoneId elements in the response contain the domain name and the hosted zone ID of the next hosted zone that is associated with the current Amazon Web Services account. If you want to list more hosted zones, make another call to ListHostedZonesByName, and specify the value of NextDNSName and NextHostedZoneId in the dnsname and hostedzoneid parameters, respectively.

- responses: - "200": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/ListHostedZonesByNameResponse" - "480": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - "481": - description: InvalidDomainName - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidDomainName" - parameters: - - name: dnsname - in: query - required: false - description: (Optional) For your first request to ListHostedZonesByName, include the dnsname parameter only if you want to specify the name of the first hosted zone in the response. If you don't include the dnsname parameter, Amazon Route 53 returns all of the hosted zones that were created by the current Amazon Web Services account, in ASCII order. For subsequent requests, include both dnsname and hostedzoneid parameters. For dnsname, specify the value of NextDNSName from the previous response. - schema: - type: string - maxLength: 1024 - - name: hostedzoneid - in: query - required: false - description:

(Optional) For your first request to ListHostedZonesByName, do not include the hostedzoneid parameter.

If you have more hosted zones than the value of maxitems, ListHostedZonesByName returns only the first maxitems hosted zones. To get the next group of maxitems hosted zones, submit another request to ListHostedZonesByName and include both dnsname and hostedzoneid parameters. For the value of hostedzoneid, specify the value of the NextHostedZoneId element from the previous response.

- schema: - type: string - maxLength: 32 - - name: maxitems - in: query - required: false - description: "The maximum number of hosted zones to be included in the response body for this request. If you have more than maxitems hosted zones, then the value of the IsTruncated element in the response is true, and the values of NextDNSName and NextHostedZoneId specify the first hosted zone in the next group of maxitems hosted zones. " - schema: - type: string - parameters: - - $ref: "#/components/parameters/X-Amz-Content-Sha256" - - $ref: "#/components/parameters/X-Amz-Date" - - $ref: "#/components/parameters/X-Amz-Algorithm" - - $ref: "#/components/parameters/X-Amz-Credential" - - $ref: "#/components/parameters/X-Amz-Security-Token" - - $ref: "#/components/parameters/X-Amz-Signature" - - $ref: "#/components/parameters/X-Amz-SignedHeaders" - /2013-04-01/hostedzonesbyvpc#vpcid&vpcregion: - get: - operationId: ListHostedZonesByVPC - description:

Lists all the private hosted zones that a specified VPC is associated with, regardless of which Amazon Web Services account or Amazon Web Services service owns the hosted zones. The HostedZoneOwner structure in the response contains one of the following values:

  • An OwningAccount element, which contains the account number of either the current Amazon Web Services account or another Amazon Web Services account. Some services, such as Cloud Map, create hosted zones using the current account.

  • An OwningService element, which identifies the Amazon Web Services service that created and owns the hosted zone. For example, if a hosted zone was created by Amazon Elastic File System (Amazon EFS), the value of Owner is efs.amazonaws.com.

When listing private hosted zones, the hosted zone and the Amazon VPC must belong to the same partition where the hosted zones were created. A partition is a group of Amazon Web Services Regions. Each Amazon Web Services account is scoped to one partition.

The following are the supported partitions:

  • aws - Amazon Web Services Regions

  • aws-cn - China Regions

  • aws-us-gov - Amazon Web Services GovCloud (US) Region

For more information, see Access Management in the Amazon Web Services General Reference.

 - responses: - "200": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/ListHostedZonesByVPCResponse" - "480": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - "481": - description: InvalidPaginationToken - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidPaginationToken" - parameters: - - name: vpcid - in: query - required: true - description: The ID of the Amazon VPC that you want to list hosted zones for. - schema: - type: string - description: "(Private hosted zones only) The ID of an Amazon VPC. " - maxLength: 1024 - - name: vpcregion - in: query - required: true - description: "For the Amazon VPC that you specified for VPCId, the Amazon Web Services Region that you created the VPC in. " - schema: - type: string - enum: - - us-east-1 - - us-east-2 - - us-west-1 - - us-west-2 - - eu-west-1 - - eu-west-2 - - eu-west-3 - - eu-central-1 - - eu-central-2 - - ap-east-1 - - me-south-1 - - us-gov-west-1 - - us-gov-east-1 - - us-iso-east-1 - - us-iso-west-1 - - us-isob-east-1 - - me-central-1 - - ap-southeast-1 - - ap-southeast-2 - - ap-southeast-3 - - ap-south-1 - - ap-south-2 - - ap-northeast-1 - - ap-northeast-2 - - ap-northeast-3 - - eu-north-1 - - sa-east-1 - - ca-central-1 - - cn-north-1 - - af-south-1 - - eu-south-1 - - eu-south-2 - - ap-southeast-4 - minLength: 1 - maxLength: 64 - - name: maxitems - in: query - required: false - description: (Optional) The maximum number of hosted zones that you want Amazon Route 53 to return. If the specified VPC is associated with more than MaxItems hosted zones, the response includes a NextToken element. NextToken contains an encrypted token that identifies the first hosted zone that Route 53 will return if you submit another request. - schema: - type: string - - name: nexttoken - in: query - required: false - description:

If the previous response included a NextToken element, the specified VPC is associated with more hosted zones. To get more hosted zones, submit another ListHostedZonesByVPC request.

For the value of NextToken, specify the value of NextToken from the previous response.

If the previous response didn't include a NextToken element, there are no more hosted zones to get.

- schema: - type: string - maxLength: 1024 - parameters: - - $ref: "#/components/parameters/X-Amz-Content-Sha256" - - $ref: "#/components/parameters/X-Amz-Date" - - $ref: "#/components/parameters/X-Amz-Algorithm" - - $ref: "#/components/parameters/X-Amz-Credential" - - $ref: "#/components/parameters/X-Amz-Security-Token" - - $ref: "#/components/parameters/X-Amz-Signature" - - $ref: "#/components/parameters/X-Amz-SignedHeaders" - "/2013-04-01/hostedzone/{Id}/rrset": - get: - operationId: ListResourceRecordSets - description: "

Lists the resource record sets in a specified hosted zone.

ListResourceRecordSets returns up to 300 resource record sets at a time in ASCII order, beginning at a position specified by the name and type elements.

Sort order

ListResourceRecordSets sorts results first by DNS name with the labels reversed, for example:

com.example.www.

Note the trailing dot, which can change the sort order when the record name contains characters that appear before . (decimal 46) in the ASCII table. These characters include the following: ! \" # $ % & ' ( ) * + , -

When multiple records have the same DNS name, ListResourceRecordSets sorts results by the record type.

Specifying where to start listing records

You can use the name and type elements to specify the resource record set that the list begins with:

If you do not specify Name or Type

The results begin with the first resource record set that the hosted zone contains.

If you specify Name but not Type

The results begin with the first resource record set in the list whose name is greater than or equal to Name.

If you specify Type but not Name

Amazon Route 53 returns the InvalidInput error.

If you specify both Name and Type

The results begin with the first resource record set in the list whose name is greater than or equal to Name, and whose type is greater than or equal to Type.

Resource record sets that are PENDING

This action returns the most current version of the records. This includes records that are PENDING, and that are not yet available on all Route 53 DNS servers.

Changing resource record sets

To ensure that you get an accurate listing of the resource record sets for a hosted zone at a point in time, do not submit a ChangeResourceRecordSets request while you're paging through the results of a ListResourceRecordSets request. If you do, some pages may display results without the latest changes while other pages display results with the latest changes.

Displaying the next page of results

If a ListResourceRecordSets command returns more than one page of results, the value of IsTruncated is true. To display the next page of results, get the values of NextRecordName, NextRecordType, and NextRecordIdentifier (if any) from the response. Then submit another ListResourceRecordSets request, and specify those values for StartRecordName, StartRecordType, and StartRecordIdentifier.

" - responses: - "200": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/ListResourceRecordSetsResponse" - "480": - description: NoSuchHostedZone - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchHostedZone" - "481": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - parameters: - - name: Id - in: path - required: true - description: The ID of the hosted zone that contains the resource record sets that you want to list. - schema: - type: string - maxLength: 32 - - name: name - in: query - required: false - description: The first name in the lexicographic ordering of resource record sets that you want to list. If the specified record name doesn't exist, the results begin with the first resource record set that has a name greater than the value of name. - schema: - type: string - maxLength: 1024 - - name: type - in: query - required: false - description: "

The type of resource record set to begin the record listing from.

Valid values for basic resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | NS | PTR | SOA | SPF | SRV | TXT

Values for weighted, latency, geolocation, and failover resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | PTR | SPF | SRV | TXT

Values for alias resource record sets:

  • API Gateway custom regional API or edge-optimized API: A

  • CloudFront distribution: A or AAAA

  • Elastic Beanstalk environment that has a regionalized subdomain: A

  • Elastic Load Balancing load balancer: A | AAAA

  • S3 bucket: A

  • VPC interface VPC endpoint: A

  • Another resource record set in this hosted zone: The type of the resource record set that the alias references.

Constraint: Specifying type without specifying name returns an InvalidInput error.

" - schema: - type: string - enum: - - SOA - - A - - TXT - - NS - - CNAME - - MX - - NAPTR - - PTR - - SRV - - SPF - - AAAA - - CAA - - DS - - name: identifier - in: query - required: false - description: " Resource record sets that have a routing policy other than simple: If results were truncated for a given DNS name and type, specify the value of NextRecordIdentifier from the previous response to get the next resource record set that has the current DNS name and type." - schema: - type: string - minLength: 1 - maxLength: 128 - - name: maxitems - in: query - required: false - description: (Optional) The maximum number of resource records sets to include in the response body for this request. If the response includes more than maxitems resource record sets, the value of the IsTruncated element in the response is true, and the values of the NextRecordName and NextRecordType elements in the response identify the first resource record set in the next group of maxitems resource record sets. - schema: - type: string - - name: MaxItems - in: query - schema: - type: string - description: Pagination limit - required: false - - name: StartRecordName - in: query - schema: - type: string - description: Pagination token - required: false - - name: StartRecordType - in: query - schema: - type: string - description: Pagination token - required: false - - name: StartRecordIdentifier - in: query - schema: - type: string - description: Pagination token - required: false - - name: region - in: header - schema: - type: string - default: us-east-1 - required: false - parameters: - - $ref: "#/components/parameters/X-Amz-Content-Sha256" - - $ref: "#/components/parameters/X-Amz-Date" - - $ref: "#/components/parameters/X-Amz-Algorithm" - - $ref: "#/components/parameters/X-Amz-Credential" - - $ref: "#/components/parameters/X-Amz-Security-Token" - - $ref: "#/components/parameters/X-Amz-Signature" - - $ref: "#/components/parameters/X-Amz-SignedHeaders" - "/2013-04-01/tags/{ResourceType}": - post: - operationId: ListTagsForResources - description:

Lists tags for up to 10 health checks or hosted zones.

For information about using tags for cost allocation, see Using Cost Allocation Tags in the Billing and Cost Management User Guide.

- responses: - "200": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/ListTagsForResourcesResponse" - "480": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - "481": - description: NoSuchHealthCheck - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchHealthCheck" - "482": - description: NoSuchHostedZone - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchHostedZone" - "483": - description: PriorRequestNotComplete - content: - text/xml: - schema: - $ref: "#/components/schemas/PriorRequestNotComplete" - "484": - description: ThrottlingException - content: - text/xml: - schema: - $ref: "#/components/schemas/ThrottlingException" - parameters: - - name: ResourceType - in: path - required: true - description:

The type of the resources.

  • The resource type for health checks is healthcheck.

  • The resource type for hosted zones is hostedzone.

- schema: - type: string - enum: - - healthcheck - - hostedzone - requestBody: - required: true - content: - text/xml: - schema: - type: object - required: - - ResourceIds - properties: - ResourceIds: - description: A complex type that contains the ResourceId element for each resource for which you want to get a list of tags. - type: array - items: - allOf: - - $ref: "#/components/schemas/TagResourceId" - - xml: - name: ResourceId - minItems: 1 - maxItems: 10 - parameters: - - $ref: "#/components/parameters/X-Amz-Content-Sha256" - - $ref: "#/components/parameters/X-Amz-Date" - - $ref: "#/components/parameters/X-Amz-Algorithm" - - $ref: "#/components/parameters/X-Amz-Credential" - - $ref: "#/components/parameters/X-Amz-Security-Token" - - $ref: "#/components/parameters/X-Amz-Signature" - - $ref: "#/components/parameters/X-Amz-SignedHeaders" - /2013-04-01/trafficpolicies: - get: - operationId: ListTrafficPolicies - description:

Gets information about the latest version for every traffic policy that is associated with the current Amazon Web Services account. Policies are listed in the order that they were created in.

For information about how of deleting a traffic policy affects the response from ListTrafficPolicies, see DeleteTrafficPolicy.

- responses: - "200": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/ListTrafficPoliciesResponse" - "480": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - parameters: - - name: trafficpolicyid - in: query - required: false - description:

(Conditional) For your first request to ListTrafficPolicies, don't include the TrafficPolicyIdMarker parameter.

If you have more traffic policies than the value of MaxItems, ListTrafficPolicies returns only the first MaxItems traffic policies. To get the next group of policies, submit another request to ListTrafficPolicies. For the value of TrafficPolicyIdMarker, specify the value of TrafficPolicyIdMarker that was returned in the previous response.

- schema: - type: string - minLength: 1 - maxLength: 36 - - name: maxitems - in: query - required: false - description: (Optional) The maximum number of traffic policies that you want Amazon Route 53 to return in response to this request. If you have more than MaxItems traffic policies, the value of IsTruncated in the response is true, and the value of TrafficPolicyIdMarker is the ID of the first traffic policy that Route 53 will return if you submit another request. - schema: - type: string - parameters: - - $ref: "#/components/parameters/X-Amz-Content-Sha256" - - $ref: "#/components/parameters/X-Amz-Date" - - $ref: "#/components/parameters/X-Amz-Algorithm" - - $ref: "#/components/parameters/X-Amz-Credential" - - $ref: "#/components/parameters/X-Amz-Security-Token" - - $ref: "#/components/parameters/X-Amz-Signature" - - $ref: "#/components/parameters/X-Amz-SignedHeaders" - /2013-04-01/trafficpolicyinstances: - get: - operationId: ListTrafficPolicyInstances - description:

Gets information about the traffic policy instances that you created by using the current Amazon Web Services account.

After you submit an UpdateTrafficPolicyInstance request, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see the State response element.

Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the MaxItems parameter to list them in groups of up to 100.

- responses: - "200": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/ListTrafficPolicyInstancesResponse" - "480": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - "481": - description: NoSuchTrafficPolicyInstance - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchTrafficPolicyInstance" - parameters: - - name: hostedzoneid - in: query - required: false - description:

If the value of IsTruncated in the previous response was true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstances request. For the value of HostedZoneId, specify the value of HostedZoneIdMarker from the previous response, which is the hosted zone ID of the first traffic policy instance in the next group of traffic policy instances.

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

- schema: - type: string - maxLength: 32 - - name: trafficpolicyinstancename - in: query - required: false - description:

If the value of IsTruncated in the previous response was true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstances request. For the value of trafficpolicyinstancename, specify the value of TrafficPolicyInstanceNameMarker from the previous response, which is the name of the first traffic policy instance in the next group of traffic policy instances.

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

- schema: - type: string - maxLength: 1024 - - name: trafficpolicyinstancetype - in: query - required: false - description:

If the value of IsTruncated in the previous response was true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstances request. For the value of trafficpolicyinstancetype, specify the value of TrafficPolicyInstanceTypeMarker from the previous response, which is the type of the first traffic policy instance in the next group of traffic policy instances.

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

- schema: - type: string - enum: - - SOA - - A - - TXT - - NS - - CNAME - - MX - - NAPTR - - PTR - - SRV - - SPF - - AAAA - - CAA - - DS - - name: maxitems - in: query - required: false - description: The maximum number of traffic policy instances that you want Amazon Route 53 to return in response to a ListTrafficPolicyInstances request. If you have more than MaxItems traffic policy instances, the value of the IsTruncated element in the response is true, and the values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker represent the first traffic policy instance in the next group of MaxItems traffic policy instances. - schema: - type: string - parameters: - - $ref: "#/components/parameters/X-Amz-Content-Sha256" - - $ref: "#/components/parameters/X-Amz-Date" - - $ref: "#/components/parameters/X-Amz-Algorithm" - - $ref: "#/components/parameters/X-Amz-Credential" - - $ref: "#/components/parameters/X-Amz-Security-Token" - - $ref: "#/components/parameters/X-Amz-Signature" - - $ref: "#/components/parameters/X-Amz-SignedHeaders" - /2013-04-01/trafficpolicyinstances/hostedzone#id: - get: - operationId: ListTrafficPolicyInstancesByHostedZone - description:

Gets information about the traffic policy instances that you created in a specified hosted zone.

After you submit a CreateTrafficPolicyInstance or an UpdateTrafficPolicyInstance request, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see the State response element.

Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the MaxItems parameter to list them in groups of up to 100.

- responses: - "200": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/ListTrafficPolicyInstancesByHostedZoneResponse" - "480": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - "481": - description: NoSuchTrafficPolicyInstance - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchTrafficPolicyInstance" - "482": - description: NoSuchHostedZone - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchHostedZone" - parameters: - - name: id - in: query - required: true - description: The ID of the hosted zone that you want to list traffic policy instances for. - schema: - type: string - maxLength: 32 - - name: trafficpolicyinstancename - in: query - required: false - description:

If the value of IsTruncated in the previous response is true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstances request. For the value of trafficpolicyinstancename, specify the value of TrafficPolicyInstanceNameMarker from the previous response, which is the name of the first traffic policy instance in the next group of traffic policy instances.

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

- schema: - type: string - maxLength: 1024 - - name: trafficpolicyinstancetype - in: query - required: false - description:

If the value of IsTruncated in the previous response is true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstances request. For the value of trafficpolicyinstancetype, specify the value of TrafficPolicyInstanceTypeMarker from the previous response, which is the type of the first traffic policy instance in the next group of traffic policy instances.

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

- schema: - type: string - enum: - - SOA - - A - - TXT - - NS - - CNAME - - MX - - NAPTR - - PTR - - SRV - - SPF - - AAAA - - CAA - - DS - - name: maxitems - in: query - required: false - description: The maximum number of traffic policy instances to be included in the response body for this request. If you have more than MaxItems traffic policy instances, the value of the IsTruncated element in the response is true, and the values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker represent the first traffic policy instance that Amazon Route 53 will return if you submit another request. - schema: - type: string - parameters: - - $ref: "#/components/parameters/X-Amz-Content-Sha256" - - $ref: "#/components/parameters/X-Amz-Date" - - $ref: "#/components/parameters/X-Amz-Algorithm" - - $ref: "#/components/parameters/X-Amz-Credential" - - $ref: "#/components/parameters/X-Amz-Security-Token" - - $ref: "#/components/parameters/X-Amz-Signature" - - $ref: "#/components/parameters/X-Amz-SignedHeaders" - /2013-04-01/trafficpolicyinstances/trafficpolicy#id&version: - get: - operationId: ListTrafficPolicyInstancesByPolicy - description:

Gets information about the traffic policy instances that you created by using a specify traffic policy version.

After you submit a CreateTrafficPolicyInstance or an UpdateTrafficPolicyInstance request, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see the State response element.

Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the MaxItems parameter to list them in groups of up to 100.

- responses: - "200": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/ListTrafficPolicyInstancesByPolicyResponse" - "480": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - "481": - description: NoSuchTrafficPolicyInstance - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchTrafficPolicyInstance" - "482": - description: NoSuchTrafficPolicy - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchTrafficPolicy" - parameters: - - name: id - in: query - required: true - description: The ID of the traffic policy for which you want to list traffic policy instances. - schema: - type: string - minLength: 1 - maxLength: 36 - - name: version - in: query - required: true - description: The version of the traffic policy for which you want to list traffic policy instances. The version must be associated with the traffic policy that is specified by TrafficPolicyId. - schema: - type: integer - minimum: 1 - maximum: 1000 - - name: hostedzoneid - in: query - required: false - description:

If the value of IsTruncated in the previous response was true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstancesByPolicy request.

For the value of hostedzoneid, specify the value of HostedZoneIdMarker from the previous response, which is the hosted zone ID of the first traffic policy instance that Amazon Route 53 will return if you submit another request.

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

- schema: - type: string - maxLength: 32 - - name: trafficpolicyinstancename - in: query - required: false - description:

If the value of IsTruncated in the previous response was true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstancesByPolicy request.

For the value of trafficpolicyinstancename, specify the value of TrafficPolicyInstanceNameMarker from the previous response, which is the name of the first traffic policy instance that Amazon Route 53 will return if you submit another request.

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

- schema: - type: string - maxLength: 1024 - - name: trafficpolicyinstancetype - in: query - required: false - description:

If the value of IsTruncated in the previous response was true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstancesByPolicy request.

For the value of trafficpolicyinstancetype, specify the value of TrafficPolicyInstanceTypeMarker from the previous response, which is the name of the first traffic policy instance that Amazon Route 53 will return if you submit another request.

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

- schema: - type: string - enum: - - SOA - - A - - TXT - - NS - - CNAME - - MX - - NAPTR - - PTR - - SRV - - SPF - - AAAA - - CAA - - DS - - name: maxitems - in: query - required: false - description: The maximum number of traffic policy instances to be included in the response body for this request. If you have more than MaxItems traffic policy instances, the value of the IsTruncated element in the response is true, and the values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker represent the first traffic policy instance that Amazon Route 53 will return if you submit another request. - schema: - type: string - parameters: - - $ref: "#/components/parameters/X-Amz-Content-Sha256" - - $ref: "#/components/parameters/X-Amz-Date" - - $ref: "#/components/parameters/X-Amz-Algorithm" - - $ref: "#/components/parameters/X-Amz-Credential" - - $ref: "#/components/parameters/X-Amz-Security-Token" - - $ref: "#/components/parameters/X-Amz-Signature" - - $ref: "#/components/parameters/X-Amz-SignedHeaders" - "/2013-04-01/trafficpolicies/{Id}/versions": - get: - operationId: ListTrafficPolicyVersions - description:

Gets information about all of the versions for a specified traffic policy.

Traffic policy versions are listed in numerical order by VersionNumber.

- responses: - "200": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/ListTrafficPolicyVersionsResponse" - "480": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - "481": - description: NoSuchTrafficPolicy - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchTrafficPolicy" - parameters: - - name: Id - in: path - required: true - description: Specify the value of Id of the traffic policy for which you want to list all versions. - schema: - type: string - minLength: 1 - maxLength: 36 - - name: trafficpolicyversion - in: query - required: false - description:

For your first request to ListTrafficPolicyVersions, don't include the TrafficPolicyVersionMarker parameter.

If you have more traffic policy versions than the value of MaxItems, ListTrafficPolicyVersions returns only the first group of MaxItems versions. To get more traffic policy versions, submit another ListTrafficPolicyVersions request. For the value of TrafficPolicyVersionMarker, specify the value of TrafficPolicyVersionMarker in the previous response.

- schema: - type: string - maxLength: 4 - - name: maxitems - in: query - required: false - description: The maximum number of traffic policy versions that you want Amazon Route 53 to include in the response body for this request. If the specified traffic policy has more than MaxItems versions, the value of IsTruncated in the response is true, and the value of the TrafficPolicyVersionMarker element is the ID of the first version that Route 53 will return if you submit another request. - schema: - type: string - parameters: - - $ref: "#/components/parameters/X-Amz-Content-Sha256" - - $ref: "#/components/parameters/X-Amz-Date" - - $ref: "#/components/parameters/X-Amz-Algorithm" - - $ref: "#/components/parameters/X-Amz-Credential" - - $ref: "#/components/parameters/X-Amz-Security-Token" - - $ref: "#/components/parameters/X-Amz-Signature" - - $ref: "#/components/parameters/X-Amz-SignedHeaders" - /2013-04-01/testdnsanswer#hostedzoneid&recordname&recordtype: - get: - operationId: TestDNSAnswer - description:

Gets the value that Amazon Route 53 returns in response to a DNS request for a specified record name and type. You can optionally specify the IP address of a DNS resolver, an EDNS0 client subnet IP address, and a subnet mask.

This call only supports querying public hosted zones.

- responses: - "200": - description: Success - content: - text/xml: - schema: - $ref: "#/components/schemas/TestDNSAnswerResponse" - "480": - description: NoSuchHostedZone - content: - text/xml: - schema: - $ref: "#/components/schemas/NoSuchHostedZone" - "481": - description: InvalidInput - content: - text/xml: - schema: - $ref: "#/components/schemas/InvalidInput" - parameters: - - name: hostedzoneid - in: query - required: true - description: The ID of the hosted zone that you want Amazon Route 53 to simulate a query for. - schema: - type: string - maxLength: 32 - - name: recordname - in: query - required: true - description: The name of the resource record set that you want Amazon Route 53 to simulate a query for. - schema: - type: string - maxLength: 1024 - - name: recordtype - in: query - required: true - description: The type of the resource record set. - schema: - type: string - enum: - - SOA - - A - - TXT - - NS - - CNAME - - MX - - NAPTR - - PTR - - SRV - - SPF - - AAAA - - CAA - - DS - - name: resolverip - in: query - required: false - description: If you want to simulate a request from a specific DNS resolver, specify the IP address for that resolver. If you omit this value, TestDnsAnswer uses the IP address of a DNS resolver in the Amazon Web Services US East (N. Virginia) Region (us-east-1). - schema: - type: string - 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]))$) - maxLength: 45 - - name: edns0clientsubnetip - in: query - required: false - description: If the resolver that you specified for resolverip supports EDNS0, specify the IPv4 or IPv6 address of a client in the applicable location, for example, 192.0.2.44 or 2001:db8:85a3::8a2e:370:7334. - schema: - type: string - 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]))$) - maxLength: 45 - - name: edns0clientsubnetmask - in: query - required: false - description: "

If you specify an IP address for edns0clientsubnetip, you can optionally specify the number of bits of the IP address that you want the checking tool to include in the DNS query. For example, if you specify 192.0.2.44 for edns0clientsubnetip and 24 for edns0clientsubnetmask, the checking tool will simulate a request from 192.0.2.0/24. The default value is 24 bits for IPv4 addresses and 64 bits for IPv6 addresses.

The range of valid values depends on whether edns0clientsubnetip is an IPv4 or an IPv6 address:

  • IPv4: Specify a value between 0 and 32

  • IPv6: Specify a value between 0 and 128

" - schema: - type: string - minLength: 0 - maxLength: 3 - parameters: - - $ref: "#/components/parameters/X-Amz-Content-Sha256" - - $ref: "#/components/parameters/X-Amz-Date" - - $ref: "#/components/parameters/X-Amz-Algorithm" - - $ref: "#/components/parameters/X-Amz-Credential" - - $ref: "#/components/parameters/X-Amz-Security-Token" - - $ref: "#/components/parameters/X-Amz-Signature" - - $ref: "#/components/parameters/X-Amz-SignedHeaders" -components: - x-stackQL-resources: - resource_record_sets: - name: resource_record_sets - methods: - create_record_set: - operation: - $ref: '#/paths/~12013-04-01~1hostedzone~1{Id}~1rrset~1/post' - request: - mediaType: text/xml - xmlRootAnnotation: 'xmlns="https://route53.amazonaws.com/doc/2013-04-01/"' - response: - mediaType: text/xml - openAPIDocKey: '200' - list_record_sets: - operation: - $ref: '#/paths/~12013-04-01~1hostedzone~1{Id}~1rrset/get' - response: - objectKey: /*/ResourceRecordSets/ResourceRecordSet - mediaType: text/xml - openAPIDocKey: '200' - id: aws.route53_api.resource_record_sets - sqlVerbs: - delete: [] - insert: - - $ref: '#/components/x-stackQL-resources/resource_record_sets/methods/create_record_set' - select: - - $ref: '#/components/x-stackQL-resources/resource_record_sets/methods/list_record_sets' - update: [] - title: resource_record_sets - parameters: - X-Amz-Content-Sha256: - name: X-Amz-Content-Sha256 - in: header - schema: - type: string - required: false - X-Amz-Date: - name: X-Amz-Date - in: header - schema: - type: string - required: false - X-Amz-Algorithm: - name: X-Amz-Algorithm - in: header - schema: - type: string - required: false - X-Amz-Credential: - name: X-Amz-Credential - in: header - schema: - type: string - required: false - X-Amz-Security-Token: - name: X-Amz-Security-Token - in: header - schema: - type: string - required: false - X-Amz-Signature: - name: X-Amz-Signature - in: header - schema: - type: string - required: false - X-Amz-SignedHeaders: - name: X-Amz-SignedHeaders - in: header - schema: - type: string - required: false - securitySchemes: - hmac: - type: apiKey - name: Authorization - in: header - description: Amazon Signature authorization v4 - x-amazon-apigateway-authtype: awsSigv4 - schemas: - ActivateKeySigningKeyResponse: - type: object - required: - - ChangeInfo - properties: - ChangeInfo: - $ref: "#/components/schemas/ChangeInfo" - ConcurrentModification: {} - NoSuchKeySigningKey: {} - InvalidKeySigningKeyStatus: {} - InvalidSigningStatus: {} - InvalidKMSArn: {} - InvalidInput: {} - AssociateVPCWithHostedZoneResponse: - type: object - required: - - ChangeInfo - example: - ChangeInfo: - Comment: "" - Id: /change/C3HC6WDB2UANE2 - Status: INSYNC - SubmittedAt: 2017-01-31T01:36:41.958Z - properties: - ChangeInfo: - allOf: - - $ref: "#/components/schemas/ChangeInfo" - - description: A complex type that describes the changes made to your hosted zone. - description: A complex type that contains the response information for the AssociateVPCWithHostedZone request. - VPCRegion: - type: string - enum: - - us-east-1 - - us-east-2 - - us-west-1 - - us-west-2 - - eu-west-1 - - eu-west-2 - - eu-west-3 - - eu-central-1 - - eu-central-2 - - ap-east-1 - - me-south-1 - - us-gov-west-1 - - us-gov-east-1 - - us-iso-east-1 - - us-iso-west-1 - - us-isob-east-1 - - me-central-1 - - ap-southeast-1 - - ap-southeast-2 - - ap-southeast-3 - - ap-south-1 - - ap-south-2 - - ap-northeast-1 - - ap-northeast-2 - - ap-northeast-3 - - eu-north-1 - - sa-east-1 - - ca-central-1 - - cn-north-1 - - af-south-1 - - eu-south-1 - - eu-south-2 - - ap-southeast-4 - minLength: 1 - maxLength: 64 - VPCId: - type: string - description: "(Private hosted zones only) The ID of an Amazon VPC. " - maxLength: 1024 - NoSuchHostedZone: {} - NotAuthorizedException: {} - InvalidVPCId: {} - PublicZoneVPCAssociation: {} - ConflictingDomainExists: {} - LimitsExceeded: {} - PriorRequestNotComplete: {} - ChangeCidrCollectionResponse: - type: object - required: - - Id - properties: - Id: - allOf: - - $ref: "#/components/schemas/ChangeId" - - description: The ID that is returned by ChangeCidrCollection. You can use it as input to GetChange to see if a CIDR collection change has propagated or not. - CidrCollectionChange: - type: object - required: - - LocationName - - Action - - CidrList - properties: - LocationName: - allOf: - - $ref: "#/components/schemas/CidrLocationNameDefaultNotAllowed" - - description: Name of the location that is associated with the CIDR collection. - Action: - allOf: - - $ref: "#/components/schemas/CidrCollectionChangeAction" - - description: "CIDR collection change action. " - CidrList: - allOf: - - $ref: "#/components/schemas/CidrList" - - description: List of CIDR blocks. - description: A complex type that contains information about the CIDR collection change. - NoSuchCidrCollectionException: {} - CidrCollectionVersionMismatchException: {} - CidrBlockInUseException: {} - ChangeResourceRecordSetsResponse: - type: object - required: - - ChangeInfo - example: - ChangeInfo: - Comment: Geolocation alias configuration for example.com - Id: /change/C2682N5HXP0BZ4 - Status: PENDING - SubmittedAt: 2017-02-10T01:36:41.958Z - properties: - ChangeInfo: - allOf: - - $ref: "#/components/schemas/ChangeInfo" - - description:

A complex type that contains information about changes made to your hosted zone.

This element contains an ID that you use when performing a GetChange action to get detailed information about the change.

- description: A complex type containing the response for the request. - ResourceDescription: - type: string - maxLength: 256 - Changes: - type: array - items: - allOf: - - $ref: "#/components/schemas/Change" - - xml: - name: Change - minItems: 1 - NoSuchHealthCheck: {} - InvalidChangeBatch: {} - ChangeTagsForResourceResponse: - type: object - example: {} - properties: {} - description: Empty response for the request. - Tag: - type: object - properties: - Key: - allOf: - - $ref: "#/components/schemas/TagKey" - - description: "

The value of Key depends on the operation that you want to perform:

  • Add a tag to a health check or hosted zone: Key is the name that you want to give the new tag.

  • Edit a tag: Key is the name of the tag that you want to change the Value for.

  • Delete a key: Key is the name of the tag you want to remove.

  • Give a name to a health check: Edit the default Name tag. In the Amazon Route 53 console, the list of your health checks includes a Name column that lets you see the name that you've given to each health check.

" - Value: - allOf: - - $ref: "#/components/schemas/TagValue" - - description: "

The value of Value depends on the operation that you want to perform:

  • Add a tag to a health check or hosted zone: Value is the value that you want to give the new tag.

  • Edit a tag: Value is the new value that you want to assign the tag.

" - description: A complex type that contains information about a tag that you want to add or edit for the specified health check or hosted zone. - TagKey: - type: string - maxLength: 128 - ThrottlingException: {} - CreateCidrCollectionResponse: - type: object - properties: - Collection: - allOf: - - $ref: "#/components/schemas/CidrCollection" - - description: A complex type that contains information about the CIDR collection. - CidrCollectionAlreadyExistsException: {} - CreateHealthCheckResponse: - type: object - required: - - HealthCheck - properties: - HealthCheck: - allOf: - - $ref: "#/components/schemas/HealthCheck" - - description: A complex type that contains identifying information about the health check. - description: A complex type containing the response information for the new health check. - IPAddress: - type: string - 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]))$) - maxLength: 45 - Port: - type: integer - minimum: 1 - maximum: 65535 - HealthCheckType: - type: string - enum: - - HTTP - - HTTPS - - HTTP_STR_MATCH - - HTTPS_STR_MATCH - - TCP - - CALCULATED - - CLOUDWATCH_METRIC - - RECOVERY_CONTROL - ResourcePath: - type: string - maxLength: 255 - FullyQualifiedDomainName: - type: string - maxLength: 255 - SearchString: - type: string - maxLength: 255 - RequestInterval: - type: integer - minimum: 10 - maximum: 30 - FailureThreshold: - type: integer - minimum: 1 - maximum: 10 - MeasureLatency: - type: boolean - Inverted: - type: boolean - Disabled: - type: boolean - HealthThreshold: - type: integer - minimum: 0 - maximum: 256 - ChildHealthCheckList: - type: array - items: - allOf: - - $ref: "#/components/schemas/HealthCheckId" - - xml: - name: ChildHealthCheck - maxItems: 256 - EnableSNI: - type: boolean - HealthCheckRegionList: - type: array - items: - allOf: - - $ref: "#/components/schemas/HealthCheckRegion" - - xml: - name: Region - minItems: 3 - maxItems: 64 - AlarmIdentifier: - type: object - required: - - Region - - Name - properties: - Region: - allOf: - - $ref: "#/components/schemas/CloudWatchRegion" - - description:

For the CloudWatch alarm that you want Route 53 health checkers to use to determine whether this health check is healthy, the region that the alarm was created in.

For the current list of CloudWatch regions, see Amazon CloudWatch endpoints and quotas in the Amazon Web Services General Reference.

- Name: - allOf: - - $ref: "#/components/schemas/AlarmName" - - description: "

The name of the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.

Route 53 supports CloudWatch alarms with the following features:

  • Standard-resolution metrics. High-resolution metrics aren't supported. For more information, see High-Resolution Metrics in the Amazon CloudWatch User Guide.

  • Statistics: Average, Minimum, Maximum, Sum, and SampleCount. Extended statistics aren't supported.

" - description: A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether the specified health check is healthy. - InsufficientDataHealthStatus: - type: string - enum: - - Healthy - - Unhealthy - - LastKnownStatus - RoutingControlArn: - type: string - minLength: 1 - maxLength: 255 - TooManyHealthChecks: {} - HealthCheckAlreadyExists: {} - CreateHostedZoneResponse: - type: object - required: - - HostedZone - - ChangeInfo - - DelegationSet - properties: - HostedZone: - allOf: - - $ref: "#/components/schemas/HostedZone" - - description: A complex type that contains general information about the hosted zone. - ChangeInfo: - allOf: - - $ref: "#/components/schemas/ChangeInfo" - - description: A complex type that contains information about the CreateHostedZone request. - DelegationSet: - allOf: - - $ref: "#/components/schemas/DelegationSet" - - description: A complex type that describes the name servers for this hosted zone. - VPC: - allOf: - - $ref: "#/components/schemas/VPC" - - description: A complex type that contains information about an Amazon VPC that you associated with this hosted zone. - description: A complex type containing the response information for the hosted zone. - IsPrivateZone: - type: boolean - InvalidDomainName: {} - HostedZoneAlreadyExists: {} - TooManyHostedZones: {} - DelegationSetNotAvailable: {} - NoSuchDelegationSet: {} - DelegationSetNotReusable: {} - CreateKeySigningKeyResponse: - type: object - required: - - ChangeInfo - - KeySigningKey - properties: - ChangeInfo: - $ref: "#/components/schemas/ChangeInfo" - KeySigningKey: - allOf: - - $ref: "#/components/schemas/KeySigningKey" - - description: The key-signing key (KSK) that the request creates. - InvalidArgument: {} - InvalidKeySigningKeyName: {} - KeySigningKeyAlreadyExists: {} - TooManyKeySigningKeys: {} - CreateQueryLoggingConfigResponse: - type: object - required: - - QueryLoggingConfig - properties: - QueryLoggingConfig: - allOf: - - $ref: "#/components/schemas/QueryLoggingConfig" - - description: A complex type that contains the ID for a query logging configuration, the ID of the hosted zone that you want to log queries for, and the ARN for the log group that you want Amazon Route 53 to send query logs to. - NoSuchCloudWatchLogsLogGroup: {} - QueryLoggingConfigAlreadyExists: {} - InsufficientCloudWatchLogsResourcePolicy: {} - CreateReusableDelegationSetResponse: - type: object - required: - - DelegationSet - properties: - DelegationSet: - allOf: - - $ref: "#/components/schemas/DelegationSet" - - description: A complex type that contains name server information. - DelegationSetAlreadyCreated: {} - HostedZoneNotFound: {} - DelegationSetAlreadyReusable: {} - CreateTrafficPolicyResponse: - type: object - required: - - TrafficPolicy - properties: - TrafficPolicy: - allOf: - - $ref: "#/components/schemas/TrafficPolicy" - - description: A complex type that contains settings for the new traffic policy. - description: A complex type that contains the response information for the CreateTrafficPolicy request. - TooManyTrafficPolicies: {} - TrafficPolicyAlreadyExists: {} - InvalidTrafficPolicyDocument: {} - CreateTrafficPolicyInstanceResponse: - type: object - required: - - TrafficPolicyInstance - properties: - TrafficPolicyInstance: - allOf: - - $ref: "#/components/schemas/TrafficPolicyInstance" - - description: A complex type that contains settings for the new traffic policy instance. - description: A complex type that contains the response information for the CreateTrafficPolicyInstance request. - TooManyTrafficPolicyInstances: {} - NoSuchTrafficPolicy: {} - TrafficPolicyInstanceAlreadyExists: {} - CreateTrafficPolicyVersionResponse: - type: object - required: - - TrafficPolicy - properties: - TrafficPolicy: - allOf: - - $ref: "#/components/schemas/TrafficPolicy" - - description: A complex type that contains settings for the new version of the traffic policy. - description: A complex type that contains the response information for the CreateTrafficPolicyVersion request. - TooManyTrafficPolicyVersionsForCurrentPolicy: {} - CreateVPCAssociationAuthorizationResponse: - type: object - required: - - HostedZoneId - - VPC - properties: - HostedZoneId: - allOf: - - $ref: "#/components/schemas/ResourceId" - - description: The ID of the hosted zone that you authorized associating a VPC with. - VPC: - allOf: - - $ref: "#/components/schemas/VPC" - - description: The VPC that you authorized associating with a hosted zone. - description: A complex type that contains the response information from a CreateVPCAssociationAuthorization request. - TooManyVPCAssociationAuthorizations: {} - DeactivateKeySigningKeyResponse: - type: object - required: - - ChangeInfo - properties: - ChangeInfo: - $ref: "#/components/schemas/ChangeInfo" - KeySigningKeyInUse: {} - KeySigningKeyInParentDSRecord: {} - DeleteCidrCollectionResponse: - type: object - properties: {} - CidrCollectionInUseException: {} - DeleteHealthCheckResponse: - type: object - properties: {} - description: An empty element. - HealthCheckInUse: {} - DeleteHostedZoneResponse: - type: object - required: - - ChangeInfo - properties: - ChangeInfo: - allOf: - - $ref: "#/components/schemas/ChangeInfo" - - description: A complex type that contains the ID, the status, and the date and time of a request to delete a hosted zone. - description: A complex type that contains the response to a DeleteHostedZone request. - HostedZoneNotEmpty: {} - DeleteKeySigningKeyResponse: - type: object - required: - - ChangeInfo - properties: - ChangeInfo: - $ref: "#/components/schemas/ChangeInfo" - DeleteQueryLoggingConfigResponse: - type: object - properties: {} - NoSuchQueryLoggingConfig: {} - DeleteReusableDelegationSetResponse: - type: object - properties: {} - description: An empty element. - DelegationSetInUse: {} - DeleteTrafficPolicyResponse: - type: object - properties: {} - description: An empty element. - TrafficPolicyInUse: {} - DeleteTrafficPolicyInstanceResponse: - type: object - properties: {} - description: An empty element. - NoSuchTrafficPolicyInstance: {} - DeleteVPCAssociationAuthorizationResponse: - type: object - properties: {} - description: Empty response for the request. - VPCAssociationAuthorizationNotFound: {} - DisableHostedZoneDNSSECResponse: - type: object - required: - - ChangeInfo - properties: - ChangeInfo: - $ref: "#/components/schemas/ChangeInfo" - DNSSECNotFound: {} - DisassociateVPCFromHostedZoneResponse: - type: object - required: - - ChangeInfo - properties: - ChangeInfo: - allOf: - - $ref: "#/components/schemas/ChangeInfo" - - description: A complex type that describes the changes made to the specified private hosted zone. - description: A complex type that contains the response information for the disassociate request. - VPCAssociationNotFound: {} - LastVPCAssociation: {} - EnableHostedZoneDNSSECResponse: - type: object - required: - - ChangeInfo - properties: - ChangeInfo: - $ref: "#/components/schemas/ChangeInfo" - KeySigningKeyWithActiveStatusNotFound: {} - HostedZonePartiallyDelegated: {} - GetAccountLimitResponse: - type: object - required: - - Limit - - Count - properties: - Limit: - allOf: - - $ref: "#/components/schemas/AccountLimit" - - description: The current setting for the specified limit. For example, if you specified MAX_HEALTH_CHECKS_BY_OWNER for the value of Type in the request, the value of Limit is the maximum number of health checks that you can create using the current account. - Count: - allOf: - - $ref: "#/components/schemas/UsageCount" - - description: The current number of entities that you have created of the specified type. For example, if you specified MAX_HEALTH_CHECKS_BY_OWNER for the value of Type in the request, the value of Count is the current number of health checks that you have created using the current account. - description: "A complex type that contains the requested limit. " - GetChangeResponse: - type: object - required: - - ChangeInfo - properties: - ChangeInfo: - allOf: - - $ref: "#/components/schemas/ChangeInfo" - - description: A complex type that contains information about the specified change batch. - description: A complex type that contains the ChangeInfo element. - NoSuchChange: {} - GetCheckerIpRangesResponse: - type: object - required: - - CheckerIpRanges - properties: - CheckerIpRanges: - allOf: - - $ref: "#/components/schemas/CheckerIpRanges" - - description: A complex type that contains sorted list of IP ranges in CIDR format for Amazon Route 53 health checkers. - description: A complex type that contains the CheckerIpRanges element. - GetDNSSECResponse: - type: object - required: - - Status - - KeySigningKeys - properties: - Status: - allOf: - - $ref: "#/components/schemas/DNSSECStatus" - - description: A string repesenting the status of DNSSEC. - KeySigningKeys: - allOf: - - $ref: "#/components/schemas/KeySigningKeys" - - description: The key-signing keys (KSKs) in your account. - GetGeoLocationResponse: - type: object - required: - - GeoLocationDetails - properties: - GeoLocationDetails: - allOf: - - $ref: "#/components/schemas/GeoLocationDetails" - - description: A complex type that contains the codes and full continent, country, and subdivision names for the specified geolocation code. - description: A complex type that contains the response information for the specified geolocation code. - NoSuchGeoLocation: {} - GetHealthCheckResponse: - type: object - required: - - HealthCheck - properties: - HealthCheck: - allOf: - - $ref: "#/components/schemas/HealthCheck" - - description: A complex type that contains information about one health check that is associated with the current Amazon Web Services account. - description: A complex type that contains the response to a GetHealthCheck request. - IncompatibleVersion: {} - GetHealthCheckCountResponse: - type: object - required: - - HealthCheckCount - properties: - HealthCheckCount: - allOf: - - $ref: "#/components/schemas/HealthCheckCount" - - description: The number of health checks associated with the current Amazon Web Services account. - description: A complex type that contains the response to a GetHealthCheckCount request. - GetHealthCheckLastFailureReasonResponse: - type: object - required: - - HealthCheckObservations - properties: - HealthCheckObservations: - allOf: - - $ref: "#/components/schemas/HealthCheckObservations" - - description: "A list that contains one Observation element for each Amazon Route 53 health checker that is reporting a last failure reason. " - description: A complex type that contains the response to a GetHealthCheckLastFailureReason request. - GetHealthCheckStatusResponse: - type: object - required: - - HealthCheckObservations - properties: - HealthCheckObservations: - allOf: - - $ref: "#/components/schemas/HealthCheckObservations" - - description: A list that contains one HealthCheckObservation element for each Amazon Route 53 health checker that is reporting a status about the health check endpoint. - description: A complex type that contains the response to a GetHealthCheck request. - GetHostedZoneResponse: - type: object - required: - - HostedZone - example: - DelegationSet: - NameServers: - - ns-2048.awsdns-64.com - - ns-2049.awsdns-65.net - - ns-2050.awsdns-66.org - - ns-2051.awsdns-67.co.uk - HostedZone: - CallerReference: C741617D-04E4-F8DE-B9D7-0D150FC61C2E - Config: - PrivateZone: false - Id: /hostedzone/Z3M3LMPEXAMPLE - Name: myawsbucket.com. - ResourceRecordSetCount: 8 - properties: - HostedZone: - allOf: - - $ref: "#/components/schemas/HostedZone" - - description: A complex type that contains general information about the specified hosted zone. - DelegationSet: - allOf: - - $ref: "#/components/schemas/DelegationSet" - - description: A complex type that lists the Amazon Route 53 name servers for the specified hosted zone. - VPCs: - allOf: - - $ref: "#/components/schemas/VPCs" - - description: A complex type that contains information about the VPCs that are associated with the specified hosted zone. - description: A complex type that contain the response to a GetHostedZone request. - GetHostedZoneCountResponse: - type: object - required: - - HostedZoneCount - properties: - HostedZoneCount: - allOf: - - $ref: "#/components/schemas/HostedZoneCount" - - description: The total number of public and private hosted zones that are associated with the current Amazon Web Services account. - description: A complex type that contains the response to a GetHostedZoneCount request. - GetHostedZoneLimitResponse: - type: object - required: - - Limit - - Count - properties: - Limit: - allOf: - - $ref: "#/components/schemas/HostedZoneLimit" - - description: The current setting for the specified limit. For example, if you specified MAX_RRSETS_BY_ZONE for the value of Type in the request, the value of Limit is the maximum number of records that you can create in the specified hosted zone. - Count: - allOf: - - $ref: "#/components/schemas/UsageCount" - - description: The current number of entities that you have created of the specified type. For example, if you specified MAX_RRSETS_BY_ZONE for the value of Type in the request, the value of Count is the current number of records that you have created in the specified hosted zone. - description: "A complex type that contains the requested limit. " - HostedZoneNotPrivate: {} - GetQueryLoggingConfigResponse: - type: object - required: - - QueryLoggingConfig - properties: - QueryLoggingConfig: - allOf: - - $ref: "#/components/schemas/QueryLoggingConfig" - - description: A complex type that contains information about the query logging configuration that you specified in a GetQueryLoggingConfig request. - GetReusableDelegationSetResponse: - type: object - required: - - DelegationSet - properties: - DelegationSet: - allOf: - - $ref: "#/components/schemas/DelegationSet" - - description: A complex type that contains information about the reusable delegation set. - description: A complex type that contains the response to the GetReusableDelegationSet request. - GetReusableDelegationSetLimitResponse: - type: object - required: - - Limit - - Count - properties: - Limit: - allOf: - - $ref: "#/components/schemas/ReusableDelegationSetLimit" - - description: The current setting for the limit on hosted zones that you can associate with the specified reusable delegation set. - Count: - allOf: - - $ref: "#/components/schemas/UsageCount" - - description: The current number of hosted zones that you can associate with the specified reusable delegation set. - description: "A complex type that contains the requested limit. " - GetTrafficPolicyResponse: - type: object - required: - - TrafficPolicy - properties: - TrafficPolicy: - allOf: - - $ref: "#/components/schemas/TrafficPolicy" - - description: A complex type that contains settings for the specified traffic policy. - description: A complex type that contains the response information for the request. - GetTrafficPolicyInstanceResponse: - type: object - required: - - TrafficPolicyInstance - properties: - TrafficPolicyInstance: - allOf: - - $ref: "#/components/schemas/TrafficPolicyInstance" - - description: A complex type that contains settings for the traffic policy instance. - description: A complex type that contains information about the resource record sets that Amazon Route 53 created based on a specified traffic policy. - GetTrafficPolicyInstanceCountResponse: - type: object - required: - - TrafficPolicyInstanceCount - properties: - TrafficPolicyInstanceCount: - allOf: - - $ref: "#/components/schemas/TrafficPolicyInstanceCount" - - description: The number of traffic policy instances that are associated with the current Amazon Web Services account. - description: A complex type that contains information about the resource record sets that Amazon Route 53 created based on a specified traffic policy. - ListCidrBlocksResponse: - type: object - properties: - NextToken: - allOf: - - $ref: "#/components/schemas/PaginationToken" - - description:

An opaque pagination token to indicate where the service is to begin enumerating results.

If no value is provided, the listing of results starts from the beginning.

- CidrBlocks: - allOf: - - $ref: "#/components/schemas/CidrBlockSummaries" - - description: A complex type that contains information about the CIDR blocks. - NoSuchCidrLocationException: {} - ListCidrCollectionsResponse: - type: object - properties: - NextToken: - allOf: - - $ref: "#/components/schemas/PaginationToken" - - description:

An opaque pagination token to indicate where the service is to begin enumerating results.

If no value is provided, the listing of results starts from the beginning.

- CidrCollections: - allOf: - - $ref: "#/components/schemas/CollectionSummaries" - - description: A complex type with information about the CIDR collection. - ListCidrLocationsResponse: - type: object - properties: - NextToken: - allOf: - - $ref: "#/components/schemas/PaginationToken" - - description:

An opaque pagination token to indicate where the service is to begin enumerating results.

If no value is provided, the listing of results starts from the beginning.

- CidrLocations: - allOf: - - $ref: "#/components/schemas/LocationSummaries" - - description: A complex type that contains information about the list of CIDR locations. - ListGeoLocationsResponse: - type: object - required: - - GeoLocationDetailsList - - IsTruncated - - MaxItems - properties: - GeoLocationDetailsList: - allOf: - - $ref: "#/components/schemas/GeoLocationDetailsList" - - description: A complex type that contains one GeoLocationDetails element for each location that Amazon Route 53 supports for geolocation. - IsTruncated: - allOf: - - $ref: "#/components/schemas/PageTruncated" - - description: A value that indicates whether more locations remain to be listed after the last location in this response. If so, the value of IsTruncated is true. To get more values, submit another request and include the values of NextContinentCode, NextCountryCode, and NextSubdivisionCode in the startcontinentcode, startcountrycode, and startsubdivisioncode, as applicable. - NextContinentCode: - allOf: - - $ref: "#/components/schemas/GeoLocationContinentCode" - - description: If IsTruncated is true, you can make a follow-up request to display more locations. Enter the value of NextContinentCode in the startcontinentcode parameter in another ListGeoLocations request. - NextCountryCode: - allOf: - - $ref: "#/components/schemas/GeoLocationCountryCode" - - description: If IsTruncated is true, you can make a follow-up request to display more locations. Enter the value of NextCountryCode in the startcountrycode parameter in another ListGeoLocations request. - NextSubdivisionCode: - allOf: - - $ref: "#/components/schemas/GeoLocationSubdivisionCode" - - description: If IsTruncated is true, you can make a follow-up request to display more locations. Enter the value of NextSubdivisionCode in the startsubdivisioncode parameter in another ListGeoLocations request. - MaxItems: - allOf: - - $ref: "#/components/schemas/PageMaxItems" - - description: The value that you specified for MaxItems in the request. - description: A complex type containing the response information for the request. - ListHealthChecksResponse: - type: object - required: - - HealthChecks - - Marker - - IsTruncated - - MaxItems - properties: - HealthChecks: - allOf: - - $ref: "#/components/schemas/HealthChecks" - - description: A complex type that contains one HealthCheck element for each health check that is associated with the current Amazon Web Services account. - Marker: - allOf: - - $ref: "#/components/schemas/PageMarker" - - description: For the second and subsequent calls to ListHealthChecks, Marker is the value that you specified for the marker parameter in the previous request. - IsTruncated: - allOf: - - $ref: "#/components/schemas/PageTruncated" - - description: A flag that indicates whether there are more health checks to be listed. If the response was truncated, you can get the next group of health checks by submitting another ListHealthChecks request and specifying the value of NextMarker in the marker parameter. - NextMarker: - allOf: - - $ref: "#/components/schemas/PageMarker" - - description: If IsTruncated is true, the value of NextMarker identifies the first health check that Amazon Route 53 returns if you submit another ListHealthChecks request and specify the value of NextMarker in the marker parameter. - MaxItems: - allOf: - - $ref: "#/components/schemas/PageMaxItems" - - description: The value that you specified for the maxitems parameter in the call to ListHealthChecks that produced the current response. - description: A complex type that contains the response to a ListHealthChecks request. - ListHostedZonesResponse: - type: object - required: - - HostedZones - - Marker - - IsTruncated - - MaxItems - properties: - HostedZones: - allOf: - - $ref: "#/components/schemas/HostedZones" - - description: A complex type that contains general information about the hosted zone. - Marker: - allOf: - - $ref: "#/components/schemas/PageMarker" - - description: For the second and subsequent calls to ListHostedZones, Marker is the value that you specified for the marker parameter in the request that produced the current response. - IsTruncated: - allOf: - - $ref: "#/components/schemas/PageTruncated" - - description: A flag indicating whether there are more hosted zones to be listed. If the response was truncated, you can get more hosted zones by submitting another ListHostedZones request and specifying the value of NextMarker in the marker parameter. - NextMarker: - allOf: - - $ref: "#/components/schemas/PageMarker" - - description:

If IsTruncated is true, the value of NextMarker identifies the first hosted zone in the next group of hosted zones. Submit another ListHostedZones request, and specify the value of NextMarker from the response in the marker parameter.

This element is present only if IsTruncated is true.

- MaxItems: - allOf: - - $ref: "#/components/schemas/PageMaxItems" - - description: The value that you specified for the maxitems parameter in the call to ListHostedZones that produced the current response. - ListHostedZonesByNameResponse: - type: object - required: - - HostedZones - - IsTruncated - - MaxItems - properties: - HostedZones: - allOf: - - $ref: "#/components/schemas/HostedZones" - - description: A complex type that contains general information about the hosted zone. - DNSName: - allOf: - - $ref: "#/components/schemas/DNSName" - - description: For the second and subsequent calls to ListHostedZonesByName, DNSName is the value that you specified for the dnsname parameter in the request that produced the current response. - HostedZoneId: - allOf: - - $ref: "#/components/schemas/ResourceId" - - description: The ID that Amazon Route 53 assigned to the hosted zone when you created it. - IsTruncated: - allOf: - - $ref: "#/components/schemas/PageTruncated" - - description: A flag that indicates whether there are more hosted zones to be listed. If the response was truncated, you can get the next group of maxitems hosted zones by calling ListHostedZonesByName again and specifying the values of NextDNSName and NextHostedZoneId elements in the dnsname and hostedzoneid parameters. - NextDNSName: - allOf: - - $ref: "#/components/schemas/DNSName" - - description:

If IsTruncated is true, the value of NextDNSName is the name of the first hosted zone in the next group of maxitems hosted zones. Call ListHostedZonesByName again and specify the value of NextDNSName and NextHostedZoneId in the dnsname and hostedzoneid parameters, respectively.

This element is present only if IsTruncated is true.

- NextHostedZoneId: - allOf: - - $ref: "#/components/schemas/ResourceId" - - description:

If IsTruncated is true, the value of NextHostedZoneId identifies the first hosted zone in the next group of maxitems hosted zones. Call ListHostedZonesByName again and specify the value of NextDNSName and NextHostedZoneId in the dnsname and hostedzoneid parameters, respectively.

This element is present only if IsTruncated is true.

- MaxItems: - allOf: - - $ref: "#/components/schemas/PageMaxItems" - - description: The value that you specified for the maxitems parameter in the call to ListHostedZonesByName that produced the current response. - description: A complex type that contains the response information for the request. - ListHostedZonesByVPCResponse: - type: object - required: - - HostedZoneSummaries - - MaxItems - properties: - HostedZoneSummaries: - allOf: - - $ref: "#/components/schemas/HostedZoneSummaries" - - description: A list that contains one HostedZoneSummary element for each hosted zone that the specified Amazon VPC is associated with. Each HostedZoneSummary element contains the hosted zone name and ID, and information about who owns the hosted zone. - MaxItems: - allOf: - - $ref: "#/components/schemas/PageMaxItems" - - description: The value that you specified for MaxItems in the most recent ListHostedZonesByVPC request. - NextToken: - allOf: - - $ref: "#/components/schemas/PaginationToken" - - description: The value that you will use for NextToken in the next ListHostedZonesByVPC request. - InvalidPaginationToken: {} - ListQueryLoggingConfigsResponse: - type: object - required: - - QueryLoggingConfigs - properties: - QueryLoggingConfigs: - allOf: - - $ref: "#/components/schemas/QueryLoggingConfigs" - - description: An array that contains one QueryLoggingConfig element for each configuration for DNS query logging that is associated with the current Amazon Web Services account. - NextToken: - allOf: - - $ref: "#/components/schemas/PaginationToken" - - description:

If a response includes the last of the query logging configurations that are associated with the current Amazon Web Services account, NextToken doesn't appear in the response.

If a response doesn't include the last of the configurations, you can get more configurations by submitting another ListQueryLoggingConfigs request. Get the value of NextToken that Amazon Route 53 returned in the previous response and include it in NextToken in the next request.

- ListResourceRecordSetsResponse: - type: object - required: - - ResourceRecordSets - - IsTruncated - - MaxItems - properties: - ResourceRecordSets: - allOf: - - $ref: "#/components/schemas/ResourceRecordSets" - - description: Information about multiple resource record sets. - IsTruncated: - allOf: - - $ref: "#/components/schemas/PageTruncated" - - description: A flag that indicates whether more resource record sets remain to be listed. If your results were truncated, you can make a follow-up pagination request by using the NextRecordName element. - NextRecordName: - allOf: - - $ref: "#/components/schemas/DNSName" - - description:

If the results were truncated, the name of the next record in the list.

This element is present only if IsTruncated is true.

- NextRecordType: - allOf: - - $ref: "#/components/schemas/RRType" - - description:

If the results were truncated, the type of the next record in the list.

This element is present only if IsTruncated is true.

- NextRecordIdentifier: - allOf: - - $ref: "#/components/schemas/ResourceRecordSetIdentifier" - - description:

Resource record sets that have a routing policy other than simple: If results were truncated for a given DNS name and type, the value of SetIdentifier for the next resource record set that has the current DNS name and type.

For information about routing policies, see Choosing a Routing Policy in the Amazon Route 53 Developer Guide.

- MaxItems: - allOf: - - $ref: "#/components/schemas/PageMaxItems" - - description: The maximum number of records you requested. - description: A complex type that contains list information for the resource record set. - ListReusableDelegationSetsResponse: - type: object - required: - - DelegationSets - - Marker - - IsTruncated - - MaxItems - properties: - DelegationSets: - allOf: - - $ref: "#/components/schemas/DelegationSets" - - description: A complex type that contains one DelegationSet element for each reusable delegation set that was created by the current Amazon Web Services account. - Marker: - allOf: - - $ref: "#/components/schemas/PageMarker" - - description: For the second and subsequent calls to ListReusableDelegationSets, Marker is the value that you specified for the marker parameter in the request that produced the current response. - IsTruncated: - allOf: - - $ref: "#/components/schemas/PageTruncated" - - description: A flag that indicates whether there are more reusable delegation sets to be listed. - NextMarker: - allOf: - - $ref: "#/components/schemas/PageMarker" - - description: If IsTruncated is true, the value of NextMarker identifies the next reusable delegation set that Amazon Route 53 will return if you submit another ListReusableDelegationSets request and specify the value of NextMarker in the marker parameter. - MaxItems: - allOf: - - $ref: "#/components/schemas/PageMaxItems" - - description: The value that you specified for the maxitems parameter in the call to ListReusableDelegationSets that produced the current response. - description: A complex type that contains information about the reusable delegation sets that are associated with the current Amazon Web Services account. - ListTagsForResourceResponse: - type: object - required: - - ResourceTagSet - properties: - ResourceTagSet: - allOf: - - $ref: "#/components/schemas/ResourceTagSet" - - description: A ResourceTagSet containing tags associated with the specified resource. - description: A complex type that contains information about the health checks or hosted zones for which you want to list tags. - ListTagsForResourcesResponse: - type: object - required: - - ResourceTagSets - properties: - ResourceTagSets: - allOf: - - $ref: "#/components/schemas/ResourceTagSetList" - - description: A list of ResourceTagSets containing tags associated with the specified resources. - description: A complex type containing tags for the specified resources. - TagResourceId: - type: string - maxLength: 64 - ListTrafficPoliciesResponse: - type: object - required: - - TrafficPolicySummaries - - IsTruncated - - TrafficPolicyIdMarker - - MaxItems - properties: - TrafficPolicySummaries: - allOf: - - $ref: "#/components/schemas/TrafficPolicySummaries" - - description: A list that contains one TrafficPolicySummary element for each traffic policy that was created by the current Amazon Web Services account. - IsTruncated: - allOf: - - $ref: "#/components/schemas/PageTruncated" - - description: A flag that indicates whether there are more traffic policies to be listed. If the response was truncated, you can get the next group of traffic policies by submitting another ListTrafficPolicies request and specifying the value of TrafficPolicyIdMarker in the TrafficPolicyIdMarker request parameter. - TrafficPolicyIdMarker: - allOf: - - $ref: "#/components/schemas/TrafficPolicyId" - - description: If the value of IsTruncated is true, TrafficPolicyIdMarker is the ID of the first traffic policy in the next group of MaxItems traffic policies. - MaxItems: - allOf: - - $ref: "#/components/schemas/PageMaxItems" - - description: The value that you specified for the MaxItems parameter in the ListTrafficPolicies request that produced the current response. - description: A complex type that contains the response information for the request. - ListTrafficPolicyInstancesResponse: - type: object - required: - - TrafficPolicyInstances - - IsTruncated - - MaxItems - properties: - TrafficPolicyInstances: - allOf: - - $ref: "#/components/schemas/TrafficPolicyInstances" - - description: A list that contains one TrafficPolicyInstance element for each traffic policy instance that matches the elements in the request. - HostedZoneIdMarker: - allOf: - - $ref: "#/components/schemas/ResourceId" - - description: "If IsTruncated is true, HostedZoneIdMarker is the ID of the hosted zone of the first traffic policy instance that Route 53 will return if you submit another ListTrafficPolicyInstances request. " - TrafficPolicyInstanceNameMarker: - allOf: - - $ref: "#/components/schemas/DNSName" - - description: "If IsTruncated is true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance that Route 53 will return if you submit another ListTrafficPolicyInstances request. " - TrafficPolicyInstanceTypeMarker: - allOf: - - $ref: "#/components/schemas/RRType" - - description: "If IsTruncated is true, TrafficPolicyInstanceTypeMarker is the DNS type of the resource record sets that are associated with the first traffic policy instance that Amazon Route 53 will return if you submit another ListTrafficPolicyInstances request. " - IsTruncated: - allOf: - - $ref: "#/components/schemas/PageTruncated" - - description: A flag that indicates whether there are more traffic policy instances to be listed. If the response was truncated, you can get more traffic policy instances by calling ListTrafficPolicyInstances again and specifying the values of the HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker in the corresponding request parameters. - MaxItems: - allOf: - - $ref: "#/components/schemas/PageMaxItems" - - description: The value that you specified for the MaxItems parameter in the call to ListTrafficPolicyInstances that produced the current response. - description: A complex type that contains the response information for the request. - ListTrafficPolicyInstancesByHostedZoneResponse: - type: object - required: - - TrafficPolicyInstances - - IsTruncated - - MaxItems - properties: - TrafficPolicyInstances: - allOf: - - $ref: "#/components/schemas/TrafficPolicyInstances" - - description: "A list that contains one TrafficPolicyInstance element for each traffic policy instance that matches the elements in the request. " - TrafficPolicyInstanceNameMarker: - allOf: - - $ref: "#/components/schemas/DNSName" - - description: If IsTruncated is true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance in the next group of traffic policy instances. - TrafficPolicyInstanceTypeMarker: - allOf: - - $ref: "#/components/schemas/RRType" - - description: If IsTruncated is true, TrafficPolicyInstanceTypeMarker is the DNS type of the resource record sets that are associated with the first traffic policy instance in the next group of traffic policy instances. - IsTruncated: - allOf: - - $ref: "#/components/schemas/PageTruncated" - - description: A flag that indicates whether there are more traffic policy instances to be listed. If the response was truncated, you can get the next group of traffic policy instances by submitting another ListTrafficPolicyInstancesByHostedZone request and specifying the values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker in the corresponding request parameters. - MaxItems: - allOf: - - $ref: "#/components/schemas/PageMaxItems" - - description: The value that you specified for the MaxItems parameter in the ListTrafficPolicyInstancesByHostedZone request that produced the current response. - description: A complex type that contains the response information for the request. - ListTrafficPolicyInstancesByPolicyResponse: - type: object - required: - - TrafficPolicyInstances - - IsTruncated - - MaxItems - properties: - TrafficPolicyInstances: - allOf: - - $ref: "#/components/schemas/TrafficPolicyInstances" - - description: A list that contains one TrafficPolicyInstance element for each traffic policy instance that matches the elements in the request. - HostedZoneIdMarker: - allOf: - - $ref: "#/components/schemas/ResourceId" - - description: If IsTruncated is true, HostedZoneIdMarker is the ID of the hosted zone of the first traffic policy instance in the next group of traffic policy instances. - TrafficPolicyInstanceNameMarker: - allOf: - - $ref: "#/components/schemas/DNSName" - - description: If IsTruncated is true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance in the next group of MaxItems traffic policy instances. - TrafficPolicyInstanceTypeMarker: - allOf: - - $ref: "#/components/schemas/RRType" - - description: If IsTruncated is true, TrafficPolicyInstanceTypeMarker is the DNS type of the resource record sets that are associated with the first traffic policy instance in the next group of MaxItems traffic policy instances. - IsTruncated: - allOf: - - $ref: "#/components/schemas/PageTruncated" - - description: A flag that indicates whether there are more traffic policy instances to be listed. If the response was truncated, you can get the next group of traffic policy instances by calling ListTrafficPolicyInstancesByPolicy again and specifying the values of the HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker elements in the corresponding request parameters. - MaxItems: - allOf: - - $ref: "#/components/schemas/PageMaxItems" - - description: The value that you specified for the MaxItems parameter in the call to ListTrafficPolicyInstancesByPolicy that produced the current response. - description: A complex type that contains the response information for the request. - ListTrafficPolicyVersionsResponse: - type: object - required: - - TrafficPolicies - - IsTruncated - - TrafficPolicyVersionMarker - - MaxItems - properties: - TrafficPolicies: - allOf: - - $ref: "#/components/schemas/TrafficPolicies" - - description: A list that contains one TrafficPolicy element for each traffic policy version that is associated with the specified traffic policy. - IsTruncated: - allOf: - - $ref: "#/components/schemas/PageTruncated" - - description: A flag that indicates whether there are more traffic policies to be listed. If the response was truncated, you can get the next group of traffic policies by submitting another ListTrafficPolicyVersions request and specifying the value of NextMarker in the marker parameter. - TrafficPolicyVersionMarker: - allOf: - - $ref: "#/components/schemas/TrafficPolicyVersionMarker" - - description:

If IsTruncated is true, the value of TrafficPolicyVersionMarker identifies the first traffic policy that Amazon Route 53 will return if you submit another request. Call ListTrafficPolicyVersions again and specify the value of TrafficPolicyVersionMarker in the TrafficPolicyVersionMarker request parameter.

This element is present only if IsTruncated is true.

- MaxItems: - allOf: - - $ref: "#/components/schemas/PageMaxItems" - - description: The value that you specified for the maxitems parameter in the ListTrafficPolicyVersions request that produced the current response. - description: A complex type that contains the response information for the request. - ListVPCAssociationAuthorizationsResponse: - type: object - required: - - HostedZoneId - - VPCs - properties: - HostedZoneId: - allOf: - - $ref: "#/components/schemas/ResourceId" - - description: The ID of the hosted zone that you can associate the listed VPCs with. - NextToken: - allOf: - - $ref: "#/components/schemas/PaginationToken" - - description: When the response includes a NextToken element, there are more VPCs that can be associated with the specified hosted zone. To get the next page of VPCs, submit another ListVPCAssociationAuthorizations request, and include the value of the NextToken element from the response in the nexttoken request parameter. - VPCs: - allOf: - - $ref: "#/components/schemas/VPCs" - - description: The list of VPCs that are authorized to be associated with the specified hosted zone. - description: A complex type that contains the response information for the request. - TestDNSAnswerResponse: - type: object - required: - - Nameserver - - RecordName - - RecordType - - RecordData - - ResponseCode - - Protocol - properties: - Nameserver: - allOf: - - $ref: "#/components/schemas/Nameserver" - - description: The Amazon Route 53 name server used to respond to the request. - RecordName: - allOf: - - $ref: "#/components/schemas/DNSName" - - description: The name of the resource record set that you submitted a request for. - RecordType: - allOf: - - $ref: "#/components/schemas/RRType" - - description: The type of the resource record set that you submitted a request for. - RecordData: - allOf: - - $ref: "#/components/schemas/RecordData" - - description: A list that contains values that Amazon Route 53 returned for this resource record set. - ResponseCode: - allOf: - - $ref: "#/components/schemas/DNSRCode" - - description: 'A code that indicates whether the request is valid or not. The most common response code is NOERROR, meaning that the request is valid. If the response is not valid, Amazon Route 53 returns a response code that describes the error. For a list of possible response codes, see DNS RCODES on the IANA website. ' - Protocol: - allOf: - - $ref: "#/components/schemas/TransportProtocol" - - description: "The protocol that Amazon Route 53 used to respond to the request, either UDP or TCP. " - description: "A complex type that contains the response to a TestDNSAnswer request. " - UpdateHealthCheckResponse: - type: object - required: - - HealthCheck - properties: - HealthCheck: - allOf: - - $ref: "#/components/schemas/HealthCheck" - - description: A complex type that contains the response to an UpdateHealthCheck request. - description: A complex type that contains the response to the UpdateHealthCheck request. - HealthCheckId: - type: string - maxLength: 64 - HealthCheckRegion: - type: string - enum: - - us-east-1 - - us-west-1 - - us-west-2 - - eu-west-1 - - ap-southeast-1 - - ap-southeast-2 - - ap-northeast-1 - - sa-east-1 - minLength: 1 - maxLength: 64 - CloudWatchRegion: - type: string - enum: - - us-east-1 - - us-east-2 - - us-west-1 - - us-west-2 - - ca-central-1 - - eu-central-1 - - eu-central-2 - - eu-west-1 - - eu-west-2 - - eu-west-3 - - ap-east-1 - - me-south-1 - - me-central-1 - - ap-south-1 - - ap-south-2 - - ap-southeast-1 - - ap-southeast-2 - - ap-southeast-3 - - ap-northeast-1 - - ap-northeast-2 - - ap-northeast-3 - - eu-north-1 - - sa-east-1 - - cn-northwest-1 - - cn-north-1 - - af-south-1 - - eu-south-1 - - eu-south-2 - - us-gov-west-1 - - us-gov-east-1 - - us-iso-east-1 - - us-iso-west-1 - - us-isob-east-1 - - ap-southeast-4 - minLength: 1 - maxLength: 64 - AlarmName: - type: string - minLength: 1 - maxLength: 256 - ResettableElementName: - type: string - enum: - - FullyQualifiedDomainName - - Regions - - ResourcePath - - ChildHealthChecks - minLength: 1 - maxLength: 64 - HealthCheckVersionMismatch: {} - UpdateHostedZoneCommentResponse: - type: object - required: - - HostedZone - properties: - HostedZone: - allOf: - - $ref: "#/components/schemas/HostedZone" - - description: A complex type that contains the response to the UpdateHostedZoneComment request. - description: A complex type that contains the response to the UpdateHostedZoneComment request. - UpdateTrafficPolicyCommentResponse: - type: object - required: - - TrafficPolicy - properties: - TrafficPolicy: - allOf: - - $ref: "#/components/schemas/TrafficPolicy" - - description: A complex type that contains settings for the specified traffic policy. - description: A complex type that contains the response information for the traffic policy. - UpdateTrafficPolicyInstanceResponse: - type: object - required: - - TrafficPolicyInstance - properties: - TrafficPolicyInstance: - allOf: - - $ref: "#/components/schemas/TrafficPolicyInstance" - - description: A complex type that contains settings for the updated traffic policy instance. - description: A complex type that contains information about the resource record sets that Amazon Route 53 created based on a specified traffic policy. - ConflictingTypes: {} - ARN: - type: string - pattern: .*\S.* - minLength: 20 - maxLength: 2048 - AWSAccountID: - type: string - AccountLimitType: - type: string - enum: - - MAX_HEALTH_CHECKS_BY_OWNER - - MAX_HOSTED_ZONES_BY_OWNER - - MAX_TRAFFIC_POLICY_INSTANCES_BY_OWNER - - MAX_REUSABLE_DELEGATION_SETS_BY_OWNER - - MAX_TRAFFIC_POLICIES_BY_OWNER - LimitValue: - type: integer - minimum: 1 - AccountLimit: - type: object - required: - - Type - - Value - properties: - Type: - allOf: - - $ref: "#/components/schemas/AccountLimitType" - - description: "

The limit that you requested. Valid values include the following:

  • MAX_HEALTH_CHECKS_BY_OWNER: The maximum number of health checks that you can create using the current account.

  • MAX_HOSTED_ZONES_BY_OWNER: The maximum number of hosted zones that you can create using the current account.

  • MAX_REUSABLE_DELEGATION_SETS_BY_OWNER: The maximum number of reusable delegation sets that you can create using the current account.

  • MAX_TRAFFIC_POLICIES_BY_OWNER: The maximum number of traffic policies that you can create using the current account.

  • MAX_TRAFFIC_POLICY_INSTANCES_BY_OWNER: The maximum number of traffic policy instances that you can create using the current account. (Traffic policy instances are referred to as traffic flow policy records in the Amazon Route 53 console.)

" - Value: - allOf: - - $ref: "#/components/schemas/LimitValue" - - description: The current value for the limit that is specified by Type. - description: A complex type that contains the type of limit that you specified in the request and the current value for that limit. - ResourceId: - type: string - maxLength: 32 - SigningKeyName: - type: string - minLength: 3 - maxLength: 128 - ActivateKeySigningKeyRequest: - type: object - title: ActivateKeySigningKeyRequest - properties: {} - ChangeInfo: - type: object - required: - - Id - - Status - - SubmittedAt - properties: - Id: - allOf: - - $ref: "#/components/schemas/ResourceId" - - description: This element contains an ID that you use when performing a GetChange action to get detailed information about the change. - Status: - allOf: - - $ref: "#/components/schemas/ChangeStatus" - - description: The current state of the request. PENDING indicates that this request has not yet been applied to all Amazon Route 53 DNS servers. - SubmittedAt: - allOf: - - $ref: "#/components/schemas/TimeStamp" - - description: The date and time that the change request was submitted in ISO 8601 format and Coordinated Universal Time (UTC). For example, the value 2017-03-27T17:48:16.751Z represents March 27, 2017 at 17:48:16.751 UTC. - Comment: - allOf: - - $ref: "#/components/schemas/ResourceDescription" - - description: A comment you can provide. - description: A complex type that describes change information about changes made to your hosted zone. - AliasHealthEnabled: - type: boolean - DNSName: - type: string - maxLength: 1024 - AliasTarget: - type: object - required: - - HostedZoneId - - DNSName - - EvaluateTargetHealth - properties: - HostedZoneId: - allOf: - - $ref: "#/components/schemas/ResourceId" - - description: "

Alias resource records sets only: The value used depends on where you want to route traffic:

Amazon API Gateway custom regional APIs and edge-optimized APIs

Specify the hosted zone ID for your API. You can get the applicable value using the CLI command get-domain-names:

  • For regional APIs, specify the value of regionalHostedZoneId.

  • For edge-optimized APIs, specify the value of distributionHostedZoneId.

Amazon Virtual Private Cloud interface VPC endpoint

Specify the hosted zone ID for your interface endpoint. You can get the value of HostedZoneId using the CLI command describe-vpc-endpoints.

CloudFront distribution

Specify Z2FDTNDATAQYW2.

Alias resource record sets for CloudFront can't be created in a private zone.
Elastic Beanstalk environment

Specify the hosted zone ID for the region that you created the environment in. The environment must have a regionalized subdomain. For a list of regions and the corresponding hosted zone IDs, see Elastic Beanstalk endpoints and quotas in the the Amazon Web Services General Reference.

ELB load balancer

Specify the value of the hosted zone ID for the load balancer. Use the following methods to get the hosted zone ID:

  • Elastic Load Balancing endpoints and quotas topic in the Amazon Web Services General Reference: Use the value that corresponds with the region that you created your load balancer in. Note that there are separate columns for Application and Classic Load Balancers and for Network Load Balancers.

  • Amazon Web Services Management Console: Go to the Amazon EC2 page, choose Load Balancers in the navigation pane, select the load balancer, and get the value of the Hosted zone field on the Description tab.

  • Elastic Load Balancing API: Use DescribeLoadBalancers to get the applicable value. For more information, see the applicable guide:

  • CLI: Use describe-load-balancers to get the applicable value. For more information, see the applicable guide:

Global Accelerator accelerator

Specify Z2BJ6XQ5FK7U4H.

An Amazon S3 bucket configured as a static website

Specify the hosted zone ID for the region that you created the bucket in. For more information about valid values, see the table Amazon S3 Website Endpoints in the Amazon Web Services General Reference.

Another Route 53 resource record set in your hosted zone

Specify the hosted zone ID of your hosted zone. (An alias resource record set can't reference a resource record set in a different hosted zone.)

" - DNSName: - allOf: - - $ref: "#/components/schemas/DNSName" - - description: "

Alias resource record sets only: The value that you specify depends on where you want to route queries:

Amazon API Gateway custom regional APIs and edge-optimized APIs

Specify the applicable domain name for your API. You can get the applicable value using the CLI command get-domain-names:

  • For regional APIs, specify the value of regionalDomainName.

  • For edge-optimized APIs, specify the value of distributionDomainName. This is the name of the associated CloudFront distribution, such as da1b2c3d4e5.cloudfront.net.

The name of the record that you're creating must match a custom domain name for your API, such as api.example.com.
Amazon Virtual Private Cloud interface VPC endpoint

Enter the API endpoint for the interface endpoint, such as vpce-123456789abcdef01-example-us-east-1a.elasticloadbalancing.us-east-1.vpce.amazonaws.com. For edge-optimized APIs, this is the domain name for the corresponding CloudFront distribution. You can get the value of DnsName using the CLI command describe-vpc-endpoints.

CloudFront distribution

Specify the domain name that CloudFront assigned when you created your distribution.

Your CloudFront distribution must include an alternate domain name that matches the name of the resource record set. For example, if the name of the resource record set is acme.example.com, your CloudFront distribution must include acme.example.com as one of the alternate domain names. For more information, see Using Alternate Domain Names (CNAMEs) in the Amazon CloudFront Developer Guide.

You can't create a resource record set in a private hosted zone to route traffic to a CloudFront distribution.

For failover alias records, you can't specify a CloudFront distribution for both the primary and secondary records. A distribution must include an alternate domain name that matches the name of the record. However, the primary and secondary records have the same name, and you can't include the same alternate domain name in more than one distribution.

Elastic Beanstalk environment

If the domain name for your Elastic Beanstalk environment includes the region that you deployed the environment in, you can create an alias record that routes traffic to the environment. For example, the domain name my-environment.us-west-2.elasticbeanstalk.com is a regionalized domain name.

For environments that were created before early 2016, the domain name doesn't include the region. To route traffic to these environments, you must create a CNAME record instead of an alias record. Note that you can't create a CNAME record for the root domain name. For example, if your domain name is example.com, you can create a record that routes traffic for acme.example.com to your Elastic Beanstalk environment, but you can't create a record that routes traffic for example.com to your Elastic Beanstalk environment.

For Elastic Beanstalk environments that have regionalized subdomains, specify the CNAME attribute for the environment. You can use the following methods to get the value of the CNAME attribute:

  • Amazon Web Services Management Console: For information about how to get the value by using the console, see Using Custom Domains with Elastic Beanstalk in the Elastic Beanstalk Developer Guide.

  • Elastic Beanstalk API: Use the DescribeEnvironments action to get the value of the CNAME attribute. For more information, see DescribeEnvironments in the Elastic Beanstalk API Reference.

  • CLI: Use the describe-environments command to get the value of the CNAME attribute. For more information, see describe-environments in the CLI Command Reference.

ELB load balancer

Specify the DNS name that is associated with the load balancer. Get the DNS name by using the Amazon Web Services Management Console, the ELB API, or the CLI.

  • Amazon Web Services Management Console: Go to the EC2 page, choose Load Balancers in the navigation pane, choose the load balancer, choose the Description tab, and get the value of the DNS name field.

    If you're routing traffic to a Classic Load Balancer, get the value that begins with dualstack. If you're routing traffic to another type of load balancer, get the value that applies to the record type, A or AAAA.

  • Elastic Load Balancing API: Use DescribeLoadBalancers to get the value of DNSName. For more information, see the applicable guide:

  • CLI: Use describe-load-balancers to get the value of DNSName. For more information, see the applicable guide:

Global Accelerator accelerator

Specify the DNS name for your accelerator:

Amazon S3 bucket that is configured as a static website

Specify the domain name of the Amazon S3 website endpoint that you created the bucket in, for example, s3-website.us-east-2.amazonaws.com. For more information about valid values, see the table Amazon S3 Website Endpoints in the Amazon Web Services General Reference. For more information about using S3 buckets for websites, see Getting Started with Amazon Route 53 in the Amazon Route 53 Developer Guide.

Another Route 53 resource record set

Specify the value of the Name element for a resource record set in the current hosted zone.

If you're creating an alias record that has the same name as the hosted zone (known as the zone apex), you can't specify the domain name for a record for which the value of Type is CNAME. This is because the alias record must have the same type as the record that you're routing traffic to, and creating a CNAME record for the zone apex isn't supported even for an alias record.
" - EvaluateTargetHealth: - allOf: - - $ref: "#/components/schemas/AliasHealthEnabled" - - description: "

Applies only to alias, failover alias, geolocation alias, latency alias, and weighted alias resource record sets: When EvaluateTargetHealth is true, an alias resource record set inherits the health of the referenced Amazon Web Services resource, such as an ELB load balancer or another resource record set in the hosted zone.

Note the following:

CloudFront distributions

You can't set EvaluateTargetHealth to true when the alias target is a CloudFront distribution.

Elastic Beanstalk environments that have regionalized subdomains

If you specify an Elastic Beanstalk environment in DNSName and the environment contains an ELB load balancer, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. (An environment automatically contains an ELB load balancer if it includes more than one Amazon EC2 instance.) If you set EvaluateTargetHealth to true and either no Amazon EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other available resources that are healthy, if any.

If the environment contains a single Amazon EC2 instance, there are no special requirements.

ELB load balancers

Health checking behavior depends on the type of load balancer:

  • Classic Load Balancers: If you specify an ELB Classic Load Balancer in DNSName, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. If you set EvaluateTargetHealth to true and either no EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other resources.

  • Application and Network Load Balancers: If you specify an ELB Application or Network Load Balancer and you set EvaluateTargetHealth to true, Route 53 routes queries to the load balancer based on the health of the target groups that are associated with the load balancer:

    • For an Application or Network Load Balancer to be considered healthy, every target group that contains targets must contain at least one healthy target. If any target group contains only unhealthy targets, the load balancer is considered unhealthy, and Route 53 routes queries to other resources.

    • A target group that has no registered targets is considered unhealthy.

When you create a load balancer, you configure settings for Elastic Load Balancing health checks; they're not Route 53 health checks, but they perform a similar function. Do not create Route 53 health checks for the EC2 instances that you register with an ELB load balancer.

S3 buckets

There are no special requirements for setting EvaluateTargetHealth to true when the alias target is an S3 bucket.

Other records in the same hosted zone

If the Amazon Web Services resource that you specify in DNSName is a record or a group of records (for example, a group of weighted records) but is not another alias record, we recommend that you associate a health check with all of the records in the alias target. For more information, see What Happens When You Omit Health Checks? in the Amazon Route 53 Developer Guide.

For more information and examples, see Amazon Route 53 Health Checks and DNS Failover in the Amazon Route 53 Developer Guide.

" - description:

Alias resource record sets only: Information about the Amazon Web Services resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to.

When creating resource record sets for a private hosted zone, note the following:

- AssociateVPCComment: - type: string - VPC: - type: object - properties: - VPCRegion: - allOf: - - $ref: "#/components/schemas/VPCRegion" - - description: (Private hosted zones only) The region that an Amazon VPC was created in. - VPCId: - $ref: "#/components/schemas/VPCId" - description:

(Private hosted zones only) A complex type that contains information about an Amazon VPC.

If you associate a private hosted zone with an Amazon VPC when you make a CreateHostedZone request, the following parameters are also required.

- AssociateVPCWithHostedZoneRequest: - type: object - required: - - VPC - title: AssociateVPCWithHostedZoneRequest - properties: - VPC: - allOf: - - $ref: "#/components/schemas/VPC" - - description: A complex type that contains information about the VPC that you want to associate with a private hosted zone. - Comment: - allOf: - - $ref: "#/components/schemas/AssociateVPCComment" - - description: " Optional: A comment about the association request." - description: A complex type that contains information about the request to associate a VPC with a private hosted zone. - ChangeAction: - type: string - enum: - - CREATE - - DELETE - - UPSERT - ResourceRecordSet: - type: object - required: - - Name - - Type - properties: - Name: - allOf: - - $ref: "#/components/schemas/DNSName" - - description:

For ChangeResourceRecordSets requests, the name of the record that you want to create, update, or delete. For ListResourceRecordSets responses, the name of a record in the specified hosted zone.

ChangeResourceRecordSets Only

Enter a fully qualified domain name, for example, www.example.com. You can optionally include a trailing dot. If you omit the trailing dot, Amazon Route 53 assumes that the domain name that you specify is fully qualified. This means that Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.

For information about how to specify characters other than a-z, 0-9, and - (hyphen) and how to specify internationalized domain names, see DNS Domain Name Format in the Amazon Route 53 Developer Guide.

You can use the asterisk (*) wildcard to replace the leftmost label in a domain name, for example, *.example.com. Note the following:

  • The * must replace the entire label. For example, you can't specify *prod.example.com or prod*.example.com.

  • The * can't replace any of the middle labels, for example, marketing.*.example.com.

  • If you include * in any position other than the leftmost label in a domain name, DNS treats it as an * character (ASCII 42), not as a wildcard.

    You can't use the * wildcard for resource records sets that have a type of NS.

You can use the * wildcard as the leftmost label in a domain name, for example, *.example.com. You can't use an * for one of the middle labels, for example, marketing.*.example.com. In addition, the * must replace the entire label; for example, you can't specify prod*.example.com.

- Type: - allOf: - - $ref: "#/components/schemas/RRType" - - description: "

The DNS record type. For information about different record types and how data is encoded for them, see Supported DNS Resource Record Types in the Amazon Route 53 Developer Guide.

Valid values for basic resource record sets: A | AAAA | CAA | CNAME | DS |MX | NAPTR | NS | PTR | SOA | SPF | SRV | TXT

Values for weighted, latency, geolocation, and failover resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | PTR | SPF | SRV | TXT. When creating a group of weighted, latency, geolocation, or failover resource record sets, specify the same value for all of the resource record sets in the group.

Valid values for multivalue answer resource record sets: A | AAAA | MX | NAPTR | PTR | SPF | SRV | TXT

SPF records were formerly used to verify the identity of the sender of email messages. However, we no longer recommend that you create resource record sets for which the value of Type is SPF. RFC 7208, Sender Policy Framework (SPF) for Authorizing Use of Domains in Email, Version 1, has been updated to say, \"...[I]ts existence and mechanism defined in [RFC4408] have led to some interoperability issues. Accordingly, its use is no longer appropriate for SPF version 1; implementations are not to use it.\" In RFC 7208, see section 14.1, The SPF DNS Record Type.

Values for alias resource record sets:

  • Amazon API Gateway custom regional APIs and edge-optimized APIs: A

  • CloudFront distributions: A

    If IPv6 is enabled for the distribution, create two resource record sets to route traffic to your distribution, one with a value of A and one with a value of AAAA.

  • Amazon API Gateway environment that has a regionalized subdomain: A

  • ELB load balancers: A | AAAA

  • Amazon S3 buckets: A

  • Amazon Virtual Private Cloud interface VPC endpoints A

  • Another resource record set in this hosted zone: Specify the type of the resource record set that you're creating the alias for. All values are supported except NS and SOA.

    If you're creating an alias record that has the same name as the hosted zone (known as the zone apex), you can't route traffic to a record for which the value of Type is CNAME. This is because the alias record must have the same type as the record you're routing traffic to, and creating a CNAME record for the zone apex isn't supported even for an alias record.
" - SetIdentifier: - allOf: - - $ref: "#/components/schemas/ResourceRecordSetIdentifier" - - description:

Resource record sets that have a routing policy other than simple: An identifier that differentiates among multiple resource record sets that have the same combination of name and type, such as multiple weighted resource record sets named acme.example.com that have a type of A. In a group of resource record sets that have the same name and type, the value of SetIdentifier must be unique for each resource record set.

For information about routing policies, see Choosing a Routing Policy in the Amazon Route 53 Developer Guide.

- Weight: - allOf: - - $ref: "#/components/schemas/ResourceRecordSetWeight" - - description:

Weighted resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that determines the proportion of DNS queries that Amazon Route 53 responds to using the current resource record set. Route 53 calculates the sum of the weights for the resource record sets that have the same combination of DNS name and type. Route 53 then responds to queries based on the ratio of a resource's weight to the total. Note the following:

  • You must specify a value for the Weight element for every weighted resource record set.

  • You can only specify one ResourceRecord per weighted resource record set.

  • You can't create latency, failover, or geolocation resource record sets that have the same values for the Name and Type elements as weighted resource record sets.

  • You can create a maximum of 100 weighted resource record sets that have the same values for the Name and Type elements.

  • For weighted (but not weighted alias) resource record sets, if you set Weight to 0 for a resource record set, Route 53 never responds to queries with the applicable value for that resource record set. However, if you set Weight to 0 for all resource record sets that have the same combination of DNS name and type, traffic is routed to all resources with equal probability.

    The effect of setting Weight to 0 is different when you associate health checks with weighted resource record sets. For more information, see Options for Configuring Route 53 Active-Active and Active-Passive Failover in the Amazon Route 53 Developer Guide.

- Region: - allOf: - - $ref: "#/components/schemas/ResourceRecordSetRegion" - - description:

Latency-based resource record sets only: The Amazon EC2 Region where you created the resource that this resource record set refers to. The resource typically is an Amazon Web Services resource, such as an EC2 instance or an ELB load balancer, and is referred to by an IP address or a DNS domain name, depending on the record type.

When Amazon Route 53 receives a DNS query for a domain name and type for which you have created latency resource record sets, Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 Region. Route 53 then returns the value that is associated with the selected resource record set.

Note the following:

  • You can only specify one ResourceRecord per latency resource record set.

  • You can only create one latency resource record set for each Amazon EC2 Region.

  • You aren't required to create latency resource record sets for all Amazon EC2 Regions. Route 53 will choose the region with the best latency from among the regions that you create latency resource record sets for.

  • You can't create non-latency resource record sets that have the same values for the Name and Type elements as latency resource record sets.

- GeoLocation: - allOf: - - $ref: "#/components/schemas/GeoLocation" - - description: "

Geolocation resource record sets only: A complex type that lets you control how Amazon Route 53 responds to DNS queries based on the geographic origin of the query. For example, if you want all queries from Africa to be routed to a web server with an IP address of 192.0.2.111, create a resource record set with a Type of A and a ContinentCode of AF.

Although creating geolocation and geolocation alias resource record sets in a private hosted zone is allowed, it's not supported.

If you create separate resource record sets for overlapping geographic regions (for example, one resource record set for a continent and one for a country on the same continent), priority goes to the smallest geographic region. This allows you to route most queries for a continent to one resource and to route queries for a country on that continent to a different resource.

You can't create two geolocation resource record sets that specify the same geographic location.

The value * in the CountryCode element matches all geographic locations that aren't specified in other geolocation resource record sets that have the same values for the Name and Type elements.

Geolocation works by mapping IP addresses to locations. However, some IP addresses aren't mapped to geographic locations, so even if you create geolocation resource record sets that cover all seven continents, Route 53 will receive some DNS queries from locations that it can't identify. We recommend that you create a resource record set for which the value of CountryCode is *. Two groups of queries are routed to the resource that you specify in this record: queries that come from locations for which you haven't created geolocation resource record sets and queries from IP addresses that aren't mapped to a location. If you don't create a * resource record set, Route 53 returns a \"no answer\" response for queries from those locations.

You can't create non-geolocation resource record sets that have the same values for the Name and Type elements as geolocation resource record sets.

" - Failover: - allOf: - - $ref: "#/components/schemas/ResourceRecordSetFailover" - - description: "

Failover resource record sets only: To configure failover, you add the Failover element to two resource record sets. For one resource record set, you specify PRIMARY as the value for Failover; for the other resource record set, you specify SECONDARY. In addition, you include the HealthCheckId element and specify the health check that you want Amazon Route 53 to perform for each resource record set.

Except where noted, the following failover behaviors assume that you have included the HealthCheckId element in both resource record sets:

  • When the primary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the secondary resource record set.

  • When the primary resource record set is unhealthy and the secondary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the secondary resource record set.

  • When the secondary resource record set is unhealthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the primary resource record set.

  • If you omit the HealthCheckId element for the secondary resource record set, and if the primary resource record set is unhealthy, Route 53 always responds to DNS queries with the applicable value from the secondary resource record set. This is true regardless of the health of the associated endpoint.

You can't create non-failover resource record sets that have the same values for the Name and Type elements as failover resource record sets.

For failover alias resource record sets, you must also include the EvaluateTargetHealth element and set the value to true.

For more information about configuring failover for Route 53, see the following topics in the Amazon Route 53 Developer Guide:

" - MultiValueAnswer: - allOf: - - $ref: "#/components/schemas/ResourceRecordSetMultiValueAnswer" - - description: "

Multivalue answer resource record sets only: To route traffic approximately randomly to multiple resources, such as web servers, create one multivalue answer record for each resource and specify true for MultiValueAnswer. Note the following:

  • If you associate a health check with a multivalue answer resource record set, Amazon Route 53 responds to DNS queries with the corresponding IP address only when the health check is healthy.

  • If you don't associate a health check with a multivalue answer record, Route 53 always considers the record to be healthy.

  • Route 53 responds to DNS queries with up to eight healthy records; if you have eight or fewer healthy records, Route 53 responds to all DNS queries with all the healthy records.

  • If you have more than eight healthy records, Route 53 responds to different DNS resolvers with different combinations of healthy records.

  • When all records are unhealthy, Route 53 responds to DNS queries with up to eight unhealthy records.

  • If a resource becomes unavailable after a resolver caches a response, client software typically tries another of the IP addresses in the response.

You can't create multivalue answer alias records.

" - TTL: - allOf: - - $ref: "#/components/schemas/TTL" - - description:

The resource record cache time to live (TTL), in seconds. Note the following:

  • If you're creating or updating an alias resource record set, omit TTL. Amazon Route 53 uses the value of TTL for the alias target.

  • If you're associating this resource record set with a health check (if you're adding a HealthCheckId element), we recommend that you specify a TTL of 60 seconds or less so clients respond quickly to changes in health status.

  • All of the resource record sets in a group of weighted resource record sets must have the same value for TTL.

  • If a group of weighted resource record sets includes one or more weighted alias resource record sets for which the alias target is an ELB load balancer, we recommend that you specify a TTL of 60 seconds for all of the non-alias weighted resource record sets that have the same name and type. Values other than 60 seconds (the TTL for load balancers) will change the effect of the values that you specify for Weight.

- ResourceRecords: - allOf: - - $ref: "#/components/schemas/ResourceRecords" - - description:

Information about the resource records to act upon.

If you're creating an alias resource record set, omit ResourceRecords.

 - AliasTarget: - allOf: - - $ref: "#/components/schemas/AliasTarget" - - description:

Alias resource record sets only: Information about the Amazon Web Services resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to.

If you're creating resource records sets for a private hosted zone, note the following:

  • You can't create an alias resource record set in a private hosted zone to route traffic to a CloudFront distribution.

  • For information about creating failover resource record sets in a private hosted zone, see Configuring Failover in a Private Hosted Zone in the Amazon Route 53 Developer Guide.

- HealthCheckId: - allOf: - - $ref: "#/components/schemas/HealthCheckId" - - description: "

If you want Amazon Route 53 to return this resource record set in response to a DNS query only when the status of a health check is healthy, include the HealthCheckId element and specify the ID of the applicable health check.

Route 53 determines whether a resource record set is healthy based on one of the following:

  • By periodically sending a request to the endpoint that is specified in the health check

  • By aggregating the status of a specified group of health checks (calculated health checks)

  • By determining the current state of a CloudWatch alarm (CloudWatch metric health checks)

Route 53 doesn't check the health of the endpoint that is specified in the resource record set, for example, the endpoint specified by the IP address in the Value element. When you add a HealthCheckId element to a resource record set, Route 53 checks the health of the endpoint that you specified in the health check.

For more information, see the following topics in the Amazon Route 53 Developer Guide:

When to Specify HealthCheckId

Specifying a value for HealthCheckId is useful only when Route 53 is choosing between two or more resource record sets to respond to a DNS query, and you want Route 53 to base the choice in part on the status of a health check. Configuring health checks makes sense only in the following configurations:

  • Non-alias resource record sets: You're checking the health of a group of non-alias resource record sets that have the same routing policy, name, and type (such as multiple weighted records named www.example.com with a type of A) and you specify health check IDs for all the resource record sets.

    If the health check status for a resource record set is healthy, Route 53 includes the record among the records that it responds to DNS queries with.

    If the health check status for a resource record set is unhealthy, Route 53 stops responding to DNS queries using the value for that resource record set.

    If the health check status for all resource record sets in the group is unhealthy, Route 53 considers all resource record sets in the group healthy and responds to DNS queries accordingly.

  • Alias resource record sets: You specify the following settings:

    • You set EvaluateTargetHealth to true for an alias resource record set in a group of resource record sets that have the same routing policy, name, and type (such as multiple weighted records named www.example.com with a type of A).

    • You configure the alias resource record set to route traffic to a non-alias resource record set in the same hosted zone.

    • You specify a health check ID for the non-alias resource record set.

    If the health check status is healthy, Route 53 considers the alias resource record set to be healthy and includes the alias record among the records that it responds to DNS queries with.

    If the health check status is unhealthy, Route 53 stops responding to DNS queries using the alias resource record set.

    The alias resource record set can also route traffic to a group of non-alias resource record sets that have the same routing policy, name, and type. In that configuration, associate health checks with all of the resource record sets in the group of non-alias resource record sets.

Geolocation Routing

For geolocation resource record sets, if an endpoint is unhealthy, Route 53 looks for a resource record set for the larger, associated geographic region. For example, suppose you have resource record sets for a state in the United States, for the entire United States, for North America, and a resource record set that has * for CountryCode is *, which applies to all locations. If the endpoint for the state resource record set is unhealthy, Route 53 checks for healthy resource record sets in the following order until it finds a resource record set for which the endpoint is healthy:

  • The United States

  • North America

  • The default resource record set

Specifying the Health Check Endpoint by Domain Name

If your health checks specify the endpoint only by domain name, we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName, specify the domain name of the server (such as us-east-2-www.example.com), not the name of the resource record sets (www.example.com).

Health check results will be unpredictable if you do the following:

  • Create a health check that has the same value for FullyQualifiedDomainName as the name of a resource record set.

  • Associate that health check with the resource record set.

" - TrafficPolicyInstanceId: - allOf: - - $ref: "#/components/schemas/TrafficPolicyInstanceId" - - description:

When you create a traffic policy instance, Amazon Route 53 automatically creates a resource record set. TrafficPolicyInstanceId is the ID of the traffic policy instance that Route 53 created this resource record set for.

To delete the resource record set that is associated with a traffic policy instance, use DeleteTrafficPolicyInstance. Route 53 will delete the resource record set automatically. If you delete the resource record set by using ChangeResourceRecordSets, Route 53 doesn't automatically delete the traffic policy instance, and you'll continue to be charged for it even though it's no longer in use.

- CidrRoutingConfig: - $ref: "#/components/schemas/CidrRoutingConfig" - description: Information about the resource record set to create or delete. - Change: - type: object - required: - - Action - - ResourceRecordSet - properties: - Action: - allOf: - - $ref: "#/components/schemas/ChangeAction" - - description: "

The action to perform:

  • CREATE: Creates a resource record set that has the specified values.

  • DELETE: Deletes a existing resource record set.

    To delete the resource record set that is associated with a traffic policy instance, use DeleteTrafficPolicyInstance. Amazon Route 53 will delete the resource record set automatically. If you delete the resource record set by using ChangeResourceRecordSets, Route 53 doesn't automatically delete the traffic policy instance, and you'll continue to be charged for it even though it's no longer in use.

  • UPSERT: If a resource record set doesn't already exist, Route 53 creates it. If a resource record set does exist, Route 53 updates it with the values in the request.

" - ResourceRecordSet: - allOf: - - $ref: "#/components/schemas/ResourceRecordSet" - - description: Information about the resource record set to create, delete, or update. - description: The information for each resource record set that you want to change. - ChangeBatch: - type: object - required: - - Changes - properties: - Comment: - allOf: - - $ref: "#/components/schemas/ResourceDescription" - - description: " Optional: Any comments you want to include about a change batch request." - Changes: - allOf: - - $ref: "#/components/schemas/Changes" - - description: Information about the changes to make to the record sets. - description: The information for a change request. - UUID: - type: string - pattern: "[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}" - CollectionVersion: - type: integer - minimum: 1 - CidrCollectionChanges: - type: array - items: - $ref: "#/components/schemas/CidrCollectionChange" - minItems: 1 - maxItems: 1000 - ChangeCidrCollectionRequest: - type: object - required: - - Changes - title: ChangeCidrCollectionRequest - properties: - CollectionVersion: - allOf: - - $ref: "#/components/schemas/CollectionVersion" - - description: "

A sequential counter that Amazon Route 53 sets to 1 when you create a collection and increments it by 1 each time you update the collection.

We recommend that you use ListCidrCollection to get the current value of CollectionVersion for the collection that you want to update, and then include that value with the change request. This prevents Route 53 from overwriting an intervening update:

  • If the value in the request matches the value of CollectionVersion in the collection, Route 53 updates the collection.

  • If the value of CollectionVersion in the collection is greater than the value in the request, the collection was changed after you got the version number. Route 53 does not update the collection, and it returns a CidrCollectionVersionMismatch error.

" - Changes: - allOf: - - $ref: "#/components/schemas/CidrCollectionChanges" - - description: " Information about changes to a CIDR collection." - ChangeId: - type: string - minLength: 1 - maxLength: 6500 - ChangeStatus: - type: string - enum: - - PENDING - - INSYNC - TimeStamp: - type: string - format: date-time - ChangeResourceRecordSetsRequest: - type: object - required: - - ChangeBatch - title: ChangeResourceRecordSetsRequest - properties: - ChangeBatch: - allOf: - - $ref: "#/components/schemas/ChangeBatch" - - description: A complex type that contains an optional comment and the Changes element. - description: A complex type that contains change information for the resource record set. - TagResourceType: - type: string - enum: - - healthcheck - - hostedzone - TagList: - type: array - items: - allOf: - - $ref: "#/components/schemas/Tag" - - xml: - name: Tag - minItems: 1 - maxItems: 10 - TagKeyList: - type: array - items: - allOf: - - $ref: "#/components/schemas/TagKey" - - xml: - name: Key - minItems: 1 - maxItems: 10 - ChangeTagsForResourceRequest: - type: object - title: ChangeTagsForResourceRequest - properties: - AddTags: - allOf: - - $ref: "#/components/schemas/TagList" - - description:

A complex type that contains a list of the tags that you want to add to the specified health check or hosted zone and/or the tags that you want to edit Value for.

You can add a maximum of 10 tags to a health check or a hosted zone.

- RemoveTagKeys: - allOf: - - $ref: "#/components/schemas/TagKeyList" - - description: A complex type that contains a list of the tags that you want to delete from the specified health check or hosted zone. You can specify up to 10 keys. - description: A complex type that contains information about the tags that you want to add, edit, or delete. - IPAddressCidr: - type: string - CheckerIpRanges: - type: array - items: - $ref: "#/components/schemas/IPAddressCidr" - Cidr: - type: string - pattern: .*\S.* - minLength: 1 - maxLength: 50 - CidrBlockSummary: - type: object - properties: - CidrBlock: - allOf: - - $ref: "#/components/schemas/Cidr" - - description: Value for the CIDR block. - LocationName: - allOf: - - $ref: "#/components/schemas/CidrLocationNameDefaultNotAllowed" - - description: The location name of the CIDR block. - description: A complex type that lists the CIDR blocks. - CidrBlockSummaries: - type: array - items: - $ref: "#/components/schemas/CidrBlockSummary" - CidrLocationNameDefaultNotAllowed: - type: string - pattern: "[0-9A-Za-z_\\-]+" - minLength: 1 - maxLength: 16 - CollectionName: - type: string - pattern: "[0-9A-Za-z_\\-]+" - minLength: 1 - maxLength: 64 - CidrCollection: - type: object - properties: - Arn: - allOf: - - $ref: "#/components/schemas/ARN" - - description: The ARN of the collection. Can be used to reference the collection in IAM policy or in another Amazon Web Services account. - Id: - allOf: - - $ref: "#/components/schemas/UUID" - - description: The unique ID of the CIDR collection. - Name: - allOf: - - $ref: "#/components/schemas/CollectionName" - - description: The name of a CIDR collection. - Version: - allOf: - - $ref: "#/components/schemas/CollectionVersion" - - description: A sequential counter that Route 53 sets to 1 when you create a CIDR collection and increments by 1 each time you update settings for the CIDR collection. - description: A complex type that identifies a CIDR collection. - CidrCollectionChangeAction: - type: string - enum: - - PUT - - DELETE_IF_EXISTS - CidrList: - type: array - items: - allOf: - - $ref: "#/components/schemas/Cidr" - - xml: - name: Cidr - minItems: 1 - maxItems: 1000 - CidrLocationNameDefaultAllowed: - type: string - pattern: "[0-9A-Za-z_\\-\\*]+" - minLength: 1 - maxLength: 16 - CidrNonce: - type: string - pattern: \p{ASCII}+ - minLength: 1 - maxLength: 64 - CidrRoutingConfig: - type: object - required: - - CollectionId - - LocationName - properties: - CollectionId: - allOf: - - $ref: "#/components/schemas/UUID" - - description: The CIDR collection ID. - LocationName: - allOf: - - $ref: "#/components/schemas/CidrLocationNameDefaultAllowed" - - description: The CIDR collection location name. - description:

The object that is specified in resource record set object when you are linking a resource record set to a CIDR location.

A LocationName with an asterisk “*” can be used to create a default CIDR record. CollectionId is still required for default record.

- EvaluationPeriods: - type: integer - minimum: 1 - Threshold: - type: number - format: double - ComparisonOperator: - type: string - enum: - - GreaterThanOrEqualToThreshold - - GreaterThanThreshold - - LessThanThreshold - - LessThanOrEqualToThreshold - Period: - type: integer - minimum: 60 - MetricName: - type: string - minLength: 1 - maxLength: 255 - Namespace: - type: string - minLength: 1 - maxLength: 255 - Statistic: - type: string - enum: - - Average - - Sum - - SampleCount - - Maximum - - Minimum - DimensionList: - type: array - items: - allOf: - - $ref: "#/components/schemas/Dimension" - - xml: - name: Dimension - maxItems: 10 - CloudWatchAlarmConfiguration: - type: object - required: - - EvaluationPeriods - - Threshold - - ComparisonOperator - - Period - - MetricName - - Namespace - - Statistic - properties: - EvaluationPeriods: - allOf: - - $ref: "#/components/schemas/EvaluationPeriods" - - description: For the metric that the CloudWatch alarm is associated with, the number of periods that the metric is compared to the threshold. - Threshold: - allOf: - - $ref: "#/components/schemas/Threshold" - - description: For the metric that the CloudWatch alarm is associated with, the value the metric is compared with. - ComparisonOperator: - allOf: - - $ref: "#/components/schemas/ComparisonOperator" - - description: For the metric that the CloudWatch alarm is associated with, the arithmetic operation that is used for the comparison. - Period: - allOf: - - $ref: "#/components/schemas/Period" - - description: For the metric that the CloudWatch alarm is associated with, the duration of one evaluation period in seconds. - MetricName: - allOf: - - $ref: "#/components/schemas/MetricName" - - description: The name of the CloudWatch metric that the alarm is associated with. - Namespace: - allOf: - - $ref: "#/components/schemas/Namespace" - - description: The namespace of the metric that the alarm is associated with. For more information, see Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference in the Amazon CloudWatch User Guide. - Statistic: - allOf: - - $ref: "#/components/schemas/Statistic" - - description: For the metric that the CloudWatch alarm is associated with, the statistic that is applied to the metric. - Dimensions: - allOf: - - $ref: "#/components/schemas/DimensionList" - - description: For the metric that the CloudWatch alarm is associated with, a complex type that contains information about the dimensions for the metric. For information, see Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference in the Amazon CloudWatch User Guide. - description: A complex type that contains information about the CloudWatch alarm that Amazon Route 53 is monitoring for this health check. - CloudWatchLogsLogGroupArn: - type: string - CollectionSummary: - type: object - properties: - Arn: - allOf: - - $ref: "#/components/schemas/ARN" - - description: The ARN of the collection summary. Can be used to reference the collection in IAM policy or cross-account. - Id: - allOf: - - $ref: "#/components/schemas/UUID" - - description: Unique ID for the CIDR collection. - Name: - allOf: - - $ref: "#/components/schemas/CollectionName" - - description: The name of a CIDR collection. - Version: - allOf: - - $ref: "#/components/schemas/CollectionVersion" - - description: A sequential counter that Route 53 sets to 1 when you create a CIDR collection and increments by 1 each time you update settings for the CIDR collection. - description: A complex type that is an entry in an CidrCollection array. - CollectionSummaries: - type: array - items: - $ref: "#/components/schemas/CollectionSummary" - CreateCidrCollectionRequest: - type: object - required: - - Name - - CallerReference - title: CreateCidrCollectionRequest - properties: - Name: - allOf: - - $ref: "#/components/schemas/CollectionName" - - description: A unique identifier for the account that can be used to reference the collection from other API calls. - CallerReference: - allOf: - - $ref: "#/components/schemas/CidrNonce" - - description: A client-specific token that allows requests to be securely retried so that the intended outcome will only occur once, retries receive a similar response, and there are no additional edge cases to handle. - ResourceURI: - type: string - maxLength: 1024 - HealthCheckNonce: - type: string - minLength: 1 - maxLength: 64 - HealthCheckConfig: - type: object - required: - - Type - properties: - IPAddress: - allOf: - - $ref: "#/components/schemas/IPAddress" - - description: "

The IPv4 or IPv6 IP address of the endpoint that you want Amazon Route 53 to perform health checks on. If you don't specify a value for IPAddress, Route 53 sends a DNS request to resolve the domain name that you specify in FullyQualifiedDomainName at the interval that you specify in RequestInterval. Using an IP address returned by DNS, Route 53 then checks the health of the endpoint.

Use one of the following formats for the value of IPAddress:

  • IPv4 address: four values between 0 and 255, separated by periods (.), for example, 192.0.2.44.

  • IPv6 address: eight groups of four hexadecimal values, separated by colons (:), for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345. You can also shorten IPv6 addresses as described in RFC 5952, for example, 2001:db8:85a3::abcd:1:2345.

If the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with your EC2 instance, and specify the Elastic IP address for IPAddress. This ensures that the IP address of your instance will never change.

For more information, see FullyQualifiedDomainName.

Constraints: Route 53 can't check the health of endpoints for which the IP address is in local, private, non-routable, or multicast ranges. For more information about IP addresses for which you can't create health checks, see the following documents:

When the value of Type is CALCULATED or CLOUDWATCH_METRIC, omit IPAddress.

" - Port: - allOf: - - $ref: "#/components/schemas/Port" - - description:

The port on the endpoint that you want Amazon Route 53 to perform health checks on.

Don't specify a value for Port when you specify a value for Type of CLOUDWATCH_METRIC or CALCULATED.

 - Type: - allOf: - - $ref: "#/components/schemas/HealthCheckType" - - description: "

The type of health check that you want to create, which indicates how Amazon Route 53 determines whether an endpoint is healthy.

You can't change the value of Type after you create a health check.

You can create the following types of health checks:

  • HTTP: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.

  • HTTPS: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.

    If you specify HTTPS for the value of Type, the endpoint must support TLS v1.0 or later.

  • HTTP_STR_MATCH: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString.

  • HTTPS_STR_MATCH: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString.

  • TCP: Route 53 tries to establish a TCP connection.

  • CLOUDWATCH_METRIC: The health check is associated with a CloudWatch alarm. If the state of the alarm is OK, the health check is considered healthy. If the state is ALARM, the health check is considered unhealthy. If CloudWatch doesn't have sufficient data to determine whether the state is OK or ALARM, the health check status depends on the setting for InsufficientDataHealthStatus: Healthy, Unhealthy, or LastKnownStatus.

  • CALCULATED: For health checks that monitor the status of other health checks, Route 53 adds up the number of health checks that Route 53 health checkers consider to be healthy and compares that number with the value of HealthThreshold.

  • RECOVERY_CONTROL: The health check is assocated with a Route53 Application Recovery Controller routing control. If the routing control state is ON, the health check is considered healthy. If the state is OFF, the health check is considered unhealthy.

For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.

" - ResourcePath: - allOf: - - $ref: "#/components/schemas/ResourcePath" - - description: "The path, if any, that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example, the file /docs/route53-health-check.html. You can also include query string parameters, for example, /welcome.html?language=jp&login=y. " - FullyQualifiedDomainName: - allOf: - - $ref: "#/components/schemas/FullyQualifiedDomainName" - - description:

Amazon Route 53 behavior depends on whether you specify a value for IPAddress.

If you specify a value for IPAddress:

Amazon Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of FullyQualifiedDomainName in the Host header for all health checks except TCP health checks. This is typically the fully qualified DNS name of the endpoint on which you want Route 53 to perform health checks.

When Route 53 checks the health of an endpoint, here is how it constructs the Host header:

  • If you specify a value of 80 for Port and HTTP or HTTP_STR_MATCH for Type, Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

  • If you specify a value of 443 for Port and HTTPS or HTTPS_STR_MATCH for Type, Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

  • If you specify another value for Port and any value except TCP for Type, Route 53 passes FullyQualifiedDomainName:Port to the endpoint in the Host header.

If you don't specify a value for FullyQualifiedDomainName, Route 53 substitutes the value of IPAddress in the Host header in each of the preceding cases.

If you don't specify a value for IPAddress:

Route 53 sends a DNS request to the domain that you specify for FullyQualifiedDomainName at the interval that you specify for RequestInterval. Using an IPv4 address that DNS returns, Route 53 then checks the health of the endpoint.

If you don't specify a value for IPAddress, Route 53 uses only IPv4 to send health checks to the endpoint. If there's no resource record set with a type of A for the name that you specify for FullyQualifiedDomainName, the health check fails with a "DNS resolution failed" error.

If you want to check the health of weighted, latency, or failover resource record sets and you choose to specify the endpoint only by FullyQualifiedDomainName, we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName, specify the domain name of the server (such as us-east-2-www.example.com), not the name of the resource record sets (www.example.com).

In this configuration, if you create a health check for which the value of FullyQualifiedDomainName matches the name of the resource record sets and you then associate the health check with those resource record sets, health check results will be unpredictable.

In addition, if the value that you specify for Type is HTTP, HTTPS, HTTP_STR_MATCH, or HTTPS_STR_MATCH, Route 53 passes the value of FullyQualifiedDomainName in the Host header, as it does when you specify a value for IPAddress. If the value of Type is TCP, Route 53 doesn't pass a Host header.

- SearchString: - allOf: - - $ref: "#/components/schemas/SearchString" - - description:

If the value of Type is HTTP_STR_MATCH or HTTPS_STR_MATCH, the string that you want Amazon Route 53 to search for in the response body from the specified resource. If the string appears in the response body, Route 53 considers the resource healthy.

Route 53 considers case when searching for SearchString in the response body.

- RequestInterval: - allOf: - - $ref: "#/components/schemas/RequestInterval" - - description:

The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health check request. Each Route 53 health checker makes requests at this interval.

You can't change the value of RequestInterval after you create a health check.

If you don't specify a value for RequestInterval, the default value is 30 seconds.

- FailureThreshold: - allOf: - - $ref: "#/components/schemas/FailureThreshold" - - description:

The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.

If you don't specify a value for FailureThreshold, the default value is three health checks.

- MeasureLatency: - allOf: - - $ref: "#/components/schemas/MeasureLatency" - - description:

Specify whether you want Amazon Route 53 to measure the latency between health checkers in multiple Amazon Web Services regions and your endpoint, and to display CloudWatch latency graphs on the Health Checks page in the Route 53 console.

You can't change the value of MeasureLatency after you create a health check.

 - Inverted: - allOf: - - $ref: "#/components/schemas/Inverted" - - description: Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider a health check unhealthy when it otherwise would be considered healthy. - Disabled: - allOf: - - $ref: "#/components/schemas/Disabled" - - description:

Stops Route 53 from performing health checks. When you disable a health check, here's what happens:

  • Health checks that check the health of endpoints: Route 53 stops submitting requests to your application, server, or other resource.

  • Calculated health checks: Route 53 stops aggregating the status of the referenced health checks.

  • Health checks that monitor CloudWatch alarms: Route 53 stops monitoring the corresponding CloudWatch metrics.

After you disable a health check, Route 53 considers the status of the health check to always be healthy. If you configured DNS failover, Route 53 continues to route traffic to the corresponding resources. If you want to stop routing traffic to a resource, change the value of Inverted.

Charges for a health check still apply when the health check is disabled. For more information, see Amazon Route 53 Pricing.

- HealthThreshold: - allOf: - - $ref: "#/components/schemas/HealthThreshold" - - description:

The number of child health checks that are associated with a CALCULATED health check that Amazon Route 53 must consider healthy for the CALCULATED health check to be considered healthy. To specify the child health checks that you want to associate with a CALCULATED health check, use the ChildHealthChecks element.

Note the following:

  • If you specify a number greater than the number of child health checks, Route 53 always considers this health check to be unhealthy.

  • If you specify 0, Route 53 always considers this health check to be healthy.

- ChildHealthChecks: - allOf: - - $ref: "#/components/schemas/ChildHealthCheckList" - - description: (CALCULATED Health Checks Only) A complex type that contains one ChildHealthCheck element for each health check that you want to associate with a CALCULATED health check. - EnableSNI: - allOf: - - $ref: "#/components/schemas/EnableSNI" - - description:

Specify whether you want Amazon Route 53 to send the value of FullyQualifiedDomainName to the endpoint in the client_hello message during TLS negotiation. This allows the endpoint to respond to HTTPS health check requests with the applicable SSL/TLS certificate.

Some endpoints require that HTTPS requests include the host name in the client_hello message. If you don't enable SNI, the status of the health check will be SSL alert handshake_failure. A health check can also have that status for other reasons. If SNI is enabled and you're still getting the error, check the SSL/TLS configuration on your endpoint and confirm that your certificate is valid.

The SSL/TLS certificate on your endpoint includes a domain name in the Common Name field and possibly several more in the Subject Alternative Names field. One of the domain names in the certificate should match the value that you specify for FullyQualifiedDomainName. If the endpoint responds to the client_hello message with a certificate that does not include the domain name that you specified in FullyQualifiedDomainName, a health checker will retry the handshake. In the second attempt, the health checker will omit FullyQualifiedDomainName from the client_hello message.

- Regions: - allOf: - - $ref: "#/components/schemas/HealthCheckRegionList" - - description:

A complex type that contains one Region element for each region from which you want Amazon Route 53 health checkers to check the specified endpoint.

If you don't specify any regions, Route 53 health checkers automatically performs checks from all of the regions that are listed under Valid Values.

If you update a health check to remove a region that has been performing health checks, Route 53 will briefly continue to perform checks from that region to ensure that some health checkers are always checking the endpoint (for example, if you replace three regions with four different regions).

- AlarmIdentifier: - allOf: - - $ref: "#/components/schemas/AlarmIdentifier" - - description: A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether the specified health check is healthy. - InsufficientDataHealthStatus: - allOf: - - $ref: "#/components/schemas/InsufficientDataHealthStatus" - - description: "

When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign to the health check:

  • Healthy: Route 53 considers the health check to be healthy.

  • Unhealthy: Route 53 considers the health check to be unhealthy.

  • LastKnownStatus: Route 53 uses the status of the health check from the last time that CloudWatch had sufficient data to determine the alarm state. For new health checks that have no last known status, the default status for the health check is healthy.

" - RoutingControlArn: - allOf: - - $ref: "#/components/schemas/RoutingControlArn" - - description:

The Amazon Resource Name (ARN) for the Route 53 Application Recovery Controller routing control.

For more information about Route 53 Application Recovery Controller, see Route 53 Application Recovery Controller Developer Guide..

- description: A complex type that contains information about the health check. - CreateHealthCheckRequest: - type: object - required: - - CallerReference - - HealthCheckConfig - title: CreateHealthCheckRequest - properties: - CallerReference: - allOf: - - $ref: "#/components/schemas/HealthCheckNonce" - - description:

A unique string that identifies the request and that allows you to retry a failed CreateHealthCheck request without the risk of creating two identical health checks:

  • If you send a CreateHealthCheck request with the same CallerReference and settings as a previous request, and if the health check doesn't exist, Amazon Route 53 creates the health check. If the health check does exist, Route 53 returns the settings for the existing health check.

  • If you send a CreateHealthCheck request with the same CallerReference as a deleted health check, regardless of the settings, Route 53 returns a HealthCheckAlreadyExists error.

  • If you send a CreateHealthCheck request with the same CallerReference as an existing health check but with different settings, Route 53 returns a HealthCheckAlreadyExists error.

  • If you send a CreateHealthCheck request with a unique CallerReference but settings identical to an existing health check, Route 53 creates the health check.

- HealthCheckConfig: - allOf: - - $ref: "#/components/schemas/HealthCheckConfig" - - description: A complex type that contains settings for a new health check. - description: A complex type that contains the health check request information. - HealthCheck: - type: object - required: - - Id - - CallerReference - - HealthCheckConfig - - HealthCheckVersion - properties: - Id: - allOf: - - $ref: "#/components/schemas/HealthCheckId" - - description: "The identifier that Amazon Route 53 assigned to the health check when you created it. When you add or update a resource record set, you use this value to specify which health check to use. The value can be up to 64 characters long. " - CallerReference: - allOf: - - $ref: "#/components/schemas/HealthCheckNonce" - - description: A unique string that you specified when you created the health check. - LinkedService: - allOf: - - $ref: "#/components/schemas/LinkedService" - - description: "If the health check was created by another service, the service that created the health check. When a health check is created by another service, you can't edit or delete it using Amazon Route 53. " - HealthCheckConfig: - allOf: - - $ref: "#/components/schemas/HealthCheckConfig" - - description: A complex type that contains detailed information about one health check. - HealthCheckVersion: - allOf: - - $ref: "#/components/schemas/HealthCheckVersion" - - description: The version of the health check. You can optionally pass this value in a call to UpdateHealthCheck to prevent overwriting another change to the health check. - CloudWatchAlarmConfiguration: - allOf: - - $ref: "#/components/schemas/CloudWatchAlarmConfiguration" - - description: A complex type that contains information about the CloudWatch alarm that Amazon Route 53 is monitoring for this health check. - description: A complex type that contains information about one health check that is associated with the current Amazon Web Services account. - Nonce: - type: string - minLength: 1 - maxLength: 128 - HostedZoneConfig: - type: object - properties: - Comment: - allOf: - - $ref: "#/components/schemas/ResourceDescription" - - description: Any comments that you want to include about the hosted zone. - PrivateZone: - allOf: - - $ref: "#/components/schemas/IsPrivateZone" - - description: A value that indicates whether this is a private hosted zone. - description: A complex type that contains an optional comment about your hosted zone. If you don't want to specify a comment, omit both the HostedZoneConfig and Comment elements. - CreateHostedZoneRequest: - type: object - required: - - Name - - CallerReference - title: CreateHostedZoneRequest - properties: - Name: - allOf: - - $ref: "#/components/schemas/DNSName" - - description:

The name of the domain. Specify a fully qualified domain name, for example, www.example.com. The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.

If you're creating a public hosted zone, this is the name you have registered with your DNS registrar. If your domain name is registered with a registrar other than Route 53, change the name servers for your domain to the set of NameServers that CreateHostedZone returns in DelegationSet.

- VPC: - allOf: - - $ref: "#/components/schemas/VPC" - - description:

(Private hosted zones only) A complex type that contains information about the Amazon VPC that you're associating with this hosted zone.

You can specify only one Amazon VPC when you create a private hosted zone. If you are associating a VPC with a hosted zone with this request, the paramaters VPCId and VPCRegion are also required.

To associate additional Amazon VPCs with the hosted zone, use AssociateVPCWithHostedZone after you create a hosted zone.

- CallerReference: - allOf: - - $ref: "#/components/schemas/Nonce" - - description: A unique string that identifies the request and that allows failed CreateHostedZone requests to be retried without the risk of executing the operation twice. You must use a unique CallerReference string every time you submit a CreateHostedZone request. CallerReference can be any unique string, for example, a date/time stamp. - HostedZoneConfig: - allOf: - - $ref: "#/components/schemas/HostedZoneConfig" - - description:

(Optional) A complex type that contains the following optional values:

  • For public and private hosted zones, an optional comment

  • For private hosted zones, an optional PrivateZone element

If you don't specify a comment or the PrivateZone element, omit HostedZoneConfig and the other elements.

- DelegationSetId: - allOf: - - $ref: "#/components/schemas/ResourceId" - - description: If you want to associate a reusable delegation set with this hosted zone, the ID that Amazon Route 53 assigned to the reusable delegation set when you created it. For more information about reusable delegation sets, see CreateReusableDelegationSet. - description: A complex type that contains information about the request to create a public or private hosted zone. - HostedZone: - type: object - required: - - Id - - Name - - CallerReference - properties: - Id: - allOf: - - $ref: "#/components/schemas/ResourceId" - - description: The ID that Amazon Route 53 assigned to the hosted zone when you created it. - Name: - allOf: - - $ref: "#/components/schemas/DNSName" - - description:

The name of the domain. For public hosted zones, this is the name that you have registered with your DNS registrar.

For information about how to specify characters other than a-z, 0-9, and - (hyphen) and how to specify internationalized domain names, see CreateHostedZone.

- CallerReference: - allOf: - - $ref: "#/components/schemas/Nonce" - - description: The value that you specified for CallerReference when you created the hosted zone. - Config: - allOf: - - $ref: "#/components/schemas/HostedZoneConfig" - - description: A complex type that includes the Comment and PrivateZone elements. If you omitted the HostedZoneConfig and Comment elements from the request, the Config and Comment elements don't appear in the response. - ResourceRecordSetCount: - allOf: - - $ref: "#/components/schemas/HostedZoneRRSetCount" - - description: The number of resource record sets in the hosted zone. - LinkedService: - allOf: - - $ref: "#/components/schemas/LinkedService" - - description: "If the hosted zone was created by another service, the service that created the hosted zone. When a hosted zone is created by another service, you can't edit or delete it using Route 53. " - description: A complex type that contains general information about the hosted zone. - DelegationSet: - type: object - required: - - NameServers - properties: - Id: - allOf: - - $ref: "#/components/schemas/ResourceId" - - description: The ID that Amazon Route 53 assigns to a reusable delegation set. - CallerReference: - allOf: - - $ref: "#/components/schemas/Nonce" - - description: The value that you specified for CallerReference when you created the reusable delegation set. - NameServers: - allOf: - - $ref: "#/components/schemas/DelegationSetNameServers" - - description: A complex type that contains a list of the authoritative name servers for a hosted zone or for a reusable delegation set. - description: A complex type that lists the name servers in a delegation set, as well as the CallerReference and the ID for the delegation set. - SigningKeyString: - type: string - SigningKeyStatus: - type: string - minLength: 5 - maxLength: 150 - CreateKeySigningKeyRequest: - type: object - required: - - CallerReference - - HostedZoneId - - KeyManagementServiceArn - - Name - - Status - title: CreateKeySigningKeyRequest - properties: - CallerReference: - allOf: - - $ref: "#/components/schemas/Nonce" - - description: A unique string that identifies the request. - HostedZoneId: - allOf: - - $ref: "#/components/schemas/ResourceId" - - description: The unique string (ID) used to identify a hosted zone. - KeyManagementServiceArn: - allOf: - - $ref: "#/components/schemas/SigningKeyString" - - description: '

The Amazon resource name (ARN) for a customer managed key in Key Management Service (KMS). The KeyManagementServiceArn must be unique for each key-signing key (KSK) in a single hosted zone. To see an example of KeyManagementServiceArn that grants the correct permissions for DNSSEC, scroll down to Example.

You must configure the customer managed customer managed key as follows:

Status

Enabled

Key spec

ECC_NIST_P256

Key usage

Sign and verify

Key policy

The key policy must give permission for the following actions:

  • DescribeKey

  • GetPublicKey

  • Sign

The key policy must also include the Amazon Route 53 service in the principal for your account. Specify the following:

  • "Service": "dnssec-route53.amazonaws.com"

For more information about working with a customer managed key in KMS, see Key Management Service concepts.

' - Name: - allOf: - - $ref: "#/components/schemas/SigningKeyName" - - description: A string used to identify a key-signing key (KSK). Name can include numbers, letters, and underscores (_). Name must be unique for each key-signing key in the same hosted zone. - Status: - allOf: - - $ref: "#/components/schemas/SigningKeyStatus" - - description: A string specifying the initial status of the key-signing key (KSK). You can set the value to ACTIVE or INACTIVE. - KeySigningKey: - type: object - properties: - Name: - allOf: - - $ref: "#/components/schemas/SigningKeyName" - - description: A string used to identify a key-signing key (KSK). Name can include numbers, letters, and underscores (_). Name must be unique for each key-signing key in the same hosted zone. - KmsArn: - allOf: - - $ref: "#/components/schemas/SigningKeyString" - - description: '

The Amazon resource name (ARN) used to identify the customer managed key in Key Management Service (KMS). The KmsArn must be unique for each key-signing key (KSK) in a single hosted zone.

You must configure the customer managed key as follows:

Status

Enabled

Key spec

ECC_NIST_P256

Key usage

Sign and verify

Key policy

The key policy must give permission for the following actions:

  • DescribeKey

  • GetPublicKey

  • Sign

The key policy must also include the Amazon Route 53 service in the principal for your account. Specify the following:

  • "Service": "dnssec-route53.amazonaws.com"

For more information about working with the customer managed key in KMS, see Key Management Service concepts.

' - Flag: - allOf: - - $ref: "#/components/schemas/SigningKeyInteger" - - description: An integer that specifies how the key is used. For key-signing key (KSK), this value is always 257. - SigningAlgorithmMnemonic: - allOf: - - $ref: "#/components/schemas/SigningKeyString" - - description: 'A string used to represent the signing algorithm. This value must follow the guidelines provided by RFC-8624 Section 3.1. ' - SigningAlgorithmType: - allOf: - - $ref: "#/components/schemas/SigningKeyInteger" - - description: 'An integer used to represent the signing algorithm. This value must follow the guidelines provided by RFC-8624 Section 3.1. ' - DigestAlgorithmMnemonic: - allOf: - - $ref: "#/components/schemas/SigningKeyString" - - description: 'A string used to represent the delegation signer digest algorithm. This value must follow the guidelines provided by RFC-8624 Section 3.3. ' - DigestAlgorithmType: - allOf: - - $ref: "#/components/schemas/SigningKeyInteger" - - description: An integer used to represent the delegation signer digest algorithm. This value must follow the guidelines provided by RFC-8624 Section 3.3. - KeyTag: - allOf: - - $ref: "#/components/schemas/SigningKeyTag" - - description: An integer used to identify the DNSSEC record for the domain name. The process used to calculate the value is described in RFC-4034 Appendix B. - DigestValue: - allOf: - - $ref: "#/components/schemas/SigningKeyString" - - description: A cryptographic digest of a DNSKEY resource record (RR). DNSKEY records are used to publish the public key that resolvers can use to verify DNSSEC signatures that are used to secure certain kinds of information provided by the DNS system. - PublicKey: - allOf: - - $ref: "#/components/schemas/SigningKeyString" - - description: The public key, represented as a Base64 encoding, as required by RFC-4034 Page 5. - DSRecord: - allOf: - - $ref: "#/components/schemas/SigningKeyString" - - description: A string that represents a delegation signer (DS) record. - DNSKEYRecord: - allOf: - - $ref: "#/components/schemas/SigningKeyString" - - description: A string that represents a DNSKEY record. - Status: - allOf: - - $ref: "#/components/schemas/SigningKeyStatus" - - description:

A string that represents the current key-signing key (KSK) status.

Status can have one of the following values:

ACTIVE

The KSK is being used for signing.

INACTIVE

The KSK is not being used for signing.

DELETING

The KSK is in the process of being deleted.

ACTION_NEEDED

There is a problem with the KSK that requires you to take action to resolve. For example, the customer managed key might have been deleted, or the permissions for the customer managed key might have been changed.

INTERNAL_FAILURE

There was an error during a request. Before you can continue to work with DNSSEC signing, including actions that involve this KSK, you must correct the problem. For example, you may need to activate or deactivate the KSK.

- StatusMessage: - allOf: - - $ref: "#/components/schemas/SigningKeyStatusMessage" - - description: "The status message provided for the following key-signing key (KSK) statuses: ACTION_NEEDED or INTERNAL_FAILURE. The status message includes information about what the problem might be and steps that you can take to correct the issue." - CreatedDate: - allOf: - - $ref: "#/components/schemas/TimeStamp" - - description: The date when the key-signing key (KSK) was created. - LastModifiedDate: - allOf: - - $ref: "#/components/schemas/TimeStamp" - - description: The last time that the key-signing key (KSK) was changed. - description: A key-signing key (KSK) is a complex type that represents a public/private key pair. The private key is used to generate a digital signature for the zone signing key (ZSK). The public key is stored in the DNS and is used to authenticate the ZSK. A KSK is always associated with a hosted zone; it cannot exist by itself. - CreateQueryLoggingConfigRequest: - type: object - required: - - HostedZoneId - - CloudWatchLogsLogGroupArn - title: CreateQueryLoggingConfigRequest - properties: - HostedZoneId: - allOf: - - $ref: "#/components/schemas/ResourceId" - - description: The ID of the hosted zone that you want to log queries for. You can log queries only for public hosted zones. - CloudWatchLogsLogGroupArn: - allOf: - - $ref: "#/components/schemas/CloudWatchLogsLogGroupArn" - - description:

The Amazon Resource Name (ARN) for the log group that you want to Amazon Route 53 to send query logs to. This is the format of the ARN:

arn:aws:logs:region:account-id:log-group:log_group_name

To get the ARN for a log group, you can use the CloudWatch console, the DescribeLogGroups API action, the describe-log-groups command, or the applicable command in one of the Amazon Web Services SDKs.

- QueryLoggingConfig: - type: object - required: - - Id - - HostedZoneId - - CloudWatchLogsLogGroupArn - properties: - Id: - allOf: - - $ref: "#/components/schemas/QueryLoggingConfigId" - - description: The ID for a configuration for DNS query logging. - HostedZoneId: - allOf: - - $ref: "#/components/schemas/ResourceId" - - description: "The ID of the hosted zone that CloudWatch Logs is logging queries for. " - CloudWatchLogsLogGroupArn: - allOf: - - $ref: "#/components/schemas/CloudWatchLogsLogGroupArn" - - description: The Amazon Resource Name (ARN) of the CloudWatch Logs log group that Amazon Route 53 is publishing logs to. - description: A complex type that contains information about a configuration for DNS query logging. - CreateReusableDelegationSetRequest: - type: object - required: - - CallerReference - title: CreateReusableDelegationSetRequest - properties: - CallerReference: - allOf: - - $ref: "#/components/schemas/Nonce" - - description: A unique string that identifies the request, and that allows you to retry failed CreateReusableDelegationSet requests without the risk of executing the operation twice. You must use a unique CallerReference string every time you submit a CreateReusableDelegationSet request. CallerReference can be any unique string, for example a date/time stamp. - HostedZoneId: - allOf: - - $ref: "#/components/schemas/ResourceId" - - description: If you want to mark the delegation set for an existing hosted zone as reusable, the ID for that hosted zone. - TTL: - type: integer - minimum: 0 - maximum: 2147483647 - TrafficPolicyId: - type: string - minLength: 1 - maxLength: 36 - TrafficPolicyVersion: - type: integer - minimum: 1 - maximum: 1000 - CreateTrafficPolicyInstanceRequest: - type: object - required: - - HostedZoneId - - Name - - TTL - - TrafficPolicyId - - TrafficPolicyVersion - title: CreateTrafficPolicyInstanceRequest - properties: - HostedZoneId: - allOf: - - $ref: "#/components/schemas/ResourceId" - - description: The ID of the hosted zone that you want Amazon Route 53 to create resource record sets in by using the configuration in a traffic policy. - Name: - allOf: - - $ref: "#/components/schemas/DNSName" - - description: The domain name (such as example.com) or subdomain name (such as www.example.com) for which Amazon Route 53 responds to DNS queries by using the resource record sets that Route 53 creates for this traffic policy instance. - TTL: - allOf: - - $ref: "#/components/schemas/TTL" - - description: (Optional) The TTL that you want Amazon Route 53 to assign to all of the resource record sets that it creates in the specified hosted zone. - TrafficPolicyId: - allOf: - - $ref: "#/components/schemas/TrafficPolicyId" - - description: The ID of the traffic policy that you want to use to create resource record sets in the specified hosted zone. - TrafficPolicyVersion: - allOf: - - $ref: "#/components/schemas/TrafficPolicyVersion" - - description: The version of the traffic policy that you want to use to create resource record sets in the specified hosted zone. - description: A complex type that contains information about the resource record sets that you want to create based on a specified traffic policy. - TrafficPolicyInstance: - type: object - required: - - Id - - HostedZoneId - - Name - - TTL - - State - - Message - - TrafficPolicyId - - TrafficPolicyVersion - - TrafficPolicyType - properties: - Id: - allOf: - - $ref: "#/components/schemas/TrafficPolicyInstanceId" - - description: The ID that Amazon Route 53 assigned to the new traffic policy instance. - HostedZoneId: - allOf: - - $ref: "#/components/schemas/ResourceId" - - description: The ID of the hosted zone that Amazon Route 53 created resource record sets in. - Name: - allOf: - - $ref: "#/components/schemas/DNSName" - - description: "The DNS name, such as www.example.com, for which Amazon Route 53 responds to queries by using the resource record sets that are associated with this traffic policy instance. " - TTL: - allOf: - - $ref: "#/components/schemas/TTL" - - description: The TTL that Amazon Route 53 assigned to all of the resource record sets that it created in the specified hosted zone. - State: - allOf: - - $ref: "#/components/schemas/TrafficPolicyInstanceState" - - description:

The value of State is one of the following values:

Applied

Amazon Route 53 has finished creating resource record sets, and changes have propagated to all Route 53 edge locations.

Creating

Route 53 is creating the resource record sets. Use GetTrafficPolicyInstance to confirm that the CreateTrafficPolicyInstance request completed successfully.

Failed

Route 53 wasn't able to create or update the resource record sets. When the value of State is Failed, see Message for an explanation of what caused the request to fail.

- Message: - allOf: - - $ref: "#/components/schemas/Message" - - description: If State is Failed, an explanation of the reason for the failure. If State is another value, Message is empty. - TrafficPolicyId: - allOf: - - $ref: "#/components/schemas/TrafficPolicyId" - - description: The ID of the traffic policy that Amazon Route 53 used to create resource record sets in the specified hosted zone. - TrafficPolicyVersion: - allOf: - - $ref: "#/components/schemas/TrafficPolicyVersion" - - description: The version of the traffic policy that Amazon Route 53 used to create resource record sets in the specified hosted zone. - TrafficPolicyType: - allOf: - - $ref: "#/components/schemas/RRType" - - description: "The DNS type that Amazon Route 53 assigned to all of the resource record sets that it created for this traffic policy instance. " - description: A complex type that contains settings for the new traffic policy instance. - TrafficPolicyName: - type: string - maxLength: 512 - TrafficPolicyDocument: - type: string - maxLength: 102400 - TrafficPolicyComment: - type: string - maxLength: 1024 - CreateTrafficPolicyRequest: - type: object - required: - - Name - - Document - title: CreateTrafficPolicyRequest - properties: - Name: - allOf: - - $ref: "#/components/schemas/TrafficPolicyName" - - description: The name of the traffic policy. - Document: - allOf: - - $ref: "#/components/schemas/TrafficPolicyDocument" - - description: The definition of this traffic policy in JSON format. For more information, see Traffic Policy Document Format. - Comment: - allOf: - - $ref: "#/components/schemas/TrafficPolicyComment" - - description: (Optional) Any comments that you want to include about the traffic policy. - description: A complex type that contains information about the traffic policy that you want to create. - TrafficPolicy: - type: object - required: - - Id - - Version - - Name - - Type - - Document - properties: - Id: - allOf: - - $ref: "#/components/schemas/TrafficPolicyId" - - description: The ID that Amazon Route 53 assigned to a traffic policy when you created it. - Version: - allOf: - - $ref: "#/components/schemas/TrafficPolicyVersion" - - description: The version number that Amazon Route 53 assigns to a traffic policy. For a new traffic policy, the value of Version is always 1. - Name: - allOf: - - $ref: "#/components/schemas/TrafficPolicyName" - - description: The name that you specified when you created the traffic policy. - Type: - allOf: - - $ref: "#/components/schemas/RRType" - - description: The DNS type of the resource record sets that Amazon Route 53 creates when you use a traffic policy to create a traffic policy instance. - Document: - allOf: - - $ref: "#/components/schemas/TrafficPolicyDocument" - - description: The definition of a traffic policy in JSON format. You specify the JSON document to use for a new traffic policy in the CreateTrafficPolicy request. For more information about the JSON format, see Traffic Policy Document Format. - Comment: - allOf: - - $ref: "#/components/schemas/TrafficPolicyComment" - - description: The comment that you specify in the CreateTrafficPolicy request, if any. - description: A complex type that contains settings for a traffic policy. - CreateTrafficPolicyVersionRequest: - type: object - required: - - Document - title: CreateTrafficPolicyVersionRequest - properties: - Document: - allOf: - - $ref: "#/components/schemas/TrafficPolicyDocument" - - description: The definition of this version of the traffic policy, in JSON format. You specified the JSON in the CreateTrafficPolicyVersion request. For more information about the JSON format, see CreateTrafficPolicy. - Comment: - allOf: - - $ref: "#/components/schemas/TrafficPolicyComment" - - description: The comment that you specified in the CreateTrafficPolicyVersion request, if any. - description: A complex type that contains information about the traffic policy that you want to create a new version for. - CreateVPCAssociationAuthorizationRequest: - type: object - required: - - VPC - title: CreateVPCAssociationAuthorizationRequest - properties: - VPC: - allOf: - - $ref: "#/components/schemas/VPC" - - description: A complex type that contains the VPC ID and region for the VPC that you want to authorize associating with your hosted zone. - description: A complex type that contains information about the request to authorize associating a VPC with your private hosted zone. Authorization is only required when a private hosted zone and a VPC were created by using different accounts. - DNSRCode: - type: string - ServeSignature: - type: string - minLength: 1 - maxLength: 1024 - SigningKeyStatusMessage: - type: string - minLength: 0 - maxLength: 512 - DNSSECStatus: - type: object - properties: - ServeSignature: - allOf: - - $ref: "#/components/schemas/ServeSignature" - - description:

A string that represents the current hosted zone signing status.

Status can have one of the following values:

SIGNING

DNSSEC signing is enabled for the hosted zone.

NOT_SIGNING

DNSSEC signing is not enabled for the hosted zone.

DELETING

DNSSEC signing is in the process of being removed for the hosted zone.

ACTION_NEEDED

There is a problem with signing in the hosted zone that requires you to take action to resolve. For example, the customer managed key might have been deleted, or the permissions for the customer managed key might have been changed.

INTERNAL_FAILURE

There was an error during a request. Before you can continue to work with DNSSEC signing, including with key-signing keys (KSKs), you must correct the problem by enabling or disabling DNSSEC signing for the hosted zone.

- StatusMessage: - allOf: - - $ref: "#/components/schemas/SigningKeyStatusMessage" - - description: "The status message provided for the following DNSSEC signing status: INTERNAL_FAILURE. The status message includes information about what the problem might be and steps that you can take to correct the issue." - description: A string repesenting the status of DNSSEC signing. - DeactivateKeySigningKeyRequest: - type: object - title: DeactivateKeySigningKeyRequest - properties: {} - DelegationSetNameServers: - type: array - items: - allOf: - - $ref: "#/components/schemas/DNSName" - - xml: - name: NameServer - minItems: 1 - DelegationSets: - type: array - items: - allOf: - - $ref: "#/components/schemas/DelegationSet" - - xml: - name: DelegationSet - DeleteCidrCollectionRequest: - type: object - title: DeleteCidrCollectionRequest - properties: {} - DeleteHealthCheckRequest: - type: object - title: DeleteHealthCheckRequest - properties: {} - description: This action deletes a health check. - DeleteHostedZoneRequest: - type: object - title: DeleteHostedZoneRequest - properties: {} - description: A request to delete a hosted zone. - DeleteKeySigningKeyRequest: - type: object - title: DeleteKeySigningKeyRequest - properties: {} - QueryLoggingConfigId: - type: string - minLength: 1 - maxLength: 36 - DeleteQueryLoggingConfigRequest: - type: object - title: DeleteQueryLoggingConfigRequest - properties: {} - DeleteReusableDelegationSetRequest: - type: object - title: DeleteReusableDelegationSetRequest - properties: {} - description: A request to delete a reusable delegation set. - TrafficPolicyInstanceId: - type: string - minLength: 1 - maxLength: 36 - DeleteTrafficPolicyInstanceRequest: - type: object - title: DeleteTrafficPolicyInstanceRequest - properties: {} - description: A request to delete a specified traffic policy instance. - DeleteTrafficPolicyRequest: - type: object - title: DeleteTrafficPolicyRequest - properties: {} - description: A request to delete a specified traffic policy version. - DeleteVPCAssociationAuthorizationRequest: - type: object - required: - - VPC - title: DeleteVPCAssociationAuthorizationRequest - properties: - VPC: - allOf: - - $ref: "#/components/schemas/VPC" - - description: When removing authorization to associate a VPC that was created by one Amazon Web Services account with a hosted zone that was created with a different Amazon Web Services account, a complex type that includes the ID and region of the VPC. - description: "A complex type that contains information about the request to remove authorization to associate a VPC that was created by one Amazon Web Services account with a hosted zone that was created with a different Amazon Web Services account. " - DimensionField: - type: string - minLength: 1 - maxLength: 255 - Dimension: - type: object - required: - - Name - - Value - properties: - Name: - allOf: - - $ref: "#/components/schemas/DimensionField" - - description: For the metric that the CloudWatch alarm is associated with, the name of one dimension. - Value: - allOf: - - $ref: "#/components/schemas/DimensionField" - - description: For the metric that the CloudWatch alarm is associated with, the value of one dimension. - description: For the metric that the CloudWatch alarm is associated with, a complex type that contains information about one dimension. - DisableHostedZoneDNSSECRequest: - type: object - title: DisableHostedZoneDNSSECRequest - properties: {} - DisassociateVPCComment: - type: string - DisassociateVPCFromHostedZoneRequest: - type: object - required: - - VPC - title: DisassociateVPCFromHostedZoneRequest - properties: - VPC: - allOf: - - $ref: "#/components/schemas/VPC" - - description: A complex type that contains information about the VPC that you're disassociating from the specified hosted zone. - Comment: - allOf: - - $ref: "#/components/schemas/DisassociateVPCComment" - - description: " Optional: A comment about the disassociation request." - description: A complex type that contains information about the VPC that you want to disassociate from a specified private hosted zone. - EnableHostedZoneDNSSECRequest: - type: object - title: EnableHostedZoneDNSSECRequest - properties: {} - GeoLocationContinentCode: - type: string - minLength: 2 - maxLength: 2 - GeoLocationCountryCode: - type: string - minLength: 1 - maxLength: 2 - GeoLocationSubdivisionCode: - type: string - minLength: 1 - maxLength: 3 - GeoLocation: - type: object - properties: - ContinentCode: - allOf: - - $ref: "#/components/schemas/GeoLocationContinentCode" - - description: "

The two-letter code for the continent.

Amazon Route 53 supports the following continent codes:

  • AF: Africa

  • AN: Antarctica

  • AS: Asia

  • EU: Europe

  • OC: Oceania

  • NA: North America

  • SA: South America

Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode returns an InvalidInput error.

" - CountryCode: - allOf: - - $ref: "#/components/schemas/GeoLocationCountryCode" - - description:

For geolocation resource record sets, the two-letter code for a country.

Amazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1 alpha-2.

- SubdivisionCode: - allOf: - - $ref: "#/components/schemas/GeoLocationSubdivisionCode" - - description: "

For geolocation resource record sets, the two-letter code for a state of the United States. Route 53 doesn't support any other values for SubdivisionCode. For a list of state abbreviations, see Appendix B: Two–Letter State and Possession Abbreviations on the United States Postal Service website.

If you specify subdivisioncode, you must also specify US for CountryCode.

" - description: A complex type that contains information about a geographic location. - GeoLocationContinentName: - type: string - minLength: 1 - maxLength: 32 - GeoLocationCountryName: - type: string - minLength: 1 - maxLength: 64 - GeoLocationSubdivisionName: - type: string - minLength: 1 - maxLength: 64 - GeoLocationDetails: - type: object - properties: - ContinentCode: - allOf: - - $ref: "#/components/schemas/GeoLocationContinentCode" - - description: The two-letter code for the continent. - ContinentName: - allOf: - - $ref: "#/components/schemas/GeoLocationContinentName" - - description: The full name of the continent. - CountryCode: - allOf: - - $ref: "#/components/schemas/GeoLocationCountryCode" - - description: The two-letter code for the country. - CountryName: - allOf: - - $ref: "#/components/schemas/GeoLocationCountryName" - - description: The name of the country. - SubdivisionCode: - allOf: - - $ref: "#/components/schemas/GeoLocationSubdivisionCode" - - description: 'The code for the subdivision, such as a particular state within the United States. For a list of US state abbreviations, see Appendix B: Two–Letter State and Possession Abbreviations on the United States Postal Service website. For a list of all supported subdivision codes, use the ListGeoLocations API.' - SubdivisionName: - allOf: - - $ref: "#/components/schemas/GeoLocationSubdivisionName" - - description: The full name of the subdivision. Route 53 currently supports only states in the United States. - description: A complex type that contains the codes and full continent, country, and subdivision names for the specified geolocation code. - GeoLocationDetailsList: - type: array - items: - allOf: - - $ref: "#/components/schemas/GeoLocationDetails" - - xml: - name: GeoLocationDetails - GetAccountLimitRequest: - type: object - title: GetAccountLimitRequest - properties: {} - description: A complex type that contains information about the request to create a hosted zone. - UsageCount: - type: integer - minimum: 0 - GetChangeRequest: - type: object - title: GetChangeRequest - properties: {} - description: The input for a GetChange request. - GetCheckerIpRangesRequest: - type: object - title: GetCheckerIpRangesRequest - properties: {} - description: Empty request. - GetDNSSECRequest: - type: object - title: GetDNSSECRequest - properties: {} - KeySigningKeys: - type: array - items: - $ref: "#/components/schemas/KeySigningKey" - GetGeoLocationRequest: - type: object - title: GetGeoLocationRequest - properties: {} - description: A request for information about whether a specified geographic location is supported for Amazon Route 53 geolocation resource record sets. - GetHealthCheckCountRequest: - type: object - title: GetHealthCheckCountRequest - properties: {} - description: A request for the number of health checks that are associated with the current Amazon Web Services account. - HealthCheckCount: - type: integer - GetHealthCheckLastFailureReasonRequest: - type: object - title: GetHealthCheckLastFailureReasonRequest - properties: {} - description: A request for the reason that a health check failed most recently. - HealthCheckObservations: - type: array - items: - allOf: - - $ref: "#/components/schemas/HealthCheckObservation" - - xml: - name: HealthCheckObservation - GetHealthCheckRequest: - type: object - title: GetHealthCheckRequest - properties: {} - description: "A request to get information about a specified health check. " - GetHealthCheckStatusRequest: - type: object - title: GetHealthCheckStatusRequest - properties: {} - description: A request to get the status for a health check. - GetHostedZoneCountRequest: - type: object - title: GetHostedZoneCountRequest - properties: {} - description: A request to retrieve a count of all the hosted zones that are associated with the current Amazon Web Services account. - HostedZoneCount: - type: integer - HostedZoneLimitType: - type: string - enum: - - MAX_RRSETS_BY_ZONE - - MAX_VPCS_ASSOCIATED_BY_ZONE - GetHostedZoneLimitRequest: - type: object - title: GetHostedZoneLimitRequest - properties: {} - description: A complex type that contains information about the request to create a hosted zone. - HostedZoneLimit: - type: object - required: - - Type - - Value - properties: - Type: - allOf: - - $ref: "#/components/schemas/HostedZoneLimitType" - - description: "

The limit that you requested. Valid values include the following:

  • MAX_RRSETS_BY_ZONE: The maximum number of records that you can create in the specified hosted zone.

  • MAX_VPCS_ASSOCIATED_BY_ZONE: The maximum number of Amazon VPCs that you can associate with the specified private hosted zone.

" - Value: - allOf: - - $ref: "#/components/schemas/LimitValue" - - description: The current value for the limit that is specified by Type. - description: A complex type that contains the type of limit that you specified in the request and the current value for that limit. - GetHostedZoneRequest: - type: object - title: GetHostedZoneRequest - properties: {} - description: "A request to get information about a specified hosted zone. " - VPCs: - type: array - description: (Private hosted zones only) A list of VPC elements. - items: - allOf: - - $ref: "#/components/schemas/VPC" - - xml: - name: VPC - minItems: 1 - GetQueryLoggingConfigRequest: - type: object - title: GetQueryLoggingConfigRequest - properties: {} - ReusableDelegationSetLimitType: - type: string - enum: - - MAX_ZONES_BY_REUSABLE_DELEGATION_SET - GetReusableDelegationSetLimitRequest: - type: object - title: GetReusableDelegationSetLimitRequest - properties: {} - description: A complex type that contains information about the request to create a hosted zone. - ReusableDelegationSetLimit: - type: object - required: - - Type - - Value - properties: - Type: - allOf: - - $ref: "#/components/schemas/ReusableDelegationSetLimitType" - - description: "The limit that you requested: MAX_ZONES_BY_REUSABLE_DELEGATION_SET, the maximum number of hosted zones that you can associate with the specified reusable delegation set." - Value: - allOf: - - $ref: "#/components/schemas/LimitValue" - - description: The current value for the MAX_ZONES_BY_REUSABLE_DELEGATION_SET limit. - description: A complex type that contains the type of limit that you specified in the request and the current value for that limit. - GetReusableDelegationSetRequest: - type: object - title: GetReusableDelegationSetRequest - properties: {} - description: A request to get information about a specified reusable delegation set. - GetTrafficPolicyInstanceCountRequest: - type: object - title: GetTrafficPolicyInstanceCountRequest - properties: {} - description: Request to get the number of traffic policy instances that are associated with the current Amazon Web Services account. - TrafficPolicyInstanceCount: - type: integer - GetTrafficPolicyInstanceRequest: - type: object - title: GetTrafficPolicyInstanceRequest - properties: {} - description: Gets information about a specified traffic policy instance. - GetTrafficPolicyRequest: - type: object - title: GetTrafficPolicyRequest - properties: {} - description: Gets information about a specific traffic policy version. - LinkedService: - type: object - properties: - ServicePrincipal: - allOf: - - $ref: "#/components/schemas/ServicePrincipal" - - description: "If the health check or hosted zone was created by another service, the service that created the resource. When a resource is created by another service, you can't edit or delete it using Amazon Route 53. " - Description: - allOf: - - $ref: "#/components/schemas/ResourceDescription" - - description: "If the health check or hosted zone was created by another service, an optional description that can be provided by the other service. When a resource is created by another service, you can't edit or delete it using Amazon Route 53. " - description: "If a health check or hosted zone was created by another service, LinkedService is a complex type that describes the service that created the resource. When a resource is created by another service, you can't edit or delete it using Amazon Route 53. " - HealthCheckVersion: - type: integer - minimum: 1 - StatusReport: - type: object - properties: - Status: - allOf: - - $ref: "#/components/schemas/Status" - - description: A description of the status of the health check endpoint as reported by one of the Amazon Route 53 health checkers. - CheckedTime: - allOf: - - $ref: "#/components/schemas/TimeStamp" - - description: The date and time that the health checker performed the health check in ISO 8601 format and Coordinated Universal Time (UTC). For example, the value 2017-03-27T17:48:16.751Z represents March 27, 2017 at 17:48:16.751 UTC. - description: A complex type that contains the status that one Amazon Route 53 health checker reports and the time of the health check. - HealthCheckObservation: - type: object - properties: - Region: - allOf: - - $ref: "#/components/schemas/HealthCheckRegion" - - description: The region of the Amazon Route 53 health checker that provided the status in StatusReport. - IPAddress: - allOf: - - $ref: "#/components/schemas/IPAddress" - - description: The IP address of the Amazon Route 53 health checker that provided the failure reason in StatusReport. - StatusReport: - allOf: - - $ref: "#/components/schemas/StatusReport" - - description: A complex type that contains the last failure reason as reported by one Amazon Route 53 health checker and the time of the failed health check. - description: A complex type that contains the last failure reason as reported by one Amazon Route 53 health checker. - HealthChecks: - type: array - items: - allOf: - - $ref: "#/components/schemas/HealthCheck" - - xml: - name: HealthCheck - HostedZoneRRSetCount: - type: integer - HostedZoneOwningService: - type: string - maxLength: 128 - HostedZoneOwner: - type: object - properties: - OwningAccount: - allOf: - - $ref: "#/components/schemas/AWSAccountID" - - description: "If the hosted zone was created by an Amazon Web Services account, or was created by an Amazon Web Services service that creates hosted zones using the current account, OwningAccount contains the account ID of that account. For example, when you use Cloud Map to create a hosted zone, Cloud Map creates the hosted zone using the current Amazon Web Services account. " - OwningService: - allOf: - - $ref: "#/components/schemas/HostedZoneOwningService" - - description: If an Amazon Web Services service uses its own account to create a hosted zone and associate the specified VPC with that hosted zone, OwningService contains an abbreviation that identifies the service. For example, if Amazon Elastic File System (Amazon EFS) created a hosted zone and associated a VPC with the hosted zone, the value of OwningService is efs.amazonaws.com. - description: "A complex type that identifies a hosted zone that a specified Amazon VPC is associated with and the owner of the hosted zone. If there is a value for OwningAccount, there is no value for OwningService, and vice versa. " - HostedZoneSummary: - type: object - required: - - HostedZoneId - - Name - - Owner - properties: - HostedZoneId: - allOf: - - $ref: "#/components/schemas/ResourceId" - - description: The Route 53 hosted zone ID of a private hosted zone that the specified VPC is associated with. - Name: - allOf: - - $ref: "#/components/schemas/DNSName" - - description: The name of the private hosted zone, such as example.com. - Owner: - allOf: - - $ref: "#/components/schemas/HostedZoneOwner" - - description: The owner of a private hosted zone that the specified VPC is associated with. The owner can be either an Amazon Web Services account or an Amazon Web Services service. - description: In the response to a ListHostedZonesByVPC request, the HostedZoneSummaries element contains one HostedZoneSummary element for each hosted zone that the specified Amazon VPC is associated with. Each HostedZoneSummary element contains the hosted zone name and ID, and information about who owns the hosted zone. - HostedZoneSummaries: - type: array - items: - allOf: - - $ref: "#/components/schemas/HostedZoneSummary" - - xml: - name: HostedZoneSummary - HostedZones: - type: array - items: - allOf: - - $ref: "#/components/schemas/HostedZone" - - xml: - name: HostedZone - SigningKeyInteger: - type: integer - SigningKeyTag: - type: integer - minimum: 0 - maximum: 65536 - ServicePrincipal: - type: string - maxLength: 128 - PaginationToken: - type: string - maxLength: 1024 - MaxResults: - type: string - ListCidrBlocksRequest: - type: object - title: ListCidrBlocksRequest - properties: {} - ListCidrCollectionsRequest: - type: object - title: ListCidrCollectionsRequest - properties: {} - ListCidrLocationsRequest: - type: object - title: ListCidrLocationsRequest - properties: {} - LocationSummaries: - type: array - items: - $ref: "#/components/schemas/LocationSummary" - PageMaxItems: - type: string - ListGeoLocationsRequest: - type: object - title: ListGeoLocationsRequest - properties: {} - description: "A request to get a list of geographic locations that Amazon Route 53 supports for geolocation resource record sets. " - PageTruncated: - type: boolean - PageMarker: - type: string - maxLength: 64 - ListHealthChecksRequest: - type: object - title: ListHealthChecksRequest - properties: {} - description: A request to retrieve a list of the health checks that are associated with the current Amazon Web Services account. - ListHostedZonesByNameRequest: - type: object - title: ListHostedZonesByNameRequest - properties: {} - description: "Retrieves a list of the public and private hosted zones that are associated with the current Amazon Web Services account in ASCII order by domain name. " - ListHostedZonesByVPCRequest: - type: object - title: ListHostedZonesByVPCRequest - properties: {} - description: Lists all the private hosted zones that a specified VPC is associated with, regardless of which Amazon Web Services account created the hosted zones. - ListHostedZonesRequest: - type: object - title: ListHostedZonesRequest - properties: {} - description: A request to retrieve a list of the public and private hosted zones that are associated with the current Amazon Web Services account. - ListQueryLoggingConfigsRequest: - type: object - title: ListQueryLoggingConfigsRequest - properties: {} - QueryLoggingConfigs: - type: array - items: - allOf: - - $ref: "#/components/schemas/QueryLoggingConfig" - - xml: - name: QueryLoggingConfig - RRType: - type: string - enum: - - SOA - - A - - TXT - - NS - - CNAME - - MX - - NAPTR - - PTR - - SRV - - SPF - - AAAA - - CAA - - DS - ResourceRecordSetIdentifier: - type: string - minLength: 1 - maxLength: 128 - ListResourceRecordSetsRequest: - type: object - title: ListResourceRecordSetsRequest - properties: {} - description: A request for the resource record sets that are associated with a specified hosted zone. - ResourceRecordSets: - type: array - items: - allOf: - - $ref: "#/components/schemas/ResourceRecordSet" - - xml: - name: ResourceRecordSet - ListReusableDelegationSetsRequest: - type: object - title: ListReusableDelegationSetsRequest - properties: {} - description: A request to get a list of the reusable delegation sets that are associated with the current Amazon Web Services account. - ListTagsForResourceRequest: - type: object - title: ListTagsForResourceRequest - properties: {} - description: A complex type containing information about a request for a list of the tags that are associated with an individual resource. - ResourceTagSet: - type: object - properties: - ResourceType: - allOf: - - $ref: "#/components/schemas/TagResourceType" - - description:

The type of the resource.

  • The resource type for health checks is healthcheck.

  • The resource type for hosted zones is hostedzone.

- ResourceId: - allOf: - - $ref: "#/components/schemas/TagResourceId" - - description: The ID for the specified resource. - Tags: - allOf: - - $ref: "#/components/schemas/TagList" - - description: The tags associated with the specified resource. - description: A complex type containing a resource and its associated tags. - TagResourceIdList: - type: array - items: - allOf: - - $ref: "#/components/schemas/TagResourceId" - - xml: - name: ResourceId - minItems: 1 - maxItems: 10 - ListTagsForResourcesRequest: - type: object - required: - - ResourceIds - title: ListTagsForResourcesRequest - properties: - ResourceIds: - allOf: - - $ref: "#/components/schemas/TagResourceIdList" - - description: A complex type that contains the ResourceId element for each resource for which you want to get a list of tags. - description: A complex type that contains information about the health checks or hosted zones for which you want to list tags. - ResourceTagSetList: - type: array - items: - allOf: - - $ref: "#/components/schemas/ResourceTagSet" - - xml: - name: ResourceTagSet - ListTrafficPoliciesRequest: - type: object - title: ListTrafficPoliciesRequest - properties: {} - description: A complex type that contains the information about the request to list the traffic policies that are associated with the current Amazon Web Services account. - TrafficPolicySummaries: - type: array - items: - allOf: - - $ref: "#/components/schemas/TrafficPolicySummary" - - xml: - name: TrafficPolicySummary - ListTrafficPolicyInstancesByHostedZoneRequest: - type: object - title: ListTrafficPolicyInstancesByHostedZoneRequest - properties: {} - description: A request for the traffic policy instances that you created in a specified hosted zone. - TrafficPolicyInstances: - type: array - items: - allOf: - - $ref: "#/components/schemas/TrafficPolicyInstance" - - xml: - name: TrafficPolicyInstance - ListTrafficPolicyInstancesByPolicyRequest: - type: object - title: ListTrafficPolicyInstancesByPolicyRequest - properties: {} - description: A complex type that contains the information about the request to list your traffic policy instances. - ListTrafficPolicyInstancesRequest: - type: object - title: ListTrafficPolicyInstancesRequest - properties: {} - description: A request to get information about the traffic policy instances that you created by using the current Amazon Web Services account. - TrafficPolicyVersionMarker: - type: string - maxLength: 4 - ListTrafficPolicyVersionsRequest: - type: object - title: ListTrafficPolicyVersionsRequest - properties: {} - description: A complex type that contains the information about the request to list your traffic policies. - TrafficPolicies: - type: array - items: - allOf: - - $ref: "#/components/schemas/TrafficPolicy" - - xml: - name: TrafficPolicy - ListVPCAssociationAuthorizationsRequest: - type: object - title: ListVPCAssociationAuthorizationsRequest - properties: {} - description: A complex type that contains information about that can be associated with your hosted zone. - LocationSummary: - type: object - properties: - LocationName: - allOf: - - $ref: "#/components/schemas/CidrLocationNameDefaultAllowed" - - description: A string that specifies a location name. - description: A complex type that contains information about the CIDR location. - Message: - type: string - maxLength: 1024 - Nameserver: - type: string - minLength: 0 - maxLength: 255 - RData: - type: string - maxLength: 4000 - RecordDataEntry: - type: string - description:

A value that Amazon Route 53 returned for this resource record set. A RecordDataEntry element is one of the following:

  • For non-alias resource record sets, a RecordDataEntry element contains one value in the resource record set. If the resource record set contains multiple values, the response includes one RecordDataEntry element for each value.

  • For multiple resource record sets that have the same name and type, which includes weighted, latency, geolocation, and failover, a RecordDataEntry element contains the value from the appropriate resource record set based on the request.

  • For alias resource record sets that refer to Amazon Web Services resources other than another resource record set, the RecordDataEntry element contains an IP address or a domain name for the Amazon Web Services resource, depending on the type of resource.

  • For alias resource record sets that refer to other resource record sets, a RecordDataEntry element contains one value from the referenced resource record set. If the referenced resource record set contains multiple values, the response includes one RecordDataEntry element for each value.

- minLength: 0 - maxLength: 512 - RecordData: - type: array - items: - allOf: - - $ref: "#/components/schemas/RecordDataEntry" - - xml: - name: RecordDataEntry - ResettableElementNameList: - type: array - items: - allOf: - - $ref: "#/components/schemas/ResettableElementName" - - xml: - name: ResettableElementName - maxItems: 64 - ResourceRecord: - type: object - required: - - Value - properties: - Value: - allOf: - - $ref: "#/components/schemas/RData" - - description:

The current or new DNS record value, not to exceed 4,000 characters. In the case of a DELETE action, if the current value does not match the actual value, an error is returned. For descriptions about how to format Value for different record types, see Supported DNS Resource Record Types in the Amazon Route 53 Developer Guide.

You can specify more than one value for all record types except CNAME and SOA.

If you're creating an alias resource record set, omit Value.

 - description:

Information specific to the resource record.

If you're creating an alias resource record set, omit ResourceRecord.

 - ResourceRecordSetWeight: - type: integer - minimum: 0 - maximum: 255 - ResourceRecordSetRegion: - type: string - enum: - - us-east-1 - - us-east-2 - - us-west-1 - - us-west-2 - - ca-central-1 - - eu-west-1 - - eu-west-2 - - eu-west-3 - - eu-central-1 - - eu-central-2 - - ap-southeast-1 - - ap-southeast-2 - - ap-southeast-3 - - ap-northeast-1 - - ap-northeast-2 - - ap-northeast-3 - - eu-north-1 - - sa-east-1 - - cn-north-1 - - cn-northwest-1 - - ap-east-1 - - me-south-1 - - me-central-1 - - ap-south-1 - - ap-south-2 - - af-south-1 - - eu-south-1 - - eu-south-2 - - ap-southeast-4 - minLength: 1 - maxLength: 64 - ResourceRecordSetFailover: - type: string - enum: - - PRIMARY - - SECONDARY - ResourceRecordSetMultiValueAnswer: - type: boolean - ResourceRecords: - type: array - items: - allOf: - - $ref: "#/components/schemas/ResourceRecord" - - xml: - name: ResourceRecord - minItems: 1 - Status: - type: string - SubnetMask: - type: string - minLength: 0 - maxLength: 3 - TagValue: - type: string - maxLength: 256 - TestDNSAnswerRequest: - type: object - title: TestDNSAnswerRequest - properties: {} - description: "Gets the value that Amazon Route 53 returns in response to a DNS request for a specified record name and type. You can optionally specify the IP address of a DNS resolver, an EDNS0 client subnet IP address, and a subnet mask. " - TransportProtocol: - type: string - TrafficPolicyInstanceState: - type: string - TrafficPolicySummary: - type: object - required: - - Id - - Name - - Type - - LatestVersion - - TrafficPolicyCount - properties: - Id: - allOf: - - $ref: "#/components/schemas/TrafficPolicyId" - - description: The ID that Amazon Route 53 assigned to the traffic policy when you created it. - Name: - allOf: - - $ref: "#/components/schemas/TrafficPolicyName" - - description: The name that you specified for the traffic policy when you created it. - Type: - allOf: - - $ref: "#/components/schemas/RRType" - - description: The DNS type of the resource record sets that Amazon Route 53 creates when you use a traffic policy to create a traffic policy instance. - LatestVersion: - allOf: - - $ref: "#/components/schemas/TrafficPolicyVersion" - - description: The version number of the latest version of the traffic policy. - TrafficPolicyCount: - allOf: - - $ref: "#/components/schemas/TrafficPolicyVersion" - - description: The number of traffic policies that are associated with the current Amazon Web Services account. - description: A complex type that contains information about the latest version of one traffic policy that is associated with the current Amazon Web Services account. - UpdateHealthCheckRequest: - type: object - title: UpdateHealthCheckRequest - properties: - HealthCheckVersion: - allOf: - - $ref: "#/components/schemas/HealthCheckVersion" - - description:

A sequential counter that Amazon Route 53 sets to 1 when you create a health check and increments by 1 each time you update settings for the health check.

We recommend that you use GetHealthCheck or ListHealthChecks to get the current value of HealthCheckVersion for the health check that you want to update, and that you include that value in your UpdateHealthCheck request. This prevents Route 53 from overwriting an intervening update:

  • If the value in the UpdateHealthCheck request matches the value of HealthCheckVersion in the health check, Route 53 updates the health check with the new settings.

  • If the value of HealthCheckVersion in the health check is greater, the health check was changed after you got the version number. Route 53 does not update the health check, and it returns a HealthCheckVersionMismatch error.

- IPAddress: - allOf: - - $ref: "#/components/schemas/IPAddress" - - description: "

The IPv4 or IPv6 IP address for the endpoint that you want Amazon Route 53 to perform health checks on. If you don't specify a value for IPAddress, Route 53 sends a DNS request to resolve the domain name that you specify in FullyQualifiedDomainName at the interval that you specify in RequestInterval. Using an IP address that is returned by DNS, Route 53 then checks the health of the endpoint.

Use one of the following formats for the value of IPAddress:

  • IPv4 address: four values between 0 and 255, separated by periods (.), for example, 192.0.2.44.

  • IPv6 address: eight groups of four hexadecimal values, separated by colons (:), for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345. You can also shorten IPv6 addresses as described in RFC 5952, for example, 2001:db8:85a3::abcd:1:2345.

If the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with your EC2 instance, and specify the Elastic IP address for IPAddress. This ensures that the IP address of your instance never changes. For more information, see the applicable documentation:

If a health check already has a value for IPAddress, you can change the value. However, you can't update an existing health check to add or remove the value of IPAddress.

For more information, see FullyQualifiedDomainName.

Constraints: Route 53 can't check the health of endpoints for which the IP address is in local, private, non-routable, or multicast ranges. For more information about IP addresses for which you can't create health checks, see the following documents:

" - Port: - allOf: - - $ref: "#/components/schemas/Port" - - description:

The port on the endpoint that you want Amazon Route 53 to perform health checks on.

Don't specify a value for Port when you specify a value for Type of CLOUDWATCH_METRIC or CALCULATED.

 - ResourcePath: - allOf: - - $ref: "#/components/schemas/ResourcePath" - - description:

The path that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example the file /docs/route53-health-check.html. You can also include query string parameters, for example, /welcome.html?language=jp&login=y.

Specify this value only if you want to change it.

- FullyQualifiedDomainName: - allOf: - - $ref: "#/components/schemas/FullyQualifiedDomainName" - - description:

Amazon Route 53 behavior depends on whether you specify a value for IPAddress.

If a health check already has a value for IPAddress, you can change the value. However, you can't update an existing health check to add or remove the value of IPAddress.

If you specify a value for IPAddress:

Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of FullyQualifiedDomainName in the Host header for all health checks except TCP health checks. This is typically the fully qualified DNS name of the endpoint on which you want Route 53 to perform health checks.

When Route 53 checks the health of an endpoint, here is how it constructs the Host header:

  • If you specify a value of 80 for Port and HTTP or HTTP_STR_MATCH for Type, Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

  • If you specify a value of 443 for Port and HTTPS or HTTPS_STR_MATCH for Type, Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

  • If you specify another value for Port and any value except TCP for Type, Route 53 passes FullyQualifiedDomainName:Port to the endpoint in the Host header.

If you don't specify a value for FullyQualifiedDomainName, Route 53 substitutes the value of IPAddress in the Host header in each of the above cases.

If you don't specify a value for IPAddress:

If you don't specify a value for IPAddress, Route 53 sends a DNS request to the domain that you specify in FullyQualifiedDomainName at the interval you specify in RequestInterval. Using an IPv4 address that is returned by DNS, Route 53 then checks the health of the endpoint.

If you don't specify a value for IPAddress, Route 53 uses only IPv4 to send health checks to the endpoint. If there's no resource record set with a type of A for the name that you specify for FullyQualifiedDomainName, the health check fails with a "DNS resolution failed" error.

If you want to check the health of weighted, latency, or failover resource record sets and you choose to specify the endpoint only by FullyQualifiedDomainName, we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName, specify the domain name of the server (such as us-east-2-www.example.com), not the name of the resource record sets (www.example.com).

In this configuration, if the value of FullyQualifiedDomainName matches the name of the resource record sets and you then associate the health check with those resource record sets, health check results will be unpredictable.

In addition, if the value of Type is HTTP, HTTPS, HTTP_STR_MATCH, or HTTPS_STR_MATCH, Route 53 passes the value of FullyQualifiedDomainName in the Host header, as it does when you specify a value for IPAddress. If the value of Type is TCP, Route 53 doesn't pass a Host header.

- SearchString: - allOf: - - $ref: "#/components/schemas/SearchString" - - description: If the value of Type is HTTP_STR_MATCH or HTTPS_STR_MATCH, the string that you want Amazon Route 53 to search for in the response body from the specified resource. If the string appears in the response body, Route 53 considers the resource healthy. (You can't change the value of Type when you update a health check.) - FailureThreshold: - allOf: - - $ref: "#/components/schemas/FailureThreshold" - - description:

The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.

If you don't specify a value for FailureThreshold, the default value is three health checks.

- Inverted: - allOf: - - $ref: "#/components/schemas/Inverted" - - description: Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider a health check unhealthy when it otherwise would be considered healthy. - Disabled: - allOf: - - $ref: "#/components/schemas/Disabled" - - description:

Stops Route 53 from performing health checks. When you disable a health check, here's what happens:

  • Health checks that check the health of endpoints: Route 53 stops submitting requests to your application, server, or other resource.

  • Calculated health checks: Route 53 stops aggregating the status of the referenced health checks.

  • Health checks that monitor CloudWatch alarms: Route 53 stops monitoring the corresponding CloudWatch metrics.

After you disable a health check, Route 53 considers the status of the health check to always be healthy. If you configured DNS failover, Route 53 continues to route traffic to the corresponding resources. If you want to stop routing traffic to a resource, change the value of Inverted.

Charges for a health check still apply when the health check is disabled. For more information, see Amazon Route 53 Pricing.

- HealthThreshold: - allOf: - - $ref: "#/components/schemas/HealthThreshold" - - description:

The number of child health checks that are associated with a CALCULATED health that Amazon Route 53 must consider healthy for the CALCULATED health check to be considered healthy. To specify the child health checks that you want to associate with a CALCULATED health check, use the ChildHealthChecks and ChildHealthCheck elements.

Note the following:

  • If you specify a number greater than the number of child health checks, Route 53 always considers this health check to be unhealthy.

  • If you specify 0, Route 53 always considers this health check to be healthy.

- ChildHealthChecks: - allOf: - - $ref: "#/components/schemas/ChildHealthCheckList" - - description: A complex type that contains one ChildHealthCheck element for each health check that you want to associate with a CALCULATED health check. - EnableSNI: - allOf: - - $ref: "#/components/schemas/EnableSNI" - - description:

Specify whether you want Amazon Route 53 to send the value of FullyQualifiedDomainName to the endpoint in the client_hello message during TLS negotiation. This allows the endpoint to respond to HTTPS health check requests with the applicable SSL/TLS certificate.

Some endpoints require that HTTPS requests include the host name in the client_hello message. If you don't enable SNI, the status of the health check will be SSL alert handshake_failure. A health check can also have that status for other reasons. If SNI is enabled and you're still getting the error, check the SSL/TLS configuration on your endpoint and confirm that your certificate is valid.

The SSL/TLS certificate on your endpoint includes a domain name in the Common Name field and possibly several more in the Subject Alternative Names field. One of the domain names in the certificate should match the value that you specify for FullyQualifiedDomainName. If the endpoint responds to the client_hello message with a certificate that does not include the domain name that you specified in FullyQualifiedDomainName, a health checker will retry the handshake. In the second attempt, the health checker will omit FullyQualifiedDomainName from the client_hello message.

- Regions: - allOf: - - $ref: "#/components/schemas/HealthCheckRegionList" - - description: A complex type that contains one Region element for each region that you want Amazon Route 53 health checkers to check the specified endpoint from. - AlarmIdentifier: - allOf: - - $ref: "#/components/schemas/AlarmIdentifier" - - description: A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether the specified health check is healthy. - InsufficientDataHealthStatus: - allOf: - - $ref: "#/components/schemas/InsufficientDataHealthStatus" - - description: "

When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign to the health check:

  • Healthy: Route 53 considers the health check to be healthy.

  • Unhealthy: Route 53 considers the health check to be unhealthy.

  • LastKnownStatus: By default, Route 53 uses the status of the health check from the last time CloudWatch had sufficient data to determine the alarm state. For new health checks that have no last known status, the status for the health check is healthy.

" - ResetElements: - allOf: - - $ref: "#/components/schemas/ResettableElementNameList" - - description: '

A complex type that contains one ResettableElementName element for each element that you want to reset to the default value. Valid values for ResettableElementName include the following:

' - description: A complex type that contains information about a request to update a health check. - UpdateHostedZoneCommentRequest: - type: object - title: UpdateHostedZoneCommentRequest - properties: - Comment: - allOf: - - $ref: "#/components/schemas/ResourceDescription" - - description: The new comment for the hosted zone. If you don't specify a value for Comment, Amazon Route 53 deletes the existing value of the Comment element, if any. - description: A request to update the comment for a hosted zone. - UpdateTrafficPolicyCommentRequest: - type: object - required: - - Comment - title: UpdateTrafficPolicyCommentRequest - properties: - Comment: - allOf: - - $ref: "#/components/schemas/TrafficPolicyComment" - - description: The new comment for the specified traffic policy and version. - description: A complex type that contains information about the traffic policy that you want to update the comment for. - UpdateTrafficPolicyInstanceRequest: - type: object - required: - - TTL - - TrafficPolicyId - - TrafficPolicyVersion - title: UpdateTrafficPolicyInstanceRequest - properties: - TTL: - allOf: - - $ref: "#/components/schemas/TTL" - - description: The TTL that you want Amazon Route 53 to assign to all of the updated resource record sets. - TrafficPolicyId: - allOf: - - $ref: "#/components/schemas/TrafficPolicyId" - - description: The ID of the traffic policy that you want Amazon Route 53 to use to update resource record sets for the specified traffic policy instance. - TrafficPolicyVersion: - allOf: - - $ref: "#/components/schemas/TrafficPolicyVersion" - - description: The version of the traffic policy that you want Amazon Route 53 to use to update resource record sets for the specified traffic policy instance. - description: A complex type that contains information about the resource record sets that you want to update based on a specified traffic policy instance. -security: - - hmac: [] -x-stackQL-config: - queryParamTranspose: - algorithm: AWSCanonical diff --git a/providers/src/aws/v00.00.00000/services/route53profiles.yaml b/providers/src/aws/v00.00.00000/services/route53profiles.yaml new file mode 100644 index 00000000..fb83be7b --- /dev/null +++ b/providers/src/aws/v00.00.00000/services/route53profiles.yaml @@ -0,0 +1,1326 @@ +openapi: 3.0.0 +info: + title: Route53Profiles + version: 2.0.0 + x-serviceName: cloudcontrolapi +servers: + - url: https://cloudcontrolapi.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The CloudControlApi multi-region endpoint + - url: https://cloudcontrolapi.{region}.amazonaws.com.cn + variables: + region: + description: The AWS region + enum: + - cn-north-1 + - cn-northwest-1 + default: cn-north-1 + description: The CloudControlApi endpoint for China (Beijing) and China (Ningxia) +components: + parameters: + X-Amz-Content-Sha256: + name: X-Amz-Content-Sha256 + in: header + schema: + type: string + required: false + X-Amz-Date: + name: X-Amz-Date + in: header + schema: + type: string + required: false + X-Amz-Algorithm: + name: X-Amz-Algorithm + in: header + schema: + type: string + required: false + X-Amz-Credential: + name: X-Amz-Credential + in: header + schema: + type: string + required: false + X-Amz-Security-Token: + name: X-Amz-Security-Token + in: header + schema: + type: string + required: false + X-Amz-Signature: + name: X-Amz-Signature + in: header + schema: + type: string + required: false + X-Amz-SignedHeaders: + name: X-Amz-SignedHeaders + in: header + schema: + type: string + required: false + x-cloud-control-schemas: + AlreadyExistsException: {} + CancelResourceRequestInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: CancelResourceRequestInput + type: object + CancelResourceRequestOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + ClientToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + ClientTokenConflictException: {} + ConcurrentModificationException: {} + ConcurrentOperationException: {} + CreateResourceInput: + properties: + ClientToken: + type: string + DesiredState: + allOf: + - $ref: '#/components/x-cloud-control-schemas/Properties' + - description: >- +

Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

 
 <p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p>
+                </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the
+                <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
+ RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - DesiredState + title: CreateResourceInput + type: object + CreateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + DeleteResourceInput: + properties: + ClientToken: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + required: + - Identifier + title: DeleteResourceInput + type: object + DeleteResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + GeneralServiceException: {} + GetResourceInput: + properties: + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + required: + - TypeName + - Identifier + title: GetResourceInput + type: object + GetResourceOutput: + properties: + ResourceDescription: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + TypeName: + type: string + type: object + GetResourceRequestStatusInput: + properties: + RequestToken: + $ref: '#/components/x-cloud-control-schemas/RequestToken' + required: + - RequestToken + title: GetResourceRequestStatusInput + type: object + GetResourceRequestStatusOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + HandlerErrorCode: + enum: + - NotUpdatable + - InvalidRequest + - AccessDenied + - InvalidCredentials + - AlreadyExists + - NotFound + - ResourceConflict + - Throttling + - ServiceLimitExceeded + - NotStabilized + - GeneralServiceException + - ServiceInternalError + - ServiceTimeout + - NetworkFailure + - InternalFailure + type: string + HandlerFailureException: {} + HandlerInternalFailureException: {} + HandlerNextToken: + maxLength: 2048 + minLength: 1 + pattern: .+ + type: string + Identifier: + maxLength: 1024 + minLength: 1 + pattern: .+ + type: string + InvalidCredentialsException: {} + InvalidRequestException: {} + MaxResults: + maximum: 100 + minimum: 1 + type: integer + NetworkFailureException: {} + NextToken: + maxLength: 2048 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + NotStabilizedException: {} + NotUpdatableException: {} + Operation: + enum: + - CREATE + - DELETE + - UPDATE + type: string + OperationStatus: + enum: + - PENDING + - IN_PROGRESS + - SUCCESS + - FAILED + - CANCEL_IN_PROGRESS + - CANCEL_COMPLETE + type: string + OperationStatuses: + items: + $ref: '#/components/x-cloud-control-schemas/OperationStatus' + type: array + Operations: + items: + $ref: '#/components/x-cloud-control-schemas/Operation' + type: array + PatchDocument: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + PrivateTypeException: {} + ProgressEvent: + example: + ErrorCode: string + EventTime: number + Identifier: string + Operation: string + OperationStatus: string + RequestToken: string + ResourceModel: string + RetryAfter: number + StatusMessage: string + TypeName: string + properties: + ErrorCode: + type: string + EventTime: + type: number + Identifier: + type: string + Operation: + type: string + OperationStatus: + type: string + RequestToken: + type: string + ResourceModel: + type: string + RetryAfter: + type: number + StatusMessage: + type: string + TypeName: + type: string + type: object + Properties: + format: password + maxLength: 65536 + minLength: 1 + pattern: '[\s\S]*' + type: string + RequestToken: + maxLength: 128 + minLength: 1 + pattern: '[-A-Za-z0-9+/=]+' + type: string + RequestTokenNotFoundException: {} + ResourceConflictException: {} + ResourceDescription: + description: Represents information about a provisioned resource. + properties: + Identifier: + type: string + Properties: + type: string + type: object + ResourceDescriptions: + items: + $ref: '#/components/x-cloud-control-schemas/ResourceDescription' + type: array + ResourceNotFoundException: {} + ResourceRequestStatusFilter: + description: The filter criteria to use in determining the requests returned. + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/OperationStatuses' + - description: >- +

The operation statuses to include in the filter.

  • PENDING: The operation has been requested, but not yet initiated.

  • IN_PROGRESS: The operation is in progress.

  • SUCCESS: The operation completed.

  • FAILED: The operation failed.

  • CANCEL_IN_PROGRESS: The operation is in the process of being canceled.

  • + CANCEL_COMPLETE: The operation has been canceled.

+ type: object + ResourceRequestStatusSummaries: + items: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: array + RoleArn: + maxLength: 2048 + minLength: 20 + pattern: arn:.+:iam::[0-9]{12}:role/.+ + type: string + ServiceInternalErrorException: {} + ServiceLimitExceededException: {} + StatusMessage: + maxLength: 1024 + minLength: 0 + pattern: '[\s\S]*' + type: string + ThrottlingException: {} + Timestamp: + format: date-time + type: string + TypeName: + maxLength: 196 + minLength: 10 + pattern: '[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}' + type: string + TypeNotFoundException: {} + TypeVersionId: + maxLength: 128 + minLength: 1 + pattern: '[A-Za-z0-9-]+' + type: string + UnsupportedActionException: {} + UpdateResourceInput: + properties: + undefined: + allOf: + - $ref: '#/components/x-cloud-control-schemas/PatchDocument' + required: + - Identifier + - PatchDocument + title: UpdateResourceInput + type: object + UpdateResourceOutput: + properties: + ProgressEvent: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + type: object + schemas: + Tag: + type: object + additionalProperties: false + properties: + Key: + type: string + description: 'The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' + minLength: 1 + maxLength: 128 + Value: + type: string + description: 'The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.' + minLength: 0 + maxLength: 256 + required: + - Value + - Key + Profile: + type: object + properties: + Name: + type: string + description: The name of the profile. + minLength: 1 + maxLength: 64 + ClientToken: + type: string + description: The id of the creator request + minLength: 1 + maxLength: 64 + Tags: + type: array + description: An array of key-value pairs to apply to this resource. + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + Arn: + type: string + description: The Amazon Resource Name (ARN) of the resolver profile. + Id: + type: string + description: The ID of the profile. + required: + - Name + x-stackql-resource-name: profile + description: Resource Type definition for AWS::Route53Profiles::Profile + x-type-name: AWS::Route53Profiles::Profile + x-stackql-primary-identifier: + - Id + x-create-only-properties: + - Name + x-write-only-properties: + - Tags + x-read-only-properties: + - Arn + - Id + - ClientToken + x-required-properties: + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + x-required-permissions: + create: + - route53profiles:CreateProfile + - route53profiles:GetProfile + - route53profiles:TagResource + - route53profiles:ListTagsForResource + update: + - route53profiles:GetProfile + - route53profiles:TagResource + - route53profiles:UntagResource + - route53profiles:ListTagsForResource + read: + - route53profiles:GetProfile + - route53profiles:ListTagsForResource + delete: + - route53profiles:DeleteProfile + - route53profiles:GetProfile + - route53profiles:UntagResource + list: + - route53profiles:ListProfiles + - route53profiles:ListTagsForResource + ProfileAssociation: + type: object + properties: + ResourceId: + description: The resource that you associated the profile with. + type: string + ProfileId: + description: The ID of the profile that you associated with the resource that is specified by ResourceId. + type: string + Id: + description: Primary Identifier for Profile Association + type: string + Name: + description: The name of an association between a Profile and a VPC. + type: string + Tags: + type: array + description: An array of key-value pairs to apply to this resource. + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + Arn: + type: string + description: The Amazon Resource Name (ARN) of the profile association. + required: + - ResourceId + - ProfileId + - Name + x-stackql-resource-name: profile_association + description: Resource Type definition for AWS::Route53Profiles::ProfileAssociation + x-type-name: AWS::Route53Profiles::ProfileAssociation + x-stackql-primary-identifier: + - Id + x-create-only-properties: + - Name + - ResourceId + - ProfileId + x-write-only-properties: + - Arn + - Tags + x-read-only-properties: + - Id + x-required-properties: + - ResourceId + - ProfileId + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + x-required-permissions: + create: + - route53profiles:AssociateProfile + - route53profiles:GetProfileAssociation + - ec2:DescribeVpcs + - route53profiles:TagResource + update: + - route53profiles:GetProfileAssociation + - route53profiles:TagResource + - route53profiles:UntagResource + - route53profiles:ListTagsForResource + read: + - route53profiles:GetProfileAssociation + - route53profiles:ListTagsForResource + delete: + - route53profiles:DisassociateProfile + - route53profiles:GetProfileAssociation + - route53profiles:UntagResource + list: + - route53profiles:ListProfileAssociations + - route53profiles:ListTagsForResource + ProfileResourceAssociation: + type: object + properties: + ProfileId: + description: The ID of the profile that you associated the resource to that is specified by ResourceArn. + type: string + Id: + description: Primary Identifier for Profile Resource Association + type: string + Name: + description: The name of an association between the Profile and resource. + type: string + ResourceArn: + description: The arn of the resource that you associated to the Profile. + type: string + ResourceProperties: + description: A JSON-formatted string with key-value pairs specifying the properties of the associated resource. + type: string + ResourceType: + description: The type of the resource associated to the Profile. + type: string + required: + - ProfileId + - Name + - ResourceArn + x-stackql-resource-name: profile_resource_association + description: Resource Type definition for AWS::Route53Profiles::ProfileResourceAssociation + x-type-name: AWS::Route53Profiles::ProfileResourceAssociation + x-stackql-primary-identifier: + - Id + x-create-only-properties: + - ProfileId + - Name + - ResourceArn + x-read-only-properties: + - Id + - ResourceType + x-required-properties: + - ProfileId + - Name + - ResourceArn + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + cloudFormationSystemTags: false + x-required-permissions: + create: + - route53profiles:AssociateResourceToProfile + - route53profiles:GetProfileResourceAssociation + - route53resolver:* + - route53:* + read: + - route53profiles:GetProfileResourceAssociation + - route53resolver:* + - route53:* + delete: + - route53profiles:DisassociateResourceFromProfile + - route53profiles:GetProfileResourceAssociation + - route53resolver:* + - route53:* + list: + - route53profiles:ListProfileResourceAssociations + - route53resolver:* + - route53:* + update: + - route53profiles:UpdateProfileResourceAssociation + - route53profiles:GetProfileResourceAssociation + - route53resolver:* + - route53:* + CreateProfileRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + type: string + description: The name of the profile. + minLength: 1 + maxLength: 64 + ClientToken: + type: string + description: The id of the creator request + minLength: 1 + maxLength: 64 + Tags: + type: array + description: An array of key-value pairs to apply to this resource. + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + Arn: + type: string + description: The Amazon Resource Name (ARN) of the resolver profile. + Id: + type: string + description: The ID of the profile. + x-stackQL-stringOnly: true + x-title: CreateProfileRequest + type: object + required: [] + CreateProfileAssociationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ResourceId: + description: The resource that you associated the profile with. + type: string + ProfileId: + description: The ID of the profile that you associated with the resource that is specified by ResourceId. + type: string + Id: + description: Primary Identifier for Profile Association + type: string + Name: + description: The name of an association between a Profile and a VPC. + type: string + Tags: + type: array + description: An array of key-value pairs to apply to this resource. + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + Arn: + type: string + description: The Amazon Resource Name (ARN) of the profile association. + x-stackQL-stringOnly: true + x-title: CreateProfileAssociationRequest + type: object + required: [] + CreateProfileResourceAssociationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ProfileId: + description: The ID of the profile that you associated the resource to that is specified by ResourceArn. + type: string + Id: + description: Primary Identifier for Profile Resource Association + type: string + Name: + description: The name of an association between the Profile and resource. + type: string + ResourceArn: + description: The arn of the resource that you associated to the Profile. + type: string + ResourceProperties: + description: A JSON-formatted string with key-value pairs specifying the properties of the associated resource. + type: string + ResourceType: + description: The type of the resource associated to the Profile. + type: string + x-stackQL-stringOnly: true + x-title: CreateProfileResourceAssociationRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 + x-stackQL-resources: + profiles: + name: profiles + id: aws.route53profiles.profiles + x-cfn-schema-name: Profile + x-cfn-type-name: AWS::Route53Profiles::Profile + x-identifiers: + - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Profile&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53Profiles::Profile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53Profiles::Profile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53Profiles::Profile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/profiles/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/profiles/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/profiles/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.ClientToken') as client_token, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Route53Profiles::Profile' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Profiles::Profile' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'ClientToken') as client_token, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Route53Profiles::Profile' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Profiles::Profile' + AND region = 'us-east-1' + profile_associations: + name: profile_associations + id: aws.route53profiles.profile_associations + x-cfn-schema-name: ProfileAssociation + x-cfn-type-name: AWS::Route53Profiles::ProfileAssociation + x-identifiers: + - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ProfileAssociation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53Profiles::ProfileAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53Profiles::ProfileAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53Profiles::ProfileAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/profile_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/profile_associations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/profile_associations/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.ResourceId') as resource_id, + JSON_EXTRACT(Properties, '$.ProfileId') as profile_id, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Route53Profiles::ProfileAssociation' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Profiles::ProfileAssociation' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ResourceId') as resource_id, + json_extract_path_text(Properties, 'ProfileId') as profile_id, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Route53Profiles::ProfileAssociation' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Profiles::ProfileAssociation' + AND region = 'us-east-1' + profile_resource_associations: + name: profile_resource_associations + id: aws.route53profiles.profile_resource_associations + x-cfn-schema-name: ProfileResourceAssociation + x-cfn-type-name: AWS::Route53Profiles::ProfileResourceAssociation + x-identifiers: + - Id + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ProfileResourceAssociation&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53Profiles::ProfileResourceAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53Profiles::ProfileResourceAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Route53Profiles::ProfileResourceAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/profile_resource_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/profile_resource_associations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/profile_resource_associations/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.ProfileId') as profile_id, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.ResourceArn') as resource_arn, + JSON_EXTRACT(Properties, '$.ResourceProperties') as resource_properties, + JSON_EXTRACT(Properties, '$.ResourceType') as resource_type + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Route53Profiles::ProfileResourceAssociation' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Profiles::ProfileResourceAssociation' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ProfileId') as profile_id, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'ResourceArn') as resource_arn, + json_extract_path_text(Properties, 'ResourceProperties') as resource_properties, + json_extract_path_text(Properties, 'ResourceType') as resource_type + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Route53Profiles::ProfileResourceAssociation' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Profiles::ProfileResourceAssociation' + AND region = 'us-east-1' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Profile&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateProfile + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateProfileRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ProfileAssociation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateProfileAssociation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateProfileAssociationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ProfileResourceAssociation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateProfileResourceAssociation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateProfileResourceAssociationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success +x-stackQL-config: + requestTranslate: + algorithm: drop_double_underscore_params + pagination: + requestToken: + key: NextToken + location: body + responseToken: + key: NextToken + location: body diff --git a/providers/src/aws/v00.00.00000/services/route53recoverycontrol.yaml b/providers/src/aws/v00.00.00000/services/route53recoverycontrol.yaml index d4d0249d..7ff5c30e 100644 --- a/providers/src/aws/v00.00.00000/services/route53recoverycontrol.yaml +++ b/providers/src/aws/v00.00.00000/services/route53recoverycontrol.yaml @@ -944,7 +944,7 @@ components: x-cfn-type-name: AWS::Route53RecoveryControl::Cluster x-identifiers: - ClusterArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -978,39 +978,11 @@ components: - $ref: '#/components/x-stackQL-resources/clusters/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/clusters/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ClusterArn') as cluster_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryControl::Cluster' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ClusterArn') as cluster_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryControl::Cluster' - AND region = 'us-east-1' - cluster: - name: cluster - id: aws.route53recoverycontrol.cluster - x-cfn-schema-name: Cluster - x-cfn-type-name: AWS::Route53RecoveryControl::Cluster - x-identifiers: - - ClusterArn - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1024,19 +996,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'ClusterArn') as cluster_arn, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'ClusterEndpoints') as cluster_endpoints, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Route53RecoveryControl::Cluster' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ClusterArn') as cluster_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryControl::Cluster' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'ClusterArn') as cluster_arn, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'ClusterEndpoints') as cluster_endpoints, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Route53RecoveryControl::Cluster' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ClusterArn') as cluster_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryControl::Cluster' + AND region = 'us-east-1' control_panels: name: control_panels id: aws.route53recoverycontrol.control_panels @@ -1044,7 +1032,7 @@ components: x-cfn-type-name: AWS::Route53RecoveryControl::ControlPanel x-identifiers: - ControlPanelArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1061,9 +1049,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1073,41 +1061,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/control_panels/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/control_panels/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ControlPanelArn') as control_panel_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryControl::ControlPanel' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ControlPanelArn') as control_panel_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryControl::ControlPanel' - AND region = 'us-east-1' - control_panel: - name: control_panel - id: aws.route53recoverycontrol.control_panel - x-cfn-schema-name: ControlPanel - x-cfn-type-name: AWS::Route53RecoveryControl::ControlPanel - x-identifiers: - - ControlPanelArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1118,12 +1074,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/control_panels/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/control_panels/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/control_panel/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/control_panels/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1139,21 +1099,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ClusterArn') as cluster_arn, - json_extract_path_text(Properties, 'ControlPanelArn') as control_panel_arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'DefaultControlPanel') as default_control_panel, - json_extract_path_text(Properties, 'RoutingControlCount') as routing_control_count, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Route53RecoveryControl::ControlPanel' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ControlPanelArn') as control_panel_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryControl::ControlPanel' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ClusterArn') as cluster_arn, + json_extract_path_text(Properties, 'ControlPanelArn') as control_panel_arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'DefaultControlPanel') as default_control_panel, + json_extract_path_text(Properties, 'RoutingControlCount') as routing_control_count, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Route53RecoveryControl::ControlPanel' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ControlPanelArn') as control_panel_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryControl::ControlPanel' + AND region = 'us-east-1' routing_controls: name: routing_controls id: aws.route53recoverycontrol.routing_controls @@ -1161,7 +1137,7 @@ components: x-cfn-type-name: AWS::Route53RecoveryControl::RoutingControl x-identifiers: - RoutingControlArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1178,9 +1154,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1190,41 +1166,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/routing_controls/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/routing_controls/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.RoutingControlArn') as routing_control_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryControl::RoutingControl' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'RoutingControlArn') as routing_control_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryControl::RoutingControl' - AND region = 'us-east-1' - routing_control: - name: routing_control - id: aws.route53recoverycontrol.routing_control - x-cfn-schema-name: RoutingControl - x-cfn-type-name: AWS::Route53RecoveryControl::RoutingControl - x-identifiers: - - RoutingControlArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1235,12 +1179,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/routing_controls/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/routing_controls/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/routing_control/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/routing_controls/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1254,19 +1202,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'RoutingControlArn') as routing_control_arn, - json_extract_path_text(Properties, 'ControlPanelArn') as control_panel_arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'ClusterArn') as cluster_arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Route53RecoveryControl::RoutingControl' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.RoutingControlArn') as routing_control_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryControl::RoutingControl' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'RoutingControlArn') as routing_control_arn, + json_extract_path_text(Properties, 'ControlPanelArn') as control_panel_arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'ClusterArn') as cluster_arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Route53RecoveryControl::RoutingControl' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'RoutingControlArn') as routing_control_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryControl::RoutingControl' + AND region = 'us-east-1' safety_rules: name: safety_rules id: aws.route53recoverycontrol.safety_rules @@ -1274,7 +1238,7 @@ components: x-cfn-type-name: AWS::Route53RecoveryControl::SafetyRule x-identifiers: - SafetyRuleArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1291,9 +1255,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1303,41 +1267,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/safety_rules/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/safety_rules/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.SafetyRuleArn') as safety_rule_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryControl::SafetyRule' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'SafetyRuleArn') as safety_rule_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryControl::SafetyRule' - AND region = 'us-east-1' - safety_rule: - name: safety_rule - id: aws.route53recoverycontrol.safety_rule - x-cfn-schema-name: SafetyRule - x-cfn-type-name: AWS::Route53RecoveryControl::SafetyRule - x-identifiers: - - SafetyRuleArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1348,12 +1280,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/safety_rules/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/safety_rules/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/safety_rule/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/safety_rules/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1370,22 +1306,38 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AssertionRule') as assertion_rule, - json_extract_path_text(Properties, 'GatingRule') as gating_rule, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'SafetyRuleArn') as safety_rule_arn, - json_extract_path_text(Properties, 'ControlPanelArn') as control_panel_arn, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'RuleConfig') as rule_config, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Route53RecoveryControl::SafetyRule' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.SafetyRuleArn') as safety_rule_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryControl::SafetyRule' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AssertionRule') as assertion_rule, + json_extract_path_text(Properties, 'GatingRule') as gating_rule, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'SafetyRuleArn') as safety_rule_arn, + json_extract_path_text(Properties, 'ControlPanelArn') as control_panel_arn, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'RuleConfig') as rule_config, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Route53RecoveryControl::SafetyRule' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'SafetyRuleArn') as safety_rule_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryControl::SafetyRule' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/route53recoveryreadiness.yaml b/providers/src/aws/v00.00.00000/services/route53recoveryreadiness.yaml index e802018a..624228a1 100644 --- a/providers/src/aws/v00.00.00000/services/route53recoveryreadiness.yaml +++ b/providers/src/aws/v00.00.00000/services/route53recoveryreadiness.yaml @@ -916,7 +916,7 @@ components: x-cfn-type-name: AWS::Route53RecoveryReadiness::Cell x-identifiers: - CellName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -933,9 +933,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -945,41 +945,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/cells/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/cells/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.CellName') as cell_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryReadiness::Cell' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'CellName') as cell_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryReadiness::Cell' - AND region = 'us-east-1' - cell: - name: cell - id: aws.route53recoveryreadiness.cell - x-cfn-schema-name: Cell - x-cfn-type-name: AWS::Route53RecoveryReadiness::Cell - x-identifiers: - - CellName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -990,12 +958,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/cells/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/cells/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/cell/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/cells/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1009,19 +981,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'CellName') as cell_name, - json_extract_path_text(Properties, 'CellArn') as cell_arn, - json_extract_path_text(Properties, 'Cells') as cells, - json_extract_path_text(Properties, 'ParentReadinessScopes') as parent_readiness_scopes, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Route53RecoveryReadiness::Cell' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.CellName') as cell_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryReadiness::Cell' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'CellName') as cell_name, + json_extract_path_text(Properties, 'CellArn') as cell_arn, + json_extract_path_text(Properties, 'Cells') as cells, + json_extract_path_text(Properties, 'ParentReadinessScopes') as parent_readiness_scopes, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Route53RecoveryReadiness::Cell' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'CellName') as cell_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryReadiness::Cell' + AND region = 'us-east-1' readiness_checks: name: readiness_checks id: aws.route53recoveryreadiness.readiness_checks @@ -1029,7 +1017,7 @@ components: x-cfn-type-name: AWS::Route53RecoveryReadiness::ReadinessCheck x-identifiers: - ReadinessCheckName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1046,9 +1034,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1058,41 +1046,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/readiness_checks/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/readiness_checks/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ReadinessCheckName') as readiness_check_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryReadiness::ReadinessCheck' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ReadinessCheckName') as readiness_check_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryReadiness::ReadinessCheck' - AND region = 'us-east-1' - readiness_check: - name: readiness_check - id: aws.route53recoveryreadiness.readiness_check - x-cfn-schema-name: ReadinessCheck - x-cfn-type-name: AWS::Route53RecoveryReadiness::ReadinessCheck - x-identifiers: - - ReadinessCheckName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1103,12 +1059,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/readiness_checks/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/readiness_checks/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/readiness_check/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/readiness_checks/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1121,18 +1081,34 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ResourceSetName') as resource_set_name, - json_extract_path_text(Properties, 'ReadinessCheckName') as readiness_check_name, - json_extract_path_text(Properties, 'ReadinessCheckArn') as readiness_check_arn, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Route53RecoveryReadiness::ReadinessCheck' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ReadinessCheckName') as readiness_check_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryReadiness::ReadinessCheck' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ResourceSetName') as resource_set_name, + json_extract_path_text(Properties, 'ReadinessCheckName') as readiness_check_name, + json_extract_path_text(Properties, 'ReadinessCheckArn') as readiness_check_arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Route53RecoveryReadiness::ReadinessCheck' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ReadinessCheckName') as readiness_check_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryReadiness::ReadinessCheck' + AND region = 'us-east-1' recovery_groups: name: recovery_groups id: aws.route53recoveryreadiness.recovery_groups @@ -1140,7 +1116,7 @@ components: x-cfn-type-name: AWS::Route53RecoveryReadiness::RecoveryGroup x-identifiers: - RecoveryGroupName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1157,9 +1133,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1169,41 +1145,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/recovery_groups/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/recovery_groups/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.RecoveryGroupName') as recovery_group_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryReadiness::RecoveryGroup' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'RecoveryGroupName') as recovery_group_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryReadiness::RecoveryGroup' - AND region = 'us-east-1' - recovery_group: - name: recovery_group - id: aws.route53recoveryreadiness.recovery_group - x-cfn-schema-name: RecoveryGroup - x-cfn-type-name: AWS::Route53RecoveryReadiness::RecoveryGroup - x-identifiers: - - RecoveryGroupName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1214,12 +1158,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/recovery_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/recovery_groups/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/recovery_group/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/recovery_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1232,18 +1180,34 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'RecoveryGroupName') as recovery_group_name, - json_extract_path_text(Properties, 'Cells') as cells, - json_extract_path_text(Properties, 'RecoveryGroupArn') as recovery_group_arn, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Route53RecoveryReadiness::RecoveryGroup' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.RecoveryGroupName') as recovery_group_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryReadiness::RecoveryGroup' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'RecoveryGroupName') as recovery_group_name, + json_extract_path_text(Properties, 'Cells') as cells, + json_extract_path_text(Properties, 'RecoveryGroupArn') as recovery_group_arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Route53RecoveryReadiness::RecoveryGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'RecoveryGroupName') as recovery_group_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryReadiness::RecoveryGroup' + AND region = 'us-east-1' resource_sets: name: resource_sets id: aws.route53recoveryreadiness.resource_sets @@ -1251,7 +1215,7 @@ components: x-cfn-type-name: AWS::Route53RecoveryReadiness::ResourceSet x-identifiers: - ResourceSetName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1268,9 +1232,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1280,41 +1244,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/resource_sets/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/resource_sets/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ResourceSetName') as resource_set_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryReadiness::ResourceSet' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ResourceSetName') as resource_set_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryReadiness::ResourceSet' - AND region = 'us-east-1' - resource_set: - name: resource_set - id: aws.route53recoveryreadiness.resource_set - x-cfn-schema-name: ResourceSet - x-cfn-type-name: AWS::Route53RecoveryReadiness::ResourceSet - x-identifiers: - - ResourceSetName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1325,12 +1257,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/resource_sets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/resource_sets/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/resource_set/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/resource_sets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1344,19 +1280,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ResourceSetName') as resource_set_name, - json_extract_path_text(Properties, 'Resources') as resources, - json_extract_path_text(Properties, 'ResourceSetArn') as resource_set_arn, - json_extract_path_text(Properties, 'ResourceSetType') as resource_set_type, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Route53RecoveryReadiness::ResourceSet' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ResourceSetName') as resource_set_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryReadiness::ResourceSet' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ResourceSetName') as resource_set_name, + json_extract_path_text(Properties, 'Resources') as resources, + json_extract_path_text(Properties, 'ResourceSetArn') as resource_set_arn, + json_extract_path_text(Properties, 'ResourceSetType') as resource_set_type, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Route53RecoveryReadiness::ResourceSet' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ResourceSetName') as resource_set_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53RecoveryReadiness::ResourceSet' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/route53resolver.yaml b/providers/src/aws/v00.00.00000/services/route53resolver.yaml index b46f3695..149ff8fe 100644 --- a/providers/src/aws/v00.00.00000/services/route53resolver.yaml +++ b/providers/src/aws/v00.00.00000/services/route53resolver.yaml @@ -589,6 +589,12 @@ components: type: string minLength: 1 maxLength: 16 + FirewallDomainRedirectionAction: + description: FirewallDomainRedirectionAction + type: string + enum: + - INSPECT_REDIRECTION_DOMAIN + - TRUST_REDIRECTION_DOMAIN required: - FirewallDomainListId - Priority @@ -2105,7 +2111,7 @@ components: x-cfn-type-name: AWS::Route53Resolver::FirewallDomainList x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2122,9 +2128,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2134,41 +2140,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/firewall_domain_lists/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/firewall_domain_lists/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::FirewallDomainList' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::FirewallDomainList' - AND region = 'us-east-1' - firewall_domain_list: - name: firewall_domain_list - id: aws.route53resolver.firewall_domain_list - x-cfn-schema-name: FirewallDomainList - x-cfn-type-name: AWS::Route53Resolver::FirewallDomainList - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2179,12 +2153,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/firewall_domain_lists/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/firewall_domain_lists/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/firewall_domain_list/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/firewall_domain_lists/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2206,27 +2184,43 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'DomainCount') as domain_count, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'StatusMessage') as status_message, - json_extract_path_text(Properties, 'ManagedOwnerName') as managed_owner_name, - json_extract_path_text(Properties, 'CreatorRequestId') as creator_request_id, - json_extract_path_text(Properties, 'CreationTime') as creation_time, - json_extract_path_text(Properties, 'ModificationTime') as modification_time, - json_extract_path_text(Properties, 'Domains') as domains, - json_extract_path_text(Properties, 'DomainFileUrl') as domain_file_url, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Route53Resolver::FirewallDomainList' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::FirewallDomainList' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'DomainCount') as domain_count, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'StatusMessage') as status_message, + json_extract_path_text(Properties, 'ManagedOwnerName') as managed_owner_name, + json_extract_path_text(Properties, 'CreatorRequestId') as creator_request_id, + json_extract_path_text(Properties, 'CreationTime') as creation_time, + json_extract_path_text(Properties, 'ModificationTime') as modification_time, + json_extract_path_text(Properties, 'Domains') as domains, + json_extract_path_text(Properties, 'DomainFileUrl') as domain_file_url, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Route53Resolver::FirewallDomainList' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::FirewallDomainList' + AND region = 'us-east-1' firewall_rule_groups: name: firewall_rule_groups id: aws.route53resolver.firewall_rule_groups @@ -2234,7 +2228,7 @@ components: x-cfn-type-name: AWS::Route53Resolver::FirewallRuleGroup x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2251,9 +2245,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2263,41 +2257,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/firewall_rule_groups/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/firewall_rule_groups/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::FirewallRuleGroup' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::FirewallRuleGroup' - AND region = 'us-east-1' - firewall_rule_group: - name: firewall_rule_group - id: aws.route53resolver.firewall_rule_group - x-cfn-schema-name: FirewallRuleGroup - x-cfn-type-name: AWS::Route53Resolver::FirewallRuleGroup - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2308,12 +2270,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/firewall_rule_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/firewall_rule_groups/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/firewall_rule_group/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/firewall_rule_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2335,27 +2301,43 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'RuleCount') as rule_count, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'StatusMessage') as status_message, - json_extract_path_text(Properties, 'OwnerId') as owner_id, - json_extract_path_text(Properties, 'ShareStatus') as share_status, - json_extract_path_text(Properties, 'CreatorRequestId') as creator_request_id, - json_extract_path_text(Properties, 'CreationTime') as creation_time, - json_extract_path_text(Properties, 'ModificationTime') as modification_time, - json_extract_path_text(Properties, 'FirewallRules') as firewall_rules, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Route53Resolver::FirewallRuleGroup' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::FirewallRuleGroup' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'RuleCount') as rule_count, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'StatusMessage') as status_message, + json_extract_path_text(Properties, 'OwnerId') as owner_id, + json_extract_path_text(Properties, 'ShareStatus') as share_status, + json_extract_path_text(Properties, 'CreatorRequestId') as creator_request_id, + json_extract_path_text(Properties, 'CreationTime') as creation_time, + json_extract_path_text(Properties, 'ModificationTime') as modification_time, + json_extract_path_text(Properties, 'FirewallRules') as firewall_rules, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Route53Resolver::FirewallRuleGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::FirewallRuleGroup' + AND region = 'us-east-1' firewall_rule_group_associations: name: firewall_rule_group_associations id: aws.route53resolver.firewall_rule_group_associations @@ -2363,7 +2345,7 @@ components: x-cfn-type-name: AWS::Route53Resolver::FirewallRuleGroupAssociation x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2380,9 +2362,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2392,41 +2374,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/firewall_rule_group_associations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/firewall_rule_group_associations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::FirewallRuleGroupAssociation' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::FirewallRuleGroupAssociation' - AND region = 'us-east-1' - firewall_rule_group_association: - name: firewall_rule_group_association - id: aws.route53resolver.firewall_rule_group_association - x-cfn-schema-name: FirewallRuleGroupAssociation - x-cfn-type-name: AWS::Route53Resolver::FirewallRuleGroupAssociation - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2437,12 +2387,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/firewall_rule_group_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/firewall_rule_group_associations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/firewall_rule_group_association/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/firewall_rule_group_associations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2465,28 +2419,44 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'FirewallRuleGroupId') as firewall_rule_group_id, - json_extract_path_text(Properties, 'VpcId') as vpc_id, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Priority') as priority, - json_extract_path_text(Properties, 'MutationProtection') as mutation_protection, - json_extract_path_text(Properties, 'ManagedOwnerName') as managed_owner_name, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'StatusMessage') as status_message, - json_extract_path_text(Properties, 'CreatorRequestId') as creator_request_id, - json_extract_path_text(Properties, 'CreationTime') as creation_time, - json_extract_path_text(Properties, 'ModificationTime') as modification_time, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Route53Resolver::FirewallRuleGroupAssociation' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::FirewallRuleGroupAssociation' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'FirewallRuleGroupId') as firewall_rule_group_id, + json_extract_path_text(Properties, 'VpcId') as vpc_id, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Priority') as priority, + json_extract_path_text(Properties, 'MutationProtection') as mutation_protection, + json_extract_path_text(Properties, 'ManagedOwnerName') as managed_owner_name, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'StatusMessage') as status_message, + json_extract_path_text(Properties, 'CreatorRequestId') as creator_request_id, + json_extract_path_text(Properties, 'CreationTime') as creation_time, + json_extract_path_text(Properties, 'ModificationTime') as modification_time, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Route53Resolver::FirewallRuleGroupAssociation' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::FirewallRuleGroupAssociation' + AND region = 'us-east-1' outpost_resolvers: name: outpost_resolvers id: aws.route53resolver.outpost_resolvers @@ -2494,7 +2464,7 @@ components: x-cfn-type-name: AWS::Route53Resolver::OutpostResolver x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2511,9 +2481,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2523,41 +2493,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/outpost_resolvers/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/outpost_resolvers/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::OutpostResolver' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::OutpostResolver' - AND region = 'us-east-1' - outpost_resolver: - name: outpost_resolver - id: aws.route53resolver.outpost_resolver - x-cfn-schema-name: OutpostResolver - x-cfn-type-name: AWS::Route53Resolver::OutpostResolver - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2568,12 +2506,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/outpost_resolvers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/outpost_resolvers/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/outpost_resolver/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/outpost_resolvers/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2594,26 +2536,42 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'CreatorRequestId') as creator_request_id, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'OutpostArn') as outpost_arn, - json_extract_path_text(Properties, 'PreferredInstanceType') as preferred_instance_type, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'StatusMessage') as status_message, - json_extract_path_text(Properties, 'InstanceCount') as instance_count, - json_extract_path_text(Properties, 'CreationTime') as creation_time, - json_extract_path_text(Properties, 'ModificationTime') as modification_time, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Route53Resolver::OutpostResolver' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::OutpostResolver' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'CreatorRequestId') as creator_request_id, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'OutpostArn') as outpost_arn, + json_extract_path_text(Properties, 'PreferredInstanceType') as preferred_instance_type, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'StatusMessage') as status_message, + json_extract_path_text(Properties, 'InstanceCount') as instance_count, + json_extract_path_text(Properties, 'CreationTime') as creation_time, + json_extract_path_text(Properties, 'ModificationTime') as modification_time, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Route53Resolver::OutpostResolver' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::OutpostResolver' + AND region = 'us-east-1' resolver_configs: name: resolver_configs id: aws.route53resolver.resolver_configs @@ -2621,7 +2579,7 @@ components: x-cfn-type-name: AWS::Route53Resolver::ResolverConfig x-identifiers: - ResourceId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2655,39 +2613,11 @@ components: - $ref: '#/components/x-stackQL-resources/resolver_configs/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/resolver_configs/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ResourceId') as resource_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::ResolverConfig' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ResourceId') as resource_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::ResolverConfig' - AND region = 'us-east-1' - resolver_config: - name: resolver_config - id: aws.route53resolver.resolver_config - x-cfn-schema-name: ResolverConfig - x-cfn-type-name: AWS::Route53Resolver::ResolverConfig - x-identifiers: - - ResourceId - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2701,19 +2631,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'OwnerId') as owner_id, - json_extract_path_text(Properties, 'ResourceId') as resource_id, - json_extract_path_text(Properties, 'AutodefinedReverse') as autodefined_reverse, - json_extract_path_text(Properties, 'AutodefinedReverseFlag') as autodefined_reverse_flag - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Route53Resolver::ResolverConfig' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ResourceId') as resource_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::ResolverConfig' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'OwnerId') as owner_id, + json_extract_path_text(Properties, 'ResourceId') as resource_id, + json_extract_path_text(Properties, 'AutodefinedReverse') as autodefined_reverse, + json_extract_path_text(Properties, 'AutodefinedReverseFlag') as autodefined_reverse_flag + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Route53Resolver::ResolverConfig' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ResourceId') as resource_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::ResolverConfig' + AND region = 'us-east-1' resolverdnssec_configs: name: resolverdnssec_configs id: aws.route53resolver.resolverdnssec_configs @@ -2721,7 +2667,7 @@ components: x-cfn-type-name: AWS::Route53Resolver::ResolverDNSSECConfig x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2755,39 +2701,11 @@ components: - $ref: '#/components/x-stackQL-resources/resolverdnssec_configs/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/resolverdnssec_configs/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::ResolverDNSSECConfig' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::ResolverDNSSECConfig' - AND region = 'us-east-1' - resolverdnssec_config: - name: resolverdnssec_config - id: aws.route53resolver.resolverdnssec_config - x-cfn-schema-name: ResolverDNSSECConfig - x-cfn-type-name: AWS::Route53Resolver::ResolverDNSSECConfig - x-identifiers: - - Id - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2800,18 +2718,34 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'OwnerId') as owner_id, - json_extract_path_text(Properties, 'ResourceId') as resource_id, - json_extract_path_text(Properties, 'ValidationStatus') as validation_status - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Route53Resolver::ResolverDNSSECConfig' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::ResolverDNSSECConfig' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'OwnerId') as owner_id, + json_extract_path_text(Properties, 'ResourceId') as resource_id, + json_extract_path_text(Properties, 'ValidationStatus') as validation_status + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Route53Resolver::ResolverDNSSECConfig' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::ResolverDNSSECConfig' + AND region = 'us-east-1' resolver_query_logging_configs: name: resolver_query_logging_configs id: aws.route53resolver.resolver_query_logging_configs @@ -2819,7 +2753,7 @@ components: x-cfn-type-name: AWS::Route53Resolver::ResolverQueryLoggingConfig x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2853,39 +2787,11 @@ components: - $ref: '#/components/x-stackQL-resources/resolver_query_logging_configs/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/resolver_query_logging_configs/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::ResolverQueryLoggingConfig' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::ResolverQueryLoggingConfig' - AND region = 'us-east-1' - resolver_query_logging_config: - name: resolver_query_logging_config - id: aws.route53resolver.resolver_query_logging_config - x-cfn-schema-name: ResolverQueryLoggingConfig - x-cfn-type-name: AWS::Route53Resolver::ResolverQueryLoggingConfig - x-identifiers: - - Id - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2904,24 +2810,40 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'OwnerId') as owner_id, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'ShareStatus') as share_status, - json_extract_path_text(Properties, 'AssociationCount') as association_count, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'CreatorRequestId') as creator_request_id, - json_extract_path_text(Properties, 'DestinationArn') as destination_arn, - json_extract_path_text(Properties, 'CreationTime') as creation_time - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Route53Resolver::ResolverQueryLoggingConfig' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::ResolverQueryLoggingConfig' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'OwnerId') as owner_id, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'ShareStatus') as share_status, + json_extract_path_text(Properties, 'AssociationCount') as association_count, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'CreatorRequestId') as creator_request_id, + json_extract_path_text(Properties, 'DestinationArn') as destination_arn, + json_extract_path_text(Properties, 'CreationTime') as creation_time + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Route53Resolver::ResolverQueryLoggingConfig' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::ResolverQueryLoggingConfig' + AND region = 'us-east-1' resolver_query_logging_config_associations: name: resolver_query_logging_config_associations id: aws.route53resolver.resolver_query_logging_config_associations @@ -2929,7 +2851,7 @@ components: x-cfn-type-name: AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2963,39 +2885,11 @@ components: - $ref: '#/components/x-stackQL-resources/resolver_query_logging_config_associations/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/resolver_query_logging_config_associations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation' - AND region = 'us-east-1' - resolver_query_logging_config_association: - name: resolver_query_logging_config_association - id: aws.route53resolver.resolver_query_logging_config_association - x-cfn-schema-name: ResolverQueryLoggingConfigAssociation - x-cfn-type-name: AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation - x-identifiers: - - Id - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3011,21 +2905,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'ResolverQueryLogConfigId') as resolver_query_log_config_id, - json_extract_path_text(Properties, 'ResourceId') as resource_id, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'Error') as error, - json_extract_path_text(Properties, 'ErrorMessage') as error_message, - json_extract_path_text(Properties, 'CreationTime') as creation_time - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'ResolverQueryLogConfigId') as resolver_query_log_config_id, + json_extract_path_text(Properties, 'ResourceId') as resource_id, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'Error') as error, + json_extract_path_text(Properties, 'ErrorMessage') as error_message, + json_extract_path_text(Properties, 'CreationTime') as creation_time + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation' + AND region = 'us-east-1' resolver_rules: name: resolver_rules id: aws.route53resolver.resolver_rules @@ -3033,7 +2943,7 @@ components: x-cfn-type-name: AWS::Route53Resolver::ResolverRule x-identifiers: - ResolverRuleId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3050,9 +2960,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3062,41 +2972,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/resolver_rules/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/resolver_rules/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ResolverRuleId') as resolver_rule_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::ResolverRule' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ResolverRuleId') as resolver_rule_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::ResolverRule' - AND region = 'us-east-1' - resolver_rule: - name: resolver_rule - id: aws.route53resolver.resolver_rule - x-cfn-schema-name: ResolverRule - x-cfn-type-name: AWS::Route53Resolver::ResolverRule - x-identifiers: - - ResolverRuleId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3107,12 +2985,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/resolver_rules/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/resolver_rules/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/resolver_rule/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/resolver_rules/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3129,22 +3011,38 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ResolverEndpointId') as resolver_endpoint_id, - json_extract_path_text(Properties, 'DomainName') as domain_name, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'RuleType') as rule_type, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'TargetIps') as target_ips, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'ResolverRuleId') as resolver_rule_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Route53Resolver::ResolverRule' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ResolverRuleId') as resolver_rule_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::ResolverRule' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ResolverEndpointId') as resolver_endpoint_id, + json_extract_path_text(Properties, 'DomainName') as domain_name, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'RuleType') as rule_type, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'TargetIps') as target_ips, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'ResolverRuleId') as resolver_rule_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Route53Resolver::ResolverRule' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ResolverRuleId') as resolver_rule_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::ResolverRule' + AND region = 'us-east-1' resolver_rule_associations: name: resolver_rule_associations id: aws.route53resolver.resolver_rule_associations @@ -3152,7 +3050,7 @@ components: x-cfn-type-name: AWS::Route53Resolver::ResolverRuleAssociation x-identifiers: - ResolverRuleAssociationId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3186,39 +3084,11 @@ components: - $ref: '#/components/x-stackQL-resources/resolver_rule_associations/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/resolver_rule_associations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ResolverRuleAssociationId') as resolver_rule_association_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::ResolverRuleAssociation' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ResolverRuleAssociationId') as resolver_rule_association_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::ResolverRuleAssociation' - AND region = 'us-east-1' - resolver_rule_association: - name: resolver_rule_association - id: aws.route53resolver.resolver_rule_association - x-cfn-schema-name: ResolverRuleAssociation - x-cfn-type-name: AWS::Route53Resolver::ResolverRuleAssociation - x-identifiers: - - ResolverRuleAssociationId - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3231,18 +3101,34 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'VPCId') as vpc_id, - json_extract_path_text(Properties, 'ResolverRuleId') as resolver_rule_id, - json_extract_path_text(Properties, 'ResolverRuleAssociationId') as resolver_rule_association_id, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Route53Resolver::ResolverRuleAssociation' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ResolverRuleAssociationId') as resolver_rule_association_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::ResolverRuleAssociation' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'VPCId') as vpc_id, + json_extract_path_text(Properties, 'ResolverRuleId') as resolver_rule_id, + json_extract_path_text(Properties, 'ResolverRuleAssociationId') as resolver_rule_association_id, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Route53Resolver::ResolverRuleAssociation' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ResolverRuleAssociationId') as resolver_rule_association_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53Resolver::ResolverRuleAssociation' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/rum.yaml b/providers/src/aws/v00.00.00000/services/rum.yaml index 7e644632..39d92f0b 100644 --- a/providers/src/aws/v00.00.00000/services/rum.yaml +++ b/providers/src/aws/v00.00.00000/services/rum.yaml @@ -687,9 +687,11 @@ components: x-required-properties: - Name - Domain - x-taggable: true + x-tagging: + taggable: true x-required-permissions: create: + - rum:GetAppMonitor - rum:CreateAppMonitor - dynamodb:GetItem - dynamodb:PutItem @@ -706,11 +708,15 @@ components: - logs:DescribeLogGroups - logs:PutRetentionPolicy - rum:TagResource + - rum:ListTagsForResource - cognito-identity:DescribeIdentityPool - iam:GetRole - iam:CreateServiceLinkedRole + - iam:PassRole - rum:PutRumMetricsDestination - rum:BatchCreateRumMetricDefinitions + - rum:ListRumMetricsDestinations + - rum:BatchGetRumMetricDefinitions read: - rum:GetAppMonitor - dynamodb:GetItem @@ -721,6 +727,7 @@ components: - rum:ListRumMetricsDestinations - rum:BatchGetRumMetricDefinitions update: + - rum:GetAppMonitor - rum:UpdateAppMonitor - dynamodb:GetItem - dynamodb:PutItem @@ -743,6 +750,7 @@ components: - rum:ListTagsForResource - iam:GetRole - iam:CreateServiceLinkedRole + - iam:PassRole - rum:PutRumMetricsDestination - rum:DeleteRumMetricsDestination - rum:ListRumMetricsDestinations @@ -751,6 +759,7 @@ components: - rum:BatchGetRumMetricDefinitions - rum:UpdateRumMetricDefinition delete: + - rum:GetAppMonitor - rum:DeleteAppMonitor - dynamodb:DeleteItem - dynamodb:Query @@ -758,8 +767,11 @@ components: - s3:DeleteObject - s3:DoesObjectExist - rum:UntagResource + - rum:ListTagsForResource - rum:DeleteRumMetricsDestination - rum:BatchDeleteRumMetricDefinitions + - rum:ListRumMetricsDestinations + - rum:BatchGetRumMetricDefinitions list: - rum:ListAppMonitors - dynamodb:DescribeTable @@ -831,7 +843,7 @@ components: x-cfn-type-name: AWS::RUM::AppMonitor x-identifiers: - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -848,9 +860,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -860,41 +872,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/app_monitors/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/app_monitors/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RUM::AppMonitor' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RUM::AppMonitor' - AND region = 'us-east-1' - app_monitor: - name: app_monitor - id: aws.rum.app_monitor - x-cfn-schema-name: AppMonitor - x-cfn-type-name: AWS::RUM::AppMonitor - x-identifiers: - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -905,12 +885,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/app_monitors/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/app_monitors/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/app_monitor/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/app_monitors/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -926,21 +910,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Domain') as domain, - json_extract_path_text(Properties, 'CwLogEnabled') as cw_log_enabled, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'AppMonitorConfiguration') as app_monitor_configuration, - json_extract_path_text(Properties, 'CustomEvents') as custom_events - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::RUM::AppMonitor' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RUM::AppMonitor' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Domain') as domain, + json_extract_path_text(Properties, 'CwLogEnabled') as cw_log_enabled, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'AppMonitorConfiguration') as app_monitor_configuration, + json_extract_path_text(Properties, 'CustomEvents') as custom_events + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::RUM::AppMonitor' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::RUM::AppMonitor' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/s3.yaml b/providers/src/aws/v00.00.00000/services/s3.yaml index f3c8713c..a418a269 100644 --- a/providers/src/aws/v00.00.00000/services/s3.yaml +++ b/providers/src/aws/v00.00.00000/services/s3.yaml @@ -3367,7 +3367,7 @@ components: x-cfn-type-name: AWS::S3::AccessGrant x-identifiers: - AccessGrantId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3384,9 +3384,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3396,41 +3396,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/access_grants/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/access_grants/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AccessGrantId') as access_grant_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::S3::AccessGrant' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AccessGrantId') as access_grant_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::S3::AccessGrant' - AND region = 'us-east-1' - access_grant: - name: access_grant - id: aws.s3.access_grant - x-cfn-schema-name: AccessGrant - x-cfn-type-name: AWS::S3::AccessGrant - x-identifiers: - - AccessGrantId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3441,12 +3409,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/access_grants/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/access_grants/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/access_grant/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/access_grants/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3465,24 +3437,40 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AccessGrantId') as access_grant_id, - json_extract_path_text(Properties, 'AccessGrantsLocationId') as access_grants_location_id, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Permission') as permission, - json_extract_path_text(Properties, 'ApplicationArn') as application_arn, - json_extract_path_text(Properties, 'S3PrefixType') as s3_prefix_type, - json_extract_path_text(Properties, 'GrantScope') as grant_scope, - json_extract_path_text(Properties, 'AccessGrantArn') as access_grant_arn, - json_extract_path_text(Properties, 'Grantee') as grantee, - json_extract_path_text(Properties, 'AccessGrantsLocationConfiguration') as access_grants_location_configuration - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::S3::AccessGrant' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.AccessGrantId') as access_grant_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::S3::AccessGrant' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AccessGrantId') as access_grant_id, + json_extract_path_text(Properties, 'AccessGrantsLocationId') as access_grants_location_id, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Permission') as permission, + json_extract_path_text(Properties, 'ApplicationArn') as application_arn, + json_extract_path_text(Properties, 'S3PrefixType') as s3_prefix_type, + json_extract_path_text(Properties, 'GrantScope') as grant_scope, + json_extract_path_text(Properties, 'AccessGrantArn') as access_grant_arn, + json_extract_path_text(Properties, 'Grantee') as grantee, + json_extract_path_text(Properties, 'AccessGrantsLocationConfiguration') as access_grants_location_configuration + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::S3::AccessGrant' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AccessGrantId') as access_grant_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::S3::AccessGrant' + AND region = 'us-east-1' access_grants_instances: name: access_grants_instances id: aws.s3.access_grants_instances @@ -3490,7 +3478,7 @@ components: x-cfn-type-name: AWS::S3::AccessGrantsInstance x-identifiers: - AccessGrantsInstanceArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3507,9 +3495,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3519,41 +3507,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/access_grants_instances/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/access_grants_instances/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AccessGrantsInstanceArn') as access_grants_instance_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::S3::AccessGrantsInstance' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AccessGrantsInstanceArn') as access_grants_instance_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::S3::AccessGrantsInstance' - AND region = 'us-east-1' - access_grants_instance: - name: access_grants_instance - id: aws.s3.access_grants_instance - x-cfn-schema-name: AccessGrantsInstance - x-cfn-type-name: AWS::S3::AccessGrantsInstance - x-identifiers: - - AccessGrantsInstanceArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3564,12 +3520,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/access_grants_instances/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/access_grants_instances/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/access_grants_instance/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/access_grants_instances/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3582,18 +3542,34 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AccessGrantsInstanceArn') as access_grants_instance_arn, - json_extract_path_text(Properties, 'IdentityCenterArn') as identity_center_arn, - json_extract_path_text(Properties, 'AccessGrantsInstanceId') as access_grants_instance_id, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::S3::AccessGrantsInstance' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.AccessGrantsInstanceArn') as access_grants_instance_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::S3::AccessGrantsInstance' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AccessGrantsInstanceArn') as access_grants_instance_arn, + json_extract_path_text(Properties, 'IdentityCenterArn') as identity_center_arn, + json_extract_path_text(Properties, 'AccessGrantsInstanceId') as access_grants_instance_id, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::S3::AccessGrantsInstance' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AccessGrantsInstanceArn') as access_grants_instance_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::S3::AccessGrantsInstance' + AND region = 'us-east-1' access_grants_locations: name: access_grants_locations id: aws.s3.access_grants_locations @@ -3601,7 +3577,7 @@ components: x-cfn-type-name: AWS::S3::AccessGrantsLocation x-identifiers: - AccessGrantsLocationId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3618,9 +3594,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3630,41 +3606,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/access_grants_locations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/access_grants_locations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AccessGrantsLocationId') as access_grants_location_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::S3::AccessGrantsLocation' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AccessGrantsLocationId') as access_grants_location_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::S3::AccessGrantsLocation' - AND region = 'us-east-1' - access_grants_location: - name: access_grants_location - id: aws.s3.access_grants_location - x-cfn-schema-name: AccessGrantsLocation - x-cfn-type-name: AWS::S3::AccessGrantsLocation - x-identifiers: - - AccessGrantsLocationId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3675,12 +3619,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/access_grants_locations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/access_grants_locations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/access_grants_location/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/access_grants_locations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3694,19 +3642,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AccessGrantsLocationArn') as access_grants_location_arn, - json_extract_path_text(Properties, 'AccessGrantsLocationId') as access_grants_location_id, - json_extract_path_text(Properties, 'IamRoleArn') as iam_role_arn, - json_extract_path_text(Properties, 'LocationScope') as location_scope, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::S3::AccessGrantsLocation' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.AccessGrantsLocationId') as access_grants_location_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::S3::AccessGrantsLocation' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AccessGrantsLocationArn') as access_grants_location_arn, + json_extract_path_text(Properties, 'AccessGrantsLocationId') as access_grants_location_id, + json_extract_path_text(Properties, 'IamRoleArn') as iam_role_arn, + json_extract_path_text(Properties, 'LocationScope') as location_scope, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::S3::AccessGrantsLocation' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AccessGrantsLocationId') as access_grants_location_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::S3::AccessGrantsLocation' + AND region = 'us-east-1' access_points: name: access_points id: aws.s3.access_points @@ -3714,7 +3678,7 @@ components: x-cfn-type-name: AWS::S3::AccessPoint x-identifiers: - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3731,9 +3695,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3743,41 +3707,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/access_points/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/access_points/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::S3::AccessPoint' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::S3::AccessPoint' - AND region = 'us-east-1' - access_point: - name: access_point - id: aws.s3.access_point - x-cfn-schema-name: AccessPoint - x-cfn-type-name: AWS::S3::AccessPoint - x-identifiers: - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3788,12 +3720,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/access_points/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/access_points/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/access_point/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/access_points/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3811,23 +3747,39 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Alias') as alias, - json_extract_path_text(Properties, 'Bucket') as bucket, - json_extract_path_text(Properties, 'BucketAccountId') as bucket_account_id, - json_extract_path_text(Properties, 'VpcConfiguration') as vpc_configuration, - json_extract_path_text(Properties, 'PublicAccessBlockConfiguration') as public_access_block_configuration, - json_extract_path_text(Properties, 'Policy') as policy, - json_extract_path_text(Properties, 'NetworkOrigin') as network_origin, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::S3::AccessPoint' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::S3::AccessPoint' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Alias') as alias, + json_extract_path_text(Properties, 'Bucket') as bucket, + json_extract_path_text(Properties, 'BucketAccountId') as bucket_account_id, + json_extract_path_text(Properties, 'VpcConfiguration') as vpc_configuration, + json_extract_path_text(Properties, 'PublicAccessBlockConfiguration') as public_access_block_configuration, + json_extract_path_text(Properties, 'Policy') as policy, + json_extract_path_text(Properties, 'NetworkOrigin') as network_origin, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::S3::AccessPoint' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::S3::AccessPoint' + AND region = 'us-east-1' buckets: name: buckets id: aws.s3.buckets @@ -3835,7 +3787,7 @@ components: x-cfn-type-name: AWS::S3::Bucket x-identifiers: - BucketName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3852,9 +3804,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3864,41 +3816,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/buckets/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/buckets/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.BucketName') as bucket_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::S3::Bucket' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'BucketName') as bucket_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::S3::Bucket' - AND region = 'us-east-1' - bucket: - name: bucket - id: aws.s3.bucket - x-cfn-schema-name: Bucket - x-cfn-type-name: AWS::S3::Bucket - x-identifiers: - - BucketName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3909,12 +3829,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/buckets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/buckets/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/bucket/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/buckets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3948,39 +3872,55 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AccelerateConfiguration') as accelerate_configuration, - json_extract_path_text(Properties, 'AccessControl') as access_control, - json_extract_path_text(Properties, 'AnalyticsConfigurations') as analytics_configurations, - json_extract_path_text(Properties, 'BucketEncryption') as bucket_encryption, - json_extract_path_text(Properties, 'BucketName') as bucket_name, - json_extract_path_text(Properties, 'CorsConfiguration') as cors_configuration, - json_extract_path_text(Properties, 'IntelligentTieringConfigurations') as intelligent_tiering_configurations, - json_extract_path_text(Properties, 'InventoryConfigurations') as inventory_configurations, - json_extract_path_text(Properties, 'LifecycleConfiguration') as lifecycle_configuration, - json_extract_path_text(Properties, 'LoggingConfiguration') as logging_configuration, - json_extract_path_text(Properties, 'MetricsConfigurations') as metrics_configurations, - json_extract_path_text(Properties, 'NotificationConfiguration') as notification_configuration, - json_extract_path_text(Properties, 'ObjectLockConfiguration') as object_lock_configuration, - json_extract_path_text(Properties, 'ObjectLockEnabled') as object_lock_enabled, - json_extract_path_text(Properties, 'OwnershipControls') as ownership_controls, - json_extract_path_text(Properties, 'PublicAccessBlockConfiguration') as public_access_block_configuration, - json_extract_path_text(Properties, 'ReplicationConfiguration') as replication_configuration, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'VersioningConfiguration') as versioning_configuration, - json_extract_path_text(Properties, 'WebsiteConfiguration') as website_configuration, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'DomainName') as domain_name, - json_extract_path_text(Properties, 'DualStackDomainName') as dual_stack_domain_name, - json_extract_path_text(Properties, 'RegionalDomainName') as regional_domain_name, - json_extract_path_text(Properties, 'WebsiteURL') as website_url - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::S3::Bucket' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.BucketName') as bucket_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::S3::Bucket' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AccelerateConfiguration') as accelerate_configuration, + json_extract_path_text(Properties, 'AccessControl') as access_control, + json_extract_path_text(Properties, 'AnalyticsConfigurations') as analytics_configurations, + json_extract_path_text(Properties, 'BucketEncryption') as bucket_encryption, + json_extract_path_text(Properties, 'BucketName') as bucket_name, + json_extract_path_text(Properties, 'CorsConfiguration') as cors_configuration, + json_extract_path_text(Properties, 'IntelligentTieringConfigurations') as intelligent_tiering_configurations, + json_extract_path_text(Properties, 'InventoryConfigurations') as inventory_configurations, + json_extract_path_text(Properties, 'LifecycleConfiguration') as lifecycle_configuration, + json_extract_path_text(Properties, 'LoggingConfiguration') as logging_configuration, + json_extract_path_text(Properties, 'MetricsConfigurations') as metrics_configurations, + json_extract_path_text(Properties, 'NotificationConfiguration') as notification_configuration, + json_extract_path_text(Properties, 'ObjectLockConfiguration') as object_lock_configuration, + json_extract_path_text(Properties, 'ObjectLockEnabled') as object_lock_enabled, + json_extract_path_text(Properties, 'OwnershipControls') as ownership_controls, + json_extract_path_text(Properties, 'PublicAccessBlockConfiguration') as public_access_block_configuration, + json_extract_path_text(Properties, 'ReplicationConfiguration') as replication_configuration, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'VersioningConfiguration') as versioning_configuration, + json_extract_path_text(Properties, 'WebsiteConfiguration') as website_configuration, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'DomainName') as domain_name, + json_extract_path_text(Properties, 'DualStackDomainName') as dual_stack_domain_name, + json_extract_path_text(Properties, 'RegionalDomainName') as regional_domain_name, + json_extract_path_text(Properties, 'WebsiteURL') as website_url + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::S3::Bucket' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'BucketName') as bucket_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::S3::Bucket' + AND region = 'us-east-1' bucket_policies: name: bucket_policies id: aws.s3.bucket_policies @@ -3988,7 +3928,7 @@ components: x-cfn-type-name: AWS::S3::BucketPolicy x-identifiers: - Bucket - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -4005,9 +3945,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -4017,41 +3957,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/bucket_policies/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/bucket_policies/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Bucket') as bucket - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::S3::BucketPolicy' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Bucket') as bucket - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::S3::BucketPolicy' - AND region = 'us-east-1' - bucket_policy: - name: bucket_policy - id: aws.s3.bucket_policy - x-cfn-schema-name: BucketPolicy - x-cfn-type-name: AWS::S3::BucketPolicy - x-identifiers: - - Bucket - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -4062,12 +3970,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/bucket_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/bucket_policies/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/bucket_policy/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/bucket_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -4078,16 +3990,32 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Bucket') as bucket, - json_extract_path_text(Properties, 'PolicyDocument') as policy_document - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::S3::BucketPolicy' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Bucket') as bucket + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::S3::BucketPolicy' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Bucket') as bucket, + json_extract_path_text(Properties, 'PolicyDocument') as policy_document + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::S3::BucketPolicy' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Bucket') as bucket + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::S3::BucketPolicy' + AND region = 'us-east-1' multi_region_access_points: name: multi_region_access_points id: aws.s3.multi_region_access_points @@ -4095,7 +4023,7 @@ components: x-cfn-type-name: AWS::S3::MultiRegionAccessPoint x-identifiers: - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -4129,39 +4057,11 @@ components: - $ref: '#/components/x-stackQL-resources/multi_region_access_points/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/multi_region_access_points/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::S3::MultiRegionAccessPoint' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::S3::MultiRegionAccessPoint' - AND region = 'us-east-1' - multi_region_access_point: - name: multi_region_access_point - id: aws.s3.multi_region_access_point - x-cfn-schema-name: MultiRegionAccessPoint - x-cfn-type-name: AWS::S3::MultiRegionAccessPoint - x-identifiers: - - Name - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -4175,19 +4075,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Alias') as alias, - json_extract_path_text(Properties, 'CreatedAt') as created_at, - json_extract_path_text(Properties, 'PublicAccessBlockConfiguration') as public_access_block_configuration, - json_extract_path_text(Properties, 'Regions') as regions - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::S3::MultiRegionAccessPoint' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::S3::MultiRegionAccessPoint' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Alias') as alias, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'PublicAccessBlockConfiguration') as public_access_block_configuration, + json_extract_path_text(Properties, 'Regions') as regions + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::S3::MultiRegionAccessPoint' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::S3::MultiRegionAccessPoint' + AND region = 'us-east-1' multi_region_access_point_policies: name: multi_region_access_point_policies id: aws.s3.multi_region_access_point_policies @@ -4195,7 +4111,7 @@ components: x-cfn-type-name: AWS::S3::MultiRegionAccessPointPolicy x-identifiers: - MrapName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -4212,9 +4128,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -4224,23 +4140,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/multi_region_access_point_policies/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/multi_region_access_point_policies/methods/delete_resource' - multi_region_access_point_policy: - name: multi_region_access_point_policy - id: aws.s3.multi_region_access_point_policy - x-cfn-schema-name: MultiRegionAccessPointPolicy - x-cfn-type-name: AWS::S3::MultiRegionAccessPointPolicy - x-identifiers: - - MrapName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -4251,12 +4153,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/multi_region_access_point_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/multi_region_access_point_policies/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/multi_region_access_point_policy/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/multi_region_access_point_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -4268,7 +4174,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -4286,8 +4192,23 @@ components: x-cfn-type-name: AWS::S3::StorageLens x-identifiers: - StorageLensConfiguration/Id - x-type: get + x-type: cloud_control methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__StorageLens&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3::StorageLens" + } + response: + mediaType: application/json + openAPIDocKey: '200' update_resource: operation: $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' @@ -4300,13 +4221,29 @@ components: response: mediaType: application/json openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::S3::StorageLens" + } + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/storage_lens/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/storage_lens/methods/delete_resource' update: - $ref: '#/components/x-stackQL-resources/storage_lens/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -4317,16 +4254,32 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'StorageLensConfiguration') as storage_lens_configuration, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::S3::StorageLens' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.StorageLensConfiguration.Id') as storage_lens_configuration__id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::S3::StorageLens' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'StorageLensConfiguration') as storage_lens_configuration, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::S3::StorageLens' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'StorageLensConfiguration', 'Id') as storage_lens_configuration__id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::S3::StorageLens' + AND region = 'us-east-1' storage_lens_groups: name: storage_lens_groups id: aws.s3.storage_lens_groups @@ -4334,7 +4287,7 @@ components: x-cfn-type-name: AWS::S3::StorageLensGroup x-identifiers: - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -4351,9 +4304,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -4363,41 +4316,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/storage_lens_groups/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/storage_lens_groups/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::S3::StorageLensGroup' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::S3::StorageLensGroup' - AND region = 'us-east-1' - storage_lens_group: - name: storage_lens_group - id: aws.s3.storage_lens_group - x-cfn-schema-name: StorageLensGroup - x-cfn-type-name: AWS::S3::StorageLensGroup - x-identifiers: - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -4408,12 +4329,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/storage_lens_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/storage_lens_groups/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/storage_lens_group/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/storage_lens_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -4426,18 +4351,34 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Filter') as filter, - json_extract_path_text(Properties, 'StorageLensGroupArn') as storage_lens_group_arn, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::S3::StorageLensGroup' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::S3::StorageLensGroup' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Filter') as filter, + json_extract_path_text(Properties, 'StorageLensGroupArn') as storage_lens_group_arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::S3::StorageLensGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::S3::StorageLensGroup' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/s3express.yaml b/providers/src/aws/v00.00.00000/services/s3express.yaml index b756feaa..3e300ac1 100644 --- a/providers/src/aws/v00.00.00000/services/s3express.yaml +++ b/providers/src/aws/v00.00.00000/services/s3express.yaml @@ -557,7 +557,7 @@ components: x-cfn-type-name: AWS::S3Express::BucketPolicy x-identifiers: - Bucket - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -574,9 +574,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -586,41 +586,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/bucket_policies/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/bucket_policies/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Bucket') as bucket - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::S3Express::BucketPolicy' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Bucket') as bucket - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::S3Express::BucketPolicy' - AND region = 'us-east-1' - bucket_policy: - name: bucket_policy - id: aws.s3express.bucket_policy - x-cfn-schema-name: BucketPolicy - x-cfn-type-name: AWS::S3Express::BucketPolicy - x-identifiers: - - Bucket - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -631,12 +599,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/bucket_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/bucket_policies/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/bucket_policy/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/bucket_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -647,16 +619,32 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Bucket') as bucket, - json_extract_path_text(Properties, 'PolicyDocument') as policy_document - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::S3Express::BucketPolicy' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Bucket') as bucket + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::S3Express::BucketPolicy' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Bucket') as bucket, + json_extract_path_text(Properties, 'PolicyDocument') as policy_document + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::S3Express::BucketPolicy' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Bucket') as bucket + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::S3Express::BucketPolicy' + AND region = 'us-east-1' directory_buckets: name: directory_buckets id: aws.s3express.directory_buckets @@ -664,7 +652,7 @@ components: x-cfn-type-name: AWS::S3Express::DirectoryBucket x-identifiers: - BucketName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -698,39 +686,11 @@ components: - $ref: '#/components/x-stackQL-resources/directory_buckets/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/directory_buckets/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.BucketName') as bucket_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::S3Express::DirectoryBucket' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'BucketName') as bucket_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::S3Express::DirectoryBucket' - AND region = 'us-east-1' - directory_bucket: - name: directory_bucket - id: aws.s3express.directory_bucket - x-cfn-schema-name: DirectoryBucket - x-cfn-type-name: AWS::S3Express::DirectoryBucket - x-identifiers: - - BucketName - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -743,18 +703,34 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'BucketName') as bucket_name, - json_extract_path_text(Properties, 'LocationName') as location_name, - json_extract_path_text(Properties, 'DataRedundancy') as data_redundancy, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::S3Express::DirectoryBucket' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.BucketName') as bucket_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::S3Express::DirectoryBucket' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'BucketName') as bucket_name, + json_extract_path_text(Properties, 'LocationName') as location_name, + json_extract_path_text(Properties, 'DataRedundancy') as data_redundancy, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::S3Express::DirectoryBucket' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'BucketName') as bucket_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::S3Express::DirectoryBucket' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/s3objectlambda.yaml b/providers/src/aws/v00.00.00000/services/s3objectlambda.yaml index 598cb0bf..e602ae15 100644 --- a/providers/src/aws/v00.00.00000/services/s3objectlambda.yaml +++ b/providers/src/aws/v00.00.00000/services/s3objectlambda.yaml @@ -679,7 +679,7 @@ components: x-cfn-type-name: AWS::S3ObjectLambda::AccessPoint x-identifiers: - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -696,9 +696,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -708,41 +708,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/access_points/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/access_points/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::S3ObjectLambda::AccessPoint' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::S3ObjectLambda::AccessPoint' - AND region = 'us-east-1' - access_point: - name: access_point - id: aws.s3objectlambda.access_point - x-cfn-schema-name: AccessPoint - x-cfn-type-name: AWS::S3ObjectLambda::AccessPoint - x-identifiers: - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -753,12 +721,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/access_points/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/access_points/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/access_point/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/access_points/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -774,21 +746,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Alias') as alias, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'CreationDate') as creation_date, - json_extract_path_text(Properties, 'PublicAccessBlockConfiguration') as public_access_block_configuration, - json_extract_path_text(Properties, 'PolicyStatus') as policy_status, - json_extract_path_text(Properties, 'ObjectLambdaConfiguration') as object_lambda_configuration - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::S3ObjectLambda::AccessPoint' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::S3ObjectLambda::AccessPoint' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Alias') as alias, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'CreationDate') as creation_date, + json_extract_path_text(Properties, 'PublicAccessBlockConfiguration') as public_access_block_configuration, + json_extract_path_text(Properties, 'PolicyStatus') as policy_status, + json_extract_path_text(Properties, 'ObjectLambdaConfiguration') as object_lambda_configuration + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::S3ObjectLambda::AccessPoint' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::S3ObjectLambda::AccessPoint' + AND region = 'us-east-1' access_point_policies: name: access_point_policies id: aws.s3objectlambda.access_point_policies @@ -796,7 +784,7 @@ components: x-cfn-type-name: AWS::S3ObjectLambda::AccessPointPolicy x-identifiers: - ObjectLambdaAccessPoint - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -813,9 +801,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -825,23 +813,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/access_point_policies/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/access_point_policies/methods/delete_resource' - access_point_policy: - name: access_point_policy - id: aws.s3objectlambda.access_point_policy - x-cfn-schema-name: AccessPointPolicy - x-cfn-type-name: AWS::S3ObjectLambda::AccessPointPolicy - x-identifiers: - - ObjectLambdaAccessPoint - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -852,12 +826,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/access_point_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/access_point_policies/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/access_point_policy/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/access_point_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -868,7 +846,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, diff --git a/providers/src/aws/v00.00.00000/services/s3outposts.yaml b/providers/src/aws/v00.00.00000/services/s3outposts.yaml index 66a7b22b..29b7034c 100644 --- a/providers/src/aws/v00.00.00000/services/s3outposts.yaml +++ b/providers/src/aws/v00.00.00000/services/s3outposts.yaml @@ -1049,7 +1049,7 @@ components: x-cfn-type-name: AWS::S3Outposts::AccessPoint x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1066,9 +1066,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1078,41 +1078,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/access_points/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/access_points/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::S3Outposts::AccessPoint' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::S3Outposts::AccessPoint' - AND region = 'us-east-1' - access_point: - name: access_point - id: aws.s3outposts.access_point - x-cfn-schema-name: AccessPoint - x-cfn-type-name: AWS::S3Outposts::AccessPoint - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1123,12 +1091,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/access_points/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/access_points/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/access_point/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/access_points/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1142,19 +1114,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Bucket') as bucket, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'VpcConfiguration') as vpc_configuration, - json_extract_path_text(Properties, 'Policy') as policy - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::S3Outposts::AccessPoint' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::S3Outposts::AccessPoint' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Bucket') as bucket, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'VpcConfiguration') as vpc_configuration, + json_extract_path_text(Properties, 'Policy') as policy + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::S3Outposts::AccessPoint' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::S3Outposts::AccessPoint' + AND region = 'us-east-1' buckets: name: buckets id: aws.s3outposts.buckets @@ -1162,7 +1150,7 @@ components: x-cfn-type-name: AWS::S3Outposts::Bucket x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1179,9 +1167,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1191,41 +1179,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/buckets/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/buckets/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::S3Outposts::Bucket' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::S3Outposts::Bucket' - AND region = 'us-east-1' - bucket: - name: bucket - id: aws.s3outposts.bucket - x-cfn-schema-name: Bucket - x-cfn-type-name: AWS::S3Outposts::Bucket - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1236,12 +1192,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/buckets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/buckets/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/bucket/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/buckets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1255,19 +1215,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'BucketName') as bucket_name, - json_extract_path_text(Properties, 'OutpostId') as outpost_id, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'LifecycleConfiguration') as lifecycle_configuration - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::S3Outposts::Bucket' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::S3Outposts::Bucket' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'BucketName') as bucket_name, + json_extract_path_text(Properties, 'OutpostId') as outpost_id, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'LifecycleConfiguration') as lifecycle_configuration + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::S3Outposts::Bucket' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::S3Outposts::Bucket' + AND region = 'us-east-1' bucket_policies: name: bucket_policies id: aws.s3outposts.bucket_policies @@ -1275,7 +1251,7 @@ components: x-cfn-type-name: AWS::S3Outposts::BucketPolicy x-identifiers: - Bucket - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1292,9 +1268,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1304,23 +1280,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/bucket_policies/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/bucket_policies/methods/delete_resource' - bucket_policy: - name: bucket_policy - id: aws.s3outposts.bucket_policy - x-cfn-schema-name: BucketPolicy - x-cfn-type-name: AWS::S3Outposts::BucketPolicy - x-identifiers: - - Bucket - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1331,12 +1293,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/bucket_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/bucket_policies/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/bucket_policy/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/bucket_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1347,7 +1313,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1364,7 +1330,7 @@ components: x-cfn-type-name: AWS::S3Outposts::Endpoint x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1398,39 +1364,11 @@ components: - $ref: '#/components/x-stackQL-resources/endpoints/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/endpoints/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::S3Outposts::Endpoint' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::S3Outposts::Endpoint' - AND region = 'us-east-1' - endpoint: - name: endpoint - id: aws.s3outposts.endpoint - x-cfn-schema-name: Endpoint - x-cfn-type-name: AWS::S3Outposts::Endpoint - x-identifiers: - - Arn - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1451,26 +1389,42 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'CidrBlock') as cidr_block, - json_extract_path_text(Properties, 'CreationTime') as creation_time, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'NetworkInterfaces') as network_interfaces, - json_extract_path_text(Properties, 'OutpostId') as outpost_id, - json_extract_path_text(Properties, 'SecurityGroupId') as security_group_id, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'SubnetId') as subnet_id, - json_extract_path_text(Properties, 'AccessType') as access_type, - json_extract_path_text(Properties, 'CustomerOwnedIpv4Pool') as customer_owned_ipv4_pool, - json_extract_path_text(Properties, 'FailedReason') as failed_reason - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::S3Outposts::Endpoint' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::S3Outposts::Endpoint' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'CidrBlock') as cidr_block, + json_extract_path_text(Properties, 'CreationTime') as creation_time, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'NetworkInterfaces') as network_interfaces, + json_extract_path_text(Properties, 'OutpostId') as outpost_id, + json_extract_path_text(Properties, 'SecurityGroupId') as security_group_id, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'SubnetId') as subnet_id, + json_extract_path_text(Properties, 'AccessType') as access_type, + json_extract_path_text(Properties, 'CustomerOwnedIpv4Pool') as customer_owned_ipv4_pool, + json_extract_path_text(Properties, 'FailedReason') as failed_reason + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::S3Outposts::Endpoint' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::S3Outposts::Endpoint' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/sagemaker.yaml b/providers/src/aws/v00.00.00000/services/sagemaker.yaml index dc821477..d9ff067a 100644 --- a/providers/src/aws/v00.00.00000/services/sagemaker.yaml +++ b/providers/src/aws/v00.00.00000/services/sagemaker.yaml @@ -1380,6 +1380,22 @@ components: type: string maxLength: 32 pattern: '[-0-9a-zA-Z]+' + JupyterLabAppSettings: + $ref: '#/components/schemas/JupyterLabAppSettings' + description: The Jupyter lab's app settings. + SpaceStorageSettings: + $ref: '#/components/schemas/DefaultSpaceStorageSettings' + description: The Jupyter lab's space storage settings. + CustomPosixUserConfig: + $ref: '#/components/schemas/CustomPosixUserConfig' + description: The Jupyter lab's custom posix user configurations. + CustomFileSystemConfigs: + type: array + uniqueItems: true + minItems: 0 + maxItems: 2 + items: + $ref: '#/components/schemas/CustomFileSystemConfig' required: - ExecutionRole JupyterServerAppSettings: @@ -1622,8 +1638,9 @@ components: maxItems: 10 items: type: string + minLength: 12 maxLength: 12 - pattern: ^[0-9]$ + pattern: ^\d+$ RStudioServerProDomainSettings: type: object description: A collection of settings that update the current configuration for the RStudioServerPro Domain-level app. @@ -1658,7 +1675,7 @@ components: x-insertionOrder: false uniqueItems: false minItems: 0 - maxItems: 30 + maxItems: 200 items: $ref: '#/components/schemas/CustomImage' DefaultResourceSpec: @@ -3638,6 +3655,7 @@ components: x-required-permissions: create: - sagemaker:CreateModelCard + - sagemaker:DescribeModel - kms:DescribeKey - kms:GenerateDataKey - kms:CreateGrant @@ -3653,6 +3671,7 @@ components: update: - sagemaker:UpdateModelCard - sagemaker:DescribeModelCard + - sagemaker:DescribeModel - kms:GenerateDataKey - kms:Decrypt - sagemaker:DescribeModelPackageGroup @@ -6897,7 +6916,7 @@ components: - AppType - DomainId - UserProfileName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -6931,48 +6950,11 @@ components: - $ref: '#/components/x-stackQL-resources/apps/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/apps/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AppName') as app_name, - JSON_EXTRACT(Properties, '$.AppType') as app_type, - JSON_EXTRACT(Properties, '$.DomainId') as domain_id, - JSON_EXTRACT(Properties, '$.UserProfileName') as user_profile_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::App' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AppName') as app_name, - json_extract_path_text(Properties, 'AppType') as app_type, - json_extract_path_text(Properties, 'DomainId') as domain_id, - json_extract_path_text(Properties, 'UserProfileName') as user_profile_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::App' - AND region = 'us-east-1' - app: - name: app - id: aws.sagemaker.app - x-cfn-schema-name: App - x-cfn-type-name: AWS::SageMaker::App - x-identifiers: - - AppName - - AppType - - DomainId - - UserProfileName - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -6988,21 +6970,43 @@ components: AND data__Identifier = '|||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AppArn') as app_arn, - json_extract_path_text(Properties, 'AppName') as app_name, - json_extract_path_text(Properties, 'AppType') as app_type, - json_extract_path_text(Properties, 'DomainId') as domain_id, - json_extract_path_text(Properties, 'ResourceSpec') as resource_spec, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'UserProfileName') as user_profile_name - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::App' - AND data__Identifier = '|||' + JSON_EXTRACT(Properties, '$.AppName') as app_name, + JSON_EXTRACT(Properties, '$.AppType') as app_type, + JSON_EXTRACT(Properties, '$.DomainId') as domain_id, + JSON_EXTRACT(Properties, '$.UserProfileName') as user_profile_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::App' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AppArn') as app_arn, + json_extract_path_text(Properties, 'AppName') as app_name, + json_extract_path_text(Properties, 'AppType') as app_type, + json_extract_path_text(Properties, 'DomainId') as domain_id, + json_extract_path_text(Properties, 'ResourceSpec') as resource_spec, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'UserProfileName') as user_profile_name + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::App' + AND data__Identifier = '|||' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AppName') as app_name, + json_extract_path_text(Properties, 'AppType') as app_type, + json_extract_path_text(Properties, 'DomainId') as domain_id, + json_extract_path_text(Properties, 'UserProfileName') as user_profile_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::App' + AND region = 'us-east-1' app_image_configs: name: app_image_configs id: aws.sagemaker.app_image_configs @@ -7010,7 +7014,7 @@ components: x-cfn-type-name: AWS::SageMaker::AppImageConfig x-identifiers: - AppImageConfigName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -7027,9 +7031,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -7039,41 +7043,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/app_image_configs/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/app_image_configs/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AppImageConfigName') as app_image_config_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::AppImageConfig' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AppImageConfigName') as app_image_config_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::AppImageConfig' - AND region = 'us-east-1' - app_image_config: - name: app_image_config - id: aws.sagemaker.app_image_config - x-cfn-schema-name: AppImageConfig - x-cfn-type-name: AWS::SageMaker::AppImageConfig - x-identifiers: - - AppImageConfigName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -7084,12 +7056,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/app_image_configs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/app_image_configs/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/app_image_config/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/app_image_configs/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -7104,20 +7080,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AppImageConfigArn') as app_image_config_arn, - json_extract_path_text(Properties, 'AppImageConfigName') as app_image_config_name, - json_extract_path_text(Properties, 'KernelGatewayImageConfig') as kernel_gateway_image_config, - json_extract_path_text(Properties, 'JupyterLabAppImageConfig') as jupyter_lab_app_image_config, - json_extract_path_text(Properties, 'CodeEditorAppImageConfig') as code_editor_app_image_config, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::AppImageConfig' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.AppImageConfigName') as app_image_config_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::AppImageConfig' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AppImageConfigArn') as app_image_config_arn, + json_extract_path_text(Properties, 'AppImageConfigName') as app_image_config_name, + json_extract_path_text(Properties, 'KernelGatewayImageConfig') as kernel_gateway_image_config, + json_extract_path_text(Properties, 'JupyterLabAppImageConfig') as jupyter_lab_app_image_config, + json_extract_path_text(Properties, 'CodeEditorAppImageConfig') as code_editor_app_image_config, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::AppImageConfig' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AppImageConfigName') as app_image_config_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::AppImageConfig' + AND region = 'us-east-1' data_quality_job_definitions: name: data_quality_job_definitions id: aws.sagemaker.data_quality_job_definitions @@ -7125,7 +7117,7 @@ components: x-cfn-type-name: AWS::SageMaker::DataQualityJobDefinition x-identifiers: - JobDefinitionArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -7159,39 +7151,11 @@ components: - $ref: '#/components/x-stackQL-resources/data_quality_job_definitions/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/data_quality_job_definitions/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.JobDefinitionArn') as job_definition_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::DataQualityJobDefinition' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'JobDefinitionArn') as job_definition_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::DataQualityJobDefinition' - AND region = 'us-east-1' - data_quality_job_definition: - name: data_quality_job_definition - id: aws.sagemaker.data_quality_job_definition - x-cfn-schema-name: DataQualityJobDefinition - x-cfn-type-name: AWS::SageMaker::DataQualityJobDefinition - x-identifiers: - - JobDefinitionArn - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -7213,27 +7177,43 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'JobDefinitionArn') as job_definition_arn, - json_extract_path_text(Properties, 'JobDefinitionName') as job_definition_name, - json_extract_path_text(Properties, 'DataQualityBaselineConfig') as data_quality_baseline_config, - json_extract_path_text(Properties, 'DataQualityAppSpecification') as data_quality_app_specification, - json_extract_path_text(Properties, 'DataQualityJobInput') as data_quality_job_input, - json_extract_path_text(Properties, 'DataQualityJobOutputConfig') as data_quality_job_output_config, - json_extract_path_text(Properties, 'JobResources') as job_resources, - json_extract_path_text(Properties, 'NetworkConfig') as network_config, - json_extract_path_text(Properties, 'EndpointName') as endpoint_name, - json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'StoppingCondition') as stopping_condition, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'CreationTime') as creation_time - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::DataQualityJobDefinition' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.JobDefinitionArn') as job_definition_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::DataQualityJobDefinition' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'JobDefinitionArn') as job_definition_arn, + json_extract_path_text(Properties, 'JobDefinitionName') as job_definition_name, + json_extract_path_text(Properties, 'DataQualityBaselineConfig') as data_quality_baseline_config, + json_extract_path_text(Properties, 'DataQualityAppSpecification') as data_quality_app_specification, + json_extract_path_text(Properties, 'DataQualityJobInput') as data_quality_job_input, + json_extract_path_text(Properties, 'DataQualityJobOutputConfig') as data_quality_job_output_config, + json_extract_path_text(Properties, 'JobResources') as job_resources, + json_extract_path_text(Properties, 'NetworkConfig') as network_config, + json_extract_path_text(Properties, 'EndpointName') as endpoint_name, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'StoppingCondition') as stopping_condition, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'CreationTime') as creation_time + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::DataQualityJobDefinition' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'JobDefinitionArn') as job_definition_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::DataQualityJobDefinition' + AND region = 'us-east-1' devices: name: devices id: aws.sagemaker.devices @@ -7241,7 +7221,7 @@ components: x-cfn-type-name: AWS::SageMaker::Device x-identifiers: - Device/DeviceName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -7258,9 +7238,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -7270,23 +7250,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/devices/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/devices/methods/delete_resource' - device: - name: device - id: aws.sagemaker.device - x-cfn-schema-name: Device - x-cfn-type-name: AWS::SageMaker::Device - x-identifiers: - - Device/DeviceName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -7297,12 +7263,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/devices/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/devices/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/device/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/devices/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -7314,7 +7284,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -7332,7 +7302,7 @@ components: x-cfn-type-name: AWS::SageMaker::DeviceFleet x-identifiers: - DeviceFleetName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -7349,9 +7319,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -7361,23 +7331,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/device_fleets/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/device_fleets/methods/delete_resource' - device_fleet: - name: device_fleet - id: aws.sagemaker.device_fleet - x-cfn-schema-name: DeviceFleet - x-cfn-type-name: AWS::SageMaker::DeviceFleet - x-identifiers: - - DeviceFleetName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -7388,12 +7344,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/device_fleets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/device_fleets/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/device_fleet/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/device_fleets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -7407,7 +7367,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -7427,7 +7387,7 @@ components: x-cfn-type-name: AWS::SageMaker::FeatureGroup x-identifiers: - FeatureGroupName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -7444,9 +7404,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -7456,41 +7416,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/feature_groups/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/feature_groups/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.FeatureGroupName') as feature_group_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::FeatureGroup' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'FeatureGroupName') as feature_group_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::FeatureGroup' - AND region = 'us-east-1' - feature_group: - name: feature_group - id: aws.sagemaker.feature_group - x-cfn-schema-name: FeatureGroup - x-cfn-type-name: AWS::SageMaker::FeatureGroup - x-identifiers: - - FeatureGroupName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -7501,12 +7429,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/feature_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/feature_groups/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/feature_group/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/feature_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -7527,26 +7459,42 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'FeatureGroupName') as feature_group_name, - json_extract_path_text(Properties, 'RecordIdentifierFeatureName') as record_identifier_feature_name, - json_extract_path_text(Properties, 'EventTimeFeatureName') as event_time_feature_name, - json_extract_path_text(Properties, 'FeatureDefinitions') as feature_definitions, - json_extract_path_text(Properties, 'OnlineStoreConfig') as online_store_config, - json_extract_path_text(Properties, 'OfflineStoreConfig') as offline_store_config, - json_extract_path_text(Properties, 'ThroughputConfig') as throughput_config, - json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'CreationTime') as creation_time, - json_extract_path_text(Properties, 'FeatureGroupStatus') as feature_group_status, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::FeatureGroup' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.FeatureGroupName') as feature_group_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::FeatureGroup' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'FeatureGroupName') as feature_group_name, + json_extract_path_text(Properties, 'RecordIdentifierFeatureName') as record_identifier_feature_name, + json_extract_path_text(Properties, 'EventTimeFeatureName') as event_time_feature_name, + json_extract_path_text(Properties, 'FeatureDefinitions') as feature_definitions, + json_extract_path_text(Properties, 'OnlineStoreConfig') as online_store_config, + json_extract_path_text(Properties, 'OfflineStoreConfig') as offline_store_config, + json_extract_path_text(Properties, 'ThroughputConfig') as throughput_config, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'CreationTime') as creation_time, + json_extract_path_text(Properties, 'FeatureGroupStatus') as feature_group_status, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::FeatureGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'FeatureGroupName') as feature_group_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::FeatureGroup' + AND region = 'us-east-1' images: name: images id: aws.sagemaker.images @@ -7554,7 +7502,7 @@ components: x-cfn-type-name: AWS::SageMaker::Image x-identifiers: - ImageArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -7571,9 +7519,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -7583,41 +7531,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/images/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/images/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ImageArn') as image_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::Image' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ImageArn') as image_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::Image' - AND region = 'us-east-1' - image: - name: image - id: aws.sagemaker.image - x-cfn-schema-name: Image - x-cfn-type-name: AWS::SageMaker::Image - x-identifiers: - - ImageArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -7628,12 +7544,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/images/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/images/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/image/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/images/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -7648,20 +7568,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ImageName') as image_name, - json_extract_path_text(Properties, 'ImageArn') as image_arn, - json_extract_path_text(Properties, 'ImageRoleArn') as image_role_arn, - json_extract_path_text(Properties, 'ImageDisplayName') as image_display_name, - json_extract_path_text(Properties, 'ImageDescription') as image_description, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::Image' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ImageArn') as image_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::Image' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ImageName') as image_name, + json_extract_path_text(Properties, 'ImageArn') as image_arn, + json_extract_path_text(Properties, 'ImageRoleArn') as image_role_arn, + json_extract_path_text(Properties, 'ImageDisplayName') as image_display_name, + json_extract_path_text(Properties, 'ImageDescription') as image_description, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::Image' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ImageArn') as image_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::Image' + AND region = 'us-east-1' image_versions: name: image_versions id: aws.sagemaker.image_versions @@ -7669,7 +7605,7 @@ components: x-cfn-type-name: AWS::SageMaker::ImageVersion x-identifiers: - ImageVersionArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -7686,6 +7622,18 @@ components: response: mediaType: application/json openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SageMaker::ImageVersion" + } + response: + mediaType: application/json + openAPIDocKey: '200' delete_resource: operation: $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' @@ -7703,98 +7651,74 @@ components: - $ref: '#/components/x-stackQL-resources/image_versions/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/image_versions/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/image_versions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ImageVersionArn') as image_version_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::ImageVersion' + data__Identifier, + JSON_EXTRACT(Properties, '$.ImageName') as image_name, + JSON_EXTRACT(Properties, '$.ImageArn') as image_arn, + JSON_EXTRACT(Properties, '$.ImageVersionArn') as image_version_arn, + JSON_EXTRACT(Properties, '$.BaseImage') as base_image, + JSON_EXTRACT(Properties, '$.ContainerImage') as container_image, + JSON_EXTRACT(Properties, '$.Version') as version, + JSON_EXTRACT(Properties, '$.Alias') as alias, + JSON_EXTRACT(Properties, '$.Aliases') as aliases, + JSON_EXTRACT(Properties, '$.VendorGuidance') as vendor_guidance, + JSON_EXTRACT(Properties, '$.JobType') as job_type, + JSON_EXTRACT(Properties, '$.MLFramework') as ml_framework, + JSON_EXTRACT(Properties, '$.ProgrammingLang') as programming_lang, + JSON_EXTRACT(Properties, '$.Processor') as processor, + JSON_EXTRACT(Properties, '$.Horovod') as horovod, + JSON_EXTRACT(Properties, '$.ReleaseNotes') as release_notes + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::ImageVersion' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ImageVersionArn') as image_version_arn + JSON_EXTRACT(Properties, '$.ImageVersionArn') as image_version_arn FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::ImageVersion' AND region = 'us-east-1' - image_version: - name: image_version - id: aws.sagemaker.image_version - x-cfn-schema-name: ImageVersion - x-cfn-type-name: AWS::SageMaker::ImageVersion - x-identifiers: - - ImageVersionArn - x-type: get - methods: - update_resource: - operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' - request: - mediaType: application/x-amz-json-1.0 - base: |- - { - "TypeName": "AWS::SageMaker::ImageVersion" - } - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - update: - - $ref: '#/components/x-stackQL-resources/image_version/methods/update_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - data__Identifier, - JSON_EXTRACT(Properties, '$.ImageName') as image_name, - JSON_EXTRACT(Properties, '$.ImageArn') as image_arn, - JSON_EXTRACT(Properties, '$.ImageVersionArn') as image_version_arn, - JSON_EXTRACT(Properties, '$.BaseImage') as base_image, - JSON_EXTRACT(Properties, '$.ContainerImage') as container_image, - JSON_EXTRACT(Properties, '$.Version') as version, - JSON_EXTRACT(Properties, '$.Alias') as alias, - JSON_EXTRACT(Properties, '$.Aliases') as aliases, - JSON_EXTRACT(Properties, '$.VendorGuidance') as vendor_guidance, - JSON_EXTRACT(Properties, '$.JobType') as job_type, - JSON_EXTRACT(Properties, '$.MLFramework') as ml_framework, - JSON_EXTRACT(Properties, '$.ProgrammingLang') as programming_lang, - JSON_EXTRACT(Properties, '$.Processor') as processor, - JSON_EXTRACT(Properties, '$.Horovod') as horovod, - JSON_EXTRACT(Properties, '$.ReleaseNotes') as release_notes - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::ImageVersion' - AND data__Identifier = '' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - data__Identifier, - json_extract_path_text(Properties, 'ImageName') as image_name, - json_extract_path_text(Properties, 'ImageArn') as image_arn, - json_extract_path_text(Properties, 'ImageVersionArn') as image_version_arn, - json_extract_path_text(Properties, 'BaseImage') as base_image, - json_extract_path_text(Properties, 'ContainerImage') as container_image, - json_extract_path_text(Properties, 'Version') as version, - json_extract_path_text(Properties, 'Alias') as alias, - json_extract_path_text(Properties, 'Aliases') as aliases, - json_extract_path_text(Properties, 'VendorGuidance') as vendor_guidance, - json_extract_path_text(Properties, 'JobType') as job_type, - json_extract_path_text(Properties, 'MLFramework') as ml_framework, - json_extract_path_text(Properties, 'ProgrammingLang') as programming_lang, - json_extract_path_text(Properties, 'Processor') as processor, - json_extract_path_text(Properties, 'Horovod') as horovod, - json_extract_path_text(Properties, 'ReleaseNotes') as release_notes - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::ImageVersion' - AND data__Identifier = '' - AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ImageName') as image_name, + json_extract_path_text(Properties, 'ImageArn') as image_arn, + json_extract_path_text(Properties, 'ImageVersionArn') as image_version_arn, + json_extract_path_text(Properties, 'BaseImage') as base_image, + json_extract_path_text(Properties, 'ContainerImage') as container_image, + json_extract_path_text(Properties, 'Version') as version, + json_extract_path_text(Properties, 'Alias') as alias, + json_extract_path_text(Properties, 'Aliases') as aliases, + json_extract_path_text(Properties, 'VendorGuidance') as vendor_guidance, + json_extract_path_text(Properties, 'JobType') as job_type, + json_extract_path_text(Properties, 'MLFramework') as ml_framework, + json_extract_path_text(Properties, 'ProgrammingLang') as programming_lang, + json_extract_path_text(Properties, 'Processor') as processor, + json_extract_path_text(Properties, 'Horovod') as horovod, + json_extract_path_text(Properties, 'ReleaseNotes') as release_notes + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::ImageVersion' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ImageVersionArn') as image_version_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::ImageVersion' + AND region = 'us-east-1' inference_components: name: inference_components id: aws.sagemaker.inference_components @@ -7802,7 +7726,7 @@ components: x-cfn-type-name: AWS::SageMaker::InferenceComponent x-identifiers: - InferenceComponentArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -7819,9 +7743,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -7831,41 +7755,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/inference_components/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/inference_components/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.InferenceComponentArn') as inference_component_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::InferenceComponent' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'InferenceComponentArn') as inference_component_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::InferenceComponent' - AND region = 'us-east-1' - inference_component: - name: inference_component - id: aws.sagemaker.inference_component - x-cfn-schema-name: InferenceComponent - x-cfn-type-name: AWS::SageMaker::InferenceComponent - x-identifiers: - - InferenceComponentArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -7876,12 +7768,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/inference_components/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/inference_components/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/inference_component/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/inference_components/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -7902,26 +7798,42 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'InferenceComponentArn') as inference_component_arn, - json_extract_path_text(Properties, 'InferenceComponentName') as inference_component_name, - json_extract_path_text(Properties, 'EndpointArn') as endpoint_arn, - json_extract_path_text(Properties, 'EndpointName') as endpoint_name, - json_extract_path_text(Properties, 'VariantName') as variant_name, - json_extract_path_text(Properties, 'FailureReason') as failure_reason, - json_extract_path_text(Properties, 'Specification') as specification, - json_extract_path_text(Properties, 'RuntimeConfig') as runtime_config, - json_extract_path_text(Properties, 'InferenceComponentStatus') as inference_component_status, - json_extract_path_text(Properties, 'CreationTime') as creation_time, - json_extract_path_text(Properties, 'LastModifiedTime') as last_modified_time, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::InferenceComponent' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.InferenceComponentArn') as inference_component_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::InferenceComponent' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'InferenceComponentArn') as inference_component_arn, + json_extract_path_text(Properties, 'InferenceComponentName') as inference_component_name, + json_extract_path_text(Properties, 'EndpointArn') as endpoint_arn, + json_extract_path_text(Properties, 'EndpointName') as endpoint_name, + json_extract_path_text(Properties, 'VariantName') as variant_name, + json_extract_path_text(Properties, 'FailureReason') as failure_reason, + json_extract_path_text(Properties, 'Specification') as specification, + json_extract_path_text(Properties, 'RuntimeConfig') as runtime_config, + json_extract_path_text(Properties, 'InferenceComponentStatus') as inference_component_status, + json_extract_path_text(Properties, 'CreationTime') as creation_time, + json_extract_path_text(Properties, 'LastModifiedTime') as last_modified_time, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::InferenceComponent' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'InferenceComponentArn') as inference_component_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::InferenceComponent' + AND region = 'us-east-1' inference_experiments: name: inference_experiments id: aws.sagemaker.inference_experiments @@ -7929,7 +7841,7 @@ components: x-cfn-type-name: AWS::SageMaker::InferenceExperiment x-identifiers: - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -7946,9 +7858,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -7958,41 +7870,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/inference_experiments/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/inference_experiments/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::InferenceExperiment' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::InferenceExperiment' - AND region = 'us-east-1' - inference_experiment: - name: inference_experiment - id: aws.sagemaker.inference_experiment - x-cfn-schema-name: InferenceExperiment - x-cfn-type-name: AWS::SageMaker::InferenceExperiment - x-identifiers: - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -8003,12 +7883,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/inference_experiments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/inference_experiments/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/inference_experiment/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/inference_experiments/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -8035,32 +7919,48 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Type') as type, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'EndpointName') as endpoint_name, - json_extract_path_text(Properties, 'EndpointMetadata') as endpoint_metadata, - json_extract_path_text(Properties, 'Schedule') as schedule, - json_extract_path_text(Properties, 'KmsKey') as kms_key, - json_extract_path_text(Properties, 'DataStorageConfig') as data_storage_config, - json_extract_path_text(Properties, 'ModelVariants') as model_variants, - json_extract_path_text(Properties, 'ShadowModeConfig') as shadow_mode_config, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'CreationTime') as creation_time, - json_extract_path_text(Properties, 'LastModifiedTime') as last_modified_time, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'StatusReason') as status_reason, - json_extract_path_text(Properties, 'DesiredState') as desired_state - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::InferenceExperiment' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::InferenceExperiment' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'EndpointName') as endpoint_name, + json_extract_path_text(Properties, 'EndpointMetadata') as endpoint_metadata, + json_extract_path_text(Properties, 'Schedule') as schedule, + json_extract_path_text(Properties, 'KmsKey') as kms_key, + json_extract_path_text(Properties, 'DataStorageConfig') as data_storage_config, + json_extract_path_text(Properties, 'ModelVariants') as model_variants, + json_extract_path_text(Properties, 'ShadowModeConfig') as shadow_mode_config, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'CreationTime') as creation_time, + json_extract_path_text(Properties, 'LastModifiedTime') as last_modified_time, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'StatusReason') as status_reason, + json_extract_path_text(Properties, 'DesiredState') as desired_state + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::InferenceExperiment' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::InferenceExperiment' + AND region = 'us-east-1' model_bias_job_definitions: name: model_bias_job_definitions id: aws.sagemaker.model_bias_job_definitions @@ -8068,7 +7968,7 @@ components: x-cfn-type-name: AWS::SageMaker::ModelBiasJobDefinition x-identifiers: - JobDefinitionArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -8102,39 +8002,11 @@ components: - $ref: '#/components/x-stackQL-resources/model_bias_job_definitions/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/model_bias_job_definitions/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.JobDefinitionArn') as job_definition_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::ModelBiasJobDefinition' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'JobDefinitionArn') as job_definition_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::ModelBiasJobDefinition' - AND region = 'us-east-1' - model_bias_job_definition: - name: model_bias_job_definition - id: aws.sagemaker.model_bias_job_definition - x-cfn-schema-name: ModelBiasJobDefinition - x-cfn-type-name: AWS::SageMaker::ModelBiasJobDefinition - x-identifiers: - - JobDefinitionArn - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -8156,27 +8028,43 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'JobDefinitionArn') as job_definition_arn, - json_extract_path_text(Properties, 'JobDefinitionName') as job_definition_name, - json_extract_path_text(Properties, 'ModelBiasBaselineConfig') as model_bias_baseline_config, - json_extract_path_text(Properties, 'ModelBiasAppSpecification') as model_bias_app_specification, - json_extract_path_text(Properties, 'ModelBiasJobInput') as model_bias_job_input, - json_extract_path_text(Properties, 'ModelBiasJobOutputConfig') as model_bias_job_output_config, - json_extract_path_text(Properties, 'JobResources') as job_resources, - json_extract_path_text(Properties, 'NetworkConfig') as network_config, - json_extract_path_text(Properties, 'EndpointName') as endpoint_name, - json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'StoppingCondition') as stopping_condition, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'CreationTime') as creation_time - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::ModelBiasJobDefinition' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.JobDefinitionArn') as job_definition_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::ModelBiasJobDefinition' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'JobDefinitionArn') as job_definition_arn, + json_extract_path_text(Properties, 'JobDefinitionName') as job_definition_name, + json_extract_path_text(Properties, 'ModelBiasBaselineConfig') as model_bias_baseline_config, + json_extract_path_text(Properties, 'ModelBiasAppSpecification') as model_bias_app_specification, + json_extract_path_text(Properties, 'ModelBiasJobInput') as model_bias_job_input, + json_extract_path_text(Properties, 'ModelBiasJobOutputConfig') as model_bias_job_output_config, + json_extract_path_text(Properties, 'JobResources') as job_resources, + json_extract_path_text(Properties, 'NetworkConfig') as network_config, + json_extract_path_text(Properties, 'EndpointName') as endpoint_name, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'StoppingCondition') as stopping_condition, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'CreationTime') as creation_time + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::ModelBiasJobDefinition' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'JobDefinitionArn') as job_definition_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::ModelBiasJobDefinition' + AND region = 'us-east-1' model_cards: name: model_cards id: aws.sagemaker.model_cards @@ -8184,7 +8072,7 @@ components: x-cfn-type-name: AWS::SageMaker::ModelCard x-identifiers: - ModelCardName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -8201,9 +8089,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -8213,41 +8101,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/model_cards/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/model_cards/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ModelCardName') as model_card_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::ModelCard' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ModelCardName') as model_card_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::ModelCard' - AND region = 'us-east-1' - model_card: - name: model_card - id: aws.sagemaker.model_card - x-cfn-schema-name: ModelCard - x-cfn-type-name: AWS::SageMaker::ModelCard - x-identifiers: - - ModelCardName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -8258,12 +8114,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/model_cards/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/model_cards/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/model_card/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/model_cards/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -8284,26 +8144,42 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ModelCardArn') as model_card_arn, - json_extract_path_text(Properties, 'ModelCardVersion') as model_card_version, - json_extract_path_text(Properties, 'ModelCardName') as model_card_name, - json_extract_path_text(Properties, 'SecurityConfig') as security_config, - json_extract_path_text(Properties, 'ModelCardStatus') as model_card_status, - json_extract_path_text(Properties, 'Content') as content, - json_extract_path_text(Properties, 'CreationTime') as creation_time, - json_extract_path_text(Properties, 'CreatedBy') as created_by, - json_extract_path_text(Properties, 'LastModifiedTime') as last_modified_time, - json_extract_path_text(Properties, 'LastModifiedBy') as last_modified_by, - json_extract_path_text(Properties, 'ModelCardProcessingStatus') as model_card_processing_status, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::ModelCard' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ModelCardName') as model_card_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::ModelCard' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ModelCardArn') as model_card_arn, + json_extract_path_text(Properties, 'ModelCardVersion') as model_card_version, + json_extract_path_text(Properties, 'ModelCardName') as model_card_name, + json_extract_path_text(Properties, 'SecurityConfig') as security_config, + json_extract_path_text(Properties, 'ModelCardStatus') as model_card_status, + json_extract_path_text(Properties, 'Content') as content, + json_extract_path_text(Properties, 'CreationTime') as creation_time, + json_extract_path_text(Properties, 'CreatedBy') as created_by, + json_extract_path_text(Properties, 'LastModifiedTime') as last_modified_time, + json_extract_path_text(Properties, 'LastModifiedBy') as last_modified_by, + json_extract_path_text(Properties, 'ModelCardProcessingStatus') as model_card_processing_status, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::ModelCard' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ModelCardName') as model_card_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::ModelCard' + AND region = 'us-east-1' model_explainability_job_definitions: name: model_explainability_job_definitions id: aws.sagemaker.model_explainability_job_definitions @@ -8311,7 +8187,7 @@ components: x-cfn-type-name: AWS::SageMaker::ModelExplainabilityJobDefinition x-identifiers: - JobDefinitionArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -8345,39 +8221,11 @@ components: - $ref: '#/components/x-stackQL-resources/model_explainability_job_definitions/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/model_explainability_job_definitions/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.JobDefinitionArn') as job_definition_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::ModelExplainabilityJobDefinition' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'JobDefinitionArn') as job_definition_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::ModelExplainabilityJobDefinition' - AND region = 'us-east-1' - model_explainability_job_definition: - name: model_explainability_job_definition - id: aws.sagemaker.model_explainability_job_definition - x-cfn-schema-name: ModelExplainabilityJobDefinition - x-cfn-type-name: AWS::SageMaker::ModelExplainabilityJobDefinition - x-identifiers: - - JobDefinitionArn - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -8399,27 +8247,43 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'JobDefinitionArn') as job_definition_arn, - json_extract_path_text(Properties, 'JobDefinitionName') as job_definition_name, - json_extract_path_text(Properties, 'ModelExplainabilityBaselineConfig') as model_explainability_baseline_config, - json_extract_path_text(Properties, 'ModelExplainabilityAppSpecification') as model_explainability_app_specification, - json_extract_path_text(Properties, 'ModelExplainabilityJobInput') as model_explainability_job_input, - json_extract_path_text(Properties, 'ModelExplainabilityJobOutputConfig') as model_explainability_job_output_config, - json_extract_path_text(Properties, 'JobResources') as job_resources, - json_extract_path_text(Properties, 'NetworkConfig') as network_config, - json_extract_path_text(Properties, 'EndpointName') as endpoint_name, - json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'StoppingCondition') as stopping_condition, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'CreationTime') as creation_time - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::ModelExplainabilityJobDefinition' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.JobDefinitionArn') as job_definition_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::ModelExplainabilityJobDefinition' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'JobDefinitionArn') as job_definition_arn, + json_extract_path_text(Properties, 'JobDefinitionName') as job_definition_name, + json_extract_path_text(Properties, 'ModelExplainabilityBaselineConfig') as model_explainability_baseline_config, + json_extract_path_text(Properties, 'ModelExplainabilityAppSpecification') as model_explainability_app_specification, + json_extract_path_text(Properties, 'ModelExplainabilityJobInput') as model_explainability_job_input, + json_extract_path_text(Properties, 'ModelExplainabilityJobOutputConfig') as model_explainability_job_output_config, + json_extract_path_text(Properties, 'JobResources') as job_resources, + json_extract_path_text(Properties, 'NetworkConfig') as network_config, + json_extract_path_text(Properties, 'EndpointName') as endpoint_name, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'StoppingCondition') as stopping_condition, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'CreationTime') as creation_time + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::ModelExplainabilityJobDefinition' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'JobDefinitionArn') as job_definition_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::ModelExplainabilityJobDefinition' + AND region = 'us-east-1' model_packages: name: model_packages id: aws.sagemaker.model_packages @@ -8427,7 +8291,7 @@ components: x-cfn-type-name: AWS::SageMaker::ModelPackage x-identifiers: - ModelPackageArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -8444,9 +8308,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -8456,41 +8320,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/model_packages/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/model_packages/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ModelPackageArn') as model_package_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::ModelPackage' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ModelPackageArn') as model_package_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::ModelPackage' - AND region = 'us-east-1' - model_package: - name: model_package - id: aws.sagemaker.model_package - x-cfn-schema-name: ModelPackage - x-cfn-type-name: AWS::SageMaker::ModelPackage - x-identifiers: - - ModelPackageArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -8501,12 +8333,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/model_packages/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/model_packages/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/model_package/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/model_packages/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -8542,41 +8378,57 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'AdditionalInferenceSpecifications') as additional_inference_specifications, - json_extract_path_text(Properties, 'CertifyForMarketplace') as certify_for_marketplace, - json_extract_path_text(Properties, 'ClientToken') as client_token, - json_extract_path_text(Properties, 'CustomerMetadataProperties') as customer_metadata_properties, - json_extract_path_text(Properties, 'Domain') as domain, - json_extract_path_text(Properties, 'DriftCheckBaselines') as drift_check_baselines, - json_extract_path_text(Properties, 'InferenceSpecification') as inference_specification, - json_extract_path_text(Properties, 'MetadataProperties') as metadata_properties, - json_extract_path_text(Properties, 'ModelApprovalStatus') as model_approval_status, - json_extract_path_text(Properties, 'ModelMetrics') as model_metrics, - json_extract_path_text(Properties, 'ModelPackageDescription') as model_package_description, - json_extract_path_text(Properties, 'ModelPackageGroupName') as model_package_group_name, - json_extract_path_text(Properties, 'ModelPackageName') as model_package_name, - json_extract_path_text(Properties, 'SamplePayloadUrl') as sample_payload_url, - json_extract_path_text(Properties, 'SkipModelValidation') as skip_model_validation, - json_extract_path_text(Properties, 'SourceAlgorithmSpecification') as source_algorithm_specification, - json_extract_path_text(Properties, 'Task') as task, - json_extract_path_text(Properties, 'ValidationSpecification') as validation_specification, - json_extract_path_text(Properties, 'ModelPackageArn') as model_package_arn, - json_extract_path_text(Properties, 'ApprovalDescription') as approval_description, - json_extract_path_text(Properties, 'CreationTime') as creation_time, - json_extract_path_text(Properties, 'LastModifiedTime') as last_modified_time, - json_extract_path_text(Properties, 'ModelPackageStatus') as model_package_status, - json_extract_path_text(Properties, 'ModelPackageVersion') as model_package_version, - json_extract_path_text(Properties, 'AdditionalInferenceSpecificationsToAdd') as additional_inference_specifications_to_add, - json_extract_path_text(Properties, 'ModelPackageStatusDetails') as model_package_status_details - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::ModelPackage' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ModelPackageArn') as model_package_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::ModelPackage' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'AdditionalInferenceSpecifications') as additional_inference_specifications, + json_extract_path_text(Properties, 'CertifyForMarketplace') as certify_for_marketplace, + json_extract_path_text(Properties, 'ClientToken') as client_token, + json_extract_path_text(Properties, 'CustomerMetadataProperties') as customer_metadata_properties, + json_extract_path_text(Properties, 'Domain') as domain, + json_extract_path_text(Properties, 'DriftCheckBaselines') as drift_check_baselines, + json_extract_path_text(Properties, 'InferenceSpecification') as inference_specification, + json_extract_path_text(Properties, 'MetadataProperties') as metadata_properties, + json_extract_path_text(Properties, 'ModelApprovalStatus') as model_approval_status, + json_extract_path_text(Properties, 'ModelMetrics') as model_metrics, + json_extract_path_text(Properties, 'ModelPackageDescription') as model_package_description, + json_extract_path_text(Properties, 'ModelPackageGroupName') as model_package_group_name, + json_extract_path_text(Properties, 'ModelPackageName') as model_package_name, + json_extract_path_text(Properties, 'SamplePayloadUrl') as sample_payload_url, + json_extract_path_text(Properties, 'SkipModelValidation') as skip_model_validation, + json_extract_path_text(Properties, 'SourceAlgorithmSpecification') as source_algorithm_specification, + json_extract_path_text(Properties, 'Task') as task, + json_extract_path_text(Properties, 'ValidationSpecification') as validation_specification, + json_extract_path_text(Properties, 'ModelPackageArn') as model_package_arn, + json_extract_path_text(Properties, 'ApprovalDescription') as approval_description, + json_extract_path_text(Properties, 'CreationTime') as creation_time, + json_extract_path_text(Properties, 'LastModifiedTime') as last_modified_time, + json_extract_path_text(Properties, 'ModelPackageStatus') as model_package_status, + json_extract_path_text(Properties, 'ModelPackageVersion') as model_package_version, + json_extract_path_text(Properties, 'AdditionalInferenceSpecificationsToAdd') as additional_inference_specifications_to_add, + json_extract_path_text(Properties, 'ModelPackageStatusDetails') as model_package_status_details + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::ModelPackage' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ModelPackageArn') as model_package_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::ModelPackage' + AND region = 'us-east-1' model_package_groups: name: model_package_groups id: aws.sagemaker.model_package_groups @@ -8584,7 +8436,7 @@ components: x-cfn-type-name: AWS::SageMaker::ModelPackageGroup x-identifiers: - ModelPackageGroupArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -8601,9 +8453,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -8613,41 +8465,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/model_package_groups/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/model_package_groups/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ModelPackageGroupArn') as model_package_group_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::ModelPackageGroup' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ModelPackageGroupArn') as model_package_group_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::ModelPackageGroup' - AND region = 'us-east-1' - model_package_group: - name: model_package_group - id: aws.sagemaker.model_package_group - x-cfn-schema-name: ModelPackageGroup - x-cfn-type-name: AWS::SageMaker::ModelPackageGroup - x-identifiers: - - ModelPackageGroupArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -8658,12 +8478,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/model_package_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/model_package_groups/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/model_package_group/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/model_package_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -8679,21 +8503,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'ModelPackageGroupArn') as model_package_group_arn, - json_extract_path_text(Properties, 'ModelPackageGroupName') as model_package_group_name, - json_extract_path_text(Properties, 'ModelPackageGroupDescription') as model_package_group_description, - json_extract_path_text(Properties, 'ModelPackageGroupPolicy') as model_package_group_policy, - json_extract_path_text(Properties, 'CreationTime') as creation_time, - json_extract_path_text(Properties, 'ModelPackageGroupStatus') as model_package_group_status - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::ModelPackageGroup' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ModelPackageGroupArn') as model_package_group_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::ModelPackageGroup' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'ModelPackageGroupArn') as model_package_group_arn, + json_extract_path_text(Properties, 'ModelPackageGroupName') as model_package_group_name, + json_extract_path_text(Properties, 'ModelPackageGroupDescription') as model_package_group_description, + json_extract_path_text(Properties, 'ModelPackageGroupPolicy') as model_package_group_policy, + json_extract_path_text(Properties, 'CreationTime') as creation_time, + json_extract_path_text(Properties, 'ModelPackageGroupStatus') as model_package_group_status + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::ModelPackageGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ModelPackageGroupArn') as model_package_group_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::ModelPackageGroup' + AND region = 'us-east-1' model_quality_job_definitions: name: model_quality_job_definitions id: aws.sagemaker.model_quality_job_definitions @@ -8701,7 +8541,7 @@ components: x-cfn-type-name: AWS::SageMaker::ModelQualityJobDefinition x-identifiers: - JobDefinitionArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -8735,39 +8575,11 @@ components: - $ref: '#/components/x-stackQL-resources/model_quality_job_definitions/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/model_quality_job_definitions/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.JobDefinitionArn') as job_definition_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::ModelQualityJobDefinition' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'JobDefinitionArn') as job_definition_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::ModelQualityJobDefinition' - AND region = 'us-east-1' - model_quality_job_definition: - name: model_quality_job_definition - id: aws.sagemaker.model_quality_job_definition - x-cfn-schema-name: ModelQualityJobDefinition - x-cfn-type-name: AWS::SageMaker::ModelQualityJobDefinition - x-identifiers: - - JobDefinitionArn - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -8789,27 +8601,43 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'JobDefinitionArn') as job_definition_arn, - json_extract_path_text(Properties, 'JobDefinitionName') as job_definition_name, - json_extract_path_text(Properties, 'ModelQualityBaselineConfig') as model_quality_baseline_config, - json_extract_path_text(Properties, 'ModelQualityAppSpecification') as model_quality_app_specification, - json_extract_path_text(Properties, 'ModelQualityJobInput') as model_quality_job_input, - json_extract_path_text(Properties, 'ModelQualityJobOutputConfig') as model_quality_job_output_config, - json_extract_path_text(Properties, 'JobResources') as job_resources, - json_extract_path_text(Properties, 'NetworkConfig') as network_config, - json_extract_path_text(Properties, 'EndpointName') as endpoint_name, - json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'StoppingCondition') as stopping_condition, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'CreationTime') as creation_time - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::ModelQualityJobDefinition' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.JobDefinitionArn') as job_definition_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::ModelQualityJobDefinition' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'JobDefinitionArn') as job_definition_arn, + json_extract_path_text(Properties, 'JobDefinitionName') as job_definition_name, + json_extract_path_text(Properties, 'ModelQualityBaselineConfig') as model_quality_baseline_config, + json_extract_path_text(Properties, 'ModelQualityAppSpecification') as model_quality_app_specification, + json_extract_path_text(Properties, 'ModelQualityJobInput') as model_quality_job_input, + json_extract_path_text(Properties, 'ModelQualityJobOutputConfig') as model_quality_job_output_config, + json_extract_path_text(Properties, 'JobResources') as job_resources, + json_extract_path_text(Properties, 'NetworkConfig') as network_config, + json_extract_path_text(Properties, 'EndpointName') as endpoint_name, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'StoppingCondition') as stopping_condition, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'CreationTime') as creation_time + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::ModelQualityJobDefinition' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'JobDefinitionArn') as job_definition_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::ModelQualityJobDefinition' + AND region = 'us-east-1' monitoring_schedules: name: monitoring_schedules id: aws.sagemaker.monitoring_schedules @@ -8817,7 +8645,7 @@ components: x-cfn-type-name: AWS::SageMaker::MonitoringSchedule x-identifiers: - MonitoringScheduleArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -8834,9 +8662,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -8846,41 +8674,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/monitoring_schedules/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/monitoring_schedules/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.MonitoringScheduleArn') as monitoring_schedule_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::MonitoringSchedule' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'MonitoringScheduleArn') as monitoring_schedule_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::MonitoringSchedule' - AND region = 'us-east-1' - monitoring_schedule: - name: monitoring_schedule - id: aws.sagemaker.monitoring_schedule - x-cfn-schema-name: MonitoringSchedule - x-cfn-type-name: AWS::SageMaker::MonitoringSchedule - x-identifiers: - - MonitoringScheduleArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -8891,12 +8687,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/monitoring_schedules/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/monitoring_schedules/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/monitoring_schedule/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/monitoring_schedules/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -8915,24 +8715,40 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'MonitoringScheduleArn') as monitoring_schedule_arn, - json_extract_path_text(Properties, 'MonitoringScheduleName') as monitoring_schedule_name, - json_extract_path_text(Properties, 'MonitoringScheduleConfig') as monitoring_schedule_config, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'CreationTime') as creation_time, - json_extract_path_text(Properties, 'EndpointName') as endpoint_name, - json_extract_path_text(Properties, 'FailureReason') as failure_reason, - json_extract_path_text(Properties, 'LastModifiedTime') as last_modified_time, - json_extract_path_text(Properties, 'LastMonitoringExecutionSummary') as last_monitoring_execution_summary, - json_extract_path_text(Properties, 'MonitoringScheduleStatus') as monitoring_schedule_status - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::MonitoringSchedule' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.MonitoringScheduleArn') as monitoring_schedule_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::MonitoringSchedule' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'MonitoringScheduleArn') as monitoring_schedule_arn, + json_extract_path_text(Properties, 'MonitoringScheduleName') as monitoring_schedule_name, + json_extract_path_text(Properties, 'MonitoringScheduleConfig') as monitoring_schedule_config, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'CreationTime') as creation_time, + json_extract_path_text(Properties, 'EndpointName') as endpoint_name, + json_extract_path_text(Properties, 'FailureReason') as failure_reason, + json_extract_path_text(Properties, 'LastModifiedTime') as last_modified_time, + json_extract_path_text(Properties, 'LastMonitoringExecutionSummary') as last_monitoring_execution_summary, + json_extract_path_text(Properties, 'MonitoringScheduleStatus') as monitoring_schedule_status + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::MonitoringSchedule' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'MonitoringScheduleArn') as monitoring_schedule_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::MonitoringSchedule' + AND region = 'us-east-1' pipelines: name: pipelines id: aws.sagemaker.pipelines @@ -8940,7 +8756,7 @@ components: x-cfn-type-name: AWS::SageMaker::Pipeline x-identifiers: - PipelineName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -8957,9 +8773,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -8969,41 +8785,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/pipelines/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/pipelines/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.PipelineName') as pipeline_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::Pipeline' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'PipelineName') as pipeline_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::Pipeline' - AND region = 'us-east-1' - pipeline: - name: pipeline - id: aws.sagemaker.pipeline - x-cfn-schema-name: Pipeline - x-cfn-type-name: AWS::SageMaker::Pipeline - x-identifiers: - - PipelineName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -9014,12 +8798,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/pipelines/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/pipelines/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/pipeline/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/pipelines/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -9035,21 +8823,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'PipelineName') as pipeline_name, - json_extract_path_text(Properties, 'PipelineDisplayName') as pipeline_display_name, - json_extract_path_text(Properties, 'PipelineDescription') as pipeline_description, - json_extract_path_text(Properties, 'PipelineDefinition') as pipeline_definition, - json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'ParallelismConfiguration') as parallelism_configuration - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::Pipeline' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.PipelineName') as pipeline_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::Pipeline' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'PipelineName') as pipeline_name, + json_extract_path_text(Properties, 'PipelineDisplayName') as pipeline_display_name, + json_extract_path_text(Properties, 'PipelineDescription') as pipeline_description, + json_extract_path_text(Properties, 'PipelineDefinition') as pipeline_definition, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'ParallelismConfiguration') as parallelism_configuration + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::Pipeline' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'PipelineName') as pipeline_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::Pipeline' + AND region = 'us-east-1' projects: name: projects id: aws.sagemaker.projects @@ -9057,7 +8861,7 @@ components: x-cfn-type-name: AWS::SageMaker::Project x-identifiers: - ProjectArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -9074,9 +8878,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -9086,41 +8890,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/projects/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/projects/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ProjectArn') as project_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::Project' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ProjectArn') as project_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::Project' - AND region = 'us-east-1' - project: - name: project - id: aws.sagemaker.project - x-cfn-schema-name: Project - x-cfn-type-name: AWS::SageMaker::Project - x-identifiers: - - ProjectArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -9131,12 +8903,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/projects/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/projects/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/project/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/projects/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -9154,23 +8930,39 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'ProjectArn') as project_arn, - json_extract_path_text(Properties, 'ProjectId') as project_id, - json_extract_path_text(Properties, 'ProjectName') as project_name, - json_extract_path_text(Properties, 'ProjectDescription') as project_description, - json_extract_path_text(Properties, 'CreationTime') as creation_time, - json_extract_path_text(Properties, 'ServiceCatalogProvisioningDetails') as service_catalog_provisioning_details, - json_extract_path_text(Properties, 'ServiceCatalogProvisionedProductDetails') as service_catalog_provisioned_product_details, - json_extract_path_text(Properties, 'ProjectStatus') as project_status - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::Project' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ProjectArn') as project_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::Project' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'ProjectArn') as project_arn, + json_extract_path_text(Properties, 'ProjectId') as project_id, + json_extract_path_text(Properties, 'ProjectName') as project_name, + json_extract_path_text(Properties, 'ProjectDescription') as project_description, + json_extract_path_text(Properties, 'CreationTime') as creation_time, + json_extract_path_text(Properties, 'ServiceCatalogProvisioningDetails') as service_catalog_provisioning_details, + json_extract_path_text(Properties, 'ServiceCatalogProvisionedProductDetails') as service_catalog_provisioned_product_details, + json_extract_path_text(Properties, 'ProjectStatus') as project_status + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::Project' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ProjectArn') as project_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::Project' + AND region = 'us-east-1' spaces: name: spaces id: aws.sagemaker.spaces @@ -9179,7 +8971,7 @@ components: x-identifiers: - DomainId - SpaceName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -9196,9 +8988,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -9208,44 +9000,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/spaces/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/spaces/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.DomainId') as domain_id, - JSON_EXTRACT(Properties, '$.SpaceName') as space_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::Space' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'DomainId') as domain_id, - json_extract_path_text(Properties, 'SpaceName') as space_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::Space' - AND region = 'us-east-1' - space: - name: space - id: aws.sagemaker.space - x-cfn-schema-name: Space - x-cfn-type-name: AWS::SageMaker::Space - x-identifiers: - - DomainId - - SpaceName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -9256,12 +9013,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/spaces/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/spaces/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/space/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/spaces/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -9279,23 +9040,41 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'SpaceArn') as space_arn, - json_extract_path_text(Properties, 'DomainId') as domain_id, - json_extract_path_text(Properties, 'SpaceName') as space_name, - json_extract_path_text(Properties, 'SpaceSettings') as space_settings, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'OwnershipSettings') as ownership_settings, - json_extract_path_text(Properties, 'SpaceSharingSettings') as space_sharing_settings, - json_extract_path_text(Properties, 'SpaceDisplayName') as space_display_name, - json_extract_path_text(Properties, 'Url') as url - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::Space' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.DomainId') as domain_id, + JSON_EXTRACT(Properties, '$.SpaceName') as space_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::Space' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'SpaceArn') as space_arn, + json_extract_path_text(Properties, 'DomainId') as domain_id, + json_extract_path_text(Properties, 'SpaceName') as space_name, + json_extract_path_text(Properties, 'SpaceSettings') as space_settings, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'OwnershipSettings') as ownership_settings, + json_extract_path_text(Properties, 'SpaceSharingSettings') as space_sharing_settings, + json_extract_path_text(Properties, 'SpaceDisplayName') as space_display_name, + json_extract_path_text(Properties, 'Url') as url + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::Space' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DomainId') as domain_id, + json_extract_path_text(Properties, 'SpaceName') as space_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::Space' + AND region = 'us-east-1' user_profiles: name: user_profiles id: aws.sagemaker.user_profiles @@ -9304,7 +9083,7 @@ components: x-identifiers: - UserProfileName - DomainId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -9321,9 +9100,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -9333,44 +9112,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/user_profiles/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/user_profiles/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.UserProfileName') as user_profile_name, - JSON_EXTRACT(Properties, '$.DomainId') as domain_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::UserProfile' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'UserProfileName') as user_profile_name, - json_extract_path_text(Properties, 'DomainId') as domain_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::UserProfile' - AND region = 'us-east-1' - user_profile: - name: user_profile - id: aws.sagemaker.user_profile - x-cfn-schema-name: UserProfile - x-cfn-type-name: AWS::SageMaker::UserProfile - x-identifiers: - - UserProfileName - - DomainId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -9381,12 +9125,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/user_profiles/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/user_profiles/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/user_profile/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/user_profiles/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -9402,21 +9150,39 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'UserProfileArn') as user_profile_arn, - json_extract_path_text(Properties, 'DomainId') as domain_id, - json_extract_path_text(Properties, 'SingleSignOnUserIdentifier') as single_sign_on_user_identifier, - json_extract_path_text(Properties, 'SingleSignOnUserValue') as single_sign_on_user_value, - json_extract_path_text(Properties, 'UserProfileName') as user_profile_name, - json_extract_path_text(Properties, 'UserSettings') as user_settings, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::UserProfile' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.UserProfileName') as user_profile_name, + JSON_EXTRACT(Properties, '$.DomainId') as domain_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::UserProfile' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'UserProfileArn') as user_profile_arn, + json_extract_path_text(Properties, 'DomainId') as domain_id, + json_extract_path_text(Properties, 'SingleSignOnUserIdentifier') as single_sign_on_user_identifier, + json_extract_path_text(Properties, 'SingleSignOnUserValue') as single_sign_on_user_value, + json_extract_path_text(Properties, 'UserProfileName') as user_profile_name, + json_extract_path_text(Properties, 'UserSettings') as user_settings, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SageMaker::UserProfile' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'UserProfileName') as user_profile_name, + json_extract_path_text(Properties, 'DomainId') as domain_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SageMaker::UserProfile' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/scheduler.yaml b/providers/src/aws/v00.00.00000/services/scheduler.yaml index c4a31d67..887f7ba5 100644 --- a/providers/src/aws/v00.00.00000/services/scheduler.yaml +++ b/providers/src/aws/v00.00.00000/services/scheduler.yaml @@ -1061,7 +1061,7 @@ components: x-cfn-type-name: AWS::Scheduler::Schedule x-identifiers: - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1078,9 +1078,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1090,41 +1090,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/schedules/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/schedules/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Scheduler::Schedule' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Scheduler::Schedule' - AND region = 'us-east-1' - schedule: - name: schedule - id: aws.scheduler.schedule - x-cfn-schema-name: Schedule - x-cfn-type-name: AWS::Scheduler::Schedule - x-identifiers: - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1135,12 +1103,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/schedules/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/schedules/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/schedule/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/schedules/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1161,26 +1133,42 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'EndDate') as end_date, - json_extract_path_text(Properties, 'FlexibleTimeWindow') as flexible_time_window, - json_extract_path_text(Properties, 'GroupName') as group_name, - json_extract_path_text(Properties, 'KmsKeyArn') as kms_key_arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'ScheduleExpression') as schedule_expression, - json_extract_path_text(Properties, 'ScheduleExpressionTimezone') as schedule_expression_timezone, - json_extract_path_text(Properties, 'StartDate') as start_date, - json_extract_path_text(Properties, 'State') as state, - json_extract_path_text(Properties, 'Target') as target - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Scheduler::Schedule' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Scheduler::Schedule' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'EndDate') as end_date, + json_extract_path_text(Properties, 'FlexibleTimeWindow') as flexible_time_window, + json_extract_path_text(Properties, 'GroupName') as group_name, + json_extract_path_text(Properties, 'KmsKeyArn') as kms_key_arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'ScheduleExpression') as schedule_expression, + json_extract_path_text(Properties, 'ScheduleExpressionTimezone') as schedule_expression_timezone, + json_extract_path_text(Properties, 'StartDate') as start_date, + json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'Target') as target + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Scheduler::Schedule' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Scheduler::Schedule' + AND region = 'us-east-1' schedule_groups: name: schedule_groups id: aws.scheduler.schedule_groups @@ -1188,7 +1176,7 @@ components: x-cfn-type-name: AWS::Scheduler::ScheduleGroup x-identifiers: - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1205,9 +1193,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1217,41 +1205,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/schedule_groups/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/schedule_groups/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Scheduler::ScheduleGroup' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Scheduler::ScheduleGroup' - AND region = 'us-east-1' - schedule_group: - name: schedule_group - id: aws.scheduler.schedule_group - x-cfn-schema-name: ScheduleGroup - x-cfn-type-name: AWS::Scheduler::ScheduleGroup - x-identifiers: - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1262,12 +1218,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/schedule_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/schedule_groups/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/schedule_group/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/schedule_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1282,20 +1242,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'CreationDate') as creation_date, - json_extract_path_text(Properties, 'LastModificationDate') as last_modification_date, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'State') as state, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Scheduler::ScheduleGroup' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Scheduler::ScheduleGroup' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'CreationDate') as creation_date, + json_extract_path_text(Properties, 'LastModificationDate') as last_modification_date, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Scheduler::ScheduleGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Scheduler::ScheduleGroup' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/secretsmanager.yaml b/providers/src/aws/v00.00.00000/services/secretsmanager.yaml index e7ddf459..62b62675 100644 --- a/providers/src/aws/v00.00.00000/services/secretsmanager.yaml +++ b/providers/src/aws/v00.00.00000/services/secretsmanager.yaml @@ -639,7 +639,7 @@ components: x-cfn-type-name: AWS::SecretsManager::Secret x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -656,9 +656,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -668,41 +668,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/secrets/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/secrets/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SecretsManager::Secret' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SecretsManager::Secret' - AND region = 'us-east-1' - secret: - name: secret - id: aws.secretsmanager.secret - x-cfn-schema-name: Secret - x-cfn-type-name: AWS::SecretsManager::Secret - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -713,12 +681,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/secrets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/secrets/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/secret/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/secrets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -735,22 +707,38 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, - json_extract_path_text(Properties, 'SecretString') as secret_string, - json_extract_path_text(Properties, 'GenerateSecretString') as generate_secret_string, - json_extract_path_text(Properties, 'ReplicaRegions') as replica_regions, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SecretsManager::Secret' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SecretsManager::Secret' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, + json_extract_path_text(Properties, 'SecretString') as secret_string, + json_extract_path_text(Properties, 'GenerateSecretString') as generate_secret_string, + json_extract_path_text(Properties, 'ReplicaRegions') as replica_regions, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SecretsManager::Secret' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SecretsManager::Secret' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/securityhub.yaml b/providers/src/aws/v00.00.00000/services/securityhub.yaml index 79091e29..3eab420e 100644 --- a/providers/src/aws/v00.00.00000/services/securityhub.yaml +++ b/providers/src/aws/v00.00.00000/services/securityhub.yaml @@ -396,9 +396,8 @@ components: minLength: 0 maxLength: 256 NonEmptyString: - description: Non-empty string definition. type: string - minLength: 1 + pattern: .*\S.* DateFilter: description: A date filter for querying findings. properties: @@ -939,7 +938,7 @@ components: taggable: true tagOnCreate: true tagUpdatable: true - cloudFormationSystemTags: true + cloudFormationSystemTags: false tagProperty: /properties/Tags x-required-permissions: create: @@ -961,6 +960,214 @@ components: list: - securityhub:ListAutomationRules - securityhub:ListTagsForResource + ParameterValue: + type: object + properties: + Boolean: + description: A control parameter that is a boolean. + type: boolean + Double: + description: A control parameter that is a double. + type: number + Enum: + description: A control parameter that is a enum. + $ref: '#/components/schemas/NonEmptyString' + EnumList: + description: A control parameter that is a list of enums. + $ref: '#/components/schemas/NonEmptyStringList' + Integer: + description: A control parameter that is a integer. + type: integer + IntegerList: + description: A control parameter that is a list of integers. + $ref: '#/components/schemas/IntegerList' + String: + description: A control parameter that is a string. + $ref: '#/components/schemas/NonEmptyString' + StringList: + description: A control parameter that is a list of strings. + $ref: '#/components/schemas/NonEmptyStringList' + oneOf: + - required: + - Boolean + - required: + - Double + - required: + - Enum + - required: + - EnumList + - required: + - Integer + - required: + - IntegerList + - required: + - String + - required: + - StringList + additionalProperties: false + ParameterConfiguration: + type: object + properties: + ValueType: + type: string + enum: + - DEFAULT + - CUSTOM + Value: + $ref: '#/components/schemas/ParameterValue' + additionalProperties: false + required: + - ValueType + SecurityControlCustomParameter: + type: object + additionalProperties: false + description: An object of security control and control parameter value that are included in a configuration policy. + properties: + Parameters: + type: object + minProperties: 1 + description: An object that specifies parameter values for a control in a configuration policy. + additionalProperties: false + x-patternProperties: + ^[-_+=.:/@\w\s]{1,128}$: + $ref: '#/components/schemas/ParameterConfiguration' + SecurityControlId: + type: string + description: The ID of the security control. + maxLength: 2048 + SecurityControlsConfiguration: + type: object + description: An object that defines which security controls are enabled in an AWS Security Hub configuration policy. + additionalProperties: false + properties: + DisabledSecurityControlIdentifiers: + type: array + description: A list of security controls that are disabled in the configuration policy + maxItems: 1000 + x-insertionOrder: true + uniqueItems: true + items: + type: string + maxLength: 2048 + EnabledSecurityControlIdentifiers: + type: array + description: A list of security controls that are enabled in the configuration policy. + maxItems: 1000 + x-insertionOrder: true + uniqueItems: true + items: + type: string + maxLength: 2048 + SecurityControlCustomParameters: + type: array + description: A list of security controls and control parameter values that are included in a configuration policy. + maxItems: 1000 + x-insertionOrder: true + uniqueItems: true + items: + $ref: '#/components/schemas/SecurityControlCustomParameter' + SecurityHubPolicy: + type: object + description: An object that defines how AWS Security Hub is configured. + additionalProperties: false + properties: + EnabledStandardIdentifiers: + type: array + description: A list that defines which security standards are enabled in the configuration policy. + maxItems: 1000 + x-insertionOrder: true + uniqueItems: true + items: + type: string + maxLength: 2048 + ServiceEnabled: + description: Indicates whether Security Hub is enabled in the policy. + type: boolean + SecurityControlsConfiguration: + $ref: '#/components/schemas/SecurityControlsConfiguration' + Policy: + description: An object that defines how Security Hub is configured. + type: object + additionalProperties: false + properties: + SecurityHub: + $ref: '#/components/schemas/SecurityHubPolicy' + ConfigurationPolicy: + type: object + properties: + Arn: + description: The Amazon Resource Name (ARN) of the configuration policy. + type: string + pattern: ^arn:aws\S*:securityhub:[a-z0-9-]+:[0-9]{12}:configuration-policy/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ + Name: + description: The name of the configuration policy. + type: string + minLength: 1 + maxLength: 128 + Description: + description: The description of the configuration policy. + type: string + minLength: 0 + maxLength: 512 + ConfigurationPolicy: + $ref: '#/components/schemas/Policy' + Id: + description: The universally unique identifier (UUID) of the configuration policy. + type: string + pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ + CreatedAt: + description: The date and time, in UTC and ISO 8601 format. + type: string + UpdatedAt: + description: The date and time, in UTC and ISO 8601 format. + type: string + ServiceEnabled: + type: boolean + description: Indicates whether the service that the configuration policy applies to is enabled in the policy. + Tags: + $ref: '#/components/schemas/Tags' + required: + - ConfigurationPolicy + - Name + x-stackql-resource-name: configuration_policy + description: The AWS::SecurityHub::ConfigurationPolicy resource represents the Central Configuration Policy in your account. + x-type-name: AWS::SecurityHub::ConfigurationPolicy + x-stackql-primary-identifier: + - Arn + x-read-only-properties: + - Arn + - Id + - CreatedAt + - UpdatedAt + - ServiceEnabled + x-required-properties: + - ConfigurationPolicy + - Name + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags + x-required-permissions: + create: + - securityhub:CreateConfigurationPolicy + - securityhub:TagResource + - securityhub:ListTagsForResource + read: + - securityhub:GetConfigurationPolicy + - securityhub:ListTagsForResource + update: + - securityhub:UpdateConfigurationPolicy + - securityhub:TagResource + - securityhub:UntagResource + - securityhub:ListTagsForResource + delete: + - securityhub:GetConfigurationPolicy + - securityhub:DeleteConfigurationPolicy + list: + - securityhub:ListConfigurationPolicies + - securityhub:ListTagsForResource DelegatedAdmin: type: object properties: @@ -1013,6 +1220,60 @@ components: list: - securityhub:ListOrganizationAdminAccounts - organizations:DescribeOrganization + Region: + type: string + pattern: ^[a-zA-Z0-9-]{1,32}$ + FindingAggregator: + type: object + properties: + FindingAggregatorArn: + description: The ARN of the FindingAggregator being created and assigned as the unique identifier + type: string + pattern: arn:aws\S*:securityhub:\S* + RegionLinkingMode: + description: Indicates whether to link all Regions, all Regions except for a list of excluded Regions, or a list of included Regions + type: string + enum: + - ALL_REGIONS + - ALL_REGIONS_EXCEPT_SPECIFIED + - SPECIFIED_REGIONS + Regions: + description: The list of excluded Regions or included Regions + type: array + x-insertionOrder: false + uniqueItems: true + minItems: 1 + maxItems: 50 + items: + $ref: '#/components/schemas/Region' + FindingAggregationRegion: + description: The aggregation Region of the FindingAggregator + $ref: '#/components/schemas/Region' + required: + - RegionLinkingMode + x-stackql-resource-name: finding_aggregator + description: The AWS::SecurityHub::FindingAggregator resource represents the AWS Security Hub Finding Aggregator in your account. One finding aggregator resource is created for each account in non opt-in region in which you configure region linking mode. + x-type-name: AWS::SecurityHub::FindingAggregator + x-stackql-primary-identifier: + - FindingAggregatorArn + x-read-only-properties: + - FindingAggregatorArn + - FindingAggregationRegion + x-required-properties: + - RegionLinkingMode + x-tagging: + taggable: false + x-required-permissions: + create: + - securityhub:CreateFindingAggregator + read: + - securityhub:GetFindingAggregator + update: + - securityhub:UpdateFindingAggregator + delete: + - securityhub:DeleteFindingAggregator + list: + - securityhub:ListFindingAggregators Hub: type: object properties: @@ -1978,6 +2239,153 @@ components: - securityhub:DeleteInsight list: - securityhub:GetInsights + OrganizationConfiguration: + type: object + properties: + AutoEnable: + description: Whether to automatically enable Security Hub in new member accounts when they join the organization. + type: boolean + AutoEnableStandards: + description: Whether to automatically enable Security Hub default standards in new member accounts when they join the organization. + type: string + enum: + - DEFAULT + - NONE + ConfigurationType: + description: Indicates whether the organization uses local or central configuration. + type: string + enum: + - CENTRAL + - LOCAL + Status: + description: Describes whether central configuration could be enabled as the ConfigurationType for the organization. + type: string + enum: + - PENDING + - ENABLED + - FAILED + StatusMessage: + description: Provides an explanation if the value of Status is equal to FAILED when ConfigurationType is equal to CENTRAL. + type: string + MemberAccountLimitReached: + description: Whether the maximum number of allowed member accounts are already associated with the Security Hub administrator account. + type: boolean + OrganizationConfigurationIdentifier: + description: The identifier of the OrganizationConfiguration being created and assigned as the unique identifier. + type: string + pattern: ^[0-9]{12}/[a-zA-Z0-9-]{1,32}/securityhub-organization-configuration$ + required: + - AutoEnable + x-stackql-resource-name: organization_configuration + description: The AWS::SecurityHub::OrganizationConfiguration resource represents the configuration of your organization in Security Hub. Only the Security Hub administrator account can create Organization Configuration resource in each region and can opt-in to Central Configuration only in the aggregation region of FindingAggregator. + x-type-name: AWS::SecurityHub::OrganizationConfiguration + x-stackql-primary-identifier: + - OrganizationConfigurationIdentifier + x-read-only-properties: + - OrganizationConfigurationIdentifier + - Status + - StatusMessage + - MemberAccountLimitReached + x-required-properties: + - AutoEnable + x-tagging: + taggable: false + x-required-permissions: + create: + - securityhub:UpdateOrganizationConfiguration + - securityhub:DescribeOrganizationConfiguration + - organizations:DescribeOrganization + read: + - securityhub:DescribeOrganizationConfiguration + update: + - securityhub:UpdateOrganizationConfiguration + - securityhub:DescribeOrganizationConfiguration + - organizations:DescribeOrganization + delete: + - securityhub:UpdateOrganizationConfiguration + - securityhub:DescribeOrganizationConfiguration + - securityhub:ListFindingAggregators + - organizations:DescribeOrganization + list: + - securityhub:DescribeOrganizationConfiguration + PolicyAssociation: + type: object + properties: + ConfigurationPolicyId: + description: The universally unique identifier (UUID) of the configuration policy or a value of SELF_MANAGED_SECURITY_HUB for a self-managed configuration + type: string + pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^SELF_MANAGED_SECURITY_HUB$ + AssociationStatus: + description: The current status of the association between the specified target and the configuration + type: string + enum: + - SUCCESS + - PENDING + - FAILED + AssociationType: + description: Indicates whether the association between the specified target and the configuration was directly applied by the Security Hub delegated administrator or inherited from a parent + type: string + enum: + - APPLIED + - INHERITED + AssociationStatusMessage: + description: An explanation for a FAILED value for AssociationStatus + type: string + TargetId: + description: The identifier of the target account, organizational unit, or the root + type: string + TargetType: + description: Indicates whether the target is an AWS account, organizational unit, or the organization root + type: string + enum: + - ACCOUNT + - ORGANIZATIONAL_UNIT + - ROOT + UpdatedAt: + description: The date and time, in UTC and ISO 8601 format, that the configuration policy association was last updated + type: string + AssociationIdentifier: + description: A unique identifier to indicates if the target has an association + type: string + required: + - TargetId + - TargetType + - ConfigurationPolicyId + x-stackql-resource-name: policy_association + description: The AWS::SecurityHub::PolicyAssociation resource represents the AWS Security Hub Central Configuration Policy associations in your Target. Only the AWS Security Hub delegated administrator can create the resouce from the home region. + x-type-name: AWS::SecurityHub::PolicyAssociation + x-stackql-primary-identifier: + - AssociationIdentifier + x-create-only-properties: + - TargetId + - TargetType + x-read-only-properties: + - AssociationStatus + - AssociationType + - AssociationStatusMessage + - UpdatedAt + - AssociationIdentifier + x-required-properties: + - TargetId + - TargetType + - ConfigurationPolicyId + x-tagging: + taggable: false + x-required-permissions: + create: + - securityhub:StartConfigurationPolicyAssociation + - securityhub:GetConfigurationPolicyAssociation + read: + - securityhub:GetConfigurationPolicyAssociation + - securityhub:GetConfigurationPolicyAssociation + update: + - securityhub:StartConfigurationPolicyAssociation + - securityhub:GetConfigurationPolicyAssociation + delete: + - securityhub:StartConfigurationPolicyDisassociation + - securityhub:GetConfigurationPolicyAssociation + list: + - securityhub:ListConfigurationPolicyAssociations ProductSubscription: type: object properties: @@ -2018,6 +2426,72 @@ components: - securityhub:DisableImportFindingsForProduct list: - securityhub:ListEnabledProductsForImport + NonEmptyStringList: + items: + $ref: '#/components/schemas/NonEmptyString' + type: array + IntegerList: + items: + type: integer + type: array + Parameters: + type: object + x-patternProperties: + .*\S.*: + $ref: '#/components/schemas/ParameterConfiguration' + additionalProperties: false + SecurityControl: + type: object + properties: + SecurityControlId: + description: The unique identifier of a security control across standards. Values for this field typically consist of an AWS service name and a number, such as APIGateway.3. + $ref: '#/components/schemas/NonEmptyString' + SecurityControlArn: + description: The Amazon Resource Name (ARN) for a security control across standards, such as `arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1`. This parameter doesn't mention a specific standard. + $ref: '#/components/schemas/NonEmptyString' + LastUpdateReason: + description: The most recent reason for updating the customizable properties of a security control. This differs from the UpdateReason field of the BatchUpdateStandardsControlAssociations API, which tracks the reason for updating the enablement status of a control. This field accepts alphanumeric characters in addition to white spaces, dashes, and underscores. + type: string + pattern: "^([^\0-\x7F]|[-_ a-zA-Z0-9])+$" + Parameters: + description: An object that identifies the name of a control parameter, its current value, and whether it has been customized. + $ref: '#/components/schemas/Parameters' + required: + - Parameters + x-stackql-resource-name: security_control + description: A security control in Security Hub describes a security best practice related to a specific resource. + x-type-name: AWS::SecurityHub::SecurityControl + x-stackql-primary-identifier: + - SecurityControlId + x-stackql-additional-identifiers: + - - SecurityControlArn + x-required-properties: + - Parameters + x-tagging: + taggable: false + x-required-permissions: + create: + - securityhub:BatchGetSecurityControls + - securityhub:DescribeStandardsControls + - securityhub:UpdateSecurityControl + - securityhub:UpdateStandardsControl + read: + - securityhub:BatchGetSecurityControls + - securityhub:DescribeStandardsControls + update: + - securityhub:BatchGetSecurityControls + - securityhub:DescribeStandardsControls + - securityhub:UpdateSecurityControl + - securityhub:UpdateStandardsControl + delete: + - securityhub:BatchGetSecurityControls + - securityhub:DescribeStandardsControls + - securityhub:UpdateSecurityControl + - securityhub:UpdateStandardsControl + list: + - securityhub:BatchGetSecurityControls + - securityhub:DescribeStandardsControls + - securityhub:ListSecurityControlDefinitions StandardsControl: description: Provides details about an individual security control. For a list of ASH controls, see [controls reference](https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-controls-reference.html) in the *User Guide*. type: object @@ -2163,6 +2637,54 @@ components: x-title: CreateAutomationRuleRequest type: object required: [] + CreateConfigurationPolicyRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Arn: + description: The Amazon Resource Name (ARN) of the configuration policy. + type: string + pattern: ^arn:aws\S*:securityhub:[a-z0-9-]+:[0-9]{12}:configuration-policy/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ + Name: + description: The name of the configuration policy. + type: string + minLength: 1 + maxLength: 128 + Description: + description: The description of the configuration policy. + type: string + minLength: 0 + maxLength: 512 + ConfigurationPolicy: + $ref: '#/components/schemas/Policy' + Id: + description: The universally unique identifier (UUID) of the configuration policy. + type: string + pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ + CreatedAt: + description: The date and time, in UTC and ISO 8601 format. + type: string + UpdatedAt: + description: The date and time, in UTC and ISO 8601 format. + type: string + ServiceEnabled: + type: boolean + description: Indicates whether the service that the configuration policy applies to is enabled in the policy. + Tags: + $ref: '#/components/schemas/Tags' + x-stackQL-stringOnly: true + x-title: CreateConfigurationPolicyRequest + type: object + required: [] CreateDelegatedAdminRequest: properties: ClientToken: @@ -2194,7 +2716,7 @@ components: x-title: CreateDelegatedAdminRequest type: object required: [] - CreateHubRequest: + CreateFindingAggregatorRequest: properties: ClientToken: type: string @@ -2207,17 +2729,57 @@ components: DesiredState: type: object properties: - ARN: - description: An ARN is automatically created for the customer. + FindingAggregatorArn: + description: The ARN of the FindingAggregator being created and assigned as the unique identifier type: string - pattern: ^arn:.* - EnableDefaultStandards: - description: Whether to enable the security standards that Security Hub has designated as automatically enabled. - type: boolean - ControlFindingGenerator: - description: This field, used when enabling Security Hub, specifies whether the calling account has consolidated control findings turned on. If the value for this field is set to SECURITY_CONTROL, Security Hub generates a single finding for a control check even when the check applies to multiple enabled standards. If the value for this field is set to STANDARD_CONTROL, Security Hub generates separate findings for a control check when the check applies to multiple enabled standards. + pattern: arn:aws\S*:securityhub:\S* + RegionLinkingMode: + description: Indicates whether to link all Regions, all Regions except for a list of excluded Regions, or a list of included Regions type: string - pattern: ^(SECURITY_CONTROL|STANDARD_CONTROL)$ + enum: + - ALL_REGIONS + - ALL_REGIONS_EXCEPT_SPECIFIED + - SPECIFIED_REGIONS + Regions: + description: The list of excluded Regions or included Regions + type: array + x-insertionOrder: false + uniqueItems: true + minItems: 1 + maxItems: 50 + items: + $ref: '#/components/schemas/Region' + FindingAggregationRegion: + description: The aggregation Region of the FindingAggregator + $ref: '#/components/schemas/Region' + x-stackQL-stringOnly: true + x-title: CreateFindingAggregatorRequest + type: object + required: [] + CreateHubRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ARN: + description: An ARN is automatically created for the customer. + type: string + pattern: ^arn:.* + EnableDefaultStandards: + description: Whether to enable the security standards that Security Hub has designated as automatically enabled. + type: boolean + ControlFindingGenerator: + description: This field, used when enabling Security Hub, specifies whether the calling account has consolidated control findings turned on. If the value for this field is set to SECURITY_CONTROL, Security Hub generates a single finding for a control check even when the check applies to multiple enabled standards. If the value for this field is set to STANDARD_CONTROL, Security Hub generates separate findings for a control check when the check applies to multiple enabled standards. + type: string + pattern: ^(SECURITY_CONTROL|STANDARD_CONTROL)$ AutoEnableControls: description: Whether to automatically enable new controls when they are added to standards that are enabled type: boolean @@ -2263,6 +2825,108 @@ components: x-title: CreateInsightRequest type: object required: [] + CreateOrganizationConfigurationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AutoEnable: + description: Whether to automatically enable Security Hub in new member accounts when they join the organization. + type: boolean + AutoEnableStandards: + description: Whether to automatically enable Security Hub default standards in new member accounts when they join the organization. + type: string + enum: + - DEFAULT + - NONE + ConfigurationType: + description: Indicates whether the organization uses local or central configuration. + type: string + enum: + - CENTRAL + - LOCAL + Status: + description: Describes whether central configuration could be enabled as the ConfigurationType for the organization. + type: string + enum: + - PENDING + - ENABLED + - FAILED + StatusMessage: + description: Provides an explanation if the value of Status is equal to FAILED when ConfigurationType is equal to CENTRAL. + type: string + MemberAccountLimitReached: + description: Whether the maximum number of allowed member accounts are already associated with the Security Hub administrator account. + type: boolean + OrganizationConfigurationIdentifier: + description: The identifier of the OrganizationConfiguration being created and assigned as the unique identifier. + type: string + pattern: ^[0-9]{12}/[a-zA-Z0-9-]{1,32}/securityhub-organization-configuration$ + x-stackQL-stringOnly: true + x-title: CreateOrganizationConfigurationRequest + type: object + required: [] + CreatePolicyAssociationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ConfigurationPolicyId: + description: The universally unique identifier (UUID) of the configuration policy or a value of SELF_MANAGED_SECURITY_HUB for a self-managed configuration + type: string + pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^SELF_MANAGED_SECURITY_HUB$ + AssociationStatus: + description: The current status of the association between the specified target and the configuration + type: string + enum: + - SUCCESS + - PENDING + - FAILED + AssociationType: + description: Indicates whether the association between the specified target and the configuration was directly applied by the Security Hub delegated administrator or inherited from a parent + type: string + enum: + - APPLIED + - INHERITED + AssociationStatusMessage: + description: An explanation for a FAILED value for AssociationStatus + type: string + TargetId: + description: The identifier of the target account, organizational unit, or the root + type: string + TargetType: + description: Indicates whether the target is an AWS account, organizational unit, or the organization root + type: string + enum: + - ACCOUNT + - ORGANIZATIONAL_UNIT + - ROOT + UpdatedAt: + description: The date and time, in UTC and ISO 8601 format, that the configuration policy association was last updated + type: string + AssociationIdentifier: + description: A unique identifier to indicates if the target has an association + type: string + x-stackQL-stringOnly: true + x-title: CreatePolicyAssociationRequest + type: object + required: [] CreateProductSubscriptionRequest: properties: ClientToken: @@ -2288,6 +2952,36 @@ components: x-title: CreateProductSubscriptionRequest type: object required: [] + CreateSecurityControlRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + SecurityControlId: + description: The unique identifier of a security control across standards. Values for this field typically consist of an AWS service name and a number, such as APIGateway.3. + $ref: '#/components/schemas/NonEmptyString' + SecurityControlArn: + description: The Amazon Resource Name (ARN) for a security control across standards, such as `arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1`. This parameter doesn't mention a specific standard. + $ref: '#/components/schemas/NonEmptyString' + LastUpdateReason: + description: The most recent reason for updating the customizable properties of a security control. This differs from the UpdateReason field of the BatchUpdateStandardsControlAssociations API, which tracks the reason for updating the enablement status of a control. This field accepts alphanumeric characters in addition to white spaces, dashes, and underscores. + type: string + pattern: "^([^\0-\x7F]|[-_ a-zA-Z0-9])+$" + Parameters: + description: An object that identifies the name of a control parameter, its current value, and whether it has been customized. + $ref: '#/components/schemas/Parameters' + x-stackQL-stringOnly: true + x-title: CreateSecurityControlRequest + type: object + required: [] CreateStandardRequest: properties: ClientToken: @@ -2339,7 +3033,7 @@ components: x-cfn-type-name: AWS::SecurityHub::AutomationRule x-identifiers: - RuleArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2356,6 +3050,18 @@ components: response: mediaType: application/json openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityHub::AutomationRule" + } + response: + mediaType: application/json + openAPIDocKey: '200' delete_resource: operation: $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' @@ -2373,33 +3079,92 @@ components: - $ref: '#/components/x-stackQL-resources/automation_rules/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/automation_rules/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/automation_rules/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.RuleArn') as rule_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::AutomationRule' + data__Identifier, + JSON_EXTRACT(Properties, '$.RuleArn') as rule_arn, + JSON_EXTRACT(Properties, '$.RuleStatus') as rule_status, + JSON_EXTRACT(Properties, '$.RuleOrder') as rule_order, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.RuleName') as rule_name, + JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, + JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at, + JSON_EXTRACT(Properties, '$.CreatedBy') as created_by, + JSON_EXTRACT(Properties, '$.IsTerminal') as is_terminal, + JSON_EXTRACT(Properties, '$.Actions') as actions, + JSON_EXTRACT(Properties, '$.Criteria') as criteria, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityHub::AutomationRule' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - json_extract_path_text(Properties, 'RuleArn') as rule_arn + JSON_EXTRACT(Properties, '$.RuleArn') as rule_arn FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::AutomationRule' AND region = 'us-east-1' - automation_rule: - name: automation_rule - id: aws.securityhub.automation_rule - x-cfn-schema-name: AutomationRule - x-cfn-type-name: AWS::SecurityHub::AutomationRule + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'RuleArn') as rule_arn, + json_extract_path_text(Properties, 'RuleStatus') as rule_status, + json_extract_path_text(Properties, 'RuleOrder') as rule_order, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'RuleName') as rule_name, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'UpdatedAt') as updated_at, + json_extract_path_text(Properties, 'CreatedBy') as created_by, + json_extract_path_text(Properties, 'IsTerminal') as is_terminal, + json_extract_path_text(Properties, 'Actions') as actions, + json_extract_path_text(Properties, 'Criteria') as criteria, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityHub::AutomationRule' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'RuleArn') as rule_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::AutomationRule' + AND region = 'us-east-1' + configuration_policies: + name: configuration_policies + id: aws.securityhub.configuration_policies + x-cfn-schema-name: ConfigurationPolicy + x-cfn-type-name: AWS::SecurityHub::ConfigurationPolicy x-identifiers: - - RuleArn - x-type: get + - Arn + x-type: cloud_control methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ConfigurationPolicy&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityHub::ConfigurationPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' update_resource: operation: $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' @@ -2407,58 +3172,84 @@ components: mediaType: application/x-amz-json-1.0 base: |- { - "TypeName": "AWS::SecurityHub::AutomationRule" + "TypeName": "AWS::SecurityHub::ConfigurationPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityHub::ConfigurationPolicy" } response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/configuration_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/configuration_policies/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/automation_rule/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/configuration_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.RuleArn') as rule_arn, - JSON_EXTRACT(Properties, '$.RuleStatus') as rule_status, - JSON_EXTRACT(Properties, '$.RuleOrder') as rule_order, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.Name') as name, JSON_EXTRACT(Properties, '$.Description') as description, - JSON_EXTRACT(Properties, '$.RuleName') as rule_name, + JSON_EXTRACT(Properties, '$.ConfigurationPolicy') as configuration_policy, + JSON_EXTRACT(Properties, '$.Id') as id, JSON_EXTRACT(Properties, '$.CreatedAt') as created_at, JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at, - JSON_EXTRACT(Properties, '$.CreatedBy') as created_by, - JSON_EXTRACT(Properties, '$.IsTerminal') as is_terminal, - JSON_EXTRACT(Properties, '$.Actions') as actions, - JSON_EXTRACT(Properties, '$.Criteria') as criteria, + JSON_EXTRACT(Properties, '$.ServiceEnabled') as service_enabled, JSON_EXTRACT(Properties, '$.Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityHub::AutomationRule' - AND data__Identifier = '' + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityHub::ConfigurationPolicy' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'RuleArn') as rule_arn, - json_extract_path_text(Properties, 'RuleStatus') as rule_status, - json_extract_path_text(Properties, 'RuleOrder') as rule_order, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'RuleName') as rule_name, - json_extract_path_text(Properties, 'CreatedAt') as created_at, - json_extract_path_text(Properties, 'UpdatedAt') as updated_at, - json_extract_path_text(Properties, 'CreatedBy') as created_by, - json_extract_path_text(Properties, 'IsTerminal') as is_terminal, - json_extract_path_text(Properties, 'Actions') as actions, - json_extract_path_text(Properties, 'Criteria') as criteria, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityHub::AutomationRule' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::ConfigurationPolicy' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'ConfigurationPolicy') as configuration_policy, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'UpdatedAt') as updated_at, + json_extract_path_text(Properties, 'ServiceEnabled') as service_enabled, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityHub::ConfigurationPolicy' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::ConfigurationPolicy' + AND region = 'us-east-1' delegated_admins: name: delegated_admins id: aws.securityhub.delegated_admins @@ -2466,7 +3257,7 @@ components: x-cfn-type-name: AWS::SecurityHub::DelegatedAdmin x-identifiers: - DelegatedAdminIdentifier - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2500,39 +3291,11 @@ components: - $ref: '#/components/x-stackQL-resources/delegated_admins/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/delegated_admins/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.DelegatedAdminIdentifier') as delegated_admin_identifier - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::DelegatedAdmin' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'DelegatedAdminIdentifier') as delegated_admin_identifier - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::DelegatedAdmin' - AND region = 'us-east-1' - delegated_admin: - name: delegated_admin - id: aws.securityhub.delegated_admin - x-cfn-schema-name: DelegatedAdmin - x-cfn-type-name: AWS::SecurityHub::DelegatedAdmin - x-identifiers: - - DelegatedAdminIdentifier - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2544,37 +3307,65 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'DelegatedAdminIdentifier') as delegated_admin_identifier, - json_extract_path_text(Properties, 'AdminAccountId') as admin_account_id, - json_extract_path_text(Properties, 'Status') as status - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityHub::DelegatedAdmin' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.DelegatedAdminIdentifier') as delegated_admin_identifier + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::DelegatedAdmin' AND region = 'us-east-1' - hubs: - name: hubs - id: aws.securityhub.hubs - x-cfn-schema-name: Hub - x-cfn-type-name: AWS::SecurityHub::Hub + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DelegatedAdminIdentifier') as delegated_admin_identifier, + json_extract_path_text(Properties, 'AdminAccountId') as admin_account_id, + json_extract_path_text(Properties, 'Status') as status + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityHub::DelegatedAdmin' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DelegatedAdminIdentifier') as delegated_admin_identifier + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::DelegatedAdmin' + AND region = 'us-east-1' + finding_aggregators: + name: finding_aggregators + id: aws.securityhub.finding_aggregators + x-cfn-schema-name: FindingAggregator + x-cfn-type-name: AWS::SecurityHub::FindingAggregator x-identifiers: - - ARN - x-type: list + - FindingAggregatorArn + x-type: cloud_control methods: create_resource: config: requestBodyTranslate: algorithm: naive_DesiredState operation: - $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Hub&__detailTransformed=true/post' + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__FindingAggregator&__detailTransformed=true/post' request: mediaType: application/x-amz-json-1.0 base: |- { - "TypeName": "AWS::SecurityHub::Hub" + "TypeName": "AWS::SecurityHub::FindingAggregator" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityHub::FindingAggregator" } response: mediaType: application/json @@ -2586,43 +3377,86 @@ components: mediaType: application/x-amz-json-1.0 base: |- { - "TypeName": "AWS::SecurityHub::Hub" + "TypeName": "AWS::SecurityHub::FindingAggregator" } response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: insert: - - $ref: '#/components/x-stackQL-resources/hubs/methods/create_resource' + - $ref: '#/components/x-stackQL-resources/finding_aggregators/methods/create_resource' delete: - - $ref: '#/components/x-stackQL-resources/hubs/methods/delete_resource' + - $ref: '#/components/x-stackQL-resources/finding_aggregators/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/finding_aggregators/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ARN') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::Hub' + data__Identifier, + JSON_EXTRACT(Properties, '$.FindingAggregatorArn') as finding_aggregator_arn, + JSON_EXTRACT(Properties, '$.RegionLinkingMode') as region_linking_mode, + JSON_EXTRACT(Properties, '$.Regions') as regions, + JSON_EXTRACT(Properties, '$.FindingAggregationRegion') as finding_aggregation_region + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityHub::FindingAggregator' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ARN') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::Hub' + JSON_EXTRACT(Properties, '$.FindingAggregatorArn') as finding_aggregator_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::FindingAggregator' AND region = 'us-east-1' - hub: - name: hub - id: aws.securityhub.hub + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'FindingAggregatorArn') as finding_aggregator_arn, + json_extract_path_text(Properties, 'RegionLinkingMode') as region_linking_mode, + json_extract_path_text(Properties, 'Regions') as regions, + json_extract_path_text(Properties, 'FindingAggregationRegion') as finding_aggregation_region + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityHub::FindingAggregator' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'FindingAggregatorArn') as finding_aggregator_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::FindingAggregator' + AND region = 'us-east-1' + hubs: + name: hubs + id: aws.securityhub.hubs x-cfn-schema-name: Hub x-cfn-type-name: AWS::SecurityHub::Hub x-identifiers: - ARN - x-type: get + x-type: cloud_control methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Hub&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityHub::Hub" + } + response: + mediaType: application/json + openAPIDocKey: '200' update_resource: operation: $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' @@ -2635,13 +3469,29 @@ components: response: mediaType: application/json openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityHub::Hub" + } + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/hubs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/hubs/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/hub/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/hubs/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2656,20 +3506,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ARN') as arn, - json_extract_path_text(Properties, 'EnableDefaultStandards') as enable_default_standards, - json_extract_path_text(Properties, 'ControlFindingGenerator') as control_finding_generator, - json_extract_path_text(Properties, 'AutoEnableControls') as auto_enable_controls, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'SubscribedAt') as subscribed_at - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityHub::Hub' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ARN') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::Hub' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ARN') as arn, + json_extract_path_text(Properties, 'EnableDefaultStandards') as enable_default_standards, + json_extract_path_text(Properties, 'ControlFindingGenerator') as control_finding_generator, + json_extract_path_text(Properties, 'AutoEnableControls') as auto_enable_controls, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'SubscribedAt') as subscribed_at + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityHub::Hub' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ARN') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::Hub' + AND region = 'us-east-1' insights: name: insights id: aws.securityhub.insights @@ -2677,7 +3543,7 @@ components: x-cfn-type-name: AWS::SecurityHub::Insight x-identifiers: - InsightArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2694,6 +3560,18 @@ components: response: mediaType: application/json openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityHub::Insight" + } + response: + mediaType: application/json + openAPIDocKey: '200' delete_resource: operation: $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' @@ -2711,33 +3589,76 @@ components: - $ref: '#/components/x-stackQL-resources/insights/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/insights/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/insights/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.InsightArn') as insight_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::Insight' + data__Identifier, + JSON_EXTRACT(Properties, '$.InsightArn') as insight_arn, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Filters') as filters, + JSON_EXTRACT(Properties, '$.GroupByAttribute') as group_by_attribute + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityHub::Insight' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - json_extract_path_text(Properties, 'InsightArn') as insight_arn + JSON_EXTRACT(Properties, '$.InsightArn') as insight_arn FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::Insight' AND region = 'us-east-1' - insight: - name: insight - id: aws.securityhub.insight - x-cfn-schema-name: Insight - x-cfn-type-name: AWS::SecurityHub::Insight + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'InsightArn') as insight_arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Filters') as filters, + json_extract_path_text(Properties, 'GroupByAttribute') as group_by_attribute + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityHub::Insight' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'InsightArn') as insight_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::Insight' + AND region = 'us-east-1' + organization_configurations: + name: organization_configurations + id: aws.securityhub.organization_configurations + x-cfn-schema-name: OrganizationConfiguration + x-cfn-type-name: AWS::SecurityHub::OrganizationConfiguration x-identifiers: - - InsightArn - x-type: get + - OrganizationConfigurationIdentifier + x-type: cloud_control methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__OrganizationConfiguration&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityHub::OrganizationConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' update_resource: operation: $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' @@ -2745,62 +3666,112 @@ components: mediaType: application/x-amz-json-1.0 base: |- { - "TypeName": "AWS::SecurityHub::Insight" + "TypeName": "AWS::SecurityHub::OrganizationConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityHub::OrganizationConfiguration" } response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/organization_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/organization_configurations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/insight/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/organization_configurations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.InsightArn') as insight_arn, - JSON_EXTRACT(Properties, '$.Name') as name, - JSON_EXTRACT(Properties, '$.Filters') as filters, - JSON_EXTRACT(Properties, '$.GroupByAttribute') as group_by_attribute - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityHub::Insight' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.AutoEnable') as auto_enable, + JSON_EXTRACT(Properties, '$.AutoEnableStandards') as auto_enable_standards, + JSON_EXTRACT(Properties, '$.ConfigurationType') as configuration_type, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.StatusMessage') as status_message, + JSON_EXTRACT(Properties, '$.MemberAccountLimitReached') as member_account_limit_reached, + JSON_EXTRACT(Properties, '$.OrganizationConfigurationIdentifier') as organization_configuration_identifier + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityHub::OrganizationConfiguration' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'InsightArn') as insight_arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Filters') as filters, - json_extract_path_text(Properties, 'GroupByAttribute') as group_by_attribute - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityHub::Insight' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.OrganizationConfigurationIdentifier') as organization_configuration_identifier + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::OrganizationConfiguration' AND region = 'us-east-1' - product_subscriptions: - name: product_subscriptions - id: aws.securityhub.product_subscriptions - x-cfn-schema-name: ProductSubscription - x-cfn-type-name: AWS::SecurityHub::ProductSubscription + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AutoEnable') as auto_enable, + json_extract_path_text(Properties, 'AutoEnableStandards') as auto_enable_standards, + json_extract_path_text(Properties, 'ConfigurationType') as configuration_type, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'StatusMessage') as status_message, + json_extract_path_text(Properties, 'MemberAccountLimitReached') as member_account_limit_reached, + json_extract_path_text(Properties, 'OrganizationConfigurationIdentifier') as organization_configuration_identifier + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityHub::OrganizationConfiguration' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'OrganizationConfigurationIdentifier') as organization_configuration_identifier + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::OrganizationConfiguration' + AND region = 'us-east-1' + policy_associations: + name: policy_associations + id: aws.securityhub.policy_associations + x-cfn-schema-name: PolicyAssociation + x-cfn-type-name: AWS::SecurityHub::PolicyAssociation x-identifiers: - - ProductSubscriptionArn - x-type: list + - AssociationIdentifier + x-type: cloud_control methods: create_resource: config: requestBodyTranslate: algorithm: naive_DesiredState operation: - $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ProductSubscription&__detailTransformed=true/post' + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__PolicyAssociation&__detailTransformed=true/post' request: mediaType: application/x-amz-json-1.0 base: |- { - "TypeName": "AWS::SecurityHub::ProductSubscription" + "TypeName": "AWS::SecurityHub::PolicyAssociation" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityHub::PolicyAssociation" } response: mediaType: application/json @@ -2812,49 +3783,116 @@ components: mediaType: application/x-amz-json-1.0 base: |- { - "TypeName": "AWS::SecurityHub::ProductSubscription" + "TypeName": "AWS::SecurityHub::PolicyAssociation" } response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: insert: - - $ref: '#/components/x-stackQL-resources/product_subscriptions/methods/create_resource' + - $ref: '#/components/x-stackQL-resources/policy_associations/methods/create_resource' delete: - - $ref: '#/components/x-stackQL-resources/product_subscriptions/methods/delete_resource' + - $ref: '#/components/x-stackQL-resources/policy_associations/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/policy_associations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.ProductSubscriptionArn') as product_subscription_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::ProductSubscription' + data__Identifier, + JSON_EXTRACT(Properties, '$.ConfigurationPolicyId') as configuration_policy_id, + JSON_EXTRACT(Properties, '$.AssociationStatus') as association_status, + JSON_EXTRACT(Properties, '$.AssociationType') as association_type, + JSON_EXTRACT(Properties, '$.AssociationStatusMessage') as association_status_message, + JSON_EXTRACT(Properties, '$.TargetId') as target_id, + JSON_EXTRACT(Properties, '$.TargetType') as target_type, + JSON_EXTRACT(Properties, '$.UpdatedAt') as updated_at, + JSON_EXTRACT(Properties, '$.AssociationIdentifier') as association_identifier + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityHub::PolicyAssociation' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ProductSubscriptionArn') as product_subscription_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::ProductSubscription' + JSON_EXTRACT(Properties, '$.AssociationIdentifier') as association_identifier + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::PolicyAssociation' AND region = 'us-east-1' - product_subscription: - name: product_subscription - id: aws.securityhub.product_subscription + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ConfigurationPolicyId') as configuration_policy_id, + json_extract_path_text(Properties, 'AssociationStatus') as association_status, + json_extract_path_text(Properties, 'AssociationType') as association_type, + json_extract_path_text(Properties, 'AssociationStatusMessage') as association_status_message, + json_extract_path_text(Properties, 'TargetId') as target_id, + json_extract_path_text(Properties, 'TargetType') as target_type, + json_extract_path_text(Properties, 'UpdatedAt') as updated_at, + json_extract_path_text(Properties, 'AssociationIdentifier') as association_identifier + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityHub::PolicyAssociation' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AssociationIdentifier') as association_identifier + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::PolicyAssociation' + AND region = 'us-east-1' + product_subscriptions: + name: product_subscriptions + id: aws.securityhub.product_subscriptions x-cfn-schema-name: ProductSubscription x-cfn-type-name: AWS::SecurityHub::ProductSubscription x-identifiers: - ProductSubscriptionArn - x-type: get - methods: {} + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ProductSubscription&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityHub::ProductSubscription" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityHub::ProductSubscription" + } + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/product_subscriptions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/product_subscriptions/methods/delete_resource' update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2865,36 +3903,64 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ProductArn') as product_arn, - json_extract_path_text(Properties, 'ProductSubscriptionArn') as product_subscription_arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityHub::ProductSubscription' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ProductSubscriptionArn') as product_subscription_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::ProductSubscription' AND region = 'us-east-1' - standards: - name: standards - id: aws.securityhub.standards - x-cfn-schema-name: Standard - x-cfn-type-name: AWS::SecurityHub::Standard + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ProductArn') as product_arn, + json_extract_path_text(Properties, 'ProductSubscriptionArn') as product_subscription_arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityHub::ProductSubscription' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ProductSubscriptionArn') as product_subscription_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::ProductSubscription' + AND region = 'us-east-1' + security_controls: + name: security_controls + id: aws.securityhub.security_controls + x-cfn-schema-name: SecurityControl + x-cfn-type-name: AWS::SecurityHub::SecurityControl x-identifiers: - - StandardsSubscriptionArn - x-type: list + - SecurityControlId + x-type: cloud_control methods: create_resource: config: requestBodyTranslate: algorithm: naive_DesiredState operation: - $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Standard&__detailTransformed=true/post' + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__SecurityControl&__detailTransformed=true/post' request: mediaType: application/x-amz-json-1.0 base: |- { - "TypeName": "AWS::SecurityHub::Standard" + "TypeName": "AWS::SecurityHub::SecurityControl" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityHub::SecurityControl" } response: mediaType: application/json @@ -2906,43 +3972,86 @@ components: mediaType: application/x-amz-json-1.0 base: |- { - "TypeName": "AWS::SecurityHub::Standard" + "TypeName": "AWS::SecurityHub::SecurityControl" } response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: insert: - - $ref: '#/components/x-stackQL-resources/standards/methods/create_resource' + - $ref: '#/components/x-stackQL-resources/security_controls/methods/create_resource' delete: - - $ref: '#/components/x-stackQL-resources/standards/methods/delete_resource' + - $ref: '#/components/x-stackQL-resources/security_controls/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/security_controls/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.StandardsSubscriptionArn') as standards_subscription_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::Standard' + data__Identifier, + JSON_EXTRACT(Properties, '$.SecurityControlId') as security_control_id, + JSON_EXTRACT(Properties, '$.SecurityControlArn') as security_control_arn, + JSON_EXTRACT(Properties, '$.LastUpdateReason') as last_update_reason, + JSON_EXTRACT(Properties, '$.Parameters') as parameters + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityHub::SecurityControl' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - json_extract_path_text(Properties, 'StandardsSubscriptionArn') as standards_subscription_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::Standard' + JSON_EXTRACT(Properties, '$.SecurityControlId') as security_control_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::SecurityControl' AND region = 'us-east-1' - standard: - name: standard - id: aws.securityhub.standard + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'SecurityControlId') as security_control_id, + json_extract_path_text(Properties, 'SecurityControlArn') as security_control_arn, + json_extract_path_text(Properties, 'LastUpdateReason') as last_update_reason, + json_extract_path_text(Properties, 'Parameters') as parameters + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityHub::SecurityControl' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'SecurityControlId') as security_control_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::SecurityControl' + AND region = 'us-east-1' + standards: + name: standards + id: aws.securityhub.standards x-cfn-schema-name: Standard x-cfn-type-name: AWS::SecurityHub::Standard x-identifiers: - StandardsSubscriptionArn - x-type: get + x-type: cloud_control methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Standard&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityHub::Standard" + } + response: + mediaType: application/json + openAPIDocKey: '200' update_resource: operation: $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' @@ -2955,13 +4064,29 @@ components: response: mediaType: application/json openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityHub::Standard" + } + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/standards/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/standards/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/standard/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/standards/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2973,17 +4098,33 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'StandardsSubscriptionArn') as standards_subscription_arn, - json_extract_path_text(Properties, 'StandardsArn') as standards_arn, - json_extract_path_text(Properties, 'DisabledStandardsControls') as disabled_standards_controls - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityHub::Standard' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.StandardsSubscriptionArn') as standards_subscription_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::Standard' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'StandardsSubscriptionArn') as standards_subscription_arn, + json_extract_path_text(Properties, 'StandardsArn') as standards_arn, + json_extract_path_text(Properties, 'DisabledStandardsControls') as disabled_standards_controls + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityHub::Standard' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'StandardsSubscriptionArn') as standards_subscription_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityHub::Standard' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: @@ -3169,6 +4310,48 @@ paths: schema: $ref: '#/components/x-cloud-control-schemas/ProgressEvent' description: Success + /?Action=CreateResource&Version=2021-09-30&__ConfigurationPolicy&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateConfigurationPolicy + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateConfigurationPolicyRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success /?Action=CreateResource&Version=2021-09-30&__DelegatedAdmin&__detailTransformed=true: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' @@ -3211,6 +4394,48 @@ paths: schema: $ref: '#/components/x-cloud-control-schemas/ProgressEvent' description: Success + /?Action=CreateResource&Version=2021-09-30&__FindingAggregator&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateFindingAggregator + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateFindingAggregatorRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success /?Action=CreateResource&Version=2021-09-30&__Hub&__detailTransformed=true: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' @@ -3295,6 +4520,90 @@ paths: schema: $ref: '#/components/x-cloud-control-schemas/ProgressEvent' description: Success + /?Action=CreateResource&Version=2021-09-30&__OrganizationConfiguration&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateOrganizationConfiguration + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateOrganizationConfigurationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__PolicyAssociation&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreatePolicyAssociation + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreatePolicyAssociationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success /?Action=CreateResource&Version=2021-09-30&__ProductSubscription&__detailTransformed=true: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' @@ -3337,6 +4646,48 @@ paths: schema: $ref: '#/components/x-cloud-control-schemas/ProgressEvent' description: Success + /?Action=CreateResource&Version=2021-09-30&__SecurityControl&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSecurityControl + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSecurityControlRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success /?Action=CreateResource&Version=2021-09-30&__Standard&__detailTransformed=true: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' diff --git a/providers/src/aws/v00.00.00000/services/securitylake.yaml b/providers/src/aws/v00.00.00000/services/securitylake.yaml index 81b5c5e0..c37d0b9a 100644 --- a/providers/src/aws/v00.00.00000/services/securitylake.yaml +++ b/providers/src/aws/v00.00.00000/services/securitylake.yaml @@ -509,8 +509,6 @@ components: x-type-name: AWS::SecurityLake::DataLake x-stackql-primary-identifier: - Arn - x-create-only-properties: - - MetaStoreManagerRoleArn x-write-only-properties: - MetaStoreManagerRoleArn x-read-only-properties: @@ -596,21 +594,17 @@ components: description: The version for a third-party custom source. This must be a Regionally unique value. additionalProperties: false Source: + properties: + AwsLogSource: + $ref: '#/components/schemas/AwsLogSource' + CustomLogSource: + $ref: '#/components/schemas/CustomLogSource' + additionalProperties: false oneOf: - - type: object - properties: - AwsLogSource: - $ref: '#/components/schemas/AwsLogSource' - required: + - required: - AwsLogSource - additionalProperties: false - - type: object - properties: - CustomLogSource: - $ref: '#/components/schemas/CustomLogSource' - required: + - required: - CustomLogSource - additionalProperties: false Subscriber: type: object properties: @@ -786,6 +780,165 @@ components: - sqs:GetQueueUrl list: - securitylake:ListSubscribers + HttpsNotificationConfiguration: + type: object + properties: + AuthorizationApiKeyName: + type: string + description: The key name for the notification subscription. + AuthorizationApiKeyValue: + type: string + description: The key value for the notification subscription. + Endpoint: + type: string + pattern: ^https?://.+$ + description: The subscription endpoint in Security Lake. + HttpMethod: + type: string + enum: + - POST + - PUT + description: The HTTPS method used for the notification subscription. + TargetRoleArn: + type: string + pattern: ^arn:.*$ + description: The Amazon Resource Name (ARN) of the EventBridge API destinations IAM role that you created. + description: The configuration for HTTPS subscriber notification. + additionalProperties: false + required: + - Endpoint + - TargetRoleArn + SqsNotificationConfiguration: + type: object + description: The configurations for SQS subscriber notification. The members of this structure are context-dependent. + NotificationConfiguration: + type: object + properties: + HttpsNotificationConfiguration: + $ref: '#/components/schemas/HttpsNotificationConfiguration' + SqsNotificationConfiguration: + $ref: '#/components/schemas/SqsNotificationConfiguration' + additionalProperties: false + oneOf: + - required: + - HttpsNotificationConfiguration + - required: + - SqsNotificationConfiguration + SubscriberNotification: + type: object + properties: + NotificationConfiguration: + $ref: '#/components/schemas/NotificationConfiguration' + SubscriberArn: + description: The ARN for the subscriber + type: string + pattern: ^arn:.*$ + SubscriberEndpoint: + description: The endpoint the subscriber should listen to for notifications + type: string + required: + - SubscriberArn + - NotificationConfiguration + x-stackql-resource-name: subscriber_notification + description: Resource Type definition for AWS::SecurityLake::SubscriberNotification + x-type-name: AWS::SecurityLake::SubscriberNotification + x-stackql-primary-identifier: + - SubscriberArn + x-create-only-properties: + - SubscriberArn + x-write-only-properties: + - NotificationConfiguration/HttpsNotificationConfiguration/AuthorizationApiKeyName + - NotificationConfiguration/HttpsNotificationConfiguration/AuthorizationApiKeyValue + - NotificationConfiguration/HttpsNotificationConfiguration/Endpoint + - NotificationConfiguration/HttpsNotificationConfiguration/HttpMethod + - NotificationConfiguration/HttpsNotificationConfiguration/TargetRoleArn + x-read-only-properties: + - SubscriberEndpoint + x-required-properties: + - SubscriberArn + - NotificationConfiguration + x-replacement-strategy: delete_then_create + x-tagging: + taggable: false + x-required-permissions: + create: + - securitylake:CreateDataLake + - securitylake:CreateSubscriber + - securitylake:CreateSubscriberNotification + - securitylake:GetSubscriber + - iam:CreateServiceLinkedRole + - iam:PutRolePolicy + - iam:DeleteRolePolicy + - iam:PassRole + - s3:PutBucketNotification + - s3:GetBucketNotification + - events:CreateApiDestination + - events:CreateConnection + - events:CreateRule + - events:UpdateConnection + - events:DeleteConnection + - events:UpdateApiDestination + - events:DeleteApiDestination + - events:ListApiDestinations + - events:ListConnections + - events:PutRule + - events:DescribeRule + - events:DeleteRule + - events:PutTargets + - events:RemoveTargets + - events:ListTargetsByRule + - secretsmanager:CreateSecret + - sqs:CreateQueue + - sqs:GetQueueAttributes + - sqs:GetQueueUrl + - sqs:SetQueueAttributes + read: + - securitylake:GetSubscriber + update: + - securitylake:UpdateSubscriberNotification + - securitylake:GetSubscriber + - iam:CreateServiceLinkedRole + - iam:PutRolePolicy + - iam:DeleteRolePolicy + - iam:PassRole + - events:CreateApiDestination + - events:CreateConnection + - events:UpdateConnection + - events:DeleteConnection + - events:UpdateApiDestination + - events:DeleteApiDestination + - events:DeleteRule + - events:ListApiDestinations + - events:ListConnections + - events:PutRule + - events:DescribeRule + - events:DeleteRule + - events:PutTargets + - events:RemoveTargets + - events:ListTargetsByRule + - secretsmanager:CreateSecret + - s3:GetBucketNotificationConfiguration + - s3:PutBucketNotificationConfiguration + - s3:PutBucketNotification + - s3:GetBucketNotification + - sqs:CreateQueue + - sqs:DeleteQueue + - sqs:GetQueueAttributes + - sqs:SetQueueAttributes + delete: + - securitylake:DeleteSubscriberNotification + - securitylake:GetSubscriber + - iam:DeleteRole + - iam:DeleteRolePolicy + - events:DeleteApiDestination + - events:DeleteConnection + - events:DeleteRule + - events:ListTargetsByRule + - events:DescribeRule + - events:RemoveTargets + - sqs:DeleteQueue + list: + - securitylake:ListSubscribers CreateDataLakeRequest: properties: ClientToken: @@ -900,6 +1053,32 @@ components: x-title: CreateSubscriberRequest type: object required: [] + CreateSubscriberNotificationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + NotificationConfiguration: + $ref: '#/components/schemas/NotificationConfiguration' + SubscriberArn: + description: The ARN for the subscriber + type: string + pattern: ^arn:.*$ + SubscriberEndpoint: + description: The endpoint the subscriber should listen to for notifications + type: string + x-stackQL-stringOnly: true + x-title: CreateSubscriberNotificationRequest + type: object + required: [] securitySchemes: hmac: type: apiKey @@ -915,7 +1094,7 @@ components: x-cfn-type-name: AWS::SecurityLake::DataLake x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -932,9 +1111,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -944,41 +1123,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/data_lakes/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/data_lakes/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityLake::DataLake' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityLake::DataLake' - AND region = 'us-east-1' - data_lake: - name: data_lake - id: aws.securitylake.data_lake - x-cfn-schema-name: DataLake - x-cfn-type-name: AWS::SecurityLake::DataLake - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -989,12 +1136,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/data_lakes/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/data_lakes/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/data_lake/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/data_lakes/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1010,21 +1161,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'EncryptionConfiguration') as encryption_configuration, - json_extract_path_text(Properties, 'LifecycleConfiguration') as lifecycle_configuration, - json_extract_path_text(Properties, 'ReplicationConfiguration') as replication_configuration, - json_extract_path_text(Properties, 'MetaStoreManagerRoleArn') as meta_store_manager_role_arn, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'S3BucketArn') as s3_bucket_arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityLake::DataLake' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityLake::DataLake' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'EncryptionConfiguration') as encryption_configuration, + json_extract_path_text(Properties, 'LifecycleConfiguration') as lifecycle_configuration, + json_extract_path_text(Properties, 'ReplicationConfiguration') as replication_configuration, + json_extract_path_text(Properties, 'MetaStoreManagerRoleArn') as meta_store_manager_role_arn, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'S3BucketArn') as s3_bucket_arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityLake::DataLake' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityLake::DataLake' + AND region = 'us-east-1' subscribers: name: subscribers id: aws.securitylake.subscribers @@ -1032,7 +1199,7 @@ components: x-cfn-type-name: AWS::SecurityLake::Subscriber x-identifiers: - SubscriberArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1049,6 +1216,18 @@ components: response: mediaType: application/json openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityLake::Subscriber" + } + response: + mediaType: application/json + openAPIDocKey: '200' delete_resource: operation: $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' @@ -1066,33 +1245,92 @@ components: - $ref: '#/components/x-stackQL-resources/subscribers/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/subscribers/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/subscribers/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, + data__Identifier, + JSON_EXTRACT(Properties, '$.AccessTypes') as access_types, + JSON_EXTRACT(Properties, '$.DataLakeArn') as data_lake_arn, + JSON_EXTRACT(Properties, '$.SubscriberIdentity') as subscriber_identity, + JSON_EXTRACT(Properties, '$.SubscriberName') as subscriber_name, + JSON_EXTRACT(Properties, '$.SubscriberDescription') as subscriber_description, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.Sources') as sources, + JSON_EXTRACT(Properties, '$.ResourceShareArn') as resource_share_arn, + JSON_EXTRACT(Properties, '$.ResourceShareName') as resource_share_name, + JSON_EXTRACT(Properties, '$.SubscriberRoleArn') as subscriber_role_arn, + JSON_EXTRACT(Properties, '$.S3BucketArn') as s3_bucket_arn, JSON_EXTRACT(Properties, '$.SubscriberArn') as subscriber_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityLake::Subscriber' + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityLake::Subscriber' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - json_extract_path_text(Properties, 'SubscriberArn') as subscriber_arn + JSON_EXTRACT(Properties, '$.SubscriberArn') as subscriber_arn FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityLake::Subscriber' AND region = 'us-east-1' - subscriber: - name: subscriber - id: aws.securitylake.subscriber - x-cfn-schema-name: Subscriber - x-cfn-type-name: AWS::SecurityLake::Subscriber + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AccessTypes') as access_types, + json_extract_path_text(Properties, 'DataLakeArn') as data_lake_arn, + json_extract_path_text(Properties, 'SubscriberIdentity') as subscriber_identity, + json_extract_path_text(Properties, 'SubscriberName') as subscriber_name, + json_extract_path_text(Properties, 'SubscriberDescription') as subscriber_description, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Sources') as sources, + json_extract_path_text(Properties, 'ResourceShareArn') as resource_share_arn, + json_extract_path_text(Properties, 'ResourceShareName') as resource_share_name, + json_extract_path_text(Properties, 'SubscriberRoleArn') as subscriber_role_arn, + json_extract_path_text(Properties, 'S3BucketArn') as s3_bucket_arn, + json_extract_path_text(Properties, 'SubscriberArn') as subscriber_arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityLake::Subscriber' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'SubscriberArn') as subscriber_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityLake::Subscriber' + AND region = 'us-east-1' + subscriber_notifications: + name: subscriber_notifications + id: aws.securitylake.subscriber_notifications + x-cfn-schema-name: SubscriberNotification + x-cfn-type-name: AWS::SecurityLake::SubscriberNotification x-identifiers: - SubscriberArn - x-type: get + x-type: cloud_control methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__SubscriberNotification&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityLake::SubscriberNotification" + } + response: + mediaType: application/json + openAPIDocKey: '200' update_resource: operation: $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' @@ -1100,58 +1338,72 @@ components: mediaType: application/x-amz-json-1.0 base: |- { - "TypeName": "AWS::SecurityLake::Subscriber" + "TypeName": "AWS::SecurityLake::SubscriberNotification" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SecurityLake::SubscriberNotification" } response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/subscriber_notifications/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/subscriber_notifications/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/subscriber/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/subscriber_notifications/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, - JSON_EXTRACT(Properties, '$.AccessTypes') as access_types, - JSON_EXTRACT(Properties, '$.DataLakeArn') as data_lake_arn, - JSON_EXTRACT(Properties, '$.SubscriberIdentity') as subscriber_identity, - JSON_EXTRACT(Properties, '$.SubscriberName') as subscriber_name, - JSON_EXTRACT(Properties, '$.SubscriberDescription') as subscriber_description, - JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.Sources') as sources, - JSON_EXTRACT(Properties, '$.ResourceShareArn') as resource_share_arn, - JSON_EXTRACT(Properties, '$.ResourceShareName') as resource_share_name, - JSON_EXTRACT(Properties, '$.SubscriberRoleArn') as subscriber_role_arn, - JSON_EXTRACT(Properties, '$.S3BucketArn') as s3_bucket_arn, - JSON_EXTRACT(Properties, '$.SubscriberArn') as subscriber_arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityLake::Subscriber' + JSON_EXTRACT(Properties, '$.NotificationConfiguration') as notification_configuration, + JSON_EXTRACT(Properties, '$.SubscriberArn') as subscriber_arn, + JSON_EXTRACT(Properties, '$.SubscriberEndpoint') as subscriber_endpoint + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityLake::SubscriberNotification' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AccessTypes') as access_types, - json_extract_path_text(Properties, 'DataLakeArn') as data_lake_arn, - json_extract_path_text(Properties, 'SubscriberIdentity') as subscriber_identity, - json_extract_path_text(Properties, 'SubscriberName') as subscriber_name, - json_extract_path_text(Properties, 'SubscriberDescription') as subscriber_description, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Sources') as sources, - json_extract_path_text(Properties, 'ResourceShareArn') as resource_share_arn, - json_extract_path_text(Properties, 'ResourceShareName') as resource_share_name, - json_extract_path_text(Properties, 'SubscriberRoleArn') as subscriber_role_arn, - json_extract_path_text(Properties, 'S3BucketArn') as s3_bucket_arn, - json_extract_path_text(Properties, 'SubscriberArn') as subscriber_arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityLake::Subscriber' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.SubscriberArn') as subscriber_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityLake::SubscriberNotification' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'NotificationConfiguration') as notification_configuration, + json_extract_path_text(Properties, 'SubscriberArn') as subscriber_arn, + json_extract_path_text(Properties, 'SubscriberEndpoint') as subscriber_endpoint + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SecurityLake::SubscriberNotification' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'SubscriberArn') as subscriber_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SecurityLake::SubscriberNotification' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: @@ -1379,6 +1631,48 @@ paths: schema: $ref: '#/components/x-cloud-control-schemas/ProgressEvent' description: Success + /?Action=CreateResource&Version=2021-09-30&__SubscriberNotification&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateSubscriberNotification + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateSubscriberNotificationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success x-stackQL-config: requestTranslate: algorithm: drop_double_underscore_params diff --git a/providers/src/aws/v00.00.00000/services/servicecatalog.yaml b/providers/src/aws/v00.00.00000/services/servicecatalog.yaml index f1921404..709251f1 100644 --- a/providers/src/aws/v00.00.00000/services/servicecatalog.yaml +++ b/providers/src/aws/v00.00.00000/services/servicecatalog.yaml @@ -844,7 +844,7 @@ components: x-cfn-type-name: AWS::ServiceCatalog::CloudFormationProvisionedProduct x-identifiers: - ProvisionedProductId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -861,9 +861,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -873,23 +873,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/cloud_formation_provisioned_products/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/cloud_formation_provisioned_products/methods/delete_resource' - cloud_formation_provisioned_product: - name: cloud_formation_provisioned_product - id: aws.servicecatalog.cloud_formation_provisioned_product - x-cfn-schema-name: CloudFormationProvisionedProduct - x-cfn-type-name: AWS::ServiceCatalog::CloudFormationProvisionedProduct - x-identifiers: - - ProvisionedProductId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -900,12 +886,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/cloud_formation_provisioned_products/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/cloud_formation_provisioned_products/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/cloud_formation_provisioned_product/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/cloud_formation_provisioned_products/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -930,7 +920,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -961,7 +951,7 @@ components: x-cfn-type-name: AWS::ServiceCatalog::ServiceAction x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -978,9 +968,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -990,41 +980,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/service_actions/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/service_actions/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ServiceCatalog::ServiceAction' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ServiceCatalog::ServiceAction' - AND region = 'us-east-1' - service_action: - name: service_action - id: aws.servicecatalog.service_action - x-cfn-schema-name: ServiceAction - x-cfn-type-name: AWS::ServiceCatalog::ServiceAction - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1035,12 +993,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/service_actions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/service_actions/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/service_action/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/service_actions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1055,20 +1017,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AcceptLanguage') as accept_language, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'DefinitionType') as definition_type, - json_extract_path_text(Properties, 'Definition') as definition, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ServiceCatalog::ServiceAction' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ServiceCatalog::ServiceAction' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AcceptLanguage') as accept_language, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'DefinitionType') as definition_type, + json_extract_path_text(Properties, 'Definition') as definition, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ServiceCatalog::ServiceAction' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ServiceCatalog::ServiceAction' + AND region = 'us-east-1' service_action_associations: name: service_action_associations id: aws.servicecatalog.service_action_associations @@ -1078,7 +1056,7 @@ components: - ProductId - ProvisioningArtifactId - ServiceActionId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1112,45 +1090,11 @@ components: - $ref: '#/components/x-stackQL-resources/service_action_associations/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/service_action_associations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ProductId') as product_id, - JSON_EXTRACT(Properties, '$.ProvisioningArtifactId') as provisioning_artifact_id, - JSON_EXTRACT(Properties, '$.ServiceActionId') as service_action_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ServiceCatalog::ServiceActionAssociation' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ProductId') as product_id, - json_extract_path_text(Properties, 'ProvisioningArtifactId') as provisioning_artifact_id, - json_extract_path_text(Properties, 'ServiceActionId') as service_action_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ServiceCatalog::ServiceActionAssociation' - AND region = 'us-east-1' - service_action_association: - name: service_action_association - id: aws.servicecatalog.service_action_association - x-cfn-schema-name: ServiceActionAssociation - x-cfn-type-name: AWS::ServiceCatalog::ServiceActionAssociation - x-identifiers: - - ProductId - - ProvisioningArtifactId - - ServiceActionId - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1162,17 +1106,37 @@ components: AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ProductId') as product_id, - json_extract_path_text(Properties, 'ProvisioningArtifactId') as provisioning_artifact_id, - json_extract_path_text(Properties, 'ServiceActionId') as service_action_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ServiceCatalog::ServiceActionAssociation' - AND data__Identifier = '||' + JSON_EXTRACT(Properties, '$.ProductId') as product_id, + JSON_EXTRACT(Properties, '$.ProvisioningArtifactId') as provisioning_artifact_id, + JSON_EXTRACT(Properties, '$.ServiceActionId') as service_action_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ServiceCatalog::ServiceActionAssociation' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ProductId') as product_id, + json_extract_path_text(Properties, 'ProvisioningArtifactId') as provisioning_artifact_id, + json_extract_path_text(Properties, 'ServiceActionId') as service_action_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ServiceCatalog::ServiceActionAssociation' + AND data__Identifier = '||' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ProductId') as product_id, + json_extract_path_text(Properties, 'ProvisioningArtifactId') as provisioning_artifact_id, + json_extract_path_text(Properties, 'ServiceActionId') as service_action_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ServiceCatalog::ServiceActionAssociation' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/servicecatalogappregistry.yaml b/providers/src/aws/v00.00.00000/services/servicecatalogappregistry.yaml index 9dcc976b..8685e233 100644 --- a/providers/src/aws/v00.00.00000/services/servicecatalogappregistry.yaml +++ b/providers/src/aws/v00.00.00000/services/servicecatalogappregistry.yaml @@ -824,7 +824,7 @@ components: x-cfn-type-name: AWS::ServiceCatalogAppRegistry::Application x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -841,9 +841,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -853,41 +853,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/applications/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/applications/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ServiceCatalogAppRegistry::Application' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ServiceCatalogAppRegistry::Application' - AND region = 'us-east-1' - application: - name: application - id: aws.servicecatalogappregistry.application - x-cfn-schema-name: Application - x-cfn-type-name: AWS::ServiceCatalogAppRegistry::Application - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -898,12 +866,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/applications/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/applications/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/application/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/applications/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -920,22 +892,38 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'ApplicationTagKey') as application_tag_key, - json_extract_path_text(Properties, 'ApplicationTagValue') as application_tag_value, - json_extract_path_text(Properties, 'ApplicationName') as application_name - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ServiceCatalogAppRegistry::Application' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ServiceCatalogAppRegistry::Application' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'ApplicationTagKey') as application_tag_key, + json_extract_path_text(Properties, 'ApplicationTagValue') as application_tag_value, + json_extract_path_text(Properties, 'ApplicationName') as application_name + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ServiceCatalogAppRegistry::Application' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ServiceCatalogAppRegistry::Application' + AND region = 'us-east-1' attribute_groups: name: attribute_groups id: aws.servicecatalogappregistry.attribute_groups @@ -943,7 +931,7 @@ components: x-cfn-type-name: AWS::ServiceCatalogAppRegistry::AttributeGroup x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -960,9 +948,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -972,41 +960,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/attribute_groups/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/attribute_groups/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ServiceCatalogAppRegistry::AttributeGroup' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ServiceCatalogAppRegistry::AttributeGroup' - AND region = 'us-east-1' - attribute_group: - name: attribute_group - id: aws.servicecatalogappregistry.attribute_group - x-cfn-schema-name: AttributeGroup - x-cfn-type-name: AWS::ServiceCatalogAppRegistry::AttributeGroup - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1017,12 +973,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/attribute_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/attribute_groups/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/attribute_group/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/attribute_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1037,20 +997,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Attributes') as attributes, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ServiceCatalogAppRegistry::AttributeGroup' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ServiceCatalogAppRegistry::AttributeGroup' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Attributes') as attributes, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ServiceCatalogAppRegistry::AttributeGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ServiceCatalogAppRegistry::AttributeGroup' + AND region = 'us-east-1' attribute_group_associations: name: attribute_group_associations id: aws.servicecatalogappregistry.attribute_group_associations @@ -1059,7 +1035,7 @@ components: x-identifiers: - ApplicationArn - AttributeGroupArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1093,42 +1069,11 @@ components: - $ref: '#/components/x-stackQL-resources/attribute_group_associations/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/attribute_group_associations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ApplicationArn') as application_arn, - JSON_EXTRACT(Properties, '$.AttributeGroupArn') as attribute_group_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ServiceCatalogAppRegistry::AttributeGroupAssociation' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ApplicationArn') as application_arn, - json_extract_path_text(Properties, 'AttributeGroupArn') as attribute_group_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ServiceCatalogAppRegistry::AttributeGroupAssociation' - AND region = 'us-east-1' - attribute_group_association: - name: attribute_group_association - id: aws.servicecatalogappregistry.attribute_group_association - x-cfn-schema-name: AttributeGroupAssociation - x-cfn-type-name: AWS::ServiceCatalogAppRegistry::AttributeGroupAssociation - x-identifiers: - - ApplicationArn - - AttributeGroupArn - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1141,18 +1086,36 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Application') as application, - json_extract_path_text(Properties, 'AttributeGroup') as attribute_group, - json_extract_path_text(Properties, 'ApplicationArn') as application_arn, - json_extract_path_text(Properties, 'AttributeGroupArn') as attribute_group_arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ServiceCatalogAppRegistry::AttributeGroupAssociation' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.ApplicationArn') as application_arn, + JSON_EXTRACT(Properties, '$.AttributeGroupArn') as attribute_group_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ServiceCatalogAppRegistry::AttributeGroupAssociation' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Application') as application, + json_extract_path_text(Properties, 'AttributeGroup') as attribute_group, + json_extract_path_text(Properties, 'ApplicationArn') as application_arn, + json_extract_path_text(Properties, 'AttributeGroupArn') as attribute_group_arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ServiceCatalogAppRegistry::AttributeGroupAssociation' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ApplicationArn') as application_arn, + json_extract_path_text(Properties, 'AttributeGroupArn') as attribute_group_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ServiceCatalogAppRegistry::AttributeGroupAssociation' + AND region = 'us-east-1' resource_associations: name: resource_associations id: aws.servicecatalogappregistry.resource_associations @@ -1162,7 +1125,7 @@ components: - ApplicationArn - ResourceArn - ResourceType - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1196,45 +1159,11 @@ components: - $ref: '#/components/x-stackQL-resources/resource_associations/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/resource_associations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ApplicationArn') as application_arn, - JSON_EXTRACT(Properties, '$.ResourceArn') as resource_arn, - JSON_EXTRACT(Properties, '$.ResourceType') as resource_type - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ServiceCatalogAppRegistry::ResourceAssociation' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ApplicationArn') as application_arn, - json_extract_path_text(Properties, 'ResourceArn') as resource_arn, - json_extract_path_text(Properties, 'ResourceType') as resource_type - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ServiceCatalogAppRegistry::ResourceAssociation' - AND region = 'us-east-1' - resource_association: - name: resource_association - id: aws.servicecatalogappregistry.resource_association - x-cfn-schema-name: ResourceAssociation - x-cfn-type-name: AWS::ServiceCatalogAppRegistry::ResourceAssociation - x-identifiers: - - ApplicationArn - - ResourceArn - - ResourceType - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1248,19 +1177,39 @@ components: AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Application') as application, - json_extract_path_text(Properties, 'Resource') as resource, - json_extract_path_text(Properties, 'ResourceType') as resource_type, - json_extract_path_text(Properties, 'ApplicationArn') as application_arn, - json_extract_path_text(Properties, 'ResourceArn') as resource_arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ServiceCatalogAppRegistry::ResourceAssociation' - AND data__Identifier = '||' + JSON_EXTRACT(Properties, '$.ApplicationArn') as application_arn, + JSON_EXTRACT(Properties, '$.ResourceArn') as resource_arn, + JSON_EXTRACT(Properties, '$.ResourceType') as resource_type + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ServiceCatalogAppRegistry::ResourceAssociation' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Application') as application, + json_extract_path_text(Properties, 'Resource') as resource, + json_extract_path_text(Properties, 'ResourceType') as resource_type, + json_extract_path_text(Properties, 'ApplicationArn') as application_arn, + json_extract_path_text(Properties, 'ResourceArn') as resource_arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::ServiceCatalogAppRegistry::ResourceAssociation' + AND data__Identifier = '||' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ApplicationArn') as application_arn, + json_extract_path_text(Properties, 'ResourceArn') as resource_arn, + json_extract_path_text(Properties, 'ResourceType') as resource_type + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::ServiceCatalogAppRegistry::ResourceAssociation' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/ses.yaml b/providers/src/aws/v00.00.00000/services/ses.yaml index 547ebd0e..e81d559b 100644 --- a/providers/src/aws/v00.00.00000/services/ses.yaml +++ b/providers/src/aws/v00.00.00000/services/ses.yaml @@ -1195,7 +1195,7 @@ components: x-cfn-type-name: AWS::SES::ConfigurationSet x-identifiers: - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1212,9 +1212,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1224,41 +1224,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/configuration_sets/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/configuration_sets/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SES::ConfigurationSet' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SES::ConfigurationSet' - AND region = 'us-east-1' - configuration_set: - name: configuration_set - id: aws.ses.configuration_set - x-cfn-schema-name: ConfigurationSet - x-cfn-type-name: AWS::SES::ConfigurationSet - x-identifiers: - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1269,12 +1237,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/configuration_sets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/configuration_sets/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/configuration_set/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/configuration_sets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1290,21 +1262,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'TrackingOptions') as tracking_options, - json_extract_path_text(Properties, 'DeliveryOptions') as delivery_options, - json_extract_path_text(Properties, 'ReputationOptions') as reputation_options, - json_extract_path_text(Properties, 'SendingOptions') as sending_options, - json_extract_path_text(Properties, 'SuppressionOptions') as suppression_options, - json_extract_path_text(Properties, 'VdmOptions') as vdm_options - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SES::ConfigurationSet' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SES::ConfigurationSet' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'TrackingOptions') as tracking_options, + json_extract_path_text(Properties, 'DeliveryOptions') as delivery_options, + json_extract_path_text(Properties, 'ReputationOptions') as reputation_options, + json_extract_path_text(Properties, 'SendingOptions') as sending_options, + json_extract_path_text(Properties, 'SuppressionOptions') as suppression_options, + json_extract_path_text(Properties, 'VdmOptions') as vdm_options + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SES::ConfigurationSet' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SES::ConfigurationSet' + AND region = 'us-east-1' configuration_set_event_destinations: name: configuration_set_event_destinations id: aws.ses.configuration_set_event_destinations @@ -1312,7 +1300,7 @@ components: x-cfn-type-name: AWS::SES::ConfigurationSetEventDestination x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1329,9 +1317,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1341,23 +1329,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/configuration_set_event_destinations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/configuration_set_event_destinations/methods/delete_resource' - configuration_set_event_destination: - name: configuration_set_event_destination - id: aws.ses.configuration_set_event_destination - x-cfn-schema-name: ConfigurationSetEventDestination - x-cfn-type-name: AWS::SES::ConfigurationSetEventDestination - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1368,12 +1342,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/configuration_set_event_destinations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/configuration_set_event_destinations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/configuration_set_event_destination/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/configuration_set_event_destinations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1385,7 +1363,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1403,7 +1381,7 @@ components: x-cfn-type-name: AWS::SES::ContactList x-identifiers: - ContactListName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1420,9 +1398,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1432,41 +1410,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/contact_lists/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/contact_lists/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ContactListName') as contact_list_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SES::ContactList' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ContactListName') as contact_list_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SES::ContactList' - AND region = 'us-east-1' - contact_list: - name: contact_list - id: aws.ses.contact_list - x-cfn-schema-name: ContactList - x-cfn-type-name: AWS::SES::ContactList - x-identifiers: - - ContactListName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1477,12 +1423,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/contact_lists/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/contact_lists/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/contact_list/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/contact_lists/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1495,18 +1445,34 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ContactListName') as contact_list_name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Topics') as topics, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SES::ContactList' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ContactListName') as contact_list_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SES::ContactList' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ContactListName') as contact_list_name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Topics') as topics, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SES::ContactList' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ContactListName') as contact_list_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SES::ContactList' + AND region = 'us-east-1' dedicated_ip_pools: name: dedicated_ip_pools id: aws.ses.dedicated_ip_pools @@ -1514,7 +1480,7 @@ components: x-cfn-type-name: AWS::SES::DedicatedIpPool x-identifiers: - PoolName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1531,9 +1497,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1543,41 +1509,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/dedicated_ip_pools/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/dedicated_ip_pools/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.PoolName') as pool_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SES::DedicatedIpPool' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'PoolName') as pool_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SES::DedicatedIpPool' - AND region = 'us-east-1' - dedicated_ip_pool: - name: dedicated_ip_pool - id: aws.ses.dedicated_ip_pool - x-cfn-schema-name: DedicatedIpPool - x-cfn-type-name: AWS::SES::DedicatedIpPool - x-identifiers: - - PoolName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1588,12 +1522,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/dedicated_ip_pools/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/dedicated_ip_pools/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/dedicated_ip_pool/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/dedicated_ip_pools/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1604,16 +1542,32 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'PoolName') as pool_name, - json_extract_path_text(Properties, 'ScalingMode') as scaling_mode - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SES::DedicatedIpPool' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.PoolName') as pool_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SES::DedicatedIpPool' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'PoolName') as pool_name, + json_extract_path_text(Properties, 'ScalingMode') as scaling_mode + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SES::DedicatedIpPool' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'PoolName') as pool_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SES::DedicatedIpPool' + AND region = 'us-east-1' email_identities: name: email_identities id: aws.ses.email_identities @@ -1621,7 +1575,7 @@ components: x-cfn-type-name: AWS::SES::EmailIdentity x-identifiers: - EmailIdentity - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1638,9 +1592,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1650,41 +1604,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/email_identities/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/email_identities/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.EmailIdentity') as email_identity - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SES::EmailIdentity' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'EmailIdentity') as email_identity - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SES::EmailIdentity' - AND region = 'us-east-1' - email_identity: - name: email_identity - id: aws.ses.email_identity - x-cfn-schema-name: EmailIdentity - x-cfn-type-name: AWS::SES::EmailIdentity - x-identifiers: - - EmailIdentity - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1695,12 +1617,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/email_identities/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/email_identities/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/email_identity/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/email_identities/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1721,26 +1647,42 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'EmailIdentity') as email_identity, - json_extract_path_text(Properties, 'ConfigurationSetAttributes') as configuration_set_attributes, - json_extract_path_text(Properties, 'DkimSigningAttributes') as dkim_signing_attributes, - json_extract_path_text(Properties, 'DkimAttributes') as dkim_attributes, - json_extract_path_text(Properties, 'MailFromAttributes') as mail_from_attributes, - json_extract_path_text(Properties, 'FeedbackAttributes') as feedback_attributes, - json_extract_path_text(Properties, 'DkimDNSTokenName1') as dkim_dns_token_name1, - json_extract_path_text(Properties, 'DkimDNSTokenName2') as dkim_dns_token_name2, - json_extract_path_text(Properties, 'DkimDNSTokenName3') as dkim_dns_token_name3, - json_extract_path_text(Properties, 'DkimDNSTokenValue1') as dkim_dns_token_value1, - json_extract_path_text(Properties, 'DkimDNSTokenValue2') as dkim_dns_token_value2, - json_extract_path_text(Properties, 'DkimDNSTokenValue3') as dkim_dns_token_value3 - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SES::EmailIdentity' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.EmailIdentity') as email_identity + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SES::EmailIdentity' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'EmailIdentity') as email_identity, + json_extract_path_text(Properties, 'ConfigurationSetAttributes') as configuration_set_attributes, + json_extract_path_text(Properties, 'DkimSigningAttributes') as dkim_signing_attributes, + json_extract_path_text(Properties, 'DkimAttributes') as dkim_attributes, + json_extract_path_text(Properties, 'MailFromAttributes') as mail_from_attributes, + json_extract_path_text(Properties, 'FeedbackAttributes') as feedback_attributes, + json_extract_path_text(Properties, 'DkimDNSTokenName1') as dkim_dns_token_name1, + json_extract_path_text(Properties, 'DkimDNSTokenName2') as dkim_dns_token_name2, + json_extract_path_text(Properties, 'DkimDNSTokenName3') as dkim_dns_token_name3, + json_extract_path_text(Properties, 'DkimDNSTokenValue1') as dkim_dns_token_value1, + json_extract_path_text(Properties, 'DkimDNSTokenValue2') as dkim_dns_token_value2, + json_extract_path_text(Properties, 'DkimDNSTokenValue3') as dkim_dns_token_value3 + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SES::EmailIdentity' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'EmailIdentity') as email_identity + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SES::EmailIdentity' + AND region = 'us-east-1' templates: name: templates id: aws.ses.templates @@ -1748,7 +1690,7 @@ components: x-cfn-type-name: AWS::SES::Template x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1765,9 +1707,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1777,41 +1719,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/templates/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/templates/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SES::Template' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SES::Template' - AND region = 'us-east-1' - template: - name: template - id: aws.ses.template - x-cfn-schema-name: Template - x-cfn-type-name: AWS::SES::Template - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1822,12 +1732,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/templates/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/templates/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/template/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/templates/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1838,16 +1752,32 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Template') as template - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SES::Template' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SES::Template' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Template') as template + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SES::Template' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SES::Template' + AND region = 'us-east-1' vdm_attributes: name: vdm_attributes id: aws.ses.vdm_attributes @@ -1855,8 +1785,23 @@ components: x-cfn-type-name: AWS::SES::VdmAttributes x-identifiers: - VdmAttributesResourceId - x-type: get + x-type: cloud_control methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__VdmAttributes&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SES::VdmAttributes" + } + response: + mediaType: application/json + openAPIDocKey: '200' update_resource: operation: $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' @@ -1869,13 +1814,29 @@ components: response: mediaType: application/json openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SES::VdmAttributes" + } + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/vdm_attributes/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/vdm_attributes/methods/delete_resource' update: - $ref: '#/components/x-stackQL-resources/vdm_attributes/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1887,7 +1848,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, diff --git a/providers/src/aws/v00.00.00000/services/shield.yaml b/providers/src/aws/v00.00.00000/services/shield.yaml index 71425131..07e5182f 100644 --- a/providers/src/aws/v00.00.00000/services/shield.yaml +++ b/providers/src/aws/v00.00.00000/services/shield.yaml @@ -451,7 +451,8 @@ components: - s3:GetBucketPolicy - s3:PutBucketPolicy - s3:DeleteBucketPolicy - list: [] + list: + - shield:DescribeDRTAccess EmergencyContact: description: An emergency contact is used by Shield Response Team (SRT) to contact you for escalations to the SRT and to initiate proactive customer support. An emergency contact requires an email address. type: object @@ -996,7 +997,7 @@ components: x-cfn-type-name: AWS::Shield::DRTAccess x-identifiers: - AccountId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1013,9 +1014,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1025,23 +1026,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/drt_accesses/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/drt_accesses/methods/delete_resource' - drt_access: - name: drt_access - id: aws.shield.drt_access - x-cfn-schema-name: DRTAccess - x-cfn-type-name: AWS::Shield::DRTAccess - x-identifiers: - - AccountId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1052,12 +1039,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/drt_accesses/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/drt_accesses/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/drt_access/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/drt_accesses/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1069,17 +1060,33 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AccountId') as account_id, - json_extract_path_text(Properties, 'LogBucketList') as log_bucket_list, - json_extract_path_text(Properties, 'RoleArn') as role_arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Shield::DRTAccess' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.AccountId') as account_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Shield::DRTAccess' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AccountId') as account_id, + json_extract_path_text(Properties, 'LogBucketList') as log_bucket_list, + json_extract_path_text(Properties, 'RoleArn') as role_arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Shield::DRTAccess' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AccountId') as account_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Shield::DRTAccess' + AND region = 'us-east-1' proactive_engagements: name: proactive_engagements id: aws.shield.proactive_engagements @@ -1087,7 +1094,7 @@ components: x-cfn-type-name: AWS::Shield::ProactiveEngagement x-identifiers: - AccountId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1104,9 +1111,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1116,41 +1123,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/proactive_engagements/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/proactive_engagements/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AccountId') as account_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Shield::ProactiveEngagement' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AccountId') as account_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Shield::ProactiveEngagement' - AND region = 'us-east-1' - proactive_engagement: - name: proactive_engagement - id: aws.shield.proactive_engagement - x-cfn-schema-name: ProactiveEngagement - x-cfn-type-name: AWS::Shield::ProactiveEngagement - x-identifiers: - - AccountId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1161,12 +1136,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/proactive_engagements/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/proactive_engagements/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/proactive_engagement/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/proactive_engagements/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1178,17 +1157,33 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AccountId') as account_id, - json_extract_path_text(Properties, 'ProactiveEngagementStatus') as proactive_engagement_status, - json_extract_path_text(Properties, 'EmergencyContactList') as emergency_contact_list - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Shield::ProactiveEngagement' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.AccountId') as account_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Shield::ProactiveEngagement' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AccountId') as account_id, + json_extract_path_text(Properties, 'ProactiveEngagementStatus') as proactive_engagement_status, + json_extract_path_text(Properties, 'EmergencyContactList') as emergency_contact_list + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Shield::ProactiveEngagement' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AccountId') as account_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Shield::ProactiveEngagement' + AND region = 'us-east-1' protections: name: protections id: aws.shield.protections @@ -1196,7 +1191,7 @@ components: x-cfn-type-name: AWS::Shield::Protection x-identifiers: - ProtectionArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1213,9 +1208,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1225,41 +1220,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/protections/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/protections/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ProtectionArn') as protection_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Shield::Protection' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ProtectionArn') as protection_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Shield::Protection' - AND region = 'us-east-1' - protection: - name: protection - id: aws.shield.protection - x-cfn-schema-name: Protection - x-cfn-type-name: AWS::Shield::Protection - x-identifiers: - - ProtectionArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1270,12 +1233,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/protections/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/protections/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/protection/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/protections/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1291,21 +1258,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ProtectionId') as protection_id, - json_extract_path_text(Properties, 'ProtectionArn') as protection_arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'ResourceArn') as resource_arn, - json_extract_path_text(Properties, 'HealthCheckArns') as health_check_arns, - json_extract_path_text(Properties, 'ApplicationLayerAutomaticResponseConfiguration') as application_layer_automatic_response_configuration, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Shield::Protection' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ProtectionArn') as protection_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Shield::Protection' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ProtectionId') as protection_id, + json_extract_path_text(Properties, 'ProtectionArn') as protection_arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'ResourceArn') as resource_arn, + json_extract_path_text(Properties, 'HealthCheckArns') as health_check_arns, + json_extract_path_text(Properties, 'ApplicationLayerAutomaticResponseConfiguration') as application_layer_automatic_response_configuration, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Shield::Protection' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ProtectionArn') as protection_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Shield::Protection' + AND region = 'us-east-1' protection_groups: name: protection_groups id: aws.shield.protection_groups @@ -1313,7 +1296,7 @@ components: x-cfn-type-name: AWS::Shield::ProtectionGroup x-identifiers: - ProtectionGroupArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1330,9 +1313,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1342,41 +1325,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/protection_groups/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/protection_groups/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ProtectionGroupArn') as protection_group_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Shield::ProtectionGroup' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ProtectionGroupArn') as protection_group_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Shield::ProtectionGroup' - AND region = 'us-east-1' - protection_group: - name: protection_group - id: aws.shield.protection_group - x-cfn-schema-name: ProtectionGroup - x-cfn-type-name: AWS::Shield::ProtectionGroup - x-identifiers: - - ProtectionGroupArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1387,12 +1338,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/protection_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/protection_groups/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/protection_group/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/protection_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1408,21 +1363,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ProtectionGroupId') as protection_group_id, - json_extract_path_text(Properties, 'ProtectionGroupArn') as protection_group_arn, - json_extract_path_text(Properties, 'Aggregation') as aggregation, - json_extract_path_text(Properties, 'Pattern') as pattern, - json_extract_path_text(Properties, 'Members') as members, - json_extract_path_text(Properties, 'ResourceType') as resource_type, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Shield::ProtectionGroup' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ProtectionGroupArn') as protection_group_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Shield::ProtectionGroup' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ProtectionGroupId') as protection_group_id, + json_extract_path_text(Properties, 'ProtectionGroupArn') as protection_group_arn, + json_extract_path_text(Properties, 'Aggregation') as aggregation, + json_extract_path_text(Properties, 'Pattern') as pattern, + json_extract_path_text(Properties, 'Members') as members, + json_extract_path_text(Properties, 'ResourceType') as resource_type, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Shield::ProtectionGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ProtectionGroupArn') as protection_group_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Shield::ProtectionGroup' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/signer.yaml b/providers/src/aws/v00.00.00000/services/signer.yaml index afdbe57f..cab93c14 100644 --- a/providers/src/aws/v00.00.00000/services/signer.yaml +++ b/providers/src/aws/v00.00.00000/services/signer.yaml @@ -614,7 +614,7 @@ components: x-identifiers: - StatementId - ProfileName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -648,42 +648,11 @@ components: - $ref: '#/components/x-stackQL-resources/profile_permissions/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/profile_permissions/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.StatementId') as statement_id, - JSON_EXTRACT(Properties, '$.ProfileName') as profile_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Signer::ProfilePermission' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'StatementId') as statement_id, - json_extract_path_text(Properties, 'ProfileName') as profile_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Signer::ProfilePermission' - AND region = 'us-east-1' - profile_permission: - name: profile_permission - id: aws.signer.profile_permission - x-cfn-schema-name: ProfilePermission - x-cfn-type-name: AWS::Signer::ProfilePermission - x-identifiers: - - StatementId - - ProfileName - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -697,19 +666,37 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ProfileName') as profile_name, - json_extract_path_text(Properties, 'ProfileVersion') as profile_version, - json_extract_path_text(Properties, 'Action') as action, - json_extract_path_text(Properties, 'Principal') as principal, - json_extract_path_text(Properties, 'StatementId') as statement_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Signer::ProfilePermission' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.StatementId') as statement_id, + JSON_EXTRACT(Properties, '$.ProfileName') as profile_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Signer::ProfilePermission' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ProfileName') as profile_name, + json_extract_path_text(Properties, 'ProfileVersion') as profile_version, + json_extract_path_text(Properties, 'Action') as action, + json_extract_path_text(Properties, 'Principal') as principal, + json_extract_path_text(Properties, 'StatementId') as statement_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Signer::ProfilePermission' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'StatementId') as statement_id, + json_extract_path_text(Properties, 'ProfileName') as profile_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Signer::ProfilePermission' + AND region = 'us-east-1' signing_profiles: name: signing_profiles id: aws.signer.signing_profiles @@ -717,7 +704,7 @@ components: x-cfn-type-name: AWS::Signer::SigningProfile x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -734,9 +721,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -746,41 +733,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/signing_profiles/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/signing_profiles/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Signer::SigningProfile' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Signer::SigningProfile' - AND region = 'us-east-1' - signing_profile: - name: signing_profile - id: aws.signer.signing_profile - x-cfn-schema-name: SigningProfile - x-cfn-type-name: AWS::Signer::SigningProfile - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -791,12 +746,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/signing_profiles/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/signing_profiles/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/signing_profile/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/signing_profiles/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -812,21 +771,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ProfileName') as profile_name, - json_extract_path_text(Properties, 'ProfileVersion') as profile_version, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'ProfileVersionArn') as profile_version_arn, - json_extract_path_text(Properties, 'SignatureValidityPeriod') as signature_validity_period, - json_extract_path_text(Properties, 'PlatformId') as platform_id, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Signer::SigningProfile' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Signer::SigningProfile' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ProfileName') as profile_name, + json_extract_path_text(Properties, 'ProfileVersion') as profile_version, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'ProfileVersionArn') as profile_version_arn, + json_extract_path_text(Properties, 'SignatureValidityPeriod') as signature_validity_period, + json_extract_path_text(Properties, 'PlatformId') as platform_id, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Signer::SigningProfile' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Signer::SigningProfile' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/simspaceweaver.yaml b/providers/src/aws/v00.00.00000/services/simspaceweaver.yaml index acffe619..b1ee3a50 100644 --- a/providers/src/aws/v00.00.00000/services/simspaceweaver.yaml +++ b/providers/src/aws/v00.00.00000/services/simspaceweaver.yaml @@ -523,7 +523,7 @@ components: x-cfn-type-name: AWS::SimSpaceWeaver::Simulation x-identifiers: - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -540,9 +540,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -552,41 +552,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/simulations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/simulations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SimSpaceWeaver::Simulation' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SimSpaceWeaver::Simulation' - AND region = 'us-east-1' - simulation: - name: simulation - id: aws.simspaceweaver.simulation - x-cfn-schema-name: Simulation - x-cfn-type-name: AWS::SimSpaceWeaver::Simulation - x-identifiers: - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -597,12 +565,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/simulations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/simulations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/simulation/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/simulations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -617,20 +589,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'SchemaS3Location') as schema_s3_location, - json_extract_path_text(Properties, 'DescribePayload') as describe_payload, - json_extract_path_text(Properties, 'MaximumDuration') as maximum_duration, - json_extract_path_text(Properties, 'SnapshotS3Location') as snapshot_s3_location - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SimSpaceWeaver::Simulation' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SimSpaceWeaver::Simulation' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'SchemaS3Location') as schema_s3_location, + json_extract_path_text(Properties, 'DescribePayload') as describe_payload, + json_extract_path_text(Properties, 'MaximumDuration') as maximum_duration, + json_extract_path_text(Properties, 'SnapshotS3Location') as snapshot_s3_location + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SimSpaceWeaver::Simulation' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SimSpaceWeaver::Simulation' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/sns.yaml b/providers/src/aws/v00.00.00000/services/sns.yaml index b54d042d..06169fb8 100644 --- a/providers/src/aws/v00.00.00000/services/sns.yaml +++ b/providers/src/aws/v00.00.00000/services/sns.yaml @@ -751,7 +751,7 @@ components: x-cfn-type-name: AWS::SNS::Topic x-identifiers: - TopicArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -768,9 +768,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -780,41 +780,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/topics/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/topics/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.TopicArn') as topic_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SNS::Topic' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'TopicArn') as topic_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SNS::Topic' - AND region = 'us-east-1' - topic: - name: topic - id: aws.sns.topic - x-cfn-schema-name: Topic - x-cfn-type-name: AWS::SNS::Topic - x-identifiers: - - TopicArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -825,12 +793,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/topics/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/topics/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/topic/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/topics/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -852,27 +824,43 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'DisplayName') as display_name, - json_extract_path_text(Properties, 'KmsMasterKeyId') as kms_master_key_id, - json_extract_path_text(Properties, 'DataProtectionPolicy') as data_protection_policy, - json_extract_path_text(Properties, 'Subscription') as subscription, - json_extract_path_text(Properties, 'FifoTopic') as fifo_topic, - json_extract_path_text(Properties, 'ContentBasedDeduplication') as content_based_deduplication, - json_extract_path_text(Properties, 'ArchivePolicy') as archive_policy, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'TopicName') as topic_name, - json_extract_path_text(Properties, 'TopicArn') as topic_arn, - json_extract_path_text(Properties, 'SignatureVersion') as signature_version, - json_extract_path_text(Properties, 'TracingConfig') as tracing_config, - json_extract_path_text(Properties, 'DeliveryStatusLogging') as delivery_status_logging - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SNS::Topic' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.TopicArn') as topic_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SNS::Topic' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DisplayName') as display_name, + json_extract_path_text(Properties, 'KmsMasterKeyId') as kms_master_key_id, + json_extract_path_text(Properties, 'DataProtectionPolicy') as data_protection_policy, + json_extract_path_text(Properties, 'Subscription') as subscription, + json_extract_path_text(Properties, 'FifoTopic') as fifo_topic, + json_extract_path_text(Properties, 'ContentBasedDeduplication') as content_based_deduplication, + json_extract_path_text(Properties, 'ArchivePolicy') as archive_policy, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'TopicName') as topic_name, + json_extract_path_text(Properties, 'TopicArn') as topic_arn, + json_extract_path_text(Properties, 'SignatureVersion') as signature_version, + json_extract_path_text(Properties, 'TracingConfig') as tracing_config, + json_extract_path_text(Properties, 'DeliveryStatusLogging') as delivery_status_logging + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SNS::Topic' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'TopicArn') as topic_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SNS::Topic' + AND region = 'us-east-1' topic_inline_policies: name: topic_inline_policies id: aws.sns.topic_inline_policies @@ -880,7 +868,7 @@ components: x-cfn-type-name: AWS::SNS::TopicInlinePolicy x-identifiers: - TopicArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -897,9 +885,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -909,23 +897,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/topic_inline_policies/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/topic_inline_policies/methods/delete_resource' - topic_inline_policy: - name: topic_inline_policy - id: aws.sns.topic_inline_policy - x-cfn-schema-name: TopicInlinePolicy - x-cfn-type-name: AWS::SNS::TopicInlinePolicy - x-identifiers: - - TopicArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -936,12 +910,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/topic_inline_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/topic_inline_policies/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/topic_inline_policy/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/topic_inline_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -952,7 +930,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, diff --git a/providers/src/aws/v00.00.00000/services/sqs.yaml b/providers/src/aws/v00.00.00000/services/sqs.yaml index 2d45bfc3..2f644dba 100644 --- a/providers/src/aws/v00.00.00000/services/sqs.yaml +++ b/providers/src/aws/v00.00.00000/services/sqs.yaml @@ -736,7 +736,7 @@ components: x-cfn-type-name: AWS::SQS::Queue x-identifiers: - QueueUrl - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -753,9 +753,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -765,41 +765,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/queues/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/queues/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.QueueUrl') as queue_url - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SQS::Queue' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'QueueUrl') as queue_url - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SQS::Queue' - AND region = 'us-east-1' - queue: - name: queue - id: aws.sqs.queue - x-cfn-schema-name: Queue - x-cfn-type-name: AWS::SQS::Queue - x-identifiers: - - QueueUrl - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -810,12 +778,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/queues/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/queues/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/queue/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/queues/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -842,32 +814,48 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'QueueUrl') as queue_url, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'ContentBasedDeduplication') as content_based_deduplication, - json_extract_path_text(Properties, 'DeduplicationScope') as deduplication_scope, - json_extract_path_text(Properties, 'DelaySeconds') as delay_seconds, - json_extract_path_text(Properties, 'FifoQueue') as fifo_queue, - json_extract_path_text(Properties, 'FifoThroughputLimit') as fifo_throughput_limit, - json_extract_path_text(Properties, 'KmsDataKeyReusePeriodSeconds') as kms_data_key_reuse_period_seconds, - json_extract_path_text(Properties, 'KmsMasterKeyId') as kms_master_key_id, - json_extract_path_text(Properties, 'SqsManagedSseEnabled') as sqs_managed_sse_enabled, - json_extract_path_text(Properties, 'MaximumMessageSize') as maximum_message_size, - json_extract_path_text(Properties, 'MessageRetentionPeriod') as message_retention_period, - json_extract_path_text(Properties, 'QueueName') as queue_name, - json_extract_path_text(Properties, 'ReceiveMessageWaitTimeSeconds') as receive_message_wait_time_seconds, - json_extract_path_text(Properties, 'RedriveAllowPolicy') as redrive_allow_policy, - json_extract_path_text(Properties, 'RedrivePolicy') as redrive_policy, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'VisibilityTimeout') as visibility_timeout - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SQS::Queue' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.QueueUrl') as queue_url + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SQS::Queue' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'QueueUrl') as queue_url, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'ContentBasedDeduplication') as content_based_deduplication, + json_extract_path_text(Properties, 'DeduplicationScope') as deduplication_scope, + json_extract_path_text(Properties, 'DelaySeconds') as delay_seconds, + json_extract_path_text(Properties, 'FifoQueue') as fifo_queue, + json_extract_path_text(Properties, 'FifoThroughputLimit') as fifo_throughput_limit, + json_extract_path_text(Properties, 'KmsDataKeyReusePeriodSeconds') as kms_data_key_reuse_period_seconds, + json_extract_path_text(Properties, 'KmsMasterKeyId') as kms_master_key_id, + json_extract_path_text(Properties, 'SqsManagedSseEnabled') as sqs_managed_sse_enabled, + json_extract_path_text(Properties, 'MaximumMessageSize') as maximum_message_size, + json_extract_path_text(Properties, 'MessageRetentionPeriod') as message_retention_period, + json_extract_path_text(Properties, 'QueueName') as queue_name, + json_extract_path_text(Properties, 'ReceiveMessageWaitTimeSeconds') as receive_message_wait_time_seconds, + json_extract_path_text(Properties, 'RedriveAllowPolicy') as redrive_allow_policy, + json_extract_path_text(Properties, 'RedrivePolicy') as redrive_policy, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'VisibilityTimeout') as visibility_timeout + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SQS::Queue' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'QueueUrl') as queue_url + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SQS::Queue' + AND region = 'us-east-1' queue_inline_policies: name: queue_inline_policies id: aws.sqs.queue_inline_policies @@ -875,7 +863,7 @@ components: x-cfn-type-name: AWS::SQS::QueueInlinePolicy x-identifiers: - Queue - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -892,9 +880,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -904,23 +892,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/queue_inline_policies/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/queue_inline_policies/methods/delete_resource' - queue_inline_policy: - name: queue_inline_policy - id: aws.sqs.queue_inline_policy - x-cfn-schema-name: QueueInlinePolicy - x-cfn-type-name: AWS::SQS::QueueInlinePolicy - x-identifiers: - - Queue - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -931,12 +905,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/queue_inline_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/queue_inline_policies/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/queue_inline_policy/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/queue_inline_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -947,7 +925,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, diff --git a/providers/src/aws/v00.00.00000/services/ssm.yaml b/providers/src/aws/v00.00.00000/services/ssm.yaml index 739d10d1..f343550e 100644 --- a/providers/src/aws/v00.00.00000/services/ssm.yaml +++ b/providers/src/aws/v00.00.00000/services/ssm.yaml @@ -1251,6 +1251,8 @@ components: - SyncName x-required-properties: - SyncName + x-tagging: + taggable: false x-required-permissions: create: - ssm:CreateResourceDataSync @@ -1807,7 +1809,7 @@ components: x-cfn-type-name: AWS::SSM::Association x-identifiers: - AssociationId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1824,9 +1826,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1836,41 +1838,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/associations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/associations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AssociationId') as association_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SSM::Association' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AssociationId') as association_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SSM::Association' - AND region = 'us-east-1' - association: - name: association - id: aws.ssm.association - x-cfn-schema-name: Association - x-cfn-type-name: AWS::SSM::Association - x-identifiers: - - AssociationId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1881,12 +1851,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/associations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/association/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/associations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1913,32 +1887,48 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AssociationName') as association_name, - json_extract_path_text(Properties, 'CalendarNames') as calendar_names, - json_extract_path_text(Properties, 'ScheduleExpression') as schedule_expression, - json_extract_path_text(Properties, 'MaxErrors') as max_errors, - json_extract_path_text(Properties, 'Parameters') as parameters, - json_extract_path_text(Properties, 'InstanceId') as instance_id, - json_extract_path_text(Properties, 'WaitForSuccessTimeoutSeconds') as wait_for_success_timeout_seconds, - json_extract_path_text(Properties, 'MaxConcurrency') as max_concurrency, - json_extract_path_text(Properties, 'ComplianceSeverity') as compliance_severity, - json_extract_path_text(Properties, 'Targets') as targets, - json_extract_path_text(Properties, 'SyncCompliance') as sync_compliance, - json_extract_path_text(Properties, 'OutputLocation') as output_location, - json_extract_path_text(Properties, 'ScheduleOffset') as schedule_offset, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'ApplyOnlyAtCronInterval') as apply_only_at_cron_interval, - json_extract_path_text(Properties, 'DocumentVersion') as document_version, - json_extract_path_text(Properties, 'AssociationId') as association_id, - json_extract_path_text(Properties, 'AutomationTargetParameterName') as automation_target_parameter_name - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SSM::Association' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.AssociationId') as association_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SSM::Association' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AssociationName') as association_name, + json_extract_path_text(Properties, 'CalendarNames') as calendar_names, + json_extract_path_text(Properties, 'ScheduleExpression') as schedule_expression, + json_extract_path_text(Properties, 'MaxErrors') as max_errors, + json_extract_path_text(Properties, 'Parameters') as parameters, + json_extract_path_text(Properties, 'InstanceId') as instance_id, + json_extract_path_text(Properties, 'WaitForSuccessTimeoutSeconds') as wait_for_success_timeout_seconds, + json_extract_path_text(Properties, 'MaxConcurrency') as max_concurrency, + json_extract_path_text(Properties, 'ComplianceSeverity') as compliance_severity, + json_extract_path_text(Properties, 'Targets') as targets, + json_extract_path_text(Properties, 'SyncCompliance') as sync_compliance, + json_extract_path_text(Properties, 'OutputLocation') as output_location, + json_extract_path_text(Properties, 'ScheduleOffset') as schedule_offset, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'ApplyOnlyAtCronInterval') as apply_only_at_cron_interval, + json_extract_path_text(Properties, 'DocumentVersion') as document_version, + json_extract_path_text(Properties, 'AssociationId') as association_id, + json_extract_path_text(Properties, 'AutomationTargetParameterName') as automation_target_parameter_name + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SSM::Association' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AssociationId') as association_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SSM::Association' + AND region = 'us-east-1' documents: name: documents id: aws.ssm.documents @@ -1946,7 +1936,7 @@ components: x-cfn-type-name: AWS::SSM::Document x-identifiers: - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1963,9 +1953,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1975,41 +1965,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/documents/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/documents/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SSM::Document' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SSM::Document' - AND region = 'us-east-1' - document: - name: document - id: aws.ssm.document - x-cfn-schema-name: Document - x-cfn-type-name: AWS::SSM::Document - x-identifiers: - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2020,12 +1978,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/documents/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/documents/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/document/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/documents/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2044,24 +2006,40 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Content') as content, - json_extract_path_text(Properties, 'Attachments') as attachments, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'VersionName') as version_name, - json_extract_path_text(Properties, 'DocumentType') as document_type, - json_extract_path_text(Properties, 'DocumentFormat') as document_format, - json_extract_path_text(Properties, 'TargetType') as target_type, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Requires') as requires, - json_extract_path_text(Properties, 'UpdateMethod') as update_method - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SSM::Document' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SSM::Document' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Content') as content, + json_extract_path_text(Properties, 'Attachments') as attachments, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'VersionName') as version_name, + json_extract_path_text(Properties, 'DocumentType') as document_type, + json_extract_path_text(Properties, 'DocumentFormat') as document_format, + json_extract_path_text(Properties, 'TargetType') as target_type, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Requires') as requires, + json_extract_path_text(Properties, 'UpdateMethod') as update_method + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SSM::Document' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SSM::Document' + AND region = 'us-east-1' parameters: name: parameters id: aws.ssm.parameters @@ -2069,7 +2047,7 @@ components: x-cfn-type-name: AWS::SSM::Parameter x-identifiers: - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2086,9 +2064,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2098,41 +2076,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/parameters/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/parameters/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SSM::Parameter' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SSM::Parameter' - AND region = 'us-east-1' - parameter: - name: parameter - id: aws.ssm.parameter - x-cfn-schema-name: Parameter - x-cfn-type-name: AWS::SSM::Parameter - x-identifiers: - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2143,12 +2089,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/parameters/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/parameters/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/parameter/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/parameters/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2166,23 +2116,39 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Type') as type, - json_extract_path_text(Properties, 'Value') as value, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Policies') as policies, - json_extract_path_text(Properties, 'AllowedPattern') as allowed_pattern, - json_extract_path_text(Properties, 'Tier') as tier, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'DataType') as data_type, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SSM::Parameter' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SSM::Parameter' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'Value') as value, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Policies') as policies, + json_extract_path_text(Properties, 'AllowedPattern') as allowed_pattern, + json_extract_path_text(Properties, 'Tier') as tier, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'DataType') as data_type, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SSM::Parameter' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SSM::Parameter' + AND region = 'us-east-1' patch_baselines: name: patch_baselines id: aws.ssm.patch_baselines @@ -2190,7 +2156,7 @@ components: x-cfn-type-name: AWS::SSM::PatchBaseline x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2207,9 +2173,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2219,41 +2185,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/patch_baselines/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/patch_baselines/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SSM::PatchBaseline' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SSM::PatchBaseline' - AND region = 'us-east-1' - patch_baseline: - name: patch_baseline - id: aws.ssm.patch_baseline - x-cfn-schema-name: PatchBaseline - x-cfn-type-name: AWS::SSM::PatchBaseline - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2264,12 +2198,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/patch_baselines/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/patch_baselines/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/patch_baseline/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/patch_baselines/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2293,29 +2231,45 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'DefaultBaseline') as default_baseline, - json_extract_path_text(Properties, 'OperatingSystem') as operating_system, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'ApprovalRules') as approval_rules, - json_extract_path_text(Properties, 'Sources') as sources, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'RejectedPatches') as rejected_patches, - json_extract_path_text(Properties, 'ApprovedPatches') as approved_patches, - json_extract_path_text(Properties, 'RejectedPatchesAction') as rejected_patches_action, - json_extract_path_text(Properties, 'PatchGroups') as patch_groups, - json_extract_path_text(Properties, 'ApprovedPatchesComplianceLevel') as approved_patches_compliance_level, - json_extract_path_text(Properties, 'ApprovedPatchesEnableNonSecurity') as approved_patches_enable_non_security, - json_extract_path_text(Properties, 'GlobalFilters') as global_filters, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SSM::PatchBaseline' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SSM::PatchBaseline' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'DefaultBaseline') as default_baseline, + json_extract_path_text(Properties, 'OperatingSystem') as operating_system, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'ApprovalRules') as approval_rules, + json_extract_path_text(Properties, 'Sources') as sources, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'RejectedPatches') as rejected_patches, + json_extract_path_text(Properties, 'ApprovedPatches') as approved_patches, + json_extract_path_text(Properties, 'RejectedPatchesAction') as rejected_patches_action, + json_extract_path_text(Properties, 'PatchGroups') as patch_groups, + json_extract_path_text(Properties, 'ApprovedPatchesComplianceLevel') as approved_patches_compliance_level, + json_extract_path_text(Properties, 'ApprovedPatchesEnableNonSecurity') as approved_patches_enable_non_security, + json_extract_path_text(Properties, 'GlobalFilters') as global_filters, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SSM::PatchBaseline' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SSM::PatchBaseline' + AND region = 'us-east-1' resource_data_syncs: name: resource_data_syncs id: aws.ssm.resource_data_syncs @@ -2323,7 +2277,7 @@ components: x-cfn-type-name: AWS::SSM::ResourceDataSync x-identifiers: - SyncName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2340,9 +2294,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2352,41 +2306,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/resource_data_syncs/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/resource_data_syncs/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.SyncName') as sync_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SSM::ResourceDataSync' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'SyncName') as sync_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SSM::ResourceDataSync' - AND region = 'us-east-1' - resource_data_sync: - name: resource_data_sync - id: aws.ssm.resource_data_sync - x-cfn-schema-name: ResourceDataSync - x-cfn-type-name: AWS::SSM::ResourceDataSync - x-identifiers: - - SyncName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2397,12 +2319,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/resource_data_syncs/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/resource_data_syncs/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/resource_data_sync/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/resource_data_syncs/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2420,23 +2346,39 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'S3Destination') as s3_destination, - json_extract_path_text(Properties, 'KMSKeyArn') as kms_key_arn, - json_extract_path_text(Properties, 'SyncSource') as sync_source, - json_extract_path_text(Properties, 'BucketName') as bucket_name, - json_extract_path_text(Properties, 'BucketRegion') as bucket_region, - json_extract_path_text(Properties, 'SyncFormat') as sync_format, - json_extract_path_text(Properties, 'SyncName') as sync_name, - json_extract_path_text(Properties, 'SyncType') as sync_type, - json_extract_path_text(Properties, 'BucketPrefix') as bucket_prefix - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SSM::ResourceDataSync' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.SyncName') as sync_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SSM::ResourceDataSync' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'S3Destination') as s3_destination, + json_extract_path_text(Properties, 'KMSKeyArn') as kms_key_arn, + json_extract_path_text(Properties, 'SyncSource') as sync_source, + json_extract_path_text(Properties, 'BucketName') as bucket_name, + json_extract_path_text(Properties, 'BucketRegion') as bucket_region, + json_extract_path_text(Properties, 'SyncFormat') as sync_format, + json_extract_path_text(Properties, 'SyncName') as sync_name, + json_extract_path_text(Properties, 'SyncType') as sync_type, + json_extract_path_text(Properties, 'BucketPrefix') as bucket_prefix + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SSM::ResourceDataSync' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'SyncName') as sync_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SSM::ResourceDataSync' + AND region = 'us-east-1' resource_policies: name: resource_policies id: aws.ssm.resource_policies @@ -2445,7 +2387,7 @@ components: x-identifiers: - PolicyId - ResourceArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2462,9 +2404,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2474,44 +2416,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/resource_policies/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/resource_policies/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.PolicyId') as policy_id, - JSON_EXTRACT(Properties, '$.ResourceArn') as resource_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SSM::ResourcePolicy' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'PolicyId') as policy_id, - json_extract_path_text(Properties, 'ResourceArn') as resource_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SSM::ResourcePolicy' - AND region = 'us-east-1' - resource_policy: - name: resource_policy - id: aws.ssm.resource_policy - x-cfn-schema-name: ResourcePolicy - x-cfn-type-name: AWS::SSM::ResourcePolicy - x-identifiers: - - PolicyId - - ResourceArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2522,12 +2429,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/resource_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/resource_policies/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/resource_policy/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/resource_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2540,18 +2451,36 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ResourceArn') as resource_arn, - json_extract_path_text(Properties, 'Policy') as policy, - json_extract_path_text(Properties, 'PolicyId') as policy_id, - json_extract_path_text(Properties, 'PolicyHash') as policy_hash - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SSM::ResourcePolicy' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.PolicyId') as policy_id, + JSON_EXTRACT(Properties, '$.ResourceArn') as resource_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SSM::ResourcePolicy' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ResourceArn') as resource_arn, + json_extract_path_text(Properties, 'Policy') as policy, + json_extract_path_text(Properties, 'PolicyId') as policy_id, + json_extract_path_text(Properties, 'PolicyHash') as policy_hash + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SSM::ResourcePolicy' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'PolicyId') as policy_id, + json_extract_path_text(Properties, 'ResourceArn') as resource_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SSM::ResourcePolicy' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/ssmcontacts.yaml b/providers/src/aws/v00.00.00000/services/ssmcontacts.yaml index 5ee9516b..39120850 100644 --- a/providers/src/aws/v00.00.00000/services/ssmcontacts.yaml +++ b/providers/src/aws/v00.00.00000/services/ssmcontacts.yaml @@ -1035,7 +1035,7 @@ components: x-cfn-type-name: AWS::SSMContacts::Contact x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1052,9 +1052,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1064,41 +1064,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/contacts/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/contacts/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SSMContacts::Contact' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SSMContacts::Contact' - AND region = 'us-east-1' - contact: - name: contact - id: aws.ssmcontacts.contact - x-cfn-schema-name: Contact - x-cfn-type-name: AWS::SSMContacts::Contact - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1109,12 +1077,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/contacts/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/contacts/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/contact/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/contacts/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1128,19 +1100,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Alias') as alias, - json_extract_path_text(Properties, 'DisplayName') as display_name, - json_extract_path_text(Properties, 'Type') as type, - json_extract_path_text(Properties, 'Plan') as plan, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SSMContacts::Contact' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SSMContacts::Contact' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Alias') as alias, + json_extract_path_text(Properties, 'DisplayName') as display_name, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'Plan') as plan, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SSMContacts::Contact' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SSMContacts::Contact' + AND region = 'us-east-1' contact_channels: name: contact_channels id: aws.ssmcontacts.contact_channels @@ -1148,7 +1136,7 @@ components: x-cfn-type-name: AWS::SSMContacts::ContactChannel x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1165,9 +1153,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1177,41 +1165,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/contact_channels/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/contact_channels/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SSMContacts::ContactChannel' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SSMContacts::ContactChannel' - AND region = 'us-east-1' - contact_channel: - name: contact_channel - id: aws.ssmcontacts.contact_channel - x-cfn-schema-name: ContactChannel - x-cfn-type-name: AWS::SSMContacts::ContactChannel - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1222,12 +1178,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/contact_channels/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/contact_channels/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/contact_channel/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/contact_channels/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1242,20 +1202,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ContactId') as contact_id, - json_extract_path_text(Properties, 'ChannelName') as channel_name, - json_extract_path_text(Properties, 'ChannelType') as channel_type, - json_extract_path_text(Properties, 'DeferActivation') as defer_activation, - json_extract_path_text(Properties, 'ChannelAddress') as channel_address, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SSMContacts::ContactChannel' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SSMContacts::ContactChannel' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ContactId') as contact_id, + json_extract_path_text(Properties, 'ChannelName') as channel_name, + json_extract_path_text(Properties, 'ChannelType') as channel_type, + json_extract_path_text(Properties, 'DeferActivation') as defer_activation, + json_extract_path_text(Properties, 'ChannelAddress') as channel_address, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SSMContacts::ContactChannel' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SSMContacts::ContactChannel' + AND region = 'us-east-1' plans: name: plans id: aws.ssmcontacts.plans @@ -1263,7 +1239,7 @@ components: x-cfn-type-name: AWS::SSMContacts::Plan x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1280,9 +1256,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1292,23 +1268,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/plans/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/plans/methods/delete_resource' - plan: - name: plan - id: aws.ssmcontacts.plan - x-cfn-schema-name: Plan - x-cfn-type-name: AWS::SSMContacts::Plan - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1319,12 +1281,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/plans/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/plans/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/plan/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/plans/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1337,7 +1303,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1356,7 +1322,7 @@ components: x-cfn-type-name: AWS::SSMContacts::Rotation x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1373,9 +1339,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1385,41 +1351,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/rotations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/rotations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SSMContacts::Rotation' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SSMContacts::Rotation' - AND region = 'us-east-1' - rotation: - name: rotation - id: aws.ssmcontacts.rotation - x-cfn-schema-name: Rotation - x-cfn-type-name: AWS::SSMContacts::Rotation - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1430,12 +1364,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/rotations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/rotations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/rotation/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/rotations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1451,21 +1389,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'ContactIds') as contact_ids, - json_extract_path_text(Properties, 'StartTime') as start_time, - json_extract_path_text(Properties, 'TimeZoneId') as time_zone_id, - json_extract_path_text(Properties, 'Recurrence') as recurrence, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SSMContacts::Rotation' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SSMContacts::Rotation' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'ContactIds') as contact_ids, + json_extract_path_text(Properties, 'StartTime') as start_time, + json_extract_path_text(Properties, 'TimeZoneId') as time_zone_id, + json_extract_path_text(Properties, 'Recurrence') as recurrence, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SSMContacts::Rotation' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SSMContacts::Rotation' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/ssmincidents.yaml b/providers/src/aws/v00.00.00000/services/ssmincidents.yaml index de9641fb..0c06e21d 100644 --- a/providers/src/aws/v00.00.00000/services/ssmincidents.yaml +++ b/providers/src/aws/v00.00.00000/services/ssmincidents.yaml @@ -473,7 +473,12 @@ components: - Arn x-required-properties: - Regions - x-taggable: true + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags x-required-permissions: create: - ssm-incidents:CreateReplicationSet @@ -793,7 +798,12 @@ components: x-required-properties: - Name - IncidentTemplate - x-taggable: true + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: false + tagProperty: /properties/Tags x-required-permissions: create: - ssm-incidents:CreateResponsePlan @@ -803,7 +813,10 @@ components: - iam:PassRole - secretsmanager:GetSecretValue - kms:Decrypt - - kms:GenerateDataKey* + - kms:GenerateDataKey + - kms:GenerateDataKeyPair + - kms:GenerateDataKeyPairWithoutPlaintext + - kms:GenerateDataKeyWithoutPlaintext read: - ssm-incidents:GetResponsePlan - ssm-incidents:ListTagsForResource @@ -816,7 +829,10 @@ components: - iam:PassRole - secretsmanager:GetSecretValue - kms:Decrypt - - kms:GenerateDataKey* + - kms:GenerateDataKey + - kms:GenerateDataKeyPair + - kms:GenerateDataKeyPairWithoutPlaintext + - kms:GenerateDataKeyWithoutPlaintext delete: - ssm-incidents:DeleteResponsePlan - ssm-incidents:GetResponsePlan @@ -946,7 +962,7 @@ components: x-cfn-type-name: AWS::SSMIncidents::ReplicationSet x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -963,9 +979,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -975,41 +991,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/replication_sets/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/replication_sets/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SSMIncidents::ReplicationSet' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SSMIncidents::ReplicationSet' - AND region = 'us-east-1' - replication_set: - name: replication_set - id: aws.ssmincidents.replication_set - x-cfn-schema-name: ReplicationSet - x-cfn-type-name: AWS::SSMIncidents::ReplicationSet - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1020,12 +1004,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/replication_sets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/replication_sets/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/replication_set/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/replication_sets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1038,18 +1026,34 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Regions') as regions, - json_extract_path_text(Properties, 'DeletionProtected') as deletion_protected, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SSMIncidents::ReplicationSet' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SSMIncidents::ReplicationSet' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Regions') as regions, + json_extract_path_text(Properties, 'DeletionProtected') as deletion_protected, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SSMIncidents::ReplicationSet' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SSMIncidents::ReplicationSet' + AND region = 'us-east-1' response_plans: name: response_plans id: aws.ssmincidents.response_plans @@ -1057,7 +1061,7 @@ components: x-cfn-type-name: AWS::SSMIncidents::ResponsePlan x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1074,9 +1078,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1086,41 +1090,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/response_plans/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/response_plans/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SSMIncidents::ResponsePlan' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SSMIncidents::ResponsePlan' - AND region = 'us-east-1' - response_plan: - name: response_plan - id: aws.ssmincidents.response_plan - x-cfn-schema-name: ResponsePlan - x-cfn-type-name: AWS::SSMIncidents::ResponsePlan - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1131,12 +1103,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/response_plans/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/response_plans/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/response_plan/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/response_plans/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1154,23 +1130,39 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'DisplayName') as display_name, - json_extract_path_text(Properties, 'ChatChannel') as chat_channel, - json_extract_path_text(Properties, 'Engagements') as engagements, - json_extract_path_text(Properties, 'Actions') as actions, - json_extract_path_text(Properties, 'Integrations') as integrations, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'IncidentTemplate') as incident_template - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SSMIncidents::ResponsePlan' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SSMIncidents::ResponsePlan' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'DisplayName') as display_name, + json_extract_path_text(Properties, 'ChatChannel') as chat_channel, + json_extract_path_text(Properties, 'Engagements') as engagements, + json_extract_path_text(Properties, 'Actions') as actions, + json_extract_path_text(Properties, 'Integrations') as integrations, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'IncidentTemplate') as incident_template + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SSMIncidents::ResponsePlan' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SSMIncidents::ResponsePlan' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/sso.yaml b/providers/src/aws/v00.00.00000/services/sso.yaml index df8d3f5e..9e7259fd 100644 --- a/providers/src/aws/v00.00.00000/services/sso.yaml +++ b/providers/src/aws/v00.00.00000/services/sso.yaml @@ -385,6 +385,203 @@ components: $ref: '#/components/x-cloud-control-schemas/ProgressEvent' type: object schemas: + Tag: + description: The metadata that you apply to the permission set to help you categorize and organize them. + type: object + properties: + Key: + type: string + pattern: '[\w+=,.@-]+' + minLength: 1 + maxLength: 128 + Value: + type: string + pattern: '[\w+=,.@-]+' + minLength: 0 + maxLength: 256 + required: + - Key + - Value + additionalProperties: false + SignInOptions: + description: A structure that describes the sign-in options for an application portal + type: object + properties: + Origin: + description: This determines how IAM Identity Center navigates the user to the target application + type: string + enum: + - IDENTITY_CENTER + - APPLICATION + ApplicationUrl: + description: The URL that accepts authentication requests for an application, this is a required parameter if the Origin parameter is APPLICATION + type: string + pattern: ^http(s)?:\/\/[-a-zA-Z0-9+&@#\/%?=~_|!:,.;]*[-a-zA-Z0-9+&bb@#\/%?=~_|]$ + minLength: 1 + maxLength: 512 + required: + - Origin + additionalProperties: false + PortalOptionsConfiguration: + description: A structure that describes the options for the access portal associated with an application + type: object + properties: + Visibility: + description: Indicates whether this application is visible in the access portal + type: string + enum: + - ENABLED + - DISABLED + SignInOptions: + description: A structure that describes the sign-in options for the access portal + $ref: '#/components/schemas/SignInOptions' + required: [] + additionalProperties: false + Application: + type: object + properties: + Name: + description: The name you want to assign to this Identity Center (SSO) Application + type: string + pattern: ^[\w+=,.@-]+$ + minLength: 0 + maxLength: 255 + Description: + description: The description information for the Identity Center (SSO) Application + type: string + minLength: 1 + maxLength: 128 + InstanceArn: + description: The ARN of the instance of IAM Identity Center under which the operation will run + type: string + pattern: ^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}$ + minLength: 10 + maxLength: 1224 + ApplicationArn: + description: The Application ARN that is returned upon creation of the Identity Center (SSO) Application + type: string + pattern: ^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}$ + minLength: 10 + maxLength: 1224 + ApplicationProviderArn: + description: The ARN of the application provider under which the operation will run + type: string + pattern: ^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::aws:applicationProvider/[a-zA-Z0-9-/]+$ + minLength: 10 + maxLength: 1224 + Status: + description: Specifies whether the application is enabled or disabled + type: string + enum: + - ENABLED + - DISABLED + PortalOptions: + description: A structure that describes the options for the portal associated with an application + $ref: '#/components/schemas/PortalOptionsConfiguration' + Tags: + type: array + uniqueItems: false + x-insertionOrder: false + items: + description: Specifies tags to be attached to the application + $ref: '#/components/schemas/Tag' + maxItems: 75 + required: + - Name + - InstanceArn + - ApplicationProviderArn + x-stackql-resource-name: application + description: Resource Type definition for Identity Center (SSO) Application + x-type-name: AWS::SSO::Application + x-stackql-primary-identifier: + - ApplicationArn + x-create-only-properties: + - InstanceArn + - ApplicationProviderArn + x-read-only-properties: + - ApplicationArn + x-required-properties: + - Name + - InstanceArn + - ApplicationProviderArn + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + x-required-permissions: + create: + - sso:CreateApplication + - sso:DescribeApplication + - sso:TagResource + read: + - sso:DescribeApplication + - sso:ListTagsForResource + update: + - sso:UpdateApplication + - sso:TagResource + - sso:UntagResource + - sso:ListTagsForResource + - sso:DescribeApplication + delete: + - sso:DeleteApplication + list: + - sso:ListApplications + ApplicationAssignment: + type: object + properties: + ApplicationArn: + description: The ARN of the application. + type: string + pattern: arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16} + minLength: 10 + maxLength: 1224 + PrincipalType: + description: The entity type for which the assignment will be created. + type: string + enum: + - USER + - GROUP + PrincipalId: + description: An identifier for an object in IAM Identity Center, such as a user or group + type: string + pattern: ^([0-9a-f]{10}-|)[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}$ + minLength: 1 + maxLength: 47 + required: + - ApplicationArn + - PrincipalType + - PrincipalId + x-stackql-resource-name: application_assignment + description: Resource Type definition for SSO application access grant to a user or group. + x-type-name: AWS::SSO::ApplicationAssignment + x-stackql-primary-identifier: + - ApplicationArn + - PrincipalType + - PrincipalId + x-create-only-properties: + - ApplicationArn + - PrincipalType + - PrincipalId + x-required-properties: + - ApplicationArn + - PrincipalType + - PrincipalId + x-tagging: + taggable: false + tagOnCreate: false + tagUpdatable: false + x-required-permissions: + create: + - sso:CreateApplicationAssignment + - sso:DescribeApplicationAssignment + read: + - sso:DescribeApplicationAssignment + delete: + - sso:DeleteApplicationAssignment + list: + - sso:ListApplicationAssignments Assignment: type: object properties: @@ -480,6 +677,84 @@ components: list: - sso:ListAccountAssignments - iam:ListRolePolicies + Instance: + type: object + properties: + Name: + description: The name you want to assign to this Identity Center (SSO) Instance + type: string + pattern: ^[\w+=,.@-]+$ + minLength: 1 + maxLength: 32 + InstanceArn: + description: The SSO Instance ARN that is returned upon creation of the Identity Center (SSO) Instance + type: string + pattern: ^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}$ + minLength: 10 + maxLength: 1224 + OwnerAccountId: + description: The AWS accountId of the owner of the Identity Center (SSO) Instance + type: string + pattern: ^\d{12}?$ + minLength: 12 + maxLength: 12 + IdentityStoreId: + description: The ID of the identity store associated with the created Identity Center (SSO) Instance + type: string + pattern: ^[a-zA-Z0-9-]*$ + minLength: 1 + maxLength: 64 + Status: + description: The status of the Identity Center (SSO) Instance, create_in_progress/delete_in_progress/active + type: string + enum: + - CREATE_IN_PROGRESS + - DELETE_IN_PROGRESS + - ACTIVE + Tags: + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + maxItems: 75 + x-stackql-resource-name: instance + description: Resource Type definition for Identity Center (SSO) Instance + x-type-name: AWS::SSO::Instance + x-stackql-primary-identifier: + - InstanceArn + x-read-only-properties: + - InstanceArn + - OwnerAccountId + - IdentityStoreId + - Status + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + tagProperty: /properties/Tags + x-required-permissions: + create: + - sso:CreateInstance + - sso:DescribeInstance + - sso:TagResource + - iam:CreateServiceLinkedRole + - sso:TagInstance + - sso:ListTagsForResource + read: + - sso:DescribeInstance + - sso:ListTagsForResource + update: + - sso:UpdateInstance + - sso:TagResource + - sso:UntagResource + - sso:ListTagsForResource + - sso:TagInstance + - sso:DescribeInstance + delete: + - sso:DeleteInstance + list: + - sso:ListInstances AccessControlAttributeValueSource: type: string minLength: 0 @@ -569,24 +844,6 @@ components: - sso:DescribeInstanceAccessControlAttributeConfiguration list: - sso:DescribeInstanceAccessControlAttributeConfiguration - Tag: - description: The metadata that you apply to the permission set to help you categorize and organize them. - type: object - properties: - Key: - type: string - pattern: '[\w+=,.@-]+' - minLength: 1 - maxLength: 128 - Value: - type: string - pattern: '[\w+=,.@-]+' - minLength: 0 - maxLength: 256 - required: - - Key - - Value - additionalProperties: false ManagedPolicyArn: description: The managed policy to attach. type: string @@ -747,6 +1004,104 @@ components: - sso:DeletePermissionSet list: - sso:DescribePermissionSet + CreateApplicationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Name: + description: The name you want to assign to this Identity Center (SSO) Application + type: string + pattern: ^[\w+=,.@-]+$ + minLength: 0 + maxLength: 255 + Description: + description: The description information for the Identity Center (SSO) Application + type: string + minLength: 1 + maxLength: 128 + InstanceArn: + description: The ARN of the instance of IAM Identity Center under which the operation will run + type: string + pattern: ^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}$ + minLength: 10 + maxLength: 1224 + ApplicationArn: + description: The Application ARN that is returned upon creation of the Identity Center (SSO) Application + type: string + pattern: ^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}$ + minLength: 10 + maxLength: 1224 + ApplicationProviderArn: + description: The ARN of the application provider under which the operation will run + type: string + pattern: ^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::aws:applicationProvider/[a-zA-Z0-9-/]+$ + minLength: 10 + maxLength: 1224 + Status: + description: Specifies whether the application is enabled or disabled + type: string + enum: + - ENABLED + - DISABLED + PortalOptions: + description: A structure that describes the options for the portal associated with an application + $ref: '#/components/schemas/PortalOptionsConfiguration' + Tags: + type: array + uniqueItems: false + x-insertionOrder: false + items: + description: Specifies tags to be attached to the application + $ref: '#/components/schemas/Tag' + maxItems: 75 + x-stackQL-stringOnly: true + x-title: CreateApplicationRequest + type: object + required: [] + CreateApplicationAssignmentRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + ApplicationArn: + description: The ARN of the application. + type: string + pattern: arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16} + minLength: 10 + maxLength: 1224 + PrincipalType: + description: The entity type for which the assignment will be created. + type: string + enum: + - USER + - GROUP + PrincipalId: + description: An identifier for an object in IAM Identity Center, such as a user or group + type: string + pattern: ^([0-9a-f]{10}-|)[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}$ + minLength: 1 + maxLength: 47 + x-stackQL-stringOnly: true + x-title: CreateApplicationAssignmentRequest + type: object + required: [] CreateAssignmentRequest: properties: ClientToken: @@ -797,7 +1152,7 @@ components: x-title: CreateAssignmentRequest type: object required: [] - CreateInstanceAccessControlAttributeConfigurationRequest: + CreateInstanceRequest: properties: ClientToken: type: string @@ -810,16 +1165,71 @@ components: DesiredState: type: object properties: + Name: + description: The name you want to assign to this Identity Center (SSO) Instance + type: string + pattern: ^[\w+=,.@-]+$ + minLength: 1 + maxLength: 32 InstanceArn: - description: The ARN of the AWS SSO instance under which the operation will be executed. + description: The SSO Instance ARN that is returned upon creation of the Identity Center (SSO) Instance type: string - pattern: arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16} + pattern: ^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}$ minLength: 10 maxLength: 1224 - InstanceAccessControlAttributeConfiguration: - description: The InstanceAccessControlAttributeConfiguration property has been deprecated but is still supported for backwards compatibility purposes. We recomend that you use AccessControlAttributes property instead. - type: object - properties: + OwnerAccountId: + description: The AWS accountId of the owner of the Identity Center (SSO) Instance + type: string + pattern: ^\d{12}?$ + minLength: 12 + maxLength: 12 + IdentityStoreId: + description: The ID of the identity store associated with the created Identity Center (SSO) Instance + type: string + pattern: ^[a-zA-Z0-9-]*$ + minLength: 1 + maxLength: 64 + Status: + description: The status of the Identity Center (SSO) Instance, create_in_progress/delete_in_progress/active + type: string + enum: + - CREATE_IN_PROGRESS + - DELETE_IN_PROGRESS + - ACTIVE + Tags: + type: array + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + maxItems: 75 + x-stackQL-stringOnly: true + x-title: CreateInstanceRequest + type: object + required: [] + CreateInstanceAccessControlAttributeConfigurationRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + InstanceArn: + description: The ARN of the AWS SSO instance under which the operation will be executed. + type: string + pattern: arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16} + minLength: 10 + maxLength: 1224 + InstanceAccessControlAttributeConfiguration: + description: The InstanceAccessControlAttributeConfiguration property has been deprecated but is still supported for backwards compatibility purposes. We recomend that you use AccessControlAttributes property instead. + type: object + properties: AccessControlAttributes: $ref: '#/components/schemas/AccessControlAttributeList' required: @@ -917,31 +1327,135 @@ components: description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: - assignments: - name: assignments - id: aws.sso.assignments - x-cfn-schema-name: Assignment - x-cfn-type-name: AWS::SSO::Assignment + applications: + name: applications + id: aws.sso.applications + x-cfn-schema-name: Application + x-cfn-type-name: AWS::SSO::Application x-identifiers: - - InstanceArn - - TargetId - - TargetType - - PermissionSetArn + - ApplicationArn + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Application&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSO::Application" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSO::Application" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSO::Application" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/applications/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/applications/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/applications/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.InstanceArn') as instance_arn, + JSON_EXTRACT(Properties, '$.ApplicationArn') as application_arn, + JSON_EXTRACT(Properties, '$.ApplicationProviderArn') as application_provider_arn, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.PortalOptions') as portal_options, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SSO::Application' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ApplicationArn') as application_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SSO::Application' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'InstanceArn') as instance_arn, + json_extract_path_text(Properties, 'ApplicationArn') as application_arn, + json_extract_path_text(Properties, 'ApplicationProviderArn') as application_provider_arn, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'PortalOptions') as portal_options, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SSO::Application' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ApplicationArn') as application_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SSO::Application' + AND region = 'us-east-1' + application_assignments: + name: application_assignments + id: aws.sso.application_assignments + x-cfn-schema-name: ApplicationAssignment + x-cfn-type-name: AWS::SSO::ApplicationAssignment + x-identifiers: + - ApplicationArn - PrincipalType - PrincipalId - x-type: list + x-type: cloud_control methods: create_resource: config: requestBodyTranslate: algorithm: naive_DesiredState operation: - $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Assignment&__detailTransformed=true/post' + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__ApplicationAssignment&__detailTransformed=true/post' request: mediaType: application/x-amz-json-1.0 base: |- { - "TypeName": "AWS::SSO::Assignment" + "TypeName": "AWS::SSO::ApplicationAssignment" } response: mediaType: application/json @@ -953,47 +1467,66 @@ components: mediaType: application/x-amz-json-1.0 base: |- { - "TypeName": "AWS::SSO::Assignment" + "TypeName": "AWS::SSO::ApplicationAssignment" } response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: insert: - - $ref: '#/components/x-stackQL-resources/assignments/methods/create_resource' + - $ref: '#/components/x-stackQL-resources/application_assignments/methods/create_resource' delete: - - $ref: '#/components/x-stackQL-resources/assignments/methods/delete_resource' + - $ref: '#/components/x-stackQL-resources/application_assignments/methods/delete_resource' + update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.InstanceArn') as instance_arn, - JSON_EXTRACT(Properties, '$.TargetId') as target_id, - JSON_EXTRACT(Properties, '$.TargetType') as target_type, - JSON_EXTRACT(Properties, '$.PermissionSetArn') as permission_set_arn, + data__Identifier, + JSON_EXTRACT(Properties, '$.ApplicationArn') as application_arn, JSON_EXTRACT(Properties, '$.PrincipalType') as principal_type, JSON_EXTRACT(Properties, '$.PrincipalId') as principal_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SSO::Assignment' + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SSO::ApplicationAssignment' + AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - json_extract_path_text(Properties, 'InstanceArn') as instance_arn, - json_extract_path_text(Properties, 'TargetId') as target_id, - json_extract_path_text(Properties, 'TargetType') as target_type, - json_extract_path_text(Properties, 'PermissionSetArn') as permission_set_arn, - json_extract_path_text(Properties, 'PrincipalType') as principal_type, - json_extract_path_text(Properties, 'PrincipalId') as principal_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SSO::Assignment' + JSON_EXTRACT(Properties, '$.ApplicationArn') as application_arn, + JSON_EXTRACT(Properties, '$.PrincipalType') as principal_type, + JSON_EXTRACT(Properties, '$.PrincipalId') as principal_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SSO::ApplicationAssignment' AND region = 'us-east-1' - assignment: - name: assignment - id: aws.sso.assignment + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ApplicationArn') as application_arn, + json_extract_path_text(Properties, 'PrincipalType') as principal_type, + json_extract_path_text(Properties, 'PrincipalId') as principal_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SSO::ApplicationAssignment' + AND data__Identifier = '||' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ApplicationArn') as application_arn, + json_extract_path_text(Properties, 'PrincipalType') as principal_type, + json_extract_path_text(Properties, 'PrincipalId') as principal_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SSO::ApplicationAssignment' + AND region = 'us-east-1' + assignments: + name: assignments + id: aws.sso.assignments x-cfn-schema-name: Assignment x-cfn-type-name: AWS::SSO::Assignment x-identifiers: @@ -1003,14 +1536,45 @@ components: - PermissionSetArn - PrincipalType - PrincipalId - x-type: get - methods: {} + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Assignment&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSO::Assignment" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSO::Assignment" + } + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/assignments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/assignments/methods/delete_resource' update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1025,40 +1589,78 @@ components: AND data__Identifier = '|||||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'InstanceArn') as instance_arn, - json_extract_path_text(Properties, 'TargetId') as target_id, - json_extract_path_text(Properties, 'TargetType') as target_type, - json_extract_path_text(Properties, 'PermissionSetArn') as permission_set_arn, - json_extract_path_text(Properties, 'PrincipalType') as principal_type, - json_extract_path_text(Properties, 'PrincipalId') as principal_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SSO::Assignment' - AND data__Identifier = '|||||' + JSON_EXTRACT(Properties, '$.InstanceArn') as instance_arn, + JSON_EXTRACT(Properties, '$.TargetId') as target_id, + JSON_EXTRACT(Properties, '$.TargetType') as target_type, + JSON_EXTRACT(Properties, '$.PermissionSetArn') as permission_set_arn, + JSON_EXTRACT(Properties, '$.PrincipalType') as principal_type, + JSON_EXTRACT(Properties, '$.PrincipalId') as principal_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SSO::Assignment' AND region = 'us-east-1' - instance_access_control_attribute_configurations: - name: instance_access_control_attribute_configurations - id: aws.sso.instance_access_control_attribute_configurations - x-cfn-schema-name: InstanceAccessControlAttributeConfiguration - x-cfn-type-name: AWS::SSO::InstanceAccessControlAttributeConfiguration + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'InstanceArn') as instance_arn, + json_extract_path_text(Properties, 'TargetId') as target_id, + json_extract_path_text(Properties, 'TargetType') as target_type, + json_extract_path_text(Properties, 'PermissionSetArn') as permission_set_arn, + json_extract_path_text(Properties, 'PrincipalType') as principal_type, + json_extract_path_text(Properties, 'PrincipalId') as principal_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SSO::Assignment' + AND data__Identifier = '|||||' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'InstanceArn') as instance_arn, + json_extract_path_text(Properties, 'TargetId') as target_id, + json_extract_path_text(Properties, 'TargetType') as target_type, + json_extract_path_text(Properties, 'PermissionSetArn') as permission_set_arn, + json_extract_path_text(Properties, 'PrincipalType') as principal_type, + json_extract_path_text(Properties, 'PrincipalId') as principal_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SSO::Assignment' + AND region = 'us-east-1' + instances: + name: instances + id: aws.sso.instances + x-cfn-schema-name: Instance + x-cfn-type-name: AWS::SSO::Instance x-identifiers: - InstanceArn - x-type: list + x-type: cloud_control methods: create_resource: config: requestBodyTranslate: algorithm: naive_DesiredState operation: - $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__InstanceAccessControlAttributeConfiguration&__detailTransformed=true/post' + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Instance&__detailTransformed=true/post' request: mediaType: application/x-amz-json-1.0 base: |- { - "TypeName": "AWS::SSO::InstanceAccessControlAttributeConfiguration" + "TypeName": "AWS::SSO::Instance" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSO::Instance" } response: mediaType: application/json @@ -1070,43 +1672,90 @@ components: mediaType: application/x-amz-json-1.0 base: |- { - "TypeName": "AWS::SSO::InstanceAccessControlAttributeConfiguration" + "TypeName": "AWS::SSO::Instance" } response: mediaType: application/json openAPIDocKey: '200' sqlVerbs: insert: - - $ref: '#/components/x-stackQL-resources/instance_access_control_attribute_configurations/methods/create_resource' + - $ref: '#/components/x-stackQL-resources/instances/methods/create_resource' delete: - - $ref: '#/components/x-stackQL-resources/instance_access_control_attribute_configurations/methods/delete_resource' + - $ref: '#/components/x-stackQL-resources/instances/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/instances/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, - JSON_EXTRACT(Properties, '$.InstanceArn') as instance_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SSO::InstanceAccessControlAttributeConfiguration' + data__Identifier, + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.InstanceArn') as instance_arn, + JSON_EXTRACT(Properties, '$.OwnerAccountId') as owner_account_id, + JSON_EXTRACT(Properties, '$.IdentityStoreId') as identity_store_id, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SSO::Instance' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - json_extract_path_text(Properties, 'InstanceArn') as instance_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SSO::InstanceAccessControlAttributeConfiguration' + JSON_EXTRACT(Properties, '$.InstanceArn') as instance_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SSO::Instance' AND region = 'us-east-1' - instance_access_control_attribute_configuration: - name: instance_access_control_attribute_configuration - id: aws.sso.instance_access_control_attribute_configuration + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'InstanceArn') as instance_arn, + json_extract_path_text(Properties, 'OwnerAccountId') as owner_account_id, + json_extract_path_text(Properties, 'IdentityStoreId') as identity_store_id, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SSO::Instance' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'InstanceArn') as instance_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SSO::Instance' + AND region = 'us-east-1' + instance_access_control_attribute_configurations: + name: instance_access_control_attribute_configurations + id: aws.sso.instance_access_control_attribute_configurations x-cfn-schema-name: InstanceAccessControlAttributeConfiguration x-cfn-type-name: AWS::SSO::InstanceAccessControlAttributeConfiguration x-identifiers: - InstanceArn - x-type: get + x-type: cloud_control methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__InstanceAccessControlAttributeConfiguration&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSO::InstanceAccessControlAttributeConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' update_resource: operation: $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' @@ -1119,13 +1768,29 @@ components: response: mediaType: application/json openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::SSO::InstanceAccessControlAttributeConfiguration" + } + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/instance_access_control_attribute_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/instance_access_control_attribute_configurations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/instance_access_control_attribute_configuration/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/instance_access_control_attribute_configurations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1137,17 +1802,33 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'InstanceArn') as instance_arn, - json_extract_path_text(Properties, 'InstanceAccessControlAttributeConfiguration') as instance_access_control_attribute_configuration, - json_extract_path_text(Properties, 'AccessControlAttributes') as access_control_attributes - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SSO::InstanceAccessControlAttributeConfiguration' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.InstanceArn') as instance_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SSO::InstanceAccessControlAttributeConfiguration' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'InstanceArn') as instance_arn, + json_extract_path_text(Properties, 'InstanceAccessControlAttributeConfiguration') as instance_access_control_attribute_configuration, + json_extract_path_text(Properties, 'AccessControlAttributes') as access_control_attributes + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SSO::InstanceAccessControlAttributeConfiguration' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'InstanceArn') as instance_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SSO::InstanceAccessControlAttributeConfiguration' + AND region = 'us-east-1' permission_sets: name: permission_sets id: aws.sso.permission_sets @@ -1156,7 +1837,7 @@ components: x-identifiers: - InstanceArn - PermissionSetArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1173,9 +1854,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1185,44 +1866,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/permission_sets/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/permission_sets/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.InstanceArn') as instance_arn, - JSON_EXTRACT(Properties, '$.PermissionSetArn') as permission_set_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SSO::PermissionSet' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'InstanceArn') as instance_arn, - json_extract_path_text(Properties, 'PermissionSetArn') as permission_set_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SSO::PermissionSet' - AND region = 'us-east-1' - permission_set: - name: permission_set - id: aws.sso.permission_set - x-cfn-schema-name: PermissionSet - x-cfn-type-name: AWS::SSO::PermissionSet - x-identifiers: - - InstanceArn - - PermissionSetArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1233,12 +1879,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/permission_sets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/permission_sets/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/permission_set/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/permission_sets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1258,25 +1908,43 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'PermissionSetArn') as permission_set_arn, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'InstanceArn') as instance_arn, - json_extract_path_text(Properties, 'SessionDuration') as session_duration, - json_extract_path_text(Properties, 'RelayStateType') as relay_state_type, - json_extract_path_text(Properties, 'ManagedPolicies') as managed_policies, - json_extract_path_text(Properties, 'InlinePolicy') as inline_policy, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'CustomerManagedPolicyReferences') as customer_managed_policy_references, - json_extract_path_text(Properties, 'PermissionsBoundary') as permissions_boundary - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SSO::PermissionSet' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.InstanceArn') as instance_arn, + JSON_EXTRACT(Properties, '$.PermissionSetArn') as permission_set_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SSO::PermissionSet' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'PermissionSetArn') as permission_set_arn, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'InstanceArn') as instance_arn, + json_extract_path_text(Properties, 'SessionDuration') as session_duration, + json_extract_path_text(Properties, 'RelayStateType') as relay_state_type, + json_extract_path_text(Properties, 'ManagedPolicies') as managed_policies, + json_extract_path_text(Properties, 'InlinePolicy') as inline_policy, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'CustomerManagedPolicyReferences') as customer_managed_policy_references, + json_extract_path_text(Properties, 'PermissionsBoundary') as permissions_boundary + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SSO::PermissionSet' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'InstanceArn') as instance_arn, + json_extract_path_text(Properties, 'PermissionSetArn') as permission_set_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SSO::PermissionSet' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: @@ -1420,6 +2088,90 @@ paths: schema: $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' description: Success + /?Action=CreateResource&Version=2021-09-30&__Application&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateApplication + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateApplicationRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__ApplicationAssignment&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateApplicationAssignment + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateApplicationAssignmentRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success /?Action=CreateResource&Version=2021-09-30&__Assignment&__detailTransformed=true: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' @@ -1462,6 +2214,48 @@ paths: schema: $ref: '#/components/x-cloud-control-schemas/ProgressEvent' description: Success + /?Action=CreateResource&Version=2021-09-30&__Instance&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateInstance + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateInstanceRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success /?Action=CreateResource&Version=2021-09-30&__InstanceAccessControlAttributeConfiguration&__detailTransformed=true: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' diff --git a/providers/src/aws/v00.00.00000/services/stepfunctions.yaml b/providers/src/aws/v00.00.00000/services/stepfunctions.yaml index 2b0003e1..e338fdfc 100644 --- a/providers/src/aws/v00.00.00000/services/stepfunctions.yaml +++ b/providers/src/aws/v00.00.00000/services/stepfunctions.yaml @@ -404,19 +404,19 @@ components: type: object properties: Arn: - type: string minLength: 1 - maxLength: 2048 - Name: type: string - minLength: 1 - maxLength: 80 + maxLength: 2048 Tags: - type: array uniqueItems: false x-insertionOrder: false + type: array items: $ref: '#/components/schemas/TagsEntry' + Name: + minLength: 1 + type: string + maxLength: 80 required: - Name x-stackql-resource-name: activity @@ -434,19 +434,23 @@ components: taggable: true tagOnCreate: true tagUpdatable: true - cloudFormationSystemTags: true tagProperty: /properties/Tags + cloudFormationSystemTags: true x-required-permissions: - create: - - states:CreateActivity read: - states:DescribeActivity - states:ListTagsForResource + create: + - states:CreateActivity + - states:TagResource update: - states:ListTagsForResource - states:TagResource - states:UntagResource + list: + - states:ListActivities delete: + - states:DescribeActivity - states:DeleteActivity LoggingConfiguration: additionalProperties: false @@ -491,9 +495,6 @@ components: type: object properties: LogGroupArn: - x-relationshipRef: - typeName: AWS::Logs::LogGroup - propertyPath: /properties/Arn minLength: 1 type: string maxLength: 256 @@ -792,19 +793,19 @@ components: type: object properties: Arn: - type: string minLength: 1 - maxLength: 2048 - Name: type: string - minLength: 1 - maxLength: 80 + maxLength: 2048 Tags: - type: array uniqueItems: false x-insertionOrder: false + type: array items: $ref: '#/components/schemas/TagsEntry' + Name: + minLength: 1 + type: string + maxLength: 80 x-stackQL-stringOnly: true x-title: CreateActivityRequest type: object @@ -955,7 +956,7 @@ components: x-cfn-type-name: AWS::StepFunctions::Activity x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -972,9 +973,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -984,23 +985,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/activities/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/activities/methods/delete_resource' - activity: - name: activity - id: aws.stepfunctions.activity - x-cfn-schema-name: Activity - x-cfn-type-name: AWS::StepFunctions::Activity - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1011,34 +998,54 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/activities/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/activities/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/activity/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/activities/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, data__Identifier, JSON_EXTRACT(Properties, '$.Arn') as arn, - JSON_EXTRACT(Properties, '$.Name') as name, - JSON_EXTRACT(Properties, '$.Tags') as tags + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.Name') as name FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::StepFunctions::Activity' AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::StepFunctions::Activity' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::StepFunctions::Activity' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::StepFunctions::Activity' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::StepFunctions::Activity' + AND region = 'us-east-1' state_machines: name: state_machines id: aws.stepfunctions.state_machines @@ -1046,7 +1053,7 @@ components: x-cfn-type-name: AWS::StepFunctions::StateMachine x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1063,9 +1070,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1075,41 +1082,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/state_machines/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/state_machines/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::StepFunctions::StateMachine' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::StepFunctions::StateMachine' - AND region = 'us-east-1' - state_machine: - name: state_machine - id: aws.stepfunctions.state_machine - x-cfn-schema-name: StateMachine - x-cfn-type-name: AWS::StepFunctions::StateMachine - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1120,12 +1095,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/state_machines/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/state_machines/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/state_machine/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/state_machines/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1147,27 +1126,43 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'DefinitionSubstitutions') as definition_substitutions, - json_extract_path_text(Properties, 'Definition') as definition, - json_extract_path_text(Properties, 'RoleArn') as role_arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'StateMachineType') as state_machine_type, - json_extract_path_text(Properties, 'TracingConfiguration') as tracing_configuration, - json_extract_path_text(Properties, 'DefinitionString') as definition_string, - json_extract_path_text(Properties, 'LoggingConfiguration') as logging_configuration, - json_extract_path_text(Properties, 'StateMachineRevisionId') as state_machine_revision_id, - json_extract_path_text(Properties, 'DefinitionS3Location') as definition_s3_location, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'StateMachineName') as state_machine_name, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::StepFunctions::StateMachine' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::StepFunctions::StateMachine' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'DefinitionSubstitutions') as definition_substitutions, + json_extract_path_text(Properties, 'Definition') as definition, + json_extract_path_text(Properties, 'RoleArn') as role_arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'StateMachineType') as state_machine_type, + json_extract_path_text(Properties, 'TracingConfiguration') as tracing_configuration, + json_extract_path_text(Properties, 'DefinitionString') as definition_string, + json_extract_path_text(Properties, 'LoggingConfiguration') as logging_configuration, + json_extract_path_text(Properties, 'StateMachineRevisionId') as state_machine_revision_id, + json_extract_path_text(Properties, 'DefinitionS3Location') as definition_s3_location, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'StateMachineName') as state_machine_name, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::StepFunctions::StateMachine' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::StepFunctions::StateMachine' + AND region = 'us-east-1' state_machine_aliases: name: state_machine_aliases id: aws.stepfunctions.state_machine_aliases @@ -1175,7 +1170,7 @@ components: x-cfn-type-name: AWS::StepFunctions::StateMachineAlias x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1192,9 +1187,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1204,41 +1199,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/state_machine_aliases/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/state_machine_aliases/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::StepFunctions::StateMachineAlias' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::StepFunctions::StateMachineAlias' - AND region = 'us-east-1' - state_machine_alias: - name: state_machine_alias - id: aws.stepfunctions.state_machine_alias - x-cfn-schema-name: StateMachineAlias - x-cfn-type-name: AWS::StepFunctions::StateMachineAlias - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1249,12 +1212,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/state_machine_aliases/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/state_machine_aliases/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/state_machine_alias/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/state_machine_aliases/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1268,19 +1235,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'RoutingConfiguration') as routing_configuration, - json_extract_path_text(Properties, 'DeploymentPreference') as deployment_preference - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::StepFunctions::StateMachineAlias' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::StepFunctions::StateMachineAlias' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'RoutingConfiguration') as routing_configuration, + json_extract_path_text(Properties, 'DeploymentPreference') as deployment_preference + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::StepFunctions::StateMachineAlias' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::StepFunctions::StateMachineAlias' + AND region = 'us-east-1' state_machine_versions: name: state_machine_versions id: aws.stepfunctions.state_machine_versions @@ -1288,7 +1271,7 @@ components: x-cfn-type-name: AWS::StepFunctions::StateMachineVersion x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1322,39 +1305,11 @@ components: - $ref: '#/components/x-stackQL-resources/state_machine_versions/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/state_machine_versions/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::StepFunctions::StateMachineVersion' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::StepFunctions::StateMachineVersion' - AND region = 'us-east-1' - state_machine_version: - name: state_machine_version - id: aws.stepfunctions.state_machine_version - x-cfn-schema-name: StateMachineVersion - x-cfn-type-name: AWS::StepFunctions::StateMachineVersion - x-identifiers: - - Arn - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1367,18 +1322,34 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'StateMachineArn') as state_machine_arn, - json_extract_path_text(Properties, 'StateMachineRevisionId') as state_machine_revision_id, - json_extract_path_text(Properties, 'Description') as description - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::StepFunctions::StateMachineVersion' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::StepFunctions::StateMachineVersion' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'StateMachineArn') as state_machine_arn, + json_extract_path_text(Properties, 'StateMachineRevisionId') as state_machine_revision_id, + json_extract_path_text(Properties, 'Description') as description + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::StepFunctions::StateMachineVersion' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::StepFunctions::StateMachineVersion' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/supportapp.yaml b/providers/src/aws/v00.00.00000/services/supportapp.yaml index dbbb548d..52deefd4 100644 --- a/providers/src/aws/v00.00.00000/services/supportapp.yaml +++ b/providers/src/aws/v00.00.00000/services/supportapp.yaml @@ -675,7 +675,7 @@ components: x-cfn-type-name: AWS::SupportApp::AccountAlias x-identifiers: - AccountAliasResourceId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -692,9 +692,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -704,41 +704,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/account_aliases/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/account_aliases/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AccountAliasResourceId') as account_alias_resource_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SupportApp::AccountAlias' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AccountAliasResourceId') as account_alias_resource_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SupportApp::AccountAlias' - AND region = 'us-east-1' - account_alias: - name: account_alias - id: aws.supportapp.account_alias - x-cfn-schema-name: AccountAlias - x-cfn-type-name: AWS::SupportApp::AccountAlias - x-identifiers: - - AccountAliasResourceId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -749,12 +717,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/account_aliases/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/account_aliases/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/account_alias/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/account_aliases/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -765,16 +737,32 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AccountAlias') as account_alias, - json_extract_path_text(Properties, 'AccountAliasResourceId') as account_alias_resource_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SupportApp::AccountAlias' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.AccountAliasResourceId') as account_alias_resource_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SupportApp::AccountAlias' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AccountAlias') as account_alias, + json_extract_path_text(Properties, 'AccountAliasResourceId') as account_alias_resource_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SupportApp::AccountAlias' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AccountAliasResourceId') as account_alias_resource_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SupportApp::AccountAlias' + AND region = 'us-east-1' slack_channel_configurations: name: slack_channel_configurations id: aws.supportapp.slack_channel_configurations @@ -783,7 +771,7 @@ components: x-identifiers: - TeamId - ChannelId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -800,9 +788,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -812,44 +800,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/slack_channel_configurations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/slack_channel_configurations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.TeamId') as team_id, - JSON_EXTRACT(Properties, '$.ChannelId') as channel_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SupportApp::SlackChannelConfiguration' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'TeamId') as team_id, - json_extract_path_text(Properties, 'ChannelId') as channel_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SupportApp::SlackChannelConfiguration' - AND region = 'us-east-1' - slack_channel_configuration: - name: slack_channel_configuration - id: aws.supportapp.slack_channel_configuration - x-cfn-schema-name: SlackChannelConfiguration - x-cfn-type-name: AWS::SupportApp::SlackChannelConfiguration - x-identifiers: - - TeamId - - ChannelId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -860,12 +813,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/slack_channel_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/slack_channel_configurations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/slack_channel_configuration/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/slack_channel_configurations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -882,22 +839,40 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'TeamId') as team_id, - json_extract_path_text(Properties, 'ChannelId') as channel_id, - json_extract_path_text(Properties, 'ChannelName') as channel_name, - json_extract_path_text(Properties, 'NotifyOnCreateOrReopenCase') as notify_on_create_or_reopen_case, - json_extract_path_text(Properties, 'NotifyOnAddCorrespondenceToCase') as notify_on_add_correspondence_to_case, - json_extract_path_text(Properties, 'NotifyOnResolveCase') as notify_on_resolve_case, - json_extract_path_text(Properties, 'NotifyOnCaseSeverity') as notify_on_case_severity, - json_extract_path_text(Properties, 'ChannelRoleArn') as channel_role_arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SupportApp::SlackChannelConfiguration' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.TeamId') as team_id, + JSON_EXTRACT(Properties, '$.ChannelId') as channel_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SupportApp::SlackChannelConfiguration' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'TeamId') as team_id, + json_extract_path_text(Properties, 'ChannelId') as channel_id, + json_extract_path_text(Properties, 'ChannelName') as channel_name, + json_extract_path_text(Properties, 'NotifyOnCreateOrReopenCase') as notify_on_create_or_reopen_case, + json_extract_path_text(Properties, 'NotifyOnAddCorrespondenceToCase') as notify_on_add_correspondence_to_case, + json_extract_path_text(Properties, 'NotifyOnResolveCase') as notify_on_resolve_case, + json_extract_path_text(Properties, 'NotifyOnCaseSeverity') as notify_on_case_severity, + json_extract_path_text(Properties, 'ChannelRoleArn') as channel_role_arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SupportApp::SlackChannelConfiguration' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'TeamId') as team_id, + json_extract_path_text(Properties, 'ChannelId') as channel_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SupportApp::SlackChannelConfiguration' + AND region = 'us-east-1' slack_workspace_configurations: name: slack_workspace_configurations id: aws.supportapp.slack_workspace_configurations @@ -905,7 +880,7 @@ components: x-cfn-type-name: AWS::SupportApp::SlackWorkspaceConfiguration x-identifiers: - TeamId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -922,9 +897,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -934,41 +909,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/slack_workspace_configurations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/slack_workspace_configurations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.TeamId') as team_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SupportApp::SlackWorkspaceConfiguration' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'TeamId') as team_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SupportApp::SlackWorkspaceConfiguration' - AND region = 'us-east-1' - slack_workspace_configuration: - name: slack_workspace_configuration - id: aws.supportapp.slack_workspace_configuration - x-cfn-schema-name: SlackWorkspaceConfiguration - x-cfn-type-name: AWS::SupportApp::SlackWorkspaceConfiguration - x-identifiers: - - TeamId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -979,12 +922,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/slack_workspace_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/slack_workspace_configurations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/slack_workspace_configuration/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/slack_workspace_configurations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -995,16 +942,32 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'TeamId') as team_id, - json_extract_path_text(Properties, 'VersionId') as version_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SupportApp::SlackWorkspaceConfiguration' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.TeamId') as team_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SupportApp::SlackWorkspaceConfiguration' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'TeamId') as team_id, + json_extract_path_text(Properties, 'VersionId') as version_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SupportApp::SlackWorkspaceConfiguration' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'TeamId') as team_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SupportApp::SlackWorkspaceConfiguration' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/synthetics.yaml b/providers/src/aws/v00.00.00000/services/synthetics.yaml index 454448ed..a6c373ed 100644 --- a/providers/src/aws/v00.00.00000/services/synthetics.yaml +++ b/providers/src/aws/v00.00.00000/services/synthetics.yaml @@ -857,7 +857,7 @@ components: x-cfn-type-name: AWS::Synthetics::Canary x-identifiers: - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -874,9 +874,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -886,41 +886,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/canaries/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/canaries/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Synthetics::Canary' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Synthetics::Canary' - AND region = 'us-east-1' - canary: - name: canary - id: aws.synthetics.canary - x-cfn-schema-name: Canary - x-cfn-type-name: AWS::Synthetics::Canary - x-identifiers: - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -931,12 +899,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/canaries/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/canaries/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/canary/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/canaries/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -962,31 +934,47 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'State') as state, - json_extract_path_text(Properties, 'Code') as code, - json_extract_path_text(Properties, 'ArtifactS3Location') as artifact_s3_location, - json_extract_path_text(Properties, 'ArtifactConfig') as artifact_config, - json_extract_path_text(Properties, 'Schedule') as schedule, - json_extract_path_text(Properties, 'ExecutionRoleArn') as execution_role_arn, - json_extract_path_text(Properties, 'RuntimeVersion') as runtime_version, - json_extract_path_text(Properties, 'SuccessRetentionPeriod') as success_retention_period, - json_extract_path_text(Properties, 'FailureRetentionPeriod') as failure_retention_period, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'VPCConfig') as vpc_config, - json_extract_path_text(Properties, 'RunConfig') as run_config, - json_extract_path_text(Properties, 'StartCanaryAfterCreation') as start_canary_after_creation, - json_extract_path_text(Properties, 'VisualReference') as visual_reference, - json_extract_path_text(Properties, 'DeleteLambdaResourcesOnCanaryDeletion') as delete_lambda_resources_on_canary_deletion - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Synthetics::Canary' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Synthetics::Canary' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'State') as state, + json_extract_path_text(Properties, 'Code') as code, + json_extract_path_text(Properties, 'ArtifactS3Location') as artifact_s3_location, + json_extract_path_text(Properties, 'ArtifactConfig') as artifact_config, + json_extract_path_text(Properties, 'Schedule') as schedule, + json_extract_path_text(Properties, 'ExecutionRoleArn') as execution_role_arn, + json_extract_path_text(Properties, 'RuntimeVersion') as runtime_version, + json_extract_path_text(Properties, 'SuccessRetentionPeriod') as success_retention_period, + json_extract_path_text(Properties, 'FailureRetentionPeriod') as failure_retention_period, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'VPCConfig') as vpc_config, + json_extract_path_text(Properties, 'RunConfig') as run_config, + json_extract_path_text(Properties, 'StartCanaryAfterCreation') as start_canary_after_creation, + json_extract_path_text(Properties, 'VisualReference') as visual_reference, + json_extract_path_text(Properties, 'DeleteLambdaResourcesOnCanaryDeletion') as delete_lambda_resources_on_canary_deletion + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Synthetics::Canary' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Synthetics::Canary' + AND region = 'us-east-1' groups: name: groups id: aws.synthetics.groups @@ -994,7 +982,7 @@ components: x-cfn-type-name: AWS::Synthetics::Group x-identifiers: - Name - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1011,9 +999,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1023,41 +1011,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/groups/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/groups/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Synthetics::Group' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Synthetics::Group' - AND region = 'us-east-1' - group: - name: group - id: aws.synthetics.group - x-cfn-schema-name: Group - x-cfn-type-name: AWS::Synthetics::Group - x-identifiers: - - Name - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1068,12 +1024,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/groups/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/group/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1086,18 +1046,34 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'ResourceArns') as resource_arns - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Synthetics::Group' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Synthetics::Group' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'ResourceArns') as resource_arns + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Synthetics::Group' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Synthetics::Group' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/systemsmanagersap.yaml b/providers/src/aws/v00.00.00000/services/systemsmanagersap.yaml index 3803278f..62868981 100644 --- a/providers/src/aws/v00.00.00000/services/systemsmanagersap.yaml +++ b/providers/src/aws/v00.00.00000/services/systemsmanagersap.yaml @@ -573,7 +573,7 @@ components: x-cfn-type-name: AWS::SystemsManagerSAP::Application x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -590,9 +590,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -602,41 +602,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/applications/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/applications/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SystemsManagerSAP::Application' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SystemsManagerSAP::Application' - AND region = 'us-east-1' - application: - name: application - id: aws.systemsmanagersap.application - x-cfn-schema-name: Application - x-cfn-type-name: AWS::SystemsManagerSAP::Application - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -647,12 +615,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/applications/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/applications/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/application/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/applications/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -669,22 +641,38 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ApplicationId') as application_id, - json_extract_path_text(Properties, 'ApplicationType') as application_type, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Credentials') as credentials, - json_extract_path_text(Properties, 'Instances') as instances, - json_extract_path_text(Properties, 'SapInstanceNumber') as sap_instance_number, - json_extract_path_text(Properties, 'Sid') as sid, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SystemsManagerSAP::Application' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SystemsManagerSAP::Application' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ApplicationId') as application_id, + json_extract_path_text(Properties, 'ApplicationType') as application_type, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Credentials') as credentials, + json_extract_path_text(Properties, 'Instances') as instances, + json_extract_path_text(Properties, 'SapInstanceNumber') as sap_instance_number, + json_extract_path_text(Properties, 'Sid') as sid, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::SystemsManagerSAP::Application' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::SystemsManagerSAP::Application' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/timestream.yaml b/providers/src/aws/v00.00.00000/services/timestream.yaml index edcc3768..f49d00cd 100644 --- a/providers/src/aws/v00.00.00000/services/timestream.yaml +++ b/providers/src/aws/v00.00.00000/services/timestream.yaml @@ -1612,7 +1612,7 @@ components: x-cfn-type-name: AWS::Timestream::Database x-identifiers: - DatabaseName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1629,9 +1629,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1641,41 +1641,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/databases/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/databases/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.DatabaseName') as database_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Timestream::Database' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'DatabaseName') as database_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Timestream::Database' - AND region = 'us-east-1' - database: - name: database - id: aws.timestream.database - x-cfn-schema-name: Database - x-cfn-type-name: AWS::Timestream::Database - x-identifiers: - - DatabaseName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1686,12 +1654,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/databases/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/databases/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/database/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/databases/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1704,18 +1676,34 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'DatabaseName') as database_name, - json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Timestream::Database' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.DatabaseName') as database_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Timestream::Database' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'DatabaseName') as database_name, + json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Timestream::Database' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DatabaseName') as database_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Timestream::Database' + AND region = 'us-east-1' influxdb_instances: name: influxdb_instances id: aws.timestream.influxdb_instances @@ -1723,7 +1711,7 @@ components: x-cfn-type-name: AWS::Timestream::InfluxDBInstance x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1740,9 +1728,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1752,41 +1740,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/influxdb_instances/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/influxdb_instances/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Timestream::InfluxDBInstance' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Timestream::InfluxDBInstance' - AND region = 'us-east-1' - influxdb_instance: - name: influxdb_instance - id: aws.timestream.influxdb_instance - x-cfn-schema-name: InfluxDBInstance - x-cfn-type-name: AWS::Timestream::InfluxDBInstance - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1797,12 +1753,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/influxdb_instances/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/influxdb_instances/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/influxdb_instance/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/influxdb_instances/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1833,36 +1793,52 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Username') as username, - json_extract_path_text(Properties, 'Password') as password, - json_extract_path_text(Properties, 'Organization') as organization, - json_extract_path_text(Properties, 'Bucket') as bucket, - json_extract_path_text(Properties, 'DbInstanceType') as db_instance_type, - json_extract_path_text(Properties, 'VpcSubnetIds') as vpc_subnet_ids, - json_extract_path_text(Properties, 'VpcSecurityGroupIds') as vpc_security_group_ids, - json_extract_path_text(Properties, 'PubliclyAccessible') as publicly_accessible, - json_extract_path_text(Properties, 'DbStorageType') as db_storage_type, - json_extract_path_text(Properties, 'AllocatedStorage') as allocated_storage, - json_extract_path_text(Properties, 'DbParameterGroupIdentifier') as db_parameter_group_identifier, - json_extract_path_text(Properties, 'LogDeliveryConfiguration') as log_delivery_configuration, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'AvailabilityZone') as availability_zone, - json_extract_path_text(Properties, 'SecondaryAvailabilityZone') as secondary_availability_zone, - json_extract_path_text(Properties, 'Endpoint') as endpoint, - json_extract_path_text(Properties, 'InfluxAuthParametersSecretArn') as influx_auth_parameters_secret_arn, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'DeploymentType') as deployment_type, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Timestream::InfluxDBInstance' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Timestream::InfluxDBInstance' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Username') as username, + json_extract_path_text(Properties, 'Password') as password, + json_extract_path_text(Properties, 'Organization') as organization, + json_extract_path_text(Properties, 'Bucket') as bucket, + json_extract_path_text(Properties, 'DbInstanceType') as db_instance_type, + json_extract_path_text(Properties, 'VpcSubnetIds') as vpc_subnet_ids, + json_extract_path_text(Properties, 'VpcSecurityGroupIds') as vpc_security_group_ids, + json_extract_path_text(Properties, 'PubliclyAccessible') as publicly_accessible, + json_extract_path_text(Properties, 'DbStorageType') as db_storage_type, + json_extract_path_text(Properties, 'AllocatedStorage') as allocated_storage, + json_extract_path_text(Properties, 'DbParameterGroupIdentifier') as db_parameter_group_identifier, + json_extract_path_text(Properties, 'LogDeliveryConfiguration') as log_delivery_configuration, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'AvailabilityZone') as availability_zone, + json_extract_path_text(Properties, 'SecondaryAvailabilityZone') as secondary_availability_zone, + json_extract_path_text(Properties, 'Endpoint') as endpoint, + json_extract_path_text(Properties, 'InfluxAuthParametersSecretArn') as influx_auth_parameters_secret_arn, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'DeploymentType') as deployment_type, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Timestream::InfluxDBInstance' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Timestream::InfluxDBInstance' + AND region = 'us-east-1' scheduled_queries: name: scheduled_queries id: aws.timestream.scheduled_queries @@ -1870,7 +1846,7 @@ components: x-cfn-type-name: AWS::Timestream::ScheduledQuery x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1887,9 +1863,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1899,41 +1875,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/scheduled_queries/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/scheduled_queries/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Timestream::ScheduledQuery' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Timestream::ScheduledQuery' - AND region = 'us-east-1' - scheduled_query: - name: scheduled_query - id: aws.timestream.scheduled_query - x-cfn-schema-name: ScheduledQuery - x-cfn-type-name: AWS::Timestream::ScheduledQuery - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1944,12 +1888,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/scheduled_queries/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/scheduled_queries/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/scheduled_query/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/scheduled_queries/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1977,33 +1925,49 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'ScheduledQueryName') as scheduled_query_name, - json_extract_path_text(Properties, 'QueryString') as query_string, - json_extract_path_text(Properties, 'ScheduleConfiguration') as schedule_configuration, - json_extract_path_text(Properties, 'NotificationConfiguration') as notification_configuration, - json_extract_path_text(Properties, 'ClientToken') as client_token, - json_extract_path_text(Properties, 'ScheduledQueryExecutionRoleArn') as scheduled_query_execution_role_arn, - json_extract_path_text(Properties, 'TargetConfiguration') as target_configuration, - json_extract_path_text(Properties, 'ErrorReportConfiguration') as error_report_configuration, - json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, - json_extract_path_text(Properties, 'SQName') as sq_name, - json_extract_path_text(Properties, 'SQQueryString') as sq_query_string, - json_extract_path_text(Properties, 'SQScheduleConfiguration') as sq_schedule_configuration, - json_extract_path_text(Properties, 'SQNotificationConfiguration') as sq_notification_configuration, - json_extract_path_text(Properties, 'SQScheduledQueryExecutionRoleArn') as sq_scheduled_query_execution_role_arn, - json_extract_path_text(Properties, 'SQTargetConfiguration') as sq_target_configuration, - json_extract_path_text(Properties, 'SQErrorReportConfiguration') as sq_error_report_configuration, - json_extract_path_text(Properties, 'SQKmsKeyId') as sq_kms_key_id, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Timestream::ScheduledQuery' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Timestream::ScheduledQuery' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'ScheduledQueryName') as scheduled_query_name, + json_extract_path_text(Properties, 'QueryString') as query_string, + json_extract_path_text(Properties, 'ScheduleConfiguration') as schedule_configuration, + json_extract_path_text(Properties, 'NotificationConfiguration') as notification_configuration, + json_extract_path_text(Properties, 'ClientToken') as client_token, + json_extract_path_text(Properties, 'ScheduledQueryExecutionRoleArn') as scheduled_query_execution_role_arn, + json_extract_path_text(Properties, 'TargetConfiguration') as target_configuration, + json_extract_path_text(Properties, 'ErrorReportConfiguration') as error_report_configuration, + json_extract_path_text(Properties, 'KmsKeyId') as kms_key_id, + json_extract_path_text(Properties, 'SQName') as sq_name, + json_extract_path_text(Properties, 'SQQueryString') as sq_query_string, + json_extract_path_text(Properties, 'SQScheduleConfiguration') as sq_schedule_configuration, + json_extract_path_text(Properties, 'SQNotificationConfiguration') as sq_notification_configuration, + json_extract_path_text(Properties, 'SQScheduledQueryExecutionRoleArn') as sq_scheduled_query_execution_role_arn, + json_extract_path_text(Properties, 'SQTargetConfiguration') as sq_target_configuration, + json_extract_path_text(Properties, 'SQErrorReportConfiguration') as sq_error_report_configuration, + json_extract_path_text(Properties, 'SQKmsKeyId') as sq_kms_key_id, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Timestream::ScheduledQuery' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Timestream::ScheduledQuery' + AND region = 'us-east-1' tables: name: tables id: aws.timestream.tables @@ -2012,7 +1976,7 @@ components: x-identifiers: - DatabaseName - TableName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2029,9 +1993,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2041,44 +2005,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/tables/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/tables/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.DatabaseName') as database_name, - JSON_EXTRACT(Properties, '$.TableName') as table_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Timestream::Table' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'DatabaseName') as database_name, - json_extract_path_text(Properties, 'TableName') as table_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Timestream::Table' - AND region = 'us-east-1' - table: - name: table - id: aws.timestream.table - x-cfn-schema-name: Table - x-cfn-type-name: AWS::Timestream::Table - x-identifiers: - - DatabaseName - - TableName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2089,12 +2018,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/tables/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/tables/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/table/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/tables/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2111,22 +2044,40 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'DatabaseName') as database_name, - json_extract_path_text(Properties, 'TableName') as table_name, - json_extract_path_text(Properties, 'RetentionProperties') as retention_properties, - json_extract_path_text(Properties, 'Schema') as _schema, - json_extract_path_text(Properties, 'MagneticStoreWriteProperties') as magnetic_store_write_properties, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Timestream::Table' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.DatabaseName') as database_name, + JSON_EXTRACT(Properties, '$.TableName') as table_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Timestream::Table' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'DatabaseName') as database_name, + json_extract_path_text(Properties, 'TableName') as table_name, + json_extract_path_text(Properties, 'RetentionProperties') as retention_properties, + json_extract_path_text(Properties, 'Schema') as _schema, + json_extract_path_text(Properties, 'MagneticStoreWriteProperties') as magnetic_store_write_properties, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Timestream::Table' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DatabaseName') as database_name, + json_extract_path_text(Properties, 'TableName') as table_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Timestream::Table' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/transfer.yaml b/providers/src/aws/v00.00.00000/services/transfer.yaml index 3036e351..c0dbb758 100644 --- a/providers/src/aws/v00.00.00000/services/transfer.yaml +++ b/providers/src/aws/v00.00.00000/services/transfer.yaml @@ -385,133 +385,70 @@ components: $ref: '#/components/x-cloud-control-schemas/ProgressEvent' type: object schemas: - Tag: - description: Creates a key-value pair for a specific resource. + user_public_keys: + description: Details of a Transfer family server tags type: object - properties: - Key: - type: string - description: The name assigned to the tag that you create. - minLength: 1 - maxLength: 128 - Value: - type: string - description: Contains one or more values that you assigned to the key name you create. - minLength: 0 - maxLength: 256 - required: - - Key - - Value additionalProperties: false - Agreement: - type: object properties: - Description: - description: A textual description for the agreement. + data__ServerId: type: string - pattern: ^[\w\- ]*$ - minLength: 1 - maxLength: 200 - ServerId: - description: A unique identifier for the server. + description: The server id + data__UserName: type: string - pattern: ^s-([0-9a-f]{17})$ - minLength: 19 - maxLength: 19 - LocalProfileId: - description: A unique identifier for the local profile. + description: The user name + region: type: string - pattern: ^p-([0-9a-f]{17})$ - minLength: 19 - maxLength: 19 - PartnerProfileId: - description: A unique identifier for the partner profile. + description: The AWS region + ssh_public_key_body: type: string - pattern: ^p-([0-9a-f]{17})$ - minLength: 19 - maxLength: 19 - BaseDirectory: - description: Specifies the base directory for the agreement. + description: The SSH public key body + ssh_public_key_id: type: string - pattern: ^$|/.* - maxLength: 1024 - AccessRole: - description: Specifies the access role for the agreement. + description: The SSH public key id + date_imported: type: string - pattern: arn:.*role/.* - minLength: 20 - maxLength: 2048 - Status: - description: Specifies the status of the agreement. + description: The date imported + x-example-where-clause: WHERE region = '' AND data__ServerId = '' AND data__UserName = '' + server_tags: + description: Details of a Transfer family server tags + type: object + additionalProperties: false + properties: + data__ServerId: type: string - enum: - - ACTIVE - - INACTIVE - Tags: - description: Key-value pairs that can be used to group and search for agreements. Tags are metadata attached to agreements for any purpose. - type: array - maxItems: 50 - uniqueItems: true - x-insertionOrder: false - items: - $ref: '#/components/schemas/Tag' - AgreementId: - description: A unique identifier for the agreement. + description: The server id + region: type: string - pattern: ^a-([0-9a-f]{17})$ - minLength: 19 - maxLength: 19 - Arn: - description: Specifies the unique Amazon Resource Name (ARN) for the agreement. + description: The AWS region + key: type: string - pattern: arn:.* - minLength: 20 - maxLength: 1600 - required: - - ServerId - - LocalProfileId - - PartnerProfileId - - BaseDirectory - - AccessRole - x-stackql-resource-name: agreement - description: Resource Type definition for AWS::Transfer::Agreement - x-type-name: AWS::Transfer::Agreement - x-stackql-primary-identifier: - - AgreementId - - ServerId - x-create-only-properties: - - ServerId - x-read-only-properties: - - AgreementId - - Arn - x-required-properties: - - ServerId - - LocalProfileId - - PartnerProfileId - - BaseDirectory - - AccessRole - x-tagging: - taggable: true - tagOnCreate: true - tagUpdatable: true - cloudFormationSystemTags: true - tagProperty: /properties/Tags - x-required-permissions: - create: - - transfer:CreateAgreement - - transfer:TagResource - - iam:PassRole - read: - - transfer:DescribeAgreement - update: - - transfer:UpdateAgreement - - transfer:UnTagResource - - transfer:TagResource - - iam:PassRole - delete: - - transfer:DeleteAgreement - list: - - transfer:ListAgreements + description: The key of the tag + value: + type: string + description: The value of the tag + x-example-where-clause: WHERE region = '' AND data__ServerId = '' + AccessDeniedException: {} + AddressAllocationId: + type: string + AddressAllocationIds: + type: array + items: + $ref: '#/components/schemas/AddressAllocationId' + Arn: + type: string + pattern: arn:.* + minLength: 20 + maxLength: 1600 + As2Transport: + type: string + enum: + - HTTP + As2Transports: + type: array + items: + $ref: '#/components/schemas/As2Transport' + minItems: 1 + maxItems: 1 Certificate: type: object properties: @@ -521,22 +458,23 @@ components: enum: - SIGNING - ENCRYPTION + - TLS Certificate: description: Specifies the certificate body to be imported. type: string - pattern: "^[\t\n\r -ÿ]*" + pattern: ^[\t\n\r\u0020-\u00FF]+$ minLength: 1 maxLength: 16384 CertificateChain: description: Specifies the certificate chain to be imported. type: string - pattern: "^[\t\n\r -ÿ]*" + pattern: ^[\t\n\r\u0020-\u00FF]+$ minLength: 1 maxLength: 2097152 PrivateKey: description: Specifies the private key for the certificate. type: string - pattern: "^[\t\n\r -ÿ]*" + pattern: ^[\t\n\r\u0020-\u00FF]+$ minLength: 1 maxLength: 16384 ActiveDate: @@ -548,7 +486,7 @@ components: Description: description: A textual description for the certificate. type: string - pattern: ^[\w\- ]*$ + pattern: ^[\u0021-\u007E]+$ minLength: 1 maxLength: 200 Tags: @@ -587,7 +525,7 @@ components: Serial: description: Specifies Certificate's serial. type: string - pattern: ^[\p{XDigit}{2}:?]* + pattern: ^[0-9a-fA-F{}:?]*$ minLength: 0 maxLength: 48 NotBeforeDate: @@ -641,1589 +579,2280 @@ components: - transfer:DeleteCertificate list: - transfer:ListCertificates - SftpConnectorTrustedHostKey: - description: The public host key for the external server to which you are connecting. + ConflictException: {} + CreateServerRequest: + type: object + title: CreateServerRequest + properties: + Certificate: + $ref: '#/components/schemas/Certificate' + Domain: + $ref: '#/components/schemas/Domain' + EndpointDetails: + $ref: '#/components/schemas/EndpointDetails' + EndpointType: + $ref: '#/components/schemas/EndpointType' + HostKey: + $ref: '#/components/schemas/HostKey' + IdentityProviderDetails: + $ref: '#/components/schemas/IdentityProviderDetails' + IdentityProviderType: + $ref: '#/components/schemas/IdentityProviderType' + LoggingRole: + $ref: '#/components/schemas/Role' + PostAuthenticationLoginBanner: + $ref: '#/components/schemas/PostAuthenticationLoginBanner' + PreAuthenticationLoginBanner: + $ref: '#/components/schemas/PreAuthenticationLoginBanner' + Protocols: + $ref: '#/components/schemas/Protocols' + ProtocolDetails: + $ref: '#/components/schemas/ProtocolDetails' + SecurityPolicyName: + $ref: '#/components/schemas/SecurityPolicyName' + Tags: + $ref: '#/components/schemas/Tags' + WorkflowDetails: + $ref: '#/components/schemas/WorkflowDetails' + StructuredLogDestinations: + $ref: '#/components/schemas/StructuredLogDestinations' + CreateServerResponse: + type: object + required: + - ServerId + properties: + ServerId: + $ref: '#/components/schemas/ServerId' + CreateUserRequest: + type: object + required: + - Role + - ServerId + - UserName + title: CreateUserRequest + properties: + HomeDirectory: + $ref: '#/components/schemas/HomeDirectory' + HomeDirectoryType: + $ref: '#/components/schemas/HomeDirectoryType' + HomeDirectoryMappings: + $ref: '#/components/schemas/HomeDirectoryMappings' + Policy: + $ref: '#/components/schemas/Policy' + PosixProfile: + $ref: '#/components/schemas/PosixProfile' + Role: + $ref: '#/components/schemas/Role' + ServerId: + $ref: '#/components/schemas/ServerId' + SshPublicKeyBody: + $ref: '#/components/schemas/SshPublicKeyBody' + Tags: + $ref: '#/components/schemas/Tags' + UserName: + $ref: '#/components/schemas/UserName' + CreateUserResponse: + type: object + required: + - ServerId + - UserName + properties: + ServerId: + $ref: '#/components/schemas/ServerId' + UserName: + $ref: '#/components/schemas/UserName' + DateImported: type: string - minLength: 1 - maxLength: 2048 - Connector: + format: date-time + DeleteServerRequest: type: object + required: + - ServerId + title: DeleteServerRequest properties: - AccessRole: - description: Specifies the access role for the connector. - type: string - pattern: arn:.*role/.* - minLength: 20 - maxLength: 2048 - As2Config: - description: Configuration for an AS2 connector. + ServerId: + $ref: '#/components/schemas/ServerId' + DeleteSshPublicKeyRequest: + type: object + required: + - ServerId + - SshPublicKeyId + - UserName + title: DeleteSshPublicKeyRequest + properties: + ServerId: + $ref: '#/components/schemas/ServerId' + SshPublicKeyId: + $ref: '#/components/schemas/SshPublicKeyId' + UserName: + $ref: '#/components/schemas/UserName' + DeleteUserRequest: + type: object + required: + - ServerId + - UserName + title: DeleteUserRequest + properties: + ServerId: + $ref: '#/components/schemas/ServerId' + UserName: + $ref: '#/components/schemas/UserName' + DescribeServerRequest: + type: object + required: + - ServerId + title: DescribeServerRequest + properties: + ServerId: + $ref: '#/components/schemas/ServerId' + DescribeServerResponse: + type: object + required: + - Server + properties: + Server: + $ref: '#/components/schemas/DescribedServer' + DescribeUserRequest: + type: object + required: + - ServerId + - UserName + title: DescribeUserRequest + properties: + ServerId: + $ref: '#/components/schemas/ServerId' + UserName: + $ref: '#/components/schemas/UserName' + DescribeUserResponse: + type: object + required: + - ServerId + - User + properties: + ServerId: + $ref: '#/components/schemas/ServerId' + User: + $ref: '#/components/schemas/DescribedUser' + DescribedServer: + type: object + required: + - Arn + properties: + Arn: + $ref: '#/components/schemas/Arn' + Certificate: + $ref: '#/components/schemas/Certificate' + ProtocolDetails: + $ref: '#/components/schemas/ProtocolDetails' + Domain: + $ref: '#/components/schemas/Domain' + EndpointDetails: + $ref: '#/components/schemas/EndpointDetails' + EndpointType: + $ref: '#/components/schemas/EndpointType' + HostKeyFingerprint: + $ref: '#/components/schemas/HostKeyFingerprint' + IdentityProviderDetails: + $ref: '#/components/schemas/IdentityProviderDetails' + IdentityProviderType: + $ref: '#/components/schemas/IdentityProviderType' + LoggingRole: + $ref: '#/components/schemas/Role' + PostAuthenticationLoginBanner: + $ref: '#/components/schemas/PostAuthenticationLoginBanner' + PreAuthenticationLoginBanner: + $ref: '#/components/schemas/PreAuthenticationLoginBanner' + Protocols: + $ref: '#/components/schemas/Protocols' + S3StorageOptions: type: object - properties: - LocalProfileId: - type: string - description: A unique identifier for the local profile. - pattern: ^p-([0-9a-f]{17})$ - minLength: 19 - maxLength: 19 - PartnerProfileId: - type: string - description: A unique identifier for the partner profile. - pattern: ^p-([0-9a-f]{17})$ - minLength: 19 - maxLength: 19 - MessageSubject: - type: string - description: The message subject for this AS2 connector configuration. - pattern: ^[\p{Print}\p{Blank}]+ - minLength: 1 - maxLength: 1024 - Compression: - type: string - description: Compression setting for this AS2 connector configuration. - enum: - - ZLIB - - DISABLED - EncryptionAlgorithm: - type: string - description: Encryption algorithm for this AS2 connector configuration. - enum: - - AES128_CBC - - AES192_CBC - - AES256_CBC - - NONE - SigningAlgorithm: - type: string - description: Signing algorithm for this AS2 connector configuration. - enum: - - SHA256 - - SHA384 - - SHA512 - - SHA1 - - NONE - MdnSigningAlgorithm: - type: string - description: MDN Signing algorithm for this AS2 connector configuration. - enum: - - SHA256 - - SHA384 - - SHA512 - - SHA1 - - NONE - - DEFAULT - MdnResponse: - type: string - description: MDN Response setting for this AS2 connector configuration. - enum: - - SYNC - - NONE - BasicAuthSecretId: - type: string - description: ARN or name of the secret in AWS Secrets Manager which contains the credentials for Basic authentication. If empty, Basic authentication is disabled for the AS2 connector - minLength: 0 - maxLength: 2048 - additionalProperties: false - SftpConfig: - description: Configuration for an SFTP connector. - type: object - properties: - UserSecretId: - type: string - description: ARN or name of the secret in AWS Secrets Manager which contains the SFTP user's private keys or passwords. - minLength: 1 - maxLength: 2048 - TrustedHostKeys: - description: List of public host keys, for the external server to which you are connecting. - type: array - maxItems: 10 - uniqueItems: false - x-insertionOrder: false - items: - $ref: '#/components/schemas/SftpConnectorTrustedHostKey' - additionalProperties: false - Arn: - description: Specifies the unique Amazon Resource Name (ARN) for the connector. - type: string - pattern: arn:.* - minLength: 20 - maxLength: 1600 - ConnectorId: - description: A unique identifier for the connector. - type: string - pattern: ^c-([0-9a-f]{17})$ - minLength: 19 - maxLength: 19 - LoggingRole: - description: Specifies the logging role for the connector. - type: string - pattern: arn:.*role/.* - minLength: 20 - maxLength: 2048 + SecurityPolicyName: + $ref: '#/components/schemas/SecurityPolicyName' + ServerId: + $ref: '#/components/schemas/ServerId' + State: + $ref: '#/components/schemas/State' Tags: - description: Key-value pairs that can be used to group and search for connectors. Tags are metadata attached to connectors for any purpose. - type: array - maxItems: 50 - uniqueItems: true - x-insertionOrder: false - items: - $ref: '#/components/schemas/Tag' - Url: - description: URL for Connector - type: string - maxLength: 255 + $ref: '#/components/schemas/Tags' + UserCount: + $ref: '#/components/schemas/UserCount' + WorkflowDetails: + $ref: '#/components/schemas/WorkflowDetails' + StructuredLogDestinations: + $ref: '#/components/schemas/StructuredLogDestinations' + description: Describes the properties of a file transfer protocol-enabled server that was specified. + DescribedUser: + type: object required: - - AccessRole - - Url - x-stackql-resource-name: connector - description: Resource Type definition for AWS::Transfer::Connector - x-type-name: AWS::Transfer::Connector - x-stackql-primary-identifier: - - ConnectorId - x-read-only-properties: - Arn - - ConnectorId - x-required-properties: - - AccessRole - - Url - x-tagging: - taggable: true - tagOnCreate: true - tagUpdatable: true - cloudFormationSystemTags: true - tagProperty: /properties/Tags - x-required-permissions: - create: - - transfer:CreateConnector - - transfer:TagResource - - iam:PassRole - read: - - transfer:DescribeConnector - update: - - transfer:UpdateConnector - - transfer:UnTagResource - - transfer:TagResource - - iam:PassRole - delete: - - transfer:DeleteConnector - list: - - transfer:ListConnectors - CertificateId: - description: A unique identifier for the certificate. + properties: + Arn: + $ref: '#/components/schemas/Arn' + HomeDirectory: + $ref: '#/components/schemas/HomeDirectory' + HomeDirectoryMappings: + $ref: '#/components/schemas/HomeDirectoryMappings' + HomeDirectoryType: + $ref: '#/components/schemas/HomeDirectoryType' + Policy: + $ref: '#/components/schemas/Policy' + PosixProfile: + $ref: '#/components/schemas/PosixProfile' + Role: + $ref: '#/components/schemas/Role' + SshPublicKeys: + $ref: '#/components/schemas/SshPublicKeys' + Tags: + $ref: '#/components/schemas/Tags' + UserName: + $ref: '#/components/schemas/UserName' + description: Describes the properties of a user that was specified. + DirectoryId: type: string - pattern: ^cert-([0-9a-f]{17})$ - minLength: 22 - maxLength: 22 - Profile: + pattern: ^d-[0-9a-f]{10}$ + minLength: 12 + maxLength: 12 + Domain: + type: string + enum: + - S3 + - EFS + EndpointDetails: type: object properties: - As2Id: - description: AS2 identifier agreed with a trading partner. - type: string - minLength: 1 - maxLength: 128 - ProfileType: - description: Enum specifying whether the profile is local or associated with a trading partner. - type: string - enum: - - LOCAL - - PARTNER - Tags: - description: An array of key-value pairs to apply to this resource. - type: array - uniqueItems: true - maxItems: 50 - x-insertionOrder: false - items: - $ref: '#/components/schemas/Tag' - CertificateIds: - description: List of the certificate IDs associated with this profile to be used for encryption and signing of AS2 messages. - type: array - x-insertionOrder: false - items: - $ref: '#/components/schemas/CertificateId' - Arn: - description: Specifies the unique Amazon Resource Name (ARN) for the profile. - type: string - pattern: arn:.* - minLength: 20 - maxLength: 1600 - ProfileId: - description: A unique identifier for the profile - type: string - pattern: ^p-([0-9a-f]{17})$ - minLength: 19 - maxLength: 19 + AddressAllocationIds: + $ref: '#/components/schemas/AddressAllocationIds' + SubnetIds: + $ref: '#/components/schemas/SubnetIds' + VpcEndpointId: + $ref: '#/components/schemas/VpcEndpointId' + VpcId: + $ref: '#/components/schemas/VpcId' + SecurityGroupIds: + $ref: '#/components/schemas/SecurityGroupIds' + description: >- +

The virtual private cloud (VPC) endpoint settings that are configured for your file transfer protocol-enabled server. With a VPC endpoint, you can restrict access to your server and resources only within your VPC. To control incoming internet traffic, invoke the UpdateServer API and attach an Elastic IP address to your server's endpoint.

After May 19, 2021, you won't be able to create a server using EndpointType=VPC_ENDPOINT in your Amazon Web + Servicesaccount if your account hasn't already done so before May 19, 2021. If you have already created servers with EndpointType=VPC_ENDPOINT in your Amazon Web Servicesaccount on or before May 19, 2021, you will not be affected. After this date, use EndpointType=VPC.

For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.

 + EndpointType: + type: string + enum: + - PUBLIC + - VPC + - VPC_ENDPOINT + Function: + type: string + pattern: ^arn:[a-z-]+:lambda:.*$ + minLength: 1 + maxLength: 170 + HomeDirectory: + type: string + pattern: ^$|/.* + maxLength: 1024 + HomeDirectoryMapEntry: + type: object required: - - As2Id - - ProfileType - x-stackql-resource-name: profile - description: Resource Type definition for AWS::Transfer::Profile - x-type-name: AWS::Transfer::Profile - x-stackql-primary-identifier: - - ProfileId - x-create-only-properties: - - ProfileType - x-read-only-properties: - - Arn - - ProfileId - x-required-properties: - - As2Id - - ProfileType - x-tagging: - taggable: true - tagOnCreate: true - tagUpdatable: true - cloudFormationSystemTags: true - tagProperty: /properties/Tags - x-required-permissions: - create: - - transfer:CreateProfile - - transfer:TagResource - read: - - transfer:DescribeProfile - update: - - transfer:UpdateProfile - - transfer:UnTagResource - - transfer:TagResource - delete: - - transfer:DeleteProfile - list: - - transfer:ListProfiles - S3Tag: - description: Specifies the key-value pair that are assigned to a file during the execution of a Tagging step. + - Entry + - Target + properties: + Entry: + $ref: '#/components/schemas/MapEntry' + Target: + $ref: '#/components/schemas/MapTarget' + description: '

Represents an object that contains entries and targets for HomeDirectoryMappings.

The following is an Entry and Target pair example for chroot.

[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]

' + HomeDirectoryMappings: + type: array + items: + $ref: '#/components/schemas/HomeDirectoryMapEntry' + minItems: 1 + maxItems: 50 + HomeDirectoryType: + type: string + enum: + - PATH + - LOGICAL + HostKey: + type: string + maxLength: 4096 + format: password + HostKeyFingerprint: + type: string + IdentityProviderDetails: type: object properties: - Key: - description: The name assigned to the tag that you create. - type: string - minLength: 1 - maxLength: 128 - Value: - description: The value that corresponds to the key. - type: string - minLength: 0 - maxLength: 256 + Url: + $ref: '#/components/schemas/Url' + InvocationRole: + $ref: '#/components/schemas/Role' + DirectoryId: + $ref: '#/components/schemas/DirectoryId' + Function: + $ref: '#/components/schemas/Function' + SftpAuthenticationMethods: + $ref: '#/components/schemas/SftpAuthenticationMethods' + description: Returns information related to the type of user authentication that is in use for a file transfer protocol-enabled server's users. A server can have only one method of authentication. + IdentityProviderType: + type: string + enum: + - SERVICE_MANAGED + - API_GATEWAY + - AWS_DIRECTORY_SERVICE + - AWS_LAMBDA + description: >- +

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.

+ ImportSshPublicKeyRequest: + type: object required: - - Key - - Value - additionalProperties: false - EfsInputFileLocation: - description: Specifies the details for an EFS file. + - ServerId + - SshPublicKeyBody + - UserName + title: ImportSshPublicKeyRequest + properties: + ServerId: + $ref: '#/components/schemas/ServerId' + SshPublicKeyBody: + $ref: '#/components/schemas/SshPublicKeyBody' + UserName: + $ref: '#/components/schemas/UserName' + ImportSshPublicKeyResponse: type: object + required: + - ServerId + - SshPublicKeyId + - UserName properties: - FileSystemId: - description: Specifies the EFS filesystem that contains the file. - type: string - pattern: ^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:(access-point/fsap|file-system/fs)-[0-9a-f]{8,40}|fs(ap)?-[0-9a-f]{8,40})$ - minLength: 0 - maxLength: 128 - Path: - description: The name assigned to the file when it was created in EFS. You use the object path to retrieve the object. - type: string - pattern: ^[^\x00]+$ - minLength: 1 - maxLength: 65536 - additionalProperties: false - S3InputFileLocation: - description: Specifies the details for a S3 file. + ServerId: + $ref: '#/components/schemas/ServerId' + SshPublicKeyId: + $ref: '#/components/schemas/SshPublicKeyId' + UserName: + $ref: '#/components/schemas/UserName' + description: Identifies the user, the server they belong to, and the identifier of the SSH public key associated with that user. A user can have more than one key on each server that they are associated with. + InternalServiceError: {} + InvalidNextTokenException: {} + InvalidRequestException: {} + ListServersRequest: type: object + title: ListServersRequest properties: - Bucket: - description: Specifies the S3 bucket that contains the file. - type: string - pattern: ^[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]$ - minLength: 3 - maxLength: 63 - Key: - description: The name assigned to the file when it was created in S3. You use the object key to retrieve the object. - type: string - pattern: .* - minLength: 0 - maxLength: 1024 - additionalProperties: false - InputFileLocation: - description: Specifies the location for the file being decrypted. Only applicable for the Decrypt type of workflow steps. + MaxResults: + $ref: '#/components/schemas/MaxResults' + NextToken: + $ref: '#/components/schemas/NextToken' + ListServersResponse: type: object + required: + - Servers properties: - S3FileLocation: - $ref: '#/components/schemas/S3InputFileLocation' - EfsFileLocation: - $ref: '#/components/schemas/EfsInputFileLocation' - additionalProperties: false - S3FileLocation: - description: Specifies the location for the file being copied. Only applicable for the Copy type of workflow steps. + NextToken: + $ref: '#/components/schemas/NextToken' + Servers: + $ref: '#/components/schemas/ListedServers' + ListUsersRequest: type: object + required: + - ServerId + title: ListUsersRequest properties: - S3FileLocation: - $ref: '#/components/schemas/S3InputFileLocation' - additionalProperties: false - WorkflowStep: - description: The basic building block of a workflow. + MaxResults: + $ref: '#/components/schemas/MaxResults' + NextToken: + $ref: '#/components/schemas/NextToken' + ServerId: + $ref: '#/components/schemas/ServerId' + ListUsersResponse: type: object + required: + - ServerId + - Users properties: - CopyStepDetails: - description: Details for a step that performs a file copy. - type: object - properties: - DestinationFileLocation: - $ref: '#/components/schemas/S3FileLocation' - Name: - description: The name of the step, used as an identifier. - type: string - pattern: ^[\w-]*$ - minLength: 0 - maxLength: 30 - OverwriteExisting: - description: A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE. - type: string - enum: - - 'TRUE' - - 'FALSE' - SourceFileLocation: - description: Specifies which file to use as input to the workflow step. - type: string - pattern: ^\$\{(\w+.)+\w+\}$ - minLength: 0 - maxLength: 256 - additionalProperties: false - CustomStepDetails: - description: Details for a step that invokes a lambda function. - type: object - properties: - Name: - description: The name of the step, used as an identifier. - type: string - pattern: ^[\w-]*$ - minLength: 0 - maxLength: 30 - Target: - description: The ARN for the lambda function that is being called. - type: string - pattern: arn:[a-z-]+:lambda:.*$ - minLength: 0 - maxLength: 170 - TimeoutSeconds: - description: Timeout, in seconds, for the step. - type: integer - minimum: 1 - maximum: 1800 - SourceFileLocation: - description: Specifies which file to use as input to the workflow step. - type: string - pattern: ^\$\{(\w+.)+\w+\}$ - minLength: 0 - maxLength: 256 - additionalProperties: false - DecryptStepDetails: - description: Details for a step that performs a file decryption. - type: object - properties: - DestinationFileLocation: - $ref: '#/components/schemas/InputFileLocation' - Name: - description: The name of the step, used as an identifier. - type: string - pattern: ^[\w-]*$ - minLength: 0 - maxLength: 30 - Type: - description: Specifies which encryption method to use. - type: string - enum: - - PGP - OverwriteExisting: - description: A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE. - type: string - enum: - - 'TRUE' - - 'FALSE' - SourceFileLocation: - description: Specifies which file to use as input to the workflow step. - type: string - pattern: ^\$\{(\w+.)+\w+\}$ - minLength: 0 - maxLength: 256 - additionalProperties: false - DeleteStepDetails: - description: Details for a step that deletes the file. - type: object - properties: - Name: - description: The name of the step, used as an identifier. - type: string - pattern: ^[\w-]*$ - minLength: 0 - maxLength: 30 - SourceFileLocation: - description: Specifies which file to use as input to the workflow step. - type: string - pattern: ^\$\{(\w+.)+\w+\}$ - minLength: 0 - maxLength: 256 - additionalProperties: false - TagStepDetails: - description: Details for a step that creates one or more tags. - type: object - properties: - Name: - description: The name of the step, used as an identifier. - type: string - pattern: ^[\w-]*$ - minLength: 0 - maxLength: 30 - Tags: - description: Array that contains from 1 to 10 key/value pairs. - type: array - maxItems: 10 - uniqueItems: true - x-insertionOrder: false - items: - $ref: '#/components/schemas/S3Tag' - SourceFileLocation: - description: Specifies which file to use as input to the workflow step. - type: string - pattern: ^\$\{(\w+.)+\w+\}$ - minLength: 0 - maxLength: 256 - additionalProperties: false - Type: - type: string - enum: - - COPY - - CUSTOM - - DECRYPT - - DELETE - - TAG - additionalProperties: false - Workflow: + NextToken: + $ref: '#/components/schemas/NextToken' + ServerId: + $ref: '#/components/schemas/ServerId' + Users: + $ref: '#/components/schemas/ListedUsers' + ListedServer: type: object + required: + - Arn properties: - OnExceptionSteps: - description: Specifies the steps (actions) to take if any errors are encountered during execution of the workflow. - type: array - maxItems: 8 - uniqueItems: true - x-insertionOrder: true - items: - $ref: '#/components/schemas/WorkflowStep' - Steps: - description: Specifies the details for the steps that are in the specified workflow. - type: array - maxItems: 8 - uniqueItems: true - x-insertionOrder: true - items: - $ref: '#/components/schemas/WorkflowStep' - Tags: - description: Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose. - type: array - maxItems: 50 - uniqueItems: true - x-insertionOrder: false - items: - $ref: '#/components/schemas/Tag' - Description: - description: A textual description for the workflow. - type: string - pattern: ^[\w\- ]*$ - minLength: 0 - maxLength: 256 - WorkflowId: - description: A unique identifier for the workflow. - type: string - pattern: ^w-([a-z0-9]{17})$ - minLength: 19 - maxLength: 19 Arn: - description: Specifies the unique Amazon Resource Name (ARN) for the workflow. - type: string - pattern: arn:.* - minLength: 20 - maxLength: 1600 + $ref: '#/components/schemas/Arn' + Domain: + $ref: '#/components/schemas/Domain' + IdentityProviderType: + $ref: '#/components/schemas/IdentityProviderType' + EndpointType: + $ref: '#/components/schemas/EndpointType' + LoggingRole: + $ref: '#/components/schemas/Role' + ServerId: + $ref: '#/components/schemas/ServerId' + State: + $ref: '#/components/schemas/State' + UserCount: + $ref: '#/components/schemas/UserCount' + description: Returns properties of a file transfer protocol-enabled server that was specified. + ListedServers: + type: array + items: + $ref: '#/components/schemas/ListedServer' + ListedUser: + type: object required: - - Steps - x-stackql-resource-name: workflow - description: Resource Type definition for AWS::Transfer::Workflow - x-type-name: AWS::Transfer::Workflow - x-stackql-primary-identifier: - - WorkflowId - x-create-only-properties: - - Steps - - OnExceptionSteps - - Description - x-read-only-properties: - - WorkflowId - Arn - x-required-properties: - - Steps - x-taggable: true - x-required-permissions: - create: - - transfer:CreateWorkflow - - transfer:TagResource - read: - - transfer:DescribeWorkflow - delete: - - transfer:DeleteWorkflow - list: - - transfer:ListWorkflows - update: - - transfer:UnTagResource - - transfer:TagResource - CreateAgreementRequest: properties: - ClientToken: - type: string - RoleArn: - type: string - TypeName: - type: string - TypeVersionId: - type: string - DesiredState: - type: object - properties: - Description: - description: A textual description for the agreement. - type: string - pattern: ^[\w\- ]*$ - minLength: 1 - maxLength: 200 - ServerId: - description: A unique identifier for the server. - type: string - pattern: ^s-([0-9a-f]{17})$ - minLength: 19 - maxLength: 19 - LocalProfileId: - description: A unique identifier for the local profile. - type: string - pattern: ^p-([0-9a-f]{17})$ - minLength: 19 - maxLength: 19 - PartnerProfileId: - description: A unique identifier for the partner profile. - type: string - pattern: ^p-([0-9a-f]{17})$ - minLength: 19 - maxLength: 19 - BaseDirectory: - description: Specifies the base directory for the agreement. - type: string - pattern: ^$|/.* - maxLength: 1024 - AccessRole: - description: Specifies the access role for the agreement. - type: string - pattern: arn:.*role/.* - minLength: 20 - maxLength: 2048 - Status: - description: Specifies the status of the agreement. - type: string - enum: - - ACTIVE - - INACTIVE - Tags: - description: Key-value pairs that can be used to group and search for agreements. Tags are metadata attached to agreements for any purpose. - type: array - maxItems: 50 - uniqueItems: true - x-insertionOrder: false - items: - $ref: '#/components/schemas/Tag' - AgreementId: - description: A unique identifier for the agreement. - type: string - pattern: ^a-([0-9a-f]{17})$ - minLength: 19 - maxLength: 19 - Arn: - description: Specifies the unique Amazon Resource Name (ARN) for the agreement. - type: string - pattern: arn:.* - minLength: 20 - maxLength: 1600 - x-stackQL-stringOnly: true - x-title: CreateAgreementRequest + Arn: + $ref: '#/components/schemas/Arn' + HomeDirectory: + $ref: '#/components/schemas/HomeDirectory' + HomeDirectoryType: + $ref: '#/components/schemas/HomeDirectoryType' + Role: + $ref: '#/components/schemas/Role' + SshPublicKeyCount: + $ref: '#/components/schemas/SshPublicKeyCount' + UserName: + $ref: '#/components/schemas/UserName' + description: Returns properties of the user that you specify. + ListedUsers: + type: array + items: + $ref: '#/components/schemas/ListedUser' + MapEntry: + type: string + pattern: ^/.* + maxLength: 1024 + MapTarget: + type: string + pattern: ^/.* + maxLength: 1024 + MaxResults: + type: integer + minimum: 1 + maximum: 1000 + NextToken: + type: string + minLength: 1 + maxLength: 6144 + NullableRole: + type: string + pattern: ^$|arn:.*role/.* + maxLength: 2048 + OnPartialUploadWorkflowDetails: + type: array + items: + $ref: '#/components/schemas/WorkflowDetail' + maxItems: 1 + OnUploadWorkflowDetails: + type: array + items: + $ref: '#/components/schemas/WorkflowDetail' + maxItems: 1 + PassiveIp: + type: string + maxLength: 15 + Policy: + type: string + maxLength: 2048 + PosixId: + type: integer + minimum: 0 + maximum: 4294967295 + PosixProfile: type: object - required: [] - CreateCertificateRequest: + required: + - Uid + - Gid properties: - ClientToken: - type: string - RoleArn: - type: string - TypeName: - type: string - TypeVersionId: - type: string - DesiredState: - type: object - properties: - Usage: - description: Specifies the usage type for the certificate. - type: string - enum: - - SIGNING - - ENCRYPTION - Certificate: - description: Specifies the certificate body to be imported. - type: string - pattern: "^[\t\n\r -ÿ]*" - minLength: 1 - maxLength: 16384 - CertificateChain: - description: Specifies the certificate chain to be imported. - type: string - pattern: "^[\t\n\r -ÿ]*" - minLength: 1 - maxLength: 2097152 - PrivateKey: - description: Specifies the private key for the certificate. - type: string - pattern: "^[\t\n\r -ÿ]*" - minLength: 1 - maxLength: 16384 - ActiveDate: - description: Specifies the active date for the certificate. - type: string - InactiveDate: - description: Specifies the inactive date for the certificate. - type: string - Description: - description: A textual description for the certificate. - type: string - pattern: ^[\w\- ]*$ - minLength: 1 - maxLength: 200 - Tags: - description: Key-value pairs that can be used to group and search for certificates. Tags are metadata attached to certificates for any purpose. - type: array - maxItems: 50 - uniqueItems: true - x-insertionOrder: false - items: - $ref: '#/components/schemas/Tag' - Arn: - description: Specifies the unique Amazon Resource Name (ARN) for the agreement. - type: string - pattern: arn:.* - minLength: 20 - maxLength: 1600 - CertificateId: - description: A unique identifier for the certificate. - type: string - pattern: ^cert-([0-9a-f]{17})$ - minLength: 22 - maxLength: 22 - Status: - description: A status description for the certificate. - type: string - enum: - - ACTIVE - - PENDING - - INACTIVE - Type: - description: Describing the type of certificate. With or without a private key. - type: string - enum: - - CERTIFICATE - - CERTIFICATE_WITH_PRIVATE_KEY - Serial: - description: Specifies Certificate's serial. - type: string - pattern: ^[\p{XDigit}{2}:?]* - minLength: 0 - maxLength: 48 - NotBeforeDate: - description: Specifies the not before date for the certificate. - type: string - NotAfterDate: - description: Specifies the not after date for the certificate. - type: string - x-stackQL-stringOnly: true - x-title: CreateCertificateRequest + Uid: + $ref: '#/components/schemas/PosixId' + Gid: + $ref: '#/components/schemas/PosixId' + SecondaryGids: + $ref: '#/components/schemas/SecondaryGids' + description: The full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon EFS file systems. The POSIX permissions that are set on files and directories in your file system determine the level of access your users get when transferring files into and out of your Amazon EFS file systems. + PostAuthenticationLoginBanner: + type: string + pattern: '[\x09-\x0D\x20-\x7E]*' + maxLength: 512 + PreAuthenticationLoginBanner: + type: string + pattern: '[\x09-\x0D\x20-\x7E]*' + maxLength: 512 + Protocol: + type: string + enum: + - SFTP + - FTP + - FTPS + - AS2 + ProtocolDetails: type: object - required: [] - CreateConnectorRequest: properties: - ClientToken: - type: string - RoleArn: - type: string - TypeName: + PassiveIp: + $ref: '#/components/schemas/PassiveIp' + TlsSessionResumptionMode: + $ref: '#/components/schemas/TlsSessionResumptionMode' + SetStatOption: + $ref: '#/components/schemas/SetStatOption' + As2Transports: + $ref: '#/components/schemas/As2Transports' + description: ' The protocol settings that are configured for your server. ' + Protocols: + type: array + items: + $ref: '#/components/schemas/Protocol' + minItems: 1 + maxItems: 4 + ResourceExistsException: {} + ResourceNotFoundException: {} + Role: + type: string + pattern: arn:.*role/.* + minLength: 20 + maxLength: 2048 + SecondaryGids: + type: array + items: + $ref: '#/components/schemas/PosixId' + minItems: 0 + maxItems: 16 + SecurityGroupId: + type: string + pattern: ^sg-[0-9a-f]{8,17}$ + minLength: 11 + maxLength: 20 + SecurityGroupIds: + type: array + items: + $ref: '#/components/schemas/SecurityGroupId' + SecurityPolicyName: + type: string + pattern: TransferSecurityPolicy-.+ + maxLength: 100 + ServerId: + type: string + pattern: ^s-([0-9a-f]{17})$ + minLength: 19 + maxLength: 19 + ServiceUnavailableException: {} + SetStatOption: + type: string + enum: + - DEFAULT + - ENABLE_NO_OP + SftpAuthenticationMethods: + type: string + enum: + - PASSWORD + - PUBLIC_KEY + - PUBLIC_KEY_OR_PASSWORD + - PUBLIC_KEY_AND_PASSWORD + SshPublicKey: + type: object + required: + - DateImported + - SshPublicKeyBody + - SshPublicKeyId + properties: + DateImported: + $ref: '#/components/schemas/DateImported' + SshPublicKeyBody: + $ref: '#/components/schemas/SshPublicKeyBody' + SshPublicKeyId: + $ref: '#/components/schemas/SshPublicKeyId' + description: Provides information about the public Secure Shell (SSH) key that is associated with a Transfer Family user for the specific file transfer protocol-enabled server (as identified by ServerId). The information returned includes the date the key was imported, the public key contents, and the public key ID. A user can store more than one SSH public key associated with their user name on a specific server. + SshPublicKeyBody: + type: string + maxLength: 2048 + SshPublicKeyCount: + type: integer + SshPublicKeyId: + type: string + pattern: ^key-[0-9a-f]{17}$ + minLength: 21 + maxLength: 21 + SshPublicKeys: + type: array + items: + $ref: '#/components/schemas/SshPublicKey' + maxItems: 5 + StartServerRequest: + type: object + required: + - ServerId + title: StartServerRequest + properties: + ServerId: + $ref: '#/components/schemas/ServerId' + State: + type: string + enum: + - OFFLINE + - ONLINE + - STARTING + - STOPPING + - START_FAILED + - STOP_FAILED + description: >- +

Describes the condition of a file transfer protocol-enabled server with respect to its ability to perform file operations. There are six possible states: OFFLINE, ONLINE, STARTING, STOPPING, START_FAILED, and STOP_FAILED.

OFFLINE indicates that the server exists, but that it is not available for file operations. ONLINE indicates that the server is available to perform file + operations. STARTING indicates that the server's was instantiated, but the server is not yet available to perform file operations. Under normal conditions, it can take a couple of minutes for the server to be completely operational. Both START_FAILED and STOP_FAILED are error conditions.

+ StopServerRequest: + type: object + title: StopServerRequest + properties: + ServerId: + $ref: '#/components/schemas/ServerId' + StructuredLogDestinations: + type: array + items: + $ref: '#/components/schemas/Arn' + minItems: 0 + maxItems: 1 + SubnetId: + type: string + SubnetIds: + type: array + items: + $ref: '#/components/schemas/SubnetId' + Tag: + description: Creates a key-value pair for a specific resource. + type: object + properties: + Key: type: string - TypeVersionId: + description: The name assigned to the tag that you create. + minLength: 1 + maxLength: 128 + Value: type: string - DesiredState: - type: object - properties: - AccessRole: - description: Specifies the access role for the connector. - type: string - pattern: arn:.*role/.* - minLength: 20 - maxLength: 2048 - As2Config: - description: Configuration for an AS2 connector. - type: object - properties: - LocalProfileId: - type: string - description: A unique identifier for the local profile. - pattern: ^p-([0-9a-f]{17})$ - minLength: 19 - maxLength: 19 - PartnerProfileId: - type: string - description: A unique identifier for the partner profile. - pattern: ^p-([0-9a-f]{17})$ - minLength: 19 - maxLength: 19 - MessageSubject: - type: string - description: The message subject for this AS2 connector configuration. - pattern: ^[\p{Print}\p{Blank}]+ - minLength: 1 - maxLength: 1024 - Compression: - type: string - description: Compression setting for this AS2 connector configuration. - enum: - - ZLIB - - DISABLED - EncryptionAlgorithm: - type: string - description: Encryption algorithm for this AS2 connector configuration. - enum: - - AES128_CBC - - AES192_CBC - - AES256_CBC - - NONE - SigningAlgorithm: - type: string - description: Signing algorithm for this AS2 connector configuration. - enum: - - SHA256 - - SHA384 - - SHA512 - - SHA1 - - NONE - MdnSigningAlgorithm: - type: string - description: MDN Signing algorithm for this AS2 connector configuration. - enum: - - SHA256 - - SHA384 - - SHA512 - - SHA1 - - NONE - - DEFAULT - MdnResponse: - type: string - description: MDN Response setting for this AS2 connector configuration. - enum: - - SYNC - - NONE - BasicAuthSecretId: - type: string - description: ARN or name of the secret in AWS Secrets Manager which contains the credentials for Basic authentication. If empty, Basic authentication is disabled for the AS2 connector - minLength: 0 - maxLength: 2048 - additionalProperties: false - SftpConfig: - description: Configuration for an SFTP connector. - type: object - properties: - UserSecretId: - type: string - description: ARN or name of the secret in AWS Secrets Manager which contains the SFTP user's private keys or passwords. - minLength: 1 - maxLength: 2048 - TrustedHostKeys: - description: List of public host keys, for the external server to which you are connecting. - type: array - maxItems: 10 - uniqueItems: false - x-insertionOrder: false - items: - $ref: '#/components/schemas/SftpConnectorTrustedHostKey' - additionalProperties: false - Arn: - description: Specifies the unique Amazon Resource Name (ARN) for the connector. - type: string - pattern: arn:.* - minLength: 20 - maxLength: 1600 - ConnectorId: - description: A unique identifier for the connector. - type: string - pattern: ^c-([0-9a-f]{17})$ - minLength: 19 - maxLength: 19 - LoggingRole: - description: Specifies the logging role for the connector. - type: string - pattern: arn:.*role/.* - minLength: 20 - maxLength: 2048 - Tags: - description: Key-value pairs that can be used to group and search for connectors. Tags are metadata attached to connectors for any purpose. - type: array - maxItems: 50 - uniqueItems: true - x-insertionOrder: false - items: - $ref: '#/components/schemas/Tag' - Url: - description: URL for Connector - type: string - maxLength: 255 - x-stackQL-stringOnly: true - x-title: CreateConnectorRequest + description: Contains one or more values that you assigned to the key name you create. + minLength: 0 + maxLength: 256 + required: + - Key + - Value + additionalProperties: false + TagKey: + type: string + maxLength: 128 + TagValue: + type: string + maxLength: 256 + Tags: + type: array + items: + $ref: '#/components/schemas/Tag' + minItems: 1 + maxItems: 50 + ThrottlingException: {} + TlsSessionResumptionMode: + type: string + enum: + - DISABLED + - ENABLED + - ENFORCED + UpdateServerRequest: type: object - required: [] - CreateProfileRequest: + required: + - ServerId + title: UpdateServerRequest properties: - ClientToken: - type: string - RoleArn: + Certificate: + $ref: '#/components/schemas/Certificate' + ProtocolDetails: + $ref: '#/components/schemas/ProtocolDetails' + EndpointDetails: + $ref: '#/components/schemas/EndpointDetails' + EndpointType: + $ref: '#/components/schemas/EndpointType' + HostKey: + $ref: '#/components/schemas/HostKey' + IdentityProviderDetails: + $ref: '#/components/schemas/IdentityProviderDetails' + LoggingRole: + $ref: '#/components/schemas/NullableRole' + PostAuthenticationLoginBanner: + $ref: '#/components/schemas/PostAuthenticationLoginBanner' + PreAuthenticationLoginBanner: + $ref: '#/components/schemas/PreAuthenticationLoginBanner' + Protocols: + $ref: '#/components/schemas/Protocols' + SecurityPolicyName: + $ref: '#/components/schemas/SecurityPolicyName' + ServerId: + $ref: '#/components/schemas/ServerId' + WorkflowDetails: + $ref: '#/components/schemas/WorkflowDetails' + StructuredLogDestinations: + $ref: '#/components/schemas/StructuredLogDestinations' + UpdateServerResponse: + type: object + required: + - ServerId + properties: + ServerId: + $ref: '#/components/schemas/ServerId' + UpdateUserRequest: + type: object + required: + - ServerId + - UserName + title: UpdateUserRequest + properties: + HomeDirectory: + $ref: '#/components/schemas/HomeDirectory' + HomeDirectoryType: + $ref: '#/components/schemas/HomeDirectoryType' + HomeDirectoryMappings: + $ref: '#/components/schemas/HomeDirectoryMappings' + Policy: + $ref: '#/components/schemas/Policy' + PosixProfile: + $ref: '#/components/schemas/PosixProfile' + Role: + $ref: '#/components/schemas/Role' + ServerId: + $ref: '#/components/schemas/ServerId' + UserName: + $ref: '#/components/schemas/UserName' + UpdateUserResponse: + type: object + required: + - ServerId + - UserName + properties: + ServerId: + $ref: '#/components/schemas/ServerId' + UserName: + $ref: '#/components/schemas/UserName' + description: ' UpdateUserResponse returns the user name and identifier for the request to update a user''s properties.' + Url: + type: string + maxLength: 255 + UserCount: + type: integer + UserName: + type: string + pattern: ^[\w][\w@.-]{2,99}$ + minLength: 3 + maxLength: 100 + VpcEndpointId: + type: string + pattern: ^vpce-[0-9a-f]{17}$ + minLength: 22 + maxLength: 22 + VpcId: + type: string + WorkflowDetail: + type: object + required: + - WorkflowId + - ExecutionRole + properties: + WorkflowId: + $ref: '#/components/schemas/WorkflowId' + ExecutionRole: + $ref: '#/components/schemas/Role' + description:

Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.

In addition to a workflow to execute when a file is uploaded completely, WorkflowDetails can also contain a workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs when the server session disconnects while the file is still being uploaded.

+ WorkflowDetails: + type: object + properties: + OnUpload: + $ref: '#/components/schemas/OnUploadWorkflowDetails' + OnPartialUpload: + $ref: '#/components/schemas/OnPartialUploadWorkflowDetails' + description: Container for the WorkflowDetail data type. It is used by actions that trigger a workflow to begin execution. + WorkflowId: + type: string + pattern: ^w-([a-z0-9]{17})$ + minLength: 19 + maxLength: 19 + Agreement: + type: object + properties: + Description: + description: A textual description for the agreement. type: string - TypeName: + pattern: ^[\u0021-\u007E]+$ + minLength: 1 + maxLength: 200 + ServerId: + description: A unique identifier for the server. type: string - TypeVersionId: + pattern: ^s-([0-9a-f]{17})$ + minLength: 19 + maxLength: 19 + LocalProfileId: + description: A unique identifier for the local profile. type: string - DesiredState: - type: object - properties: - As2Id: - description: AS2 identifier agreed with a trading partner. - type: string - minLength: 1 - maxLength: 128 - ProfileType: - description: Enum specifying whether the profile is local or associated with a trading partner. - type: string - enum: - - LOCAL - - PARTNER - Tags: - description: An array of key-value pairs to apply to this resource. - type: array - uniqueItems: true - maxItems: 50 - x-insertionOrder: false - items: - $ref: '#/components/schemas/Tag' - CertificateIds: - description: List of the certificate IDs associated with this profile to be used for encryption and signing of AS2 messages. - type: array - x-insertionOrder: false - items: - $ref: '#/components/schemas/CertificateId' - Arn: - description: Specifies the unique Amazon Resource Name (ARN) for the profile. - type: string - pattern: arn:.* - minLength: 20 - maxLength: 1600 - ProfileId: - description: A unique identifier for the profile - type: string - pattern: ^p-([0-9a-f]{17})$ - minLength: 19 - maxLength: 19 - x-stackQL-stringOnly: true - x-title: CreateProfileRequest - type: object - required: [] - CreateWorkflowRequest: - properties: - ClientToken: + pattern: ^p-([0-9a-f]{17})$ + minLength: 19 + maxLength: 19 + PartnerProfileId: + description: A unique identifier for the partner profile. type: string - RoleArn: + pattern: ^p-([0-9a-f]{17})$ + minLength: 19 + maxLength: 19 + BaseDirectory: + description: Specifies the base directory for the agreement. type: string - TypeName: + pattern: ^(|/.*)$ + maxLength: 1024 + AccessRole: + description: Specifies the access role for the agreement. type: string - TypeVersionId: + pattern: arn:.*role/.* + minLength: 20 + maxLength: 2048 + Status: + description: Specifies the status of the agreement. type: string - DesiredState: - type: object - properties: - OnExceptionSteps: - description: Specifies the steps (actions) to take if any errors are encountered during execution of the workflow. - type: array - maxItems: 8 - uniqueItems: true - x-insertionOrder: true - items: - $ref: '#/components/schemas/WorkflowStep' - Steps: - description: Specifies the details for the steps that are in the specified workflow. - type: array - maxItems: 8 - uniqueItems: true - x-insertionOrder: true - items: - $ref: '#/components/schemas/WorkflowStep' - Tags: - description: Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose. - type: array - maxItems: 50 - uniqueItems: true - x-insertionOrder: false - items: - $ref: '#/components/schemas/Tag' - Description: - description: A textual description for the workflow. - type: string - pattern: ^[\w\- ]*$ - minLength: 0 - maxLength: 256 - WorkflowId: - description: A unique identifier for the workflow. - type: string - pattern: ^w-([a-z0-9]{17})$ - minLength: 19 - maxLength: 19 - Arn: - description: Specifies the unique Amazon Resource Name (ARN) for the workflow. - type: string - pattern: arn:.* - minLength: 20 - maxLength: 1600 - x-stackQL-stringOnly: true - x-title: CreateWorkflowRequest - type: object - required: [] - region: - type: string - description: The AWS region - servers: - description: List of Transfer family servers in a region - type: object - additionalProperties: false - properties: - arn: - type: string - description: Unique Amazon Resource Name (ARN) for the server. - domain: - type: string - description: The domain of the server - endpoint_type: - type: string - description: The endpoint type of the server - identity_provider_type: - type: string - description: The mode of authentication for a server. The default - logging_role: + enum: + - ACTIVE + - INACTIVE + Tags: + description: Key-value pairs that can be used to group and search for agreements. Tags are metadata attached to agreements for any purpose. + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + AgreementId: + description: A unique identifier for the agreement. type: string - description: The logging role of the server - server_id: + pattern: ^a-([0-9a-f]{17})$ + minLength: 19 + maxLength: 19 + Arn: + description: Specifies the unique Amazon Resource Name (ARN) for the agreement. type: string - description: The server id - state: - type: string - description: >- - Describes the condition of a file transfer protocol-enabled server with respect to its ability to perform file operations. There are six possible states: OFFLINE, ONLINE, STARTING, STOPPING, START_FAILED, and STOP_FAILED. OFFLINE indicates that the server exists, but that it is not available for file operations. ONLINE indicates that the server is available to perform file operations. STARTING indicates that the server's was instantiated, but the server is not yet available to - perform file operations. Under normal conditions, it can take a couple of minutes for the server to be completely operational. Both START_FAILED and STOP_FAILED are error conditions. - user_count: - type: integer - description: The user count of the server - region: - $ref: '#/components/schemas/region' - x-example-where-clause: WHERE region = '' - server: - description: Details of a Transfer family server + pattern: arn:.* + minLength: 20 + maxLength: 1600 + required: + - ServerId + - LocalProfileId + - PartnerProfileId + - BaseDirectory + - AccessRole + x-stackql-resource-name: agreement + description: Resource Type definition for AWS::Transfer::Agreement + x-type-name: AWS::Transfer::Agreement + x-stackql-primary-identifier: + - AgreementId + - ServerId + x-create-only-properties: + - ServerId + x-read-only-properties: + - AgreementId + - Arn + x-required-properties: + - ServerId + - LocalProfileId + - PartnerProfileId + - BaseDirectory + - AccessRole + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + x-required-permissions: + create: + - transfer:CreateAgreement + - transfer:TagResource + - iam:PassRole + read: + - transfer:DescribeAgreement + update: + - transfer:UpdateAgreement + - transfer:UnTagResource + - transfer:TagResource + - iam:PassRole + delete: + - transfer:DeleteAgreement + list: + - transfer:ListAgreements + SftpConnectorTrustedHostKey: + description: The public host key for the external server to which you are connecting. + type: string + minLength: 1 + maxLength: 2048 + Connector: type: object - additionalProperties: false properties: - data__ServerId: - type: string - description: The server id - arn: - type: string - description: Unique Amazon Resource Name (ARN) for the server. - certificate: - type: string - description: The certificate of the server - domain: + AccessRole: + description: Specifies the access role for the connector. type: string - description: The domain of the server - endpoint_details: + pattern: arn:.*role/.* + minLength: 20 + maxLength: 2048 + As2Config: + description: Configuration for an AS2 connector. type: object - description: The virtual private cloud (VPC) endpoint settings that are configured for your file transfer protocol-enabled server. With a VPC endpoint, you can restrict access to your server and resources only within your VPC. To control incoming internet traffic, invoke the UpdateServer API and attach an Elastic IP address to your server's endpoint. - endpoint_type: - type: string - description: The endpoint type of the server - host_key_fingerprint: - type: string - description: The host key fingerprint of the server - identity_provider_details: + properties: + LocalProfileId: + type: string + description: A unique identifier for the local profile. + pattern: ^p-([0-9a-f]{17})$ + minLength: 19 + maxLength: 19 + PartnerProfileId: + type: string + description: A unique identifier for the partner profile. + pattern: ^p-([0-9a-f]{17})$ + minLength: 19 + maxLength: 19 + MessageSubject: + type: string + description: The message subject for this AS2 connector configuration. + pattern: ^[\u0020-\u007E\t]+$ + minLength: 1 + maxLength: 1024 + Compression: + type: string + description: Compression setting for this AS2 connector configuration. + enum: + - ZLIB + - DISABLED + EncryptionAlgorithm: + type: string + description: Encryption algorithm for this AS2 connector configuration. + enum: + - AES128_CBC + - AES192_CBC + - AES256_CBC + - NONE + - DES_EDE3_CBC + SigningAlgorithm: + type: string + description: Signing algorithm for this AS2 connector configuration. + enum: + - SHA256 + - SHA384 + - SHA512 + - SHA1 + - NONE + MdnSigningAlgorithm: + type: string + description: MDN Signing algorithm for this AS2 connector configuration. + enum: + - SHA256 + - SHA384 + - SHA512 + - SHA1 + - NONE + - DEFAULT + MdnResponse: + type: string + description: MDN Response setting for this AS2 connector configuration. + enum: + - SYNC + - NONE + BasicAuthSecretId: + type: string + description: ARN or name of the secret in AWS Secrets Manager which contains the credentials for Basic authentication. If empty, Basic authentication is disabled for the AS2 connector + minLength: 0 + maxLength: 2048 + additionalProperties: false + SftpConfig: + description: Configuration for an SFTP connector. type: object - description: Returns information related to the type of user authentication that is in use for a file transfer protocol-enabled server's users. A server can have only one method of authentication. - identity_provider_type: - type: string - description: The mode of authentication for a server. The default - logging_role: + properties: + UserSecretId: + type: string + description: ARN or name of the secret in AWS Secrets Manager which contains the SFTP user's private keys or passwords. + minLength: 1 + maxLength: 2048 + TrustedHostKeys: + description: List of public host keys, for the external server to which you are connecting. + type: array + maxItems: 10 + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/SftpConnectorTrustedHostKey' + additionalProperties: false + Arn: + description: Specifies the unique Amazon Resource Name (ARN) for the connector. type: string - description: The logging role of the server - post_authentication_login_banner: + pattern: arn:.* + minLength: 20 + maxLength: 1600 + ConnectorId: + description: A unique identifier for the connector. type: string - description: The post authentication login banner of the server - pre_authentication_login_banner: + pattern: ^c-([0-9a-f]{17})$ + minLength: 19 + maxLength: 19 + LoggingRole: + description: Specifies the logging role for the connector. type: string - description: The pre authentication login banner of the server - protocol_details: - type: object - description: The protocol settings that are configured for your server - protocols: + pattern: arn:.*role/.* + minLength: 20 + maxLength: 2048 + ServiceManagedEgressIpAddresses: + description: The list of egress IP addresses of this connector. These IP addresses are assigned automatically when you create the connector. type: array - description: The protocols of the server - s3_storage_options: - type: object - description: The S3 storage options of the server - security_policy_name: - type: string - description: The security policy name of the server - server_id: + items: + type: string + pattern: ^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$ + Tags: + description: Key-value pairs that can be used to group and search for connectors. Tags are metadata attached to connectors for any purpose. + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + Url: + description: URL for Connector type: string - description: The server id - state: + maxLength: 255 + SecurityPolicyName: + description: Security policy for SFTP Connector type: string - description: >- - Describes the condition of a file transfer protocol-enabled server with respect to its ability to perform file operations. There are six possible states: OFFLINE, ONLINE, STARTING, STOPPING, START_FAILED, and STOP_FAILED. OFFLINE indicates that the server exists, but that it is not available for file operations. ONLINE indicates that the server is available to perform file operations. STARTING indicates that the server's was instantiated, but the server is not yet available to - perform file operations. Under normal conditions, it can take a couple of minutes for the server to be completely operational. Both START_FAILED and STOP_FAILED are error conditions. - structured_log_destinations: - type: array - description: The structured log destinations of the server - tags: - type: array - description: The tags of the server - user_count: - type: integer - description: The user count of the server - workflow_details: - type: object - description: Container for the WorkflowDetail data type. It is used by actions that trigger a workflow to begin execution. - region: - $ref: '#/components/schemas/region' - x-example-where-clause: WHERE region = '' AND data__ServerId = '' - server_tags: - description: Details of a Transfer family server tags - type: object - additionalProperties: false - properties: - data__ServerId: - type: string - description: The server id - region: - $ref: '#/components/schemas/region' - key: - type: string - description: The key of the tag - value: - type: string - description: The value of the tag - x-example-where-clause: WHERE region = '' AND data__ServerId = '' - user: - description: Details for a Transfer family user in a server + pattern: TransferSFTPConnectorSecurityPolicy-[A-Za-z0-9-]+ + maxLength: 50 + required: + - AccessRole + - Url + x-stackql-resource-name: connector + description: Resource Type definition for AWS::Transfer::Connector + x-type-name: AWS::Transfer::Connector + x-stackql-primary-identifier: + - ConnectorId + x-read-only-properties: + - Arn + - ConnectorId + - ServiceManagedEgressIpAddresses + x-required-properties: + - AccessRole + - Url + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + x-required-permissions: + create: + - transfer:CreateConnector + - transfer:TagResource + - iam:PassRole + read: + - transfer:DescribeConnector + update: + - transfer:UpdateConnector + - transfer:UnTagResource + - transfer:TagResource + - iam:PassRole + delete: + - transfer:DeleteConnector + list: + - transfer:ListConnectors + CertificateId: + description: A unique identifier for the certificate. + type: string + pattern: ^cert-([0-9a-f]{17})$ + minLength: 22 + maxLength: 22 + Profile: type: object - additionalProperties: false properties: - data__ServerId: - type: string - description: The server id - data__UserName: - type: string - description: The user name - arn: + As2Id: + description: AS2 identifier agreed with a trading partner. type: string - description: Unique Amazon Resource Name (ARN) for the user. - home_directory: + pattern: ^[\u0020-\u007E\s]*$ + minLength: 1 + maxLength: 128 + ProfileType: + description: Enum specifying whether the profile is local or associated with a trading partner. type: string - description: The home directory of the user - home_directory_mappings: + enum: + - LOCAL + - PARTNER + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + maxItems: 50 + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + CertificateIds: + description: List of the certificate IDs associated with this profile to be used for encryption and signing of AS2 messages. type: array - description: >- - Logical directory mappings that specify what Amazon S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the "/" name of the Amazon S3 bucket and the "" value for the Amazon S3 key in the HomeDirectory parameter. The following example will map the "" value "/" to "">. The "" value does not need to be specified if it is the same as the - "". The mapping will be visible to the user in the "" folder of their Amazon S3 storage. This is often referred to as 'logical directory mappings'. In the example, the user will see their Amazon S3 storage as the "" folder in the "" bucket. - home_directory_type: + x-insertionOrder: false + items: + $ref: '#/components/schemas/CertificateId' + Arn: + description: Specifies the unique Amazon Resource Name (ARN) for the profile. type: string - description: The type of home directory to provide for the user. If you set it to PATH, the user will see the immediate contents of their Amazon S3 storage location. If you set it to LOGICAL, you will provide mappings in the HomeDirectoryMappings for what they will see at the root of their Amazon S3 storage location. - policy: + pattern: arn:.* + minLength: 20 + maxLength: 1600 + ProfileId: + description: A unique identifier for the profile type: string - description: The policy of the user - posix_profile: - type: object - description: The full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary group IDs (SecondaryGids), that controls your users' access to your Amazon EFS file systems. The POSIX permissions that are set on files and directories in your file system determine the level of access your users get when transferring files into and out of your Amazon EFS file systems. - role: + pattern: ^p-([0-9a-f]{17})$ + minLength: 19 + maxLength: 19 + required: + - As2Id + - ProfileType + x-stackql-resource-name: profile + description: Resource Type definition for AWS::Transfer::Profile + x-type-name: AWS::Transfer::Profile + x-stackql-primary-identifier: + - ProfileId + x-create-only-properties: + - ProfileType + x-read-only-properties: + - Arn + - ProfileId + x-required-properties: + - As2Id + - ProfileType + x-tagging: + taggable: true + tagOnCreate: true + tagUpdatable: true + cloudFormationSystemTags: true + tagProperty: /properties/Tags + x-required-permissions: + create: + - transfer:CreateProfile + - transfer:TagResource + read: + - transfer:DescribeProfile + update: + - transfer:UpdateProfile + - transfer:UnTagResource + - transfer:TagResource + delete: + - transfer:DeleteProfile + list: + - transfer:ListProfiles + S3Tag: + description: Specifies the key-value pair that are assigned to a file during the execution of a Tagging step. + type: object + properties: + Key: + description: The name assigned to the tag that you create. type: string - description: The role of the server - ssh_public_keys: - type: array - description: The SSH public keys of the server - tags: - type: array - description: The tags of the server - user_name: + minLength: 1 + maxLength: 128 + Value: + description: The value that corresponds to the key. type: string - description: The user name - region: - $ref: '#/components/schemas/region' - x-example-where-clause: WHERE region = '' AND data__ServerId = '' AND data__UserName = '' - users: - description: List of Transfer family users in a server - type: object + minLength: 0 + maxLength: 256 + required: + - Key + - Value additionalProperties: false + EfsInputFileLocation: + description: Specifies the details for an EFS file. + type: object properties: - data__ServerId: - type: string - description: The server id - user_name: + FileSystemId: + description: Specifies the EFS filesystem that contains the file. type: string - description: The user name - arn: + pattern: ^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:(access-point/fsap|file-system/fs)-[0-9a-f]{8,40}|fs(ap)?-[0-9a-f]{8,40})$ + minLength: 0 + maxLength: 128 + Path: + description: The name assigned to the file when it was created in EFS. You use the object path to retrieve the object. type: string - description: Unique Amazon Resource Name (ARN) for the user. - home_directory_type: + pattern: ^[^\x00]+$ + minLength: 1 + maxLength: 65536 + additionalProperties: false + S3InputFileLocation: + description: Specifies the details for a S3 file. + type: object + properties: + Bucket: + description: Specifies the S3 bucket that contains the file. type: string - description: The home directory type for the user - role: + pattern: ^[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]$ + minLength: 3 + maxLength: 63 + Key: + description: The name assigned to the file when it was created in S3. You use the object key to retrieve the object. type: string - description: The role of the server - ssh_public_key_count: - type: integer - description: The SSH public key count of the server - region: - $ref: '#/components/schemas/region' - x-example-where-clause: WHERE region = '' AND data__ServerId = '' - user_public_keys: - description: Details of a Transfer family server tags + pattern: .* + minLength: 0 + maxLength: 1024 + additionalProperties: false + InputFileLocation: + description: Specifies the location for the file being decrypted. Only applicable for the Decrypt type of workflow steps. type: object + properties: + S3FileLocation: + $ref: '#/components/schemas/S3InputFileLocation' + EfsFileLocation: + $ref: '#/components/schemas/EfsInputFileLocation' additionalProperties: false + S3FileLocation: + description: Specifies the location for the file being copied. Only applicable for the Copy type of workflow steps. + type: object properties: - data__ServerId: - type: string - description: The server id - data__UserName: - type: string - description: The user name - region: - $ref: '#/components/schemas/region' - ssh_public_key_body: - type: string - description: The SSH public key body - ssh_public_key_id: - type: string - description: The SSH public key id - date_imported: - type: string - description: The date imported - x-example-where-clause: WHERE region = '' AND data__ServerId = '' AND data__UserName = '' - securitySchemes: - hmac: - type: apiKey - name: Authorization - in: header - description: Amazon Signature authorization v4 - x-amazon-apigateway-authtype: awsSigv4 - x-stackQL-resources: - agreements: - name: agreements - id: aws.transfer.agreements - x-cfn-schema-name: Agreement - x-cfn-type-name: AWS::Transfer::Agreement - x-identifiers: - - AgreementId - - ServerId - x-type: list - methods: - create_resource: - config: - requestBodyTranslate: - algorithm: naive_DesiredState - operation: - $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Agreement&__detailTransformed=true/post' - request: - mediaType: application/x-amz-json-1.0 - base: |- - { - "TypeName": "AWS::Transfer::Agreement" - } - response: - mediaType: application/json - openAPIDocKey: '200' - delete_resource: - operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' - request: - mediaType: application/x-amz-json-1.0 - base: |- - { - "TypeName": "AWS::Transfer::Agreement" - } - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/agreements/methods/create_resource' + S3FileLocation: + $ref: '#/components/schemas/S3InputFileLocation' + additionalProperties: false + WorkflowStep: + description: The basic building block of a workflow. + type: object + properties: + CopyStepDetails: + description: Details for a step that performs a file copy. + type: object + properties: + DestinationFileLocation: + $ref: '#/components/schemas/S3FileLocation' + Name: + description: The name of the step, used as an identifier. + type: string + pattern: ^[\w-]*$ + minLength: 0 + maxLength: 30 + OverwriteExisting: + description: A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE. + type: string + enum: + - 'TRUE' + - 'FALSE' + SourceFileLocation: + description: Specifies which file to use as input to the workflow step. + type: string + pattern: ^\$\{(\w+.)+\w+\}$ + minLength: 0 + maxLength: 256 + additionalProperties: false + CustomStepDetails: + description: Details for a step that invokes a lambda function. + type: object + properties: + Name: + description: The name of the step, used as an identifier. + type: string + pattern: ^[\w-]*$ + minLength: 0 + maxLength: 30 + Target: + description: The ARN for the lambda function that is being called. + type: string + pattern: arn:[a-z-]+:lambda:.*$ + minLength: 0 + maxLength: 170 + TimeoutSeconds: + description: Timeout, in seconds, for the step. + type: integer + minimum: 1 + maximum: 1800 + SourceFileLocation: + description: Specifies which file to use as input to the workflow step. + type: string + pattern: ^\$\{(\w+.)+\w+\}$ + minLength: 0 + maxLength: 256 + additionalProperties: false + DecryptStepDetails: + description: Details for a step that performs a file decryption. + type: object + properties: + DestinationFileLocation: + $ref: '#/components/schemas/InputFileLocation' + Name: + description: The name of the step, used as an identifier. + type: string + pattern: ^[\w-]*$ + minLength: 0 + maxLength: 30 + Type: + description: Specifies which encryption method to use. + type: string + enum: + - PGP + OverwriteExisting: + description: A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE. + type: string + enum: + - 'TRUE' + - 'FALSE' + SourceFileLocation: + description: Specifies which file to use as input to the workflow step. + type: string + pattern: ^\$\{(\w+.)+\w+\}$ + minLength: 0 + maxLength: 256 + required: + - DestinationFileLocation + - Type + additionalProperties: false + DeleteStepDetails: + description: Details for a step that deletes the file. + type: object + properties: + Name: + description: The name of the step, used as an identifier. + type: string + pattern: ^[\w-]*$ + minLength: 0 + maxLength: 30 + SourceFileLocation: + description: Specifies which file to use as input to the workflow step. + type: string + pattern: ^\$\{(\w+.)+\w+\}$ + minLength: 0 + maxLength: 256 + additionalProperties: false + TagStepDetails: + description: Details for a step that creates one or more tags. + type: object + properties: + Name: + description: The name of the step, used as an identifier. + type: string + pattern: ^[\w-]*$ + minLength: 0 + maxLength: 30 + Tags: + description: Array that contains from 1 to 10 key/value pairs. + type: array + maxItems: 10 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/S3Tag' + SourceFileLocation: + description: Specifies which file to use as input to the workflow step. + type: string + pattern: ^\$\{(\w+.)+\w+\}$ + minLength: 0 + maxLength: 256 + additionalProperties: false + Type: + type: string + enum: + - COPY + - CUSTOM + - DECRYPT + - DELETE + - TAG + additionalProperties: false + Workflow: + type: object + properties: + OnExceptionSteps: + description: Specifies the steps (actions) to take if any errors are encountered during execution of the workflow. + type: array + maxItems: 8 + uniqueItems: true + x-insertionOrder: true + items: + $ref: '#/components/schemas/WorkflowStep' + Steps: + description: Specifies the details for the steps that are in the specified workflow. + type: array + maxItems: 8 + uniqueItems: true + x-insertionOrder: true + items: + $ref: '#/components/schemas/WorkflowStep' + Tags: + description: Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose. + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + Description: + description: A textual description for the workflow. + type: string + pattern: ^[\w\- ]*$ + minLength: 0 + maxLength: 256 + WorkflowId: + description: A unique identifier for the workflow. + type: string + pattern: ^w-([a-z0-9]{17})$ + minLength: 19 + maxLength: 19 + Arn: + description: Specifies the unique Amazon Resource Name (ARN) for the workflow. + type: string + pattern: arn:.* + minLength: 20 + maxLength: 1600 + required: + - Steps + x-stackql-resource-name: workflow + description: Resource Type definition for AWS::Transfer::Workflow + x-type-name: AWS::Transfer::Workflow + x-stackql-primary-identifier: + - WorkflowId + x-create-only-properties: + - Steps + - OnExceptionSteps + - Description + x-read-only-properties: + - WorkflowId + - Arn + x-required-properties: + - Steps + x-tagging: + cloudFormationSystemTags: true + tagOnCreate: true + tagProperty: /properties/Tags + tagUpdatable: true + taggable: true + x-required-permissions: + create: + - transfer:CreateWorkflow + - transfer:TagResource + read: + - transfer:DescribeWorkflow delete: - - $ref: '#/components/x-stackQL-resources/agreements/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AgreementId') as agreement_id, - JSON_EXTRACT(Properties, '$.ServerId') as server_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Transfer::Agreement' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AgreementId') as agreement_id, - json_extract_path_text(Properties, 'ServerId') as server_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Transfer::Agreement' - AND region = 'us-east-1' - agreement: - name: agreement - id: aws.transfer.agreement - x-cfn-schema-name: Agreement - x-cfn-type-name: AWS::Transfer::Agreement - x-identifiers: - - AgreementId - - ServerId - x-type: get - methods: - update_resource: - operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' - request: - mediaType: application/x-amz-json-1.0 - base: |- - { - "TypeName": "AWS::Transfer::Agreement" - } - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - update: - - $ref: '#/components/x-stackQL-resources/agreement/methods/update_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - data__Identifier, - JSON_EXTRACT(Properties, '$.Description') as description, - JSON_EXTRACT(Properties, '$.ServerId') as server_id, - JSON_EXTRACT(Properties, '$.LocalProfileId') as local_profile_id, - JSON_EXTRACT(Properties, '$.PartnerProfileId') as partner_profile_id, - JSON_EXTRACT(Properties, '$.BaseDirectory') as base_directory, - JSON_EXTRACT(Properties, '$.AccessRole') as access_role, - JSON_EXTRACT(Properties, '$.Status') as status, - JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.AgreementId') as agreement_id, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Transfer::Agreement' - AND data__Identifier = '|' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - data__Identifier, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'ServerId') as server_id, - json_extract_path_text(Properties, 'LocalProfileId') as local_profile_id, - json_extract_path_text(Properties, 'PartnerProfileId') as partner_profile_id, - json_extract_path_text(Properties, 'BaseDirectory') as base_directory, - json_extract_path_text(Properties, 'AccessRole') as access_role, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'AgreementId') as agreement_id, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Transfer::Agreement' - AND data__Identifier = '|' - AND region = 'us-east-1' - certificates: - name: certificates - id: aws.transfer.certificates - x-cfn-schema-name: Certificate - x-cfn-type-name: AWS::Transfer::Certificate - x-identifiers: - - CertificateId - x-type: list - methods: - create_resource: - config: - requestBodyTranslate: - algorithm: naive_DesiredState - operation: - $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Certificate&__detailTransformed=true/post' - request: - mediaType: application/x-amz-json-1.0 - base: |- - { - "TypeName": "AWS::Transfer::Certificate" - } - response: - mediaType: application/json - openAPIDocKey: '200' - delete_resource: - operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' - request: - mediaType: application/x-amz-json-1.0 - base: |- - { - "TypeName": "AWS::Transfer::Certificate" - } - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/certificates/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/certificates/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.CertificateId') as certificate_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Transfer::Certificate' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'CertificateId') as certificate_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Transfer::Certificate' - AND region = 'us-east-1' - certificate: - name: certificate - id: aws.transfer.certificate - x-cfn-schema-name: Certificate - x-cfn-type-name: AWS::Transfer::Certificate - x-identifiers: - - CertificateId - x-type: get - methods: - update_resource: - operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' - request: - mediaType: application/x-amz-json-1.0 - base: |- - { - "TypeName": "AWS::Transfer::Certificate" - } - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - update: - - $ref: '#/components/x-stackQL-resources/certificate/methods/update_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - data__Identifier, - JSON_EXTRACT(Properties, '$.Usage') as usage, - JSON_EXTRACT(Properties, '$.Certificate') as certificate, - JSON_EXTRACT(Properties, '$.CertificateChain') as certificate_chain, - JSON_EXTRACT(Properties, '$.PrivateKey') as private_key, - JSON_EXTRACT(Properties, '$.ActiveDate') as active_date, - JSON_EXTRACT(Properties, '$.InactiveDate') as inactive_date, - JSON_EXTRACT(Properties, '$.Description') as description, - JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.Arn') as arn, - JSON_EXTRACT(Properties, '$.CertificateId') as certificate_id, - JSON_EXTRACT(Properties, '$.Status') as status, - JSON_EXTRACT(Properties, '$.Type') as type, - JSON_EXTRACT(Properties, '$.Serial') as serial, - JSON_EXTRACT(Properties, '$.NotBeforeDate') as not_before_date, - JSON_EXTRACT(Properties, '$.NotAfterDate') as not_after_date - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Transfer::Certificate' - AND data__Identifier = '' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - data__Identifier, - json_extract_path_text(Properties, 'Usage') as usage, - json_extract_path_text(Properties, 'Certificate') as certificate, - json_extract_path_text(Properties, 'CertificateChain') as certificate_chain, - json_extract_path_text(Properties, 'PrivateKey') as private_key, - json_extract_path_text(Properties, 'ActiveDate') as active_date, - json_extract_path_text(Properties, 'InactiveDate') as inactive_date, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'CertificateId') as certificate_id, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'Type') as type, - json_extract_path_text(Properties, 'Serial') as serial, - json_extract_path_text(Properties, 'NotBeforeDate') as not_before_date, - json_extract_path_text(Properties, 'NotAfterDate') as not_after_date - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Transfer::Certificate' - AND data__Identifier = '' - AND region = 'us-east-1' - connectors: - name: connectors - id: aws.transfer.connectors - x-cfn-schema-name: Connector - x-cfn-type-name: AWS::Transfer::Connector - x-identifiers: - - ConnectorId - x-type: list - methods: - create_resource: - config: - requestBodyTranslate: - algorithm: naive_DesiredState - operation: - $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Connector&__detailTransformed=true/post' - request: - mediaType: application/x-amz-json-1.0 - base: |- - { - "TypeName": "AWS::Transfer::Connector" - } - response: - mediaType: application/json - openAPIDocKey: '200' - delete_resource: - operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' - request: - mediaType: application/x-amz-json-1.0 - base: |- - { - "TypeName": "AWS::Transfer::Connector" - } - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/connectors/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/connectors/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ConnectorId') as connector_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Transfer::Connector' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ConnectorId') as connector_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Transfer::Connector' - AND region = 'us-east-1' - connector: - name: connector - id: aws.transfer.connector - x-cfn-schema-name: Connector - x-cfn-type-name: AWS::Transfer::Connector - x-identifiers: - - ConnectorId - x-type: get - methods: - update_resource: - operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' - request: - mediaType: application/x-amz-json-1.0 - base: |- - { - "TypeName": "AWS::Transfer::Connector" - } - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: + - transfer:DeleteWorkflow + list: + - transfer:ListWorkflows update: - - $ref: '#/components/x-stackQL-resources/connector/methods/update_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - data__Identifier, - JSON_EXTRACT(Properties, '$.AccessRole') as access_role, - JSON_EXTRACT(Properties, '$.As2Config') as as2_config, - JSON_EXTRACT(Properties, '$.SftpConfig') as sftp_config, - JSON_EXTRACT(Properties, '$.Arn') as arn, - JSON_EXTRACT(Properties, '$.ConnectorId') as connector_id, - JSON_EXTRACT(Properties, '$.LoggingRole') as logging_role, - JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.Url') as url - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Transfer::Connector' - AND data__Identifier = '' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - data__Identifier, - json_extract_path_text(Properties, 'AccessRole') as access_role, - json_extract_path_text(Properties, 'As2Config') as as2_config, - json_extract_path_text(Properties, 'SftpConfig') as sftp_config, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'ConnectorId') as connector_id, - json_extract_path_text(Properties, 'LoggingRole') as logging_role, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Url') as url - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Transfer::Connector' - AND data__Identifier = '' - AND region = 'us-east-1' - profiles: - name: profiles - id: aws.transfer.profiles - x-cfn-schema-name: Profile - x-cfn-type-name: AWS::Transfer::Profile - x-identifiers: - - ProfileId - x-type: list - methods: - create_resource: - config: - requestBodyTranslate: - algorithm: naive_DesiredState - operation: - $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Profile&__detailTransformed=true/post' - request: + - transfer:UnTagResource + - transfer:TagResource + CreateAgreementRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Description: + description: A textual description for the agreement. + type: string + pattern: ^[\u0021-\u007E]+$ + minLength: 1 + maxLength: 200 + ServerId: + description: A unique identifier for the server. + type: string + pattern: ^s-([0-9a-f]{17})$ + minLength: 19 + maxLength: 19 + LocalProfileId: + description: A unique identifier for the local profile. + type: string + pattern: ^p-([0-9a-f]{17})$ + minLength: 19 + maxLength: 19 + PartnerProfileId: + description: A unique identifier for the partner profile. + type: string + pattern: ^p-([0-9a-f]{17})$ + minLength: 19 + maxLength: 19 + BaseDirectory: + description: Specifies the base directory for the agreement. + type: string + pattern: ^(|/.*)$ + maxLength: 1024 + AccessRole: + description: Specifies the access role for the agreement. + type: string + pattern: arn:.*role/.* + minLength: 20 + maxLength: 2048 + Status: + description: Specifies the status of the agreement. + type: string + enum: + - ACTIVE + - INACTIVE + Tags: + description: Key-value pairs that can be used to group and search for agreements. Tags are metadata attached to agreements for any purpose. + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + AgreementId: + description: A unique identifier for the agreement. + type: string + pattern: ^a-([0-9a-f]{17})$ + minLength: 19 + maxLength: 19 + Arn: + description: Specifies the unique Amazon Resource Name (ARN) for the agreement. + type: string + pattern: arn:.* + minLength: 20 + maxLength: 1600 + x-stackQL-stringOnly: true + x-title: CreateAgreementRequest + type: object + required: [] + CreateCertificateRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + Usage: + description: Specifies the usage type for the certificate. + type: string + enum: + - SIGNING + - ENCRYPTION + - TLS + Certificate: + description: Specifies the certificate body to be imported. + type: string + pattern: ^[\t\n\r\u0020-\u00FF]+$ + minLength: 1 + maxLength: 16384 + CertificateChain: + description: Specifies the certificate chain to be imported. + type: string + pattern: ^[\t\n\r\u0020-\u00FF]+$ + minLength: 1 + maxLength: 2097152 + PrivateKey: + description: Specifies the private key for the certificate. + type: string + pattern: ^[\t\n\r\u0020-\u00FF]+$ + minLength: 1 + maxLength: 16384 + ActiveDate: + description: Specifies the active date for the certificate. + type: string + InactiveDate: + description: Specifies the inactive date for the certificate. + type: string + Description: + description: A textual description for the certificate. + type: string + pattern: ^[\u0021-\u007E]+$ + minLength: 1 + maxLength: 200 + Tags: + description: Key-value pairs that can be used to group and search for certificates. Tags are metadata attached to certificates for any purpose. + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + Arn: + description: Specifies the unique Amazon Resource Name (ARN) for the agreement. + type: string + pattern: arn:.* + minLength: 20 + maxLength: 1600 + CertificateId: + description: A unique identifier for the certificate. + type: string + pattern: ^cert-([0-9a-f]{17})$ + minLength: 22 + maxLength: 22 + Status: + description: A status description for the certificate. + type: string + enum: + - ACTIVE + - PENDING + - INACTIVE + Type: + description: Describing the type of certificate. With or without a private key. + type: string + enum: + - CERTIFICATE + - CERTIFICATE_WITH_PRIVATE_KEY + Serial: + description: Specifies Certificate's serial. + type: string + pattern: ^[0-9a-fA-F{}:?]*$ + minLength: 0 + maxLength: 48 + NotBeforeDate: + description: Specifies the not before date for the certificate. + type: string + NotAfterDate: + description: Specifies the not after date for the certificate. + type: string + x-stackQL-stringOnly: true + x-title: CreateCertificateRequest + type: object + required: [] + CreateConnectorRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + AccessRole: + description: Specifies the access role for the connector. + type: string + pattern: arn:.*role/.* + minLength: 20 + maxLength: 2048 + As2Config: + description: Configuration for an AS2 connector. + type: object + properties: + LocalProfileId: + type: string + description: A unique identifier for the local profile. + pattern: ^p-([0-9a-f]{17})$ + minLength: 19 + maxLength: 19 + PartnerProfileId: + type: string + description: A unique identifier for the partner profile. + pattern: ^p-([0-9a-f]{17})$ + minLength: 19 + maxLength: 19 + MessageSubject: + type: string + description: The message subject for this AS2 connector configuration. + pattern: ^[\u0020-\u007E\t]+$ + minLength: 1 + maxLength: 1024 + Compression: + type: string + description: Compression setting for this AS2 connector configuration. + enum: + - ZLIB + - DISABLED + EncryptionAlgorithm: + type: string + description: Encryption algorithm for this AS2 connector configuration. + enum: + - AES128_CBC + - AES192_CBC + - AES256_CBC + - NONE + - DES_EDE3_CBC + SigningAlgorithm: + type: string + description: Signing algorithm for this AS2 connector configuration. + enum: + - SHA256 + - SHA384 + - SHA512 + - SHA1 + - NONE + MdnSigningAlgorithm: + type: string + description: MDN Signing algorithm for this AS2 connector configuration. + enum: + - SHA256 + - SHA384 + - SHA512 + - SHA1 + - NONE + - DEFAULT + MdnResponse: + type: string + description: MDN Response setting for this AS2 connector configuration. + enum: + - SYNC + - NONE + BasicAuthSecretId: + type: string + description: ARN or name of the secret in AWS Secrets Manager which contains the credentials for Basic authentication. If empty, Basic authentication is disabled for the AS2 connector + minLength: 0 + maxLength: 2048 + additionalProperties: false + SftpConfig: + description: Configuration for an SFTP connector. + type: object + properties: + UserSecretId: + type: string + description: ARN or name of the secret in AWS Secrets Manager which contains the SFTP user's private keys or passwords. + minLength: 1 + maxLength: 2048 + TrustedHostKeys: + description: List of public host keys, for the external server to which you are connecting. + type: array + maxItems: 10 + uniqueItems: false + x-insertionOrder: false + items: + $ref: '#/components/schemas/SftpConnectorTrustedHostKey' + additionalProperties: false + Arn: + description: Specifies the unique Amazon Resource Name (ARN) for the connector. + type: string + pattern: arn:.* + minLength: 20 + maxLength: 1600 + ConnectorId: + description: A unique identifier for the connector. + type: string + pattern: ^c-([0-9a-f]{17})$ + minLength: 19 + maxLength: 19 + LoggingRole: + description: Specifies the logging role for the connector. + type: string + pattern: arn:.*role/.* + minLength: 20 + maxLength: 2048 + ServiceManagedEgressIpAddresses: + description: The list of egress IP addresses of this connector. These IP addresses are assigned automatically when you create the connector. + type: array + items: + type: string + pattern: ^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$ + Tags: + description: Key-value pairs that can be used to group and search for connectors. Tags are metadata attached to connectors for any purpose. + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + Url: + description: URL for Connector + type: string + maxLength: 255 + SecurityPolicyName: + description: Security policy for SFTP Connector + type: string + pattern: TransferSFTPConnectorSecurityPolicy-[A-Za-z0-9-]+ + maxLength: 50 + x-stackQL-stringOnly: true + x-title: CreateConnectorRequest + type: object + required: [] + CreateProfileRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + As2Id: + description: AS2 identifier agreed with a trading partner. + type: string + pattern: ^[\u0020-\u007E\s]*$ + minLength: 1 + maxLength: 128 + ProfileType: + description: Enum specifying whether the profile is local or associated with a trading partner. + type: string + enum: + - LOCAL + - PARTNER + Tags: + description: An array of key-value pairs to apply to this resource. + type: array + uniqueItems: true + maxItems: 50 + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + CertificateIds: + description: List of the certificate IDs associated with this profile to be used for encryption and signing of AS2 messages. + type: array + x-insertionOrder: false + items: + $ref: '#/components/schemas/CertificateId' + Arn: + description: Specifies the unique Amazon Resource Name (ARN) for the profile. + type: string + pattern: arn:.* + minLength: 20 + maxLength: 1600 + ProfileId: + description: A unique identifier for the profile + type: string + pattern: ^p-([0-9a-f]{17})$ + minLength: 19 + maxLength: 19 + x-stackQL-stringOnly: true + x-title: CreateProfileRequest + type: object + required: [] + CreateWorkflowRequest: + properties: + ClientToken: + type: string + RoleArn: + type: string + TypeName: + type: string + TypeVersionId: + type: string + DesiredState: + type: object + properties: + OnExceptionSteps: + description: Specifies the steps (actions) to take if any errors are encountered during execution of the workflow. + type: array + maxItems: 8 + uniqueItems: true + x-insertionOrder: true + items: + $ref: '#/components/schemas/WorkflowStep' + Steps: + description: Specifies the details for the steps that are in the specified workflow. + type: array + maxItems: 8 + uniqueItems: true + x-insertionOrder: true + items: + $ref: '#/components/schemas/WorkflowStep' + Tags: + description: Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose. + type: array + maxItems: 50 + uniqueItems: true + x-insertionOrder: false + items: + $ref: '#/components/schemas/Tag' + Description: + description: A textual description for the workflow. + type: string + pattern: ^[\w\- ]*$ + minLength: 0 + maxLength: 256 + WorkflowId: + description: A unique identifier for the workflow. + type: string + pattern: ^w-([a-z0-9]{17})$ + minLength: 19 + maxLength: 19 + Arn: + description: Specifies the unique Amazon Resource Name (ARN) for the workflow. + type: string + pattern: arn:.* + minLength: 20 + maxLength: 1600 + x-stackQL-stringOnly: true + x-title: CreateWorkflowRequest + type: object + required: [] + securitySchemes: + hmac: + type: apiKey + name: Authorization + in: header + description: Amazon Signature authorization v4 + x-amazon-apigateway-authtype: awsSigv4 + x-stackQL-resources: + agreements: + name: agreements + id: aws.transfer.agreements + x-cfn-schema-name: Agreement + x-cfn-type-name: AWS::Transfer::Agreement + x-identifiers: + - AgreementId + - ServerId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Agreement&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Transfer::Agreement" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Transfer::Agreement" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Transfer::Agreement" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/agreements/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/agreements/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/agreements/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.ServerId') as server_id, + JSON_EXTRACT(Properties, '$.LocalProfileId') as local_profile_id, + JSON_EXTRACT(Properties, '$.PartnerProfileId') as partner_profile_id, + JSON_EXTRACT(Properties, '$.BaseDirectory') as base_directory, + JSON_EXTRACT(Properties, '$.AccessRole') as access_role, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.AgreementId') as agreement_id, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Transfer::Agreement' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.AgreementId') as agreement_id, + JSON_EXTRACT(Properties, '$.ServerId') as server_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Transfer::Agreement' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'ServerId') as server_id, + json_extract_path_text(Properties, 'LocalProfileId') as local_profile_id, + json_extract_path_text(Properties, 'PartnerProfileId') as partner_profile_id, + json_extract_path_text(Properties, 'BaseDirectory') as base_directory, + json_extract_path_text(Properties, 'AccessRole') as access_role, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'AgreementId') as agreement_id, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Transfer::Agreement' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AgreementId') as agreement_id, + json_extract_path_text(Properties, 'ServerId') as server_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Transfer::Agreement' + AND region = 'us-east-1' + certificates: + name: certificates + id: aws.transfer.certificates + x-cfn-schema-name: Certificate + x-cfn-type-name: AWS::Transfer::Certificate + x-identifiers: + - CertificateId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Certificate&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Transfer::Certificate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Transfer::Certificate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Transfer::Certificate" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/certificates/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/certificates/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/certificates/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.Usage') as usage, + JSON_EXTRACT(Properties, '$.Certificate') as certificate, + JSON_EXTRACT(Properties, '$.CertificateChain') as certificate_chain, + JSON_EXTRACT(Properties, '$.PrivateKey') as private_key, + JSON_EXTRACT(Properties, '$.ActiveDate') as active_date, + JSON_EXTRACT(Properties, '$.InactiveDate') as inactive_date, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.CertificateId') as certificate_id, + JSON_EXTRACT(Properties, '$.Status') as status, + JSON_EXTRACT(Properties, '$.Type') as type, + JSON_EXTRACT(Properties, '$.Serial') as serial, + JSON_EXTRACT(Properties, '$.NotBeforeDate') as not_before_date, + JSON_EXTRACT(Properties, '$.NotAfterDate') as not_after_date + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Transfer::Certificate' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.CertificateId') as certificate_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Transfer::Certificate' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Usage') as usage, + json_extract_path_text(Properties, 'Certificate') as certificate, + json_extract_path_text(Properties, 'CertificateChain') as certificate_chain, + json_extract_path_text(Properties, 'PrivateKey') as private_key, + json_extract_path_text(Properties, 'ActiveDate') as active_date, + json_extract_path_text(Properties, 'InactiveDate') as inactive_date, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'CertificateId') as certificate_id, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'Serial') as serial, + json_extract_path_text(Properties, 'NotBeforeDate') as not_before_date, + json_extract_path_text(Properties, 'NotAfterDate') as not_after_date + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Transfer::Certificate' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'CertificateId') as certificate_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Transfer::Certificate' + AND region = 'us-east-1' + connectors: + name: connectors + id: aws.transfer.connectors + x-cfn-schema-name: Connector + x-cfn-type-name: AWS::Transfer::Connector + x-identifiers: + - ConnectorId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Connector&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Transfer::Connector" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Transfer::Connector" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Transfer::Connector" + } + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/connectors/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/connectors/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/connectors/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.AccessRole') as access_role, + JSON_EXTRACT(Properties, '$.As2Config') as as2_config, + JSON_EXTRACT(Properties, '$.SftpConfig') as sftp_config, + JSON_EXTRACT(Properties, '$.Arn') as arn, + JSON_EXTRACT(Properties, '$.ConnectorId') as connector_id, + JSON_EXTRACT(Properties, '$.LoggingRole') as logging_role, + JSON_EXTRACT(Properties, '$.ServiceManagedEgressIpAddresses') as service_managed_egress_ip_addresses, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.Url') as url, + JSON_EXTRACT(Properties, '$.SecurityPolicyName') as security_policy_name + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Transfer::Connector' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.ConnectorId') as connector_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Transfer::Connector' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AccessRole') as access_role, + json_extract_path_text(Properties, 'As2Config') as as2_config, + json_extract_path_text(Properties, 'SftpConfig') as sftp_config, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'ConnectorId') as connector_id, + json_extract_path_text(Properties, 'LoggingRole') as logging_role, + json_extract_path_text(Properties, 'ServiceManagedEgressIpAddresses') as service_managed_egress_ip_addresses, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Url') as url, + json_extract_path_text(Properties, 'SecurityPolicyName') as security_policy_name + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Transfer::Connector' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ConnectorId') as connector_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Transfer::Connector' + AND region = 'us-east-1' + profiles: + name: profiles + id: aws.transfer.profiles + x-cfn-schema-name: Profile + x-cfn-type-name: AWS::Transfer::Profile + x-identifiers: + - ProfileId + x-type: cloud_control + methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Profile&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Transfer::Profile" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: mediaType: application/x-amz-json-1.0 base: |- { @@ -2249,33 +2878,80 @@ components: - $ref: '#/components/x-stackQL-resources/profiles/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/profiles/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/profiles/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, + data__Identifier, + JSON_EXTRACT(Properties, '$.As2Id') as as2_id, + JSON_EXTRACT(Properties, '$.ProfileType') as profile_type, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.CertificateIds') as certificate_ids, + JSON_EXTRACT(Properties, '$.Arn') as arn, JSON_EXTRACT(Properties, '$.ProfileId') as profile_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Transfer::Profile' + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Transfer::Profile' + AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - json_extract_path_text(Properties, 'ProfileId') as profile_id + JSON_EXTRACT(Properties, '$.ProfileId') as profile_id FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Transfer::Profile' AND region = 'us-east-1' - profile: - name: profile - id: aws.transfer.profile - x-cfn-schema-name: Profile - x-cfn-type-name: AWS::Transfer::Profile + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'As2Id') as as2_id, + json_extract_path_text(Properties, 'ProfileType') as profile_type, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'CertificateIds') as certificate_ids, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'ProfileId') as profile_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Transfer::Profile' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ProfileId') as profile_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Transfer::Profile' + AND region = 'us-east-1' + workflows: + name: workflows + id: aws.transfer.workflows + x-cfn-schema-name: Workflow + x-cfn-type-name: AWS::Transfer::Workflow x-identifiers: - - ProfileId - x-type: get + - WorkflowId + x-type: cloud_control methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Workflow&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Transfer::Workflow" + } + response: + mediaType: application/json + openAPIDocKey: '200' update_resource: operation: $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' @@ -2283,339 +2959,1136 @@ components: mediaType: application/x-amz-json-1.0 base: |- { - "TypeName": "AWS::Transfer::Profile" + "TypeName": "AWS::Transfer::Workflow" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::Transfer::Workflow" } response: - mediaType: application/json + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/workflows/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/workflows/methods/delete_resource' + update: + - $ref: '#/components/x-stackQL-resources/workflows/methods/update_resource' + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.OnExceptionSteps') as on_exception_steps, + JSON_EXTRACT(Properties, '$.Steps') as steps, + JSON_EXTRACT(Properties, '$.Tags') as tags, + JSON_EXTRACT(Properties, '$.Description') as description, + JSON_EXTRACT(Properties, '$.WorkflowId') as workflow_id, + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Transfer::Workflow' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + region, + JSON_EXTRACT(Properties, '$.WorkflowId') as workflow_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Transfer::Workflow' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'OnExceptionSteps') as on_exception_steps, + json_extract_path_text(Properties, 'Steps') as steps, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'WorkflowId') as workflow_id, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Transfer::Workflow' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'WorkflowId') as workflow_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Transfer::Workflow' + AND region = 'us-east-1' + servers: + name: servers + x-cfn-schema-name: DescribedServer + x-example-where-clause: WHERE region = 'us-east-1' AND ServerId = '' + x-type: native + methods: + create_server: + serviceName: transfer + operation: + $ref: '#/paths/~1?__X-Amz-Target=TransferService.CreateServer?__nativeEndpoint=true/post' + request: + mediaType: application/x-amz-json-1.1 + default: | + {} + response: + mediaType: application/json + openAPIDocKey: '200' + list_servers: + serviceName: transfer + operation: + $ref: '#/paths/~1?__X-Amz-Target=TransferService.ListServers?__nativeEndpoint=true/post' + request: + mediaType: application/x-amz-json-1.1 + default: | + {} + response: + objectKey: $.Servers + mediaType: application/json + openAPIDocKey: '200' + describe_server: + serviceName: transfer + operation: + $ref: '#/paths/~1?__X-Amz-Target=TransferService.DescribeServer?__nativeEndpoint=true/post' + request: + mediaType: application/x-amz-json-1.1 + response: + objectKey: $.Server + mediaType: application/json + openAPIDocKey: '200' + update_server: + serviceName: transfer + operation: + $ref: '#/paths/~1?__X-Amz-Target=TransferService.UpdateServer?__nativeEndpoint=true/post' + request: + mediaType: application/x-amz-json-1.1 + response: + mediaType: application/json + openAPIDocKey: '200' + delete_server: + serviceName: transfer + operation: + $ref: '#/paths/~1?__X-Amz-Target=TransferService.DeleteServer?__nativeEndpoint=true/post' + request: + mediaType: application/x-amz-json-1.1 + response: + openAPIDocKey: '200' + start_server: + serviceName: transfer + operation: + $ref: '#/paths/~1?__X-Amz-Target=TransferService.StartServer?__nativeEndpoint=true/post' + request: + mediaType: application/x-amz-json-1.1 + response: + openAPIDocKey: '200' + stop_server: + serviceName: transfer + operation: + $ref: '#/paths/~1?__X-Amz-Target=TransferService.StopServer?__nativeEndpoint=true/post' + request: + mediaType: application/x-amz-json-1.1 + response: + openAPIDocKey: '200' + id: aws.transfer.servers + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/servers/methods/delete_server' + insert: + - $ref: '#/components/x-stackQL-resources/servers/methods/create_server' + select: + - $ref: '#/components/x-stackQL-resources/servers/methods/describe_server' + - $ref: '#/components/x-stackQL-resources/servers/methods/list_servers' + update: + - $ref: '#/components/x-stackQL-resources/servers/methods/update_server' + title: servers + users: + name: users + x-cfn-schema-name: DescribedUser + x-example-where-clause: WHERE region = 'us-east-1' AND ServerId = '' AND UserName = '' + x-type: native + methods: + list_users: + serviceName: transfer + operation: + $ref: '#/paths/~1?__X-Amz-Target=TransferService.ListUsers?__nativeEndpoint=true/post' + request: + mediaType: application/x-amz-json-1.1 + response: + objectKey: $.Users + mediaType: application/json + openAPIDocKey: '200' + describe_user: + serviceName: transfer + operation: + $ref: '#/paths/~1?__X-Amz-Target=TransferService.DescribeUser?__nativeEndpoint=true/post' + request: + mediaType: application/x-amz-json-1.1 + response: + objectKey: $.User + mediaType: application/json + openAPIDocKey: '200' + create_user: + serviceName: transfer + operation: + $ref: '#/paths/~1?__X-Amz-Target=TransferService.CreateUser?__nativeEndpoint=true/post' + request: + mediaType: application/x-amz-json-1.1 + response: + mediaType: application/json + openAPIDocKey: '200' + update_user: + serviceName: transfer + operation: + $ref: '#/paths/~1?__X-Amz-Target=TransferService.UpdateUser?__nativeEndpoint=true/post' + request: + mediaType: application/x-amz-json-1.1 + response: + mediaType: application/json + openAPIDocKey: '200' + delete_user: + serviceName: transfer + operation: + $ref: '#/paths/~1?__X-Amz-Target=TransferService.DeleteUser?__nativeEndpoint=true/post' + request: + mediaType: application/x-amz-json-1.1 + response: openAPIDocKey: '200' + id: aws.transfer.users sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/users/methods/delete_user' + insert: + - $ref: '#/components/x-stackQL-resources/users/methods/create_user' + select: + - $ref: '#/components/x-stackQL-resources/users/methods/describe_user' + - $ref: '#/components/x-stackQL-resources/users/methods/list_users' update: - - $ref: '#/components/x-stackQL-resources/profile/methods/update_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - data__Identifier, - JSON_EXTRACT(Properties, '$.As2Id') as as2_id, - JSON_EXTRACT(Properties, '$.ProfileType') as profile_type, - JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.CertificateIds') as certificate_ids, - JSON_EXTRACT(Properties, '$.Arn') as arn, - JSON_EXTRACT(Properties, '$.ProfileId') as profile_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Transfer::Profile' - AND data__Identifier = '' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - data__Identifier, - json_extract_path_text(Properties, 'As2Id') as as2_id, - json_extract_path_text(Properties, 'ProfileType') as profile_type, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'CertificateIds') as certificate_ids, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'ProfileId') as profile_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Transfer::Profile' - AND data__Identifier = '' - AND region = 'us-east-1' - workflows: - name: workflows - id: aws.transfer.workflows - x-cfn-schema-name: Workflow - x-cfn-type-name: AWS::Transfer::Workflow - x-identifiers: - - WorkflowId - x-type: list + - $ref: '#/components/x-stackQL-resources/users/methods/update_user' + title: users + public_keys: + name: public_keys + x-description: Imports or deletes a public key for a user + x-type: native methods: - create_resource: - config: - requestBodyTranslate: - algorithm: naive_DesiredState + import_public_key: + serviceName: transfer operation: - $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__Workflow&__detailTransformed=true/post' + $ref: '#/paths/~1?__X-Amz-Target=TransferService.ImportSshPublicKey?__nativeEndpoint=true/post' request: - mediaType: application/x-amz-json-1.0 - base: |- - { - "TypeName": "AWS::Transfer::Workflow" - } + mediaType: application/x-amz-json-1.1 response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + delete_public_key: + serviceName: transfer operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?__X-Amz-Target=TransferService.DeleteSshPublicKey?__nativeEndpoint=true/post' request: - mediaType: application/x-amz-json-1.0 - base: |- - { - "TypeName": "AWS::Transfer::Workflow" - } + mediaType: application/x-amz-json-1.1 response: - mediaType: application/json openAPIDocKey: '200' + id: aws.transfer.public_keys sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/workflows/methods/create_resource' delete: - - $ref: '#/components/x-stackQL-resources/workflows/methods/delete_resource' + - $ref: '#/components/x-stackQL-resources/public_keys/methods/delete_public_key' + insert: + - $ref: '#/components/x-stackQL-resources/public_keys/methods/import_public_key' + select: [] + update: [] + title: public_keys + server_tags: + name: server_tags + id: aws.transfer.server_tags + x-cfn-schema-name: server_tags + x-type: view config: views: select: predicate: sqlDialect == "sqlite3" ddl: |- SELECT + data__ServerId, region, - JSON_EXTRACT(Properties, '$.WorkflowId') as workflow_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Transfer::Workflow' - AND region = 'us-east-1' + JSON_EXTRACT(json_each.value, '$.Key') as key, + JSON_EXTRACT(json_each.value, '$.Value') as value + FROM aws.transfer.servers, json_each(Tags) + WHERE region = 'us-east-1' + AND data__ServerId = 's-ab1234567890123cd' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT - region, - json_extract_path_text(Properties, 'WorkflowId') as workflow_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Transfer::Workflow' - AND region = 'us-east-1' - workflow: - name: workflow - id: aws.transfer.workflow - x-cfn-schema-name: Workflow - x-cfn-type-name: AWS::Transfer::Workflow - x-identifiers: - - WorkflowId - x-type: get - methods: - update_resource: - operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' - request: - mediaType: application/x-amz-json-1.0 - base: |- - { - "TypeName": "AWS::Transfer::Workflow" - } - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - update: - - $ref: '#/components/x-stackQL-resources/workflow/methods/update_resource' + data__ServerId, + region, + json_array_elements_text(Tags)::jsonb ->> 'Key' as key, + json_array_elements_text(Tags)::jsonb ->> 'Value' as value + FROM + aws.transfer.servers + WHERE + region = 'us-east-1' + AND data__ServerId = 's-ab1234567890123cd' + user_public_keys: + name: user_public_keys + id: aws.transfer.user_public_keys + x-cfn-schema-name: user_public_keys + x-type: view config: views: select: predicate: sqlDialect == "sqlite3" ddl: |- SELECT + data__ServerId, + data__UserName, region, - data__Identifier, - JSON_EXTRACT(Properties, '$.OnExceptionSteps') as on_exception_steps, - JSON_EXTRACT(Properties, '$.Steps') as steps, - JSON_EXTRACT(Properties, '$.Tags') as tags, - JSON_EXTRACT(Properties, '$.Description') as description, - JSON_EXTRACT(Properties, '$.WorkflowId') as workflow_id, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Transfer::Workflow' - AND data__Identifier = '' - AND region = 'us-east-1' + JSON_EXTRACT(json_each.value, '$.SshPublicKeyBody') as ssh_public_key_body, + JSON_EXTRACT(json_each.value, '$.SshPublicKeyId') as ssh_public_key_id, + JSON_EXTRACT(json_each.value, '$.DateImported') as date_imported + FROM aws.transfer.users, json_each(SshPublicKeys) + WHERE region = 'us-east-1' + AND data__ServerId = 's-ab1234567890123cd' + AND data__UserName = 'my_user_name' fallback: predicate: sqlDialect == "postgres" ddl: |- SELECT - region, - data__Identifier, - json_extract_path_text(Properties, 'OnExceptionSteps') as on_exception_steps, - json_extract_path_text(Properties, 'Steps') as steps, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'WorkflowId') as workflow_id, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Transfer::Workflow' - AND data__Identifier = '' - AND region = 'us-east-1' + data__ServerId, + data__UserName, + region, + json_array_elements_text(SshPublicKeys)::jsonb ->> 'SshPublicKeyBody' as ssh_public_key_body, + json_array_elements_text(SshPublicKeys)::jsonb ->> 'SshPublicKeyId' as ssh_public_key_id, + json_array_elements_text(SshPublicKeys)::jsonb ->> 'DateImported' as date_imported + FROM + aws.transfer.users + WHERE + region = 'us-east-1' + AND data__ServerId = 's-ab1234567890123cd' + AND data__UserName = 'my_user_name' +paths: + /?Action=CreateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=DeleteResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: DeleteResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.DeleteResource + enum: + - CloudApiService.DeleteResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' + description: Success + /?Action=UpdateResource&Version=2021-09-30: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: UpdateResource + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.UpdateResource + enum: + - CloudApiService.UpdateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + properties: + ClientName: + type: string + Identifier: + $ref: '#/components/x-cloud-control-schemas/Identifier' + PatchDocument: + type: string + RoleArn: + $ref: '#/components/x-cloud-control-schemas/RoleArn' + TypeName: + $ref: '#/components/x-cloud-control-schemas/TypeName' + TypeVersionId: + $ref: '#/components/x-cloud-control-schemas/TypeVersionId' + required: + - Identifier + - PatchDocument + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Agreement&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateAgreement + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateAgreementRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Certificate&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateCertificate + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateCertificateRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Connector&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateConnector + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateConnectorRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Profile&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateProfile + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateProfileRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?Action=CreateResource&Version=2021-09-30&__Workflow&__detailTransformed=true: + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + post: + operationId: CreateWorkflow + parameters: + - description: Action Header + in: header + name: X-Amz-Target + required: false + schema: + default: CloudApiService.CreateResource + enum: + - CloudApiService.CreateResource + type: string + - in: header + name: Content-Type + required: false + schema: + default: application/x-amz-json-1.0 + enum: + - application/x-amz-json-1.0 + type: string + requestBody: + content: + application/x-amz-json-1.0: + schema: + $ref: '#/components/schemas/CreateWorkflowRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/x-cloud-control-schemas/ProgressEvent' + description: Success + /?__X-Amz-Target=TransferService.CreateServer?__nativeEndpoint=true: + post: + operationId: CreateServer + description: Instantiates an auto-scaling virtual server based on the selected file transfer protocol in Amazon Web Services. When you make updates to your file transfer protocol-enabled server or when you work with users, use the service-generated ServerId property that is assigned to the newly created server. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/CreateServerResponse' + '480': + description: AccessDeniedException + content: + application/json: + schema: + $ref: '#/components/schemas/AccessDeniedException' + '481': + description: ServiceUnavailableException + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceUnavailableException' + '482': + description: InternalServiceError + content: + application/json: + schema: + $ref: '#/components/schemas/InternalServiceError' + '483': + description: InvalidRequestException + content: + application/json: + schema: + $ref: '#/components/schemas/InvalidRequestException' + '484': + description: ResourceExistsException + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceExistsException' + '485': + description: ResourceNotFoundException + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceNotFoundException' + '486': + description: ThrottlingException + content: + application/json: + schema: + $ref: '#/components/schemas/ThrottlingException' + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + $ref: '#/components/schemas/CreateServerRequest' + parameters: + - name: X-Amz-Target + in: header + schema: + type: string + default: TransferService.CreateServer + enum: + - TransferService.CreateServer servers: - name: servers - id: aws.transfer.servers - x-cfn-schema-name: servers - x-type: custom_list - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - Arn as arn, - Domain as domain, - EndpointType as endpoint_type, - IdentityProviderType as identity_provider_type, - LoggingRole as logging_role, - ServerId as server_id, - State as state, - UserCount as user_count, - region - FROM aws.transfer_api.servers - WHERE region = 'us-east-1' - server: - name: server - id: aws.transfer.server - x-cfn-schema-name: server - x-type: custom_list - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - data__ServerId, - Arn as arn, - Certificate as certificate, - Domain as domain, - EndpointDetails as endpoint_details, - EndpointType as endpoint_type, - HostKeyFingerprint as host_key_fingerprint, - IdentityProviderDetails as identity_provider_details, - IdentityProviderType as identity_provider_type, - LoggingRole as logging_role, - PostAuthenticationLoginBanner as post_authentication_login_banner, - PreAuthenticationLoginBanner as pre_authentication_login_banner, - ProtocolDetails as protocol_details, - Protocols as protocols, - S3StorageOptions as s3_storage_options, - SecurityPolicyName as security_policy_name, - ServerId as server_id, - State as state, - StructuredLogDestinations as structured_log_destinations, - Tags as tags, - UserCount as user_count, - WorkflowDetails as workflow_details, - region - FROM aws.transfer_api.servers - WHERE region = 'us-east-1' - AND data__ServerId = 's-ab1234567890123cd' - server_tags: - name: server_tags - id: aws.transfer.server_tags - x-cfn-schema-name: server_tags - x-type: custom_list - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - data__ServerId, - region, - JSON_EXTRACT(json_each.value, '$.Key') as key, - JSON_EXTRACT(json_each.value, '$.Value') as value - FROM aws.transfer_api.servers, json_each(Tags) - WHERE region = 'us-east-1' - AND data__ServerId = 's-ab1234567890123cd' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - data__ServerId, - region, - json_array_elements_text(Tags)::jsonb ->> 'Key' as key, - json_array_elements_text(Tags)::jsonb ->> 'Value' as value - FROM - aws.transfer_api.servers - WHERE - region = 'us-east-1' - AND data__ServerId = 's-ab1234567890123cd' - user: - name: user - id: aws.transfer.user - x-cfn-schema-name: user - x-type: custom_list - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - data__ServerId, - data__UserName, - Arn as arn, - HomeDirectory as home_directory, - HomeDirectoryMappings as home_directory_mappings, - HomeDirectoryType as home_directory_type, - Policy as policy, - PosixProfile as posix_profile, - Role as role, - SshPublicKeys as ssh_public_keys, - Tags as tags, - UserName as user_name, - region - FROM aws.transfer_api.users - WHERE region = 'us-east-1' - AND data__ServerId = 's-ab1234567890123cd' - AND data__UserName = 'my_user_name' - users: - name: users - id: aws.transfer.users - x-cfn-schema-name: users - x-type: custom_list - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - data__ServerId, - UserName as user_name, - Arn as arn, - HomeDirectoryType as home_directory_type, - Role as role, - SshPublicKeyCount as ssh_public_key_count, - region - FROM aws.transfer_api.users - WHERE region = 'us-east-1' - AND data__ServerId = 's-ab1234567890123cd' - user_public_keys: - name: user_public_keys - id: aws.transfer.user_public_keys - x-cfn-schema-name: user_public_keys - x-type: custom_list - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - data__ServerId, - data__UserName, - region, - JSON_EXTRACT(json_each.value, '$.SshPublicKeyBody') as ssh_public_key_body, - JSON_EXTRACT(json_each.value, '$.SshPublicKeyId') as ssh_public_key_id, - JSON_EXTRACT(json_each.value, '$.DateImported') as date_imported - FROM aws.transfer_api.users, json_each(SshPublicKeys) - WHERE region = 'us-east-1' - AND data__ServerId = 's-ab1234567890123cd' - AND data__UserName = 'my_user_name' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - data__ServerId, - data__UserName, - region, - json_array_elements_text(SshPublicKeys)::jsonb ->> 'SshPublicKeyBody' as ssh_public_key_body, - json_array_elements_text(SshPublicKeys)::jsonb ->> 'SshPublicKeyId' as ssh_public_key_id, - json_array_elements_text(SshPublicKeys)::jsonb ->> 'DateImported' as date_imported - FROM - aws.transfer_api.users - WHERE - region = 'us-east-1' - AND data__ServerId = 's-ab1234567890123cd' - AND data__UserName = 'my_user_name' -paths: - /?Action=CreateResource&Version=2021-09-30: + - url: https://transfer.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The AWS Transfer multi-region endpoint + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + /?__X-Amz-Target=TransferService.CreateUser?__nativeEndpoint=true: + post: + operationId: CreateUser + description: >- + Creates a user and associates them with an existing file transfer protocol-enabled server. You can only create and associate users with servers that have the IdentityProviderType set to SERVICE_MANAGED. Using parameters for CreateUser, you can specify the user name, set the home directory, store the user's public key, and assign the user's Identity and Access Management (IAM) role. You can also optionally add a session policy, and assign metadata + with tags that can be used to group and search for users. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/CreateUserResponse' + '480': + description: ServiceUnavailableException + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceUnavailableException' + '481': + description: InternalServiceError + content: + application/json: + schema: + $ref: '#/components/schemas/InternalServiceError' + '482': + description: InvalidRequestException + content: + application/json: + schema: + $ref: '#/components/schemas/InvalidRequestException' + '483': + description: ResourceExistsException + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceExistsException' + '484': + description: ResourceNotFoundException + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceNotFoundException' + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + $ref: '#/components/schemas/CreateUserRequest' + parameters: + - name: X-Amz-Target + in: header + schema: + type: string + default: TransferService.CreateUser + enum: + - TransferService.CreateUser + servers: + - url: https://transfer.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The AWS Transfer multi-region endpoint + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + /?__X-Amz-Target=TransferService.DeleteServer?__nativeEndpoint=true: + post: + operationId: DeleteServer + description:

Deletes the file transfer protocol-enabled server that you specify.

No response returns from this operation.

+ responses: + '200': + description: Success + '480': + description: AccessDeniedException + content: + application/json: + schema: + $ref: '#/components/schemas/AccessDeniedException' + '481': + description: ServiceUnavailableException + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceUnavailableException' + '482': + description: InternalServiceError + content: + application/json: + schema: + $ref: '#/components/schemas/InternalServiceError' + '483': + description: InvalidRequestException + content: + application/json: + schema: + $ref: '#/components/schemas/InvalidRequestException' + '484': + description: ResourceNotFoundException + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceNotFoundException' + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + $ref: '#/components/schemas/DeleteServerRequest' + parameters: + - name: X-Amz-Target + in: header + schema: + type: string + default: TransferService.DeleteServer + enum: + - TransferService.DeleteServer + servers: + - url: https://transfer.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The AWS Transfer multi-region endpoint + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + /?__X-Amz-Target=TransferService.DeleteSshPublicKey?__nativeEndpoint=true: + post: + operationId: DeleteSshPublicKey + description: Deletes a user's Secure Shell (SSH) public key. + responses: + '200': + description: Success + '480': + description: ServiceUnavailableException + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceUnavailableException' + '481': + description: InternalServiceError + content: + application/json: + schema: + $ref: '#/components/schemas/InternalServiceError' + '482': + description: InvalidRequestException + content: + application/json: + schema: + $ref: '#/components/schemas/InvalidRequestException' + '483': + description: ResourceNotFoundException + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceNotFoundException' + '484': + description: ThrottlingException + content: + application/json: + schema: + $ref: '#/components/schemas/ThrottlingException' + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + $ref: '#/components/schemas/DeleteSshPublicKeyRequest' + parameters: + - name: X-Amz-Target + in: header + schema: + type: string + default: TransferService.DeleteSshPublicKey + enum: + - TransferService.DeleteSshPublicKey + servers: + - url: https://transfer.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The AWS Transfer multi-region endpoint + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + /?__X-Amz-Target=TransferService.DeleteUser?__nativeEndpoint=true: + post: + operationId: DeleteUser + description:

Deletes the user belonging to a file transfer protocol-enabled server you specify.

No response returns from this operation.

When you delete a user from a server, the user's information is lost.

 + responses: + '200': + description: Success + '480': + description: ServiceUnavailableException + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceUnavailableException' + '481': + description: InternalServiceError + content: + application/json: + schema: + $ref: '#/components/schemas/InternalServiceError' + '482': + description: InvalidRequestException + content: + application/json: + schema: + $ref: '#/components/schemas/InvalidRequestException' + '483': + description: ResourceNotFoundException + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceNotFoundException' + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + $ref: '#/components/schemas/DeleteUserRequest' + parameters: + - name: X-Amz-Target + in: header + schema: + type: string + default: TransferService.DeleteUser + enum: + - TransferService.DeleteUser + servers: + - url: https://transfer.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The AWS Transfer multi-region endpoint parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' @@ -2624,40 +4097,86 @@ paths: - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' + /?__X-Amz-Target=TransferService.DescribeServer?__nativeEndpoint=true: post: - operationId: CreateResource - parameters: - - description: Action Header - in: header - name: X-Amz-Target - required: false - schema: - default: CloudApiService.CreateResource - enum: - - CloudApiService.CreateResource - type: string - - in: header - name: Content-Type - required: false - schema: - default: application/x-amz-json-1.0 - enum: - - application/x-amz-json-1.0 - type: string - requestBody: - content: - application/x-amz-json-1.0: - schema: - $ref: '#/components/x-cloud-control-schemas/CreateResourceInput' - required: true + operationId: DescribeServer + description:

Describes a file transfer protocol-enabled server that you specify by passing the ServerId parameter.

The response contains a description of a server's properties. When you set EndpointType to VPC, the response will contain the EndpointDetails.

responses: '200': + description: Success content: application/json: schema: - $ref: '#/components/x-cloud-control-schemas/ProgressEvent' - description: Success - /?Action=DeleteResource&Version=2021-09-30: + $ref: '#/components/schemas/DescribeServerResponse' + '480': + description: ServiceUnavailableException + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceUnavailableException' + '481': + description: InternalServiceError + content: + application/json: + schema: + $ref: '#/components/schemas/InternalServiceError' + '482': + description: InvalidRequestException + content: + application/json: + schema: + $ref: '#/components/schemas/InvalidRequestException' + '483': + description: ResourceNotFoundException + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceNotFoundException' + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + $ref: '#/components/schemas/DescribeServerRequest' + parameters: + - name: X-Amz-Target + in: header + schema: + type: string + default: TransferService.DescribeServer + enum: + - TransferService.DescribeServer + servers: + - url: https://transfer.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The AWS Transfer multi-region endpoint parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' @@ -2666,40 +4185,186 @@ paths: - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' + /?__X-Amz-Target=TransferService.DescribeUser?__nativeEndpoint=true: post: - operationId: DeleteResource + operationId: DescribeUser + description:

Describes the user assigned to the specific file transfer protocol-enabled server, as identified by its ServerId property.

The response from this call returns the properties of the user associated with the ServerId value that was specified.

+ responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/DescribeUserResponse' + '480': + description: ServiceUnavailableException + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceUnavailableException' + '481': + description: InternalServiceError + content: + application/json: + schema: + $ref: '#/components/schemas/InternalServiceError' + '482': + description: InvalidRequestException + content: + application/json: + schema: + $ref: '#/components/schemas/InvalidRequestException' + '483': + description: ResourceNotFoundException + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceNotFoundException' + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + $ref: '#/components/schemas/DescribeUserRequest' parameters: - - description: Action Header + - name: X-Amz-Target in: header - name: X-Amz-Target - required: false schema: - default: CloudApiService.DeleteResource - enum: - - CloudApiService.DeleteResource type: string - - in: header - name: Content-Type - required: false - schema: - default: application/x-amz-json-1.0 + default: TransferService.DescribeUser enum: - - application/x-amz-json-1.0 - type: string - requestBody: - content: - application/x-amz-json-1.0: - schema: - $ref: '#/components/x-cloud-control-schemas/DeleteResourceInput' - required: true + - TransferService.DescribeUser + servers: + - url: https://transfer.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The AWS Transfer multi-region endpoint + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + /?__X-Amz-Target=TransferService.ImportSshPublicKey?__nativeEndpoint=true: + post: + operationId: ImportSshPublicKey + description:

Adds a Secure Shell (SSH) public key to a Transfer Family user identified by a UserName value assigned to the specific file transfer protocol-enabled server, identified by ServerId.

The response returns the UserName value, the ServerId value, and the name of the SshPublicKeyId.

responses: '200': + description: Success content: application/json: schema: - $ref: '#/components/x-cloud-control-schemas/DeleteResourceOutput' - description: Success - /?Action=UpdateResource&Version=2021-09-30: + $ref: '#/components/schemas/ImportSshPublicKeyResponse' + '480': + description: ServiceUnavailableException + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceUnavailableException' + '481': + description: InternalServiceError + content: + application/json: + schema: + $ref: '#/components/schemas/InternalServiceError' + '482': + description: InvalidRequestException + content: + application/json: + schema: + $ref: '#/components/schemas/InvalidRequestException' + '483': + description: ResourceExistsException + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceExistsException' + '484': + description: ResourceNotFoundException + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceNotFoundException' + '485': + description: ThrottlingException + content: + application/json: + schema: + $ref: '#/components/schemas/ThrottlingException' + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + $ref: '#/components/schemas/ImportSshPublicKeyRequest' + parameters: + - name: X-Amz-Target + in: header + schema: + type: string + default: TransferService.ImportSshPublicKey + enum: + - TransferService.ImportSshPublicKey + servers: + - url: https://transfer.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The AWS Transfer multi-region endpoint parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' @@ -2708,56 +4373,207 @@ paths: - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' + /?__X-Amz-Target=TransferService.ListServers?__nativeEndpoint=true: post: - operationId: UpdateResource + operationId: ListServers + description: | + Lists the file transfer protocol-enabled + servers that are associated with your + Amazon Web Services account. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ListServersResponse' + '480': + description: ServiceUnavailableException + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceUnavailableException' + '481': + description: InternalServiceError + content: + application/json: + schema: + $ref: '#/components/schemas/InternalServiceError' + '482': + description: InvalidNextTokenException + content: + application/json: + schema: + $ref: '#/components/schemas/InvalidNextTokenException' + '483': + description: InvalidRequestException + content: + application/json: + schema: + $ref: '#/components/schemas/InvalidRequestException' + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + $ref: '#/components/schemas/ListServersRequest' parameters: - - description: Action Header - in: header - name: X-Amz-Target + - name: MaxResults + in: query + schema: + type: string + description: Pagination limit required: false + - name: NextToken + in: query schema: - default: CloudApiService.UpdateResource - enum: - - CloudApiService.UpdateResource type: string - - in: header - name: Content-Type + description: Pagination token required: false + - name: X-Amz-Target + in: header schema: - default: application/x-amz-json-1.0 - enum: - - application/x-amz-json-1.0 type: string - requestBody: - content: - application/x-amz-json-1.0: - schema: - properties: - ClientName: - type: string - Identifier: - $ref: '#/components/x-cloud-control-schemas/Identifier' - PatchDocument: - type: string - RoleArn: - $ref: '#/components/x-cloud-control-schemas/RoleArn' - TypeName: - $ref: '#/components/x-cloud-control-schemas/TypeName' - TypeVersionId: - $ref: '#/components/x-cloud-control-schemas/TypeVersionId' - required: - - Identifier - - PatchDocument - type: object - required: true + default: TransferService.ListServers + enum: + - TransferService.ListServers + servers: + - url: https://transfer.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The AWS Transfer multi-region endpoint + parameters: + - $ref: '#/components/parameters/X-Amz-Content-Sha256' + - $ref: '#/components/parameters/X-Amz-Date' + - $ref: '#/components/parameters/X-Amz-Algorithm' + - $ref: '#/components/parameters/X-Amz-Credential' + - $ref: '#/components/parameters/X-Amz-Security-Token' + - $ref: '#/components/parameters/X-Amz-Signature' + - $ref: '#/components/parameters/X-Amz-SignedHeaders' + /?__X-Amz-Target=TransferService.ListUsers?__nativeEndpoint=true: + post: + operationId: ListUsers + description: Lists the users for a file transfer protocol-enabled server that you specify by passing the ServerId parameter. responses: '200': + description: Success content: application/json: schema: - $ref: '#/components/x-cloud-control-schemas/UpdateResourceOutput' - description: Success - /?Action=CreateResource&Version=2021-09-30&__Agreement&__detailTransformed=true: + $ref: '#/components/schemas/ListUsersResponse' + '480': + description: ServiceUnavailableException + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceUnavailableException' + '481': + description: InternalServiceError + content: + application/json: + schema: + $ref: '#/components/schemas/InternalServiceError' + '482': + description: InvalidNextTokenException + content: + application/json: + schema: + $ref: '#/components/schemas/InvalidNextTokenException' + '483': + description: InvalidRequestException + content: + application/json: + schema: + $ref: '#/components/schemas/InvalidRequestException' + '484': + description: ResourceNotFoundException + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceNotFoundException' + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + $ref: '#/components/schemas/ListUsersRequest' + parameters: + - name: MaxResults + in: query + schema: + type: string + description: Pagination limit + required: false + - name: NextToken + in: query + schema: + type: string + description: Pagination token + required: false + - name: X-Amz-Target + in: header + schema: + type: string + default: TransferService.ListUsers + enum: + - TransferService.ListUsers + servers: + - url: https://transfer.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The AWS Transfer multi-region endpoint parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' @@ -2766,40 +4582,90 @@ paths: - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' + /?__X-Amz-Target=TransferService.StartServer?__nativeEndpoint=true: post: - operationId: CreateAgreement - parameters: - - description: Action Header - in: header - name: X-Amz-Target - required: false - schema: - default: CloudApiService.CreateResource - enum: - - CloudApiService.CreateResource - type: string - - in: header - name: Content-Type - required: false - schema: - default: application/x-amz-json-1.0 - enum: - - application/x-amz-json-1.0 - type: string - requestBody: - content: - application/x-amz-json-1.0: - schema: - $ref: '#/components/schemas/CreateAgreementRequest' - required: true + operationId: StartServer + description: >- +

Changes the state of a file transfer protocol-enabled server from OFFLINE to ONLINE. It has no impact on a server that is already ONLINE. An ONLINE server can accept and process file transfer jobs.

The state of STARTING indicates that the server is in an intermediate state, either not fully able to respond, or not fully online. The values of START_FAILED can indicate an error condition.

No + response is returned from this call.

responses: '200': + description: Success + '480': + description: ServiceUnavailableException content: application/json: schema: - $ref: '#/components/x-cloud-control-schemas/ProgressEvent' - description: Success - /?Action=CreateResource&Version=2021-09-30&__Certificate&__detailTransformed=true: + $ref: '#/components/schemas/ServiceUnavailableException' + '481': + description: InternalServiceError + content: + application/json: + schema: + $ref: '#/components/schemas/InternalServiceError' + '482': + description: InvalidRequestException + content: + application/json: + schema: + $ref: '#/components/schemas/InvalidRequestException' + '483': + description: ResourceNotFoundException + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceNotFoundException' + '484': + description: ThrottlingException + content: + application/json: + schema: + $ref: '#/components/schemas/ThrottlingException' + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + $ref: '#/components/schemas/StartServerRequest' + parameters: + - name: X-Amz-Target + in: header + schema: + type: string + default: TransferService.StartServer + enum: + - TransferService.StartServer + servers: + - url: https://transfer.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The AWS Transfer multi-region endpoint parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' @@ -2808,40 +4674,90 @@ paths: - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' + /?__X-Amz-Target=TransferService.StopServer?__nativeEndpoint=true: post: - operationId: CreateCertificate - parameters: - - description: Action Header - in: header - name: X-Amz-Target - required: false - schema: - default: CloudApiService.CreateResource - enum: - - CloudApiService.CreateResource - type: string - - in: header - name: Content-Type - required: false - schema: - default: application/x-amz-json-1.0 - enum: - - application/x-amz-json-1.0 - type: string - requestBody: - content: - application/x-amz-json-1.0: - schema: - $ref: '#/components/schemas/CreateCertificateRequest' - required: true + operationId: StopServer + description: >- +

Changes the state of a file transfer protocol-enabled server from ONLINE to OFFLINE. An OFFLINE server cannot accept and process file transfer jobs. Information tied to your server, such as server and user properties, are not affected by stopping your server.

Stopping the server does not reduce or impact your file transfer protocol endpoint billing; you must delete the server to stop being billed.

The state of + STOPPING indicates that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of STOP_FAILED can indicate an error condition.

No response is returned from this call.

responses: '200': + description: Success + '480': + description: ServiceUnavailableException content: application/json: schema: - $ref: '#/components/x-cloud-control-schemas/ProgressEvent' - description: Success - /?Action=CreateResource&Version=2021-09-30&__Connector&__detailTransformed=true: + $ref: '#/components/schemas/ServiceUnavailableException' + '481': + description: InternalServiceError + content: + application/json: + schema: + $ref: '#/components/schemas/InternalServiceError' + '482': + description: InvalidRequestException + content: + application/json: + schema: + $ref: '#/components/schemas/InvalidRequestException' + '483': + description: ResourceNotFoundException + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceNotFoundException' + '484': + description: ThrottlingException + content: + application/json: + schema: + $ref: '#/components/schemas/ThrottlingException' + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + $ref: '#/components/schemas/StopServerRequest' + parameters: + - name: X-Amz-Target + in: header + schema: + type: string + default: TransferService.StopServer + enum: + - TransferService.StopServer + servers: + - url: https://transfer.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The AWS Transfer multi-region endpoint parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' @@ -2850,40 +4766,110 @@ paths: - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' + /?__X-Amz-Target=TransferService.UpdateServer?__nativeEndpoint=true: post: - operationId: CreateConnector - parameters: - - description: Action Header - in: header - name: X-Amz-Target - required: false - schema: - default: CloudApiService.CreateResource - enum: - - CloudApiService.CreateResource - type: string - - in: header - name: Content-Type - required: false - schema: - default: application/x-amz-json-1.0 - enum: - - application/x-amz-json-1.0 - type: string - requestBody: - content: - application/x-amz-json-1.0: - schema: - $ref: '#/components/schemas/CreateConnectorRequest' - required: true + operationId: UpdateServer + description:

Updates the file transfer protocol-enabled server's properties after that server has been created.

The UpdateServer call returns the ServerId of the server you updated.

responses: '200': + description: Success content: application/json: schema: - $ref: '#/components/x-cloud-control-schemas/ProgressEvent' - description: Success - /?Action=CreateResource&Version=2021-09-30&__Profile&__detailTransformed=true: + $ref: '#/components/schemas/UpdateServerResponse' + '480': + description: AccessDeniedException + content: + application/json: + schema: + $ref: '#/components/schemas/AccessDeniedException' + '481': + description: ServiceUnavailableException + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceUnavailableException' + '482': + description: ConflictException + content: + application/json: + schema: + $ref: '#/components/schemas/ConflictException' + '483': + description: InternalServiceError + content: + application/json: + schema: + $ref: '#/components/schemas/InternalServiceError' + '484': + description: InvalidRequestException + content: + application/json: + schema: + $ref: '#/components/schemas/InvalidRequestException' + '485': + description: ResourceExistsException + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceExistsException' + '486': + description: ResourceNotFoundException + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceNotFoundException' + '487': + description: ThrottlingException + content: + application/json: + schema: + $ref: '#/components/schemas/ThrottlingException' + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + $ref: '#/components/schemas/UpdateServerRequest' + parameters: + - name: X-Amz-Target + in: header + schema: + type: string + default: TransferService.UpdateServer + enum: + - TransferService.UpdateServer + servers: + - url: https://transfer.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The AWS Transfer multi-region endpoint parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' @@ -2892,40 +4878,92 @@ paths: - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' + /?__X-Amz-Target=TransferService.UpdateUser?__nativeEndpoint=true: post: - operationId: CreateProfile - parameters: - - description: Action Header - in: header - name: X-Amz-Target - required: false - schema: - default: CloudApiService.CreateResource - enum: - - CloudApiService.CreateResource - type: string - - in: header - name: Content-Type - required: false - schema: - default: application/x-amz-json-1.0 - enum: - - application/x-amz-json-1.0 - type: string - requestBody: - content: - application/x-amz-json-1.0: - schema: - $ref: '#/components/schemas/CreateProfileRequest' - required: true + operationId: UpdateUser + description: '

Assigns new properties to a user. Parameters you pass modify any or all of the following: the home directory, role, and policy for the UserName and ServerId you specify.

The response returns the ServerId and the UserName for the updated user.

' responses: '200': + description: Success content: application/json: schema: - $ref: '#/components/x-cloud-control-schemas/ProgressEvent' - description: Success - /?Action=CreateResource&Version=2021-09-30&__Workflow&__detailTransformed=true: + $ref: '#/components/schemas/UpdateUserResponse' + '480': + description: ServiceUnavailableException + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceUnavailableException' + '481': + description: InternalServiceError + content: + application/json: + schema: + $ref: '#/components/schemas/InternalServiceError' + '482': + description: InvalidRequestException + content: + application/json: + schema: + $ref: '#/components/schemas/InvalidRequestException' + '483': + description: ResourceNotFoundException + content: + application/json: + schema: + $ref: '#/components/schemas/ResourceNotFoundException' + '484': + description: ThrottlingException + content: + application/json: + schema: + $ref: '#/components/schemas/ThrottlingException' + requestBody: + required: true + content: + application/x-amz-json-1.1: + schema: + $ref: '#/components/schemas/UpdateUserRequest' + parameters: + - name: X-Amz-Target + in: header + schema: + type: string + default: TransferService.UpdateUser + enum: + - TransferService.UpdateUser + servers: + - url: https://transfer.{region}.amazonaws.com + variables: + region: + description: The AWS region + enum: + - us-east-1 + - us-east-2 + - us-west-1 + - us-west-2 + - us-gov-west-1 + - us-gov-east-1 + - ca-central-1 + - eu-north-1 + - eu-west-1 + - eu-west-2 + - eu-west-3 + - eu-central-1 + - eu-south-1 + - af-south-1 + - ap-northeast-1 + - ap-northeast-2 + - ap-northeast-3 + - ap-southeast-1 + - ap-southeast-2 + - ap-east-1 + - ap-south-1 + - sa-east-1 + - me-south-1 + default: us-east-1 + description: The AWS Transfer multi-region endpoint parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' @@ -2934,39 +4972,6 @@ paths: - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - operationId: CreateWorkflow - parameters: - - description: Action Header - in: header - name: X-Amz-Target - required: false - schema: - default: CloudApiService.CreateResource - enum: - - CloudApiService.CreateResource - type: string - - in: header - name: Content-Type - required: false - schema: - default: application/x-amz-json-1.0 - enum: - - application/x-amz-json-1.0 - type: string - requestBody: - content: - application/x-amz-json-1.0: - schema: - $ref: '#/components/schemas/CreateWorkflowRequest' - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/x-cloud-control-schemas/ProgressEvent' - description: Success x-stackQL-config: requestTranslate: algorithm: drop_double_underscore_params @@ -2977,3 +4982,5 @@ x-stackQL-config: responseToken: key: NextToken location: body + queryParamTranspose: + algorithm: AWSCanonical diff --git a/providers/src/aws/v00.00.00000/services/transfer_api.yaml b/providers/src/aws/v00.00.00000/services/transfer_api.yaml deleted file mode 100644 index 1aa6ee06..00000000 --- a/providers/src/aws/v00.00.00000/services/transfer_api.yaml +++ /dev/null @@ -1,6592 +0,0 @@ -x-stackQL-config: - requestTranslate: - algorithm: drop_double_underscore_params -openapi: 3.0.0 -info: - version: '2018-11-05' - x-release: v4 - title: AWS Transfer Family - description: 'Transfer Family is a fully managed service that enables the transfer of files over the File Transfer Protocol (FTP), File Transfer Protocol over SSL (FTPS), or Secure Shell (SSH) File Transfer Protocol (SFTP) directly into and out of Amazon Simple Storage Service (Amazon S3) or Amazon EFS. Additionally, you can use Applicability Statement 2 (AS2) to transfer files into and out of Amazon S3. Amazon Web Services helps you seamlessly migrate your file transfer workflows to Transfer Family by integrating with existing authentication systems, and providing DNS routing with Amazon Route 53 so nothing changes for your customers and partners, or their applications. With your data in Amazon S3, you can use it with Amazon Web Services for processing, analytics, machine learning, and archiving. Getting started with Transfer Family is easy since there is no infrastructure to buy and set up.' - x-logo: - url: 'https://twitter.com/awscloud/profile_image?size=original' - backgroundColor: '#FFFFFF' - termsOfService: 'https://aws.amazon.com/service-terms/' - contact: - name: Mike Ralphson - email: mike.ralphson@gmail.com - url: 'https://github.com/mermade/aws2openapi' - x-twitter: PermittedSoc - license: - name: Apache 2.0 License - url: 'http://www.apache.org/licenses/' - x-providerName: amazonaws.com - x-serviceName: transfer - x-aws-signingName: transfer - x-origin: - - contentType: application/json - url: 'https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/transfer-2018-11-05.normal.json' - converter: - url: 'https://github.com/mermade/aws2openapi' - version: 1.0.0 - x-apisguru-driver: external - x-apiClientRegistration: - url: 'https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct' - x-apisguru-categories: - - cloud - x-preferred: true -externalDocs: - description: Amazon Web Services documentation - url: 'https://docs.aws.amazon.com/transfer/' -servers: - - url: 'https://transfer.{region}.amazonaws.com' - variables: - region: - description: The AWS region - enum: - - us-east-1 - - us-east-2 - - us-west-1 - - us-west-2 - - us-gov-west-1 - - us-gov-east-1 - - ca-central-1 - - eu-north-1 - - eu-west-1 - - eu-west-2 - - eu-west-3 - - eu-central-1 - - eu-south-1 - - af-south-1 - - ap-northeast-1 - - ap-northeast-2 - - ap-northeast-3 - - ap-southeast-1 - - ap-southeast-2 - - ap-east-1 - - ap-south-1 - - sa-east-1 - - me-south-1 - default: us-east-1 - description: The AWS Transfer multi-region endpoint -x-hasEquivalentPaths: true -paths: - /?__X-Amz-Target=TransferService.CreateAccess: - post: - operationId: CreateAccess - description: 'Used by administrators to choose which groups in the directory should have access to upload and download files over the enabled protocols using Transfer Family. For example, a Microsoft Active Directory might contain 50,000 users, but only a small fraction might need the ability to transfer files to the server. An administrator can use CreateAccess to limit the access to the correct set of users who need this ability.' - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/CreateAccessResponse' - '480': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - '481': - description: InternalServiceError - content: - application/json: - schema: - $ref: '#/components/schemas/InternalServiceError' - '482': - description: InvalidRequestException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidRequestException' - '483': - description: ResourceExistsException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceExistsException' - '484': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - requestBody: - required: true - content: - application/x-amz-json-1.1: - schema: - $ref: '#/components/schemas/CreateAccessRequest' - parameters: - - name: X-Amz-Target - in: header - schema: - type: string - default: TransferService.CreateAccess - enum: - - TransferService.CreateAccess - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /?__X-Amz-Target=TransferService.CreateAgreement: - post: - operationId: CreateAgreement - description: '

Creates an agreement. An agreement is a bilateral trading partner agreement, or partnership, between an Transfer Family server and an AS2 process. The agreement defines the file and message transfer relationship between the server and the AS2 process. To define an agreement, Transfer Family combines a server, local profile, partner profile, certificate, and other attributes.

The partner is identified with the PartnerProfileId, and the AS2 process is identified with the LocalProfileId.

' - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/CreateAgreementResponse' - '480': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - '481': - description: InternalServiceError - content: - application/json: - schema: - $ref: '#/components/schemas/InternalServiceError' - '482': - description: InvalidRequestException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidRequestException' - '483': - description: ResourceExistsException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceExistsException' - '484': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - '485': - description: ThrottlingException - content: - application/json: - schema: - $ref: '#/components/schemas/ThrottlingException' - requestBody: - required: true - content: - application/x-amz-json-1.1: - schema: - $ref: '#/components/schemas/CreateAgreementRequest' - parameters: - - name: X-Amz-Target - in: header - schema: - type: string - default: TransferService.CreateAgreement - enum: - - TransferService.CreateAgreement - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /?__X-Amz-Target=TransferService.CreateConnector: - post: - operationId: CreateConnector - description: '

Creates the connector, which captures the parameters for an outbound connection for the AS2 or SFTP protocol. The connector is required for sending files to an externally hosted AS2 or SFTP server. For more details about AS2 connectors, see Create AS2 connectors.

You must specify exactly one configuration object: either for AS2 (As2Config) or SFTP (SftpConfig).

' - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/CreateConnectorResponse' - '480': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - '481': - description: InternalServiceError - content: - application/json: - schema: - $ref: '#/components/schemas/InternalServiceError' - '482': - description: InvalidRequestException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidRequestException' - '483': - description: ResourceExistsException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceExistsException' - '484': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - '485': - description: ThrottlingException - content: - application/json: - schema: - $ref: '#/components/schemas/ThrottlingException' - requestBody: - required: true - content: - application/x-amz-json-1.1: - schema: - $ref: '#/components/schemas/CreateConnectorRequest' - parameters: - - name: X-Amz-Target - in: header - schema: - type: string - default: TransferService.CreateConnector - enum: - - TransferService.CreateConnector - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /?__X-Amz-Target=TransferService.CreateProfile: - post: - operationId: CreateProfile - description: Creates the local or partner profile to use for AS2 transfers. - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/CreateProfileResponse' - '480': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - '481': - description: InternalServiceError - content: - application/json: - schema: - $ref: '#/components/schemas/InternalServiceError' - '482': - description: InvalidRequestException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidRequestException' - '483': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - '484': - description: ThrottlingException - content: - application/json: - schema: - $ref: '#/components/schemas/ThrottlingException' - requestBody: - required: true - content: - application/x-amz-json-1.1: - schema: - $ref: '#/components/schemas/CreateProfileRequest' - parameters: - - name: X-Amz-Target - in: header - schema: - type: string - default: TransferService.CreateProfile - enum: - - TransferService.CreateProfile - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /?__X-Amz-Target=TransferService.CreateServer: - post: - operationId: CreateServer - description: 'Instantiates an auto-scaling virtual server based on the selected file transfer protocol in Amazon Web Services. When you make updates to your file transfer protocol-enabled server or when you work with users, use the service-generated ServerId property that is assigned to the newly created server.' - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/CreateServerResponse' - '480': - description: AccessDeniedException - content: - application/json: - schema: - $ref: '#/components/schemas/AccessDeniedException' - '481': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - '482': - description: InternalServiceError - content: - application/json: - schema: - $ref: '#/components/schemas/InternalServiceError' - '483': - description: InvalidRequestException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidRequestException' - '484': - description: ResourceExistsException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceExistsException' - '485': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - '486': - description: ThrottlingException - content: - application/json: - schema: - $ref: '#/components/schemas/ThrottlingException' - requestBody: - required: true - content: - application/x-amz-json-1.1: - schema: - $ref: '#/components/schemas/CreateServerRequest' - parameters: - - name: X-Amz-Target - in: header - schema: - type: string - default: TransferService.CreateServer - enum: - - TransferService.CreateServer - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /?__X-Amz-Target=TransferService.CreateUser: - post: - operationId: CreateUser - description: 'Creates a user and associates them with an existing file transfer protocol-enabled server. You can only create and associate users with servers that have the IdentityProviderType set to SERVICE_MANAGED. Using parameters for CreateUser, you can specify the user name, set the home directory, store the user''s public key, and assign the user''s Identity and Access Management (IAM) role. You can also optionally add a session policy, and assign metadata with tags that can be used to group and search for users.' - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/CreateUserResponse' - '480': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - '481': - description: InternalServiceError - content: - application/json: - schema: - $ref: '#/components/schemas/InternalServiceError' - '482': - description: InvalidRequestException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidRequestException' - '483': - description: ResourceExistsException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceExistsException' - '484': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - requestBody: - required: true - content: - application/x-amz-json-1.1: - schema: - $ref: '#/components/schemas/CreateUserRequest' - parameters: - - name: X-Amz-Target - in: header - schema: - type: string - default: TransferService.CreateUser - enum: - - TransferService.CreateUser - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /?__X-Amz-Target=TransferService.CreateWorkflow: - post: - operationId: CreateWorkflow - description: ' Allows you to create a workflow with specified steps and step details the workflow invokes after file transfer completes. After creating a workflow, you can associate the workflow created with any transfer servers by specifying the workflow-details field in CreateServer and UpdateServer operations. ' - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/CreateWorkflowResponse' - '480': - description: AccessDeniedException - content: - application/json: - schema: - $ref: '#/components/schemas/AccessDeniedException' - '481': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - '482': - description: InternalServiceError - content: - application/json: - schema: - $ref: '#/components/schemas/InternalServiceError' - '483': - description: InvalidRequestException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidRequestException' - '484': - description: ResourceExistsException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceExistsException' - '485': - description: ThrottlingException - content: - application/json: - schema: - $ref: '#/components/schemas/ThrottlingException' - requestBody: - required: true - content: - application/x-amz-json-1.1: - schema: - $ref: '#/components/schemas/CreateWorkflowRequest' - parameters: - - name: X-Amz-Target - in: header - schema: - type: string - default: TransferService.CreateWorkflow - enum: - - TransferService.CreateWorkflow - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /?__X-Amz-Target=TransferService.DeleteAccess: - post: - operationId: DeleteAccess - description: Allows you to delete the access specified in the ServerID and ExternalID parameters. - responses: - '200': - description: Success - '480': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - '481': - description: InternalServiceError - content: - application/json: - schema: - $ref: '#/components/schemas/InternalServiceError' - '482': - description: InvalidRequestException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidRequestException' - '483': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - requestBody: - required: true - content: - application/x-amz-json-1.1: - schema: - $ref: '#/components/schemas/DeleteAccessRequest' - parameters: - - name: X-Amz-Target - in: header - schema: - type: string - default: TransferService.DeleteAccess - enum: - - TransferService.DeleteAccess - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /?__X-Amz-Target=TransferService.DeleteAgreement: - post: - operationId: DeleteAgreement - description: Delete the agreement that's specified in the provided AgreementId. - responses: - '200': - description: Success - '480': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - '481': - description: InternalServiceError - content: - application/json: - schema: - $ref: '#/components/schemas/InternalServiceError' - '482': - description: InvalidRequestException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidRequestException' - '483': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - requestBody: - required: true - content: - application/x-amz-json-1.1: - schema: - $ref: '#/components/schemas/DeleteAgreementRequest' - parameters: - - name: X-Amz-Target - in: header - schema: - type: string - default: TransferService.DeleteAgreement - enum: - - TransferService.DeleteAgreement - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /?__X-Amz-Target=TransferService.DeleteCertificate: - post: - operationId: DeleteCertificate - description: Deletes the certificate that's specified in the CertificateId parameter. - responses: - '200': - description: Success - '480': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - '481': - description: InternalServiceError - content: - application/json: - schema: - $ref: '#/components/schemas/InternalServiceError' - '482': - description: InvalidRequestException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidRequestException' - '483': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - requestBody: - required: true - content: - application/x-amz-json-1.1: - schema: - $ref: '#/components/schemas/DeleteCertificateRequest' - parameters: - - name: X-Amz-Target - in: header - schema: - type: string - default: TransferService.DeleteCertificate - enum: - - TransferService.DeleteCertificate - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /?__X-Amz-Target=TransferService.DeleteConnector: - post: - operationId: DeleteConnector - description: Deletes the connector that's specified in the provided ConnectorId. - responses: - '200': - description: Success - '480': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - '481': - description: InternalServiceError - content: - application/json: - schema: - $ref: '#/components/schemas/InternalServiceError' - '482': - description: InvalidRequestException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidRequestException' - '483': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - requestBody: - required: true - content: - application/x-amz-json-1.1: - schema: - $ref: '#/components/schemas/DeleteConnectorRequest' - parameters: - - name: X-Amz-Target - in: header - schema: - type: string - default: TransferService.DeleteConnector - enum: - - TransferService.DeleteConnector - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /?__X-Amz-Target=TransferService.DeleteHostKey: - post: - operationId: DeleteHostKey - description: Deletes the host key that's specified in the HostKeyId parameter. - responses: - '200': - description: Success - '480': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - '481': - description: InternalServiceError - content: - application/json: - schema: - $ref: '#/components/schemas/InternalServiceError' - '482': - description: InvalidRequestException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidRequestException' - '483': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - '484': - description: ThrottlingException - content: - application/json: - schema: - $ref: '#/components/schemas/ThrottlingException' - requestBody: - required: true - content: - application/x-amz-json-1.1: - schema: - $ref: '#/components/schemas/DeleteHostKeyRequest' - parameters: - - name: X-Amz-Target - in: header - schema: - type: string - default: TransferService.DeleteHostKey - enum: - - TransferService.DeleteHostKey - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /?__X-Amz-Target=TransferService.DeleteProfile: - post: - operationId: DeleteProfile - description: Deletes the profile that's specified in the ProfileId parameter. - responses: - '200': - description: Success - '480': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - '481': - description: InternalServiceError - content: - application/json: - schema: - $ref: '#/components/schemas/InternalServiceError' - '482': - description: InvalidRequestException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidRequestException' - '483': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - requestBody: - required: true - content: - application/x-amz-json-1.1: - schema: - $ref: '#/components/schemas/DeleteProfileRequest' - parameters: - - name: X-Amz-Target - in: header - schema: - type: string - default: TransferService.DeleteProfile - enum: - - TransferService.DeleteProfile - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /?__X-Amz-Target=TransferService.DeleteServer: - post: - operationId: DeleteServer - description:

Deletes the file transfer protocol-enabled server that you specify.

No response returns from this operation.

- responses: - '200': - description: Success - '480': - description: AccessDeniedException - content: - application/json: - schema: - $ref: '#/components/schemas/AccessDeniedException' - '481': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - '482': - description: InternalServiceError - content: - application/json: - schema: - $ref: '#/components/schemas/InternalServiceError' - '483': - description: InvalidRequestException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidRequestException' - '484': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - requestBody: - required: true - content: - application/x-amz-json-1.1: - schema: - $ref: '#/components/schemas/DeleteServerRequest' - parameters: - - name: X-Amz-Target - in: header - schema: - type: string - default: TransferService.DeleteServer - enum: - - TransferService.DeleteServer - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /?__X-Amz-Target=TransferService.DeleteSshPublicKey: - post: - operationId: DeleteSshPublicKey - description: Deletes a user's Secure Shell (SSH) public key. - responses: - '200': - description: Success - '480': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - '481': - description: InternalServiceError - content: - application/json: - schema: - $ref: '#/components/schemas/InternalServiceError' - '482': - description: InvalidRequestException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidRequestException' - '483': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - '484': - description: ThrottlingException - content: - application/json: - schema: - $ref: '#/components/schemas/ThrottlingException' - requestBody: - required: true - content: - application/x-amz-json-1.1: - schema: - $ref: '#/components/schemas/DeleteSshPublicKeyRequest' - parameters: - - name: X-Amz-Target - in: header - schema: - type: string - default: TransferService.DeleteSshPublicKey - enum: - - TransferService.DeleteSshPublicKey - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /?__X-Amz-Target=TransferService.DeleteUser: - post: - operationId: DeleteUser - description: '

Deletes the user belonging to a file transfer protocol-enabled server you specify.

No response returns from this operation.

When you delete a user from a server, the user''s information is lost.

' - responses: - '200': - description: Success - '480': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - '481': - description: InternalServiceError - content: - application/json: - schema: - $ref: '#/components/schemas/InternalServiceError' - '482': - description: InvalidRequestException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidRequestException' - '483': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - requestBody: - required: true - content: - application/x-amz-json-1.1: - schema: - $ref: '#/components/schemas/DeleteUserRequest' - parameters: - - name: X-Amz-Target - in: header - schema: - type: string - default: TransferService.DeleteUser - enum: - - TransferService.DeleteUser - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /?__X-Amz-Target=TransferService.DeleteWorkflow: - post: - operationId: DeleteWorkflow - description: Deletes the specified workflow. - responses: - '200': - description: Success - '480': - description: AccessDeniedException - content: - application/json: - schema: - $ref: '#/components/schemas/AccessDeniedException' - '481': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - '482': - description: InternalServiceError - content: - application/json: - schema: - $ref: '#/components/schemas/InternalServiceError' - '483': - description: InvalidRequestException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidRequestException' - '484': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - requestBody: - required: true - content: - application/x-amz-json-1.1: - schema: - $ref: '#/components/schemas/DeleteWorkflowRequest' - parameters: - - name: X-Amz-Target - in: header - schema: - type: string - default: TransferService.DeleteWorkflow - enum: - - TransferService.DeleteWorkflow - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /?__X-Amz-Target=TransferService.DescribeAccess: - post: - operationId: DescribeAccess - description: '

Describes the access that is assigned to the specific file transfer protocol-enabled server, as identified by its ServerId property and its ExternalId.

The response from this call returns the properties of the access that is associated with the ServerId value that was specified.

' - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/DescribeAccessResponse' - '480': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - '481': - description: InternalServiceError - content: - application/json: - schema: - $ref: '#/components/schemas/InternalServiceError' - '482': - description: InvalidRequestException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidRequestException' - '483': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - requestBody: - required: true - content: - application/x-amz-json-1.1: - schema: - $ref: '#/components/schemas/DescribeAccessRequest' - parameters: - - name: X-Amz-Target - in: header - schema: - type: string - default: TransferService.DescribeAccess - enum: - - TransferService.DescribeAccess - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /?__X-Amz-Target=TransferService.DescribeAgreement: - post: - operationId: DescribeAgreement - description: Describes the agreement that's identified by the AgreementId. - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/DescribeAgreementResponse' - '480': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - '481': - description: InternalServiceError - content: - application/json: - schema: - $ref: '#/components/schemas/InternalServiceError' - '482': - description: InvalidRequestException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidRequestException' - '483': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - requestBody: - required: true - content: - application/x-amz-json-1.1: - schema: - $ref: '#/components/schemas/DescribeAgreementRequest' - parameters: - - name: X-Amz-Target - in: header - schema: - type: string - default: TransferService.DescribeAgreement - enum: - - TransferService.DescribeAgreement - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /?__X-Amz-Target=TransferService.DescribeCertificate: - post: - operationId: DescribeCertificate - description: Describes the certificate that's identified by the CertificateId. - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/DescribeCertificateResponse' - '480': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - '481': - description: InternalServiceError - content: - application/json: - schema: - $ref: '#/components/schemas/InternalServiceError' - '482': - description: InvalidRequestException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidRequestException' - '483': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - requestBody: - required: true - content: - application/x-amz-json-1.1: - schema: - $ref: '#/components/schemas/DescribeCertificateRequest' - parameters: - - name: X-Amz-Target - in: header - schema: - type: string - default: TransferService.DescribeCertificate - enum: - - TransferService.DescribeCertificate - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /?__X-Amz-Target=TransferService.DescribeConnector: - post: - operationId: DescribeConnector - description: 'Describes the connector that''s identified by the ConnectorId. ' - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/DescribeConnectorResponse' - '480': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - '481': - description: InternalServiceError - content: - application/json: - schema: - $ref: '#/components/schemas/InternalServiceError' - '482': - description: InvalidRequestException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidRequestException' - '483': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - requestBody: - required: true - content: - application/x-amz-json-1.1: - schema: - $ref: '#/components/schemas/DescribeConnectorRequest' - parameters: - - name: X-Amz-Target - in: header - schema: - type: string - default: TransferService.DescribeConnector - enum: - - TransferService.DescribeConnector - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /?__X-Amz-Target=TransferService.DescribeExecution: - post: - operationId: DescribeExecution - description: '

You can use DescribeExecution to check the details of the execution of the specified workflow.

This API call only returns details for in-progress workflows.

If you provide an ID for an execution that is not in progress, or if the execution doesn''t match the specified workflow ID, you receive a ResourceNotFound exception.

' - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/DescribeExecutionResponse' - '480': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - '481': - description: InternalServiceError - content: - application/json: - schema: - $ref: '#/components/schemas/InternalServiceError' - '482': - description: InvalidRequestException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidRequestException' - '483': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - requestBody: - required: true - content: - application/x-amz-json-1.1: - schema: - $ref: '#/components/schemas/DescribeExecutionRequest' - parameters: - - name: X-Amz-Target - in: header - schema: - type: string - default: TransferService.DescribeExecution - enum: - - TransferService.DescribeExecution - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /?__X-Amz-Target=TransferService.DescribeHostKey: - post: - operationId: DescribeHostKey - description: Returns the details of the host key that's specified by the HostKeyId and ServerId. - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/DescribeHostKeyResponse' - '480': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - '481': - description: InternalServiceError - content: - application/json: - schema: - $ref: '#/components/schemas/InternalServiceError' - '482': - description: InvalidRequestException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidRequestException' - '483': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - requestBody: - required: true - content: - application/x-amz-json-1.1: - schema: - $ref: '#/components/schemas/DescribeHostKeyRequest' - parameters: - - name: X-Amz-Target - in: header - schema: - type: string - default: TransferService.DescribeHostKey - enum: - - TransferService.DescribeHostKey - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /?__X-Amz-Target=TransferService.DescribeProfile: - post: - operationId: DescribeProfile - description: Returns the details of the profile that's specified by the ProfileId. - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/DescribeProfileResponse' - '480': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - '481': - description: InternalServiceError - content: - application/json: - schema: - $ref: '#/components/schemas/InternalServiceError' - '482': - description: InvalidRequestException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidRequestException' - '483': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - requestBody: - required: true - content: - application/x-amz-json-1.1: - schema: - $ref: '#/components/schemas/DescribeProfileRequest' - parameters: - - name: X-Amz-Target - in: header - schema: - type: string - default: TransferService.DescribeProfile - enum: - - TransferService.DescribeProfile - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /?__X-Amz-Target=TransferService.DescribeSecurityPolicy: - post: - operationId: DescribeSecurityPolicy - description: 'Describes the security policy that is attached to your file transfer protocol-enabled server. The response contains a description of the security policy''s properties. For more information about security policies, see Working with security policies.' - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/DescribeSecurityPolicyResponse' - '480': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - '481': - description: InternalServiceError - content: - application/json: - schema: - $ref: '#/components/schemas/InternalServiceError' - '482': - description: InvalidRequestException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidRequestException' - '483': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - requestBody: - required: true - content: - application/x-amz-json-1.1: - schema: - $ref: '#/components/schemas/DescribeSecurityPolicyRequest' - parameters: - - name: X-Amz-Target - in: header - schema: - type: string - default: TransferService.DescribeSecurityPolicy - enum: - - TransferService.DescribeSecurityPolicy - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /?__X-Amz-Target=TransferService.DescribeServer: - post: - operationId: DescribeServer - description: '

Describes a file transfer protocol-enabled server that you specify by passing the ServerId parameter.

The response contains a description of a server''s properties. When you set EndpointType to VPC, the response will contain the EndpointDetails.

' - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/DescribeServerResponse' - '480': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - '481': - description: InternalServiceError - content: - application/json: - schema: - $ref: '#/components/schemas/InternalServiceError' - '482': - description: InvalidRequestException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidRequestException' - '483': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - requestBody: - required: true - content: - application/x-amz-json-1.1: - schema: - $ref: '#/components/schemas/DescribeServerRequest' - parameters: - - name: X-Amz-Target - in: header - schema: - type: string - default: TransferService.DescribeServer - enum: - - TransferService.DescribeServer - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /?__X-Amz-Target=TransferService.DescribeUser: - post: - operationId: DescribeUser - description: '

Describes the user assigned to the specific file transfer protocol-enabled server, as identified by its ServerId property.

The response from this call returns the properties of the user associated with the ServerId value that was specified.

' - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/DescribeUserResponse' - '480': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - '481': - description: InternalServiceError - content: - application/json: - schema: - $ref: '#/components/schemas/InternalServiceError' - '482': - description: InvalidRequestException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidRequestException' - '483': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - requestBody: - required: true - content: - application/x-amz-json-1.1: - schema: - $ref: '#/components/schemas/DescribeUserRequest' - parameters: - - name: X-Amz-Target - in: header - schema: - type: string - default: TransferService.DescribeUser - enum: - - TransferService.DescribeUser - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /?__X-Amz-Target=TransferService.DescribeWorkflow: - post: - operationId: DescribeWorkflow - description: Describes the specified workflow. - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/DescribeWorkflowResponse' - '480': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - '481': - description: InternalServiceError - content: - application/json: - schema: - $ref: '#/components/schemas/InternalServiceError' - '482': - description: InvalidRequestException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidRequestException' - '483': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - requestBody: - required: true - content: - application/x-amz-json-1.1: - schema: - $ref: '#/components/schemas/DescribeWorkflowRequest' - parameters: - - name: X-Amz-Target - in: header - schema: - type: string - default: TransferService.DescribeWorkflow - enum: - - TransferService.DescribeWorkflow - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /?__X-Amz-Target=TransferService.ImportCertificate: - post: - operationId: ImportCertificate - description: Imports the signing and encryption certificates that you need to create local (AS2) profiles and partner profiles. - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/ImportCertificateResponse' - '480': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - '481': - description: InternalServiceError - content: - application/json: - schema: - $ref: '#/components/schemas/InternalServiceError' - '482': - description: InvalidRequestException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidRequestException' - '483': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - requestBody: - required: true - content: - application/x-amz-json-1.1: - schema: - $ref: '#/components/schemas/ImportCertificateRequest' - parameters: - - name: X-Amz-Target - in: header - schema: - type: string - default: TransferService.ImportCertificate - enum: - - TransferService.ImportCertificate - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /?__X-Amz-Target=TransferService.ImportHostKey: - post: - operationId: ImportHostKey - description: Adds a host key to the server that's specified by the ServerId parameter. - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/ImportHostKeyResponse' - '480': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - '481': - description: InternalServiceError - content: - application/json: - schema: - $ref: '#/components/schemas/InternalServiceError' - '482': - description: InvalidRequestException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidRequestException' - '483': - description: ResourceExistsException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceExistsException' - '484': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - '485': - description: ThrottlingException - content: - application/json: - schema: - $ref: '#/components/schemas/ThrottlingException' - requestBody: - required: true - content: - application/x-amz-json-1.1: - schema: - $ref: '#/components/schemas/ImportHostKeyRequest' - parameters: - - name: X-Amz-Target - in: header - schema: - type: string - default: TransferService.ImportHostKey - enum: - - TransferService.ImportHostKey - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /?__X-Amz-Target=TransferService.ImportSshPublicKey: - post: - operationId: ImportSshPublicKey - description: '

Adds a Secure Shell (SSH) public key to a Transfer Family user identified by a UserName value assigned to the specific file transfer protocol-enabled server, identified by ServerId.

The response returns the UserName value, the ServerId value, and the name of the SshPublicKeyId.

' - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/ImportSshPublicKeyResponse' - '480': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - '481': - description: InternalServiceError - content: - application/json: - schema: - $ref: '#/components/schemas/InternalServiceError' - '482': - description: InvalidRequestException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidRequestException' - '483': - description: ResourceExistsException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceExistsException' - '484': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - '485': - description: ThrottlingException - content: - application/json: - schema: - $ref: '#/components/schemas/ThrottlingException' - requestBody: - required: true - content: - application/x-amz-json-1.1: - schema: - $ref: '#/components/schemas/ImportSshPublicKeyRequest' - parameters: - - name: X-Amz-Target - in: header - schema: - type: string - default: TransferService.ImportSshPublicKey - enum: - - TransferService.ImportSshPublicKey - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /?__X-Amz-Target=TransferService.ListAccesses: - post: - operationId: ListAccesses - description: Lists the details for all the accesses you have on your server. - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/ListAccessesResponse' - '480': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - '481': - description: InternalServiceError - content: - application/json: - schema: - $ref: '#/components/schemas/InternalServiceError' - '482': - description: InvalidNextTokenException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidNextTokenException' - '483': - description: InvalidRequestException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidRequestException' - '484': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - requestBody: - required: true - content: - application/x-amz-json-1.1: - schema: - $ref: '#/components/schemas/ListAccessesRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - - name: X-Amz-Target - in: header - schema: - type: string - default: TransferService.ListAccesses - enum: - - TransferService.ListAccesses - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /?__X-Amz-Target=TransferService.ListAgreements: - post: - operationId: ListAgreements - description: 'Returns a list of the agreements for the server that''s identified by the ServerId that you supply. If you want to limit the results to a certain number, supply a value for the MaxResults parameter. If you ran the command previously and received a value for NextToken, you can supply that value to continue listing agreements from where you left off.' - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/ListAgreementsResponse' - '480': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - '481': - description: InternalServiceError - content: - application/json: - schema: - $ref: '#/components/schemas/InternalServiceError' - '482': - description: InvalidNextTokenException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidNextTokenException' - '483': - description: InvalidRequestException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidRequestException' - '484': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - requestBody: - required: true - content: - application/x-amz-json-1.1: - schema: - $ref: '#/components/schemas/ListAgreementsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - - name: X-Amz-Target - in: header - schema: - type: string - default: TransferService.ListAgreements - enum: - - TransferService.ListAgreements - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /?__X-Amz-Target=TransferService.ListCertificates: - post: - operationId: ListCertificates - description: 'Returns a list of the current certificates that have been imported into Transfer Family. If you want to limit the results to a certain number, supply a value for the MaxResults parameter. If you ran the command previously and received a value for the NextToken parameter, you can supply that value to continue listing certificates from where you left off.' - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/ListCertificatesResponse' - '480': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - '481': - description: InternalServiceError - content: - application/json: - schema: - $ref: '#/components/schemas/InternalServiceError' - '482': - description: InvalidNextTokenException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidNextTokenException' - '483': - description: InvalidRequestException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidRequestException' - '484': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - requestBody: - required: true - content: - application/x-amz-json-1.1: - schema: - $ref: '#/components/schemas/ListCertificatesRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - - name: X-Amz-Target - in: header - schema: - type: string - default: TransferService.ListCertificates - enum: - - TransferService.ListCertificates - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /?__X-Amz-Target=TransferService.ListConnectors: - post: - operationId: ListConnectors - description: Lists the connectors for the specified Region. - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/ListConnectorsResponse' - '480': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - '481': - description: InternalServiceError - content: - application/json: - schema: - $ref: '#/components/schemas/InternalServiceError' - '482': - description: InvalidNextTokenException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidNextTokenException' - '483': - description: InvalidRequestException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidRequestException' - '484': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - requestBody: - required: true - content: - application/x-amz-json-1.1: - schema: - $ref: '#/components/schemas/ListConnectorsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - - name: X-Amz-Target - in: header - schema: - type: string - default: 'TransferService.ListConnectors' - enum: - - TransferService.ListConnectors - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /?__X-Amz-Target=TransferService.ListExecutions: - post: - operationId: ListExecutions - description: '

Lists all in-progress executions for the specified workflow.

If the specified workflow ID cannot be found, ListExecutions returns a ResourceNotFound exception.

' - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/ListExecutionsResponse' - '480': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - '481': - description: InternalServiceError - content: - application/json: - schema: - $ref: '#/components/schemas/InternalServiceError' - '482': - description: InvalidNextTokenException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidNextTokenException' - '483': - description: InvalidRequestException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidRequestException' - '484': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - requestBody: - required: true - content: - application/x-amz-json-1.1: - schema: - $ref: '#/components/schemas/ListExecutionsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - - name: X-Amz-Target - in: header - schema: - type: string - default: TransferService.ListExecutions - enum: - - TransferService.ListExecutions - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /?__X-Amz-Target=TransferService.ListHostKeys: - post: - operationId: ListHostKeys - description: Returns a list of host keys for the server that's specified by the ServerId parameter. - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/ListHostKeysResponse' - '480': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - '481': - description: InternalServiceError - content: - application/json: - schema: - $ref: '#/components/schemas/InternalServiceError' - '482': - description: InvalidNextTokenException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidNextTokenException' - '483': - description: InvalidRequestException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidRequestException' - '484': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - requestBody: - required: true - content: - application/x-amz-json-1.1: - schema: - $ref: '#/components/schemas/ListHostKeysRequest' - parameters: - - name: X-Amz-Target - in: header - schema: - type: string - default: TransferService.ListHostKeys - enum: - - TransferService.ListHostKeys - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /?__X-Amz-Target=TransferService.ListProfiles: - post: - operationId: ListProfiles - description: 'Returns a list of the profiles for your system. If you want to limit the results to a certain number, supply a value for the MaxResults parameter. If you ran the command previously and received a value for NextToken, you can supply that value to continue listing profiles from where you left off.' - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/ListProfilesResponse' - '480': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - '481': - description: InternalServiceError - content: - application/json: - schema: - $ref: '#/components/schemas/InternalServiceError' - '482': - description: InvalidNextTokenException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidNextTokenException' - '483': - description: InvalidRequestException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidRequestException' - '484': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - requestBody: - required: true - content: - application/x-amz-json-1.1: - schema: - $ref: '#/components/schemas/ListProfilesRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - - name: X-Amz-Target - in: header - schema: - type: string - default: TransferService.ListProfiles - enum: - - TransferService.ListProfiles - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /?__X-Amz-Target=TransferService.ListSecurityPolicies: - post: - operationId: ListSecurityPolicies - description: Lists the security policies that are attached to your file transfer protocol-enabled servers. - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/ListSecurityPoliciesResponse' - '480': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - '481': - description: InternalServiceError - content: - application/json: - schema: - $ref: '#/components/schemas/InternalServiceError' - '482': - description: InvalidNextTokenException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidNextTokenException' - '483': - description: InvalidRequestException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidRequestException' - requestBody: - required: true - content: - application/x-amz-json-1.1: - schema: - $ref: '#/components/schemas/ListSecurityPoliciesRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - - name: X-Amz-Target - in: header - schema: - type: string - default: TransferService.ListSecurityPolicies - enum: - - TransferService.ListSecurityPolicies - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /?__X-Amz-Target=TransferService.ListServers: - post: - operationId: ListServers - description: | - Lists the file transfer protocol-enabled - servers that are associated with your - Amazon Web Services account. - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/ListServersResponse' - '480': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - '481': - description: InternalServiceError - content: - application/json: - schema: - $ref: '#/components/schemas/InternalServiceError' - '482': - description: InvalidNextTokenException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidNextTokenException' - '483': - description: InvalidRequestException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidRequestException' - requestBody: - required: true - content: - application/x-amz-json-1.1: - schema: - $ref: '#/components/schemas/ListServersRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - - name: X-Amz-Target - in: header - schema: - type: string - default: TransferService.ListServers - enum: - - TransferService.ListServers - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /?__X-Amz-Target=TransferService.ListTagsForResource: - post: - operationId: ListTagsForResource - description: 'Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a user, server, or role.' - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/ListTagsForResourceResponse' - '480': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - '481': - description: InternalServiceError - content: - application/json: - schema: - $ref: '#/components/schemas/InternalServiceError' - '482': - description: InvalidNextTokenException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidNextTokenException' - '483': - description: InvalidRequestException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidRequestException' - requestBody: - required: true - content: - application/x-amz-json-1.1: - schema: - $ref: '#/components/schemas/ListTagsForResourceRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - - name: X-Amz-Target - in: header - schema: - type: string - default: TransferService.ListTagsForResource - enum: - - TransferService.ListTagsForResource - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /?__X-Amz-Target=TransferService.ListUsers: - post: - operationId: ListUsers - description: Lists the users for a file transfer protocol-enabled server that you specify by passing the ServerId parameter. - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/ListUsersResponse' - '480': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - '481': - description: InternalServiceError - content: - application/json: - schema: - $ref: '#/components/schemas/InternalServiceError' - '482': - description: InvalidNextTokenException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidNextTokenException' - '483': - description: InvalidRequestException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidRequestException' - '484': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - requestBody: - required: true - content: - application/x-amz-json-1.1: - schema: - $ref: '#/components/schemas/ListUsersRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - - name: X-Amz-Target - in: header - schema: - type: string - default: TransferService.ListUsers - enum: - - TransferService.ListUsers - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /?__X-Amz-Target=TransferService.ListWorkflows: - post: - operationId: ListWorkflows - description: Lists all workflows associated with your Amazon Web Services account for your current region. - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/ListWorkflowsResponse' - '480': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - '481': - description: InternalServiceError - content: - application/json: - schema: - $ref: '#/components/schemas/InternalServiceError' - '482': - description: InvalidNextTokenException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidNextTokenException' - '483': - description: InvalidRequestException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidRequestException' - requestBody: - required: true - content: - application/x-amz-json-1.1: - schema: - $ref: '#/components/schemas/ListWorkflowsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - - name: X-Amz-Target - in: header - schema: - type: string - default: TransferService.ListWorkflows - enum: - - TransferService.ListWorkflows - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /?__X-Amz-Target=TransferService.SendWorkflowStepState: - post: - operationId: SendWorkflowStepState - description: '

Sends a callback for asynchronous custom steps.

The ExecutionId, WorkflowId, and Token are passed to the target resource during execution of a custom step of a workflow. You must include those with their callback as well as providing a status.

' - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/SendWorkflowStepStateResponse' - '480': - description: AccessDeniedException - content: - application/json: - schema: - $ref: '#/components/schemas/AccessDeniedException' - '481': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - '482': - description: InternalServiceError - content: - application/json: - schema: - $ref: '#/components/schemas/InternalServiceError' - '483': - description: InvalidRequestException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidRequestException' - '484': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - '485': - description: ThrottlingException - content: - application/json: - schema: - $ref: '#/components/schemas/ThrottlingException' - requestBody: - required: true - content: - application/x-amz-json-1.1: - schema: - $ref: '#/components/schemas/SendWorkflowStepStateRequest' - parameters: - - name: X-Amz-Target - in: header - schema: - type: string - default: TransferService.SendWorkflowStepState - enum: - - TransferService.SendWorkflowStepState - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /?__X-Amz-Target=TransferService.StartFileTransfer: - post: - operationId: StartFileTransfer - description: '

Begins a file transfer between local Amazon Web Services storage and a remote AS2 or SFTP server.

  • For an AS2 connector, you specify the ConnectorId and one or more SendFilePaths to identify the files you want to transfer.

  • For an SFTP connector, the file transfer can be either outbound or inbound. In both cases, you specify the ConnectorId. Depending on the direction of the transfer, you also specify the following items:

    • If you are transferring file from a partner''s SFTP server to a Transfer Family server, you specify one or more RetreiveFilePaths to identify the files you want to transfer, and a LocalDirectoryPath to specify the destination folder.

    • If you are transferring file to a partner''s SFTP server from Amazon Web Services storage, you specify one or more SendFilePaths to identify the files you want to transfer, and a RemoteDirectoryPath to specify the destination folder.

' - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/StartFileTransferResponse' - '480': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - '481': - description: InternalServiceError - content: - application/json: - schema: - $ref: '#/components/schemas/InternalServiceError' - '482': - description: InvalidRequestException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidRequestException' - '483': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - '484': - description: ThrottlingException - content: - application/json: - schema: - $ref: '#/components/schemas/ThrottlingException' - requestBody: - required: true - content: - application/x-amz-json-1.1: - schema: - $ref: '#/components/schemas/StartFileTransferRequest' - parameters: - - name: X-Amz-Target - in: header - schema: - type: string - default: TransferService.StartFileTransfer - enum: - - TransferService.StartFileTransfer - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /?__X-Amz-Target=TransferService.StartServer: - post: - operationId: StartServer - description: '

Changes the state of a file transfer protocol-enabled server from OFFLINE to ONLINE. It has no impact on a server that is already ONLINE. An ONLINE server can accept and process file transfer jobs.

The state of STARTING indicates that the server is in an intermediate state, either not fully able to respond, or not fully online. The values of START_FAILED can indicate an error condition.

No response is returned from this call.

' - responses: - '200': - description: Success - '480': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - '481': - description: InternalServiceError - content: - application/json: - schema: - $ref: '#/components/schemas/InternalServiceError' - '482': - description: InvalidRequestException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidRequestException' - '483': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - '484': - description: ThrottlingException - content: - application/json: - schema: - $ref: '#/components/schemas/ThrottlingException' - requestBody: - required: true - content: - application/x-amz-json-1.1: - schema: - $ref: '#/components/schemas/StartServerRequest' - parameters: - - name: X-Amz-Target - in: header - schema: - type: string - default: TransferService.StartServer - enum: - - TransferService.StartServer - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /?__X-Amz-Target=TransferService.StopServer: - post: - operationId: StopServer - description: '

Changes the state of a file transfer protocol-enabled server from ONLINE to OFFLINE. An OFFLINE server cannot accept and process file transfer jobs. Information tied to your server, such as server and user properties, are not affected by stopping your server.

Stopping the server does not reduce or impact your file transfer protocol endpoint billing; you must delete the server to stop being billed.

The state of STOPPING indicates that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of STOP_FAILED can indicate an error condition.

No response is returned from this call.

' - responses: - '200': - description: Success - '480': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - '481': - description: InternalServiceError - content: - application/json: - schema: - $ref: '#/components/schemas/InternalServiceError' - '482': - description: InvalidRequestException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidRequestException' - '483': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - '484': - description: ThrottlingException - content: - application/json: - schema: - $ref: '#/components/schemas/ThrottlingException' - requestBody: - required: true - content: - application/x-amz-json-1.1: - schema: - $ref: '#/components/schemas/StopServerRequest' - parameters: - - name: X-Amz-Target - in: header - schema: - type: string - default: TransferService.StopServer - enum: - - TransferService.StopServer - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /?__X-Amz-Target=TransferService.TagResource: - post: - operationId: TagResource - description: '

Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.

There is no response returned from this call.

' - responses: - '200': - description: Success - '480': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - '481': - description: InternalServiceError - content: - application/json: - schema: - $ref: '#/components/schemas/InternalServiceError' - '482': - description: InvalidRequestException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidRequestException' - '483': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - requestBody: - required: true - content: - application/x-amz-json-1.1: - schema: - $ref: '#/components/schemas/TagResourceRequest' - parameters: - - name: X-Amz-Target - in: header - schema: - type: string - default: TransferService.TagResource - enum: - - TransferService.TagResource - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /?__X-Amz-Target=TransferService.TestConnection: - post: - operationId: TestConnection - description: Tests whether your SFTP connector is set up successfully. We highly recommend that you call this operation to test your ability to transfer files between a Transfer Family server and a trading partner's SFTP server. - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/TestConnectionResponse' - '480': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - '481': - description: InternalServiceError - content: - application/json: - schema: - $ref: '#/components/schemas/InternalServiceError' - '482': - description: InvalidRequestException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidRequestException' - '483': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - requestBody: - required: true - content: - application/x-amz-json-1.1: - schema: - $ref: '#/components/schemas/TestConnectionRequest' - parameters: - - name: X-Amz-Target - in: header - schema: - type: string - default: TransferService.TestConnection - enum: - - TransferService.TestConnection - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /?__X-Amz-Target=TransferService.TestIdentityProvider: - post: - operationId: TestIdentityProvider - description: '

If the IdentityProviderType of a file transfer protocol-enabled server is AWS_DIRECTORY_SERVICE or API_Gateway, tests whether your identity provider is set up successfully. We highly recommend that you call this operation to test your authentication method as soon as you create your server. By doing so, you can troubleshoot issues with the identity provider integration to ensure that your users can successfully use the service.

The ServerId and UserName parameters are required. The ServerProtocol, SourceIp, and UserPassword are all optional.

Note the following:

  • You cannot use TestIdentityProvider if the IdentityProviderType of your server is SERVICE_MANAGED.

  • TestIdentityProvider does not work with keys: it only accepts passwords.

  • TestIdentityProvider can test the password operation for a custom Identity Provider that handles keys and passwords.

  • If you provide any incorrect values for any parameters, the Response field is empty.

  • If you provide a server ID for a server that uses service-managed users, you get an error:

    An error occurred (InvalidRequestException) when calling the TestIdentityProvider operation: s-server-ID not configured for external auth

  • If you enter a Server ID for the --server-id parameter that does not identify an actual Transfer server, you receive the following error:

    An error occurred (ResourceNotFoundException) when calling the TestIdentityProvider operation: Unknown server.

    It is possible your sever is in a different region. You can specify a region by adding the following: --region region-code, such as --region us-east-2 to specify a server in US East (Ohio).

' - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/TestIdentityProviderResponse' - '480': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - '481': - description: InternalServiceError - content: - application/json: - schema: - $ref: '#/components/schemas/InternalServiceError' - '482': - description: InvalidRequestException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidRequestException' - '483': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - requestBody: - required: true - content: - application/x-amz-json-1.1: - schema: - $ref: '#/components/schemas/TestIdentityProviderRequest' - parameters: - - name: X-Amz-Target - in: header - schema: - type: string - default: TransferService.TestIdentityProvider - enum: - - TransferService.TestIdentityProvider - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /?__X-Amz-Target=TransferService.UntagResource: - post: - operationId: UntagResource - description: '

Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.

No response is returned from this call.

' - responses: - '200': - description: Success - '480': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - '481': - description: InternalServiceError - content: - application/json: - schema: - $ref: '#/components/schemas/InternalServiceError' - '482': - description: InvalidRequestException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidRequestException' - '483': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - requestBody: - required: true - content: - application/x-amz-json-1.1: - schema: - $ref: '#/components/schemas/UntagResourceRequest' - parameters: - - name: X-Amz-Target - in: header - schema: - type: string - default: TransferService.UntagResource - enum: - - TransferService.UntagResource - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /?__X-Amz-Target=TransferService.UpdateAccess: - post: - operationId: UpdateAccess - description: Allows you to update parameters for the access specified in the ServerID and ExternalID parameters. - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/UpdateAccessResponse' - '480': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - '481': - description: InternalServiceError - content: - application/json: - schema: - $ref: '#/components/schemas/InternalServiceError' - '482': - description: InvalidRequestException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidRequestException' - '483': - description: ResourceExistsException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceExistsException' - '484': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - '485': - description: ThrottlingException - content: - application/json: - schema: - $ref: '#/components/schemas/ThrottlingException' - requestBody: - required: true - content: - application/x-amz-json-1.1: - schema: - $ref: '#/components/schemas/UpdateAccessRequest' - parameters: - - name: X-Amz-Target - in: header - schema: - type: string - default: TransferService.UpdateAccess - enum: - - TransferService.UpdateAccess - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /?__X-Amz-Target=TransferService.UpdateAgreement: - post: - operationId: UpdateAgreement - description: 'Updates some of the parameters for an existing agreement. Provide the AgreementId and the ServerId for the agreement that you want to update, along with the new values for the parameters to update.' - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/UpdateAgreementResponse' - '480': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - '481': - description: InternalServiceError - content: - application/json: - schema: - $ref: '#/components/schemas/InternalServiceError' - '482': - description: InvalidRequestException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidRequestException' - '483': - description: ResourceExistsException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceExistsException' - '484': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - '485': - description: ThrottlingException - content: - application/json: - schema: - $ref: '#/components/schemas/ThrottlingException' - requestBody: - required: true - content: - application/x-amz-json-1.1: - schema: - $ref: '#/components/schemas/UpdateAgreementRequest' - parameters: - - name: X-Amz-Target - in: header - schema: - type: string - default: TransferService.UpdateAgreement - enum: - - TransferService.UpdateAgreement - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /?__X-Amz-Target=TransferService.UpdateCertificate: - post: - operationId: UpdateCertificate - description: Updates the active and inactive dates for a certificate. - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/UpdateCertificateResponse' - '480': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - '481': - description: InternalServiceError - content: - application/json: - schema: - $ref: '#/components/schemas/InternalServiceError' - '482': - description: InvalidRequestException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidRequestException' - '483': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - '484': - description: ThrottlingException - content: - application/json: - schema: - $ref: '#/components/schemas/ThrottlingException' - requestBody: - required: true - content: - application/x-amz-json-1.1: - schema: - $ref: '#/components/schemas/UpdateCertificateRequest' - parameters: - - name: X-Amz-Target - in: header - schema: - type: string - default: TransferService.UpdateCertificate - enum: - - TransferService.UpdateCertificate - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /?__X-Amz-Target=TransferService.UpdateConnector: - post: - operationId: UpdateConnector - description: 'Updates some of the parameters for an existing connector. Provide the ConnectorId for the connector that you want to update, along with the new values for the parameters to update.' - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/UpdateConnectorResponse' - '480': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - '481': - description: InternalServiceError - content: - application/json: - schema: - $ref: '#/components/schemas/InternalServiceError' - '482': - description: InvalidRequestException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidRequestException' - '483': - description: ResourceExistsException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceExistsException' - '484': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - '485': - description: ThrottlingException - content: - application/json: - schema: - $ref: '#/components/schemas/ThrottlingException' - requestBody: - required: true - content: - application/x-amz-json-1.1: - schema: - $ref: '#/components/schemas/UpdateConnectorRequest' - parameters: - - name: X-Amz-Target - in: header - schema: - type: string - default: TransferService.UpdateConnector - enum: - - TransferService.UpdateConnector - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /?__X-Amz-Target=TransferService.UpdateHostKey: - post: - operationId: UpdateHostKey - description: Updates the description for the host key that's specified by the ServerId and HostKeyId parameters. - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/UpdateHostKeyResponse' - '480': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - '481': - description: InternalServiceError - content: - application/json: - schema: - $ref: '#/components/schemas/InternalServiceError' - '482': - description: InvalidRequestException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidRequestException' - '483': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - '484': - description: ThrottlingException - content: - application/json: - schema: - $ref: '#/components/schemas/ThrottlingException' - requestBody: - required: true - content: - application/x-amz-json-1.1: - schema: - $ref: '#/components/schemas/UpdateHostKeyRequest' - parameters: - - name: X-Amz-Target - in: header - schema: - type: string - default: TransferService.UpdateHostKey - enum: - - TransferService.UpdateHostKey - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /?__X-Amz-Target=TransferService.UpdateProfile: - post: - operationId: UpdateProfile - description: 'Updates some of the parameters for an existing profile. Provide the ProfileId for the profile that you want to update, along with the new values for the parameters to update.' - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/UpdateProfileResponse' - '480': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - '481': - description: InternalServiceError - content: - application/json: - schema: - $ref: '#/components/schemas/InternalServiceError' - '482': - description: InvalidRequestException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidRequestException' - '483': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - '484': - description: ThrottlingException - content: - application/json: - schema: - $ref: '#/components/schemas/ThrottlingException' - requestBody: - required: true - content: - application/x-amz-json-1.1: - schema: - $ref: '#/components/schemas/UpdateProfileRequest' - parameters: - - name: X-Amz-Target - in: header - schema: - type: string - default: TransferService.UpdateProfile - enum: - - TransferService.UpdateProfile - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /?__X-Amz-Target=TransferService.UpdateServer: - post: - operationId: UpdateServer - description:

Updates the file transfer protocol-enabled server's properties after that server has been created.

The UpdateServer call returns the ServerId of the server you updated.

- responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/UpdateServerResponse' - '480': - description: AccessDeniedException - content: - application/json: - schema: - $ref: '#/components/schemas/AccessDeniedException' - '481': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - '482': - description: ConflictException - content: - application/json: - schema: - $ref: '#/components/schemas/ConflictException' - '483': - description: InternalServiceError - content: - application/json: - schema: - $ref: '#/components/schemas/InternalServiceError' - '484': - description: InvalidRequestException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidRequestException' - '485': - description: ResourceExistsException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceExistsException' - '486': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - '487': - description: ThrottlingException - content: - application/json: - schema: - $ref: '#/components/schemas/ThrottlingException' - requestBody: - required: true - content: - application/x-amz-json-1.1: - schema: - $ref: '#/components/schemas/UpdateServerRequest' - parameters: - - name: X-Amz-Target - in: header - schema: - type: string - default: TransferService.UpdateServer - enum: - - TransferService.UpdateServer - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - /?__X-Amz-Target=TransferService.UpdateUser: - post: - operationId: UpdateUser - description: '

Assigns new properties to a user. Parameters you pass modify any or all of the following: the home directory, role, and policy for the UserName and ServerId you specify.

The response returns the ServerId and the UserName for the updated user.

' - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/UpdateUserResponse' - '480': - description: ServiceUnavailableException - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUnavailableException' - '481': - description: InternalServiceError - content: - application/json: - schema: - $ref: '#/components/schemas/InternalServiceError' - '482': - description: InvalidRequestException - content: - application/json: - schema: - $ref: '#/components/schemas/InvalidRequestException' - '483': - description: ResourceNotFoundException - content: - application/json: - schema: - $ref: '#/components/schemas/ResourceNotFoundException' - '484': - description: ThrottlingException - content: - application/json: - schema: - $ref: '#/components/schemas/ThrottlingException' - requestBody: - required: true - content: - application/x-amz-json-1.1: - schema: - $ref: '#/components/schemas/UpdateUserRequest' - parameters: - - name: X-Amz-Target - in: header - schema: - type: string - default: TransferService.UpdateUser - enum: - - TransferService.UpdateUser - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' -components: - x-stackQL-resources: - servers: - name: servers - methods: - create_server: - operation: - $ref: '#/paths/~1?__X-Amz-Target=TransferService.CreateServer/post' - request: - mediaType: application/x-amz-json-1.1 - default: | - {} - response: - mediaType: application/json - openAPIDocKey: '200' - list_servers: - operation: - $ref: '#/paths/~1?__X-Amz-Target=TransferService.ListServers/post' - request: - mediaType: application/x-amz-json-1.1 - default: | - {} - response: - objectKey: '$.Servers' - mediaType: application/json - openAPIDocKey: '200' - describe_server: - operation: - $ref: '#/paths/~1?__X-Amz-Target=TransferService.DescribeServer/post' - request: - mediaType: application/x-amz-json-1.1 - response: - objectKey: '$.Server' - mediaType: application/json - openAPIDocKey: '200' - update_server: - operation: - $ref: '#/paths/~1?__X-Amz-Target=TransferService.UpdateServer/post' - request: - mediaType: application/x-amz-json-1.1 - response: - mediaType: application/json - openAPIDocKey: '200' - delete_server: - operation: - $ref: '#/paths/~1?__X-Amz-Target=TransferService.DeleteServer/post' - request: - mediaType: application/x-amz-json-1.1 - response: - openAPIDocKey: '200' - start_server: - operation: - $ref: '#/paths/~1?__X-Amz-Target=TransferService.StartServer/post' - request: - mediaType: application/x-amz-json-1.1 - response: - openAPIDocKey: '200' - stop_server: - operation: - $ref: '#/paths/~1?__X-Amz-Target=TransferService.StopServer/post' - request: - mediaType: application/x-amz-json-1.1 - response: - openAPIDocKey: '200' - id: aws.transfer_api.servers - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/servers/methods/delete_server' - insert: - - $ref: '#/components/x-stackQL-resources/servers/methods/create_server' - select: - - $ref: '#/components/x-stackQL-resources/servers/methods/describe_server' - - $ref: '#/components/x-stackQL-resources/servers/methods/list_servers' - update: - - $ref: '#/components/x-stackQL-resources/servers/methods/update_server' - title: servers - users: - name: users - methods: - list_users: - operation: - $ref: '#/paths/~1?__X-Amz-Target=TransferService.ListUsers/post' - request: - mediaType: application/x-amz-json-1.1 - response: - objectKey: '$.Users' - mediaType: application/json - openAPIDocKey: '200' - describe_user: - operation: - $ref: '#/paths/~1?__X-Amz-Target=TransferService.DescribeUser/post' - request: - mediaType: application/x-amz-json-1.1 - response: - objectKey: '$.User' - mediaType: application/json - openAPIDocKey: '200' - create_user: - operation: - $ref: '#/paths/~1?__X-Amz-Target=TransferService.CreateUser/post' - request: - mediaType: application/x-amz-json-1.1 - response: - mediaType: application/json - openAPIDocKey: '200' - update_user: - operation: - $ref: '#/paths/~1?__X-Amz-Target=TransferService.UpdateUser/post' - request: - mediaType: application/x-amz-json-1.1 - response: - mediaType: application/json - openAPIDocKey: '200' - delete_user: - operation: - $ref: '#/paths/~1?__X-Amz-Target=TransferService.DeleteUser/post' - request: - mediaType: application/x-amz-json-1.1 - response: - openAPIDocKey: '200' - id: aws.transfer_api.users - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/users/methods/delete_user' - insert: - - $ref: '#/components/x-stackQL-resources/users/methods/create_user' - select: - - $ref: '#/components/x-stackQL-resources/users/methods/describe_user' - - $ref: '#/components/x-stackQL-resources/users/methods/list_users' - update: - - $ref: '#/components/x-stackQL-resources/users/methods/update_user' - title: users - public_keys: - name: public_keys - methods: - import_public_key: - operation: - $ref: '#/paths/~1?__X-Amz-Target=TransferService.ImportSshPublicKey/post' - request: - mediaType: application/x-amz-json-1.1 - response: - mediaType: application/json - openAPIDocKey: '200' - delete_public_key: - operation: - $ref: '#/paths/~1?__X-Amz-Target=TransferService.DeleteSshPublicKey/post' - request: - mediaType: application/x-amz-json-1.1 - response: - openAPIDocKey: '200' - id: aws.transfer_api.public_keys - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/public_keys/methods/delete_public_key' - insert: - - $ref: '#/components/x-stackQL-resources/public_keys/methods/import_public_key' - select: [] - update: [] - title: public_keys - parameters: - X-Amz-Content-Sha256: - name: X-Amz-Content-Sha256 - in: header - schema: - type: string - required: false - X-Amz-Date: - name: X-Amz-Date - in: header - schema: - type: string - required: false - X-Amz-Algorithm: - name: X-Amz-Algorithm - in: header - schema: - type: string - required: false - X-Amz-Credential: - name: X-Amz-Credential - in: header - schema: - type: string - required: false - X-Amz-Security-Token: - name: X-Amz-Security-Token - in: header - schema: - type: string - required: false - X-Amz-Signature: - name: X-Amz-Signature - in: header - schema: - type: string - required: false - X-Amz-SignedHeaders: - name: X-Amz-SignedHeaders - in: header - schema: - type: string - required: false - securitySchemes: - hmac: - type: apiKey - name: Authorization - in: header - description: Amazon Signature authorization v4 - x-amazon-apigateway-authtype: awsSigv4 - schemas: - CreateAccessResponse: - type: object - required: - - ServerId - - ExternalId - properties: - ServerId: - $ref: '#/components/schemas/ServerId' - ExternalId: - $ref: '#/components/schemas/ExternalId' - CreateAccessRequest: - type: object - required: - - Role - - ServerId - - ExternalId - title: CreateAccessRequest - properties: - HomeDirectory: - $ref: '#/components/schemas/HomeDirectory' - HomeDirectoryType: - $ref: '#/components/schemas/HomeDirectoryType' - HomeDirectoryMappings: - $ref: '#/components/schemas/HomeDirectoryMappings' - Policy: - $ref: '#/components/schemas/Policy' - PosixProfile: - $ref: '#/components/schemas/PosixProfile' - Role: - $ref: '#/components/schemas/Role' - ServerId: - $ref: '#/components/schemas/ServerId' - ExternalId: - $ref: '#/components/schemas/ExternalId' - ServiceUnavailableException: {} - InternalServiceError: {} - InvalidRequestException: {} - ResourceExistsException: {} - ResourceNotFoundException: {} - CreateAgreementResponse: - type: object - required: - - AgreementId - properties: - AgreementId: - $ref: '#/components/schemas/AgreementId' - CreateAgreementRequest: - type: object - required: - - ServerId - - LocalProfileId - - PartnerProfileId - - BaseDirectory - - AccessRole - title: CreateAgreementRequest - properties: - Description: - $ref: '#/components/schemas/Description' - ServerId: - $ref: '#/components/schemas/ServerId' - LocalProfileId: - $ref: '#/components/schemas/ProfileId' - PartnerProfileId: - $ref: '#/components/schemas/ProfileId' - BaseDirectory: - $ref: '#/components/schemas/HomeDirectory' - AccessRole: - $ref: '#/components/schemas/Role' - Status: - $ref: '#/components/schemas/AgreementStatusType' - Tags: - $ref: '#/components/schemas/Tags' - ThrottlingException: {} - CreateConnectorResponse: - type: object - required: - - ConnectorId - properties: - ConnectorId: - $ref: '#/components/schemas/ConnectorId' - CreateConnectorRequest: - type: object - required: - - Url - - AccessRole - title: CreateConnectorRequest - properties: - Url: - $ref: '#/components/schemas/Url' - As2Config: - $ref: '#/components/schemas/As2ConnectorConfig' - AccessRole: - $ref: '#/components/schemas/Role' - LoggingRole: - $ref: '#/components/schemas/Role' - Tags: - $ref: '#/components/schemas/Tags' - SftpConfig: - $ref: '#/components/schemas/SftpConnectorConfig' - CreateProfileResponse: - type: object - required: - - ProfileId - properties: - ProfileId: - $ref: '#/components/schemas/ProfileId' - CreateProfileRequest: - type: object - required: - - As2Id - - ProfileType - title: CreateProfileRequest - properties: - As2Id: - $ref: '#/components/schemas/As2Id' - ProfileType: - $ref: '#/components/schemas/ProfileType' - CertificateIds: - $ref: '#/components/schemas/CertificateIds' - Tags: - $ref: '#/components/schemas/Tags' - CreateServerResponse: - type: object - required: - - ServerId - properties: - ServerId: - $ref: '#/components/schemas/ServerId' - CreateServerRequest: - type: object - title: CreateServerRequest - properties: - Certificate: - $ref: '#/components/schemas/Certificate' - Domain: - $ref: '#/components/schemas/Domain' - EndpointDetails: - $ref: '#/components/schemas/EndpointDetails' - EndpointType: - $ref: '#/components/schemas/EndpointType' - HostKey: - $ref: '#/components/schemas/HostKey' - IdentityProviderDetails: - $ref: '#/components/schemas/IdentityProviderDetails' - IdentityProviderType: - $ref: '#/components/schemas/IdentityProviderType' - LoggingRole: - $ref: '#/components/schemas/Role' - PostAuthenticationLoginBanner: - $ref: '#/components/schemas/PostAuthenticationLoginBanner' - PreAuthenticationLoginBanner: - $ref: '#/components/schemas/PreAuthenticationLoginBanner' - Protocols: - $ref: '#/components/schemas/Protocols' - ProtocolDetails: - $ref: '#/components/schemas/ProtocolDetails' - SecurityPolicyName: - $ref: '#/components/schemas/SecurityPolicyName' - Tags: - $ref: '#/components/schemas/Tags' - WorkflowDetails: - $ref: '#/components/schemas/WorkflowDetails' - StructuredLogDestinations: - $ref: '#/components/schemas/StructuredLogDestinations' - AccessDeniedException: {} - CreateUserResponse: - type: object - required: - - ServerId - - UserName - properties: - ServerId: - $ref: '#/components/schemas/ServerId' - UserName: - $ref: '#/components/schemas/UserName' - CreateUserRequest: - type: object - required: - - Role - - ServerId - - UserName - title: CreateUserRequest - properties: - HomeDirectory: - $ref: '#/components/schemas/HomeDirectory' - HomeDirectoryType: - $ref: '#/components/schemas/HomeDirectoryType' - HomeDirectoryMappings: - $ref: '#/components/schemas/HomeDirectoryMappings' - Policy: - $ref: '#/components/schemas/Policy' - PosixProfile: - $ref: '#/components/schemas/PosixProfile' - Role: - $ref: '#/components/schemas/Role' - ServerId: - $ref: '#/components/schemas/ServerId' - SshPublicKeyBody: - $ref: '#/components/schemas/SshPublicKeyBody' - Tags: - $ref: '#/components/schemas/Tags' - UserName: - $ref: '#/components/schemas/UserName' - CreateWorkflowResponse: - type: object - required: - - WorkflowId - properties: - WorkflowId: - $ref: '#/components/schemas/WorkflowId' - CreateWorkflowRequest: - type: object - required: - - Steps - title: CreateWorkflowRequest - properties: - Description: - $ref: '#/components/schemas/WorkflowDescription' - Steps: - $ref: '#/components/schemas/WorkflowSteps' - OnExceptionSteps: - $ref: '#/components/schemas/WorkflowSteps' - Tags: - $ref: '#/components/schemas/Tags' - DeleteAccessRequest: - type: object - required: - - ServerId - - ExternalId - title: DeleteAccessRequest - properties: - ServerId: - $ref: '#/components/schemas/ServerId' - ExternalId: - $ref: '#/components/schemas/ExternalId' - DeleteAgreementRequest: - type: object - required: - - AgreementId - - ServerId - title: DeleteAgreementRequest - properties: - AgreementId: - $ref: '#/components/schemas/AgreementId' - ServerId: - $ref: '#/components/schemas/ServerId' - DeleteCertificateRequest: - type: object - required: - - CertificateId - title: DeleteCertificateRequest - properties: - CertificateId: - $ref: '#/components/schemas/CertificateId' - DeleteConnectorRequest: - type: object - required: - - ConnectorId - title: DeleteConnectorRequest - properties: - ConnectorId: - $ref: '#/components/schemas/ConnectorId' - DeleteHostKeyRequest: - type: object - required: - - ServerId - - HostKeyId - title: DeleteHostKeyRequest - properties: - ServerId: - $ref: '#/components/schemas/ServerId' - HostKeyId: - $ref: '#/components/schemas/HostKeyId' - DeleteProfileRequest: - type: object - required: - - ProfileId - title: DeleteProfileRequest - properties: - ProfileId: - $ref: '#/components/schemas/ProfileId' - DeleteServerRequest: - type: object - required: - - ServerId - title: DeleteServerRequest - properties: - ServerId: - $ref: '#/components/schemas/ServerId' - DeleteSshPublicKeyRequest: - type: object - required: - - ServerId - - SshPublicKeyId - - UserName - title: DeleteSshPublicKeyRequest - properties: - ServerId: - $ref: '#/components/schemas/ServerId' - SshPublicKeyId: - $ref: '#/components/schemas/SshPublicKeyId' - UserName: - $ref: '#/components/schemas/UserName' - DeleteUserRequest: - type: object - required: - - ServerId - - UserName - title: DeleteUserRequest - properties: - ServerId: - $ref: '#/components/schemas/ServerId' - UserName: - $ref: '#/components/schemas/UserName' - DeleteWorkflowRequest: - type: object - required: - - WorkflowId - title: DeleteWorkflowRequest - properties: - WorkflowId: - $ref: '#/components/schemas/WorkflowId' - DescribeAccessResponse: - type: object - required: - - ServerId - - Access - properties: - ServerId: - $ref: '#/components/schemas/ServerId' - Access: - $ref: '#/components/schemas/DescribedAccess' - DescribeAccessRequest: - type: object - required: - - ServerId - - ExternalId - title: DescribeAccessRequest - properties: - ServerId: - $ref: '#/components/schemas/ServerId' - ExternalId: - $ref: '#/components/schemas/ExternalId' - DescribeAgreementResponse: - type: object - required: - - Agreement - properties: - Agreement: - $ref: '#/components/schemas/DescribedAgreement' - DescribeAgreementRequest: - type: object - required: - - AgreementId - - ServerId - title: DescribeAgreementRequest - properties: - AgreementId: - $ref: '#/components/schemas/AgreementId' - ServerId: - $ref: '#/components/schemas/ServerId' - DescribeCertificateResponse: - type: object - required: - - Certificate - properties: - Certificate: - $ref: '#/components/schemas/DescribedCertificate' - DescribeCertificateRequest: - type: object - required: - - CertificateId - title: DescribeCertificateRequest - properties: - CertificateId: - $ref: '#/components/schemas/CertificateId' - DescribeConnectorResponse: - type: object - required: - - Connector - properties: - Connector: - $ref: '#/components/schemas/DescribedConnector' - DescribeConnectorRequest: - type: object - required: - - ConnectorId - title: DescribeConnectorRequest - properties: - ConnectorId: - $ref: '#/components/schemas/ConnectorId' - DescribeExecutionResponse: - type: object - required: - - WorkflowId - - Execution - properties: - WorkflowId: - $ref: '#/components/schemas/WorkflowId' - Execution: - $ref: '#/components/schemas/DescribedExecution' - DescribeExecutionRequest: - type: object - required: - - ExecutionId - - WorkflowId - title: DescribeExecutionRequest - properties: - ExecutionId: - $ref: '#/components/schemas/ExecutionId' - WorkflowId: - $ref: '#/components/schemas/WorkflowId' - DescribeHostKeyResponse: - type: object - required: - - HostKey - properties: - HostKey: - $ref: '#/components/schemas/DescribedHostKey' - DescribeHostKeyRequest: - type: object - required: - - ServerId - - HostKeyId - title: DescribeHostKeyRequest - properties: - ServerId: - $ref: '#/components/schemas/ServerId' - HostKeyId: - $ref: '#/components/schemas/HostKeyId' - DescribeProfileResponse: - type: object - required: - - Profile - properties: - Profile: - $ref: '#/components/schemas/DescribedProfile' - DescribeProfileRequest: - type: object - required: - - ProfileId - title: DescribeProfileRequest - properties: - ProfileId: - $ref: '#/components/schemas/ProfileId' - DescribeSecurityPolicyResponse: - type: object - required: - - SecurityPolicy - properties: - SecurityPolicy: - $ref: '#/components/schemas/DescribedSecurityPolicy' - DescribeSecurityPolicyRequest: - type: object - required: - - SecurityPolicyName - title: DescribeSecurityPolicyRequest - properties: - SecurityPolicyName: - $ref: '#/components/schemas/SecurityPolicyName' - DescribeServerResponse: - type: object - required: - - Server - properties: - Server: - $ref: '#/components/schemas/DescribedServer' - DescribeServerRequest: - type: object - required: - - ServerId - title: DescribeServerRequest - properties: - ServerId: - $ref: '#/components/schemas/ServerId' - DescribeUserResponse: - type: object - required: - - ServerId - - User - properties: - ServerId: - $ref: '#/components/schemas/ServerId' - User: - $ref: '#/components/schemas/DescribedUser' - DescribeUserRequest: - type: object - required: - - ServerId - - UserName - title: DescribeUserRequest - properties: - ServerId: - $ref: '#/components/schemas/ServerId' - UserName: - $ref: '#/components/schemas/UserName' - DescribeWorkflowResponse: - type: object - required: - - Workflow - properties: - Workflow: - $ref: '#/components/schemas/DescribedWorkflow' - DescribeWorkflowRequest: - type: object - required: - - WorkflowId - title: DescribeWorkflowRequest - properties: - WorkflowId: - $ref: '#/components/schemas/WorkflowId' - ImportCertificateResponse: - type: object - required: - - CertificateId - properties: - CertificateId: - $ref: '#/components/schemas/CertificateId' - ImportCertificateRequest: - type: object - required: - - Usage - - Certificate - title: ImportCertificateRequest - properties: - Usage: - $ref: '#/components/schemas/CertificateUsageType' - Certificate: - $ref: '#/components/schemas/CertificateBodyType' - CertificateChain: - $ref: '#/components/schemas/CertificateChainType' - PrivateKey: - $ref: '#/components/schemas/PrivateKeyType' - ActiveDate: - $ref: '#/components/schemas/CertDate' - InactiveDate: - $ref: '#/components/schemas/CertDate' - Description: - $ref: '#/components/schemas/Description' - Tags: - $ref: '#/components/schemas/Tags' - ImportHostKeyResponse: - type: object - required: - - ServerId - - HostKeyId - properties: - ServerId: - $ref: '#/components/schemas/ServerId' - HostKeyId: - $ref: '#/components/schemas/HostKeyId' - ImportHostKeyRequest: - type: object - required: - - ServerId - - HostKeyBody - title: ImportHostKeyRequest - properties: - ServerId: - $ref: '#/components/schemas/ServerId' - HostKeyBody: - $ref: '#/components/schemas/HostKey' - Description: - $ref: '#/components/schemas/HostKeyDescription' - Tags: - $ref: '#/components/schemas/Tags' - ImportSshPublicKeyResponse: - type: object - required: - - ServerId - - SshPublicKeyId - - UserName - properties: - ServerId: - $ref: '#/components/schemas/ServerId' - SshPublicKeyId: - $ref: '#/components/schemas/SshPublicKeyId' - UserName: - $ref: '#/components/schemas/UserName' - description: 'Identifies the user, the server they belong to, and the identifier of the SSH public key associated with that user. A user can have more than one key on each server that they are associated with.' - ImportSshPublicKeyRequest: - type: object - required: - - ServerId - - SshPublicKeyBody - - UserName - title: ImportSshPublicKeyRequest - properties: - ServerId: - $ref: '#/components/schemas/ServerId' - SshPublicKeyBody: - $ref: '#/components/schemas/SshPublicKeyBody' - UserName: - $ref: '#/components/schemas/UserName' - ListAccessesResponse: - type: object - required: - - ServerId - - Accesses - properties: - NextToken: - $ref: '#/components/schemas/NextToken' - ServerId: - $ref: '#/components/schemas/ServerId' - Accesses: - $ref: '#/components/schemas/ListedAccesses' - ListAccessesRequest: - type: object - required: - - ServerId - title: ListAccessesRequest - properties: - MaxResults: - $ref: '#/components/schemas/MaxResults' - NextToken: - $ref: '#/components/schemas/NextToken' - ServerId: - $ref: '#/components/schemas/ServerId' - InvalidNextTokenException: {} - ListAgreementsResponse: - type: object - required: - - Agreements - properties: - NextToken: - $ref: '#/components/schemas/NextToken' - Agreements: - $ref: '#/components/schemas/ListedAgreements' - ListAgreementsRequest: - type: object - required: - - ServerId - title: ListAgreementsRequest - properties: - MaxResults: - $ref: '#/components/schemas/MaxResults' - NextToken: - $ref: '#/components/schemas/NextToken' - ServerId: - $ref: '#/components/schemas/ServerId' - ListCertificatesResponse: - type: object - required: - - Certificates - properties: - NextToken: - $ref: '#/components/schemas/NextToken' - Certificates: - $ref: '#/components/schemas/ListedCertificates' - ListCertificatesRequest: - type: object - title: ListCertificatesRequest - properties: - MaxResults: - $ref: '#/components/schemas/MaxResults' - NextToken: - $ref: '#/components/schemas/NextToken' - ListConnectorsResponse: - type: object - required: - - Connectors - properties: - NextToken: - $ref: '#/components/schemas/NextToken' - Connectors: - $ref: '#/components/schemas/ListedConnectors' - ListConnectorsRequest: - type: object - title: ListConnectorsRequest - properties: - MaxResults: - $ref: '#/components/schemas/MaxResults' - NextToken: - $ref: '#/components/schemas/NextToken' - ListExecutionsResponse: - type: object - required: - - WorkflowId - - Executions - properties: - NextToken: - $ref: '#/components/schemas/NextToken' - WorkflowId: - $ref: '#/components/schemas/WorkflowId' - Executions: - $ref: '#/components/schemas/ListedExecutions' - ListExecutionsRequest: - type: object - required: - - WorkflowId - title: ListExecutionsRequest - properties: - MaxResults: - $ref: '#/components/schemas/MaxResults' - NextToken: - $ref: '#/components/schemas/NextToken' - WorkflowId: - $ref: '#/components/schemas/WorkflowId' - ListHostKeysResponse: - type: object - required: - - ServerId - - HostKeys - properties: - NextToken: - $ref: '#/components/schemas/NextToken' - ServerId: - $ref: '#/components/schemas/ServerId' - HostKeys: - $ref: '#/components/schemas/ListedHostKeys' - ListHostKeysRequest: - type: object - required: - - ServerId - title: ListHostKeysRequest - properties: - MaxResults: - $ref: '#/components/schemas/MaxResults' - NextToken: - $ref: '#/components/schemas/NextToken' - ServerId: - $ref: '#/components/schemas/ServerId' - ListProfilesResponse: - type: object - required: - - Profiles - properties: - NextToken: - $ref: '#/components/schemas/NextToken' - Profiles: - $ref: '#/components/schemas/ListedProfiles' - ListProfilesRequest: - type: object - title: ListProfilesRequest - properties: - MaxResults: - $ref: '#/components/schemas/MaxResults' - NextToken: - $ref: '#/components/schemas/NextToken' - ProfileType: - $ref: '#/components/schemas/ProfileType' - ListSecurityPoliciesResponse: - type: object - required: - - SecurityPolicyNames - properties: - NextToken: - $ref: '#/components/schemas/NextToken' - SecurityPolicyNames: - $ref: '#/components/schemas/SecurityPolicyNames' - ListSecurityPoliciesRequest: - type: object - title: ListSecurityPoliciesRequest - properties: - MaxResults: - $ref: '#/components/schemas/MaxResults' - NextToken: - $ref: '#/components/schemas/NextToken' - ListServersResponse: - type: object - required: - - Servers - properties: - NextToken: - $ref: '#/components/schemas/NextToken' - Servers: - $ref: '#/components/schemas/ListedServers' - ListServersRequest: - type: object - title: ListServersRequest - properties: - MaxResults: - $ref: '#/components/schemas/MaxResults' - NextToken: - $ref: '#/components/schemas/NextToken' - ListTagsForResourceResponse: - type: object - properties: - Arn: - $ref: '#/components/schemas/Arn' - NextToken: - $ref: '#/components/schemas/NextToken' - Tags: - $ref: '#/components/schemas/Tags' - ListTagsForResourceRequest: - type: object - required: - - Arn - title: ListTagsForResourceRequest - properties: - Arn: - $ref: '#/components/schemas/Arn' - MaxResults: - $ref: '#/components/schemas/MaxResults' - NextToken: - $ref: '#/components/schemas/NextToken' - ListUsersResponse: - type: object - required: - - ServerId - - Users - properties: - NextToken: - $ref: '#/components/schemas/NextToken' - ServerId: - $ref: '#/components/schemas/ServerId' - Users: - $ref: '#/components/schemas/ListedUsers' - ListUsersRequest: - type: object - required: - - ServerId - title: ListUsersRequest - properties: - MaxResults: - $ref: '#/components/schemas/MaxResults' - NextToken: - $ref: '#/components/schemas/NextToken' - ServerId: - $ref: '#/components/schemas/ServerId' - ListWorkflowsResponse: - type: object - required: - - Workflows - properties: - NextToken: - $ref: '#/components/schemas/NextToken' - Workflows: - $ref: '#/components/schemas/ListedWorkflows' - ListWorkflowsRequest: - type: object - title: ListWorkflowsRequest - properties: - MaxResults: - $ref: '#/components/schemas/MaxResults' - NextToken: - $ref: '#/components/schemas/NextToken' - SendWorkflowStepStateResponse: - type: object - properties: {} - SendWorkflowStepStateRequest: - type: object - required: - - WorkflowId - - ExecutionId - - Token - - Status - title: SendWorkflowStepStateRequest - properties: - WorkflowId: - $ref: '#/components/schemas/WorkflowId' - ExecutionId: - $ref: '#/components/schemas/ExecutionId' - Token: - $ref: '#/components/schemas/CallbackToken' - Status: - $ref: '#/components/schemas/CustomStepStatus' - StartFileTransferResponse: - type: object - required: - - TransferId - properties: - TransferId: - $ref: '#/components/schemas/TransferId' - StartFileTransferRequest: - type: object - required: - - ConnectorId - title: StartFileTransferRequest - properties: - ConnectorId: - $ref: '#/components/schemas/ConnectorId' - SendFilePaths: - $ref: '#/components/schemas/FilePaths' - RetrieveFilePaths: - $ref: '#/components/schemas/FilePaths' - LocalDirectoryPath: - $ref: '#/components/schemas/FilePath' - RemoteDirectoryPath: - $ref: '#/components/schemas/FilePath' - StartServerRequest: - type: object - required: - - ServerId - title: StartServerRequest - properties: - ServerId: - $ref: '#/components/schemas/ServerId' - StopServerRequest: - type: object - # required: - # - ServerId - title: StopServerRequest - properties: - ServerId: - $ref: '#/components/schemas/ServerId' - TagResourceRequest: - type: object - required: - - Arn - - Tags - title: TagResourceRequest - properties: - Arn: - $ref: '#/components/schemas/Arn' - Tags: - $ref: '#/components/schemas/Tags' - TestConnectionResponse: - type: object - properties: - ConnectorId: - $ref: '#/components/schemas/ConnectorId' - Status: - $ref: '#/components/schemas/Status' - StatusMessage: - $ref: '#/components/schemas/Message' - TestConnectionRequest: - type: object - required: - - ConnectorId - title: TestConnectionRequest - properties: - ConnectorId: - $ref: '#/components/schemas/ConnectorId' - TestIdentityProviderResponse: - type: object - required: - - StatusCode - - Url - properties: - Response: - $ref: '#/components/schemas/Response' - StatusCode: - $ref: '#/components/schemas/StatusCode' - Message: - $ref: '#/components/schemas/Message' - Url: - $ref: '#/components/schemas/Url' - TestIdentityProviderRequest: - type: object - required: - - ServerId - - UserName - title: TestIdentityProviderRequest - properties: - ServerId: - $ref: '#/components/schemas/ServerId' - ServerProtocol: - $ref: '#/components/schemas/Protocol' - SourceIp: - $ref: '#/components/schemas/SourceIp' - UserName: - $ref: '#/components/schemas/UserName' - UserPassword: - $ref: '#/components/schemas/UserPassword' - UntagResourceRequest: - type: object - required: - - Arn - - TagKeys - title: UntagResourceRequest - properties: - Arn: - $ref: '#/components/schemas/Arn' - TagKeys: - $ref: '#/components/schemas/TagKeys' - UpdateAccessResponse: - type: object - required: - - ServerId - - ExternalId - properties: - ServerId: - $ref: '#/components/schemas/ServerId' - ExternalId: - $ref: '#/components/schemas/ExternalId' - UpdateAccessRequest: - type: object - required: - - ServerId - - ExternalId - title: UpdateAccessRequest - properties: - HomeDirectory: - $ref: '#/components/schemas/HomeDirectory' - HomeDirectoryType: - $ref: '#/components/schemas/HomeDirectoryType' - HomeDirectoryMappings: - $ref: '#/components/schemas/HomeDirectoryMappings' - Policy: - $ref: '#/components/schemas/Policy' - PosixProfile: - $ref: '#/components/schemas/PosixProfile' - Role: - $ref: '#/components/schemas/Role' - ServerId: - $ref: '#/components/schemas/ServerId' - ExternalId: - $ref: '#/components/schemas/ExternalId' - UpdateAgreementResponse: - type: object - required: - - AgreementId - properties: - AgreementId: - $ref: '#/components/schemas/AgreementId' - UpdateAgreementRequest: - type: object - required: - - AgreementId - - ServerId - title: UpdateAgreementRequest - properties: - AgreementId: - $ref: '#/components/schemas/AgreementId' - ServerId: - $ref: '#/components/schemas/ServerId' - Description: - $ref: '#/components/schemas/Description' - Status: - $ref: '#/components/schemas/AgreementStatusType' - LocalProfileId: - $ref: '#/components/schemas/ProfileId' - PartnerProfileId: - $ref: '#/components/schemas/ProfileId' - BaseDirectory: - $ref: '#/components/schemas/HomeDirectory' - AccessRole: - $ref: '#/components/schemas/Role' - UpdateCertificateResponse: - type: object - required: - - CertificateId - properties: - CertificateId: - $ref: '#/components/schemas/CertificateId' - UpdateCertificateRequest: - type: object - required: - - CertificateId - title: UpdateCertificateRequest - properties: - CertificateId: - $ref: '#/components/schemas/CertificateId' - ActiveDate: - $ref: '#/components/schemas/CertDate' - InactiveDate: - $ref: '#/components/schemas/CertDate' - Description: - $ref: '#/components/schemas/Description' - UpdateConnectorResponse: - type: object - required: - - ConnectorId - properties: - ConnectorId: - $ref: '#/components/schemas/ConnectorId' - UpdateConnectorRequest: - type: object - required: - - ConnectorId - title: UpdateConnectorRequest - properties: - ConnectorId: - $ref: '#/components/schemas/ConnectorId' - Url: - $ref: '#/components/schemas/Url' - As2Config: - $ref: '#/components/schemas/As2ConnectorConfig' - AccessRole: - $ref: '#/components/schemas/Role' - LoggingRole: - $ref: '#/components/schemas/Role' - SftpConfig: - $ref: '#/components/schemas/SftpConnectorConfig' - UpdateHostKeyResponse: - type: object - required: - - ServerId - - HostKeyId - properties: - ServerId: - $ref: '#/components/schemas/ServerId' - HostKeyId: - $ref: '#/components/schemas/HostKeyId' - UpdateHostKeyRequest: - type: object - required: - - ServerId - - HostKeyId - - Description - title: UpdateHostKeyRequest - properties: - ServerId: - $ref: '#/components/schemas/ServerId' - HostKeyId: - $ref: '#/components/schemas/HostKeyId' - Description: - $ref: '#/components/schemas/HostKeyDescription' - UpdateProfileResponse: - type: object - required: - - ProfileId - properties: - ProfileId: - $ref: '#/components/schemas/ProfileId' - UpdateProfileRequest: - type: object - required: - - ProfileId - title: UpdateProfileRequest - properties: - ProfileId: - $ref: '#/components/schemas/ProfileId' - CertificateIds: - $ref: '#/components/schemas/CertificateIds' - UpdateServerResponse: - type: object - required: - - ServerId - properties: - ServerId: - $ref: '#/components/schemas/ServerId' - UpdateServerRequest: - type: object - required: - - ServerId - title: UpdateServerRequest - properties: - Certificate: - $ref: '#/components/schemas/Certificate' - ProtocolDetails: - $ref: '#/components/schemas/ProtocolDetails' - EndpointDetails: - $ref: '#/components/schemas/EndpointDetails' - EndpointType: - $ref: '#/components/schemas/EndpointType' - HostKey: - $ref: '#/components/schemas/HostKey' - IdentityProviderDetails: - $ref: '#/components/schemas/IdentityProviderDetails' - LoggingRole: - $ref: '#/components/schemas/NullableRole' - PostAuthenticationLoginBanner: - $ref: '#/components/schemas/PostAuthenticationLoginBanner' - PreAuthenticationLoginBanner: - $ref: '#/components/schemas/PreAuthenticationLoginBanner' - Protocols: - $ref: '#/components/schemas/Protocols' - SecurityPolicyName: - $ref: '#/components/schemas/SecurityPolicyName' - ServerId: - $ref: '#/components/schemas/ServerId' - WorkflowDetails: - $ref: '#/components/schemas/WorkflowDetails' - StructuredLogDestinations: - $ref: '#/components/schemas/StructuredLogDestinations' - ConflictException: {} - UpdateUserResponse: - type: object - required: - - ServerId - - UserName - properties: - ServerId: - $ref: '#/components/schemas/ServerId' - UserName: - $ref: '#/components/schemas/UserName' - description: ' UpdateUserResponse returns the user name and identifier for the request to update a user''s properties.' - UpdateUserRequest: - type: object - required: - - ServerId - - UserName - title: UpdateUserRequest - properties: - HomeDirectory: - $ref: '#/components/schemas/HomeDirectory' - HomeDirectoryType: - $ref: '#/components/schemas/HomeDirectoryType' - HomeDirectoryMappings: - $ref: '#/components/schemas/HomeDirectoryMappings' - Policy: - $ref: '#/components/schemas/Policy' - PosixProfile: - $ref: '#/components/schemas/PosixProfile' - Role: - $ref: '#/components/schemas/Role' - ServerId: - $ref: '#/components/schemas/ServerId' - UserName: - $ref: '#/components/schemas/UserName' - AddressAllocationId: - type: string - AddressAllocationIds: - type: array - items: - $ref: '#/components/schemas/AddressAllocationId' - AgreementId: - type: string - pattern: '^a-([0-9a-f]{17})$' - minLength: 19 - maxLength: 19 - AgreementStatusType: - type: string - enum: - - ACTIVE - - INACTIVE - Arn: - type: string - pattern: 'arn:.*' - minLength: 20 - maxLength: 1600 - ProfileId: - type: string - pattern: '^p-([0-9a-f]{17})$' - minLength: 19 - maxLength: 19 - MessageSubject: - type: string - pattern: '^[\p{Print}\p{Blank}]+' - minLength: 1 - maxLength: 1024 - CompressionEnum: - type: string - enum: - - ZLIB - - DISABLED - EncryptionAlg: - type: string - enum: - - AES128_CBC - - AES192_CBC - - AES256_CBC - - NONE - SigningAlg: - type: string - enum: - - SHA256 - - SHA384 - - SHA512 - - SHA1 - - NONE - MdnSigningAlg: - type: string - enum: - - SHA256 - - SHA384 - - SHA512 - - SHA1 - - NONE - - DEFAULT - MdnResponse: - type: string - enum: - - SYNC - - NONE - As2ConnectorSecretId: - type: string - minLength: 0 - maxLength: 2048 - As2ConnectorConfig: - type: object - properties: - LocalProfileId: - $ref: '#/components/schemas/ProfileId' - PartnerProfileId: - $ref: '#/components/schemas/ProfileId' - MessageSubject: - $ref: '#/components/schemas/MessageSubject' - Compression: - $ref: '#/components/schemas/CompressionEnum' - EncryptionAlgorithm: - $ref: '#/components/schemas/EncryptionAlg' - SigningAlgorithm: - $ref: '#/components/schemas/SigningAlg' - MdnSigningAlgorithm: - $ref: '#/components/schemas/MdnSigningAlg' - MdnResponse: - $ref: '#/components/schemas/MdnResponse' - BasicAuthSecretId: - $ref: '#/components/schemas/As2ConnectorSecretId' - description: 'Contains the details for an AS2 connector object. The connector object is used for AS2 outbound processes, to connect the Transfer Family customer with the trading partner.' - As2Id: - type: string - pattern: '^[\p{Print}\s]*' - minLength: 1 - maxLength: 128 - As2Transport: - type: string - enum: - - HTTP - As2Transports: - type: array - items: - $ref: '#/components/schemas/As2Transport' - minItems: 1 - maxItems: 1 - CallbackToken: - type: string - pattern: \w+ - minLength: 1 - maxLength: 64 - CertDate: - type: string - format: date-time - CertSerial: - type: string - pattern: '^[\p{XDigit}{2}:?]*' - minLength: 0 - maxLength: 48 - Certificate: - type: string - maxLength: 1600 - CertificateBodyType: - type: string - pattern: '^[\u0009\u000A\u000D\u0020-\u00FF]*' - minLength: 1 - maxLength: 16384 - format: password - CertificateChainType: - type: string - pattern: '^[\u0009\u000A\u000D\u0020-\u00FF]*' - minLength: 1 - maxLength: 2097152 - format: password - CertificateId: - type: string - pattern: '^cert-([0-9a-f]{17})$' - minLength: 22 - maxLength: 22 - CertificateIds: - type: array - items: - $ref: '#/components/schemas/CertificateId' - CertificateStatusType: - type: string - enum: - - ACTIVE - - PENDING_ROTATION - - INACTIVE - CertificateType: - type: string - enum: - - CERTIFICATE - - CERTIFICATE_WITH_PRIVATE_KEY - CertificateUsageType: - type: string - enum: - - SIGNING - - ENCRYPTION - ConnectorId: - type: string - pattern: '^c-([0-9a-f]{17})$' - minLength: 19 - maxLength: 19 - WorkflowStepName: - type: string - pattern: '^[\w-]*$' - maxLength: 30 - InputFileLocation: - type: object - properties: - S3FileLocation: - $ref: '#/components/schemas/S3InputFileLocation' - EfsFileLocation: - $ref: '#/components/schemas/EfsFileLocation' - description: Specifies the location for the file that's being processed. - OverwriteExisting: - type: string - enum: - - 'TRUE' - - 'FALSE' - SourceFileLocation: - type: string - pattern: '^\$\{(\w+.)+\w+\}$' - maxLength: 256 - CopyStepDetails: - type: object - properties: - Name: - $ref: '#/components/schemas/WorkflowStepName' - DestinationFileLocation: - $ref: '#/components/schemas/InputFileLocation' - OverwriteExisting: - $ref: '#/components/schemas/OverwriteExisting' - SourceFileLocation: - $ref: '#/components/schemas/SourceFileLocation' - description: Each step type has its own StepDetails structure. - HomeDirectory: - type: string - pattern: ^$|/.* - maxLength: 1024 - HomeDirectoryType: - type: string - enum: - - PATH - - LOGICAL - HomeDirectoryMappings: - type: array - items: - $ref: '#/components/schemas/HomeDirectoryMapEntry' - minItems: 1 - maxItems: 50 - Policy: - type: string - maxLength: 2048 - PosixProfile: - type: object - required: - - Uid - - Gid - properties: - Uid: - $ref: '#/components/schemas/PosixId' - Gid: - $ref: '#/components/schemas/PosixId' - SecondaryGids: - $ref: '#/components/schemas/SecondaryGids' - description: 'The full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users'' access to your Amazon EFS file systems. The POSIX permissions that are set on files and directories in your file system determine the level of access your users get when transferring files into and out of your Amazon EFS file systems.' - Role: - type: string - pattern: 'arn:.*role/.*' - minLength: 20 - maxLength: 2048 - ServerId: - type: string - pattern: '^s-([0-9a-f]{17})$' - minLength: 19 - maxLength: 19 - ExternalId: - type: string - pattern: '^S-1-[\d-]+$' - minLength: 1 - maxLength: 256 - Description: - type: string - pattern: '^[\p{Graph}]+' - minLength: 1 - maxLength: 200 - Tags: - type: array - items: - $ref: '#/components/schemas/Tag' - minItems: 1 - maxItems: 50 - Url: - type: string - maxLength: 255 - SftpConnectorConfig: - type: object - properties: - UserSecretId: - $ref: '#/components/schemas/SecretId' - TrustedHostKeys: - $ref: '#/components/schemas/SftpConnectorTrustedHostKeyList' - description: Contains the details for an SFTP connector object. The connector object is used for transferring files to and from a partner's SFTP server. - ProfileType: - type: string - enum: - - LOCAL - - PARTNER - Domain: - type: string - enum: - - S3 - - EFS - EndpointDetails: - type: object - properties: - AddressAllocationIds: - $ref: '#/components/schemas/AddressAllocationIds' - SubnetIds: - $ref: '#/components/schemas/SubnetIds' - VpcEndpointId: - $ref: '#/components/schemas/VpcEndpointId' - VpcId: - $ref: '#/components/schemas/VpcId' - SecurityGroupIds: - $ref: '#/components/schemas/SecurityGroupIds' - description: '

The virtual private cloud (VPC) endpoint settings that are configured for your file transfer protocol-enabled server. With a VPC endpoint, you can restrict access to your server and resources only within your VPC. To control incoming internet traffic, invoke the UpdateServer API and attach an Elastic IP address to your server''s endpoint.

After May 19, 2021, you won''t be able to create a server using EndpointType=VPC_ENDPOINT in your Amazon Web Servicesaccount if your account hasn''t already done so before May 19, 2021. If you have already created servers with EndpointType=VPC_ENDPOINT in your Amazon Web Servicesaccount on or before May 19, 2021, you will not be affected. After this date, use EndpointType=VPC.

For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.

' - EndpointType: - type: string - enum: - - PUBLIC - - VPC - - VPC_ENDPOINT - HostKey: - type: string - maxLength: 4096 - format: password - IdentityProviderDetails: - type: object - properties: - Url: - $ref: '#/components/schemas/Url' - InvocationRole: - $ref: '#/components/schemas/Role' - DirectoryId: - $ref: '#/components/schemas/DirectoryId' - Function: - $ref: '#/components/schemas/Function' - SftpAuthenticationMethods: - $ref: '#/components/schemas/SftpAuthenticationMethods' - description: Returns information related to the type of user authentication that is in use for a file transfer protocol-enabled server's users. A server can have only one method of authentication. - IdentityProviderType: - type: string - enum: - - SERVICE_MANAGED - - API_GATEWAY - - AWS_DIRECTORY_SERVICE - - AWS_LAMBDA - description: '

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.

' - PostAuthenticationLoginBanner: - type: string - pattern: '[\x09-\x0D\x20-\x7E]*' - maxLength: 512 - PreAuthenticationLoginBanner: - type: string - pattern: '[\x09-\x0D\x20-\x7E]*' - maxLength: 512 - Protocols: - type: array - items: - $ref: '#/components/schemas/Protocol' - minItems: 1 - maxItems: 4 - ProtocolDetails: - type: object - properties: - PassiveIp: - $ref: '#/components/schemas/PassiveIp' - TlsSessionResumptionMode: - $ref: '#/components/schemas/TlsSessionResumptionMode' - SetStatOption: - $ref: '#/components/schemas/SetStatOption' - As2Transports: - $ref: '#/components/schemas/As2Transports' - description: ' The protocol settings that are configured for your server. ' - SecurityPolicyName: - type: string - pattern: TransferSecurityPolicy-.+ - maxLength: 100 - WorkflowDetails: - type: object - properties: - OnUpload: - $ref: '#/components/schemas/OnUploadWorkflowDetails' - OnPartialUpload: - $ref: '#/components/schemas/OnPartialUploadWorkflowDetails' - description: Container for the WorkflowDetail data type. It is used by actions that trigger a workflow to begin execution. - StructuredLogDestinations: - type: array - items: - $ref: '#/components/schemas/Arn' - minItems: 0 - maxItems: 1 - SshPublicKeyBody: - type: string - maxLength: 2048 - UserName: - type: string - pattern: '^[\w][\w@.-]{2,99}$' - minLength: 3 - maxLength: 100 - WorkflowDescription: - type: string - pattern: '^[\w- ]*$' - maxLength: 256 - WorkflowSteps: - type: array - items: - $ref: '#/components/schemas/WorkflowStep' - maxItems: 8 - WorkflowId: - type: string - pattern: '^w-([a-z0-9]{17})$' - minLength: 19 - maxLength: 19 - CustomStepTarget: - type: string - pattern: 'arn:[a-z-]+:lambda:.*$' - maxLength: 170 - CustomStepTimeoutSeconds: - type: integer - minimum: 1 - maximum: 1800 - CustomStepDetails: - type: object - properties: - Name: - $ref: '#/components/schemas/WorkflowStepName' - Target: - $ref: '#/components/schemas/CustomStepTarget' - TimeoutSeconds: - $ref: '#/components/schemas/CustomStepTimeoutSeconds' - SourceFileLocation: - $ref: '#/components/schemas/SourceFileLocation' - description: Each step type has its own StepDetails structure. - CustomStepStatus: - type: string - enum: - - SUCCESS - - FAILURE - DateImported: - type: string - format: date-time - EncryptionType: - type: string - enum: - - PGP - DecryptStepDetails: - type: object - required: - - Type - - DestinationFileLocation - properties: - Name: - $ref: '#/components/schemas/WorkflowStepName' - Type: - $ref: '#/components/schemas/EncryptionType' - SourceFileLocation: - $ref: '#/components/schemas/SourceFileLocation' - OverwriteExisting: - $ref: '#/components/schemas/OverwriteExisting' - DestinationFileLocation: - $ref: '#/components/schemas/InputFileLocation' - description: Each step type has its own StepDetails structure. - HostKeyId: - type: string - pattern: '^hostkey-[0-9a-f]{17}$' - minLength: 25 - maxLength: 25 - SshPublicKeyId: - type: string - pattern: '^key-[0-9a-f]{17}$' - minLength: 21 - maxLength: 21 - DeleteStepDetails: - type: object - properties: - Name: - $ref: '#/components/schemas/WorkflowStepName' - SourceFileLocation: - $ref: '#/components/schemas/SourceFileLocation' - description: 'The name of the step, used to identify the delete step.' - DescribedAccess: - type: object - properties: - HomeDirectory: - $ref: '#/components/schemas/HomeDirectory' - HomeDirectoryMappings: - $ref: '#/components/schemas/HomeDirectoryMappings' - HomeDirectoryType: - $ref: '#/components/schemas/HomeDirectoryType' - Policy: - $ref: '#/components/schemas/Policy' - PosixProfile: - $ref: '#/components/schemas/PosixProfile' - Role: - $ref: '#/components/schemas/Role' - ExternalId: - $ref: '#/components/schemas/ExternalId' - description: Describes the properties of the access that was specified. - DescribedAgreement: - type: object - required: - - Arn - properties: - Arn: - $ref: '#/components/schemas/Arn' - AgreementId: - $ref: '#/components/schemas/AgreementId' - Description: - $ref: '#/components/schemas/Description' - Status: - $ref: '#/components/schemas/AgreementStatusType' - ServerId: - $ref: '#/components/schemas/ServerId' - LocalProfileId: - $ref: '#/components/schemas/ProfileId' - PartnerProfileId: - $ref: '#/components/schemas/ProfileId' - BaseDirectory: - $ref: '#/components/schemas/HomeDirectory' - AccessRole: - $ref: '#/components/schemas/Role' - Tags: - $ref: '#/components/schemas/Tags' - description: Describes the properties of an agreement. - DescribedCertificate: - type: object - required: - - Arn - properties: - Arn: - $ref: '#/components/schemas/Arn' - CertificateId: - $ref: '#/components/schemas/CertificateId' - Usage: - $ref: '#/components/schemas/CertificateUsageType' - Status: - $ref: '#/components/schemas/CertificateStatusType' - Certificate: - $ref: '#/components/schemas/CertificateBodyType' - CertificateChain: - $ref: '#/components/schemas/CertificateChainType' - ActiveDate: - $ref: '#/components/schemas/CertDate' - InactiveDate: - $ref: '#/components/schemas/CertDate' - Serial: - $ref: '#/components/schemas/CertSerial' - NotBeforeDate: - $ref: '#/components/schemas/CertDate' - NotAfterDate: - $ref: '#/components/schemas/CertDate' - Type: - $ref: '#/components/schemas/CertificateType' - Description: - $ref: '#/components/schemas/Description' - Tags: - $ref: '#/components/schemas/Tags' - description: Describes the properties of a certificate. - DescribedConnector: - type: object - required: - - Arn - properties: - Arn: - $ref: '#/components/schemas/Arn' - ConnectorId: - $ref: '#/components/schemas/ConnectorId' - Url: - $ref: '#/components/schemas/Url' - As2Config: - $ref: '#/components/schemas/As2ConnectorConfig' - AccessRole: - $ref: '#/components/schemas/Role' - LoggingRole: - $ref: '#/components/schemas/Role' - Tags: - $ref: '#/components/schemas/Tags' - SftpConfig: - $ref: '#/components/schemas/SftpConnectorConfig' - description: 'Describes the parameters for the connector, as identified by the ConnectorId.' - ExecutionId: - type: string - pattern: '^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$' - minLength: 36 - maxLength: 36 - DescribedExecution: - type: object - properties: - ExecutionId: - $ref: '#/components/schemas/ExecutionId' - InitialFileLocation: - $ref: '#/components/schemas/FileLocation' - ServiceMetadata: - $ref: '#/components/schemas/ServiceMetadata' - ExecutionRole: - $ref: '#/components/schemas/Role' - LoggingConfiguration: - $ref: '#/components/schemas/LoggingConfiguration' - PosixProfile: - $ref: '#/components/schemas/PosixProfile' - Status: - $ref: '#/components/schemas/ExecutionStatus' - Results: - $ref: '#/components/schemas/ExecutionResults' - description: The details for an execution object. - DescribedHostKey: - type: object - required: - - Arn - properties: - Arn: - $ref: '#/components/schemas/Arn' - HostKeyId: - $ref: '#/components/schemas/HostKeyId' - HostKeyFingerprint: - $ref: '#/components/schemas/HostKeyFingerprint' - Description: - $ref: '#/components/schemas/HostKeyDescription' - Type: - $ref: '#/components/schemas/HostKeyType' - DateImported: - $ref: '#/components/schemas/DateImported' - Tags: - $ref: '#/components/schemas/Tags' - description: The details for a server host key. - DescribedProfile: - type: object - required: - - Arn - properties: - Arn: - $ref: '#/components/schemas/Arn' - ProfileId: - $ref: '#/components/schemas/ProfileId' - ProfileType: - $ref: '#/components/schemas/ProfileType' - As2Id: - $ref: '#/components/schemas/As2Id' - CertificateIds: - $ref: '#/components/schemas/CertificateIds' - Tags: - $ref: '#/components/schemas/Tags' - description: 'The details for a local or partner AS2 profile. ' - DescribedSecurityPolicy: - type: object - required: - - SecurityPolicyName - properties: - Fips: - $ref: '#/components/schemas/Fips' - SecurityPolicyName: - $ref: '#/components/schemas/SecurityPolicyName' - SshCiphers: - $ref: '#/components/schemas/SecurityPolicyOptions' - SshKexs: - $ref: '#/components/schemas/SecurityPolicyOptions' - SshMacs: - $ref: '#/components/schemas/SecurityPolicyOptions' - TlsCiphers: - $ref: '#/components/schemas/SecurityPolicyOptions' - description: 'Describes the properties of a security policy that was specified. For more information about security policies, see Working with security policies.' - DescribedServer: - type: object - required: - - Arn - properties: - Arn: - $ref: '#/components/schemas/Arn' - Certificate: - $ref: '#/components/schemas/Certificate' - ProtocolDetails: - $ref: '#/components/schemas/ProtocolDetails' - Domain: - $ref: '#/components/schemas/Domain' - EndpointDetails: - $ref: '#/components/schemas/EndpointDetails' - EndpointType: - $ref: '#/components/schemas/EndpointType' - HostKeyFingerprint: - $ref: '#/components/schemas/HostKeyFingerprint' - IdentityProviderDetails: - $ref: '#/components/schemas/IdentityProviderDetails' - IdentityProviderType: - $ref: '#/components/schemas/IdentityProviderType' - LoggingRole: - $ref: '#/components/schemas/Role' - PostAuthenticationLoginBanner: - $ref: '#/components/schemas/PostAuthenticationLoginBanner' - PreAuthenticationLoginBanner: - $ref: '#/components/schemas/PreAuthenticationLoginBanner' - Protocols: - $ref: '#/components/schemas/Protocols' - S3StorageOptions: - type: object - SecurityPolicyName: - $ref: '#/components/schemas/SecurityPolicyName' - ServerId: - $ref: '#/components/schemas/ServerId' - State: - $ref: '#/components/schemas/State' - Tags: - $ref: '#/components/schemas/Tags' - UserCount: - $ref: '#/components/schemas/UserCount' - WorkflowDetails: - $ref: '#/components/schemas/WorkflowDetails' - StructuredLogDestinations: - $ref: '#/components/schemas/StructuredLogDestinations' - description: Describes the properties of a file transfer protocol-enabled server that was specified. - DescribedUser: - type: object - required: - - Arn - properties: - Arn: - $ref: '#/components/schemas/Arn' - HomeDirectory: - $ref: '#/components/schemas/HomeDirectory' - HomeDirectoryMappings: - $ref: '#/components/schemas/HomeDirectoryMappings' - HomeDirectoryType: - $ref: '#/components/schemas/HomeDirectoryType' - Policy: - $ref: '#/components/schemas/Policy' - PosixProfile: - $ref: '#/components/schemas/PosixProfile' - Role: - $ref: '#/components/schemas/Role' - SshPublicKeys: - $ref: '#/components/schemas/SshPublicKeys' - Tags: - $ref: '#/components/schemas/Tags' - UserName: - $ref: '#/components/schemas/UserName' - description: Describes the properties of a user that was specified. - DescribedWorkflow: - type: object - required: - - Arn - properties: - Arn: - $ref: '#/components/schemas/Arn' - Description: - $ref: '#/components/schemas/WorkflowDescription' - Steps: - $ref: '#/components/schemas/WorkflowSteps' - OnExceptionSteps: - $ref: '#/components/schemas/WorkflowSteps' - WorkflowId: - $ref: '#/components/schemas/WorkflowId' - Tags: - $ref: '#/components/schemas/Tags' - description: Describes the properties of the specified workflow - FileLocation: - type: object - properties: - S3FileLocation: - $ref: '#/components/schemas/S3FileLocation' - EfsFileLocation: - $ref: '#/components/schemas/EfsFileLocation' - description: Specifies the Amazon S3 or EFS file details to be used in the step. - ServiceMetadata: - type: object - required: - - UserDetails - properties: - UserDetails: - $ref: '#/components/schemas/UserDetails' - description: A container object for the session details that are associated with a workflow. - LoggingConfiguration: - type: object - properties: - LoggingRole: - $ref: '#/components/schemas/Role' - LogGroupName: - $ref: '#/components/schemas/LogGroupName' - description: Consists of the logging role and the log group name. - ExecutionStatus: - type: string - enum: - - IN_PROGRESS - - COMPLETED - - EXCEPTION - - HANDLING_EXCEPTION - ExecutionResults: - type: object - properties: - Steps: - $ref: '#/components/schemas/ExecutionStepResults' - OnExceptionSteps: - $ref: '#/components/schemas/ExecutionStepResults' - description: 'Specifies the steps in the workflow, as well as the steps to execute in case of any errors during workflow execution.' - HostKeyFingerprint: - type: string - HostKeyDescription: - type: string - pattern: '^[\p{Print}]*$' - minLength: 0 - maxLength: 200 - HostKeyType: - type: string - Fips: - type: boolean - SecurityPolicyOptions: - type: array - items: - $ref: '#/components/schemas/SecurityPolicyOption' - State: - type: string - enum: - - OFFLINE - - ONLINE - - STARTING - - STOPPING - - START_FAILED - - STOP_FAILED - description: '

Describes the condition of a file transfer protocol-enabled server with respect to its ability to perform file operations. There are six possible states: OFFLINE, ONLINE, STARTING, STOPPING, START_FAILED, and STOP_FAILED.

OFFLINE indicates that the server exists, but that it is not available for file operations. ONLINE indicates that the server is available to perform file operations. STARTING indicates that the server''s was instantiated, but the server is not yet available to perform file operations. Under normal conditions, it can take a couple of minutes for the server to be completely operational. Both START_FAILED and STOP_FAILED are error conditions.

' - UserCount: - type: integer - SshPublicKeys: - type: array - items: - $ref: '#/components/schemas/SshPublicKey' - maxItems: 5 - DirectoryId: - type: string - pattern: '^d-[0-9a-f]{10}$' - minLength: 12 - maxLength: 12 - EfsFileSystemId: - type: string - pattern: '^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:(access-point/fsap|file-system/fs)-[0-9a-f]{8,40}|fs(ap)?-[0-9a-f]{8,40})$' - maxLength: 128 - EfsPath: - type: string - pattern: '^[^\x00]+$' - minLength: 1 - maxLength: 65536 - EfsFileLocation: - type: object - properties: - FileSystemId: - $ref: '#/components/schemas/EfsFileSystemId' - Path: - $ref: '#/components/schemas/EfsPath' - description:

Specifies the details for the file location for the file that's being used in the workflow. Only applicable if you are using Amazon Elastic File Systems (Amazon EFS) for storage.

- SubnetIds: - type: array - items: - $ref: '#/components/schemas/SubnetId' - VpcEndpointId: - type: string - pattern: '^vpce-[0-9a-f]{17}$' - minLength: 22 - maxLength: 22 - VpcId: - type: string - SecurityGroupIds: - type: array - items: - $ref: '#/components/schemas/SecurityGroupId' - ExecutionErrorType: - type: string - enum: - - PERMISSION_DENIED - - CUSTOM_STEP_FAILED - - THROTTLED - - ALREADY_EXISTS - - NOT_FOUND - - BAD_REQUEST - - TIMEOUT - - INTERNAL_SERVER_ERROR - ExecutionErrorMessage: - type: string - ExecutionError: - type: object - required: - - Type - - Message - properties: - Type: - $ref: '#/components/schemas/ExecutionErrorType' - Message: - $ref: '#/components/schemas/ExecutionErrorMessage' - description: 'Specifies the error message and type, for an error that occurs during the execution of the workflow.' - ExecutionStepResults: - type: array - items: - $ref: '#/components/schemas/ExecutionStepResult' - minItems: 1 - maxItems: 50 - WorkflowStepType: - type: string - enum: - - COPY - - CUSTOM - - TAG - - DELETE - - DECRYPT - StepResultOutputsJson: - type: string - maxLength: 65536 - ExecutionStepResult: - type: object - properties: - StepType: - $ref: '#/components/schemas/WorkflowStepType' - Outputs: - $ref: '#/components/schemas/StepResultOutputsJson' - Error: - $ref: '#/components/schemas/ExecutionError' - description: 'Specifies the following details for the step: error (if any), outputs (if any), and the step type.' - S3FileLocation: - type: object - properties: - Bucket: - $ref: '#/components/schemas/S3Bucket' - Key: - $ref: '#/components/schemas/S3Key' - VersionId: - $ref: '#/components/schemas/S3VersionId' - Etag: - $ref: '#/components/schemas/S3Etag' - description: Specifies the details for the file location for the file that's being used in the workflow. Only applicable if you are using S3 storage. - FilePath: - type: string - pattern: ^(.)+ - minLength: 1 - maxLength: 1024 - FilePaths: - type: array - items: - $ref: '#/components/schemas/FilePath' - minItems: 1 - maxItems: 10 - Function: - type: string - pattern: '^arn:[a-z-]+:lambda:.*$' - minLength: 1 - maxLength: 170 - MapEntry: - type: string - pattern: ^/.* - maxLength: 1024 - MapTarget: - type: string - pattern: ^/.* - maxLength: 1024 - HomeDirectoryMapEntry: - type: object - required: - - Entry - - Target - properties: - Entry: - $ref: '#/components/schemas/MapEntry' - Target: - $ref: '#/components/schemas/MapTarget' - description: '

Represents an object that contains entries and targets for HomeDirectoryMappings.

The following is an Entry and Target pair example for chroot.

[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]

' - SftpAuthenticationMethods: - type: string - enum: - - PASSWORD - - PUBLIC_KEY - - PUBLIC_KEY_OR_PASSWORD - - PUBLIC_KEY_AND_PASSWORD - PrivateKeyType: - type: string - pattern: '^[\u0009\u000A\u000D\u0020-\u00FF]*' - minLength: 1 - maxLength: 16384 - format: password - S3InputFileLocation: - type: object - properties: - Bucket: - $ref: '#/components/schemas/S3Bucket' - Key: - $ref: '#/components/schemas/S3Key' - description: '

Specifies the customer input Amazon S3 file location. If it is used inside copyStepDetails.DestinationFileLocation, it should be the S3 copy destination.

You need to provide the bucket and key. The key can represent either a path or a file. This is determined by whether or not you end the key value with the forward slash (/) character. If the final character is "/", then your file is copied to the folder, and its name does not change. If, rather, the final character is alphanumeric, your uploaded file is renamed to the path value. In this case, if a file with that name already exists, it is overwritten.

For example, if your path is shared-files/bob/, your uploaded files are copied to the shared-files/bob/, folder. If your path is shared-files/today, each uploaded file is copied to the shared-files folder and named today: each upload overwrites the previous version of the bob file.

' - MaxResults: - type: integer - minimum: 1 - maximum: 1000 - NextToken: - type: string - minLength: 1 - maxLength: 6144 - ListedAccesses: - type: array - items: - $ref: '#/components/schemas/ListedAccess' - ListedAgreements: - type: array - items: - $ref: '#/components/schemas/ListedAgreement' - ListedCertificates: - type: array - items: - $ref: '#/components/schemas/ListedCertificate' - ListedConnectors: - type: array - items: - $ref: '#/components/schemas/ListedConnector' - ListedExecutions: - type: array - items: - $ref: '#/components/schemas/ListedExecution' - ListedHostKeys: - type: array - items: - $ref: '#/components/schemas/ListedHostKey' - ListedProfiles: - type: array - items: - $ref: '#/components/schemas/ListedProfile' - SecurityPolicyNames: - type: array - items: - $ref: '#/components/schemas/SecurityPolicyName' - ListedServers: - type: array - items: - $ref: '#/components/schemas/ListedServer' - ListedUsers: - type: array - items: - $ref: '#/components/schemas/ListedUser' - ListedWorkflows: - type: array - items: - $ref: '#/components/schemas/ListedWorkflow' - ListedAccess: - type: object - properties: - HomeDirectory: - $ref: '#/components/schemas/HomeDirectory' - HomeDirectoryType: - $ref: '#/components/schemas/HomeDirectoryType' - Role: - $ref: '#/components/schemas/Role' - ExternalId: - $ref: '#/components/schemas/ExternalId' - description: Lists the properties for one or more specified associated accesses. - ListedAgreement: - type: object - properties: - Arn: - $ref: '#/components/schemas/Arn' - AgreementId: - $ref: '#/components/schemas/AgreementId' - Description: - $ref: '#/components/schemas/Description' - Status: - $ref: '#/components/schemas/AgreementStatusType' - ServerId: - $ref: '#/components/schemas/ServerId' - LocalProfileId: - $ref: '#/components/schemas/ProfileId' - PartnerProfileId: - $ref: '#/components/schemas/ProfileId' - description: Describes the properties of an agreement. - ListedCertificate: - type: object - properties: - Arn: - $ref: '#/components/schemas/Arn' - CertificateId: - $ref: '#/components/schemas/CertificateId' - Usage: - $ref: '#/components/schemas/CertificateUsageType' - Status: - $ref: '#/components/schemas/CertificateStatusType' - ActiveDate: - $ref: '#/components/schemas/CertDate' - InactiveDate: - $ref: '#/components/schemas/CertDate' - Type: - $ref: '#/components/schemas/CertificateType' - Description: - $ref: '#/components/schemas/Description' - description: Describes the properties of a certificate. - ListedConnector: - type: object - properties: - Arn: - $ref: '#/components/schemas/Arn' - ConnectorId: - $ref: '#/components/schemas/ConnectorId' - Url: - $ref: '#/components/schemas/Url' - description: Returns details of the connector that is specified. - ListedExecution: - type: object - properties: - ExecutionId: - $ref: '#/components/schemas/ExecutionId' - InitialFileLocation: - $ref: '#/components/schemas/FileLocation' - ServiceMetadata: - $ref: '#/components/schemas/ServiceMetadata' - Status: - $ref: '#/components/schemas/ExecutionStatus' - description: Returns properties of the execution that is specified. - ListedHostKey: - type: object - required: - - Arn - properties: - Arn: - $ref: '#/components/schemas/Arn' - HostKeyId: - $ref: '#/components/schemas/HostKeyId' - Fingerprint: - $ref: '#/components/schemas/HostKeyFingerprint' - Description: - $ref: '#/components/schemas/HostKeyDescription' - Type: - $ref: '#/components/schemas/HostKeyType' - DateImported: - $ref: '#/components/schemas/DateImported' - description: Returns properties of the host key that's specified. - ListedProfile: - type: object - properties: - Arn: - $ref: '#/components/schemas/Arn' - ProfileId: - $ref: '#/components/schemas/ProfileId' - As2Id: - $ref: '#/components/schemas/As2Id' - ProfileType: - $ref: '#/components/schemas/ProfileType' - description: Returns the properties of the profile that was specified. - ListedServer: - type: object - required: - - Arn - properties: - Arn: - $ref: '#/components/schemas/Arn' - Domain: - $ref: '#/components/schemas/Domain' - IdentityProviderType: - $ref: '#/components/schemas/IdentityProviderType' - EndpointType: - $ref: '#/components/schemas/EndpointType' - LoggingRole: - $ref: '#/components/schemas/Role' - ServerId: - $ref: '#/components/schemas/ServerId' - State: - $ref: '#/components/schemas/State' - UserCount: - $ref: '#/components/schemas/UserCount' - description: Returns properties of a file transfer protocol-enabled server that was specified. - SshPublicKeyCount: - type: integer - ListedUser: - type: object - required: - - Arn - properties: - Arn: - $ref: '#/components/schemas/Arn' - HomeDirectory: - $ref: '#/components/schemas/HomeDirectory' - HomeDirectoryType: - $ref: '#/components/schemas/HomeDirectoryType' - Role: - $ref: '#/components/schemas/Role' - SshPublicKeyCount: - $ref: '#/components/schemas/SshPublicKeyCount' - UserName: - $ref: '#/components/schemas/UserName' - description: Returns properties of the user that you specify. - ListedWorkflow: - type: object - properties: - WorkflowId: - $ref: '#/components/schemas/WorkflowId' - Description: - $ref: '#/components/schemas/WorkflowDescription' - Arn: - $ref: '#/components/schemas/Arn' - description: 'Contains the identifier, text description, and Amazon Resource Name (ARN) for the workflow.' - LogGroupName: - type: string - pattern: '[\.\-_/#A-Za-z0-9]*' - minLength: 1 - maxLength: 512 - Message: - type: string - NullableRole: - type: string - pattern: '^$|arn:.*role/.*' - maxLength: 2048 - WorkflowDetail: - type: object - required: - - WorkflowId - - ExecutionRole - properties: - WorkflowId: - $ref: '#/components/schemas/WorkflowId' - ExecutionRole: - $ref: '#/components/schemas/Role' - description: '

Specifies the workflow ID for the workflow to assign and the execution role that''s used for executing the workflow.

In addition to a workflow to execute when a file is uploaded completely, WorkflowDetails can also contain a workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs when the server session disconnects while the file is still being uploaded.

' - OnPartialUploadWorkflowDetails: - type: array - items: - $ref: '#/components/schemas/WorkflowDetail' - maxItems: 1 - OnUploadWorkflowDetails: - type: array - items: - $ref: '#/components/schemas/WorkflowDetail' - maxItems: 1 - PassiveIp: - type: string - maxLength: 15 - PosixId: - type: integer - minimum: 0 - maximum: 4294967295 - SecondaryGids: - type: array - items: - $ref: '#/components/schemas/PosixId' - minItems: 0 - maxItems: 16 - Protocol: - type: string - enum: - - SFTP - - FTP - - FTPS - - AS2 - TlsSessionResumptionMode: - type: string - enum: - - DISABLED - - ENABLED - - ENFORCED - SetStatOption: - type: string - enum: - - DEFAULT - - ENABLE_NO_OP - Response: - type: string - S3Bucket: - type: string - pattern: '^[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]$' - minLength: 3 - maxLength: 63 - S3Etag: - type: string - pattern: ^.+$ - minLength: 1 - maxLength: 65536 - S3Key: - type: string - pattern: '[\P{M}\p{M}]*' - maxLength: 1024 - S3VersionId: - type: string - pattern: ^.+$ - minLength: 1 - maxLength: 1024 - S3TagKey: - type: string - pattern: '^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$' - minLength: 1 - maxLength: 128 - S3TagValue: - type: string - pattern: '^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$' - maxLength: 256 - S3Tag: - type: object - required: - - Key - - Value - properties: - Key: - $ref: '#/components/schemas/S3TagKey' - Value: - $ref: '#/components/schemas/S3TagValue' - description: Specifies the key-value pair that are assigned to a file during the execution of a Tagging step. - S3Tags: - type: array - items: - $ref: '#/components/schemas/S3Tag' - minItems: 1 - maxItems: 10 - SecretId: - type: string - minLength: 1 - maxLength: 2048 - SecurityGroupId: - type: string - pattern: '^sg-[0-9a-f]{8,17}$' - minLength: 11 - maxLength: 20 - SecurityPolicyOption: - type: string - maxLength: 50 - UserDetails: - type: object - required: - - UserName - - ServerId - properties: - UserName: - $ref: '#/components/schemas/UserName' - ServerId: - $ref: '#/components/schemas/ServerId' - SessionId: - $ref: '#/components/schemas/SessionId' - description: 'Specifies the user name, server ID, and session ID for a workflow.' - SessionId: - type: string - pattern: '^[\w-]*$' - minLength: 3 - maxLength: 32 - SftpConnectorTrustedHostKeyList: - type: array - items: - $ref: '#/components/schemas/SftpConnectorTrustedHostKey' - minItems: 1 - maxItems: 10 - SftpConnectorTrustedHostKey: - type: string - minLength: 1 - maxLength: 2048 - SourceIp: - type: string - pattern: '^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$' - maxLength: 32 - SshPublicKey: - type: object - required: - - DateImported - - SshPublicKeyBody - - SshPublicKeyId - properties: - DateImported: - $ref: '#/components/schemas/DateImported' - SshPublicKeyBody: - $ref: '#/components/schemas/SshPublicKeyBody' - SshPublicKeyId: - $ref: '#/components/schemas/SshPublicKeyId' - description: 'Provides information about the public Secure Shell (SSH) key that is associated with a Transfer Family user for the specific file transfer protocol-enabled server (as identified by ServerId). The information returned includes the date the key was imported, the public key contents, and the public key ID. A user can store more than one SSH public key associated with their user name on a specific server.' - TransferId: - type: string - pattern: '^[0-9a-zA-Z./-]+$' - minLength: 1 - maxLength: 512 - Status: - type: string - StatusCode: - type: integer - SubnetId: - type: string - TagKey: - type: string - maxLength: 128 - TagValue: - type: string - maxLength: 256 - Tag: - type: object - required: - - Key - - Value - properties: - Key: - $ref: '#/components/schemas/TagKey' - Value: - $ref: '#/components/schemas/TagValue' - description: 'Creates a key-value pair for a specific resource. Tags are metadata that you can use to search for and group a resource for various purposes. You can apply tags to servers, users, and roles. A tag key can take more than one value. For example, to group servers for accounting purposes, you might create a tag called Group and assign the values Research and Accounting to that group.' - TagKeys: - type: array - items: - $ref: '#/components/schemas/TagKey' - minItems: 1 - maxItems: 50 - TagStepDetails: - type: object - properties: - Name: - $ref: '#/components/schemas/WorkflowStepName' - Tags: - $ref: '#/components/schemas/S3Tags' - SourceFileLocation: - $ref: '#/components/schemas/SourceFileLocation' - description:

Each step type has its own StepDetails structure.

The key/value pairs used to tag a file during the execution of a workflow step.

- UserPassword: - type: string - maxLength: 1024 - format: password - WorkflowStep: - type: object - properties: - Type: - $ref: '#/components/schemas/WorkflowStepType' - CopyStepDetails: - $ref: '#/components/schemas/CopyStepDetails' - CustomStepDetails: - $ref: '#/components/schemas/CustomStepDetails' - DeleteStepDetails: - $ref: '#/components/schemas/DeleteStepDetails' - TagStepDetails: - $ref: '#/components/schemas/TagStepDetails' - DecryptStepDetails: - $ref: '#/components/schemas/DecryptStepDetails' - description: The basic building block of a workflow. -security: - - hmac: [] diff --git a/providers/src/aws/v00.00.00000/services/verifiedpermissions.yaml b/providers/src/aws/v00.00.00000/services/verifiedpermissions.yaml index bdfb7de9..a0d4a54b 100644 --- a/providers/src/aws/v00.00.00000/services/verifiedpermissions.yaml +++ b/providers/src/aws/v00.00.00000/services/verifiedpermissions.yaml @@ -420,14 +420,15 @@ components: - UserPoolArn additionalProperties: false IdentitySourceConfiguration: - type: object - x-title: CognitoUserPoolConfiguration - properties: - CognitoUserPoolConfiguration: - $ref: '#/components/schemas/CognitoUserPoolConfiguration' - required: - - CognitoUserPoolConfiguration - additionalProperties: false + oneOf: + - type: object + title: CognitoUserPoolConfiguration + properties: + CognitoUserPoolConfiguration: + $ref: '#/components/schemas/CognitoUserPoolConfiguration' + required: + - CognitoUserPoolConfiguration + additionalProperties: false IdentitySourceDetails: type: object properties: @@ -939,7 +940,7 @@ components: x-identifiers: - IdentitySourceId - PolicyStoreId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -956,9 +957,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -968,44 +969,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/identity_sources/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/identity_sources/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.IdentitySourceId') as identity_source_id, - JSON_EXTRACT(Properties, '$.PolicyStoreId') as policy_store_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::VerifiedPermissions::IdentitySource' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'IdentitySourceId') as identity_source_id, - json_extract_path_text(Properties, 'PolicyStoreId') as policy_store_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::VerifiedPermissions::IdentitySource' - AND region = 'us-east-1' - identity_source: - name: identity_source - id: aws.verifiedpermissions.identity_source - x-cfn-schema-name: IdentitySource - x-cfn-type-name: AWS::VerifiedPermissions::IdentitySource - x-identifiers: - - IdentitySourceId - - PolicyStoreId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1016,12 +982,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/identity_sources/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/identity_sources/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/identity_source/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/identity_sources/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1035,19 +1005,37 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Configuration') as configuration, - json_extract_path_text(Properties, 'Details') as details, - json_extract_path_text(Properties, 'IdentitySourceId') as identity_source_id, - json_extract_path_text(Properties, 'PolicyStoreId') as policy_store_id, - json_extract_path_text(Properties, 'PrincipalEntityType') as principal_entity_type - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::VerifiedPermissions::IdentitySource' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.IdentitySourceId') as identity_source_id, + JSON_EXTRACT(Properties, '$.PolicyStoreId') as policy_store_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::VerifiedPermissions::IdentitySource' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Configuration') as configuration, + json_extract_path_text(Properties, 'Details') as details, + json_extract_path_text(Properties, 'IdentitySourceId') as identity_source_id, + json_extract_path_text(Properties, 'PolicyStoreId') as policy_store_id, + json_extract_path_text(Properties, 'PrincipalEntityType') as principal_entity_type + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::VerifiedPermissions::IdentitySource' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'IdentitySourceId') as identity_source_id, + json_extract_path_text(Properties, 'PolicyStoreId') as policy_store_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::VerifiedPermissions::IdentitySource' + AND region = 'us-east-1' policies: name: policies id: aws.verifiedpermissions.policies @@ -1056,7 +1044,7 @@ components: x-identifiers: - PolicyId - PolicyStoreId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1073,9 +1061,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1085,44 +1073,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/policies/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/policies/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.PolicyId') as policy_id, - JSON_EXTRACT(Properties, '$.PolicyStoreId') as policy_store_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::VerifiedPermissions::Policy' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'PolicyId') as policy_id, - json_extract_path_text(Properties, 'PolicyStoreId') as policy_store_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::VerifiedPermissions::Policy' - AND region = 'us-east-1' - policy: - name: policy - id: aws.verifiedpermissions.policy - x-cfn-schema-name: Policy - x-cfn-type-name: AWS::VerifiedPermissions::Policy - x-identifiers: - - PolicyId - - PolicyStoreId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1133,12 +1086,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/policies/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/policy/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1151,18 +1108,36 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Definition') as definition, - json_extract_path_text(Properties, 'PolicyId') as policy_id, - json_extract_path_text(Properties, 'PolicyStoreId') as policy_store_id, - json_extract_path_text(Properties, 'PolicyType') as policy_type - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::VerifiedPermissions::Policy' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.PolicyId') as policy_id, + JSON_EXTRACT(Properties, '$.PolicyStoreId') as policy_store_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::VerifiedPermissions::Policy' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Definition') as definition, + json_extract_path_text(Properties, 'PolicyId') as policy_id, + json_extract_path_text(Properties, 'PolicyStoreId') as policy_store_id, + json_extract_path_text(Properties, 'PolicyType') as policy_type + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::VerifiedPermissions::Policy' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'PolicyId') as policy_id, + json_extract_path_text(Properties, 'PolicyStoreId') as policy_store_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::VerifiedPermissions::Policy' + AND region = 'us-east-1' policy_stores: name: policy_stores id: aws.verifiedpermissions.policy_stores @@ -1170,7 +1145,7 @@ components: x-cfn-type-name: AWS::VerifiedPermissions::PolicyStore x-identifiers: - PolicyStoreId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1187,9 +1162,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1199,41 +1174,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/policy_stores/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/policy_stores/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.PolicyStoreId') as policy_store_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::VerifiedPermissions::PolicyStore' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'PolicyStoreId') as policy_store_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::VerifiedPermissions::PolicyStore' - AND region = 'us-east-1' - policy_store: - name: policy_store - id: aws.verifiedpermissions.policy_store - x-cfn-schema-name: PolicyStore - x-cfn-type-name: AWS::VerifiedPermissions::PolicyStore - x-identifiers: - - PolicyStoreId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1244,12 +1187,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/policy_stores/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/policy_stores/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/policy_store/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/policy_stores/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1263,19 +1210,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'PolicyStoreId') as policy_store_id, - json_extract_path_text(Properties, 'ValidationSettings') as validation_settings, - json_extract_path_text(Properties, 'Schema') as _schema - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::VerifiedPermissions::PolicyStore' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.PolicyStoreId') as policy_store_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::VerifiedPermissions::PolicyStore' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'PolicyStoreId') as policy_store_id, + json_extract_path_text(Properties, 'ValidationSettings') as validation_settings, + json_extract_path_text(Properties, 'Schema') as _schema + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::VerifiedPermissions::PolicyStore' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'PolicyStoreId') as policy_store_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::VerifiedPermissions::PolicyStore' + AND region = 'us-east-1' policy_templates: name: policy_templates id: aws.verifiedpermissions.policy_templates @@ -1284,7 +1247,7 @@ components: x-identifiers: - PolicyStoreId - PolicyTemplateId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1301,9 +1264,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1313,44 +1276,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/policy_templates/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/policy_templates/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.PolicyStoreId') as policy_store_id, - JSON_EXTRACT(Properties, '$.PolicyTemplateId') as policy_template_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::VerifiedPermissions::PolicyTemplate' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'PolicyStoreId') as policy_store_id, - json_extract_path_text(Properties, 'PolicyTemplateId') as policy_template_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::VerifiedPermissions::PolicyTemplate' - AND region = 'us-east-1' - policy_template: - name: policy_template - id: aws.verifiedpermissions.policy_template - x-cfn-schema-name: PolicyTemplate - x-cfn-type-name: AWS::VerifiedPermissions::PolicyTemplate - x-identifiers: - - PolicyStoreId - - PolicyTemplateId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1361,12 +1289,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/policy_templates/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/policy_templates/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/policy_template/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/policy_templates/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1379,18 +1311,36 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'PolicyStoreId') as policy_store_id, - json_extract_path_text(Properties, 'PolicyTemplateId') as policy_template_id, - json_extract_path_text(Properties, 'Statement') as statement - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::VerifiedPermissions::PolicyTemplate' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.PolicyStoreId') as policy_store_id, + JSON_EXTRACT(Properties, '$.PolicyTemplateId') as policy_template_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::VerifiedPermissions::PolicyTemplate' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'PolicyStoreId') as policy_store_id, + json_extract_path_text(Properties, 'PolicyTemplateId') as policy_template_id, + json_extract_path_text(Properties, 'Statement') as statement + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::VerifiedPermissions::PolicyTemplate' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'PolicyStoreId') as policy_store_id, + json_extract_path_text(Properties, 'PolicyTemplateId') as policy_template_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::VerifiedPermissions::PolicyTemplate' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/voiceid.yaml b/providers/src/aws/v00.00.00000/services/voiceid.yaml index 3ebee1d3..ffb5e765 100644 --- a/providers/src/aws/v00.00.00000/services/voiceid.yaml +++ b/providers/src/aws/v00.00.00000/services/voiceid.yaml @@ -547,7 +547,7 @@ components: x-cfn-type-name: AWS::VoiceID::Domain x-identifiers: - DomainId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -564,9 +564,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -576,41 +576,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/domains/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/domains/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.DomainId') as domain_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::VoiceID::Domain' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'DomainId') as domain_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::VoiceID::Domain' - AND region = 'us-east-1' - domain: - name: domain - id: aws.voiceid.domain - x-cfn-schema-name: Domain - x-cfn-type-name: AWS::VoiceID::Domain - x-identifiers: - - DomainId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -621,12 +589,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/domains/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/domains/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/domain/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/domains/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -640,19 +612,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'DomainId') as domain_id, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'ServerSideEncryptionConfiguration') as server_side_encryption_configuration, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::VoiceID::Domain' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.DomainId') as domain_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::VoiceID::Domain' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'DomainId') as domain_id, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'ServerSideEncryptionConfiguration') as server_side_encryption_configuration, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::VoiceID::Domain' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'DomainId') as domain_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::VoiceID::Domain' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/vpclattice.yaml b/providers/src/aws/v00.00.00000/services/vpclattice.yaml index 95095a57..7b97ac9d 100644 --- a/providers/src/aws/v00.00.00000/services/vpclattice.yaml +++ b/providers/src/aws/v00.00.00000/services/vpclattice.yaml @@ -581,7 +581,7 @@ components: type: array items: $ref: '#/components/schemas/WeightedTargetGroup' - maxItems: 2 + maxItems: 10 minItems: 1 x-insertionOrder: false required: @@ -650,6 +650,7 @@ components: enum: - HTTP - HTTPS + - TLS_PASSTHROUGH ServiceArn: type: string maxLength: 2048 @@ -1409,7 +1410,6 @@ components: enum: - HTTP1 - HTTP2 - - GRPC Port: type: integer maximum: 65535 @@ -1461,6 +1461,7 @@ components: enum: - HTTP - HTTPS + - TCP ProtocolVersion: type: string default: HTTP1 @@ -1756,6 +1757,7 @@ components: enum: - HTTP - HTTPS + - TLS_PASSTHROUGH ServiceArn: type: string maxLength: 2048 @@ -2239,7 +2241,7 @@ components: x-cfn-type-name: AWS::VpcLattice::AccessLogSubscription x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2256,9 +2258,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2268,41 +2270,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/access_log_subscriptions/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/access_log_subscriptions/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::AccessLogSubscription' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::AccessLogSubscription' - AND region = 'us-east-1' - access_log_subscription: - name: access_log_subscription - id: aws.vpclattice.access_log_subscription - x-cfn-schema-name: AccessLogSubscription - x-cfn-type-name: AWS::VpcLattice::AccessLogSubscription - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2313,12 +2283,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/access_log_subscriptions/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/access_log_subscriptions/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/access_log_subscription/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/access_log_subscriptions/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2334,21 +2308,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'DestinationArn') as destination_arn, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'ResourceArn') as resource_arn, - json_extract_path_text(Properties, 'ResourceId') as resource_id, - json_extract_path_text(Properties, 'ResourceIdentifier') as resource_identifier, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::VpcLattice::AccessLogSubscription' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::AccessLogSubscription' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'DestinationArn') as destination_arn, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'ResourceArn') as resource_arn, + json_extract_path_text(Properties, 'ResourceId') as resource_id, + json_extract_path_text(Properties, 'ResourceIdentifier') as resource_identifier, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::VpcLattice::AccessLogSubscription' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::AccessLogSubscription' + AND region = 'us-east-1' auth_policies: name: auth_policies id: aws.vpclattice.auth_policies @@ -2356,7 +2346,7 @@ components: x-cfn-type-name: AWS::VpcLattice::AuthPolicy x-identifiers: - ResourceIdentifier - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2373,9 +2363,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2385,23 +2375,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/auth_policies/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/auth_policies/methods/delete_resource' - auth_policy: - name: auth_policy - id: aws.vpclattice.auth_policy - x-cfn-schema-name: AuthPolicy - x-cfn-type-name: AWS::VpcLattice::AuthPolicy - x-identifiers: - - ResourceIdentifier - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2412,12 +2388,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/auth_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/auth_policies/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/auth_policy/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/auth_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2429,7 +2409,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2447,7 +2427,7 @@ components: x-cfn-type-name: AWS::VpcLattice::Listener x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2464,9 +2444,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2476,41 +2456,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/listeners/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/listeners/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::Listener' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::Listener' - AND region = 'us-east-1' - listener: - name: listener - id: aws.vpclattice.listener - x-cfn-schema-name: Listener - x-cfn-type-name: AWS::VpcLattice::Listener - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2521,12 +2469,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/listeners/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/listeners/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/listener/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/listeners/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2545,24 +2497,40 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'DefaultAction') as default_action, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Port') as port, - json_extract_path_text(Properties, 'Protocol') as protocol, - json_extract_path_text(Properties, 'ServiceArn') as service_arn, - json_extract_path_text(Properties, 'ServiceId') as service_id, - json_extract_path_text(Properties, 'ServiceIdentifier') as service_identifier, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::VpcLattice::Listener' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::Listener' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'DefaultAction') as default_action, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Port') as port, + json_extract_path_text(Properties, 'Protocol') as protocol, + json_extract_path_text(Properties, 'ServiceArn') as service_arn, + json_extract_path_text(Properties, 'ServiceId') as service_id, + json_extract_path_text(Properties, 'ServiceIdentifier') as service_identifier, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::VpcLattice::Listener' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::Listener' + AND region = 'us-east-1' resource_policies: name: resource_policies id: aws.vpclattice.resource_policies @@ -2570,7 +2538,7 @@ components: x-cfn-type-name: AWS::VpcLattice::ResourcePolicy x-identifiers: - ResourceArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2587,9 +2555,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2599,23 +2567,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/resource_policies/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/resource_policies/methods/delete_resource' - resource_policy: - name: resource_policy - id: aws.vpclattice.resource_policy - x-cfn-schema-name: ResourcePolicy - x-cfn-type-name: AWS::VpcLattice::ResourcePolicy - x-identifiers: - - ResourceArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2626,12 +2580,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/resource_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/resource_policies/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/resource_policy/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/resource_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2642,7 +2600,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2659,7 +2617,7 @@ components: x-cfn-type-name: AWS::VpcLattice::Rule x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2676,9 +2634,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2688,41 +2646,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/rules/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/rules/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::Rule' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::Rule' - AND region = 'us-east-1' - rule: - name: rule - id: aws.vpclattice.rule - x-cfn-schema-name: Rule - x-cfn-type-name: AWS::VpcLattice::Rule - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2733,12 +2659,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/rules/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/rules/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/rule/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/rules/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2756,23 +2686,39 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Action') as action, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'ListenerIdentifier') as listener_identifier, - json_extract_path_text(Properties, 'Match') as _match, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Priority') as priority, - json_extract_path_text(Properties, 'ServiceIdentifier') as service_identifier, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::VpcLattice::Rule' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::Rule' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Action') as action, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'ListenerIdentifier') as listener_identifier, + json_extract_path_text(Properties, 'Match') as _match, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Priority') as priority, + json_extract_path_text(Properties, 'ServiceIdentifier') as service_identifier, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::VpcLattice::Rule' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::Rule' + AND region = 'us-east-1' services: name: services id: aws.vpclattice.services @@ -2780,7 +2726,7 @@ components: x-cfn-type-name: AWS::VpcLattice::Service x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2797,9 +2743,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2809,41 +2755,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/services/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/services/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::Service' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::Service' - AND region = 'us-east-1' - service: - name: service - id: aws.vpclattice.service - x-cfn-schema-name: Service - x-cfn-type-name: AWS::VpcLattice::Service - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2854,12 +2768,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/services/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/services/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/service/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/services/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2879,25 +2797,41 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'AuthType') as auth_type, - json_extract_path_text(Properties, 'CreatedAt') as created_at, - json_extract_path_text(Properties, 'DnsEntry') as dns_entry, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'LastUpdatedAt') as last_updated_at, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'CertificateArn') as certificate_arn, - json_extract_path_text(Properties, 'CustomDomainName') as custom_domain_name, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::VpcLattice::Service' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::Service' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'AuthType') as auth_type, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'DnsEntry') as dns_entry, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'LastUpdatedAt') as last_updated_at, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'CertificateArn') as certificate_arn, + json_extract_path_text(Properties, 'CustomDomainName') as custom_domain_name, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::VpcLattice::Service' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::Service' + AND region = 'us-east-1' service_networks: name: service_networks id: aws.vpclattice.service_networks @@ -2905,7 +2839,7 @@ components: x-cfn-type-name: AWS::VpcLattice::ServiceNetwork x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2922,9 +2856,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2934,41 +2868,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/service_networks/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/service_networks/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::ServiceNetwork' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::ServiceNetwork' - AND region = 'us-east-1' - service_network: - name: service_network - id: aws.vpclattice.service_network - x-cfn-schema-name: ServiceNetwork - x-cfn-type-name: AWS::VpcLattice::ServiceNetwork - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2979,12 +2881,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/service_networks/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/service_networks/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/service_network/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/service_networks/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3000,21 +2906,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'CreatedAt') as created_at, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'LastUpdatedAt') as last_updated_at, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'AuthType') as auth_type, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::VpcLattice::ServiceNetwork' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::ServiceNetwork' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'LastUpdatedAt') as last_updated_at, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'AuthType') as auth_type, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::VpcLattice::ServiceNetwork' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::ServiceNetwork' + AND region = 'us-east-1' service_network_service_associations: name: service_network_service_associations id: aws.vpclattice.service_network_service_associations @@ -3022,7 +2944,7 @@ components: x-cfn-type-name: AWS::VpcLattice::ServiceNetworkServiceAssociation x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3039,9 +2961,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3051,41 +2973,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/service_network_service_associations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/service_network_service_associations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::ServiceNetworkServiceAssociation' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::ServiceNetworkServiceAssociation' - AND region = 'us-east-1' - service_network_service_association: - name: service_network_service_association - id: aws.vpclattice.service_network_service_association - x-cfn-schema-name: ServiceNetworkServiceAssociation - x-cfn-type-name: AWS::VpcLattice::ServiceNetworkServiceAssociation - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3096,12 +2986,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/service_network_service_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/service_network_service_associations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/service_network_service_association/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/service_network_service_associations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3124,28 +3018,44 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'CreatedAt') as created_at, - json_extract_path_text(Properties, 'DnsEntry') as dns_entry, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'ServiceNetworkArn') as service_network_arn, - json_extract_path_text(Properties, 'ServiceNetworkId') as service_network_id, - json_extract_path_text(Properties, 'ServiceNetworkIdentifier') as service_network_identifier, - json_extract_path_text(Properties, 'ServiceNetworkName') as service_network_name, - json_extract_path_text(Properties, 'ServiceArn') as service_arn, - json_extract_path_text(Properties, 'ServiceId') as service_id, - json_extract_path_text(Properties, 'ServiceIdentifier') as service_identifier, - json_extract_path_text(Properties, 'ServiceName') as service_name, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::VpcLattice::ServiceNetworkServiceAssociation' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::ServiceNetworkServiceAssociation' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'DnsEntry') as dns_entry, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'ServiceNetworkArn') as service_network_arn, + json_extract_path_text(Properties, 'ServiceNetworkId') as service_network_id, + json_extract_path_text(Properties, 'ServiceNetworkIdentifier') as service_network_identifier, + json_extract_path_text(Properties, 'ServiceNetworkName') as service_network_name, + json_extract_path_text(Properties, 'ServiceArn') as service_arn, + json_extract_path_text(Properties, 'ServiceId') as service_id, + json_extract_path_text(Properties, 'ServiceIdentifier') as service_identifier, + json_extract_path_text(Properties, 'ServiceName') as service_name, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::VpcLattice::ServiceNetworkServiceAssociation' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::ServiceNetworkServiceAssociation' + AND region = 'us-east-1' service_network_vpc_associations: name: service_network_vpc_associations id: aws.vpclattice.service_network_vpc_associations @@ -3153,7 +3063,7 @@ components: x-cfn-type-name: AWS::VpcLattice::ServiceNetworkVpcAssociation x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3170,9 +3080,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3182,41 +3092,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/service_network_vpc_associations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/service_network_vpc_associations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::ServiceNetworkVpcAssociation' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::ServiceNetworkVpcAssociation' - AND region = 'us-east-1' - service_network_vpc_association: - name: service_network_vpc_association - id: aws.vpclattice.service_network_vpc_association - x-cfn-schema-name: ServiceNetworkVpcAssociation - x-cfn-type-name: AWS::VpcLattice::ServiceNetworkVpcAssociation - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3227,12 +3105,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/service_network_vpc_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/service_network_vpc_associations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/service_network_vpc_association/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/service_network_vpc_associations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3253,26 +3135,42 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'CreatedAt') as created_at, - json_extract_path_text(Properties, 'SecurityGroupIds') as security_group_ids, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'ServiceNetworkArn') as service_network_arn, - json_extract_path_text(Properties, 'ServiceNetworkId') as service_network_id, - json_extract_path_text(Properties, 'ServiceNetworkIdentifier') as service_network_identifier, - json_extract_path_text(Properties, 'ServiceNetworkName') as service_network_name, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'VpcId') as vpc_id, - json_extract_path_text(Properties, 'VpcIdentifier') as vpc_identifier, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::VpcLattice::ServiceNetworkVpcAssociation' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::ServiceNetworkVpcAssociation' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'SecurityGroupIds') as security_group_ids, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'ServiceNetworkArn') as service_network_arn, + json_extract_path_text(Properties, 'ServiceNetworkId') as service_network_id, + json_extract_path_text(Properties, 'ServiceNetworkIdentifier') as service_network_identifier, + json_extract_path_text(Properties, 'ServiceNetworkName') as service_network_name, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'VpcId') as vpc_id, + json_extract_path_text(Properties, 'VpcIdentifier') as vpc_identifier, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::VpcLattice::ServiceNetworkVpcAssociation' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::ServiceNetworkVpcAssociation' + AND region = 'us-east-1' target_groups: name: target_groups id: aws.vpclattice.target_groups @@ -3280,7 +3178,7 @@ components: x-cfn-type-name: AWS::VpcLattice::TargetGroup x-identifiers: - Arn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3297,9 +3195,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3309,41 +3207,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/target_groups/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/target_groups/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::TargetGroup' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Arn') as arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::TargetGroup' - AND region = 'us-east-1' - target_group: - name: target_group - id: aws.vpclattice.target_group - x-cfn-schema-name: TargetGroup - x-cfn-type-name: AWS::VpcLattice::TargetGroup - x-identifiers: - - Arn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3354,12 +3220,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/target_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/target_groups/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/target_group/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/target_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3378,24 +3248,40 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Config') as config, - json_extract_path_text(Properties, 'CreatedAt') as created_at, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'LastUpdatedAt') as last_updated_at, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Status') as status, - json_extract_path_text(Properties, 'Type') as type, - json_extract_path_text(Properties, 'Targets') as targets, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::VpcLattice::TargetGroup' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::TargetGroup' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Config') as config, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'LastUpdatedAt') as last_updated_at, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Status') as status, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'Targets') as targets, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::VpcLattice::TargetGroup' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Arn') as arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::VpcLattice::TargetGroup' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/wafv2.yaml b/providers/src/aws/v00.00.00000/services/wafv2.yaml index 0044ba04..bb544e6f 100644 --- a/providers/src/aws/v00.00.00000/services/wafv2.yaml +++ b/providers/src/aws/v00.00.00000/services/wafv2.yaml @@ -2618,7 +2618,7 @@ components: - Name - Id - Scope - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2635,9 +2635,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2647,47 +2647,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/ip_sets/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/ip_sets/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name, - JSON_EXTRACT(Properties, '$.Id') as id, - JSON_EXTRACT(Properties, '$.Scope') as scope - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::WAFv2::IPSet' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Scope') as scope - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::WAFv2::IPSet' - AND region = 'us-east-1' - ip_set: - name: ip_set - id: aws.wafv2.ip_set - x-cfn-schema-name: IPSet - x-cfn-type-name: AWS::WAFv2::IPSet - x-identifiers: - - Name - - Id - - Scope - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2698,12 +2660,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/ip_sets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/ip_sets/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/ip_set/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/ip_sets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2720,22 +2686,42 @@ components: AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Scope') as scope, - json_extract_path_text(Properties, 'IPAddressVersion') as ip_address_version, - json_extract_path_text(Properties, 'Addresses') as addresses, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::WAFv2::IPSet' - AND data__Identifier = '||' + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.Scope') as scope + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::WAFv2::IPSet' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Scope') as scope, + json_extract_path_text(Properties, 'IPAddressVersion') as ip_address_version, + json_extract_path_text(Properties, 'Addresses') as addresses, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::WAFv2::IPSet' + AND data__Identifier = '||' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Scope') as scope + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::WAFv2::IPSet' + AND region = 'us-east-1' logging_configurations: name: logging_configurations id: aws.wafv2.logging_configurations @@ -2743,7 +2729,7 @@ components: x-cfn-type-name: AWS::WAFv2::LoggingConfiguration x-identifiers: - ResourceArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2760,9 +2746,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2772,41 +2758,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/logging_configurations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/logging_configurations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.ResourceArn') as resource_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::WAFv2::LoggingConfiguration' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'ResourceArn') as resource_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::WAFv2::LoggingConfiguration' - AND region = 'us-east-1' - logging_configuration: - name: logging_configuration - id: aws.wafv2.logging_configuration - x-cfn-schema-name: LoggingConfiguration - x-cfn-type-name: AWS::WAFv2::LoggingConfiguration - x-identifiers: - - ResourceArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2817,12 +2771,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/logging_configurations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/logging_configurations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/logging_configuration/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/logging_configurations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2836,19 +2794,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'ResourceArn') as resource_arn, - json_extract_path_text(Properties, 'LogDestinationConfigs') as log_destination_configs, - json_extract_path_text(Properties, 'RedactedFields') as redacted_fields, - json_extract_path_text(Properties, 'ManagedByFirewallManager') as managed_by_firewall_manager, - json_extract_path_text(Properties, 'LoggingFilter') as logging_filter - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::WAFv2::LoggingConfiguration' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.ResourceArn') as resource_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::WAFv2::LoggingConfiguration' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'ResourceArn') as resource_arn, + json_extract_path_text(Properties, 'LogDestinationConfigs') as log_destination_configs, + json_extract_path_text(Properties, 'RedactedFields') as redacted_fields, + json_extract_path_text(Properties, 'ManagedByFirewallManager') as managed_by_firewall_manager, + json_extract_path_text(Properties, 'LoggingFilter') as logging_filter + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::WAFv2::LoggingConfiguration' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'ResourceArn') as resource_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::WAFv2::LoggingConfiguration' + AND region = 'us-east-1' regex_pattern_sets: name: regex_pattern_sets id: aws.wafv2.regex_pattern_sets @@ -2858,7 +2832,7 @@ components: - Name - Id - Scope - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2875,9 +2849,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2887,47 +2861,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/regex_pattern_sets/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/regex_pattern_sets/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name, - JSON_EXTRACT(Properties, '$.Id') as id, - JSON_EXTRACT(Properties, '$.Scope') as scope - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::WAFv2::RegexPatternSet' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Scope') as scope - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::WAFv2::RegexPatternSet' - AND region = 'us-east-1' - regex_pattern_set: - name: regex_pattern_set - id: aws.wafv2.regex_pattern_set - x-cfn-schema-name: RegexPatternSet - x-cfn-type-name: AWS::WAFv2::RegexPatternSet - x-identifiers: - - Name - - Id - - Scope - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2938,12 +2874,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/regex_pattern_sets/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/regex_pattern_sets/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/regex_pattern_set/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/regex_pattern_sets/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2959,21 +2899,41 @@ components: AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'RegularExpressionList') as regular_expression_list, - json_extract_path_text(Properties, 'Scope') as scope, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::WAFv2::RegexPatternSet' - AND data__Identifier = '||' + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.Scope') as scope + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::WAFv2::RegexPatternSet' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'RegularExpressionList') as regular_expression_list, + json_extract_path_text(Properties, 'Scope') as scope, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::WAFv2::RegexPatternSet' + AND data__Identifier = '||' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Scope') as scope + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::WAFv2::RegexPatternSet' + AND region = 'us-east-1' rule_groups: name: rule_groups id: aws.wafv2.rule_groups @@ -2983,7 +2943,7 @@ components: - Name - Id - Scope - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3000,9 +2960,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3012,47 +2972,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/rule_groups/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/rule_groups/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name, - JSON_EXTRACT(Properties, '$.Id') as id, - JSON_EXTRACT(Properties, '$.Scope') as scope - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::WAFv2::RuleGroup' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Scope') as scope - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::WAFv2::RuleGroup' - AND region = 'us-east-1' - rule_group: - name: rule_group - id: aws.wafv2.rule_group - x-cfn-schema-name: RuleGroup - x-cfn-type-name: AWS::WAFv2::RuleGroup - x-identifiers: - - Name - - Id - - Scope - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3063,12 +2985,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/rule_groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/rule_groups/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/rule_group/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/rule_groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3090,27 +3016,47 @@ components: AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Capacity') as capacity, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Scope') as scope, - json_extract_path_text(Properties, 'Rules') as rules, - json_extract_path_text(Properties, 'VisibilityConfig') as visibility_config, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'LabelNamespace') as label_namespace, - json_extract_path_text(Properties, 'CustomResponseBodies') as custom_response_bodies, - json_extract_path_text(Properties, 'AvailableLabels') as available_labels, - json_extract_path_text(Properties, 'ConsumedLabels') as consumed_labels - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::WAFv2::RuleGroup' - AND data__Identifier = '||' + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.Scope') as scope + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::WAFv2::RuleGroup' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Capacity') as capacity, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Scope') as scope, + json_extract_path_text(Properties, 'Rules') as rules, + json_extract_path_text(Properties, 'VisibilityConfig') as visibility_config, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'LabelNamespace') as label_namespace, + json_extract_path_text(Properties, 'CustomResponseBodies') as custom_response_bodies, + json_extract_path_text(Properties, 'AvailableLabels') as available_labels, + json_extract_path_text(Properties, 'ConsumedLabels') as consumed_labels + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::WAFv2::RuleGroup' + AND data__Identifier = '||' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Scope') as scope + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::WAFv2::RuleGroup' + AND region = 'us-east-1' web_acls: name: web_acls id: aws.wafv2.web_acls @@ -3120,7 +3066,7 @@ components: - Name - Id - Scope - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3137,9 +3083,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3149,47 +3095,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/web_acls/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/web_acls/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Name') as name, - JSON_EXTRACT(Properties, '$.Id') as id, - JSON_EXTRACT(Properties, '$.Scope') as scope - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::WAFv2::WebACL' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Scope') as scope - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::WAFv2::WebACL' - AND region = 'us-east-1' - web_acl: - name: web_acl - id: aws.wafv2.web_acl - x-cfn-schema-name: WebACL - x-cfn-type-name: AWS::WAFv2::WebACL - x-identifiers: - - Name - - Id - - Scope - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3200,12 +3108,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/web_acls/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/web_acls/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/web_acl/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/web_acls/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3230,30 +3142,50 @@ components: AND data__Identifier = '||' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'Capacity') as capacity, - json_extract_path_text(Properties, 'DefaultAction') as default_action, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Scope') as scope, - json_extract_path_text(Properties, 'Rules') as rules, - json_extract_path_text(Properties, 'VisibilityConfig') as visibility_config, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'LabelNamespace') as label_namespace, - json_extract_path_text(Properties, 'CustomResponseBodies') as custom_response_bodies, - json_extract_path_text(Properties, 'CaptchaConfig') as captcha_config, - json_extract_path_text(Properties, 'ChallengeConfig') as challenge_config, - json_extract_path_text(Properties, 'TokenDomains') as token_domains, - json_extract_path_text(Properties, 'AssociationConfig') as association_config - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::WAFv2::WebACL' - AND data__Identifier = '||' + JSON_EXTRACT(Properties, '$.Name') as name, + JSON_EXTRACT(Properties, '$.Id') as id, + JSON_EXTRACT(Properties, '$.Scope') as scope + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::WAFv2::WebACL' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'Capacity') as capacity, + json_extract_path_text(Properties, 'DefaultAction') as default_action, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Scope') as scope, + json_extract_path_text(Properties, 'Rules') as rules, + json_extract_path_text(Properties, 'VisibilityConfig') as visibility_config, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'LabelNamespace') as label_namespace, + json_extract_path_text(Properties, 'CustomResponseBodies') as custom_response_bodies, + json_extract_path_text(Properties, 'CaptchaConfig') as captcha_config, + json_extract_path_text(Properties, 'ChallengeConfig') as challenge_config, + json_extract_path_text(Properties, 'TokenDomains') as token_domains, + json_extract_path_text(Properties, 'AssociationConfig') as association_config + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::WAFv2::WebACL' + AND data__Identifier = '||' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Scope') as scope + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::WAFv2::WebACL' + AND region = 'us-east-1' webacl_associations: name: webacl_associations id: aws.wafv2.webacl_associations @@ -3262,7 +3194,7 @@ components: x-identifiers: - ResourceArn - WebACLArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -3279,9 +3211,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3291,24 +3223,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/webacl_associations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/webacl_associations/methods/delete_resource' - webacl_association: - name: webacl_association - id: aws.wafv2.webacl_association - x-cfn-schema-name: WebACLAssociation - x-cfn-type-name: AWS::WAFv2::WebACLAssociation - x-identifiers: - - ResourceArn - - WebACLArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -3319,12 +3236,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/webacl_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/webacl_associations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/webacl_association/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/webacl_associations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -3335,7 +3256,7 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, diff --git a/providers/src/aws/v00.00.00000/services/wisdom.yaml b/providers/src/aws/v00.00.00000/services/wisdom.yaml index 379b94f4..c7b87bfe 100644 --- a/providers/src/aws/v00.00.00000/services/wisdom.yaml +++ b/providers/src/aws/v00.00.00000/services/wisdom.yaml @@ -816,7 +816,7 @@ components: x-cfn-type-name: AWS::Wisdom::Assistant x-identifiers: - AssistantId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -833,9 +833,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -845,41 +845,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/assistants/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/assistants/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AssistantId') as assistant_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Wisdom::Assistant' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AssistantId') as assistant_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Wisdom::Assistant' - AND region = 'us-east-1' - assistant: - name: assistant - id: aws.wisdom.assistant - x-cfn-schema-name: Assistant - x-cfn-type-name: AWS::Wisdom::Assistant - x-identifiers: - - AssistantId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -890,12 +858,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/assistants/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/assistants/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/assistant/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/assistants/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -911,21 +883,37 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Type') as type, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'AssistantArn') as assistant_arn, - json_extract_path_text(Properties, 'AssistantId') as assistant_id, - json_extract_path_text(Properties, 'ServerSideEncryptionConfiguration') as server_side_encryption_configuration, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'Name') as name - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Wisdom::Assistant' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.AssistantId') as assistant_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Wisdom::Assistant' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Type') as type, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'AssistantArn') as assistant_arn, + json_extract_path_text(Properties, 'AssistantId') as assistant_id, + json_extract_path_text(Properties, 'ServerSideEncryptionConfiguration') as server_side_encryption_configuration, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'Name') as name + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Wisdom::Assistant' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AssistantId') as assistant_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Wisdom::Assistant' + AND region = 'us-east-1' assistant_associations: name: assistant_associations id: aws.wisdom.assistant_associations @@ -934,7 +922,7 @@ components: x-identifiers: - AssistantAssociationId - AssistantId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -951,9 +939,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -963,44 +951,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/assistant_associations/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/assistant_associations/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.AssistantAssociationId') as assistant_association_id, - JSON_EXTRACT(Properties, '$.AssistantId') as assistant_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Wisdom::AssistantAssociation' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'AssistantAssociationId') as assistant_association_id, - json_extract_path_text(Properties, 'AssistantId') as assistant_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Wisdom::AssistantAssociation' - AND region = 'us-east-1' - assistant_association: - name: assistant_association - id: aws.wisdom.assistant_association - x-cfn-schema-name: AssistantAssociation - x-cfn-type-name: AWS::Wisdom::AssistantAssociation - x-identifiers: - - AssistantAssociationId - - AssistantId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1011,12 +964,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/assistant_associations/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/assistant_associations/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/assistant_association/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/assistant_associations/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1032,21 +989,39 @@ components: AND data__Identifier = '|' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AssistantAssociationArn') as assistant_association_arn, - json_extract_path_text(Properties, 'AssistantArn') as assistant_arn, - json_extract_path_text(Properties, 'AssistantAssociationId') as assistant_association_id, - json_extract_path_text(Properties, 'AssistantId') as assistant_id, - json_extract_path_text(Properties, 'Association') as association, - json_extract_path_text(Properties, 'AssociationType') as association_type, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Wisdom::AssistantAssociation' - AND data__Identifier = '|' + JSON_EXTRACT(Properties, '$.AssistantAssociationId') as assistant_association_id, + JSON_EXTRACT(Properties, '$.AssistantId') as assistant_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Wisdom::AssistantAssociation' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AssistantAssociationArn') as assistant_association_arn, + json_extract_path_text(Properties, 'AssistantArn') as assistant_arn, + json_extract_path_text(Properties, 'AssistantAssociationId') as assistant_association_id, + json_extract_path_text(Properties, 'AssistantId') as assistant_id, + json_extract_path_text(Properties, 'Association') as association, + json_extract_path_text(Properties, 'AssociationType') as association_type, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Wisdom::AssistantAssociation' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'AssistantAssociationId') as assistant_association_id, + json_extract_path_text(Properties, 'AssistantId') as assistant_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Wisdom::AssistantAssociation' + AND region = 'us-east-1' knowledge_bases: name: knowledge_bases id: aws.wisdom.knowledge_bases @@ -1054,7 +1029,7 @@ components: x-cfn-type-name: AWS::Wisdom::KnowledgeBase x-identifiers: - KnowledgeBaseId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1071,9 +1046,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1083,41 +1058,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/knowledge_bases/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/knowledge_bases/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.KnowledgeBaseId') as knowledge_base_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Wisdom::KnowledgeBase' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'KnowledgeBaseId') as knowledge_base_id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Wisdom::KnowledgeBase' - AND region = 'us-east-1' - knowledge_base: - name: knowledge_base - id: aws.wisdom.knowledge_base - x-cfn-schema-name: KnowledgeBase - x-cfn-type-name: AWS::Wisdom::KnowledgeBase - x-identifiers: - - KnowledgeBaseId - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1128,12 +1071,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/knowledge_bases/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/knowledge_bases/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/knowledge_base/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/knowledge_bases/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1151,23 +1098,39 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'KnowledgeBaseArn') as knowledge_base_arn, - json_extract_path_text(Properties, 'KnowledgeBaseId') as knowledge_base_id, - json_extract_path_text(Properties, 'KnowledgeBaseType') as knowledge_base_type, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'RenderingConfiguration') as rendering_configuration, - json_extract_path_text(Properties, 'ServerSideEncryptionConfiguration') as server_side_encryption_configuration, - json_extract_path_text(Properties, 'SourceConfiguration') as source_configuration, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Wisdom::KnowledgeBase' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.KnowledgeBaseId') as knowledge_base_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Wisdom::KnowledgeBase' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'KnowledgeBaseArn') as knowledge_base_arn, + json_extract_path_text(Properties, 'KnowledgeBaseId') as knowledge_base_id, + json_extract_path_text(Properties, 'KnowledgeBaseType') as knowledge_base_type, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'RenderingConfiguration') as rendering_configuration, + json_extract_path_text(Properties, 'ServerSideEncryptionConfiguration') as server_side_encryption_configuration, + json_extract_path_text(Properties, 'SourceConfiguration') as source_configuration, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::Wisdom::KnowledgeBase' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'KnowledgeBaseId') as knowledge_base_id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Wisdom::KnowledgeBase' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/workspaces.yaml b/providers/src/aws/v00.00.00000/services/workspaces.yaml index 06dd5c8b..1a368eb7 100644 --- a/providers/src/aws/v00.00.00000/services/workspaces.yaml +++ b/providers/src/aws/v00.00.00000/services/workspaces.yaml @@ -532,7 +532,7 @@ components: x-cfn-type-name: AWS::WorkSpaces::ConnectionAlias x-identifiers: - AliasId - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -566,21 +566,11 @@ components: - $ref: '#/components/x-stackQL-resources/connection_aliases/methods/create_resource' delete: - $ref: '#/components/x-stackQL-resources/connection_aliases/methods/delete_resource' - connection_alias: - name: connection_alias - id: aws.workspaces.connection_alias - x-cfn-schema-name: ConnectionAlias - x-cfn-type-name: AWS::WorkSpaces::ConnectionAlias - x-identifiers: - - AliasId - x-type: get - methods: {} - sqlVerbs: update: [] config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -594,7 +584,7 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, diff --git a/providers/src/aws/v00.00.00000/services/workspacesthinclient.yaml b/providers/src/aws/v00.00.00000/services/workspacesthinclient.yaml index 08b8288c..f586f182 100644 --- a/providers/src/aws/v00.00.00000/services/workspacesthinclient.yaml +++ b/providers/src/aws/v00.00.00000/services/workspacesthinclient.yaml @@ -553,7 +553,7 @@ components: maxLength: 2048 Tags: type: array - maxItems: 20 + maxItems: 50 uniqueItems: true x-insertionOrder: false description: An array of key-value pairs to apply to this resource. @@ -611,10 +611,9 @@ components: - workspaces-web:GetPortal - workspaces-web:GetUserSettings - thinclient:UpdateEnvironment - - thinclient:GetEnvironment + - thinclient:ListTagsForResource - thinclient:TagResource - thinclient:UntagResource - - thinclient:ListTagsForResource - kms:Decrypt - kms:GenerateDataKey delete: @@ -729,7 +728,7 @@ components: maxLength: 2048 Tags: type: array - maxItems: 20 + maxItems: 50 uniqueItems: true x-insertionOrder: false description: An array of key-value pairs to apply to this resource. @@ -754,7 +753,7 @@ components: x-cfn-type-name: AWS::WorkSpacesThinClient::Environment x-identifiers: - Id - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -771,9 +770,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -783,41 +782,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/environments/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/environments/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::WorkSpacesThinClient::Environment' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'Id') as id - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::WorkSpacesThinClient::Environment' - AND region = 'us-east-1' - environment: - name: environment - id: aws.workspacesthinclient.environment - x-cfn-schema-name: Environment - x-cfn-type-name: AWS::WorkSpacesThinClient::Environment - x-identifiers: - - Id - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -828,12 +795,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/environments/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/environments/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/environment/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/environments/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -861,33 +832,49 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'Id') as id, - json_extract_path_text(Properties, 'Name') as name, - json_extract_path_text(Properties, 'DesktopArn') as desktop_arn, - json_extract_path_text(Properties, 'DesktopEndpoint') as desktop_endpoint, - json_extract_path_text(Properties, 'DesktopType') as desktop_type, - json_extract_path_text(Properties, 'ActivationCode') as activation_code, - json_extract_path_text(Properties, 'RegisteredDevicesCount') as registered_devices_count, - json_extract_path_text(Properties, 'SoftwareSetUpdateSchedule') as software_set_update_schedule, - json_extract_path_text(Properties, 'MaintenanceWindow') as maintenance_window, - json_extract_path_text(Properties, 'SoftwareSetUpdateMode') as software_set_update_mode, - json_extract_path_text(Properties, 'DesiredSoftwareSetId') as desired_software_set_id, - json_extract_path_text(Properties, 'PendingSoftwareSetId') as pending_software_set_id, - json_extract_path_text(Properties, 'PendingSoftwareSetVersion') as pending_software_set_version, - json_extract_path_text(Properties, 'SoftwareSetComplianceStatus') as software_set_compliance_status, - json_extract_path_text(Properties, 'CreatedAt') as created_at, - json_extract_path_text(Properties, 'UpdatedAt') as updated_at, - json_extract_path_text(Properties, 'Arn') as arn, - json_extract_path_text(Properties, 'KmsKeyArn') as kms_key_arn, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::WorkSpacesThinClient::Environment' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::WorkSpacesThinClient::Environment' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'Id') as id, + json_extract_path_text(Properties, 'Name') as name, + json_extract_path_text(Properties, 'DesktopArn') as desktop_arn, + json_extract_path_text(Properties, 'DesktopEndpoint') as desktop_endpoint, + json_extract_path_text(Properties, 'DesktopType') as desktop_type, + json_extract_path_text(Properties, 'ActivationCode') as activation_code, + json_extract_path_text(Properties, 'RegisteredDevicesCount') as registered_devices_count, + json_extract_path_text(Properties, 'SoftwareSetUpdateSchedule') as software_set_update_schedule, + json_extract_path_text(Properties, 'MaintenanceWindow') as maintenance_window, + json_extract_path_text(Properties, 'SoftwareSetUpdateMode') as software_set_update_mode, + json_extract_path_text(Properties, 'DesiredSoftwareSetId') as desired_software_set_id, + json_extract_path_text(Properties, 'PendingSoftwareSetId') as pending_software_set_id, + json_extract_path_text(Properties, 'PendingSoftwareSetVersion') as pending_software_set_version, + json_extract_path_text(Properties, 'SoftwareSetComplianceStatus') as software_set_compliance_status, + json_extract_path_text(Properties, 'CreatedAt') as created_at, + json_extract_path_text(Properties, 'UpdatedAt') as updated_at, + json_extract_path_text(Properties, 'Arn') as arn, + json_extract_path_text(Properties, 'KmsKeyArn') as kms_key_arn, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::WorkSpacesThinClient::Environment' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'Id') as id + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::WorkSpacesThinClient::Environment' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/workspacesweb.yaml b/providers/src/aws/v00.00.00000/services/workspacesweb.yaml index 4d1b4b84..7c9c8f19 100644 --- a/providers/src/aws/v00.00.00000/services/workspacesweb.yaml +++ b/providers/src/aws/v00.00.00000/services/workspacesweb.yaml @@ -454,9 +454,6 @@ components: x-create-only-properties: - AdditionalEncryptionContext - CustomerManagedKey - x-write-only-properties: - - AdditionalEncryptionContext - - CustomerManagedKey x-read-only-properties: - AssociatedPortalArns - BrowserSettingsArn @@ -665,9 +662,6 @@ components: x-create-only-properties: - AdditionalEncryptionContext - CustomerManagedKey - x-write-only-properties: - - AdditionalEncryptionContext - - CustomerManagedKey x-read-only-properties: - AssociatedPortalArns - CreationDate @@ -820,6 +814,12 @@ components: type: string enum: - Chrome + InstanceType: + type: string + enum: + - standard.regular + - standard.large + - standard.xlarge PortalStatus: type: string enum: @@ -857,11 +857,17 @@ components: maxLength: 64 minLength: 1 pattern: ^.+$ + InstanceType: + $ref: '#/components/schemas/InstanceType' IpAccessSettingsArn: type: string maxLength: 2048 minLength: 20 pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ + MaxConcurrentSessions: + type: number + maximum: 5000 + minimum: 1 NetworkSettingsArn: type: string maxLength: 2048 @@ -921,9 +927,6 @@ components: x-create-only-properties: - AdditionalEncryptionContext - CustomerManagedKey - x-write-only-properties: - - AdditionalEncryptionContext - - CustomerManagedKey x-read-only-properties: - BrowserType - CreationDate @@ -1274,9 +1277,6 @@ components: x-create-only-properties: - AdditionalEncryptionContext - CustomerManagedKey - x-write-only-properties: - - AdditionalEncryptionContext - - CustomerManagedKey x-read-only-properties: - AssociatedPortalArns - UserSettingsArn @@ -1580,11 +1580,17 @@ components: maxLength: 64 minLength: 1 pattern: ^.+$ + InstanceType: + $ref: '#/components/schemas/InstanceType' IpAccessSettingsArn: type: string maxLength: 2048 minLength: 20 pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$ + MaxConcurrentSessions: + type: number + maximum: 5000 + minimum: 1 NetworkSettingsArn: type: string maxLength: 2048 @@ -1806,8 +1812,23 @@ components: x-cfn-type-name: AWS::WorkSpacesWeb::BrowserSettings x-identifiers: - BrowserSettingsArn - x-type: get + x-type: cloud_control methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__BrowserSettings&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WorkSpacesWeb::BrowserSettings" + } + response: + mediaType: application/json + openAPIDocKey: '200' update_resource: operation: $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' @@ -1820,13 +1841,29 @@ components: response: mediaType: application/json openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WorkSpacesWeb::BrowserSettings" + } + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/browser_settings/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/browser_settings/methods/delete_resource' update: - $ref: '#/components/x-stackQL-resources/browser_settings/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1841,20 +1878,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AdditionalEncryptionContext') as additional_encryption_context, - json_extract_path_text(Properties, 'AssociatedPortalArns') as associated_portal_arns, - json_extract_path_text(Properties, 'BrowserPolicy') as browser_policy, - json_extract_path_text(Properties, 'BrowserSettingsArn') as browser_settings_arn, - json_extract_path_text(Properties, 'CustomerManagedKey') as customer_managed_key, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::WorkSpacesWeb::BrowserSettings' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.BrowserSettingsArn') as browser_settings_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::WorkSpacesWeb::BrowserSettings' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AdditionalEncryptionContext') as additional_encryption_context, + json_extract_path_text(Properties, 'AssociatedPortalArns') as associated_portal_arns, + json_extract_path_text(Properties, 'BrowserPolicy') as browser_policy, + json_extract_path_text(Properties, 'BrowserSettingsArn') as browser_settings_arn, + json_extract_path_text(Properties, 'CustomerManagedKey') as customer_managed_key, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::WorkSpacesWeb::BrowserSettings' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'BrowserSettingsArn') as browser_settings_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::WorkSpacesWeb::BrowserSettings' + AND region = 'us-east-1' identity_providers: name: identity_providers id: aws.workspacesweb.identity_providers @@ -1862,7 +1915,7 @@ components: x-cfn-type-name: AWS::WorkSpacesWeb::IdentityProvider x-identifiers: - IdentityProviderArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -1879,9 +1932,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1891,41 +1944,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/identity_providers/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/identity_providers/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.IdentityProviderArn') as identity_provider_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::WorkSpacesWeb::IdentityProvider' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'IdentityProviderArn') as identity_provider_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::WorkSpacesWeb::IdentityProvider' - AND region = 'us-east-1' - identity_provider: - name: identity_provider - id: aws.workspacesweb.identity_provider - x-cfn-schema-name: IdentityProvider - x-cfn-type-name: AWS::WorkSpacesWeb::IdentityProvider - x-identifiers: - - IdentityProviderArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1936,12 +1957,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/identity_providers/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/identity_providers/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/identity_provider/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/identity_providers/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1955,19 +1980,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'IdentityProviderArn') as identity_provider_arn, - json_extract_path_text(Properties, 'IdentityProviderDetails') as identity_provider_details, - json_extract_path_text(Properties, 'IdentityProviderName') as identity_provider_name, - json_extract_path_text(Properties, 'IdentityProviderType') as identity_provider_type, - json_extract_path_text(Properties, 'PortalArn') as portal_arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::WorkSpacesWeb::IdentityProvider' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.IdentityProviderArn') as identity_provider_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::WorkSpacesWeb::IdentityProvider' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'IdentityProviderArn') as identity_provider_arn, + json_extract_path_text(Properties, 'IdentityProviderDetails') as identity_provider_details, + json_extract_path_text(Properties, 'IdentityProviderName') as identity_provider_name, + json_extract_path_text(Properties, 'IdentityProviderType') as identity_provider_type, + json_extract_path_text(Properties, 'PortalArn') as portal_arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::WorkSpacesWeb::IdentityProvider' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'IdentityProviderArn') as identity_provider_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::WorkSpacesWeb::IdentityProvider' + AND region = 'us-east-1' ip_access_settings: name: ip_access_settings id: aws.workspacesweb.ip_access_settings @@ -1975,8 +2016,23 @@ components: x-cfn-type-name: AWS::WorkSpacesWeb::IpAccessSettings x-identifiers: - IpAccessSettingsArn - x-type: get + x-type: cloud_control methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__IpAccessSettings&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WorkSpacesWeb::IpAccessSettings" + } + response: + mediaType: application/json + openAPIDocKey: '200' update_resource: operation: $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' @@ -1989,13 +2045,29 @@ components: response: mediaType: application/json openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WorkSpacesWeb::IpAccessSettings" + } + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/ip_access_settings/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/ip_access_settings/methods/delete_resource' update: - $ref: '#/components/x-stackQL-resources/ip_access_settings/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2013,23 +2085,39 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AdditionalEncryptionContext') as additional_encryption_context, - json_extract_path_text(Properties, 'AssociatedPortalArns') as associated_portal_arns, - json_extract_path_text(Properties, 'CreationDate') as creation_date, - json_extract_path_text(Properties, 'CustomerManagedKey') as customer_managed_key, - json_extract_path_text(Properties, 'Description') as description, - json_extract_path_text(Properties, 'DisplayName') as display_name, - json_extract_path_text(Properties, 'IpAccessSettingsArn') as ip_access_settings_arn, - json_extract_path_text(Properties, 'IpRules') as ip_rules, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::WorkSpacesWeb::IpAccessSettings' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.IpAccessSettingsArn') as ip_access_settings_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::WorkSpacesWeb::IpAccessSettings' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AdditionalEncryptionContext') as additional_encryption_context, + json_extract_path_text(Properties, 'AssociatedPortalArns') as associated_portal_arns, + json_extract_path_text(Properties, 'CreationDate') as creation_date, + json_extract_path_text(Properties, 'CustomerManagedKey') as customer_managed_key, + json_extract_path_text(Properties, 'Description') as description, + json_extract_path_text(Properties, 'DisplayName') as display_name, + json_extract_path_text(Properties, 'IpAccessSettingsArn') as ip_access_settings_arn, + json_extract_path_text(Properties, 'IpRules') as ip_rules, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::WorkSpacesWeb::IpAccessSettings' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'IpAccessSettingsArn') as ip_access_settings_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::WorkSpacesWeb::IpAccessSettings' + AND region = 'us-east-1' network_settings: name: network_settings id: aws.workspacesweb.network_settings @@ -2037,8 +2125,23 @@ components: x-cfn-type-name: AWS::WorkSpacesWeb::NetworkSettings x-identifiers: - NetworkSettingsArn - x-type: get + x-type: cloud_control methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__NetworkSettings&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WorkSpacesWeb::NetworkSettings" + } + response: + mediaType: application/json + openAPIDocKey: '200' update_resource: operation: $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' @@ -2051,13 +2154,29 @@ components: response: mediaType: application/json openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WorkSpacesWeb::NetworkSettings" + } + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/network_settings/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/network_settings/methods/delete_resource' update: - $ref: '#/components/x-stackQL-resources/network_settings/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2072,20 +2191,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AssociatedPortalArns') as associated_portal_arns, - json_extract_path_text(Properties, 'NetworkSettingsArn') as network_settings_arn, - json_extract_path_text(Properties, 'SecurityGroupIds') as security_group_ids, - json_extract_path_text(Properties, 'SubnetIds') as subnet_ids, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'VpcId') as vpc_id - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::WorkSpacesWeb::NetworkSettings' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.NetworkSettingsArn') as network_settings_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::WorkSpacesWeb::NetworkSettings' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AssociatedPortalArns') as associated_portal_arns, + json_extract_path_text(Properties, 'NetworkSettingsArn') as network_settings_arn, + json_extract_path_text(Properties, 'SecurityGroupIds') as security_group_ids, + json_extract_path_text(Properties, 'SubnetIds') as subnet_ids, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'VpcId') as vpc_id + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::WorkSpacesWeb::NetworkSettings' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'NetworkSettingsArn') as network_settings_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::WorkSpacesWeb::NetworkSettings' + AND region = 'us-east-1' portals: name: portals id: aws.workspacesweb.portals @@ -2093,7 +2228,7 @@ components: x-cfn-type-name: AWS::WorkSpacesWeb::Portal x-identifiers: - PortalArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2110,9 +2245,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2122,41 +2257,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/portals/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/portals/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.PortalArn') as portal_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::WorkSpacesWeb::Portal' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'PortalArn') as portal_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::WorkSpacesWeb::Portal' - AND region = 'us-east-1' - portal: - name: portal - id: aws.workspacesweb.portal - x-cfn-schema-name: Portal - x-cfn-type-name: AWS::WorkSpacesWeb::Portal - x-identifiers: - - PortalArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2167,12 +2270,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/portals/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/portals/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/portal/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/portals/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2184,7 +2291,9 @@ components: JSON_EXTRACT(Properties, '$.CreationDate') as creation_date, JSON_EXTRACT(Properties, '$.CustomerManagedKey') as customer_managed_key, JSON_EXTRACT(Properties, '$.DisplayName') as display_name, + JSON_EXTRACT(Properties, '$.InstanceType') as instance_type, JSON_EXTRACT(Properties, '$.IpAccessSettingsArn') as ip_access_settings_arn, + JSON_EXTRACT(Properties, '$.MaxConcurrentSessions') as max_concurrent_sessions, JSON_EXTRACT(Properties, '$.NetworkSettingsArn') as network_settings_arn, JSON_EXTRACT(Properties, '$.PortalArn') as portal_arn, JSON_EXTRACT(Properties, '$.PortalEndpoint') as portal_endpoint, @@ -2200,33 +2309,51 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AdditionalEncryptionContext') as additional_encryption_context, - json_extract_path_text(Properties, 'AuthenticationType') as authentication_type, - json_extract_path_text(Properties, 'BrowserSettingsArn') as browser_settings_arn, - json_extract_path_text(Properties, 'BrowserType') as browser_type, - json_extract_path_text(Properties, 'CreationDate') as creation_date, - json_extract_path_text(Properties, 'CustomerManagedKey') as customer_managed_key, - json_extract_path_text(Properties, 'DisplayName') as display_name, - json_extract_path_text(Properties, 'IpAccessSettingsArn') as ip_access_settings_arn, - json_extract_path_text(Properties, 'NetworkSettingsArn') as network_settings_arn, - json_extract_path_text(Properties, 'PortalArn') as portal_arn, - json_extract_path_text(Properties, 'PortalEndpoint') as portal_endpoint, - json_extract_path_text(Properties, 'PortalStatus') as portal_status, - json_extract_path_text(Properties, 'RendererType') as renderer_type, - json_extract_path_text(Properties, 'ServiceProviderSamlMetadata') as service_provider_saml_metadata, - json_extract_path_text(Properties, 'StatusReason') as status_reason, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'TrustStoreArn') as trust_store_arn, - json_extract_path_text(Properties, 'UserAccessLoggingSettingsArn') as user_access_logging_settings_arn, - json_extract_path_text(Properties, 'UserSettingsArn') as user_settings_arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::WorkSpacesWeb::Portal' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.PortalArn') as portal_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::WorkSpacesWeb::Portal' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AdditionalEncryptionContext') as additional_encryption_context, + json_extract_path_text(Properties, 'AuthenticationType') as authentication_type, + json_extract_path_text(Properties, 'BrowserSettingsArn') as browser_settings_arn, + json_extract_path_text(Properties, 'BrowserType') as browser_type, + json_extract_path_text(Properties, 'CreationDate') as creation_date, + json_extract_path_text(Properties, 'CustomerManagedKey') as customer_managed_key, + json_extract_path_text(Properties, 'DisplayName') as display_name, + json_extract_path_text(Properties, 'InstanceType') as instance_type, + json_extract_path_text(Properties, 'IpAccessSettingsArn') as ip_access_settings_arn, + json_extract_path_text(Properties, 'MaxConcurrentSessions') as max_concurrent_sessions, + json_extract_path_text(Properties, 'NetworkSettingsArn') as network_settings_arn, + json_extract_path_text(Properties, 'PortalArn') as portal_arn, + json_extract_path_text(Properties, 'PortalEndpoint') as portal_endpoint, + json_extract_path_text(Properties, 'PortalStatus') as portal_status, + json_extract_path_text(Properties, 'RendererType') as renderer_type, + json_extract_path_text(Properties, 'ServiceProviderSamlMetadata') as service_provider_saml_metadata, + json_extract_path_text(Properties, 'StatusReason') as status_reason, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'TrustStoreArn') as trust_store_arn, + json_extract_path_text(Properties, 'UserAccessLoggingSettingsArn') as user_access_logging_settings_arn, + json_extract_path_text(Properties, 'UserSettingsArn') as user_settings_arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::WorkSpacesWeb::Portal' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'PortalArn') as portal_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::WorkSpacesWeb::Portal' + AND region = 'us-east-1' trust_stores: name: trust_stores id: aws.workspacesweb.trust_stores @@ -2234,7 +2361,7 @@ components: x-cfn-type-name: AWS::WorkSpacesWeb::TrustStore x-identifiers: - TrustStoreArn - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -2251,9 +2378,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2263,41 +2390,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/trust_stores/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/trust_stores/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.TrustStoreArn') as trust_store_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::WorkSpacesWeb::TrustStore' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'TrustStoreArn') as trust_store_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::WorkSpacesWeb::TrustStore' - AND region = 'us-east-1' - trust_store: - name: trust_store - id: aws.workspacesweb.trust_store - x-cfn-schema-name: TrustStore - x-cfn-type-name: AWS::WorkSpacesWeb::TrustStore - x-identifiers: - - TrustStoreArn - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -2308,12 +2403,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/trust_stores/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/trust_stores/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/trust_store/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/trust_stores/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2326,18 +2425,34 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AssociatedPortalArns') as associated_portal_arns, - json_extract_path_text(Properties, 'CertificateList') as certificate_list, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'TrustStoreArn') as trust_store_arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::WorkSpacesWeb::TrustStore' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.TrustStoreArn') as trust_store_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::WorkSpacesWeb::TrustStore' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AssociatedPortalArns') as associated_portal_arns, + json_extract_path_text(Properties, 'CertificateList') as certificate_list, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'TrustStoreArn') as trust_store_arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::WorkSpacesWeb::TrustStore' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'TrustStoreArn') as trust_store_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::WorkSpacesWeb::TrustStore' + AND region = 'us-east-1' user_access_logging_settings: name: user_access_logging_settings id: aws.workspacesweb.user_access_logging_settings @@ -2345,8 +2460,23 @@ components: x-cfn-type-name: AWS::WorkSpacesWeb::UserAccessLoggingSettings x-identifiers: - UserAccessLoggingSettingsArn - x-type: get + x-type: cloud_control methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__UserAccessLoggingSettings&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WorkSpacesWeb::UserAccessLoggingSettings" + } + response: + mediaType: application/json + openAPIDocKey: '200' update_resource: operation: $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' @@ -2359,13 +2489,29 @@ components: response: mediaType: application/json openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WorkSpacesWeb::UserAccessLoggingSettings" + } + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/user_access_logging_settings/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/user_access_logging_settings/methods/delete_resource' update: - $ref: '#/components/x-stackQL-resources/user_access_logging_settings/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2378,18 +2524,34 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AssociatedPortalArns') as associated_portal_arns, - json_extract_path_text(Properties, 'KinesisStreamArn') as kinesis_stream_arn, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'UserAccessLoggingSettingsArn') as user_access_logging_settings_arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::WorkSpacesWeb::UserAccessLoggingSettings' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.UserAccessLoggingSettingsArn') as user_access_logging_settings_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::WorkSpacesWeb::UserAccessLoggingSettings' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AssociatedPortalArns') as associated_portal_arns, + json_extract_path_text(Properties, 'KinesisStreamArn') as kinesis_stream_arn, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'UserAccessLoggingSettingsArn') as user_access_logging_settings_arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::WorkSpacesWeb::UserAccessLoggingSettings' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'UserAccessLoggingSettingsArn') as user_access_logging_settings_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::WorkSpacesWeb::UserAccessLoggingSettings' + AND region = 'us-east-1' user_settings: name: user_settings id: aws.workspacesweb.user_settings @@ -2397,8 +2559,23 @@ components: x-cfn-type-name: AWS::WorkSpacesWeb::UserSettings x-identifiers: - UserSettingsArn - x-type: get + x-type: cloud_control methods: + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__UserSettings&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WorkSpacesWeb::UserSettings" + } + response: + mediaType: application/json + openAPIDocKey: '200' update_resource: operation: $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' @@ -2411,13 +2588,29 @@ components: response: mediaType: application/json openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::WorkSpacesWeb::UserSettings" + } + response: + mediaType: application/json + openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/user_settings/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/user_settings/methods/delete_resource' update: - $ref: '#/components/x-stackQL-resources/user_settings/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -2439,27 +2632,43 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'AdditionalEncryptionContext') as additional_encryption_context, - json_extract_path_text(Properties, 'AssociatedPortalArns') as associated_portal_arns, - json_extract_path_text(Properties, 'CookieSynchronizationConfiguration') as cookie_synchronization_configuration, - json_extract_path_text(Properties, 'CopyAllowed') as copy_allowed, - json_extract_path_text(Properties, 'CustomerManagedKey') as customer_managed_key, - json_extract_path_text(Properties, 'DisconnectTimeoutInMinutes') as disconnect_timeout_in_minutes, - json_extract_path_text(Properties, 'DownloadAllowed') as download_allowed, - json_extract_path_text(Properties, 'IdleDisconnectTimeoutInMinutes') as idle_disconnect_timeout_in_minutes, - json_extract_path_text(Properties, 'PasteAllowed') as paste_allowed, - json_extract_path_text(Properties, 'PrintAllowed') as print_allowed, - json_extract_path_text(Properties, 'Tags') as tags, - json_extract_path_text(Properties, 'UploadAllowed') as upload_allowed, - json_extract_path_text(Properties, 'UserSettingsArn') as user_settings_arn - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::WorkSpacesWeb::UserSettings' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.UserSettingsArn') as user_settings_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::WorkSpacesWeb::UserSettings' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'AdditionalEncryptionContext') as additional_encryption_context, + json_extract_path_text(Properties, 'AssociatedPortalArns') as associated_portal_arns, + json_extract_path_text(Properties, 'CookieSynchronizationConfiguration') as cookie_synchronization_configuration, + json_extract_path_text(Properties, 'CopyAllowed') as copy_allowed, + json_extract_path_text(Properties, 'CustomerManagedKey') as customer_managed_key, + json_extract_path_text(Properties, 'DisconnectTimeoutInMinutes') as disconnect_timeout_in_minutes, + json_extract_path_text(Properties, 'DownloadAllowed') as download_allowed, + json_extract_path_text(Properties, 'IdleDisconnectTimeoutInMinutes') as idle_disconnect_timeout_in_minutes, + json_extract_path_text(Properties, 'PasteAllowed') as paste_allowed, + json_extract_path_text(Properties, 'PrintAllowed') as print_allowed, + json_extract_path_text(Properties, 'Tags') as tags, + json_extract_path_text(Properties, 'UploadAllowed') as upload_allowed, + json_extract_path_text(Properties, 'UserSettingsArn') as user_settings_arn + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::WorkSpacesWeb::UserSettings' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'UserSettingsArn') as user_settings_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::WorkSpacesWeb::UserSettings' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/xray.yaml b/providers/src/aws/v00.00.00000/services/xray.yaml index b46e8cbd..ae53caca 100644 --- a/providers/src/aws/v00.00.00000/services/xray.yaml +++ b/providers/src/aws/v00.00.00000/services/xray.yaml @@ -736,7 +736,7 @@ components: x-cfn-type-name: AWS::XRay::Group x-identifiers: - GroupARN - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -753,9 +753,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -765,41 +765,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/groups/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/groups/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.GroupARN') as group_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::XRay::Group' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'GroupARN') as group_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::XRay::Group' - AND region = 'us-east-1' - group: - name: group - id: aws.xray.group - x-cfn-schema-name: Group - x-cfn-type-name: AWS::XRay::Group - x-identifiers: - - GroupARN - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -810,12 +778,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/groups/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/groups/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/group/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/groups/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -829,19 +801,35 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'FilterExpression') as filter_expression, - json_extract_path_text(Properties, 'GroupName') as group_name, - json_extract_path_text(Properties, 'GroupARN') as group_arn, - json_extract_path_text(Properties, 'InsightsConfiguration') as insights_configuration, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::XRay::Group' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.GroupARN') as group_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::XRay::Group' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'FilterExpression') as filter_expression, + json_extract_path_text(Properties, 'GroupName') as group_name, + json_extract_path_text(Properties, 'GroupARN') as group_arn, + json_extract_path_text(Properties, 'InsightsConfiguration') as insights_configuration, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::XRay::Group' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'GroupARN') as group_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::XRay::Group' + AND region = 'us-east-1' resource_policies: name: resource_policies id: aws.xray.resource_policies @@ -849,7 +837,7 @@ components: x-cfn-type-name: AWS::XRay::ResourcePolicy x-identifiers: - PolicyName - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -866,9 +854,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -878,41 +866,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/resource_policies/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/resource_policies/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.PolicyName') as policy_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::XRay::ResourcePolicy' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'PolicyName') as policy_name - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::XRay::ResourcePolicy' - AND region = 'us-east-1' - resource_policy: - name: resource_policy - id: aws.xray.resource_policy - x-cfn-schema-name: ResourcePolicy - x-cfn-type-name: AWS::XRay::ResourcePolicy - x-identifiers: - - PolicyName - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -923,12 +879,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/resource_policies/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/resource_policies/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/resource_policy/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/resource_policies/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -940,17 +900,33 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'PolicyName') as policy_name, - json_extract_path_text(Properties, 'PolicyDocument') as policy_document, - json_extract_path_text(Properties, 'BypassPolicyLockoutCheck') as bypass_policy_lockout_check - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::XRay::ResourcePolicy' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.PolicyName') as policy_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::XRay::ResourcePolicy' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'PolicyName') as policy_name, + json_extract_path_text(Properties, 'PolicyDocument') as policy_document, + json_extract_path_text(Properties, 'BypassPolicyLockoutCheck') as bypass_policy_lockout_check + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::XRay::ResourcePolicy' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'PolicyName') as policy_name + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::XRay::ResourcePolicy' + AND region = 'us-east-1' sampling_rules: name: sampling_rules id: aws.xray.sampling_rules @@ -958,7 +934,7 @@ components: x-cfn-type-name: AWS::XRay::SamplingRule x-identifiers: - RuleARN - x-type: list + x-type: cloud_control methods: create_resource: config: @@ -975,9 +951,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - delete_resource: + update_resource: operation: - $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -987,41 +963,9 @@ components: response: mediaType: application/json openAPIDocKey: '200' - sqlVerbs: - insert: - - $ref: '#/components/x-stackQL-resources/sampling_rules/methods/create_resource' - delete: - - $ref: '#/components/x-stackQL-resources/sampling_rules/methods/delete_resource' - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - region, - JSON_EXTRACT(Properties, '$.RuleARN') as rule_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::XRay::SamplingRule' - AND region = 'us-east-1' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - region, - json_extract_path_text(Properties, 'RuleARN') as rule_arn - FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::XRay::SamplingRule' - AND region = 'us-east-1' - sampling_rule: - name: sampling_rule - id: aws.xray.sampling_rule - x-cfn-schema-name: SamplingRule - x-cfn-type-name: AWS::XRay::SamplingRule - x-identifiers: - - RuleARN - x-type: get - methods: - update_resource: + delete_resource: operation: - $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' request: mediaType: application/x-amz-json-1.0 base: |- @@ -1032,12 +976,16 @@ components: mediaType: application/json openAPIDocKey: '200' sqlVerbs: + insert: + - $ref: '#/components/x-stackQL-resources/sampling_rules/methods/create_resource' + delete: + - $ref: '#/components/x-stackQL-resources/sampling_rules/methods/delete_resource' update: - - $ref: '#/components/x-stackQL-resources/sampling_rule/methods/update_resource' + - $ref: '#/components/x-stackQL-resources/sampling_rules/methods/update_resource' config: views: select: - predicate: sqlDialect == "sqlite3" + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] ddl: |- SELECT region, @@ -1052,20 +1000,36 @@ components: AND data__Identifier = '' AND region = 'us-east-1' fallback: - predicate: sqlDialect == "postgres" + predicate: sqlDialect == "sqlite3" ddl: |- SELECT region, - data__Identifier, - json_extract_path_text(Properties, 'SamplingRule') as sampling_rule, - json_extract_path_text(Properties, 'SamplingRuleRecord') as sampling_rule_record, - json_extract_path_text(Properties, 'SamplingRuleUpdate') as sampling_rule_update, - json_extract_path_text(Properties, 'RuleARN') as rule_arn, - json_extract_path_text(Properties, 'RuleName') as rule_name, - json_extract_path_text(Properties, 'Tags') as tags - FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::XRay::SamplingRule' - AND data__Identifier = '' + JSON_EXTRACT(Properties, '$.RuleARN') as rule_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::XRay::SamplingRule' AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'SamplingRule') as sampling_rule, + json_extract_path_text(Properties, 'SamplingRuleRecord') as sampling_rule_record, + json_extract_path_text(Properties, 'SamplingRuleUpdate') as sampling_rule_update, + json_extract_path_text(Properties, 'RuleARN') as rule_arn, + json_extract_path_text(Properties, 'RuleName') as rule_name, + json_extract_path_text(Properties, 'Tags') as tags + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::XRay::SamplingRule' + AND data__Identifier = '' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + region, + json_extract_path_text(Properties, 'RuleARN') as rule_arn + FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::XRay::SamplingRule' + AND region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: From 264b4579a8b94d677cee5c0e66a060446b0d5e7c Mon Sep 17 00:00:00 2001 From: Jeffrey Aven Date: Thu, 6 Jun 2024 16:38:36 +1000 Subject: [PATCH 2/3] updated ci --- .github/workflows/main.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index e45438c2..60a0e02d 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -124,7 +124,7 @@ jobs: while IFS= read -r provider do echo "testing ${provider}..." - sh test-provider.sh $provider false $providersdir + sh test-provider.sh $provider false $providersdir true done < ../providers.txt # From 2b54c0aaa073f68afe6ded01107b30e584b3dc15 Mon Sep 17 00:00:00 2001 From: Jeffrey Aven Date: Tue, 11 Jun 2024 17:27:10 +0800 Subject: [PATCH 3/3] aws updates --- providers/src/aws/v00.00.00000/provider.yaml | 18 - .../aws/v00.00.00000/services/cloudwatch.yaml | 224 +- .../src/aws/v00.00.00000/services/ec2.yaml | 99 - .../aws/v00.00.00000/services/ec2_api.yaml | 80190 ---------------- .../src/aws/v00.00.00000/services/iam.yaml | 668 +- .../aws/v00.00.00000/services/route53.yaml | 66 +- .../src/aws/v00.00.00000/services/s3_api.yaml | 17160 ---- .../aws/v00.00.00000/services/transfer.yaml | 494 +- 8 files changed, 831 insertions(+), 98088 deletions(-) delete mode 100644 providers/src/aws/v00.00.00000/services/ec2_api.yaml delete mode 100644 providers/src/aws/v00.00.00000/services/s3_api.yaml diff --git a/providers/src/aws/v00.00.00000/provider.yaml b/providers/src/aws/v00.00.00000/provider.yaml index fd82f508..459c500e 100644 --- a/providers/src/aws/v00.00.00000/provider.yaml +++ b/providers/src/aws/v00.00.00000/provider.yaml @@ -1964,24 +1964,6 @@ providerServices: title: cloudhsm version: v00.00.00000 description: cloudhsm - ec2_api: - id: ec2_api:v00.00.00000 - name: ec2_api - preferred: true - service: - $ref: aws/v00.00.00000/services/ec2_api.yaml - title: ec2_api - version: v00.00.00000 - description: ec2_api - s3_api: - id: s3_api:v00.00.00000 - name: s3_api - preferred: true - service: - $ref: aws/v00.00.00000/services/s3_api.yaml - title: s3_api - version: v00.00.00000 - description: s3_api config: auth: type: aws_signing_v4 diff --git a/providers/src/aws/v00.00.00000/services/cloudwatch.yaml b/providers/src/aws/v00.00.00000/services/cloudwatch.yaml index a0dce82a..6c8a6941 100644 --- a/providers/src/aws/v00.00.00000/services/cloudwatch.yaml +++ b/providers/src/aws/v00.00.00000/services/cloudwatch.yaml @@ -1676,6 +1676,118 @@ components: description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: + log_events: + name: log_events + x-cfn-schema-name: OutputLogEvent + x-example-where-clause: WHERE region = 'us-east-1' AND data___logStreamName = '' + x-type: native + id: aws.cloudwatch.log_events + methods: + GetLogEvents: + serviceName: logs + operation: + $ref: '#/paths/~1?__X-Amz-Target=Logs_20140328.GetLogEvents&__nativeEndpoint=true/post' + request: + mediaType: application/json + response: + mediaType: application/json + objectKey: $.events + openAPIDocKey: '200' + sqlVerbs: + delete: [] + insert: [] + select: + - $ref: '#/components/x-stackQL-resources/log_events/methods/GetLogEvents' + update: [] + title: log_events + log_groups: + name: log_groups + x-cfn-schema-name: LogGroup + x-example-where-clause: WHERE region = 'us-east-1' + x-type: native + id: aws.cloudwatch.log_groups + methods: + DescribeLogGroups: + serviceName: logs + operation: + $ref: '#/paths/~1?__X-Amz-Target=Logs_20140328.DescribeLogGroups&__nativeEndpoint=true/post' + request: + mediaType: application/json + response: + mediaType: application/json + objectKey: $.logGroups + openAPIDocKey: '200' + DeleteLogGroup: + serviceName: logs + operation: + $ref: '#/paths/~1?__X-Amz-Target=Logs_20140328.DeleteLogGroup&__nativeEndpoint=true/post' + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + CreateLogGroup: + serviceName: logs + operation: + $ref: '#/paths/~1?__X-Amz-Target=Logs_20140328.CreateLogGroup&__nativeEndpoint=true/post' + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/log_groups/methods/DeleteLogGroup' + insert: + - $ref: '#/components/x-stackQL-resources/log_groups/methods/CreateLogGroup' + select: + - $ref: '#/components/x-stackQL-resources/log_groups/methods/DescribeLogGroups' + update: [] + title: log_groups + log_streams: + name: log_streams + x-cfn-schema-name: LogStream + x-example-where-clause: WHERE region = 'us-east-1' + x-type: native + id: aws.cloudwatch.log_streams + methods: + DescribeLogGroups: + serviceName: logs + operation: + $ref: '#/paths/~1?__X-Amz-Target=Logs_20140328.DescribeLogStreams&__nativeEndpoint=true/post' + request: + mediaType: application/json + response: + mediaType: application/json + objectKey: $.logStreams + openAPIDocKey: '200' + DeleteLogGroup: + serviceName: logs + operation: + $ref: '#/paths/~1?__X-Amz-Target=Logs_20140328.DeleteLogStream&__nativeEndpoint=true/post' + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + CreateLogGroup: + serviceName: logs + operation: + $ref: '#/paths/~1?__X-Amz-Target=Logs_20140328.CreateLogStream&__nativeEndpoint=true/post' + request: + mediaType: application/json + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/log_streams/methods/DeleteLogGroup' + insert: + - $ref: '#/components/x-stackQL-resources/log_streams/methods/CreateLogGroup' + select: + - $ref: '#/components/x-stackQL-resources/log_streams/methods/DescribeLogGroups' + update: [] + title: log_streams alarms: name: alarms id: aws.cloudwatch.alarms @@ -2045,118 +2157,6 @@ components: json_extract_path_text(Properties, 'Name') as name FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::CloudWatch::MetricStream' AND region = 'us-east-1' - log_events: - name: log_events - x-cfn-schema-name: OutputLogEvent - x-example-where-clause: WHERE region = 'us-east-1' AND data___logStreamName = '' - x-type: native - id: aws.cloudwatch.log_events - methods: - GetLogEvents: - serviceName: logs - operation: - $ref: '#/paths/~1?__X-Amz-Target=Logs_20140328.GetLogEvents&__nativeEndpoint=true/post' - request: - mediaType: application/json - response: - mediaType: application/json - objectKey: $.events - openAPIDocKey: '200' - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/log_events/methods/GetLogEvents' - update: [] - title: log_events - log_groups: - name: log_groups - x-cfn-schema-name: LogGroup - x-example-where-clause: WHERE region = 'us-east-1' - x-type: native - id: aws.cloudwatch.log_groups - methods: - DescribeLogGroups: - serviceName: logs - operation: - $ref: '#/paths/~1?__X-Amz-Target=Logs_20140328.DescribeLogGroups&__nativeEndpoint=true/post' - request: - mediaType: application/json - response: - mediaType: application/json - objectKey: $.logGroups - openAPIDocKey: '200' - DeleteLogGroup: - serviceName: logs - operation: - $ref: '#/paths/~1?__X-Amz-Target=Logs_20140328.DeleteLogGroup&__nativeEndpoint=true/post' - request: - mediaType: application/json - response: - mediaType: application/json - openAPIDocKey: '200' - CreateLogGroup: - serviceName: logs - operation: - $ref: '#/paths/~1?__X-Amz-Target=Logs_20140328.CreateLogGroup&__nativeEndpoint=true/post' - request: - mediaType: application/json - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/log_groups/methods/DeleteLogGroup' - insert: - - $ref: '#/components/x-stackQL-resources/log_groups/methods/CreateLogGroup' - select: - - $ref: '#/components/x-stackQL-resources/log_groups/methods/DescribeLogGroups' - update: [] - title: log_groups - log_streams: - name: log_streams - x-cfn-schema-name: LogStream - x-example-where-clause: WHERE region = 'us-east-1' - x-type: native - id: aws.cloudwatch.log_streams - methods: - DescribeLogGroups: - serviceName: logs - operation: - $ref: '#/paths/~1?__X-Amz-Target=Logs_20140328.DescribeLogStreams&__nativeEndpoint=true/post' - request: - mediaType: application/json - response: - mediaType: application/json - objectKey: $.logStreams - openAPIDocKey: '200' - DeleteLogGroup: - serviceName: logs - operation: - $ref: '#/paths/~1?__X-Amz-Target=Logs_20140328.DeleteLogStream&__nativeEndpoint=true/post' - request: - mediaType: application/json - response: - mediaType: application/json - openAPIDocKey: '200' - CreateLogGroup: - serviceName: logs - operation: - $ref: '#/paths/~1?__X-Amz-Target=Logs_20140328.CreateLogStream&__nativeEndpoint=true/post' - request: - mediaType: application/json - response: - mediaType: application/json - openAPIDocKey: '200' - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/log_streams/methods/DeleteLogGroup' - insert: - - $ref: '#/components/x-stackQL-resources/log_streams/methods/CreateLogGroup' - select: - - $ref: '#/components/x-stackQL-resources/log_streams/methods/DescribeLogGroups' - update: [] - title: log_streams paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/ec2.yaml b/providers/src/aws/v00.00.00000/services/ec2.yaml index c75ef946..cd9a5c5d 100644 --- a/providers/src/aws/v00.00.00000/services/ec2.yaml +++ b/providers/src/aws/v00.00.00000/services/ec2.yaml @@ -385,74 +385,6 @@ components: $ref: '#/components/x-cloud-control-schemas/ProgressEvent' type: object schemas: - region: - type: string - description: The AWS region - outpostArn: - type: string - description: The Amazon Resource Name (ARN) of the Outpost. - ownerId: - type: string - description: The ID of the Amazon Web Services account that owns the resource. - tagSet: - type: array - description: Any tags assigned to the resource. - snapshots: - description: List of snapshots by region (requires `aws` provider to be installed) - type: object - additionalProperties: false - properties: - description: - type: string - description: The description for the snapshot. - dataEncryptionKeyId: - type: string - description: The data encryption key identifier for the snapshot. - encrypted: - type: boolean - description: Indicates whether the snapshot is encrypted. - kmsKeyId: - type: string - description: The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the volume encryption key for the parent volume. - outpostArn: - $ref: '#/components/schemas/outpostArn' - ownerAlias: - type: string - description: The Amazon Web Services owner alias. - ownerId: - $ref: '#/components/schemas/ownerId' - progress: - type: string - description: The progress of the snapshot, as a percentage. - restoreExpiryTime: - type: string - description: Only for archived snapshots that are temporarily restored. Indicates the date and time when a temporarily restored snapshot will be automatically re-archived. - snapshotId: - type: string - description: The ID of the snapshot. Each snapshot receives a unique identifier when it is created. - startTime: - type: string - description: The time stamp when the snapshot was initiated. - status: - type: string - description: The snapshot state. - statusMessage: - type: string - description: Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper Key Management Service (KMS) permissions are not obtained) this field displays error state details. - storageTier: - type: string - description: The storage tier in which the snapshot is stored. - tagSet: - $ref: '#/components/schemas/tagSet' - volumeId: - type: string - description: The ID of the volume that was used to create the snapshot. - volumeSize: - type: integer - description: The size of the volume, in GiB. - region: - $ref: '#/components/schemas/region' - x-example-where-clause: WHERE region = '' Tag: type: object additionalProperties: false @@ -22443,37 +22375,6 @@ components: json_extract_path_text(Properties, 'VPNGatewayId') as v_pn_gateway_id FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::EC2::VPNGateway' AND region = 'us-east-1' - snapshots: - name: snapshots - id: aws.ec2.snapshots - x-cfn-schema-name: snapshots - x-type: view - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - description, - dataEncryptionKeyId, - encrypted, - kmsKeyId, - outpostArn, - ownerAlias, - ownerId, - progress, - restoreExpiryTime, - snapshotId, - startTime, - status, - statusMessage, - storageTier, - tagSet, - volumeId, - volumeSize, - region - FROM aws.ec2_api.snapshots - WHERE region = 'us-east-1' paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/ec2_api.yaml b/providers/src/aws/v00.00.00000/services/ec2_api.yaml deleted file mode 100644 index 188c7f01..00000000 --- a/providers/src/aws/v00.00.00000/services/ec2_api.yaml +++ /dev/null @@ -1,80190 +0,0 @@ -openapi: 3.0.0 -info: - version: '2016-11-15' - x-release: v4 - title: Amazon Elastic Compute Cloud - description: 'Amazon Elastic Compute Cloud

Amazon Elastic Compute Cloud (Amazon EC2) provides secure and resizable computing capacity in the Amazon Web Services Cloud. Using Amazon EC2 eliminates the need to invest in hardware up front, so you can develop and deploy applications faster. Amazon Virtual Private Cloud (Amazon VPC) enables you to provision a logically isolated section of the Amazon Web Services Cloud where you can launch Amazon Web Services resources in a virtual network that you''ve defined. Amazon Elastic Block Store (Amazon EBS) provides block level storage volumes for use with EC2 instances. EBS volumes are highly available and reliable storage volumes that can be attached to any running instance and used like a hard drive.

To learn more, see the following resources:

' - x-logo: - url: 'https://twitter.com/awscloud/profile_image?size=original' - backgroundColor: '#FFFFFF' - termsOfService: 'https://aws.amazon.com/service-terms/' - contact: - name: Mike Ralphson - email: mike.ralphson@gmail.com - url: 'https://github.com/mermade/aws2openapi' - x-twitter: PermittedSoc - license: - name: Apache 2.0 License - url: 'http://www.apache.org/licenses/' - x-providerName: amazonaws.com - x-serviceName: ec2 - x-origin: - - contentType: application/json - url: 'https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/ec2-2016-11-15.normal.json' - converter: - url: 'https://github.com/mermade/aws2openapi' - version: 1.0.0 - x-apisguru-driver: external - x-apiClientRegistration: - url: 'https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct' - x-apisguru-categories: - - cloud - x-preferred: true -externalDocs: - description: Amazon Web Services documentation - url: 'https://docs.aws.amazon.com/ec2/' -servers: - - url: 'https://ec2.{region}.amazonaws.com' - variables: - region: - description: The AWS region - enum: - - us-east-1 - - us-east-2 - - us-west-1 - - us-west-2 - - us-gov-west-1 - - us-gov-east-1 - - ca-central-1 - - eu-north-1 - - eu-west-1 - - eu-west-2 - - eu-west-3 - - eu-central-1 - - eu-south-1 - - af-south-1 - - ap-northeast-1 - - ap-northeast-2 - - ap-northeast-3 - - ap-southeast-1 - - ap-southeast-2 - - ap-east-1 - - ap-south-1 - - sa-east-1 - - me-south-1 - default: us-east-1 - description: The Amazon EC2 multi-region endpoint - - url: 'https://ec2.amazonaws.com' - variables: {} - description: The general Amazon EC2 endpoint for US East (N. Virginia) - - url: 'https://ec2.{region}.amazonaws.com.cn' - variables: - region: - description: The AWS region - enum: - - cn-north-1 - - cn-northwest-1 - default: cn-north-1 - description: The Amazon EC2 endpoint for China (Beijing) and China (Ningxia) -paths: - /?Action=AcceptReservedInstancesExchangeQuote&Version=2016-11-15: - get: - x-aws-operation-name: AcceptReservedInstancesExchangeQuote - operationId: GET_AcceptReservedInstancesExchangeQuote - description: Accepts the Convertible Reserved Instance exchange quote described in the GetReservedInstancesExchangeQuote call. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AcceptReservedInstancesExchangeQuoteResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: ReservedInstanceId - in: query - required: true - description: The IDs of the Convertible Reserved Instances to exchange for another Convertible Reserved Instance of the same or higher value. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/ReservationId' - - xml: - name: ReservedInstanceId - - name: TargetConfiguration - in: query - required: false - description: The configuration of the target Convertible Reserved Instance to exchange for your current Convertible Reserved Instances. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TargetConfigurationRequest' - - xml: - name: TargetConfigurationRequest - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: AcceptReservedInstancesExchangeQuote - operationId: POST_AcceptReservedInstancesExchangeQuote - description: Accepts the Convertible Reserved Instance exchange quote described in the GetReservedInstancesExchangeQuote call. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AcceptReservedInstancesExchangeQuoteResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/AcceptReservedInstancesExchangeQuoteRequest' - parameters: [] - /?Action=AcceptTransitGatewayMulticastDomainAssociations&Version=2016-11-15: - get: - x-aws-operation-name: AcceptTransitGatewayMulticastDomainAssociations - operationId: GET_AcceptTransitGatewayMulticastDomainAssociations - description: Accepts a request to associate subnets with a transit gateway multicast domain. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AcceptTransitGatewayMulticastDomainAssociationsResult' - parameters: - - name: TransitGatewayMulticastDomainId - in: query - required: false - description: The ID of the transit gateway multicast domain. - schema: - type: string - - name: TransitGatewayAttachmentId - in: query - required: false - description: The ID of the transit gateway attachment. - schema: - type: string - - name: SubnetIds - in: query - required: false - description: The IDs of the subnets to associate with the transit gateway multicast domain. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: AcceptTransitGatewayMulticastDomainAssociations - operationId: POST_AcceptTransitGatewayMulticastDomainAssociations - description: Accepts a request to associate subnets with a transit gateway multicast domain. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AcceptTransitGatewayMulticastDomainAssociationsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/AcceptTransitGatewayMulticastDomainAssociationsRequest' - parameters: [] - /?Action=AcceptTransitGatewayPeeringAttachment&Version=2016-11-15: - get: - x-aws-operation-name: AcceptTransitGatewayPeeringAttachment - operationId: GET_AcceptTransitGatewayPeeringAttachment - description: Accepts a transit gateway peering attachment request. The peering attachment must be in the pendingAcceptance state. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AcceptTransitGatewayPeeringAttachmentResult' - parameters: - - name: TransitGatewayAttachmentId - in: query - required: true - description: The ID of the transit gateway attachment. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: AcceptTransitGatewayPeeringAttachment - operationId: POST_AcceptTransitGatewayPeeringAttachment - description: Accepts a transit gateway peering attachment request. The peering attachment must be in the pendingAcceptance state. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AcceptTransitGatewayPeeringAttachmentResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/AcceptTransitGatewayPeeringAttachmentRequest' - parameters: [] - /?Action=AcceptTransitGatewayVpcAttachment&Version=2016-11-15: - get: - x-aws-operation-name: AcceptTransitGatewayVpcAttachment - operationId: GET_AcceptTransitGatewayVpcAttachment - description:

Accepts a request to attach a VPC to a transit gateway.

The VPC attachment must be in the pendingAcceptance state. Use DescribeTransitGatewayVpcAttachments to view your pending VPC attachment requests. Use RejectTransitGatewayVpcAttachment to reject a VPC attachment request.

- responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AcceptTransitGatewayVpcAttachmentResult' - parameters: - - name: TransitGatewayAttachmentId - in: query - required: true - description: The ID of the attachment. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: AcceptTransitGatewayVpcAttachment - operationId: POST_AcceptTransitGatewayVpcAttachment - description:

Accepts a request to attach a VPC to a transit gateway.

The VPC attachment must be in the pendingAcceptance state. Use DescribeTransitGatewayVpcAttachments to view your pending VPC attachment requests. Use RejectTransitGatewayVpcAttachment to reject a VPC attachment request.

- responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AcceptTransitGatewayVpcAttachmentResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/AcceptTransitGatewayVpcAttachmentRequest' - parameters: [] - /?Action=AcceptVpcEndpointConnections&Version=2016-11-15: - get: - x-aws-operation-name: AcceptVpcEndpointConnections - operationId: GET_AcceptVpcEndpointConnections - description: Accepts one or more interface VPC endpoint connection requests to your VPC endpoint service. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AcceptVpcEndpointConnectionsResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: ServiceId - in: query - required: true - description: The ID of the VPC endpoint service. - schema: - type: string - - name: VpcEndpointId - in: query - required: true - description: The IDs of one or more interface VPC endpoints. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/VpcEndpointId' - - xml: - name: item - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: AcceptVpcEndpointConnections - operationId: POST_AcceptVpcEndpointConnections - description: Accepts one or more interface VPC endpoint connection requests to your VPC endpoint service. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AcceptVpcEndpointConnectionsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/AcceptVpcEndpointConnectionsRequest' - parameters: [] - /?Action=AcceptVpcPeeringConnection&Version=2016-11-15: - get: - x-aws-operation-name: AcceptVpcPeeringConnection - operationId: GET_AcceptVpcPeeringConnection - description: '

Accept a VPC peering connection request. To accept a request, the VPC peering connection must be in the pending-acceptance state, and you must be the owner of the peer VPC. Use DescribeVpcPeeringConnections to view your outstanding VPC peering connection requests.

For an inter-Region VPC peering connection request, you must accept the VPC peering connection in the Region of the accepter VPC.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AcceptVpcPeeringConnectionResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: VpcPeeringConnectionId - in: query - required: false - description: The ID of the VPC peering connection. You must specify this parameter in the request. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: AcceptVpcPeeringConnection - operationId: POST_AcceptVpcPeeringConnection - description: '

Accept a VPC peering connection request. To accept a request, the VPC peering connection must be in the pending-acceptance state, and you must be the owner of the peer VPC. Use DescribeVpcPeeringConnections to view your outstanding VPC peering connection requests.

For an inter-Region VPC peering connection request, you must accept the VPC peering connection in the Region of the accepter VPC.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AcceptVpcPeeringConnectionResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/AcceptVpcPeeringConnectionRequest' - parameters: [] - /?Action=AdvertiseByoipCidr&Version=2016-11-15: - get: - x-aws-operation-name: AdvertiseByoipCidr - operationId: GET_AdvertiseByoipCidr - description: '

Advertises an IPv4 or IPv6 address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP).

You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time.

We recommend that you stop advertising the BYOIP CIDR from other locations when you advertise it from Amazon Web Services. To minimize down time, you can configure your Amazon Web Services resources to use an address from a BYOIP CIDR before it is advertised, and then simultaneously stop advertising it from the current location and start advertising it through Amazon Web Services.

It can take a few minutes before traffic to the specified addresses starts routing to Amazon Web Services because of BGP propagation delays.

To stop advertising the BYOIP CIDR, use WithdrawByoipCidr.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AdvertiseByoipCidrResult' - parameters: - - name: Cidr - in: query - required: true - description: 'The address range, in CIDR notation. This must be the exact range that you provisioned. You can''t advertise only a portion of the provisioned range.' - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: AdvertiseByoipCidr - operationId: POST_AdvertiseByoipCidr - description: '

Advertises an IPv4 or IPv6 address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP).

You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time.

We recommend that you stop advertising the BYOIP CIDR from other locations when you advertise it from Amazon Web Services. To minimize down time, you can configure your Amazon Web Services resources to use an address from a BYOIP CIDR before it is advertised, and then simultaneously stop advertising it from the current location and start advertising it through Amazon Web Services.

It can take a few minutes before traffic to the specified addresses starts routing to Amazon Web Services because of BGP propagation delays.

To stop advertising the BYOIP CIDR, use WithdrawByoipCidr.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AdvertiseByoipCidrResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/AdvertiseByoipCidrRequest' - parameters: [] - /?Action=AllocateAddress&Version=2016-11-15: - get: - x-aws-operation-name: AllocateAddress - operationId: GET_AllocateAddress - description: '

Allocates an Elastic IP address to your Amazon Web Services account. After you allocate the Elastic IP address you can associate it with an instance or network interface. After you release an Elastic IP address, it is released to the IP address pool and can be allocated to a different Amazon Web Services account.

You can allocate an Elastic IP address from an address pool owned by Amazon Web Services or from an address pool created from a public IPv4 address range that you have brought to Amazon Web Services for use with your Amazon Web Services resources using bring your own IP addresses (BYOIP). For more information, see Bring Your Own IP Addresses (BYOIP) in the Amazon Elastic Compute Cloud User Guide.

[EC2-VPC] If you release an Elastic IP address, you might be able to recover it. You cannot recover an Elastic IP address that you released after it is allocated to another Amazon Web Services account. You cannot recover an Elastic IP address for EC2-Classic. To attempt to recover an Elastic IP address that you released, specify it in this operation.

An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. By default, you can allocate 5 Elastic IP addresses for EC2-Classic per Region and 5 Elastic IP addresses for EC2-VPC per Region.

For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

You can allocate a carrier IP address which is a public IP address from a telecommunication carrier, to a network interface which resides in a subnet in a Wavelength Zone (for example an EC2 instance).

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AllocateAddressResult' - parameters: - - name: Domain - in: query - required: false - description: '

Indicates whether the Elastic IP address is for use with instances in a VPC or instances in EC2-Classic.

Default: If the Region supports EC2-Classic, the default is standard. Otherwise, the default is vpc.

' - schema: - type: string - enum: - - vpc - - standard - - name: Address - in: query - required: false - description: '[EC2-VPC] The Elastic IP address to recover or an IPv4 address from an address pool.' - schema: - type: string - - name: PublicIpv4Pool - in: query - required: false - description: 'The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address pool. To specify a specific address from the address pool, use the Address parameter instead.' - schema: - type: string - - name: NetworkBorderGroup - in: query - required: false - description: '

A unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses. Use this parameter to limit the IP address to this location. IP addresses cannot move between network border groups.

Use DescribeAvailabilityZones to view the network border groups.

You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 Classic, you receive an InvalidParameterCombination error.

' - schema: - type: string - - name: CustomerOwnedIpv4Pool - in: query - required: false - description: 'The ID of a customer-owned address pool. Use this parameter to let Amazon EC2 select an address from the address pool. Alternatively, specify a specific address from the address pool.' - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: TagSpecification - in: query - required: false - description: The tags to assign to the Elastic IP address. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: AllocateAddress - operationId: POST_AllocateAddress - description: '

Allocates an Elastic IP address to your Amazon Web Services account. After you allocate the Elastic IP address you can associate it with an instance or network interface. After you release an Elastic IP address, it is released to the IP address pool and can be allocated to a different Amazon Web Services account.

You can allocate an Elastic IP address from an address pool owned by Amazon Web Services or from an address pool created from a public IPv4 address range that you have brought to Amazon Web Services for use with your Amazon Web Services resources using bring your own IP addresses (BYOIP). For more information, see Bring Your Own IP Addresses (BYOIP) in the Amazon Elastic Compute Cloud User Guide.

[EC2-VPC] If you release an Elastic IP address, you might be able to recover it. You cannot recover an Elastic IP address that you released after it is allocated to another Amazon Web Services account. You cannot recover an Elastic IP address for EC2-Classic. To attempt to recover an Elastic IP address that you released, specify it in this operation.

An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. By default, you can allocate 5 Elastic IP addresses for EC2-Classic per Region and 5 Elastic IP addresses for EC2-VPC per Region.

For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

You can allocate a carrier IP address which is a public IP address from a telecommunication carrier, to a network interface which resides in a subnet in a Wavelength Zone (for example an EC2 instance).

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AllocateAddressResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/AllocateAddressRequest' - parameters: [] - /?Action=AllocateHosts&Version=2016-11-15: - get: - x-aws-operation-name: AllocateHosts - operationId: GET_AllocateHosts - description: 'Allocates a Dedicated Host to your account. At a minimum, specify the supported instance type or instance family, the Availability Zone in which to allocate the host, and the number of hosts to allocate.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AllocateHostsResult' - parameters: - - name: AutoPlacement - in: query - required: false - description: '

Indicates whether the host accepts any untargeted instance launches that match its instance type configuration, or if it only accepts Host tenancy instance launches that specify its unique host ID. For more information, see Understanding auto-placement and affinity in the Amazon EC2 User Guide.

Default: on

' - schema: - type: string - enum: - - 'on' - - 'off' - - name: AvailabilityZone - in: query - required: true - description: The Availability Zone in which to allocate the Dedicated Host. - schema: - type: string - - name: ClientToken - in: query - required: false - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.' - schema: - type: string - - name: InstanceType - in: query - required: false - description: '

Specifies the instance type to be supported by the Dedicated Hosts. If you specify an instance type, the Dedicated Hosts support instances of the specified instance type only.

If you want the Dedicated Hosts to support multiple instance types in a specific instance family, omit this parameter and specify InstanceFamily instead. You cannot specify InstanceType and InstanceFamily in the same request.

' - schema: - type: string - - name: InstanceFamily - in: query - required: false - description: '

Specifies the instance family to be supported by the Dedicated Hosts. If you specify an instance family, the Dedicated Hosts support multiple instance types within that instance family.

If you want the Dedicated Hosts to support a specific instance type only, omit this parameter and specify InstanceType instead. You cannot specify InstanceFamily and InstanceType in the same request.

' - schema: - type: string - - name: Quantity - in: query - required: true - description: The number of Dedicated Hosts to allocate to your account with these parameters. - schema: - type: integer - - name: TagSpecification - in: query - required: false - description: The tags to apply to the Dedicated Host during creation. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - - name: HostRecovery - in: query - required: false - description: '

Indicates whether to enable or disable host recovery for the Dedicated Host. Host recovery is disabled by default. For more information, see Host recovery in the Amazon EC2 User Guide.

Default: off

' - schema: - type: string - enum: - - 'on' - - 'off' - - name: OutpostArn - in: query - required: false - description: The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which to allocate the Dedicated Host. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: AllocateHosts - operationId: POST_AllocateHosts - description: 'Allocates a Dedicated Host to your account. At a minimum, specify the supported instance type or instance family, the Availability Zone in which to allocate the host, and the number of hosts to allocate.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AllocateHostsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/AllocateHostsRequest' - parameters: [] - /?Action=AllocateIpamPoolCidr&Version=2016-11-15: - get: - x-aws-operation-name: AllocateIpamPoolCidr - operationId: GET_AllocateIpamPoolCidr - description: 'Allocate a CIDR from an IPAM pool. In IPAM, an allocation is a CIDR assignment from an IPAM pool to another resource or IPAM pool. For more information, see Allocate CIDRs in the Amazon VPC IPAM User Guide. ' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AllocateIpamPoolCidrResult' - parameters: - - name: DryRun - in: query - required: false - description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: IpamPoolId - in: query - required: true - description: The ID of the IPAM pool from which you would like to allocate a CIDR. - schema: - type: string - - name: Cidr - in: query - required: false - description: '

The CIDR you would like to allocate from the IPAM pool. Note the following:

  • If there is no DefaultNetmaskLength allocation rule set on the pool, you must specify either the NetmaskLength or the CIDR.

  • If the DefaultNetmaskLength allocation rule is set on the pool, you can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will be ignored.

Possible values: Any available IPv4 or IPv6 CIDR.

' - schema: - type: string - - name: NetmaskLength - in: query - required: false - description: '

The netmask length of the CIDR you would like to allocate from the IPAM pool. Note the following:

  • If there is no DefaultNetmaskLength allocation rule set on the pool, you must specify either the NetmaskLength or the CIDR.

  • If the DefaultNetmaskLength allocation rule is set on the pool, you can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will be ignored.

Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

' - schema: - type: integer - - name: ClientToken - in: query - required: false - description: 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.' - schema: - type: string - - name: Description - in: query - required: false - description: A description for the allocation. - schema: - type: string - - name: PreviewNextCidr - in: query - required: false - description: A preview of the next available CIDR in a pool. - schema: - type: boolean - - name: DisallowedCidr - in: query - required: false - description: Exclude a particular CIDR range from being returned by the pool. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: AllocateIpamPoolCidr - operationId: POST_AllocateIpamPoolCidr - description: 'Allocate a CIDR from an IPAM pool. In IPAM, an allocation is a CIDR assignment from an IPAM pool to another resource or IPAM pool. For more information, see Allocate CIDRs in the Amazon VPC IPAM User Guide. ' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AllocateIpamPoolCidrResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/AllocateIpamPoolCidrRequest' - parameters: [] - /?Action=ApplySecurityGroupsToClientVpnTargetNetwork&Version=2016-11-15: - get: - x-aws-operation-name: ApplySecurityGroupsToClientVpnTargetNetwork - operationId: GET_ApplySecurityGroupsToClientVpnTargetNetwork - description: Applies a security group to the association between the target network and the Client VPN endpoint. This action replaces the existing security groups with the specified security groups. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ApplySecurityGroupsToClientVpnTargetNetworkResult' - parameters: - - name: ClientVpnEndpointId - in: query - required: true - description: The ID of the Client VPN endpoint. - schema: - type: string - - name: VpcId - in: query - required: true - description: The ID of the VPC in which the associated target network is located. - schema: - type: string - - name: SecurityGroupId - in: query - required: true - description: The IDs of the security groups to apply to the associated target network. Up to 5 security groups can be applied to an associated target network. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/SecurityGroupId' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ApplySecurityGroupsToClientVpnTargetNetwork - operationId: POST_ApplySecurityGroupsToClientVpnTargetNetwork - description: Applies a security group to the association between the target network and the Client VPN endpoint. This action replaces the existing security groups with the specified security groups. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ApplySecurityGroupsToClientVpnTargetNetworkResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ApplySecurityGroupsToClientVpnTargetNetworkRequest' - parameters: [] - /?Action=AssignIpv6Addresses&Version=2016-11-15: - get: - x-aws-operation-name: AssignIpv6Addresses - operationId: GET_AssignIpv6Addresses - description: '

Assigns one or more IPv6 addresses to the specified network interface. You can specify one or more specific IPv6 addresses, or you can specify the number of IPv6 addresses to be automatically assigned from within the subnet''s IPv6 CIDR block range. You can assign as many IPv6 addresses to a network interface as you can assign private IPv4 addresses, and the limit varies per instance type. For information, see IP Addresses Per Network Interface Per Instance Type in the Amazon Elastic Compute Cloud User Guide.

You must specify either the IPv6 addresses or the IPv6 address count in the request.

You can optionally use Prefix Delegation on the network interface. You must specify either the IPV6 Prefix Delegation prefixes, or the IPv6 Prefix Delegation count. For information, see Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AssignIpv6AddressesResult' - parameters: - - name: Ipv6AddressCount - in: query - required: false - description: The number of additional IPv6 addresses to assign to the network interface. The specified number of IPv6 addresses are assigned in addition to the existing IPv6 addresses that are already assigned to the network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses. - schema: - type: integer - - name: Ipv6Addresses - in: query - required: false - description: One or more specific IPv6 addresses to be assigned to the network interface. You can't use this option if you're specifying a number of IPv6 addresses. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - - name: Ipv6PrefixCount - in: query - required: false - description: The number of IPv6 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use the Ipv6Prefixes option. - schema: - type: integer - - name: Ipv6Prefix - in: query - required: false - description: One or more IPv6 prefixes assigned to the network interface. You cannot use this option if you use the Ipv6PrefixCount option. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - - name: NetworkInterfaceId - in: query - required: true - description: The ID of the network interface. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: AssignIpv6Addresses - operationId: POST_AssignIpv6Addresses - description: '

Assigns one or more IPv6 addresses to the specified network interface. You can specify one or more specific IPv6 addresses, or you can specify the number of IPv6 addresses to be automatically assigned from within the subnet''s IPv6 CIDR block range. You can assign as many IPv6 addresses to a network interface as you can assign private IPv4 addresses, and the limit varies per instance type. For information, see IP Addresses Per Network Interface Per Instance Type in the Amazon Elastic Compute Cloud User Guide.

You must specify either the IPv6 addresses or the IPv6 address count in the request.

You can optionally use Prefix Delegation on the network interface. You must specify either the IPV6 Prefix Delegation prefixes, or the IPv6 Prefix Delegation count. For information, see Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AssignIpv6AddressesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/AssignIpv6AddressesRequest' - parameters: [] - /?Action=AssignPrivateIpAddresses&Version=2016-11-15: - get: - x-aws-operation-name: AssignPrivateIpAddresses - operationId: GET_AssignPrivateIpAddresses - description: '

Assigns one or more secondary private IP addresses to the specified network interface.

You can specify one or more specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned within the subnet''s CIDR block range. The number of secondary IP addresses that you can assign to an instance varies by instance type. For information about instance types, see Instance Types in the Amazon Elastic Compute Cloud User Guide. For more information about Elastic IP addresses, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

When you move a secondary private IP address to another network interface, any Elastic IP address that is associated with the IP address is also moved.

Remapping an IP address is an asynchronous operation. When you move an IP address from one network interface to another, check network/interfaces/macs/mac/local-ipv4s in the instance metadata to confirm that the remapping is complete.

You must specify either the IP addresses or the IP address count in the request.

You can optionally use Prefix Delegation on the network interface. You must specify either the IPv4 Prefix Delegation prefixes, or the IPv4 Prefix Delegation count. For information, see Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AssignPrivateIpAddressesResult' - parameters: - - name: AllowReassignment - in: query - required: false - description: Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface. - schema: - type: boolean - - name: NetworkInterfaceId - in: query - required: true - description: The ID of the network interface. - schema: - type: string - - name: PrivateIpAddress - in: query - required: false - description: '

One or more IP addresses to be assigned as a secondary private IP address to the network interface. You can''t specify this parameter when also specifying a number of secondary IP addresses.

If you don''t specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: PrivateIpAddress - - name: SecondaryPrivateIpAddressCount - in: query - required: false - description: The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses. - schema: - type: integer - - name: Ipv4Prefix - in: query - required: false - description: One or more IPv4 prefixes assigned to the network interface. You cannot use this option if you use the Ipv4PrefixCount option. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - - name: Ipv4PrefixCount - in: query - required: false - description: The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use the Ipv4 Prefixes option. - schema: - type: integer - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: AssignPrivateIpAddresses - operationId: POST_AssignPrivateIpAddresses - description: '

Assigns one or more secondary private IP addresses to the specified network interface.

You can specify one or more specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned within the subnet''s CIDR block range. The number of secondary IP addresses that you can assign to an instance varies by instance type. For information about instance types, see Instance Types in the Amazon Elastic Compute Cloud User Guide. For more information about Elastic IP addresses, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

When you move a secondary private IP address to another network interface, any Elastic IP address that is associated with the IP address is also moved.

Remapping an IP address is an asynchronous operation. When you move an IP address from one network interface to another, check network/interfaces/macs/mac/local-ipv4s in the instance metadata to confirm that the remapping is complete.

You must specify either the IP addresses or the IP address count in the request.

You can optionally use Prefix Delegation on the network interface. You must specify either the IPv4 Prefix Delegation prefixes, or the IPv4 Prefix Delegation count. For information, see Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AssignPrivateIpAddressesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/AssignPrivateIpAddressesRequest' - parameters: [] - /?Action=AssociateAddress&Version=2016-11-15: - get: - x-aws-operation-name: AssociateAddress - operationId: GET_AssociateAddress - description: '

Associates an Elastic IP address, or carrier IP address (for instances that are in subnets in Wavelength Zones) with an instance or a network interface. Before you can use an Elastic IP address, you must allocate it to your account.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

[EC2-Classic, VPC in an EC2-VPC-only account] If the Elastic IP address is already associated with a different instance, it is disassociated from that instance and associated with the specified instance. If you associate an Elastic IP address with an instance that has an existing Elastic IP address, the existing address is disassociated from the instance, but remains allocated to your account.

[VPC in an EC2-Classic account] If you don''t specify a private IP address, the Elastic IP address is associated with the primary IP address. If the Elastic IP address is already associated with a different instance or a network interface, you get an error unless you allow reassociation. You cannot associate an Elastic IP address with an instance or network interface that has an existing Elastic IP address.

[Subnets in Wavelength Zones] You can associate an IP address from the telecommunication carrier to the instance or network interface.

You cannot associate an Elastic IP address with an interface in a different network border group.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn''t return an error, and you may be charged for each time the Elastic IP address is remapped to the same instance. For more information, see the Elastic IP Addresses section of Amazon EC2 Pricing.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AssociateAddressResult' - parameters: - - name: AllocationId - in: query - required: false - description: '[EC2-VPC] The allocation ID. This is required for EC2-VPC.' - schema: - type: string - - name: InstanceId - in: query - required: false - description: 'The ID of the instance. The instance must have exactly one attached network interface. For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both. For EC2-Classic, you must specify an instance ID and the instance must be in the running state.' - schema: - type: string - - name: PublicIp - in: query - required: false - description: '[EC2-Classic] The Elastic IP address to associate with the instance. This is required for EC2-Classic.' - schema: - type: string - - name: AllowReassociation - in: query - required: false - description: '[EC2-VPC] For a VPC in an EC2-Classic account, specify true to allow an Elastic IP address that is already associated with an instance or network interface to be reassociated with the specified instance or network interface. Otherwise, the operation fails. In a VPC in an EC2-VPC-only account, reassociation is automatic, therefore you can specify false to ensure the operation fails if the Elastic IP address is already associated with another resource.' - schema: - type: boolean - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: NetworkInterfaceId - in: query - required: false - description: '

[EC2-VPC] The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.

For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both.

' - schema: - type: string - - name: PrivateIpAddress - in: query - required: false - description: '[EC2-VPC] The primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address.' - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: AssociateAddress - operationId: POST_AssociateAddress - description: '

Associates an Elastic IP address, or carrier IP address (for instances that are in subnets in Wavelength Zones) with an instance or a network interface. Before you can use an Elastic IP address, you must allocate it to your account.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

[EC2-Classic, VPC in an EC2-VPC-only account] If the Elastic IP address is already associated with a different instance, it is disassociated from that instance and associated with the specified instance. If you associate an Elastic IP address with an instance that has an existing Elastic IP address, the existing address is disassociated from the instance, but remains allocated to your account.

[VPC in an EC2-Classic account] If you don''t specify a private IP address, the Elastic IP address is associated with the primary IP address. If the Elastic IP address is already associated with a different instance or a network interface, you get an error unless you allow reassociation. You cannot associate an Elastic IP address with an instance or network interface that has an existing Elastic IP address.

[Subnets in Wavelength Zones] You can associate an IP address from the telecommunication carrier to the instance or network interface.

You cannot associate an Elastic IP address with an interface in a different network border group.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn''t return an error, and you may be charged for each time the Elastic IP address is remapped to the same instance. For more information, see the Elastic IP Addresses section of Amazon EC2 Pricing.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AssociateAddressResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/AssociateAddressRequest' - parameters: [] - /?Action=AssociateClientVpnTargetNetwork&Version=2016-11-15: - get: - x-aws-operation-name: AssociateClientVpnTargetNetwork - operationId: GET_AssociateClientVpnTargetNetwork - description: '

Associates a target network with a Client VPN endpoint. A target network is a subnet in a VPC. You can associate multiple subnets from the same VPC with a Client VPN endpoint. You can associate only one subnet in each Availability Zone. We recommend that you associate at least two subnets to provide Availability Zone redundancy.

If you specified a VPC when you created the Client VPN endpoint or if you have previous subnet associations, the specified subnet must be in the same VPC. To specify a subnet that''s in a different VPC, you must first modify the Client VPN endpoint (ModifyClientVpnEndpoint) and change the VPC that''s associated with it.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AssociateClientVpnTargetNetworkResult' - parameters: - - name: ClientVpnEndpointId - in: query - required: true - description: The ID of the Client VPN endpoint. - schema: - type: string - - name: SubnetId - in: query - required: true - description: The ID of the subnet to associate with the Client VPN endpoint. - schema: - type: string - - name: ClientToken - in: query - required: false - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.' - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: AssociateClientVpnTargetNetwork - operationId: POST_AssociateClientVpnTargetNetwork - description: '

Associates a target network with a Client VPN endpoint. A target network is a subnet in a VPC. You can associate multiple subnets from the same VPC with a Client VPN endpoint. You can associate only one subnet in each Availability Zone. We recommend that you associate at least two subnets to provide Availability Zone redundancy.

If you specified a VPC when you created the Client VPN endpoint or if you have previous subnet associations, the specified subnet must be in the same VPC. To specify a subnet that''s in a different VPC, you must first modify the Client VPN endpoint (ModifyClientVpnEndpoint) and change the VPC that''s associated with it.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AssociateClientVpnTargetNetworkResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/AssociateClientVpnTargetNetworkRequest' - parameters: [] - /?Action=AssociateDhcpOptions&Version=2016-11-15: - get: - x-aws-operation-name: AssociateDhcpOptions - operationId: GET_AssociateDhcpOptions - description: '

Associates a set of DHCP options (that you''ve previously created) with the specified VPC, or associates no DHCP options with the VPC.

After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don''t need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance.

For more information, see DHCP options sets in the Amazon Virtual Private Cloud User Guide.

' - responses: - '200': - description: Success - parameters: - - name: DhcpOptionsId - in: query - required: true - description: 'The ID of the DHCP options set, or default to associate no DHCP options with the VPC.' - schema: - type: string - - name: VpcId - in: query - required: true - description: The ID of the VPC. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: AssociateDhcpOptions - operationId: POST_AssociateDhcpOptions - description: '

Associates a set of DHCP options (that you''ve previously created) with the specified VPC, or associates no DHCP options with the VPC.

After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don''t need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance.

For more information, see DHCP options sets in the Amazon Virtual Private Cloud User Guide.

' - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/AssociateDhcpOptionsRequest' - parameters: [] - /?Action=AssociateEnclaveCertificateIamRole&Version=2016-11-15: - get: - x-aws-operation-name: AssociateEnclaveCertificateIamRole - operationId: GET_AssociateEnclaveCertificateIamRole - description: '

Associates an Identity and Access Management (IAM) role with an Certificate Manager (ACM) certificate. This enables the certificate to be used by the ACM for Nitro Enclaves application inside an enclave. For more information, see Certificate Manager for Nitro Enclaves in the Amazon Web Services Nitro Enclaves User Guide.

When the IAM role is associated with the ACM certificate, the certificate, certificate chain, and encrypted private key are placed in an Amazon S3 bucket that only the associated IAM role can access. The private key of the certificate is encrypted with an Amazon Web Services managed key that has an attached attestation-based key policy.

To enable the IAM role to access the Amazon S3 object, you must grant it permission to call s3:GetObject on the Amazon S3 bucket returned by the command. To enable the IAM role to access the KMS key, you must grant it permission to call kms:Decrypt on the KMS key returned by the command. For more information, see Grant the role permission to access the certificate and encryption key in the Amazon Web Services Nitro Enclaves User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AssociateEnclaveCertificateIamRoleResult' - parameters: - - name: CertificateArn - in: query - required: false - description: The ARN of the ACM certificate with which to associate the IAM role. - schema: - type: string - minLength: 1 - maxLength: 1283 - - name: RoleArn - in: query - required: false - description: The ARN of the IAM role to associate with the ACM certificate. You can associate up to 16 IAM roles with an ACM certificate. - schema: - type: string - minLength: 1 - maxLength: 1283 - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: AssociateEnclaveCertificateIamRole - operationId: POST_AssociateEnclaveCertificateIamRole - description: '

Associates an Identity and Access Management (IAM) role with an Certificate Manager (ACM) certificate. This enables the certificate to be used by the ACM for Nitro Enclaves application inside an enclave. For more information, see Certificate Manager for Nitro Enclaves in the Amazon Web Services Nitro Enclaves User Guide.

When the IAM role is associated with the ACM certificate, the certificate, certificate chain, and encrypted private key are placed in an Amazon S3 bucket that only the associated IAM role can access. The private key of the certificate is encrypted with an Amazon Web Services managed key that has an attached attestation-based key policy.

To enable the IAM role to access the Amazon S3 object, you must grant it permission to call s3:GetObject on the Amazon S3 bucket returned by the command. To enable the IAM role to access the KMS key, you must grant it permission to call kms:Decrypt on the KMS key returned by the command. For more information, see Grant the role permission to access the certificate and encryption key in the Amazon Web Services Nitro Enclaves User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AssociateEnclaveCertificateIamRoleResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/AssociateEnclaveCertificateIamRoleRequest' - parameters: [] - /?Action=AssociateIamInstanceProfile&Version=2016-11-15: - get: - x-aws-operation-name: AssociateIamInstanceProfile - operationId: GET_AssociateIamInstanceProfile - description: Associates an IAM instance profile with a running or stopped instance. You cannot associate more than one IAM instance profile with an instance. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AssociateIamInstanceProfileResult' - parameters: - - name: IamInstanceProfile - in: query - required: true - description: The IAM instance profile. - schema: - type: object - properties: - arn: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Resource Name (ARN) of the instance profile. - name: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of the instance profile. - description: Describes an IAM instance profile. - - name: InstanceId - in: query - required: true - description: The ID of the instance. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: AssociateIamInstanceProfile - operationId: POST_AssociateIamInstanceProfile - description: Associates an IAM instance profile with a running or stopped instance. You cannot associate more than one IAM instance profile with an instance. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AssociateIamInstanceProfileResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/AssociateIamInstanceProfileRequest' - parameters: [] - /?Action=AssociateInstanceEventWindow&Version=2016-11-15: - get: - x-aws-operation-name: AssociateInstanceEventWindow - operationId: GET_AssociateInstanceEventWindow - description: '

Associates one or more targets with an event window. Only one type of target (instance IDs, Dedicated Host IDs, or tags) can be specified with an event window.

For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AssociateInstanceEventWindowResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: InstanceEventWindowId - in: query - required: true - description: The ID of the event window. - schema: - type: string - - name: AssociationTarget - in: query - required: true - description: One or more targets associated with the specified event window. - schema: - type: object - properties: - InstanceId: - allOf: - - $ref: '#/components/schemas/InstanceIdList' - - description: 'The IDs of the instances to associate with the event window. If the instance is on a Dedicated Host, you can''t specify the Instance ID parameter; you must use the Dedicated Host ID parameter.' - InstanceTag: - allOf: - - $ref: '#/components/schemas/TagList' - - description: The instance tags to associate with the event window. Any instances associated with the tags will be associated with the event window. - DedicatedHostId: - allOf: - - $ref: '#/components/schemas/DedicatedHostIdList' - - description: The IDs of the Dedicated Hosts to associate with the event window. - description: 'One or more targets associated with the specified event window. Only one type of target (instance ID, instance tag, or Dedicated Host ID) can be associated with an event window.' - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: AssociateInstanceEventWindow - operationId: POST_AssociateInstanceEventWindow - description: '

Associates one or more targets with an event window. Only one type of target (instance IDs, Dedicated Host IDs, or tags) can be specified with an event window.

For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AssociateInstanceEventWindowResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/AssociateInstanceEventWindowRequest' - parameters: [] - /?Action=AssociateRouteTable&Version=2016-11-15: - get: - x-aws-operation-name: AssociateRouteTable - operationId: GET_AssociateRouteTable - description: '

Associates a subnet in your VPC or an internet gateway or virtual private gateway attached to your VPC with a route table in your VPC. This association causes traffic from the subnet or gateway to be routed according to the routes in the route table. The action returns an association ID, which you need in order to disassociate the route table later. A route table can be associated with multiple subnets.

For more information, see Route tables in the Amazon Virtual Private Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AssociateRouteTableResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: RouteTableId - in: query - required: true - description: The ID of the route table. - schema: - type: string - - name: SubnetId - in: query - required: false - description: The ID of the subnet. - schema: - type: string - - name: GatewayId - in: query - required: false - description: The ID of the internet gateway or virtual private gateway. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: AssociateRouteTable - operationId: POST_AssociateRouteTable - description: '

Associates a subnet in your VPC or an internet gateway or virtual private gateway attached to your VPC with a route table in your VPC. This association causes traffic from the subnet or gateway to be routed according to the routes in the route table. The action returns an association ID, which you need in order to disassociate the route table later. A route table can be associated with multiple subnets.

For more information, see Route tables in the Amazon Virtual Private Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AssociateRouteTableResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/AssociateRouteTableRequest' - parameters: [] - /?Action=AssociateSubnetCidrBlock&Version=2016-11-15: - get: - x-aws-operation-name: AssociateSubnetCidrBlock - operationId: GET_AssociateSubnetCidrBlock - description: Associates a CIDR block with your subnet. You can only associate a single IPv6 CIDR block with your subnet. An IPv6 CIDR block must have a prefix length of /64. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AssociateSubnetCidrBlockResult' - parameters: - - name: Ipv6CidrBlock - in: query - required: true - description: The IPv6 CIDR block for your subnet. The subnet must have a /64 prefix length. - schema: - type: string - - name: SubnetId - in: query - required: true - description: The ID of your subnet. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: AssociateSubnetCidrBlock - operationId: POST_AssociateSubnetCidrBlock - description: Associates a CIDR block with your subnet. You can only associate a single IPv6 CIDR block with your subnet. An IPv6 CIDR block must have a prefix length of /64. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AssociateSubnetCidrBlockResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/AssociateSubnetCidrBlockRequest' - parameters: [] - /?Action=AssociateTransitGatewayMulticastDomain&Version=2016-11-15: - get: - x-aws-operation-name: AssociateTransitGatewayMulticastDomain - operationId: GET_AssociateTransitGatewayMulticastDomain - description: '

Associates the specified subnets and transit gateway attachments with the specified transit gateway multicast domain.

The transit gateway attachment must be in the available state before you can add a resource. Use DescribeTransitGatewayAttachments to see the state of the attachment.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AssociateTransitGatewayMulticastDomainResult' - parameters: - - name: TransitGatewayMulticastDomainId - in: query - required: false - description: The ID of the transit gateway multicast domain. - schema: - type: string - - name: TransitGatewayAttachmentId - in: query - required: false - description: The ID of the transit gateway attachment to associate with the transit gateway multicast domain. - schema: - type: string - - name: SubnetIds - in: query - required: false - description: The IDs of the subnets to associate with the transit gateway multicast domain. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/SubnetId' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: AssociateTransitGatewayMulticastDomain - operationId: POST_AssociateTransitGatewayMulticastDomain - description: '

Associates the specified subnets and transit gateway attachments with the specified transit gateway multicast domain.

The transit gateway attachment must be in the available state before you can add a resource. Use DescribeTransitGatewayAttachments to see the state of the attachment.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AssociateTransitGatewayMulticastDomainResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/AssociateTransitGatewayMulticastDomainRequest' - parameters: [] - /?Action=AssociateTransitGatewayRouteTable&Version=2016-11-15: - get: - x-aws-operation-name: AssociateTransitGatewayRouteTable - operationId: GET_AssociateTransitGatewayRouteTable - description: Associates the specified attachment with the specified transit gateway route table. You can associate only one route table with an attachment. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AssociateTransitGatewayRouteTableResult' - parameters: - - name: TransitGatewayRouteTableId - in: query - required: true - description: The ID of the transit gateway route table. - schema: - type: string - - name: TransitGatewayAttachmentId - in: query - required: true - description: The ID of the attachment. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: AssociateTransitGatewayRouteTable - operationId: POST_AssociateTransitGatewayRouteTable - description: Associates the specified attachment with the specified transit gateway route table. You can associate only one route table with an attachment. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AssociateTransitGatewayRouteTableResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/AssociateTransitGatewayRouteTableRequest' - parameters: [] - /?Action=AssociateTrunkInterface&Version=2016-11-15: - get: - x-aws-operation-name: AssociateTrunkInterface - operationId: GET_AssociateTrunkInterface - description: '

This API action is currently in limited preview only. If you are interested in using this feature, contact your account manager.

Associates a branch network interface with a trunk network interface.

Before you create the association, run the create-network-interface command and set --interface-type to trunk. You must also create a network interface for each branch network interface that you want to associate with the trunk network interface.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AssociateTrunkInterfaceResult' - parameters: - - name: BranchInterfaceId - in: query - required: true - description: The ID of the branch network interface. - schema: - type: string - - name: TrunkInterfaceId - in: query - required: true - description: The ID of the trunk network interface. - schema: - type: string - - name: VlanId - in: query - required: false - description: The ID of the VLAN. This applies to the VLAN protocol. - schema: - type: integer - - name: GreKey - in: query - required: false - description: The application key. This applies to the GRE protocol. - schema: - type: integer - - name: ClientToken - in: query - required: false - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.' - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: AssociateTrunkInterface - operationId: POST_AssociateTrunkInterface - description: '

This API action is currently in limited preview only. If you are interested in using this feature, contact your account manager.

Associates a branch network interface with a trunk network interface.

Before you create the association, run the create-network-interface command and set --interface-type to trunk. You must also create a network interface for each branch network interface that you want to associate with the trunk network interface.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AssociateTrunkInterfaceResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/AssociateTrunkInterfaceRequest' - parameters: [] - /?Action=AssociateVpcCidrBlock&Version=2016-11-15: - get: - x-aws-operation-name: AssociateVpcCidrBlock - operationId: GET_AssociateVpcCidrBlock - description: '

Associates a CIDR block with your VPC. You can associate a secondary IPv4 CIDR block, an Amazon-provided IPv6 CIDR block, or an IPv6 CIDR block from an IPv6 address pool that you provisioned through bring your own IP addresses (BYOIP). The IPv6 CIDR block size is fixed at /56.

You must specify one of the following in the request: an IPv4 CIDR block, an IPv6 pool, or an Amazon-provided IPv6 CIDR block.

For more information about associating CIDR blocks with your VPC and applicable restrictions, see VPC and subnet sizing in the Amazon Virtual Private Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AssociateVpcCidrBlockResult' - parameters: - - name: AmazonProvidedIpv6CidrBlock - in: query - required: false - description: 'Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IPv6 addresses, or the size of the CIDR block.' - schema: - type: boolean - - name: CidrBlock - in: query - required: false - description: An IPv4 CIDR block to associate with the VPC. - schema: - type: string - - name: VpcId - in: query - required: true - description: The ID of the VPC. - schema: - type: string - - name: Ipv6CidrBlockNetworkBorderGroup - in: query - required: false - description:

The name of the location from which we advertise the IPV6 CIDR block. Use this parameter to limit the CIDR block to this location.

You must set AmazonProvidedIpv6CidrBlock to true to use this parameter.

You can have one IPv6 CIDR block association per network border group.

- schema: - type: string - - name: Ipv6Pool - in: query - required: false - description: The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block. - schema: - type: string - - name: Ipv6CidrBlock - in: query - required: false - description: '

An IPv6 CIDR block from the IPv6 address pool. You must also specify Ipv6Pool in the request.

To let Amazon choose the IPv6 CIDR block for you, omit this parameter.

' - schema: - type: string - - name: Ipv4IpamPoolId - in: query - required: false - description: 'Associate a CIDR allocated from an IPv4 IPAM pool to a VPC. For more information about Amazon VPC IP Address Manager (IPAM), see What is IPAM? in the Amazon VPC IPAM User Guide.' - schema: - type: string - - name: Ipv4NetmaskLength - in: query - required: false - description: 'The netmask length of the IPv4 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide. ' - schema: - type: integer - - name: Ipv6IpamPoolId - in: query - required: false - description: 'Associates a CIDR allocated from an IPv6 IPAM pool to a VPC. For more information about Amazon VPC IP Address Manager (IPAM), see What is IPAM? in the Amazon VPC IPAM User Guide.' - schema: - type: string - - name: Ipv6NetmaskLength - in: query - required: false - description: 'The netmask length of the IPv6 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide. ' - schema: - type: integer - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: AssociateVpcCidrBlock - operationId: POST_AssociateVpcCidrBlock - description: '

Associates a CIDR block with your VPC. You can associate a secondary IPv4 CIDR block, an Amazon-provided IPv6 CIDR block, or an IPv6 CIDR block from an IPv6 address pool that you provisioned through bring your own IP addresses (BYOIP). The IPv6 CIDR block size is fixed at /56.

You must specify one of the following in the request: an IPv4 CIDR block, an IPv6 pool, or an Amazon-provided IPv6 CIDR block.

For more information about associating CIDR blocks with your VPC and applicable restrictions, see VPC and subnet sizing in the Amazon Virtual Private Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AssociateVpcCidrBlockResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/AssociateVpcCidrBlockRequest' - parameters: [] - /?Action=AttachClassicLinkVpc&Version=2016-11-15: - get: - x-aws-operation-name: AttachClassicLinkVpc - operationId: GET_AttachClassicLinkVpc - description: '

Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC''s security groups. You cannot link an EC2-Classic instance to more than one VPC at a time. You can only link an instance that''s in the running state. An instance is automatically unlinked from a VPC when it''s stopped - you can link it to the VPC again when you restart it.

After you''ve linked an instance, you cannot change the VPC security groups that are associated with it. To change the security groups, you must first unlink the instance, and then link it again.

Linking your instance to a VPC is sometimes referred to as attaching your instance.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AttachClassicLinkVpcResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: SecurityGroupId - in: query - required: true - description: The ID of one or more of the VPC's security groups. You cannot specify security groups from a different VPC. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/SecurityGroupId' - - xml: - name: groupId - - name: InstanceId - in: query - required: true - description: The ID of an EC2-Classic instance to link to the ClassicLink-enabled VPC. - schema: - type: string - - name: VpcId - in: query - required: true - description: The ID of a ClassicLink-enabled VPC. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: AttachClassicLinkVpc - operationId: POST_AttachClassicLinkVpc - description: '

Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC''s security groups. You cannot link an EC2-Classic instance to more than one VPC at a time. You can only link an instance that''s in the running state. An instance is automatically unlinked from a VPC when it''s stopped - you can link it to the VPC again when you restart it.

After you''ve linked an instance, you cannot change the VPC security groups that are associated with it. To change the security groups, you must first unlink the instance, and then link it again.

Linking your instance to a VPC is sometimes referred to as attaching your instance.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AttachClassicLinkVpcResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/AttachClassicLinkVpcRequest' - parameters: [] - /?Action=AttachInternetGateway&Version=2016-11-15: - get: - x-aws-operation-name: AttachInternetGateway - operationId: GET_AttachInternetGateway - description: 'Attaches an internet gateway or a virtual private gateway to a VPC, enabling connectivity between the internet and the VPC. For more information about your VPC and internet gateway, see the Amazon Virtual Private Cloud User Guide.' - responses: - '200': - description: Success - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: InternetGatewayId - in: query - required: true - description: The ID of the internet gateway. - schema: - type: string - - name: VpcId - in: query - required: true - description: The ID of the VPC. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: AttachInternetGateway - operationId: POST_AttachInternetGateway - description: 'Attaches an internet gateway or a virtual private gateway to a VPC, enabling connectivity between the internet and the VPC. For more information about your VPC and internet gateway, see the Amazon Virtual Private Cloud User Guide.' - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/AttachInternetGatewayRequest' - parameters: [] - /?Action=AttachNetworkInterface&Version=2016-11-15: - get: - x-aws-operation-name: AttachNetworkInterface - operationId: GET_AttachNetworkInterface - description: Attaches a network interface to an instance. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AttachNetworkInterfaceResult' - parameters: - - name: DeviceIndex - in: query - required: true - description: The index of the device for the network interface attachment. - schema: - type: integer - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: InstanceId - in: query - required: true - description: The ID of the instance. - schema: - type: string - - name: NetworkInterfaceId - in: query - required: true - description: The ID of the network interface. - schema: - type: string - - name: NetworkCardIndex - in: query - required: false - description: The index of the network card. Some instance types support multiple network cards. The primary network interface must be assigned to network card index 0. The default is network card index 0. - schema: - type: integer - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: AttachNetworkInterface - operationId: POST_AttachNetworkInterface - description: Attaches a network interface to an instance. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AttachNetworkInterfaceResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/AttachNetworkInterfaceRequest' - parameters: [] - /?Action=AttachVolume&Version=2016-11-15: - get: - x-aws-operation-name: AttachVolume - operationId: GET_AttachVolume - description: '

Attaches an EBS volume to a running or stopped instance and exposes it to the instance with the specified device name.

Encrypted EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.

After you attach an EBS volume, you must make it available. For more information, see Make an EBS volume available for use.

If a volume has an Amazon Web Services Marketplace product code:

  • The volume can be attached only to a stopped instance.

  • Amazon Web Services Marketplace product codes are copied from the volume to the instance.

  • You must be subscribed to the product.

  • The instance type and operating system of the instance must support the product. For example, you can''t detach a volume from a Windows instance and attach it to a Linux instance.

For more information, see Attach an Amazon EBS volume to an instance in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/VolumeAttachment' - parameters: - - name: Device - in: query - required: true - description: 'The device name (for example, /dev/sdh or xvdh).' - schema: - type: string - - name: InstanceId - in: query - required: true - description: The ID of the instance. - schema: - type: string - - name: VolumeId - in: query - required: true - description: The ID of the EBS volume. The volume and instance must be within the same Availability Zone. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: AttachVolume - operationId: POST_AttachVolume - description: '

Attaches an EBS volume to a running or stopped instance and exposes it to the instance with the specified device name.

Encrypted EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.

After you attach an EBS volume, you must make it available. For more information, see Make an EBS volume available for use.

If a volume has an Amazon Web Services Marketplace product code:

  • The volume can be attached only to a stopped instance.

  • Amazon Web Services Marketplace product codes are copied from the volume to the instance.

  • You must be subscribed to the product.

  • The instance type and operating system of the instance must support the product. For example, you can''t detach a volume from a Windows instance and attach it to a Linux instance.

For more information, see Attach an Amazon EBS volume to an instance in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/VolumeAttachment' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/AttachVolumeRequest' - parameters: [] - /?Action=AttachVpnGateway&Version=2016-11-15: - get: - x-aws-operation-name: AttachVpnGateway - operationId: GET_AttachVpnGateway - description: '

Attaches a virtual private gateway to a VPC. You can attach one virtual private gateway to one VPC at a time.

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AttachVpnGatewayResult' - parameters: - - name: VpcId - in: query - required: true - description: The ID of the VPC. - schema: - type: string - - name: VpnGatewayId - in: query - required: true - description: The ID of the virtual private gateway. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: AttachVpnGateway - operationId: POST_AttachVpnGateway - description: '

Attaches a virtual private gateway to a VPC. You can attach one virtual private gateway to one VPC at a time.

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AttachVpnGatewayResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/AttachVpnGatewayRequest' - parameters: [] - /?Action=AuthorizeClientVpnIngress&Version=2016-11-15: - get: - x-aws-operation-name: AuthorizeClientVpnIngress - operationId: GET_AuthorizeClientVpnIngress - description: Adds an ingress authorization rule to a Client VPN endpoint. Ingress authorization rules act as firewall rules that grant access to networks. You must configure ingress authorization rules to enable clients to access resources in Amazon Web Services or on-premises networks. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AuthorizeClientVpnIngressResult' - parameters: - - name: ClientVpnEndpointId - in: query - required: true - description: The ID of the Client VPN endpoint. - schema: - type: string - - name: TargetNetworkCidr - in: query - required: true - description: 'The IPv4 address range, in CIDR notation, of the network for which access is being authorized.' - schema: - type: string - - name: AccessGroupId - in: query - required: false - description: 'The ID of the group to grant access to, for example, the Active Directory group or identity provider (IdP) group. Required if AuthorizeAllGroups is false or not specified.' - schema: - type: string - - name: AuthorizeAllGroups - in: query - required: false - description: Indicates whether to grant access to all clients. Specify true to grant all clients who successfully establish a VPN connection access to the network. Must be set to true if AccessGroupId is not specified. - schema: - type: boolean - - name: Description - in: query - required: false - description: A brief description of the authorization rule. - schema: - type: string - - name: ClientToken - in: query - required: false - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.' - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: AuthorizeClientVpnIngress - operationId: POST_AuthorizeClientVpnIngress - description: Adds an ingress authorization rule to a Client VPN endpoint. Ingress authorization rules act as firewall rules that grant access to networks. You must configure ingress authorization rules to enable clients to access resources in Amazon Web Services or on-premises networks. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AuthorizeClientVpnIngressResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/AuthorizeClientVpnIngressRequest' - parameters: [] - /?Action=AuthorizeSecurityGroupEgress&Version=2016-11-15: - get: - x-aws-operation-name: AuthorizeSecurityGroupEgress - operationId: GET_AuthorizeSecurityGroupEgress - description: '

[VPC only] Adds the specified outbound (egress) rules to a security group for use with a VPC.

An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 CIDR address ranges, or to the instances that are associated with the specified source security groups.

You specify a protocol for each rule (for example, TCP). For the TCP and UDP protocols, you must also specify the destination port or port range. For the ICMP protocol, you must also specify the ICMP type and code. You can use -1 for the type or code to mean all types or all codes.

Rule changes are propagated to affected instances as quickly as possible. However, a small delay might occur.

For information about VPC security group quotas, see Amazon VPC quotas.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AuthorizeSecurityGroupEgressResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: GroupId - in: query - required: true - description: The ID of the security group. - schema: - type: string - - name: IpPermissions - in: query - required: false - description: The sets of IP permissions. You can't specify a destination security group and a CIDR IP address range in the same set of permissions. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/IpPermission' - - xml: - name: item - - name: TagSpecification - in: query - required: false - description: The tags applied to the security group rule. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - - name: CidrIp - in: query - required: false - description: Not supported. Use a set of IP permissions to specify the CIDR. - schema: - type: string - - name: FromPort - in: query - required: false - description: Not supported. Use a set of IP permissions to specify the port. - schema: - type: integer - - name: IpProtocol - in: query - required: false - description: Not supported. Use a set of IP permissions to specify the protocol name or number. - schema: - type: string - - name: ToPort - in: query - required: false - description: Not supported. Use a set of IP permissions to specify the port. - schema: - type: integer - - name: SourceSecurityGroupName - in: query - required: false - description: Not supported. Use a set of IP permissions to specify a destination security group. - schema: - type: string - - name: SourceSecurityGroupOwnerId - in: query - required: false - description: Not supported. Use a set of IP permissions to specify a destination security group. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: AuthorizeSecurityGroupEgress - operationId: POST_AuthorizeSecurityGroupEgress - description: '

[VPC only] Adds the specified outbound (egress) rules to a security group for use with a VPC.

An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 CIDR address ranges, or to the instances that are associated with the specified source security groups.

You specify a protocol for each rule (for example, TCP). For the TCP and UDP protocols, you must also specify the destination port or port range. For the ICMP protocol, you must also specify the ICMP type and code. You can use -1 for the type or code to mean all types or all codes.

Rule changes are propagated to affected instances as quickly as possible. However, a small delay might occur.

For information about VPC security group quotas, see Amazon VPC quotas.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AuthorizeSecurityGroupEgressResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/AuthorizeSecurityGroupEgressRequest' - parameters: [] - /?Action=AuthorizeSecurityGroupIngress&Version=2016-11-15: - get: - x-aws-operation-name: AuthorizeSecurityGroupIngress - operationId: GET_AuthorizeSecurityGroupIngress - description: '

Adds the specified inbound (ingress) rules to a security group.

An inbound rule permits instances to receive traffic from the specified IPv4 or IPv6 CIDR address range, or from the instances that are associated with the specified destination security groups.

You specify a protocol for each rule (for example, TCP). For TCP and UDP, you must also specify the destination port or port range. For ICMP/ICMPv6, you must also specify the ICMP/ICMPv6 type and code. You can use -1 to mean all types or all codes.

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

For more information about VPC security group quotas, see Amazon VPC quotas.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AuthorizeSecurityGroupIngressResult' - parameters: - - name: CidrIp - in: query - required: false - description: '

The IPv4 address range, in CIDR format. You can''t specify this parameter when specifying a source security group. To specify an IPv6 address range, use a set of IP permissions.

Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.

' - schema: - type: string - - name: FromPort - in: query - required: false - description: '

The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all types. If you specify all ICMP types, you must specify all codes.

Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.

' - schema: - type: integer - - name: GroupId - in: query - required: false - description: 'The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.' - schema: - type: string - - name: GroupName - in: query - required: false - description: '[EC2-Classic, default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request.' - schema: - type: string - - name: IpPermissions - in: query - required: false - description: The sets of IP permissions. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/IpPermission' - - xml: - name: item - - name: IpProtocol - in: query - required: false - description: '

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). To specify icmpv6, use a set of IP permissions.

[VPC only] Use -1 to specify all protocols. If you specify -1 or a protocol other than tcp, udp, or icmp, traffic on all ports is allowed, regardless of any ports you specify.

Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.

' - schema: - type: string - - name: SourceSecurityGroupName - in: query - required: false - description: '[EC2-Classic, default VPC] The name of the source security group. You can''t specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead. For EC2-VPC, the source security group must be in the same VPC.' - schema: - type: string - - name: SourceSecurityGroupOwnerId - in: query - required: false - description: '[nondefault VPC] The Amazon Web Services account ID for the source security group, if the source security group is in a different account. You can''t specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead.' - schema: - type: string - - name: ToPort - in: query - required: false - description: '

The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all codes. If you specify all ICMP types, you must specify all codes.

Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.

' - schema: - type: integer - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: TagSpecification - in: query - required: false - description: '[VPC Only] The tags applied to the security group rule.' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: AuthorizeSecurityGroupIngress - operationId: POST_AuthorizeSecurityGroupIngress - description: '

Adds the specified inbound (ingress) rules to a security group.

An inbound rule permits instances to receive traffic from the specified IPv4 or IPv6 CIDR address range, or from the instances that are associated with the specified destination security groups.

You specify a protocol for each rule (for example, TCP). For TCP and UDP, you must also specify the destination port or port range. For ICMP/ICMPv6, you must also specify the ICMP/ICMPv6 type and code. You can use -1 to mean all types or all codes.

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

For more information about VPC security group quotas, see Amazon VPC quotas.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/AuthorizeSecurityGroupIngressResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/AuthorizeSecurityGroupIngressRequest' - parameters: [] - /?Action=BundleInstance&Version=2016-11-15: - get: - x-aws-operation-name: BundleInstance - operationId: GET_BundleInstance - description: '

Bundles an Amazon instance store-backed Windows instance.

During bundling, only the root device volume (C:\) is bundled. Data on other instance store volumes is not preserved.

This action is not applicable for Linux/Unix instances or Windows instances that are backed by Amazon EBS.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/BundleInstanceResult' - parameters: - - name: InstanceId - in: query - required: true - description: '

The ID of the instance to bundle.

Type: String

Default: None

Required: Yes

' - schema: - type: string - - name: Storage - in: query - required: true - description: 'The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.' - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/S3Storage' - - description: An Amazon S3 storage location. - description: Describes the storage location for an instance store-backed AMI. - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: BundleInstance - operationId: POST_BundleInstance - description: '

Bundles an Amazon instance store-backed Windows instance.

During bundling, only the root device volume (C:\) is bundled. Data on other instance store volumes is not preserved.

This action is not applicable for Linux/Unix instances or Windows instances that are backed by Amazon EBS.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/BundleInstanceResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/BundleInstanceRequest' - parameters: [] - /?Action=CancelBundleTask&Version=2016-11-15: - get: - x-aws-operation-name: CancelBundleTask - operationId: GET_CancelBundleTask - description: Cancels a bundling operation for an instance store-backed Windows instance. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CancelBundleTaskResult' - parameters: - - name: BundleId - in: query - required: true - description: The ID of the bundle task. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CancelBundleTask - operationId: POST_CancelBundleTask - description: Cancels a bundling operation for an instance store-backed Windows instance. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CancelBundleTaskResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CancelBundleTaskRequest' - parameters: [] - /?Action=CancelCapacityReservation&Version=2016-11-15: - get: - x-aws-operation-name: CancelCapacityReservation - operationId: GET_CancelCapacityReservation - description: '

Cancels the specified Capacity Reservation, releases the reserved capacity, and changes the Capacity Reservation''s state to cancelled.

Instances running in the reserved capacity continue running until you stop them. Stopped instances that target the Capacity Reservation can no longer launch. Modify these instances to either target a different Capacity Reservation, launch On-Demand Instance capacity, or run in any open Capacity Reservation that has matching attributes and sufficient capacity.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CancelCapacityReservationResult' - parameters: - - name: CapacityReservationId - in: query - required: true - description: The ID of the Capacity Reservation to be cancelled. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CancelCapacityReservation - operationId: POST_CancelCapacityReservation - description: '

Cancels the specified Capacity Reservation, releases the reserved capacity, and changes the Capacity Reservation''s state to cancelled.

Instances running in the reserved capacity continue running until you stop them. Stopped instances that target the Capacity Reservation can no longer launch. Modify these instances to either target a different Capacity Reservation, launch On-Demand Instance capacity, or run in any open Capacity Reservation that has matching attributes and sufficient capacity.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CancelCapacityReservationResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CancelCapacityReservationRequest' - parameters: [] - /?Action=CancelCapacityReservationFleets&Version=2016-11-15: - get: - x-aws-operation-name: CancelCapacityReservationFleets - operationId: GET_CancelCapacityReservationFleets - description: '

Cancels one or more Capacity Reservation Fleets. When you cancel a Capacity Reservation Fleet, the following happens:

  • The Capacity Reservation Fleet''s status changes to cancelled.

  • The individual Capacity Reservations in the Fleet are cancelled. Instances running in the Capacity Reservations at the time of cancelling the Fleet continue to run in shared capacity.

  • The Fleet stops creating new Capacity Reservations.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CancelCapacityReservationFleetsResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: CapacityReservationFleetId - in: query - required: true - description: The IDs of the Capacity Reservation Fleets to cancel. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/CapacityReservationFleetId' - - xml: - name: item - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CancelCapacityReservationFleets - operationId: POST_CancelCapacityReservationFleets - description: '

Cancels one or more Capacity Reservation Fleets. When you cancel a Capacity Reservation Fleet, the following happens:

  • The Capacity Reservation Fleet''s status changes to cancelled.

  • The individual Capacity Reservations in the Fleet are cancelled. Instances running in the Capacity Reservations at the time of cancelling the Fleet continue to run in shared capacity.

  • The Fleet stops creating new Capacity Reservations.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CancelCapacityReservationFleetsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CancelCapacityReservationFleetsRequest' - parameters: [] - /?Action=CancelConversionTask&Version=2016-11-15: - get: - x-aws-operation-name: CancelConversionTask - operationId: GET_CancelConversionTask - description: '

Cancels an active conversion task. The task can be the import of an instance or volume. The action removes all artifacts of the conversion, including a partially uploaded volume or instance. If the conversion is complete or is in the process of transferring the final disk image, the command fails and returns an exception.

For more information, see Importing a Virtual Machine Using the Amazon EC2 CLI.

' - responses: - '200': - description: Success - parameters: - - name: ConversionTaskId - in: query - required: true - description: The ID of the conversion task. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: ReasonMessage - in: query - required: false - description: The reason for canceling the conversion task. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CancelConversionTask - operationId: POST_CancelConversionTask - description: '

Cancels an active conversion task. The task can be the import of an instance or volume. The action removes all artifacts of the conversion, including a partially uploaded volume or instance. If the conversion is complete or is in the process of transferring the final disk image, the command fails and returns an exception.

For more information, see Importing a Virtual Machine Using the Amazon EC2 CLI.

' - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CancelConversionRequest' - parameters: [] - /?Action=CancelExportTask&Version=2016-11-15: - get: - x-aws-operation-name: CancelExportTask - operationId: GET_CancelExportTask - description: 'Cancels an active export task. The request removes all artifacts of the export, including any partially-created Amazon S3 objects. If the export task is complete or is in the process of transferring the final disk image, the command fails and returns an error.' - responses: - '200': - description: Success - parameters: - - name: ExportTaskId - in: query - required: true - description: The ID of the export task. This is the ID returned by CreateInstanceExportTask. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CancelExportTask - operationId: POST_CancelExportTask - description: 'Cancels an active export task. The request removes all artifacts of the export, including any partially-created Amazon S3 objects. If the export task is complete or is in the process of transferring the final disk image, the command fails and returns an error.' - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CancelExportTaskRequest' - parameters: [] - /?Action=CancelImportTask&Version=2016-11-15: - get: - x-aws-operation-name: CancelImportTask - operationId: GET_CancelImportTask - description: Cancels an in-process import virtual machine or import snapshot task. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CancelImportTaskResult' - parameters: - - name: CancelReason - in: query - required: false - description: The reason for canceling the task. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: ImportTaskId - in: query - required: false - description: The ID of the import image or import snapshot task to be canceled. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CancelImportTask - operationId: POST_CancelImportTask - description: Cancels an in-process import virtual machine or import snapshot task. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CancelImportTaskResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CancelImportTaskRequest' - parameters: [] - /?Action=CancelReservedInstancesListing&Version=2016-11-15: - get: - x-aws-operation-name: CancelReservedInstancesListing - operationId: GET_CancelReservedInstancesListing - description: '

Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.

For more information, see Reserved Instance Marketplace in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CancelReservedInstancesListingResult' - parameters: - - name: ReservedInstancesListingId - in: query - required: true - description: The ID of the Reserved Instance listing. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CancelReservedInstancesListing - operationId: POST_CancelReservedInstancesListing - description: '

Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.

For more information, see Reserved Instance Marketplace in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CancelReservedInstancesListingResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CancelReservedInstancesListingRequest' - parameters: [] - /?Action=CancelSpotFleetRequests&Version=2016-11-15: - get: - x-aws-operation-name: CancelSpotFleetRequests - operationId: GET_CancelSpotFleetRequests - description: '

Cancels the specified Spot Fleet requests.

After you cancel a Spot Fleet request, the Spot Fleet launches no new Spot Instances. You must specify whether the Spot Fleet should also terminate its Spot Instances. If you terminate the instances, the Spot Fleet request enters the cancelled_terminating state. Otherwise, the Spot Fleet request enters the cancelled_running state and the instances continue to run until they are interrupted or you terminate them manually.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CancelSpotFleetRequestsResponse' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: SpotFleetRequestId - in: query - required: true - description: The IDs of the Spot Fleet requests. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/SpotFleetRequestId' - - xml: - name: item - - name: TerminateInstances - in: query - required: true - description: Indicates whether to terminate instances for a Spot Fleet request if it is canceled successfully. - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CancelSpotFleetRequests - operationId: POST_CancelSpotFleetRequests - description: '

Cancels the specified Spot Fleet requests.

After you cancel a Spot Fleet request, the Spot Fleet launches no new Spot Instances. You must specify whether the Spot Fleet should also terminate its Spot Instances. If you terminate the instances, the Spot Fleet request enters the cancelled_terminating state. Otherwise, the Spot Fleet request enters the cancelled_running state and the instances continue to run until they are interrupted or you terminate them manually.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CancelSpotFleetRequestsResponse' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CancelSpotFleetRequestsRequest' - parameters: [] - /?Action=CancelSpotInstanceRequests&Version=2016-11-15: - get: - x-aws-operation-name: CancelSpotInstanceRequests - operationId: GET_CancelSpotInstanceRequests - description:

Cancels one or more Spot Instance requests.

Canceling a Spot Instance request does not terminate running Spot Instances associated with the request.

 - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CancelSpotInstanceRequestsResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: SpotInstanceRequestId - in: query - required: true - description: One or more Spot Instance request IDs. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/SpotInstanceRequestId' - - xml: - name: SpotInstanceRequestId - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CancelSpotInstanceRequests - operationId: POST_CancelSpotInstanceRequests - description:

Cancels one or more Spot Instance requests.

Canceling a Spot Instance request does not terminate running Spot Instances associated with the request.

 - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CancelSpotInstanceRequestsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CancelSpotInstanceRequestsRequest' - parameters: [] - /?Action=ConfirmProductInstance&Version=2016-11-15: - get: - x-aws-operation-name: ConfirmProductInstance - operationId: GET_ConfirmProductInstance - description: Determines whether a product code is associated with an instance. This action can only be used by the owner of the product code. It is useful when a product code owner must verify whether another user's instance is eligible for support. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ConfirmProductInstanceResult' - parameters: - - name: InstanceId - in: query - required: true - description: The ID of the instance. - schema: - type: string - - name: ProductCode - in: query - required: true - description: The product code. This must be a product code that you own. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ConfirmProductInstance - operationId: POST_ConfirmProductInstance - description: Determines whether a product code is associated with an instance. This action can only be used by the owner of the product code. It is useful when a product code owner must verify whether another user's instance is eligible for support. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ConfirmProductInstanceResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ConfirmProductInstanceRequest' - parameters: [] - /?Action=CopyFpgaImage&Version=2016-11-15: - get: - x-aws-operation-name: CopyFpgaImage - operationId: GET_CopyFpgaImage - description: Copies the specified Amazon FPGA Image (AFI) to the current Region. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CopyFpgaImageResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: SourceFpgaImageId - in: query - required: true - description: The ID of the source AFI. - schema: - type: string - - name: Description - in: query - required: false - description: The description for the new AFI. - schema: - type: string - - name: Name - in: query - required: false - description: The name for the new AFI. The default is the name of the source AFI. - schema: - type: string - - name: SourceRegion - in: query - required: true - description: The Region that contains the source AFI. - schema: - type: string - - name: ClientToken - in: query - required: false - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.' - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CopyFpgaImage - operationId: POST_CopyFpgaImage - description: Copies the specified Amazon FPGA Image (AFI) to the current Region. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CopyFpgaImageResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CopyFpgaImageRequest' - parameters: [] - /?Action=CopyImage&Version=2016-11-15: - get: - x-aws-operation-name: CopyImage - operationId: GET_CopyImage - description: '

Initiates the copy of an AMI. You can copy an AMI from one Region to another, or from a Region to an Outpost. You can''t copy an AMI from an Outpost to a Region, from one Outpost to another, or within the same Outpost. To copy an AMI to another partition, see CreateStoreImageTask.

To copy an AMI from one Region to another, specify the source Region using the SourceRegion parameter, and specify the destination Region using its endpoint. Copies of encrypted backing snapshots for the AMI are encrypted. Copies of unencrypted backing snapshots remain unencrypted, unless you set Encrypted during the copy operation. You cannot create an unencrypted copy of an encrypted backing snapshot.

To copy an AMI from a Region to an Outpost, specify the source Region using the SourceRegion parameter, and specify the ARN of the destination Outpost using DestinationOutpostArn. Backing snapshots copied to an Outpost are encrypted by default using the default encryption key for the Region, or a different key that you specify in the request using KmsKeyId. Outposts do not support unencrypted snapshots. For more information, Amazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.

For more information about the prerequisites and limits when copying an AMI, see Copying an AMI in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CopyImageResult' - parameters: - - name: ClientToken - in: query - required: false - description: 'Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.' - schema: - type: string - - name: Description - in: query - required: false - description: A description for the new AMI in the destination Region. - schema: - type: string - - name: Encrypted - in: query - required: false - description: 'Specifies whether the destination snapshots of the copied image should be encrypted. You can encrypt a copy of an unencrypted snapshot, but you cannot create an unencrypted copy of an encrypted snapshot. The default KMS key for Amazon EBS is used unless you specify a non-default Key Management Service (KMS) KMS key using KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.' - schema: - type: boolean - - name: KmsKeyId - in: query - required: false - description: '

The identifier of the symmetric Key Management Service (KMS) KMS key to use when creating encrypted volumes. If this parameter is not specified, your Amazon Web Services managed KMS key for Amazon EBS is used. If you specify a KMS key, you must also set the encrypted state to true.

You can specify a KMS key using any of the following:

  • Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.

  • Key alias. For example, alias/ExampleAlias.

  • Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.

  • Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an identifier that is not valid, the action can appear to complete, but eventually fails.

The specified KMS key must exist in the destination Region.

Amazon EBS does not support asymmetric KMS keys.

' - schema: - type: string - - name: Name - in: query - required: true - description: The name of the new AMI in the destination Region. - schema: - type: string - - name: SourceImageId - in: query - required: true - description: The ID of the AMI to copy. - schema: - type: string - - name: SourceRegion - in: query - required: true - description: The name of the Region that contains the AMI to copy. - schema: - type: string - - name: DestinationOutpostArn - in: query - required: false - description: '

The Amazon Resource Name (ARN) of the Outpost to which to copy the AMI. Only specify this parameter when copying an AMI from an Amazon Web Services Region to an Outpost. The AMI must be in the Region of the destination Outpost. You cannot copy an AMI from an Outpost to a Region, from one Outpost to another, or within the same Outpost.

For more information, see Copying AMIs from an Amazon Web Services Region to an Outpost in the Amazon Elastic Compute Cloud User Guide.

' - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CopyImage - operationId: POST_CopyImage - description: '

Initiates the copy of an AMI. You can copy an AMI from one Region to another, or from a Region to an Outpost. You can''t copy an AMI from an Outpost to a Region, from one Outpost to another, or within the same Outpost. To copy an AMI to another partition, see CreateStoreImageTask.

To copy an AMI from one Region to another, specify the source Region using the SourceRegion parameter, and specify the destination Region using its endpoint. Copies of encrypted backing snapshots for the AMI are encrypted. Copies of unencrypted backing snapshots remain unencrypted, unless you set Encrypted during the copy operation. You cannot create an unencrypted copy of an encrypted backing snapshot.

To copy an AMI from a Region to an Outpost, specify the source Region using the SourceRegion parameter, and specify the ARN of the destination Outpost using DestinationOutpostArn. Backing snapshots copied to an Outpost are encrypted by default using the default encryption key for the Region, or a different key that you specify in the request using KmsKeyId. Outposts do not support unencrypted snapshots. For more information, Amazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.

For more information about the prerequisites and limits when copying an AMI, see Copying an AMI in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CopyImageResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CopyImageRequest' - parameters: [] - /?Action=CopySnapshot&Version=2016-11-15: - get: - x-aws-operation-name: CopySnapshot - operationId: GET_CopySnapshot - description: '

Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy a snapshot within the same Region, from one Region to another, or from a Region to an Outpost. You can''t copy a snapshot from an Outpost to a Region, from one Outpost to another, or within the same Outpost.

You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs).

When copying snapshots to a Region, copies of encrypted EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted, unless you enable encryption for the snapshot copy operation. By default, encrypted snapshot copies use the default Key Management Service (KMS) KMS key; however, you can specify a different KMS key. To copy an encrypted snapshot that has been shared from another account, you must have permissions for the KMS key used to encrypt the snapshot.

Snapshots copied to an Outpost are encrypted by default using the default encryption key for the Region, or a different key that you specify in the request using KmsKeyId. Outposts do not support unencrypted snapshots. For more information, Amazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.

Snapshots created by copying another snapshot have an arbitrary volume ID that should not be used for any purpose.

For more information, see Copy an Amazon EBS snapshot in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CopySnapshotResult' - parameters: - - name: Description - in: query - required: false - description: A description for the EBS snapshot. - schema: - type: string - - name: DestinationOutpostArn - in: query - required: false - description: '

The Amazon Resource Name (ARN) of the Outpost to which to copy the snapshot. Only specify this parameter when copying a snapshot from an Amazon Web Services Region to an Outpost. The snapshot must be in the Region for the destination Outpost. You cannot copy a snapshot from an Outpost to a Region, from one Outpost to another, or within the same Outpost.

For more information, see Copy snapshots from an Amazon Web Services Region to an Outpost in the Amazon Elastic Compute Cloud User Guide.

' - schema: - type: string - - name: DestinationRegion - in: query - required: false - description: '

The destination Region to use in the PresignedUrl parameter of a snapshot copy operation. This parameter is only valid for specifying the destination Region in a PresignedUrl parameter, where it is required.

The snapshot copy is sent to the regional endpoint that you sent the HTTP request to (for example, ec2.us-east-1.amazonaws.com). With the CLI, this is specified using the --region parameter or the default Region in your Amazon Web Services configuration file.

' - schema: - type: string - - name: Encrypted - in: query - required: false - description: 'To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter. Otherwise, omit this parameter. Encrypted snapshots are encrypted, even if you omit this parameter and encryption by default is not enabled. You cannot set this parameter to false. For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.' - schema: - type: boolean - - name: KmsKeyId - in: query - required: false - description: '

The identifier of the Key Management Service (KMS) KMS key to use for Amazon EBS encryption. If this parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId is specified, the encrypted state must be true.

You can specify the KMS key using any of the following:

  • Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.

  • Key alias. For example, alias/ExampleAlias.

  • Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.

  • Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.

' - schema: - type: string - - name: PresignedUrl - in: query - required: false - description: '

When you copy an encrypted source snapshot using the Amazon EC2 Query API, you must supply a pre-signed URL. This parameter is optional for unencrypted snapshots. For more information, see Query requests.

The PresignedUrl should use the snapshot source endpoint, the CopySnapshot action, and include the SourceRegion, SourceSnapshotId, and DestinationRegion parameters. The PresignedUrl must be signed using Amazon Web Services Signature Version 4. Because EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) in the Amazon Simple Storage Service API Reference. An invalid or improperly signed PresignedUrl will cause the copy operation to fail asynchronously, and the snapshot will move to an error state.

' - schema: - type: string - - name: SourceRegion - in: query - required: true - description: The ID of the Region that contains the snapshot to be copied. - schema: - type: string - - name: SourceSnapshotId - in: query - required: true - description: The ID of the EBS snapshot to copy. - schema: - type: string - - name: TagSpecification - in: query - required: false - description: The tags to apply to the new snapshot. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CopySnapshot - operationId: POST_CopySnapshot - description: '

Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy a snapshot within the same Region, from one Region to another, or from a Region to an Outpost. You can''t copy a snapshot from an Outpost to a Region, from one Outpost to another, or within the same Outpost.

You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs).

When copying snapshots to a Region, copies of encrypted EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted, unless you enable encryption for the snapshot copy operation. By default, encrypted snapshot copies use the default Key Management Service (KMS) KMS key; however, you can specify a different KMS key. To copy an encrypted snapshot that has been shared from another account, you must have permissions for the KMS key used to encrypt the snapshot.

Snapshots copied to an Outpost are encrypted by default using the default encryption key for the Region, or a different key that you specify in the request using KmsKeyId. Outposts do not support unencrypted snapshots. For more information, Amazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.

Snapshots created by copying another snapshot have an arbitrary volume ID that should not be used for any purpose.

For more information, see Copy an Amazon EBS snapshot in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CopySnapshotResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CopySnapshotRequest' - parameters: [] - /?Action=CreateCapacityReservation&Version=2016-11-15: - get: - x-aws-operation-name: CreateCapacityReservation - operationId: GET_CreateCapacityReservation - description: '

Creates a new Capacity Reservation with the specified attributes.

Capacity Reservations enable you to reserve capacity for your Amazon EC2 instances in a specific Availability Zone for any duration. This gives you the flexibility to selectively add capacity reservations and still get the Regional RI discounts for that usage. By creating Capacity Reservations, you ensure that you always have access to Amazon EC2 capacity when you need it, for as long as you need it. For more information, see Capacity Reservations in the Amazon EC2 User Guide.

Your request to create a Capacity Reservation could fail if Amazon EC2 does not have sufficient capacity to fulfill the request. If your request fails due to Amazon EC2 capacity constraints, either try again at a later time, try in a different Availability Zone, or request a smaller capacity reservation. If your application is flexible across instance types and sizes, try to create a Capacity Reservation with different instance attributes.

Your request could also fail if the requested quantity exceeds your On-Demand Instance limit for the selected instance type. If your request fails due to limit constraints, increase your On-Demand Instance limit for the required instance type and try again. For more information about increasing your instance limits, see Amazon EC2 Service Quotas in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateCapacityReservationResult' - parameters: - - name: ClientToken - in: query - required: false - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.' - schema: - type: string - - name: InstanceType - in: query - required: true - description: 'The instance type for which to reserve capacity. For more information, see Instance types in the Amazon EC2 User Guide.' - schema: - type: string - - name: InstancePlatform - in: query - required: true - description: The type of operating system for which to reserve capacity. - schema: - type: string - enum: - - Linux/UNIX - - Red Hat Enterprise Linux - - SUSE Linux - - Windows - - Windows with SQL Server - - Windows with SQL Server Enterprise - - Windows with SQL Server Standard - - Windows with SQL Server Web - - Linux with SQL Server Standard - - Linux with SQL Server Web - - Linux with SQL Server Enterprise - - RHEL with SQL Server Standard - - RHEL with SQL Server Enterprise - - RHEL with SQL Server Web - - RHEL with HA - - RHEL with HA and SQL Server Standard - - RHEL with HA and SQL Server Enterprise - - name: AvailabilityZone - in: query - required: false - description: The Availability Zone in which to create the Capacity Reservation. - schema: - type: string - - name: AvailabilityZoneId - in: query - required: false - description: The ID of the Availability Zone in which to create the Capacity Reservation. - schema: - type: string - - name: Tenancy - in: query - required: false - description: '

Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:

  • default - The Capacity Reservation is created on hardware that is shared with other Amazon Web Services accounts.

  • dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.

' - schema: - type: string - enum: - - default - - dedicated - - name: InstanceCount - in: query - required: true - description: '

The number of instances for which to reserve capacity.

Valid range: 1 - 1000

' - schema: - type: integer - - name: EbsOptimized - in: query - required: false - description: Indicates whether the Capacity Reservation supports EBS-optimized instances. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS- optimized instance. - schema: - type: boolean - - name: EphemeralStorage - in: query - required: false - description: 'Indicates whether the Capacity Reservation supports instances with temporary, block-level storage.' - schema: - type: boolean - - name: EndDate - in: query - required: false - description: '

The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation''s state changes to expired when it reaches its end date and time.

You must provide an EndDate value if EndDateType is limited. Omit EndDate if EndDateType is unlimited.

If the EndDateType is limited, the Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019.

' - schema: - type: string - format: date-time - - name: EndDateType - in: query - required: false - description: '

Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:

  • unlimited - The Capacity Reservation remains active until you explicitly cancel it. Do not provide an EndDate if the EndDateType is unlimited.

  • limited - The Capacity Reservation expires automatically at a specified date and time. You must provide an EndDate value if the EndDateType value is limited.

' - schema: - type: string - enum: - - unlimited - - limited - - name: InstanceMatchCriteria - in: query - required: false - description: '

Indicates the type of instance launches that the Capacity Reservation accepts. The options include:

  • open - The Capacity Reservation automatically matches all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes run in the Capacity Reservation automatically without specifying any additional parameters.

  • targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.

Default: open

' - schema: - type: string - enum: - - open - - targeted - - name: TagSpecifications - in: query - required: false - description: The tags to apply to the Capacity Reservation during launch. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: OutpostArn - in: query - required: false - description: The Amazon Resource Name (ARN) of the Outpost on which to create the Capacity Reservation. - schema: - type: string - pattern: '^arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/op-[a-f0-9]{17}$' - - name: PlacementGroupArn - in: query - required: false - description: 'The Amazon Resource Name (ARN) of the cluster placement group in which to create the Capacity Reservation. For more information, see Capacity Reservations for cluster placement groups in the Amazon EC2 User Guide.' - schema: - type: string - pattern: '^arn:aws([a-z-]+)?:ec2:[a-z\d-]+:\d{12}:placement-group/([^\s].+[^\s]){1,255}$' - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateCapacityReservation - operationId: POST_CreateCapacityReservation - description: '

Creates a new Capacity Reservation with the specified attributes.

Capacity Reservations enable you to reserve capacity for your Amazon EC2 instances in a specific Availability Zone for any duration. This gives you the flexibility to selectively add capacity reservations and still get the Regional RI discounts for that usage. By creating Capacity Reservations, you ensure that you always have access to Amazon EC2 capacity when you need it, for as long as you need it. For more information, see Capacity Reservations in the Amazon EC2 User Guide.

Your request to create a Capacity Reservation could fail if Amazon EC2 does not have sufficient capacity to fulfill the request. If your request fails due to Amazon EC2 capacity constraints, either try again at a later time, try in a different Availability Zone, or request a smaller capacity reservation. If your application is flexible across instance types and sizes, try to create a Capacity Reservation with different instance attributes.

Your request could also fail if the requested quantity exceeds your On-Demand Instance limit for the selected instance type. If your request fails due to limit constraints, increase your On-Demand Instance limit for the required instance type and try again. For more information about increasing your instance limits, see Amazon EC2 Service Quotas in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateCapacityReservationResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateCapacityReservationRequest' - parameters: [] - /?Action=CreateCapacityReservationFleet&Version=2016-11-15: - get: - x-aws-operation-name: CreateCapacityReservationFleet - operationId: GET_CreateCapacityReservationFleet - description: 'Creates a Capacity Reservation Fleet. For more information, see Create a Capacity Reservation Fleet in the Amazon EC2 User Guide.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateCapacityReservationFleetResult' - parameters: - - name: AllocationStrategy - in: query - required: false - description: '

The strategy used by the Capacity Reservation Fleet to determine which of the specified instance types to use. Currently, only the prioritized allocation strategy is supported. For more information, see Allocation strategy in the Amazon EC2 User Guide.

Valid values: prioritized

' - schema: - type: string - - name: ClientToken - in: query - required: false - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.' - schema: - type: string - - name: InstanceTypeSpecification - in: query - required: true - description: Information about the instance types for which to reserve the capacity. - schema: - type: array - items: - $ref: '#/components/schemas/ReservationFleetInstanceSpecification' - - name: Tenancy - in: query - required: false - description: '

Indicates the tenancy of the Capacity Reservation Fleet. All Capacity Reservations in the Fleet inherit this tenancy. The Capacity Reservation Fleet can have one of the following tenancy settings:

  • default - The Capacity Reservation Fleet is created on hardware that is shared with other Amazon Web Services accounts.

  • dedicated - The Capacity Reservations are created on single-tenant hardware that is dedicated to a single Amazon Web Services account.

' - schema: - type: string - enum: - - default - - name: TotalTargetCapacity - in: query - required: true - description: 'The total number of capacity units to be reserved by the Capacity Reservation Fleet. This value, together with the instance type weights that you assign to each instance type used by the Fleet determine the number of instances for which the Fleet reserves capacity. Both values are based on units that make sense for your workload. For more information, see Total target capacity in the Amazon EC2 User Guide.' - schema: - type: integer - - name: EndDate - in: query - required: false - description: '

The date and time at which the Capacity Reservation Fleet expires. When the Capacity Reservation Fleet expires, its state changes to expired and all of the Capacity Reservations in the Fleet expire.

The Capacity Reservation Fleet expires within an hour after the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation Fleet is guaranteed to expire between 13:30:55 and 14:30:55 on 5/31/2019.

' - schema: - type: string - format: date-time - - name: InstanceMatchCriteria - in: query - required: false - description: '

Indicates the type of instance launches that the Capacity Reservation Fleet accepts. All Capacity Reservations in the Fleet inherit this instance matching criteria.

Currently, Capacity Reservation Fleets support open instance matching criteria only. This means that instances that have matching attributes (instance type, platform, and Availability Zone) run in the Capacity Reservations automatically. Instances do not need to explicitly target a Capacity Reservation Fleet to use its reserved capacity.

' - schema: - type: string - enum: - - open - - name: TagSpecification - in: query - required: false - description: The tags to assign to the Capacity Reservation Fleet. The tags are automatically assigned to the Capacity Reservations in the Fleet. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateCapacityReservationFleet - operationId: POST_CreateCapacityReservationFleet - description: 'Creates a Capacity Reservation Fleet. For more information, see Create a Capacity Reservation Fleet in the Amazon EC2 User Guide.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateCapacityReservationFleetResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateCapacityReservationFleetRequest' - parameters: [] - /?Action=CreateCarrierGateway&Version=2016-11-15: - get: - x-aws-operation-name: CreateCarrierGateway - operationId: GET_CreateCarrierGateway - description: 'Creates a carrier gateway. For more information about carrier gateways, see Carrier gateways in the Amazon Web Services Wavelength Developer Guide.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateCarrierGatewayResult' - parameters: - - name: VpcId - in: query - required: true - description: The ID of the VPC to associate with the carrier gateway. - schema: - type: string - - name: TagSpecification - in: query - required: false - description: The tags to associate with the carrier gateway. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: ClientToken - in: query - required: false - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.' - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateCarrierGateway - operationId: POST_CreateCarrierGateway - description: 'Creates a carrier gateway. For more information about carrier gateways, see Carrier gateways in the Amazon Web Services Wavelength Developer Guide.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateCarrierGatewayResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateCarrierGatewayRequest' - parameters: [] - /?Action=CreateClientVpnEndpoint&Version=2016-11-15: - get: - x-aws-operation-name: CreateClientVpnEndpoint - operationId: GET_CreateClientVpnEndpoint - description: Creates a Client VPN endpoint. A Client VPN endpoint is the resource you create and configure to enable and manage client VPN sessions. It is the destination endpoint at which all client VPN sessions are terminated. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateClientVpnEndpointResult' - parameters: - - name: ClientCidrBlock - in: query - required: true - description: '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. The CIDR block should be /22 or greater.' - schema: - type: string - - name: ServerCertificateArn - in: query - required: true - description: 'The ARN of the server certificate. For more information, see the Certificate Manager User Guide.' - schema: - type: string - - name: Authentication - in: query - required: true - description: Information about the authentication method to be used to authenticate clients. - schema: - type: array - items: - $ref: '#/components/schemas/ClientVpnAuthenticationRequest' - - name: ConnectionLogOptions - in: query - required: true - description: '

Information about the client connection logging options.

If you enable client connection logging, data about client connections is sent to a Cloudwatch Logs log stream. The following information is logged:

  • Client connection requests

  • Client connection results (successful and unsuccessful)

  • Reasons for unsuccessful client connection requests

  • Client connection termination time

' - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of the CloudWatch Logs log stream to which the connection data is published. - description: Describes the client connection logging options for the Client VPN endpoint. - - name: DnsServers - in: query - required: false - description: 'Information about the DNS servers to be used for DNS resolution. A Client VPN endpoint can have up to two DNS servers. If no DNS server is specified, the DNS address configured on the device is used for the DNS server.' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - - name: TransportProtocol - in: query - required: false - description: '

The transport protocol to be used by the VPN session.

Default value: udp

' - schema: - type: string - enum: - - tcp - - udp - - name: VpnPort - in: query - required: false - description: '

The port number to assign to the Client VPN endpoint for TCP and UDP traffic.

Valid Values: 443 | 1194

Default Value: 443

' - schema: - type: integer - - name: Description - in: query - required: false - description: A brief description of the Client VPN endpoint. - schema: - type: string - - name: SplitTunnel - in: query - required: false - description: '

Indicates whether split-tunnel is enabled on the Client VPN endpoint.

By default, split-tunnel on a VPN endpoint is disabled.

For information about split-tunnel VPN endpoints, see Split-tunnel Client VPN endpoint in the Client VPN Administrator Guide.

' - schema: - type: boolean - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: ClientToken - in: query - required: false - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.' - schema: - type: string - - name: TagSpecification - in: query - required: false - description: The tags to apply to the Client VPN endpoint during creation. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - - name: SecurityGroupId - in: query - required: false - description: The IDs of one or more security groups to apply to the target network. You must also specify the ID of the VPC that contains the security groups. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/SecurityGroupId' - - xml: - name: item - - name: VpcId - in: query - required: false - description: 'The ID of the VPC to associate with the Client VPN endpoint. If no security group IDs are specified in the request, the default security group for the VPC is applied.' - schema: - type: string - - name: SelfServicePortal - in: query - required: false - description: '

Specify whether to enable the self-service portal for the Client VPN endpoint.

Default Value: enabled

' - schema: - type: string - enum: - - enabled - - disabled - - name: ClientConnectOptions - in: query - required: false - description: The options for managing connection authorization for new client connections. - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Resource Name (ARN) of the Lambda function used for connection authorization. - description: The options for managing connection authorization for new client connections. - - name: SessionTimeoutHours - in: query - required: false - description: '

The maximum VPN session duration time in hours.

Valid values: 8 | 10 | 12 | 24

Default value: 24

' - schema: - type: integer - - name: ClientLoginBannerOptions - in: query - required: false - description: Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established. - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: Customizable text that will be displayed in a banner on Amazon Web Services provided clients when a VPN session is established. UTF-8 encoded characters only. Maximum of 1400 characters. - description: Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established. - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateClientVpnEndpoint - operationId: POST_CreateClientVpnEndpoint - description: Creates a Client VPN endpoint. A Client VPN endpoint is the resource you create and configure to enable and manage client VPN sessions. It is the destination endpoint at which all client VPN sessions are terminated. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateClientVpnEndpointResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateClientVpnEndpointRequest' - parameters: [] - /?Action=CreateClientVpnRoute&Version=2016-11-15: - get: - x-aws-operation-name: CreateClientVpnRoute - operationId: GET_CreateClientVpnRoute - description: Adds a route to a network to a Client VPN endpoint. Each Client VPN endpoint has a route table that describes the available destination network routes. Each route in the route table specifies the path for traffic to specific resources or networks. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateClientVpnRouteResult' - parameters: - - name: ClientVpnEndpointId - in: query - required: true - description: The ID of the Client VPN endpoint to which to add the route. - schema: - type: string - - name: DestinationCidrBlock - in: query - required: true - description: '

The IPv4 address range, in CIDR notation, of the route destination. For example:

  • To add a route for Internet access, enter 0.0.0.0/0

  • To add a route for a peered VPC, enter the peered VPC''s IPv4 CIDR range

  • To add a route for an on-premises network, enter the Amazon Web Services Site-to-Site VPN connection''s IPv4 CIDR range

  • To add a route for the local network, enter the client CIDR range

' - schema: - type: string - - name: TargetVpcSubnetId - in: query - required: true - description: '

The ID of the subnet through which you want to route traffic. The specified subnet must be an existing target network of the Client VPN endpoint.

Alternatively, if you''re adding a route for the local network, specify local.

' - schema: - type: string - - name: Description - in: query - required: false - description: A brief description of the route. - schema: - type: string - - name: ClientToken - in: query - required: false - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.' - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateClientVpnRoute - operationId: POST_CreateClientVpnRoute - description: Adds a route to a network to a Client VPN endpoint. Each Client VPN endpoint has a route table that describes the available destination network routes. Each route in the route table specifies the path for traffic to specific resources or networks. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateClientVpnRouteResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateClientVpnRouteRequest' - parameters: [] - /?Action=CreateCustomerGateway&Version=2016-11-15: - get: - x-aws-operation-name: CreateCustomerGateway - operationId: GET_CreateCustomerGateway - description: '

Provides information to Amazon Web Services about your VPN customer gateway device. The customer gateway is the appliance at your end of the VPN connection. (The device on the Amazon Web Services side of the VPN connection is the virtual private gateway.) You must provide the internet-routable IP address of the customer gateway''s external interface. The IP address must be static and can be behind a device performing network address translation (NAT).

For devices that use Border Gateway Protocol (BGP), you can also provide the device''s BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network. If you don''t have an ASN already, you can use a private ASN. For more information, see Customer gateway options for your Site-to-Site VPN connection in the Amazon Web Services Site-to-Site VPN User Guide.

To create more than one customer gateway with the same VPN type, IP address, and BGP ASN, specify a unique device name for each customer gateway. An identical request returns information about the existing customer gateway; it doesn''t create a new customer gateway.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateCustomerGatewayResult' - parameters: - - name: BgpAsn - in: query - required: true - description: '

For devices that support BGP, the customer gateway''s BGP ASN.

Default: 65000

' - schema: - type: integer - - name: IpAddress - in: query - required: false - description: The Internet-routable IP address for the customer gateway's outside interface. The address must be static. - schema: - type: string - - name: CertificateArn - in: query - required: false - description: The Amazon Resource Name (ARN) for the customer gateway certificate. - schema: - type: string - - name: Type - in: query - required: true - description: The type of VPN connection that this customer gateway supports (ipsec.1). - schema: - type: string - enum: - - ipsec.1 - - name: TagSpecification - in: query - required: false - description: The tags to apply to the customer gateway. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - - name: DeviceName - in: query - required: false - description: '

A name for the customer gateway device.

Length Constraints: Up to 255 characters.

' - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateCustomerGateway - operationId: POST_CreateCustomerGateway - description: '

Provides information to Amazon Web Services about your VPN customer gateway device. The customer gateway is the appliance at your end of the VPN connection. (The device on the Amazon Web Services side of the VPN connection is the virtual private gateway.) You must provide the internet-routable IP address of the customer gateway''s external interface. The IP address must be static and can be behind a device performing network address translation (NAT).

For devices that use Border Gateway Protocol (BGP), you can also provide the device''s BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network. If you don''t have an ASN already, you can use a private ASN. For more information, see Customer gateway options for your Site-to-Site VPN connection in the Amazon Web Services Site-to-Site VPN User Guide.

To create more than one customer gateway with the same VPN type, IP address, and BGP ASN, specify a unique device name for each customer gateway. An identical request returns information about the existing customer gateway; it doesn''t create a new customer gateway.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateCustomerGatewayResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateCustomerGatewayRequest' - parameters: [] - /?Action=CreateDefaultSubnet&Version=2016-11-15: - get: - x-aws-operation-name: CreateDefaultSubnet - operationId: GET_CreateDefaultSubnet - description: 'Creates a default subnet with a size /20 IPv4 CIDR block in the specified Availability Zone in your default VPC. You can have only one default subnet per Availability Zone. For more information, see Creating a default subnet in the Amazon Virtual Private Cloud User Guide.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateDefaultSubnetResult' - parameters: - - name: AvailabilityZone - in: query - required: true - description: The Availability Zone in which to create the default subnet. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: Ipv6Native - in: query - required: false - description: 'Indicates whether to create an IPv6 only subnet. If you already have a default subnet for this Availability Zone, you must delete it before you can create an IPv6 only subnet.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateDefaultSubnet - operationId: POST_CreateDefaultSubnet - description: 'Creates a default subnet with a size /20 IPv4 CIDR block in the specified Availability Zone in your default VPC. You can have only one default subnet per Availability Zone. For more information, see Creating a default subnet in the Amazon Virtual Private Cloud User Guide.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateDefaultSubnetResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateDefaultSubnetRequest' - parameters: [] - /?Action=CreateDefaultVpc&Version=2016-11-15: - get: - x-aws-operation-name: CreateDefaultVpc - operationId: GET_CreateDefaultVpc - description: '

Creates a default VPC with a size /16 IPv4 CIDR block and a default subnet in each Availability Zone. For more information about the components of a default VPC, see Default VPC and default subnets in the Amazon Virtual Private Cloud User Guide. You cannot specify the components of the default VPC yourself.

If you deleted your previous default VPC, you can create a default VPC. You cannot have more than one default VPC per Region.

If your account supports EC2-Classic, you cannot use this action to create a default VPC in a Region that supports EC2-Classic. If you want a default VPC in a Region that supports EC2-Classic, see "I really want a default VPC for my existing EC2 account. Is that possible?" in the Default VPCs FAQ.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateDefaultVpcResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateDefaultVpc - operationId: POST_CreateDefaultVpc - description: '

Creates a default VPC with a size /16 IPv4 CIDR block and a default subnet in each Availability Zone. For more information about the components of a default VPC, see Default VPC and default subnets in the Amazon Virtual Private Cloud User Guide. You cannot specify the components of the default VPC yourself.

If you deleted your previous default VPC, you can create a default VPC. You cannot have more than one default VPC per Region.

If your account supports EC2-Classic, you cannot use this action to create a default VPC in a Region that supports EC2-Classic. If you want a default VPC in a Region that supports EC2-Classic, see "I really want a default VPC for my existing EC2 account. Is that possible?" in the Default VPCs FAQ.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateDefaultVpcResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateDefaultVpcRequest' - parameters: [] - /?Action=CreateDhcpOptions&Version=2016-11-15: - get: - x-aws-operation-name: CreateDhcpOptions - operationId: GET_CreateDhcpOptions - description: '

Creates a set of DHCP options for your VPC. After creating the set, you must associate it with the VPC, causing all existing and new instances that you launch in the VPC to use this set of DHCP options. The following are the individual DHCP options you can specify. For more information about the options, see RFC 2132.

  • domain-name-servers - The IP addresses of up to four domain name servers, or AmazonProvidedDNS. The default DHCP option set specifies AmazonProvidedDNS. If specifying more than one domain name server, specify the IP addresses in a single parameter, separated by commas. To have your instance receive a custom DNS hostname as specified in domain-name, you must set domain-name-servers to a custom DNS server.

  • domain-name - If you''re using AmazonProvidedDNS in us-east-1, specify ec2.internal. If you''re using AmazonProvidedDNS in another Region, specify region.compute.internal (for example, ap-northeast-1.compute.internal). Otherwise, specify a domain name (for example, ExampleCompany.com). This value is used to complete unqualified DNS hostnames. Important: Some Linux operating systems accept multiple domain names separated by spaces. However, Windows and other Linux operating systems treat the value as a single domain, which results in unexpected behavior. If your DHCP options set is associated with a VPC that has instances with multiple operating systems, specify only one domain name.

  • ntp-servers - The IP addresses of up to four Network Time Protocol (NTP) servers.

  • netbios-name-servers - The IP addresses of up to four NetBIOS name servers.

  • netbios-node-type - The NetBIOS node type (1, 2, 4, or 8). We recommend that you specify 2 (broadcast and multicast are not currently supported). For more information about these node types, see RFC 2132.

Your VPC automatically starts out with a set of DHCP options that includes only a DNS server that we provide (AmazonProvidedDNS). If you create a set of options, and if your VPC has an internet gateway, make sure to set the domain-name-servers option either to AmazonProvidedDNS or to a domain name server of your choice. For more information, see DHCP options sets in the Amazon Virtual Private Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateDhcpOptionsResult' - parameters: - - name: DhcpConfiguration - in: query - required: true - description: A DHCP configuration option. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/NewDhcpConfiguration' - - xml: - name: item - - name: TagSpecification - in: query - required: false - description: The tags to assign to the DHCP option. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateDhcpOptions - operationId: POST_CreateDhcpOptions - description: '

Creates a set of DHCP options for your VPC. After creating the set, you must associate it with the VPC, causing all existing and new instances that you launch in the VPC to use this set of DHCP options. The following are the individual DHCP options you can specify. For more information about the options, see RFC 2132.

  • domain-name-servers - The IP addresses of up to four domain name servers, or AmazonProvidedDNS. The default DHCP option set specifies AmazonProvidedDNS. If specifying more than one domain name server, specify the IP addresses in a single parameter, separated by commas. To have your instance receive a custom DNS hostname as specified in domain-name, you must set domain-name-servers to a custom DNS server.

  • domain-name - If you''re using AmazonProvidedDNS in us-east-1, specify ec2.internal. If you''re using AmazonProvidedDNS in another Region, specify region.compute.internal (for example, ap-northeast-1.compute.internal). Otherwise, specify a domain name (for example, ExampleCompany.com). This value is used to complete unqualified DNS hostnames. Important: Some Linux operating systems accept multiple domain names separated by spaces. However, Windows and other Linux operating systems treat the value as a single domain, which results in unexpected behavior. If your DHCP options set is associated with a VPC that has instances with multiple operating systems, specify only one domain name.

  • ntp-servers - The IP addresses of up to four Network Time Protocol (NTP) servers.

  • netbios-name-servers - The IP addresses of up to four NetBIOS name servers.

  • netbios-node-type - The NetBIOS node type (1, 2, 4, or 8). We recommend that you specify 2 (broadcast and multicast are not currently supported). For more information about these node types, see RFC 2132.

Your VPC automatically starts out with a set of DHCP options that includes only a DNS server that we provide (AmazonProvidedDNS). If you create a set of options, and if your VPC has an internet gateway, make sure to set the domain-name-servers option either to AmazonProvidedDNS or to a domain name server of your choice. For more information, see DHCP options sets in the Amazon Virtual Private Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateDhcpOptionsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateDhcpOptionsRequest' - parameters: [] - /?Action=CreateEgressOnlyInternetGateway&Version=2016-11-15: - get: - x-aws-operation-name: CreateEgressOnlyInternetGateway - operationId: GET_CreateEgressOnlyInternetGateway - description: '[IPv6 only] Creates an egress-only internet gateway for your VPC. An egress-only internet gateway is used to enable outbound communication over IPv6 from instances in your VPC to the internet, and prevents hosts outside of your VPC from initiating an IPv6 connection with your instance.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateEgressOnlyInternetGatewayResult' - parameters: - - name: ClientToken - in: query - required: false - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.' - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: VpcId - in: query - required: true - description: The ID of the VPC for which to create the egress-only internet gateway. - schema: - type: string - - name: TagSpecification - in: query - required: false - description: The tags to assign to the egress-only internet gateway. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateEgressOnlyInternetGateway - operationId: POST_CreateEgressOnlyInternetGateway - description: '[IPv6 only] Creates an egress-only internet gateway for your VPC. An egress-only internet gateway is used to enable outbound communication over IPv6 from instances in your VPC to the internet, and prevents hosts outside of your VPC from initiating an IPv6 connection with your instance.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateEgressOnlyInternetGatewayResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateEgressOnlyInternetGatewayRequest' - parameters: [] - /?Action=CreateFleet&Version=2016-11-15: - get: - x-aws-operation-name: CreateFleet - operationId: GET_CreateFleet - description: '

Launches an EC2 Fleet.

You can create a single EC2 Fleet that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.

For more information, see EC2 Fleet in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateFleetResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: ClientToken - in: query - required: false - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.' - schema: - type: string - - name: SpotOptions - in: query - required: false - description: Describes the configuration of Spot Instances in an EC2 Fleet. - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The maximum amount per hour for Spot Instances that you're willing to pay. - description: Describes the configuration of Spot Instances in an EC2 Fleet request. - - name: OnDemandOptions - in: query - required: false - description: Describes the configuration of On-Demand Instances in an EC2 Fleet. - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The maximum amount per hour for On-Demand Instances that you're willing to pay. - description: Describes the configuration of On-Demand Instances in an EC2 Fleet. - - name: ExcessCapacityTerminationPolicy - in: query - required: false - description: Indicates whether running instances should be terminated if the total target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet. - schema: - type: string - enum: - - no-termination - - termination - - name: LaunchTemplateConfigs - in: query - required: true - description: The configuration for the EC2 Fleet. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/FleetLaunchTemplateConfigRequest' - - xml: - name: item - minItems: 0 - maxItems: 50 - - name: TargetCapacitySpecification - in: query - required: true - description: The number of units to request. - schema: - type: object - required: - - TotalTargetCapacity - properties: - undefined: - allOf: - - $ref: '#/components/schemas/TargetCapacityUnitType' - - description: '

The unit for the target capacity.

Default: units (translates to number of instances)

' - description: '

The number of units to request. You can choose to set the target capacity as the number of instances. Or you can set the target capacity to a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.

You can use the On-Demand Instance MaxTotalPrice parameter, the Spot Instance MaxTotalPrice parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, EC2 Fleet will launch instances until it reaches the maximum amount that you''re willing to pay. When the maximum amount you''re willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity. The MaxTotalPrice parameters are located in OnDemandOptionsRequest and SpotOptionsRequest.

' - - name: TerminateInstancesWithExpiration - in: query - required: false - description: Indicates whether running instances should be terminated when the EC2 Fleet expires. - schema: - type: boolean - - name: Type - in: query - required: false - description: '

The fleet type. The default value is maintain.

  • maintain - The EC2 Fleet places an asynchronous request for your desired capacity, and continues to maintain your desired Spot capacity by replenishing interrupted Spot Instances.

  • request - The EC2 Fleet places an asynchronous one-time request for your desired capacity, but does submit Spot requests in alternative capacity pools if Spot capacity is unavailable, and does not maintain Spot capacity if Spot Instances are interrupted.

  • instant - The EC2 Fleet places a synchronous one-time request for your desired capacity, and returns errors for any instances that could not be launched.

For more information, see EC2 Fleet request types in the Amazon EC2 User Guide.

' - schema: - type: string - enum: - - request - - maintain - - instant - - name: ValidFrom - in: query - required: false - description: 'The start date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The default is to start fulfilling the request immediately.' - schema: - type: string - format: date-time - - name: ValidUntil - in: query - required: false - description: 'The end date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). At this point, no new EC2 Fleet requests are placed or able to fulfill the request. If no value is specified, the request remains until you cancel it.' - schema: - type: string - format: date-time - - name: ReplaceUnhealthyInstances - in: query - required: false - description: 'Indicates whether EC2 Fleet should replace unhealthy Spot Instances. Supported only for fleets of type maintain. For more information, see EC2 Fleet health checks in the Amazon EC2 User Guide.' - schema: - type: boolean - - name: TagSpecification - in: query - required: false - description: '

The key-value pair for tagging the EC2 Fleet request on creation. For more information, see Tagging your resources.

If the fleet type is instant, specify a resource type of fleet to tag the fleet or instance to tag the instances at launch.

If the fleet type is maintain or request, specify a resource type of fleet to tag the fleet. You cannot specify a resource type of instance. To tag instances at launch, specify the tags in a launch template.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - - name: Context - in: query - required: false - description: Reserved. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateFleet - operationId: POST_CreateFleet - description: '

Launches an EC2 Fleet.

You can create a single EC2 Fleet that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.

For more information, see EC2 Fleet in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateFleetResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateFleetRequest' - parameters: [] - /?Action=CreateFlowLogs&Version=2016-11-15: - get: - x-aws-operation-name: CreateFlowLogs - operationId: GET_CreateFlowLogs - description: '

Creates one or more flow logs to capture information about IP traffic for a specific network interface, subnet, or VPC.

Flow log data for a monitored network interface is recorded as flow log records, which are log events consisting of fields that describe the traffic flow. For more information, see Flow log records in the Amazon Virtual Private Cloud User Guide.

When publishing to CloudWatch Logs, flow log records are published to a log group, and each network interface has a unique log stream in the log group. When publishing to Amazon S3, flow log records for all of the monitored network interfaces are published to a single log file object that is stored in the specified bucket.

For more information, see VPC Flow Logs in the Amazon Virtual Private Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateFlowLogsResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: ClientToken - in: query - required: false - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.' - schema: - type: string - - name: DeliverLogsPermissionArn - in: query - required: false - description: '

The ARN for the IAM role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account.

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

' - schema: - type: string - - name: LogGroupName - in: query - required: false - description: '

The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs.

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

' - schema: - type: string - - name: ResourceId - in: query - required: true - description: '

The ID of the subnet, network interface, or VPC for which you want to create a flow log.

Constraints: Maximum of 1000 resources

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/FlowLogResourceId' - - xml: - name: item - - name: ResourceType - in: query - required: true - description: 'The type of resource for which to create the flow log. For example, if you specified a VPC ID for the ResourceId property, specify VPC for this property.' - schema: - type: string - enum: - - VPC - - Subnet - - NetworkInterface - - name: TrafficType - in: query - required: true - description: 'The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic.' - schema: - type: string - enum: - - ACCEPT - - REJECT - - ALL - - name: LogDestinationType - in: query - required: false - description: '

The type of destination to which the flow log data is to be published. Flow log data can be published to CloudWatch Logs or Amazon S3. To publish flow log data to CloudWatch Logs, specify cloud-watch-logs. To publish flow log data to Amazon S3, specify s3.

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

Default: cloud-watch-logs

' - schema: - type: string - enum: - - cloud-watch-logs - - s3 - - name: LogDestination - in: query - required: false - description: '

The destination to which the flow log data is to be published. Flow log data can be published to a CloudWatch Logs log group or an Amazon S3 bucket. The value specified for this parameter depends on the value specified for LogDestinationType.

If LogDestinationType is not specified or cloud-watch-logs, specify the Amazon Resource Name (ARN) of the CloudWatch Logs log group. For example, to publish to a log group called my-logs, specify arn:aws:logs:us-east-1:123456789012:log-group:my-logs. Alternatively, use LogGroupName instead.

If LogDestinationType is s3, specify the ARN of the Amazon S3 bucket. You can also specify a subfolder in the bucket. To specify a subfolder in the bucket, use the following ARN format: bucket_ARN/subfolder_name/. For example, to specify a subfolder named my-logs in a bucket named my-bucket, use the following ARN: arn:aws:s3:::my-bucket/my-logs/. You cannot use AWSLogs as a subfolder name. This is a reserved term.

' - schema: - type: string - - name: LogFormat - in: query - required: false - description: '

The fields to include in the flow log record, in the order in which they should appear. For a list of available fields, see Flow log records. If you omit this parameter, the flow log is created using the default format. If you specify this parameter, you must specify at least one field.

Specify the fields using the ${field-id} format, separated by spaces. For the CLI, surround this parameter value with single quotes on Linux or double quotes on Windows.

' - schema: - type: string - - name: TagSpecification - in: query - required: false - description: The tags to apply to the flow logs. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - - name: MaxAggregationInterval - in: query - required: false - description: '

The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. You can specify 60 seconds (1 minute) or 600 seconds (10 minutes).

When a network interface is attached to a Nitro-based instance, the aggregation interval is always 60 seconds or less, regardless of the value that you specify.

Default: 600

' - schema: - type: integer - - name: DestinationOptions - in: query - required: false - description: The destination options. - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether to partition the flow log per hour. This reduces the cost and response time for queries. The default is false. - description: Describes the destination options for a flow log. - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateFlowLogs - operationId: POST_CreateFlowLogs - description: '

Creates one or more flow logs to capture information about IP traffic for a specific network interface, subnet, or VPC.

Flow log data for a monitored network interface is recorded as flow log records, which are log events consisting of fields that describe the traffic flow. For more information, see Flow log records in the Amazon Virtual Private Cloud User Guide.

When publishing to CloudWatch Logs, flow log records are published to a log group, and each network interface has a unique log stream in the log group. When publishing to Amazon S3, flow log records for all of the monitored network interfaces are published to a single log file object that is stored in the specified bucket.

For more information, see VPC Flow Logs in the Amazon Virtual Private Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateFlowLogsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateFlowLogsRequest' - parameters: [] - /?Action=CreateFpgaImage&Version=2016-11-15: - get: - x-aws-operation-name: CreateFpgaImage - operationId: GET_CreateFpgaImage - description: '

Creates an Amazon FPGA Image (AFI) from the specified design checkpoint (DCP).

The create operation is asynchronous. To verify that the AFI is ready for use, check the output logs.

An AFI contains the FPGA bitstream that is ready to download to an FPGA. You can securely deploy an AFI on multiple FPGA-accelerated instances. For more information, see the Amazon Web Services FPGA Hardware Development Kit.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateFpgaImageResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: InputStorageLocation - in: query - required: true - description: The location of the encrypted design checkpoint in Amazon S3. The input must be a tarball. - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The key. - description: Describes a storage location in Amazon S3. - - name: LogsStorageLocation - in: query - required: false - description: The location in Amazon S3 for the output logs. - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The key. - description: Describes a storage location in Amazon S3. - - name: Description - in: query - required: false - description: A description for the AFI. - schema: - type: string - - name: Name - in: query - required: false - description: A name for the AFI. - schema: - type: string - - name: ClientToken - in: query - required: false - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.' - schema: - type: string - - name: TagSpecification - in: query - required: false - description: The tags to apply to the FPGA image during creation. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateFpgaImage - operationId: POST_CreateFpgaImage - description: '

Creates an Amazon FPGA Image (AFI) from the specified design checkpoint (DCP).

The create operation is asynchronous. To verify that the AFI is ready for use, check the output logs.

An AFI contains the FPGA bitstream that is ready to download to an FPGA. You can securely deploy an AFI on multiple FPGA-accelerated instances. For more information, see the Amazon Web Services FPGA Hardware Development Kit.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateFpgaImageResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateFpgaImageRequest' - parameters: [] - /?Action=CreateImage&Version=2016-11-15: - get: - x-aws-operation-name: CreateImage - operationId: GET_CreateImage - description: '

Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped.

By default, when Amazon EC2 creates the new AMI, it reboots the instance so that it can take snapshots of the attached volumes while data is at rest, in order to ensure a consistent state. You can set the NoReboot parameter to true in the API request, or use the --no-reboot option in the CLI to prevent Amazon EC2 from shutting down and rebooting the instance.

If you choose to bypass the shutdown and reboot process by setting the NoReboot parameter to true in the API request, or by using the --no-reboot option in the CLI, we can''t guarantee the file system integrity of the created image.

If you customized your instance with instance store volumes or Amazon EBS volumes in addition to the root device volume, the new AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, the instance automatically launches with those additional volumes.

For more information, see Creating Amazon EBS-Backed Linux AMIs in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateImageResult' - parameters: - - name: BlockDeviceMapping - in: query - required: false - description: 'The block device mappings. This parameter cannot be used to modify the encryption status of existing volumes or snapshots. To create an AMI with encrypted snapshots, use the CopyImage action.' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/BlockDeviceMapping' - - xml: - name: BlockDeviceMapping - - name: Description - in: query - required: false - description: A description for the new image. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: InstanceId - in: query - required: true - description: The ID of the instance. - schema: - type: string - - name: Name - in: query - required: true - description: '

A name for the new image.

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes (''), at-signs (@), or underscores(_)

' - schema: - type: string - - name: NoReboot - in: query - required: false - description: '

By default, when Amazon EC2 creates the new AMI, it reboots the instance so that it can take snapshots of the attached volumes while data is at rest, in order to ensure a consistent state. You can set the NoReboot parameter to true in the API request, or use the --no-reboot option in the CLI to prevent Amazon EC2 from shutting down and rebooting the instance.

If you choose to bypass the shutdown and reboot process by setting the NoReboot parameter to true in the API request, or by using the --no-reboot option in the CLI, we can''t guarantee the file system integrity of the created image.

Default: false (follow standard reboot process)

' - schema: - type: boolean - - name: TagSpecification - in: query - required: false - description: '

The tags to apply to the AMI and snapshots on creation. You can tag the AMI, the snapshots, or both.

  • To tag the AMI, the value for ResourceType must be image.

  • To tag the snapshots that are created of the root volume and of other Amazon EBS volumes that are attached to the instance, the value for ResourceType must be snapshot. The same tag is applied to all of the snapshots that are created.

If you specify other values for ResourceType, the request fails.

To tag an AMI or snapshot after it has been created, see CreateTags.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateImage - operationId: POST_CreateImage - description: '

Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped.

By default, when Amazon EC2 creates the new AMI, it reboots the instance so that it can take snapshots of the attached volumes while data is at rest, in order to ensure a consistent state. You can set the NoReboot parameter to true in the API request, or use the --no-reboot option in the CLI to prevent Amazon EC2 from shutting down and rebooting the instance.

If you choose to bypass the shutdown and reboot process by setting the NoReboot parameter to true in the API request, or by using the --no-reboot option in the CLI, we can''t guarantee the file system integrity of the created image.

If you customized your instance with instance store volumes or Amazon EBS volumes in addition to the root device volume, the new AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, the instance automatically launches with those additional volumes.

For more information, see Creating Amazon EBS-Backed Linux AMIs in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateImageResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateImageRequest' - parameters: [] - /?Action=CreateInstanceEventWindow&Version=2016-11-15: - get: - x-aws-operation-name: CreateInstanceEventWindow - operationId: GET_CreateInstanceEventWindow - description: '

Creates an event window in which scheduled events for the associated Amazon EC2 instances can run.

You can define either a set of time ranges or a cron expression when creating the event window, but not both. All event window times are in UTC.

You can create up to 200 event windows per Amazon Web Services Region.

When you create the event window, targets (instance IDs, Dedicated Host IDs, or tags) are not yet associated with it. To ensure that the event window can be used, you must associate one or more targets with it by using the AssociateInstanceEventWindow API.

Event windows are applicable only for scheduled events that stop, reboot, or terminate instances.

Event windows are not applicable for:

  • Expedited scheduled events and network maintenance events.

  • Unscheduled maintenance such as AutoRecovery and unplanned reboots.

For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateInstanceEventWindowResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: Name - in: query - required: false - description: The name of the event window. - schema: - type: string - - name: TimeRange - in: query - required: false - description: 'The time range for the event window. If you specify a time range, you can''t specify a cron expression.' - schema: - type: array - items: - $ref: '#/components/schemas/InstanceEventWindowTimeRangeRequest' - - name: CronExpression - in: query - required: false - description: '

The cron expression for the event window, for example, * 0-4,20-23 * * 1,5. If you specify a cron expression, you can''t specify a time range.

Constraints:

  • Only hour and day of the week values are supported.

  • For day of the week values, you can specify either integers 0 through 6, or alternative single values SUN through SAT.

  • The minute, month, and year must be specified by *.

  • The hour value must be one or a multiple range, for example, 0-4 or 0-4,20-23.

  • Each hour range must be >= 2 hours, for example, 0-2 or 20-23.

  • The event window must be >= 4 hours. The combined total time ranges in the event window must be >= 4 hours.

For more information about cron expressions, see cron on the Wikipedia website.

' - schema: - type: string - - name: TagSpecification - in: query - required: false - description: The tags to apply to the event window. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateInstanceEventWindow - operationId: POST_CreateInstanceEventWindow - description: '

Creates an event window in which scheduled events for the associated Amazon EC2 instances can run.

You can define either a set of time ranges or a cron expression when creating the event window, but not both. All event window times are in UTC.

You can create up to 200 event windows per Amazon Web Services Region.

When you create the event window, targets (instance IDs, Dedicated Host IDs, or tags) are not yet associated with it. To ensure that the event window can be used, you must associate one or more targets with it by using the AssociateInstanceEventWindow API.

Event windows are applicable only for scheduled events that stop, reboot, or terminate instances.

Event windows are not applicable for:

  • Expedited scheduled events and network maintenance events.

  • Unscheduled maintenance such as AutoRecovery and unplanned reboots.

For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateInstanceEventWindowResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateInstanceEventWindowRequest' - parameters: [] - /?Action=CreateInstanceExportTask&Version=2016-11-15: - get: - x-aws-operation-name: CreateInstanceExportTask - operationId: GET_CreateInstanceExportTask - description: '

Exports a running or stopped instance to an Amazon S3 bucket.

For information about the supported operating systems, image formats, and known limitations for the types of instances you can export, see Exporting an instance as a VM Using VM Import/Export in the VM Import/Export User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateInstanceExportTaskResult' - parameters: - - name: Description - in: query - required: false - description: A description for the conversion task or the resource being exported. The maximum length is 255 characters. - schema: - type: string - - name: ExportToS3 - in: query - required: true - description: The format and location for an export instance task. - schema: - type: object - properties: - containerFormat: - allOf: - - $ref: '#/components/schemas/ContainerFormat' - - description: 'The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.' - diskImageFormat: - allOf: - - $ref: '#/components/schemas/DiskImageFormat' - - description: The format for the exported image. - s3Bucket: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACP permissions to the Amazon Web Services account vm-import-export@amazon.com. - s3Prefix: - allOf: - - $ref: '#/components/schemas/String' - - description: The image is written to a single object in the Amazon S3 bucket at the S3 key s3prefix + exportTaskId + '.' + diskImageFormat. - description: Describes an export instance task. - - name: InstanceId - in: query - required: true - description: The ID of the instance. - schema: - type: string - - name: TargetEnvironment - in: query - required: true - description: The target virtualization environment. - schema: - type: string - enum: - - citrix - - vmware - - microsoft - - name: TagSpecification - in: query - required: false - description: The tags to apply to the export instance task during creation. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateInstanceExportTask - operationId: POST_CreateInstanceExportTask - description: '

Exports a running or stopped instance to an Amazon S3 bucket.

For information about the supported operating systems, image formats, and known limitations for the types of instances you can export, see Exporting an instance as a VM Using VM Import/Export in the VM Import/Export User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateInstanceExportTaskResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateInstanceExportTaskRequest' - parameters: [] - /?Action=CreateInternetGateway&Version=2016-11-15: - get: - x-aws-operation-name: CreateInternetGateway - operationId: GET_CreateInternetGateway - description: '

Creates an internet gateway for use with a VPC. After creating the internet gateway, you attach it to a VPC using AttachInternetGateway.

For more information about your VPC and internet gateway, see the Amazon Virtual Private Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateInternetGatewayResult' - parameters: - - name: TagSpecification - in: query - required: false - description: The tags to assign to the internet gateway. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateInternetGateway - operationId: POST_CreateInternetGateway - description: '

Creates an internet gateway for use with a VPC. After creating the internet gateway, you attach it to a VPC using AttachInternetGateway.

For more information about your VPC and internet gateway, see the Amazon Virtual Private Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateInternetGatewayResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateInternetGatewayRequest' - parameters: [] - /?Action=CreateIpam&Version=2016-11-15: - get: - x-aws-operation-name: CreateIpam - operationId: GET_CreateIpam - description: '

Create an IPAM. Amazon VPC IP Address Manager (IPAM) is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts throughout your Amazon Web Services Organization.

For more information, see Create an IPAM in the Amazon VPC IPAM User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateIpamResult' - parameters: - - name: DryRun - in: query - required: false - description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: Description - in: query - required: false - description: A description for the IPAM. - schema: - type: string - - name: OperatingRegion - in: query - required: false - description: '

The operating Regions for the IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.

' - schema: - type: array - items: - $ref: '#/components/schemas/AddIpamOperatingRegion' - minItems: 0 - maxItems: 50 - - name: TagSpecification - in: query - required: false - description: '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. 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.' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - - name: ClientToken - in: query - required: false - description: 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.' - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateIpam - operationId: POST_CreateIpam - description: '

Create an IPAM. Amazon VPC IP Address Manager (IPAM) is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts throughout your Amazon Web Services Organization.

For more information, see Create an IPAM in the Amazon VPC IPAM User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateIpamResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateIpamRequest' - parameters: [] - /?Action=CreateIpamPool&Version=2016-11-15: - get: - x-aws-operation-name: CreateIpamPool - operationId: GET_CreateIpamPool - description: '

Create an IP address pool for Amazon VPC IP Address Manager (IPAM). In IPAM, a pool is a collection of contiguous IP addresses CIDRs. Pools enable you to organize your IP addresses according to your routing and security needs. For example, if you have separate routing and security needs for development and production applications, you can create a pool for each.

For more information, see Create a top-level pool in the Amazon VPC IPAM User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateIpamPoolResult' - parameters: - - name: DryRun - in: query - required: false - description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: IpamScopeId - in: query - required: true - description: The ID of the scope in which you would like to create the IPAM pool. - schema: - type: string - - name: Locale - in: query - required: false - description: '

In IPAM, the locale is the Amazon Web Services Region where you want to make an IPAM pool available for allocations. Only resources in the same Region as the locale of the pool can get IP address allocations from the pool. You can only allocate a CIDR for a VPC, for example, from an IPAM pool that shares a locale with the VPC’s Region. Note that once you choose a Locale for a pool, you cannot modify it. If you do not choose a locale, resources in Regions others than the IPAM''s home region cannot use CIDRs from this pool.

Possible values: Any Amazon Web Services Region, such as us-east-1.

' - schema: - type: string - - name: SourceIpamPoolId - in: query - required: false - description: The ID of the source IPAM pool. Use this option to create a pool within an existing pool. Note that the CIDR you provision for the pool within the source pool must be available in the source pool's CIDR range. - schema: - type: string - - name: Description - in: query - required: false - description: A description for the IPAM pool. - schema: - type: string - - name: AddressFamily - in: query - required: true - description: The IP protocol assigned to this IPAM pool. You must choose either IPv4 or IPv6 protocol for a pool. - schema: - type: string - enum: - - ipv4 - - ipv6 - - name: AutoImport - in: query - required: false - description: '

If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool''s allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.

A locale must be set on the pool for this feature to work.

' - schema: - type: boolean - - name: PubliclyAdvertisable - in: query - required: false - description: Determines if the pool is publicly advertisable. This option is not available for pools with AddressFamily set to ipv4. - schema: - type: boolean - - name: AllocationMinNetmaskLength - in: query - required: false - description: The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. The minimum netmask length must be less than the maximum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128. - schema: - type: integer - minimum: 0 - maximum: 128 - - name: AllocationMaxNetmaskLength - in: query - required: false - description: The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. The maximum netmask length must be greater than the minimum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128. - schema: - type: integer - minimum: 0 - maximum: 128 - - name: AllocationDefaultNetmaskLength - in: query - required: false - description: 'The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.' - schema: - type: integer - minimum: 0 - maximum: 128 - - name: AllocationResourceTag - in: query - required: false - description: 'Tags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/RequestIpamResourceTag' - - xml: - name: item - - name: TagSpecification - in: query - required: false - description: '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. 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.' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - - name: ClientToken - in: query - required: false - description: 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.' - schema: - type: string - - name: AwsService - in: query - required: false - description: 'Limits which service in Amazon Web Services that the pool can be used in. "ec2", for example, allows users to use space for Elastic IP addresses and VPCs.' - schema: - type: string - enum: - - ec2 - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateIpamPool - operationId: POST_CreateIpamPool - description: '

Create an IP address pool for Amazon VPC IP Address Manager (IPAM). In IPAM, a pool is a collection of contiguous IP addresses CIDRs. Pools enable you to organize your IP addresses according to your routing and security needs. For example, if you have separate routing and security needs for development and production applications, you can create a pool for each.

For more information, see Create a top-level pool in the Amazon VPC IPAM User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateIpamPoolResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateIpamPoolRequest' - parameters: [] - /?Action=CreateIpamScope&Version=2016-11-15: - get: - x-aws-operation-name: CreateIpamScope - operationId: GET_CreateIpamScope - description: '

Create an IPAM scope. In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.

For more information, see Add a scope in the Amazon VPC IPAM User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateIpamScopeResult' - parameters: - - name: DryRun - in: query - required: false - description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: IpamId - in: query - required: true - description: The ID of the IPAM for which you're creating this scope. - schema: - type: string - - name: Description - in: query - required: false - description: A description for the scope you're creating. - schema: - type: string - - name: TagSpecification - in: query - required: false - description: '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. 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.' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - - name: ClientToken - in: query - required: false - description: 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.' - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateIpamScope - operationId: POST_CreateIpamScope - description: '

Create an IPAM scope. In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.

For more information, see Add a scope in the Amazon VPC IPAM User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateIpamScopeResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateIpamScopeRequest' - parameters: [] - /?Action=CreateKeyPair&Version=2016-11-15: - get: - x-aws-operation-name: CreateKeyPair - operationId: GET_CreateKeyPair - description: '

Creates an ED25519 or 2048-bit RSA key pair with the specified name and in the specified PEM or PPK format. Amazon EC2 stores the public key and displays the private key for you to save to a file. The private key is returned as an unencrypted PEM encoded PKCS#1 private key or an unencrypted PPK formatted private key for use with PuTTY. If a key with the specified name already exists, Amazon EC2 returns an error.

The key pair returned to you is available only in the Amazon Web Services Region in which you create it. If you prefer, you can create your own key pair using a third-party tool and upload it to any Region using ImportKeyPair.

You can have up to 5,000 key pairs per Amazon Web Services Region.

For more information, see Amazon EC2 key pairs in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/KeyPair' - parameters: - - name: KeyName - in: query - required: true - description: '

A unique name for the key pair.

Constraints: Up to 255 ASCII characters

' - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: KeyType - in: query - required: false - description: '

The type of key pair. Note that ED25519 keys are not supported for Windows instances.

Default: rsa

' - schema: - type: string - enum: - - rsa - - ed25519 - - name: TagSpecification - in: query - required: false - description: The tags to apply to the new key pair. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - - name: KeyFormat - in: query - required: false - description: '

The format of the key pair.

Default: pem

' - schema: - type: string - enum: - - pem - - ppk - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateKeyPair - operationId: POST_CreateKeyPair - description: '

Creates an ED25519 or 2048-bit RSA key pair with the specified name and in the specified PEM or PPK format. Amazon EC2 stores the public key and displays the private key for you to save to a file. The private key is returned as an unencrypted PEM encoded PKCS#1 private key or an unencrypted PPK formatted private key for use with PuTTY. If a key with the specified name already exists, Amazon EC2 returns an error.

The key pair returned to you is available only in the Amazon Web Services Region in which you create it. If you prefer, you can create your own key pair using a third-party tool and upload it to any Region using ImportKeyPair.

You can have up to 5,000 key pairs per Amazon Web Services Region.

For more information, see Amazon EC2 key pairs in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/KeyPair' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateKeyPairRequest' - parameters: [] - /?Action=CreateLaunchTemplate&Version=2016-11-15: - get: - x-aws-operation-name: CreateLaunchTemplate - operationId: GET_CreateLaunchTemplate - description: '

Creates a launch template.

A launch template contains the parameters to launch an instance. When you launch an instance using RunInstances, you can specify a launch template instead of providing the launch parameters in the request. For more information, see Launching an instance from a launch template in the Amazon Elastic Compute Cloud User Guide.

If you want to clone an existing launch template as the basis for creating a new launch template, you can use the Amazon EC2 console. The API, SDKs, and CLI do not support cloning a template. For more information, see Create a launch template from an existing launch template in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateLaunchTemplateResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: ClientToken - in: query - required: false - description: '

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

Constraint: Maximum 128 ASCII characters.

' - schema: - type: string - - name: LaunchTemplateName - in: query - required: true - description: A name for the launch template. - schema: - type: string - pattern: '[a-zA-Z0-9\(\)\.\-/_]+' - minLength: 3 - maxLength: 128 - - name: VersionDescription - in: query - required: false - description: A description for the first version of the launch template. - schema: - type: string - minLength: 0 - maxLength: 255 - - name: LaunchTemplateData - in: query - required: true - description: The information for the launch template. - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/LaunchTemplateIamInstanceProfileSpecificationRequest' - - description: The name or Amazon Resource Name (ARN) of an IAM instance profile. - BlockDeviceMapping: - allOf: - - $ref: '#/components/schemas/LaunchTemplateBlockDeviceMappingRequestList' - - description: The block device mapping. - NetworkInterface: - allOf: - - $ref: '#/components/schemas/String' - - description: '

The user data to make available to the instance. You must provide base64-encoded text. User data is limited to 16 KB. For more information, see Running Commands on Your Linux Instance at Launch (Linux) or Adding User Data (Windows).

If you are creating the launch template for use with Batch, the user data must be provided in the MIME multi-part archive format. For more information, see Amazon EC2 user data in launch templates in the Batch User Guide.

' - TagSpecification: - allOf: - - $ref: '#/components/schemas/LaunchTemplateTagSpecificationRequestList' - - description: 'The tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified tags are applied to all instances or volumes that are created during launch. To tag a resource after it has been created, see CreateTags.' - ElasticGpuSpecification: - allOf: - - $ref: '#/components/schemas/ElasticGpuSpecificationList' - - description: An elastic GPU to associate with the instance. - ElasticInferenceAccelerator: - allOf: - - $ref: '#/components/schemas/LaunchTemplateElasticInferenceAcceleratorList' - - description: ' The elastic inference accelerator for the instance. ' - SecurityGroupId: - allOf: - - $ref: '#/components/schemas/SecurityGroupIdStringList' - - description: 'One or more security group IDs. You can create a security group using CreateSecurityGroup. You cannot specify both a security group ID and security name in the same request.' - SecurityGroup: - allOf: - - $ref: '#/components/schemas/LaunchTemplateCapacityReservationSpecificationRequest' - - description: 'The Capacity Reservation targeting option. If you do not specify this parameter, the instance''s Capacity Reservation preference defaults to open, which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).' - LicenseSpecification: - allOf: - - $ref: '#/components/schemas/LaunchTemplateInstanceMaintenanceOptionsRequest' - - description: The maintenance options for the instance. - description:

The information to include in the launch template.

You must specify at least one parameter for the launch template data.

 - - name: TagSpecification - in: query - required: false - description: The tags to apply to the launch template during creation. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateLaunchTemplate - operationId: POST_CreateLaunchTemplate - description: '

Creates a launch template.

A launch template contains the parameters to launch an instance. When you launch an instance using RunInstances, you can specify a launch template instead of providing the launch parameters in the request. For more information, see Launching an instance from a launch template in the Amazon Elastic Compute Cloud User Guide.

If you want to clone an existing launch template as the basis for creating a new launch template, you can use the Amazon EC2 console. The API, SDKs, and CLI do not support cloning a template. For more information, see Create a launch template from an existing launch template in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateLaunchTemplateResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateLaunchTemplateRequest' - parameters: [] - /?Action=CreateLaunchTemplateVersion&Version=2016-11-15: - get: - x-aws-operation-name: CreateLaunchTemplateVersion - operationId: GET_CreateLaunchTemplateVersion - description: '

Creates a new version for a launch template. You can specify an existing version of launch template from which to base the new version.

Launch template versions are numbered in the order in which they are created. You cannot specify, change, or replace the numbering of launch template versions.

For more information, see Managing launch template versionsin the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateLaunchTemplateVersionResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: ClientToken - in: query - required: false - description: '

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

Constraint: Maximum 128 ASCII characters.

' - schema: - type: string - - name: LaunchTemplateId - in: query - required: false - description: The ID of the launch template. You must specify either the launch template ID or launch template name in the request. - schema: - type: string - - name: LaunchTemplateName - in: query - required: false - description: The name of the launch template. You must specify either the launch template ID or launch template name in the request. - schema: - type: string - pattern: '[a-zA-Z0-9\(\)\.\-/_]+' - minLength: 3 - maxLength: 128 - - name: SourceVersion - in: query - required: false - description: 'The version number of the launch template version on which to base the new version. The new version inherits the same launch parameters as the source version, except for parameters that you specify in LaunchTemplateData. Snapshots applied to the block device mapping are ignored when creating a new version unless they are explicitly included.' - schema: - type: string - - name: VersionDescription - in: query - required: false - description: A description for the version of the launch template. - schema: - type: string - minLength: 0 - maxLength: 255 - - name: LaunchTemplateData - in: query - required: true - description: The information for the launch template. - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/LaunchTemplateIamInstanceProfileSpecificationRequest' - - description: The name or Amazon Resource Name (ARN) of an IAM instance profile. - BlockDeviceMapping: - allOf: - - $ref: '#/components/schemas/LaunchTemplateBlockDeviceMappingRequestList' - - description: The block device mapping. - NetworkInterface: - allOf: - - $ref: '#/components/schemas/String' - - description: '

The user data to make available to the instance. You must provide base64-encoded text. User data is limited to 16 KB. For more information, see Running Commands on Your Linux Instance at Launch (Linux) or Adding User Data (Windows).

If you are creating the launch template for use with Batch, the user data must be provided in the MIME multi-part archive format. For more information, see Amazon EC2 user data in launch templates in the Batch User Guide.

' - TagSpecification: - allOf: - - $ref: '#/components/schemas/LaunchTemplateTagSpecificationRequestList' - - description: 'The tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified tags are applied to all instances or volumes that are created during launch. To tag a resource after it has been created, see CreateTags.' - ElasticGpuSpecification: - allOf: - - $ref: '#/components/schemas/ElasticGpuSpecificationList' - - description: An elastic GPU to associate with the instance. - ElasticInferenceAccelerator: - allOf: - - $ref: '#/components/schemas/LaunchTemplateElasticInferenceAcceleratorList' - - description: ' The elastic inference accelerator for the instance. ' - SecurityGroupId: - allOf: - - $ref: '#/components/schemas/SecurityGroupIdStringList' - - description: 'One or more security group IDs. You can create a security group using CreateSecurityGroup. You cannot specify both a security group ID and security name in the same request.' - SecurityGroup: - allOf: - - $ref: '#/components/schemas/LaunchTemplateCapacityReservationSpecificationRequest' - - description: 'The Capacity Reservation targeting option. If you do not specify this parameter, the instance''s Capacity Reservation preference defaults to open, which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).' - LicenseSpecification: - allOf: - - $ref: '#/components/schemas/LaunchTemplateInstanceMaintenanceOptionsRequest' - - description: The maintenance options for the instance. - description:

The information to include in the launch template.

You must specify at least one parameter for the launch template data.

 - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateLaunchTemplateVersion - operationId: POST_CreateLaunchTemplateVersion - description: '

Creates a new version for a launch template. You can specify an existing version of launch template from which to base the new version.

Launch template versions are numbered in the order in which they are created. You cannot specify, change, or replace the numbering of launch template versions.

For more information, see Managing launch template versionsin the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateLaunchTemplateVersionResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateLaunchTemplateVersionRequest' - parameters: [] - /?Action=CreateLocalGatewayRoute&Version=2016-11-15: - get: - x-aws-operation-name: CreateLocalGatewayRoute - operationId: GET_CreateLocalGatewayRoute - description: Creates a static route for the specified local gateway route table. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateLocalGatewayRouteResult' - parameters: - - name: DestinationCidrBlock - in: query - required: true - description: The CIDR range used for destination matches. Routing decisions are based on the most specific match. - schema: - type: string - - name: LocalGatewayRouteTableId - in: query - required: true - description: The ID of the local gateway route table. - schema: - type: string - - name: LocalGatewayVirtualInterfaceGroupId - in: query - required: true - description: The ID of the virtual interface group. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateLocalGatewayRoute - operationId: POST_CreateLocalGatewayRoute - description: Creates a static route for the specified local gateway route table. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateLocalGatewayRouteResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateLocalGatewayRouteRequest' - parameters: [] - /?Action=CreateLocalGatewayRouteTableVpcAssociation&Version=2016-11-15: - get: - x-aws-operation-name: CreateLocalGatewayRouteTableVpcAssociation - operationId: GET_CreateLocalGatewayRouteTableVpcAssociation - description: Associates the specified VPC with the specified local gateway route table. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateLocalGatewayRouteTableVpcAssociationResult' - parameters: - - name: LocalGatewayRouteTableId - in: query - required: true - description: The ID of the local gateway route table. - schema: - type: string - - name: VpcId - in: query - required: true - description: The ID of the VPC. - schema: - type: string - - name: TagSpecification - in: query - required: false - description: The tags to assign to the local gateway route table VPC association. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateLocalGatewayRouteTableVpcAssociation - operationId: POST_CreateLocalGatewayRouteTableVpcAssociation - description: Associates the specified VPC with the specified local gateway route table. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateLocalGatewayRouteTableVpcAssociationResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateLocalGatewayRouteTableVpcAssociationRequest' - parameters: [] - /?Action=CreateManagedPrefixList&Version=2016-11-15: - get: - x-aws-operation-name: CreateManagedPrefixList - operationId: GET_CreateManagedPrefixList - description: Creates a managed prefix list. You can specify one or more entries for the prefix list. Each entry consists of a CIDR block and an optional description. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateManagedPrefixListResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: PrefixListName - in: query - required: true - description: '

A name for the prefix list.

Constraints: Up to 255 characters in length. The name cannot start with com.amazonaws.

' - schema: - type: string - - name: Entry - in: query - required: false - description: One or more entries for the prefix list. - schema: - type: array - items: - $ref: '#/components/schemas/AddPrefixListEntry' - minItems: 0 - maxItems: 100 - - name: MaxEntries - in: query - required: true - description: The maximum number of entries for the prefix list. - schema: - type: integer - - name: TagSpecification - in: query - required: false - description: The tags to apply to the prefix list during creation. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - - name: AddressFamily - in: query - required: true - description: '

The IP address type.

Valid Values: IPv4 | IPv6

' - schema: - type: string - - name: ClientToken - in: query - required: false - description: '

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

Constraints: Up to 255 UTF-8 characters in length.

' - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateManagedPrefixList - operationId: POST_CreateManagedPrefixList - description: Creates a managed prefix list. You can specify one or more entries for the prefix list. Each entry consists of a CIDR block and an optional description. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateManagedPrefixListResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateManagedPrefixListRequest' - parameters: [] - /?Action=CreateNatGateway&Version=2016-11-15: - get: - x-aws-operation-name: CreateNatGateway - operationId: GET_CreateNatGateway - description: '

Creates a NAT gateway in the specified subnet. This action creates a network interface in the specified subnet with a private IP address from the IP address range of the subnet. You can create either a public NAT gateway or a private NAT gateway.

With a public NAT gateway, internet-bound traffic from a private subnet can be routed to the NAT gateway, so that instances in a private subnet can connect to the internet.

With a private NAT gateway, private communication is routed across VPCs and on-premises networks through a transit gateway or virtual private gateway. Common use cases include running large workloads behind a small pool of allowlisted IPv4 addresses, preserving private IPv4 addresses, and communicating between overlapping networks.

For more information, see NAT gateways in the Amazon Virtual Private Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateNatGatewayResult' - parameters: - - name: AllocationId - in: query - required: false - description: '[Public NAT gateways only] The allocation ID of an Elastic IP address to associate with the NAT gateway. You cannot specify an Elastic IP address with a private NAT gateway. If the Elastic IP address is associated with another resource, you must first disassociate it.' - schema: - type: string - - name: ClientToken - in: query - required: false - description: '

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

Constraint: Maximum 64 ASCII characters.

' - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: SubnetId - in: query - required: true - description: The subnet in which to create the NAT gateway. - schema: - type: string - - name: TagSpecification - in: query - required: false - description: The tags to assign to the NAT gateway. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - - name: ConnectivityType - in: query - required: false - description: Indicates whether the NAT gateway supports public or private connectivity. The default is public connectivity. - schema: - type: string - enum: - - private - - public - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateNatGateway - operationId: POST_CreateNatGateway - description: '

Creates a NAT gateway in the specified subnet. This action creates a network interface in the specified subnet with a private IP address from the IP address range of the subnet. You can create either a public NAT gateway or a private NAT gateway.

With a public NAT gateway, internet-bound traffic from a private subnet can be routed to the NAT gateway, so that instances in a private subnet can connect to the internet.

With a private NAT gateway, private communication is routed across VPCs and on-premises networks through a transit gateway or virtual private gateway. Common use cases include running large workloads behind a small pool of allowlisted IPv4 addresses, preserving private IPv4 addresses, and communicating between overlapping networks.

For more information, see NAT gateways in the Amazon Virtual Private Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateNatGatewayResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateNatGatewayRequest' - parameters: [] - /?Action=CreateNetworkAcl&Version=2016-11-15: - get: - x-aws-operation-name: CreateNetworkAcl - operationId: GET_CreateNetworkAcl - description: '

Creates a network ACL in a VPC. Network ACLs provide an optional layer of security (in addition to security groups) for the instances in your VPC.

For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateNetworkAclResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: VpcId - in: query - required: true - description: The ID of the VPC. - schema: - type: string - - name: TagSpecification - in: query - required: false - description: The tags to assign to the network ACL. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateNetworkAcl - operationId: POST_CreateNetworkAcl - description: '

Creates a network ACL in a VPC. Network ACLs provide an optional layer of security (in addition to security groups) for the instances in your VPC.

For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateNetworkAclResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateNetworkAclRequest' - parameters: [] - /?Action=CreateNetworkAclEntry&Version=2016-11-15: - get: - x-aws-operation-name: CreateNetworkAclEntry - operationId: GET_CreateNetworkAclEntry - description: '

Creates an entry (a rule) in a network ACL with the specified rule number. Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated with the ACL, we process the entries in the ACL according to the rule numbers, in ascending order. Each network ACL has a set of ingress rules and a separate set of egress rules.

We recommend that you leave room between the rule numbers (for example, 100, 110, 120, ...), and not number them one right after the other (for example, 101, 102, 103, ...). This makes it easier to add a rule between existing ones without having to renumber the rules.

After you add an entry, you can''t modify it; you must either replace it, or create an entry and delete the old one.

For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

' - responses: - '200': - description: Success - parameters: - - name: CidrBlock - in: query - required: false - description: 'The IPv4 network range to allow or deny, in CIDR notation (for example 172.16.0.0/24). We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.' - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: Egress - in: query - required: true - description: Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet). - schema: - type: boolean - - name: Icmp - in: query - required: false - description: 'ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block.' - schema: - type: object - properties: - code: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The ICMP code. A value of -1 means all codes for the specified ICMP type. - type: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The ICMP type. A value of -1 means all types. - description: Describes the ICMP type and code. - - name: Ipv6CidrBlock - in: query - required: false - description: 'The IPv6 network range to allow or deny, in CIDR notation (for example 2001:db8:1234:1a00::/64).' - schema: - type: string - - name: NetworkAclId - in: query - required: true - description: The ID of the network ACL. - schema: - type: string - - name: PortRange - in: query - required: false - description: 'TCP or UDP protocols: The range of ports the rule applies to. Required if specifying protocol 6 (TCP) or 17 (UDP).' - schema: - type: object - properties: - from: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The first port in the range. - to: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The last port in the range. - description: Describes a range of ports. - - name: Protocol - in: query - required: true - description: 'The protocol number. A value of "-1" means all protocols. If you specify "-1" or a protocol number other than "6" (TCP), "17" (UDP), or "1" (ICMP), traffic on all ports is allowed, regardless of any ports or ICMP types or codes that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP types and codes allowed, regardless of any that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv6 CIDR block, you must specify an ICMP type and code.' - schema: - type: string - - name: RuleAction - in: query - required: true - description: Indicates whether to allow or deny the traffic that matches the rule. - schema: - type: string - enum: - - allow - - deny - - name: RuleNumber - in: query - required: true - description: '

The rule number for the entry (for example, 100). ACL entries are processed in ascending order by rule number.

Constraints: Positive integer from 1 to 32766. The range 32767 to 65535 is reserved for internal use.

' - schema: - type: integer - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateNetworkAclEntry - operationId: POST_CreateNetworkAclEntry - description: '

Creates an entry (a rule) in a network ACL with the specified rule number. Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated with the ACL, we process the entries in the ACL according to the rule numbers, in ascending order. Each network ACL has a set of ingress rules and a separate set of egress rules.

We recommend that you leave room between the rule numbers (for example, 100, 110, 120, ...), and not number them one right after the other (for example, 101, 102, 103, ...). This makes it easier to add a rule between existing ones without having to renumber the rules.

After you add an entry, you can''t modify it; you must either replace it, or create an entry and delete the old one.

For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

' - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateNetworkAclEntryRequest' - parameters: [] - /?Action=CreateNetworkInsightsAccessScope&Version=2016-11-15: - get: - x-aws-operation-name: CreateNetworkInsightsAccessScope - operationId: GET_CreateNetworkInsightsAccessScope - description: '

Creates a Network Access Scope.

Amazon Web Services Network Access Analyzer enables cloud networking and cloud operations teams to verify that their networks on Amazon Web Services conform to their network security and governance objectives. For more information, see the Amazon Web Services Network Access Analyzer Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateNetworkInsightsAccessScopeResult' - parameters: - - name: MatchPath - in: query - required: false - description: The paths to match. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/AccessScopePathRequest' - - xml: - name: item - - name: ExcludePath - in: query - required: false - description: The paths to exclude. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/AccessScopePathRequest' - - xml: - name: item - - name: ClientToken - in: query - required: true - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.' - schema: - type: string - - name: TagSpecification - in: query - required: false - description: The tags to apply. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateNetworkInsightsAccessScope - operationId: POST_CreateNetworkInsightsAccessScope - description: '

Creates a Network Access Scope.

Amazon Web Services Network Access Analyzer enables cloud networking and cloud operations teams to verify that their networks on Amazon Web Services conform to their network security and governance objectives. For more information, see the Amazon Web Services Network Access Analyzer Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateNetworkInsightsAccessScopeResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateNetworkInsightsAccessScopeRequest' - parameters: [] - /?Action=CreateNetworkInsightsPath&Version=2016-11-15: - get: - x-aws-operation-name: CreateNetworkInsightsPath - operationId: GET_CreateNetworkInsightsPath - description: '

Creates a path to analyze for reachability.

Reachability Analyzer enables you to analyze and debug network reachability between two resources in your virtual private cloud (VPC). For more information, see What is Reachability Analyzer.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateNetworkInsightsPathResult' - parameters: - - name: SourceIp - in: query - required: false - description: The IP address of the Amazon Web Services resource that is the source of the path. - schema: - type: string - pattern: '^([0-9]{1,3}.){3}[0-9]{1,3}$' - minLength: 0 - maxLength: 15 - - name: DestinationIp - in: query - required: false - description: The IP address of the Amazon Web Services resource that is the destination of the path. - schema: - type: string - pattern: '^([0-9]{1,3}.){3}[0-9]{1,3}$' - minLength: 0 - maxLength: 15 - - name: Source - in: query - required: true - description: The Amazon Web Services resource that is the source of the path. - schema: - type: string - - name: Destination - in: query - required: true - description: The Amazon Web Services resource that is the destination of the path. - schema: - type: string - - name: Protocol - in: query - required: true - description: The protocol. - schema: - type: string - enum: - - tcp - - udp - - name: DestinationPort - in: query - required: false - description: The destination port. - schema: - type: integer - minimum: 1 - maximum: 65535 - - name: TagSpecification - in: query - required: false - description: The tags to add to the path. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: ClientToken - in: query - required: true - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.' - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateNetworkInsightsPath - operationId: POST_CreateNetworkInsightsPath - description: '

Creates a path to analyze for reachability.

Reachability Analyzer enables you to analyze and debug network reachability between two resources in your virtual private cloud (VPC). For more information, see What is Reachability Analyzer.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateNetworkInsightsPathResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateNetworkInsightsPathRequest' - parameters: [] - /?Action=CreateNetworkInterface&Version=2016-11-15: - get: - x-aws-operation-name: CreateNetworkInterface - operationId: GET_CreateNetworkInterface - description: '

Creates a network interface in the specified subnet.

For more information about network interfaces, see Elastic Network Interfaces in the Amazon Virtual Private Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateNetworkInterfaceResult' - parameters: - - name: Description - in: query - required: false - description: A description for the network interface. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: SecurityGroupId - in: query - required: false - description: The IDs of one or more security groups. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/SecurityGroupId' - - xml: - name: SecurityGroupId - - name: Ipv6AddressCount - in: query - required: false - description: 'The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can''t use this option if specifying specific IPv6 addresses. If your subnet has the AssignIpv6AddressOnCreation attribute set to true, you can specify 0 to override this setting.' - schema: - type: integer - - name: Ipv6Addresses - in: query - required: false - description: One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/InstanceIpv6Address' - - xml: - name: item - - name: PrivateIpAddress - in: query - required: false - description: 'The primary private IPv4 address of the network interface. If you don''t specify an IPv4 address, Amazon EC2 selects one for you from the subnet''s IPv4 CIDR range. If you specify an IP address, you cannot indicate any IP addresses specified in privateIpAddresses as primary (only one IP address can be designated as primary).' - schema: - type: string - - name: PrivateIpAddresses - in: query - required: false - description: One or more private IPv4 addresses. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/PrivateIpAddressSpecification' - - xml: - name: item - - name: SecondaryPrivateIpAddressCount - in: query - required: false - description: '

The number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet''s IPv4 CIDR range. You can''t specify this option and specify more than one private IP address using privateIpAddresses.

The number of IP addresses you can assign to a network interface varies by instance type. For more information, see IP Addresses Per ENI Per Instance Type in the Amazon Virtual Private Cloud User Guide.

' - schema: - type: integer - - name: Ipv4Prefix - in: query - required: false - description: One or more IPv4 prefixes assigned to the network interface. You cannot use this option if you use the Ipv4PrefixCount option. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Ipv4PrefixSpecificationRequest' - - xml: - name: item - - name: Ipv4PrefixCount - in: query - required: false - description: The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use the Ipv4 Prefixes option. - schema: - type: integer - - name: Ipv6Prefix - in: query - required: false - description: One or more IPv6 prefixes assigned to the network interface. You cannot use this option if you use the Ipv6PrefixCount option. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Ipv6PrefixSpecificationRequest' - - xml: - name: item - - name: Ipv6PrefixCount - in: query - required: false - description: The number of IPv6 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use the Ipv6Prefixes option. - schema: - type: integer - - name: InterfaceType - in: query - required: false - description:

The type of network interface. The default is interface.

The only supported values are efa and trunk.

- schema: - type: string - enum: - - efa - - branch - - trunk - - name: SubnetId - in: query - required: true - description: The ID of the subnet to associate with the network interface. - schema: - type: string - - name: TagSpecification - in: query - required: false - description: The tags to apply to the new network interface. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - - name: ClientToken - in: query - required: false - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.' - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateNetworkInterface - operationId: POST_CreateNetworkInterface - description: '

Creates a network interface in the specified subnet.

For more information about network interfaces, see Elastic Network Interfaces in the Amazon Virtual Private Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateNetworkInterfaceResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateNetworkInterfaceRequest' - parameters: [] - /?Action=CreateNetworkInterfacePermission&Version=2016-11-15: - get: - x-aws-operation-name: CreateNetworkInterfacePermission - operationId: GET_CreateNetworkInterfacePermission - description: '

Grants an Amazon Web Services-authorized account permission to attach the specified network interface to an instance in their account.

You can grant permission to a single Amazon Web Services account only, and only one account at a time.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateNetworkInterfacePermissionResult' - parameters: - - name: NetworkInterfaceId - in: query - required: true - description: The ID of the network interface. - schema: - type: string - - name: AwsAccountId - in: query - required: false - description: The Amazon Web Services account ID. - schema: - type: string - - name: AwsService - in: query - required: false - description: The Amazon Web Service. Currently not supported. - schema: - type: string - - name: Permission - in: query - required: true - description: The type of permission to grant. - schema: - type: string - enum: - - INSTANCE-ATTACH - - EIP-ASSOCIATE - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateNetworkInterfacePermission - operationId: POST_CreateNetworkInterfacePermission - description: '

Grants an Amazon Web Services-authorized account permission to attach the specified network interface to an instance in their account.

You can grant permission to a single Amazon Web Services account only, and only one account at a time.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateNetworkInterfacePermissionResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateNetworkInterfacePermissionRequest' - parameters: [] - /?Action=CreatePlacementGroup&Version=2016-11-15: - get: - x-aws-operation-name: CreatePlacementGroup - operationId: GET_CreatePlacementGroup - description: '

Creates a placement group in which to launch instances. The strategy of the placement group determines how the instances are organized within the group.

A cluster placement group is a logical grouping of instances within a single Availability Zone that benefit from low network latency, high network throughput. A spread placement group places instances on distinct hardware. A partition placement group places groups of instances in different partitions, where instances in one partition do not share the same hardware with instances in another partition.

For more information, see Placement groups in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreatePlacementGroupResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: GroupName - in: query - required: false - description: '

A name for the placement group. Must be unique within the scope of your account for the Region.

Constraints: Up to 255 ASCII characters

' - schema: - type: string - - name: Strategy - in: query - required: false - description: The placement strategy. - schema: - type: string - enum: - - cluster - - spread - - partition - - name: PartitionCount - in: query - required: false - description: The number of partitions. Valid only when Strategy is set to partition. - schema: - type: integer - - name: TagSpecification - in: query - required: false - description: The tags to apply to the new placement group. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreatePlacementGroup - operationId: POST_CreatePlacementGroup - description: '

Creates a placement group in which to launch instances. The strategy of the placement group determines how the instances are organized within the group.

A cluster placement group is a logical grouping of instances within a single Availability Zone that benefit from low network latency, high network throughput. A spread placement group places instances on distinct hardware. A partition placement group places groups of instances in different partitions, where instances in one partition do not share the same hardware with instances in another partition.

For more information, see Placement groups in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreatePlacementGroupResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreatePlacementGroupRequest' - parameters: [] - /?Action=CreatePublicIpv4Pool&Version=2016-11-15: - get: - x-aws-operation-name: CreatePublicIpv4Pool - operationId: GET_CreatePublicIpv4Pool - description: 'Creates a public IPv4 address pool. A public IPv4 pool is an EC2 IP address pool required for the public IPv4 CIDRs that you own and bring to Amazon Web Services to manage with IPAM. IPv6 addresses you bring to Amazon Web Services, however, use IPAM pools only. To monitor the status of pool creation, use DescribePublicIpv4Pools.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreatePublicIpv4PoolResult' - parameters: - - name: DryRun - in: query - required: false - description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: TagSpecification - in: query - required: false - description: '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. 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.' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreatePublicIpv4Pool - operationId: POST_CreatePublicIpv4Pool - description: 'Creates a public IPv4 address pool. A public IPv4 pool is an EC2 IP address pool required for the public IPv4 CIDRs that you own and bring to Amazon Web Services to manage with IPAM. IPv6 addresses you bring to Amazon Web Services, however, use IPAM pools only. To monitor the status of pool creation, use DescribePublicIpv4Pools.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreatePublicIpv4PoolResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreatePublicIpv4PoolRequest' - parameters: [] - /?Action=CreateReplaceRootVolumeTask&Version=2016-11-15: - get: - x-aws-operation-name: CreateReplaceRootVolumeTask - operationId: GET_CreateReplaceRootVolumeTask - description: '

Creates a root volume replacement task for an Amazon EC2 instance. The root volume can either be restored to its initial launch state, or it can be restored using a specific snapshot.

For more information, see Replace a root volume in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateReplaceRootVolumeTaskResult' - parameters: - - name: InstanceId - in: query - required: true - description: The ID of the instance for which to replace the root volume. - schema: - type: string - - name: SnapshotId - in: query - required: false - description: 'The ID of the snapshot from which to restore the replacement root volume. If you want to restore the volume to the initial launch state, omit this parameter.' - schema: - type: string - - name: ClientToken - in: query - required: false - description: 'Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency. For more information, see Ensuring idempotency.' - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: TagSpecification - in: query - required: false - description: The tags to apply to the root volume replacement task. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateReplaceRootVolumeTask - operationId: POST_CreateReplaceRootVolumeTask - description: '

Creates a root volume replacement task for an Amazon EC2 instance. The root volume can either be restored to its initial launch state, or it can be restored using a specific snapshot.

For more information, see Replace a root volume in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateReplaceRootVolumeTaskResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateReplaceRootVolumeTaskRequest' - parameters: [] - /?Action=CreateReservedInstancesListing&Version=2016-11-15: - get: - x-aws-operation-name: CreateReservedInstancesListing - operationId: GET_CreateReservedInstancesListing - description: '

Creates a listing for Amazon EC2 Standard Reserved Instances to be sold in the Reserved Instance Marketplace. You can submit one Standard Reserved Instance listing at a time. To get a list of your Standard Reserved Instances, you can use the DescribeReservedInstances operation.

Only Standard Reserved Instances can be sold in the Reserved Instance Marketplace. Convertible Reserved Instances cannot be sold.

The Reserved Instance Marketplace matches sellers who want to resell Standard Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.

To sell your Standard Reserved Instances, you must first register as a seller in the Reserved Instance Marketplace. After completing the registration process, you can create a Reserved Instance Marketplace listing of some or all of your Standard Reserved Instances, and specify the upfront price to receive for them. Your Standard Reserved Instance listings then become available for purchase. To view the details of your Standard Reserved Instance listing, you can use the DescribeReservedInstancesListings operation.

For more information, see Reserved Instance Marketplace in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateReservedInstancesListingResult' - parameters: - - name: ClientToken - in: query - required: true - description: 'Unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see Ensuring Idempotency.' - schema: - type: string - - name: InstanceCount - in: query - required: true - description: The number of instances that are a part of a Reserved Instance account to be listed in the Reserved Instance Marketplace. This number should be less than or equal to the instance count associated with the Reserved Instance ID specified in this call. - schema: - type: integer - - name: PriceSchedules - in: query - required: true - description: A list specifying the price of the Standard Reserved Instance for each month remaining in the Reserved Instance term. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/PriceScheduleSpecification' - - xml: - name: item - - name: ReservedInstancesId - in: query - required: true - description: The ID of the active Standard Reserved Instance. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateReservedInstancesListing - operationId: POST_CreateReservedInstancesListing - description: '

Creates a listing for Amazon EC2 Standard Reserved Instances to be sold in the Reserved Instance Marketplace. You can submit one Standard Reserved Instance listing at a time. To get a list of your Standard Reserved Instances, you can use the DescribeReservedInstances operation.

Only Standard Reserved Instances can be sold in the Reserved Instance Marketplace. Convertible Reserved Instances cannot be sold.

The Reserved Instance Marketplace matches sellers who want to resell Standard Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.

To sell your Standard Reserved Instances, you must first register as a seller in the Reserved Instance Marketplace. After completing the registration process, you can create a Reserved Instance Marketplace listing of some or all of your Standard Reserved Instances, and specify the upfront price to receive for them. Your Standard Reserved Instance listings then become available for purchase. To view the details of your Standard Reserved Instance listing, you can use the DescribeReservedInstancesListings operation.

For more information, see Reserved Instance Marketplace in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateReservedInstancesListingResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateReservedInstancesListingRequest' - parameters: [] - /?Action=CreateRestoreImageTask&Version=2016-11-15: - get: - x-aws-operation-name: CreateRestoreImageTask - operationId: GET_CreateRestoreImageTask - description: '

Starts a task that restores an AMI from an Amazon S3 object that was previously created by using CreateStoreImageTask.

To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the Amazon Elastic Compute Cloud User Guide.

For more information, see Store and restore an AMI using Amazon S3 in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateRestoreImageTaskResult' - parameters: - - name: Bucket - in: query - required: true - description: The name of the Amazon S3 bucket that contains the stored AMI object. - schema: - type: string - - name: ObjectKey - in: query - required: true - description: The name of the stored AMI object in the bucket. - schema: - type: string - - name: Name - in: query - required: false - description: 'The name for the restored AMI. The name must be unique for AMIs in the Region for this account. If you do not provide a name, the new AMI gets the same name as the original AMI.' - schema: - type: string - - name: TagSpecification - in: query - required: false - description: '

The tags to apply to the AMI and snapshots on restoration. You can tag the AMI, the snapshots, or both.

  • To tag the AMI, the value for ResourceType must be image.

  • To tag the snapshots, the value for ResourceType must be snapshot. The same tag is applied to all of the snapshots that are created.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateRestoreImageTask - operationId: POST_CreateRestoreImageTask - description: '

Starts a task that restores an AMI from an Amazon S3 object that was previously created by using CreateStoreImageTask.

To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the Amazon Elastic Compute Cloud User Guide.

For more information, see Store and restore an AMI using Amazon S3 in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateRestoreImageTaskResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateRestoreImageTaskRequest' - parameters: [] - /?Action=CreateRoute&Version=2016-11-15: - get: - x-aws-operation-name: CreateRoute - operationId: GET_CreateRoute - description: '

Creates a route in a route table within a VPC.

You must specify one of the following targets: internet gateway or virtual private gateway, NAT instance, NAT gateway, VPC peering connection, network interface, egress-only internet gateway, or transit gateway.

When determining how to route traffic, we use the route with the most specific match. For example, traffic is destined for the IPv4 address 192.0.2.3, and the route table includes the following two IPv4 routes:

  • 192.0.2.0/24 (goes to some target A)

  • 192.0.2.0/28 (goes to some target B)

Both routes apply to the traffic destined for 192.0.2.3. However, the second route in the list covers a smaller number of IP addresses and is therefore more specific, so we use that route to determine where to target the traffic.

For more information about route tables, see Route tables in the Amazon Virtual Private Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateRouteResult' - parameters: - - name: DestinationCidrBlock - in: query - required: false - description: 'The IPv4 CIDR address block used for the destination match. Routing decisions are based on the most specific match. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.' - schema: - type: string - - name: DestinationIpv6CidrBlock - in: query - required: false - description: The IPv6 CIDR block used for the destination match. Routing decisions are based on the most specific match. - schema: - type: string - - name: DestinationPrefixListId - in: query - required: false - description: The ID of a prefix list used for the destination match. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: VpcEndpointId - in: query - required: false - description: The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only. - schema: - type: string - - name: EgressOnlyInternetGatewayId - in: query - required: false - description: '[IPv6 traffic only] The ID of an egress-only internet gateway.' - schema: - type: string - - name: GatewayId - in: query - required: false - description: The ID of an internet gateway or virtual private gateway attached to your VPC. - schema: - type: string - - name: InstanceId - in: query - required: false - description: The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached. - schema: - type: string - - name: NatGatewayId - in: query - required: false - description: '[IPv4 traffic only] The ID of a NAT gateway.' - schema: - type: string - - name: TransitGatewayId - in: query - required: false - description: The ID of a transit gateway. - schema: - type: string - - name: LocalGatewayId - in: query - required: false - description: The ID of the local gateway. - schema: - type: string - - name: CarrierGatewayId - in: query - required: false - description:

The ID of the carrier gateway.

You can only use this option when the VPC contains a subnet which is associated with a Wavelength Zone.

- schema: - type: string - - name: NetworkInterfaceId - in: query - required: false - description: The ID of a network interface. - schema: - type: string - - name: RouteTableId - in: query - required: true - description: The ID of the route table for the route. - schema: - type: string - - name: VpcPeeringConnectionId - in: query - required: false - description: The ID of a VPC peering connection. - schema: - type: string - - name: CoreNetworkArn - in: query - required: false - description: The Amazon Resource Name (ARN) of the core network. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateRoute - operationId: POST_CreateRoute - description: '

Creates a route in a route table within a VPC.

You must specify one of the following targets: internet gateway or virtual private gateway, NAT instance, NAT gateway, VPC peering connection, network interface, egress-only internet gateway, or transit gateway.

When determining how to route traffic, we use the route with the most specific match. For example, traffic is destined for the IPv4 address 192.0.2.3, and the route table includes the following two IPv4 routes:

  • 192.0.2.0/24 (goes to some target A)

  • 192.0.2.0/28 (goes to some target B)

Both routes apply to the traffic destined for 192.0.2.3. However, the second route in the list covers a smaller number of IP addresses and is therefore more specific, so we use that route to determine where to target the traffic.

For more information about route tables, see Route tables in the Amazon Virtual Private Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateRouteResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateRouteRequest' - parameters: [] - /?Action=CreateRouteTable&Version=2016-11-15: - get: - x-aws-operation-name: CreateRouteTable - operationId: GET_CreateRouteTable - description: '

Creates a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet.

For more information, see Route tables in the Amazon Virtual Private Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateRouteTableResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: VpcId - in: query - required: true - description: The ID of the VPC. - schema: - type: string - - name: TagSpecification - in: query - required: false - description: The tags to assign to the route table. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateRouteTable - operationId: POST_CreateRouteTable - description: '

Creates a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet.

For more information, see Route tables in the Amazon Virtual Private Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateRouteTableResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateRouteTableRequest' - parameters: [] - /?Action=CreateSecurityGroup&Version=2016-11-15: - get: - x-aws-operation-name: CreateSecurityGroup - operationId: GET_CreateSecurityGroup - description: '

Creates a security group.

A security group acts as a virtual firewall for your instance to control inbound and outbound traffic. For more information, see Amazon EC2 security groups in the Amazon Elastic Compute Cloud User Guide and Security groups for your VPC in the Amazon Virtual Private Cloud User Guide.

When you create a security group, you specify a friendly name of your choice. You can have a security group for use in EC2-Classic with the same name as a security group for use in a VPC. However, you can''t have two security groups for use in EC2-Classic with the same name or two security groups for use in a VPC with the same name.

You have a default security group for use in EC2-Classic and a default security group for use in your VPC. If you don''t specify a security group when you launch an instance, the instance is launched into the appropriate default security group. A default security group includes a default rule that grants instances unrestricted network access to each other.

You can add or remove rules from your security groups using AuthorizeSecurityGroupIngress, AuthorizeSecurityGroupEgress, RevokeSecurityGroupIngress, and RevokeSecurityGroupEgress.

For more information about VPC security group limits, see Amazon VPC Limits.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateSecurityGroupResult' - parameters: - - name: GroupDescription - in: query - required: true - description: '

A description for the security group. This is informational only.

Constraints: Up to 255 characters in length

Constraints for EC2-Classic: ASCII characters

Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*

' - schema: - type: string - - name: GroupName - in: query - required: true - description: '

The name of the security group.

Constraints: Up to 255 characters in length. Cannot start with sg-.

Constraints for EC2-Classic: ASCII characters

Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*

' - schema: - type: string - - name: VpcId - in: query - required: false - description: '[EC2-VPC] The ID of the VPC. Required for EC2-VPC.' - schema: - type: string - - name: TagSpecification - in: query - required: false - description: The tags to assign to the security group. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateSecurityGroup - operationId: POST_CreateSecurityGroup - description: '

Creates a security group.

A security group acts as a virtual firewall for your instance to control inbound and outbound traffic. For more information, see Amazon EC2 security groups in the Amazon Elastic Compute Cloud User Guide and Security groups for your VPC in the Amazon Virtual Private Cloud User Guide.

When you create a security group, you specify a friendly name of your choice. You can have a security group for use in EC2-Classic with the same name as a security group for use in a VPC. However, you can''t have two security groups for use in EC2-Classic with the same name or two security groups for use in a VPC with the same name.

You have a default security group for use in EC2-Classic and a default security group for use in your VPC. If you don''t specify a security group when you launch an instance, the instance is launched into the appropriate default security group. A default security group includes a default rule that grants instances unrestricted network access to each other.

You can add or remove rules from your security groups using AuthorizeSecurityGroupIngress, AuthorizeSecurityGroupEgress, RevokeSecurityGroupIngress, and RevokeSecurityGroupEgress.

For more information about VPC security group limits, see Amazon VPC Limits.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateSecurityGroupResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateSecurityGroupRequest' - parameters: [] - /?Action=CreateSnapshot&Version=2016-11-15: - get: - x-aws-operation-name: CreateSnapshot - operationId: GET_CreateSnapshot - description: '

Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of EBS volumes, and to save data before shutting down an instance.

You can create snapshots of volumes in a Region and volumes on an Outpost. If you create a snapshot of a volume in a Region, the snapshot must be stored in the same Region as the volume. If you create a snapshot of a volume on an Outpost, the snapshot can be stored on the same Outpost as the volume, or in the Region for that Outpost.

When a snapshot is created, any Amazon Web Services Marketplace product codes that are associated with the source volume are propagated to the snapshot.

You can take a snapshot of an attached volume that is in use. However, snapshots only capture data that has been written to your Amazon EBS volume at the time the snapshot command is issued; this might exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the volume long enough to take a snapshot, your snapshot should be complete. However, if you cannot pause all file writes to the volume, you should unmount the volume from within the instance, issue the snapshot command, and then remount the volume to ensure a consistent and complete snapshot. You may remount and use your volume while the snapshot status is pending.

To create a snapshot for Amazon EBS volumes that serve as root devices, you should stop the instance before taking the snapshot.

Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes and any associated snapshots always remain protected.

You can tag your snapshots during creation. For more information, see Tag your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide.

For more information, see Amazon Elastic Block Store and Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/Snapshot' - parameters: - - name: Description - in: query - required: false - description: A description for the snapshot. - schema: - type: string - - name: OutpostArn - in: query - required: false - description: '

The Amazon Resource Name (ARN) of the Outpost on which to create a local snapshot.

  • To create a snapshot of a volume in a Region, omit this parameter. The snapshot is created in the same Region as the volume.

  • To create a snapshot of a volume on an Outpost and store the snapshot in the Region, omit this parameter. The snapshot is created in the Region for the Outpost.

  • To create a snapshot of a volume on an Outpost and store the snapshot on an Outpost, specify the ARN of the destination Outpost. The snapshot must be created on the same Outpost as the volume.

For more information, see Create local snapshots from volumes on an Outpost in the Amazon Elastic Compute Cloud User Guide.

' - schema: - type: string - - name: VolumeId - in: query - required: true - description: The ID of the Amazon EBS volume. - schema: - type: string - - name: TagSpecification - in: query - required: false - description: The tags to apply to the snapshot during creation. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateSnapshot - operationId: POST_CreateSnapshot - description: '

Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of EBS volumes, and to save data before shutting down an instance.

You can create snapshots of volumes in a Region and volumes on an Outpost. If you create a snapshot of a volume in a Region, the snapshot must be stored in the same Region as the volume. If you create a snapshot of a volume on an Outpost, the snapshot can be stored on the same Outpost as the volume, or in the Region for that Outpost.

When a snapshot is created, any Amazon Web Services Marketplace product codes that are associated with the source volume are propagated to the snapshot.

You can take a snapshot of an attached volume that is in use. However, snapshots only capture data that has been written to your Amazon EBS volume at the time the snapshot command is issued; this might exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the volume long enough to take a snapshot, your snapshot should be complete. However, if you cannot pause all file writes to the volume, you should unmount the volume from within the instance, issue the snapshot command, and then remount the volume to ensure a consistent and complete snapshot. You may remount and use your volume while the snapshot status is pending.

To create a snapshot for Amazon EBS volumes that serve as root devices, you should stop the instance before taking the snapshot.

Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes and any associated snapshots always remain protected.

You can tag your snapshots during creation. For more information, see Tag your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide.

For more information, see Amazon Elastic Block Store and Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/Snapshot' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateSnapshotRequest' - parameters: [] - /?Action=CreateSnapshots&Version=2016-11-15: - get: - x-aws-operation-name: CreateSnapshots - operationId: GET_CreateSnapshots - description: '

Creates crash-consistent snapshots of multiple EBS volumes and stores the data in S3. Volumes are chosen by specifying an instance. Any attached volumes will produce one snapshot each that is crash-consistent across the instance. Boot volumes can be excluded by changing the parameters.

You can create multi-volume snapshots of instances in a Region and instances on an Outpost. If you create snapshots from an instance in a Region, the snapshots must be stored in the same Region as the instance. If you create snapshots from an instance on an Outpost, the snapshots can be stored on the same Outpost as the instance, or in the Region for that Outpost.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateSnapshotsResult' - parameters: - - name: Description - in: query - required: false - description: ' A description propagated to every snapshot specified by the instance.' - schema: - type: string - - name: InstanceSpecification - in: query - required: true - description: The instance to specify which volumes should be included in the snapshots. - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Excludes the root volume from being snapshotted. - description: The instance details to specify which volumes should be snapshotted. - - name: OutpostArn - in: query - required: false - description: '

The Amazon Resource Name (ARN) of the Outpost on which to create the local snapshots.

  • To create snapshots from an instance in a Region, omit this parameter. The snapshots are created in the same Region as the instance.

  • To create snapshots from an instance on an Outpost and store the snapshots in the Region, omit this parameter. The snapshots are created in the Region for the Outpost.

  • To create snapshots from an instance on an Outpost and store the snapshots on an Outpost, specify the ARN of the destination Outpost. The snapshots must be created on the same Outpost as the instance.

For more information, see Create multi-volume local snapshots from instances on an Outpost in the Amazon Elastic Compute Cloud User Guide.

' - schema: - type: string - - name: TagSpecification - in: query - required: false - description: Tags to apply to every snapshot specified by the instance. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: CopyTagsFromSource - in: query - required: false - description: Copies the tags from the specified volume to corresponding snapshot. - schema: - type: string - enum: - - volume - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateSnapshots - operationId: POST_CreateSnapshots - description: '

Creates crash-consistent snapshots of multiple EBS volumes and stores the data in S3. Volumes are chosen by specifying an instance. Any attached volumes will produce one snapshot each that is crash-consistent across the instance. Boot volumes can be excluded by changing the parameters.

You can create multi-volume snapshots of instances in a Region and instances on an Outpost. If you create snapshots from an instance in a Region, the snapshots must be stored in the same Region as the instance. If you create snapshots from an instance on an Outpost, the snapshots can be stored on the same Outpost as the instance, or in the Region for that Outpost.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateSnapshotsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateSnapshotsRequest' - parameters: [] - /?Action=CreateSpotDatafeedSubscription&Version=2016-11-15: - get: - x-aws-operation-name: CreateSpotDatafeedSubscription - operationId: GET_CreateSpotDatafeedSubscription - description: 'Creates a data feed for Spot Instances, enabling you to view Spot Instance usage logs. You can create one data feed per Amazon Web Services account. For more information, see Spot Instance data feed in the Amazon EC2 User Guide for Linux Instances.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateSpotDatafeedSubscriptionResult' - parameters: - - name: Bucket - in: query - required: true - description: 'The name of the Amazon S3 bucket in which to store the Spot Instance data feed. For more information about bucket names, see Rules for bucket naming in the Amazon S3 Developer Guide.' - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: Prefix - in: query - required: false - description: The prefix for the data feed file names. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateSpotDatafeedSubscription - operationId: POST_CreateSpotDatafeedSubscription - description: 'Creates a data feed for Spot Instances, enabling you to view Spot Instance usage logs. You can create one data feed per Amazon Web Services account. For more information, see Spot Instance data feed in the Amazon EC2 User Guide for Linux Instances.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateSpotDatafeedSubscriptionResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateSpotDatafeedSubscriptionRequest' - parameters: [] - /?Action=CreateStoreImageTask&Version=2016-11-15: - get: - x-aws-operation-name: CreateStoreImageTask - operationId: GET_CreateStoreImageTask - description: '

Stores an AMI as a single object in an Amazon S3 bucket.

To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the Amazon Elastic Compute Cloud User Guide.

For more information, see Store and restore an AMI using Amazon S3 in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateStoreImageTaskResult' - parameters: - - name: ImageId - in: query - required: true - description: The ID of the AMI. - schema: - type: string - - name: Bucket - in: query - required: true - description: 'The name of the Amazon S3 bucket in which the AMI object will be stored. The bucket must be in the Region in which the request is being made. The AMI object appears in the bucket only after the upload task has completed. ' - schema: - type: string - - name: S3ObjectTag - in: query - required: false - description: 'The tags to apply to the AMI object that will be stored in the Amazon S3 bucket. ' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/S3ObjectTag' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateStoreImageTask - operationId: POST_CreateStoreImageTask - description: '

Stores an AMI as a single object in an Amazon S3 bucket.

To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the Amazon Elastic Compute Cloud User Guide.

For more information, see Store and restore an AMI using Amazon S3 in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateStoreImageTaskResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateStoreImageTaskRequest' - parameters: [] - /?Action=CreateSubnet&Version=2016-11-15: - get: - x-aws-operation-name: CreateSubnet - operationId: GET_CreateSubnet - description: '

Creates a subnet in a specified VPC.

You must specify an IPv4 CIDR block for the subnet. After you create a subnet, you can''t change its CIDR block. The allowed block size is between a /16 netmask (65,536 IP addresses) and /28 netmask (16 IP addresses). The CIDR block must not overlap with the CIDR block of an existing subnet in the VPC.

If you''ve associated an IPv6 CIDR block with your VPC, you can create a subnet with an IPv6 CIDR block that uses a /64 prefix length.

Amazon Web Services reserves both the first four and the last IPv4 address in each subnet''s CIDR block. They''re not available for use.

If you add more than one subnet to a VPC, they''re set up in a star topology with a logical router in the middle.

When you stop an instance in a subnet, it retains its private IPv4 address. It''s therefore possible to have a subnet with no running instances (they''re all stopped), but no remaining IP addresses available.

For more information about subnets, see Your VPC and subnets in the Amazon Virtual Private Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateSubnetResult' - parameters: - - name: TagSpecification - in: query - required: false - description: The tags to assign to the subnet. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - - name: AvailabilityZone - in: query - required: false - description: '

The Availability Zone or Local Zone for the subnet.

Default: Amazon Web Services selects one for you. If you create more than one subnet in your VPC, we do not necessarily select a different zone for each subnet.

To create a subnet in a Local Zone, set this value to the Local Zone ID, for example us-west-2-lax-1a. For information about the Regions that support Local Zones, see Available Regions in the Amazon Elastic Compute Cloud User Guide.

To create a subnet in an Outpost, set this value to the Availability Zone for the Outpost and specify the Outpost ARN.

' - schema: - type: string - - name: AvailabilityZoneId - in: query - required: false - description: The AZ ID or the Local Zone ID of the subnet. - schema: - type: string - - name: CidrBlock - in: query - required: false - description: '

The IPv4 network range for the subnet, in CIDR notation. For example, 10.0.0.0/24. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.

This parameter is not supported for an IPv6 only subnet.

' - schema: - type: string - - name: Ipv6CidrBlock - in: query - required: false - description: '

The IPv6 network range for the subnet, in CIDR notation. The subnet size must use a /64 prefix length.

This parameter is required for an IPv6 only subnet.

' - schema: - type: string - - name: OutpostArn - in: query - required: false - description: 'The Amazon Resource Name (ARN) of the Outpost. If you specify an Outpost ARN, you must also specify the Availability Zone of the Outpost subnet.' - schema: - type: string - - name: VpcId - in: query - required: true - description: The ID of the VPC. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: Ipv6Native - in: query - required: false - description: Indicates whether to create an IPv6 only subnet. - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateSubnet - operationId: POST_CreateSubnet - description: '

Creates a subnet in a specified VPC.

You must specify an IPv4 CIDR block for the subnet. After you create a subnet, you can''t change its CIDR block. The allowed block size is between a /16 netmask (65,536 IP addresses) and /28 netmask (16 IP addresses). The CIDR block must not overlap with the CIDR block of an existing subnet in the VPC.

If you''ve associated an IPv6 CIDR block with your VPC, you can create a subnet with an IPv6 CIDR block that uses a /64 prefix length.

Amazon Web Services reserves both the first four and the last IPv4 address in each subnet''s CIDR block. They''re not available for use.

If you add more than one subnet to a VPC, they''re set up in a star topology with a logical router in the middle.

When you stop an instance in a subnet, it retains its private IPv4 address. It''s therefore possible to have a subnet with no running instances (they''re all stopped), but no remaining IP addresses available.

For more information about subnets, see Your VPC and subnets in the Amazon Virtual Private Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateSubnetResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateSubnetRequest' - parameters: [] - /?Action=CreateSubnetCidrReservation&Version=2016-11-15: - get: - x-aws-operation-name: CreateSubnetCidrReservation - operationId: GET_CreateSubnetCidrReservation - description: 'Creates a subnet CIDR reservation. For information about subnet CIDR reservations, see Subnet CIDR reservations in the Amazon Virtual Private Cloud User Guide.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateSubnetCidrReservationResult' - parameters: - - name: SubnetId - in: query - required: true - description: The ID of the subnet. - schema: - type: string - - name: Cidr - in: query - required: true - description: The IPv4 or IPV6 CIDR range to reserve. - schema: - type: string - - name: ReservationType - in: query - required: true - description: '

The type of reservation.

The following are valid values:

  • prefix: The Amazon EC2 Prefix Delegation feature assigns the IP addresses to network interfaces that are associated with an instance. For information about Prefix Delegation, see Prefix Delegation for Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.

  • explicit: You manually assign the IP addresses to resources that reside in your subnet.

' - schema: - type: string - enum: - - prefix - - explicit - - name: Description - in: query - required: false - description: The description to assign to the subnet CIDR reservation. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: TagSpecification - in: query - required: false - description: The tags to assign to the subnet CIDR reservation. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateSubnetCidrReservation - operationId: POST_CreateSubnetCidrReservation - description: 'Creates a subnet CIDR reservation. For information about subnet CIDR reservations, see Subnet CIDR reservations in the Amazon Virtual Private Cloud User Guide.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateSubnetCidrReservationResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateSubnetCidrReservationRequest' - parameters: [] - /?Action=CreateTags&Version=2016-11-15: - get: - x-aws-operation-name: CreateTags - operationId: GET_CreateTags - description: '

Adds or overwrites only the specified tags for the specified Amazon EC2 resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource.

For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide. For more information about creating IAM policies that control users'' access to resources based on tags, see Supported Resource-Level Permissions for Amazon EC2 API Actions in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: ResourceId - in: query - required: true - description: '

The IDs of the resources, separated by spaces.

Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.

' - schema: - type: array - items: - $ref: '#/components/schemas/TaggableResourceId' - - name: Tag - in: query - required: true - description: 'The tags. The value parameter is required, but if you don''t want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Tag' - - xml: - name: item - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateTags - operationId: POST_CreateTags - description: '

Adds or overwrites only the specified tags for the specified Amazon EC2 resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource.

For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide. For more information about creating IAM policies that control users'' access to resources based on tags, see Supported Resource-Level Permissions for Amazon EC2 API Actions in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTagsRequest' - parameters: [] - /?Action=CreateTrafficMirrorFilter&Version=2016-11-15: - get: - x-aws-operation-name: CreateTrafficMirrorFilter - operationId: GET_CreateTrafficMirrorFilter - description: '

Creates a Traffic Mirror filter.

A Traffic Mirror filter is a set of rules that defines the traffic to mirror.

By default, no traffic is mirrored. To mirror traffic, use CreateTrafficMirrorFilterRule to add Traffic Mirror rules to the filter. The rules you add define what traffic gets mirrored. You can also use ModifyTrafficMirrorFilterNetworkServices to mirror supported network services.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTrafficMirrorFilterResult' - parameters: - - name: Description - in: query - required: false - description: The description of the Traffic Mirror filter. - schema: - type: string - - name: TagSpecification - in: query - required: false - description: The tags to assign to a Traffic Mirror filter. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: ClientToken - in: query - required: false - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.' - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateTrafficMirrorFilter - operationId: POST_CreateTrafficMirrorFilter - description: '

Creates a Traffic Mirror filter.

A Traffic Mirror filter is a set of rules that defines the traffic to mirror.

By default, no traffic is mirrored. To mirror traffic, use CreateTrafficMirrorFilterRule to add Traffic Mirror rules to the filter. The rules you add define what traffic gets mirrored. You can also use ModifyTrafficMirrorFilterNetworkServices to mirror supported network services.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTrafficMirrorFilterResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTrafficMirrorFilterRequest' - parameters: [] - /?Action=CreateTrafficMirrorFilterRule&Version=2016-11-15: - get: - x-aws-operation-name: CreateTrafficMirrorFilterRule - operationId: GET_CreateTrafficMirrorFilterRule - description:

Creates a Traffic Mirror filter rule.

A Traffic Mirror rule defines the Traffic Mirror source traffic to mirror.

You need the Traffic Mirror filter ID when you create the rule.

- responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTrafficMirrorFilterRuleResult' - parameters: - - name: TrafficMirrorFilterId - in: query - required: true - description: The ID of the filter that this rule is associated with. - schema: - type: string - - name: TrafficDirection - in: query - required: true - description: The type of traffic. - schema: - type: string - enum: - - ingress - - egress - - name: RuleNumber - in: query - required: true - description: The number of the Traffic Mirror rule. This number must be unique for each Traffic Mirror rule in a given direction. The rules are processed in ascending order by rule number. - schema: - type: integer - - name: RuleAction - in: query - required: true - description: The action to take on the filtered traffic. - schema: - type: string - enum: - - accept - - reject - - name: DestinationPortRange - in: query - required: false - description: The destination port range. - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The last port in the Traffic Mirror port range. This applies to the TCP and UDP protocols. - description: Information about the Traffic Mirror filter rule port range. - - name: SourcePortRange - in: query - required: false - description: The source port range. - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The last port in the Traffic Mirror port range. This applies to the TCP and UDP protocols. - description: Information about the Traffic Mirror filter rule port range. - - name: Protocol - in: query - required: false - description: '

The protocol, for example UDP, to assign to the Traffic Mirror rule.

For information about the protocol value, see Protocol Numbers on the Internet Assigned Numbers Authority (IANA) website.

' - schema: - type: integer - - name: DestinationCidrBlock - in: query - required: true - description: The destination CIDR block to assign to the Traffic Mirror rule. - schema: - type: string - - name: SourceCidrBlock - in: query - required: true - description: The source CIDR block to assign to the Traffic Mirror rule. - schema: - type: string - - name: Description - in: query - required: false - description: The description of the Traffic Mirror rule. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: ClientToken - in: query - required: false - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.' - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateTrafficMirrorFilterRule - operationId: POST_CreateTrafficMirrorFilterRule - description:

Creates a Traffic Mirror filter rule.

A Traffic Mirror rule defines the Traffic Mirror source traffic to mirror.

You need the Traffic Mirror filter ID when you create the rule.

- responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTrafficMirrorFilterRuleResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTrafficMirrorFilterRuleRequest' - parameters: [] - /?Action=CreateTrafficMirrorSession&Version=2016-11-15: - get: - x-aws-operation-name: CreateTrafficMirrorSession - operationId: GET_CreateTrafficMirrorSession - description: '

Creates a Traffic Mirror session.

A Traffic Mirror session actively copies packets from a Traffic Mirror source to a Traffic Mirror target. Create a filter, and then assign it to the session to define a subset of the traffic to mirror, for example all TCP traffic.

The Traffic Mirror source and the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in a different VPC connected via VPC peering or a transit gateway.

By default, no traffic is mirrored. Use CreateTrafficMirrorFilter to create filter rules that specify the traffic to mirror.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTrafficMirrorSessionResult' - parameters: - - name: NetworkInterfaceId - in: query - required: true - description: The ID of the source network interface. - schema: - type: string - - name: TrafficMirrorTargetId - in: query - required: true - description: The ID of the Traffic Mirror target. - schema: - type: string - - name: TrafficMirrorFilterId - in: query - required: true - description: The ID of the Traffic Mirror filter. - schema: - type: string - - name: PacketLength - in: query - required: false - description: '

The number of bytes in each packet to mirror. These are bytes after the VXLAN header. Do not specify this parameter when you want to mirror the entire packet. To mirror a subset of the packet, set this to the length (in bytes) that you want to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target.

If you do not want to mirror the entire packet, use the PacketLength parameter to specify the number of bytes in each packet to mirror.

' - schema: - type: integer - - name: SessionNumber - in: query - required: true - description:

The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. The first session with a matching filter is the one that mirrors the packets.

Valid values are 1-32766.

- schema: - type: integer - - name: VirtualNetworkId - in: query - required: false - description: 'The VXLAN ID for the Traffic Mirror session. For more information about the VXLAN protocol, see RFC 7348. If you do not specify a VirtualNetworkId, an account-wide unique id is chosen at random.' - schema: - type: integer - - name: Description - in: query - required: false - description: The description of the Traffic Mirror session. - schema: - type: string - - name: TagSpecification - in: query - required: false - description: The tags to assign to a Traffic Mirror session. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: ClientToken - in: query - required: false - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.' - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateTrafficMirrorSession - operationId: POST_CreateTrafficMirrorSession - description: '

Creates a Traffic Mirror session.

A Traffic Mirror session actively copies packets from a Traffic Mirror source to a Traffic Mirror target. Create a filter, and then assign it to the session to define a subset of the traffic to mirror, for example all TCP traffic.

The Traffic Mirror source and the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in a different VPC connected via VPC peering or a transit gateway.

By default, no traffic is mirrored. Use CreateTrafficMirrorFilter to create filter rules that specify the traffic to mirror.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTrafficMirrorSessionResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTrafficMirrorSessionRequest' - parameters: [] - /?Action=CreateTrafficMirrorTarget&Version=2016-11-15: - get: - x-aws-operation-name: CreateTrafficMirrorTarget - operationId: GET_CreateTrafficMirrorTarget - description: '

Creates a target for your Traffic Mirror session.

A Traffic Mirror target is the destination for mirrored traffic. The Traffic Mirror source and the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in different VPCs connected via VPC peering or a transit gateway.

A Traffic Mirror target can be a network interface, a Network Load Balancer, or a Gateway Load Balancer endpoint.

To use the target in a Traffic Mirror session, use CreateTrafficMirrorSession.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTrafficMirrorTargetResult' - parameters: - - name: NetworkInterfaceId - in: query - required: false - description: The network interface ID that is associated with the target. - schema: - type: string - - name: NetworkLoadBalancerArn - in: query - required: false - description: The Amazon Resource Name (ARN) of the Network Load Balancer that is associated with the target. - schema: - type: string - - name: Description - in: query - required: false - description: The description of the Traffic Mirror target. - schema: - type: string - - name: TagSpecification - in: query - required: false - description: The tags to assign to the Traffic Mirror target. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: ClientToken - in: query - required: false - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.' - schema: - type: string - - name: GatewayLoadBalancerEndpointId - in: query - required: false - description: The ID of the Gateway Load Balancer endpoint. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateTrafficMirrorTarget - operationId: POST_CreateTrafficMirrorTarget - description: '

Creates a target for your Traffic Mirror session.

A Traffic Mirror target is the destination for mirrored traffic. The Traffic Mirror source and the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in different VPCs connected via VPC peering or a transit gateway.

A Traffic Mirror target can be a network interface, a Network Load Balancer, or a Gateway Load Balancer endpoint.

To use the target in a Traffic Mirror session, use CreateTrafficMirrorSession.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTrafficMirrorTargetResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTrafficMirrorTargetRequest' - parameters: [] - /?Action=CreateTransitGateway&Version=2016-11-15: - get: - x-aws-operation-name: CreateTransitGateway - operationId: GET_CreateTransitGateway - description: '

Creates a transit gateway.

You can use a transit gateway to interconnect your virtual private clouds (VPC) and on-premises networks. After the transit gateway enters the available state, you can attach your VPCs and VPN connections to the transit gateway.

To attach your VPCs, use CreateTransitGatewayVpcAttachment.

To attach a VPN connection, use CreateCustomerGateway to create a customer gateway and specify the ID of the customer gateway and the ID of the transit gateway in a call to CreateVpnConnection.

When you create a transit gateway, we create a default transit gateway route table and use it as the default association route table and the default propagation route table. You can use CreateTransitGatewayRouteTable to create additional transit gateway route tables. If you disable automatic route propagation, we do not create a default transit gateway route table. You can use EnableTransitGatewayRouteTablePropagation to propagate routes from a resource attachment to a transit gateway route table. If you disable automatic associations, you can use AssociateTransitGatewayRouteTable to associate a resource attachment with a transit gateway route table.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTransitGatewayResult' - parameters: - - name: Description - in: query - required: false - description: A description of the transit gateway. - schema: - type: string - - name: Options - in: query - required: false - description: The transit gateway options. - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/TransitGatewayCidrBlockStringList' - - description: 'One or more IPv4 or IPv6 CIDR blocks for the transit gateway. Must be a size /24 CIDR block or larger for IPv4, or a size /64 CIDR block or larger for IPv6.' - description: Describes the options for a transit gateway. - - name: TagSpecification - in: query - required: false - description: The tags to apply to the transit gateway. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateTransitGateway - operationId: POST_CreateTransitGateway - description: '

Creates a transit gateway.

You can use a transit gateway to interconnect your virtual private clouds (VPC) and on-premises networks. After the transit gateway enters the available state, you can attach your VPCs and VPN connections to the transit gateway.

To attach your VPCs, use CreateTransitGatewayVpcAttachment.

To attach a VPN connection, use CreateCustomerGateway to create a customer gateway and specify the ID of the customer gateway and the ID of the transit gateway in a call to CreateVpnConnection.

When you create a transit gateway, we create a default transit gateway route table and use it as the default association route table and the default propagation route table. You can use CreateTransitGatewayRouteTable to create additional transit gateway route tables. If you disable automatic route propagation, we do not create a default transit gateway route table. You can use EnableTransitGatewayRouteTablePropagation to propagate routes from a resource attachment to a transit gateway route table. If you disable automatic associations, you can use AssociateTransitGatewayRouteTable to associate a resource attachment with a transit gateway route table.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTransitGatewayResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTransitGatewayRequest' - parameters: [] - /?Action=CreateTransitGatewayConnect&Version=2016-11-15: - get: - x-aws-operation-name: CreateTransitGatewayConnect - operationId: GET_CreateTransitGatewayConnect - description:

Creates a Connect attachment from a specified transit gateway attachment. A Connect attachment is a GRE-based tunnel attachment that you can use to establish a connection between a transit gateway and an appliance.

A Connect attachment uses an existing VPC or Amazon Web Services Direct Connect attachment as the underlying transport mechanism.

- responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTransitGatewayConnectResult' - parameters: - - name: TransportTransitGatewayAttachmentId - in: query - required: true - description: The ID of the transit gateway attachment. You can specify a VPC attachment or Amazon Web Services Direct Connect attachment. - schema: - type: string - - name: Options - in: query - required: true - description: The Connect attachment options. - schema: - type: object - required: - - Protocol - properties: - undefined: - allOf: - - $ref: '#/components/schemas/ProtocolValue' - - description: The tunnel protocol. - description: The options for a Connect attachment. - - name: TagSpecification - in: query - required: false - description: The tags to apply to the Connect attachment. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateTransitGatewayConnect - operationId: POST_CreateTransitGatewayConnect - description:

Creates a Connect attachment from a specified transit gateway attachment. A Connect attachment is a GRE-based tunnel attachment that you can use to establish a connection between a transit gateway and an appliance.

A Connect attachment uses an existing VPC or Amazon Web Services Direct Connect attachment as the underlying transport mechanism.

- responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTransitGatewayConnectResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTransitGatewayConnectRequest' - parameters: [] - /?Action=CreateTransitGatewayConnectPeer&Version=2016-11-15: - get: - x-aws-operation-name: CreateTransitGatewayConnectPeer - operationId: GET_CreateTransitGatewayConnectPeer - description: '

Creates a Connect peer for a specified transit gateway Connect attachment between a transit gateway and an appliance.

The peer address and transit gateway address must be the same IP address family (IPv4 or IPv6).

For more information, see Connect peers in the Transit Gateways Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTransitGatewayConnectPeerResult' - parameters: - - name: TransitGatewayAttachmentId - in: query - required: true - description: The ID of the Connect attachment. - schema: - type: string - - name: TransitGatewayAddress - in: query - required: false - description: 'The peer IP address (GRE outer IP address) on the transit gateway side of the Connect peer, which must be specified from a transit gateway CIDR block. If not specified, Amazon automatically assigns the first available IP address from the transit gateway CIDR block.' - schema: - type: string - - name: PeerAddress - in: query - required: true - description: The peer IP address (GRE outer IP address) on the appliance side of the Connect peer. - schema: - type: string - - name: BgpOptions - in: query - required: false - description: The BGP options for the Connect peer. - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Long' - - description: The peer Autonomous System Number (ASN). - description: The BGP options for the Connect attachment. - - name: InsideCidrBlocks - in: query - required: true - description: 'The range of inside IP addresses that are used for BGP peering. You must specify a size /29 IPv4 CIDR block from the 169.254.0.0/16 range. The first address from the range must be configured on the appliance as the BGP IP address. You can also optionally specify a size /125 IPv6 CIDR block from the fd00::/8 range.' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - - name: TagSpecification - in: query - required: false - description: The tags to apply to the Connect peer. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateTransitGatewayConnectPeer - operationId: POST_CreateTransitGatewayConnectPeer - description: '

Creates a Connect peer for a specified transit gateway Connect attachment between a transit gateway and an appliance.

The peer address and transit gateway address must be the same IP address family (IPv4 or IPv6).

For more information, see Connect peers in the Transit Gateways Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTransitGatewayConnectPeerResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTransitGatewayConnectPeerRequest' - parameters: [] - /?Action=CreateTransitGatewayMulticastDomain&Version=2016-11-15: - get: - x-aws-operation-name: CreateTransitGatewayMulticastDomain - operationId: GET_CreateTransitGatewayMulticastDomain - description: '

Creates a multicast domain using the specified transit gateway.

The transit gateway must be in the available state before you create a domain. Use DescribeTransitGateways to see the state of transit gateway.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTransitGatewayMulticastDomainResult' - parameters: - - name: TransitGatewayId - in: query - required: true - description: The ID of the transit gateway. - schema: - type: string - - name: Options - in: query - required: false - description: The options for the transit gateway multicast domain. - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/AutoAcceptSharedAssociationsValue' - - description: Indicates whether to automatically accept cross-account subnet associations that are associated with the transit gateway multicast domain. - description: The options for the transit gateway multicast domain. - - name: TagSpecification - in: query - required: false - description: The tags for the transit gateway multicast domain. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateTransitGatewayMulticastDomain - operationId: POST_CreateTransitGatewayMulticastDomain - description: '

Creates a multicast domain using the specified transit gateway.

The transit gateway must be in the available state before you create a domain. Use DescribeTransitGateways to see the state of transit gateway.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTransitGatewayMulticastDomainResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTransitGatewayMulticastDomainRequest' - parameters: [] - /?Action=CreateTransitGatewayPeeringAttachment&Version=2016-11-15: - get: - x-aws-operation-name: CreateTransitGatewayPeeringAttachment - operationId: GET_CreateTransitGatewayPeeringAttachment - description: '

Requests a transit gateway peering attachment between the specified transit gateway (requester) and a peer transit gateway (accepter). The transit gateways must be in different Regions. The peer transit gateway can be in your account or a different Amazon Web Services account.

After you create the peering attachment, the owner of the accepter transit gateway must accept the attachment request.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTransitGatewayPeeringAttachmentResult' - parameters: - - name: TransitGatewayId - in: query - required: true - description: The ID of the transit gateway. - schema: - type: string - - name: PeerTransitGatewayId - in: query - required: true - description: The ID of the peer transit gateway with which to create the peering attachment. - schema: - type: string - - name: PeerAccountId - in: query - required: true - description: The ID of the Amazon Web Services account that owns the peer transit gateway. - schema: - type: string - - name: PeerRegion - in: query - required: true - description: The Region where the peer transit gateway is located. - schema: - type: string - - name: TagSpecification - in: query - required: false - description: The tags to apply to the transit gateway peering attachment. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateTransitGatewayPeeringAttachment - operationId: POST_CreateTransitGatewayPeeringAttachment - description: '

Requests a transit gateway peering attachment between the specified transit gateway (requester) and a peer transit gateway (accepter). The transit gateways must be in different Regions. The peer transit gateway can be in your account or a different Amazon Web Services account.

After you create the peering attachment, the owner of the accepter transit gateway must accept the attachment request.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTransitGatewayPeeringAttachmentResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTransitGatewayPeeringAttachmentRequest' - parameters: [] - /?Action=CreateTransitGatewayPrefixListReference&Version=2016-11-15: - get: - x-aws-operation-name: CreateTransitGatewayPrefixListReference - operationId: GET_CreateTransitGatewayPrefixListReference - description: Creates a reference (route) to a prefix list in a specified transit gateway route table. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTransitGatewayPrefixListReferenceResult' - parameters: - - name: TransitGatewayRouteTableId - in: query - required: true - description: The ID of the transit gateway route table. - schema: - type: string - - name: PrefixListId - in: query - required: true - description: The ID of the prefix list that is used for destination matches. - schema: - type: string - - name: TransitGatewayAttachmentId - in: query - required: false - description: The ID of the attachment to which traffic is routed. - schema: - type: string - - name: Blackhole - in: query - required: false - description: Indicates whether to drop traffic that matches this route. - schema: - type: boolean - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateTransitGatewayPrefixListReference - operationId: POST_CreateTransitGatewayPrefixListReference - description: Creates a reference (route) to a prefix list in a specified transit gateway route table. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTransitGatewayPrefixListReferenceResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTransitGatewayPrefixListReferenceRequest' - parameters: [] - /?Action=CreateTransitGatewayRoute&Version=2016-11-15: - get: - x-aws-operation-name: CreateTransitGatewayRoute - operationId: GET_CreateTransitGatewayRoute - description: Creates a static route for the specified transit gateway route table. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTransitGatewayRouteResult' - parameters: - - name: DestinationCidrBlock - in: query - required: true - description: The CIDR range used for destination matches. Routing decisions are based on the most specific match. - schema: - type: string - - name: TransitGatewayRouteTableId - in: query - required: true - description: The ID of the transit gateway route table. - schema: - type: string - - name: TransitGatewayAttachmentId - in: query - required: false - description: The ID of the attachment. - schema: - type: string - - name: Blackhole - in: query - required: false - description: Indicates whether to drop traffic that matches this route. - schema: - type: boolean - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateTransitGatewayRoute - operationId: POST_CreateTransitGatewayRoute - description: Creates a static route for the specified transit gateway route table. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTransitGatewayRouteResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTransitGatewayRouteRequest' - parameters: [] - /?Action=CreateTransitGatewayRouteTable&Version=2016-11-15: - get: - x-aws-operation-name: CreateTransitGatewayRouteTable - operationId: GET_CreateTransitGatewayRouteTable - description: Creates a route table for the specified transit gateway. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTransitGatewayRouteTableResult' - parameters: - - name: TransitGatewayId - in: query - required: true - description: The ID of the transit gateway. - schema: - type: string - - name: TagSpecifications - in: query - required: false - description: The tags to apply to the transit gateway route table. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateTransitGatewayRouteTable - operationId: POST_CreateTransitGatewayRouteTable - description: Creates a route table for the specified transit gateway. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTransitGatewayRouteTableResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTransitGatewayRouteTableRequest' - parameters: [] - /?Action=CreateTransitGatewayVpcAttachment&Version=2016-11-15: - get: - x-aws-operation-name: CreateTransitGatewayVpcAttachment - operationId: GET_CreateTransitGatewayVpcAttachment - description: '

Attaches the specified VPC to the specified transit gateway.

If you attach a VPC with a CIDR range that overlaps the CIDR range of a VPC that is already attached, the new VPC CIDR range is not propagated to the default propagation route table.

To send VPC traffic to an attached transit gateway, add a route to the VPC route table using CreateRoute.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTransitGatewayVpcAttachmentResult' - parameters: - - name: TransitGatewayId - in: query - required: true - description: The ID of the transit gateway. - schema: - type: string - - name: VpcId - in: query - required: true - description: The ID of the VPC. - schema: - type: string - - name: SubnetIds - in: query - required: true - description: 'The IDs of one or more subnets. You can specify only one subnet per Availability Zone. You must specify at least one subnet, but we recommend that you specify two subnets for better availability. The transit gateway uses one IP address from each specified subnet.' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/SubnetId' - - xml: - name: item - - name: Options - in: query - required: false - description: The VPC attachment options. - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/ApplianceModeSupportValue' - - description: 'Enable or disable support for appliance mode. If enabled, a traffic flow between a source and destination uses the same Availability Zone for the VPC attachment for the lifetime of that flow. The default is disable.' - description: Describes the options for a VPC attachment. - - name: TagSpecifications - in: query - required: false - description: The tags to apply to the VPC attachment. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateTransitGatewayVpcAttachment - operationId: POST_CreateTransitGatewayVpcAttachment - description: '

Attaches the specified VPC to the specified transit gateway.

If you attach a VPC with a CIDR range that overlaps the CIDR range of a VPC that is already attached, the new VPC CIDR range is not propagated to the default propagation route table.

To send VPC traffic to an attached transit gateway, add a route to the VPC route table using CreateRoute.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTransitGatewayVpcAttachmentResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateTransitGatewayVpcAttachmentRequest' - parameters: [] - /?Action=CreateVolume&Version=2016-11-15: - get: - x-aws-operation-name: CreateVolume - operationId: GET_CreateVolume - description: '

Creates an EBS volume that can be attached to an instance in the same Availability Zone.

You can create a new empty volume or restore a volume from an EBS snapshot. Any Amazon Web Services Marketplace product codes from the snapshot are propagated to the volume.

You can create encrypted volumes. Encrypted volumes must be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also automatically encrypted. For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.

You can tag your volumes during creation. For more information, see Tag your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide.

For more information, see Create an Amazon EBS volume in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/Volume' - parameters: - - name: AvailabilityZone - in: query - required: true - description: The Availability Zone in which to create the volume. - schema: - type: string - - name: Encrypted - in: query - required: false - description: '

Indicates whether the volume should be encrypted. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Encryption by default in the Amazon Elastic Compute Cloud User Guide.

Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types.

' - schema: - type: boolean - - name: Iops - in: query - required: false - description: '

The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.

The following are the supported values for each volume type:

  • gp3: 3,000-16,000 IOPS

  • io1: 100-64,000 IOPS

  • io2: 100-64,000 IOPS

io1 and io2 volumes support up to 64,000 IOPS only on Instances built on the Nitro System. Other instance families support performance up to 32,000 IOPS.

This parameter is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for gp2, st1, sc1, or standard volumes.

' - schema: - type: integer - - name: KmsKeyId - in: query - required: false - description: '

The identifier of the Key Management Service (KMS) KMS key to use for Amazon EBS encryption. If this parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId is specified, the encrypted state must be true.

You can specify the KMS key using any of the following:

  • Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.

  • Key alias. For example, alias/ExampleAlias.

  • Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.

  • Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.

' - schema: - type: string - - name: OutpostArn - in: query - required: false - description: The Amazon Resource Name (ARN) of the Outpost. - schema: - type: string - - name: Size - in: query - required: false - description: '

The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.

The following are the supported volumes sizes for each volume type:

  • gp2 and gp3: 1-16,384

  • io1 and io2: 4-16,384

  • st1 and sc1: 125-16,384

  • standard: 1-1,024

' - schema: - type: integer - - name: SnapshotId - in: query - required: false - description: The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size. - schema: - type: string - - name: VolumeType - in: query - required: false - description: '

The volume type. This parameter can be one of the following values:

  • General Purpose SSD: gp2 | gp3

  • Provisioned IOPS SSD: io1 | io2

  • Throughput Optimized HDD: st1

  • Cold HDD: sc1

  • Magnetic: standard

For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide.

Default: gp2

' - schema: - type: string - enum: - - standard - - io1 - - io2 - - gp2 - - sc1 - - st1 - - gp3 - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: TagSpecification - in: query - required: false - description: The tags to apply to the volume during creation. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - - name: MultiAttachEnabled - in: query - required: false - description: 'Indicates whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the volume to up to 16 Instances built on the Nitro System in the same Availability Zone. This parameter is supported with io1 and io2 volumes only. For more information, see Amazon EBS Multi-Attach in the Amazon Elastic Compute Cloud User Guide.' - schema: - type: boolean - - name: Throughput - in: query - required: false - description: '

The throughput to provision for a volume, with a maximum of 1,000 MiB/s.

This parameter is valid only for gp3 volumes.

Valid Range: Minimum value of 125. Maximum value of 1000.

' - schema: - type: integer - - name: ClientToken - in: query - required: false - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.' - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateVolume - operationId: POST_CreateVolume - description: '

Creates an EBS volume that can be attached to an instance in the same Availability Zone.

You can create a new empty volume or restore a volume from an EBS snapshot. Any Amazon Web Services Marketplace product codes from the snapshot are propagated to the volume.

You can create encrypted volumes. Encrypted volumes must be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also automatically encrypted. For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.

You can tag your volumes during creation. For more information, see Tag your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide.

For more information, see Create an Amazon EBS volume in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/Volume' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateVolumeRequest' - parameters: [] - /?Action=CreateVpc&Version=2016-11-15: - get: - x-aws-operation-name: CreateVpc - operationId: GET_CreateVpc - description: '

Creates a VPC with the specified IPv4 CIDR block. The smallest VPC you can create uses a /28 netmask (16 IPv4 addresses), and the largest uses a /16 netmask (65,536 IPv4 addresses). For more information about how large to make your VPC, see Your VPC and subnets in the Amazon Virtual Private Cloud User Guide.

You can optionally request an IPv6 CIDR block for the VPC. You can request an Amazon-provided IPv6 CIDR block from Amazon''s pool of IPv6 addresses, or an IPv6 CIDR block from an IPv6 address pool that you provisioned through bring your own IP addresses (BYOIP).

By default, each instance you launch in the VPC has the default DHCP options, which include only a default DNS server that we provide (AmazonProvidedDNS). For more information, see DHCP options sets in the Amazon Virtual Private Cloud User Guide.

You can specify the instance tenancy value for the VPC when you create it. You can''t change this value for the VPC after you create it. For more information, see Dedicated Instances in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateVpcResult' - parameters: - - name: CidrBlock - in: query - required: false - description: 'The IPv4 network range for the VPC, in CIDR notation. For example, 10.0.0.0/16. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.' - schema: - type: string - - name: AmazonProvidedIpv6CidrBlock - in: query - required: false - description: 'Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IP addresses, or the size of the CIDR block.' - schema: - type: boolean - - name: Ipv6Pool - in: query - required: false - description: The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block. - schema: - type: string - - name: Ipv6CidrBlock - in: query - required: false - description: '

The IPv6 CIDR block from the IPv6 address pool. You must also specify Ipv6Pool in the request.

To let Amazon choose the IPv6 CIDR block for you, omit this parameter.

' - schema: - type: string - - name: Ipv4IpamPoolId - in: query - required: false - description: 'The ID of an IPv4 IPAM pool you want to use for allocating this VPC''s CIDR. For more information, see What is IPAM? in the Amazon VPC IPAM User Guide. ' - schema: - type: string - - name: Ipv4NetmaskLength - in: query - required: false - description: 'The netmask length of the IPv4 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.' - schema: - type: integer - - name: Ipv6IpamPoolId - in: query - required: false - description: 'The ID of an IPv6 IPAM pool which will be used to allocate this VPC an IPv6 CIDR. IPAM is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts throughout your Amazon Web Services Organization. For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.' - schema: - type: string - - name: Ipv6NetmaskLength - in: query - required: false - description: 'The netmask length of the IPv6 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.' - schema: - type: integer - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: InstanceTenancy - in: query - required: false - description: '

The tenancy options for instances launched into the VPC. For default, instances are launched with shared tenancy by default. You can launch instances with any tenancy into a shared tenancy VPC. For dedicated, instances are launched as dedicated tenancy instances by default. You can only launch instances with a tenancy of dedicated or host into a dedicated tenancy VPC.

Important: The host value cannot be used with this parameter. Use the default or dedicated values only.

Default: default

' - schema: - type: string - enum: - - default - - dedicated - - host - - name: Ipv6CidrBlockNetworkBorderGroup - in: query - required: false - description:

The name of the location from which we advertise the IPV6 CIDR block. Use this parameter to limit the address to this location.

You must set AmazonProvidedIpv6CidrBlock to true to use this parameter.

- schema: - type: string - - name: TagSpecification - in: query - required: false - description: The tags to assign to the VPC. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateVpc - operationId: POST_CreateVpc - description: '

Creates a VPC with the specified IPv4 CIDR block. The smallest VPC you can create uses a /28 netmask (16 IPv4 addresses), and the largest uses a /16 netmask (65,536 IPv4 addresses). For more information about how large to make your VPC, see Your VPC and subnets in the Amazon Virtual Private Cloud User Guide.

You can optionally request an IPv6 CIDR block for the VPC. You can request an Amazon-provided IPv6 CIDR block from Amazon''s pool of IPv6 addresses, or an IPv6 CIDR block from an IPv6 address pool that you provisioned through bring your own IP addresses (BYOIP).

By default, each instance you launch in the VPC has the default DHCP options, which include only a default DNS server that we provide (AmazonProvidedDNS). For more information, see DHCP options sets in the Amazon Virtual Private Cloud User Guide.

You can specify the instance tenancy value for the VPC when you create it. You can''t change this value for the VPC after you create it. For more information, see Dedicated Instances in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateVpcResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateVpcRequest' - parameters: [] - /?Action=CreateVpcEndpoint&Version=2016-11-15: - get: - x-aws-operation-name: CreateVpcEndpoint - operationId: GET_CreateVpcEndpoint - description: 'Creates a VPC endpoint for a specified service. An endpoint enables you to create a private connection between your VPC and the service. The service may be provided by Amazon Web Services, an Amazon Web Services Marketplace Partner, or another Amazon Web Services account. For more information, see the Amazon Web Services PrivateLink Guide.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateVpcEndpointResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: VpcEndpointType - in: query - required: false - description: '

The type of endpoint.

Default: Gateway

' - schema: - type: string - enum: - - Interface - - Gateway - - GatewayLoadBalancer - - name: VpcId - in: query - required: true - description: The ID of the VPC in which the endpoint will be used. - schema: - type: string - - name: ServiceName - in: query - required: true - description: 'The service name. To get a list of available services, use the DescribeVpcEndpointServices request, or get the name from the service provider.' - schema: - type: string - - name: PolicyDocument - in: query - required: false - description: '(Interface and gateway endpoints) A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format. If this parameter is not specified, we attach a default policy that allows full access to the service.' - schema: - type: string - - name: RouteTableId - in: query - required: false - description: (Gateway endpoint) One or more route table IDs. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/RouteTableId' - - xml: - name: item - - name: SubnetId - in: query - required: false - description: '(Interface and Gateway Load Balancer endpoints) The ID of one or more subnets in which to create an endpoint network interface. For a Gateway Load Balancer endpoint, you can specify one subnet only.' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/SubnetId' - - xml: - name: item - - name: SecurityGroupId - in: query - required: false - description: (Interface endpoint) The ID of one or more security groups to associate with the endpoint network interface. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/SecurityGroupId' - - xml: - name: item - - name: IpAddressType - in: query - required: false - description: The IP address type for the endpoint. - schema: - type: string - enum: - - ipv4 - - dualstack - - ipv6 - - name: DnsOptions - in: query - required: false - description: The DNS options for the endpoint. - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/DnsRecordIpType' - - description: The DNS records created for the endpoint. - description: Describes the DNS options for an endpoint. - - name: ClientToken - in: query - required: false - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.' - schema: - type: string - - name: PrivateDnsEnabled - in: query - required: false - description: '

(Interface endpoint) Indicates whether to associate a private hosted zone with the specified VPC. The private hosted zone contains a record set for the default public DNS name for the service for the Region (for example, kinesis.us-east-1.amazonaws.com), which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC endpoint service.

To use a private hosted zone, you must set the following VPC attributes to true: enableDnsHostnames and enableDnsSupport. Use ModifyVpcAttribute to set the VPC attributes.

Default: true

' - schema: - type: boolean - - name: TagSpecification - in: query - required: false - description: The tags to associate with the endpoint. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateVpcEndpoint - operationId: POST_CreateVpcEndpoint - description: 'Creates a VPC endpoint for a specified service. An endpoint enables you to create a private connection between your VPC and the service. The service may be provided by Amazon Web Services, an Amazon Web Services Marketplace Partner, or another Amazon Web Services account. For more information, see the Amazon Web Services PrivateLink Guide.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateVpcEndpointResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateVpcEndpointRequest' - parameters: [] - /?Action=CreateVpcEndpointConnectionNotification&Version=2016-11-15: - get: - x-aws-operation-name: CreateVpcEndpointConnectionNotification - operationId: GET_CreateVpcEndpointConnectionNotification - description: '

Creates a connection notification for a specified VPC endpoint or VPC endpoint service. A connection notification notifies you of specific endpoint events. You must create an SNS topic to receive notifications. For more information, see Create a Topic in the Amazon Simple Notification Service Developer Guide.

You can create a connection notification for interface endpoints only.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateVpcEndpointConnectionNotificationResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: ServiceId - in: query - required: false - description: The ID of the endpoint service. - schema: - type: string - - name: VpcEndpointId - in: query - required: false - description: The ID of the endpoint. - schema: - type: string - - name: ConnectionNotificationArn - in: query - required: true - description: The ARN of the SNS topic for the notifications. - schema: - type: string - - name: ConnectionEvents - in: query - required: true - description: 'One or more endpoint events for which to receive notifications. Valid values are Accept, Connect, Delete, and Reject.' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - - name: ClientToken - in: query - required: false - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.' - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateVpcEndpointConnectionNotification - operationId: POST_CreateVpcEndpointConnectionNotification - description: '

Creates a connection notification for a specified VPC endpoint or VPC endpoint service. A connection notification notifies you of specific endpoint events. You must create an SNS topic to receive notifications. For more information, see Create a Topic in the Amazon Simple Notification Service Developer Guide.

You can create a connection notification for interface endpoints only.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateVpcEndpointConnectionNotificationResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateVpcEndpointConnectionNotificationRequest' - parameters: [] - /?Action=CreateVpcEndpointServiceConfiguration&Version=2016-11-15: - get: - x-aws-operation-name: CreateVpcEndpointServiceConfiguration - operationId: GET_CreateVpcEndpointServiceConfiguration - description: '

Creates a VPC endpoint service to which service consumers (Amazon Web Services accounts, IAM users, and IAM roles) can connect.

Before you create an endpoint service, you must create one of the following for your service:

If you set the private DNS name, you must prove that you own the private DNS domain name.

For more information, see the Amazon Web Services PrivateLink Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateVpcEndpointServiceConfigurationResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: AcceptanceRequired - in: query - required: false - description: Indicates whether requests from service consumers to create an endpoint to your service must be accepted manually. - schema: - type: boolean - - name: PrivateDnsName - in: query - required: false - description: (Interface endpoint configuration) The private DNS name to assign to the VPC endpoint service. - schema: - type: string - - name: NetworkLoadBalancerArn - in: query - required: false - description: The Amazon Resource Names (ARNs) of one or more Network Load Balancers for your service. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - - name: GatewayLoadBalancerArn - in: query - required: false - description: The Amazon Resource Names (ARNs) of one or more Gateway Load Balancers. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - - name: SupportedIpAddressType - in: query - required: false - description: The supported IP address types. The possible values are ipv4 and ipv6. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - - name: ClientToken - in: query - required: false - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.' - schema: - type: string - - name: TagSpecification - in: query - required: false - description: The tags to associate with the service. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateVpcEndpointServiceConfiguration - operationId: POST_CreateVpcEndpointServiceConfiguration - description: '

Creates a VPC endpoint service to which service consumers (Amazon Web Services accounts, IAM users, and IAM roles) can connect.

Before you create an endpoint service, you must create one of the following for your service:

If you set the private DNS name, you must prove that you own the private DNS domain name.

For more information, see the Amazon Web Services PrivateLink Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateVpcEndpointServiceConfigurationResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateVpcEndpointServiceConfigurationRequest' - parameters: [] - /?Action=CreateVpcPeeringConnection&Version=2016-11-15: - get: - x-aws-operation-name: CreateVpcPeeringConnection - operationId: GET_CreateVpcPeeringConnection - description: '

Requests a VPC peering connection between two VPCs: a requester VPC that you own and an accepter VPC with which to create the connection. The accepter VPC can belong to another Amazon Web Services account and can be in a different Region to the requester VPC. The requester VPC and accepter VPC cannot have overlapping CIDR blocks.

Limitations and rules apply to a VPC peering connection. For more information, see the limitations section in the VPC Peering Guide.

The owner of the accepter VPC must accept the peering request to activate the peering connection. The VPC peering connection request expires after 7 days, after which it cannot be accepted or rejected.

If you create a VPC peering connection request between VPCs with overlapping CIDR blocks, the VPC peering connection has a status of failed.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateVpcPeeringConnectionResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: PeerOwnerId - in: query - required: false - description: '

The Amazon Web Services account ID of the owner of the accepter VPC.

Default: Your Amazon Web Services account ID

' - schema: - type: string - - name: PeerVpcId - in: query - required: false - description: The ID of the VPC with which you are creating the VPC peering connection. You must specify this parameter in the request. - schema: - type: string - - name: VpcId - in: query - required: false - description: The ID of the requester VPC. You must specify this parameter in the request. - schema: - type: string - - name: PeerRegion - in: query - required: false - description: '

The Region code for the accepter VPC, if the accepter VPC is located in a Region other than the Region in which you make the request.

Default: The Region in which you make the request.

' - schema: - type: string - - name: TagSpecification - in: query - required: false - description: The tags to assign to the peering connection. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateVpcPeeringConnection - operationId: POST_CreateVpcPeeringConnection - description: '

Requests a VPC peering connection between two VPCs: a requester VPC that you own and an accepter VPC with which to create the connection. The accepter VPC can belong to another Amazon Web Services account and can be in a different Region to the requester VPC. The requester VPC and accepter VPC cannot have overlapping CIDR blocks.

Limitations and rules apply to a VPC peering connection. For more information, see the limitations section in the VPC Peering Guide.

The owner of the accepter VPC must accept the peering request to activate the peering connection. The VPC peering connection request expires after 7 days, after which it cannot be accepted or rejected.

If you create a VPC peering connection request between VPCs with overlapping CIDR blocks, the VPC peering connection has a status of failed.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateVpcPeeringConnectionResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateVpcPeeringConnectionRequest' - parameters: [] - /?Action=CreateVpnConnection&Version=2016-11-15: - get: - x-aws-operation-name: CreateVpnConnection - operationId: GET_CreateVpnConnection - description: '

Creates a VPN connection between an existing virtual private gateway or transit gateway and a customer gateway. The supported connection type is ipsec.1.

The response includes information that you need to give to your network administrator to configure your customer gateway.

We strongly recommend that you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway device.

If you decide to shut down your VPN connection for any reason and later create a new VPN connection, you must reconfigure your customer gateway with the new information returned from this call.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn''t return an error.

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateVpnConnectionResult' - parameters: - - name: CustomerGatewayId - in: query - required: true - description: The ID of the customer gateway. - schema: - type: string - - name: Type - in: query - required: true - description: The type of VPN connection (ipsec.1). - schema: - type: string - - name: VpnGatewayId - in: query - required: false - description: 'The ID of the virtual private gateway. If you specify a virtual private gateway, you cannot specify a transit gateway.' - schema: - type: string - - name: TransitGatewayId - in: query - required: false - description: 'The ID of the transit gateway. If you specify a transit gateway, you cannot specify a virtual private gateway.' - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: Options - in: query - required: false - description: The options for the VPN connection. - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: '

Indicate whether to enable acceleration for the VPN connection.

Default: false

' - staticRoutesOnly: - allOf: - - $ref: '#/components/schemas/String' - - description: '

The IPv6 CIDR on the Amazon Web Services side of the VPN connection.

Default: ::/0

' - description: Describes VPN connection options. - - name: TagSpecification - in: query - required: false - description: The tags to apply to the VPN connection. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateVpnConnection - operationId: POST_CreateVpnConnection - description: '

Creates a VPN connection between an existing virtual private gateway or transit gateway and a customer gateway. The supported connection type is ipsec.1.

The response includes information that you need to give to your network administrator to configure your customer gateway.

We strongly recommend that you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway device.

If you decide to shut down your VPN connection for any reason and later create a new VPN connection, you must reconfigure your customer gateway with the new information returned from this call.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn''t return an error.

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateVpnConnectionResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateVpnConnectionRequest' - parameters: [] - /?Action=CreateVpnConnectionRoute&Version=2016-11-15: - get: - x-aws-operation-name: CreateVpnConnectionRoute - operationId: GET_CreateVpnConnectionRoute - description: '

Creates a static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.

' - responses: - '200': - description: Success - parameters: - - name: DestinationCidrBlock - in: query - required: true - description: The CIDR block associated with the local subnet of the customer network. - schema: - type: string - - name: VpnConnectionId - in: query - required: true - description: The ID of the VPN connection. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateVpnConnectionRoute - operationId: POST_CreateVpnConnectionRoute - description: '

Creates a static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.

' - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateVpnConnectionRouteRequest' - parameters: [] - /?Action=CreateVpnGateway&Version=2016-11-15: - get: - x-aws-operation-name: CreateVpnGateway - operationId: GET_CreateVpnGateway - description: '

Creates a virtual private gateway. A virtual private gateway is the endpoint on the VPC side of your VPN connection. You can create a virtual private gateway before creating the VPC itself.

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateVpnGatewayResult' - parameters: - - name: AvailabilityZone - in: query - required: false - description: The Availability Zone for the virtual private gateway. - schema: - type: string - - name: Type - in: query - required: true - description: The type of VPN connection this virtual private gateway supports. - schema: - type: string - enum: - - ipsec.1 - - name: TagSpecification - in: query - required: false - description: The tags to apply to the virtual private gateway. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - - name: AmazonSideAsn - in: query - required: false - description: '

A private Autonomous System Number (ASN) for the Amazon side of a BGP session. If you''re using a 16-bit ASN, it must be in the 64512 to 65534 range. If you''re using a 32-bit ASN, it must be in the 4200000000 to 4294967294 range.

Default: 64512

' - schema: - type: integer - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: CreateVpnGateway - operationId: POST_CreateVpnGateway - description: '

Creates a virtual private gateway. A virtual private gateway is the endpoint on the VPC side of your VPN connection. You can create a virtual private gateway before creating the VPC itself.

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateVpnGatewayResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateVpnGatewayRequest' - parameters: [] - /?Action=DeleteCarrierGateway&Version=2016-11-15: - get: - x-aws-operation-name: DeleteCarrierGateway - operationId: GET_DeleteCarrierGateway - description: '

Deletes a carrier gateway.

If you do not delete the route that contains the carrier gateway as the Target, the route is a blackhole route. For information about how to delete a route, see DeleteRoute.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteCarrierGatewayResult' - parameters: - - name: CarrierGatewayId - in: query - required: true - description: The ID of the carrier gateway. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeleteCarrierGateway - operationId: POST_DeleteCarrierGateway - description: '

Deletes a carrier gateway.

If you do not delete the route that contains the carrier gateway as the Target, the route is a blackhole route. For information about how to delete a route, see DeleteRoute.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteCarrierGatewayResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteCarrierGatewayRequest' - parameters: [] - /?Action=DeleteClientVpnEndpoint&Version=2016-11-15: - get: - x-aws-operation-name: DeleteClientVpnEndpoint - operationId: GET_DeleteClientVpnEndpoint - description: Deletes the specified Client VPN endpoint. You must disassociate all target networks before you can delete a Client VPN endpoint. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteClientVpnEndpointResult' - parameters: - - name: ClientVpnEndpointId - in: query - required: true - description: The ID of the Client VPN to be deleted. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeleteClientVpnEndpoint - operationId: POST_DeleteClientVpnEndpoint - description: Deletes the specified Client VPN endpoint. You must disassociate all target networks before you can delete a Client VPN endpoint. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteClientVpnEndpointResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteClientVpnEndpointRequest' - parameters: [] - /?Action=DeleteClientVpnRoute&Version=2016-11-15: - get: - x-aws-operation-name: DeleteClientVpnRoute - operationId: GET_DeleteClientVpnRoute - description: 'Deletes a route from a Client VPN endpoint. You can only delete routes that you manually added using the CreateClientVpnRoute action. You cannot delete routes that were automatically added when associating a subnet. To remove routes that have been automatically added, disassociate the target subnet from the Client VPN endpoint.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteClientVpnRouteResult' - parameters: - - name: ClientVpnEndpointId - in: query - required: true - description: The ID of the Client VPN endpoint from which the route is to be deleted. - schema: - type: string - - name: TargetVpcSubnetId - in: query - required: false - description: The ID of the target subnet used by the route. - schema: - type: string - - name: DestinationCidrBlock - in: query - required: true - description: 'The IPv4 address range, in CIDR notation, of the route to be deleted.' - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeleteClientVpnRoute - operationId: POST_DeleteClientVpnRoute - description: 'Deletes a route from a Client VPN endpoint. You can only delete routes that you manually added using the CreateClientVpnRoute action. You cannot delete routes that were automatically added when associating a subnet. To remove routes that have been automatically added, disassociate the target subnet from the Client VPN endpoint.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteClientVpnRouteResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteClientVpnRouteRequest' - parameters: [] - /?Action=DeleteCustomerGateway&Version=2016-11-15: - get: - x-aws-operation-name: DeleteCustomerGateway - operationId: GET_DeleteCustomerGateway - description: Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway. - responses: - '200': - description: Success - parameters: - - name: CustomerGatewayId - in: query - required: true - description: The ID of the customer gateway. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeleteCustomerGateway - operationId: POST_DeleteCustomerGateway - description: Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway. - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteCustomerGatewayRequest' - parameters: [] - /?Action=DeleteDhcpOptions&Version=2016-11-15: - get: - x-aws-operation-name: DeleteDhcpOptions - operationId: GET_DeleteDhcpOptions - description: Deletes the specified set of DHCP options. You must disassociate the set of DHCP options before you can delete it. You can disassociate the set of DHCP options by associating either a new set of options or the default set of options with the VPC. - responses: - '200': - description: Success - parameters: - - name: DhcpOptionsId - in: query - required: true - description: The ID of the DHCP options set. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeleteDhcpOptions - operationId: POST_DeleteDhcpOptions - description: Deletes the specified set of DHCP options. You must disassociate the set of DHCP options before you can delete it. You can disassociate the set of DHCP options by associating either a new set of options or the default set of options with the VPC. - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteDhcpOptionsRequest' - parameters: [] - /?Action=DeleteEgressOnlyInternetGateway&Version=2016-11-15: - get: - x-aws-operation-name: DeleteEgressOnlyInternetGateway - operationId: GET_DeleteEgressOnlyInternetGateway - description: Deletes an egress-only internet gateway. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteEgressOnlyInternetGatewayResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: EgressOnlyInternetGatewayId - in: query - required: true - description: The ID of the egress-only internet gateway. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeleteEgressOnlyInternetGateway - operationId: POST_DeleteEgressOnlyInternetGateway - description: Deletes an egress-only internet gateway. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteEgressOnlyInternetGatewayResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteEgressOnlyInternetGatewayRequest' - parameters: [] - /?Action=DeleteFleets&Version=2016-11-15: - get: - x-aws-operation-name: DeleteFleets - operationId: GET_DeleteFleets - description: '

Deletes the specified EC2 Fleet.

After you delete an EC2 Fleet, it launches no new instances.

You must specify whether a deleted EC2 Fleet should also terminate its instances. If you choose to terminate the instances, the EC2 Fleet enters the deleted_terminating state. Otherwise, the EC2 Fleet enters the deleted_running state, and the instances continue to run until they are interrupted or you terminate them manually.

For instant fleets, EC2 Fleet must terminate the instances when the fleet is deleted. A deleted instant fleet with running instances is not supported.

Restrictions

  • You can delete up to 25 instant fleets in a single request. If you exceed this number, no instant fleets are deleted and an error is returned. There is no restriction on the number of fleets of type maintain or request that can be deleted in a single request.

  • Up to 1000 instances can be terminated in a single request to delete instant fleets.

For more information, see Delete an EC2 Fleet in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteFleetsResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: FleetId - in: query - required: true - description: The IDs of the EC2 Fleets. - schema: - type: array - items: - $ref: '#/components/schemas/FleetId' - - name: TerminateInstances - in: query - required: true - description: '

Indicates whether to terminate the instances when the EC2 Fleet is deleted. The default is to terminate the instances.

To let the instances continue to run after the EC2 Fleet is deleted, specify NoTerminateInstances. Supported only for fleets of type maintain and request.

For instant fleets, you cannot specify NoTerminateInstances. A deleted instant fleet with running instances is not supported.

' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeleteFleets - operationId: POST_DeleteFleets - description: '

Deletes the specified EC2 Fleet.

After you delete an EC2 Fleet, it launches no new instances.

You must specify whether a deleted EC2 Fleet should also terminate its instances. If you choose to terminate the instances, the EC2 Fleet enters the deleted_terminating state. Otherwise, the EC2 Fleet enters the deleted_running state, and the instances continue to run until they are interrupted or you terminate them manually.

For instant fleets, EC2 Fleet must terminate the instances when the fleet is deleted. A deleted instant fleet with running instances is not supported.

Restrictions

  • You can delete up to 25 instant fleets in a single request. If you exceed this number, no instant fleets are deleted and an error is returned. There is no restriction on the number of fleets of type maintain or request that can be deleted in a single request.

  • Up to 1000 instances can be terminated in a single request to delete instant fleets.

For more information, see Delete an EC2 Fleet in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteFleetsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteFleetsRequest' - parameters: [] - /?Action=DeleteFlowLogs&Version=2016-11-15: - get: - x-aws-operation-name: DeleteFlowLogs - operationId: GET_DeleteFlowLogs - description: Deletes one or more flow logs. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteFlowLogsResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: FlowLogId - in: query - required: true - description: '

One or more flow log IDs.

Constraint: Maximum of 1000 flow log IDs.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/VpcFlowLogId' - - xml: - name: item - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeleteFlowLogs - operationId: POST_DeleteFlowLogs - description: Deletes one or more flow logs. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteFlowLogsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteFlowLogsRequest' - parameters: [] - /?Action=DeleteFpgaImage&Version=2016-11-15: - get: - x-aws-operation-name: DeleteFpgaImage - operationId: GET_DeleteFpgaImage - description: Deletes the specified Amazon FPGA Image (AFI). - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteFpgaImageResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: FpgaImageId - in: query - required: true - description: The ID of the AFI. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeleteFpgaImage - operationId: POST_DeleteFpgaImage - description: Deletes the specified Amazon FPGA Image (AFI). - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteFpgaImageResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteFpgaImageRequest' - parameters: [] - /?Action=DeleteInstanceEventWindow&Version=2016-11-15: - get: - x-aws-operation-name: DeleteInstanceEventWindow - operationId: GET_DeleteInstanceEventWindow - description: '

Deletes the specified event window.

For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteInstanceEventWindowResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: ForceDelete - in: query - required: false - description: Specify true to force delete the event window. Use the force delete parameter if the event window is currently associated with targets. - schema: - type: boolean - - name: InstanceEventWindowId - in: query - required: true - description: The ID of the event window. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeleteInstanceEventWindow - operationId: POST_DeleteInstanceEventWindow - description: '

Deletes the specified event window.

For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteInstanceEventWindowResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteInstanceEventWindowRequest' - parameters: [] - /?Action=DeleteInternetGateway&Version=2016-11-15: - get: - x-aws-operation-name: DeleteInternetGateway - operationId: GET_DeleteInternetGateway - description: Deletes the specified internet gateway. You must detach the internet gateway from the VPC before you can delete it. - responses: - '200': - description: Success - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: InternetGatewayId - in: query - required: true - description: The ID of the internet gateway. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeleteInternetGateway - operationId: POST_DeleteInternetGateway - description: Deletes the specified internet gateway. You must detach the internet gateway from the VPC before you can delete it. - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteInternetGatewayRequest' - parameters: [] - /?Action=DeleteIpam&Version=2016-11-15: - get: - x-aws-operation-name: DeleteIpam - operationId: GET_DeleteIpam - description: '

Delete an IPAM. Deleting an IPAM removes all monitored data associated with the IPAM including the historical data for CIDRs.

For more information, see Delete an IPAM in the Amazon VPC IPAM User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteIpamResult' - parameters: - - name: DryRun - in: query - required: false - description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: IpamId - in: query - required: true - description: The ID of the IPAM to delete. - schema: - type: string - - name: Cascade - in: query - required: false - description: '

Enables you to quickly delete an IPAM, private scopes, pools in private scopes, and any allocations in the pools in private scopes. You cannot delete the IPAM with this option if there is a pool in your public scope. If you use this option, IPAM does the following:

  • Deallocates any CIDRs allocated to VPC resources (such as VPCs) in pools in private scopes.

    No VPC resources are deleted as a result of enabling this option. The CIDR associated with the resource will no longer be allocated from an IPAM pool, but the CIDR itself will remain unchanged.

  • Deprovisions all IPv4 CIDRs provisioned to IPAM pools in private scopes.

  • Deletes all IPAM pools in private scopes.

  • Deletes all non-default private scopes in the IPAM.

  • Deletes the default public and private scopes and the IPAM.

' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeleteIpam - operationId: POST_DeleteIpam - description: '

Delete an IPAM. Deleting an IPAM removes all monitored data associated with the IPAM including the historical data for CIDRs.

For more information, see Delete an IPAM in the Amazon VPC IPAM User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteIpamResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteIpamRequest' - parameters: [] - /?Action=DeleteIpamPool&Version=2016-11-15: - get: - x-aws-operation-name: DeleteIpamPool - operationId: GET_DeleteIpamPool - description: '

Delete an IPAM pool.

You cannot delete an IPAM pool if there are allocations in it or CIDRs provisioned to it. To release allocations, see ReleaseIpamPoolAllocation. To deprovision pool CIDRs, see DeprovisionIpamPoolCidr.

For more information, see Delete a pool in the Amazon VPC IPAM User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteIpamPoolResult' - parameters: - - name: DryRun - in: query - required: false - description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: IpamPoolId - in: query - required: true - description: The ID of the pool to delete. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeleteIpamPool - operationId: POST_DeleteIpamPool - description: '

Delete an IPAM pool.

You cannot delete an IPAM pool if there are allocations in it or CIDRs provisioned to it. To release allocations, see ReleaseIpamPoolAllocation. To deprovision pool CIDRs, see DeprovisionIpamPoolCidr.

For more information, see Delete a pool in the Amazon VPC IPAM User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteIpamPoolResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteIpamPoolRequest' - parameters: [] - /?Action=DeleteIpamScope&Version=2016-11-15: - get: - x-aws-operation-name: DeleteIpamScope - operationId: GET_DeleteIpamScope - description: '

Delete the scope for an IPAM. You cannot delete the default scopes.

For more information, see Delete a scope in the Amazon VPC IPAM User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteIpamScopeResult' - parameters: - - name: DryRun - in: query - required: false - description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: IpamScopeId - in: query - required: true - description: The ID of the scope to delete. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeleteIpamScope - operationId: POST_DeleteIpamScope - description: '

Delete the scope for an IPAM. You cannot delete the default scopes.

For more information, see Delete a scope in the Amazon VPC IPAM User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteIpamScopeResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteIpamScopeRequest' - parameters: [] - /?Action=DeleteKeyPair&Version=2016-11-15: - get: - x-aws-operation-name: DeleteKeyPair - operationId: GET_DeleteKeyPair - description: 'Deletes the specified key pair, by removing the public key from Amazon EC2.' - responses: - '200': - description: Success - parameters: - - name: KeyName - in: query - required: false - description: The name of the key pair. - schema: - type: string - - name: KeyPairId - in: query - required: false - description: The ID of the key pair. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeleteKeyPair - operationId: POST_DeleteKeyPair - description: 'Deletes the specified key pair, by removing the public key from Amazon EC2.' - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteKeyPairRequest' - parameters: [] - /?Action=DeleteLaunchTemplate&Version=2016-11-15: - get: - x-aws-operation-name: DeleteLaunchTemplate - operationId: GET_DeleteLaunchTemplate - description: Deletes a launch template. Deleting a launch template deletes all of its versions. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteLaunchTemplateResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: LaunchTemplateId - in: query - required: false - description: The ID of the launch template. You must specify either the launch template ID or launch template name in the request. - schema: - type: string - - name: LaunchTemplateName - in: query - required: false - description: The name of the launch template. You must specify either the launch template ID or launch template name in the request. - schema: - type: string - pattern: '[a-zA-Z0-9\(\)\.\-/_]+' - minLength: 3 - maxLength: 128 - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeleteLaunchTemplate - operationId: POST_DeleteLaunchTemplate - description: Deletes a launch template. Deleting a launch template deletes all of its versions. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteLaunchTemplateResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteLaunchTemplateRequest' - parameters: [] - /?Action=DeleteLaunchTemplateVersions&Version=2016-11-15: - get: - x-aws-operation-name: DeleteLaunchTemplateVersions - operationId: GET_DeleteLaunchTemplateVersions - description: 'Deletes one or more versions of a launch template. You cannot delete the default version of a launch template; you must first assign a different version as the default. If the default version is the only version for the launch template, you must delete the entire launch template using DeleteLaunchTemplate.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteLaunchTemplateVersionsResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: LaunchTemplateId - in: query - required: false - description: The ID of the launch template. You must specify either the launch template ID or launch template name in the request. - schema: - type: string - - name: LaunchTemplateName - in: query - required: false - description: The name of the launch template. You must specify either the launch template ID or launch template name in the request. - schema: - type: string - pattern: '[a-zA-Z0-9\(\)\.\-/_]+' - minLength: 3 - maxLength: 128 - - name: LaunchTemplateVersion - in: query - required: true - description: The version numbers of one or more launch template versions to delete. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeleteLaunchTemplateVersions - operationId: POST_DeleteLaunchTemplateVersions - description: 'Deletes one or more versions of a launch template. You cannot delete the default version of a launch template; you must first assign a different version as the default. If the default version is the only version for the launch template, you must delete the entire launch template using DeleteLaunchTemplate.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteLaunchTemplateVersionsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteLaunchTemplateVersionsRequest' - parameters: [] - /?Action=DeleteLocalGatewayRoute&Version=2016-11-15: - get: - x-aws-operation-name: DeleteLocalGatewayRoute - operationId: GET_DeleteLocalGatewayRoute - description: Deletes the specified route from the specified local gateway route table. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteLocalGatewayRouteResult' - parameters: - - name: DestinationCidrBlock - in: query - required: true - description: The CIDR range for the route. This must match the CIDR for the route exactly. - schema: - type: string - - name: LocalGatewayRouteTableId - in: query - required: true - description: The ID of the local gateway route table. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeleteLocalGatewayRoute - operationId: POST_DeleteLocalGatewayRoute - description: Deletes the specified route from the specified local gateway route table. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteLocalGatewayRouteResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteLocalGatewayRouteRequest' - parameters: [] - /?Action=DeleteLocalGatewayRouteTableVpcAssociation&Version=2016-11-15: - get: - x-aws-operation-name: DeleteLocalGatewayRouteTableVpcAssociation - operationId: GET_DeleteLocalGatewayRouteTableVpcAssociation - description: Deletes the specified association between a VPC and local gateway route table. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteLocalGatewayRouteTableVpcAssociationResult' - parameters: - - name: LocalGatewayRouteTableVpcAssociationId - in: query - required: true - description: The ID of the association. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeleteLocalGatewayRouteTableVpcAssociation - operationId: POST_DeleteLocalGatewayRouteTableVpcAssociation - description: Deletes the specified association between a VPC and local gateway route table. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteLocalGatewayRouteTableVpcAssociationResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteLocalGatewayRouteTableVpcAssociationRequest' - parameters: [] - /?Action=DeleteManagedPrefixList&Version=2016-11-15: - get: - x-aws-operation-name: DeleteManagedPrefixList - operationId: GET_DeleteManagedPrefixList - description: Deletes the specified managed prefix list. You must first remove all references to the prefix list in your resources. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteManagedPrefixListResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: PrefixListId - in: query - required: true - description: The ID of the prefix list. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeleteManagedPrefixList - operationId: POST_DeleteManagedPrefixList - description: Deletes the specified managed prefix list. You must first remove all references to the prefix list in your resources. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteManagedPrefixListResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteManagedPrefixListRequest' - parameters: [] - /?Action=DeleteNatGateway&Version=2016-11-15: - get: - x-aws-operation-name: DeleteNatGateway - operationId: GET_DeleteNatGateway - description: 'Deletes the specified NAT gateway. Deleting a public NAT gateway disassociates its Elastic IP address, but does not release the address from your account. Deleting a NAT gateway does not delete any NAT gateway routes in your route tables.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteNatGatewayResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: NatGatewayId - in: query - required: true - description: The ID of the NAT gateway. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeleteNatGateway - operationId: POST_DeleteNatGateway - description: 'Deletes the specified NAT gateway. Deleting a public NAT gateway disassociates its Elastic IP address, but does not release the address from your account. Deleting a NAT gateway does not delete any NAT gateway routes in your route tables.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteNatGatewayResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteNatGatewayRequest' - parameters: [] - /?Action=DeleteNetworkAcl&Version=2016-11-15: - get: - x-aws-operation-name: DeleteNetworkAcl - operationId: GET_DeleteNetworkAcl - description: Deletes the specified network ACL. You can't delete the ACL if it's associated with any subnets. You can't delete the default network ACL. - responses: - '200': - description: Success - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: NetworkAclId - in: query - required: true - description: The ID of the network ACL. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeleteNetworkAcl - operationId: POST_DeleteNetworkAcl - description: Deletes the specified network ACL. You can't delete the ACL if it's associated with any subnets. You can't delete the default network ACL. - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteNetworkAclRequest' - parameters: [] - /?Action=DeleteNetworkAclEntry&Version=2016-11-15: - get: - x-aws-operation-name: DeleteNetworkAclEntry - operationId: GET_DeleteNetworkAclEntry - description: Deletes the specified ingress or egress entry (rule) from the specified network ACL. - responses: - '200': - description: Success - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: Egress - in: query - required: true - description: Indicates whether the rule is an egress rule. - schema: - type: boolean - - name: NetworkAclId - in: query - required: true - description: The ID of the network ACL. - schema: - type: string - - name: RuleNumber - in: query - required: true - description: The rule number of the entry to delete. - schema: - type: integer - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeleteNetworkAclEntry - operationId: POST_DeleteNetworkAclEntry - description: Deletes the specified ingress or egress entry (rule) from the specified network ACL. - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteNetworkAclEntryRequest' - parameters: [] - /?Action=DeleteNetworkInsightsAccessScope&Version=2016-11-15: - get: - x-aws-operation-name: DeleteNetworkInsightsAccessScope - operationId: GET_DeleteNetworkInsightsAccessScope - description: Deletes the specified Network Access Scope. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteNetworkInsightsAccessScopeResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: NetworkInsightsAccessScopeId - in: query - required: true - description: The ID of the Network Access Scope. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeleteNetworkInsightsAccessScope - operationId: POST_DeleteNetworkInsightsAccessScope - description: Deletes the specified Network Access Scope. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteNetworkInsightsAccessScopeResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteNetworkInsightsAccessScopeRequest' - parameters: [] - /?Action=DeleteNetworkInsightsAccessScopeAnalysis&Version=2016-11-15: - get: - x-aws-operation-name: DeleteNetworkInsightsAccessScopeAnalysis - operationId: GET_DeleteNetworkInsightsAccessScopeAnalysis - description: Deletes the specified Network Access Scope analysis. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteNetworkInsightsAccessScopeAnalysisResult' - parameters: - - name: NetworkInsightsAccessScopeAnalysisId - in: query - required: true - description: The ID of the Network Access Scope analysis. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeleteNetworkInsightsAccessScopeAnalysis - operationId: POST_DeleteNetworkInsightsAccessScopeAnalysis - description: Deletes the specified Network Access Scope analysis. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteNetworkInsightsAccessScopeAnalysisResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteNetworkInsightsAccessScopeAnalysisRequest' - parameters: [] - /?Action=DeleteNetworkInsightsAnalysis&Version=2016-11-15: - get: - x-aws-operation-name: DeleteNetworkInsightsAnalysis - operationId: GET_DeleteNetworkInsightsAnalysis - description: Deletes the specified network insights analysis. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteNetworkInsightsAnalysisResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: NetworkInsightsAnalysisId - in: query - required: true - description: The ID of the network insights analysis. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeleteNetworkInsightsAnalysis - operationId: POST_DeleteNetworkInsightsAnalysis - description: Deletes the specified network insights analysis. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteNetworkInsightsAnalysisResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteNetworkInsightsAnalysisRequest' - parameters: [] - /?Action=DeleteNetworkInsightsPath&Version=2016-11-15: - get: - x-aws-operation-name: DeleteNetworkInsightsPath - operationId: GET_DeleteNetworkInsightsPath - description: Deletes the specified path. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteNetworkInsightsPathResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: NetworkInsightsPathId - in: query - required: true - description: The ID of the path. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeleteNetworkInsightsPath - operationId: POST_DeleteNetworkInsightsPath - description: Deletes the specified path. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteNetworkInsightsPathResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteNetworkInsightsPathRequest' - parameters: [] - /?Action=DeleteNetworkInterface&Version=2016-11-15: - get: - x-aws-operation-name: DeleteNetworkInterface - operationId: GET_DeleteNetworkInterface - description: Deletes the specified network interface. You must detach the network interface before you can delete it. - responses: - '200': - description: Success - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: NetworkInterfaceId - in: query - required: true - description: The ID of the network interface. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeleteNetworkInterface - operationId: POST_DeleteNetworkInterface - description: Deletes the specified network interface. You must detach the network interface before you can delete it. - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteNetworkInterfaceRequest' - parameters: [] - /?Action=DeleteNetworkInterfacePermission&Version=2016-11-15: - get: - x-aws-operation-name: DeleteNetworkInterfacePermission - operationId: GET_DeleteNetworkInterfacePermission - description: 'Deletes a permission for a network interface. By default, you cannot delete the permission if the account for which you''re removing the permission has attached the network interface to an instance. However, you can force delete the permission, regardless of any attachment.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteNetworkInterfacePermissionResult' - parameters: - - name: NetworkInterfacePermissionId - in: query - required: true - description: The ID of the network interface permission. - schema: - type: string - - name: Force - in: query - required: false - description: Specify true to remove the permission even if the network interface is attached to an instance. - schema: - type: boolean - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeleteNetworkInterfacePermission - operationId: POST_DeleteNetworkInterfacePermission - description: 'Deletes a permission for a network interface. By default, you cannot delete the permission if the account for which you''re removing the permission has attached the network interface to an instance. However, you can force delete the permission, regardless of any attachment.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteNetworkInterfacePermissionResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteNetworkInterfacePermissionRequest' - parameters: [] - /?Action=DeletePlacementGroup&Version=2016-11-15: - get: - x-aws-operation-name: DeletePlacementGroup - operationId: GET_DeletePlacementGroup - description: 'Deletes the specified placement group. You must terminate all instances in the placement group before you can delete the placement group. For more information, see Placement groups in the Amazon EC2 User Guide.' - responses: - '200': - description: Success - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: GroupName - in: query - required: true - description: The name of the placement group. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeletePlacementGroup - operationId: POST_DeletePlacementGroup - description: 'Deletes the specified placement group. You must terminate all instances in the placement group before you can delete the placement group. For more information, see Placement groups in the Amazon EC2 User Guide.' - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeletePlacementGroupRequest' - parameters: [] - /?Action=DeletePublicIpv4Pool&Version=2016-11-15: - get: - x-aws-operation-name: DeletePublicIpv4Pool - operationId: GET_DeletePublicIpv4Pool - description: 'Delete a public IPv4 pool. A public IPv4 pool is an EC2 IP address pool required for the public IPv4 CIDRs that you own and bring to Amazon Web Services to manage with IPAM. IPv6 addresses you bring to Amazon Web Services, however, use IPAM pools only.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeletePublicIpv4PoolResult' - parameters: - - name: DryRun - in: query - required: false - description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: PoolId - in: query - required: true - description: The ID of the public IPv4 pool you want to delete. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeletePublicIpv4Pool - operationId: POST_DeletePublicIpv4Pool - description: 'Delete a public IPv4 pool. A public IPv4 pool is an EC2 IP address pool required for the public IPv4 CIDRs that you own and bring to Amazon Web Services to manage with IPAM. IPv6 addresses you bring to Amazon Web Services, however, use IPAM pools only.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeletePublicIpv4PoolResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeletePublicIpv4PoolRequest' - parameters: [] - /?Action=DeleteQueuedReservedInstances&Version=2016-11-15: - get: - x-aws-operation-name: DeleteQueuedReservedInstances - operationId: GET_DeleteQueuedReservedInstances - description: Deletes the queued purchases for the specified Reserved Instances. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteQueuedReservedInstancesResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: ReservedInstancesId - in: query - required: true - description: The IDs of the Reserved Instances. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/ReservationId' - - xml: - name: item - minItems: 1 - maxItems: 100 - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeleteQueuedReservedInstances - operationId: POST_DeleteQueuedReservedInstances - description: Deletes the queued purchases for the specified Reserved Instances. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteQueuedReservedInstancesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteQueuedReservedInstancesRequest' - parameters: [] - /?Action=DeleteRoute&Version=2016-11-15: - get: - x-aws-operation-name: DeleteRoute - operationId: GET_DeleteRoute - description: Deletes the specified route from the specified route table. - responses: - '200': - description: Success - parameters: - - name: DestinationCidrBlock - in: query - required: false - description: The IPv4 CIDR range for the route. The value you specify must match the CIDR for the route exactly. - schema: - type: string - - name: DestinationIpv6CidrBlock - in: query - required: false - description: The IPv6 CIDR range for the route. The value you specify must match the CIDR for the route exactly. - schema: - type: string - - name: DestinationPrefixListId - in: query - required: false - description: The ID of the prefix list for the route. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: RouteTableId - in: query - required: true - description: The ID of the route table. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeleteRoute - operationId: POST_DeleteRoute - description: Deletes the specified route from the specified route table. - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteRouteRequest' - parameters: [] - /?Action=DeleteRouteTable&Version=2016-11-15: - get: - x-aws-operation-name: DeleteRouteTable - operationId: GET_DeleteRouteTable - description: Deletes the specified route table. You must disassociate the route table from any subnets before you can delete it. You can't delete the main route table. - responses: - '200': - description: Success - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: RouteTableId - in: query - required: true - description: The ID of the route table. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeleteRouteTable - operationId: POST_DeleteRouteTable - description: Deletes the specified route table. You must disassociate the route table from any subnets before you can delete it. You can't delete the main route table. - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteRouteTableRequest' - parameters: [] - /?Action=DeleteSecurityGroup&Version=2016-11-15: - get: - x-aws-operation-name: DeleteSecurityGroup - operationId: GET_DeleteSecurityGroup - description: '

Deletes a security group.

If you attempt to delete a security group that is associated with an instance, or is referenced by another security group, the operation fails with InvalidGroup.InUse in EC2-Classic or DependencyViolation in EC2-VPC.

' - responses: - '200': - description: Success - parameters: - - name: GroupId - in: query - required: false - description: The ID of the security group. Required for a nondefault VPC. - schema: - type: string - - name: GroupName - in: query - required: false - description: '[EC2-Classic, default VPC] The name of the security group. You can specify either the security group name or the security group ID.' - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeleteSecurityGroup - operationId: POST_DeleteSecurityGroup - description: '

Deletes a security group.

If you attempt to delete a security group that is associated with an instance, or is referenced by another security group, the operation fails with InvalidGroup.InUse in EC2-Classic or DependencyViolation in EC2-VPC.

' - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteSecurityGroupRequest' - parameters: [] - /?Action=DeleteSnapshot&Version=2016-11-15: - get: - x-aws-operation-name: DeleteSnapshot - operationId: GET_DeleteSnapshot - description: '

Deletes the specified snapshot.

When you make periodic snapshots of a volume, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the volume.

You cannot delete a snapshot of the root device of an EBS volume used by a registered AMI. You must first de-register the AMI before you can delete the snapshot.

For more information, see Delete an Amazon EBS snapshot in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - parameters: - - name: SnapshotId - in: query - required: true - description: The ID of the EBS snapshot. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeleteSnapshot - operationId: POST_DeleteSnapshot - description: '

Deletes the specified snapshot.

When you make periodic snapshots of a volume, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the volume.

You cannot delete a snapshot of the root device of an EBS volume used by a registered AMI. You must first de-register the AMI before you can delete the snapshot.

For more information, see Delete an Amazon EBS snapshot in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteSnapshotRequest' - parameters: [] - /?Action=DeleteSpotDatafeedSubscription&Version=2016-11-15: - get: - x-aws-operation-name: DeleteSpotDatafeedSubscription - operationId: GET_DeleteSpotDatafeedSubscription - description: Deletes the data feed for Spot Instances. - responses: - '200': - description: Success - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeleteSpotDatafeedSubscription - operationId: POST_DeleteSpotDatafeedSubscription - description: Deletes the data feed for Spot Instances. - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteSpotDatafeedSubscriptionRequest' - parameters: [] - /?Action=DeleteSubnet&Version=2016-11-15: - get: - x-aws-operation-name: DeleteSubnet - operationId: GET_DeleteSubnet - description: Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet. - responses: - '200': - description: Success - parameters: - - name: SubnetId - in: query - required: true - description: The ID of the subnet. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeleteSubnet - operationId: POST_DeleteSubnet - description: Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet. - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteSubnetRequest' - parameters: [] - /?Action=DeleteSubnetCidrReservation&Version=2016-11-15: - get: - x-aws-operation-name: DeleteSubnetCidrReservation - operationId: GET_DeleteSubnetCidrReservation - description: Deletes a subnet CIDR reservation. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteSubnetCidrReservationResult' - parameters: - - name: SubnetCidrReservationId - in: query - required: true - description: The ID of the subnet CIDR reservation. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeleteSubnetCidrReservation - operationId: POST_DeleteSubnetCidrReservation - description: Deletes a subnet CIDR reservation. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteSubnetCidrReservationResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteSubnetCidrReservationRequest' - parameters: [] - /?Action=DeleteTags&Version=2016-11-15: - get: - x-aws-operation-name: DeleteTags - operationId: GET_DeleteTags - description: '

Deletes the specified set of tags from the specified set of resources.

To list the current tags, use DescribeTags. For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: ResourceId - in: query - required: true - description: '

The IDs of the resources, separated by spaces.

Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.

' - schema: - type: array - items: - $ref: '#/components/schemas/TaggableResourceId' - - name: Tag - in: query - required: false - description: '

The tags to delete. Specify a tag key and an optional tag value to delete specific tags. If you specify a tag key without a tag value, we delete any tag with this key regardless of its value. If you specify a tag key with an empty string as the tag value, we delete the tag only if its value is an empty string.

If you omit this parameter, we delete all user-defined tags for the specified resources. We do not delete Amazon Web Services-generated tags (tags that have the aws: prefix).

Constraints: Up to 1000 tags.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Tag' - - xml: - name: item - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeleteTags - operationId: POST_DeleteTags - description: '

Deletes the specified set of tags from the specified set of resources.

To list the current tags, use DescribeTags. For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteTagsRequest' - parameters: [] - /?Action=DeleteTrafficMirrorFilter&Version=2016-11-15: - get: - x-aws-operation-name: DeleteTrafficMirrorFilter - operationId: GET_DeleteTrafficMirrorFilter - description:

Deletes the specified Traffic Mirror filter.

You cannot delete a Traffic Mirror filter that is in use by a Traffic Mirror session.

- responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteTrafficMirrorFilterResult' - parameters: - - name: TrafficMirrorFilterId - in: query - required: true - description: The ID of the Traffic Mirror filter. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeleteTrafficMirrorFilter - operationId: POST_DeleteTrafficMirrorFilter - description:

Deletes the specified Traffic Mirror filter.

You cannot delete a Traffic Mirror filter that is in use by a Traffic Mirror session.

- responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteTrafficMirrorFilterResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteTrafficMirrorFilterRequest' - parameters: [] - /?Action=DeleteTrafficMirrorFilterRule&Version=2016-11-15: - get: - x-aws-operation-name: DeleteTrafficMirrorFilterRule - operationId: GET_DeleteTrafficMirrorFilterRule - description: Deletes the specified Traffic Mirror rule. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteTrafficMirrorFilterRuleResult' - parameters: - - name: TrafficMirrorFilterRuleId - in: query - required: true - description: The ID of the Traffic Mirror rule. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeleteTrafficMirrorFilterRule - operationId: POST_DeleteTrafficMirrorFilterRule - description: Deletes the specified Traffic Mirror rule. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteTrafficMirrorFilterRuleResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteTrafficMirrorFilterRuleRequest' - parameters: [] - /?Action=DeleteTrafficMirrorSession&Version=2016-11-15: - get: - x-aws-operation-name: DeleteTrafficMirrorSession - operationId: GET_DeleteTrafficMirrorSession - description: Deletes the specified Traffic Mirror session. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteTrafficMirrorSessionResult' - parameters: - - name: TrafficMirrorSessionId - in: query - required: true - description: The ID of the Traffic Mirror session. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeleteTrafficMirrorSession - operationId: POST_DeleteTrafficMirrorSession - description: Deletes the specified Traffic Mirror session. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteTrafficMirrorSessionResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteTrafficMirrorSessionRequest' - parameters: [] - /?Action=DeleteTrafficMirrorTarget&Version=2016-11-15: - get: - x-aws-operation-name: DeleteTrafficMirrorTarget - operationId: GET_DeleteTrafficMirrorTarget - description:

Deletes the specified Traffic Mirror target.

You cannot delete a Traffic Mirror target that is in use by a Traffic Mirror session.

- responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteTrafficMirrorTargetResult' - parameters: - - name: TrafficMirrorTargetId - in: query - required: true - description: The ID of the Traffic Mirror target. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeleteTrafficMirrorTarget - operationId: POST_DeleteTrafficMirrorTarget - description:

Deletes the specified Traffic Mirror target.

You cannot delete a Traffic Mirror target that is in use by a Traffic Mirror session.

- responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteTrafficMirrorTargetResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteTrafficMirrorTargetRequest' - parameters: [] - /?Action=DeleteTransitGateway&Version=2016-11-15: - get: - x-aws-operation-name: DeleteTransitGateway - operationId: GET_DeleteTransitGateway - description: Deletes the specified transit gateway. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteTransitGatewayResult' - parameters: - - name: TransitGatewayId - in: query - required: true - description: The ID of the transit gateway. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeleteTransitGateway - operationId: POST_DeleteTransitGateway - description: Deletes the specified transit gateway. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteTransitGatewayResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteTransitGatewayRequest' - parameters: [] - /?Action=DeleteTransitGatewayConnect&Version=2016-11-15: - get: - x-aws-operation-name: DeleteTransitGatewayConnect - operationId: GET_DeleteTransitGatewayConnect - description: Deletes the specified Connect attachment. You must first delete any Connect peers for the attachment. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteTransitGatewayConnectResult' - parameters: - - name: TransitGatewayAttachmentId - in: query - required: true - description: The ID of the Connect attachment. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeleteTransitGatewayConnect - operationId: POST_DeleteTransitGatewayConnect - description: Deletes the specified Connect attachment. You must first delete any Connect peers for the attachment. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteTransitGatewayConnectResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteTransitGatewayConnectRequest' - parameters: [] - /?Action=DeleteTransitGatewayConnectPeer&Version=2016-11-15: - get: - x-aws-operation-name: DeleteTransitGatewayConnectPeer - operationId: GET_DeleteTransitGatewayConnectPeer - description: Deletes the specified Connect peer. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteTransitGatewayConnectPeerResult' - parameters: - - name: TransitGatewayConnectPeerId - in: query - required: true - description: The ID of the Connect peer. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeleteTransitGatewayConnectPeer - operationId: POST_DeleteTransitGatewayConnectPeer - description: Deletes the specified Connect peer. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteTransitGatewayConnectPeerResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteTransitGatewayConnectPeerRequest' - parameters: [] - /?Action=DeleteTransitGatewayMulticastDomain&Version=2016-11-15: - get: - x-aws-operation-name: DeleteTransitGatewayMulticastDomain - operationId: GET_DeleteTransitGatewayMulticastDomain - description: Deletes the specified transit gateway multicast domain. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteTransitGatewayMulticastDomainResult' - parameters: - - name: TransitGatewayMulticastDomainId - in: query - required: true - description: The ID of the transit gateway multicast domain. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeleteTransitGatewayMulticastDomain - operationId: POST_DeleteTransitGatewayMulticastDomain - description: Deletes the specified transit gateway multicast domain. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteTransitGatewayMulticastDomainResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteTransitGatewayMulticastDomainRequest' - parameters: [] - /?Action=DeleteTransitGatewayPeeringAttachment&Version=2016-11-15: - get: - x-aws-operation-name: DeleteTransitGatewayPeeringAttachment - operationId: GET_DeleteTransitGatewayPeeringAttachment - description: Deletes a transit gateway peering attachment. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteTransitGatewayPeeringAttachmentResult' - parameters: - - name: TransitGatewayAttachmentId - in: query - required: true - description: The ID of the transit gateway peering attachment. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeleteTransitGatewayPeeringAttachment - operationId: POST_DeleteTransitGatewayPeeringAttachment - description: Deletes a transit gateway peering attachment. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteTransitGatewayPeeringAttachmentResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteTransitGatewayPeeringAttachmentRequest' - parameters: [] - /?Action=DeleteTransitGatewayPrefixListReference&Version=2016-11-15: - get: - x-aws-operation-name: DeleteTransitGatewayPrefixListReference - operationId: GET_DeleteTransitGatewayPrefixListReference - description: Deletes a reference (route) to a prefix list in a specified transit gateway route table. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteTransitGatewayPrefixListReferenceResult' - parameters: - - name: TransitGatewayRouteTableId - in: query - required: true - description: The ID of the route table. - schema: - type: string - - name: PrefixListId - in: query - required: true - description: The ID of the prefix list. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeleteTransitGatewayPrefixListReference - operationId: POST_DeleteTransitGatewayPrefixListReference - description: Deletes a reference (route) to a prefix list in a specified transit gateway route table. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteTransitGatewayPrefixListReferenceResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteTransitGatewayPrefixListReferenceRequest' - parameters: [] - /?Action=DeleteTransitGatewayRoute&Version=2016-11-15: - get: - x-aws-operation-name: DeleteTransitGatewayRoute - operationId: GET_DeleteTransitGatewayRoute - description: Deletes the specified route from the specified transit gateway route table. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteTransitGatewayRouteResult' - parameters: - - name: TransitGatewayRouteTableId - in: query - required: true - description: The ID of the transit gateway route table. - schema: - type: string - - name: DestinationCidrBlock - in: query - required: true - description: The CIDR range for the route. This must match the CIDR for the route exactly. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeleteTransitGatewayRoute - operationId: POST_DeleteTransitGatewayRoute - description: Deletes the specified route from the specified transit gateway route table. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteTransitGatewayRouteResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteTransitGatewayRouteRequest' - parameters: [] - /?Action=DeleteTransitGatewayRouteTable&Version=2016-11-15: - get: - x-aws-operation-name: DeleteTransitGatewayRouteTable - operationId: GET_DeleteTransitGatewayRouteTable - description: Deletes the specified transit gateway route table. You must disassociate the route table from any transit gateway route tables before you can delete it. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteTransitGatewayRouteTableResult' - parameters: - - name: TransitGatewayRouteTableId - in: query - required: true - description: The ID of the transit gateway route table. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeleteTransitGatewayRouteTable - operationId: POST_DeleteTransitGatewayRouteTable - description: Deletes the specified transit gateway route table. You must disassociate the route table from any transit gateway route tables before you can delete it. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteTransitGatewayRouteTableResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteTransitGatewayRouteTableRequest' - parameters: [] - /?Action=DeleteTransitGatewayVpcAttachment&Version=2016-11-15: - get: - x-aws-operation-name: DeleteTransitGatewayVpcAttachment - operationId: GET_DeleteTransitGatewayVpcAttachment - description: Deletes the specified VPC attachment. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteTransitGatewayVpcAttachmentResult' - parameters: - - name: TransitGatewayAttachmentId - in: query - required: true - description: The ID of the attachment. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeleteTransitGatewayVpcAttachment - operationId: POST_DeleteTransitGatewayVpcAttachment - description: Deletes the specified VPC attachment. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteTransitGatewayVpcAttachmentResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteTransitGatewayVpcAttachmentRequest' - parameters: [] - /?Action=DeleteVolume&Version=2016-11-15: - get: - x-aws-operation-name: DeleteVolume - operationId: GET_DeleteVolume - description: '

Deletes the specified EBS volume. The volume must be in the available state (not attached to an instance).

The volume can remain in the deleting state for several minutes.

For more information, see Delete an Amazon EBS volume in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - parameters: - - name: VolumeId - in: query - required: true - description: The ID of the volume. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeleteVolume - operationId: POST_DeleteVolume - description: '

Deletes the specified EBS volume. The volume must be in the available state (not attached to an instance).

The volume can remain in the deleting state for several minutes.

For more information, see Delete an Amazon EBS volume in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteVolumeRequest' - parameters: [] - /?Action=DeleteVpc&Version=2016-11-15: - get: - x-aws-operation-name: DeleteVpc - operationId: GET_DeleteVpc - description: 'Deletes the specified VPC. You must detach or delete all gateways and resources that are associated with the VPC before you can delete it. For example, you must terminate all instances running in the VPC, delete all security groups associated with the VPC (except the default one), delete all route tables associated with the VPC (except the default one), and so on.' - responses: - '200': - description: Success - parameters: - - name: VpcId - in: query - required: true - description: The ID of the VPC. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeleteVpc - operationId: POST_DeleteVpc - description: 'Deletes the specified VPC. You must detach or delete all gateways and resources that are associated with the VPC before you can delete it. For example, you must terminate all instances running in the VPC, delete all security groups associated with the VPC (except the default one), delete all route tables associated with the VPC (except the default one), and so on.' - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteVpcRequest' - parameters: [] - /?Action=DeleteVpcEndpointConnectionNotifications&Version=2016-11-15: - get: - x-aws-operation-name: DeleteVpcEndpointConnectionNotifications - operationId: GET_DeleteVpcEndpointConnectionNotifications - description: Deletes one or more VPC endpoint connection notifications. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteVpcEndpointConnectionNotificationsResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: ConnectionNotificationId - in: query - required: true - description: One or more notification IDs. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/ConnectionNotificationId' - - xml: - name: item - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeleteVpcEndpointConnectionNotifications - operationId: POST_DeleteVpcEndpointConnectionNotifications - description: Deletes one or more VPC endpoint connection notifications. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteVpcEndpointConnectionNotificationsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteVpcEndpointConnectionNotificationsRequest' - parameters: [] - /?Action=DeleteVpcEndpointServiceConfigurations&Version=2016-11-15: - get: - x-aws-operation-name: DeleteVpcEndpointServiceConfigurations - operationId: GET_DeleteVpcEndpointServiceConfigurations - description: 'Deletes one or more VPC endpoint service configurations in your account. Before you delete the endpoint service configuration, you must reject any Available or PendingAcceptance interface endpoint connections that are attached to the service.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteVpcEndpointServiceConfigurationsResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: ServiceId - in: query - required: true - description: The IDs of one or more services. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/VpcEndpointServiceId' - - xml: - name: item - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeleteVpcEndpointServiceConfigurations - operationId: POST_DeleteVpcEndpointServiceConfigurations - description: 'Deletes one or more VPC endpoint service configurations in your account. Before you delete the endpoint service configuration, you must reject any Available or PendingAcceptance interface endpoint connections that are attached to the service.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteVpcEndpointServiceConfigurationsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteVpcEndpointServiceConfigurationsRequest' - parameters: [] - /?Action=DeleteVpcEndpoints&Version=2016-11-15: - get: - x-aws-operation-name: DeleteVpcEndpoints - operationId: GET_DeleteVpcEndpoints - description: '

Deletes one or more specified VPC endpoints. You can delete any of the following types of VPC endpoints.

  • Gateway endpoint,

  • Gateway Load Balancer endpoint,

  • Interface endpoint

The following rules apply when you delete a VPC endpoint:

  • When you delete a gateway endpoint, we delete the endpoint routes in the route tables that are associated with the endpoint.

  • When you delete a Gateway Load Balancer endpoint, we delete the endpoint network interfaces.

    You can only delete Gateway Load Balancer endpoints when the routes that are associated with the endpoint are deleted.

  • When you delete an interface endpoint, we delete the endpoint network interfaces.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteVpcEndpointsResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: VpcEndpointId - in: query - required: true - description: One or more VPC endpoint IDs. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/VpcEndpointId' - - xml: - name: item - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeleteVpcEndpoints - operationId: POST_DeleteVpcEndpoints - description: '

Deletes one or more specified VPC endpoints. You can delete any of the following types of VPC endpoints.

  • Gateway endpoint,

  • Gateway Load Balancer endpoint,

  • Interface endpoint

The following rules apply when you delete a VPC endpoint:

  • When you delete a gateway endpoint, we delete the endpoint routes in the route tables that are associated with the endpoint.

  • When you delete a Gateway Load Balancer endpoint, we delete the endpoint network interfaces.

    You can only delete Gateway Load Balancer endpoints when the routes that are associated with the endpoint are deleted.

  • When you delete an interface endpoint, we delete the endpoint network interfaces.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteVpcEndpointsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteVpcEndpointsRequest' - parameters: [] - /?Action=DeleteVpcPeeringConnection&Version=2016-11-15: - get: - x-aws-operation-name: DeleteVpcPeeringConnection - operationId: GET_DeleteVpcPeeringConnection - description: Deletes a VPC peering connection. Either the owner of the requester VPC or the owner of the accepter VPC can delete the VPC peering connection if it's in the active state. The owner of the requester VPC can delete a VPC peering connection in the pending-acceptance state. You cannot delete a VPC peering connection that's in the failed state. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteVpcPeeringConnectionResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: VpcPeeringConnectionId - in: query - required: true - description: The ID of the VPC peering connection. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeleteVpcPeeringConnection - operationId: POST_DeleteVpcPeeringConnection - description: Deletes a VPC peering connection. Either the owner of the requester VPC or the owner of the accepter VPC can delete the VPC peering connection if it's in the active state. The owner of the requester VPC can delete a VPC peering connection in the pending-acceptance state. You cannot delete a VPC peering connection that's in the failed state. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteVpcPeeringConnectionResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteVpcPeeringConnectionRequest' - parameters: [] - /?Action=DeleteVpnConnection&Version=2016-11-15: - get: - x-aws-operation-name: DeleteVpnConnection - operationId: GET_DeleteVpnConnection - description: '

Deletes the specified VPN connection.

If you''re deleting the VPC and its associated components, we recommend that you detach the virtual private gateway from the VPC and delete the VPC before deleting the VPN connection. If you believe that the tunnel credentials for your VPN connection have been compromised, you can delete the VPN connection and create a new one that has new keys, without needing to delete the VPC or virtual private gateway. If you create a new VPN connection, you must reconfigure the customer gateway device using the new configuration information returned with the new VPN connection ID.

For certificate-based authentication, delete all Certificate Manager (ACM) private certificates used for the Amazon Web Services-side tunnel endpoints for the VPN connection before deleting the VPN connection.

' - responses: - '200': - description: Success - parameters: - - name: VpnConnectionId - in: query - required: true - description: The ID of the VPN connection. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeleteVpnConnection - operationId: POST_DeleteVpnConnection - description: '

Deletes the specified VPN connection.

If you''re deleting the VPC and its associated components, we recommend that you detach the virtual private gateway from the VPC and delete the VPC before deleting the VPN connection. If you believe that the tunnel credentials for your VPN connection have been compromised, you can delete the VPN connection and create a new one that has new keys, without needing to delete the VPC or virtual private gateway. If you create a new VPN connection, you must reconfigure the customer gateway device using the new configuration information returned with the new VPN connection ID.

For certificate-based authentication, delete all Certificate Manager (ACM) private certificates used for the Amazon Web Services-side tunnel endpoints for the VPN connection before deleting the VPN connection.

' - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteVpnConnectionRequest' - parameters: [] - /?Action=DeleteVpnConnectionRoute&Version=2016-11-15: - get: - x-aws-operation-name: DeleteVpnConnectionRoute - operationId: GET_DeleteVpnConnectionRoute - description: Deletes the specified static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway. - responses: - '200': - description: Success - parameters: - - name: DestinationCidrBlock - in: query - required: true - description: The CIDR block associated with the local subnet of the customer network. - schema: - type: string - - name: VpnConnectionId - in: query - required: true - description: The ID of the VPN connection. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeleteVpnConnectionRoute - operationId: POST_DeleteVpnConnectionRoute - description: Deletes the specified static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway. - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteVpnConnectionRouteRequest' - parameters: [] - /?Action=DeleteVpnGateway&Version=2016-11-15: - get: - x-aws-operation-name: DeleteVpnGateway - operationId: GET_DeleteVpnGateway - description: Deletes the specified virtual private gateway. You must first detach the virtual private gateway from the VPC. Note that you don't need to delete the virtual private gateway if you plan to delete and recreate the VPN connection between your VPC and your network. - responses: - '200': - description: Success - parameters: - - name: VpnGatewayId - in: query - required: true - description: The ID of the virtual private gateway. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeleteVpnGateway - operationId: POST_DeleteVpnGateway - description: Deletes the specified virtual private gateway. You must first detach the virtual private gateway from the VPC. Note that you don't need to delete the virtual private gateway if you plan to delete and recreate the VPN connection between your VPC and your network. - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteVpnGatewayRequest' - parameters: [] - /?Action=DeprovisionByoipCidr&Version=2016-11-15: - get: - x-aws-operation-name: DeprovisionByoipCidr - operationId: GET_DeprovisionByoipCidr - description: '

Releases the specified address range that you provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and deletes the corresponding address pool.

Before you can release an address range, you must stop advertising it using WithdrawByoipCidr and you must not have any IP addresses allocated from its address range.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeprovisionByoipCidrResult' - parameters: - - name: Cidr - in: query - required: true - description: 'The address range, in CIDR notation. The prefix must be the same prefix that you specified when you provisioned the address range.' - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeprovisionByoipCidr - operationId: POST_DeprovisionByoipCidr - description: '

Releases the specified address range that you provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and deletes the corresponding address pool.

Before you can release an address range, you must stop advertising it using WithdrawByoipCidr and you must not have any IP addresses allocated from its address range.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeprovisionByoipCidrResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeprovisionByoipCidrRequest' - parameters: [] - /?Action=DeprovisionIpamPoolCidr&Version=2016-11-15: - get: - x-aws-operation-name: DeprovisionIpamPoolCidr - operationId: GET_DeprovisionIpamPoolCidr - description: 'Deprovision a CIDR provisioned from an IPAM pool. If you deprovision a CIDR from a pool that has a source pool, the CIDR is recycled back into the source pool. For more information, see Deprovision pool CIDRs in the Amazon VPC IPAM User Guide.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeprovisionIpamPoolCidrResult' - parameters: - - name: DryRun - in: query - required: false - description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: IpamPoolId - in: query - required: true - description: The ID of the pool that has the CIDR you want to deprovision. - schema: - type: string - - name: Cidr - in: query - required: false - description: The CIDR which you want to deprovision from the pool. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeprovisionIpamPoolCidr - operationId: POST_DeprovisionIpamPoolCidr - description: 'Deprovision a CIDR provisioned from an IPAM pool. If you deprovision a CIDR from a pool that has a source pool, the CIDR is recycled back into the source pool. For more information, see Deprovision pool CIDRs in the Amazon VPC IPAM User Guide.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeprovisionIpamPoolCidrResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeprovisionIpamPoolCidrRequest' - parameters: [] - /?Action=DeprovisionPublicIpv4PoolCidr&Version=2016-11-15: - get: - x-aws-operation-name: DeprovisionPublicIpv4PoolCidr - operationId: GET_DeprovisionPublicIpv4PoolCidr - description: Deprovision a CIDR from a public IPv4 pool. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeprovisionPublicIpv4PoolCidrResult' - parameters: - - name: DryRun - in: query - required: false - description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: PoolId - in: query - required: true - description: The ID of the pool that you want to deprovision the CIDR from. - schema: - type: string - - name: Cidr - in: query - required: true - description: The CIDR you want to deprovision from the pool. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeprovisionPublicIpv4PoolCidr - operationId: POST_DeprovisionPublicIpv4PoolCidr - description: Deprovision a CIDR from a public IPv4 pool. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeprovisionPublicIpv4PoolCidrResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeprovisionPublicIpv4PoolCidrRequest' - parameters: [] - /?Action=DeregisterImage&Version=2016-11-15: - get: - x-aws-operation-name: DeregisterImage - operationId: GET_DeregisterImage - description: '

Deregisters the specified AMI. After you deregister an AMI, it can''t be used to launch new instances.

If you deregister an AMI that matches a Recycle Bin retention rule, the AMI is retained in the Recycle Bin for the specified retention period. For more information, see Recycle Bin in the Amazon Elastic Compute Cloud User Guide.

When you deregister an AMI, it doesn''t affect any instances that you''ve already launched from the AMI. You''ll continue to incur usage costs for those instances until you terminate them.

When you deregister an Amazon EBS-backed AMI, it doesn''t affect the snapshot that was created for the root volume of the instance during the AMI creation process. When you deregister an instance store-backed AMI, it doesn''t affect the files that you uploaded to Amazon S3 when you created the AMI.

' - responses: - '200': - description: Success - parameters: - - name: ImageId - in: query - required: true - description: The ID of the AMI. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeregisterImage - operationId: POST_DeregisterImage - description: '

Deregisters the specified AMI. After you deregister an AMI, it can''t be used to launch new instances.

If you deregister an AMI that matches a Recycle Bin retention rule, the AMI is retained in the Recycle Bin for the specified retention period. For more information, see Recycle Bin in the Amazon Elastic Compute Cloud User Guide.

When you deregister an AMI, it doesn''t affect any instances that you''ve already launched from the AMI. You''ll continue to incur usage costs for those instances until you terminate them.

When you deregister an Amazon EBS-backed AMI, it doesn''t affect the snapshot that was created for the root volume of the instance during the AMI creation process. When you deregister an instance store-backed AMI, it doesn''t affect the files that you uploaded to Amazon S3 when you created the AMI.

' - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeregisterImageRequest' - parameters: [] - /?Action=DeregisterInstanceEventNotificationAttributes&Version=2016-11-15: - get: - x-aws-operation-name: DeregisterInstanceEventNotificationAttributes - operationId: GET_DeregisterInstanceEventNotificationAttributes - description: Deregisters tag keys to prevent tags that have the specified tag keys from being included in scheduled event notifications for resources in the Region. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeregisterInstanceEventNotificationAttributesResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: InstanceTagAttribute - in: query - required: false - description: Information about the tag keys to deregister. - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether to deregister all tag keys in the current Region. Specify false to deregister all tag keys. - InstanceTagKey: - allOf: - - $ref: '#/components/schemas/InstanceTagKeySet' - - description: Information about the tag keys to deregister. - description: Information about the tag keys to deregister for the current Region. You can either specify individual tag keys or deregister all tag keys in the current Region. You must specify either IncludeAllTagsOfInstance or InstanceTagKeys in the request - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeregisterInstanceEventNotificationAttributes - operationId: POST_DeregisterInstanceEventNotificationAttributes - description: Deregisters tag keys to prevent tags that have the specified tag keys from being included in scheduled event notifications for resources in the Region. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeregisterInstanceEventNotificationAttributesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeregisterInstanceEventNotificationAttributesRequest' - parameters: [] - /?Action=DeregisterTransitGatewayMulticastGroupMembers&Version=2016-11-15: - get: - x-aws-operation-name: DeregisterTransitGatewayMulticastGroupMembers - operationId: GET_DeregisterTransitGatewayMulticastGroupMembers - description: Deregisters the specified members (network interfaces) from the transit gateway multicast group. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeregisterTransitGatewayMulticastGroupMembersResult' - parameters: - - name: TransitGatewayMulticastDomainId - in: query - required: false - description: The ID of the transit gateway multicast domain. - schema: - type: string - - name: GroupIpAddress - in: query - required: false - description: The IP address assigned to the transit gateway multicast group. - schema: - type: string - - name: NetworkInterfaceIds - in: query - required: false - description: The IDs of the group members' network interfaces. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/NetworkInterfaceId' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeregisterTransitGatewayMulticastGroupMembers - operationId: POST_DeregisterTransitGatewayMulticastGroupMembers - description: Deregisters the specified members (network interfaces) from the transit gateway multicast group. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeregisterTransitGatewayMulticastGroupMembersResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeregisterTransitGatewayMulticastGroupMembersRequest' - parameters: [] - /?Action=DeregisterTransitGatewayMulticastGroupSources&Version=2016-11-15: - get: - x-aws-operation-name: DeregisterTransitGatewayMulticastGroupSources - operationId: GET_DeregisterTransitGatewayMulticastGroupSources - description: Deregisters the specified sources (network interfaces) from the transit gateway multicast group. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeregisterTransitGatewayMulticastGroupSourcesResult' - parameters: - - name: TransitGatewayMulticastDomainId - in: query - required: false - description: The ID of the transit gateway multicast domain. - schema: - type: string - - name: GroupIpAddress - in: query - required: false - description: The IP address assigned to the transit gateway multicast group. - schema: - type: string - - name: NetworkInterfaceIds - in: query - required: false - description: The IDs of the group sources' network interfaces. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/NetworkInterfaceId' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DeregisterTransitGatewayMulticastGroupSources - operationId: POST_DeregisterTransitGatewayMulticastGroupSources - description: Deregisters the specified sources (network interfaces) from the transit gateway multicast group. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DeregisterTransitGatewayMulticastGroupSourcesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DeregisterTransitGatewayMulticastGroupSourcesRequest' - parameters: [] - /?Action=DescribeAccountAttributes&Version=2016-11-15: - get: - x-aws-operation-name: DescribeAccountAttributes - operationId: GET_DescribeAccountAttributes - description: '

Describes attributes of your Amazon Web Services account. The following are the supported account attributes:

  • supported-platforms: Indicates whether your account can launch instances into EC2-Classic and EC2-VPC, or only into EC2-VPC.

  • default-vpc: The ID of the default VPC for your account, or none.

  • max-instances: This attribute is no longer supported. The returned value does not reflect your actual vCPU limit for running On-Demand Instances. For more information, see On-Demand Instance Limits in the Amazon Elastic Compute Cloud User Guide.

  • vpc-max-security-groups-per-interface: The maximum number of security groups that you can assign to a network interface.

  • max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate for use with EC2-Classic.

  • vpc-max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate for use with EC2-VPC.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeAccountAttributesResult' - parameters: - - name: AttributeName - in: query - required: false - description: The account attribute names. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/AccountAttributeName' - - xml: - name: attributeName - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeAccountAttributes - operationId: POST_DescribeAccountAttributes - description: '

Describes attributes of your Amazon Web Services account. The following are the supported account attributes:

  • supported-platforms: Indicates whether your account can launch instances into EC2-Classic and EC2-VPC, or only into EC2-VPC.

  • default-vpc: The ID of the default VPC for your account, or none.

  • max-instances: This attribute is no longer supported. The returned value does not reflect your actual vCPU limit for running On-Demand Instances. For more information, see On-Demand Instance Limits in the Amazon Elastic Compute Cloud User Guide.

  • vpc-max-security-groups-per-interface: The maximum number of security groups that you can assign to a network interface.

  • max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate for use with EC2-Classic.

  • vpc-max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate for use with EC2-VPC.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeAccountAttributesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeAccountAttributesRequest' - parameters: [] - /?Action=DescribeAddresses&Version=2016-11-15: - get: - x-aws-operation-name: DescribeAddresses - operationId: GET_DescribeAddresses - description: '

Describes the specified Elastic IP addresses or all of your Elastic IP addresses.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeAddressesResult' - parameters: - - name: Filter - in: query - required: false - description: '

One or more filters. Filter names and values are case-sensitive.

  • allocation-id - [EC2-VPC] The allocation ID for the address.

  • association-id - [EC2-VPC] The association ID for the address.

  • domain - Indicates whether the address is for use in EC2-Classic (standard) or in a VPC (vpc).

  • instance-id - The ID of the instance the address is associated with, if any.

  • network-border-group - A unique set of Availability Zones, Local Zones, or Wavelength Zones from where Amazon Web Services advertises IP addresses.

  • network-interface-id - [EC2-VPC] The ID of the network interface that the address is associated with, if any.

  • network-interface-owner-id - The Amazon Web Services account ID of the owner.

  • private-ip-address - [EC2-VPC] The private IP address associated with the Elastic IP address.

  • public-ip - The Elastic IP address, or the carrier IP address.

  • tag:<key> - 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. 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.

  • 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.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: PublicIp - in: query - required: false - description: '

One or more Elastic IP addresses.

Default: Describes all your Elastic IP addresses.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: PublicIp - - name: AllocationId - in: query - required: false - description: '[EC2-VPC] Information about the allocation IDs.' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/AllocationId' - - xml: - name: AllocationId - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeAddresses - operationId: POST_DescribeAddresses - description: '

Describes the specified Elastic IP addresses or all of your Elastic IP addresses.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeAddressesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeAddressesRequest' - parameters: [] - /?Action=DescribeAddressesAttribute&Version=2016-11-15: - get: - x-aws-operation-name: DescribeAddressesAttribute - operationId: GET_DescribeAddressesAttribute - description: 'Describes the attributes of the specified Elastic IP addresses. For requirements, see Using reverse DNS for email applications.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeAddressesAttributeResult' - parameters: - - name: AllocationId - in: query - required: false - description: '[EC2-VPC] The allocation IDs.' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/AllocationId' - - xml: - name: item - - name: Attribute - in: query - required: false - description: The attribute of the IP address. - schema: - type: string - enum: - - domain-name - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - schema: - type: integer - minimum: 1 - maximum: 1000 - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeAddressesAttribute - operationId: POST_DescribeAddressesAttribute - description: 'Describes the attributes of the specified Elastic IP addresses. For requirements, see Using reverse DNS for email applications.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeAddressesAttributeResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeAddressesAttributeRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeAggregateIdFormat&Version=2016-11-15: - get: - x-aws-operation-name: DescribeAggregateIdFormat - operationId: GET_DescribeAggregateIdFormat - description: '

Describes the longer ID format settings for all resource types in a specific Region. This request is useful for performing a quick audit to determine whether a specific Region is fully opted in for longer IDs (17-character IDs).

This request only returns information about resource types that support longer IDs.

The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeAggregateIdFormatResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeAggregateIdFormat - operationId: POST_DescribeAggregateIdFormat - description: '

Describes the longer ID format settings for all resource types in a specific Region. This request is useful for performing a quick audit to determine whether a specific Region is fully opted in for longer IDs (17-character IDs).

This request only returns information about resource types that support longer IDs.

The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeAggregateIdFormatResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeAggregateIdFormatRequest' - parameters: [] - /?Action=DescribeAvailabilityZones&Version=2016-11-15: - get: - x-aws-operation-name: DescribeAvailabilityZones - operationId: GET_DescribeAvailabilityZones - description: '

Describes the Availability Zones, Local Zones, and Wavelength Zones that are available to you. If there is an event impacting a zone, you can use this request to view the state and any provided messages for that zone.

For more information about Availability Zones, Local Zones, and Wavelength Zones, see Regions and zones in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeAvailabilityZonesResult' - parameters: - - name: Filter - in: query - required: false - description: '

The filters.

  • group-name - For Availability Zones, use the Region name. For Local Zones, use the name of the group associated with the Local Zone (for example, us-west-2-lax-1) For Wavelength Zones, use the name of the group associated with the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).

  • message - The Zone message.

  • opt-in-status - The opt-in status (opted-in, and not-opted-in | opt-in-not-required).

  • parent-zoneID - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.

  • parent-zoneName - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.

  • region-name - The name of the Region for the Zone (for example, us-east-1).

  • state - The state of the Availability Zone, the Local Zone, or the Wavelength Zone (available).

  • zone-id - The ID of the Availability Zone (for example, use1-az1), the Local Zone (for example, usw2-lax1-az1), or the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).

  • zone-type - The type of zone, for example, local-zone.

  • zone-name - The name of the Availability Zone (for example, us-east-1a), the Local Zone (for example, us-west-2-lax-1a), or the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).

  • zone-type - The type of zone, for example, local-zone.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: ZoneName - in: query - required: false - description: 'The names of the Availability Zones, Local Zones, and Wavelength Zones.' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: ZoneName - - name: ZoneId - in: query - required: false - description: 'The IDs of the Availability Zones, Local Zones, and Wavelength Zones.' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: ZoneId - - name: AllAvailabilityZones - in: query - required: false - description: '

Include all Availability Zones, Local Zones, and Wavelength Zones regardless of your opt-in status.

If you do not use this parameter, the results include only the zones for the Regions where you have chosen the option to opt in.

' - schema: - type: boolean - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeAvailabilityZones - operationId: POST_DescribeAvailabilityZones - description: '

Describes the Availability Zones, Local Zones, and Wavelength Zones that are available to you. If there is an event impacting a zone, you can use this request to view the state and any provided messages for that zone.

For more information about Availability Zones, Local Zones, and Wavelength Zones, see Regions and zones in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeAvailabilityZonesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeAvailabilityZonesRequest' - parameters: [] - /?Action=DescribeBundleTasks&Version=2016-11-15: - get: - x-aws-operation-name: DescribeBundleTasks - operationId: GET_DescribeBundleTasks - description: '

Describes the specified bundle tasks or all of your bundle tasks.

Completed bundle tasks are listed for only a limited time. If your bundle task is no longer in the list, you can still register an AMI from it. Just use RegisterImage with the Amazon S3 bucket name and image manifest name you provided to the bundle task.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeBundleTasksResult' - parameters: - - name: BundleId - in: query - required: false - description: '

The bundle task IDs.

Default: Describes all your bundle tasks.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/BundleId' - - xml: - name: BundleId - - name: Filter - in: query - required: false - description: '

The filters.

  • bundle-id - The ID of the bundle task.

  • error-code - If the task failed, the error code returned.

  • error-message - If the task failed, the error message returned.

  • instance-id - The ID of the instance.

  • progress - The level of task completion, as a percentage (for example, 20%).

  • s3-bucket - The Amazon S3 bucket to store the AMI.

  • s3-prefix - The beginning of the AMI name.

  • start-time - The time the task started (for example, 2013-09-15T17:15:20.000Z).

  • state - The state of the task (pending | waiting-for-shutdown | bundling | storing | cancelling | complete | failed).

  • update-time - The time of the most recent update for the task.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeBundleTasks - operationId: POST_DescribeBundleTasks - description: '

Describes the specified bundle tasks or all of your bundle tasks.

Completed bundle tasks are listed for only a limited time. If your bundle task is no longer in the list, you can still register an AMI from it. Just use RegisterImage with the Amazon S3 bucket name and image manifest name you provided to the bundle task.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeBundleTasksResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeBundleTasksRequest' - parameters: [] - /?Action=DescribeByoipCidrs&Version=2016-11-15: - get: - x-aws-operation-name: DescribeByoipCidrs - operationId: GET_DescribeByoipCidrs - description: '

Describes the IP address ranges that were specified in calls to ProvisionByoipCidr.

To describe the address pools that were created when you provisioned the address ranges, use DescribePublicIpv4Pools or DescribeIpv6Pools.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeByoipCidrsResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: MaxResults - in: query - required: true - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - schema: - type: integer - minimum: 1 - maximum: 100 - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeByoipCidrs - operationId: POST_DescribeByoipCidrs - description: '

Describes the IP address ranges that were specified in calls to ProvisionByoipCidr.

To describe the address pools that were created when you provisioned the address ranges, use DescribePublicIpv4Pools or DescribeIpv6Pools.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeByoipCidrsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeByoipCidrsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeCapacityReservationFleets&Version=2016-11-15: - get: - x-aws-operation-name: DescribeCapacityReservationFleets - operationId: GET_DescribeCapacityReservationFleets - description: Describes one or more Capacity Reservation Fleets. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeCapacityReservationFleetsResult' - parameters: - - name: CapacityReservationFleetId - in: query - required: false - description: The IDs of the Capacity Reservation Fleets to describe. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/CapacityReservationFleetId' - - xml: - name: item - - name: NextToken - in: query - required: false - description: The token to use to retrieve the next page of results. - schema: - type: string - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.' - schema: - type: integer - minimum: 1 - maximum: 100 - - name: Filter - in: query - required: false - description:

One or more filters.

  • state - The state of the Fleet (submitted | modifying | active | partially_fulfilled | expiring | expired | cancelling | cancelled | failed).

  • instance-match-criteria - The instance matching criteria for the Fleet. Only open is supported.

  • tenancy - The tenancy of the Fleet (default | dedicated).

  • allocation-strategy - The allocation strategy used by the Fleet. Only prioritized is supported.

- schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeCapacityReservationFleets - operationId: POST_DescribeCapacityReservationFleets - description: Describes one or more Capacity Reservation Fleets. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeCapacityReservationFleetsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeCapacityReservationFleetsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeCapacityReservations&Version=2016-11-15: - get: - x-aws-operation-name: DescribeCapacityReservations - operationId: GET_DescribeCapacityReservations - description: Describes one or more of your Capacity Reservations. The results describe only the Capacity Reservations in the Amazon Web Services Region that you're currently using. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeCapacityReservationsResult' - parameters: - - name: CapacityReservationId - in: query - required: false - description: The ID of the Capacity Reservation. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/CapacityReservationId' - - xml: - name: item - - name: NextToken - in: query - required: false - description: The token to use to retrieve the next page of results. - schema: - type: string - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.' - schema: - type: integer - minimum: 1 - maximum: 1000 - - name: Filter - in: query - required: false - description: '

One or more filters.

  • instance-type - The type of instance for which the Capacity Reservation reserves capacity.

  • owner-id - The ID of the Amazon Web Services account that owns the Capacity Reservation.

  • instance-platform - The type of operating system for which the Capacity Reservation reserves capacity.

  • availability-zone - The Availability Zone of the Capacity Reservation.

  • tenancy - Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:

    • default - The Capacity Reservation is created on hardware that is shared with other Amazon Web Services accounts.

    • dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.

  • outpost-arn - The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation was created.

  • state - The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:

    • active- The Capacity Reservation is active and the capacity is available for your use.

    • expired - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.

    • cancelled - The Capacity Reservation was cancelled. The reserved capacity is no longer available for your use.

    • pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.

    • failed - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.

  • start-date - The date and time at which the Capacity Reservation was started.

  • end-date - The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation''s state changes to expired when it reaches its end date and time.

  • end-date-type - Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:

    • unlimited - The Capacity Reservation remains active until you explicitly cancel it.

    • limited - The Capacity Reservation expires automatically at a specified date and time.

  • instance-match-criteria - Indicates the type of instance launches that the Capacity Reservation accepts. The options include:

    • open - The Capacity Reservation accepts all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes launch into the Capacity Reservation automatically without specifying any additional parameters.

    • targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.

  • placement-group-arn - The ARN of the cluster placement group in which the Capacity Reservation was created.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeCapacityReservations - operationId: POST_DescribeCapacityReservations - description: Describes one or more of your Capacity Reservations. The results describe only the Capacity Reservations in the Amazon Web Services Region that you're currently using. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeCapacityReservationsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeCapacityReservationsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeCarrierGateways&Version=2016-11-15: - get: - x-aws-operation-name: DescribeCarrierGateways - operationId: GET_DescribeCarrierGateways - description: Describes one or more of your carrier gateways. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeCarrierGatewaysResult' - parameters: - - name: CarrierGatewayId - in: query - required: false - description: One or more carrier gateway IDs. - schema: - type: array - items: - $ref: '#/components/schemas/CarrierGatewayId' - - name: Filter - in: query - required: false - description: '

One or more filters.

  • carrier-gateway-id - The ID of the carrier gateway.

  • state - The state of the carrier gateway (pending | failed | available | deleting | deleted).

  • owner-id - The Amazon Web Services account ID of the owner of the carrier gateway.

  • tag:<key> - 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. 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.

  • 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.

  • vpc-id - The ID of the VPC associated with the carrier gateway.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - schema: - type: integer - minimum: 5 - maximum: 1000 - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeCarrierGateways - operationId: POST_DescribeCarrierGateways - description: Describes one or more of your carrier gateways. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeCarrierGatewaysResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeCarrierGatewaysRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeClassicLinkInstances&Version=2016-11-15: - get: - x-aws-operation-name: DescribeClassicLinkInstances - operationId: GET_DescribeClassicLinkInstances - description: Describes one or more of your linked EC2-Classic instances. This request only returns information about EC2-Classic instances linked to a VPC through ClassicLink. You cannot use this request to return information about other instances. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeClassicLinkInstancesResult' - parameters: - - name: Filter - in: query - required: false - description: '

One or more filters.

  • group-id - The ID of a VPC security group that''s associated with the instance.

  • instance-id - The ID of the instance.

  • tag:<key> - 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. 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.

  • 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.

  • vpc-id - The ID of the VPC to which the instance is linked.

    vpc-id - The ID of the VPC that the instance is linked to.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: InstanceId - in: query - required: false - description: One or more instance IDs. Must be instances linked to a VPC through ClassicLink. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/InstanceId' - - xml: - name: InstanceId - - name: MaxResults - in: query - required: false - description: '

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

Constraint: If the value is greater than 1000, we return only 1000 items.

' - schema: - type: integer - minimum: 5 - maximum: 1000 - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeClassicLinkInstances - operationId: POST_DescribeClassicLinkInstances - description: Describes one or more of your linked EC2-Classic instances. This request only returns information about EC2-Classic instances linked to a VPC through ClassicLink. You cannot use this request to return information about other instances. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeClassicLinkInstancesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeClassicLinkInstancesRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeClientVpnAuthorizationRules&Version=2016-11-15: - get: - x-aws-operation-name: DescribeClientVpnAuthorizationRules - operationId: GET_DescribeClientVpnAuthorizationRules - description: Describes the authorization rules for a specified Client VPN endpoint. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeClientVpnAuthorizationRulesResult' - parameters: - - name: ClientVpnEndpointId - in: query - required: true - description: The ID of the Client VPN endpoint. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: NextToken - in: query - required: false - description: The token to retrieve the next page of results. - schema: - type: string - - name: Filter - in: query - required: false - description:

One or more filters. Filter names and values are case-sensitive.

  • description - The description of the authorization rule.

  • destination-cidr - The CIDR of the network to which the authorization rule applies.

  • group-id - The ID of the Active Directory group to which the authorization rule grants access.

- schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: MaxResults - in: query - required: false - description: The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value. - schema: - type: integer - minimum: 5 - maximum: 1000 - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeClientVpnAuthorizationRules - operationId: POST_DescribeClientVpnAuthorizationRules - description: Describes the authorization rules for a specified Client VPN endpoint. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeClientVpnAuthorizationRulesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeClientVpnAuthorizationRulesRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeClientVpnConnections&Version=2016-11-15: - get: - x-aws-operation-name: DescribeClientVpnConnections - operationId: GET_DescribeClientVpnConnections - description: Describes active client connections and connections that have been terminated within the last 60 minutes for the specified Client VPN endpoint. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeClientVpnConnectionsResult' - parameters: - - name: ClientVpnEndpointId - in: query - required: true - description: The ID of the Client VPN endpoint. - schema: - type: string - - name: Filter - in: query - required: false - description: '

One or more filters. Filter names and values are case-sensitive.

  • connection-id - The ID of the connection.

  • username - For Active Directory client authentication, the user name of the client who established the client connection.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: NextToken - in: query - required: false - description: The token to retrieve the next page of results. - schema: - type: string - - name: MaxResults - in: query - required: false - description: The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value. - schema: - type: integer - minimum: 5 - maximum: 1000 - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeClientVpnConnections - operationId: POST_DescribeClientVpnConnections - description: Describes active client connections and connections that have been terminated within the last 60 minutes for the specified Client VPN endpoint. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeClientVpnConnectionsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeClientVpnConnectionsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeClientVpnEndpoints&Version=2016-11-15: - get: - x-aws-operation-name: DescribeClientVpnEndpoints - operationId: GET_DescribeClientVpnEndpoints - description: Describes one or more Client VPN endpoints in the account. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeClientVpnEndpointsResult' - parameters: - - name: ClientVpnEndpointId - in: query - required: false - description: The ID of the Client VPN endpoint. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/ClientVpnEndpointId' - - xml: - name: item - - name: MaxResults - in: query - required: false - description: The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value. - schema: - type: integer - minimum: 5 - maximum: 1000 - - name: NextToken - in: query - required: false - description: The token to retrieve the next page of results. - schema: - type: string - - name: Filter - in: query - required: false - description:

One or more filters. Filter names and values are case-sensitive.

  • endpoint-id - The ID of the Client VPN endpoint.

  • transport-protocol - The transport protocol (tcp | udp).

- schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeClientVpnEndpoints - operationId: POST_DescribeClientVpnEndpoints - description: Describes one or more Client VPN endpoints in the account. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeClientVpnEndpointsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeClientVpnEndpointsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeClientVpnRoutes&Version=2016-11-15: - get: - x-aws-operation-name: DescribeClientVpnRoutes - operationId: GET_DescribeClientVpnRoutes - description: Describes the routes for the specified Client VPN endpoint. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeClientVpnRoutesResult' - parameters: - - name: ClientVpnEndpointId - in: query - required: true - description: The ID of the Client VPN endpoint. - schema: - type: string - - name: Filter - in: query - required: false - description:

One or more filters. Filter names and values are case-sensitive.

  • destination-cidr - The CIDR of the route destination.

  • origin - How the route was associated with the Client VPN endpoint (associate | add-route).

  • target-subnet - The ID of the subnet through which traffic is routed.

- schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: MaxResults - in: query - required: false - description: The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value. - schema: - type: integer - minimum: 5 - maximum: 1000 - - name: NextToken - in: query - required: false - description: The token to retrieve the next page of results. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeClientVpnRoutes - operationId: POST_DescribeClientVpnRoutes - description: Describes the routes for the specified Client VPN endpoint. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeClientVpnRoutesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeClientVpnRoutesRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeClientVpnTargetNetworks&Version=2016-11-15: - get: - x-aws-operation-name: DescribeClientVpnTargetNetworks - operationId: GET_DescribeClientVpnTargetNetworks - description: Describes the target networks associated with the specified Client VPN endpoint. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeClientVpnTargetNetworksResult' - parameters: - - name: ClientVpnEndpointId - in: query - required: true - description: The ID of the Client VPN endpoint. - schema: - type: string - - name: AssociationIds - in: query - required: false - description: The IDs of the target network associations. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - - name: MaxResults - in: query - required: false - description: The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value. - schema: - type: integer - minimum: 5 - maximum: 1000 - - name: NextToken - in: query - required: false - description: The token to retrieve the next page of results. - schema: - type: string - - name: Filter - in: query - required: false - description:

One or more filters. Filter names and values are case-sensitive.

  • association-id - The ID of the association.

  • target-network-id - The ID of the subnet specified as the target network.

  • vpc-id - The ID of the VPC in which the target network is located.

- schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeClientVpnTargetNetworks - operationId: POST_DescribeClientVpnTargetNetworks - description: Describes the target networks associated with the specified Client VPN endpoint. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeClientVpnTargetNetworksResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeClientVpnTargetNetworksRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeCoipPools&Version=2016-11-15: - get: - x-aws-operation-name: DescribeCoipPools - operationId: GET_DescribeCoipPools - description: Describes the specified customer-owned address pools or all of your customer-owned address pools. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeCoipPoolsResult' - parameters: - - name: PoolId - in: query - required: false - description: The IDs of the address pools. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Ipv4PoolCoipId' - - xml: - name: item - - name: Filter - in: query - required: false - description:

One or more filters.

  • coip-pool.local-gateway-route-table-id - The ID of the local gateway route table.

  • coip-pool.pool-id - The ID of the address pool.

- schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - schema: - type: integer - minimum: 5 - maximum: 1000 - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeCoipPools - operationId: POST_DescribeCoipPools - description: Describes the specified customer-owned address pools or all of your customer-owned address pools. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeCoipPoolsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeCoipPoolsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeConversionTasks&Version=2016-11-15: - get: - x-aws-operation-name: DescribeConversionTasks - operationId: GET_DescribeConversionTasks - description: '

Describes the specified conversion tasks or all your conversion tasks. For more information, see the VM Import/Export User Guide.

For information about the import manifest referenced by this API action, see VM Import Manifest.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeConversionTasksResult' - parameters: - - name: ConversionTaskId - in: query - required: false - description: The conversion task IDs. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/ConversionTaskId' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeConversionTasks - operationId: POST_DescribeConversionTasks - description: '

Describes the specified conversion tasks or all your conversion tasks. For more information, see the VM Import/Export User Guide.

For information about the import manifest referenced by this API action, see VM Import Manifest.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeConversionTasksResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeConversionTasksRequest' - parameters: [] - /?Action=DescribeCustomerGateways&Version=2016-11-15: - get: - x-aws-operation-name: DescribeCustomerGateways - operationId: GET_DescribeCustomerGateways - description: '

Describes one or more of your VPN customer gateways.

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeCustomerGatewaysResult' - parameters: - - name: CustomerGatewayId - in: query - required: false - description: '

One or more customer gateway IDs.

Default: Describes all your customer gateways.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/CustomerGatewayId' - - xml: - name: CustomerGatewayId - - name: Filter - in: query - required: false - description: '

One or more filters.

  • bgp-asn - The customer gateway''s Border Gateway Protocol (BGP) Autonomous System Number (ASN).

  • customer-gateway-id - The ID of the customer gateway.

  • ip-address - The IP address of the customer gateway''s Internet-routable external interface.

  • state - The state of the customer gateway (pending | available | deleting | deleted).

  • type - The type of customer gateway. Currently, the only supported type is ipsec.1.

  • tag:<key> - 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. 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.

  • 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.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeCustomerGateways - operationId: POST_DescribeCustomerGateways - description: '

Describes one or more of your VPN customer gateways.

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeCustomerGatewaysResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeCustomerGatewaysRequest' - parameters: [] - /?Action=DescribeDhcpOptions&Version=2016-11-15: - get: - x-aws-operation-name: DescribeDhcpOptions - operationId: GET_DescribeDhcpOptions - description: '

Describes one or more of your DHCP options sets.

For more information, see DHCP options sets in the Amazon Virtual Private Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeDhcpOptionsResult' - parameters: - - name: DhcpOptionsId - in: query - required: false - description: '

The IDs of one or more DHCP options sets.

Default: Describes all your DHCP options sets.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/DhcpOptionsId' - - xml: - name: DhcpOptionsId - - name: Filter - in: query - required: false - description: '

One or more filters.

  • dhcp-options-id - The ID of a DHCP options set.

  • key - The key for one of the options (for example, domain-name).

  • value - The value for one of the options.

  • owner-id - The ID of the Amazon Web Services account that owns the DHCP options set.

  • tag:<key> - 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. 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.

  • 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.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - schema: - type: integer - minimum: 5 - maximum: 1000 - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeDhcpOptions - operationId: POST_DescribeDhcpOptions - description: '

Describes one or more of your DHCP options sets.

For more information, see DHCP options sets in the Amazon Virtual Private Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeDhcpOptionsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeDhcpOptionsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeEgressOnlyInternetGateways&Version=2016-11-15: - get: - x-aws-operation-name: DescribeEgressOnlyInternetGateways - operationId: GET_DescribeEgressOnlyInternetGateways - description: Describes one or more of your egress-only internet gateways. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeEgressOnlyInternetGatewaysResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: EgressOnlyInternetGatewayId - in: query - required: false - description: One or more egress-only internet gateway IDs. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/EgressOnlyInternetGatewayId' - - xml: - name: item - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - schema: - type: integer - minimum: 5 - maximum: 255 - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - - name: Filter - in: query - required: false - description: '

One or more filters.

  • tag:<key> - 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. 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.

  • 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.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeEgressOnlyInternetGateways - operationId: POST_DescribeEgressOnlyInternetGateways - description: Describes one or more of your egress-only internet gateways. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeEgressOnlyInternetGatewaysResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeEgressOnlyInternetGatewaysRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeElasticGpus&Version=2016-11-15: - get: - x-aws-operation-name: DescribeElasticGpus - operationId: GET_DescribeElasticGpus - description: 'Describes the Elastic Graphics accelerator associated with your instances. For more information about Elastic Graphics, see Amazon Elastic Graphics.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeElasticGpusResult' - parameters: - - name: ElasticGpuId - in: query - required: false - description: The Elastic Graphics accelerator IDs. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/ElasticGpuId' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: Filter - in: query - required: false - description: '

The filters.

  • availability-zone - The Availability Zone in which the Elastic Graphics accelerator resides.

  • elastic-gpu-health - The status of the Elastic Graphics accelerator (OK | IMPAIRED).

  • elastic-gpu-state - The state of the Elastic Graphics accelerator (ATTACHED).

  • elastic-gpu-type - The type of Elastic Graphics accelerator; for example, eg1.medium.

  • instance-id - The ID of the instance to which the Elastic Graphics accelerator is associated.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000.' - schema: - type: integer - minimum: 10 - maximum: 1000 - - name: NextToken - in: query - required: false - description: The token to request the next page of results. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeElasticGpus - operationId: POST_DescribeElasticGpus - description: 'Describes the Elastic Graphics accelerator associated with your instances. For more information about Elastic Graphics, see Amazon Elastic Graphics.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeElasticGpusResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeElasticGpusRequest' - parameters: [] - /?Action=DescribeExportImageTasks&Version=2016-11-15: - get: - x-aws-operation-name: DescribeExportImageTasks - operationId: GET_DescribeExportImageTasks - description: Describes the specified export image tasks or all of your export image tasks. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeExportImageTasksResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: Filter - in: query - required: false - description: 'Filter tasks using the task-state filter and one of the following values: active, completed, deleting, or deleted.' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: ExportImageTaskId - in: query - required: false - description: The IDs of the export image tasks. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/ExportImageTaskId' - - xml: - name: ExportImageTaskId - - name: MaxResults - in: query - required: false - description: The maximum number of results to return in a single call. - schema: - type: integer - minimum: 1 - maximum: 500 - - name: NextToken - in: query - required: false - description: A token that indicates the next page of results. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeExportImageTasks - operationId: POST_DescribeExportImageTasks - description: Describes the specified export image tasks or all of your export image tasks. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeExportImageTasksResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeExportImageTasksRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeExportTasks&Version=2016-11-15: - get: - x-aws-operation-name: DescribeExportTasks - operationId: GET_DescribeExportTasks - description: Describes the specified export instance tasks or all of your export instance tasks. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeExportTasksResult' - parameters: - - name: ExportTaskId - in: query - required: false - description: The export task IDs. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/ExportTaskId' - - xml: - name: ExportTaskId - - name: Filter - in: query - required: false - description: the filters for the export tasks. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeExportTasks - operationId: POST_DescribeExportTasks - description: Describes the specified export instance tasks or all of your export instance tasks. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeExportTasksResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeExportTasksRequest' - parameters: [] - /?Action=DescribeFastLaunchImages&Version=2016-11-15: - get: - x-aws-operation-name: DescribeFastLaunchImages - operationId: GET_DescribeFastLaunchImages - description: Describe details for Windows AMIs that are configured for faster launching. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeFastLaunchImagesResult' - parameters: - - name: ImageId - in: query - required: false - description: Details for one or more Windows AMI image IDs. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/ImageId' - - xml: - name: ImageId - - name: Filter - in: query - required: false - description:

Use the following filters to streamline results.

  • resource-type - The resource type for pre-provisioning.

  • launch-template - The launch template that is associated with the pre-provisioned Windows AMI.

  • owner-id - The owner ID for the pre-provisioning resource.

  • state - The current state of fast launching for the Windows AMI.

- schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return in a single call. To retrieve the remaining results, make another request with the returned NextToken value. If this parameter is not specified, then all results are returned.' - schema: - type: integer - minimum: 0 - maximum: 200 - - name: NextToken - in: query - required: false - description: The token for the next set of results. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeFastLaunchImages - operationId: POST_DescribeFastLaunchImages - description: Describe details for Windows AMIs that are configured for faster launching. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeFastLaunchImagesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeFastLaunchImagesRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeFastSnapshotRestores&Version=2016-11-15: - get: - x-aws-operation-name: DescribeFastSnapshotRestores - operationId: GET_DescribeFastSnapshotRestores - description: Describes the state of fast snapshot restores for your snapshots. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeFastSnapshotRestoresResult' - parameters: - - name: Filter - in: query - required: false - description: '

The filters. The possible values are:

  • availability-zone: The Availability Zone of the snapshot.

  • owner-id: The ID of the Amazon Web Services account that enabled fast snapshot restore on the snapshot.

  • snapshot-id: The ID of the snapshot.

  • state: The state of fast snapshot restores for the snapshot (enabling | optimizing | enabled | disabling | disabled).

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - schema: - type: integer - minimum: 0 - maximum: 200 - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeFastSnapshotRestores - operationId: POST_DescribeFastSnapshotRestores - description: Describes the state of fast snapshot restores for your snapshots. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeFastSnapshotRestoresResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeFastSnapshotRestoresRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeFleetHistory&Version=2016-11-15: - get: - x-aws-operation-name: DescribeFleetHistory - operationId: GET_DescribeFleetHistory - description: '

Describes the events for the specified EC2 Fleet during the specified time.

EC2 Fleet events are delayed by up to 30 seconds before they can be described. This ensures that you can query by the last evaluated time and not miss a recorded event. EC2 Fleet events are available for 48 hours.

For more information, see Monitor fleet events using Amazon EventBridge in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeFleetHistoryResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: EventType - in: query - required: false - description: 'The type of events to describe. By default, all events are described.' - schema: - type: string - enum: - - instance-change - - fleet-change - - service-error - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.' - schema: - type: integer - - name: NextToken - in: query - required: false - description: The token for the next set of results. - schema: - type: string - - name: FleetId - in: query - required: true - description: The ID of the EC2 Fleet. - schema: - type: string - - name: StartTime - in: query - required: true - description: 'The start date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).' - schema: - type: string - format: date-time - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeFleetHistory - operationId: POST_DescribeFleetHistory - description: '

Describes the events for the specified EC2 Fleet during the specified time.

EC2 Fleet events are delayed by up to 30 seconds before they can be described. This ensures that you can query by the last evaluated time and not miss a recorded event. EC2 Fleet events are available for 48 hours.

For more information, see Monitor fleet events using Amazon EventBridge in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeFleetHistoryResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeFleetHistoryRequest' - parameters: [] - /?Action=DescribeFleetInstances&Version=2016-11-15: - get: - x-aws-operation-name: DescribeFleetInstances - operationId: GET_DescribeFleetInstances - description: '

Describes the running instances for the specified EC2 Fleet.

For more information, see Monitor your EC2 Fleet in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeFleetInstancesResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.' - schema: - type: integer - - name: NextToken - in: query - required: false - description: The token for the next set of results. - schema: - type: string - - name: FleetId - in: query - required: true - description: The ID of the EC2 Fleet. - schema: - type: string - - name: Filter - in: query - required: false - description:

The filters.

  • instance-type - The instance type.

- schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeFleetInstances - operationId: POST_DescribeFleetInstances - description: '

Describes the running instances for the specified EC2 Fleet.

For more information, see Monitor your EC2 Fleet in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeFleetInstancesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeFleetInstancesRequest' - parameters: [] - /?Action=DescribeFleets&Version=2016-11-15: - get: - x-aws-operation-name: DescribeFleets - operationId: GET_DescribeFleets - description: '

Describes the specified EC2 Fleets or all of your EC2 Fleets.

For more information, see Monitor your EC2 Fleet in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeFleetsResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.' - schema: - type: integer - - name: NextToken - in: query - required: false - description: The token for the next set of results. - schema: - type: string - - name: FleetId - in: query - required: false - description: '

The IDs of the EC2 Fleets.

If a fleet is of type instant, you must specify the fleet ID, otherwise it does not appear in the response.

' - schema: - type: array - items: - $ref: '#/components/schemas/FleetId' - - name: Filter - in: query - required: false - description:

The filters.

  • activity-status - The progress of the EC2 Fleet ( error | pending-fulfillment | pending-termination | fulfilled).

  • excess-capacity-termination-policy - Indicates whether to terminate running instances if the target capacity is decreased below the current EC2 Fleet size (true | false).

  • fleet-state - The state of the EC2 Fleet (submitted | active | deleted | failed | deleted-running | deleted-terminating | modifying).

  • replace-unhealthy-instances - Indicates whether EC2 Fleet should replace unhealthy instances (true | false).

  • type - The type of request (instant | request | maintain).

- schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeFleets - operationId: POST_DescribeFleets - description: '

Describes the specified EC2 Fleets or all of your EC2 Fleets.

For more information, see Monitor your EC2 Fleet in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeFleetsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeFleetsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeFlowLogs&Version=2016-11-15: - get: - x-aws-operation-name: DescribeFlowLogs - operationId: GET_DescribeFlowLogs - description: 'Describes one or more flow logs. To view the information in your flow logs (the log streams for the network interfaces), you must use the CloudWatch Logs console or the CloudWatch Logs API.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeFlowLogsResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: Filter - in: query - required: false - description: '

One or more filters.

  • deliver-log-status - The status of the logs delivery (SUCCESS | FAILED).

  • log-destination-type - The type of destination to which the flow log publishes data. Possible destination types include cloud-watch-logs and s3.

  • flow-log-id - The ID of the flow log.

  • log-group-name - The name of the log group.

  • resource-id - The ID of the VPC, subnet, or network interface.

  • traffic-type - The type of traffic (ACCEPT | REJECT | ALL).

  • tag:<key> - 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. 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.

  • 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.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: FlowLogId - in: query - required: false - description: '

One or more flow log IDs.

Constraint: Maximum of 1000 flow log IDs.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/VpcFlowLogId' - - xml: - name: item - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - schema: - type: integer - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeFlowLogs - operationId: POST_DescribeFlowLogs - description: 'Describes one or more flow logs. To view the information in your flow logs (the log streams for the network interfaces), you must use the CloudWatch Logs console or the CloudWatch Logs API.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeFlowLogsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeFlowLogsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeFpgaImageAttribute&Version=2016-11-15: - get: - x-aws-operation-name: DescribeFpgaImageAttribute - operationId: GET_DescribeFpgaImageAttribute - description: Describes the specified attribute of the specified Amazon FPGA Image (AFI). - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeFpgaImageAttributeResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: FpgaImageId - in: query - required: true - description: The ID of the AFI. - schema: - type: string - - name: Attribute - in: query - required: true - description: The AFI attribute. - schema: - type: string - enum: - - description - - name - - loadPermission - - productCodes - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeFpgaImageAttribute - operationId: POST_DescribeFpgaImageAttribute - description: Describes the specified attribute of the specified Amazon FPGA Image (AFI). - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeFpgaImageAttributeResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeFpgaImageAttributeRequest' - parameters: [] - /?Action=DescribeFpgaImages&Version=2016-11-15: - get: - x-aws-operation-name: DescribeFpgaImages - operationId: GET_DescribeFpgaImages - description: 'Describes the Amazon FPGA Images (AFIs) available to you. These include public AFIs, private AFIs that you own, and AFIs owned by other Amazon Web Services accounts for which you have load permissions.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeFpgaImagesResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: FpgaImageId - in: query - required: false - description: The AFI IDs. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/FpgaImageId' - - xml: - name: item - - name: Owner - in: query - required: false - description: 'Filters the AFI by owner. Specify an Amazon Web Services account ID, self (owner is the sender of the request), or an Amazon Web Services owner alias (valid values are amazon | aws-marketplace).' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: Owner - - name: Filter - in: query - required: false - description: '

The filters.

  • create-time - The creation time of the AFI.

  • fpga-image-id - The FPGA image identifier (AFI ID).

  • fpga-image-global-id - The global FPGA image identifier (AGFI ID).

  • name - The name of the AFI.

  • owner-id - The Amazon Web Services account ID of the AFI owner.

  • product-code - The product code.

  • shell-version - The version of the Amazon Web Services Shell that was used to create the bitstream.

  • state - The state of the AFI (pending | failed | available | unavailable).

  • tag:<key> - 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. 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.

  • 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.

  • update-time - The time of the most recent update.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: NextToken - in: query - required: false - description: The token to retrieve the next page of results. - schema: - type: string - - name: MaxResults - in: query - required: false - description: The maximum number of results to return in a single call. - schema: - type: integer - minimum: 5 - maximum: 1000 - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeFpgaImages - operationId: POST_DescribeFpgaImages - description: 'Describes the Amazon FPGA Images (AFIs) available to you. These include public AFIs, private AFIs that you own, and AFIs owned by other Amazon Web Services accounts for which you have load permissions.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeFpgaImagesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeFpgaImagesRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeHostReservationOfferings&Version=2016-11-15: - get: - x-aws-operation-name: DescribeHostReservationOfferings - operationId: GET_DescribeHostReservationOfferings - description: '

Describes the Dedicated Host reservations that are available to purchase.

The results describe all of the Dedicated Host reservation offerings, including offerings that might not match the instance family and Region of your Dedicated Hosts. When purchasing an offering, ensure that the instance family and Region of the offering matches that of the Dedicated Hosts with which it is to be associated. For more information about supported instance types, see Dedicated Hosts in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeHostReservationOfferingsResult' - parameters: - - name: Filter - in: query - required: false - description: '

The filters.

  • instance-family - The instance family of the offering (for example, m4).

  • payment-option - The payment option (NoUpfront | PartialUpfront | AllUpfront).

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: MaxDuration - in: query - required: false - description: 'This is the maximum duration of the reservation to purchase, specified in seconds. Reservations are available in one-year and three-year terms. The number of seconds specified must be the number of seconds in a year (365x24x60x60) times one of the supported durations (1 or 3). For example, specify 94608000 for three years.' - schema: - type: integer - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.' - schema: - type: integer - minimum: 5 - maximum: 500 - - name: MinDuration - in: query - required: false - description: 'This is the minimum duration of the reservation you''d like to purchase, specified in seconds. Reservations are available in one-year and three-year terms. The number of seconds specified must be the number of seconds in a year (365x24x60x60) times one of the supported durations (1 or 3). For example, specify 31536000 for one year.' - schema: - type: integer - - name: NextToken - in: query - required: false - description: The token to use to retrieve the next page of results. - schema: - type: string - - name: OfferingId - in: query - required: false - description: The ID of the reservation offering. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeHostReservationOfferings - operationId: POST_DescribeHostReservationOfferings - description: '

Describes the Dedicated Host reservations that are available to purchase.

The results describe all of the Dedicated Host reservation offerings, including offerings that might not match the instance family and Region of your Dedicated Hosts. When purchasing an offering, ensure that the instance family and Region of the offering matches that of the Dedicated Hosts with which it is to be associated. For more information about supported instance types, see Dedicated Hosts in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeHostReservationOfferingsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeHostReservationOfferingsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeHostReservations&Version=2016-11-15: - get: - x-aws-operation-name: DescribeHostReservations - operationId: GET_DescribeHostReservations - description: Describes reservations that are associated with Dedicated Hosts in your account. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeHostReservationsResult' - parameters: - - name: Filter - in: query - required: false - description: '

The filters.

  • instance-family - The instance family (for example, m4).

  • payment-option - The payment option (NoUpfront | PartialUpfront | AllUpfront).

  • state - The state of the reservation (payment-pending | payment-failed | active | retired).

  • tag:<key> - 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. 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.

  • 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.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: HostReservationIdSet - in: query - required: false - description: The host reservation IDs. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/HostReservationId' - - xml: - name: item - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.' - schema: - type: integer - - name: NextToken - in: query - required: false - description: The token to use to retrieve the next page of results. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeHostReservations - operationId: POST_DescribeHostReservations - description: Describes reservations that are associated with Dedicated Hosts in your account. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeHostReservationsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeHostReservationsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeHosts&Version=2016-11-15: - get: - x-aws-operation-name: DescribeHosts - operationId: GET_DescribeHosts - description:

Describes the specified Dedicated Hosts or all your Dedicated Hosts.

The results describe only the Dedicated Hosts in the Region you're currently using. All listed instances consume capacity on your Dedicated Host. Dedicated Hosts that have recently been released are listed with the state released.

- responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeHostsResult' - parameters: - - name: Filter - in: query - required: false - description: '

The filters.

  • auto-placement - Whether auto-placement is enabled or disabled (on | off).

  • availability-zone - The Availability Zone of the host.

  • client-token - The idempotency token that you provided when you allocated the host.

  • host-reservation-id - The ID of the reservation assigned to this host.

  • instance-type - The instance type size that the Dedicated Host is configured to support.

  • state - The allocation state of the Dedicated Host (available | under-assessment | permanent-failure | released | released-permanent-failure).

  • 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.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: HostId - in: query - required: false - description: The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/DedicatedHostId' - - xml: - name: item - - name: MaxResults - in: query - required: false - description: '

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.

You cannot specify this parameter and the host IDs parameter in the same request.

' - schema: - type: integer - - name: NextToken - in: query - required: false - description: The token to use to retrieve the next page of results. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeHosts - operationId: POST_DescribeHosts - description:

Describes the specified Dedicated Hosts or all your Dedicated Hosts.

The results describe only the Dedicated Hosts in the Region you're currently using. All listed instances consume capacity on your Dedicated Host. Dedicated Hosts that have recently been released are listed with the state released.

- responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeHostsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeHostsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeIamInstanceProfileAssociations&Version=2016-11-15: - get: - x-aws-operation-name: DescribeIamInstanceProfileAssociations - operationId: GET_DescribeIamInstanceProfileAssociations - description: Describes your IAM instance profile associations. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeIamInstanceProfileAssociationsResult' - parameters: - - name: AssociationId - in: query - required: false - description: The IAM instance profile associations. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/IamInstanceProfileAssociationId' - - xml: - name: AssociationId - - name: Filter - in: query - required: false - description:

The filters.

  • instance-id - The ID of the instance.

  • state - The state of the association (associating | associated | disassociating).

- schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.' - schema: - type: integer - minimum: 5 - maximum: 1000 - - name: NextToken - in: query - required: false - description: The token to request the next page of results. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeIamInstanceProfileAssociations - operationId: POST_DescribeIamInstanceProfileAssociations - description: Describes your IAM instance profile associations. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeIamInstanceProfileAssociationsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeIamInstanceProfileAssociationsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeIdFormat&Version=2016-11-15: - get: - x-aws-operation-name: DescribeIdFormat - operationId: GET_DescribeIdFormat - description: '

Describes the ID format settings for your resources on a per-Region basis, for example, to view which resource types are enabled for longer IDs. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types.

The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.

These settings apply to the IAM user who makes the request; they do not apply to the entire Amazon Web Services account. By default, an IAM user defaults to the same settings as the root user, unless they explicitly override the settings by running the ModifyIdFormat command. Resources created with longer IDs are visible to all IAM users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeIdFormatResult' - parameters: - - name: Resource - in: query - required: false - description: 'The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway ' - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeIdFormat - operationId: POST_DescribeIdFormat - description: '

Describes the ID format settings for your resources on a per-Region basis, for example, to view which resource types are enabled for longer IDs. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types.

The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.

These settings apply to the IAM user who makes the request; they do not apply to the entire Amazon Web Services account. By default, an IAM user defaults to the same settings as the root user, unless they explicitly override the settings by running the ModifyIdFormat command. Resources created with longer IDs are visible to all IAM users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeIdFormatResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeIdFormatRequest' - parameters: [] - /?Action=DescribeIdentityIdFormat&Version=2016-11-15: - get: - x-aws-operation-name: DescribeIdentityIdFormat - operationId: GET_DescribeIdentityIdFormat - description: '

Describes the ID format settings for resources for the specified IAM user, IAM role, or root user. For example, you can view the resource types that are enabled for longer IDs. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types. For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.

The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.

These settings apply to the principal specified in the request. They do not apply to the principal that makes the request.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeIdentityIdFormatResult' - parameters: - - name: PrincipalArn - in: query - required: true - description: 'The ARN of the principal, which can be an IAM role, IAM user, or the root user.' - schema: - type: string - - name: Resource - in: query - required: false - description: 'The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway ' - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeIdentityIdFormat - operationId: POST_DescribeIdentityIdFormat - description: '

Describes the ID format settings for resources for the specified IAM user, IAM role, or root user. For example, you can view the resource types that are enabled for longer IDs. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types. For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.

The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.

These settings apply to the principal specified in the request. They do not apply to the principal that makes the request.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeIdentityIdFormatResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeIdentityIdFormatRequest' - parameters: [] - /?Action=DescribeImageAttribute&Version=2016-11-15: - get: - x-aws-operation-name: DescribeImageAttribute - operationId: GET_DescribeImageAttribute - description: Describes the specified attribute of the specified AMI. You can specify only one attribute at a time. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ImageAttribute' - parameters: - - name: Attribute - in: query - required: true - description: '

The AMI attribute.

Note: The blockDeviceMapping attribute is deprecated. Using this attribute returns the Client.AuthFailure error. To get information about the block device mappings for an AMI, use the DescribeImages action.

' - schema: - type: string - enum: - - description - - kernel - - ramdisk - - launchPermission - - productCodes - - blockDeviceMapping - - sriovNetSupport - - bootMode - - tpmSupport - - uefiData - - lastLaunchedTime - - name: ImageId - in: query - required: true - description: The ID of the AMI. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeImageAttribute - operationId: POST_DescribeImageAttribute - description: Describes the specified attribute of the specified AMI. You can specify only one attribute at a time. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ImageAttribute' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeImageAttributeRequest' - parameters: [] - /?Action=DescribeImages&Version=2016-11-15: - get: - x-aws-operation-name: DescribeImages - operationId: GET_DescribeImages - description: '

Describes the specified images (AMIs, AKIs, and ARIs) available to you or all of the images available to you.

The images available to you include public images, private images that you own, and private images owned by other Amazon Web Services accounts for which you have explicit launch permissions.

Recently deregistered images appear in the returned results for a short interval and then return empty results. After all instances that reference a deregistered AMI are terminated, specifying the ID of the image will eventually return an error indicating that the AMI ID cannot be found.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeImagesResult' - parameters: - - name: ExecutableBy - in: query - required: false - description: '

Scopes the images by users with explicit launch permissions. Specify an Amazon Web Services account ID, self (the sender of the request), or all (public AMIs).

  • If you specify an Amazon Web Services account ID that is not your own, only AMIs shared with that specific Amazon Web Services account ID are returned. However, AMIs that are shared with the account’s organization or organizational unit (OU) are not returned.

  • If you specify self or your own Amazon Web Services account ID, AMIs shared with your account are returned. In addition, AMIs that are shared with the organization or OU of which you are member are also returned.

  • If you specify all, all public AMIs are returned.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: ExecutableBy - - name: Filter - in: query - required: false - description: '

The filters.

  • architecture - The image architecture (i386 | x86_64 | arm64).

  • block-device-mapping.delete-on-termination - A Boolean value that indicates whether the Amazon EBS volume is deleted on instance termination.

  • block-device-mapping.device-name - The device name specified in the block device mapping (for example, /dev/sdh or xvdh).

  • block-device-mapping.snapshot-id - The ID of the snapshot used for the Amazon EBS volume.

  • block-device-mapping.volume-size - The volume size of the Amazon EBS volume, in GiB.

  • block-device-mapping.volume-type - The volume type of the Amazon EBS volume (io1 | io2 | gp2 | gp3 | sc1 | st1 | standard).

  • block-device-mapping.encrypted - A Boolean that indicates whether the Amazon EBS volume is encrypted.

  • creation-date - The time when the image was created, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, 2021-09-29T11:04:43.305Z. You can use a wildcard (*), for example, 2021-09-29T*, which matches an entire day.

  • description - The description of the image (provided during image creation).

  • ena-support - A Boolean that indicates whether enhanced networking with ENA is enabled.

  • hypervisor - The hypervisor type (ovm | xen).

  • image-id - The ID of the image.

  • image-type - The image type (machine | kernel | ramdisk).

  • is-public - A Boolean that indicates whether the image is public.

  • kernel-id - The kernel ID.

  • manifest-location - The location of the image manifest.

  • name - The name of the AMI (provided during image creation).

  • owner-alias - The owner alias (amazon | aws-marketplace). The valid aliases are defined in an Amazon-maintained list. This is not the Amazon Web Services account alias that can be set using the IAM console. We recommend that you use the Owner request parameter instead of this filter.

  • owner-id - The Amazon Web Services account ID of the owner. We recommend that you use the Owner request parameter instead of this filter.

  • platform - The platform. To only list Windows-based AMIs, use windows.

  • product-code - The product code.

  • product-code.type - The type of the product code (marketplace).

  • ramdisk-id - The RAM disk ID.

  • root-device-name - The device name of the root device volume (for example, /dev/sda1).

  • root-device-type - The type of the root device volume (ebs | instance-store).

  • state - The state of the image (available | pending | failed).

  • state-reason-code - The reason code for the state change.

  • state-reason-message - The message for the state change.

  • sriov-net-support - A value of simple indicates that enhanced networking with the Intel 82599 VF interface is enabled.

  • tag:<key> - 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. 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.

  • 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.

  • virtualization-type - The virtualization type (paravirtual | hvm).

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: ImageId - in: query - required: false - description: '

The image IDs.

Default: Describes all images available to you.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/ImageId' - - xml: - name: ImageId - - name: Owner - in: query - required: false - description: 'Scopes the results to images with the specified owners. You can specify a combination of Amazon Web Services account IDs, self, amazon, and aws-marketplace. If you omit this parameter, the results include all images for which you have launch permissions, regardless of ownership.' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: Owner - - name: IncludeDeprecated - in: query - required: false - description: '

If true, all deprecated AMIs are included in the response. If false, no deprecated AMIs are included in the response. If no value is specified, the default value is false.

If you are the AMI owner, all deprecated AMIs appear in the response regardless of the value (true or false) that you set for this parameter.

' - schema: - type: boolean - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeImages - operationId: POST_DescribeImages - description: '

Describes the specified images (AMIs, AKIs, and ARIs) available to you or all of the images available to you.

The images available to you include public images, private images that you own, and private images owned by other Amazon Web Services accounts for which you have explicit launch permissions.

Recently deregistered images appear in the returned results for a short interval and then return empty results. After all instances that reference a deregistered AMI are terminated, specifying the ID of the image will eventually return an error indicating that the AMI ID cannot be found.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeImagesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeImagesRequest' - parameters: [] - /?Action=DescribeImportImageTasks&Version=2016-11-15: - get: - x-aws-operation-name: DescribeImportImageTasks - operationId: GET_DescribeImportImageTasks - description: Displays details about an import virtual machine or import snapshot tasks that are already created. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeImportImageTasksResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: Filters - in: query - required: false - description: 'Filter tasks using the task-state filter and one of the following values: active, completed, deleting, or deleted.' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: ImportTaskId - in: query - required: false - description: The IDs of the import image tasks. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/ImportImageTaskId' - - xml: - name: ImportTaskId - - name: MaxResults - in: query - required: false - description: The maximum number of results to return in a single call. - schema: - type: integer - - name: NextToken - in: query - required: false - description: A token that indicates the next page of results. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeImportImageTasks - operationId: POST_DescribeImportImageTasks - description: Displays details about an import virtual machine or import snapshot tasks that are already created. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeImportImageTasksResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeImportImageTasksRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeImportSnapshotTasks&Version=2016-11-15: - get: - x-aws-operation-name: DescribeImportSnapshotTasks - operationId: GET_DescribeImportSnapshotTasks - description: Describes your import snapshot tasks. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeImportSnapshotTasksResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: Filters - in: query - required: false - description: The filters. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: ImportTaskId - in: query - required: false - description: A list of import snapshot task IDs. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/ImportSnapshotTaskId' - - xml: - name: ImportTaskId - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.' - schema: - type: integer - - name: NextToken - in: query - required: false - description: A token that indicates the next page of results. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeImportSnapshotTasks - operationId: POST_DescribeImportSnapshotTasks - description: Describes your import snapshot tasks. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeImportSnapshotTasksResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeImportSnapshotTasksRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeInstanceAttribute&Version=2016-11-15: - get: - x-aws-operation-name: DescribeInstanceAttribute - operationId: GET_DescribeInstanceAttribute - description: 'Describes the specified attribute of the specified instance. You can specify only one attribute at a time. Valid attribute values are: instanceType | kernel | ramdisk | userData | disableApiTermination | instanceInitiatedShutdownBehavior | rootDeviceName | blockDeviceMapping | productCodes | sourceDestCheck | groupSet | ebsOptimized | sriovNetSupport ' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/InstanceAttribute' - parameters: - - name: Attribute - in: query - required: true - description: '

The instance attribute.

Note: The enaSupport attribute is not supported at this time.

' - schema: - type: string - enum: - - instanceType - - kernel - - ramdisk - - userData - - disableApiTermination - - instanceInitiatedShutdownBehavior - - rootDeviceName - - blockDeviceMapping - - productCodes - - sourceDestCheck - - groupSet - - ebsOptimized - - sriovNetSupport - - enaSupport - - enclaveOptions - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: InstanceId - in: query - required: true - description: The ID of the instance. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeInstanceAttribute - operationId: POST_DescribeInstanceAttribute - description: 'Describes the specified attribute of the specified instance. You can specify only one attribute at a time. Valid attribute values are: instanceType | kernel | ramdisk | userData | disableApiTermination | instanceInitiatedShutdownBehavior | rootDeviceName | blockDeviceMapping | productCodes | sourceDestCheck | groupSet | ebsOptimized | sriovNetSupport ' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/InstanceAttribute' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeInstanceAttributeRequest' - parameters: [] - /?Action=DescribeInstanceCreditSpecifications&Version=2016-11-15: - get: - x-aws-operation-name: DescribeInstanceCreditSpecifications - operationId: GET_DescribeInstanceCreditSpecifications - description: '

Describes the credit option for CPU usage of the specified burstable performance instances. The credit options are standard and unlimited.

If you do not specify an instance ID, Amazon EC2 returns burstable performance instances with the unlimited credit option, as well as instances that were previously configured as T2, T3, and T3a with the unlimited credit option. For example, if you resize a T2 instance, while it is configured as unlimited, to an M4 instance, Amazon EC2 returns the M4 instance.

If you specify one or more instance IDs, Amazon EC2 returns the credit option (standard or unlimited) of those instances. If you specify an instance ID that is not valid, such as an instance that is not a burstable performance instance, an error is returned.

Recently terminated instances might appear in the returned results. This interval is usually less than one hour.

If an Availability Zone is experiencing a service disruption and you specify instance IDs in the affected zone, or do not specify any instance IDs at all, the call fails. If you specify only instance IDs in an unaffected zone, the call works normally.

For more information, see Burstable performance instances in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeInstanceCreditSpecificationsResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: Filter - in: query - required: false - description:

The filters.

  • instance-id - The ID of the instance.

- schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: InstanceId - in: query - required: false - description: '

The instance IDs.

Default: Describes all your instances.

Constraints: Maximum 1000 explicitly specified instance IDs.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/InstanceId' - - xml: - name: InstanceId - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call.' - schema: - type: integer - minimum: 5 - maximum: 1000 - - name: NextToken - in: query - required: false - description: The token to retrieve the next page of results. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeInstanceCreditSpecifications - operationId: POST_DescribeInstanceCreditSpecifications - description: '

Describes the credit option for CPU usage of the specified burstable performance instances. The credit options are standard and unlimited.

If you do not specify an instance ID, Amazon EC2 returns burstable performance instances with the unlimited credit option, as well as instances that were previously configured as T2, T3, and T3a with the unlimited credit option. For example, if you resize a T2 instance, while it is configured as unlimited, to an M4 instance, Amazon EC2 returns the M4 instance.

If you specify one or more instance IDs, Amazon EC2 returns the credit option (standard or unlimited) of those instances. If you specify an instance ID that is not valid, such as an instance that is not a burstable performance instance, an error is returned.

Recently terminated instances might appear in the returned results. This interval is usually less than one hour.

If an Availability Zone is experiencing a service disruption and you specify instance IDs in the affected zone, or do not specify any instance IDs at all, the call fails. If you specify only instance IDs in an unaffected zone, the call works normally.

For more information, see Burstable performance instances in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeInstanceCreditSpecificationsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeInstanceCreditSpecificationsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeInstanceEventNotificationAttributes&Version=2016-11-15: - get: - x-aws-operation-name: DescribeInstanceEventNotificationAttributes - operationId: GET_DescribeInstanceEventNotificationAttributes - description: Describes the tag keys that are registered to appear in scheduled event notifications for resources in the current Region. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeInstanceEventNotificationAttributesResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeInstanceEventNotificationAttributes - operationId: POST_DescribeInstanceEventNotificationAttributes - description: Describes the tag keys that are registered to appear in scheduled event notifications for resources in the current Region. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeInstanceEventNotificationAttributesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeInstanceEventNotificationAttributesRequest' - parameters: [] - /?Action=DescribeInstanceEventWindows&Version=2016-11-15: - get: - x-aws-operation-name: DescribeInstanceEventWindows - operationId: GET_DescribeInstanceEventWindows - description: '

Describes the specified event windows or all event windows.

If you specify event window IDs, the output includes information for only the specified event windows. If you specify filters, the output includes information for only those event windows that meet the filter criteria. If you do not specify event windows IDs or filters, the output includes information for all event windows, which can affect performance. We recommend that you use pagination to ensure that the operation returns quickly and successfully.

For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeInstanceEventWindowsResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: InstanceEventWindowId - in: query - required: false - description: The IDs of the event windows. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/InstanceEventWindowId' - - xml: - name: InstanceEventWindowId - - name: Filter - in: query - required: false - description: '

One or more filters.

  • dedicated-host-id - The event windows associated with the specified Dedicated Host ID.

  • event-window-name - The event windows associated with the specified names.

  • instance-id - The event windows associated with the specified instance ID.

  • instance-tag - The event windows associated with the specified tag and value.

  • instance-tag-key - The event windows associated with the specified tag key, regardless of the value.

  • instance-tag-value - The event windows associated with the specified tag value, regardless of the key.

  • tag:<key> - The key/value combination of a tag assigned to the event window. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value CMX, specify tag:Owner for the filter name and CMX for the filter value.

  • tag-key - The key of a tag assigned to the event window. Use this filter to find all event windows that have a tag with a specific key, regardless of the tag value.

  • tag-value - The value of a tag assigned to the event window. Use this filter to find all event windows that have a tag with a specific value, regardless of the tag key.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 20 and 500. You cannot specify this parameter and the event window IDs parameter in the same call.' - schema: - type: integer - minimum: 20 - maximum: 500 - - name: NextToken - in: query - required: false - description: The token to request the next page of results. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeInstanceEventWindows - operationId: POST_DescribeInstanceEventWindows - description: '

Describes the specified event windows or all event windows.

If you specify event window IDs, the output includes information for only the specified event windows. If you specify filters, the output includes information for only those event windows that meet the filter criteria. If you do not specify event windows IDs or filters, the output includes information for all event windows, which can affect performance. We recommend that you use pagination to ensure that the operation returns quickly and successfully.

For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeInstanceEventWindowsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeInstanceEventWindowsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeInstanceStatus&Version=2016-11-15: - get: - x-aws-operation-name: DescribeInstanceStatus - operationId: GET_DescribeInstanceStatus - description: '

Describes the status of the specified instances or all of your instances. By default, only running instances are described, unless you specifically indicate to return the status of all instances.

Instance status includes the following components:

  • Status checks - Amazon EC2 performs status checks on running EC2 instances to identify hardware and software issues. For more information, see Status checks for your instances and Troubleshoot instances with failed status checks in the Amazon EC2 User Guide.

  • Scheduled events - Amazon EC2 can schedule events (such as reboot, stop, or terminate) for your instances related to hardware issues, software updates, or system maintenance. For more information, see Scheduled events for your instances in the Amazon EC2 User Guide.

  • Instance state - You can manage your instances from the moment you launch them through their termination. For more information, see Instance lifecycle in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeInstanceStatusResult' - parameters: - - name: Filter - in: query - required: false - description: '

The filters.

  • availability-zone - The Availability Zone of the instance.

  • event.code - The code for the scheduled event (instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop).

  • event.description - A description of the event.

  • event.instance-event-id - The ID of the event whose date and time you are modifying.

  • event.not-after - The latest end time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).

  • event.not-before - The earliest start time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).

  • event.not-before-deadline - The deadline for starting the event (for example, 2014-09-15T17:15:20.000Z).

  • instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).

  • instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

  • instance-status.reachability - Filters on instance status where the name is reachability (passed | failed | initializing | insufficient-data).

  • instance-status.status - The status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

  • system-status.reachability - Filters on system status where the name is reachability (passed | failed | initializing | insufficient-data).

  • system-status.status - The system status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: InstanceId - in: query - required: false - description: '

The instance IDs.

Default: Describes all your instances.

Constraints: Maximum 100 explicitly specified instance IDs.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/InstanceId' - - xml: - name: InstanceId - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call.' - schema: - type: integer - - name: NextToken - in: query - required: false - description: The token to retrieve the next page of results. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: IncludeAllInstances - in: query - required: false - description: '

When true, includes the health status for all instances. When false, includes the health status for running instances only.

Default: false

' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeInstanceStatus - operationId: POST_DescribeInstanceStatus - description: '

Describes the status of the specified instances or all of your instances. By default, only running instances are described, unless you specifically indicate to return the status of all instances.

Instance status includes the following components:

  • Status checks - Amazon EC2 performs status checks on running EC2 instances to identify hardware and software issues. For more information, see Status checks for your instances and Troubleshoot instances with failed status checks in the Amazon EC2 User Guide.

  • Scheduled events - Amazon EC2 can schedule events (such as reboot, stop, or terminate) for your instances related to hardware issues, software updates, or system maintenance. For more information, see Scheduled events for your instances in the Amazon EC2 User Guide.

  • Instance state - You can manage your instances from the moment you launch them through their termination. For more information, see Instance lifecycle in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeInstanceStatusResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeInstanceStatusRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeInstanceTypeOfferings&Version=2016-11-15: - get: - x-aws-operation-name: DescribeInstanceTypeOfferings - operationId: GET_DescribeInstanceTypeOfferings - description: 'Returns a list of all instance types offered. The results can be filtered by location (Region or Availability Zone). If no location is specified, the instance types offered in the current Region are returned.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeInstanceTypeOfferingsResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: LocationType - in: query - required: false - description: The location type. - schema: - type: string - enum: - - region - - availability-zone - - availability-zone-id - - name: Filter - in: query - required: false - description: '

One or more filters. Filter names and values are case-sensitive.

  • location - This depends on the location type. For example, if the location type is region (default), the location is the Region code (for example, us-east-2.)

  • instance-type - The instance type. For example, c5.2xlarge.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: MaxResults - in: query - required: false - description: The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the next token value. - schema: - type: integer - minimum: 5 - maximum: 1000 - - name: NextToken - in: query - required: false - description: The token to retrieve the next page of results. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeInstanceTypeOfferings - operationId: POST_DescribeInstanceTypeOfferings - description: 'Returns a list of all instance types offered. The results can be filtered by location (Region or Availability Zone). If no location is specified, the instance types offered in the current Region are returned.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeInstanceTypeOfferingsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeInstanceTypeOfferingsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeInstanceTypes&Version=2016-11-15: - get: - x-aws-operation-name: DescribeInstanceTypes - operationId: GET_DescribeInstanceTypes - description: Describes the details of the instance types that are offered in a location. The results can be filtered by the attributes of the instance types. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeInstanceTypesResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: InstanceType - in: query - required: false - description: 'The instance types. For more information, see Instance types in the Amazon EC2 User Guide.' - schema: - type: array - items: - $ref: '#/components/schemas/InstanceType' - minItems: 0 - maxItems: 100 - - name: Filter - in: query - required: false - description: '

One or more filters. Filter names and values are case-sensitive.

  • auto-recovery-supported - Indicates whether auto recovery is supported (true | false).

  • bare-metal - Indicates whether it is a bare metal instance type (true | false).

  • burstable-performance-supported - Indicates whether it is a burstable performance instance type (true | false).

  • current-generation - Indicates whether this instance type is the latest generation instance type of an instance family (true | false).

  • ebs-info.ebs-optimized-info.baseline-bandwidth-in-mbps - The baseline bandwidth performance for an EBS-optimized instance type, in Mbps.

  • ebs-info.ebs-optimized-info.baseline-iops - The baseline input/output storage operations per second for an EBS-optimized instance type.

  • ebs-info.ebs-optimized-info.baseline-throughput-in-mbps - The baseline throughput performance for an EBS-optimized instance type, in MB/s.

  • ebs-info.ebs-optimized-info.maximum-bandwidth-in-mbps - The maximum bandwidth performance for an EBS-optimized instance type, in Mbps.

  • ebs-info.ebs-optimized-info.maximum-iops - The maximum input/output storage operations per second for an EBS-optimized instance type.

  • ebs-info.ebs-optimized-info.maximum-throughput-in-mbps - The maximum throughput performance for an EBS-optimized instance type, in MB/s.

  • ebs-info.ebs-optimized-support - Indicates whether the instance type is EBS-optimized (supported | unsupported | default).

  • ebs-info.encryption-support - Indicates whether EBS encryption is supported (supported | unsupported).

  • ebs-info.nvme-support - Indicates whether non-volatile memory express (NVMe) is supported for EBS volumes (required | supported | unsupported).

  • free-tier-eligible - Indicates whether the instance type is eligible to use in the free tier (true | false).

  • hibernation-supported - Indicates whether On-Demand hibernation is supported (true | false).

  • hypervisor - The hypervisor (nitro | xen).

  • instance-storage-info.disk.count - The number of local disks.

  • instance-storage-info.disk.size-in-gb - The storage size of each instance storage disk, in GB.

  • instance-storage-info.disk.type - The storage technology for the local instance storage disks (hdd | ssd).

  • instance-storage-info.encryption-support - Indicates whether data is encrypted at rest (required | supported | unsupported).

  • instance-storage-info.nvme-support - Indicates whether non-volatile memory express (NVMe) is supported for instance store (required | supported | unsupported).

  • instance-storage-info.total-size-in-gb - The total amount of storage available from all local instance storage, in GB.

  • instance-storage-supported - Indicates whether the instance type has local instance storage (true | false).

  • instance-type - The instance type (for example c5.2xlarge or c5*).

  • memory-info.size-in-mib - The memory size.

  • network-info.efa-info.maximum-efa-interfaces - The maximum number of Elastic Fabric Adapters (EFAs) per instance.

  • network-info.efa-supported - Indicates whether the instance type supports Elastic Fabric Adapter (EFA) (true | false).

  • network-info.ena-support - Indicates whether Elastic Network Adapter (ENA) is supported or required (required | supported | unsupported).

  • network-info.encryption-in-transit-supported - Indicates whether the instance type automatically encrypts in-transit traffic between instances (true | false).

  • network-info.ipv4-addresses-per-interface - The maximum number of private IPv4 addresses per network interface.

  • network-info.ipv6-addresses-per-interface - The maximum number of private IPv6 addresses per network interface.

  • network-info.ipv6-supported - Indicates whether the instance type supports IPv6 (true | false).

  • network-info.maximum-network-cards - The maximum number of network cards per instance.

  • network-info.maximum-network-interfaces - The maximum number of network interfaces per instance.

  • network-info.network-performance - The network performance (for example, "25 Gigabit").

  • processor-info.supported-architecture - The CPU architecture (arm64 | i386 | x86_64).

  • processor-info.sustained-clock-speed-in-ghz - The CPU clock speed, in GHz.

  • supported-boot-mode - The boot mode (legacy-bios | uefi).

  • supported-root-device-type - The root device type (ebs | instance-store).

  • supported-usage-class - The usage class (on-demand | spot).

  • supported-virtualization-type - The virtualization type (hvm | paravirtual).

  • vcpu-info.default-cores - The default number of cores for the instance type.

  • vcpu-info.default-threads-per-core - The default number of threads per core for the instance type.

  • vcpu-info.default-vcpus - The default number of vCPUs for the instance type.

  • vcpu-info.valid-cores - The number of cores that can be configured for the instance type.

  • vcpu-info.valid-threads-per-core - The number of threads per core that can be configured for the instance type. For example, "1" or "1,2".

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: MaxResults - in: query - required: false - description: The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the next token value. - schema: - type: integer - minimum: 5 - maximum: 100 - - name: NextToken - in: query - required: false - description: The token to retrieve the next page of results. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeInstanceTypes - operationId: POST_DescribeInstanceTypes - description: Describes the details of the instance types that are offered in a location. The results can be filtered by the attributes of the instance types. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeInstanceTypesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeInstanceTypesRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeInstances&Version=2016-11-15: - get: - x-aws-operation-name: DescribeInstances - operationId: GET_DescribeInstances - description: '

Describes the specified instances or all instances.

If you specify instance IDs, the output includes information for only the specified instances. If you specify filters, the output includes information for only those instances that meet the filter criteria. If you do not specify instance IDs or filters, the output includes information for all instances, which can affect performance. We recommend that you use pagination to ensure that the operation returns quickly and successfully.

If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the output.

Recently terminated instances might appear in the returned results. This interval is usually less than one hour.

If you describe instances in the rare case where an Availability Zone is experiencing a service disruption and you specify instance IDs that are in the affected zone, or do not specify any instance IDs at all, the call fails. If you describe instances and specify only instance IDs that are in an unaffected zone, the call works normally.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeInstancesResult' - parameters: - - name: Filter - in: query - required: false - description: '

The filters.

  • affinity - The affinity setting for an instance running on a Dedicated Host (default | host).

  • architecture - The instance architecture (i386 | x86_64 | arm64).

  • availability-zone - The Availability Zone of the instance.

  • block-device-mapping.attach-time - The attach time for an EBS volume mapped to the instance, for example, 2010-09-15T17:15:20.000Z.

  • block-device-mapping.delete-on-termination - A Boolean that indicates whether the EBS volume is deleted on instance termination.

  • block-device-mapping.device-name - The device name specified in the block device mapping (for example, /dev/sdh or xvdh).

  • block-device-mapping.status - The status for the EBS volume (attaching | attached | detaching | detached).

  • block-device-mapping.volume-id - The volume ID of the EBS volume.

  • capacity-reservation-id - The ID of the Capacity Reservation into which the instance was launched.

  • client-token - The idempotency token you provided when you launched the instance.

  • dns-name - The public DNS name of the instance.

  • group-id - The ID of the security group for the instance. EC2-Classic only.

  • group-name - The name of the security group for the instance. EC2-Classic only.

  • hibernation-options.configured - A Boolean that indicates whether the instance is enabled for hibernation. A value of true means that the instance is enabled for hibernation.

  • host-id - The ID of the Dedicated Host on which the instance is running, if applicable.

  • hypervisor - The hypervisor type of the instance (ovm | xen). The value xen is used for both Xen and Nitro hypervisors.

  • iam-instance-profile.arn - The instance profile associated with the instance. Specified as an ARN.

  • image-id - The ID of the image used to launch the instance.

  • instance-id - The ID of the instance.

  • instance-lifecycle - Indicates whether this is a Spot Instance or a Scheduled Instance (spot | scheduled).

  • instance-state-code - The state of the instance, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).

  • instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

  • instance-type - The type of instance (for example, t2.micro).

  • instance.group-id - The ID of the security group for the instance.

  • instance.group-name - The name of the security group for the instance.

  • ip-address - The public IPv4 address of the instance.

  • kernel-id - The kernel ID.

  • key-name - The name of the key pair used when the instance was launched.

  • launch-index - When launching multiple instances, this is the index for the instance in the launch group (for example, 0, 1, 2, and so on).

  • launch-time - The time when the instance was launched, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, 2021-09-29T11:04:43.305Z. You can use a wildcard (*), for example, 2021-09-29T*, which matches an entire day.

  • metadata-options.http-tokens - The metadata request authorization state (optional | required)

  • metadata-options.http-put-response-hop-limit - The http metadata request put response hop limit (integer, possible values 1 to 64)

  • metadata-options.http-endpoint - Enable or disable metadata access on http endpoint (enabled | disabled)

  • monitoring-state - Indicates whether detailed monitoring is enabled (disabled | enabled).

  • network-interface.addresses.private-ip-address - The private IPv4 address associated with the network interface.

  • network-interface.addresses.primary - Specifies whether the IPv4 address of the network interface is the primary private IPv4 address.

  • network-interface.addresses.association.public-ip - The ID of the association of an Elastic IP address (IPv4) with a network interface.

  • network-interface.addresses.association.ip-owner-id - The owner ID of the private IPv4 address associated with the network interface.

  • network-interface.association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.

  • network-interface.association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface.

  • network-interface.association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.

  • network-interface.association.association-id - The association ID returned when the network interface was associated with an IPv4 address.

  • network-interface.attachment.attachment-id - The ID of the interface attachment.

  • network-interface.attachment.instance-id - The ID of the instance to which the network interface is attached.

  • network-interface.attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.

  • network-interface.attachment.device-index - The device index to which the network interface is attached.

  • network-interface.attachment.status - The status of the attachment (attaching | attached | detaching | detached).

  • network-interface.attachment.attach-time - The time that the network interface was attached to an instance.

  • network-interface.attachment.delete-on-termination - Specifies whether the attachment is deleted when an instance is terminated.

  • network-interface.availability-zone - The Availability Zone for the network interface.

  • network-interface.description - The description of the network interface.

  • network-interface.group-id - The ID of a security group associated with the network interface.

  • network-interface.group-name - The name of a security group associated with the network interface.

  • network-interface.ipv6-addresses.ipv6-address - The IPv6 address associated with the network interface.

  • network-interface.mac-address - The MAC address of the network interface.

  • network-interface.network-interface-id - The ID of the network interface.

  • network-interface.owner-id - The ID of the owner of the network interface.

  • network-interface.private-dns-name - The private DNS name of the network interface.

  • network-interface.requester-id - The requester ID for the network interface.

  • network-interface.requester-managed - Indicates whether the network interface is being managed by Amazon Web Services.

  • network-interface.status - The status of the network interface (available) | in-use).

  • network-interface.source-dest-check - Whether the network interface performs source/destination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.

  • network-interface.subnet-id - The ID of the subnet for the network interface.

  • network-interface.vpc-id - The ID of the VPC for the network interface.

  • outpost-arn - The Amazon Resource Name (ARN) of the Outpost.

  • owner-id - The Amazon Web Services account ID of the instance owner.

  • placement-group-name - The name of the placement group for the instance.

  • placement-partition-number - The partition in which the instance is located.

  • platform - The platform. To list only Windows instances, use windows.

  • private-dns-name - The private IPv4 DNS name of the instance.

  • private-ip-address - The private IPv4 address of the instance.

  • product-code - The product code associated with the AMI used to launch the instance.

  • product-code.type - The type of product code (devpay | marketplace).

  • ramdisk-id - The RAM disk ID.

  • reason - The reason for the current state of the instance (for example, shows "User Initiated [date]" when you stop or terminate the instance). Similar to the state-reason-code filter.

  • requester-id - The ID of the entity that launched the instance on your behalf (for example, Amazon Web Services Management Console, Auto Scaling, and so on).

  • reservation-id - The ID of the instance''s reservation. A reservation ID is created any time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be associated with more than one instance if you launch multiple instances using the same launch request. For example, if you launch one instance, you get one reservation ID. If you launch ten instances using the same launch request, you also get one reservation ID.

  • root-device-name - The device name of the root device volume (for example, /dev/sda1).

  • root-device-type - The type of the root device volume (ebs | instance-store).

  • source-dest-check - Indicates whether the instance performs source/destination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the instance to perform network address translation (NAT) in your VPC.

  • spot-instance-request-id - The ID of the Spot Instance request.

  • state-reason-code - The reason code for the state change.

  • state-reason-message - A message that describes the state change.

  • subnet-id - The ID of the subnet for the instance.

  • tag:<key> - 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. 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.

  • 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.

  • tenancy - The tenancy of an instance (dedicated | default | host).

  • virtualization-type - The virtualization type of the instance (paravirtual | hvm).

  • vpc-id - The ID of the VPC that the instance is running in.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: InstanceId - in: query - required: false - description: '

The instance IDs.

Default: Describes all your instances.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/InstanceId' - - xml: - name: InstanceId - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call.' - schema: - type: integer - - name: NextToken - in: query - required: false - description: The token to request the next page of results. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeInstances - operationId: POST_DescribeInstances - description: '

Describes the specified instances or all instances.

If you specify instance IDs, the output includes information for only the specified instances. If you specify filters, the output includes information for only those instances that meet the filter criteria. If you do not specify instance IDs or filters, the output includes information for all instances, which can affect performance. We recommend that you use pagination to ensure that the operation returns quickly and successfully.

If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the output.

Recently terminated instances might appear in the returned results. This interval is usually less than one hour.

If you describe instances in the rare case where an Availability Zone is experiencing a service disruption and you specify instance IDs that are in the affected zone, or do not specify any instance IDs at all, the call fails. If you describe instances and specify only instance IDs that are in an unaffected zone, the call works normally.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeInstancesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeInstancesRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeInternetGateways&Version=2016-11-15: - get: - x-aws-operation-name: DescribeInternetGateways - operationId: GET_DescribeInternetGateways - description: Describes one or more of your internet gateways. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeInternetGatewaysResult' - parameters: - - name: Filter - in: query - required: false - description: '

One or more filters.

  • attachment.state - The current state of the attachment between the gateway and the VPC (available). Present only if a VPC is attached.

  • attachment.vpc-id - The ID of an attached VPC.

  • internet-gateway-id - The ID of the Internet gateway.

  • owner-id - The ID of the Amazon Web Services account that owns the internet gateway.

  • tag:<key> - 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. 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.

  • 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.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: InternetGatewayId - in: query - required: false - description: '

One or more internet gateway IDs.

Default: Describes all your internet gateways.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/InternetGatewayId' - - xml: - name: item - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - schema: - type: integer - minimum: 5 - maximum: 1000 - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeInternetGateways - operationId: POST_DescribeInternetGateways - description: Describes one or more of your internet gateways. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeInternetGatewaysResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeInternetGatewaysRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeIpamPools&Version=2016-11-15: - get: - x-aws-operation-name: DescribeIpamPools - operationId: GET_DescribeIpamPools - description: Get information about your IPAM pools. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeIpamPoolsResult' - parameters: - - name: DryRun - in: query - required: false - description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: Filter - in: query - required: false - description: 'One or more filters for the request. For more information about filtering, see Filtering CLI output.' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: MaxResults - in: query - required: false - description: The maximum number of results to return in the request. - schema: - type: integer - minimum: 5 - maximum: 1000 - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - - name: IpamPoolId - in: query - required: false - description: The IDs of the IPAM pools you would like information on. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeIpamPools - operationId: POST_DescribeIpamPools - description: Get information about your IPAM pools. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeIpamPoolsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeIpamPoolsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeIpamScopes&Version=2016-11-15: - get: - x-aws-operation-name: DescribeIpamScopes - operationId: GET_DescribeIpamScopes - description: Get information about your IPAM scopes. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeIpamScopesResult' - parameters: - - name: DryRun - in: query - required: false - description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: Filter - in: query - required: false - description: 'One or more filters for the request. For more information about filtering, see Filtering CLI output.' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: MaxResults - in: query - required: false - description: The maximum number of results to return in the request. - schema: - type: integer - minimum: 5 - maximum: 1000 - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - - name: IpamScopeId - in: query - required: false - description: The IDs of the scopes you want information on. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeIpamScopes - operationId: POST_DescribeIpamScopes - description: Get information about your IPAM scopes. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeIpamScopesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeIpamScopesRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeIpams&Version=2016-11-15: - get: - x-aws-operation-name: DescribeIpams - operationId: GET_DescribeIpams - description: '

Get information about your IPAM pools.

For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeIpamsResult' - parameters: - - name: DryRun - in: query - required: false - description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: Filter - in: query - required: false - description: 'One or more filters for the request. For more information about filtering, see Filtering CLI output.' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: MaxResults - in: query - required: false - description: The maximum number of results to return in the request. - schema: - type: integer - minimum: 5 - maximum: 1000 - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - - name: IpamId - in: query - required: false - description: The IDs of the IPAMs you want information on. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeIpams - operationId: POST_DescribeIpams - description: '

Get information about your IPAM pools.

For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeIpamsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeIpamsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeIpv6Pools&Version=2016-11-15: - get: - x-aws-operation-name: DescribeIpv6Pools - operationId: GET_DescribeIpv6Pools - description: Describes your IPv6 address pools. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeIpv6PoolsResult' - parameters: - - name: PoolId - in: query - required: false - description: The IDs of the IPv6 address pools. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Ipv6PoolEc2Id' - - xml: - name: item - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - schema: - type: integer - minimum: 1 - maximum: 1000 - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: Filter - in: query - required: false - description: '

One or more filters.

  • tag:<key> - 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. 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.

  • 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.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeIpv6Pools - operationId: POST_DescribeIpv6Pools - description: Describes your IPv6 address pools. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeIpv6PoolsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeIpv6PoolsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeKeyPairs&Version=2016-11-15: - get: - x-aws-operation-name: DescribeKeyPairs - operationId: GET_DescribeKeyPairs - description: '

Describes the specified key pairs or all of your key pairs.

For more information about key pairs, see Amazon EC2 key pairs in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeKeyPairsResult' - parameters: - - name: Filter - in: query - required: false - description: '

The filters.

  • key-pair-id - The ID of the key pair.

  • fingerprint - The fingerprint of the key pair.

  • key-name - The name of the key pair.

  • 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.

  • tag:<key> - 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. 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.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: KeyName - in: query - required: false - description: '

The key pair names.

Default: Describes all of your key pairs.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/KeyPairName' - - xml: - name: KeyName - - name: KeyPairId - in: query - required: false - description: The IDs of the key pairs. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/KeyPairId' - - xml: - name: KeyPairId - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: IncludePublicKey - in: query - required: false - description: '

If true, the public key material is included in the response.

Default: false

' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeKeyPairs - operationId: POST_DescribeKeyPairs - description: '

Describes the specified key pairs or all of your key pairs.

For more information about key pairs, see Amazon EC2 key pairs in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeKeyPairsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeKeyPairsRequest' - parameters: [] - /?Action=DescribeLaunchTemplateVersions&Version=2016-11-15: - get: - x-aws-operation-name: DescribeLaunchTemplateVersions - operationId: GET_DescribeLaunchTemplateVersions - description: 'Describes one or more versions of a specified launch template. You can describe all versions, individual versions, or a range of versions. You can also describe all the latest versions or all the default versions of all the launch templates in your account.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeLaunchTemplateVersionsResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: LaunchTemplateId - in: query - required: false - description: 'The ID of the launch template. To describe one or more versions of a specified launch template, you must specify either the launch template ID or the launch template name in the request. To describe all the latest or default launch template versions in your account, you must omit this parameter.' - schema: - type: string - - name: LaunchTemplateName - in: query - required: false - description: 'The name of the launch template. To describe one or more versions of a specified launch template, you must specify either the launch template ID or the launch template name in the request. To describe all the latest or default launch template versions in your account, you must omit this parameter.' - schema: - type: string - pattern: '[a-zA-Z0-9\(\)\.\-/_]+' - minLength: 3 - maxLength: 128 - - name: LaunchTemplateVersion - in: query - required: false - description: '

One or more versions of the launch template. Valid values depend on whether you are describing a specified launch template (by ID or name) or all launch templates in your account.

To describe one or more versions of a specified launch template, valid values are $Latest, $Default, and numbers.

To describe all launch templates in your account that are defined as the latest version, the valid value is $Latest. To describe all launch templates in your account that are defined as the default version, the valid value is $Default. You can specify $Latest and $Default in the same call. You cannot specify numbers.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - - name: MinVersion - in: query - required: false - description: The version number after which to describe launch template versions. - schema: - type: string - - name: MaxVersion - in: query - required: false - description: The version number up to which to describe launch template versions. - schema: - type: string - - name: NextToken - in: query - required: false - description: The token to request the next page of results. - schema: - type: string - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 1 and 200.' - schema: - type: integer - - name: Filter - in: query - required: false - description:

One or more filters.

  • create-time - The time the launch template version was created.

  • ebs-optimized - A boolean that indicates whether the instance is optimized for Amazon EBS I/O.

  • http-endpoint - Indicates whether the HTTP metadata endpoint on your instances is enabled (enabled | disabled).

  • http-protocol-ipv4 - Indicates whether the IPv4 endpoint for the instance metadata service is enabled (enabled | disabled).

  • host-resource-group-arn - The ARN of the host resource group in which to launch the instances.

  • http-tokens - The state of token usage for your instance metadata requests (optional | required).

  • iam-instance-profile - The ARN of the IAM instance profile.

  • image-id - The ID of the AMI.

  • instance-type - The instance type.

  • is-default-version - A boolean that indicates whether the launch template version is the default version.

  • kernel-id - The kernel ID.

  • license-configuration-arn - The ARN of the license configuration.

  • network-card-index - The index of the network card.

  • ram-disk-id - The RAM disk ID.

- schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeLaunchTemplateVersions - operationId: POST_DescribeLaunchTemplateVersions - description: 'Describes one or more versions of a specified launch template. You can describe all versions, individual versions, or a range of versions. You can also describe all the latest versions or all the default versions of all the launch templates in your account.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeLaunchTemplateVersionsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeLaunchTemplateVersionsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeLaunchTemplates&Version=2016-11-15: - get: - x-aws-operation-name: DescribeLaunchTemplates - operationId: GET_DescribeLaunchTemplates - description: Describes one or more launch templates. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeLaunchTemplatesResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: LaunchTemplateId - in: query - required: false - description: One or more launch template IDs. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/LaunchTemplateId' - - xml: - name: item - - name: LaunchTemplateName - in: query - required: false - description: One or more launch template names. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/LaunchTemplateName' - - xml: - name: item - - name: Filter - in: query - required: false - description: '

One or more filters.

  • create-time - The time the launch template was created.

  • launch-template-name - The name of the launch template.

  • tag:<key> - 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. 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.

  • 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.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: NextToken - in: query - required: false - description: The token to request the next page of results. - schema: - type: string - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 1 and 200.' - schema: - type: integer - minimum: 1 - maximum: 200 - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeLaunchTemplates - operationId: POST_DescribeLaunchTemplates - description: Describes one or more launch templates. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeLaunchTemplatesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeLaunchTemplatesRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations&Version=2016-11-15: - get: - x-aws-operation-name: DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations - operationId: GET_DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations - description: Describes the associations between virtual interface groups and local gateway route tables. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsResult' - parameters: - - name: LocalGatewayRouteTableVirtualInterfaceGroupAssociationId - in: query - required: false - description: The IDs of the associations. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/LocalGatewayRouteTableVirtualInterfaceGroupAssociationId' - - xml: - name: item - - name: Filter - in: query - required: false - description:

One or more filters.

  • local-gateway-id - The ID of a local gateway.

  • local-gateway-route-table-arn - The Amazon Resource Name (ARN) of the local gateway route table for the virtual interface group.

  • local-gateway-route-table-id - The ID of the local gateway route table.

  • local-gateway-route-table-virtual-interface-group-association-id - The ID of the association.

  • local-gateway-route-table-virtual-interface-group-id - The ID of the virtual interface group.

  • owner-id - The ID of the Amazon Web Services account that owns the local gateway virtual interface group association.

  • state - The state of the association.

- schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - schema: - type: integer - minimum: 5 - maximum: 1000 - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations - operationId: POST_DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations - description: Describes the associations between virtual interface groups and local gateway route tables. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeLocalGatewayRouteTableVpcAssociations&Version=2016-11-15: - get: - x-aws-operation-name: DescribeLocalGatewayRouteTableVpcAssociations - operationId: GET_DescribeLocalGatewayRouteTableVpcAssociations - description: Describes the specified associations between VPCs and local gateway route tables. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeLocalGatewayRouteTableVpcAssociationsResult' - parameters: - - name: LocalGatewayRouteTableVpcAssociationId - in: query - required: false - description: The IDs of the associations. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/LocalGatewayRouteTableVpcAssociationId' - - xml: - name: item - - name: Filter - in: query - required: false - description:

One or more filters.

  • local-gateway-id - The ID of a local gateway.

  • local-gateway-route-table-arn - The Amazon Resource Name (ARN) of the local gateway route table for the association.

  • local-gateway-route-table-id - The ID of the local gateway route table.

  • local-gateway-route-table-vpc-association-id - The ID of the association.

  • owner-id - The ID of the Amazon Web Services account that owns the local gateway route table for the association.

  • state - The state of the association.

  • vpc-id - The ID of the VPC.

- schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - schema: - type: integer - minimum: 5 - maximum: 1000 - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeLocalGatewayRouteTableVpcAssociations - operationId: POST_DescribeLocalGatewayRouteTableVpcAssociations - description: Describes the specified associations between VPCs and local gateway route tables. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeLocalGatewayRouteTableVpcAssociationsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeLocalGatewayRouteTableVpcAssociationsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeLocalGatewayRouteTables&Version=2016-11-15: - get: - x-aws-operation-name: DescribeLocalGatewayRouteTables - operationId: GET_DescribeLocalGatewayRouteTables - description: 'Describes one or more local gateway route tables. By default, all local gateway route tables are described. Alternatively, you can filter the results.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeLocalGatewayRouteTablesResult' - parameters: - - name: LocalGatewayRouteTableId - in: query - required: false - description: The IDs of the local gateway route tables. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/LocalGatewayRoutetableId' - - xml: - name: item - - name: Filter - in: query - required: false - description:

One or more filters.

  • local-gateway-id - The ID of a local gateway.

  • local-gateway-route-table-arn - The Amazon Resource Name (ARN) of the local gateway route table.

  • local-gateway-route-table-id - The ID of a local gateway route table.

  • outpost-arn - The Amazon Resource Name (ARN) of the Outpost.

  • owner-id - The ID of the Amazon Web Services account that owns the local gateway route table.

  • state - The state of the local gateway route table.

- schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - schema: - type: integer - minimum: 5 - maximum: 1000 - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeLocalGatewayRouteTables - operationId: POST_DescribeLocalGatewayRouteTables - description: 'Describes one or more local gateway route tables. By default, all local gateway route tables are described. Alternatively, you can filter the results.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeLocalGatewayRouteTablesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeLocalGatewayRouteTablesRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeLocalGatewayVirtualInterfaceGroups&Version=2016-11-15: - get: - x-aws-operation-name: DescribeLocalGatewayVirtualInterfaceGroups - operationId: GET_DescribeLocalGatewayVirtualInterfaceGroups - description: Describes the specified local gateway virtual interface groups. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeLocalGatewayVirtualInterfaceGroupsResult' - parameters: - - name: LocalGatewayVirtualInterfaceGroupId - in: query - required: false - description: The IDs of the virtual interface groups. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/LocalGatewayVirtualInterfaceGroupId' - - xml: - name: item - - name: Filter - in: query - required: false - description:

One or more filters.

  • local-gateway-id - The ID of a local gateway.

  • local-gateway-virtual-interface-group-id - The ID of the virtual interface group.

  • local-gateway-virtual-interface-id - The ID of the virtual interface.

  • owner-id - The ID of the Amazon Web Services account that owns the local gateway virtual interface group.

- schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - schema: - type: integer - minimum: 5 - maximum: 1000 - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeLocalGatewayVirtualInterfaceGroups - operationId: POST_DescribeLocalGatewayVirtualInterfaceGroups - description: Describes the specified local gateway virtual interface groups. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeLocalGatewayVirtualInterfaceGroupsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeLocalGatewayVirtualInterfaceGroupsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeLocalGatewayVirtualInterfaces&Version=2016-11-15: - get: - x-aws-operation-name: DescribeLocalGatewayVirtualInterfaces - operationId: GET_DescribeLocalGatewayVirtualInterfaces - description: Describes the specified local gateway virtual interfaces. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeLocalGatewayVirtualInterfacesResult' - parameters: - - name: LocalGatewayVirtualInterfaceId - in: query - required: false - description: The IDs of the virtual interfaces. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/LocalGatewayVirtualInterfaceId' - - xml: - name: item - - name: Filter - in: query - required: false - description:

One or more filters.

  • local-address - The local address.

  • local-bgp-asn - The Border Gateway Protocol (BGP) Autonomous System Number (ASN) of the local gateway.

  • local-gateway-id - The ID of the local gateway.

  • local-gateway-virtual-interface-id - The ID of the virtual interface.

  • owner-id - The ID of the Amazon Web Services account that owns the local gateway virtual interface.

  • peer-address - The peer address.

  • peer-bgp-asn - The peer BGP ASN.

  • vlan - The ID of the VLAN.

- schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - schema: - type: integer - minimum: 5 - maximum: 1000 - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeLocalGatewayVirtualInterfaces - operationId: POST_DescribeLocalGatewayVirtualInterfaces - description: Describes the specified local gateway virtual interfaces. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeLocalGatewayVirtualInterfacesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeLocalGatewayVirtualInterfacesRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeLocalGateways&Version=2016-11-15: - get: - x-aws-operation-name: DescribeLocalGateways - operationId: GET_DescribeLocalGateways - description: 'Describes one or more local gateways. By default, all local gateways are described. Alternatively, you can filter the results.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeLocalGatewaysResult' - parameters: - - name: LocalGatewayId - in: query - required: false - description: The IDs of the local gateways. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/LocalGatewayId' - - xml: - name: item - - name: Filter - in: query - required: false - description:

One or more filters.

  • local-gateway-id - The ID of a local gateway.

  • outpost-arn - The Amazon Resource Name (ARN) of the Outpost.

  • owner-id - The ID of the Amazon Web Services account that owns the local gateway.

  • state - The state of the association.

- schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - schema: - type: integer - minimum: 5 - maximum: 1000 - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeLocalGateways - operationId: POST_DescribeLocalGateways - description: 'Describes one or more local gateways. By default, all local gateways are described. Alternatively, you can filter the results.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeLocalGatewaysResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeLocalGatewaysRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeManagedPrefixLists&Version=2016-11-15: - get: - x-aws-operation-name: DescribeManagedPrefixLists - operationId: GET_DescribeManagedPrefixLists - description: '

Describes your managed prefix lists and any Amazon Web Services-managed prefix lists.

To view the entries for your prefix list, use GetManagedPrefixListEntries.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeManagedPrefixListsResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: Filter - in: query - required: false - description:

One or more filters.

  • owner-id - The ID of the prefix list owner.

  • prefix-list-id - The ID of the prefix list.

  • prefix-list-name - The name of the prefix list.

- schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - schema: - type: integer - minimum: 1 - maximum: 100 - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - - name: PrefixListId - in: query - required: false - description: One or more prefix list IDs. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeManagedPrefixLists - operationId: POST_DescribeManagedPrefixLists - description: '

Describes your managed prefix lists and any Amazon Web Services-managed prefix lists.

To view the entries for your prefix list, use GetManagedPrefixListEntries.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeManagedPrefixListsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeManagedPrefixListsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeMovingAddresses&Version=2016-11-15: - get: - x-aws-operation-name: DescribeMovingAddresses - operationId: GET_DescribeMovingAddresses - description: 'Describes your Elastic IP addresses that are being moved to the EC2-VPC platform, or that are being restored to the EC2-Classic platform. This request does not return information about any other Elastic IP addresses in your account.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeMovingAddressesResult' - parameters: - - name: Filter - in: query - required: false - description:

One or more filters.

  • moving-status - The status of the Elastic IP address (MovingToVpc | RestoringToClassic).

- schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: MaxResults - in: query - required: false - description: '

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value outside of this range, an error is returned.

Default: If no value is provided, the default is 1000.

' - schema: - type: integer - minimum: 5 - maximum: 1000 - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - - name: PublicIp - in: query - required: false - description: One or more Elastic IP addresses. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeMovingAddresses - operationId: POST_DescribeMovingAddresses - description: 'Describes your Elastic IP addresses that are being moved to the EC2-VPC platform, or that are being restored to the EC2-Classic platform. This request does not return information about any other Elastic IP addresses in your account.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeMovingAddressesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeMovingAddressesRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeNatGateways&Version=2016-11-15: - get: - x-aws-operation-name: DescribeNatGateways - operationId: GET_DescribeNatGateways - description: Describes one or more of your NAT gateways. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeNatGatewaysResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: Filter - in: query - required: false - description: '

One or more filters.

  • nat-gateway-id - The ID of the NAT gateway.

  • state - The state of the NAT gateway (pending | failed | available | deleting | deleted).

  • subnet-id - The ID of the subnet in which the NAT gateway resides.

  • tag:<key> - 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. 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.

  • 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.

  • vpc-id - The ID of the VPC in which the NAT gateway resides.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - schema: - type: integer - minimum: 5 - maximum: 1000 - - name: NatGatewayId - in: query - required: false - description: One or more NAT gateway IDs. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/NatGatewayId' - - xml: - name: item - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeNatGateways - operationId: POST_DescribeNatGateways - description: Describes one or more of your NAT gateways. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeNatGatewaysResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeNatGatewaysRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeNetworkAcls&Version=2016-11-15: - get: - x-aws-operation-name: DescribeNetworkAcls - operationId: GET_DescribeNetworkAcls - description: '

Describes one or more of your network ACLs.

For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeNetworkAclsResult' - parameters: - - name: Filter - in: query - required: false - description: '

One or more filters.

  • association.association-id - The ID of an association ID for the ACL.

  • association.network-acl-id - The ID of the network ACL involved in the association.

  • association.subnet-id - The ID of the subnet involved in the association.

  • default - Indicates whether the ACL is the default network ACL for the VPC.

  • entry.cidr - The IPv4 CIDR range specified in the entry.

  • entry.icmp.code - The ICMP code specified in the entry, if any.

  • entry.icmp.type - The ICMP type specified in the entry, if any.

  • entry.ipv6-cidr - The IPv6 CIDR range specified in the entry.

  • entry.port-range.from - The start of the port range specified in the entry.

  • entry.port-range.to - The end of the port range specified in the entry.

  • entry.protocol - The protocol specified in the entry (tcp | udp | icmp or a protocol number).

  • entry.rule-action - Allows or denies the matching traffic (allow | deny).

  • entry.rule-number - The number of an entry (in other words, rule) in the set of ACL entries.

  • network-acl-id - The ID of the network ACL.

  • owner-id - The ID of the Amazon Web Services account that owns the network ACL.

  • tag:<key> - 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. 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.

  • 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.

  • vpc-id - The ID of the VPC for the network ACL.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: NetworkAclId - in: query - required: false - description: '

One or more network ACL IDs.

Default: Describes all your network ACLs.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/NetworkAclId' - - xml: - name: item - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - schema: - type: integer - minimum: 5 - maximum: 1000 - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeNetworkAcls - operationId: POST_DescribeNetworkAcls - description: '

Describes one or more of your network ACLs.

For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeNetworkAclsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeNetworkAclsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeNetworkInsightsAccessScopeAnalyses&Version=2016-11-15: - get: - x-aws-operation-name: DescribeNetworkInsightsAccessScopeAnalyses - operationId: GET_DescribeNetworkInsightsAccessScopeAnalyses - description: Describes the specified Network Access Scope analyses. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeNetworkInsightsAccessScopeAnalysesResult' - parameters: - - name: NetworkInsightsAccessScopeAnalysisId - in: query - required: false - description: The IDs of the Network Access Scope analyses. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/NetworkInsightsAccessScopeAnalysisId' - - xml: - name: item - - name: NetworkInsightsAccessScopeId - in: query - required: false - description: The ID of the Network Access Scope. - schema: - type: string - - name: AnalysisStartTimeBegin - in: query - required: false - description: Filters the results based on the start time. The analysis must have started on or after this time. - schema: - type: string - format: date-time - - name: AnalysisStartTimeEnd - in: query - required: false - description: Filters the results based on the start time. The analysis must have started on or before this time. - schema: - type: string - format: date-time - - name: Filter - in: query - required: false - description: There are no supported filters. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - schema: - type: integer - minimum: 1 - maximum: 100 - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeNetworkInsightsAccessScopeAnalyses - operationId: POST_DescribeNetworkInsightsAccessScopeAnalyses - description: Describes the specified Network Access Scope analyses. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeNetworkInsightsAccessScopeAnalysesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeNetworkInsightsAccessScopeAnalysesRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeNetworkInsightsAccessScopes&Version=2016-11-15: - get: - x-aws-operation-name: DescribeNetworkInsightsAccessScopes - operationId: GET_DescribeNetworkInsightsAccessScopes - description: Describes the specified Network Access Scopes. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeNetworkInsightsAccessScopesResult' - parameters: - - name: NetworkInsightsAccessScopeId - in: query - required: false - description: The IDs of the Network Access Scopes. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/NetworkInsightsAccessScopeId' - - xml: - name: item - - name: Filter - in: query - required: false - description: There are no supported filters. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - schema: - type: integer - minimum: 1 - maximum: 100 - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeNetworkInsightsAccessScopes - operationId: POST_DescribeNetworkInsightsAccessScopes - description: Describes the specified Network Access Scopes. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeNetworkInsightsAccessScopesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeNetworkInsightsAccessScopesRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeNetworkInsightsAnalyses&Version=2016-11-15: - get: - x-aws-operation-name: DescribeNetworkInsightsAnalyses - operationId: GET_DescribeNetworkInsightsAnalyses - description: Describes one or more of your network insights analyses. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeNetworkInsightsAnalysesResult' - parameters: - - name: NetworkInsightsAnalysisId - in: query - required: false - description: The ID of the network insights analyses. You must specify either analysis IDs or a path ID. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/NetworkInsightsAnalysisId' - - xml: - name: item - - name: NetworkInsightsPathId - in: query - required: false - description: The ID of the path. You must specify either a path ID or analysis IDs. - schema: - type: string - - name: AnalysisStartTime - in: query - required: false - description: The time when the network insights analyses started. - schema: - type: string - format: date-time - - name: AnalysisEndTime - in: query - required: false - description: The time when the network insights analyses ended. - schema: - type: string - format: date-time - - name: Filter - in: query - required: false - description: '

The filters. The following are the possible values:

  • PathFound - A Boolean value that indicates whether a feasible path is found.

  • Status - The status of the analysis (running | succeeded | failed).

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - schema: - type: integer - minimum: 1 - maximum: 100 - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeNetworkInsightsAnalyses - operationId: POST_DescribeNetworkInsightsAnalyses - description: Describes one or more of your network insights analyses. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeNetworkInsightsAnalysesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeNetworkInsightsAnalysesRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeNetworkInsightsPaths&Version=2016-11-15: - get: - x-aws-operation-name: DescribeNetworkInsightsPaths - operationId: GET_DescribeNetworkInsightsPaths - description: Describes one or more of your paths. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeNetworkInsightsPathsResult' - parameters: - - name: NetworkInsightsPathId - in: query - required: false - description: The IDs of the paths. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/NetworkInsightsPathId' - - xml: - name: item - - name: Filter - in: query - required: false - description: '

The filters. The following are the possible values:

  • Destination - The ID of the resource.

  • DestinationPort - The destination port.

  • Name - The path name.

  • Protocol - The protocol.

  • Source - The ID of the resource.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - schema: - type: integer - minimum: 1 - maximum: 100 - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeNetworkInsightsPaths - operationId: POST_DescribeNetworkInsightsPaths - description: Describes one or more of your paths. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeNetworkInsightsPathsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeNetworkInsightsPathsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeNetworkInterfaceAttribute&Version=2016-11-15: - get: - x-aws-operation-name: DescribeNetworkInterfaceAttribute - operationId: GET_DescribeNetworkInterfaceAttribute - description: Describes a network interface attribute. You can specify only one attribute at a time. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeNetworkInterfaceAttributeResult' - parameters: - - name: Attribute - in: query - required: false - description: The attribute of the network interface. This parameter is required. - schema: - type: string - enum: - - description - - groupSet - - sourceDestCheck - - attachment - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: NetworkInterfaceId - in: query - required: true - description: The ID of the network interface. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeNetworkInterfaceAttribute - operationId: POST_DescribeNetworkInterfaceAttribute - description: Describes a network interface attribute. You can specify only one attribute at a time. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeNetworkInterfaceAttributeResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeNetworkInterfaceAttributeRequest' - parameters: [] - /?Action=DescribeNetworkInterfacePermissions&Version=2016-11-15: - get: - x-aws-operation-name: DescribeNetworkInterfacePermissions - operationId: GET_DescribeNetworkInterfacePermissions - description: 'Describes the permissions for your network interfaces. ' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeNetworkInterfacePermissionsResult' - parameters: - - name: NetworkInterfacePermissionId - in: query - required: false - description: One or more network interface permission IDs. - schema: - type: array - items: - $ref: '#/components/schemas/NetworkInterfacePermissionId' - - name: Filter - in: query - required: false - description:

One or more filters.

  • network-interface-permission.network-interface-permission-id - The ID of the permission.

  • network-interface-permission.network-interface-id - The ID of the network interface.

  • network-interface-permission.aws-account-id - The Amazon Web Services account ID.

  • network-interface-permission.aws-service - The Amazon Web Service.

  • network-interface-permission.permission - The type of permission (INSTANCE-ATTACH | EIP-ASSOCIATE).

- schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: NextToken - in: query - required: false - description: The token to request the next page of results. - schema: - type: string - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. If this parameter is not specified, up to 50 results are returned by default.' - schema: - type: integer - minimum: 5 - maximum: 255 - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeNetworkInterfacePermissions - operationId: POST_DescribeNetworkInterfacePermissions - description: 'Describes the permissions for your network interfaces. ' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeNetworkInterfacePermissionsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeNetworkInterfacePermissionsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeNetworkInterfaces&Version=2016-11-15: - get: - x-aws-operation-name: DescribeNetworkInterfaces - operationId: GET_DescribeNetworkInterfaces - description: Describes one or more of your network interfaces. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeNetworkInterfacesResult' - parameters: - - name: Filter - in: query - required: false - description: '

One or more filters.

  • addresses.private-ip-address - The private IPv4 addresses associated with the network interface.

  • addresses.primary - Whether the private IPv4 address is the primary IP address associated with the network interface.

  • addresses.association.public-ip - The association ID returned when the network interface was associated with the Elastic IP address (IPv4).

  • addresses.association.owner-id - The owner ID of the addresses associated with the network interface.

  • association.association-id - The association ID returned when the network interface was associated with an IPv4 address.

  • association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.

  • association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface.

  • association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.

  • association.public-dns-name - The public DNS name for the network interface (IPv4).

  • attachment.attachment-id - The ID of the interface attachment.

  • attachment.attach-time - The time that the network interface was attached to an instance.

  • attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is terminated.

  • attachment.device-index - The device index to which the network interface is attached.

  • attachment.instance-id - The ID of the instance to which the network interface is attached.

  • attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.

  • attachment.status - The status of the attachment (attaching | attached | detaching | detached).

  • availability-zone - The Availability Zone of the network interface.

  • description - The description of the network interface.

  • group-id - The ID of a security group associated with the network interface.

  • group-name - The name of a security group associated with the network interface.

  • ipv6-addresses.ipv6-address - An IPv6 address associated with the network interface.

  • interface-type - The type of network interface (api_gateway_managed | aws_codestar_connections_managed | branch | efa | gateway_load_balancer | gateway_load_balancer_endpoint | global_accelerator_managed | interface | iot_rules_managed | lambda | load_balancer | nat_gateway | network_load_balancer | quicksight | transit_gateway | trunk | vpc_endpoint).

  • mac-address - The MAC address of the network interface.

  • network-interface-id - The ID of the network interface.

  • owner-id - The Amazon Web Services account ID of the network interface owner.

  • private-ip-address - The private IPv4 address or addresses of the network interface.

  • private-dns-name - The private DNS name of the network interface (IPv4).

  • requester-id - The alias or Amazon Web Services account ID of the principal or service that created the network interface.

  • requester-managed - Indicates whether the network interface is being managed by an Amazon Web Service (for example, Amazon Web Services Management Console, Auto Scaling, and so on).

  • source-dest-check - Indicates whether the network interface performs source/destination checking. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.

  • status - The status of the network interface. If the network interface is not attached to an instance, the status is available; if a network interface is attached to an instance the status is in-use.

  • subnet-id - The ID of the subnet for the network interface.

  • tag:<key> - 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. 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.

  • 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.

  • vpc-id - The ID of the VPC for the network interface.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: NetworkInterfaceId - in: query - required: false - description: '

One or more network interface IDs.

Default: Describes all your network interfaces.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/NetworkInterfaceId' - - xml: - name: item - - name: NextToken - in: query - required: false - description: The token to retrieve the next page of results. - schema: - type: string - - name: MaxResults - in: query - required: false - description: The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results. You cannot specify this parameter and the network interface IDs parameter in the same request. - schema: - type: integer - minimum: 5 - maximum: 1000 - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeNetworkInterfaces - operationId: POST_DescribeNetworkInterfaces - description: Describes one or more of your network interfaces. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeNetworkInterfacesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeNetworkInterfacesRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribePlacementGroups&Version=2016-11-15: - get: - x-aws-operation-name: DescribePlacementGroups - operationId: GET_DescribePlacementGroups - description: 'Describes the specified placement groups or all of your placement groups. For more information, see Placement groups in the Amazon EC2 User Guide.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribePlacementGroupsResult' - parameters: - - name: Filter - in: query - required: false - description: '

The filters.

  • group-name - The name of the placement group.

  • group-arn - The Amazon Resource Name (ARN) of the placement group.

  • state - The state of the placement group (pending | available | deleting | deleted).

  • strategy - The strategy of the placement group (cluster | spread | partition).

  • tag:<key> - 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. 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.

  • 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.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: GroupName - in: query - required: false - description: '

The names of the placement groups.

Default: Describes all your placement groups, or only those otherwise specified.

' - schema: - type: array - items: - $ref: '#/components/schemas/PlacementGroupName' - - name: GroupId - in: query - required: false - description: The IDs of the placement groups. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/PlacementGroupId' - - xml: - name: GroupId - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribePlacementGroups - operationId: POST_DescribePlacementGroups - description: 'Describes the specified placement groups or all of your placement groups. For more information, see Placement groups in the Amazon EC2 User Guide.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribePlacementGroupsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribePlacementGroupsRequest' - parameters: [] - /?Action=DescribePrefixLists&Version=2016-11-15: - get: - x-aws-operation-name: DescribePrefixLists - operationId: GET_DescribePrefixLists - description: '

Describes available Amazon Web Services services in a prefix list format, which includes the prefix list name and prefix list ID of the service and the IP address range for the service.

We recommend that you use DescribeManagedPrefixLists instead.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribePrefixListsResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: Filter - in: query - required: false - description: '

One or more filters.

  • prefix-list-id: The ID of a prefix list.

  • prefix-list-name: The name of a prefix list.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - schema: - type: integer - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - - name: PrefixListId - in: query - required: false - description: One or more prefix list IDs. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/PrefixListResourceId' - - xml: - name: item - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribePrefixLists - operationId: POST_DescribePrefixLists - description: '

Describes available Amazon Web Services services in a prefix list format, which includes the prefix list name and prefix list ID of the service and the IP address range for the service.

We recommend that you use DescribeManagedPrefixLists instead.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribePrefixListsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribePrefixListsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribePrincipalIdFormat&Version=2016-11-15: - get: - x-aws-operation-name: DescribePrincipalIdFormat - operationId: GET_DescribePrincipalIdFormat - description: '

Describes the ID format settings for the root user and all IAM roles and IAM users that have explicitly specified a longer ID (17-character ID) preference.

By default, all IAM roles and IAM users default to the same ID settings as the root user, unless they explicitly override the settings. This request is useful for identifying those IAM users and IAM roles that have overridden the default ID settings.

The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribePrincipalIdFormatResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: Resource - in: query - required: false - description: 'The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway ' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. ' - schema: - type: integer - minimum: 1 - maximum: 1000 - - name: NextToken - in: query - required: false - description: The token to request the next page of results. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribePrincipalIdFormat - operationId: POST_DescribePrincipalIdFormat - description: '

Describes the ID format settings for the root user and all IAM roles and IAM users that have explicitly specified a longer ID (17-character ID) preference.

By default, all IAM roles and IAM users default to the same ID settings as the root user, unless they explicitly override the settings. This request is useful for identifying those IAM users and IAM roles that have overridden the default ID settings.

The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribePrincipalIdFormatResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribePrincipalIdFormatRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribePublicIpv4Pools&Version=2016-11-15: - get: - x-aws-operation-name: DescribePublicIpv4Pools - operationId: GET_DescribePublicIpv4Pools - description: Describes the specified IPv4 address pools. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribePublicIpv4PoolsResult' - parameters: - - name: PoolId - in: query - required: false - description: The IDs of the address pools. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Ipv4PoolEc2Id' - - xml: - name: item - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - schema: - type: integer - minimum: 1 - maximum: 10 - - name: Filter - in: query - required: false - description: '

One or more filters.

  • tag:<key> - 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. 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.

  • 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.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribePublicIpv4Pools - operationId: POST_DescribePublicIpv4Pools - description: Describes the specified IPv4 address pools. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribePublicIpv4PoolsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribePublicIpv4PoolsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeRegions&Version=2016-11-15: - get: - x-aws-operation-name: DescribeRegions - operationId: GET_DescribeRegions - description: '

Describes the Regions that are enabled for your account, or all Regions.

For a list of the Regions supported by Amazon EC2, see Amazon Elastic Compute Cloud endpoints and quotas.

For information about enabling and disabling Regions for your account, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeRegionsResult' - parameters: - - name: Filter - in: query - required: false - description: '

The filters.

  • endpoint - The endpoint of the Region (for example, ec2.us-east-1.amazonaws.com).

  • opt-in-status - The opt-in status of the Region (opt-in-not-required | opted-in | not-opted-in).

  • region-name - The name of the Region (for example, us-east-1).

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: RegionName - in: query - required: false - description: 'The names of the Regions. You can specify any Regions, whether they are enabled and disabled for your account.' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: RegionName - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: AllRegions - in: query - required: false - description: 'Indicates whether to display all Regions, including Regions that are disabled for your account.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeRegions - operationId: POST_DescribeRegions - description: '

Describes the Regions that are enabled for your account, or all Regions.

For a list of the Regions supported by Amazon EC2, see Amazon Elastic Compute Cloud endpoints and quotas.

For information about enabling and disabling Regions for your account, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeRegionsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeRegionsRequest' - parameters: [] - /?Action=DescribeReplaceRootVolumeTasks&Version=2016-11-15: - get: - x-aws-operation-name: DescribeReplaceRootVolumeTasks - operationId: GET_DescribeReplaceRootVolumeTasks - description: 'Describes a root volume replacement task. For more information, see Replace a root volume in the Amazon Elastic Compute Cloud User Guide.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeReplaceRootVolumeTasksResult' - parameters: - - name: ReplaceRootVolumeTaskId - in: query - required: false - description: The ID of the root volume replacement task to view. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/ReplaceRootVolumeTaskId' - - xml: - name: ReplaceRootVolumeTaskId - - name: Filter - in: query - required: false - description: '

Filter to use:

  • instance-id - The ID of the instance for which the root volume replacement task was created.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - schema: - type: integer - minimum: 1 - maximum: 50 - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeReplaceRootVolumeTasks - operationId: POST_DescribeReplaceRootVolumeTasks - description: 'Describes a root volume replacement task. For more information, see Replace a root volume in the Amazon Elastic Compute Cloud User Guide.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeReplaceRootVolumeTasksResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeReplaceRootVolumeTasksRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeReservedInstances&Version=2016-11-15: - get: - x-aws-operation-name: DescribeReservedInstances - operationId: GET_DescribeReservedInstances - description: '

Describes one or more of the Reserved Instances that you purchased.

For more information about Reserved Instances, see Reserved Instances in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeReservedInstancesResult' - parameters: - - name: Filter - in: query - required: false - description: '

One or more filters.

  • availability-zone - The Availability Zone where the Reserved Instance can be used.

  • duration - The duration of the Reserved Instance (one year or three years), in seconds (31536000 | 94608000).

  • end - The time when the Reserved Instance expires (for example, 2015-08-07T11:54:42.000Z).

  • fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).

  • instance-type - The instance type that is covered by the reservation.

  • scope - The scope of the Reserved Instance (Region or Availability Zone).

  • product-description - The Reserved Instance product platform description. Instances that include (Amazon VPC) in the product platform description will only be displayed to EC2-Classic account holders and are for use with Amazon VPC (Linux/UNIX | Linux/UNIX (Amazon VPC) | SUSE Linux | SUSE Linux (Amazon VPC) | Red Hat Enterprise Linux | Red Hat Enterprise Linux (Amazon VPC) | Red Hat Enterprise Linux with HA (Amazon VPC) | Windows | Windows (Amazon VPC) | Windows with SQL Server Standard | Windows with SQL Server Standard (Amazon VPC) | Windows with SQL Server Web | Windows with SQL Server Web (Amazon VPC) | Windows with SQL Server Enterprise | Windows with SQL Server Enterprise (Amazon VPC)).

  • reserved-instances-id - The ID of the Reserved Instance.

  • start - The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z).

  • state - The state of the Reserved Instance (payment-pending | active | payment-failed | retired).

  • tag:<key> - 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. 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.

  • 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.

  • usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: OfferingClass - in: query - required: false - description: Describes whether the Reserved Instance is Standard or Convertible. - schema: - type: string - enum: - - standard - - convertible - - name: ReservedInstancesId - in: query - required: false - description: '

One or more Reserved Instance IDs.

Default: Describes all your Reserved Instances, or only those otherwise specified.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/ReservationId' - - xml: - name: ReservedInstancesId - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: OfferingType - in: query - required: false - description: 'The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.' - schema: - type: string - enum: - - Heavy Utilization - - Medium Utilization - - Light Utilization - - No Upfront - - Partial Upfront - - All Upfront - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeReservedInstances - operationId: POST_DescribeReservedInstances - description: '

Describes one or more of the Reserved Instances that you purchased.

For more information about Reserved Instances, see Reserved Instances in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeReservedInstancesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeReservedInstancesRequest' - parameters: [] - /?Action=DescribeReservedInstancesListings&Version=2016-11-15: - get: - x-aws-operation-name: DescribeReservedInstancesListings - operationId: GET_DescribeReservedInstancesListings - description: '

Describes your account''s Reserved Instance listings in the Reserved Instance Marketplace.

The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.

As a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase.

As a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you''re searching for with what''s available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase.

For more information, see Reserved Instance Marketplace in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeReservedInstancesListingsResult' - parameters: - - name: Filter - in: query - required: false - description:

One or more filters.

  • reserved-instances-id - The ID of the Reserved Instances.

  • reserved-instances-listing-id - The ID of the Reserved Instances listing.

  • status - The status of the Reserved Instance listing (pending | active | cancelled | closed).

  • status-message - The reason for the status.

- schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: ReservedInstancesId - in: query - required: false - description: One or more Reserved Instance IDs. - schema: - type: string - - name: ReservedInstancesListingId - in: query - required: false - description: One or more Reserved Instance listing IDs. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeReservedInstancesListings - operationId: POST_DescribeReservedInstancesListings - description: '

Describes your account''s Reserved Instance listings in the Reserved Instance Marketplace.

The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.

As a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase.

As a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you''re searching for with what''s available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase.

For more information, see Reserved Instance Marketplace in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeReservedInstancesListingsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeReservedInstancesListingsRequest' - parameters: [] - /?Action=DescribeReservedInstancesModifications&Version=2016-11-15: - get: - x-aws-operation-name: DescribeReservedInstancesModifications - operationId: GET_DescribeReservedInstancesModifications - description: '

Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned.

For more information, see Modifying Reserved Instances in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeReservedInstancesModificationsResult' - parameters: - - name: Filter - in: query - required: false - description:

One or more filters.

  • client-token - The idempotency token for the modification request.

  • create-date - The time when the modification request was created.

  • effective-date - The time when the modification becomes effective.

  • modification-result.reserved-instances-id - The ID for the Reserved Instances created as part of the modification request. This ID is only available when the status of the modification is fulfilled.

  • modification-result.target-configuration.availability-zone - The Availability Zone for the new Reserved Instances.

  • modification-result.target-configuration.instance-count - The number of new Reserved Instances.

  • modification-result.target-configuration.instance-type - The instance type of the new Reserved Instances.

  • modification-result.target-configuration.platform - The network platform of the new Reserved Instances (EC2-Classic | EC2-VPC).

  • reserved-instances-id - The ID of the Reserved Instances modified.

  • reserved-instances-modification-id - The ID of the modification request.

  • status - The status of the Reserved Instances modification request (processing | fulfilled | failed).

  • status-message - The reason for the status.

  • update-date - The time when the modification request was last updated.

- schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: ReservedInstancesModificationId - in: query - required: false - description: IDs for the submitted modification request. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/ReservedInstancesModificationId' - - xml: - name: ReservedInstancesModificationId - - name: NextToken - in: query - required: false - description: The token to retrieve the next page of results. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeReservedInstancesModifications - operationId: POST_DescribeReservedInstancesModifications - description: '

Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned.

For more information, see Modifying Reserved Instances in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeReservedInstancesModificationsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeReservedInstancesModificationsRequest' - parameters: - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeReservedInstancesOfferings&Version=2016-11-15: - get: - x-aws-operation-name: DescribeReservedInstancesOfferings - operationId: GET_DescribeReservedInstancesOfferings - description: '

Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used.

If you have listed your own Reserved Instances for sale in the Reserved Instance Marketplace, they will be excluded from these results. This is to ensure that you do not purchase your own Reserved Instances.

For more information, see Reserved Instance Marketplace in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeReservedInstancesOfferingsResult' - parameters: - - name: AvailabilityZone - in: query - required: false - description: The Availability Zone in which the Reserved Instance can be used. - schema: - type: string - - name: Filter - in: query - required: false - description: '

One or more filters.

  • availability-zone - The Availability Zone where the Reserved Instance can be used.

  • duration - The duration of the Reserved Instance (for example, one year or three years), in seconds (31536000 | 94608000).

  • fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).

  • instance-type - The instance type that is covered by the reservation.

  • marketplace - Set to true to show only Reserved Instance Marketplace offerings. When this filter is not used, which is the default behavior, all offerings from both Amazon Web Services and the Reserved Instance Marketplace are listed.

  • product-description - The Reserved Instance product platform description. Instances that include (Amazon VPC) in the product platform description will only be displayed to EC2-Classic account holders and are for use with Amazon VPC. (Linux/UNIX | Linux/UNIX (Amazon VPC) | SUSE Linux | SUSE Linux (Amazon VPC) | Red Hat Enterprise Linux | Red Hat Enterprise Linux (Amazon VPC) | Red Hat Enterprise Linux with HA (Amazon VPC) | Windows | Windows (Amazon VPC) | Windows with SQL Server Standard | Windows with SQL Server Standard (Amazon VPC) | Windows with SQL Server Web | Windows with SQL Server Web (Amazon VPC) | Windows with SQL Server Enterprise | Windows with SQL Server Enterprise (Amazon VPC))

  • reserved-instances-offering-id - The Reserved Instances offering ID.

  • scope - The scope of the Reserved Instance (Availability Zone or Region).

  • usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: IncludeMarketplace - in: query - required: false - description: Include Reserved Instance Marketplace offerings in the response. - schema: - type: boolean - - name: InstanceType - in: query - required: false - description: 'The instance type that the reservation will cover (for example, m1.small). For more information, see Instance types in the Amazon EC2 User Guide.' - schema: - type: string - enum: - - a1.medium - - a1.large - - a1.xlarge - - a1.2xlarge - - a1.4xlarge - - a1.metal - - c1.medium - - c1.xlarge - - c3.large - - c3.xlarge - - c3.2xlarge - - c3.4xlarge - - c3.8xlarge - - c4.large - - c4.xlarge - - c4.2xlarge - - c4.4xlarge - - c4.8xlarge - - c5.large - - c5.xlarge - - c5.2xlarge - - c5.4xlarge - - c5.9xlarge - - c5.12xlarge - - c5.18xlarge - - c5.24xlarge - - c5.metal - - c5a.large - - c5a.xlarge - - c5a.2xlarge - - c5a.4xlarge - - c5a.8xlarge - - c5a.12xlarge - - c5a.16xlarge - - c5a.24xlarge - - c5ad.large - - c5ad.xlarge - - c5ad.2xlarge - - c5ad.4xlarge - - c5ad.8xlarge - - c5ad.12xlarge - - c5ad.16xlarge - - c5ad.24xlarge - - c5d.large - - c5d.xlarge - - c5d.2xlarge - - c5d.4xlarge - - c5d.9xlarge - - c5d.12xlarge - - c5d.18xlarge - - c5d.24xlarge - - c5d.metal - - c5n.large - - c5n.xlarge - - c5n.2xlarge - - c5n.4xlarge - - c5n.9xlarge - - c5n.18xlarge - - c5n.metal - - c6g.medium - - c6g.large - - c6g.xlarge - - c6g.2xlarge - - c6g.4xlarge - - c6g.8xlarge - - c6g.12xlarge - - c6g.16xlarge - - c6g.metal - - c6gd.medium - - c6gd.large - - c6gd.xlarge - - c6gd.2xlarge - - c6gd.4xlarge - - c6gd.8xlarge - - c6gd.12xlarge - - c6gd.16xlarge - - c6gd.metal - - c6gn.medium - - c6gn.large - - c6gn.xlarge - - c6gn.2xlarge - - c6gn.4xlarge - - c6gn.8xlarge - - c6gn.12xlarge - - c6gn.16xlarge - - c6i.large - - c6i.xlarge - - c6i.2xlarge - - c6i.4xlarge - - c6i.8xlarge - - c6i.12xlarge - - c6i.16xlarge - - c6i.24xlarge - - c6i.32xlarge - - c6i.metal - - cc1.4xlarge - - cc2.8xlarge - - cg1.4xlarge - - cr1.8xlarge - - d2.xlarge - - d2.2xlarge - - d2.4xlarge - - d2.8xlarge - - d3.xlarge - - d3.2xlarge - - d3.4xlarge - - d3.8xlarge - - d3en.xlarge - - d3en.2xlarge - - d3en.4xlarge - - d3en.6xlarge - - d3en.8xlarge - - d3en.12xlarge - - dl1.24xlarge - - f1.2xlarge - - f1.4xlarge - - f1.16xlarge - - g2.2xlarge - - g2.8xlarge - - g3.4xlarge - - g3.8xlarge - - g3.16xlarge - - g3s.xlarge - - g4ad.xlarge - - g4ad.2xlarge - - g4ad.4xlarge - - g4ad.8xlarge - - g4ad.16xlarge - - g4dn.xlarge - - g4dn.2xlarge - - g4dn.4xlarge - - g4dn.8xlarge - - g4dn.12xlarge - - g4dn.16xlarge - - g4dn.metal - - g5.xlarge - - g5.2xlarge - - g5.4xlarge - - g5.8xlarge - - g5.12xlarge - - g5.16xlarge - - g5.24xlarge - - g5.48xlarge - - g5g.xlarge - - g5g.2xlarge - - g5g.4xlarge - - g5g.8xlarge - - g5g.16xlarge - - g5g.metal - - hi1.4xlarge - - hpc6a.48xlarge - - hs1.8xlarge - - h1.2xlarge - - h1.4xlarge - - h1.8xlarge - - h1.16xlarge - - i2.xlarge - - i2.2xlarge - - i2.4xlarge - - i2.8xlarge - - i3.large - - i3.xlarge - - i3.2xlarge - - i3.4xlarge - - i3.8xlarge - - i3.16xlarge - - i3.metal - - i3en.large - - i3en.xlarge - - i3en.2xlarge - - i3en.3xlarge - - i3en.6xlarge - - i3en.12xlarge - - i3en.24xlarge - - i3en.metal - - im4gn.large - - im4gn.xlarge - - im4gn.2xlarge - - im4gn.4xlarge - - im4gn.8xlarge - - im4gn.16xlarge - - inf1.xlarge - - inf1.2xlarge - - inf1.6xlarge - - inf1.24xlarge - - is4gen.medium - - is4gen.large - - is4gen.xlarge - - is4gen.2xlarge - - is4gen.4xlarge - - is4gen.8xlarge - - m1.small - - m1.medium - - m1.large - - m1.xlarge - - m2.xlarge - - m2.2xlarge - - m2.4xlarge - - m3.medium - - m3.large - - m3.xlarge - - m3.2xlarge - - m4.large - - m4.xlarge - - m4.2xlarge - - m4.4xlarge - - m4.10xlarge - - m4.16xlarge - - m5.large - - m5.xlarge - - m5.2xlarge - - m5.4xlarge - - m5.8xlarge - - m5.12xlarge - - m5.16xlarge - - m5.24xlarge - - m5.metal - - m5a.large - - m5a.xlarge - - m5a.2xlarge - - m5a.4xlarge - - m5a.8xlarge - - m5a.12xlarge - - m5a.16xlarge - - m5a.24xlarge - - m5ad.large - - m5ad.xlarge - - m5ad.2xlarge - - m5ad.4xlarge - - m5ad.8xlarge - - m5ad.12xlarge - - m5ad.16xlarge - - m5ad.24xlarge - - m5d.large - - m5d.xlarge - - m5d.2xlarge - - m5d.4xlarge - - m5d.8xlarge - - m5d.12xlarge - - m5d.16xlarge - - m5d.24xlarge - - m5d.metal - - m5dn.large - - m5dn.xlarge - - m5dn.2xlarge - - m5dn.4xlarge - - m5dn.8xlarge - - m5dn.12xlarge - - m5dn.16xlarge - - m5dn.24xlarge - - m5dn.metal - - m5n.large - - m5n.xlarge - - m5n.2xlarge - - m5n.4xlarge - - m5n.8xlarge - - m5n.12xlarge - - m5n.16xlarge - - m5n.24xlarge - - m5n.metal - - m5zn.large - - m5zn.xlarge - - m5zn.2xlarge - - m5zn.3xlarge - - m5zn.6xlarge - - m5zn.12xlarge - - m5zn.metal - - m6a.large - - m6a.xlarge - - m6a.2xlarge - - m6a.4xlarge - - m6a.8xlarge - - m6a.12xlarge - - m6a.16xlarge - - m6a.24xlarge - - m6a.32xlarge - - m6a.48xlarge - - m6g.metal - - m6g.medium - - m6g.large - - m6g.xlarge - - m6g.2xlarge - - m6g.4xlarge - - m6g.8xlarge - - m6g.12xlarge - - m6g.16xlarge - - m6gd.metal - - m6gd.medium - - m6gd.large - - m6gd.xlarge - - m6gd.2xlarge - - m6gd.4xlarge - - m6gd.8xlarge - - m6gd.12xlarge - - m6gd.16xlarge - - m6i.large - - m6i.xlarge - - m6i.2xlarge - - m6i.4xlarge - - m6i.8xlarge - - m6i.12xlarge - - m6i.16xlarge - - m6i.24xlarge - - m6i.32xlarge - - m6i.metal - - mac1.metal - - p2.xlarge - - p2.8xlarge - - p2.16xlarge - - p3.2xlarge - - p3.8xlarge - - p3.16xlarge - - p3dn.24xlarge - - p4d.24xlarge - - r3.large - - r3.xlarge - - r3.2xlarge - - r3.4xlarge - - r3.8xlarge - - r4.large - - r4.xlarge - - r4.2xlarge - - r4.4xlarge - - r4.8xlarge - - r4.16xlarge - - r5.large - - r5.xlarge - - r5.2xlarge - - r5.4xlarge - - r5.8xlarge - - r5.12xlarge - - r5.16xlarge - - r5.24xlarge - - r5.metal - - r5a.large - - r5a.xlarge - - r5a.2xlarge - - r5a.4xlarge - - r5a.8xlarge - - r5a.12xlarge - - r5a.16xlarge - - r5a.24xlarge - - r5ad.large - - r5ad.xlarge - - r5ad.2xlarge - - r5ad.4xlarge - - r5ad.8xlarge - - r5ad.12xlarge - - r5ad.16xlarge - - r5ad.24xlarge - - r5b.large - - r5b.xlarge - - r5b.2xlarge - - r5b.4xlarge - - r5b.8xlarge - - r5b.12xlarge - - r5b.16xlarge - - r5b.24xlarge - - r5b.metal - - r5d.large - - r5d.xlarge - - r5d.2xlarge - - r5d.4xlarge - - r5d.8xlarge - - r5d.12xlarge - - r5d.16xlarge - - r5d.24xlarge - - r5d.metal - - r5dn.large - - r5dn.xlarge - - r5dn.2xlarge - - r5dn.4xlarge - - r5dn.8xlarge - - r5dn.12xlarge - - r5dn.16xlarge - - r5dn.24xlarge - - r5dn.metal - - r5n.large - - r5n.xlarge - - r5n.2xlarge - - r5n.4xlarge - - r5n.8xlarge - - r5n.12xlarge - - r5n.16xlarge - - r5n.24xlarge - - r5n.metal - - r6g.medium - - r6g.large - - r6g.xlarge - - r6g.2xlarge - - r6g.4xlarge - - r6g.8xlarge - - r6g.12xlarge - - r6g.16xlarge - - r6g.metal - - r6gd.medium - - r6gd.large - - r6gd.xlarge - - r6gd.2xlarge - - r6gd.4xlarge - - r6gd.8xlarge - - r6gd.12xlarge - - r6gd.16xlarge - - r6gd.metal - - r6i.large - - r6i.xlarge - - r6i.2xlarge - - r6i.4xlarge - - r6i.8xlarge - - r6i.12xlarge - - r6i.16xlarge - - r6i.24xlarge - - r6i.32xlarge - - r6i.metal - - t1.micro - - t2.nano - - t2.micro - - t2.small - - t2.medium - - t2.large - - t2.xlarge - - t2.2xlarge - - t3.nano - - t3.micro - - t3.small - - t3.medium - - t3.large - - t3.xlarge - - t3.2xlarge - - t3a.nano - - t3a.micro - - t3a.small - - t3a.medium - - t3a.large - - t3a.xlarge - - t3a.2xlarge - - t4g.nano - - t4g.micro - - t4g.small - - t4g.medium - - t4g.large - - t4g.xlarge - - t4g.2xlarge - - u-6tb1.56xlarge - - u-6tb1.112xlarge - - u-9tb1.112xlarge - - u-12tb1.112xlarge - - u-6tb1.metal - - u-9tb1.metal - - u-12tb1.metal - - u-18tb1.metal - - u-24tb1.metal - - vt1.3xlarge - - vt1.6xlarge - - vt1.24xlarge - - x1.16xlarge - - x1.32xlarge - - x1e.xlarge - - x1e.2xlarge - - x1e.4xlarge - - x1e.8xlarge - - x1e.16xlarge - - x1e.32xlarge - - x2iezn.2xlarge - - x2iezn.4xlarge - - x2iezn.6xlarge - - x2iezn.8xlarge - - x2iezn.12xlarge - - x2iezn.metal - - x2gd.medium - - x2gd.large - - x2gd.xlarge - - x2gd.2xlarge - - x2gd.4xlarge - - x2gd.8xlarge - - x2gd.12xlarge - - x2gd.16xlarge - - x2gd.metal - - z1d.large - - z1d.xlarge - - z1d.2xlarge - - z1d.3xlarge - - z1d.6xlarge - - z1d.12xlarge - - z1d.metal - - x2idn.16xlarge - - x2idn.24xlarge - - x2idn.32xlarge - - x2iedn.xlarge - - x2iedn.2xlarge - - x2iedn.4xlarge - - x2iedn.8xlarge - - x2iedn.16xlarge - - x2iedn.24xlarge - - x2iedn.32xlarge - - c6a.large - - c6a.xlarge - - c6a.2xlarge - - c6a.4xlarge - - c6a.8xlarge - - c6a.12xlarge - - c6a.16xlarge - - c6a.24xlarge - - c6a.32xlarge - - c6a.48xlarge - - c6a.metal - - m6a.metal - - i4i.large - - i4i.xlarge - - i4i.2xlarge - - i4i.4xlarge - - i4i.8xlarge - - i4i.16xlarge - - i4i.32xlarge - - name: MaxDuration - in: query - required: false - description: '

The maximum duration (in seconds) to filter when searching for offerings.

Default: 94608000 (3 years)

' - schema: - type: integer - - name: MaxInstanceCount - in: query - required: false - description: '

The maximum number of instances to filter when searching for offerings.

Default: 20

' - schema: - type: integer - - name: MinDuration - in: query - required: false - description: '

The minimum duration (in seconds) to filter when searching for offerings.

Default: 2592000 (1 month)

' - schema: - type: integer - - name: OfferingClass - in: query - required: false - description: The offering class of the Reserved Instance. Can be standard or convertible. - schema: - type: string - enum: - - standard - - convertible - - name: ProductDescription - in: query - required: false - description: The Reserved Instance product platform description. Instances that include (Amazon VPC) in the description are for use with Amazon VPC. - schema: - type: string - enum: - - Linux/UNIX - - Linux/UNIX (Amazon VPC) - - Windows - - Windows (Amazon VPC) - - name: ReservedInstancesOfferingId - in: query - required: false - description: One or more Reserved Instances offering IDs. - schema: - type: array - items: - $ref: '#/components/schemas/ReservedInstancesOfferingId' - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: InstanceTenancy - in: query - required: false - description: '

The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy of dedicated is applied to instances that run in a VPC on single-tenant hardware (i.e., Dedicated Instances).

Important: The host value cannot be used with this parameter. Use the default or dedicated values only.

Default: default

' - schema: - type: string - enum: - - default - - dedicated - - host - - name: MaxResults - in: query - required: false - description: '

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. The maximum is 100.

Default: 100

' - schema: - type: integer - - name: NextToken - in: query - required: false - description: The token to retrieve the next page of results. - schema: - type: string - - name: OfferingType - in: query - required: false - description: 'The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type. ' - schema: - type: string - enum: - - Heavy Utilization - - Medium Utilization - - Light Utilization - - No Upfront - - Partial Upfront - - All Upfront - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeReservedInstancesOfferings - operationId: POST_DescribeReservedInstancesOfferings - description: '

Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used.

If you have listed your own Reserved Instances for sale in the Reserved Instance Marketplace, they will be excluded from these results. This is to ensure that you do not purchase your own Reserved Instances.

For more information, see Reserved Instance Marketplace in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeReservedInstancesOfferingsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeReservedInstancesOfferingsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeRouteTables&Version=2016-11-15: - get: - x-aws-operation-name: DescribeRouteTables - operationId: GET_DescribeRouteTables - description: '

Describes one or more of your route tables.

Each subnet in your VPC must be associated with a route table. If a subnet is not explicitly associated with any route table, it is implicitly associated with the main route table. This command does not return the subnet ID for implicit associations.

For more information, see Route tables in the Amazon Virtual Private Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeRouteTablesResult' - parameters: - - name: Filter - in: query - required: false - description: '

One or more filters.

  • association.route-table-association-id - The ID of an association ID for the route table.

  • association.route-table-id - The ID of the route table involved in the association.

  • association.subnet-id - The ID of the subnet involved in the association.

  • association.main - Indicates whether the route table is the main route table for the VPC (true | false). Route tables that do not have an association ID are not returned in the response.

  • owner-id - The ID of the Amazon Web Services account that owns the route table.

  • route-table-id - The ID of the route table.

  • route.destination-cidr-block - The IPv4 CIDR range specified in a route in the table.

  • route.destination-ipv6-cidr-block - The IPv6 CIDR range specified in a route in the route table.

  • route.destination-prefix-list-id - The ID (prefix) of the Amazon Web Service specified in a route in the table.

  • route.egress-only-internet-gateway-id - The ID of an egress-only Internet gateway specified in a route in the route table.

  • route.gateway-id - The ID of a gateway specified in a route in the table.

  • route.instance-id - The ID of an instance specified in a route in the table.

  • route.nat-gateway-id - The ID of a NAT gateway.

  • route.transit-gateway-id - The ID of a transit gateway.

  • route.origin - Describes how the route was created. CreateRouteTable indicates that the route was automatically created when the route table was created; CreateRoute indicates that the route was manually added to the route table; EnableVgwRoutePropagation indicates that the route was propagated by route propagation.

  • route.state - The state of a route in the route table (active | blackhole). The blackhole state indicates that the route''s target isn''t available (for example, the specified gateway isn''t attached to the VPC, the specified NAT instance has been terminated, and so on).

  • route.vpc-peering-connection-id - The ID of a VPC peering connection specified in a route in the table.

  • tag:<key> - 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. 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.

  • 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.

  • vpc-id - The ID of the VPC for the route table.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: RouteTableId - in: query - required: false - description: '

One or more route table IDs.

Default: Describes all your route tables.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/RouteTableId' - - xml: - name: item - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - schema: - type: integer - minimum: 5 - maximum: 100 - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeRouteTables - operationId: POST_DescribeRouteTables - description: '

Describes one or more of your route tables.

Each subnet in your VPC must be associated with a route table. If a subnet is not explicitly associated with any route table, it is implicitly associated with the main route table. This command does not return the subnet ID for implicit associations.

For more information, see Route tables in the Amazon Virtual Private Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeRouteTablesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeRouteTablesRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeScheduledInstanceAvailability&Version=2016-11-15: - get: - x-aws-operation-name: DescribeScheduledInstanceAvailability - operationId: GET_DescribeScheduledInstanceAvailability - description: '

Finds available schedules that meet the specified criteria.

You can search for an available schedule no more than 3 months in advance. You must meet the minimum required duration of 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.

After you find a schedule that meets your needs, call PurchaseScheduledInstances to purchase Scheduled Instances with that schedule.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeScheduledInstanceAvailabilityResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: Filter - in: query - required: false - description: '

The filters.

  • availability-zone - The Availability Zone (for example, us-west-2a).

  • instance-type - The instance type (for example, c4.large).

  • network-platform - The network platform (EC2-Classic or EC2-VPC).

  • platform - The platform (Linux/UNIX or Windows).

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: FirstSlotStartTimeRange - in: query - required: true - description: The time period for the first schedule to start. - schema: - type: object - required: - - EarliestTime - - LatestTime - properties: - undefined: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: 'The latest date and time, in UTC, for the Scheduled Instance to start. This value must be later than or equal to the earliest date and at most three months in the future.' - description: Describes the time period for a Scheduled Instance to start its first schedule. The time period must span less than one day. - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return in a single call. This value can be between 5 and 300. The default value is 300. To retrieve the remaining results, make another call with the returned NextToken value.' - schema: - type: integer - minimum: 5 - maximum: 300 - - name: MaxSlotDurationInHours - in: query - required: false - description: 'The maximum available duration, in hours. This value must be greater than MinSlotDurationInHours and less than 1,720.' - schema: - type: integer - - name: MinSlotDurationInHours - in: query - required: false - description: 'The minimum available duration, in hours. The minimum required duration is 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.' - schema: - type: integer - - name: NextToken - in: query - required: false - description: The token for the next set of results. - schema: - type: string - - name: Recurrence - in: query - required: true - description: The schedule recurrence. - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The interval quantity. The interval unit depends on the value of Frequency. For example, every 2 weeks or every 2 months.' - OccurrenceDay: - allOf: - - $ref: '#/components/schemas/String' - - description: The unit for OccurrenceDays (DayOfWeek or DayOfMonth). This value is required for a monthly schedule. You can't specify DayOfWeek with a weekly schedule. You can't specify this value with a daily schedule. - description: Describes the recurring schedule for a Scheduled Instance. - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeScheduledInstanceAvailability - operationId: POST_DescribeScheduledInstanceAvailability - description: '

Finds available schedules that meet the specified criteria.

You can search for an available schedule no more than 3 months in advance. You must meet the minimum required duration of 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.

After you find a schedule that meets your needs, call PurchaseScheduledInstances to purchase Scheduled Instances with that schedule.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeScheduledInstanceAvailabilityResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeScheduledInstanceAvailabilityRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeScheduledInstances&Version=2016-11-15: - get: - x-aws-operation-name: DescribeScheduledInstances - operationId: GET_DescribeScheduledInstances - description: Describes the specified Scheduled Instances or all your Scheduled Instances. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeScheduledInstancesResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: Filter - in: query - required: false - description: '

The filters.

  • availability-zone - The Availability Zone (for example, us-west-2a).

  • instance-type - The instance type (for example, c4.large).

  • network-platform - The network platform (EC2-Classic or EC2-VPC).

  • platform - The platform (Linux/UNIX or Windows).

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return in a single call. This value can be between 5 and 300. The default value is 100. To retrieve the remaining results, make another call with the returned NextToken value.' - schema: - type: integer - - name: NextToken - in: query - required: false - description: The token for the next set of results. - schema: - type: string - - name: ScheduledInstanceId - in: query - required: false - description: The Scheduled Instance IDs. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/ScheduledInstanceId' - - xml: - name: ScheduledInstanceId - - name: SlotStartTimeRange - in: query - required: false - description: The time period for the first schedule to start. - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: 'The latest date and time, in UTC, for the Scheduled Instance to start.' - description: Describes the time period for a Scheduled Instance to start its first schedule. - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeScheduledInstances - operationId: POST_DescribeScheduledInstances - description: Describes the specified Scheduled Instances or all your Scheduled Instances. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeScheduledInstancesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeScheduledInstancesRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeSecurityGroupReferences&Version=2016-11-15: - get: - x-aws-operation-name: DescribeSecurityGroupReferences - operationId: GET_DescribeSecurityGroupReferences - description: '[VPC only] Describes the VPCs on the other side of a VPC peering connection that are referencing the security groups you''ve specified in this request.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSecurityGroupReferencesResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: GroupId - in: query - required: true - description: The IDs of the security groups in your account. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/SecurityGroupId' - - xml: - name: item - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeSecurityGroupReferences - operationId: POST_DescribeSecurityGroupReferences - description: '[VPC only] Describes the VPCs on the other side of a VPC peering connection that are referencing the security groups you''ve specified in this request.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSecurityGroupReferencesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSecurityGroupReferencesRequest' - parameters: [] - /?Action=DescribeSecurityGroupRules&Version=2016-11-15: - get: - x-aws-operation-name: DescribeSecurityGroupRules - operationId: GET_DescribeSecurityGroupRules - description: Describes one or more of your security group rules. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSecurityGroupRulesResult' - parameters: - - name: Filter - in: query - required: false - description: '

One or more filters.

  • group-id - The ID of the security group.

  • security-group-rule-id - The ID of the security group rule.

  • tag:<key> - 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. 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.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: SecurityGroupRuleId - in: query - required: false - description: The IDs of the security group rules. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return in a single call. To retrieve the remaining results, make another request with the returned NextToken value. This value can be between 5 and 1000. If this parameter is not specified, then all results are returned.' - schema: - type: integer - minimum: 5 - maximum: 1000 - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeSecurityGroupRules - operationId: POST_DescribeSecurityGroupRules - description: Describes one or more of your security group rules. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSecurityGroupRulesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSecurityGroupRulesRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeSecurityGroups&Version=2016-11-15: - get: - x-aws-operation-name: DescribeSecurityGroups - operationId: GET_DescribeSecurityGroups - description: '

Describes the specified security groups or all of your security groups.

A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see Amazon EC2 security groups in the Amazon Elastic Compute Cloud User Guide and Security groups for your VPC in the Amazon Virtual Private Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSecurityGroupsResult' - parameters: - - name: Filter - in: query - required: false - description: '

The filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filters.

  • description - The description of the security group.

  • egress.ip-permission.cidr - An IPv4 CIDR block for an outbound security group rule.

  • egress.ip-permission.from-port - For an outbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number.

  • egress.ip-permission.group-id - The ID of a security group that has been referenced in an outbound security group rule.

  • egress.ip-permission.group-name - The name of a security group that is referenced in an outbound security group rule.

  • egress.ip-permission.ipv6-cidr - An IPv6 CIDR block for an outbound security group rule.

  • egress.ip-permission.prefix-list-id - The ID of a prefix list to which a security group rule allows outbound access.

  • egress.ip-permission.protocol - The IP protocol for an outbound security group rule (tcp | udp | icmp, a protocol number, or -1 for all protocols).

  • egress.ip-permission.to-port - For an outbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code.

  • egress.ip-permission.user-id - The ID of an Amazon Web Services account that has been referenced in an outbound security group rule.

  • group-id - The ID of the security group.

  • group-name - The name of the security group.

  • ip-permission.cidr - An IPv4 CIDR block for an inbound security group rule.

  • ip-permission.from-port - For an inbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number.

  • ip-permission.group-id - The ID of a security group that has been referenced in an inbound security group rule.

  • ip-permission.group-name - The name of a security group that is referenced in an inbound security group rule.

  • ip-permission.ipv6-cidr - An IPv6 CIDR block for an inbound security group rule.

  • ip-permission.prefix-list-id - The ID of a prefix list from which a security group rule allows inbound access.

  • ip-permission.protocol - The IP protocol for an inbound security group rule (tcp | udp | icmp, a protocol number, or -1 for all protocols).

  • ip-permission.to-port - For an inbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code.

  • ip-permission.user-id - The ID of an Amazon Web Services account that has been referenced in an inbound security group rule.

  • owner-id - The Amazon Web Services account ID of the owner of the security group.

  • tag:<key> - 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. 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.

  • 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.

  • vpc-id - The ID of the VPC specified when the security group was created.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: GroupId - in: query - required: false - description: '

The IDs of the security groups. Required for security groups in a nondefault VPC.

Default: Describes all of your security groups.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/SecurityGroupId' - - xml: - name: groupId - - name: GroupName - in: query - required: false - description: '

[EC2-Classic and default VPC only] The names of the security groups. You can specify either the security group name or the security group ID. For security groups in a nondefault VPC, use the group-name filter to describe security groups by name.

Default: Describes all of your security groups.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/SecurityGroupName' - - xml: - name: GroupName - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: NextToken - in: query - required: false - description: The token to request the next page of results. - schema: - type: string - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return in a single call. To retrieve the remaining results, make another request with the returned NextToken value. This value can be between 5 and 1000. If this parameter is not specified, then all results are returned.' - schema: - type: integer - minimum: 5 - maximum: 1000 - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeSecurityGroups - operationId: POST_DescribeSecurityGroups - description: '

Describes the specified security groups or all of your security groups.

A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see Amazon EC2 security groups in the Amazon Elastic Compute Cloud User Guide and Security groups for your VPC in the Amazon Virtual Private Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSecurityGroupsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSecurityGroupsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeSnapshotAttribute&Version=2016-11-15: - get: - x-aws-operation-name: DescribeSnapshotAttribute - operationId: GET_DescribeSnapshotAttribute - description: '

Describes the specified attribute of the specified snapshot. You can specify only one attribute at a time.

For more information about EBS snapshots, see Amazon EBS snapshots in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSnapshotAttributeResult' - parameters: - - name: Attribute - in: query - required: true - description: The snapshot attribute you would like to view. - schema: - type: string - enum: - - productCodes - - createVolumePermission - - name: SnapshotId - in: query - required: true - description: The ID of the EBS snapshot. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeSnapshotAttribute - operationId: POST_DescribeSnapshotAttribute - description: '

Describes the specified attribute of the specified snapshot. You can specify only one attribute at a time.

For more information about EBS snapshots, see Amazon EBS snapshots in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSnapshotAttributeResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSnapshotAttributeRequest' - parameters: [] - /?Action=DescribeSnapshotTierStatus&Version=2016-11-15: - get: - x-aws-operation-name: DescribeSnapshotTierStatus - operationId: GET_DescribeSnapshotTierStatus - description: Describes the storage tier status of one or more Amazon EBS snapshots. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSnapshotTierStatusResult' - parameters: - - name: Filter - in: query - required: false - description:

The filters.

  • snapshot-id - The snapshot ID.

  • volume-id - The ID of the volume the snapshot is for.

  • last-tiering-operation - The state of the last archive or restore action. (archival-in-progress | archival-completed | archival-failed | permanent-restore-in-progress | permanent-restore-completed | permanent-restore-failed | temporary-restore-in-progress | temporary-restore-completed | temporary-restore-failed)

- schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - schema: - type: integer - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeSnapshotTierStatus - operationId: POST_DescribeSnapshotTierStatus - description: Describes the storage tier status of one or more Amazon EBS snapshots. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSnapshotTierStatusResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSnapshotTierStatusRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeSnapshots&Version=2016-11-15: - get: - x-aws-operation-name: DescribeSnapshots - operationId: GET_DescribeSnapshots - description: '

Describes the specified EBS snapshots available to you or all of the EBS snapshots available to you.

The snapshots available to you include public snapshots, private snapshots that you own, and private snapshots owned by other Amazon Web Services accounts for which you have explicit create volume permissions.

The create volume permissions fall into the following categories:

  • public: The owner of the snapshot granted create volume permissions for the snapshot to the all group. All Amazon Web Services accounts have create volume permissions for these snapshots.

  • explicit: The owner of the snapshot granted create volume permissions to a specific Amazon Web Services account.

  • implicit: An Amazon Web Services account has implicit create volume permissions for all snapshots it owns.

The list of snapshots returned can be filtered by specifying snapshot IDs, snapshot owners, or Amazon Web Services accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions.

If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot ID for which you do not have access, it is not included in the returned results.

If you specify one or more snapshot owners using the OwnerIds option, only snapshots from the specified owners and for which you have access are returned. The results can include the Amazon Web Services account IDs of the specified owners, amazon for snapshots owned by Amazon, or self for snapshots that you own.

If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned. You can specify Amazon Web Services account IDs (if you own the snapshots), self for snapshots for which you own or have explicit permissions, or all for public snapshots.

If you are describing a long list of snapshots, we recommend that you paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeSnapshots request to retrieve the remaining results.

To get the state of fast snapshot restores for a snapshot, use DescribeFastSnapshotRestores.

For more information about EBS snapshots, see Amazon EBS snapshots in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSnapshotsResult' - parameters: - - name: Filter - in: query - required: false - description: '

The filters.

  • description - A description of the snapshot.

  • encrypted - Indicates whether the snapshot is encrypted (true | false)

  • owner-alias - The owner alias, from an Amazon-maintained list (amazon). This is not the user-configured Amazon Web Services account alias set using the IAM console. We recommend that you use the related parameter instead of this filter.

  • owner-id - The Amazon Web Services account ID of the owner. We recommend that you use the related parameter instead of this filter.

  • progress - The progress of the snapshot, as a percentage (for example, 80%).

  • snapshot-id - The snapshot ID.

  • start-time - The time stamp when the snapshot was initiated.

  • status - The status of the snapshot (pending | completed | error).

  • storage-tier - The storage tier of the snapshot (archive | standard).

  • tag:<key> - 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. 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.

  • 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.

  • volume-id - The ID of the volume the snapshot is for.

  • volume-size - The size of the volume, in GiB.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: MaxResults - in: query - required: false - description: 'The maximum number of snapshot results returned by DescribeSnapshots in paginated output. When this parameter is used, DescribeSnapshots only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeSnapshots request with the returned NextToken value. This value can be between 5 and 1,000; if MaxResults is given a value larger than 1,000, only 1,000 results are returned. If this parameter is not used, then DescribeSnapshots returns all results. You cannot specify this parameter and the snapshot IDs parameter in the same request.' - schema: - type: integer - - name: NextToken - in: query - required: false - description: The NextToken value returned from a previous paginated DescribeSnapshots request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return. - schema: - type: string - - name: Owner - in: query - required: false - description: 'Scopes the results to snapshots with the specified owners. You can specify a combination of Amazon Web Services account IDs, self, and amazon.' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: Owner - - name: RestorableBy - in: query - required: false - description: The IDs of the Amazon Web Services accounts that can create volumes from the snapshot. - schema: - type: array - items: - $ref: '#/components/schemas/String' - - name: SnapshotId - in: query - required: false - description: '

The snapshot IDs.

Default: Describes the snapshots for which you have create volume permissions.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/SnapshotId' - - xml: - name: SnapshotId - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeSnapshots - operationId: POST_DescribeSnapshots - description: '

Describes the specified EBS snapshots available to you or all of the EBS snapshots available to you.

The snapshots available to you include public snapshots, private snapshots that you own, and private snapshots owned by other Amazon Web Services accounts for which you have explicit create volume permissions.

The create volume permissions fall into the following categories:

  • public: The owner of the snapshot granted create volume permissions for the snapshot to the all group. All Amazon Web Services accounts have create volume permissions for these snapshots.

  • explicit: The owner of the snapshot granted create volume permissions to a specific Amazon Web Services account.

  • implicit: An Amazon Web Services account has implicit create volume permissions for all snapshots it owns.

The list of snapshots returned can be filtered by specifying snapshot IDs, snapshot owners, or Amazon Web Services accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions.

If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot ID for which you do not have access, it is not included in the returned results.

If you specify one or more snapshot owners using the OwnerIds option, only snapshots from the specified owners and for which you have access are returned. The results can include the Amazon Web Services account IDs of the specified owners, amazon for snapshots owned by Amazon, or self for snapshots that you own.

If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned. You can specify Amazon Web Services account IDs (if you own the snapshots), self for snapshots for which you own or have explicit permissions, or all for public snapshots.

If you are describing a long list of snapshots, we recommend that you paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeSnapshots request to retrieve the remaining results.

To get the state of fast snapshot restores for a snapshot, use DescribeFastSnapshotRestores.

For more information about EBS snapshots, see Amazon EBS snapshots in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSnapshotsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSnapshotsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeSpotDatafeedSubscription&Version=2016-11-15: - get: - x-aws-operation-name: DescribeSpotDatafeedSubscription - operationId: GET_DescribeSpotDatafeedSubscription - description: 'Describes the data feed for Spot Instances. For more information, see Spot Instance data feed in the Amazon EC2 User Guide for Linux Instances.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSpotDatafeedSubscriptionResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeSpotDatafeedSubscription - operationId: POST_DescribeSpotDatafeedSubscription - description: 'Describes the data feed for Spot Instances. For more information, see Spot Instance data feed in the Amazon EC2 User Guide for Linux Instances.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSpotDatafeedSubscriptionResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSpotDatafeedSubscriptionRequest' - parameters: [] - /?Action=DescribeSpotFleetInstances&Version=2016-11-15: - get: - x-aws-operation-name: DescribeSpotFleetInstances - operationId: GET_DescribeSpotFleetInstances - description: Describes the running instances for the specified Spot Fleet. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSpotFleetInstancesResponse' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.' - schema: - type: integer - minimum: 1 - maximum: 1000 - - name: NextToken - in: query - required: false - description: The token for the next set of results. - schema: - type: string - - name: SpotFleetRequestId - in: query - required: true - description: The ID of the Spot Fleet request. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeSpotFleetInstances - operationId: POST_DescribeSpotFleetInstances - description: Describes the running instances for the specified Spot Fleet. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSpotFleetInstancesResponse' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSpotFleetInstancesRequest' - parameters: [] - /?Action=DescribeSpotFleetRequestHistory&Version=2016-11-15: - get: - x-aws-operation-name: DescribeSpotFleetRequestHistory - operationId: GET_DescribeSpotFleetRequestHistory - description: '

Describes the events for the specified Spot Fleet request during the specified time.

Spot Fleet events are delayed by up to 30 seconds before they can be described. This ensures that you can query by the last evaluated time and not miss a recorded event. Spot Fleet events are available for 48 hours.

For more information, see Monitor fleet events using Amazon EventBridge in the Amazon EC2 User Guide for Linux Instances.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSpotFleetRequestHistoryResponse' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: EventType - in: query - required: false - description: 'The type of events to describe. By default, all events are described.' - schema: - type: string - enum: - - instanceChange - - fleetRequestChange - - error - - information - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.' - schema: - type: integer - minimum: 1 - maximum: 1000 - - name: NextToken - in: query - required: false - description: The token for the next set of results. - schema: - type: string - - name: SpotFleetRequestId - in: query - required: true - description: The ID of the Spot Fleet request. - schema: - type: string - - name: StartTime - in: query - required: true - description: 'The starting date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).' - schema: - type: string - format: date-time - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeSpotFleetRequestHistory - operationId: POST_DescribeSpotFleetRequestHistory - description: '

Describes the events for the specified Spot Fleet request during the specified time.

Spot Fleet events are delayed by up to 30 seconds before they can be described. This ensures that you can query by the last evaluated time and not miss a recorded event. Spot Fleet events are available for 48 hours.

For more information, see Monitor fleet events using Amazon EventBridge in the Amazon EC2 User Guide for Linux Instances.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSpotFleetRequestHistoryResponse' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSpotFleetRequestHistoryRequest' - parameters: [] - /?Action=DescribeSpotFleetRequests&Version=2016-11-15: - get: - x-aws-operation-name: DescribeSpotFleetRequests - operationId: GET_DescribeSpotFleetRequests - description:

Describes your Spot Fleet requests.

Spot Fleet requests are deleted 48 hours after they are canceled and their instances are terminated.

- responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSpotFleetRequestsResponse' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.' - schema: - type: integer - - name: NextToken - in: query - required: false - description: The token for the next set of results. - schema: - type: string - - name: SpotFleetRequestId - in: query - required: false - description: The IDs of the Spot Fleet requests. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/SpotFleetRequestId' - - xml: - name: item - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeSpotFleetRequests - operationId: POST_DescribeSpotFleetRequests - description:

Describes your Spot Fleet requests.

Spot Fleet requests are deleted 48 hours after they are canceled and their instances are terminated.

- responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSpotFleetRequestsResponse' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSpotFleetRequestsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeSpotInstanceRequests&Version=2016-11-15: - get: - x-aws-operation-name: DescribeSpotInstanceRequests - operationId: GET_DescribeSpotInstanceRequests - description: '

Describes the specified Spot Instance requests.

You can use DescribeSpotInstanceRequests to find a running Spot Instance by examining the response. If the status of the Spot Instance is fulfilled, the instance ID appears in the response and contains the identifier of the instance. Alternatively, you can use DescribeInstances with a filter to look for instances where the instance lifecycle is spot.

We recommend that you set MaxResults to a value between 5 and 1000 to limit the number of results returned. This paginates the output, which makes the list more manageable and returns the results faster. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeSpotInstanceRequests request to retrieve the remaining results.

Spot Instance requests are deleted four hours after they are canceled and their instances are terminated.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSpotInstanceRequestsResult' - parameters: - - name: Filter - in: query - required: false - description: '

One or more filters.

  • availability-zone-group - The Availability Zone group.

  • create-time - The time stamp when the Spot Instance request was created.

  • fault-code - The fault code related to the request.

  • fault-message - The fault message related to the request.

  • instance-id - The ID of the instance that fulfilled the request.

  • launch-group - The Spot Instance launch group.

  • launch.block-device-mapping.delete-on-termination - Indicates whether the EBS volume is deleted on instance termination.

  • launch.block-device-mapping.device-name - The device name for the volume in the block device mapping (for example, /dev/sdh or xvdh).

  • launch.block-device-mapping.snapshot-id - The ID of the snapshot for the EBS volume.

  • launch.block-device-mapping.volume-size - The size of the EBS volume, in GiB.

  • launch.block-device-mapping.volume-type - The type of EBS volume: gp2 for General Purpose SSD, io1 or io2 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1for Cold HDD, or standard for Magnetic.

  • launch.group-id - The ID of the security group for the instance.

  • launch.group-name - The name of the security group for the instance.

  • launch.image-id - The ID of the AMI.

  • launch.instance-type - The type of instance (for example, m3.medium).

  • launch.kernel-id - The kernel ID.

  • launch.key-name - The name of the key pair the instance launched with.

  • launch.monitoring-enabled - Whether detailed monitoring is enabled for the Spot Instance.

  • launch.ramdisk-id - The RAM disk ID.

  • launched-availability-zone - The Availability Zone in which the request is launched.

  • network-interface.addresses.primary - Indicates whether the IP address is the primary private IP address.

  • network-interface.delete-on-termination - Indicates whether the network interface is deleted when the instance is terminated.

  • network-interface.description - A description of the network interface.

  • network-interface.device-index - The index of the device for the network interface attachment on the instance.

  • network-interface.group-id - The ID of the security group associated with the network interface.

  • network-interface.network-interface-id - The ID of the network interface.

  • network-interface.private-ip-address - The primary private IP address of the network interface.

  • network-interface.subnet-id - The ID of the subnet for the instance.

  • product-description - The product description associated with the instance (Linux/UNIX | Windows).

  • spot-instance-request-id - The Spot Instance request ID.

  • spot-price - The maximum hourly price for any Spot Instance launched to fulfill the request.

  • state - The state of the Spot Instance request (open | active | closed | cancelled | failed). Spot request status information can help you track your Amazon EC2 Spot Instance requests. For more information, see Spot request status in the Amazon EC2 User Guide for Linux Instances.

  • status-code - The short code describing the most recent evaluation of your Spot Instance request.

  • status-message - The message explaining the status of the Spot Instance request.

  • tag:<key> - 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. 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.

  • 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.

  • type - The type of Spot Instance request (one-time | persistent).

  • valid-from - The start date of the request.

  • valid-until - The end date of the request.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: SpotInstanceRequestId - in: query - required: false - description: One or more Spot Instance request IDs. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/SpotInstanceRequestId' - - xml: - name: SpotInstanceRequestId - - name: NextToken - in: query - required: false - description: The token to request the next set of results. This value is null when there are no more results to return. - schema: - type: string - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return in a single call. Specify a value between 5 and 1000. To retrieve the remaining results, make another call with the returned NextToken value.' - schema: - type: integer - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeSpotInstanceRequests - operationId: POST_DescribeSpotInstanceRequests - description: '

Describes the specified Spot Instance requests.

You can use DescribeSpotInstanceRequests to find a running Spot Instance by examining the response. If the status of the Spot Instance is fulfilled, the instance ID appears in the response and contains the identifier of the instance. Alternatively, you can use DescribeInstances with a filter to look for instances where the instance lifecycle is spot.

We recommend that you set MaxResults to a value between 5 and 1000 to limit the number of results returned. This paginates the output, which makes the list more manageable and returns the results faster. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeSpotInstanceRequests request to retrieve the remaining results.

Spot Instance requests are deleted four hours after they are canceled and their instances are terminated.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSpotInstanceRequestsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSpotInstanceRequestsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeSpotPriceHistory&Version=2016-11-15: - get: - x-aws-operation-name: DescribeSpotPriceHistory - operationId: GET_DescribeSpotPriceHistory - description: '

Describes the Spot price history. For more information, see Spot Instance pricing history in the Amazon EC2 User Guide for Linux Instances.

When you specify a start and end time, the operation returns the prices of the instance types within that time range. It also returns the last price change before the start time, which is the effective price as of the start time.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSpotPriceHistoryResult' - parameters: - - name: Filter - in: query - required: false - description: '

One or more filters.

  • availability-zone - The Availability Zone for which prices should be returned.

  • instance-type - The type of instance (for example, m3.medium).

  • product-description - The product description for the Spot price (Linux/UNIX | Red Hat Enterprise Linux | SUSE Linux | Windows | Linux/UNIX (Amazon VPC) | Red Hat Enterprise Linux (Amazon VPC) | SUSE Linux (Amazon VPC) | Windows (Amazon VPC)).

  • spot-price - The Spot price. The value must match exactly (or use wildcards; greater than or less than comparison is not supported).

  • timestamp - The time stamp of the Spot price history, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). You can use wildcards (* and ?). Greater than or less than comparison is not supported.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: AvailabilityZone - in: query - required: false - description: Filters the results by the specified Availability Zone. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: EndTime - in: query - required: false - description: 'The date and time, up to the current date, from which to stop retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).' - schema: - type: string - format: date-time - - name: InstanceType - in: query - required: false - description: Filters the results by the specified instance types. - schema: - type: array - items: - $ref: '#/components/schemas/InstanceType' - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.' - schema: - type: integer - - name: NextToken - in: query - required: false - description: The token for the next set of results. - schema: - type: string - - name: ProductDescription - in: query - required: false - description: Filters the results by the specified basic product descriptions. - schema: - type: array - items: - $ref: '#/components/schemas/String' - - name: StartTime - in: query - required: false - description: 'The date and time, up to the past 90 days, from which to start retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).' - schema: - type: string - format: date-time - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeSpotPriceHistory - operationId: POST_DescribeSpotPriceHistory - description: '

Describes the Spot price history. For more information, see Spot Instance pricing history in the Amazon EC2 User Guide for Linux Instances.

When you specify a start and end time, the operation returns the prices of the instance types within that time range. It also returns the last price change before the start time, which is the effective price as of the start time.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSpotPriceHistoryResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSpotPriceHistoryRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeStaleSecurityGroups&Version=2016-11-15: - get: - x-aws-operation-name: DescribeStaleSecurityGroups - operationId: GET_DescribeStaleSecurityGroups - description: '[VPC only] Describes the stale security group rules for security groups in a specified VPC. Rules are stale when they reference a deleted security group in the same VPC or in a peer VPC, or if they reference a security group in a peer VPC for which the VPC peering connection has been deleted.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeStaleSecurityGroupsResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: MaxResults - in: query - required: false - description: The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results. - schema: - type: integer - minimum: 5 - maximum: 255 - - name: NextToken - in: query - required: false - description: The token for the next set of items to return. (You received this token from a prior call.) - schema: - type: string - minLength: 1 - maxLength: 1024 - - name: VpcId - in: query - required: true - description: The ID of the VPC. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeStaleSecurityGroups - operationId: POST_DescribeStaleSecurityGroups - description: '[VPC only] Describes the stale security group rules for security groups in a specified VPC. Rules are stale when they reference a deleted security group in the same VPC or in a peer VPC, or if they reference a security group in a peer VPC for which the VPC peering connection has been deleted.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeStaleSecurityGroupsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeStaleSecurityGroupsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeStoreImageTasks&Version=2016-11-15: - get: - x-aws-operation-name: DescribeStoreImageTasks - operationId: GET_DescribeStoreImageTasks - description: '

Describes the progress of the AMI store tasks. You can describe the store tasks for specified AMIs. If you don''t specify the AMIs, you get a paginated list of store tasks from the last 31 days.

For each AMI task, the response indicates if the task is InProgress, Completed, or Failed. For tasks InProgress, the response shows the estimated progress as a percentage.

Tasks are listed in reverse chronological order. Currently, only tasks from the past 31 days can be viewed.

To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the Amazon Elastic Compute Cloud User Guide.

For more information, see Store and restore an AMI using Amazon S3 in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeStoreImageTasksResult' - parameters: - - name: ImageId - in: query - required: false - description: The AMI IDs for which to show progress. Up to 20 AMI IDs can be included in a request. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/ImageId' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: Filter - in: query - required: false - description: '

The filters.

  • task-state - Returns tasks in a certain state (InProgress | Completed | Failed)

  • bucket - Returns task information for tasks that targeted a specific bucket. For the filter value, specify the bucket name.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 1 and 200. You cannot specify this parameter and the ImageIDs parameter in the same call.' - schema: - type: integer - minimum: 1 - maximum: 200 - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeStoreImageTasks - operationId: POST_DescribeStoreImageTasks - description: '

Describes the progress of the AMI store tasks. You can describe the store tasks for specified AMIs. If you don''t specify the AMIs, you get a paginated list of store tasks from the last 31 days.

For each AMI task, the response indicates if the task is InProgress, Completed, or Failed. For tasks InProgress, the response shows the estimated progress as a percentage.

Tasks are listed in reverse chronological order. Currently, only tasks from the past 31 days can be viewed.

To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the Amazon Elastic Compute Cloud User Guide.

For more information, see Store and restore an AMI using Amazon S3 in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeStoreImageTasksResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeStoreImageTasksRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeSubnets&Version=2016-11-15: - get: - x-aws-operation-name: DescribeSubnets - operationId: GET_DescribeSubnets - description: '

Describes one or more of your subnets.

For more information, see Your VPC and subnets in the Amazon Virtual Private Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSubnetsResult' - parameters: - - name: Filter - in: query - required: false - description: '

One or more filters.

  • availability-zone - The Availability Zone for the subnet. You can also use availabilityZone as the filter name.

  • availability-zone-id - The ID of the Availability Zone for the subnet. You can also use availabilityZoneId as the filter name.

  • available-ip-address-count - The number of IPv4 addresses in the subnet that are available.

  • cidr-block - The IPv4 CIDR block of the subnet. The CIDR block you specify must exactly match the subnet''s CIDR block for information to be returned for the subnet. You can also use cidr or cidrBlock as the filter names.

  • default-for-az - Indicates whether this is the default subnet for the Availability Zone (true | false). You can also use defaultForAz as the filter name.

  • ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the subnet.

  • ipv6-cidr-block-association.association-id - An association ID for an IPv6 CIDR block associated with the subnet.

  • ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the subnet.

  • ipv6-native - Indicates whether this is an IPv6 only subnet (true | false).

  • outpost-arn - The Amazon Resource Name (ARN) of the Outpost.

  • owner-id - The ID of the Amazon Web Services account that owns the subnet.

  • state - The state of the subnet (pending | available).

  • subnet-arn - The Amazon Resource Name (ARN) of the subnet.

  • subnet-id - The ID of the subnet.

  • tag:<key> - 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. 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.

  • 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.

  • vpc-id - The ID of the VPC for the subnet.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: SubnetId - in: query - required: false - description: '

One or more subnet IDs.

Default: Describes all your subnets.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/SubnetId' - - xml: - name: SubnetId - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - schema: - type: integer - minimum: 5 - maximum: 1000 - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeSubnets - operationId: POST_DescribeSubnets - description: '

Describes one or more of your subnets.

For more information, see Your VPC and subnets in the Amazon Virtual Private Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSubnetsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeSubnetsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeTags&Version=2016-11-15: - get: - x-aws-operation-name: DescribeTags - operationId: GET_DescribeTags - description: '

Describes the specified tags for your EC2 resources.

For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeTagsResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: Filter - in: query - required: false - description: '

The filters.

  • key - The tag key.

  • resource-id - The ID of the resource.

  • resource-type - The resource type (customer-gateway | dedicated-host | dhcp-options | elastic-ip | fleet | fpga-image | host-reservation | image | instance | internet-gateway | key-pair | launch-template | natgateway | network-acl | network-interface | placement-group | reserved-instances | route-table | security-group | snapshot | spot-instances-request | subnet | volume | vpc | vpc-endpoint | vpc-endpoint-service | vpc-peering-connection | vpn-connection | vpn-gateway).

  • tag:<key> - The key/value combination of the tag. For example, specify "tag:Owner" for the filter name and "TeamA" for the filter value to find resources with the tag "Owner=TeamA".

  • value - The tag value.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return in a single call. This value can be between 5 and 1000. To retrieve the remaining results, make another call with the returned NextToken value.' - schema: - type: integer - - name: NextToken - in: query - required: false - description: The token to retrieve the next page of results. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeTags - operationId: POST_DescribeTags - description: '

Describes the specified tags for your EC2 resources.

For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeTagsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeTagsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeTrafficMirrorFilters&Version=2016-11-15: - get: - x-aws-operation-name: DescribeTrafficMirrorFilters - operationId: GET_DescribeTrafficMirrorFilters - description: Describes one or more Traffic Mirror filters. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeTrafficMirrorFiltersResult' - parameters: - - name: TrafficMirrorFilterId - in: query - required: false - description: The ID of the Traffic Mirror filter. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TrafficMirrorFilterId' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: Filter - in: query - required: false - description: '

One or more filters. The possible values are:

  • description: The Traffic Mirror filter description.

  • traffic-mirror-filter-id: The ID of the Traffic Mirror filter.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - schema: - type: integer - minimum: 5 - maximum: 1000 - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeTrafficMirrorFilters - operationId: POST_DescribeTrafficMirrorFilters - description: Describes one or more Traffic Mirror filters. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeTrafficMirrorFiltersResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeTrafficMirrorFiltersRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeTrafficMirrorSessions&Version=2016-11-15: - get: - x-aws-operation-name: DescribeTrafficMirrorSessions - operationId: GET_DescribeTrafficMirrorSessions - description: 'Describes one or more Traffic Mirror sessions. By default, all Traffic Mirror sessions are described. Alternatively, you can filter the results.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeTrafficMirrorSessionsResult' - parameters: - - name: TrafficMirrorSessionId - in: query - required: false - description: The ID of the Traffic Mirror session. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TrafficMirrorSessionId' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: Filter - in: query - required: false - description: '

One or more filters. The possible values are:

  • description: The Traffic Mirror session description.

  • network-interface-id: The ID of the Traffic Mirror session network interface.

  • owner-id: The ID of the account that owns the Traffic Mirror session.

  • packet-length: The assigned number of packets to mirror.

  • session-number: The assigned session number.

  • traffic-mirror-filter-id: The ID of the Traffic Mirror filter.

  • traffic-mirror-session-id: The ID of the Traffic Mirror session.

  • traffic-mirror-target-id: The ID of the Traffic Mirror target.

  • virtual-network-id: The virtual network ID of the Traffic Mirror session.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - schema: - type: integer - minimum: 5 - maximum: 1000 - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeTrafficMirrorSessions - operationId: POST_DescribeTrafficMirrorSessions - description: 'Describes one or more Traffic Mirror sessions. By default, all Traffic Mirror sessions are described. Alternatively, you can filter the results.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeTrafficMirrorSessionsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeTrafficMirrorSessionsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeTrafficMirrorTargets&Version=2016-11-15: - get: - x-aws-operation-name: DescribeTrafficMirrorTargets - operationId: GET_DescribeTrafficMirrorTargets - description: Information about one or more Traffic Mirror targets. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeTrafficMirrorTargetsResult' - parameters: - - name: TrafficMirrorTargetId - in: query - required: false - description: The ID of the Traffic Mirror targets. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TrafficMirrorTargetId' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: Filter - in: query - required: false - description: '

One or more filters. The possible values are:

  • description: The Traffic Mirror target description.

  • network-interface-id: The ID of the Traffic Mirror session network interface.

  • network-load-balancer-arn: The Amazon Resource Name (ARN) of the Network Load Balancer that is associated with the session.

  • owner-id: The ID of the account that owns the Traffic Mirror session.

  • traffic-mirror-target-id: The ID of the Traffic Mirror target.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - schema: - type: integer - minimum: 5 - maximum: 1000 - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeTrafficMirrorTargets - operationId: POST_DescribeTrafficMirrorTargets - description: Information about one or more Traffic Mirror targets. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeTrafficMirrorTargetsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeTrafficMirrorTargetsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeTransitGatewayAttachments&Version=2016-11-15: - get: - x-aws-operation-name: DescribeTransitGatewayAttachments - operationId: GET_DescribeTransitGatewayAttachments - description: 'Describes one or more attachments between resources and transit gateways. By default, all attachments are described. Alternatively, you can filter the results by attachment ID, attachment state, resource ID, or resource owner.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeTransitGatewayAttachmentsResult' - parameters: - - name: TransitGatewayAttachmentIds - in: query - required: false - description: The IDs of the attachments. - schema: - type: array - items: - $ref: '#/components/schemas/TransitGatewayAttachmentId' - - name: Filter - in: query - required: false - description: '

One or more filters. The possible values are:

  • association.state - The state of the association (associating | associated | disassociating).

  • association.transit-gateway-route-table-id - The ID of the route table for the transit gateway.

  • resource-id - The ID of the resource.

  • resource-owner-id - The ID of the Amazon Web Services account that owns the resource.

  • resource-type - The resource type. Valid values are vpc | vpn | direct-connect-gateway | peering | connect.

  • state - The state of the attachment. Valid values are available | deleted | deleting | failed | failing | initiatingRequest | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting.

  • transit-gateway-attachment-id - The ID of the attachment.

  • transit-gateway-id - The ID of the transit gateway.

  • transit-gateway-owner-id - The ID of the Amazon Web Services account that owns the transit gateway.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - schema: - type: integer - minimum: 5 - maximum: 1000 - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeTransitGatewayAttachments - operationId: POST_DescribeTransitGatewayAttachments - description: 'Describes one or more attachments between resources and transit gateways. By default, all attachments are described. Alternatively, you can filter the results by attachment ID, attachment state, resource ID, or resource owner.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeTransitGatewayAttachmentsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeTransitGatewayAttachmentsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeTransitGatewayConnectPeers&Version=2016-11-15: - get: - x-aws-operation-name: DescribeTransitGatewayConnectPeers - operationId: GET_DescribeTransitGatewayConnectPeers - description: Describes one or more Connect peers. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeTransitGatewayConnectPeersResult' - parameters: - - name: TransitGatewayConnectPeerIds - in: query - required: false - description: The IDs of the Connect peers. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TransitGatewayConnectPeerId' - - xml: - name: item - - name: Filter - in: query - required: false - description: '

One or more filters. The possible values are:

  • state - The state of the Connect peer (pending | available | deleting | deleted).

  • transit-gateway-attachment-id - The ID of the attachment.

  • transit-gateway-connect-peer-id - The ID of the Connect peer.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - schema: - type: integer - minimum: 5 - maximum: 1000 - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeTransitGatewayConnectPeers - operationId: POST_DescribeTransitGatewayConnectPeers - description: Describes one or more Connect peers. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeTransitGatewayConnectPeersResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeTransitGatewayConnectPeersRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeTransitGatewayConnects&Version=2016-11-15: - get: - x-aws-operation-name: DescribeTransitGatewayConnects - operationId: GET_DescribeTransitGatewayConnects - description: Describes one or more Connect attachments. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeTransitGatewayConnectsResult' - parameters: - - name: TransitGatewayAttachmentIds - in: query - required: false - description: The IDs of the attachments. - schema: - type: array - items: - $ref: '#/components/schemas/TransitGatewayAttachmentId' - - name: Filter - in: query - required: false - description: '

One or more filters. The possible values are:

  • options.protocol - The tunnel protocol (gre).

  • state - The state of the attachment (initiating | initiatingRequest | pendingAcceptance | rollingBack | pending | available | modifying | deleting | deleted | failed | rejected | rejecting | failing).

  • transit-gateway-attachment-id - The ID of the Connect attachment.

  • transit-gateway-id - The ID of the transit gateway.

  • transport-transit-gateway-attachment-id - The ID of the transit gateway attachment from which the Connect attachment was created.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - schema: - type: integer - minimum: 5 - maximum: 1000 - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeTransitGatewayConnects - operationId: POST_DescribeTransitGatewayConnects - description: Describes one or more Connect attachments. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeTransitGatewayConnectsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeTransitGatewayConnectsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeTransitGatewayMulticastDomains&Version=2016-11-15: - get: - x-aws-operation-name: DescribeTransitGatewayMulticastDomains - operationId: GET_DescribeTransitGatewayMulticastDomains - description: Describes one or more transit gateway multicast domains. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeTransitGatewayMulticastDomainsResult' - parameters: - - name: TransitGatewayMulticastDomainIds - in: query - required: false - description: The ID of the transit gateway multicast domain. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TransitGatewayMulticastDomainId' - - xml: - name: item - - name: Filter - in: query - required: false - description: '

One or more filters. The possible values are:

  • state - The state of the transit gateway multicast domain. Valid values are pending | available | deleting | deleted.

  • transit-gateway-id - The ID of the transit gateway.

  • transit-gateway-multicast-domain-id - The ID of the transit gateway multicast domain.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - schema: - type: integer - minimum: 5 - maximum: 1000 - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeTransitGatewayMulticastDomains - operationId: POST_DescribeTransitGatewayMulticastDomains - description: Describes one or more transit gateway multicast domains. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeTransitGatewayMulticastDomainsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeTransitGatewayMulticastDomainsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeTransitGatewayPeeringAttachments&Version=2016-11-15: - get: - x-aws-operation-name: DescribeTransitGatewayPeeringAttachments - operationId: GET_DescribeTransitGatewayPeeringAttachments - description: Describes your transit gateway peering attachments. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeTransitGatewayPeeringAttachmentsResult' - parameters: - - name: TransitGatewayAttachmentIds - in: query - required: false - description: One or more IDs of the transit gateway peering attachments. - schema: - type: array - items: - $ref: '#/components/schemas/TransitGatewayAttachmentId' - - name: Filter - in: query - required: false - description: '

One or more filters. The possible values are:

  • transit-gateway-attachment-id - The ID of the transit gateway attachment.

  • local-owner-id - The ID of your Amazon Web Services account.

  • remote-owner-id - The ID of the Amazon Web Services account in the remote Region that owns the transit gateway.

  • state - The state of the peering attachment. Valid values are available | deleted | deleting | failed | failing | initiatingRequest | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting).

  • tag:<key> - 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. 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.

  • 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.

  • transit-gateway-id - The ID of the transit gateway.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - schema: - type: integer - minimum: 5 - maximum: 1000 - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeTransitGatewayPeeringAttachments - operationId: POST_DescribeTransitGatewayPeeringAttachments - description: Describes your transit gateway peering attachments. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeTransitGatewayPeeringAttachmentsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeTransitGatewayPeeringAttachmentsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeTransitGatewayRouteTables&Version=2016-11-15: - get: - x-aws-operation-name: DescribeTransitGatewayRouteTables - operationId: GET_DescribeTransitGatewayRouteTables - description: 'Describes one or more transit gateway route tables. By default, all transit gateway route tables are described. Alternatively, you can filter the results.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeTransitGatewayRouteTablesResult' - parameters: - - name: TransitGatewayRouteTableIds - in: query - required: false - description: The IDs of the transit gateway route tables. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TransitGatewayRouteTableId' - - xml: - name: item - - name: Filter - in: query - required: false - description: '

One or more filters. The possible values are:

  • default-association-route-table - Indicates whether this is the default association route table for the transit gateway (true | false).

  • default-propagation-route-table - Indicates whether this is the default propagation route table for the transit gateway (true | false).

  • state - The state of the route table (available | deleting | deleted | pending).

  • transit-gateway-id - The ID of the transit gateway.

  • transit-gateway-route-table-id - The ID of the transit gateway route table.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - schema: - type: integer - minimum: 5 - maximum: 1000 - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeTransitGatewayRouteTables - operationId: POST_DescribeTransitGatewayRouteTables - description: 'Describes one or more transit gateway route tables. By default, all transit gateway route tables are described. Alternatively, you can filter the results.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeTransitGatewayRouteTablesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeTransitGatewayRouteTablesRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeTransitGatewayVpcAttachments&Version=2016-11-15: - get: - x-aws-operation-name: DescribeTransitGatewayVpcAttachments - operationId: GET_DescribeTransitGatewayVpcAttachments - description: 'Describes one or more VPC attachments. By default, all VPC attachments are described. Alternatively, you can filter the results.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeTransitGatewayVpcAttachmentsResult' - parameters: - - name: TransitGatewayAttachmentIds - in: query - required: false - description: The IDs of the attachments. - schema: - type: array - items: - $ref: '#/components/schemas/TransitGatewayAttachmentId' - - name: Filter - in: query - required: false - description: '

One or more filters. The possible values are:

  • state - The state of the attachment. Valid values are available | deleted | deleting | failed | failing | initiatingRequest | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting.

  • transit-gateway-attachment-id - The ID of the attachment.

  • transit-gateway-id - The ID of the transit gateway.

  • vpc-id - The ID of the VPC.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - schema: - type: integer - minimum: 5 - maximum: 1000 - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeTransitGatewayVpcAttachments - operationId: POST_DescribeTransitGatewayVpcAttachments - description: 'Describes one or more VPC attachments. By default, all VPC attachments are described. Alternatively, you can filter the results.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeTransitGatewayVpcAttachmentsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeTransitGatewayVpcAttachmentsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeTransitGateways&Version=2016-11-15: - get: - x-aws-operation-name: DescribeTransitGateways - operationId: GET_DescribeTransitGateways - description: 'Describes one or more transit gateways. By default, all transit gateways are described. Alternatively, you can filter the results.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeTransitGatewaysResult' - parameters: - - name: TransitGatewayIds - in: query - required: false - description: The IDs of the transit gateways. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TransitGatewayId' - - xml: - name: item - - name: Filter - in: query - required: false - description: '

One or more filters. The possible values are:

  • options.propagation-default-route-table-id - The ID of the default propagation route table.

  • options.amazon-side-asn - The private ASN for the Amazon side of a BGP session.

  • options.association-default-route-table-id - The ID of the default association route table.

  • options.auto-accept-shared-attachments - Indicates whether there is automatic acceptance of attachment requests (enable | disable).

  • options.default-route-table-association - Indicates whether resource attachments are automatically associated with the default association route table (enable | disable).

  • options.default-route-table-propagation - Indicates whether resource attachments automatically propagate routes to the default propagation route table (enable | disable).

  • options.dns-support - Indicates whether DNS support is enabled (enable | disable).

  • options.vpn-ecmp-support - Indicates whether Equal Cost Multipath Protocol support is enabled (enable | disable).

  • owner-id - The ID of the Amazon Web Services account that owns the transit gateway.

  • state - The state of the transit gateway (available | deleted | deleting | modifying | pending).

  • transit-gateway-id - The ID of the transit gateway.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - schema: - type: integer - minimum: 5 - maximum: 1000 - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeTransitGateways - operationId: POST_DescribeTransitGateways - description: 'Describes one or more transit gateways. By default, all transit gateways are described. Alternatively, you can filter the results.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeTransitGatewaysResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeTransitGatewaysRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeTrunkInterfaceAssociations&Version=2016-11-15: - get: - x-aws-operation-name: DescribeTrunkInterfaceAssociations - operationId: GET_DescribeTrunkInterfaceAssociations - description: '

This API action is currently in limited preview only. If you are interested in using this feature, contact your account manager.

Describes one or more network interface trunk associations.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeTrunkInterfaceAssociationsResult' - parameters: - - name: AssociationId - in: query - required: false - description: The IDs of the associations. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TrunkInterfaceAssociationId' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: Filter - in: query - required: false - description:

One or more filters.

  • gre-key - The ID of a trunk interface association.

  • interface-protocol - The interface protocol. Valid values are VLAN and GRE.

- schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - schema: - type: integer - minimum: 5 - maximum: 255 - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeTrunkInterfaceAssociations - operationId: POST_DescribeTrunkInterfaceAssociations - description: '

This API action is currently in limited preview only. If you are interested in using this feature, contact your account manager.

Describes one or more network interface trunk associations.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeTrunkInterfaceAssociationsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeTrunkInterfaceAssociationsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeVolumeAttribute&Version=2016-11-15: - get: - x-aws-operation-name: DescribeVolumeAttribute - operationId: GET_DescribeVolumeAttribute - description: '

Describes the specified attribute of the specified volume. You can specify only one attribute at a time.

For more information about EBS volumes, see Amazon EBS volumes in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVolumeAttributeResult' - parameters: - - name: Attribute - in: query - required: true - description: The attribute of the volume. This parameter is required. - schema: - type: string - enum: - - autoEnableIO - - productCodes - - name: VolumeId - in: query - required: true - description: The ID of the volume. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeVolumeAttribute - operationId: POST_DescribeVolumeAttribute - description: '

Describes the specified attribute of the specified volume. You can specify only one attribute at a time.

For more information about EBS volumes, see Amazon EBS volumes in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVolumeAttributeResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVolumeAttributeRequest' - parameters: [] - /?Action=DescribeVolumeStatus&Version=2016-11-15: - get: - x-aws-operation-name: DescribeVolumeStatus - operationId: GET_DescribeVolumeStatus - description: '

Describes the status of the specified volumes. Volume status provides the result of the checks performed on your volumes to determine events that can impair the performance of your volumes. The performance of a volume can be affected if an issue occurs on the volume''s underlying host. If the volume''s underlying host experiences a power outage or system issue, after the system is restored, there could be data inconsistencies on the volume. Volume events notify you if this occurs. Volume actions notify you if any action needs to be taken in response to the event.

The DescribeVolumeStatus operation provides the following information about the specified volumes:

Status: Reflects the current status of the volume. The possible values are ok, impaired , warning, or insufficient-data. If all checks pass, the overall status of the volume is ok. If the check fails, the overall status is impaired. If the status is insufficient-data, then the checks might still be taking place on your volume at the time. We recommend that you retry the request. For more information about volume status, see Monitor the status of your volumes in the Amazon Elastic Compute Cloud User Guide.

Events: Reflect the cause of a volume status and might require you to take action. For example, if your volume returns an impaired status, then the volume event might be potential-data-inconsistency. This means that your volume has been affected by an issue with the underlying host, has all I/O operations disabled, and might have inconsistent data.

Actions: Reflect the actions you might have to take in response to an event. For example, if the status of the volume is impaired and the volume event shows potential-data-inconsistency, then the action shows enable-volume-io. This means that you may want to enable the I/O operations for the volume by calling the EnableVolumeIO action and then check the volume for data consistency.

Volume status is based on the volume status checks, and does not reflect the volume state. Therefore, volume status does not indicate volumes in the error state (for example, when a volume is incapable of accepting I/O.)

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVolumeStatusResult' - parameters: - - name: Filter - in: query - required: false - description: '

The filters.

  • action.code - The action code for the event (for example, enable-volume-io).

  • action.description - A description of the action.

  • action.event-id - The event ID associated with the action.

  • availability-zone - The Availability Zone of the instance.

  • event.description - A description of the event.

  • event.event-id - The event ID.

  • event.event-type - The event type (for io-enabled: passed | failed; for io-performance: io-performance:degraded | io-performance:severely-degraded | io-performance:stalled).

  • event.not-after - The latest end time for the event.

  • event.not-before - The earliest start time for the event.

  • volume-status.details-name - The cause for volume-status.status (io-enabled | io-performance).

  • volume-status.details-status - The status of volume-status.details-name (for io-enabled: passed | failed; for io-performance: normal | degraded | severely-degraded | stalled).

  • volume-status.status - The status of the volume (ok | impaired | warning | insufficient-data).

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: MaxResults - in: query - required: false - description: 'The maximum number of volume results returned by DescribeVolumeStatus in paginated output. When this parameter is used, the request only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1,000; if MaxResults is given a value larger than 1,000, only 1,000 results are returned. If this parameter is not used, then DescribeVolumeStatus returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.' - schema: - type: integer - - name: NextToken - in: query - required: false - description: 'The NextToken value to include in a future DescribeVolumeStatus request. When the results of the request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.' - schema: - type: string - - name: VolumeId - in: query - required: false - description: '

The IDs of the volumes.

Default: Describes all your volumes.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/VolumeId' - - xml: - name: VolumeId - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeVolumeStatus - operationId: POST_DescribeVolumeStatus - description: '

Describes the status of the specified volumes. Volume status provides the result of the checks performed on your volumes to determine events that can impair the performance of your volumes. The performance of a volume can be affected if an issue occurs on the volume''s underlying host. If the volume''s underlying host experiences a power outage or system issue, after the system is restored, there could be data inconsistencies on the volume. Volume events notify you if this occurs. Volume actions notify you if any action needs to be taken in response to the event.

The DescribeVolumeStatus operation provides the following information about the specified volumes:

Status: Reflects the current status of the volume. The possible values are ok, impaired , warning, or insufficient-data. If all checks pass, the overall status of the volume is ok. If the check fails, the overall status is impaired. If the status is insufficient-data, then the checks might still be taking place on your volume at the time. We recommend that you retry the request. For more information about volume status, see Monitor the status of your volumes in the Amazon Elastic Compute Cloud User Guide.

Events: Reflect the cause of a volume status and might require you to take action. For example, if your volume returns an impaired status, then the volume event might be potential-data-inconsistency. This means that your volume has been affected by an issue with the underlying host, has all I/O operations disabled, and might have inconsistent data.

Actions: Reflect the actions you might have to take in response to an event. For example, if the status of the volume is impaired and the volume event shows potential-data-inconsistency, then the action shows enable-volume-io. This means that you may want to enable the I/O operations for the volume by calling the EnableVolumeIO action and then check the volume for data consistency.

Volume status is based on the volume status checks, and does not reflect the volume state. Therefore, volume status does not indicate volumes in the error state (for example, when a volume is incapable of accepting I/O.)

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVolumeStatusResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVolumeStatusRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - '/?Action=DescribeVolumes&Version=2016-11-15': - get: - x-aws-operation-name: DescribeVolumes - operationId: GET_DescribeVolumes - description: '

Describes the specified EBS volumes or all of your EBS volumes.

If you are describing a long list of volumes, we recommend that you paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeVolumes request to retrieve the remaining results.

For more information about EBS volumes, see Amazon EBS volumes in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVolumesResult' - parameters: - - name: Filter - in: query - required: false - description: '

The filters.

  • attachment.attach-time - The time stamp when the attachment initiated.

  • attachment.delete-on-termination - Whether the volume is deleted on instance termination.

  • attachment.device - The device name specified in the block device mapping (for example, /dev/sda1).

  • attachment.instance-id - The ID of the instance the volume is attached to.

  • attachment.status - The attachment state (attaching | attached | detaching).

  • availability-zone - The Availability Zone in which the volume was created.

  • create-time - The time stamp when the volume was created.

  • encrypted - Indicates whether the volume is encrypted (true | false)

  • multi-attach-enabled - Indicates whether the volume is enabled for Multi-Attach (true | false)

  • fast-restored - Indicates whether the volume was created from a snapshot that is enabled for fast snapshot restore (true | false).

  • size - The size of the volume, in GiB.

  • snapshot-id - The snapshot from which the volume was created.

  • status - The state of the volume (creating | available | in-use | deleting | deleted | error).

  • tag:<key> - 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. 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.

  • 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.

  • volume-id - The volume ID.

  • volume-type - The Amazon EBS volume type (gp2 | gp3 | io1 | io2 | st1 | sc1| standard)

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: VolumeId - in: query - required: false - description: The volume IDs. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/VolumeId' - - xml: - name: VolumeId - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: MaxResults - in: query - required: false - description: 'The maximum number of volume results returned by DescribeVolumes in paginated output. When this parameter is used, DescribeVolumes only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeVolumes request with the returned NextToken value. This value can be between 5 and 500; if MaxResults is given a value larger than 500, only 500 results are returned. If this parameter is not used, then DescribeVolumes returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.' - schema: - type: integer - - name: NextToken - in: query - required: false - description: The NextToken value returned from a previous paginated DescribeVolumes request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeVolumes - operationId: POST_DescribeVolumes - description: '

Describes the specified EBS volumes or all of your EBS volumes.

If you are describing a long list of volumes, we recommend that you paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeVolumes request to retrieve the remaining results.

For more information about EBS volumes, see Amazon EBS volumes in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVolumesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVolumesRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeVolumesModifications&Version=2016-11-15: - get: - x-aws-operation-name: DescribeVolumesModifications - operationId: GET_DescribeVolumesModifications - description: '

Describes the most recent volume modification request for the specified EBS volumes.

If a volume has never been modified, some information in the output will be null. If a volume has been modified more than once, the output includes only the most recent modification request.

You can also use CloudWatch Events to check the status of a modification to an EBS volume. For information about CloudWatch Events, see the Amazon CloudWatch Events User Guide. For more information, see Monitor the progress of volume modifications in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVolumesModificationsResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: VolumeId - in: query - required: false - description: The IDs of the volumes. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/VolumeId' - - xml: - name: VolumeId - - name: Filter - in: query - required: false - description: '

The filters.

  • modification-state - The current modification state (modifying | optimizing | completed | failed).

  • original-iops - The original IOPS rate of the volume.

  • original-size - The original size of the volume, in GiB.

  • original-volume-type - The original volume type of the volume (standard | io1 | io2 | gp2 | sc1 | st1).

  • originalMultiAttachEnabled - Indicates whether Multi-Attach support was enabled (true | false).

  • start-time - The modification start time.

  • target-iops - The target IOPS rate of the volume.

  • target-size - The target size of the volume, in GiB.

  • target-volume-type - The target volume type of the volume (standard | io1 | io2 | gp2 | sc1 | st1).

  • targetMultiAttachEnabled - Indicates whether Multi-Attach support is to be enabled (true | false).

  • volume-id - The ID of the volume.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: NextToken - in: query - required: false - description: The nextToken value returned by a previous paginated request. - schema: - type: string - - name: MaxResults - in: query - required: false - description: The maximum number of results (up to a limit of 500) to be returned in a paginated request. - schema: - type: integer - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeVolumesModifications - operationId: POST_DescribeVolumesModifications - description: '

Describes the most recent volume modification request for the specified EBS volumes.

If a volume has never been modified, some information in the output will be null. If a volume has been modified more than once, the output includes only the most recent modification request.

You can also use CloudWatch Events to check the status of a modification to an EBS volume. For information about CloudWatch Events, see the Amazon CloudWatch Events User Guide. For more information, see Monitor the progress of volume modifications in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVolumesModificationsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVolumesModificationsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeVpcAttribute&Version=2016-11-15: - get: - x-aws-operation-name: DescribeVpcAttribute - operationId: GET_DescribeVpcAttribute - description: Describes the specified attribute of the specified VPC. You can specify only one attribute at a time. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVpcAttributeResult' - parameters: - - name: Attribute - in: query - required: true - description: The VPC attribute. - schema: - type: string - enum: - - enableDnsSupport - - enableDnsHostnames - - name: VpcId - in: query - required: true - description: The ID of the VPC. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeVpcAttribute - operationId: POST_DescribeVpcAttribute - description: Describes the specified attribute of the specified VPC. You can specify only one attribute at a time. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVpcAttributeResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVpcAttributeRequest' - parameters: [] - /?Action=DescribeVpcClassicLink&Version=2016-11-15: - get: - x-aws-operation-name: DescribeVpcClassicLink - operationId: GET_DescribeVpcClassicLink - description: Describes the ClassicLink status of one or more VPCs. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVpcClassicLinkResult' - parameters: - - name: Filter - in: query - required: false - description: '

One or more filters.

  • is-classic-link-enabled - Whether the VPC is enabled for ClassicLink (true | false).

  • tag:<key> - 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. 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.

  • 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.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: VpcId - in: query - required: false - description: One or more VPCs for which you want to describe the ClassicLink status. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/VpcId' - - xml: - name: VpcId - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeVpcClassicLink - operationId: POST_DescribeVpcClassicLink - description: Describes the ClassicLink status of one or more VPCs. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVpcClassicLinkResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVpcClassicLinkRequest' - parameters: [] - /?Action=DescribeVpcClassicLinkDnsSupport&Version=2016-11-15: - get: - x-aws-operation-name: DescribeVpcClassicLinkDnsSupport - operationId: GET_DescribeVpcClassicLinkDnsSupport - description: 'Describes the ClassicLink DNS support status of one or more VPCs. If enabled, the DNS hostname of a linked EC2-Classic instance resolves to its private IP address when addressed from an instance in the VPC to which it''s linked. Similarly, the DNS hostname of an instance in a VPC resolves to its private IP address when addressed from a linked EC2-Classic instance. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVpcClassicLinkDnsSupportResult' - parameters: - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - schema: - type: integer - minimum: 5 - maximum: 255 - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - minLength: 1 - maxLength: 1024 - - name: VpcIds - in: query - required: false - description: One or more VPC IDs. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/VpcId' - - xml: - name: VpcId - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeVpcClassicLinkDnsSupport - operationId: POST_DescribeVpcClassicLinkDnsSupport - description: 'Describes the ClassicLink DNS support status of one or more VPCs. If enabled, the DNS hostname of a linked EC2-Classic instance resolves to its private IP address when addressed from an instance in the VPC to which it''s linked. Similarly, the DNS hostname of an instance in a VPC resolves to its private IP address when addressed from a linked EC2-Classic instance. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVpcClassicLinkDnsSupportResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVpcClassicLinkDnsSupportRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeVpcEndpointConnectionNotifications&Version=2016-11-15: - get: - x-aws-operation-name: DescribeVpcEndpointConnectionNotifications - operationId: GET_DescribeVpcEndpointConnectionNotifications - description: Describes the connection notifications for VPC endpoints and VPC endpoint services. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVpcEndpointConnectionNotificationsResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: ConnectionNotificationId - in: query - required: false - description: The ID of the notification. - schema: - type: string - - name: Filter - in: query - required: false - description:

One or more filters.

  • connection-notification-arn - The ARN of the SNS topic for the notification.

  • connection-notification-id - The ID of the notification.

  • connection-notification-state - The state of the notification (Enabled | Disabled).

  • connection-notification-type - The type of notification (Topic).

  • service-id - The ID of the endpoint service.

  • vpc-endpoint-id - The ID of the VPC endpoint.

- schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return in a single call. To retrieve the remaining results, make another request with the returned NextToken value.' - schema: - type: integer - - name: NextToken - in: query - required: false - description: The token to request the next page of results. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeVpcEndpointConnectionNotifications - operationId: POST_DescribeVpcEndpointConnectionNotifications - description: Describes the connection notifications for VPC endpoints and VPC endpoint services. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVpcEndpointConnectionNotificationsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVpcEndpointConnectionNotificationsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeVpcEndpointConnections&Version=2016-11-15: - get: - x-aws-operation-name: DescribeVpcEndpointConnections - operationId: GET_DescribeVpcEndpointConnections - description: 'Describes the VPC endpoint connections to your VPC endpoint services, including any endpoints that are pending your acceptance.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVpcEndpointConnectionsResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: Filter - in: query - required: false - description:

One or more filters.

  • ip-address-type - The IP address type (ipv4 | ipv6).

  • service-id - The ID of the service.

  • vpc-endpoint-owner - The ID of the Amazon Web Services account ID that owns the endpoint.

  • vpc-endpoint-state - The state of the endpoint (pendingAcceptance | pending | available | deleting | deleted | rejected | failed).

  • vpc-endpoint-id - The ID of the endpoint.

- schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1,000; if MaxResults is given a value larger than 1,000, only 1,000 results are returned.' - schema: - type: integer - - name: NextToken - in: query - required: false - description: The token to retrieve the next page of results. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeVpcEndpointConnections - operationId: POST_DescribeVpcEndpointConnections - description: 'Describes the VPC endpoint connections to your VPC endpoint services, including any endpoints that are pending your acceptance.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVpcEndpointConnectionsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVpcEndpointConnectionsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeVpcEndpointServiceConfigurations&Version=2016-11-15: - get: - x-aws-operation-name: DescribeVpcEndpointServiceConfigurations - operationId: GET_DescribeVpcEndpointServiceConfigurations - description: Describes the VPC endpoint service configurations in your account (your services). - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVpcEndpointServiceConfigurationsResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: ServiceId - in: query - required: false - description: The IDs of one or more services. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/VpcEndpointServiceId' - - xml: - name: item - - name: Filter - in: query - required: false - description: '

One or more filters.

  • service-name - The name of the service.

  • service-id - The ID of the service.

  • service-state - The state of the service (Pending | Available | Deleting | Deleted | Failed).

  • supported-ip-address-types - The IP address type (ipv4 | ipv6).

  • tag:<key> - 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. 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.

  • 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.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1,000; if MaxResults is given a value larger than 1,000, only 1,000 results are returned.' - schema: - type: integer - - name: NextToken - in: query - required: false - description: The token to retrieve the next page of results. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeVpcEndpointServiceConfigurations - operationId: POST_DescribeVpcEndpointServiceConfigurations - description: Describes the VPC endpoint service configurations in your account (your services). - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVpcEndpointServiceConfigurationsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVpcEndpointServiceConfigurationsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeVpcEndpointServicePermissions&Version=2016-11-15: - get: - x-aws-operation-name: DescribeVpcEndpointServicePermissions - operationId: GET_DescribeVpcEndpointServicePermissions - description: Describes the principals (service consumers) that are permitted to discover your VPC endpoint service. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVpcEndpointServicePermissionsResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: ServiceId - in: query - required: true - description: The ID of the service. - schema: - type: string - - name: Filter - in: query - required: false - description:

One or more filters.

  • principal - The ARN of the principal.

  • principal-type - The principal type (All | Service | OrganizationUnit | Account | User | Role).

- schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1,000; if MaxResults is given a value larger than 1,000, only 1,000 results are returned.' - schema: - type: integer - - name: NextToken - in: query - required: false - description: The token to retrieve the next page of results. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeVpcEndpointServicePermissions - operationId: POST_DescribeVpcEndpointServicePermissions - description: Describes the principals (service consumers) that are permitted to discover your VPC endpoint service. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVpcEndpointServicePermissionsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVpcEndpointServicePermissionsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeVpcEndpointServices&Version=2016-11-15: - get: - x-aws-operation-name: DescribeVpcEndpointServices - operationId: GET_DescribeVpcEndpointServices - description: '

Describes available services to which you can create a VPC endpoint.

When the service provider and the consumer have different accounts in multiple Availability Zones, and the consumer views the VPC endpoint service information, the response only includes the common Availability Zones. For example, when the service provider account uses us-east-1a and us-east-1c and the consumer uses us-east-1a and us-east-1b, the response includes the VPC endpoint services in the common Availability Zone, us-east-1a.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVpcEndpointServicesResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: ServiceName - in: query - required: false - description: One or more service names. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - - name: Filter - in: query - required: false - description: '

One or more filters.

  • service-name - The name of the service.

  • service-type - The type of service (Interface | Gateway).

  • supported-ip-address-types - The IP address type (ipv4 | ipv6).

  • tag:<key> - 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. 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.

  • 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.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: MaxResults - in: query - required: false - description: '

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

Constraint: If the value is greater than 1,000, we return only 1,000 items.

' - schema: - type: integer - - name: NextToken - in: query - required: false - description: The token for the next set of items to return. (You received this token from a prior call.) - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeVpcEndpointServices - operationId: POST_DescribeVpcEndpointServices - description: '

Describes available services to which you can create a VPC endpoint.

When the service provider and the consumer have different accounts in multiple Availability Zones, and the consumer views the VPC endpoint service information, the response only includes the common Availability Zones. For example, when the service provider account uses us-east-1a and us-east-1c and the consumer uses us-east-1a and us-east-1b, the response includes the VPC endpoint services in the common Availability Zone, us-east-1a.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVpcEndpointServicesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVpcEndpointServicesRequest' - parameters: [] - /?Action=DescribeVpcEndpoints&Version=2016-11-15: - get: - x-aws-operation-name: DescribeVpcEndpoints - operationId: GET_DescribeVpcEndpoints - description: Describes one or more of your VPC endpoints. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVpcEndpointsResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: VpcEndpointId - in: query - required: false - description: One or more endpoint IDs. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/VpcEndpointId' - - xml: - name: item - - name: Filter - in: query - required: false - description: '

One or more filters.

  • ip-address-type - The IP address type (ipv4 | ipv6).

  • service-name - The name of the service.

  • vpc-id - The ID of the VPC in which the endpoint resides.

  • vpc-endpoint-id - The ID of the endpoint.

  • vpc-endpoint-state - The state of the endpoint (pendingAcceptance | pending | available | deleting | deleted | rejected | failed).

  • vpc-endpoint-type - The type of VPC endpoint (Interface | Gateway | GatewayLoadBalancer).

  • tag:<key> - 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. 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.

  • 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.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: MaxResults - in: query - required: false - description: '

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

Constraint: If the value is greater than 1,000, we return only 1,000 items.

' - schema: - type: integer - - name: NextToken - in: query - required: false - description: The token for the next set of items to return. (You received this token from a prior call.) - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeVpcEndpoints - operationId: POST_DescribeVpcEndpoints - description: Describes one or more of your VPC endpoints. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVpcEndpointsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVpcEndpointsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeVpcPeeringConnections&Version=2016-11-15: - get: - x-aws-operation-name: DescribeVpcPeeringConnections - operationId: GET_DescribeVpcPeeringConnections - description: Describes one or more of your VPC peering connections. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVpcPeeringConnectionsResult' - parameters: - - name: Filter - in: query - required: false - description: '

One or more filters.

  • accepter-vpc-info.cidr-block - The IPv4 CIDR block of the accepter VPC.

  • accepter-vpc-info.owner-id - The ID of the Amazon Web Services account that owns the accepter VPC.

  • accepter-vpc-info.vpc-id - The ID of the accepter VPC.

  • expiration-time - The expiration date and time for the VPC peering connection.

  • requester-vpc-info.cidr-block - The IPv4 CIDR block of the requester''s VPC.

  • requester-vpc-info.owner-id - The ID of the Amazon Web Services account that owns the requester VPC.

  • requester-vpc-info.vpc-id - The ID of the requester VPC.

  • status-code - The status of the VPC peering connection (pending-acceptance | failed | expired | provisioning | active | deleting | deleted | rejected).

  • status-message - A message that provides more information about the status of the VPC peering connection, if applicable.

  • tag:<key> - 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. 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.

  • 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.

  • vpc-peering-connection-id - The ID of the VPC peering connection.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: VpcPeeringConnectionId - in: query - required: false - description: '

One or more VPC peering connection IDs.

Default: Describes all your VPC peering connections.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/VpcPeeringConnectionId' - - xml: - name: item - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - schema: - type: integer - minimum: 5 - maximum: 1000 - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeVpcPeeringConnections - operationId: POST_DescribeVpcPeeringConnections - description: Describes one or more of your VPC peering connections. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVpcPeeringConnectionsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVpcPeeringConnectionsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeVpcs&Version=2016-11-15: - get: - x-aws-operation-name: DescribeVpcs - operationId: GET_DescribeVpcs - description: Describes one or more of your VPCs. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVpcsResult' - parameters: - - name: Filter - in: query - required: false - description: '

One or more filters.

  • cidr - The primary IPv4 CIDR block of the VPC. The CIDR block you specify must exactly match the VPC''s CIDR block for information to be returned for the VPC. Must contain the slash followed by one or two digits (for example, /28).

  • cidr-block-association.cidr-block - An IPv4 CIDR block associated with the VPC.

  • cidr-block-association.association-id - The association ID for an IPv4 CIDR block associated with the VPC.

  • cidr-block-association.state - The state of an IPv4 CIDR block associated with the VPC.

  • dhcp-options-id - The ID of a set of DHCP options.

  • ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the VPC.

  • ipv6-cidr-block-association.ipv6-pool - The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.

  • ipv6-cidr-block-association.association-id - The association ID for an IPv6 CIDR block associated with the VPC.

  • ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the VPC.

  • is-default - Indicates whether the VPC is the default VPC.

  • owner-id - The ID of the Amazon Web Services account that owns the VPC.

  • state - The state of the VPC (pending | available).

  • tag:<key> - 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. 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.

  • 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.

  • vpc-id - The ID of the VPC.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: VpcId - in: query - required: false - description: '

One or more VPC IDs.

Default: Describes all your VPCs.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/VpcId' - - xml: - name: VpcId - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - schema: - type: integer - minimum: 5 - maximum: 1000 - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeVpcs - operationId: POST_DescribeVpcs - description: Describes one or more of your VPCs. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVpcsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVpcsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=DescribeVpnConnections&Version=2016-11-15: - get: - x-aws-operation-name: DescribeVpnConnections - operationId: GET_DescribeVpnConnections - description: '

Describes one or more of your VPN connections.

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVpnConnectionsResult' - parameters: - - name: Filter - in: query - required: false - description: '

One or more filters.

  • customer-gateway-configuration - The configuration information for the customer gateway.

  • customer-gateway-id - The ID of a customer gateway associated with the VPN connection.

  • state - The state of the VPN connection (pending | available | deleting | deleted).

  • option.static-routes-only - Indicates whether the connection has static routes only. Used for devices that do not support Border Gateway Protocol (BGP).

  • route.destination-cidr-block - The destination CIDR block. This corresponds to the subnet used in a customer data center.

  • bgp-asn - The BGP Autonomous System Number (ASN) associated with a BGP device.

  • tag:<key> - 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. 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.

  • 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.

  • type - The type of VPN connection. Currently the only supported type is ipsec.1.

  • vpn-connection-id - The ID of the VPN connection.

  • vpn-gateway-id - The ID of a virtual private gateway associated with the VPN connection.

  • transit-gateway-id - The ID of a transit gateway associated with the VPN connection.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: VpnConnectionId - in: query - required: false - description: '

One or more VPN connection IDs.

Default: Describes your VPN connections.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/VpnConnectionId' - - xml: - name: VpnConnectionId - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeVpnConnections - operationId: POST_DescribeVpnConnections - description: '

Describes one or more of your VPN connections.

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVpnConnectionsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVpnConnectionsRequest' - parameters: [] - /?Action=DescribeVpnGateways&Version=2016-11-15: - get: - x-aws-operation-name: DescribeVpnGateways - operationId: GET_DescribeVpnGateways - description: '

Describes one or more of your virtual private gateways.

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVpnGatewaysResult' - parameters: - - name: Filter - in: query - required: false - description: '

One or more filters.

  • amazon-side-asn - The Autonomous System Number (ASN) for the Amazon side of the gateway.

  • attachment.state - The current state of the attachment between the gateway and the VPC (attaching | attached | detaching | detached).

  • attachment.vpc-id - The ID of an attached VPC.

  • availability-zone - The Availability Zone for the virtual private gateway (if applicable).

  • state - The state of the virtual private gateway (pending | available | deleting | deleted).

  • tag:<key> - 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. 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.

  • 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.

  • type - The type of virtual private gateway. Currently the only supported type is ipsec.1.

  • vpn-gateway-id - The ID of the virtual private gateway.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: VpnGatewayId - in: query - required: false - description: '

One or more virtual private gateway IDs.

Default: Describes all your virtual private gateways.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/VpnGatewayId' - - xml: - name: VpnGatewayId - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DescribeVpnGateways - operationId: POST_DescribeVpnGateways - description: '

Describes one or more of your virtual private gateways.

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVpnGatewaysResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DescribeVpnGatewaysRequest' - parameters: [] - /?Action=DetachClassicLinkVpc&Version=2016-11-15: - get: - x-aws-operation-name: DetachClassicLinkVpc - operationId: GET_DetachClassicLinkVpc - description: 'Unlinks (detaches) a linked EC2-Classic instance from a VPC. After the instance has been unlinked, the VPC security groups are no longer associated with it. An instance is automatically unlinked from a VPC when it''s stopped.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DetachClassicLinkVpcResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: InstanceId - in: query - required: true - description: The ID of the instance to unlink from the VPC. - schema: - type: string - - name: VpcId - in: query - required: true - description: The ID of the VPC to which the instance is linked. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DetachClassicLinkVpc - operationId: POST_DetachClassicLinkVpc - description: 'Unlinks (detaches) a linked EC2-Classic instance from a VPC. After the instance has been unlinked, the VPC security groups are no longer associated with it. An instance is automatically unlinked from a VPC when it''s stopped.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DetachClassicLinkVpcResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DetachClassicLinkVpcRequest' - parameters: [] - /?Action=DetachInternetGateway&Version=2016-11-15: - get: - x-aws-operation-name: DetachInternetGateway - operationId: GET_DetachInternetGateway - description: 'Detaches an internet gateway from a VPC, disabling connectivity between the internet and the VPC. The VPC must not contain any running instances with Elastic IP addresses or public IPv4 addresses.' - responses: - '200': - description: Success - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: InternetGatewayId - in: query - required: true - description: The ID of the internet gateway. - schema: - type: string - - name: VpcId - in: query - required: true - description: The ID of the VPC. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DetachInternetGateway - operationId: POST_DetachInternetGateway - description: 'Detaches an internet gateway from a VPC, disabling connectivity between the internet and the VPC. The VPC must not contain any running instances with Elastic IP addresses or public IPv4 addresses.' - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DetachInternetGatewayRequest' - parameters: [] - /?Action=DetachNetworkInterface&Version=2016-11-15: - get: - x-aws-operation-name: DetachNetworkInterface - operationId: GET_DetachNetworkInterface - description: Detaches a network interface from an instance. - responses: - '200': - description: Success - parameters: - - name: AttachmentId - in: query - required: true - description: The ID of the attachment. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: Force - in: query - required: false - description: '

Specifies whether to force a detachment.

  • Use the Force parameter only as a last resort to detach a network interface from a failed instance.

  • If you use the Force parameter to detach a network interface, you might not be able to attach a different network interface to the same index on the instance without first stopping and starting the instance.

  • If you force the detachment of a network interface, the instance metadata might not get updated. This means that the attributes associated with the detached network interface might still be visible. The instance metadata will get updated when you stop and start the instance.

' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DetachNetworkInterface - operationId: POST_DetachNetworkInterface - description: Detaches a network interface from an instance. - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DetachNetworkInterfaceRequest' - parameters: [] - /?Action=DetachVolume&Version=2016-11-15: - get: - x-aws-operation-name: DetachVolume - operationId: GET_DetachVolume - description: '

Detaches an EBS volume from an instance. Make sure to unmount any file systems on the device within your operating system before detaching the volume. Failure to do so can result in the volume becoming stuck in the busy state while detaching. If this happens, detachment can be delayed indefinitely until you unmount the volume, force detachment, reboot the instance, or all three. If an EBS volume is the root device of an instance, it can''t be detached while the instance is running. To detach the root volume, stop the instance first.

When a volume with an Amazon Web Services Marketplace product code is detached from an instance, the product code is no longer associated with the instance.

For more information, see Detach an Amazon EBS volume in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/VolumeAttachment' - parameters: - - name: Device - in: query - required: false - description: The device name. - schema: - type: string - - name: Force - in: query - required: false - description: 'Forces detachment if the previous detachment attempt did not occur cleanly (for example, logging into an instance, unmounting the volume, and detaching normally). This option can lead to data loss or a corrupted file system. Use this option only as a last resort to detach a volume from a failed instance. The instance won''t have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures.' - schema: - type: boolean - - name: InstanceId - in: query - required: false - description: 'The ID of the instance. If you are detaching a Multi-Attach enabled volume, you must specify an instance ID.' - schema: - type: string - - name: VolumeId - in: query - required: true - description: The ID of the volume. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DetachVolume - operationId: POST_DetachVolume - description: '

Detaches an EBS volume from an instance. Make sure to unmount any file systems on the device within your operating system before detaching the volume. Failure to do so can result in the volume becoming stuck in the busy state while detaching. If this happens, detachment can be delayed indefinitely until you unmount the volume, force detachment, reboot the instance, or all three. If an EBS volume is the root device of an instance, it can''t be detached while the instance is running. To detach the root volume, stop the instance first.

When a volume with an Amazon Web Services Marketplace product code is detached from an instance, the product code is no longer associated with the instance.

For more information, see Detach an Amazon EBS volume in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/VolumeAttachment' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DetachVolumeRequest' - parameters: [] - /?Action=DetachVpnGateway&Version=2016-11-15: - get: - x-aws-operation-name: DetachVpnGateway - operationId: GET_DetachVpnGateway - description:

Detaches a virtual private gateway from a VPC. You do this if you're planning to turn off the VPC and not use it anymore. You can confirm a virtual private gateway has been completely detached from a VPC by describing the virtual private gateway (any attachments to the virtual private gateway are also described).

You must wait for the attachment's state to switch to detached before you can delete the VPC or attach a different VPC to the virtual private gateway.

- responses: - '200': - description: Success - parameters: - - name: VpcId - in: query - required: true - description: The ID of the VPC. - schema: - type: string - - name: VpnGatewayId - in: query - required: true - description: The ID of the virtual private gateway. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DetachVpnGateway - operationId: POST_DetachVpnGateway - description:

Detaches a virtual private gateway from a VPC. You do this if you're planning to turn off the VPC and not use it anymore. You can confirm a virtual private gateway has been completely detached from a VPC by describing the virtual private gateway (any attachments to the virtual private gateway are also described).

You must wait for the attachment's state to switch to detached before you can delete the VPC or attach a different VPC to the virtual private gateway.

- responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DetachVpnGatewayRequest' - parameters: [] - /?Action=DisableEbsEncryptionByDefault&Version=2016-11-15: - get: - x-aws-operation-name: DisableEbsEncryptionByDefault - operationId: GET_DisableEbsEncryptionByDefault - description: '

Disables EBS encryption by default for your account in the current Region.

After you disable encryption by default, you can still create encrypted volumes by enabling encryption when you create each volume.

Disabling encryption by default does not change the encryption status of your existing volumes.

For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DisableEbsEncryptionByDefaultResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DisableEbsEncryptionByDefault - operationId: POST_DisableEbsEncryptionByDefault - description: '

Disables EBS encryption by default for your account in the current Region.

After you disable encryption by default, you can still create encrypted volumes by enabling encryption when you create each volume.

Disabling encryption by default does not change the encryption status of your existing volumes.

For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DisableEbsEncryptionByDefaultResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DisableEbsEncryptionByDefaultRequest' - parameters: [] - /?Action=DisableFastLaunch&Version=2016-11-15: - get: - x-aws-operation-name: DisableFastLaunch - operationId: GET_DisableFastLaunch - description: '

Discontinue faster launching for a Windows AMI, and clean up existing pre-provisioned snapshots. When you disable faster launching, the AMI uses the standard launch process for each instance. All pre-provisioned snapshots must be removed before you can enable faster launching again.

To change these settings, you must own the AMI.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DisableFastLaunchResult' - parameters: - - name: ImageId - in: query - required: true - description: 'The ID of the image for which you’re turning off faster launching, and removing pre-provisioned snapshots.' - schema: - type: string - - name: Force - in: query - required: false - description: Forces the image settings to turn off faster launching for your Windows AMI. This parameter overrides any errors that are encountered while cleaning up resources in your account. - schema: - type: boolean - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DisableFastLaunch - operationId: POST_DisableFastLaunch - description: '

Discontinue faster launching for a Windows AMI, and clean up existing pre-provisioned snapshots. When you disable faster launching, the AMI uses the standard launch process for each instance. All pre-provisioned snapshots must be removed before you can enable faster launching again.

To change these settings, you must own the AMI.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DisableFastLaunchResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DisableFastLaunchRequest' - parameters: [] - /?Action=DisableFastSnapshotRestores&Version=2016-11-15: - get: - x-aws-operation-name: DisableFastSnapshotRestores - operationId: GET_DisableFastSnapshotRestores - description: Disables fast snapshot restores for the specified snapshots in the specified Availability Zones. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DisableFastSnapshotRestoresResult' - parameters: - - name: AvailabilityZone - in: query - required: true - description: 'One or more Availability Zones. For example, us-east-2a.' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: AvailabilityZone - - name: SourceSnapshotId - in: query - required: true - description: 'The IDs of one or more snapshots. For example, snap-1234567890abcdef0.' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/SnapshotId' - - xml: - name: SnapshotId - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DisableFastSnapshotRestores - operationId: POST_DisableFastSnapshotRestores - description: Disables fast snapshot restores for the specified snapshots in the specified Availability Zones. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DisableFastSnapshotRestoresResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DisableFastSnapshotRestoresRequest' - parameters: [] - /?Action=DisableImageDeprecation&Version=2016-11-15: - get: - x-aws-operation-name: DisableImageDeprecation - operationId: GET_DisableImageDeprecation - description: '

Cancels the deprecation of the specified AMI.

For more information, see Deprecate an AMI in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DisableImageDeprecationResult' - parameters: - - name: ImageId - in: query - required: true - description: The ID of the AMI. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DisableImageDeprecation - operationId: POST_DisableImageDeprecation - description: '

Cancels the deprecation of the specified AMI.

For more information, see Deprecate an AMI in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DisableImageDeprecationResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DisableImageDeprecationRequest' - parameters: [] - /?Action=DisableIpamOrganizationAdminAccount&Version=2016-11-15: - get: - x-aws-operation-name: DisableIpamOrganizationAdminAccount - operationId: GET_DisableIpamOrganizationAdminAccount - description: 'Disable the IPAM account. For more information, see Enable integration with Organizations in the Amazon VPC IPAM User Guide. ' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DisableIpamOrganizationAdminAccountResult' - parameters: - - name: DryRun - in: query - required: false - description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: DelegatedAdminAccountId - in: query - required: true - description: The Organizations member account ID that you want to disable as IPAM account. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DisableIpamOrganizationAdminAccount - operationId: POST_DisableIpamOrganizationAdminAccount - description: 'Disable the IPAM account. For more information, see Enable integration with Organizations in the Amazon VPC IPAM User Guide. ' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DisableIpamOrganizationAdminAccountResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DisableIpamOrganizationAdminAccountRequest' - parameters: [] - /?Action=DisableSerialConsoleAccess&Version=2016-11-15: - get: - x-aws-operation-name: DisableSerialConsoleAccess - operationId: GET_DisableSerialConsoleAccess - description: 'Disables access to the EC2 serial console of all instances for your account. By default, access to the EC2 serial console is disabled for your account. For more information, see Manage account access to the EC2 serial console in the Amazon EC2 User Guide.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DisableSerialConsoleAccessResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DisableSerialConsoleAccess - operationId: POST_DisableSerialConsoleAccess - description: 'Disables access to the EC2 serial console of all instances for your account. By default, access to the EC2 serial console is disabled for your account. For more information, see Manage account access to the EC2 serial console in the Amazon EC2 User Guide.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DisableSerialConsoleAccessResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DisableSerialConsoleAccessRequest' - parameters: [] - /?Action=DisableTransitGatewayRouteTablePropagation&Version=2016-11-15: - get: - x-aws-operation-name: DisableTransitGatewayRouteTablePropagation - operationId: GET_DisableTransitGatewayRouteTablePropagation - description: Disables the specified resource attachment from propagating routes to the specified propagation route table. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DisableTransitGatewayRouteTablePropagationResult' - parameters: - - name: TransitGatewayRouteTableId - in: query - required: true - description: The ID of the propagation route table. - schema: - type: string - - name: TransitGatewayAttachmentId - in: query - required: true - description: The ID of the attachment. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DisableTransitGatewayRouteTablePropagation - operationId: POST_DisableTransitGatewayRouteTablePropagation - description: Disables the specified resource attachment from propagating routes to the specified propagation route table. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DisableTransitGatewayRouteTablePropagationResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DisableTransitGatewayRouteTablePropagationRequest' - parameters: [] - /?Action=DisableVgwRoutePropagation&Version=2016-11-15: - get: - x-aws-operation-name: DisableVgwRoutePropagation - operationId: GET_DisableVgwRoutePropagation - description: Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC. - responses: - '200': - description: Success - parameters: - - name: GatewayId - in: query - required: true - description: The ID of the virtual private gateway. - schema: - type: string - - name: RouteTableId - in: query - required: true - description: The ID of the route table. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DisableVgwRoutePropagation - operationId: POST_DisableVgwRoutePropagation - description: Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC. - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DisableVgwRoutePropagationRequest' - parameters: [] - /?Action=DisableVpcClassicLink&Version=2016-11-15: - get: - x-aws-operation-name: DisableVpcClassicLink - operationId: GET_DisableVpcClassicLink - description: Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that has EC2-Classic instances linked to it. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DisableVpcClassicLinkResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: VpcId - in: query - required: true - description: The ID of the VPC. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DisableVpcClassicLink - operationId: POST_DisableVpcClassicLink - description: Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that has EC2-Classic instances linked to it. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DisableVpcClassicLinkResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DisableVpcClassicLinkRequest' - parameters: [] - /?Action=DisableVpcClassicLinkDnsSupport&Version=2016-11-15: - get: - x-aws-operation-name: DisableVpcClassicLinkDnsSupport - operationId: GET_DisableVpcClassicLinkDnsSupport - description: '

Disables ClassicLink DNS support for a VPC. If disabled, DNS hostnames resolve to public IP addresses when addressed between a linked EC2-Classic instance and instances in the VPC to which it''s linked. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

You must specify a VPC ID in the request.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DisableVpcClassicLinkDnsSupportResult' - parameters: - - name: VpcId - in: query - required: false - description: The ID of the VPC. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DisableVpcClassicLinkDnsSupport - operationId: POST_DisableVpcClassicLinkDnsSupport - description: '

Disables ClassicLink DNS support for a VPC. If disabled, DNS hostnames resolve to public IP addresses when addressed between a linked EC2-Classic instance and instances in the VPC to which it''s linked. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

You must specify a VPC ID in the request.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DisableVpcClassicLinkDnsSupportResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DisableVpcClassicLinkDnsSupportRequest' - parameters: [] - /?Action=DisassociateAddress&Version=2016-11-15: - get: - x-aws-operation-name: DisassociateAddress - operationId: GET_DisassociateAddress - description: '

Disassociates an Elastic IP address from the instance or network interface it''s associated with.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn''t return an error.

' - responses: - '200': - description: Success - parameters: - - name: AssociationId - in: query - required: false - description: '[EC2-VPC] The association ID. Required for EC2-VPC.' - schema: - type: string - - name: PublicIp - in: query - required: false - description: '[EC2-Classic] The Elastic IP address. Required for EC2-Classic.' - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DisassociateAddress - operationId: POST_DisassociateAddress - description: '

Disassociates an Elastic IP address from the instance or network interface it''s associated with.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn''t return an error.

' - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DisassociateAddressRequest' - parameters: [] - /?Action=DisassociateClientVpnTargetNetwork&Version=2016-11-15: - get: - x-aws-operation-name: DisassociateClientVpnTargetNetwork - operationId: GET_DisassociateClientVpnTargetNetwork - description: '

Disassociates a target network from the specified Client VPN endpoint. When you disassociate the last target network from a Client VPN, the following happens:

  • The route that was automatically added for the VPC is deleted

  • All active client connections are terminated

  • New client connections are disallowed

  • The Client VPN endpoint''s status changes to pending-associate

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DisassociateClientVpnTargetNetworkResult' - parameters: - - name: ClientVpnEndpointId - in: query - required: true - description: The ID of the Client VPN endpoint from which to disassociate the target network. - schema: - type: string - - name: AssociationId - in: query - required: true - description: The ID of the target network association. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DisassociateClientVpnTargetNetwork - operationId: POST_DisassociateClientVpnTargetNetwork - description: '

Disassociates a target network from the specified Client VPN endpoint. When you disassociate the last target network from a Client VPN, the following happens:

  • The route that was automatically added for the VPC is deleted

  • All active client connections are terminated

  • New client connections are disallowed

  • The Client VPN endpoint''s status changes to pending-associate

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DisassociateClientVpnTargetNetworkResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DisassociateClientVpnTargetNetworkRequest' - parameters: [] - /?Action=DisassociateEnclaveCertificateIamRole&Version=2016-11-15: - get: - x-aws-operation-name: DisassociateEnclaveCertificateIamRole - operationId: GET_DisassociateEnclaveCertificateIamRole - description: 'Disassociates an IAM role from an Certificate Manager (ACM) certificate. Disassociating an IAM role from an ACM certificate removes the Amazon S3 object that contains the certificate, certificate chain, and encrypted private key from the Amazon S3 bucket. It also revokes the IAM role''s permission to use the KMS key used to encrypt the private key. This effectively revokes the role''s permission to use the certificate.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DisassociateEnclaveCertificateIamRoleResult' - parameters: - - name: CertificateArn - in: query - required: false - description: The ARN of the ACM certificate from which to disassociate the IAM role. - schema: - type: string - minLength: 1 - maxLength: 1283 - - name: RoleArn - in: query - required: false - description: The ARN of the IAM role to disassociate. - schema: - type: string - minLength: 1 - maxLength: 1283 - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DisassociateEnclaveCertificateIamRole - operationId: POST_DisassociateEnclaveCertificateIamRole - description: 'Disassociates an IAM role from an Certificate Manager (ACM) certificate. Disassociating an IAM role from an ACM certificate removes the Amazon S3 object that contains the certificate, certificate chain, and encrypted private key from the Amazon S3 bucket. It also revokes the IAM role''s permission to use the KMS key used to encrypt the private key. This effectively revokes the role''s permission to use the certificate.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DisassociateEnclaveCertificateIamRoleResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DisassociateEnclaveCertificateIamRoleRequest' - parameters: [] - /?Action=DisassociateIamInstanceProfile&Version=2016-11-15: - get: - x-aws-operation-name: DisassociateIamInstanceProfile - operationId: GET_DisassociateIamInstanceProfile - description:

Disassociates an IAM instance profile from a running or stopped instance.

Use DescribeIamInstanceProfileAssociations to get the association ID.

- responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DisassociateIamInstanceProfileResult' - parameters: - - name: AssociationId - in: query - required: true - description: The ID of the IAM instance profile association. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DisassociateIamInstanceProfile - operationId: POST_DisassociateIamInstanceProfile - description:

Disassociates an IAM instance profile from a running or stopped instance.

Use DescribeIamInstanceProfileAssociations to get the association ID.

- responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DisassociateIamInstanceProfileResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DisassociateIamInstanceProfileRequest' - parameters: [] - /?Action=DisassociateInstanceEventWindow&Version=2016-11-15: - get: - x-aws-operation-name: DisassociateInstanceEventWindow - operationId: GET_DisassociateInstanceEventWindow - description: '

Disassociates one or more targets from an event window.

For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DisassociateInstanceEventWindowResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: InstanceEventWindowId - in: query - required: true - description: The ID of the event window. - schema: - type: string - - name: AssociationTarget - in: query - required: true - description: One or more targets to disassociate from the specified event window. - schema: - type: object - properties: - InstanceId: - allOf: - - $ref: '#/components/schemas/InstanceIdList' - - description: The IDs of the instances to disassociate from the event window. - InstanceTag: - allOf: - - $ref: '#/components/schemas/TagList' - - description: The instance tags to disassociate from the event window. Any instances associated with the tags will be disassociated from the event window. - DedicatedHostId: - allOf: - - $ref: '#/components/schemas/DedicatedHostIdList' - - description: The IDs of the Dedicated Hosts to disassociate from the event window. - description: The targets to disassociate from the specified event window. - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DisassociateInstanceEventWindow - operationId: POST_DisassociateInstanceEventWindow - description: '

Disassociates one or more targets from an event window.

For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DisassociateInstanceEventWindowResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DisassociateInstanceEventWindowRequest' - parameters: [] - /?Action=DisassociateRouteTable&Version=2016-11-15: - get: - x-aws-operation-name: DisassociateRouteTable - operationId: GET_DisassociateRouteTable - description: '

Disassociates a subnet or gateway from a route table.

After you perform this action, the subnet no longer uses the routes in the route table. Instead, it uses the routes in the VPC''s main route table. For more information about route tables, see Route tables in the Amazon Virtual Private Cloud User Guide.

' - responses: - '200': - description: Success - parameters: - - name: AssociationId - in: query - required: true - description: The association ID representing the current association between the route table and subnet or gateway. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DisassociateRouteTable - operationId: POST_DisassociateRouteTable - description: '

Disassociates a subnet or gateway from a route table.

After you perform this action, the subnet no longer uses the routes in the route table. Instead, it uses the routes in the VPC''s main route table. For more information about route tables, see Route tables in the Amazon Virtual Private Cloud User Guide.

' - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DisassociateRouteTableRequest' - parameters: [] - /?Action=DisassociateSubnetCidrBlock&Version=2016-11-15: - get: - x-aws-operation-name: DisassociateSubnetCidrBlock - operationId: GET_DisassociateSubnetCidrBlock - description: 'Disassociates a CIDR block from a subnet. Currently, you can disassociate an IPv6 CIDR block only. You must detach or delete all gateways and resources that are associated with the CIDR block before you can disassociate it. ' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DisassociateSubnetCidrBlockResult' - parameters: - - name: AssociationId - in: query - required: true - description: The association ID for the CIDR block. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DisassociateSubnetCidrBlock - operationId: POST_DisassociateSubnetCidrBlock - description: 'Disassociates a CIDR block from a subnet. Currently, you can disassociate an IPv6 CIDR block only. You must detach or delete all gateways and resources that are associated with the CIDR block before you can disassociate it. ' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DisassociateSubnetCidrBlockResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DisassociateSubnetCidrBlockRequest' - parameters: [] - /?Action=DisassociateTransitGatewayMulticastDomain&Version=2016-11-15: - get: - x-aws-operation-name: DisassociateTransitGatewayMulticastDomain - operationId: GET_DisassociateTransitGatewayMulticastDomain - description: 'Disassociates the specified subnets from the transit gateway multicast domain. ' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DisassociateTransitGatewayMulticastDomainResult' - parameters: - - name: TransitGatewayMulticastDomainId - in: query - required: false - description: The ID of the transit gateway multicast domain. - schema: - type: string - - name: TransitGatewayAttachmentId - in: query - required: false - description: The ID of the attachment. - schema: - type: string - - name: SubnetIds - in: query - required: false - description: The IDs of the subnets; - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/SubnetId' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DisassociateTransitGatewayMulticastDomain - operationId: POST_DisassociateTransitGatewayMulticastDomain - description: 'Disassociates the specified subnets from the transit gateway multicast domain. ' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DisassociateTransitGatewayMulticastDomainResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DisassociateTransitGatewayMulticastDomainRequest' - parameters: [] - /?Action=DisassociateTransitGatewayRouteTable&Version=2016-11-15: - get: - x-aws-operation-name: DisassociateTransitGatewayRouteTable - operationId: GET_DisassociateTransitGatewayRouteTable - description: Disassociates a resource attachment from a transit gateway route table. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DisassociateTransitGatewayRouteTableResult' - parameters: - - name: TransitGatewayRouteTableId - in: query - required: true - description: The ID of the transit gateway route table. - schema: - type: string - - name: TransitGatewayAttachmentId - in: query - required: true - description: The ID of the attachment. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DisassociateTransitGatewayRouteTable - operationId: POST_DisassociateTransitGatewayRouteTable - description: Disassociates a resource attachment from a transit gateway route table. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DisassociateTransitGatewayRouteTableResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DisassociateTransitGatewayRouteTableRequest' - parameters: [] - /?Action=DisassociateTrunkInterface&Version=2016-11-15: - get: - x-aws-operation-name: DisassociateTrunkInterface - operationId: GET_DisassociateTrunkInterface - description: '

This API action is currently in limited preview only. If you are interested in using this feature, contact your account manager.

Removes an association between a branch network interface with a trunk network interface.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DisassociateTrunkInterfaceResult' - parameters: - - name: AssociationId - in: query - required: true - description: The ID of the association - schema: - type: string - - name: ClientToken - in: query - required: false - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.' - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DisassociateTrunkInterface - operationId: POST_DisassociateTrunkInterface - description: '

This API action is currently in limited preview only. If you are interested in using this feature, contact your account manager.

Removes an association between a branch network interface with a trunk network interface.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DisassociateTrunkInterfaceResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DisassociateTrunkInterfaceRequest' - parameters: [] - /?Action=DisassociateVpcCidrBlock&Version=2016-11-15: - get: - x-aws-operation-name: DisassociateVpcCidrBlock - operationId: GET_DisassociateVpcCidrBlock - description: '

Disassociates a CIDR block from a VPC. To disassociate the CIDR block, you must specify its association ID. You can get the association ID by using DescribeVpcs. You must detach or delete all gateways and resources that are associated with the CIDR block before you can disassociate it.

You cannot disassociate the CIDR block with which you originally created the VPC (the primary CIDR block).

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DisassociateVpcCidrBlockResult' - parameters: - - name: AssociationId - in: query - required: true - description: The association ID for the CIDR block. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: DisassociateVpcCidrBlock - operationId: POST_DisassociateVpcCidrBlock - description: '

Disassociates a CIDR block from a VPC. To disassociate the CIDR block, you must specify its association ID. You can get the association ID by using DescribeVpcs. You must detach or delete all gateways and resources that are associated with the CIDR block before you can disassociate it.

You cannot disassociate the CIDR block with which you originally created the VPC (the primary CIDR block).

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/DisassociateVpcCidrBlockResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/DisassociateVpcCidrBlockRequest' - parameters: [] - /?Action=EnableEbsEncryptionByDefault&Version=2016-11-15: - get: - x-aws-operation-name: EnableEbsEncryptionByDefault - operationId: GET_EnableEbsEncryptionByDefault - description: '

Enables EBS encryption by default for your account in the current Region.

After you enable encryption by default, the EBS volumes that you create are always encrypted, either using the default KMS key or the KMS key that you specified when you created each volume. For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.

You can specify the default KMS key for encryption by default using ModifyEbsDefaultKmsKeyId or ResetEbsDefaultKmsKeyId.

Enabling encryption by default has no effect on the encryption status of your existing volumes.

After you enable encryption by default, you can no longer launch instances using instance types that do not support encryption. For more information, see Supported instance types.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/EnableEbsEncryptionByDefaultResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: EnableEbsEncryptionByDefault - operationId: POST_EnableEbsEncryptionByDefault - description: '

Enables EBS encryption by default for your account in the current Region.

After you enable encryption by default, the EBS volumes that you create are always encrypted, either using the default KMS key or the KMS key that you specified when you created each volume. For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.

You can specify the default KMS key for encryption by default using ModifyEbsDefaultKmsKeyId or ResetEbsDefaultKmsKeyId.

Enabling encryption by default has no effect on the encryption status of your existing volumes.

After you enable encryption by default, you can no longer launch instances using instance types that do not support encryption. For more information, see Supported instance types.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/EnableEbsEncryptionByDefaultResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/EnableEbsEncryptionByDefaultRequest' - parameters: [] - /?Action=EnableFastLaunch&Version=2016-11-15: - get: - x-aws-operation-name: EnableFastLaunch - operationId: GET_EnableFastLaunch - description: '

When you enable faster launching for a Windows AMI, images are pre-provisioned, using snapshots to launch instances up to 65% faster. To create the optimized Windows image, Amazon EC2 launches an instance and runs through Sysprep steps, rebooting as required. Then it creates a set of reserved snapshots that are used for subsequent launches. The reserved snapshots are automatically replenished as they are used, depending on your settings for launch frequency.

To change these settings, you must own the AMI.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/EnableFastLaunchResult' - parameters: - - name: ImageId - in: query - required: true - description: The ID of the image for which you’re enabling faster launching. - schema: - type: string - - name: ResourceType - in: query - required: false - description: 'The type of resource to use for pre-provisioning the Windows AMI for faster launching. Supported values include: snapshot, which is the default value.' - schema: - type: string - - name: SnapshotConfiguration - in: query - required: false - description: Configuration settings for creating and managing the snapshots that are used for pre-provisioning the Windows AMI for faster launching. The associated ResourceType must be snapshot. - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled Windows AMI. - description: Configuration settings for creating and managing pre-provisioned snapshots for a fast-launch enabled Windows AMI. - - name: LaunchTemplate - in: query - required: false - description: 'The launch template to use when launching Windows instances from pre-provisioned snapshots. Launch template parameters can include either the name or ID of the launch template, but not both.' - schema: - type: object - required: - - Version - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The version of the launch template to use for faster launching for a Windows AMI. - description: '

Request to create a launch template for a fast-launch enabled Windows AMI.

Note - You can specify either the LaunchTemplateName or the LaunchTemplateId, but not both.

' - - name: MaxParallelLaunches - in: query - required: false - description: 'The maximum number of parallel instances to launch for creating resources. Value must be 6 or greater. ' - schema: - type: integer - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: EnableFastLaunch - operationId: POST_EnableFastLaunch - description: '

When you enable faster launching for a Windows AMI, images are pre-provisioned, using snapshots to launch instances up to 65% faster. To create the optimized Windows image, Amazon EC2 launches an instance and runs through Sysprep steps, rebooting as required. Then it creates a set of reserved snapshots that are used for subsequent launches. The reserved snapshots are automatically replenished as they are used, depending on your settings for launch frequency.

To change these settings, you must own the AMI.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/EnableFastLaunchResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/EnableFastLaunchRequest' - parameters: [] - /?Action=EnableFastSnapshotRestores&Version=2016-11-15: - get: - x-aws-operation-name: EnableFastSnapshotRestores - operationId: GET_EnableFastSnapshotRestores - description: '

Enables fast snapshot restores for the specified snapshots in the specified Availability Zones.

You get the full benefit of fast snapshot restores after they enter the enabled state. To get the current state of fast snapshot restores, use DescribeFastSnapshotRestores. To disable fast snapshot restores, use DisableFastSnapshotRestores.

For more information, see Amazon EBS fast snapshot restore in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/EnableFastSnapshotRestoresResult' - parameters: - - name: AvailabilityZone - in: query - required: true - description: 'One or more Availability Zones. For example, us-east-2a.' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: AvailabilityZone - - name: SourceSnapshotId - in: query - required: true - description: 'The IDs of one or more snapshots. For example, snap-1234567890abcdef0. You can specify a snapshot that was shared with you from another Amazon Web Services account.' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/SnapshotId' - - xml: - name: SnapshotId - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: EnableFastSnapshotRestores - operationId: POST_EnableFastSnapshotRestores - description: '

Enables fast snapshot restores for the specified snapshots in the specified Availability Zones.

You get the full benefit of fast snapshot restores after they enter the enabled state. To get the current state of fast snapshot restores, use DescribeFastSnapshotRestores. To disable fast snapshot restores, use DisableFastSnapshotRestores.

For more information, see Amazon EBS fast snapshot restore in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/EnableFastSnapshotRestoresResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/EnableFastSnapshotRestoresRequest' - parameters: [] - /?Action=EnableImageDeprecation&Version=2016-11-15: - get: - x-aws-operation-name: EnableImageDeprecation - operationId: GET_EnableImageDeprecation - description: '

Enables deprecation of the specified AMI at the specified date and time.

For more information, see Deprecate an AMI in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/EnableImageDeprecationResult' - parameters: - - name: ImageId - in: query - required: true - description: The ID of the AMI. - schema: - type: string - - name: DeprecateAt - in: query - required: true - description: '

The date and time to deprecate the AMI, in UTC, in the following format: YYYY-MM-DDTHH:MM:SSZ. If you specify a value for seconds, Amazon EC2 rounds the seconds to the nearest minute.

You can’t specify a date in the past. The upper limit for DeprecateAt is 10 years from now.

' - schema: - type: string - format: date-time - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: EnableImageDeprecation - operationId: POST_EnableImageDeprecation - description: '

Enables deprecation of the specified AMI at the specified date and time.

For more information, see Deprecate an AMI in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/EnableImageDeprecationResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/EnableImageDeprecationRequest' - parameters: [] - /?Action=EnableIpamOrganizationAdminAccount&Version=2016-11-15: - get: - x-aws-operation-name: EnableIpamOrganizationAdminAccount - operationId: GET_EnableIpamOrganizationAdminAccount - description: 'Enable an Organizations member account as the IPAM admin account. You cannot select the Organizations management account as the IPAM admin account. For more information, see Enable integration with Organizations in the Amazon VPC IPAM User Guide. ' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/EnableIpamOrganizationAdminAccountResult' - parameters: - - name: DryRun - in: query - required: false - description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: DelegatedAdminAccountId - in: query - required: true - description: The Organizations member account ID that you want to enable as the IPAM account. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: EnableIpamOrganizationAdminAccount - operationId: POST_EnableIpamOrganizationAdminAccount - description: 'Enable an Organizations member account as the IPAM admin account. You cannot select the Organizations management account as the IPAM admin account. For more information, see Enable integration with Organizations in the Amazon VPC IPAM User Guide. ' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/EnableIpamOrganizationAdminAccountResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/EnableIpamOrganizationAdminAccountRequest' - parameters: [] - /?Action=EnableSerialConsoleAccess&Version=2016-11-15: - get: - x-aws-operation-name: EnableSerialConsoleAccess - operationId: GET_EnableSerialConsoleAccess - description: 'Enables access to the EC2 serial console of all instances for your account. By default, access to the EC2 serial console is disabled for your account. For more information, see Manage account access to the EC2 serial console in the Amazon EC2 User Guide.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/EnableSerialConsoleAccessResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: EnableSerialConsoleAccess - operationId: POST_EnableSerialConsoleAccess - description: 'Enables access to the EC2 serial console of all instances for your account. By default, access to the EC2 serial console is disabled for your account. For more information, see Manage account access to the EC2 serial console in the Amazon EC2 User Guide.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/EnableSerialConsoleAccessResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/EnableSerialConsoleAccessRequest' - parameters: [] - /?Action=EnableTransitGatewayRouteTablePropagation&Version=2016-11-15: - get: - x-aws-operation-name: EnableTransitGatewayRouteTablePropagation - operationId: GET_EnableTransitGatewayRouteTablePropagation - description: Enables the specified attachment to propagate routes to the specified propagation route table. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/EnableTransitGatewayRouteTablePropagationResult' - parameters: - - name: TransitGatewayRouteTableId - in: query - required: true - description: The ID of the propagation route table. - schema: - type: string - - name: TransitGatewayAttachmentId - in: query - required: true - description: The ID of the attachment. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: EnableTransitGatewayRouteTablePropagation - operationId: POST_EnableTransitGatewayRouteTablePropagation - description: Enables the specified attachment to propagate routes to the specified propagation route table. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/EnableTransitGatewayRouteTablePropagationResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/EnableTransitGatewayRouteTablePropagationRequest' - parameters: [] - /?Action=EnableVgwRoutePropagation&Version=2016-11-15: - get: - x-aws-operation-name: EnableVgwRoutePropagation - operationId: GET_EnableVgwRoutePropagation - description: Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC. - responses: - '200': - description: Success - parameters: - - name: GatewayId - in: query - required: true - description: 'The ID of the virtual private gateway that is attached to a VPC. The virtual private gateway must be attached to the same VPC that the routing tables are associated with. ' - schema: - type: string - - name: RouteTableId - in: query - required: true - description: 'The ID of the route table. The routing table must be associated with the same VPC that the virtual private gateway is attached to. ' - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: EnableVgwRoutePropagation - operationId: POST_EnableVgwRoutePropagation - description: Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC. - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/EnableVgwRoutePropagationRequest' - parameters: [] - /?Action=EnableVolumeIO&Version=2016-11-15: - get: - x-aws-operation-name: EnableVolumeIO - operationId: GET_EnableVolumeIO - description: Enables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent. - responses: - '200': - description: Success - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: VolumeId - in: query - required: true - description: The ID of the volume. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: EnableVolumeIO - operationId: POST_EnableVolumeIO - description: Enables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent. - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/EnableVolumeIORequest' - parameters: [] - /?Action=EnableVpcClassicLink&Version=2016-11-15: - get: - x-aws-operation-name: EnableVpcClassicLink - operationId: GET_EnableVpcClassicLink - description: 'Enables a VPC for ClassicLink. You can then link EC2-Classic instances to your ClassicLink-enabled VPC to allow communication over private IP addresses. You cannot enable your VPC for ClassicLink if any of your VPC route tables have existing routes for address ranges within the 10.0.0.0/8 IP address range, excluding local routes for VPCs in the 10.0.0.0/16 and 10.1.0.0/16 IP address ranges. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/EnableVpcClassicLinkResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: VpcId - in: query - required: true - description: The ID of the VPC. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: EnableVpcClassicLink - operationId: POST_EnableVpcClassicLink - description: 'Enables a VPC for ClassicLink. You can then link EC2-Classic instances to your ClassicLink-enabled VPC to allow communication over private IP addresses. You cannot enable your VPC for ClassicLink if any of your VPC route tables have existing routes for address ranges within the 10.0.0.0/8 IP address range, excluding local routes for VPCs in the 10.0.0.0/16 and 10.1.0.0/16 IP address ranges. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/EnableVpcClassicLinkResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/EnableVpcClassicLinkRequest' - parameters: [] - /?Action=EnableVpcClassicLinkDnsSupport&Version=2016-11-15: - get: - x-aws-operation-name: EnableVpcClassicLinkDnsSupport - operationId: GET_EnableVpcClassicLinkDnsSupport - description: '

Enables a VPC to support DNS hostname resolution for ClassicLink. If enabled, the DNS hostname of a linked EC2-Classic instance resolves to its private IP address when addressed from an instance in the VPC to which it''s linked. Similarly, the DNS hostname of an instance in a VPC resolves to its private IP address when addressed from a linked EC2-Classic instance. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

You must specify a VPC ID in the request.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/EnableVpcClassicLinkDnsSupportResult' - parameters: - - name: VpcId - in: query - required: false - description: The ID of the VPC. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: EnableVpcClassicLinkDnsSupport - operationId: POST_EnableVpcClassicLinkDnsSupport - description: '

Enables a VPC to support DNS hostname resolution for ClassicLink. If enabled, the DNS hostname of a linked EC2-Classic instance resolves to its private IP address when addressed from an instance in the VPC to which it''s linked. Similarly, the DNS hostname of an instance in a VPC resolves to its private IP address when addressed from a linked EC2-Classic instance. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

You must specify a VPC ID in the request.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/EnableVpcClassicLinkDnsSupportResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/EnableVpcClassicLinkDnsSupportRequest' - parameters: [] - /?Action=ExportClientVpnClientCertificateRevocationList&Version=2016-11-15: - get: - x-aws-operation-name: ExportClientVpnClientCertificateRevocationList - operationId: GET_ExportClientVpnClientCertificateRevocationList - description: Downloads the client certificate revocation list for the specified Client VPN endpoint. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ExportClientVpnClientCertificateRevocationListResult' - parameters: - - name: ClientVpnEndpointId - in: query - required: true - description: The ID of the Client VPN endpoint. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ExportClientVpnClientCertificateRevocationList - operationId: POST_ExportClientVpnClientCertificateRevocationList - description: Downloads the client certificate revocation list for the specified Client VPN endpoint. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ExportClientVpnClientCertificateRevocationListResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ExportClientVpnClientCertificateRevocationListRequest' - parameters: [] - /?Action=ExportClientVpnClientConfiguration&Version=2016-11-15: - get: - x-aws-operation-name: ExportClientVpnClientConfiguration - operationId: GET_ExportClientVpnClientConfiguration - description: Downloads the contents of the Client VPN endpoint configuration file for the specified Client VPN endpoint. The Client VPN endpoint configuration file includes the Client VPN endpoint and certificate information clients need to establish a connection with the Client VPN endpoint. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ExportClientVpnClientConfigurationResult' - parameters: - - name: ClientVpnEndpointId - in: query - required: true - description: The ID of the Client VPN endpoint. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ExportClientVpnClientConfiguration - operationId: POST_ExportClientVpnClientConfiguration - description: Downloads the contents of the Client VPN endpoint configuration file for the specified Client VPN endpoint. The Client VPN endpoint configuration file includes the Client VPN endpoint and certificate information clients need to establish a connection with the Client VPN endpoint. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ExportClientVpnClientConfigurationResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ExportClientVpnClientConfigurationRequest' - parameters: [] - /?Action=ExportImage&Version=2016-11-15: - get: - x-aws-operation-name: ExportImage - operationId: GET_ExportImage - description: 'Exports an Amazon Machine Image (AMI) to a VM file. For more information, see Exporting a VM directly from an Amazon Machine Image (AMI) in the VM Import/Export User Guide.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ExportImageResult' - parameters: - - name: ClientToken - in: query - required: false - description: Token to enable idempotency for export image requests. - schema: - type: string - - name: Description - in: query - required: false - description: A description of the image being exported. The maximum length is 255 characters. - schema: - type: string - - name: DiskImageFormat - in: query - required: true - description: The disk image format. - schema: - type: string - enum: - - VMDK - - RAW - - VHD - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: ImageId - in: query - required: true - description: The ID of the image. - schema: - type: string - - name: S3ExportLocation - in: query - required: true - description: Information about the destination Amazon S3 bucket. The bucket must exist and grant WRITE and READ_ACP permissions to the Amazon Web Services account vm-import-export@amazon.com. - schema: - type: object - required: - - S3Bucket - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The prefix (logical hierarchy) in the bucket. - description: Describes the destination for an export image task. - - name: RoleName - in: query - required: false - description: 'The name of the role that grants VM Import/Export permission to export images to your Amazon S3 bucket. If this parameter is not specified, the default role is named ''vmimport''.' - schema: - type: string - - name: TagSpecification - in: query - required: false - description: The tags to apply to the export image task during creation. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ExportImage - operationId: POST_ExportImage - description: 'Exports an Amazon Machine Image (AMI) to a VM file. For more information, see Exporting a VM directly from an Amazon Machine Image (AMI) in the VM Import/Export User Guide.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ExportImageResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ExportImageRequest' - parameters: [] - /?Action=ExportTransitGatewayRoutes&Version=2016-11-15: - get: - x-aws-operation-name: ExportTransitGatewayRoutes - operationId: GET_ExportTransitGatewayRoutes - description: '

Exports routes from the specified transit gateway route table to the specified S3 bucket. By default, all routes are exported. Alternatively, you can filter by CIDR range.

The routes are saved to the specified bucket in a JSON file. For more information, see Export Route Tables to Amazon S3 in Transit Gateways.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ExportTransitGatewayRoutesResult' - parameters: - - name: TransitGatewayRouteTableId - in: query - required: true - description: The ID of the route table. - schema: - type: string - - name: Filter - in: query - required: false - description: '

One or more filters. The possible values are:

  • attachment.transit-gateway-attachment-id - The id of the transit gateway attachment.

  • attachment.resource-id - The resource id of the transit gateway attachment.

  • route-search.exact-match - The exact match of the specified filter.

  • route-search.longest-prefix-match - The longest prefix that matches the route.

  • route-search.subnet-of-match - The routes with a subnet that match the specified CIDR filter.

  • route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29.

  • state - The state of the route (active | blackhole).

  • transit-gateway-route-destination-cidr-block - The CIDR range.

  • type - The type of route (propagated | static).

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: S3Bucket - in: query - required: true - description: The name of the S3 bucket. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ExportTransitGatewayRoutes - operationId: POST_ExportTransitGatewayRoutes - description: '

Exports routes from the specified transit gateway route table to the specified S3 bucket. By default, all routes are exported. Alternatively, you can filter by CIDR range.

The routes are saved to the specified bucket in a JSON file. For more information, see Export Route Tables to Amazon S3 in Transit Gateways.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ExportTransitGatewayRoutesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ExportTransitGatewayRoutesRequest' - parameters: [] - /?Action=GetAssociatedEnclaveCertificateIamRoles&Version=2016-11-15: - get: - x-aws-operation-name: GetAssociatedEnclaveCertificateIamRoles - operationId: GET_GetAssociatedEnclaveCertificateIamRoles - description: 'Returns the IAM roles that are associated with the specified ACM (ACM) certificate. It also returns the name of the Amazon S3 bucket and the Amazon S3 object key where the certificate, certificate chain, and encrypted private key bundle are stored, and the ARN of the KMS key that''s used to encrypt the private key.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetAssociatedEnclaveCertificateIamRolesResult' - parameters: - - name: CertificateArn - in: query - required: false - description: 'The ARN of the ACM certificate for which to view the associated IAM roles, encryption keys, and Amazon S3 object information.' - schema: - type: string - minLength: 1 - maxLength: 1283 - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: GetAssociatedEnclaveCertificateIamRoles - operationId: POST_GetAssociatedEnclaveCertificateIamRoles - description: 'Returns the IAM roles that are associated with the specified ACM (ACM) certificate. It also returns the name of the Amazon S3 bucket and the Amazon S3 object key where the certificate, certificate chain, and encrypted private key bundle are stored, and the ARN of the KMS key that''s used to encrypt the private key.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetAssociatedEnclaveCertificateIamRolesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetAssociatedEnclaveCertificateIamRolesRequest' - parameters: [] - /?Action=GetAssociatedIpv6PoolCidrs&Version=2016-11-15: - get: - x-aws-operation-name: GetAssociatedIpv6PoolCidrs - operationId: GET_GetAssociatedIpv6PoolCidrs - description: Gets information about the IPv6 CIDR block associations for a specified IPv6 address pool. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetAssociatedIpv6PoolCidrsResult' - parameters: - - name: PoolId - in: query - required: true - description: The ID of the IPv6 address pool. - schema: - type: string - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - schema: - type: integer - minimum: 1 - maximum: 1000 - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: GetAssociatedIpv6PoolCidrs - operationId: POST_GetAssociatedIpv6PoolCidrs - description: Gets information about the IPv6 CIDR block associations for a specified IPv6 address pool. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetAssociatedIpv6PoolCidrsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetAssociatedIpv6PoolCidrsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=GetCapacityReservationUsage&Version=2016-11-15: - get: - x-aws-operation-name: GetCapacityReservationUsage - operationId: GET_GetCapacityReservationUsage - description: 'Gets usage information about a Capacity Reservation. If the Capacity Reservation is shared, it shows usage information for the Capacity Reservation owner and each Amazon Web Services account that is currently using the shared capacity. If the Capacity Reservation is not shared, it shows only the Capacity Reservation owner''s usage.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetCapacityReservationUsageResult' - parameters: - - name: CapacityReservationId - in: query - required: true - description: The ID of the Capacity Reservation. - schema: - type: string - - name: NextToken - in: query - required: false - description: The token to use to retrieve the next page of results. - schema: - type: string - - name: MaxResults - in: query - required: false - description: '

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.

Valid range: Minimum value of 1. Maximum value of 1000.

' - schema: - type: integer - minimum: 1 - maximum: 1000 - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: GetCapacityReservationUsage - operationId: POST_GetCapacityReservationUsage - description: 'Gets usage information about a Capacity Reservation. If the Capacity Reservation is shared, it shows usage information for the Capacity Reservation owner and each Amazon Web Services account that is currently using the shared capacity. If the Capacity Reservation is not shared, it shows only the Capacity Reservation owner''s usage.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetCapacityReservationUsageResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetCapacityReservationUsageRequest' - parameters: [] - /?Action=GetCoipPoolUsage&Version=2016-11-15: - get: - x-aws-operation-name: GetCoipPoolUsage - operationId: GET_GetCoipPoolUsage - description: Describes the allocations from the specified customer-owned address pool. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetCoipPoolUsageResult' - parameters: - - name: PoolId - in: query - required: true - description: The ID of the address pool. - schema: - type: string - - name: Filter - in: query - required: false - description:

One or more filters.

  • coip-address-usage.allocation-id - The allocation ID of the address.

  • coip-address-usage.aws-account-id - The ID of the Amazon Web Services account that is using the customer-owned IP address.

  • coip-address-usage.aws-service - The Amazon Web Services service that is using the customer-owned IP address.

  • coip-address-usage.co-ip - The customer-owned IP address.

- schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - schema: - type: integer - minimum: 5 - maximum: 1000 - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: GetCoipPoolUsage - operationId: POST_GetCoipPoolUsage - description: Describes the allocations from the specified customer-owned address pool. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetCoipPoolUsageResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetCoipPoolUsageRequest' - parameters: [] - /?Action=GetConsoleOutput&Version=2016-11-15: - get: - x-aws-operation-name: GetConsoleOutput - operationId: GET_GetConsoleOutput - description: '

Gets the console output for the specified instance. For Linux instances, the instance console output displays the exact console output that would normally be displayed on a physical monitor attached to a computer. For Windows instances, the instance console output includes the last three system event log errors.

By default, the console output returns buffered information that was posted shortly after an instance transition state (start, stop, reboot, or terminate). This information is available for at least one hour after the most recent post. Only the most recent 64 KB of console output is available.

You can optionally retrieve the latest serial console output at any time during the instance lifecycle. This option is supported on instance types that use the Nitro hypervisor.

For more information, see Instance console output in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetConsoleOutputResult' - parameters: - - name: InstanceId - in: query - required: true - description: The ID of the instance. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: Latest - in: query - required: false - description: '

When enabled, retrieves the latest console output for the instance.

Default: disabled (false)

' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: GetConsoleOutput - operationId: POST_GetConsoleOutput - description: '

Gets the console output for the specified instance. For Linux instances, the instance console output displays the exact console output that would normally be displayed on a physical monitor attached to a computer. For Windows instances, the instance console output includes the last three system event log errors.

By default, the console output returns buffered information that was posted shortly after an instance transition state (start, stop, reboot, or terminate). This information is available for at least one hour after the most recent post. Only the most recent 64 KB of console output is available.

You can optionally retrieve the latest serial console output at any time during the instance lifecycle. This option is supported on instance types that use the Nitro hypervisor.

For more information, see Instance console output in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetConsoleOutputResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetConsoleOutputRequest' - parameters: [] - /?Action=GetConsoleScreenshot&Version=2016-11-15: - get: - x-aws-operation-name: GetConsoleScreenshot - operationId: GET_GetConsoleScreenshot - description:

Retrieve a JPG-format screenshot of a running instance to help with troubleshooting.

The returned content is Base64-encoded.

- responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetConsoleScreenshotResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: InstanceId - in: query - required: true - description: The ID of the instance. - schema: - type: string - - name: WakeUp - in: query - required: false - description: 'When set to true, acts as keystroke input and wakes up an instance that''s in standby or "sleep" mode.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: GetConsoleScreenshot - operationId: POST_GetConsoleScreenshot - description:

Retrieve a JPG-format screenshot of a running instance to help with troubleshooting.

The returned content is Base64-encoded.

- responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetConsoleScreenshotResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetConsoleScreenshotRequest' - parameters: [] - /?Action=GetDefaultCreditSpecification&Version=2016-11-15: - get: - x-aws-operation-name: GetDefaultCreditSpecification - operationId: GET_GetDefaultCreditSpecification - description: '

Describes the default credit option for CPU usage of a burstable performance instance family.

For more information, see Burstable performance instances in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetDefaultCreditSpecificationResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: InstanceFamily - in: query - required: true - description: The instance family. - schema: - type: string - enum: - - t2 - - t3 - - t3a - - t4g - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: GetDefaultCreditSpecification - operationId: POST_GetDefaultCreditSpecification - description: '

Describes the default credit option for CPU usage of a burstable performance instance family.

For more information, see Burstable performance instances in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetDefaultCreditSpecificationResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetDefaultCreditSpecificationRequest' - parameters: [] - /?Action=GetEbsDefaultKmsKeyId&Version=2016-11-15: - get: - x-aws-operation-name: GetEbsDefaultKmsKeyId - operationId: GET_GetEbsDefaultKmsKeyId - description: '

Describes the default KMS key for EBS encryption by default for your account in this Region. You can change the default KMS key for encryption by default using ModifyEbsDefaultKmsKeyId or ResetEbsDefaultKmsKeyId.

For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetEbsDefaultKmsKeyIdResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: GetEbsDefaultKmsKeyId - operationId: POST_GetEbsDefaultKmsKeyId - description: '

Describes the default KMS key for EBS encryption by default for your account in this Region. You can change the default KMS key for encryption by default using ModifyEbsDefaultKmsKeyId or ResetEbsDefaultKmsKeyId.

For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetEbsDefaultKmsKeyIdResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetEbsDefaultKmsKeyIdRequest' - parameters: [] - /?Action=GetEbsEncryptionByDefault&Version=2016-11-15: - get: - x-aws-operation-name: GetEbsEncryptionByDefault - operationId: GET_GetEbsEncryptionByDefault - description: '

Describes whether EBS encryption by default is enabled for your account in the current Region.

For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetEbsEncryptionByDefaultResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: GetEbsEncryptionByDefault - operationId: POST_GetEbsEncryptionByDefault - description: '

Describes whether EBS encryption by default is enabled for your account in the current Region.

For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetEbsEncryptionByDefaultResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetEbsEncryptionByDefaultRequest' - parameters: [] - /?Action=GetFlowLogsIntegrationTemplate&Version=2016-11-15: - get: - x-aws-operation-name: GetFlowLogsIntegrationTemplate - operationId: GET_GetFlowLogsIntegrationTemplate - description: '

Generates a CloudFormation template that streamlines and automates the integration of VPC flow logs with Amazon Athena. This make it easier for you to query and gain insights from VPC flow logs data. Based on the information that you provide, we configure resources in the template to do the following:

  • Create a table in Athena that maps fields to a custom log format

  • Create a Lambda function that updates the table with new partitions on a daily, weekly, or monthly basis

  • Create a table partitioned between two timestamps in the past

  • Create a set of named queries in Athena that you can use to get started quickly

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetFlowLogsIntegrationTemplateResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: FlowLogId - in: query - required: true - description: The ID of the flow log. - schema: - type: string - - name: ConfigDeliveryS3DestinationArn - in: query - required: true - description: 'To store the CloudFormation template in Amazon S3, specify the location in Amazon S3.' - schema: - type: string - - name: IntegrateService - in: query - required: true - description: Information about the service integration. - schema: - type: object - properties: - AthenaIntegration: - allOf: - - $ref: '#/components/schemas/AthenaIntegrationsSet' - - description: Information about the integration with Amazon Athena. - description: Describes service integrations with VPC Flow logs. - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: GetFlowLogsIntegrationTemplate - operationId: POST_GetFlowLogsIntegrationTemplate - description: '

Generates a CloudFormation template that streamlines and automates the integration of VPC flow logs with Amazon Athena. This make it easier for you to query and gain insights from VPC flow logs data. Based on the information that you provide, we configure resources in the template to do the following:

  • Create a table in Athena that maps fields to a custom log format

  • Create a Lambda function that updates the table with new partitions on a daily, weekly, or monthly basis

  • Create a table partitioned between two timestamps in the past

  • Create a set of named queries in Athena that you can use to get started quickly

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetFlowLogsIntegrationTemplateResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetFlowLogsIntegrationTemplateRequest' - parameters: [] - /?Action=GetGroupsForCapacityReservation&Version=2016-11-15: - get: - x-aws-operation-name: GetGroupsForCapacityReservation - operationId: GET_GetGroupsForCapacityReservation - description: Lists the resource groups to which a Capacity Reservation has been added. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetGroupsForCapacityReservationResult' - parameters: - - name: CapacityReservationId - in: query - required: true - description: The ID of the Capacity Reservation. - schema: - type: string - - name: NextToken - in: query - required: false - description: The token to use to retrieve the next page of results. - schema: - type: string - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.' - schema: - type: integer - minimum: 1 - maximum: 1000 - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: GetGroupsForCapacityReservation - operationId: POST_GetGroupsForCapacityReservation - description: Lists the resource groups to which a Capacity Reservation has been added. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetGroupsForCapacityReservationResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetGroupsForCapacityReservationRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=GetHostReservationPurchasePreview&Version=2016-11-15: - get: - x-aws-operation-name: GetHostReservationPurchasePreview - operationId: GET_GetHostReservationPurchasePreview - description:

Preview a reservation purchase with configurations that match those of your Dedicated Host. You must have active Dedicated Hosts in your account before you purchase a reservation.

This is a preview of the PurchaseHostReservation action and does not result in the offering being purchased.

- responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetHostReservationPurchasePreviewResult' - parameters: - - name: HostIdSet - in: query - required: true - description: The IDs of the Dedicated Hosts with which the reservation is associated. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/DedicatedHostId' - - xml: - name: item - - name: OfferingId - in: query - required: true - description: The offering ID of the reservation. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: GetHostReservationPurchasePreview - operationId: POST_GetHostReservationPurchasePreview - description:

Preview a reservation purchase with configurations that match those of your Dedicated Host. You must have active Dedicated Hosts in your account before you purchase a reservation.

This is a preview of the PurchaseHostReservation action and does not result in the offering being purchased.

- responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetHostReservationPurchasePreviewResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetHostReservationPurchasePreviewRequest' - parameters: [] - /?Action=GetInstanceTypesFromInstanceRequirements&Version=2016-11-15: - get: - x-aws-operation-name: GetInstanceTypesFromInstanceRequirements - operationId: GET_GetInstanceTypesFromInstanceRequirements - description: '

Returns a list of instance types with the specified instance attributes. You can use the response to preview the instance types without launching instances. Note that the response does not consider capacity.

When you specify multiple parameters, you get instance types that satisfy all of the specified parameters. If you specify multiple values for a parameter, you get instance types that satisfy any of the specified values.

For more information, see Preview instance types with specified attributes, Attribute-based instance type selection for EC2 Fleet, Attribute-based instance type selection for Spot Fleet, and Spot placement score in the Amazon EC2 User Guide, and Creating an Auto Scaling group using attribute-based instance type selection in the Amazon EC2 Auto Scaling User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetInstanceTypesFromInstanceRequirementsResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: ArchitectureType - in: query - required: true - description: The processor architecture type. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/ArchitectureType' - - xml: - name: item - minItems: 0 - maxItems: 3 - - name: VirtualizationType - in: query - required: true - description: The virtualization type. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/VirtualizationType' - - xml: - name: item - minItems: 0 - maxItems: 2 - - name: InstanceRequirements - in: query - required: true - description: The attributes required for the instance types. - schema: - type: object - required: - - VCpuCount - - MemoryMiB - properties: - undefined: - allOf: - - $ref: '#/components/schemas/MemoryMiBRequest' - - description: 'The minimum and maximum amount of memory, in MiB.' - CpuManufacturer: - allOf: - - $ref: '#/components/schemas/MemoryGiBPerVCpuRequest' - - description: '

The minimum and maximum amount of memory per vCPU, in GiB.

Default: No minimum or maximum limits

' - ExcludedInstanceType: - allOf: - - $ref: '#/components/schemas/ExcludedInstanceTypeSet' - - description: '

The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk (*), to exclude an instance family, type, size, or generation. The following are examples: m5.8xlarge, c5*.*, m5a.*, r*, *3*.

For example, if you specify c5*,Amazon EC2 will exclude the entire C5 instance family, which includes all C5a and C5n instance types. If you specify m5a.*, Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types.

Default: No excluded instance types

' - InstanceGeneration: - allOf: - - $ref: '#/components/schemas/LocalStorage' - - description: '

Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, Amazon EC2 instance store in the Amazon EC2 User Guide.

  • To include instance types with instance store volumes, specify included.

  • To require only instance types with instance store volumes, specify required.

  • To exclude instance types with instance store volumes, specify excluded.

Default: included

' - LocalStorageType: - allOf: - - $ref: '#/components/schemas/BaselineEbsBandwidthMbpsRequest' - - description: '

The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see Amazon EBS–optimized instances in the Amazon EC2 User Guide.

Default: No minimum or maximum limits

' - AcceleratorType: - allOf: - - $ref: '#/components/schemas/AcceleratorCountRequest' - - description: '

The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on an instance.

To exclude accelerator-enabled instance types, set Max to 0.

Default: No minimum or maximum limits

' - AcceleratorManufacturer: - allOf: - - $ref: '#/components/schemas/AcceleratorManufacturerSet' - - description: '

Indicates whether instance types must have accelerators by specific manufacturers.

  • For instance types with NVIDIA devices, specify nvidia.

  • For instance types with AMD devices, specify amd.

  • For instance types with Amazon Web Services devices, specify amazon-web-services.

  • For instance types with Xilinx devices, specify xilinx.

Default: Any manufacturer

' - AcceleratorName: - allOf: - - $ref: '#/components/schemas/AcceleratorTotalMemoryMiBRequest' - - description: '

The minimum and maximum amount of total accelerator memory, in MiB.

Default: No minimum or maximum limits

' - description: '

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.

When you specify multiple parameters, you get instance types that satisfy all of the specified parameters. If you specify multiple values for a parameter, you get instance types that satisfy any of the specified values.

You must specify VCpuCount and MemoryMiB. All other parameters are optional. Any unspecified optional parameter is set to its default.

For more information, see Attribute-based instance type selection for EC2 Fleet, Attribute-based instance type selection for Spot Fleet, and Spot placement score in the Amazon EC2 User Guide.

' - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return in a single call. Specify a value between 1 and
 1000. The default value is 1000. To retrieve the remaining results, make another call with
 the returned NextToken value.' - schema: - type: integer - - name: NextToken - in: query - required: false - description: The token for the next set of results. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: GetInstanceTypesFromInstanceRequirements - operationId: POST_GetInstanceTypesFromInstanceRequirements - description: '

Returns a list of instance types with the specified instance attributes. You can use the response to preview the instance types without launching instances. Note that the response does not consider capacity.

When you specify multiple parameters, you get instance types that satisfy all of the specified parameters. If you specify multiple values for a parameter, you get instance types that satisfy any of the specified values.

For more information, see Preview instance types with specified attributes, Attribute-based instance type selection for EC2 Fleet, Attribute-based instance type selection for Spot Fleet, and Spot placement score in the Amazon EC2 User Guide, and Creating an Auto Scaling group using attribute-based instance type selection in the Amazon EC2 Auto Scaling User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetInstanceTypesFromInstanceRequirementsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetInstanceTypesFromInstanceRequirementsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=GetInstanceUefiData&Version=2016-11-15: - get: - x-aws-operation-name: GetInstanceUefiData - operationId: GET_GetInstanceUefiData - description: '

A binary representation of the UEFI variable store. Only non-volatile variables are stored. This is a base64 encoded and zlib compressed binary value that must be properly encoded.

When you use register-image to create an AMI, you can create an exact copy of your variable store by passing the UEFI data in the UefiData parameter. You can modify the UEFI data by using the python-uefivars tool on GitHub. You can use the tool to convert the UEFI data into a human-readable format (JSON), which you can inspect and modify, and then convert back into the binary format to use with register-image.

For more information, see UEFI Secure Boot in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetInstanceUefiDataResult' - parameters: - - name: InstanceId - in: query - required: true - description: The ID of the instance from which to retrieve the UEFI data. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: GetInstanceUefiData - operationId: POST_GetInstanceUefiData - description: '

A binary representation of the UEFI variable store. Only non-volatile variables are stored. This is a base64 encoded and zlib compressed binary value that must be properly encoded.

When you use register-image to create an AMI, you can create an exact copy of your variable store by passing the UEFI data in the UefiData parameter. You can modify the UEFI data by using the python-uefivars tool on GitHub. You can use the tool to convert the UEFI data into a human-readable format (JSON), which you can inspect and modify, and then convert back into the binary format to use with register-image.

For more information, see UEFI Secure Boot in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetInstanceUefiDataResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetInstanceUefiDataRequest' - parameters: [] - /?Action=GetIpamAddressHistory&Version=2016-11-15: - get: - x-aws-operation-name: GetIpamAddressHistory - operationId: GET_GetIpamAddressHistory - description: 'Retrieve historical information about a CIDR within an IPAM scope. For more information, see View the history of IP addresses in the Amazon VPC IPAM User Guide.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetIpamAddressHistoryResult' - parameters: - - name: DryRun - in: query - required: false - description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: Cidr - in: query - required: true - description: 'The CIDR you want the history of. The CIDR can be an IPv4 or IPv6 IP address range. If you enter a /16 IPv4 CIDR, you will get records that match it exactly. You will not get records for any subnets within the /16 CIDR.' - schema: - type: string - - name: IpamScopeId - in: query - required: true - description: The ID of the IPAM scope that the CIDR is in. - schema: - type: string - - name: VpcId - in: query - required: false - description: The ID of the VPC you want your history records filtered by. - schema: - type: string - - name: StartTime - in: query - required: false - description: 'The start of the time period for which you are looking for history. If you omit this option, it will default to the value of EndTime.' - schema: - type: string - format: date-time - - name: EndTime - in: query - required: false - description: 'The end of the time period for which you are looking for history. If you omit this option, it will default to the current time.' - schema: - type: string - format: date-time - - name: MaxResults - in: query - required: false - description: The maximum number of historical results you would like returned per page. Defaults to 100. - schema: - type: integer - minimum: 1 - maximum: 1000 - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: GetIpamAddressHistory - operationId: POST_GetIpamAddressHistory - description: 'Retrieve historical information about a CIDR within an IPAM scope. For more information, see View the history of IP addresses in the Amazon VPC IPAM User Guide.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetIpamAddressHistoryResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetIpamAddressHistoryRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=GetIpamPoolAllocations&Version=2016-11-15: - get: - x-aws-operation-name: GetIpamPoolAllocations - operationId: GET_GetIpamPoolAllocations - description: Get a list of all the CIDR allocations in an IPAM pool. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetIpamPoolAllocationsResult' - parameters: - - name: DryRun - in: query - required: false - description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: IpamPoolId - in: query - required: true - description: The ID of the IPAM pool you want to see the allocations for. - schema: - type: string - - name: IpamPoolAllocationId - in: query - required: false - description: The ID of the allocation. - schema: - type: string - - name: Filter - in: query - required: false - description: 'One or more filters for the request. For more information about filtering, see Filtering CLI output.' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: MaxResults - in: query - required: false - description: The maximum number of results you would like returned per page. - schema: - type: integer - minimum: 1000 - maximum: 100000 - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: GetIpamPoolAllocations - operationId: POST_GetIpamPoolAllocations - description: Get a list of all the CIDR allocations in an IPAM pool. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetIpamPoolAllocationsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetIpamPoolAllocationsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=GetIpamPoolCidrs&Version=2016-11-15: - get: - x-aws-operation-name: GetIpamPoolCidrs - operationId: GET_GetIpamPoolCidrs - description: Get the CIDRs provisioned to an IPAM pool. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetIpamPoolCidrsResult' - parameters: - - name: DryRun - in: query - required: false - description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: IpamPoolId - in: query - required: true - description: The ID of the IPAM pool you want the CIDR for. - schema: - type: string - - name: Filter - in: query - required: false - description: 'One or more filters for the request. For more information about filtering, see Filtering CLI output.' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: MaxResults - in: query - required: false - description: The maximum number of results to return in the request. - schema: - type: integer - minimum: 5 - maximum: 1000 - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: GetIpamPoolCidrs - operationId: POST_GetIpamPoolCidrs - description: Get the CIDRs provisioned to an IPAM pool. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetIpamPoolCidrsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetIpamPoolCidrsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=GetIpamResourceCidrs&Version=2016-11-15: - get: - x-aws-operation-name: GetIpamResourceCidrs - operationId: GET_GetIpamResourceCidrs - description: Get information about the resources in a scope. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetIpamResourceCidrsResult' - parameters: - - name: DryRun - in: query - required: false - description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: Filter - in: query - required: false - description: 'One or more filters for the request. For more information about filtering, see Filtering CLI output.' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: MaxResults - in: query - required: false - description: The maximum number of results to return in the request. - schema: - type: integer - minimum: 5 - maximum: 1000 - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - - name: IpamScopeId - in: query - required: true - description: The ID of the scope that the resource is in. - schema: - type: string - - name: IpamPoolId - in: query - required: false - description: The ID of the IPAM pool that the resource is in. - schema: - type: string - - name: ResourceId - in: query - required: false - description: The ID of the resource. - schema: - type: string - - name: ResourceType - in: query - required: false - description: The resource type. - schema: - type: string - enum: - - vpc - - subnet - - eip - - public-ipv4-pool - - ipv6-pool - - name: ResourceTag - in: query - required: false - description: '' - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The value for the tag. - description: A tag on an IPAM resource. - - name: ResourceOwner - in: query - required: false - description: The ID of the Amazon Web Services account that owns the resource. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: GetIpamResourceCidrs - operationId: POST_GetIpamResourceCidrs - description: Get information about the resources in a scope. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetIpamResourceCidrsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetIpamResourceCidrsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=GetLaunchTemplateData&Version=2016-11-15: - get: - x-aws-operation-name: GetLaunchTemplateData - operationId: GET_GetLaunchTemplateData - description: '

Retrieves the configuration data of the specified instance. You can use this data to create a launch template.

This action calls on other describe actions to get instance information. Depending on your instance configuration, you may need to allow the following actions in your IAM policy: DescribeSpotInstanceRequests, DescribeInstanceCreditSpecifications, DescribeVolumes, DescribeInstanceAttribute, and DescribeElasticGpus. Or, you can allow describe* depending on your instance requirements.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetLaunchTemplateDataResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: InstanceId - in: query - required: true - description: The ID of the instance. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: GetLaunchTemplateData - operationId: POST_GetLaunchTemplateData - description: '

Retrieves the configuration data of the specified instance. You can use this data to create a launch template.

This action calls on other describe actions to get instance information. Depending on your instance configuration, you may need to allow the following actions in your IAM policy: DescribeSpotInstanceRequests, DescribeInstanceCreditSpecifications, DescribeVolumes, DescribeInstanceAttribute, and DescribeElasticGpus. Or, you can allow describe* depending on your instance requirements.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetLaunchTemplateDataResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetLaunchTemplateDataRequest' - parameters: [] - /?Action=GetManagedPrefixListAssociations&Version=2016-11-15: - get: - x-aws-operation-name: GetManagedPrefixListAssociations - operationId: GET_GetManagedPrefixListAssociations - description: Gets information about the resources that are associated with the specified managed prefix list. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetManagedPrefixListAssociationsResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: PrefixListId - in: query - required: true - description: The ID of the prefix list. - schema: - type: string - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - schema: - type: integer - minimum: 5 - maximum: 255 - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: GetManagedPrefixListAssociations - operationId: POST_GetManagedPrefixListAssociations - description: Gets information about the resources that are associated with the specified managed prefix list. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetManagedPrefixListAssociationsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetManagedPrefixListAssociationsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=GetManagedPrefixListEntries&Version=2016-11-15: - get: - x-aws-operation-name: GetManagedPrefixListEntries - operationId: GET_GetManagedPrefixListEntries - description: Gets information about the entries for a specified managed prefix list. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetManagedPrefixListEntriesResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: PrefixListId - in: query - required: true - description: The ID of the prefix list. - schema: - type: string - - name: TargetVersion - in: query - required: false - description: The version of the prefix list for which to return the entries. The default is the current version. - schema: - type: integer - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - schema: - type: integer - minimum: 1 - maximum: 100 - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: GetManagedPrefixListEntries - operationId: POST_GetManagedPrefixListEntries - description: Gets information about the entries for a specified managed prefix list. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetManagedPrefixListEntriesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetManagedPrefixListEntriesRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=GetNetworkInsightsAccessScopeAnalysisFindings&Version=2016-11-15: - get: - x-aws-operation-name: GetNetworkInsightsAccessScopeAnalysisFindings - operationId: GET_GetNetworkInsightsAccessScopeAnalysisFindings - description: Gets the findings for the specified Network Access Scope analysis. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetNetworkInsightsAccessScopeAnalysisFindingsResult' - parameters: - - name: NetworkInsightsAccessScopeAnalysisId - in: query - required: true - description: The ID of the Network Access Scope analysis. - schema: - type: string - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - schema: - type: integer - minimum: 1 - maximum: 100 - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: GetNetworkInsightsAccessScopeAnalysisFindings - operationId: POST_GetNetworkInsightsAccessScopeAnalysisFindings - description: Gets the findings for the specified Network Access Scope analysis. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetNetworkInsightsAccessScopeAnalysisFindingsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetNetworkInsightsAccessScopeAnalysisFindingsRequest' - parameters: [] - /?Action=GetNetworkInsightsAccessScopeContent&Version=2016-11-15: - get: - x-aws-operation-name: GetNetworkInsightsAccessScopeContent - operationId: GET_GetNetworkInsightsAccessScopeContent - description: Gets the content for the specified Network Access Scope. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetNetworkInsightsAccessScopeContentResult' - parameters: - - name: NetworkInsightsAccessScopeId - in: query - required: true - description: The ID of the Network Access Scope. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: GetNetworkInsightsAccessScopeContent - operationId: POST_GetNetworkInsightsAccessScopeContent - description: Gets the content for the specified Network Access Scope. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetNetworkInsightsAccessScopeContentResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetNetworkInsightsAccessScopeContentRequest' - parameters: [] - /?Action=GetPasswordData&Version=2016-11-15: - get: - x-aws-operation-name: GetPasswordData - operationId: GET_GetPasswordData - description: '

Retrieves the encrypted administrator password for a running Windows instance.

The Windows password is generated at boot by the EC2Config service or EC2Launch scripts (Windows Server 2016 and later). This usually only happens the first time an instance is launched. For more information, see EC2Config and EC2Launch in the Amazon EC2 User Guide.

For the EC2Config service, the password is not generated for rebundled AMIs unless Ec2SetPassword is enabled before bundling.

The password is encrypted using the key pair that you specified when you launched the instance. You must provide the corresponding key pair file.

When you launch an instance, password generation and encryption may take a few minutes. If you try to retrieve the password before it''s available, the output returns an empty string. We recommend that you wait up to 15 minutes after launching an instance before trying to retrieve the generated password.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetPasswordDataResult' - parameters: - - name: InstanceId - in: query - required: true - description: The ID of the Windows instance. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: GetPasswordData - operationId: POST_GetPasswordData - description: '

Retrieves the encrypted administrator password for a running Windows instance.

The Windows password is generated at boot by the EC2Config service or EC2Launch scripts (Windows Server 2016 and later). This usually only happens the first time an instance is launched. For more information, see EC2Config and EC2Launch in the Amazon EC2 User Guide.

For the EC2Config service, the password is not generated for rebundled AMIs unless Ec2SetPassword is enabled before bundling.

The password is encrypted using the key pair that you specified when you launched the instance. You must provide the corresponding key pair file.

When you launch an instance, password generation and encryption may take a few minutes. If you try to retrieve the password before it''s available, the output returns an empty string. We recommend that you wait up to 15 minutes after launching an instance before trying to retrieve the generated password.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetPasswordDataResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetPasswordDataRequest' - parameters: [] - /?Action=GetReservedInstancesExchangeQuote&Version=2016-11-15: - get: - x-aws-operation-name: GetReservedInstancesExchangeQuote - operationId: GET_GetReservedInstancesExchangeQuote - description: 'Returns a quote and exchange information for exchanging one or more specified Convertible Reserved Instances for a new Convertible Reserved Instance. If the exchange cannot be performed, the reason is returned in the response. Use AcceptReservedInstancesExchangeQuote to perform the exchange.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetReservedInstancesExchangeQuoteResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: ReservedInstanceId - in: query - required: true - description: The IDs of the Convertible Reserved Instances to exchange. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/ReservationId' - - xml: - name: ReservedInstanceId - - name: TargetConfiguration - in: query - required: false - description: The configuration of the target Convertible Reserved Instance to exchange for your current Convertible Reserved Instances. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TargetConfigurationRequest' - - xml: - name: TargetConfigurationRequest - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: GetReservedInstancesExchangeQuote - operationId: POST_GetReservedInstancesExchangeQuote - description: 'Returns a quote and exchange information for exchanging one or more specified Convertible Reserved Instances for a new Convertible Reserved Instance. If the exchange cannot be performed, the reason is returned in the response. Use AcceptReservedInstancesExchangeQuote to perform the exchange.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetReservedInstancesExchangeQuoteResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetReservedInstancesExchangeQuoteRequest' - parameters: [] - /?Action=GetSerialConsoleAccessStatus&Version=2016-11-15: - get: - x-aws-operation-name: GetSerialConsoleAccessStatus - operationId: GET_GetSerialConsoleAccessStatus - description: 'Retrieves the access status of your account to the EC2 serial console of all instances. By default, access to the EC2 serial console is disabled for your account. For more information, see Manage account access to the EC2 serial console in the Amazon EC2 User Guide.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetSerialConsoleAccessStatusResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: GetSerialConsoleAccessStatus - operationId: POST_GetSerialConsoleAccessStatus - description: 'Retrieves the access status of your account to the EC2 serial console of all instances. By default, access to the EC2 serial console is disabled for your account. For more information, see Manage account access to the EC2 serial console in the Amazon EC2 User Guide.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetSerialConsoleAccessStatusResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetSerialConsoleAccessStatusRequest' - parameters: [] - /?Action=GetSpotPlacementScores&Version=2016-11-15: - get: - x-aws-operation-name: GetSpotPlacementScores - operationId: GET_GetSpotPlacementScores - description: '

Calculates the Spot placement score for a Region or Availability Zone based on the specified target capacity and compute requirements.

You can specify your compute requirements either by using InstanceRequirementsWithMetadata and letting Amazon EC2 choose the optimal instance types to fulfill your Spot request, or you can specify the instance types by using InstanceTypes.

For more information, see Spot placement score in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetSpotPlacementScoresResult' - parameters: - - name: InstanceType - in: query - required: false - description: '

The instance types. We recommend that you specify at least three instance types. If you specify one or two instance types, or specify variations of a single instance type (for example, an m3.xlarge with and without instance storage), the returned placement score will always be low.

If you specify InstanceTypes, you can''t specify InstanceRequirementsWithMetadata.

' - schema: - type: array - items: - $ref: '#/components/schemas/String' - minItems: 0 - maxItems: 1000 - - name: TargetCapacity - in: query - required: true - description: The target capacity. - schema: - type: integer - minimum: 1 - maximum: 2000000000 - - name: TargetCapacityUnitType - in: query - required: false - description: '

The unit for the target capacity.

Default: units (translates to number of instances)

' - schema: - type: string - enum: - - vcpu - - memory-mib - - units - - name: SingleAvailabilityZone - in: query - required: false - description: '

Specify true so that the response returns a list of scored Availability Zones. Otherwise, the response returns a list of scored Regions.

A list of scored Availability Zones is useful if you want to launch all of your Spot capacity into a single Availability Zone.

' - schema: - type: boolean - - name: RegionName - in: query - required: false - description: 'The Regions used to narrow down the list of Regions to be scored. Enter the Region code, for example, us-east-1.' - schema: - type: array - items: - $ref: '#/components/schemas/String' - minItems: 0 - maxItems: 10 - - name: InstanceRequirementsWithMetadata - in: query - required: false - description: '

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.

If you specify InstanceRequirementsWithMetadata, you can''t specify InstanceTypes.

' - schema: - type: object - properties: - ArchitectureType: - allOf: - - $ref: '#/components/schemas/ArchitectureTypeSet' - - description: The architecture type. - VirtualizationType: - allOf: - - $ref: '#/components/schemas/InstanceRequirementsRequest' - - description: 'The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.' - description: '

The architecture type, virtualization type, and other attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.

If you specify InstanceRequirementsWithMetadataRequest, you can''t specify InstanceTypes.

' - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return in a single call. Specify a value between 1 and
 1000. The default value is 1000. To retrieve the remaining results, make another call with
 the returned NextToken value.' - schema: - type: integer - minimum: 10 - maximum: 1000 - - name: NextToken - in: query - required: false - description: The token for the next set of results. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: GetSpotPlacementScores - operationId: POST_GetSpotPlacementScores - description: '

Calculates the Spot placement score for a Region or Availability Zone based on the specified target capacity and compute requirements.

You can specify your compute requirements either by using InstanceRequirementsWithMetadata and letting Amazon EC2 choose the optimal instance types to fulfill your Spot request, or you can specify the instance types by using InstanceTypes.

For more information, see Spot placement score in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetSpotPlacementScoresResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetSpotPlacementScoresRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=GetSubnetCidrReservations&Version=2016-11-15: - get: - x-aws-operation-name: GetSubnetCidrReservations - operationId: GET_GetSubnetCidrReservations - description: Gets information about the subnet CIDR reservations. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetSubnetCidrReservationsResult' - parameters: - - name: Filter - in: query - required: false - description: '

One or more filters.

  • reservationType - The type of reservation (prefix | explicit).

  • subnet-id - The ID of the subnet.

  • tag:<key> - 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. 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.

  • 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.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: SubnetId - in: query - required: true - description: The ID of the subnet. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - schema: - type: integer - minimum: 5 - maximum: 1000 - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: GetSubnetCidrReservations - operationId: POST_GetSubnetCidrReservations - description: Gets information about the subnet CIDR reservations. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetSubnetCidrReservationsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetSubnetCidrReservationsRequest' - parameters: [] - /?Action=GetTransitGatewayAttachmentPropagations&Version=2016-11-15: - get: - x-aws-operation-name: GetTransitGatewayAttachmentPropagations - operationId: GET_GetTransitGatewayAttachmentPropagations - description: Lists the route tables to which the specified resource attachment propagates routes. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetTransitGatewayAttachmentPropagationsResult' - parameters: - - name: TransitGatewayAttachmentId - in: query - required: true - description: The ID of the attachment. - schema: - type: string - - name: Filter - in: query - required: false - description: '

One or more filters. The possible values are:

  • transit-gateway-route-table-id - The ID of the transit gateway route table.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - schema: - type: integer - minimum: 5 - maximum: 1000 - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: GetTransitGatewayAttachmentPropagations - operationId: POST_GetTransitGatewayAttachmentPropagations - description: Lists the route tables to which the specified resource attachment propagates routes. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetTransitGatewayAttachmentPropagationsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetTransitGatewayAttachmentPropagationsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=GetTransitGatewayMulticastDomainAssociations&Version=2016-11-15: - get: - x-aws-operation-name: GetTransitGatewayMulticastDomainAssociations - operationId: GET_GetTransitGatewayMulticastDomainAssociations - description: Gets information about the associations for the transit gateway multicast domain. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetTransitGatewayMulticastDomainAssociationsResult' - parameters: - - name: TransitGatewayMulticastDomainId - in: query - required: false - description: The ID of the transit gateway multicast domain. - schema: - type: string - - name: Filter - in: query - required: false - description: '

One or more filters. The possible values are:

  • resource-id - The ID of the resource.

  • resource-type - The type of resource. The valid value is: vpc.

  • state - The state of the subnet association. Valid values are associated | associating | disassociated | disassociating.

  • subnet-id - The ID of the subnet.

  • transit-gateway-attachment-id - The id of the transit gateway attachment.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - schema: - type: integer - minimum: 5 - maximum: 1000 - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: GetTransitGatewayMulticastDomainAssociations - operationId: POST_GetTransitGatewayMulticastDomainAssociations - description: Gets information about the associations for the transit gateway multicast domain. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetTransitGatewayMulticastDomainAssociationsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetTransitGatewayMulticastDomainAssociationsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=GetTransitGatewayPrefixListReferences&Version=2016-11-15: - get: - x-aws-operation-name: GetTransitGatewayPrefixListReferences - operationId: GET_GetTransitGatewayPrefixListReferences - description: Gets information about the prefix list references in a specified transit gateway route table. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetTransitGatewayPrefixListReferencesResult' - parameters: - - name: TransitGatewayRouteTableId - in: query - required: true - description: The ID of the transit gateway route table. - schema: - type: string - - name: Filter - in: query - required: false - description: '

One or more filters. The possible values are:

  • attachment.resource-id - The ID of the resource for the attachment.

  • attachment.resource-type - The type of resource for the attachment. Valid values are vpc | vpn | direct-connect-gateway | peering.

  • attachment.transit-gateway-attachment-id - The ID of the attachment.

  • is-blackhole - Whether traffic matching the route is blocked (true | false).

  • prefix-list-id - The ID of the prefix list.

  • prefix-list-owner-id - The ID of the owner of the prefix list.

  • state - The state of the prefix list reference (pending | available | modifying | deleting).

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - schema: - type: integer - minimum: 5 - maximum: 1000 - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: GetTransitGatewayPrefixListReferences - operationId: POST_GetTransitGatewayPrefixListReferences - description: Gets information about the prefix list references in a specified transit gateway route table. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetTransitGatewayPrefixListReferencesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetTransitGatewayPrefixListReferencesRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=GetTransitGatewayRouteTableAssociations&Version=2016-11-15: - get: - x-aws-operation-name: GetTransitGatewayRouteTableAssociations - operationId: GET_GetTransitGatewayRouteTableAssociations - description: Gets information about the associations for the specified transit gateway route table. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetTransitGatewayRouteTableAssociationsResult' - parameters: - - name: TransitGatewayRouteTableId - in: query - required: true - description: The ID of the transit gateway route table. - schema: - type: string - - name: Filter - in: query - required: false - description: '

One or more filters. The possible values are:

  • resource-id - The ID of the resource.

  • resource-type - The resource type. Valid values are vpc | vpn | direct-connect-gateway | peering | connect.

  • transit-gateway-attachment-id - The ID of the attachment.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - schema: - type: integer - minimum: 5 - maximum: 1000 - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: GetTransitGatewayRouteTableAssociations - operationId: POST_GetTransitGatewayRouteTableAssociations - description: Gets information about the associations for the specified transit gateway route table. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetTransitGatewayRouteTableAssociationsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetTransitGatewayRouteTableAssociationsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=GetTransitGatewayRouteTablePropagations&Version=2016-11-15: - get: - x-aws-operation-name: GetTransitGatewayRouteTablePropagations - operationId: GET_GetTransitGatewayRouteTablePropagations - description: Gets information about the route table propagations for the specified transit gateway route table. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetTransitGatewayRouteTablePropagationsResult' - parameters: - - name: TransitGatewayRouteTableId - in: query - required: true - description: The ID of the transit gateway route table. - schema: - type: string - - name: Filter - in: query - required: false - description: '

One or more filters. The possible values are:

  • resource-id - The ID of the resource.

  • resource-type - The resource type. Valid values are vpc | vpn | direct-connect-gateway | peering | connect.

  • transit-gateway-attachment-id - The ID of the attachment.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - schema: - type: integer - minimum: 5 - maximum: 1000 - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: GetTransitGatewayRouteTablePropagations - operationId: POST_GetTransitGatewayRouteTablePropagations - description: Gets information about the route table propagations for the specified transit gateway route table. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetTransitGatewayRouteTablePropagationsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetTransitGatewayRouteTablePropagationsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=GetVpnConnectionDeviceSampleConfiguration&Version=2016-11-15: - get: - x-aws-operation-name: GetVpnConnectionDeviceSampleConfiguration - operationId: GET_GetVpnConnectionDeviceSampleConfiguration - description: Download an Amazon Web Services-provided sample configuration file to be used with the customer gateway device specified for your Site-to-Site VPN connection. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetVpnConnectionDeviceSampleConfigurationResult' - parameters: - - name: VpnConnectionId - in: query - required: true - description: The VpnConnectionId specifies the Site-to-Site VPN connection used for the sample configuration. - schema: - type: string - - name: VpnConnectionDeviceTypeId - in: query - required: true - description: Device identifier provided by the GetVpnConnectionDeviceTypes API. - schema: - type: string - - name: InternetKeyExchangeVersion - in: query - required: false - description: 'The IKE version to be used in the sample configuration file for your customer gateway device. You can specify one of the following versions: ikev1 or ikev2.' - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: GetVpnConnectionDeviceSampleConfiguration - operationId: POST_GetVpnConnectionDeviceSampleConfiguration - description: Download an Amazon Web Services-provided sample configuration file to be used with the customer gateway device specified for your Site-to-Site VPN connection. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetVpnConnectionDeviceSampleConfigurationResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetVpnConnectionDeviceSampleConfigurationRequest' - parameters: [] - /?Action=GetVpnConnectionDeviceTypes&Version=2016-11-15: - get: - x-aws-operation-name: GetVpnConnectionDeviceTypes - operationId: GET_GetVpnConnectionDeviceTypes - description: 'Obtain a list of customer gateway devices for which sample configuration files can be provided. The request has no additional parameters. You can also see the list of device types with sample configuration files available under Your customer gateway device in the Amazon Web Services Site-to-Site VPN User Guide.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetVpnConnectionDeviceTypesResult' - parameters: - - name: MaxResults - in: query - required: false - description: 'The maximum number of results returned by GetVpnConnectionDeviceTypes in paginated output. When this parameter is used, GetVpnConnectionDeviceTypes only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another GetVpnConnectionDeviceTypes request with the returned NextToken value. This value can be between 200 and 1000. If this parameter is not used, then GetVpnConnectionDeviceTypes returns all results.' - schema: - type: integer - minimum: 200 - maximum: 1000 - - name: NextToken - in: query - required: false - description: 'The NextToken value returned from a previous paginated GetVpnConnectionDeviceTypes request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return. ' - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: GetVpnConnectionDeviceTypes - operationId: POST_GetVpnConnectionDeviceTypes - description: 'Obtain a list of customer gateway devices for which sample configuration files can be provided. The request has no additional parameters. You can also see the list of device types with sample configuration files available under Your customer gateway device in the Amazon Web Services Site-to-Site VPN User Guide.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/GetVpnConnectionDeviceTypesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/GetVpnConnectionDeviceTypesRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=ImportClientVpnClientCertificateRevocationList&Version=2016-11-15: - get: - x-aws-operation-name: ImportClientVpnClientCertificateRevocationList - operationId: GET_ImportClientVpnClientCertificateRevocationList - description:

Uploads a client certificate revocation list to the specified Client VPN endpoint. Uploading a client certificate revocation list overwrites the existing client certificate revocation list.

Uploading a client certificate revocation list resets existing client connections.

- responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ImportClientVpnClientCertificateRevocationListResult' - parameters: - - name: ClientVpnEndpointId - in: query - required: true - description: The ID of the Client VPN endpoint to which the client certificate revocation list applies. - schema: - type: string - - name: CertificateRevocationList - in: query - required: true - description: 'The client certificate revocation list file. For more information, see Generate a Client Certificate Revocation List in the Client VPN Administrator Guide.' - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ImportClientVpnClientCertificateRevocationList - operationId: POST_ImportClientVpnClientCertificateRevocationList - description:

Uploads a client certificate revocation list to the specified Client VPN endpoint. Uploading a client certificate revocation list overwrites the existing client certificate revocation list.

Uploading a client certificate revocation list resets existing client connections.

- responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ImportClientVpnClientCertificateRevocationListResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ImportClientVpnClientCertificateRevocationListRequest' - parameters: [] - /?Action=ImportImage&Version=2016-11-15: - get: - x-aws-operation-name: ImportImage - operationId: GET_ImportImage - description: '

Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI).

For more information, see Importing a VM as an image using VM Import/Export in the VM Import/Export User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ImportImageResult' - parameters: - - name: Architecture - in: query - required: false - description: '

The architecture of the virtual machine.

Valid values: i386 | x86_64

' - schema: - type: string - - name: ClientData - in: query - required: false - description: The client-specific data. - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The time that the disk upload starts. - description: Describes the client-specific data. - - name: ClientToken - in: query - required: false - description: The token to enable idempotency for VM import requests. - schema: - type: string - - name: Description - in: query - required: false - description: A description string for the import image task. - schema: - type: string - - name: DiskContainer - in: query - required: false - description: Information about the disk containers. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/ImageDiskContainer' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: Encrypted - in: query - required: false - description: 'Specifies whether the destination AMI of the imported image should be encrypted. The default KMS key for EBS is used unless you specify a non-default KMS key using KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.' - schema: - type: boolean - - name: Hypervisor - in: query - required: false - description: '

The target hypervisor platform.

Valid values: xen

' - schema: - type: string - - name: KmsKeyId - in: query - required: false - description: '

An identifier for the symmetric KMS key to use when creating the encrypted AMI. This parameter is only required if you want to use a non-default KMS key; if this parameter is not specified, the default KMS key for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.

The KMS key identifier may be provided in any of the following formats:

  • Key ID

  • Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the alias namespace, and then the key alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

  • ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the key namespace, and then the key ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

  • ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the alias namespace, and then the key alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

Amazon Web Services parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.

The specified KMS key must exist in the Region that the AMI is being copied to.

Amazon EBS does not support asymmetric KMS keys.

' - schema: - type: string - - name: LicenseType - in: query - required: false - description: '

The license type to be used for the Amazon Machine Image (AMI) after importing.

By default, we detect the source-system operating system (OS) and apply the appropriate license. Specify AWS to replace the source-system license with an Amazon Web Services license, if appropriate. Specify BYOL to retain the source-system license, if appropriate.

To use BYOL, you must have existing licenses with rights to use these licenses in a third party cloud, such as Amazon Web Services. For more information, see Prerequisites in the VM Import/Export User Guide.

' - schema: - type: string - - name: Platform - in: query - required: false - description: '

The operating system of the virtual machine.

Valid values: Windows | Linux

' - schema: - type: string - - name: RoleName - in: query - required: false - description: 'The name of the role to use when not using the default role, ''vmimport''.' - schema: - type: string - - name: LicenseSpecifications - in: query - required: false - description: The ARNs of the license configurations. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/ImportImageLicenseConfigurationRequest' - - xml: - name: item - - name: TagSpecification - in: query - required: false - description: The tags to apply to the import image task during creation. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - - name: UsageOperation - in: query - required: false - description: 'The usage operation value. For more information, see Licensing options in the VM Import/Export User Guide.' - schema: - type: string - - name: BootMode - in: query - required: false - description: The boot mode of the virtual machine. - schema: - type: string - enum: - - legacy-bios - - uefi - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ImportImage - operationId: POST_ImportImage - description: '

Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI).

For more information, see Importing a VM as an image using VM Import/Export in the VM Import/Export User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ImportImageResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ImportImageRequest' - parameters: [] - /?Action=ImportInstance&Version=2016-11-15: - get: - x-aws-operation-name: ImportInstance - operationId: GET_ImportInstance - description: '

Creates an import instance task using metadata from the specified disk image.

This API action supports only single-volume VMs. To import multi-volume VMs, use ImportImage instead.

This API action is not supported by the Command Line Interface (CLI). For information about using the Amazon EC2 CLI, which is deprecated, see Importing a VM to Amazon EC2 in the Amazon EC2 CLI Reference PDF file.

For information about the import manifest referenced by this API action, see VM Import Manifest.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ImportInstanceResult' - parameters: - - name: Description - in: query - required: false - description: A description for the instance being imported. - schema: - type: string - - name: DiskImage - in: query - required: false - description: The disk image. - schema: - type: array - items: - $ref: '#/components/schemas/DiskImage' - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: LaunchSpecification - in: query - required: false - description: The launch specification. - schema: - type: object - properties: - additionalInfo: - allOf: - - $ref: '#/components/schemas/String' - - description: Reserved. - architecture: - allOf: - - $ref: '#/components/schemas/ArchitectureValues' - - description: The architecture of the instance. - GroupId: - allOf: - - $ref: '#/components/schemas/SecurityGroupIdStringList' - - description: The security group IDs. - GroupName: - allOf: - - $ref: '#/components/schemas/SecurityGroupStringList' - - description: The security group names. - instanceInitiatedShutdownBehavior: - allOf: - - $ref: '#/components/schemas/ShutdownBehavior' - - description: Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown). - instanceType: - allOf: - - $ref: '#/components/schemas/InstanceType' - - description: 'The instance type. For more information about the instance types that you can import, see Instance Types in the VM Import/Export User Guide.' - monitoring: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether monitoring is enabled. - placement: - allOf: - - $ref: '#/components/schemas/Placement' - - description: The placement information for the instance. - privateIpAddress: - allOf: - - $ref: '#/components/schemas/String' - - description: '[EC2-VPC] An available IP address from the IP address range of the subnet.' - subnetId: - allOf: - - $ref: '#/components/schemas/SubnetId' - - description: '[EC2-VPC] The ID of the subnet in which to launch the instance.' - userData: - allOf: - - $ref: '#/components/schemas/UserData' - - description: The Base64-encoded user data to make available to the instance. - description: Describes the launch specification for VM import. - - name: Platform - in: query - required: true - description: The instance operating system. - schema: - type: string - enum: - - Windows - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ImportInstance - operationId: POST_ImportInstance - description: '

Creates an import instance task using metadata from the specified disk image.

This API action supports only single-volume VMs. To import multi-volume VMs, use ImportImage instead.

This API action is not supported by the Command Line Interface (CLI). For information about using the Amazon EC2 CLI, which is deprecated, see Importing a VM to Amazon EC2 in the Amazon EC2 CLI Reference PDF file.

For information about the import manifest referenced by this API action, see VM Import Manifest.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ImportInstanceResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ImportInstanceRequest' - parameters: [] - /?Action=ImportKeyPair&Version=2016-11-15: - get: - x-aws-operation-name: ImportKeyPair - operationId: GET_ImportKeyPair - description: '

Imports the public key from an RSA or ED25519 key pair that you created with a third-party tool. Compare this with CreateKeyPair, in which Amazon Web Services creates the key pair and gives the keys to you (Amazon Web Services keeps a copy of the public key). With ImportKeyPair, you create the key pair and give Amazon Web Services just the public key. The private key is never transferred between you and Amazon Web Services.

For more information about key pairs, see Amazon EC2 key pairs in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ImportKeyPairResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: KeyName - in: query - required: true - description: A unique name for the key pair. - schema: - type: string - - name: PublicKeyMaterial - in: query - required: true - description: 'The public key. For API calls, the text must be base64-encoded. For command line tools, base64 encoding is performed for you.' - schema: - type: string - - name: TagSpecification - in: query - required: false - description: The tags to apply to the imported key pair. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ImportKeyPair - operationId: POST_ImportKeyPair - description: '

Imports the public key from an RSA or ED25519 key pair that you created with a third-party tool. Compare this with CreateKeyPair, in which Amazon Web Services creates the key pair and gives the keys to you (Amazon Web Services keeps a copy of the public key). With ImportKeyPair, you create the key pair and give Amazon Web Services just the public key. The private key is never transferred between you and Amazon Web Services.

For more information about key pairs, see Amazon EC2 key pairs in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ImportKeyPairResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ImportKeyPairRequest' - parameters: [] - /?Action=ImportSnapshot&Version=2016-11-15: - get: - x-aws-operation-name: ImportSnapshot - operationId: GET_ImportSnapshot - description: '

Imports a disk into an EBS snapshot.

For more information, see Importing a disk as a snapshot using VM Import/Export in the VM Import/Export User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ImportSnapshotResult' - parameters: - - name: ClientData - in: query - required: false - description: The client-specific data. - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The time that the disk upload starts. - description: Describes the client-specific data. - - name: ClientToken - in: query - required: false - description: Token to enable idempotency for VM import requests. - schema: - type: string - - name: Description - in: query - required: false - description: The description string for the import snapshot task. - schema: - type: string - - name: DiskContainer - in: query - required: false - description: Information about the disk container. - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/UserBucket' - - description: The Amazon S3 bucket for the disk image. - description: The disk container object for the import snapshot request. - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: Encrypted - in: query - required: false - description: 'Specifies whether the destination snapshot of the imported image should be encrypted. The default KMS key for EBS is used unless you specify a non-default KMS key using KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.' - schema: - type: boolean - - name: KmsKeyId - in: query - required: false - description: '

An identifier for the symmetric KMS key to use when creating the encrypted snapshot. This parameter is only required if you want to use a non-default KMS key; if this parameter is not specified, the default KMS key for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.

The KMS key identifier may be provided in any of the following formats:

  • Key ID

  • Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the alias namespace, and then the key alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

  • ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the key namespace, and then the key ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

  • ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the alias namespace, and then the key alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

Amazon Web Services parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.

The specified KMS key must exist in the Region that the snapshot is being copied to.

Amazon EBS does not support asymmetric KMS keys.

' - schema: - type: string - - name: RoleName - in: query - required: false - description: 'The name of the role to use when not using the default role, ''vmimport''.' - schema: - type: string - - name: TagSpecification - in: query - required: false - description: The tags to apply to the import snapshot task during creation. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ImportSnapshot - operationId: POST_ImportSnapshot - description: '

Imports a disk into an EBS snapshot.

For more information, see Importing a disk as a snapshot using VM Import/Export in the VM Import/Export User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ImportSnapshotResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ImportSnapshotRequest' - parameters: [] - /?Action=ImportVolume&Version=2016-11-15: - get: - x-aws-operation-name: ImportVolume - operationId: GET_ImportVolume - description: '

Creates an import volume task using metadata from the specified disk image.

This API action supports only single-volume VMs. To import multi-volume VMs, use ImportImage instead. To import a disk to a snapshot, use ImportSnapshot instead.

This API action is not supported by the Command Line Interface (CLI). For information about using the Amazon EC2 CLI, which is deprecated, see Importing Disks to Amazon EBS in the Amazon EC2 CLI Reference PDF file.

For information about the import manifest referenced by this API action, see VM Import Manifest.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ImportVolumeResult' - parameters: - - name: AvailabilityZone - in: query - required: true - description: The Availability Zone for the resulting EBS volume. - schema: - type: string - - name: Description - in: query - required: false - description: A description of the volume. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: Image - in: query - required: true - description: The disk image. - schema: - type: object - required: - - Bytes - - Format - - ImportManifestUrl - properties: - bytes: - allOf: - - $ref: '#/components/schemas/Long' - - description: 'The size of the disk image, in GiB.' - format: - allOf: - - $ref: '#/components/schemas/DiskImageFormat' - - description: The disk image format. - importManifestUrl: - allOf: - - $ref: '#/components/schemas/String' - - description: '

A presigned URL for the import manifest stored in Amazon S3 and presented here as an Amazon S3 presigned URL. For information about creating a presigned URL for an Amazon S3 object, read the "Query String Request Authentication Alternative" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.

For information about the import manifest referenced by this API action, see VM Import Manifest.

' - description: Describes a disk image. - - name: Volume - in: query - required: true - description: The volume size. - schema: - type: object - required: - - Size - properties: - size: - allOf: - - $ref: '#/components/schemas/Long' - - description: 'The size of the volume, in GiB.' - description: Describes an EBS volume. - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ImportVolume - operationId: POST_ImportVolume - description: '

Creates an import volume task using metadata from the specified disk image.

This API action supports only single-volume VMs. To import multi-volume VMs, use ImportImage instead. To import a disk to a snapshot, use ImportSnapshot instead.

This API action is not supported by the Command Line Interface (CLI). For information about using the Amazon EC2 CLI, which is deprecated, see Importing Disks to Amazon EBS in the Amazon EC2 CLI Reference PDF file.

For information about the import manifest referenced by this API action, see VM Import Manifest.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ImportVolumeResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ImportVolumeRequest' - parameters: [] - /?Action=ListImagesInRecycleBin&Version=2016-11-15: - get: - x-aws-operation-name: ListImagesInRecycleBin - operationId: GET_ListImagesInRecycleBin - description: 'Lists one or more AMIs that are currently in the Recycle Bin. For more information, see Recycle Bin in the Amazon Elastic Compute Cloud User Guide.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ListImagesInRecycleBinResult' - parameters: - - name: ImageId - in: query - required: false - description: The IDs of the AMIs to list. Omit this parameter to list all of the AMIs that are in the Recycle Bin. You can specify up to 20 IDs in a single request. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/ImageId' - - xml: - name: ImageId - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - - name: MaxResults - in: query - required: false - description: '

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 1,000 items per page by default. For more information, see Pagination.

' - schema: - type: integer - minimum: 1 - maximum: 1000 - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ListImagesInRecycleBin - operationId: POST_ListImagesInRecycleBin - description: 'Lists one or more AMIs that are currently in the Recycle Bin. For more information, see Recycle Bin in the Amazon Elastic Compute Cloud User Guide.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ListImagesInRecycleBinResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ListImagesInRecycleBinRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=ListSnapshotsInRecycleBin&Version=2016-11-15: - get: - x-aws-operation-name: ListSnapshotsInRecycleBin - operationId: GET_ListSnapshotsInRecycleBin - description: Lists one or more snapshots that are currently in the Recycle Bin. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ListSnapshotsInRecycleBinResult' - parameters: - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - schema: - type: integer - minimum: 5 - maximum: 1000 - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - - name: SnapshotId - in: query - required: false - description: The IDs of the snapshots to list. Omit this parameter to list all of the snapshots that are in the Recycle Bin. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/SnapshotId' - - xml: - name: SnapshotId - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ListSnapshotsInRecycleBin - operationId: POST_ListSnapshotsInRecycleBin - description: Lists one or more snapshots that are currently in the Recycle Bin. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ListSnapshotsInRecycleBinResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ListSnapshotsInRecycleBinRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=ModifyAddressAttribute&Version=2016-11-15: - get: - x-aws-operation-name: ModifyAddressAttribute - operationId: GET_ModifyAddressAttribute - description: 'Modifies an attribute of the specified Elastic IP address. For requirements, see Using reverse DNS for email applications.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyAddressAttributeResult' - parameters: - - name: AllocationId - in: query - required: true - description: '[EC2-VPC] The allocation ID.' - schema: - type: string - - name: DomainName - in: query - required: false - description: The domain name to modify for the IP address. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ModifyAddressAttribute - operationId: POST_ModifyAddressAttribute - description: 'Modifies an attribute of the specified Elastic IP address. For requirements, see Using reverse DNS for email applications.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyAddressAttributeResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyAddressAttributeRequest' - parameters: [] - /?Action=ModifyAvailabilityZoneGroup&Version=2016-11-15: - get: - x-aws-operation-name: ModifyAvailabilityZoneGroup - operationId: GET_ModifyAvailabilityZoneGroup - description: '

Changes the opt-in status of the Local Zone and Wavelength Zone group for your account.

Use DescribeAvailabilityZones to view the value for GroupName.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyAvailabilityZoneGroupResult' - parameters: - - name: GroupName - in: query - required: true - description: 'The name of the Availability Zone group, Local Zone group, or Wavelength Zone group.' - schema: - type: string - - name: OptInStatus - in: query - required: true - description: 'Indicates whether you are opted in to the Local Zone group or Wavelength Zone group. The only valid value is opted-in. You must contact Amazon Web Services Support to opt out of a Local Zone or Wavelength Zone group.' - schema: - type: string - enum: - - opted-in - - not-opted-in - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ModifyAvailabilityZoneGroup - operationId: POST_ModifyAvailabilityZoneGroup - description: '

Changes the opt-in status of the Local Zone and Wavelength Zone group for your account.

Use DescribeAvailabilityZones to view the value for GroupName.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyAvailabilityZoneGroupResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyAvailabilityZoneGroupRequest' - parameters: [] - /?Action=ModifyCapacityReservation&Version=2016-11-15: - get: - x-aws-operation-name: ModifyCapacityReservation - operationId: GET_ModifyCapacityReservation - description: 'Modifies a Capacity Reservation''s capacity and the conditions under which it is to be released. You cannot change a Capacity Reservation''s instance type, EBS optimization, instance store settings, platform, Availability Zone, or instance eligibility. If you need to modify any of these attributes, we recommend that you cancel the Capacity Reservation, and then create a new one with the required attributes.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyCapacityReservationResult' - parameters: - - name: CapacityReservationId - in: query - required: true - description: The ID of the Capacity Reservation. - schema: - type: string - - name: InstanceCount - in: query - required: false - description: The number of instances for which to reserve capacity. The number of instances can't be increased or decreased by more than 1000 in a single request. - schema: - type: integer - - name: EndDate - in: query - required: false - description: '

The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation''s state changes to expired when it reaches its end date and time.

The Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019.

You must provide an EndDate value if EndDateType is limited. Omit EndDate if EndDateType is unlimited.

' - schema: - type: string - format: date-time - - name: EndDateType - in: query - required: false - description: '

Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:

  • unlimited - The Capacity Reservation remains active until you explicitly cancel it. Do not provide an EndDate value if EndDateType is unlimited.

  • limited - The Capacity Reservation expires automatically at a specified date and time. You must provide an EndDate value if EndDateType is limited.

' - schema: - type: string - enum: - - unlimited - - limited - - name: Accept - in: query - required: false - description: Reserved. Capacity Reservations you have created are accepted by default. - schema: - type: boolean - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: AdditionalInfo - in: query - required: false - description: Reserved for future use. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ModifyCapacityReservation - operationId: POST_ModifyCapacityReservation - description: 'Modifies a Capacity Reservation''s capacity and the conditions under which it is to be released. You cannot change a Capacity Reservation''s instance type, EBS optimization, instance store settings, platform, Availability Zone, or instance eligibility. If you need to modify any of these attributes, we recommend that you cancel the Capacity Reservation, and then create a new one with the required attributes.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyCapacityReservationResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyCapacityReservationRequest' - parameters: [] - /?Action=ModifyCapacityReservationFleet&Version=2016-11-15: - get: - x-aws-operation-name: ModifyCapacityReservationFleet - operationId: GET_ModifyCapacityReservationFleet - description: '

Modifies a Capacity Reservation Fleet.

When you modify the total target capacity of a Capacity Reservation Fleet, the Fleet automatically creates new Capacity Reservations, or modifies or cancels existing Capacity Reservations in the Fleet to meet the new total target capacity. When you modify the end date for the Fleet, the end dates for all of the individual Capacity Reservations in the Fleet are updated accordingly.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyCapacityReservationFleetResult' - parameters: - - name: CapacityReservationFleetId - in: query - required: true - description: The ID of the Capacity Reservation Fleet to modify. - schema: - type: string - - name: TotalTargetCapacity - in: query - required: false - description: 'The total number of capacity units to be reserved by the Capacity Reservation Fleet. This value, together with the instance type weights that you assign to each instance type used by the Fleet determine the number of instances for which the Fleet reserves capacity. Both values are based on units that make sense for your workload. For more information, see Total target capacity in the Amazon EC2 User Guide.' - schema: - type: integer - - name: EndDate - in: query - required: false - description: '

The date and time at which the Capacity Reservation Fleet expires. When the Capacity Reservation Fleet expires, its state changes to expired and all of the Capacity Reservations in the Fleet expire.

The Capacity Reservation Fleet expires within an hour after the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation Fleet is guaranteed to expire between 13:30:55 and 14:30:55 on 5/31/2019.

You can''t specify EndDate and RemoveEndDate in the same request.

' - schema: - type: string - format: date-time - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: RemoveEndDate - in: query - required: false - description: '

Indicates whether to remove the end date from the Capacity Reservation Fleet. If you remove the end date, the Capacity Reservation Fleet does not expire and it remains active until you explicitly cancel it using the CancelCapacityReservationFleet action.

You can''t specify RemoveEndDate and EndDate in the same request.

' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ModifyCapacityReservationFleet - operationId: POST_ModifyCapacityReservationFleet - description: '

Modifies a Capacity Reservation Fleet.

When you modify the total target capacity of a Capacity Reservation Fleet, the Fleet automatically creates new Capacity Reservations, or modifies or cancels existing Capacity Reservations in the Fleet to meet the new total target capacity. When you modify the end date for the Fleet, the end dates for all of the individual Capacity Reservations in the Fleet are updated accordingly.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyCapacityReservationFleetResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyCapacityReservationFleetRequest' - parameters: [] - /?Action=ModifyClientVpnEndpoint&Version=2016-11-15: - get: - x-aws-operation-name: ModifyClientVpnEndpoint - operationId: GET_ModifyClientVpnEndpoint - description: Modifies the specified Client VPN endpoint. Modifying the DNS server resets existing client connections. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyClientVpnEndpointResult' - parameters: - - name: ClientVpnEndpointId - in: query - required: true - description: The ID of the Client VPN endpoint to modify. - schema: - type: string - - name: ServerCertificateArn - in: query - required: false - description: The ARN of the server certificate to be used. The server certificate must be provisioned in Certificate Manager (ACM). - schema: - type: string - - name: ConnectionLogOptions - in: query - required: false - description: '

Information about the client connection logging options.

If you enable client connection logging, data about client connections is sent to a Cloudwatch Logs log stream. The following information is logged:

  • Client connection requests

  • Client connection results (successful and unsuccessful)

  • Reasons for unsuccessful client connection requests

  • Client connection termination time

' - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of the CloudWatch Logs log stream to which the connection data is published. - description: Describes the client connection logging options for the Client VPN endpoint. - - name: DnsServers - in: query - required: false - description: Information about the DNS servers to be used by Client VPN connections. A Client VPN endpoint can have up to two DNS servers. - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether DNS servers should be used. Specify False to delete the existing DNS servers. - description: Information about the DNS server to be used. - - name: VpnPort - in: query - required: false - description: '

The port number to assign to the Client VPN endpoint for TCP and UDP traffic.

Valid Values: 443 | 1194

Default Value: 443

' - schema: - type: integer - - name: Description - in: query - required: false - description: A brief description of the Client VPN endpoint. - schema: - type: string - - name: SplitTunnel - in: query - required: false - description: '

Indicates whether the VPN is split-tunnel.

For information about split-tunnel VPN endpoints, see Split-tunnel Client VPN endpoint in the Client VPN Administrator Guide.

' - schema: - type: boolean - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: SecurityGroupId - in: query - required: false - description: The IDs of one or more security groups to apply to the target network. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/SecurityGroupId' - - xml: - name: item - - name: VpcId - in: query - required: false - description: The ID of the VPC to associate with the Client VPN endpoint. - schema: - type: string - - name: SelfServicePortal - in: query - required: false - description: Specify whether to enable the self-service portal for the Client VPN endpoint. - schema: - type: string - enum: - - enabled - - disabled - - name: ClientConnectOptions - in: query - required: false - description: The options for managing connection authorization for new client connections. - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Resource Name (ARN) of the Lambda function used for connection authorization. - description: The options for managing connection authorization for new client connections. - - name: SessionTimeoutHours - in: query - required: false - description: '

The maximum VPN session duration time in hours.

Valid values: 8 | 10 | 12 | 24

Default value: 24

' - schema: - type: integer - - name: ClientLoginBannerOptions - in: query - required: false - description: Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established. - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: Customizable text that will be displayed in a banner on Amazon Web Services provided clients when a VPN session is established. UTF-8 encoded characters only. Maximum of 1400 characters. - description: Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established. - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ModifyClientVpnEndpoint - operationId: POST_ModifyClientVpnEndpoint - description: Modifies the specified Client VPN endpoint. Modifying the DNS server resets existing client connections. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyClientVpnEndpointResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyClientVpnEndpointRequest' - parameters: [] - /?Action=ModifyDefaultCreditSpecification&Version=2016-11-15: - get: - x-aws-operation-name: ModifyDefaultCreditSpecification - operationId: GET_ModifyDefaultCreditSpecification - description: '

Modifies the default credit option for CPU usage of burstable performance instances. The default credit option is set at the account level per Amazon Web Services Region, and is specified per instance family. All new burstable performance instances in the account launch using the default credit option.

ModifyDefaultCreditSpecification is an asynchronous operation, which works at an Amazon Web Services Region level and modifies the credit option for each Availability Zone. All zones in a Region are updated within five minutes. But if instances are launched during this operation, they might not get the new credit option until the zone is updated. To verify whether the update has occurred, you can call GetDefaultCreditSpecification and check DefaultCreditSpecification for updates.

For more information, see Burstable performance instances in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyDefaultCreditSpecificationResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: InstanceFamily - in: query - required: true - description: The instance family. - schema: - type: string - enum: - - t2 - - t3 - - t3a - - t4g - - name: CpuCredits - in: query - required: true - description: '

The credit option for CPU usage of the instance family.

Valid Values: standard | unlimited

' - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ModifyDefaultCreditSpecification - operationId: POST_ModifyDefaultCreditSpecification - description: '

Modifies the default credit option for CPU usage of burstable performance instances. The default credit option is set at the account level per Amazon Web Services Region, and is specified per instance family. All new burstable performance instances in the account launch using the default credit option.

ModifyDefaultCreditSpecification is an asynchronous operation, which works at an Amazon Web Services Region level and modifies the credit option for each Availability Zone. All zones in a Region are updated within five minutes. But if instances are launched during this operation, they might not get the new credit option until the zone is updated. To verify whether the update has occurred, you can call GetDefaultCreditSpecification and check DefaultCreditSpecification for updates.

For more information, see Burstable performance instances in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyDefaultCreditSpecificationResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyDefaultCreditSpecificationRequest' - parameters: [] - /?Action=ModifyEbsDefaultKmsKeyId&Version=2016-11-15: - get: - x-aws-operation-name: ModifyEbsDefaultKmsKeyId - operationId: GET_ModifyEbsDefaultKmsKeyId - description: '

Changes the default KMS key for EBS encryption by default for your account in this Region.

Amazon Web Services creates a unique Amazon Web Services managed KMS key in each Region for use with encryption by default. If you change the default KMS key to a symmetric customer managed KMS key, it is used instead of the Amazon Web Services managed KMS key. To reset the default KMS key to the Amazon Web Services managed KMS key for EBS, use ResetEbsDefaultKmsKeyId. Amazon EBS does not support asymmetric KMS keys.

If you delete or disable the customer managed KMS key that you specified for use with encryption by default, your instances will fail to launch.

For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyEbsDefaultKmsKeyIdResult' - parameters: - - name: KmsKeyId - in: query - required: true - description: '

The identifier of the Key Management Service (KMS) KMS key to use for Amazon EBS encryption. If this parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId is specified, the encrypted state must be true.

You can specify the KMS key using any of the following:

  • Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.

  • Key alias. For example, alias/ExampleAlias.

  • Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.

  • Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.

Amazon EBS does not support asymmetric KMS keys.

' - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ModifyEbsDefaultKmsKeyId - operationId: POST_ModifyEbsDefaultKmsKeyId - description: '

Changes the default KMS key for EBS encryption by default for your account in this Region.

Amazon Web Services creates a unique Amazon Web Services managed KMS key in each Region for use with encryption by default. If you change the default KMS key to a symmetric customer managed KMS key, it is used instead of the Amazon Web Services managed KMS key. To reset the default KMS key to the Amazon Web Services managed KMS key for EBS, use ResetEbsDefaultKmsKeyId. Amazon EBS does not support asymmetric KMS keys.

If you delete or disable the customer managed KMS key that you specified for use with encryption by default, your instances will fail to launch.

For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyEbsDefaultKmsKeyIdResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyEbsDefaultKmsKeyIdRequest' - parameters: [] - /?Action=ModifyFleet&Version=2016-11-15: - get: - x-aws-operation-name: ModifyFleet - operationId: GET_ModifyFleet - description: '

Modifies the specified EC2 Fleet.

You can only modify an EC2 Fleet request of type maintain.

While the EC2 Fleet is being modified, it is in the modifying state.

To scale up your EC2 Fleet, increase its target capacity. The EC2 Fleet launches the additional Spot Instances according to the allocation strategy for the EC2 Fleet request. If the allocation strategy is lowest-price, the EC2 Fleet launches instances using the Spot Instance pool with the lowest price. If the allocation strategy is diversified, the EC2 Fleet distributes the instances across the Spot Instance pools. If the allocation strategy is capacity-optimized, EC2 Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching.

To scale down your EC2 Fleet, decrease its target capacity. First, the EC2 Fleet cancels any open requests that exceed the new target capacity. You can request that the EC2 Fleet terminate Spot Instances until the size of the fleet no longer exceeds the new target capacity. If the allocation strategy is lowest-price, the EC2 Fleet terminates the instances with the highest price per unit. If the allocation strategy is capacity-optimized, the EC2 Fleet terminates the instances in the Spot Instance pools that have the least available Spot Instance capacity. If the allocation strategy is diversified, the EC2 Fleet terminates instances across the Spot Instance pools. Alternatively, you can request that the EC2 Fleet keep the fleet at its current size, but not replace any Spot Instances that are interrupted or that you terminate manually.

If you are finished with your EC2 Fleet for now, but will use it again later, you can set the target capacity to 0.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyFleetResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: ExcessCapacityTerminationPolicy - in: query - required: false - description: Indicates whether running instances should be terminated if the total target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet. - schema: - type: string - enum: - - no-termination - - termination - - name: LaunchTemplateConfig - in: query - required: false - description: The launch template and overrides. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/FleetLaunchTemplateConfigRequest' - - xml: - name: item - minItems: 0 - maxItems: 50 - - name: FleetId - in: query - required: true - description: The ID of the EC2 Fleet. - schema: - type: string - - name: TargetCapacitySpecification - in: query - required: false - description: The size of the EC2 Fleet. - schema: - type: object - required: - - TotalTargetCapacity - properties: - undefined: - allOf: - - $ref: '#/components/schemas/TargetCapacityUnitType' - - description: '

The unit for the target capacity.

Default: units (translates to number of instances)

' - description: '

The number of units to request. You can choose to set the target capacity as the number of instances. Or you can set the target capacity to a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.

You can use the On-Demand Instance MaxTotalPrice parameter, the Spot Instance MaxTotalPrice parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, EC2 Fleet will launch instances until it reaches the maximum amount that you''re willing to pay. When the maximum amount you''re willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity. The MaxTotalPrice parameters are located in OnDemandOptionsRequest and SpotOptionsRequest.

' - - name: Context - in: query - required: false - description: Reserved. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ModifyFleet - operationId: POST_ModifyFleet - description: '

Modifies the specified EC2 Fleet.

You can only modify an EC2 Fleet request of type maintain.

While the EC2 Fleet is being modified, it is in the modifying state.

To scale up your EC2 Fleet, increase its target capacity. The EC2 Fleet launches the additional Spot Instances according to the allocation strategy for the EC2 Fleet request. If the allocation strategy is lowest-price, the EC2 Fleet launches instances using the Spot Instance pool with the lowest price. If the allocation strategy is diversified, the EC2 Fleet distributes the instances across the Spot Instance pools. If the allocation strategy is capacity-optimized, EC2 Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching.

To scale down your EC2 Fleet, decrease its target capacity. First, the EC2 Fleet cancels any open requests that exceed the new target capacity. You can request that the EC2 Fleet terminate Spot Instances until the size of the fleet no longer exceeds the new target capacity. If the allocation strategy is lowest-price, the EC2 Fleet terminates the instances with the highest price per unit. If the allocation strategy is capacity-optimized, the EC2 Fleet terminates the instances in the Spot Instance pools that have the least available Spot Instance capacity. If the allocation strategy is diversified, the EC2 Fleet terminates instances across the Spot Instance pools. Alternatively, you can request that the EC2 Fleet keep the fleet at its current size, but not replace any Spot Instances that are interrupted or that you terminate manually.

If you are finished with your EC2 Fleet for now, but will use it again later, you can set the target capacity to 0.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyFleetResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyFleetRequest' - parameters: [] - /?Action=ModifyFpgaImageAttribute&Version=2016-11-15: - get: - x-aws-operation-name: ModifyFpgaImageAttribute - operationId: GET_ModifyFpgaImageAttribute - description: Modifies the specified attribute of the specified Amazon FPGA Image (AFI). - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyFpgaImageAttributeResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: FpgaImageId - in: query - required: true - description: The ID of the AFI. - schema: - type: string - - name: Attribute - in: query - required: false - description: The name of the attribute. - schema: - type: string - enum: - - description - - name - - loadPermission - - productCodes - - name: OperationType - in: query - required: false - description: The operation type. - schema: - type: string - enum: - - add - - remove - - name: UserId - in: query - required: false - description: The Amazon Web Services account IDs. This parameter is valid only when modifying the loadPermission attribute. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: UserId - - name: UserGroup - in: query - required: false - description: The user groups. This parameter is valid only when modifying the loadPermission attribute. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: UserGroup - - name: ProductCode - in: query - required: false - description: 'The product codes. After you add a product code to an AFI, it can''t be removed. This parameter is valid only when modifying the productCodes attribute.' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: ProductCode - - name: LoadPermission - in: query - required: false - description: The load permission for the AFI. - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/LoadPermissionListRequest' - - description: The load permissions to remove. - description: Describes modifications to the load permissions of an Amazon FPGA image (AFI). - - name: Description - in: query - required: false - description: A description for the AFI. - schema: - type: string - - name: Name - in: query - required: false - description: A name for the AFI. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ModifyFpgaImageAttribute - operationId: POST_ModifyFpgaImageAttribute - description: Modifies the specified attribute of the specified Amazon FPGA Image (AFI). - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyFpgaImageAttributeResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyFpgaImageAttributeRequest' - parameters: [] - /?Action=ModifyHosts&Version=2016-11-15: - get: - x-aws-operation-name: ModifyHosts - operationId: GET_ModifyHosts - description: '

Modify the auto-placement setting of a Dedicated Host. When auto-placement is enabled, any instances that you launch with a tenancy of host but without a specific host ID are placed onto any available Dedicated Host in your account that has auto-placement enabled. When auto-placement is disabled, you need to provide a host ID to have the instance launch onto a specific host. If no host ID is provided, the instance is launched onto a suitable host with auto-placement enabled.

You can also use this API action to modify a Dedicated Host to support either multiple instance types in an instance family, or to support a specific instance type only.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyHostsResult' - parameters: - - name: AutoPlacement - in: query - required: false - description: Specify whether to enable or disable auto-placement. - schema: - type: string - enum: - - 'on' - - 'off' - - name: HostId - in: query - required: true - description: The IDs of the Dedicated Hosts to modify. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/DedicatedHostId' - - xml: - name: item - - name: HostRecovery - in: query - required: false - description: 'Indicates whether to enable or disable host recovery for the Dedicated Host. For more information, see Host recovery in the Amazon EC2 User Guide.' - schema: - type: string - enum: - - 'on' - - 'off' - - name: InstanceType - in: query - required: false - description: '

Specifies the instance type to be supported by the Dedicated Host. Specify this parameter to modify a Dedicated Host to support only a specific instance type.

If you want to modify a Dedicated Host to support multiple instance types in its current instance family, omit this parameter and specify InstanceFamily instead. You cannot specify InstanceType and InstanceFamily in the same request.

' - schema: - type: string - - name: InstanceFamily - in: query - required: false - description: '

Specifies the instance family to be supported by the Dedicated Host. Specify this parameter to modify a Dedicated Host to support multiple instance types within its current instance family.

If you want to modify a Dedicated Host to support a specific instance type only, omit this parameter and specify InstanceType instead. You cannot specify InstanceFamily and InstanceType in the same request.

' - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ModifyHosts - operationId: POST_ModifyHosts - description: '

Modify the auto-placement setting of a Dedicated Host. When auto-placement is enabled, any instances that you launch with a tenancy of host but without a specific host ID are placed onto any available Dedicated Host in your account that has auto-placement enabled. When auto-placement is disabled, you need to provide a host ID to have the instance launch onto a specific host. If no host ID is provided, the instance is launched onto a suitable host with auto-placement enabled.

You can also use this API action to modify a Dedicated Host to support either multiple instance types in an instance family, or to support a specific instance type only.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyHostsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyHostsRequest' - parameters: [] - /?Action=ModifyIdFormat&Version=2016-11-15: - get: - x-aws-operation-name: ModifyIdFormat - operationId: GET_ModifyIdFormat - description: '

Modifies the ID format for the specified resource on a per-Region basis. You can specify that resources should receive longer IDs (17-character IDs) when they are created.

This request can only be used to modify longer ID settings for resource types that are within the opt-in period. Resources currently in their opt-in period include: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | route-table | route-table-association | security-group | subnet | subnet-cidr-block-association | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.

This setting applies to the IAM user who makes the request; it does not apply to the entire Amazon Web Services account. By default, an IAM user defaults to the same settings as the root user. If you''re using this action as the root user, then these settings apply to the entire account, unless an IAM user explicitly overrides these settings for themselves. For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.

Resources created with longer IDs are visible to all IAM roles and users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type.

' - responses: - '200': - description: Success - parameters: - - name: Resource - in: query - required: true - description: '

The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | route-table | route-table-association | security-group | subnet | subnet-cidr-block-association | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.

Alternatively, use the all-current option to include all resource types that are currently within their opt-in period for longer IDs.

' - schema: - type: string - - name: UseLongIds - in: query - required: true - description: Indicate whether the resource should use longer IDs (17-character IDs). - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ModifyIdFormat - operationId: POST_ModifyIdFormat - description: '

Modifies the ID format for the specified resource on a per-Region basis. You can specify that resources should receive longer IDs (17-character IDs) when they are created.

This request can only be used to modify longer ID settings for resource types that are within the opt-in period. Resources currently in their opt-in period include: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | route-table | route-table-association | security-group | subnet | subnet-cidr-block-association | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.

This setting applies to the IAM user who makes the request; it does not apply to the entire Amazon Web Services account. By default, an IAM user defaults to the same settings as the root user. If you''re using this action as the root user, then these settings apply to the entire account, unless an IAM user explicitly overrides these settings for themselves. For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.

Resources created with longer IDs are visible to all IAM roles and users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type.

' - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyIdFormatRequest' - parameters: [] - /?Action=ModifyIdentityIdFormat&Version=2016-11-15: - get: - x-aws-operation-name: ModifyIdentityIdFormat - operationId: GET_ModifyIdentityIdFormat - description: '

Modifies the ID format of a resource for a specified IAM user, IAM role, or the root user for an account; or all IAM users, IAM roles, and the root user for an account. You can specify that resources should receive longer IDs (17-character IDs) when they are created.

This request can only be used to modify longer ID settings for resource types that are within the opt-in period. Resources currently in their opt-in period include: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | route-table | route-table-association | security-group | subnet | subnet-cidr-block-association | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.

For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.

This setting applies to the principal specified in the request; it does not apply to the principal that makes the request.

Resources created with longer IDs are visible to all IAM roles and users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type.

' - responses: - '200': - description: Success - parameters: - - name: PrincipalArn - in: query - required: true - description: 'The ARN of the principal, which can be an IAM user, IAM role, or the root user. Specify all to modify the ID format for all IAM users, IAM roles, and the root user of the account.' - schema: - type: string - - name: Resource - in: query - required: true - description: '

The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | route-table | route-table-association | security-group | subnet | subnet-cidr-block-association | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.

Alternatively, use the all-current option to include all resource types that are currently within their opt-in period for longer IDs.

' - schema: - type: string - - name: UseLongIds - in: query - required: true - description: Indicates whether the resource should use longer IDs (17-character IDs) - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ModifyIdentityIdFormat - operationId: POST_ModifyIdentityIdFormat - description: '

Modifies the ID format of a resource for a specified IAM user, IAM role, or the root user for an account; or all IAM users, IAM roles, and the root user for an account. You can specify that resources should receive longer IDs (17-character IDs) when they are created.

This request can only be used to modify longer ID settings for resource types that are within the opt-in period. Resources currently in their opt-in period include: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | route-table | route-table-association | security-group | subnet | subnet-cidr-block-association | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.

For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.

This setting applies to the principal specified in the request; it does not apply to the principal that makes the request.

Resources created with longer IDs are visible to all IAM roles and users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type.

' - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyIdentityIdFormatRequest' - parameters: [] - /?Action=ModifyImageAttribute&Version=2016-11-15: - get: - x-aws-operation-name: ModifyImageAttribute - operationId: GET_ModifyImageAttribute - description: '

Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time. You can use the Attribute parameter to specify the attribute or one of the following parameters: Description or LaunchPermission.

Images with an Amazon Web Services Marketplace product code cannot be made public.

To enable the SriovNetSupport enhanced networking attribute of an image, enable SriovNetSupport on an instance and create an AMI from the instance.

' - responses: - '200': - description: Success - parameters: - - name: Attribute - in: query - required: false - description: '

The name of the attribute to modify.

Valid values: description | launchPermission

' - schema: - type: string - - name: Description - in: query - required: false - description: A new description for the AMI. - schema: - type: object - properties: - value: - allOf: - - $ref: '#/components/schemas/String' - - description: The attribute value. The value is case-sensitive. - description: Describes a value for a resource attribute that is a String. - - name: ImageId - in: query - required: true - description: The ID of the AMI. - schema: - type: string - - name: LaunchPermission - in: query - required: false - description: A new launch permission for the AMI. - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/LaunchPermissionList' - - description: 'The Amazon Web Services account ID, organization ARN, or OU ARN to remove from the list of launch permissions for the AMI.' - description: Describes a launch permission modification. - - name: OperationType - in: query - required: false - description: The operation type. This parameter can be used only when the Attribute parameter is launchPermission. - schema: - type: string - enum: - - add - - remove - - name: ProductCode - in: query - required: false - description: Not supported. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: ProductCode - - name: UserGroup - in: query - required: false - description: The user groups. This parameter can be used only when the Attribute parameter is launchPermission. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: UserGroup - - name: UserId - in: query - required: false - description: The Amazon Web Services account IDs. This parameter can be used only when the Attribute parameter is launchPermission. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: UserId - - name: Value - in: query - required: false - description: The value of the attribute being modified. This parameter can be used only when the Attribute parameter is description. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: OrganizationArn - in: query - required: false - description: The Amazon Resource Name (ARN) of an organization. This parameter can be used only when the Attribute parameter is launchPermission. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: OrganizationArn - - name: OrganizationalUnitArn - in: query - required: false - description: The Amazon Resource Name (ARN) of an organizational unit (OU). This parameter can be used only when the Attribute parameter is launchPermission. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: OrganizationalUnitArn - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ModifyImageAttribute - operationId: POST_ModifyImageAttribute - description: '

Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time. You can use the Attribute parameter to specify the attribute or one of the following parameters: Description or LaunchPermission.

Images with an Amazon Web Services Marketplace product code cannot be made public.

To enable the SriovNetSupport enhanced networking attribute of an image, enable SriovNetSupport on an instance and create an AMI from the instance.

' - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyImageAttributeRequest' - parameters: [] - /?Action=ModifyInstanceAttribute&Version=2016-11-15: - get: - x-aws-operation-name: ModifyInstanceAttribute - operationId: GET_ModifyInstanceAttribute - description: '

Modifies the specified attribute of the specified instance. You can specify only one attribute at a time.

Note: Using this action to change the security groups associated with an elastic network interface (ENI) attached to an instance in a VPC can result in an error if the instance has more than one ENI. To change the security groups associated with an ENI attached to an instance that has multiple ENIs, we recommend that you use the ModifyNetworkInterfaceAttribute action.

To modify some attributes, the instance must be stopped. For more information, see Modify a stopped instance in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - parameters: - - name: SourceDestCheck - in: query - required: false - description: 'Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives. If the value is true, source/destination checks are enabled; otherwise, they are disabled. The default value is true. You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.' - schema: - type: object - properties: - value: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: The attribute value. The valid values are true or false. - description: Describes a value for a resource attribute that is a Boolean value. - - name: Attribute - in: query - required: false - description: The name of the attribute. - schema: - type: string - enum: - - instanceType - - kernel - - ramdisk - - userData - - disableApiTermination - - instanceInitiatedShutdownBehavior - - rootDeviceName - - blockDeviceMapping - - productCodes - - sourceDestCheck - - groupSet - - ebsOptimized - - sriovNetSupport - - enaSupport - - enclaveOptions - - name: BlockDeviceMapping - in: query - required: false - description: '

Modifies the DeleteOnTermination attribute for volumes that are currently attached. The volume must be owned by the caller. If no value is specified for DeleteOnTermination, the default is true and the volume is deleted when the instance is terminated.

To add instance store volumes to an Amazon EBS-backed instance, you must add them when you launch the instance. For more information, see Update the block device mapping when launching an instance in the Amazon EC2 User Guide.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/InstanceBlockDeviceMappingSpecification' - - xml: - name: item - - name: DisableApiTermination - in: query - required: false - description: 'If the value is true, you can''t terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. You cannot use this parameter for Spot Instances.' - schema: - type: object - properties: - value: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: The attribute value. The valid values are true or false. - description: Describes a value for a resource attribute that is a Boolean value. - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: EbsOptimized - in: query - required: false - description: Specifies whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance. - schema: - type: object - properties: - value: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: The attribute value. The valid values are true or false. - description: Describes a value for a resource attribute that is a Boolean value. - - name: EnaSupport - in: query - required: false - description:

Set to true to enable enhanced networking with ENA for the instance.

This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.

- schema: - type: object - properties: - value: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: The attribute value. The valid values are true or false. - description: Describes a value for a resource attribute that is a Boolean value. - - name: GroupId - in: query - required: false - description: '[EC2-VPC] Replaces the security groups of the instance with the specified security groups. You must specify at least one security group, even if it''s just the default security group for the VPC. You must specify the security group ID, not the security group name.' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/SecurityGroupId' - - xml: - name: groupId - - name: InstanceId - in: query - required: true - description: The ID of the instance. - schema: - type: string - - name: InstanceInitiatedShutdownBehavior - in: query - required: false - description: Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown). - schema: - type: object - properties: - value: - allOf: - - $ref: '#/components/schemas/String' - - description: The attribute value. The value is case-sensitive. - description: Describes a value for a resource attribute that is a String. - - name: InstanceType - in: query - required: false - description: 'Changes the instance type to the specified value. For more information, see Instance types in the Amazon EC2 User Guide. If the instance type is not valid, the error returned is InvalidInstanceAttributeValue.' - schema: - type: object - properties: - value: - allOf: - - $ref: '#/components/schemas/String' - - description: The attribute value. The value is case-sensitive. - description: Describes a value for a resource attribute that is a String. - - name: Kernel - in: query - required: false - description: 'Changes the instance''s kernel to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.' - schema: - type: object - properties: - value: - allOf: - - $ref: '#/components/schemas/String' - - description: The attribute value. The value is case-sensitive. - description: Describes a value for a resource attribute that is a String. - - name: Ramdisk - in: query - required: false - description: 'Changes the instance''s RAM disk to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.' - schema: - type: object - properties: - value: - allOf: - - $ref: '#/components/schemas/String' - - description: The attribute value. The value is case-sensitive. - description: Describes a value for a resource attribute that is a String. - - name: SriovNetSupport - in: query - required: false - description:

Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the instance.

There is no way to disable enhanced networking with the Intel 82599 Virtual Function interface at this time.

This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.

- schema: - type: object - properties: - value: - allOf: - - $ref: '#/components/schemas/String' - - description: The attribute value. The value is case-sensitive. - description: Describes a value for a resource attribute that is a String. - - name: UserData - in: query - required: false - description: 'Changes the instance''s user data to the specified value. If you are using an Amazon Web Services SDK or command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text.' - schema: - type: object - properties: - value: - $ref: '#/components/schemas/Blob' - - name: Value - in: query - required: false - description: 'A new value for the attribute. Use only with the kernel, ramdisk, userData, disableApiTermination, or instanceInitiatedShutdownBehavior attribute.' - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ModifyInstanceAttribute - operationId: POST_ModifyInstanceAttribute - description: '

Modifies the specified attribute of the specified instance. You can specify only one attribute at a time.

Note: Using this action to change the security groups associated with an elastic network interface (ENI) attached to an instance in a VPC can result in an error if the instance has more than one ENI. To change the security groups associated with an ENI attached to an instance that has multiple ENIs, we recommend that you use the ModifyNetworkInterfaceAttribute action.

To modify some attributes, the instance must be stopped. For more information, see Modify a stopped instance in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyInstanceAttributeRequest' - parameters: [] - /?Action=ModifyInstanceCapacityReservationAttributes&Version=2016-11-15: - get: - x-aws-operation-name: ModifyInstanceCapacityReservationAttributes - operationId: GET_ModifyInstanceCapacityReservationAttributes - description: 'Modifies the Capacity Reservation settings for a stopped instance. Use this action to configure an instance to target a specific Capacity Reservation, run in any open Capacity Reservation with matching attributes, or run On-Demand Instance capacity.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyInstanceCapacityReservationAttributesResult' - parameters: - - name: InstanceId - in: query - required: true - description: The ID of the instance to be modified. - schema: - type: string - - name: CapacityReservationSpecification - in: query - required: true - description: Information about the Capacity Reservation targeting option. - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/CapacityReservationTarget' - - description: Information about the target Capacity Reservation or Capacity Reservation group. - description: '

Describes an instance''s Capacity Reservation targeting option. You can specify only one parameter at a time. If you specify CapacityReservationPreference and CapacityReservationTarget, the request fails.

Use the CapacityReservationPreference parameter to configure the instance to run as an On-Demand Instance or to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). Use the CapacityReservationTarget parameter to explicitly target a specific Capacity Reservation or a Capacity Reservation group.

' - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ModifyInstanceCapacityReservationAttributes - operationId: POST_ModifyInstanceCapacityReservationAttributes - description: 'Modifies the Capacity Reservation settings for a stopped instance. Use this action to configure an instance to target a specific Capacity Reservation, run in any open Capacity Reservation with matching attributes, or run On-Demand Instance capacity.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyInstanceCapacityReservationAttributesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyInstanceCapacityReservationAttributesRequest' - parameters: [] - /?Action=ModifyInstanceCreditSpecification&Version=2016-11-15: - get: - x-aws-operation-name: ModifyInstanceCreditSpecification - operationId: GET_ModifyInstanceCreditSpecification - description: '

Modifies the credit option for CPU usage on a running or stopped burstable performance instance. The credit options are standard and unlimited.

For more information, see Burstable performance instances in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyInstanceCreditSpecificationResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: ClientToken - in: query - required: false - description: 'A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.' - schema: - type: string - - name: InstanceCreditSpecification - in: query - required: true - description: Information about the credit option for CPU usage. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/InstanceCreditSpecificationRequest' - - xml: - name: item - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ModifyInstanceCreditSpecification - operationId: POST_ModifyInstanceCreditSpecification - description: '

Modifies the credit option for CPU usage on a running or stopped burstable performance instance. The credit options are standard and unlimited.

For more information, see Burstable performance instances in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyInstanceCreditSpecificationResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyInstanceCreditSpecificationRequest' - parameters: [] - /?Action=ModifyInstanceEventStartTime&Version=2016-11-15: - get: - x-aws-operation-name: ModifyInstanceEventStartTime - operationId: GET_ModifyInstanceEventStartTime - description: Modifies the start time for a scheduled Amazon EC2 instance event. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyInstanceEventStartTimeResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: InstanceId - in: query - required: true - description: The ID of the instance with the scheduled event. - schema: - type: string - - name: InstanceEventId - in: query - required: true - description: The ID of the event whose date and time you are modifying. - schema: - type: string - - name: NotBefore - in: query - required: true - description: The new date and time when the event will take place. - schema: - type: string - format: date-time - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ModifyInstanceEventStartTime - operationId: POST_ModifyInstanceEventStartTime - description: Modifies the start time for a scheduled Amazon EC2 instance event. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyInstanceEventStartTimeResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyInstanceEventStartTimeRequest' - parameters: [] - /?Action=ModifyInstanceEventWindow&Version=2016-11-15: - get: - x-aws-operation-name: ModifyInstanceEventWindow - operationId: GET_ModifyInstanceEventWindow - description: '

Modifies the specified event window.

You can define either a set of time ranges or a cron expression when modifying the event window, but not both.

To modify the targets associated with the event window, use the AssociateInstanceEventWindow and DisassociateInstanceEventWindow API.

If Amazon Web Services has already scheduled an event, modifying an event window won''t change the time of the scheduled event.

For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyInstanceEventWindowResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: Name - in: query - required: false - description: The name of the event window. - schema: - type: string - - name: InstanceEventWindowId - in: query - required: true - description: The ID of the event window. - schema: - type: string - - name: TimeRange - in: query - required: false - description: The time ranges of the event window. - schema: - type: array - items: - $ref: '#/components/schemas/InstanceEventWindowTimeRangeRequest' - - name: CronExpression - in: query - required: false - description: '

The cron expression of the event window, for example, * 0-4,20-23 * * 1,5.

Constraints:

  • Only hour and day of the week values are supported.

  • For day of the week values, you can specify either integers 0 through 6, or alternative single values SUN through SAT.

  • The minute, month, and year must be specified by *.

  • The hour value must be one or a multiple range, for example, 0-4 or 0-4,20-23.

  • Each hour range must be >= 2 hours, for example, 0-2 or 20-23.

  • The event window must be >= 4 hours. The combined total time ranges in the event window must be >= 4 hours.

For more information about cron expressions, see cron on the Wikipedia website.

' - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ModifyInstanceEventWindow - operationId: POST_ModifyInstanceEventWindow - description: '

Modifies the specified event window.

You can define either a set of time ranges or a cron expression when modifying the event window, but not both.

To modify the targets associated with the event window, use the AssociateInstanceEventWindow and DisassociateInstanceEventWindow API.

If Amazon Web Services has already scheduled an event, modifying an event window won''t change the time of the scheduled event.

For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyInstanceEventWindowResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyInstanceEventWindowRequest' - parameters: [] - /?Action=ModifyInstanceMaintenanceOptions&Version=2016-11-15: - get: - x-aws-operation-name: ModifyInstanceMaintenanceOptions - operationId: GET_ModifyInstanceMaintenanceOptions - description: 'Modifies the recovery behavior of your instance to disable simplified automatic recovery or set the recovery behavior to default. The default configuration will not enable simplified automatic recovery for an unsupported instance type. For more information, see Simplified automatic recovery.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyInstanceMaintenanceOptionsResult' - parameters: - - name: InstanceId - in: query - required: true - description: The ID of the instance. - schema: - type: string - - name: AutoRecovery - in: query - required: false - description: Disables the automatic recovery behavior of your instance or sets it to default. - schema: - type: string - enum: - - disabled - - default - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ModifyInstanceMaintenanceOptions - operationId: POST_ModifyInstanceMaintenanceOptions - description: 'Modifies the recovery behavior of your instance to disable simplified automatic recovery or set the recovery behavior to default. The default configuration will not enable simplified automatic recovery for an unsupported instance type. For more information, see Simplified automatic recovery.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyInstanceMaintenanceOptionsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyInstanceMaintenanceOptionsRequest' - parameters: [] - /?Action=ModifyInstanceMetadataOptions&Version=2016-11-15: - get: - x-aws-operation-name: ModifyInstanceMetadataOptions - operationId: GET_ModifyInstanceMetadataOptions - description: 'Modify the instance metadata parameters on a running or stopped instance. When you modify the parameters on a stopped instance, they are applied when the instance is started. When you modify the parameters on a running instance, the API responds with a state of “pending”. After the parameter modifications are successfully applied to the instance, the state of the modifications changes from “pending” to “applied” in subsequent describe-instances API calls. For more information, see Instance metadata and user data in the Amazon EC2 User Guide.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyInstanceMetadataOptionsResult' - parameters: - - name: InstanceId - in: query - required: true - description: The ID of the instance. - schema: - type: string - - name: HttpTokens - in: query - required: false - description: '

The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional.

If the state is optional, you can choose to retrieve instance metadata with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0 role credentials are returned.

If the state is required, you must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials; the version 1.0 credentials are not available.

' - schema: - type: string - enum: - - optional - - required - - name: HttpPutResponseHopLimit - in: query - required: false - description: '

The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel. If no parameter is specified, the existing state is maintained.

Possible values: Integers from 1 to 64

' - schema: - type: integer - - name: HttpEndpoint - in: query - required: false - description: '

Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not specified, the existing state is maintained.

If you specify a value of disabled, you cannot access your instance metadata.

' - schema: - type: string - enum: - - disabled - - enabled - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: HttpProtocolIpv6 - in: query - required: false - description: Enables or disables the IPv6 endpoint for the instance metadata service. This setting applies only if you have enabled the HTTP metadata endpoint. - schema: - type: string - enum: - - disabled - - enabled - - name: InstanceMetadataTags - in: query - required: false - description: '

Set to enabled to allow access to instance tags from the instance metadata. Set to disabled to turn off access to instance tags from the instance metadata. For more information, see Work with instance tags using the instance metadata.

Default: disabled

' - schema: - type: string - enum: - - disabled - - enabled - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ModifyInstanceMetadataOptions - operationId: POST_ModifyInstanceMetadataOptions - description: 'Modify the instance metadata parameters on a running or stopped instance. When you modify the parameters on a stopped instance, they are applied when the instance is started. When you modify the parameters on a running instance, the API responds with a state of “pending”. After the parameter modifications are successfully applied to the instance, the state of the modifications changes from “pending” to “applied” in subsequent describe-instances API calls. For more information, see Instance metadata and user data in the Amazon EC2 User Guide.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyInstanceMetadataOptionsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyInstanceMetadataOptionsRequest' - parameters: [] - /?Action=ModifyInstancePlacement&Version=2016-11-15: - get: - x-aws-operation-name: ModifyInstancePlacement - operationId: GET_ModifyInstancePlacement - description: '

Modifies the placement attributes for a specified instance. You can do the following:

  • Modify the affinity between an instance and a Dedicated Host. When affinity is set to host and the instance is not associated with a specific Dedicated Host, the next time the instance is launched, it is automatically associated with the host on which it lands. If the instance is restarted or rebooted, this relationship persists.

  • Change the Dedicated Host with which an instance is associated.

  • Change the instance tenancy of an instance.

  • Move an instance to or from a placement group.

At least one attribute for affinity, host ID, tenancy, or placement group name must be specified in the request. Affinity and tenancy can be modified in the same request.

To modify the host ID, tenancy, placement group, or partition for an instance, the instance must be in the stopped state.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyInstancePlacementResult' - parameters: - - name: Affinity - in: query - required: false - description: The affinity setting for the instance. - schema: - type: string - enum: - - default - - host - - name: GroupName - in: query - required: false - description: '

The name of the placement group in which to place the instance. For spread placement groups, the instance must have a tenancy of default. For cluster and partition placement groups, the instance must have a tenancy of default or dedicated.

To remove an instance from a placement group, specify an empty string ("").

' - schema: - type: string - - name: HostId - in: query - required: false - description: The ID of the Dedicated Host with which to associate the instance. - schema: - type: string - - name: InstanceId - in: query - required: true - description: The ID of the instance that you are modifying. - schema: - type: string - - name: Tenancy - in: query - required: false - description: '

The tenancy for the instance.

For T3 instances, you can''t change the tenancy from dedicated to host, or from host to dedicated. Attempting to make one of these unsupported tenancy changes results in the InvalidTenancy error code.

' - schema: - type: string - enum: - - dedicated - - host - - name: PartitionNumber - in: query - required: false - description: The number of the partition in which to place the instance. Valid only if the placement group strategy is set to partition. - schema: - type: integer - - name: HostResourceGroupArn - in: query - required: false - description: The ARN of the host resource group in which to place the instance. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ModifyInstancePlacement - operationId: POST_ModifyInstancePlacement - description: '

Modifies the placement attributes for a specified instance. You can do the following:

  • Modify the affinity between an instance and a Dedicated Host. When affinity is set to host and the instance is not associated with a specific Dedicated Host, the next time the instance is launched, it is automatically associated with the host on which it lands. If the instance is restarted or rebooted, this relationship persists.

  • Change the Dedicated Host with which an instance is associated.

  • Change the instance tenancy of an instance.

  • Move an instance to or from a placement group.

At least one attribute for affinity, host ID, tenancy, or placement group name must be specified in the request. Affinity and tenancy can be modified in the same request.

To modify the host ID, tenancy, placement group, or partition for an instance, the instance must be in the stopped state.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyInstancePlacementResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyInstancePlacementRequest' - parameters: [] - /?Action=ModifyIpam&Version=2016-11-15: - get: - x-aws-operation-name: ModifyIpam - operationId: GET_ModifyIpam - description: 'Modify the configurations of an IPAM. ' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyIpamResult' - parameters: - - name: DryRun - in: query - required: false - description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: IpamId - in: query - required: true - description: The ID of the IPAM you want to modify. - schema: - type: string - - name: Description - in: query - required: false - description: The description of the IPAM you want to modify. - schema: - type: string - - name: AddOperatingRegion - in: query - required: false - description: '

Choose the operating Regions for the IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.

' - schema: - type: array - items: - $ref: '#/components/schemas/AddIpamOperatingRegion' - minItems: 0 - maxItems: 50 - - name: RemoveOperatingRegion - in: query - required: false - description: The operating Regions to remove. - schema: - type: array - items: - $ref: '#/components/schemas/RemoveIpamOperatingRegion' - minItems: 0 - maxItems: 50 - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ModifyIpam - operationId: POST_ModifyIpam - description: 'Modify the configurations of an IPAM. ' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyIpamResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyIpamRequest' - parameters: [] - /?Action=ModifyIpamPool&Version=2016-11-15: - get: - x-aws-operation-name: ModifyIpamPool - operationId: GET_ModifyIpamPool - description: '

Modify the configurations of an IPAM pool.

For more information, see Modify a pool in the Amazon VPC IPAM User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyIpamPoolResult' - parameters: - - name: DryRun - in: query - required: false - description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: IpamPoolId - in: query - required: true - description: The ID of the IPAM pool you want to modify. - schema: - type: string - - name: Description - in: query - required: false - description: The description of the IPAM pool you want to modify. - schema: - type: string - - name: AutoImport - in: query - required: false - description: '

If true, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool''s allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.

A locale must be set on the pool for this feature to work.

' - schema: - type: boolean - - name: AllocationMinNetmaskLength - in: query - required: false - description: The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128. The minimum netmask length must be less than the maximum netmask length. - schema: - type: integer - minimum: 0 - maximum: 128 - - name: AllocationMaxNetmaskLength - in: query - required: false - description: The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.The maximum netmask length must be greater than the minimum netmask length. - schema: - type: integer - minimum: 0 - maximum: 128 - - name: AllocationDefaultNetmaskLength - in: query - required: false - description: 'The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.' - schema: - type: integer - minimum: 0 - maximum: 128 - - name: ClearAllocationDefaultNetmaskLength - in: query - required: false - description: Clear the default netmask length allocation rule for this pool. - schema: - type: boolean - - name: AddAllocationResourceTag - in: query - required: false - description: 'Add tag allocation rules to a pool. For more information about allocation rules, see Create a top-level pool in the Amazon VPC IPAM User Guide.' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/RequestIpamResourceTag' - - xml: - name: item - - name: RemoveAllocationResourceTag - in: query - required: false - description: Remove tag allocation rules from a pool. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/RequestIpamResourceTag' - - xml: - name: item - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ModifyIpamPool - operationId: POST_ModifyIpamPool - description: '

Modify the configurations of an IPAM pool.

For more information, see Modify a pool in the Amazon VPC IPAM User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyIpamPoolResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyIpamPoolRequest' - parameters: [] - /?Action=ModifyIpamResourceCidr&Version=2016-11-15: - get: - x-aws-operation-name: ModifyIpamResourceCidr - operationId: GET_ModifyIpamResourceCidr - description: '

Modify a resource CIDR. You can use this action to transfer resource CIDRs between scopes and ignore resource CIDRs that you do not want to manage. If set to false, the resource will not be tracked for overlap, it cannot be auto-imported into a pool, and it will be removed from any pool it has an allocation in.

For more information, see Move resource CIDRs between scopes and Change the monitoring state of resource CIDRs in the Amazon VPC IPAM User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyIpamResourceCidrResult' - parameters: - - name: DryRun - in: query - required: false - description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: ResourceId - in: query - required: true - description: The ID of the resource you want to modify. - schema: - type: string - - name: ResourceCidr - in: query - required: true - description: The CIDR of the resource you want to modify. - schema: - type: string - - name: ResourceRegion - in: query - required: true - description: The Amazon Web Services Region of the resource you want to modify. - schema: - type: string - - name: CurrentIpamScopeId - in: query - required: true - description: The ID of the current scope that the resource CIDR is in. - schema: - type: string - - name: DestinationIpamScopeId - in: query - required: false - description: The ID of the scope you want to transfer the resource CIDR to. - schema: - type: string - - name: Monitored - in: query - required: true - description: 'Determines if the resource is monitored by IPAM. If a resource is monitored, the resource is discovered by IPAM and you can view details about the resource’s CIDR.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ModifyIpamResourceCidr - operationId: POST_ModifyIpamResourceCidr - description: '

Modify a resource CIDR. You can use this action to transfer resource CIDRs between scopes and ignore resource CIDRs that you do not want to manage. If set to false, the resource will not be tracked for overlap, it cannot be auto-imported into a pool, and it will be removed from any pool it has an allocation in.

For more information, see Move resource CIDRs between scopes and Change the monitoring state of resource CIDRs in the Amazon VPC IPAM User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyIpamResourceCidrResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyIpamResourceCidrRequest' - parameters: [] - /?Action=ModifyIpamScope&Version=2016-11-15: - get: - x-aws-operation-name: ModifyIpamScope - operationId: GET_ModifyIpamScope - description: Modify an IPAM scope. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyIpamScopeResult' - parameters: - - name: DryRun - in: query - required: false - description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: IpamScopeId - in: query - required: true - description: The ID of the scope you want to modify. - schema: - type: string - - name: Description - in: query - required: false - description: The description of the scope you want to modify. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ModifyIpamScope - operationId: POST_ModifyIpamScope - description: Modify an IPAM scope. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyIpamScopeResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyIpamScopeRequest' - parameters: [] - /?Action=ModifyLaunchTemplate&Version=2016-11-15: - get: - x-aws-operation-name: ModifyLaunchTemplate - operationId: GET_ModifyLaunchTemplate - description: 'Modifies a launch template. You can specify which version of the launch template to set as the default version. When launching an instance, the default version applies when a launch template version is not specified.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyLaunchTemplateResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: ClientToken - in: query - required: false - description: '

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

Constraint: Maximum 128 ASCII characters.

' - schema: - type: string - - name: LaunchTemplateId - in: query - required: false - description: The ID of the launch template. You must specify either the launch template ID or launch template name in the request. - schema: - type: string - - name: LaunchTemplateName - in: query - required: false - description: The name of the launch template. You must specify either the launch template ID or launch template name in the request. - schema: - type: string - pattern: '[a-zA-Z0-9\(\)\.\-/_]+' - minLength: 3 - maxLength: 128 - - name: SetDefaultVersion - in: query - required: false - description: The version number of the launch template to set as the default version. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ModifyLaunchTemplate - operationId: POST_ModifyLaunchTemplate - description: 'Modifies a launch template. You can specify which version of the launch template to set as the default version. When launching an instance, the default version applies when a launch template version is not specified.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyLaunchTemplateResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyLaunchTemplateRequest' - parameters: [] - /?Action=ModifyManagedPrefixList&Version=2016-11-15: - get: - x-aws-operation-name: ModifyManagedPrefixList - operationId: GET_ModifyManagedPrefixList - description: '

Modifies the specified managed prefix list.

Adding or removing entries in a prefix list creates a new version of the prefix list. Changing the name of the prefix list does not affect the version.

If you specify a current version number that does not match the true current version number, the request fails.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyManagedPrefixListResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: PrefixListId - in: query - required: true - description: The ID of the prefix list. - schema: - type: string - - name: CurrentVersion - in: query - required: false - description: The current version of the prefix list. - schema: - type: integer - - name: PrefixListName - in: query - required: false - description: A name for the prefix list. - schema: - type: string - - name: AddEntry - in: query - required: false - description: One or more entries to add to the prefix list. - schema: - type: array - items: - $ref: '#/components/schemas/AddPrefixListEntry' - minItems: 0 - maxItems: 100 - - name: RemoveEntry - in: query - required: false - description: One or more entries to remove from the prefix list. - schema: - type: array - items: - $ref: '#/components/schemas/RemovePrefixListEntry' - minItems: 0 - maxItems: 100 - - name: MaxEntries - in: query - required: false - description: '

The maximum number of entries for the prefix list. You cannot modify the entries of a prefix list and modify the size of a prefix list at the same time.

If any of the resources that reference the prefix list cannot support the new maximum size, the modify operation fails. Check the state message for the IDs of the first ten resources that do not support the new maximum size.

' - schema: - type: integer - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ModifyManagedPrefixList - operationId: POST_ModifyManagedPrefixList - description: '

Modifies the specified managed prefix list.

Adding or removing entries in a prefix list creates a new version of the prefix list. Changing the name of the prefix list does not affect the version.

If you specify a current version number that does not match the true current version number, the request fails.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyManagedPrefixListResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyManagedPrefixListRequest' - parameters: [] - /?Action=ModifyNetworkInterfaceAttribute&Version=2016-11-15: - get: - x-aws-operation-name: ModifyNetworkInterfaceAttribute - operationId: GET_ModifyNetworkInterfaceAttribute - description: Modifies the specified network interface attribute. You can specify only one attribute at a time. You can use this action to attach and detach security groups from an existing EC2 instance. - responses: - '200': - description: Success - parameters: - - name: Attachment - in: query - required: false - description: 'Information about the interface attachment. If modifying the ''delete on termination'' attribute, you must specify the ID of the interface attachment.' - schema: - type: object - properties: - attachmentId: - allOf: - - $ref: '#/components/schemas/NetworkInterfaceAttachmentId' - - description: The ID of the network interface attachment. - deleteOnTermination: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether the network interface is deleted when the instance is terminated. - description: Describes an attachment change. - - name: Description - in: query - required: false - description: A description for the network interface. - schema: - type: object - properties: - value: - allOf: - - $ref: '#/components/schemas/String' - - description: The attribute value. The value is case-sensitive. - description: Describes a value for a resource attribute that is a String. - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: SecurityGroupId - in: query - required: false - description: 'Changes the security groups for the network interface. The new set of groups you specify replaces the current set. You must specify at least one group, even if it''s just the default security group in the VPC. You must specify the ID of the security group, not the name.' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/SecurityGroupId' - - xml: - name: SecurityGroupId - - name: NetworkInterfaceId - in: query - required: true - description: The ID of the network interface. - schema: - type: string - - name: SourceDestCheck - in: query - required: false - description: 'Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives. If the value is true, source/destination checks are enabled; otherwise, they are disabled. The default value is true. You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.' - schema: - type: object - properties: - value: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: The attribute value. The valid values are true or false. - description: Describes a value for a resource attribute that is a Boolean value. - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ModifyNetworkInterfaceAttribute - operationId: POST_ModifyNetworkInterfaceAttribute - description: Modifies the specified network interface attribute. You can specify only one attribute at a time. You can use this action to attach and detach security groups from an existing EC2 instance. - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyNetworkInterfaceAttributeRequest' - parameters: [] - /?Action=ModifyPrivateDnsNameOptions&Version=2016-11-15: - get: - x-aws-operation-name: ModifyPrivateDnsNameOptions - operationId: GET_ModifyPrivateDnsNameOptions - description: Modifies the options for instance hostnames for the specified instance. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyPrivateDnsNameOptionsResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: InstanceId - in: query - required: false - description: The ID of the instance. - schema: - type: string - - name: PrivateDnsHostnameType - in: query - required: false - description: 'The type of hostname for EC2 instances. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance IPv4 address or the instance ID.' - schema: - type: string - enum: - - ip-name - - resource-name - - name: EnableResourceNameDnsARecord - in: query - required: false - description: Indicates whether to respond to DNS queries for instance hostnames with DNS A records. - schema: - type: boolean - - name: EnableResourceNameDnsAAAARecord - in: query - required: false - description: Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records. - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ModifyPrivateDnsNameOptions - operationId: POST_ModifyPrivateDnsNameOptions - description: Modifies the options for instance hostnames for the specified instance. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyPrivateDnsNameOptionsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyPrivateDnsNameOptionsRequest' - parameters: [] - /?Action=ModifyReservedInstances&Version=2016-11-15: - get: - x-aws-operation-name: ModifyReservedInstances - operationId: GET_ModifyReservedInstances - description: '

Modifies the Availability Zone, instance count, instance type, or network platform (EC2-Classic or EC2-VPC) of your Reserved Instances. The Reserved Instances to be modified must be identical, except for Availability Zone, network platform, and instance type.

For more information, see Modifying Reserved Instances in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyReservedInstancesResult' - parameters: - - name: ReservedInstancesId - in: query - required: true - description: The IDs of the Reserved Instances to modify. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/ReservationId' - - xml: - name: ReservedInstancesId - - name: ClientToken - in: query - required: false - description: 'A unique, case-sensitive token you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.' - schema: - type: string - - name: ReservedInstancesConfigurationSetItemType - in: query - required: true - description: The configuration settings for the Reserved Instances to modify. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/ReservedInstancesConfiguration' - - xml: - name: item - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ModifyReservedInstances - operationId: POST_ModifyReservedInstances - description: '

Modifies the Availability Zone, instance count, instance type, or network platform (EC2-Classic or EC2-VPC) of your Reserved Instances. The Reserved Instances to be modified must be identical, except for Availability Zone, network platform, and instance type.

For more information, see Modifying Reserved Instances in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyReservedInstancesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyReservedInstancesRequest' - parameters: [] - /?Action=ModifySecurityGroupRules&Version=2016-11-15: - get: - x-aws-operation-name: ModifySecurityGroupRules - operationId: GET_ModifySecurityGroupRules - description: Modifies the rules of a security group. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifySecurityGroupRulesResult' - parameters: - - name: GroupId - in: query - required: true - description: The ID of the security group. - schema: - type: string - - name: SecurityGroupRule - in: query - required: true - description: Information about the security group properties to update. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/SecurityGroupRuleUpdate' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ModifySecurityGroupRules - operationId: POST_ModifySecurityGroupRules - description: Modifies the rules of a security group. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifySecurityGroupRulesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifySecurityGroupRulesRequest' - parameters: [] - /?Action=ModifySnapshotAttribute&Version=2016-11-15: - get: - x-aws-operation-name: ModifySnapshotAttribute - operationId: GET_ModifySnapshotAttribute - description: '

Adds or removes permission settings for the specified snapshot. You may add or remove specified Amazon Web Services account IDs from a snapshot''s list of create volume permissions, but you cannot do both in a single operation. If you need to both add and remove account IDs for a snapshot, you must use multiple operations. You can make up to 500 modifications to a snapshot in a single operation.

Encrypted snapshots and snapshots with Amazon Web Services Marketplace product codes cannot be made public. Snapshots encrypted with your default KMS key cannot be shared with other accounts.

For more information about modifying snapshot permissions, see Share a snapshot in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - parameters: - - name: Attribute - in: query - required: false - description: The snapshot attribute to modify. Only volume creation permissions can be modified. - schema: - type: string - enum: - - productCodes - - createVolumePermission - - name: CreateVolumePermission - in: query - required: false - description: A JSON representation of the snapshot attribute modification. - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/CreateVolumePermissionList' - - description: Removes the specified Amazon Web Services account ID or group from the list. - description: Describes modifications to the list of create volume permissions for a volume. - - name: UserGroup - in: query - required: false - description: The group to modify for the snapshot. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/SecurityGroupName' - - xml: - name: GroupName - - name: OperationType - in: query - required: false - description: The type of operation to perform to the attribute. - schema: - type: string - enum: - - add - - remove - - name: SnapshotId - in: query - required: true - description: The ID of the snapshot. - schema: - type: string - - name: UserId - in: query - required: false - description: The account ID to modify for the snapshot. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: UserId - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ModifySnapshotAttribute - operationId: POST_ModifySnapshotAttribute - description: '

Adds or removes permission settings for the specified snapshot. You may add or remove specified Amazon Web Services account IDs from a snapshot''s list of create volume permissions, but you cannot do both in a single operation. If you need to both add and remove account IDs for a snapshot, you must use multiple operations. You can make up to 500 modifications to a snapshot in a single operation.

Encrypted snapshots and snapshots with Amazon Web Services Marketplace product codes cannot be made public. Snapshots encrypted with your default KMS key cannot be shared with other accounts.

For more information about modifying snapshot permissions, see Share a snapshot in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifySnapshotAttributeRequest' - parameters: [] - /?Action=ModifySnapshotTier&Version=2016-11-15: - get: - x-aws-operation-name: ModifySnapshotTier - operationId: GET_ModifySnapshotTier - description: 'Archives an Amazon EBS snapshot. When you archive a snapshot, it is converted to a full snapshot that includes all of the blocks of data that were written to the volume at the time the snapshot was created, and moved from the standard tier to the archive tier. For more information, see Archive Amazon EBS snapshots in the Amazon Elastic Compute Cloud User Guide.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifySnapshotTierResult' - parameters: - - name: SnapshotId - in: query - required: true - description: The ID of the snapshot. - schema: - type: string - - name: StorageTier - in: query - required: false - description: The name of the storage tier. You must specify archive. - schema: - type: string - enum: - - archive - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ModifySnapshotTier - operationId: POST_ModifySnapshotTier - description: 'Archives an Amazon EBS snapshot. When you archive a snapshot, it is converted to a full snapshot that includes all of the blocks of data that were written to the volume at the time the snapshot was created, and moved from the standard tier to the archive tier. For more information, see Archive Amazon EBS snapshots in the Amazon Elastic Compute Cloud User Guide.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifySnapshotTierResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifySnapshotTierRequest' - parameters: [] - /?Action=ModifySpotFleetRequest&Version=2016-11-15: - get: - x-aws-operation-name: ModifySpotFleetRequest - operationId: GET_ModifySpotFleetRequest - description: '

Modifies the specified Spot Fleet request.

You can only modify a Spot Fleet request of type maintain.

While the Spot Fleet request is being modified, it is in the modifying state.

To scale up your Spot Fleet, increase its target capacity. The Spot Fleet launches the additional Spot Instances according to the allocation strategy for the Spot Fleet request. If the allocation strategy is lowestPrice, the Spot Fleet launches instances using the Spot Instance pool with the lowest price. If the allocation strategy is diversified, the Spot Fleet distributes the instances across the Spot Instance pools. If the allocation strategy is capacityOptimized, Spot Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching.

To scale down your Spot Fleet, decrease its target capacity. First, the Spot Fleet cancels any open requests that exceed the new target capacity. You can request that the Spot Fleet terminate Spot Instances until the size of the fleet no longer exceeds the new target capacity. If the allocation strategy is lowestPrice, the Spot Fleet terminates the instances with the highest price per unit. If the allocation strategy is capacityOptimized, the Spot Fleet terminates the instances in the Spot Instance pools that have the least available Spot Instance capacity. If the allocation strategy is diversified, the Spot Fleet terminates instances across the Spot Instance pools. Alternatively, you can request that the Spot Fleet keep the fleet at its current size, but not replace any Spot Instances that are interrupted or that you terminate manually.

If you are finished with your Spot Fleet for now, but will use it again later, you can set the target capacity to 0.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifySpotFleetRequestResponse' - parameters: - - name: ExcessCapacityTerminationPolicy - in: query - required: false - description: Indicates whether running Spot Instances should be terminated if the target capacity of the Spot Fleet request is decreased below the current size of the Spot Fleet. - schema: - type: string - enum: - - noTermination - - default - - name: LaunchTemplateConfig - in: query - required: false - description: 'The launch template and overrides. You can only use this parameter if you specified a launch template (LaunchTemplateConfigs) in your Spot Fleet request. If you specified LaunchSpecifications in your Spot Fleet request, then omit this parameter.' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/LaunchTemplateConfig' - - xml: - name: item - - name: SpotFleetRequestId - in: query - required: true - description: The ID of the Spot Fleet request. - schema: - type: string - - name: TargetCapacity - in: query - required: false - description: The size of the fleet. - schema: - type: integer - - name: OnDemandTargetCapacity - in: query - required: false - description: The number of On-Demand Instances in the fleet. - schema: - type: integer - - name: Context - in: query - required: false - description: Reserved. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ModifySpotFleetRequest - operationId: POST_ModifySpotFleetRequest - description: '

Modifies the specified Spot Fleet request.

You can only modify a Spot Fleet request of type maintain.

While the Spot Fleet request is being modified, it is in the modifying state.

To scale up your Spot Fleet, increase its target capacity. The Spot Fleet launches the additional Spot Instances according to the allocation strategy for the Spot Fleet request. If the allocation strategy is lowestPrice, the Spot Fleet launches instances using the Spot Instance pool with the lowest price. If the allocation strategy is diversified, the Spot Fleet distributes the instances across the Spot Instance pools. If the allocation strategy is capacityOptimized, Spot Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching.

To scale down your Spot Fleet, decrease its target capacity. First, the Spot Fleet cancels any open requests that exceed the new target capacity. You can request that the Spot Fleet terminate Spot Instances until the size of the fleet no longer exceeds the new target capacity. If the allocation strategy is lowestPrice, the Spot Fleet terminates the instances with the highest price per unit. If the allocation strategy is capacityOptimized, the Spot Fleet terminates the instances in the Spot Instance pools that have the least available Spot Instance capacity. If the allocation strategy is diversified, the Spot Fleet terminates instances across the Spot Instance pools. Alternatively, you can request that the Spot Fleet keep the fleet at its current size, but not replace any Spot Instances that are interrupted or that you terminate manually.

If you are finished with your Spot Fleet for now, but will use it again later, you can set the target capacity to 0.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifySpotFleetRequestResponse' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifySpotFleetRequestRequest' - parameters: [] - /?Action=ModifySubnetAttribute&Version=2016-11-15: - get: - x-aws-operation-name: ModifySubnetAttribute - operationId: GET_ModifySubnetAttribute - description: '

Modifies a subnet attribute. You can only modify one attribute at a time.

Use this action to modify subnets on Amazon Web Services Outposts.

  • To modify a subnet on an Outpost rack, set both MapCustomerOwnedIpOnLaunch and CustomerOwnedIpv4Pool. These two parameters act as a single attribute.

  • To modify a subnet on an Outpost server, set either EnableLniAtDeviceIndex or DisableLniAtDeviceIndex.

For more information about Amazon Web Services Outposts, see the following:

' - responses: - '200': - description: Success - parameters: - - name: AssignIpv6AddressOnCreation - in: query - required: false - description: '

Specify true to indicate that network interfaces created in the specified subnet should be assigned an IPv6 address. This includes a network interface that''s created when launching an instance into the subnet (the instance therefore receives an IPv6 address).

If you enable the IPv6 addressing feature for your subnet, your network interface or instance only receives an IPv6 address if it''s created using version 2016-11-15 or later of the Amazon EC2 API.

' - schema: - type: object - properties: - value: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: The attribute value. The valid values are true or false. - description: Describes a value for a resource attribute that is a Boolean value. - - name: MapPublicIpOnLaunch - in: query - required: false - description: Specify true to indicate that network interfaces attached to instances created in the specified subnet should be assigned a public IPv4 address. - schema: - type: object - properties: - value: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: The attribute value. The valid values are true or false. - description: Describes a value for a resource attribute that is a Boolean value. - - name: SubnetId - in: query - required: true - description: The ID of the subnet. - schema: - type: string - - name: MapCustomerOwnedIpOnLaunch - in: query - required: false - description: '

Specify true to indicate that network interfaces attached to instances created in the specified subnet should be assigned a customer-owned IPv4 address.

When this value is true, you must specify the customer-owned IP pool using CustomerOwnedIpv4Pool.

' - schema: - type: object - properties: - value: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: The attribute value. The valid values are true or false. - description: Describes a value for a resource attribute that is a Boolean value. - - name: CustomerOwnedIpv4Pool - in: query - required: false - description:

The customer-owned IPv4 address pool associated with the subnet.

You must set this value when you specify true for MapCustomerOwnedIpOnLaunch.

- schema: - type: string - - name: EnableDns64 - in: query - required: false - description: Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations. - schema: - type: object - properties: - value: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: The attribute value. The valid values are true or false. - description: Describes a value for a resource attribute that is a Boolean value. - - name: PrivateDnsHostnameTypeOnLaunch - in: query - required: false - description: 'The type of hostname to assign to instances in the subnet at launch. For IPv4-only and dual-stack (IPv4 and IPv6) subnets, an instance DNS name can be based on the instance IPv4 address (ip-name) or the instance ID (resource-name). For IPv6 only subnets, an instance DNS name must be based on the instance ID (resource-name).' - schema: - type: string - enum: - - ip-name - - resource-name - - name: EnableResourceNameDnsARecordOnLaunch - in: query - required: false - description: Indicates whether to respond to DNS queries for instance hostnames with DNS A records. - schema: - type: object - properties: - value: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: The attribute value. The valid values are true or false. - description: Describes a value for a resource attribute that is a Boolean value. - - name: EnableResourceNameDnsAAAARecordOnLaunch - in: query - required: false - description: Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records. - schema: - type: object - properties: - value: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: The attribute value. The valid values are true or false. - description: Describes a value for a resource attribute that is a Boolean value. - - name: EnableLniAtDeviceIndex - in: query - required: false - description: ' Indicates the device position for local network interfaces in this subnet. For example, 1 indicates local network interfaces in this subnet are the secondary network interface (eth1). A local network interface cannot be the primary network interface (eth0). ' - schema: - type: integer - - name: DisableLniAtDeviceIndex - in: query - required: false - description: ' Specify true to indicate that local network interfaces at the current position should be disabled. ' - schema: - type: object - properties: - value: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: The attribute value. The valid values are true or false. - description: Describes a value for a resource attribute that is a Boolean value. - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ModifySubnetAttribute - operationId: POST_ModifySubnetAttribute - description: '

Modifies a subnet attribute. You can only modify one attribute at a time.

Use this action to modify subnets on Amazon Web Services Outposts.

  • To modify a subnet on an Outpost rack, set both MapCustomerOwnedIpOnLaunch and CustomerOwnedIpv4Pool. These two parameters act as a single attribute.

  • To modify a subnet on an Outpost server, set either EnableLniAtDeviceIndex or DisableLniAtDeviceIndex.

For more information about Amazon Web Services Outposts, see the following:

' - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifySubnetAttributeRequest' - parameters: [] - /?Action=ModifyTrafficMirrorFilterNetworkServices&Version=2016-11-15: - get: - x-aws-operation-name: ModifyTrafficMirrorFilterNetworkServices - operationId: GET_ModifyTrafficMirrorFilterNetworkServices - description: '

Allows or restricts mirroring network services.

By default, Amazon DNS network services are not eligible for Traffic Mirror. Use AddNetworkServices to add network services to a Traffic Mirror filter. When a network service is added to the Traffic Mirror filter, all traffic related to that network service will be mirrored. When you no longer want to mirror network services, use RemoveNetworkServices to remove the network services from the Traffic Mirror filter.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyTrafficMirrorFilterNetworkServicesResult' - parameters: - - name: TrafficMirrorFilterId - in: query - required: true - description: The ID of the Traffic Mirror filter. - schema: - type: string - - name: AddNetworkService - in: query - required: false - description: 'The network service, for example Amazon DNS, that you want to mirror.' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TrafficMirrorNetworkService' - - xml: - name: item - - name: RemoveNetworkService - in: query - required: false - description: 'The network service, for example Amazon DNS, that you no longer want to mirror.' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TrafficMirrorNetworkService' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ModifyTrafficMirrorFilterNetworkServices - operationId: POST_ModifyTrafficMirrorFilterNetworkServices - description: '

Allows or restricts mirroring network services.

By default, Amazon DNS network services are not eligible for Traffic Mirror. Use AddNetworkServices to add network services to a Traffic Mirror filter. When a network service is added to the Traffic Mirror filter, all traffic related to that network service will be mirrored. When you no longer want to mirror network services, use RemoveNetworkServices to remove the network services from the Traffic Mirror filter.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyTrafficMirrorFilterNetworkServicesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyTrafficMirrorFilterNetworkServicesRequest' - parameters: [] - /?Action=ModifyTrafficMirrorFilterRule&Version=2016-11-15: - get: - x-aws-operation-name: ModifyTrafficMirrorFilterRule - operationId: GET_ModifyTrafficMirrorFilterRule - description:

Modifies the specified Traffic Mirror rule.

DestinationCidrBlock and SourceCidrBlock must both be an IPv4 range or an IPv6 range.

- responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyTrafficMirrorFilterRuleResult' - parameters: - - name: TrafficMirrorFilterRuleId - in: query - required: true - description: The ID of the Traffic Mirror rule. - schema: - type: string - - name: TrafficDirection - in: query - required: false - description: The type of traffic to assign to the rule. - schema: - type: string - enum: - - ingress - - egress - - name: RuleNumber - in: query - required: false - description: The number of the Traffic Mirror rule. This number must be unique for each Traffic Mirror rule in a given direction. The rules are processed in ascending order by rule number. - schema: - type: integer - - name: RuleAction - in: query - required: false - description: The action to assign to the rule. - schema: - type: string - enum: - - accept - - reject - - name: DestinationPortRange - in: query - required: false - description: The destination ports that are associated with the Traffic Mirror rule. - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The last port in the Traffic Mirror port range. This applies to the TCP and UDP protocols. - description: Information about the Traffic Mirror filter rule port range. - - name: SourcePortRange - in: query - required: false - description: The port range to assign to the Traffic Mirror rule. - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The last port in the Traffic Mirror port range. This applies to the TCP and UDP protocols. - description: Information about the Traffic Mirror filter rule port range. - - name: Protocol - in: query - required: false - description: 'The protocol, for example TCP, to assign to the Traffic Mirror rule.' - schema: - type: integer - - name: DestinationCidrBlock - in: query - required: false - description: The destination CIDR block to assign to the Traffic Mirror rule. - schema: - type: string - - name: SourceCidrBlock - in: query - required: false - description: The source CIDR block to assign to the Traffic Mirror rule. - schema: - type: string - - name: Description - in: query - required: false - description: The description to assign to the Traffic Mirror rule. - schema: - type: string - - name: RemoveField - in: query - required: false - description: '

The properties that you want to remove from the Traffic Mirror filter rule.

When you remove a property from a Traffic Mirror filter rule, the property is set to the default.

' - schema: - type: array - items: - $ref: '#/components/schemas/TrafficMirrorFilterRuleField' - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ModifyTrafficMirrorFilterRule - operationId: POST_ModifyTrafficMirrorFilterRule - description:

Modifies the specified Traffic Mirror rule.

DestinationCidrBlock and SourceCidrBlock must both be an IPv4 range or an IPv6 range.

- responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyTrafficMirrorFilterRuleResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyTrafficMirrorFilterRuleRequest' - parameters: [] - /?Action=ModifyTrafficMirrorSession&Version=2016-11-15: - get: - x-aws-operation-name: ModifyTrafficMirrorSession - operationId: GET_ModifyTrafficMirrorSession - description: Modifies a Traffic Mirror session. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyTrafficMirrorSessionResult' - parameters: - - name: TrafficMirrorSessionId - in: query - required: true - description: The ID of the Traffic Mirror session. - schema: - type: string - - name: TrafficMirrorTargetId - in: query - required: false - description: 'The Traffic Mirror target. The target must be in the same VPC as the source, or have a VPC peering connection with the source.' - schema: - type: string - - name: TrafficMirrorFilterId - in: query - required: false - description: The ID of the Traffic Mirror filter. - schema: - type: string - - name: PacketLength - in: query - required: false - description: 'The number of bytes in each packet to mirror. These are bytes after the VXLAN header. To mirror a subset, set this to the length (in bytes) to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target. Do not specify this parameter when you want to mirror the entire packet.' - schema: - type: integer - - name: SessionNumber - in: query - required: false - description:

The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. The first session with a matching filter is the one that mirrors the packets.

Valid values are 1-32766.

- schema: - type: integer - - name: VirtualNetworkId - in: query - required: false - description: The virtual network ID of the Traffic Mirror session. - schema: - type: integer - - name: Description - in: query - required: false - description: The description to assign to the Traffic Mirror session. - schema: - type: string - - name: RemoveField - in: query - required: false - description: '

The properties that you want to remove from the Traffic Mirror session.

When you remove a property from a Traffic Mirror session, the property is set to the default.

' - schema: - type: array - items: - $ref: '#/components/schemas/TrafficMirrorSessionField' - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ModifyTrafficMirrorSession - operationId: POST_ModifyTrafficMirrorSession - description: Modifies a Traffic Mirror session. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyTrafficMirrorSessionResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyTrafficMirrorSessionRequest' - parameters: [] - /?Action=ModifyTransitGateway&Version=2016-11-15: - get: - x-aws-operation-name: ModifyTransitGateway - operationId: GET_ModifyTransitGateway - description: 'Modifies the specified transit gateway. When you modify a transit gateway, the modified options are applied to new transit gateway attachments only. Your existing transit gateway attachments are not modified.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyTransitGatewayResult' - parameters: - - name: TransitGatewayId - in: query - required: true - description: The ID of the transit gateway. - schema: - type: string - - name: Description - in: query - required: false - description: The description for the transit gateway. - schema: - type: string - - name: Options - in: query - required: false - description: The options to modify. - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/TransitGatewayRouteTableId' - - description: The ID of the default propagation route table. - description: The transit gateway options. - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ModifyTransitGateway - operationId: POST_ModifyTransitGateway - description: 'Modifies the specified transit gateway. When you modify a transit gateway, the modified options are applied to new transit gateway attachments only. Your existing transit gateway attachments are not modified.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyTransitGatewayResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyTransitGatewayRequest' - parameters: [] - /?Action=ModifyTransitGatewayPrefixListReference&Version=2016-11-15: - get: - x-aws-operation-name: ModifyTransitGatewayPrefixListReference - operationId: GET_ModifyTransitGatewayPrefixListReference - description: Modifies a reference (route) to a prefix list in a specified transit gateway route table. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyTransitGatewayPrefixListReferenceResult' - parameters: - - name: TransitGatewayRouteTableId - in: query - required: true - description: The ID of the transit gateway route table. - schema: - type: string - - name: PrefixListId - in: query - required: true - description: The ID of the prefix list. - schema: - type: string - - name: TransitGatewayAttachmentId - in: query - required: false - description: The ID of the attachment to which traffic is routed. - schema: - type: string - - name: Blackhole - in: query - required: false - description: Indicates whether to drop traffic that matches this route. - schema: - type: boolean - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ModifyTransitGatewayPrefixListReference - operationId: POST_ModifyTransitGatewayPrefixListReference - description: Modifies a reference (route) to a prefix list in a specified transit gateway route table. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyTransitGatewayPrefixListReferenceResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyTransitGatewayPrefixListReferenceRequest' - parameters: [] - /?Action=ModifyTransitGatewayVpcAttachment&Version=2016-11-15: - get: - x-aws-operation-name: ModifyTransitGatewayVpcAttachment - operationId: GET_ModifyTransitGatewayVpcAttachment - description: Modifies the specified VPC attachment. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyTransitGatewayVpcAttachmentResult' - parameters: - - name: TransitGatewayAttachmentId - in: query - required: true - description: The ID of the attachment. - schema: - type: string - - name: AddSubnetIds - in: query - required: false - description: The IDs of one or more subnets to add. You can specify at most one subnet per Availability Zone. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/SubnetId' - - xml: - name: item - - name: RemoveSubnetIds - in: query - required: false - description: The IDs of one or more subnets to remove. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/SubnetId' - - xml: - name: item - - name: Options - in: query - required: false - description: The new VPC attachment options. - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/ApplianceModeSupportValue' - - description: 'Enable or disable support for appliance mode. If enabled, a traffic flow between a source and destination uses the same Availability Zone for the VPC attachment for the lifetime of that flow. The default is disable.' - description: Describes the options for a VPC attachment. - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ModifyTransitGatewayVpcAttachment - operationId: POST_ModifyTransitGatewayVpcAttachment - description: Modifies the specified VPC attachment. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyTransitGatewayVpcAttachmentResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyTransitGatewayVpcAttachmentRequest' - parameters: [] - /?Action=ModifyVolume&Version=2016-11-15: - get: - x-aws-operation-name: ModifyVolume - operationId: GET_ModifyVolume - description: '

You can modify several parameters of an existing EBS volume, including volume size, volume type, and IOPS capacity. If your EBS volume is attached to a current-generation EC2 instance type, you might be able to apply these changes without stopping the instance or detaching the volume from it. For more information about modifying EBS volumes, see Amazon EBS Elastic Volumes (Linux instances) or Amazon EBS Elastic Volumes (Windows instances).

When you complete a resize operation on your volume, you need to extend the volume''s file-system size to take advantage of the new storage capacity. For more information, see Extend a Linux file system or Extend a Windows file system.

You can use CloudWatch Events to check the status of a modification to an EBS volume. For information about CloudWatch Events, see the Amazon CloudWatch Events User Guide. You can also track the status of a modification using DescribeVolumesModifications. For information about tracking status changes using either method, see Monitor the progress of volume modifications.

With previous-generation instance types, resizing an EBS volume might require detaching and reattaching the volume or stopping and restarting the instance.

After modifying a volume, you must wait at least six hours and ensure that the volume is in the in-use or available state before you can modify the same volume. This is sometimes referred to as a cooldown period.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyVolumeResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: VolumeId - in: query - required: true - description: The ID of the volume. - schema: - type: string - - name: Size - in: query - required: false - description: '

The target size of the volume, in GiB. The target volume size must be greater than or equal to the existing size of the volume.

The following are the supported volumes sizes for each volume type:

  • gp2 and gp3: 1-16,384

  • io1 and io2: 4-16,384

  • st1 and sc1: 125-16,384

  • standard: 1-1,024

Default: The existing size is retained.

' - schema: - type: integer - - name: VolumeType - in: query - required: false - description: '

The target EBS volume type of the volume. For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide.

Default: The existing type is retained.

' - schema: - type: string - enum: - - standard - - io1 - - io2 - - gp2 - - sc1 - - st1 - - gp3 - - name: Iops - in: query - required: false - description: '

The target IOPS rate of the volume. This parameter is valid only for gp3, io1, and io2 volumes.

The following are the supported values for each volume type:

  • gp3: 3,000-16,000 IOPS

  • io1: 100-64,000 IOPS

  • io2: 100-64,000 IOPS

Default: The existing value is retained if you keep the same volume type. If you change the volume type to io1, io2, or gp3, the default is 3,000.

' - schema: - type: integer - - name: Throughput - in: query - required: false - description: '

The target throughput of the volume, in MiB/s. This parameter is valid only for gp3 volumes. The maximum value is 1,000.

Default: The existing value is retained if the source and target volume type is gp3. Otherwise, the default value is 125.

Valid Range: Minimum value of 125. Maximum value of 1000.

' - schema: - type: integer - - name: MultiAttachEnabled - in: query - required: false - description: 'Specifies whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the volume to up to 16 Nitro-based instances in the same Availability Zone. This parameter is supported with io1 and io2 volumes only. For more information, see Amazon EBS Multi-Attach in the Amazon Elastic Compute Cloud User Guide.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ModifyVolume - operationId: POST_ModifyVolume - description: '

You can modify several parameters of an existing EBS volume, including volume size, volume type, and IOPS capacity. If your EBS volume is attached to a current-generation EC2 instance type, you might be able to apply these changes without stopping the instance or detaching the volume from it. For more information about modifying EBS volumes, see Amazon EBS Elastic Volumes (Linux instances) or Amazon EBS Elastic Volumes (Windows instances).

When you complete a resize operation on your volume, you need to extend the volume''s file-system size to take advantage of the new storage capacity. For more information, see Extend a Linux file system or Extend a Windows file system.

You can use CloudWatch Events to check the status of a modification to an EBS volume. For information about CloudWatch Events, see the Amazon CloudWatch Events User Guide. You can also track the status of a modification using DescribeVolumesModifications. For information about tracking status changes using either method, see Monitor the progress of volume modifications.

With previous-generation instance types, resizing an EBS volume might require detaching and reattaching the volume or stopping and restarting the instance.

After modifying a volume, you must wait at least six hours and ensure that the volume is in the in-use or available state before you can modify the same volume. This is sometimes referred to as a cooldown period.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyVolumeResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyVolumeRequest' - parameters: [] - /?Action=ModifyVolumeAttribute&Version=2016-11-15: - get: - x-aws-operation-name: ModifyVolumeAttribute - operationId: GET_ModifyVolumeAttribute - description: '

Modifies a volume attribute.

By default, all I/O operations for the volume are suspended when the data on the volume is determined to be potentially inconsistent, to prevent undetectable, latent data corruption. The I/O access to the volume can be resumed by first enabling I/O access and then checking the data consistency on your volume.

You can change the default behavior to resume I/O operations. We recommend that you change this only for boot volumes or for volumes that are stateless or disposable.

' - responses: - '200': - description: Success - parameters: - - name: AutoEnableIO - in: query - required: false - description: Indicates whether the volume should be auto-enabled for I/O operations. - schema: - type: object - properties: - value: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: The attribute value. The valid values are true or false. - description: Describes a value for a resource attribute that is a Boolean value. - - name: VolumeId - in: query - required: true - description: The ID of the volume. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ModifyVolumeAttribute - operationId: POST_ModifyVolumeAttribute - description: '

Modifies a volume attribute.

By default, all I/O operations for the volume are suspended when the data on the volume is determined to be potentially inconsistent, to prevent undetectable, latent data corruption. The I/O access to the volume can be resumed by first enabling I/O access and then checking the data consistency on your volume.

You can change the default behavior to resume I/O operations. We recommend that you change this only for boot volumes or for volumes that are stateless or disposable.

' - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyVolumeAttributeRequest' - parameters: [] - /?Action=ModifyVpcAttribute&Version=2016-11-15: - get: - x-aws-operation-name: ModifyVpcAttribute - operationId: GET_ModifyVpcAttribute - description: Modifies the specified attribute of the specified VPC. - responses: - '200': - description: Success - parameters: - - name: EnableDnsHostnames - in: query - required: false - description: '

Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not.

You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute. You can only enable DNS hostnames if you''ve enabled DNS support.

' - schema: - type: object - properties: - value: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: The attribute value. The valid values are true or false. - description: Describes a value for a resource attribute that is a Boolean value. - - name: EnableDnsSupport - in: query - required: false - description: '

Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range "plus two" succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled.

You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute.

' - schema: - type: object - properties: - value: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: The attribute value. The valid values are true or false. - description: Describes a value for a resource attribute that is a Boolean value. - - name: VpcId - in: query - required: true - description: The ID of the VPC. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ModifyVpcAttribute - operationId: POST_ModifyVpcAttribute - description: Modifies the specified attribute of the specified VPC. - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyVpcAttributeRequest' - parameters: [] - /?Action=ModifyVpcEndpoint&Version=2016-11-15: - get: - x-aws-operation-name: ModifyVpcEndpoint - operationId: GET_ModifyVpcEndpoint - description: 'Modifies attributes of a specified VPC endpoint. The attributes that you can modify depend on the type of VPC endpoint (interface, gateway, or Gateway Load Balancer). For more information, see the Amazon Web Services PrivateLink Guide.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyVpcEndpointResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: VpcEndpointId - in: query - required: true - description: The ID of the endpoint. - schema: - type: string - - name: ResetPolicy - in: query - required: false - description: (Gateway endpoint) Specify true to reset the policy document to the default policy. The default policy allows full access to the service. - schema: - type: boolean - - name: PolicyDocument - in: query - required: false - description: (Interface and gateway endpoints) A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format. - schema: - type: string - - name: AddRouteTableId - in: query - required: false - description: (Gateway endpoint) One or more route tables IDs to associate with the endpoint. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/RouteTableId' - - xml: - name: item - - name: RemoveRouteTableId - in: query - required: false - description: (Gateway endpoint) One or more route table IDs to disassociate from the endpoint. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/RouteTableId' - - xml: - name: item - - name: AddSubnetId - in: query - required: false - description: '(Interface and Gateway Load Balancer endpoints) One or more subnet IDs in which to serve the endpoint. For a Gateway Load Balancer endpoint, you can specify only one subnet.' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/SubnetId' - - xml: - name: item - - name: RemoveSubnetId - in: query - required: false - description: (Interface endpoint) One or more subnets IDs in which to remove the endpoint. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/SubnetId' - - xml: - name: item - - name: AddSecurityGroupId - in: query - required: false - description: (Interface endpoint) One or more security group IDs to associate with the network interface. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/SecurityGroupId' - - xml: - name: item - - name: RemoveSecurityGroupId - in: query - required: false - description: (Interface endpoint) One or more security group IDs to disassociate from the network interface. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/SecurityGroupId' - - xml: - name: item - - name: IpAddressType - in: query - required: false - description: The IP address type for the endpoint. - schema: - type: string - enum: - - ipv4 - - dualstack - - ipv6 - - name: DnsOptions - in: query - required: false - description: The DNS options for the endpoint. - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/DnsRecordIpType' - - description: The DNS records created for the endpoint. - description: Describes the DNS options for an endpoint. - - name: PrivateDnsEnabled - in: query - required: false - description: (Interface endpoint) Indicates whether a private hosted zone is associated with the VPC. - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ModifyVpcEndpoint - operationId: POST_ModifyVpcEndpoint - description: 'Modifies attributes of a specified VPC endpoint. The attributes that you can modify depend on the type of VPC endpoint (interface, gateway, or Gateway Load Balancer). For more information, see the Amazon Web Services PrivateLink Guide.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyVpcEndpointResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyVpcEndpointRequest' - parameters: [] - /?Action=ModifyVpcEndpointConnectionNotification&Version=2016-11-15: - get: - x-aws-operation-name: ModifyVpcEndpointConnectionNotification - operationId: GET_ModifyVpcEndpointConnectionNotification - description: 'Modifies a connection notification for VPC endpoint or VPC endpoint service. You can change the SNS topic for the notification, or the events for which to be notified. ' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyVpcEndpointConnectionNotificationResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: ConnectionNotificationId - in: query - required: true - description: The ID of the notification. - schema: - type: string - - name: ConnectionNotificationArn - in: query - required: false - description: The ARN for the SNS topic for the notification. - schema: - type: string - - name: ConnectionEvents - in: query - required: false - description: 'One or more events for the endpoint. Valid values are Accept, Connect, Delete, and Reject.' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ModifyVpcEndpointConnectionNotification - operationId: POST_ModifyVpcEndpointConnectionNotification - description: 'Modifies a connection notification for VPC endpoint or VPC endpoint service. You can change the SNS topic for the notification, or the events for which to be notified. ' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyVpcEndpointConnectionNotificationResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyVpcEndpointConnectionNotificationRequest' - parameters: [] - /?Action=ModifyVpcEndpointServiceConfiguration&Version=2016-11-15: - get: - x-aws-operation-name: ModifyVpcEndpointServiceConfiguration - operationId: GET_ModifyVpcEndpointServiceConfiguration - description: '

Modifies the attributes of your VPC endpoint service configuration. You can change the Network Load Balancers or Gateway Load Balancers for your service, and you can specify whether acceptance is required for requests to connect to your endpoint service through an interface VPC endpoint.

If you set or modify the private DNS name, you must prove that you own the private DNS domain name.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyVpcEndpointServiceConfigurationResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: ServiceId - in: query - required: true - description: The ID of the service. - schema: - type: string - - name: PrivateDnsName - in: query - required: false - description: (Interface endpoint configuration) The private DNS name to assign to the endpoint service. - schema: - type: string - - name: RemovePrivateDnsName - in: query - required: false - description: (Interface endpoint configuration) Removes the private DNS name of the endpoint service. - schema: - type: boolean - - name: AcceptanceRequired - in: query - required: false - description: Indicates whether requests to create an endpoint to your service must be accepted. - schema: - type: boolean - - name: AddNetworkLoadBalancerArn - in: query - required: false - description: The Amazon Resource Names (ARNs) of Network Load Balancers to add to your service configuration. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - - name: RemoveNetworkLoadBalancerArn - in: query - required: false - description: The Amazon Resource Names (ARNs) of Network Load Balancers to remove from your service configuration. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - - name: AddGatewayLoadBalancerArn - in: query - required: false - description: The Amazon Resource Names (ARNs) of Gateway Load Balancers to add to your service configuration. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - - name: RemoveGatewayLoadBalancerArn - in: query - required: false - description: The Amazon Resource Names (ARNs) of Gateway Load Balancers to remove from your service configuration. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - - name: AddSupportedIpAddressType - in: query - required: false - description: The IP address types to add to your service configuration. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - - name: RemoveSupportedIpAddressType - in: query - required: false - description: The IP address types to remove from your service configuration. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ModifyVpcEndpointServiceConfiguration - operationId: POST_ModifyVpcEndpointServiceConfiguration - description: '

Modifies the attributes of your VPC endpoint service configuration. You can change the Network Load Balancers or Gateway Load Balancers for your service, and you can specify whether acceptance is required for requests to connect to your endpoint service through an interface VPC endpoint.

If you set or modify the private DNS name, you must prove that you own the private DNS domain name.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyVpcEndpointServiceConfigurationResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyVpcEndpointServiceConfigurationRequest' - parameters: [] - /?Action=ModifyVpcEndpointServicePayerResponsibility&Version=2016-11-15: - get: - x-aws-operation-name: ModifyVpcEndpointServicePayerResponsibility - operationId: GET_ModifyVpcEndpointServicePayerResponsibility - description: Modifies the payer responsibility for your VPC endpoint service. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyVpcEndpointServicePayerResponsibilityResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: ServiceId - in: query - required: true - description: The ID of the service. - schema: - type: string - - name: PayerResponsibility - in: query - required: true - description: 'The entity that is responsible for the endpoint costs. The default is the endpoint owner. If you set the payer responsibility to the service owner, you cannot set it back to the endpoint owner.' - schema: - type: string - enum: - - ServiceOwner - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ModifyVpcEndpointServicePayerResponsibility - operationId: POST_ModifyVpcEndpointServicePayerResponsibility - description: Modifies the payer responsibility for your VPC endpoint service. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyVpcEndpointServicePayerResponsibilityResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyVpcEndpointServicePayerResponsibilityRequest' - parameters: [] - /?Action=ModifyVpcEndpointServicePermissions&Version=2016-11-15: - get: - x-aws-operation-name: ModifyVpcEndpointServicePermissions - operationId: GET_ModifyVpcEndpointServicePermissions - description: '

Modifies the permissions for your VPC endpoint service. You can add or remove permissions for service consumers (IAM users, IAM roles, and Amazon Web Services accounts) to connect to your endpoint service.

If you grant permissions to all principals, the service is public. Any users who know the name of a public service can send a request to attach an endpoint. If the service does not require manual approval, attachments are automatically approved.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyVpcEndpointServicePermissionsResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: ServiceId - in: query - required: true - description: The ID of the service. - schema: - type: string - - name: AddAllowedPrincipals - in: query - required: false - description: 'The Amazon Resource Names (ARN) of one or more principals. Permissions are granted to the principals in this list. To grant permissions to all principals, specify an asterisk (*).' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - - name: RemoveAllowedPrincipals - in: query - required: false - description: The Amazon Resource Names (ARN) of one or more principals. Permissions are revoked for principals in this list. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ModifyVpcEndpointServicePermissions - operationId: POST_ModifyVpcEndpointServicePermissions - description: '

Modifies the permissions for your VPC endpoint service. You can add or remove permissions for service consumers (IAM users, IAM roles, and Amazon Web Services accounts) to connect to your endpoint service.

If you grant permissions to all principals, the service is public. Any users who know the name of a public service can send a request to attach an endpoint. If the service does not require manual approval, attachments are automatically approved.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyVpcEndpointServicePermissionsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyVpcEndpointServicePermissionsRequest' - parameters: [] - /?Action=ModifyVpcPeeringConnectionOptions&Version=2016-11-15: - get: - x-aws-operation-name: ModifyVpcPeeringConnectionOptions - operationId: GET_ModifyVpcPeeringConnectionOptions - description: '

Modifies the VPC peering connection options on one side of a VPC peering connection. You can do the following:

  • Enable/disable communication over the peering connection between an EC2-Classic instance that''s linked to your VPC (using ClassicLink) and instances in the peer VPC.

  • Enable/disable communication over the peering connection between instances in your VPC and an EC2-Classic instance that''s linked to the peer VPC.

  • Enable/disable the ability to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC.

If the peered VPCs are in the same Amazon Web Services account, you can enable DNS resolution for queries from the local VPC. This ensures that queries from the local VPC resolve to private IP addresses in the peer VPC. This option is not available if the peered VPCs are in different different Amazon Web Services accounts or different Regions. For peered VPCs in different Amazon Web Services accounts, each Amazon Web Services account owner must initiate a separate request to modify the peering connection options. For inter-region peering connections, you must use the Region for the requester VPC to modify the requester VPC peering options and the Region for the accepter VPC to modify the accepter VPC peering options. To verify which VPCs are the accepter and the requester for a VPC peering connection, use the DescribeVpcPeeringConnections command.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyVpcPeeringConnectionOptionsResult' - parameters: - - name: AccepterPeeringConnectionOptions - in: query - required: false - description: The VPC peering connection options for the accepter VPC. - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'If true, enables outbound communication from instances in a local VPC to an EC2-Classic instance that''s linked to a peer VPC using ClassicLink.' - description: The VPC peering connection options. - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: RequesterPeeringConnectionOptions - in: query - required: false - description: The VPC peering connection options for the requester VPC. - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'If true, enables outbound communication from instances in a local VPC to an EC2-Classic instance that''s linked to a peer VPC using ClassicLink.' - description: The VPC peering connection options. - - name: VpcPeeringConnectionId - in: query - required: true - description: The ID of the VPC peering connection. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ModifyVpcPeeringConnectionOptions - operationId: POST_ModifyVpcPeeringConnectionOptions - description: '

Modifies the VPC peering connection options on one side of a VPC peering connection. You can do the following:

  • Enable/disable communication over the peering connection between an EC2-Classic instance that''s linked to your VPC (using ClassicLink) and instances in the peer VPC.

  • Enable/disable communication over the peering connection between instances in your VPC and an EC2-Classic instance that''s linked to the peer VPC.

  • Enable/disable the ability to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC.

If the peered VPCs are in the same Amazon Web Services account, you can enable DNS resolution for queries from the local VPC. This ensures that queries from the local VPC resolve to private IP addresses in the peer VPC. This option is not available if the peered VPCs are in different different Amazon Web Services accounts or different Regions. For peered VPCs in different Amazon Web Services accounts, each Amazon Web Services account owner must initiate a separate request to modify the peering connection options. For inter-region peering connections, you must use the Region for the requester VPC to modify the requester VPC peering options and the Region for the accepter VPC to modify the accepter VPC peering options. To verify which VPCs are the accepter and the requester for a VPC peering connection, use the DescribeVpcPeeringConnections command.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyVpcPeeringConnectionOptionsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyVpcPeeringConnectionOptionsRequest' - parameters: [] - /?Action=ModifyVpcTenancy&Version=2016-11-15: - get: - x-aws-operation-name: ModifyVpcTenancy - operationId: GET_ModifyVpcTenancy - description: '

Modifies the instance tenancy attribute of the specified VPC. You can change the instance tenancy attribute of a VPC to default only. You cannot change the instance tenancy attribute to dedicated.

After you modify the tenancy of the VPC, any new instances that you launch into the VPC have a tenancy of default, unless you specify otherwise during launch. The tenancy of any existing instances in the VPC is not affected.

For more information, see Dedicated Instances in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyVpcTenancyResult' - parameters: - - name: VpcId - in: query - required: true - description: The ID of the VPC. - schema: - type: string - - name: InstanceTenancy - in: query - required: true - description: 'The instance tenancy attribute for the VPC. ' - schema: - type: string - enum: - - default - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ModifyVpcTenancy - operationId: POST_ModifyVpcTenancy - description: '

Modifies the instance tenancy attribute of the specified VPC. You can change the instance tenancy attribute of a VPC to default only. You cannot change the instance tenancy attribute to dedicated.

After you modify the tenancy of the VPC, any new instances that you launch into the VPC have a tenancy of default, unless you specify otherwise during launch. The tenancy of any existing instances in the VPC is not affected.

For more information, see Dedicated Instances in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyVpcTenancyResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyVpcTenancyRequest' - parameters: [] - /?Action=ModifyVpnConnection&Version=2016-11-15: - get: - x-aws-operation-name: ModifyVpnConnection - operationId: GET_ModifyVpnConnection - description: '

Modifies the customer gateway or the target gateway of an Amazon Web Services Site-to-Site VPN connection. To modify the target gateway, the following migration options are available:

  • An existing virtual private gateway to a new virtual private gateway

  • An existing virtual private gateway to a transit gateway

  • An existing transit gateway to a new transit gateway

  • An existing transit gateway to a virtual private gateway

Before you perform the migration to the new gateway, you must configure the new gateway. Use CreateVpnGateway to create a virtual private gateway, or CreateTransitGateway to create a transit gateway.

This step is required when you migrate from a virtual private gateway with static routes to a transit gateway.

You must delete the static routes before you migrate to the new gateway.

Keep a copy of the static route before you delete it. You will need to add back these routes to the transit gateway after the VPN connection migration is complete.

After you migrate to the new gateway, you might need to modify your VPC route table. Use CreateRoute and DeleteRoute to make the changes described in Update VPC route tables in the Amazon Web Services Site-to-Site VPN User Guide.

When the new gateway is a transit gateway, modify the transit gateway route table to allow traffic between the VPC and the Amazon Web Services Site-to-Site VPN connection. Use CreateTransitGatewayRoute to add the routes.

If you deleted VPN static routes, you must add the static routes to the transit gateway route table.

After you perform this operation, the VPN endpoint''s IP addresses on the Amazon Web Services side and the tunnel options remain intact. Your Amazon Web Services Site-to-Site VPN connection will be temporarily unavailable for a brief period while we provision the new endpoints.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyVpnConnectionResult' - parameters: - - name: VpnConnectionId - in: query - required: true - description: The ID of the VPN connection. - schema: - type: string - - name: TransitGatewayId - in: query - required: false - description: The ID of the transit gateway. - schema: - type: string - - name: CustomerGatewayId - in: query - required: false - description: The ID of the customer gateway at your end of the VPN connection. - schema: - type: string - - name: VpnGatewayId - in: query - required: false - description: The ID of the virtual private gateway at the Amazon Web Services side of the VPN connection. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ModifyVpnConnection - operationId: POST_ModifyVpnConnection - description: '

Modifies the customer gateway or the target gateway of an Amazon Web Services Site-to-Site VPN connection. To modify the target gateway, the following migration options are available:

  • An existing virtual private gateway to a new virtual private gateway

  • An existing virtual private gateway to a transit gateway

  • An existing transit gateway to a new transit gateway

  • An existing transit gateway to a virtual private gateway

Before you perform the migration to the new gateway, you must configure the new gateway. Use CreateVpnGateway to create a virtual private gateway, or CreateTransitGateway to create a transit gateway.

This step is required when you migrate from a virtual private gateway with static routes to a transit gateway.

You must delete the static routes before you migrate to the new gateway.

Keep a copy of the static route before you delete it. You will need to add back these routes to the transit gateway after the VPN connection migration is complete.

After you migrate to the new gateway, you might need to modify your VPC route table. Use CreateRoute and DeleteRoute to make the changes described in Update VPC route tables in the Amazon Web Services Site-to-Site VPN User Guide.

When the new gateway is a transit gateway, modify the transit gateway route table to allow traffic between the VPC and the Amazon Web Services Site-to-Site VPN connection. Use CreateTransitGatewayRoute to add the routes.

If you deleted VPN static routes, you must add the static routes to the transit gateway route table.

After you perform this operation, the VPN endpoint''s IP addresses on the Amazon Web Services side and the tunnel options remain intact. Your Amazon Web Services Site-to-Site VPN connection will be temporarily unavailable for a brief period while we provision the new endpoints.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyVpnConnectionResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyVpnConnectionRequest' - parameters: [] - /?Action=ModifyVpnConnectionOptions&Version=2016-11-15: - get: - x-aws-operation-name: ModifyVpnConnectionOptions - operationId: GET_ModifyVpnConnectionOptions - description: '

Modifies the connection options for your Site-to-Site VPN connection.

When you modify the VPN connection options, the VPN endpoint IP addresses on the Amazon Web Services side do not change, and the tunnel options do not change. Your VPN connection will be temporarily unavailable for a brief period while the VPN connection is updated.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyVpnConnectionOptionsResult' - parameters: - - name: VpnConnectionId - in: query - required: true - description: 'The ID of the Site-to-Site VPN connection. ' - schema: - type: string - - name: LocalIpv4NetworkCidr - in: query - required: false - description: '

The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.

Default: 0.0.0.0/0

' - schema: - type: string - - name: RemoteIpv4NetworkCidr - in: query - required: false - description: '

The IPv4 CIDR on the Amazon Web Services side of the VPN connection.

Default: 0.0.0.0/0

' - schema: - type: string - - name: LocalIpv6NetworkCidr - in: query - required: false - description: '

The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.

Default: ::/0

' - schema: - type: string - - name: RemoteIpv6NetworkCidr - in: query - required: false - description: '

The IPv6 CIDR on the Amazon Web Services side of the VPN connection.

Default: ::/0

' - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ModifyVpnConnectionOptions - operationId: POST_ModifyVpnConnectionOptions - description: '

Modifies the connection options for your Site-to-Site VPN connection.

When you modify the VPN connection options, the VPN endpoint IP addresses on the Amazon Web Services side do not change, and the tunnel options do not change. Your VPN connection will be temporarily unavailable for a brief period while the VPN connection is updated.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyVpnConnectionOptionsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyVpnConnectionOptionsRequest' - parameters: [] - /?Action=ModifyVpnTunnelCertificate&Version=2016-11-15: - get: - x-aws-operation-name: ModifyVpnTunnelCertificate - operationId: GET_ModifyVpnTunnelCertificate - description: Modifies the VPN tunnel endpoint certificate. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyVpnTunnelCertificateResult' - parameters: - - name: VpnConnectionId - in: query - required: true - description: The ID of the Amazon Web Services Site-to-Site VPN connection. - schema: - type: string - - name: VpnTunnelOutsideIpAddress - in: query - required: true - description: The external IP address of the VPN tunnel. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ModifyVpnTunnelCertificate - operationId: POST_ModifyVpnTunnelCertificate - description: Modifies the VPN tunnel endpoint certificate. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyVpnTunnelCertificateResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyVpnTunnelCertificateRequest' - parameters: [] - /?Action=ModifyVpnTunnelOptions&Version=2016-11-15: - get: - x-aws-operation-name: ModifyVpnTunnelOptions - operationId: GET_ModifyVpnTunnelOptions - description: 'Modifies the options for a VPN tunnel in an Amazon Web Services Site-to-Site VPN connection. You can modify multiple options for a tunnel in a single request, but you can only modify one tunnel at a time. For more information, see Site-to-Site VPN tunnel options for your Site-to-Site VPN connection in the Amazon Web Services Site-to-Site VPN User Guide.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyVpnTunnelOptionsResult' - parameters: - - name: VpnConnectionId - in: query - required: true - description: The ID of the Amazon Web Services Site-to-Site VPN connection. - schema: - type: string - - name: VpnTunnelOutsideIpAddress - in: query - required: true - description: The external IP address of the VPN tunnel. - schema: - type: string - - name: TunnelOptions - in: query - required: true - description: The tunnel options to modify. - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: '

The action to take after DPD timeout occurs. Specify restart to restart the IKE initiation. Specify clear to end the IKE session.

Valid Values: clear | none | restart

Default: clear

' - Phase1EncryptionAlgorithm: - allOf: - - $ref: '#/components/schemas/Phase1EncryptionAlgorithmsRequestList' - - description: '

One or more encryption algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.

Valid values: AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16

' - Phase2EncryptionAlgorithm: - allOf: - - $ref: '#/components/schemas/Phase2EncryptionAlgorithmsRequestList' - - description: '

One or more encryption algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.

Valid values: AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16

' - Phase1IntegrityAlgorithm: - allOf: - - $ref: '#/components/schemas/Phase1IntegrityAlgorithmsRequestList' - - description: '

One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.

Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512

' - Phase2IntegrityAlgorithm: - allOf: - - $ref: '#/components/schemas/Phase2IntegrityAlgorithmsRequestList' - - description: '

One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.

Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512

' - Phase1DHGroupNumber: - allOf: - - $ref: '#/components/schemas/Phase1DHGroupNumbersRequestList' - - description: '

One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 1 IKE negotiations.

Valid values: 2 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24

' - Phase2DHGroupNumber: - allOf: - - $ref: '#/components/schemas/Phase2DHGroupNumbersRequestList' - - description: '

One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 2 IKE negotiations.

Valid values: 2 | 5 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24

' - IKEVersion: - allOf: - - $ref: '#/components/schemas/String' - - description: '

The action to take when the establishing the tunnel for the VPN connection. By default, your customer gateway device must initiate the IKE negotiation and bring up the tunnel. Specify start for Amazon Web Services to initiate the IKE negotiation.

Valid Values: add | start

Default: add

' - description: The Amazon Web Services Site-to-Site VPN tunnel options to modify. - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ModifyVpnTunnelOptions - operationId: POST_ModifyVpnTunnelOptions - description: 'Modifies the options for a VPN tunnel in an Amazon Web Services Site-to-Site VPN connection. You can modify multiple options for a tunnel in a single request, but you can only modify one tunnel at a time. For more information, see Site-to-Site VPN tunnel options for your Site-to-Site VPN connection in the Amazon Web Services Site-to-Site VPN User Guide.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyVpnTunnelOptionsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ModifyVpnTunnelOptionsRequest' - parameters: [] - /?Action=MonitorInstances&Version=2016-11-15: - get: - x-aws-operation-name: MonitorInstances - operationId: GET_MonitorInstances - description: '

Enables detailed monitoring for a running instance. Otherwise, basic monitoring is enabled. For more information, see Monitor your instances using CloudWatch in the Amazon EC2 User Guide.

To disable detailed monitoring, see UnmonitorInstances.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/MonitorInstancesResult' - parameters: - - name: InstanceId - in: query - required: true - description: The IDs of the instances. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/InstanceId' - - xml: - name: InstanceId - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: MonitorInstances - operationId: POST_MonitorInstances - description: '

Enables detailed monitoring for a running instance. Otherwise, basic monitoring is enabled. For more information, see Monitor your instances using CloudWatch in the Amazon EC2 User Guide.

To disable detailed monitoring, see UnmonitorInstances.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/MonitorInstancesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/MonitorInstancesRequest' - parameters: [] - /?Action=MoveAddressToVpc&Version=2016-11-15: - get: - x-aws-operation-name: MoveAddressToVpc - operationId: GET_MoveAddressToVpc - description: 'Moves an Elastic IP address from the EC2-Classic platform to the EC2-VPC platform. The Elastic IP address must be allocated to your account for more than 24 hours, and it must not be associated with an instance. After the Elastic IP address is moved, it is no longer available for use in the EC2-Classic platform, unless you move it back using the RestoreAddressToClassic request. You cannot move an Elastic IP address that was originally allocated for use in the EC2-VPC platform to the EC2-Classic platform. ' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/MoveAddressToVpcResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: PublicIp - in: query - required: true - description: The Elastic IP address. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: MoveAddressToVpc - operationId: POST_MoveAddressToVpc - description: 'Moves an Elastic IP address from the EC2-Classic platform to the EC2-VPC platform. The Elastic IP address must be allocated to your account for more than 24 hours, and it must not be associated with an instance. After the Elastic IP address is moved, it is no longer available for use in the EC2-Classic platform, unless you move it back using the RestoreAddressToClassic request. You cannot move an Elastic IP address that was originally allocated for use in the EC2-VPC platform to the EC2-Classic platform. ' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/MoveAddressToVpcResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/MoveAddressToVpcRequest' - parameters: [] - /?Action=MoveByoipCidrToIpam&Version=2016-11-15: - get: - x-aws-operation-name: MoveByoipCidrToIpam - operationId: GET_MoveByoipCidrToIpam - description: '

Move an BYOIP IPv4 CIDR to IPAM from a public IPv4 pool.

If you already have an IPv4 BYOIP CIDR with Amazon Web Services, you can move the CIDR to IPAM from a public IPv4 pool. You cannot move an IPv6 CIDR to IPAM. If you are bringing a new IP address to Amazon Web Services for the first time, complete the steps in Tutorial: BYOIP address CIDRs to IPAM.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/MoveByoipCidrToIpamResult' - parameters: - - name: DryRun - in: query - required: false - description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: Cidr - in: query - required: true - description: The BYOIP CIDR. - schema: - type: string - - name: IpamPoolId - in: query - required: true - description: The IPAM pool ID. - schema: - type: string - - name: IpamPoolOwner - in: query - required: true - description: The Amazon Web Services account ID of the owner of the IPAM pool. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: MoveByoipCidrToIpam - operationId: POST_MoveByoipCidrToIpam - description: '

Move an BYOIP IPv4 CIDR to IPAM from a public IPv4 pool.

If you already have an IPv4 BYOIP CIDR with Amazon Web Services, you can move the CIDR to IPAM from a public IPv4 pool. You cannot move an IPv6 CIDR to IPAM. If you are bringing a new IP address to Amazon Web Services for the first time, complete the steps in Tutorial: BYOIP address CIDRs to IPAM.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/MoveByoipCidrToIpamResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/MoveByoipCidrToIpamRequest' - parameters: [] - /?Action=ProvisionByoipCidr&Version=2016-11-15: - get: - x-aws-operation-name: ProvisionByoipCidr - operationId: GET_ProvisionByoipCidr - description: '

Provisions an IPv4 or IPv6 address range for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool. After the address range is provisioned, it is ready to be advertised using AdvertiseByoipCidr.

Amazon Web Services verifies that you own the address range and are authorized to advertise it. You must ensure that the address range is registered to you and that you created an RPKI ROA to authorize Amazon ASNs 16509 and 14618 to advertise the address range. For more information, see Bring your own IP addresses (BYOIP) in the Amazon Elastic Compute Cloud User Guide.

Provisioning an address range is an asynchronous operation, so the call returns immediately, but the address range is not ready to use until its status changes from pending-provision to provisioned. To monitor the status of an address range, use DescribeByoipCidrs. To allocate an Elastic IP address from your IPv4 address pool, use AllocateAddress with either the specific address from the address pool or the ID of the address pool.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ProvisionByoipCidrResult' - parameters: - - name: Cidr - in: query - required: true - description: 'The public IPv4 or IPv6 address range, in CIDR notation. The most specific IPv4 prefix that you can specify is /24. The most specific IPv6 prefix you can specify is /56. The address range cannot overlap with another address range that you''ve brought to this or another Region.' - schema: - type: string - - name: CidrAuthorizationContext - in: query - required: false - description: A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP. - schema: - type: object - required: - - Message - - Signature - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The signed authorization message for the prefix and account. - description: 'Provides authorization for Amazon to bring a specific IP address range to a specific Amazon Web Services account using bring your own IP addresses (BYOIP). For more information, see Configuring your BYOIP address range in the Amazon Elastic Compute Cloud User Guide.' - - name: PubliclyAdvertisable - in: query - required: false - description: '

(IPv6 only) Indicate whether the address range will be publicly advertised to the internet.

Default: true

' - schema: - type: boolean - - name: Description - in: query - required: false - description: A description for the address range and the address pool. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: PoolTagSpecification - in: query - required: false - description: The tags to apply to the address pool. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - - name: MultiRegion - in: query - required: false - description: Reserved. - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ProvisionByoipCidr - operationId: POST_ProvisionByoipCidr - description: '

Provisions an IPv4 or IPv6 address range for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool. After the address range is provisioned, it is ready to be advertised using AdvertiseByoipCidr.

Amazon Web Services verifies that you own the address range and are authorized to advertise it. You must ensure that the address range is registered to you and that you created an RPKI ROA to authorize Amazon ASNs 16509 and 14618 to advertise the address range. For more information, see Bring your own IP addresses (BYOIP) in the Amazon Elastic Compute Cloud User Guide.

Provisioning an address range is an asynchronous operation, so the call returns immediately, but the address range is not ready to use until its status changes from pending-provision to provisioned. To monitor the status of an address range, use DescribeByoipCidrs. To allocate an Elastic IP address from your IPv4 address pool, use AllocateAddress with either the specific address from the address pool or the ID of the address pool.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ProvisionByoipCidrResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ProvisionByoipCidrRequest' - parameters: [] - /?Action=ProvisionIpamPoolCidr&Version=2016-11-15: - get: - x-aws-operation-name: ProvisionIpamPoolCidr - operationId: GET_ProvisionIpamPoolCidr - description: '

Provision a CIDR to an IPAM pool. You can use this action to provision new CIDRs to a top-level pool or to transfer a CIDR from a top-level pool to a pool within it.

For more information, see Provision CIDRs to pools in the Amazon VPC IPAM User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ProvisionIpamPoolCidrResult' - parameters: - - name: DryRun - in: query - required: false - description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: IpamPoolId - in: query - required: true - description: The ID of the IPAM pool to which you want to assign a CIDR. - schema: - type: string - - name: Cidr - in: query - required: false - description: The CIDR you want to assign to the IPAM pool. - schema: - type: string - - name: CidrAuthorizationContext - in: query - required: false - description: A signed document that proves that you are authorized to bring a specified IP address range to Amazon using BYOIP. This option applies to public pools only. - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The signed authorization message for the prefix and account. - description: A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP. - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ProvisionIpamPoolCidr - operationId: POST_ProvisionIpamPoolCidr - description: '

Provision a CIDR to an IPAM pool. You can use this action to provision new CIDRs to a top-level pool or to transfer a CIDR from a top-level pool to a pool within it.

For more information, see Provision CIDRs to pools in the Amazon VPC IPAM User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ProvisionIpamPoolCidrResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ProvisionIpamPoolCidrRequest' - parameters: [] - /?Action=ProvisionPublicIpv4PoolCidr&Version=2016-11-15: - get: - x-aws-operation-name: ProvisionPublicIpv4PoolCidr - operationId: GET_ProvisionPublicIpv4PoolCidr - description: '

Provision a CIDR to a public IPv4 pool.

For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ProvisionPublicIpv4PoolCidrResult' - parameters: - - name: DryRun - in: query - required: false - description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: IpamPoolId - in: query - required: true - description: The ID of the IPAM pool you would like to use to allocate this CIDR. - schema: - type: string - - name: PoolId - in: query - required: true - description: The ID of the public IPv4 pool you would like to use for this CIDR. - schema: - type: string - - name: NetmaskLength - in: query - required: true - description: The netmask length of the CIDR you would like to allocate to the public IPv4 pool. - schema: - type: integer - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ProvisionPublicIpv4PoolCidr - operationId: POST_ProvisionPublicIpv4PoolCidr - description: '

Provision a CIDR to a public IPv4 pool.

For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ProvisionPublicIpv4PoolCidrResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ProvisionPublicIpv4PoolCidrRequest' - parameters: [] - /?Action=PurchaseHostReservation&Version=2016-11-15: - get: - x-aws-operation-name: PurchaseHostReservation - operationId: GET_PurchaseHostReservation - description: Purchase a reservation with configurations that match those of your Dedicated Host. You must have active Dedicated Hosts in your account before you purchase a reservation. This action results in the specified reservation being purchased and charged to your account. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/PurchaseHostReservationResult' - parameters: - - name: ClientToken - in: query - required: false - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.' - schema: - type: string - - name: CurrencyCode - in: query - required: false - description: 'The currency in which the totalUpfrontPrice, LimitPrice, and totalHourlyPrice amounts are specified. At this time, the only supported currency is USD.' - schema: - type: string - enum: - - USD - - name: HostIdSet - in: query - required: true - description: The IDs of the Dedicated Hosts with which the reservation will be associated. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/DedicatedHostId' - - xml: - name: item - - name: LimitPrice - in: query - required: false - description: 'The specified limit is checked against the total upfront cost of the reservation (calculated as the offering''s upfront cost multiplied by the host count). If the total upfront cost is greater than the specified price limit, the request fails. This is used to ensure that the purchase does not exceed the expected upfront cost of the purchase. At this time, the only supported currency is USD. For example, to indicate a limit price of USD 100, specify 100.00.' - schema: - type: string - - name: OfferingId - in: query - required: true - description: The ID of the offering. - schema: - type: string - - name: TagSpecification - in: query - required: false - description: The tags to apply to the Dedicated Host Reservation during purchase. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: PurchaseHostReservation - operationId: POST_PurchaseHostReservation - description: Purchase a reservation with configurations that match those of your Dedicated Host. You must have active Dedicated Hosts in your account before you purchase a reservation. This action results in the specified reservation being purchased and charged to your account. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/PurchaseHostReservationResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/PurchaseHostReservationRequest' - parameters: [] - /?Action=PurchaseReservedInstancesOffering&Version=2016-11-15: - get: - x-aws-operation-name: PurchaseReservedInstancesOffering - operationId: GET_PurchaseReservedInstancesOffering - description: '

Purchases a Reserved Instance for use with your account. With Reserved Instances, you pay a lower hourly rate compared to On-Demand instance pricing.

Use DescribeReservedInstancesOfferings to get a list of Reserved Instance offerings that match your specifications. After you''ve purchased a Reserved Instance, you can check for your new Reserved Instance with DescribeReservedInstances.

To queue a purchase for a future date and time, specify a purchase time. If you do not specify a purchase time, the default is the current time.

For more information, see Reserved Instances and Reserved Instance Marketplace in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/PurchaseReservedInstancesOfferingResult' - parameters: - - name: InstanceCount - in: query - required: true - description: The number of Reserved Instances to purchase. - schema: - type: integer - - name: ReservedInstancesOfferingId - in: query - required: true - description: The ID of the Reserved Instance offering to purchase. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: LimitPrice - in: query - required: false - description: Specified for Reserved Instance Marketplace offerings to limit the total order and ensure that the Reserved Instances are not purchased at unexpected prices. - schema: - type: object - properties: - amount: - allOf: - - $ref: '#/components/schemas/Double' - - description: Used for Reserved Instance Marketplace offerings. Specifies the limit price on the total order (instanceCount * price). - currencyCode: - allOf: - - $ref: '#/components/schemas/CurrencyCodeValues' - - description: 'The currency in which the limitPrice amount is specified. At this time, the only supported currency is USD.' - description: Describes the limit price of a Reserved Instance offering. - - name: PurchaseTime - in: query - required: false - description: 'The time at which to purchase the Reserved Instance, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).' - schema: - type: string - format: date-time - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: PurchaseReservedInstancesOffering - operationId: POST_PurchaseReservedInstancesOffering - description: '

Purchases a Reserved Instance for use with your account. With Reserved Instances, you pay a lower hourly rate compared to On-Demand instance pricing.

Use DescribeReservedInstancesOfferings to get a list of Reserved Instance offerings that match your specifications. After you''ve purchased a Reserved Instance, you can check for your new Reserved Instance with DescribeReservedInstances.

To queue a purchase for a future date and time, specify a purchase time. If you do not specify a purchase time, the default is the current time.

For more information, see Reserved Instances and Reserved Instance Marketplace in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/PurchaseReservedInstancesOfferingResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/PurchaseReservedInstancesOfferingRequest' - parameters: [] - /?Action=PurchaseScheduledInstances&Version=2016-11-15: - get: - x-aws-operation-name: PurchaseScheduledInstances - operationId: GET_PurchaseScheduledInstances - description: '

Purchases the Scheduled Instances with the specified schedule.

Scheduled Instances enable you to purchase Amazon EC2 compute capacity by the hour for a one-year term. Before you can purchase a Scheduled Instance, you must call DescribeScheduledInstanceAvailability to check for available schedules and obtain a purchase token. After you purchase a Scheduled Instance, you must call RunScheduledInstances during each scheduled time period.

After you purchase a Scheduled Instance, you can''t cancel, modify, or resell your purchase.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/PurchaseScheduledInstancesResult' - parameters: - - name: ClientToken - in: query - required: false - description: 'Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see Ensuring Idempotency.' - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: PurchaseRequest - in: query - required: true - description: The purchase requests. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/PurchaseRequest' - - xml: - name: PurchaseRequest - minItems: 1 - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: PurchaseScheduledInstances - operationId: POST_PurchaseScheduledInstances - description: '

Purchases the Scheduled Instances with the specified schedule.

Scheduled Instances enable you to purchase Amazon EC2 compute capacity by the hour for a one-year term. Before you can purchase a Scheduled Instance, you must call DescribeScheduledInstanceAvailability to check for available schedules and obtain a purchase token. After you purchase a Scheduled Instance, you must call RunScheduledInstances during each scheduled time period.

After you purchase a Scheduled Instance, you can''t cancel, modify, or resell your purchase.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/PurchaseScheduledInstancesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/PurchaseScheduledInstancesRequest' - parameters: [] - /?Action=RebootInstances&Version=2016-11-15: - get: - x-aws-operation-name: RebootInstances - operationId: GET_RebootInstances - description: '

Requests a reboot of the specified instances. This operation is asynchronous; it only queues a request to reboot the specified instances. The operation succeeds if the instances are valid and belong to you. Requests to reboot terminated instances are ignored.

If an instance does not cleanly shut down within a few minutes, Amazon EC2 performs a hard reboot.

For more information about troubleshooting, see Troubleshoot an unreachable instance in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - parameters: - - name: InstanceId - in: query - required: true - description: The instance IDs. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/InstanceId' - - xml: - name: InstanceId - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: RebootInstances - operationId: POST_RebootInstances - description: '

Requests a reboot of the specified instances. This operation is asynchronous; it only queues a request to reboot the specified instances. The operation succeeds if the instances are valid and belong to you. Requests to reboot terminated instances are ignored.

If an instance does not cleanly shut down within a few minutes, Amazon EC2 performs a hard reboot.

For more information about troubleshooting, see Troubleshoot an unreachable instance in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/RebootInstancesRequest' - parameters: [] - /?Action=RegisterImage&Version=2016-11-15: - get: - x-aws-operation-name: RegisterImage - operationId: GET_RegisterImage - description: '

Registers an AMI. When you''re creating an AMI, this is the final step you must complete before you can launch an instance from the AMI. For more information about creating AMIs, see Creating your own AMIs in the Amazon Elastic Compute Cloud User Guide.

For Amazon EBS-backed instances, CreateImage creates and registers the AMI in a single request, so you don''t have to register the AMI yourself.

If needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. If you make changes to an image, deregister the previous image and register the new image.

Register a snapshot of a root device volume

You can use RegisterImage to create an Amazon EBS-backed Linux AMI from a snapshot of a root device volume. You specify the snapshot using a block device mapping. You can''t set the encryption state of the volume using the block device mapping. If the snapshot is encrypted, or encryption by default is enabled, the root volume of an instance launched from the AMI is encrypted.

For more information, see Create a Linux AMI from a snapshot and Use encryption with Amazon EBS-backed AMIs in the Amazon Elastic Compute Cloud User Guide.

Amazon Web Services Marketplace product codes

If any snapshots have Amazon Web Services Marketplace product codes, they are copied to the new AMI.

Windows and some Linux distributions, such as Red Hat Enterprise Linux (RHEL) and SUSE Linux Enterprise Server (SLES), use the Amazon EC2 billing product code associated with an AMI to verify the subscription status for package updates. To create a new AMI for operating systems that require a billing product code, instead of registering the AMI, do the following to preserve the billing product code association:

  1. Launch an instance from an existing AMI with that billing product code.

  2. Customize the instance.

  3. Create an AMI from the instance using CreateImage.

If you purchase a Reserved Instance to apply to an On-Demand Instance that was launched from an AMI with a billing product code, make sure that the Reserved Instance has the matching billing product code. If you purchase a Reserved Instance without the matching billing product code, the Reserved Instance will not be applied to the On-Demand Instance. For information about how to obtain the platform details and billing information of an AMI, see Understanding AMI billing in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/RegisterImageResult' - parameters: - - name: ImageLocation - in: query - required: false - description: 'The full path to your AMI manifest in Amazon S3 storage. The specified bucket must have the aws-exec-read canned access control list (ACL) to ensure that it can be accessed by Amazon EC2. For more information, see Canned ACLs in the Amazon S3 Service Developer Guide.' - schema: - type: string - - name: Architecture - in: query - required: false - description: '

The architecture of the AMI.

Default: For Amazon EBS-backed AMIs, i386. For instance store-backed AMIs, the architecture specified in the manifest file.

' - schema: - type: string - enum: - - i386 - - x86_64 - - arm64 - - x86_64_mac - - name: BlockDeviceMapping - in: query - required: false - description: '

The block device mapping entries.

If you specify an Amazon EBS volume using the ID of an Amazon EBS snapshot, you can''t specify the encryption state of the volume.

If you create an AMI on an Outpost, then all backing snapshots must be on the same Outpost or in the Region of that Outpost. AMIs on an Outpost that include local snapshots can be used to launch instances on the same Outpost only. For more information, Amazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/BlockDeviceMapping' - - xml: - name: BlockDeviceMapping - - name: Description - in: query - required: false - description: A description for your AMI. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: EnaSupport - in: query - required: false - description:

Set to true to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI.

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

- schema: - type: boolean - - name: KernelId - in: query - required: false - description: The ID of the kernel. - schema: - type: string - - name: Name - in: query - required: true - description: '

A name for your AMI.

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes (''), at-signs (@), or underscores(_)

' - schema: - type: string - - name: BillingProduct - in: query - required: false - description: 'The billing product codes. Your account must be authorized to specify billing product codes. Otherwise, you can use the Amazon Web Services Marketplace to bill for the use of an AMI.' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - - name: RamdiskId - in: query - required: false - description: The ID of the RAM disk. - schema: - type: string - - name: RootDeviceName - in: query - required: false - description: 'The device name of the root device volume (for example, /dev/sda1).' - schema: - type: string - - name: SriovNetSupport - in: query - required: false - description:

Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the AMI and any instances that you launch from the AMI.

There is no way to disable sriovNetSupport at this time.

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

- schema: - type: string - - name: VirtualizationType - in: query - required: false - description: '

The type of virtualization (hvm | paravirtual).

Default: paravirtual

' - schema: - type: string - - name: BootMode - in: query - required: false - description: 'The boot mode of the AMI. For more information, see Boot modes in the Amazon Elastic Compute Cloud User Guide.' - schema: - type: string - enum: - - legacy-bios - - uefi - - name: TpmSupport - in: query - required: false - description: 'Set to v2.0 to enable Trusted Platform Module (TPM) support. For more information, see NitroTPM in the Amazon Elastic Compute Cloud User Guide.' - schema: - type: string - enum: - - v2.0 - - name: UefiData - in: query - required: false - description: 'Base64 representation of the non-volatile UEFI variable store. To retrieve the UEFI data, use the GetInstanceUefiData command. You can inspect and modify the UEFI data by using the python-uefivars tool on GitHub. For more information, see UEFI Secure Boot in the Amazon Elastic Compute Cloud User Guide.' - schema: - type: string - minLength: 0 - maxLength: 64000 - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: RegisterImage - operationId: POST_RegisterImage - description: '

Registers an AMI. When you''re creating an AMI, this is the final step you must complete before you can launch an instance from the AMI. For more information about creating AMIs, see Creating your own AMIs in the Amazon Elastic Compute Cloud User Guide.

For Amazon EBS-backed instances, CreateImage creates and registers the AMI in a single request, so you don''t have to register the AMI yourself.

If needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. If you make changes to an image, deregister the previous image and register the new image.

Register a snapshot of a root device volume

You can use RegisterImage to create an Amazon EBS-backed Linux AMI from a snapshot of a root device volume. You specify the snapshot using a block device mapping. You can''t set the encryption state of the volume using the block device mapping. If the snapshot is encrypted, or encryption by default is enabled, the root volume of an instance launched from the AMI is encrypted.

For more information, see Create a Linux AMI from a snapshot and Use encryption with Amazon EBS-backed AMIs in the Amazon Elastic Compute Cloud User Guide.

Amazon Web Services Marketplace product codes

If any snapshots have Amazon Web Services Marketplace product codes, they are copied to the new AMI.

Windows and some Linux distributions, such as Red Hat Enterprise Linux (RHEL) and SUSE Linux Enterprise Server (SLES), use the Amazon EC2 billing product code associated with an AMI to verify the subscription status for package updates. To create a new AMI for operating systems that require a billing product code, instead of registering the AMI, do the following to preserve the billing product code association:

  1. Launch an instance from an existing AMI with that billing product code.

  2. Customize the instance.

  3. Create an AMI from the instance using CreateImage.

If you purchase a Reserved Instance to apply to an On-Demand Instance that was launched from an AMI with a billing product code, make sure that the Reserved Instance has the matching billing product code. If you purchase a Reserved Instance without the matching billing product code, the Reserved Instance will not be applied to the On-Demand Instance. For information about how to obtain the platform details and billing information of an AMI, see Understanding AMI billing in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/RegisterImageResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/RegisterImageRequest' - parameters: [] - /?Action=RegisterInstanceEventNotificationAttributes&Version=2016-11-15: - get: - x-aws-operation-name: RegisterInstanceEventNotificationAttributes - operationId: GET_RegisterInstanceEventNotificationAttributes - description: '

Registers a set of tag keys to include in scheduled event notifications for your resources.

To remove tags, use DeregisterInstanceEventNotificationAttributes.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/RegisterInstanceEventNotificationAttributesResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: InstanceTagAttribute - in: query - required: false - description: Information about the tag keys to register. - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether to register all tag keys in the current Region. Specify true to register all tag keys. - InstanceTagKey: - allOf: - - $ref: '#/components/schemas/InstanceTagKeySet' - - description: The tag keys to register. - description: Information about the tag keys to register for the current Region. You can either specify individual tag keys or register all tag keys in the current Region. You must specify either IncludeAllTagsOfInstance or InstanceTagKeys in the request - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: RegisterInstanceEventNotificationAttributes - operationId: POST_RegisterInstanceEventNotificationAttributes - description: '

Registers a set of tag keys to include in scheduled event notifications for your resources.

To remove tags, use DeregisterInstanceEventNotificationAttributes.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/RegisterInstanceEventNotificationAttributesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/RegisterInstanceEventNotificationAttributesRequest' - parameters: [] - /?Action=RegisterTransitGatewayMulticastGroupMembers&Version=2016-11-15: - get: - x-aws-operation-name: RegisterTransitGatewayMulticastGroupMembers - operationId: GET_RegisterTransitGatewayMulticastGroupMembers - description: '

Registers members (network interfaces) with the transit gateway multicast group. A member is a network interface associated with a supported EC2 instance that receives multicast traffic. For information about supported instances, see Multicast Consideration in Amazon VPC Transit Gateways.

After you add the members, use SearchTransitGatewayMulticastGroups to verify that the members were added to the transit gateway multicast group.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/RegisterTransitGatewayMulticastGroupMembersResult' - parameters: - - name: TransitGatewayMulticastDomainId - in: query - required: false - description: The ID of the transit gateway multicast domain. - schema: - type: string - - name: GroupIpAddress - in: query - required: false - description: The IP address assigned to the transit gateway multicast group. - schema: - type: string - - name: NetworkInterfaceIds - in: query - required: false - description: The group members' network interface IDs to register with the transit gateway multicast group. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/NetworkInterfaceId' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: RegisterTransitGatewayMulticastGroupMembers - operationId: POST_RegisterTransitGatewayMulticastGroupMembers - description: '

Registers members (network interfaces) with the transit gateway multicast group. A member is a network interface associated with a supported EC2 instance that receives multicast traffic. For information about supported instances, see Multicast Consideration in Amazon VPC Transit Gateways.

After you add the members, use SearchTransitGatewayMulticastGroups to verify that the members were added to the transit gateway multicast group.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/RegisterTransitGatewayMulticastGroupMembersResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/RegisterTransitGatewayMulticastGroupMembersRequest' - parameters: [] - /?Action=RegisterTransitGatewayMulticastGroupSources&Version=2016-11-15: - get: - x-aws-operation-name: RegisterTransitGatewayMulticastGroupSources - operationId: GET_RegisterTransitGatewayMulticastGroupSources - description: '

Registers sources (network interfaces) with the specified transit gateway multicast group.

A multicast source is a network interface attached to a supported instance that sends multicast traffic. For information about supported instances, see Multicast Considerations in Amazon VPC Transit Gateways.

After you add the source, use SearchTransitGatewayMulticastGroups to verify that the source was added to the multicast group.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/RegisterTransitGatewayMulticastGroupSourcesResult' - parameters: - - name: TransitGatewayMulticastDomainId - in: query - required: false - description: The ID of the transit gateway multicast domain. - schema: - type: string - - name: GroupIpAddress - in: query - required: false - description: The IP address assigned to the transit gateway multicast group. - schema: - type: string - - name: NetworkInterfaceIds - in: query - required: false - description: The group sources' network interface IDs to register with the transit gateway multicast group. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/NetworkInterfaceId' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: RegisterTransitGatewayMulticastGroupSources - operationId: POST_RegisterTransitGatewayMulticastGroupSources - description: '

Registers sources (network interfaces) with the specified transit gateway multicast group.

A multicast source is a network interface attached to a supported instance that sends multicast traffic. For information about supported instances, see Multicast Considerations in Amazon VPC Transit Gateways.

After you add the source, use SearchTransitGatewayMulticastGroups to verify that the source was added to the multicast group.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/RegisterTransitGatewayMulticastGroupSourcesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/RegisterTransitGatewayMulticastGroupSourcesRequest' - parameters: [] - /?Action=RejectTransitGatewayMulticastDomainAssociations&Version=2016-11-15: - get: - x-aws-operation-name: RejectTransitGatewayMulticastDomainAssociations - operationId: GET_RejectTransitGatewayMulticastDomainAssociations - description: Rejects a request to associate cross-account subnets with a transit gateway multicast domain. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/RejectTransitGatewayMulticastDomainAssociationsResult' - parameters: - - name: TransitGatewayMulticastDomainId - in: query - required: false - description: The ID of the transit gateway multicast domain. - schema: - type: string - - name: TransitGatewayAttachmentId - in: query - required: false - description: The ID of the transit gateway attachment. - schema: - type: string - - name: SubnetIds - in: query - required: false - description: The IDs of the subnets to associate with the transit gateway multicast domain. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: RejectTransitGatewayMulticastDomainAssociations - operationId: POST_RejectTransitGatewayMulticastDomainAssociations - description: Rejects a request to associate cross-account subnets with a transit gateway multicast domain. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/RejectTransitGatewayMulticastDomainAssociationsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/RejectTransitGatewayMulticastDomainAssociationsRequest' - parameters: [] - /?Action=RejectTransitGatewayPeeringAttachment&Version=2016-11-15: - get: - x-aws-operation-name: RejectTransitGatewayPeeringAttachment - operationId: GET_RejectTransitGatewayPeeringAttachment - description: Rejects a transit gateway peering attachment request. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/RejectTransitGatewayPeeringAttachmentResult' - parameters: - - name: TransitGatewayAttachmentId - in: query - required: true - description: The ID of the transit gateway peering attachment. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: RejectTransitGatewayPeeringAttachment - operationId: POST_RejectTransitGatewayPeeringAttachment - description: Rejects a transit gateway peering attachment request. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/RejectTransitGatewayPeeringAttachmentResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/RejectTransitGatewayPeeringAttachmentRequest' - parameters: [] - /?Action=RejectTransitGatewayVpcAttachment&Version=2016-11-15: - get: - x-aws-operation-name: RejectTransitGatewayVpcAttachment - operationId: GET_RejectTransitGatewayVpcAttachment - description:

Rejects a request to attach a VPC to a transit gateway.

The VPC attachment must be in the pendingAcceptance state. Use DescribeTransitGatewayVpcAttachments to view your pending VPC attachment requests. Use AcceptTransitGatewayVpcAttachment to accept a VPC attachment request.

- responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/RejectTransitGatewayVpcAttachmentResult' - parameters: - - name: TransitGatewayAttachmentId - in: query - required: true - description: The ID of the attachment. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: RejectTransitGatewayVpcAttachment - operationId: POST_RejectTransitGatewayVpcAttachment - description:

Rejects a request to attach a VPC to a transit gateway.

The VPC attachment must be in the pendingAcceptance state. Use DescribeTransitGatewayVpcAttachments to view your pending VPC attachment requests. Use AcceptTransitGatewayVpcAttachment to accept a VPC attachment request.

- responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/RejectTransitGatewayVpcAttachmentResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/RejectTransitGatewayVpcAttachmentRequest' - parameters: [] - /?Action=RejectVpcEndpointConnections&Version=2016-11-15: - get: - x-aws-operation-name: RejectVpcEndpointConnections - operationId: GET_RejectVpcEndpointConnections - description: Rejects one or more VPC endpoint connection requests to your VPC endpoint service. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/RejectVpcEndpointConnectionsResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: ServiceId - in: query - required: true - description: The ID of the service. - schema: - type: string - - name: VpcEndpointId - in: query - required: true - description: The IDs of one or more VPC endpoints. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/VpcEndpointId' - - xml: - name: item - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: RejectVpcEndpointConnections - operationId: POST_RejectVpcEndpointConnections - description: Rejects one or more VPC endpoint connection requests to your VPC endpoint service. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/RejectVpcEndpointConnectionsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/RejectVpcEndpointConnectionsRequest' - parameters: [] - /?Action=RejectVpcPeeringConnection&Version=2016-11-15: - get: - x-aws-operation-name: RejectVpcPeeringConnection - operationId: GET_RejectVpcPeeringConnection - description: 'Rejects a VPC peering connection request. The VPC peering connection must be in the pending-acceptance state. Use the DescribeVpcPeeringConnections request to view your outstanding VPC peering connection requests. To delete an active VPC peering connection, or to delete a VPC peering connection request that you initiated, use DeleteVpcPeeringConnection.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/RejectVpcPeeringConnectionResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: VpcPeeringConnectionId - in: query - required: true - description: The ID of the VPC peering connection. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: RejectVpcPeeringConnection - operationId: POST_RejectVpcPeeringConnection - description: 'Rejects a VPC peering connection request. The VPC peering connection must be in the pending-acceptance state. Use the DescribeVpcPeeringConnections request to view your outstanding VPC peering connection requests. To delete an active VPC peering connection, or to delete a VPC peering connection request that you initiated, use DeleteVpcPeeringConnection.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/RejectVpcPeeringConnectionResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/RejectVpcPeeringConnectionRequest' - parameters: [] - /?Action=ReleaseAddress&Version=2016-11-15: - get: - x-aws-operation-name: ReleaseAddress - operationId: GET_ReleaseAddress - description: '

Releases the specified Elastic IP address.

[EC2-Classic, default VPC] Releasing an Elastic IP address automatically disassociates it from any instance that it''s associated with. To disassociate an Elastic IP address without releasing it, use DisassociateAddress.

[Nondefault VPC] You must use DisassociateAddress to disassociate the Elastic IP address before you can release it. Otherwise, Amazon EC2 returns an error (InvalidIPAddress.InUse).

After releasing an Elastic IP address, it is released to the IP address pool. Be sure to update your DNS records and any servers or devices that communicate with the address. If you attempt to release an Elastic IP address that you already released, you''ll get an AuthFailure error if the address is already allocated to another Amazon Web Services account.

[EC2-VPC] After you release an Elastic IP address for use in a VPC, you might be able to recover it. For more information, see AllocateAddress.

' - responses: - '200': - description: Success - parameters: - - name: AllocationId - in: query - required: false - description: '[EC2-VPC] The allocation ID. Required for EC2-VPC.' - schema: - type: string - - name: PublicIp - in: query - required: false - description: '[EC2-Classic] The Elastic IP address. Required for EC2-Classic.' - schema: - type: string - - name: NetworkBorderGroup - in: query - required: false - description: '

The set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses.

If you provide an incorrect network border group, you receive an InvalidAddress.NotFound error.

You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 classic, you receive an InvalidParameterCombination error.

' - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ReleaseAddress - operationId: POST_ReleaseAddress - description: '

Releases the specified Elastic IP address.

[EC2-Classic, default VPC] Releasing an Elastic IP address automatically disassociates it from any instance that it''s associated with. To disassociate an Elastic IP address without releasing it, use DisassociateAddress.

[Nondefault VPC] You must use DisassociateAddress to disassociate the Elastic IP address before you can release it. Otherwise, Amazon EC2 returns an error (InvalidIPAddress.InUse).

After releasing an Elastic IP address, it is released to the IP address pool. Be sure to update your DNS records and any servers or devices that communicate with the address. If you attempt to release an Elastic IP address that you already released, you''ll get an AuthFailure error if the address is already allocated to another Amazon Web Services account.

[EC2-VPC] After you release an Elastic IP address for use in a VPC, you might be able to recover it. For more information, see AllocateAddress.

' - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ReleaseAddressRequest' - parameters: [] - /?Action=ReleaseHosts&Version=2016-11-15: - get: - x-aws-operation-name: ReleaseHosts - operationId: GET_ReleaseHosts - description: '

When you no longer want to use an On-Demand Dedicated Host it can be released. On-Demand billing is stopped and the host goes into released state. The host ID of Dedicated Hosts that have been released can no longer be specified in another request, for example, to modify the host. You must stop or terminate all instances on a host before it can be released.

When Dedicated Hosts are released, it may take some time for them to stop counting toward your limit and you may receive capacity errors when trying to allocate new Dedicated Hosts. Wait a few minutes and then try again.

Released hosts still appear in a DescribeHosts response.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ReleaseHostsResult' - parameters: - - name: HostId - in: query - required: true - description: The IDs of the Dedicated Hosts to release. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/DedicatedHostId' - - xml: - name: item - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ReleaseHosts - operationId: POST_ReleaseHosts - description: '

When you no longer want to use an On-Demand Dedicated Host it can be released. On-Demand billing is stopped and the host goes into released state. The host ID of Dedicated Hosts that have been released can no longer be specified in another request, for example, to modify the host. You must stop or terminate all instances on a host before it can be released.

When Dedicated Hosts are released, it may take some time for them to stop counting toward your limit and you may receive capacity errors when trying to allocate new Dedicated Hosts. Wait a few minutes and then try again.

Released hosts still appear in a DescribeHosts response.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ReleaseHostsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ReleaseHostsRequest' - parameters: [] - /?Action=ReleaseIpamPoolAllocation&Version=2016-11-15: - get: - x-aws-operation-name: ReleaseIpamPoolAllocation - operationId: GET_ReleaseIpamPoolAllocation - description: 'Release an allocation within an IPAM pool. You can only use this action to release manual allocations. To remove an allocation for a resource without deleting the resource, set its monitored state to false using ModifyIpamResourceCidr. For more information, see Release an allocation in the Amazon VPC IPAM User Guide. ' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ReleaseIpamPoolAllocationResult' - parameters: - - name: DryRun - in: query - required: false - description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: IpamPoolId - in: query - required: true - description: The ID of the IPAM pool which contains the allocation you want to release. - schema: - type: string - - name: Cidr - in: query - required: true - description: The CIDR of the allocation you want to release. - schema: - type: string - - name: IpamPoolAllocationId - in: query - required: true - description: The ID of the allocation. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ReleaseIpamPoolAllocation - operationId: POST_ReleaseIpamPoolAllocation - description: 'Release an allocation within an IPAM pool. You can only use this action to release manual allocations. To remove an allocation for a resource without deleting the resource, set its monitored state to false using ModifyIpamResourceCidr. For more information, see Release an allocation in the Amazon VPC IPAM User Guide. ' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ReleaseIpamPoolAllocationResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ReleaseIpamPoolAllocationRequest' - parameters: [] - /?Action=ReplaceIamInstanceProfileAssociation&Version=2016-11-15: - get: - x-aws-operation-name: ReplaceIamInstanceProfileAssociation - operationId: GET_ReplaceIamInstanceProfileAssociation - description:

Replaces an IAM instance profile for the specified running instance. You can use this action to change the IAM instance profile that's associated with an instance without having to disassociate the existing IAM instance profile first.

Use DescribeIamInstanceProfileAssociations to get the association ID.

- responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ReplaceIamInstanceProfileAssociationResult' - parameters: - - name: IamInstanceProfile - in: query - required: true - description: The IAM instance profile. - schema: - type: object - properties: - arn: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Resource Name (ARN) of the instance profile. - name: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of the instance profile. - description: Describes an IAM instance profile. - - name: AssociationId - in: query - required: true - description: The ID of the existing IAM instance profile association. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ReplaceIamInstanceProfileAssociation - operationId: POST_ReplaceIamInstanceProfileAssociation - description:

Replaces an IAM instance profile for the specified running instance. You can use this action to change the IAM instance profile that's associated with an instance without having to disassociate the existing IAM instance profile first.

Use DescribeIamInstanceProfileAssociations to get the association ID.

- responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ReplaceIamInstanceProfileAssociationResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ReplaceIamInstanceProfileAssociationRequest' - parameters: [] - /?Action=ReplaceNetworkAclAssociation&Version=2016-11-15: - get: - x-aws-operation-name: ReplaceNetworkAclAssociation - operationId: GET_ReplaceNetworkAclAssociation - description: '

Changes which network ACL a subnet is associated with. By default when you create a subnet, it''s automatically associated with the default network ACL. For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

This is an idempotent operation.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ReplaceNetworkAclAssociationResult' - parameters: - - name: AssociationId - in: query - required: true - description: The ID of the current association between the original network ACL and the subnet. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: NetworkAclId - in: query - required: true - description: The ID of the new network ACL to associate with the subnet. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ReplaceNetworkAclAssociation - operationId: POST_ReplaceNetworkAclAssociation - description: '

Changes which network ACL a subnet is associated with. By default when you create a subnet, it''s automatically associated with the default network ACL. For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

This is an idempotent operation.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ReplaceNetworkAclAssociationResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ReplaceNetworkAclAssociationRequest' - parameters: [] - /?Action=ReplaceNetworkAclEntry&Version=2016-11-15: - get: - x-aws-operation-name: ReplaceNetworkAclEntry - operationId: GET_ReplaceNetworkAclEntry - description: 'Replaces an entry (rule) in a network ACL. For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide.' - responses: - '200': - description: Success - parameters: - - name: CidrBlock - in: query - required: false - description: 'The IPv4 network range to allow or deny, in CIDR notation (for example 172.16.0.0/24).' - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: Egress - in: query - required: true - description: '

Indicates whether to replace the egress rule.

Default: If no value is specified, we replace the ingress rule.

' - schema: - type: boolean - - name: Icmp - in: query - required: false - description: 'ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block.' - schema: - type: object - properties: - code: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The ICMP code. A value of -1 means all codes for the specified ICMP type. - type: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The ICMP type. A value of -1 means all types. - description: Describes the ICMP type and code. - - name: Ipv6CidrBlock - in: query - required: false - description: 'The IPv6 network range to allow or deny, in CIDR notation (for example 2001:bd8:1234:1a00::/64).' - schema: - type: string - - name: NetworkAclId - in: query - required: true - description: The ID of the ACL. - schema: - type: string - - name: PortRange - in: query - required: false - description: 'TCP or UDP protocols: The range of ports the rule applies to. Required if specifying protocol 6 (TCP) or 17 (UDP).' - schema: - type: object - properties: - from: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The first port in the range. - to: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The last port in the range. - description: Describes a range of ports. - - name: Protocol - in: query - required: true - description: 'The protocol number. A value of "-1" means all protocols. If you specify "-1" or a protocol number other than "6" (TCP), "17" (UDP), or "1" (ICMP), traffic on all ports is allowed, regardless of any ports or ICMP types or codes that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP types and codes allowed, regardless of any that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv6 CIDR block, you must specify an ICMP type and code.' - schema: - type: string - - name: RuleAction - in: query - required: true - description: Indicates whether to allow or deny the traffic that matches the rule. - schema: - type: string - enum: - - allow - - deny - - name: RuleNumber - in: query - required: true - description: The rule number of the entry to replace. - schema: - type: integer - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ReplaceNetworkAclEntry - operationId: POST_ReplaceNetworkAclEntry - description: 'Replaces an entry (rule) in a network ACL. For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide.' - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ReplaceNetworkAclEntryRequest' - parameters: [] - /?Action=ReplaceRoute&Version=2016-11-15: - get: - x-aws-operation-name: ReplaceRoute - operationId: GET_ReplaceRoute - description: '

Replaces an existing route within a route table in a VPC. You must provide only one of the following: internet gateway, virtual private gateway, NAT instance, NAT gateway, VPC peering connection, network interface, egress-only internet gateway, or transit gateway.

For more information, see Route tables in the Amazon Virtual Private Cloud User Guide.

' - responses: - '200': - description: Success - parameters: - - name: DestinationCidrBlock - in: query - required: false - description: The IPv4 CIDR address block used for the destination match. The value that you provide must match the CIDR of an existing route in the table. - schema: - type: string - - name: DestinationIpv6CidrBlock - in: query - required: false - description: The IPv6 CIDR address block used for the destination match. The value that you provide must match the CIDR of an existing route in the table. - schema: - type: string - - name: DestinationPrefixListId - in: query - required: false - description: The ID of the prefix list for the route. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: VpcEndpointId - in: query - required: false - description: The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only. - schema: - type: string - - name: EgressOnlyInternetGatewayId - in: query - required: false - description: '[IPv6 traffic only] The ID of an egress-only internet gateway.' - schema: - type: string - - name: GatewayId - in: query - required: false - description: The ID of an internet gateway or virtual private gateway. - schema: - type: string - - name: InstanceId - in: query - required: false - description: The ID of a NAT instance in your VPC. - schema: - type: string - - name: LocalTarget - in: query - required: false - description: Specifies whether to reset the local route to its default target (local). - schema: - type: boolean - - name: NatGatewayId - in: query - required: false - description: '[IPv4 traffic only] The ID of a NAT gateway.' - schema: - type: string - - name: TransitGatewayId - in: query - required: false - description: The ID of a transit gateway. - schema: - type: string - - name: LocalGatewayId - in: query - required: false - description: The ID of the local gateway. - schema: - type: string - - name: CarrierGatewayId - in: query - required: false - description: '[IPv4 traffic only] The ID of a carrier gateway.' - schema: - type: string - - name: NetworkInterfaceId - in: query - required: false - description: The ID of a network interface. - schema: - type: string - - name: RouteTableId - in: query - required: true - description: The ID of the route table. - schema: - type: string - - name: VpcPeeringConnectionId - in: query - required: false - description: The ID of a VPC peering connection. - schema: - type: string - - name: CoreNetworkArn - in: query - required: false - description: The Amazon Resource Name (ARN) of the core network. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ReplaceRoute - operationId: POST_ReplaceRoute - description: '

Replaces an existing route within a route table in a VPC. You must provide only one of the following: internet gateway, virtual private gateway, NAT instance, NAT gateway, VPC peering connection, network interface, egress-only internet gateway, or transit gateway.

For more information, see Route tables in the Amazon Virtual Private Cloud User Guide.

' - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ReplaceRouteRequest' - parameters: [] - /?Action=ReplaceRouteTableAssociation&Version=2016-11-15: - get: - x-aws-operation-name: ReplaceRouteTableAssociation - operationId: GET_ReplaceRouteTableAssociation - description: '

Changes the route table associated with a given subnet, internet gateway, or virtual private gateway in a VPC. After the operation completes, the subnet or gateway uses the routes in the new route table. For more information about route tables, see Route tables in the Amazon Virtual Private Cloud User Guide.

You can also use this operation to change which table is the main route table in the VPC. Specify the main route table''s association ID and the route table ID of the new main route table.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ReplaceRouteTableAssociationResult' - parameters: - - name: AssociationId - in: query - required: true - description: The association ID. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: RouteTableId - in: query - required: true - description: The ID of the new route table to associate with the subnet. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ReplaceRouteTableAssociation - operationId: POST_ReplaceRouteTableAssociation - description: '

Changes the route table associated with a given subnet, internet gateway, or virtual private gateway in a VPC. After the operation completes, the subnet or gateway uses the routes in the new route table. For more information about route tables, see Route tables in the Amazon Virtual Private Cloud User Guide.

You can also use this operation to change which table is the main route table in the VPC. Specify the main route table''s association ID and the route table ID of the new main route table.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ReplaceRouteTableAssociationResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ReplaceRouteTableAssociationRequest' - parameters: [] - /?Action=ReplaceTransitGatewayRoute&Version=2016-11-15: - get: - x-aws-operation-name: ReplaceTransitGatewayRoute - operationId: GET_ReplaceTransitGatewayRoute - description: Replaces the specified route in the specified transit gateway route table. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ReplaceTransitGatewayRouteResult' - parameters: - - name: DestinationCidrBlock - in: query - required: true - description: The CIDR range used for the destination match. Routing decisions are based on the most specific match. - schema: - type: string - - name: TransitGatewayRouteTableId - in: query - required: true - description: The ID of the route table. - schema: - type: string - - name: TransitGatewayAttachmentId - in: query - required: false - description: The ID of the attachment. - schema: - type: string - - name: Blackhole - in: query - required: false - description: Indicates whether traffic matching this route is to be dropped. - schema: - type: boolean - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ReplaceTransitGatewayRoute - operationId: POST_ReplaceTransitGatewayRoute - description: Replaces the specified route in the specified transit gateway route table. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ReplaceTransitGatewayRouteResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ReplaceTransitGatewayRouteRequest' - parameters: [] - /?Action=ReportInstanceStatus&Version=2016-11-15: - get: - x-aws-operation-name: ReportInstanceStatus - operationId: GET_ReportInstanceStatus - description: '

Submits feedback about the status of an instance. The instance must be in the running state. If your experience with the instance differs from the instance status returned by DescribeInstanceStatus, use ReportInstanceStatus to report your experience with the instance. Amazon EC2 collects this information to improve the accuracy of status checks.

Use of this action does not change the value returned by DescribeInstanceStatus.

' - responses: - '200': - description: Success - parameters: - - name: Description - in: query - required: false - description: Descriptive text about the health state of your instance. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: EndTime - in: query - required: false - description: The time at which the reported instance health state ended. - schema: - type: string - format: date-time - - name: InstanceId - in: query - required: true - description: The instances. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/InstanceId' - - xml: - name: InstanceId - - name: ReasonCode - in: query - required: true - description: '

The reason codes that describe the health state of your instance.

  • instance-stuck-in-state: My instance is stuck in a state.

  • unresponsive: My instance is unresponsive.

  • not-accepting-credentials: My instance is not accepting my credentials.

  • password-not-available: A password is not available for my instance.

  • performance-network: My instance is experiencing performance problems that I believe are network related.

  • performance-instance-store: My instance is experiencing performance problems that I believe are related to the instance stores.

  • performance-ebs-volume: My instance is experiencing performance problems that I believe are related to an EBS volume.

  • performance-other: My instance is experiencing performance problems.

  • other: [explain using the description parameter]

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/ReportInstanceReasonCodes' - - xml: - name: item - - name: StartTime - in: query - required: false - description: The time at which the reported instance health state began. - schema: - type: string - format: date-time - - name: Status - in: query - required: true - description: The status of all instances listed. - schema: - type: string - enum: - - ok - - impaired - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ReportInstanceStatus - operationId: POST_ReportInstanceStatus - description: '

Submits feedback about the status of an instance. The instance must be in the running state. If your experience with the instance differs from the instance status returned by DescribeInstanceStatus, use ReportInstanceStatus to report your experience with the instance. Amazon EC2 collects this information to improve the accuracy of status checks.

Use of this action does not change the value returned by DescribeInstanceStatus.

' - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ReportInstanceStatusRequest' - parameters: [] - /?Action=RequestSpotFleet&Version=2016-11-15: - get: - x-aws-operation-name: RequestSpotFleet - operationId: GET_RequestSpotFleet - description: '

Creates a Spot Fleet request.

The Spot Fleet request specifies the total target capacity and the On-Demand target capacity. Amazon EC2 calculates the difference between the total capacity and On-Demand capacity, and launches the difference as Spot capacity.

You can submit a single request that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.

By default, the Spot Fleet requests Spot Instances in the Spot Instance pool where the price per unit is the lowest. Each launch specification can include its own instance weighting that reflects the value of the instance type to your application workload.

Alternatively, you can specify that the Spot Fleet distribute the target capacity across the Spot pools included in its launch specifications. By ensuring that the Spot Instances in your Spot Fleet are in different Spot pools, you can improve the availability of your fleet.

You can specify tags for the Spot Fleet request and instances launched by the fleet. You cannot tag other resource types in a Spot Fleet request because only the spot-fleet-request and instance resource types are supported.

For more information, see Spot Fleet requests in the Amazon EC2 User Guide for Linux Instances.

We strongly discourage using the RequestSpotFleet API because it is a legacy API with no planned investment. For options for requesting Spot Instances, see Which is the best Spot request method to use? in the Amazon EC2 User Guide for Linux Instances.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/RequestSpotFleetResponse' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: SpotFleetRequestConfig - in: query - required: true - description: The configuration for the Spot Fleet request. - schema: - type: object - required: - - IamFleetRole - - TargetCapacity - properties: - allocationStrategy: - allOf: - - $ref: '#/components/schemas/AllocationStrategy' - - description: '

Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the Spot Fleet request.

If the allocation strategy is lowestPrice, Spot Fleet launches instances from the Spot Instance pools with the lowest price. This is the default allocation strategy.

If the allocation strategy is diversified, Spot Fleet launches instances from all the Spot Instance pools that you specify.

If the allocation strategy is capacityOptimized (recommended), Spot Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching. To give certain instance types a higher chance of launching first, use capacityOptimizedPrioritized. Set a priority for each instance type by using the Priority parameter for LaunchTemplateOverrides. You can assign the same priority to different LaunchTemplateOverrides. EC2 implements the priorities on a best-effort basis, but optimizes for capacity first. capacityOptimizedPrioritized is supported only if your Spot Fleet uses a launch template. Note that if the OnDemandAllocationStrategy is set to prioritized, the same priority is applied when fulfilling On-Demand capacity.

' - onDemandAllocationStrategy: - allOf: - - $ref: '#/components/schemas/OnDemandAllocationStrategy' - - description: 'The order of the launch template overrides to use in fulfilling On-Demand capacity. If you specify lowestPrice, Spot Fleet uses price to determine the order, launching the lowest price first. If you specify prioritized, Spot Fleet uses the priority that you assign to each Spot Fleet launch template override, launching the highest priority first. If you do not specify a value, Spot Fleet defaults to lowestPrice.' - spotMaintenanceStrategies: - allOf: - - $ref: '#/components/schemas/SpotMaintenanceStrategies' - - description: The strategies for managing your Spot Instances that are at an elevated risk of being interrupted. - clientToken: - allOf: - - $ref: '#/components/schemas/String' - - description: 'A unique, case-sensitive identifier that you provide to ensure the idempotency of your listings. This helps to avoid duplicate listings. For more information, see Ensuring Idempotency.' - excessCapacityTerminationPolicy: - allOf: - - $ref: '#/components/schemas/ExcessCapacityTerminationPolicy' - - description: Indicates whether running Spot Instances should be terminated if you decrease the target capacity of the Spot Fleet request below the current size of the Spot Fleet. - fulfilledCapacity: - allOf: - - $ref: '#/components/schemas/Double' - - description: The number of units fulfilled by this request compared to the set target capacity. You cannot set this value. - onDemandFulfilledCapacity: - allOf: - - $ref: '#/components/schemas/Double' - - description: The number of On-Demand units fulfilled by this request compared to the set target On-Demand capacity. - iamFleetRole: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that grants the Spot Fleet the permission to request, launch, terminate, and tag instances on your behalf. For more information, see Spot Fleet prerequisites in the Amazon EC2 User Guide for Linux Instances. Spot Fleet can terminate Spot Instances on your behalf when you cancel its Spot Fleet request using CancelSpotFleetRequests or when the Spot Fleet request expires, if you set TerminateInstancesWithExpiration.' - launchSpecifications: - allOf: - - $ref: '#/components/schemas/LaunchSpecsList' - - description: 'The launch specifications for the Spot Fleet request. If you specify LaunchSpecifications, you can''t specify LaunchTemplateConfigs. If you include On-Demand capacity in your request, you must use LaunchTemplateConfigs.' - launchTemplateConfigs: - allOf: - - $ref: '#/components/schemas/LaunchTemplateConfigList' - - description: 'The launch template and overrides. If you specify LaunchTemplateConfigs, you can''t specify LaunchSpecifications. If you include On-Demand capacity in your request, you must use LaunchTemplateConfigs.' - spotPrice: - allOf: - - $ref: '#/components/schemas/String' - - description: The maximum price per unit hour that you are willing to pay for a Spot Instance. The default is the On-Demand price. - targetCapacity: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The number of units to request for the Spot Fleet. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.' - onDemandTargetCapacity: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The number of On-Demand units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.' - onDemandMaxTotalPrice: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The maximum amount per hour for On-Demand Instances that you''re willing to pay. You can use the onDemandMaxTotalPrice parameter, the spotMaxTotalPrice parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the maximum amount you''re willing to pay. When the maximum amount you''re willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity.' - spotMaxTotalPrice: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The maximum amount per hour for Spot Instances that you''re willing to pay. You can use the spotdMaxTotalPrice parameter, the onDemandMaxTotalPrice parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the maximum amount you''re willing to pay. When the maximum amount you''re willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity.' - terminateInstancesWithExpiration: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether running Spot Instances are terminated when the Spot Fleet request expires. - type: - allOf: - - $ref: '#/components/schemas/FleetType' - - description: 'The type of request. Indicates whether the Spot Fleet only requests the target capacity or also attempts to maintain it. When this value is request, the Spot Fleet only places the required requests. It does not attempt to replenish Spot Instances if capacity is diminished, nor does it submit requests in alternative Spot pools if capacity is not available. When this value is maintain, the Spot Fleet maintains the target capacity. The Spot Fleet places the required requests to meet capacity and automatically replenishes any interrupted instances. Default: maintain. instant is listed but is not used by Spot Fleet.' - validFrom: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: 'The start date and time of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ). By default, Amazon EC2 starts fulfilling the request immediately.' - validUntil: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: 'The end date and time of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ). After the end date and time, no new Spot Instance requests are placed or able to fulfill the request. If no value is specified, the Spot Fleet request remains until you cancel it.' - replaceUnhealthyInstances: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether Spot Fleet should replace unhealthy instances. - instanceInterruptionBehavior: - allOf: - - $ref: '#/components/schemas/InstanceInterruptionBehavior' - - description: The behavior when a Spot Instance is interrupted. The default is terminate. - loadBalancersConfig: - allOf: - - $ref: '#/components/schemas/LoadBalancersConfig' - - description: '

One or more Classic Load Balancers and target groups to attach to the Spot Fleet request. Spot Fleet registers the running Spot Instances with the specified Classic Load Balancers and target groups.

With Network Load Balancers, Spot Fleet cannot register instances that have the following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, M3, and T1.

' - instancePoolsToUseCount: - allOf: - - $ref: '#/components/schemas/Integer' - - description: '

The number of Spot pools across which to allocate your target Spot capacity. Valid only when Spot AllocationStrategy is set to lowest-price. Spot Fleet selects the cheapest Spot pools and evenly allocates your target Spot capacity across the number of Spot pools that you specify.

Note that Spot Fleet attempts to draw Spot Instances from the number of pools that you specify on a best effort basis. If a pool runs out of Spot capacity before fulfilling your target capacity, Spot Fleet will continue to fulfill your request by drawing from the next cheapest pool. To ensure that your target capacity is met, you might receive Spot Instances from more than the number of pools that you specified. Similarly, if most of the pools have no Spot capacity, you might receive your full target capacity from fewer than the number of pools that you specified.

' - context: - allOf: - - $ref: '#/components/schemas/String' - - description: Reserved. - targetCapacityUnitType: - allOf: - - $ref: '#/components/schemas/TargetCapacityUnitType' - - description: '

The unit for the target capacity.

Default: units (translates to number of instances)

' - TagSpecification: - allOf: - - $ref: '#/components/schemas/TagSpecificationList' - - description: 'The key-value pair for tagging the Spot Fleet request on creation. The value for ResourceType must be spot-fleet-request, otherwise the Spot Fleet request fails. To tag instances at launch, specify the tags in the launch template (valid only if you use LaunchTemplateConfigs) or in the SpotFleetTagSpecification (valid only if you use LaunchSpecifications). For information about tagging after launch, see Tagging Your Resources.' - description: Describes the configuration of a Spot Fleet request. - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: RequestSpotFleet - operationId: POST_RequestSpotFleet - description: '

Creates a Spot Fleet request.

The Spot Fleet request specifies the total target capacity and the On-Demand target capacity. Amazon EC2 calculates the difference between the total capacity and On-Demand capacity, and launches the difference as Spot capacity.

You can submit a single request that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.

By default, the Spot Fleet requests Spot Instances in the Spot Instance pool where the price per unit is the lowest. Each launch specification can include its own instance weighting that reflects the value of the instance type to your application workload.

Alternatively, you can specify that the Spot Fleet distribute the target capacity across the Spot pools included in its launch specifications. By ensuring that the Spot Instances in your Spot Fleet are in different Spot pools, you can improve the availability of your fleet.

You can specify tags for the Spot Fleet request and instances launched by the fleet. You cannot tag other resource types in a Spot Fleet request because only the spot-fleet-request and instance resource types are supported.

For more information, see Spot Fleet requests in the Amazon EC2 User Guide for Linux Instances.

We strongly discourage using the RequestSpotFleet API because it is a legacy API with no planned investment. For options for requesting Spot Instances, see Which is the best Spot request method to use? in the Amazon EC2 User Guide for Linux Instances.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/RequestSpotFleetResponse' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/RequestSpotFleetRequest' - parameters: [] - /?Action=RequestSpotInstances&Version=2016-11-15: - get: - x-aws-operation-name: RequestSpotInstances - operationId: GET_RequestSpotInstances - description: '

Creates a Spot Instance request.

For more information, see Spot Instance requests in the Amazon EC2 User Guide for Linux Instances.

We strongly discourage using the RequestSpotInstances API because it is a legacy API with no planned investment. For options for requesting Spot Instances, see Which is the best Spot request method to use? in the Amazon EC2 User Guide for Linux Instances.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/RequestSpotInstancesResult' - parameters: - - name: AvailabilityZoneGroup - in: query - required: false - description: '

The user-specified name for a logical grouping of requests.

When you specify an Availability Zone group in a Spot Instance request, all Spot Instances in the request are launched in the same Availability Zone. Instance proximity is maintained with this parameter, but the choice of Availability Zone is not. The group applies only to requests for Spot Instances of the same instance type. Any additional Spot Instance requests that are specified with the same Availability Zone group name are launched in that same Availability Zone, as long as at least one instance from the group is still active.

If there is no active instance running in the Availability Zone group that you specify for a new Spot Instance request (all instances are terminated, the request is expired, or the maximum price you specified falls below current Spot price), then Amazon EC2 launches the instance in any Availability Zone where the constraint can be met. Consequently, the subsequent set of Spot Instances could be placed in a different zone from the original request, even if you specified the same Availability Zone group.

Default: Instances are launched in any available Availability Zone.

' - schema: - type: string - - name: BlockDurationMinutes - in: query - required: false - description: Deprecated. - schema: - type: integer - - name: ClientToken - in: query - required: false - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon EC2 User Guide for Linux Instances.' - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: InstanceCount - in: query - required: false - description: '

The maximum number of Spot Instances to launch.

Default: 1

' - schema: - type: integer - - name: LaunchGroup - in: query - required: false - description: '

The instance launch group. Launch groups are Spot Instances that launch together and terminate together.

Default: Instances are launched and terminated individually

' - schema: - type: string - - name: LaunchSpecification - in: query - required: false - description: The launch specification. - schema: - type: object - properties: - SecurityGroupId: - allOf: - - $ref: '#/components/schemas/RequestSpotLaunchSpecificationSecurityGroupIdList' - - description: One or more security group IDs. - SecurityGroup: - allOf: - - $ref: '#/components/schemas/RequestSpotLaunchSpecificationSecurityGroupList' - - description: 'One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.' - addressingType: - allOf: - - $ref: '#/components/schemas/String' - - description: Deprecated. - blockDeviceMapping: - allOf: - - $ref: '#/components/schemas/BlockDeviceMappingList' - - description: 'One or more block device mapping entries. You can''t specify both a snapshot ID and an encryption value. This is because only blank volumes can be encrypted on creation. If a snapshot is the basis for a volume, it is not blank and its encryption status is used for the volume encryption status.' - ebsOptimized: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: '

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn''t available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

Default: false

' - iamInstanceProfile: - allOf: - - $ref: '#/components/schemas/IamInstanceProfileSpecification' - - description: The IAM instance profile. - imageId: - allOf: - - $ref: '#/components/schemas/ImageId' - - description: The ID of the AMI. - instanceType: - allOf: - - $ref: '#/components/schemas/InstanceType' - - description: The instance type. Only one instance type can be specified. - kernelId: - allOf: - - $ref: '#/components/schemas/KernelId' - - description: The ID of the kernel. - keyName: - allOf: - - $ref: '#/components/schemas/KeyPairName' - - description: The name of the key pair. - monitoring: - allOf: - - $ref: '#/components/schemas/RunInstancesMonitoringEnabled' - - description: '

Indicates whether basic or detailed monitoring is enabled for the instance.

Default: Disabled

' - NetworkInterface: - allOf: - - $ref: '#/components/schemas/InstanceNetworkInterfaceSpecificationList' - - description: 'One or more network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface.' - placement: - allOf: - - $ref: '#/components/schemas/SpotPlacement' - - description: The placement information for the instance. - ramdiskId: - allOf: - - $ref: '#/components/schemas/RamdiskId' - - description: The ID of the RAM disk. - subnetId: - allOf: - - $ref: '#/components/schemas/SubnetId' - - description: The ID of the subnet in which to launch the instance. - userData: - allOf: - - $ref: '#/components/schemas/String' - - description: The Base64-encoded user data for the instance. User data is limited to 16 KB. - description: Describes the launch specification for an instance. - - name: SpotPrice - in: query - required: false - description: The maximum price per hour that you are willing to pay for a Spot Instance. The default is the On-Demand price. - schema: - type: string - - name: Type - in: query - required: false - description: '

The Spot Instance request type.

Default: one-time

' - schema: - type: string - enum: - - one-time - - persistent - - name: ValidFrom - in: query - required: false - description: '

The start date of the request. If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled.

The specified start date and time cannot be equal to the current date and time. You must specify a start date and time that occurs after the current date and time.

' - schema: - type: string - format: date-time - - name: ValidUntil - in: query - required: false - description: '

The end date of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ).

  • For a persistent request, the request remains active until the ValidUntil date and time is reached. Otherwise, the request remains active until you cancel it.

  • For a one-time request, the request remains active until all instances launch, the request is canceled, or the ValidUntil date and time is reached. By default, the request is valid for 7 days from the date the request was created.

' - schema: - type: string - format: date-time - - name: TagSpecification - in: query - required: false - description: 'The key-value pair for tagging the Spot Instance request on creation. The value for ResourceType must be spot-instances-request, otherwise the Spot Instance request fails. To tag the Spot Instance request after it has been created, see CreateTags. ' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - - name: InstanceInterruptionBehavior - in: query - required: false - description: The behavior when a Spot Instance is interrupted. The default is terminate. - schema: - type: string - enum: - - hibernate - - stop - - terminate - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: RequestSpotInstances - operationId: POST_RequestSpotInstances - description: '

Creates a Spot Instance request.

For more information, see Spot Instance requests in the Amazon EC2 User Guide for Linux Instances.

We strongly discourage using the RequestSpotInstances API because it is a legacy API with no planned investment. For options for requesting Spot Instances, see Which is the best Spot request method to use? in the Amazon EC2 User Guide for Linux Instances.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/RequestSpotInstancesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/RequestSpotInstancesRequest' - parameters: [] - /?Action=ResetAddressAttribute&Version=2016-11-15: - get: - x-aws-operation-name: ResetAddressAttribute - operationId: GET_ResetAddressAttribute - description: 'Resets the attribute of the specified IP address. For requirements, see Using reverse DNS for email applications.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ResetAddressAttributeResult' - parameters: - - name: AllocationId - in: query - required: true - description: '[EC2-VPC] The allocation ID.' - schema: - type: string - - name: Attribute - in: query - required: true - description: The attribute of the IP address. - schema: - type: string - enum: - - domain-name - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ResetAddressAttribute - operationId: POST_ResetAddressAttribute - description: 'Resets the attribute of the specified IP address. For requirements, see Using reverse DNS for email applications.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ResetAddressAttributeResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ResetAddressAttributeRequest' - parameters: [] - /?Action=ResetEbsDefaultKmsKeyId&Version=2016-11-15: - get: - x-aws-operation-name: ResetEbsDefaultKmsKeyId - operationId: GET_ResetEbsDefaultKmsKeyId - description: '

Resets the default KMS key for EBS encryption for your account in this Region to the Amazon Web Services managed KMS key for EBS.

After resetting the default KMS key to the Amazon Web Services managed KMS key, you can continue to encrypt by a customer managed KMS key by specifying it when you create the volume. For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ResetEbsDefaultKmsKeyIdResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ResetEbsDefaultKmsKeyId - operationId: POST_ResetEbsDefaultKmsKeyId - description: '

Resets the default KMS key for EBS encryption for your account in this Region to the Amazon Web Services managed KMS key for EBS.

After resetting the default KMS key to the Amazon Web Services managed KMS key, you can continue to encrypt by a customer managed KMS key by specifying it when you create the volume. For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ResetEbsDefaultKmsKeyIdResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ResetEbsDefaultKmsKeyIdRequest' - parameters: [] - /?Action=ResetFpgaImageAttribute&Version=2016-11-15: - get: - x-aws-operation-name: ResetFpgaImageAttribute - operationId: GET_ResetFpgaImageAttribute - description: Resets the specified attribute of the specified Amazon FPGA Image (AFI) to its default value. You can only reset the load permission attribute. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ResetFpgaImageAttributeResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: FpgaImageId - in: query - required: true - description: The ID of the AFI. - schema: - type: string - - name: Attribute - in: query - required: false - description: The attribute. - schema: - type: string - enum: - - loadPermission - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ResetFpgaImageAttribute - operationId: POST_ResetFpgaImageAttribute - description: Resets the specified attribute of the specified Amazon FPGA Image (AFI) to its default value. You can only reset the load permission attribute. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/ResetFpgaImageAttributeResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ResetFpgaImageAttributeRequest' - parameters: [] - /?Action=ResetImageAttribute&Version=2016-11-15: - get: - x-aws-operation-name: ResetImageAttribute - operationId: GET_ResetImageAttribute - description: Resets an attribute of an AMI to its default value. - responses: - '200': - description: Success - parameters: - - name: Attribute - in: query - required: true - description: The attribute to reset (currently you can only reset the launch permission attribute). - schema: - type: string - enum: - - launchPermission - - name: ImageId - in: query - required: true - description: The ID of the AMI. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ResetImageAttribute - operationId: POST_ResetImageAttribute - description: Resets an attribute of an AMI to its default value. - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ResetImageAttributeRequest' - parameters: [] - /?Action=ResetInstanceAttribute&Version=2016-11-15: - get: - x-aws-operation-name: ResetInstanceAttribute - operationId: GET_ResetInstanceAttribute - description: '

Resets an attribute of an instance to its default value. To reset the kernel or ramdisk, the instance must be in a stopped state. To reset the sourceDestCheck, the instance can be either running or stopped.

The sourceDestCheck attribute controls whether source/destination checking is enabled. The default value is true, which means checking is enabled. This value must be false for a NAT instance to perform NAT. For more information, see NAT Instances in the Amazon VPC User Guide.

' - responses: - '200': - description: Success - parameters: - - name: Attribute - in: query - required: true - description: '

The attribute to reset.

You can only reset the following attributes: kernel | ramdisk | sourceDestCheck.

' - schema: - type: string - enum: - - instanceType - - kernel - - ramdisk - - userData - - disableApiTermination - - instanceInitiatedShutdownBehavior - - rootDeviceName - - blockDeviceMapping - - productCodes - - sourceDestCheck - - groupSet - - ebsOptimized - - sriovNetSupport - - enaSupport - - enclaveOptions - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: InstanceId - in: query - required: true - description: The ID of the instance. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ResetInstanceAttribute - operationId: POST_ResetInstanceAttribute - description: '

Resets an attribute of an instance to its default value. To reset the kernel or ramdisk, the instance must be in a stopped state. To reset the sourceDestCheck, the instance can be either running or stopped.

The sourceDestCheck attribute controls whether source/destination checking is enabled. The default value is true, which means checking is enabled. This value must be false for a NAT instance to perform NAT. For more information, see NAT Instances in the Amazon VPC User Guide.

' - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ResetInstanceAttributeRequest' - parameters: [] - /?Action=ResetNetworkInterfaceAttribute&Version=2016-11-15: - get: - x-aws-operation-name: ResetNetworkInterfaceAttribute - operationId: GET_ResetNetworkInterfaceAttribute - description: Resets a network interface attribute. You can specify only one attribute at a time. - responses: - '200': - description: Success - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: NetworkInterfaceId - in: query - required: true - description: The ID of the network interface. - schema: - type: string - - name: SourceDestCheck - in: query - required: false - description: The source/destination checking attribute. Resets the value to true. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ResetNetworkInterfaceAttribute - operationId: POST_ResetNetworkInterfaceAttribute - description: Resets a network interface attribute. You can specify only one attribute at a time. - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ResetNetworkInterfaceAttributeRequest' - parameters: [] - /?Action=ResetSnapshotAttribute&Version=2016-11-15: - get: - x-aws-operation-name: ResetSnapshotAttribute - operationId: GET_ResetSnapshotAttribute - description: '

Resets permission settings for the specified snapshot.

For more information about modifying snapshot permissions, see Share a snapshot in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - parameters: - - name: Attribute - in: query - required: true - description: 'The attribute to reset. Currently, only the attribute for permission to create volumes can be reset.' - schema: - type: string - enum: - - productCodes - - createVolumePermission - - name: SnapshotId - in: query - required: true - description: The ID of the snapshot. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: ResetSnapshotAttribute - operationId: POST_ResetSnapshotAttribute - description: '

Resets permission settings for the specified snapshot.

For more information about modifying snapshot permissions, see Share a snapshot in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/ResetSnapshotAttributeRequest' - parameters: [] - /?Action=RestoreAddressToClassic&Version=2016-11-15: - get: - x-aws-operation-name: RestoreAddressToClassic - operationId: GET_RestoreAddressToClassic - description: Restores an Elastic IP address that was previously moved to the EC2-VPC platform back to the EC2-Classic platform. You cannot move an Elastic IP address that was originally allocated for use in EC2-VPC. The Elastic IP address must not be associated with an instance or network interface. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/RestoreAddressToClassicResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: PublicIp - in: query - required: true - description: The Elastic IP address. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: RestoreAddressToClassic - operationId: POST_RestoreAddressToClassic - description: Restores an Elastic IP address that was previously moved to the EC2-VPC platform back to the EC2-Classic platform. You cannot move an Elastic IP address that was originally allocated for use in EC2-VPC. The Elastic IP address must not be associated with an instance or network interface. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/RestoreAddressToClassicResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/RestoreAddressToClassicRequest' - parameters: [] - /?Action=RestoreImageFromRecycleBin&Version=2016-11-15: - get: - x-aws-operation-name: RestoreImageFromRecycleBin - operationId: GET_RestoreImageFromRecycleBin - description: 'Restores an AMI from the Recycle Bin. For more information, see Recycle Bin in the Amazon Elastic Compute Cloud User Guide.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/RestoreImageFromRecycleBinResult' - parameters: - - name: ImageId - in: query - required: true - description: The ID of the AMI to restore. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: RestoreImageFromRecycleBin - operationId: POST_RestoreImageFromRecycleBin - description: 'Restores an AMI from the Recycle Bin. For more information, see Recycle Bin in the Amazon Elastic Compute Cloud User Guide.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/RestoreImageFromRecycleBinResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/RestoreImageFromRecycleBinRequest' - parameters: [] - /?Action=RestoreManagedPrefixListVersion&Version=2016-11-15: - get: - x-aws-operation-name: RestoreManagedPrefixListVersion - operationId: GET_RestoreManagedPrefixListVersion - description: Restores the entries from a previous version of a managed prefix list to a new version of the prefix list. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/RestoreManagedPrefixListVersionResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: PrefixListId - in: query - required: true - description: The ID of the prefix list. - schema: - type: string - - name: PreviousVersion - in: query - required: true - description: The version to restore. - schema: - type: integer - - name: CurrentVersion - in: query - required: true - description: The current version number for the prefix list. - schema: - type: integer - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: RestoreManagedPrefixListVersion - operationId: POST_RestoreManagedPrefixListVersion - description: Restores the entries from a previous version of a managed prefix list to a new version of the prefix list. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/RestoreManagedPrefixListVersionResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/RestoreManagedPrefixListVersionRequest' - parameters: [] - /?Action=RestoreSnapshotFromRecycleBin&Version=2016-11-15: - get: - x-aws-operation-name: RestoreSnapshotFromRecycleBin - operationId: GET_RestoreSnapshotFromRecycleBin - description: 'Restores a snapshot from the Recycle Bin. For more information, see Restore snapshots from the Recycle Bin in the Amazon Elastic Compute Cloud User Guide.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/RestoreSnapshotFromRecycleBinResult' - parameters: - - name: SnapshotId - in: query - required: true - description: The ID of the snapshot to restore. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: RestoreSnapshotFromRecycleBin - operationId: POST_RestoreSnapshotFromRecycleBin - description: 'Restores a snapshot from the Recycle Bin. For more information, see Restore snapshots from the Recycle Bin in the Amazon Elastic Compute Cloud User Guide.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/RestoreSnapshotFromRecycleBinResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/RestoreSnapshotFromRecycleBinRequest' - parameters: [] - /?Action=RestoreSnapshotTier&Version=2016-11-15: - get: - x-aws-operation-name: RestoreSnapshotTier - operationId: GET_RestoreSnapshotTier - description: '

Restores an archived Amazon EBS snapshot for use temporarily or permanently, or modifies the restore period or restore type for a snapshot that was previously temporarily restored.

For more information see Restore an archived snapshot and modify the restore period or restore type for a temporarily restored snapshot in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/RestoreSnapshotTierResult' - parameters: - - name: SnapshotId - in: query - required: true - description: The ID of the snapshot to restore. - schema: - type: string - - name: TemporaryRestoreDays - in: query - required: false - description: '

Specifies the number of days for which to temporarily restore an archived snapshot. Required for temporary restores only. The snapshot will be automatically re-archived after this period.

To temporarily restore an archived snapshot, specify the number of days and omit the PermanentRestore parameter or set it to false.

' - schema: - type: integer - - name: PermanentRestore - in: query - required: false - description: 'Indicates whether to permanently restore an archived snapshot. To permanently restore an archived snapshot, specify true and omit the RestoreSnapshotTierRequest$TemporaryRestoreDays parameter.' - schema: - type: boolean - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: RestoreSnapshotTier - operationId: POST_RestoreSnapshotTier - description: '

Restores an archived Amazon EBS snapshot for use temporarily or permanently, or modifies the restore period or restore type for a snapshot that was previously temporarily restored.

For more information see Restore an archived snapshot and modify the restore period or restore type for a temporarily restored snapshot in the Amazon Elastic Compute Cloud User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/RestoreSnapshotTierResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/RestoreSnapshotTierRequest' - parameters: [] - /?Action=RevokeClientVpnIngress&Version=2016-11-15: - get: - x-aws-operation-name: RevokeClientVpnIngress - operationId: GET_RevokeClientVpnIngress - description: 'Removes an ingress authorization rule from a Client VPN endpoint. ' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/RevokeClientVpnIngressResult' - parameters: - - name: ClientVpnEndpointId - in: query - required: true - description: The ID of the Client VPN endpoint with which the authorization rule is associated. - schema: - type: string - - name: TargetNetworkCidr - in: query - required: true - description: 'The IPv4 address range, in CIDR notation, of the network for which access is being removed.' - schema: - type: string - - name: AccessGroupId - in: query - required: false - description: 'The ID of the Active Directory group for which to revoke access. ' - schema: - type: string - - name: RevokeAllGroups - in: query - required: false - description: Indicates whether access should be revoked for all clients. - schema: - type: boolean - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: RevokeClientVpnIngress - operationId: POST_RevokeClientVpnIngress - description: 'Removes an ingress authorization rule from a Client VPN endpoint. ' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/RevokeClientVpnIngressResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/RevokeClientVpnIngressRequest' - parameters: [] - /?Action=RevokeSecurityGroupEgress&Version=2016-11-15: - get: - x-aws-operation-name: RevokeSecurityGroupEgress - operationId: GET_RevokeSecurityGroupEgress - description: '

[VPC only] Removes the specified outbound (egress) rules from a security group for EC2-VPC. This action does not apply to security groups for use in EC2-Classic.

You can specify rules using either rule IDs or security group rule properties. If you use rule properties, the values that you specify (for example, ports) must match the existing rule''s values exactly. Each rule has a protocol, from and to ports, and destination (CIDR range, security group, or prefix list). For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. If the security group rule has a description, you do not need to specify the description to revoke the rule.

[Default VPC] If the values you specify do not match the existing rule''s values, no error is returned, and the output describes the security group rules that were not revoked.

Amazon Web Services recommends that you describe the security group to verify that the rules were removed.

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/RevokeSecurityGroupEgressResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: GroupId - in: query - required: true - description: The ID of the security group. - schema: - type: string - - name: IpPermissions - in: query - required: false - description: The sets of IP permissions. You can't specify a destination security group and a CIDR IP address range in the same set of permissions. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/IpPermission' - - xml: - name: item - - name: SecurityGroupRuleId - in: query - required: false - description: The IDs of the security group rules. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - - name: CidrIp - in: query - required: false - description: Not supported. Use a set of IP permissions to specify the CIDR. - schema: - type: string - - name: FromPort - in: query - required: false - description: Not supported. Use a set of IP permissions to specify the port. - schema: - type: integer - - name: IpProtocol - in: query - required: false - description: Not supported. Use a set of IP permissions to specify the protocol name or number. - schema: - type: string - - name: ToPort - in: query - required: false - description: Not supported. Use a set of IP permissions to specify the port. - schema: - type: integer - - name: SourceSecurityGroupName - in: query - required: false - description: Not supported. Use a set of IP permissions to specify a destination security group. - schema: - type: string - - name: SourceSecurityGroupOwnerId - in: query - required: false - description: Not supported. Use a set of IP permissions to specify a destination security group. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: RevokeSecurityGroupEgress - operationId: POST_RevokeSecurityGroupEgress - description: '

[VPC only] Removes the specified outbound (egress) rules from a security group for EC2-VPC. This action does not apply to security groups for use in EC2-Classic.

You can specify rules using either rule IDs or security group rule properties. If you use rule properties, the values that you specify (for example, ports) must match the existing rule''s values exactly. Each rule has a protocol, from and to ports, and destination (CIDR range, security group, or prefix list). For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. If the security group rule has a description, you do not need to specify the description to revoke the rule.

[Default VPC] If the values you specify do not match the existing rule''s values, no error is returned, and the output describes the security group rules that were not revoked.

Amazon Web Services recommends that you describe the security group to verify that the rules were removed.

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/RevokeSecurityGroupEgressResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/RevokeSecurityGroupEgressRequest' - parameters: [] - /?Action=RevokeSecurityGroupIngress&Version=2016-11-15: - get: - x-aws-operation-name: RevokeSecurityGroupIngress - operationId: GET_RevokeSecurityGroupIngress - description: '

Removes the specified inbound (ingress) rules from a security group.

You can specify rules using either rule IDs or security group rule properties. If you use rule properties, the values that you specify (for example, ports) must match the existing rule''s values exactly. Each rule has a protocol, from and to ports, and source (CIDR range, security group, or prefix list). For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. If the security group rule has a description, you do not need to specify the description to revoke the rule.

[EC2-Classic, default VPC] If the values you specify do not match the existing rule''s values, no error is returned, and the output describes the security group rules that were not revoked.

Amazon Web Services recommends that you describe the security group to verify that the rules were removed.

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/RevokeSecurityGroupIngressResult' - parameters: - - name: CidrIp - in: query - required: false - description: The CIDR IP address range. You can't specify this parameter when specifying a source security group. - schema: - type: string - - name: FromPort - in: query - required: false - description: 'The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.' - schema: - type: integer - - name: GroupId - in: query - required: false - description: 'The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.' - schema: - type: string - - name: GroupName - in: query - required: false - description: '[EC2-Classic, default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request.' - schema: - type: string - - name: IpPermissions - in: query - required: false - description: The sets of IP permissions. You can't specify a source security group and a CIDR IP address range in the same set of permissions. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/IpPermission' - - xml: - name: item - - name: IpProtocol - in: query - required: false - description: 'The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.' - schema: - type: string - - name: SourceSecurityGroupName - in: query - required: false - description: '[EC2-Classic, default VPC] The name of the source security group. You can''t specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. For EC2-VPC, the source security group must be in the same VPC. To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead.' - schema: - type: string - - name: SourceSecurityGroupOwnerId - in: query - required: false - description: '[EC2-Classic] The Amazon Web Services account ID of the source security group, if the source security group is in a different account. You can''t specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead.' - schema: - type: string - - name: ToPort - in: query - required: false - description: 'The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.' - schema: - type: integer - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: SecurityGroupRuleId - in: query - required: false - description: The IDs of the security group rules. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: RevokeSecurityGroupIngress - operationId: POST_RevokeSecurityGroupIngress - description: '

Removes the specified inbound (ingress) rules from a security group.

You can specify rules using either rule IDs or security group rule properties. If you use rule properties, the values that you specify (for example, ports) must match the existing rule''s values exactly. Each rule has a protocol, from and to ports, and source (CIDR range, security group, or prefix list). For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. If the security group rule has a description, you do not need to specify the description to revoke the rule.

[EC2-Classic, default VPC] If the values you specify do not match the existing rule''s values, no error is returned, and the output describes the security group rules that were not revoked.

Amazon Web Services recommends that you describe the security group to verify that the rules were removed.

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/RevokeSecurityGroupIngressResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/RevokeSecurityGroupIngressRequest' - parameters: [] - /?Action=RunInstances&Version=2016-11-15: - get: - x-aws-operation-name: RunInstances - operationId: GET_RunInstances - description: '

Launches the specified number of instances using an AMI for which you have permissions.

You can specify a number of options, or leave the default options. The following rules apply:

  • [EC2-VPC] If you don''t specify a subnet ID, we choose a default subnet from your default VPC for you. If you don''t have a default VPC, you must specify a subnet ID in the request.

  • [EC2-Classic] If don''t specify an Availability Zone, we choose one for you.

  • Some instance types must be launched into a VPC. If you do not have a default VPC, or if you do not specify a subnet ID, the request fails. For more information, see Instance types available only in a VPC.

  • [EC2-VPC] All instances have a network interface with a primary private IPv4 address. If you don''t specify this address, we choose one from the IPv4 range of your subnet.

  • Not all instance types support IPv6 addresses. For more information, see Instance types.

  • If you don''t specify a security group ID, we use the default security group. For more information, see Security groups.

  • If any of the AMIs have a product code attached for which the user has not subscribed, the request fails.

You can create a launch template, which is a resource that contains the parameters to launch an instance. When you launch an instance using RunInstances, you can specify the launch template instead of specifying the launch parameters.

To ensure faster instance launches, break up large requests into smaller batches. For example, create five separate launch requests for 100 instances each instead of one launch request for 500 instances.

An instance is ready for you to use when it''s in the running state. You can check the state of your instance using DescribeInstances. You can tag instances and EBS volumes during launch, after launch, or both. For more information, see CreateTags and Tagging your Amazon EC2 resources.

Linux instances have access to the public key of the key pair at boot. You can use this key to provide secure access to the instance. Amazon EC2 public images use this feature to provide secure access without passwords. For more information, see Key pairs.

For troubleshooting, see What to do if an instance immediately terminates, and Troubleshooting connecting to your instance.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/Reservation' - parameters: - - name: BlockDeviceMapping - in: query - required: false - description: 'The block device mapping, which defines the EBS volumes and instance store volumes to attach to the instance at launch. For more information, see Block device mappings in the Amazon EC2 User Guide.' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/BlockDeviceMapping' - - xml: - name: BlockDeviceMapping - - name: ImageId - in: query - required: false - description: The ID of the AMI. An AMI ID is required to launch an instance and must be specified here or in a launch template. - schema: - type: string - - name: InstanceType - in: query - required: false - description: '

The instance type. For more information, see Instance types in the Amazon EC2 User Guide.

Default: m1.small

' - schema: - type: string - enum: - - a1.medium - - a1.large - - a1.xlarge - - a1.2xlarge - - a1.4xlarge - - a1.metal - - c1.medium - - c1.xlarge - - c3.large - - c3.xlarge - - c3.2xlarge - - c3.4xlarge - - c3.8xlarge - - c4.large - - c4.xlarge - - c4.2xlarge - - c4.4xlarge - - c4.8xlarge - - c5.large - - c5.xlarge - - c5.2xlarge - - c5.4xlarge - - c5.9xlarge - - c5.12xlarge - - c5.18xlarge - - c5.24xlarge - - c5.metal - - c5a.large - - c5a.xlarge - - c5a.2xlarge - - c5a.4xlarge - - c5a.8xlarge - - c5a.12xlarge - - c5a.16xlarge - - c5a.24xlarge - - c5ad.large - - c5ad.xlarge - - c5ad.2xlarge - - c5ad.4xlarge - - c5ad.8xlarge - - c5ad.12xlarge - - c5ad.16xlarge - - c5ad.24xlarge - - c5d.large - - c5d.xlarge - - c5d.2xlarge - - c5d.4xlarge - - c5d.9xlarge - - c5d.12xlarge - - c5d.18xlarge - - c5d.24xlarge - - c5d.metal - - c5n.large - - c5n.xlarge - - c5n.2xlarge - - c5n.4xlarge - - c5n.9xlarge - - c5n.18xlarge - - c5n.metal - - c6g.medium - - c6g.large - - c6g.xlarge - - c6g.2xlarge - - c6g.4xlarge - - c6g.8xlarge - - c6g.12xlarge - - c6g.16xlarge - - c6g.metal - - c6gd.medium - - c6gd.large - - c6gd.xlarge - - c6gd.2xlarge - - c6gd.4xlarge - - c6gd.8xlarge - - c6gd.12xlarge - - c6gd.16xlarge - - c6gd.metal - - c6gn.medium - - c6gn.large - - c6gn.xlarge - - c6gn.2xlarge - - c6gn.4xlarge - - c6gn.8xlarge - - c6gn.12xlarge - - c6gn.16xlarge - - c6i.large - - c6i.xlarge - - c6i.2xlarge - - c6i.4xlarge - - c6i.8xlarge - - c6i.12xlarge - - c6i.16xlarge - - c6i.24xlarge - - c6i.32xlarge - - c6i.metal - - cc1.4xlarge - - cc2.8xlarge - - cg1.4xlarge - - cr1.8xlarge - - d2.xlarge - - d2.2xlarge - - d2.4xlarge - - d2.8xlarge - - d3.xlarge - - d3.2xlarge - - d3.4xlarge - - d3.8xlarge - - d3en.xlarge - - d3en.2xlarge - - d3en.4xlarge - - d3en.6xlarge - - d3en.8xlarge - - d3en.12xlarge - - dl1.24xlarge - - f1.2xlarge - - f1.4xlarge - - f1.16xlarge - - g2.2xlarge - - g2.8xlarge - - g3.4xlarge - - g3.8xlarge - - g3.16xlarge - - g3s.xlarge - - g4ad.xlarge - - g4ad.2xlarge - - g4ad.4xlarge - - g4ad.8xlarge - - g4ad.16xlarge - - g4dn.xlarge - - g4dn.2xlarge - - g4dn.4xlarge - - g4dn.8xlarge - - g4dn.12xlarge - - g4dn.16xlarge - - g4dn.metal - - g5.xlarge - - g5.2xlarge - - g5.4xlarge - - g5.8xlarge - - g5.12xlarge - - g5.16xlarge - - g5.24xlarge - - g5.48xlarge - - g5g.xlarge - - g5g.2xlarge - - g5g.4xlarge - - g5g.8xlarge - - g5g.16xlarge - - g5g.metal - - hi1.4xlarge - - hpc6a.48xlarge - - hs1.8xlarge - - h1.2xlarge - - h1.4xlarge - - h1.8xlarge - - h1.16xlarge - - i2.xlarge - - i2.2xlarge - - i2.4xlarge - - i2.8xlarge - - i3.large - - i3.xlarge - - i3.2xlarge - - i3.4xlarge - - i3.8xlarge - - i3.16xlarge - - i3.metal - - i3en.large - - i3en.xlarge - - i3en.2xlarge - - i3en.3xlarge - - i3en.6xlarge - - i3en.12xlarge - - i3en.24xlarge - - i3en.metal - - im4gn.large - - im4gn.xlarge - - im4gn.2xlarge - - im4gn.4xlarge - - im4gn.8xlarge - - im4gn.16xlarge - - inf1.xlarge - - inf1.2xlarge - - inf1.6xlarge - - inf1.24xlarge - - is4gen.medium - - is4gen.large - - is4gen.xlarge - - is4gen.2xlarge - - is4gen.4xlarge - - is4gen.8xlarge - - m1.small - - m1.medium - - m1.large - - m1.xlarge - - m2.xlarge - - m2.2xlarge - - m2.4xlarge - - m3.medium - - m3.large - - m3.xlarge - - m3.2xlarge - - m4.large - - m4.xlarge - - m4.2xlarge - - m4.4xlarge - - m4.10xlarge - - m4.16xlarge - - m5.large - - m5.xlarge - - m5.2xlarge - - m5.4xlarge - - m5.8xlarge - - m5.12xlarge - - m5.16xlarge - - m5.24xlarge - - m5.metal - - m5a.large - - m5a.xlarge - - m5a.2xlarge - - m5a.4xlarge - - m5a.8xlarge - - m5a.12xlarge - - m5a.16xlarge - - m5a.24xlarge - - m5ad.large - - m5ad.xlarge - - m5ad.2xlarge - - m5ad.4xlarge - - m5ad.8xlarge - - m5ad.12xlarge - - m5ad.16xlarge - - m5ad.24xlarge - - m5d.large - - m5d.xlarge - - m5d.2xlarge - - m5d.4xlarge - - m5d.8xlarge - - m5d.12xlarge - - m5d.16xlarge - - m5d.24xlarge - - m5d.metal - - m5dn.large - - m5dn.xlarge - - m5dn.2xlarge - - m5dn.4xlarge - - m5dn.8xlarge - - m5dn.12xlarge - - m5dn.16xlarge - - m5dn.24xlarge - - m5dn.metal - - m5n.large - - m5n.xlarge - - m5n.2xlarge - - m5n.4xlarge - - m5n.8xlarge - - m5n.12xlarge - - m5n.16xlarge - - m5n.24xlarge - - m5n.metal - - m5zn.large - - m5zn.xlarge - - m5zn.2xlarge - - m5zn.3xlarge - - m5zn.6xlarge - - m5zn.12xlarge - - m5zn.metal - - m6a.large - - m6a.xlarge - - m6a.2xlarge - - m6a.4xlarge - - m6a.8xlarge - - m6a.12xlarge - - m6a.16xlarge - - m6a.24xlarge - - m6a.32xlarge - - m6a.48xlarge - - m6g.metal - - m6g.medium - - m6g.large - - m6g.xlarge - - m6g.2xlarge - - m6g.4xlarge - - m6g.8xlarge - - m6g.12xlarge - - m6g.16xlarge - - m6gd.metal - - m6gd.medium - - m6gd.large - - m6gd.xlarge - - m6gd.2xlarge - - m6gd.4xlarge - - m6gd.8xlarge - - m6gd.12xlarge - - m6gd.16xlarge - - m6i.large - - m6i.xlarge - - m6i.2xlarge - - m6i.4xlarge - - m6i.8xlarge - - m6i.12xlarge - - m6i.16xlarge - - m6i.24xlarge - - m6i.32xlarge - - m6i.metal - - mac1.metal - - p2.xlarge - - p2.8xlarge - - p2.16xlarge - - p3.2xlarge - - p3.8xlarge - - p3.16xlarge - - p3dn.24xlarge - - p4d.24xlarge - - r3.large - - r3.xlarge - - r3.2xlarge - - r3.4xlarge - - r3.8xlarge - - r4.large - - r4.xlarge - - r4.2xlarge - - r4.4xlarge - - r4.8xlarge - - r4.16xlarge - - r5.large - - r5.xlarge - - r5.2xlarge - - r5.4xlarge - - r5.8xlarge - - r5.12xlarge - - r5.16xlarge - - r5.24xlarge - - r5.metal - - r5a.large - - r5a.xlarge - - r5a.2xlarge - - r5a.4xlarge - - r5a.8xlarge - - r5a.12xlarge - - r5a.16xlarge - - r5a.24xlarge - - r5ad.large - - r5ad.xlarge - - r5ad.2xlarge - - r5ad.4xlarge - - r5ad.8xlarge - - r5ad.12xlarge - - r5ad.16xlarge - - r5ad.24xlarge - - r5b.large - - r5b.xlarge - - r5b.2xlarge - - r5b.4xlarge - - r5b.8xlarge - - r5b.12xlarge - - r5b.16xlarge - - r5b.24xlarge - - r5b.metal - - r5d.large - - r5d.xlarge - - r5d.2xlarge - - r5d.4xlarge - - r5d.8xlarge - - r5d.12xlarge - - r5d.16xlarge - - r5d.24xlarge - - r5d.metal - - r5dn.large - - r5dn.xlarge - - r5dn.2xlarge - - r5dn.4xlarge - - r5dn.8xlarge - - r5dn.12xlarge - - r5dn.16xlarge - - r5dn.24xlarge - - r5dn.metal - - r5n.large - - r5n.xlarge - - r5n.2xlarge - - r5n.4xlarge - - r5n.8xlarge - - r5n.12xlarge - - r5n.16xlarge - - r5n.24xlarge - - r5n.metal - - r6g.medium - - r6g.large - - r6g.xlarge - - r6g.2xlarge - - r6g.4xlarge - - r6g.8xlarge - - r6g.12xlarge - - r6g.16xlarge - - r6g.metal - - r6gd.medium - - r6gd.large - - r6gd.xlarge - - r6gd.2xlarge - - r6gd.4xlarge - - r6gd.8xlarge - - r6gd.12xlarge - - r6gd.16xlarge - - r6gd.metal - - r6i.large - - r6i.xlarge - - r6i.2xlarge - - r6i.4xlarge - - r6i.8xlarge - - r6i.12xlarge - - r6i.16xlarge - - r6i.24xlarge - - r6i.32xlarge - - r6i.metal - - t1.micro - - t2.nano - - t2.micro - - t2.small - - t2.medium - - t2.large - - t2.xlarge - - t2.2xlarge - - t3.nano - - t3.micro - - t3.small - - t3.medium - - t3.large - - t3.xlarge - - t3.2xlarge - - t3a.nano - - t3a.micro - - t3a.small - - t3a.medium - - t3a.large - - t3a.xlarge - - t3a.2xlarge - - t4g.nano - - t4g.micro - - t4g.small - - t4g.medium - - t4g.large - - t4g.xlarge - - t4g.2xlarge - - u-6tb1.56xlarge - - u-6tb1.112xlarge - - u-9tb1.112xlarge - - u-12tb1.112xlarge - - u-6tb1.metal - - u-9tb1.metal - - u-12tb1.metal - - u-18tb1.metal - - u-24tb1.metal - - vt1.3xlarge - - vt1.6xlarge - - vt1.24xlarge - - x1.16xlarge - - x1.32xlarge - - x1e.xlarge - - x1e.2xlarge - - x1e.4xlarge - - x1e.8xlarge - - x1e.16xlarge - - x1e.32xlarge - - x2iezn.2xlarge - - x2iezn.4xlarge - - x2iezn.6xlarge - - x2iezn.8xlarge - - x2iezn.12xlarge - - x2iezn.metal - - x2gd.medium - - x2gd.large - - x2gd.xlarge - - x2gd.2xlarge - - x2gd.4xlarge - - x2gd.8xlarge - - x2gd.12xlarge - - x2gd.16xlarge - - x2gd.metal - - z1d.large - - z1d.xlarge - - z1d.2xlarge - - z1d.3xlarge - - z1d.6xlarge - - z1d.12xlarge - - z1d.metal - - x2idn.16xlarge - - x2idn.24xlarge - - x2idn.32xlarge - - x2iedn.xlarge - - x2iedn.2xlarge - - x2iedn.4xlarge - - x2iedn.8xlarge - - x2iedn.16xlarge - - x2iedn.24xlarge - - x2iedn.32xlarge - - c6a.large - - c6a.xlarge - - c6a.2xlarge - - c6a.4xlarge - - c6a.8xlarge - - c6a.12xlarge - - c6a.16xlarge - - c6a.24xlarge - - c6a.32xlarge - - c6a.48xlarge - - c6a.metal - - m6a.metal - - i4i.large - - i4i.xlarge - - i4i.2xlarge - - i4i.4xlarge - - i4i.8xlarge - - i4i.16xlarge - - i4i.32xlarge - - name: Ipv6AddressCount - in: query - required: false - description: '

[EC2-VPC] The number of IPv6 addresses to associate with the primary network interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you''ve specified a minimum number of instances to launch.

You cannot specify this option and the network interfaces option in the same request.

' - schema: - type: integer - - name: Ipv6Address - in: query - required: false - description: '

[EC2-VPC] The IPv6 addresses from the range of the subnet to associate with the primary network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you''ve specified a minimum number of instances to launch.

You cannot specify this option and the network interfaces option in the same request.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/InstanceIpv6Address' - - xml: - name: item - - name: KernelId - in: query - required: false - description: '

The ID of the kernel.

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon EC2 User Guide.

' - schema: - type: string - - name: KeyName - in: query - required: false - description: '

The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.

If you do not specify a key pair, you can''t connect to the instance unless you choose an AMI that is configured to allow users another way to log in.

' - schema: - type: string - - name: MaxCount - in: query - required: true - description: '

The maximum number of instances to launch. If you specify more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches the largest possible number of instances above MinCount.

Constraints: Between 1 and the maximum number you''re allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 FAQ.

' - schema: - type: integer - - name: MinCount - in: query - required: true - description: '

The minimum number of instances to launch. If you specify a minimum that is more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches no instances.

Constraints: Between 1 and the maximum number you''re allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.

' - schema: - type: integer - - name: Monitoring - in: query - required: false - description: Specifies whether detailed monitoring is enabled for the instance. - schema: - type: object - required: - - Enabled - properties: - enabled: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.' - description: Describes the monitoring of an instance. - - name: Placement - in: query - required: false - description: The placement for the instance. - schema: - type: object - properties: - availabilityZone: - allOf: - - $ref: '#/components/schemas/String' - - description: '

The Availability Zone of the instance.

If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region.

This parameter is not supported by CreateFleet.

' - affinity: - allOf: - - $ref: '#/components/schemas/String' - - description: '

The affinity setting for the instance on the Dedicated Host. This parameter is not supported for the ImportInstance command.

This parameter is not supported by CreateFleet.

' - groupName: - allOf: - - $ref: '#/components/schemas/PlacementGroupName' - - description: The name of the placement group the instance is in. - partitionNumber: - allOf: - - $ref: '#/components/schemas/Integer' - - description: '

The number of the partition that the instance is in. Valid only if the placement group strategy is set to partition.

This parameter is not supported by CreateFleet.

' - hostId: - allOf: - - $ref: '#/components/schemas/String' - - description: '

The ID of the Dedicated Host on which the instance resides. This parameter is not supported for the ImportInstance command.

This parameter is not supported by CreateFleet.

' - tenancy: - allOf: - - $ref: '#/components/schemas/Tenancy' - - description: '

The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for the ImportInstance command.

This parameter is not supported by CreateFleet.

T3 instances that use the unlimited CPU credit option do not support host tenancy.

' - spreadDomain: - allOf: - - $ref: '#/components/schemas/String' - - description: '

Reserved for future use.

This parameter is not supported by CreateFleet.

' - hostResourceGroupArn: - allOf: - - $ref: '#/components/schemas/String' - - description: '

The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host.

This parameter is not supported by CreateFleet.

' - description: Describes the placement of an instance. - - name: RamdiskId - in: query - required: false - description: '

The ID of the RAM disk to select. Some kernels require additional drivers at launch. Check the kernel requirements for information about whether you need to specify a RAM disk. To find kernel requirements, go to the Amazon Web Services Resource Center and search for the kernel ID.

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon EC2 User Guide.

' - schema: - type: string - - name: SecurityGroupId - in: query - required: false - description: '

The IDs of the security groups. You can create a security group using CreateSecurityGroup.

If you specify a network interface, you must specify any security groups as part of the network interface.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/SecurityGroupId' - - xml: - name: SecurityGroupId - - name: SecurityGroup - in: query - required: false - description: '

[EC2-Classic, default VPC] The names of the security groups. For a nondefault VPC, you must use security group IDs instead.

If you specify a network interface, you must specify any security groups as part of the network interface.

Default: Amazon EC2 uses the default security group.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/SecurityGroupName' - - xml: - name: SecurityGroup - - name: SubnetId - in: query - required: false - description: '

[EC2-VPC] The ID of the subnet to launch the instance into.

If you specify a network interface, you must specify any subnets as part of the network interface.

' - schema: - type: string - - name: UserData - in: query - required: false - description: 'The user data script to make available to the instance. For more information, see Run commands on your Linux instance at launch and Run commands on your Windows instance at launch. If you are using a command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text. User data is limited to 16 KB.' - schema: - type: string - format: password - - name: AdditionalInfo - in: query - required: false - description: Reserved. - schema: - type: string - - name: ClientToken - in: query - required: false - description: '

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.

For more information, see Ensuring Idempotency.

Constraints: Maximum 64 ASCII characters

' - schema: - type: string - - name: DisableApiTermination - in: query - required: false - description: '

If you set this parameter to true, you can''t terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after launch, use ModifyInstanceAttribute. Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate, you can terminate the instance by running the shutdown command from the instance.

Default: false

' - schema: - type: boolean - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: EbsOptimized - in: query - required: false - description: '

Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn''t available with all instance types. Additional usage charges apply when using an EBS-optimized instance.

Default: false

' - schema: - type: boolean - - name: IamInstanceProfile - in: query - required: false - description: The name or Amazon Resource Name (ARN) of an IAM instance profile. - schema: - type: object - properties: - arn: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Resource Name (ARN) of the instance profile. - name: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of the instance profile. - description: Describes an IAM instance profile. - - name: InstanceInitiatedShutdownBehavior - in: query - required: false - description: '

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

Default: stop

' - schema: - type: string - enum: - - stop - - terminate - - name: NetworkInterface - in: query - required: false - description: 'The network interfaces to associate with the instance. If you specify a network interface, you must specify any security groups and subnets as part of the network interface.' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/InstanceNetworkInterfaceSpecification' - - xml: - name: item - - name: PrivateIpAddress - in: query - required: false - description: '

[EC2-VPC] The primary IPv4 address. You must specify a value from the IPv4 address range of the subnet.

Only one private IP address can be designated as primary. You can''t specify this option if you''ve specified the option to designate a private IP address as the primary IP address in a network interface specification. You cannot specify this option if you''re launching more than one instance in the request.

You cannot specify this option and the network interfaces option in the same request.

' - schema: - type: string - - name: ElasticGpuSpecification - in: query - required: false - description: 'An elastic GPU to associate with the instance. An Elastic GPU is a GPU resource that you can attach to your Windows instance to accelerate the graphics performance of your applications. For more information, see Amazon EC2 Elastic GPUs in the Amazon EC2 User Guide.' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/ElasticGpuSpecification' - - xml: - name: item - - name: ElasticInferenceAccelerator - in: query - required: false - description:

An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads.

You cannot specify accelerators from different generations in the same request.

- schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/ElasticInferenceAccelerator' - - xml: - name: item - - name: TagSpecification - in: query - required: false - description: 'The tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified tags are applied to all instances or volumes that are created during launch. To tag a resource after it has been created, see CreateTags.' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - - name: LaunchTemplate - in: query - required: false - description: 'The launch template to use to launch the instances. Any parameters that you specify in RunInstances override the same parameters in the launch template. You can specify either the name or ID of a launch template, but not both.' - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: '

The version number of the launch template.

Default: The default version for the launch template.

' - description: 'The launch template to use. You must specify either the launch template ID or launch template name in the request, but not both.' - - name: InstanceMarketOptions - in: query - required: false - description: '

The market (purchasing) option for the instances.

For RunInstances, persistent Spot Instance requests are only supported when InstanceInterruptionBehavior is set to either hibernate or stop.

' - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/SpotMarketOptions' - - description: The options for Spot Instances. - description: Describes the market (purchasing) option for the instances. - - name: CreditSpecification - in: query - required: false - description: '

The credit option for CPU usage of the burstable performance instance. Valid values are standard and unlimited. To change this attribute after launch, use ModifyInstanceCreditSpecification. For more information, see Burstable performance instances in the Amazon EC2 User Guide.

Default: standard (T2 instances) or unlimited (T3/T3a instances)

For T3 instances with host tenancy, only standard is supported.

' - schema: - type: object - required: - - CpuCredits - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The credit option for CPU usage of a T2, T3, or T3a instance. Valid values are standard and unlimited.' - description: 'The credit option for CPU usage of a T2, T3, or T3a instance.' - - name: CpuOptions - in: query - required: false - description: 'The CPU options for the instance. For more information, see Optimize CPU options in the Amazon EC2 User Guide.' - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The number of threads per CPU core. To disable multithreading for the instance, specify a value of 1. Otherwise, specify the default value of 2.' - description: The CPU options for the instance. Both the core count and threads per core must be specified in the request. - - name: CapacityReservationSpecification - in: query - required: false - description: 'Information about the Capacity Reservation targeting option. If you do not specify this parameter, the instance''s Capacity Reservation preference defaults to open, which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).' - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/CapacityReservationTarget' - - description: Information about the target Capacity Reservation or Capacity Reservation group. - description: '

Describes an instance''s Capacity Reservation targeting option. You can specify only one parameter at a time. If you specify CapacityReservationPreference and CapacityReservationTarget, the request fails.

Use the CapacityReservationPreference parameter to configure the instance to run as an On-Demand Instance or to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). Use the CapacityReservationTarget parameter to explicitly target a specific Capacity Reservation or a Capacity Reservation group.

' - - name: HibernationOptions - in: query - required: false - description: '

Indicates whether an instance is enabled for hibernation. For more information, see Hibernate your instance in the Amazon EC2 User Guide.

You can''t enable hibernation and Amazon Web Services Nitro Enclaves on the same instance.

' - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: '

If you set this parameter to true, your instance is enabled for hibernation.

Default: false

' - description: 'Indicates whether your instance is configured for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites. For more information, see Hibernate your instance in the Amazon EC2 User Guide.' - - name: LicenseSpecification - in: query - required: false - description: The license configurations. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/LicenseConfigurationRequest' - - xml: - name: item - - name: MetadataOptions - in: query - required: false - description: 'The metadata options for the instance. For more information, see Instance metadata and user data.' - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/InstanceMetadataTagsState' - - description: '

Set to enabled to allow access to instance tags from the instance metadata. Set to disabled to turn off access to instance tags from the instance metadata. For more information, see Work with instance tags using the instance metadata.

Default: disabled

' - description: The metadata options for the instance. - - name: EnclaveOptions - in: query - required: false - description: '

Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more information, see What is Amazon Web Services Nitro Enclaves? in the Amazon Web Services Nitro Enclaves User Guide.

You can''t enable Amazon Web Services Nitro Enclaves and hibernation on the same instance.

' - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'To enable the instance for Amazon Web Services Nitro Enclaves, set this parameter to true.' - description: 'Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more information, see What is Amazon Web Services Nitro Enclaves? in the Amazon Web Services Nitro Enclaves User Guide.' - - name: PrivateDnsNameOptions - in: query - required: false - description: The options for the instance hostname. The default values are inherited from the subnet. - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records. - description: Describes the options for instance hostnames. - - name: MaintenanceOptions - in: query - required: false - description: The maintenance and recovery options for the instance. - schema: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/InstanceAutoRecoveryState' - - description: 'Disables the automatic recovery behavior of your instance or sets it to default. For more information, see Simplified automatic recovery.' - description: The maintenance options for the instance. - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: RunInstances - operationId: POST_RunInstances - description: '

Launches the specified number of instances using an AMI for which you have permissions.

You can specify a number of options, or leave the default options. The following rules apply:

  • [EC2-VPC] If you don''t specify a subnet ID, we choose a default subnet from your default VPC for you. If you don''t have a default VPC, you must specify a subnet ID in the request.

  • [EC2-Classic] If don''t specify an Availability Zone, we choose one for you.

  • Some instance types must be launched into a VPC. If you do not have a default VPC, or if you do not specify a subnet ID, the request fails. For more information, see Instance types available only in a VPC.

  • [EC2-VPC] All instances have a network interface with a primary private IPv4 address. If you don''t specify this address, we choose one from the IPv4 range of your subnet.

  • Not all instance types support IPv6 addresses. For more information, see Instance types.

  • If you don''t specify a security group ID, we use the default security group. For more information, see Security groups.

  • If any of the AMIs have a product code attached for which the user has not subscribed, the request fails.

You can create a launch template, which is a resource that contains the parameters to launch an instance. When you launch an instance using RunInstances, you can specify the launch template instead of specifying the launch parameters.

To ensure faster instance launches, break up large requests into smaller batches. For example, create five separate launch requests for 100 instances each instead of one launch request for 500 instances.

An instance is ready for you to use when it''s in the running state. You can check the state of your instance using DescribeInstances. You can tag instances and EBS volumes during launch, after launch, or both. For more information, see CreateTags and Tagging your Amazon EC2 resources.

Linux instances have access to the public key of the key pair at boot. You can use this key to provide secure access to the instance. Amazon EC2 public images use this feature to provide secure access without passwords. For more information, see Key pairs.

For troubleshooting, see What to do if an instance immediately terminates, and Troubleshooting connecting to your instance.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/Reservation' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/RunInstancesRequest' - parameters: [] - /?Action=RunScheduledInstances&Version=2016-11-15: - get: - x-aws-operation-name: RunScheduledInstances - operationId: GET_RunScheduledInstances - description: '

Launches the specified Scheduled Instances.

Before you can launch a Scheduled Instance, you must purchase it and obtain an identifier using PurchaseScheduledInstances.

You must launch a Scheduled Instance during its scheduled time period. You can''t stop or reboot a Scheduled Instance, but you can terminate it as needed. If you terminate a Scheduled Instance before the current scheduled time period ends, you can launch it again after a few minutes. For more information, see Scheduled Instances in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/RunScheduledInstancesResult' - parameters: - - name: ClientToken - in: query - required: false - description: 'Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see Ensuring Idempotency.' - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: InstanceCount - in: query - required: false - description: '

The number of instances.

Default: 1

' - schema: - type: integer - - name: LaunchSpecification - in: query - required: true - description: 'The launch specification. You must match the instance type, Availability Zone, network, and platform of the schedule that you purchased.' - schema: - type: object - required: - - ImageId - properties: - BlockDeviceMapping: - allOf: - - $ref: '#/components/schemas/ScheduledInstancesMonitoring' - - description: Enable or disable monitoring for the instances. - NetworkInterface: - allOf: - - $ref: '#/components/schemas/RamdiskId' - - description: The ID of the RAM disk. - SecurityGroupId: - allOf: - - $ref: '#/components/schemas/String' - - description: The base64-encoded MIME user data. - description: '

Describes the launch specification for a Scheduled Instance.

If you are launching the Scheduled Instance in EC2-VPC, you must specify the ID of the subnet. You can specify the subnet using either SubnetId or NetworkInterface.

' - - name: ScheduledInstanceId - in: query - required: true - description: The Scheduled Instance ID. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: RunScheduledInstances - operationId: POST_RunScheduledInstances - description: '

Launches the specified Scheduled Instances.

Before you can launch a Scheduled Instance, you must purchase it and obtain an identifier using PurchaseScheduledInstances.

You must launch a Scheduled Instance during its scheduled time period. You can''t stop or reboot a Scheduled Instance, but you can terminate it as needed. If you terminate a Scheduled Instance before the current scheduled time period ends, you can launch it again after a few minutes. For more information, see Scheduled Instances in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/RunScheduledInstancesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/RunScheduledInstancesRequest' - parameters: [] - /?Action=SearchLocalGatewayRoutes&Version=2016-11-15: - get: - x-aws-operation-name: SearchLocalGatewayRoutes - operationId: GET_SearchLocalGatewayRoutes - description: Searches for routes in the specified local gateway route table. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/SearchLocalGatewayRoutesResult' - parameters: - - name: LocalGatewayRouteTableId - in: query - required: true - description: The ID of the local gateway route table. - schema: - type: string - - name: Filter - in: query - required: false - description: '

One or more filters.

  • route-search.exact-match - The exact match of the specified filter.

  • route-search.longest-prefix-match - The longest prefix that matches the route.

  • route-search.subnet-of-match - The routes with a subnet that match the specified CIDR filter.

  • route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29.

  • state - The state of the route.

  • type - The route type.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - schema: - type: integer - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: SearchLocalGatewayRoutes - operationId: POST_SearchLocalGatewayRoutes - description: Searches for routes in the specified local gateway route table. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/SearchLocalGatewayRoutesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/SearchLocalGatewayRoutesRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=SearchTransitGatewayMulticastGroups&Version=2016-11-15: - get: - x-aws-operation-name: SearchTransitGatewayMulticastGroups - operationId: GET_SearchTransitGatewayMulticastGroups - description: Searches one or more transit gateway multicast groups and returns the group membership information. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/SearchTransitGatewayMulticastGroupsResult' - parameters: - - name: TransitGatewayMulticastDomainId - in: query - required: false - description: The ID of the transit gateway multicast domain. - schema: - type: string - - name: Filter - in: query - required: false - description: '

One or more filters. The possible values are:

  • group-ip-address - The IP address of the transit gateway multicast group.

  • is-group-member - The resource is a group member. Valid values are true | false.

  • is-group-source - The resource is a group source. Valid values are true | false.

  • member-type - The member type. Valid values are igmp | static.

  • resource-id - The ID of the resource.

  • resource-type - The type of resource. Valid values are vpc | vpn | direct-connect-gateway | tgw-peering.

  • source-type - The source type. Valid values are igmp | static.

  • subnet-id - The ID of the subnet.

  • transit-gateway-attachment-id - The id of the transit gateway attachment.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: MaxResults - in: query - required: false - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - schema: - type: integer - minimum: 5 - maximum: 1000 - - name: NextToken - in: query - required: false - description: The token for the next page of results. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: SearchTransitGatewayMulticastGroups - operationId: POST_SearchTransitGatewayMulticastGroups - description: Searches one or more transit gateway multicast groups and returns the group membership information. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/SearchTransitGatewayMulticastGroupsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/SearchTransitGatewayMulticastGroupsRequest' - parameters: - - name: MaxResults - in: query - schema: - type: string - description: Pagination limit - required: false - - name: NextToken - in: query - schema: - type: string - description: Pagination token - required: false - /?Action=SearchTransitGatewayRoutes&Version=2016-11-15: - get: - x-aws-operation-name: SearchTransitGatewayRoutes - operationId: GET_SearchTransitGatewayRoutes - description: Searches for routes in the specified transit gateway route table. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/SearchTransitGatewayRoutesResult' - parameters: - - name: TransitGatewayRouteTableId - in: query - required: true - description: The ID of the transit gateway route table. - schema: - type: string - - name: Filter - in: query - required: true - description: '

One or more filters. The possible values are:

  • attachment.transit-gateway-attachment-id- The id of the transit gateway attachment.

  • attachment.resource-id - The resource id of the transit gateway attachment.

  • attachment.resource-type - The attachment resource type. Valid values are vpc | vpn | direct-connect-gateway | peering | connect.

  • prefix-list-id - The ID of the prefix list.

  • route-search.exact-match - The exact match of the specified filter.

  • route-search.longest-prefix-match - The longest prefix that matches the route.

  • route-search.subnet-of-match - The routes with a subnet that match the specified CIDR filter.

  • route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29.

  • state - The state of the route (active | blackhole).

  • type - The type of route (propagated | static).

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - - name: MaxResults - in: query - required: false - description: The maximum number of routes to return. - schema: - type: integer - minimum: 5 - maximum: 1000 - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: SearchTransitGatewayRoutes - operationId: POST_SearchTransitGatewayRoutes - description: Searches for routes in the specified transit gateway route table. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/SearchTransitGatewayRoutesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/SearchTransitGatewayRoutesRequest' - parameters: [] - /?Action=SendDiagnosticInterrupt&Version=2016-11-15: - get: - x-aws-operation-name: SendDiagnosticInterrupt - operationId: GET_SendDiagnosticInterrupt - description: '

Sends a diagnostic interrupt to the specified Amazon EC2 instance to trigger a kernel panic (on Linux instances), or a blue screen/stop error (on Windows instances). For instances based on Intel and AMD processors, the interrupt is received as a non-maskable interrupt (NMI).

In general, the operating system crashes and reboots when a kernel panic or stop error is triggered. The operating system can also be configured to perform diagnostic tasks, such as generating a memory dump file, loading a secondary kernel, or obtaining a call trace.

Before sending a diagnostic interrupt to your instance, ensure that its operating system is configured to perform the required diagnostic tasks.

For more information about configuring your operating system to generate a crash dump when a kernel panic or stop error occurs, see Send a diagnostic interrupt (for advanced users) (Linux instances) or Send a diagnostic interrupt (for advanced users) (Windows instances).

' - responses: - '200': - description: Success - parameters: - - name: InstanceId - in: query - required: true - description: The ID of the instance. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: SendDiagnosticInterrupt - operationId: POST_SendDiagnosticInterrupt - description: '

Sends a diagnostic interrupt to the specified Amazon EC2 instance to trigger a kernel panic (on Linux instances), or a blue screen/stop error (on Windows instances). For instances based on Intel and AMD processors, the interrupt is received as a non-maskable interrupt (NMI).

In general, the operating system crashes and reboots when a kernel panic or stop error is triggered. The operating system can also be configured to perform diagnostic tasks, such as generating a memory dump file, loading a secondary kernel, or obtaining a call trace.

Before sending a diagnostic interrupt to your instance, ensure that its operating system is configured to perform the required diagnostic tasks.

For more information about configuring your operating system to generate a crash dump when a kernel panic or stop error occurs, see Send a diagnostic interrupt (for advanced users) (Linux instances) or Send a diagnostic interrupt (for advanced users) (Windows instances).

' - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/SendDiagnosticInterruptRequest' - parameters: [] - /?Action=StartInstances&Version=2016-11-15: - get: - x-aws-operation-name: StartInstances - operationId: GET_StartInstances - description: '

Starts an Amazon EBS-backed instance that you''ve previously stopped.

Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for instance usage. However, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. Every time you start your instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage.

Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.

Performing this operation on an instance that uses an instance store as its root device returns an error.

If you attempt to start a T3 instance with host tenancy and the unlimted CPU credit option, the request fails. The unlimited CPU credit option is not supported on Dedicated Hosts. Before you start the instance, either change its CPU credit option to standard, or change its tenancy to default or dedicated.

For more information, see Stop and start your instance in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/StartInstancesResult' - parameters: - - name: InstanceId - in: query - required: true - description: The IDs of the instances. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/InstanceId' - - xml: - name: InstanceId - - name: AdditionalInfo - in: query - required: false - description: Reserved. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: StartInstances - operationId: POST_StartInstances - description: '

Starts an Amazon EBS-backed instance that you''ve previously stopped.

Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for instance usage. However, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. Every time you start your instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage.

Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.

Performing this operation on an instance that uses an instance store as its root device returns an error.

If you attempt to start a T3 instance with host tenancy and the unlimted CPU credit option, the request fails. The unlimited CPU credit option is not supported on Dedicated Hosts. Before you start the instance, either change its CPU credit option to standard, or change its tenancy to default or dedicated.

For more information, see Stop and start your instance in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/StartInstancesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/StartInstancesRequest' - parameters: [] - /?Action=StartNetworkInsightsAccessScopeAnalysis&Version=2016-11-15: - get: - x-aws-operation-name: StartNetworkInsightsAccessScopeAnalysis - operationId: GET_StartNetworkInsightsAccessScopeAnalysis - description: Starts analyzing the specified Network Access Scope. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/StartNetworkInsightsAccessScopeAnalysisResult' - parameters: - - name: NetworkInsightsAccessScopeId - in: query - required: true - description: The ID of the Network Access Scope. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: TagSpecification - in: query - required: false - description: The tags to apply. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - - name: ClientToken - in: query - required: true - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.' - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: StartNetworkInsightsAccessScopeAnalysis - operationId: POST_StartNetworkInsightsAccessScopeAnalysis - description: Starts analyzing the specified Network Access Scope. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/StartNetworkInsightsAccessScopeAnalysisResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/StartNetworkInsightsAccessScopeAnalysisRequest' - parameters: [] - /?Action=StartNetworkInsightsAnalysis&Version=2016-11-15: - get: - x-aws-operation-name: StartNetworkInsightsAnalysis - operationId: GET_StartNetworkInsightsAnalysis - description: 'Starts analyzing the specified path. If the path is reachable, the operation returns the shortest feasible path.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/StartNetworkInsightsAnalysisResult' - parameters: - - name: NetworkInsightsPathId - in: query - required: true - description: The ID of the path. - schema: - type: string - - name: FilterInArn - in: query - required: false - description: The Amazon Resource Names (ARN) of the resources that the path must traverse. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/ResourceArn' - - xml: - name: item - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: TagSpecification - in: query - required: false - description: The tags to apply. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - - name: ClientToken - in: query - required: true - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.' - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: StartNetworkInsightsAnalysis - operationId: POST_StartNetworkInsightsAnalysis - description: 'Starts analyzing the specified path. If the path is reachable, the operation returns the shortest feasible path.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/StartNetworkInsightsAnalysisResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/StartNetworkInsightsAnalysisRequest' - parameters: [] - /?Action=StartVpcEndpointServicePrivateDnsVerification&Version=2016-11-15: - get: - x-aws-operation-name: StartVpcEndpointServicePrivateDnsVerification - operationId: GET_StartVpcEndpointServicePrivateDnsVerification - description: '

Initiates the verification process to prove that the service provider owns the private DNS name domain for the endpoint service.

The service provider must successfully perform the verification before the consumer can use the name to access the service.

Before the service provider runs this command, they must add a record to the DNS server.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/StartVpcEndpointServicePrivateDnsVerificationResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: ServiceId - in: query - required: true - description: The ID of the endpoint service. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: StartVpcEndpointServicePrivateDnsVerification - operationId: POST_StartVpcEndpointServicePrivateDnsVerification - description: '

Initiates the verification process to prove that the service provider owns the private DNS name domain for the endpoint service.

The service provider must successfully perform the verification before the consumer can use the name to access the service.

Before the service provider runs this command, they must add a record to the DNS server.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/StartVpcEndpointServicePrivateDnsVerificationResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/StartVpcEndpointServicePrivateDnsVerificationRequest' - parameters: [] - /?Action=StopInstances&Version=2016-11-15: - get: - x-aws-operation-name: StopInstances - operationId: GET_StopInstances - description: '

Stops an Amazon EBS-backed instance. For more information, see Stop and start your instance in the Amazon EC2 User Guide.

You can use the Stop action to hibernate an instance if the instance is enabled for hibernation and it meets the hibernation prerequisites. For more information, see Hibernate your instance in the Amazon EC2 User Guide.

We don''t charge usage for a stopped instance, or data transfer fees; however, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. Every time you start your instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage.

You can''t stop or hibernate instance store-backed instances. You can''t use the Stop action to hibernate Spot Instances, but you can specify that Amazon EC2 should hibernate Spot Instances when they are interrupted. For more information, see Hibernating interrupted Spot Instances in the Amazon EC2 User Guide.

When you stop or hibernate an instance, we shut it down. You can restart your instance at any time. Before stopping or hibernating an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM, but hibernating an instance does preserve data stored in RAM. If an instance cannot hibernate successfully, a normal shutdown occurs.

Stopping and hibernating an instance is different to rebooting or terminating it. For example, when you stop or hibernate an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between rebooting, stopping, hibernating, and terminating instances, see Instance lifecycle in the Amazon EC2 User Guide.

When you stop an instance, we attempt to shut it down forcibly after a short while. If your instance appears stuck in the stopping state after a period of time, there may be an issue with the underlying host computer. For more information, see Troubleshoot stopping your instance in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/StopInstancesResult' - parameters: - - name: InstanceId - in: query - required: true - description: The IDs of the instances. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/InstanceId' - - xml: - name: InstanceId - - name: Hibernate - in: query - required: false - description: '

Hibernates the instance if the instance was enabled for hibernation at launch. If the instance cannot hibernate successfully, a normal shutdown occurs. For more information, see Hibernate your instance in the Amazon EC2 User Guide.

Default: false

' - schema: - type: boolean - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: Force - in: query - required: false - description: '

Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances.

Default: false

' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: StopInstances - operationId: POST_StopInstances - description: '

Stops an Amazon EBS-backed instance. For more information, see Stop and start your instance in the Amazon EC2 User Guide.

You can use the Stop action to hibernate an instance if the instance is enabled for hibernation and it meets the hibernation prerequisites. For more information, see Hibernate your instance in the Amazon EC2 User Guide.

We don''t charge usage for a stopped instance, or data transfer fees; however, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. Every time you start your instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage.

You can''t stop or hibernate instance store-backed instances. You can''t use the Stop action to hibernate Spot Instances, but you can specify that Amazon EC2 should hibernate Spot Instances when they are interrupted. For more information, see Hibernating interrupted Spot Instances in the Amazon EC2 User Guide.

When you stop or hibernate an instance, we shut it down. You can restart your instance at any time. Before stopping or hibernating an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM, but hibernating an instance does preserve data stored in RAM. If an instance cannot hibernate successfully, a normal shutdown occurs.

Stopping and hibernating an instance is different to rebooting or terminating it. For example, when you stop or hibernate an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between rebooting, stopping, hibernating, and terminating instances, see Instance lifecycle in the Amazon EC2 User Guide.

When you stop an instance, we attempt to shut it down forcibly after a short while. If your instance appears stuck in the stopping state after a period of time, there may be an issue with the underlying host computer. For more information, see Troubleshoot stopping your instance in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/StopInstancesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/StopInstancesRequest' - parameters: [] - /?Action=TerminateClientVpnConnections&Version=2016-11-15: - get: - x-aws-operation-name: TerminateClientVpnConnections - operationId: GET_TerminateClientVpnConnections - description: 'Terminates active Client VPN endpoint connections. This action can be used to terminate a specific client connection, or up to five connections established by a specific user.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/TerminateClientVpnConnectionsResult' - parameters: - - name: ClientVpnEndpointId - in: query - required: true - description: The ID of the Client VPN endpoint to which the client is connected. - schema: - type: string - - name: ConnectionId - in: query - required: false - description: The ID of the client connection to be terminated. - schema: - type: string - - name: Username - in: query - required: false - description: The name of the user who initiated the connection. Use this option to terminate all active connections for the specified user. This option can only be used if the user has established up to five connections. - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: TerminateClientVpnConnections - operationId: POST_TerminateClientVpnConnections - description: 'Terminates active Client VPN endpoint connections. This action can be used to terminate a specific client connection, or up to five connections established by a specific user.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/TerminateClientVpnConnectionsResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/TerminateClientVpnConnectionsRequest' - parameters: [] - /?Action=TerminateInstances&Version=2016-11-15: - get: - x-aws-operation-name: TerminateInstances - operationId: GET_TerminateInstances - description: '

Shuts down the specified instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds.

If you specify multiple instances and the request fails (for example, because of a single incorrect instance ID), none of the instances are terminated.

If you terminate multiple instances across multiple Availability Zones, and one or more of the specified instances are enabled for termination protection, the request fails with the following results:

  • The specified instances that are in the same Availability Zone as the protected instance are not terminated.

  • The specified instances that are in different Availability Zones, where no other specified instances are protected, are successfully terminated.

For example, say you have the following instances:

  • Instance A: us-east-1a; Not protected

  • Instance B: us-east-1a; Not protected

  • Instance C: us-east-1b; Protected

  • Instance D: us-east-1b; not protected

If you attempt to terminate all of these instances in the same request, the request reports failure with the following results:

  • Instance A and Instance B are successfully terminated because none of the specified instances in us-east-1a are enabled for termination protection.

  • Instance C and Instance D fail to terminate because at least one of the specified instances in us-east-1b (Instance C) is enabled for termination protection.

Terminated instances remain visible after termination (for approximately one hour).

By default, Amazon EC2 deletes all EBS volumes that were attached when the instance launched. Volumes attached after instance launch continue running.

You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, any attached EBS volumes with the DeleteOnTermination block device mapping parameter set to true are automatically deleted. For more information about the differences between stopping and terminating instances, see Instance lifecycle in the Amazon EC2 User Guide.

For more information about troubleshooting, see Troubleshooting terminating your instance in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/TerminateInstancesResult' - parameters: - - name: InstanceId - in: query - required: true - description: '

The IDs of the instances.

Constraints: Up to 1000 instance IDs. We recommend breaking up this request into smaller batches.

' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/InstanceId' - - xml: - name: InstanceId - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: TerminateInstances - operationId: POST_TerminateInstances - description: '

Shuts down the specified instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds.

If you specify multiple instances and the request fails (for example, because of a single incorrect instance ID), none of the instances are terminated.

If you terminate multiple instances across multiple Availability Zones, and one or more of the specified instances are enabled for termination protection, the request fails with the following results:

  • The specified instances that are in the same Availability Zone as the protected instance are not terminated.

  • The specified instances that are in different Availability Zones, where no other specified instances are protected, are successfully terminated.

For example, say you have the following instances:

  • Instance A: us-east-1a; Not protected

  • Instance B: us-east-1a; Not protected

  • Instance C: us-east-1b; Protected

  • Instance D: us-east-1b; not protected

If you attempt to terminate all of these instances in the same request, the request reports failure with the following results:

  • Instance A and Instance B are successfully terminated because none of the specified instances in us-east-1a are enabled for termination protection.

  • Instance C and Instance D fail to terminate because at least one of the specified instances in us-east-1b (Instance C) is enabled for termination protection.

Terminated instances remain visible after termination (for approximately one hour).

By default, Amazon EC2 deletes all EBS volumes that were attached when the instance launched. Volumes attached after instance launch continue running.

You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, any attached EBS volumes with the DeleteOnTermination block device mapping parameter set to true are automatically deleted. For more information about the differences between stopping and terminating instances, see Instance lifecycle in the Amazon EC2 User Guide.

For more information about troubleshooting, see Troubleshooting terminating your instance in the Amazon EC2 User Guide.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/TerminateInstancesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/TerminateInstancesRequest' - parameters: [] - /?Action=UnassignIpv6Addresses&Version=2016-11-15: - get: - x-aws-operation-name: UnassignIpv6Addresses - operationId: GET_UnassignIpv6Addresses - description: Unassigns one or more IPv6 addresses IPv4 Prefix Delegation prefixes from a network interface. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/UnassignIpv6AddressesResult' - parameters: - - name: Ipv6Addresses - in: query - required: false - description: The IPv6 addresses to unassign from the network interface. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - - name: Ipv6Prefix - in: query - required: false - description: One or more IPv6 prefixes to unassign from the network interface. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - - name: NetworkInterfaceId - in: query - required: true - description: The ID of the network interface. - schema: - type: string - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: UnassignIpv6Addresses - operationId: POST_UnassignIpv6Addresses - description: Unassigns one or more IPv6 addresses IPv4 Prefix Delegation prefixes from a network interface. - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/UnassignIpv6AddressesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/UnassignIpv6AddressesRequest' - parameters: [] - /?Action=UnassignPrivateIpAddresses&Version=2016-11-15: - get: - x-aws-operation-name: UnassignPrivateIpAddresses - operationId: GET_UnassignPrivateIpAddresses - description: 'Unassigns one or more secondary private IP addresses, or IPv4 Prefix Delegation prefixes from a network interface.' - responses: - '200': - description: Success - parameters: - - name: NetworkInterfaceId - in: query - required: true - description: The ID of the network interface. - schema: - type: string - - name: PrivateIpAddress - in: query - required: false - description: The secondary private IP addresses to unassign from the network interface. You can specify this option multiple times to unassign more than one IP address. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: PrivateIpAddress - - name: Ipv4Prefix - in: query - required: false - description: The IPv4 prefixes to unassign from the network interface. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: UnassignPrivateIpAddresses - operationId: POST_UnassignPrivateIpAddresses - description: 'Unassigns one or more secondary private IP addresses, or IPv4 Prefix Delegation prefixes from a network interface.' - responses: - '200': - description: Success - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/UnassignPrivateIpAddressesRequest' - parameters: [] - /?Action=UnmonitorInstances&Version=2016-11-15: - get: - x-aws-operation-name: UnmonitorInstances - operationId: GET_UnmonitorInstances - description: 'Disables detailed monitoring for a running instance. For more information, see Monitoring your instances and volumes in the Amazon EC2 User Guide.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/UnmonitorInstancesResult' - parameters: - - name: InstanceId - in: query - required: true - description: The IDs of the instances. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/InstanceId' - - xml: - name: InstanceId - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: UnmonitorInstances - operationId: POST_UnmonitorInstances - description: 'Disables detailed monitoring for a running instance. For more information, see Monitoring your instances and volumes in the Amazon EC2 User Guide.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/UnmonitorInstancesResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/UnmonitorInstancesRequest' - parameters: [] - /?Action=UpdateSecurityGroupRuleDescriptionsEgress&Version=2016-11-15: - get: - x-aws-operation-name: UpdateSecurityGroupRuleDescriptionsEgress - operationId: GET_UpdateSecurityGroupRuleDescriptionsEgress - description: '[VPC only] Updates the description of an egress (outbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously. You can remove a description for a security group rule by omitting the description parameter in the request.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/UpdateSecurityGroupRuleDescriptionsEgressResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: GroupId - in: query - required: false - description: 'The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.' - schema: - type: string - - name: GroupName - in: query - required: false - description: '[Default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request.' - schema: - type: string - - name: IpPermissions - in: query - required: false - description: The IP permissions for the security group rule. You must specify either the IP permissions or the description. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/IpPermission' - - xml: - name: item - - name: SecurityGroupRuleDescription - in: query - required: false - description: The description for the egress security group rules. You must specify either the description or the IP permissions. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/SecurityGroupRuleDescription' - - xml: - name: item - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: UpdateSecurityGroupRuleDescriptionsEgress - operationId: POST_UpdateSecurityGroupRuleDescriptionsEgress - description: '[VPC only] Updates the description of an egress (outbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously. You can remove a description for a security group rule by omitting the description parameter in the request.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/UpdateSecurityGroupRuleDescriptionsEgressResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/UpdateSecurityGroupRuleDescriptionsEgressRequest' - parameters: [] - /?Action=UpdateSecurityGroupRuleDescriptionsIngress&Version=2016-11-15: - get: - x-aws-operation-name: UpdateSecurityGroupRuleDescriptionsIngress - operationId: GET_UpdateSecurityGroupRuleDescriptionsIngress - description: 'Updates the description of an ingress (inbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously. You can remove a description for a security group rule by omitting the description parameter in the request.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/UpdateSecurityGroupRuleDescriptionsIngressResult' - parameters: - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - - name: GroupId - in: query - required: false - description: 'The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.' - schema: - type: string - - name: GroupName - in: query - required: false - description: '[EC2-Classic, default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request.' - schema: - type: string - - name: IpPermissions - in: query - required: false - description: The IP permissions for the security group rule. You must specify either IP permissions or a description. - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/IpPermission' - - xml: - name: item - - name: SecurityGroupRuleDescription - in: query - required: false - description: '[VPC only] The description for the ingress security group rules. You must specify either a description or IP permissions.' - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/SecurityGroupRuleDescription' - - xml: - name: item - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: UpdateSecurityGroupRuleDescriptionsIngress - operationId: POST_UpdateSecurityGroupRuleDescriptionsIngress - description: 'Updates the description of an ingress (inbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously. You can remove a description for a security group rule by omitting the description parameter in the request.' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/UpdateSecurityGroupRuleDescriptionsIngressResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/UpdateSecurityGroupRuleDescriptionsIngressRequest' - parameters: [] - /?Action=WithdrawByoipCidr&Version=2016-11-15: - get: - x-aws-operation-name: WithdrawByoipCidr - operationId: GET_WithdrawByoipCidr - description: '

Stops advertising an address range that is provisioned as an address pool.

You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time.

It can take a few minutes before traffic to the specified addresses stops routing to Amazon Web Services because of BGP propagation delays.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/WithdrawByoipCidrResult' - parameters: - - name: Cidr - in: query - required: true - description: 'The address range, in CIDR notation.' - schema: - type: string - - name: DryRun - in: query - required: false - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - schema: - type: boolean - parameters: - - $ref: '#/components/parameters/X-Amz-Content-Sha256' - - $ref: '#/components/parameters/X-Amz-Date' - - $ref: '#/components/parameters/X-Amz-Algorithm' - - $ref: '#/components/parameters/X-Amz-Credential' - - $ref: '#/components/parameters/X-Amz-Security-Token' - - $ref: '#/components/parameters/X-Amz-Signature' - - $ref: '#/components/parameters/X-Amz-SignedHeaders' - post: - x-aws-operation-name: WithdrawByoipCidr - operationId: POST_WithdrawByoipCidr - description: '

Stops advertising an address range that is provisioned as an address pool.

You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time.

It can take a few minutes before traffic to the specified addresses stops routing to Amazon Web Services because of BGP propagation delays.

' - responses: - '200': - description: Success - content: - text/xml: - schema: - $ref: '#/components/schemas/WithdrawByoipCidrResult' - requestBody: - content: - text/xml: - schema: - $ref: '#/components/schemas/WithdrawByoipCidrRequest' - parameters: [] -components: - x-stackQL-resources: - account_attributes: - name: account_attributes - methods: - account_attributes_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeAccountAttributes&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/accountAttributeSet/item - openAPIDocKey: '200' - id: aws.ec2_api.account_attributes - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/account_attributes/methods/account_attributes_Describe' - update: [] - title: account_attributes - address: - name: address - methods: - address_Allocate: - operation: - $ref: '#/paths/~1?Action=AllocateAddress&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - address_Associate: - operation: - $ref: '#/paths/~1?Action=AssociateAddress&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - address_Disassociate: - operation: - $ref: '#/paths/~1?Action=DisassociateAddress&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - address_Release: - operation: - $ref: '#/paths/~1?Action=ReleaseAddress&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - id: aws.ec2_api.address - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: address - address_attribute: - name: address_attribute - methods: - address_attribute_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyAddressAttribute&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - address_attribute_Reset: - operation: - $ref: '#/paths/~1?Action=ResetAddressAttribute&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.address_attribute - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: address_attribute - address_to_classic: - name: address_to_classic - methods: - address_to_classic_Restore: - operation: - $ref: '#/paths/~1?Action=RestoreAddressToClassic&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.address_to_classic - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: address_to_classic - address_to_vpc: - name: address_to_vpc - methods: - address_to_vpc_Move: - operation: - $ref: '#/paths/~1?Action=MoveAddressToVpc&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.address_to_vpc - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: address_to_vpc - addresses: - name: addresses - methods: - addresses_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeAddresses&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/addressesSet/item - openAPIDocKey: '200' - id: aws.ec2_api.addresses - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/addresses/methods/addresses_Describe' - update: [] - title: addresses - addresses_attribute: - name: addresses_attribute - methods: - addresses_attribute_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeAddressesAttribute&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/addressSet/item - openAPIDocKey: '200' - id: aws.ec2_api.addresses_attribute - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/addresses_attribute/methods/addresses_attribute_Describe' - update: [] - title: addresses_attribute - aggregate_id_format: - name: aggregate_id_format - methods: - aggregate_id_format_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeAggregateIdFormat&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/statusSet/item - openAPIDocKey: '200' - id: aws.ec2_api.aggregate_id_format - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/aggregate_id_format/methods/aggregate_id_format_Describe' - update: [] - title: aggregate_id_format - associated_enclave_certificate_iam_roles: - name: associated_enclave_certificate_iam_roles - methods: - associated_enclave_certificate_iam_roles_Get: - operation: - $ref: '#/paths/~1?Action=GetAssociatedEnclaveCertificateIamRoles&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/associatedRoleSet/item - openAPIDocKey: '200' - id: aws.ec2_api.associated_enclave_certificate_iam_roles - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/associated_enclave_certificate_iam_roles/methods/associated_enclave_certificate_iam_roles_Get' - update: [] - title: associated_enclave_certificate_iam_roles - associated_ipv6_pool_cidrs: - name: associated_ipv6_pool_cidrs - methods: - associated_ipv6_pool_cidrs_Get: - operation: - $ref: '#/paths/~1?Action=GetAssociatedIpv6PoolCidrs&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/ipv6CidrAssociationSet/item - openAPIDocKey: '200' - id: aws.ec2_api.associated_ipv6_pool_cidrs - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/associated_ipv6_pool_cidrs/methods/associated_ipv6_pool_cidrs_Get' - update: [] - title: associated_ipv6_pool_cidrs - availability_zone_group: - name: availability_zone_group - methods: - availability_zone_group_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyAvailabilityZoneGroup&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.availability_zone_group - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: availability_zone_group - availability_zones: - name: availability_zones - methods: - availability_zones_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeAvailabilityZones&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/availabilityZoneInfo/item - openAPIDocKey: '200' - id: aws.ec2_api.availability_zones - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/availability_zones/methods/availability_zones_Describe' - update: [] - title: availability_zones - bundle_tasks: - name: bundle_tasks - methods: - bundle_task_Cancel: - operation: - $ref: '#/paths/~1?Action=CancelBundleTask&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - bundle_tasks_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeBundleTasks&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/bundleInstanceTasksSet/item - openAPIDocKey: '200' - id: aws.ec2_api.bundle_tasks - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/bundle_tasks/methods/bundle_tasks_Describe' - update: [] - title: bundle_tasks - byoip_cidr_to_ipam: - name: byoip_cidr_to_ipam - methods: - byoip_cidr_to_ipam_Move: - operation: - $ref: '#/paths/~1?Action=MoveByoipCidrToIpam&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.byoip_cidr_to_ipam - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: byoip_cidr_to_ipam - byoip_cidrs: - name: byoip_cidrs - methods: - byoip_cidr_Advertise: - operation: - $ref: '#/paths/~1?Action=AdvertiseByoipCidr&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - byoip_cidr_Deprovision: - operation: - $ref: '#/paths/~1?Action=DeprovisionByoipCidr&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - byoip_cidr_Provision: - operation: - $ref: '#/paths/~1?Action=ProvisionByoipCidr&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - byoip_cidr_Withdraw: - operation: - $ref: '#/paths/~1?Action=WithdrawByoipCidr&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - byoip_cidrs_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeByoipCidrs&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/byoipCidrSet/item - openAPIDocKey: '200' - id: aws.ec2_api.byoip_cidrs - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/byoip_cidrs/methods/byoip_cidrs_Describe' - update: [] - title: byoip_cidrs - capacity_reservation_fleets: - name: capacity_reservation_fleets - methods: - capacity_reservation_fleet_Create: - operation: - $ref: '#/paths/~1?Action=CreateCapacityReservationFleet&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - capacity_reservation_fleet_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyCapacityReservationFleet&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - capacity_reservation_fleets_Cancel: - operation: - $ref: '#/paths/~1?Action=CancelCapacityReservationFleets&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - capacity_reservation_fleets_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeCapacityReservationFleets&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/capacityReservationFleetSet/item - openAPIDocKey: '200' - id: aws.ec2_api.capacity_reservation_fleets - sqlVerbs: - delete: [] - insert: - - $ref: '#/components/x-stackQL-resources/capacity_reservation_fleets/methods/capacity_reservation_fleet_Create' - select: - - $ref: '#/components/x-stackQL-resources/capacity_reservation_fleets/methods/capacity_reservation_fleets_Describe' - update: [] - title: capacity_reservation_fleets - capacity_reservation_usage: - name: capacity_reservation_usage - methods: - capacity_reservation_usage_Get: - operation: - $ref: '#/paths/~1?Action=GetCapacityReservationUsage&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - id: aws.ec2_api.capacity_reservation_usage - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/capacity_reservation_usage/methods/capacity_reservation_usage_Get' - update: [] - title: capacity_reservation_usage - capacity_reservations: - name: capacity_reservations - methods: - capacity_reservation_Cancel: - operation: - $ref: '#/paths/~1?Action=CancelCapacityReservation&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - capacity_reservation_Create: - operation: - $ref: '#/paths/~1?Action=CreateCapacityReservation&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - capacity_reservation_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyCapacityReservation&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - capacity_reservations_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeCapacityReservations&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/capacityReservationSet/item - openAPIDocKey: '200' - id: aws.ec2_api.capacity_reservations - sqlVerbs: - delete: [] - insert: - - $ref: '#/components/x-stackQL-resources/capacity_reservations/methods/capacity_reservation_Create' - select: - - $ref: '#/components/x-stackQL-resources/capacity_reservations/methods/capacity_reservations_Describe' - update: [] - title: capacity_reservations - carrier_gateways: - name: carrier_gateways - methods: - carrier_gateway_Create: - operation: - $ref: '#/paths/~1?Action=CreateCarrierGateway&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - carrier_gateway_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteCarrierGateway&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - carrier_gateways_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeCarrierGateways&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/carrierGatewaySet/item - openAPIDocKey: '200' - id: aws.ec2_api.carrier_gateways - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/carrier_gateways/methods/carrier_gateway_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/carrier_gateways/methods/carrier_gateway_Create' - select: - - $ref: '#/components/x-stackQL-resources/carrier_gateways/methods/carrier_gateways_Describe' - update: [] - title: carrier_gateways - classic_link_instances: - name: classic_link_instances - methods: - classic_link_instances_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeClassicLinkInstances&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/instancesSet/item - openAPIDocKey: '200' - id: aws.ec2_api.classic_link_instances - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/classic_link_instances/methods/classic_link_instances_Describe' - update: [] - title: classic_link_instances - classic_link_vpc: - name: classic_link_vpc - methods: - classic_link_vpc_Attach: - operation: - $ref: '#/paths/~1?Action=AttachClassicLinkVpc&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - classic_link_vpc_Detach: - operation: - $ref: '#/paths/~1?Action=DetachClassicLinkVpc&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.classic_link_vpc - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: classic_link_vpc - client_vpn_authorization_rules: - name: client_vpn_authorization_rules - methods: - client_vpn_authorization_rules_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeClientVpnAuthorizationRules&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/authorizationRule/item - openAPIDocKey: '200' - id: aws.ec2_api.client_vpn_authorization_rules - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/client_vpn_authorization_rules/methods/client_vpn_authorization_rules_Describe' - update: [] - title: client_vpn_authorization_rules - client_vpn_client_certificate_revocation_list: - name: client_vpn_client_certificate_revocation_list - methods: - client_vpn_client_certificate_revocation_list_Export: - operation: - $ref: '#/paths/~1?Action=ExportClientVpnClientCertificateRevocationList&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - client_vpn_client_certificate_revocation_list_Import: - operation: - $ref: '#/paths/~1?Action=ImportClientVpnClientCertificateRevocationList&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.client_vpn_client_certificate_revocation_list - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: client_vpn_client_certificate_revocation_list - client_vpn_client_configuration: - name: client_vpn_client_configuration - methods: - client_vpn_client_configuration_Export: - operation: - $ref: '#/paths/~1?Action=ExportClientVpnClientConfiguration&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.client_vpn_client_configuration - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: client_vpn_client_configuration - client_vpn_connections: - name: client_vpn_connections - methods: - client_vpn_connections_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeClientVpnConnections&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/connections/item - openAPIDocKey: '200' - client_vpn_connections_Terminate: - operation: - $ref: '#/paths/~1?Action=TerminateClientVpnConnections&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.client_vpn_connections - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/client_vpn_connections/methods/client_vpn_connections_Describe' - update: [] - title: client_vpn_connections - client_vpn_endpoints: - name: client_vpn_endpoints - methods: - client_vpn_endpoint_Create: - operation: - $ref: '#/paths/~1?Action=CreateClientVpnEndpoint&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - client_vpn_endpoint_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteClientVpnEndpoint&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - client_vpn_endpoint_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyClientVpnEndpoint&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - client_vpn_endpoints_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeClientVpnEndpoints&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/clientVpnEndpoint/item - openAPIDocKey: '200' - id: aws.ec2_api.client_vpn_endpoints - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/client_vpn_endpoints/methods/client_vpn_endpoint_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/client_vpn_endpoints/methods/client_vpn_endpoint_Create' - select: - - $ref: '#/components/x-stackQL-resources/client_vpn_endpoints/methods/client_vpn_endpoints_Describe' - update: [] - title: client_vpn_endpoints - client_vpn_ingress: - name: client_vpn_ingress - methods: - client_vpn_ingress_Authorize: - operation: - $ref: '#/paths/~1?Action=AuthorizeClientVpnIngress&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - client_vpn_ingress_Revoke: - operation: - $ref: '#/paths/~1?Action=RevokeClientVpnIngress&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.client_vpn_ingress - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: client_vpn_ingress - client_vpn_routes: - name: client_vpn_routes - methods: - client_vpn_route_Create: - operation: - $ref: '#/paths/~1?Action=CreateClientVpnRoute&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - client_vpn_route_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteClientVpnRoute&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - client_vpn_routes_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeClientVpnRoutes&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/routes/item - openAPIDocKey: '200' - id: aws.ec2_api.client_vpn_routes - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/client_vpn_routes/methods/client_vpn_route_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/client_vpn_routes/methods/client_vpn_route_Create' - select: - - $ref: '#/components/x-stackQL-resources/client_vpn_routes/methods/client_vpn_routes_Describe' - update: [] - title: client_vpn_routes - client_vpn_target_networks: - name: client_vpn_target_networks - methods: - client_vpn_target_network_Associate: - operation: - $ref: '#/paths/~1?Action=AssociateClientVpnTargetNetwork&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - client_vpn_target_network_Disassociate: - operation: - $ref: '#/paths/~1?Action=DisassociateClientVpnTargetNetwork&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - client_vpn_target_networks_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeClientVpnTargetNetworks&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/clientVpnTargetNetworks/item - openAPIDocKey: '200' - id: aws.ec2_api.client_vpn_target_networks - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/client_vpn_target_networks/methods/client_vpn_target_networks_Describe' - update: [] - title: client_vpn_target_networks - coip_pool_usage: - name: coip_pool_usage - methods: - coip_pool_usage_Get: - operation: - $ref: '#/paths/~1?Action=GetCoipPoolUsage&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/coipAddressUsageSet/item - openAPIDocKey: '200' - id: aws.ec2_api.coip_pool_usage - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/coip_pool_usage/methods/coip_pool_usage_Get' - update: [] - title: coip_pool_usage - coip_pools: - name: coip_pools - methods: - coip_pools_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeCoipPools&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/coipPoolSet/item - openAPIDocKey: '200' - id: aws.ec2_api.coip_pools - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/coip_pools/methods/coip_pools_Describe' - update: [] - title: coip_pools - console_output: - name: console_output - methods: - console_output_Get: - operation: - $ref: '#/paths/~1?Action=GetConsoleOutput&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - id: aws.ec2_api.console_output - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/console_output/methods/console_output_Get' - update: [] - title: console_output - console_screenshot: - name: console_screenshot - methods: - console_screenshot_Get: - operation: - $ref: '#/paths/~1?Action=GetConsoleScreenshot&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - id: aws.ec2_api.console_screenshot - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/console_screenshot/methods/console_screenshot_Get' - update: [] - title: console_screenshot - conversion_tasks: - name: conversion_tasks - methods: - conversion_task_Cancel: - operation: - $ref: '#/paths/~1?Action=CancelConversionTask&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - conversion_tasks_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeConversionTasks&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/conversionTasks/item - openAPIDocKey: '200' - id: aws.ec2_api.conversion_tasks - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/conversion_tasks/methods/conversion_tasks_Describe' - update: [] - title: conversion_tasks - customer_gateways: - name: customer_gateways - methods: - customer_gateway_Create: - operation: - $ref: '#/paths/~1?Action=CreateCustomerGateway&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - customer_gateway_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteCustomerGateway&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - customer_gateways_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeCustomerGateways&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/customerGatewaySet/item - openAPIDocKey: '200' - id: aws.ec2_api.customer_gateways - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/customer_gateways/methods/customer_gateway_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/customer_gateways/methods/customer_gateway_Create' - select: - - $ref: '#/components/x-stackQL-resources/customer_gateways/methods/customer_gateways_Describe' - update: [] - title: customer_gateways - default_credit_specification: - name: default_credit_specification - methods: - default_credit_specification_Get: - operation: - $ref: '#/paths/~1?Action=GetDefaultCreditSpecification&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/instanceFamilyCreditSpecification - openAPIDocKey: '200' - default_credit_specification_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyDefaultCreditSpecification&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.default_credit_specification - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/default_credit_specification/methods/default_credit_specification_Get' - update: [] - title: default_credit_specification - default_subnet: - name: default_subnet - methods: - default_subnet_Create: - operation: - $ref: '#/paths/~1?Action=CreateDefaultSubnet&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.default_subnet - sqlVerbs: - delete: [] - insert: - - $ref: '#/components/x-stackQL-resources/default_subnet/methods/default_subnet_Create' - select: [] - update: [] - title: default_subnet - default_vpc: - name: default_vpc - methods: - default_vpc_Create: - operation: - $ref: '#/paths/~1?Action=CreateDefaultVpc&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.default_vpc - sqlVerbs: - delete: [] - insert: - - $ref: '#/components/x-stackQL-resources/default_vpc/methods/default_vpc_Create' - select: [] - update: [] - title: default_vpc - dhcp_options: - name: dhcp_options - methods: - dhcp_options_Associate: - operation: - $ref: '#/paths/~1?Action=AssociateDhcpOptions&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - dhcp_options_Create: - operation: - $ref: '#/paths/~1?Action=CreateDhcpOptions&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - dhcp_options_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteDhcpOptions&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - dhcp_options_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeDhcpOptions&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/dhcpOptionsSet/item - openAPIDocKey: '200' - id: aws.ec2_api.dhcp_options - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/dhcp_options/methods/dhcp_options_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/dhcp_options/methods/dhcp_options_Create' - select: - - $ref: '#/components/x-stackQL-resources/dhcp_options/methods/dhcp_options_Describe' - update: [] - title: dhcp_options - diagnostic_interrupt: - name: diagnostic_interrupt - methods: - diagnostic_interrupt_Send: - operation: - $ref: '#/paths/~1?Action=SendDiagnosticInterrupt&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - id: aws.ec2_api.diagnostic_interrupt - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: diagnostic_interrupt - ebs_default_kms_key_id: - name: ebs_default_kms_key_id - methods: - ebs_default_kms_key_id_Get: - operation: - $ref: '#/paths/~1?Action=GetEbsDefaultKmsKeyId&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - ebs_default_kms_key_id_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyEbsDefaultKmsKeyId&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - ebs_default_kms_key_id_Reset: - operation: - $ref: '#/paths/~1?Action=ResetEbsDefaultKmsKeyId&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.ebs_default_kms_key_id - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/ebs_default_kms_key_id/methods/ebs_default_kms_key_id_Get' - update: [] - title: ebs_default_kms_key_id - ebs_encryption_by_default: - name: ebs_encryption_by_default - methods: - ebs_encryption_by_default_Disable: - operation: - $ref: '#/paths/~1?Action=DisableEbsEncryptionByDefault&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - ebs_encryption_by_default_Enable: - operation: - $ref: '#/paths/~1?Action=EnableEbsEncryptionByDefault&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - ebs_encryption_by_default_Get: - operation: - $ref: '#/paths/~1?Action=GetEbsEncryptionByDefault&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - id: aws.ec2_api.ebs_encryption_by_default - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/ebs_encryption_by_default/methods/ebs_encryption_by_default_Get' - update: [] - title: ebs_encryption_by_default - egress_only_internet_gateways: - name: egress_only_internet_gateways - methods: - egress_only_internet_gateway_Create: - operation: - $ref: '#/paths/~1?Action=CreateEgressOnlyInternetGateway&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - egress_only_internet_gateway_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteEgressOnlyInternetGateway&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - egress_only_internet_gateways_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeEgressOnlyInternetGateways&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/egressOnlyInternetGatewaySet/item - openAPIDocKey: '200' - id: aws.ec2_api.egress_only_internet_gateways - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/egress_only_internet_gateways/methods/egress_only_internet_gateway_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/egress_only_internet_gateways/methods/egress_only_internet_gateway_Create' - select: - - $ref: '#/components/x-stackQL-resources/egress_only_internet_gateways/methods/egress_only_internet_gateways_Describe' - update: [] - title: egress_only_internet_gateways - elastic_gpus: - name: elastic_gpus - methods: - elastic_gpus_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeElasticGpus&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/elasticGpuSet/item - openAPIDocKey: '200' - id: aws.ec2_api.elastic_gpus - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/elastic_gpus/methods/elastic_gpus_Describe' - update: [] - title: elastic_gpus - enclave_certificate_iam_role: - name: enclave_certificate_iam_role - methods: - enclave_certificate_iam_role_Associate: - operation: - $ref: '#/paths/~1?Action=AssociateEnclaveCertificateIamRole&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - enclave_certificate_iam_role_Disassociate: - operation: - $ref: '#/paths/~1?Action=DisassociateEnclaveCertificateIamRole&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.enclave_certificate_iam_role - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: enclave_certificate_iam_role - export_image_tasks: - name: export_image_tasks - methods: - export_image_tasks_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeExportImageTasks&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/exportImageTaskSet/item - openAPIDocKey: '200' - id: aws.ec2_api.export_image_tasks - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/export_image_tasks/methods/export_image_tasks_Describe' - update: [] - title: export_image_tasks - export_tasks: - name: export_tasks - methods: - export_task_Cancel: - operation: - $ref: '#/paths/~1?Action=CancelExportTask&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - export_tasks_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeExportTasks&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/exportTaskSet/item - openAPIDocKey: '200' - id: aws.ec2_api.export_tasks - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/export_tasks/methods/export_tasks_Describe' - update: [] - title: export_tasks - fast_launch: - name: fast_launch - methods: - fast_launch_Disable: - operation: - $ref: '#/paths/~1?Action=DisableFastLaunch&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - fast_launch_Enable: - operation: - $ref: '#/paths/~1?Action=EnableFastLaunch&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.fast_launch - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: fast_launch - fast_launch_images: - name: fast_launch_images - methods: - fast_launch_images_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeFastLaunchImages&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/fastLaunchImageSet/item - openAPIDocKey: '200' - id: aws.ec2_api.fast_launch_images - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/fast_launch_images/methods/fast_launch_images_Describe' - update: [] - title: fast_launch_images - fast_snapshot_restores: - name: fast_snapshot_restores - methods: - fast_snapshot_restores_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeFastSnapshotRestores&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/fastSnapshotRestoreSet/item - openAPIDocKey: '200' - fast_snapshot_restores_Disable: - operation: - $ref: '#/paths/~1?Action=DisableFastSnapshotRestores&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - fast_snapshot_restores_Enable: - operation: - $ref: '#/paths/~1?Action=EnableFastSnapshotRestores&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.fast_snapshot_restores - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/fast_snapshot_restores/methods/fast_snapshot_restores_Describe' - update: [] - title: fast_snapshot_restores - fleet_history: - name: fleet_history - methods: - fleet_history_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeFleetHistory&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - id: aws.ec2_api.fleet_history - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/fleet_history/methods/fleet_history_Describe' - update: [] - title: fleet_history - fleet_instances: - name: fleet_instances - methods: - fleet_instances_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeFleetInstances&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/activeInstanceSet/item - openAPIDocKey: '200' - id: aws.ec2_api.fleet_instances - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/fleet_instances/methods/fleet_instances_Describe' - update: [] - title: fleet_instances - fleets: - name: fleets - methods: - fleet_Create: - operation: - $ref: '#/paths/~1?Action=CreateFleet&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - fleet_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyFleet&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - fleets_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteFleets&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - fleets_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeFleets&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/fleetSet/item - openAPIDocKey: '200' - id: aws.ec2_api.fleets - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/fleets/methods/fleets_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/fleets/methods/fleet_Create' - select: - - $ref: '#/components/x-stackQL-resources/fleets/methods/fleets_Describe' - update: [] - title: fleets - flow_logs: - name: flow_logs - methods: - flow_logs_Create: - operation: - $ref: '#/paths/~1?Action=CreateFlowLogs&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - flow_logs_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteFlowLogs&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - flow_logs_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeFlowLogs&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/flowLogSet/item - openAPIDocKey: '200' - id: aws.ec2_api.flow_logs - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/flow_logs/methods/flow_logs_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/flow_logs/methods/flow_logs_Create' - select: - - $ref: '#/components/x-stackQL-resources/flow_logs/methods/flow_logs_Describe' - update: [] - title: flow_logs - flow_logs_integration_template: - name: flow_logs_integration_template - methods: - flow_logs_integration_template_Get: - operation: - $ref: '#/paths/~1?Action=GetFlowLogsIntegrationTemplate&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - id: aws.ec2_api.flow_logs_integration_template - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/flow_logs_integration_template/methods/flow_logs_integration_template_Get' - update: [] - title: flow_logs_integration_template - fpga_image_attribute: - name: fpga_image_attribute - methods: - fpga_image_attribute_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeFpgaImageAttribute&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - fpga_image_attribute_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyFpgaImageAttribute&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - fpga_image_attribute_Reset: - operation: - $ref: '#/paths/~1?Action=ResetFpgaImageAttribute&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.fpga_image_attribute - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/fpga_image_attribute/methods/fpga_image_attribute_Describe' - update: [] - title: fpga_image_attribute - fpga_images: - name: fpga_images - methods: - fpga_image_Copy: - operation: - $ref: '#/paths/~1?Action=CopyFpgaImage&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - fpga_image_Create: - operation: - $ref: '#/paths/~1?Action=CreateFpgaImage&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - fpga_image_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteFpgaImage&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - fpga_images_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeFpgaImages&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/fpgaImageSet/item - openAPIDocKey: '200' - id: aws.ec2_api.fpga_images - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/fpga_images/methods/fpga_image_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/fpga_images/methods/fpga_image_Create' - select: - - $ref: '#/components/x-stackQL-resources/fpga_images/methods/fpga_images_Describe' - update: [] - title: fpga_images - groups_for_capacity_reservation: - name: groups_for_capacity_reservation - methods: - groups_for_capacity_reservation_Get: - operation: - $ref: '#/paths/~1?Action=GetGroupsForCapacityReservation&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/capacityReservationGroupSet/item - openAPIDocKey: '200' - id: aws.ec2_api.groups_for_capacity_reservation - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/groups_for_capacity_reservation/methods/groups_for_capacity_reservation_Get' - update: [] - title: groups_for_capacity_reservation - host_reservation_offerings: - name: host_reservation_offerings - methods: - host_reservation_offerings_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeHostReservationOfferings&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/offeringSet/item - openAPIDocKey: '200' - id: aws.ec2_api.host_reservation_offerings - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/host_reservation_offerings/methods/host_reservation_offerings_Describe' - update: [] - title: host_reservation_offerings - host_reservation_purchase_preview: - name: host_reservation_purchase_preview - methods: - host_reservation_purchase_preview_Get: - operation: - $ref: '#/paths/~1?Action=GetHostReservationPurchasePreview&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - id: aws.ec2_api.host_reservation_purchase_preview - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/host_reservation_purchase_preview/methods/host_reservation_purchase_preview_Get' - update: [] - title: host_reservation_purchase_preview - host_reservations: - name: host_reservations - methods: - host_reservation_Purchase: - operation: - $ref: '#/paths/~1?Action=PurchaseHostReservation&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - host_reservations_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeHostReservations&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/hostReservationSet/item - openAPIDocKey: '200' - id: aws.ec2_api.host_reservations - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/host_reservations/methods/host_reservations_Describe' - update: [] - title: host_reservations - hosts: - name: hosts - methods: - hosts_Allocate: - operation: - $ref: '#/paths/~1?Action=AllocateHosts&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - hosts_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeHosts&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/hostSet/item - openAPIDocKey: '200' - hosts_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyHosts&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - hosts_Release: - operation: - $ref: '#/paths/~1?Action=ReleaseHosts&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.hosts - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/hosts/methods/hosts_Describe' - update: [] - title: hosts - iam_instance_profile: - name: iam_instance_profile - methods: - iam_instance_profile_Associate: - operation: - $ref: '#/paths/~1?Action=AssociateIamInstanceProfile&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - iam_instance_profile_Disassociate: - operation: - $ref: '#/paths/~1?Action=DisassociateIamInstanceProfile&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.iam_instance_profile - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: iam_instance_profile - iam_instance_profile_associations: - name: iam_instance_profile_associations - methods: - iam_instance_profile_association_Replace: - operation: - $ref: '#/paths/~1?Action=ReplaceIamInstanceProfileAssociation&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - iam_instance_profile_associations_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeIamInstanceProfileAssociations&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/iamInstanceProfileAssociationSet/item - openAPIDocKey: '200' - id: aws.ec2_api.iam_instance_profile_associations - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/iam_instance_profile_associations/methods/iam_instance_profile_associations_Describe' - update: [] - title: iam_instance_profile_associations - id_format: - name: id_format - methods: - id_format_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeIdFormat&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/statusSet/item - openAPIDocKey: '200' - id_format_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyIdFormat&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - id: aws.ec2_api.id_format - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/id_format/methods/id_format_Describe' - update: [] - title: id_format - identity_id_format: - name: identity_id_format - methods: - identity_id_format_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeIdentityIdFormat&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/statusSet/item - openAPIDocKey: '200' - identity_id_format_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyIdentityIdFormat&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - id: aws.ec2_api.identity_id_format - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/identity_id_format/methods/identity_id_format_Describe' - update: [] - title: identity_id_format - image_attribute: - name: image_attribute - methods: - image_attribute_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeImageAttribute&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - image_attribute_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyImageAttribute&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - image_attribute_Reset: - operation: - $ref: '#/paths/~1?Action=ResetImageAttribute&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - id: aws.ec2_api.image_attribute - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/image_attribute/methods/image_attribute_Describe' - update: [] - title: image_attribute - image_deprecation: - name: image_deprecation - methods: - image_deprecation_Disable: - operation: - $ref: '#/paths/~1?Action=DisableImageDeprecation&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - image_deprecation_Enable: - operation: - $ref: '#/paths/~1?Action=EnableImageDeprecation&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.image_deprecation - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: image_deprecation - image_from_recycle_bin: - name: image_from_recycle_bin - methods: - image_from_recycle_bin_Restore: - operation: - $ref: '#/paths/~1?Action=RestoreImageFromRecycleBin&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.image_from_recycle_bin - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: image_from_recycle_bin - images: - name: images - methods: - image_Copy: - operation: - $ref: '#/paths/~1?Action=CopyImage&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - image_Create: - operation: - $ref: '#/paths/~1?Action=CreateImage&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - image_Deregister: - operation: - $ref: '#/paths/~1?Action=DeregisterImage&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - image_Export: - operation: - $ref: '#/paths/~1?Action=ExportImage&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - image_Import: - operation: - $ref: '#/paths/~1?Action=ImportImage&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - image_Register: - operation: - $ref: '#/paths/~1?Action=RegisterImage&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - images_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeImages&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - id: aws.ec2_api.images - sqlVerbs: - delete: [] - insert: - - $ref: '#/components/x-stackQL-resources/images/methods/image_Create' - select: - - $ref: '#/components/x-stackQL-resources/images/methods/images_Describe' - update: [] - title: images - images_in_recycle_bin: - name: images_in_recycle_bin - methods: - images_in_recycle_bin_List: - operation: - $ref: '#/paths/~1?Action=ListImagesInRecycleBin&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/imageSet/item - openAPIDocKey: '200' - id: aws.ec2_api.images_in_recycle_bin - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/images_in_recycle_bin/methods/images_in_recycle_bin_List' - update: [] - title: images_in_recycle_bin - import_image_tasks: - name: import_image_tasks - methods: - import_image_tasks_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeImportImageTasks&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/importImageTaskSet/item - openAPIDocKey: '200' - id: aws.ec2_api.import_image_tasks - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/import_image_tasks/methods/import_image_tasks_Describe' - update: [] - title: import_image_tasks - import_snapshot_tasks: - name: import_snapshot_tasks - methods: - import_snapshot_tasks_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeImportSnapshotTasks&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/importSnapshotTaskSet/item - openAPIDocKey: '200' - id: aws.ec2_api.import_snapshot_tasks - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/import_snapshot_tasks/methods/import_snapshot_tasks_Describe' - update: [] - title: import_snapshot_tasks - import_task: - name: import_task - methods: - import_task_Cancel: - operation: - $ref: '#/paths/~1?Action=CancelImportTask&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.import_task - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: import_task - instance_attribute: - name: instance_attribute - methods: - instance_attribute_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeInstanceAttribute&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - instance_attribute_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyInstanceAttribute&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - instance_attribute_Reset: - operation: - $ref: '#/paths/~1?Action=ResetInstanceAttribute&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - id: aws.ec2_api.instance_attribute - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/instance_attribute/methods/instance_attribute_Describe' - update: [] - title: instance_attribute - instance_capacity_reservation_attributes: - name: instance_capacity_reservation_attributes - methods: - instance_capacity_reservation_attributes_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyInstanceCapacityReservationAttributes&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.instance_capacity_reservation_attributes - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: instance_capacity_reservation_attributes - instance_credit_specifications: - name: instance_credit_specifications - methods: - instance_credit_specification_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyInstanceCreditSpecification&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - instance_credit_specifications_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeInstanceCreditSpecifications&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/instanceCreditSpecificationSet/item - openAPIDocKey: '200' - id: aws.ec2_api.instance_credit_specifications - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/instance_credit_specifications/methods/instance_credit_specifications_Describe' - update: [] - title: instance_credit_specifications - instance_event_notification_attributes: - name: instance_event_notification_attributes - methods: - instance_event_notification_attributes_Deregister: - operation: - $ref: '#/paths/~1?Action=DeregisterInstanceEventNotificationAttributes&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - instance_event_notification_attributes_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeInstanceEventNotificationAttributes&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - instance_event_notification_attributes_Register: - operation: - $ref: '#/paths/~1?Action=RegisterInstanceEventNotificationAttributes&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.instance_event_notification_attributes - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/instance_event_notification_attributes/methods/instance_event_notification_attributes_Describe' - update: [] - title: instance_event_notification_attributes - instance_event_start_time: - name: instance_event_start_time - methods: - instance_event_start_time_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyInstanceEventStartTime&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.instance_event_start_time - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: instance_event_start_time - instance_event_windows: - name: instance_event_windows - methods: - instance_event_window_Associate: - operation: - $ref: '#/paths/~1?Action=AssociateInstanceEventWindow&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - instance_event_window_Create: - operation: - $ref: '#/paths/~1?Action=CreateInstanceEventWindow&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - instance_event_window_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteInstanceEventWindow&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - instance_event_window_Disassociate: - operation: - $ref: '#/paths/~1?Action=DisassociateInstanceEventWindow&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - instance_event_window_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyInstanceEventWindow&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - instance_event_windows_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeInstanceEventWindows&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/instanceEventWindowSet/item - openAPIDocKey: '200' - id: aws.ec2_api.instance_event_windows - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/instance_event_windows/methods/instance_event_window_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/instance_event_windows/methods/instance_event_window_Create' - select: - - $ref: '#/components/x-stackQL-resources/instance_event_windows/methods/instance_event_windows_Describe' - update: [] - title: instance_event_windows - instance_export_task: - name: instance_export_task - methods: - instance_export_task_Create: - operation: - $ref: '#/paths/~1?Action=CreateInstanceExportTask&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.instance_export_task - sqlVerbs: - delete: [] - insert: - - $ref: '#/components/x-stackQL-resources/instance_export_task/methods/instance_export_task_Create' - select: [] - update: [] - title: instance_export_task - instance_maintenance_options: - name: instance_maintenance_options - methods: - instance_maintenance_options_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyInstanceMaintenanceOptions&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.instance_maintenance_options - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: instance_maintenance_options - instance_metadata_options: - name: instance_metadata_options - methods: - instance_metadata_options_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyInstanceMetadataOptions&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.instance_metadata_options - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: instance_metadata_options - instance_placement: - name: instance_placement - methods: - instance_placement_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyInstancePlacement&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.instance_placement - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: instance_placement - instance_status: - name: instance_status - methods: - instance_status_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeInstanceStatus&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/instanceStatusSet/item - openAPIDocKey: '200' - instance_status_Report: - operation: - $ref: '#/paths/~1?Action=ReportInstanceStatus&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - id: aws.ec2_api.instance_status - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/instance_status/methods/instance_status_Describe' - update: [] - title: instance_status - instance_type_offerings: - name: instance_type_offerings - methods: - instance_type_offerings_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeInstanceTypeOfferings&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/instanceTypeOfferingSet/item - openAPIDocKey: '200' - id: aws.ec2_api.instance_type_offerings - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/instance_type_offerings/methods/instance_type_offerings_Describe' - update: [] - title: instance_type_offerings - instance_types: - name: instance_types - methods: - instance_types_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeInstanceTypes&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/instanceTypeSet/item - openAPIDocKey: '200' - id: aws.ec2_api.instance_types - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/instance_types/methods/instance_types_Describe' - update: [] - title: instance_types - instance_types_from_instance_requirements: - name: instance_types_from_instance_requirements - methods: - instance_types_from_instance_requirements_Get: - operation: - $ref: '#/paths/~1?Action=GetInstanceTypesFromInstanceRequirements&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/instanceTypeSet/item - openAPIDocKey: '200' - id: aws.ec2_api.instance_types_from_instance_requirements - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/instance_types_from_instance_requirements/methods/instance_types_from_instance_requirements_Get' - update: [] - title: instance_types_from_instance_requirements - instance_uefi_data: - name: instance_uefi_data - methods: - instance_uefi_data_Get: - operation: - $ref: '#/paths/~1?Action=GetInstanceUefiData&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - id: aws.ec2_api.instance_uefi_data - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/instance_uefi_data/methods/instance_uefi_data_Get' - update: [] - title: instance_uefi_data - instances: - name: instances - methods: - instance_Bundle: - operation: - $ref: '#/paths/~1?Action=BundleInstance&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - instance_Import: - operation: - $ref: '#/paths/~1?Action=ImportInstance&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - instances_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeInstances&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/reservationSet/item/instancesSet/item - openAPIDocKey: '200' - instances_Monitor: - operation: - $ref: '#/paths/~1?Action=MonitorInstances&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - instances_Reboot: - operation: - $ref: '#/paths/~1?Action=RebootInstances&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - instances_Run: - operation: - $ref: '#/paths/~1?Action=RunInstances&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - instances_Start: - operation: - $ref: '#/paths/~1?Action=StartInstances&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - instances_Stop: - operation: - $ref: '#/paths/~1?Action=StopInstances&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - instances_Terminate: - operation: - $ref: '#/paths/~1?Action=TerminateInstances&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - instances_Unmonitor: - operation: - $ref: '#/paths/~1?Action=UnmonitorInstances&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.instances - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/instances/methods/instances_Describe' - update: [] - title: instances - internet_gateways: - name: internet_gateways - methods: - internet_gateway_Attach: - operation: - $ref: '#/paths/~1?Action=AttachInternetGateway&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - internet_gateway_Create: - operation: - $ref: '#/paths/~1?Action=CreateInternetGateway&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - internet_gateway_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteInternetGateway&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - internet_gateway_Detach: - operation: - $ref: '#/paths/~1?Action=DetachInternetGateway&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - internet_gateways_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeInternetGateways&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/internetGatewaySet/item - openAPIDocKey: '200' - id: aws.ec2_api.internet_gateways - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/internet_gateways/methods/internet_gateway_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/internet_gateways/methods/internet_gateway_Create' - select: - - $ref: '#/components/x-stackQL-resources/internet_gateways/methods/internet_gateways_Describe' - update: [] - title: internet_gateways - ipam_address_history: - name: ipam_address_history - methods: - ipam_address_history_Get: - operation: - $ref: '#/paths/~1?Action=GetIpamAddressHistory&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/historyRecordSet/item - openAPIDocKey: '200' - id: aws.ec2_api.ipam_address_history - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/ipam_address_history/methods/ipam_address_history_Get' - update: [] - title: ipam_address_history - ipam_organization_admin_account: - name: ipam_organization_admin_account - methods: - ipam_organization_admin_account_Disable: - operation: - $ref: '#/paths/~1?Action=DisableIpamOrganizationAdminAccount&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - ipam_organization_admin_account_Enable: - operation: - $ref: '#/paths/~1?Action=EnableIpamOrganizationAdminAccount&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.ipam_organization_admin_account - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: ipam_organization_admin_account - ipam_pool_allocations: - name: ipam_pool_allocations - methods: - ipam_pool_allocation_Release: - operation: - $ref: '#/paths/~1?Action=ReleaseIpamPoolAllocation&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - ipam_pool_allocations_Get: - operation: - $ref: '#/paths/~1?Action=GetIpamPoolAllocations&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/ipamPoolAllocationSet/item - openAPIDocKey: '200' - id: aws.ec2_api.ipam_pool_allocations - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/ipam_pool_allocations/methods/ipam_pool_allocations_Get' - update: [] - title: ipam_pool_allocations - ipam_pool_cidrs: - name: ipam_pool_cidrs - methods: - ipam_pool_cidr_Allocate: - operation: - $ref: '#/paths/~1?Action=AllocateIpamPoolCidr&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - ipam_pool_cidr_Deprovision: - operation: - $ref: '#/paths/~1?Action=DeprovisionIpamPoolCidr&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - ipam_pool_cidr_Provision: - operation: - $ref: '#/paths/~1?Action=ProvisionIpamPoolCidr&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - ipam_pool_cidrs_Get: - operation: - $ref: '#/paths/~1?Action=GetIpamPoolCidrs&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/ipamPoolCidrSet/item - openAPIDocKey: '200' - id: aws.ec2_api.ipam_pool_cidrs - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/ipam_pool_cidrs/methods/ipam_pool_cidrs_Get' - update: [] - title: ipam_pool_cidrs - ipam_pools: - name: ipam_pools - methods: - ipam_pool_Create: - operation: - $ref: '#/paths/~1?Action=CreateIpamPool&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - ipam_pool_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteIpamPool&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - ipam_pool_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyIpamPool&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - ipam_pools_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeIpamPools&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/ipamPoolSet/item - openAPIDocKey: '200' - id: aws.ec2_api.ipam_pools - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/ipam_pools/methods/ipam_pool_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/ipam_pools/methods/ipam_pool_Create' - select: - - $ref: '#/components/x-stackQL-resources/ipam_pools/methods/ipam_pools_Describe' - update: [] - title: ipam_pools - ipam_resource_cidrs: - name: ipam_resource_cidrs - methods: - ipam_resource_cidr_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyIpamResourceCidr&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - ipam_resource_cidrs_Get: - operation: - $ref: '#/paths/~1?Action=GetIpamResourceCidrs&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/ipamResourceCidrSet/item - openAPIDocKey: '200' - id: aws.ec2_api.ipam_resource_cidrs - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/ipam_resource_cidrs/methods/ipam_resource_cidrs_Get' - update: [] - title: ipam_resource_cidrs - ipam_scopes: - name: ipam_scopes - methods: - ipam_scope_Create: - operation: - $ref: '#/paths/~1?Action=CreateIpamScope&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - ipam_scope_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteIpamScope&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - ipam_scope_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyIpamScope&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - ipam_scopes_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeIpamScopes&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/ipamScopeSet/item - openAPIDocKey: '200' - id: aws.ec2_api.ipam_scopes - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/ipam_scopes/methods/ipam_scope_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/ipam_scopes/methods/ipam_scope_Create' - select: - - $ref: '#/components/x-stackQL-resources/ipam_scopes/methods/ipam_scopes_Describe' - update: [] - title: ipam_scopes - ipams: - name: ipams - methods: - ipam_Create: - operation: - $ref: '#/paths/~1?Action=CreateIpam&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - ipam_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteIpam&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - ipam_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyIpam&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - ipams_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeIpams&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/ipamSet/item - openAPIDocKey: '200' - id: aws.ec2_api.ipams - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/ipams/methods/ipam_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/ipams/methods/ipam_Create' - select: - - $ref: '#/components/x-stackQL-resources/ipams/methods/ipams_Describe' - update: [] - title: ipams - ipv6_addresses: - name: ipv6_addresses - methods: - ipv6_addresses_Assign: - operation: - $ref: '#/paths/~1?Action=AssignIpv6Addresses&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - ipv6_addresses_Unassign: - operation: - $ref: '#/paths/~1?Action=UnassignIpv6Addresses&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.ipv6_addresses - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: ipv6_addresses - ipv6_pools: - name: ipv6_pools - methods: - ipv6_pools_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeIpv6Pools&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/ipv6PoolSet/item - openAPIDocKey: '200' - id: aws.ec2_api.ipv6_pools - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/ipv6_pools/methods/ipv6_pools_Describe' - update: [] - title: ipv6_pools - key_pairs: - name: key_pairs - methods: - key_pair_Create: - operation: - $ref: '#/paths/~1?Action=CreateKeyPair&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - key_pair_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteKeyPair&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - key_pair_Import: - operation: - $ref: '#/paths/~1?Action=ImportKeyPair&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - key_pairs_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeKeyPairs&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - id: aws.ec2_api.key_pairs - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/key_pairs/methods/key_pair_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/key_pairs/methods/key_pair_Create' - select: - - $ref: '#/components/x-stackQL-resources/key_pairs/methods/key_pairs_Describe' - update: [] - title: key_pairs - launch_template_data: - name: launch_template_data - methods: - launch_template_data_Get: - operation: - $ref: '#/paths/~1?Action=GetLaunchTemplateData&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - id: aws.ec2_api.launch_template_data - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/launch_template_data/methods/launch_template_data_Get' - update: [] - title: launch_template_data - launch_template_versions: - name: launch_template_versions - methods: - launch_template_version_Create: - operation: - $ref: '#/paths/~1?Action=CreateLaunchTemplateVersion&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - launch_template_versions_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteLaunchTemplateVersions&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - launch_template_versions_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeLaunchTemplateVersions&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/launchTemplateVersionSet/item - openAPIDocKey: '200' - id: aws.ec2_api.launch_template_versions - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/launch_template_versions/methods/launch_template_versions_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/launch_template_versions/methods/launch_template_version_Create' - select: - - $ref: '#/components/x-stackQL-resources/launch_template_versions/methods/launch_template_versions_Describe' - update: [] - title: launch_template_versions - launch_templates: - name: launch_templates - methods: - launch_template_Create: - operation: - $ref: '#/paths/~1?Action=CreateLaunchTemplate&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - launch_template_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteLaunchTemplate&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - launch_template_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyLaunchTemplate&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - launch_templates_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeLaunchTemplates&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/launchTemplates/item - openAPIDocKey: '200' - id: aws.ec2_api.launch_templates - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/launch_templates/methods/launch_template_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/launch_templates/methods/launch_template_Create' - select: - - $ref: '#/components/x-stackQL-resources/launch_templates/methods/launch_templates_Describe' - update: [] - title: launch_templates - local_gateway_route_table_virtual_interface_group_associations: - name: local_gateway_route_table_virtual_interface_group_associations - methods: - local_gateway_route_table_virtual_interface_group_associations_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/localGatewayRouteTableVirtualInterfaceGroupAssociationSet/item - openAPIDocKey: '200' - id: aws.ec2_api.local_gateway_route_table_virtual_interface_group_associations - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/local_gateway_route_table_virtual_interface_group_associations/methods/local_gateway_route_table_virtual_interface_group_associations_Describe' - update: [] - title: local_gateway_route_table_virtual_interface_group_associations - local_gateway_route_table_vpc_associations: - name: local_gateway_route_table_vpc_associations - methods: - local_gateway_route_table_vpc_association_Create: - operation: - $ref: '#/paths/~1?Action=CreateLocalGatewayRouteTableVpcAssociation&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - local_gateway_route_table_vpc_association_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteLocalGatewayRouteTableVpcAssociation&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - local_gateway_route_table_vpc_associations_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeLocalGatewayRouteTableVpcAssociations&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/localGatewayRouteTableVpcAssociationSet/item - openAPIDocKey: '200' - id: aws.ec2_api.local_gateway_route_table_vpc_associations - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/local_gateway_route_table_vpc_associations/methods/local_gateway_route_table_vpc_association_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/local_gateway_route_table_vpc_associations/methods/local_gateway_route_table_vpc_association_Create' - select: - - $ref: '#/components/x-stackQL-resources/local_gateway_route_table_vpc_associations/methods/local_gateway_route_table_vpc_associations_Describe' - update: [] - title: local_gateway_route_table_vpc_associations - local_gateway_route_tables: - name: local_gateway_route_tables - methods: - local_gateway_route_tables_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeLocalGatewayRouteTables&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/localGatewayRouteTableSet/item - openAPIDocKey: '200' - id: aws.ec2_api.local_gateway_route_tables - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/local_gateway_route_tables/methods/local_gateway_route_tables_Describe' - update: [] - title: local_gateway_route_tables - local_gateway_routes: - name: local_gateway_routes - methods: - local_gateway_route_Create: - operation: - $ref: '#/paths/~1?Action=CreateLocalGatewayRoute&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - local_gateway_route_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteLocalGatewayRoute&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - local_gateway_routes_Search: - operation: - $ref: '#/paths/~1?Action=SearchLocalGatewayRoutes&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.local_gateway_routes - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/local_gateway_routes/methods/local_gateway_route_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/local_gateway_routes/methods/local_gateway_route_Create' - select: [] - update: [] - title: local_gateway_routes - local_gateway_virtual_interface_groups: - name: local_gateway_virtual_interface_groups - methods: - local_gateway_virtual_interface_groups_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeLocalGatewayVirtualInterfaceGroups&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/localGatewayVirtualInterfaceGroupSet/item - openAPIDocKey: '200' - id: aws.ec2_api.local_gateway_virtual_interface_groups - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/local_gateway_virtual_interface_groups/methods/local_gateway_virtual_interface_groups_Describe' - update: [] - title: local_gateway_virtual_interface_groups - local_gateway_virtual_interfaces: - name: local_gateway_virtual_interfaces - methods: - local_gateway_virtual_interfaces_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeLocalGatewayVirtualInterfaces&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/localGatewayVirtualInterfaceSet/item - openAPIDocKey: '200' - id: aws.ec2_api.local_gateway_virtual_interfaces - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/local_gateway_virtual_interfaces/methods/local_gateway_virtual_interfaces_Describe' - update: [] - title: local_gateway_virtual_interfaces - local_gateways: - name: local_gateways - methods: - local_gateways_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeLocalGateways&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/localGatewaySet/item - openAPIDocKey: '200' - id: aws.ec2_api.local_gateways - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/local_gateways/methods/local_gateways_Describe' - update: [] - title: local_gateways - managed_prefix_list_associations: - name: managed_prefix_list_associations - methods: - managed_prefix_list_associations_Get: - operation: - $ref: '#/paths/~1?Action=GetManagedPrefixListAssociations&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/prefixListAssociationSet/item - openAPIDocKey: '200' - id: aws.ec2_api.managed_prefix_list_associations - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/managed_prefix_list_associations/methods/managed_prefix_list_associations_Get' - update: [] - title: managed_prefix_list_associations - managed_prefix_list_entries: - name: managed_prefix_list_entries - methods: - managed_prefix_list_entries_Get: - operation: - $ref: '#/paths/~1?Action=GetManagedPrefixListEntries&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/entrySet/item - openAPIDocKey: '200' - id: aws.ec2_api.managed_prefix_list_entries - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/managed_prefix_list_entries/methods/managed_prefix_list_entries_Get' - update: [] - title: managed_prefix_list_entries - managed_prefix_list_version: - name: managed_prefix_list_version - methods: - managed_prefix_list_version_Restore: - operation: - $ref: '#/paths/~1?Action=RestoreManagedPrefixListVersion&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.managed_prefix_list_version - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: managed_prefix_list_version - managed_prefix_lists: - name: managed_prefix_lists - methods: - managed_prefix_list_Create: - operation: - $ref: '#/paths/~1?Action=CreateManagedPrefixList&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - managed_prefix_list_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteManagedPrefixList&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - managed_prefix_list_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyManagedPrefixList&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - managed_prefix_lists_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeManagedPrefixLists&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/prefixListSet/item - openAPIDocKey: '200' - id: aws.ec2_api.managed_prefix_lists - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/managed_prefix_lists/methods/managed_prefix_list_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/managed_prefix_lists/methods/managed_prefix_list_Create' - select: - - $ref: '#/components/x-stackQL-resources/managed_prefix_lists/methods/managed_prefix_lists_Describe' - update: [] - title: managed_prefix_lists - moving_addresses: - name: moving_addresses - methods: - moving_addresses_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeMovingAddresses&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/movingAddressStatusSet/item - openAPIDocKey: '200' - id: aws.ec2_api.moving_addresses - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/moving_addresses/methods/moving_addresses_Describe' - update: [] - title: moving_addresses - nat_gateways: - name: nat_gateways - methods: - nat_gateway_Create: - operation: - $ref: '#/paths/~1?Action=CreateNatGateway&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - nat_gateway_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteNatGateway&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - nat_gateways_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeNatGateways&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/natGatewaySet/item - openAPIDocKey: '200' - id: aws.ec2_api.nat_gateways - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/nat_gateways/methods/nat_gateway_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/nat_gateways/methods/nat_gateway_Create' - select: - - $ref: '#/components/x-stackQL-resources/nat_gateways/methods/nat_gateways_Describe' - update: [] - title: nat_gateways - network_acl_association: - name: network_acl_association - methods: - network_acl_association_Replace: - operation: - $ref: '#/paths/~1?Action=ReplaceNetworkAclAssociation&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.network_acl_association - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: network_acl_association - network_acl_entry: - name: network_acl_entry - methods: - network_acl_entry_Create: - operation: - $ref: '#/paths/~1?Action=CreateNetworkAclEntry&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - network_acl_entry_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteNetworkAclEntry&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - network_acl_entry_Replace: - operation: - $ref: '#/paths/~1?Action=ReplaceNetworkAclEntry&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - id: aws.ec2_api.network_acl_entry - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/network_acl_entry/methods/network_acl_entry_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/network_acl_entry/methods/network_acl_entry_Create' - select: [] - update: [] - title: network_acl_entry - network_acls: - name: network_acls - methods: - network_acl_Create: - operation: - $ref: '#/paths/~1?Action=CreateNetworkAcl&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - network_acl_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteNetworkAcl&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - network_acls_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeNetworkAcls&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/networkAclSet/item - openAPIDocKey: '200' - id: aws.ec2_api.network_acls - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/network_acls/methods/network_acl_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/network_acls/methods/network_acl_Create' - select: - - $ref: '#/components/x-stackQL-resources/network_acls/methods/network_acls_Describe' - update: [] - title: network_acls - network_insights_access_scope_analyses: - name: network_insights_access_scope_analyses - methods: - network_insights_access_scope_analyses_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeNetworkInsightsAccessScopeAnalyses&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/networkInsightsAccessScopeAnalysisSet/item - openAPIDocKey: '200' - id: aws.ec2_api.network_insights_access_scope_analyses - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/network_insights_access_scope_analyses/methods/network_insights_access_scope_analyses_Describe' - update: [] - title: network_insights_access_scope_analyses - network_insights_access_scope_analysis: - name: network_insights_access_scope_analysis - methods: - network_insights_access_scope_analysis_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteNetworkInsightsAccessScopeAnalysis&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - network_insights_access_scope_analysis_Start: - operation: - $ref: '#/paths/~1?Action=StartNetworkInsightsAccessScopeAnalysis&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.network_insights_access_scope_analysis - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/network_insights_access_scope_analysis/methods/network_insights_access_scope_analysis_Delete' - insert: [] - select: [] - update: [] - title: network_insights_access_scope_analysis - network_insights_access_scope_analysis_findings: - name: network_insights_access_scope_analysis_findings - methods: - network_insights_access_scope_analysis_findings_Get: - operation: - $ref: '#/paths/~1?Action=GetNetworkInsightsAccessScopeAnalysisFindings&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/analysisFindingSet/item - openAPIDocKey: '200' - id: aws.ec2_api.network_insights_access_scope_analysis_findings - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/network_insights_access_scope_analysis_findings/methods/network_insights_access_scope_analysis_findings_Get' - update: [] - title: network_insights_access_scope_analysis_findings - network_insights_access_scope_content: - name: network_insights_access_scope_content - methods: - network_insights_access_scope_content_Get: - operation: - $ref: '#/paths/~1?Action=GetNetworkInsightsAccessScopeContent&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - id: aws.ec2_api.network_insights_access_scope_content - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/network_insights_access_scope_content/methods/network_insights_access_scope_content_Get' - update: [] - title: network_insights_access_scope_content - network_insights_access_scopes: - name: network_insights_access_scopes - methods: - network_insights_access_scope_Create: - operation: - $ref: '#/paths/~1?Action=CreateNetworkInsightsAccessScope&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - network_insights_access_scope_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteNetworkInsightsAccessScope&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - network_insights_access_scopes_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeNetworkInsightsAccessScopes&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/networkInsightsAccessScopeSet/item - openAPIDocKey: '200' - id: aws.ec2_api.network_insights_access_scopes - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/network_insights_access_scopes/methods/network_insights_access_scope_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/network_insights_access_scopes/methods/network_insights_access_scope_Create' - select: - - $ref: '#/components/x-stackQL-resources/network_insights_access_scopes/methods/network_insights_access_scopes_Describe' - update: [] - title: network_insights_access_scopes - network_insights_analyses: - name: network_insights_analyses - methods: - network_insights_analyses_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeNetworkInsightsAnalyses&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/networkInsightsAnalysisSet/item - openAPIDocKey: '200' - id: aws.ec2_api.network_insights_analyses - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/network_insights_analyses/methods/network_insights_analyses_Describe' - update: [] - title: network_insights_analyses - network_insights_analysis: - name: network_insights_analysis - methods: - network_insights_analysis_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteNetworkInsightsAnalysis&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - network_insights_analysis_Start: - operation: - $ref: '#/paths/~1?Action=StartNetworkInsightsAnalysis&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.network_insights_analysis - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/network_insights_analysis/methods/network_insights_analysis_Delete' - insert: [] - select: [] - update: [] - title: network_insights_analysis - network_insights_paths: - name: network_insights_paths - methods: - network_insights_path_Create: - operation: - $ref: '#/paths/~1?Action=CreateNetworkInsightsPath&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - network_insights_path_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteNetworkInsightsPath&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - network_insights_paths_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeNetworkInsightsPaths&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/networkInsightsPathSet/item - openAPIDocKey: '200' - id: aws.ec2_api.network_insights_paths - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/network_insights_paths/methods/network_insights_path_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/network_insights_paths/methods/network_insights_path_Create' - select: - - $ref: '#/components/x-stackQL-resources/network_insights_paths/methods/network_insights_paths_Describe' - update: [] - title: network_insights_paths - network_interface_attribute: - name: network_interface_attribute - methods: - network_interface_attribute_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeNetworkInterfaceAttribute&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - network_interface_attribute_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyNetworkInterfaceAttribute&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - network_interface_attribute_Reset: - operation: - $ref: '#/paths/~1?Action=ResetNetworkInterfaceAttribute&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - id: aws.ec2_api.network_interface_attribute - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/network_interface_attribute/methods/network_interface_attribute_Describe' - update: [] - title: network_interface_attribute - network_interface_permissions: - name: network_interface_permissions - methods: - network_interface_permission_Create: - operation: - $ref: '#/paths/~1?Action=CreateNetworkInterfacePermission&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - network_interface_permission_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteNetworkInterfacePermission&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - network_interface_permissions_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeNetworkInterfacePermissions&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/networkInterfacePermissions/item - openAPIDocKey: '200' - id: aws.ec2_api.network_interface_permissions - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/network_interface_permissions/methods/network_interface_permission_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/network_interface_permissions/methods/network_interface_permission_Create' - select: - - $ref: '#/components/x-stackQL-resources/network_interface_permissions/methods/network_interface_permissions_Describe' - update: [] - title: network_interface_permissions - network_interfaces: - name: network_interfaces - methods: - network_interface_Attach: - operation: - $ref: '#/paths/~1?Action=AttachNetworkInterface&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - network_interface_Create: - operation: - $ref: '#/paths/~1?Action=CreateNetworkInterface&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - network_interface_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteNetworkInterface&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - network_interface_Detach: - operation: - $ref: '#/paths/~1?Action=DetachNetworkInterface&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - network_interfaces_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeNetworkInterfaces&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/networkInterfaceSet/item - openAPIDocKey: '200' - id: aws.ec2_api.network_interfaces - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/network_interfaces/methods/network_interface_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/network_interfaces/methods/network_interface_Create' - select: - - $ref: '#/components/x-stackQL-resources/network_interfaces/methods/network_interfaces_Describe' - update: [] - title: network_interfaces - password_data: - name: password_data - methods: - password_data_Get: - operation: - $ref: '#/paths/~1?Action=GetPasswordData&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - id: aws.ec2_api.password_data - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/password_data/methods/password_data_Get' - update: [] - title: password_data - placement_groups: - name: placement_groups - methods: - placement_group_Create: - operation: - $ref: '#/paths/~1?Action=CreatePlacementGroup&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - placement_group_Delete: - operation: - $ref: '#/paths/~1?Action=DeletePlacementGroup&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - placement_groups_Describe: - operation: - $ref: '#/paths/~1?Action=DescribePlacementGroups&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/placementGroupSet/item - openAPIDocKey: '200' - id: aws.ec2_api.placement_groups - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/placement_groups/methods/placement_group_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/placement_groups/methods/placement_group_Create' - select: - - $ref: '#/components/x-stackQL-resources/placement_groups/methods/placement_groups_Describe' - update: [] - title: placement_groups - prefix_lists: - name: prefix_lists - methods: - prefix_lists_Describe: - operation: - $ref: '#/paths/~1?Action=DescribePrefixLists&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/prefixListSet/item - openAPIDocKey: '200' - id: aws.ec2_api.prefix_lists - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/prefix_lists/methods/prefix_lists_Describe' - update: [] - title: prefix_lists - principal_id_format: - name: principal_id_format - methods: - principal_id_format_Describe: - operation: - $ref: '#/paths/~1?Action=DescribePrincipalIdFormat&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/principalSet/item - openAPIDocKey: '200' - id: aws.ec2_api.principal_id_format - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/principal_id_format/methods/principal_id_format_Describe' - update: [] - title: principal_id_format - private_dns_name_options: - name: private_dns_name_options - methods: - private_dns_name_options_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyPrivateDnsNameOptions&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.private_dns_name_options - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: private_dns_name_options - private_ip_addresses: - name: private_ip_addresses - methods: - private_ip_addresses_Assign: - operation: - $ref: '#/paths/~1?Action=AssignPrivateIpAddresses&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - private_ip_addresses_Unassign: - operation: - $ref: '#/paths/~1?Action=UnassignPrivateIpAddresses&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - id: aws.ec2_api.private_ip_addresses - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: private_ip_addresses - product_instance: - name: product_instance - methods: - product_instance_Confirm: - operation: - $ref: '#/paths/~1?Action=ConfirmProductInstance&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.product_instance - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: product_instance - public_ipv4_pool_cidr: - name: public_ipv4_pool_cidr - methods: - public_ipv4_pool_cidr_Deprovision: - operation: - $ref: '#/paths/~1?Action=DeprovisionPublicIpv4PoolCidr&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - public_ipv4_pool_cidr_Provision: - operation: - $ref: '#/paths/~1?Action=ProvisionPublicIpv4PoolCidr&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.public_ipv4_pool_cidr - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: public_ipv4_pool_cidr - public_ipv4_pools: - name: public_ipv4_pools - methods: - public_ipv4_pool_Create: - operation: - $ref: '#/paths/~1?Action=CreatePublicIpv4Pool&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - public_ipv4_pool_Delete: - operation: - $ref: '#/paths/~1?Action=DeletePublicIpv4Pool&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - public_ipv4_pools_Describe: - operation: - $ref: '#/paths/~1?Action=DescribePublicIpv4Pools&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/publicIpv4PoolSet/item - openAPIDocKey: '200' - id: aws.ec2_api.public_ipv4_pools - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/public_ipv4_pools/methods/public_ipv4_pool_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/public_ipv4_pools/methods/public_ipv4_pool_Create' - select: - - $ref: '#/components/x-stackQL-resources/public_ipv4_pools/methods/public_ipv4_pools_Describe' - update: [] - title: public_ipv4_pools - queued_reserved_instances: - name: queued_reserved_instances - methods: - queued_reserved_instances_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteQueuedReservedInstances&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.queued_reserved_instances - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/queued_reserved_instances/methods/queued_reserved_instances_Delete' - insert: [] - select: [] - update: [] - title: queued_reserved_instances - regions: - name: regions - methods: - regions_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeRegions&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/regionInfo/item - openAPIDocKey: '200' - id: aws.ec2_api.regions - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/regions/methods/regions_Describe' - update: [] - title: regions - replace_root_volume_tasks: - name: replace_root_volume_tasks - methods: - replace_root_volume_task_Create: - operation: - $ref: '#/paths/~1?Action=CreateReplaceRootVolumeTask&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - replace_root_volume_tasks_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeReplaceRootVolumeTasks&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/replaceRootVolumeTaskSet/item - openAPIDocKey: '200' - id: aws.ec2_api.replace_root_volume_tasks - sqlVerbs: - delete: [] - insert: - - $ref: '#/components/x-stackQL-resources/replace_root_volume_tasks/methods/replace_root_volume_task_Create' - select: - - $ref: '#/components/x-stackQL-resources/replace_root_volume_tasks/methods/replace_root_volume_tasks_Describe' - update: [] - title: replace_root_volume_tasks - reserved_instances: - name: reserved_instances - methods: - reserved_instances_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeReservedInstances&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/reservedInstancesSet/item - openAPIDocKey: '200' - reserved_instances_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyReservedInstances&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.reserved_instances - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/reserved_instances/methods/reserved_instances_Describe' - update: [] - title: reserved_instances - reserved_instances_exchange_quote: - name: reserved_instances_exchange_quote - methods: - reserved_instances_exchange_quote_Accept: - operation: - $ref: '#/paths/~1?Action=AcceptReservedInstancesExchangeQuote&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - reserved_instances_exchange_quote_Get: - operation: - $ref: '#/paths/~1?Action=GetReservedInstancesExchangeQuote&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - id: aws.ec2_api.reserved_instances_exchange_quote - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/reserved_instances_exchange_quote/methods/reserved_instances_exchange_quote_Get' - update: [] - title: reserved_instances_exchange_quote - reserved_instances_listings: - name: reserved_instances_listings - methods: - reserved_instances_listing_Cancel: - operation: - $ref: '#/paths/~1?Action=CancelReservedInstancesListing&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - reserved_instances_listing_Create: - operation: - $ref: '#/paths/~1?Action=CreateReservedInstancesListing&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - reserved_instances_listings_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeReservedInstancesListings&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/reservedInstancesListingsSet/item - openAPIDocKey: '200' - id: aws.ec2_api.reserved_instances_listings - sqlVerbs: - delete: [] - insert: - - $ref: '#/components/x-stackQL-resources/reserved_instances_listings/methods/reserved_instances_listing_Create' - select: - - $ref: '#/components/x-stackQL-resources/reserved_instances_listings/methods/reserved_instances_listings_Describe' - update: [] - title: reserved_instances_listings - reserved_instances_modifications: - name: reserved_instances_modifications - methods: - reserved_instances_modifications_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeReservedInstancesModifications&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/reservedInstancesModificationsSet/item - openAPIDocKey: '200' - id: aws.ec2_api.reserved_instances_modifications - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/reserved_instances_modifications/methods/reserved_instances_modifications_Describe' - update: [] - title: reserved_instances_modifications - reserved_instances_offerings: - name: reserved_instances_offerings - methods: - reserved_instances_offering_Purchase: - operation: - $ref: '#/paths/~1?Action=PurchaseReservedInstancesOffering&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - reserved_instances_offerings_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeReservedInstancesOfferings&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/reservedInstancesOfferingsSet/item - openAPIDocKey: '200' - id: aws.ec2_api.reserved_instances_offerings - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/reserved_instances_offerings/methods/reserved_instances_offerings_Describe' - update: [] - title: reserved_instances_offerings - restore_image_task: - name: restore_image_task - methods: - restore_image_task_Create: - operation: - $ref: '#/paths/~1?Action=CreateRestoreImageTask&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.restore_image_task - sqlVerbs: - delete: [] - insert: - - $ref: '#/components/x-stackQL-resources/restore_image_task/methods/restore_image_task_Create' - select: [] - update: [] - title: restore_image_task - route: - name: route - methods: - route_Create: - operation: - $ref: '#/paths/~1?Action=CreateRoute&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - route_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteRoute&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - route_Replace: - operation: - $ref: '#/paths/~1?Action=ReplaceRoute&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - id: aws.ec2_api.route - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/route/methods/route_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/route/methods/route_Create' - select: [] - update: [] - title: route - route_table_association: - name: route_table_association - methods: - route_table_association_Replace: - operation: - $ref: '#/paths/~1?Action=ReplaceRouteTableAssociation&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.route_table_association - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: route_table_association - route_tables: - name: route_tables - methods: - route_table_Associate: - operation: - $ref: '#/paths/~1?Action=AssociateRouteTable&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - route_table_Create: - operation: - $ref: '#/paths/~1?Action=CreateRouteTable&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - route_table_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteRouteTable&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - route_table_Disassociate: - operation: - $ref: '#/paths/~1?Action=DisassociateRouteTable&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - route_tables_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeRouteTables&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/routeTableSet/item - openAPIDocKey: '200' - id: aws.ec2_api.route_tables - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/route_tables/methods/route_table_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/route_tables/methods/route_table_Create' - select: - - $ref: '#/components/x-stackQL-resources/route_tables/methods/route_tables_Describe' - update: [] - title: route_tables - scheduled_instance_availability: - name: scheduled_instance_availability - methods: - scheduled_instance_availability_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeScheduledInstanceAvailability&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/scheduledInstanceAvailabilitySet/item - openAPIDocKey: '200' - id: aws.ec2_api.scheduled_instance_availability - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/scheduled_instance_availability/methods/scheduled_instance_availability_Describe' - update: [] - title: scheduled_instance_availability - scheduled_instances: - name: scheduled_instances - methods: - scheduled_instances_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeScheduledInstances&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/scheduledInstanceSet/item - openAPIDocKey: '200' - scheduled_instances_Purchase: - operation: - $ref: '#/paths/~1?Action=PurchaseScheduledInstances&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - scheduled_instances_Run: - operation: - $ref: '#/paths/~1?Action=RunScheduledInstances&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.scheduled_instances - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/scheduled_instances/methods/scheduled_instances_Describe' - update: [] - title: scheduled_instances - security_group_egress: - name: security_group_egress - methods: - security_group_egress_Authorize: - operation: - $ref: '#/paths/~1?Action=AuthorizeSecurityGroupEgress&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - security_group_egress_Revoke: - operation: - $ref: '#/paths/~1?Action=RevokeSecurityGroupEgress&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.security_group_egress - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: security_group_egress - security_group_ingress: - name: security_group_ingress - methods: - security_group_ingress_Authorize: - operation: - $ref: '#/paths/~1?Action=AuthorizeSecurityGroupIngress&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - security_group_ingress_Revoke: - operation: - $ref: '#/paths/~1?Action=RevokeSecurityGroupIngress&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.security_group_ingress - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: security_group_ingress - security_group_references: - name: security_group_references - methods: - security_group_references_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeSecurityGroupReferences&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/securityGroupReferenceSet/item - openAPIDocKey: '200' - id: aws.ec2_api.security_group_references - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/security_group_references/methods/security_group_references_Describe' - update: [] - title: security_group_references - security_group_rule_descriptions_egress: - name: security_group_rule_descriptions_egress - methods: - security_group_rule_descriptions_egress_Update: - operation: - $ref: '#/paths/~1?Action=UpdateSecurityGroupRuleDescriptionsEgress&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.security_group_rule_descriptions_egress - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: security_group_rule_descriptions_egress - security_group_rule_descriptions_ingress: - name: security_group_rule_descriptions_ingress - methods: - security_group_rule_descriptions_ingress_Update: - operation: - $ref: '#/paths/~1?Action=UpdateSecurityGroupRuleDescriptionsIngress&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.security_group_rule_descriptions_ingress - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: security_group_rule_descriptions_ingress - security_group_rules: - name: security_group_rules - methods: - security_group_rules_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeSecurityGroupRules&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/securityGroupRuleSet/item - openAPIDocKey: '200' - security_group_rules_Modify: - operation: - $ref: '#/paths/~1?Action=ModifySecurityGroupRules&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.security_group_rules - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/security_group_rules/methods/security_group_rules_Describe' - update: [] - title: security_group_rules - security_groups: - name: security_groups - methods: - security_group_Create: - operation: - $ref: '#/paths/~1?Action=CreateSecurityGroup&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - security_group_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteSecurityGroup&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - security_groups_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeSecurityGroups&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/securityGroupInfo/item - openAPIDocKey: '200' - id: aws.ec2_api.security_groups - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/security_groups/methods/security_group_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/security_groups/methods/security_group_Create' - select: - - $ref: '#/components/x-stackQL-resources/security_groups/methods/security_groups_Describe' - update: [] - title: security_groups - security_groups_to_client_vpn_target_network: - name: security_groups_to_client_vpn_target_network - methods: - security_groups_to_client_vpn_target_network_Apply: - operation: - $ref: '#/paths/~1?Action=ApplySecurityGroupsToClientVpnTargetNetwork&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.security_groups_to_client_vpn_target_network - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: security_groups_to_client_vpn_target_network - serial_console_access: - name: serial_console_access - methods: - serial_console_access_Disable: - operation: - $ref: '#/paths/~1?Action=DisableSerialConsoleAccess&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - serial_console_access_Enable: - operation: - $ref: '#/paths/~1?Action=EnableSerialConsoleAccess&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.serial_console_access - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: serial_console_access - serial_console_access_status: - name: serial_console_access_status - methods: - serial_console_access_status_Get: - operation: - $ref: '#/paths/~1?Action=GetSerialConsoleAccessStatus&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - id: aws.ec2_api.serial_console_access_status - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/serial_console_access_status/methods/serial_console_access_status_Get' - update: [] - title: serial_console_access_status - snapshot_attribute: - name: snapshot_attribute - methods: - snapshot_attribute_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeSnapshotAttribute&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - snapshot_attribute_Modify: - operation: - $ref: '#/paths/~1?Action=ModifySnapshotAttribute&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - snapshot_attribute_Reset: - operation: - $ref: '#/paths/~1?Action=ResetSnapshotAttribute&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - id: aws.ec2_api.snapshot_attribute - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/snapshot_attribute/methods/snapshot_attribute_Describe' - update: [] - title: snapshot_attribute - snapshot_from_recycle_bin: - name: snapshot_from_recycle_bin - methods: - snapshot_from_recycle_bin_Restore: - operation: - $ref: '#/paths/~1?Action=RestoreSnapshotFromRecycleBin&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.snapshot_from_recycle_bin - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: snapshot_from_recycle_bin - snapshot_tier: - name: snapshot_tier - methods: - snapshot_tier_Modify: - operation: - $ref: '#/paths/~1?Action=ModifySnapshotTier&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - snapshot_tier_Restore: - operation: - $ref: '#/paths/~1?Action=RestoreSnapshotTier&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.snapshot_tier - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: snapshot_tier - snapshot_tier_status: - name: snapshot_tier_status - methods: - snapshot_tier_status_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeSnapshotTierStatus&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/snapshotTierStatusSet/item - openAPIDocKey: '200' - id: aws.ec2_api.snapshot_tier_status - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/snapshot_tier_status/methods/snapshot_tier_status_Describe' - update: [] - title: snapshot_tier_status - snapshots: - name: snapshots - methods: - snapshot_Copy: - operation: - $ref: '#/paths/~1?Action=CopySnapshot&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - snapshot_Create: - operation: - $ref: '#/paths/~1?Action=CreateSnapshot&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - snapshot_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteSnapshot&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - snapshot_Import: - operation: - $ref: '#/paths/~1?Action=ImportSnapshot&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - snapshots_Create: - operation: - $ref: '#/paths/~1?Action=CreateSnapshots&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - snapshots_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeSnapshots&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/snapshotSet/item - openAPIDocKey: '200' - id: aws.ec2_api.snapshots - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/snapshots/methods/snapshot_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/snapshots/methods/snapshot_Create' - - $ref: '#/components/x-stackQL-resources/snapshots/methods/snapshots_Create' - select: - - $ref: '#/components/x-stackQL-resources/snapshots/methods/snapshots_Describe' - update: [] - title: snapshots - snapshots_in_recycle_bin: - name: snapshots_in_recycle_bin - methods: - snapshots_in_recycle_bin_List: - operation: - $ref: '#/paths/~1?Action=ListSnapshotsInRecycleBin&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/snapshotSet/item - openAPIDocKey: '200' - id: aws.ec2_api.snapshots_in_recycle_bin - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/snapshots_in_recycle_bin/methods/snapshots_in_recycle_bin_List' - update: [] - title: snapshots_in_recycle_bin - spot_datafeed_subscription: - name: spot_datafeed_subscription - methods: - spot_datafeed_subscription_Create: - operation: - $ref: '#/paths/~1?Action=CreateSpotDatafeedSubscription&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - spot_datafeed_subscription_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteSpotDatafeedSubscription&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - spot_datafeed_subscription_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeSpotDatafeedSubscription&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/spotDatafeedSubscription/* - openAPIDocKey: '200' - id: aws.ec2_api.spot_datafeed_subscription - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/spot_datafeed_subscription/methods/spot_datafeed_subscription_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/spot_datafeed_subscription/methods/spot_datafeed_subscription_Create' - select: - - $ref: '#/components/x-stackQL-resources/spot_datafeed_subscription/methods/spot_datafeed_subscription_Describe' - update: [] - title: spot_datafeed_subscription - spot_fleet: - name: spot_fleet - methods: - spot_fleet_Request: - operation: - $ref: '#/paths/~1?Action=RequestSpotFleet&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.spot_fleet - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: spot_fleet - spot_fleet_instances: - name: spot_fleet_instances - methods: - spot_fleet_instances_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeSpotFleetInstances&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/activeInstanceSet/item - openAPIDocKey: '200' - id: aws.ec2_api.spot_fleet_instances - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/spot_fleet_instances/methods/spot_fleet_instances_Describe' - update: [] - title: spot_fleet_instances - spot_fleet_request_history: - name: spot_fleet_request_history - methods: - spot_fleet_request_history_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeSpotFleetRequestHistory&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/historyRecordSet/item - openAPIDocKey: '200' - id: aws.ec2_api.spot_fleet_request_history - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/spot_fleet_request_history/methods/spot_fleet_request_history_Describe' - update: [] - title: spot_fleet_request_history - spot_fleet_requests: - name: spot_fleet_requests - methods: - spot_fleet_request_Modify: - operation: - $ref: '#/paths/~1?Action=ModifySpotFleetRequest&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - spot_fleet_requests_Cancel: - operation: - $ref: '#/paths/~1?Action=CancelSpotFleetRequests&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - spot_fleet_requests_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeSpotFleetRequests&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/spotFleetRequestConfigSet/item - openAPIDocKey: '200' - id: aws.ec2_api.spot_fleet_requests - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/spot_fleet_requests/methods/spot_fleet_requests_Describe' - update: [] - title: spot_fleet_requests - spot_instance_requests: - name: spot_instance_requests - methods: - spot_instance_requests_Cancel: - operation: - $ref: '#/paths/~1?Action=CancelSpotInstanceRequests&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - spot_instance_requests_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeSpotInstanceRequests&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/spotInstanceRequestSet/item - openAPIDocKey: '200' - id: aws.ec2_api.spot_instance_requests - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/spot_instance_requests/methods/spot_instance_requests_Describe' - update: [] - title: spot_instance_requests - spot_instances: - name: spot_instances - methods: - spot_instances_Request: - operation: - $ref: '#/paths/~1?Action=RequestSpotInstances&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.spot_instances - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: spot_instances - spot_placement_scores: - name: spot_placement_scores - methods: - spot_placement_scores_Get: - operation: - $ref: '#/paths/~1?Action=GetSpotPlacementScores&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/spotPlacementScoreSet/item - openAPIDocKey: '200' - id: aws.ec2_api.spot_placement_scores - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/spot_placement_scores/methods/spot_placement_scores_Get' - update: [] - title: spot_placement_scores - spot_price_history: - name: spot_price_history - methods: - spot_price_history_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeSpotPriceHistory&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/spotPriceHistorySet/item - openAPIDocKey: '200' - id: aws.ec2_api.spot_price_history - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/spot_price_history/methods/spot_price_history_Describe' - update: [] - title: spot_price_history - stale_security_groups: - name: stale_security_groups - methods: - stale_security_groups_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeStaleSecurityGroups&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/staleSecurityGroupSet/item - openAPIDocKey: '200' - id: aws.ec2_api.stale_security_groups - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/stale_security_groups/methods/stale_security_groups_Describe' - update: [] - title: stale_security_groups - store_image_tasks: - name: store_image_tasks - methods: - store_image_task_Create: - operation: - $ref: '#/paths/~1?Action=CreateStoreImageTask&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - store_image_tasks_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeStoreImageTasks&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/storeImageTaskResultSet/item - openAPIDocKey: '200' - id: aws.ec2_api.store_image_tasks - sqlVerbs: - delete: [] - insert: - - $ref: '#/components/x-stackQL-resources/store_image_tasks/methods/store_image_task_Create' - select: - - $ref: '#/components/x-stackQL-resources/store_image_tasks/methods/store_image_tasks_Describe' - update: [] - title: store_image_tasks - subnet_attribute: - name: subnet_attribute - methods: - subnet_attribute_Modify: - operation: - $ref: '#/paths/~1?Action=ModifySubnetAttribute&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - id: aws.ec2_api.subnet_attribute - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: subnet_attribute - subnet_cidr_block: - name: subnet_cidr_block - methods: - subnet_cidr_block_Associate: - operation: - $ref: '#/paths/~1?Action=AssociateSubnetCidrBlock&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - subnet_cidr_block_Disassociate: - operation: - $ref: '#/paths/~1?Action=DisassociateSubnetCidrBlock&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.subnet_cidr_block - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: subnet_cidr_block - subnet_cidr_reservations: - name: subnet_cidr_reservations - methods: - subnet_cidr_reservation_Create: - operation: - $ref: '#/paths/~1?Action=CreateSubnetCidrReservation&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - subnet_cidr_reservation_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteSubnetCidrReservation&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - subnet_cidr_reservations_Get: - operation: - $ref: '#/paths/~1?Action=GetSubnetCidrReservations&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - id: aws.ec2_api.subnet_cidr_reservations - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/subnet_cidr_reservations/methods/subnet_cidr_reservation_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/subnet_cidr_reservations/methods/subnet_cidr_reservation_Create' - select: - - $ref: '#/components/x-stackQL-resources/subnet_cidr_reservations/methods/subnet_cidr_reservations_Get' - update: [] - title: subnet_cidr_reservations - subnets: - name: subnets - methods: - subnet_Create: - operation: - $ref: '#/paths/~1?Action=CreateSubnet&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - subnet_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteSubnet&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - subnets_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeSubnets&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/subnetSet/item - openAPIDocKey: '200' - id: aws.ec2_api.subnets - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/subnets/methods/subnet_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/subnets/methods/subnet_Create' - select: - - $ref: '#/components/x-stackQL-resources/subnets/methods/subnets_Describe' - update: [] - title: subnets - tags: - name: tags - methods: - tags_Create: - operation: - $ref: '#/paths/~1?Action=CreateTags&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - tags_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteTags&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - tags_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeTags&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/tagSet/item - openAPIDocKey: '200' - id: aws.ec2_api.tags - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/tags/methods/tags_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/tags/methods/tags_Create' - select: - - $ref: '#/components/x-stackQL-resources/tags/methods/tags_Describe' - update: [] - title: tags - traffic_mirror_filter_network_services: - name: traffic_mirror_filter_network_services - methods: - traffic_mirror_filter_network_services_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyTrafficMirrorFilterNetworkServices&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.traffic_mirror_filter_network_services - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: traffic_mirror_filter_network_services - traffic_mirror_filter_rule: - name: traffic_mirror_filter_rule - methods: - traffic_mirror_filter_rule_Create: - operation: - $ref: '#/paths/~1?Action=CreateTrafficMirrorFilterRule&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - traffic_mirror_filter_rule_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteTrafficMirrorFilterRule&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - traffic_mirror_filter_rule_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyTrafficMirrorFilterRule&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.traffic_mirror_filter_rule - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/traffic_mirror_filter_rule/methods/traffic_mirror_filter_rule_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/traffic_mirror_filter_rule/methods/traffic_mirror_filter_rule_Create' - select: [] - update: [] - title: traffic_mirror_filter_rule - traffic_mirror_filters: - name: traffic_mirror_filters - methods: - traffic_mirror_filter_Create: - operation: - $ref: '#/paths/~1?Action=CreateTrafficMirrorFilter&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - traffic_mirror_filter_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteTrafficMirrorFilter&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - traffic_mirror_filters_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeTrafficMirrorFilters&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/trafficMirrorFilterSet/item - openAPIDocKey: '200' - id: aws.ec2_api.traffic_mirror_filters - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/traffic_mirror_filters/methods/traffic_mirror_filter_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/traffic_mirror_filters/methods/traffic_mirror_filter_Create' - select: - - $ref: '#/components/x-stackQL-resources/traffic_mirror_filters/methods/traffic_mirror_filters_Describe' - update: [] - title: traffic_mirror_filters - traffic_mirror_sessions: - name: traffic_mirror_sessions - methods: - traffic_mirror_session_Create: - operation: - $ref: '#/paths/~1?Action=CreateTrafficMirrorSession&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - traffic_mirror_session_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteTrafficMirrorSession&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - traffic_mirror_session_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyTrafficMirrorSession&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - traffic_mirror_sessions_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeTrafficMirrorSessions&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/trafficMirrorSessionSet/item - openAPIDocKey: '200' - id: aws.ec2_api.traffic_mirror_sessions - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/traffic_mirror_sessions/methods/traffic_mirror_session_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/traffic_mirror_sessions/methods/traffic_mirror_session_Create' - select: - - $ref: '#/components/x-stackQL-resources/traffic_mirror_sessions/methods/traffic_mirror_sessions_Describe' - update: [] - title: traffic_mirror_sessions - traffic_mirror_targets: - name: traffic_mirror_targets - methods: - traffic_mirror_target_Create: - operation: - $ref: '#/paths/~1?Action=CreateTrafficMirrorTarget&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - traffic_mirror_target_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteTrafficMirrorTarget&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - traffic_mirror_targets_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeTrafficMirrorTargets&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/trafficMirrorTargetSet/item - openAPIDocKey: '200' - id: aws.ec2_api.traffic_mirror_targets - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/traffic_mirror_targets/methods/traffic_mirror_target_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/traffic_mirror_targets/methods/traffic_mirror_target_Create' - select: - - $ref: '#/components/x-stackQL-resources/traffic_mirror_targets/methods/traffic_mirror_targets_Describe' - update: [] - title: traffic_mirror_targets - transit_gateway_attachment_propagations: - name: transit_gateway_attachment_propagations - methods: - transit_gateway_attachment_propagations_Get: - operation: - $ref: '#/paths/~1?Action=GetTransitGatewayAttachmentPropagations&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/transitGatewayAttachmentPropagations/item - openAPIDocKey: '200' - id: aws.ec2_api.transit_gateway_attachment_propagations - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/transit_gateway_attachment_propagations/methods/transit_gateway_attachment_propagations_Get' - update: [] - title: transit_gateway_attachment_propagations - transit_gateway_attachments: - name: transit_gateway_attachments - methods: - transit_gateway_attachments_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeTransitGatewayAttachments&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/transitGatewayAttachments/item - openAPIDocKey: '200' - id: aws.ec2_api.transit_gateway_attachments - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/transit_gateway_attachments/methods/transit_gateway_attachments_Describe' - update: [] - title: transit_gateway_attachments - transit_gateway_connect_peers: - name: transit_gateway_connect_peers - methods: - transit_gateway_connect_peer_Create: - operation: - $ref: '#/paths/~1?Action=CreateTransitGatewayConnectPeer&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_connect_peer_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteTransitGatewayConnectPeer&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_connect_peers_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeTransitGatewayConnectPeers&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/transitGatewayConnectPeerSet/item - openAPIDocKey: '200' - id: aws.ec2_api.transit_gateway_connect_peers - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/transit_gateway_connect_peers/methods/transit_gateway_connect_peer_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/transit_gateway_connect_peers/methods/transit_gateway_connect_peer_Create' - select: - - $ref: '#/components/x-stackQL-resources/transit_gateway_connect_peers/methods/transit_gateway_connect_peers_Describe' - update: [] - title: transit_gateway_connect_peers - transit_gateway_connects: - name: transit_gateway_connects - methods: - transit_gateway_connect_Create: - operation: - $ref: '#/paths/~1?Action=CreateTransitGatewayConnect&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_connect_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteTransitGatewayConnect&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_connects_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeTransitGatewayConnects&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/transitGatewayConnectSet/item - openAPIDocKey: '200' - id: aws.ec2_api.transit_gateway_connects - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/transit_gateway_connects/methods/transit_gateway_connect_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/transit_gateway_connects/methods/transit_gateway_connect_Create' - select: - - $ref: '#/components/x-stackQL-resources/transit_gateway_connects/methods/transit_gateway_connects_Describe' - update: [] - title: transit_gateway_connects - transit_gateway_multicast_domain_associations: - name: transit_gateway_multicast_domain_associations - methods: - transit_gateway_multicast_domain_associations_Accept: - operation: - $ref: '#/paths/~1?Action=AcceptTransitGatewayMulticastDomainAssociations&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_multicast_domain_associations_Get: - operation: - $ref: '#/paths/~1?Action=GetTransitGatewayMulticastDomainAssociations&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/multicastDomainAssociations/item - openAPIDocKey: '200' - transit_gateway_multicast_domain_associations_Reject: - operation: - $ref: '#/paths/~1?Action=RejectTransitGatewayMulticastDomainAssociations&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.transit_gateway_multicast_domain_associations - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/transit_gateway_multicast_domain_associations/methods/transit_gateway_multicast_domain_associations_Get' - update: [] - title: transit_gateway_multicast_domain_associations - transit_gateway_multicast_domains: - name: transit_gateway_multicast_domains - methods: - transit_gateway_multicast_domain_Associate: - operation: - $ref: '#/paths/~1?Action=AssociateTransitGatewayMulticastDomain&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_multicast_domain_Create: - operation: - $ref: '#/paths/~1?Action=CreateTransitGatewayMulticastDomain&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_multicast_domain_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteTransitGatewayMulticastDomain&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_multicast_domain_Disassociate: - operation: - $ref: '#/paths/~1?Action=DisassociateTransitGatewayMulticastDomain&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_multicast_domains_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeTransitGatewayMulticastDomains&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/transitGatewayMulticastDomains/item - openAPIDocKey: '200' - id: aws.ec2_api.transit_gateway_multicast_domains - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/transit_gateway_multicast_domains/methods/transit_gateway_multicast_domain_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/transit_gateway_multicast_domains/methods/transit_gateway_multicast_domain_Create' - select: - - $ref: '#/components/x-stackQL-resources/transit_gateway_multicast_domains/methods/transit_gateway_multicast_domains_Describe' - update: [] - title: transit_gateway_multicast_domains - transit_gateway_multicast_group_members: - name: transit_gateway_multicast_group_members - methods: - transit_gateway_multicast_group_members_Deregister: - operation: - $ref: '#/paths/~1?Action=DeregisterTransitGatewayMulticastGroupMembers&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_multicast_group_members_Register: - operation: - $ref: '#/paths/~1?Action=RegisterTransitGatewayMulticastGroupMembers&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.transit_gateway_multicast_group_members - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: transit_gateway_multicast_group_members - transit_gateway_multicast_group_sources: - name: transit_gateway_multicast_group_sources - methods: - transit_gateway_multicast_group_sources_Deregister: - operation: - $ref: '#/paths/~1?Action=DeregisterTransitGatewayMulticastGroupSources&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_multicast_group_sources_Register: - operation: - $ref: '#/paths/~1?Action=RegisterTransitGatewayMulticastGroupSources&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.transit_gateway_multicast_group_sources - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: transit_gateway_multicast_group_sources - transit_gateway_multicast_groups: - name: transit_gateway_multicast_groups - methods: - transit_gateway_multicast_groups_Search: - operation: - $ref: '#/paths/~1?Action=SearchTransitGatewayMulticastGroups&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.transit_gateway_multicast_groups - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: transit_gateway_multicast_groups - transit_gateway_peering_attachments: - name: transit_gateway_peering_attachments - methods: - transit_gateway_peering_attachment_Accept: - operation: - $ref: '#/paths/~1?Action=AcceptTransitGatewayPeeringAttachment&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_peering_attachment_Create: - operation: - $ref: '#/paths/~1?Action=CreateTransitGatewayPeeringAttachment&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_peering_attachment_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteTransitGatewayPeeringAttachment&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_peering_attachment_Reject: - operation: - $ref: '#/paths/~1?Action=RejectTransitGatewayPeeringAttachment&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_peering_attachments_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeTransitGatewayPeeringAttachments&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/transitGatewayPeeringAttachments/item - openAPIDocKey: '200' - id: aws.ec2_api.transit_gateway_peering_attachments - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/transit_gateway_peering_attachments/methods/transit_gateway_peering_attachment_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/transit_gateway_peering_attachments/methods/transit_gateway_peering_attachment_Create' - select: - - $ref: '#/components/x-stackQL-resources/transit_gateway_peering_attachments/methods/transit_gateway_peering_attachments_Describe' - update: [] - title: transit_gateway_peering_attachments - transit_gateway_prefix_list_references: - name: transit_gateway_prefix_list_references - methods: - transit_gateway_prefix_list_reference_Create: - operation: - $ref: '#/paths/~1?Action=CreateTransitGatewayPrefixListReference&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_prefix_list_reference_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteTransitGatewayPrefixListReference&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_prefix_list_reference_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyTransitGatewayPrefixListReference&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_prefix_list_references_Get: - operation: - $ref: '#/paths/~1?Action=GetTransitGatewayPrefixListReferences&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/transitGatewayPrefixListReferenceSet/item - openAPIDocKey: '200' - id: aws.ec2_api.transit_gateway_prefix_list_references - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/transit_gateway_prefix_list_references/methods/transit_gateway_prefix_list_reference_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/transit_gateway_prefix_list_references/methods/transit_gateway_prefix_list_reference_Create' - select: - - $ref: '#/components/x-stackQL-resources/transit_gateway_prefix_list_references/methods/transit_gateway_prefix_list_references_Get' - update: [] - title: transit_gateway_prefix_list_references - transit_gateway_route_table_associations: - name: transit_gateway_route_table_associations - methods: - transit_gateway_route_table_associations_Get: - operation: - $ref: '#/paths/~1?Action=GetTransitGatewayRouteTableAssociations&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/associations/item - openAPIDocKey: '200' - id: aws.ec2_api.transit_gateway_route_table_associations - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/transit_gateway_route_table_associations/methods/transit_gateway_route_table_associations_Get' - update: [] - title: transit_gateway_route_table_associations - transit_gateway_route_table_propagations: - name: transit_gateway_route_table_propagations - methods: - transit_gateway_route_table_propagation_Disable: - operation: - $ref: '#/paths/~1?Action=DisableTransitGatewayRouteTablePropagation&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_route_table_propagation_Enable: - operation: - $ref: '#/paths/~1?Action=EnableTransitGatewayRouteTablePropagation&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_route_table_propagations_Get: - operation: - $ref: '#/paths/~1?Action=GetTransitGatewayRouteTablePropagations&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/transitGatewayRouteTablePropagations/item - openAPIDocKey: '200' - id: aws.ec2_api.transit_gateway_route_table_propagations - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/transit_gateway_route_table_propagations/methods/transit_gateway_route_table_propagations_Get' - update: [] - title: transit_gateway_route_table_propagations - transit_gateway_route_tables: - name: transit_gateway_route_tables - methods: - transit_gateway_route_table_Associate: - operation: - $ref: '#/paths/~1?Action=AssociateTransitGatewayRouteTable&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_route_table_Create: - operation: - $ref: '#/paths/~1?Action=CreateTransitGatewayRouteTable&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_route_table_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteTransitGatewayRouteTable&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_route_table_Disassociate: - operation: - $ref: '#/paths/~1?Action=DisassociateTransitGatewayRouteTable&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_route_tables_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeTransitGatewayRouteTables&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/transitGatewayRouteTables/item - openAPIDocKey: '200' - id: aws.ec2_api.transit_gateway_route_tables - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/transit_gateway_route_tables/methods/transit_gateway_route_table_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/transit_gateway_route_tables/methods/transit_gateway_route_table_Create' - select: - - $ref: '#/components/x-stackQL-resources/transit_gateway_route_tables/methods/transit_gateway_route_tables_Describe' - update: [] - title: transit_gateway_route_tables - transit_gateway_routes: - name: transit_gateway_routes - methods: - transit_gateway_route_Create: - operation: - $ref: '#/paths/~1?Action=CreateTransitGatewayRoute&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_route_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteTransitGatewayRoute&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_route_Replace: - operation: - $ref: '#/paths/~1?Action=ReplaceTransitGatewayRoute&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_routes_Export: - operation: - $ref: '#/paths/~1?Action=ExportTransitGatewayRoutes&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_routes_Search: - operation: - $ref: '#/paths/~1?Action=SearchTransitGatewayRoutes&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.transit_gateway_routes - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/transit_gateway_routes/methods/transit_gateway_route_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/transit_gateway_routes/methods/transit_gateway_route_Create' - select: [] - update: [] - title: transit_gateway_routes - transit_gateway_vpc_attachments: - name: transit_gateway_vpc_attachments - methods: - transit_gateway_vpc_attachment_Accept: - operation: - $ref: '#/paths/~1?Action=AcceptTransitGatewayVpcAttachment&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_vpc_attachment_Create: - operation: - $ref: '#/paths/~1?Action=CreateTransitGatewayVpcAttachment&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_vpc_attachment_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteTransitGatewayVpcAttachment&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_vpc_attachment_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyTransitGatewayVpcAttachment&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_vpc_attachment_Reject: - operation: - $ref: '#/paths/~1?Action=RejectTransitGatewayVpcAttachment&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_vpc_attachments_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeTransitGatewayVpcAttachments&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/transitGatewayVpcAttachments/item - openAPIDocKey: '200' - id: aws.ec2_api.transit_gateway_vpc_attachments - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/transit_gateway_vpc_attachments/methods/transit_gateway_vpc_attachment_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/transit_gateway_vpc_attachments/methods/transit_gateway_vpc_attachment_Create' - select: - - $ref: '#/components/x-stackQL-resources/transit_gateway_vpc_attachments/methods/transit_gateway_vpc_attachments_Describe' - update: [] - title: transit_gateway_vpc_attachments - transit_gateways: - name: transit_gateways - methods: - transit_gateway_Create: - operation: - $ref: '#/paths/~1?Action=CreateTransitGateway&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteTransitGateway&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateway_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyTransitGateway&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - transit_gateways_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeTransitGateways&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/transitGatewaySet/item - openAPIDocKey: '200' - id: aws.ec2_api.transit_gateways - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/transit_gateways/methods/transit_gateway_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/transit_gateways/methods/transit_gateway_Create' - select: - - $ref: '#/components/x-stackQL-resources/transit_gateways/methods/transit_gateways_Describe' - update: [] - title: transit_gateways - trunk_interface: - name: trunk_interface - methods: - trunk_interface_Associate: - operation: - $ref: '#/paths/~1?Action=AssociateTrunkInterface&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - trunk_interface_Disassociate: - operation: - $ref: '#/paths/~1?Action=DisassociateTrunkInterface&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.trunk_interface - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: trunk_interface - trunk_interface_associations: - name: trunk_interface_associations - methods: - trunk_interface_associations_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeTrunkInterfaceAssociations&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/interfaceAssociationSet/item - openAPIDocKey: '200' - id: aws.ec2_api.trunk_interface_associations - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/trunk_interface_associations/methods/trunk_interface_associations_Describe' - update: [] - title: trunk_interface_associations - vgw_route_propagation: - name: vgw_route_propagation - methods: - vgw_route_propagation_Disable: - operation: - $ref: '#/paths/~1?Action=DisableVgwRoutePropagation&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - vgw_route_propagation_Enable: - operation: - $ref: '#/paths/~1?Action=EnableVgwRoutePropagation&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - id: aws.ec2_api.vgw_route_propagation - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: vgw_route_propagation - volume_attribute: - name: volume_attribute - methods: - volume_attribute_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeVolumeAttribute&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - volume_attribute_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyVolumeAttribute&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - id: aws.ec2_api.volume_attribute - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/volume_attribute/methods/volume_attribute_Describe' - update: [] - title: volume_attribute - volume_i_o: - name: volume_i_o - methods: - volume_i_o_Enable: - operation: - $ref: '#/paths/~1?Action=EnableVolumeIO&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - id: aws.ec2_api.volume_i_o - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: volume_i_o - volume_status: - name: volume_status - methods: - volume_status_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeVolumeStatus&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/volumeStatusSet/item - openAPIDocKey: '200' - id: aws.ec2_api.volume_status - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/volume_status/methods/volume_status_Describe' - update: [] - title: volume_status - volumes: - name: volumes - methods: - volume_Attach: - operation: - $ref: '#/paths/~1?Action=AttachVolume&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - volume_Create: - operation: - $ref: '#/paths/~1?Action=CreateVolume&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - volume_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteVolume&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - volume_Detach: - operation: - $ref: '#/paths/~1?Action=DetachVolume&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - volume_Import: - operation: - $ref: '#/paths/~1?Action=ImportVolume&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - volume_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyVolume&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - volumes_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeVolumes&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/volumeSet/item - openAPIDocKey: '200' - id: aws.ec2_api.volumes - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/volumes/methods/volume_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/volumes/methods/volume_Create' - select: - - $ref: '#/components/x-stackQL-resources/volumes/methods/volumes_Describe' - update: - - $ref: '#/components/x-stackQL-resources/volumes/methods/volume_Modify' - title: volumes - volumes_modifications: - name: volumes_modifications - methods: - volumes_modifications_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeVolumesModifications&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/volumeModificationSet/item - openAPIDocKey: '200' - id: aws.ec2_api.volumes_modifications - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/volumes_modifications/methods/volumes_modifications_Describe' - update: [] - title: volumes_modifications - vpc_attribute: - name: vpc_attribute - methods: - vpc_attribute_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeVpcAttribute&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - vpc_attribute_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyVpcAttribute&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - id: aws.ec2_api.vpc_attribute - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/vpc_attribute/methods/vpc_attribute_Describe' - update: [] - title: vpc_attribute - vpc_cidr_block: - name: vpc_cidr_block - methods: - vpc_cidr_block_Associate: - operation: - $ref: '#/paths/~1?Action=AssociateVpcCidrBlock&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - vpc_cidr_block_Disassociate: - operation: - $ref: '#/paths/~1?Action=DisassociateVpcCidrBlock&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.vpc_cidr_block - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: vpc_cidr_block - vpc_classic_link: - name: vpc_classic_link - methods: - vpc_classic_link_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeVpcClassicLink&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/vpcSet/item - openAPIDocKey: '200' - vpc_classic_link_Disable: - operation: - $ref: '#/paths/~1?Action=DisableVpcClassicLink&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - vpc_classic_link_Enable: - operation: - $ref: '#/paths/~1?Action=EnableVpcClassicLink&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.vpc_classic_link - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/vpc_classic_link/methods/vpc_classic_link_Describe' - update: [] - title: vpc_classic_link - vpc_classic_link_dns_support: - name: vpc_classic_link_dns_support - methods: - vpc_classic_link_dns_support_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeVpcClassicLinkDnsSupport&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/vpcs/item - openAPIDocKey: '200' - vpc_classic_link_dns_support_Disable: - operation: - $ref: '#/paths/~1?Action=DisableVpcClassicLinkDnsSupport&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - vpc_classic_link_dns_support_Enable: - operation: - $ref: '#/paths/~1?Action=EnableVpcClassicLinkDnsSupport&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.vpc_classic_link_dns_support - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/vpc_classic_link_dns_support/methods/vpc_classic_link_dns_support_Describe' - update: [] - title: vpc_classic_link_dns_support - vpc_endpoint_connection_notifications: - name: vpc_endpoint_connection_notifications - methods: - vpc_endpoint_connection_notification_Create: - operation: - $ref: '#/paths/~1?Action=CreateVpcEndpointConnectionNotification&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - vpc_endpoint_connection_notification_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyVpcEndpointConnectionNotification&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - vpc_endpoint_connection_notifications_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteVpcEndpointConnectionNotifications&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - vpc_endpoint_connection_notifications_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeVpcEndpointConnectionNotifications&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/connectionNotificationSet/item - openAPIDocKey: '200' - id: aws.ec2_api.vpc_endpoint_connection_notifications - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/vpc_endpoint_connection_notifications/methods/vpc_endpoint_connection_notifications_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/vpc_endpoint_connection_notifications/methods/vpc_endpoint_connection_notification_Create' - select: - - $ref: '#/components/x-stackQL-resources/vpc_endpoint_connection_notifications/methods/vpc_endpoint_connection_notifications_Describe' - update: [] - title: vpc_endpoint_connection_notifications - vpc_endpoint_connections: - name: vpc_endpoint_connections - methods: - vpc_endpoint_connections_Accept: - operation: - $ref: '#/paths/~1?Action=AcceptVpcEndpointConnections&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - vpc_endpoint_connections_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeVpcEndpointConnections&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/vpcEndpointConnectionSet/item - openAPIDocKey: '200' - vpc_endpoint_connections_Reject: - operation: - $ref: '#/paths/~1?Action=RejectVpcEndpointConnections&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.vpc_endpoint_connections - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/vpc_endpoint_connections/methods/vpc_endpoint_connections_Describe' - update: [] - title: vpc_endpoint_connections - vpc_endpoint_service_configurations: - name: vpc_endpoint_service_configurations - methods: - vpc_endpoint_service_configuration_Create: - operation: - $ref: '#/paths/~1?Action=CreateVpcEndpointServiceConfiguration&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - vpc_endpoint_service_configuration_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyVpcEndpointServiceConfiguration&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - vpc_endpoint_service_configurations_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteVpcEndpointServiceConfigurations&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - vpc_endpoint_service_configurations_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeVpcEndpointServiceConfigurations&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/serviceConfigurationSet/item - openAPIDocKey: '200' - id: aws.ec2_api.vpc_endpoint_service_configurations - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/vpc_endpoint_service_configurations/methods/vpc_endpoint_service_configurations_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/vpc_endpoint_service_configurations/methods/vpc_endpoint_service_configuration_Create' - select: - - $ref: '#/components/x-stackQL-resources/vpc_endpoint_service_configurations/methods/vpc_endpoint_service_configurations_Describe' - update: [] - title: vpc_endpoint_service_configurations - vpc_endpoint_service_payer_responsibility: - name: vpc_endpoint_service_payer_responsibility - methods: - vpc_endpoint_service_payer_responsibility_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyVpcEndpointServicePayerResponsibility&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.vpc_endpoint_service_payer_responsibility - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: vpc_endpoint_service_payer_responsibility - vpc_endpoint_service_permissions: - name: vpc_endpoint_service_permissions - methods: - vpc_endpoint_service_permissions_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeVpcEndpointServicePermissions&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/allowedPrincipals/item - openAPIDocKey: '200' - vpc_endpoint_service_permissions_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyVpcEndpointServicePermissions&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.vpc_endpoint_service_permissions - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/vpc_endpoint_service_permissions/methods/vpc_endpoint_service_permissions_Describe' - update: [] - title: vpc_endpoint_service_permissions - vpc_endpoint_service_private_dns_verification: - name: vpc_endpoint_service_private_dns_verification - methods: - vpc_endpoint_service_private_dns_verification_Start: - operation: - $ref: '#/paths/~1?Action=StartVpcEndpointServicePrivateDnsVerification&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.vpc_endpoint_service_private_dns_verification - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: vpc_endpoint_service_private_dns_verification - vpc_endpoint_services: - name: vpc_endpoint_services - methods: - vpc_endpoint_services_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeVpcEndpointServices&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/serviceDetailSet/item - openAPIDocKey: '200' - id: aws.ec2_api.vpc_endpoint_services - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/vpc_endpoint_services/methods/vpc_endpoint_services_Describe' - update: [] - title: vpc_endpoint_services - vpc_endpoints: - name: vpc_endpoints - methods: - vpc_endpoint_Create: - operation: - $ref: '#/paths/~1?Action=CreateVpcEndpoint&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - vpc_endpoint_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyVpcEndpoint&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - vpc_endpoints_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteVpcEndpoints&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - vpc_endpoints_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeVpcEndpoints&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/vpcEndpointSet/item - openAPIDocKey: '200' - id: aws.ec2_api.vpc_endpoints - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/vpc_endpoints/methods/vpc_endpoints_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/vpc_endpoints/methods/vpc_endpoint_Create' - select: - - $ref: '#/components/x-stackQL-resources/vpc_endpoints/methods/vpc_endpoints_Describe' - update: [] - title: vpc_endpoints - vpc_peering_connection_options: - name: vpc_peering_connection_options - methods: - vpc_peering_connection_options_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyVpcPeeringConnectionOptions&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.vpc_peering_connection_options - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: vpc_peering_connection_options - vpc_peering_connections: - name: vpc_peering_connections - methods: - vpc_peering_connection_Accept: - operation: - $ref: '#/paths/~1?Action=AcceptVpcPeeringConnection&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - vpc_peering_connection_Create: - operation: - $ref: '#/paths/~1?Action=CreateVpcPeeringConnection&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - vpc_peering_connection_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteVpcPeeringConnection&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - vpc_peering_connection_Reject: - operation: - $ref: '#/paths/~1?Action=RejectVpcPeeringConnection&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - vpc_peering_connections_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeVpcPeeringConnections&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/vpcPeeringConnectionSet/item - openAPIDocKey: '200' - id: aws.ec2_api.vpc_peering_connections - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/vpc_peering_connections/methods/vpc_peering_connection_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/vpc_peering_connections/methods/vpc_peering_connection_Create' - select: - - $ref: '#/components/x-stackQL-resources/vpc_peering_connections/methods/vpc_peering_connections_Describe' - update: [] - title: vpc_peering_connections - vpc_tenancy: - name: vpc_tenancy - methods: - vpc_tenancy_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyVpcTenancy&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.vpc_tenancy - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: vpc_tenancy - vpcs: - name: vpcs - methods: - vpc_Create: - operation: - $ref: '#/paths/~1?Action=CreateVpc&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - vpc_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteVpc&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - vpcs_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeVpcs&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/vpcSet/item - openAPIDocKey: '200' - id: aws.ec2_api.vpcs - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/vpcs/methods/vpc_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/vpcs/methods/vpc_Create' - select: - - $ref: '#/components/x-stackQL-resources/vpcs/methods/vpcs_Describe' - update: [] - title: vpcs - vpn_connection_device_sample_configuration: - name: vpn_connection_device_sample_configuration - methods: - vpn_connection_device_sample_configuration_Get: - operation: - $ref: '#/paths/~1?Action=GetVpnConnectionDeviceSampleConfiguration&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - id: aws.ec2_api.vpn_connection_device_sample_configuration - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/vpn_connection_device_sample_configuration/methods/vpn_connection_device_sample_configuration_Get' - update: [] - title: vpn_connection_device_sample_configuration - vpn_connection_device_types: - name: vpn_connection_device_types - methods: - vpn_connection_device_types_Get: - operation: - $ref: '#/paths/~1?Action=GetVpnConnectionDeviceTypes&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/vpnConnectionDeviceTypeSet/item - openAPIDocKey: '200' - id: aws.ec2_api.vpn_connection_device_types - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/vpn_connection_device_types/methods/vpn_connection_device_types_Get' - update: [] - title: vpn_connection_device_types - vpn_connection_options: - name: vpn_connection_options - methods: - vpn_connection_options_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyVpnConnectionOptions&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.vpn_connection_options - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: vpn_connection_options - vpn_connection_route: - name: vpn_connection_route - methods: - vpn_connection_route_Create: - operation: - $ref: '#/paths/~1?Action=CreateVpnConnectionRoute&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - vpn_connection_route_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteVpnConnectionRoute&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - id: aws.ec2_api.vpn_connection_route - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/vpn_connection_route/methods/vpn_connection_route_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/vpn_connection_route/methods/vpn_connection_route_Create' - select: [] - update: [] - title: vpn_connection_route - vpn_connections: - name: vpn_connections - methods: - vpn_connection_Create: - operation: - $ref: '#/paths/~1?Action=CreateVpnConnection&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - vpn_connection_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteVpnConnection&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - vpn_connection_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyVpnConnection&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - vpn_connections_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeVpnConnections&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/vpnConnectionSet/item - openAPIDocKey: '200' - id: aws.ec2_api.vpn_connections - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/vpn_connections/methods/vpn_connection_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/vpn_connections/methods/vpn_connection_Create' - select: - - $ref: '#/components/x-stackQL-resources/vpn_connections/methods/vpn_connections_Describe' - update: [] - title: vpn_connections - vpn_gateways: - name: vpn_gateways - methods: - vpn_gateway_Attach: - operation: - $ref: '#/paths/~1?Action=AttachVpnGateway&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - vpn_gateway_Create: - operation: - $ref: '#/paths/~1?Action=CreateVpnGateway&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - vpn_gateway_Delete: - operation: - $ref: '#/paths/~1?Action=DeleteVpnGateway&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - vpn_gateway_Detach: - operation: - $ref: '#/paths/~1?Action=DetachVpnGateway&Version=2016-11-15/get' - response: - openAPIDocKey: '200' - vpn_gateways_Describe: - operation: - $ref: '#/paths/~1?Action=DescribeVpnGateways&Version=2016-11-15/get' - response: - mediaType: text/xml - objectKey: /*/vpnGatewaySet/item - openAPIDocKey: '200' - id: aws.ec2_api.vpn_gateways - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/vpn_gateways/methods/vpn_gateway_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/vpn_gateways/methods/vpn_gateway_Create' - select: - - $ref: '#/components/x-stackQL-resources/vpn_gateways/methods/vpn_gateways_Describe' - update: [] - title: vpn_gateways - vpn_tunnel_certificate: - name: vpn_tunnel_certificate - methods: - vpn_tunnel_certificate_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyVpnTunnelCertificate&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.vpn_tunnel_certificate - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: vpn_tunnel_certificate - vpn_tunnel_options: - name: vpn_tunnel_options - methods: - vpn_tunnel_options_Modify: - operation: - $ref: '#/paths/~1?Action=ModifyVpnTunnelOptions&Version=2016-11-15/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - id: aws.ec2_api.vpn_tunnel_options - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: vpn_tunnel_options - parameters: - X-Amz-Content-Sha256: - name: X-Amz-Content-Sha256 - in: header - schema: - type: string - required: false - X-Amz-Date: - name: X-Amz-Date - in: header - schema: - type: string - required: false - X-Amz-Algorithm: - name: X-Amz-Algorithm - in: header - schema: - type: string - required: false - X-Amz-Credential: - name: X-Amz-Credential - in: header - schema: - type: string - required: false - X-Amz-Security-Token: - name: X-Amz-Security-Token - in: header - schema: - type: string - required: false - X-Amz-Signature: - name: X-Amz-Signature - in: header - schema: - type: string - required: false - X-Amz-SignedHeaders: - name: X-Amz-SignedHeaders - in: header - schema: - type: string - required: false - securitySchemes: - hmac: - type: apiKey - name: Authorization - in: header - description: Amazon Signature authorization v4 - x-amazon-apigateway-authtype: awsSigv4 - schemas: - AcceptReservedInstancesExchangeQuoteResult: - type: object - properties: - exchangeId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the successful exchange. - description: The result of the exchange and whether it was successful. - ReservationId: - type: string - TargetConfigurationRequest: - type: object - required: - - OfferingId - properties: - undefined: - allOf: - - $ref: '#/components/schemas/ReservedInstancesOfferingId' - - description: The Convertible Reserved Instance offering ID. - description: Details about the target configuration. - AcceptTransitGatewayMulticastDomainAssociationsResult: - type: object - properties: - associations: - $ref: '#/components/schemas/TransitGatewayMulticastDomainAssociations' - String: - type: string - AcceptTransitGatewayPeeringAttachmentResult: - type: object - properties: - transitGatewayPeeringAttachment: - allOf: - - $ref: '#/components/schemas/TransitGatewayPeeringAttachment' - - description: The transit gateway peering attachment. - AcceptTransitGatewayVpcAttachmentResult: - type: object - properties: - transitGatewayVpcAttachment: - allOf: - - $ref: '#/components/schemas/TransitGatewayVpcAttachment' - - description: The VPC attachment. - AcceptVpcEndpointConnectionsResult: - type: object - properties: - unsuccessful: - allOf: - - $ref: '#/components/schemas/UnsuccessfulItemSet' - - description: 'Information about the interface endpoints that were not accepted, if applicable.' - VpcEndpointId: - type: string - AcceptVpcPeeringConnectionResult: - type: object - properties: - vpcPeeringConnection: - allOf: - - $ref: '#/components/schemas/VpcPeeringConnection' - - description: Information about the VPC peering connection. - AdvertiseByoipCidrResult: - type: object - properties: - byoipCidr: - allOf: - - $ref: '#/components/schemas/ByoipCidr' - - description: Information about the address range. - AllocateAddressResult: - type: object - example: - Domain: standard - PublicIp: 198.51.100.0 - properties: - publicIp: - allOf: - - $ref: '#/components/schemas/String' - - description: The Elastic IP address. - allocationId: - allOf: - - $ref: '#/components/schemas/String' - - description: '[EC2-VPC] The ID that Amazon Web Services assigns to represent the allocation of the Elastic IP address for use with instances in a VPC.' - publicIpv4Pool: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of an address pool. - networkBorderGroup: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses.' - domain: - allOf: - - $ref: '#/components/schemas/DomainType' - - description: Indicates whether the Elastic IP address is for use with instances in a VPC (vpc) or instances in EC2-Classic (standard). - customerOwnedIp: - allOf: - - $ref: '#/components/schemas/String' - - description: The customer-owned IP address. - customerOwnedIpv4Pool: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the customer-owned address pool. - carrierIp: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The carrier IP address. This option is only available for network interfaces which reside in a subnet in a Wavelength Zone (for example an EC2 instance). ' - TagSpecification: - type: object - properties: - resourceType: - allOf: - - $ref: '#/components/schemas/ResourceType' - - description: The type of resource to tag on creation. - Tag: - allOf: - - $ref: '#/components/schemas/TagList' - - description: The tags to apply to the resource. - description: The tags to apply to a resource when the resource is being created. - AllocateHostsResult: - type: object - properties: - hostIdSet: - allOf: - - $ref: '#/components/schemas/ResponseHostIdList' - - description: The ID of the allocated Dedicated Host. This is used to launch an instance onto a specific host. - description: Contains the output of AllocateHosts. - AllocateIpamPoolCidrResult: - type: object - properties: - ipamPoolAllocation: - allOf: - - $ref: '#/components/schemas/IpamPoolAllocation' - - description: Information about the allocation created. - ApplySecurityGroupsToClientVpnTargetNetworkResult: - type: object - properties: - securityGroupIds: - allOf: - - $ref: '#/components/schemas/ClientVpnSecurityGroupIdSet' - - description: The IDs of the applied security groups. - SecurityGroupId: - type: string - AssignIpv6AddressesResult: - type: object - properties: - assignedIpv6Addresses: - allOf: - - $ref: '#/components/schemas/Ipv6AddressList' - - description: The new IPv6 addresses assigned to the network interface. Existing IPv6 addresses that were assigned to the network interface before the request are not included. - assignedIpv6PrefixSet: - allOf: - - $ref: '#/components/schemas/IpPrefixList' - - description: The IPv6 prefixes that are assigned to the network interface. - networkInterfaceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the network interface. - AssignPrivateIpAddressesResult: - type: object - properties: - networkInterfaceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the network interface. - assignedPrivateIpAddressesSet: - allOf: - - $ref: '#/components/schemas/AssignedPrivateIpAddressList' - - description: The private IP addresses assigned to the network interface. - assignedIpv4PrefixSet: - allOf: - - $ref: '#/components/schemas/Ipv4PrefixesList' - - description: The IPv4 prefixes that are assigned to the network interface. - AssociateAddressResult: - type: object - example: - AssociationId: eipassoc-2bebb745 - properties: - associationId: - allOf: - - $ref: '#/components/schemas/String' - - description: '[EC2-VPC] The ID that represents the association of the Elastic IP address with an instance.' - AssociateClientVpnTargetNetworkResult: - type: object - properties: - associationId: - allOf: - - $ref: '#/components/schemas/String' - - description: The unique ID of the target network association. - status: - allOf: - - $ref: '#/components/schemas/AssociationStatus' - - description: The current state of the target network association. - AssociateEnclaveCertificateIamRoleResult: - type: object - properties: - certificateS3BucketName: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of the Amazon S3 bucket to which the certificate was uploaded. - certificateS3ObjectKey: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The Amazon S3 object key where the certificate, certificate chain, and encrypted private key bundle are stored. The object key is formatted as follows: role_arn/certificate_arn.' - encryptionKmsKeyId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the KMS key used to encrypt the private key of the certificate. - AssociateIamInstanceProfileResult: - type: object - example: - IamInstanceProfileAssociation: - AssociationId: iip-assoc-0e7736511a163c209 - IamInstanceProfile: - Arn: 'arn:aws:iam::123456789012:instance-profile/admin-role' - Id: AIPAJBLK7RKJKWDXVHIEC - InstanceId: i-123456789abcde123 - State: associating - properties: - iamInstanceProfileAssociation: - allOf: - - $ref: '#/components/schemas/IamInstanceProfileAssociation' - - description: Information about the IAM instance profile association. - AssociateInstanceEventWindowResult: - type: object - properties: - instanceEventWindow: - allOf: - - $ref: '#/components/schemas/InstanceEventWindow' - - description: Information about the event window. - InstanceIdList: - type: array - items: - allOf: - - $ref: '#/components/schemas/InstanceId' - - xml: - name: item - TagList: - type: array - items: - allOf: - - $ref: '#/components/schemas/Tag' - - xml: - name: item - DedicatedHostIdList: - type: array - items: - allOf: - - $ref: '#/components/schemas/DedicatedHostId' - - xml: - name: item - AssociateRouteTableResult: - type: object - example: - AssociationId: rtbassoc-781d0d1a - properties: - associationId: - allOf: - - $ref: '#/components/schemas/String' - - description: The route table association ID. This ID is required for disassociating the route table. - associationState: - allOf: - - $ref: '#/components/schemas/RouteTableAssociationState' - - description: The state of the association. - AssociateSubnetCidrBlockResult: - type: object - properties: - ipv6CidrBlockAssociation: - allOf: - - $ref: '#/components/schemas/SubnetIpv6CidrBlockAssociation' - - description: Information about the IPv6 association. - subnetId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the subnet. - AssociateTransitGatewayMulticastDomainResult: - type: object - properties: - associations: - allOf: - - $ref: '#/components/schemas/TransitGatewayMulticastDomainAssociations' - - description: Information about the transit gateway multicast domain associations. - SubnetId: - type: string - AssociateTransitGatewayRouteTableResult: - type: object - properties: - association: - allOf: - - $ref: '#/components/schemas/TransitGatewayAssociation' - - description: The ID of the association. - AssociateTrunkInterfaceResult: - type: object - properties: - interfaceAssociation: - allOf: - - $ref: '#/components/schemas/TrunkInterfaceAssociation' - - description: Information about the association between the trunk network interface and branch network interface. - clientToken: - allOf: - - $ref: '#/components/schemas/String' - - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.' - AssociateVpcCidrBlockResult: - type: object - properties: - ipv6CidrBlockAssociation: - allOf: - - $ref: '#/components/schemas/VpcIpv6CidrBlockAssociation' - - description: Information about the IPv6 CIDR block association. - cidrBlockAssociation: - allOf: - - $ref: '#/components/schemas/VpcCidrBlockAssociation' - - description: Information about the IPv4 CIDR block association. - vpcId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the VPC. - AttachClassicLinkVpcResult: - type: object - properties: - return: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Returns true if the request succeeds; otherwise, it returns an error.' - AttachNetworkInterfaceResult: - type: object - example: - AttachmentId: eni-attach-66c4350a - properties: - attachmentId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the network interface attachment. - networkCardIndex: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The index of the network card. - description: Contains the output of AttachNetworkInterface. - VolumeAttachment: - type: object - example: - AttachTime: '2014-02-27T19:23:06.000Z' - Device: /dev/sdb - InstanceId: i-1234567890abcdef0 - State: detaching - VolumeId: vol-049df61146c4d7901 - properties: - attachTime: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The time stamp when the attachment initiated. - device: - allOf: - - $ref: '#/components/schemas/String' - - description: The device name. - instanceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the instance. - status: - allOf: - - $ref: '#/components/schemas/VolumeAttachmentState' - - description: The attachment state of the volume. - volumeId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the volume. - deleteOnTermination: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether the EBS volume is deleted on instance termination. - description: Describes volume attachment details. - AttachVpnGatewayResult: - type: object - properties: - attachment: - allOf: - - $ref: '#/components/schemas/VpcAttachment' - - description: Information about the attachment. - description: Contains the output of AttachVpnGateway. - AuthorizeClientVpnIngressResult: - type: object - properties: - status: - allOf: - - $ref: '#/components/schemas/ClientVpnAuthorizationRuleStatus' - - description: The current state of the authorization rule. - AuthorizeSecurityGroupEgressResult: - type: object - example: {} - properties: - return: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Returns true if the request succeeds; otherwise, returns an error.' - securityGroupRuleSet: - allOf: - - $ref: '#/components/schemas/SecurityGroupRuleList' - - description: Information about the outbound (egress) security group rules that were added. - IpPermission: - type: object - properties: - fromPort: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.' - ipProtocol: - allOf: - - $ref: '#/components/schemas/String' - - description: '

The IP protocol name (tcp, udp, icmp, icmpv6) or number (see Protocol Numbers).

[VPC only] Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp, udp, and icmp, you must specify a port range. For icmpv6, the port range is optional; if you omit the port range, traffic for all types and codes is allowed.

' - ipRanges: - allOf: - - $ref: '#/components/schemas/IpRangeList' - - description: The IPv4 ranges. - ipv6Ranges: - allOf: - - $ref: '#/components/schemas/Ipv6RangeList' - - description: '[VPC only] The IPv6 ranges.' - prefixListIds: - allOf: - - $ref: '#/components/schemas/PrefixListIdList' - - description: '[VPC only] The prefix list IDs.' - toPort: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.' - groups: - allOf: - - $ref: '#/components/schemas/UserIdGroupPairList' - - description: The security group and Amazon Web Services account ID pairs. - description: Describes a set of permissions for a security group rule. - AuthorizeSecurityGroupIngressResult: - type: object - example: {} - properties: - return: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Returns true if the request succeeds; otherwise, returns an error.' - securityGroupRuleSet: - allOf: - - $ref: '#/components/schemas/SecurityGroupRuleList' - - description: Information about the inbound (ingress) security group rules that were added. - BundleInstanceResult: - type: object - properties: - bundleInstanceTask: - allOf: - - $ref: '#/components/schemas/BundleTask' - - description: Information about the bundle task. - description: Contains the output of BundleInstance. - S3Storage: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The access key ID of the owner of the bucket. Before you specify a value for your access key ID, review and follow the guidance in Best Practices for Managing Amazon Web Services Access Keys.' - bucket: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.' - prefix: - allOf: - - $ref: '#/components/schemas/String' - - description: The beginning of the file name of the AMI. - uploadPolicy: - allOf: - - $ref: '#/components/schemas/Blob' - - description: An Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf. - uploadPolicySignature: - allOf: - - $ref: '#/components/schemas/String' - - description: The signature of the JSON document. - description: Describes the storage parameters for Amazon S3 and Amazon S3 buckets for an instance store-backed AMI. - CancelBundleTaskResult: - type: object - properties: - bundleInstanceTask: - allOf: - - $ref: '#/components/schemas/BundleTask' - - description: Information about the bundle task. - description: Contains the output of CancelBundleTask. - CancelCapacityReservationResult: - type: object - properties: - return: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Returns true if the request succeeds; otherwise, it returns an error.' - CancelCapacityReservationFleetsResult: - type: object - properties: - successfulFleetCancellationSet: - allOf: - - $ref: '#/components/schemas/CapacityReservationFleetCancellationStateSet' - - description: Information about the Capacity Reservation Fleets that were successfully cancelled. - failedFleetCancellationSet: - allOf: - - $ref: '#/components/schemas/FailedCapacityReservationFleetCancellationResultSet' - - description: Information about the Capacity Reservation Fleets that could not be cancelled. - CapacityReservationFleetId: - type: string - CancelImportTaskResult: - type: object - properties: - importTaskId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the task being canceled. - previousState: - allOf: - - $ref: '#/components/schemas/String' - - description: The current state of the task being canceled. - state: - allOf: - - $ref: '#/components/schemas/String' - - description: The current state of the task being canceled. - CancelReservedInstancesListingResult: - type: object - properties: - reservedInstancesListingsSet: - allOf: - - $ref: '#/components/schemas/ReservedInstancesListingList' - - description: The Reserved Instance listing. - description: Contains the output of CancelReservedInstancesListing. - CancelSpotFleetRequestsResponse: - type: object - example: - SuccessfulFleetRequests: - - CurrentSpotFleetRequestState: cancelled_terminating - PreviousSpotFleetRequestState: active - SpotFleetRequestId: sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE - properties: - successfulFleetRequestSet: - allOf: - - $ref: '#/components/schemas/CancelSpotFleetRequestsSuccessSet' - - description: Information about the Spot Fleet requests that are successfully canceled. - unsuccessfulFleetRequestSet: - allOf: - - $ref: '#/components/schemas/CancelSpotFleetRequestsErrorSet' - - description: Information about the Spot Fleet requests that are not successfully canceled. - description: Contains the output of CancelSpotFleetRequests. - SpotFleetRequestId: - type: string - CancelSpotInstanceRequestsResult: - type: object - example: - CancelledSpotInstanceRequests: - - SpotInstanceRequestId: sir-08b93456 - State: cancelled - properties: - spotInstanceRequestSet: - allOf: - - $ref: '#/components/schemas/CancelledSpotInstanceRequestList' - - description: One or more Spot Instance requests. - description: Contains the output of CancelSpotInstanceRequests. - SpotInstanceRequestId: - type: string - ConfirmProductInstanceResult: - type: object - example: - OwnerId: '123456789012' - properties: - ownerId: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Web Services account ID of the instance owner. This is only present if the product code is attached to the instance. - return: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: The return value of the request. Returns true if the specified product code is owned by the requester and associated with the specified instance. - CopyFpgaImageResult: - type: object - properties: - fpgaImageId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the new AFI. - CopyImageResult: - type: object - example: - ImageId: ami-438bea42 - properties: - imageId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the new AMI. - description: Contains the output of CopyImage. - CopySnapshotResult: - type: object - example: - SnapshotId: snap-066877671789bd71b - properties: - snapshotId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the new snapshot. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: Any tags applied to the new snapshot. - CreateCapacityReservationResult: - type: object - properties: - capacityReservation: - allOf: - - $ref: '#/components/schemas/CapacityReservation' - - description: Information about the Capacity Reservation. - CreateCapacityReservationFleetResult: - type: object - properties: - capacityReservationFleetId: - allOf: - - $ref: '#/components/schemas/CapacityReservationFleetId' - - description: The ID of the Capacity Reservation Fleet. - state: - allOf: - - $ref: '#/components/schemas/CapacityReservationFleetState' - - description: The status of the Capacity Reservation Fleet. - totalTargetCapacity: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The total number of capacity units for which the Capacity Reservation Fleet reserves capacity. - totalFulfilledCapacity: - allOf: - - $ref: '#/components/schemas/Double' - - description: The requested capacity units that have been successfully reserved. - instanceMatchCriteria: - allOf: - - $ref: '#/components/schemas/FleetInstanceMatchCriteria' - - description: The instance matching criteria for the Capacity Reservation Fleet. - allocationStrategy: - allOf: - - $ref: '#/components/schemas/String' - - description: The allocation strategy used by the Capacity Reservation Fleet. - createTime: - allOf: - - $ref: '#/components/schemas/MillisecondDateTime' - - description: The date and time at which the Capacity Reservation Fleet was created. - endDate: - allOf: - - $ref: '#/components/schemas/MillisecondDateTime' - - description: The date and time at which the Capacity Reservation Fleet expires. - tenancy: - allOf: - - $ref: '#/components/schemas/FleetCapacityReservationTenancy' - - description: Indicates the tenancy of Capacity Reservation Fleet. - fleetCapacityReservationSet: - allOf: - - $ref: '#/components/schemas/FleetCapacityReservationSet' - - description: Information about the individual Capacity Reservations in the Capacity Reservation Fleet. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: The tags assigned to the Capacity Reservation Fleet. - ReservationFleetInstanceSpecification: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/IntegerWithConstraints' - - description: 'The priority to assign to the instance type. This value is used to determine which of the instance types specified for the Fleet should be prioritized for use. A lower value indicates a high priority. For more information, see Instance type priority in the Amazon EC2 User Guide.' - description: Information about an instance type to use in a Capacity Reservation Fleet. - CreateCarrierGatewayResult: - type: object - properties: - carrierGateway: - allOf: - - $ref: '#/components/schemas/CarrierGateway' - - description: Information about the carrier gateway. - CreateClientVpnEndpointResult: - type: object - properties: - clientVpnEndpointId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Client VPN endpoint. - status: - allOf: - - $ref: '#/components/schemas/ClientVpnEndpointStatus' - - description: The current state of the Client VPN endpoint. - dnsName: - allOf: - - $ref: '#/components/schemas/String' - - description: The DNS name to be used by clients when establishing their VPN session. - ClientVpnAuthenticationRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/FederatedAuthenticationRequest' - - description: 'Information about the IAM SAML identity provider to be used, if applicable. You must provide this information if Type is federated-authentication.' - description: 'Describes the authentication method to be used by a Client VPN endpoint. For more information, see Authentication in the Client VPN Administrator Guide.' - CreateClientVpnRouteResult: - type: object - properties: - status: - allOf: - - $ref: '#/components/schemas/ClientVpnRouteStatus' - - description: The current state of the route. - CreateCustomerGatewayResult: - type: object - example: - CustomerGateway: - BgpAsn: '65534' - CustomerGatewayId: cgw-0e11f167 - IpAddress: 12.1.2.3 - State: available - Type: ipsec.1 - properties: - customerGateway: - allOf: - - $ref: '#/components/schemas/CustomerGateway' - - description: Information about the customer gateway. - description: Contains the output of CreateCustomerGateway. - CreateDefaultSubnetResult: - type: object - properties: - subnet: - allOf: - - $ref: '#/components/schemas/Subnet' - - description: Information about the subnet. - CreateDefaultVpcResult: - type: object - properties: - vpc: - allOf: - - $ref: '#/components/schemas/Vpc' - - description: Information about the VPC. - CreateDhcpOptionsResult: - type: object - example: - DhcpOptions: - DhcpConfigurations: - - Key: domain-name-servers - Values: - - Value: 10.2.5.2 - - Value: 10.2.5.1 - DhcpOptionsId: dopt-d9070ebb - properties: - dhcpOptions: - allOf: - - $ref: '#/components/schemas/DhcpOptions' - - description: A set of DHCP options. - NewDhcpConfiguration: - type: object - properties: - key: - $ref: '#/components/schemas/String' - Value: - $ref: '#/components/schemas/ValueStringList' - CreateEgressOnlyInternetGatewayResult: - type: object - properties: - clientToken: - allOf: - - $ref: '#/components/schemas/String' - - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.' - egressOnlyInternetGateway: - allOf: - - $ref: '#/components/schemas/EgressOnlyInternetGateway' - - description: Information about the egress-only internet gateway. - CreateFleetResult: - type: object - properties: - fleetId: - allOf: - - $ref: '#/components/schemas/FleetId' - - description: The ID of the EC2 Fleet. - errorSet: - allOf: - - $ref: '#/components/schemas/CreateFleetErrorsSet' - - description: Information about the instances that could not be launched by the fleet. Supported only for fleets of type instant. - fleetInstanceSet: - allOf: - - $ref: '#/components/schemas/CreateFleetInstancesSet' - - description: Information about the instances that were launched by the fleet. Supported only for fleets of type instant. - FleetLaunchTemplateConfigRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/FleetLaunchTemplateOverridesListRequest' - - description: '

Any parameters that you specify override the same parameters in the launch template.

For fleets of type request and maintain, a maximum of 300 items is allowed across all launch templates.

' - description: Describes a launch template and overrides. - TargetCapacityUnitType: - type: string - enum: - - vcpu - - memory-mib - - units - CreateFlowLogsResult: - type: object - properties: - clientToken: - allOf: - - $ref: '#/components/schemas/String' - - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.' - flowLogIdSet: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The IDs of the flow logs. - unsuccessful: - allOf: - - $ref: '#/components/schemas/UnsuccessfulItemSet' - - description: Information about the flow logs that could not be created successfully. - FlowLogResourceId: - type: string - Boolean: - type: boolean - CreateFpgaImageResult: - type: object - properties: - fpgaImageId: - allOf: - - $ref: '#/components/schemas/String' - - description: The FPGA image identifier (AFI ID). - fpgaImageGlobalId: - allOf: - - $ref: '#/components/schemas/String' - - description: The global FPGA image identifier (AGFI ID). - CreateImageResult: - type: object - example: - ImageId: ami-1a2b3c4d - properties: - imageId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the new AMI. - BlockDeviceMapping: - type: object - properties: - deviceName: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The device name (for example, /dev/sdh or xvdh).' - virtualName: - allOf: - - $ref: '#/components/schemas/String' - - description: '

The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.

NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.

Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.

' - ebs: - allOf: - - $ref: '#/components/schemas/EbsBlockDevice' - - description: Parameters used to automatically set up EBS volumes when the instance is launched. - noDevice: - allOf: - - $ref: '#/components/schemas/String' - - description: 'To omit the device from the block device mapping, specify an empty string. When this property is specified, the device is removed from the block device mapping regardless of the assigned value.' - description: 'Describes a block device mapping, which defines the EBS volumes and instance store volumes to attach to an instance at launch.' - CreateInstanceEventWindowResult: - type: object - properties: - instanceEventWindow: - allOf: - - $ref: '#/components/schemas/InstanceEventWindow' - - description: Information about the event window. - InstanceEventWindowTimeRangeRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Hour' - - description: The hour when the time range ends. - description: 'The start day and time and the end day and time of the time range, in UTC.' - CreateInstanceExportTaskResult: - type: object - properties: - exportTask: - allOf: - - $ref: '#/components/schemas/ExportTask' - - description: Information about the export instance task. - ContainerFormat: - type: string - enum: - - ova - DiskImageFormat: - type: string - enum: - - VMDK - - RAW - - VHD - CreateInternetGatewayResult: - type: object - example: - InternetGateway: - Attachments: [] - InternetGatewayId: igw-c0a643a9 - Tags: [] - properties: - internetGateway: - allOf: - - $ref: '#/components/schemas/InternetGateway' - - description: Information about the internet gateway. - CreateIpamResult: - type: object - properties: - ipam: - allOf: - - $ref: '#/components/schemas/Ipam' - - description: Information about the IPAM created. - AddIpamOperatingRegion: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of the operating Region. - description: '

Add an operating Region to an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.

' - CreateIpamPoolResult: - type: object - properties: - ipamPool: - allOf: - - $ref: '#/components/schemas/IpamPool' - - description: Information about the IPAM pool created. - RequestIpamResourceTag: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The value for the tag. - description: A tag on an IPAM resource. - CreateIpamScopeResult: - type: object - properties: - ipamScope: - allOf: - - $ref: '#/components/schemas/IpamScope' - - description: Information about the created scope. - KeyPair: - type: object - properties: - keyFingerprint: - allOf: - - $ref: '#/components/schemas/String' - - description: '

  • For RSA key pairs, the key fingerprint is the SHA-1 digest of the DER encoded private key.

  • For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8.

' - keyMaterial: - allOf: - - $ref: '#/components/schemas/SensitiveUserData' - - description: An unencrypted PEM encoded RSA or ED25519 private key. - keyName: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of the key pair. - keyPairId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the key pair. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: Any tags applied to the key pair. - description: Describes a key pair. - CreateLaunchTemplateResult: - type: object - example: - LaunchTemplate: - CreateTime: '2017-11-27T09:13:24.000Z' - CreatedBy: 'arn:aws:iam::123456789012:root' - DefaultVersionNumber: 1 - LatestVersionNumber: 1 - LaunchTemplateId: lt-01238c059e3466abc - LaunchTemplateName: my-template - properties: - launchTemplate: - allOf: - - $ref: '#/components/schemas/LaunchTemplate' - - description: Information about the launch template. - warning: - allOf: - - $ref: '#/components/schemas/ValidationWarning' - - description: 'If the launch template contains parameters or parameter combinations that are not valid, an error code and an error message are returned for each issue that''s found.' - LaunchTemplateIamInstanceProfileSpecificationRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of the instance profile. - description: An IAM instance profile. - LaunchTemplateBlockDeviceMappingRequestList: - type: array - items: - allOf: - - $ref: '#/components/schemas/LaunchTemplateBlockDeviceMappingRequest' - - xml: - name: BlockDeviceMapping - LaunchTemplateTagSpecificationRequestList: - type: array - items: - allOf: - - $ref: '#/components/schemas/LaunchTemplateTagSpecificationRequest' - - xml: - name: LaunchTemplateTagSpecificationRequest - ElasticGpuSpecificationList: - type: array - items: - allOf: - - $ref: '#/components/schemas/ElasticGpuSpecification' - - xml: - name: ElasticGpuSpecification - LaunchTemplateElasticInferenceAcceleratorList: - type: array - items: - allOf: - - $ref: '#/components/schemas/LaunchTemplateElasticInferenceAccelerator' - - xml: - name: item - SecurityGroupIdStringList: - type: array - items: - allOf: - - $ref: '#/components/schemas/SecurityGroupId' - - xml: - name: SecurityGroupId - LaunchTemplateCapacityReservationSpecificationRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/CapacityReservationTarget' - - description: Information about the target Capacity Reservation or Capacity Reservation group. - description: 'Describes an instance''s Capacity Reservation targeting option. You can specify only one option at a time. Use the CapacityReservationPreference parameter to configure the instance to run in On-Demand capacity or to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). Use the CapacityReservationTarget parameter to explicitly target a specific Capacity Reservation or a Capacity Reservation group.' - LaunchTemplateInstanceMaintenanceOptionsRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/LaunchTemplateAutoRecoveryState' - - description: 'Disables the automatic recovery behavior of your instance or sets it to default. For more information, see Simplified automatic recovery.' - description: The maintenance options of your instance. - CreateLaunchTemplateVersionResult: - type: object - example: - LaunchTemplateVersion: - CreateTime: '2017-12-01T13:35:46.000Z' - CreatedBy: 'arn:aws:iam::123456789012:root' - DefaultVersion: false - LaunchTemplateData: - ImageId: ami-c998b6b2 - InstanceType: t2.micro - NetworkInterfaces: - - AssociatePublicIpAddress: true - DeviceIndex: 0 - Ipv6Addresses: - - Ipv6Address: '2001:db8:1234:1a00::123' - SubnetId: subnet-7b16de0c - LaunchTemplateId: lt-0abcd290751193123 - LaunchTemplateName: my-template - VersionDescription: WebVersion2 - VersionNumber: 2 - properties: - launchTemplateVersion: - allOf: - - $ref: '#/components/schemas/LaunchTemplateVersion' - - description: Information about the launch template version. - warning: - allOf: - - $ref: '#/components/schemas/ValidationWarning' - - description: 'If the new version of the launch template contains parameters or parameter combinations that are not valid, an error code and an error message are returned for each issue that''s found.' - CreateLocalGatewayRouteResult: - type: object - properties: - route: - allOf: - - $ref: '#/components/schemas/LocalGatewayRoute' - - description: Information about the route. - CreateLocalGatewayRouteTableVpcAssociationResult: - type: object - properties: - localGatewayRouteTableVpcAssociation: - allOf: - - $ref: '#/components/schemas/LocalGatewayRouteTableVpcAssociation' - - description: Information about the association. - CreateManagedPrefixListResult: - type: object - properties: - prefixList: - allOf: - - $ref: '#/components/schemas/ManagedPrefixList' - - description: Information about the prefix list. - AddPrefixListEntry: - type: object - required: - - Cidr - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: '

A description for the entry.

Constraints: Up to 255 characters in length.

' - description: An entry for a prefix list. - CreateNatGatewayResult: - type: object - example: - NatGateway: - CreateTime: '2015-12-17T12:45:26.732Z' - NatGatewayAddresses: - - AllocationId: eipalloc-37fc1a52 - NatGatewayId: nat-08d48af2a8e83edfd - State: pending - SubnetId: subnet-1a2b3c4d - VpcId: vpc-1122aabb - properties: - clientToken: - allOf: - - $ref: '#/components/schemas/String' - - description: 'Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request.' - natGateway: - allOf: - - $ref: '#/components/schemas/NatGateway' - - description: Information about the NAT gateway. - CreateNetworkAclResult: - type: object - example: - NetworkAcl: - Associations: [] - Entries: - - CidrBlock: 0.0.0.0/0 - Egress: true - Protocol: '-1' - RuleAction: deny - RuleNumber: 32767 - - CidrBlock: 0.0.0.0/0 - Egress: false - Protocol: '-1' - RuleAction: deny - RuleNumber: 32767 - IsDefault: false - NetworkAclId: acl-5fb85d36 - Tags: [] - VpcId: vpc-a01106c2 - properties: - networkAcl: - allOf: - - $ref: '#/components/schemas/NetworkAcl' - - description: Information about the network ACL. - Integer: - type: integer - CreateNetworkInsightsAccessScopeResult: - type: object - properties: - networkInsightsAccessScope: - allOf: - - $ref: '#/components/schemas/NetworkInsightsAccessScope' - - description: The Network Access Scope. - networkInsightsAccessScopeContent: - allOf: - - $ref: '#/components/schemas/NetworkInsightsAccessScopeContent' - - description: The Network Access Scope content. - AccessScopePathRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/PathStatementRequest' - - description: The destination. - ThroughResource: - allOf: - - $ref: '#/components/schemas/ThroughResourcesStatementRequestList' - - description: The through resources. - description: Describes a path. - CreateNetworkInsightsPathResult: - type: object - properties: - networkInsightsPath: - allOf: - - $ref: '#/components/schemas/NetworkInsightsPath' - - description: Information about the path. - CreateNetworkInterfaceResult: - type: object - example: - NetworkInterface: - AvailabilityZone: us-east-1d - Description: my network interface - Groups: - - GroupId: sg-903004f8 - GroupName: default - MacAddress: '02:1a:80:41:52:9c' - NetworkInterfaceId: eni-e5aa89a3 - OwnerId: '123456789012' - PrivateIpAddress: 10.0.2.17 - PrivateIpAddresses: - - Primary: true - PrivateIpAddress: 10.0.2.17 - RequesterManaged: false - SourceDestCheck: true - Status: pending - SubnetId: subnet-9d4a7b6c - TagSet: [] - VpcId: vpc-a01106c2 - properties: - networkInterface: - allOf: - - $ref: '#/components/schemas/NetworkInterface' - - description: Information about the network interface. - clientToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - description: Contains the output of CreateNetworkInterface. - InstanceIpv6Address: - type: object - properties: - ipv6Address: - allOf: - - $ref: '#/components/schemas/String' - - description: The IPv6 address. - description: Describes an IPv6 address. - PrivateIpAddressSpecification: - type: object - properties: - primary: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary. - privateIpAddress: - allOf: - - $ref: '#/components/schemas/String' - - description: The private IPv4 addresses. - description: Describes a secondary private IPv4 address for a network interface. - Ipv4PrefixSpecificationRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The IPv4 prefix. For information, see Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.' - description: Describes the IPv4 prefix option for a network interface. - Ipv6PrefixSpecificationRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The IPv6 prefix. - description: Describes the IPv4 prefix option for a network interface. - CreateNetworkInterfacePermissionResult: - type: object - properties: - interfacePermission: - allOf: - - $ref: '#/components/schemas/NetworkInterfacePermission' - - description: Information about the permission for the network interface. - description: Contains the output of CreateNetworkInterfacePermission. - CreatePlacementGroupResult: - type: object - example: {} - properties: - placementGroup: - $ref: '#/components/schemas/PlacementGroup' - CreatePublicIpv4PoolResult: - type: object - properties: - poolId: - allOf: - - $ref: '#/components/schemas/Ipv4PoolEc2Id' - - description: The ID of the public IPv4 pool. - CreateReplaceRootVolumeTaskResult: - type: object - properties: - replaceRootVolumeTask: - allOf: - - $ref: '#/components/schemas/ReplaceRootVolumeTask' - - description: Information about the root volume replacement task. - CreateReservedInstancesListingResult: - type: object - properties: - reservedInstancesListingsSet: - allOf: - - $ref: '#/components/schemas/ReservedInstancesListingList' - - description: Information about the Standard Reserved Instance listing. - description: Contains the output of CreateReservedInstancesListing. - PriceScheduleSpecification: - type: object - properties: - currencyCode: - allOf: - - $ref: '#/components/schemas/CurrencyCodeValues' - - description: 'The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD.' - price: - allOf: - - $ref: '#/components/schemas/Double' - - description: The fixed price for the term. - term: - allOf: - - $ref: '#/components/schemas/Long' - - description: 'The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.' - description: Describes the price for a Reserved Instance. - CreateRestoreImageTaskResult: - type: object - properties: - imageId: - allOf: - - $ref: '#/components/schemas/String' - - description: The AMI ID. - CreateRouteResult: - type: object - properties: - return: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Returns true if the request succeeds; otherwise, it returns an error.' - CreateRouteTableResult: - type: object - example: - RouteTable: - Associations: [] - PropagatingVgws: [] - RouteTableId: rtb-22574640 - Routes: - - DestinationCidrBlock: 10.0.0.0/16 - GatewayId: local - State: active - Tags: [] - VpcId: vpc-a01106c2 - properties: - routeTable: - allOf: - - $ref: '#/components/schemas/RouteTable' - - description: Information about the route table. - CreateSecurityGroupResult: - type: object - example: - GroupId: sg-903004f8 - properties: - groupId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the security group. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: The tags assigned to the security group. - Snapshot: - type: object - example: - Description: This is my root volume snapshot. - OwnerId: 012345678910 - SnapshotId: snap-066877671789bd71b - StartTime: '2014-02-28T21:06:01.000Z' - State: pending - Tags: [] - VolumeId: vol-1234567890abcdef0 - VolumeSize: 8 - properties: - dataEncryptionKeyId: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy. Because data encryption keys are inherited by volumes created from snapshots, and vice versa, if snapshots share the same data encryption key identifier, then they belong to the same volume/snapshot lineage. This parameter is only returned by DescribeSnapshots.' - description: - allOf: - - $ref: '#/components/schemas/String' - - description: The description for the snapshot. - encrypted: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether the snapshot is encrypted. - kmsKeyId: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the volume encryption key for the parent volume. - ownerId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Amazon Web Services account that owns the EBS snapshot. - progress: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The progress of the snapshot, as a percentage.' - snapshotId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the snapshot. Each snapshot receives a unique identifier when it is created. - startTime: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The time stamp when the snapshot was initiated. - status: - allOf: - - $ref: '#/components/schemas/SnapshotState' - - description: The snapshot state. - statusMessage: - allOf: - - $ref: '#/components/schemas/String' - - description: 'Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper Key Management Service (KMS) permissions are not obtained) this field displays error state details to help you diagnose why the error occurred. This parameter is only returned by DescribeSnapshots.' - volumeId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the volume that was used to create the snapshot. Snapshots created by the CopySnapshot action have an arbitrary volume ID that should not be used for any purpose. - volumeSize: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The size of the volume, in GiB.' - ownerAlias: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The Amazon Web Services owner alias, from an Amazon-maintained list (amazon). This is not the user-configured Amazon Web Services account alias set using the IAM console.' - outpostArn: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The ARN of the Outpost on which the snapshot is stored. For more information, see Amazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.' - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: Any tags assigned to the snapshot. - storageTier: - allOf: - - $ref: '#/components/schemas/StorageTier' - - description: The storage tier in which the snapshot is stored. standard indicates that the snapshot is stored in the standard snapshot storage tier and that it is ready for use. archive indicates that the snapshot is currently archived and that it must be restored before it can be used. - restoreExpiryTime: - allOf: - - $ref: '#/components/schemas/MillisecondDateTime' - - description: Only for archived snapshots that are temporarily restored. Indicates the date and time when a temporarily restored snapshot will be automatically re-archived. - description: Describes a snapshot. - CreateSnapshotsResult: - type: object - properties: - snapshotSet: - allOf: - - $ref: '#/components/schemas/SnapshotSet' - - description: List of snapshots. - CreateSpotDatafeedSubscriptionResult: - type: object - example: - SpotDatafeedSubscription: - Bucket: my-s3-bucket - OwnerId: '123456789012' - Prefix: spotdata - State: Active - properties: - spotDatafeedSubscription: - allOf: - - $ref: '#/components/schemas/SpotDatafeedSubscription' - - description: The Spot Instance data feed subscription. - description: Contains the output of CreateSpotDatafeedSubscription. - CreateStoreImageTaskResult: - type: object - properties: - objectKey: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of the stored AMI object in the S3 bucket. - S3ObjectTag: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: '

The value of the tag.

Constraints: Tag values are case-sensitive and can be up to 256 Unicode characters in length.

' - description: 'The tags to apply to the AMI object that will be stored in the Amazon S3 bucket. For more information, see Categorizing your storage using tags in the Amazon Simple Storage Service User Guide.' - CreateSubnetResult: - type: object - example: - Subnet: - AvailabilityZone: us-west-2c - AvailableIpAddressCount: 251 - CidrBlock: 10.0.1.0/24 - State: pending - SubnetId: subnet-9d4a7b6c - VpcId: vpc-a01106c2 - properties: - subnet: - allOf: - - $ref: '#/components/schemas/Subnet' - - description: Information about the subnet. - CreateSubnetCidrReservationResult: - type: object - properties: - subnetCidrReservation: - allOf: - - $ref: '#/components/schemas/SubnetCidrReservation' - - description: Information about the created subnet CIDR reservation. - TaggableResourceId: - type: string - Tag: - type: object - properties: - key: - allOf: - - $ref: '#/components/schemas/String' - - description: '

The key of the tag.

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

' - value: - allOf: - - $ref: '#/components/schemas/String' - - description: '

The value of the tag.

Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

' - description: Describes a tag. - CreateTrafficMirrorFilterResult: - type: object - properties: - trafficMirrorFilter: - allOf: - - $ref: '#/components/schemas/TrafficMirrorFilter' - - description: Information about the Traffic Mirror filter. - clientToken: - allOf: - - $ref: '#/components/schemas/String' - - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.' - CreateTrafficMirrorFilterRuleResult: - type: object - properties: - trafficMirrorFilterRule: - allOf: - - $ref: '#/components/schemas/TrafficMirrorFilterRule' - - description: The Traffic Mirror rule. - clientToken: - allOf: - - $ref: '#/components/schemas/String' - - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.' - CreateTrafficMirrorSessionResult: - type: object - properties: - trafficMirrorSession: - allOf: - - $ref: '#/components/schemas/TrafficMirrorSession' - - description: Information about the Traffic Mirror session. - clientToken: - allOf: - - $ref: '#/components/schemas/String' - - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.' - CreateTrafficMirrorTargetResult: - type: object - properties: - trafficMirrorTarget: - allOf: - - $ref: '#/components/schemas/TrafficMirrorTarget' - - description: Information about the Traffic Mirror target. - clientToken: - allOf: - - $ref: '#/components/schemas/String' - - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.' - CreateTransitGatewayResult: - type: object - properties: - transitGateway: - allOf: - - $ref: '#/components/schemas/TransitGateway' - - description: Information about the transit gateway. - TransitGatewayCidrBlockStringList: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - CreateTransitGatewayConnectResult: - type: object - properties: - transitGatewayConnect: - allOf: - - $ref: '#/components/schemas/TransitGatewayConnect' - - description: Information about the Connect attachment. - ProtocolValue: - type: string - enum: - - gre - CreateTransitGatewayConnectPeerResult: - type: object - properties: - transitGatewayConnectPeer: - allOf: - - $ref: '#/components/schemas/TransitGatewayConnectPeer' - - description: Information about the Connect peer. - Long: - type: integer - CreateTransitGatewayMulticastDomainResult: - type: object - properties: - transitGatewayMulticastDomain: - allOf: - - $ref: '#/components/schemas/TransitGatewayMulticastDomain' - - description: Information about the transit gateway multicast domain. - AutoAcceptSharedAssociationsValue: - type: string - enum: - - enable - - disable - CreateTransitGatewayPeeringAttachmentResult: - type: object - properties: - transitGatewayPeeringAttachment: - allOf: - - $ref: '#/components/schemas/TransitGatewayPeeringAttachment' - - description: The transit gateway peering attachment. - CreateTransitGatewayPrefixListReferenceResult: - type: object - properties: - transitGatewayPrefixListReference: - allOf: - - $ref: '#/components/schemas/TransitGatewayPrefixListReference' - - description: Information about the prefix list reference. - CreateTransitGatewayRouteResult: - type: object - properties: - route: - allOf: - - $ref: '#/components/schemas/TransitGatewayRoute' - - description: Information about the route. - CreateTransitGatewayRouteTableResult: - type: object - properties: - transitGatewayRouteTable: - allOf: - - $ref: '#/components/schemas/TransitGatewayRouteTable' - - description: Information about the transit gateway route table. - CreateTransitGatewayVpcAttachmentResult: - type: object - properties: - transitGatewayVpcAttachment: - allOf: - - $ref: '#/components/schemas/TransitGatewayVpcAttachment' - - description: Information about the VPC attachment. - ApplianceModeSupportValue: - type: string - enum: - - enable - - disable - Volume: - type: object - example: - Attachments: [] - AvailabilityZone: us-east-1a - CreateTime: '2016-08-29T18:52:32.724Z' - Iops: 1000 - Size: 500 - SnapshotId: snap-066877671789bd71b - State: creating - Tags: [] - VolumeId: vol-1234567890abcdef0 - VolumeType: io1 - properties: - attachmentSet: - allOf: - - $ref: '#/components/schemas/VolumeAttachmentList' - - description: Information about the volume attachments. - AvailabilityZone: - allOf: - - $ref: '#/components/schemas/String' - - description: The Availability Zone for the volume. - - xml: - name: 'availabilityZone' - createTime: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The time stamp when volume creation was initiated. - encrypted: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether the volume is encrypted. - kmsKeyId: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the volume encryption key for the volume. - outpostArn: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Resource Name (ARN) of the Outpost. - size: - type: integer - description: 'The size of the volume, in GiBs.' - snapshotId: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The snapshot from which the volume was created, if applicable.' - status: - allOf: - - $ref: '#/components/schemas/VolumeState' - - description: The volume state. - volumeId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the volume. - iops: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.' - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: Any tags assigned to the volume. - volumeType: - allOf: - - $ref: '#/components/schemas/VolumeType' - - description: The volume type. - fastRestored: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether the volume was created using fast snapshot restore. - multiAttachEnabled: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether Amazon EBS Multi-Attach is enabled. - throughput: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The throughput that the volume supports, in MiB/s.' - description: Describes a volume. - CreateVpcResult: - type: object - example: - Vpc: - CidrBlock: 10.0.0.0/16 - DhcpOptionsId: dopt-7a8b9c2d - InstanceTenancy: default - State: pending - VpcId: vpc-a01106c2 - properties: - vpc: - allOf: - - $ref: '#/components/schemas/Vpc' - - description: Information about the VPC. - CreateVpcEndpointResult: - type: object - properties: - vpcEndpoint: - allOf: - - $ref: '#/components/schemas/VpcEndpoint' - - description: Information about the endpoint. - clientToken: - allOf: - - $ref: '#/components/schemas/String' - - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.' - description: Contains the output of CreateVpcEndpoint. - RouteTableId: - type: string - DnsRecordIpType: - type: string - enum: - - ipv4 - - dualstack - - ipv6 - - service-defined - CreateVpcEndpointConnectionNotificationResult: - type: object - properties: - connectionNotification: - allOf: - - $ref: '#/components/schemas/ConnectionNotification' - - description: Information about the notification. - clientToken: - allOf: - - $ref: '#/components/schemas/String' - - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.' - CreateVpcEndpointServiceConfigurationResult: - type: object - properties: - serviceConfiguration: - allOf: - - $ref: '#/components/schemas/ServiceConfiguration' - - description: Information about the service configuration. - clientToken: - allOf: - - $ref: '#/components/schemas/String' - - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.' - CreateVpcPeeringConnectionResult: - type: object - properties: - vpcPeeringConnection: - allOf: - - $ref: '#/components/schemas/VpcPeeringConnection' - - description: Information about the VPC peering connection. - CreateVpnConnectionResult: - type: object - properties: - vpnConnection: - allOf: - - $ref: '#/components/schemas/VpnConnection' - - description: Information about the VPN connection. - description: Contains the output of CreateVpnConnection. - CreateVpnGatewayResult: - type: object - properties: - vpnGateway: - allOf: - - $ref: '#/components/schemas/VpnGateway' - - description: Information about the virtual private gateway. - description: Contains the output of CreateVpnGateway. - DeleteCarrierGatewayResult: - type: object - properties: - carrierGateway: - allOf: - - $ref: '#/components/schemas/CarrierGateway' - - description: Information about the carrier gateway. - DeleteClientVpnEndpointResult: - type: object - properties: - status: - allOf: - - $ref: '#/components/schemas/ClientVpnEndpointStatus' - - description: The current state of the Client VPN endpoint. - DeleteClientVpnRouteResult: - type: object - properties: - status: - allOf: - - $ref: '#/components/schemas/ClientVpnRouteStatus' - - description: The current state of the route. - DeleteEgressOnlyInternetGatewayResult: - type: object - properties: - returnCode: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Returns true if the request succeeds; otherwise, it returns an error.' - DeleteFleetsResult: - type: object - properties: - successfulFleetDeletionSet: - allOf: - - $ref: '#/components/schemas/DeleteFleetSuccessSet' - - description: Information about the EC2 Fleets that are successfully deleted. - unsuccessfulFleetDeletionSet: - allOf: - - $ref: '#/components/schemas/DeleteFleetErrorSet' - - description: Information about the EC2 Fleets that are not successfully deleted. - FleetId: - type: string - DeleteFlowLogsResult: - type: object - properties: - unsuccessful: - allOf: - - $ref: '#/components/schemas/UnsuccessfulItemSet' - - description: Information about the flow logs that could not be deleted successfully. - VpcFlowLogId: - type: string - DeleteFpgaImageResult: - type: object - properties: - return: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Is true if the request succeeds, and an error otherwise.' - DeleteInstanceEventWindowResult: - type: object - properties: - instanceEventWindowState: - allOf: - - $ref: '#/components/schemas/InstanceEventWindowStateChange' - - description: The state of the event window. - DeleteIpamResult: - type: object - properties: - ipam: - allOf: - - $ref: '#/components/schemas/Ipam' - - description: Information about the results of the deletion. - DeleteIpamPoolResult: - type: object - properties: - ipamPool: - allOf: - - $ref: '#/components/schemas/IpamPool' - - description: Information about the results of the deletion. - DeleteIpamScopeResult: - type: object - properties: - ipamScope: - allOf: - - $ref: '#/components/schemas/IpamScope' - - description: Information about the results of the deletion. - DeleteLaunchTemplateResult: - type: object - example: - LaunchTemplate: - CreateTime: '2017-11-23T16:46:25.000Z' - CreatedBy: 'arn:aws:iam::123456789012:root' - DefaultVersionNumber: 2 - LatestVersionNumber: 2 - LaunchTemplateId: lt-0abcd290751193123 - LaunchTemplateName: my-template - properties: - launchTemplate: - allOf: - - $ref: '#/components/schemas/LaunchTemplate' - - description: Information about the launch template. - DeleteLaunchTemplateVersionsResult: - type: object - example: - SuccessfullyDeletedLaunchTemplateVersions: - - LaunchTemplateId: lt-0abcd290751193123 - LaunchTemplateName: my-template - VersionNumber: 1 - UnsuccessfullyDeletedLaunchTemplateVersions: [] - properties: - successfullyDeletedLaunchTemplateVersionSet: - allOf: - - $ref: '#/components/schemas/DeleteLaunchTemplateVersionsResponseSuccessSet' - - description: Information about the launch template versions that were successfully deleted. - unsuccessfullyDeletedLaunchTemplateVersionSet: - allOf: - - $ref: '#/components/schemas/DeleteLaunchTemplateVersionsResponseErrorSet' - - description: Information about the launch template versions that could not be deleted. - DeleteLocalGatewayRouteResult: - type: object - properties: - route: - allOf: - - $ref: '#/components/schemas/LocalGatewayRoute' - - description: Information about the route. - DeleteLocalGatewayRouteTableVpcAssociationResult: - type: object - properties: - localGatewayRouteTableVpcAssociation: - allOf: - - $ref: '#/components/schemas/LocalGatewayRouteTableVpcAssociation' - - description: Information about the association. - DeleteManagedPrefixListResult: - type: object - properties: - prefixList: - allOf: - - $ref: '#/components/schemas/ManagedPrefixList' - - description: Information about the prefix list. - DeleteNatGatewayResult: - type: object - example: - NatGatewayId: nat-04ae55e711cec5680 - properties: - natGatewayId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the NAT gateway. - DeleteNetworkInsightsAccessScopeResult: - type: object - properties: - networkInsightsAccessScopeId: - allOf: - - $ref: '#/components/schemas/NetworkInsightsAccessScopeId' - - description: The ID of the Network Access Scope. - DeleteNetworkInsightsAccessScopeAnalysisResult: - type: object - properties: - networkInsightsAccessScopeAnalysisId: - allOf: - - $ref: '#/components/schemas/NetworkInsightsAccessScopeAnalysisId' - - description: The ID of the Network Access Scope analysis. - DeleteNetworkInsightsAnalysisResult: - type: object - properties: - networkInsightsAnalysisId: - allOf: - - $ref: '#/components/schemas/NetworkInsightsAnalysisId' - - description: The ID of the network insights analysis. - DeleteNetworkInsightsPathResult: - type: object - properties: - networkInsightsPathId: - allOf: - - $ref: '#/components/schemas/NetworkInsightsPathId' - - description: The ID of the path. - DeleteNetworkInterfacePermissionResult: - type: object - properties: - return: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Returns true if the request succeeds, otherwise returns an error.' - description: Contains the output for DeleteNetworkInterfacePermission. - DeletePublicIpv4PoolResult: - type: object - properties: - returnValue: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Information about the result of deleting the public IPv4 pool. - DeleteQueuedReservedInstancesResult: - type: object - properties: - successfulQueuedPurchaseDeletionSet: - allOf: - - $ref: '#/components/schemas/SuccessfulQueuedPurchaseDeletionSet' - - description: Information about the queued purchases that were successfully deleted. - failedQueuedPurchaseDeletionSet: - allOf: - - $ref: '#/components/schemas/FailedQueuedPurchaseDeletionSet' - - description: Information about the queued purchases that could not be deleted. - DeleteSubnetCidrReservationResult: - type: object - properties: - deletedSubnetCidrReservation: - allOf: - - $ref: '#/components/schemas/SubnetCidrReservation' - - description: Information about the deleted subnet CIDR reservation. - DeleteTrafficMirrorFilterResult: - type: object - properties: - trafficMirrorFilterId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Traffic Mirror filter. - DeleteTrafficMirrorFilterRuleResult: - type: object - properties: - trafficMirrorFilterRuleId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the deleted Traffic Mirror rule. - DeleteTrafficMirrorSessionResult: - type: object - properties: - trafficMirrorSessionId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the deleted Traffic Mirror session. - DeleteTrafficMirrorTargetResult: - type: object - properties: - trafficMirrorTargetId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the deleted Traffic Mirror target. - DeleteTransitGatewayResult: - type: object - properties: - transitGateway: - allOf: - - $ref: '#/components/schemas/TransitGateway' - - description: Information about the deleted transit gateway. - DeleteTransitGatewayConnectResult: - type: object - properties: - transitGatewayConnect: - allOf: - - $ref: '#/components/schemas/TransitGatewayConnect' - - description: Information about the deleted Connect attachment. - DeleteTransitGatewayConnectPeerResult: - type: object - properties: - transitGatewayConnectPeer: - allOf: - - $ref: '#/components/schemas/TransitGatewayConnectPeer' - - description: Information about the deleted Connect peer. - DeleteTransitGatewayMulticastDomainResult: - type: object - properties: - transitGatewayMulticastDomain: - allOf: - - $ref: '#/components/schemas/TransitGatewayMulticastDomain' - - description: Information about the deleted transit gateway multicast domain. - DeleteTransitGatewayPeeringAttachmentResult: - type: object - properties: - transitGatewayPeeringAttachment: - allOf: - - $ref: '#/components/schemas/TransitGatewayPeeringAttachment' - - description: The transit gateway peering attachment. - DeleteTransitGatewayPrefixListReferenceResult: - type: object - properties: - transitGatewayPrefixListReference: - allOf: - - $ref: '#/components/schemas/TransitGatewayPrefixListReference' - - description: Information about the deleted prefix list reference. - DeleteTransitGatewayRouteResult: - type: object - properties: - route: - allOf: - - $ref: '#/components/schemas/TransitGatewayRoute' - - description: Information about the route. - DeleteTransitGatewayRouteTableResult: - type: object - properties: - transitGatewayRouteTable: - allOf: - - $ref: '#/components/schemas/TransitGatewayRouteTable' - - description: Information about the deleted transit gateway route table. - DeleteTransitGatewayVpcAttachmentResult: - type: object - properties: - transitGatewayVpcAttachment: - allOf: - - $ref: '#/components/schemas/TransitGatewayVpcAttachment' - - description: Information about the deleted VPC attachment. - DeleteVpcEndpointConnectionNotificationsResult: - type: object - properties: - unsuccessful: - allOf: - - $ref: '#/components/schemas/UnsuccessfulItemSet' - - description: Information about the notifications that could not be deleted successfully. - ConnectionNotificationId: - type: string - DeleteVpcEndpointServiceConfigurationsResult: - type: object - properties: - unsuccessful: - allOf: - - $ref: '#/components/schemas/UnsuccessfulItemSet' - - description: 'Information about the service configurations that were not deleted, if applicable.' - VpcEndpointServiceId: - type: string - DeleteVpcEndpointsResult: - type: object - properties: - unsuccessful: - allOf: - - $ref: '#/components/schemas/UnsuccessfulItemSet' - - description: Information about the VPC endpoints that were not successfully deleted. - description: Contains the output of DeleteVpcEndpoints. - DeleteVpcPeeringConnectionResult: - type: object - properties: - return: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Returns true if the request succeeds; otherwise, it returns an error.' - DeprovisionByoipCidrResult: - type: object - properties: - byoipCidr: - allOf: - - $ref: '#/components/schemas/ByoipCidr' - - description: Information about the address range. - DeprovisionIpamPoolCidrResult: - type: object - properties: - ipamPoolCidr: - allOf: - - $ref: '#/components/schemas/IpamPoolCidr' - - description: The deprovisioned pool CIDR. - DeprovisionPublicIpv4PoolCidrResult: - type: object - properties: - poolId: - allOf: - - $ref: '#/components/schemas/Ipv4PoolEc2Id' - - description: The ID of the pool that you deprovisioned the CIDR from. - deprovisionedAddressSet: - allOf: - - $ref: '#/components/schemas/DeprovisionedAddressSet' - - description: The deprovisioned CIDRs. - DeregisterInstanceEventNotificationAttributesResult: - type: object - properties: - instanceTagAttribute: - allOf: - - $ref: '#/components/schemas/InstanceTagNotificationAttribute' - - description: The resulting set of tag keys. - InstanceTagKeySet: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - DeregisterTransitGatewayMulticastGroupMembersResult: - type: object - properties: - deregisteredMulticastGroupMembers: - allOf: - - $ref: '#/components/schemas/TransitGatewayMulticastDeregisteredGroupMembers' - - description: Information about the deregistered members. - NetworkInterfaceId: - type: string - DeregisterTransitGatewayMulticastGroupSourcesResult: - type: object - properties: - deregisteredMulticastGroupSources: - allOf: - - $ref: '#/components/schemas/TransitGatewayMulticastDeregisteredGroupSources' - - description: Information about the deregistered group sources. - DescribeAccountAttributesResult: - type: object - example: - AccountAttributes: - - AttributeName: supported-platforms - AttributeValues: - - AttributeValue: EC2 - - AttributeValue: VPC - - AttributeName: vpc-max-security-groups-per-interface - AttributeValues: - - AttributeValue: '5' - - AttributeName: max-elastic-ips - AttributeValues: - - AttributeValue: '5' - - AttributeName: max-instances - AttributeValues: - - AttributeValue: '20' - - AttributeName: vpc-max-elastic-ips - AttributeValues: - - AttributeValue: '5' - - AttributeName: default-vpc - AttributeValues: - - AttributeValue: none - properties: - accountAttributeSet: - allOf: - - $ref: '#/components/schemas/AccountAttributeList' - - description: Information about the account attributes. - AccountAttributeName: - type: string - enum: - - supported-platforms - - default-vpc - DescribeAddressesResult: - type: object - example: - Addresses: - - Domain: standard - InstanceId: i-1234567890abcdef0 - PublicIp: 198.51.100.0 - properties: - addressesSet: - allOf: - - $ref: '#/components/schemas/AddressList' - - description: Information about the Elastic IP addresses. - Filter: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of the filter. Filter names are case-sensitive. - Value: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: '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.' - description: '

A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.

' - AllocationId: - type: string - DescribeAddressesAttributeResult: - type: object - properties: - addressSet: - allOf: - - $ref: '#/components/schemas/AddressSet' - - description: Information about the IP addresses. - nextToken: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - DescribeAggregateIdFormatResult: - type: object - properties: - useLongIdsAggregated: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether all resource types in the Region are configured to use longer IDs. This value is only true if all users are configured to use longer IDs for all resources types in the Region. - statusSet: - allOf: - - $ref: '#/components/schemas/IdFormatList' - - description: Information about each resource's ID format. - DescribeAvailabilityZonesResult: - type: object - example: - AvailabilityZones: - - Messages: [] - RegionName: us-east-1 - State: available - ZoneName: us-east-1b - - Messages: [] - RegionName: us-east-1 - State: available - ZoneName: us-east-1c - - Messages: [] - RegionName: us-east-1 - State: available - ZoneName: us-east-1d - - Messages: [] - RegionName: us-east-1 - State: available - ZoneName: us-east-1e - properties: - availabilityZoneInfo: - allOf: - - $ref: '#/components/schemas/AvailabilityZoneList' - - description: 'Information about the Availability Zones, Local Zones, and Wavelength Zones.' - DescribeBundleTasksResult: - type: object - properties: - bundleInstanceTasksSet: - allOf: - - $ref: '#/components/schemas/BundleTaskList' - - description: Information about the bundle tasks. - BundleId: - type: string - DescribeByoipCidrsResult: - type: object - properties: - byoipCidrSet: - allOf: - - $ref: '#/components/schemas/ByoipCidrSet' - - description: Information about your address ranges. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - DescribeCapacityReservationFleetsResult: - type: object - properties: - capacityReservationFleetSet: - allOf: - - $ref: '#/components/schemas/CapacityReservationFleetSet' - - description: Information about the Capacity Reservation Fleets. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - DescribeCapacityReservationsResult: - type: object - properties: - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - capacityReservationSet: - allOf: - - $ref: '#/components/schemas/CapacityReservationSet' - - description: Information about the Capacity Reservations. - CapacityReservationId: - type: string - DescribeCarrierGatewaysResult: - type: object - properties: - carrierGatewaySet: - allOf: - - $ref: '#/components/schemas/CarrierGatewaySet' - - description: Information about the carrier gateway. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - CarrierGatewayId: - type: string - DescribeClassicLinkInstancesResult: - type: object - properties: - instancesSet: - allOf: - - $ref: '#/components/schemas/ClassicLinkInstanceList' - - description: Information about one or more linked EC2-Classic instances. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - InstanceId: - type: string - DescribeClientVpnAuthorizationRulesResult: - type: object - properties: - authorizationRule: - allOf: - - $ref: '#/components/schemas/AuthorizationRuleSet' - - description: Information about the authorization rules. - nextToken: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - DescribeClientVpnConnectionsResult: - type: object - properties: - connections: - allOf: - - $ref: '#/components/schemas/ClientVpnConnectionSet' - - description: Information about the active and terminated client connections. - nextToken: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - DescribeClientVpnEndpointsResult: - type: object - properties: - clientVpnEndpoint: - allOf: - - $ref: '#/components/schemas/EndpointSet' - - description: Information about the Client VPN endpoints. - nextToken: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - ClientVpnEndpointId: - type: string - DescribeClientVpnRoutesResult: - type: object - properties: - routes: - allOf: - - $ref: '#/components/schemas/ClientVpnRouteSet' - - description: Information about the Client VPN endpoint routes. - nextToken: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - DescribeClientVpnTargetNetworksResult: - type: object - properties: - clientVpnTargetNetworks: - allOf: - - $ref: '#/components/schemas/TargetNetworkSet' - - description: Information about the associated target networks. - nextToken: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - DescribeCoipPoolsResult: - type: object - properties: - coipPoolSet: - allOf: - - $ref: '#/components/schemas/CoipPoolSet' - - description: Information about the address pools. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - Ipv4PoolCoipId: - type: string - DescribeConversionTasksResult: - type: object - properties: - conversionTasks: - allOf: - - $ref: '#/components/schemas/DescribeConversionTaskList' - - description: Information about the conversion tasks. - ConversionTaskId: - type: string - DescribeCustomerGatewaysResult: - type: object - example: - CustomerGateways: - - BgpAsn: '65534' - CustomerGatewayId: cgw-0e11f167 - IpAddress: 12.1.2.3 - State: available - Type: ipsec.1 - properties: - customerGatewaySet: - allOf: - - $ref: '#/components/schemas/CustomerGatewayList' - - description: Information about one or more customer gateways. - description: Contains the output of DescribeCustomerGateways. - CustomerGatewayId: - type: string - DescribeDhcpOptionsResult: - type: object - example: - DhcpOptions: - - DhcpConfigurations: - - Key: domain-name-servers - Values: - - Value: 10.2.5.2 - - Value: 10.2.5.1 - DhcpOptionsId: dopt-d9070ebb - properties: - dhcpOptionsSet: - allOf: - - $ref: '#/components/schemas/DhcpOptionsList' - - description: Information about one or more DHCP options sets. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - DhcpOptionsId: - type: string - DescribeEgressOnlyInternetGatewaysResult: - type: object - properties: - egressOnlyInternetGatewaySet: - allOf: - - $ref: '#/components/schemas/EgressOnlyInternetGatewayList' - - description: Information about the egress-only internet gateways. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - EgressOnlyInternetGatewayId: - type: string - DescribeElasticGpusResult: - type: object - properties: - elasticGpuSet: - allOf: - - $ref: '#/components/schemas/ElasticGpuSet' - - description: Information about the Elastic Graphics accelerators. - maxResults: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The total number of items to return. If the total number of items available is more than the value specified in max-items then a Next-Token will be provided in the output that you can use to resume pagination. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - ElasticGpuId: - type: string - DescribeExportImageTasksResult: - type: object - properties: - exportImageTaskSet: - allOf: - - $ref: '#/components/schemas/ExportImageTaskList' - - description: Information about the export image tasks. - nextToken: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: The token to use to get the next page of results. This value is null when there are no more results to return. - ExportImageTaskId: - type: string - DescribeExportTasksResult: - type: object - properties: - exportTaskSet: - allOf: - - $ref: '#/components/schemas/ExportTaskList' - - description: Information about the export tasks. - ExportTaskId: - type: string - DescribeFastLaunchImagesResult: - type: object - properties: - fastLaunchImageSet: - allOf: - - $ref: '#/components/schemas/DescribeFastLaunchImagesSuccessSet' - - description: A collection of details about the fast-launch enabled Windows images that meet the requested criteria. - nextToken: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: The token to use for the next set of results. This value is null when there are no more results to return. - ImageId: - type: string - DescribeFastSnapshotRestoresResult: - type: object - properties: - fastSnapshotRestoreSet: - allOf: - - $ref: '#/components/schemas/DescribeFastSnapshotRestoreSuccessSet' - - description: Information about the state of fast snapshot restores. - nextToken: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - DescribeFleetHistoryResult: - type: object - properties: - historyRecordSet: - allOf: - - $ref: '#/components/schemas/HistoryRecordSet' - - description: Information about the events in the history of the EC2 Fleet. - lastEvaluatedTime: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: '

The last date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). All records up to this time were retrieved.

If nextToken indicates that there are more results, this value is not present.

' - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token for the next set of results. - fleetId: - allOf: - - $ref: '#/components/schemas/FleetId' - - description: The ID of the EC Fleet. - startTime: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: 'The start date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).' - DescribeFleetInstancesResult: - type: object - properties: - activeInstanceSet: - allOf: - - $ref: '#/components/schemas/ActiveInstanceSet' - - description: The running instances. This list is refreshed periodically and might be out of date. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token for the next set of results. - fleetId: - allOf: - - $ref: '#/components/schemas/FleetId' - - description: The ID of the EC2 Fleet. - DescribeFleetsResult: - type: object - properties: - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token for the next set of results. - fleetSet: - allOf: - - $ref: '#/components/schemas/FleetSet' - - description: Information about the EC2 Fleets. - DescribeFlowLogsResult: - type: object - properties: - flowLogSet: - allOf: - - $ref: '#/components/schemas/FlowLogSet' - - description: Information about the flow logs. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - DescribeFpgaImageAttributeResult: - type: object - properties: - fpgaImageAttribute: - allOf: - - $ref: '#/components/schemas/FpgaImageAttribute' - - description: Information about the attribute. - DescribeFpgaImagesResult: - type: object - properties: - fpgaImageSet: - allOf: - - $ref: '#/components/schemas/FpgaImageList' - - description: Information about the FPGA images. - nextToken: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - FpgaImageId: - type: string - DescribeHostReservationOfferingsResult: - type: object - properties: - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - offeringSet: - allOf: - - $ref: '#/components/schemas/HostOfferingSet' - - description: Information about the offerings. - DescribeHostReservationsResult: - type: object - properties: - hostReservationSet: - allOf: - - $ref: '#/components/schemas/HostReservationSet' - - description: Details about the reservation's configuration. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - HostReservationId: - type: string - DescribeHostsResult: - type: object - properties: - hostSet: - allOf: - - $ref: '#/components/schemas/HostList' - - description: Information about the Dedicated Hosts. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - DedicatedHostId: - type: string - DescribeIamInstanceProfileAssociationsResult: - type: object - example: - IamInstanceProfileAssociations: - - AssociationId: iip-assoc-0db249b1f25fa24b8 - IamInstanceProfile: - Arn: 'arn:aws:iam::123456789012:instance-profile/admin-role' - Id: AIPAJVQN4F5WVLGCJDRGM - InstanceId: i-09eb09efa73ec1dee - State: associated - properties: - iamInstanceProfileAssociationSet: - allOf: - - $ref: '#/components/schemas/IamInstanceProfileAssociationSet' - - description: Information about the IAM instance profile associations. - nextToken: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - IamInstanceProfileAssociationId: - type: string - DescribeIdFormatResult: - type: object - properties: - statusSet: - allOf: - - $ref: '#/components/schemas/IdFormatList' - - description: Information about the ID format for the resource. - DescribeIdentityIdFormatResult: - type: object - properties: - statusSet: - allOf: - - $ref: '#/components/schemas/IdFormatList' - - description: Information about the ID format for the resources. - ImageAttribute: - type: object - example: - ImageId: ami-5731123e - LaunchPermissions: - - UserId: '123456789012' - properties: - blockDeviceMapping: - allOf: - - $ref: '#/components/schemas/BlockDeviceMappingList' - - description: The block device mapping entries. - imageId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the AMI. - launchPermission: - allOf: - - $ref: '#/components/schemas/LaunchPermissionList' - - description: The launch permissions. - productCodes: - allOf: - - $ref: '#/components/schemas/ProductCodeList' - - description: The product codes. - description: - allOf: - - $ref: '#/components/schemas/AttributeValue' - - description: A description for the AMI. - kernel: - allOf: - - $ref: '#/components/schemas/AttributeValue' - - description: The kernel ID. - ramdisk: - allOf: - - $ref: '#/components/schemas/AttributeValue' - - description: The RAM disk ID. - sriovNetSupport: - allOf: - - $ref: '#/components/schemas/AttributeValue' - - description: Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled. - bootMode: - allOf: - - $ref: '#/components/schemas/AttributeValue' - - description: The boot mode. - tpmSupport: - allOf: - - $ref: '#/components/schemas/AttributeValue' - - description: 'If the image is configured for NitroTPM support, the value is v2.0.' - uefiData: - allOf: - - $ref: '#/components/schemas/AttributeValue' - - description: 'Base64 representation of the non-volatile UEFI variable store. To retrieve the UEFI data, use the GetInstanceUefiData command. You can inspect and modify the UEFI data by using the python-uefivars tool on GitHub. For more information, see UEFI Secure Boot in the Amazon Elastic Compute Cloud User Guide.' - lastLaunchedTime: - allOf: - - $ref: '#/components/schemas/AttributeValue' - - description: '

The date and time, in ISO 8601 date-time format, when the AMI was last used to launch an EC2 instance. When the AMI is used, there is a 24-hour delay before that usage is reported.

lastLaunchedTime data is available starting April 2017.

' - description: Describes an image attribute. - DescribeImagesResult: - type: object - example: - Images: - - Architecture: x86_64 - BlockDeviceMappings: - - DeviceName: /dev/sda1 - Ebs: - DeleteOnTermination: true - SnapshotId: snap-1234567890abcdef0 - VolumeSize: 8 - VolumeType: standard - Description: An AMI for my server - Hypervisor: xen - ImageId: ami-5731123e - ImageLocation: 123456789012/My server - ImageType: machine - KernelId: aki-88aa75e1 - Name: My server - OwnerId: '123456789012' - Public: false - RootDeviceName: /dev/sda1 - RootDeviceType: ebs - State: available - VirtualizationType: paravirtual - properties: - imagesSet: - allOf: - - $ref: '#/components/schemas/ImageList' - - description: Information about the images. - DescribeImportImageTasksResult: - type: object - properties: - importImageTaskSet: - allOf: - - $ref: '#/components/schemas/ImportImageTaskList' - - description: A list of zero or more import image tasks that are currently active or were completed or canceled in the previous 7 days. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to get the next page of results. This value is null when there are no more results to return. - ImportImageTaskId: - type: string - DescribeImportSnapshotTasksResult: - type: object - properties: - importSnapshotTaskSet: - allOf: - - $ref: '#/components/schemas/ImportSnapshotTaskList' - - description: A list of zero or more import snapshot tasks that are currently active or were completed or canceled in the previous 7 days. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to get the next page of results. This value is null when there are no more results to return. - ImportSnapshotTaskId: - type: string - InstanceAttribute: - type: object - example: - BlockDeviceMappings: - - DeviceName: /dev/sda1 - Ebs: - AttachTime: '2013-05-17T22:42:34.000Z' - DeleteOnTermination: true - Status: attached - VolumeId: vol-049df61146c4d7901 - - DeviceName: /dev/sdf - Ebs: - AttachTime: '2013-09-10T23:07:00.000Z' - DeleteOnTermination: false - Status: attached - VolumeId: vol-049df61146c4d7901 - InstanceId: i-1234567890abcdef0 - properties: - groupSet: - allOf: - - $ref: '#/components/schemas/GroupIdentifierList' - - description: The security groups associated with the instance. - blockDeviceMapping: - allOf: - - $ref: '#/components/schemas/InstanceBlockDeviceMappingList' - - description: The block device mapping of the instance. - disableApiTermination: - allOf: - - $ref: '#/components/schemas/AttributeBooleanValue' - - description: 'If the value is true, you can''t terminate the instance through the Amazon EC2 console, CLI, or API; otherwise, you can.' - enaSupport: - allOf: - - $ref: '#/components/schemas/AttributeBooleanValue' - - description: Indicates whether enhanced networking with ENA is enabled. - enclaveOptions: - allOf: - - $ref: '#/components/schemas/EnclaveOptions' - - description: 'To enable the instance for Amazon Web Services Nitro Enclaves, set this parameter to true; otherwise, set it to false.' - ebsOptimized: - allOf: - - $ref: '#/components/schemas/AttributeBooleanValue' - - description: Indicates whether the instance is optimized for Amazon EBS I/O. - instanceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the instance. - instanceInitiatedShutdownBehavior: - allOf: - - $ref: '#/components/schemas/AttributeValue' - - description: Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown). - instanceType: - allOf: - - $ref: '#/components/schemas/AttributeValue' - - description: The instance type. - kernel: - allOf: - - $ref: '#/components/schemas/AttributeValue' - - description: The kernel ID. - productCodes: - allOf: - - $ref: '#/components/schemas/ProductCodeList' - - description: A list of product codes. - ramdisk: - allOf: - - $ref: '#/components/schemas/AttributeValue' - - description: The RAM disk ID. - rootDeviceName: - allOf: - - $ref: '#/components/schemas/AttributeValue' - - description: 'The device name of the root device volume (for example, /dev/sda1).' - sourceDestCheck: - allOf: - - $ref: '#/components/schemas/AttributeBooleanValue' - - description: 'Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives. If the value is true, source/destination checks are enabled; otherwise, they are disabled. The default value is true. You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.' - sriovNetSupport: - allOf: - - $ref: '#/components/schemas/AttributeValue' - - description: Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled. - userData: - allOf: - - $ref: '#/components/schemas/AttributeValue' - - description: The user data. - description: Describes an instance attribute. - DescribeInstanceCreditSpecificationsResult: - type: object - properties: - instanceCreditSpecificationSet: - allOf: - - $ref: '#/components/schemas/InstanceCreditSpecificationList' - - description: Information about the credit option for CPU usage of an instance. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - DescribeInstanceEventNotificationAttributesResult: - type: object - properties: - instanceTagAttribute: - allOf: - - $ref: '#/components/schemas/InstanceTagNotificationAttribute' - - description: Information about the registered tag keys. - DescribeInstanceEventWindowsResult: - type: object - properties: - instanceEventWindowSet: - allOf: - - $ref: '#/components/schemas/InstanceEventWindowSet' - - description: Information about the event windows. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The token to use to retrieve the next page of results. This value is null when there are no more results to return. ' - InstanceEventWindowId: - type: string - DescribeInstanceStatusResult: - type: object - example: - InstanceStatuses: - - AvailabilityZone: us-east-1d - InstanceId: i-1234567890abcdef0 - InstanceState: - Code: 16 - Name: running - InstanceStatus: - Details: - - Name: reachability - Status: passed - Status: ok - SystemStatus: - Details: - - Name: reachability - Status: passed - Status: ok - properties: - instanceStatusSet: - allOf: - - $ref: '#/components/schemas/InstanceStatusList' - - description: Information about the status of the instances. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - DescribeInstanceTypeOfferingsResult: - type: object - properties: - instanceTypeOfferingSet: - allOf: - - $ref: '#/components/schemas/InstanceTypeOfferingsList' - - description: The instance types offered. - nextToken: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - DescribeInstanceTypesResult: - type: object - properties: - instanceTypeSet: - allOf: - - $ref: '#/components/schemas/InstanceTypeInfoList' - - description: 'The instance type. For more information, see Instance types in the Amazon EC2 User Guide.' - nextToken: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - InstanceType: - type: string - enum: - - a1.medium - - a1.large - - a1.xlarge - - a1.2xlarge - - a1.4xlarge - - a1.metal - - c1.medium - - c1.xlarge - - c3.large - - c3.xlarge - - c3.2xlarge - - c3.4xlarge - - c3.8xlarge - - c4.large - - c4.xlarge - - c4.2xlarge - - c4.4xlarge - - c4.8xlarge - - c5.large - - c5.xlarge - - c5.2xlarge - - c5.4xlarge - - c5.9xlarge - - c5.12xlarge - - c5.18xlarge - - c5.24xlarge - - c5.metal - - c5a.large - - c5a.xlarge - - c5a.2xlarge - - c5a.4xlarge - - c5a.8xlarge - - c5a.12xlarge - - c5a.16xlarge - - c5a.24xlarge - - c5ad.large - - c5ad.xlarge - - c5ad.2xlarge - - c5ad.4xlarge - - c5ad.8xlarge - - c5ad.12xlarge - - c5ad.16xlarge - - c5ad.24xlarge - - c5d.large - - c5d.xlarge - - c5d.2xlarge - - c5d.4xlarge - - c5d.9xlarge - - c5d.12xlarge - - c5d.18xlarge - - c5d.24xlarge - - c5d.metal - - c5n.large - - c5n.xlarge - - c5n.2xlarge - - c5n.4xlarge - - c5n.9xlarge - - c5n.18xlarge - - c5n.metal - - c6g.medium - - c6g.large - - c6g.xlarge - - c6g.2xlarge - - c6g.4xlarge - - c6g.8xlarge - - c6g.12xlarge - - c6g.16xlarge - - c6g.metal - - c6gd.medium - - c6gd.large - - c6gd.xlarge - - c6gd.2xlarge - - c6gd.4xlarge - - c6gd.8xlarge - - c6gd.12xlarge - - c6gd.16xlarge - - c6gd.metal - - c6gn.medium - - c6gn.large - - c6gn.xlarge - - c6gn.2xlarge - - c6gn.4xlarge - - c6gn.8xlarge - - c6gn.12xlarge - - c6gn.16xlarge - - c6i.large - - c6i.xlarge - - c6i.2xlarge - - c6i.4xlarge - - c6i.8xlarge - - c6i.12xlarge - - c6i.16xlarge - - c6i.24xlarge - - c6i.32xlarge - - c6i.metal - - cc1.4xlarge - - cc2.8xlarge - - cg1.4xlarge - - cr1.8xlarge - - d2.xlarge - - d2.2xlarge - - d2.4xlarge - - d2.8xlarge - - d3.xlarge - - d3.2xlarge - - d3.4xlarge - - d3.8xlarge - - d3en.xlarge - - d3en.2xlarge - - d3en.4xlarge - - d3en.6xlarge - - d3en.8xlarge - - d3en.12xlarge - - dl1.24xlarge - - f1.2xlarge - - f1.4xlarge - - f1.16xlarge - - g2.2xlarge - - g2.8xlarge - - g3.4xlarge - - g3.8xlarge - - g3.16xlarge - - g3s.xlarge - - g4ad.xlarge - - g4ad.2xlarge - - g4ad.4xlarge - - g4ad.8xlarge - - g4ad.16xlarge - - g4dn.xlarge - - g4dn.2xlarge - - g4dn.4xlarge - - g4dn.8xlarge - - g4dn.12xlarge - - g4dn.16xlarge - - g4dn.metal - - g5.xlarge - - g5.2xlarge - - g5.4xlarge - - g5.8xlarge - - g5.12xlarge - - g5.16xlarge - - g5.24xlarge - - g5.48xlarge - - g5g.xlarge - - g5g.2xlarge - - g5g.4xlarge - - g5g.8xlarge - - g5g.16xlarge - - g5g.metal - - hi1.4xlarge - - hpc6a.48xlarge - - hs1.8xlarge - - h1.2xlarge - - h1.4xlarge - - h1.8xlarge - - h1.16xlarge - - i2.xlarge - - i2.2xlarge - - i2.4xlarge - - i2.8xlarge - - i3.large - - i3.xlarge - - i3.2xlarge - - i3.4xlarge - - i3.8xlarge - - i3.16xlarge - - i3.metal - - i3en.large - - i3en.xlarge - - i3en.2xlarge - - i3en.3xlarge - - i3en.6xlarge - - i3en.12xlarge - - i3en.24xlarge - - i3en.metal - - im4gn.large - - im4gn.xlarge - - im4gn.2xlarge - - im4gn.4xlarge - - im4gn.8xlarge - - im4gn.16xlarge - - inf1.xlarge - - inf1.2xlarge - - inf1.6xlarge - - inf1.24xlarge - - is4gen.medium - - is4gen.large - - is4gen.xlarge - - is4gen.2xlarge - - is4gen.4xlarge - - is4gen.8xlarge - - m1.small - - m1.medium - - m1.large - - m1.xlarge - - m2.xlarge - - m2.2xlarge - - m2.4xlarge - - m3.medium - - m3.large - - m3.xlarge - - m3.2xlarge - - m4.large - - m4.xlarge - - m4.2xlarge - - m4.4xlarge - - m4.10xlarge - - m4.16xlarge - - m5.large - - m5.xlarge - - m5.2xlarge - - m5.4xlarge - - m5.8xlarge - - m5.12xlarge - - m5.16xlarge - - m5.24xlarge - - m5.metal - - m5a.large - - m5a.xlarge - - m5a.2xlarge - - m5a.4xlarge - - m5a.8xlarge - - m5a.12xlarge - - m5a.16xlarge - - m5a.24xlarge - - m5ad.large - - m5ad.xlarge - - m5ad.2xlarge - - m5ad.4xlarge - - m5ad.8xlarge - - m5ad.12xlarge - - m5ad.16xlarge - - m5ad.24xlarge - - m5d.large - - m5d.xlarge - - m5d.2xlarge - - m5d.4xlarge - - m5d.8xlarge - - m5d.12xlarge - - m5d.16xlarge - - m5d.24xlarge - - m5d.metal - - m5dn.large - - m5dn.xlarge - - m5dn.2xlarge - - m5dn.4xlarge - - m5dn.8xlarge - - m5dn.12xlarge - - m5dn.16xlarge - - m5dn.24xlarge - - m5dn.metal - - m5n.large - - m5n.xlarge - - m5n.2xlarge - - m5n.4xlarge - - m5n.8xlarge - - m5n.12xlarge - - m5n.16xlarge - - m5n.24xlarge - - m5n.metal - - m5zn.large - - m5zn.xlarge - - m5zn.2xlarge - - m5zn.3xlarge - - m5zn.6xlarge - - m5zn.12xlarge - - m5zn.metal - - m6a.large - - m6a.xlarge - - m6a.2xlarge - - m6a.4xlarge - - m6a.8xlarge - - m6a.12xlarge - - m6a.16xlarge - - m6a.24xlarge - - m6a.32xlarge - - m6a.48xlarge - - m6g.metal - - m6g.medium - - m6g.large - - m6g.xlarge - - m6g.2xlarge - - m6g.4xlarge - - m6g.8xlarge - - m6g.12xlarge - - m6g.16xlarge - - m6gd.metal - - m6gd.medium - - m6gd.large - - m6gd.xlarge - - m6gd.2xlarge - - m6gd.4xlarge - - m6gd.8xlarge - - m6gd.12xlarge - - m6gd.16xlarge - - m6i.large - - m6i.xlarge - - m6i.2xlarge - - m6i.4xlarge - - m6i.8xlarge - - m6i.12xlarge - - m6i.16xlarge - - m6i.24xlarge - - m6i.32xlarge - - m6i.metal - - mac1.metal - - p2.xlarge - - p2.8xlarge - - p2.16xlarge - - p3.2xlarge - - p3.8xlarge - - p3.16xlarge - - p3dn.24xlarge - - p4d.24xlarge - - r3.large - - r3.xlarge - - r3.2xlarge - - r3.4xlarge - - r3.8xlarge - - r4.large - - r4.xlarge - - r4.2xlarge - - r4.4xlarge - - r4.8xlarge - - r4.16xlarge - - r5.large - - r5.xlarge - - r5.2xlarge - - r5.4xlarge - - r5.8xlarge - - r5.12xlarge - - r5.16xlarge - - r5.24xlarge - - r5.metal - - r5a.large - - r5a.xlarge - - r5a.2xlarge - - r5a.4xlarge - - r5a.8xlarge - - r5a.12xlarge - - r5a.16xlarge - - r5a.24xlarge - - r5ad.large - - r5ad.xlarge - - r5ad.2xlarge - - r5ad.4xlarge - - r5ad.8xlarge - - r5ad.12xlarge - - r5ad.16xlarge - - r5ad.24xlarge - - r5b.large - - r5b.xlarge - - r5b.2xlarge - - r5b.4xlarge - - r5b.8xlarge - - r5b.12xlarge - - r5b.16xlarge - - r5b.24xlarge - - r5b.metal - - r5d.large - - r5d.xlarge - - r5d.2xlarge - - r5d.4xlarge - - r5d.8xlarge - - r5d.12xlarge - - r5d.16xlarge - - r5d.24xlarge - - r5d.metal - - r5dn.large - - r5dn.xlarge - - r5dn.2xlarge - - r5dn.4xlarge - - r5dn.8xlarge - - r5dn.12xlarge - - r5dn.16xlarge - - r5dn.24xlarge - - r5dn.metal - - r5n.large - - r5n.xlarge - - r5n.2xlarge - - r5n.4xlarge - - r5n.8xlarge - - r5n.12xlarge - - r5n.16xlarge - - r5n.24xlarge - - r5n.metal - - r6g.medium - - r6g.large - - r6g.xlarge - - r6g.2xlarge - - r6g.4xlarge - - r6g.8xlarge - - r6g.12xlarge - - r6g.16xlarge - - r6g.metal - - r6gd.medium - - r6gd.large - - r6gd.xlarge - - r6gd.2xlarge - - r6gd.4xlarge - - r6gd.8xlarge - - r6gd.12xlarge - - r6gd.16xlarge - - r6gd.metal - - r6i.large - - r6i.xlarge - - r6i.2xlarge - - r6i.4xlarge - - r6i.8xlarge - - r6i.12xlarge - - r6i.16xlarge - - r6i.24xlarge - - r6i.32xlarge - - r6i.metal - - t1.micro - - t2.nano - - t2.micro - - t2.small - - t2.medium - - t2.large - - t2.xlarge - - t2.2xlarge - - t3.nano - - t3.micro - - t3.small - - t3.medium - - t3.large - - t3.xlarge - - t3.2xlarge - - t3a.nano - - t3a.micro - - t3a.small - - t3a.medium - - t3a.large - - t3a.xlarge - - t3a.2xlarge - - t4g.nano - - t4g.micro - - t4g.small - - t4g.medium - - t4g.large - - t4g.xlarge - - t4g.2xlarge - - u-6tb1.56xlarge - - u-6tb1.112xlarge - - u-9tb1.112xlarge - - u-12tb1.112xlarge - - u-6tb1.metal - - u-9tb1.metal - - u-12tb1.metal - - u-18tb1.metal - - u-24tb1.metal - - vt1.3xlarge - - vt1.6xlarge - - vt1.24xlarge - - x1.16xlarge - - x1.32xlarge - - x1e.xlarge - - x1e.2xlarge - - x1e.4xlarge - - x1e.8xlarge - - x1e.16xlarge - - x1e.32xlarge - - x2iezn.2xlarge - - x2iezn.4xlarge - - x2iezn.6xlarge - - x2iezn.8xlarge - - x2iezn.12xlarge - - x2iezn.metal - - x2gd.medium - - x2gd.large - - x2gd.xlarge - - x2gd.2xlarge - - x2gd.4xlarge - - x2gd.8xlarge - - x2gd.12xlarge - - x2gd.16xlarge - - x2gd.metal - - z1d.large - - z1d.xlarge - - z1d.2xlarge - - z1d.3xlarge - - z1d.6xlarge - - z1d.12xlarge - - z1d.metal - - x2idn.16xlarge - - x2idn.24xlarge - - x2idn.32xlarge - - x2iedn.xlarge - - x2iedn.2xlarge - - x2iedn.4xlarge - - x2iedn.8xlarge - - x2iedn.16xlarge - - x2iedn.24xlarge - - x2iedn.32xlarge - - c6a.large - - c6a.xlarge - - c6a.2xlarge - - c6a.4xlarge - - c6a.8xlarge - - c6a.12xlarge - - c6a.16xlarge - - c6a.24xlarge - - c6a.32xlarge - - c6a.48xlarge - - c6a.metal - - m6a.metal - - i4i.large - - i4i.xlarge - - i4i.2xlarge - - i4i.4xlarge - - i4i.8xlarge - - i4i.16xlarge - - i4i.32xlarge - DescribeInstancesResult: - type: object - example: {} - properties: - reservationSet: - allOf: - - $ref: '#/components/schemas/ReservationList' - - description: Information about the reservations. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - DescribeInternetGatewaysResult: - type: object - example: - InternetGateways: - - Attachments: - - State: available - VpcId: vpc-a01106c2 - InternetGatewayId: igw-c0a643a9 - Tags: [] - properties: - internetGatewaySet: - allOf: - - $ref: '#/components/schemas/InternetGatewayList' - - description: Information about one or more internet gateways. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - InternetGatewayId: - type: string - DescribeIpamPoolsResult: - type: object - properties: - nextToken: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - ipamPoolSet: - allOf: - - $ref: '#/components/schemas/IpamPoolSet' - - description: Information about the IPAM pools. - DescribeIpamScopesResult: - type: object - properties: - nextToken: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - ipamScopeSet: - allOf: - - $ref: '#/components/schemas/IpamScopeSet' - - description: The scopes you want information on. - DescribeIpamsResult: - type: object - properties: - nextToken: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - ipamSet: - allOf: - - $ref: '#/components/schemas/IpamSet' - - description: Information about the IPAMs. - DescribeIpv6PoolsResult: - type: object - properties: - ipv6PoolSet: - allOf: - - $ref: '#/components/schemas/Ipv6PoolSet' - - description: Information about the IPv6 address pools. - nextToken: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - Ipv6PoolEc2Id: - type: string - DescribeKeyPairsResult: - type: object - example: - KeyPairs: - - KeyFingerprint: '1f:51:ae:28:bf:89:e9:d8:1f:25:5d:37:2d:7d:b8:ca:9f:f5:f1:6f' - KeyName: my-key-pair - properties: - keySet: - allOf: - - $ref: '#/components/schemas/KeyPairList' - - description: Information about the key pairs. - KeyPairName: - type: string - KeyPairId: - type: string - DescribeLaunchTemplateVersionsResult: - type: object - example: - LaunchTemplateVersions: - - CreateTime: '2017-11-20T13:12:32.000Z' - CreatedBy: 'arn:aws:iam::123456789102:root' - DefaultVersion: false - LaunchTemplateData: - ImageId: ami-6057e21a - InstanceType: t2.medium - KeyName: kp-us-east - NetworkInterfaces: - - DeviceIndex: 0 - Groups: - - sg-7c227019 - SubnetId: subnet-1a2b3c4d - LaunchTemplateId: lt-068f72b72934aff71 - LaunchTemplateName: Webservers - VersionNumber: 2 - - CreateTime: '2017-11-20T12:52:33.000Z' - CreatedBy: 'arn:aws:iam::123456789102:root' - DefaultVersion: true - LaunchTemplateData: - ImageId: ami-aabbcc11 - InstanceType: t2.medium - KeyName: kp-us-east - NetworkInterfaces: - - AssociatePublicIpAddress: true - DeleteOnTermination: false - DeviceIndex: 0 - Groups: - - sg-7c227019 - SubnetId: subnet-7b16de0c - UserData: '' - LaunchTemplateId: lt-068f72b72934aff71 - LaunchTemplateName: Webservers - VersionNumber: 1 - properties: - launchTemplateVersionSet: - allOf: - - $ref: '#/components/schemas/LaunchTemplateVersionSet' - - description: Information about the launch template versions. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - DescribeLaunchTemplatesResult: - type: object - example: - LaunchTemplates: - - CreateTime: '2018-01-16T04:32:57.000Z' - CreatedBy: 'arn:aws:iam::123456789012:root' - DefaultVersionNumber: 1 - LatestVersionNumber: 1 - LaunchTemplateId: lt-01238c059e3466abc - LaunchTemplateName: my-template - properties: - launchTemplates: - allOf: - - $ref: '#/components/schemas/LaunchTemplateSet' - - description: Information about the launch templates. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - LaunchTemplateId: - type: string - LaunchTemplateName: - type: string - pattern: '[a-zA-Z0-9\(\)\.\-/_]+' - minLength: 3 - maxLength: 128 - DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsResult: - type: object - properties: - localGatewayRouteTableVirtualInterfaceGroupAssociationSet: - allOf: - - $ref: '#/components/schemas/LocalGatewayRouteTableVirtualInterfaceGroupAssociationSet' - - description: Information about the associations. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - LocalGatewayRouteTableVirtualInterfaceGroupAssociationId: - type: string - DescribeLocalGatewayRouteTableVpcAssociationsResult: - type: object - properties: - localGatewayRouteTableVpcAssociationSet: - allOf: - - $ref: '#/components/schemas/LocalGatewayRouteTableVpcAssociationSet' - - description: Information about the associations. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - LocalGatewayRouteTableVpcAssociationId: - type: string - DescribeLocalGatewayRouteTablesResult: - type: object - properties: - localGatewayRouteTableSet: - allOf: - - $ref: '#/components/schemas/LocalGatewayRouteTableSet' - - description: Information about the local gateway route tables. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - LocalGatewayRoutetableId: - type: string - DescribeLocalGatewayVirtualInterfaceGroupsResult: - type: object - properties: - localGatewayVirtualInterfaceGroupSet: - allOf: - - $ref: '#/components/schemas/LocalGatewayVirtualInterfaceGroupSet' - - description: The virtual interface groups. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - LocalGatewayVirtualInterfaceGroupId: - type: string - DescribeLocalGatewayVirtualInterfacesResult: - type: object - properties: - localGatewayVirtualInterfaceSet: - allOf: - - $ref: '#/components/schemas/LocalGatewayVirtualInterfaceSet' - - description: Information about the virtual interfaces. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - LocalGatewayVirtualInterfaceId: - type: string - DescribeLocalGatewaysResult: - type: object - properties: - localGatewaySet: - allOf: - - $ref: '#/components/schemas/LocalGatewaySet' - - description: Information about the local gateways. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - LocalGatewayId: - type: string - DescribeManagedPrefixListsResult: - type: object - properties: - nextToken: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - prefixListSet: - allOf: - - $ref: '#/components/schemas/ManagedPrefixListSet' - - description: Information about the prefix lists. - DescribeMovingAddressesResult: - type: object - example: - MovingAddressStatuses: - - MoveStatus: MovingToVpc - PublicIp: 198.51.100.0 - properties: - movingAddressStatusSet: - allOf: - - $ref: '#/components/schemas/MovingAddressStatusSet' - - description: The status for each Elastic IP address. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - DescribeNatGatewaysResult: - type: object - example: - NatGateways: - - CreateTime: '2015-12-01T12:26:55.983Z' - NatGatewayAddresses: - - AllocationId: eipalloc-89c620ec - NetworkInterfaceId: eni-9dec76cd - PrivateIp: 10.0.0.149 - PublicIp: 198.11.222.333 - NatGatewayId: nat-05dba92075d71c408 - State: available - SubnetId: subnet-847e4dc2 - VpcId: vpc-1a2b3c4d - properties: - natGatewaySet: - allOf: - - $ref: '#/components/schemas/NatGatewayList' - - description: Information about the NAT gateways. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - NatGatewayId: - type: string - DescribeNetworkAclsResult: - type: object - example: - NetworkAcls: - - Associations: - - NetworkAclAssociationId: aclassoc-66ea5f0b - NetworkAclId: acl-9aeb5ef7 - SubnetId: subnet-65ea5f08 - Entries: - - CidrBlock: 0.0.0.0/0 - Egress: true - Protocol: '-1' - RuleAction: deny - RuleNumber: 32767 - - CidrBlock: 0.0.0.0/0 - Egress: false - Protocol: '-1' - RuleAction: deny - RuleNumber: 32767 - IsDefault: false - NetworkAclId: acl-5fb85d36 - Tags: [] - VpcId: vpc-a01106c2 - properties: - networkAclSet: - allOf: - - $ref: '#/components/schemas/NetworkAclList' - - description: Information about one or more network ACLs. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - NetworkAclId: - type: string - DescribeNetworkInsightsAccessScopeAnalysesResult: - type: object - properties: - networkInsightsAccessScopeAnalysisSet: - allOf: - - $ref: '#/components/schemas/NetworkInsightsAccessScopeAnalysisList' - - description: The Network Access Scope analyses. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - NetworkInsightsAccessScopeAnalysisId: - type: string - DescribeNetworkInsightsAccessScopesResult: - type: object - properties: - networkInsightsAccessScopeSet: - allOf: - - $ref: '#/components/schemas/NetworkInsightsAccessScopeList' - - description: The Network Access Scopes. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - NetworkInsightsAccessScopeId: - type: string - DescribeNetworkInsightsAnalysesResult: - type: object - properties: - networkInsightsAnalysisSet: - allOf: - - $ref: '#/components/schemas/NetworkInsightsAnalysisList' - - description: Information about the network insights analyses. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - NetworkInsightsAnalysisId: - type: string - DescribeNetworkInsightsPathsResult: - type: object - properties: - networkInsightsPathSet: - allOf: - - $ref: '#/components/schemas/NetworkInsightsPathList' - - description: Information about the paths. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - NetworkInsightsPathId: - type: string - DescribeNetworkInterfaceAttributeResult: - type: object - example: - NetworkInterfaceId: eni-686ea200 - SourceDestCheck: - Value: true - properties: - attachment: - allOf: - - $ref: '#/components/schemas/NetworkInterfaceAttachment' - - description: The attachment (if any) of the network interface. - description: - allOf: - - $ref: '#/components/schemas/AttributeValue' - - description: The description of the network interface. - groupSet: - allOf: - - $ref: '#/components/schemas/GroupIdentifierList' - - description: The security groups associated with the network interface. - networkInterfaceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the network interface. - sourceDestCheck: - allOf: - - $ref: '#/components/schemas/AttributeBooleanValue' - - description: Indicates whether source/destination checking is enabled. - description: Contains the output of DescribeNetworkInterfaceAttribute. - DescribeNetworkInterfacePermissionsResult: - type: object - properties: - networkInterfacePermissions: - allOf: - - $ref: '#/components/schemas/NetworkInterfacePermissionList' - - description: The network interface permissions. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. - description: Contains the output for DescribeNetworkInterfacePermissions. - NetworkInterfacePermissionId: - type: string - DescribeNetworkInterfacesResult: - type: object - example: - NetworkInterfaces: - - Association: - AssociationId: eipassoc-0fbb766a - IpOwnerId: '123456789012' - PublicDnsName: ec2-203-0-113-12.compute-1.amazonaws.com - PublicIp: 203.0.113.12 - Attachment: - AttachTime: '2013-11-30T23:36:42.000Z' - AttachmentId: eni-attach-66c4350a - DeleteOnTermination: false - DeviceIndex: 1 - InstanceId: i-1234567890abcdef0 - InstanceOwnerId: '123456789012' - Status: attached - AvailabilityZone: us-east-1d - Description: my network interface - Groups: - - GroupId: sg-8637d3e3 - GroupName: default - MacAddress: '02:2f:8f:b0:cf:75' - NetworkInterfaceId: eni-e5aa89a3 - OwnerId: '123456789012' - PrivateDnsName: ip-10-0-1-17.ec2.internal - PrivateIpAddress: 10.0.1.17 - PrivateIpAddresses: - - Association: - AssociationId: eipassoc-0fbb766a - IpOwnerId: '123456789012' - PublicDnsName: ec2-203-0-113-12.compute-1.amazonaws.com - PublicIp: 203.0.113.12 - Primary: true - PrivateDnsName: ip-10-0-1-17.ec2.internal - PrivateIpAddress: 10.0.1.17 - RequesterManaged: false - SourceDestCheck: true - Status: in-use - SubnetId: subnet-b61f49f0 - TagSet: [] - VpcId: vpc-a01106c2 - properties: - networkInterfaceSet: - allOf: - - $ref: '#/components/schemas/NetworkInterfaceList' - - description: Information about one or more network interfaces. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - description: Contains the output of DescribeNetworkInterfaces. - DescribePlacementGroupsResult: - type: object - properties: - placementGroupSet: - allOf: - - $ref: '#/components/schemas/PlacementGroupList' - - description: Information about the placement groups. - PlacementGroupName: - type: string - PlacementGroupId: - type: string - DescribePrefixListsResult: - type: object - properties: - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - prefixListSet: - allOf: - - $ref: '#/components/schemas/PrefixListSet' - - description: All available prefix lists. - PrefixListResourceId: - type: string - DescribePrincipalIdFormatResult: - type: object - properties: - principalSet: - allOf: - - $ref: '#/components/schemas/PrincipalIdFormatList' - - description: Information about the ID format settings for the ARN. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - DescribePublicIpv4PoolsResult: - type: object - properties: - publicIpv4PoolSet: - allOf: - - $ref: '#/components/schemas/PublicIpv4PoolSet' - - description: Information about the address pools. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - Ipv4PoolEc2Id: - type: string - DescribeRegionsResult: - type: object - example: - Regions: - - Endpoint: ec2.ap-south-1.amazonaws.com - RegionName: ap-south-1 - - Endpoint: ec2.eu-west-1.amazonaws.com - RegionName: eu-west-1 - - Endpoint: ec2.ap-southeast-1.amazonaws.com - RegionName: ap-southeast-1 - - Endpoint: ec2.ap-southeast-2.amazonaws.com - RegionName: ap-southeast-2 - - Endpoint: ec2.eu-central-1.amazonaws.com - RegionName: eu-central-1 - - Endpoint: ec2.ap-northeast-2.amazonaws.com - RegionName: ap-northeast-2 - - Endpoint: ec2.ap-northeast-1.amazonaws.com - RegionName: ap-northeast-1 - - Endpoint: ec2.us-east-1.amazonaws.com - RegionName: us-east-1 - - Endpoint: ec2.sa-east-1.amazonaws.com - RegionName: sa-east-1 - - Endpoint: ec2.us-west-1.amazonaws.com - RegionName: us-west-1 - - Endpoint: ec2.us-west-2.amazonaws.com - RegionName: us-west-2 - properties: - regionInfo: - allOf: - - $ref: '#/components/schemas/RegionList' - - description: Information about the Regions. - DescribeReplaceRootVolumeTasksResult: - type: object - properties: - replaceRootVolumeTaskSet: - allOf: - - $ref: '#/components/schemas/ReplaceRootVolumeTasks' - - description: Information about the root volume replacement task. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - ReplaceRootVolumeTaskId: - type: string - DescribeReservedInstancesResult: - type: object - properties: - reservedInstancesSet: - allOf: - - $ref: '#/components/schemas/ReservedInstancesList' - - description: A list of Reserved Instances. - description: Contains the output for DescribeReservedInstances. - DescribeReservedInstancesListingsResult: - type: object - properties: - reservedInstancesListingsSet: - allOf: - - $ref: '#/components/schemas/ReservedInstancesListingList' - - description: Information about the Reserved Instance listing. - description: Contains the output of DescribeReservedInstancesListings. - DescribeReservedInstancesModificationsResult: - type: object - properties: - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - reservedInstancesModificationsSet: - allOf: - - $ref: '#/components/schemas/ReservedInstancesModificationList' - - description: The Reserved Instance modification information. - description: Contains the output of DescribeReservedInstancesModifications. - ReservedInstancesModificationId: - type: string - DescribeReservedInstancesOfferingsResult: - type: object - properties: - reservedInstancesOfferingsSet: - allOf: - - $ref: '#/components/schemas/ReservedInstancesOfferingList' - - description: A list of Reserved Instances offerings. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - description: Contains the output of DescribeReservedInstancesOfferings. - ReservedInstancesOfferingId: - type: string - DescribeRouteTablesResult: - type: object - example: - RouteTables: - - Associations: - - Main: true - RouteTableAssociationId: rtbassoc-d8ccddba - RouteTableId: rtb-1f382e7d - PropagatingVgws: [] - RouteTableId: rtb-1f382e7d - Routes: - - DestinationCidrBlock: 10.0.0.0/16 - GatewayId: local - State: active - Tags: [] - VpcId: vpc-a01106c2 - properties: - routeTableSet: - allOf: - - $ref: '#/components/schemas/RouteTableList' - - description: Information about one or more route tables. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - description: Contains the output of DescribeRouteTables. - DescribeScheduledInstanceAvailabilityResult: - type: object - example: - ScheduledInstanceAvailabilitySet: - - AvailabilityZone: us-west-2b - AvailableInstanceCount: 20 - FirstSlotStartTime: '2016-01-31T00:00:00Z' - HourlyPrice: '0.095' - InstanceType: c4.large - MaxTermDurationInDays: 366 - MinTermDurationInDays: 366 - NetworkPlatform: EC2-VPC - Platform: Linux/UNIX - PurchaseToken: eyJ2IjoiMSIsInMiOjEsImMiOi... - Recurrence: - Frequency: Weekly - Interval: 1 - OccurrenceDaySet: - - 1 - OccurrenceRelativeToEnd: false - SlotDurationInHours: 23 - TotalScheduledInstanceHours: 1219 - properties: - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token required to retrieve the next set of results. This value is null when there are no more results to return. - scheduledInstanceAvailabilitySet: - allOf: - - $ref: '#/components/schemas/ScheduledInstanceAvailabilitySet' - - description: Information about the available Scheduled Instances. - description: Contains the output of DescribeScheduledInstanceAvailability. - DateTime: - type: string - format: date-time - DescribeScheduledInstancesResult: - type: object - example: - ScheduledInstanceSet: - - AvailabilityZone: us-west-2b - CreateDate: '2016-01-25T21:43:38.612Z' - HourlyPrice: '0.095' - InstanceCount: 1 - InstanceType: c4.large - NetworkPlatform: EC2-VPC - NextSlotStartTime: '2016-01-31T09:00:00Z' - Platform: Linux/UNIX - Recurrence: - Frequency: Weekly - Interval: 1 - OccurrenceDaySet: - - 1 - OccurrenceRelativeToEnd: false - OccurrenceUnit: '' - ScheduledInstanceId: sci-1234-1234-1234-1234-123456789012 - SlotDurationInHours: 32 - TermEndDate: '2017-01-31T09:00:00Z' - TermStartDate: '2016-01-31T09:00:00Z' - TotalScheduledInstanceHours: 1696 - properties: - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token required to retrieve the next set of results. This value is null when there are no more results to return. - scheduledInstanceSet: - allOf: - - $ref: '#/components/schemas/ScheduledInstanceSet' - - description: Information about the Scheduled Instances. - description: Contains the output of DescribeScheduledInstances. - ScheduledInstanceId: - type: string - DescribeSecurityGroupReferencesResult: - type: object - example: - SecurityGroupReferenceSet: - - GroupId: sg-903004f8 - ReferencingVpcId: vpc-1a2b3c4d - VpcPeeringConnectionId: pcx-b04deed9 - properties: - securityGroupReferenceSet: - allOf: - - $ref: '#/components/schemas/SecurityGroupReferences' - - description: Information about the VPCs with the referencing security groups. - DescribeSecurityGroupRulesResult: - type: object - properties: - securityGroupRuleSet: - allOf: - - $ref: '#/components/schemas/SecurityGroupRuleList' - - description: Information about security group rules. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The token to use to retrieve the next page of results. This value is null when there are no more results to return. ' - DescribeSecurityGroupsResult: - type: object - example: {} - properties: - securityGroupInfo: - allOf: - - $ref: '#/components/schemas/SecurityGroupList' - - description: Information about the security groups. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - SecurityGroupName: - type: string - DescribeSnapshotAttributeResult: - type: object - example: - CreateVolumePermissions: [] - SnapshotId: snap-066877671789bd71b - properties: - createVolumePermission: - allOf: - - $ref: '#/components/schemas/CreateVolumePermissionList' - - description: The users and groups that have the permissions for creating volumes from the snapshot. - productCodes: - allOf: - - $ref: '#/components/schemas/ProductCodeList' - - description: The product codes. - snapshotId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the EBS snapshot. - DescribeSnapshotTierStatusResult: - type: object - properties: - snapshotTierStatusSet: - allOf: - - $ref: '#/components/schemas/snapshotTierStatusSet' - - description: Information about the snapshot's storage tier. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - DescribeSnapshotsResult: - type: object - example: - NextToken: '' - Snapshots: - - Description: This is my copied snapshot. - OwnerId: 012345678910 - Progress: 87% - SnapshotId: snap-066877671789bd71b - StartTime: '2014-02-28T21:37:27.000Z' - State: pending - VolumeId: vol-1234567890abcdef0 - VolumeSize: 8 - properties: - snapshotSet: - allOf: - - $ref: '#/components/schemas/SnapshotList' - - description: Information about the snapshots. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The NextToken value to include in a future DescribeSnapshots request. When the results of a DescribeSnapshots request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.' - SnapshotId: - type: string - DescribeSpotDatafeedSubscriptionResult: - type: object - example: - SpotDatafeedSubscription: - Bucket: my-s3-bucket - OwnerId: '123456789012' - Prefix: spotdata - State: Active - properties: - spotDatafeedSubscription: - allOf: - - $ref: '#/components/schemas/SpotDatafeedSubscription' - - description: The Spot Instance data feed subscription. - description: Contains the output of DescribeSpotDatafeedSubscription. - DescribeSpotFleetInstancesResponse: - type: object - example: - ActiveInstances: - - InstanceId: i-1234567890abcdef0 - InstanceType: m3.medium - SpotInstanceRequestId: sir-08b93456 - SpotFleetRequestId: sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE - properties: - activeInstanceSet: - allOf: - - $ref: '#/components/schemas/ActiveInstanceSet' - - description: The running instances. This list is refreshed periodically and might be out of date. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token required to retrieve the next set of results. This value is null when there are no more results to return. - spotFleetRequestId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Spot Fleet request. - description: Contains the output of DescribeSpotFleetInstances. - DescribeSpotFleetRequestHistoryResponse: - type: object - example: - HistoryRecords: - - EventInformation: - EventSubType: submitted - EventType: fleetRequestChange - Timestamp: '2015-05-26T23:17:20.697Z' - - EventInformation: - EventSubType: active - EventType: fleetRequestChange - Timestamp: '2015-05-26T23:17:20.873Z' - - EventInformation: - EventSubType: launched - InstanceId: i-1234567890abcdef0 - EventType: instanceChange - Timestamp: '2015-05-26T23:21:21.712Z' - - EventInformation: - EventSubType: launched - InstanceId: i-1234567890abcdef1 - EventType: instanceChange - Timestamp: '2015-05-26T23:21:21.816Z' - NextToken: CpHNsscimcV5oH7bSbub03CI2Qms5+ypNpNm+53MNlR0YcXAkp0xFlfKf91yVxSExmbtma3awYxMFzNA663ZskT0AHtJ6TCb2Z8bQC2EnZgyELbymtWPfpZ1ZbauVg+P+TfGlWxWWB/Vr5dk5d4LfdgA/DRAHUrYgxzrEXAMPLE= - SpotFleetRequestId: sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE - StartTime: '2015-05-26T00:00:00Z' - properties: - historyRecordSet: - allOf: - - $ref: '#/components/schemas/HistoryRecords' - - description: Information about the events in the history of the Spot Fleet request. - lastEvaluatedTime: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: '

The last date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). All records up to this time were retrieved.

If nextToken indicates that there are more results, this value is not present.

' - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token required to retrieve the next set of results. This value is null when there are no more results to return. - spotFleetRequestId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Spot Fleet request. - startTime: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: 'The starting date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).' - description: Contains the output of DescribeSpotFleetRequestHistory. - DescribeSpotFleetRequestsResponse: - type: object - example: - SpotFleetRequestConfigs: - - SpotFleetRequestConfig: - IamFleetRole: 'arn:aws:iam::123456789012:role/my-spot-fleet-role' - LaunchSpecifications: - - EbsOptimized: false - ImageId: ami-1a2b3c4d - InstanceType: cc2.8xlarge - NetworkInterfaces: - - AssociatePublicIpAddress: true - DeleteOnTermination: false - DeviceIndex: 0 - SecondaryPrivateIpAddressCount: 0 - SubnetId: subnet-a61dafcf - - EbsOptimized: false - ImageId: ami-1a2b3c4d - InstanceType: r3.8xlarge - NetworkInterfaces: - - AssociatePublicIpAddress: true - DeleteOnTermination: false - DeviceIndex: 0 - SecondaryPrivateIpAddressCount: 0 - SubnetId: subnet-a61dafcf - SpotPrice: '0.05' - TargetCapacity: 20 - SpotFleetRequestId: sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE - SpotFleetRequestState: active - properties: - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token required to retrieve the next set of results. This value is null when there are no more results to return. - spotFleetRequestConfigSet: - allOf: - - $ref: '#/components/schemas/SpotFleetRequestConfigSet' - - description: Information about the configuration of your Spot Fleet. - description: Contains the output of DescribeSpotFleetRequests. - DescribeSpotInstanceRequestsResult: - type: object - example: - SpotInstanceRequests: - - CreateTime: '2014-04-30T18:14:55.000Z' - InstanceId: i-1234567890abcdef0 - LaunchSpecification: - BlockDeviceMappings: - - DeviceName: /dev/sda1 - Ebs: - DeleteOnTermination: true - VolumeSize: 8 - VolumeType: standard - EbsOptimized: false - ImageId: ami-7aba833f - InstanceType: m1.small - KeyName: my-key-pair - SecurityGroups: - - GroupId: sg-e38f24a7 - GroupName: my-security-group - LaunchedAvailabilityZone: us-west-1b - ProductDescription: Linux/UNIX - SpotInstanceRequestId: sir-08b93456 - SpotPrice: '0.010000' - State: active - Status: - Code: fulfilled - Message: Your Spot request is fulfilled. - UpdateTime: '2014-04-30T18:16:21.000Z' - Type: one-time - properties: - spotInstanceRequestSet: - allOf: - - $ref: '#/components/schemas/SpotInstanceRequestList' - - description: One or more Spot Instance requests. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next set of results. This value is null when there are no more results to return. - description: Contains the output of DescribeSpotInstanceRequests. - DescribeSpotPriceHistoryResult: - type: object - example: - SpotPriceHistory: - - AvailabilityZone: us-west-1a - InstanceType: m1.xlarge - ProductDescription: Linux/UNIX (Amazon VPC) - SpotPrice: '0.080000' - Timestamp: '2014-01-06T04:32:53.000Z' - - AvailabilityZone: us-west-1c - InstanceType: m1.xlarge - ProductDescription: Linux/UNIX (Amazon VPC) - SpotPrice: '0.080000' - Timestamp: '2014-01-05T11:28:26.000Z' - properties: - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token required to retrieve the next set of results. This value is null or an empty string when there are no more results to return. - spotPriceHistorySet: - allOf: - - $ref: '#/components/schemas/SpotPriceHistoryList' - - description: The historical Spot prices. - description: Contains the output of DescribeSpotPriceHistory. - DescribeStaleSecurityGroupsResult: - type: object - properties: - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.' - staleSecurityGroupSet: - allOf: - - $ref: '#/components/schemas/StaleSecurityGroupSet' - - description: Information about the stale security groups. - DescribeStoreImageTasksResult: - type: object - properties: - storeImageTaskResultSet: - allOf: - - $ref: '#/components/schemas/StoreImageTaskResultSet' - - description: The information about the AMI store tasks. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - DescribeSubnetsResult: - type: object - example: - Subnets: - - AvailabilityZone: us-east-1c - AvailableIpAddressCount: 251 - CidrBlock: 10.0.1.0/24 - DefaultForAz: false - MapPublicIpOnLaunch: false - State: available - SubnetId: subnet-9d4a7b6c - VpcId: vpc-a01106c2 - properties: - subnetSet: - allOf: - - $ref: '#/components/schemas/SubnetList' - - description: Information about one or more subnets. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - DescribeTagsResult: - type: object - example: - Tags: - - Key: Stack - ResourceId: i-1234567890abcdef8 - ResourceType: instance - Value: test - - Key: Name - ResourceId: i-1234567890abcdef8 - ResourceType: instance - Value: Beta Server - properties: - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - tagSet: - allOf: - - $ref: '#/components/schemas/TagDescriptionList' - - description: The tags. - DescribeTrafficMirrorFiltersResult: - type: object - properties: - trafficMirrorFilterSet: - allOf: - - $ref: '#/components/schemas/TrafficMirrorFilterSet' - - description: Information about one or more Traffic Mirror filters. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. The value is null when there are no more results to return. - TrafficMirrorFilterId: - type: string - DescribeTrafficMirrorSessionsResult: - type: object - properties: - trafficMirrorSessionSet: - allOf: - - $ref: '#/components/schemas/TrafficMirrorSessionSet' - - description: 'Describes one or more Traffic Mirror sessions. By default, all Traffic Mirror sessions are described. Alternatively, you can filter the results.' - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. The value is null when there are no more results to return. - TrafficMirrorSessionId: - type: string - DescribeTrafficMirrorTargetsResult: - type: object - properties: - trafficMirrorTargetSet: - allOf: - - $ref: '#/components/schemas/TrafficMirrorTargetSet' - - description: Information about one or more Traffic Mirror targets. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. The value is null when there are no more results to return. - TrafficMirrorTargetId: - type: string - DescribeTransitGatewayAttachmentsResult: - type: object - properties: - transitGatewayAttachments: - allOf: - - $ref: '#/components/schemas/TransitGatewayAttachmentList' - - description: Information about the attachments. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - TransitGatewayAttachmentId: - type: string - DescribeTransitGatewayConnectPeersResult: - type: object - properties: - transitGatewayConnectPeerSet: - allOf: - - $ref: '#/components/schemas/TransitGatewayConnectPeerList' - - description: Information about the Connect peers. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - TransitGatewayConnectPeerId: - type: string - DescribeTransitGatewayConnectsResult: - type: object - properties: - transitGatewayConnectSet: - allOf: - - $ref: '#/components/schemas/TransitGatewayConnectList' - - description: Information about the Connect attachments. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - DescribeTransitGatewayMulticastDomainsResult: - type: object - properties: - transitGatewayMulticastDomains: - allOf: - - $ref: '#/components/schemas/TransitGatewayMulticastDomainList' - - description: Information about the transit gateway multicast domains. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - TransitGatewayMulticastDomainId: - type: string - DescribeTransitGatewayPeeringAttachmentsResult: - type: object - properties: - transitGatewayPeeringAttachments: - allOf: - - $ref: '#/components/schemas/TransitGatewayPeeringAttachmentList' - - description: The transit gateway peering attachments. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - DescribeTransitGatewayRouteTablesResult: - type: object - properties: - transitGatewayRouteTables: - allOf: - - $ref: '#/components/schemas/TransitGatewayRouteTableList' - - description: Information about the transit gateway route tables. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - TransitGatewayRouteTableId: - type: string - DescribeTransitGatewayVpcAttachmentsResult: - type: object - properties: - transitGatewayVpcAttachments: - allOf: - - $ref: '#/components/schemas/TransitGatewayVpcAttachmentList' - - description: Information about the VPC attachments. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - DescribeTransitGatewaysResult: - type: object - properties: - transitGatewaySet: - allOf: - - $ref: '#/components/schemas/TransitGatewayList' - - description: Information about the transit gateways. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - TransitGatewayId: - type: string - DescribeTrunkInterfaceAssociationsResult: - type: object - properties: - interfaceAssociationSet: - allOf: - - $ref: '#/components/schemas/TrunkInterfaceAssociationList' - - description: Information about the trunk associations. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - TrunkInterfaceAssociationId: - type: string - DescribeVolumeAttributeResult: - type: object - example: - AutoEnableIO: - Value: false - VolumeId: vol-049df61146c4d7901 - properties: - autoEnableIO: - allOf: - - $ref: '#/components/schemas/AttributeBooleanValue' - - description: The state of autoEnableIO attribute. - productCodes: - allOf: - - $ref: '#/components/schemas/ProductCodeList' - - description: A list of product codes. - volumeId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the volume. - DescribeVolumeStatusResult: - type: object - example: - VolumeStatuses: [] - properties: - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - volumeStatusSet: - allOf: - - $ref: '#/components/schemas/VolumeStatusList' - - description: Information about the status of the volumes. - VolumeId: - type: string - DescribeVolumesResult: - type: object - example: - Volumes: - - Attachments: - - AttachTime: '2013-12-18T22:35:00.000Z' - DeleteOnTermination: true - Device: /dev/sda1 - InstanceId: i-1234567890abcdef0 - State: attached - VolumeId: vol-049df61146c4d7901 - AvailabilityZone: us-east-1a - CreateTime: '2013-12-18T22:35:00.084Z' - Size: 8 - SnapshotId: snap-1234567890abcdef0 - State: in-use - VolumeId: vol-049df61146c4d7901 - VolumeType: standard - properties: - volumeSet: - allOf: - - $ref: '#/components/schemas/VolumeList' - - description: Information about the volumes. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The NextToken value to include in a future DescribeVolumes request. When the results of a DescribeVolumes request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.' - DescribeVolumesModificationsResult: - type: object - properties: - volumeModificationSet: - allOf: - - $ref: '#/components/schemas/VolumeModificationList' - - description: Information about the volume modifications. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: 'Token for pagination, null if there are no more results ' - DescribeVpcAttributeResult: - type: object - example: - EnableDnsHostnames: - Value: true - VpcId: vpc-a01106c2 - properties: - vpcId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the VPC. - enableDnsHostnames: - allOf: - - $ref: '#/components/schemas/AttributeBooleanValue' - - description: 'Indicates whether the instances launched in the VPC get DNS hostnames. If this attribute is true, instances in the VPC get DNS hostnames; otherwise, they do not.' - enableDnsSupport: - allOf: - - $ref: '#/components/schemas/AttributeBooleanValue' - - description: 'Indicates whether DNS resolution is enabled for the VPC. If this attribute is true, the Amazon DNS server resolves DNS hostnames for your instances to their corresponding IP addresses; otherwise, it does not.' - DescribeVpcClassicLinkResult: - type: object - properties: - vpcSet: - allOf: - - $ref: '#/components/schemas/VpcClassicLinkList' - - description: The ClassicLink status of one or more VPCs. - VpcId: - type: string - DescribeVpcClassicLinkDnsSupportResult: - type: object - properties: - nextToken: - allOf: - - $ref: '#/components/schemas/DescribeVpcClassicLinkDnsSupportNextToken' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - vpcs: - allOf: - - $ref: '#/components/schemas/ClassicLinkDnsSupportList' - - description: Information about the ClassicLink DNS support status of the VPCs. - DescribeVpcEndpointConnectionNotificationsResult: - type: object - properties: - connectionNotificationSet: - allOf: - - $ref: '#/components/schemas/ConnectionNotificationSet' - - description: One or more notifications. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - DescribeVpcEndpointConnectionsResult: - type: object - properties: - vpcEndpointConnectionSet: - allOf: - - $ref: '#/components/schemas/VpcEndpointConnectionSet' - - description: Information about one or more VPC endpoint connections. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - DescribeVpcEndpointServiceConfigurationsResult: - type: object - properties: - serviceConfigurationSet: - allOf: - - $ref: '#/components/schemas/ServiceConfigurationSet' - - description: Information about one or more services. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - DescribeVpcEndpointServicePermissionsResult: - type: object - properties: - allowedPrincipals: - allOf: - - $ref: '#/components/schemas/AllowedPrincipalSet' - - description: Information about one or more allowed principals. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - DescribeVpcEndpointServicesResult: - type: object - properties: - serviceNameSet: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: A list of supported services. - serviceDetailSet: - allOf: - - $ref: '#/components/schemas/ServiceDetailSet' - - description: Information about the service. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.' - description: Contains the output of DescribeVpcEndpointServices. - DescribeVpcEndpointsResult: - type: object - properties: - vpcEndpointSet: - allOf: - - $ref: '#/components/schemas/VpcEndpointSet' - - description: Information about the endpoints. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.' - description: Contains the output of DescribeVpcEndpoints. - DescribeVpcPeeringConnectionsResult: - type: object - properties: - vpcPeeringConnectionSet: - allOf: - - $ref: '#/components/schemas/VpcPeeringConnectionList' - - description: Information about the VPC peering connections. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - VpcPeeringConnectionId: - type: string - DescribeVpcsResult: - type: object - example: - Vpcs: - - CidrBlock: 10.0.0.0/16 - DhcpOptionsId: dopt-7a8b9c2d - InstanceTenancy: default - IsDefault: false - State: available - Tags: - - Key: Name - Value: MyVPC - VpcId: vpc-a01106c2 - properties: - vpcSet: - allOf: - - $ref: '#/components/schemas/VpcList' - - description: Information about one or more VPCs. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - DescribeVpnConnectionsResult: - type: object - properties: - vpnConnectionSet: - allOf: - - $ref: '#/components/schemas/VpnConnectionList' - - description: Information about one or more VPN connections. - description: Contains the output of DescribeVpnConnections. - VpnConnectionId: - type: string - DescribeVpnGatewaysResult: - type: object - properties: - vpnGatewaySet: - allOf: - - $ref: '#/components/schemas/VpnGatewayList' - - description: Information about one or more virtual private gateways. - description: Contains the output of DescribeVpnGateways. - VpnGatewayId: - type: string - DetachClassicLinkVpcResult: - type: object - properties: - return: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Returns true if the request succeeds; otherwise, it returns an error.' - DisableEbsEncryptionByDefaultResult: - type: object - properties: - ebsEncryptionByDefault: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: The updated status of encryption by default. - DisableFastLaunchResult: - type: object - properties: - imageId: - allOf: - - $ref: '#/components/schemas/ImageId' - - description: The ID of the image for which faster-launching has been turned off. - resourceType: - allOf: - - $ref: '#/components/schemas/FastLaunchResourceType' - - description: 'The pre-provisioning resource type that must be cleaned after turning off faster launching for the Windows AMI. Supported values include: snapshot.' - snapshotConfiguration: - allOf: - - $ref: '#/components/schemas/FastLaunchSnapshotConfigurationResponse' - - description: Parameters that were used for faster launching for the Windows AMI before faster launching was turned off. This informs the clean-up process. - launchTemplate: - allOf: - - $ref: '#/components/schemas/FastLaunchLaunchTemplateSpecificationResponse' - - description: The launch template that was used to launch Windows instances from pre-provisioned snapshots. - maxParallelLaunches: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The maximum number of parallel instances to launch for creating resources. - ownerId: - allOf: - - $ref: '#/components/schemas/String' - - description: The owner of the Windows AMI for which faster launching was turned off. - state: - allOf: - - $ref: '#/components/schemas/FastLaunchStateCode' - - description: The current state of faster launching for the specified Windows AMI. - stateTransitionReason: - allOf: - - $ref: '#/components/schemas/String' - - description: The reason that the state changed for faster launching for the Windows AMI. - stateTransitionTime: - allOf: - - $ref: '#/components/schemas/MillisecondDateTime' - - description: The time that the state changed for faster launching for the Windows AMI. - DisableFastSnapshotRestoresResult: - type: object - properties: - successful: - allOf: - - $ref: '#/components/schemas/DisableFastSnapshotRestoreSuccessSet' - - description: Information about the snapshots for which fast snapshot restores were successfully disabled. - unsuccessful: - allOf: - - $ref: '#/components/schemas/DisableFastSnapshotRestoreErrorSet' - - description: Information about the snapshots for which fast snapshot restores could not be disabled. - DisableImageDeprecationResult: - type: object - properties: - return: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Returns true if the request succeeds; otherwise, it returns an error.' - DisableIpamOrganizationAdminAccountResult: - type: object - properties: - success: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: The result of disabling the IPAM account. - DisableSerialConsoleAccessResult: - type: object - properties: - serialConsoleAccessEnabled: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'If true, access to the EC2 serial console of all instances is enabled for your account. If false, access to the EC2 serial console of all instances is disabled for your account.' - DisableTransitGatewayRouteTablePropagationResult: - type: object - properties: - propagation: - allOf: - - $ref: '#/components/schemas/TransitGatewayPropagation' - - description: Information about route propagation. - DisableVpcClassicLinkResult: - type: object - properties: - return: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Returns true if the request succeeds; otherwise, it returns an error.' - DisableVpcClassicLinkDnsSupportResult: - type: object - properties: - return: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Returns true if the request succeeds; otherwise, it returns an error.' - DisassociateClientVpnTargetNetworkResult: - type: object - properties: - associationId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the target network association. - status: - allOf: - - $ref: '#/components/schemas/AssociationStatus' - - description: The current state of the target network association. - DisassociateEnclaveCertificateIamRoleResult: - type: object - properties: - return: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Returns true if the request succeeds; otherwise, it returns an error.' - DisassociateIamInstanceProfileResult: - type: object - example: - IamInstanceProfileAssociation: - AssociationId: iip-assoc-05020b59952902f5f - IamInstanceProfile: - Arn: 'arn:aws:iam::123456789012:instance-profile/admin-role' - Id: AIPAI5IVIHMFFYY2DKV5Y - InstanceId: i-123456789abcde123 - State: disassociating - properties: - iamInstanceProfileAssociation: - allOf: - - $ref: '#/components/schemas/IamInstanceProfileAssociation' - - description: Information about the IAM instance profile association. - DisassociateInstanceEventWindowResult: - type: object - properties: - instanceEventWindow: - allOf: - - $ref: '#/components/schemas/InstanceEventWindow' - - description: Information about the event window. - DisassociateSubnetCidrBlockResult: - type: object - properties: - ipv6CidrBlockAssociation: - allOf: - - $ref: '#/components/schemas/SubnetIpv6CidrBlockAssociation' - - description: Information about the IPv6 CIDR block association. - subnetId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the subnet. - DisassociateTransitGatewayMulticastDomainResult: - type: object - properties: - associations: - allOf: - - $ref: '#/components/schemas/TransitGatewayMulticastDomainAssociations' - - description: Information about the association. - DisassociateTransitGatewayRouteTableResult: - type: object - properties: - association: - allOf: - - $ref: '#/components/schemas/TransitGatewayAssociation' - - description: Information about the association. - DisassociateTrunkInterfaceResult: - type: object - properties: - return: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Returns true if the request succeeds; otherwise, it returns an error.' - clientToken: - allOf: - - $ref: '#/components/schemas/String' - - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.' - DisassociateVpcCidrBlockResult: - type: object - properties: - ipv6CidrBlockAssociation: - allOf: - - $ref: '#/components/schemas/VpcIpv6CidrBlockAssociation' - - description: Information about the IPv6 CIDR block association. - cidrBlockAssociation: - allOf: - - $ref: '#/components/schemas/VpcCidrBlockAssociation' - - description: Information about the IPv4 CIDR block association. - vpcId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the VPC. - EnableEbsEncryptionByDefaultResult: - type: object - properties: - ebsEncryptionByDefault: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: The updated status of encryption by default. - EnableFastLaunchResult: - type: object - properties: - imageId: - allOf: - - $ref: '#/components/schemas/ImageId' - - description: The image ID that identifies the Windows AMI for which faster launching was enabled. - resourceType: - allOf: - - $ref: '#/components/schemas/FastLaunchResourceType' - - description: The type of resource that was defined for pre-provisioning the Windows AMI for faster launching. - snapshotConfiguration: - allOf: - - $ref: '#/components/schemas/FastLaunchSnapshotConfigurationResponse' - - description: The configuration settings that were defined for creating and managing the pre-provisioned snapshots for faster launching of the Windows AMI. This property is returned when the associated resourceType is snapshot. - launchTemplate: - allOf: - - $ref: '#/components/schemas/FastLaunchLaunchTemplateSpecificationResponse' - - description: The launch template that is used when launching Windows instances from pre-provisioned snapshots. - maxParallelLaunches: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The maximum number of parallel instances to launch for creating resources. - ownerId: - allOf: - - $ref: '#/components/schemas/String' - - description: The owner ID for the Windows AMI for which faster launching was enabled. - state: - allOf: - - $ref: '#/components/schemas/FastLaunchStateCode' - - description: The current state of faster launching for the specified Windows AMI. - stateTransitionReason: - allOf: - - $ref: '#/components/schemas/String' - - description: The reason that the state changed for faster launching for the Windows AMI. - stateTransitionTime: - allOf: - - $ref: '#/components/schemas/MillisecondDateTime' - - description: The time that the state changed for faster launching for the Windows AMI. - EnableFastSnapshotRestoresResult: - type: object - properties: - successful: - allOf: - - $ref: '#/components/schemas/EnableFastSnapshotRestoreSuccessSet' - - description: Information about the snapshots for which fast snapshot restores were successfully enabled. - unsuccessful: - allOf: - - $ref: '#/components/schemas/EnableFastSnapshotRestoreErrorSet' - - description: Information about the snapshots for which fast snapshot restores could not be enabled. - EnableImageDeprecationResult: - type: object - properties: - return: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Returns true if the request succeeds; otherwise, it returns an error.' - EnableIpamOrganizationAdminAccountResult: - type: object - properties: - success: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: The result of enabling the IPAM account. - EnableSerialConsoleAccessResult: - type: object - properties: - serialConsoleAccessEnabled: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'If true, access to the EC2 serial console of all instances is enabled for your account. If false, access to the EC2 serial console of all instances is disabled for your account.' - EnableTransitGatewayRouteTablePropagationResult: - type: object - properties: - propagation: - allOf: - - $ref: '#/components/schemas/TransitGatewayPropagation' - - description: Information about route propagation. - EnableVpcClassicLinkResult: - type: object - properties: - return: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Returns true if the request succeeds; otherwise, it returns an error.' - EnableVpcClassicLinkDnsSupportResult: - type: object - properties: - return: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Returns true if the request succeeds; otherwise, it returns an error.' - ExportClientVpnClientCertificateRevocationListResult: - type: object - properties: - certificateRevocationList: - allOf: - - $ref: '#/components/schemas/String' - - description: Information about the client certificate revocation list. - status: - allOf: - - $ref: '#/components/schemas/ClientCertificateRevocationListStatus' - - description: The current state of the client certificate revocation list. - ExportClientVpnClientConfigurationResult: - type: object - properties: - clientConfiguration: - allOf: - - $ref: '#/components/schemas/String' - - description: The contents of the Client VPN endpoint configuration file. - ExportImageResult: - type: object - properties: - description: - allOf: - - $ref: '#/components/schemas/String' - - description: A description of the image being exported. - diskImageFormat: - allOf: - - $ref: '#/components/schemas/DiskImageFormat' - - description: The disk image format for the exported image. - exportImageTaskId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the export image task. - imageId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the image. - roleName: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of the role that grants VM Import/Export permission to export images to your Amazon S3 bucket. - progress: - allOf: - - $ref: '#/components/schemas/String' - - description: The percent complete of the export image task. - s3ExportLocation: - allOf: - - $ref: '#/components/schemas/ExportTaskS3Location' - - description: Information about the destination Amazon S3 bucket. - status: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The status of the export image task. The possible values are active, completed, deleting, and deleted.' - statusMessage: - allOf: - - $ref: '#/components/schemas/String' - - description: The status message for the export image task. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: Any tags assigned to the export image task. - ExportTransitGatewayRoutesResult: - type: object - properties: - s3Location: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The URL of the exported file in Amazon S3. For example, s3://bucket_name/VPCTransitGateway/TransitGatewayRouteTables/file_name.' - GetAssociatedEnclaveCertificateIamRolesResult: - type: object - properties: - associatedRoleSet: - allOf: - - $ref: '#/components/schemas/AssociatedRolesList' - - description: Information about the associated IAM roles. - GetAssociatedIpv6PoolCidrsResult: - type: object - properties: - ipv6CidrAssociationSet: - allOf: - - $ref: '#/components/schemas/Ipv6CidrAssociationSet' - - description: Information about the IPv6 CIDR block associations. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - GetCapacityReservationUsageResult: - type: object - properties: - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - capacityReservationId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Capacity Reservation. - instanceType: - allOf: - - $ref: '#/components/schemas/String' - - description: The type of instance for which the Capacity Reservation reserves capacity. - totalInstanceCount: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The number of instances for which the Capacity Reservation reserves capacity. - availableInstanceCount: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation. - state: - allOf: - - $ref: '#/components/schemas/CapacityReservationState' - - description: '

The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:

  • active - The Capacity Reservation is active and the capacity is available for your use.

  • expired - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.

  • cancelled - The Capacity Reservation was cancelled. The reserved capacity is no longer available for your use.

  • pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.

  • failed - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.

' - instanceUsageSet: - allOf: - - $ref: '#/components/schemas/InstanceUsageSet' - - description: Information about the Capacity Reservation usage. - GetCoipPoolUsageResult: - type: object - properties: - coipPoolId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the customer-owned address pool. - coipAddressUsageSet: - allOf: - - $ref: '#/components/schemas/CoipAddressUsageSet' - - description: Information about the address usage. - localGatewayRouteTableId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the local gateway route table. - GetConsoleOutputResult: - type: object - example: - InstanceId: i-1234567890abcdef0 - Output: ... - Timestamp: '2018-05-25T21:23:53.000Z' - properties: - instanceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the instance. - output: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The console output, base64-encoded. If you are using a command line tool, the tool decodes the output for you.' - timestamp: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The time at which the output was last updated. - GetConsoleScreenshotResult: - type: object - properties: - imageData: - allOf: - - $ref: '#/components/schemas/String' - - description: The data that comprises the image. - instanceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the instance. - GetDefaultCreditSpecificationResult: - type: object - properties: - instanceFamilyCreditSpecification: - allOf: - - $ref: '#/components/schemas/InstanceFamilyCreditSpecification' - - description: The default credit option for CPU usage of the instance family. - GetEbsDefaultKmsKeyIdResult: - type: object - properties: - kmsKeyId: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Resource Name (ARN) of the default KMS key for encryption by default. - GetEbsEncryptionByDefaultResult: - type: object - properties: - ebsEncryptionByDefault: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether encryption by default is enabled. - GetFlowLogsIntegrationTemplateResult: - type: object - properties: - result: - allOf: - - $ref: '#/components/schemas/String' - - description: The generated CloudFormation template. - AthenaIntegrationsSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/AthenaIntegration' - - xml: - name: item - minItems: 1 - maxItems: 10 - GetGroupsForCapacityReservationResult: - type: object - properties: - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - capacityReservationGroupSet: - allOf: - - $ref: '#/components/schemas/CapacityReservationGroupSet' - - description: Information about the resource groups to which the Capacity Reservation has been added. - GetHostReservationPurchasePreviewResult: - type: object - properties: - currencyCode: - allOf: - - $ref: '#/components/schemas/CurrencyCodeValues' - - description: 'The currency in which the totalUpfrontPrice and totalHourlyPrice amounts are specified. At this time, the only supported currency is USD.' - purchase: - allOf: - - $ref: '#/components/schemas/PurchaseSet' - - description: The purchase information of the Dedicated Host reservation and the Dedicated Hosts associated with it. - totalHourlyPrice: - allOf: - - $ref: '#/components/schemas/String' - - description: The potential total hourly price of the reservation per hour. - totalUpfrontPrice: - allOf: - - $ref: '#/components/schemas/String' - - description: The potential total upfront price. This is billed immediately. - GetInstanceTypesFromInstanceRequirementsResult: - type: object - properties: - instanceTypeSet: - allOf: - - $ref: '#/components/schemas/InstanceTypeInfoFromInstanceRequirementsSet' - - description: The instance types with the specified instance attributes. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token for the next set of results. - ArchitectureType: - type: string - enum: - - i386 - - x86_64 - - arm64 - - x86_64_mac - VirtualizationType: - type: string - enum: - - hvm - - paravirtual - MemoryMiBRequest: - type: object - required: - - Min - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The maximum amount of memory, in MiB. To specify no maximum limit, omit this parameter.' - description: 'The minimum and maximum amount of memory, in MiB.' - MemoryGiBPerVCpuRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Double' - - description: 'The maximum amount of memory per vCPU, in GiB. To specify no maximum limit, omit this parameter.' - description: 'The minimum and maximum amount of memory per vCPU, in GiB.' - ExcludedInstanceTypeSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/ExcludedInstanceType' - - xml: - name: item - minItems: 0 - maxItems: 400 - LocalStorage: - type: string - enum: - - included - - required - - excluded - BaselineEbsBandwidthMbpsRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The maximum baseline bandwidth, in Mbps. To specify no maximum limit, omit this parameter.' - description: 'The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see Amazon EBS–optimized instances in the Amazon EC2 User Guide.' - AcceleratorCountRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The maximum number of accelerators. To specify no maximum limit, omit this parameter. To exclude accelerator-enabled instance types, set Max to 0.' - description: 'The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on an instance. To exclude accelerator-enabled instance types, set Max to 0.' - AcceleratorManufacturerSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/AcceleratorManufacturer' - - xml: - name: item - AcceleratorTotalMemoryMiBRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The maximum amount of accelerator memory, in MiB. To specify no maximum limit, omit this parameter.' - description: 'The minimum and maximum amount of total accelerator memory, in MiB.' - GetInstanceUefiDataResult: - type: object - properties: - instanceId: - allOf: - - $ref: '#/components/schemas/InstanceId' - - description: The ID of the instance from which to retrieve the UEFI data. - uefiData: - allOf: - - $ref: '#/components/schemas/String' - - description: Base64 representation of the non-volatile UEFI variable store. - GetIpamAddressHistoryResult: - type: object - properties: - historyRecordSet: - allOf: - - $ref: '#/components/schemas/IpamAddressHistoryRecordSet' - - description: 'A historical record for a CIDR within an IPAM scope. If the CIDR is associated with an EC2 instance, you will see an object in the response for the instance and one for the network interface.' - nextToken: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - GetIpamPoolAllocationsResult: - type: object - properties: - ipamPoolAllocationSet: - allOf: - - $ref: '#/components/schemas/IpamPoolAllocationSet' - - description: The IPAM pool allocations you want information on. - nextToken: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - GetIpamPoolCidrsResult: - type: object - properties: - ipamPoolCidrSet: - allOf: - - $ref: '#/components/schemas/IpamPoolCidrSet' - - description: Information about the CIDRs provisioned to an IPAM pool. - nextToken: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - GetIpamResourceCidrsResult: - type: object - properties: - nextToken: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - ipamResourceCidrSet: - allOf: - - $ref: '#/components/schemas/IpamResourceCidrSet' - - description: The resource CIDRs. - GetLaunchTemplateDataResult: - type: object - example: - LaunchTemplateData: - BlockDeviceMappings: - - DeviceName: /dev/xvda - Ebs: - DeleteOnTermination: true - Encrypted: false - Iops: 100 - SnapshotId: snap-02594938353ef77d3 - VolumeSize: 8 - VolumeType: gp2 - EbsOptimized: false - ImageId: ami-32cf7b4a - InstanceType: t2.medium - KeyName: my-key-pair - Monitoring: - Enabled: false - NetworkInterfaces: - - AssociatePublicIpAddress: false - DeleteOnTermination: true - Description: '' - DeviceIndex: 0 - Groups: - - sg-d14e1bb4 - Ipv6Addresses: [] - NetworkInterfaceId: eni-4338b5a9 - PrivateIpAddress: 10.0.3.233 - PrivateIpAddresses: - - Primary: true - PrivateIpAddress: 10.0.3.233 - SubnetId: subnet-5264e837 - Placement: - AvailabilityZone: us-east-2b - GroupName: '' - Tenancy: default - properties: - launchTemplateData: - allOf: - - $ref: '#/components/schemas/ResponseLaunchTemplateData' - - description: The instance data. - GetManagedPrefixListAssociationsResult: - type: object - properties: - prefixListAssociationSet: - allOf: - - $ref: '#/components/schemas/PrefixListAssociationSet' - - description: Information about the associations. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - GetManagedPrefixListEntriesResult: - type: object - properties: - entrySet: - allOf: - - $ref: '#/components/schemas/PrefixListEntrySet' - - description: Information about the prefix list entries. - nextToken: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - GetNetworkInsightsAccessScopeAnalysisFindingsResult: - type: object - properties: - networkInsightsAccessScopeAnalysisId: - allOf: - - $ref: '#/components/schemas/NetworkInsightsAccessScopeAnalysisId' - - description: The ID of the Network Access Scope analysis. - analysisStatus: - allOf: - - $ref: '#/components/schemas/AnalysisStatus' - - description: The status of Network Access Scope Analysis. - analysisFindingSet: - allOf: - - $ref: '#/components/schemas/AccessScopeAnalysisFindingList' - - description: The findings associated with Network Access Scope Analysis. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - GetNetworkInsightsAccessScopeContentResult: - type: object - properties: - networkInsightsAccessScopeContent: - allOf: - - $ref: '#/components/schemas/NetworkInsightsAccessScopeContent' - - description: The Network Access Scope content. - GetPasswordDataResult: - type: object - properties: - instanceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Windows instance. - passwordData: - allOf: - - $ref: '#/components/schemas/String' - - description: The password of the instance. Returns an empty string if the password is not available. - timestamp: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The time the data was last updated. - GetReservedInstancesExchangeQuoteResult: - type: object - properties: - currencyCode: - allOf: - - $ref: '#/components/schemas/String' - - description: The currency of the transaction. - isValidExchange: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'If true, the exchange is valid. If false, the exchange cannot be completed.' - outputReservedInstancesWillExpireAt: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The new end date of the reservation term. - paymentDue: - allOf: - - $ref: '#/components/schemas/String' - - description: The total true upfront charge for the exchange. - reservedInstanceValueRollup: - allOf: - - $ref: '#/components/schemas/ReservationValue' - - description: The cost associated with the Reserved Instance. - reservedInstanceValueSet: - allOf: - - $ref: '#/components/schemas/ReservedInstanceReservationValueSet' - - description: The configuration of your Convertible Reserved Instances. - targetConfigurationValueRollup: - allOf: - - $ref: '#/components/schemas/ReservationValue' - - description: The cost associated with the Reserved Instance. - targetConfigurationValueSet: - allOf: - - $ref: '#/components/schemas/TargetReservationValueSet' - - description: The values of the target Convertible Reserved Instances. - validationFailureReason: - allOf: - - $ref: '#/components/schemas/String' - - description: Describes the reason why the exchange cannot be completed. - description: Contains the output of GetReservedInstancesExchangeQuote. - GetSerialConsoleAccessStatusResult: - type: object - properties: - serialConsoleAccessEnabled: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'If true, access to the EC2 serial console of all instances is enabled for your account. If false, access to the EC2 serial console of all instances is disabled for your account.' - GetSpotPlacementScoresResult: - type: object - properties: - spotPlacementScoreSet: - allOf: - - $ref: '#/components/schemas/SpotPlacementScores' - - description: '

The Spot placement score for the top 10 Regions or Availability Zones, scored on a scale from 1 to 10. Each score
 reflects how likely it is that each Region or Availability Zone will succeed at fulfilling the specified target capacity
 at the time of the Spot placement score request. A score of 10 means that your Spot capacity request is highly likely to succeed in that Region or Availability Zone.

If you request a Spot placement score for Regions, a high score assumes that your fleet request will be configured to use all Availability Zones and the capacity-optimized allocation strategy. If you request a Spot placement score for Availability Zones, a high score assumes that your fleet request will be configured to use a single Availability Zone and the capacity-optimized allocation strategy.

Different
 Regions or Availability Zones might return the same score.

The Spot placement score serves as a recommendation only. No score guarantees that your Spot request will be fully or partially fulfilled.

' - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token for the next set of results. - ArchitectureTypeSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/ArchitectureType' - - xml: - name: item - minItems: 0 - maxItems: 3 - InstanceRequirementsRequest: - type: object - required: - - VCpuCount - - MemoryMiB - properties: - undefined: - allOf: - - $ref: '#/components/schemas/MemoryMiBRequest' - - description: 'The minimum and maximum amount of memory, in MiB.' - CpuManufacturer: - allOf: - - $ref: '#/components/schemas/MemoryGiBPerVCpuRequest' - - description: '

The minimum and maximum amount of memory per vCPU, in GiB.

Default: No minimum or maximum limits

' - ExcludedInstanceType: - allOf: - - $ref: '#/components/schemas/ExcludedInstanceTypeSet' - - description: '

The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk (*), to exclude an instance family, type, size, or generation. The following are examples: m5.8xlarge, c5*.*, m5a.*, r*, *3*.

For example, if you specify c5*,Amazon EC2 will exclude the entire C5 instance family, which includes all C5a and C5n instance types. If you specify m5a.*, Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types.

Default: No excluded instance types

' - InstanceGeneration: - allOf: - - $ref: '#/components/schemas/LocalStorage' - - description: '

Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, Amazon EC2 instance store in the Amazon EC2 User Guide.

  • To include instance types with instance store volumes, specify included.

  • To require only instance types with instance store volumes, specify required.

  • To exclude instance types with instance store volumes, specify excluded.

Default: included

' - LocalStorageType: - allOf: - - $ref: '#/components/schemas/BaselineEbsBandwidthMbpsRequest' - - description: '

The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see Amazon EBS–optimized instances in the Amazon EC2 User Guide.

Default: No minimum or maximum limits

' - AcceleratorType: - allOf: - - $ref: '#/components/schemas/AcceleratorCountRequest' - - description: '

The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on an instance.

To exclude accelerator-enabled instance types, set Max to 0.

Default: No minimum or maximum limits

' - AcceleratorManufacturer: - allOf: - - $ref: '#/components/schemas/AcceleratorManufacturerSet' - - description: '

Indicates whether instance types must have accelerators by specific manufacturers.

  • For instance types with NVIDIA devices, specify nvidia.

  • For instance types with AMD devices, specify amd.

  • For instance types with Amazon Web Services devices, specify amazon-web-services.

  • For instance types with Xilinx devices, specify xilinx.

Default: Any manufacturer

' - AcceleratorName: - allOf: - - $ref: '#/components/schemas/AcceleratorTotalMemoryMiBRequest' - - description: '

The minimum and maximum amount of total accelerator memory, in MiB.

Default: No minimum or maximum limits

' - description: '

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.

When you specify multiple parameters, you get instance types that satisfy all of the specified parameters. If you specify multiple values for a parameter, you get instance types that satisfy any of the specified values.

You must specify VCpuCount and MemoryMiB. All other parameters are optional. Any unspecified optional parameter is set to its default.

For more information, see Attribute-based instance type selection for EC2 Fleet, Attribute-based instance type selection for Spot Fleet, and Spot placement score in the Amazon EC2 User Guide.

' - GetSubnetCidrReservationsResult: - type: object - properties: - subnetIpv4CidrReservationSet: - allOf: - - $ref: '#/components/schemas/SubnetCidrReservationList' - - description: Information about the IPv4 subnet CIDR reservations. - subnetIpv6CidrReservationSet: - allOf: - - $ref: '#/components/schemas/SubnetCidrReservationList' - - description: Information about the IPv6 subnet CIDR reservations. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - GetTransitGatewayAttachmentPropagationsResult: - type: object - properties: - transitGatewayAttachmentPropagations: - allOf: - - $ref: '#/components/schemas/TransitGatewayAttachmentPropagationList' - - description: Information about the propagation route tables. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - GetTransitGatewayMulticastDomainAssociationsResult: - type: object - properties: - multicastDomainAssociations: - allOf: - - $ref: '#/components/schemas/TransitGatewayMulticastDomainAssociationList' - - description: Information about the multicast domain associations. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - GetTransitGatewayPrefixListReferencesResult: - type: object - properties: - transitGatewayPrefixListReferenceSet: - allOf: - - $ref: '#/components/schemas/TransitGatewayPrefixListReferenceSet' - - description: Information about the prefix list references. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - GetTransitGatewayRouteTableAssociationsResult: - type: object - properties: - associations: - allOf: - - $ref: '#/components/schemas/TransitGatewayRouteTableAssociationList' - - description: Information about the associations. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - GetTransitGatewayRouteTablePropagationsResult: - type: object - properties: - transitGatewayRouteTablePropagations: - allOf: - - $ref: '#/components/schemas/TransitGatewayRouteTablePropagationList' - - description: Information about the route table propagations. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - GetVpnConnectionDeviceSampleConfigurationResult: - type: object - properties: - vpnConnectionDeviceSampleConfiguration: - allOf: - - $ref: '#/components/schemas/VpnConnectionDeviceSampleConfiguration' - - description: Sample configuration file for the specified customer gateway device. - GetVpnConnectionDeviceTypesResult: - type: object - properties: - vpnConnectionDeviceTypeSet: - allOf: - - $ref: '#/components/schemas/VpnConnectionDeviceTypeList' - - description: List of customer gateway devices that have a sample configuration file available for use. - nextToken: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: 'The NextToken value to include in a future GetVpnConnectionDeviceTypes request. When the results of a GetVpnConnectionDeviceTypes request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.' - ImportClientVpnClientCertificateRevocationListResult: - type: object - properties: - return: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Returns true if the request succeeds; otherwise, it returns an error.' - ImportImageResult: - type: object - properties: - architecture: - allOf: - - $ref: '#/components/schemas/String' - - description: The architecture of the virtual machine. - description: - allOf: - - $ref: '#/components/schemas/String' - - description: A description of the import task. - encrypted: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether the AMI is encrypted. - hypervisor: - allOf: - - $ref: '#/components/schemas/String' - - description: The target hypervisor of the import task. - imageId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Amazon Machine Image (AMI) created by the import task. - importTaskId: - allOf: - - $ref: '#/components/schemas/ImportImageTaskId' - - description: The task ID of the import image task. - kmsKeyId: - allOf: - - $ref: '#/components/schemas/KmsKeyId' - - description: The identifier for the symmetric KMS key that was used to create the encrypted AMI. - licenseType: - allOf: - - $ref: '#/components/schemas/String' - - description: The license type of the virtual machine. - platform: - allOf: - - $ref: '#/components/schemas/String' - - description: The operating system of the virtual machine. - progress: - allOf: - - $ref: '#/components/schemas/String' - - description: The progress of the task. - snapshotDetailSet: - allOf: - - $ref: '#/components/schemas/SnapshotDetailList' - - description: Information about the snapshots. - status: - allOf: - - $ref: '#/components/schemas/String' - - description: A brief status of the task. - statusMessage: - allOf: - - $ref: '#/components/schemas/String' - - description: A detailed status message of the import task. - licenseSpecifications: - allOf: - - $ref: '#/components/schemas/ImportImageLicenseSpecificationListResponse' - - description: The ARNs of the license configurations. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: Any tags assigned to the import image task. - usageOperation: - allOf: - - $ref: '#/components/schemas/String' - - description: The usage operation value. - ImageDiskContainer: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/UserBucket' - - description: The S3 bucket for the disk image. - description: Describes the disk container object for an import image task. - ImportImageLicenseConfigurationRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The ARN of a license configuration. - description: The request information of license configurations. - ImportInstanceResult: - type: object - properties: - conversionTask: - allOf: - - $ref: '#/components/schemas/ConversionTask' - - description: Information about the conversion task. - DiskImage: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/VolumeDetail' - - description: Information about the volume. - description: Describes a disk image. - ArchitectureValues: - type: string - enum: - - i386 - - x86_64 - - arm64 - - x86_64_mac - SecurityGroupStringList: - type: array - items: - allOf: - - $ref: '#/components/schemas/SecurityGroupName' - - xml: - name: SecurityGroup - ShutdownBehavior: - type: string - enum: - - stop - - terminate - Placement: - type: object - properties: - availabilityZone: - allOf: - - $ref: '#/components/schemas/String' - - description: '

The Availability Zone of the instance.

If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region.

This parameter is not supported by CreateFleet.

' - affinity: - allOf: - - $ref: '#/components/schemas/String' - - description: '

The affinity setting for the instance on the Dedicated Host. This parameter is not supported for the ImportInstance command.

This parameter is not supported by CreateFleet.

' - groupName: - allOf: - - $ref: '#/components/schemas/PlacementGroupName' - - description: The name of the placement group the instance is in. - partitionNumber: - allOf: - - $ref: '#/components/schemas/Integer' - - description: '

The number of the partition that the instance is in. Valid only if the placement group strategy is set to partition.

This parameter is not supported by CreateFleet.

' - hostId: - allOf: - - $ref: '#/components/schemas/String' - - description: '

The ID of the Dedicated Host on which the instance resides. This parameter is not supported for the ImportInstance command.

This parameter is not supported by CreateFleet.

' - tenancy: - allOf: - - $ref: '#/components/schemas/Tenancy' - - description: '

The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for the ImportInstance command.

This parameter is not supported by CreateFleet.

T3 instances that use the unlimited CPU credit option do not support host tenancy.

' - spreadDomain: - allOf: - - $ref: '#/components/schemas/String' - - description: '

Reserved for future use.

This parameter is not supported by CreateFleet.

' - hostResourceGroupArn: - allOf: - - $ref: '#/components/schemas/String' - - description: '

The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host.

This parameter is not supported by CreateFleet.

' - description: Describes the placement of an instance. - UserData: - type: object - properties: - data: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The user data. If you are using an Amazon Web Services SDK or command line tool, Base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide Base64-encoded text.' - description: Describes the user data for an instance. - ImportKeyPairResult: - type: object - properties: - keyFingerprint: - allOf: - - $ref: '#/components/schemas/String' - - description: '

  • For RSA key pairs, the key fingerprint is the MD5 public key fingerprint as specified in section 4 of RFC 4716.

  • For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8.

' - keyName: - allOf: - - $ref: '#/components/schemas/String' - - description: The key pair name that you provided. - keyPairId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the resulting key pair. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: The tags applied to the imported key pair. - ImportSnapshotResult: - type: object - properties: - description: - allOf: - - $ref: '#/components/schemas/String' - - description: A description of the import snapshot task. - importTaskId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the import snapshot task. - snapshotTaskDetail: - allOf: - - $ref: '#/components/schemas/SnapshotTaskDetail' - - description: Information about the import snapshot task. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: Any tags assigned to the import snapshot task. - UserBucket: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The file name of the disk image. - description: Describes the Amazon S3 bucket for the disk image. - ImportVolumeResult: - type: object - properties: - conversionTask: - allOf: - - $ref: '#/components/schemas/ConversionTask' - - description: Information about the conversion task. - ListImagesInRecycleBinResult: - type: object - properties: - imageSet: - allOf: - - $ref: '#/components/schemas/ImageRecycleBinInfoList' - - description: Information about the AMIs. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - ListSnapshotsInRecycleBinResult: - type: object - properties: - snapshotSet: - allOf: - - $ref: '#/components/schemas/SnapshotRecycleBinInfoList' - - description: Information about the snapshots. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - ModifyAddressAttributeResult: - type: object - properties: - address: - allOf: - - $ref: '#/components/schemas/AddressAttribute' - - description: Information about the Elastic IP address. - ModifyAvailabilityZoneGroupResult: - type: object - properties: - return: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Is true if the request succeeds, and an error otherwise.' - ModifyCapacityReservationResult: - type: object - properties: - return: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Returns true if the request succeeds; otherwise, it returns an error.' - ModifyCapacityReservationFleetResult: - type: object - properties: - return: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Returns true if the request succeeds; otherwise, it returns an error.' - ModifyClientVpnEndpointResult: - type: object - properties: - return: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Returns true if the request succeeds; otherwise, it returns an error.' - ModifyDefaultCreditSpecificationResult: - type: object - properties: - instanceFamilyCreditSpecification: - allOf: - - $ref: '#/components/schemas/InstanceFamilyCreditSpecification' - - description: The default credit option for CPU usage of the instance family. - ModifyEbsDefaultKmsKeyIdResult: - type: object - properties: - kmsKeyId: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Resource Name (ARN) of the default KMS key for encryption by default. - ModifyFleetResult: - type: object - properties: - return: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'If the request succeeds, the response returns true. If the request fails, no response is returned, and instead an error message is returned.' - ModifyFpgaImageAttributeResult: - type: object - properties: - fpgaImageAttribute: - allOf: - - $ref: '#/components/schemas/FpgaImageAttribute' - - description: Information about the attribute. - LoadPermissionListRequest: - type: array - items: - allOf: - - $ref: '#/components/schemas/LoadPermissionRequest' - - xml: - name: item - ModifyHostsResult: - type: object - properties: - successful: - allOf: - - $ref: '#/components/schemas/ResponseHostIdList' - - description: The IDs of the Dedicated Hosts that were successfully modified. - unsuccessful: - allOf: - - $ref: '#/components/schemas/UnsuccessfulItemList' - - description: The IDs of the Dedicated Hosts that could not be modified. Check whether the setting you requested can be used. - LaunchPermissionList: - type: array - items: - allOf: - - $ref: '#/components/schemas/LaunchPermission' - - xml: - name: item - InstanceBlockDeviceMappingSpecification: - type: object - properties: - deviceName: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The device name (for example, /dev/sdh or xvdh).' - ebs: - allOf: - - $ref: '#/components/schemas/EbsInstanceBlockDeviceSpecification' - - description: Parameters used to automatically set up EBS volumes when the instance is launched. - noDevice: - allOf: - - $ref: '#/components/schemas/String' - - description: suppress the specified device included in the block device mapping. - virtualName: - allOf: - - $ref: '#/components/schemas/String' - - description: The virtual device name. - description: Describes a block device mapping entry. - Blob: - type: string - ModifyInstanceCapacityReservationAttributesResult: - type: object - properties: - return: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Returns true if the request succeeds; otherwise, it returns an error.' - CapacityReservationTarget: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The ARN of the Capacity Reservation resource group in which to run the instance. - description: Describes a target Capacity Reservation or Capacity Reservation group. - ModifyInstanceCreditSpecificationResult: - type: object - properties: - successfulInstanceCreditSpecificationSet: - allOf: - - $ref: '#/components/schemas/SuccessfulInstanceCreditSpecificationSet' - - description: Information about the instances whose credit option for CPU usage was successfully modified. - unsuccessfulInstanceCreditSpecificationSet: - allOf: - - $ref: '#/components/schemas/UnsuccessfulInstanceCreditSpecificationSet' - - description: Information about the instances whose credit option for CPU usage was not modified. - InstanceCreditSpecificationRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description:

The credit option for CPU usage of the instance. Valid values are standard and unlimited.

T3 instances with host tenancy do not support the unlimited CPU credit option.

- description: Describes the credit option for CPU usage of a burstable performance instance. - ModifyInstanceEventStartTimeResult: - type: object - properties: - event: - $ref: '#/components/schemas/InstanceStatusEvent' - ModifyInstanceEventWindowResult: - type: object - properties: - instanceEventWindow: - allOf: - - $ref: '#/components/schemas/InstanceEventWindow' - - description: Information about the event window. - ModifyInstanceMaintenanceOptionsResult: - type: object - properties: - instanceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the instance. - autoRecovery: - allOf: - - $ref: '#/components/schemas/InstanceAutoRecoveryState' - - description: Provides information on the current automatic recovery behavior of your instance. - ModifyInstanceMetadataOptionsResult: - type: object - properties: - instanceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the instance. - instanceMetadataOptions: - allOf: - - $ref: '#/components/schemas/InstanceMetadataOptionsResponse' - - description: The metadata options for the instance. - ModifyInstancePlacementResult: - type: object - properties: - return: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Is true if the request succeeds, and an error otherwise.' - ModifyIpamResult: - type: object - properties: - ipam: - allOf: - - $ref: '#/components/schemas/Ipam' - - description: The results of the modification. - RemoveIpamOperatingRegion: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of the operating Region you want to remove. - description: '

Remove an operating Region from an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide

' - ModifyIpamPoolResult: - type: object - properties: - ipamPool: - allOf: - - $ref: '#/components/schemas/IpamPool' - - description: The results of the modification. - ModifyIpamResourceCidrResult: - type: object - properties: - ipamResourceCidr: - $ref: '#/components/schemas/IpamResourceCidr' - ModifyIpamScopeResult: - type: object - properties: - ipamScope: - allOf: - - $ref: '#/components/schemas/IpamScope' - - description: The results of the modification. - ModifyLaunchTemplateResult: - type: object - example: - LaunchTemplate: - CreateTime: '2017-12-01T13:35:46.000Z' - CreatedBy: 'arn:aws:iam::123456789012:root' - DefaultVersionNumber: 2 - LatestVersionNumber: 2 - LaunchTemplateId: lt-0abcd290751193123 - LaunchTemplateName: WebServers - properties: - launchTemplate: - allOf: - - $ref: '#/components/schemas/LaunchTemplate' - - description: Information about the launch template. - ModifyManagedPrefixListResult: - type: object - properties: - prefixList: - allOf: - - $ref: '#/components/schemas/ManagedPrefixList' - - description: Information about the prefix list. - RemovePrefixListEntry: - type: object - required: - - Cidr - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The CIDR block. - description: An entry for a prefix list. - NetworkInterfaceAttachmentId: - type: string - ModifyPrivateDnsNameOptionsResult: - type: object - properties: - return: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Returns true if the request succeeds; otherwise, it returns an error.' - ModifyReservedInstancesResult: - type: object - properties: - reservedInstancesModificationId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID for the modification. - description: Contains the output of ModifyReservedInstances. - ReservedInstancesConfiguration: - type: object - properties: - availabilityZone: - allOf: - - $ref: '#/components/schemas/String' - - description: The Availability Zone for the modified Reserved Instances. - instanceCount: - allOf: - - $ref: '#/components/schemas/Integer' - - description:

The number of modified Reserved Instances.

This is a required field for a request.

 - instanceType: - allOf: - - $ref: '#/components/schemas/InstanceType' - - description: The instance type for the modified Reserved Instances. - platform: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The network platform of the modified Reserved Instances, which is either EC2-Classic or EC2-VPC.' - scope: - allOf: - - $ref: '#/components/schemas/scope' - - description: Whether the Reserved Instance is applied to instances in a Region or instances in a specific Availability Zone. - description: Describes the configuration settings for the modified Reserved Instances. - ModifySecurityGroupRulesResult: - type: object - properties: - return: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Returns true if the request succeeds; otherwise, returns an error.' - SecurityGroupRuleUpdate: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/SecurityGroupRuleRequest' - - description: Information about the security group rule. - description: Describes an update to a security group rule. - CreateVolumePermissionList: - type: array - items: - allOf: - - $ref: '#/components/schemas/CreateVolumePermission' - - xml: - name: item - ModifySnapshotTierResult: - type: object - properties: - snapshotId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the snapshot. - tieringStartTime: - allOf: - - $ref: '#/components/schemas/MillisecondDateTime' - - description: The date and time when the archive process was started. - ModifySpotFleetRequestResponse: - type: object - example: - Return: true - properties: - return: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'If the request succeeds, the response returns true. If the request fails, no response is returned, and instead an error message is returned.' - description: Contains the output of ModifySpotFleetRequest. - LaunchTemplateConfig: - type: object - properties: - launchTemplateSpecification: - allOf: - - $ref: '#/components/schemas/FleetLaunchTemplateSpecification' - - description: The launch template. - overrides: - allOf: - - $ref: '#/components/schemas/LaunchTemplateOverridesList' - - description: Any parameters that you specify override the same parameters in the launch template. - description: Describes a launch template and overrides. - ModifyTrafficMirrorFilterNetworkServicesResult: - type: object - properties: - trafficMirrorFilter: - allOf: - - $ref: '#/components/schemas/TrafficMirrorFilter' - - description: The Traffic Mirror filter that the network service is associated with. - TrafficMirrorNetworkService: - type: string - enum: - - amazon-dns - ModifyTrafficMirrorFilterRuleResult: - type: object - properties: - trafficMirrorFilterRule: - allOf: - - $ref: '#/components/schemas/TrafficMirrorFilterRule' - - description: Modifies a Traffic Mirror rule. - TrafficMirrorFilterRuleField: - type: string - enum: - - destination-port-range - - source-port-range - - protocol - - description - ModifyTrafficMirrorSessionResult: - type: object - properties: - trafficMirrorSession: - allOf: - - $ref: '#/components/schemas/TrafficMirrorSession' - - description: Information about the Traffic Mirror session. - TrafficMirrorSessionField: - type: string - enum: - - packet-length - - description - - virtual-network-id - ModifyTransitGatewayResult: - type: object - properties: - transitGateway: - $ref: '#/components/schemas/TransitGateway' - ModifyTransitGatewayPrefixListReferenceResult: - type: object - properties: - transitGatewayPrefixListReference: - allOf: - - $ref: '#/components/schemas/TransitGatewayPrefixListReference' - - description: Information about the prefix list reference. - ModifyTransitGatewayVpcAttachmentResult: - type: object - properties: - transitGatewayVpcAttachment: - allOf: - - $ref: '#/components/schemas/TransitGatewayVpcAttachment' - - description: Information about the modified attachment. - ModifyVolumeResult: - type: object - properties: - volumeModification: - allOf: - - $ref: '#/components/schemas/VolumeModification' - - description: Information about the volume modification. - ModifyVpcEndpointResult: - type: object - properties: - return: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Returns true if the request succeeds; otherwise, it returns an error.' - ModifyVpcEndpointConnectionNotificationResult: - type: object - properties: - return: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Returns true if the request succeeds; otherwise, it returns an error.' - ModifyVpcEndpointServiceConfigurationResult: - type: object - properties: - return: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Returns true if the request succeeds; otherwise, it returns an error.' - ModifyVpcEndpointServicePayerResponsibilityResult: - type: object - properties: - return: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Returns true if the request succeeds; otherwise, it returns an error.' - ModifyVpcEndpointServicePermissionsResult: - type: object - properties: - return: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Returns true if the request succeeds; otherwise, it returns an error.' - ModifyVpcPeeringConnectionOptionsResult: - type: object - properties: - accepterPeeringConnectionOptions: - allOf: - - $ref: '#/components/schemas/PeeringConnectionOptions' - - description: Information about the VPC peering connection options for the accepter VPC. - requesterPeeringConnectionOptions: - allOf: - - $ref: '#/components/schemas/PeeringConnectionOptions' - - description: Information about the VPC peering connection options for the requester VPC. - ModifyVpcTenancyResult: - type: object - properties: - return: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Returns true if the request succeeds; otherwise, returns an error.' - ModifyVpnConnectionResult: - type: object - properties: - vpnConnection: - $ref: '#/components/schemas/VpnConnection' - ModifyVpnConnectionOptionsResult: - type: object - properties: - vpnConnection: - $ref: '#/components/schemas/VpnConnection' - ModifyVpnTunnelCertificateResult: - type: object - properties: - vpnConnection: - $ref: '#/components/schemas/VpnConnection' - ModifyVpnTunnelOptionsResult: - type: object - properties: - vpnConnection: - $ref: '#/components/schemas/VpnConnection' - Phase1EncryptionAlgorithmsRequestList: - type: array - items: - allOf: - - $ref: '#/components/schemas/Phase1EncryptionAlgorithmsRequestListValue' - - xml: - name: item - Phase2EncryptionAlgorithmsRequestList: - type: array - items: - allOf: - - $ref: '#/components/schemas/Phase2EncryptionAlgorithmsRequestListValue' - - xml: - name: item - Phase1IntegrityAlgorithmsRequestList: - type: array - items: - allOf: - - $ref: '#/components/schemas/Phase1IntegrityAlgorithmsRequestListValue' - - xml: - name: item - Phase2IntegrityAlgorithmsRequestList: - type: array - items: - allOf: - - $ref: '#/components/schemas/Phase2IntegrityAlgorithmsRequestListValue' - - xml: - name: item - Phase1DHGroupNumbersRequestList: - type: array - items: - allOf: - - $ref: '#/components/schemas/Phase1DHGroupNumbersRequestListValue' - - xml: - name: item - Phase2DHGroupNumbersRequestList: - type: array - items: - allOf: - - $ref: '#/components/schemas/Phase2DHGroupNumbersRequestListValue' - - xml: - name: item - MonitorInstancesResult: - type: object - properties: - instancesSet: - allOf: - - $ref: '#/components/schemas/InstanceMonitoringList' - - description: The monitoring information. - MoveAddressToVpcResult: - type: object - example: - Status: MoveInProgress - properties: - allocationId: - allOf: - - $ref: '#/components/schemas/String' - - description: The allocation ID for the Elastic IP address. - status: - allOf: - - $ref: '#/components/schemas/Status' - - description: The status of the move of the IP address. - MoveByoipCidrToIpamResult: - type: object - properties: - byoipCidr: - $ref: '#/components/schemas/ByoipCidr' - ProvisionByoipCidrResult: - type: object - properties: - byoipCidr: - allOf: - - $ref: '#/components/schemas/ByoipCidr' - - description: Information about the address range. - ProvisionIpamPoolCidrResult: - type: object - properties: - ipamPoolCidr: - allOf: - - $ref: '#/components/schemas/IpamPoolCidr' - - description: Information about the provisioned CIDR. - ProvisionPublicIpv4PoolCidrResult: - type: object - properties: - poolId: - allOf: - - $ref: '#/components/schemas/Ipv4PoolEc2Id' - - description: The ID of the pool that you want to provision the CIDR to. - poolAddressRange: - $ref: '#/components/schemas/PublicIpv4PoolRange' - PurchaseHostReservationResult: - type: object - properties: - clientToken: - allOf: - - $ref: '#/components/schemas/String' - - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.' - currencyCode: - allOf: - - $ref: '#/components/schemas/CurrencyCodeValues' - - description: 'The currency in which the totalUpfrontPrice and totalHourlyPrice amounts are specified. At this time, the only supported currency is USD.' - purchase: - allOf: - - $ref: '#/components/schemas/PurchaseSet' - - description: Describes the details of the purchase. - totalHourlyPrice: - allOf: - - $ref: '#/components/schemas/String' - - description: The total hourly price of the reservation calculated per hour. - totalUpfrontPrice: - allOf: - - $ref: '#/components/schemas/String' - - description: The total amount charged to your account when you purchase the reservation. - PurchaseReservedInstancesOfferingResult: - type: object - properties: - reservedInstancesId: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The IDs of the purchased Reserved Instances. If your purchase crosses into a discounted pricing tier, the final Reserved Instances IDs might change. For more information, see Crossing pricing tiers in the Amazon Elastic Compute Cloud User Guide.' - description: Contains the output of PurchaseReservedInstancesOffering. - Double: - type: number - format: double - CurrencyCodeValues: - type: string - enum: - - USD - PurchaseScheduledInstancesResult: - type: object - example: - ScheduledInstanceSet: - - AvailabilityZone: us-west-2b - CreateDate: '2016-01-25T21:43:38.612Z' - HourlyPrice: '0.095' - InstanceCount: 1 - InstanceType: c4.large - NetworkPlatform: EC2-VPC - NextSlotStartTime: '2016-01-31T09:00:00Z' - Platform: Linux/UNIX - Recurrence: - Frequency: Weekly - Interval: 1 - OccurrenceDaySet: - - 1 - OccurrenceRelativeToEnd: false - OccurrenceUnit: '' - ScheduledInstanceId: sci-1234-1234-1234-1234-123456789012 - SlotDurationInHours: 32 - TermEndDate: '2017-01-31T09:00:00Z' - TermStartDate: '2016-01-31T09:00:00Z' - TotalScheduledInstanceHours: 1696 - properties: - scheduledInstanceSet: - allOf: - - $ref: '#/components/schemas/PurchasedScheduledInstanceSet' - - description: Information about the Scheduled Instances. - description: Contains the output of PurchaseScheduledInstances. - PurchaseRequest: - type: object - required: - - InstanceCount - - PurchaseToken - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The purchase token. - description: Describes a request to purchase Scheduled Instances. - RegisterImageResult: - type: object - properties: - imageId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the newly registered AMI. - description: Contains the output of RegisterImage. - RegisterInstanceEventNotificationAttributesResult: - type: object - properties: - instanceTagAttribute: - allOf: - - $ref: '#/components/schemas/InstanceTagNotificationAttribute' - - description: The resulting set of tag keys. - RegisterTransitGatewayMulticastGroupMembersResult: - type: object - properties: - registeredMulticastGroupMembers: - allOf: - - $ref: '#/components/schemas/TransitGatewayMulticastRegisteredGroupMembers' - - description: Information about the registered transit gateway multicast group members. - RegisterTransitGatewayMulticastGroupSourcesResult: - type: object - properties: - registeredMulticastGroupSources: - allOf: - - $ref: '#/components/schemas/TransitGatewayMulticastRegisteredGroupSources' - - description: Information about the transit gateway multicast group sources. - RejectTransitGatewayMulticastDomainAssociationsResult: - type: object - properties: - associations: - $ref: '#/components/schemas/TransitGatewayMulticastDomainAssociations' - RejectTransitGatewayPeeringAttachmentResult: - type: object - properties: - transitGatewayPeeringAttachment: - allOf: - - $ref: '#/components/schemas/TransitGatewayPeeringAttachment' - - description: The transit gateway peering attachment. - RejectTransitGatewayVpcAttachmentResult: - type: object - properties: - transitGatewayVpcAttachment: - allOf: - - $ref: '#/components/schemas/TransitGatewayVpcAttachment' - - description: Information about the attachment. - RejectVpcEndpointConnectionsResult: - type: object - properties: - unsuccessful: - allOf: - - $ref: '#/components/schemas/UnsuccessfulItemSet' - - description: 'Information about the endpoints that were not rejected, if applicable.' - RejectVpcPeeringConnectionResult: - type: object - properties: - return: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Returns true if the request succeeds; otherwise, it returns an error.' - ReleaseHostsResult: - type: object - properties: - successful: - allOf: - - $ref: '#/components/schemas/ResponseHostIdList' - - description: The IDs of the Dedicated Hosts that were successfully released. - unsuccessful: - allOf: - - $ref: '#/components/schemas/UnsuccessfulItemList' - - description: 'The IDs of the Dedicated Hosts that could not be released, including an error message.' - ReleaseIpamPoolAllocationResult: - type: object - properties: - success: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates if the release was successful. - ReplaceIamInstanceProfileAssociationResult: - type: object - properties: - iamInstanceProfileAssociation: - allOf: - - $ref: '#/components/schemas/IamInstanceProfileAssociation' - - description: Information about the IAM instance profile association. - ReplaceNetworkAclAssociationResult: - type: object - example: - NewAssociationId: aclassoc-3999875b - properties: - newAssociationId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the new association. - ReplaceRouteTableAssociationResult: - type: object - example: - NewAssociationId: rtbassoc-3a1f0f58 - properties: - newAssociationId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the new association. - associationState: - allOf: - - $ref: '#/components/schemas/RouteTableAssociationState' - - description: The state of the association. - ReplaceTransitGatewayRouteResult: - type: object - properties: - route: - allOf: - - $ref: '#/components/schemas/TransitGatewayRoute' - - description: Information about the modified route. - ReportInstanceReasonCodes: - type: string - enum: - - instance-stuck-in-state - - unresponsive - - not-accepting-credentials - - password-not-available - - performance-network - - performance-instance-store - - performance-ebs-volume - - performance-other - - other - RequestSpotFleetResponse: - type: object - example: - SpotFleetRequestId: sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE - properties: - spotFleetRequestId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Spot Fleet request. - description: Contains the output of RequestSpotFleet. - AllocationStrategy: - type: string - enum: - - lowestPrice - - diversified - - capacityOptimized - - capacityOptimizedPrioritized - OnDemandAllocationStrategy: - type: string - enum: - - lowestPrice - - prioritized - SpotMaintenanceStrategies: - type: object - properties: - capacityRebalance: - allOf: - - $ref: '#/components/schemas/SpotCapacityRebalance' - - description: 'The Spot Instance replacement strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an elevated risk of being interrupted. For more information, see Capacity rebalancing in the Amazon EC2 User Guide for Linux Instances.' - description: The strategies for managing your Spot Instances that are at an elevated risk of being interrupted. - ExcessCapacityTerminationPolicy: - type: string - enum: - - noTermination - - default - LaunchSpecsList: - type: array - items: - allOf: - - $ref: '#/components/schemas/SpotFleetLaunchSpecification' - - xml: - name: item - LaunchTemplateConfigList: - type: array - items: - allOf: - - $ref: '#/components/schemas/LaunchTemplateConfig' - - xml: - name: item - FleetType: - type: string - enum: - - request - - maintain - - instant - InstanceInterruptionBehavior: - type: string - enum: - - hibernate - - stop - - terminate - LoadBalancersConfig: - type: object - properties: - classicLoadBalancersConfig: - allOf: - - $ref: '#/components/schemas/ClassicLoadBalancersConfig' - - description: The Classic Load Balancers. - targetGroupsConfig: - allOf: - - $ref: '#/components/schemas/TargetGroupsConfig' - - description: The target groups. - description: Describes the Classic Load Balancers and target groups to attach to a Spot Fleet request. - TagSpecificationList: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagSpecification' - - xml: - name: item - RequestSpotInstancesResult: - type: object - properties: - spotInstanceRequestSet: - allOf: - - $ref: '#/components/schemas/SpotInstanceRequestList' - - description: One or more Spot Instance requests. - description: Contains the output of RequestSpotInstances. - RequestSpotLaunchSpecificationSecurityGroupIdList: - type: array - items: - allOf: - - $ref: '#/components/schemas/SecurityGroupId' - - xml: - name: item - RequestSpotLaunchSpecificationSecurityGroupList: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - BlockDeviceMappingList: - type: array - items: - allOf: - - $ref: '#/components/schemas/BlockDeviceMapping' - - xml: - name: item - IamInstanceProfileSpecification: - type: object - properties: - arn: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Resource Name (ARN) of the instance profile. - name: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of the instance profile. - description: Describes an IAM instance profile. - KernelId: - type: string - RunInstancesMonitoringEnabled: - type: object - required: - - Enabled - properties: - enabled: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.' - description: Describes the monitoring of an instance. - InstanceNetworkInterfaceSpecificationList: - type: array - items: - allOf: - - $ref: '#/components/schemas/InstanceNetworkInterfaceSpecification' - - xml: - name: item - SpotPlacement: - type: object - properties: - availabilityZone: - allOf: - - $ref: '#/components/schemas/String' - - description: '

The Availability Zone.

[Spot Fleet only] To specify multiple Availability Zones, separate them using commas; for example, "us-west-2a, us-west-2b".

' - groupName: - allOf: - - $ref: '#/components/schemas/PlacementGroupName' - - description: The name of the placement group. - tenancy: - allOf: - - $ref: '#/components/schemas/Tenancy' - - description: The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for Spot Instances. - description: Describes Spot Instance placement. - RamdiskId: - type: string - ResetAddressAttributeResult: - type: object - properties: - address: - allOf: - - $ref: '#/components/schemas/AddressAttribute' - - description: Information about the IP address. - ResetEbsDefaultKmsKeyIdResult: - type: object - properties: - kmsKeyId: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Resource Name (ARN) of the default KMS key for EBS encryption by default. - ResetFpgaImageAttributeResult: - type: object - properties: - return: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Is true if the request succeeds, and an error otherwise.' - RestoreAddressToClassicResult: - type: object - example: - PublicIp: 198.51.100.0 - Status: MoveInProgress - properties: - publicIp: - allOf: - - $ref: '#/components/schemas/String' - - description: The Elastic IP address. - status: - allOf: - - $ref: '#/components/schemas/Status' - - description: The move status for the IP address. - RestoreImageFromRecycleBinResult: - type: object - properties: - return: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Returns true if the request succeeds; otherwise, it returns an error.' - RestoreManagedPrefixListVersionResult: - type: object - properties: - prefixList: - allOf: - - $ref: '#/components/schemas/ManagedPrefixList' - - description: Information about the prefix list. - RestoreSnapshotFromRecycleBinResult: - type: object - properties: - snapshotId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the snapshot. - outpostArn: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The ARN of the Outpost on which the snapshot is stored. For more information, see Amazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.' - description: - allOf: - - $ref: '#/components/schemas/String' - - description: The description for the snapshot. - encrypted: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether the snapshot is encrypted. - ownerId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Amazon Web Services account that owns the EBS snapshot. - progress: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The progress of the snapshot, as a percentage.' - startTime: - allOf: - - $ref: '#/components/schemas/MillisecondDateTime' - - description: The time stamp when the snapshot was initiated. - status: - allOf: - - $ref: '#/components/schemas/SnapshotState' - - description: The state of the snapshot. - volumeId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the volume that was used to create the snapshot. - volumeSize: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The size of the volume, in GiB.' - RestoreSnapshotTierResult: - type: object - properties: - snapshotId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the snapshot. - restoreStartTime: - allOf: - - $ref: '#/components/schemas/MillisecondDateTime' - - description: The date and time when the snapshot restore process started. - restoreDuration: - allOf: - - $ref: '#/components/schemas/Integer' - - description: For temporary restores only. The number of days for which the archived snapshot is temporarily restored. - isPermanentRestore: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether the snapshot is permanently restored. true indicates a permanent restore. false indicates a temporary restore. - RevokeClientVpnIngressResult: - type: object - properties: - status: - allOf: - - $ref: '#/components/schemas/ClientVpnAuthorizationRuleStatus' - - description: The current state of the authorization rule. - RevokeSecurityGroupEgressResult: - type: object - properties: - return: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Returns true if the request succeeds; otherwise, returns an error.' - unknownIpPermissionSet: - allOf: - - $ref: '#/components/schemas/IpPermissionList' - - description: 'The outbound rules that were unknown to the service. In some cases, unknownIpPermissionSet might be in a different format from the request parameter. ' - RevokeSecurityGroupIngressResult: - type: object - properties: - return: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Returns true if the request succeeds; otherwise, returns an error.' - unknownIpPermissionSet: - allOf: - - $ref: '#/components/schemas/IpPermissionList' - - description: 'The inbound rules that were unknown to the service. In some cases, unknownIpPermissionSet might be in a different format from the request parameter. ' - Reservation: - type: object - example: {} - properties: - groupSet: - allOf: - - $ref: '#/components/schemas/GroupIdentifierList' - - description: '[EC2-Classic only] The security groups.' - instancesSet: - allOf: - - $ref: '#/components/schemas/InstanceList' - - description: The instances. - ownerId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Amazon Web Services account that owns the reservation. - requesterId: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The ID of the requester that launched the instances on your behalf (for example, Amazon Web Services Management Console or Auto Scaling).' - reservationId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the reservation. - description: 'Describes a launch request for one or more instances, and includes owner, requester, and security group information that applies to all instances in the launch request.' - Tenancy: - type: string - enum: - - default - - dedicated - - host - InstanceNetworkInterfaceSpecification: - type: object - properties: - associatePublicIpAddress: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Indicates whether to assign a public IPv4 address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true.' - deleteOnTermination: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'If set to true, the interface is deleted when the instance is terminated. You can specify true only if creating a new network interface when launching an instance.' - description: - allOf: - - $ref: '#/components/schemas/String' - - description: The description of the network interface. Applies only if creating a network interface when launching an instance. - deviceIndex: - allOf: - - $ref: '#/components/schemas/Integer' - - description: '

The position of the network interface in the attachment order. A primary network interface has a device index of 0.

If you specify a network interface when launching an instance, you must specify the device index.

' - SecurityGroupId: - allOf: - - $ref: '#/components/schemas/SecurityGroupIdStringList' - - description: The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance. - ipv6AddressCount: - allOf: - - $ref: '#/components/schemas/Integer' - - description: A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses the IPv6 addresses from the range of the subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch. - ipv6AddressesSet: - allOf: - - $ref: '#/components/schemas/InstanceIpv6AddressList' - - description: One or more IPv6 addresses to assign to the network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch. - networkInterfaceId: - allOf: - - $ref: '#/components/schemas/NetworkInterfaceId' - - description: '

The ID of the network interface.

If you are creating a Spot Fleet, omit this parameter because you can’t specify a network interface ID in a launch specification.

' - privateIpAddress: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The private IPv4 address of the network interface. Applies only if creating a network interface when launching an instance. You cannot specify this option if you''re launching more than one instance in a RunInstances request.' - privateIpAddressesSet: - allOf: - - $ref: '#/components/schemas/PrivateIpAddressSpecificationList' - - description: 'One or more private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you''re launching more than one instance in a RunInstances request.' - secondaryPrivateIpAddressCount: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The number of secondary private IPv4 addresses. You can''t specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you''re launching more than one instance in a RunInstances request.' - subnetId: - allOf: - - $ref: '#/components/schemas/Integer' - - description: '

The index of the network card. Some instance types support multiple network cards. The primary network interface must be assigned to network card index 0. The default is network card index 0.

If you are using RequestSpotInstances to create Spot Instances, omit this parameter because you can’t specify the network card index when using this API. To specify the network card index, use RunInstances.

' - Ipv4Prefix: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The number of IPv4 delegated prefixes to be automatically assigned to the network interface. You cannot use this option if you use the Ipv4Prefix option. - Ipv6Prefix: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The number of IPv6 delegated prefixes to be automatically assigned to the network interface. You cannot use this option if you use the Ipv6Prefix option. - description: Describes a network interface. - ElasticGpuSpecification: - type: object - required: - - Type - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The type of Elastic Graphics accelerator. For more information about the values to specify for Type, see Elastic Graphics Basics, specifically the Elastic Graphics accelerator column, in the Amazon Elastic Compute Cloud User Guide for Windows Instances.' - description: A specification for an Elastic Graphics accelerator. - ElasticInferenceAccelerator: - type: object - required: - - Type - properties: - undefined: - allOf: - - $ref: '#/components/schemas/ElasticInferenceAcceleratorCount' - - description: '

The number of elastic inference accelerators to attach to the instance.

Default: 1

' - description: ' Describes an elastic inference accelerator. ' - SpotMarketOptions: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/InstanceInterruptionBehavior' - - description: The behavior when a Spot Instance is interrupted. The default is terminate. - description: The options for Spot Instances. - LicenseConfigurationRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Resource Name (ARN) of the license configuration. - description: Describes a license configuration. - InstanceMetadataTagsState: - type: string - enum: - - disabled - - enabled - InstanceAutoRecoveryState: - type: string - enum: - - disabled - - default - RunScheduledInstancesResult: - type: object - example: - InstanceIdSet: - - i-1234567890abcdef0 - properties: - instanceIdSet: - allOf: - - $ref: '#/components/schemas/InstanceIdSet' - - description: The IDs of the newly launched instances. - description: Contains the output of RunScheduledInstances. - ScheduledInstancesMonitoring: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether monitoring is enabled. - description: Describes whether monitoring is enabled for a Scheduled Instance. - SearchLocalGatewayRoutesResult: - type: object - properties: - routeSet: - allOf: - - $ref: '#/components/schemas/LocalGatewayRouteList' - - description: Information about the routes. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - SearchTransitGatewayMulticastGroupsResult: - type: object - properties: - multicastGroups: - allOf: - - $ref: '#/components/schemas/TransitGatewayMulticastGroupList' - - description: Information about the transit gateway multicast group. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. - SearchTransitGatewayRoutesResult: - type: object - properties: - routeSet: - allOf: - - $ref: '#/components/schemas/TransitGatewayRouteList' - - description: Information about the routes. - additionalRoutesAvailable: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether there are additional routes available. - StartInstancesResult: - type: object - example: - StartingInstances: - - CurrentState: - Code: 0 - Name: pending - InstanceId: i-1234567890abcdef0 - PreviousState: - Code: 80 - Name: stopped - properties: - instancesSet: - allOf: - - $ref: '#/components/schemas/InstanceStateChangeList' - - description: Information about the started instances. - StartNetworkInsightsAccessScopeAnalysisResult: - type: object - properties: - networkInsightsAccessScopeAnalysis: - allOf: - - $ref: '#/components/schemas/NetworkInsightsAccessScopeAnalysis' - - description: The Network Access Scope analysis. - StartNetworkInsightsAnalysisResult: - type: object - properties: - networkInsightsAnalysis: - allOf: - - $ref: '#/components/schemas/NetworkInsightsAnalysis' - - description: Information about the network insights analysis. - ResourceArn: - type: string - minLength: 1 - maxLength: 1283 - StartVpcEndpointServicePrivateDnsVerificationResult: - type: object - properties: - return: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Returns true if the request succeeds; otherwise, it returns an error.' - StopInstancesResult: - type: object - example: - StoppingInstances: - - CurrentState: - Code: 64 - Name: stopping - InstanceId: i-1234567890abcdef0 - PreviousState: - Code: 16 - Name: running - properties: - instancesSet: - allOf: - - $ref: '#/components/schemas/InstanceStateChangeList' - - description: Information about the stopped instances. - TerminateClientVpnConnectionsResult: - type: object - properties: - clientVpnEndpointId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Client VPN endpoint. - username: - allOf: - - $ref: '#/components/schemas/String' - - description: The user who established the terminated client connections. - connectionStatuses: - allOf: - - $ref: '#/components/schemas/TerminateConnectionStatusSet' - - description: The current state of the client connections. - TerminateInstancesResult: - type: object - example: - TerminatingInstances: - - CurrentState: - Code: 32 - Name: shutting-down - InstanceId: i-1234567890abcdef0 - PreviousState: - Code: 16 - Name: running - properties: - instancesSet: - allOf: - - $ref: '#/components/schemas/InstanceStateChangeList' - - description: Information about the terminated instances. - UnassignIpv6AddressesResult: - type: object - properties: - networkInterfaceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the network interface. - unassignedIpv6Addresses: - allOf: - - $ref: '#/components/schemas/Ipv6AddressList' - - description: The IPv6 addresses that have been unassigned from the network interface. - unassignedIpv6PrefixSet: - allOf: - - $ref: '#/components/schemas/IpPrefixList' - - description: The IPv4 prefixes that have been unassigned from the network interface. - UnmonitorInstancesResult: - type: object - properties: - instancesSet: - allOf: - - $ref: '#/components/schemas/InstanceMonitoringList' - - description: The monitoring information. - UpdateSecurityGroupRuleDescriptionsEgressResult: - type: object - example: {} - properties: - return: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Returns true if the request succeeds; otherwise, returns an error.' - SecurityGroupRuleDescription: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The description of the security group rule. - description:

Describes the description of a security group rule.

You can use this when you want to update the security group rule description for either an inbound or outbound rule.

- UpdateSecurityGroupRuleDescriptionsIngressResult: - type: object - example: {} - properties: - return: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Returns true if the request succeeds; otherwise, returns an error.' - WithdrawByoipCidrResult: - type: object - properties: - byoipCidr: - allOf: - - $ref: '#/components/schemas/ByoipCidr' - - description: Information about the address pool. - AcceleratorCount: - type: object - properties: - min: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The minimum number of accelerators. If this parameter is not specified, there is no minimum limit.' - max: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The maximum number of accelerators. If this parameter is not specified, there is no maximum limit.' - description: 'The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on an instance.' - AcceleratorManufacturer: - type: string - enum: - - nvidia - - amd - - amazon-web-services - - xilinx - AcceleratorName: - type: string - enum: - - a100 - - v100 - - k80 - - t4 - - m60 - - radeon-pro-v520 - - vu9p - AcceleratorNameSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/AcceleratorName' - - xml: - name: item - AcceleratorTotalMemoryMiB: - type: object - properties: - min: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The minimum amount of accelerator memory, in MiB. If this parameter is not specified, there is no minimum limit.' - max: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The maximum amount of accelerator memory, in MiB. If this parameter is not specified, there is no maximum limit.' - description: 'The minimum and maximum amount of total accelerator memory, in MiB.' - AcceleratorType: - type: string - enum: - - gpu - - fpga - - inference - AcceleratorTypeSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/AcceleratorType' - - xml: - name: item - ReservedInstanceIdSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/ReservationId' - - xml: - name: ReservedInstanceId - TargetConfigurationRequestSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/TargetConfigurationRequest' - - xml: - name: TargetConfigurationRequest - AcceptReservedInstancesExchangeQuoteRequest: - type: object - required: - - ReservedInstanceIds - title: AcceptReservedInstancesExchangeQuoteRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - ReservedInstanceId: - allOf: - - $ref: '#/components/schemas/ReservedInstanceIdSet' - - description: The IDs of the Convertible Reserved Instances to exchange for another Convertible Reserved Instance of the same or higher value. - TargetConfiguration: - allOf: - - $ref: '#/components/schemas/TargetConfigurationRequestSet' - - description: The configuration of the target Convertible Reserved Instance to exchange for your current Convertible Reserved Instances. - description: Contains the parameters for accepting the quote. - AcceptTransitGatewayMulticastDomainAssociationsRequest: - type: object - title: AcceptTransitGatewayMulticastDomainAssociationsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - TransitGatewayMulticastDomainAssociations: - type: object - properties: - transitGatewayMulticastDomainId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the transit gateway multicast domain. - transitGatewayAttachmentId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the transit gateway attachment. - resourceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the resource. - resourceType: - allOf: - - $ref: '#/components/schemas/TransitGatewayAttachmentResourceType' - - description: 'The type of resource, for example a VPC attachment.' - resourceOwnerId: - allOf: - - $ref: '#/components/schemas/String' - - description: ' The ID of the Amazon Web Services account that owns the resource.' - subnets: - allOf: - - $ref: '#/components/schemas/SubnetAssociationList' - - description: The subnets associated with the multicast domain. - description: Describes the multicast domain associations. - AcceptTransitGatewayPeeringAttachmentRequest: - type: object - required: - - TransitGatewayAttachmentId - title: AcceptTransitGatewayPeeringAttachmentRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - TransitGatewayPeeringAttachment: - type: object - properties: - transitGatewayAttachmentId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the transit gateway peering attachment. - requesterTgwInfo: - allOf: - - $ref: '#/components/schemas/PeeringTgwInfo' - - description: Information about the requester transit gateway. - accepterTgwInfo: - allOf: - - $ref: '#/components/schemas/PeeringTgwInfo' - - description: Information about the accepter transit gateway. - status: - allOf: - - $ref: '#/components/schemas/PeeringAttachmentStatus' - - description: The status of the transit gateway peering attachment. - state: - allOf: - - $ref: '#/components/schemas/TransitGatewayAttachmentState' - - description: The state of the transit gateway peering attachment. Note that the initiating state has been deprecated. - creationTime: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The time the transit gateway peering attachment was created. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: The tags for the transit gateway peering attachment. - description: Describes the transit gateway peering attachment. - AcceptTransitGatewayVpcAttachmentRequest: - type: object - required: - - TransitGatewayAttachmentId - title: AcceptTransitGatewayVpcAttachmentRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - TransitGatewayVpcAttachment: - type: object - properties: - transitGatewayAttachmentId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the attachment. - transitGatewayId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the transit gateway. - vpcId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the VPC. - vpcOwnerId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Amazon Web Services account that owns the VPC. - state: - allOf: - - $ref: '#/components/schemas/TransitGatewayAttachmentState' - - description: The state of the VPC attachment. Note that the initiating state has been deprecated. - subnetIds: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The IDs of the subnets. - creationTime: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The creation time. - options: - allOf: - - $ref: '#/components/schemas/TransitGatewayVpcAttachmentOptions' - - description: The VPC attachment options. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: The tags for the VPC attachment. - description: Describes a VPC attachment. - VpcEndpointIdList: - type: array - items: - allOf: - - $ref: '#/components/schemas/VpcEndpointId' - - xml: - name: item - AcceptVpcEndpointConnectionsRequest: - type: object - required: - - ServiceId - - VpcEndpointIds - title: AcceptVpcEndpointConnectionsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/VpcEndpointServiceId' - - description: The ID of the VPC endpoint service. - VpcEndpointId: - allOf: - - $ref: '#/components/schemas/VpcEndpointIdList' - - description: The IDs of one or more interface VPC endpoints. - UnsuccessfulItemSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/UnsuccessfulItem' - - xml: - name: item - AcceptVpcPeeringConnectionRequest: - type: object - title: AcceptVpcPeeringConnectionRequest - properties: - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - vpcPeeringConnectionId: - allOf: - - $ref: '#/components/schemas/VpcPeeringConnectionId' - - description: The ID of the VPC peering connection. You must specify this parameter in the request. - VpcPeeringConnection: - type: object - properties: - accepterVpcInfo: - allOf: - - $ref: '#/components/schemas/VpcPeeringConnectionVpcInfo' - - description: Information about the accepter VPC. CIDR block information is only returned when describing an active VPC peering connection. - expirationTime: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The time that an unaccepted VPC peering connection will expire. - requesterVpcInfo: - allOf: - - $ref: '#/components/schemas/VpcPeeringConnectionVpcInfo' - - description: Information about the requester VPC. CIDR block information is only returned when describing an active VPC peering connection. - status: - allOf: - - $ref: '#/components/schemas/VpcPeeringConnectionStateReason' - - description: The status of the VPC peering connection. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: Any tags assigned to the resource. - vpcPeeringConnectionId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the VPC peering connection. - description: Describes a VPC peering connection. - PathComponentList: - type: array - items: - allOf: - - $ref: '#/components/schemas/PathComponent' - - xml: - name: item - AccessScopeAnalysisFinding: - type: object - properties: - networkInsightsAccessScopeAnalysisId: - allOf: - - $ref: '#/components/schemas/NetworkInsightsAccessScopeAnalysisId' - - description: The ID of the Network Access Scope analysis. - networkInsightsAccessScopeId: - allOf: - - $ref: '#/components/schemas/NetworkInsightsAccessScopeId' - - description: The ID of the Network Access Scope. - findingId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the finding. - findingComponentSet: - allOf: - - $ref: '#/components/schemas/PathComponentList' - - description: The finding components. - description: Describes a finding for a Network Access Scope. - AccessScopeAnalysisFindingList: - type: array - items: - allOf: - - $ref: '#/components/schemas/AccessScopeAnalysisFinding' - - xml: - name: item - PathStatement: - type: object - properties: - packetHeaderStatement: - allOf: - - $ref: '#/components/schemas/PacketHeaderStatement' - - description: The packet header statement. - resourceStatement: - allOf: - - $ref: '#/components/schemas/ResourceStatement' - - description: The resource statement. - description: Describes a path statement. - ThroughResourcesStatementList: - type: array - items: - allOf: - - $ref: '#/components/schemas/ThroughResourcesStatement' - - xml: - name: item - AccessScopePath: - type: object - properties: - source: - allOf: - - $ref: '#/components/schemas/PathStatement' - - description: The source. - destination: - allOf: - - $ref: '#/components/schemas/PathStatement' - - description: The destination. - throughResourceSet: - allOf: - - $ref: '#/components/schemas/ThroughResourcesStatementList' - - description: The through resources. - description: Describes a path. - AccessScopePathList: - type: array - items: - allOf: - - $ref: '#/components/schemas/AccessScopePath' - - xml: - name: item - AccessScopePathListRequest: - type: array - items: - allOf: - - $ref: '#/components/schemas/AccessScopePathRequest' - - xml: - name: item - PathStatementRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/ResourceStatementRequest' - - description: The resource statement. - description: Describes a path statement. - ThroughResourcesStatementRequestList: - type: array - items: - allOf: - - $ref: '#/components/schemas/ThroughResourcesStatementRequest' - - xml: - name: item - AccountAttributeValueList: - type: array - items: - allOf: - - $ref: '#/components/schemas/AccountAttributeValue' - - xml: - name: item - AccountAttribute: - type: object - properties: - attributeName: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of the account attribute. - attributeValueSet: - allOf: - - $ref: '#/components/schemas/AccountAttributeValueList' - - description: The values for the account attribute. - description: Describes an account attribute. - AccountAttributeList: - type: array - items: - allOf: - - $ref: '#/components/schemas/AccountAttribute' - - xml: - name: item - AccountAttributeNameStringList: - type: array - items: - allOf: - - $ref: '#/components/schemas/AccountAttributeName' - - xml: - name: attributeName - AccountAttributeValue: - type: object - properties: - attributeValue: - allOf: - - $ref: '#/components/schemas/String' - - description: The value of the attribute. - description: Describes a value of an account attribute. - InstanceHealthStatus: - type: string - enum: - - healthy - - unhealthy - ActiveInstance: - type: object - properties: - instanceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the instance. - instanceType: - allOf: - - $ref: '#/components/schemas/String' - - description: The instance type. - spotInstanceRequestId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Spot Instance request. - instanceHealth: - allOf: - - $ref: '#/components/schemas/InstanceHealthStatus' - - description: 'The health status of the instance. If the status of either the instance status check or the system status check is impaired, the health status of the instance is unhealthy. Otherwise, the health status is healthy.' - description: Describes a running instance in a Spot Fleet. - ActiveInstanceSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/ActiveInstance' - - xml: - name: item - ActivityStatus: - type: string - enum: - - error - - pending_fulfillment - - pending_termination - - fulfilled - AddIpamOperatingRegionSet: - type: array - items: - $ref: '#/components/schemas/AddIpamOperatingRegion' - minItems: 0 - maxItems: 50 - AddPrefixListEntries: - type: array - items: - $ref: '#/components/schemas/AddPrefixListEntry' - minItems: 0 - maxItems: 100 - AnalysisComponent: - type: object - properties: - id: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the component. - arn: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Resource Name (ARN) of the component. - name: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of the analysis component. - description: Describes a path component. - AdditionalDetail: - type: object - properties: - additionalDetailType: - allOf: - - $ref: '#/components/schemas/String' - - description: The information type. - component: - allOf: - - $ref: '#/components/schemas/AnalysisComponent' - - description: The path component. - description: Describes an additional detail for a path analysis. - AdditionalDetailList: - type: array - items: - allOf: - - $ref: '#/components/schemas/AdditionalDetail' - - xml: - name: item - DomainType: - type: string - enum: - - vpc - - standard - Address: - type: object - properties: - instanceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the instance that the address is associated with (if any). - publicIp: - allOf: - - $ref: '#/components/schemas/String' - - description: The Elastic IP address. - allocationId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID representing the allocation of the address for use with EC2-VPC. - associationId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID representing the association of the address with an instance in a VPC. - domain: - allOf: - - $ref: '#/components/schemas/DomainType' - - description: Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or instances in a VPC (vpc). - networkInterfaceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the network interface. - networkInterfaceOwnerId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Amazon Web Services account that owns the network interface. - privateIpAddress: - allOf: - - $ref: '#/components/schemas/String' - - description: The private IP address associated with the Elastic IP address. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: Any tags assigned to the Elastic IP address. - publicIpv4Pool: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of an address pool. - networkBorderGroup: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses.' - customerOwnedIp: - allOf: - - $ref: '#/components/schemas/String' - - description: The customer-owned IP address. - customerOwnedIpv4Pool: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the customer-owned address pool. - carrierIp: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The carrier IP address associated. This option is only available for network interfaces which reside in a subnet in a Wavelength Zone (for example an EC2 instance). ' - description: 'Describes an Elastic IP address, or a carrier IP address.' - PublicIpAddress: - type: string - PtrUpdateStatus: - type: object - properties: - value: - allOf: - - $ref: '#/components/schemas/String' - - description: The value for the PTR record update. - status: - allOf: - - $ref: '#/components/schemas/String' - - description: The status of the PTR record update. - reason: - allOf: - - $ref: '#/components/schemas/String' - - description: The reason for the PTR record update. - description: The status of an updated pointer (PTR) record for an Elastic IP address. - AddressAttribute: - type: object - properties: - publicIp: - allOf: - - $ref: '#/components/schemas/PublicIpAddress' - - description: The public IP address. - allocationId: - allOf: - - $ref: '#/components/schemas/AllocationId' - - description: '[EC2-VPC] The allocation ID.' - ptrRecord: - allOf: - - $ref: '#/components/schemas/String' - - description: The pointer (PTR) record for the IP address. - ptrRecordUpdate: - allOf: - - $ref: '#/components/schemas/PtrUpdateStatus' - - description: The updated PTR record for the IP address. - description: The attributes associated with an Elastic IP address. - AddressAttributeName: - type: string - enum: - - domain-name - AddressFamily: - type: string - enum: - - ipv4 - - ipv6 - AddressList: - type: array - items: - allOf: - - $ref: '#/components/schemas/Address' - - xml: - name: item - AddressMaxResults: - type: integer - minimum: 1 - maximum: 1000 - AddressSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/AddressAttribute' - - xml: - name: item - AdvertiseByoipCidrRequest: - type: object - required: - - Cidr - title: AdvertiseByoipCidrRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - ByoipCidr: - type: object - properties: - cidr: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The address range, in CIDR notation.' - description: - allOf: - - $ref: '#/components/schemas/String' - - description: The description of the address range. - statusMessage: - allOf: - - $ref: '#/components/schemas/String' - - description: 'Upon success, contains the ID of the address pool. Otherwise, contains an error message.' - state: - allOf: - - $ref: '#/components/schemas/ByoipCidrState' - - description: The state of the address pool. - description: Information about an address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP). - Affinity: - type: string - enum: - - default - - host - AllocateAddressRequest: - type: object - title: AllocateAddressRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The ID of a customer-owned address pool. Use this parameter to let Amazon EC2 select an address from the address pool. Alternatively, specify a specific address from the address pool.' - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - TagSpecification: - allOf: - - $ref: '#/components/schemas/TagSpecificationList' - - description: The tags to assign to the Elastic IP address. - AutoPlacement: - type: string - enum: - - 'on' - - 'off' - AllocateHostsRequest: - type: object - required: - - AvailabilityZone - - Quantity - title: AllocateHostsRequest - properties: - autoPlacement: - allOf: - - $ref: '#/components/schemas/AutoPlacement' - - description: '

Indicates whether the host accepts any untargeted instance launches that match its instance type configuration, or if it only accepts Host tenancy instance launches that specify its unique host ID. For more information, see Understanding auto-placement and affinity in the Amazon EC2 User Guide.

Default: on

' - availabilityZone: - allOf: - - $ref: '#/components/schemas/String' - - description: The Availability Zone in which to allocate the Dedicated Host. - clientToken: - allOf: - - $ref: '#/components/schemas/String' - - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.' - instanceType: - allOf: - - $ref: '#/components/schemas/String' - - description: '

Specifies the instance family to be supported by the Dedicated Hosts. If you specify an instance family, the Dedicated Hosts support multiple instance types within that instance family.

If you want the Dedicated Hosts to support a specific instance type only, omit this parameter and specify InstanceType instead. You cannot specify InstanceFamily and InstanceType in the same request.

' - quantity: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The number of Dedicated Hosts to allocate to your account with these parameters. - TagSpecification: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which to allocate the Dedicated Host. - ResponseHostIdList: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - IpamPoolAllocationDisallowedCidrs: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - AllocateIpamPoolCidrRequest: - type: object - required: - - IpamPoolId - title: AllocateIpamPoolCidrRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: A preview of the next available CIDR in a pool. - DisallowedCidr: - allOf: - - $ref: '#/components/schemas/IpamPoolAllocationDisallowedCidrs' - - description: Exclude a particular CIDR range from being returned by the pool. - IpamPoolAllocation: - type: object - properties: - cidr: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The CIDR for the allocation. A CIDR is a representation of an IP address and its associated network mask (or netmask) and refers to a range of IP addresses. An IPv4 CIDR example is 10.24.34.0/23. An IPv6 CIDR example is 2001:DB8::/32.' - ipamPoolAllocationId: - allOf: - - $ref: '#/components/schemas/IpamPoolAllocationId' - - description: The ID of an allocation. - description: - allOf: - - $ref: '#/components/schemas/String' - - description: A description of the pool allocation. - resourceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the resource. - resourceType: - allOf: - - $ref: '#/components/schemas/IpamPoolAllocationResourceType' - - description: The type of the resource. - resourceRegion: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Web Services Region of the resource. - resourceOwner: - allOf: - - $ref: '#/components/schemas/String' - - description: The owner of the resource. - description: 'In IPAM, an allocation is a CIDR assignment from an IPAM pool to another resource or IPAM pool.' - AllocationIdList: - type: array - items: - allOf: - - $ref: '#/components/schemas/AllocationId' - - xml: - name: AllocationId - AllocationIds: - type: array - items: - allOf: - - $ref: '#/components/schemas/AllocationId' - - xml: - name: item - AllocationState: - type: string - enum: - - available - - under-assessment - - permanent-failure - - released - - released-permanent-failure - - pending - PrincipalType: - type: string - enum: - - All - - Service - - OrganizationUnit - - Account - - User - - Role - AllowedPrincipal: - type: object - properties: - principalType: - allOf: - - $ref: '#/components/schemas/PrincipalType' - - description: The type of principal. - principal: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Resource Name (ARN) of the principal. - description: Describes a principal. - AllowedPrincipalSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/AllowedPrincipal' - - xml: - name: item - AllowsMultipleInstanceTypes: - type: string - enum: - - 'on' - - 'off' - AlternatePathHint: - type: object - properties: - componentId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the component. - componentArn: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Resource Name (ARN) of the component. - description: Describes an potential intermediate component of a feasible path. - AlternatePathHintList: - type: array - items: - allOf: - - $ref: '#/components/schemas/AlternatePathHint' - - xml: - name: item - PortRange: - type: object - properties: - from: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The first port in the range. - to: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The last port in the range. - description: Describes a range of ports. - AnalysisAclRule: - type: object - properties: - cidr: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The IPv4 address range, in CIDR notation.' - egress: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether the rule is an outbound rule. - portRange: - allOf: - - $ref: '#/components/schemas/PortRange' - - description: The range of ports. - protocol: - allOf: - - $ref: '#/components/schemas/String' - - description: The protocol. - ruleAction: - allOf: - - $ref: '#/components/schemas/String' - - description: Indicates whether to allow or deny traffic that matches the rule. - ruleNumber: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The rule number. - description: Describes a network access control (ACL) rule. - AnalysisComponentList: - type: array - items: - allOf: - - $ref: '#/components/schemas/AnalysisComponent' - - xml: - name: item - Port: - type: integer - minimum: 1 - maximum: 65535 - AnalysisLoadBalancerListener: - type: object - properties: - loadBalancerPort: - allOf: - - $ref: '#/components/schemas/Port' - - description: The port on which the load balancer is listening. - instancePort: - allOf: - - $ref: '#/components/schemas/Port' - - description: '[Classic Load Balancers] The back-end port for the listener.' - description: Describes a load balancer listener. - IpAddress: - type: string - pattern: '^([0-9]{1,3}.){3}[0-9]{1,3}$' - minLength: 0 - maxLength: 15 - AnalysisLoadBalancerTarget: - type: object - properties: - address: - allOf: - - $ref: '#/components/schemas/IpAddress' - - description: The IP address. - availabilityZone: - allOf: - - $ref: '#/components/schemas/String' - - description: The Availability Zone. - instance: - allOf: - - $ref: '#/components/schemas/AnalysisComponent' - - description: Information about the instance. - port: - allOf: - - $ref: '#/components/schemas/Port' - - description: The port on which the target is listening. - description: Describes a load balancer target. - IpAddressList: - type: array - items: - allOf: - - $ref: '#/components/schemas/IpAddress' - - xml: - name: item - PortRangeList: - type: array - items: - allOf: - - $ref: '#/components/schemas/PortRange' - - xml: - name: item - AnalysisPacketHeader: - type: object - properties: - destinationAddressSet: - allOf: - - $ref: '#/components/schemas/IpAddressList' - - description: The destination addresses. - destinationPortRangeSet: - allOf: - - $ref: '#/components/schemas/PortRangeList' - - description: The destination port ranges. - protocol: - allOf: - - $ref: '#/components/schemas/String' - - description: The protocol. - sourceAddressSet: - allOf: - - $ref: '#/components/schemas/IpAddressList' - - description: The source addresses. - sourcePortRangeSet: - allOf: - - $ref: '#/components/schemas/PortRangeList' - - description: The source port ranges. - description: Describes a header. Reflects any changes made by a component as traffic passes through. The fields of an inbound header are null except for the first component of a path. - AnalysisRouteTableRoute: - type: object - properties: - destinationCidr: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The destination IPv4 address, in CIDR notation.' - destinationPrefixListId: - allOf: - - $ref: '#/components/schemas/String' - - description: The prefix of the Amazon Web Service. - egressOnlyInternetGatewayId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of an egress-only internet gateway. - gatewayId: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The ID of the gateway, such as an internet gateway or virtual private gateway.' - instanceId: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The ID of the instance, such as a NAT instance.' - natGatewayId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of a NAT gateway. - networkInterfaceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of a network interface. - origin: - allOf: - - $ref: '#/components/schemas/String' - - description: '

Describes how the route was created. The following are the possible values:

  • CreateRouteTable - The route was automatically created when the route table was created.

  • CreateRoute - The route was manually added to the route table.

  • EnableVgwRoutePropagation - The route was propagated by route propagation.

' - transitGatewayId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of a transit gateway. - vpcPeeringConnectionId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of a VPC peering connection. - description: Describes a route table route. - AnalysisSecurityGroupRule: - type: object - properties: - cidr: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The IPv4 address range, in CIDR notation.' - direction: - allOf: - - $ref: '#/components/schemas/String' - - description: '

The direction. The following are the possible values:

  • egress

  • ingress

' - securityGroupId: - allOf: - - $ref: '#/components/schemas/String' - - description: The security group ID. - portRange: - allOf: - - $ref: '#/components/schemas/PortRange' - - description: The port range. - prefixListId: - allOf: - - $ref: '#/components/schemas/String' - - description: The prefix list ID. - protocol: - allOf: - - $ref: '#/components/schemas/String' - - description: The protocol name. - description: Describes a security group rule. - AnalysisStatus: - type: string - enum: - - running - - succeeded - - failed - ApplySecurityGroupsToClientVpnTargetNetworkRequest: - type: object - required: - - ClientVpnEndpointId - - VpcId - - SecurityGroupIds - title: ApplySecurityGroupsToClientVpnTargetNetworkRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/VpcId' - - description: The ID of the VPC in which the associated target network is located. - SecurityGroupId: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - ClientVpnSecurityGroupIdSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/SecurityGroupId' - - xml: - name: item - ArchitectureTypeList: - type: array - items: - allOf: - - $ref: '#/components/schemas/ArchitectureType' - - xml: - name: item - ArnList: - type: array - items: - allOf: - - $ref: '#/components/schemas/ResourceArn' - - xml: - name: item - IpPrefixList: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - AssignIpv6AddressesRequest: - type: object - required: - - NetworkInterfaceId - title: AssignIpv6AddressesRequest - properties: - ipv6AddressCount: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The number of additional IPv6 addresses to assign to the network interface. The specified number of IPv6 addresses are assigned in addition to the existing IPv6 addresses that are already assigned to the network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses. - ipv6Addresses: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The number of IPv6 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use the Ipv6Prefixes option. - Ipv6Prefix: - allOf: - - $ref: '#/components/schemas/IpPrefixList' - - description: One or more IPv6 prefixes assigned to the network interface. You cannot use this option if you use the Ipv6PrefixCount option. - networkInterfaceId: - allOf: - - $ref: '#/components/schemas/NetworkInterfaceId' - - description: The ID of the network interface. - Ipv6AddressList: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - PrivateIpAddressStringList: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: PrivateIpAddress - AssignPrivateIpAddressesRequest: - type: object - required: - - NetworkInterfaceId - title: AssignPrivateIpAddressesRequest - properties: - allowReassignment: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface. - networkInterfaceId: - allOf: - - $ref: '#/components/schemas/NetworkInterfaceId' - - description: The ID of the network interface. - privateIpAddress: - allOf: - - $ref: '#/components/schemas/PrivateIpAddressStringList' - - description: '

One or more IP addresses to be assigned as a secondary private IP address to the network interface. You can''t specify this parameter when also specifying a number of secondary IP addresses.

If you don''t specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.

' - secondaryPrivateIpAddressCount: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses. - Ipv4Prefix: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use the Ipv4 Prefixes option. - description: Contains the parameters for AssignPrivateIpAddresses. - AssignedPrivateIpAddressList: - type: array - items: - allOf: - - $ref: '#/components/schemas/AssignedPrivateIpAddress' - - xml: - name: item - Ipv4PrefixesList: - type: array - items: - allOf: - - $ref: '#/components/schemas/Ipv4PrefixSpecification' - - xml: - name: item - AssignedPrivateIpAddress: - type: object - properties: - privateIpAddress: - allOf: - - $ref: '#/components/schemas/String' - - description: The private IP address assigned to the network interface. - description: Describes the private IP addresses assigned to a network interface. - AssociateAddressRequest: - type: object - title: AssociateAddressRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: '[EC2-Classic] The Elastic IP address to associate with the instance. This is required for EC2-Classic.' - allowReassociation: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: '[EC2-VPC] For a VPC in an EC2-Classic account, specify true to allow an Elastic IP address that is already associated with an instance or network interface to be reassociated with the specified instance or network interface. Otherwise, the operation fails. In a VPC in an EC2-VPC-only account, reassociation is automatic, therefore you can specify false to ensure the operation fails if the Elastic IP address is already associated with another resource.' - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - networkInterfaceId: - allOf: - - $ref: '#/components/schemas/NetworkInterfaceId' - - description: '

[EC2-VPC] The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.

For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both.

' - privateIpAddress: - allOf: - - $ref: '#/components/schemas/String' - - description: '[EC2-VPC] The primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address.' - AssociateClientVpnTargetNetworkRequest: - type: object - required: - - ClientVpnEndpointId - - SubnetId - title: AssociateClientVpnTargetNetworkRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - AssociationStatus: - type: object - properties: - code: - allOf: - - $ref: '#/components/schemas/AssociationStatusCode' - - description: The state of the target network association. - message: - allOf: - - $ref: '#/components/schemas/String' - - description: 'A message about the status of the target network association, if applicable.' - description: Describes the state of a target network association. - AssociateDhcpOptionsRequest: - type: object - required: - - DhcpOptionsId - - VpcId - title: AssociateDhcpOptionsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/VpcId' - - description: The ID of the VPC. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - AssociateEnclaveCertificateIamRoleRequest: - type: object - title: AssociateEnclaveCertificateIamRoleRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - AssociateIamInstanceProfileRequest: - type: object - required: - - IamInstanceProfile - - InstanceId - title: AssociateIamInstanceProfileRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/InstanceId' - - description: The ID of the instance. - IamInstanceProfileAssociation: - type: object - properties: - associationId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the association. - instanceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the instance. - iamInstanceProfile: - allOf: - - $ref: '#/components/schemas/IamInstanceProfile' - - description: The IAM instance profile. - state: - allOf: - - $ref: '#/components/schemas/IamInstanceProfileAssociationState' - - description: The state of the association. - timestamp: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The time the IAM instance profile was associated with the instance. - description: Describes an association between an IAM instance profile and an instance. - InstanceEventWindowAssociationRequest: - type: object - properties: - InstanceId: - allOf: - - $ref: '#/components/schemas/InstanceIdList' - - description: 'The IDs of the instances to associate with the event window. If the instance is on a Dedicated Host, you can''t specify the Instance ID parameter; you must use the Dedicated Host ID parameter.' - InstanceTag: - allOf: - - $ref: '#/components/schemas/TagList' - - description: The instance tags to associate with the event window. Any instances associated with the tags will be associated with the event window. - DedicatedHostId: - allOf: - - $ref: '#/components/schemas/DedicatedHostIdList' - - description: The IDs of the Dedicated Hosts to associate with the event window. - description: 'One or more targets associated with the specified event window. Only one type of target (instance ID, instance tag, or Dedicated Host ID) can be associated with an event window.' - AssociateInstanceEventWindowRequest: - type: object - required: - - InstanceEventWindowId - - AssociationTarget - title: AssociateInstanceEventWindowRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/InstanceEventWindowAssociationRequest' - - description: One or more targets associated with the specified event window. - InstanceEventWindow: - type: object - properties: - instanceEventWindowId: - allOf: - - $ref: '#/components/schemas/InstanceEventWindowId' - - description: The ID of the event window. - timeRangeSet: - allOf: - - $ref: '#/components/schemas/InstanceEventWindowTimeRangeList' - - description: One or more time ranges defined for the event window. - name: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of the event window. - cronExpression: - allOf: - - $ref: '#/components/schemas/InstanceEventWindowCronExpression' - - description: The cron expression defined for the event window. - associationTarget: - allOf: - - $ref: '#/components/schemas/InstanceEventWindowAssociationTarget' - - description: One or more targets associated with the event window. - state: - allOf: - - $ref: '#/components/schemas/InstanceEventWindowState' - - description: The current state of the event window. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: The instance tags associated with the event window. - description: The event window. - RouteGatewayId: - type: string - AssociateRouteTableRequest: - type: object - required: - - RouteTableId - title: AssociateRouteTableRequest - properties: - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - routeTableId: - allOf: - - $ref: '#/components/schemas/RouteTableId' - - description: The ID of the route table. - subnetId: - allOf: - - $ref: '#/components/schemas/RouteGatewayId' - - description: The ID of the internet gateway or virtual private gateway. - RouteTableAssociationState: - type: object - properties: - state: - allOf: - - $ref: '#/components/schemas/RouteTableAssociationStateCode' - - description: The state of the association. - statusMessage: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The status message, if applicable.' - description: Describes the state of an association between a route table and a subnet or gateway. - AssociateSubnetCidrBlockRequest: - type: object - required: - - Ipv6CidrBlock - - SubnetId - title: AssociateSubnetCidrBlockRequest - properties: - ipv6CidrBlock: - allOf: - - $ref: '#/components/schemas/String' - - description: The IPv6 CIDR block for your subnet. The subnet must have a /64 prefix length. - subnetId: - allOf: - - $ref: '#/components/schemas/SubnetId' - - description: The ID of your subnet. - SubnetIpv6CidrBlockAssociation: - type: object - properties: - associationId: - allOf: - - $ref: '#/components/schemas/SubnetCidrAssociationId' - - description: The ID of the association. - ipv6CidrBlock: - allOf: - - $ref: '#/components/schemas/String' - - description: The IPv6 CIDR block. - ipv6CidrBlockState: - allOf: - - $ref: '#/components/schemas/SubnetCidrBlockState' - - description: The state of the CIDR block. - description: Describes an association between a subnet and an IPv6 CIDR block. - AssociateTransitGatewayMulticastDomainRequest: - type: object - title: AssociateTransitGatewayMulticastDomainRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - AssociateTransitGatewayRouteTableRequest: - type: object - required: - - TransitGatewayRouteTableId - - TransitGatewayAttachmentId - title: AssociateTransitGatewayRouteTableRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - TransitGatewayAssociation: - type: object - properties: - transitGatewayRouteTableId: - allOf: - - $ref: '#/components/schemas/TransitGatewayRouteTableId' - - description: The ID of the transit gateway route table. - transitGatewayAttachmentId: - allOf: - - $ref: '#/components/schemas/TransitGatewayAttachmentId' - - description: The ID of the attachment. - resourceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the resource. - resourceType: - allOf: - - $ref: '#/components/schemas/TransitGatewayAttachmentResourceType' - - description: The resource type. Note that the tgw-peering resource type has been deprecated. - state: - allOf: - - $ref: '#/components/schemas/TransitGatewayAssociationState' - - description: The state of the association. - description: Describes an association between a resource attachment and a transit gateway route table. - AssociateTrunkInterfaceRequest: - type: object - required: - - BranchInterfaceId - - TrunkInterfaceId - title: AssociateTrunkInterfaceRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - TrunkInterfaceAssociation: - type: object - properties: - associationId: - allOf: - - $ref: '#/components/schemas/TrunkInterfaceAssociationId' - - description: The ID of the association. - branchInterfaceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the branch network interface. - trunkInterfaceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the trunk network interface. - interfaceProtocol: - allOf: - - $ref: '#/components/schemas/InterfaceProtocolType' - - description: The interface protocol. Valid values are VLAN and GRE. - vlanId: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The ID of the VLAN when you use the VLAN protocol. - greKey: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The application key when you use the GRE protocol. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: The tags for the trunk interface association. - description: '

Currently available in limited preview only. If you are interested in using this feature, contact your account manager.

Information about an association between a branch network interface with a trunk network interface.

' - NetmaskLength: - type: integer - AssociateVpcCidrBlockRequest: - type: object - required: - - VpcId - title: AssociateVpcCidrBlockRequest - properties: - amazonProvidedIpv6CidrBlock: - allOf: - - $ref: '#/components/schemas/String' - - description: An IPv4 CIDR block to associate with the VPC. - vpcId: - allOf: - - $ref: '#/components/schemas/NetmaskLength' - - description: 'The netmask length of the IPv6 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide. ' - VpcIpv6CidrBlockAssociation: - type: object - properties: - associationId: - allOf: - - $ref: '#/components/schemas/String' - - description: The association ID for the IPv6 CIDR block. - ipv6CidrBlock: - allOf: - - $ref: '#/components/schemas/String' - - description: The IPv6 CIDR block. - ipv6CidrBlockState: - allOf: - - $ref: '#/components/schemas/VpcCidrBlockState' - - description: Information about the state of the CIDR block. - networkBorderGroup: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses, for example, us-east-1-wl1-bos-wlz-1.' - ipv6Pool: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated. - description: Describes an IPv6 CIDR block associated with a VPC. - VpcCidrBlockAssociation: - type: object - properties: - associationId: - allOf: - - $ref: '#/components/schemas/String' - - description: The association ID for the IPv4 CIDR block. - cidrBlock: - allOf: - - $ref: '#/components/schemas/String' - - description: The IPv4 CIDR block. - cidrBlockState: - allOf: - - $ref: '#/components/schemas/VpcCidrBlockState' - - description: Information about the state of the CIDR block. - description: Describes an IPv4 CIDR block associated with a VPC. - AssociatedNetworkType: - type: string - enum: - - vpc - AssociatedRole: - type: object - properties: - associatedRoleArn: - allOf: - - $ref: '#/components/schemas/ResourceArn' - - description: The ARN of the associated IAM role. - certificateS3BucketName: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of the Amazon S3 bucket in which the Amazon S3 object is stored. - certificateS3ObjectKey: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The key of the Amazon S3 object ey where the certificate, certificate chain, and encrypted private key bundle is stored. The object key is formated as follows: role_arn/certificate_arn. ' - encryptionKmsKeyId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the KMS customer master key (CMK) used to encrypt the private key. - description: Information about the associated IAM roles. - AssociatedRolesList: - type: array - items: - allOf: - - $ref: '#/components/schemas/AssociatedRole' - - xml: - name: item - AssociatedTargetNetwork: - type: object - properties: - networkId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the subnet. - networkType: - allOf: - - $ref: '#/components/schemas/AssociatedNetworkType' - - description: The target network type. - description: Describes a target network that is associated with a Client VPN endpoint. A target network is a subnet in a VPC. - AssociatedTargetNetworkSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/AssociatedTargetNetwork' - - xml: - name: item - AssociationIdList: - type: array - items: - allOf: - - $ref: '#/components/schemas/IamInstanceProfileAssociationId' - - xml: - name: AssociationId - AssociationStatusCode: - type: string - enum: - - associating - - associated - - association-failed - - disassociating - - disassociated - MillisecondDateTime: - type: string - format: date-time - AthenaIntegration: - type: object - required: - - IntegrationResultS3DestinationArn - - PartitionLoadFrequency - properties: - undefined: - allOf: - - $ref: '#/components/schemas/MillisecondDateTime' - - description: The end date for the partition. - description: Describes integration options for Amazon Athena. - GroupIdStringList: - type: array - items: - allOf: - - $ref: '#/components/schemas/SecurityGroupId' - - xml: - name: groupId - AttachClassicLinkVpcRequest: - type: object - required: - - Groups - - InstanceId - - VpcId - title: AttachClassicLinkVpcRequest - properties: - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - SecurityGroupId: - allOf: - - $ref: '#/components/schemas/GroupIdStringList' - - description: The ID of one or more of the VPC's security groups. You cannot specify security groups from a different VPC. - instanceId: - allOf: - - $ref: '#/components/schemas/InstanceId' - - description: The ID of an EC2-Classic instance to link to the ClassicLink-enabled VPC. - vpcId: - allOf: - - $ref: '#/components/schemas/VpcId' - - description: The ID of a ClassicLink-enabled VPC. - AttachInternetGatewayRequest: - type: object - required: - - InternetGatewayId - - VpcId - title: AttachInternetGatewayRequest - properties: - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - internetGatewayId: - allOf: - - $ref: '#/components/schemas/InternetGatewayId' - - description: The ID of the internet gateway. - vpcId: - allOf: - - $ref: '#/components/schemas/VpcId' - - description: The ID of the VPC. - AttachNetworkInterfaceRequest: - type: object - required: - - DeviceIndex - - InstanceId - - NetworkInterfaceId - title: AttachNetworkInterfaceRequest - properties: - deviceIndex: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The index of the device for the network interface attachment. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - instanceId: - allOf: - - $ref: '#/components/schemas/InstanceId' - - description: The ID of the instance. - networkInterfaceId: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The index of the network card. Some instance types support multiple network cards. The primary network interface must be assigned to network card index 0. The default is network card index 0. - description: Contains the parameters for AttachNetworkInterface. - AttachVolumeRequest: - type: object - required: - - Device - - InstanceId - - VolumeId - title: AttachVolumeRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/VolumeId' - - description: The ID of the EBS volume. The volume and instance must be within the same Availability Zone. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - AttachVpnGatewayRequest: - type: object - required: - - VpcId - - VpnGatewayId - title: AttachVpnGatewayRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/VpnGatewayId' - - description: The ID of the virtual private gateway. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - description: Contains the parameters for AttachVpnGateway. - VpcAttachment: - type: object - properties: - state: - allOf: - - $ref: '#/components/schemas/AttachmentStatus' - - description: The current state of the attachment. - vpcId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the VPC. - description: Describes an attachment between a virtual private gateway and a VPC. - AttachmentStatus: - type: string - enum: - - attaching - - attached - - detaching - - detached - AttributeBooleanValue: - type: object - properties: - value: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: The attribute value. The valid values are true or false. - description: Describes a value for a resource attribute that is a Boolean value. - AttributeValue: - type: object - properties: - value: - allOf: - - $ref: '#/components/schemas/String' - - description: The attribute value. The value is case-sensitive. - description: Describes a value for a resource attribute that is a String. - ClientVpnAuthorizationRuleStatus: - type: object - properties: - code: - allOf: - - $ref: '#/components/schemas/ClientVpnAuthorizationRuleStatusCode' - - description: The state of the authorization rule. - message: - allOf: - - $ref: '#/components/schemas/String' - - description: 'A message about the status of the authorization rule, if applicable.' - description: Describes the state of an authorization rule. - AuthorizationRule: - type: object - properties: - clientVpnEndpointId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Client VPN endpoint with which the authorization rule is associated. - description: - allOf: - - $ref: '#/components/schemas/String' - - description: A brief description of the authorization rule. - groupId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Active Directory group to which the authorization rule grants access. - accessAll: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether the authorization rule grants access to all clients. - destinationCidr: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The IPv4 address range, in CIDR notation, of the network to which the authorization rule applies.' - status: - allOf: - - $ref: '#/components/schemas/ClientVpnAuthorizationRuleStatus' - - description: The current state of the authorization rule. - description: Information about an authorization rule. - AuthorizationRuleSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/AuthorizationRule' - - xml: - name: item - AuthorizeClientVpnIngressRequest: - type: object - required: - - ClientVpnEndpointId - - TargetNetworkCidr - title: AuthorizeClientVpnIngressRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - IpPermissionList: - type: array - items: - allOf: - - $ref: '#/components/schemas/IpPermission' - - xml: - name: item - AuthorizeSecurityGroupEgressRequest: - type: object - required: - - GroupId - title: AuthorizeSecurityGroupEgressRequest - properties: - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - groupId: - allOf: - - $ref: '#/components/schemas/SecurityGroupId' - - description: The ID of the security group. - ipPermissions: - allOf: - - $ref: '#/components/schemas/IpPermissionList' - - description: The sets of IP permissions. You can't specify a destination security group and a CIDR IP address range in the same set of permissions. - TagSpecification: - allOf: - - $ref: '#/components/schemas/TagSpecificationList' - - description: The tags applied to the security group rule. - cidrIp: - allOf: - - $ref: '#/components/schemas/String' - - description: Not supported. Use a set of IP permissions to specify the CIDR. - fromPort: - allOf: - - $ref: '#/components/schemas/Integer' - - description: Not supported. Use a set of IP permissions to specify the port. - ipProtocol: - allOf: - - $ref: '#/components/schemas/String' - - description: Not supported. Use a set of IP permissions to specify the protocol name or number. - toPort: - allOf: - - $ref: '#/components/schemas/Integer' - - description: Not supported. Use a set of IP permissions to specify the port. - sourceSecurityGroupName: - allOf: - - $ref: '#/components/schemas/String' - - description: Not supported. Use a set of IP permissions to specify a destination security group. - sourceSecurityGroupOwnerId: - allOf: - - $ref: '#/components/schemas/String' - - description: Not supported. Use a set of IP permissions to specify a destination security group. - SecurityGroupRuleList: - type: array - items: - allOf: - - $ref: '#/components/schemas/SecurityGroupRule' - - xml: - name: item - AuthorizeSecurityGroupIngressRequest: - type: object - title: AuthorizeSecurityGroupIngressRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Integer' - - description: '

The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all codes. If you specify all ICMP types, you must specify all codes.

Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.

' - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - TagSpecification: - allOf: - - $ref: '#/components/schemas/TagSpecificationList' - - description: '[VPC Only] The tags applied to the security group rule.' - AutoAcceptSharedAttachmentsValue: - type: string - enum: - - enable - - disable - AutoRecoveryFlag: - type: boolean - AvailabilityZoneState: - type: string - enum: - - available - - information - - impaired - - unavailable - AvailabilityZoneOptInStatus: - type: string - enum: - - opt-in-not-required - - opted-in - - not-opted-in - AvailabilityZoneMessageList: - type: array - items: - allOf: - - $ref: '#/components/schemas/AvailabilityZoneMessage' - - xml: - name: item - AvailabilityZone: - type: object - properties: - zoneState: - allOf: - - $ref: '#/components/schemas/AvailabilityZoneState' - - description: 'The state of the Availability Zone, Local Zone, or Wavelength Zone. This value is always available.' - optInStatus: - allOf: - - $ref: '#/components/schemas/AvailabilityZoneOptInStatus' - - description: '

For Availability Zones, this parameter always has the value of opt-in-not-required.

For Local Zones and Wavelength Zones, this parameter is the opt-in status. The possible values are opted-in, and not-opted-in.

' - messageSet: - allOf: - - $ref: '#/components/schemas/AvailabilityZoneMessageList' - - description: 'Any messages about the Availability Zone, Local Zone, or Wavelength Zone.' - regionName: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of the Region. - zoneName: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The name of the Availability Zone, Local Zone, or Wavelength Zone.' - zoneId: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The ID of the Availability Zone, Local Zone, or Wavelength Zone.' - groupName: - allOf: - - $ref: '#/components/schemas/String' - - description: '

For Availability Zones, this parameter has the same value as the Region name.

For Local Zones, the name of the associated group, for example us-west-2-lax-1.

For Wavelength Zones, the name of the associated group, for example us-east-1-wl1-bos-wlz-1.

' - networkBorderGroup: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of the network border group. - zoneType: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The type of zone. The valid values are availability-zone, local-zone, and wavelength-zone.' - parentZoneName: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The name of the zone that handles some of the Local Zone or Wavelength Zone control plane operations, such as API calls.' - parentZoneId: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The ID of the zone that handles some of the Local Zone or Wavelength Zone control plane operations, such as API calls.' - description: 'Describes Availability Zones, Local Zones, and Wavelength Zones.' - AvailabilityZoneList: - type: array - items: - allOf: - - $ref: '#/components/schemas/AvailabilityZone' - - xml: - name: item - AvailabilityZoneMessage: - type: object - properties: - message: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The message about the Availability Zone, Local Zone, or Wavelength Zone.' - description: 'Describes a message about an Availability Zone, Local Zone, or Wavelength Zone.' - AvailabilityZoneStringList: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: AvailabilityZone - AvailableInstanceCapacityList: - type: array - items: - allOf: - - $ref: '#/components/schemas/InstanceCapacity' - - xml: - name: item - AvailableCapacity: - type: object - properties: - availableInstanceCapacity: - allOf: - - $ref: '#/components/schemas/AvailableInstanceCapacityList' - - description: 'The number of instances that can be launched onto the Dedicated Host depending on the host''s available capacity. For Dedicated Hosts that support multiple instance types, this parameter represents the number of instances for each instance size that is supported on the host.' - availableVCpus: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The number of vCPUs available for launching instances onto the Dedicated Host. - description: 'The capacity information for instances that can be launched onto the Dedicated Host. ' - InstanceCapacity: - type: object - properties: - availableCapacity: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The number of instances that can be launched onto the Dedicated Host based on the host's available capacity. - instanceType: - allOf: - - $ref: '#/components/schemas/String' - - description: The instance type supported by the Dedicated Host. - totalCapacity: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The total number of instances that can be launched onto the Dedicated Host if there are no instances running on it. - description: Information about the number of instances that can be launched onto the Dedicated Host. - BareMetal: - type: string - enum: - - included - - required - - excluded - BareMetalFlag: - type: boolean - BaselineBandwidthInMbps: - type: integer - BaselineEbsBandwidthMbps: - type: object - properties: - min: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The minimum baseline bandwidth, in Mbps. If this parameter is not specified, there is no minimum limit.' - max: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The maximum baseline bandwidth, in Mbps. If this parameter is not specified, there is no maximum limit.' - description: 'The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see Amazon EBS–optimized instances in the Amazon EC2 User Guide.' - BaselineIops: - type: integer - BaselineThroughputInMBps: - type: number - format: double - BatchState: - type: string - enum: - - submitted - - active - - cancelled - - failed - - cancelled_running - - cancelled_terminating - - modifying - BgpStatus: - type: string - enum: - - up - - down - BillingProductList: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - BlobAttributeValue: - type: object - properties: - value: - $ref: '#/components/schemas/Blob' - EbsBlockDevice: - type: object - properties: - deleteOnTermination: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the Amazon EC2 User Guide.' - iops: - allOf: - - $ref: '#/components/schemas/Integer' - - description: '

The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.

The following are the supported values for each volume type:

  • gp3: 3,000-16,000 IOPS

  • io1: 100-64,000 IOPS

  • io2: 100-64,000 IOPS

For io1 and io2 volumes, we guarantee 64,000 IOPS only for Instances built on the Nitro System. Other instance families guarantee performance up to 32,000 IOPS.

This parameter is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for gp2, st1, sc1, or standard volumes.

' - snapshotId: - allOf: - - $ref: '#/components/schemas/SnapshotId' - - description: The ID of the snapshot. - volumeSize: - allOf: - - $ref: '#/components/schemas/Integer' - - description: '

The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.

The following are the supported volumes sizes for each volume type:

  • gp2 and gp3:1-16,384

  • io1 and io2: 4-16,384

  • st1 and sc1: 125-16,384

  • standard: 1-1,024

' - volumeType: - allOf: - - $ref: '#/components/schemas/String' - - description: '

Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.

This parameter is only supported on BlockDeviceMapping objects called by RunInstances, RequestSpotFleet, and RequestSpotInstances.

' - throughput: - allOf: - - $ref: '#/components/schemas/Integer' - - description: '

The throughput that the volume supports, in MiB/s.

This parameter is valid only for gp3 volumes.

Valid Range: Minimum value of 125. Maximum value of 1000.

' - outpostArn: - allOf: - - $ref: '#/components/schemas/String' - - description: '

The ARN of the Outpost on which the snapshot is stored.

This parameter is only supported on BlockDeviceMapping objects called by CreateImage.

' - encrypted: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: '

Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS encryption in the Amazon EC2 User Guide.

In no case can you remove encryption from an encrypted volume.

Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types.

This parameter is not returned by DescribeImageAttribute.

' - description: Describes a block device for an EBS volume. - BlockDeviceMappingRequestList: - type: array - items: - allOf: - - $ref: '#/components/schemas/BlockDeviceMapping' - - xml: - name: BlockDeviceMapping - BootModeType: - type: string - enum: - - legacy-bios - - uefi - BootModeTypeList: - type: array - items: - allOf: - - $ref: '#/components/schemas/BootModeType' - - xml: - name: item - BootModeValues: - type: string - enum: - - legacy-bios - - uefi - BoxedDouble: - type: number - format: double - BundleIdStringList: - type: array - items: - allOf: - - $ref: '#/components/schemas/BundleId' - - xml: - name: BundleId - Storage: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/S3Storage' - - description: An Amazon S3 storage location. - description: Describes the storage location for an instance store-backed AMI. - BundleInstanceRequest: - type: object - required: - - InstanceId - - Storage - title: BundleInstanceRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Storage' - - description: 'The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.' - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - description: Contains the parameters for BundleInstance. - BundleTask: - type: object - properties: - bundleId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the bundle task. - error: - allOf: - - $ref: '#/components/schemas/BundleTaskError' - - description: 'If the task fails, a description of the error.' - instanceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the instance associated with this bundle task. - progress: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The level of task completion, as a percent (for example, 20%).' - startTime: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The time this task started. - state: - allOf: - - $ref: '#/components/schemas/BundleTaskState' - - description: The state of the task. - storage: - allOf: - - $ref: '#/components/schemas/Storage' - - description: The Amazon S3 storage locations. - updateTime: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The time of the most recent update for the task. - description: Describes a bundle task. - BundleTaskError: - type: object - properties: - code: - allOf: - - $ref: '#/components/schemas/String' - - description: The error code. - message: - allOf: - - $ref: '#/components/schemas/String' - - description: The error message. - description: Describes an error for BundleInstance. - BundleTaskState: - type: string - enum: - - pending - - waiting-for-shutdown - - bundling - - storing - - cancelling - - complete - - failed - BundleTaskList: - type: array - items: - allOf: - - $ref: '#/components/schemas/BundleTask' - - xml: - name: item - BurstablePerformance: - type: string - enum: - - included - - required - - excluded - BurstablePerformanceFlag: - type: boolean - ByoipCidrState: - type: string - enum: - - advertised - - deprovisioned - - failed-deprovision - - failed-provision - - pending-deprovision - - pending-provision - - provisioned - - provisioned-not-publicly-advertisable - ByoipCidrSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/ByoipCidr' - - xml: - name: item - CancelBatchErrorCode: - type: string - enum: - - fleetRequestIdDoesNotExist - - fleetRequestIdMalformed - - fleetRequestNotInCancellableState - - unexpectedError - CancelBundleTaskRequest: - type: object - required: - - BundleId - title: CancelBundleTaskRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/BundleId' - - description: The ID of the bundle task. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - description: Contains the parameters for CancelBundleTask. - CancelCapacityReservationFleetErrorCode: - type: string - CancelCapacityReservationFleetErrorMessage: - type: string - CancelCapacityReservationFleetError: - type: object - properties: - code: - allOf: - - $ref: '#/components/schemas/CancelCapacityReservationFleetErrorCode' - - description: The error code. - message: - allOf: - - $ref: '#/components/schemas/CancelCapacityReservationFleetErrorMessage' - - description: The error message. - description: Describes a Capacity Reservation Fleet cancellation error. - CapacityReservationFleetIdSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/CapacityReservationFleetId' - - xml: - name: item - CancelCapacityReservationFleetsRequest: - type: object - required: - - CapacityReservationFleetIds - title: CancelCapacityReservationFleetsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - CapacityReservationFleetId: - allOf: - - $ref: '#/components/schemas/CapacityReservationFleetIdSet' - - description: The IDs of the Capacity Reservation Fleets to cancel. - CapacityReservationFleetCancellationStateSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/CapacityReservationFleetCancellationState' - - xml: - name: item - FailedCapacityReservationFleetCancellationResultSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/FailedCapacityReservationFleetCancellationResult' - - xml: - name: item - CancelCapacityReservationRequest: - type: object - required: - - CapacityReservationId - title: CancelCapacityReservationRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - CancelConversionRequest: - type: object - required: - - ConversionTaskId - title: CancelConversionRequest - properties: - conversionTaskId: - allOf: - - $ref: '#/components/schemas/ConversionTaskId' - - description: The ID of the conversion task. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - reasonMessage: - allOf: - - $ref: '#/components/schemas/String' - - description: The reason for canceling the conversion task. - ExportVmTaskId: - type: string - CancelExportTaskRequest: - type: object - required: - - ExportTaskId - title: CancelExportTaskRequest - properties: - exportTaskId: - allOf: - - $ref: '#/components/schemas/ExportVmTaskId' - - description: The ID of the export task. This is the ID returned by CreateInstanceExportTask. - ImportTaskId: - type: string - CancelImportTaskRequest: - type: object - title: CancelImportTaskRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/ImportTaskId' - - description: The ID of the import image or import snapshot task to be canceled. - ReservedInstancesListingId: - type: string - CancelReservedInstancesListingRequest: - type: object - required: - - ReservedInstancesListingId - title: CancelReservedInstancesListingRequest - properties: - reservedInstancesListingId: - allOf: - - $ref: '#/components/schemas/ReservedInstancesListingId' - - description: The ID of the Reserved Instance listing. - description: Contains the parameters for CancelReservedInstancesListing. - ReservedInstancesListingList: - type: array - items: - allOf: - - $ref: '#/components/schemas/ReservedInstancesListing' - - xml: - name: item - CancelSpotFleetRequestsError: - type: object - properties: - code: - allOf: - - $ref: '#/components/schemas/CancelBatchErrorCode' - - description: The error code. - message: - allOf: - - $ref: '#/components/schemas/String' - - description: The description for the error code. - description: Describes a Spot Fleet error. - CancelSpotFleetRequestsErrorItem: - type: object - properties: - error: - allOf: - - $ref: '#/components/schemas/CancelSpotFleetRequestsError' - - description: The error. - spotFleetRequestId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Spot Fleet request. - description: Describes a Spot Fleet request that was not successfully canceled. - CancelSpotFleetRequestsErrorSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/CancelSpotFleetRequestsErrorItem' - - xml: - name: item - SpotFleetRequestIdList: - type: array - items: - allOf: - - $ref: '#/components/schemas/SpotFleetRequestId' - - xml: - name: item - CancelSpotFleetRequestsRequest: - type: object - required: - - SpotFleetRequestIds - - TerminateInstances - title: CancelSpotFleetRequestsRequest - properties: - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - spotFleetRequestId: - allOf: - - $ref: '#/components/schemas/SpotFleetRequestIdList' - - description: The IDs of the Spot Fleet requests. - terminateInstances: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether to terminate instances for a Spot Fleet request if it is canceled successfully. - description: Contains the parameters for CancelSpotFleetRequests. - CancelSpotFleetRequestsSuccessSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/CancelSpotFleetRequestsSuccessItem' - - xml: - name: item - CancelSpotFleetRequestsSuccessItem: - type: object - properties: - currentSpotFleetRequestState: - allOf: - - $ref: '#/components/schemas/BatchState' - - description: The current state of the Spot Fleet request. - previousSpotFleetRequestState: - allOf: - - $ref: '#/components/schemas/BatchState' - - description: The previous state of the Spot Fleet request. - spotFleetRequestId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Spot Fleet request. - description: Describes a Spot Fleet request that was successfully canceled. - CancelSpotInstanceRequestState: - type: string - enum: - - active - - open - - closed - - cancelled - - completed - SpotInstanceRequestIdList: - type: array - items: - allOf: - - $ref: '#/components/schemas/SpotInstanceRequestId' - - xml: - name: SpotInstanceRequestId - CancelSpotInstanceRequestsRequest: - type: object - required: - - SpotInstanceRequestIds - title: CancelSpotInstanceRequestsRequest - properties: - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - SpotInstanceRequestId: - allOf: - - $ref: '#/components/schemas/SpotInstanceRequestIdList' - - description: One or more Spot Instance request IDs. - description: Contains the parameters for CancelSpotInstanceRequests. - CancelledSpotInstanceRequestList: - type: array - items: - allOf: - - $ref: '#/components/schemas/CancelledSpotInstanceRequest' - - xml: - name: item - CancelledSpotInstanceRequest: - type: object - properties: - spotInstanceRequestId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Spot Instance request. - state: - allOf: - - $ref: '#/components/schemas/CancelSpotInstanceRequestState' - - description: The state of the Spot Instance request. - description: Describes a request to cancel a Spot Instance. - CapacityReservationInstancePlatform: - type: string - enum: - - Linux/UNIX - - Red Hat Enterprise Linux - - SUSE Linux - - Windows - - Windows with SQL Server - - Windows with SQL Server Enterprise - - Windows with SQL Server Standard - - Windows with SQL Server Web - - Linux with SQL Server Standard - - Linux with SQL Server Web - - Linux with SQL Server Enterprise - - RHEL with SQL Server Standard - - RHEL with SQL Server Enterprise - - RHEL with SQL Server Web - - RHEL with HA - - RHEL with HA and SQL Server Standard - - RHEL with HA and SQL Server Enterprise - CapacityReservationTenancy: - type: string - enum: - - default - - dedicated - CapacityReservationState: - type: string - enum: - - active - - expired - - cancelled - - pending - - failed - EndDateType: - type: string - enum: - - unlimited - - limited - InstanceMatchCriteria: - type: string - enum: - - open - - targeted - OutpostArn: - type: string - pattern: '^arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/op-[a-f0-9]{17}$' - PlacementGroupArn: - type: string - pattern: '^arn:aws([a-z-]+)?:ec2:[a-z\d-]+:\d{12}:placement-group/([^\s].+[^\s]){1,255}$' - CapacityReservation: - type: object - properties: - capacityReservationId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Capacity Reservation. - ownerId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Amazon Web Services account that owns the Capacity Reservation. - capacityReservationArn: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Resource Name (ARN) of the Capacity Reservation. - availabilityZoneId: - allOf: - - $ref: '#/components/schemas/String' - - description: The Availability Zone ID of the Capacity Reservation. - instanceType: - allOf: - - $ref: '#/components/schemas/String' - - description: The type of instance for which the Capacity Reservation reserves capacity. - instancePlatform: - allOf: - - $ref: '#/components/schemas/CapacityReservationInstancePlatform' - - description: The type of operating system for which the Capacity Reservation reserves capacity. - availabilityZone: - allOf: - - $ref: '#/components/schemas/String' - - description: The Availability Zone in which the capacity is reserved. - tenancy: - allOf: - - $ref: '#/components/schemas/CapacityReservationTenancy' - - description: '

Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:

  • default - The Capacity Reservation is created on hardware that is shared with other Amazon Web Services accounts.

  • dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.

' - totalInstanceCount: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The total number of instances for which the Capacity Reservation reserves capacity. - availableInstanceCount: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation. - ebsOptimized: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether the Capacity Reservation supports EBS-optimized instances. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS- optimized instance. - ephemeralStorage: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Indicates whether the Capacity Reservation supports instances with temporary, block-level storage.' - state: - allOf: - - $ref: '#/components/schemas/CapacityReservationState' - - description: '

The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:

  • active - The Capacity Reservation is active and the capacity is available for your use.

  • expired - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.

  • cancelled - The Capacity Reservation was cancelled. The reserved capacity is no longer available for your use.

  • pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.

  • failed - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.

' - startDate: - allOf: - - $ref: '#/components/schemas/MillisecondDateTime' - - description: The date and time at which the Capacity Reservation was started. - endDate: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: 'The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation''s state changes to expired when it reaches its end date and time.' - endDateType: - allOf: - - $ref: '#/components/schemas/EndDateType' - - description: '

Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:

  • unlimited - The Capacity Reservation remains active until you explicitly cancel it.

  • limited - The Capacity Reservation expires automatically at a specified date and time.

' - instanceMatchCriteria: - allOf: - - $ref: '#/components/schemas/InstanceMatchCriteria' - - description: '

Indicates the type of instance launches that the Capacity Reservation accepts. The options include:

  • open - The Capacity Reservation accepts all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes launch into the Capacity Reservation automatically without specifying any additional parameters.

  • targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.

' - createDate: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The date and time at which the Capacity Reservation was created. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: Any tags assigned to the Capacity Reservation. - outpostArn: - allOf: - - $ref: '#/components/schemas/OutpostArn' - - description: The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation was created. - capacityReservationFleetId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Capacity Reservation Fleet to which the Capacity Reservation belongs. Only valid for Capacity Reservations that were created by a Capacity Reservation Fleet. - placementGroupArn: - allOf: - - $ref: '#/components/schemas/PlacementGroupArn' - - description: 'The Amazon Resource Name (ARN) of the cluster placement group in which the Capacity Reservation was created. For more information, see Capacity Reservations for cluster placement groups in the Amazon EC2 User Guide.' - description: Describes a Capacity Reservation. - CapacityReservationFleetState: - type: string - enum: - - submitted - - modifying - - active - - partially_fulfilled - - expiring - - expired - - cancelling - - cancelled - - failed - FleetCapacityReservationTenancy: - type: string - enum: - - default - FleetInstanceMatchCriteria: - type: string - enum: - - open - FleetCapacityReservationSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/FleetCapacityReservation' - - xml: - name: item - CapacityReservationFleet: - type: object - properties: - capacityReservationFleetId: - allOf: - - $ref: '#/components/schemas/CapacityReservationFleetId' - - description: The ID of the Capacity Reservation Fleet. - capacityReservationFleetArn: - allOf: - - $ref: '#/components/schemas/String' - - description: The ARN of the Capacity Reservation Fleet. - state: - allOf: - - $ref: '#/components/schemas/CapacityReservationFleetState' - - description: '

The state of the Capacity Reservation Fleet. Possible states include:

  • submitted - The Capacity Reservation Fleet request has been submitted and Amazon Elastic Compute Cloud is preparing to create the Capacity Reservations.

  • modifying - The Capacity Reservation Fleet is being modified. The Fleet remains in this state until the modification is complete.

  • active - The Capacity Reservation Fleet has fulfilled its total target capacity and it is attempting to maintain this capacity. The Fleet remains in this state until it is modified or deleted.

  • partially_fulfilled - The Capacity Reservation Fleet has partially fulfilled its total target capacity. There is insufficient Amazon EC2 to fulfill the total target capacity. The Fleet is attempting to asynchronously fulfill its total target capacity.

  • expiring - The Capacity Reservation Fleet has reach its end date and it is in the process of expiring. One or more of its Capacity reservations might still be active.

  • expired - The Capacity Reservation Fleet has reach its end date. The Fleet and its Capacity Reservations are expired. The Fleet can''t create new Capacity Reservations.

  • cancelling - The Capacity Reservation Fleet is in the process of being cancelled. One or more of its Capacity reservations might still be active.

  • cancelled - The Capacity Reservation Fleet has been manually cancelled. The Fleet and its Capacity Reservations are cancelled and the Fleet can''t create new Capacity Reservations.

  • failed - The Capacity Reservation Fleet failed to reserve capacity for the specified instance types.

' - totalTargetCapacity: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The total number of capacity units for which the Capacity Reservation Fleet reserves capacity. For more information, see Total target capacity in the Amazon EC2 User Guide.' - totalFulfilledCapacity: - allOf: - - $ref: '#/components/schemas/Double' - - description: The capacity units that have been fulfilled. - tenancy: - allOf: - - $ref: '#/components/schemas/FleetCapacityReservationTenancy' - - description: '

The tenancy of the Capacity Reservation Fleet. Tenancies include:

  • default - The Capacity Reservation Fleet is created on hardware that is shared with other Amazon Web Services accounts.

  • dedicated - The Capacity Reservation Fleet is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.

' - endDate: - allOf: - - $ref: '#/components/schemas/MillisecondDateTime' - - description: The date and time at which the Capacity Reservation Fleet expires. - createTime: - allOf: - - $ref: '#/components/schemas/MillisecondDateTime' - - description: The date and time at which the Capacity Reservation Fleet was created. - instanceMatchCriteria: - allOf: - - $ref: '#/components/schemas/FleetInstanceMatchCriteria' - - description: '

Indicates the type of instance launches that the Capacity Reservation Fleet accepts. All Capacity Reservations in the Fleet inherit this instance matching criteria.

Currently, Capacity Reservation Fleets support open instance matching criteria only. This means that instances that have matching attributes (instance type, platform, and Availability Zone) run in the Capacity Reservations automatically. Instances do not need to explicitly target a Capacity Reservation Fleet to use its reserved capacity.

' - allocationStrategy: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The strategy used by the Capacity Reservation Fleet to determine which of the specified instance types to use. For more information, see For more information, see Allocation strategy in the Amazon EC2 User Guide.' - instanceTypeSpecificationSet: - allOf: - - $ref: '#/components/schemas/FleetCapacityReservationSet' - - description: Information about the instance types for which to reserve the capacity. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: The tags assigned to the Capacity Reservation Fleet. - description: Information about a Capacity Reservation Fleet. - CapacityReservationFleetCancellationState: - type: object - properties: - currentFleetState: - allOf: - - $ref: '#/components/schemas/CapacityReservationFleetState' - - description: The current state of the Capacity Reservation Fleet. - previousFleetState: - allOf: - - $ref: '#/components/schemas/CapacityReservationFleetState' - - description: The previous state of the Capacity Reservation Fleet. - capacityReservationFleetId: - allOf: - - $ref: '#/components/schemas/CapacityReservationFleetId' - - description: The ID of the Capacity Reservation Fleet that was successfully cancelled. - description: Describes a Capacity Reservation Fleet that was successfully cancelled. - CapacityReservationFleetSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/CapacityReservationFleet' - - xml: - name: item - CapacityReservationGroup: - type: object - properties: - groupArn: - allOf: - - $ref: '#/components/schemas/String' - - description: The ARN of the resource group. - ownerId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Amazon Web Services account that owns the resource group. - description: Describes a resource group to which a Capacity Reservation has been added. - CapacityReservationGroupSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/CapacityReservationGroup' - - xml: - name: item - CapacityReservationIdSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/CapacityReservationId' - - xml: - name: item - FleetCapacityReservationUsageStrategy: - type: string - enum: - - use-capacity-reservations-first - CapacityReservationOptions: - type: object - properties: - usageStrategy: - allOf: - - $ref: '#/components/schemas/FleetCapacityReservationUsageStrategy' - - description: '

Indicates whether to use unused Capacity Reservations for fulfilling On-Demand capacity.

If you specify use-capacity-reservations-first, the fleet uses unused Capacity Reservations to fulfill On-Demand capacity up to the target On-Demand capacity. If multiple instance pools have unused Capacity Reservations, the On-Demand allocation strategy (lowest-price or prioritized) is applied. If the number of unused Capacity Reservations is less than the On-Demand target capacity, the remaining On-Demand target capacity is launched according to the On-Demand allocation strategy (lowest-price or prioritized).

If you do not specify a value, the fleet fulfils the On-Demand capacity according to the chosen On-Demand allocation strategy.

' - description: '

Describes the strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.

This strategy can only be used if the EC2 Fleet is of type instant.

For more information about Capacity Reservations, see On-Demand Capacity Reservations in the Amazon EC2 User Guide. For examples of using Capacity Reservations in an EC2 Fleet, see EC2 Fleet example configurations in the Amazon EC2 User Guide.

' - CapacityReservationOptionsRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/FleetCapacityReservationUsageStrategy' - - description: '

Indicates whether to use unused Capacity Reservations for fulfilling On-Demand capacity.

If you specify use-capacity-reservations-first, the fleet uses unused Capacity Reservations to fulfill On-Demand capacity up to the target On-Demand capacity. If multiple instance pools have unused Capacity Reservations, the On-Demand allocation strategy (lowest-price or prioritized) is applied. If the number of unused Capacity Reservations is less than the On-Demand target capacity, the remaining On-Demand target capacity is launched according to the On-Demand allocation strategy (lowest-price or prioritized).

If you do not specify a value, the fleet fulfils the On-Demand capacity according to the chosen On-Demand allocation strategy.

' - description: '

Describes the strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.

This strategy can only be used if the EC2 Fleet is of type instant.

For more information about Capacity Reservations, see On-Demand Capacity Reservations in the Amazon EC2 User Guide. For examples of using Capacity Reservations in an EC2 Fleet, see EC2 Fleet example configurations in the Amazon EC2 User Guide.

' - CapacityReservationPreference: - type: string - enum: - - open - - none - CapacityReservationSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/CapacityReservation' - - xml: - name: item - CapacityReservationSpecification: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/CapacityReservationTarget' - - description: Information about the target Capacity Reservation or Capacity Reservation group. - description: '

Describes an instance''s Capacity Reservation targeting option. You can specify only one parameter at a time. If you specify CapacityReservationPreference and CapacityReservationTarget, the request fails.

Use the CapacityReservationPreference parameter to configure the instance to run as an On-Demand Instance or to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). Use the CapacityReservationTarget parameter to explicitly target a specific Capacity Reservation or a Capacity Reservation group.

' - CapacityReservationTargetResponse: - type: object - properties: - capacityReservationId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the targeted Capacity Reservation. - capacityReservationResourceGroupArn: - allOf: - - $ref: '#/components/schemas/String' - - description: The ARN of the targeted Capacity Reservation group. - description: Describes a target Capacity Reservation or Capacity Reservation group. - CapacityReservationSpecificationResponse: - type: object - properties: - capacityReservationPreference: - allOf: - - $ref: '#/components/schemas/CapacityReservationPreference' - - description: '

Describes the instance''s Capacity Reservation preferences. Possible preferences include:

  • open - The instance can run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).

  • none - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity.

' - capacityReservationTarget: - allOf: - - $ref: '#/components/schemas/CapacityReservationTargetResponse' - - description: Information about the targeted Capacity Reservation or Capacity Reservation group. - description: 'Describes the instance''s Capacity Reservation targeting preferences. The action returns the capacityReservationPreference response element if the instance is configured to run in On-Demand capacity, or if it is configured in run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). The action returns the capacityReservationTarget response element if the instance explicily targets a specific Capacity Reservation or Capacity Reservation group.' - CarrierGatewayState: - type: string - enum: - - pending - - available - - deleting - - deleted - CarrierGateway: - type: object - properties: - carrierGatewayId: - allOf: - - $ref: '#/components/schemas/CarrierGatewayId' - - description: The ID of the carrier gateway. - vpcId: - allOf: - - $ref: '#/components/schemas/VpcId' - - description: The ID of the VPC associated with the carrier gateway. - state: - allOf: - - $ref: '#/components/schemas/CarrierGatewayState' - - description: The state of the carrier gateway. - ownerId: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Web Services account ID of the owner of the carrier gateway. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: The tags assigned to the carrier gateway. - description: Describes a carrier gateway. - CarrierGatewayIdSet: - type: array - items: - $ref: '#/components/schemas/CarrierGatewayId' - CarrierGatewayMaxResults: - type: integer - minimum: 5 - maximum: 1000 - CarrierGatewaySet: - type: array - items: - allOf: - - $ref: '#/components/schemas/CarrierGateway' - - xml: - name: item - CertificateAuthentication: - type: object - properties: - clientRootCertificateChain: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The ARN of the client certificate. ' - description: Information about the client certificate used for authentication. - CertificateAuthenticationRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The ARN of the client certificate. The certificate must be signed by a certificate authority (CA) and it must be provisioned in Certificate Manager (ACM). - description: Information about the client certificate to be used for authentication. - CidrAuthorizationContext: - type: object - required: - - Message - - Signature - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The signed authorization message for the prefix and account. - description: 'Provides authorization for Amazon to bring a specific IP address range to a specific Amazon Web Services account using bring your own IP addresses (BYOIP). For more information, see Configuring your BYOIP address range in the Amazon Elastic Compute Cloud User Guide.' - CidrBlock: - type: object - properties: - cidrBlock: - allOf: - - $ref: '#/components/schemas/String' - - description: The IPv4 CIDR block. - description: Describes an IPv4 CIDR block. - CidrBlockSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/CidrBlock' - - xml: - name: item - ClassicLinkDnsSupport: - type: object - properties: - classicLinkDnsSupported: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether ClassicLink DNS support is enabled for the VPC. - vpcId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the VPC. - description: Describes the ClassicLink DNS support status of a VPC. - ClassicLinkDnsSupportList: - type: array - items: - allOf: - - $ref: '#/components/schemas/ClassicLinkDnsSupport' - - xml: - name: item - GroupIdentifierList: - type: array - items: - allOf: - - $ref: '#/components/schemas/GroupIdentifier' - - xml: - name: item - ClassicLinkInstance: - type: object - properties: - groupSet: - allOf: - - $ref: '#/components/schemas/GroupIdentifierList' - - description: A list of security groups. - instanceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the instance. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: Any tags assigned to the instance. - vpcId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the VPC. - description: Describes a linked EC2-Classic instance. - ClassicLinkInstanceList: - type: array - items: - allOf: - - $ref: '#/components/schemas/ClassicLinkInstance' - - xml: - name: item - ClassicLoadBalancer: - type: object - properties: - name: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of the load balancer. - description: Describes a Classic Load Balancer. - ClassicLoadBalancers: - type: array - items: - allOf: - - $ref: '#/components/schemas/ClassicLoadBalancer' - - xml: - name: item - minItems: 1 - maxItems: 5 - ClassicLoadBalancersConfig: - type: object - properties: - classicLoadBalancers: - allOf: - - $ref: '#/components/schemas/ClassicLoadBalancers' - - description: One or more Classic Load Balancers. - description: Describes the Classic Load Balancers to attach to a Spot Fleet. Spot Fleet registers the running Spot Instances with these Classic Load Balancers. - ClientCertificateRevocationListStatusCode: - type: string - enum: - - pending - - active - ClientCertificateRevocationListStatus: - type: object - properties: - code: - allOf: - - $ref: '#/components/schemas/ClientCertificateRevocationListStatusCode' - - description: The state of the client certificate revocation list. - message: - allOf: - - $ref: '#/components/schemas/String' - - description: 'A message about the status of the client certificate revocation list, if applicable.' - description: Describes the state of a client certificate revocation list. - ClientConnectOptions: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Resource Name (ARN) of the Lambda function used for connection authorization. - description: The options for managing connection authorization for new client connections. - ClientVpnEndpointAttributeStatus: - type: object - properties: - code: - allOf: - - $ref: '#/components/schemas/ClientVpnEndpointAttributeStatusCode' - - description: The status code. - message: - allOf: - - $ref: '#/components/schemas/String' - - description: The status message. - description: Describes the status of the Client VPN endpoint attribute. - ClientConnectResponseOptions: - type: object - properties: - enabled: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether client connect options are enabled. - lambdaFunctionArn: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Resource Name (ARN) of the Lambda function used for connection authorization. - status: - allOf: - - $ref: '#/components/schemas/ClientVpnEndpointAttributeStatus' - - description: The status of any updates to the client connect options. - description: The options for managing connection authorization for new client connections. - ClientData: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The time that the disk upload starts. - description: Describes the client-specific data. - ClientLoginBannerOptions: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: Customizable text that will be displayed in a banner on Amazon Web Services provided clients when a VPN session is established. UTF-8 encoded characters only. Maximum of 1400 characters. - description: Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established. - ClientLoginBannerResponseOptions: - type: object - properties: - enabled: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: '

Current state of text banner feature.

Valid values: true | false

' - bannerText: - allOf: - - $ref: '#/components/schemas/String' - - description: Customizable text that will be displayed in a banner on Amazon Web Services provided clients when a VPN session is established. UTF-8 encoded characters only. Maximum of 1400 characters. - description: Current state of options for customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established. - ClientVpnAssociationId: - type: string - ClientVpnAuthenticationType: - type: string - enum: - - certificate-authentication - - directory-service-authentication - - federated-authentication - DirectoryServiceAuthentication: - type: object - properties: - directoryId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Active Directory used for authentication. - description: Describes an Active Directory. - FederatedAuthentication: - type: object - properties: - samlProviderArn: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Resource Name (ARN) of the IAM SAML identity provider. - selfServiceSamlProviderArn: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Resource Name (ARN) of the IAM SAML identity provider for the self-service portal. - description: Describes the IAM SAML identity providers used for federated authentication. - ClientVpnAuthentication: - type: object - properties: - type: - allOf: - - $ref: '#/components/schemas/ClientVpnAuthenticationType' - - description: The authentication type used. - activeDirectory: - allOf: - - $ref: '#/components/schemas/DirectoryServiceAuthentication' - - description: 'Information about the Active Directory, if applicable.' - mutualAuthentication: - allOf: - - $ref: '#/components/schemas/CertificateAuthentication' - - description: 'Information about the authentication certificates, if applicable.' - federatedAuthentication: - allOf: - - $ref: '#/components/schemas/FederatedAuthentication' - - description: 'Information about the IAM SAML identity provider, if applicable.' - description: 'Describes the authentication methods used by a Client VPN endpoint. For more information, see Authentication in the Client VPN Administrator Guide.' - ClientVpnAuthenticationList: - type: array - items: - allOf: - - $ref: '#/components/schemas/ClientVpnAuthentication' - - xml: - name: item - FederatedAuthenticationRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Resource Name (ARN) of the IAM SAML identity provider for the self-service portal. - description: The IAM SAML identity provider used for federated authentication. - ClientVpnAuthenticationRequestList: - type: array - items: - $ref: '#/components/schemas/ClientVpnAuthenticationRequest' - ClientVpnAuthorizationRuleStatusCode: - type: string - enum: - - authorizing - - active - - failed - - revoking - ClientVpnConnectionStatus: - type: object - properties: - code: - allOf: - - $ref: '#/components/schemas/ClientVpnConnectionStatusCode' - - description: The state of the client connection. - message: - allOf: - - $ref: '#/components/schemas/String' - - description: 'A message about the status of the client connection, if applicable.' - description: Describes the status of a client connection. - ValueStringList: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - ClientVpnConnection: - type: object - properties: - clientVpnEndpointId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Client VPN endpoint to which the client is connected. - timestamp: - allOf: - - $ref: '#/components/schemas/String' - - description: The current date and time. - connectionId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the client connection. - username: - allOf: - - $ref: '#/components/schemas/String' - - description: The username of the client who established the client connection. This information is only provided if Active Directory client authentication is used. - connectionEstablishedTime: - allOf: - - $ref: '#/components/schemas/String' - - description: The date and time the client connection was established. - ingressBytes: - allOf: - - $ref: '#/components/schemas/String' - - description: The number of bytes sent by the client. - egressBytes: - allOf: - - $ref: '#/components/schemas/String' - - description: The number of bytes received by the client. - ingressPackets: - allOf: - - $ref: '#/components/schemas/String' - - description: The number of packets sent by the client. - egressPackets: - allOf: - - $ref: '#/components/schemas/String' - - description: The number of packets received by the client. - clientIp: - allOf: - - $ref: '#/components/schemas/String' - - description: The IP address of the client. - commonName: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The common name associated with the client. This is either the name of the client certificate, or the Active Directory user name.' - status: - allOf: - - $ref: '#/components/schemas/ClientVpnConnectionStatus' - - description: The current state of the client connection. - connectionEndTime: - allOf: - - $ref: '#/components/schemas/String' - - description: The date and time the client connection was terminated. - postureComplianceStatusSet: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: 'The statuses returned by the client connect handler for posture compliance, if applicable.' - description: Describes a client connection. - ClientVpnConnectionSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/ClientVpnConnection' - - xml: - name: item - ClientVpnConnectionStatusCode: - type: string - enum: - - active - - failed-to-terminate - - terminating - - terminated - ClientVpnEndpointStatus: - type: object - properties: - code: - allOf: - - $ref: '#/components/schemas/ClientVpnEndpointStatusCode' - - description: '

The state of the Client VPN endpoint. Possible states include:

  • pending-associate - The Client VPN endpoint has been created but no target networks have been associated. The Client VPN endpoint cannot accept connections.

  • available - The Client VPN endpoint has been created and a target network has been associated. The Client VPN endpoint can accept connections.

  • deleting - The Client VPN endpoint is being deleted. The Client VPN endpoint cannot accept connections.

  • deleted - The Client VPN endpoint has been deleted. The Client VPN endpoint cannot accept connections.

' - message: - allOf: - - $ref: '#/components/schemas/String' - - description: A message about the status of the Client VPN endpoint. - description: Describes the state of a Client VPN endpoint. - VpnProtocol: - type: string - enum: - - openvpn - TransportProtocol: - type: string - enum: - - tcp - - udp - ConnectionLogResponseOptions: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of the Amazon CloudWatch Logs log stream to which connection logging data is published. - description: Information about the client connection logging options for a Client VPN endpoint. - ClientVpnEndpoint: - type: object - properties: - clientVpnEndpointId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Client VPN endpoint. - description: - allOf: - - $ref: '#/components/schemas/String' - - description: A brief description of the endpoint. - status: - allOf: - - $ref: '#/components/schemas/ClientVpnEndpointStatus' - - description: The current state of the Client VPN endpoint. - creationTime: - allOf: - - $ref: '#/components/schemas/String' - - description: The date and time the Client VPN endpoint was created. - deletionTime: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The date and time the Client VPN endpoint was deleted, if applicable.' - dnsName: - allOf: - - $ref: '#/components/schemas/String' - - description: The DNS name to be used by clients when connecting to the Client VPN endpoint. - clientCidrBlock: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The IPv4 address range, in CIDR notation, from which client IP addresses are assigned.' - dnsServer: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: 'Information about the DNS servers to be used for DNS resolution. ' - splitTunnel: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: '

Indicates whether split-tunnel is enabled in the Client VPN endpoint.

For information about split-tunnel VPN endpoints, see Split-Tunnel Client VPN endpoint in the Client VPN Administrator Guide.

' - vpnProtocol: - allOf: - - $ref: '#/components/schemas/VpnProtocol' - - description: The protocol used by the VPN session. - transportProtocol: - allOf: - - $ref: '#/components/schemas/TransportProtocol' - - description: The transport protocol used by the Client VPN endpoint. - vpnPort: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The port number for the Client VPN endpoint. - associatedTargetNetwork: - allOf: - - $ref: '#/components/schemas/AssociatedTargetNetworkSet' - - deprecated: true - description: 'Information about the associated target networks. A target network is a subnet in a VPC.This property is deprecated. To view the target networks associated with a Client VPN endpoint, call DescribeClientVpnTargetNetworks and inspect the clientVpnTargetNetworks response element.' - serverCertificateArn: - allOf: - - $ref: '#/components/schemas/String' - - description: The ARN of the server certificate. - authenticationOptions: - allOf: - - $ref: '#/components/schemas/ClientVpnAuthenticationList' - - description: Information about the authentication method used by the Client VPN endpoint. - connectionLogOptions: - allOf: - - $ref: '#/components/schemas/ConnectionLogResponseOptions' - - description: Information about the client connection logging options for the Client VPN endpoint. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: Any tags assigned to the Client VPN endpoint. - securityGroupIdSet: - allOf: - - $ref: '#/components/schemas/ClientVpnSecurityGroupIdSet' - - description: The IDs of the security groups for the target network. - vpcId: - allOf: - - $ref: '#/components/schemas/VpcId' - - description: The ID of the VPC. - selfServicePortalUrl: - allOf: - - $ref: '#/components/schemas/String' - - description: The URL of the self-service portal. - clientConnectOptions: - allOf: - - $ref: '#/components/schemas/ClientConnectResponseOptions' - - description: The options for managing connection authorization for new client connections. - sessionTimeoutHours: - allOf: - - $ref: '#/components/schemas/Integer' - - description: '

The maximum VPN session duration time in hours.

Valid values: 8 | 10 | 12 | 24

Default value: 24

' - clientLoginBannerOptions: - allOf: - - $ref: '#/components/schemas/ClientLoginBannerResponseOptions' - - description: Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established. - description: Describes a Client VPN endpoint. - ClientVpnEndpointAttributeStatusCode: - type: string - enum: - - applying - - applied - ClientVpnEndpointIdList: - type: array - items: - allOf: - - $ref: '#/components/schemas/ClientVpnEndpointId' - - xml: - name: item - ClientVpnEndpointStatusCode: - type: string - enum: - - pending-associate - - available - - deleting - - deleted - ClientVpnRouteStatus: - type: object - properties: - code: - allOf: - - $ref: '#/components/schemas/ClientVpnRouteStatusCode' - - description: The state of the Client VPN endpoint route. - message: - allOf: - - $ref: '#/components/schemas/String' - - description: 'A message about the status of the Client VPN endpoint route, if applicable.' - description: Describes the state of a Client VPN endpoint route. - ClientVpnRoute: - type: object - properties: - clientVpnEndpointId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Client VPN endpoint with which the route is associated. - destinationCidr: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The IPv4 address range, in CIDR notation, of the route destination.' - targetSubnet: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the subnet through which traffic is routed. - type: - allOf: - - $ref: '#/components/schemas/String' - - description: The route type. - origin: - allOf: - - $ref: '#/components/schemas/String' - - description: Indicates how the route was associated with the Client VPN endpoint. associate indicates that the route was automatically added when the target network was associated with the Client VPN endpoint. add-route indicates that the route was manually added using the CreateClientVpnRoute action. - status: - allOf: - - $ref: '#/components/schemas/ClientVpnRouteStatus' - - description: The current state of the route. - description: - allOf: - - $ref: '#/components/schemas/String' - - description: A brief description of the route. - description: Information about a Client VPN endpoint route. - ClientVpnRouteSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/ClientVpnRoute' - - xml: - name: item - ClientVpnRouteStatusCode: - type: string - enum: - - creating - - active - - failed - - deleting - CoipAddressUsage: - type: object - properties: - allocationId: - allOf: - - $ref: '#/components/schemas/String' - - description: The allocation ID of the address. - awsAccountId: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Web Services account ID. - awsService: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Web Services service. - coIp: - allOf: - - $ref: '#/components/schemas/String' - - description: The customer-owned IP address. - description: Describes address usage for a customer-owned address pool. - CoipAddressUsageSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/CoipAddressUsage' - - xml: - name: item - CoipPool: - type: object - properties: - poolId: - allOf: - - $ref: '#/components/schemas/Ipv4PoolCoipId' - - description: The ID of the address pool. - poolCidrSet: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The address ranges of the address pool. - localGatewayRouteTableId: - allOf: - - $ref: '#/components/schemas/LocalGatewayRoutetableId' - - description: The ID of the local gateway route table. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: The tags. - poolArn: - allOf: - - $ref: '#/components/schemas/ResourceArn' - - description: The ARN of the address pool. - description: Describes a customer-owned address pool. - CoipPoolId: - type: string - CoipPoolIdSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/Ipv4PoolCoipId' - - xml: - name: item - CoipPoolMaxResults: - type: integer - minimum: 5 - maximum: 1000 - CoipPoolSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/CoipPool' - - xml: - name: item - ConfirmProductInstanceRequest: - type: object - required: - - InstanceId - - ProductCode - title: ConfirmProductInstanceRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The product code. This must be a product code that you own. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - ConnectionLogOptions: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of the CloudWatch Logs log stream to which the connection data is published. - description: Describes the client connection logging options for the Client VPN endpoint. - ConnectionNotificationType: - type: string - enum: - - Topic - ConnectionNotificationState: - type: string - enum: - - Enabled - - Disabled - ConnectionNotification: - type: object - properties: - connectionNotificationId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the notification. - serviceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the endpoint service. - vpcEndpointId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the VPC endpoint. - connectionNotificationType: - allOf: - - $ref: '#/components/schemas/ConnectionNotificationType' - - description: The type of notification. - connectionNotificationArn: - allOf: - - $ref: '#/components/schemas/String' - - description: The ARN of the SNS topic for the notification. - connectionEvents: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: 'The events for the notification. Valid values are Accept, Connect, Delete, and Reject.' - connectionNotificationState: - allOf: - - $ref: '#/components/schemas/ConnectionNotificationState' - - description: The state of the notification. - description: Describes a connection notification for a VPC endpoint or VPC endpoint service. - ConnectionNotificationIdsList: - type: array - items: - allOf: - - $ref: '#/components/schemas/ConnectionNotificationId' - - xml: - name: item - ConnectionNotificationSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/ConnectionNotification' - - xml: - name: item - ConnectivityType: - type: string - enum: - - private - - public - ConversionIdStringList: - type: array - items: - allOf: - - $ref: '#/components/schemas/ConversionTaskId' - - xml: - name: item - ImportInstanceTaskDetails: - type: object - properties: - description: - allOf: - - $ref: '#/components/schemas/String' - - description: A description of the task. - instanceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the instance. - platform: - allOf: - - $ref: '#/components/schemas/PlatformValues' - - description: The instance operating system. - volumes: - allOf: - - $ref: '#/components/schemas/ImportInstanceVolumeDetailSet' - - description: The volumes. - description: Describes an import instance task. - ImportVolumeTaskDetails: - type: object - properties: - availabilityZone: - allOf: - - $ref: '#/components/schemas/String' - - description: The Availability Zone where the resulting volume will reside. - bytesConverted: - allOf: - - $ref: '#/components/schemas/Long' - - description: The number of bytes converted so far. - description: - allOf: - - $ref: '#/components/schemas/String' - - description: The description you provided when starting the import volume task. - image: - allOf: - - $ref: '#/components/schemas/DiskImageDescription' - - description: The image. - volume: - allOf: - - $ref: '#/components/schemas/DiskImageVolumeDescription' - - description: The volume. - description: Describes an import volume task. - ConversionTaskState: - type: string - enum: - - active - - cancelling - - cancelled - - completed - ConversionTask: - type: object - properties: - conversionTaskId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the conversion task. - expirationTime: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The time when the task expires. If the upload isn''t complete before the expiration time, we automatically cancel the task.' - importInstance: - allOf: - - $ref: '#/components/schemas/ImportInstanceTaskDetails' - - description: 'If the task is for importing an instance, this contains information about the import instance task.' - importVolume: - allOf: - - $ref: '#/components/schemas/ImportVolumeTaskDetails' - - description: 'If the task is for importing a volume, this contains information about the import volume task.' - state: - allOf: - - $ref: '#/components/schemas/ConversionTaskState' - - description: The state of the conversion task. - statusMessage: - allOf: - - $ref: '#/components/schemas/String' - - description: The status message related to the conversion task. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: Any tags assigned to the task. - description: Describes a conversion task. - CopyFpgaImageRequest: - type: object - required: - - SourceFpgaImageId - - SourceRegion - title: CopyFpgaImageRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.' - CopyImageRequest: - type: object - required: - - Name - - SourceImageId - - SourceRegion - title: CopyImageRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: A description for the new AMI in the destination Region. - encrypted: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Specifies whether the destination snapshots of the copied image should be encrypted. You can encrypt a copy of an unencrypted snapshot, but you cannot create an unencrypted copy of an encrypted snapshot. The default KMS key for Amazon EBS is used unless you specify a non-default Key Management Service (KMS) KMS key using KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.' - kmsKeyId: - allOf: - - $ref: '#/components/schemas/String' - - description: '

The Amazon Resource Name (ARN) of the Outpost to which to copy the AMI. Only specify this parameter when copying an AMI from an Amazon Web Services Region to an Outpost. The AMI must be in the Region of the destination Outpost. You cannot copy an AMI from an Outpost to a Region, from one Outpost to another, or within the same Outpost.

For more information, see Copying AMIs from an Amazon Web Services Region to an Outpost in the Amazon Elastic Compute Cloud User Guide.

' - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - description: Contains the parameters for CopyImage. - KmsKeyId: - type: string - CopySnapshotRequest: - type: object - required: - - SourceRegion - - SourceSnapshotId - title: CopySnapshotRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: '

The Amazon Resource Name (ARN) of the Outpost to which to copy the snapshot. Only specify this parameter when copying a snapshot from an Amazon Web Services Region to an Outpost. The snapshot must be in the Region for the destination Outpost. You cannot copy a snapshot from an Outpost to a Region, from one Outpost to another, or within the same Outpost.

For more information, see Copy snapshots from an Amazon Web Services Region to an Outpost in the Amazon Elastic Compute Cloud User Guide.

' - destinationRegion: - allOf: - - $ref: '#/components/schemas/String' - - description: '

The destination Region to use in the PresignedUrl parameter of a snapshot copy operation. This parameter is only valid for specifying the destination Region in a PresignedUrl parameter, where it is required.

The snapshot copy is sent to the regional endpoint that you sent the HTTP request to (for example, ec2.us-east-1.amazonaws.com). With the CLI, this is specified using the --region parameter or the default Region in your Amazon Web Services configuration file.

' - encrypted: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter. Otherwise, omit this parameter. Encrypted snapshots are encrypted, even if you omit this parameter and encryption by default is not enabled. You cannot set this parameter to false. For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.' - kmsKeyId: - allOf: - - $ref: '#/components/schemas/KmsKeyId' - - description: '

The identifier of the Key Management Service (KMS) KMS key to use for Amazon EBS encryption. If this parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId is specified, the encrypted state must be true.

You can specify the KMS key using any of the following:

  • Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.

  • Key alias. For example, alias/ExampleAlias.

  • Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.

  • Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.

' - presignedUrl: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the EBS snapshot to copy. - TagSpecification: - allOf: - - $ref: '#/components/schemas/TagSpecificationList' - - description: The tags to apply to the new snapshot. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - CopyTagsFromSource: - type: string - enum: - - volume - CoreCount: - type: integer - CoreCountList: - type: array - items: - allOf: - - $ref: '#/components/schemas/CoreCount' - - xml: - name: item - CoreNetworkArn: - type: string - CpuManufacturer: - type: string - enum: - - intel - - amd - - amazon-web-services - CpuManufacturerSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/CpuManufacturer' - - xml: - name: item - CpuOptions: - type: object - properties: - coreCount: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The number of CPU cores for the instance. - threadsPerCore: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The number of threads per CPU core. - description: The CPU options for the instance. - CpuOptionsRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The number of threads per CPU core. To disable multithreading for the instance, specify a value of 1. Otherwise, specify the default value of 2.' - description: The CPU options for the instance. Both the core count and threads per core must be specified in the request. - CreateCapacityReservationFleetRequest: - type: object - required: - - InstanceTypeSpecifications - - TotalTargetCapacity - title: CreateCapacityReservationFleetRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.' - InstanceTypeSpecification: - allOf: - - $ref: '#/components/schemas/FleetInstanceMatchCriteria' - - description: '

Indicates the type of instance launches that the Capacity Reservation Fleet accepts. All Capacity Reservations in the Fleet inherit this instance matching criteria.

Currently, Capacity Reservation Fleets support open instance matching criteria only. This means that instances that have matching attributes (instance type, platform, and Availability Zone) run in the Capacity Reservations automatically. Instances do not need to explicitly target a Capacity Reservation Fleet to use its reserved capacity.

' - TagSpecification: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - CreateCapacityReservationRequest: - type: object - required: - - InstanceType - - InstancePlatform - - InstanceCount - title: CreateCapacityReservationRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/PlacementGroupArn' - - description: 'The Amazon Resource Name (ARN) of the cluster placement group in which to create the Capacity Reservation. For more information, see Capacity Reservations for cluster placement groups in the Amazon EC2 User Guide.' - CreateCarrierGatewayRequest: - type: object - required: - - VpcId - title: CreateCarrierGatewayRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/VpcId' - - description: The ID of the VPC to associate with the carrier gateway. - TagSpecification: - allOf: - - $ref: '#/components/schemas/String' - - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.' - CreateClientVpnEndpointRequest: - type: object - required: - - ClientCidrBlock - - ServerCertificateArn - - AuthenticationOptions - - ConnectionLogOptions - title: CreateClientVpnEndpointRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The ARN of the server certificate. For more information, see the Certificate Manager User Guide.' - Authentication: - allOf: - - $ref: '#/components/schemas/String' - - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.' - TagSpecification: - allOf: - - $ref: '#/components/schemas/TagSpecificationList' - - description: The tags to apply to the Client VPN endpoint during creation. - SecurityGroupId: - allOf: - - $ref: '#/components/schemas/ClientLoginBannerOptions' - - description: Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established. - CreateClientVpnRouteRequest: - type: object - required: - - ClientVpnEndpointId - - DestinationCidrBlock - - TargetVpcSubnetId - title: CreateClientVpnRouteRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - GatewayType: - type: string - enum: - - ipsec.1 - CreateCustomerGatewayRequest: - type: object - required: - - BgpAsn - - Type - title: CreateCustomerGatewayRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Integer' - - description: '

For devices that support BGP, the customer gateway''s BGP ASN.

Default: 65000

' - IpAddress: - allOf: - - $ref: '#/components/schemas/GatewayType' - - description: The type of VPN connection that this customer gateway supports (ipsec.1). - TagSpecification: - allOf: - - $ref: '#/components/schemas/String' - - description: '

A name for the customer gateway device.

Length Constraints: Up to 255 characters.

' - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - description: Contains the parameters for CreateCustomerGateway. - CustomerGateway: - type: object - properties: - bgpAsn: - allOf: - - $ref: '#/components/schemas/String' - - description: The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN). - customerGatewayId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the customer gateway. - ipAddress: - allOf: - - $ref: '#/components/schemas/String' - - description: The Internet-routable IP address of the customer gateway's outside interface. - certificateArn: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Resource Name (ARN) for the customer gateway certificate. - state: - allOf: - - $ref: '#/components/schemas/String' - - description: The current state of the customer gateway (pending | available | deleting | deleted). - type: - allOf: - - $ref: '#/components/schemas/String' - - description: The type of VPN connection the customer gateway supports (ipsec.1). - deviceName: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of customer gateway device. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: Any tags assigned to the customer gateway. - description: Describes a customer gateway. - CreateDefaultSubnetRequest: - type: object - required: - - AvailabilityZone - title: CreateDefaultSubnetRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Indicates whether to create an IPv6 only subnet. If you already have a default subnet for this Availability Zone, you must delete it before you can create an IPv6 only subnet.' - Subnet: - type: object - properties: - availabilityZone: - allOf: - - $ref: '#/components/schemas/String' - - description: The Availability Zone of the subnet. - availabilityZoneId: - allOf: - - $ref: '#/components/schemas/String' - - description: The AZ ID of the subnet. - availableIpAddressCount: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The number of unused private IPv4 addresses in the subnet. The IPv4 addresses for any stopped instances are considered unavailable. - cidrBlock: - allOf: - - $ref: '#/components/schemas/String' - - description: The IPv4 CIDR block assigned to the subnet. - defaultForAz: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether this is the default subnet for the Availability Zone. - enableLniAtDeviceIndex: - allOf: - - $ref: '#/components/schemas/Integer' - - description: ' Indicates the device position for local network interfaces in this subnet. For example, 1 indicates local network interfaces in this subnet are the secondary network interface (eth1). ' - mapPublicIpOnLaunch: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether instances launched in this subnet receive a public IPv4 address. - mapCustomerOwnedIpOnLaunch: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives a customer-owned IPv4 address. - customerOwnedIpv4Pool: - allOf: - - $ref: '#/components/schemas/CoipPoolId' - - description: The customer-owned IPv4 address pool associated with the subnet. - state: - allOf: - - $ref: '#/components/schemas/SubnetState' - - description: The current state of the subnet. - subnetId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the subnet. - vpcId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the VPC the subnet is in. - ownerId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Amazon Web Services account that owns the subnet. - assignIpv6AddressOnCreation: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives an IPv6 address. - ipv6CidrBlockAssociationSet: - allOf: - - $ref: '#/components/schemas/SubnetIpv6CidrBlockAssociationSet' - - description: Information about the IPv6 CIDR blocks associated with the subnet. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: Any tags assigned to the subnet. - subnetArn: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Resource Name (ARN) of the subnet. - outpostArn: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Resource Name (ARN) of the Outpost. - enableDns64: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations. - ipv6Native: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether this is an IPv6 only subnet. - privateDnsNameOptionsOnLaunch: - allOf: - - $ref: '#/components/schemas/PrivateDnsNameOptionsOnLaunch' - - description: The type of hostnames to assign to instances in the subnet at launch. An instance hostname is based on the IPv4 address or ID of the instance. - description: Describes a subnet. - CreateDefaultVpcRequest: - type: object - title: CreateDefaultVpcRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - Vpc: - type: object - properties: - cidrBlock: - allOf: - - $ref: '#/components/schemas/String' - - description: The primary IPv4 CIDR block for the VPC. - dhcpOptionsId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the set of DHCP options you've associated with the VPC. - state: - allOf: - - $ref: '#/components/schemas/VpcState' - - description: The current state of the VPC. - vpcId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the VPC. - ownerId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Amazon Web Services account that owns the VPC. - instanceTenancy: - allOf: - - $ref: '#/components/schemas/Tenancy' - - description: The allowed tenancy of instances launched into the VPC. - ipv6CidrBlockAssociationSet: - allOf: - - $ref: '#/components/schemas/VpcIpv6CidrBlockAssociationSet' - - description: Information about the IPv6 CIDR blocks associated with the VPC. - cidrBlockAssociationSet: - allOf: - - $ref: '#/components/schemas/VpcCidrBlockAssociationSet' - - description: Information about the IPv4 CIDR blocks associated with the VPC. - isDefault: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether the VPC is the default VPC. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: Any tags assigned to the VPC. - description: Describes a VPC. - NewDhcpConfigurationList: - type: array - items: - allOf: - - $ref: '#/components/schemas/NewDhcpConfiguration' - - xml: - name: item - CreateDhcpOptionsRequest: - type: object - required: - - DhcpConfigurations - title: CreateDhcpOptionsRequest - properties: - dhcpConfiguration: - allOf: - - $ref: '#/components/schemas/NewDhcpConfigurationList' - - description: A DHCP configuration option. - TagSpecification: - allOf: - - $ref: '#/components/schemas/TagSpecificationList' - - description: The tags to assign to the DHCP option. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - DhcpOptions: - type: object - properties: - dhcpConfigurationSet: - allOf: - - $ref: '#/components/schemas/DhcpConfigurationList' - - description: One or more DHCP options in the set. - dhcpOptionsId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the set of DHCP options. - ownerId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Amazon Web Services account that owns the DHCP options set. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: Any tags assigned to the DHCP options set. - description: Describes a set of DHCP options. - CreateEgressOnlyInternetGatewayRequest: - type: object - required: - - VpcId - title: CreateEgressOnlyInternetGatewayRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/VpcId' - - description: The ID of the VPC for which to create the egress-only internet gateway. - TagSpecification: - allOf: - - $ref: '#/components/schemas/TagSpecificationList' - - description: The tags to assign to the egress-only internet gateway. - EgressOnlyInternetGateway: - type: object - properties: - attachmentSet: - allOf: - - $ref: '#/components/schemas/InternetGatewayAttachmentList' - - description: Information about the attachment of the egress-only internet gateway. - egressOnlyInternetGatewayId: - allOf: - - $ref: '#/components/schemas/EgressOnlyInternetGatewayId' - - description: The ID of the egress-only internet gateway. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: The tags assigned to the egress-only internet gateway. - description: Describes an egress-only internet gateway. - LaunchTemplateAndOverridesResponse: - type: object - properties: - launchTemplateSpecification: - allOf: - - $ref: '#/components/schemas/FleetLaunchTemplateSpecification' - - description: The launch template. - overrides: - allOf: - - $ref: '#/components/schemas/FleetLaunchTemplateOverrides' - - description: Any parameters that you specify override the same parameters in the launch template. - description: Describes a launch template and overrides. - InstanceLifecycle: - type: string - enum: - - spot - - on-demand - CreateFleetError: - type: object - properties: - launchTemplateAndOverrides: - allOf: - - $ref: '#/components/schemas/LaunchTemplateAndOverridesResponse' - - description: The launch templates and overrides that were used for launching the instances. The values that you specify in the Overrides replace the values in the launch template. - lifecycle: - allOf: - - $ref: '#/components/schemas/InstanceLifecycle' - - description: Indicates if the instance that could not be launched was a Spot Instance or On-Demand Instance. - errorCode: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The error code that indicates why the instance could not be launched. For more information about error codes, see Error codes.' - errorMessage: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The error message that describes why the instance could not be launched. For more information about error messages, see Error codes.' - description: Describes the instances that could not be launched by the fleet. - CreateFleetErrorsSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/CreateFleetError' - - xml: - name: item - InstanceIdsSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/InstanceId' - - xml: - name: item - PlatformValues: - type: string - enum: - - Windows - CreateFleetInstance: - type: object - properties: - launchTemplateAndOverrides: - allOf: - - $ref: '#/components/schemas/LaunchTemplateAndOverridesResponse' - - description: The launch templates and overrides that were used for launching the instances. The values that you specify in the Overrides replace the values in the launch template. - lifecycle: - allOf: - - $ref: '#/components/schemas/InstanceLifecycle' - - description: Indicates if the instance that was launched is a Spot Instance or On-Demand Instance. - instanceIds: - allOf: - - $ref: '#/components/schemas/InstanceIdsSet' - - description: The IDs of the instances. - instanceType: - allOf: - - $ref: '#/components/schemas/InstanceType' - - description: The instance type. - platform: - allOf: - - $ref: '#/components/schemas/PlatformValues' - - description: 'The value is Windows for Windows instances. Otherwise, the value is blank.' - description: Describes the instances that were launched by the fleet. - CreateFleetInstancesSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/CreateFleetInstance' - - xml: - name: item - CreateFleetRequest: - type: object - required: - - LaunchTemplateConfigs - - TargetCapacitySpecification - title: CreateFleetRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Indicates whether EC2 Fleet should replace unhealthy Spot Instances. Supported only for fleets of type maintain. For more information, see EC2 Fleet health checks in the Amazon EC2 User Guide.' - TagSpecification: - allOf: - - $ref: '#/components/schemas/String' - - description: Reserved. - DestinationOptionsRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether to partition the flow log per hour. This reduces the cost and response time for queries. The default is false. - description: Describes the destination options for a flow log. - CreateFlowLogsRequest: - type: object - required: - - ResourceIds - - ResourceType - - TrafficType - title: CreateFlowLogsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: '

The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs.

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

' - ResourceId: - allOf: - - $ref: '#/components/schemas/String' - - description: '

The fields to include in the flow log record, in the order in which they should appear. For a list of available fields, see Flow log records. If you omit this parameter, the flow log is created using the default format. If you specify this parameter, you must specify at least one field.

Specify the fields using the ${field-id} format, separated by spaces. For the CLI, surround this parameter value with single quotes on Linux or double quotes on Windows.

' - TagSpecification: - allOf: - - $ref: '#/components/schemas/DestinationOptionsRequest' - - description: The destination options. - CreateFpgaImageRequest: - type: object - required: - - InputStorageLocation - title: CreateFpgaImageRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.' - TagSpecification: - allOf: - - $ref: '#/components/schemas/TagSpecificationList' - - description: The tags to apply to the FPGA image during creation. - CreateImageRequest: - type: object - required: - - InstanceId - - Name - title: CreateImageRequest - properties: - blockDeviceMapping: - allOf: - - $ref: '#/components/schemas/BlockDeviceMappingRequestList' - - description: 'The block device mappings. This parameter cannot be used to modify the encryption status of existing volumes or snapshots. To create an AMI with encrypted snapshots, use the CopyImage action.' - description: - allOf: - - $ref: '#/components/schemas/String' - - description: A description for the new image. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - instanceId: - allOf: - - $ref: '#/components/schemas/InstanceId' - - description: The ID of the instance. - name: - allOf: - - $ref: '#/components/schemas/String' - - description: '

A name for the new image.

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes (''), at-signs (@), or underscores(_)

' - noReboot: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: '

By default, when Amazon EC2 creates the new AMI, it reboots the instance so that it can take snapshots of the attached volumes while data is at rest, in order to ensure a consistent state. You can set the NoReboot parameter to true in the API request, or use the --no-reboot option in the CLI to prevent Amazon EC2 from shutting down and rebooting the instance.

If you choose to bypass the shutdown and reboot process by setting the NoReboot parameter to true in the API request, or by using the --no-reboot option in the CLI, we can''t guarantee the file system integrity of the created image.

Default: false (follow standard reboot process)

' - TagSpecification: - allOf: - - $ref: '#/components/schemas/TagSpecificationList' - - description: '

The tags to apply to the AMI and snapshots on creation. You can tag the AMI, the snapshots, or both.

  • To tag the AMI, the value for ResourceType must be image.

  • To tag the snapshots that are created of the root volume and of other Amazon EBS volumes that are attached to the instance, the value for ResourceType must be snapshot. The same tag is applied to all of the snapshots that are created.

If you specify other values for ResourceType, the request fails.

To tag an AMI or snapshot after it has been created, see CreateTags.

' - InstanceEventWindowCronExpression: - type: string - CreateInstanceEventWindowRequest: - type: object - title: CreateInstanceEventWindowRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of the event window. - TimeRange: - allOf: - - $ref: '#/components/schemas/InstanceEventWindowCronExpression' - - description: '

The cron expression for the event window, for example, * 0-4,20-23 * * 1,5. If you specify a cron expression, you can''t specify a time range.

Constraints:

  • Only hour and day of the week values are supported.

  • For day of the week values, you can specify either integers 0 through 6, or alternative single values SUN through SAT.

  • The minute, month, and year must be specified by *.

  • The hour value must be one or a multiple range, for example, 0-4 or 0-4,20-23.

  • Each hour range must be >= 2 hours, for example, 0-2 or 20-23.

  • The event window must be >= 4 hours. The combined total time ranges in the event window must be >= 4 hours.

For more information about cron expressions, see cron on the Wikipedia website.

' - TagSpecification: - allOf: - - $ref: '#/components/schemas/TagSpecificationList' - - description: The tags to apply to the event window. - ExportToS3TaskSpecification: - type: object - properties: - containerFormat: - allOf: - - $ref: '#/components/schemas/ContainerFormat' - - description: 'The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.' - diskImageFormat: - allOf: - - $ref: '#/components/schemas/DiskImageFormat' - - description: The format for the exported image. - s3Bucket: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACP permissions to the Amazon Web Services account vm-import-export@amazon.com. - s3Prefix: - allOf: - - $ref: '#/components/schemas/String' - - description: The image is written to a single object in the Amazon S3 bucket at the S3 key s3prefix + exportTaskId + '.' + diskImageFormat. - description: Describes an export instance task. - ExportEnvironment: - type: string - enum: - - citrix - - vmware - - microsoft - CreateInstanceExportTaskRequest: - type: object - required: - - ExportToS3Task - - InstanceId - - TargetEnvironment - title: CreateInstanceExportTaskRequest - properties: - description: - allOf: - - $ref: '#/components/schemas/String' - - description: A description for the conversion task or the resource being exported. The maximum length is 255 characters. - exportToS3: - allOf: - - $ref: '#/components/schemas/ExportToS3TaskSpecification' - - description: The format and location for an export instance task. - instanceId: - allOf: - - $ref: '#/components/schemas/InstanceId' - - description: The ID of the instance. - targetEnvironment: - allOf: - - $ref: '#/components/schemas/ExportEnvironment' - - description: The target virtualization environment. - TagSpecification: - allOf: - - $ref: '#/components/schemas/TagSpecificationList' - - description: The tags to apply to the export instance task during creation. - ExportTask: - type: object - properties: - description: - allOf: - - $ref: '#/components/schemas/String' - - description: A description of the resource being exported. - exportTaskId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the export task. - exportToS3: - allOf: - - $ref: '#/components/schemas/ExportToS3Task' - - description: Information about the export task. - instanceExport: - allOf: - - $ref: '#/components/schemas/InstanceExportDetails' - - description: Information about the instance to export. - state: - allOf: - - $ref: '#/components/schemas/ExportTaskState' - - description: The state of the export task. - statusMessage: - allOf: - - $ref: '#/components/schemas/String' - - description: The status message related to the export task. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: The tags for the export task. - description: Describes an export instance task. - CreateInternetGatewayRequest: - type: object - title: CreateInternetGatewayRequest - properties: - TagSpecification: - allOf: - - $ref: '#/components/schemas/TagSpecificationList' - - description: The tags to assign to the internet gateway. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - InternetGateway: - type: object - properties: - attachmentSet: - allOf: - - $ref: '#/components/schemas/InternetGatewayAttachmentList' - - description: Any VPCs attached to the internet gateway. - internetGatewayId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the internet gateway. - ownerId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Amazon Web Services account that owns the internet gateway. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: Any tags assigned to the internet gateway. - description: Describes an internet gateway. - IpamNetmaskLength: - type: integer - minimum: 0 - maximum: 128 - RequestIpamResourceTagList: - type: array - items: - allOf: - - $ref: '#/components/schemas/RequestIpamResourceTag' - - xml: - name: item - IpamPoolAwsService: - type: string - enum: - - ec2 - CreateIpamPoolRequest: - type: object - required: - - IpamScopeId - - AddressFamily - title: CreateIpamPoolRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/IpamNetmaskLength' - - description: 'The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.' - AllocationResourceTag: - allOf: - - $ref: '#/components/schemas/RequestIpamResourceTagList' - - description: 'Tags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.' - TagSpecification: - allOf: - - $ref: '#/components/schemas/IpamPoolAwsService' - - description: 'Limits which service in Amazon Web Services that the pool can be used in. "ec2", for example, allows users to use space for Elastic IP addresses and VPCs.' - IpamPool: - type: object - properties: - ownerId: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Web Services account ID of the owner of the IPAM pool. - ipamPoolId: - allOf: - - $ref: '#/components/schemas/IpamPoolId' - - description: The ID of the IPAM pool. - sourceIpamPoolId: - allOf: - - $ref: '#/components/schemas/IpamPoolId' - - description: The ID of the source IPAM pool. You can use this option to create an IPAM pool within an existing source pool. - ipamPoolArn: - allOf: - - $ref: '#/components/schemas/ResourceArn' - - description: The ARN of the IPAM pool. - ipamScopeArn: - allOf: - - $ref: '#/components/schemas/ResourceArn' - - description: The ARN of the scope of the IPAM pool. - ipamScopeType: - allOf: - - $ref: '#/components/schemas/IpamScopeType' - - description: 'In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.' - ipamArn: - allOf: - - $ref: '#/components/schemas/ResourceArn' - - description: The ARN of the IPAM. - ipamRegion: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Web Services Region of the IPAM pool. - locale: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The locale of the IPAM pool. In IPAM, the locale is the Amazon Web Services Region where you want to make an IPAM pool available for allocations. Only resources in the same Region as the locale of the pool can get IP address allocations from the pool. You can only allocate a CIDR for a VPC, for example, from an IPAM pool that shares a locale with the VPC’s Region. Note that once you choose a Locale for a pool, you cannot modify it. If you choose an Amazon Web Services Region for locale that has not been configured as an operating Region for the IPAM, you''ll get an error.' - poolDepth: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The depth of pools in your IPAM pool. The pool depth quota is 10. For more information, see Quotas in IPAM in the Amazon VPC IPAM User Guide. ' - state: - allOf: - - $ref: '#/components/schemas/IpamPoolState' - - description: The state of the IPAM pool. - stateMessage: - allOf: - - $ref: '#/components/schemas/String' - - description: A message related to the failed creation of an IPAM pool. - description: - allOf: - - $ref: '#/components/schemas/String' - - description: The description of the IPAM pool. - autoImport: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: '

If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool''s allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.

A locale must be set on the pool for this feature to work.

' - publiclyAdvertisable: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Determines if a pool is publicly advertisable. This option is not available for pools with AddressFamily set to ipv4. - addressFamily: - allOf: - - $ref: '#/components/schemas/AddressFamily' - - description: The address family of the pool. - allocationMinNetmaskLength: - allOf: - - $ref: '#/components/schemas/IpamNetmaskLength' - - description: The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. The minimum netmask length must be less than the maximum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128. - allocationMaxNetmaskLength: - allOf: - - $ref: '#/components/schemas/IpamNetmaskLength' - - description: The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. The maximum netmask length must be greater than the minimum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128. - allocationDefaultNetmaskLength: - allOf: - - $ref: '#/components/schemas/IpamNetmaskLength' - - description: 'The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.' - allocationResourceTagSet: - allOf: - - $ref: '#/components/schemas/IpamResourceTagList' - - description: 'Tags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.' - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: '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. 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.' - awsService: - allOf: - - $ref: '#/components/schemas/IpamPoolAwsService' - - description: 'Limits which service in Amazon Web Services that the pool can be used in. "ec2", for example, allows users to use space for Elastic IP addresses and VPCs.' - description: 'In IPAM, a pool is a collection of contiguous IP addresses CIDRs. Pools enable you to organize your IP addresses according to your routing and security needs. For example, if you have separate routing and security needs for development and production applications, you can create a pool for each.' - CreateIpamRequest: - type: object - title: CreateIpamRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: A description for the IPAM. - OperatingRegion: - allOf: - - $ref: '#/components/schemas/AddIpamOperatingRegionSet' - - description: '

The operating Regions for the IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.

' - TagSpecification: - allOf: - - $ref: '#/components/schemas/String' - - description: 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.' - Ipam: - type: object - properties: - ownerId: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Web Services account ID of the owner of the IPAM. - ipamId: - allOf: - - $ref: '#/components/schemas/IpamId' - - description: The ID of the IPAM. - ipamArn: - allOf: - - $ref: '#/components/schemas/ResourceArn' - - description: The ARN of the IPAM. - ipamRegion: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Web Services Region of the IPAM. - publicDefaultScopeId: - allOf: - - $ref: '#/components/schemas/IpamScopeId' - - description: The ID of the IPAM's default public scope. - privateDefaultScopeId: - allOf: - - $ref: '#/components/schemas/IpamScopeId' - - description: The ID of the IPAM's default private scope. - scopeCount: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The number of scopes in the IPAM. The scope quota is 5. For more information on quotas, see Quotas in IPAM in the Amazon VPC IPAM User Guide. ' - description: - allOf: - - $ref: '#/components/schemas/String' - - description: The description for the IPAM. - operatingRegionSet: - allOf: - - $ref: '#/components/schemas/IpamOperatingRegionSet' - - description: '

The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.

' - state: - allOf: - - $ref: '#/components/schemas/IpamState' - - description: The state of the IPAM. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: '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. 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.' - description: 'IPAM is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts throughout your Amazon Web Services Organization. For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.' - CreateIpamScopeRequest: - type: object - required: - - IpamId - title: CreateIpamScopeRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: A description for the scope you're creating. - TagSpecification: - allOf: - - $ref: '#/components/schemas/String' - - description: 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.' - IpamScope: - type: object - properties: - ownerId: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Web Services account ID of the owner of the scope. - ipamScopeId: - allOf: - - $ref: '#/components/schemas/IpamScopeId' - - description: The ID of the scope. - ipamScopeArn: - allOf: - - $ref: '#/components/schemas/ResourceArn' - - description: The ARN of the scope. - ipamArn: - allOf: - - $ref: '#/components/schemas/ResourceArn' - - description: The ARN of the IPAM. - ipamRegion: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Web Services Region of the IPAM scope. - ipamScopeType: - allOf: - - $ref: '#/components/schemas/IpamScopeType' - - description: The type of the scope. - isDefault: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Defines if the scope is the default scope or not. - description: - allOf: - - $ref: '#/components/schemas/String' - - description: The description of the scope. - poolCount: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The number of pools in the scope. - state: - allOf: - - $ref: '#/components/schemas/IpamScopeState' - - description: The state of the IPAM scope. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: '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. 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.' - description: '

In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.

For more information, see How IPAM works in the Amazon VPC IPAM User Guide.

' - KeyType: - type: string - enum: - - rsa - - ed25519 - KeyFormat: - type: string - enum: - - pem - - ppk - CreateKeyPairRequest: - type: object - required: - - KeyName - title: CreateKeyPairRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: '

A unique name for the key pair.

Constraints: Up to 255 ASCII characters

' - dryRun: - allOf: - - $ref: '#/components/schemas/KeyType' - - description: '

The type of key pair. Note that ED25519 keys are not supported for Windows instances.

Default: rsa

' - TagSpecification: - allOf: - - $ref: '#/components/schemas/KeyFormat' - - description: '

The format of the key pair.

Default: pem

' - RequestLaunchTemplateData: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/LaunchTemplateIamInstanceProfileSpecificationRequest' - - description: The name or Amazon Resource Name (ARN) of an IAM instance profile. - BlockDeviceMapping: - allOf: - - $ref: '#/components/schemas/LaunchTemplateBlockDeviceMappingRequestList' - - description: The block device mapping. - NetworkInterface: - allOf: - - $ref: '#/components/schemas/String' - - description: '

The user data to make available to the instance. You must provide base64-encoded text. User data is limited to 16 KB. For more information, see Running Commands on Your Linux Instance at Launch (Linux) or Adding User Data (Windows).

If you are creating the launch template for use with Batch, the user data must be provided in the MIME multi-part archive format. For more information, see Amazon EC2 user data in launch templates in the Batch User Guide.

' - TagSpecification: - allOf: - - $ref: '#/components/schemas/LaunchTemplateTagSpecificationRequestList' - - description: 'The tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified tags are applied to all instances or volumes that are created during launch. To tag a resource after it has been created, see CreateTags.' - ElasticGpuSpecification: - allOf: - - $ref: '#/components/schemas/ElasticGpuSpecificationList' - - description: An elastic GPU to associate with the instance. - ElasticInferenceAccelerator: - allOf: - - $ref: '#/components/schemas/LaunchTemplateElasticInferenceAcceleratorList' - - description: ' The elastic inference accelerator for the instance. ' - SecurityGroupId: - allOf: - - $ref: '#/components/schemas/SecurityGroupIdStringList' - - description: 'One or more security group IDs. You can create a security group using CreateSecurityGroup. You cannot specify both a security group ID and security name in the same request.' - SecurityGroup: - allOf: - - $ref: '#/components/schemas/LaunchTemplateCapacityReservationSpecificationRequest' - - description: 'The Capacity Reservation targeting option. If you do not specify this parameter, the instance''s Capacity Reservation preference defaults to open, which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).' - LicenseSpecification: - allOf: - - $ref: '#/components/schemas/LaunchTemplateInstanceMaintenanceOptionsRequest' - - description: The maintenance options for the instance. - description:

The information to include in the launch template.

You must specify at least one parameter for the launch template data.

 - CreateLaunchTemplateRequest: - type: object - required: - - LaunchTemplateName - - LaunchTemplateData - title: CreateLaunchTemplateRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/RequestLaunchTemplateData' - - description: The information for the launch template. - TagSpecification: - allOf: - - $ref: '#/components/schemas/TagSpecificationList' - - description: The tags to apply to the launch template during creation. - LaunchTemplate: - type: object - properties: - launchTemplateId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the launch template. - launchTemplateName: - allOf: - - $ref: '#/components/schemas/LaunchTemplateName' - - description: The name of the launch template. - createTime: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The time launch template was created. - createdBy: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The principal that created the launch template. ' - defaultVersionNumber: - allOf: - - $ref: '#/components/schemas/Long' - - description: The version number of the default version of the launch template. - latestVersionNumber: - allOf: - - $ref: '#/components/schemas/Long' - - description: The version number of the latest version of the launch template. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: The tags for the launch template. - description: Describes a launch template. - ValidationWarning: - type: object - properties: - errorSet: - allOf: - - $ref: '#/components/schemas/ErrorSet' - - description: The error codes and error messages. - description: The error codes and error messages that are returned for the parameters or parameter combinations that are not valid when a new launch template or new version of a launch template is created. - CreateLaunchTemplateVersionRequest: - type: object - required: - - LaunchTemplateData - title: CreateLaunchTemplateVersionRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/RequestLaunchTemplateData' - - description: The information for the launch template. - LaunchTemplateVersion: - type: object - properties: - launchTemplateId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the launch template. - launchTemplateName: - allOf: - - $ref: '#/components/schemas/LaunchTemplateName' - - description: The name of the launch template. - versionNumber: - allOf: - - $ref: '#/components/schemas/Long' - - description: The version number. - versionDescription: - allOf: - - $ref: '#/components/schemas/VersionDescription' - - description: The description for the version. - createTime: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The time the version was created. - createdBy: - allOf: - - $ref: '#/components/schemas/String' - - description: The principal that created the version. - defaultVersion: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether the version is the default version. - launchTemplateData: - allOf: - - $ref: '#/components/schemas/ResponseLaunchTemplateData' - - description: Information about the launch template. - description: Describes a launch template version. - CreateLocalGatewayRouteRequest: - type: object - required: - - DestinationCidrBlock - - LocalGatewayRouteTableId - - LocalGatewayVirtualInterfaceGroupId - title: CreateLocalGatewayRouteRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - LocalGatewayRoute: - type: object - properties: - destinationCidrBlock: - allOf: - - $ref: '#/components/schemas/String' - - description: The CIDR block used for destination matches. - localGatewayVirtualInterfaceGroupId: - allOf: - - $ref: '#/components/schemas/LocalGatewayVirtualInterfaceGroupId' - - description: The ID of the virtual interface group. - type: - allOf: - - $ref: '#/components/schemas/LocalGatewayRouteType' - - description: The route type. - state: - allOf: - - $ref: '#/components/schemas/LocalGatewayRouteState' - - description: The state of the route. - localGatewayRouteTableId: - allOf: - - $ref: '#/components/schemas/LocalGatewayRoutetableId' - - description: The ID of the local gateway route table. - localGatewayRouteTableArn: - allOf: - - $ref: '#/components/schemas/ResourceArn' - - description: The Amazon Resource Name (ARN) of the local gateway route table. - ownerId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Amazon Web Services account that owns the local gateway route. - description: Describes a route for a local gateway route table. - CreateLocalGatewayRouteTableVpcAssociationRequest: - type: object - required: - - LocalGatewayRouteTableId - - VpcId - title: CreateLocalGatewayRouteTableVpcAssociationRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/VpcId' - - description: The ID of the VPC. - TagSpecification: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - LocalGatewayRouteTableVpcAssociation: - type: object - properties: - localGatewayRouteTableVpcAssociationId: - allOf: - - $ref: '#/components/schemas/LocalGatewayRouteTableVpcAssociationId' - - description: The ID of the association. - localGatewayRouteTableId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the local gateway route table. - localGatewayRouteTableArn: - allOf: - - $ref: '#/components/schemas/ResourceArn' - - description: The Amazon Resource Name (ARN) of the local gateway route table for the association. - localGatewayId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the local gateway. - vpcId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the VPC. - ownerId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Amazon Web Services account that owns the local gateway route table for the association. - state: - allOf: - - $ref: '#/components/schemas/String' - - description: The state of the association. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: The tags assigned to the association. - description: Describes an association between a local gateway route table and a VPC. - CreateManagedPrefixListRequest: - type: object - required: - - PrefixListName - - MaxEntries - - AddressFamily - title: CreateManagedPrefixListRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: '

A name for the prefix list.

Constraints: Up to 255 characters in length. The name cannot start with com.amazonaws.

' - Entry: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The maximum number of entries for the prefix list. - TagSpecification: - allOf: - - $ref: '#/components/schemas/String' - - description: '

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

Constraints: Up to 255 UTF-8 characters in length.

' - ManagedPrefixList: - type: object - properties: - prefixListId: - allOf: - - $ref: '#/components/schemas/PrefixListResourceId' - - description: The ID of the prefix list. - addressFamily: - allOf: - - $ref: '#/components/schemas/String' - - description: The IP address version. - state: - allOf: - - $ref: '#/components/schemas/PrefixListState' - - description: The current state of the prefix list. - stateMessage: - allOf: - - $ref: '#/components/schemas/String' - - description: The state message. - prefixListArn: - allOf: - - $ref: '#/components/schemas/ResourceArn' - - description: The Amazon Resource Name (ARN) for the prefix list. - prefixListName: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of the prefix list. - maxEntries: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The maximum number of entries for the prefix list. - version: - allOf: - - $ref: '#/components/schemas/Long' - - description: The version of the prefix list. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: The tags for the prefix list. - ownerId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the owner of the prefix list. - description: Describes a managed prefix list. - CreateNatGatewayRequest: - type: object - required: - - SubnetId - title: CreateNatGatewayRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/SubnetId' - - description: The subnet in which to create the NAT gateway. - TagSpecification: - allOf: - - $ref: '#/components/schemas/ConnectivityType' - - description: Indicates whether the NAT gateway supports public or private connectivity. The default is public connectivity. - NatGateway: - type: object - properties: - createTime: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The date and time the NAT gateway was created. - deleteTime: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: 'The date and time the NAT gateway was deleted, if applicable.' - failureCode: - allOf: - - $ref: '#/components/schemas/String' - - description: 'If the NAT gateway could not be created, specifies the error code for the failure. (InsufficientFreeAddressesInSubnet | Gateway.NotAttached | InvalidAllocationID.NotFound | Resource.AlreadyAssociated | InternalError | InvalidSubnetID.NotFound)' - failureMessage: - allOf: - - $ref: '#/components/schemas/String' - - description: '

If the NAT gateway could not be created, specifies the error message for the failure, that corresponds to the error code.

  • For InsufficientFreeAddressesInSubnet: "Subnet has insufficient free addresses to create this NAT gateway"

  • For Gateway.NotAttached: "Network vpc-xxxxxxxx has no Internet gateway attached"

  • For InvalidAllocationID.NotFound: "Elastic IP address eipalloc-xxxxxxxx could not be associated with this NAT gateway"

  • For Resource.AlreadyAssociated: "Elastic IP address eipalloc-xxxxxxxx is already associated"

  • For InternalError: "Network interface eni-xxxxxxxx, created and used internally by this NAT gateway is in an invalid state. Please try again."

  • For InvalidSubnetID.NotFound: "The specified subnet subnet-xxxxxxxx does not exist or could not be found."

' - natGatewayAddressSet: - allOf: - - $ref: '#/components/schemas/NatGatewayAddressList' - - description: Information about the IP addresses and network interface associated with the NAT gateway. - natGatewayId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the NAT gateway. - provisionedBandwidth: - allOf: - - $ref: '#/components/schemas/ProvisionedBandwidth' - - description: 'Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.' - state: - allOf: - - $ref: '#/components/schemas/NatGatewayState' - - description: '

The state of the NAT gateway.

  • pending: The NAT gateway is being created and is not ready to process traffic.

  • failed: The NAT gateway could not be created. Check the failureCode and failureMessage fields for the reason.

  • available: The NAT gateway is able to process traffic. This status remains until you delete the NAT gateway, and does not indicate the health of the NAT gateway.

  • deleting: The NAT gateway is in the process of being terminated and may still be processing traffic.

  • deleted: The NAT gateway has been terminated and is no longer processing traffic.

' - subnetId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the subnet in which the NAT gateway is located. - vpcId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the VPC in which the NAT gateway is located. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: The tags for the NAT gateway. - connectivityType: - allOf: - - $ref: '#/components/schemas/ConnectivityType' - - description: Indicates whether the NAT gateway supports public or private connectivity. - description: Describes a NAT gateway. - IcmpTypeCode: - type: object - properties: - code: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The ICMP code. A value of -1 means all codes for the specified ICMP type. - type: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The ICMP type. A value of -1 means all types. - description: Describes the ICMP type and code. - RuleAction: - type: string - enum: - - allow - - deny - CreateNetworkAclEntryRequest: - type: object - required: - - Egress - - NetworkAclId - - Protocol - - RuleAction - - RuleNumber - title: CreateNetworkAclEntryRequest - properties: - cidrBlock: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The IPv4 network range to allow or deny, in CIDR notation (for example 172.16.0.0/24). We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.' - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - egress: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet). - Icmp: - allOf: - - $ref: '#/components/schemas/IcmpTypeCode' - - description: 'ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block.' - ipv6CidrBlock: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The IPv6 network range to allow or deny, in CIDR notation (for example 2001:db8:1234:1a00::/64).' - networkAclId: - allOf: - - $ref: '#/components/schemas/NetworkAclId' - - description: The ID of the network ACL. - portRange: - allOf: - - $ref: '#/components/schemas/PortRange' - - description: 'TCP or UDP protocols: The range of ports the rule applies to. Required if specifying protocol 6 (TCP) or 17 (UDP).' - protocol: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The protocol number. A value of "-1" means all protocols. If you specify "-1" or a protocol number other than "6" (TCP), "17" (UDP), or "1" (ICMP), traffic on all ports is allowed, regardless of any ports or ICMP types or codes that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP types and codes allowed, regardless of any that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv6 CIDR block, you must specify an ICMP type and code.' - ruleAction: - allOf: - - $ref: '#/components/schemas/RuleAction' - - description: Indicates whether to allow or deny the traffic that matches the rule. - ruleNumber: - allOf: - - $ref: '#/components/schemas/Integer' - - description: '

The rule number for the entry (for example, 100). ACL entries are processed in ascending order by rule number.

Constraints: Positive integer from 1 to 32766. The range 32767 to 65535 is reserved for internal use.

' - CreateNetworkAclRequest: - type: object - required: - - VpcId - title: CreateNetworkAclRequest - properties: - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - vpcId: - allOf: - - $ref: '#/components/schemas/VpcId' - - description: The ID of the VPC. - TagSpecification: - allOf: - - $ref: '#/components/schemas/TagSpecificationList' - - description: The tags to assign to the network ACL. - NetworkAcl: - type: object - properties: - associationSet: - allOf: - - $ref: '#/components/schemas/NetworkAclAssociationList' - - description: Any associations between the network ACL and one or more subnets - entrySet: - allOf: - - $ref: '#/components/schemas/NetworkAclEntryList' - - description: One or more entries (rules) in the network ACL. - default: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether this is the default network ACL for the VPC. - networkAclId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the network ACL. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: Any tags assigned to the network ACL. - vpcId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the VPC for the network ACL. - ownerId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Amazon Web Services account that owns the network ACL. - description: Describes a network ACL. - CreateNetworkInsightsAccessScopeRequest: - type: object - required: - - ClientToken - title: CreateNetworkInsightsAccessScopeRequest - properties: - MatchPath: - allOf: - - $ref: '#/components/schemas/AccessScopePathListRequest' - - description: The paths to match. - ExcludePath: - allOf: - - $ref: '#/components/schemas/String' - - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.' - TagSpecification: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - NetworkInsightsAccessScope: - type: object - properties: - networkInsightsAccessScopeId: - allOf: - - $ref: '#/components/schemas/NetworkInsightsAccessScopeId' - - description: The ID of the Network Access Scope. - networkInsightsAccessScopeArn: - allOf: - - $ref: '#/components/schemas/ResourceArn' - - description: The Amazon Resource Name (ARN) of the Network Access Scope. - createdDate: - allOf: - - $ref: '#/components/schemas/MillisecondDateTime' - - description: The creation date. - updatedDate: - allOf: - - $ref: '#/components/schemas/MillisecondDateTime' - - description: The last updated date. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: The tags. - description: Describes a Network Access Scope. - NetworkInsightsAccessScopeContent: - type: object - properties: - networkInsightsAccessScopeId: - allOf: - - $ref: '#/components/schemas/NetworkInsightsAccessScopeId' - - description: The ID of the Network Access Scope. - matchPathSet: - allOf: - - $ref: '#/components/schemas/AccessScopePathList' - - description: The paths to match. - excludePathSet: - allOf: - - $ref: '#/components/schemas/AccessScopePathList' - - description: The paths to exclude. - description: Describes the Network Access Scope content. - CreateNetworkInsightsPathRequest: - type: object - required: - - Source - - Destination - - Protocol - - ClientToken - title: CreateNetworkInsightsPathRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Port' - - description: The destination port. - TagSpecification: - allOf: - - $ref: '#/components/schemas/String' - - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.' - NetworkInsightsPath: - type: object - properties: - networkInsightsPathId: - allOf: - - $ref: '#/components/schemas/NetworkInsightsPathId' - - description: The ID of the path. - networkInsightsPathArn: - allOf: - - $ref: '#/components/schemas/ResourceArn' - - description: The Amazon Resource Name (ARN) of the path. - createdDate: - allOf: - - $ref: '#/components/schemas/MillisecondDateTime' - - description: The time stamp when the path was created. - source: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Web Services resource that is the source of the path. - destination: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Web Services resource that is the destination of the path. - sourceIp: - allOf: - - $ref: '#/components/schemas/IpAddress' - - description: The IP address of the Amazon Web Services resource that is the source of the path. - destinationIp: - allOf: - - $ref: '#/components/schemas/IpAddress' - - description: The IP address of the Amazon Web Services resource that is the destination of the path. - protocol: - allOf: - - $ref: '#/components/schemas/Protocol' - - description: The protocol. - destinationPort: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The destination port. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: The tags associated with the path. - description: Describes a path. - CreateNetworkInterfacePermissionRequest: - type: object - required: - - NetworkInterfaceId - - Permission - title: CreateNetworkInterfacePermissionRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - description: Contains the parameters for CreateNetworkInterfacePermission. - NetworkInterfacePermission: - type: object - properties: - networkInterfacePermissionId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the network interface permission. - networkInterfaceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the network interface. - awsAccountId: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Web Services account ID. - awsService: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Web Service. - permission: - allOf: - - $ref: '#/components/schemas/InterfacePermissionType' - - description: The type of permission. - permissionState: - allOf: - - $ref: '#/components/schemas/NetworkInterfacePermissionState' - - description: Information about the state of the permission. - description: Describes a permission for a network interface. - InstanceIpv6AddressList: - type: array - items: - allOf: - - $ref: '#/components/schemas/InstanceIpv6Address' - - xml: - name: item - PrivateIpAddressSpecificationList: - type: array - items: - allOf: - - $ref: '#/components/schemas/PrivateIpAddressSpecification' - - xml: - name: item - NetworkInterfaceCreationType: - type: string - enum: - - efa - - branch - - trunk - CreateNetworkInterfaceRequest: - type: object - required: - - SubnetId - title: CreateNetworkInterfaceRequest - properties: - description: - allOf: - - $ref: '#/components/schemas/String' - - description: A description for the network interface. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - SecurityGroupId: - allOf: - - $ref: '#/components/schemas/SecurityGroupIdStringList' - - description: The IDs of one or more security groups. - ipv6AddressCount: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can''t use this option if specifying specific IPv6 addresses. If your subnet has the AssignIpv6AddressOnCreation attribute set to true, you can specify 0 to override this setting.' - ipv6Addresses: - allOf: - - $ref: '#/components/schemas/InstanceIpv6AddressList' - - description: One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses. - privateIpAddress: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The primary private IPv4 address of the network interface. If you don''t specify an IPv4 address, Amazon EC2 selects one for you from the subnet''s IPv4 CIDR range. If you specify an IP address, you cannot indicate any IP addresses specified in privateIpAddresses as primary (only one IP address can be designated as primary).' - privateIpAddresses: - allOf: - - $ref: '#/components/schemas/PrivateIpAddressSpecificationList' - - description: One or more private IPv4 addresses. - secondaryPrivateIpAddressCount: - allOf: - - $ref: '#/components/schemas/Integer' - - description: '

The number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet''s IPv4 CIDR range. You can''t specify this option and specify more than one private IP address using privateIpAddresses.

The number of IP addresses you can assign to a network interface varies by instance type. For more information, see IP Addresses Per ENI Per Instance Type in the Amazon Virtual Private Cloud User Guide.

' - Ipv4Prefix: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use the Ipv4 Prefixes option. - Ipv6Prefix: - allOf: - - $ref: '#/components/schemas/NetworkInterfaceCreationType' - - description:

The type of network interface. The default is interface.

The only supported values are efa and trunk.

- subnetId: - allOf: - - $ref: '#/components/schemas/SubnetId' - - description: The ID of the subnet to associate with the network interface. - TagSpecification: - allOf: - - $ref: '#/components/schemas/String' - - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.' - description: Contains the parameters for CreateNetworkInterface. - NetworkInterface: - type: object - properties: - association: - allOf: - - $ref: '#/components/schemas/NetworkInterfaceAssociation' - - description: The association information for an Elastic IP address (IPv4) associated with the network interface. - attachment: - allOf: - - $ref: '#/components/schemas/NetworkInterfaceAttachment' - - description: The network interface attachment. - availabilityZone: - allOf: - - $ref: '#/components/schemas/String' - - description: The Availability Zone. - description: - allOf: - - $ref: '#/components/schemas/String' - - description: A description. - groupSet: - allOf: - - $ref: '#/components/schemas/GroupIdentifierList' - - description: Any security groups for the network interface. - interfaceType: - allOf: - - $ref: '#/components/schemas/NetworkInterfaceType' - - description: The type of network interface. - ipv6AddressesSet: - allOf: - - $ref: '#/components/schemas/NetworkInterfaceIpv6AddressesList' - - description: The IPv6 addresses associated with the network interface. - macAddress: - allOf: - - $ref: '#/components/schemas/String' - - description: The MAC address. - networkInterfaceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the network interface. - outpostArn: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Resource Name (ARN) of the Outpost. - ownerId: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Web Services account ID of the owner of the network interface. - privateDnsName: - allOf: - - $ref: '#/components/schemas/String' - - description: The private DNS name. - privateIpAddress: - allOf: - - $ref: '#/components/schemas/String' - - description: The IPv4 address of the network interface within the subnet. - privateIpAddressesSet: - allOf: - - $ref: '#/components/schemas/NetworkInterfacePrivateIpAddressList' - - description: The private IPv4 addresses associated with the network interface. - ipv4PrefixSet: - allOf: - - $ref: '#/components/schemas/Ipv4PrefixesList' - - description: The IPv4 prefixes that are assigned to the network interface. - ipv6PrefixSet: - allOf: - - $ref: '#/components/schemas/Ipv6PrefixesList' - - description: The IPv6 prefixes that are assigned to the network interface. - requesterId: - allOf: - - $ref: '#/components/schemas/String' - - description: The alias or Amazon Web Services account ID of the principal or service that created the network interface. - requesterManaged: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether the network interface is being managed by Amazon Web Services. - sourceDestCheck: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether source/destination checking is enabled. - status: - allOf: - - $ref: '#/components/schemas/NetworkInterfaceStatus' - - description: The status of the network interface. - subnetId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the subnet. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: Any tags assigned to the network interface. - vpcId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the VPC. - denyAllIgwTraffic: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Indicates whether a network interface with an IPv6 address is unreachable from the public internet. If the value is true, inbound traffic from the internet is dropped and you cannot assign an elastic IP address to the network interface. The network interface is reachable from peered VPCs and resources connected through a transit gateway, including on-premises networks.' - ipv6Native: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether this is an IPv6 only network interface. - ipv6Address: - allOf: - - $ref: '#/components/schemas/String' - - description: The IPv6 globally unique address associated with the network interface. - description: Describes a network interface. - CreatePlacementGroupRequest: - type: object - title: CreatePlacementGroupRequest - properties: - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - groupName: - allOf: - - $ref: '#/components/schemas/String' - - description: '

A name for the placement group. Must be unique within the scope of your account for the Region.

Constraints: Up to 255 ASCII characters

' - strategy: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The number of partitions. Valid only when Strategy is set to partition. - TagSpecification: - allOf: - - $ref: '#/components/schemas/TagSpecificationList' - - description: The tags to apply to the new placement group. - PlacementGroup: - type: object - properties: - groupName: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of the placement group. - state: - allOf: - - $ref: '#/components/schemas/PlacementGroupState' - - description: The state of the placement group. - strategy: - allOf: - - $ref: '#/components/schemas/PlacementStrategy' - - description: The placement strategy. - partitionCount: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The number of partitions. Valid only if strategy is set to partition. - groupId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the placement group. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: Any tags applied to the placement group. - groupArn: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Resource Name (ARN) of the placement group. - description: Describes a placement group. - CreatePublicIpv4PoolRequest: - type: object - title: CreatePublicIpv4PoolRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - TagSpecification: - allOf: - - $ref: '#/components/schemas/TagSpecificationList' - - description: '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. 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.' - CreateReplaceRootVolumeTaskRequest: - type: object - required: - - InstanceId - title: CreateReplaceRootVolumeTaskRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - TagSpecification: - allOf: - - $ref: '#/components/schemas/TagSpecificationList' - - description: The tags to apply to the root volume replacement task. - ReplaceRootVolumeTask: - type: object - properties: - replaceRootVolumeTaskId: - allOf: - - $ref: '#/components/schemas/ReplaceRootVolumeTaskId' - - description: The ID of the root volume replacement task. - instanceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the instance for which the root volume replacement task was created. - taskState: - allOf: - - $ref: '#/components/schemas/ReplaceRootVolumeTaskState' - - description: '

The state of the task. The task can be in one of the following states:

  • pending - the replacement volume is being created.

  • in-progress - the original volume is being detached and the replacement volume is being attached.

  • succeeded - the replacement volume has been successfully attached to the instance and the instance is available.

  • failing - the replacement task is in the process of failing.

  • failed - the replacement task has failed but the original root volume is still attached.

  • failing-detached - the replacement task is in the process of failing. The instance might have no root volume attached.

  • failed-detached - the replacement task has failed and the instance has no root volume attached.

' - startTime: - allOf: - - $ref: '#/components/schemas/String' - - description: The time the task was started. - completeTime: - allOf: - - $ref: '#/components/schemas/String' - - description: The time the task completed. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: The tags assigned to the task. - description: Information about a root volume replacement task. - PriceScheduleSpecificationList: - type: array - items: - allOf: - - $ref: '#/components/schemas/PriceScheduleSpecification' - - xml: - name: item - CreateReservedInstancesListingRequest: - type: object - required: - - ClientToken - - InstanceCount - - PriceSchedules - - ReservedInstancesId - title: CreateReservedInstancesListingRequest - properties: - clientToken: - allOf: - - $ref: '#/components/schemas/String' - - description: 'Unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see Ensuring Idempotency.' - instanceCount: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The number of instances that are a part of a Reserved Instance account to be listed in the Reserved Instance Marketplace. This number should be less than or equal to the instance count associated with the Reserved Instance ID specified in this call. - priceSchedules: - allOf: - - $ref: '#/components/schemas/PriceScheduleSpecificationList' - - description: A list specifying the price of the Standard Reserved Instance for each month remaining in the Reserved Instance term. - reservedInstancesId: - allOf: - - $ref: '#/components/schemas/ReservationId' - - description: The ID of the active Standard Reserved Instance. - description: Contains the parameters for CreateReservedInstancesListing. - CreateRestoreImageTaskRequest: - type: object - required: - - Bucket - - ObjectKey - title: CreateRestoreImageTaskRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The name for the restored AMI. The name must be unique for AMIs in the Region for this account. If you do not provide a name, the new AMI gets the same name as the original AMI.' - TagSpecification: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - CreateRouteRequest: - type: object - required: - - RouteTableId - title: CreateRouteRequest - properties: - destinationCidrBlock: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The IPv4 CIDR address block used for the destination match. Routing decisions are based on the most specific match. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.' - destinationIpv6CidrBlock: - allOf: - - $ref: '#/components/schemas/PrefixListResourceId' - - description: The ID of a prefix list used for the destination match. - dryRun: - allOf: - - $ref: '#/components/schemas/VpcEndpointId' - - description: The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only. - egressOnlyInternetGatewayId: - allOf: - - $ref: '#/components/schemas/EgressOnlyInternetGatewayId' - - description: '[IPv6 traffic only] The ID of an egress-only internet gateway.' - gatewayId: - allOf: - - $ref: '#/components/schemas/RouteGatewayId' - - description: The ID of an internet gateway or virtual private gateway attached to your VPC. - instanceId: - allOf: - - $ref: '#/components/schemas/InstanceId' - - description: The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached. - natGatewayId: - allOf: - - $ref: '#/components/schemas/CarrierGatewayId' - - description:

The ID of the carrier gateway.

You can only use this option when the VPC contains a subnet which is associated with a Wavelength Zone.

- networkInterfaceId: - allOf: - - $ref: '#/components/schemas/NetworkInterfaceId' - - description: The ID of a network interface. - routeTableId: - allOf: - - $ref: '#/components/schemas/RouteTableId' - - description: The ID of the route table for the route. - vpcPeeringConnectionId: - allOf: - - $ref: '#/components/schemas/CoreNetworkArn' - - description: The Amazon Resource Name (ARN) of the core network. - CreateRouteTableRequest: - type: object - required: - - VpcId - title: CreateRouteTableRequest - properties: - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - vpcId: - allOf: - - $ref: '#/components/schemas/VpcId' - - description: The ID of the VPC. - TagSpecification: - allOf: - - $ref: '#/components/schemas/TagSpecificationList' - - description: The tags to assign to the route table. - RouteTable: - type: object - properties: - associationSet: - allOf: - - $ref: '#/components/schemas/RouteTableAssociationList' - - description: The associations between the route table and one or more subnets or a gateway. - propagatingVgwSet: - allOf: - - $ref: '#/components/schemas/PropagatingVgwList' - - description: Any virtual private gateway (VGW) propagating routes. - routeTableId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the route table. - routeSet: - allOf: - - $ref: '#/components/schemas/RouteList' - - description: The routes in the route table. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: Any tags assigned to the route table. - vpcId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the VPC. - ownerId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Amazon Web Services account that owns the route table. - description: Describes a route table. - CreateSecurityGroupRequest: - type: object - required: - - Description - - GroupName - title: CreateSecurityGroupRequest - properties: - GroupDescription: - allOf: - - $ref: '#/components/schemas/VpcId' - - description: '[EC2-VPC] The ID of the VPC. Required for EC2-VPC.' - TagSpecification: - allOf: - - $ref: '#/components/schemas/TagSpecificationList' - - description: The tags to assign to the security group. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - CreateSnapshotRequest: - type: object - required: - - VolumeId - title: CreateSnapshotRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/VolumeId' - - description: The ID of the Amazon EBS volume. - TagSpecification: - allOf: - - $ref: '#/components/schemas/TagSpecificationList' - - description: The tags to apply to the snapshot during creation. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - CreateSnapshotsRequest: - type: object - required: - - InstanceSpecification - title: CreateSnapshotsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: '

The Amazon Resource Name (ARN) of the Outpost on which to create the local snapshots.

  • To create snapshots from an instance in a Region, omit this parameter. The snapshots are created in the same Region as the instance.

  • To create snapshots from an instance on an Outpost and store the snapshots in the Region, omit this parameter. The snapshots are created in the Region for the Outpost.

  • To create snapshots from an instance on an Outpost and store the snapshots on an Outpost, specify the ARN of the destination Outpost. The snapshots must be created on the same Outpost as the instance.

For more information, see Create multi-volume local snapshots from instances on an Outpost in the Amazon Elastic Compute Cloud User Guide.

' - TagSpecification: - allOf: - - $ref: '#/components/schemas/CopyTagsFromSource' - - description: Copies the tags from the specified volume to corresponding snapshot. - SnapshotSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/SnapshotInfo' - - xml: - name: item - CreateSpotDatafeedSubscriptionRequest: - type: object - required: - - Bucket - title: CreateSpotDatafeedSubscriptionRequest - properties: - bucket: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The name of the Amazon S3 bucket in which to store the Spot Instance data feed. For more information about bucket names, see Rules for bucket naming in the Amazon S3 Developer Guide.' - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - prefix: - allOf: - - $ref: '#/components/schemas/String' - - description: The prefix for the data feed file names. - description: Contains the parameters for CreateSpotDatafeedSubscription. - SpotDatafeedSubscription: - type: object - properties: - bucket: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of the Amazon S3 bucket where the Spot Instance data feed is located. - fault: - allOf: - - $ref: '#/components/schemas/SpotInstanceStateFault' - - description: 'The fault codes for the Spot Instance request, if any.' - ownerId: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Web Services account ID of the account. - prefix: - allOf: - - $ref: '#/components/schemas/String' - - description: The prefix for the data feed files. - state: - allOf: - - $ref: '#/components/schemas/DatafeedSubscriptionState' - - description: The state of the Spot Instance data feed subscription. - description: Describes the data feed for a Spot Instance. - CreateStoreImageTaskRequest: - type: object - required: - - ImageId - - Bucket - title: CreateStoreImageTaskRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The name of the Amazon S3 bucket in which the AMI object will be stored. The bucket must be in the Region in which the request is being made. The AMI object appears in the bucket only after the upload task has completed. ' - S3ObjectTag: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - CreateSubnetCidrReservationRequest: - type: object - required: - - SubnetId - - Cidr - - ReservationType - title: CreateSubnetCidrReservationRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - TagSpecification: - allOf: - - $ref: '#/components/schemas/TagSpecificationList' - - description: The tags to assign to the subnet CIDR reservation. - SubnetCidrReservation: - type: object - properties: - subnetCidrReservationId: - allOf: - - $ref: '#/components/schemas/SubnetCidrReservationId' - - description: The ID of the subnet CIDR reservation. - subnetId: - allOf: - - $ref: '#/components/schemas/SubnetId' - - description: The ID of the subnet. - cidr: - allOf: - - $ref: '#/components/schemas/String' - - description: The CIDR that has been reserved. - reservationType: - allOf: - - $ref: '#/components/schemas/SubnetCidrReservationType' - - description: 'The type of reservation. ' - ownerId: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The ID of the account that owns the subnet CIDR reservation. ' - description: - allOf: - - $ref: '#/components/schemas/String' - - description: The description assigned to the subnet CIDR reservation. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: The tags assigned to the subnet CIDR reservation. - description: Describes a subnet CIDR reservation. - CreateSubnetRequest: - type: object - required: - - VpcId - title: CreateSubnetRequest - properties: - TagSpecification: - allOf: - - $ref: '#/components/schemas/VpcId' - - description: The ID of the VPC. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether to create an IPv6 only subnet. - ResourceIdList: - type: array - items: - $ref: '#/components/schemas/TaggableResourceId' - CreateTagsRequest: - type: object - required: - - Resources - - Tags - title: CreateTagsRequest - properties: - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - ResourceId: - allOf: - - $ref: '#/components/schemas/ResourceIdList' - - description: '

The IDs of the resources, separated by spaces.

Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.

' - Tag: - allOf: - - $ref: '#/components/schemas/TagList' - - description: 'The tags. The value parameter is required, but if you don''t want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.' - CreateTrafficMirrorFilterRequest: - type: object - title: CreateTrafficMirrorFilterRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The description of the Traffic Mirror filter. - TagSpecification: - allOf: - - $ref: '#/components/schemas/String' - - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.' - TrafficMirrorFilter: - type: object - properties: - trafficMirrorFilterId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Traffic Mirror filter. - ingressFilterRuleSet: - allOf: - - $ref: '#/components/schemas/TrafficMirrorFilterRuleList' - - description: Information about the ingress rules that are associated with the Traffic Mirror filter. - egressFilterRuleSet: - allOf: - - $ref: '#/components/schemas/TrafficMirrorFilterRuleList' - - description: Information about the egress rules that are associated with the Traffic Mirror filter. - networkServiceSet: - allOf: - - $ref: '#/components/schemas/TrafficMirrorNetworkServiceList' - - description: The network service traffic that is associated with the Traffic Mirror filter. - description: - allOf: - - $ref: '#/components/schemas/String' - - description: The description of the Traffic Mirror filter. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: The tags assigned to the Traffic Mirror filter. - description: Describes the Traffic Mirror filter. - CreateTrafficMirrorFilterRuleRequest: - type: object - required: - - TrafficMirrorFilterId - - TrafficDirection - - RuleNumber - - RuleAction - - DestinationCidrBlock - - SourceCidrBlock - title: CreateTrafficMirrorFilterRuleRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.' - TrafficMirrorFilterRule: - type: object - properties: - trafficMirrorFilterRuleId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Traffic Mirror rule. - trafficMirrorFilterId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Traffic Mirror filter that the rule is associated with. - trafficDirection: - allOf: - - $ref: '#/components/schemas/TrafficDirection' - - description: The traffic direction assigned to the Traffic Mirror rule. - ruleNumber: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The rule number of the Traffic Mirror rule. - ruleAction: - allOf: - - $ref: '#/components/schemas/TrafficMirrorRuleAction' - - description: The action assigned to the Traffic Mirror rule. - protocol: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The protocol assigned to the Traffic Mirror rule. - destinationPortRange: - allOf: - - $ref: '#/components/schemas/TrafficMirrorPortRange' - - description: The destination port range assigned to the Traffic Mirror rule. - sourcePortRange: - allOf: - - $ref: '#/components/schemas/TrafficMirrorPortRange' - - description: The source port range assigned to the Traffic Mirror rule. - destinationCidrBlock: - allOf: - - $ref: '#/components/schemas/String' - - description: The destination CIDR block assigned to the Traffic Mirror rule. - sourceCidrBlock: - allOf: - - $ref: '#/components/schemas/String' - - description: The source CIDR block assigned to the Traffic Mirror rule. - description: - allOf: - - $ref: '#/components/schemas/String' - - description: The description of the Traffic Mirror rule. - description: Describes the Traffic Mirror rule. - CreateTrafficMirrorSessionRequest: - type: object - required: - - NetworkInterfaceId - - TrafficMirrorTargetId - - TrafficMirrorFilterId - - SessionNumber - title: CreateTrafficMirrorSessionRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The description of the Traffic Mirror session. - TagSpecification: - allOf: - - $ref: '#/components/schemas/String' - - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.' - TrafficMirrorSession: - type: object - properties: - trafficMirrorSessionId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID for the Traffic Mirror session. - trafficMirrorTargetId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Traffic Mirror target. - trafficMirrorFilterId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Traffic Mirror filter. - networkInterfaceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Traffic Mirror session's network interface. - ownerId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the account that owns the Traffic Mirror session. - packetLength: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The number of bytes in each packet to mirror. These are the bytes after the VXLAN header. To mirror a subset, set this to the length (in bytes) to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target. Do not specify this parameter when you want to mirror the entire packet' - sessionNumber: - allOf: - - $ref: '#/components/schemas/Integer' - - description:

The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. The first session with a matching filter is the one that mirrors the packets.

Valid values are 1-32766.

- virtualNetworkId: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The virtual network ID associated with the Traffic Mirror session. - description: - allOf: - - $ref: '#/components/schemas/String' - - description: The description of the Traffic Mirror session. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: The tags assigned to the Traffic Mirror session. - description: Describes a Traffic Mirror session. - CreateTrafficMirrorTargetRequest: - type: object - title: CreateTrafficMirrorTargetRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The description of the Traffic Mirror target. - TagSpecification: - allOf: - - $ref: '#/components/schemas/VpcEndpointId' - - description: The ID of the Gateway Load Balancer endpoint. - TrafficMirrorTarget: - type: object - properties: - trafficMirrorTargetId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Traffic Mirror target. - networkInterfaceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The network interface ID that is attached to the target. - networkLoadBalancerArn: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Resource Name (ARN) of the Network Load Balancer. - type: - allOf: - - $ref: '#/components/schemas/TrafficMirrorTargetType' - - description: The type of Traffic Mirror target. - description: - allOf: - - $ref: '#/components/schemas/String' - - description: Information about the Traffic Mirror target. - ownerId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the account that owns the Traffic Mirror target. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: The tags assigned to the Traffic Mirror target. - gatewayLoadBalancerEndpointId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Gateway Load Balancer endpoint. - description: Describes a Traffic Mirror target. - InsideCidrBlocksStringList: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - CreateTransitGatewayConnectPeerRequest: - type: object - required: - - TransitGatewayAttachmentId - - PeerAddress - - InsideCidrBlocks - title: CreateTransitGatewayConnectPeerRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/InsideCidrBlocksStringList' - - description: 'The range of inside IP addresses that are used for BGP peering. You must specify a size /29 IPv4 CIDR block from the 169.254.0.0/16 range. The first address from the range must be configured on the appliance as the BGP IP address. You can also optionally specify a size /125 IPv6 CIDR block from the fd00::/8 range.' - TagSpecification: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - TransitGatewayConnectPeer: - type: object - properties: - transitGatewayAttachmentId: - allOf: - - $ref: '#/components/schemas/TransitGatewayAttachmentId' - - description: The ID of the Connect attachment. - transitGatewayConnectPeerId: - allOf: - - $ref: '#/components/schemas/TransitGatewayConnectPeerId' - - description: The ID of the Connect peer. - state: - allOf: - - $ref: '#/components/schemas/TransitGatewayConnectPeerState' - - description: The state of the Connect peer. - creationTime: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The creation time. - connectPeerConfiguration: - allOf: - - $ref: '#/components/schemas/TransitGatewayConnectPeerConfiguration' - - description: The Connect peer details. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: The tags for the Connect peer. - description: Describes a transit gateway Connect peer. - CreateTransitGatewayConnectRequestOptions: - type: object - required: - - Protocol - properties: - undefined: - allOf: - - $ref: '#/components/schemas/ProtocolValue' - - description: The tunnel protocol. - description: The options for a Connect attachment. - CreateTransitGatewayConnectRequest: - type: object - required: - - TransportTransitGatewayAttachmentId - - Options - title: CreateTransitGatewayConnectRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/CreateTransitGatewayConnectRequestOptions' - - description: The Connect attachment options. - TagSpecification: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - TransitGatewayConnect: - type: object - properties: - transitGatewayAttachmentId: - allOf: - - $ref: '#/components/schemas/TransitGatewayAttachmentId' - - description: The ID of the Connect attachment. - transportTransitGatewayAttachmentId: - allOf: - - $ref: '#/components/schemas/TransitGatewayAttachmentId' - - description: The ID of the attachment from which the Connect attachment was created. - transitGatewayId: - allOf: - - $ref: '#/components/schemas/TransitGatewayId' - - description: The ID of the transit gateway. - state: - allOf: - - $ref: '#/components/schemas/TransitGatewayAttachmentState' - - description: The state of the attachment. - creationTime: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The creation time. - options: - allOf: - - $ref: '#/components/schemas/TransitGatewayConnectOptions' - - description: The Connect attachment options. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: The tags for the attachment. - description: Describes a transit gateway Connect attachment. - CreateTransitGatewayMulticastDomainRequestOptions: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/AutoAcceptSharedAssociationsValue' - - description: Indicates whether to automatically accept cross-account subnet associations that are associated with the transit gateway multicast domain. - description: The options for the transit gateway multicast domain. - CreateTransitGatewayMulticastDomainRequest: - type: object - required: - - TransitGatewayId - title: CreateTransitGatewayMulticastDomainRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/CreateTransitGatewayMulticastDomainRequestOptions' - - description: The options for the transit gateway multicast domain. - TagSpecification: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - TransitGatewayMulticastDomain: - type: object - properties: - transitGatewayMulticastDomainId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the transit gateway multicast domain. - transitGatewayId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the transit gateway. - transitGatewayMulticastDomainArn: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Resource Name (ARN) of the transit gateway multicast domain. - ownerId: - allOf: - - $ref: '#/components/schemas/String' - - description: ' The ID of the Amazon Web Services account that owns the transit gateway multicast domain.' - options: - allOf: - - $ref: '#/components/schemas/TransitGatewayMulticastDomainOptions' - - description: The options for the transit gateway multicast domain. - state: - allOf: - - $ref: '#/components/schemas/TransitGatewayMulticastDomainState' - - description: The state of the transit gateway multicast domain. - creationTime: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The time the transit gateway multicast domain was created. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: The tags for the transit gateway multicast domain. - description: Describes the transit gateway multicast domain. - CreateTransitGatewayPeeringAttachmentRequest: - type: object - required: - - TransitGatewayId - - PeerTransitGatewayId - - PeerAccountId - - PeerRegion - title: CreateTransitGatewayPeeringAttachmentRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The Region where the peer transit gateway is located. - TagSpecification: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - CreateTransitGatewayPrefixListReferenceRequest: - type: object - required: - - TransitGatewayRouteTableId - - PrefixListId - title: CreateTransitGatewayPrefixListReferenceRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - TransitGatewayPrefixListReference: - type: object - properties: - transitGatewayRouteTableId: - allOf: - - $ref: '#/components/schemas/TransitGatewayRouteTableId' - - description: The ID of the transit gateway route table. - prefixListId: - allOf: - - $ref: '#/components/schemas/PrefixListResourceId' - - description: The ID of the prefix list. - prefixListOwnerId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the prefix list owner. - state: - allOf: - - $ref: '#/components/schemas/TransitGatewayPrefixListReferenceState' - - description: The state of the prefix list reference. - blackhole: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether traffic that matches this route is dropped. - transitGatewayAttachment: - allOf: - - $ref: '#/components/schemas/TransitGatewayPrefixListAttachment' - - description: Information about the transit gateway attachment. - description: Describes a prefix list reference. - TransitGatewayRequestOptions: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/TransitGatewayCidrBlockStringList' - - description: 'One or more IPv4 or IPv6 CIDR blocks for the transit gateway. Must be a size /24 CIDR block or larger for IPv4, or a size /64 CIDR block or larger for IPv6.' - description: Describes the options for a transit gateway. - CreateTransitGatewayRequest: - type: object - title: CreateTransitGatewayRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/TransitGatewayRequestOptions' - - description: The transit gateway options. - TagSpecification: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - TransitGateway: - type: object - properties: - transitGatewayId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the transit gateway. - transitGatewayArn: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Resource Name (ARN) of the transit gateway. - state: - allOf: - - $ref: '#/components/schemas/TransitGatewayState' - - description: The state of the transit gateway. - ownerId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Amazon Web Services account that owns the transit gateway. - description: - allOf: - - $ref: '#/components/schemas/String' - - description: The description of the transit gateway. - creationTime: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The creation time. - options: - allOf: - - $ref: '#/components/schemas/TransitGatewayOptions' - - description: The transit gateway options. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: The tags for the transit gateway. - description: Describes a transit gateway. - CreateTransitGatewayRouteRequest: - type: object - required: - - DestinationCidrBlock - - TransitGatewayRouteTableId - title: CreateTransitGatewayRouteRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - TransitGatewayRoute: - type: object - properties: - destinationCidrBlock: - allOf: - - $ref: '#/components/schemas/String' - - description: The CIDR block used for destination matches. - prefixListId: - allOf: - - $ref: '#/components/schemas/PrefixListResourceId' - - description: The ID of the prefix list used for destination matches. - transitGatewayAttachments: - allOf: - - $ref: '#/components/schemas/TransitGatewayRouteAttachmentList' - - description: The attachments. - type: - allOf: - - $ref: '#/components/schemas/TransitGatewayRouteType' - - description: The route type. - state: - allOf: - - $ref: '#/components/schemas/TransitGatewayRouteState' - - description: The state of the route. - description: Describes a route for a transit gateway route table. - CreateTransitGatewayRouteTableRequest: - type: object - required: - - TransitGatewayId - title: CreateTransitGatewayRouteTableRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - TransitGatewayRouteTable: - type: object - properties: - transitGatewayRouteTableId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the transit gateway route table. - transitGatewayId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the transit gateway. - state: - allOf: - - $ref: '#/components/schemas/TransitGatewayRouteTableState' - - description: The state of the transit gateway route table. - defaultAssociationRouteTable: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether this is the default association route table for the transit gateway. - defaultPropagationRouteTable: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether this is the default propagation route table for the transit gateway. - creationTime: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The creation time. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: Any tags assigned to the route table. - description: Describes a transit gateway route table. - CreateTransitGatewayVpcAttachmentRequest: - type: object - required: - - TransitGatewayId - - VpcId - - SubnetIds - title: CreateTransitGatewayVpcAttachmentRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - CreateTransitGatewayVpcAttachmentRequestOptions: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/ApplianceModeSupportValue' - - description: 'Enable or disable support for appliance mode. If enabled, a traffic flow between a source and destination uses the same Availability Zone for the VPC attachment for the lifetime of that flow. The default is disable.' - description: Describes the options for a VPC attachment. - PermissionGroup: - type: string - enum: - - all - CreateVolumePermission: - type: object - properties: - group: - allOf: - - $ref: '#/components/schemas/PermissionGroup' - - description: The group to be added or removed. The possible value is all. - userId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Amazon Web Services account to be added or removed. - description: Describes the user or group to be added or removed from the list of create volume permissions for a volume. - CreateVolumePermissionModifications: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/CreateVolumePermissionList' - - description: Removes the specified Amazon Web Services account ID or group from the list. - description: Describes modifications to the list of create volume permissions for a volume. - VolumeType: - type: string - enum: - - standard - - io1 - - io2 - - gp2 - - sc1 - - st1 - - gp3 - CreateVolumeRequest: - type: object - required: - - AvailabilityZone - title: CreateVolumeRequest - properties: - AvailabilityZone: - allOf: - - $ref: '#/components/schemas/String' - - description: The Availability Zone in which to create the volume. - encrypted: - allOf: - - $ref: '#/components/schemas/VolumeType' - - description: '

The volume type. This parameter can be one of the following values:

  • General Purpose SSD: gp2 | gp3

  • Provisioned IOPS SSD: io1 | io2

  • Throughput Optimized HDD: st1

  • Cold HDD: sc1

  • Magnetic: standard

For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide.

Default: gp2

' - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - TagSpecification: - allOf: - - $ref: '#/components/schemas/String' - - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.' - CreateVpcEndpointConnectionNotificationRequest: - type: object - required: - - ConnectionNotificationArn - - ConnectionEvents - title: CreateVpcEndpointConnectionNotificationRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.' - VpcEndpointRouteTableIdList: - type: array - items: - allOf: - - $ref: '#/components/schemas/RouteTableId' - - xml: - name: item - VpcEndpointSubnetIdList: - type: array - items: - allOf: - - $ref: '#/components/schemas/SubnetId' - - xml: - name: item - CreateVpcEndpointRequest: - type: object - required: - - VpcId - - ServiceName - title: CreateVpcEndpointRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: '(Interface and gateway endpoints) A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format. If this parameter is not specified, we attach a default policy that allows full access to the service.' - RouteTableId: - allOf: - - $ref: '#/components/schemas/VpcEndpointRouteTableIdList' - - description: (Gateway endpoint) One or more route table IDs. - SubnetId: - allOf: - - $ref: '#/components/schemas/VpcEndpointSubnetIdList' - - description: '(Interface and Gateway Load Balancer endpoints) The ID of one or more subnets in which to create an endpoint network interface. For a Gateway Load Balancer endpoint, you can specify one subnet only.' - SecurityGroupId: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: '

(Interface endpoint) Indicates whether to associate a private hosted zone with the specified VPC. The private hosted zone contains a record set for the default public DNS name for the service for the Region (for example, kinesis.us-east-1.amazonaws.com), which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC endpoint service.

To use a private hosted zone, you must set the following VPC attributes to true: enableDnsHostnames and enableDnsSupport. Use ModifyVpcAttribute to set the VPC attributes.

Default: true

' - TagSpecification: - allOf: - - $ref: '#/components/schemas/TagSpecificationList' - - description: The tags to associate with the endpoint. - description: Contains the parameters for CreateVpcEndpoint. - VpcEndpoint: - type: object - properties: - vpcEndpointId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the endpoint. - vpcEndpointType: - allOf: - - $ref: '#/components/schemas/VpcEndpointType' - - description: The type of endpoint. - vpcId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the VPC to which the endpoint is associated. - serviceName: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of the service to which the endpoint is associated. - state: - allOf: - - $ref: '#/components/schemas/State' - - description: The state of the endpoint. - policyDocument: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The policy document associated with the endpoint, if applicable.' - routeTableIdSet: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: (Gateway endpoint) One or more route tables associated with the endpoint. - subnetIdSet: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: (Interface endpoint) The subnets for the endpoint. - groupSet: - allOf: - - $ref: '#/components/schemas/GroupIdentifierSet' - - description: (Interface endpoint) Information about the security groups that are associated with the network interface. - ipAddressType: - allOf: - - $ref: '#/components/schemas/IpAddressType' - - description: The IP address type for the endpoint. - dnsOptions: - allOf: - - $ref: '#/components/schemas/DnsOptions' - - description: The DNS options for the endpoint. - privateDnsEnabled: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: (Interface endpoint) Indicates whether the VPC is associated with a private hosted zone. - requesterManaged: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether the endpoint is being managed by its service. - networkInterfaceIdSet: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: (Interface endpoint) One or more network interfaces for the endpoint. - dnsEntrySet: - allOf: - - $ref: '#/components/schemas/DnsEntrySet' - - description: (Interface endpoint) The DNS entries for the endpoint. - creationTimestamp: - allOf: - - $ref: '#/components/schemas/MillisecondDateTime' - - description: The date and time that the endpoint was created. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: Any tags assigned to the endpoint. - ownerId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Amazon Web Services account that owns the endpoint. - lastError: - allOf: - - $ref: '#/components/schemas/LastError' - - description: The last error that occurred for endpoint. - description: Describes a VPC endpoint. - CreateVpcEndpointServiceConfigurationRequest: - type: object - title: CreateVpcEndpointServiceConfigurationRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: (Interface endpoint configuration) The private DNS name to assign to the VPC endpoint service. - NetworkLoadBalancerArn: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The Amazon Resource Names (ARNs) of one or more Network Load Balancers for your service. - GatewayLoadBalancerArn: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The Amazon Resource Names (ARNs) of one or more Gateway Load Balancers. - SupportedIpAddressType: - allOf: - - $ref: '#/components/schemas/String' - - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.' - TagSpecification: - allOf: - - $ref: '#/components/schemas/TagSpecificationList' - - description: The tags to associate with the service. - ServiceConfiguration: - type: object - properties: - serviceType: - allOf: - - $ref: '#/components/schemas/ServiceTypeDetailSet' - - description: The type of service. - serviceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the service. - serviceName: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of the service. - serviceState: - allOf: - - $ref: '#/components/schemas/ServiceState' - - description: The service state. - availabilityZoneSet: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The Availability Zones in which the service is available. - acceptanceRequired: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether requests from other Amazon Web Services accounts to create an endpoint to the service must first be accepted. - managesVpcEndpoints: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether the service manages its VPC endpoints. Management of the service VPC endpoints using the VPC endpoint API is restricted. - networkLoadBalancerArnSet: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The Amazon Resource Names (ARNs) of the Network Load Balancers for the service. - gatewayLoadBalancerArnSet: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The Amazon Resource Names (ARNs) of the Gateway Load Balancers for the service. - supportedIpAddressTypeSet: - allOf: - - $ref: '#/components/schemas/SupportedIpAddressTypes' - - description: The supported IP address types. - baseEndpointDnsNameSet: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The DNS names for the service. - privateDnsName: - allOf: - - $ref: '#/components/schemas/String' - - description: The private DNS name for the service. - privateDnsNameConfiguration: - allOf: - - $ref: '#/components/schemas/PrivateDnsNameConfiguration' - - description: Information about the endpoint service private DNS name configuration. - payerResponsibility: - allOf: - - $ref: '#/components/schemas/PayerResponsibility' - - description: The payer responsibility. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: Any tags assigned to the service. - description: Describes a service configuration for a VPC endpoint service. - CreateVpcPeeringConnectionRequest: - type: object - title: CreateVpcPeeringConnectionRequest - properties: - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - peerOwnerId: - allOf: - - $ref: '#/components/schemas/String' - - description: '

The Amazon Web Services account ID of the owner of the accepter VPC.

Default: Your Amazon Web Services account ID

' - peerVpcId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the VPC with which you are creating the VPC peering connection. You must specify this parameter in the request. - vpcId: - allOf: - - $ref: '#/components/schemas/String' - - description: '

The Region code for the accepter VPC, if the accepter VPC is located in a Region other than the Region in which you make the request.

Default: The Region in which you make the request.

' - TagSpecification: - allOf: - - $ref: '#/components/schemas/TagSpecificationList' - - description: The tags to assign to the peering connection. - CreateVpcRequest: - type: object - title: CreateVpcRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The IPv4 network range for the VPC, in CIDR notation. For example, 10.0.0.0/16. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.' - amazonProvidedIpv6CidrBlock: - allOf: - - $ref: '#/components/schemas/NetmaskLength' - - description: 'The netmask length of the IPv6 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.' - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - instanceTenancy: - allOf: - - $ref: '#/components/schemas/String' - - description:

The name of the location from which we advertise the IPV6 CIDR block. Use this parameter to limit the address to this location.

You must set AmazonProvidedIpv6CidrBlock to true to use this parameter.

- TagSpecification: - allOf: - - $ref: '#/components/schemas/TagSpecificationList' - - description: The tags to assign to the VPC. - VpnConnectionOptionsSpecification: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: '

Indicate whether to enable acceleration for the VPN connection.

Default: false

' - staticRoutesOnly: - allOf: - - $ref: '#/components/schemas/String' - - description: '

The IPv6 CIDR on the Amazon Web Services side of the VPN connection.

Default: ::/0

' - description: Describes VPN connection options. - CreateVpnConnectionRequest: - type: object - required: - - CustomerGatewayId - - Type - title: CreateVpnConnectionRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/TransitGatewayId' - - description: 'The ID of the transit gateway. If you specify a transit gateway, you cannot specify a virtual private gateway.' - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - options: - allOf: - - $ref: '#/components/schemas/VpnConnectionOptionsSpecification' - - description: The options for the VPN connection. - TagSpecification: - allOf: - - $ref: '#/components/schemas/TagSpecificationList' - - description: The tags to apply to the VPN connection. - description: Contains the parameters for CreateVpnConnection. - VpnConnection: - type: object - properties: - customerGatewayConfiguration: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The configuration information for the VPN connection''s customer gateway (in the native XML format). This element is always present in the CreateVpnConnection response; however, it''s present in the DescribeVpnConnections response only if the VPN connection is in the pending or available state.' - customerGatewayId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the customer gateway at your end of the VPN connection. - category: - allOf: - - $ref: '#/components/schemas/String' - - description: The category of the VPN connection. A value of VPN indicates an Amazon Web Services VPN connection. A value of VPN-Classic indicates an Amazon Web Services Classic VPN connection. - state: - allOf: - - $ref: '#/components/schemas/VpnState' - - description: The current state of the VPN connection. - type: - allOf: - - $ref: '#/components/schemas/GatewayType' - - description: The type of VPN connection. - vpnConnectionId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the VPN connection. - vpnGatewayId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the virtual private gateway at the Amazon Web Services side of the VPN connection. - transitGatewayId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the transit gateway associated with the VPN connection. - coreNetworkArn: - allOf: - - $ref: '#/components/schemas/String' - - description: The ARN of the core network. - coreNetworkAttachmentArn: - allOf: - - $ref: '#/components/schemas/String' - - description: The ARN of the core network attachment. - gatewayAssociationState: - allOf: - - $ref: '#/components/schemas/GatewayAssociationState' - - description: The current state of the gateway association. - options: - allOf: - - $ref: '#/components/schemas/VpnConnectionOptions' - - description: The VPN connection options. - routes: - allOf: - - $ref: '#/components/schemas/VpnStaticRouteList' - - description: The static routes associated with the VPN connection. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: Any tags assigned to the VPN connection. - vgwTelemetry: - allOf: - - $ref: '#/components/schemas/VgwTelemetryList' - - description: Information about the VPN tunnel. - description: Describes a VPN connection. - CreateVpnConnectionRouteRequest: - type: object - required: - - DestinationCidrBlock - - VpnConnectionId - title: CreateVpnConnectionRouteRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/VpnConnectionId' - - description: The ID of the VPN connection. - description: Contains the parameters for CreateVpnConnectionRoute. - CreateVpnGatewayRequest: - type: object - required: - - Type - title: CreateVpnGatewayRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/GatewayType' - - description: The type of VPN connection this virtual private gateway supports. - TagSpecification: - allOf: - - $ref: '#/components/schemas/Long' - - description: '

A private Autonomous System Number (ASN) for the Amazon side of a BGP session. If you''re using a 16-bit ASN, it must be in the 64512 to 65534 range. If you''re using a 32-bit ASN, it must be in the 4200000000 to 4294967294 range.

Default: 64512

' - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - description: Contains the parameters for CreateVpnGateway. - VpnGateway: - type: object - properties: - availabilityZone: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The Availability Zone where the virtual private gateway was created, if applicable. This field may be empty or not returned.' - state: - allOf: - - $ref: '#/components/schemas/VpnState' - - description: The current state of the virtual private gateway. - type: - allOf: - - $ref: '#/components/schemas/GatewayType' - - description: The type of VPN connection the virtual private gateway supports. - attachments: - allOf: - - $ref: '#/components/schemas/VpcAttachmentList' - - description: Any VPCs attached to the virtual private gateway. - vpnGatewayId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the virtual private gateway. - amazonSideAsn: - allOf: - - $ref: '#/components/schemas/Long' - - description: The private Autonomous System Number (ASN) for the Amazon side of a BGP session. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: Any tags assigned to the virtual private gateway. - description: Describes a virtual private gateway. - CreditSpecification: - type: object - properties: - cpuCredits: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The credit option for CPU usage of a T2, T3, or T3a instance. Valid values are standard and unlimited.' - description: 'Describes the credit option for CPU usage of a T2, T3, or T3a instance.' - CreditSpecificationRequest: - type: object - required: - - CpuCredits - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The credit option for CPU usage of a T2, T3, or T3a instance. Valid values are standard and unlimited.' - description: 'The credit option for CPU usage of a T2, T3, or T3a instance.' - CurrentGenerationFlag: - type: boolean - CustomerGatewayIdStringList: - type: array - items: - allOf: - - $ref: '#/components/schemas/CustomerGatewayId' - - xml: - name: CustomerGatewayId - CustomerGatewayList: - type: array - items: - allOf: - - $ref: '#/components/schemas/CustomerGateway' - - xml: - name: item - DITMaxResults: - type: integer - minimum: 5 - maximum: 100 - DITOMaxResults: - type: integer - minimum: 5 - maximum: 1000 - DatafeedSubscriptionState: - type: string - enum: - - Active - - Inactive - DedicatedHostFlag: - type: boolean - DefaultNetworkCardIndex: - type: integer - DefaultRouteTableAssociationValue: - type: string - enum: - - enable - - disable - DefaultRouteTablePropagationValue: - type: string - enum: - - enable - - disable - DefaultTargetCapacityType: - type: string - enum: - - spot - - on-demand - DefaultingDhcpOptionsId: - type: string - DeleteCarrierGatewayRequest: - type: object - required: - - CarrierGatewayId - title: DeleteCarrierGatewayRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - DeleteClientVpnEndpointRequest: - type: object - required: - - ClientVpnEndpointId - title: DeleteClientVpnEndpointRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - DeleteClientVpnRouteRequest: - type: object - required: - - ClientVpnEndpointId - - DestinationCidrBlock - title: DeleteClientVpnRouteRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - DeleteCustomerGatewayRequest: - type: object - required: - - CustomerGatewayId - title: DeleteCustomerGatewayRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/CustomerGatewayId' - - description: The ID of the customer gateway. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - description: Contains the parameters for DeleteCustomerGateway. - DeleteDhcpOptionsRequest: - type: object - required: - - DhcpOptionsId - title: DeleteDhcpOptionsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/DhcpOptionsId' - - description: The ID of the DHCP options set. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - DeleteEgressOnlyInternetGatewayRequest: - type: object - required: - - EgressOnlyInternetGatewayId - title: DeleteEgressOnlyInternetGatewayRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/EgressOnlyInternetGatewayId' - - description: The ID of the egress-only internet gateway. - DeleteFleetErrorCode: - type: string - enum: - - fleetIdDoesNotExist - - fleetIdMalformed - - fleetNotInDeletableState - - unexpectedError - DeleteFleetError: - type: object - properties: - code: - allOf: - - $ref: '#/components/schemas/DeleteFleetErrorCode' - - description: The error code. - message: - allOf: - - $ref: '#/components/schemas/String' - - description: The description for the error code. - description: Describes an EC2 Fleet error. - DeleteFleetErrorItem: - type: object - properties: - error: - allOf: - - $ref: '#/components/schemas/DeleteFleetError' - - description: The error. - fleetId: - allOf: - - $ref: '#/components/schemas/FleetId' - - description: The ID of the EC2 Fleet. - description: Describes an EC2 Fleet that was not successfully deleted. - DeleteFleetErrorSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/DeleteFleetErrorItem' - - xml: - name: item - FleetStateCode: - type: string - enum: - - submitted - - active - - deleted - - failed - - deleted_running - - deleted_terminating - - modifying - DeleteFleetSuccessItem: - type: object - properties: - currentFleetState: - allOf: - - $ref: '#/components/schemas/FleetStateCode' - - description: The current state of the EC2 Fleet. - previousFleetState: - allOf: - - $ref: '#/components/schemas/FleetStateCode' - - description: The previous state of the EC2 Fleet. - fleetId: - allOf: - - $ref: '#/components/schemas/FleetId' - - description: The ID of the EC2 Fleet. - description: Describes an EC2 Fleet that was successfully deleted. - DeleteFleetSuccessSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/DeleteFleetSuccessItem' - - xml: - name: item - DeleteFleetsRequest: - type: object - required: - - FleetIds - - TerminateInstances - title: DeleteFleetsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - FleetId: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: '

Indicates whether to terminate the instances when the EC2 Fleet is deleted. The default is to terminate the instances.

To let the instances continue to run after the EC2 Fleet is deleted, specify NoTerminateInstances. Supported only for fleets of type maintain and request.

For instant fleets, you cannot specify NoTerminateInstances. A deleted instant fleet with running instances is not supported.

' - FlowLogIdList: - type: array - items: - allOf: - - $ref: '#/components/schemas/VpcFlowLogId' - - xml: - name: item - DeleteFlowLogsRequest: - type: object - required: - - FlowLogIds - title: DeleteFlowLogsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - FlowLogId: - allOf: - - $ref: '#/components/schemas/FlowLogIdList' - - description: '

One or more flow log IDs.

Constraint: Maximum of 1000 flow log IDs.

' - DeleteFpgaImageRequest: - type: object - required: - - FpgaImageId - title: DeleteFpgaImageRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/FpgaImageId' - - description: The ID of the AFI. - DeleteInstanceEventWindowRequest: - type: object - required: - - InstanceEventWindowId - title: DeleteInstanceEventWindowRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/InstanceEventWindowId' - - description: The ID of the event window. - InstanceEventWindowStateChange: - type: object - properties: - instanceEventWindowId: - allOf: - - $ref: '#/components/schemas/InstanceEventWindowId' - - description: The ID of the event window. - state: - allOf: - - $ref: '#/components/schemas/InstanceEventWindowState' - - description: The current state of the event window. - description: The state of the event window. - DeleteInternetGatewayRequest: - type: object - required: - - InternetGatewayId - title: DeleteInternetGatewayRequest - properties: - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - internetGatewayId: - allOf: - - $ref: '#/components/schemas/InternetGatewayId' - - description: The ID of the internet gateway. - IpamPoolId: - type: string - DeleteIpamPoolRequest: - type: object - required: - - IpamPoolId - title: DeleteIpamPoolRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/IpamPoolId' - - description: The ID of the pool to delete. - DeleteIpamRequest: - type: object - required: - - IpamId - title: DeleteIpamRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: '

Enables you to quickly delete an IPAM, private scopes, pools in private scopes, and any allocations in the pools in private scopes. You cannot delete the IPAM with this option if there is a pool in your public scope. If you use this option, IPAM does the following:

  • Deallocates any CIDRs allocated to VPC resources (such as VPCs) in pools in private scopes.

    No VPC resources are deleted as a result of enabling this option. The CIDR associated with the resource will no longer be allocated from an IPAM pool, but the CIDR itself will remain unchanged.

  • Deprovisions all IPv4 CIDRs provisioned to IPAM pools in private scopes.

  • Deletes all IPAM pools in private scopes.

  • Deletes all non-default private scopes in the IPAM.

  • Deletes the default public and private scopes and the IPAM.

' - IpamScopeId: - type: string - DeleteIpamScopeRequest: - type: object - required: - - IpamScopeId - title: DeleteIpamScopeRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/IpamScopeId' - - description: The ID of the scope to delete. - DeleteKeyPairRequest: - type: object - title: DeleteKeyPairRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/KeyPairId' - - description: The ID of the key pair. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - DeleteLaunchTemplateRequest: - type: object - title: DeleteLaunchTemplateRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/LaunchTemplateName' - - description: The name of the launch template. You must specify either the launch template ID or launch template name in the request. - VersionStringList: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - DeleteLaunchTemplateVersionsRequest: - type: object - required: - - Versions - title: DeleteLaunchTemplateVersionsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/LaunchTemplateName' - - description: The name of the launch template. You must specify either the launch template ID or launch template name in the request. - LaunchTemplateVersion: - allOf: - - $ref: '#/components/schemas/VersionStringList' - - description: The version numbers of one or more launch template versions to delete. - ResponseError: - type: object - properties: - code: - allOf: - - $ref: '#/components/schemas/LaunchTemplateErrorCode' - - description: The error code. - message: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The error message, if applicable.' - description: Describes the error that's returned when you cannot delete a launch template version. - DeleteLaunchTemplateVersionsResponseErrorItem: - type: object - properties: - launchTemplateId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the launch template. - launchTemplateName: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of the launch template. - versionNumber: - allOf: - - $ref: '#/components/schemas/Long' - - description: The version number of the launch template. - responseError: - allOf: - - $ref: '#/components/schemas/ResponseError' - - description: Information about the error. - description: Describes a launch template version that could not be deleted. - DeleteLaunchTemplateVersionsResponseErrorSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/DeleteLaunchTemplateVersionsResponseErrorItem' - - xml: - name: item - DeleteLaunchTemplateVersionsResponseSuccessItem: - type: object - properties: - launchTemplateId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the launch template. - launchTemplateName: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of the launch template. - versionNumber: - allOf: - - $ref: '#/components/schemas/Long' - - description: The version number of the launch template. - description: Describes a launch template version that was successfully deleted. - DeleteLaunchTemplateVersionsResponseSuccessSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/DeleteLaunchTemplateVersionsResponseSuccessItem' - - xml: - name: item - DeleteLocalGatewayRouteRequest: - type: object - required: - - DestinationCidrBlock - - LocalGatewayRouteTableId - title: DeleteLocalGatewayRouteRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - DeleteLocalGatewayRouteTableVpcAssociationRequest: - type: object - required: - - LocalGatewayRouteTableVpcAssociationId - title: DeleteLocalGatewayRouteTableVpcAssociationRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - DeleteManagedPrefixListRequest: - type: object - required: - - PrefixListId - title: DeleteManagedPrefixListRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/PrefixListResourceId' - - description: The ID of the prefix list. - DeleteNatGatewayRequest: - type: object - required: - - NatGatewayId - title: DeleteNatGatewayRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/NatGatewayId' - - description: The ID of the NAT gateway. - DeleteNetworkAclEntryRequest: - type: object - required: - - Egress - - NetworkAclId - - RuleNumber - title: DeleteNetworkAclEntryRequest - properties: - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - egress: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether the rule is an egress rule. - networkAclId: - allOf: - - $ref: '#/components/schemas/NetworkAclId' - - description: The ID of the network ACL. - ruleNumber: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The rule number of the entry to delete. - DeleteNetworkAclRequest: - type: object - required: - - NetworkAclId - title: DeleteNetworkAclRequest - properties: - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - networkAclId: - allOf: - - $ref: '#/components/schemas/NetworkAclId' - - description: The ID of the network ACL. - DeleteNetworkInsightsAccessScopeAnalysisRequest: - type: object - required: - - NetworkInsightsAccessScopeAnalysisId - title: DeleteNetworkInsightsAccessScopeAnalysisRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - DeleteNetworkInsightsAccessScopeRequest: - type: object - required: - - NetworkInsightsAccessScopeId - title: DeleteNetworkInsightsAccessScopeRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/NetworkInsightsAccessScopeId' - - description: The ID of the Network Access Scope. - DeleteNetworkInsightsAnalysisRequest: - type: object - required: - - NetworkInsightsAnalysisId - title: DeleteNetworkInsightsAnalysisRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/NetworkInsightsAnalysisId' - - description: The ID of the network insights analysis. - DeleteNetworkInsightsPathRequest: - type: object - required: - - NetworkInsightsPathId - title: DeleteNetworkInsightsPathRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/NetworkInsightsPathId' - - description: The ID of the path. - DeleteNetworkInterfacePermissionRequest: - type: object - required: - - NetworkInterfacePermissionId - title: DeleteNetworkInterfacePermissionRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - description: Contains the parameters for DeleteNetworkInterfacePermission. - DeleteNetworkInterfaceRequest: - type: object - required: - - NetworkInterfaceId - title: DeleteNetworkInterfaceRequest - properties: - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - networkInterfaceId: - allOf: - - $ref: '#/components/schemas/NetworkInterfaceId' - - description: The ID of the network interface. - description: Contains the parameters for DeleteNetworkInterface. - DeletePlacementGroupRequest: - type: object - required: - - GroupName - title: DeletePlacementGroupRequest - properties: - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - groupName: - allOf: - - $ref: '#/components/schemas/PlacementGroupName' - - description: The name of the placement group. - DeletePublicIpv4PoolRequest: - type: object - required: - - PoolId - title: DeletePublicIpv4PoolRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Ipv4PoolEc2Id' - - description: The ID of the public IPv4 pool you want to delete. - DeleteQueuedReservedInstancesErrorCode: - type: string - enum: - - reserved-instances-id-invalid - - reserved-instances-not-in-queued-state - - unexpected-error - DeleteQueuedReservedInstancesError: - type: object - properties: - code: - allOf: - - $ref: '#/components/schemas/DeleteQueuedReservedInstancesErrorCode' - - description: The error code. - message: - allOf: - - $ref: '#/components/schemas/String' - - description: The error message. - description: Describes the error for a Reserved Instance whose queued purchase could not be deleted. - DeleteQueuedReservedInstancesIdList: - type: array - items: - allOf: - - $ref: '#/components/schemas/ReservationId' - - xml: - name: item - minItems: 1 - maxItems: 100 - DeleteQueuedReservedInstancesRequest: - type: object - required: - - ReservedInstancesIds - title: DeleteQueuedReservedInstancesRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - ReservedInstancesId: - allOf: - - $ref: '#/components/schemas/DeleteQueuedReservedInstancesIdList' - - description: The IDs of the Reserved Instances. - SuccessfulQueuedPurchaseDeletionSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/SuccessfulQueuedPurchaseDeletion' - - xml: - name: item - FailedQueuedPurchaseDeletionSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/FailedQueuedPurchaseDeletion' - - xml: - name: item - DeleteRouteRequest: - type: object - required: - - RouteTableId - title: DeleteRouteRequest - properties: - destinationCidrBlock: - allOf: - - $ref: '#/components/schemas/String' - - description: The IPv4 CIDR range for the route. The value you specify must match the CIDR for the route exactly. - destinationIpv6CidrBlock: - allOf: - - $ref: '#/components/schemas/PrefixListResourceId' - - description: The ID of the prefix list for the route. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - routeTableId: - allOf: - - $ref: '#/components/schemas/RouteTableId' - - description: The ID of the route table. - DeleteRouteTableRequest: - type: object - required: - - RouteTableId - title: DeleteRouteTableRequest - properties: - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - routeTableId: - allOf: - - $ref: '#/components/schemas/RouteTableId' - - description: The ID of the route table. - DeleteSecurityGroupRequest: - type: object - title: DeleteSecurityGroupRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/SecurityGroupName' - - description: '[EC2-Classic, default VPC] The name of the security group. You can specify either the security group name or the security group ID.' - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - DeleteSnapshotRequest: - type: object - required: - - SnapshotId - title: DeleteSnapshotRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/SnapshotId' - - description: The ID of the EBS snapshot. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - DeleteSpotDatafeedSubscriptionRequest: - type: object - title: DeleteSpotDatafeedSubscriptionRequest - properties: - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - description: Contains the parameters for DeleteSpotDatafeedSubscription. - DeleteSubnetCidrReservationRequest: - type: object - required: - - SubnetCidrReservationId - title: DeleteSubnetCidrReservationRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - DeleteSubnetRequest: - type: object - required: - - SubnetId - title: DeleteSubnetRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/SubnetId' - - description: The ID of the subnet. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - DeleteTagsRequest: - type: object - required: - - Resources - title: DeleteTagsRequest - properties: - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - resourceId: - allOf: - - $ref: '#/components/schemas/ResourceIdList' - - description: '

The IDs of the resources, separated by spaces.

Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.

' - tag: - allOf: - - $ref: '#/components/schemas/TagList' - - description: '

The tags to delete. Specify a tag key and an optional tag value to delete specific tags. If you specify a tag key without a tag value, we delete any tag with this key regardless of its value. If you specify a tag key with an empty string as the tag value, we delete the tag only if its value is an empty string.

If you omit this parameter, we delete all user-defined tags for the specified resources. We do not delete Amazon Web Services-generated tags (tags that have the aws: prefix).

Constraints: Up to 1000 tags.

' - DeleteTrafficMirrorFilterRequest: - type: object - required: - - TrafficMirrorFilterId - title: DeleteTrafficMirrorFilterRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - DeleteTrafficMirrorFilterRuleRequest: - type: object - required: - - TrafficMirrorFilterRuleId - title: DeleteTrafficMirrorFilterRuleRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - DeleteTrafficMirrorSessionRequest: - type: object - required: - - TrafficMirrorSessionId - title: DeleteTrafficMirrorSessionRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - DeleteTrafficMirrorTargetRequest: - type: object - required: - - TrafficMirrorTargetId - title: DeleteTrafficMirrorTargetRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - DeleteTransitGatewayConnectPeerRequest: - type: object - required: - - TransitGatewayConnectPeerId - title: DeleteTransitGatewayConnectPeerRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - DeleteTransitGatewayConnectRequest: - type: object - required: - - TransitGatewayAttachmentId - title: DeleteTransitGatewayConnectRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - DeleteTransitGatewayMulticastDomainRequest: - type: object - required: - - TransitGatewayMulticastDomainId - title: DeleteTransitGatewayMulticastDomainRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - DeleteTransitGatewayPeeringAttachmentRequest: - type: object - required: - - TransitGatewayAttachmentId - title: DeleteTransitGatewayPeeringAttachmentRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - DeleteTransitGatewayPrefixListReferenceRequest: - type: object - required: - - TransitGatewayRouteTableId - - PrefixListId - title: DeleteTransitGatewayPrefixListReferenceRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - DeleteTransitGatewayRequest: - type: object - required: - - TransitGatewayId - title: DeleteTransitGatewayRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - DeleteTransitGatewayRouteRequest: - type: object - required: - - TransitGatewayRouteTableId - - DestinationCidrBlock - title: DeleteTransitGatewayRouteRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - DeleteTransitGatewayRouteTableRequest: - type: object - required: - - TransitGatewayRouteTableId - title: DeleteTransitGatewayRouteTableRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - DeleteTransitGatewayVpcAttachmentRequest: - type: object - required: - - TransitGatewayAttachmentId - title: DeleteTransitGatewayVpcAttachmentRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - DeleteVolumeRequest: - type: object - required: - - VolumeId - title: DeleteVolumeRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/VolumeId' - - description: The ID of the volume. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - DeleteVpcEndpointConnectionNotificationsRequest: - type: object - required: - - ConnectionNotificationIds - title: DeleteVpcEndpointConnectionNotificationsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - ConnectionNotificationId: - allOf: - - $ref: '#/components/schemas/ConnectionNotificationIdsList' - - description: One or more notification IDs. - VpcEndpointServiceIdList: - type: array - items: - allOf: - - $ref: '#/components/schemas/VpcEndpointServiceId' - - xml: - name: item - DeleteVpcEndpointServiceConfigurationsRequest: - type: object - required: - - ServiceIds - title: DeleteVpcEndpointServiceConfigurationsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - ServiceId: - allOf: - - $ref: '#/components/schemas/VpcEndpointServiceIdList' - - description: The IDs of one or more services. - DeleteVpcEndpointsRequest: - type: object - required: - - VpcEndpointIds - title: DeleteVpcEndpointsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - VpcEndpointId: - allOf: - - $ref: '#/components/schemas/VpcEndpointIdList' - - description: One or more VPC endpoint IDs. - description: Contains the parameters for DeleteVpcEndpoints. - DeleteVpcPeeringConnectionRequest: - type: object - required: - - VpcPeeringConnectionId - title: DeleteVpcPeeringConnectionRequest - properties: - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - vpcPeeringConnectionId: - allOf: - - $ref: '#/components/schemas/VpcPeeringConnectionId' - - description: The ID of the VPC peering connection. - DeleteVpcRequest: - type: object - required: - - VpcId - title: DeleteVpcRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/VpcId' - - description: The ID of the VPC. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - DeleteVpnConnectionRequest: - type: object - required: - - VpnConnectionId - title: DeleteVpnConnectionRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/VpnConnectionId' - - description: The ID of the VPN connection. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - description: Contains the parameters for DeleteVpnConnection. - DeleteVpnConnectionRouteRequest: - type: object - required: - - DestinationCidrBlock - - VpnConnectionId - title: DeleteVpnConnectionRouteRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/VpnConnectionId' - - description: The ID of the VPN connection. - description: Contains the parameters for DeleteVpnConnectionRoute. - DeleteVpnGatewayRequest: - type: object - required: - - VpnGatewayId - title: DeleteVpnGatewayRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/VpnGatewayId' - - description: The ID of the virtual private gateway. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - description: Contains the parameters for DeleteVpnGateway. - DeprovisionByoipCidrRequest: - type: object - required: - - Cidr - title: DeprovisionByoipCidrRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - DeprovisionIpamPoolCidrRequest: - type: object - required: - - IpamPoolId - title: DeprovisionIpamPoolCidrRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The CIDR which you want to deprovision from the pool. - IpamPoolCidr: - type: object - properties: - cidr: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The CIDR provisioned to the IPAM pool. A CIDR is a representation of an IP address and its associated network mask (or netmask) and refers to a range of IP addresses. An IPv4 CIDR example is 10.24.34.0/23. An IPv6 CIDR example is 2001:DB8::/32.' - state: - allOf: - - $ref: '#/components/schemas/IpamPoolCidrState' - - description: The state of the CIDR. - failureReason: - allOf: - - $ref: '#/components/schemas/IpamPoolCidrFailureReason' - - description: Details related to why an IPAM pool CIDR failed to be provisioned. - description: A CIDR provisioned to an IPAM pool. - DeprovisionPublicIpv4PoolCidrRequest: - type: object - required: - - PoolId - - Cidr - title: DeprovisionPublicIpv4PoolCidrRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The CIDR you want to deprovision from the pool. - DeprovisionedAddressSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - DeregisterImageRequest: - type: object - required: - - ImageId - title: DeregisterImageRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/ImageId' - - description: The ID of the AMI. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - description: Contains the parameters for DeregisterImage. - DeregisterInstanceTagAttributeRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether to deregister all tag keys in the current Region. Specify false to deregister all tag keys. - InstanceTagKey: - allOf: - - $ref: '#/components/schemas/InstanceTagKeySet' - - description: Information about the tag keys to deregister. - description: Information about the tag keys to deregister for the current Region. You can either specify individual tag keys or deregister all tag keys in the current Region. You must specify either IncludeAllTagsOfInstance or InstanceTagKeys in the request - DeregisterInstanceEventNotificationAttributesRequest: - type: object - title: DeregisterInstanceEventNotificationAttributesRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/DeregisterInstanceTagAttributeRequest' - - description: Information about the tag keys to deregister. - InstanceTagNotificationAttribute: - type: object - properties: - instanceTagKeySet: - allOf: - - $ref: '#/components/schemas/InstanceTagKeySet' - - description: The registered tag keys. - includeAllTagsOfInstance: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates wheter all tag keys in the current Region are registered to appear in scheduled event notifications. true indicates that all tag keys in the current Region are registered. - description: Describes the registered tag keys for the current Region. - DeregisterTransitGatewayMulticastGroupMembersRequest: - type: object - title: DeregisterTransitGatewayMulticastGroupMembersRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - TransitGatewayMulticastDeregisteredGroupMembers: - type: object - properties: - transitGatewayMulticastDomainId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the transit gateway multicast domain. - deregisteredNetworkInterfaceIds: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The network interface IDs of the deregistered members. - groupIpAddress: - allOf: - - $ref: '#/components/schemas/String' - - description: The IP address assigned to the transit gateway multicast group. - description: Describes the deregistered transit gateway multicast group members. - DeregisterTransitGatewayMulticastGroupSourcesRequest: - type: object - title: DeregisterTransitGatewayMulticastGroupSourcesRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - TransitGatewayMulticastDeregisteredGroupSources: - type: object - properties: - transitGatewayMulticastDomainId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the transit gateway multicast domain. - deregisteredNetworkInterfaceIds: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The network interface IDs of the non-registered members. - groupIpAddress: - allOf: - - $ref: '#/components/schemas/String' - - description: The IP address assigned to the transit gateway multicast group. - description: Describes the deregistered transit gateway multicast group sources. - DescribeAccountAttributesRequest: - type: object - title: DescribeAccountAttributesRequest - properties: - attributeName: - allOf: - - $ref: '#/components/schemas/AccountAttributeNameStringList' - - description: The account attribute names. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - DescribeAddressesAttributeRequest: - type: object - title: DescribeAddressesAttributeRequest - properties: - AllocationId: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - NextToken: - type: string - FilterList: - type: array - items: - allOf: - - $ref: '#/components/schemas/Filter' - - xml: - name: Filter - PublicIpStringList: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: PublicIp - DescribeAddressesRequest: - type: object - title: DescribeAddressesRequest - properties: - Filter: - allOf: - - $ref: '#/components/schemas/FilterList' - - description: '

One or more filters. Filter names and values are case-sensitive.

  • allocation-id - [EC2-VPC] The allocation ID for the address.

  • association-id - [EC2-VPC] The association ID for the address.

  • domain - Indicates whether the address is for use in EC2-Classic (standard) or in a VPC (vpc).

  • instance-id - The ID of the instance the address is associated with, if any.

  • network-border-group - A unique set of Availability Zones, Local Zones, or Wavelength Zones from where Amazon Web Services advertises IP addresses.

  • network-interface-id - [EC2-VPC] The ID of the network interface that the address is associated with, if any.

  • network-interface-owner-id - The Amazon Web Services account ID of the owner.

  • private-ip-address - [EC2-VPC] The private IP address associated with the Elastic IP address.

  • public-ip - The Elastic IP address, or the carrier IP address.

  • tag:<key> - 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. 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.

  • 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.

' - PublicIp: - allOf: - - $ref: '#/components/schemas/PublicIpStringList' - - description: '

One or more Elastic IP addresses.

Default: Describes all your Elastic IP addresses.

' - AllocationId: - allOf: - - $ref: '#/components/schemas/AllocationIdList' - - description: '[EC2-VPC] Information about the allocation IDs.' - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - DescribeAggregateIdFormatRequest: - type: object - title: DescribeAggregateIdFormatRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - IdFormatList: - type: array - items: - allOf: - - $ref: '#/components/schemas/IdFormat' - - xml: - name: item - ZoneNameStringList: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: ZoneName - DescribeAvailabilityZonesRequest: - type: object - title: DescribeAvailabilityZonesRequest - properties: - Filter: - allOf: - - $ref: '#/components/schemas/FilterList' - - description: '

The filters.

  • group-name - For Availability Zones, use the Region name. For Local Zones, use the name of the group associated with the Local Zone (for example, us-west-2-lax-1) For Wavelength Zones, use the name of the group associated with the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).

  • message - The Zone message.

  • opt-in-status - The opt-in status (opted-in, and not-opted-in | opt-in-not-required).

  • parent-zoneID - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.

  • parent-zoneName - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.

  • region-name - The name of the Region for the Zone (for example, us-east-1).

  • state - The state of the Availability Zone, the Local Zone, or the Wavelength Zone (available).

  • zone-id - The ID of the Availability Zone (for example, use1-az1), the Local Zone (for example, usw2-lax1-az1), or the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).

  • zone-type - The type of zone, for example, local-zone.

  • zone-name - The name of the Availability Zone (for example, us-east-1a), the Local Zone (for example, us-west-2-lax-1a), or the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).

  • zone-type - The type of zone, for example, local-zone.

' - ZoneName: - allOf: - - $ref: '#/components/schemas/ZoneNameStringList' - - description: 'The names of the Availability Zones, Local Zones, and Wavelength Zones.' - ZoneId: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: '

Include all Availability Zones, Local Zones, and Wavelength Zones regardless of your opt-in status.

If you do not use this parameter, the results include only the zones for the Regions where you have chosen the option to opt in.

' - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - DescribeBundleTasksRequest: - type: object - title: DescribeBundleTasksRequest - properties: - BundleId: - allOf: - - $ref: '#/components/schemas/BundleIdStringList' - - description: '

The bundle task IDs.

Default: Describes all your bundle tasks.

' - Filter: - allOf: - - $ref: '#/components/schemas/FilterList' - - description: '

The filters.

  • bundle-id - The ID of the bundle task.

  • error-code - If the task failed, the error code returned.

  • error-message - If the task failed, the error message returned.

  • instance-id - The ID of the instance.

  • progress - The level of task completion, as a percentage (for example, 20%).

  • s3-bucket - The Amazon S3 bucket to store the AMI.

  • s3-prefix - The beginning of the AMI name.

  • start-time - The time the task started (for example, 2013-09-15T17:15:20.000Z).

  • state - The state of the task (pending | waiting-for-shutdown | bundling | storing | cancelling | complete | failed).

  • update-time - The time of the most recent update for the task.

' - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - DescribeByoipCidrsMaxResults: - type: integer - minimum: 1 - maximum: 100 - DescribeByoipCidrsRequest: - type: object - required: - - MaxResults - title: DescribeByoipCidrsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: The token for the next page of results. - DescribeCapacityReservationFleetsMaxResults: - type: integer - minimum: 1 - maximum: 100 - DescribeCapacityReservationFleetsRequest: - type: object - title: DescribeCapacityReservationFleetsRequest - properties: - CapacityReservationFleetId: - allOf: - - $ref: '#/components/schemas/DescribeCapacityReservationFleetsMaxResults' - - description: 'The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.' - Filter: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - DescribeCapacityReservationsMaxResults: - type: integer - minimum: 1 - maximum: 1000 - DescribeCapacityReservationsRequest: - type: object - title: DescribeCapacityReservationsRequest - properties: - CapacityReservationId: - allOf: - - $ref: '#/components/schemas/DescribeCapacityReservationsMaxResults' - - description: 'The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.' - Filter: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - DescribeCarrierGatewaysRequest: - type: object - title: DescribeCarrierGatewaysRequest - properties: - CarrierGatewayId: - allOf: - - $ref: '#/components/schemas/CarrierGatewayIdSet' - - description: One or more carrier gateway IDs. - Filter: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - DescribeClassicLinkInstancesMaxResults: - type: integer - minimum: 5 - maximum: 1000 - InstanceIdStringList: - type: array - items: - allOf: - - $ref: '#/components/schemas/InstanceId' - - xml: - name: InstanceId - DescribeClassicLinkInstancesRequest: - type: object - title: DescribeClassicLinkInstancesRequest - properties: - Filter: - allOf: - - $ref: '#/components/schemas/FilterList' - - description: '

One or more filters.

  • group-id - The ID of a VPC security group that''s associated with the instance.

  • instance-id - The ID of the instance.

  • tag:<key> - 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. 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.

  • 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.

  • vpc-id - The ID of the VPC to which the instance is linked.

    vpc-id - The ID of the VPC that the instance is linked to.

' - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - InstanceId: - allOf: - - $ref: '#/components/schemas/InstanceIdStringList' - - description: One or more instance IDs. Must be instances linked to a VPC through ClassicLink. - maxResults: - allOf: - - $ref: '#/components/schemas/DescribeClassicLinkInstancesMaxResults' - - description: '

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

Constraint: If the value is greater than 1000, we return only 1000 items.

' - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token for the next page of results. - DescribeClientVpnAuthorizationRulesMaxResults: - type: integer - minimum: 5 - maximum: 1000 - DescribeClientVpnAuthorizationRulesRequest: - type: object - required: - - ClientVpnEndpointId - title: DescribeClientVpnAuthorizationRulesRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: The token to retrieve the next page of results. - Filter: - allOf: - - $ref: '#/components/schemas/DescribeClientVpnAuthorizationRulesMaxResults' - - description: The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value. - DescribeClientVpnConnectionsMaxResults: - type: integer - minimum: 5 - maximum: 1000 - DescribeClientVpnConnectionsRequest: - type: object - required: - - ClientVpnEndpointId - title: DescribeClientVpnConnectionsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/ClientVpnEndpointId' - - description: The ID of the Client VPN endpoint. - Filter: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - DescribeClientVpnEndpointMaxResults: - type: integer - minimum: 5 - maximum: 1000 - DescribeClientVpnEndpointsRequest: - type: object - title: DescribeClientVpnEndpointsRequest - properties: - ClientVpnEndpointId: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: The token to retrieve the next page of results. - Filter: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - EndpointSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/ClientVpnEndpoint' - - xml: - name: item - DescribeClientVpnRoutesMaxResults: - type: integer - minimum: 5 - maximum: 1000 - DescribeClientVpnRoutesRequest: - type: object - required: - - ClientVpnEndpointId - title: DescribeClientVpnRoutesRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/ClientVpnEndpointId' - - description: The ID of the Client VPN endpoint. - Filter: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - DescribeClientVpnTargetNetworksMaxResults: - type: integer - minimum: 5 - maximum: 1000 - DescribeClientVpnTargetNetworksRequest: - type: object - required: - - ClientVpnEndpointId - title: DescribeClientVpnTargetNetworksRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: The token to retrieve the next page of results. - Filter: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - TargetNetworkSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/TargetNetwork' - - xml: - name: item - DescribeCoipPoolsRequest: - type: object - title: DescribeCoipPoolsRequest - properties: - PoolId: - allOf: - - $ref: '#/components/schemas/CoipPoolIdSet' - - description: The IDs of the address pools. - Filter: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - DescribeConversionTaskList: - type: array - items: - allOf: - - $ref: '#/components/schemas/ConversionTask' - - xml: - name: item - DescribeConversionTasksRequest: - type: object - title: DescribeConversionTasksRequest - properties: - conversionTaskId: - allOf: - - $ref: '#/components/schemas/ConversionIdStringList' - - description: The conversion task IDs. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - DescribeCustomerGatewaysRequest: - type: object - title: DescribeCustomerGatewaysRequest - properties: - CustomerGatewayId: - allOf: - - $ref: '#/components/schemas/CustomerGatewayIdStringList' - - description: '

One or more customer gateway IDs.

Default: Describes all your customer gateways.

' - Filter: - allOf: - - $ref: '#/components/schemas/FilterList' - - description: '

One or more filters.

  • bgp-asn - The customer gateway''s Border Gateway Protocol (BGP) Autonomous System Number (ASN).

  • customer-gateway-id - The ID of the customer gateway.

  • ip-address - The IP address of the customer gateway''s Internet-routable external interface.

  • state - The state of the customer gateway (pending | available | deleting | deleted).

  • type - The type of customer gateway. Currently, the only supported type is ipsec.1.

  • tag:<key> - 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. 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.

  • 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.

' - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - description: Contains the parameters for DescribeCustomerGateways. - DescribeDhcpOptionsMaxResults: - type: integer - minimum: 5 - maximum: 1000 - DhcpOptionsIdStringList: - type: array - items: - allOf: - - $ref: '#/components/schemas/DhcpOptionsId' - - xml: - name: DhcpOptionsId - DescribeDhcpOptionsRequest: - type: object - title: DescribeDhcpOptionsRequest - properties: - DhcpOptionsId: - allOf: - - $ref: '#/components/schemas/DhcpOptionsIdStringList' - - description: '

The IDs of one or more DHCP options sets.

Default: Describes all your DHCP options sets.

' - Filter: - allOf: - - $ref: '#/components/schemas/FilterList' - - description: '

One or more filters.

  • dhcp-options-id - The ID of a DHCP options set.

  • key - The key for one of the options (for example, domain-name).

  • value - The value for one of the options.

  • owner-id - The ID of the Amazon Web Services account that owns the DHCP options set.

  • tag:<key> - 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. 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.

  • 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.

' - dryRun: - allOf: - - $ref: '#/components/schemas/DescribeDhcpOptionsMaxResults' - - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - DhcpOptionsList: - type: array - items: - allOf: - - $ref: '#/components/schemas/DhcpOptions' - - xml: - name: item - DescribeEgressOnlyInternetGatewaysMaxResults: - type: integer - minimum: 5 - maximum: 255 - DescribeEgressOnlyInternetGatewaysRequest: - type: object - title: DescribeEgressOnlyInternetGatewaysRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - EgressOnlyInternetGatewayId: - allOf: - - $ref: '#/components/schemas/String' - - description: The token for the next page of results. - Filter: - allOf: - - $ref: '#/components/schemas/FilterList' - - description: '

One or more filters.

  • tag:<key> - 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. 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.

  • 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.

' - EgressOnlyInternetGatewayList: - type: array - items: - allOf: - - $ref: '#/components/schemas/EgressOnlyInternetGateway' - - xml: - name: item - DescribeElasticGpusMaxResults: - type: integer - minimum: 10 - maximum: 1000 - DescribeElasticGpusRequest: - type: object - title: DescribeElasticGpusRequest - properties: - ElasticGpuId: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - Filter: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to request the next page of results. - ElasticGpuSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/ElasticGpus' - - xml: - name: item - DescribeExportImageTasksMaxResults: - type: integer - minimum: 1 - maximum: 500 - DescribeExportImageTasksRequest: - type: object - title: DescribeExportImageTasksRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - Filter: - allOf: - - $ref: '#/components/schemas/FilterList' - - description: 'Filter tasks using the task-state filter and one of the following values: active, completed, deleting, or deleted.' - ExportImageTaskId: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: A token that indicates the next page of results. - ExportImageTaskList: - type: array - items: - allOf: - - $ref: '#/components/schemas/ExportImageTask' - - xml: - name: item - ExportTaskIdStringList: - type: array - items: - allOf: - - $ref: '#/components/schemas/ExportTaskId' - - xml: - name: ExportTaskId - DescribeExportTasksRequest: - type: object - title: DescribeExportTasksRequest - properties: - exportTaskId: - allOf: - - $ref: '#/components/schemas/ExportTaskIdStringList' - - description: The export task IDs. - Filter: - allOf: - - $ref: '#/components/schemas/FilterList' - - description: the filters for the export tasks. - ExportTaskList: - type: array - items: - allOf: - - $ref: '#/components/schemas/ExportTask' - - xml: - name: item - FastLaunchImageIdList: - type: array - items: - allOf: - - $ref: '#/components/schemas/ImageId' - - xml: - name: ImageId - DescribeFastLaunchImagesRequest: - type: object - title: DescribeFastLaunchImagesRequest - properties: - ImageId: - allOf: - - $ref: '#/components/schemas/FastLaunchImageIdList' - - description: Details for one or more Windows AMI image IDs. - Filter: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - DescribeFastLaunchImagesRequestMaxResults: - type: integer - minimum: 0 - maximum: 200 - DescribeFastLaunchImagesSuccessSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/DescribeFastLaunchImagesSuccessItem' - - xml: - name: item - FastLaunchResourceType: - type: string - enum: - - snapshot - FastLaunchSnapshotConfigurationResponse: - type: object - properties: - targetResourceCount: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The number of pre-provisioned snapshots requested to keep on hand for a fast-launch enabled Windows AMI. - description: Configuration settings for creating and managing pre-provisioned snapshots for a fast-launch enabled Windows AMI. - FastLaunchLaunchTemplateSpecificationResponse: - type: object - properties: - launchTemplateId: - allOf: - - $ref: '#/components/schemas/LaunchTemplateId' - - description: The ID of the launch template for faster launching of the associated Windows AMI. - launchTemplateName: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of the launch template for faster launching of the associated Windows AMI. - version: - allOf: - - $ref: '#/components/schemas/String' - - description: The version of the launch template for faster launching of the associated Windows AMI. - description: Identifies the launch template to use for faster launching of the Windows AMI. - FastLaunchStateCode: - type: string - enum: - - enabling - - enabling-failed - - enabled - - enabled-failed - - disabling - - disabling-failed - DescribeFastLaunchImagesSuccessItem: - type: object - properties: - imageId: - allOf: - - $ref: '#/components/schemas/ImageId' - - description: The image ID that identifies the fast-launch enabled Windows image. - resourceType: - allOf: - - $ref: '#/components/schemas/FastLaunchResourceType' - - description: 'The resource type that is used for pre-provisioning the Windows AMI. Supported values include: snapshot.' - snapshotConfiguration: - allOf: - - $ref: '#/components/schemas/FastLaunchSnapshotConfigurationResponse' - - description: A group of parameters that are used for pre-provisioning the associated Windows AMI using snapshots. - launchTemplate: - allOf: - - $ref: '#/components/schemas/FastLaunchLaunchTemplateSpecificationResponse' - - description: The launch template that the fast-launch enabled Windows AMI uses when it launches Windows instances from pre-provisioned snapshots. - maxParallelLaunches: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The maximum number of parallel instances that are launched for creating resources. - ownerId: - allOf: - - $ref: '#/components/schemas/String' - - description: The owner ID for the fast-launch enabled Windows AMI. - state: - allOf: - - $ref: '#/components/schemas/FastLaunchStateCode' - - description: The current state of faster launching for the specified Windows AMI. - stateTransitionReason: - allOf: - - $ref: '#/components/schemas/String' - - description: The reason that faster launching for the Windows AMI changed to the current state. - stateTransitionTime: - allOf: - - $ref: '#/components/schemas/MillisecondDateTime' - - description: The time that faster launching for the Windows AMI changed to the current state. - description: Describe details about a fast-launch enabled Windows image that meets the requested criteria. Criteria are defined by the DescribeFastLaunchImages action filters. - FastSnapshotRestoreStateCode: - type: string - enum: - - enabling - - optimizing - - enabled - - disabling - - disabled - DescribeFastSnapshotRestoreSuccessItem: - type: object - properties: - snapshotId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the snapshot. - availabilityZone: - allOf: - - $ref: '#/components/schemas/String' - - description: The Availability Zone. - state: - allOf: - - $ref: '#/components/schemas/FastSnapshotRestoreStateCode' - - description: The state of fast snapshot restores. - stateTransitionReason: - allOf: - - $ref: '#/components/schemas/String' - - description: '

The reason for the state transition. The possible values are as follows:

  • Client.UserInitiated - The state successfully transitioned to enabling or disabling.

  • Client.UserInitiated - Lifecycle state transition - The state successfully transitioned to optimizing, enabled, or disabled.

' - ownerId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Amazon Web Services account that enabled fast snapshot restores on the snapshot. - ownerAlias: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Web Services owner alias that enabled fast snapshot restores on the snapshot. This is intended for future use. - enablingTime: - allOf: - - $ref: '#/components/schemas/MillisecondDateTime' - - description: The time at which fast snapshot restores entered the enabling state. - optimizingTime: - allOf: - - $ref: '#/components/schemas/MillisecondDateTime' - - description: The time at which fast snapshot restores entered the optimizing state. - enabledTime: - allOf: - - $ref: '#/components/schemas/MillisecondDateTime' - - description: The time at which fast snapshot restores entered the enabled state. - disablingTime: - allOf: - - $ref: '#/components/schemas/MillisecondDateTime' - - description: The time at which fast snapshot restores entered the disabling state. - disabledTime: - allOf: - - $ref: '#/components/schemas/MillisecondDateTime' - - description: The time at which fast snapshot restores entered the disabled state. - description: Describes fast snapshot restores for a snapshot. - DescribeFastSnapshotRestoreSuccessSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/DescribeFastSnapshotRestoreSuccessItem' - - xml: - name: item - DescribeFastSnapshotRestoresMaxResults: - type: integer - minimum: 0 - maximum: 200 - DescribeFastSnapshotRestoresRequest: - type: object - title: DescribeFastSnapshotRestoresRequest - properties: - Filter: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - DescribeFleetError: - type: object - properties: - launchTemplateAndOverrides: - allOf: - - $ref: '#/components/schemas/LaunchTemplateAndOverridesResponse' - - description: The launch templates and overrides that were used for launching the instances. The values that you specify in the Overrides replace the values in the launch template. - lifecycle: - allOf: - - $ref: '#/components/schemas/InstanceLifecycle' - - description: Indicates if the instance that could not be launched was a Spot Instance or On-Demand Instance. - errorCode: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The error code that indicates why the instance could not be launched. For more information about error codes, see Error codes.' - errorMessage: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The error message that describes why the instance could not be launched. For more information about error messages, see Error codes.' - description: Describes the instances that could not be launched by the fleet. - DescribeFleetHistoryRequest: - type: object - required: - - FleetId - - StartTime - title: DescribeFleetHistoryRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: 'The start date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).' - HistoryRecordSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/HistoryRecordEntry' - - xml: - name: item - DescribeFleetInstancesRequest: - type: object - required: - - FleetId - title: DescribeFleetInstancesRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/FleetId' - - description: The ID of the EC2 Fleet. - Filter: - allOf: - - $ref: '#/components/schemas/FilterList' - - description:

The filters.

  • instance-type - The instance type.

- DescribeFleetsErrorSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/DescribeFleetError' - - xml: - name: item - DescribeFleetsInstances: - type: object - properties: - launchTemplateAndOverrides: - allOf: - - $ref: '#/components/schemas/LaunchTemplateAndOverridesResponse' - - description: The launch templates and overrides that were used for launching the instances. The values that you specify in the Overrides replace the values in the launch template. - lifecycle: - allOf: - - $ref: '#/components/schemas/InstanceLifecycle' - - description: Indicates if the instance that was launched is a Spot Instance or On-Demand Instance. - instanceIds: - allOf: - - $ref: '#/components/schemas/InstanceIdsSet' - - description: The IDs of the instances. - instanceType: - allOf: - - $ref: '#/components/schemas/InstanceType' - - description: The instance type. - platform: - allOf: - - $ref: '#/components/schemas/PlatformValues' - - description: 'The value is Windows for Windows instances. Otherwise, the value is blank.' - description: Describes the instances that were launched by the fleet. - DescribeFleetsInstancesSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/DescribeFleetsInstances' - - xml: - name: item - FleetIdSet: - type: array - items: - $ref: '#/components/schemas/FleetId' - DescribeFleetsRequest: - type: object - title: DescribeFleetsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The token for the next set of results. - FleetId: - allOf: - - $ref: '#/components/schemas/FleetIdSet' - - description: '

The IDs of the EC2 Fleets.

If a fleet is of type instant, you must specify the fleet ID, otherwise it does not appear in the response.

' - Filter: - allOf: - - $ref: '#/components/schemas/FilterList' - - description:

The filters.

  • activity-status - The progress of the EC2 Fleet ( error | pending-fulfillment | pending-termination | fulfilled).

  • excess-capacity-termination-policy - Indicates whether to terminate running instances if the target capacity is decreased below the current EC2 Fleet size (true | false).

  • fleet-state - The state of the EC2 Fleet (submitted | active | deleted | failed | deleted-running | deleted-terminating | modifying).

  • replace-unhealthy-instances - Indicates whether EC2 Fleet should replace unhealthy instances (true | false).

  • type - The type of request (instant | request | maintain).

- FleetSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/FleetData' - - xml: - name: item - DescribeFlowLogsRequest: - type: object - title: DescribeFlowLogsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/FilterList' - - description: '

One or more filters.

  • deliver-log-status - The status of the logs delivery (SUCCESS | FAILED).

  • log-destination-type - The type of destination to which the flow log publishes data. Possible destination types include cloud-watch-logs and s3.

  • flow-log-id - The ID of the flow log.

  • log-group-name - The name of the log group.

  • resource-id - The ID of the VPC, subnet, or network interface.

  • traffic-type - The type of traffic (ACCEPT | REJECT | ALL).

  • tag:<key> - 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. 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.

  • 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.

' - FlowLogId: - allOf: - - $ref: '#/components/schemas/String' - - description: The token for the next page of results. - FlowLogSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/FlowLog' - - xml: - name: item - FpgaImageAttributeName: - type: string - enum: - - description - - name - - loadPermission - - productCodes - DescribeFpgaImageAttributeRequest: - type: object - required: - - FpgaImageId - - Attribute - title: DescribeFpgaImageAttributeRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/FpgaImageAttributeName' - - description: The AFI attribute. - FpgaImageAttribute: - type: object - properties: - fpgaImageId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the AFI. - name: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of the AFI. - description: - allOf: - - $ref: '#/components/schemas/String' - - description: The description of the AFI. - loadPermissions: - allOf: - - $ref: '#/components/schemas/LoadPermissionList' - - description: The load permissions. - productCodes: - allOf: - - $ref: '#/components/schemas/ProductCodeList' - - description: The product codes. - description: Describes an Amazon FPGA image (AFI) attribute. - DescribeFpgaImagesMaxResults: - type: integer - minimum: 5 - maximum: 1000 - FpgaImageIdList: - type: array - items: - allOf: - - $ref: '#/components/schemas/FpgaImageId' - - xml: - name: item - OwnerStringList: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: Owner - DescribeFpgaImagesRequest: - type: object - title: DescribeFpgaImagesRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - FpgaImageId: - allOf: - - $ref: '#/components/schemas/FpgaImageIdList' - - description: The AFI IDs. - Owner: - allOf: - - $ref: '#/components/schemas/OwnerStringList' - - description: 'Filters the AFI by owner. Specify an Amazon Web Services account ID, self (owner is the sender of the request), or an Amazon Web Services owner alias (valid values are amazon | aws-marketplace).' - Filter: - allOf: - - $ref: '#/components/schemas/DescribeFpgaImagesMaxResults' - - description: The maximum number of results to return in a single call. - FpgaImageList: - type: array - items: - allOf: - - $ref: '#/components/schemas/FpgaImage' - - xml: - name: item - OfferingId: - type: string - DescribeHostReservationOfferingsRequest: - type: object - title: DescribeHostReservationOfferingsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/OfferingId' - - description: The ID of the reservation offering. - HostOfferingSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/HostOffering' - - xml: - name: item - DescribeHostReservationsMaxResults: - type: integer - minimum: 5 - maximum: 500 - DescribeHostReservationsRequest: - type: object - title: DescribeHostReservationsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. - HostReservationSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/HostReservation' - - xml: - name: item - RequestHostIdList: - type: array - items: - allOf: - - $ref: '#/components/schemas/DedicatedHostId' - - xml: - name: item - DescribeHostsRequest: - type: object - title: DescribeHostsRequest - properties: - filter: - allOf: - - $ref: '#/components/schemas/FilterList' - - description: '

The filters.

  • auto-placement - Whether auto-placement is enabled or disabled (on | off).

  • availability-zone - The Availability Zone of the host.

  • client-token - The idempotency token that you provided when you allocated the host.

  • host-reservation-id - The ID of the reservation assigned to this host.

  • instance-type - The instance type size that the Dedicated Host is configured to support.

  • state - The allocation state of the Dedicated Host (available | under-assessment | permanent-failure | released | released-permanent-failure).

  • 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.

' - hostId: - allOf: - - $ref: '#/components/schemas/RequestHostIdList' - - description: The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches. - maxResults: - allOf: - - $ref: '#/components/schemas/Integer' - - description: '

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.

You cannot specify this parameter and the host IDs parameter in the same request.

' - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to use to retrieve the next page of results. - HostList: - type: array - items: - allOf: - - $ref: '#/components/schemas/Host' - - xml: - name: item - DescribeIamInstanceProfileAssociationsMaxResults: - type: integer - minimum: 5 - maximum: 1000 - DescribeIamInstanceProfileAssociationsRequest: - type: object - title: DescribeIamInstanceProfileAssociationsRequest - properties: - AssociationId: - allOf: - - $ref: '#/components/schemas/AssociationIdList' - - description: The IAM instance profile associations. - Filter: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: The token to request the next page of results. - IamInstanceProfileAssociationSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/IamInstanceProfileAssociation' - - xml: - name: item - DescribeIdFormatRequest: - type: object - title: DescribeIdFormatRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway ' - DescribeIdentityIdFormatRequest: - type: object - required: - - PrincipalArn - title: DescribeIdentityIdFormatRequest - properties: - principalArn: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The ARN of the principal, which can be an IAM role, IAM user, or the root user.' - resource: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway ' - DescribeImageAttributeRequest: - type: object - required: - - Attribute - - ImageId - title: DescribeImageAttributeRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/ImageId' - - description: The ID of the AMI. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - description: Contains the parameters for DescribeImageAttribute. - ExecutableByStringList: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: ExecutableBy - ImageIdStringList: - type: array - items: - allOf: - - $ref: '#/components/schemas/ImageId' - - xml: - name: ImageId - DescribeImagesRequest: - type: object - title: DescribeImagesRequest - properties: - ExecutableBy: - allOf: - - $ref: '#/components/schemas/ExecutableByStringList' - - description: '

Scopes the images by users with explicit launch permissions. Specify an Amazon Web Services account ID, self (the sender of the request), or all (public AMIs).

  • If you specify an Amazon Web Services account ID that is not your own, only AMIs shared with that specific Amazon Web Services account ID are returned. However, AMIs that are shared with the account’s organization or organizational unit (OU) are not returned.

  • If you specify self or your own Amazon Web Services account ID, AMIs shared with your account are returned. In addition, AMIs that are shared with the organization or OU of which you are member are also returned.

  • If you specify all, all public AMIs are returned.

' - Filter: - allOf: - - $ref: '#/components/schemas/FilterList' - - description: '

The filters.

  • architecture - The image architecture (i386 | x86_64 | arm64).

  • block-device-mapping.delete-on-termination - A Boolean value that indicates whether the Amazon EBS volume is deleted on instance termination.

  • block-device-mapping.device-name - The device name specified in the block device mapping (for example, /dev/sdh or xvdh).

  • block-device-mapping.snapshot-id - The ID of the snapshot used for the Amazon EBS volume.

  • block-device-mapping.volume-size - The volume size of the Amazon EBS volume, in GiB.

  • block-device-mapping.volume-type - The volume type of the Amazon EBS volume (io1 | io2 | gp2 | gp3 | sc1 | st1 | standard).

  • block-device-mapping.encrypted - A Boolean that indicates whether the Amazon EBS volume is encrypted.

  • creation-date - The time when the image was created, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, 2021-09-29T11:04:43.305Z. You can use a wildcard (*), for example, 2021-09-29T*, which matches an entire day.

  • description - The description of the image (provided during image creation).

  • ena-support - A Boolean that indicates whether enhanced networking with ENA is enabled.

  • hypervisor - The hypervisor type (ovm | xen).

  • image-id - The ID of the image.

  • image-type - The image type (machine | kernel | ramdisk).

  • is-public - A Boolean that indicates whether the image is public.

  • kernel-id - The kernel ID.

  • manifest-location - The location of the image manifest.

  • name - The name of the AMI (provided during image creation).

  • owner-alias - The owner alias (amazon | aws-marketplace). The valid aliases are defined in an Amazon-maintained list. This is not the Amazon Web Services account alias that can be set using the IAM console. We recommend that you use the Owner request parameter instead of this filter.

  • owner-id - The Amazon Web Services account ID of the owner. We recommend that you use the Owner request parameter instead of this filter.

  • platform - The platform. To only list Windows-based AMIs, use windows.

  • product-code - The product code.

  • product-code.type - The type of the product code (marketplace).

  • ramdisk-id - The RAM disk ID.

  • root-device-name - The device name of the root device volume (for example, /dev/sda1).

  • root-device-type - The type of the root device volume (ebs | instance-store).

  • state - The state of the image (available | pending | failed).

  • state-reason-code - The reason code for the state change.

  • state-reason-message - The message for the state change.

  • sriov-net-support - A value of simple indicates that enhanced networking with the Intel 82599 VF interface is enabled.

  • tag:<key> - 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. 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.

  • 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.

  • virtualization-type - The virtualization type (paravirtual | hvm).

' - ImageId: - allOf: - - $ref: '#/components/schemas/ImageIdStringList' - - description: '

The image IDs.

Default: Describes all images available to you.

' - Owner: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: '

If true, all deprecated AMIs are included in the response. If false, no deprecated AMIs are included in the response. If no value is specified, the default value is false.

If you are the AMI owner, all deprecated AMIs appear in the response regardless of the value (true or false) that you set for this parameter.

' - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - ImageList: - type: array - items: - allOf: - - $ref: '#/components/schemas/Image' - - xml: - name: item - DescribeImportImageTasksRequest: - type: object - title: DescribeImportImageTasksRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/FilterList' - - description: 'Filter tasks using the task-state filter and one of the following values: active, completed, deleting, or deleted.' - ImportTaskId: - allOf: - - $ref: '#/components/schemas/String' - - description: A token that indicates the next page of results. - ImportImageTaskList: - type: array - items: - allOf: - - $ref: '#/components/schemas/ImportImageTask' - - xml: - name: item - DescribeImportSnapshotTasksRequest: - type: object - title: DescribeImportSnapshotTasksRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/FilterList' - - description: The filters. - ImportTaskId: - allOf: - - $ref: '#/components/schemas/String' - - description: A token that indicates the next page of results. - ImportSnapshotTaskList: - type: array - items: - allOf: - - $ref: '#/components/schemas/ImportSnapshotTask' - - xml: - name: item - InstanceAttributeName: - type: string - enum: - - instanceType - - kernel - - ramdisk - - userData - - disableApiTermination - - instanceInitiatedShutdownBehavior - - rootDeviceName - - blockDeviceMapping - - productCodes - - sourceDestCheck - - groupSet - - ebsOptimized - - sriovNetSupport - - enaSupport - - enclaveOptions - DescribeInstanceAttributeRequest: - type: object - required: - - Attribute - - InstanceId - title: DescribeInstanceAttributeRequest - properties: - attribute: - allOf: - - $ref: '#/components/schemas/InstanceAttributeName' - - description: '

The instance attribute.

Note: The enaSupport attribute is not supported at this time.

' - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - instanceId: - allOf: - - $ref: '#/components/schemas/InstanceId' - - description: The ID of the instance. - DescribeInstanceCreditSpecificationsMaxResults: - type: integer - minimum: 5 - maximum: 1000 - DescribeInstanceCreditSpecificationsRequest: - type: object - title: DescribeInstanceCreditSpecificationsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - Filter: - allOf: - - $ref: '#/components/schemas/FilterList' - - description:

The filters.

  • instance-id - The ID of the instance.

- InstanceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to retrieve the next page of results. - InstanceCreditSpecificationList: - type: array - items: - allOf: - - $ref: '#/components/schemas/InstanceCreditSpecification' - - xml: - name: item - DescribeInstanceEventNotificationAttributesRequest: - type: object - title: DescribeInstanceEventNotificationAttributesRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - InstanceEventWindowIdSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/InstanceEventWindowId' - - xml: - name: InstanceEventWindowId - DescribeInstanceEventWindowsRequest: - type: object - title: DescribeInstanceEventWindowsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - InstanceEventWindowId: - allOf: - - $ref: '#/components/schemas/InstanceEventWindowIdSet' - - description: The IDs of the event windows. - Filter: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to request the next page of results. - description: Describe instance event windows by InstanceEventWindow. - InstanceEventWindowSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/InstanceEventWindow' - - xml: - name: item - DescribeInstanceStatusRequest: - type: object - title: DescribeInstanceStatusRequest - properties: - Filter: - allOf: - - $ref: '#/components/schemas/FilterList' - - description: '

The filters.

  • availability-zone - The Availability Zone of the instance.

  • event.code - The code for the scheduled event (instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop).

  • event.description - A description of the event.

  • event.instance-event-id - The ID of the event whose date and time you are modifying.

  • event.not-after - The latest end time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).

  • event.not-before - The earliest start time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).

  • event.not-before-deadline - The deadline for starting the event (for example, 2014-09-15T17:15:20.000Z).

  • instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).

  • instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

  • instance-status.reachability - Filters on instance status where the name is reachability (passed | failed | initializing | insufficient-data).

  • instance-status.status - The status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

  • system-status.reachability - Filters on system status where the name is reachability (passed | failed | initializing | insufficient-data).

  • system-status.status - The system status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

' - InstanceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to retrieve the next page of results. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - includeAllInstances: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: '

When true, includes the health status for all instances. When false, includes the health status for running instances only.

Default: false

' - InstanceStatusList: - type: array - items: - allOf: - - $ref: '#/components/schemas/InstanceStatus' - - xml: - name: item - LocationType: - type: string - enum: - - region - - availability-zone - - availability-zone-id - DescribeInstanceTypeOfferingsRequest: - type: object - title: DescribeInstanceTypeOfferingsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/LocationType' - - description: The location type. - Filter: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: The token to retrieve the next page of results. - InstanceTypeOfferingsList: - type: array - items: - allOf: - - $ref: '#/components/schemas/InstanceTypeOffering' - - xml: - name: item - RequestInstanceTypeList: - type: array - items: - $ref: '#/components/schemas/InstanceType' - minItems: 0 - maxItems: 100 - DescribeInstanceTypesRequest: - type: object - title: DescribeInstanceTypesRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - InstanceType: - allOf: - - $ref: '#/components/schemas/RequestInstanceTypeList' - - description: 'The instance types. For more information, see Instance types in the Amazon EC2 User Guide.' - Filter: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: The token to retrieve the next page of results. - InstanceTypeInfoList: - type: array - items: - allOf: - - $ref: '#/components/schemas/InstanceTypeInfo' - - xml: - name: item - DescribeInstancesRequest: - type: object - title: DescribeInstancesRequest - properties: - Filter: - allOf: - - $ref: '#/components/schemas/FilterList' - - description: '

The filters.

  • affinity - The affinity setting for an instance running on a Dedicated Host (default | host).

  • architecture - The instance architecture (i386 | x86_64 | arm64).

  • availability-zone - The Availability Zone of the instance.

  • block-device-mapping.attach-time - The attach time for an EBS volume mapped to the instance, for example, 2010-09-15T17:15:20.000Z.

  • block-device-mapping.delete-on-termination - A Boolean that indicates whether the EBS volume is deleted on instance termination.

  • block-device-mapping.device-name - The device name specified in the block device mapping (for example, /dev/sdh or xvdh).

  • block-device-mapping.status - The status for the EBS volume (attaching | attached | detaching | detached).

  • block-device-mapping.volume-id - The volume ID of the EBS volume.

  • capacity-reservation-id - The ID of the Capacity Reservation into which the instance was launched.

  • client-token - The idempotency token you provided when you launched the instance.

  • dns-name - The public DNS name of the instance.

  • group-id - The ID of the security group for the instance. EC2-Classic only.

  • group-name - The name of the security group for the instance. EC2-Classic only.

  • hibernation-options.configured - A Boolean that indicates whether the instance is enabled for hibernation. A value of true means that the instance is enabled for hibernation.

  • host-id - The ID of the Dedicated Host on which the instance is running, if applicable.

  • hypervisor - The hypervisor type of the instance (ovm | xen). The value xen is used for both Xen and Nitro hypervisors.

  • iam-instance-profile.arn - The instance profile associated with the instance. Specified as an ARN.

  • image-id - The ID of the image used to launch the instance.

  • instance-id - The ID of the instance.

  • instance-lifecycle - Indicates whether this is a Spot Instance or a Scheduled Instance (spot | scheduled).

  • instance-state-code - The state of the instance, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).

  • instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

  • instance-type - The type of instance (for example, t2.micro).

  • instance.group-id - The ID of the security group for the instance.

  • instance.group-name - The name of the security group for the instance.

  • ip-address - The public IPv4 address of the instance.

  • kernel-id - The kernel ID.

  • key-name - The name of the key pair used when the instance was launched.

  • launch-index - When launching multiple instances, this is the index for the instance in the launch group (for example, 0, 1, 2, and so on).

  • launch-time - The time when the instance was launched, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, 2021-09-29T11:04:43.305Z. You can use a wildcard (*), for example, 2021-09-29T*, which matches an entire day.

  • metadata-options.http-tokens - The metadata request authorization state (optional | required)

  • metadata-options.http-put-response-hop-limit - The http metadata request put response hop limit (integer, possible values 1 to 64)

  • metadata-options.http-endpoint - Enable or disable metadata access on http endpoint (enabled | disabled)

  • monitoring-state - Indicates whether detailed monitoring is enabled (disabled | enabled).

  • network-interface.addresses.private-ip-address - The private IPv4 address associated with the network interface.

  • network-interface.addresses.primary - Specifies whether the IPv4 address of the network interface is the primary private IPv4 address.

  • network-interface.addresses.association.public-ip - The ID of the association of an Elastic IP address (IPv4) with a network interface.

  • network-interface.addresses.association.ip-owner-id - The owner ID of the private IPv4 address associated with the network interface.

  • network-interface.association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.

  • network-interface.association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface.

  • network-interface.association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.

  • network-interface.association.association-id - The association ID returned when the network interface was associated with an IPv4 address.

  • network-interface.attachment.attachment-id - The ID of the interface attachment.

  • network-interface.attachment.instance-id - The ID of the instance to which the network interface is attached.

  • network-interface.attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.

  • network-interface.attachment.device-index - The device index to which the network interface is attached.

  • network-interface.attachment.status - The status of the attachment (attaching | attached | detaching | detached).

  • network-interface.attachment.attach-time - The time that the network interface was attached to an instance.

  • network-interface.attachment.delete-on-termination - Specifies whether the attachment is deleted when an instance is terminated.

  • network-interface.availability-zone - The Availability Zone for the network interface.

  • network-interface.description - The description of the network interface.

  • network-interface.group-id - The ID of a security group associated with the network interface.

  • network-interface.group-name - The name of a security group associated with the network interface.

  • network-interface.ipv6-addresses.ipv6-address - The IPv6 address associated with the network interface.

  • network-interface.mac-address - The MAC address of the network interface.

  • network-interface.network-interface-id - The ID of the network interface.

  • network-interface.owner-id - The ID of the owner of the network interface.

  • network-interface.private-dns-name - The private DNS name of the network interface.

  • network-interface.requester-id - The requester ID for the network interface.

  • network-interface.requester-managed - Indicates whether the network interface is being managed by Amazon Web Services.

  • network-interface.status - The status of the network interface (available) | in-use).

  • network-interface.source-dest-check - Whether the network interface performs source/destination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.

  • network-interface.subnet-id - The ID of the subnet for the network interface.

  • network-interface.vpc-id - The ID of the VPC for the network interface.

  • outpost-arn - The Amazon Resource Name (ARN) of the Outpost.

  • owner-id - The Amazon Web Services account ID of the instance owner.

  • placement-group-name - The name of the placement group for the instance.

  • placement-partition-number - The partition in which the instance is located.

  • platform - The platform. To list only Windows instances, use windows.

  • private-dns-name - The private IPv4 DNS name of the instance.

  • private-ip-address - The private IPv4 address of the instance.

  • product-code - The product code associated with the AMI used to launch the instance.

  • product-code.type - The type of product code (devpay | marketplace).

  • ramdisk-id - The RAM disk ID.

  • reason - The reason for the current state of the instance (for example, shows "User Initiated [date]" when you stop or terminate the instance). Similar to the state-reason-code filter.

  • requester-id - The ID of the entity that launched the instance on your behalf (for example, Amazon Web Services Management Console, Auto Scaling, and so on).

  • reservation-id - The ID of the instance''s reservation. A reservation ID is created any time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be associated with more than one instance if you launch multiple instances using the same launch request. For example, if you launch one instance, you get one reservation ID. If you launch ten instances using the same launch request, you also get one reservation ID.

  • root-device-name - The device name of the root device volume (for example, /dev/sda1).

  • root-device-type - The type of the root device volume (ebs | instance-store).

  • source-dest-check - Indicates whether the instance performs source/destination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the instance to perform network address translation (NAT) in your VPC.

  • spot-instance-request-id - The ID of the Spot Instance request.

  • state-reason-code - The reason code for the state change.

  • state-reason-message - A message that describes the state change.

  • subnet-id - The ID of the subnet for the instance.

  • tag:<key> - 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. 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.

  • 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.

  • tenancy - The tenancy of an instance (dedicated | default | host).

  • virtualization-type - The virtualization type of the instance (paravirtual | hvm).

  • vpc-id - The ID of the VPC that the instance is running in.

' - InstanceId: - allOf: - - $ref: '#/components/schemas/InstanceIdStringList' - - description: '

The instance IDs.

Default: Describes all your instances.

' - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - maxResults: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call.' - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to request the next page of results. - ReservationList: - type: array - items: - allOf: - - $ref: '#/components/schemas/Reservation' - - xml: - name: item - DescribeInternetGatewaysMaxResults: - type: integer - minimum: 5 - maximum: 1000 - DescribeInternetGatewaysRequest: - type: object - title: DescribeInternetGatewaysRequest - properties: - Filter: - allOf: - - $ref: '#/components/schemas/FilterList' - - description: '

One or more filters.

  • attachment.state - The current state of the attachment between the gateway and the VPC (available). Present only if a VPC is attached.

  • attachment.vpc-id - The ID of an attached VPC.

  • internet-gateway-id - The ID of the Internet gateway.

  • owner-id - The ID of the Amazon Web Services account that owns the internet gateway.

  • tag:<key> - 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. 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.

  • 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.

' - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - internetGatewayId: - allOf: - - $ref: '#/components/schemas/DescribeInternetGatewaysMaxResults' - - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - InternetGatewayList: - type: array - items: - allOf: - - $ref: '#/components/schemas/InternetGateway' - - xml: - name: item - DescribeIpamPoolsRequest: - type: object - title: DescribeIpamPoolsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - Filter: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: The token for the next page of results. - IpamPoolId: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The IDs of the IPAM pools you would like information on. - IpamPoolSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/IpamPool' - - xml: - name: item - DescribeIpamScopesRequest: - type: object - title: DescribeIpamScopesRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - Filter: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: The token for the next page of results. - IpamScopeId: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The IDs of the scopes you want information on. - IpamScopeSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/IpamScope' - - xml: - name: item - DescribeIpamsRequest: - type: object - title: DescribeIpamsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - Filter: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: The token for the next page of results. - IpamId: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The IDs of the IPAMs you want information on. - IpamSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/Ipam' - - xml: - name: item - DescribeIpv6PoolsRequest: - type: object - title: DescribeIpv6PoolsRequest - properties: - PoolId: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - Filter: - allOf: - - $ref: '#/components/schemas/FilterList' - - description: '

One or more filters.

  • tag:<key> - 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. 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.

  • 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.

' - Ipv6PoolSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/Ipv6Pool' - - xml: - name: item - KeyNameStringList: - type: array - items: - allOf: - - $ref: '#/components/schemas/KeyPairName' - - xml: - name: KeyName - KeyPairIdStringList: - type: array - items: - allOf: - - $ref: '#/components/schemas/KeyPairId' - - xml: - name: KeyPairId - DescribeKeyPairsRequest: - type: object - title: DescribeKeyPairsRequest - properties: - Filter: - allOf: - - $ref: '#/components/schemas/FilterList' - - description: '

The filters.

  • key-pair-id - The ID of the key pair.

  • fingerprint - The fingerprint of the key pair.

  • key-name - The name of the key pair.

  • 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.

  • tag:<key> - 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. 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.

' - KeyName: - allOf: - - $ref: '#/components/schemas/KeyNameStringList' - - description: '

The key pair names.

Default: Describes all of your key pairs.

' - KeyPairId: - allOf: - - $ref: '#/components/schemas/KeyPairIdStringList' - - description: The IDs of the key pairs. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: '

If true, the public key material is included in the response.

Default: false

' - KeyPairList: - type: array - items: - allOf: - - $ref: '#/components/schemas/KeyPairInfo' - - xml: - name: item - DescribeLaunchTemplateVersionsRequest: - type: object - title: DescribeLaunchTemplateVersionsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/LaunchTemplateName' - - description: 'The name of the launch template. To describe one or more versions of a specified launch template, you must specify either the launch template ID or the launch template name in the request. To describe all the latest or default launch template versions in your account, you must omit this parameter.' - LaunchTemplateVersion: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 1 and 200.' - Filter: - allOf: - - $ref: '#/components/schemas/FilterList' - - description:

One or more filters.

  • create-time - The time the launch template version was created.

  • ebs-optimized - A boolean that indicates whether the instance is optimized for Amazon EBS I/O.

  • http-endpoint - Indicates whether the HTTP metadata endpoint on your instances is enabled (enabled | disabled).

  • http-protocol-ipv4 - Indicates whether the IPv4 endpoint for the instance metadata service is enabled (enabled | disabled).

  • host-resource-group-arn - The ARN of the host resource group in which to launch the instances.

  • http-tokens - The state of token usage for your instance metadata requests (optional | required).

  • iam-instance-profile - The ARN of the IAM instance profile.

  • image-id - The ID of the AMI.

  • instance-type - The instance type.

  • is-default-version - A boolean that indicates whether the launch template version is the default version.

  • kernel-id - The kernel ID.

  • license-configuration-arn - The ARN of the license configuration.

  • network-card-index - The index of the network card.

  • ram-disk-id - The RAM disk ID.

- LaunchTemplateVersionSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/LaunchTemplateVersion' - - xml: - name: item - DescribeLaunchTemplatesMaxResults: - type: integer - minimum: 1 - maximum: 200 - LaunchTemplateIdStringList: - type: array - items: - allOf: - - $ref: '#/components/schemas/LaunchTemplateId' - - xml: - name: item - LaunchTemplateNameStringList: - type: array - items: - allOf: - - $ref: '#/components/schemas/LaunchTemplateName' - - xml: - name: item - DescribeLaunchTemplatesRequest: - type: object - title: DescribeLaunchTemplatesRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - LaunchTemplateId: - allOf: - - $ref: '#/components/schemas/LaunchTemplateIdStringList' - - description: One or more launch template IDs. - LaunchTemplateName: - allOf: - - $ref: '#/components/schemas/LaunchTemplateNameStringList' - - description: One or more launch template names. - Filter: - allOf: - - $ref: '#/components/schemas/DescribeLaunchTemplatesMaxResults' - - description: 'The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 1 and 200.' - LaunchTemplateSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/LaunchTemplate' - - xml: - name: item - LocalGatewayRouteTableVirtualInterfaceGroupAssociationIdSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/LocalGatewayRouteTableVirtualInterfaceGroupAssociationId' - - xml: - name: item - DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsRequest: - type: object - title: DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsRequest - properties: - LocalGatewayRouteTableVirtualInterfaceGroupAssociationId: - allOf: - - $ref: '#/components/schemas/LocalGatewayRouteTableVirtualInterfaceGroupAssociationIdSet' - - description: The IDs of the associations. - Filter: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - LocalGatewayRouteTableVirtualInterfaceGroupAssociationSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/LocalGatewayRouteTableVirtualInterfaceGroupAssociation' - - xml: - name: item - LocalGatewayRouteTableVpcAssociationIdSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/LocalGatewayRouteTableVpcAssociationId' - - xml: - name: item - DescribeLocalGatewayRouteTableVpcAssociationsRequest: - type: object - title: DescribeLocalGatewayRouteTableVpcAssociationsRequest - properties: - LocalGatewayRouteTableVpcAssociationId: - allOf: - - $ref: '#/components/schemas/LocalGatewayRouteTableVpcAssociationIdSet' - - description: The IDs of the associations. - Filter: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - LocalGatewayRouteTableVpcAssociationSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/LocalGatewayRouteTableVpcAssociation' - - xml: - name: item - LocalGatewayRouteTableIdSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/LocalGatewayRoutetableId' - - xml: - name: item - DescribeLocalGatewayRouteTablesRequest: - type: object - title: DescribeLocalGatewayRouteTablesRequest - properties: - LocalGatewayRouteTableId: - allOf: - - $ref: '#/components/schemas/LocalGatewayRouteTableIdSet' - - description: The IDs of the local gateway route tables. - Filter: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - LocalGatewayRouteTableSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/LocalGatewayRouteTable' - - xml: - name: item - LocalGatewayVirtualInterfaceGroupIdSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/LocalGatewayVirtualInterfaceGroupId' - - xml: - name: item - DescribeLocalGatewayVirtualInterfaceGroupsRequest: - type: object - title: DescribeLocalGatewayVirtualInterfaceGroupsRequest - properties: - LocalGatewayVirtualInterfaceGroupId: - allOf: - - $ref: '#/components/schemas/LocalGatewayVirtualInterfaceGroupIdSet' - - description: The IDs of the virtual interface groups. - Filter: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - LocalGatewayVirtualInterfaceGroupSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/LocalGatewayVirtualInterfaceGroup' - - xml: - name: item - LocalGatewayVirtualInterfaceIdSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/LocalGatewayVirtualInterfaceId' - - xml: - name: item - DescribeLocalGatewayVirtualInterfacesRequest: - type: object - title: DescribeLocalGatewayVirtualInterfacesRequest - properties: - LocalGatewayVirtualInterfaceId: - allOf: - - $ref: '#/components/schemas/LocalGatewayVirtualInterfaceIdSet' - - description: The IDs of the virtual interfaces. - Filter: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - LocalGatewayVirtualInterfaceSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/LocalGatewayVirtualInterface' - - xml: - name: item - LocalGatewayIdSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/LocalGatewayId' - - xml: - name: item - DescribeLocalGatewaysRequest: - type: object - title: DescribeLocalGatewaysRequest - properties: - LocalGatewayId: - allOf: - - $ref: '#/components/schemas/LocalGatewayIdSet' - - description: The IDs of the local gateways. - Filter: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - LocalGatewaySet: - type: array - items: - allOf: - - $ref: '#/components/schemas/LocalGateway' - - xml: - name: item - DescribeManagedPrefixListsRequest: - type: object - title: DescribeManagedPrefixListsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - Filter: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: The token for the next page of results. - PrefixListId: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: One or more prefix list IDs. - ManagedPrefixListSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/ManagedPrefixList' - - xml: - name: item - DescribeMovingAddressesMaxResults: - type: integer - minimum: 5 - maximum: 1000 - DescribeMovingAddressesRequest: - type: object - title: DescribeMovingAddressesRequest - properties: - filter: - allOf: - - $ref: '#/components/schemas/FilterList' - - description:

One or more filters.

  • moving-status - The status of the Elastic IP address (MovingToVpc | RestoringToClassic).

- dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - maxResults: - allOf: - - $ref: '#/components/schemas/DescribeMovingAddressesMaxResults' - - description: '

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value outside of this range, an error is returned.

Default: If no value is provided, the default is 1000.

' - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token for the next page of results. - publicIp: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: One or more Elastic IP addresses. - MovingAddressStatusSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/MovingAddressStatus' - - xml: - name: item - DescribeNatGatewaysMaxResults: - type: integer - minimum: 5 - maximum: 1000 - DescribeNatGatewaysRequest: - type: object - title: DescribeNatGatewaysRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/DescribeNatGatewaysMaxResults' - - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - NatGatewayId: - allOf: - - $ref: '#/components/schemas/String' - - description: The token for the next page of results. - NatGatewayList: - type: array - items: - allOf: - - $ref: '#/components/schemas/NatGateway' - - xml: - name: item - DescribeNetworkAclsMaxResults: - type: integer - minimum: 5 - maximum: 1000 - DescribeNetworkAclsRequest: - type: object - title: DescribeNetworkAclsRequest - properties: - Filter: - allOf: - - $ref: '#/components/schemas/FilterList' - - description: '

One or more filters.

  • association.association-id - The ID of an association ID for the ACL.

  • association.network-acl-id - The ID of the network ACL involved in the association.

  • association.subnet-id - The ID of the subnet involved in the association.

  • default - Indicates whether the ACL is the default network ACL for the VPC.

  • entry.cidr - The IPv4 CIDR range specified in the entry.

  • entry.icmp.code - The ICMP code specified in the entry, if any.

  • entry.icmp.type - The ICMP type specified in the entry, if any.

  • entry.ipv6-cidr - The IPv6 CIDR range specified in the entry.

  • entry.port-range.from - The start of the port range specified in the entry.

  • entry.port-range.to - The end of the port range specified in the entry.

  • entry.protocol - The protocol specified in the entry (tcp | udp | icmp or a protocol number).

  • entry.rule-action - Allows or denies the matching traffic (allow | deny).

  • entry.rule-number - The number of an entry (in other words, rule) in the set of ACL entries.

  • network-acl-id - The ID of the network ACL.

  • owner-id - The ID of the Amazon Web Services account that owns the network ACL.

  • tag:<key> - 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. 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.

  • 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.

  • vpc-id - The ID of the VPC for the network ACL.

' - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - NetworkAclId: - allOf: - - $ref: '#/components/schemas/DescribeNetworkAclsMaxResults' - - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - NetworkAclList: - type: array - items: - allOf: - - $ref: '#/components/schemas/NetworkAcl' - - xml: - name: item - DescribeNetworkInsightsAccessScopeAnalysesRequest: - type: object - title: DescribeNetworkInsightsAccessScopeAnalysesRequest - properties: - NetworkInsightsAccessScopeAnalysisId: - allOf: - - $ref: '#/components/schemas/MillisecondDateTime' - - description: Filters the results based on the start time. The analysis must have started on or before this time. - Filter: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: The token for the next page of results. - NetworkInsightsAccessScopeAnalysisList: - type: array - items: - allOf: - - $ref: '#/components/schemas/NetworkInsightsAccessScopeAnalysis' - - xml: - name: item - NetworkInsightsAccessScopeIdList: - type: array - items: - allOf: - - $ref: '#/components/schemas/NetworkInsightsAccessScopeId' - - xml: - name: item - DescribeNetworkInsightsAccessScopesRequest: - type: object - title: DescribeNetworkInsightsAccessScopesRequest - properties: - NetworkInsightsAccessScopeId: - allOf: - - $ref: '#/components/schemas/NetworkInsightsAccessScopeIdList' - - description: The IDs of the Network Access Scopes. - Filter: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: The token for the next page of results. - NetworkInsightsAccessScopeList: - type: array - items: - allOf: - - $ref: '#/components/schemas/NetworkInsightsAccessScope' - - xml: - name: item - DescribeNetworkInsightsAnalysesRequest: - type: object - title: DescribeNetworkInsightsAnalysesRequest - properties: - NetworkInsightsAnalysisId: - allOf: - - $ref: '#/components/schemas/MillisecondDateTime' - - description: The time when the network insights analyses ended. - Filter: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: The token for the next page of results. - NetworkInsightsAnalysisList: - type: array - items: - allOf: - - $ref: '#/components/schemas/NetworkInsightsAnalysis' - - xml: - name: item - NetworkInsightsPathIdList: - type: array - items: - allOf: - - $ref: '#/components/schemas/NetworkInsightsPathId' - - xml: - name: item - DescribeNetworkInsightsPathsRequest: - type: object - title: DescribeNetworkInsightsPathsRequest - properties: - NetworkInsightsPathId: - allOf: - - $ref: '#/components/schemas/NetworkInsightsPathIdList' - - description: The IDs of the paths. - Filter: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: The token for the next page of results. - NetworkInsightsPathList: - type: array - items: - allOf: - - $ref: '#/components/schemas/NetworkInsightsPath' - - xml: - name: item - NetworkInterfaceAttribute: - type: string - enum: - - description - - groupSet - - sourceDestCheck - - attachment - DescribeNetworkInterfaceAttributeRequest: - type: object - required: - - NetworkInterfaceId - title: DescribeNetworkInterfaceAttributeRequest - properties: - attribute: - allOf: - - $ref: '#/components/schemas/NetworkInterfaceAttribute' - - description: The attribute of the network interface. This parameter is required. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - networkInterfaceId: - allOf: - - $ref: '#/components/schemas/NetworkInterfaceId' - - description: The ID of the network interface. - description: Contains the parameters for DescribeNetworkInterfaceAttribute. - NetworkInterfaceAttachment: - type: object - properties: - attachTime: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The timestamp indicating when the attachment initiated. - attachmentId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the network interface attachment. - deleteOnTermination: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether the network interface is deleted when the instance is terminated. - deviceIndex: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The device index of the network interface attachment on the instance. - networkCardIndex: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The index of the network card. - instanceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the instance. - instanceOwnerId: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Web Services account ID of the owner of the instance. - status: - allOf: - - $ref: '#/components/schemas/AttachmentStatus' - - description: The attachment state. - description: Describes a network interface attachment. - DescribeNetworkInterfacePermissionsMaxResults: - type: integer - minimum: 5 - maximum: 255 - NetworkInterfacePermissionIdList: - type: array - items: - $ref: '#/components/schemas/NetworkInterfacePermissionId' - DescribeNetworkInterfacePermissionsRequest: - type: object - title: DescribeNetworkInterfacePermissionsRequest - properties: - NetworkInterfacePermissionId: - allOf: - - $ref: '#/components/schemas/NetworkInterfacePermissionIdList' - - description: One or more network interface permission IDs. - Filter: - allOf: - - $ref: '#/components/schemas/DescribeNetworkInterfacePermissionsMaxResults' - - description: 'The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. If this parameter is not specified, up to 50 results are returned by default.' - description: Contains the parameters for DescribeNetworkInterfacePermissions. - NetworkInterfacePermissionList: - type: array - items: - allOf: - - $ref: '#/components/schemas/NetworkInterfacePermission' - - xml: - name: item - DescribeNetworkInterfacesMaxResults: - type: integer - minimum: 5 - maximum: 1000 - DescribeNetworkInterfacesRequest: - type: object - title: DescribeNetworkInterfacesRequest - properties: - filter: - allOf: - - $ref: '#/components/schemas/FilterList' - - description: '

One or more filters.

  • addresses.private-ip-address - The private IPv4 addresses associated with the network interface.

  • addresses.primary - Whether the private IPv4 address is the primary IP address associated with the network interface.

  • addresses.association.public-ip - The association ID returned when the network interface was associated with the Elastic IP address (IPv4).

  • addresses.association.owner-id - The owner ID of the addresses associated with the network interface.

  • association.association-id - The association ID returned when the network interface was associated with an IPv4 address.

  • association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.

  • association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface.

  • association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.

  • association.public-dns-name - The public DNS name for the network interface (IPv4).

  • attachment.attachment-id - The ID of the interface attachment.

  • attachment.attach-time - The time that the network interface was attached to an instance.

  • attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is terminated.

  • attachment.device-index - The device index to which the network interface is attached.

  • attachment.instance-id - The ID of the instance to which the network interface is attached.

  • attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.

  • attachment.status - The status of the attachment (attaching | attached | detaching | detached).

  • availability-zone - The Availability Zone of the network interface.

  • description - The description of the network interface.

  • group-id - The ID of a security group associated with the network interface.

  • group-name - The name of a security group associated with the network interface.

  • ipv6-addresses.ipv6-address - An IPv6 address associated with the network interface.

  • interface-type - The type of network interface (api_gateway_managed | aws_codestar_connections_managed | branch | efa | gateway_load_balancer | gateway_load_balancer_endpoint | global_accelerator_managed | interface | iot_rules_managed | lambda | load_balancer | nat_gateway | network_load_balancer | quicksight | transit_gateway | trunk | vpc_endpoint).

  • mac-address - The MAC address of the network interface.

  • network-interface-id - The ID of the network interface.

  • owner-id - The Amazon Web Services account ID of the network interface owner.

  • private-ip-address - The private IPv4 address or addresses of the network interface.

  • private-dns-name - The private DNS name of the network interface (IPv4).

  • requester-id - The alias or Amazon Web Services account ID of the principal or service that created the network interface.

  • requester-managed - Indicates whether the network interface is being managed by an Amazon Web Service (for example, Amazon Web Services Management Console, Auto Scaling, and so on).

  • source-dest-check - Indicates whether the network interface performs source/destination checking. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.

  • status - The status of the network interface. If the network interface is not attached to an instance, the status is available; if a network interface is attached to an instance the status is in-use.

  • subnet-id - The ID of the subnet for the network interface.

  • tag:<key> - 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. 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.

  • 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.

  • vpc-id - The ID of the VPC for the network interface.

' - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - NetworkInterfaceId: - allOf: - - $ref: '#/components/schemas/DescribeNetworkInterfacesMaxResults' - - description: The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results. You cannot specify this parameter and the network interface IDs parameter in the same request. - description: Contains the parameters for DescribeNetworkInterfaces. - NetworkInterfaceList: - type: array - items: - allOf: - - $ref: '#/components/schemas/NetworkInterface' - - xml: - name: item - PlacementGroupStringList: - type: array - items: - $ref: '#/components/schemas/PlacementGroupName' - PlacementGroupIdStringList: - type: array - items: - allOf: - - $ref: '#/components/schemas/PlacementGroupId' - - xml: - name: GroupId - DescribePlacementGroupsRequest: - type: object - title: DescribePlacementGroupsRequest - properties: - Filter: - allOf: - - $ref: '#/components/schemas/FilterList' - - description: '

The filters.

  • group-name - The name of the placement group.

  • group-arn - The Amazon Resource Name (ARN) of the placement group.

  • state - The state of the placement group (pending | available | deleting | deleted).

  • strategy - The strategy of the placement group (cluster | spread | partition).

  • tag:<key> - 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. 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.

  • 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.

' - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - groupName: - allOf: - - $ref: '#/components/schemas/PlacementGroupStringList' - - description: '

The names of the placement groups.

Default: Describes all your placement groups, or only those otherwise specified.

' - GroupId: - allOf: - - $ref: '#/components/schemas/PlacementGroupIdStringList' - - description: The IDs of the placement groups. - PlacementGroupList: - type: array - items: - allOf: - - $ref: '#/components/schemas/PlacementGroup' - - xml: - name: item - PrefixListResourceIdStringList: - type: array - items: - allOf: - - $ref: '#/components/schemas/PrefixListResourceId' - - xml: - name: item - DescribePrefixListsRequest: - type: object - title: DescribePrefixListsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - Filter: - allOf: - - $ref: '#/components/schemas/String' - - description: The token for the next page of results. - PrefixListId: - allOf: - - $ref: '#/components/schemas/PrefixListResourceIdStringList' - - description: One or more prefix list IDs. - PrefixListSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/PrefixList' - - xml: - name: item - DescribePrincipalIdFormatMaxResults: - type: integer - minimum: 1 - maximum: 1000 - DescribePrincipalIdFormatRequest: - type: object - title: DescribePrincipalIdFormatRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - Resource: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to request the next page of results. - PrincipalIdFormatList: - type: array - items: - allOf: - - $ref: '#/components/schemas/PrincipalIdFormat' - - xml: - name: item - PoolMaxResults: - type: integer - minimum: 1 - maximum: 10 - DescribePublicIpv4PoolsRequest: - type: object - title: DescribePublicIpv4PoolsRequest - properties: - PoolId: - allOf: - - $ref: '#/components/schemas/PoolMaxResults' - - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - Filter: - allOf: - - $ref: '#/components/schemas/FilterList' - - description: '

One or more filters.

  • tag:<key> - 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. 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.

  • 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.

' - PublicIpv4PoolSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/PublicIpv4Pool' - - xml: - name: item - RegionNameStringList: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: RegionName - DescribeRegionsRequest: - type: object - title: DescribeRegionsRequest - properties: - Filter: - allOf: - - $ref: '#/components/schemas/FilterList' - - description: '

The filters.

  • endpoint - The endpoint of the Region (for example, ec2.us-east-1.amazonaws.com).

  • opt-in-status - The opt-in status of the Region (opt-in-not-required | opted-in | not-opted-in).

  • region-name - The name of the Region (for example, us-east-1).

' - RegionName: - allOf: - - $ref: '#/components/schemas/RegionNameStringList' - - description: 'The names of the Regions. You can specify any Regions, whether they are enabled and disabled for your account.' - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Indicates whether to display all Regions, including Regions that are disabled for your account.' - RegionList: - type: array - items: - allOf: - - $ref: '#/components/schemas/Region' - - xml: - name: item - DescribeReplaceRootVolumeTasksMaxResults: - type: integer - minimum: 1 - maximum: 50 - ReplaceRootVolumeTaskIds: - type: array - items: - allOf: - - $ref: '#/components/schemas/ReplaceRootVolumeTaskId' - - xml: - name: ReplaceRootVolumeTaskId - DescribeReplaceRootVolumeTasksRequest: - type: object - title: DescribeReplaceRootVolumeTasksRequest - properties: - ReplaceRootVolumeTaskId: - allOf: - - $ref: '#/components/schemas/ReplaceRootVolumeTaskIds' - - description: The ID of the root volume replacement task to view. - Filter: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - ReplaceRootVolumeTasks: - type: array - items: - allOf: - - $ref: '#/components/schemas/ReplaceRootVolumeTask' - - xml: - name: item - DescribeReservedInstancesListingsRequest: - type: object - title: DescribeReservedInstancesListingsRequest - properties: - Filter: - allOf: - - $ref: '#/components/schemas/FilterList' - - description:

One or more filters.

  • reserved-instances-id - The ID of the Reserved Instances.

  • reserved-instances-listing-id - The ID of the Reserved Instances listing.

  • status - The status of the Reserved Instance listing (pending | active | cancelled | closed).

  • status-message - The reason for the status.

- reservedInstancesId: - allOf: - - $ref: '#/components/schemas/ReservationId' - - description: One or more Reserved Instance IDs. - reservedInstancesListingId: - allOf: - - $ref: '#/components/schemas/ReservedInstancesListingId' - - description: One or more Reserved Instance listing IDs. - description: Contains the parameters for DescribeReservedInstancesListings. - ReservedInstancesModificationIdStringList: - type: array - items: - allOf: - - $ref: '#/components/schemas/ReservedInstancesModificationId' - - xml: - name: ReservedInstancesModificationId - DescribeReservedInstancesModificationsRequest: - type: object - title: DescribeReservedInstancesModificationsRequest - properties: - Filter: - allOf: - - $ref: '#/components/schemas/FilterList' - - description:

One or more filters.

  • client-token - The idempotency token for the modification request.

  • create-date - The time when the modification request was created.

  • effective-date - The time when the modification becomes effective.

  • modification-result.reserved-instances-id - The ID for the Reserved Instances created as part of the modification request. This ID is only available when the status of the modification is fulfilled.

  • modification-result.target-configuration.availability-zone - The Availability Zone for the new Reserved Instances.

  • modification-result.target-configuration.instance-count - The number of new Reserved Instances.

  • modification-result.target-configuration.instance-type - The instance type of the new Reserved Instances.

  • modification-result.target-configuration.platform - The network platform of the new Reserved Instances (EC2-Classic | EC2-VPC).

  • reserved-instances-id - The ID of the Reserved Instances modified.

  • reserved-instances-modification-id - The ID of the modification request.

  • status - The status of the Reserved Instances modification request (processing | fulfilled | failed).

  • status-message - The reason for the status.

  • update-date - The time when the modification request was last updated.

- ReservedInstancesModificationId: - allOf: - - $ref: '#/components/schemas/ReservedInstancesModificationIdStringList' - - description: IDs for the submitted modification request. - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to retrieve the next page of results. - description: Contains the parameters for DescribeReservedInstancesModifications. - ReservedInstancesModificationList: - type: array - items: - allOf: - - $ref: '#/components/schemas/ReservedInstancesModification' - - xml: - name: item - RIProductDescription: - type: string - enum: - - Linux/UNIX - - Linux/UNIX (Amazon VPC) - - Windows - - Windows (Amazon VPC) - ReservedInstancesOfferingIdStringList: - type: array - items: - $ref: '#/components/schemas/ReservedInstancesOfferingId' - OfferingTypeValues: - type: string - enum: - - Heavy Utilization - - Medium Utilization - - Light Utilization - - No Upfront - - Partial Upfront - - All Upfront - DescribeReservedInstancesOfferingsRequest: - type: object - title: DescribeReservedInstancesOfferingsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The Availability Zone in which the Reserved Instance can be used. - Filter: - allOf: - - $ref: '#/components/schemas/RIProductDescription' - - description: The Reserved Instance product platform description. Instances that include (Amazon VPC) in the description are for use with Amazon VPC. - ReservedInstancesOfferingId: - allOf: - - $ref: '#/components/schemas/ReservedInstancesOfferingIdStringList' - - description: One or more Reserved Instances offering IDs. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - instanceTenancy: - allOf: - - $ref: '#/components/schemas/Tenancy' - - description: '

The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy of dedicated is applied to instances that run in a VPC on single-tenant hardware (i.e., Dedicated Instances).

Important: The host value cannot be used with this parameter. Use the default or dedicated values only.

Default: default

' - maxResults: - allOf: - - $ref: '#/components/schemas/Integer' - - description: '

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. The maximum is 100.

Default: 100

' - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to retrieve the next page of results. - offeringType: - allOf: - - $ref: '#/components/schemas/OfferingTypeValues' - - description: 'The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type. ' - description: Contains the parameters for DescribeReservedInstancesOfferings. - ReservedInstancesOfferingList: - type: array - items: - allOf: - - $ref: '#/components/schemas/ReservedInstancesOffering' - - xml: - name: item - OfferingClassType: - type: string - enum: - - standard - - convertible - ReservedInstancesIdStringList: - type: array - items: - allOf: - - $ref: '#/components/schemas/ReservationId' - - xml: - name: ReservedInstancesId - DescribeReservedInstancesRequest: - type: object - title: DescribeReservedInstancesRequest - properties: - Filter: - allOf: - - $ref: '#/components/schemas/OfferingClassType' - - description: Describes whether the Reserved Instance is Standard or Convertible. - ReservedInstancesId: - allOf: - - $ref: '#/components/schemas/ReservedInstancesIdStringList' - - description: '

One or more Reserved Instance IDs.

Default: Describes all your Reserved Instances, or only those otherwise specified.

' - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - offeringType: - allOf: - - $ref: '#/components/schemas/OfferingTypeValues' - - description: 'The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.' - description: Contains the parameters for DescribeReservedInstances. - ReservedInstancesList: - type: array - items: - allOf: - - $ref: '#/components/schemas/ReservedInstances' - - xml: - name: item - DescribeRouteTablesMaxResults: - type: integer - minimum: 5 - maximum: 100 - DescribeRouteTablesRequest: - type: object - title: DescribeRouteTablesRequest - properties: - Filter: - allOf: - - $ref: '#/components/schemas/FilterList' - - description: '

One or more filters.

  • association.route-table-association-id - The ID of an association ID for the route table.

  • association.route-table-id - The ID of the route table involved in the association.

  • association.subnet-id - The ID of the subnet involved in the association.

  • association.main - Indicates whether the route table is the main route table for the VPC (true | false). Route tables that do not have an association ID are not returned in the response.

  • owner-id - The ID of the Amazon Web Services account that owns the route table.

  • route-table-id - The ID of the route table.

  • route.destination-cidr-block - The IPv4 CIDR range specified in a route in the table.

  • route.destination-ipv6-cidr-block - The IPv6 CIDR range specified in a route in the route table.

  • route.destination-prefix-list-id - The ID (prefix) of the Amazon Web Service specified in a route in the table.

  • route.egress-only-internet-gateway-id - The ID of an egress-only Internet gateway specified in a route in the route table.

  • route.gateway-id - The ID of a gateway specified in a route in the table.

  • route.instance-id - The ID of an instance specified in a route in the table.

  • route.nat-gateway-id - The ID of a NAT gateway.

  • route.transit-gateway-id - The ID of a transit gateway.

  • route.origin - Describes how the route was created. CreateRouteTable indicates that the route was automatically created when the route table was created; CreateRoute indicates that the route was manually added to the route table; EnableVgwRoutePropagation indicates that the route was propagated by route propagation.

  • route.state - The state of a route in the route table (active | blackhole). The blackhole state indicates that the route''s target isn''t available (for example, the specified gateway isn''t attached to the VPC, the specified NAT instance has been terminated, and so on).

  • route.vpc-peering-connection-id - The ID of a VPC peering connection specified in a route in the table.

  • tag:<key> - 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. 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.

  • 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.

  • vpc-id - The ID of the VPC for the route table.

' - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - RouteTableId: - allOf: - - $ref: '#/components/schemas/DescribeRouteTablesMaxResults' - - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - RouteTableList: - type: array - items: - allOf: - - $ref: '#/components/schemas/RouteTable' - - xml: - name: item - DescribeScheduledInstanceAvailabilityMaxResults: - type: integer - minimum: 5 - maximum: 300 - ScheduledInstanceRecurrenceRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The interval quantity. The interval unit depends on the value of Frequency. For example, every 2 weeks or every 2 months.' - OccurrenceDay: - allOf: - - $ref: '#/components/schemas/String' - - description: The unit for OccurrenceDays (DayOfWeek or DayOfMonth). This value is required for a monthly schedule. You can't specify DayOfWeek with a weekly schedule. You can't specify this value with a daily schedule. - description: Describes the recurring schedule for a Scheduled Instance. - DescribeScheduledInstanceAvailabilityRequest: - type: object - required: - - FirstSlotStartTimeRange - - Recurrence - title: DescribeScheduledInstanceAvailabilityRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - Filter: - allOf: - - $ref: '#/components/schemas/ScheduledInstanceRecurrenceRequest' - - description: The schedule recurrence. - description: Contains the parameters for DescribeScheduledInstanceAvailability. - ScheduledInstanceAvailabilitySet: - type: array - items: - allOf: - - $ref: '#/components/schemas/ScheduledInstanceAvailability' - - xml: - name: item - SlotStartTimeRangeRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: 'The latest date and time, in UTC, for the Scheduled Instance to start.' - description: Describes the time period for a Scheduled Instance to start its first schedule. - DescribeScheduledInstancesRequest: - type: object - title: DescribeScheduledInstancesRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - Filter: - allOf: - - $ref: '#/components/schemas/String' - - description: The token for the next set of results. - ScheduledInstanceId: - allOf: - - $ref: '#/components/schemas/SlotStartTimeRangeRequest' - - description: The time period for the first schedule to start. - description: Contains the parameters for DescribeScheduledInstances. - ScheduledInstanceSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/ScheduledInstance' - - xml: - name: item - GroupIds: - type: array - items: - allOf: - - $ref: '#/components/schemas/SecurityGroupId' - - xml: - name: item - DescribeSecurityGroupReferencesRequest: - type: object - required: - - GroupId - title: DescribeSecurityGroupReferencesRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/GroupIds' - - description: The IDs of the security groups in your account. - SecurityGroupReferences: - type: array - items: - allOf: - - $ref: '#/components/schemas/SecurityGroupReference' - - xml: - name: item - DescribeSecurityGroupRulesMaxResults: - type: integer - minimum: 5 - maximum: 1000 - DescribeSecurityGroupRulesRequest: - type: object - title: DescribeSecurityGroupRulesRequest - properties: - Filter: - allOf: - - $ref: '#/components/schemas/FilterList' - - description: '

One or more filters.

  • group-id - The ID of the security group.

  • security-group-rule-id - The ID of the security group rule.

  • tag:<key> - 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. 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.

' - SecurityGroupRuleId: - allOf: - - $ref: '#/components/schemas/DescribeSecurityGroupRulesMaxResults' - - description: 'The maximum number of results to return in a single call. To retrieve the remaining results, make another request with the returned NextToken value. This value can be between 5 and 1000. If this parameter is not specified, then all results are returned.' - DescribeSecurityGroupsMaxResults: - type: integer - minimum: 5 - maximum: 1000 - GroupNameStringList: - type: array - items: - allOf: - - $ref: '#/components/schemas/SecurityGroupName' - - xml: - name: GroupName - DescribeSecurityGroupsRequest: - type: object - title: DescribeSecurityGroupsRequest - properties: - Filter: - allOf: - - $ref: '#/components/schemas/FilterList' - - description: '

The filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filters.

  • description - The description of the security group.

  • egress.ip-permission.cidr - An IPv4 CIDR block for an outbound security group rule.

  • egress.ip-permission.from-port - For an outbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number.

  • egress.ip-permission.group-id - The ID of a security group that has been referenced in an outbound security group rule.

  • egress.ip-permission.group-name - The name of a security group that is referenced in an outbound security group rule.

  • egress.ip-permission.ipv6-cidr - An IPv6 CIDR block for an outbound security group rule.

  • egress.ip-permission.prefix-list-id - The ID of a prefix list to which a security group rule allows outbound access.

  • egress.ip-permission.protocol - The IP protocol for an outbound security group rule (tcp | udp | icmp, a protocol number, or -1 for all protocols).

  • egress.ip-permission.to-port - For an outbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code.

  • egress.ip-permission.user-id - The ID of an Amazon Web Services account that has been referenced in an outbound security group rule.

  • group-id - The ID of the security group.

  • group-name - The name of the security group.

  • ip-permission.cidr - An IPv4 CIDR block for an inbound security group rule.

  • ip-permission.from-port - For an inbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number.

  • ip-permission.group-id - The ID of a security group that has been referenced in an inbound security group rule.

  • ip-permission.group-name - The name of a security group that is referenced in an inbound security group rule.

  • ip-permission.ipv6-cidr - An IPv6 CIDR block for an inbound security group rule.

  • ip-permission.prefix-list-id - The ID of a prefix list from which a security group rule allows inbound access.

  • ip-permission.protocol - The IP protocol for an inbound security group rule (tcp | udp | icmp, a protocol number, or -1 for all protocols).

  • ip-permission.to-port - For an inbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code.

  • ip-permission.user-id - The ID of an Amazon Web Services account that has been referenced in an inbound security group rule.

  • owner-id - The Amazon Web Services account ID of the owner of the security group.

  • tag:<key> - 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. 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.

  • 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.

  • vpc-id - The ID of the VPC specified when the security group was created.

' - GroupId: - allOf: - - $ref: '#/components/schemas/GroupIdStringList' - - description: '

The IDs of the security groups. Required for security groups in a nondefault VPC.

Default: Describes all of your security groups.

' - GroupName: - allOf: - - $ref: '#/components/schemas/GroupNameStringList' - - description: '

[EC2-Classic and default VPC only] The names of the security groups. You can specify either the security group name or the security group ID. For security groups in a nondefault VPC, use the group-name filter to describe security groups by name.

Default: Describes all of your security groups.

' - dryRun: - allOf: - - $ref: '#/components/schemas/DescribeSecurityGroupsMaxResults' - - description: 'The maximum number of results to return in a single call. To retrieve the remaining results, make another request with the returned NextToken value. This value can be between 5 and 1000. If this parameter is not specified, then all results are returned.' - SecurityGroupList: - type: array - items: - allOf: - - $ref: '#/components/schemas/SecurityGroup' - - xml: - name: item - DescribeSnapshotAttributeRequest: - type: object - required: - - Attribute - - SnapshotId - title: DescribeSnapshotAttributeRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/SnapshotId' - - description: The ID of the EBS snapshot. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - ProductCodeList: - type: array - items: - allOf: - - $ref: '#/components/schemas/ProductCode' - - xml: - name: item - DescribeSnapshotTierStatusMaxResults: - type: integer - DescribeSnapshotTierStatusRequest: - type: object - title: DescribeSnapshotTierStatusRequest - properties: - Filter: - allOf: - - $ref: '#/components/schemas/DescribeSnapshotTierStatusMaxResults' - - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - snapshotTierStatusSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/SnapshotTierStatus' - - xml: - name: item - RestorableByStringList: - type: array - items: - $ref: '#/components/schemas/String' - SnapshotIdStringList: - type: array - items: - allOf: - - $ref: '#/components/schemas/SnapshotId' - - xml: - name: SnapshotId - DescribeSnapshotsRequest: - type: object - title: DescribeSnapshotsRequest - properties: - Filter: - allOf: - - $ref: '#/components/schemas/String' - - description: The NextToken value returned from a previous paginated DescribeSnapshots request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return. - Owner: - allOf: - - $ref: '#/components/schemas/OwnerStringList' - - description: 'Scopes the results to snapshots with the specified owners. You can specify a combination of Amazon Web Services account IDs, self, and amazon.' - RestorableBy: - allOf: - - $ref: '#/components/schemas/RestorableByStringList' - - description: The IDs of the Amazon Web Services accounts that can create volumes from the snapshot. - SnapshotId: - allOf: - - $ref: '#/components/schemas/SnapshotIdStringList' - - description: '

The snapshot IDs.

Default: Describes the snapshots for which you have create volume permissions.

' - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - SnapshotList: - type: array - items: - allOf: - - $ref: '#/components/schemas/Snapshot' - - xml: - name: item - DescribeSpotDatafeedSubscriptionRequest: - type: object - title: DescribeSpotDatafeedSubscriptionRequest - properties: - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - description: Contains the parameters for DescribeSpotDatafeedSubscription. - DescribeSpotFleetInstancesMaxResults: - type: integer - minimum: 1 - maximum: 1000 - DescribeSpotFleetInstancesRequest: - type: object - required: - - SpotFleetRequestId - title: DescribeSpotFleetInstancesRequest - properties: - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - maxResults: - allOf: - - $ref: '#/components/schemas/DescribeSpotFleetInstancesMaxResults' - - description: 'The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.' - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token for the next set of results. - spotFleetRequestId: - allOf: - - $ref: '#/components/schemas/SpotFleetRequestId' - - description: The ID of the Spot Fleet request. - description: Contains the parameters for DescribeSpotFleetInstances. - DescribeSpotFleetRequestHistoryMaxResults: - type: integer - minimum: 1 - maximum: 1000 - EventType: - type: string - enum: - - instanceChange - - fleetRequestChange - - error - - information - DescribeSpotFleetRequestHistoryRequest: - type: object - required: - - SpotFleetRequestId - - StartTime - title: DescribeSpotFleetRequestHistoryRequest - properties: - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - eventType: - allOf: - - $ref: '#/components/schemas/EventType' - - description: 'The type of events to describe. By default, all events are described.' - maxResults: - allOf: - - $ref: '#/components/schemas/DescribeSpotFleetRequestHistoryMaxResults' - - description: 'The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.' - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token for the next set of results. - spotFleetRequestId: - allOf: - - $ref: '#/components/schemas/SpotFleetRequestId' - - description: The ID of the Spot Fleet request. - startTime: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: 'The starting date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).' - description: Contains the parameters for DescribeSpotFleetRequestHistory. - HistoryRecords: - type: array - items: - allOf: - - $ref: '#/components/schemas/HistoryRecord' - - xml: - name: item - DescribeSpotFleetRequestsRequest: - type: object - title: DescribeSpotFleetRequestsRequest - properties: - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - maxResults: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.' - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token for the next set of results. - spotFleetRequestId: - allOf: - - $ref: '#/components/schemas/SpotFleetRequestIdList' - - description: The IDs of the Spot Fleet requests. - description: Contains the parameters for DescribeSpotFleetRequests. - SpotFleetRequestConfigSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/SpotFleetRequestConfig' - - xml: - name: item - DescribeSpotInstanceRequestsRequest: - type: object - title: DescribeSpotInstanceRequestsRequest - properties: - Filter: - allOf: - - $ref: '#/components/schemas/FilterList' - - description: '

One or more filters.

  • availability-zone-group - The Availability Zone group.

  • create-time - The time stamp when the Spot Instance request was created.

  • fault-code - The fault code related to the request.

  • fault-message - The fault message related to the request.

  • instance-id - The ID of the instance that fulfilled the request.

  • launch-group - The Spot Instance launch group.

  • launch.block-device-mapping.delete-on-termination - Indicates whether the EBS volume is deleted on instance termination.

  • launch.block-device-mapping.device-name - The device name for the volume in the block device mapping (for example, /dev/sdh or xvdh).

  • launch.block-device-mapping.snapshot-id - The ID of the snapshot for the EBS volume.

  • launch.block-device-mapping.volume-size - The size of the EBS volume, in GiB.

  • launch.block-device-mapping.volume-type - The type of EBS volume: gp2 for General Purpose SSD, io1 or io2 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1for Cold HDD, or standard for Magnetic.

  • launch.group-id - The ID of the security group for the instance.

  • launch.group-name - The name of the security group for the instance.

  • launch.image-id - The ID of the AMI.

  • launch.instance-type - The type of instance (for example, m3.medium).

  • launch.kernel-id - The kernel ID.

  • launch.key-name - The name of the key pair the instance launched with.

  • launch.monitoring-enabled - Whether detailed monitoring is enabled for the Spot Instance.

  • launch.ramdisk-id - The RAM disk ID.

  • launched-availability-zone - The Availability Zone in which the request is launched.

  • network-interface.addresses.primary - Indicates whether the IP address is the primary private IP address.

  • network-interface.delete-on-termination - Indicates whether the network interface is deleted when the instance is terminated.

  • network-interface.description - A description of the network interface.

  • network-interface.device-index - The index of the device for the network interface attachment on the instance.

  • network-interface.group-id - The ID of the security group associated with the network interface.

  • network-interface.network-interface-id - The ID of the network interface.

  • network-interface.private-ip-address - The primary private IP address of the network interface.

  • network-interface.subnet-id - The ID of the subnet for the instance.

  • product-description - The product description associated with the instance (Linux/UNIX | Windows).

  • spot-instance-request-id - The Spot Instance request ID.

  • spot-price - The maximum hourly price for any Spot Instance launched to fulfill the request.

  • state - The state of the Spot Instance request (open | active | closed | cancelled | failed). Spot request status information can help you track your Amazon EC2 Spot Instance requests. For more information, see Spot request status in the Amazon EC2 User Guide for Linux Instances.

  • status-code - The short code describing the most recent evaluation of your Spot Instance request.

  • status-message - The message explaining the status of the Spot Instance request.

  • tag:<key> - 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. 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.

  • 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.

  • type - The type of Spot Instance request (one-time | persistent).

  • valid-from - The start date of the request.

  • valid-until - The end date of the request.

' - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - SpotInstanceRequestId: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The maximum number of results to return in a single call. Specify a value between 5 and 1000. To retrieve the remaining results, make another call with the returned NextToken value.' - description: Contains the parameters for DescribeSpotInstanceRequests. - SpotInstanceRequestList: - type: array - items: - allOf: - - $ref: '#/components/schemas/SpotInstanceRequest' - - xml: - name: item - InstanceTypeList: - type: array - items: - $ref: '#/components/schemas/InstanceType' - ProductDescriptionList: - type: array - items: - $ref: '#/components/schemas/String' - DescribeSpotPriceHistoryRequest: - type: object - title: DescribeSpotPriceHistoryRequest - properties: - Filter: - allOf: - - $ref: '#/components/schemas/FilterList' - - description: '

One or more filters.

  • availability-zone - The Availability Zone for which prices should be returned.

  • instance-type - The type of instance (for example, m3.medium).

  • product-description - The product description for the Spot price (Linux/UNIX | Red Hat Enterprise Linux | SUSE Linux | Windows | Linux/UNIX (Amazon VPC) | Red Hat Enterprise Linux (Amazon VPC) | SUSE Linux (Amazon VPC) | Windows (Amazon VPC)).

  • spot-price - The Spot price. The value must match exactly (or use wildcards; greater than or less than comparison is not supported).

  • timestamp - The time stamp of the Spot price history, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). You can use wildcards (* and ?). Greater than or less than comparison is not supported.

' - availabilityZone: - allOf: - - $ref: '#/components/schemas/String' - - description: Filters the results by the specified Availability Zone. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - endTime: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: 'The date and time, up to the current date, from which to stop retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).' - InstanceType: - allOf: - - $ref: '#/components/schemas/InstanceTypeList' - - description: Filters the results by the specified instance types. - maxResults: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.' - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token for the next set of results. - ProductDescription: - allOf: - - $ref: '#/components/schemas/ProductDescriptionList' - - description: Filters the results by the specified basic product descriptions. - startTime: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: 'The date and time, up to the past 90 days, from which to start retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).' - description: Contains the parameters for DescribeSpotPriceHistory. - SpotPriceHistoryList: - type: array - items: - allOf: - - $ref: '#/components/schemas/SpotPrice' - - xml: - name: item - DescribeStaleSecurityGroupsMaxResults: - type: integer - minimum: 5 - maximum: 255 - DescribeStaleSecurityGroupsNextToken: - type: string - minLength: 1 - maxLength: 1024 - DescribeStaleSecurityGroupsRequest: - type: object - required: - - VpcId - title: DescribeStaleSecurityGroupsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/VpcId' - - description: The ID of the VPC. - StaleSecurityGroupSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/StaleSecurityGroup' - - xml: - name: item - DescribeStoreImageTasksRequestMaxResults: - type: integer - minimum: 1 - maximum: 200 - DescribeStoreImageTasksRequest: - type: object - title: DescribeStoreImageTasksRequest - properties: - ImageId: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - Filter: - allOf: - - $ref: '#/components/schemas/DescribeStoreImageTasksRequestMaxResults' - - description: 'The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 1 and 200. You cannot specify this parameter and the ImageIDs parameter in the same call.' - StoreImageTaskResultSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/StoreImageTaskResult' - - xml: - name: item - DescribeSubnetsMaxResults: - type: integer - minimum: 5 - maximum: 1000 - SubnetIdStringList: - type: array - items: - allOf: - - $ref: '#/components/schemas/SubnetId' - - xml: - name: SubnetId - DescribeSubnetsRequest: - type: object - title: DescribeSubnetsRequest - properties: - Filter: - allOf: - - $ref: '#/components/schemas/FilterList' - - description: '

One or more filters.

  • availability-zone - The Availability Zone for the subnet. You can also use availabilityZone as the filter name.

  • availability-zone-id - The ID of the Availability Zone for the subnet. You can also use availabilityZoneId as the filter name.

  • available-ip-address-count - The number of IPv4 addresses in the subnet that are available.

  • cidr-block - The IPv4 CIDR block of the subnet. The CIDR block you specify must exactly match the subnet''s CIDR block for information to be returned for the subnet. You can also use cidr or cidrBlock as the filter names.

  • default-for-az - Indicates whether this is the default subnet for the Availability Zone (true | false). You can also use defaultForAz as the filter name.

  • ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the subnet.

  • ipv6-cidr-block-association.association-id - An association ID for an IPv6 CIDR block associated with the subnet.

  • ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the subnet.

  • ipv6-native - Indicates whether this is an IPv6 only subnet (true | false).

  • outpost-arn - The Amazon Resource Name (ARN) of the Outpost.

  • owner-id - The ID of the Amazon Web Services account that owns the subnet.

  • state - The state of the subnet (pending | available).

  • subnet-arn - The Amazon Resource Name (ARN) of the subnet.

  • subnet-id - The ID of the subnet.

  • tag:<key> - 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. 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.

  • 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.

  • vpc-id - The ID of the VPC for the subnet.

' - SubnetId: - allOf: - - $ref: '#/components/schemas/SubnetIdStringList' - - description: '

One or more subnet IDs.

Default: Describes all your subnets.

' - dryRun: - allOf: - - $ref: '#/components/schemas/DescribeSubnetsMaxResults' - - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - SubnetList: - type: array - items: - allOf: - - $ref: '#/components/schemas/Subnet' - - xml: - name: item - DescribeTagsRequest: - type: object - title: DescribeTagsRequest - properties: - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - Filter: - allOf: - - $ref: '#/components/schemas/FilterList' - - description: '

The filters.

  • key - The tag key.

  • resource-id - The ID of the resource.

  • resource-type - The resource type (customer-gateway | dedicated-host | dhcp-options | elastic-ip | fleet | fpga-image | host-reservation | image | instance | internet-gateway | key-pair | launch-template | natgateway | network-acl | network-interface | placement-group | reserved-instances | route-table | security-group | snapshot | spot-instances-request | subnet | volume | vpc | vpc-endpoint | vpc-endpoint-service | vpc-peering-connection | vpn-connection | vpn-gateway).

  • tag:<key> - The key/value combination of the tag. For example, specify "tag:Owner" for the filter name and "TeamA" for the filter value to find resources with the tag "Owner=TeamA".

  • value - The tag value.

' - maxResults: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The maximum number of results to return in a single call. This value can be between 5 and 1000. To retrieve the remaining results, make another call with the returned NextToken value.' - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to retrieve the next page of results. - TagDescriptionList: - type: array - items: - allOf: - - $ref: '#/components/schemas/TagDescription' - - xml: - name: item - DescribeTrafficMirrorFiltersRequest: - type: object - title: DescribeTrafficMirrorFiltersRequest - properties: - TrafficMirrorFilterId: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - Filter: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: The token for the next page of results. - TrafficMirrorFilterSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/TrafficMirrorFilter' - - xml: - name: item - DescribeTrafficMirrorSessionsRequest: - type: object - title: DescribeTrafficMirrorSessionsRequest - properties: - TrafficMirrorSessionId: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - Filter: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: The token for the next page of results. - TrafficMirrorSessionSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/TrafficMirrorSession' - - xml: - name: item - DescribeTrafficMirrorTargetsRequest: - type: object - title: DescribeTrafficMirrorTargetsRequest - properties: - TrafficMirrorTargetId: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - Filter: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: The token for the next page of results. - TrafficMirrorTargetSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/TrafficMirrorTarget' - - xml: - name: item - TransitGatewayAttachmentIdStringList: - type: array - items: - $ref: '#/components/schemas/TransitGatewayAttachmentId' - DescribeTransitGatewayAttachmentsRequest: - type: object - title: DescribeTransitGatewayAttachmentsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/TransitGatewayAttachmentIdStringList' - - description: The IDs of the attachments. - Filter: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - TransitGatewayAttachmentList: - type: array - items: - allOf: - - $ref: '#/components/schemas/TransitGatewayAttachment' - - xml: - name: item - TransitGatewayConnectPeerIdStringList: - type: array - items: - allOf: - - $ref: '#/components/schemas/TransitGatewayConnectPeerId' - - xml: - name: item - DescribeTransitGatewayConnectPeersRequest: - type: object - title: DescribeTransitGatewayConnectPeersRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/TransitGatewayConnectPeerIdStringList' - - description: The IDs of the Connect peers. - Filter: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - TransitGatewayConnectPeerList: - type: array - items: - allOf: - - $ref: '#/components/schemas/TransitGatewayConnectPeer' - - xml: - name: item - DescribeTransitGatewayConnectsRequest: - type: object - title: DescribeTransitGatewayConnectsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/TransitGatewayAttachmentIdStringList' - - description: The IDs of the attachments. - Filter: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - TransitGatewayConnectList: - type: array - items: - allOf: - - $ref: '#/components/schemas/TransitGatewayConnect' - - xml: - name: item - TransitGatewayMulticastDomainIdStringList: - type: array - items: - allOf: - - $ref: '#/components/schemas/TransitGatewayMulticastDomainId' - - xml: - name: item - DescribeTransitGatewayMulticastDomainsRequest: - type: object - title: DescribeTransitGatewayMulticastDomainsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/TransitGatewayMulticastDomainIdStringList' - - description: The ID of the transit gateway multicast domain. - Filter: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - TransitGatewayMulticastDomainList: - type: array - items: - allOf: - - $ref: '#/components/schemas/TransitGatewayMulticastDomain' - - xml: - name: item - DescribeTransitGatewayPeeringAttachmentsRequest: - type: object - title: DescribeTransitGatewayPeeringAttachmentsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/TransitGatewayAttachmentIdStringList' - - description: One or more IDs of the transit gateway peering attachments. - Filter: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - TransitGatewayPeeringAttachmentList: - type: array - items: - allOf: - - $ref: '#/components/schemas/TransitGatewayPeeringAttachment' - - xml: - name: item - TransitGatewayRouteTableIdStringList: - type: array - items: - allOf: - - $ref: '#/components/schemas/TransitGatewayRouteTableId' - - xml: - name: item - DescribeTransitGatewayRouteTablesRequest: - type: object - title: DescribeTransitGatewayRouteTablesRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/TransitGatewayRouteTableIdStringList' - - description: The IDs of the transit gateway route tables. - Filter: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - TransitGatewayRouteTableList: - type: array - items: - allOf: - - $ref: '#/components/schemas/TransitGatewayRouteTable' - - xml: - name: item - DescribeTransitGatewayVpcAttachmentsRequest: - type: object - title: DescribeTransitGatewayVpcAttachmentsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/TransitGatewayAttachmentIdStringList' - - description: The IDs of the attachments. - Filter: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - TransitGatewayVpcAttachmentList: - type: array - items: - allOf: - - $ref: '#/components/schemas/TransitGatewayVpcAttachment' - - xml: - name: item - TransitGatewayIdStringList: - type: array - items: - allOf: - - $ref: '#/components/schemas/TransitGatewayId' - - xml: - name: item - DescribeTransitGatewaysRequest: - type: object - title: DescribeTransitGatewaysRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/TransitGatewayIdStringList' - - description: The IDs of the transit gateways. - Filter: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - TransitGatewayList: - type: array - items: - allOf: - - $ref: '#/components/schemas/TransitGateway' - - xml: - name: item - DescribeTrunkInterfaceAssociationsMaxResults: - type: integer - minimum: 5 - maximum: 255 - DescribeTrunkInterfaceAssociationsRequest: - type: object - title: DescribeTrunkInterfaceAssociationsRequest - properties: - AssociationId: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - Filter: - allOf: - - $ref: '#/components/schemas/DescribeTrunkInterfaceAssociationsMaxResults' - - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - TrunkInterfaceAssociationList: - type: array - items: - allOf: - - $ref: '#/components/schemas/TrunkInterfaceAssociation' - - xml: - name: item - DescribeVolumeAttributeRequest: - type: object - required: - - Attribute - - VolumeId - title: DescribeVolumeAttributeRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/VolumeId' - - description: The ID of the volume. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - VolumeIdStringList: - type: array - items: - allOf: - - $ref: '#/components/schemas/VolumeId' - - xml: - name: VolumeId - DescribeVolumeStatusRequest: - type: object - title: DescribeVolumeStatusRequest - properties: - Filter: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The NextToken value to include in a future DescribeVolumeStatus request. When the results of the request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.' - VolumeId: - allOf: - - $ref: '#/components/schemas/VolumeIdStringList' - - description: '

The IDs of the volumes.

Default: Describes all your volumes.

' - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - VolumeStatusList: - type: array - items: - allOf: - - $ref: '#/components/schemas/VolumeStatusItem' - - xml: - name: item - DescribeVolumesModificationsRequest: - type: object - title: DescribeVolumesModificationsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - VolumeId: - allOf: - - $ref: '#/components/schemas/VolumeIdStringList' - - description: The IDs of the volumes. - Filter: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The maximum number of results (up to a limit of 500) to be returned in a paginated request. - VolumeModificationList: - type: array - items: - allOf: - - $ref: '#/components/schemas/VolumeModification' - - xml: - name: item - DescribeVolumesRequest: - type: object - title: DescribeVolumesRequest - properties: - Filter: - allOf: - - $ref: '#/components/schemas/FilterList' - - description: '

The filters.

  • attachment.attach-time - The time stamp when the attachment initiated.

  • attachment.delete-on-termination - Whether the volume is deleted on instance termination.

  • attachment.device - The device name specified in the block device mapping (for example, /dev/sda1).

  • attachment.instance-id - The ID of the instance the volume is attached to.

  • attachment.status - The attachment state (attaching | attached | detaching).

  • availability-zone - The Availability Zone in which the volume was created.

  • create-time - The time stamp when the volume was created.

  • encrypted - Indicates whether the volume is encrypted (true | false)

  • multi-attach-enabled - Indicates whether the volume is enabled for Multi-Attach (true | false)

  • fast-restored - Indicates whether the volume was created from a snapshot that is enabled for fast snapshot restore (true | false).

  • size - The size of the volume, in GiB.

  • snapshot-id - The snapshot from which the volume was created.

  • status - The state of the volume (creating | available | in-use | deleting | deleted | error).

  • tag:<key> - 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. 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.

  • 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.

  • volume-id - The volume ID.

  • volume-type - The Amazon EBS volume type (gp2 | gp3 | io1 | io2 | st1 | sc1| standard)

' - VolumeId: - allOf: - - $ref: '#/components/schemas/VolumeIdStringList' - - description: The volume IDs. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - maxResults: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The maximum number of volume results returned by DescribeVolumes in paginated output. When this parameter is used, DescribeVolumes only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeVolumes request with the returned NextToken value. This value can be between 5 and 500; if MaxResults is given a value larger than 500, only 500 results are returned. If this parameter is not used, then DescribeVolumes returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.' - nextToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The NextToken value returned from a previous paginated DescribeVolumes request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return. - VolumeList: - type: array - items: - allOf: - - $ref: '#/components/schemas/Volume' - - xml: - name: item - DescribeVpcAttributeRequest: - type: object - required: - - Attribute - - VpcId - title: DescribeVpcAttributeRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/VpcId' - - description: The ID of the VPC. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - DescribeVpcClassicLinkDnsSupportMaxResults: - type: integer - minimum: 5 - maximum: 255 - DescribeVpcClassicLinkDnsSupportNextToken: - type: string - minLength: 1 - maxLength: 1024 - VpcClassicLinkIdList: - type: array - items: - allOf: - - $ref: '#/components/schemas/VpcId' - - xml: - name: VpcId - DescribeVpcClassicLinkDnsSupportRequest: - type: object - title: DescribeVpcClassicLinkDnsSupportRequest - properties: - maxResults: - allOf: - - $ref: '#/components/schemas/DescribeVpcClassicLinkDnsSupportMaxResults' - - description: '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: - allOf: - - $ref: '#/components/schemas/VpcClassicLinkIdList' - - description: One or more VPC IDs. - DescribeVpcClassicLinkRequest: - type: object - title: DescribeVpcClassicLinkRequest - properties: - Filter: - allOf: - - $ref: '#/components/schemas/FilterList' - - description: '

One or more filters.

  • is-classic-link-enabled - Whether the VPC is enabled for ClassicLink (true | false).

  • tag:<key> - 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. 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.

  • 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.

' - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - VpcId: - allOf: - - $ref: '#/components/schemas/VpcClassicLinkIdList' - - description: One or more VPCs for which you want to describe the ClassicLink status. - VpcClassicLinkList: - type: array - items: - allOf: - - $ref: '#/components/schemas/VpcClassicLink' - - xml: - name: item - DescribeVpcEndpointConnectionNotificationsRequest: - type: object - title: DescribeVpcEndpointConnectionNotificationsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/ConnectionNotificationId' - - description: The ID of the notification. - Filter: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to request the next page of results. - DescribeVpcEndpointConnectionsRequest: - type: object - title: DescribeVpcEndpointConnectionsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - Filter: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to retrieve the next page of results. - VpcEndpointConnectionSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/VpcEndpointConnection' - - xml: - name: item - DescribeVpcEndpointServiceConfigurationsRequest: - type: object - title: DescribeVpcEndpointServiceConfigurationsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - ServiceId: - allOf: - - $ref: '#/components/schemas/VpcEndpointServiceIdList' - - description: The IDs of one or more services. - Filter: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to retrieve the next page of results. - ServiceConfigurationSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/ServiceConfiguration' - - xml: - name: item - DescribeVpcEndpointServicePermissionsRequest: - type: object - required: - - ServiceId - title: DescribeVpcEndpointServicePermissionsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/VpcEndpointServiceId' - - description: The ID of the service. - Filter: - allOf: - - $ref: '#/components/schemas/String' - - description: The token to retrieve the next page of results. - DescribeVpcEndpointServicesRequest: - type: object - title: DescribeVpcEndpointServicesRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - ServiceName: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: One or more service names. - Filter: - allOf: - - $ref: '#/components/schemas/String' - - description: The token for the next set of items to return. (You received this token from a prior call.) - description: Contains the parameters for DescribeVpcEndpointServices. - ServiceDetailSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/ServiceDetail' - - xml: - name: item - DescribeVpcEndpointsRequest: - type: object - title: DescribeVpcEndpointsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - VpcEndpointId: - allOf: - - $ref: '#/components/schemas/VpcEndpointIdList' - - description: One or more endpoint IDs. - Filter: - allOf: - - $ref: '#/components/schemas/String' - - description: The token for the next set of items to return. (You received this token from a prior call.) - description: Contains the parameters for DescribeVpcEndpoints. - VpcEndpointSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/VpcEndpoint' - - xml: - name: item - DescribeVpcPeeringConnectionsMaxResults: - type: integer - minimum: 5 - maximum: 1000 - DescribeVpcPeeringConnectionsRequest: - type: object - title: DescribeVpcPeeringConnectionsRequest - properties: - Filter: - allOf: - - $ref: '#/components/schemas/FilterList' - - description: '

One or more filters.

  • accepter-vpc-info.cidr-block - The IPv4 CIDR block of the accepter VPC.

  • accepter-vpc-info.owner-id - The ID of the Amazon Web Services account that owns the accepter VPC.

  • accepter-vpc-info.vpc-id - The ID of the accepter VPC.

  • expiration-time - The expiration date and time for the VPC peering connection.

  • requester-vpc-info.cidr-block - The IPv4 CIDR block of the requester''s VPC.

  • requester-vpc-info.owner-id - The ID of the Amazon Web Services account that owns the requester VPC.

  • requester-vpc-info.vpc-id - The ID of the requester VPC.

  • status-code - The status of the VPC peering connection (pending-acceptance | failed | expired | provisioning | active | deleting | deleted | rejected).

  • status-message - A message that provides more information about the status of the VPC peering connection, if applicable.

  • tag:<key> - 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. 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.

  • 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.

  • vpc-peering-connection-id - The ID of the VPC peering connection.

' - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - VpcPeeringConnectionId: - allOf: - - $ref: '#/components/schemas/DescribeVpcPeeringConnectionsMaxResults' - - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - VpcPeeringConnectionList: - type: array - items: - allOf: - - $ref: '#/components/schemas/VpcPeeringConnection' - - xml: - name: item - DescribeVpcsMaxResults: - type: integer - minimum: 5 - maximum: 1000 - VpcIdStringList: - type: array - items: - allOf: - - $ref: '#/components/schemas/VpcId' - - xml: - name: VpcId - DescribeVpcsRequest: - type: object - title: DescribeVpcsRequest - properties: - Filter: - allOf: - - $ref: '#/components/schemas/FilterList' - - description: '

One or more filters.

  • cidr - The primary IPv4 CIDR block of the VPC. The CIDR block you specify must exactly match the VPC''s CIDR block for information to be returned for the VPC. Must contain the slash followed by one or two digits (for example, /28).

  • cidr-block-association.cidr-block - An IPv4 CIDR block associated with the VPC.

  • cidr-block-association.association-id - The association ID for an IPv4 CIDR block associated with the VPC.

  • cidr-block-association.state - The state of an IPv4 CIDR block associated with the VPC.

  • dhcp-options-id - The ID of a set of DHCP options.

  • ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the VPC.

  • ipv6-cidr-block-association.ipv6-pool - The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.

  • ipv6-cidr-block-association.association-id - The association ID for an IPv6 CIDR block associated with the VPC.

  • ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the VPC.

  • is-default - Indicates whether the VPC is the default VPC.

  • owner-id - The ID of the Amazon Web Services account that owns the VPC.

  • state - The state of the VPC (pending | available).

  • tag:<key> - 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. 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.

  • 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.

  • vpc-id - The ID of the VPC.

' - VpcId: - allOf: - - $ref: '#/components/schemas/VpcIdStringList' - - description: '

One or more VPC IDs.

Default: Describes all your VPCs.

' - dryRun: - allOf: - - $ref: '#/components/schemas/DescribeVpcsMaxResults' - - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - VpcList: - type: array - items: - allOf: - - $ref: '#/components/schemas/Vpc' - - xml: - name: item - VpnConnectionIdStringList: - type: array - items: - allOf: - - $ref: '#/components/schemas/VpnConnectionId' - - xml: - name: VpnConnectionId - DescribeVpnConnectionsRequest: - type: object - title: DescribeVpnConnectionsRequest - properties: - Filter: - allOf: - - $ref: '#/components/schemas/FilterList' - - description: '

One or more filters.

  • customer-gateway-configuration - The configuration information for the customer gateway.

  • customer-gateway-id - The ID of a customer gateway associated with the VPN connection.

  • state - The state of the VPN connection (pending | available | deleting | deleted).

  • option.static-routes-only - Indicates whether the connection has static routes only. Used for devices that do not support Border Gateway Protocol (BGP).

  • route.destination-cidr-block - The destination CIDR block. This corresponds to the subnet used in a customer data center.

  • bgp-asn - The BGP Autonomous System Number (ASN) associated with a BGP device.

  • tag:<key> - 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. 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.

  • 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.

  • type - The type of VPN connection. Currently the only supported type is ipsec.1.

  • vpn-connection-id - The ID of the VPN connection.

  • vpn-gateway-id - The ID of a virtual private gateway associated with the VPN connection.

  • transit-gateway-id - The ID of a transit gateway associated with the VPN connection.

' - VpnConnectionId: - allOf: - - $ref: '#/components/schemas/VpnConnectionIdStringList' - - description: '

One or more VPN connection IDs.

Default: Describes your VPN connections.

' - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - description: Contains the parameters for DescribeVpnConnections. - VpnConnectionList: - type: array - items: - allOf: - - $ref: '#/components/schemas/VpnConnection' - - xml: - name: item - VpnGatewayIdStringList: - type: array - items: - allOf: - - $ref: '#/components/schemas/VpnGatewayId' - - xml: - name: VpnGatewayId - DescribeVpnGatewaysRequest: - type: object - title: DescribeVpnGatewaysRequest - properties: - Filter: - allOf: - - $ref: '#/components/schemas/FilterList' - - description: '

One or more filters.

  • amazon-side-asn - The Autonomous System Number (ASN) for the Amazon side of the gateway.

  • attachment.state - The current state of the attachment between the gateway and the VPC (attaching | attached | detaching | detached).

  • attachment.vpc-id - The ID of an attached VPC.

  • availability-zone - The Availability Zone for the virtual private gateway (if applicable).

  • state - The state of the virtual private gateway (pending | available | deleting | deleted).

  • tag:<key> - 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. 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.

  • 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.

  • type - The type of virtual private gateway. Currently the only supported type is ipsec.1.

  • vpn-gateway-id - The ID of the virtual private gateway.

' - VpnGatewayId: - allOf: - - $ref: '#/components/schemas/VpnGatewayIdStringList' - - description: '

One or more virtual private gateway IDs.

Default: Describes all your virtual private gateways.

' - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - description: Contains the parameters for DescribeVpnGateways. - VpnGatewayList: - type: array - items: - allOf: - - $ref: '#/components/schemas/VpnGateway' - - xml: - name: item - DestinationFileFormat: - type: string - enum: - - plain-text - - parquet - DestinationOptionsResponse: - type: object - properties: - fileFormat: - allOf: - - $ref: '#/components/schemas/DestinationFileFormat' - - description: The format for the flow log. - hiveCompatiblePartitions: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether to use Hive-compatible prefixes for flow logs stored in Amazon S3. - perHourPartition: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether to partition the flow log per hour. - description: Describes the destination options for a flow log. - DetachClassicLinkVpcRequest: - type: object - required: - - InstanceId - - VpcId - title: DetachClassicLinkVpcRequest - properties: - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - instanceId: - allOf: - - $ref: '#/components/schemas/InstanceId' - - description: The ID of the instance to unlink from the VPC. - vpcId: - allOf: - - $ref: '#/components/schemas/VpcId' - - description: The ID of the VPC to which the instance is linked. - DetachInternetGatewayRequest: - type: object - required: - - InternetGatewayId - - VpcId - title: DetachInternetGatewayRequest - properties: - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - internetGatewayId: - allOf: - - $ref: '#/components/schemas/InternetGatewayId' - - description: The ID of the internet gateway. - vpcId: - allOf: - - $ref: '#/components/schemas/VpcId' - - description: The ID of the VPC. - DetachNetworkInterfaceRequest: - type: object - required: - - AttachmentId - title: DetachNetworkInterfaceRequest - properties: - attachmentId: - allOf: - - $ref: '#/components/schemas/NetworkInterfaceAttachmentId' - - description: The ID of the attachment. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - force: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: '

Specifies whether to force a detachment.

  • Use the Force parameter only as a last resort to detach a network interface from a failed instance.

  • If you use the Force parameter to detach a network interface, you might not be able to attach a different network interface to the same index on the instance without first stopping and starting the instance.

  • If you force the detachment of a network interface, the instance metadata might not get updated. This means that the attributes associated with the detached network interface might still be visible. The instance metadata will get updated when you stop and start the instance.

' - description: Contains the parameters for DetachNetworkInterface. - DetachVolumeRequest: - type: object - required: - - VolumeId - title: DetachVolumeRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/VolumeId' - - description: The ID of the volume. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - DetachVpnGatewayRequest: - type: object - required: - - VpcId - - VpnGatewayId - title: DetachVpnGatewayRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/VpnGatewayId' - - description: The ID of the virtual private gateway. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - description: Contains the parameters for DetachVpnGateway. - DeviceType: - type: string - enum: - - ebs - - instance-store - DhcpConfigurationValueList: - type: array - items: - allOf: - - $ref: '#/components/schemas/AttributeValue' - - xml: - name: item - DhcpConfiguration: - type: object - properties: - key: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of a DHCP option. - valueSet: - allOf: - - $ref: '#/components/schemas/DhcpConfigurationValueList' - - description: One or more values for the DHCP option. - description: Describes a DHCP configuration option. - DhcpConfigurationList: - type: array - items: - allOf: - - $ref: '#/components/schemas/DhcpConfiguration' - - xml: - name: item - DirectoryServiceAuthenticationRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Active Directory to be used for authentication. - description: Describes the Active Directory to be used for client authentication. - DisableEbsEncryptionByDefaultRequest: - type: object - title: DisableEbsEncryptionByDefaultRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - DisableFastLaunchRequest: - type: object - required: - - ImageId - title: DisableFastLaunchRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - DisableFastSnapshotRestoreStateErrorSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/DisableFastSnapshotRestoreStateErrorItem' - - xml: - name: item - DisableFastSnapshotRestoreErrorItem: - type: object - properties: - snapshotId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the snapshot. - fastSnapshotRestoreStateErrorSet: - allOf: - - $ref: '#/components/schemas/DisableFastSnapshotRestoreStateErrorSet' - - description: The errors. - description: Contains information about the errors that occurred when disabling fast snapshot restores. - DisableFastSnapshotRestoreErrorSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/DisableFastSnapshotRestoreErrorItem' - - xml: - name: item - DisableFastSnapshotRestoreStateError: - type: object - properties: - code: - allOf: - - $ref: '#/components/schemas/String' - - description: The error code. - message: - allOf: - - $ref: '#/components/schemas/String' - - description: The error message. - description: Describes an error that occurred when disabling fast snapshot restores. - DisableFastSnapshotRestoreStateErrorItem: - type: object - properties: - availabilityZone: - allOf: - - $ref: '#/components/schemas/String' - - description: The Availability Zone. - error: - allOf: - - $ref: '#/components/schemas/DisableFastSnapshotRestoreStateError' - - description: The error. - description: Contains information about an error that occurred when disabling fast snapshot restores. - DisableFastSnapshotRestoreSuccessItem: - type: object - properties: - snapshotId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the snapshot. - availabilityZone: - allOf: - - $ref: '#/components/schemas/String' - - description: The Availability Zone. - state: - allOf: - - $ref: '#/components/schemas/FastSnapshotRestoreStateCode' - - description: The state of fast snapshot restores for the snapshot. - stateTransitionReason: - allOf: - - $ref: '#/components/schemas/String' - - description: '

The reason for the state transition. The possible values are as follows:

  • Client.UserInitiated - The state successfully transitioned to enabling or disabling.

  • Client.UserInitiated - Lifecycle state transition - The state successfully transitioned to optimizing, enabled, or disabled.

' - ownerId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Amazon Web Services account that enabled fast snapshot restores on the snapshot. - ownerAlias: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Web Services owner alias that enabled fast snapshot restores on the snapshot. This is intended for future use. - enablingTime: - allOf: - - $ref: '#/components/schemas/MillisecondDateTime' - - description: The time at which fast snapshot restores entered the enabling state. - optimizingTime: - allOf: - - $ref: '#/components/schemas/MillisecondDateTime' - - description: The time at which fast snapshot restores entered the optimizing state. - enabledTime: - allOf: - - $ref: '#/components/schemas/MillisecondDateTime' - - description: The time at which fast snapshot restores entered the enabled state. - disablingTime: - allOf: - - $ref: '#/components/schemas/MillisecondDateTime' - - description: The time at which fast snapshot restores entered the disabling state. - disabledTime: - allOf: - - $ref: '#/components/schemas/MillisecondDateTime' - - description: The time at which fast snapshot restores entered the disabled state. - description: Describes fast snapshot restores that were successfully disabled. - DisableFastSnapshotRestoreSuccessSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/DisableFastSnapshotRestoreSuccessItem' - - xml: - name: item - DisableFastSnapshotRestoresRequest: - type: object - required: - - AvailabilityZones - - SourceSnapshotIds - title: DisableFastSnapshotRestoresRequest - properties: - AvailabilityZone: - allOf: - - $ref: '#/components/schemas/AvailabilityZoneStringList' - - description: 'One or more Availability Zones. For example, us-east-2a.' - SourceSnapshotId: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - DisableImageDeprecationRequest: - type: object - required: - - ImageId - title: DisableImageDeprecationRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - DisableIpamOrganizationAdminAccountRequest: - type: object - required: - - DelegatedAdminAccountId - title: DisableIpamOrganizationAdminAccountRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The Organizations member account ID that you want to disable as IPAM account. - DisableSerialConsoleAccessRequest: - type: object - title: DisableSerialConsoleAccessRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - DisableTransitGatewayRouteTablePropagationRequest: - type: object - required: - - TransitGatewayRouteTableId - - TransitGatewayAttachmentId - title: DisableTransitGatewayRouteTablePropagationRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - TransitGatewayPropagation: - type: object - properties: - transitGatewayAttachmentId: - allOf: - - $ref: '#/components/schemas/TransitGatewayAttachmentId' - - description: The ID of the attachment. - resourceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the resource. - resourceType: - allOf: - - $ref: '#/components/schemas/TransitGatewayAttachmentResourceType' - - description: The resource type. Note that the tgw-peering resource type has been deprecated. - transitGatewayRouteTableId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the transit gateway route table. - state: - allOf: - - $ref: '#/components/schemas/TransitGatewayPropagationState' - - description: The state. - description: Describes route propagation. - DisableVgwRoutePropagationRequest: - type: object - required: - - GatewayId - - RouteTableId - title: DisableVgwRoutePropagationRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - description: Contains the parameters for DisableVgwRoutePropagation. - DisableVpcClassicLinkDnsSupportRequest: - type: object - title: DisableVpcClassicLinkDnsSupportRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/VpcId' - - description: The ID of the VPC. - DisableVpcClassicLinkRequest: - type: object - required: - - VpcId - title: DisableVpcClassicLinkRequest - properties: - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - vpcId: - allOf: - - $ref: '#/components/schemas/VpcId' - - description: The ID of the VPC. - DisassociateAddressRequest: - type: object - title: DisassociateAddressRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: '[EC2-Classic] The Elastic IP address. Required for EC2-Classic.' - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - DisassociateClientVpnTargetNetworkRequest: - type: object - required: - - ClientVpnEndpointId - - AssociationId - title: DisassociateClientVpnTargetNetworkRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - DisassociateEnclaveCertificateIamRoleRequest: - type: object - title: DisassociateEnclaveCertificateIamRoleRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - DisassociateIamInstanceProfileRequest: - type: object - required: - - AssociationId - title: DisassociateIamInstanceProfileRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/IamInstanceProfileAssociationId' - - description: The ID of the IAM instance profile association. - InstanceEventWindowDisassociationRequest: - type: object - properties: - InstanceId: - allOf: - - $ref: '#/components/schemas/InstanceIdList' - - description: The IDs of the instances to disassociate from the event window. - InstanceTag: - allOf: - - $ref: '#/components/schemas/TagList' - - description: The instance tags to disassociate from the event window. Any instances associated with the tags will be disassociated from the event window. - DedicatedHostId: - allOf: - - $ref: '#/components/schemas/DedicatedHostIdList' - - description: The IDs of the Dedicated Hosts to disassociate from the event window. - description: The targets to disassociate from the specified event window. - DisassociateInstanceEventWindowRequest: - type: object - required: - - InstanceEventWindowId - - AssociationTarget - title: DisassociateInstanceEventWindowRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/InstanceEventWindowDisassociationRequest' - - description: One or more targets to disassociate from the specified event window. - RouteTableAssociationId: - type: string - DisassociateRouteTableRequest: - type: object - required: - - AssociationId - title: DisassociateRouteTableRequest - properties: - associationId: - allOf: - - $ref: '#/components/schemas/RouteTableAssociationId' - - description: The association ID representing the current association between the route table and subnet or gateway. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - SubnetCidrAssociationId: - type: string - DisassociateSubnetCidrBlockRequest: - type: object - required: - - AssociationId - title: DisassociateSubnetCidrBlockRequest - properties: - associationId: - allOf: - - $ref: '#/components/schemas/SubnetCidrAssociationId' - - description: The association ID for the CIDR block. - DisassociateTransitGatewayMulticastDomainRequest: - type: object - title: DisassociateTransitGatewayMulticastDomainRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - DisassociateTransitGatewayRouteTableRequest: - type: object - required: - - TransitGatewayRouteTableId - - TransitGatewayAttachmentId - title: DisassociateTransitGatewayRouteTableRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - DisassociateTrunkInterfaceRequest: - type: object - required: - - AssociationId - title: DisassociateTrunkInterfaceRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - VpcCidrAssociationId: - type: string - DisassociateVpcCidrBlockRequest: - type: object - required: - - AssociationId - title: DisassociateVpcCidrBlockRequest - properties: - associationId: - allOf: - - $ref: '#/components/schemas/VpcCidrAssociationId' - - description: The association ID for the CIDR block. - DiskCount: - type: integer - VolumeDetail: - type: object - required: - - Size - properties: - size: - type: integer - description: 'The size of the volume, in GiB.' - description: Describes an EBS volume. - DiskImageDescription: - type: object - properties: - checksum: - allOf: - - $ref: '#/components/schemas/String' - - description: The checksum computed for the disk image. - format: - allOf: - - $ref: '#/components/schemas/DiskImageFormat' - - description: The disk image format. - importManifestUrl: - allOf: - - $ref: '#/components/schemas/String' - - description: '

A presigned URL for the import manifest stored in Amazon S3. For information about creating a presigned URL for an Amazon S3 object, read the "Query String Request Authentication Alternative" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.

For information about the import manifest referenced by this API action, see VM Import Manifest.

' - size: - allOf: - - $ref: '#/components/schemas/Long' - - description: 'The size of the disk image, in GiB.' - description: Describes a disk image. - DiskImageDetail: - type: object - required: - - Bytes - - Format - - ImportManifestUrl - properties: - bytes: - allOf: - - $ref: '#/components/schemas/Long' - - description: 'The size of the disk image, in GiB.' - format: - allOf: - - $ref: '#/components/schemas/DiskImageFormat' - - description: The disk image format. - importManifestUrl: - allOf: - - $ref: '#/components/schemas/String' - - description: '

A presigned URL for the import manifest stored in Amazon S3 and presented here as an Amazon S3 presigned URL. For information about creating a presigned URL for an Amazon S3 object, read the "Query String Request Authentication Alternative" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.

For information about the import manifest referenced by this API action, see VM Import Manifest.

' - description: Describes a disk image. - DiskImageList: - type: array - items: - $ref: '#/components/schemas/DiskImage' - DiskImageVolumeDescription: - type: object - properties: - id: - allOf: - - $ref: '#/components/schemas/String' - - description: The volume identifier. - size: - allOf: - - $ref: '#/components/schemas/Long' - - description: 'The size of the volume, in GiB.' - description: Describes a disk image volume. - DiskSize: - type: integer - DiskType: - type: string - enum: - - hdd - - ssd - DiskInfo: - type: object - properties: - sizeInGB: - allOf: - - $ref: '#/components/schemas/DiskSize' - - description: The size of the disk in GB. - count: - allOf: - - $ref: '#/components/schemas/DiskCount' - - description: The number of disks with this configuration. - type: - allOf: - - $ref: '#/components/schemas/DiskType' - - description: The type of disk. - description: Describes a disk. - DiskInfoList: - type: array - items: - allOf: - - $ref: '#/components/schemas/DiskInfo' - - xml: - name: item - DnsEntry: - type: object - properties: - dnsName: - allOf: - - $ref: '#/components/schemas/String' - - description: The DNS name. - hostedZoneId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the private hosted zone. - description: Describes a DNS entry. - DnsEntrySet: - type: array - items: - allOf: - - $ref: '#/components/schemas/DnsEntry' - - xml: - name: item - DnsNameState: - type: string - enum: - - pendingVerification - - verified - - failed - DnsOptions: - type: object - properties: - dnsRecordIpType: - allOf: - - $ref: '#/components/schemas/DnsRecordIpType' - - description: The DNS records created for the endpoint. - description: Describes the DNS options for an endpoint. - DnsOptionsSpecification: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/DnsRecordIpType' - - description: The DNS records created for the endpoint. - description: Describes the DNS options for an endpoint. - DnsServersOptionsModifyStructure: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether DNS servers should be used. Specify False to delete the existing DNS servers. - description: Information about the DNS server to be used. - DnsSupportValue: - type: string - enum: - - enable - - disable - DoubleWithConstraints: - type: number - format: double - minimum: 0.001 - maximum: 99.999 - EbsEncryptionSupport: - type: string - enum: - - unsupported - - supported - EbsOptimizedSupport: - type: string - enum: - - unsupported - - supported - - default - EbsOptimizedInfo: - type: object - properties: - baselineBandwidthInMbps: - allOf: - - $ref: '#/components/schemas/BaselineBandwidthInMbps' - - description: 'The baseline bandwidth performance for an EBS-optimized instance type, in Mbps.' - baselineThroughputInMBps: - allOf: - - $ref: '#/components/schemas/BaselineThroughputInMBps' - - description: 'The baseline throughput performance for an EBS-optimized instance type, in MB/s.' - baselineIops: - allOf: - - $ref: '#/components/schemas/BaselineIops' - - description: The baseline input/output storage operations per seconds for an EBS-optimized instance type. - maximumBandwidthInMbps: - allOf: - - $ref: '#/components/schemas/MaximumBandwidthInMbps' - - description: 'The maximum bandwidth performance for an EBS-optimized instance type, in Mbps.' - maximumThroughputInMBps: - allOf: - - $ref: '#/components/schemas/MaximumThroughputInMBps' - - description: 'The maximum throughput performance for an EBS-optimized instance type, in MB/s.' - maximumIops: - allOf: - - $ref: '#/components/schemas/MaximumIops' - - description: The maximum input/output storage operations per second for an EBS-optimized instance type. - description: Describes the optimized EBS performance for supported instance types. - EbsNvmeSupport: - type: string - enum: - - unsupported - - supported - - required - EbsInfo: - type: object - properties: - ebsOptimizedSupport: - allOf: - - $ref: '#/components/schemas/EbsOptimizedSupport' - - description: 'Indicates whether the instance type is Amazon EBS-optimized. For more information, see Amazon EBS-optimized instances in Amazon EC2 User Guide.' - encryptionSupport: - allOf: - - $ref: '#/components/schemas/EbsEncryptionSupport' - - description: Indicates whether Amazon EBS encryption is supported. - ebsOptimizedInfo: - allOf: - - $ref: '#/components/schemas/EbsOptimizedInfo' - - description: Describes the optimized EBS performance for the instance type. - nvmeSupport: - allOf: - - $ref: '#/components/schemas/EbsNvmeSupport' - - description: Indicates whether non-volatile memory express (NVMe) is supported. - description: Describes the Amazon EBS features supported by the instance type. - EbsInstanceBlockDevice: - type: object - properties: - attachTime: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The time stamp when the attachment initiated. - deleteOnTermination: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether the volume is deleted on instance termination. - status: - allOf: - - $ref: '#/components/schemas/AttachmentStatus' - - description: The attachment state. - volumeId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the EBS volume. - description: Describes a parameter used to set up an EBS volume in a block device mapping. - EbsInstanceBlockDeviceSpecification: - type: object - properties: - deleteOnTermination: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether the volume is deleted on instance termination. - volumeId: - allOf: - - $ref: '#/components/schemas/VolumeId' - - description: The ID of the EBS volume. - description: Describes information used to set up an EBS volume specified in a block device mapping. - MaximumBandwidthInMbps: - type: integer - MaximumThroughputInMBps: - type: number - format: double - MaximumIops: - type: integer - MaximumEfaInterfaces: - type: integer - EfaInfo: - type: object - properties: - maximumEfaInterfaces: - allOf: - - $ref: '#/components/schemas/MaximumEfaInterfaces' - - description: The maximum number of Elastic Fabric Adapters for the instance type. - description: Describes the Elastic Fabric Adapters for the instance type. - EfaSupportedFlag: - type: boolean - InternetGatewayAttachmentList: - type: array - items: - allOf: - - $ref: '#/components/schemas/InternetGatewayAttachment' - - xml: - name: item - EgressOnlyInternetGatewayIdList: - type: array - items: - allOf: - - $ref: '#/components/schemas/EgressOnlyInternetGatewayId' - - xml: - name: item - ElasticGpuAssociation: - type: object - properties: - elasticGpuId: - allOf: - - $ref: '#/components/schemas/ElasticGpuId' - - description: The ID of the Elastic Graphics accelerator. - elasticGpuAssociationId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the association. - elasticGpuAssociationState: - allOf: - - $ref: '#/components/schemas/String' - - description: The state of the association between the instance and the Elastic Graphics accelerator. - elasticGpuAssociationTime: - allOf: - - $ref: '#/components/schemas/String' - - description: The time the Elastic Graphics accelerator was associated with the instance. - description: Describes the association between an instance and an Elastic Graphics accelerator. - ElasticGpuAssociationList: - type: array - items: - allOf: - - $ref: '#/components/schemas/ElasticGpuAssociation' - - xml: - name: item - ElasticGpuStatus: - type: string - enum: - - OK - - IMPAIRED - ElasticGpuHealth: - type: object - properties: - status: - allOf: - - $ref: '#/components/schemas/ElasticGpuStatus' - - description: The health status. - description: Describes the status of an Elastic Graphics accelerator. - ElasticGpuIdSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/ElasticGpuId' - - xml: - name: item - ElasticGpus: - type: object - properties: - elasticGpuId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Elastic Graphics accelerator. - availabilityZone: - allOf: - - $ref: '#/components/schemas/String' - - description: The Availability Zone in the which the Elastic Graphics accelerator resides. - elasticGpuType: - allOf: - - $ref: '#/components/schemas/String' - - description: The type of Elastic Graphics accelerator. - elasticGpuHealth: - allOf: - - $ref: '#/components/schemas/ElasticGpuHealth' - - description: The status of the Elastic Graphics accelerator. - elasticGpuState: - allOf: - - $ref: '#/components/schemas/ElasticGpuState' - - description: The state of the Elastic Graphics accelerator. - instanceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the instance to which the Elastic Graphics accelerator is attached. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: The tags assigned to the Elastic Graphics accelerator. - description: Describes an Elastic Graphics accelerator. - ElasticGpuSpecificationResponse: - type: object - properties: - type: - allOf: - - $ref: '#/components/schemas/String' - - description: The elastic GPU type. - description: Describes an elastic GPU. - ElasticGpuSpecificationResponseList: - type: array - items: - allOf: - - $ref: '#/components/schemas/ElasticGpuSpecificationResponse' - - xml: - name: item - ElasticGpuSpecifications: - type: array - items: - allOf: - - $ref: '#/components/schemas/ElasticGpuSpecification' - - xml: - name: item - ElasticGpuState: - type: string - enum: - - ATTACHED - ElasticInferenceAcceleratorCount: - type: integer - minimum: 1 - ElasticInferenceAcceleratorAssociation: - type: object - properties: - elasticInferenceAcceleratorArn: - allOf: - - $ref: '#/components/schemas/String' - - description: ' The Amazon Resource Name (ARN) of the elastic inference accelerator. ' - elasticInferenceAcceleratorAssociationId: - allOf: - - $ref: '#/components/schemas/String' - - description: ' The ID of the association. ' - elasticInferenceAcceleratorAssociationState: - allOf: - - $ref: '#/components/schemas/String' - - description: ' The state of the elastic inference accelerator. ' - elasticInferenceAcceleratorAssociationTime: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: ' The time at which the elastic inference accelerator is associated with an instance. ' - description: ' Describes the association between an instance and an elastic inference accelerator. ' - ElasticInferenceAcceleratorAssociationList: - type: array - items: - allOf: - - $ref: '#/components/schemas/ElasticInferenceAcceleratorAssociation' - - xml: - name: item - ElasticInferenceAccelerators: - type: array - items: - allOf: - - $ref: '#/components/schemas/ElasticInferenceAccelerator' - - xml: - name: item - ElasticIpAssociationId: - type: string - EnaSupport: - type: string - enum: - - unsupported - - supported - - required - EnableEbsEncryptionByDefaultRequest: - type: object - title: EnableEbsEncryptionByDefaultRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - EnableFastLaunchRequest: - type: object - required: - - ImageId - title: EnableFastLaunchRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - EnableFastSnapshotRestoreStateErrorSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/EnableFastSnapshotRestoreStateErrorItem' - - xml: - name: item - EnableFastSnapshotRestoreErrorItem: - type: object - properties: - snapshotId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the snapshot. - fastSnapshotRestoreStateErrorSet: - allOf: - - $ref: '#/components/schemas/EnableFastSnapshotRestoreStateErrorSet' - - description: The errors. - description: Contains information about the errors that occurred when enabling fast snapshot restores. - EnableFastSnapshotRestoreErrorSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/EnableFastSnapshotRestoreErrorItem' - - xml: - name: item - EnableFastSnapshotRestoreStateError: - type: object - properties: - code: - allOf: - - $ref: '#/components/schemas/String' - - description: The error code. - message: - allOf: - - $ref: '#/components/schemas/String' - - description: The error message. - description: Describes an error that occurred when enabling fast snapshot restores. - EnableFastSnapshotRestoreStateErrorItem: - type: object - properties: - availabilityZone: - allOf: - - $ref: '#/components/schemas/String' - - description: The Availability Zone. - error: - allOf: - - $ref: '#/components/schemas/EnableFastSnapshotRestoreStateError' - - description: The error. - description: Contains information about an error that occurred when enabling fast snapshot restores. - EnableFastSnapshotRestoreSuccessItem: - type: object - properties: - snapshotId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the snapshot. - availabilityZone: - allOf: - - $ref: '#/components/schemas/String' - - description: The Availability Zone. - state: - allOf: - - $ref: '#/components/schemas/FastSnapshotRestoreStateCode' - - description: The state of fast snapshot restores. - stateTransitionReason: - allOf: - - $ref: '#/components/schemas/String' - - description: '

The reason for the state transition. The possible values are as follows:

  • Client.UserInitiated - The state successfully transitioned to enabling or disabling.

  • Client.UserInitiated - Lifecycle state transition - The state successfully transitioned to optimizing, enabled, or disabled.

' - ownerId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Amazon Web Services account that enabled fast snapshot restores on the snapshot. - ownerAlias: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Web Services owner alias that enabled fast snapshot restores on the snapshot. This is intended for future use. - enablingTime: - allOf: - - $ref: '#/components/schemas/MillisecondDateTime' - - description: The time at which fast snapshot restores entered the enabling state. - optimizingTime: - allOf: - - $ref: '#/components/schemas/MillisecondDateTime' - - description: The time at which fast snapshot restores entered the optimizing state. - enabledTime: - allOf: - - $ref: '#/components/schemas/MillisecondDateTime' - - description: The time at which fast snapshot restores entered the enabled state. - disablingTime: - allOf: - - $ref: '#/components/schemas/MillisecondDateTime' - - description: The time at which fast snapshot restores entered the disabling state. - disabledTime: - allOf: - - $ref: '#/components/schemas/MillisecondDateTime' - - description: The time at which fast snapshot restores entered the disabled state. - description: Describes fast snapshot restores that were successfully enabled. - EnableFastSnapshotRestoreSuccessSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/EnableFastSnapshotRestoreSuccessItem' - - xml: - name: item - EnableFastSnapshotRestoresRequest: - type: object - required: - - AvailabilityZones - - SourceSnapshotIds - title: EnableFastSnapshotRestoresRequest - properties: - AvailabilityZone: - allOf: - - $ref: '#/components/schemas/AvailabilityZoneStringList' - - description: 'One or more Availability Zones. For example, us-east-2a.' - SourceSnapshotId: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - EnableImageDeprecationRequest: - type: object - required: - - ImageId - - DeprecateAt - title: EnableImageDeprecationRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - EnableIpamOrganizationAdminAccountRequest: - type: object - required: - - DelegatedAdminAccountId - title: EnableIpamOrganizationAdminAccountRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The Organizations member account ID that you want to enable as the IPAM account. - EnableSerialConsoleAccessRequest: - type: object - title: EnableSerialConsoleAccessRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - EnableTransitGatewayRouteTablePropagationRequest: - type: object - required: - - TransitGatewayRouteTableId - - TransitGatewayAttachmentId - title: EnableTransitGatewayRouteTablePropagationRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - EnableVgwRoutePropagationRequest: - type: object - required: - - GatewayId - - RouteTableId - title: EnableVgwRoutePropagationRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - description: Contains the parameters for EnableVgwRoutePropagation. - EnableVolumeIORequest: - type: object - required: - - VolumeId - title: EnableVolumeIORequest - properties: - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - volumeId: - allOf: - - $ref: '#/components/schemas/VolumeId' - - description: The ID of the volume. - EnableVpcClassicLinkDnsSupportRequest: - type: object - title: EnableVpcClassicLinkDnsSupportRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/VpcId' - - description: The ID of the VPC. - EnableVpcClassicLinkRequest: - type: object - required: - - VpcId - title: EnableVpcClassicLinkRequest - properties: - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - vpcId: - allOf: - - $ref: '#/components/schemas/VpcId' - - description: The ID of the VPC. - EnclaveOptions: - type: object - properties: - enabled: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'If this parameter is set to true, the instance is enabled for Amazon Web Services Nitro Enclaves; otherwise, it is not enabled for Amazon Web Services Nitro Enclaves.' - description: Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. - EnclaveOptionsRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'To enable the instance for Amazon Web Services Nitro Enclaves, set this parameter to true.' - description: 'Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more information, see What is Amazon Web Services Nitro Enclaves? in the Amazon Web Services Nitro Enclaves User Guide.' - EncryptionInTransitSupported: - type: boolean - EphemeralNvmeSupport: - type: string - enum: - - unsupported - - supported - - required - ValidationError: - type: object - properties: - code: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The error code that indicates why the parameter or parameter combination is not valid. For more information about error codes, see Error Codes.' - message: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The error message that describes why the parameter or parameter combination is not valid. For more information about error messages, see Error Codes.' - description: The error code and error message that is returned for a parameter or parameter combination that is not valid when a new launch template or new version of a launch template is created. - ErrorSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/ValidationError' - - xml: - name: item - EventCode: - type: string - enum: - - instance-reboot - - system-reboot - - system-maintenance - - instance-retirement - - instance-stop - EventInformation: - type: object - properties: - eventDescription: - allOf: - - $ref: '#/components/schemas/String' - - description: The description of the event. - eventSubType: - allOf: - - $ref: '#/components/schemas/String' - - description: '

The event.

error events:

  • iamFleetRoleInvalid - The EC2 Fleet or Spot Fleet does not have the required permissions either to launch or terminate an instance.

  • allLaunchSpecsTemporarilyBlacklisted - None of the configurations are valid, and several attempts to launch instances have failed. For more information, see the description of the event.

  • spotInstanceCountLimitExceeded - You''ve reached the limit on the number of Spot Instances that you can launch.

  • spotFleetRequestConfigurationInvalid - The configuration is not valid. For more information, see the description of the event.

fleetRequestChange events:

  • active - The EC2 Fleet or Spot Fleet request has been validated and Amazon EC2 is attempting to maintain the target number of running instances.

  • cancelled - The EC2 Fleet or Spot Fleet request is canceled and has no running instances. The EC2 Fleet or Spot Fleet will be deleted two days after its instances are terminated.

  • cancelled_running - The EC2 Fleet or Spot Fleet request is canceled and does not launch additional instances. Its existing instances continue to run until they are interrupted or terminated. The request remains in this state until all instances are interrupted or terminated.

  • cancelled_terminating - The EC2 Fleet or Spot Fleet request is canceled and its instances are terminating. The request remains in this state until all instances are terminated.

  • expired - The EC2 Fleet or Spot Fleet request has expired. If the request was created with TerminateInstancesWithExpiration set, a subsequent terminated event indicates that the instances are terminated.

  • modify_in_progress - The EC2 Fleet or Spot Fleet request is being modified. The request remains in this state until the modification is fully processed.

  • modify_succeeded - The EC2 Fleet or Spot Fleet request was modified.

  • submitted - The EC2 Fleet or Spot Fleet request is being evaluated and Amazon EC2 is preparing to launch the target number of instances.

  • progress - The EC2 Fleet or Spot Fleet request is in the process of being fulfilled.

instanceChange events:

  • launched - A new instance was launched.

  • terminated - An instance was terminated by the user.

  • termination_notified - An instance termination notification was sent when a Spot Instance was terminated by Amazon EC2 during scale-down, when the target capacity of the fleet was modified down, for example, from a target capacity of 4 to a target capacity of 3.

Information events:

  • fleetProgressHalted - The price in every launch specification is not valid because it is below the Spot price (all the launch specifications have produced launchSpecUnusable events). A launch specification might become valid if the Spot price changes.

  • launchSpecTemporarilyBlacklisted - The configuration is not valid and several attempts to launch instances have failed. For more information, see the description of the event.

  • launchSpecUnusable - The price in a launch specification is not valid because it is below the Spot price.

  • registerWithLoadBalancersFailed - An attempt to register instances with load balancers failed. For more information, see the description of the event.

' - instanceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the instance. This information is available only for instanceChange events. - description: Describes an EC2 Fleet or Spot Fleet event. - ExcludedInstanceType: - type: string - pattern: '[a-zA-Z0-9\.\*]+' - minLength: 1 - maxLength: 30 - StringList: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - TransitGatewayRouteTableRoute: - type: object - properties: - destinationCidr: - allOf: - - $ref: '#/components/schemas/String' - - description: The CIDR block used for destination matches. - state: - allOf: - - $ref: '#/components/schemas/String' - - description: The state of the route. - routeOrigin: - allOf: - - $ref: '#/components/schemas/String' - - description: '

The route origin. The following are the possible values:

  • static

  • propagated

' - prefixListId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the prefix list. - attachmentId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the route attachment. - resourceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the resource for the route attachment. - resourceType: - allOf: - - $ref: '#/components/schemas/String' - - description: The resource type for the route attachment. - description: Describes a route in a transit gateway route table. - Explanation: - type: object - properties: - acl: - allOf: - - $ref: '#/components/schemas/AnalysisComponent' - - description: The network ACL. - aclRule: - allOf: - - $ref: '#/components/schemas/AnalysisAclRule' - - description: The network ACL rule. - address: - allOf: - - $ref: '#/components/schemas/IpAddress' - - description: 'The IPv4 address, in CIDR notation.' - addressSet: - allOf: - - $ref: '#/components/schemas/IpAddressList' - - description: 'The IPv4 addresses, in CIDR notation.' - attachedTo: - allOf: - - $ref: '#/components/schemas/AnalysisComponent' - - description: The resource to which the component is attached. - availabilityZoneSet: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The Availability Zones. - cidrSet: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The CIDR ranges. - component: - allOf: - - $ref: '#/components/schemas/AnalysisComponent' - - description: The component. - customerGateway: - allOf: - - $ref: '#/components/schemas/AnalysisComponent' - - description: The customer gateway. - destination: - allOf: - - $ref: '#/components/schemas/AnalysisComponent' - - description: The destination. - destinationVpc: - allOf: - - $ref: '#/components/schemas/AnalysisComponent' - - description: The destination VPC. - direction: - allOf: - - $ref: '#/components/schemas/String' - - description: '

The direction. The following are the possible values:

  • egress

  • ingress

' - explanationCode: - allOf: - - $ref: '#/components/schemas/String' - - description: The explanation code. - ingressRouteTable: - allOf: - - $ref: '#/components/schemas/AnalysisComponent' - - description: The route table. - internetGateway: - allOf: - - $ref: '#/components/schemas/AnalysisComponent' - - description: The internet gateway. - loadBalancerArn: - allOf: - - $ref: '#/components/schemas/ResourceArn' - - description: The Amazon Resource Name (ARN) of the load balancer. - classicLoadBalancerListener: - allOf: - - $ref: '#/components/schemas/AnalysisLoadBalancerListener' - - description: The listener for a Classic Load Balancer. - loadBalancerListenerPort: - allOf: - - $ref: '#/components/schemas/Port' - - description: The listener port of the load balancer. - loadBalancerTarget: - allOf: - - $ref: '#/components/schemas/AnalysisLoadBalancerTarget' - - description: The target. - loadBalancerTargetGroup: - allOf: - - $ref: '#/components/schemas/AnalysisComponent' - - description: The target group. - loadBalancerTargetGroupSet: - allOf: - - $ref: '#/components/schemas/AnalysisComponentList' - - description: The target groups. - loadBalancerTargetPort: - allOf: - - $ref: '#/components/schemas/Port' - - description: The target port. - elasticLoadBalancerListener: - allOf: - - $ref: '#/components/schemas/AnalysisComponent' - - description: The load balancer listener. - missingComponent: - allOf: - - $ref: '#/components/schemas/String' - - description: The missing component. - natGateway: - allOf: - - $ref: '#/components/schemas/AnalysisComponent' - - description: The NAT gateway. - networkInterface: - allOf: - - $ref: '#/components/schemas/AnalysisComponent' - - description: The network interface. - packetField: - allOf: - - $ref: '#/components/schemas/String' - - description: The packet field. - vpcPeeringConnection: - allOf: - - $ref: '#/components/schemas/AnalysisComponent' - - description: The VPC peering connection. - port: - allOf: - - $ref: '#/components/schemas/Port' - - description: The port. - portRangeSet: - allOf: - - $ref: '#/components/schemas/PortRangeList' - - description: The port ranges. - prefixList: - allOf: - - $ref: '#/components/schemas/AnalysisComponent' - - description: The prefix list. - protocolSet: - allOf: - - $ref: '#/components/schemas/StringList' - - description: The protocols. - routeTableRoute: - allOf: - - $ref: '#/components/schemas/AnalysisRouteTableRoute' - - description: The route table route. - routeTable: - allOf: - - $ref: '#/components/schemas/AnalysisComponent' - - description: The route table. - securityGroup: - allOf: - - $ref: '#/components/schemas/AnalysisComponent' - - description: The security group. - securityGroupRule: - allOf: - - $ref: '#/components/schemas/AnalysisSecurityGroupRule' - - description: The security group rule. - securityGroupSet: - allOf: - - $ref: '#/components/schemas/AnalysisComponentList' - - description: The security groups. - sourceVpc: - allOf: - - $ref: '#/components/schemas/AnalysisComponent' - - description: The source VPC. - state: - allOf: - - $ref: '#/components/schemas/String' - - description: The state. - subnet: - allOf: - - $ref: '#/components/schemas/AnalysisComponent' - - description: The subnet. - subnetRouteTable: - allOf: - - $ref: '#/components/schemas/AnalysisComponent' - - description: The route table for the subnet. - vpc: - allOf: - - $ref: '#/components/schemas/AnalysisComponent' - - description: The component VPC. - vpcEndpoint: - allOf: - - $ref: '#/components/schemas/AnalysisComponent' - - description: The VPC endpoint. - vpnConnection: - allOf: - - $ref: '#/components/schemas/AnalysisComponent' - - description: The VPN connection. - vpnGateway: - allOf: - - $ref: '#/components/schemas/AnalysisComponent' - - description: The VPN gateway. - transitGateway: - allOf: - - $ref: '#/components/schemas/AnalysisComponent' - - description: The transit gateway. - transitGatewayRouteTable: - allOf: - - $ref: '#/components/schemas/AnalysisComponent' - - description: The transit gateway route table. - transitGatewayRouteTableRoute: - allOf: - - $ref: '#/components/schemas/TransitGatewayRouteTableRoute' - - description: The transit gateway route table route. - transitGatewayAttachment: - allOf: - - $ref: '#/components/schemas/AnalysisComponent' - - description: The transit gateway attachment. - description: 'Describes an explanation code for an unreachable path. For more information, see Reachability Analyzer explanation codes.' - ExplanationList: - type: array - items: - allOf: - - $ref: '#/components/schemas/Explanation' - - xml: - name: item - ExportClientVpnClientCertificateRevocationListRequest: - type: object - required: - - ClientVpnEndpointId - title: ExportClientVpnClientCertificateRevocationListRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - ExportClientVpnClientConfigurationRequest: - type: object - required: - - ClientVpnEndpointId - title: ExportClientVpnClientConfigurationRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - ExportImageRequest: - type: object - required: - - DiskImageFormat - - ImageId - - S3ExportLocation - title: ExportImageRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The name of the role that grants VM Import/Export permission to export images to your Amazon S3 bucket. If this parameter is not specified, the default role is named ''vmimport''.' - TagSpecification: - allOf: - - $ref: '#/components/schemas/TagSpecificationList' - - description: The tags to apply to the export image task during creation. - ExportTaskS3Location: - type: object - properties: - s3Bucket: - allOf: - - $ref: '#/components/schemas/String' - - description: The destination Amazon S3 bucket. - s3Prefix: - allOf: - - $ref: '#/components/schemas/String' - - description: The prefix (logical hierarchy) in the bucket. - description: Describes the destination for an export image task. - ExportImageTask: - type: object - properties: - description: - allOf: - - $ref: '#/components/schemas/String' - - description: A description of the image being exported. - exportImageTaskId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the export image task. - imageId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the image. - progress: - allOf: - - $ref: '#/components/schemas/String' - - description: The percent complete of the export image task. - s3ExportLocation: - allOf: - - $ref: '#/components/schemas/ExportTaskS3Location' - - description: Information about the destination Amazon S3 bucket. - status: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The status of the export image task. The possible values are active, completed, deleting, and deleted.' - statusMessage: - allOf: - - $ref: '#/components/schemas/String' - - description: The status message for the export image task. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: Any tags assigned to the export image task. - description: Describes an export image task. - ExportImageTaskIdList: - type: array - items: - allOf: - - $ref: '#/components/schemas/ExportImageTaskId' - - xml: - name: ExportImageTaskId - ExportToS3Task: - type: object - properties: - containerFormat: - allOf: - - $ref: '#/components/schemas/ContainerFormat' - - description: 'The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.' - diskImageFormat: - allOf: - - $ref: '#/components/schemas/DiskImageFormat' - - description: The format for the exported image. - s3Bucket: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACP permissions to the Amazon Web Services account vm-import-export@amazon.com. - s3Key: - allOf: - - $ref: '#/components/schemas/String' - - description: The encryption key for your S3 bucket. - description: Describes the format and location for the export task. - InstanceExportDetails: - type: object - properties: - instanceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the resource being exported. - targetEnvironment: - allOf: - - $ref: '#/components/schemas/ExportEnvironment' - - description: The target virtualization environment. - description: Describes an instance to export. - ExportTaskState: - type: string - enum: - - active - - cancelling - - cancelled - - completed - ExportTaskS3LocationRequest: - type: object - required: - - S3Bucket - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The prefix (logical hierarchy) in the bucket. - description: Describes the destination for an export image task. - ExportTransitGatewayRoutesRequest: - type: object - required: - - TransitGatewayRouteTableId - - S3Bucket - title: ExportTransitGatewayRoutesRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/TransitGatewayRouteTableId' - - description: The ID of the route table. - Filter: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - FailedCapacityReservationFleetCancellationResult: - type: object - properties: - capacityReservationFleetId: - allOf: - - $ref: '#/components/schemas/CapacityReservationFleetId' - - description: The ID of the Capacity Reservation Fleet that could not be cancelled. - cancelCapacityReservationFleetError: - allOf: - - $ref: '#/components/schemas/CancelCapacityReservationFleetError' - - description: Information about the Capacity Reservation Fleet cancellation error. - description: Describes a Capacity Reservation Fleet that could not be cancelled. - FailedQueuedPurchaseDeletion: - type: object - properties: - error: - allOf: - - $ref: '#/components/schemas/DeleteQueuedReservedInstancesError' - - description: The error. - reservedInstancesId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Reserved Instance. - description: Describes a Reserved Instance whose queued purchase was not deleted. - FastLaunchLaunchTemplateSpecificationRequest: - type: object - required: - - Version - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The version of the launch template to use for faster launching for a Windows AMI. - description: '

Request to create a launch template for a fast-launch enabled Windows AMI.

Note - You can specify either the LaunchTemplateName or the LaunchTemplateId, but not both.

' - FastLaunchSnapshotConfigurationRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled Windows AMI. - description: Configuration settings for creating and managing pre-provisioned snapshots for a fast-launch enabled Windows AMI. - FindingsFound: - type: string - enum: - - 'true' - - 'false' - - unknown - FleetActivityStatus: - type: string - enum: - - error - - pending_fulfillment - - pending_termination - - fulfilled - IntegerWithConstraints: - type: integer - minimum: 0 - FleetCapacityReservation: - type: object - properties: - capacityReservationId: - allOf: - - $ref: '#/components/schemas/CapacityReservationId' - - description: The ID of the Capacity Reservation. - availabilityZoneId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Availability Zone in which the Capacity Reservation reserves capacity. - instanceType: - allOf: - - $ref: '#/components/schemas/InstanceType' - - description: The instance type for which the Capacity Reservation reserves capacity. - instancePlatform: - allOf: - - $ref: '#/components/schemas/CapacityReservationInstancePlatform' - - description: The type of operating system for which the Capacity Reservation reserves capacity. - availabilityZone: - allOf: - - $ref: '#/components/schemas/String' - - description: The Availability Zone in which the Capacity Reservation reserves capacity. - totalInstanceCount: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The total number of instances for which the Capacity Reservation reserves capacity. - fulfilledCapacity: - allOf: - - $ref: '#/components/schemas/Double' - - description: 'The number of capacity units fulfilled by the Capacity Reservation. For more information, see Total target capacity in the Amazon EC2 User Guide.' - ebsOptimized: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether the Capacity Reservation reserves capacity for EBS-optimized instance types. - createDate: - allOf: - - $ref: '#/components/schemas/MillisecondDateTime' - - description: The date and time at which the Capacity Reservation was created. - weight: - allOf: - - $ref: '#/components/schemas/DoubleWithConstraints' - - description: 'The weight of the instance type in the Capacity Reservation Fleet. For more information, see Instance type weight in the Amazon EC2 User Guide.' - priority: - allOf: - - $ref: '#/components/schemas/IntegerWithConstraints' - - description: 'The priority of the instance type in the Capacity Reservation Fleet. For more information, see Instance type priority in the Amazon EC2 User Guide.' - description: Information about a Capacity Reservation in a Capacity Reservation Fleet. - FleetExcessCapacityTerminationPolicy: - type: string - enum: - - no-termination - - termination - FleetLaunchTemplateConfigList: - type: array - items: - allOf: - - $ref: '#/components/schemas/FleetLaunchTemplateConfig' - - xml: - name: item - TargetCapacitySpecification: - type: object - properties: - totalTargetCapacity: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The number of units to request, filled using DefaultTargetCapacityType.' - onDemandTargetCapacity: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The number of On-Demand units to request. If you specify a target capacity for Spot units, you cannot specify a target capacity for On-Demand units.' - spotTargetCapacity: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The maximum number of Spot units to launch. If you specify a target capacity for On-Demand units, you cannot specify a target capacity for Spot units.' - defaultTargetCapacityType: - allOf: - - $ref: '#/components/schemas/DefaultTargetCapacityType' - - description: 'The default TotalTargetCapacity, which is either Spot or On-Demand.' - targetCapacityUnitType: - allOf: - - $ref: '#/components/schemas/TargetCapacityUnitType' - - description: '

The unit for the target capacity.

Default: units (translates to number of instances)

' - description: '

The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.

You can use the On-Demand Instance MaxTotalPrice parameter, the Spot Instance MaxTotalPrice, or both to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, EC2 Fleet will launch instances until it reaches the maximum amount that you''re willing to pay. When the maximum amount you''re willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity. The MaxTotalPrice parameters are located in OnDemandOptions and SpotOptions.

' - SpotOptions: - type: object - properties: - allocationStrategy: - allOf: - - $ref: '#/components/schemas/SpotAllocationStrategy' - - description: '

The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2 Fleet.

lowest-price - EC2 Fleet launches instances from the Spot Instance pools with the lowest price.

diversified - EC2 Fleet launches instances from all of the Spot Instance pools that you specify.

capacity-optimized (recommended) - EC2 Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching. To give certain instance types a higher chance of launching first, use capacity-optimized-prioritized. Set a priority for each instance type by using the Priority parameter for LaunchTemplateOverrides. You can assign the same priority to different LaunchTemplateOverrides. EC2 implements the priorities on a best-effort basis, but optimizes for capacity first. capacity-optimized-prioritized is supported only if your fleet uses a launch template. Note that if the On-Demand AllocationStrategy is set to prioritized, the same priority is applied when fulfilling On-Demand capacity.

Default: lowest-price

' - maintenanceStrategies: - allOf: - - $ref: '#/components/schemas/FleetSpotMaintenanceStrategies' - - description: The strategies for managing your workloads on your Spot Instances that will be interrupted. Currently only the capacity rebalance strategy is available. - instanceInterruptionBehavior: - allOf: - - $ref: '#/components/schemas/SpotInstanceInterruptionBehavior' - - description: '

The behavior when a Spot Instance is interrupted.

Default: terminate

' - instancePoolsToUseCount: - allOf: - - $ref: '#/components/schemas/Integer' - - description: '

The number of Spot pools across which to allocate your target Spot capacity. Supported only when AllocationStrategy is set to lowest-price. EC2 Fleet selects the cheapest Spot pools and evenly allocates your target Spot capacity across the number of Spot pools that you specify.

Note that EC2 Fleet attempts to draw Spot Instances from the number of pools that you specify on a best effort basis. If a pool runs out of Spot capacity before fulfilling your target capacity, EC2 Fleet will continue to fulfill your request by drawing from the next cheapest pool. To ensure that your target capacity is met, you might receive Spot Instances from more than the number of pools that you specified. Similarly, if most of the pools have no Spot capacity, you might receive your full target capacity from fewer than the number of pools that you specified.

' - singleInstanceType: - allOf: - - $ref: '#/components/schemas/Boolean' - - description:

Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet.

Supported only for fleets of type instant.

- singleAvailabilityZone: - allOf: - - $ref: '#/components/schemas/Boolean' - - description:

Indicates that the fleet launches all Spot Instances into a single Availability Zone.

Supported only for fleets of type instant.

- minTargetCapacity: - allOf: - - $ref: '#/components/schemas/Integer' - - description: '

The minimum target capacity for Spot Instances in the fleet. If the minimum target capacity is not reached, the fleet launches no instances.

Supported only for fleets of type instant.

At least one of the following must be specified: SingleAvailabilityZone | SingleInstanceType

' - maxTotalPrice: - allOf: - - $ref: '#/components/schemas/String' - - description: The maximum amount per hour for Spot Instances that you're willing to pay. - description: Describes the configuration of Spot Instances in an EC2 Fleet. - OnDemandOptions: - type: object - properties: - allocationStrategy: - allOf: - - $ref: '#/components/schemas/FleetOnDemandAllocationStrategy' - - description: '

The strategy that determines the order of the launch template overrides to use in fulfilling On-Demand capacity.

lowest-price - EC2 Fleet uses price to determine the order, launching the lowest price first.

prioritized - EC2 Fleet uses the priority that you assigned to each launch template override, launching the highest priority first.

Default: lowest-price

' - capacityReservationOptions: - allOf: - - $ref: '#/components/schemas/CapacityReservationOptions' - - description:

The strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.

Supported only for fleets of type instant.

- singleInstanceType: - allOf: - - $ref: '#/components/schemas/Boolean' - - description:

Indicates that the fleet uses a single instance type to launch all On-Demand Instances in the fleet.

Supported only for fleets of type instant.

- singleAvailabilityZone: - allOf: - - $ref: '#/components/schemas/Boolean' - - description:

Indicates that the fleet launches all On-Demand Instances into a single Availability Zone.

Supported only for fleets of type instant.

- minTargetCapacity: - allOf: - - $ref: '#/components/schemas/Integer' - - description: '

The minimum target capacity for On-Demand Instances in the fleet. If the minimum target capacity is not reached, the fleet launches no instances.

Supported only for fleets of type instant.

At least one of the following must be specified: SingleAvailabilityZone | SingleInstanceType

' - maxTotalPrice: - allOf: - - $ref: '#/components/schemas/String' - - description: The maximum amount per hour for On-Demand Instances that you're willing to pay. - description: Describes the configuration of On-Demand Instances in an EC2 Fleet. - FleetData: - type: object - properties: - activityStatus: - allOf: - - $ref: '#/components/schemas/FleetActivityStatus' - - description: 'The progress of the EC2 Fleet. If there is an error, the status is error. After all requests are placed, the status is pending_fulfillment. If the size of the EC2 Fleet is equal to or greater than its target capacity, the status is fulfilled. If the size of the EC2 Fleet is decreased, the status is pending_termination while instances are terminating.' - createTime: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The creation date and time of the EC2 Fleet. - fleetId: - allOf: - - $ref: '#/components/schemas/FleetId' - - description: The ID of the EC2 Fleet. - fleetState: - allOf: - - $ref: '#/components/schemas/FleetStateCode' - - description: The state of the EC2 Fleet. - clientToken: - allOf: - - $ref: '#/components/schemas/String' - - description: '

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.

Constraints: Maximum 64 ASCII characters

' - excessCapacityTerminationPolicy: - allOf: - - $ref: '#/components/schemas/FleetExcessCapacityTerminationPolicy' - - description: Indicates whether running instances should be terminated if the target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet. - fulfilledCapacity: - allOf: - - $ref: '#/components/schemas/Double' - - description: The number of units fulfilled by this request compared to the set target capacity. - fulfilledOnDemandCapacity: - allOf: - - $ref: '#/components/schemas/Double' - - description: The number of units fulfilled by this request compared to the set target On-Demand capacity. - launchTemplateConfigs: - allOf: - - $ref: '#/components/schemas/FleetLaunchTemplateConfigList' - - description: The launch template and overrides. - targetCapacitySpecification: - allOf: - - $ref: '#/components/schemas/TargetCapacitySpecification' - - description: 'The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.' - terminateInstancesWithExpiration: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Indicates whether running instances should be terminated when the EC2 Fleet expires. ' - type: - allOf: - - $ref: '#/components/schemas/FleetType' - - description: 'The type of request. Indicates whether the EC2 Fleet only requests the target capacity, or also attempts to maintain it. If you request a certain target capacity, EC2 Fleet only places the required requests; it does not attempt to replenish instances if capacity is diminished, and it does not submit requests in alternative capacity pools if capacity is unavailable. To maintain a certain target capacity, EC2 Fleet places the required requests to meet this target capacity. It also automatically replenishes any interrupted Spot Instances. Default: maintain.' - validFrom: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: 'The start date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The default is to start fulfilling the request immediately. ' - validUntil: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: 'The end date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). At this point, no new instance requests are placed or able to fulfill the request. The default end date is 7 days from the current date. ' - replaceUnhealthyInstances: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Indicates whether EC2 Fleet should replace unhealthy Spot Instances. Supported only for fleets of type maintain. For more information, see EC2 Fleet health checks in the Amazon EC2 User Guide.' - spotOptions: - allOf: - - $ref: '#/components/schemas/SpotOptions' - - description: The configuration of Spot Instances in an EC2 Fleet. - onDemandOptions: - allOf: - - $ref: '#/components/schemas/OnDemandOptions' - - description: The allocation strategy of On-Demand Instances in an EC2 Fleet. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: The tags for an EC2 Fleet resource. - errorSet: - allOf: - - $ref: '#/components/schemas/DescribeFleetsErrorSet' - - description: Information about the instances that could not be launched by the fleet. Valid only when Type is set to instant. - fleetInstanceSet: - allOf: - - $ref: '#/components/schemas/DescribeFleetsInstancesSet' - - description: Information about the instances that were launched by the fleet. Valid only when Type is set to instant. - context: - allOf: - - $ref: '#/components/schemas/String' - - description: Reserved. - description: Describes an EC2 Fleet. - FleetEventType: - type: string - enum: - - instance-change - - fleet-change - - service-error - FleetLaunchTemplateSpecification: - type: object - properties: - launchTemplateId: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The ID of the launch template. If you specify the template ID, you can''t specify the template name.' - launchTemplateName: - allOf: - - $ref: '#/components/schemas/LaunchTemplateName' - - description: 'The name of the launch template. If you specify the template name, you can''t specify the template ID.' - version: - allOf: - - $ref: '#/components/schemas/String' - - description: '

The launch template version number, $Latest, or $Default. You must specify a value, otherwise the request fails.

If the value is $Latest, Amazon EC2 uses the latest version of the launch template.

If the value is $Default, Amazon EC2 uses the default version of the launch template.

' - description: 'Describes the Amazon EC2 launch template and the launch template version that can be used by a Spot Fleet request to configure Amazon EC2 instances. For information about launch templates, see Launching an instance from a launch template in the Amazon EC2 User Guide for Linux Instances.' - FleetLaunchTemplateOverridesList: - type: array - items: - allOf: - - $ref: '#/components/schemas/FleetLaunchTemplateOverrides' - - xml: - name: item - FleetLaunchTemplateConfig: - type: object - properties: - launchTemplateSpecification: - allOf: - - $ref: '#/components/schemas/FleetLaunchTemplateSpecification' - - description: The launch template. - overrides: - allOf: - - $ref: '#/components/schemas/FleetLaunchTemplateOverridesList' - - description: Any parameters that you specify override the same parameters in the launch template. - description: Describes a launch template and overrides. - FleetLaunchTemplateConfigListRequest: - type: array - items: - allOf: - - $ref: '#/components/schemas/FleetLaunchTemplateConfigRequest' - - xml: - name: item - minItems: 0 - maxItems: 50 - FleetLaunchTemplateOverridesListRequest: - type: array - items: - allOf: - - $ref: '#/components/schemas/FleetLaunchTemplateOverridesRequest' - - xml: - name: item - PlacementResponse: - type: object - properties: - groupName: - allOf: - - $ref: '#/components/schemas/PlacementGroupName' - - description: The name of the placement group that the instance is in. - description: Describes the placement of an instance. - InstanceRequirements: - type: object - properties: - vCpuCount: - allOf: - - $ref: '#/components/schemas/VCpuCountRange' - - description: The minimum and maximum number of vCPUs. - memoryMiB: - allOf: - - $ref: '#/components/schemas/MemoryMiB' - - description: 'The minimum and maximum amount of memory, in MiB.' - cpuManufacturerSet: - allOf: - - $ref: '#/components/schemas/CpuManufacturerSet' - - description: '

The CPU manufacturers to include.

  • For instance types with Intel CPUs, specify intel.

  • For instance types with AMD CPUs, specify amd.

  • For instance types with Amazon Web Services CPUs, specify amazon-web-services.

Don''t confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template.

Default: Any manufacturer

' - memoryGiBPerVCpu: - allOf: - - $ref: '#/components/schemas/MemoryGiBPerVCpu' - - description: '

The minimum and maximum amount of memory per vCPU, in GiB.

Default: No minimum or maximum limits

' - excludedInstanceTypeSet: - allOf: - - $ref: '#/components/schemas/ExcludedInstanceTypeSet' - - description: '

The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk (*), to exclude an instance type, size, or generation. The following are examples: m5.8xlarge, c5*.*, m5a.*, r*, *3*.

For example, if you specify c5*,Amazon EC2 will exclude the entire C5 instance family, which includes all C5a and C5n instance types. If you specify m5a.*, Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types.

Default: No excluded instance types

' - instanceGenerationSet: - allOf: - - $ref: '#/components/schemas/InstanceGenerationSet' - - description: '

Indicates whether current or previous generation instance types are included. The current generation instance types are recommended for use. Current generation instance types are typically the latest two to three generations in each instance family. For more information, see Instance types in the Amazon EC2 User Guide.

For current generation instance types, specify current.

For previous generation instance types, specify previous.

Default: Current and previous generation instance types

' - spotMaxPricePercentageOverLowestPrice: - allOf: - - $ref: '#/components/schemas/Integer' - - description: '

The price protection threshold for Spot Instances. This is the maximum you’ll pay for a Spot Instance, expressed as a percentage above the cheapest M, C, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance types priced above your threshold.

The parameter accepts an integer, which Amazon EC2 interprets as a percentage.

To turn off price protection, specify a high value, such as 999999.

This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.

If you set TargetCapacityUnitType to vcpu or memory-mib, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.

Default: 100

' - onDemandMaxPricePercentageOverLowestPrice: - allOf: - - $ref: '#/components/schemas/Integer' - - description: '

The price protection threshold for On-Demand Instances. This is the maximum you’ll pay for an On-Demand Instance, expressed as a percentage above the cheapest M, C, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance types priced above your threshold.

The parameter accepts an integer, which Amazon EC2 interprets as a percentage.

To turn off price protection, specify a high value, such as 999999.

This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.

If you set TargetCapacityUnitType to vcpu or memory-mib, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.

Default: 20

' - bareMetal: - allOf: - - $ref: '#/components/schemas/BareMetal' - - description: '

Indicates whether bare metal instance types must be included, excluded, or required.

  • To include bare metal instance types, specify included.

  • To require only bare metal instance types, specify required.

  • To exclude bare metal instance types, specify excluded.

Default: excluded

' - burstablePerformance: - allOf: - - $ref: '#/components/schemas/BurstablePerformance' - - description: '

Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see Burstable performance instances.

  • To include burstable performance instance types, specify included.

  • To require only burstable performance instance types, specify required.

  • To exclude burstable performance instance types, specify excluded.

Default: excluded

' - requireHibernateSupport: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: '

Indicates whether instance types must support hibernation for On-Demand Instances.

This parameter is not supported for GetSpotPlacementScores.

Default: false

' - networkInterfaceCount: - allOf: - - $ref: '#/components/schemas/NetworkInterfaceCount' - - description: '

The minimum and maximum number of network interfaces.

Default: No minimum or maximum limits

' - localStorage: - allOf: - - $ref: '#/components/schemas/LocalStorage' - - description: '

Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, Amazon EC2 instance store in the Amazon EC2 User Guide.

  • To include instance types with instance store volumes, specify included.

  • To require only instance types with instance store volumes, specify required.

  • To exclude instance types with instance store volumes, specify excluded.

Default: included

' - localStorageTypeSet: - allOf: - - $ref: '#/components/schemas/LocalStorageTypeSet' - - description: '

The type of local storage that is required.

  • For instance types with hard disk drive (HDD) storage, specify hdd.

  • For instance types with solid state drive (SDD) storage, specify sdd.

Default: hdd and sdd

' - totalLocalStorageGB: - allOf: - - $ref: '#/components/schemas/TotalLocalStorageGB' - - description: '

The minimum and maximum amount of total local storage, in GB.

Default: No minimum or maximum limits

' - baselineEbsBandwidthMbps: - allOf: - - $ref: '#/components/schemas/BaselineEbsBandwidthMbps' - - description: '

The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see Amazon EBS–optimized instances in the Amazon EC2 User Guide.

Default: No minimum or maximum limits

' - acceleratorTypeSet: - allOf: - - $ref: '#/components/schemas/AcceleratorTypeSet' - - description: '

The accelerator types that must be on the instance type.

  • For instance types with GPU accelerators, specify gpu.

  • For instance types with FPGA accelerators, specify fpga.

  • For instance types with inference accelerators, specify inference.

Default: Any accelerator type

' - acceleratorCount: - allOf: - - $ref: '#/components/schemas/AcceleratorCount' - - description: '

The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on an instance.

To exclude accelerator-enabled instance types, set Max to 0.

Default: No minimum or maximum limits

' - acceleratorManufacturerSet: - allOf: - - $ref: '#/components/schemas/AcceleratorManufacturerSet' - - description: '

Indicates whether instance types must have accelerators by specific manufacturers.

  • For instance types with NVIDIA devices, specify nvidia.

  • For instance types with AMD devices, specify amd.

  • For instance types with Amazon Web Services devices, specify amazon-web-services.

  • For instance types with Xilinx devices, specify xilinx.

Default: Any manufacturer

' - acceleratorNameSet: - allOf: - - $ref: '#/components/schemas/AcceleratorNameSet' - - description: '

The accelerators that must be on the instance type.

  • For instance types with NVIDIA A100 GPUs, specify a100.

  • For instance types with NVIDIA V100 GPUs, specify v100.

  • For instance types with NVIDIA K80 GPUs, specify k80.

  • For instance types with NVIDIA T4 GPUs, specify t4.

  • For instance types with NVIDIA M60 GPUs, specify m60.

  • For instance types with AMD Radeon Pro V520 GPUs, specify radeon-pro-v520.

  • For instance types with Xilinx VU9P FPGAs, specify vu9p.

Default: Any accelerator

' - acceleratorTotalMemoryMiB: - allOf: - - $ref: '#/components/schemas/AcceleratorTotalMemoryMiB' - - description: '

The minimum and maximum amount of total accelerator memory, in MiB.

Default: No minimum or maximum limits

' - description: '

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.

When you specify multiple parameters, you get instance types that satisfy all of the specified parameters. If you specify multiple values for a parameter, you get instance types that satisfy any of the specified values.

You must specify VCpuCount and MemoryMiB. All other parameters are optional. Any unspecified optional parameter is set to its default.

For more information, see Attribute-based instance type selection for EC2 Fleet, Attribute-based instance type selection for Spot Fleet, and Spot placement score in the Amazon EC2 User Guide.

' - FleetLaunchTemplateOverrides: - type: object - properties: - instanceType: - allOf: - - $ref: '#/components/schemas/InstanceType' - - description: '

The instance type.

If you specify InstanceTypes, you can''t specify InstanceRequirements.

' - maxPrice: - allOf: - - $ref: '#/components/schemas/String' - - description: The maximum price per unit hour that you are willing to pay for a Spot Instance. - subnetId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the subnet in which to launch the instances. - availabilityZone: - allOf: - - $ref: '#/components/schemas/String' - - description: The Availability Zone in which to launch the instances. - weightedCapacity: - allOf: - - $ref: '#/components/schemas/Double' - - description: The number of units provided by the specified instance type. - priority: - allOf: - - $ref: '#/components/schemas/Double' - - description: '

The priority for the launch template override. The highest priority is launched first.

If the On-Demand AllocationStrategy is set to prioritized, EC2 Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity.

If the Spot AllocationStrategy is set to capacity-optimized-prioritized, EC2 Fleet uses priority on a best-effort basis to determine which launch template override to use in fulfilling Spot capacity, but optimizes for capacity first.

Valid values are whole numbers starting at 0. The lower the number, the higher the priority. If no number is set, the override has the lowest priority. You can set the same priority for different launch template overrides.

' - placement: - allOf: - - $ref: '#/components/schemas/PlacementResponse' - - description: 'The location where the instance launched, if applicable.' - instanceRequirements: - allOf: - - $ref: '#/components/schemas/InstanceRequirements' - - description: '

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.

If you specify InstanceRequirements, you can''t specify InstanceTypes.

' - description: Describes overrides for a launch template. - FleetLaunchTemplateOverridesRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/InstanceRequirementsRequest' - - description: '

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.

If you specify InstanceRequirements, you can''t specify InstanceTypes.

' - description: Describes overrides for a launch template. - FleetLaunchTemplateSpecificationRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: '

The launch template version number, $Latest, or $Default. You must specify a value, otherwise the request fails.

If the value is $Latest, Amazon EC2 uses the latest version of the launch template.

If the value is $Default, Amazon EC2 uses the default version of the launch template.

' - description: 'Describes the Amazon EC2 launch template and the launch template version that can be used by an EC2 Fleet to configure Amazon EC2 instances. For information about launch templates, see Launching an instance from a launch template in the Amazon EC2 User Guide.' - FleetOnDemandAllocationStrategy: - type: string - enum: - - lowest-price - - prioritized - FleetReplacementStrategy: - type: string - enum: - - launch - - launch-before-terminate - FleetSpotCapacityRebalance: - type: object - properties: - replacementStrategy: - allOf: - - $ref: '#/components/schemas/FleetReplacementStrategy' - - description: '

The replacement strategy to use. Only available for fleets of type maintain.

launch - EC2 Fleet launches a new replacement Spot Instance when a rebalance notification is emitted for an existing Spot Instance in the fleet. EC2 Fleet does not terminate the instances that receive a rebalance notification. You can terminate the old instances, or you can leave them running. You are charged for all instances while they are running.

launch-before-terminate - EC2 Fleet launches a new replacement Spot Instance when a rebalance notification is emitted for an existing Spot Instance in the fleet, and then, after a delay that you specify (in TerminationDelay), terminates the instances that received a rebalance notification.

' - terminationDelay: - allOf: - - $ref: '#/components/schemas/Integer' - - description: '

The amount of time (in seconds) that Amazon EC2 waits before terminating the old Spot Instance after launching a new replacement Spot Instance.

Required when ReplacementStrategy is set to launch-before-terminate.

Not valid when ReplacementStrategy is set to launch.

Valid values: Minimum value of 120 seconds. Maximum value of 7200 seconds.

' - description: The strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an elevated risk of being interrupted. - FleetSpotCapacityRebalanceRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Integer' - - description: '

The amount of time (in seconds) that Amazon EC2 waits before terminating the old Spot Instance after launching a new replacement Spot Instance.

Required when ReplacementStrategy is set to launch-before-terminate.

Not valid when ReplacementStrategy is set to launch.

Valid values: Minimum value of 120 seconds. Maximum value of 7200 seconds.

' - description: 'The Spot Instance replacement strategy to use when Amazon EC2 emits a rebalance notification signal that your Spot Instance is at an elevated risk of being interrupted. For more information, see Capacity rebalancing in the Amazon EC2 User Guide.' - FleetSpotMaintenanceStrategies: - type: object - properties: - capacityRebalance: - allOf: - - $ref: '#/components/schemas/FleetSpotCapacityRebalance' - - description: The strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an elevated risk of being interrupted. - description: The strategies for managing your Spot Instances that are at an elevated risk of being interrupted. - FleetSpotMaintenanceStrategiesRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/FleetSpotCapacityRebalanceRequest' - - description: The strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an elevated risk of being interrupted. - description: The strategies for managing your Spot Instances that are at an elevated risk of being interrupted. - Float: - type: number - format: float - TrafficType: - type: string - enum: - - ACCEPT - - REJECT - - ALL - LogDestinationType: - type: string - enum: - - cloud-watch-logs - - s3 - FlowLog: - type: object - properties: - creationTime: - allOf: - - $ref: '#/components/schemas/MillisecondDateTime' - - description: The date and time the flow log was created. - deliverLogsErrorMessage: - allOf: - - $ref: '#/components/schemas/String' - - description: 'Information about the error that occurred. Rate limited indicates that CloudWatch Logs throttling has been applied for one or more network interfaces, or that you''ve reached the limit on the number of log groups that you can create. Access error indicates that the IAM role associated with the flow log does not have sufficient permissions to publish to CloudWatch Logs. Unknown error indicates an internal error.' - deliverLogsPermissionArn: - allOf: - - $ref: '#/components/schemas/String' - - description: The ARN of the IAM role that posts logs to CloudWatch Logs. - deliverLogsStatus: - allOf: - - $ref: '#/components/schemas/String' - - description: The status of the logs delivery (SUCCESS | FAILED). - flowLogId: - allOf: - - $ref: '#/components/schemas/String' - - description: The flow log ID. - flowLogStatus: - allOf: - - $ref: '#/components/schemas/String' - - description: The status of the flow log (ACTIVE). - logGroupName: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of the flow log group. - resourceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the resource on which the flow log was created. - trafficType: - allOf: - - $ref: '#/components/schemas/TrafficType' - - description: The type of traffic captured for the flow log. - logDestinationType: - allOf: - - $ref: '#/components/schemas/LogDestinationType' - - description: The type of destination to which the flow log data is published. Flow log data can be published to CloudWatch Logs or Amazon S3. - logDestination: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The destination to which the flow log data is published. Flow log data can be published to an CloudWatch Logs log group or an Amazon S3 bucket. If the flow log publishes to CloudWatch Logs, this element indicates the Amazon Resource Name (ARN) of the CloudWatch Logs log group to which the data is published. If the flow log publishes to Amazon S3, this element indicates the ARN of the Amazon S3 bucket to which the data is published.' - logFormat: - allOf: - - $ref: '#/components/schemas/String' - - description: The format of the flow log record. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: The tags for the flow log. - maxAggregationInterval: - allOf: - - $ref: '#/components/schemas/Integer' - - description: '

The maximum interval of time, in seconds, during which a flow of packets is captured and aggregated into a flow log record.

When a network interface is attached to a Nitro-based instance, the aggregation interval is always 60 seconds (1 minute) or less, regardless of the specified value.

Valid Values: 60 | 600

' - destinationOptions: - allOf: - - $ref: '#/components/schemas/DestinationOptionsResponse' - - description: The destination options. - description: Describes a flow log. - FlowLogResourceIds: - type: array - items: - allOf: - - $ref: '#/components/schemas/FlowLogResourceId' - - xml: - name: item - FlowLogsResourceType: - type: string - enum: - - VPC - - Subnet - - NetworkInterface - FpgaDeviceCount: - type: integer - FpgaDeviceName: - type: string - FpgaDeviceManufacturerName: - type: string - FpgaDeviceMemoryInfo: - type: object - properties: - sizeInMiB: - allOf: - - $ref: '#/components/schemas/FpgaDeviceMemorySize' - - description: 'The size of the memory available to the FPGA accelerator, in MiB.' - description: Describes the memory for the FPGA accelerator for the instance type. - FpgaDeviceInfo: - type: object - properties: - name: - allOf: - - $ref: '#/components/schemas/FpgaDeviceName' - - description: The name of the FPGA accelerator. - manufacturer: - allOf: - - $ref: '#/components/schemas/FpgaDeviceManufacturerName' - - description: The manufacturer of the FPGA accelerator. - count: - allOf: - - $ref: '#/components/schemas/FpgaDeviceCount' - - description: The count of FPGA accelerators for the instance type. - memoryInfo: - allOf: - - $ref: '#/components/schemas/FpgaDeviceMemoryInfo' - - description: Describes the memory for the FPGA accelerator for the instance type. - description: Describes the FPGA accelerator for the instance type. - FpgaDeviceInfoList: - type: array - items: - allOf: - - $ref: '#/components/schemas/FpgaDeviceInfo' - - xml: - name: item - FpgaDeviceMemorySize: - type: integer - PciId: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the vendor for the subsystem. - description: Describes the data that identifies an Amazon FPGA image (AFI) on the PCI bus. - FpgaImageState: - type: object - properties: - code: - allOf: - - $ref: '#/components/schemas/FpgaImageStateCode' - - description: '

The state. The following are the possible values:

  • pending - AFI bitstream generation is in progress.

  • available - The AFI is available for use.

  • failed - AFI bitstream generation failed.

  • unavailable - The AFI is no longer available for use.

' - message: - allOf: - - $ref: '#/components/schemas/String' - - description: 'If the state is failed, this is the error message.' - description: Describes the state of the bitstream generation process for an Amazon FPGA image (AFI). - FpgaImage: - type: object - properties: - fpgaImageId: - allOf: - - $ref: '#/components/schemas/String' - - description: The FPGA image identifier (AFI ID). - fpgaImageGlobalId: - allOf: - - $ref: '#/components/schemas/String' - - description: The global FPGA image identifier (AGFI ID). - name: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of the AFI. - description: - allOf: - - $ref: '#/components/schemas/String' - - description: The description of the AFI. - shellVersion: - allOf: - - $ref: '#/components/schemas/String' - - description: The version of the Amazon Web Services Shell that was used to create the bitstream. - pciId: - allOf: - - $ref: '#/components/schemas/PciId' - - description: Information about the PCI bus. - state: - allOf: - - $ref: '#/components/schemas/FpgaImageState' - - description: Information about the state of the AFI. - createTime: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The date and time the AFI was created. - updateTime: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The time of the most recent update to the AFI. - ownerId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Amazon Web Services account that owns the AFI. - ownerAlias: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The alias of the AFI owner. Possible values include self, amazon, and aws-marketplace.' - productCodes: - allOf: - - $ref: '#/components/schemas/ProductCodeList' - - description: The product codes for the AFI. - tags: - allOf: - - $ref: '#/components/schemas/TagList' - - description: Any tags assigned to the AFI. - public: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether the AFI is public. - dataRetentionSupport: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether data retention support is enabled for the AFI. - description: Describes an Amazon FPGA image (AFI). - LoadPermissionList: - type: array - items: - allOf: - - $ref: '#/components/schemas/LoadPermission' - - xml: - name: item - FpgaImageStateCode: - type: string - enum: - - pending - - failed - - available - - unavailable - totalFpgaMemory: - type: integer - FpgaInfo: - type: object - properties: - fpgas: - allOf: - - $ref: '#/components/schemas/FpgaDeviceInfoList' - - description: Describes the FPGAs for the instance type. - totalFpgaMemoryInMiB: - allOf: - - $ref: '#/components/schemas/totalFpgaMemory' - - description: The total memory of all FPGA accelerators for the instance type. - description: Describes the FPGAs for the instance type. - FreeTierEligibleFlag: - type: boolean - GVCDMaxResults: - type: integer - minimum: 200 - maximum: 1000 - GatewayAssociationState: - type: string - enum: - - associated - - not-associated - - associating - - disassociating - GetAssociatedEnclaveCertificateIamRolesRequest: - type: object - title: GetAssociatedEnclaveCertificateIamRolesRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - GetAssociatedIpv6PoolCidrsRequest: - type: object - required: - - PoolId - title: GetAssociatedIpv6PoolCidrsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - Ipv6CidrAssociationSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/Ipv6CidrAssociation' - - xml: - name: item - GetCapacityReservationUsageRequest: - type: object - required: - - CapacityReservationId - title: GetCapacityReservationUsageRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - GetCapacityReservationUsageRequestMaxResults: - type: integer - minimum: 1 - maximum: 1000 - InstanceUsageSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/InstanceUsage' - - xml: - name: item - GetCoipPoolUsageRequest: - type: object - required: - - PoolId - title: GetCoipPoolUsageRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Ipv4PoolCoipId' - - description: The ID of the address pool. - Filter: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - GetConsoleOutputRequest: - type: object - required: - - InstanceId - title: GetConsoleOutputRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/InstanceId' - - description: The ID of the instance. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: '

When enabled, retrieves the latest console output for the instance.

Default: disabled (false)

' - GetConsoleScreenshotRequest: - type: object - required: - - InstanceId - title: GetConsoleScreenshotRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'When set to true, acts as keystroke input and wakes up an instance that''s in standby or "sleep" mode.' - UnlimitedSupportedInstanceFamily: - type: string - enum: - - t2 - - t3 - - t3a - - t4g - GetDefaultCreditSpecificationRequest: - type: object - required: - - InstanceFamily - title: GetDefaultCreditSpecificationRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/UnlimitedSupportedInstanceFamily' - - description: The instance family. - InstanceFamilyCreditSpecification: - type: object - properties: - instanceFamily: - allOf: - - $ref: '#/components/schemas/UnlimitedSupportedInstanceFamily' - - description: The instance family. - cpuCredits: - allOf: - - $ref: '#/components/schemas/String' - - description: The default credit option for CPU usage of the instance family. Valid values are standard and unlimited. - description: Describes the default credit option for CPU usage of a burstable performance instance family. - GetEbsDefaultKmsKeyIdRequest: - type: object - title: GetEbsDefaultKmsKeyIdRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - GetEbsEncryptionByDefaultRequest: - type: object - title: GetEbsEncryptionByDefaultRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - IntegrateServices: - type: object - properties: - AthenaIntegration: - allOf: - - $ref: '#/components/schemas/AthenaIntegrationsSet' - - description: Information about the integration with Amazon Athena. - description: Describes service integrations with VPC Flow logs. - GetFlowLogsIntegrationTemplateRequest: - type: object - required: - - FlowLogId - - ConfigDeliveryS3DestinationArn - - IntegrateServices - title: GetFlowLogsIntegrationTemplateRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: 'To store the CloudFormation template in Amazon S3, specify the location in Amazon S3.' - IntegrateService: - allOf: - - $ref: '#/components/schemas/IntegrateServices' - - description: Information about the service integration. - GetGroupsForCapacityReservationRequest: - type: object - required: - - CapacityReservationId - title: GetGroupsForCapacityReservationRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - GetGroupsForCapacityReservationRequestMaxResults: - type: integer - minimum: 1 - maximum: 1000 - GetHostReservationPurchasePreviewRequest: - type: object - required: - - HostIdSet - - OfferingId - title: GetHostReservationPurchasePreviewRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/OfferingId' - - description: The offering ID of the reservation. - PurchaseSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/Purchase' - - xml: - name: item - GetInstanceTypesFromInstanceRequirementsRequest: - type: object - required: - - ArchitectureTypes - - VirtualizationTypes - - InstanceRequirements - title: GetInstanceTypesFromInstanceRequirementsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - ArchitectureType: - allOf: - - $ref: '#/components/schemas/ArchitectureTypeSet' - - description: The processor architecture type. - VirtualizationType: - allOf: - - $ref: '#/components/schemas/String' - - description: The token for the next set of results. - InstanceTypeInfoFromInstanceRequirementsSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/InstanceTypeInfoFromInstanceRequirements' - - xml: - name: item - GetInstanceUefiDataRequest: - type: object - required: - - InstanceId - title: GetInstanceUefiDataRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - GetIpamAddressHistoryRequest: - type: object - required: - - Cidr - - IpamScopeId - title: GetIpamAddressHistoryRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: The token for the next page of results. - IpamAddressHistoryRecordSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/IpamAddressHistoryRecord' - - xml: - name: item - GetIpamPoolAllocationsMaxResults: - type: integer - minimum: 1000 - maximum: 100000 - IpamPoolAllocationId: - type: string - GetIpamPoolAllocationsRequest: - type: object - required: - - IpamPoolId - title: GetIpamPoolAllocationsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/IpamPoolAllocationId' - - description: The ID of the allocation. - Filter: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: The token for the next page of results. - IpamPoolAllocationSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/IpamPoolAllocation' - - xml: - name: item - GetIpamPoolCidrsRequest: - type: object - required: - - IpamPoolId - title: GetIpamPoolCidrsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/IpamPoolId' - - description: The ID of the IPAM pool you want the CIDR for. - Filter: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: The token for the next page of results. - IpamPoolCidrSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/IpamPoolCidr' - - xml: - name: item - GetIpamResourceCidrsRequest: - type: object - required: - - IpamScopeId - title: GetIpamResourceCidrsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - Filter: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Amazon Web Services account that owns the resource. - IpamResourceCidrSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/IpamResourceCidr' - - xml: - name: item - GetLaunchTemplateDataRequest: - type: object - required: - - InstanceId - title: GetLaunchTemplateDataRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/InstanceId' - - description: The ID of the instance. - ResponseLaunchTemplateData: - type: object - properties: - kernelId: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The ID of the kernel, if applicable.' - ebsOptimized: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Indicates whether the instance is optimized for Amazon EBS I/O. ' - iamInstanceProfile: - allOf: - - $ref: '#/components/schemas/LaunchTemplateIamInstanceProfileSpecification' - - description: The IAM instance profile. - blockDeviceMappingSet: - allOf: - - $ref: '#/components/schemas/LaunchTemplateBlockDeviceMappingList' - - description: The block device mappings. - networkInterfaceSet: - allOf: - - $ref: '#/components/schemas/LaunchTemplateInstanceNetworkInterfaceSpecificationList' - - description: The network interfaces. - imageId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the AMI that was used to launch the instance. - instanceType: - allOf: - - $ref: '#/components/schemas/InstanceType' - - description: The instance type. - keyName: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of the key pair. - monitoring: - allOf: - - $ref: '#/components/schemas/LaunchTemplatesMonitoring' - - description: The monitoring for the instance. - placement: - allOf: - - $ref: '#/components/schemas/LaunchTemplatePlacement' - - description: The placement of the instance. - ramDiskId: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The ID of the RAM disk, if applicable.' - disableApiTermination: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'If set to true, indicates that the instance cannot be terminated using the Amazon EC2 console, command line tool, or API.' - instanceInitiatedShutdownBehavior: - allOf: - - $ref: '#/components/schemas/ShutdownBehavior' - - description: Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown). - userData: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The user data for the instance. ' - tagSpecificationSet: - allOf: - - $ref: '#/components/schemas/LaunchTemplateTagSpecificationList' - - description: The tags. - elasticGpuSpecificationSet: - allOf: - - $ref: '#/components/schemas/ElasticGpuSpecificationResponseList' - - description: The elastic GPU specification. - elasticInferenceAcceleratorSet: - allOf: - - $ref: '#/components/schemas/LaunchTemplateElasticInferenceAcceleratorResponseList' - - description: ' The elastic inference accelerator for the instance. ' - securityGroupIdSet: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The security group IDs. - securityGroupSet: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The security group names. - instanceMarketOptions: - allOf: - - $ref: '#/components/schemas/LaunchTemplateInstanceMarketOptions' - - description: The market (purchasing) option for the instances. - creditSpecification: - allOf: - - $ref: '#/components/schemas/CreditSpecification' - - description: The credit option for CPU usage of the instance. - cpuOptions: - allOf: - - $ref: '#/components/schemas/LaunchTemplateCpuOptions' - - description: 'The CPU options for the instance. For more information, see Optimizing CPU options in the Amazon Elastic Compute Cloud User Guide.' - capacityReservationSpecification: - allOf: - - $ref: '#/components/schemas/LaunchTemplateCapacityReservationSpecificationResponse' - - description: Information about the Capacity Reservation targeting option. - licenseSet: - allOf: - - $ref: '#/components/schemas/LaunchTemplateLicenseList' - - description: The license configurations. - hibernationOptions: - allOf: - - $ref: '#/components/schemas/LaunchTemplateHibernationOptions' - - description: 'Indicates whether an instance is configured for hibernation. For more information, see Hibernate your instance in the Amazon Elastic Compute Cloud User Guide.' - metadataOptions: - allOf: - - $ref: '#/components/schemas/LaunchTemplateInstanceMetadataOptions' - - description: 'The metadata options for the instance. For more information, see Instance metadata and user data in the Amazon Elastic Compute Cloud User Guide.' - enclaveOptions: - allOf: - - $ref: '#/components/schemas/LaunchTemplateEnclaveOptions' - - description: Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. - instanceRequirements: - allOf: - - $ref: '#/components/schemas/InstanceRequirements' - - description: '

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.

If you specify InstanceRequirements, you can''t specify InstanceTypes.

' - privateDnsNameOptions: - allOf: - - $ref: '#/components/schemas/LaunchTemplatePrivateDnsNameOptions' - - description: The options for the instance hostname. - maintenanceOptions: - allOf: - - $ref: '#/components/schemas/LaunchTemplateInstanceMaintenanceOptions' - - description: The maintenance options for your instance. - description: 'The information for a launch template. ' - GetManagedPrefixListAssociationsMaxResults: - type: integer - minimum: 5 - maximum: 255 - GetManagedPrefixListAssociationsRequest: - type: object - required: - - PrefixListId - title: GetManagedPrefixListAssociationsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: The token for the next page of results. - PrefixListAssociationSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/PrefixListAssociation' - - xml: - name: item - GetManagedPrefixListEntriesRequest: - type: object - required: - - PrefixListId - title: GetManagedPrefixListEntriesRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: The token for the next page of results. - PrefixListEntrySet: - type: array - items: - allOf: - - $ref: '#/components/schemas/PrefixListEntry' - - xml: - name: item - GetNetworkInsightsAccessScopeAnalysisFindingsRequest: - type: object - required: - - NetworkInsightsAccessScopeAnalysisId - title: GetNetworkInsightsAccessScopeAnalysisFindingsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - GetNetworkInsightsAccessScopeContentRequest: - type: object - required: - - NetworkInsightsAccessScopeId - title: GetNetworkInsightsAccessScopeContentRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - GetPasswordDataRequest: - type: object - required: - - InstanceId - title: GetPasswordDataRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/InstanceId' - - description: The ID of the Windows instance. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - GetReservedInstancesExchangeQuoteRequest: - type: object - required: - - ReservedInstanceIds - title: GetReservedInstancesExchangeQuoteRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - ReservedInstanceId: - allOf: - - $ref: '#/components/schemas/ReservedInstanceIdSet' - - description: The IDs of the Convertible Reserved Instances to exchange. - TargetConfiguration: - allOf: - - $ref: '#/components/schemas/TargetConfigurationRequestSet' - - description: The configuration of the target Convertible Reserved Instance to exchange for your current Convertible Reserved Instances. - description: Contains the parameters for GetReservedInstanceExchangeQuote. - ReservationValue: - type: object - properties: - hourlyPrice: - allOf: - - $ref: '#/components/schemas/String' - - description: The hourly rate of the reservation. - remainingTotalValue: - allOf: - - $ref: '#/components/schemas/String' - - description: The balance of the total value (the sum of remainingUpfrontValue + hourlyPrice * number of hours remaining). - remainingUpfrontValue: - allOf: - - $ref: '#/components/schemas/String' - - description: The remaining upfront cost of the reservation. - description: The cost associated with the Reserved Instance. - ReservedInstanceReservationValueSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/ReservedInstanceReservationValue' - - xml: - name: item - TargetReservationValueSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/TargetReservationValue' - - xml: - name: item - GetSerialConsoleAccessStatusRequest: - type: object - title: GetSerialConsoleAccessStatusRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - GetSpotPlacementScoresRequest: - type: object - required: - - TargetCapacity - title: GetSpotPlacementScoresRequest - properties: - InstanceType: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: '

Specify true so that the response returns a list of scored Availability Zones. Otherwise, the response returns a list of scored Regions.

A list of scored Availability Zones is useful if you want to launch all of your Spot capacity into a single Availability Zone.

' - RegionName: - allOf: - - $ref: '#/components/schemas/String' - - description: The token for the next set of results. - SpotPlacementScores: - type: array - items: - allOf: - - $ref: '#/components/schemas/SpotPlacementScore' - - xml: - name: item - GetSubnetCidrReservationsMaxResults: - type: integer - minimum: 5 - maximum: 1000 - GetSubnetCidrReservationsRequest: - type: object - required: - - SubnetId - title: GetSubnetCidrReservationsRequest - properties: - Filter: - allOf: - - $ref: '#/components/schemas/GetSubnetCidrReservationsMaxResults' - - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.' - SubnetCidrReservationList: - type: array - items: - allOf: - - $ref: '#/components/schemas/SubnetCidrReservation' - - xml: - name: item - GetTransitGatewayAttachmentPropagationsRequest: - type: object - required: - - TransitGatewayAttachmentId - title: GetTransitGatewayAttachmentPropagationsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/TransitGatewayAttachmentId' - - description: The ID of the attachment. - Filter: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - TransitGatewayAttachmentPropagationList: - type: array - items: - allOf: - - $ref: '#/components/schemas/TransitGatewayAttachmentPropagation' - - xml: - name: item - GetTransitGatewayMulticastDomainAssociationsRequest: - type: object - title: GetTransitGatewayMulticastDomainAssociationsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/TransitGatewayMulticastDomainId' - - description: The ID of the transit gateway multicast domain. - Filter: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - TransitGatewayMulticastDomainAssociationList: - type: array - items: - allOf: - - $ref: '#/components/schemas/TransitGatewayMulticastDomainAssociation' - - xml: - name: item - GetTransitGatewayPrefixListReferencesRequest: - type: object - required: - - TransitGatewayRouteTableId - title: GetTransitGatewayPrefixListReferencesRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/TransitGatewayRouteTableId' - - description: The ID of the transit gateway route table. - Filter: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - TransitGatewayPrefixListReferenceSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/TransitGatewayPrefixListReference' - - xml: - name: item - GetTransitGatewayRouteTableAssociationsRequest: - type: object - required: - - TransitGatewayRouteTableId - title: GetTransitGatewayRouteTableAssociationsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/TransitGatewayRouteTableId' - - description: The ID of the transit gateway route table. - Filter: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - TransitGatewayRouteTableAssociationList: - type: array - items: - allOf: - - $ref: '#/components/schemas/TransitGatewayRouteTableAssociation' - - xml: - name: item - GetTransitGatewayRouteTablePropagationsRequest: - type: object - required: - - TransitGatewayRouteTableId - title: GetTransitGatewayRouteTablePropagationsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/TransitGatewayRouteTableId' - - description: The ID of the transit gateway route table. - Filter: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - TransitGatewayRouteTablePropagationList: - type: array - items: - allOf: - - $ref: '#/components/schemas/TransitGatewayRouteTablePropagation' - - xml: - name: item - GetVpnConnectionDeviceSampleConfigurationRequest: - type: object - required: - - VpnConnectionId - - VpnConnectionDeviceTypeId - title: GetVpnConnectionDeviceSampleConfigurationRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - VpnConnectionDeviceSampleConfiguration: - type: string - format: password - GetVpnConnectionDeviceTypesRequest: - type: object - title: GetVpnConnectionDeviceTypesRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - VpnConnectionDeviceTypeList: - type: array - items: - allOf: - - $ref: '#/components/schemas/VpnConnectionDeviceType' - - xml: - name: item - GpuDeviceCount: - type: integer - GpuDeviceName: - type: string - GpuDeviceManufacturerName: - type: string - GpuDeviceMemoryInfo: - type: object - properties: - sizeInMiB: - allOf: - - $ref: '#/components/schemas/GpuDeviceMemorySize' - - description: 'The size of the memory available to the GPU accelerator, in MiB.' - description: Describes the memory available to the GPU accelerator. - GpuDeviceInfo: - type: object - properties: - name: - allOf: - - $ref: '#/components/schemas/GpuDeviceName' - - description: The name of the GPU accelerator. - manufacturer: - allOf: - - $ref: '#/components/schemas/GpuDeviceManufacturerName' - - description: The manufacturer of the GPU accelerator. - count: - allOf: - - $ref: '#/components/schemas/GpuDeviceCount' - - description: The number of GPUs for the instance type. - memoryInfo: - allOf: - - $ref: '#/components/schemas/GpuDeviceMemoryInfo' - - description: Describes the memory available to the GPU accelerator. - description: Describes the GPU accelerators for the instance type. - GpuDeviceInfoList: - type: array - items: - allOf: - - $ref: '#/components/schemas/GpuDeviceInfo' - - xml: - name: item - GpuDeviceMemorySize: - type: integer - totalGpuMemory: - type: integer - GpuInfo: - type: object - properties: - gpus: - allOf: - - $ref: '#/components/schemas/GpuDeviceInfoList' - - description: Describes the GPU accelerators for the instance type. - totalGpuMemoryInMiB: - allOf: - - $ref: '#/components/schemas/totalGpuMemory' - - description: 'The total size of the memory for the GPU accelerators for the instance type, in MiB.' - description: Describes the GPU accelerators for the instance type. - GroupIdentifier: - type: object - properties: - groupName: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of the security group. - groupId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the security group. - description: Describes a security group. - SecurityGroupIdentifier: - type: object - properties: - groupId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the security group. - groupName: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of the security group. - description: Describes a security group. - GroupIdentifierSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/SecurityGroupIdentifier' - - xml: - name: item - HibernationFlag: - type: boolean - HibernationOptions: - type: object - properties: - configured: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'If this parameter is set to true, your instance is enabled for hibernation; otherwise, it is not enabled for hibernation.' - description: 'Indicates whether your instance is configured for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites. For more information, see Hibernate your instance in the Amazon EC2 User Guide.' - HibernationOptionsRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: '

If you set this parameter to true, your instance is enabled for hibernation.

Default: false

' - description: 'Indicates whether your instance is configured for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites. For more information, see Hibernate your instance in the Amazon EC2 User Guide.' - HistoryRecord: - type: object - properties: - eventInformation: - allOf: - - $ref: '#/components/schemas/EventInformation' - - description: Information about the event. - eventType: - allOf: - - $ref: '#/components/schemas/EventType' - - description:

The event type.

  • error - An error with the Spot Fleet request.

  • fleetRequestChange - A change in the status or configuration of the Spot Fleet request.

  • instanceChange - An instance was launched or terminated.

  • Information - An informational event.

- timestamp: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: 'The date and time of the event, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).' - description: Describes an event in the history of the Spot Fleet request. - HistoryRecordEntry: - type: object - properties: - eventInformation: - allOf: - - $ref: '#/components/schemas/EventInformation' - - description: Information about the event. - eventType: - allOf: - - $ref: '#/components/schemas/FleetEventType' - - description: The event type. - timestamp: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: 'The date and time of the event, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).' - description: Describes an event in the history of an EC2 Fleet. - HostProperties: - type: object - properties: - cores: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The number of cores on the Dedicated Host. - instanceType: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The instance type supported by the Dedicated Host. For example, m5.large. If the host supports multiple instance types, no instanceType is returned.' - instanceFamily: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The instance family supported by the Dedicated Host. For example, m5.' - sockets: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The number of sockets on the Dedicated Host. - totalVCpus: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The total number of vCPUs on the Dedicated Host. - description: Describes the properties of a Dedicated Host. - HostInstanceList: - type: array - items: - allOf: - - $ref: '#/components/schemas/HostInstance' - - xml: - name: item - HostRecovery: - type: string - enum: - - 'on' - - 'off' - Host: - type: object - properties: - autoPlacement: - allOf: - - $ref: '#/components/schemas/AutoPlacement' - - description: Whether auto-placement is on or off. - availabilityZone: - allOf: - - $ref: '#/components/schemas/String' - - description: The Availability Zone of the Dedicated Host. - availableCapacity: - allOf: - - $ref: '#/components/schemas/AvailableCapacity' - - description: Information about the instances running on the Dedicated Host. - clientToken: - allOf: - - $ref: '#/components/schemas/String' - - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.' - hostId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Dedicated Host. - hostProperties: - allOf: - - $ref: '#/components/schemas/HostProperties' - - description: The hardware specifications of the Dedicated Host. - hostReservationId: - allOf: - - $ref: '#/components/schemas/String' - - description: The reservation ID of the Dedicated Host. This returns a null response if the Dedicated Host doesn't have an associated reservation. - instances: - allOf: - - $ref: '#/components/schemas/HostInstanceList' - - description: The IDs and instance type that are currently running on the Dedicated Host. - state: - allOf: - - $ref: '#/components/schemas/AllocationState' - - description: The Dedicated Host's state. - allocationTime: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The time that the Dedicated Host was allocated. - releaseTime: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The time that the Dedicated Host was released. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: Any tags assigned to the Dedicated Host. - hostRecovery: - allOf: - - $ref: '#/components/schemas/HostRecovery' - - description: Indicates whether host recovery is enabled or disabled for the Dedicated Host. - allowsMultipleInstanceTypes: - allOf: - - $ref: '#/components/schemas/AllowsMultipleInstanceTypes' - - description: 'Indicates whether the Dedicated Host supports multiple instance types of the same instance family. If the value is on, the Dedicated Host supports multiple instance types in the instance family. If the value is off, the Dedicated Host supports a single instance type only.' - ownerId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Amazon Web Services account that owns the Dedicated Host. - availabilityZoneId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Availability Zone in which the Dedicated Host is allocated. - memberOfServiceLinkedResourceGroup: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Indicates whether the Dedicated Host is in a host resource group. If memberOfServiceLinkedResourceGroup is true, the host is in a host resource group; otherwise, it is not.' - outpostArn: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which the Dedicated Host is allocated. - description: Describes the properties of the Dedicated Host. - HostInstance: - type: object - properties: - instanceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of instance that is running on the Dedicated Host. - instanceType: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The instance type (for example, m3.medium) of the running instance.' - ownerId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Amazon Web Services account that owns the instance. - description: Describes an instance running on a Dedicated Host. - PaymentOption: - type: string - enum: - - AllUpfront - - PartialUpfront - - NoUpfront - HostOffering: - type: object - properties: - currencyCode: - allOf: - - $ref: '#/components/schemas/CurrencyCodeValues' - - description: The currency of the offering. - duration: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The duration of the offering (in seconds). - hourlyPrice: - allOf: - - $ref: '#/components/schemas/String' - - description: The hourly price of the offering. - instanceFamily: - allOf: - - $ref: '#/components/schemas/String' - - description: The instance family of the offering. - offeringId: - allOf: - - $ref: '#/components/schemas/OfferingId' - - description: The ID of the offering. - paymentOption: - allOf: - - $ref: '#/components/schemas/PaymentOption' - - description: The available payment option. - upfrontPrice: - allOf: - - $ref: '#/components/schemas/String' - - description: The upfront price of the offering. Does not apply to No Upfront offerings. - description: Details about the Dedicated Host Reservation offering. - ResponseHostIdSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - ReservationState: - type: string - enum: - - payment-pending - - payment-failed - - active - - retired - HostReservation: - type: object - properties: - count: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The number of Dedicated Hosts the reservation is associated with. - currencyCode: - allOf: - - $ref: '#/components/schemas/CurrencyCodeValues' - - description: 'The currency in which the upfrontPrice and hourlyPrice amounts are specified. At this time, the only supported currency is USD.' - duration: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The length of the reservation''s term, specified in seconds. Can be 31536000 (1 year) | 94608000 (3 years).' - end: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The date and time that the reservation ends. - hostIdSet: - allOf: - - $ref: '#/components/schemas/ResponseHostIdSet' - - description: The IDs of the Dedicated Hosts associated with the reservation. - hostReservationId: - allOf: - - $ref: '#/components/schemas/HostReservationId' - - description: The ID of the reservation that specifies the associated Dedicated Hosts. - hourlyPrice: - allOf: - - $ref: '#/components/schemas/String' - - description: The hourly price of the reservation. - instanceFamily: - allOf: - - $ref: '#/components/schemas/String' - - description: The instance family of the Dedicated Host Reservation. The instance family on the Dedicated Host must be the same in order for it to benefit from the reservation. - offeringId: - allOf: - - $ref: '#/components/schemas/OfferingId' - - description: The ID of the reservation. This remains the same regardless of which Dedicated Hosts are associated with it. - paymentOption: - allOf: - - $ref: '#/components/schemas/PaymentOption' - - description: The payment option selected for this reservation. - start: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The date and time that the reservation started. - state: - allOf: - - $ref: '#/components/schemas/ReservationState' - - description: The state of the reservation. - upfrontPrice: - allOf: - - $ref: '#/components/schemas/String' - - description: The upfront price of the reservation. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: Any tags assigned to the Dedicated Host Reservation. - description: Details about the Dedicated Host Reservation and associated Dedicated Hosts. - HostReservationIdSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/HostReservationId' - - xml: - name: item - HostTenancy: - type: string - enum: - - dedicated - - host - HostnameType: - type: string - enum: - - ip-name - - resource-name - Hour: - type: integer - minimum: 0 - maximum: 23 - HttpTokensState: - type: string - enum: - - optional - - required - HypervisorType: - type: string - enum: - - ovm - - xen - IKEVersionsListValue: - type: object - properties: - value: - allOf: - - $ref: '#/components/schemas/String' - - description: The IKE version. - description: The internet key exchange (IKE) version permitted for the VPN tunnel. - IKEVersionsList: - type: array - items: - allOf: - - $ref: '#/components/schemas/IKEVersionsListValue' - - xml: - name: item - IKEVersionsRequestListValue: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The IKE version. - description: The IKE version that is permitted for the VPN tunnel. - IKEVersionsRequestList: - type: array - items: - allOf: - - $ref: '#/components/schemas/IKEVersionsRequestListValue' - - xml: - name: item - IamInstanceProfile: - type: object - properties: - arn: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Resource Name (ARN) of the instance profile. - id: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the instance profile. - description: Describes an IAM instance profile. - IamInstanceProfileAssociationState: - type: string - enum: - - associating - - associated - - disassociating - - disassociated - IdFormat: - type: object - properties: - deadline: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: 'The date in UTC at which you are permanently switched over to using longer IDs. If a deadline is not yet available for this resource type, this field is not returned.' - resource: - allOf: - - $ref: '#/components/schemas/String' - - description: The type of resource. - useLongIds: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether longer IDs (17-character IDs) are enabled for the resource. - description: Describes the ID format for a resource. - Igmpv2SupportValue: - type: string - enum: - - enable - - disable - ImageTypeValues: - type: string - enum: - - machine - - kernel - - ramdisk - ImageState: - type: string - enum: - - pending - - available - - invalid - - deregistered - - transient - - failed - - error - StateReason: - type: object - properties: - code: - allOf: - - $ref: '#/components/schemas/String' - - description: The reason code for the state change. - message: - allOf: - - $ref: '#/components/schemas/String' - - description: '

The message for the state change.

  • Server.InsufficientInstanceCapacity: There was insufficient capacity available to satisfy the launch request.

  • Server.InternalError: An internal error caused the instance to terminate during launch.

  • Server.ScheduledStop: The instance was stopped due to a scheduled retirement.

  • Server.SpotInstanceShutdown: The instance was stopped because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price.

  • Server.SpotInstanceTermination: The instance was terminated because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price.

  • Client.InstanceInitiatedShutdown: The instance was shut down using the shutdown -h command from the instance.

  • Client.InstanceTerminated: The instance was terminated or rebooted during AMI creation.

  • Client.InternalError: A client error caused the instance to terminate during launch.

  • Client.InvalidSnapshot.NotFound: The specified snapshot was not found.

  • Client.UserInitiatedHibernate: Hibernation was initiated on the instance.

  • Client.UserInitiatedShutdown: The instance was shut down using the Amazon EC2 API.

  • Client.VolumeLimitExceeded: The limit on the number of EBS volumes or total storage was exceeded. Decrease usage or request an increase in your account limits.

' - description: Describes a state change. - TpmSupportValues: - type: string - enum: - - v2.0 - Image: - type: object - properties: - architecture: - allOf: - - $ref: '#/components/schemas/ArchitectureValues' - - description: The architecture of the image. - creationDate: - allOf: - - $ref: '#/components/schemas/String' - - description: The date and time the image was created. - imageId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the AMI. - imageLocation: - allOf: - - $ref: '#/components/schemas/String' - - description: The location of the AMI. - imageType: - allOf: - - $ref: '#/components/schemas/ImageTypeValues' - - description: The type of image. - isPublic: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether the image has public launch permissions. The value is true if this image has public launch permissions or false if it has only implicit and explicit launch permissions. - kernelId: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The kernel associated with the image, if any. Only applicable for machine images.' - imageOwnerId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Amazon Web Services account that owns the image. - platform: - allOf: - - $ref: '#/components/schemas/PlatformValues' - - description: 'This value is set to windows for Windows AMIs; otherwise, it is blank.' - platformDetails: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The platform details associated with the billing code of the AMI. For more information, see Understanding AMI billing in the Amazon Elastic Compute Cloud User Guide.' - usageOperation: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The operation of the Amazon EC2 instance and the billing code that is associated with the AMI. usageOperation corresponds to the lineitem/Operation column on your Amazon Web Services Cost and Usage Report and in the Amazon Web Services Price List API. You can view these fields on the Instances or AMIs pages in the Amazon EC2 console, or in the responses that are returned by the DescribeImages command in the Amazon EC2 API, or the describe-images command in the CLI.' - productCodes: - allOf: - - $ref: '#/components/schemas/ProductCodeList' - - description: Any product codes associated with the AMI. - ramdiskId: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The RAM disk associated with the image, if any. Only applicable for machine images.' - imageState: - allOf: - - $ref: '#/components/schemas/ImageState' - - description: 'The current state of the AMI. If the state is available, the image is successfully registered and can be used to launch an instance.' - blockDeviceMapping: - allOf: - - $ref: '#/components/schemas/BlockDeviceMappingList' - - description: Any block device mapping entries. - description: - allOf: - - $ref: '#/components/schemas/String' - - description: The description of the AMI that was provided during image creation. - enaSupport: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Specifies whether enhanced networking with ENA is enabled. - hypervisor: - allOf: - - $ref: '#/components/schemas/HypervisorType' - - description: The hypervisor type of the image. - imageOwnerAlias: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The Amazon Web Services account alias (for example, amazon, self) or the Amazon Web Services account ID of the AMI owner.' - name: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of the AMI that was provided during image creation. - rootDeviceName: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The device name of the root device volume (for example, /dev/sda1).' - rootDeviceType: - allOf: - - $ref: '#/components/schemas/DeviceType' - - description: The type of root device used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume. - sriovNetSupport: - allOf: - - $ref: '#/components/schemas/String' - - description: Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled. - stateReason: - allOf: - - $ref: '#/components/schemas/StateReason' - - description: The reason for the state change. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: Any tags assigned to the image. - virtualizationType: - allOf: - - $ref: '#/components/schemas/VirtualizationType' - - description: The type of virtualization of the AMI. - bootMode: - allOf: - - $ref: '#/components/schemas/BootModeValues' - - description: 'The boot mode of the image. For more information, see Boot modes in the Amazon Elastic Compute Cloud User Guide.' - tpmSupport: - allOf: - - $ref: '#/components/schemas/TpmSupportValues' - - description: 'If the image is configured for NitroTPM support, the value is v2.0. For more information, see NitroTPM in the Amazon Elastic Compute Cloud User Guide.' - deprecationTime: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The date and time to deprecate the AMI, in UTC, in the following format: YYYY-MM-DDTHH:MM:SSZ. If you specified a value for seconds, Amazon EC2 rounds the seconds to the nearest minute.' - description: Describes an image. - ImageAttributeName: - type: string - enum: - - description - - kernel - - ramdisk - - launchPermission - - productCodes - - blockDeviceMapping - - sriovNetSupport - - bootMode - - tpmSupport - - uefiData - - lastLaunchedTime - ImageDiskContainerList: - type: array - items: - allOf: - - $ref: '#/components/schemas/ImageDiskContainer' - - xml: - name: item - ImageIdList: - type: array - items: - allOf: - - $ref: '#/components/schemas/ImageId' - - xml: - name: item - ImageRecycleBinInfo: - type: object - properties: - imageId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the AMI. - name: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of the AMI. - description: - allOf: - - $ref: '#/components/schemas/String' - - description: The description of the AMI. - recycleBinEnterTime: - allOf: - - $ref: '#/components/schemas/MillisecondDateTime' - - description: The date and time when the AMI entered the Recycle Bin. - recycleBinExitTime: - allOf: - - $ref: '#/components/schemas/MillisecondDateTime' - - description: The date and time when the AMI is to be permanently deleted from the Recycle Bin. - description: Information about an AMI that is currently in the Recycle Bin. - ImageRecycleBinInfoList: - type: array - items: - allOf: - - $ref: '#/components/schemas/ImageRecycleBinInfo' - - xml: - name: item - ImportClientVpnClientCertificateRevocationListRequest: - type: object - required: - - ClientVpnEndpointId - - CertificateRevocationList - title: ImportClientVpnClientCertificateRevocationListRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - ImportImageLicenseConfigurationResponse: - type: object - properties: - licenseConfigurationArn: - allOf: - - $ref: '#/components/schemas/String' - - description: The ARN of a license configuration. - description: ' The response information for license configurations.' - ImportImageLicenseSpecificationListRequest: - type: array - items: - allOf: - - $ref: '#/components/schemas/ImportImageLicenseConfigurationRequest' - - xml: - name: item - ImportImageLicenseSpecificationListResponse: - type: array - items: - allOf: - - $ref: '#/components/schemas/ImportImageLicenseConfigurationResponse' - - xml: - name: item - ImportImageRequest: - type: object - title: ImportImageRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: A description string for the import image task. - DiskContainer: - allOf: - - $ref: '#/components/schemas/ImportImageLicenseSpecificationListRequest' - - description: The ARNs of the license configurations. - TagSpecification: - allOf: - - $ref: '#/components/schemas/BootModeValues' - - description: The boot mode of the virtual machine. - SnapshotDetailList: - type: array - items: - allOf: - - $ref: '#/components/schemas/SnapshotDetail' - - xml: - name: item - ImportImageTask: - type: object - properties: - architecture: - allOf: - - $ref: '#/components/schemas/String' - - description: '

The architecture of the virtual machine.

Valid values: i386 | x86_64 | arm64

' - description: - allOf: - - $ref: '#/components/schemas/String' - - description: A description of the import task. - encrypted: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether the image is encrypted. - hypervisor: - allOf: - - $ref: '#/components/schemas/String' - - description: '

The target hypervisor for the import task.

Valid values: xen

' - imageId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Amazon Machine Image (AMI) of the imported virtual machine. - importTaskId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the import image task. - kmsKeyId: - allOf: - - $ref: '#/components/schemas/String' - - description: The identifier for the KMS key that was used to create the encrypted image. - licenseType: - allOf: - - $ref: '#/components/schemas/String' - - description: The license type of the virtual machine. - platform: - allOf: - - $ref: '#/components/schemas/String' - - description: The description string for the import image task. - progress: - allOf: - - $ref: '#/components/schemas/String' - - description: The percentage of progress of the import image task. - snapshotDetailSet: - allOf: - - $ref: '#/components/schemas/SnapshotDetailList' - - description: Information about the snapshots. - status: - allOf: - - $ref: '#/components/schemas/String' - - description: A brief status for the import image task. - statusMessage: - allOf: - - $ref: '#/components/schemas/String' - - description: A descriptive status message for the import image task. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: The tags for the import image task. - licenseSpecifications: - allOf: - - $ref: '#/components/schemas/ImportImageLicenseSpecificationListResponse' - - description: The ARNs of the license configurations that are associated with the import image task. - usageOperation: - allOf: - - $ref: '#/components/schemas/String' - - description: The usage operation value. - bootMode: - allOf: - - $ref: '#/components/schemas/BootModeValues' - - description: The boot mode of the virtual machine. - description: Describes an import image task. - ImportInstanceLaunchSpecification: - type: object - properties: - additionalInfo: - allOf: - - $ref: '#/components/schemas/String' - - description: Reserved. - architecture: - allOf: - - $ref: '#/components/schemas/ArchitectureValues' - - description: The architecture of the instance. - GroupId: - allOf: - - $ref: '#/components/schemas/SecurityGroupIdStringList' - - description: The security group IDs. - GroupName: - allOf: - - $ref: '#/components/schemas/SecurityGroupStringList' - - description: The security group names. - instanceInitiatedShutdownBehavior: - allOf: - - $ref: '#/components/schemas/ShutdownBehavior' - - description: Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown). - instanceType: - allOf: - - $ref: '#/components/schemas/InstanceType' - - description: 'The instance type. For more information about the instance types that you can import, see Instance Types in the VM Import/Export User Guide.' - monitoring: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether monitoring is enabled. - placement: - allOf: - - $ref: '#/components/schemas/Placement' - - description: The placement information for the instance. - privateIpAddress: - allOf: - - $ref: '#/components/schemas/String' - - description: '[EC2-VPC] An available IP address from the IP address range of the subnet.' - subnetId: - allOf: - - $ref: '#/components/schemas/SubnetId' - - description: '[EC2-VPC] The ID of the subnet in which to launch the instance.' - userData: - allOf: - - $ref: '#/components/schemas/UserData' - - description: The Base64-encoded user data to make available to the instance. - description: Describes the launch specification for VM import. - ImportInstanceRequest: - type: object - required: - - Platform - title: ImportInstanceRequest - properties: - description: - allOf: - - $ref: '#/components/schemas/String' - - description: A description for the instance being imported. - diskImage: - allOf: - - $ref: '#/components/schemas/DiskImageList' - - description: The disk image. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - launchSpecification: - allOf: - - $ref: '#/components/schemas/ImportInstanceLaunchSpecification' - - description: The launch specification. - platform: - allOf: - - $ref: '#/components/schemas/PlatformValues' - - description: The instance operating system. - ImportInstanceVolumeDetailSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/ImportInstanceVolumeDetailItem' - - xml: - name: item - ImportInstanceVolumeDetailItem: - type: object - properties: - availabilityZone: - allOf: - - $ref: '#/components/schemas/String' - - description: The Availability Zone where the resulting instance will reside. - bytesConverted: - allOf: - - $ref: '#/components/schemas/Long' - - description: The number of bytes converted so far. - description: - allOf: - - $ref: '#/components/schemas/String' - - description: A description of the task. - image: - allOf: - - $ref: '#/components/schemas/DiskImageDescription' - - description: The image. - status: - allOf: - - $ref: '#/components/schemas/String' - - description: The status of the import of this particular disk image. - statusMessage: - allOf: - - $ref: '#/components/schemas/String' - - description: The status information or errors related to the disk image. - volume: - allOf: - - $ref: '#/components/schemas/DiskImageVolumeDescription' - - description: The volume. - description: Describes an import volume task. - ImportKeyPairRequest: - type: object - required: - - KeyName - - PublicKeyMaterial - title: ImportKeyPairRequest - properties: - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - keyName: - allOf: - - $ref: '#/components/schemas/String' - - description: A unique name for the key pair. - publicKeyMaterial: - allOf: - - $ref: '#/components/schemas/Blob' - - description: 'The public key. For API calls, the text must be base64-encoded. For command line tools, base64 encoding is performed for you.' - TagSpecification: - allOf: - - $ref: '#/components/schemas/TagSpecificationList' - - description: The tags to apply to the imported key pair. - ImportSnapshotRequest: - type: object - title: ImportSnapshotRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The name of the role to use when not using the default role, ''vmimport''.' - TagSpecification: - allOf: - - $ref: '#/components/schemas/TagSpecificationList' - - description: The tags to apply to the import snapshot task during creation. - SnapshotTaskDetail: - type: object - properties: - description: - allOf: - - $ref: '#/components/schemas/String' - - description: The description of the snapshot. - diskImageSize: - allOf: - - $ref: '#/components/schemas/Double' - - description: 'The size of the disk in the snapshot, in GiB.' - encrypted: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether the snapshot is encrypted. - format: - allOf: - - $ref: '#/components/schemas/String' - - description: The format of the disk image from which the snapshot is created. - kmsKeyId: - allOf: - - $ref: '#/components/schemas/String' - - description: The identifier for the KMS key that was used to create the encrypted snapshot. - progress: - allOf: - - $ref: '#/components/schemas/String' - - description: The percentage of completion for the import snapshot task. - snapshotId: - allOf: - - $ref: '#/components/schemas/String' - - description: The snapshot ID of the disk being imported. - status: - allOf: - - $ref: '#/components/schemas/String' - - description: A brief status for the import snapshot task. - statusMessage: - allOf: - - $ref: '#/components/schemas/String' - - description: A detailed status message for the import snapshot task. - url: - allOf: - - $ref: '#/components/schemas/String' - - description: The URL of the disk image from which the snapshot is created. - userBucket: - allOf: - - $ref: '#/components/schemas/UserBucketDetails' - - description: The Amazon S3 bucket for the disk image. - description: Details about the import snapshot task. - ImportSnapshotTask: - type: object - properties: - description: - allOf: - - $ref: '#/components/schemas/String' - - description: A description of the import snapshot task. - importTaskId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the import snapshot task. - snapshotTaskDetail: - allOf: - - $ref: '#/components/schemas/SnapshotTaskDetail' - - description: Describes an import snapshot task. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: The tags for the import snapshot task. - description: Describes an import snapshot task. - ImportSnapshotTaskIdList: - type: array - items: - allOf: - - $ref: '#/components/schemas/ImportSnapshotTaskId' - - xml: - name: ImportTaskId - ImportTaskIdList: - type: array - items: - allOf: - - $ref: '#/components/schemas/ImportImageTaskId' - - xml: - name: ImportTaskId - ImportVolumeRequest: - type: object - required: - - AvailabilityZone - - Image - - Volume - title: ImportVolumeRequest - properties: - availabilityZone: - allOf: - - $ref: '#/components/schemas/String' - - description: The Availability Zone for the resulting EBS volume. - description: - allOf: - - $ref: '#/components/schemas/String' - - description: A description of the volume. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - image: - allOf: - - $ref: '#/components/schemas/DiskImageDetail' - - description: The disk image. - volume: - allOf: - - $ref: '#/components/schemas/VolumeDetail' - - description: The volume size. - InferenceDeviceInfoList: - type: array - items: - $ref: '#/components/schemas/InferenceDeviceInfo' - InferenceAcceleratorInfo: - type: object - properties: - accelerators: - allOf: - - $ref: '#/components/schemas/InferenceDeviceInfoList' - - description: Describes the Inference accelerators for the instance type. - description: Describes the Inference accelerators for the instance type. - InferenceDeviceCount: - type: integer - InferenceDeviceName: - type: string - InferenceDeviceManufacturerName: - type: string - InferenceDeviceInfo: - type: object - properties: - count: - allOf: - - $ref: '#/components/schemas/InferenceDeviceCount' - - description: The number of Inference accelerators for the instance type. - name: - allOf: - - $ref: '#/components/schemas/InferenceDeviceName' - - description: The name of the Inference accelerator. - manufacturer: - allOf: - - $ref: '#/components/schemas/InferenceDeviceManufacturerName' - - description: The manufacturer of the Inference accelerator. - description: Describes the Inference accelerators for the instance type. - Monitoring: - type: object - properties: - state: - allOf: - - $ref: '#/components/schemas/MonitoringState' - - description: 'Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.' - description: Describes the monitoring of an instance. - InstanceState: - type: object - properties: - code: - allOf: - - $ref: '#/components/schemas/Integer' - - description: '

The state of the instance as a 16-bit unsigned integer.

The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.

The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.

The valid values for instance-state-code will all be in the range of the low byte and they are:

  • 0 : pending

  • 16 : running

  • 32 : shutting-down

  • 48 : terminated

  • 64 : stopping

  • 80 : stopped

You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.

' - name: - allOf: - - $ref: '#/components/schemas/InstanceStateName' - - description: The current state of the instance. - description: Describes the current state of an instance. - InstanceBlockDeviceMappingList: - type: array - items: - allOf: - - $ref: '#/components/schemas/InstanceBlockDeviceMapping' - - xml: - name: item - InstanceLifecycleType: - type: string - enum: - - spot - - scheduled - InstanceNetworkInterfaceList: - type: array - items: - allOf: - - $ref: '#/components/schemas/InstanceNetworkInterface' - - xml: - name: item - LicenseList: - type: array - items: - allOf: - - $ref: '#/components/schemas/LicenseConfiguration' - - xml: - name: item - InstanceMetadataOptionsResponse: - type: object - properties: - state: - allOf: - - $ref: '#/components/schemas/InstanceMetadataOptionsState' - - description:

The state of the metadata option changes.

pending - The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection.

applied - The metadata options have been successfully applied on the instance.

- httpTokens: - allOf: - - $ref: '#/components/schemas/HttpTokensState' - - description: '

The state of token usage for your instance metadata requests.

If the state is optional, you can choose to retrieve instance metadata with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0 role credentials are returned.

If the state is required, you must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials; the version 1.0 credentials are not available.

Default: optional

' - httpPutResponseHopLimit: - allOf: - - $ref: '#/components/schemas/Integer' - - description: '

The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.

Default: 1

Possible values: Integers from 1 to 64

' - httpEndpoint: - allOf: - - $ref: '#/components/schemas/InstanceMetadataEndpointState' - - description: '

Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled.

If the value is disabled, you cannot access your instance metadata.

' - httpProtocolIpv6: - allOf: - - $ref: '#/components/schemas/InstanceMetadataProtocolState' - - description: Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled. - instanceMetadataTags: - allOf: - - $ref: '#/components/schemas/InstanceMetadataTagsState' - - description: 'Indicates whether access to instance tags from the instance metadata is enabled or disabled. For more information, see Work with instance tags using the instance metadata.' - description: The metadata options for the instance. - PrivateDnsNameOptionsResponse: - type: object - properties: - hostnameType: - allOf: - - $ref: '#/components/schemas/HostnameType' - - description: The type of hostname to assign to an instance. - enableResourceNameDnsARecord: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether to respond to DNS queries for instance hostnames with DNS A records. - enableResourceNameDnsAAAARecord: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records. - description: Describes the options for instance hostnames. - InstanceMaintenanceOptions: - type: object - properties: - autoRecovery: - allOf: - - $ref: '#/components/schemas/InstanceAutoRecoveryState' - - description: Provides information on the current automatic recovery behavior of your instance. - description: The maintenance options for the instance. - Instance: - type: object - properties: - amiLaunchIndex: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The AMI launch index, which can be used to find this instance in the launch group.' - imageId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the AMI used to launch the instance. - instanceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the instance. - instanceType: - allOf: - - $ref: '#/components/schemas/InstanceType' - - description: The instance type. - kernelId: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The kernel associated with this instance, if applicable.' - keyName: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The name of the key pair, if this instance was launched with an associated key pair.' - launchTime: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The time the instance was launched. - monitoring: - allOf: - - $ref: '#/components/schemas/Monitoring' - - description: The monitoring for the instance. - placement: - allOf: - - $ref: '#/components/schemas/Placement' - - description: 'The location where the instance launched, if applicable.' - platform: - allOf: - - $ref: '#/components/schemas/PlatformValues' - - description: The value is Windows for Windows instances; otherwise blank. - privateDnsName: - allOf: - - $ref: '#/components/schemas/String' - - description: '

(IPv4 only) The private DNS hostname name assigned to the instance. This DNS hostname can only be used inside the Amazon EC2 network. This name is not available until the instance enters the running state.

[EC2-VPC] The Amazon-provided DNS server resolves Amazon-provided private DNS hostnames if you''ve enabled DNS resolution and DNS hostnames in your VPC. If you are not using the Amazon-provided DNS server in your VPC, your custom domain name servers must resolve the hostname as appropriate.

' - privateIpAddress: - allOf: - - $ref: '#/components/schemas/String' - - description: The private IPv4 address assigned to the instance. - productCodes: - allOf: - - $ref: '#/components/schemas/ProductCodeList' - - description: 'The product codes attached to this instance, if applicable.' - dnsName: - allOf: - - $ref: '#/components/schemas/String' - - description: '(IPv4 only) The public DNS name assigned to the instance. This name is not available until the instance enters the running state. For EC2-VPC, this name is only available if you''ve enabled DNS hostnames for your VPC.' - ipAddress: - allOf: - - $ref: '#/components/schemas/String' - - description: '

The public IPv4 address, or the Carrier IP address assigned to the instance, if applicable.

A Carrier IP address only applies to an instance launched in a subnet associated with a Wavelength Zone.

' - ramdiskId: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The RAM disk associated with this instance, if applicable.' - instanceState: - allOf: - - $ref: '#/components/schemas/InstanceState' - - description: The current state of the instance. - reason: - allOf: - - $ref: '#/components/schemas/String' - - description: The reason for the most recent state transition. This might be an empty string. - subnetId: - allOf: - - $ref: '#/components/schemas/String' - - description: '[EC2-VPC] The ID of the subnet in which the instance is running.' - vpcId: - allOf: - - $ref: '#/components/schemas/String' - - description: '[EC2-VPC] The ID of the VPC in which the instance is running.' - architecture: - allOf: - - $ref: '#/components/schemas/ArchitectureValues' - - description: The architecture of the image. - blockDeviceMapping: - allOf: - - $ref: '#/components/schemas/InstanceBlockDeviceMappingList' - - description: Any block device mapping entries for the instance. - clientToken: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The idempotency token you provided when you launched the instance, if applicable.' - ebsOptimized: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance. - enaSupport: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Specifies whether enhanced networking with ENA is enabled. - hypervisor: - allOf: - - $ref: '#/components/schemas/HypervisorType' - - description: The hypervisor type of the instance. The value xen is used for both Xen and Nitro hypervisors. - iamInstanceProfile: - allOf: - - $ref: '#/components/schemas/IamInstanceProfile' - - description: 'The IAM instance profile associated with the instance, if applicable.' - instanceLifecycle: - allOf: - - $ref: '#/components/schemas/InstanceLifecycleType' - - description: Indicates whether this is a Spot Instance or a Scheduled Instance. - elasticGpuAssociationSet: - allOf: - - $ref: '#/components/schemas/ElasticGpuAssociationList' - - description: The Elastic GPU associated with the instance. - elasticInferenceAcceleratorAssociationSet: - allOf: - - $ref: '#/components/schemas/ElasticInferenceAcceleratorAssociationList' - - description: ' The elastic inference accelerator associated with the instance.' - networkInterfaceSet: - allOf: - - $ref: '#/components/schemas/InstanceNetworkInterfaceList' - - description: '[EC2-VPC] The network interfaces for the instance.' - outpostArn: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Resource Name (ARN) of the Outpost. - rootDeviceName: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The device name of the root device volume (for example, /dev/sda1).' - rootDeviceType: - allOf: - - $ref: '#/components/schemas/DeviceType' - - description: The root device type used by the AMI. The AMI can use an EBS volume or an instance store volume. - groupSet: - allOf: - - $ref: '#/components/schemas/GroupIdentifierList' - - description: The security groups for the instance. - sourceDestCheck: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether source/destination checking is enabled. - spotInstanceRequestId: - allOf: - - $ref: '#/components/schemas/String' - - description: 'If the request is a Spot Instance request, the ID of the request.' - sriovNetSupport: - allOf: - - $ref: '#/components/schemas/String' - - description: Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled. - stateReason: - allOf: - - $ref: '#/components/schemas/StateReason' - - description: The reason for the most recent state transition. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: Any tags assigned to the instance. - virtualizationType: - allOf: - - $ref: '#/components/schemas/VirtualizationType' - - description: The virtualization type of the instance. - cpuOptions: - allOf: - - $ref: '#/components/schemas/CpuOptions' - - description: The CPU options for the instance. - capacityReservationId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Capacity Reservation. - capacityReservationSpecification: - allOf: - - $ref: '#/components/schemas/CapacityReservationSpecificationResponse' - - description: Information about the Capacity Reservation targeting option. - hibernationOptions: - allOf: - - $ref: '#/components/schemas/HibernationOptions' - - description: Indicates whether the instance is enabled for hibernation. - licenseSet: - allOf: - - $ref: '#/components/schemas/LicenseList' - - description: The license configurations for the instance. - metadataOptions: - allOf: - - $ref: '#/components/schemas/InstanceMetadataOptionsResponse' - - description: The metadata options for the instance. - enclaveOptions: - allOf: - - $ref: '#/components/schemas/EnclaveOptions' - - description: Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. - bootMode: - allOf: - - $ref: '#/components/schemas/BootModeValues' - - description: 'The boot mode of the instance. For more information, see Boot modes in the Amazon EC2 User Guide.' - platformDetails: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The platform details value for the instance. For more information, see AMI billing information fields in the Amazon EC2 User Guide.' - usageOperation: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The usage operation value for the instance. For more information, see AMI billing information fields in the Amazon EC2 User Guide.' - usageOperationUpdateTime: - allOf: - - $ref: '#/components/schemas/MillisecondDateTime' - - description: The time that the usage operation was last updated. - privateDnsNameOptions: - allOf: - - $ref: '#/components/schemas/PrivateDnsNameOptionsResponse' - - description: The options for the instance hostname. - ipv6Address: - allOf: - - $ref: '#/components/schemas/String' - - description: The IPv6 address assigned to the instance. - tpmSupport: - allOf: - - $ref: '#/components/schemas/String' - - description: 'If the instance is configured for NitroTPM support, the value is v2.0. For more information, see NitroTPM in the Amazon EC2 User Guide.' - maintenanceOptions: - allOf: - - $ref: '#/components/schemas/InstanceMaintenanceOptions' - - description: Provides information on the recovery and maintenance options of your instance. - description: Describes an instance. - InstanceBlockDeviceMapping: - type: object - properties: - deviceName: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The device name (for example, /dev/sdh or xvdh).' - ebs: - allOf: - - $ref: '#/components/schemas/EbsInstanceBlockDevice' - - description: Parameters used to automatically set up EBS volumes when the instance is launched. - description: Describes a block device mapping. - InstanceBlockDeviceMappingSpecificationList: - type: array - items: - allOf: - - $ref: '#/components/schemas/InstanceBlockDeviceMappingSpecification' - - xml: - name: item - ListingState: - type: string - enum: - - available - - sold - - cancelled - - pending - InstanceCount: - type: object - properties: - instanceCount: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The number of listed Reserved Instances in the state specified by the state. - state: - allOf: - - $ref: '#/components/schemas/ListingState' - - description: The states of the listed Reserved Instances. - description: Describes a Reserved Instance listing state. - InstanceCountList: - type: array - items: - allOf: - - $ref: '#/components/schemas/InstanceCount' - - xml: - name: item - InstanceCreditSpecification: - type: object - properties: - instanceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the instance. - cpuCredits: - allOf: - - $ref: '#/components/schemas/String' - - description: The credit option for CPU usage of the instance. Valid values are standard and unlimited. - description: 'Describes the credit option for CPU usage of a burstable performance instance. ' - InstanceCreditSpecificationListRequest: - type: array - items: - allOf: - - $ref: '#/components/schemas/InstanceCreditSpecificationRequest' - - xml: - name: item - InstanceEventId: - type: string - InstanceEventWindowTimeRangeList: - type: array - items: - allOf: - - $ref: '#/components/schemas/InstanceEventWindowTimeRange' - - xml: - name: item - InstanceEventWindowAssociationTarget: - type: object - properties: - instanceIdSet: - allOf: - - $ref: '#/components/schemas/InstanceIdList' - - description: The IDs of the instances associated with the event window. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: The instance tags associated with the event window. Any instances associated with the tags will be associated with the event window. - dedicatedHostIdSet: - allOf: - - $ref: '#/components/schemas/DedicatedHostIdList' - - description: The IDs of the Dedicated Hosts associated with the event window. - description: One or more targets associated with the event window. - InstanceEventWindowState: - type: string - enum: - - creating - - deleting - - active - - deleted - WeekDay: - type: string - enum: - - sunday - - monday - - tuesday - - wednesday - - thursday - - friday - - saturday - InstanceEventWindowTimeRange: - type: object - properties: - startWeekDay: - allOf: - - $ref: '#/components/schemas/WeekDay' - - description: The day on which the time range begins. - startHour: - allOf: - - $ref: '#/components/schemas/Hour' - - description: The hour when the time range begins. - endWeekDay: - allOf: - - $ref: '#/components/schemas/WeekDay' - - description: The day on which the time range ends. - endHour: - allOf: - - $ref: '#/components/schemas/Hour' - - description: The hour when the time range ends. - description: 'The start day and time and the end day and time of the time range, in UTC.' - InstanceEventWindowTimeRangeRequestSet: - type: array - items: - $ref: '#/components/schemas/InstanceEventWindowTimeRangeRequest' - InstanceGeneration: - type: string - enum: - - current - - previous - InstanceGenerationSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/InstanceGeneration' - - xml: - name: item - InstanceIdSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/InstanceId' - - xml: - name: item - InstanceIpv4Prefix: - type: object - properties: - ipv4Prefix: - allOf: - - $ref: '#/components/schemas/String' - - description: One or more IPv4 prefixes assigned to the network interface. - description: Information about an IPv4 prefix. - InstanceIpv4PrefixList: - type: array - items: - allOf: - - $ref: '#/components/schemas/InstanceIpv4Prefix' - - xml: - name: item - InstanceIpv6AddressRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The IPv6 address. - description: Describes an IPv6 address. - InstanceIpv6AddressListRequest: - type: array - items: - allOf: - - $ref: '#/components/schemas/InstanceIpv6AddressRequest' - - xml: - name: InstanceIpv6Address - InstanceIpv6Prefix: - type: object - properties: - ipv6Prefix: - allOf: - - $ref: '#/components/schemas/String' - - description: One or more IPv6 prefixes assigned to the network interface. - description: Information about an IPv6 prefix. - InstanceIpv6PrefixList: - type: array - items: - allOf: - - $ref: '#/components/schemas/InstanceIpv6Prefix' - - xml: - name: item - InstanceList: - type: array - items: - allOf: - - $ref: '#/components/schemas/Instance' - - xml: - name: item - InstanceMaintenanceOptionsRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/InstanceAutoRecoveryState' - - description: 'Disables the automatic recovery behavior of your instance or sets it to default. For more information, see Simplified automatic recovery.' - description: The maintenance options for the instance. - InstanceMarketOptionsRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/SpotMarketOptions' - - description: The options for Spot Instances. - description: Describes the market (purchasing) option for the instances. - InstanceMetadataEndpointState: - type: string - enum: - - disabled - - enabled - InstanceMetadataOptionsRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/InstanceMetadataTagsState' - - description: '

Set to enabled to allow access to instance tags from the instance metadata. Set to disabled to turn off access to instance tags from the instance metadata. For more information, see Work with instance tags using the instance metadata.

Default: disabled

' - description: The metadata options for the instance. - InstanceMetadataOptionsState: - type: string - enum: - - pending - - applied - InstanceMetadataProtocolState: - type: string - enum: - - disabled - - enabled - InstanceMonitoring: - type: object - properties: - instanceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the instance. - monitoring: - allOf: - - $ref: '#/components/schemas/Monitoring' - - description: The monitoring for the instance. - description: Describes the monitoring of an instance. - InstanceMonitoringList: - type: array - items: - allOf: - - $ref: '#/components/schemas/InstanceMonitoring' - - xml: - name: item - InstanceNetworkInterfaceAssociation: - type: object - properties: - carrierIp: - allOf: - - $ref: '#/components/schemas/String' - - description: The carrier IP address associated with the network interface. - customerOwnedIp: - allOf: - - $ref: '#/components/schemas/String' - - description: The customer-owned IP address associated with the network interface. - ipOwnerId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the owner of the Elastic IP address. - publicDnsName: - allOf: - - $ref: '#/components/schemas/String' - - description: The public DNS name. - publicIp: - allOf: - - $ref: '#/components/schemas/String' - - description: The public IP address or Elastic IP address bound to the network interface. - description: Describes association information for an Elastic IP address (IPv4). - InstanceNetworkInterfaceAttachment: - type: object - properties: - attachTime: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The time stamp when the attachment initiated. - attachmentId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the network interface attachment. - deleteOnTermination: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether the network interface is deleted when the instance is terminated. - deviceIndex: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The index of the device on the instance for the network interface attachment. - status: - allOf: - - $ref: '#/components/schemas/AttachmentStatus' - - description: The attachment state. - networkCardIndex: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The index of the network card. - description: Describes a network interface attachment. - InstancePrivateIpAddressList: - type: array - items: - allOf: - - $ref: '#/components/schemas/InstancePrivateIpAddress' - - xml: - name: item - NetworkInterfaceStatus: - type: string - enum: - - available - - associated - - attaching - - in-use - - detaching - InstanceNetworkInterface: - type: object - properties: - association: - allOf: - - $ref: '#/components/schemas/InstanceNetworkInterfaceAssociation' - - description: The association information for an Elastic IPv4 associated with the network interface. - attachment: - allOf: - - $ref: '#/components/schemas/InstanceNetworkInterfaceAttachment' - - description: The network interface attachment. - description: - allOf: - - $ref: '#/components/schemas/String' - - description: The description. - groupSet: - allOf: - - $ref: '#/components/schemas/GroupIdentifierList' - - description: One or more security groups. - ipv6AddressesSet: - allOf: - - $ref: '#/components/schemas/InstanceIpv6AddressList' - - description: One or more IPv6 addresses associated with the network interface. - macAddress: - allOf: - - $ref: '#/components/schemas/String' - - description: The MAC address. - networkInterfaceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the network interface. - ownerId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Amazon Web Services account that created the network interface. - privateDnsName: - allOf: - - $ref: '#/components/schemas/String' - - description: The private DNS name. - privateIpAddress: - allOf: - - $ref: '#/components/schemas/String' - - description: The IPv4 address of the network interface within the subnet. - privateIpAddressesSet: - allOf: - - $ref: '#/components/schemas/InstancePrivateIpAddressList' - - description: One or more private IPv4 addresses associated with the network interface. - sourceDestCheck: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether source/destination checking is enabled. - status: - allOf: - - $ref: '#/components/schemas/NetworkInterfaceStatus' - - description: The status of the network interface. - subnetId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the subnet. - vpcId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the VPC. - interfaceType: - allOf: - - $ref: '#/components/schemas/String' - - description: '

The type of network interface.

Valid values: interface | efa | trunk

' - ipv4PrefixSet: - allOf: - - $ref: '#/components/schemas/InstanceIpv4PrefixList' - - description: The IPv4 delegated prefixes that are assigned to the network interface. - ipv6PrefixSet: - allOf: - - $ref: '#/components/schemas/InstanceIpv6PrefixList' - - description: The IPv6 delegated prefixes that are assigned to the network interface. - description: Describes a network interface. - InstancePrivateIpAddress: - type: object - properties: - association: - allOf: - - $ref: '#/components/schemas/InstanceNetworkInterfaceAssociation' - - description: The association information for an Elastic IP address for the network interface. - primary: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether this IPv4 address is the primary private IP address of the network interface. - privateDnsName: - allOf: - - $ref: '#/components/schemas/String' - - description: The private IPv4 DNS name. - privateIpAddress: - allOf: - - $ref: '#/components/schemas/String' - - description: The private IPv4 address of the network interface. - description: Describes a private IPv4 address. - VCpuCountRange: - type: object - properties: - min: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The minimum number of vCPUs. If the value is 0, there is no minimum limit.' - max: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The maximum number of vCPUs. If this parameter is not specified, there is no maximum limit.' - description: The minimum and maximum number of vCPUs. - MemoryMiB: - type: object - properties: - min: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The minimum amount of memory, in MiB. If this parameter is not specified, there is no minimum limit.' - max: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The maximum amount of memory, in MiB. If this parameter is not specified, there is no maximum limit.' - description: 'The minimum and maximum amount of memory, in MiB.' - MemoryGiBPerVCpu: - type: object - properties: - min: - allOf: - - $ref: '#/components/schemas/Double' - - description: 'The minimum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no minimum limit.' - max: - allOf: - - $ref: '#/components/schemas/Double' - - description: 'The maximum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no maximum limit.' - description: '

The minimum and maximum amount of memory per vCPU, in GiB.

' - NetworkInterfaceCount: - type: object - properties: - min: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The minimum number of network interfaces. If this parameter is not specified, there is no minimum limit.' - max: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The maximum number of network interfaces. If this parameter is not specified, there is no maximum limit.' - description: The minimum and maximum number of network interfaces. - LocalStorageTypeSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/LocalStorageType' - - xml: - name: item - TotalLocalStorageGB: - type: object - properties: - min: - allOf: - - $ref: '#/components/schemas/Double' - - description: 'The minimum amount of total local storage, in GB. If this parameter is not specified, there is no minimum limit.' - max: - allOf: - - $ref: '#/components/schemas/Double' - - description: 'The maximum amount of total local storage, in GB. If this parameter is not specified, there is no maximum limit.' - description: 'The minimum and maximum amount of total local storage, in GB.' - InstanceRequirementsWithMetadataRequest: - type: object - properties: - ArchitectureType: - allOf: - - $ref: '#/components/schemas/ArchitectureTypeSet' - - description: The architecture type. - VirtualizationType: - allOf: - - $ref: '#/components/schemas/InstanceRequirementsRequest' - - description: 'The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.' - description: '

The architecture type, virtualization type, and other attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.

If you specify InstanceRequirementsWithMetadataRequest, you can''t specify InstanceTypes.

' - InstanceSpecification: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Excludes the root volume from being snapshotted. - description: The instance details to specify which volumes should be snapshotted. - InstanceStateName: - type: string - enum: - - pending - - running - - shutting-down - - terminated - - stopping - - stopped - InstanceStateChange: - type: object - properties: - currentState: - allOf: - - $ref: '#/components/schemas/InstanceState' - - description: The current state of the instance. - instanceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the instance. - previousState: - allOf: - - $ref: '#/components/schemas/InstanceState' - - description: The previous state of the instance. - description: Describes an instance state change. - InstanceStateChangeList: - type: array - items: - allOf: - - $ref: '#/components/schemas/InstanceStateChange' - - xml: - name: item - InstanceStatusEventList: - type: array - items: - allOf: - - $ref: '#/components/schemas/InstanceStatusEvent' - - xml: - name: item - InstanceStatusSummary: - type: object - properties: - details: - allOf: - - $ref: '#/components/schemas/InstanceStatusDetailsList' - - description: The system instance health or application instance health. - status: - allOf: - - $ref: '#/components/schemas/SummaryStatus' - - description: The status. - description: Describes the status of an instance. - InstanceStatus: - type: object - properties: - availabilityZone: - allOf: - - $ref: '#/components/schemas/String' - - description: The Availability Zone of the instance. - outpostArn: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Resource Name (ARN) of the Outpost. - eventsSet: - allOf: - - $ref: '#/components/schemas/InstanceStatusEventList' - - description: Any scheduled events associated with the instance. - instanceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the instance. - instanceState: - allOf: - - $ref: '#/components/schemas/InstanceState' - - description: The intended state of the instance. DescribeInstanceStatus requires that an instance be in the running state. - instanceStatus: - allOf: - - $ref: '#/components/schemas/InstanceStatusSummary' - - description: 'Reports impaired functionality that stems from issues internal to the instance, such as impaired reachability.' - systemStatus: - allOf: - - $ref: '#/components/schemas/InstanceStatusSummary' - - description: 'Reports impaired functionality that stems from issues related to the systems that support an instance, such as hardware failures and network connectivity problems.' - description: Describes the status of an instance. - StatusName: - type: string - enum: - - reachability - StatusType: - type: string - enum: - - passed - - failed - - insufficient-data - - initializing - InstanceStatusDetails: - type: object - properties: - impairedSince: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: 'The time when a status check failed. For an instance that was launched and impaired, this is the time when the instance was launched.' - name: - allOf: - - $ref: '#/components/schemas/StatusName' - - description: The type of instance status. - status: - allOf: - - $ref: '#/components/schemas/StatusType' - - description: The status. - description: Describes the instance status. - InstanceStatusDetailsList: - type: array - items: - allOf: - - $ref: '#/components/schemas/InstanceStatusDetails' - - xml: - name: item - InstanceStatusEvent: - type: object - properties: - instanceEventId: - allOf: - - $ref: '#/components/schemas/InstanceEventId' - - description: The ID of the event. - code: - allOf: - - $ref: '#/components/schemas/EventCode' - - description: The event code. - description: - allOf: - - $ref: '#/components/schemas/String' - - description: '

A description of the event.

After a scheduled event is completed, it can still be described for up to a week. If the event has been completed, this description starts with the following text: [Completed].

' - notAfter: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The latest scheduled end time for the event. - notBefore: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The earliest scheduled start time for the event. - notBeforeDeadline: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The deadline for starting the event. - description: Describes a scheduled event for an instance. - SummaryStatus: - type: string - enum: - - ok - - impaired - - insufficient-data - - not-applicable - - initializing - InstanceStorageEncryptionSupport: - type: string - enum: - - unsupported - - required - InstanceStorageFlag: - type: boolean - InstanceStorageInfo: - type: object - properties: - totalSizeInGB: - allOf: - - $ref: '#/components/schemas/DiskSize' - - description: 'The total size of the disks, in GB.' - disks: - allOf: - - $ref: '#/components/schemas/DiskInfoList' - - description: Describes the disks that are available for the instance type. - nvmeSupport: - allOf: - - $ref: '#/components/schemas/EphemeralNvmeSupport' - - description: Indicates whether non-volatile memory express (NVMe) is supported. - encryptionSupport: - allOf: - - $ref: '#/components/schemas/InstanceStorageEncryptionSupport' - - description: Indicates whether data is encrypted at rest. - description: Describes the instance store features that are supported by the instance type. - InstanceTypeHypervisor: - type: string - enum: - - nitro - - xen - UsageClassTypeList: - type: array - items: - allOf: - - $ref: '#/components/schemas/UsageClassType' - - xml: - name: item - RootDeviceTypeList: - type: array - items: - allOf: - - $ref: '#/components/schemas/RootDeviceType' - - xml: - name: item - VirtualizationTypeList: - type: array - items: - allOf: - - $ref: '#/components/schemas/VirtualizationType' - - xml: - name: item - ProcessorInfo: - type: object - properties: - supportedArchitectures: - allOf: - - $ref: '#/components/schemas/ArchitectureTypeList' - - description: The architectures supported by the instance type. - sustainedClockSpeedInGhz: - allOf: - - $ref: '#/components/schemas/ProcessorSustainedClockSpeed' - - description: 'The speed of the processor, in GHz.' - description: Describes the processor used by the instance type. - VCpuInfo: - type: object - properties: - defaultVCpus: - allOf: - - $ref: '#/components/schemas/VCpuCount' - - description: The default number of vCPUs for the instance type. - defaultCores: - allOf: - - $ref: '#/components/schemas/CoreCount' - - description: The default number of cores for the instance type. - defaultThreadsPerCore: - allOf: - - $ref: '#/components/schemas/ThreadsPerCore' - - description: The default number of threads per core for the instance type. - validCores: - allOf: - - $ref: '#/components/schemas/CoreCountList' - - description: The valid number of cores that can be configured for the instance type. - validThreadsPerCore: - allOf: - - $ref: '#/components/schemas/ThreadsPerCoreList' - - description: 'The valid number of threads per core that can be configured for the instance type. ' - description: Describes the vCPU configurations for the instance type. - MemoryInfo: - type: object - properties: - sizeInMiB: - allOf: - - $ref: '#/components/schemas/MemorySize' - - description: 'The size of the memory, in MiB.' - description: Describes the memory for the instance type. - NetworkInfo: - type: object - properties: - networkPerformance: - allOf: - - $ref: '#/components/schemas/NetworkPerformance' - - description: The network performance. - maximumNetworkInterfaces: - allOf: - - $ref: '#/components/schemas/MaxNetworkInterfaces' - - description: The maximum number of network interfaces for the instance type. - maximumNetworkCards: - allOf: - - $ref: '#/components/schemas/MaximumNetworkCards' - - description: The maximum number of physical network cards that can be allocated to the instance. - defaultNetworkCardIndex: - allOf: - - $ref: '#/components/schemas/DefaultNetworkCardIndex' - - description: 'The index of the default network card, starting at 0.' - networkCards: - allOf: - - $ref: '#/components/schemas/NetworkCardInfoList' - - description: Describes the network cards for the instance type. - ipv4AddressesPerInterface: - allOf: - - $ref: '#/components/schemas/MaxIpv4AddrPerInterface' - - description: The maximum number of IPv4 addresses per network interface. - ipv6AddressesPerInterface: - allOf: - - $ref: '#/components/schemas/MaxIpv6AddrPerInterface' - - description: The maximum number of IPv6 addresses per network interface. - ipv6Supported: - allOf: - - $ref: '#/components/schemas/Ipv6Flag' - - description: Indicates whether IPv6 is supported. - enaSupport: - allOf: - - $ref: '#/components/schemas/EnaSupport' - - description: Indicates whether Elastic Network Adapter (ENA) is supported. - efaSupported: - allOf: - - $ref: '#/components/schemas/EfaSupportedFlag' - - description: Indicates whether Elastic Fabric Adapter (EFA) is supported. - efaInfo: - allOf: - - $ref: '#/components/schemas/EfaInfo' - - description: Describes the Elastic Fabric Adapters for the instance type. - encryptionInTransitSupported: - allOf: - - $ref: '#/components/schemas/EncryptionInTransitSupported' - - description: Indicates whether the instance type automatically encrypts in-transit traffic between instances. - description: Describes the networking features of the instance type. - PlacementGroupInfo: - type: object - properties: - supportedStrategies: - allOf: - - $ref: '#/components/schemas/PlacementGroupStrategyList' - - description: The supported placement group types. - description: Describes the placement group support of the instance type. - InstanceTypeInfo: - type: object - properties: - instanceType: - allOf: - - $ref: '#/components/schemas/InstanceType' - - description: 'The instance type. For more information, see Instance types in the Amazon EC2 User Guide.' - currentGeneration: - allOf: - - $ref: '#/components/schemas/CurrentGenerationFlag' - - description: Indicates whether the instance type is current generation. - freeTierEligible: - allOf: - - $ref: '#/components/schemas/FreeTierEligibleFlag' - - description: Indicates whether the instance type is eligible for the free tier. - supportedUsageClasses: - allOf: - - $ref: '#/components/schemas/UsageClassTypeList' - - description: Indicates whether the instance type is offered for spot or On-Demand. - supportedRootDeviceTypes: - allOf: - - $ref: '#/components/schemas/RootDeviceTypeList' - - description: The supported root device types. - supportedVirtualizationTypes: - allOf: - - $ref: '#/components/schemas/VirtualizationTypeList' - - description: The supported virtualization types. - bareMetal: - allOf: - - $ref: '#/components/schemas/BareMetalFlag' - - description: Indicates whether the instance is a bare metal instance type. - hypervisor: - allOf: - - $ref: '#/components/schemas/InstanceTypeHypervisor' - - description: The hypervisor for the instance type. - processorInfo: - allOf: - - $ref: '#/components/schemas/ProcessorInfo' - - description: Describes the processor. - vCpuInfo: - allOf: - - $ref: '#/components/schemas/VCpuInfo' - - description: Describes the vCPU configurations for the instance type. - memoryInfo: - allOf: - - $ref: '#/components/schemas/MemoryInfo' - - description: Describes the memory for the instance type. - instanceStorageSupported: - allOf: - - $ref: '#/components/schemas/InstanceStorageFlag' - - description: Indicates whether instance storage is supported. - instanceStorageInfo: - allOf: - - $ref: '#/components/schemas/InstanceStorageInfo' - - description: Describes the instance storage for the instance type. - ebsInfo: - allOf: - - $ref: '#/components/schemas/EbsInfo' - - description: Describes the Amazon EBS settings for the instance type. - networkInfo: - allOf: - - $ref: '#/components/schemas/NetworkInfo' - - description: Describes the network settings for the instance type. - gpuInfo: - allOf: - - $ref: '#/components/schemas/GpuInfo' - - description: Describes the GPU accelerator settings for the instance type. - fpgaInfo: - allOf: - - $ref: '#/components/schemas/FpgaInfo' - - description: Describes the FPGA accelerator settings for the instance type. - placementGroupInfo: - allOf: - - $ref: '#/components/schemas/PlacementGroupInfo' - - description: Describes the placement group settings for the instance type. - inferenceAcceleratorInfo: - allOf: - - $ref: '#/components/schemas/InferenceAcceleratorInfo' - - description: Describes the Inference accelerator settings for the instance type. - hibernationSupported: - allOf: - - $ref: '#/components/schemas/HibernationFlag' - - description: Indicates whether On-Demand hibernation is supported. - burstablePerformanceSupported: - allOf: - - $ref: '#/components/schemas/BurstablePerformanceFlag' - - description: Indicates whether the instance type is a burstable performance instance type. - dedicatedHostsSupported: - allOf: - - $ref: '#/components/schemas/DedicatedHostFlag' - - description: Indicates whether Dedicated Hosts are supported on the instance type. - autoRecoverySupported: - allOf: - - $ref: '#/components/schemas/AutoRecoveryFlag' - - description: Indicates whether auto recovery is supported. - supportedBootModes: - allOf: - - $ref: '#/components/schemas/BootModeTypeList' - - description: 'The supported boot modes. For more information, see Boot modes in the Amazon EC2 User Guide.' - description: Describes the instance type. - InstanceTypeInfoFromInstanceRequirements: - type: object - properties: - instanceType: - allOf: - - $ref: '#/components/schemas/String' - - description: The matching instance type. - description: The list of instance types with the specified instance attributes. - Location: - type: string - InstanceTypeOffering: - type: object - properties: - instanceType: - allOf: - - $ref: '#/components/schemas/InstanceType' - - description: 'The instance type. For more information, see Instance types in the Amazon EC2 User Guide.' - locationType: - allOf: - - $ref: '#/components/schemas/LocationType' - - description: The location type. - location: - allOf: - - $ref: '#/components/schemas/Location' - - description: 'The identifier for the location. This depends on the location type. For example, if the location type is region, the location is the Region code (for example, us-east-2.)' - description: The instance types offered. - InstanceTypes: - type: array - items: - $ref: '#/components/schemas/String' - minItems: 0 - maxItems: 1000 - InstanceUsage: - type: object - properties: - accountId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Amazon Web Services account that is making use of the Capacity Reservation. - usedInstanceCount: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The number of instances the Amazon Web Services account currently has in the Capacity Reservation. - description: Information about the Capacity Reservation usage. - InterfacePermissionType: - type: string - enum: - - INSTANCE-ATTACH - - EIP-ASSOCIATE - InterfaceProtocolType: - type: string - enum: - - VLAN - - GRE - InternetGatewayAttachment: - type: object - properties: - state: - allOf: - - $ref: '#/components/schemas/AttachmentStatus' - - description: 'The current state of the attachment. For an internet gateway, the state is available when attached to a VPC; otherwise, this value is not returned.' - vpcId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the VPC. - description: Describes the attachment of a VPC to an internet gateway or an egress-only internet gateway. - InternetGatewayIdList: - type: array - items: - allOf: - - $ref: '#/components/schemas/InternetGatewayId' - - xml: - name: item - IpAddressType: - type: string - enum: - - ipv4 - - dualstack - - ipv6 - IpRangeList: - type: array - items: - allOf: - - $ref: '#/components/schemas/IpRange' - - xml: - name: item - Ipv6RangeList: - type: array - items: - allOf: - - $ref: '#/components/schemas/Ipv6Range' - - xml: - name: item - PrefixListIdList: - type: array - items: - allOf: - - $ref: '#/components/schemas/PrefixListId' - - xml: - name: item - UserIdGroupPairList: - type: array - items: - allOf: - - $ref: '#/components/schemas/UserIdGroupPair' - - xml: - name: item - IpRange: - type: object - properties: - cidrIp: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The IPv4 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length.' - description: - allOf: - - $ref: '#/components/schemas/String' - - description: '

A description for the security group rule that references this IPv4 address range.

Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*

' - description: Describes an IPv4 range. - IpRanges: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - IpamId: - type: string - IpamOperatingRegionSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/IpamOperatingRegion' - - xml: - name: item - IpamState: - type: string - enum: - - create-in-progress - - create-complete - - create-failed - - modify-in-progress - - modify-complete - - modify-failed - - delete-in-progress - - delete-complete - - delete-failed - - isolate-in-progress - - isolate-complete - - restore-in-progress - IpamAddressHistoryMaxResults: - type: integer - minimum: 1 - maximum: 1000 - IpamAddressHistoryResourceType: - type: string - enum: - - eip - - vpc - - subnet - - network-interface - - instance - IpamComplianceStatus: - type: string - enum: - - compliant - - noncompliant - - unmanaged - - ignored - IpamOverlapStatus: - type: string - enum: - - overlapping - - nonoverlapping - - ignored - IpamAddressHistoryRecord: - type: object - properties: - resourceOwnerId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the resource owner. - resourceRegion: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Web Services Region of the resource. - resourceType: - allOf: - - $ref: '#/components/schemas/IpamAddressHistoryResourceType' - - description: The type of the resource. - resourceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the resource. - resourceCidr: - allOf: - - $ref: '#/components/schemas/String' - - description: The CIDR of the resource. - resourceName: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of the resource. - resourceComplianceStatus: - allOf: - - $ref: '#/components/schemas/IpamComplianceStatus' - - description: 'The compliance status of a resource. For more information on compliance statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.' - resourceOverlapStatus: - allOf: - - $ref: '#/components/schemas/IpamOverlapStatus' - - description: 'The overlap status of an IPAM resource. The overlap status tells you if the CIDR for a resource overlaps with another CIDR in the scope. For more information on overlap statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.' - vpcId: - allOf: - - $ref: '#/components/schemas/String' - - description: The VPC ID of the resource. - sampledStartTime: - allOf: - - $ref: '#/components/schemas/MillisecondDateTime' - - description: 'Sampled start time of the resource-to-CIDR association within the IPAM scope. Changes are picked up in periodic snapshots, so the start time may have occurred before this specific time.' - sampledEndTime: - allOf: - - $ref: '#/components/schemas/MillisecondDateTime' - - description: 'Sampled end time of the resource-to-CIDR association within the IPAM scope. Changes are picked up in periodic snapshots, so the end time may have occurred before this specific time.' - description: 'The historical record of a CIDR within an IPAM scope. For more information, see View the history of IP addresses in the Amazon VPC IPAM User Guide. ' - IpamCidrAuthorizationContext: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The signed authorization message for the prefix and account. - description: A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP. - IpamManagementState: - type: string - enum: - - managed - - unmanaged - - ignored - IpamMaxResults: - type: integer - minimum: 5 - maximum: 1000 - IpamOperatingRegion: - type: object - properties: - regionName: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of the operating Region. - description: '

The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.

' - IpamScopeType: - type: string - enum: - - public - - private - IpamPoolState: - type: string - enum: - - create-in-progress - - create-complete - - create-failed - - modify-in-progress - - modify-complete - - modify-failed - - delete-in-progress - - delete-complete - - delete-failed - - isolate-in-progress - - isolate-complete - - restore-in-progress - IpamResourceTagList: - type: array - items: - allOf: - - $ref: '#/components/schemas/IpamResourceTag' - - xml: - name: item - IpamPoolAllocationResourceType: - type: string - enum: - - ipam-pool - - vpc - - ec2-public-ipv4-pool - - custom - IpamPoolCidrState: - type: string - enum: - - pending-provision - - provisioned - - failed-provision - - pending-deprovision - - deprovisioned - - failed-deprovision - - pending-import - - failed-import - IpamPoolCidrFailureReason: - type: object - properties: - code: - allOf: - - $ref: '#/components/schemas/IpamPoolCidrFailureCode' - - description: An error code related to why an IPAM pool CIDR failed to be provisioned. - message: - allOf: - - $ref: '#/components/schemas/String' - - description: A message related to why an IPAM pool CIDR failed to be provisioned. - description: Details related to why an IPAM pool CIDR failed to be provisioned. - IpamPoolCidrFailureCode: - type: string - enum: - - cidr-not-available - IpamResourceType: - type: string - enum: - - vpc - - subnet - - eip - - public-ipv4-pool - - ipv6-pool - IpamResourceCidr: - type: object - properties: - ipamId: - allOf: - - $ref: '#/components/schemas/IpamId' - - description: The IPAM ID for an IPAM resource. - ipamScopeId: - allOf: - - $ref: '#/components/schemas/IpamScopeId' - - description: The scope ID for an IPAM resource. - ipamPoolId: - allOf: - - $ref: '#/components/schemas/IpamPoolId' - - description: The pool ID for an IPAM resource. - resourceRegion: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Web Services Region for an IPAM resource. - resourceOwnerId: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Web Services account number of the owner of an IPAM resource. - resourceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of an IPAM resource. - resourceName: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of an IPAM resource. - resourceCidr: - allOf: - - $ref: '#/components/schemas/String' - - description: The CIDR for an IPAM resource. - resourceType: - allOf: - - $ref: '#/components/schemas/IpamResourceType' - - description: The type of IPAM resource. - resourceTagSet: - allOf: - - $ref: '#/components/schemas/IpamResourceTagList' - - description: The tags for an IPAM resource. - ipUsage: - allOf: - - $ref: '#/components/schemas/BoxedDouble' - - description: 'The IP address space in the IPAM pool that is allocated to this resource. To convert the decimal to a percentage, multiply the decimal by 100.' - complianceStatus: - allOf: - - $ref: '#/components/schemas/IpamComplianceStatus' - - description: 'The compliance status of the IPAM resource. For more information on compliance statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.' - managementState: - allOf: - - $ref: '#/components/schemas/IpamManagementState' - - description: 'The management state of the resource. For more information about management states, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.' - overlapStatus: - allOf: - - $ref: '#/components/schemas/IpamOverlapStatus' - - description: 'The overlap status of an IPAM resource. The overlap status tells you if the CIDR for a resource overlaps with another CIDR in the scope. For more information on overlap statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.' - vpcId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of a VPC. - description: The CIDR for an IPAM resource. - IpamResourceTag: - type: object - properties: - key: - allOf: - - $ref: '#/components/schemas/String' - - description: '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.' - value: - allOf: - - $ref: '#/components/schemas/String' - - description: The value of the tag. - description: '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. 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.' - IpamScopeState: - type: string - enum: - - create-in-progress - - create-complete - - create-failed - - modify-in-progress - - modify-complete - - modify-failed - - delete-in-progress - - delete-complete - - delete-failed - - isolate-in-progress - - isolate-complete - - restore-in-progress - Ipv4PrefixList: - type: array - items: - allOf: - - $ref: '#/components/schemas/Ipv4PrefixSpecificationRequest' - - xml: - name: item - Ipv4PrefixSpecificationResponse: - type: object - properties: - ipv4Prefix: - allOf: - - $ref: '#/components/schemas/String' - - description: One or more IPv4 delegated prefixes assigned to the network interface. - description: Information about the IPv4 delegated prefixes assigned to a network interface. - Ipv4PrefixListResponse: - type: array - items: - allOf: - - $ref: '#/components/schemas/Ipv4PrefixSpecificationResponse' - - xml: - name: item - Ipv4PrefixSpecification: - type: object - properties: - ipv4Prefix: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The IPv4 prefix. For information, see Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.' - description: Describes an IPv4 prefix. - Ipv6Address: - type: string - Ipv6CidrAssociation: - type: object - properties: - ipv6Cidr: - allOf: - - $ref: '#/components/schemas/String' - - description: The IPv6 CIDR block. - associatedResource: - allOf: - - $ref: '#/components/schemas/String' - - description: The resource that's associated with the IPv6 CIDR block. - description: Describes an IPv6 CIDR block association. - Ipv6CidrBlock: - type: object - properties: - ipv6CidrBlock: - allOf: - - $ref: '#/components/schemas/String' - - description: The IPv6 CIDR block. - description: Describes an IPv6 CIDR block. - Ipv6CidrBlockSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/Ipv6CidrBlock' - - xml: - name: item - Ipv6Flag: - type: boolean - PoolCidrBlocksSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/PoolCidrBlock' - - xml: - name: item - Ipv6Pool: - type: object - properties: - poolId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the address pool. - description: - allOf: - - $ref: '#/components/schemas/String' - - description: The description for the address pool. - poolCidrBlockSet: - allOf: - - $ref: '#/components/schemas/PoolCidrBlocksSet' - - description: The CIDR blocks for the address pool. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: Any tags for the address pool. - description: Describes an IPv6 address pool. - Ipv6PoolIdList: - type: array - items: - allOf: - - $ref: '#/components/schemas/Ipv6PoolEc2Id' - - xml: - name: item - Ipv6PoolMaxResults: - type: integer - minimum: 1 - maximum: 1000 - Ipv6PrefixList: - type: array - items: - allOf: - - $ref: '#/components/schemas/Ipv6PrefixSpecificationRequest' - - xml: - name: item - Ipv6PrefixSpecificationResponse: - type: object - properties: - ipv6Prefix: - allOf: - - $ref: '#/components/schemas/String' - - description: One or more IPv6 delegated prefixes assigned to the network interface. - description: Information about the IPv6 delegated prefixes assigned to a network interface. - Ipv6PrefixListResponse: - type: array - items: - allOf: - - $ref: '#/components/schemas/Ipv6PrefixSpecificationResponse' - - xml: - name: item - Ipv6PrefixSpecification: - type: object - properties: - ipv6Prefix: - allOf: - - $ref: '#/components/schemas/String' - - description: The IPv6 prefix. - description: Describes the IPv6 prefix. - Ipv6PrefixesList: - type: array - items: - allOf: - - $ref: '#/components/schemas/Ipv6PrefixSpecification' - - xml: - name: item - Ipv6Range: - type: object - properties: - cidrIpv6: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The IPv6 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv6 address, use the /128 prefix length.' - description: - allOf: - - $ref: '#/components/schemas/String' - - description: '

A description for the security group rule that references this IPv6 address range.

Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*

' - description: '[EC2-VPC only] Describes an IPv6 range.' - Ipv6SupportValue: - type: string - enum: - - enable - - disable - SensitiveUserData: - type: string - format: password - KeyPairInfo: - type: object - properties: - keyPairId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the key pair. - keyFingerprint: - allOf: - - $ref: '#/components/schemas/String' - - description: '

If you used CreateKeyPair to create the key pair:

  • For RSA key pairs, the key fingerprint is the SHA-1 digest of the DER encoded private key.

  • For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8.

If you used ImportKeyPair to provide Amazon Web Services the public key:

  • For RSA key pairs, the key fingerprint is the MD5 public key fingerprint as specified in section 4 of RFC4716.

  • For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8.

' - keyName: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of the key pair. - keyType: - allOf: - - $ref: '#/components/schemas/KeyType' - - description: The type of key pair. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: Any tags applied to the key pair. - publicKey: - allOf: - - $ref: '#/components/schemas/String' - - description: The public key material. - createTime: - allOf: - - $ref: '#/components/schemas/MillisecondDateTime' - - description: '

If you used Amazon EC2 to create the key pair, this is the date and time when the key was created, in ISO 8601 date-time format, in the UTC time zone.

If you imported an existing key pair to Amazon EC2, this is the date and time the key was imported, in ISO 8601 date-time format, in the UTC time zone.

' - description: Describes a key pair. - LastError: - type: object - properties: - message: - allOf: - - $ref: '#/components/schemas/String' - - description: The error message for the VPC endpoint error. - code: - allOf: - - $ref: '#/components/schemas/String' - - description: The error code for the VPC endpoint error. - description: The last error that occurred for a VPC endpoint. - LaunchPermission: - type: object - properties: - group: - allOf: - - $ref: '#/components/schemas/PermissionGroup' - - description: The name of the group. - userId: - allOf: - - $ref: '#/components/schemas/String' - - description: '

The Amazon Web Services account ID.

Constraints: Up to 10 000 account IDs can be specified in a single request.

' - organizationArn: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Resource Name (ARN) of an organization. - organizationalUnitArn: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Resource Name (ARN) of an organizational unit (OU). - description: Describes a launch permission. - LaunchPermissionModifications: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/LaunchPermissionList' - - description: 'The Amazon Web Services account ID, organization ARN, or OU ARN to remove from the list of launch permissions for the AMI.' - description: Describes a launch permission modification. - LaunchSpecification: - type: object - properties: - userData: - allOf: - - $ref: '#/components/schemas/String' - - description: The Base64-encoded user data for the instance. - groupSet: - allOf: - - $ref: '#/components/schemas/GroupIdentifierList' - - description: 'One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.' - addressingType: - allOf: - - $ref: '#/components/schemas/String' - - description: Deprecated. - blockDeviceMapping: - allOf: - - $ref: '#/components/schemas/BlockDeviceMappingList' - - description: One or more block device mapping entries. - ebsOptimized: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: '

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn''t available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

Default: false

' - iamInstanceProfile: - allOf: - - $ref: '#/components/schemas/IamInstanceProfileSpecification' - - description: The IAM instance profile. - imageId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the AMI. - instanceType: - allOf: - - $ref: '#/components/schemas/InstanceType' - - description: The instance type. Only one instance type can be specified. - kernelId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the kernel. - keyName: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of the key pair. - networkInterfaceSet: - allOf: - - $ref: '#/components/schemas/InstanceNetworkInterfaceSpecificationList' - - description: 'One or more network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface.' - placement: - allOf: - - $ref: '#/components/schemas/SpotPlacement' - - description: The placement information for the instance. - ramdiskId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the RAM disk. - subnetId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the subnet in which to launch the instance. - monitoring: - $ref: '#/components/schemas/RunInstancesMonitoringEnabled' - description: Describes the launch specification for an instance. - SpotFleetLaunchSpecification: - type: object - properties: - groupSet: - allOf: - - $ref: '#/components/schemas/GroupIdentifierList' - - description: 'One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.' - addressingType: - allOf: - - $ref: '#/components/schemas/String' - - description: Deprecated. - blockDeviceMapping: - allOf: - - $ref: '#/components/schemas/BlockDeviceMappingList' - - description: 'One or more block devices that are mapped to the Spot Instances. You can''t specify both a snapshot ID and an encryption value. This is because only blank volumes can be encrypted on creation. If a snapshot is the basis for a volume, it is not blank and its encryption status is used for the volume encryption status.' - ebsOptimized: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: '

Indicates whether the instances are optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn''t available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

Default: false

' - iamInstanceProfile: - allOf: - - $ref: '#/components/schemas/IamInstanceProfileSpecification' - - description: The IAM instance profile. - imageId: - allOf: - - $ref: '#/components/schemas/ImageId' - - description: The ID of the AMI. - instanceType: - allOf: - - $ref: '#/components/schemas/InstanceType' - - description: The instance type. - kernelId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the kernel. - keyName: - allOf: - - $ref: '#/components/schemas/KeyPairName' - - description: The name of the key pair. - monitoring: - allOf: - - $ref: '#/components/schemas/SpotFleetMonitoring' - - description: Enable or disable monitoring for the instances. - networkInterfaceSet: - allOf: - - $ref: '#/components/schemas/InstanceNetworkInterfaceSpecificationList' - - description: '

One or more network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface.

SpotFleetLaunchSpecification currently does not support Elastic Fabric Adapter (EFA). To specify an EFA, you must use LaunchTemplateConfig.

' - placement: - allOf: - - $ref: '#/components/schemas/SpotPlacement' - - description: The placement information. - ramdiskId: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The ID of the RAM disk. Some kernels require additional drivers at launch. Check the kernel requirements for information about whether you need to specify a RAM disk. To find kernel requirements, refer to the Amazon Web Services Resource Center and search for the kernel ID.' - spotPrice: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The maximum price per unit hour that you are willing to pay for a Spot Instance. If this value is not specified, the default is the Spot price specified for the fleet. To determine the Spot price per unit hour, divide the Spot price by the value of WeightedCapacity.' - subnetId: - allOf: - - $ref: '#/components/schemas/SubnetId' - - description: 'The IDs of the subnets in which to launch the instances. To specify multiple subnets, separate them using commas; for example, "subnet-1234abcdeexample1, subnet-0987cdef6example2".' - userData: - allOf: - - $ref: '#/components/schemas/String' - - description: The Base64-encoded user data that instances use when starting up. - weightedCapacity: - allOf: - - $ref: '#/components/schemas/Double' - - description: '

The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms of instances, or a performance characteristic such as vCPUs, memory, or I/O.

If the target capacity divided by this value is not a whole number, Amazon EC2 rounds the number of instances to the next whole number. If this value is not specified, the default is 1.

' - tagSpecificationSet: - allOf: - - $ref: '#/components/schemas/SpotFleetTagSpecificationList' - - description: The tags to apply during creation. - instanceRequirements: - allOf: - - $ref: '#/components/schemas/InstanceRequirements' - - description: '

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.

If you specify InstanceRequirements, you can''t specify InstanceTypes.

' - description: 'Describes the launch specification for one or more Spot Instances. If you include On-Demand capacity in your fleet request or want to specify an EFA network device, you can''t use SpotFleetLaunchSpecification; you must use LaunchTemplateConfig.' - LaunchTemplateAutoRecoveryState: - type: string - enum: - - default - - disabled - LaunchTemplateEbsBlockDevice: - type: object - properties: - encrypted: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether the EBS volume is encrypted. - deleteOnTermination: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether the EBS volume is deleted on instance termination. - iops: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The number of I/O operations per second (IOPS) that the volume supports. ' - kmsKeyId: - allOf: - - $ref: '#/components/schemas/KmsKeyId' - - description: The ARN of the Key Management Service (KMS) CMK used for encryption. - snapshotId: - allOf: - - $ref: '#/components/schemas/SnapshotId' - - description: The ID of the snapshot. - volumeSize: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The size of the volume, in GiB.' - volumeType: - allOf: - - $ref: '#/components/schemas/VolumeType' - - description: The volume type. - throughput: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The throughput that the volume supports, in MiB/s.' - description: Describes a block device for an EBS volume. - LaunchTemplateBlockDeviceMapping: - type: object - properties: - deviceName: - allOf: - - $ref: '#/components/schemas/String' - - description: The device name. - virtualName: - allOf: - - $ref: '#/components/schemas/String' - - description: The virtual device name (ephemeralN). - ebs: - allOf: - - $ref: '#/components/schemas/LaunchTemplateEbsBlockDevice' - - description: Information about the block device for an EBS volume. - noDevice: - allOf: - - $ref: '#/components/schemas/String' - - description: 'To omit the device from the block device mapping, specify an empty string.' - description: Describes a block device mapping. - LaunchTemplateBlockDeviceMappingList: - type: array - items: - allOf: - - $ref: '#/components/schemas/LaunchTemplateBlockDeviceMapping' - - xml: - name: item - LaunchTemplateBlockDeviceMappingRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: 'To omit the device from the block device mapping, specify an empty string.' - description: Describes a block device mapping. - LaunchTemplateCapacityReservationSpecificationResponse: - type: object - properties: - capacityReservationPreference: - allOf: - - $ref: '#/components/schemas/CapacityReservationPreference' - - description: '

Indicates the instance''s Capacity Reservation preferences. Possible preferences include:

  • open - The instance can run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).

  • none - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity.

' - capacityReservationTarget: - allOf: - - $ref: '#/components/schemas/CapacityReservationTargetResponse' - - description: Information about the target Capacity Reservation or Capacity Reservation group. - description: Information about the Capacity Reservation targeting option. - LaunchTemplateOverridesList: - type: array - items: - allOf: - - $ref: '#/components/schemas/LaunchTemplateOverrides' - - xml: - name: item - LaunchTemplateCpuOptions: - type: object - properties: - coreCount: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The number of CPU cores for the instance. - threadsPerCore: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The number of threads per CPU core. - description: The CPU options for the instance. - LaunchTemplateCpuOptionsRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The number of threads per CPU core. To disable multithreading for the instance, specify a value of 1. Otherwise, specify the default value of 2.' - description: The CPU options for the instance. Both the core count and threads per core must be specified in the request. - LaunchTemplateEbsBlockDeviceRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Integer' - - description: '

The throughput to provision for a gp3 volume, with a maximum of 1,000 MiB/s.

Valid Range: Minimum value of 125. Maximum value of 1000.

' - description: The parameters for a block device for an EBS volume. - LaunchTemplateElasticInferenceAcceleratorCount: - type: integer - minimum: 1 - LaunchTemplateElasticInferenceAccelerator: - type: object - required: - - Type - properties: - undefined: - allOf: - - $ref: '#/components/schemas/LaunchTemplateElasticInferenceAcceleratorCount' - - description: '

The number of elastic inference accelerators to attach to the instance.

Default: 1

' - description: ' Describes an elastic inference accelerator. ' - LaunchTemplateElasticInferenceAcceleratorResponse: - type: object - properties: - type: - allOf: - - $ref: '#/components/schemas/String' - - description: ' The type of elastic inference accelerator. The possible values are eia1.medium, eia1.large, and eia1.xlarge. ' - count: - allOf: - - $ref: '#/components/schemas/Integer' - - description: '

The number of elastic inference accelerators to attach to the instance.

Default: 1

' - description: ' Describes an elastic inference accelerator. ' - LaunchTemplateElasticInferenceAcceleratorResponseList: - type: array - items: - allOf: - - $ref: '#/components/schemas/LaunchTemplateElasticInferenceAcceleratorResponse' - - xml: - name: item - LaunchTemplateEnclaveOptions: - type: object - properties: - enabled: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'If this parameter is set to true, the instance is enabled for Amazon Web Services Nitro Enclaves; otherwise, it is not enabled for Amazon Web Services Nitro Enclaves.' - description: Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. - LaunchTemplateEnclaveOptionsRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'To enable the instance for Amazon Web Services Nitro Enclaves, set this parameter to true.' - description: 'Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more information, see What is Amazon Web Services Nitro Enclaves? in the Amazon Web Services Nitro Enclaves User Guide.' - LaunchTemplateErrorCode: - type: string - enum: - - launchTemplateIdDoesNotExist - - launchTemplateIdMalformed - - launchTemplateNameDoesNotExist - - launchTemplateNameMalformed - - launchTemplateVersionDoesNotExist - - unexpectedError - LaunchTemplateHibernationOptions: - type: object - properties: - configured: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'If this parameter is set to true, the instance is enabled for hibernation; otherwise, it is not enabled for hibernation.' - description: Indicates whether an instance is configured for hibernation. - LaunchTemplateHibernationOptionsRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: '

If you set this parameter to true, the instance is enabled for hibernation.

Default: false

' - description: 'Indicates whether the instance is configured for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites.' - LaunchTemplateHttpTokensState: - type: string - enum: - - optional - - required - LaunchTemplateIamInstanceProfileSpecification: - type: object - properties: - arn: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Resource Name (ARN) of the instance profile. - name: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of the instance profile. - description: Describes an IAM instance profile. - LaunchTemplateInstanceMaintenanceOptions: - type: object - properties: - autoRecovery: - allOf: - - $ref: '#/components/schemas/LaunchTemplateAutoRecoveryState' - - description: Disables the automatic recovery behavior of your instance or sets it to default. - description: The maintenance options of your instance. - MarketType: - type: string - enum: - - spot - LaunchTemplateSpotMarketOptions: - type: object - properties: - maxPrice: - allOf: - - $ref: '#/components/schemas/String' - - description: The maximum hourly price you're willing to pay for the Spot Instances. - spotInstanceType: - allOf: - - $ref: '#/components/schemas/SpotInstanceType' - - description: The Spot Instance request type. - blockDurationMinutes: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).' - validUntil: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: 'The end date of the request. For a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached.' - instanceInterruptionBehavior: - allOf: - - $ref: '#/components/schemas/InstanceInterruptionBehavior' - - description: The behavior when a Spot Instance is interrupted. - description: The options for Spot Instances. - LaunchTemplateInstanceMarketOptions: - type: object - properties: - marketType: - allOf: - - $ref: '#/components/schemas/MarketType' - - description: The market type. - spotOptions: - allOf: - - $ref: '#/components/schemas/LaunchTemplateSpotMarketOptions' - - description: The options for Spot Instances. - description: The market (purchasing) option for the instances. - LaunchTemplateSpotMarketOptionsRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/InstanceInterruptionBehavior' - - description: The behavior when a Spot Instance is interrupted. The default is terminate. - description: The options for Spot Instances. - LaunchTemplateInstanceMarketOptionsRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/LaunchTemplateSpotMarketOptionsRequest' - - description: The options for Spot Instances. - description: The market (purchasing) option for the instances. - LaunchTemplateInstanceMetadataEndpointState: - type: string - enum: - - disabled - - enabled - LaunchTemplateInstanceMetadataOptionsState: - type: string - enum: - - pending - - applied - LaunchTemplateInstanceMetadataProtocolIpv6: - type: string - enum: - - disabled - - enabled - LaunchTemplateInstanceMetadataTagsState: - type: string - enum: - - disabled - - enabled - LaunchTemplateInstanceMetadataOptions: - type: object - properties: - state: - allOf: - - $ref: '#/components/schemas/LaunchTemplateInstanceMetadataOptionsState' - - description:

The state of the metadata option changes.

pending - The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection.

applied - The metadata options have been successfully applied on the instance.

- httpTokens: - allOf: - - $ref: '#/components/schemas/LaunchTemplateHttpTokensState' - - description: '

The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional.

If the state is optional, you can choose to retrieve instance metadata with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0 role credentials are returned.

If the state is required, you must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns the version 2.0 credentials; the version 1.0 credentials are not available.

' - httpPutResponseHopLimit: - allOf: - - $ref: '#/components/schemas/Integer' - - description: '

The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.

Default: 1

Possible values: Integers from 1 to 64

' - httpEndpoint: - allOf: - - $ref: '#/components/schemas/LaunchTemplateInstanceMetadataEndpointState' - - description: '

Enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is enabled.

If you specify a value of disabled, you will not be able to access your instance metadata.

' - httpProtocolIpv6: - allOf: - - $ref: '#/components/schemas/LaunchTemplateInstanceMetadataProtocolIpv6' - - description: '

Enables or disables the IPv6 endpoint for the instance metadata service.

Default: disabled

' - instanceMetadataTags: - allOf: - - $ref: '#/components/schemas/LaunchTemplateInstanceMetadataTagsState' - - description: '

Set to enabled to allow access to instance tags from the instance metadata. Set to disabled to turn off access to instance tags from the instance metadata. For more information, see Work with instance tags using the instance metadata.

Default: disabled

' - description: 'The metadata options for the instance. For more information, see Instance Metadata and User Data in the Amazon Elastic Compute Cloud User Guide.' - LaunchTemplateInstanceMetadataOptionsRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/LaunchTemplateInstanceMetadataTagsState' - - description: '

Set to enabled to allow access to instance tags from the instance metadata. Set to disabled to turn off access to instance tags from the instance metadata. For more information, see Work with instance tags using the instance metadata.

Default: disabled

' - description: 'The metadata options for the instance. For more information, see Instance Metadata and User Data in the Amazon Elastic Compute Cloud User Guide.' - LaunchTemplateInstanceNetworkInterfaceSpecification: - type: object - properties: - associateCarrierIpAddress: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: '

Indicates whether to associate a Carrier IP address with eth0 for a new network interface.

Use this option when you launch an instance in a Wavelength Zone and want to associate a Carrier IP address with the network interface. For more information about Carrier IP addresses, see Carrier IP addresses in the Wavelength Developer Guide.

' - associatePublicIpAddress: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether to associate a public IPv4 address with eth0 for a new network interface. - deleteOnTermination: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether the network interface is deleted when the instance is terminated. - description: - allOf: - - $ref: '#/components/schemas/String' - - description: A description for the network interface. - deviceIndex: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The device index for the network interface attachment. - groupSet: - allOf: - - $ref: '#/components/schemas/GroupIdStringList' - - description: The IDs of one or more security groups. - interfaceType: - allOf: - - $ref: '#/components/schemas/String' - - description: The type of network interface. - ipv6AddressCount: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The number of IPv6 addresses for the network interface. - ipv6AddressesSet: - allOf: - - $ref: '#/components/schemas/InstanceIpv6AddressList' - - description: The IPv6 addresses for the network interface. - networkInterfaceId: - allOf: - - $ref: '#/components/schemas/NetworkInterfaceId' - - description: The ID of the network interface. - privateIpAddress: - allOf: - - $ref: '#/components/schemas/String' - - description: The primary private IPv4 address of the network interface. - privateIpAddressesSet: - allOf: - - $ref: '#/components/schemas/PrivateIpAddressSpecificationList' - - description: One or more private IPv4 addresses. - secondaryPrivateIpAddressCount: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The number of secondary private IPv4 addresses for the network interface. - subnetId: - allOf: - - $ref: '#/components/schemas/SubnetId' - - description: The ID of the subnet for the network interface. - networkCardIndex: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The index of the network card. - ipv4PrefixSet: - allOf: - - $ref: '#/components/schemas/Ipv4PrefixListResponse' - - description: One or more IPv4 prefixes assigned to the network interface. - ipv4PrefixCount: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The number of IPv4 prefixes that Amazon Web Services automatically assigned to the network interface. - ipv6PrefixSet: - allOf: - - $ref: '#/components/schemas/Ipv6PrefixListResponse' - - description: One or more IPv6 prefixes assigned to the network interface. - ipv6PrefixCount: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The number of IPv6 prefixes that Amazon Web Services automatically assigned to the network interface. - description: Describes a network interface. - LaunchTemplateInstanceNetworkInterfaceSpecificationList: - type: array - items: - allOf: - - $ref: '#/components/schemas/LaunchTemplateInstanceNetworkInterfaceSpecification' - - xml: - name: item - LaunchTemplateInstanceNetworkInterfaceSpecificationRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The device index for the network interface attachment. - SecurityGroupId: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The index of the network card. Some instance types support multiple network cards. The primary network interface must be assigned to network card index 0. The default is network card index 0. - Ipv4Prefix: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The number of IPv4 prefixes to be automatically assigned to the network interface. You cannot use this option if you use the Ipv4Prefix option. - Ipv6Prefix: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The number of IPv6 prefixes to be automatically assigned to the network interface. You cannot use this option if you use the Ipv6Prefix option. - description: The parameters for a network interface. - LaunchTemplateInstanceNetworkInterfaceSpecificationRequestList: - type: array - items: - allOf: - - $ref: '#/components/schemas/LaunchTemplateInstanceNetworkInterfaceSpecificationRequest' - - xml: - name: InstanceNetworkInterfaceSpecification - LaunchTemplateLicenseConfiguration: - type: object - properties: - licenseConfigurationArn: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Resource Name (ARN) of the license configuration. - description: Describes a license configuration. - LaunchTemplateLicenseConfigurationRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Resource Name (ARN) of the license configuration. - description: Describes a license configuration. - LaunchTemplateLicenseList: - type: array - items: - allOf: - - $ref: '#/components/schemas/LaunchTemplateLicenseConfiguration' - - xml: - name: item - LaunchTemplateLicenseSpecificationListRequest: - type: array - items: - allOf: - - $ref: '#/components/schemas/LaunchTemplateLicenseConfigurationRequest' - - xml: - name: item - LaunchTemplateOverrides: - type: object - properties: - instanceType: - allOf: - - $ref: '#/components/schemas/InstanceType' - - description: The instance type. - spotPrice: - allOf: - - $ref: '#/components/schemas/String' - - description: The maximum price per unit hour that you are willing to pay for a Spot Instance. - subnetId: - allOf: - - $ref: '#/components/schemas/SubnetId' - - description: The ID of the subnet in which to launch the instances. - availabilityZone: - allOf: - - $ref: '#/components/schemas/String' - - description: The Availability Zone in which to launch the instances. - weightedCapacity: - allOf: - - $ref: '#/components/schemas/Double' - - description: The number of units provided by the specified instance type. - priority: - allOf: - - $ref: '#/components/schemas/Double' - - description: '

The priority for the launch template override. The highest priority is launched first.

If OnDemandAllocationStrategy is set to prioritized, Spot Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity.

If the Spot AllocationStrategy is set to capacityOptimizedPrioritized, Spot Fleet uses priority on a best-effort basis to determine which launch template override to use in fulfilling Spot capacity, but optimizes for capacity first.

Valid values are whole numbers starting at 0. The lower the number, the higher the priority. If no number is set, the launch template override has the lowest priority. You can set the same priority for different launch template overrides.

' - instanceRequirements: - allOf: - - $ref: '#/components/schemas/InstanceRequirements' - - description: '

The instance requirements. When you specify instance requirements, Amazon EC2 will identify instance types with the provided requirements, and then use your On-Demand and Spot allocation strategies to launch instances from these instance types, in the same way as when you specify a list of instance types.

If you specify InstanceRequirements, you can''t specify InstanceTypes.

' - description: Describes overrides for a launch template. - LaunchTemplatePlacement: - type: object - properties: - availabilityZone: - allOf: - - $ref: '#/components/schemas/String' - - description: The Availability Zone of the instance. - affinity: - allOf: - - $ref: '#/components/schemas/String' - - description: The affinity setting for the instance on the Dedicated Host. - groupName: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of the placement group for the instance. - hostId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Dedicated Host for the instance. - tenancy: - allOf: - - $ref: '#/components/schemas/Tenancy' - - description: 'The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. ' - spreadDomain: - allOf: - - $ref: '#/components/schemas/String' - - description: Reserved for future use. - hostResourceGroupArn: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The ARN of the host resource group in which to launch the instances. ' - partitionNumber: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The number of the partition the instance should launch in. Valid only if the placement group strategy is set to partition. - description: Describes the placement of an instance. - LaunchTemplatePlacementRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The number of the partition the instance should launch in. Valid only if the placement group strategy is set to partition. - description: Describes the placement of an instance. - LaunchTemplatePrivateDnsNameOptions: - type: object - properties: - hostnameType: - allOf: - - $ref: '#/components/schemas/HostnameType' - - description: The type of hostname to assign to an instance. - enableResourceNameDnsARecord: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether to respond to DNS queries for instance hostnames with DNS A records. - enableResourceNameDnsAAAARecord: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records. - description: Describes the options for instance hostnames. - LaunchTemplatePrivateDnsNameOptionsRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records. - description: Describes the options for instance hostnames. - LaunchTemplateSpecification: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: '

The version number of the launch template.

Default: The default version for the launch template.

' - description: 'The launch template to use. You must specify either the launch template ID or launch template name in the request, but not both.' - SpotInstanceType: - type: string - enum: - - one-time - - persistent - ResourceType: - type: string - enum: - - capacity-reservation - - client-vpn-endpoint - - customer-gateway - - carrier-gateway - - dedicated-host - - dhcp-options - - egress-only-internet-gateway - - elastic-ip - - elastic-gpu - - export-image-task - - export-instance-task - - fleet - - fpga-image - - host-reservation - - image - - import-image-task - - import-snapshot-task - - instance - - instance-event-window - - internet-gateway - - ipam - - ipam-pool - - ipam-scope - - ipv4pool-ec2 - - ipv6pool-ec2 - - key-pair - - launch-template - - local-gateway - - local-gateway-route-table - - local-gateway-virtual-interface - - local-gateway-virtual-interface-group - - local-gateway-route-table-vpc-association - - local-gateway-route-table-virtual-interface-group-association - - natgateway - - network-acl - - network-interface - - network-insights-analysis - - network-insights-path - - network-insights-access-scope - - network-insights-access-scope-analysis - - placement-group - - prefix-list - - replace-root-volume-task - - reserved-instances - - route-table - - security-group - - security-group-rule - - snapshot - - spot-fleet-request - - spot-instances-request - - subnet - - subnet-cidr-reservation - - traffic-mirror-filter - - traffic-mirror-session - - traffic-mirror-target - - transit-gateway - - transit-gateway-attachment - - transit-gateway-connect-peer - - transit-gateway-multicast-domain - - transit-gateway-route-table - - volume - - vpc - - vpc-endpoint - - vpc-endpoint-service - - vpc-peering-connection - - vpn-connection - - vpn-gateway - - vpc-flow-log - LaunchTemplateTagSpecification: - type: object - properties: - resourceType: - allOf: - - $ref: '#/components/schemas/ResourceType' - - description: The type of resource. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: The tags for the resource. - description: The tag specification for the launch template. - LaunchTemplateTagSpecificationList: - type: array - items: - allOf: - - $ref: '#/components/schemas/LaunchTemplateTagSpecification' - - xml: - name: item - LaunchTemplateTagSpecificationRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/ResourceType' - - description: 'The type of resource to tag. Currently, the resource types that support tagging on creation are instance, volume, elastic-gpu, network-interface, and spot-instances-request. To tag a resource after it has been created, see CreateTags.' - Tag: - allOf: - - $ref: '#/components/schemas/TagList' - - description: The tags to apply to the resource. - description: The tags specification for the launch template. - VersionDescription: - type: string - minLength: 0 - maxLength: 255 - LaunchTemplatesMonitoring: - type: object - properties: - enabled: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.' - description: Describes the monitoring for the instance. - LaunchTemplatesMonitoringRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Specify true to enable detailed monitoring. Otherwise, basic monitoring is enabled.' - description: Describes the monitoring for the instance. - LicenseConfiguration: - type: object - properties: - licenseConfigurationArn: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Resource Name (ARN) of the license configuration. - description: Describes a license configuration. - LicenseSpecificationListRequest: - type: array - items: - allOf: - - $ref: '#/components/schemas/LicenseConfigurationRequest' - - xml: - name: item - ListImagesInRecycleBinMaxResults: - type: integer - minimum: 1 - maximum: 1000 - ListImagesInRecycleBinRequest: - type: object - title: ListImagesInRecycleBinRequest - properties: - ImageId: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - ListSnapshotsInRecycleBinMaxResults: - type: integer - minimum: 5 - maximum: 1000 - ListSnapshotsInRecycleBinRequest: - type: object - title: ListSnapshotsInRecycleBinRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The token for the next page of results. - SnapshotId: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - SnapshotRecycleBinInfoList: - type: array - items: - allOf: - - $ref: '#/components/schemas/SnapshotRecycleBinInfo' - - xml: - name: item - ListingStatus: - type: string - enum: - - active - - pending - - cancelled - - closed - TargetGroupsConfig: - type: object - properties: - targetGroups: - allOf: - - $ref: '#/components/schemas/TargetGroups' - - description: One or more target groups. - description: Describes the target groups to attach to a Spot Fleet. Spot Fleet registers the running Spot Instances with these target groups. - LoadPermission: - type: object - properties: - userId: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Web Services account ID. - group: - allOf: - - $ref: '#/components/schemas/PermissionGroup' - - description: The name of the group. - description: Describes a load permission. - LoadPermissionRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Web Services account ID. - description: Describes a load permission. - LoadPermissionModifications: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/LoadPermissionListRequest' - - description: The load permissions to remove. - description: Describes modifications to the load permissions of an Amazon FPGA image (AFI). - LocalGateway: - type: object - properties: - localGatewayId: - allOf: - - $ref: '#/components/schemas/LocalGatewayId' - - description: The ID of the local gateway. - outpostArn: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Resource Name (ARN) of the Outpost. - ownerId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Amazon Web Services account that owns the local gateway. - state: - allOf: - - $ref: '#/components/schemas/String' - - description: The state of the local gateway. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: The tags assigned to the local gateway. - description: Describes a local gateway. - LocalGatewayMaxResults: - type: integer - minimum: 5 - maximum: 1000 - LocalGatewayRouteType: - type: string - enum: - - static - - propagated - LocalGatewayRouteState: - type: string - enum: - - pending - - active - - blackhole - - deleting - - deleted - LocalGatewayRouteList: - type: array - items: - allOf: - - $ref: '#/components/schemas/LocalGatewayRoute' - - xml: - name: item - LocalGatewayRouteTable: - type: object - properties: - localGatewayRouteTableId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the local gateway route table. - localGatewayRouteTableArn: - allOf: - - $ref: '#/components/schemas/ResourceArn' - - description: The Amazon Resource Name (ARN) of the local gateway route table. - localGatewayId: - allOf: - - $ref: '#/components/schemas/LocalGatewayId' - - description: The ID of the local gateway. - outpostArn: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Resource Name (ARN) of the Outpost. - ownerId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Amazon Web Services account that owns the local gateway route table. - state: - allOf: - - $ref: '#/components/schemas/String' - - description: The state of the local gateway route table. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: The tags assigned to the local gateway route table. - description: Describes a local gateway route table. - LocalGatewayRouteTableVirtualInterfaceGroupAssociation: - type: object - properties: - localGatewayRouteTableVirtualInterfaceGroupAssociationId: - allOf: - - $ref: '#/components/schemas/LocalGatewayRouteTableVirtualInterfaceGroupAssociationId' - - description: The ID of the association. - localGatewayVirtualInterfaceGroupId: - allOf: - - $ref: '#/components/schemas/LocalGatewayVirtualInterfaceGroupId' - - description: The ID of the virtual interface group. - localGatewayId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the local gateway. - localGatewayRouteTableId: - allOf: - - $ref: '#/components/schemas/LocalGatewayId' - - description: The ID of the local gateway route table. - localGatewayRouteTableArn: - allOf: - - $ref: '#/components/schemas/ResourceArn' - - description: The Amazon Resource Name (ARN) of the local gateway route table for the virtual interface group. - ownerId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Amazon Web Services account that owns the local gateway virtual interface group association. - state: - allOf: - - $ref: '#/components/schemas/String' - - description: The state of the association. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: The tags assigned to the association. - description: Describes an association between a local gateway route table and a virtual interface group. - LocalGatewayVirtualInterface: - type: object - properties: - localGatewayVirtualInterfaceId: - allOf: - - $ref: '#/components/schemas/LocalGatewayVirtualInterfaceId' - - description: The ID of the virtual interface. - localGatewayId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the local gateway. - vlan: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The ID of the VLAN. - localAddress: - allOf: - - $ref: '#/components/schemas/String' - - description: The local address. - peerAddress: - allOf: - - $ref: '#/components/schemas/String' - - description: The peer address. - localBgpAsn: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The Border Gateway Protocol (BGP) Autonomous System Number (ASN) of the local gateway. - peerBgpAsn: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The peer BGP ASN. - ownerId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Amazon Web Services account that owns the local gateway virtual interface. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: The tags assigned to the virtual interface. - description: Describes a local gateway virtual interface. - LocalGatewayVirtualInterfaceGroup: - type: object - properties: - localGatewayVirtualInterfaceGroupId: - allOf: - - $ref: '#/components/schemas/LocalGatewayVirtualInterfaceGroupId' - - description: The ID of the virtual interface group. - localGatewayVirtualInterfaceIdSet: - allOf: - - $ref: '#/components/schemas/LocalGatewayVirtualInterfaceIdSet' - - description: The IDs of the virtual interfaces. - localGatewayId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the local gateway. - ownerId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Amazon Web Services account that owns the local gateway virtual interface group. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: The tags assigned to the virtual interface group. - description: Describes a local gateway virtual interface group. - LocalStorageType: - type: string - enum: - - hdd - - ssd - PrefixListState: - type: string - enum: - - create-in-progress - - create-complete - - create-failed - - modify-in-progress - - modify-complete - - modify-failed - - restore-in-progress - - restore-complete - - restore-failed - - delete-in-progress - - delete-complete - - delete-failed - MaxIpv4AddrPerInterface: - type: integer - MaxIpv6AddrPerInterface: - type: integer - MaxNetworkInterfaces: - type: integer - MaxResults: - type: integer - MaximumNetworkCards: - type: integer - MembershipType: - type: string - enum: - - static - - igmp - MemorySize: - type: integer - ModifyAddressAttributeRequest: - type: object - required: - - AllocationId - title: ModifyAddressAttributeRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - ModifyAvailabilityZoneGroupRequest: - type: object - required: - - GroupName - - OptInStatus - title: ModifyAvailabilityZoneGroupRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - ModifyAvailabilityZoneOptInStatus: - type: string - enum: - - opted-in - - not-opted-in - ModifyCapacityReservationFleetRequest: - type: object - required: - - CapacityReservationFleetId - title: ModifyCapacityReservationFleetRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: '

Indicates whether to remove the end date from the Capacity Reservation Fleet. If you remove the end date, the Capacity Reservation Fleet does not expire and it remains active until you explicitly cancel it using the CancelCapacityReservationFleet action.

You can''t specify RemoveEndDate and EndDate in the same request.

' - ModifyCapacityReservationRequest: - type: object - required: - - CapacityReservationId - title: ModifyCapacityReservationRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: Reserved for future use. - ModifyClientVpnEndpointRequest: - type: object - required: - - ClientVpnEndpointId - title: ModifyClientVpnEndpointRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - SecurityGroupId: - allOf: - - $ref: '#/components/schemas/ClientLoginBannerOptions' - - description: Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established. - ModifyDefaultCreditSpecificationRequest: - type: object - required: - - InstanceFamily - - CpuCredits - title: ModifyDefaultCreditSpecificationRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: '

The credit option for CPU usage of the instance family.

Valid Values: standard | unlimited

' - ModifyEbsDefaultKmsKeyIdRequest: - type: object - required: - - KmsKeyId - title: ModifyEbsDefaultKmsKeyIdRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - ModifyFleetRequest: - type: object - required: - - FleetId - title: ModifyFleetRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/FleetExcessCapacityTerminationPolicy' - - description: Indicates whether running instances should be terminated if the total target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet. - LaunchTemplateConfig: - allOf: - - $ref: '#/components/schemas/String' - - description: Reserved. - OperationType: - type: string - enum: - - add - - remove - UserIdStringList: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: UserId - UserGroupStringList: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: UserGroup - ModifyFpgaImageAttributeRequest: - type: object - required: - - FpgaImageId - title: ModifyFpgaImageAttributeRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/OperationType' - - description: The operation type. - UserId: - allOf: - - $ref: '#/components/schemas/UserIdStringList' - - description: The Amazon Web Services account IDs. This parameter is valid only when modifying the loadPermission attribute. - UserGroup: - allOf: - - $ref: '#/components/schemas/UserGroupStringList' - - description: The user groups. This parameter is valid only when modifying the loadPermission attribute. - ProductCode: - allOf: - - $ref: '#/components/schemas/String' - - description: A name for the AFI. - ModifyHostsRequest: - type: object - required: - - HostIds - title: ModifyHostsRequest - properties: - autoPlacement: - allOf: - - $ref: '#/components/schemas/AutoPlacement' - - description: Specify whether to enable or disable auto-placement. - hostId: - allOf: - - $ref: '#/components/schemas/String' - - description: '

Specifies the instance family to be supported by the Dedicated Host. Specify this parameter to modify a Dedicated Host to support multiple instance types within its current instance family.

If you want to modify a Dedicated Host to support a specific instance type only, omit this parameter and specify InstanceType instead. You cannot specify InstanceFamily and InstanceType in the same request.

' - UnsuccessfulItemList: - type: array - items: - allOf: - - $ref: '#/components/schemas/UnsuccessfulItem' - - xml: - name: item - ModifyIdFormatRequest: - type: object - required: - - Resource - - UseLongIds - title: ModifyIdFormatRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicate whether the resource should use longer IDs (17-character IDs). - ModifyIdentityIdFormatRequest: - type: object - required: - - PrincipalArn - - Resource - - UseLongIds - title: ModifyIdentityIdFormatRequest - properties: - principalArn: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The ARN of the principal, which can be an IAM user, IAM role, or the root user. Specify all to modify the ID format for all IAM users, IAM roles, and the root user of the account.' - resource: - allOf: - - $ref: '#/components/schemas/String' - - description: '

The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | route-table | route-table-association | security-group | subnet | subnet-cidr-block-association | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.

Alternatively, use the all-current option to include all resource types that are currently within their opt-in period for longer IDs.

' - useLongIds: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether the resource should use longer IDs (17-character IDs) - ProductCodeStringList: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: ProductCode - OrganizationArnStringList: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: OrganizationArn - OrganizationalUnitArnStringList: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: OrganizationalUnitArn - ModifyImageAttributeRequest: - type: object - required: - - ImageId - title: ModifyImageAttributeRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/OperationType' - - description: The operation type. This parameter can be used only when the Attribute parameter is launchPermission. - ProductCode: - allOf: - - $ref: '#/components/schemas/ProductCodeStringList' - - description: Not supported. - UserGroup: - allOf: - - $ref: '#/components/schemas/UserGroupStringList' - - description: The user groups. This parameter can be used only when the Attribute parameter is launchPermission. - UserId: - allOf: - - $ref: '#/components/schemas/String' - - description: The value of the attribute being modified. This parameter can be used only when the Attribute parameter is description. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - OrganizationArn: - allOf: - - $ref: '#/components/schemas/OrganizationArnStringList' - - description: The Amazon Resource Name (ARN) of an organization. This parameter can be used only when the Attribute parameter is launchPermission. - OrganizationalUnitArn: - allOf: - - $ref: '#/components/schemas/OrganizationalUnitArnStringList' - - description: The Amazon Resource Name (ARN) of an organizational unit (OU). This parameter can be used only when the Attribute parameter is launchPermission. - description: Contains the parameters for ModifyImageAttribute. - ModifyInstanceAttributeRequest: - type: object - required: - - InstanceId - title: ModifyInstanceAttributeRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/AttributeBooleanValue' - - description: 'Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives. If the value is true, source/destination checks are enabled; otherwise, they are disabled. The default value is true. You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.' - attribute: - allOf: - - $ref: '#/components/schemas/InstanceAttributeName' - - description: The name of the attribute. - blockDeviceMapping: - allOf: - - $ref: '#/components/schemas/InstanceBlockDeviceMappingSpecificationList' - - description: '

Modifies the DeleteOnTermination attribute for volumes that are currently attached. The volume must be owned by the caller. If no value is specified for DeleteOnTermination, the default is true and the volume is deleted when the instance is terminated.

To add instance store volumes to an Amazon EBS-backed instance, you must add them when you launch the instance. For more information, see Update the block device mapping when launching an instance in the Amazon EC2 User Guide.

' - disableApiTermination: - allOf: - - $ref: '#/components/schemas/AttributeBooleanValue' - - description: 'If the value is true, you can''t terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. You cannot use this parameter for Spot Instances.' - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - ebsOptimized: - allOf: - - $ref: '#/components/schemas/AttributeBooleanValue' - - description: Specifies whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance. - enaSupport: - allOf: - - $ref: '#/components/schemas/AttributeBooleanValue' - - description:

Set to true to enable enhanced networking with ENA for the instance.

This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.

- GroupId: - allOf: - - $ref: '#/components/schemas/GroupIdStringList' - - description: '[EC2-VPC] Replaces the security groups of the instance with the specified security groups. You must specify at least one security group, even if it''s just the default security group for the VPC. You must specify the security group ID, not the security group name.' - instanceId: - allOf: - - $ref: '#/components/schemas/InstanceId' - - description: The ID of the instance. - instanceInitiatedShutdownBehavior: - allOf: - - $ref: '#/components/schemas/AttributeValue' - - description: Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown). - instanceType: - allOf: - - $ref: '#/components/schemas/AttributeValue' - - description: 'Changes the instance type to the specified value. For more information, see Instance types in the Amazon EC2 User Guide. If the instance type is not valid, the error returned is InvalidInstanceAttributeValue.' - kernel: - allOf: - - $ref: '#/components/schemas/AttributeValue' - - description: 'Changes the instance''s kernel to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.' - ramdisk: - allOf: - - $ref: '#/components/schemas/AttributeValue' - - description: 'Changes the instance''s RAM disk to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.' - sriovNetSupport: - allOf: - - $ref: '#/components/schemas/AttributeValue' - - description:

Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the instance.

There is no way to disable enhanced networking with the Intel 82599 Virtual Function interface at this time.

This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.

- userData: - allOf: - - $ref: '#/components/schemas/BlobAttributeValue' - - description: 'Changes the instance''s user data to the specified value. If you are using an Amazon Web Services SDK or command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text.' - value: - allOf: - - $ref: '#/components/schemas/String' - - description: 'A new value for the attribute. Use only with the kernel, ramdisk, userData, disableApiTermination, or instanceInitiatedShutdownBehavior attribute.' - ModifyInstanceCapacityReservationAttributesRequest: - type: object - required: - - InstanceId - - CapacityReservationSpecification - title: ModifyInstanceCapacityReservationAttributesRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - ModifyInstanceCreditSpecificationRequest: - type: object - required: - - InstanceCreditSpecifications - title: ModifyInstanceCreditSpecificationRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: 'A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.' - InstanceCreditSpecification: - allOf: - - $ref: '#/components/schemas/InstanceCreditSpecificationListRequest' - - description: Information about the credit option for CPU usage. - SuccessfulInstanceCreditSpecificationSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/SuccessfulInstanceCreditSpecificationItem' - - xml: - name: item - UnsuccessfulInstanceCreditSpecificationSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/UnsuccessfulInstanceCreditSpecificationItem' - - xml: - name: item - ModifyInstanceEventStartTimeRequest: - type: object - required: - - InstanceId - - InstanceEventId - - NotBefore - title: ModifyInstanceEventStartTimeRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The new date and time when the event will take place. - ModifyInstanceEventWindowRequest: - type: object - required: - - InstanceEventWindowId - title: ModifyInstanceEventWindowRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/InstanceEventWindowId' - - description: The ID of the event window. - TimeRange: - allOf: - - $ref: '#/components/schemas/InstanceEventWindowCronExpression' - - description: '

The cron expression of the event window, for example, * 0-4,20-23 * * 1,5.

Constraints:

  • Only hour and day of the week values are supported.

  • For day of the week values, you can specify either integers 0 through 6, or alternative single values SUN through SAT.

  • The minute, month, and year must be specified by *.

  • The hour value must be one or a multiple range, for example, 0-4 or 0-4,20-23.

  • Each hour range must be >= 2 hours, for example, 0-2 or 20-23.

  • The event window must be >= 4 hours. The combined total time ranges in the event window must be >= 4 hours.

For more information about cron expressions, see cron on the Wikipedia website.

' - ModifyInstanceMaintenanceOptionsRequest: - type: object - required: - - InstanceId - title: ModifyInstanceMaintenanceOptionsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - ModifyInstanceMetadataOptionsRequest: - type: object - required: - - InstanceId - title: ModifyInstanceMetadataOptionsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/InstanceMetadataTagsState' - - description: '

Set to enabled to allow access to instance tags from the instance metadata. Set to disabled to turn off access to instance tags from the instance metadata. For more information, see Work with instance tags using the instance metadata.

Default: disabled

' - ModifyInstancePlacementRequest: - type: object - required: - - InstanceId - title: ModifyInstancePlacementRequest - properties: - affinity: - allOf: - - $ref: '#/components/schemas/PlacementGroupName' - - description: '

The name of the placement group in which to place the instance. For spread placement groups, the instance must have a tenancy of default. For cluster and partition placement groups, the instance must have a tenancy of default or dedicated.

To remove an instance from a placement group, specify an empty string ("").

' - hostId: - allOf: - - $ref: '#/components/schemas/DedicatedHostId' - - description: The ID of the Dedicated Host with which to associate the instance. - instanceId: - allOf: - - $ref: '#/components/schemas/InstanceId' - - description: The ID of the instance that you are modifying. - tenancy: - allOf: - - $ref: '#/components/schemas/String' - - description: The ARN of the host resource group in which to place the instance. - ModifyIpamPoolRequest: - type: object - required: - - IpamPoolId - title: ModifyIpamPoolRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Clear the default netmask length allocation rule for this pool. - AddAllocationResourceTag: - allOf: - - $ref: '#/components/schemas/RequestIpamResourceTagList' - - description: 'Add tag allocation rules to a pool. For more information about allocation rules, see Create a top-level pool in the Amazon VPC IPAM User Guide.' - RemoveAllocationResourceTag: - allOf: - - $ref: '#/components/schemas/RequestIpamResourceTagList' - - description: Remove tag allocation rules from a pool. - RemoveIpamOperatingRegionSet: - type: array - items: - $ref: '#/components/schemas/RemoveIpamOperatingRegion' - minItems: 0 - maxItems: 50 - ModifyIpamRequest: - type: object - required: - - IpamId - title: ModifyIpamRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The description of the IPAM you want to modify. - AddOperatingRegion: - allOf: - - $ref: '#/components/schemas/AddIpamOperatingRegionSet' - - description: '

Choose the operating Regions for the IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.

' - RemoveOperatingRegion: - allOf: - - $ref: '#/components/schemas/RemoveIpamOperatingRegionSet' - - description: The operating Regions to remove. - ModifyIpamResourceCidrRequest: - type: object - required: - - ResourceId - - ResourceCidr - - ResourceRegion - - CurrentIpamScopeId - - Monitored - title: ModifyIpamResourceCidrRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Determines if the resource is monitored by IPAM. If a resource is monitored, the resource is discovered by IPAM and you can view details about the resource’s CIDR.' - ModifyIpamScopeRequest: - type: object - required: - - IpamScopeId - title: ModifyIpamScopeRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The description of the scope you want to modify. - ModifyLaunchTemplateRequest: - type: object - title: ModifyLaunchTemplateRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/LaunchTemplateName' - - description: The name of the launch template. You must specify either the launch template ID or launch template name in the request. - SetDefaultVersion: - allOf: - - $ref: '#/components/schemas/String' - - description: The version number of the launch template to set as the default version. - ModifyManagedPrefixListRequest: - type: object - required: - - PrefixListId - title: ModifyManagedPrefixListRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: A name for the prefix list. - AddEntry: - allOf: - - $ref: '#/components/schemas/AddPrefixListEntries' - - description: One or more entries to add to the prefix list. - RemoveEntry: - allOf: - - $ref: '#/components/schemas/Integer' - - description: '

The maximum number of entries for the prefix list. You cannot modify the entries of a prefix list and modify the size of a prefix list at the same time.

If any of the resources that reference the prefix list cannot support the new maximum size, the modify operation fails. Check the state message for the IDs of the first ten resources that do not support the new maximum size.

' - NetworkInterfaceAttachmentChanges: - type: object - properties: - attachmentId: - allOf: - - $ref: '#/components/schemas/NetworkInterfaceAttachmentId' - - description: The ID of the network interface attachment. - deleteOnTermination: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether the network interface is deleted when the instance is terminated. - description: Describes an attachment change. - ModifyNetworkInterfaceAttributeRequest: - type: object - required: - - NetworkInterfaceId - title: ModifyNetworkInterfaceAttributeRequest - properties: - attachment: - allOf: - - $ref: '#/components/schemas/NetworkInterfaceAttachmentChanges' - - description: 'Information about the interface attachment. If modifying the ''delete on termination'' attribute, you must specify the ID of the interface attachment.' - description: - allOf: - - $ref: '#/components/schemas/AttributeValue' - - description: A description for the network interface. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - SecurityGroupId: - allOf: - - $ref: '#/components/schemas/SecurityGroupIdStringList' - - description: 'Changes the security groups for the network interface. The new set of groups you specify replaces the current set. You must specify at least one group, even if it''s just the default security group in the VPC. You must specify the ID of the security group, not the name.' - networkInterfaceId: - allOf: - - $ref: '#/components/schemas/NetworkInterfaceId' - - description: The ID of the network interface. - sourceDestCheck: - allOf: - - $ref: '#/components/schemas/AttributeBooleanValue' - - description: 'Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives. If the value is true, source/destination checks are enabled; otherwise, they are disabled. The default value is true. You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.' - description: Contains the parameters for ModifyNetworkInterfaceAttribute. - ModifyPrivateDnsNameOptionsRequest: - type: object - title: ModifyPrivateDnsNameOptionsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records. - ReservedInstancesConfigurationList: - type: array - items: - allOf: - - $ref: '#/components/schemas/ReservedInstancesConfiguration' - - xml: - name: item - ModifyReservedInstancesRequest: - type: object - required: - - ReservedInstancesIds - - TargetConfigurations - title: ModifyReservedInstancesRequest - properties: - ReservedInstancesId: - allOf: - - $ref: '#/components/schemas/ReservedInstancesIdStringList' - - description: The IDs of the Reserved Instances to modify. - clientToken: - allOf: - - $ref: '#/components/schemas/String' - - description: 'A unique, case-sensitive token you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.' - ReservedInstancesConfigurationSetItemType: - allOf: - - $ref: '#/components/schemas/ReservedInstancesConfigurationList' - - description: The configuration settings for the Reserved Instances to modify. - description: Contains the parameters for ModifyReservedInstances. - ModifySecurityGroupRulesRequest: - type: object - required: - - GroupId - - SecurityGroupRules - title: ModifySecurityGroupRulesRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/SecurityGroupId' - - description: The ID of the security group. - SecurityGroupRule: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - ModifySnapshotAttributeRequest: - type: object - required: - - SnapshotId - title: ModifySnapshotAttributeRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/CreateVolumePermissionModifications' - - description: A JSON representation of the snapshot attribute modification. - UserGroup: - allOf: - - $ref: '#/components/schemas/SnapshotId' - - description: The ID of the snapshot. - UserId: - allOf: - - $ref: '#/components/schemas/UserIdStringList' - - description: The account ID to modify for the snapshot. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - ModifySnapshotTierRequest: - type: object - required: - - SnapshotId - title: ModifySnapshotTierRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - ModifySpotFleetRequestRequest: - type: object - required: - - SpotFleetRequestId - title: ModifySpotFleetRequestRequest - properties: - excessCapacityTerminationPolicy: - allOf: - - $ref: '#/components/schemas/ExcessCapacityTerminationPolicy' - - description: Indicates whether running Spot Instances should be terminated if the target capacity of the Spot Fleet request is decreased below the current size of the Spot Fleet. - LaunchTemplateConfig: - allOf: - - $ref: '#/components/schemas/LaunchTemplateConfigList' - - description: 'The launch template and overrides. You can only use this parameter if you specified a launch template (LaunchTemplateConfigs) in your Spot Fleet request. If you specified LaunchSpecifications in your Spot Fleet request, then omit this parameter.' - spotFleetRequestId: - allOf: - - $ref: '#/components/schemas/SpotFleetRequestId' - - description: The ID of the Spot Fleet request. - targetCapacity: - allOf: - - $ref: '#/components/schemas/String' - - description: Reserved. - description: Contains the parameters for ModifySpotFleetRequest. - ModifySubnetAttributeRequest: - type: object - required: - - SubnetId - title: ModifySubnetAttributeRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/AttributeBooleanValue' - - description: Specify true to indicate that network interfaces attached to instances created in the specified subnet should be assigned a public IPv4 address. - subnetId: - allOf: - - $ref: '#/components/schemas/AttributeBooleanValue' - - description: ' Specify true to indicate that local network interfaces at the current position should be disabled. ' - TrafficMirrorNetworkServiceList: - type: array - items: - allOf: - - $ref: '#/components/schemas/TrafficMirrorNetworkService' - - xml: - name: item - ModifyTrafficMirrorFilterNetworkServicesRequest: - type: object - required: - - TrafficMirrorFilterId - title: ModifyTrafficMirrorFilterNetworkServicesRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/TrafficMirrorFilterId' - - description: The ID of the Traffic Mirror filter. - AddNetworkService: - allOf: - - $ref: '#/components/schemas/TrafficMirrorNetworkServiceList' - - description: 'The network service, for example Amazon DNS, that you want to mirror.' - RemoveNetworkService: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - ModifyTrafficMirrorFilterRuleRequest: - type: object - required: - - TrafficMirrorFilterRuleId - title: ModifyTrafficMirrorFilterRuleRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The description to assign to the Traffic Mirror rule. - RemoveField: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - ModifyTrafficMirrorSessionRequest: - type: object - required: - - TrafficMirrorSessionId - title: ModifyTrafficMirrorSessionRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The description to assign to the Traffic Mirror session. - RemoveField: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - ModifyTransitGatewayOptions: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/TransitGatewayRouteTableId' - - description: The ID of the default propagation route table. - description: The transit gateway options. - ModifyTransitGatewayPrefixListReferenceRequest: - type: object - required: - - TransitGatewayRouteTableId - - PrefixListId - title: ModifyTransitGatewayPrefixListReferenceRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - ModifyTransitGatewayRequest: - type: object - required: - - TransitGatewayId - title: ModifyTransitGatewayRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - ModifyTransitGatewayVpcAttachmentRequest: - type: object - required: - - TransitGatewayAttachmentId - title: ModifyTransitGatewayVpcAttachmentRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - ModifyTransitGatewayVpcAttachmentRequestOptions: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/ApplianceModeSupportValue' - - description: 'Enable or disable support for appliance mode. If enabled, a traffic flow between a source and destination uses the same Availability Zone for the VPC attachment for the lifetime of that flow. The default is disable.' - description: Describes the options for a VPC attachment. - ModifyVolumeAttributeRequest: - type: object - required: - - VolumeId - title: ModifyVolumeAttributeRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/VolumeId' - - description: The ID of the volume. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - ModifyVolumeRequest: - type: object - required: - - VolumeId - title: ModifyVolumeRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Specifies whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the volume to up to 16 Nitro-based instances in the same Availability Zone. This parameter is supported with io1 and io2 volumes only. For more information, see Amazon EBS Multi-Attach in the Amazon Elastic Compute Cloud User Guide.' - VolumeModification: - type: object - properties: - volumeId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the volume. - modificationState: - allOf: - - $ref: '#/components/schemas/VolumeModificationState' - - description: The current modification state. The modification state is null for unmodified volumes. - statusMessage: - allOf: - - $ref: '#/components/schemas/String' - - description: A status message about the modification progress or failure. - targetSize: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The target size of the volume, in GiB.' - targetIops: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The target IOPS rate of the volume. - targetVolumeType: - allOf: - - $ref: '#/components/schemas/VolumeType' - - description: The target EBS volume type of the volume. - targetThroughput: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The target throughput of the volume, in MiB/s.' - targetMultiAttachEnabled: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: The target setting for Amazon EBS Multi-Attach. - originalSize: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The original size of the volume, in GiB.' - originalIops: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The original IOPS rate of the volume. - originalVolumeType: - allOf: - - $ref: '#/components/schemas/VolumeType' - - description: The original EBS volume type of the volume. - originalThroughput: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The original throughput of the volume, in MiB/s.' - originalMultiAttachEnabled: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: The original setting for Amazon EBS Multi-Attach. - progress: - allOf: - - $ref: '#/components/schemas/Long' - - description: 'The modification progress, from 0 to 100 percent complete.' - startTime: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The modification start time. - endTime: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The modification completion or failure time. - description: '

Describes the modification status of an EBS volume.

If the volume has never been modified, some element values will be null.

' - ModifyVpcAttributeRequest: - type: object - required: - - VpcId - title: ModifyVpcAttributeRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/AttributeBooleanValue' - - description: '

Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range "plus two" succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled.

You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute.

' - vpcId: - allOf: - - $ref: '#/components/schemas/VpcId' - - description: The ID of the VPC. - ModifyVpcEndpointConnectionNotificationRequest: - type: object - required: - - ConnectionNotificationId - title: ModifyVpcEndpointConnectionNotificationRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: 'One or more events for the endpoint. Valid values are Accept, Connect, Delete, and Reject.' - VpcEndpointSecurityGroupIdList: - type: array - items: - allOf: - - $ref: '#/components/schemas/SecurityGroupId' - - xml: - name: item - ModifyVpcEndpointRequest: - type: object - required: - - VpcEndpointId - title: ModifyVpcEndpointRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: (Interface and gateway endpoints) A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format. - AddRouteTableId: - allOf: - - $ref: '#/components/schemas/VpcEndpointRouteTableIdList' - - description: (Gateway endpoint) One or more route tables IDs to associate with the endpoint. - RemoveRouteTableId: - allOf: - - $ref: '#/components/schemas/VpcEndpointRouteTableIdList' - - description: (Gateway endpoint) One or more route table IDs to disassociate from the endpoint. - AddSubnetId: - allOf: - - $ref: '#/components/schemas/VpcEndpointSubnetIdList' - - description: '(Interface and Gateway Load Balancer endpoints) One or more subnet IDs in which to serve the endpoint. For a Gateway Load Balancer endpoint, you can specify only one subnet.' - RemoveSubnetId: - allOf: - - $ref: '#/components/schemas/VpcEndpointSubnetIdList' - - description: (Interface endpoint) One or more subnets IDs in which to remove the endpoint. - AddSecurityGroupId: - allOf: - - $ref: '#/components/schemas/VpcEndpointSecurityGroupIdList' - - description: (Interface endpoint) One or more security group IDs to associate with the network interface. - RemoveSecurityGroupId: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: (Interface endpoint) Indicates whether a private hosted zone is associated with the VPC. - description: Contains the parameters for ModifyVpcEndpoint. - ModifyVpcEndpointServiceConfigurationRequest: - type: object - required: - - ServiceId - title: ModifyVpcEndpointServiceConfigurationRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether requests to create an endpoint to your service must be accepted. - AddNetworkLoadBalancerArn: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The Amazon Resource Names (ARNs) of Network Load Balancers to add to your service configuration. - RemoveNetworkLoadBalancerArn: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The Amazon Resource Names (ARNs) of Network Load Balancers to remove from your service configuration. - AddGatewayLoadBalancerArn: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The Amazon Resource Names (ARNs) of Gateway Load Balancers to add to your service configuration. - RemoveGatewayLoadBalancerArn: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The Amazon Resource Names (ARNs) of Gateway Load Balancers to remove from your service configuration. - AddSupportedIpAddressType: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The IP address types to add to your service configuration. - RemoveSupportedIpAddressType: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The IP address types to remove from your service configuration. - PayerResponsibility: - type: string - enum: - - ServiceOwner - ModifyVpcEndpointServicePayerResponsibilityRequest: - type: object - required: - - ServiceId - - PayerResponsibility - title: ModifyVpcEndpointServicePayerResponsibilityRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/PayerResponsibility' - - description: 'The entity that is responsible for the endpoint costs. The default is the endpoint owner. If you set the payer responsibility to the service owner, you cannot set it back to the endpoint owner.' - ModifyVpcEndpointServicePermissionsRequest: - type: object - required: - - ServiceId - title: ModifyVpcEndpointServicePermissionsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The Amazon Resource Names (ARN) of one or more principals. Permissions are revoked for principals in this list. - ModifyVpcPeeringConnectionOptionsRequest: - type: object - required: - - VpcPeeringConnectionId - title: ModifyVpcPeeringConnectionOptionsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/VpcPeeringConnectionId' - - description: The ID of the VPC peering connection. - PeeringConnectionOptions: - type: object - properties: - allowDnsResolutionFromRemoteVpc: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'If true, the public DNS hostnames of instances in the specified VPC resolve to private IP addresses when queried from instances in the peer VPC.' - allowEgressFromLocalClassicLinkToRemoteVpc: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'If true, enables outbound communication from an EC2-Classic instance that''s linked to a local VPC using ClassicLink to instances in a peer VPC.' - allowEgressFromLocalVpcToRemoteClassicLink: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'If true, enables outbound communication from instances in a local VPC to an EC2-Classic instance that''s linked to a peer VPC using ClassicLink.' - description: Describes the VPC peering connection options. - ModifyVpcTenancyRequest: - type: object - required: - - VpcId - - InstanceTenancy - title: ModifyVpcTenancyRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - ModifyVpnConnectionOptionsRequest: - type: object - required: - - VpnConnectionId - title: ModifyVpnConnectionOptionsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - ModifyVpnConnectionRequest: - type: object - required: - - VpnConnectionId - title: ModifyVpnConnectionRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - ModifyVpnTunnelCertificateRequest: - type: object - required: - - VpnConnectionId - - VpnTunnelOutsideIpAddress - title: ModifyVpnTunnelCertificateRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - ModifyVpnTunnelOptionsRequest: - type: object - required: - - VpnConnectionId - - VpnTunnelOutsideIpAddress - - TunnelOptions - title: ModifyVpnTunnelOptionsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - ModifyVpnTunnelOptionsSpecification: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: '

The action to take after DPD timeout occurs. Specify restart to restart the IKE initiation. Specify clear to end the IKE session.

Valid Values: clear | none | restart

Default: clear

' - Phase1EncryptionAlgorithm: - allOf: - - $ref: '#/components/schemas/Phase1EncryptionAlgorithmsRequestList' - - description: '

One or more encryption algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.

Valid values: AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16

' - Phase2EncryptionAlgorithm: - allOf: - - $ref: '#/components/schemas/Phase2EncryptionAlgorithmsRequestList' - - description: '

One or more encryption algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.

Valid values: AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16

' - Phase1IntegrityAlgorithm: - allOf: - - $ref: '#/components/schemas/Phase1IntegrityAlgorithmsRequestList' - - description: '

One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.

Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512

' - Phase2IntegrityAlgorithm: - allOf: - - $ref: '#/components/schemas/Phase2IntegrityAlgorithmsRequestList' - - description: '

One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.

Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512

' - Phase1DHGroupNumber: - allOf: - - $ref: '#/components/schemas/Phase1DHGroupNumbersRequestList' - - description: '

One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 1 IKE negotiations.

Valid values: 2 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24

' - Phase2DHGroupNumber: - allOf: - - $ref: '#/components/schemas/Phase2DHGroupNumbersRequestList' - - description: '

One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 2 IKE negotiations.

Valid values: 2 | 5 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24

' - IKEVersion: - allOf: - - $ref: '#/components/schemas/String' - - description: '

The action to take when the establishing the tunnel for the VPN connection. By default, your customer gateway device must initiate the IKE negotiation and bring up the tunnel. Specify start for Amazon Web Services to initiate the IKE negotiation.

Valid Values: add | start

Default: add

' - description: The Amazon Web Services Site-to-Site VPN tunnel options to modify. - MonitorInstancesRequest: - type: object - required: - - InstanceIds - title: MonitorInstancesRequest - properties: - InstanceId: - allOf: - - $ref: '#/components/schemas/InstanceIdStringList' - - description: The IDs of the instances. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - MonitoringState: - type: string - enum: - - disabled - - disabling - - enabled - - pending - MoveAddressToVpcRequest: - type: object - required: - - PublicIp - title: MoveAddressToVpcRequest - properties: - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - publicIp: - allOf: - - $ref: '#/components/schemas/String' - - description: The Elastic IP address. - Status: - type: string - enum: - - MoveInProgress - - InVpc - - InClassic - MoveByoipCidrToIpamRequest: - type: object - required: - - Cidr - - IpamPoolId - - IpamPoolOwner - title: MoveByoipCidrToIpamRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Web Services account ID of the owner of the IPAM pool. - MoveStatus: - type: string - enum: - - movingToVpc - - restoringToClassic - MovingAddressStatus: - type: object - properties: - moveStatus: - allOf: - - $ref: '#/components/schemas/MoveStatus' - - description: 'The status of the Elastic IP address that''s being moved to the EC2-VPC platform, or restored to the EC2-Classic platform.' - publicIp: - allOf: - - $ref: '#/components/schemas/String' - - description: The Elastic IP address. - description: Describes the status of a moving Elastic IP address. - MulticastSupportValue: - type: string - enum: - - enable - - disable - NatGatewayAddressList: - type: array - items: - allOf: - - $ref: '#/components/schemas/NatGatewayAddress' - - xml: - name: item - ProvisionedBandwidth: - type: object - properties: - provisionTime: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: 'Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.' - provisioned: - allOf: - - $ref: '#/components/schemas/String' - - description: 'Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.' - requestTime: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: 'Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.' - requested: - allOf: - - $ref: '#/components/schemas/String' - - description: 'Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.' - status: - allOf: - - $ref: '#/components/schemas/String' - - description: 'Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.' - description: 'Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.' - NatGatewayState: - type: string - enum: - - pending - - failed - - available - - deleting - - deleted - NatGatewayAddress: - type: object - properties: - allocationId: - allOf: - - $ref: '#/components/schemas/String' - - description: '[Public NAT gateway only] The allocation ID of the Elastic IP address that''s associated with the NAT gateway.' - networkInterfaceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the network interface associated with the NAT gateway. - privateIp: - allOf: - - $ref: '#/components/schemas/String' - - description: The private IP address associated with the NAT gateway. - publicIp: - allOf: - - $ref: '#/components/schemas/String' - - description: '[Public NAT gateway only] The Elastic IP address associated with the NAT gateway.' - description: Describes the IP addresses and network interface associated with a NAT gateway. - NatGatewayIdStringList: - type: array - items: - allOf: - - $ref: '#/components/schemas/NatGatewayId' - - xml: - name: item - NetworkAclAssociationList: - type: array - items: - allOf: - - $ref: '#/components/schemas/NetworkAclAssociation' - - xml: - name: item - NetworkAclEntryList: - type: array - items: - allOf: - - $ref: '#/components/schemas/NetworkAclEntry' - - xml: - name: item - NetworkAclAssociation: - type: object - properties: - networkAclAssociationId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the association between a network ACL and a subnet. - networkAclId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the network ACL. - subnetId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the subnet. - description: Describes an association between a network ACL and a subnet. - NetworkAclAssociationId: - type: string - NetworkAclEntry: - type: object - properties: - cidrBlock: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The IPv4 network range to allow or deny, in CIDR notation.' - egress: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether the rule is an egress rule (applied to traffic leaving the subnet). - icmpTypeCode: - allOf: - - $ref: '#/components/schemas/IcmpTypeCode' - - description: 'ICMP protocol: The ICMP type and code.' - ipv6CidrBlock: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The IPv6 network range to allow or deny, in CIDR notation.' - portRange: - allOf: - - $ref: '#/components/schemas/PortRange' - - description: 'TCP or UDP protocols: The range of ports the rule applies to.' - protocol: - allOf: - - $ref: '#/components/schemas/String' - - description: The protocol number. A value of "-1" means all protocols. - ruleAction: - allOf: - - $ref: '#/components/schemas/RuleAction' - - description: Indicates whether to allow or deny the traffic that matches the rule. - ruleNumber: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The rule number for the entry. ACL entries are processed in ascending order by rule number. - description: Describes an entry in a network ACL. - NetworkAclIdStringList: - type: array - items: - allOf: - - $ref: '#/components/schemas/NetworkAclId' - - xml: - name: item - NetworkCardIndex: - type: integer - NetworkPerformance: - type: string - NetworkCardInfo: - type: object - properties: - networkCardIndex: - allOf: - - $ref: '#/components/schemas/NetworkCardIndex' - - description: The index of the network card. - networkPerformance: - allOf: - - $ref: '#/components/schemas/NetworkPerformance' - - description: The network performance of the network card. - maximumNetworkInterfaces: - allOf: - - $ref: '#/components/schemas/MaxNetworkInterfaces' - - description: The maximum number of network interfaces for the network card. - description: Describes the network card support of the instance type. - NetworkCardInfoList: - type: array - items: - allOf: - - $ref: '#/components/schemas/NetworkCardInfo' - - xml: - name: item - NetworkInsightsAccessScopeAnalysis: - type: object - properties: - networkInsightsAccessScopeAnalysisId: - allOf: - - $ref: '#/components/schemas/NetworkInsightsAccessScopeAnalysisId' - - description: The ID of the Network Access Scope analysis. - networkInsightsAccessScopeAnalysisArn: - allOf: - - $ref: '#/components/schemas/ResourceArn' - - description: The Amazon Resource Name (ARN) of the Network Access Scope analysis. - networkInsightsAccessScopeId: - allOf: - - $ref: '#/components/schemas/NetworkInsightsAccessScopeId' - - description: The ID of the Network Access Scope. - status: - allOf: - - $ref: '#/components/schemas/AnalysisStatus' - - description: The status. - statusMessage: - allOf: - - $ref: '#/components/schemas/String' - - description: The status message. - warningMessage: - allOf: - - $ref: '#/components/schemas/String' - - description: The warning message. - startDate: - allOf: - - $ref: '#/components/schemas/MillisecondDateTime' - - description: The analysis start date. - endDate: - allOf: - - $ref: '#/components/schemas/MillisecondDateTime' - - description: The analysis end date. - findingsFound: - allOf: - - $ref: '#/components/schemas/FindingsFound' - - description: Indicates whether there are findings. - analyzedEniCount: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The number of network interfaces analyzed. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: The tags. - description: Describes a Network Access Scope analysis. - NetworkInsightsAccessScopeAnalysisIdList: - type: array - items: - allOf: - - $ref: '#/components/schemas/NetworkInsightsAccessScopeAnalysisId' - - xml: - name: item - NetworkInsightsAnalysis: - type: object - properties: - networkInsightsAnalysisId: - allOf: - - $ref: '#/components/schemas/NetworkInsightsAnalysisId' - - description: The ID of the network insights analysis. - networkInsightsAnalysisArn: - allOf: - - $ref: '#/components/schemas/ResourceArn' - - description: The Amazon Resource Name (ARN) of the network insights analysis. - networkInsightsPathId: - allOf: - - $ref: '#/components/schemas/NetworkInsightsPathId' - - description: The ID of the path. - filterInArnSet: - allOf: - - $ref: '#/components/schemas/ArnList' - - description: The Amazon Resource Names (ARN) of the Amazon Web Services resources that the path must traverse. - startDate: - allOf: - - $ref: '#/components/schemas/MillisecondDateTime' - - description: The time the analysis started. - status: - allOf: - - $ref: '#/components/schemas/AnalysisStatus' - - description: The status of the network insights analysis. - statusMessage: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The status message, if the status is failed.' - warningMessage: - allOf: - - $ref: '#/components/schemas/String' - - description: The warning message. - networkPathFound: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether the destination is reachable from the source. - forwardPathComponentSet: - allOf: - - $ref: '#/components/schemas/PathComponentList' - - description: The components in the path from source to destination. - returnPathComponentSet: - allOf: - - $ref: '#/components/schemas/PathComponentList' - - description: The components in the path from destination to source. - explanationSet: - allOf: - - $ref: '#/components/schemas/ExplanationList' - - description: 'The explanations. For more information, see Reachability Analyzer explanation codes.' - alternatePathHintSet: - allOf: - - $ref: '#/components/schemas/AlternatePathHintList' - - description: Potential intermediate components. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: The tags. - description: Describes a network insights analysis. - NetworkInsightsAnalysisIdList: - type: array - items: - allOf: - - $ref: '#/components/schemas/NetworkInsightsAnalysisId' - - xml: - name: item - NetworkInsightsMaxResults: - type: integer - minimum: 1 - maximum: 100 - Protocol: - type: string - enum: - - tcp - - udp - NetworkInsightsResourceId: - type: string - NetworkInterfaceAssociation: - type: object - properties: - allocationId: - allOf: - - $ref: '#/components/schemas/String' - - description: The allocation ID. - associationId: - allOf: - - $ref: '#/components/schemas/String' - - description: The association ID. - ipOwnerId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Elastic IP address owner. - publicDnsName: - allOf: - - $ref: '#/components/schemas/String' - - description: The public DNS name. - publicIp: - allOf: - - $ref: '#/components/schemas/String' - - description: The address of the Elastic IP address bound to the network interface. - customerOwnedIp: - allOf: - - $ref: '#/components/schemas/String' - - description: The customer-owned IP address associated with the network interface. - carrierIp: - allOf: - - $ref: '#/components/schemas/String' - - description:

The carrier IP address associated with the network interface.

This option is only available when the network interface is in a subnet which is associated with a Wavelength Zone.

- description: 'Describes association information for an Elastic IP address (IPv4 only), or a Carrier IP address (for a network interface which resides in a subnet in a Wavelength Zone).' - NetworkInterfaceType: - type: string - enum: - - interface - - natGateway - - efa - - trunk - - load_balancer - - network_load_balancer - - vpc_endpoint - - branch - - transit_gateway - - lambda - - quicksight - - global_accelerator_managed - - api_gateway_managed - - gateway_load_balancer - - gateway_load_balancer_endpoint - - iot_rules_managed - - aws_codestar_connections_managed - NetworkInterfaceIpv6AddressesList: - type: array - items: - allOf: - - $ref: '#/components/schemas/NetworkInterfaceIpv6Address' - - xml: - name: item - NetworkInterfacePrivateIpAddressList: - type: array - items: - allOf: - - $ref: '#/components/schemas/NetworkInterfacePrivateIpAddress' - - xml: - name: item - NetworkInterfaceCountRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The maximum number of network interfaces. To specify no maximum limit, omit this parameter.' - description: The minimum and maximum number of network interfaces. - NetworkInterfaceIdList: - type: array - items: - allOf: - - $ref: '#/components/schemas/NetworkInterfaceId' - - xml: - name: item - NetworkInterfaceIpv6Address: - type: object - properties: - ipv6Address: - allOf: - - $ref: '#/components/schemas/String' - - description: The IPv6 address. - description: Describes an IPv6 address associated with a network interface. - NetworkInterfacePermissionState: - type: object - properties: - state: - allOf: - - $ref: '#/components/schemas/NetworkInterfacePermissionStateCode' - - description: The state of the permission. - statusMessage: - allOf: - - $ref: '#/components/schemas/String' - - description: 'A status message, if applicable.' - description: Describes the state of a network interface permission. - NetworkInterfacePermissionStateCode: - type: string - enum: - - pending - - granted - - revoking - - revoked - NetworkInterfacePrivateIpAddress: - type: object - properties: - association: - allOf: - - $ref: '#/components/schemas/NetworkInterfaceAssociation' - - description: The association information for an Elastic IP address (IPv4) associated with the network interface. - primary: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether this IPv4 address is the primary private IPv4 address of the network interface. - privateDnsName: - allOf: - - $ref: '#/components/schemas/String' - - description: The private DNS name. - privateIpAddress: - allOf: - - $ref: '#/components/schemas/String' - - description: The private IPv4 address. - description: Describes the private IPv4 address of a network interface. - OccurrenceDayRequestSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/Integer' - - xml: - name: OccurenceDay - OccurrenceDaySet: - type: array - items: - allOf: - - $ref: '#/components/schemas/Integer' - - xml: - name: item - OnDemandOptionsRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The maximum amount per hour for On-Demand Instances that you're willing to pay. - description: Describes the configuration of On-Demand Instances in an EC2 Fleet. - ProtocolList: - type: array - items: - allOf: - - $ref: '#/components/schemas/Protocol' - - xml: - name: item - PacketHeaderStatement: - type: object - properties: - sourceAddressSet: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The source addresses. - destinationAddressSet: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The destination addresses. - sourcePortSet: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The source ports. - destinationPortSet: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The destination ports. - sourcePrefixListSet: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The source prefix lists. - destinationPrefixListSet: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The destination prefix lists. - protocolSet: - allOf: - - $ref: '#/components/schemas/ProtocolList' - - description: The protocols. - description: Describes a packet header statement. - PacketHeaderStatementRequest: - type: object - properties: - SourceAddress: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The source addresses. - DestinationAddress: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The destination addresses. - SourcePort: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The source ports. - DestinationPort: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The destination ports. - SourcePrefixList: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The source prefix lists. - DestinationPrefixList: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The destination prefix lists. - Protocol: - allOf: - - $ref: '#/components/schemas/ProtocolList' - - description: The protocols. - description: Describes a packet header statement. - PartitionLoadFrequency: - type: string - enum: - - none - - daily - - weekly - - monthly - PathComponent: - type: object - properties: - sequenceNumber: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The sequence number. - aclRule: - allOf: - - $ref: '#/components/schemas/AnalysisAclRule' - - description: The network ACL rule. - attachedTo: - allOf: - - $ref: '#/components/schemas/AnalysisComponent' - - description: The resource to which the path component is attached. - component: - allOf: - - $ref: '#/components/schemas/AnalysisComponent' - - description: The component. - destinationVpc: - allOf: - - $ref: '#/components/schemas/AnalysisComponent' - - description: The destination VPC. - outboundHeader: - allOf: - - $ref: '#/components/schemas/AnalysisPacketHeader' - - description: The outbound header. - inboundHeader: - allOf: - - $ref: '#/components/schemas/AnalysisPacketHeader' - - description: The inbound header. - routeTableRoute: - allOf: - - $ref: '#/components/schemas/AnalysisRouteTableRoute' - - description: The route table route. - securityGroupRule: - allOf: - - $ref: '#/components/schemas/AnalysisSecurityGroupRule' - - description: The security group rule. - sourceVpc: - allOf: - - $ref: '#/components/schemas/AnalysisComponent' - - description: The source VPC. - subnet: - allOf: - - $ref: '#/components/schemas/AnalysisComponent' - - description: The subnet. - vpc: - allOf: - - $ref: '#/components/schemas/AnalysisComponent' - - description: The component VPC. - additionalDetailSet: - allOf: - - $ref: '#/components/schemas/AdditionalDetailList' - - description: The additional details. - transitGateway: - $ref: '#/components/schemas/AnalysisComponent' - transitGatewayRouteTableRoute: - allOf: - - $ref: '#/components/schemas/TransitGatewayRouteTableRoute' - - description: The route in a transit gateway route table. - description: Describes a path component. - ResourceStatement: - type: object - properties: - resourceSet: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The resources. - resourceTypeSet: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The resource types. - description: Describes a resource statement. - ResourceStatementRequest: - type: object - properties: - Resource: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The resources. - ResourceType: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The resource types. - description: Describes a resource statement. - PeeringAttachmentStatus: - type: object - properties: - code: - allOf: - - $ref: '#/components/schemas/String' - - description: The status code. - message: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The status message, if applicable.' - description: The status of the transit gateway peering attachment. - PeeringConnectionOptionsRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'If true, enables outbound communication from instances in a local VPC to an EC2-Classic instance that''s linked to a peer VPC using ClassicLink.' - description: The VPC peering connection options. - PeeringTgwInfo: - type: object - properties: - transitGatewayId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the transit gateway. - ownerId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Amazon Web Services account that owns the transit gateway. - region: - allOf: - - $ref: '#/components/schemas/String' - - description: The Region of the transit gateway. - description: Information about the transit gateway in the peering attachment. - Phase1DHGroupNumbersListValue: - type: object - properties: - value: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The Diffie-Hellmann group number. - description: The Diffie-Hellmann group number for phase 1 IKE negotiations. - Phase1DHGroupNumbersList: - type: array - items: - allOf: - - $ref: '#/components/schemas/Phase1DHGroupNumbersListValue' - - xml: - name: item - Phase1DHGroupNumbersRequestListValue: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The Diffie-Hellmann group number. - description: Specifies a Diffie-Hellman group number for the VPN tunnel for phase 1 IKE negotiations. - Phase1EncryptionAlgorithmsListValue: - type: object - properties: - value: - allOf: - - $ref: '#/components/schemas/String' - - description: The value for the encryption algorithm. - description: The encryption algorithm for phase 1 IKE negotiations. - Phase1EncryptionAlgorithmsList: - type: array - items: - allOf: - - $ref: '#/components/schemas/Phase1EncryptionAlgorithmsListValue' - - xml: - name: item - Phase1EncryptionAlgorithmsRequestListValue: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The value for the encryption algorithm. - description: Specifies the encryption algorithm for the VPN tunnel for phase 1 IKE negotiations. - Phase1IntegrityAlgorithmsListValue: - type: object - properties: - value: - allOf: - - $ref: '#/components/schemas/String' - - description: The value for the integrity algorithm. - description: The integrity algorithm for phase 1 IKE negotiations. - Phase1IntegrityAlgorithmsList: - type: array - items: - allOf: - - $ref: '#/components/schemas/Phase1IntegrityAlgorithmsListValue' - - xml: - name: item - Phase1IntegrityAlgorithmsRequestListValue: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The value for the integrity algorithm. - description: Specifies the integrity algorithm for the VPN tunnel for phase 1 IKE negotiations. - Phase2DHGroupNumbersListValue: - type: object - properties: - value: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The Diffie-Hellmann group number. - description: The Diffie-Hellmann group number for phase 2 IKE negotiations. - Phase2DHGroupNumbersList: - type: array - items: - allOf: - - $ref: '#/components/schemas/Phase2DHGroupNumbersListValue' - - xml: - name: item - Phase2DHGroupNumbersRequestListValue: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The Diffie-Hellmann group number. - description: Specifies a Diffie-Hellman group number for the VPN tunnel for phase 2 IKE negotiations. - Phase2EncryptionAlgorithmsListValue: - type: object - properties: - value: - allOf: - - $ref: '#/components/schemas/String' - - description: The encryption algorithm. - description: The encryption algorithm for phase 2 IKE negotiations. - Phase2EncryptionAlgorithmsList: - type: array - items: - allOf: - - $ref: '#/components/schemas/Phase2EncryptionAlgorithmsListValue' - - xml: - name: item - Phase2EncryptionAlgorithmsRequestListValue: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The encryption algorithm. - description: Specifies the encryption algorithm for the VPN tunnel for phase 2 IKE negotiations. - Phase2IntegrityAlgorithmsListValue: - type: object - properties: - value: - allOf: - - $ref: '#/components/schemas/String' - - description: The integrity algorithm. - description: The integrity algorithm for phase 2 IKE negotiations. - Phase2IntegrityAlgorithmsList: - type: array - items: - allOf: - - $ref: '#/components/schemas/Phase2IntegrityAlgorithmsListValue' - - xml: - name: item - Phase2IntegrityAlgorithmsRequestListValue: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The integrity algorithm. - description: Specifies the integrity algorithm for the VPN tunnel for phase 2 IKE negotiations. - PlacementGroupState: - type: string - enum: - - pending - - available - - deleting - - deleted - PlacementStrategy: - type: string - enum: - - cluster - - spread - - partition - PlacementGroupStrategyList: - type: array - items: - allOf: - - $ref: '#/components/schemas/PlacementGroupStrategy' - - xml: - name: item - PlacementGroupStrategy: - type: string - enum: - - cluster - - partition - - spread - PoolCidrBlock: - type: object - properties: - poolCidrBlock: - allOf: - - $ref: '#/components/schemas/String' - - description: The CIDR block. - description: Describes a CIDR block for an address pool. - PrefixList: - type: object - properties: - cidrSet: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The IP address range of the Amazon Web Service. - prefixListId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the prefix. - prefixListName: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of the prefix. - description: Describes prefixes for Amazon Web Services services. - PrefixListAssociation: - type: object - properties: - resourceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the resource. - resourceOwner: - allOf: - - $ref: '#/components/schemas/String' - - description: The owner of the resource. - description: Describes the resource with which a prefix list is associated. - PrefixListEntry: - type: object - properties: - cidr: - allOf: - - $ref: '#/components/schemas/String' - - description: The CIDR block. - description: - allOf: - - $ref: '#/components/schemas/String' - - description: The description. - description: Describes a prefix list entry. - PrefixListId: - type: object - properties: - description: - allOf: - - $ref: '#/components/schemas/String' - - description: '

A description for the security group rule that references this prefix list ID.

Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*

' - prefixListId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the prefix. - description: Describes a prefix list ID. - PrefixListIdSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - PrefixListMaxResults: - type: integer - minimum: 1 - maximum: 100 - PriceSchedule: - type: object - properties: - active: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: '

The current price schedule, as determined by the term remaining for the Reserved Instance in the listing.

A specific price schedule is always in effect, but only one price schedule can be active at any time. Take, for example, a Reserved Instance listing that has five months remaining in its term. When you specify price schedules for five months and two months, this means that schedule 1, covering the first three months of the remaining term, will be active during months 5, 4, and 3. Then schedule 2, covering the last two months of the term, will be active for months 2 and 1.

' - currencyCode: - allOf: - - $ref: '#/components/schemas/CurrencyCodeValues' - - description: 'The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD.' - price: - allOf: - - $ref: '#/components/schemas/Double' - - description: The fixed price for the term. - term: - allOf: - - $ref: '#/components/schemas/Long' - - description: 'The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.' - description: Describes the price for a Reserved Instance. - PriceScheduleList: - type: array - items: - allOf: - - $ref: '#/components/schemas/PriceSchedule' - - xml: - name: item - PricingDetail: - type: object - properties: - count: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The number of reservations available for the price. - price: - allOf: - - $ref: '#/components/schemas/Double' - - description: The price per instance. - description: Describes a Reserved Instance offering. - PricingDetailsList: - type: array - items: - allOf: - - $ref: '#/components/schemas/PricingDetail' - - xml: - name: item - PrincipalIdFormat: - type: object - properties: - arn: - allOf: - - $ref: '#/components/schemas/String' - - description: PrincipalIdFormatARN description - statusSet: - allOf: - - $ref: '#/components/schemas/IdFormatList' - - description: PrincipalIdFormatStatuses description - description: PrincipalIdFormat description - PrivateDnsDetails: - type: object - properties: - privateDnsName: - allOf: - - $ref: '#/components/schemas/String' - - description: The private DNS name assigned to the VPC endpoint service. - description: Information about the Private DNS name for interface endpoints. - PrivateDnsDetailsSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/PrivateDnsDetails' - - xml: - name: item - PrivateDnsNameConfiguration: - type: object - properties: - state: - allOf: - - $ref: '#/components/schemas/DnsNameState' - - description:

The verification state of the VPC endpoint service.

>Consumers of the endpoint service can use the private name only when the state is verified.

- type: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The endpoint service verification type, for example TXT.' - value: - allOf: - - $ref: '#/components/schemas/String' - - description: The value the service provider adds to the private DNS name domain record before verification. - name: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of the record subdomain the service provider needs to create. The service provider adds the value text to the name. - description: Information about the private DNS name for the service endpoint. - PrivateDnsNameOptionsOnLaunch: - type: object - properties: - hostnameType: - allOf: - - $ref: '#/components/schemas/HostnameType' - - description: 'The type of hostname for EC2 instances. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance IPv4 address or the instance ID.' - enableResourceNameDnsARecord: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether to respond to DNS queries for instance hostnames with DNS A records. - enableResourceNameDnsAAAARecord: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether to respond to DNS queries for instance hostname with DNS AAAA records. - description: Describes the options for instance hostnames. - PrivateDnsNameOptionsRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records. - description: Describes the options for instance hostnames. - ScheduledInstancesPrivateIpAddressConfig: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The IPv4 address. - description: Describes a private IPv4 address for a Scheduled Instance. - PrivateIpAddressConfigSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/ScheduledInstancesPrivateIpAddressConfig' - - xml: - name: PrivateIpAddressConfigSet - ProcessorSustainedClockSpeed: - type: number - format: double - ProductCodeValues: - type: string - enum: - - devpay - - marketplace - ProductCode: - type: object - properties: - productCode: - allOf: - - $ref: '#/components/schemas/String' - - description: The product code. - type: - allOf: - - $ref: '#/components/schemas/ProductCodeValues' - - description: The type of product code. - description: Describes a product code. - PropagatingVgw: - type: object - properties: - gatewayId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the virtual private gateway. - description: Describes a virtual private gateway propagating route. - PropagatingVgwList: - type: array - items: - allOf: - - $ref: '#/components/schemas/PropagatingVgw' - - xml: - name: item - ProvisionByoipCidrRequest: - type: object - required: - - Cidr - title: ProvisionByoipCidrRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - PoolTagSpecification: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Reserved. - ProvisionIpamPoolCidrRequest: - type: object - required: - - IpamPoolId - title: ProvisionIpamPoolCidrRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/IpamCidrAuthorizationContext' - - description: A signed document that proves that you are authorized to bring a specified IP address range to Amazon using BYOIP. This option applies to public pools only. - ProvisionPublicIpv4PoolCidrRequest: - type: object - required: - - IpamPoolId - - PoolId - - NetmaskLength - title: ProvisionPublicIpv4PoolCidrRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The netmask length of the CIDR you would like to allocate to the public IPv4 pool. - PublicIpv4PoolRange: - type: object - properties: - firstAddress: - allOf: - - $ref: '#/components/schemas/String' - - description: The first IP address in the range. - lastAddress: - allOf: - - $ref: '#/components/schemas/String' - - description: The last IP address in the range. - addressCount: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The number of addresses in the range. - availableAddressCount: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The number of available addresses in the range. - description: Describes an address range of an IPv4 address pool. - PublicIpv4PoolRangeSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/PublicIpv4PoolRange' - - xml: - name: item - PublicIpv4Pool: - type: object - properties: - poolId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the address pool. - description: - allOf: - - $ref: '#/components/schemas/String' - - description: A description of the address pool. - poolAddressRangeSet: - allOf: - - $ref: '#/components/schemas/PublicIpv4PoolRangeSet' - - description: The address ranges. - totalAddressCount: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The total number of addresses. - totalAvailableAddressCount: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The total number of available addresses. - networkBorderGroup: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of the location from which the address pool is advertised. A network border group is a unique set of Availability Zones or Local Zones from where Amazon Web Services advertises public IP addresses. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: Any tags for the address pool. - description: Describes an IPv4 address pool. - PublicIpv4PoolIdStringList: - type: array - items: - allOf: - - $ref: '#/components/schemas/Ipv4PoolEc2Id' - - xml: - name: item - Purchase: - type: object - properties: - currencyCode: - allOf: - - $ref: '#/components/schemas/CurrencyCodeValues' - - description: 'The currency in which the UpfrontPrice and HourlyPrice amounts are specified. At this time, the only supported currency is USD.' - duration: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The duration of the reservation's term in seconds. - hostIdSet: - allOf: - - $ref: '#/components/schemas/ResponseHostIdSet' - - description: The IDs of the Dedicated Hosts associated with the reservation. - hostReservationId: - allOf: - - $ref: '#/components/schemas/HostReservationId' - - description: The ID of the reservation. - hourlyPrice: - allOf: - - $ref: '#/components/schemas/String' - - description: The hourly price of the reservation per hour. - instanceFamily: - allOf: - - $ref: '#/components/schemas/String' - - description: The instance family on the Dedicated Host that the reservation can be associated with. - paymentOption: - allOf: - - $ref: '#/components/schemas/PaymentOption' - - description: The payment option for the reservation. - upfrontPrice: - allOf: - - $ref: '#/components/schemas/String' - - description: The upfront price of the reservation. - description: Describes the result of the purchase. - PurchaseHostReservationRequest: - type: object - required: - - HostIdSet - - OfferingId - title: PurchaseHostReservationRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/OfferingId' - - description: The ID of the offering. - TagSpecification: - allOf: - - $ref: '#/components/schemas/TagSpecificationList' - - description: The tags to apply to the Dedicated Host Reservation during purchase. - PurchaseRequestSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/PurchaseRequest' - - xml: - name: PurchaseRequest - minItems: 1 - PurchaseReservedInstancesOfferingRequest: - type: object - required: - - InstanceCount - - ReservedInstancesOfferingId - title: PurchaseReservedInstancesOfferingRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/ReservedInstancesOfferingId' - - description: The ID of the Reserved Instance offering to purchase. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - limitPrice: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: 'The time at which to purchase the Reserved Instance, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).' - description: Contains the parameters for PurchaseReservedInstancesOffering. - PurchaseScheduledInstancesRequest: - type: object - required: - - PurchaseRequests - title: PurchaseScheduledInstancesRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - PurchaseRequest: - allOf: - - $ref: '#/components/schemas/PurchaseRequestSet' - - description: The purchase requests. - description: Contains the parameters for PurchaseScheduledInstances. - PurchasedScheduledInstanceSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/ScheduledInstance' - - xml: - name: item - ScheduledInstance: - type: object - properties: - availabilityZone: - allOf: - - $ref: '#/components/schemas/String' - - description: The Availability Zone. - createDate: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The date when the Scheduled Instance was purchased. - hourlyPrice: - allOf: - - $ref: '#/components/schemas/String' - - description: The hourly price for a single instance. - instanceCount: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The number of instances. - instanceType: - allOf: - - $ref: '#/components/schemas/String' - - description: The instance type. - networkPlatform: - allOf: - - $ref: '#/components/schemas/String' - - description: The network platform (EC2-Classic or EC2-VPC). - nextSlotStartTime: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The time for the next schedule to start. - platform: - allOf: - - $ref: '#/components/schemas/String' - - description: The platform (Linux/UNIX or Windows). - previousSlotEndTime: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The time that the previous schedule ended or will end. - recurrence: - allOf: - - $ref: '#/components/schemas/ScheduledInstanceRecurrence' - - description: The schedule recurrence. - scheduledInstanceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The Scheduled Instance ID. - slotDurationInHours: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The number of hours in the schedule. - termEndDate: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The end date for the Scheduled Instance. - termStartDate: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The start date for the Scheduled Instance. - totalScheduledInstanceHours: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The total number of hours for a single instance for the entire term. - description: Describes a Scheduled Instance. - ReasonCodesList: - type: array - items: - allOf: - - $ref: '#/components/schemas/ReportInstanceReasonCodes' - - xml: - name: item - RebootInstancesRequest: - type: object - required: - - InstanceIds - title: RebootInstancesRequest - properties: - InstanceId: - allOf: - - $ref: '#/components/schemas/InstanceIdStringList' - - description: The instance IDs. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - RecurringChargeFrequency: - type: string - enum: - - Hourly - RecurringCharge: - type: object - properties: - amount: - allOf: - - $ref: '#/components/schemas/Double' - - description: The amount of the recurring charge. - frequency: - allOf: - - $ref: '#/components/schemas/RecurringChargeFrequency' - - description: The frequency of the recurring charge. - description: Describes a recurring charge. - RecurringChargesList: - type: array - items: - allOf: - - $ref: '#/components/schemas/RecurringCharge' - - xml: - name: item - ReferencedSecurityGroup: - type: object - properties: - groupId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the security group. - peeringStatus: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The status of a VPC peering connection, if applicable.' - userId: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Web Services account ID. - vpcId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the VPC. - vpcPeeringConnectionId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the VPC peering connection. - description: ' Describes the security group that is referenced in the security group rule.' - Region: - type: object - properties: - regionEndpoint: - allOf: - - $ref: '#/components/schemas/String' - - description: The Region service endpoint. - regionName: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of the Region. - optInStatus: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The Region opt-in status. The possible values are opt-in-not-required, opted-in, and not-opted-in.' - description: Describes a Region. - RegionNames: - type: array - items: - $ref: '#/components/schemas/String' - minItems: 0 - maxItems: 10 - StringType: - type: string - minLength: 0 - maxLength: 64000 - RegisterImageRequest: - type: object - required: - - Name - title: RegisterImageRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The full path to your AMI manifest in Amazon S3 storage. The specified bucket must have the aws-exec-read canned access control list (ACL) to ensure that it can be accessed by Amazon EC2. For more information, see Canned ACLs in the Amazon S3 Service Developer Guide.' - architecture: - allOf: - - $ref: '#/components/schemas/ArchitectureValues' - - description: '

The architecture of the AMI.

Default: For Amazon EBS-backed AMIs, i386. For instance store-backed AMIs, the architecture specified in the manifest file.

' - BlockDeviceMapping: - allOf: - - $ref: '#/components/schemas/BlockDeviceMappingRequestList' - - description: '

The block device mapping entries.

If you specify an Amazon EBS volume using the ID of an Amazon EBS snapshot, you can''t specify the encryption state of the volume.

If you create an AMI on an Outpost, then all backing snapshots must be on the same Outpost or in the Region of that Outpost. AMIs on an Outpost that include local snapshots can be used to launch instances on the same Outpost only. For more information, Amazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.

' - description: - allOf: - - $ref: '#/components/schemas/String' - - description: A description for your AMI. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - enaSupport: - allOf: - - $ref: '#/components/schemas/Boolean' - - description:

Set to true to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI.

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

- kernelId: - allOf: - - $ref: '#/components/schemas/KernelId' - - description: The ID of the kernel. - name: - allOf: - - $ref: '#/components/schemas/String' - - description: '

A name for your AMI.

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes (''), at-signs (@), or underscores(_)

' - BillingProduct: - allOf: - - $ref: '#/components/schemas/BillingProductList' - - description: 'The billing product codes. Your account must be authorized to specify billing product codes. Otherwise, you can use the Amazon Web Services Marketplace to bill for the use of an AMI.' - ramdiskId: - allOf: - - $ref: '#/components/schemas/RamdiskId' - - description: The ID of the RAM disk. - rootDeviceName: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The device name of the root device volume (for example, /dev/sda1).' - sriovNetSupport: - allOf: - - $ref: '#/components/schemas/String' - - description:

Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the AMI and any instances that you launch from the AMI.

There is no way to disable sriovNetSupport at this time.

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

- virtualizationType: - allOf: - - $ref: '#/components/schemas/StringType' - - description: 'Base64 representation of the non-volatile UEFI variable store. To retrieve the UEFI data, use the GetInstanceUefiData command. You can inspect and modify the UEFI data by using the python-uefivars tool on GitHub. For more information, see UEFI Secure Boot in the Amazon Elastic Compute Cloud User Guide.' - description: Contains the parameters for RegisterImage. - RegisterInstanceTagAttributeRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether to register all tag keys in the current Region. Specify true to register all tag keys. - InstanceTagKey: - allOf: - - $ref: '#/components/schemas/InstanceTagKeySet' - - description: The tag keys to register. - description: Information about the tag keys to register for the current Region. You can either specify individual tag keys or register all tag keys in the current Region. You must specify either IncludeAllTagsOfInstance or InstanceTagKeys in the request - RegisterInstanceEventNotificationAttributesRequest: - type: object - title: RegisterInstanceEventNotificationAttributesRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/RegisterInstanceTagAttributeRequest' - - description: Information about the tag keys to register. - RegisterTransitGatewayMulticastGroupMembersRequest: - type: object - title: RegisterTransitGatewayMulticastGroupMembersRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - TransitGatewayMulticastRegisteredGroupMembers: - type: object - properties: - transitGatewayMulticastDomainId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the transit gateway multicast domain. - registeredNetworkInterfaceIds: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The ID of the registered network interfaces. - groupIpAddress: - allOf: - - $ref: '#/components/schemas/String' - - description: The IP address assigned to the transit gateway multicast group. - description: Describes the registered transit gateway multicast group members. - RegisterTransitGatewayMulticastGroupSourcesRequest: - type: object - title: RegisterTransitGatewayMulticastGroupSourcesRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - TransitGatewayMulticastRegisteredGroupSources: - type: object - properties: - transitGatewayMulticastDomainId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the transit gateway multicast domain. - registeredNetworkInterfaceIds: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The IDs of the network interfaces members registered with the transit gateway multicast group. - groupIpAddress: - allOf: - - $ref: '#/components/schemas/String' - - description: The IP address assigned to the transit gateway multicast group. - description: Describes the members registered with the transit gateway multicast group. - RejectTransitGatewayMulticastDomainAssociationsRequest: - type: object - title: RejectTransitGatewayMulticastDomainAssociationsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - RejectTransitGatewayPeeringAttachmentRequest: - type: object - required: - - TransitGatewayAttachmentId - title: RejectTransitGatewayPeeringAttachmentRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - RejectTransitGatewayVpcAttachmentRequest: - type: object - required: - - TransitGatewayAttachmentId - title: RejectTransitGatewayVpcAttachmentRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - RejectVpcEndpointConnectionsRequest: - type: object - required: - - ServiceId - - VpcEndpointIds - title: RejectVpcEndpointConnectionsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/VpcEndpointServiceId' - - description: The ID of the service. - VpcEndpointId: - allOf: - - $ref: '#/components/schemas/VpcEndpointIdList' - - description: The IDs of one or more VPC endpoints. - RejectVpcPeeringConnectionRequest: - type: object - required: - - VpcPeeringConnectionId - title: RejectVpcPeeringConnectionRequest - properties: - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - vpcPeeringConnectionId: - allOf: - - $ref: '#/components/schemas/VpcPeeringConnectionId' - - description: The ID of the VPC peering connection. - ReleaseAddressRequest: - type: object - title: ReleaseAddressRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: '

The set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses.

If you provide an incorrect network border group, you receive an InvalidAddress.NotFound error.

You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 classic, you receive an InvalidParameterCombination error.

' - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - ReleaseHostsRequest: - type: object - required: - - HostIds - title: ReleaseHostsRequest - properties: - hostId: - allOf: - - $ref: '#/components/schemas/RequestHostIdList' - - description: The IDs of the Dedicated Hosts to release. - ReleaseIpamPoolAllocationRequest: - type: object - required: - - IpamPoolId - - Cidr - - IpamPoolAllocationId - title: ReleaseIpamPoolAllocationRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/IpamPoolAllocationId' - - description: The ID of the allocation. - RemovePrefixListEntries: - type: array - items: - $ref: '#/components/schemas/RemovePrefixListEntry' - minItems: 0 - maxItems: 100 - ReplaceIamInstanceProfileAssociationRequest: - type: object - required: - - IamInstanceProfile - - AssociationId - title: ReplaceIamInstanceProfileAssociationRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/IamInstanceProfileAssociationId' - - description: The ID of the existing IAM instance profile association. - ReplaceNetworkAclAssociationRequest: - type: object - required: - - AssociationId - - NetworkAclId - title: ReplaceNetworkAclAssociationRequest - properties: - associationId: - allOf: - - $ref: '#/components/schemas/NetworkAclAssociationId' - - description: The ID of the current association between the original network ACL and the subnet. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - networkAclId: - allOf: - - $ref: '#/components/schemas/NetworkAclId' - - description: The ID of the new network ACL to associate with the subnet. - ReplaceNetworkAclEntryRequest: - type: object - required: - - Egress - - NetworkAclId - - Protocol - - RuleAction - - RuleNumber - title: ReplaceNetworkAclEntryRequest - properties: - cidrBlock: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The IPv4 network range to allow or deny, in CIDR notation (for example 172.16.0.0/24).' - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - egress: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: '

Indicates whether to replace the egress rule.

Default: If no value is specified, we replace the ingress rule.

' - Icmp: - allOf: - - $ref: '#/components/schemas/IcmpTypeCode' - - description: 'ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block.' - ipv6CidrBlock: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The IPv6 network range to allow or deny, in CIDR notation (for example 2001:bd8:1234:1a00::/64).' - networkAclId: - allOf: - - $ref: '#/components/schemas/NetworkAclId' - - description: The ID of the ACL. - portRange: - allOf: - - $ref: '#/components/schemas/PortRange' - - description: 'TCP or UDP protocols: The range of ports the rule applies to. Required if specifying protocol 6 (TCP) or 17 (UDP).' - protocol: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The protocol number. A value of "-1" means all protocols. If you specify "-1" or a protocol number other than "6" (TCP), "17" (UDP), or "1" (ICMP), traffic on all ports is allowed, regardless of any ports or ICMP types or codes that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP types and codes allowed, regardless of any that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv6 CIDR block, you must specify an ICMP type and code.' - ruleAction: - allOf: - - $ref: '#/components/schemas/RuleAction' - - description: Indicates whether to allow or deny the traffic that matches the rule. - ruleNumber: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The rule number of the entry to replace. - ReplaceRootVolumeTaskState: - type: string - enum: - - pending - - in-progress - - failing - - succeeded - - failed - - failed-detached - ReplaceRouteRequest: - type: object - required: - - RouteTableId - title: ReplaceRouteRequest - properties: - destinationCidrBlock: - allOf: - - $ref: '#/components/schemas/String' - - description: The IPv4 CIDR address block used for the destination match. The value that you provide must match the CIDR of an existing route in the table. - destinationIpv6CidrBlock: - allOf: - - $ref: '#/components/schemas/PrefixListResourceId' - - description: The ID of the prefix list for the route. - dryRun: - allOf: - - $ref: '#/components/schemas/VpcEndpointId' - - description: The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only. - egressOnlyInternetGatewayId: - allOf: - - $ref: '#/components/schemas/EgressOnlyInternetGatewayId' - - description: '[IPv6 traffic only] The ID of an egress-only internet gateway.' - gatewayId: - allOf: - - $ref: '#/components/schemas/RouteGatewayId' - - description: The ID of an internet gateway or virtual private gateway. - instanceId: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Specifies whether to reset the local route to its default target (local). - natGatewayId: - allOf: - - $ref: '#/components/schemas/CarrierGatewayId' - - description: '[IPv4 traffic only] The ID of a carrier gateway.' - networkInterfaceId: - allOf: - - $ref: '#/components/schemas/NetworkInterfaceId' - - description: The ID of a network interface. - routeTableId: - allOf: - - $ref: '#/components/schemas/RouteTableId' - - description: The ID of the route table. - vpcPeeringConnectionId: - allOf: - - $ref: '#/components/schemas/CoreNetworkArn' - - description: The Amazon Resource Name (ARN) of the core network. - ReplaceRouteTableAssociationRequest: - type: object - required: - - AssociationId - - RouteTableId - title: ReplaceRouteTableAssociationRequest - properties: - associationId: - allOf: - - $ref: '#/components/schemas/RouteTableAssociationId' - - description: The association ID. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - routeTableId: - allOf: - - $ref: '#/components/schemas/RouteTableId' - - description: The ID of the new route table to associate with the subnet. - ReplaceTransitGatewayRouteRequest: - type: object - required: - - DestinationCidrBlock - - TransitGatewayRouteTableId - title: ReplaceTransitGatewayRouteRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - ReplacementStrategy: - type: string - enum: - - launch - - launch-before-terminate - ReportStatusType: - type: string - enum: - - ok - - impaired - ReportInstanceStatusRequest: - type: object - required: - - Instances - - ReasonCodes - - Status - title: ReportInstanceStatusRequest - properties: - description: - allOf: - - $ref: '#/components/schemas/String' - - description: Descriptive text about the health state of your instance. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - endTime: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The time at which the reported instance health state ended. - instanceId: - allOf: - - $ref: '#/components/schemas/InstanceIdStringList' - - description: The instances. - reasonCode: - allOf: - - $ref: '#/components/schemas/ReasonCodesList' - - description: '

The reason codes that describe the health state of your instance.

  • instance-stuck-in-state: My instance is stuck in a state.

  • unresponsive: My instance is unresponsive.

  • not-accepting-credentials: My instance is not accepting my credentials.

  • password-not-available: A password is not available for my instance.

  • performance-network: My instance is experiencing performance problems that I believe are network related.

  • performance-instance-store: My instance is experiencing performance problems that I believe are related to the instance stores.

  • performance-ebs-volume: My instance is experiencing performance problems that I believe are related to an EBS volume.

  • performance-other: My instance is experiencing performance problems.

  • other: [explain using the description parameter]

' - startTime: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The time at which the reported instance health state began. - status: - allOf: - - $ref: '#/components/schemas/ReportStatusType' - - description: The status of all instances listed. - RequestHostIdSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/DedicatedHostId' - - xml: - name: item - SpotFleetRequestConfigData: - type: object - required: - - IamFleetRole - - TargetCapacity - properties: - allocationStrategy: - allOf: - - $ref: '#/components/schemas/AllocationStrategy' - - description: '

Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the Spot Fleet request.

If the allocation strategy is lowestPrice, Spot Fleet launches instances from the Spot Instance pools with the lowest price. This is the default allocation strategy.

If the allocation strategy is diversified, Spot Fleet launches instances from all the Spot Instance pools that you specify.

If the allocation strategy is capacityOptimized (recommended), Spot Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching. To give certain instance types a higher chance of launching first, use capacityOptimizedPrioritized. Set a priority for each instance type by using the Priority parameter for LaunchTemplateOverrides. You can assign the same priority to different LaunchTemplateOverrides. EC2 implements the priorities on a best-effort basis, but optimizes for capacity first. capacityOptimizedPrioritized is supported only if your Spot Fleet uses a launch template. Note that if the OnDemandAllocationStrategy is set to prioritized, the same priority is applied when fulfilling On-Demand capacity.

' - onDemandAllocationStrategy: - allOf: - - $ref: '#/components/schemas/OnDemandAllocationStrategy' - - description: 'The order of the launch template overrides to use in fulfilling On-Demand capacity. If you specify lowestPrice, Spot Fleet uses price to determine the order, launching the lowest price first. If you specify prioritized, Spot Fleet uses the priority that you assign to each Spot Fleet launch template override, launching the highest priority first. If you do not specify a value, Spot Fleet defaults to lowestPrice.' - spotMaintenanceStrategies: - allOf: - - $ref: '#/components/schemas/SpotMaintenanceStrategies' - - description: The strategies for managing your Spot Instances that are at an elevated risk of being interrupted. - clientToken: - allOf: - - $ref: '#/components/schemas/String' - - description: 'A unique, case-sensitive identifier that you provide to ensure the idempotency of your listings. This helps to avoid duplicate listings. For more information, see Ensuring Idempotency.' - excessCapacityTerminationPolicy: - allOf: - - $ref: '#/components/schemas/ExcessCapacityTerminationPolicy' - - description: Indicates whether running Spot Instances should be terminated if you decrease the target capacity of the Spot Fleet request below the current size of the Spot Fleet. - fulfilledCapacity: - allOf: - - $ref: '#/components/schemas/Double' - - description: The number of units fulfilled by this request compared to the set target capacity. You cannot set this value. - onDemandFulfilledCapacity: - allOf: - - $ref: '#/components/schemas/Double' - - description: The number of On-Demand units fulfilled by this request compared to the set target On-Demand capacity. - iamFleetRole: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that grants the Spot Fleet the permission to request, launch, terminate, and tag instances on your behalf. For more information, see Spot Fleet prerequisites in the Amazon EC2 User Guide for Linux Instances. Spot Fleet can terminate Spot Instances on your behalf when you cancel its Spot Fleet request using CancelSpotFleetRequests or when the Spot Fleet request expires, if you set TerminateInstancesWithExpiration.' - launchSpecifications: - allOf: - - $ref: '#/components/schemas/LaunchSpecsList' - - description: 'The launch specifications for the Spot Fleet request. If you specify LaunchSpecifications, you can''t specify LaunchTemplateConfigs. If you include On-Demand capacity in your request, you must use LaunchTemplateConfigs.' - launchTemplateConfigs: - allOf: - - $ref: '#/components/schemas/LaunchTemplateConfigList' - - description: 'The launch template and overrides. If you specify LaunchTemplateConfigs, you can''t specify LaunchSpecifications. If you include On-Demand capacity in your request, you must use LaunchTemplateConfigs.' - spotPrice: - allOf: - - $ref: '#/components/schemas/String' - - description: The maximum price per unit hour that you are willing to pay for a Spot Instance. The default is the On-Demand price. - targetCapacity: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The number of units to request for the Spot Fleet. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.' - onDemandTargetCapacity: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The number of On-Demand units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.' - onDemandMaxTotalPrice: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The maximum amount per hour for On-Demand Instances that you''re willing to pay. You can use the onDemandMaxTotalPrice parameter, the spotMaxTotalPrice parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the maximum amount you''re willing to pay. When the maximum amount you''re willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity.' - spotMaxTotalPrice: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The maximum amount per hour for Spot Instances that you''re willing to pay. You can use the spotdMaxTotalPrice parameter, the onDemandMaxTotalPrice parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the maximum amount you''re willing to pay. When the maximum amount you''re willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity.' - terminateInstancesWithExpiration: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether running Spot Instances are terminated when the Spot Fleet request expires. - type: - allOf: - - $ref: '#/components/schemas/FleetType' - - description: 'The type of request. Indicates whether the Spot Fleet only requests the target capacity or also attempts to maintain it. When this value is request, the Spot Fleet only places the required requests. It does not attempt to replenish Spot Instances if capacity is diminished, nor does it submit requests in alternative Spot pools if capacity is not available. When this value is maintain, the Spot Fleet maintains the target capacity. The Spot Fleet places the required requests to meet capacity and automatically replenishes any interrupted instances. Default: maintain. instant is listed but is not used by Spot Fleet.' - validFrom: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: 'The start date and time of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ). By default, Amazon EC2 starts fulfilling the request immediately.' - validUntil: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: 'The end date and time of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ). After the end date and time, no new Spot Instance requests are placed or able to fulfill the request. If no value is specified, the Spot Fleet request remains until you cancel it.' - replaceUnhealthyInstances: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether Spot Fleet should replace unhealthy instances. - instanceInterruptionBehavior: - allOf: - - $ref: '#/components/schemas/InstanceInterruptionBehavior' - - description: The behavior when a Spot Instance is interrupted. The default is terminate. - loadBalancersConfig: - allOf: - - $ref: '#/components/schemas/LoadBalancersConfig' - - description: '

One or more Classic Load Balancers and target groups to attach to the Spot Fleet request. Spot Fleet registers the running Spot Instances with the specified Classic Load Balancers and target groups.

With Network Load Balancers, Spot Fleet cannot register instances that have the following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, M3, and T1.

' - instancePoolsToUseCount: - allOf: - - $ref: '#/components/schemas/Integer' - - description: '

The number of Spot pools across which to allocate your target Spot capacity. Valid only when Spot AllocationStrategy is set to lowest-price. Spot Fleet selects the cheapest Spot pools and evenly allocates your target Spot capacity across the number of Spot pools that you specify.

Note that Spot Fleet attempts to draw Spot Instances from the number of pools that you specify on a best effort basis. If a pool runs out of Spot capacity before fulfilling your target capacity, Spot Fleet will continue to fulfill your request by drawing from the next cheapest pool. To ensure that your target capacity is met, you might receive Spot Instances from more than the number of pools that you specified. Similarly, if most of the pools have no Spot capacity, you might receive your full target capacity from fewer than the number of pools that you specified.

' - context: - allOf: - - $ref: '#/components/schemas/String' - - description: Reserved. - targetCapacityUnitType: - allOf: - - $ref: '#/components/schemas/TargetCapacityUnitType' - - description: '

The unit for the target capacity.

Default: units (translates to number of instances)

' - TagSpecification: - allOf: - - $ref: '#/components/schemas/TagSpecificationList' - - description: 'The key-value pair for tagging the Spot Fleet request on creation. The value for ResourceType must be spot-fleet-request, otherwise the Spot Fleet request fails. To tag instances at launch, specify the tags in the launch template (valid only if you use LaunchTemplateConfigs) or in the SpotFleetTagSpecification (valid only if you use LaunchSpecifications). For information about tagging after launch, see Tagging Your Resources.' - description: Describes the configuration of a Spot Fleet request. - RequestSpotFleetRequest: - type: object - required: - - SpotFleetRequestConfig - title: RequestSpotFleetRequest - properties: - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - spotFleetRequestConfig: - allOf: - - $ref: '#/components/schemas/SpotFleetRequestConfigData' - - description: The configuration for the Spot Fleet request. - description: Contains the parameters for RequestSpotFleet. - RequestSpotLaunchSpecification: - type: object - properties: - SecurityGroupId: - allOf: - - $ref: '#/components/schemas/RequestSpotLaunchSpecificationSecurityGroupIdList' - - description: One or more security group IDs. - SecurityGroup: - allOf: - - $ref: '#/components/schemas/RequestSpotLaunchSpecificationSecurityGroupList' - - description: 'One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.' - addressingType: - allOf: - - $ref: '#/components/schemas/String' - - description: Deprecated. - blockDeviceMapping: - allOf: - - $ref: '#/components/schemas/BlockDeviceMappingList' - - description: 'One or more block device mapping entries. You can''t specify both a snapshot ID and an encryption value. This is because only blank volumes can be encrypted on creation. If a snapshot is the basis for a volume, it is not blank and its encryption status is used for the volume encryption status.' - ebsOptimized: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: '

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn''t available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

Default: false

' - iamInstanceProfile: - allOf: - - $ref: '#/components/schemas/IamInstanceProfileSpecification' - - description: The IAM instance profile. - imageId: - allOf: - - $ref: '#/components/schemas/ImageId' - - description: The ID of the AMI. - instanceType: - allOf: - - $ref: '#/components/schemas/InstanceType' - - description: The instance type. Only one instance type can be specified. - kernelId: - allOf: - - $ref: '#/components/schemas/KernelId' - - description: The ID of the kernel. - keyName: - allOf: - - $ref: '#/components/schemas/KeyPairName' - - description: The name of the key pair. - monitoring: - allOf: - - $ref: '#/components/schemas/RunInstancesMonitoringEnabled' - - description: '

Indicates whether basic or detailed monitoring is enabled for the instance.

Default: Disabled

' - NetworkInterface: - allOf: - - $ref: '#/components/schemas/InstanceNetworkInterfaceSpecificationList' - - description: 'One or more network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface.' - placement: - allOf: - - $ref: '#/components/schemas/SpotPlacement' - - description: The placement information for the instance. - ramdiskId: - allOf: - - $ref: '#/components/schemas/RamdiskId' - - description: The ID of the RAM disk. - subnetId: - allOf: - - $ref: '#/components/schemas/SubnetId' - - description: The ID of the subnet in which to launch the instance. - userData: - allOf: - - $ref: '#/components/schemas/String' - - description: The Base64-encoded user data for the instance. User data is limited to 16 KB. - description: Describes the launch specification for an instance. - RequestSpotInstancesRequest: - type: object - title: RequestSpotInstancesRequest - properties: - availabilityZoneGroup: - allOf: - - $ref: '#/components/schemas/String' - - description: '

The user-specified name for a logical grouping of requests.

When you specify an Availability Zone group in a Spot Instance request, all Spot Instances in the request are launched in the same Availability Zone. Instance proximity is maintained with this parameter, but the choice of Availability Zone is not. The group applies only to requests for Spot Instances of the same instance type. Any additional Spot Instance requests that are specified with the same Availability Zone group name are launched in that same Availability Zone, as long as at least one instance from the group is still active.

If there is no active instance running in the Availability Zone group that you specify for a new Spot Instance request (all instances are terminated, the request is expired, or the maximum price you specified falls below current Spot price), then Amazon EC2 launches the instance in any Availability Zone where the constraint can be met. Consequently, the subsequent set of Spot Instances could be placed in a different zone from the original request, even if you specified the same Availability Zone group.

Default: Instances are launched in any available Availability Zone.

' - blockDurationMinutes: - allOf: - - $ref: '#/components/schemas/Integer' - - description: Deprecated. - clientToken: - allOf: - - $ref: '#/components/schemas/String' - - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon EC2 User Guide for Linux Instances.' - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - instanceCount: - allOf: - - $ref: '#/components/schemas/Integer' - - description: '

The maximum number of Spot Instances to launch.

Default: 1

' - launchGroup: - allOf: - - $ref: '#/components/schemas/RequestSpotLaunchSpecification' - - description: The launch specification. - spotPrice: - allOf: - - $ref: '#/components/schemas/String' - - description: The maximum price per hour that you are willing to pay for a Spot Instance. The default is the On-Demand price. - type: - allOf: - - $ref: '#/components/schemas/SpotInstanceType' - - description: '

The Spot Instance request type.

Default: one-time

' - validFrom: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: '

The start date of the request. If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled.

The specified start date and time cannot be equal to the current date and time. You must specify a start date and time that occurs after the current date and time.

' - validUntil: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: '

The end date of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ).

  • For a persistent request, the request remains active until the ValidUntil date and time is reached. Otherwise, the request remains active until you cancel it.

  • For a one-time request, the request remains active until all instances launch, the request is canceled, or the ValidUntil date and time is reached. By default, the request is valid for 7 days from the date the request was created.

' - TagSpecification: - allOf: - - $ref: '#/components/schemas/InstanceInterruptionBehavior' - - description: The behavior when a Spot Instance is interrupted. The default is terminate. - description: Contains the parameters for RequestSpotInstances. - ReservationFleetInstanceSpecificationList: - type: array - items: - $ref: '#/components/schemas/ReservationFleetInstanceSpecification' - ReservedInstanceLimitPrice: - type: object - properties: - amount: - allOf: - - $ref: '#/components/schemas/Double' - - description: Used for Reserved Instance Marketplace offerings. Specifies the limit price on the total order (instanceCount * price). - currencyCode: - allOf: - - $ref: '#/components/schemas/CurrencyCodeValues' - - description: 'The currency in which the limitPrice amount is specified. At this time, the only supported currency is USD.' - description: Describes the limit price of a Reserved Instance offering. - ReservedInstanceReservationValue: - type: object - properties: - reservationValue: - allOf: - - $ref: '#/components/schemas/ReservationValue' - - description: The total value of the Convertible Reserved Instance that you are exchanging. - reservedInstanceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Convertible Reserved Instance that you are exchanging. - description: The total value of the Convertible Reserved Instance. - ReservedInstanceState: - type: string - enum: - - payment-pending - - active - - payment-failed - - retired - - queued - - queued-deleted - scope: - type: string - enum: - - Availability Zone - - Region - ReservedInstances: - type: object - properties: - availabilityZone: - allOf: - - $ref: '#/components/schemas/String' - - description: The Availability Zone in which the Reserved Instance can be used. - duration: - allOf: - - $ref: '#/components/schemas/Long' - - description: 'The duration of the Reserved Instance, in seconds.' - end: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The time when the Reserved Instance expires. - fixedPrice: - allOf: - - $ref: '#/components/schemas/Float' - - description: The purchase price of the Reserved Instance. - instanceCount: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The number of reservations purchased. - instanceType: - allOf: - - $ref: '#/components/schemas/InstanceType' - - description: The instance type on which the Reserved Instance can be used. - productDescription: - allOf: - - $ref: '#/components/schemas/RIProductDescription' - - description: The Reserved Instance product platform description. - reservedInstancesId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Reserved Instance. - start: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The date and time the Reserved Instance started. - state: - allOf: - - $ref: '#/components/schemas/ReservedInstanceState' - - description: The state of the Reserved Instance purchase. - usagePrice: - allOf: - - $ref: '#/components/schemas/Float' - - description: 'The usage price of the Reserved Instance, per hour.' - currencyCode: - allOf: - - $ref: '#/components/schemas/CurrencyCodeValues' - - description: 'The currency of the Reserved Instance. It''s specified using ISO 4217 standard currency codes. At this time, the only supported currency is USD.' - instanceTenancy: - allOf: - - $ref: '#/components/schemas/Tenancy' - - description: The tenancy of the instance. - offeringClass: - allOf: - - $ref: '#/components/schemas/OfferingClassType' - - description: The offering class of the Reserved Instance. - offeringType: - allOf: - - $ref: '#/components/schemas/OfferingTypeValues' - - description: The Reserved Instance offering type. - recurringCharges: - allOf: - - $ref: '#/components/schemas/RecurringChargesList' - - description: The recurring charge tag assigned to the resource. - scope: - allOf: - - $ref: '#/components/schemas/scope' - - description: The scope of the Reserved Instance. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: Any tags assigned to the resource. - description: Describes a Reserved Instance. - ReservedInstancesId: - type: object - properties: - reservedInstancesId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Reserved Instance. - description: Describes the ID of a Reserved Instance. - ReservedInstancesListing: - type: object - properties: - clientToken: - allOf: - - $ref: '#/components/schemas/String' - - description: 'A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see Ensuring Idempotency.' - createDate: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The time the listing was created. - instanceCounts: - allOf: - - $ref: '#/components/schemas/InstanceCountList' - - description: The number of instances in this state. - priceSchedules: - allOf: - - $ref: '#/components/schemas/PriceScheduleList' - - description: The price of the Reserved Instance listing. - reservedInstancesId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Reserved Instance. - reservedInstancesListingId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Reserved Instance listing. - status: - allOf: - - $ref: '#/components/schemas/ListingStatus' - - description: The status of the Reserved Instance listing. - statusMessage: - allOf: - - $ref: '#/components/schemas/String' - - description: The reason for the current status of the Reserved Instance listing. The response can be blank. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: Any tags assigned to the resource. - updateDate: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The last modified timestamp of the listing. - description: Describes a Reserved Instance listing. - ReservedInstancesModificationResultList: - type: array - items: - allOf: - - $ref: '#/components/schemas/ReservedInstancesModificationResult' - - xml: - name: item - ReservedIntancesIds: - type: array - items: - allOf: - - $ref: '#/components/schemas/ReservedInstancesId' - - xml: - name: item - ReservedInstancesModification: - type: object - properties: - clientToken: - allOf: - - $ref: '#/components/schemas/String' - - description: 'A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see Ensuring Idempotency.' - createDate: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The time when the modification request was created. - effectiveDate: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The time for the modification to become effective. - modificationResultSet: - allOf: - - $ref: '#/components/schemas/ReservedInstancesModificationResultList' - - description: Contains target configurations along with their corresponding new Reserved Instance IDs. - reservedInstancesSet: - allOf: - - $ref: '#/components/schemas/ReservedIntancesIds' - - description: The IDs of one or more Reserved Instances. - reservedInstancesModificationId: - allOf: - - $ref: '#/components/schemas/String' - - description: A unique ID for the Reserved Instance modification. - status: - allOf: - - $ref: '#/components/schemas/String' - - description: The status of the Reserved Instances modification request. - statusMessage: - allOf: - - $ref: '#/components/schemas/String' - - description: The reason for the status. - updateDate: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The time when the modification request was last updated. - description: Describes a Reserved Instance modification. - ReservedInstancesModificationResult: - type: object - properties: - reservedInstancesId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID for the Reserved Instances that were created as part of the modification request. This field is only available when the modification is fulfilled. - targetConfiguration: - allOf: - - $ref: '#/components/schemas/ReservedInstancesConfiguration' - - description: The target Reserved Instances configurations supplied as part of the modification request. - description: Describes the modification request/s. - ReservedInstancesOffering: - type: object - properties: - availabilityZone: - allOf: - - $ref: '#/components/schemas/String' - - description: The Availability Zone in which the Reserved Instance can be used. - duration: - allOf: - - $ref: '#/components/schemas/Long' - - description: 'The duration of the Reserved Instance, in seconds.' - fixedPrice: - allOf: - - $ref: '#/components/schemas/Float' - - description: The purchase price of the Reserved Instance. - instanceType: - allOf: - - $ref: '#/components/schemas/InstanceType' - - description: The instance type on which the Reserved Instance can be used. - productDescription: - allOf: - - $ref: '#/components/schemas/RIProductDescription' - - description: The Reserved Instance product platform description. - reservedInstancesOfferingId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Reserved Instance offering. This is the offering ID used in GetReservedInstancesExchangeQuote to confirm that an exchange can be made. - usagePrice: - allOf: - - $ref: '#/components/schemas/Float' - - description: 'The usage price of the Reserved Instance, per hour.' - currencyCode: - allOf: - - $ref: '#/components/schemas/CurrencyCodeValues' - - description: 'The currency of the Reserved Instance offering you are purchasing. It''s specified using ISO 4217 standard currency codes. At this time, the only supported currency is USD.' - instanceTenancy: - allOf: - - $ref: '#/components/schemas/Tenancy' - - description: The tenancy of the instance. - marketplace: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Indicates whether the offering is available through the Reserved Instance Marketplace (resale) or Amazon Web Services. If it''s a Reserved Instance Marketplace offering, this is true.' - offeringClass: - allOf: - - $ref: '#/components/schemas/OfferingClassType' - - description: 'If convertible it can be exchanged for Reserved Instances of the same or higher monetary value, with different configurations. If standard, it is not possible to perform an exchange.' - offeringType: - allOf: - - $ref: '#/components/schemas/OfferingTypeValues' - - description: The Reserved Instance offering type. - pricingDetailsSet: - allOf: - - $ref: '#/components/schemas/PricingDetailsList' - - description: The pricing details of the Reserved Instance offering. - recurringCharges: - allOf: - - $ref: '#/components/schemas/RecurringChargesList' - - description: The recurring charge tag assigned to the resource. - scope: - allOf: - - $ref: '#/components/schemas/scope' - - description: Whether the Reserved Instance is applied to instances in a Region or an Availability Zone. - description: Describes a Reserved Instance offering. - ResetAddressAttributeRequest: - type: object - required: - - AllocationId - - Attribute - title: ResetAddressAttributeRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - ResetEbsDefaultKmsKeyIdRequest: - type: object - title: ResetEbsDefaultKmsKeyIdRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - ResetFpgaImageAttributeName: - type: string - enum: - - loadPermission - ResetFpgaImageAttributeRequest: - type: object - required: - - FpgaImageId - title: ResetFpgaImageAttributeRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/ResetFpgaImageAttributeName' - - description: The attribute. - ResetImageAttributeName: - type: string - enum: - - launchPermission - ResetImageAttributeRequest: - type: object - required: - - Attribute - - ImageId - title: ResetImageAttributeRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/ImageId' - - description: The ID of the AMI. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - description: Contains the parameters for ResetImageAttribute. - ResetInstanceAttributeRequest: - type: object - required: - - Attribute - - InstanceId - title: ResetInstanceAttributeRequest - properties: - attribute: - allOf: - - $ref: '#/components/schemas/InstanceAttributeName' - - description: '

The attribute to reset.

You can only reset the following attributes: kernel | ramdisk | sourceDestCheck.

' - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - instanceId: - allOf: - - $ref: '#/components/schemas/InstanceId' - - description: The ID of the instance. - ResetNetworkInterfaceAttributeRequest: - type: object - required: - - NetworkInterfaceId - title: ResetNetworkInterfaceAttributeRequest - properties: - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - networkInterfaceId: - allOf: - - $ref: '#/components/schemas/NetworkInterfaceId' - - description: The ID of the network interface. - sourceDestCheck: - allOf: - - $ref: '#/components/schemas/String' - - description: The source/destination checking attribute. Resets the value to true. - description: Contains the parameters for ResetNetworkInterfaceAttribute. - ResetSnapshotAttributeRequest: - type: object - required: - - Attribute - - SnapshotId - title: ResetSnapshotAttributeRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/SnapshotId' - - description: The ID of the snapshot. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - ResourceList: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - RestoreAddressToClassicRequest: - type: object - required: - - PublicIp - title: RestoreAddressToClassicRequest - properties: - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - publicIp: - allOf: - - $ref: '#/components/schemas/String' - - description: The Elastic IP address. - RestoreImageFromRecycleBinRequest: - type: object - required: - - ImageId - title: RestoreImageFromRecycleBinRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - RestoreManagedPrefixListVersionRequest: - type: object - required: - - PrefixListId - - PreviousVersion - - CurrentVersion - title: RestoreManagedPrefixListVersionRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Long' - - description: The current version number for the prefix list. - RestoreSnapshotFromRecycleBinRequest: - type: object - required: - - SnapshotId - title: RestoreSnapshotFromRecycleBinRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - SnapshotState: - type: string - enum: - - pending - - completed - - error - - recoverable - - recovering - RestoreSnapshotTierRequest: - type: object - required: - - SnapshotId - title: RestoreSnapshotTierRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - RestoreSnapshotTierRequestTemporaryRestoreDays: - type: integer - ResultRange: - type: integer - minimum: 20 - maximum: 500 - RevokeClientVpnIngressRequest: - type: object - required: - - ClientVpnEndpointId - - TargetNetworkCidr - title: RevokeClientVpnIngressRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - SecurityGroupRuleIdList: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: item - RevokeSecurityGroupEgressRequest: - type: object - required: - - GroupId - title: RevokeSecurityGroupEgressRequest - properties: - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - groupId: - allOf: - - $ref: '#/components/schemas/SecurityGroupId' - - description: The ID of the security group. - ipPermissions: - allOf: - - $ref: '#/components/schemas/IpPermissionList' - - description: The sets of IP permissions. You can't specify a destination security group and a CIDR IP address range in the same set of permissions. - SecurityGroupRuleId: - allOf: - - $ref: '#/components/schemas/SecurityGroupRuleIdList' - - description: The IDs of the security group rules. - cidrIp: - allOf: - - $ref: '#/components/schemas/String' - - description: Not supported. Use a set of IP permissions to specify the CIDR. - fromPort: - allOf: - - $ref: '#/components/schemas/Integer' - - description: Not supported. Use a set of IP permissions to specify the port. - ipProtocol: - allOf: - - $ref: '#/components/schemas/String' - - description: Not supported. Use a set of IP permissions to specify the protocol name or number. - toPort: - allOf: - - $ref: '#/components/schemas/Integer' - - description: Not supported. Use a set of IP permissions to specify the port. - sourceSecurityGroupName: - allOf: - - $ref: '#/components/schemas/String' - - description: Not supported. Use a set of IP permissions to specify a destination security group. - sourceSecurityGroupOwnerId: - allOf: - - $ref: '#/components/schemas/String' - - description: Not supported. Use a set of IP permissions to specify a destination security group. - RevokeSecurityGroupIngressRequest: - type: object - title: RevokeSecurityGroupIngressRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.' - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - SecurityGroupRuleId: - allOf: - - $ref: '#/components/schemas/SecurityGroupRuleIdList' - - description: The IDs of the security group rules. - RootDeviceType: - type: string - enum: - - ebs - - instance-store - RouteOrigin: - type: string - enum: - - CreateRouteTable - - CreateRoute - - EnableVgwRoutePropagation - RouteState: - type: string - enum: - - active - - blackhole - Route: - type: object - properties: - destinationCidrBlock: - allOf: - - $ref: '#/components/schemas/String' - - description: The IPv4 CIDR block used for the destination match. - destinationIpv6CidrBlock: - allOf: - - $ref: '#/components/schemas/String' - - description: The IPv6 CIDR block used for the destination match. - destinationPrefixListId: - allOf: - - $ref: '#/components/schemas/String' - - description: The prefix of the Amazon Web Service. - egressOnlyInternetGatewayId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the egress-only internet gateway. - gatewayId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of a gateway attached to your VPC. - instanceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of a NAT instance in your VPC. - instanceOwnerId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of Amazon Web Services account that owns the instance. - natGatewayId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of a NAT gateway. - transitGatewayId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of a transit gateway. - localGatewayId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the local gateway. - carrierGatewayId: - allOf: - - $ref: '#/components/schemas/CarrierGatewayId' - - description: The ID of the carrier gateway. - networkInterfaceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the network interface. - origin: - allOf: - - $ref: '#/components/schemas/RouteOrigin' - - description:

Describes how the route was created.

  • CreateRouteTable - The route was automatically created when the route table was created.

  • CreateRoute - The route was manually added to the route table.

  • EnableVgwRoutePropagation - The route was propagated by route propagation.

- state: - allOf: - - $ref: '#/components/schemas/RouteState' - - description: 'The state of the route. The blackhole state indicates that the route''s target isn''t available (for example, the specified gateway isn''t attached to the VPC, or the specified NAT instance has been terminated).' - vpcPeeringConnectionId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of a VPC peering connection. - coreNetworkArn: - allOf: - - $ref: '#/components/schemas/CoreNetworkArn' - - description: The Amazon Resource Name (ARN) of the core network. - description: Describes a route in a route table. - RouteList: - type: array - items: - allOf: - - $ref: '#/components/schemas/Route' - - xml: - name: item - RouteTableAssociationList: - type: array - items: - allOf: - - $ref: '#/components/schemas/RouteTableAssociation' - - xml: - name: item - RouteTableAssociation: - type: object - properties: - main: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether this is the main route table. - routeTableAssociationId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the association. - routeTableId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the route table. - subnetId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the subnet. A subnet ID is not returned for an implicit association. - gatewayId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the internet gateway or virtual private gateway. - associationState: - allOf: - - $ref: '#/components/schemas/RouteTableAssociationState' - - description: The state of the association. - description: Describes an association between a route table and a subnet or gateway. - RouteTableAssociationStateCode: - type: string - enum: - - associating - - associated - - disassociating - - disassociated - - failed - RouteTableIdStringList: - type: array - items: - allOf: - - $ref: '#/components/schemas/RouteTableId' - - xml: - name: item - RunInstancesUserData: - type: string - format: password - RunInstancesRequest: - type: object - required: - - MaxCount - - MinCount - title: RunInstancesRequest - properties: - BlockDeviceMapping: - allOf: - - $ref: '#/components/schemas/Integer' - - description: '

[EC2-VPC] The number of IPv6 addresses to associate with the primary network interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you''ve specified a minimum number of instances to launch.

You cannot specify this option and the network interfaces option in the same request.

' - Ipv6Address: - allOf: - - $ref: '#/components/schemas/RamdiskId' - - description: '

The ID of the RAM disk to select. Some kernels require additional drivers at launch. Check the kernel requirements for information about whether you need to specify a RAM disk. To find kernel requirements, go to the Amazon Web Services Resource Center and search for the kernel ID.

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon EC2 User Guide.

' - SecurityGroupId: - allOf: - - $ref: '#/components/schemas/SecurityGroupIdStringList' - - description: '

The IDs of the security groups. You can create a security group using CreateSecurityGroup.

If you specify a network interface, you must specify any security groups as part of the network interface.

' - SecurityGroup: - allOf: - - $ref: '#/components/schemas/RunInstancesUserData' - - description: 'The user data script to make available to the instance. For more information, see Run commands on your Linux instance at launch and Run commands on your Windows instance at launch. If you are using a command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text. User data is limited to 16 KB.' - additionalInfo: - allOf: - - $ref: '#/components/schemas/String' - - description: Reserved. - clientToken: - allOf: - - $ref: '#/components/schemas/String' - - description: '

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.

For more information, see Ensuring Idempotency.

Constraints: Maximum 64 ASCII characters

' - disableApiTermination: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: '

If you set this parameter to true, you can''t terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after launch, use ModifyInstanceAttribute. Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate, you can terminate the instance by running the shutdown command from the instance.

Default: false

' - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - ebsOptimized: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: '

Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn''t available with all instance types. Additional usage charges apply when using an EBS-optimized instance.

Default: false

' - iamInstanceProfile: - allOf: - - $ref: '#/components/schemas/IamInstanceProfileSpecification' - - description: The name or Amazon Resource Name (ARN) of an IAM instance profile. - instanceInitiatedShutdownBehavior: - allOf: - - $ref: '#/components/schemas/ShutdownBehavior' - - description: '

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

Default: stop

' - networkInterface: - allOf: - - $ref: '#/components/schemas/InstanceNetworkInterfaceSpecificationList' - - description: 'The network interfaces to associate with the instance. If you specify a network interface, you must specify any security groups and subnets as part of the network interface.' - privateIpAddress: - allOf: - - $ref: '#/components/schemas/ElasticGpuSpecifications' - - description: 'An elastic GPU to associate with the instance. An Elastic GPU is a GPU resource that you can attach to your Windows instance to accelerate the graphics performance of your applications. For more information, see Amazon EC2 Elastic GPUs in the Amazon EC2 User Guide.' - ElasticInferenceAccelerator: - allOf: - - $ref: '#/components/schemas/ElasticInferenceAccelerators' - - description:

An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads.

You cannot specify accelerators from different generations in the same request.

- TagSpecification: - allOf: - - $ref: '#/components/schemas/HibernationOptionsRequest' - - description: '

Indicates whether an instance is enabled for hibernation. For more information, see Hibernate your instance in the Amazon EC2 User Guide.

You can''t enable hibernation and Amazon Web Services Nitro Enclaves on the same instance.

' - LicenseSpecification: - allOf: - - $ref: '#/components/schemas/InstanceMaintenanceOptionsRequest' - - description: The maintenance and recovery options for the instance. - RunScheduledInstancesRequest: - type: object - required: - - LaunchSpecification - - ScheduledInstanceId - title: RunScheduledInstancesRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/ScheduledInstanceId' - - description: The Scheduled Instance ID. - description: Contains the parameters for RunScheduledInstances. - S3ObjectTagList: - type: array - items: - allOf: - - $ref: '#/components/schemas/S3ObjectTag' - - xml: - name: item - ScheduledInstanceRecurrence: - type: object - properties: - frequency: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The frequency (Daily, Weekly, or Monthly).' - interval: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The interval quantity. The interval unit depends on the value of frequency. For example, every 2 weeks or every 2 months.' - occurrenceDaySet: - allOf: - - $ref: '#/components/schemas/OccurrenceDaySet' - - description: 'The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday).' - occurrenceRelativeToEnd: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether the occurrence is relative to the end of the specified week or month. - occurrenceUnit: - allOf: - - $ref: '#/components/schemas/String' - - description: The unit for occurrenceDaySet (DayOfWeek or DayOfMonth). - description: Describes the recurring schedule for a Scheduled Instance. - ScheduledInstanceAvailability: - type: object - properties: - availabilityZone: - allOf: - - $ref: '#/components/schemas/String' - - description: The Availability Zone. - availableInstanceCount: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The number of available instances. - firstSlotStartTime: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The time period for the first schedule to start. - hourlyPrice: - allOf: - - $ref: '#/components/schemas/String' - - description: The hourly price for a single instance. - instanceType: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The instance type. You can specify one of the C3, C4, M4, or R3 instance types.' - maxTermDurationInDays: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The maximum term. The only possible value is 365 days. - minTermDurationInDays: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The minimum term. The only possible value is 365 days. - networkPlatform: - allOf: - - $ref: '#/components/schemas/String' - - description: The network platform (EC2-Classic or EC2-VPC). - platform: - allOf: - - $ref: '#/components/schemas/String' - - description: The platform (Linux/UNIX or Windows). - purchaseToken: - allOf: - - $ref: '#/components/schemas/String' - - description: The purchase token. This token expires in two hours. - recurrence: - allOf: - - $ref: '#/components/schemas/ScheduledInstanceRecurrence' - - description: The schedule recurrence. - slotDurationInHours: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The number of hours in the schedule. - totalScheduledInstanceHours: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The total number of hours for a single instance for the entire term. - description: Describes a schedule that is available for your Scheduled Instances. - ScheduledInstanceIdRequestSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/ScheduledInstanceId' - - xml: - name: ScheduledInstanceId - ScheduledInstancesBlockDeviceMapping: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: '

The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with two available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.

Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.

' - description: Describes a block device mapping for a Scheduled Instance. - ScheduledInstancesBlockDeviceMappingSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/ScheduledInstancesBlockDeviceMapping' - - xml: - name: BlockDeviceMapping - ScheduledInstancesEbs: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: '

The volume type. gp2 for General Purpose SSD, io1 or io2 for Provisioned IOPS SSD, Throughput Optimized HDD for st1, Cold HDD for sc1, or standard for Magnetic.

Default: gp2

' - description: Describes an EBS volume for a Scheduled Instance. - ScheduledInstancesIamInstanceProfile: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The name. - description: Describes an IAM instance profile for a Scheduled Instance. - ScheduledInstancesIpv6Address: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Ipv6Address' - - description: The IPv6 address. - description: Describes an IPv6 address. - ScheduledInstancesIpv6AddressList: - type: array - items: - allOf: - - $ref: '#/components/schemas/ScheduledInstancesIpv6Address' - - xml: - name: Ipv6Address - ScheduledInstancesLaunchSpecification: - type: object - required: - - ImageId - properties: - BlockDeviceMapping: - allOf: - - $ref: '#/components/schemas/ScheduledInstancesMonitoring' - - description: Enable or disable monitoring for the instances. - NetworkInterface: - allOf: - - $ref: '#/components/schemas/RamdiskId' - - description: The ID of the RAM disk. - SecurityGroupId: - allOf: - - $ref: '#/components/schemas/String' - - description: The base64-encoded MIME user data. - description: '

Describes the launch specification for a Scheduled Instance.

If you are launching the Scheduled Instance in EC2-VPC, you must specify the ID of the subnet. You can specify the subnet using either SubnetId or NetworkInterface.

' - ScheduledInstancesNetworkInterface: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The index of the device for the network interface attachment. - Group: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The number of IPv6 addresses to assign to the network interface. The IPv6 addresses are automatically selected from the subnet range. - Ipv6Address: - allOf: - - $ref: '#/components/schemas/String' - - description: The IPv4 address of the network interface within the subnet. - PrivateIpAddressConfig: - allOf: - - $ref: '#/components/schemas/SubnetId' - - description: The ID of the subnet. - description: Describes a network interface for a Scheduled Instance. - ScheduledInstancesNetworkInterfaceSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/ScheduledInstancesNetworkInterface' - - xml: - name: NetworkInterface - ScheduledInstancesPlacement: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/PlacementGroupName' - - description: The name of the placement group. - description: Describes the placement for a Scheduled Instance. - ScheduledInstancesSecurityGroupIdSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/SecurityGroupId' - - xml: - name: SecurityGroupId - SearchLocalGatewayRoutesRequest: - type: object - required: - - LocalGatewayRouteTableId - title: SearchLocalGatewayRoutesRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/LocalGatewayRoutetableId' - - description: The ID of the local gateway route table. - Filter: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - SearchTransitGatewayMulticastGroupsRequest: - type: object - title: SearchTransitGatewayMulticastGroupsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/TransitGatewayMulticastDomainId' - - description: The ID of the transit gateway multicast domain. - Filter: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - TransitGatewayMulticastGroupList: - type: array - items: - allOf: - - $ref: '#/components/schemas/TransitGatewayMulticastGroup' - - xml: - name: item - SearchTransitGatewayRoutesRequest: - type: object - required: - - TransitGatewayRouteTableId - - Filters - title: SearchTransitGatewayRoutesRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/TransitGatewayRouteTableId' - - description: The ID of the transit gateway route table. - Filter: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - TransitGatewayRouteList: - type: array - items: - allOf: - - $ref: '#/components/schemas/TransitGatewayRoute' - - xml: - name: item - SecurityGroup: - type: object - properties: - groupDescription: - allOf: - - $ref: '#/components/schemas/String' - - description: A description of the security group. - groupName: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of the security group. - ipPermissions: - allOf: - - $ref: '#/components/schemas/IpPermissionList' - - description: The inbound rules associated with the security group. - ownerId: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Web Services account ID of the owner of the security group. - groupId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the security group. - ipPermissionsEgress: - allOf: - - $ref: '#/components/schemas/IpPermissionList' - - description: '[VPC only] The outbound rules associated with the security group.' - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: Any tags assigned to the security group. - vpcId: - allOf: - - $ref: '#/components/schemas/String' - - description: '[VPC only] The ID of the VPC for the security group.' - description: Describes a security group. - SecurityGroupReference: - type: object - properties: - groupId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of your security group. - referencingVpcId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the VPC with the referencing security group. - vpcPeeringConnectionId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the VPC peering connection. - description: Describes a VPC with a security group that references your security group. - SecurityGroupRuleId: - type: string - SecurityGroupRule: - type: object - properties: - securityGroupRuleId: - allOf: - - $ref: '#/components/schemas/SecurityGroupRuleId' - - description: The ID of the security group rule. - groupId: - allOf: - - $ref: '#/components/schemas/SecurityGroupId' - - description: The ID of the security group. - groupOwnerId: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The ID of the Amazon Web Services account that owns the security group. ' - isEgress: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether the security group rule is an outbound rule. - ipProtocol: - allOf: - - $ref: '#/components/schemas/String' - - description: '

The IP protocol name (tcp, udp, icmp, icmpv6) or number (see Protocol Numbers).

Use -1 to specify all protocols.

' - fromPort: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.' - toPort: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes. ' - cidrIpv4: - allOf: - - $ref: '#/components/schemas/String' - - description: The IPv4 CIDR range. - cidrIpv6: - allOf: - - $ref: '#/components/schemas/String' - - description: The IPv6 CIDR range. - prefixListId: - allOf: - - $ref: '#/components/schemas/PrefixListResourceId' - - description: The ID of the prefix list. - referencedGroupInfo: - allOf: - - $ref: '#/components/schemas/ReferencedSecurityGroup' - - description: Describes the security group that is referenced in the rule. - description: - allOf: - - $ref: '#/components/schemas/String' - - description: The security group rule description. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: The tags applied to the security group rule. - description: Describes a security group rule. - SecurityGroupRuleDescriptionList: - type: array - items: - allOf: - - $ref: '#/components/schemas/SecurityGroupRuleDescription' - - xml: - name: item - SecurityGroupRuleRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The description of the security group rule. - description: '

Describes a security group rule.

You must specify exactly one of the following parameters, based on the rule type:

  • CidrIpv4

  • CidrIpv6

  • PrefixListId

  • ReferencedGroupId

When you modify a rule, you cannot change the rule type. For example, if the rule uses an IPv4 address range, you must use CidrIpv4 to specify a new IPv4 address range.

' - SecurityGroupRuleUpdateList: - type: array - items: - allOf: - - $ref: '#/components/schemas/SecurityGroupRuleUpdate' - - xml: - name: item - SelfServicePortal: - type: string - enum: - - enabled - - disabled - SendDiagnosticInterruptRequest: - type: object - required: - - InstanceId - title: SendDiagnosticInterruptRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - ServiceTypeDetailSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/ServiceTypeDetail' - - xml: - name: item - ServiceState: - type: string - enum: - - Pending - - Available - - Deleting - - Deleted - - Failed - SupportedIpAddressTypes: - type: array - items: - allOf: - - $ref: '#/components/schemas/ServiceConnectivityType' - - xml: - name: item - minItems: 0 - maxItems: 2 - ServiceConnectivityType: - type: string - enum: - - ipv4 - - ipv6 - ServiceDetail: - type: object - properties: - serviceName: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Resource Name (ARN) of the service. - serviceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the endpoint service. - serviceType: - allOf: - - $ref: '#/components/schemas/ServiceTypeDetailSet' - - description: The type of service. - availabilityZoneSet: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The Availability Zones in which the service is available. - owner: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Web Services account ID of the service owner. - baseEndpointDnsNameSet: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The DNS names for the service. - privateDnsName: - allOf: - - $ref: '#/components/schemas/String' - - description: The private DNS name for the service. - privateDnsNameSet: - allOf: - - $ref: '#/components/schemas/PrivateDnsDetailsSet' - - description: 'The private DNS names assigned to the VPC endpoint service. ' - vpcEndpointPolicySupported: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether the service supports endpoint policies. - acceptanceRequired: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether VPC endpoint connection requests to the service must be accepted by the service owner. - managesVpcEndpoints: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether the service manages its VPC endpoints. Management of the service VPC endpoints using the VPC endpoint API is restricted. - payerResponsibility: - allOf: - - $ref: '#/components/schemas/PayerResponsibility' - - description: The payer responsibility. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: Any tags assigned to the service. - privateDnsNameVerificationState: - allOf: - - $ref: '#/components/schemas/DnsNameState' - - description:

The verification state of the VPC endpoint service.

Consumers of the endpoint service cannot use the private name when the state is not verified.

- supportedIpAddressTypeSet: - allOf: - - $ref: '#/components/schemas/SupportedIpAddressTypes' - - description: The supported IP address types. - description: Describes a VPC endpoint service. - ServiceType: - type: string - enum: - - Interface - - Gateway - - GatewayLoadBalancer - ServiceTypeDetail: - type: object - properties: - serviceType: - allOf: - - $ref: '#/components/schemas/ServiceType' - - description: The type of service. - description: Describes the type of service for a VPC endpoint. - SlotDateTimeRangeRequest: - type: object - required: - - EarliestTime - - LatestTime - properties: - undefined: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: 'The latest date and time, in UTC, for the Scheduled Instance to start. This value must be later than or equal to the earliest date and at most three months in the future.' - description: Describes the time period for a Scheduled Instance to start its first schedule. The time period must span less than one day. - StorageTier: - type: string - enum: - - archive - - standard - SnapshotAttributeName: - type: string - enum: - - productCodes - - createVolumePermission - UserBucketDetails: - type: object - properties: - s3Bucket: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon S3 bucket from which the disk image was created. - s3Key: - allOf: - - $ref: '#/components/schemas/String' - - description: The file name of the disk image. - description: Describes the Amazon S3 bucket for the disk image. - SnapshotDetail: - type: object - properties: - description: - allOf: - - $ref: '#/components/schemas/String' - - description: A description for the snapshot. - deviceName: - allOf: - - $ref: '#/components/schemas/String' - - description: The block device mapping for the snapshot. - diskImageSize: - allOf: - - $ref: '#/components/schemas/Double' - - description: 'The size of the disk in the snapshot, in GiB.' - format: - allOf: - - $ref: '#/components/schemas/String' - - description: The format of the disk image from which the snapshot is created. - progress: - allOf: - - $ref: '#/components/schemas/String' - - description: The percentage of progress for the task. - snapshotId: - allOf: - - $ref: '#/components/schemas/String' - - description: The snapshot ID of the disk being imported. - status: - allOf: - - $ref: '#/components/schemas/String' - - description: A brief status of the snapshot creation. - statusMessage: - allOf: - - $ref: '#/components/schemas/String' - - description: A detailed status message for the snapshot creation. - url: - allOf: - - $ref: '#/components/schemas/String' - - description: The URL used to access the disk image. - userBucket: - allOf: - - $ref: '#/components/schemas/UserBucketDetails' - - description: The Amazon S3 bucket for the disk image. - description: Describes the snapshot created from the imported disk. - SnapshotDiskContainer: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/UserBucket' - - description: The Amazon S3 bucket for the disk image. - description: The disk container object for the import snapshot request. - SnapshotInfo: - type: object - properties: - description: - allOf: - - $ref: '#/components/schemas/String' - - description: Description specified by the CreateSnapshotRequest that has been applied to all snapshots. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: Tags associated with this snapshot. - encrypted: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether the snapshot is encrypted. - volumeId: - allOf: - - $ref: '#/components/schemas/String' - - description: Source volume from which this snapshot was created. - state: - allOf: - - $ref: '#/components/schemas/SnapshotState' - - description: Current state of the snapshot. - volumeSize: - allOf: - - $ref: '#/components/schemas/Integer' - - description: Size of the volume from which this snapshot was created. - startTime: - allOf: - - $ref: '#/components/schemas/MillisecondDateTime' - - description: Time this snapshot was started. This is the same for all snapshots initiated by the same request. - progress: - allOf: - - $ref: '#/components/schemas/String' - - description: Progress this snapshot has made towards completing. - ownerId: - allOf: - - $ref: '#/components/schemas/String' - - description: Account id used when creating this snapshot. - snapshotId: - allOf: - - $ref: '#/components/schemas/String' - - description: Snapshot id that can be used to describe this snapshot. - outpostArn: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The ARN of the Outpost on which the snapshot is stored. For more information, see Amazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.' - description: Information about a snapshot. - SnapshotRecycleBinInfo: - type: object - properties: - snapshotId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the snapshot. - recycleBinEnterTime: - allOf: - - $ref: '#/components/schemas/MillisecondDateTime' - - description: The date and time when the snaphsot entered the Recycle Bin. - recycleBinExitTime: - allOf: - - $ref: '#/components/schemas/MillisecondDateTime' - - description: The date and time when the snapshot is to be permanently deleted from the Recycle Bin. - description: - allOf: - - $ref: '#/components/schemas/String' - - description: The description for the snapshot. - volumeId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the volume from which the snapshot was created. - description: Information about a snapshot that is currently in the Recycle Bin. - TieringOperationStatus: - type: string - enum: - - archival-in-progress - - archival-completed - - archival-failed - - temporary-restore-in-progress - - temporary-restore-completed - - temporary-restore-failed - - permanent-restore-in-progress - - permanent-restore-completed - - permanent-restore-failed - SnapshotTierStatus: - type: object - properties: - snapshotId: - allOf: - - $ref: '#/components/schemas/SnapshotId' - - description: The ID of the snapshot. - volumeId: - allOf: - - $ref: '#/components/schemas/VolumeId' - - description: The ID of the volume from which the snapshot was created. - status: - allOf: - - $ref: '#/components/schemas/SnapshotState' - - description: The state of the snapshot. - ownerId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Amazon Web Services account that owns the snapshot. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: The tags that are assigned to the snapshot. - storageTier: - allOf: - - $ref: '#/components/schemas/StorageTier' - - description: The storage tier in which the snapshot is stored. standard indicates that the snapshot is stored in the standard snapshot storage tier and that it is ready for use. archive indicates that the snapshot is currently archived and that it must be restored before it can be used. - lastTieringStartTime: - allOf: - - $ref: '#/components/schemas/MillisecondDateTime' - - description: The date and time when the last archive or restore process was started. - lastTieringProgress: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The progress of the last archive or restore process, as a percentage.' - lastTieringOperationStatus: - allOf: - - $ref: '#/components/schemas/TieringOperationStatus' - - description: The status of the last archive or restore process. - lastTieringOperationStatusDetail: - allOf: - - $ref: '#/components/schemas/String' - - description: A message describing the status of the last archive or restore process. - archivalCompleteTime: - allOf: - - $ref: '#/components/schemas/MillisecondDateTime' - - description: The date and time when the last archive process was completed. - restoreExpiryTime: - allOf: - - $ref: '#/components/schemas/MillisecondDateTime' - - description: Only for archived snapshots that are temporarily restored. Indicates the date and time when a temporarily restored snapshot will be automatically re-archived. - description: Provides information about a snapshot's storage tier. - SpotAllocationStrategy: - type: string - enum: - - lowest-price - - diversified - - capacity-optimized - - capacity-optimized-prioritized - SpotCapacityRebalance: - type: object - properties: - replacementStrategy: - allOf: - - $ref: '#/components/schemas/ReplacementStrategy' - - description: '

The replacement strategy to use. Only available for fleets of type maintain.

launch - Spot Fleet launches a new replacement Spot Instance when a rebalance notification is emitted for an existing Spot Instance in the fleet. Spot Fleet does not terminate the instances that receive a rebalance notification. You can terminate the old instances, or you can leave them running. You are charged for all instances while they are running.

launch-before-terminate - Spot Fleet launches a new replacement Spot Instance when a rebalance notification is emitted for an existing Spot Instance in the fleet, and then, after a delay that you specify (in TerminationDelay), terminates the instances that received a rebalance notification.

' - terminationDelay: - allOf: - - $ref: '#/components/schemas/Integer' - - description: '

The amount of time (in seconds) that Amazon EC2 waits before terminating the old Spot Instance after launching a new replacement Spot Instance.

Required when ReplacementStrategy is set to launch-before-terminate.

Not valid when ReplacementStrategy is set to launch.

Valid values: Minimum value of 120 seconds. Maximum value of 7200 seconds.

' - description: 'The Spot Instance replacement strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an elevated risk of being interrupted. For more information, see Capacity rebalancing in the Amazon EC2 User Guide for Linux Instances.' - SpotInstanceStateFault: - type: object - properties: - code: - allOf: - - $ref: '#/components/schemas/String' - - description: The reason code for the Spot Instance state change. - message: - allOf: - - $ref: '#/components/schemas/String' - - description: The message for the Spot Instance state change. - description: Describes a Spot Instance state change. - SpotFleetMonitoring: - type: object - properties: - enabled: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: '

Enables monitoring for the instance.

Default: false

' - description: Describes whether monitoring is enabled. - SpotFleetTagSpecificationList: - type: array - items: - allOf: - - $ref: '#/components/schemas/SpotFleetTagSpecification' - - xml: - name: item - SpotFleetRequestConfig: - type: object - properties: - activityStatus: - allOf: - - $ref: '#/components/schemas/ActivityStatus' - - description: 'The progress of the Spot Fleet request. If there is an error, the status is error. After all requests are placed, the status is pending_fulfillment. If the size of the fleet is equal to or greater than its target capacity, the status is fulfilled. If the size of the fleet is decreased, the status is pending_termination while Spot Instances are terminating.' - createTime: - allOf: - - $ref: '#/components/schemas/MillisecondDateTime' - - description: The creation date and time of the request. - spotFleetRequestConfig: - allOf: - - $ref: '#/components/schemas/SpotFleetRequestConfigData' - - description: The configuration of the Spot Fleet request. - spotFleetRequestId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Spot Fleet request. - spotFleetRequestState: - allOf: - - $ref: '#/components/schemas/BatchState' - - description: The state of the Spot Fleet request. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: The tags for a Spot Fleet resource. - description: Describes a Spot Fleet request. - SpotFleetTagSpecification: - type: object - properties: - resourceType: - allOf: - - $ref: '#/components/schemas/ResourceType' - - description: 'The type of resource. Currently, the only resource type that is supported is instance. To tag the Spot Fleet request on creation, use the TagSpecifications parameter in SpotFleetRequestConfigData .' - tag: - allOf: - - $ref: '#/components/schemas/TagList' - - description: The tags. - description: The tags for a Spot Fleet resource. - SpotInstanceInterruptionBehavior: - type: string - enum: - - hibernate - - stop - - terminate - SpotInstanceState: - type: string - enum: - - open - - active - - closed - - cancelled - - failed - SpotInstanceStatus: - type: object - properties: - code: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The status code. For a list of status codes, see Spot request status codes in the Amazon EC2 User Guide for Linux Instances.' - message: - allOf: - - $ref: '#/components/schemas/String' - - description: The description for the status code. - updateTime: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: 'The date and time of the most recent status update, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).' - description: Describes the status of a Spot Instance request. - SpotInstanceRequest: - type: object - properties: - actualBlockHourlyPrice: - allOf: - - $ref: '#/components/schemas/String' - - description: Deprecated. - availabilityZoneGroup: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The Availability Zone group. If you specify the same Availability Zone group for all Spot Instance requests, all Spot Instances are launched in the same Availability Zone.' - blockDurationMinutes: - allOf: - - $ref: '#/components/schemas/Integer' - - description: Deprecated. - createTime: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: 'The date and time when the Spot Instance request was created, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).' - fault: - allOf: - - $ref: '#/components/schemas/SpotInstanceStateFault' - - description: 'The fault codes for the Spot Instance request, if any.' - instanceId: - allOf: - - $ref: '#/components/schemas/InstanceId' - - description: 'The instance ID, if an instance has been launched to fulfill the Spot Instance request.' - launchGroup: - allOf: - - $ref: '#/components/schemas/String' - - description: The instance launch group. Launch groups are Spot Instances that launch together and terminate together. - launchSpecification: - allOf: - - $ref: '#/components/schemas/LaunchSpecification' - - description: Additional information for launching instances. - launchedAvailabilityZone: - allOf: - - $ref: '#/components/schemas/String' - - description: The Availability Zone in which the request is launched. - productDescription: - allOf: - - $ref: '#/components/schemas/RIProductDescription' - - description: The product description associated with the Spot Instance. - spotInstanceRequestId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Spot Instance request. - spotPrice: - allOf: - - $ref: '#/components/schemas/String' - - description: The maximum price per hour that you are willing to pay for a Spot Instance. - state: - allOf: - - $ref: '#/components/schemas/SpotInstanceState' - - description: 'The state of the Spot Instance request. Spot request status information helps track your Spot Instance requests. For more information, see Spot request status in the Amazon EC2 User Guide for Linux Instances.' - status: - allOf: - - $ref: '#/components/schemas/SpotInstanceStatus' - - description: The status code and status message describing the Spot Instance request. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: Any tags assigned to the resource. - type: - allOf: - - $ref: '#/components/schemas/SpotInstanceType' - - description: The Spot Instance request type. - validFrom: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: 'The start date of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The request becomes active at this date and time.' - validUntil: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: '

The end date of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ).

  • For a persistent request, the request remains active until the validUntil date and time is reached. Otherwise, the request remains active until you cancel it.

  • For a one-time request, the request remains active until all instances launch, the request is canceled, or the validUntil date and time is reached. By default, the request is valid for 7 days from the date the request was created.

' - instanceInterruptionBehavior: - allOf: - - $ref: '#/components/schemas/InstanceInterruptionBehavior' - - description: The behavior when a Spot Instance is interrupted. - description: Describes a Spot Instance request. - SpotOptionsRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The maximum amount per hour for Spot Instances that you're willing to pay. - description: Describes the configuration of Spot Instances in an EC2 Fleet request. - SpotPlacementScore: - type: object - properties: - region: - allOf: - - $ref: '#/components/schemas/String' - - description: The Region. - availabilityZoneId: - allOf: - - $ref: '#/components/schemas/String' - - description: The Availability Zone. - score: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The placement score, on a scale from 1 to 10. A score of 10 indicates that your Spot request is highly likely to succeed in this Region or Availability Zone. A score of 1 indicates that your Spot request is not likely to succeed. ' - description: The Spot placement score for this Region or Availability Zone. The score is calculated based on the assumption that the capacity-optimized allocation strategy is used and that all of the Availability Zones in the Region can be used. - SpotPlacementScoresMaxResults: - type: integer - minimum: 10 - maximum: 1000 - SpotPlacementScoresTargetCapacity: - type: integer - minimum: 1 - maximum: 2000000000 - SpotPrice: - type: object - properties: - availabilityZone: - allOf: - - $ref: '#/components/schemas/String' - - description: The Availability Zone. - instanceType: - allOf: - - $ref: '#/components/schemas/InstanceType' - - description: The instance type. - productDescription: - allOf: - - $ref: '#/components/schemas/RIProductDescription' - - description: A general description of the AMI. - spotPrice: - allOf: - - $ref: '#/components/schemas/String' - - description: The maximum price per hour that you are willing to pay for a Spot Instance. - timestamp: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: 'The date and time the request was created, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).' - description: Describes the maximum price per hour that you are willing to pay for a Spot Instance. - UserIdGroupPairSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/UserIdGroupPair' - - xml: - name: item - StaleIpPermission: - type: object - properties: - fromPort: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The start of the port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types. ' - ipProtocol: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The IP protocol name (for tcp, udp, and icmp) or number (see Protocol Numbers).' - ipRanges: - allOf: - - $ref: '#/components/schemas/IpRanges' - - description: The IP ranges. Not applicable for stale security group rules. - prefixListIds: - allOf: - - $ref: '#/components/schemas/PrefixListIdSet' - - description: The prefix list IDs. Not applicable for stale security group rules. - toPort: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The end of the port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types. ' - groups: - allOf: - - $ref: '#/components/schemas/UserIdGroupPairSet' - - description: 'The security group pairs. Returns the ID of the referenced security group and VPC, and the ID and status of the VPC peering connection.' - description: Describes a stale rule in a security group. - StaleIpPermissionSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/StaleIpPermission' - - xml: - name: item - StaleSecurityGroup: - type: object - properties: - description: - allOf: - - $ref: '#/components/schemas/String' - - description: The description of the security group. - groupId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the security group. - groupName: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of the security group. - staleIpPermissions: - allOf: - - $ref: '#/components/schemas/StaleIpPermissionSet' - - description: Information about the stale inbound rules in the security group. - staleIpPermissionsEgress: - allOf: - - $ref: '#/components/schemas/StaleIpPermissionSet' - - description: Information about the stale outbound rules in the security group. - vpcId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the VPC for the security group. - description: Describes a stale security group (a security group that contains stale rules). - StartInstancesRequest: - type: object - required: - - InstanceIds - title: StartInstancesRequest - properties: - InstanceId: - allOf: - - $ref: '#/components/schemas/InstanceIdStringList' - - description: The IDs of the instances. - additionalInfo: - allOf: - - $ref: '#/components/schemas/String' - - description: Reserved. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - StartNetworkInsightsAccessScopeAnalysisRequest: - type: object - required: - - NetworkInsightsAccessScopeId - - ClientToken - title: StartNetworkInsightsAccessScopeAnalysisRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - TagSpecification: - allOf: - - $ref: '#/components/schemas/String' - - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.' - StartNetworkInsightsAnalysisRequest: - type: object - required: - - NetworkInsightsPathId - - ClientToken - title: StartNetworkInsightsAnalysisRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/NetworkInsightsPathId' - - description: The ID of the path. - FilterInArn: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - TagSpecification: - allOf: - - $ref: '#/components/schemas/String' - - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.' - StartVpcEndpointServicePrivateDnsVerificationRequest: - type: object - required: - - ServiceId - title: StartVpcEndpointServicePrivateDnsVerificationRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/VpcEndpointServiceId' - - description: The ID of the endpoint service. - State: - type: string - enum: - - PendingAcceptance - - Pending - - Available - - Deleting - - Deleted - - Rejected - - Failed - - Expired - StaticSourcesSupportValue: - type: string - enum: - - enable - - disable - StopInstancesRequest: - type: object - required: - - InstanceIds - title: StopInstancesRequest - properties: - InstanceId: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: '

Hibernates the instance if the instance was enabled for hibernation at launch. If the instance cannot hibernate successfully, a normal shutdown occurs. For more information, see Hibernate your instance in the Amazon EC2 User Guide.

Default: false

' - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - force: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: '

Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances.

Default: false

' - StorageLocation: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: The key. - description: Describes a storage location in Amazon S3. - StoreImageTaskResult: - type: object - properties: - amiId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the AMI that is being stored. - taskStartTime: - allOf: - - $ref: '#/components/schemas/MillisecondDateTime' - - description: The time the task started. - bucket: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of the Amazon S3 bucket that contains the stored AMI object. - s3objectKey: - allOf: - - $ref: '#/components/schemas/String' - - description: The name of the stored AMI object in the bucket. - progressPercentage: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The progress of the task as a percentage. - storeTaskState: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The state of the store task (InProgress, Completed, or Failed).' - storeTaskFailureReason: - allOf: - - $ref: '#/components/schemas/String' - - description: 'If the tasks fails, the reason for the failure is returned. If the task succeeds, null is returned.' - description: 'The information about the AMI store task, including the progress of the task.' - SubnetState: - type: string - enum: - - pending - - available - SubnetIpv6CidrBlockAssociationSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/SubnetIpv6CidrBlockAssociation' - - xml: - name: item - TransitGatewayMulitcastDomainAssociationState: - type: string - enum: - - pendingAcceptance - - associating - - associated - - disassociating - - disassociated - - rejected - - failed - SubnetAssociation: - type: object - properties: - subnetId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the subnet. - state: - allOf: - - $ref: '#/components/schemas/TransitGatewayMulitcastDomainAssociationState' - - description: The state of the subnet association. - description: Describes the subnet association with the transit gateway multicast domain. - SubnetAssociationList: - type: array - items: - allOf: - - $ref: '#/components/schemas/SubnetAssociation' - - xml: - name: item - SubnetCidrBlockStateCode: - type: string - enum: - - associating - - associated - - disassociating - - disassociated - - failing - - failed - SubnetCidrBlockState: - type: object - properties: - state: - allOf: - - $ref: '#/components/schemas/SubnetCidrBlockStateCode' - - description: The state of a CIDR block. - statusMessage: - allOf: - - $ref: '#/components/schemas/String' - - description: 'A message about the status of the CIDR block, if applicable.' - description: Describes the state of a CIDR block. - SubnetCidrReservationId: - type: string - SubnetCidrReservationType: - type: string - enum: - - prefix - - explicit - SuccessfulInstanceCreditSpecificationItem: - type: object - properties: - instanceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the instance. - description: Describes the burstable performance instance whose credit option for CPU usage was successfully modified. - SuccessfulQueuedPurchaseDeletion: - type: object - properties: - reservedInstancesId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Reserved Instance. - description: Describes a Reserved Instance whose queued purchase was successfully deleted. - TagDescription: - type: object - properties: - key: - allOf: - - $ref: '#/components/schemas/String' - - description: The tag key. - resourceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the resource. - resourceType: - allOf: - - $ref: '#/components/schemas/ResourceType' - - description: The resource type. - value: - allOf: - - $ref: '#/components/schemas/String' - - description: The tag value. - description: Describes a tag. - TargetCapacitySpecificationRequest: - type: object - required: - - TotalTargetCapacity - properties: - undefined: - allOf: - - $ref: '#/components/schemas/TargetCapacityUnitType' - - description: '

The unit for the target capacity.

Default: units (translates to number of instances)

' - description: '

The number of units to request. You can choose to set the target capacity as the number of instances. Or you can set the target capacity to a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.

You can use the On-Demand Instance MaxTotalPrice parameter, the Spot Instance MaxTotalPrice parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, EC2 Fleet will launch instances until it reaches the maximum amount that you''re willing to pay. When the maximum amount you''re willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity. The MaxTotalPrice parameters are located in OnDemandOptionsRequest and SpotOptionsRequest.

' - TargetConfiguration: - type: object - properties: - instanceCount: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The number of instances the Convertible Reserved Instance offering can be applied to. This parameter is reserved and cannot be specified in a request - offeringId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Convertible Reserved Instance offering. - description: Information about the Convertible Reserved Instance offering. - TargetGroup: - type: object - properties: - arn: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Resource Name (ARN) of the target group. - description: Describes a load balancer target group. - TargetGroups: - type: array - items: - allOf: - - $ref: '#/components/schemas/TargetGroup' - - xml: - name: item - minItems: 1 - maxItems: 5 - TargetNetwork: - type: object - properties: - associationId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the association. - vpcId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the VPC in which the target network (subnet) is located. - targetNetworkId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the subnet specified as the target network. - clientVpnEndpointId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Client VPN endpoint with which the target network is associated. - status: - allOf: - - $ref: '#/components/schemas/AssociationStatus' - - description: The current state of the target network association. - securityGroups: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The IDs of the security groups applied to the target network association. - description: Describes a target network associated with a Client VPN endpoint. - TargetReservationValue: - type: object - properties: - reservationValue: - allOf: - - $ref: '#/components/schemas/ReservationValue' - - description: 'The total value of the Convertible Reserved Instances that make up the exchange. This is the sum of the list value, remaining upfront price, and additional upfront cost of the exchange.' - targetConfiguration: - allOf: - - $ref: '#/components/schemas/TargetConfiguration' - - description: The configuration of the Convertible Reserved Instances that make up the exchange. - description: The total value of the new Convertible Reserved Instances. - TargetStorageTier: - type: string - enum: - - archive - TelemetryStatus: - type: string - enum: - - UP - - DOWN - TerminateClientVpnConnectionsRequest: - type: object - required: - - ClientVpnEndpointId - title: TerminateClientVpnConnectionsRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - TerminateConnectionStatusSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/TerminateConnectionStatus' - - xml: - name: item - TerminateConnectionStatus: - type: object - properties: - connectionId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the client connection. - previousStatus: - allOf: - - $ref: '#/components/schemas/ClientVpnConnectionStatus' - - description: The state of the client connection. - currentStatus: - allOf: - - $ref: '#/components/schemas/ClientVpnConnectionStatus' - - description: 'A message about the status of the client connection, if applicable.' - description: Information about a terminated Client VPN endpoint client connection. - TerminateInstancesRequest: - type: object - required: - - InstanceIds - title: TerminateInstancesRequest - properties: - InstanceId: - allOf: - - $ref: '#/components/schemas/InstanceIdStringList' - - description: '

The IDs of the instances.

Constraints: Up to 1000 instance IDs. We recommend breaking up this request into smaller batches.

' - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - ThreadsPerCore: - type: integer - ThreadsPerCoreList: - type: array - items: - allOf: - - $ref: '#/components/schemas/ThreadsPerCore' - - xml: - name: item - ThroughResourcesStatement: - type: object - properties: - resourceStatement: - allOf: - - $ref: '#/components/schemas/ResourceStatement' - - description: The resource statement. - description: Describes a through resource statement. - ThroughResourcesStatementRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/ResourceStatementRequest' - - description: The resource statement. - description: Describes a through resource statement. - TotalLocalStorageGBRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Double' - - description: 'The maximum amount of total local storage, in GB. To specify no maximum limit, omit this parameter.' - description: 'The minimum and maximum amount of total local storage, in GB.' - TrafficDirection: - type: string - enum: - - ingress - - egress - TrafficMirrorFilterRuleList: - type: array - items: - allOf: - - $ref: '#/components/schemas/TrafficMirrorFilterRule' - - xml: - name: item - TrafficMirrorFilterIdList: - type: array - items: - allOf: - - $ref: '#/components/schemas/TrafficMirrorFilterId' - - xml: - name: item - TrafficMirrorRuleAction: - type: string - enum: - - accept - - reject - TrafficMirrorPortRange: - type: object - properties: - fromPort: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The start of the Traffic Mirror port range. This applies to the TCP and UDP protocols. - toPort: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The end of the Traffic Mirror port range. This applies to the TCP and UDP protocols. - description: Describes the Traffic Mirror port range. - TrafficMirrorFilterRuleFieldList: - type: array - items: - $ref: '#/components/schemas/TrafficMirrorFilterRuleField' - TrafficMirrorFilterRuleId: - type: string - TrafficMirrorPortRangeRequest: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The last port in the Traffic Mirror port range. This applies to the TCP and UDP protocols. - description: Information about the Traffic Mirror filter rule port range. - TrafficMirrorSessionFieldList: - type: array - items: - $ref: '#/components/schemas/TrafficMirrorSessionField' - TrafficMirrorSessionIdList: - type: array - items: - allOf: - - $ref: '#/components/schemas/TrafficMirrorSessionId' - - xml: - name: item - TrafficMirrorTargetType: - type: string - enum: - - network-interface - - network-load-balancer - - gateway-load-balancer-endpoint - TrafficMirrorTargetIdList: - type: array - items: - allOf: - - $ref: '#/components/schemas/TrafficMirrorTargetId' - - xml: - name: item - TrafficMirroringMaxResults: - type: integer - minimum: 5 - maximum: 1000 - TransitAssociationGatewayId: - type: string - TransitGatewayState: - type: string - enum: - - pending - - available - - modifying - - deleting - - deleted - TransitGatewayOptions: - type: object - properties: - amazonSideAsn: - allOf: - - $ref: '#/components/schemas/Long' - - description: A private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs. - transitGatewayCidrBlocks: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The transit gateway CIDR blocks. - autoAcceptSharedAttachments: - allOf: - - $ref: '#/components/schemas/AutoAcceptSharedAttachmentsValue' - - description: Indicates whether attachment requests are automatically accepted. - defaultRouteTableAssociation: - allOf: - - $ref: '#/components/schemas/DefaultRouteTableAssociationValue' - - description: Indicates whether resource attachments are automatically associated with the default association route table. - associationDefaultRouteTableId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the default association route table. - defaultRouteTablePropagation: - allOf: - - $ref: '#/components/schemas/DefaultRouteTablePropagationValue' - - description: Indicates whether resource attachments automatically propagate routes to the default propagation route table. - propagationDefaultRouteTableId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the default propagation route table. - vpnEcmpSupport: - allOf: - - $ref: '#/components/schemas/VpnEcmpSupportValue' - - description: Indicates whether Equal Cost Multipath Protocol support is enabled. - dnsSupport: - allOf: - - $ref: '#/components/schemas/DnsSupportValue' - - description: Indicates whether DNS support is enabled. - multicastSupport: - allOf: - - $ref: '#/components/schemas/MulticastSupportValue' - - description: Indicates whether multicast is enabled on the transit gateway - description: Describes the options for a transit gateway. - TransitGatewayAttachmentResourceType: - type: string - enum: - - vpc - - vpn - - direct-connect-gateway - - connect - - peering - - tgw-peering - TransitGatewayAssociationState: - type: string - enum: - - associating - - associated - - disassociating - - disassociated - TransitGatewayAttachmentState: - type: string - enum: - - initiating - - initiatingRequest - - pendingAcceptance - - rollingBack - - pending - - available - - modifying - - deleting - - deleted - - failed - - rejected - - rejecting - - failing - TransitGatewayAttachmentAssociation: - type: object - properties: - transitGatewayRouteTableId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the route table for the transit gateway. - state: - allOf: - - $ref: '#/components/schemas/TransitGatewayAssociationState' - - description: The state of the association. - description: Describes an association. - TransitGatewayAttachment: - type: object - properties: - transitGatewayAttachmentId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the attachment. - transitGatewayId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the transit gateway. - transitGatewayOwnerId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Amazon Web Services account that owns the transit gateway. - resourceOwnerId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Amazon Web Services account that owns the resource. - resourceType: - allOf: - - $ref: '#/components/schemas/TransitGatewayAttachmentResourceType' - - description: The resource type. Note that the tgw-peering resource type has been deprecated. - resourceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the resource. - state: - allOf: - - $ref: '#/components/schemas/TransitGatewayAttachmentState' - - description: The attachment state. Note that the initiating state has been deprecated. - association: - allOf: - - $ref: '#/components/schemas/TransitGatewayAttachmentAssociation' - - description: The association. - creationTime: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The creation time. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: The tags for the attachment. - description: Describes an attachment between a resource and a transit gateway. - TransitGatewayAttachmentBgpConfiguration: - type: object - properties: - transitGatewayAsn: - allOf: - - $ref: '#/components/schemas/Long' - - description: The transit gateway Autonomous System Number (ASN). - peerAsn: - allOf: - - $ref: '#/components/schemas/Long' - - description: The peer Autonomous System Number (ASN). - transitGatewayAddress: - allOf: - - $ref: '#/components/schemas/String' - - description: The interior BGP peer IP address for the transit gateway. - peerAddress: - allOf: - - $ref: '#/components/schemas/String' - - description: The interior BGP peer IP address for the appliance. - bgpStatus: - allOf: - - $ref: '#/components/schemas/BgpStatus' - - description: The BGP status. - description: The BGP configuration information. - TransitGatewayAttachmentBgpConfigurationList: - type: array - items: - allOf: - - $ref: '#/components/schemas/TransitGatewayAttachmentBgpConfiguration' - - xml: - name: item - TransitGatewayPropagationState: - type: string - enum: - - enabling - - enabled - - disabling - - disabled - TransitGatewayAttachmentPropagation: - type: object - properties: - transitGatewayRouteTableId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the propagation route table. - state: - allOf: - - $ref: '#/components/schemas/TransitGatewayPropagationState' - - description: The state of the propagation route table. - description: Describes a propagation route table. - TransitGatewayConnectOptions: - type: object - properties: - protocol: - allOf: - - $ref: '#/components/schemas/ProtocolValue' - - description: The tunnel protocol. - description: Describes the Connect attachment options. - TransitGatewayConnectPeerState: - type: string - enum: - - pending - - available - - deleting - - deleted - TransitGatewayConnectPeerConfiguration: - type: object - properties: - transitGatewayAddress: - allOf: - - $ref: '#/components/schemas/String' - - description: The Connect peer IP address on the transit gateway side of the tunnel. - peerAddress: - allOf: - - $ref: '#/components/schemas/String' - - description: The Connect peer IP address on the appliance side of the tunnel. - insideCidrBlocks: - allOf: - - $ref: '#/components/schemas/InsideCidrBlocksStringList' - - description: The range of interior BGP peer IP addresses. - protocol: - allOf: - - $ref: '#/components/schemas/ProtocolValue' - - description: The tunnel protocol. - bgpConfigurations: - allOf: - - $ref: '#/components/schemas/TransitGatewayAttachmentBgpConfigurationList' - - description: The BGP configuration details. - description: Describes the Connect peer details. - TransitGatewayConnectRequestBgpOptions: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Long' - - description: The peer Autonomous System Number (ASN). - description: The BGP options for the Connect attachment. - TransitGatewayMaxResults: - type: integer - minimum: 5 - maximum: 1000 - TransitGatewayMulticastDomainOptions: - type: object - properties: - igmpv2Support: - allOf: - - $ref: '#/components/schemas/Igmpv2SupportValue' - - description: Indicates whether Internet Group Management Protocol (IGMP) version 2 is turned on for the transit gateway multicast domain. - staticSourcesSupport: - allOf: - - $ref: '#/components/schemas/StaticSourcesSupportValue' - - description: Indicates whether support for statically configuring transit gateway multicast group sources is turned on. - autoAcceptSharedAssociations: - allOf: - - $ref: '#/components/schemas/AutoAcceptSharedAssociationsValue' - - description: Indicates whether to automatically cross-account subnet associations that are associated with the transit gateway multicast domain. - description: Describes the options for a transit gateway multicast domain. - TransitGatewayMulticastDomainState: - type: string - enum: - - pending - - available - - deleting - - deleted - TransitGatewayMulticastDomainAssociation: - type: object - properties: - transitGatewayAttachmentId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the transit gateway attachment. - resourceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the resource. - resourceType: - allOf: - - $ref: '#/components/schemas/TransitGatewayAttachmentResourceType' - - description: 'The type of resource, for example a VPC attachment.' - resourceOwnerId: - allOf: - - $ref: '#/components/schemas/String' - - description: ' The ID of the Amazon Web Services account that owns the transit gateway multicast domain association resource.' - subnet: - allOf: - - $ref: '#/components/schemas/SubnetAssociation' - - description: The subnet associated with the transit gateway multicast domain. - description: Describes the resources associated with the transit gateway multicast domain. - TransitGatewayMulticastGroup: - type: object - properties: - groupIpAddress: - allOf: - - $ref: '#/components/schemas/String' - - description: The IP address assigned to the transit gateway multicast group. - transitGatewayAttachmentId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the transit gateway attachment. - subnetId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the subnet. - resourceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the resource. - resourceType: - allOf: - - $ref: '#/components/schemas/TransitGatewayAttachmentResourceType' - - description: 'The type of resource, for example a VPC attachment.' - resourceOwnerId: - allOf: - - $ref: '#/components/schemas/String' - - description: ' The ID of the Amazon Web Services account that owns the transit gateway multicast domain group resource.' - networkInterfaceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the transit gateway attachment. - groupMember: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates that the resource is a transit gateway multicast group member. - groupSource: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates that the resource is a transit gateway multicast group member. - memberType: - allOf: - - $ref: '#/components/schemas/MembershipType' - - description: 'The member type (for example, static).' - sourceType: - allOf: - - $ref: '#/components/schemas/MembershipType' - - description: The source type. - description: Describes the transit gateway multicast group resources. - TransitGatewayNetworkInterfaceIdList: - type: array - items: - allOf: - - $ref: '#/components/schemas/NetworkInterfaceId' - - xml: - name: item - VpnEcmpSupportValue: - type: string - enum: - - enable - - disable - TransitGatewayPrefixListAttachment: - type: object - properties: - transitGatewayAttachmentId: - allOf: - - $ref: '#/components/schemas/TransitGatewayAttachmentId' - - description: The ID of the attachment. - resourceType: - allOf: - - $ref: '#/components/schemas/TransitGatewayAttachmentResourceType' - - description: The resource type. Note that the tgw-peering resource type has been deprecated. - resourceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the resource. - description: Describes a transit gateway prefix list attachment. - TransitGatewayPrefixListReferenceState: - type: string - enum: - - pending - - available - - modifying - - deleting - TransitGatewayRouteAttachmentList: - type: array - items: - allOf: - - $ref: '#/components/schemas/TransitGatewayRouteAttachment' - - xml: - name: item - TransitGatewayRouteType: - type: string - enum: - - static - - propagated - TransitGatewayRouteState: - type: string - enum: - - pending - - active - - blackhole - - deleting - - deleted - TransitGatewayRouteAttachment: - type: object - properties: - resourceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the resource. - transitGatewayAttachmentId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the attachment. - resourceType: - allOf: - - $ref: '#/components/schemas/TransitGatewayAttachmentResourceType' - - description: 'The resource type. Note that the tgw-peering resource type has been deprecated. ' - description: Describes a route attachment. - TransitGatewayRouteTableState: - type: string - enum: - - pending - - available - - deleting - - deleted - TransitGatewayRouteTableAssociation: - type: object - properties: - transitGatewayAttachmentId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the attachment. - resourceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the resource. - resourceType: - allOf: - - $ref: '#/components/schemas/TransitGatewayAttachmentResourceType' - - description: The resource type. Note that the tgw-peering resource type has been deprecated. - state: - allOf: - - $ref: '#/components/schemas/TransitGatewayAssociationState' - - description: The state of the association. - description: Describes an association between a route table and a resource attachment. - TransitGatewayRouteTablePropagation: - type: object - properties: - transitGatewayAttachmentId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the attachment. - resourceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the resource. - resourceType: - allOf: - - $ref: '#/components/schemas/TransitGatewayAttachmentResourceType' - - description: The type of resource. Note that the tgw-peering resource type has been deprecated. - state: - allOf: - - $ref: '#/components/schemas/TransitGatewayPropagationState' - - description: The state of the resource. - description: Describes a route table propagation. - TransitGatewaySubnetIdList: - type: array - items: - allOf: - - $ref: '#/components/schemas/SubnetId' - - xml: - name: item - TransitGatewayVpcAttachmentOptions: - type: object - properties: - dnsSupport: - allOf: - - $ref: '#/components/schemas/DnsSupportValue' - - description: Indicates whether DNS support is enabled. - ipv6Support: - allOf: - - $ref: '#/components/schemas/Ipv6SupportValue' - - description: Indicates whether IPv6 support is disabled. - applianceModeSupport: - allOf: - - $ref: '#/components/schemas/ApplianceModeSupportValue' - - description: Indicates whether appliance mode support is enabled. - description: Describes the VPC attachment options. - TrunkInterfaceAssociationIdList: - type: array - items: - allOf: - - $ref: '#/components/schemas/TrunkInterfaceAssociationId' - - xml: - name: item - TunnelInsideIpVersion: - type: string - enum: - - ipv4 - - ipv6 - TunnelOption: - type: object - properties: - outsideIpAddress: - allOf: - - $ref: '#/components/schemas/String' - - description: The external IP address of the VPN tunnel. - tunnelInsideCidr: - allOf: - - $ref: '#/components/schemas/String' - - description: The range of inside IPv4 addresses for the tunnel. - tunnelInsideIpv6Cidr: - allOf: - - $ref: '#/components/schemas/String' - - description: The range of inside IPv6 addresses for the tunnel. - preSharedKey: - allOf: - - $ref: '#/components/schemas/String' - - description: The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and the customer gateway. - phase1LifetimeSeconds: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The lifetime for phase 1 of the IKE negotiation, in seconds.' - phase2LifetimeSeconds: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The lifetime for phase 2 of the IKE negotiation, in seconds.' - rekeyMarginTimeSeconds: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The margin time, in seconds, before the phase 2 lifetime expires, during which the Amazon Web Services side of the VPN connection performs an IKE rekey.' - rekeyFuzzPercentage: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The percentage of the rekey window determined by RekeyMarginTimeSeconds during which the rekey time is randomly selected. - replayWindowSize: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The number of packets in an IKE replay window. - dpdTimeoutSeconds: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The number of seconds after which a DPD timeout occurs. - dpdTimeoutAction: - allOf: - - $ref: '#/components/schemas/String' - - description: The action to take after a DPD timeout occurs. - phase1EncryptionAlgorithmSet: - allOf: - - $ref: '#/components/schemas/Phase1EncryptionAlgorithmsList' - - description: The permitted encryption algorithms for the VPN tunnel for phase 1 IKE negotiations. - phase2EncryptionAlgorithmSet: - allOf: - - $ref: '#/components/schemas/Phase2EncryptionAlgorithmsList' - - description: The permitted encryption algorithms for the VPN tunnel for phase 2 IKE negotiations. - phase1IntegrityAlgorithmSet: - allOf: - - $ref: '#/components/schemas/Phase1IntegrityAlgorithmsList' - - description: The permitted integrity algorithms for the VPN tunnel for phase 1 IKE negotiations. - phase2IntegrityAlgorithmSet: - allOf: - - $ref: '#/components/schemas/Phase2IntegrityAlgorithmsList' - - description: The permitted integrity algorithms for the VPN tunnel for phase 2 IKE negotiations. - phase1DHGroupNumberSet: - allOf: - - $ref: '#/components/schemas/Phase1DHGroupNumbersList' - - description: The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 1 IKE negotiations. - phase2DHGroupNumberSet: - allOf: - - $ref: '#/components/schemas/Phase2DHGroupNumbersList' - - description: The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 2 IKE negotiations. - ikeVersionSet: - allOf: - - $ref: '#/components/schemas/IKEVersionsList' - - description: The IKE versions that are permitted for the VPN tunnel. - startupAction: - allOf: - - $ref: '#/components/schemas/String' - - description: The action to take when the establishing the VPN tunnels for a VPN connection. - description: The VPN tunnel options. - TunnelOptionsList: - type: array - items: - allOf: - - $ref: '#/components/schemas/TunnelOption' - - xml: - name: item - UnassignIpv6AddressesRequest: - type: object - required: - - NetworkInterfaceId - title: UnassignIpv6AddressesRequest - properties: - ipv6Addresses: - allOf: - - $ref: '#/components/schemas/Ipv6AddressList' - - description: The IPv6 addresses to unassign from the network interface. - Ipv6Prefix: - allOf: - - $ref: '#/components/schemas/IpPrefixList' - - description: One or more IPv6 prefixes to unassign from the network interface. - networkInterfaceId: - allOf: - - $ref: '#/components/schemas/NetworkInterfaceId' - - description: The ID of the network interface. - UnassignPrivateIpAddressesRequest: - type: object - required: - - NetworkInterfaceId - title: UnassignPrivateIpAddressesRequest - properties: - networkInterfaceId: - allOf: - - $ref: '#/components/schemas/NetworkInterfaceId' - - description: The ID of the network interface. - privateIpAddress: - allOf: - - $ref: '#/components/schemas/PrivateIpAddressStringList' - - description: The secondary private IP addresses to unassign from the network interface. You can specify this option multiple times to unassign more than one IP address. - Ipv4Prefix: - allOf: - - $ref: '#/components/schemas/IpPrefixList' - - description: The IPv4 prefixes to unassign from the network interface. - description: Contains the parameters for UnassignPrivateIpAddresses. - UnmonitorInstancesRequest: - type: object - required: - - InstanceIds - title: UnmonitorInstancesRequest - properties: - InstanceId: - allOf: - - $ref: '#/components/schemas/InstanceIdStringList' - - description: The IDs of the instances. - dryRun: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - UnsuccessfulInstanceCreditSpecificationErrorCode: - type: string - enum: - - InvalidInstanceID.Malformed - - InvalidInstanceID.NotFound - - IncorrectInstanceState - - InstanceCreditSpecification.NotSupported - UnsuccessfulInstanceCreditSpecificationItemError: - type: object - properties: - code: - allOf: - - $ref: '#/components/schemas/UnsuccessfulInstanceCreditSpecificationErrorCode' - - description: The error code. - message: - allOf: - - $ref: '#/components/schemas/String' - - description: The applicable error message. - description: Information about the error for the burstable performance instance whose credit option for CPU usage was not modified. - UnsuccessfulInstanceCreditSpecificationItem: - type: object - properties: - instanceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the instance. - error: - allOf: - - $ref: '#/components/schemas/UnsuccessfulInstanceCreditSpecificationItemError' - - description: The applicable error for the burstable performance instance whose credit option for CPU usage was not modified. - description: Describes the burstable performance instance whose credit option for CPU usage was not modified. - UnsuccessfulItemError: - type: object - properties: - code: - allOf: - - $ref: '#/components/schemas/String' - - description: The error code. - message: - allOf: - - $ref: '#/components/schemas/String' - - description: The error message accompanying the error code. - description: 'Information about the error that occurred. For more information about errors, see Error codes.' - UnsuccessfulItem: - type: object - properties: - error: - allOf: - - $ref: '#/components/schemas/UnsuccessfulItemError' - - description: Information about the error. - resourceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the resource. - description: Information about items that were not successfully processed in a batch call. - UpdateSecurityGroupRuleDescriptionsEgressRequest: - type: object - title: UpdateSecurityGroupRuleDescriptionsEgressRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/IpPermissionList' - - description: The IP permissions for the security group rule. You must specify either the IP permissions or the description. - SecurityGroupRuleDescription: - allOf: - - $ref: '#/components/schemas/SecurityGroupRuleDescriptionList' - - description: The description for the egress security group rules. You must specify either the description or the IP permissions. - UpdateSecurityGroupRuleDescriptionsIngressRequest: - type: object - title: UpdateSecurityGroupRuleDescriptionsIngressRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/IpPermissionList' - - description: The IP permissions for the security group rule. You must specify either IP permissions or a description. - SecurityGroupRuleDescription: - allOf: - - $ref: '#/components/schemas/SecurityGroupRuleDescriptionList' - - description: '[VPC only] The description for the ingress security group rules. You must specify either a description or IP permissions.' - UsageClassType: - type: string - enum: - - spot - - on-demand - UserIdGroupPair: - type: object - properties: - description: - allOf: - - $ref: '#/components/schemas/String' - - description: '

A description for the security group rule that references this user ID group pair.

Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*

' - groupId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the security group. - groupName: - allOf: - - $ref: '#/components/schemas/String' - - description: '

The name of the security group. In a request, use this parameter for a security group in EC2-Classic or a default VPC only. For a security group in a nondefault VPC, use the security group ID.

For a referenced security group in another VPC, this value is not returned if the referenced security group is deleted.

' - peeringStatus: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The status of a VPC peering connection, if applicable.' - userId: - allOf: - - $ref: '#/components/schemas/String' - - description: '

The ID of an Amazon Web Services account.

For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned.

[EC2-Classic] Required when adding or removing rules that reference a security group in another Amazon Web Services account.

' - vpcId: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The ID of the VPC for the referenced security group, if applicable.' - vpcPeeringConnectionId: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The ID of the VPC peering connection, if applicable.' - description: Describes a security group and Amazon Web Services account ID pair. - VCpuCount: - type: integer - VCpuCountRangeRequest: - type: object - required: - - Min - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Integer' - - description: 'The maximum number of vCPUs. To specify no maximum limit, omit this parameter.' - description: The minimum and maximum number of vCPUs. - VgwTelemetry: - type: object - properties: - acceptedRouteCount: - allOf: - - $ref: '#/components/schemas/Integer' - - description: The number of accepted routes. - lastStatusChange: - allOf: - - $ref: '#/components/schemas/DateTime' - - description: The date and time of the last change in status. - outsideIpAddress: - allOf: - - $ref: '#/components/schemas/String' - - description: The Internet-routable IP address of the virtual private gateway's outside interface. - status: - allOf: - - $ref: '#/components/schemas/TelemetryStatus' - - description: The status of the VPN tunnel. - statusMessage: - allOf: - - $ref: '#/components/schemas/String' - - description: 'If an error occurs, a description of the error.' - certificateArn: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Resource Name (ARN) of the VPN tunnel endpoint certificate. - description: Describes telemetry for a VPN tunnel. - VgwTelemetryList: - type: array - items: - allOf: - - $ref: '#/components/schemas/VgwTelemetry' - - xml: - name: item - VirtualizationTypeSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/VirtualizationType' - - xml: - name: item - minItems: 0 - maxItems: 2 - VolumeAttachmentList: - type: array - items: - allOf: - - $ref: '#/components/schemas/VolumeAttachment' - - xml: - name: item - VolumeState: - type: string - enum: - - creating - - available - - in-use - - deleting - - deleted - - error - VolumeAttachmentState: - type: string - enum: - - attaching - - attached - - detaching - - detached - - busy - VolumeAttributeName: - type: string - enum: - - autoEnableIO - - productCodes - VolumeModificationState: - type: string - enum: - - modifying - - optimizing - - completed - - failed - VolumeStatusAction: - type: object - properties: - code: - allOf: - - $ref: '#/components/schemas/String' - - description: 'The code identifying the operation, for example, enable-volume-io.' - description: - allOf: - - $ref: '#/components/schemas/String' - - description: A description of the operation. - eventId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the event associated with this operation. - eventType: - allOf: - - $ref: '#/components/schemas/String' - - description: The event type associated with this operation. - description: Describes a volume status operation code. - VolumeStatusActionsList: - type: array - items: - allOf: - - $ref: '#/components/schemas/VolumeStatusAction' - - xml: - name: item - VolumeStatusAttachmentStatus: - type: object - properties: - ioPerformance: - allOf: - - $ref: '#/components/schemas/String' - - description: The maximum IOPS supported by the attached instance. - instanceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the attached instance. - description: Information about the instances to which the volume is attached. - VolumeStatusAttachmentStatusList: - type: array - items: - allOf: - - $ref: '#/components/schemas/VolumeStatusAttachmentStatus' - - xml: - name: item - VolumeStatusName: - type: string - enum: - - io-enabled - - io-performance - VolumeStatusDetails: - type: object - properties: - name: - allOf: - - $ref: '#/components/schemas/VolumeStatusName' - - description: The name of the volume status. - status: - allOf: - - $ref: '#/components/schemas/String' - - description: The intended status of the volume status. - description: Describes a volume status. - VolumeStatusDetailsList: - type: array - items: - allOf: - - $ref: '#/components/schemas/VolumeStatusDetails' - - xml: - name: item - VolumeStatusEvent: - type: object - properties: - description: - allOf: - - $ref: '#/components/schemas/String' - - description: A description of the event. - eventId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of this event. - eventType: - allOf: - - $ref: '#/components/schemas/String' - - description: The type of this event. - notAfter: - allOf: - - $ref: '#/components/schemas/MillisecondDateTime' - - description: The latest end time of the event. - notBefore: - allOf: - - $ref: '#/components/schemas/MillisecondDateTime' - - description: The earliest start time of the event. - instanceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the instance associated with the event. - description: Describes a volume status event. - VolumeStatusEventsList: - type: array - items: - allOf: - - $ref: '#/components/schemas/VolumeStatusEvent' - - xml: - name: item - VolumeStatusInfoStatus: - type: string - enum: - - ok - - impaired - - insufficient-data - VolumeStatusInfo: - type: object - properties: - details: - allOf: - - $ref: '#/components/schemas/VolumeStatusDetailsList' - - description: The details of the volume status. - status: - allOf: - - $ref: '#/components/schemas/VolumeStatusInfoStatus' - - description: The status of the volume. - description: Describes the status of a volume. - VolumeStatusItem: - type: object - properties: - actionsSet: - allOf: - - $ref: '#/components/schemas/VolumeStatusActionsList' - - description: The details of the operation. - availabilityZone: - allOf: - - $ref: '#/components/schemas/String' - - description: The Availability Zone of the volume. - outpostArn: - allOf: - - $ref: '#/components/schemas/String' - - description: The Amazon Resource Name (ARN) of the Outpost. - eventsSet: - allOf: - - $ref: '#/components/schemas/VolumeStatusEventsList' - - description: A list of events associated with the volume. - volumeId: - allOf: - - $ref: '#/components/schemas/String' - - description: The volume ID. - volumeStatus: - allOf: - - $ref: '#/components/schemas/VolumeStatusInfo' - - description: The volume status. - attachmentStatuses: - allOf: - - $ref: '#/components/schemas/VolumeStatusAttachmentStatusList' - - description: Information about the instances to which the volume is attached. - description: Describes the volume status. - VpcState: - type: string - enum: - - pending - - available - VpcIpv6CidrBlockAssociationSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/VpcIpv6CidrBlockAssociation' - - xml: - name: item - VpcCidrBlockAssociationSet: - type: array - items: - allOf: - - $ref: '#/components/schemas/VpcCidrBlockAssociation' - - xml: - name: item - VpcAttachmentList: - type: array - items: - allOf: - - $ref: '#/components/schemas/VpcAttachment' - - xml: - name: item - VpcAttributeName: - type: string - enum: - - enableDnsSupport - - enableDnsHostnames - VpcCidrBlockState: - type: object - properties: - state: - allOf: - - $ref: '#/components/schemas/VpcCidrBlockStateCode' - - description: The state of the CIDR block. - statusMessage: - allOf: - - $ref: '#/components/schemas/String' - - description: 'A message about the status of the CIDR block, if applicable.' - description: Describes the state of a CIDR block. - VpcCidrBlockStateCode: - type: string - enum: - - associating - - associated - - disassociating - - disassociated - - failing - - failed - VpcClassicLink: - type: object - properties: - classicLinkEnabled: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether the VPC is enabled for ClassicLink. - tagSet: - allOf: - - $ref: '#/components/schemas/TagList' - - description: Any tags assigned to the VPC. - vpcId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the VPC. - description: Describes whether a VPC is enabled for ClassicLink. - VpcEndpointType: - type: string - enum: - - Interface - - Gateway - - GatewayLoadBalancer - VpcEndpointConnection: - type: object - properties: - serviceId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the service to which the endpoint is connected. - vpcEndpointId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the VPC endpoint. - vpcEndpointOwner: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Amazon Web Services account that owns the VPC endpoint. - vpcEndpointState: - allOf: - - $ref: '#/components/schemas/State' - - description: The state of the VPC endpoint. - creationTimestamp: - allOf: - - $ref: '#/components/schemas/MillisecondDateTime' - - description: The date and time that the VPC endpoint was created. - dnsEntrySet: - allOf: - - $ref: '#/components/schemas/DnsEntrySet' - - description: The DNS entries for the VPC endpoint. - networkLoadBalancerArnSet: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The Amazon Resource Names (ARNs) of the network load balancers for the service. - gatewayLoadBalancerArnSet: - allOf: - - $ref: '#/components/schemas/ValueStringList' - - description: The Amazon Resource Names (ARNs) of the Gateway Load Balancers for the service. - ipAddressType: - allOf: - - $ref: '#/components/schemas/IpAddressType' - - description: The IP address type for the endpoint. - description: Describes a VPC endpoint connection to a service. - VpcPeeringConnectionVpcInfo: - type: object - properties: - cidrBlock: - allOf: - - $ref: '#/components/schemas/String' - - description: The IPv4 CIDR block for the VPC. - ipv6CidrBlockSet: - allOf: - - $ref: '#/components/schemas/Ipv6CidrBlockSet' - - description: The IPv6 CIDR block for the VPC. - cidrBlockSet: - allOf: - - $ref: '#/components/schemas/CidrBlockSet' - - description: Information about the IPv4 CIDR blocks for the VPC. - ownerId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the Amazon Web Services account that owns the VPC. - peeringOptions: - allOf: - - $ref: '#/components/schemas/VpcPeeringConnectionOptionsDescription' - - description: Information about the VPC peering connection options for the accepter or requester VPC. - vpcId: - allOf: - - $ref: '#/components/schemas/String' - - description: The ID of the VPC. - region: - allOf: - - $ref: '#/components/schemas/String' - - description: The Region in which the VPC is located. - description: Describes a VPC in a VPC peering connection. - VpcPeeringConnectionStateReason: - type: object - properties: - code: - allOf: - - $ref: '#/components/schemas/VpcPeeringConnectionStateReasonCode' - - description: The status of the VPC peering connection. - message: - allOf: - - $ref: '#/components/schemas/String' - - description: 'A message that provides more information about the status, if applicable.' - description: Describes the status of a VPC peering connection. - VpcPeeringConnectionIdList: - type: array - items: - allOf: - - $ref: '#/components/schemas/VpcPeeringConnectionId' - - xml: - name: item - VpcPeeringConnectionOptionsDescription: - type: object - properties: - allowDnsResolutionFromRemoteVpc: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether a local VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC. - allowEgressFromLocalClassicLinkToRemoteVpc: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether a local ClassicLink connection can communicate with the peer VPC over the VPC peering connection. - allowEgressFromLocalVpcToRemoteClassicLink: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether a local VPC can communicate with a ClassicLink connection in the peer VPC over the VPC peering connection. - description: Describes the VPC peering connection options. - VpcPeeringConnectionStateReasonCode: - type: string - enum: - - initiating-request - - pending-acceptance - - active - - deleted - - rejected - - failed - - expired - - provisioning - - deleting - VpcTenancy: - type: string - enum: - - default - VpnState: - type: string - enum: - - pending - - available - - deleting - - deleted - VpnConnectionOptions: - type: object - properties: - enableAcceleration: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether acceleration is enabled for the VPN connection. - staticRoutesOnly: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP. - localIpv4NetworkCidr: - allOf: - - $ref: '#/components/schemas/String' - - description: The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection. - remoteIpv4NetworkCidr: - allOf: - - $ref: '#/components/schemas/String' - - description: The IPv4 CIDR on the Amazon Web Services side of the VPN connection. - localIpv6NetworkCidr: - allOf: - - $ref: '#/components/schemas/String' - - description: The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection. - remoteIpv6NetworkCidr: - allOf: - - $ref: '#/components/schemas/String' - - description: The IPv6 CIDR on the Amazon Web Services side of the VPN connection. - tunnelInsideIpVersion: - allOf: - - $ref: '#/components/schemas/TunnelInsideIpVersion' - - description: Indicates whether the VPN tunnels process IPv4 or IPv6 traffic. - tunnelOptionSet: - allOf: - - $ref: '#/components/schemas/TunnelOptionsList' - - description: Indicates the VPN tunnel options. - description: Describes VPN connection options. - VpnStaticRouteList: - type: array - items: - allOf: - - $ref: '#/components/schemas/VpnStaticRoute' - - xml: - name: item - VpnConnectionDeviceType: - type: object - properties: - vpnConnectionDeviceTypeId: - allOf: - - $ref: '#/components/schemas/String' - - description: Customer gateway device identifier. - vendor: - allOf: - - $ref: '#/components/schemas/String' - - description: Customer gateway device vendor. - platform: - allOf: - - $ref: '#/components/schemas/String' - - description: Customer gateway device platform. - software: - allOf: - - $ref: '#/components/schemas/String' - - description: Customer gateway device software version. - description: 'List of customer gateway devices that have a sample configuration file available for use. You can also see the list of device types with sample configuration files available under Your customer gateway device in the Amazon Web Services Site-to-Site VPN User Guide.' - VpnConnectionDeviceTypeId: - type: string - VpnStaticRouteSource: - type: string - enum: - - Static - VpnStaticRoute: - type: object - properties: - destinationCidrBlock: - allOf: - - $ref: '#/components/schemas/String' - - description: The CIDR block associated with the local subnet of the customer data center. - source: - allOf: - - $ref: '#/components/schemas/VpnStaticRouteSource' - - description: Indicates how the routes were provided. - state: - allOf: - - $ref: '#/components/schemas/VpnState' - - description: The current state of the static route. - description: Describes a static route for a VPN connection. - VpnTunnelOptionsSpecification: - type: object - properties: - undefined: - allOf: - - $ref: '#/components/schemas/String' - - description: '

The action to take after DPD timeout occurs. Specify restart to restart the IKE initiation. Specify clear to end the IKE session.

Valid Values: clear | none | restart

Default: clear

' - Phase1EncryptionAlgorithm: - allOf: - - $ref: '#/components/schemas/Phase1EncryptionAlgorithmsRequestList' - - description: '

One or more encryption algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.

Valid values: AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16

' - Phase2EncryptionAlgorithm: - allOf: - - $ref: '#/components/schemas/Phase2EncryptionAlgorithmsRequestList' - - description: '

One or more encryption algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.

Valid values: AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16

' - Phase1IntegrityAlgorithm: - allOf: - - $ref: '#/components/schemas/Phase1IntegrityAlgorithmsRequestList' - - description: '

One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.

Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512

' - Phase2IntegrityAlgorithm: - allOf: - - $ref: '#/components/schemas/Phase2IntegrityAlgorithmsRequestList' - - description: '

One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.

Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512

' - Phase1DHGroupNumber: - allOf: - - $ref: '#/components/schemas/Phase1DHGroupNumbersRequestList' - - description: '

One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 1 IKE negotiations.

Valid values: 2 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24

' - Phase2DHGroupNumber: - allOf: - - $ref: '#/components/schemas/Phase2DHGroupNumbersRequestList' - - description: '

One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 2 IKE negotiations.

Valid values: 2 | 5 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24

' - IKEVersion: - allOf: - - $ref: '#/components/schemas/String' - - description: '

The action to take when the establishing the tunnel for the VPN connection. By default, your customer gateway device must initiate the IKE negotiation and bring up the tunnel. Specify start for Amazon Web Services to initiate the IKE negotiation.

Valid Values: add | start

Default: add

' - description: The tunnel options for a single VPN tunnel. - VpnTunnelOptionsSpecificationsList: - type: array - items: - $ref: '#/components/schemas/VpnTunnelOptionsSpecification' - WithdrawByoipCidrRequest: - type: object - required: - - Cidr - title: WithdrawByoipCidrRequest - properties: - undefined: - allOf: - - $ref: '#/components/schemas/Boolean' - - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.' - ZoneIdStringList: - type: array - items: - allOf: - - $ref: '#/components/schemas/String' - - xml: - name: ZoneId -security: - - hmac: [] -x-stackQL-config: - queryParamTranspose: - algorithm: AWSCanonical - requestTranslate: - algorithm: get_query_to_post_form_utf_8 \ No newline at end of file diff --git a/providers/src/aws/v00.00.00000/services/iam.yaml b/providers/src/aws/v00.00.00000/services/iam.yaml index b4e5ad13..930dc7e2 100644 --- a/providers/src/aws/v00.00.00000/services/iam.yaml +++ b/providers/src/aws/v00.00.00000/services/iam.yaml @@ -2864,6 +2864,445 @@ components: description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: + user_policies: + id: aws.iam.user_policies + x-cfn-schema-name: UserPolicy + x-example-where-clause: WHERE region = 'us-east-1' /* always 'us-east-1' for iam */ AND UserName = '' AND PolicyName = '' + x-type: cloud_control + methods: + attach: + serviceName: iam + operation: + $ref: '#/paths/~1?Action=AttachUserPolicy&Version=2010-05-08&__nativeEndpoint=true/get' + response: + openAPIDocKey: '200' + delete: + serviceName: iam + operation: + $ref: '#/paths/~1?Action=DeleteUserPolicy&Version=2010-05-08&__nativeEndpoint=true/get' + response: + openAPIDocKey: '200' + detach: + serviceName: iam + operation: + $ref: '#/paths/~1?Action=DetachUserPolicy&Version=2010-05-08&__nativeEndpoint=true/get' + response: + openAPIDocKey: '200' + get: + serviceName: iam + operation: + $ref: '#/paths/~1?Action=GetUserPolicy&Version=2010-05-08&__nativeEndpoint=true/get' + response: + mediaType: text/xml + objectKey: /*/GetUserPolicyResult + openAPIDocKey: '200' + list: + serviceName: iam + operation: + $ref: '#/paths/~1?Action=ListUserPolicies&Version=2010-05-08&__nativeEndpoint=true/get' + response: + mediaType: text/xml + objectKey: /*/ListUserPoliciesResult/PolicyNames/member + openAPIDocKey: '200' + put: + serviceName: iam + operation: + $ref: '#/paths/~1?Action=PutUserPolicy&Version=2010-05-08&__nativeEndpoint=true/get' + response: + openAPIDocKey: '200' + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__UserPolicy&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IAM::UserPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IAM::UserPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IAM::UserPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + name: user_policies + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/user_policies/methods/delete_resource' + insert: + - $ref: '#/components/x-stackQL-resources/user_policies/methods/create_resource' + select: + - $ref: '#/components/x-stackQL-resources/user_policies/methods/get' + - $ref: '#/components/x-stackQL-resources/user_policies/methods/list' + update: + - $ref: '#/components/x-stackQL-resources/user_policies/methods/update_resource' + title: user_policies + x-cfn-type-name: AWS::IAM::UserPolicy + x-identifiers: + - PolicyName + - UserName + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.PolicyDocument') as policy_document, + JSON_EXTRACT(Properties, '$.PolicyName') as policy_name, + JSON_EXTRACT(Properties, '$.UserName') as user_name + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IAM::UserPolicy' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'PolicyDocument') as policy_document, + json_extract_path_text(Properties, 'PolicyName') as policy_name, + json_extract_path_text(Properties, 'UserName') as user_name + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IAM::UserPolicy' + AND data__Identifier = '|' + AND region = 'us-east-1' + group_policies: + id: aws.iam.group_policies + x-cfn-schema-name: GroupPolicy + x-example-where-clause: WHERE region = 'us-east-1' /* always 'us-east-1' for iam */ AND GroupName = '' AND PolicyName = '' + x-type: cloud_control + methods: + attach: + serviceName: iam + operation: + $ref: '#/paths/~1?Action=AttachGroupPolicy&Version=2010-05-08&__nativeEndpoint=true/get' + response: + openAPIDocKey: '200' + delete: + serviceName: iam + operation: + $ref: '#/paths/~1?Action=DeleteGroupPolicy&Version=2010-05-08&__nativeEndpoint=true/get' + response: + openAPIDocKey: '200' + detach: + serviceName: iam + operation: + $ref: '#/paths/~1?Action=DetachGroupPolicy&Version=2010-05-08&__nativeEndpoint=true/get' + response: + openAPIDocKey: '200' + get: + serviceName: iam + operation: + $ref: '#/paths/~1?Action=GetGroupPolicy&Version=2010-05-08&__nativeEndpoint=true/get' + response: + mediaType: text/xml + objectKey: /*/GetGroupPolicyResult + openAPIDocKey: '200' + list: + serviceName: iam + operation: + $ref: '#/paths/~1?Action=ListGroupPolicies&Version=2010-05-08&__nativeEndpoint=true/get' + response: + mediaType: text/xml + objectKey: /*/ListGroupPoliciesResult/PolicyNames/member + openAPIDocKey: '200' + put: + serviceName: iam + operation: + $ref: '#/paths/~1?Action=PutGroupPolicy&Version=2010-05-08&__nativeEndpoint=true/get' + response: + openAPIDocKey: '200' + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__GroupPolicy&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IAM::GroupPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IAM::GroupPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IAM::GroupPolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + name: group_policies + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/group_policies/methods/delete_resource' + insert: + - $ref: '#/components/x-stackQL-resources/group_policies/methods/create_resource' + select: + - $ref: '#/components/x-stackQL-resources/group_policies/methods/get' + - $ref: '#/components/x-stackQL-resources/group_policies/methods/list' + update: + - $ref: '#/components/x-stackQL-resources/group_policies/methods/update_resource' + title: group_policies + x-cfn-type-name: AWS::IAM::GroupPolicy + x-identifiers: + - PolicyName + - GroupName + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.PolicyDocument') as policy_document, + JSON_EXTRACT(Properties, '$.PolicyName') as policy_name, + JSON_EXTRACT(Properties, '$.GroupName') as group_name + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IAM::GroupPolicy' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'PolicyDocument') as policy_document, + json_extract_path_text(Properties, 'PolicyName') as policy_name, + json_extract_path_text(Properties, 'GroupName') as group_name + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IAM::GroupPolicy' + AND data__Identifier = '|' + AND region = 'us-east-1' + policies: + id: aws.iam.policies + x-cfn-schema-name: GetPolicyResponse + x-example-where-clause: WHERE region = 'us-east-1' /* always 'us-east-1' for iam */ AND PolicyArn = '' + x-type: native + methods: + create: + serviceName: iam + operation: + $ref: '#/paths/~1?Action=CreatePolicy&Version=2010-05-08&__nativeEndpoint=true/get' + response: + mediaType: text/xml + openAPIDocKey: '200' + delete: + serviceName: iam + operation: + $ref: '#/paths/~1?Action=DeletePolicy&Version=2010-05-08&__nativeEndpoint=true/get' + response: + openAPIDocKey: '200' + get: + serviceName: iam + operation: + $ref: '#/paths/~1?Action=GetPolicy&Version=2010-05-08&__nativeEndpoint=true/get' + response: + mediaType: text/xml + objectKey: /*/GetPolicyResult + openAPIDocKey: '200' + list: + serviceName: iam + operation: + $ref: '#/paths/~1?Action=ListPolicies&Version=2010-05-08&__nativeEndpoint=true/get' + response: + mediaType: text/xml + objectKey: /*/ListPoliciesResult/Policies/member + openAPIDocKey: '200' + tag: + serviceName: iam + operation: + $ref: '#/paths/~1?Action=TagPolicy&Version=2010-05-08&__nativeEndpoint=true/get' + response: + openAPIDocKey: '200' + untag: + serviceName: iam + operation: + $ref: '#/paths/~1?Action=UntagPolicy&Version=2010-05-08&__nativeEndpoint=true/get' + response: + openAPIDocKey: '200' + name: policies + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/policies/methods/delete' + insert: + - $ref: '#/components/x-stackQL-resources/policies/methods/create' + select: + - $ref: '#/components/x-stackQL-resources/policies/methods/get' + - $ref: '#/components/x-stackQL-resources/policies/methods/list' + update: [] + title: policies + role_policies: + id: aws.iam.role_policies + x-cfn-schema-name: RolePolicy + x-example-where-clause: WHERE region = 'us-east-1' /* always 'us-east-1' for iam */ AND RoleName = '' AND PolicyName = '' + x-type: cloud_control + methods: + attach: + serviceName: iam + operation: + $ref: '#/paths/~1?Action=AttachRolePolicy&Version=2010-05-08&__nativeEndpoint=true/get' + response: + openAPIDocKey: '200' + delete: + serviceName: iam + operation: + $ref: '#/paths/~1?Action=DeleteRolePolicy&Version=2010-05-08&__nativeEndpoint=true/get' + response: + openAPIDocKey: '200' + detach: + serviceName: iam + operation: + $ref: '#/paths/~1?Action=DetachRolePolicy&Version=2010-05-08&__nativeEndpoint=true/get' + response: + openAPIDocKey: '200' + get: + serviceName: iam + operation: + $ref: '#/paths/~1?Action=GetRolePolicy&Version=2010-05-08&__nativeEndpoint=true/get' + response: + mediaType: text/xml + objectKey: /*/GetRolePolicyResult + openAPIDocKey: '200' + list: + serviceName: iam + operation: + $ref: '#/paths/~1?Action=ListRolePolicies&Version=2010-05-08&__nativeEndpoint=true/get' + response: + mediaType: text/xml + objectKey: /*/ListRolePoliciesResult/PolicyNames/member + openAPIDocKey: '200' + put: + serviceName: iam + operation: + $ref: '#/paths/~1?Action=PutRolePolicy&Version=2010-05-08&__nativeEndpoint=true/get' + response: + openAPIDocKey: '200' + create_resource: + config: + requestBodyTranslate: + algorithm: naive_DesiredState + operation: + $ref: '#/paths/~1?Action=CreateResource&Version=2021-09-30&__RolePolicy&__detailTransformed=true/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IAM::RolePolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + update_resource: + operation: + $ref: '#/paths/~1?Action=UpdateResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IAM::RolePolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + delete_resource: + operation: + $ref: '#/paths/~1?Action=DeleteResource&Version=2021-09-30/post' + request: + mediaType: application/x-amz-json-1.0 + base: |- + { + "TypeName": "AWS::IAM::RolePolicy" + } + response: + mediaType: application/json + openAPIDocKey: '200' + name: role_policies + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/role_policies/methods/delete_resource' + insert: + - $ref: '#/components/x-stackQL-resources/role_policies/methods/create_resource' + select: + - $ref: '#/components/x-stackQL-resources/role_policies/methods/get' + - $ref: '#/components/x-stackQL-resources/role_policies/methods/list' + update: + - $ref: '#/components/x-stackQL-resources/role_policies/methods/update_resource' + title: role_policies + x-cfn-type-name: AWS::IAM::RolePolicy + x-identifiers: + - PolicyName + - RoleName + config: + views: + select: + predicate: sqlDialect == "sqlite3" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + JSON_EXTRACT(Properties, '$.PolicyDocument') as policy_document, + JSON_EXTRACT(Properties, '$.PolicyName') as policy_name, + JSON_EXTRACT(Properties, '$.RoleName') as role_name + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IAM::RolePolicy' + AND data__Identifier = '|' + AND region = 'us-east-1' + fallback: + predicate: sqlDialect == "postgres" && requiredParams == [ data__Identifier ] + ddl: |- + SELECT + region, + data__Identifier, + json_extract_path_text(Properties, 'PolicyDocument') as policy_document, + json_extract_path_text(Properties, 'PolicyName') as policy_name, + json_extract_path_text(Properties, 'RoleName') as role_name + FROM aws.cloud_control.resource WHERE data__TypeName = 'AWS::IAM::RolePolicy' + AND data__Identifier = '|' + AND region = 'us-east-1' groups: name: groups id: aws.iam.groups @@ -2965,63 +3404,6 @@ components: json_extract_path_text(Properties, 'GroupName') as group_name FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::Group' AND region = 'us-east-1' - group_policies: - id: aws.iam.group_policies - x-cfn-schema-name: GetGroupPolicyResponse - x-example-where-clause: WHERE region = 'us-east-1' /* always 'us-east-1' for iam */ AND GroupName = '' AND PolicyName = '' - x-type: native - methods: - attach: - serviceName: iam - operation: - $ref: '#/paths/~1?Action=AttachGroupPolicy&Version=2010-05-08&__nativeEndpoint=true/get' - response: - openAPIDocKey: '200' - delete: - serviceName: iam - operation: - $ref: '#/paths/~1?Action=DeleteGroupPolicy&Version=2010-05-08&__nativeEndpoint=true/get' - response: - openAPIDocKey: '200' - detach: - serviceName: iam - operation: - $ref: '#/paths/~1?Action=DetachGroupPolicy&Version=2010-05-08&__nativeEndpoint=true/get' - response: - openAPIDocKey: '200' - get: - serviceName: iam - operation: - $ref: '#/paths/~1?Action=GetGroupPolicy&Version=2010-05-08&__nativeEndpoint=true/get' - response: - mediaType: text/xml - objectKey: /*/GetGroupPolicyResult - openAPIDocKey: '200' - list: - serviceName: iam - operation: - $ref: '#/paths/~1?Action=ListGroupPolicies&Version=2010-05-08&__nativeEndpoint=true/get' - response: - mediaType: text/xml - objectKey: /*/ListGroupPoliciesResult/PolicyNames/member - openAPIDocKey: '200' - put: - serviceName: iam - operation: - $ref: '#/paths/~1?Action=PutGroupPolicy&Version=2010-05-08&__nativeEndpoint=true/get' - response: - openAPIDocKey: '200' - name: group_policies - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/group_policies/methods/delete' - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/group_policies/methods/get' - - $ref: '#/components/x-stackQL-resources/group_policies/methods/list' - update: - - $ref: '#/components/x-stackQL-resources/group_policies/methods/put' - title: group_policies instance_profiles: name: instance_profiles id: aws.iam.instance_profiles @@ -3456,63 +3838,6 @@ components: json_extract_path_text(Properties, 'RoleName') as role_name FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::Role' AND region = 'us-east-1' - role_policies: - id: aws.iam.role_policies - x-cfn-schema-name: GetRolePolicyResponse - x-example-where-clause: WHERE region = 'us-east-1' /* always 'us-east-1' for iam */ AND RoleName = '' AND PolicyName = '' - x-type: native - methods: - attach: - serviceName: iam - operation: - $ref: '#/paths/~1?Action=AttachRolePolicy&Version=2010-05-08&__nativeEndpoint=true/get' - response: - openAPIDocKey: '200' - delete: - serviceName: iam - operation: - $ref: '#/paths/~1?Action=DeleteRolePolicy&Version=2010-05-08&__nativeEndpoint=true/get' - response: - openAPIDocKey: '200' - detach: - serviceName: iam - operation: - $ref: '#/paths/~1?Action=DetachRolePolicy&Version=2010-05-08&__nativeEndpoint=true/get' - response: - openAPIDocKey: '200' - get: - serviceName: iam - operation: - $ref: '#/paths/~1?Action=GetRolePolicy&Version=2010-05-08&__nativeEndpoint=true/get' - response: - mediaType: text/xml - objectKey: /*/GetRolePolicyResult - openAPIDocKey: '200' - list: - serviceName: iam - operation: - $ref: '#/paths/~1?Action=ListRolePolicies&Version=2010-05-08&__nativeEndpoint=true/get' - response: - mediaType: text/xml - objectKey: /*/ListRolePoliciesResult/PolicyNames/member - openAPIDocKey: '200' - put: - serviceName: iam - operation: - $ref: '#/paths/~1?Action=PutRolePolicy&Version=2010-05-08&__nativeEndpoint=true/get' - response: - openAPIDocKey: '200' - name: role_policies - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/role_policies/methods/delete' - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/role_policies/methods/get' - - $ref: '#/components/x-stackQL-resources/role_policies/methods/list' - update: - - $ref: '#/components/x-stackQL-resources/role_policies/methods/put' - title: role_policies saml_providers: name: saml_providers id: aws.iam.saml_providers @@ -3909,63 +4234,6 @@ components: json_extract_path_text(Properties, 'UserName') as user_name FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::User' AND region = 'us-east-1' - user_policies: - id: aws.iam.user_policies - x-cfn-schema-name: GetUserPolicyResponse - x-example-where-clause: WHERE region = 'us-east-1' /* always 'us-east-1' for iam */ AND UserName = '' AND PolicyName = '' - x-type: native - methods: - attach: - serviceName: iam - operation: - $ref: '#/paths/~1?Action=AttachUserPolicy&Version=2010-05-08&__nativeEndpoint=true/get' - response: - openAPIDocKey: '200' - delete: - serviceName: iam - operation: - $ref: '#/paths/~1?Action=DeleteUserPolicy&Version=2010-05-08&__nativeEndpoint=true/get' - response: - openAPIDocKey: '200' - detach: - serviceName: iam - operation: - $ref: '#/paths/~1?Action=DetachUserPolicy&Version=2010-05-08&__nativeEndpoint=true/get' - response: - openAPIDocKey: '200' - get: - serviceName: iam - operation: - $ref: '#/paths/~1?Action=GetUserPolicy&Version=2010-05-08&__nativeEndpoint=true/get' - response: - mediaType: text/xml - objectKey: /*/GetUserPolicyResult - openAPIDocKey: '200' - list: - serviceName: iam - operation: - $ref: '#/paths/~1?Action=ListUserPolicies&Version=2010-05-08&__nativeEndpoint=true/get' - response: - mediaType: text/xml - objectKey: /*/ListUserPoliciesResult/PolicyNames/member - openAPIDocKey: '200' - put: - serviceName: iam - operation: - $ref: '#/paths/~1?Action=PutUserPolicy&Version=2010-05-08&__nativeEndpoint=true/get' - response: - openAPIDocKey: '200' - name: user_policies - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/user_policies/methods/delete' - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/user_policies/methods/get' - - $ref: '#/components/x-stackQL-resources/user_policies/methods/list' - update: - - $ref: '#/components/x-stackQL-resources/user_policies/methods/put' - title: user_policies virtualmfa_devices: name: virtualmfa_devices id: aws.iam.virtualmfa_devices @@ -4067,64 +4335,6 @@ components: json_extract_path_text(Properties, 'SerialNumber') as serial_number FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::IAM::VirtualMFADevice' AND region = 'us-east-1' - policies: - id: aws.iam.policies - x-cfn-schema-name: GetPolicyResponse - x-example-where-clause: WHERE region = 'us-east-1' /* always 'us-east-1' for iam */ AND PolicyArn = '' - x-type: native - methods: - create: - serviceName: iam - operation: - $ref: '#/paths/~1?Action=CreatePolicy&Version=2010-05-08&__nativeEndpoint=true/get' - response: - mediaType: text/xml - openAPIDocKey: '200' - delete: - serviceName: iam - operation: - $ref: '#/paths/~1?Action=DeletePolicy&Version=2010-05-08&__nativeEndpoint=true/get' - response: - openAPIDocKey: '200' - get: - serviceName: iam - operation: - $ref: '#/paths/~1?Action=GetPolicy&Version=2010-05-08&__nativeEndpoint=true/get' - response: - mediaType: text/xml - objectKey: /*/GetPolicyResult - openAPIDocKey: '200' - list: - serviceName: iam - operation: - $ref: '#/paths/~1?Action=ListPolicies&Version=2010-05-08&__nativeEndpoint=true/get' - response: - mediaType: text/xml - objectKey: /*/ListPoliciesResult/Policies/member - openAPIDocKey: '200' - tag: - serviceName: iam - operation: - $ref: '#/paths/~1?Action=TagPolicy&Version=2010-05-08&__nativeEndpoint=true/get' - response: - openAPIDocKey: '200' - untag: - serviceName: iam - operation: - $ref: '#/paths/~1?Action=UntagPolicy&Version=2010-05-08&__nativeEndpoint=true/get' - response: - openAPIDocKey: '200' - name: policies - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/policies/methods/delete' - insert: - - $ref: '#/components/x-stackQL-resources/policies/methods/create' - select: - - $ref: '#/components/x-stackQL-resources/policies/methods/get' - - $ref: '#/components/x-stackQL-resources/policies/methods/list' - update: [] - title: policies paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/route53.yaml b/providers/src/aws/v00.00.00000/services/route53.yaml index 071a0811..f2353dc6 100644 --- a/providers/src/aws/v00.00.00000/services/route53.yaml +++ b/providers/src/aws/v00.00.00000/services/route53.yaml @@ -1647,6 +1647,39 @@ components: description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: + resource_record_sets: + name: resource_record_sets + x-cfn-schema-name: ResourceRecordSet + x-example-where-clause: WHERE region = 'us-east-1' /* always us-east-1 for route53 */ AND Id = '' + x-type: native + methods: + create_record_set: + serviceName: route53 + operation: + $ref: '#/paths/~12013-04-01~1hostedzone~1{Id}~1rrset~1?__nativeEndpoint=true/post' + request: + mediaType: text/xml + xmlRootAnnotation: xmlns="https://route53.amazonaws.com/doc/2013-04-01/" + response: + mediaType: text/xml + openAPIDocKey: '200' + list_record_sets: + serviceName: route53 + operation: + $ref: '#/paths/~12013-04-01~1hostedzone~1{Id}~1rrset?__nativeEndpoint=true/get' + response: + objectKey: /*/ResourceRecordSets/ResourceRecordSet + mediaType: text/xml + openAPIDocKey: '200' + id: aws.route53.resource_record_sets + sqlVerbs: + delete: [] + insert: + - $ref: '#/components/x-stackQL-resources/resource_record_sets/methods/create_record_set' + select: + - $ref: '#/components/x-stackQL-resources/resource_record_sets/methods/list_record_sets' + update: [] + title: resource_record_sets cidr_collections: name: cidr_collections id: aws.route53.cidr_collections @@ -2130,39 +2163,6 @@ components: json_extract_path_text(Properties, 'Name') as name FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Route53::KeySigningKey' AND region = 'us-east-1' - resource_record_sets: - name: resource_record_sets - x-cfn-schema-name: ResourceRecordSet - x-example-where-clause: WHERE region = 'us-east-1' /* always us-east-1 for route53 */ AND Id = '' - x-type: native - methods: - create_record_set: - serviceName: route53 - operation: - $ref: '#/paths/~12013-04-01~1hostedzone~1{Id}~1rrset~1?__nativeEndpoint=true/post' - request: - mediaType: text/xml - xmlRootAnnotation: xmlns="https://route53.amazonaws.com/doc/2013-04-01/" - response: - mediaType: text/xml - openAPIDocKey: '200' - list_record_sets: - serviceName: route53 - operation: - $ref: '#/paths/~12013-04-01~1hostedzone~1{Id}~1rrset?__nativeEndpoint=true/get' - response: - objectKey: /*/ResourceRecordSets/ResourceRecordSet - mediaType: text/xml - openAPIDocKey: '200' - id: aws.route53.resource_record_sets - sqlVerbs: - delete: [] - insert: - - $ref: '#/components/x-stackQL-resources/resource_record_sets/methods/create_record_set' - select: - - $ref: '#/components/x-stackQL-resources/resource_record_sets/methods/list_record_sets' - update: [] - title: resource_record_sets paths: /?Action=CreateResource&Version=2021-09-30: parameters: diff --git a/providers/src/aws/v00.00.00000/services/s3_api.yaml b/providers/src/aws/v00.00.00000/services/s3_api.yaml deleted file mode 100644 index ba40b67a..00000000 --- a/providers/src/aws/v00.00.00000/services/s3_api.yaml +++ /dev/null @@ -1,17160 +0,0 @@ -components: - parameters: - x-amz-security-token: - in: header - name: x-amz-security-token - required: false - schema: - type: string - schemas: - AbortDate: - format: date-time - type: string - AbortIncompleteMultipartUpload: - description: Specifies the days since the initiation of an incomplete multipart - upload that Amazon S3 will wait before permanently removing all parts of the - upload. For more information, see - Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy - in the Amazon S3 User Guide. - properties: - DaysAfterInitiation: - allOf: - - $ref: '#/components/schemas/DaysAfterInitiation' - - description: Specifies the number of days after which Amazon S3 aborts - an incomplete multipart upload. - type: object - AbortMultipartUploadOutput: - example: {} - properties: {} - type: object - AbortMultipartUploadRequest: - properties: {} - required: - - Bucket - - Key - - UploadId - title: AbortMultipartUploadRequest - type: object - AbortRuleId: - type: string - AccelerateConfiguration: - description: Configures the transfer acceleration state for an Amazon S3 bucket. - For more information, see Amazon - S3 Transfer Acceleration in the Amazon S3 User Guide. - properties: - Status: - allOf: - - $ref: '#/components/schemas/BucketAccelerateStatus' - - description: Specifies the transfer acceleration status of the bucket. - type: object - AcceptRanges: - type: string - AccessControlPolicy: - description: Contains the elements that set the ACL permissions for an object - per grantee. - properties: - AccessControlList: - allOf: - - $ref: '#/components/schemas/Grants' - - description: A list of grants. - Owner: - allOf: - - $ref: '#/components/schemas/Owner' - - description: Container for the bucket owner's display name and ID. - type: object - AccessControlTranslation: - description: A container for information about access control for replicas. - properties: - Owner: - allOf: - - $ref: '#/components/schemas/OwnerOverride' - - description: Specifies the replica ownership. For default and valid values, - see PUT - bucket replication in the Amazon S3 API Reference. - required: - - Owner - type: object - AccessPointArn: - type: string - AccountId: - type: string - AllowQuotedRecordDelimiter: - type: boolean - AllowedHeader: - type: string - AllowedHeaders: - items: - $ref: '#/components/schemas/AllowedHeader' - type: array - xml: - wrapped: false - AllowedMethod: - type: string - AllowedMethods: - items: - $ref: '#/components/schemas/AllowedMethod' - type: array - xml: - wrapped: false - AllowedOrigin: - type: string - AllowedOrigins: - items: - $ref: '#/components/schemas/AllowedOrigin' - type: array - xml: - wrapped: false - AnalyticsAndOperator: - description: A conjunction (logical AND) of predicates, which is used in evaluating - a metrics filter. The operator must have at least two predicates in any combination, - and an object must match all of the predicates for the filter to apply. - properties: - Prefix: - allOf: - - $ref: '#/components/schemas/Prefix' - - description: 'The prefix to use when evaluating an AND predicate: The - prefix that an object must have to be included in the metrics results.' - Tag: - allOf: - - $ref: '#/components/schemas/TagSet' - - description: The list of tags to use when evaluating an AND predicate. - type: object - xml: - wrapped: false - AnalyticsConfiguration: - description: Specifies the configuration and any analyses for the analytics - filter of an Amazon S3 bucket. - properties: - Filter: - allOf: - - $ref: '#/components/schemas/AnalyticsFilter' - - description: The filter used to describe a set of objects for analyses. - A filter must have exactly one prefix, one tag, or one conjunction (AnalyticsAndOperator). - If no filter is provided, all objects will be considered in any analysis. - Id: - allOf: - - $ref: '#/components/schemas/AnalyticsId' - - description: The ID that identifies the analytics configuration. - StorageClassAnalysis: - allOf: - - $ref: '#/components/schemas/StorageClassAnalysis' - - description: ' Contains data related to access patterns to be collected - and made available to analyze the tradeoffs between different storage - classes. ' - required: - - Id - - StorageClassAnalysis - type: object - AnalyticsConfigurationList: - items: - $ref: '#/components/schemas/AnalyticsConfiguration' - type: array - xml: - wrapped: false - AnalyticsExportDestination: - description: Where to publish the analytics results. - properties: - S3BucketDestination: - allOf: - - $ref: '#/components/schemas/AnalyticsS3BucketDestination' - - description: A destination signifying output to an S3 bucket. - required: - - S3BucketDestination - type: object - AnalyticsFilter: - description: The filter used to describe a set of objects for analyses. A filter - must have exactly one prefix, one tag, or one conjunction (AnalyticsAndOperator). - If no filter is provided, all objects will be considered in any analysis. - properties: - And: - allOf: - - $ref: '#/components/schemas/AnalyticsAndOperator' - - description: A conjunction (logical AND) of predicates, which is used - in evaluating an analytics filter. The operator must have at least two - predicates. - Prefix: - allOf: - - $ref: '#/components/schemas/Prefix' - - description: The prefix to use when evaluating an analytics filter. - Tag: - allOf: - - $ref: '#/components/schemas/Tag' - - description: The tag to use when evaluating an analytics filter. - type: object - AnalyticsId: - type: string - AnalyticsS3BucketDestination: - description: Contains information about where to publish the analytics results. - properties: - Bucket: - allOf: - - $ref: '#/components/schemas/BucketName' - - description: The Amazon Resource Name (ARN) of the bucket to which data - is exported. - BucketAccountId: - allOf: - - $ref: '#/components/schemas/AccountId' - - description:

The account ID that owns the destination S3 bucket. If - no account ID is provided, the owner is not validated before exporting - data.

Although this value is optional, we strongly recommend - that you set it to help prevent problems if the destination bucket ownership - changes.

- Format: - allOf: - - $ref: '#/components/schemas/AnalyticsS3ExportFileFormat' - - description: Specifies the file format used when exporting data to Amazon - S3. - Prefix: - allOf: - - $ref: '#/components/schemas/Prefix' - - description: The prefix to use when exporting data. The prefix is prepended - to all results. - required: - - Format - - Bucket - type: object - AnalyticsS3ExportFileFormat: - enum: - - CSV - type: string - ArchiveStatus: - enum: - - ARCHIVE_ACCESS - - DEEP_ARCHIVE_ACCESS - type: string - Body: - type: string - Bucket: - description: ' In terms of implementation, a Bucket is a resource. An Amazon - S3 bucket name is globally unique, and the namespace is shared by all Amazon - Web Services accounts. ' - properties: - CreationDate: - allOf: - - $ref: '#/components/schemas/CreationDate' - - description: Date the bucket was created. This date can change when making - changes to your bucket, such as editing its bucket policy. - Name: - allOf: - - $ref: '#/components/schemas/BucketName' - - description: The name of the bucket. - type: object - BucketAccelerateStatus: - enum: - - Enabled - - Suspended - type: string - BucketAlreadyExists: {} - BucketAlreadyOwnedByYou: {} - BucketCannedACL: - enum: - - private - - public-read - - public-read-write - - authenticated-read - type: string - BucketKeyEnabled: - type: boolean - BucketLifecycleConfiguration: - description: Specifies the lifecycle configuration for objects in an Amazon - S3 bucket. For more information, see Object - Lifecycle Management in the Amazon S3 User Guide. - properties: - Rule: - allOf: - - $ref: '#/components/schemas/LifecycleRules' - - description: A lifecycle rule for individual objects in an Amazon S3 bucket. - required: - - Rules - type: object - BucketLocationConstraint: - enum: - - af-south-1 - - ap-east-1 - - ap-northeast-1 - - ap-northeast-2 - - ap-northeast-3 - - ap-south-1 - - ap-southeast-1 - - ap-southeast-2 - - ca-central-1 - - cn-north-1 - - cn-northwest-1 - - EU - - eu-central-1 - - eu-north-1 - - eu-south-1 - - eu-west-1 - - eu-west-2 - - eu-west-3 - - me-south-1 - - sa-east-1 - - us-east-2 - - us-gov-east-1 - - us-gov-west-1 - - us-west-1 - - us-west-2 - type: string - BucketLoggingStatus: - description: Container for logging status information. - properties: - LoggingEnabled: - $ref: '#/components/schemas/LoggingEnabled' - type: object - BucketLogsPermission: - enum: - - FULL_CONTROL - - READ - - WRITE - type: string - BucketName: - type: string - BucketVersioningStatus: - enum: - - Enabled - - Suspended - type: string - Buckets: - items: - allOf: - - $ref: '#/components/schemas/Bucket' - - xml: - name: Bucket - type: array - BypassGovernanceRetention: - type: boolean - BytesProcessed: - type: integer - BytesReturned: - type: integer - BytesScanned: - type: integer - CORSConfiguration: - description: Describes the cross-origin access configuration for objects in - an Amazon S3 bucket. For more information, see Enabling - Cross-Origin Resource Sharing in the Amazon S3 User Guide. - properties: - CORSRule: - allOf: - - $ref: '#/components/schemas/CORSRules' - - description: A set of origins and methods (cross-origin access that you - want to allow). You can add up to 100 rules to the configuration. - required: - - CORSRules - type: object - CORSRule: - description: Specifies a cross-origin access rule for an Amazon S3 bucket. - properties: - AllowedHeader: - allOf: - - $ref: '#/components/schemas/AllowedHeaders' - - description: Headers that are specified in the Access-Control-Request-Headers - header. These headers are allowed in a preflight OPTIONS request. In - response to any preflight OPTIONS request, Amazon S3 returns any requested - headers that are allowed. - AllowedMethod: - allOf: - - $ref: '#/components/schemas/AllowedMethods' - - description: An HTTP method that you allow the origin to execute. Valid - values are GET, PUT, HEAD, POST, - and DELETE. - AllowedOrigin: - allOf: - - $ref: '#/components/schemas/AllowedOrigins' - - description: One or more origins you want customers to be able to access - the bucket from. - ExposeHeader: - allOf: - - $ref: '#/components/schemas/ExposeHeaders' - - description: One or more headers in the response that you want customers - to be able to access from their applications (for example, from a JavaScript - XMLHttpRequest object). - ID: - allOf: - - $ref: '#/components/schemas/ID' - - description: Unique identifier for the rule. The value cannot be longer - than 255 characters. - MaxAgeSeconds: - allOf: - - $ref: '#/components/schemas/MaxAgeSeconds' - - description: The time in seconds that your browser is to cache the preflight - response for the specified resource. - required: - - AllowedMethods - - AllowedOrigins - type: object - CORSRules: - items: - $ref: '#/components/schemas/CORSRule' - type: array - xml: - wrapped: false - CSVInput: - description: Describes how an uncompressed comma-separated values (CSV)-formatted - input object is formatted. - properties: - AllowQuotedRecordDelimiter: - allOf: - - $ref: '#/components/schemas/AllowQuotedRecordDelimiter' - - description: Specifies that CSV field values may contain quoted record - delimiters and such records should be allowed. Default value is FALSE. - Setting this value to TRUE may lower performance. - Comments: - allOf: - - $ref: '#/components/schemas/Comments' - - description: A single character used to indicate that a row should be - ignored when the character is present at the start of that row. You - can specify any character to indicate a comment line. - FieldDelimiter: - allOf: - - $ref: '#/components/schemas/FieldDelimiter' - - description: A single character used to separate individual fields in - a record. You can specify an arbitrary delimiter. - FileHeaderInfo: - allOf: - - $ref: '#/components/schemas/FileHeaderInfo' - - description: "

Describes the first line of input. Valid values are:

\ - \

  • NONE: First line is not a header.

    • \ - \

  • IGNORE: First line is a header, but you can't\ - \ use the header values to indicate the column in an expression. You\ - \ can use column position (such as _1, _2, \u2026) to indicate the column\ - \ (SELECT s._1 FROM OBJECT s).

  • Use:\ - \ First line is a header, and you can use the header value to identify\ - \ a column in an expression (SELECT \"name\" FROM OBJECT).\ - \

" - QuoteCharacter: - allOf: - - $ref: '#/components/schemas/QuoteCharacter' - - description: '

A single character used for escaping when the field delimiter - is part of the value. For example, if the value is a, b, - Amazon S3 wraps this field value in quotation marks, as follows: " - a , b ".

Type: String

Default: "

-

Ancestors: CSV

' - QuoteEscapeCharacter: - allOf: - - $ref: '#/components/schemas/QuoteEscapeCharacter' - - description: A single character used for escaping the quotation mark character - inside an already escaped value. For example, the value """ a - , b """ is parsed as " a , b ". - RecordDelimiter: - allOf: - - $ref: '#/components/schemas/RecordDelimiter' - - description: A single character used to separate individual records in - the input. Instead of the default value, you can specify an arbitrary - delimiter. - type: object - CSVOutput: - description: Describes how uncompressed comma-separated values (CSV)-formatted - results are formatted. - properties: - FieldDelimiter: - allOf: - - $ref: '#/components/schemas/FieldDelimiter' - - description: The value used to separate individual fields in a record. - You can specify an arbitrary delimiter. - QuoteCharacter: - allOf: - - $ref: '#/components/schemas/QuoteCharacter' - - description: 'A single character used for escaping when the field delimiter - is part of the value. For example, if the value is a, b, - Amazon S3 wraps this field value in quotation marks, as follows: " - a , b ".' - QuoteEscapeCharacter: - allOf: - - $ref: '#/components/schemas/QuoteEscapeCharacter' - - description: The single character used for escaping the quote character - inside an already escaped value. - QuoteFields: - allOf: - - $ref: '#/components/schemas/QuoteFields' - - description: '

Indicates whether to use quotation marks around output - fields.

  • ALWAYS: Always use quotation - marks for output fields.

  • ASNEEDED: Use - quotation marks for output fields when needed.

' - RecordDelimiter: - allOf: - - $ref: '#/components/schemas/RecordDelimiter' - - description: A single character used to separate individual records in - the output. Instead of the default value, you can specify an arbitrary - delimiter. - type: object - CacheControl: - type: string - Checksum: - description: Contains all the possible checksum or digest values for an object. - properties: - ChecksumCRC32: - allOf: - - $ref: '#/components/schemas/ChecksumCRC32' - - description: The base64-encoded, 32-bit CRC32 checksum of the object. - This will only be present if it was uploaded with the object. With multipart - uploads, this may not be a checksum value of the object. For more information - about how checksums are calculated with multipart uploads, see - Checking object integrity in the Amazon S3 User Guide. - ChecksumCRC32C: - allOf: - - $ref: '#/components/schemas/ChecksumCRC32C' - - description: The base64-encoded, 32-bit CRC32C checksum of the object. - This will only be present if it was uploaded with the object. With multipart - uploads, this may not be a checksum value of the object. For more information - about how checksums are calculated with multipart uploads, see - Checking object integrity in the Amazon S3 User Guide. - ChecksumSHA1: - allOf: - - $ref: '#/components/schemas/ChecksumSHA1' - - description: The base64-encoded, 160-bit SHA-1 digest of the object. This - will only be present if it was uploaded with the object. With multipart - uploads, this may not be a checksum value of the object. For more information - about how checksums are calculated with multipart uploads, see - Checking object integrity in the Amazon S3 User Guide. - ChecksumSHA256: - allOf: - - $ref: '#/components/schemas/ChecksumSHA256' - - description: The base64-encoded, 256-bit SHA-256 digest of the object. - This will only be present if it was uploaded with the object. With multipart - uploads, this may not be a checksum value of the object. For more information - about how checksums are calculated with multipart uploads, see - Checking object integrity in the Amazon S3 User Guide. - type: object - ChecksumAlgorithm: - enum: - - CRC32 - - CRC32C - - SHA1 - - SHA256 - type: string - ChecksumAlgorithmList: - items: - $ref: '#/components/schemas/ChecksumAlgorithm' - type: array - xml: - wrapped: false - ChecksumCRC32: - type: string - ChecksumCRC32C: - type: string - ChecksumMode: - enum: - - ENABLED - type: string - ChecksumSHA1: - type: string - ChecksumSHA256: - type: string - CloudFunction: - type: string - CloudFunctionConfiguration: - description: Container for specifying the Lambda notification configuration. - properties: - CloudFunction: - allOf: - - $ref: '#/components/schemas/CloudFunction' - - description: Lambda cloud function ARN that Amazon S3 can invoke when - it detects events of the specified type. - Event: - allOf: - - $ref: '#/components/schemas/EventList' - - description: Bucket events for which to send notifications. - Id: - $ref: '#/components/schemas/NotificationId' - InvocationRole: - allOf: - - $ref: '#/components/schemas/CloudFunctionInvocationRole' - - description: The role supporting the invocation of the Lambda function - type: object - CloudFunctionInvocationRole: - type: string - Code: - type: string - Comments: - type: string - CommonPrefix: - description: 'Container for all (if there are any) keys between Prefix and the - next occurrence of the string specified by a delimiter. CommonPrefixes lists - keys that act like subdirectories in the directory specified by Prefix. For - example, if the prefix is notes/ and the delimiter is a slash (/) as in notes/summer/july, - the common prefix is notes/summer/. ' - properties: - Prefix: - allOf: - - $ref: '#/components/schemas/Prefix' - - description: Container for the specified common prefix. - type: object - CommonPrefixList: - items: - $ref: '#/components/schemas/CommonPrefix' - type: array - xml: - wrapped: false - CompleteMultipartUploadOutput: - example: - Bucket: acexamplebucket - ETag: '"4d9031c7644d8081c2829f4ea23c55f7-2"' - Key: bigobject - Location: https://examplebucket.s3..amazonaws.com/bigobject - properties: - Bucket: - allOf: - - $ref: '#/components/schemas/BucketName' - - description:

The name of the bucket that contains the newly created - object. Does not return the access point ARN or access point alias if - used.

When using this action with an access point, you must direct - requests to the access point hostname. The access point hostname takes - the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this action with an access point through the Amazon Web Services - SDKs, you provide the access point ARN in place of the bucket name. - For more information about access point ARNs, see Using - access points in the Amazon S3 User Guide.

When using - this action with Amazon S3 on Outposts, you must direct requests to - the S3 on Outposts hostname. The S3 on Outposts hostname takes the form - AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. - When using this action with S3 on Outposts through the Amazon Web Services - SDKs, you provide the Outposts bucket ARN in place of the bucket name. - For more information about S3 on Outposts ARNs, see Using - Amazon S3 on Outposts in the Amazon S3 User Guide.

- ChecksumCRC32: - allOf: - - $ref: '#/components/schemas/ChecksumCRC32' - - description: The base64-encoded, 32-bit CRC32 checksum of the object. - This will only be present if it was uploaded with the object. With multipart - uploads, this may not be a checksum value of the object. For more information - about how checksums are calculated with multipart uploads, see - Checking object integrity in the Amazon S3 User Guide. - ChecksumCRC32C: - allOf: - - $ref: '#/components/schemas/ChecksumCRC32C' - - description: The base64-encoded, 32-bit CRC32C checksum of the object. - This will only be present if it was uploaded with the object. With multipart - uploads, this may not be a checksum value of the object. For more information - about how checksums are calculated with multipart uploads, see - Checking object integrity in the Amazon S3 User Guide. - ChecksumSHA1: - allOf: - - $ref: '#/components/schemas/ChecksumSHA1' - - description: The base64-encoded, 160-bit SHA-1 digest of the object. This - will only be present if it was uploaded with the object. With multipart - uploads, this may not be a checksum value of the object. For more information - about how checksums are calculated with multipart uploads, see - Checking object integrity in the Amazon S3 User Guide. - ChecksumSHA256: - allOf: - - $ref: '#/components/schemas/ChecksumSHA256' - - description: The base64-encoded, 256-bit SHA-256 digest of the object. - This will only be present if it was uploaded with the object. With multipart - uploads, this may not be a checksum value of the object. For more information - about how checksums are calculated with multipart uploads, see - Checking object integrity in the Amazon S3 User Guide. - ETag: - allOf: - - $ref: '#/components/schemas/ETag' - - description: Entity tag that identifies the newly created object's data. - Objects with different object data will have different entity tags. - The entity tag is an opaque string. The entity tag may or may not be - an MD5 digest of the object data. If the entity tag is not an MD5 digest - of the object data, it will contain one or more nonhexadecimal characters - and/or will consist of less than 32 or more than 32 hexadecimal digits. - For more information about how the entity tag is calculated, see Checking - object integrity in the Amazon S3 User Guide. - Key: - allOf: - - $ref: '#/components/schemas/ObjectKey' - - description: The object key of the newly created object. - Location: - allOf: - - $ref: '#/components/schemas/Location' - - description: The URI that identifies the newly created object. - type: object - CompleteMultipartUploadRequest: - properties: - CompleteMultipartUpload: - allOf: - - $ref: '#/components/schemas/CompletedMultipartUpload' - - description: The container for the multipart upload request information. - required: - - Bucket - - Key - - UploadId - title: CompleteMultipartUploadRequest - type: object - xml: - namespace: http://s3.amazonaws.com/doc/2006-03-01/ - CompletedMultipartUpload: - description: The container for the completed multipart upload details. - properties: - Part: - allOf: - - $ref: '#/components/schemas/CompletedPartList' - - description:

Array of CompletedPart data types.

If you do not - supply a valid Part with your request, the service sends - back an HTTP 400 response.

- type: object - CompletedPart: - description: Details of the parts that were uploaded. - properties: - ChecksumCRC32: - allOf: - - $ref: '#/components/schemas/ChecksumCRC32' - - description: The base64-encoded, 32-bit CRC32 checksum of the object. - This will only be present if it was uploaded with the object. With multipart - uploads, this may not be a checksum value of the object. For more information - about how checksums are calculated with multipart uploads, see - Checking object integrity in the Amazon S3 User Guide. - ChecksumCRC32C: - allOf: - - $ref: '#/components/schemas/ChecksumCRC32C' - - description: The base64-encoded, 32-bit CRC32C checksum of the object. - This will only be present if it was uploaded with the object. With multipart - uploads, this may not be a checksum value of the object. For more information - about how checksums are calculated with multipart uploads, see - Checking object integrity in the Amazon S3 User Guide. - ChecksumSHA1: - allOf: - - $ref: '#/components/schemas/ChecksumSHA1' - - description: The base64-encoded, 160-bit SHA-1 digest of the object. This - will only be present if it was uploaded with the object. With multipart - uploads, this may not be a checksum value of the object. For more information - about how checksums are calculated with multipart uploads, see - Checking object integrity in the Amazon S3 User Guide. - ChecksumSHA256: - allOf: - - $ref: '#/components/schemas/ChecksumSHA256' - - description: The base64-encoded, 256-bit SHA-256 digest of the object. - This will only be present if it was uploaded with the object. With multipart - uploads, this may not be a checksum value of the object. For more information - about how checksums are calculated with multipart uploads, see - Checking object integrity in the Amazon S3 User Guide. - ETag: - allOf: - - $ref: '#/components/schemas/ETag' - - description: Entity tag returned when the part was uploaded. - PartNumber: - allOf: - - $ref: '#/components/schemas/PartNumber' - - description: Part number that identifies the part. This is a positive - integer between 1 and 10,000. - type: object - CompletedPartList: - items: - $ref: '#/components/schemas/CompletedPart' - type: array - xml: - wrapped: false - CompressionType: - enum: - - NONE - - GZIP - - BZIP2 - type: string - Condition: - description: A container for describing a condition that must be met for the - specified redirect to apply. For example, 1. If request is for pages in the - /docs folder, redirect to the /documents folder. - 2. If request results in HTTP error 4xx, redirect request to another host - where you might process the error. - properties: - HttpErrorCodeReturnedEquals: - allOf: - - $ref: '#/components/schemas/HttpErrorCodeReturnedEquals' - - description: The HTTP error code when the redirect is applied. In the - event of an error, if the error code equals this value, then the specified - redirect is applied. Required when parent element Condition - is specified and sibling KeyPrefixEquals is not specified. - If both are specified, then both must be true for the redirect to be - applied. - KeyPrefixEquals: - allOf: - - $ref: '#/components/schemas/KeyPrefixEquals' - - description:

The object key name prefix when the redirect is applied. - For example, to redirect requests for ExamplePage.html, - the key prefix will be ExamplePage.html. To redirect request - for all pages with the prefix docs/, the key prefix will - be /docs, which identifies all objects in the docs/ - folder. Required when the parent element Condition is specified - and sibling HttpErrorCodeReturnedEquals is not specified. - If both conditions are specified, both must be true for the redirect - to be applied.

Replacement must be made for object - keys containing special characters (such as carriage returns) when using - XML requests. For more information, see - XML related object key constraints.

 - type: object - ConfirmRemoveSelfBucketAccess: - type: boolean - ContentDisposition: - type: string - ContentEncoding: - type: string - ContentLanguage: - type: string - ContentLength: - type: integer - ContentMD5: - type: string - ContentRange: - type: string - ContentType: - type: string - ContinuationEvent: - description:

- properties: {} - type: object - CopyObjectOutput: - example: - CopyObjectResult: - ETag: '"6805f2cfc46c0f04559748bb039d69ae"' - LastModified: '2016-12-15T17:38:53.000Z' - properties: - CopyObjectResult: - allOf: - - $ref: '#/components/schemas/CopyObjectResult' - - description: Container for all response elements. - type: object - CopyObjectRequest: - properties: - x-amz-meta-: - allOf: - - $ref: '#/components/schemas/Metadata' - - description: A map of metadata to store with the object in S3. - required: - - Bucket - - CopySource - - Key - title: CopyObjectRequest - type: object - CopyObjectResult: - description: Container for all response elements. - properties: - ChecksumCRC32: - allOf: - - $ref: '#/components/schemas/ChecksumCRC32' - - description: The base64-encoded, 32-bit CRC32 checksum of the object. - This will only be present if it was uploaded with the object. With multipart - uploads, this may not be a checksum value of the object. For more information - about how checksums are calculated with multipart uploads, see - Checking object integrity in the Amazon S3 User Guide. - ChecksumCRC32C: - allOf: - - $ref: '#/components/schemas/ChecksumCRC32C' - - description: The base64-encoded, 32-bit CRC32C checksum of the object. - This will only be present if it was uploaded with the object. With multipart - uploads, this may not be a checksum value of the object. For more information - about how checksums are calculated with multipart uploads, see - Checking object integrity in the Amazon S3 User Guide. - ChecksumSHA1: - allOf: - - $ref: '#/components/schemas/ChecksumSHA1' - - description: The base64-encoded, 160-bit SHA-1 digest of the object. This - will only be present if it was uploaded with the object. With multipart - uploads, this may not be a checksum value of the object. For more information - about how checksums are calculated with multipart uploads, see - Checking object integrity in the Amazon S3 User Guide. - ChecksumSHA256: - allOf: - - $ref: '#/components/schemas/ChecksumSHA256' - - description: The base64-encoded, 256-bit SHA-256 digest of the object. - This will only be present if it was uploaded with the object. With multipart - uploads, this may not be a checksum value of the object. For more information - about how checksums are calculated with multipart uploads, see - Checking object integrity in the Amazon S3 User Guide. - ETag: - allOf: - - $ref: '#/components/schemas/ETag' - - description: Returns the ETag of the new object. The ETag reflects only - changes to the contents of an object, not its metadata. - LastModified: - allOf: - - $ref: '#/components/schemas/LastModified' - - description: Creation date of the object. - type: object - CopyPartResult: - description: Container for all response elements. - properties: - ChecksumCRC32: - allOf: - - $ref: '#/components/schemas/ChecksumCRC32' - - description: The base64-encoded, 32-bit CRC32 checksum of the object. - This will only be present if it was uploaded with the object. With multipart - uploads, this may not be a checksum value of the object. For more information - about how checksums are calculated with multipart uploads, see - Checking object integrity in the Amazon S3 User Guide. - ChecksumCRC32C: - allOf: - - $ref: '#/components/schemas/ChecksumCRC32C' - - description: The base64-encoded, 32-bit CRC32C checksum of the object. - This will only be present if it was uploaded with the object. With multipart - uploads, this may not be a checksum value of the object. For more information - about how checksums are calculated with multipart uploads, see - Checking object integrity in the Amazon S3 User Guide. - ChecksumSHA1: - allOf: - - $ref: '#/components/schemas/ChecksumSHA1' - - description: The base64-encoded, 160-bit SHA-1 digest of the object. This - will only be present if it was uploaded with the object. With multipart - uploads, this may not be a checksum value of the object. For more information - about how checksums are calculated with multipart uploads, see - Checking object integrity in the Amazon S3 User Guide. - ChecksumSHA256: - allOf: - - $ref: '#/components/schemas/ChecksumSHA256' - - description: The base64-encoded, 256-bit SHA-256 digest of the object. - This will only be present if it was uploaded with the object. With multipart - uploads, this may not be a checksum value of the object. For more information - about how checksums are calculated with multipart uploads, see - Checking object integrity in the Amazon S3 User Guide. - ETag: - allOf: - - $ref: '#/components/schemas/ETag' - - description: Entity tag of the object. - LastModified: - allOf: - - $ref: '#/components/schemas/LastModified' - - description: Date and time at which the object was uploaded. - type: object - CopySource: - pattern: \/.+\/.+ - type: string - CopySourceIfMatch: - type: string - CopySourceIfModifiedSince: - format: date-time - type: string - CopySourceIfNoneMatch: - type: string - CopySourceIfUnmodifiedSince: - format: date-time - type: string - CopySourceRange: - type: string - CopySourceSSECustomerAlgorithm: - type: string - CopySourceSSECustomerKey: - format: password - type: string - CopySourceSSECustomerKeyMD5: - type: string - CopySourceVersionId: - type: string - CreateBucketConfiguration: - description: The configuration information for the bucket. - properties: - LocationConstraint: - allOf: - - $ref: '#/components/schemas/BucketLocationConstraint' - - description: Specifies the Region where the bucket will be created. If - you don't specify a Region, the bucket is created in the US East (N. - Virginia) Region (us-east-1). - type: object - CreateBucketOutput: - example: - Location: /examplebucket - properties: {} - type: object - CreateBucketRequest: - properties: {} - required: - - Bucket - title: CreateBucketRequest - type: object - CreateMultipartUploadOutput: - example: - Bucket: examplebucket - Key: largeobject - UploadId: ibZBv_75gd9r8lH_gqXatLdxMVpAlj6ZQjEs.OwyF3953YdwbcQnMA2BLGn8Lx12fQNICtMw5KyteFeHw.Sjng-- - properties: - Key: - allOf: - - $ref: '#/components/schemas/ObjectKey' - - description: Object key for which the multipart upload was initiated. - UploadId: - allOf: - - $ref: '#/components/schemas/MultipartUploadId' - - description: ID for the initiated multipart upload. - type: object - CreateMultipartUploadRequest: - properties: - x-amz-meta-: - allOf: - - $ref: '#/components/schemas/Metadata' - - description: A map of metadata to store with the object in S3. - required: - - Bucket - - Key - title: CreateMultipartUploadRequest - type: object - CreationDate: - format: date-time - type: string - Date: - format: date-time - type: string - Days: - type: integer - DaysAfterInitiation: - type: integer - DefaultRetention: - description:

The container element for specifying the default Object Lock - retention settings for new objects placed in the specified bucket.

-

  • The DefaultRetention settings require both a mode - and a period.

  • The DefaultRetention period can - be either Days or Years but you must select one. - You cannot specify Days and Years at the same time.

    -
- properties: - Days: - allOf: - - $ref: '#/components/schemas/Days' - - description: The number of days that you want to specify for the default - retention period. Must be used with Mode. - Mode: - allOf: - - $ref: '#/components/schemas/ObjectLockRetentionMode' - - description: The default Object Lock retention mode you want to apply - to new objects placed in the specified bucket. Must be used with either - Days or Years. - Years: - allOf: - - $ref: '#/components/schemas/Years' - - description: The number of years that you want to specify for the default - retention period. Must be used with Mode. - type: object - Delete: - description: Container for the objects to delete. - properties: - Object: - allOf: - - $ref: '#/components/schemas/ObjectIdentifierList' - - description: The objects to delete. - Quiet: - allOf: - - $ref: '#/components/schemas/Quiet' - - description: Element to enable quiet mode for the request. When you add - this element, you must set its value to true. - required: - - Objects - type: object - DeleteBucketAnalyticsConfigurationRequest: - properties: {} - required: - - Bucket - - Id - title: DeleteBucketAnalyticsConfigurationRequest - type: object - DeleteBucketCorsRequest: - properties: {} - required: - - Bucket - title: DeleteBucketCorsRequest - type: object - DeleteBucketEncryptionRequest: - properties: {} - required: - - Bucket - title: DeleteBucketEncryptionRequest - type: object - DeleteBucketIntelligentTieringConfigurationRequest: - properties: {} - required: - - Bucket - - Id - title: DeleteBucketIntelligentTieringConfigurationRequest - type: object - DeleteBucketInventoryConfigurationRequest: - properties: {} - required: - - Bucket - - Id - title: DeleteBucketInventoryConfigurationRequest - type: object - DeleteBucketLifecycleRequest: - properties: {} - required: - - Bucket - title: DeleteBucketLifecycleRequest - type: object - DeleteBucketMetricsConfigurationRequest: - properties: {} - required: - - Bucket - - Id - title: DeleteBucketMetricsConfigurationRequest - type: object - DeleteBucketOwnershipControlsRequest: - properties: {} - required: - - Bucket - title: DeleteBucketOwnershipControlsRequest - type: object - DeleteBucketPolicyRequest: - properties: {} - required: - - Bucket - title: DeleteBucketPolicyRequest - type: object - DeleteBucketReplicationRequest: - properties: {} - required: - - Bucket - title: DeleteBucketReplicationRequest - type: object - DeleteBucketRequest: - properties: {} - required: - - Bucket - title: DeleteBucketRequest - type: object - DeleteBucketTaggingRequest: - properties: {} - required: - - Bucket - title: DeleteBucketTaggingRequest - type: object - DeleteBucketWebsiteRequest: - properties: {} - required: - - Bucket - title: DeleteBucketWebsiteRequest - type: object - DeleteMarker: - type: boolean - DeleteMarkerEntry: - description: Information about the delete marker. - properties: - IsLatest: - allOf: - - $ref: '#/components/schemas/IsLatest' - - description: Specifies whether the object is (true) or is not (false) - the latest version of an object. - Key: - allOf: - - $ref: '#/components/schemas/ObjectKey' - - description: The object key. - LastModified: - allOf: - - $ref: '#/components/schemas/LastModified' - - description: Date and time the object was last modified. - Owner: - allOf: - - $ref: '#/components/schemas/Owner' - - description: The account that created the delete marker.> - VersionId: - allOf: - - $ref: '#/components/schemas/ObjectVersionId' - - description: Version ID of an object. - type: object - DeleteMarkerReplication: - description:

Specifies whether Amazon S3 replicates delete markers. If you - specify a Filter in your replication configuration, you must - also include a DeleteMarkerReplication element. If your Filter - includes a Tag element, the DeleteMarkerReplication - Status must be set to Disabled, because Amazon S3 does not support - replicating delete markers for tag-based rules. For an example configuration, - see Basic - Rule Configuration.

For more information about delete marker replication, - see Basic - Rule Configuration.

If you are using an earlier version - of the replication configuration, Amazon S3 handles replication of delete - markers differently. For more information, see Backward - Compatibility.

 - properties: - Status: - allOf: - - $ref: '#/components/schemas/DeleteMarkerReplicationStatus' - - description:

Indicates whether to replicate delete markers.

-

Indicates whether to replicate delete markers.

 - type: object - DeleteMarkerReplicationStatus: - enum: - - Enabled - - Disabled - type: string - DeleteMarkerVersionId: - type: string - DeleteMarkers: - items: - $ref: '#/components/schemas/DeleteMarkerEntry' - type: array - xml: - wrapped: false - DeleteObjectOutput: - example: {} - properties: {} - type: object - DeleteObjectRequest: - properties: {} - required: - - Bucket - - Key - title: DeleteObjectRequest - type: object - DeleteObjectTaggingOutput: - example: - VersionId: 'null' - properties: {} - type: object - DeleteObjectTaggingRequest: - properties: {} - required: - - Bucket - - Key - title: DeleteObjectTaggingRequest - type: object - DeleteObjectsOutput: - example: - Deleted: - - DeleteMarker: 'true' - DeleteMarkerVersionId: A._w1z6EFiCF5uhtQMDal9JDkID9tQ7F - Key: objectkey1 - - DeleteMarker: 'true' - DeleteMarkerVersionId: iOd_ORxhkKe_e8G8_oSGxt2PjsCZKlkt - Key: objectkey2 - properties: - Deleted: - allOf: - - $ref: '#/components/schemas/DeletedObjects' - - description: Container element for a successful delete. It identifies - the object that was successfully deleted. - Error: - allOf: - - $ref: '#/components/schemas/Errors' - - description: Container for a failed delete action that describes the object - that Amazon S3 attempted to delete and the error it encountered. - type: object - DeleteObjectsRequest: - properties: {} - required: - - Bucket - - Delete - title: DeleteObjectsRequest - type: object - DeletePublicAccessBlockRequest: - properties: {} - required: - - Bucket - title: DeletePublicAccessBlockRequest - type: object - DeletedObject: - description: Information about the deleted object. - properties: - DeleteMarker: - allOf: - - $ref: '#/components/schemas/DeleteMarker' - - description: Specifies whether the versioned object that was permanently - deleted was (true) or was not (false) a delete marker. In a simple DELETE, - this header indicates whether (true) or not (false) a delete marker - was created. - DeleteMarkerVersionId: - allOf: - - $ref: '#/components/schemas/DeleteMarkerVersionId' - - description: The version ID of the delete marker created as a result of - the DELETE operation. If you delete a specific object version, the value - returned by this header is the version ID of the object version deleted. - Key: - allOf: - - $ref: '#/components/schemas/ObjectKey' - - description: The name of the deleted object. - VersionId: - allOf: - - $ref: '#/components/schemas/ObjectVersionId' - - description: The version ID of the deleted object. - type: object - DeletedObjects: - items: - $ref: '#/components/schemas/DeletedObject' - type: array - xml: - wrapped: false - Delimiter: - type: string - Description: - type: string - Destination: - description: Specifies information about where to publish analysis or configuration - results for an Amazon S3 bucket and S3 Replication Time Control (S3 RTC). - properties: - AccessControlTranslation: - allOf: - - $ref: '#/components/schemas/AccessControlTranslation' - - description: Specify this only in a cross-account scenario (where source - and destination bucket owners are not the same), and you want to change - replica ownership to the Amazon Web Services account that owns the destination - bucket. If this is not specified in the replication configuration, the - replicas are owned by same Amazon Web Services account that owns the - source object. - Account: - allOf: - - $ref: '#/components/schemas/AccountId' - - description: 'Destination bucket owner account ID. In a cross-account - scenario, if you direct Amazon S3 to change replica ownership to the - Amazon Web Services account that owns the destination bucket by specifying - the AccessControlTranslation property, this is the account - ID of the destination bucket owner. For more information, see Replication - Additional Configuration: Changing the Replica Owner in the Amazon - S3 User Guide.' - Bucket: - allOf: - - $ref: '#/components/schemas/BucketName' - - description: ' The Amazon Resource Name (ARN) of the bucket where you - want Amazon S3 to store the results.' - EncryptionConfiguration: - allOf: - - $ref: '#/components/schemas/EncryptionConfiguration' - - description: A container that provides information about encryption. If - SourceSelectionCriteria is specified, you must specify - this element. - Metrics: - allOf: - - $ref: '#/components/schemas/Metrics' - - description: ' A container specifying replication metrics-related settings - enabling replication metrics and events. ' - ReplicationTime: - allOf: - - $ref: '#/components/schemas/ReplicationTime' - - description: ' A container specifying S3 Replication Time Control (S3 - RTC), including whether S3 RTC is enabled and the time when all objects - and operations on objects must be replicated. Must be specified together - with a Metrics block. ' - StorageClass: - allOf: - - $ref: '#/components/schemas/StorageClass' - - description:

The storage class to use when replicating objects, such - as S3 Standard or reduced redundancy. By default, Amazon S3 uses the - storage class of the source object to create the object replica.

-

For valid values, see the StorageClass element of the - PUT - Bucket replication action in the Amazon S3 API Reference.

- required: - - Bucket - type: object - DisplayName: - type: string - ETag: - type: string - EmailAddress: - type: string - EnableRequestProgress: - type: boolean - EncodingType: - description: Requests Amazon S3 to encode the object keys in the response and - specifies the encoding method to use. An object key may contain any Unicode - character; however, XML 1.0 parser cannot parse some characters, such as characters - with an ASCII value from 0 to 10. For characters that are not supported in - XML 1.0, you can add this parameter to request that Amazon S3 encode the keys - in the response. - enum: - - url - type: string - Encryption: - description: Contains the type of server-side encryption used. - properties: - EncryptionType: - allOf: - - $ref: '#/components/schemas/ServerSideEncryption' - - description: The server-side encryption algorithm used when storing job - results in Amazon S3 (for example, AES256, aws:kms). - KMSContext: - allOf: - - $ref: '#/components/schemas/KMSContext' - - description: If the encryption type is aws:kms, this optional - value can be used to specify the encryption context for the restore - results. - KMSKeyId: - allOf: - - $ref: '#/components/schemas/SSEKMSKeyId' - - description: If the encryption type is aws:kms, this optional - value specifies the ID of the symmetric customer managed key to use - for encryption of job results. Amazon S3 only supports symmetric keys. - For more information, see Using - symmetric and asymmetric keys in the Amazon Web Services Key - Management Service Developer Guide. - required: - - EncryptionType - type: object - EncryptionConfiguration: - description: Specifies encryption-related information for an Amazon S3 bucket - that is a destination for replicated objects. - properties: - ReplicaKmsKeyID: - allOf: - - $ref: '#/components/schemas/ReplicaKmsKeyID' - - description: Specifies the ID (Key ARN or Alias ARN) of the customer managed - Amazon Web Services KMS key stored in Amazon Web Services Key Management - Service (KMS) for the destination bucket. Amazon S3 uses this key to - encrypt replica objects. Amazon S3 only supports symmetric, customer - managed KMS keys. For more information, see Using - symmetric and asymmetric keys in the Amazon Web Services Key - Management Service Developer Guide. - type: object - End: - type: integer - EndEvent: - description: A message that indicates the request is complete and no more messages - will be sent. You should not assume that the request is complete until the - client receives an EndEvent. - properties: {} - type: object - Error: - description: Container for all error elements. - properties: - Code: - allOf: - - $ref: '#/components/schemas/Code' - - description: '

The error code is a string that uniquely identifies an - error condition. It is meant to be read and understood by programs that - detect and handle errors by type.

Amazon S3 - error codes

    • Code: AccessDenied -

    • Description: Access Denied

    • -

      HTTP Status Code: 403 Forbidden

    • SOAP - Fault Code Prefix: Client

    • - Code: AccountProblem

    • Description: There - is a problem with your Amazon Web Services account that prevents the - action from completing successfully. Contact Amazon Web Services Support - for further assistance.

    • HTTP Status Code: - 403 Forbidden

    • SOAP Fault Code Prefix: Client

      -

    • Code: AllAccessDisabled

      -

    • Description: All access to this Amazon S3 resource - has been disabled. Contact Amazon Web Services Support for further assistance.

      -

    • HTTP Status Code: 403 Forbidden

    • -

      SOAP Fault Code Prefix: Client

  • -

    • Code: AmbiguousGrantByEmailAddress

    • -

      Description: The email address you provided is associated - with more than one account.

    • HTTP Status Code: - 400 Bad Request

    • SOAP Fault Code Prefix: Client

      -

    • Code: AuthorizationHeaderMalformed

      -

    • Description: The authorization header you provided - is invalid.

    • HTTP Status Code: 400 Bad Request

      -

    • HTTP Status Code: N/A

  • -

    • Code: BadDigest

    • Description: - The Content-MD5 you specified did not match what we received.

      • -

    • HTTP Status Code: 400 Bad Request

    • - SOAP Fault Code Prefix: Client

    • -

    • Code: BucketAlreadyExists

    • Description: - The requested bucket name is not available. The bucket namespace is - shared by all users of the system. Please select a different name and - try again.

    • HTTP Status Code: 409 Conflict

      -

    • SOAP Fault Code Prefix: Client

    -

    • Code: BucketAlreadyOwnedByYou

      • -

    • Description: The bucket you tried to create already - exists, and you own it. Amazon S3 returns this error in all Amazon Web - Services Regions except in the North Virginia Region. For legacy compatibility, - if you re-create an existing bucket that you already own in the North - Virginia Region, Amazon S3 returns 200 OK and resets the bucket access - control lists (ACLs).

    • Code: 409 Conflict (in - all Regions except the North Virginia Region)

    • SOAP - Fault Code Prefix: Client

    • - Code: BucketNotEmpty

    • Description: The - bucket you tried to delete is not empty.

    • HTTP - Status Code: 409 Conflict

    • SOAP Fault Code - Prefix: Client

    • Code: - CredentialsNotSupported

    • Description: This - request does not support credentials.

    • HTTP Status - Code: 400 Bad Request

    • SOAP Fault Code Prefix: - Client

    • Code: CrossLocationLoggingProhibited

      -

    • Description: Cross-location logging not allowed. - Buckets in one geographic location cannot log information to a bucket - in another location.

    • HTTP Status Code: 403 - Forbidden

    • SOAP Fault Code Prefix: Client

      -

    • Code: EntityTooSmall

      -

    • Description: Your proposed upload is smaller than - the minimum allowed object size.

    • HTTP Status Code: - 400 Bad Request

    • SOAP Fault Code Prefix: Client

      -

    • Code: EntityTooLarge

      -

    • Description: Your proposed upload exceeds the - maximum allowed object size.

    • HTTP Status Code: - 400 Bad Request

    • SOAP Fault Code Prefix: Client

      -

    • Code: ExpiredToken

      • -

    • Description: The provided token has expired.

      • -

    • HTTP Status Code: 400 Bad Request

    • - SOAP Fault Code Prefix: Client

    • -

    • Code: IllegalVersioningConfigurationException

      • -

    • Description: Indicates that the versioning configuration - specified in the request is invalid.

    • HTTP Status - Code: 400 Bad Request

    • SOAP Fault Code Prefix: - Client

    • Code: IncompleteBody

      -

    • Description: You did not provide the number of - bytes specified by the Content-Length HTTP header

    • - HTTP Status Code: 400 Bad Request

    • SOAP - Fault Code Prefix: Client

    • - Code: IncorrectNumberOfFilesInPostRequest

    • - Description: POST requires exactly one file upload per request.

      -

    • HTTP Status Code: 400 Bad Request

    • -

      SOAP Fault Code Prefix: Client

  • -

    • Code: InlineDataTooLarge

    • Description: - Inline data exceeds the maximum allowed size.

    • HTTP - Status Code: 400 Bad Request

    • SOAP Fault Code - Prefix: Client

    • Code: - InternalError

    • Description: We encountered - an internal error. Please try again.

    • HTTP Status - Code: 500 Internal Server Error

    • SOAP Fault - Code Prefix: Server

    • Code: - InvalidAccessKeyId

    • Description: The Amazon - Web Services access key ID you provided does not exist in our records.

      -

    • HTTP Status Code: 403 Forbidden

    • -

      SOAP Fault Code Prefix: Client

  • -

    • Code: InvalidAddressingHeader

    • - Description: You must specify the Anonymous role.

    • -

      HTTP Status Code: N/A

    • SOAP Fault Code - Prefix: Client

    • Code: - InvalidArgument

    • Description: Invalid Argument

      -

    • HTTP Status Code: 400 Bad Request

    • -

      SOAP Fault Code Prefix: Client

  • -

    • Code: InvalidBucketName

    • Description: - The specified bucket is not valid.

    • HTTP Status - Code: 400 Bad Request

    • SOAP Fault Code Prefix: - Client

    • Code: InvalidBucketState

      -

    • Description: The request is not valid with the - current state of the bucket.

    • HTTP Status Code: - 409 Conflict

    • SOAP Fault Code Prefix: Client

      -

    • Code: InvalidDigest

      -

    • Description: The Content-MD5 you specified is - not valid.

    • HTTP Status Code: 400 Bad Request

      -

    • SOAP Fault Code Prefix: Client

    -

    • Code: InvalidEncryptionAlgorithmError

      -

    • Description: The encryption request you specified - is not valid. The valid value is AES256.

    • HTTP - Status Code: 400 Bad Request

    • SOAP Fault Code - Prefix: Client

    • Code: - InvalidLocationConstraint

    • Description: The - specified location constraint is not valid. For more information about - Regions, see How - to Select a Region for Your Buckets.

    • HTTP - Status Code: 400 Bad Request

    • SOAP Fault Code - Prefix: Client

    • Code: - InvalidObjectState

    • Description: The action - is not valid for the current state of the object.

    • - HTTP Status Code: 403 Forbidden

    • SOAP Fault - Code Prefix: Client

    • Code: - InvalidPart

    • Description: One or more of the - specified parts could not be found. The part might not have been uploaded, - or the specified entity tag might not have matched the part''s entity - tag.

    • HTTP Status Code: 400 Bad Request

      -

    • SOAP Fault Code Prefix: Client

    -

    • Code: InvalidPartOrder

    • -

      Description: The list of parts was not in ascending order. - Parts list must be specified in order by part number.

    • -

      HTTP Status Code: 400 Bad Request

    • SOAP - Fault Code Prefix: Client

    • - Code: InvalidPayer

    • Description: All - access to this object has been disabled. Please contact Amazon Web Services - Support for further assistance.

    • HTTP Status Code: - 403 Forbidden

    • SOAP Fault Code Prefix: Client

      -

    • Code: InvalidPolicyDocument

      -

    • Description: The content of the form does not - meet the conditions specified in the policy document.

    • -

      HTTP Status Code: 400 Bad Request

    • SOAP - Fault Code Prefix: Client

    • - Code: InvalidRange

    • Description: The - requested range cannot be satisfied.

    • HTTP Status - Code: 416 Requested Range Not Satisfiable

    • SOAP - Fault Code Prefix: Client

    • - Code: InvalidRequest

    • Description: Please - use AWS4-HMAC-SHA256.

    • HTTP Status - Code: 400 Bad Request

    • Code: N/A

      • -

    • Code: InvalidRequest

      • -

    • Description: SOAP requests must be made over an HTTPS - connection.

    • HTTP Status Code: 400 Bad Request

      -

    • SOAP Fault Code Prefix: Client

    -

    • Code: InvalidRequest

    • -

      Description: Amazon S3 Transfer Acceleration is not supported - for buckets with non-DNS compliant names.

    • HTTP - Status Code: 400 Bad Request

    • Code: N/A

      -

    • Code: InvalidRequest

      -

    • Description: Amazon S3 Transfer Acceleration is - not supported for buckets with periods (.) in their names.

      • -

    • HTTP Status Code: 400 Bad Request

    • - Code: N/A

    • Code: - InvalidRequest

    • Description: Amazon S3 Transfer - Accelerate endpoint only supports virtual style requests.

      • -

    • HTTP Status Code: 400 Bad Request

    • - Code: N/A

    • Code: - InvalidRequest

    • Description: Amazon S3 Transfer - Accelerate is not configured on this bucket.

    • HTTP - Status Code: 400 Bad Request

    • Code: N/A

      -

    • Code: InvalidRequest

      -

    • Description: Amazon S3 Transfer Accelerate is - disabled on this bucket.

    • HTTP Status Code: - 400 Bad Request

    • Code: N/A

    -

    • Code: InvalidRequest

    • -

      Description: Amazon S3 Transfer Acceleration is not supported - on this bucket. Contact Amazon Web Services Support for more information.

      -

    • HTTP Status Code: 400 Bad Request

    • -

      Code: N/A

    • Code: - InvalidRequest

    • Description: Amazon S3 Transfer - Acceleration cannot be enabled on this bucket. Contact Amazon Web Services - Support for more information.

    • HTTP Status Code: - 400 Bad Request

    • Code: N/A

    -

    • Code: InvalidSecurity

    • -

      Description: The provided security credentials are not valid.

      -

    • HTTP Status Code: 403 Forbidden

    • -

      SOAP Fault Code Prefix: Client

  • -

    • Code: InvalidSOAPRequest

    • Description: - The SOAP request body is invalid.

    • HTTP Status - Code: 400 Bad Request

    • SOAP Fault Code Prefix: - Client

    • Code: InvalidStorageClass

      -

    • Description: The storage class you specified is - not valid.

    • HTTP Status Code: 400 Bad Request

      -

    • SOAP Fault Code Prefix: Client

    -

    • Code: InvalidTargetBucketForLogging

      -

    • Description: The target bucket for logging does - not exist, is not owned by you, or does not have the appropriate grants - for the log-delivery group.

    • HTTP Status Code: - 400 Bad Request

    • SOAP Fault Code Prefix: Client

      -

    • Code: InvalidToken

      • -

    • Description: The provided token is malformed or otherwise - invalid.

    • HTTP Status Code: 400 Bad Request

      -

    • SOAP Fault Code Prefix: Client

    -

    • Code: InvalidURI

    • - Description: Couldn''t parse the specified URI.

    • -

      HTTP Status Code: 400 Bad Request

    • SOAP - Fault Code Prefix: Client

    • - Code: KeyTooLongError

    • Description: - Your key is too long.

    • HTTP Status Code: 400 - Bad Request

    • SOAP Fault Code Prefix: Client

      -

    • Code: MalformedACLError

      -

    • Description: The XML you provided was not well-formed - or did not validate against our published schema.

    • - HTTP Status Code: 400 Bad Request

    • SOAP - Fault Code Prefix: Client

    • - Code: MalformedPOSTRequest

    • Description: - The body of your POST request is not well-formed multipart/form-data.

      -

    • HTTP Status Code: 400 Bad Request

    • -

      SOAP Fault Code Prefix: Client

  • -

    • Code: MalformedXML

    • Description: - This happens when the user sends malformed XML (XML that doesn''t conform - to the published XSD) for the configuration. The error message is, "The - XML you provided was not well-formed or did not validate against our - published schema."

    • HTTP Status Code: 400 - Bad Request

    • SOAP Fault Code Prefix: Client

      -

    • Code: MaxMessageLengthExceeded

      -

    • Description: Your request was too big.

      • -

    • HTTP Status Code: 400 Bad Request

    • - SOAP Fault Code Prefix: Client

    • -

    • Code: MaxPostPreDataLengthExceededError

    • -

      Description: Your POST request fields preceding the upload - file were too large.

    • HTTP Status Code: 400 - Bad Request

    • SOAP Fault Code Prefix: Client

      -

    • Code: MetadataTooLarge

      -

    • Description: Your metadata headers exceed the - maximum allowed metadata size.

    • HTTP Status Code: - 400 Bad Request

    • SOAP Fault Code Prefix: Client

      -

    • Code: MethodNotAllowed

      -

    • Description: The specified method is not allowed - against this resource.

    • HTTP Status Code: 405 - Method Not Allowed

    • SOAP Fault Code Prefix: - Client

    • Code: MissingAttachment

      -

    • Description: A SOAP attachment was expected, but - none were found.

    • HTTP Status Code: N/A

      -

    • SOAP Fault Code Prefix: Client

    -

    • Code: MissingContentLength

      • -

    • Description: You must provide the Content-Length HTTP - header.

    • HTTP Status Code: 411 Length Required

      -

    • SOAP Fault Code Prefix: Client

    -

    • Code: MissingRequestBodyError

      • -

    • Description: This happens when the user sends an empty - XML document as a request. The error message is, "Request body is empty." -

    • HTTP Status Code: 400 Bad Request

      • -

    • SOAP Fault Code Prefix: Client

    • -

    • Code: MissingSecurityElement

    • -

      Description: The SOAP 1.1 request is missing a security element.

      -

    • HTTP Status Code: 400 Bad Request

    • -

      SOAP Fault Code Prefix: Client

  • -

    • Code: MissingSecurityHeader

    • - Description: Your request is missing a required header.

      • -

    • HTTP Status Code: 400 Bad Request

    • - SOAP Fault Code Prefix: Client

    • -

    • Code: NoLoggingStatusForKey

    • Description: - There is no such thing as a logging status subresource for a key.

      -

    • HTTP Status Code: 400 Bad Request

    • -

      SOAP Fault Code Prefix: Client

  • -

    • Code: NoSuchBucket

    • Description: - The specified bucket does not exist.

    • HTTP Status - Code: 404 Not Found

    • SOAP Fault Code Prefix: - Client

    • Code: NoSuchBucketPolicy

      -

    • Description: The specified bucket does not have - a bucket policy.

    • HTTP Status Code: 404 Not - Found

    • SOAP Fault Code Prefix: Client

      • -

    • Code: NoSuchKey

    • -

      Description: The specified key does not exist.

      • -

    • HTTP Status Code: 404 Not Found

    • SOAP - Fault Code Prefix: Client

    • - Code: NoSuchLifecycleConfiguration

    • Description: - The lifecycle configuration does not exist.

    • HTTP - Status Code: 404 Not Found

    • SOAP Fault Code - Prefix: Client

    • Code: - NoSuchUpload

    • Description: The specified multipart - upload does not exist. The upload ID might be invalid, or the multipart - upload might have been aborted or completed.

    • HTTP - Status Code: 404 Not Found

    • SOAP Fault Code - Prefix: Client

    • Code: - NoSuchVersion

    • Description: Indicates that - the version ID specified in the request does not match an existing version.

      -

    • HTTP Status Code: 404 Not Found

    • -

      SOAP Fault Code Prefix: Client

  • -

    • Code: NotImplemented

    • Description: - A header you provided implies functionality that is not implemented.

      -

    • HTTP Status Code: 501 Not Implemented

      • -

    • SOAP Fault Code Prefix: Server

    • -

    • Code: NotSignedUp

    • Description: - Your account is not signed up for the Amazon S3 service. You must sign - up before you can use Amazon S3. You can sign up at the following URL: - Amazon S3

    • - HTTP Status Code: 403 Forbidden

    • SOAP Fault - Code Prefix: Client

    • Code: - OperationAborted

    • Description: A conflicting - conditional action is currently in progress against this resource. Try - again.

    • HTTP Status Code: 409 Conflict

      -

    • SOAP Fault Code Prefix: Client

    -

    • Code: PermanentRedirect

    • -

      Description: The bucket you are attempting to access must - be addressed using the specified endpoint. Send all future requests - to this endpoint.

    • HTTP Status Code: 301 Moved - Permanently

    • SOAP Fault Code Prefix: Client

      -

    • Code: PreconditionFailed

      -

    • Description: At least one of the preconditions - you specified did not hold.

    • HTTP Status Code: - 412 Precondition Failed

    • SOAP Fault Code Prefix: - Client

    • Code: Redirect

      -

    • Description: Temporary redirect.

    • -

      HTTP Status Code: 307 Moved Temporarily

    • - SOAP Fault Code Prefix: Client

    • -

    • Code: RestoreAlreadyInProgress

    • Description: - Object restore is already in progress.

    • HTTP Status - Code: 409 Conflict

    • SOAP Fault Code Prefix: - Client

    • Code: RequestIsNotMultiPartContent

      -

    • Description: Bucket POST must be of the enclosure-type - multipart/form-data.

    • HTTP Status Code: 400 - Bad Request

    • SOAP Fault Code Prefix: Client

      -

    • Code: RequestTimeout

      -

    • Description: Your socket connection to the server - was not read from or written to within the timeout period.

      • -

    • HTTP Status Code: 400 Bad Request

    • - SOAP Fault Code Prefix: Client

    • -

    • Code: RequestTimeTooSkewed

    • Description: - The difference between the request time and the server''s time is too - large.

    • HTTP Status Code: 403 Forbidden

      -

    • SOAP Fault Code Prefix: Client

    -

    • Code: RequestTorrentOfBucketError

      -

    • Description: Requesting the torrent file of a - bucket is not permitted.

    • HTTP Status Code: - 400 Bad Request

    • SOAP Fault Code Prefix: Client

      -

    • Code: SignatureDoesNotMatch

      -

    • Description: The request signature we calculated - does not match the signature you provided. Check your Amazon Web Services - secret access key and signing method. For more information, see REST - Authentication and SOAP - Authentication for details.

    • HTTP Status Code: - 403 Forbidden

    • SOAP Fault Code Prefix: Client

      -

    • Code: ServiceUnavailable

      -

    • Description: Reduce your request rate.

      • -

    • HTTP Status Code: 503 Service Unavailable

      • -

    • SOAP Fault Code Prefix: Server

    • -

    • Code: SlowDown

    • Description: - Reduce your request rate.

    • HTTP Status Code: - 503 Slow Down

    • SOAP Fault Code Prefix: Server

      -

    • Code: TemporaryRedirect

      -

    • Description: You are being redirected to the bucket - while DNS updates.

    • HTTP Status Code: 307 Moved - Temporarily

    • SOAP Fault Code Prefix: Client

      -

    • Code: TokenRefreshRequired

      -

    • Description: The provided token must be refreshed.

      -

    • HTTP Status Code: 400 Bad Request

    • -

      SOAP Fault Code Prefix: Client

  • -

    • Code: TooManyBuckets

    • Description: - You have attempted to create more buckets than allowed.

    • -

      HTTP Status Code: 400 Bad Request

    • SOAP - Fault Code Prefix: Client

    • - Code: UnexpectedContent

    • Description: - This request does not support content.

    • HTTP Status - Code: 400 Bad Request

    • SOAP Fault Code Prefix: - Client

    • Code: UnresolvableGrantByEmailAddress

      -

    • Description: The email address you provided does - not match any account on record.

    • HTTP Status Code: - 400 Bad Request

    • SOAP Fault Code Prefix: Client

      -

    • Code: UserKeyMustBeSpecified

      -

    • Description: The bucket POST must contain the - specified field name. If it is specified, check the order of the fields.

      -

    • HTTP Status Code: 400 Bad Request

    • -

      SOAP Fault Code Prefix: Client

-

' - Key: - allOf: - - $ref: '#/components/schemas/ObjectKey' - - description: The error key. - Message: - allOf: - - $ref: '#/components/schemas/Message' - - description: The error message contains a generic description of the error - condition in English. It is intended for a human audience. Simple programs - display the message directly to the end user if they encounter an error - condition they don't know how or don't care to handle. Sophisticated - programs with more exhaustive error handling and proper internationalization - are more likely to ignore the error message. - VersionId: - allOf: - - $ref: '#/components/schemas/ObjectVersionId' - - description: The version ID of the error. - type: object - ErrorCode: - type: string - ErrorDocument: - description: The error information. - properties: - Key: - allOf: - - $ref: '#/components/schemas/ObjectKey' - - description:

The object key name to use when a 4XX class error occurs.

-

Replacement must be made for object keys containing special - characters (such as carriage returns) when using XML requests. For more - information, see - XML related object key constraints.

 - required: - - Key - type: object - ErrorMessage: - type: string - Errors: - items: - $ref: '#/components/schemas/Error' - type: array - xml: - wrapped: false - Event: - description: The bucket event for which to send notifications. - enum: - - s3:ReducedRedundancyLostObject - - s3:ObjectCreated:* - - s3:ObjectCreated:Put - - s3:ObjectCreated:Post - - s3:ObjectCreated:Copy - - s3:ObjectCreated:CompleteMultipartUpload - - s3:ObjectRemoved:* - - s3:ObjectRemoved:Delete - - s3:ObjectRemoved:DeleteMarkerCreated - - s3:ObjectRestore:* - - s3:ObjectRestore:Post - - s3:ObjectRestore:Completed - - s3:Replication:* - - s3:Replication:OperationFailedReplication - - s3:Replication:OperationNotTracked - - s3:Replication:OperationMissedThreshold - - s3:Replication:OperationReplicatedAfterThreshold - - s3:ObjectRestore:Delete - - s3:LifecycleTransition - - s3:IntelligentTiering - - s3:ObjectAcl:Put - - s3:LifecycleExpiration:* - - s3:LifecycleExpiration:Delete - - s3:LifecycleExpiration:DeleteMarkerCreated - - s3:ObjectTagging:* - - s3:ObjectTagging:Put - - s3:ObjectTagging:Delete - type: string - EventBridgeConfiguration: - description: A container for specifying the configuration for Amazon EventBridge. - properties: {} - type: object - EventList: - items: - $ref: '#/components/schemas/Event' - type: array - xml: - wrapped: false - ExistingObjectReplication: - description: 'Optional configuration to replicate existing source bucket objects. - For more information, see Replicating - Existing Objects in the Amazon S3 User Guide. ' - properties: - Status: - allOf: - - $ref: '#/components/schemas/ExistingObjectReplicationStatus' - - description:

- required: - - Status - type: object - ExistingObjectReplicationStatus: - enum: - - Enabled - - Disabled - type: string - Expiration: - type: string - ExpirationStatus: - enum: - - Enabled - - Disabled - type: string - ExpiredObjectDeleteMarker: - type: boolean - Expires: - format: date-time - type: string - ExposeHeader: - type: string - ExposeHeaders: - items: - $ref: '#/components/schemas/ExposeHeader' - type: array - xml: - wrapped: false - Expression: - type: string - ExpressionType: - enum: - - SQL - type: string - FetchOwner: - type: boolean - FieldDelimiter: - type: string - FileHeaderInfo: - enum: - - USE - - IGNORE - - NONE - type: string - FilterRule: - description: Specifies the Amazon S3 object key name to filter on and whether - to filter on the suffix or prefix of the key name. - properties: - Name: - allOf: - - $ref: '#/components/schemas/FilterRuleName' - - description: The object key name prefix or suffix identifying one or more - objects to which the filtering rule applies. The maximum length is 1,024 - characters. Overlapping prefixes and suffixes are not supported. For - more information, see Configuring - Event Notifications in the Amazon S3 User Guide. - Value: - allOf: - - $ref: '#/components/schemas/FilterRuleValue' - - description: The value that the filter searches for in object key names. - type: object - FilterRuleList: - description: A list of containers for the key-value pair that defines the criteria - for the filter rule. - items: - $ref: '#/components/schemas/FilterRule' - type: array - xml: - wrapped: false - FilterRuleName: - enum: - - prefix - - suffix - type: string - FilterRuleValue: - type: string - GetBucketAccelerateConfigurationOutput: - properties: - Status: - allOf: - - $ref: '#/components/schemas/BucketAccelerateStatus' - - description: The accelerate configuration of the bucket. - type: object - GetBucketAccelerateConfigurationRequest: - properties: {} - required: - - Bucket - title: GetBucketAccelerateConfigurationRequest - type: object - GetBucketAclOutput: - properties: - AccessControlList: - allOf: - - $ref: '#/components/schemas/Grants' - - description: A list of grants. - Owner: - allOf: - - $ref: '#/components/schemas/Owner' - - description: Container for the bucket owner's display name and ID. - type: object - GetBucketAclRequest: - properties: {} - required: - - Bucket - title: GetBucketAclRequest - type: object - GetBucketAnalyticsConfigurationOutput: - properties: - AnalyticsConfiguration: - allOf: - - $ref: '#/components/schemas/AnalyticsConfiguration' - - description: The configuration and any analyses for the analytics filter. - type: object - GetBucketAnalyticsConfigurationRequest: - properties: {} - required: - - Bucket - - Id - title: GetBucketAnalyticsConfigurationRequest - type: object - GetBucketCorsOutput: - example: - CORSRules: - - AllowedHeaders: - - Authorization - AllowedMethods: - - GET - AllowedOrigins: - - '*' - MaxAgeSeconds: 3000 - properties: - CORSRule: - allOf: - - $ref: '#/components/schemas/CORSRules' - - description: A set of origins and methods (cross-origin access that you - want to allow). You can add up to 100 rules to the configuration. - type: object - GetBucketCorsRequest: - properties: {} - required: - - Bucket - title: GetBucketCorsRequest - type: object - GetBucketEncryptionOutput: - properties: - ServerSideEncryptionConfiguration: - $ref: '#/components/schemas/ServerSideEncryptionConfiguration' - type: object - GetBucketEncryptionRequest: - properties: {} - required: - - Bucket - title: GetBucketEncryptionRequest - type: object - GetBucketIntelligentTieringConfigurationOutput: - properties: - IntelligentTieringConfiguration: - allOf: - - $ref: '#/components/schemas/IntelligentTieringConfiguration' - - description: Container for S3 Intelligent-Tiering configuration. - type: object - GetBucketIntelligentTieringConfigurationRequest: - properties: {} - required: - - Bucket - - Id - title: GetBucketIntelligentTieringConfigurationRequest - type: object - GetBucketInventoryConfigurationOutput: - properties: - InventoryConfiguration: - allOf: - - $ref: '#/components/schemas/InventoryConfiguration' - - description: Specifies the inventory configuration. - type: object - GetBucketInventoryConfigurationRequest: - properties: {} - required: - - Bucket - - Id - title: GetBucketInventoryConfigurationRequest - type: object - GetBucketLifecycleConfigurationOutput: - example: - Rules: - - ID: Rule for TaxDocs/ - Prefix: TaxDocs - Status: Enabled - Transitions: - - Days: 365 - StorageClass: STANDARD_IA - properties: - Rule: - allOf: - - $ref: '#/components/schemas/LifecycleRules' - - description: Container for a lifecycle rule. - type: object - GetBucketLifecycleConfigurationRequest: - properties: {} - required: - - Bucket - title: GetBucketLifecycleConfigurationRequest - type: object - GetBucketLifecycleOutput: - example: - Rules: - - Expiration: - Days: 1 - ID: delete logs - Prefix: 123/ - Status: Enabled - properties: - Rule: - allOf: - - $ref: '#/components/schemas/Rules' - - description: Container for a lifecycle rule. - type: object - GetBucketLifecycleRequest: - properties: {} - required: - - Bucket - title: GetBucketLifecycleRequest - type: object - GetBucketLocationOutput: - example: - LocationConstraint: us-west-2 - properties: - LocationConstraint: - allOf: - - $ref: '#/components/schemas/BucketLocationConstraint' - - description: Specifies the Region where the bucket resides. For a list - of all the Amazon S3 supported location constraints by Region, see Regions - and Endpoints. Buckets in Region us-east-1 have a LocationConstraint - of null. - type: object - GetBucketLocationRequest: - properties: {} - required: - - Bucket - title: GetBucketLocationRequest - type: object - GetBucketLoggingOutput: - properties: - LoggingEnabled: - $ref: '#/components/schemas/LoggingEnabled' - type: object - GetBucketLoggingRequest: - properties: {} - required: - - Bucket - title: GetBucketLoggingRequest - type: object - GetBucketMetricsConfigurationOutput: - properties: - MetricsConfiguration: - allOf: - - $ref: '#/components/schemas/MetricsConfiguration' - - description: Specifies the metrics configuration. - type: object - GetBucketMetricsConfigurationRequest: - properties: {} - required: - - Bucket - - Id - title: GetBucketMetricsConfigurationRequest - type: object - GetBucketNotificationConfigurationRequest: - properties: {} - required: - - Bucket - title: GetBucketNotificationConfigurationRequest - type: object - GetBucketOwnershipControlsOutput: - properties: - OwnershipControls: - allOf: - - $ref: '#/components/schemas/OwnershipControls' - - description: The OwnershipControls (BucketOwnerEnforced, - BucketOwnerPreferred, or ObjectWriter) currently in effect for this - Amazon S3 bucket. - type: object - GetBucketOwnershipControlsRequest: - properties: {} - required: - - Bucket - title: GetBucketOwnershipControlsRequest - type: object - GetBucketPolicyOutput: - example: - Policy: '{"Version":"2008-10-17","Id":"LogPolicy","Statement":[{"Sid":"Enables - the log delivery group to publish logs to your bucket ","Effect":"Allow","Principal":{"AWS":"111122223333"},"Action":["s3:GetBucketAcl","s3:GetObjectAcl","s3:PutObject"],"Resource":["arn:aws:s3:::policytest1/*","arn:aws:s3:::policytest1"]}]}' - properties: - Policy: - allOf: - - $ref: '#/components/schemas/Policy' - - description: The bucket policy as a JSON document. - type: object - GetBucketPolicyRequest: - properties: {} - required: - - Bucket - title: GetBucketPolicyRequest - type: object - GetBucketPolicyStatusOutput: - properties: - PolicyStatus: - allOf: - - $ref: '#/components/schemas/PolicyStatus' - - description: The policy status for the specified bucket. - type: object - GetBucketPolicyStatusRequest: - properties: {} - required: - - Bucket - title: GetBucketPolicyStatusRequest - type: object - GetBucketReplicationOutput: - example: - ReplicationConfiguration: - Role: arn:aws:iam::acct-id:role/example-role - Rules: - - Destination: - Bucket: arn:aws:s3:::destination-bucket - ID: MWIwNTkwZmItMTE3MS00ZTc3LWJkZDEtNzRmODQwYzc1OTQy - Prefix: Tax - Status: Enabled - properties: - ReplicationConfiguration: - $ref: '#/components/schemas/ReplicationConfiguration' - type: object - GetBucketReplicationRequest: - properties: {} - required: - - Bucket - title: GetBucketReplicationRequest - type: object - GetBucketRequestPaymentOutput: - example: - Payer: BucketOwner - properties: - Payer: - allOf: - - $ref: '#/components/schemas/Payer' - - description: Specifies who pays for the download and request fees. - type: object - GetBucketRequestPaymentRequest: - properties: {} - required: - - Bucket - title: GetBucketRequestPaymentRequest - type: object - GetBucketTaggingOutput: - example: - TagSet: - - Key: key1 - Value: value1 - - Key: key2 - Value: value2 - properties: - TagSet: - allOf: - - $ref: '#/components/schemas/TagSet' - - description: Contains the tag set. - required: - - TagSet - type: object - GetBucketTaggingRequest: - properties: {} - required: - - Bucket - title: GetBucketTaggingRequest - type: object - GetBucketVersioningOutput: - example: - MFADelete: Disabled - Status: Enabled - properties: - MfaDelete: - allOf: - - $ref: '#/components/schemas/MFADeleteStatus' - - description: Specifies whether MFA delete is enabled in the bucket versioning - configuration. This element is only returned if the bucket has been - configured with MFA delete. If the bucket has never been so configured, - this element is not returned. - Status: - allOf: - - $ref: '#/components/schemas/BucketVersioningStatus' - - description: The versioning state of the bucket. - type: object - GetBucketVersioningRequest: - properties: {} - required: - - Bucket - title: GetBucketVersioningRequest - type: object - GetBucketWebsiteOutput: - example: - ErrorDocument: - Key: error.html - IndexDocument: - Suffix: index.html - properties: - ErrorDocument: - allOf: - - $ref: '#/components/schemas/ErrorDocument' - - description: The object key name of the website error document to use - for 4XX class errors. - IndexDocument: - allOf: - - $ref: '#/components/schemas/IndexDocument' - - description: The name of the index document for the website (for example - index.html). - RedirectAllRequestsTo: - allOf: - - $ref: '#/components/schemas/RedirectAllRequestsTo' - - description: Specifies the redirect behavior of all requests to a website - endpoint of an Amazon S3 bucket. - RoutingRules: - allOf: - - $ref: '#/components/schemas/RoutingRules' - - description: Rules that define when a redirect is applied and the redirect - behavior. - type: object - GetBucketWebsiteRequest: - properties: {} - required: - - Bucket - title: GetBucketWebsiteRequest - type: object - GetObjectAclOutput: - example: - Grants: - - Grantee: - DisplayName: owner-display-name - ID: examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc - Type: CanonicalUser - Permission: WRITE - - Grantee: - DisplayName: owner-display-name - ID: examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc - Type: CanonicalUser - Permission: WRITE_ACP - - Grantee: - DisplayName: owner-display-name - ID: examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc - Type: CanonicalUser - Permission: READ - - Grantee: - DisplayName: owner-display-name - ID: 852b113eexamplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc - Type: CanonicalUser - Permission: READ_ACP - Owner: - DisplayName: owner-display-name - ID: examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc - properties: - AccessControlList: - allOf: - - $ref: '#/components/schemas/Grants' - - description: A list of grants. - Owner: - allOf: - - $ref: '#/components/schemas/Owner' - - description: ' Container for the bucket owner''s display name and ID.' - type: object - GetObjectAclRequest: - properties: {} - required: - - Bucket - - Key - title: GetObjectAclRequest - type: object - GetObjectAttributesOutput: - properties: - Checksum: - allOf: - - $ref: '#/components/schemas/Checksum' - - description: The checksum or digest of the object. - ETag: - allOf: - - $ref: '#/components/schemas/ETag' - - description: An ETag is an opaque identifier assigned by a web server - to a specific version of a resource found at a URL. - ObjectParts: - allOf: - - $ref: '#/components/schemas/GetObjectAttributesParts' - - description: A collection of parts associated with a multipart upload. - ObjectSize: - allOf: - - $ref: '#/components/schemas/ObjectSize' - - description: The size of the object in bytes. - StorageClass: - allOf: - - $ref: '#/components/schemas/StorageClass' - - description:

Provides the storage class information of the object. - Amazon S3 returns this header for all objects except for S3 Standard - storage class objects.

For more information, see Storage - Classes.

- type: object - GetObjectAttributesParts: - description: A collection of parts associated with a multipart upload. - properties: - IsTruncated: - allOf: - - $ref: '#/components/schemas/IsTruncated' - - description: Indicates whether the returned list of parts is truncated. - A value of true indicates that the list was truncated. - A list can be truncated if the number of parts exceeds the limit returned - in the MaxParts element. - MaxParts: - allOf: - - $ref: '#/components/schemas/MaxParts' - - description: The maximum number of parts allowed in the response. - NextPartNumberMarker: - allOf: - - $ref: '#/components/schemas/NextPartNumberMarker' - - description: When a list is truncated, this element specifies the last - part in the list, as well as the value to use for the PartNumberMarker - request parameter in a subsequent request. - Part: - allOf: - - $ref: '#/components/schemas/PartsList' - - description: A container for elements related to a particular part. A - response can contain zero or more Parts elements. - PartNumberMarker: - allOf: - - $ref: '#/components/schemas/PartNumberMarker' - - description: The marker for the current part. - PartsCount: - allOf: - - $ref: '#/components/schemas/PartsCount' - - description: The total number of parts. - type: object - GetObjectAttributesRequest: - properties: {} - required: - - Bucket - - Key - - ObjectAttributes - title: GetObjectAttributesRequest - type: object - GetObjectLegalHoldOutput: - properties: - LegalHold: - allOf: - - $ref: '#/components/schemas/ObjectLockLegalHold' - - description: The current legal hold status for the specified object. - type: object - GetObjectLegalHoldRequest: - properties: {} - required: - - Bucket - - Key - title: GetObjectLegalHoldRequest - type: object - GetObjectLockConfigurationOutput: - properties: - ObjectLockConfiguration: - allOf: - - $ref: '#/components/schemas/ObjectLockConfiguration' - - description: The specified bucket's Object Lock configuration. - type: object - GetObjectLockConfigurationRequest: - properties: {} - required: - - Bucket - title: GetObjectLockConfigurationRequest - type: object - GetObjectOutput: - example: - AcceptRanges: bytes - ContentLength: '10' - ContentRange: bytes 0-9/43 - ContentType: text/plain - ETag: '"0d94420ffd0bc68cd3d152506b97a9cc"' - LastModified: Thu, 09 Oct 2014 22:57:28 GMT - Metadata: {} - VersionId: 'null' - properties: - Body: - allOf: - - $ref: '#/components/schemas/Body' - - description: Object data. - x-amz-meta-: - allOf: - - $ref: '#/components/schemas/Metadata' - - description: A map of metadata to store with the object in S3. - type: object - GetObjectRequest: - properties: {} - required: - - Bucket - - Key - title: GetObjectRequest - type: object - GetObjectResponseStatusCode: - type: integer - GetObjectRetentionOutput: - properties: - Retention: - allOf: - - $ref: '#/components/schemas/ObjectLockRetention' - - description: The container element for an object's retention settings. - type: object - GetObjectRetentionRequest: - properties: {} - required: - - Bucket - - Key - title: GetObjectRetentionRequest - type: object - GetObjectTaggingOutput: - example: - TagSet: - - Key: Key1 - Value: Value1 - VersionId: ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI - properties: - TagSet: - allOf: - - $ref: '#/components/schemas/TagSet' - - description: Contains the tag set. - required: - - TagSet - type: object - GetObjectTaggingRequest: - properties: {} - required: - - Bucket - - Key - title: GetObjectTaggingRequest - type: object - GetObjectTorrentOutput: - example: {} - properties: - Body: - allOf: - - $ref: '#/components/schemas/Body' - - description: A Bencoded dictionary as defined by the BitTorrent specification - type: object - GetObjectTorrentRequest: - properties: {} - required: - - Bucket - - Key - title: GetObjectTorrentRequest - type: object - GetPublicAccessBlockOutput: - properties: - PublicAccessBlockConfiguration: - allOf: - - $ref: '#/components/schemas/PublicAccessBlockConfiguration' - - description: The PublicAccessBlock configuration currently - in effect for this Amazon S3 bucket. - type: object - GetPublicAccessBlockRequest: - properties: {} - required: - - Bucket - title: GetPublicAccessBlockRequest - type: object - GlacierJobParameters: - description: Container for S3 Glacier job parameters. - properties: - Tier: - allOf: - - $ref: '#/components/schemas/Tier' - - description: Retrieval tier at which the restore will be processed. - required: - - Tier - type: object - Grant: - description: Container for grant information. - properties: - Grantee: - allOf: - - $ref: '#/components/schemas/Grantee' - - description: The person being granted permissions. - Permission: - allOf: - - $ref: '#/components/schemas/Permission' - - description: Specifies the permission given to the grantee. - type: object - GrantFullControl: - type: string - GrantRead: - type: string - GrantReadACP: - type: string - GrantWrite: - type: string - GrantWriteACP: - type: string - Grantee: - description: Container for the person being granted permissions. - properties: - DisplayName: - allOf: - - $ref: '#/components/schemas/DisplayName' - - description: Screen name of the grantee. - EmailAddress: - allOf: - - $ref: '#/components/schemas/EmailAddress' - - description: "

Email address of the grantee.

Using email\ - \ addresses to specify a grantee is only supported in the following\ - \ Amazon Web Services Regions:

  • US East (N. Virginia)

    \ - \

  • US West (N. California)

  • US West (Oregon)

    \ - \

  • Asia Pacific (Singapore)

  • Asia Pacific\ - \ (Sydney)

  • Asia Pacific (Tokyo)

  • Europe\ - \ (Ireland)

  • South America (S\xE3o Paulo)

    • \ - \

For a list of all the Amazon S3 supported Regions and endpoints,\ - \ see Regions and Endpoints in the Amazon Web Services General Reference.

\ - \ " - ID: - allOf: - - $ref: '#/components/schemas/ID' - - description: The canonical user ID of the grantee. - URI: - allOf: - - $ref: '#/components/schemas/URI' - - description: URI of the grantee group. - xsi:type: - allOf: - - $ref: '#/components/schemas/Type' - - description: Type of grantee - required: - - Type - type: object - xml: - attribute: true - namespace: http://www.w3.org/2001/XMLSchema-instance - Grants: - items: - allOf: - - $ref: '#/components/schemas/Grant' - - xml: - name: Grant - type: array - HeadBucketRequest: - properties: {} - required: - - Bucket - title: HeadBucketRequest - type: object - HeadObjectOutput: - example: - AcceptRanges: bytes - ContentLength: '3191' - ContentType: image/jpeg - ETag: '"6805f2cfc46c0f04559748bb039d69ae"' - LastModified: Thu, 15 Dec 2016 01:19:41 GMT - Metadata: {} - VersionId: 'null' - properties: - x-amz-meta-: - allOf: - - $ref: '#/components/schemas/Metadata' - - description: A map of metadata to store with the object in S3. - type: object - HeadObjectRequest: - properties: {} - required: - - Bucket - - Key - title: HeadObjectRequest - type: object - HostName: - type: string - HttpErrorCodeReturnedEquals: - type: string - HttpRedirectCode: - type: string - ID: - type: string - IfMatch: - type: string - IfModifiedSince: - format: date-time - type: string - IfNoneMatch: - type: string - IfUnmodifiedSince: - format: date-time - type: string - IndexDocument: - description: Container for the Suffix element. - properties: - Suffix: - allOf: - - $ref: '#/components/schemas/Suffix' - - description:

A suffix that is appended to a request that is for a directory - on the website endpoint (for example,if the suffix is index.html and - you make a request to samplebucket/images/ the data that is returned - will be for the object with the key name images/index.html) The suffix - must not be empty and must not include a slash character.

-

Replacement must be made for object keys containing special characters - (such as carriage returns) when using XML requests. For more information, - see - XML related object key constraints.

 - required: - - Suffix - type: object - Initiated: - format: date-time - type: string - Initiator: - description: 'Container element that identifies who initiated the multipart - upload. ' - properties: - DisplayName: - allOf: - - $ref: '#/components/schemas/DisplayName' - - description: Name of the Principal. - ID: - allOf: - - $ref: '#/components/schemas/ID' - - description: If the principal is an Amazon Web Services account, it provides - the Canonical User ID. If the principal is an IAM User, it provides - a user ARN value. - type: object - InputSerialization: - description: Describes the serialization format of the object. - properties: - CSV: - allOf: - - $ref: '#/components/schemas/CSVInput' - - description: Describes the serialization of a CSV-encoded object. - CompressionType: - allOf: - - $ref: '#/components/schemas/CompressionType' - - description: 'Specifies object''s compression format. Valid values: NONE, - GZIP, BZIP2. Default Value: NONE.' - JSON: - allOf: - - $ref: '#/components/schemas/JSONInput' - - description: Specifies JSON as object's input serialization format. - Parquet: - allOf: - - $ref: '#/components/schemas/ParquetInput' - - description: Specifies Parquet as object's input serialization format. - type: object - IntelligentTieringAccessTier: - enum: - - ARCHIVE_ACCESS - - DEEP_ARCHIVE_ACCESS - type: string - IntelligentTieringAndOperator: - description: A container for specifying S3 Intelligent-Tiering filters. The - filters determine the subset of objects to which the rule applies. - properties: - Prefix: - allOf: - - $ref: '#/components/schemas/Prefix' - - description: An object key name prefix that identifies the subset of objects - to which the configuration applies. - Tag: - allOf: - - $ref: '#/components/schemas/TagSet' - - description: All of these tags must exist in the object's tag set in order - for the configuration to apply. - type: object - xml: - wrapped: false - IntelligentTieringConfiguration: - description:

Specifies the S3 Intelligent-Tiering configuration for an Amazon - S3 bucket.

For information about the S3 Intelligent-Tiering storage - class, see Storage - class for automatically optimizing frequently and infrequently accessed objects.

- properties: - Filter: - allOf: - - $ref: '#/components/schemas/IntelligentTieringFilter' - - description: Specifies a bucket filter. The configuration only includes - objects that meet the filter's criteria. - Id: - allOf: - - $ref: '#/components/schemas/IntelligentTieringId' - - description: The ID used to identify the S3 Intelligent-Tiering configuration. - Status: - allOf: - - $ref: '#/components/schemas/IntelligentTieringStatus' - - description: Specifies the status of the configuration. - Tiering: - allOf: - - $ref: '#/components/schemas/TieringList' - - description: Specifies the S3 Intelligent-Tiering storage class tier of - the configuration. - required: - - Id - - Status - - Tierings - type: object - IntelligentTieringConfigurationList: - items: - $ref: '#/components/schemas/IntelligentTieringConfiguration' - type: array - xml: - wrapped: false - IntelligentTieringDays: - type: integer - IntelligentTieringFilter: - description: The Filter is used to identify objects that the S3 - Intelligent-Tiering configuration applies to. - properties: - And: - allOf: - - $ref: '#/components/schemas/IntelligentTieringAndOperator' - - description: A conjunction (logical AND) of predicates, which is used - in evaluating a metrics filter. The operator must have at least two - predicates, and an object must match all of the predicates in order - for the filter to apply. - Prefix: - allOf: - - $ref: '#/components/schemas/Prefix' - - description:

An object key name prefix that identifies the subset of - objects to which the rule applies.

Replacement must - be made for object keys containing special characters (such as carriage - returns) when using XML requests. For more information, see - XML related object key constraints.

 - Tag: - $ref: '#/components/schemas/Tag' - type: object - IntelligentTieringId: - type: string - IntelligentTieringStatus: - enum: - - Enabled - - Disabled - type: string - InvalidObjectState: {} - InventoryConfiguration: - description: 'Specifies the inventory configuration for an Amazon S3 bucket. - For more information, see GET - Bucket inventory in the Amazon S3 API Reference. ' - properties: - Destination: - allOf: - - $ref: '#/components/schemas/InventoryDestination' - - description: Contains information about where to publish the inventory - results. - Filter: - allOf: - - $ref: '#/components/schemas/InventoryFilter' - - description: Specifies an inventory filter. The inventory only includes - objects that meet the filter's criteria. - Id: - allOf: - - $ref: '#/components/schemas/InventoryId' - - description: The ID used to identify the inventory configuration. - IncludedObjectVersions: - allOf: - - $ref: '#/components/schemas/InventoryIncludedObjectVersions' - - description: Object versions to include in the inventory list. If set - to All, the list includes all the object versions, which - adds the version-related fields VersionId, IsLatest, - and DeleteMarker to the list. If set to Current, - the list does not contain these version-related fields. - IsEnabled: - allOf: - - $ref: '#/components/schemas/IsEnabled' - - description: Specifies whether the inventory is enabled or disabled. If - set to True, an inventory list is generated. If set to - False, no inventory list is generated. - OptionalFields: - allOf: - - $ref: '#/components/schemas/InventoryOptionalFields' - - description: Contains the optional fields that are included in the inventory - results. - Schedule: - allOf: - - $ref: '#/components/schemas/InventorySchedule' - - description: Specifies the schedule for generating inventory results. - required: - - Destination - - IsEnabled - - Id - - IncludedObjectVersions - - Schedule - type: object - InventoryConfigurationList: - items: - $ref: '#/components/schemas/InventoryConfiguration' - type: array - xml: - wrapped: false - InventoryDestination: - description: Specifies the inventory configuration for an Amazon S3 bucket. - properties: - S3BucketDestination: - allOf: - - $ref: '#/components/schemas/InventoryS3BucketDestination' - - description: Contains the bucket name, file format, bucket owner (optional), - and prefix (optional) where inventory results are published. - required: - - S3BucketDestination - type: object - InventoryEncryption: - description: Contains the type of server-side encryption used to encrypt the - inventory results. - properties: - SSE-KMS: - allOf: - - $ref: '#/components/schemas/SSEKMS' - - description: Specifies the use of SSE-KMS to encrypt delivered inventory - reports. - SSE-S3: - allOf: - - $ref: '#/components/schemas/SSES3' - - description: Specifies the use of SSE-S3 to encrypt delivered inventory - reports. - type: object - InventoryFilter: - description: Specifies an inventory filter. The inventory only includes objects - that meet the filter's criteria. - properties: - Prefix: - allOf: - - $ref: '#/components/schemas/Prefix' - - description: The prefix that an object must have to be included in the - inventory results. - required: - - Prefix - type: object - InventoryFormat: - enum: - - CSV - - ORC - - Parquet - type: string - InventoryFrequency: - enum: - - Daily - - Weekly - type: string - InventoryId: - type: string - InventoryIncludedObjectVersions: - enum: - - All - - Current - type: string - InventoryOptionalField: - enum: - - Size - - LastModifiedDate - - StorageClass - - ETag - - IsMultipartUploaded - - ReplicationStatus - - EncryptionStatus - - ObjectLockRetainUntilDate - - ObjectLockMode - - ObjectLockLegalHoldStatus - - IntelligentTieringAccessTier - - BucketKeyStatus - - ChecksumAlgorithm - type: string - InventoryOptionalFields: - items: - allOf: - - $ref: '#/components/schemas/InventoryOptionalField' - - xml: - name: Field - type: array - InventoryS3BucketDestination: - description: Contains the bucket name, file format, bucket owner (optional), - and prefix (optional) where inventory results are published. - properties: - AccountId: - allOf: - - $ref: '#/components/schemas/AccountId' - - description:

The account ID that owns the destination S3 bucket. If - no account ID is provided, the owner is not validated before exporting - data.

Although this value is optional, we strongly recommend - that you set it to help prevent problems if the destination bucket ownership - changes.

- Bucket: - allOf: - - $ref: '#/components/schemas/BucketName' - - description: The Amazon Resource Name (ARN) of the bucket where inventory - results will be published. - Encryption: - allOf: - - $ref: '#/components/schemas/InventoryEncryption' - - description: Contains the type of server-side encryption used to encrypt - the inventory results. - Format: - allOf: - - $ref: '#/components/schemas/InventoryFormat' - - description: Specifies the output format of the inventory results. - Prefix: - allOf: - - $ref: '#/components/schemas/Prefix' - - description: The prefix that is prepended to all inventory results. - required: - - Bucket - - Format - type: object - InventorySchedule: - description: Specifies the schedule for generating inventory results. - properties: - Frequency: - allOf: - - $ref: '#/components/schemas/InventoryFrequency' - - description: Specifies how frequently inventory results are produced. - required: - - Frequency - type: object - IsEnabled: - type: boolean - IsLatest: - type: boolean - IsPublic: - type: boolean - IsTruncated: - type: boolean - JSONInput: - description: Specifies JSON as object's input serialization format. - properties: - Type: - allOf: - - $ref: '#/components/schemas/JSONType' - - description: 'The type of JSON. Valid values: Document, Lines.' - type: object - JSONOutput: - description: Specifies JSON as request's output serialization format. - properties: - RecordDelimiter: - allOf: - - $ref: '#/components/schemas/RecordDelimiter' - - description: The value used to separate individual records in the output. - If no value is specified, Amazon S3 uses a newline character ('\n'). - type: object - JSONType: - enum: - - DOCUMENT - - LINES - type: string - KMSContext: - type: string - KeyCount: - type: integer - KeyMarker: - type: string - KeyPrefixEquals: - type: string - LambdaFunctionArn: - type: string - LambdaFunctionConfiguration: - description: A container for specifying the configuration for Lambda notifications. - properties: - CloudFunction: - allOf: - - $ref: '#/components/schemas/LambdaFunctionArn' - - description: The Amazon Resource Name (ARN) of the Lambda function that - Amazon S3 invokes when the specified event type occurs. - Event: - allOf: - - $ref: '#/components/schemas/EventList' - - description: The Amazon S3 bucket event for which to invoke the Lambda - function. For more information, see Supported - Event Types in the Amazon S3 User Guide. - Filter: - $ref: '#/components/schemas/NotificationConfigurationFilter' - Id: - $ref: '#/components/schemas/NotificationId' - required: - - LambdaFunctionArn - - Events - type: object - LambdaFunctionConfigurationList: - items: - $ref: '#/components/schemas/LambdaFunctionConfiguration' - type: array - xml: - wrapped: false - LastModified: - format: date-time - type: string - LifecycleConfiguration: - description: Container for lifecycle rules. You can add as many as 1000 rules. - properties: - Rule: - allOf: - - $ref: '#/components/schemas/Rules' - - description: 'Specifies lifecycle configuration rules for an Amazon S3 - bucket. ' - required: - - Rules - type: object - LifecycleExpiration: - description: Container for the expiration for the lifecycle of the object. - properties: - Date: - allOf: - - $ref: '#/components/schemas/Date' - - description: Indicates at what date the object is to be moved or deleted. - Should be in GMT ISO 8601 Format. - Days: - allOf: - - $ref: '#/components/schemas/Days' - - description: Indicates the lifetime, in days, of the objects that are - subject to the rule. The value must be a non-zero positive integer. - ExpiredObjectDeleteMarker: - allOf: - - $ref: '#/components/schemas/ExpiredObjectDeleteMarker' - - description: Indicates whether Amazon S3 will remove a delete marker with - no noncurrent versions. If set to true, the delete marker will be expired; - if set to false the policy takes no action. This cannot be specified - with Days or Date in a Lifecycle Expiration Policy. - type: object - LifecycleRule: - description: A lifecycle rule for individual objects in an Amazon S3 bucket. - properties: - AbortIncompleteMultipartUpload: - $ref: '#/components/schemas/AbortIncompleteMultipartUpload' - Expiration: - allOf: - - $ref: '#/components/schemas/LifecycleExpiration' - - description: Specifies the expiration for the lifecycle of the object - in the form of date, days and, whether the object has a delete marker. - Filter: - allOf: - - $ref: '#/components/schemas/LifecycleRuleFilter' - - description: The Filter is used to identify objects that - a Lifecycle Rule applies to. A Filter must have exactly - one of Prefix, Tag, or And specified. - Filter is required if the LifecycleRule does - not contain a Prefix element. - ID: - allOf: - - $ref: '#/components/schemas/ID' - - description: Unique identifier for the rule. The value cannot be longer - than 255 characters. - NoncurrentVersionExpiration: - $ref: '#/components/schemas/NoncurrentVersionExpiration' - NoncurrentVersionTransition: - allOf: - - $ref: '#/components/schemas/NoncurrentVersionTransitionList' - - description: ' Specifies the transition rule for the lifecycle rule that - describes when noncurrent objects transition to a specific storage class. - If your bucket is versioning-enabled (or versioning is suspended), you - can set this action to request that Amazon S3 transition noncurrent - object versions to a specific storage class at a set period in the object''s - lifetime. ' - Prefix: - allOf: - - $ref: '#/components/schemas/Prefix' - - deprecated: true - description:

Prefix identifying one or more objects to which the rule - applies. This is no longer used; use Filter instead.

-

Replacement must be made for object keys containing special - characters (such as carriage returns) when using XML requests. For more - information, see - XML related object key constraints.

 - Status: - allOf: - - $ref: '#/components/schemas/ExpirationStatus' - - description: If 'Enabled', the rule is currently being applied. If 'Disabled', - the rule is not currently being applied. - Transition: - allOf: - - $ref: '#/components/schemas/TransitionList' - - description: Specifies when an Amazon S3 object transitions to a specified - storage class. - required: - - Status - type: object - LifecycleRuleAndOperator: - description: This is used in a Lifecycle Rule Filter to apply a logical AND - to two or more predicates. The Lifecycle Rule will apply to any object matching - all of the predicates configured inside the And operator. - properties: - ObjectSizeGreaterThan: - allOf: - - $ref: '#/components/schemas/ObjectSizeGreaterThanBytes' - - description: Minimum object size to which the rule applies. - ObjectSizeLessThan: - allOf: - - $ref: '#/components/schemas/ObjectSizeLessThanBytes' - - description: Maximum object size to which the rule applies. - Prefix: - allOf: - - $ref: '#/components/schemas/Prefix' - - description: Prefix identifying one or more objects to which the rule - applies. - Tag: - allOf: - - $ref: '#/components/schemas/TagSet' - - description: All of these tags must exist in the object's tag set in order - for the rule to apply. - type: object - xml: - wrapped: false - LifecycleRuleFilter: - description: The Filter is used to identify objects that a Lifecycle - Rule applies to. A Filter must have exactly one of Prefix, - Tag, or And specified. - properties: - And: - $ref: '#/components/schemas/LifecycleRuleAndOperator' - ObjectSizeGreaterThan: - allOf: - - $ref: '#/components/schemas/ObjectSizeGreaterThanBytes' - - description: Minimum object size to which the rule applies. - ObjectSizeLessThan: - allOf: - - $ref: '#/components/schemas/ObjectSizeLessThanBytes' - - description: Maximum object size to which the rule applies. - Prefix: - allOf: - - $ref: '#/components/schemas/Prefix' - - description:

Prefix identifying one or more objects to which the rule - applies.

Replacement must be made for object keys - containing special characters (such as carriage returns) when using - XML requests. For more information, see - XML related object key constraints.

 - Tag: - allOf: - - $ref: '#/components/schemas/Tag' - - description: This tag must exist in the object's tag set in order for - the rule to apply. - type: object - LifecycleRules: - items: - $ref: '#/components/schemas/LifecycleRule' - type: array - xml: - wrapped: false - ListBucketAnalyticsConfigurationsOutput: - properties: - AnalyticsConfiguration: - allOf: - - $ref: '#/components/schemas/AnalyticsConfigurationList' - - description: The list of analytics configurations for a bucket. - ContinuationToken: - allOf: - - $ref: '#/components/schemas/Token' - - description: The marker that is used as a starting point for this analytics - configuration list response. This value is present if it was sent in - the request. - IsTruncated: - allOf: - - $ref: '#/components/schemas/IsTruncated' - - description: Indicates whether the returned list of analytics configurations - is complete. A value of true indicates that the list is not complete - and the NextContinuationToken will be provided for a subsequent request. - NextContinuationToken: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: ' NextContinuationToken is sent when isTruncated - is true, which indicates that there are more analytics configurations - to list. The next request must include this NextContinuationToken. - The token is obfuscated and is not a usable value.' - type: object - ListBucketAnalyticsConfigurationsRequest: - properties: {} - required: - - Bucket - title: ListBucketAnalyticsConfigurationsRequest - type: object - ListBucketIntelligentTieringConfigurationsOutput: - properties: - ContinuationToken: - allOf: - - $ref: '#/components/schemas/Token' - - description: The ContinuationToken that represents a placeholder - from where this request should begin. - IntelligentTieringConfiguration: - allOf: - - $ref: '#/components/schemas/IntelligentTieringConfigurationList' - - description: The list of S3 Intelligent-Tiering configurations for a bucket. - IsTruncated: - allOf: - - $ref: '#/components/schemas/IsTruncated' - - description: Indicates whether the returned list of analytics configurations - is complete. A value of true indicates that the list is - not complete and the NextContinuationToken will be provided - for a subsequent request. - NextContinuationToken: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: The marker used to continue this inventory configuration - listing. Use the NextContinuationToken from this response - to continue the listing in a subsequent request. The continuation token - is an opaque value that Amazon S3 understands. - type: object - ListBucketIntelligentTieringConfigurationsRequest: - properties: {} - required: - - Bucket - title: ListBucketIntelligentTieringConfigurationsRequest - type: object - ListBucketInventoryConfigurationsOutput: - properties: - ContinuationToken: - allOf: - - $ref: '#/components/schemas/Token' - - description: If sent in the request, the marker that is used as a starting - point for this inventory configuration list response. - InventoryConfiguration: - allOf: - - $ref: '#/components/schemas/InventoryConfigurationList' - - description: The list of inventory configurations for a bucket. - IsTruncated: - allOf: - - $ref: '#/components/schemas/IsTruncated' - - description: Tells whether the returned list of inventory configurations - is complete. A value of true indicates that the list is not complete - and the NextContinuationToken is provided for a subsequent request. - NextContinuationToken: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: The marker used to continue this inventory configuration - listing. Use the NextContinuationToken from this response - to continue the listing in a subsequent request. The continuation token - is an opaque value that Amazon S3 understands. - type: object - ListBucketInventoryConfigurationsRequest: - properties: {} - required: - - Bucket - title: ListBucketInventoryConfigurationsRequest - type: object - ListBucketMetricsConfigurationsOutput: - properties: - ContinuationToken: - allOf: - - $ref: '#/components/schemas/Token' - - description: The marker that is used as a starting point for this metrics - configuration list response. This value is present if it was sent in - the request. - IsTruncated: - allOf: - - $ref: '#/components/schemas/IsTruncated' - - description: Indicates whether the returned list of metrics configurations - is complete. A value of true indicates that the list is not complete - and the NextContinuationToken will be provided for a subsequent request. - MetricsConfiguration: - allOf: - - $ref: '#/components/schemas/MetricsConfigurationList' - - description: The list of metrics configurations for a bucket. - NextContinuationToken: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: The marker used to continue a metrics configuration listing - that has been truncated. Use the NextContinuationToken - from a previously truncated list response to continue the listing. The - continuation token is an opaque value that Amazon S3 understands. - type: object - ListBucketMetricsConfigurationsRequest: - properties: {} - required: - - Bucket - title: ListBucketMetricsConfigurationsRequest - type: object - ListBucketsOutput: - example: - Buckets: - - CreationDate: '2012-02-15T21: 03: 02.000Z' - Name: examplebucket - - CreationDate: '2011-07-24T19: 33: 50.000Z' - Name: examplebucket2 - - CreationDate: '2010-12-17T00: 56: 49.000Z' - Name: examplebucket3 - Owner: - DisplayName: own-display-name - ID: examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31 - properties: - Buckets: - allOf: - - $ref: '#/components/schemas/Buckets' - - description: The list of buckets owned by the requester. - Owner: - allOf: - - $ref: '#/components/schemas/Owner' - - description: The owner of the buckets listed. - type: object - ListMultipartUploadsOutput: - example: - Uploads: - - Initiated: '2014-05-01T05:40:58.000Z' - Initiator: - DisplayName: display-name - ID: examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc - Key: JavaFile - Owner: - DisplayName: display-name - ID: examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc - StorageClass: STANDARD - UploadId: examplelUa.CInXklLQtSMJITdUnoZ1Y5GACB5UckOtspm5zbDMCkPF_qkfZzMiFZ6dksmcnqxJyIBvQMG9X9Q-- - - Initiated: '2014-05-01T05:41:27.000Z' - Initiator: - DisplayName: display-name - ID: examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc - Key: JavaFile - Owner: - DisplayName: display-name - ID: examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc - StorageClass: STANDARD - UploadId: examplelo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw-- - properties: - Bucket: - allOf: - - $ref: '#/components/schemas/BucketName' - - description: The name of the bucket to which the multipart upload was - initiated. Does not return the access point ARN or access point alias - if used. - CommonPrefixes: - allOf: - - $ref: '#/components/schemas/CommonPrefixList' - - description: If you specify a delimiter in the request, then the result - returns each distinct key prefix containing the delimiter in a CommonPrefixes - element. The distinct key prefixes are returned in the Prefix - child element. - Delimiter: - allOf: - - $ref: '#/components/schemas/Delimiter' - - description: Contains the delimiter you specified in the request. If you - don't specify a delimiter in your request, this element is absent from - the response. - EncodingType: - allOf: - - $ref: '#/components/schemas/EncodingType' - - description:

Encoding type used by Amazon S3 to encode object keys - in the response.

If you specify encoding-type request - parameter, Amazon S3 includes this element in the response, and returns - encoded key name values in the following response elements:

- Delimiter, KeyMarker, Prefix, - NextKeyMarker, Key.

- IsTruncated: - allOf: - - $ref: '#/components/schemas/IsTruncated' - - description: Indicates whether the returned list of multipart uploads - is truncated. A value of true indicates that the list was truncated. - The list can be truncated if the number of multipart uploads exceeds - the limit allowed or specified by max uploads. - KeyMarker: - allOf: - - $ref: '#/components/schemas/KeyMarker' - - description: The key at or after which the listing began. - MaxUploads: - allOf: - - $ref: '#/components/schemas/MaxUploads' - - description: Maximum number of multipart uploads that could have been - included in the response. - NextKeyMarker: - allOf: - - $ref: '#/components/schemas/NextKeyMarker' - - description: When a list is truncated, this element specifies the value - that should be used for the key-marker request parameter in a subsequent - request. - NextUploadIdMarker: - allOf: - - $ref: '#/components/schemas/NextUploadIdMarker' - - description: When a list is truncated, this element specifies the value - that should be used for the upload-id-marker request parameter - in a subsequent request. - Prefix: - allOf: - - $ref: '#/components/schemas/Prefix' - - description: When a prefix is provided in the request, this field contains - the specified prefix. The result contains only keys starting with the - specified prefix. - Upload: - allOf: - - $ref: '#/components/schemas/MultipartUploadList' - - description: Container for elements related to a particular multipart - upload. A response can contain zero or more Upload elements. - UploadIdMarker: - allOf: - - $ref: '#/components/schemas/UploadIdMarker' - - description: Upload ID after which listing began. - type: object - ListMultipartUploadsRequest: - properties: {} - required: - - Bucket - title: ListMultipartUploadsRequest - type: object - ListObjectVersionsOutput: - example: - Versions: - - ETag: '"6805f2cfc46c0f04559748bb039d69ae"' - IsLatest: true - Key: HappyFace.jpg - LastModified: '2016-12-15T01:19:41.000Z' - Owner: - DisplayName: owner-display-name - ID: examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc - Size: 3191 - StorageClass: STANDARD - VersionId: 'null' - - ETag: '"6805f2cfc46c0f04559748bb039d69ae"' - IsLatest: false - Key: HappyFace.jpg - LastModified: '2016-12-13T00:58:26.000Z' - Owner: - DisplayName: owner-display-name - ID: examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc - Size: 3191 - StorageClass: STANDARD - VersionId: PHtexPGjH2y.zBgT8LmB7wwLI2mpbz.k - properties: - CommonPrefixes: - allOf: - - $ref: '#/components/schemas/CommonPrefixList' - - description: All of the keys rolled up into a common prefix count as a - single return when calculating the number of returns. - DeleteMarker: - allOf: - - $ref: '#/components/schemas/DeleteMarkers' - - description: Container for an object that is a delete marker. - Delimiter: - allOf: - - $ref: '#/components/schemas/Delimiter' - - description: The delimiter grouping the included keys. A delimiter is - a character that you specify to group keys. All keys that contain the - same string between the prefix and the first occurrence of the delimiter - are grouped under a single result element in CommonPrefixes. - These groups are counted as one result against the max-keys limitation. - These keys are not returned elsewhere in the response. - EncodingType: - allOf: - - $ref: '#/components/schemas/EncodingType' - - description:

Encoding type used by Amazon S3 to encode object key - names in the XML response.

If you specify encoding-type request - parameter, Amazon S3 includes this element in the response, and returns - encoded key name values in the following response elements:

- KeyMarker, NextKeyMarker, Prefix, Key, and Delimiter.

- IsTruncated: - allOf: - - $ref: '#/components/schemas/IsTruncated' - - description: A flag that indicates whether Amazon S3 returned all of the - results that satisfied the search criteria. If your results were truncated, - you can make a follow-up paginated request using the NextKeyMarker and - NextVersionIdMarker response parameters as a starting place in another - request to return the rest of the results. - KeyMarker: - allOf: - - $ref: '#/components/schemas/KeyMarker' - - description: Marks the last key returned in a truncated response. - MaxKeys: - allOf: - - $ref: '#/components/schemas/MaxKeys' - - description: Specifies the maximum number of objects to return. - Name: - allOf: - - $ref: '#/components/schemas/BucketName' - - description: The bucket name. - NextKeyMarker: - allOf: - - $ref: '#/components/schemas/NextKeyMarker' - - description: When the number of responses exceeds the value of MaxKeys, - NextKeyMarker specifies the first key not returned that - satisfies the search criteria. Use this value for the key-marker request - parameter in a subsequent request. - NextVersionIdMarker: - allOf: - - $ref: '#/components/schemas/NextVersionIdMarker' - - description: When the number of responses exceeds the value of MaxKeys, - NextVersionIdMarker specifies the first object version - not returned that satisfies the search criteria. Use this value for - the version-id-marker request parameter in a subsequent request. - Prefix: - allOf: - - $ref: '#/components/schemas/Prefix' - - description: Selects objects that start with the value supplied by this - parameter. - Version: - allOf: - - $ref: '#/components/schemas/ObjectVersionList' - - description: Container for version information. - VersionIdMarker: - allOf: - - $ref: '#/components/schemas/VersionIdMarker' - - description: Marks the last version of the key returned in a truncated - response. - type: object - ListObjectVersionsRequest: - properties: {} - required: - - Bucket - title: ListObjectVersionsRequest - type: object - ListObjectsOutput: - example: - Contents: - - ETag: '"70ee1738b6b21e2c8a43f3a5ab0eee71"' - Key: example1.jpg - LastModified: '2014-11-21T19:40:05.000Z' - Owner: - DisplayName: myname - ID: 12345example25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc - Size: 11 - StorageClass: STANDARD - - ETag: '"9c8af9a76df052144598c115ef33e511"' - Key: example2.jpg - LastModified: '2013-11-15T01:10:49.000Z' - Owner: - DisplayName: myname - ID: 12345example25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc - Size: 713193 - StorageClass: STANDARD - NextMarker: eyJNYXJrZXIiOiBudWxsLCAiYm90b190cnVuY2F0ZV9hbW91bnQiOiAyfQ== - properties: - CommonPrefixes: - allOf: - - $ref: '#/components/schemas/CommonPrefixList' - - description:

All of the keys (up to 1,000) rolled up in a common prefix - count as a single return when calculating the number of returns.

-

A response can contain CommonPrefixes only if you specify a delimiter.

-

CommonPrefixes contains all (if there are any) keys between Prefix - and the next occurrence of the string specified by the delimiter.

-

CommonPrefixes lists keys that act like subdirectories in the directory - specified by Prefix.

For example, if the prefix is notes/ and - the delimiter is a slash (/) as in notes/summer/july, the common prefix - is notes/summer/. All of the keys that roll up into a common prefix - count as a single return when calculating the number of returns.

- Contents: - allOf: - - $ref: '#/components/schemas/ObjectList' - - description: Metadata about each object returned. - Delimiter: - allOf: - - $ref: '#/components/schemas/Delimiter' - - description: Causes keys that contain the same string between the prefix - and the first occurrence of the delimiter to be rolled up into a single - result element in the CommonPrefixes collection. These - rolled-up keys are not returned elsewhere in the response. Each rolled-up - result counts as only one return against the MaxKeys value. - EncodingType: - allOf: - - $ref: '#/components/schemas/EncodingType' - - description: Encoding type used by Amazon S3 to encode object keys in - the response. - IsTruncated: - allOf: - - $ref: '#/components/schemas/IsTruncated' - - description: A flag that indicates whether Amazon S3 returned all of the - results that satisfied the search criteria. - Marker: - allOf: - - $ref: '#/components/schemas/Marker' - - description: Indicates where in the bucket listing begins. Marker is included - in the response if it was sent with the request. - MaxKeys: - allOf: - - $ref: '#/components/schemas/MaxKeys' - - description: The maximum number of keys returned in the response body. - Name: - allOf: - - $ref: '#/components/schemas/BucketName' - - description: The bucket name. - NextMarker: - allOf: - - $ref: '#/components/schemas/NextMarker' - - description: 'When response is truncated (the IsTruncated element value - in the response is true), you can use the key name in this field as - marker in the subsequent request to get next set of objects. Amazon - S3 lists objects in alphabetical order Note: This element is returned - only if you have delimiter request parameter specified. If response - does not include the NextMarker and it is truncated, you can use the - value of the last Key in the response as the marker in the subsequent - request to get the next set of object keys.' - Prefix: - allOf: - - $ref: '#/components/schemas/Prefix' - - description: Keys that begin with the indicated prefix. - type: object - ListObjectsRequest: - properties: {} - required: - - Bucket - title: ListObjectsRequest - type: object - ListObjectsV2Output: - example: - Contents: - - ETag: '"70ee1738b6b21e2c8a43f3a5ab0eee71"' - Key: happyface.jpg - LastModified: '2014-11-21T19:40:05.000Z' - Size: 11 - StorageClass: STANDARD - - ETag: '"becf17f89c30367a9a44495d62ed521a-1"' - Key: test.jpg - LastModified: '2014-05-02T04:51:50.000Z' - Size: 4192256 - StorageClass: STANDARD - IsTruncated: true - KeyCount: '2' - MaxKeys: '2' - Name: examplebucket - NextContinuationToken: 1w41l63U0xa8q7smH50vCxyTQqdxo69O3EmK28Bi5PcROI4wI/EyIJg== - Prefix: '' - properties: - CommonPrefixes: - allOf: - - $ref: '#/components/schemas/CommonPrefixList' - - description:

All of the keys (up to 1,000) rolled up into a common - prefix count as a single return when calculating the number of returns.

-

A response can contain CommonPrefixes only if you specify - a delimiter.

CommonPrefixes contains all (if there - are any) keys between Prefix and the next occurrence of - the string specified by a delimiter.

CommonPrefixes - lists keys that act like subdirectories in the directory specified by - Prefix.

For example, if the prefix is notes/ - and the delimiter is a slash (/) as in notes/summer/july, - the common prefix is notes/summer/. All of the keys that - roll up into a common prefix count as a single return when calculating - the number of returns.

- Contents: - allOf: - - $ref: '#/components/schemas/ObjectList' - - description: Metadata about each object returned. - ContinuationToken: - allOf: - - $ref: '#/components/schemas/Token' - - description: ' If ContinuationToken was sent with the request, it is included - in the response.' - Delimiter: - allOf: - - $ref: '#/components/schemas/Delimiter' - - description: Causes keys that contain the same string between the prefix - and the first occurrence of the delimiter to be rolled up into a single - result element in the CommonPrefixes collection. These rolled-up keys - are not returned elsewhere in the response. Each rolled-up result counts - as only one return against the MaxKeys value. - EncodingType: - allOf: - - $ref: '#/components/schemas/EncodingType' - - description:

Encoding type used by Amazon S3 to encode object key names - in the XML response.

If you specify the encoding-type request - parameter, Amazon S3 includes this element in the response, and returns - encoded key name values in the following response elements:

- Delimiter, Prefix, Key, and StartAfter.

- IsTruncated: - allOf: - - $ref: '#/components/schemas/IsTruncated' - - description: Set to false if all of the results were returned. Set to - true if more keys are available to return. If the number of results - exceeds that specified by MaxKeys, all of the results might not be returned. - KeyCount: - allOf: - - $ref: '#/components/schemas/KeyCount' - - description: 'KeyCount is the number of keys returned with this request. - KeyCount will always be less than or equals to MaxKeys field. Say you - ask for 50 keys, your result will include less than equals 50 keys ' - MaxKeys: - allOf: - - $ref: '#/components/schemas/MaxKeys' - - description: Sets the maximum number of keys returned in the response. - By default the action returns up to 1,000 key names. The response might - contain fewer keys but will never contain more. - Name: - allOf: - - $ref: '#/components/schemas/BucketName' - - description:

The bucket name.

When using this action with an - access point, you must direct requests to the access point hostname. - The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this action with an access point through the Amazon Web Services - SDKs, you provide the access point ARN in place of the bucket name. - For more information about access point ARNs, see Using - access points in the Amazon S3 User Guide.

When using - this action with Amazon S3 on Outposts, you must direct requests to - the S3 on Outposts hostname. The S3 on Outposts hostname takes the form - AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. - When using this action with S3 on Outposts through the Amazon Web Services - SDKs, you provide the Outposts bucket ARN in place of the bucket name. - For more information about S3 on Outposts ARNs, see Using - Amazon S3 on Outposts in the Amazon S3 User Guide.

- NextContinuationToken: - allOf: - - $ref: '#/components/schemas/NextToken' - - description: ' NextContinuationToken is sent when isTruncated - is true, which means there are more keys in the bucket that can be listed. - The next list requests to Amazon S3 can be continued with this NextContinuationToken. - NextContinuationToken is obfuscated and is not a real key' - Prefix: - allOf: - - $ref: '#/components/schemas/Prefix' - - description: ' Keys that begin with the indicated prefix.' - StartAfter: - allOf: - - $ref: '#/components/schemas/StartAfter' - - description: If StartAfter was sent with the request, it is included in - the response. - type: object - ListObjectsV2Request: - properties: {} - required: - - Bucket - title: ListObjectsV2Request - type: object - ListPartsOutput: - example: - Initiator: - DisplayName: owner-display-name - ID: examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc - Owner: - DisplayName: owner-display-name - ID: examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc - Parts: - - ETag: '"d8c2eafd90c266e19ab9dcacc479f8af"' - LastModified: '2016-12-16T00:11:42.000Z' - PartNumber: '1' - Size: 26246026 - - ETag: '"d8c2eafd90c266e19ab9dcacc479f8af"' - LastModified: '2016-12-16T00:15:01.000Z' - PartNumber: '2' - Size: 26246026 - StorageClass: STANDARD - properties: - Bucket: - allOf: - - $ref: '#/components/schemas/BucketName' - - description: The name of the bucket to which the multipart upload was - initiated. Does not return the access point ARN or access point alias - if used. - ChecksumAlgorithm: - allOf: - - $ref: '#/components/schemas/ChecksumAlgorithm' - - description: The algorithm that was used to create a checksum of the object. - Initiator: - allOf: - - $ref: '#/components/schemas/Initiator' - - description: Container element that identifies who initiated the multipart - upload. If the initiator is an Amazon Web Services account, this element - provides the same information as the Owner element. If - the initiator is an IAM User, this element provides the user ARN and - display name. - IsTruncated: - allOf: - - $ref: '#/components/schemas/IsTruncated' - - description: ' Indicates whether the returned list of parts is truncated. - A true value indicates that the list was truncated. A list can be truncated - if the number of parts exceeds the limit returned in the MaxParts element.' - Key: - allOf: - - $ref: '#/components/schemas/ObjectKey' - - description: Object key for which the multipart upload was initiated. - MaxParts: - allOf: - - $ref: '#/components/schemas/MaxParts' - - description: Maximum number of parts that were allowed in the response. - NextPartNumberMarker: - allOf: - - $ref: '#/components/schemas/NextPartNumberMarker' - - description: When a list is truncated, this element specifies the last - part in the list, as well as the value to use for the part-number-marker - request parameter in a subsequent request. - Owner: - allOf: - - $ref: '#/components/schemas/Owner' - - description: ' Container element that identifies the object owner, after - the object is created. If multipart upload is initiated by an IAM user, - this element provides the parent account ID and display name.' - Part: - allOf: - - $ref: '#/components/schemas/Parts' - - description: ' Container for elements related to a particular part. A - response can contain zero or more Part elements.' - PartNumberMarker: - allOf: - - $ref: '#/components/schemas/PartNumberMarker' - - description: When a list is truncated, this element specifies the last - part in the list, as well as the value to use for the part-number-marker - request parameter in a subsequent request. - StorageClass: - allOf: - - $ref: '#/components/schemas/StorageClass' - - description: Class of storage (STANDARD or REDUCED_REDUNDANCY) used to - store the uploaded object. - UploadId: - allOf: - - $ref: '#/components/schemas/MultipartUploadId' - - description: Upload ID identifying the multipart upload whose parts are - being listed. - type: object - ListPartsRequest: - properties: {} - required: - - Bucket - - Key - - UploadId - title: ListPartsRequest - type: object - Location: - type: string - LocationPrefix: - type: string - LoggingEnabled: - description: Describes where logs are stored and the prefix that Amazon S3 assigns - to all log object keys for a bucket. For more information, see PUT - Bucket logging in the Amazon S3 API Reference. - properties: - TargetBucket: - allOf: - - $ref: '#/components/schemas/TargetBucket' - - description: Specifies the bucket where you want Amazon S3 to store server - access logs. You can have your logs delivered to any bucket that you - own, including the same bucket that is being logged. You can also configure - multiple buckets to deliver their logs to the same target bucket. In - this case, you should choose a different TargetPrefix for - each source bucket so that the delivered log files can be distinguished - by key. - TargetGrants: - allOf: - - $ref: '#/components/schemas/TargetGrants' - - description:

Container for granting information.

Buckets that - use the bucket owner enforced setting for Object Ownership don't support - target grants. For more information, see Permissions - for server access log delivery in the Amazon S3 User Guide.

- TargetPrefix: - allOf: - - $ref: '#/components/schemas/TargetPrefix' - - description: A prefix for all log object keys. If you store log files - from multiple Amazon S3 buckets in a single bucket, you can use a prefix - to distinguish which log files came from which bucket. - required: - - TargetBucket - - TargetPrefix - type: object - MFA: - type: string - MFADelete: - enum: - - Enabled - - Disabled - type: string - MFADeleteStatus: - enum: - - Enabled - - Disabled - type: string - Marker: - type: string - MaxAgeSeconds: - type: integer - MaxKeys: - type: integer - MaxParts: - type: integer - MaxUploads: - type: integer - Message: - type: string - Metadata: - additionalProperties: - $ref: '#/components/schemas/MetadataValue' - type: object - MetadataDirective: - enum: - - COPY - - REPLACE - type: string - MetadataEntry: - description: A metadata key-value pair to store with an object. - properties: - Name: - allOf: - - $ref: '#/components/schemas/MetadataKey' - - description: Name of the Object. - Value: - allOf: - - $ref: '#/components/schemas/MetadataValue' - - description: Value of the Object. - type: object - MetadataKey: - type: string - MetadataValue: - type: string - Metrics: - description: ' A container specifying replication metrics-related settings enabling - replication metrics and events.' - properties: - EventThreshold: - allOf: - - $ref: '#/components/schemas/ReplicationTimeValue' - - description: ' A container specifying the time threshold for emitting - the s3:Replication:OperationMissedThreshold event. ' - Status: - allOf: - - $ref: '#/components/schemas/MetricsStatus' - - description: ' Specifies whether the replication metrics are enabled. ' - required: - - Status - type: object - MetricsAndOperator: - description: A conjunction (logical AND) of predicates, which is used in evaluating - a metrics filter. The operator must have at least two predicates, and an object - must match all of the predicates in order for the filter to apply. - properties: - AccessPointArn: - allOf: - - $ref: '#/components/schemas/AccessPointArn' - - description: The access point ARN used when evaluating an AND - predicate. - Prefix: - allOf: - - $ref: '#/components/schemas/Prefix' - - description: The prefix used when evaluating an AND predicate. - Tag: - allOf: - - $ref: '#/components/schemas/TagSet' - - description: The list of tags used when evaluating an AND predicate. - type: object - xml: - wrapped: false - MetricsConfiguration: - description: Specifies a metrics configuration for the CloudWatch request metrics - (specified by the metrics configuration ID) from an Amazon S3 bucket. If you're - updating an existing metrics configuration, note that this is a full replacement - of the existing metrics configuration. If you don't include the elements you - want to keep, they are erased. For more information, see PutBucketMetricsConfiguration. - properties: - Filter: - allOf: - - $ref: '#/components/schemas/MetricsFilter' - - description: Specifies a metrics configuration filter. The metrics configuration - will only include objects that meet the filter's criteria. A filter - must be a prefix, an object tag, an access point ARN, or a conjunction - (MetricsAndOperator). - Id: - allOf: - - $ref: '#/components/schemas/MetricsId' - - description: The ID used to identify the metrics configuration. - required: - - Id - type: object - MetricsConfigurationList: - items: - $ref: '#/components/schemas/MetricsConfiguration' - type: array - xml: - wrapped: false - MetricsFilter: - description: Specifies a metrics configuration filter. The metrics configuration - only includes objects that meet the filter's criteria. A filter must be a - prefix, an object tag, an access point ARN, or a conjunction (MetricsAndOperator). - For more information, see PutBucketMetricsConfiguration. - properties: - AccessPointArn: - allOf: - - $ref: '#/components/schemas/AccessPointArn' - - description: The access point ARN used when evaluating a metrics filter. - And: - allOf: - - $ref: '#/components/schemas/MetricsAndOperator' - - description: A conjunction (logical AND) of predicates, which is used - in evaluating a metrics filter. The operator must have at least two - predicates, and an object must match all of the predicates in order - for the filter to apply. - Prefix: - allOf: - - $ref: '#/components/schemas/Prefix' - - description: The prefix used when evaluating a metrics filter. - Tag: - allOf: - - $ref: '#/components/schemas/Tag' - - description: The tag used when evaluating a metrics filter. - type: object - MetricsId: - type: string - MetricsStatus: - enum: - - Enabled - - Disabled - type: string - Minutes: - type: integer - MissingMeta: - type: integer - MultipartUpload: - description: Container for the MultipartUpload for the Amazon S3 - object. - properties: - ChecksumAlgorithm: - allOf: - - $ref: '#/components/schemas/ChecksumAlgorithm' - - description: The algorithm that was used to create a checksum of the object. - Initiated: - allOf: - - $ref: '#/components/schemas/Initiated' - - description: Date and time at which the multipart upload was initiated. - Initiator: - allOf: - - $ref: '#/components/schemas/Initiator' - - description: Identifies who initiated the multipart upload. - Key: - allOf: - - $ref: '#/components/schemas/ObjectKey' - - description: Key of the object for which the multipart upload was initiated. - Owner: - allOf: - - $ref: '#/components/schemas/Owner' - - description: 'Specifies the owner of the object that is part of the multipart - upload. ' - StorageClass: - allOf: - - $ref: '#/components/schemas/StorageClass' - - description: The class of storage used to store the object. - UploadId: - allOf: - - $ref: '#/components/schemas/MultipartUploadId' - - description: Upload ID that identifies the multipart upload. - type: object - MultipartUploadId: - type: string - MultipartUploadList: - items: - $ref: '#/components/schemas/MultipartUpload' - type: array - xml: - wrapped: false - NextKeyMarker: - type: string - NextMarker: - type: string - NextPartNumberMarker: - type: integer - NextToken: - type: string - NextUploadIdMarker: - type: string - NextVersionIdMarker: - type: string - NoSuchBucket: {} - NoSuchKey: {} - NoSuchUpload: {} - NoncurrentVersionExpiration: - description: Specifies when noncurrent object versions expire. Upon expiration, - Amazon S3 permanently deletes the noncurrent object versions. You set this - lifecycle configuration action on a bucket that has versioning enabled (or - suspended) to request that Amazon S3 delete noncurrent object versions at - a specific period in the object's lifetime. - properties: - NewerNoncurrentVersions: - allOf: - - $ref: '#/components/schemas/VersionCount' - - description: Specifies how many noncurrent versions Amazon S3 will retain. - If there are this many more recent noncurrent versions, Amazon S3 will - take the associated action. For more information about noncurrent versions, - see Lifecycle - configuration elements in the Amazon S3 User Guide. - NoncurrentDays: - allOf: - - $ref: '#/components/schemas/Days' - - description: Specifies the number of days an object is noncurrent before - Amazon S3 can perform the associated action. The value must be a non-zero - positive integer. For information about the noncurrent days calculations, - see How - Amazon S3 Calculates When an Object Became Noncurrent in the Amazon - S3 User Guide. - type: object - NoncurrentVersionTransition: - description: Container for the transition rule that describes when noncurrent - objects transition to the STANDARD_IA, ONEZONE_IA, - INTELLIGENT_TIERING, GLACIER_IR, GLACIER, - or DEEP_ARCHIVE storage class. If your bucket is versioning-enabled - (or versioning is suspended), you can set this action to request that Amazon - S3 transition noncurrent object versions to the STANDARD_IA, - ONEZONE_IA, INTELLIGENT_TIERING, GLACIER_IR, - GLACIER, or DEEP_ARCHIVE storage class at a specific - period in the object's lifetime. - properties: - NewerNoncurrentVersions: - allOf: - - $ref: '#/components/schemas/VersionCount' - - description: Specifies how many noncurrent versions Amazon S3 will retain. - If there are this many more recent noncurrent versions, Amazon S3 will - take the associated action. For more information about noncurrent versions, - see Lifecycle - configuration elements in the Amazon S3 User Guide. - NoncurrentDays: - allOf: - - $ref: '#/components/schemas/Days' - - description: Specifies the number of days an object is noncurrent before - Amazon S3 can perform the associated action. For information about the - noncurrent days calculations, see How - Amazon S3 Calculates How Long an Object Has Been Noncurrent in the - Amazon S3 User Guide. - StorageClass: - allOf: - - $ref: '#/components/schemas/TransitionStorageClass' - - description: The class of storage used to store the object. - type: object - NoncurrentVersionTransitionList: - items: - $ref: '#/components/schemas/NoncurrentVersionTransition' - type: array - xml: - wrapped: false - NotificationConfiguration: - description: A container for specifying the notification configuration of the - bucket. If this element is empty, notifications are turned off for the bucket. - properties: - CloudFunctionConfiguration: - allOf: - - $ref: '#/components/schemas/LambdaFunctionConfigurationList' - - description: Describes the Lambda functions to invoke and the events for - which to invoke them. - EventBridgeConfiguration: - allOf: - - $ref: '#/components/schemas/EventBridgeConfiguration' - - description: Enables delivery of events to Amazon EventBridge. - QueueConfiguration: - allOf: - - $ref: '#/components/schemas/QueueConfigurationList' - - description: The Amazon Simple Queue Service queues to publish messages - to and the events for which to publish messages. - TopicConfiguration: - allOf: - - $ref: '#/components/schemas/TopicConfigurationList' - - description: The topic to which notifications are sent and the events - for which notifications are generated. - type: object - NotificationConfigurationDeprecated: - example: - QueueConfiguration: - Event: s3:ObjectCreated:Put - Events: - - s3:ObjectCreated:Put - Id: MDQ2OGQ4NDEtOTBmNi00YTM4LTk0NzYtZDIwN2I3NWQ1NjIx - Queue: arn:aws:sqs:us-east-1:acct-id:S3ObjectCreatedEventQueue - TopicConfiguration: - Event: s3:ObjectCreated:Copy - Events: - - s3:ObjectCreated:Copy - Id: YTVkMWEzZGUtNTY1NS00ZmE2LWJjYjktMmRlY2QwODFkNTJi - Topic: arn:aws:sns:us-east-1:acct-id:S3ObjectCreatedEventTopic - properties: - CloudFunctionConfiguration: - allOf: - - $ref: '#/components/schemas/CloudFunctionConfiguration' - - description: Container for specifying the Lambda notification configuration. - QueueConfiguration: - allOf: - - $ref: '#/components/schemas/QueueConfigurationDeprecated' - - description: 'This data type is deprecated. This data type specifies the - configuration for publishing messages to an Amazon Simple Queue Service - (Amazon SQS) queue when Amazon S3 detects specified events. ' - TopicConfiguration: - allOf: - - $ref: '#/components/schemas/TopicConfigurationDeprecated' - - description: 'This data type is deprecated. A container for specifying - the configuration for publication of messages to an Amazon Simple Notification - Service (Amazon SNS) topic when Amazon S3 detects specified events. ' - type: object - NotificationConfigurationFilter: - description: Specifies object key name filtering rules. For information about - key name filtering, see Configuring - Event Notifications in the Amazon S3 User Guide. - properties: - S3Key: - $ref: '#/components/schemas/S3KeyFilter' - type: object - NotificationId: - description: An optional unique identifier for configurations in a notification - configuration. If you don't provide one, Amazon S3 will assign an ID. - type: string - Object: - description: An object consists of data and its descriptive metadata. - properties: - ChecksumAlgorithm: - allOf: - - $ref: '#/components/schemas/ChecksumAlgorithmList' - - description: The algorithm that was used to create a checksum of the object. - ETag: - allOf: - - $ref: '#/components/schemas/ETag' - - description:

The entity tag is a hash of the object. The ETag reflects - changes only to the contents of an object, not its metadata. The ETag - may or may not be an MD5 digest of the object data. Whether or not it - is depends on how the object was created and how it is encrypted as - described below:

  • Objects created by the PUT Object, - POST Object, or Copy operation, or through the Amazon Web Services Management - Console, and are encrypted by SSE-S3 or plaintext, have ETags that are - an MD5 digest of their object data.

  • Objects created - by the PUT Object, POST Object, or Copy operation, or through the Amazon - Web Services Management Console, and are encrypted by SSE-C or SSE-KMS, - have ETags that are not an MD5 digest of their object data.

    • -

  • If an object is created by either the Multipart Upload or Part - Copy operation, the ETag is not an MD5 digest, regardless of the method - of encryption. If an object is larger than 16 MB, the Amazon Web Services - Management Console will upload or copy that object as a Multipart Upload, - and therefore the ETag will not be an MD5 digest.

- Key: - allOf: - - $ref: '#/components/schemas/ObjectKey' - - description: The name that you assign to an object. You use the object - key to retrieve the object. - LastModified: - allOf: - - $ref: '#/components/schemas/LastModified' - - description: Creation date of the object. - Owner: - allOf: - - $ref: '#/components/schemas/Owner' - - description: The owner of the object - Size: - allOf: - - $ref: '#/components/schemas/Size' - - description: Size in bytes of the object - StorageClass: - allOf: - - $ref: '#/components/schemas/ObjectStorageClass' - - description: The class of storage used to store the object. - type: object - ObjectAlreadyInActiveTierError: {} - ObjectAttributes: - enum: - - ETag - - Checksum - - ObjectParts - - StorageClass - - ObjectSize - type: string - ObjectAttributesList: - items: - $ref: '#/components/schemas/ObjectAttributes' - type: array - ObjectCannedACL: - enum: - - private - - public-read - - public-read-write - - authenticated-read - - aws-exec-read - - bucket-owner-read - - bucket-owner-full-control - type: string - ObjectIdentifier: - description: Object Identifier is unique value to identify objects. - properties: - Key: - allOf: - - $ref: '#/components/schemas/ObjectKey' - - description:

Key name of the object.

Replacement - must be made for object keys containing special characters (such as - carriage returns) when using XML requests. For more information, see - - XML related object key constraints.

 - VersionId: - allOf: - - $ref: '#/components/schemas/ObjectVersionId' - - description: VersionId for the specific version of the object to delete. - required: - - Key - type: object - ObjectIdentifierList: - items: - $ref: '#/components/schemas/ObjectIdentifier' - type: array - xml: - wrapped: false - ObjectKey: - minLength: 1 - type: string - ObjectList: - items: - $ref: '#/components/schemas/Object' - type: array - xml: - wrapped: false - ObjectLockConfiguration: - description: The container element for Object Lock configuration parameters. - properties: - ObjectLockEnabled: - allOf: - - $ref: '#/components/schemas/ObjectLockEnabled' - - description: 'Indicates whether this bucket has an Object Lock configuration - enabled. Enable ObjectLockEnabled when you apply ObjectLockConfiguration - to a bucket. ' - Rule: - allOf: - - $ref: '#/components/schemas/ObjectLockRule' - - description: Specifies the Object Lock rule for the specified object. - Enable the this rule when you apply ObjectLockConfiguration - to a bucket. Bucket settings require both a mode and a period. The period - can be either Days or Years but you must select - one. You cannot specify Days and Years at - the same time. - type: object - ObjectLockEnabled: - enum: - - Enabled - type: string - ObjectLockEnabledForBucket: - type: boolean - ObjectLockLegalHold: - description: A legal hold configuration for an object. - properties: - Status: - allOf: - - $ref: '#/components/schemas/ObjectLockLegalHoldStatus' - - description: Indicates whether the specified object has a legal hold in - place. - type: object - ObjectLockLegalHoldStatus: - enum: - - 'ON' - - 'OFF' - type: string - ObjectLockMode: - enum: - - GOVERNANCE - - COMPLIANCE - type: string - ObjectLockRetainUntilDate: - format: date-time - type: string - ObjectLockRetention: - description: A Retention configuration for an object. - properties: - Mode: - allOf: - - $ref: '#/components/schemas/ObjectLockRetentionMode' - - description: Indicates the Retention mode for the specified object. - RetainUntilDate: - allOf: - - $ref: '#/components/schemas/Date' - - description: The date on which this Object Lock Retention will expire. - type: object - ObjectLockRetentionMode: - enum: - - GOVERNANCE - - COMPLIANCE - type: string - ObjectLockRule: - description: The container element for an Object Lock rule. - properties: - DefaultRetention: - allOf: - - $ref: '#/components/schemas/DefaultRetention' - - description: The default Object Lock retention mode and period that you - want to apply to new objects placed in the specified bucket. Bucket - settings require both a mode and a period. The period can be either - Days or Years but you must select one. You - cannot specify Days and Years at the same - time. - type: object - ObjectLockToken: - type: string - ObjectNotInActiveTierError: {} - ObjectOwnership: - description:

The container element for object ownership for a bucket's ownership - controls.

BucketOwnerPreferred - Objects uploaded to the bucket change - ownership to the bucket owner if the objects are uploaded with the bucket-owner-full-control - canned ACL.

ObjectWriter - The uploading account will own the object - if the object is uploaded with the bucket-owner-full-control - canned ACL.

BucketOwnerEnforced - Access control lists (ACLs) are disabled - and no longer affect permissions. The bucket owner automatically owns and - has full control over every object in the bucket. The bucket only accepts - PUT requests that don't specify an ACL or bucket owner full control ACLs, - such as the bucket-owner-full-control canned ACL or an equivalent - form of this ACL expressed in the XML format.

- enum: - - BucketOwnerPreferred - - ObjectWriter - - BucketOwnerEnforced - type: string - ObjectPart: - description: A container for elements related to an individual part. - properties: - ChecksumCRC32: - allOf: - - $ref: '#/components/schemas/ChecksumCRC32' - - description: This header can be used as a data integrity check to verify - that the data received is the same data that was originally sent. This - header specifies the base64-encoded, 32-bit CRC32 checksum of the object. - For more information, see Checking - object integrity in the Amazon S3 User Guide. - ChecksumCRC32C: - allOf: - - $ref: '#/components/schemas/ChecksumCRC32C' - - description: The base64-encoded, 32-bit CRC32C checksum of the object. - This will only be present if it was uploaded with the object. With multipart - uploads, this may not be a checksum value of the object. For more information - about how checksums are calculated with multipart uploads, see - Checking object integrity in the Amazon S3 User Guide. - ChecksumSHA1: - allOf: - - $ref: '#/components/schemas/ChecksumSHA1' - - description: The base64-encoded, 160-bit SHA-1 digest of the object. This - will only be present if it was uploaded with the object. With multipart - uploads, this may not be a checksum value of the object. For more information - about how checksums are calculated with multipart uploads, see - Checking object integrity in the Amazon S3 User Guide. - ChecksumSHA256: - allOf: - - $ref: '#/components/schemas/ChecksumSHA256' - - description: The base64-encoded, 256-bit SHA-256 digest of the object. - This will only be present if it was uploaded with the object. With multipart - uploads, this may not be a checksum value of the object. For more information - about how checksums are calculated with multipart uploads, see - Checking object integrity in the Amazon S3 User Guide. - PartNumber: - allOf: - - $ref: '#/components/schemas/PartNumber' - - description: The part number identifying the part. This value is a positive - integer between 1 and 10,000. - Size: - allOf: - - $ref: '#/components/schemas/Size' - - description: The size of the uploaded part in bytes. - type: object - ObjectSize: - type: integer - ObjectSizeGreaterThanBytes: - type: integer - ObjectSizeLessThanBytes: - type: integer - ObjectStorageClass: - enum: - - STANDARD - - REDUCED_REDUNDANCY - - GLACIER - - STANDARD_IA - - ONEZONE_IA - - INTELLIGENT_TIERING - - DEEP_ARCHIVE - - OUTPOSTS - - GLACIER_IR - type: string - ObjectVersion: - description: The version of an object. - properties: - ChecksumAlgorithm: - allOf: - - $ref: '#/components/schemas/ChecksumAlgorithmList' - - description: The algorithm that was used to create a checksum of the object. - ETag: - allOf: - - $ref: '#/components/schemas/ETag' - - description: The entity tag is an MD5 hash of that version of the object. - IsLatest: - allOf: - - $ref: '#/components/schemas/IsLatest' - - description: Specifies whether the object is (true) or is not (false) - the latest version of an object. - Key: - allOf: - - $ref: '#/components/schemas/ObjectKey' - - description: The object key. - LastModified: - allOf: - - $ref: '#/components/schemas/LastModified' - - description: Date and time the object was last modified. - Owner: - allOf: - - $ref: '#/components/schemas/Owner' - - description: Specifies the owner of the object. - Size: - allOf: - - $ref: '#/components/schemas/Size' - - description: Size in bytes of the object. - StorageClass: - allOf: - - $ref: '#/components/schemas/ObjectVersionStorageClass' - - description: The class of storage used to store the object. - VersionId: - allOf: - - $ref: '#/components/schemas/ObjectVersionId' - - description: Version ID of an object. - type: object - ObjectVersionId: - type: string - ObjectVersionList: - items: - $ref: '#/components/schemas/ObjectVersion' - type: array - xml: - wrapped: false - ObjectVersionStorageClass: - enum: - - STANDARD - type: string - OutputLocation: - description: Describes the location where the restore job's output is stored. - properties: - S3: - allOf: - - $ref: '#/components/schemas/S3Location' - - description: Describes an S3 location that will receive the results of - the restore request. - type: object - OutputSerialization: - description: Describes how results of the Select job are serialized. - properties: - CSV: - allOf: - - $ref: '#/components/schemas/CSVOutput' - - description: Describes the serialization of CSV-encoded Select results. - JSON: - allOf: - - $ref: '#/components/schemas/JSONOutput' - - description: Specifies JSON as request's output serialization format. - type: object - Owner: - description: Container for the owner's display name and ID. - properties: - DisplayName: - allOf: - - $ref: '#/components/schemas/DisplayName' - - description: Container for the display name of the owner. - ID: - allOf: - - $ref: '#/components/schemas/ID' - - description: Container for the ID of the owner. - type: object - OwnerOverride: - enum: - - Destination - type: string - OwnershipControls: - description: The container element for a bucket's ownership controls. - properties: - Rule: - allOf: - - $ref: '#/components/schemas/OwnershipControlsRules' - - description: The container element for an ownership control rule. - required: - - Rules - type: object - OwnershipControlsRule: - description: The container element for an ownership control rule. - properties: - ObjectOwnership: - $ref: '#/components/schemas/ObjectOwnership' - required: - - ObjectOwnership - type: object - OwnershipControlsRules: - items: - $ref: '#/components/schemas/OwnershipControlsRule' - type: array - xml: - wrapped: false - ParquetInput: - description: Container for Parquet. - properties: {} - type: object - Part: - description: Container for elements related to a part. - properties: - ChecksumCRC32: - allOf: - - $ref: '#/components/schemas/ChecksumCRC32' - - description: This header can be used as a data integrity check to verify - that the data received is the same data that was originally sent. This - header specifies the base64-encoded, 32-bit CRC32 checksum of the object. - For more information, see Checking - object integrity in the Amazon S3 User Guide. - ChecksumCRC32C: - allOf: - - $ref: '#/components/schemas/ChecksumCRC32C' - - description: The base64-encoded, 32-bit CRC32C checksum of the object. - This will only be present if it was uploaded with the object. With multipart - uploads, this may not be a checksum value of the object. For more information - about how checksums are calculated with multipart uploads, see - Checking object integrity in the Amazon S3 User Guide. - ChecksumSHA1: - allOf: - - $ref: '#/components/schemas/ChecksumSHA1' - - description: The base64-encoded, 160-bit SHA-1 digest of the object. This - will only be present if it was uploaded with the object. With multipart - uploads, this may not be a checksum value of the object. For more information - about how checksums are calculated with multipart uploads, see - Checking object integrity in the Amazon S3 User Guide. - ChecksumSHA256: - allOf: - - $ref: '#/components/schemas/ChecksumSHA256' - - description: This header can be used as a data integrity check to verify - that the data received is the same data that was originally sent. This - header specifies the base64-encoded, 256-bit SHA-256 digest of the object. - For more information, see Checking - object integrity in the Amazon S3 User Guide. - ETag: - allOf: - - $ref: '#/components/schemas/ETag' - - description: Entity tag returned when the part was uploaded. - LastModified: - allOf: - - $ref: '#/components/schemas/LastModified' - - description: Date and time at which the part was uploaded. - PartNumber: - allOf: - - $ref: '#/components/schemas/PartNumber' - - description: Part number identifying the part. This is a positive integer - between 1 and 10,000. - Size: - allOf: - - $ref: '#/components/schemas/Size' - - description: Size in bytes of the uploaded part data. - type: object - PartNumber: - type: integer - PartNumberMarker: - type: integer - Parts: - items: - $ref: '#/components/schemas/Part' - type: array - xml: - wrapped: false - PartsCount: - type: integer - PartsList: - items: - $ref: '#/components/schemas/ObjectPart' - type: array - xml: - wrapped: false - Payer: - enum: - - Requester - - BucketOwner - type: string - Permission: - enum: - - FULL_CONTROL - - WRITE - - WRITE_ACP - - READ - - READ_ACP - type: string - Policy: - type: string - PolicyStatus: - description: The container element for a bucket's policy status. - properties: {} - type: object - Prefix: - type: string - Priority: - type: integer - Progress: - description: This data type contains information about progress of an operation. - properties: - BytesProcessed: - allOf: - - $ref: '#/components/schemas/BytesProcessed' - - description: The current number of uncompressed object bytes processed. - BytesReturned: - allOf: - - $ref: '#/components/schemas/BytesReturned' - - description: The current number of bytes of records payload data returned. - BytesScanned: - allOf: - - $ref: '#/components/schemas/BytesScanned' - - description: The current number of object bytes scanned. - type: object - ProgressEvent: - description: This data type contains information about the progress event of - an operation. - properties: - Details: - allOf: - - $ref: '#/components/schemas/Progress' - - description: The Progress event details. - type: object - Protocol: - enum: - - http - - https - type: string - PublicAccessBlockConfiguration: - description: 'The PublicAccessBlock configuration that you want to apply to - this Amazon S3 bucket. You can enable the configuration options in any combination. - For more information about when Amazon S3 considers a bucket or object public, - see The - Meaning of "Public" in the Amazon S3 User Guide. ' - properties: {} - type: object - PutBucketAccelerateConfigurationRequest: - properties: {} - required: - - Bucket - - AccelerateConfiguration - title: PutBucketAccelerateConfigurationRequest - type: object - PutBucketAclRequest: - properties: {} - required: - - Bucket - title: PutBucketAclRequest - type: object - PutBucketAnalyticsConfigurationRequest: - properties: {} - required: - - Bucket - - Id - - AnalyticsConfiguration - title: PutBucketAnalyticsConfigurationRequest - type: object - PutBucketCorsRequest: - properties: {} - required: - - Bucket - - CORSConfiguration - title: PutBucketCorsRequest - type: object - PutBucketEncryptionRequest: - properties: {} - required: - - Bucket - - ServerSideEncryptionConfiguration - title: PutBucketEncryptionRequest - type: object - PutBucketIntelligentTieringConfigurationRequest: - properties: {} - required: - - Bucket - - Id - - IntelligentTieringConfiguration - title: PutBucketIntelligentTieringConfigurationRequest - type: object - PutBucketInventoryConfigurationRequest: - properties: {} - required: - - Bucket - - Id - - InventoryConfiguration - title: PutBucketInventoryConfigurationRequest - type: object - PutBucketLifecycleConfigurationRequest: - properties: {} - required: - - Bucket - title: PutBucketLifecycleConfigurationRequest - type: object - PutBucketLifecycleRequest: - properties: {} - required: - - Bucket - title: PutBucketLifecycleRequest - type: object - PutBucketLoggingRequest: - properties: {} - required: - - Bucket - - BucketLoggingStatus - title: PutBucketLoggingRequest - type: object - PutBucketMetricsConfigurationRequest: - properties: {} - required: - - Bucket - - Id - - MetricsConfiguration - title: PutBucketMetricsConfigurationRequest - type: object - PutBucketNotificationConfigurationRequest: - properties: {} - required: - - Bucket - - NotificationConfiguration - title: PutBucketNotificationConfigurationRequest - type: object - PutBucketNotificationRequest: - properties: {} - required: - - Bucket - - NotificationConfiguration - title: PutBucketNotificationRequest - type: object - PutBucketOwnershipControlsRequest: - properties: {} - required: - - Bucket - - OwnershipControls - title: PutBucketOwnershipControlsRequest - type: object - PutBucketPolicyRequest: - properties: - Policy: - allOf: - - $ref: '#/components/schemas/Policy' - - description: The bucket policy as a JSON document. - required: - - Bucket - - Policy - title: PutBucketPolicyRequest - type: object - PutBucketReplicationRequest: - properties: {} - required: - - Bucket - - ReplicationConfiguration - title: PutBucketReplicationRequest - type: object - PutBucketRequestPaymentRequest: - properties: {} - required: - - Bucket - - RequestPaymentConfiguration - title: PutBucketRequestPaymentRequest - type: object - PutBucketTaggingRequest: - properties: {} - required: - - Bucket - - Tagging - title: PutBucketTaggingRequest - type: object - PutBucketVersioningRequest: - properties: {} - required: - - Bucket - - VersioningConfiguration - title: PutBucketVersioningRequest - type: object - PutBucketWebsiteRequest: - properties: {} - required: - - Bucket - - WebsiteConfiguration - title: PutBucketWebsiteRequest - type: object - PutObjectAclOutput: - example: {} - properties: {} - type: object - PutObjectAclRequest: - properties: {} - required: - - Bucket - - Key - title: PutObjectAclRequest - type: object - PutObjectLegalHoldOutput: - properties: {} - type: object - PutObjectLegalHoldRequest: - properties: {} - required: - - Bucket - - Key - title: PutObjectLegalHoldRequest - type: object - PutObjectLockConfigurationOutput: - properties: {} - type: object - PutObjectLockConfigurationRequest: - properties: {} - required: - - Bucket - title: PutObjectLockConfigurationRequest - type: object - PutObjectOutput: - example: - ETag: '"6805f2cfc46c0f04559748bb039d69ae"' - VersionId: Kirh.unyZwjQ69YxcQLA8z4F5j3kJJKr - properties: {} - type: object - PutObjectRequest: - properties: - Body: - allOf: - - $ref: '#/components/schemas/Body' - - description: Object data. - x-amz-meta-: - allOf: - - $ref: '#/components/schemas/Metadata' - - description: A map of metadata to store with the object in S3. - required: - - Bucket - - Key - title: PutObjectRequest - type: object - PutObjectRetentionOutput: - properties: {} - type: object - PutObjectRetentionRequest: - properties: {} - required: - - Bucket - - Key - title: PutObjectRetentionRequest - type: object - PutObjectTaggingOutput: - example: - VersionId: 'null' - properties: {} - type: object - PutObjectTaggingRequest: - properties: {} - required: - - Bucket - - Key - - Tagging - title: PutObjectTaggingRequest - type: object - PutPublicAccessBlockRequest: - properties: {} - required: - - Bucket - - PublicAccessBlockConfiguration - title: PutPublicAccessBlockRequest - type: object - QueueArn: - type: string - QueueConfiguration: - description: Specifies the configuration for publishing messages to an Amazon - Simple Queue Service (Amazon SQS) queue when Amazon S3 detects specified events. - properties: - Event: - allOf: - - $ref: '#/components/schemas/EventList' - - description: A collection of bucket events for which to send notifications - Filter: - $ref: '#/components/schemas/NotificationConfigurationFilter' - Id: - $ref: '#/components/schemas/NotificationId' - Queue: - allOf: - - $ref: '#/components/schemas/QueueArn' - - description: The Amazon Resource Name (ARN) of the Amazon SQS queue to - which Amazon S3 publishes a message when it detects events of the specified - type. - required: - - QueueArn - - Events - type: object - QueueConfigurationDeprecated: - description: 'This data type is deprecated. Use QueueConfiguration - for the same purposes. This data type specifies the configuration for publishing - messages to an Amazon Simple Queue Service (Amazon SQS) queue when Amazon - S3 detects specified events. ' - properties: - Event: - allOf: - - $ref: '#/components/schemas/EventList' - - description: A collection of bucket events for which to send notifications. - Id: - $ref: '#/components/schemas/NotificationId' - Queue: - allOf: - - $ref: '#/components/schemas/QueueArn' - - description: 'The Amazon Resource Name (ARN) of the Amazon SQS queue to - which Amazon S3 publishes a message when it detects events of the specified - type. ' - type: object - QueueConfigurationList: - items: - $ref: '#/components/schemas/QueueConfiguration' - type: array - xml: - wrapped: false - Quiet: - type: boolean - QuoteCharacter: - type: string - QuoteEscapeCharacter: - type: string - QuoteFields: - enum: - - ALWAYS - - ASNEEDED - type: string - Range: - type: string - RecordDelimiter: - type: string - RecordsEvent: - description: The container for the records event. - properties: - Payload: - allOf: - - $ref: '#/components/schemas/Body' - - description: The byte array of partial, one or more result records. - type: object - Redirect: - description: Specifies how requests are redirected. In the event of an error, - you can specify a different error code to return. - properties: - HostName: - allOf: - - $ref: '#/components/schemas/HostName' - - description: The host name to use in the redirect request. - HttpRedirectCode: - allOf: - - $ref: '#/components/schemas/HttpRedirectCode' - - description: The HTTP redirect code to use on the response. Not required - if one of the siblings is present. - Protocol: - allOf: - - $ref: '#/components/schemas/Protocol' - - description: Protocol to use when redirecting requests. The default is - the protocol that is used in the original request. - ReplaceKeyPrefixWith: - allOf: - - $ref: '#/components/schemas/ReplaceKeyPrefixWith' - - description:

The object key prefix to use in the redirect request. - For example, to redirect requests for all pages with prefix docs/ - (objects in the docs/ folder) to documents/, - you can set a condition block with KeyPrefixEquals set - to docs/ and in the Redirect set ReplaceKeyPrefixWith - to /documents. Not required if one of the siblings is present. - Can be present only if ReplaceKeyWith is not provided.

-

Replacement must be made for object keys containing special - characters (such as carriage returns) when using XML requests. For more - information, see - XML related object key constraints.

 - ReplaceKeyWith: - allOf: - - $ref: '#/components/schemas/ReplaceKeyWith' - - description:

The specific object key to use in the redirect request. - For example, redirect request to error.html. Not required - if one of the siblings is present. Can be present only if ReplaceKeyPrefixWith - is not provided.

Replacement must be made for object - keys containing special characters (such as carriage returns) when using - XML requests. For more information, see - XML related object key constraints.

 - type: object - RedirectAllRequestsTo: - description: Specifies the redirect behavior of all requests to a website endpoint - of an Amazon S3 bucket. - properties: - HostName: - allOf: - - $ref: '#/components/schemas/HostName' - - description: Name of the host where requests are redirected. - Protocol: - allOf: - - $ref: '#/components/schemas/Protocol' - - description: Protocol to use when redirecting requests. The default is - the protocol that is used in the original request. - required: - - HostName - type: object - ReplaceKeyPrefixWith: - type: string - ReplaceKeyWith: - type: string - ReplicaKmsKeyID: - type: string - ReplicaModifications: - description:

A filter that you can specify for selection for modifications - on replicas. Amazon S3 doesn't replicate replica modifications by default. - In the latest version of replication configuration (when Filter - is specified), you can specify this element and set the status to Enabled - to replicate modifications on replicas.

If you don't specify - the Filter element, Amazon S3 assumes that the replication configuration - is the earlier version, V1. In the earlier version, this element is not allowed.

- - properties: - Status: - allOf: - - $ref: '#/components/schemas/ReplicaModificationsStatus' - - description: Specifies whether Amazon S3 replicates modifications on replicas. - required: - - Status - type: object - ReplicaModificationsStatus: - enum: - - Enabled - - Disabled - type: string - ReplicationConfiguration: - description: A container for replication rules. You can add up to 1,000 rules. - The maximum size of a replication configuration is 2 MB. - properties: - Role: - allOf: - - $ref: '#/components/schemas/Role' - - description: The Amazon Resource Name (ARN) of the Identity and Access - Management (IAM) role that Amazon S3 assumes when replicating objects. - For more information, see How - to Set Up Replication in the Amazon S3 User Guide. - Rule: - allOf: - - $ref: '#/components/schemas/ReplicationRules' - - description: 'A container for one or more replication rules. A replication - configuration must have at least one rule and can contain a maximum - of 1,000 rules. ' - required: - - Role - - Rules - type: object - ReplicationRule: - description: Specifies which Amazon S3 objects to replicate and where to store - the replicas. - properties: - DeleteMarkerReplication: - $ref: '#/components/schemas/DeleteMarkerReplication' - Destination: - allOf: - - $ref: '#/components/schemas/Destination' - - description: A container for information about the replication destination - and its configurations including enabling the S3 Replication Time Control - (S3 RTC). - ExistingObjectReplication: - allOf: - - $ref: '#/components/schemas/ExistingObjectReplication' - - description:

- Filter: - $ref: '#/components/schemas/ReplicationRuleFilter' - ID: - allOf: - - $ref: '#/components/schemas/ID' - - description: A unique identifier for the rule. The maximum value is 255 - characters. - Prefix: - allOf: - - $ref: '#/components/schemas/Prefix' - - deprecated: true - description:

An object key name prefix that identifies the object or - objects to which the rule applies. The maximum prefix length is 1,024 - characters. To include all objects in a bucket, specify an empty string. -

Replacement must be made for object keys containing - special characters (such as carriage returns) when using XML requests. - For more information, see - XML related object key constraints.

 - Priority: - allOf: - - $ref: '#/components/schemas/Priority' - - description:

The priority indicates which rule has precedence whenever - two or more replication rules conflict. Amazon S3 will attempt to replicate - objects according to all replication rules. However, if there are two - or more rules with the same destination bucket, then objects will be - replicated according to the rule with the highest priority. The higher - the number, the higher the priority.

For more information, see - Replication - in the Amazon S3 User Guide.

- SourceSelectionCriteria: - allOf: - - $ref: '#/components/schemas/SourceSelectionCriteria' - - description: A container that describes additional filters for identifying - the source objects that you want to replicate. You can choose to enable - or disable the replication of these objects. Currently, Amazon S3 supports - only the filter that you can specify for objects created with server-side - encryption using a customer managed key stored in Amazon Web Services - Key Management Service (SSE-KMS). - Status: - allOf: - - $ref: '#/components/schemas/ReplicationRuleStatus' - - description: Specifies whether the rule is enabled. - required: - - Status - - Destination - type: object - ReplicationRuleAndOperator: - description:

A container for specifying rule filters. The filters determine - the subset of objects to which the rule applies. This element is required - only if you specify more than one filter.

For example:

  • -

    If you specify both a Prefix and a Tag filter, - wrap these filters in an And tag.

  • If you specify - a filter based on multiple tags, wrap the Tag elements in an - And tag.

- properties: - Prefix: - allOf: - - $ref: '#/components/schemas/Prefix' - - description: An object key name prefix that identifies the subset of objects - to which the rule applies. - Tag: - allOf: - - $ref: '#/components/schemas/TagSet' - - description: An array of tags containing key and value pairs. - type: object - xml: - wrapped: false - ReplicationRuleFilter: - description: A filter that identifies the subset of objects to which the replication - rule applies. A Filter must specify exactly one Prefix, - Tag, or an And child element. - properties: - And: - allOf: - - $ref: '#/components/schemas/ReplicationRuleAndOperator' - - description: '

A container for specifying rule filters. The filters - determine the subset of objects to which the rule applies. This element - is required only if you specify more than one filter. For example:

-

  • If you specify both a Prefix and a Tag - filter, wrap these filters in an And tag.

  • -

    If you specify a filter based on multiple tags, wrap the Tag - elements in an And tag.

' - Prefix: - allOf: - - $ref: '#/components/schemas/Prefix' - - description:

An object key name prefix that identifies the subset of - objects to which the rule applies.

Replacement must - be made for object keys containing special characters (such as carriage - returns) when using XML requests. For more information, see - XML related object key constraints.

 - Tag: - allOf: - - $ref: '#/components/schemas/Tag' - - description:

A container for specifying a tag key and value.

The - rule applies only to objects that have the tag in their tag set.

- type: object - ReplicationRuleStatus: - enum: - - Enabled - - Disabled - type: string - ReplicationRules: - items: - $ref: '#/components/schemas/ReplicationRule' - type: array - xml: - wrapped: false - ReplicationStatus: - enum: - - COMPLETE - - PENDING - - FAILED - - REPLICA - type: string - ReplicationTime: - description: ' A container specifying S3 Replication Time Control (S3 RTC) related - information, including whether S3 RTC is enabled and the time when all objects - and operations on objects must be replicated. Must be specified together with - a Metrics block. ' - properties: - Status: - allOf: - - $ref: '#/components/schemas/ReplicationTimeStatus' - - description: ' Specifies whether the replication time is enabled. ' - Time: - allOf: - - $ref: '#/components/schemas/ReplicationTimeValue' - - description: ' A container specifying the time by which replication should - be complete for all objects and operations on objects. ' - required: - - Status - - Time - type: object - ReplicationTimeStatus: - enum: - - Enabled - - Disabled - type: string - ReplicationTimeValue: - description: ' A container specifying the time value for S3 Replication Time - Control (S3 RTC) and replication metrics EventThreshold. ' - properties: - Minutes: - allOf: - - $ref: '#/components/schemas/Minutes' - - description: '

Contains an integer specifying time in minutes.

-

Valid value: 15

' - type: object - RequestCharged: - description: If present, indicates that the requester was successfully charged - for the request. - enum: - - requester - type: string - RequestPayer: - description: Confirms that the requester knows that they will be charged for - the request. Bucket owners need not specify this parameter in their requests. - For information about downloading objects from Requester Pays buckets, see - Downloading - Objects in Requester Pays Buckets in the Amazon S3 User Guide. - enum: - - requester - type: string - RequestPaymentConfiguration: - description: Container for Payer. - properties: - Payer: - allOf: - - $ref: '#/components/schemas/Payer' - - description: Specifies who pays for the download and request fees. - required: - - Payer - type: object - RequestProgress: - description: Container for specifying if periodic QueryProgress - messages should be sent. - properties: - Enabled: - allOf: - - $ref: '#/components/schemas/EnableRequestProgress' - - description: 'Specifies whether periodic QueryProgress frames should be - sent. Valid values: TRUE, FALSE. Default value: FALSE.' - type: object - RequestRoute: - type: string - RequestToken: - type: string - ResponseCacheControl: - type: string - ResponseContentDisposition: - type: string - ResponseContentEncoding: - type: string - ResponseContentLanguage: - type: string - ResponseContentType: - type: string - ResponseExpires: - format: date-time - type: string - Restore: - type: string - RestoreObjectOutput: - example: {} - properties: {} - type: object - RestoreObjectRequest: - properties: {} - required: - - Bucket - - Key - title: RestoreObjectRequest - type: object - RestoreOutputPath: - type: string - RestoreRequest: - description: Container for restore job parameters. - properties: - Days: - allOf: - - $ref: '#/components/schemas/Days' - - description:

Lifetime of the active copy in days. Do not use with restores - that specify OutputLocation.

The Days element is - required for regular restores, and must not be provided for select requests.

- Description: - allOf: - - $ref: '#/components/schemas/Description' - - description: The optional description for the job. - GlacierJobParameters: - allOf: - - $ref: '#/components/schemas/GlacierJobParameters' - - description: S3 Glacier related parameters pertaining to this job. Do - not use with restores that specify OutputLocation. - OutputLocation: - allOf: - - $ref: '#/components/schemas/OutputLocation' - - description: Describes the location where the restore job's output is - stored. - SelectParameters: - allOf: - - $ref: '#/components/schemas/SelectParameters' - - description: Describes the parameters for Select job types. - Tier: - allOf: - - $ref: '#/components/schemas/Tier' - - description: Retrieval tier at which the restore will be processed. - Type: - allOf: - - $ref: '#/components/schemas/RestoreRequestType' - - description: Type of restore request. - type: object - RestoreRequestType: - enum: - - SELECT - type: string - Role: - type: string - RoutingRule: - description: Specifies the redirect behavior and when a redirect is applied. - For more information about routing rules, see Configuring - advanced conditional redirects in the Amazon S3 User Guide. - properties: - Condition: - allOf: - - $ref: '#/components/schemas/Condition' - - description: A container for describing a condition that must be met for - the specified redirect to apply. For example, 1. If request is for pages - in the /docs folder, redirect to the /documents - folder. 2. If request results in HTTP error 4xx, redirect request to - another host where you might process the error. - Redirect: - allOf: - - $ref: '#/components/schemas/Redirect' - - description: Container for redirect information. You can redirect requests - to another host, to another page, or with another protocol. In the event - of an error, you can specify a different error code to return. - required: - - Redirect - type: object - RoutingRules: - items: - allOf: - - $ref: '#/components/schemas/RoutingRule' - - xml: - name: RoutingRule - type: array - Rule: - description: Specifies lifecycle rules for an Amazon S3 bucket. For more information, - see Put - Bucket Lifecycle Configuration in the Amazon S3 API Reference. - For examples, see Put - Bucket Lifecycle Configuration Examples. - properties: - AbortIncompleteMultipartUpload: - $ref: '#/components/schemas/AbortIncompleteMultipartUpload' - Expiration: - allOf: - - $ref: '#/components/schemas/LifecycleExpiration' - - description: Specifies the expiration for the lifecycle of the object. - ID: - allOf: - - $ref: '#/components/schemas/ID' - - description: Unique identifier for the rule. The value can't be longer - than 255 characters. - NoncurrentVersionExpiration: - $ref: '#/components/schemas/NoncurrentVersionExpiration' - NoncurrentVersionTransition: - $ref: '#/components/schemas/NoncurrentVersionTransition' - Prefix: - allOf: - - $ref: '#/components/schemas/Prefix' - - description:

Object key prefix that identifies one or more objects - to which this rule applies.

Replacement must be made - for object keys containing special characters (such as carriage returns) - when using XML requests. For more information, see - XML related object key constraints.

 - Status: - allOf: - - $ref: '#/components/schemas/ExpirationStatus' - - description: If Enabled, the rule is currently being applied. - If Disabled, the rule is not currently being applied. - Transition: - allOf: - - $ref: '#/components/schemas/Transition' - - description: Specifies when an object transitions to a specified storage - class. For more information about Amazon S3 lifecycle configuration - rules, see Transitioning - Objects Using Amazon S3 Lifecycle in the Amazon S3 User Guide. - required: - - Prefix - - Status - type: object - Rules: - items: - $ref: '#/components/schemas/Rule' - type: array - xml: - wrapped: false - S3KeyFilter: - description: A container for object key name prefix and suffix filtering rules. - properties: - FilterRule: - $ref: '#/components/schemas/FilterRuleList' - type: object - S3Location: - description: Describes an Amazon S3 location that will receive the results of - the restore request. - properties: - AccessControlList: - allOf: - - $ref: '#/components/schemas/Grants' - - description: A list of grants that control access to the staged results. - BucketName: - allOf: - - $ref: '#/components/schemas/BucketName' - - description: The name of the bucket where the restore results will be - placed. - CannedACL: - allOf: - - $ref: '#/components/schemas/ObjectCannedACL' - - description: The canned ACL to apply to the restore results. - Encryption: - $ref: '#/components/schemas/Encryption' - Prefix: - allOf: - - $ref: '#/components/schemas/LocationPrefix' - - description: The prefix that is prepended to the restore results for this - request. - StorageClass: - allOf: - - $ref: '#/components/schemas/StorageClass' - - description: The class of storage used to store the restore results. - Tagging: - allOf: - - $ref: '#/components/schemas/Tagging' - - description: The tag-set that is applied to the restore results. - UserMetadata: - allOf: - - $ref: '#/components/schemas/UserMetadata' - - description: A list of metadata to store with the restore results in S3. - required: - - BucketName - - Prefix - type: object - SSECustomerAlgorithm: - type: string - SSECustomerKey: - format: password - type: string - SSECustomerKeyMD5: - type: string - SSEKMS: - description: Specifies the use of SSE-KMS to encrypt delivered inventory reports. - properties: - KeyId: - allOf: - - $ref: '#/components/schemas/SSEKMSKeyId' - - description: Specifies the ID of the Amazon Web Services Key Management - Service (Amazon Web Services KMS) symmetric customer managed key to - use for encrypting inventory reports. - required: - - KeyId - type: object - SSEKMSEncryptionContext: - format: password - type: string - SSEKMSKeyId: - format: password - type: string - SSES3: - description: Specifies the use of SSE-S3 to encrypt delivered inventory reports. - properties: {} - type: object - ScanRange: - description: Specifies the byte range of the object to get the records from. - A record is processed when its first byte is contained by the range. This - parameter is optional, but when specified, it must not be empty. See RFC 2616, - Section 14.35.1 about how to specify the start and end of the range. - properties: - End: - allOf: - - $ref: '#/components/schemas/End' - - description: 'Specifies the end of the byte range. This parameter is optional. - Valid values: non-negative integers. The default value is one less than - the size of the object being queried. If only the End parameter is supplied, - it is interpreted to mean scan the last N bytes of the file. For example, - <scanrange><end>50</end></scanrange> - means scan the last 50 bytes.' - Start: - allOf: - - $ref: '#/components/schemas/Start' - - description: 'Specifies the start of the byte range. This parameter is - optional. Valid values: non-negative integers. The default value is - 0. If only start is supplied, it means scan from that point - to the end of the file. For example, <scanrange><start>50</start></scanrange> - means scan from byte 50 until the end of the file.' - type: object - SelectObjectContentEventStream: - description: The container for selecting objects from a content event stream. - properties: - Cont: - allOf: - - $ref: '#/components/schemas/ContinuationEvent' - - description: The Continuation Event. - End: - allOf: - - $ref: '#/components/schemas/EndEvent' - - description: The End Event. - Progress: - allOf: - - $ref: '#/components/schemas/ProgressEvent' - - description: The Progress Event. - Records: - allOf: - - $ref: '#/components/schemas/RecordsEvent' - - description: The Records Event. - Stats: - allOf: - - $ref: '#/components/schemas/StatsEvent' - - description: The Stats Event. - type: object - SelectObjectContentOutput: - properties: - Payload: - allOf: - - $ref: '#/components/schemas/SelectObjectContentEventStream' - - description: The array of results. - type: object - SelectObjectContentRequest: - description: Request to filter the contents of an Amazon S3 object based on - a simple Structured Query Language (SQL) statement. In the request, along - with the SQL expression, you must specify a data serialization format (JSON - or CSV) of the object. Amazon S3 uses this to parse object data into records. - It returns only records that match the specified SQL expression. You must - also specify the data serialization format for the response. For more information, - see S3Select - API Documentation. - properties: - Expression: - allOf: - - $ref: '#/components/schemas/Expression' - - description: The expression that is used to query the object. - ExpressionType: - allOf: - - $ref: '#/components/schemas/ExpressionType' - - description: The type of the provided expression (for example, SQL). - InputSerialization: - allOf: - - $ref: '#/components/schemas/InputSerialization' - - description: Describes the format of the data in the object that is being - queried. - OutputSerialization: - allOf: - - $ref: '#/components/schemas/OutputSerialization' - - description: Describes the format of the data that you want Amazon S3 - to return in response. - RequestProgress: - allOf: - - $ref: '#/components/schemas/RequestProgress' - - description: Specifies if periodic request progress information should - be enabled. - ScanRange: - allOf: - - $ref: '#/components/schemas/ScanRange' - - description:

Specifies the byte range of the object to get the records - from. A record is processed when its first byte is contained by the - range. This parameter is optional, but when specified, it must not be - empty. See RFC 2616, Section 14.35.1 about how to specify the start - and end of the range.

ScanRangemay be used in the - following ways:

  • <scanrange><start>50</start><end>100</end></scanrange> - - process only the records starting between the bytes 50 and 100 (inclusive, - counting from zero)

  • <scanrange><start>50</start></scanrange> - - process only the records starting after the byte 50

  • -

    <scanrange><end>50</end></scanrange> - - process only the records within the last 50 bytes of the file.

    -
- required: - - Bucket - - Key - - Expression - - ExpressionType - - InputSerialization - - OutputSerialization - title: SelectObjectContentRequest - type: object - SelectParameters: - description: Describes the parameters for Select job types. - properties: - Expression: - allOf: - - $ref: '#/components/schemas/Expression' - - description: The expression that is used to query the object. - ExpressionType: - allOf: - - $ref: '#/components/schemas/ExpressionType' - - description: The type of the provided expression (for example, SQL). - InputSerialization: - allOf: - - $ref: '#/components/schemas/InputSerialization' - - description: Describes the serialization format of the object. - OutputSerialization: - allOf: - - $ref: '#/components/schemas/OutputSerialization' - - description: Describes how the results of the Select job are serialized. - required: - - InputSerialization - - ExpressionType - - Expression - - OutputSerialization - type: object - ServerSideEncryption: - enum: - - AES256 - - aws:kms - type: string - ServerSideEncryptionByDefault: - description: Describes the default server-side encryption to apply to new objects - in the bucket. If a PUT Object request doesn't specify any server-side encryption, - this default encryption will be applied. If you don't specify a customer managed - key at configuration, Amazon S3 automatically creates an Amazon Web Services - KMS key in your Amazon Web Services account the first time that you add an - object encrypted with SSE-KMS to a bucket. By default, Amazon S3 uses this - KMS key for SSE-KMS. For more information, see PUT - Bucket encryption in the Amazon S3 API Reference. - properties: - KMSMasterKeyID: - allOf: - - $ref: '#/components/schemas/SSEKMSKeyId' - - description: '

Amazon Web Services Key Management Service (KMS) customer - Amazon Web Services KMS key ID to use for the default encryption. This - parameter is allowed if and only if SSEAlgorithm is set - to aws:kms.

You can specify the key ID or the Amazon - Resource Name (ARN) of the KMS key. However, if you are using encryption - with cross-account or Amazon Web Services service operations you must - use a fully qualified KMS key ARN. For more information, see Using - encryption for cross-account operations.

For example: -

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab -

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab -

Amazon S3 only supports symmetric KMS - keys and not asymmetric KMS keys. For more information, see Using - symmetric and asymmetric keys in the Amazon Web Services Key - Management Service Developer Guide.

' - SSEAlgorithm: - allOf: - - $ref: '#/components/schemas/ServerSideEncryption' - - description: Server-side encryption algorithm to use for the default encryption. - required: - - SSEAlgorithm - type: object - ServerSideEncryptionConfiguration: - description: Specifies the default server-side-encryption configuration. - properties: - Rule: - allOf: - - $ref: '#/components/schemas/ServerSideEncryptionRules' - - description: Container for information about a particular server-side - encryption configuration rule. - required: - - Rules - type: object - ServerSideEncryptionRule: - description: Specifies the default server-side encryption configuration. - properties: - ApplyServerSideEncryptionByDefault: - allOf: - - $ref: '#/components/schemas/ServerSideEncryptionByDefault' - - description: Specifies the default server-side encryption to apply to - new objects in the bucket. If a PUT Object request doesn't specify any - server-side encryption, this default encryption will be applied. - BucketKeyEnabled: - allOf: - - $ref: '#/components/schemas/BucketKeyEnabled' - - description:

Specifies whether Amazon S3 should use an S3 Bucket Key - with server-side encryption using KMS (SSE-KMS) for new objects in the - bucket. Existing objects are not affected. Setting the BucketKeyEnabled - element to true causes Amazon S3 to use an S3 Bucket Key. - By default, S3 Bucket Key is not enabled.

For more information, - see Amazon - S3 Bucket Keys in the Amazon S3 User Guide.

- type: object - ServerSideEncryptionRules: - items: - $ref: '#/components/schemas/ServerSideEncryptionRule' - type: array - xml: - wrapped: false - Setting: - type: boolean - Size: - type: integer - SkipValidation: - type: boolean - SourceSelectionCriteria: - description: A container that describes additional filters for identifying the - source objects that you want to replicate. You can choose to enable or disable - the replication of these objects. Currently, Amazon S3 supports only the filter - that you can specify for objects created with server-side encryption using - a customer managed key stored in Amazon Web Services Key Management Service - (SSE-KMS). - properties: - ReplicaModifications: - allOf: - - $ref: '#/components/schemas/ReplicaModifications' - - description:

A filter that you can specify for selections for modifications - on replicas. Amazon S3 doesn't replicate replica modifications by default. - In the latest version of replication configuration (when Filter - is specified), you can specify this element and set the status to Enabled - to replicate modifications on replicas.

If you don't - specify the Filter element, Amazon S3 assumes that the - replication configuration is the earlier version, V1. In the earlier - version, this element is not allowed

 - SseKmsEncryptedObjects: - allOf: - - $ref: '#/components/schemas/SseKmsEncryptedObjects' - - description: ' A container for filter information for the selection of - Amazon S3 objects encrypted with Amazon Web Services KMS. If you include - SourceSelectionCriteria in the replication configuration, - this element is required. ' - type: object - SseKmsEncryptedObjects: - description: A container for filter information for the selection of S3 objects - encrypted with Amazon Web Services KMS. - properties: - Status: - allOf: - - $ref: '#/components/schemas/SseKmsEncryptedObjectsStatus' - - description: Specifies whether Amazon S3 replicates objects created with - server-side encryption using an Amazon Web Services KMS key stored in - Amazon Web Services Key Management Service. - required: - - Status - type: object - SseKmsEncryptedObjectsStatus: - enum: - - Enabled - - Disabled - type: string - Start: - type: integer - StartAfter: - type: string - Stats: - description: Container for the stats details. - properties: - BytesProcessed: - allOf: - - $ref: '#/components/schemas/BytesProcessed' - - description: The total number of uncompressed object bytes processed. - BytesReturned: - allOf: - - $ref: '#/components/schemas/BytesReturned' - - description: The total number of bytes of records payload data returned. - BytesScanned: - allOf: - - $ref: '#/components/schemas/BytesScanned' - - description: The total number of object bytes scanned. - type: object - StatsEvent: - description: Container for the Stats Event. - properties: - Details: - allOf: - - $ref: '#/components/schemas/Stats' - - description: The Stats event details. - type: object - StorageClass: - enum: - - STANDARD - - REDUCED_REDUNDANCY - - STANDARD_IA - - ONEZONE_IA - - INTELLIGENT_TIERING - - GLACIER - - DEEP_ARCHIVE - - OUTPOSTS - - GLACIER_IR - type: string - StorageClassAnalysis: - description: Specifies data related to access patterns to be collected and made - available to analyze the tradeoffs between different storage classes for an - Amazon S3 bucket. - properties: - DataExport: - allOf: - - $ref: '#/components/schemas/StorageClassAnalysisDataExport' - - description: Specifies how data related to the storage class analysis - for an Amazon S3 bucket should be exported. - type: object - StorageClassAnalysisDataExport: - description: Container for data related to the storage class analysis for an - Amazon S3 bucket for export. - properties: - Destination: - allOf: - - $ref: '#/components/schemas/AnalyticsExportDestination' - - description: The place to store the data for an analysis. - OutputSchemaVersion: - allOf: - - $ref: '#/components/schemas/StorageClassAnalysisSchemaVersion' - - description: The version of the output schema to use when exporting data. - Must be V_1. - required: - - OutputSchemaVersion - - Destination - type: object - StorageClassAnalysisSchemaVersion: - enum: - - V_1 - type: string - Suffix: - type: string - Tag: - description: A container of a key value name pair. - properties: - Key: - allOf: - - $ref: '#/components/schemas/ObjectKey' - - description: Name of the object key. - Value: - allOf: - - $ref: '#/components/schemas/Value' - - description: Value of the tag. - required: - - Key - - Value - type: object - TagCount: - type: integer - TagSet: - items: - allOf: - - $ref: '#/components/schemas/Tag' - - xml: - name: Tag - type: array - Tagging: - description: Container for TagSet elements. - properties: - TagSet: - allOf: - - $ref: '#/components/schemas/TagSet' - - description: A collection for a set of tags - required: - - TagSet - type: object - TaggingDirective: - enum: - - COPY - - REPLACE - type: string - TaggingHeader: - type: string - TargetBucket: - type: string - TargetGrant: - description:

Container for granting information.

Buckets that use - the bucket owner enforced setting for Object Ownership don't support target - grants. For more information, see Permissions - server access log delivery in the Amazon S3 User Guide.

- properties: - Grantee: - allOf: - - $ref: '#/components/schemas/Grantee' - - description: Container for the person being granted permissions. - Permission: - allOf: - - $ref: '#/components/schemas/BucketLogsPermission' - - description: Logging permissions assigned to the grantee for the bucket. - type: object - TargetGrants: - items: - allOf: - - $ref: '#/components/schemas/TargetGrant' - - xml: - name: Grant - type: array - TargetPrefix: - type: string - Tier: - enum: - - Standard - - Bulk - - Expedited - type: string - Tiering: - description: The S3 Intelligent-Tiering storage class is designed to optimize - storage costs by automatically moving data to the most cost-effective storage - access tier, without additional operational overhead. - properties: - AccessTier: - allOf: - - $ref: '#/components/schemas/IntelligentTieringAccessTier' - - description: S3 Intelligent-Tiering access tier. See Storage - class for automatically optimizing frequently and infrequently accessed - objects for a list of access tiers in the S3 Intelligent-Tiering - storage class. - Days: - allOf: - - $ref: '#/components/schemas/IntelligentTieringDays' - - description: The number of consecutive days of no access after which an - object will be eligible to be transitioned to the corresponding tier. - The minimum number of days specified for Archive Access tier must be - at least 90 days and Deep Archive Access tier must be at least 180 days. - The maximum can be up to 2 years (730 days). - required: - - Days - - AccessTier - type: object - TieringList: - items: - $ref: '#/components/schemas/Tiering' - type: array - xml: - wrapped: false - Token: - type: string - TopicArn: - type: string - TopicConfiguration: - description: A container for specifying the configuration for publication of - messages to an Amazon Simple Notification Service (Amazon SNS) topic when - Amazon S3 detects specified events. - properties: - Event: - allOf: - - $ref: '#/components/schemas/EventList' - - description: The Amazon S3 bucket event about which to send notifications. - For more information, see Supported - Event Types in the Amazon S3 User Guide. - Filter: - $ref: '#/components/schemas/NotificationConfigurationFilter' - Id: - $ref: '#/components/schemas/NotificationId' - Topic: - allOf: - - $ref: '#/components/schemas/TopicArn' - - description: The Amazon Resource Name (ARN) of the Amazon SNS topic to - which Amazon S3 publishes a message when it detects events of the specified - type. - required: - - TopicArn - - Events - type: object - TopicConfigurationDeprecated: - description: A container for specifying the configuration for publication of - messages to an Amazon Simple Notification Service (Amazon SNS) topic when - Amazon S3 detects specified events. This data type is deprecated. Use TopicConfiguration - instead. - properties: - Event: - allOf: - - $ref: '#/components/schemas/EventList' - - description: A collection of events related to objects - Id: - $ref: '#/components/schemas/NotificationId' - Topic: - allOf: - - $ref: '#/components/schemas/TopicArn' - - description: Amazon SNS topic to which Amazon S3 will publish a message - to report the specified events for the bucket. - type: object - TopicConfigurationList: - items: - $ref: '#/components/schemas/TopicConfiguration' - type: array - xml: - wrapped: false - Transition: - description: Specifies when an object transitions to a specified storage class. - For more information about Amazon S3 lifecycle configuration rules, see Transitioning - Objects Using Amazon S3 Lifecycle in the Amazon S3 User Guide. - properties: - Date: - allOf: - - $ref: '#/components/schemas/Date' - - description: Indicates when objects are transitioned to the specified - storage class. The date value must be in ISO 8601 format. The time is - always midnight UTC. - Days: - allOf: - - $ref: '#/components/schemas/Days' - - description: Indicates the number of days after creation when objects - are transitioned to the specified storage class. The value must be a - positive integer. - StorageClass: - allOf: - - $ref: '#/components/schemas/TransitionStorageClass' - - description: The storage class to which you want the object to transition. - type: object - TransitionList: - items: - $ref: '#/components/schemas/Transition' - type: array - xml: - wrapped: false - TransitionStorageClass: - enum: - - GLACIER - - STANDARD_IA - - ONEZONE_IA - - INTELLIGENT_TIERING - - DEEP_ARCHIVE - - GLACIER_IR - type: string - Type: - enum: - - CanonicalUser - - AmazonCustomerByEmail - - Group - type: string - URI: - type: string - UploadIdMarker: - type: string - UploadPartCopyOutput: - example: - CopyPartResult: - ETag: '"65d16d19e65a7508a51f043180edcc36"' - LastModified: '2016-12-29T21:44:28.000Z' - properties: - CopyPartResult: - allOf: - - $ref: '#/components/schemas/CopyPartResult' - - description: Container for all response elements. - type: object - UploadPartCopyRequest: - properties: {} - required: - - Bucket - - CopySource - - Key - - PartNumber - - UploadId - title: UploadPartCopyRequest - type: object - UploadPartOutput: - example: - ETag: '"d8c2eafd90c266e19ab9dcacc479f8af"' - properties: {} - type: object - UploadPartRequest: - properties: - Body: - allOf: - - $ref: '#/components/schemas/Body' - - description: Object data. - required: - - Bucket - - Key - - PartNumber - - UploadId - title: UploadPartRequest - type: object - UserMetadata: - items: - allOf: - - $ref: '#/components/schemas/MetadataEntry' - - xml: - name: MetadataEntry - type: array - Value: - type: string - VersionCount: - type: integer - VersionIdMarker: - type: string - VersioningConfiguration: - description: Describes the versioning state of an Amazon S3 bucket. For more - information, see PUT - Bucket versioning in the Amazon S3 API Reference. - properties: - MfaDelete: - allOf: - - $ref: '#/components/schemas/MFADelete' - - description: Specifies whether MFA delete is enabled in the bucket versioning - configuration. This element is only returned if the bucket has been - configured with MFA delete. If the bucket has never been so configured, - this element is not returned. - Status: - allOf: - - $ref: '#/components/schemas/BucketVersioningStatus' - - description: The versioning state of the bucket. - type: object - WebsiteConfiguration: - description: Specifies website configuration parameters for an Amazon S3 bucket. - properties: - ErrorDocument: - allOf: - - $ref: '#/components/schemas/ErrorDocument' - - description: The name of the error document for the website. - IndexDocument: - allOf: - - $ref: '#/components/schemas/IndexDocument' - - description: The name of the index document for the website. - RedirectAllRequestsTo: - allOf: - - $ref: '#/components/schemas/RedirectAllRequestsTo' - - description:

The redirect behavior for every request to this bucket's - website endpoint.

If you specify this property, you - can't specify any other property.

 - RoutingRules: - allOf: - - $ref: '#/components/schemas/RoutingRules' - - description: Rules that define when a redirect is applied and the redirect - behavior. - type: object - WebsiteRedirectLocation: - type: string - WriteGetObjectResponseRequest: - properties: - Body: - allOf: - - $ref: '#/components/schemas/Body' - - description: The object data. - x-amz-meta-: - allOf: - - $ref: '#/components/schemas/Metadata' - - description: A map of metadata to store with the object in S3. - required: - - RequestRoute - - RequestToken - title: WriteGetObjectResponseRequest - type: object - Years: - type: integer - securitySchemes: - hmac: - description: Amazon S3 signature - in: header - name: Authorization - type: apiKey - x-amazon-apigateway-authtype: awsS3 - x-stackQL-resources: - bucket_accelerate_configurations: - id: aws.s3_api.bucket_accelerate_configurations - methods: - bucket_accelerate_configurations_Get: - operation: - $ref: '#/paths/~1?accelerate/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - bucket_accelerate_configurations_Put: - operation: - $ref: '#/paths/~1?accelerate/put' - response: - mediaType: text/xml - openAPIDocKey: '200' - name: bucket_accelerate_configurations - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/bucket_accelerate_configurations/methods/bucket_accelerate_configurations_Get' - update: [] - title: bucket_accelerate_configurations - bucket_acls: - id: aws.s3_api.bucket_acls - methods: - bucket_acls_Get: - operation: - $ref: '#/paths/~1?acl/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - bucket_acls_Put: - operation: - $ref: '#/paths/~1?acl/put' - response: - mediaType: text/xml - openAPIDocKey: '200' - name: bucket_acls - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/bucket_acls/methods/bucket_acls_Get' - update: [] - title: bucket_acls - bucket_analytics_configurations: - id: aws.s3_api.bucket_analytics_configurations - methods: - bucket_analytics_configurations_Delete: - operation: - $ref: '#/paths/~1?analytics#id/delete' - response: - mediaType: text/xml - openAPIDocKey: '200' - bucket_analytics_configurations_Get: - operation: - $ref: '#/paths/~1?analytics#id/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - bucket_analytics_configurations_List: - operation: - $ref: '#/paths/~1?analytics/get' - response: - mediaType: text/xml - objectKey: /*/AnalyticsConfiguration/member - openAPIDocKey: '200' - bucket_analytics_configurations_Put: - operation: - $ref: '#/paths/~1?analytics#id/put' - response: - mediaType: text/xml - openAPIDocKey: '200' - name: bucket_analytics_configurations - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/bucket_analytics_configurations/methods/bucket_analytics_configurations_Delete' - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/bucket_analytics_configurations/methods/bucket_analytics_configurations_Get' - - $ref: '#/components/x-stackQL-resources/bucket_analytics_configurations/methods/bucket_analytics_configurations_List' - update: [] - title: bucket_analytics_configurations - bucket_cors: - id: aws.s3_api.bucket_cors - methods: - bucket_cors_Delete: - operation: - $ref: '#/paths/~1?cors/delete' - response: - mediaType: text/xml - openAPIDocKey: '200' - bucket_cors_Get: - operation: - $ref: '#/paths/~1?cors/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - bucket_cors_Put: - operation: - $ref: '#/paths/~1?cors/put' - response: - mediaType: text/xml - openAPIDocKey: '200' - name: bucket_cors - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/bucket_cors/methods/bucket_cors_Delete' - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/bucket_cors/methods/bucket_cors_Get' - update: [] - title: bucket_cors - bucket_encryptions: - id: aws.s3_api.bucket_encryptions - methods: - bucket_encryptions_Delete: - operation: - $ref: '#/paths/~1?encryption/delete' - response: - mediaType: text/xml - openAPIDocKey: '200' - bucket_encryptions_Get: - operation: - $ref: '#/paths/~1?encryption/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - bucket_encryptions_Put: - operation: - $ref: '#/paths/~1?encryption/put' - response: - mediaType: text/xml - openAPIDocKey: '200' - name: bucket_encryptions - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/bucket_encryptions/methods/bucket_encryptions_Delete' - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/bucket_encryptions/methods/bucket_encryptions_Get' - update: [] - title: bucket_encryptions - bucket_intelligent_tiering_configurations: - id: aws.s3_api.bucket_intelligent_tiering_configurations - methods: - bucket_intelligent_tiering_configurations_Delete: - operation: - $ref: '#/paths/~1?intelligent-tiering#id/delete' - response: - mediaType: text/xml - openAPIDocKey: '200' - bucket_intelligent_tiering_configurations_Get: - operation: - $ref: '#/paths/~1?intelligent-tiering#id/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - bucket_intelligent_tiering_configurations_List: - operation: - $ref: '#/paths/~1?intelligent-tiering/get' - response: - mediaType: text/xml - objectKey: /*/IntelligentTieringConfiguration/member - openAPIDocKey: '200' - bucket_intelligent_tiering_configurations_Put: - operation: - $ref: '#/paths/~1?intelligent-tiering#id/put' - response: - mediaType: text/xml - openAPIDocKey: '200' - name: bucket_intelligent_tiering_configurations - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/bucket_intelligent_tiering_configurations/methods/bucket_intelligent_tiering_configurations_Delete' - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/bucket_intelligent_tiering_configurations/methods/bucket_intelligent_tiering_configurations_Get' - - $ref: '#/components/x-stackQL-resources/bucket_intelligent_tiering_configurations/methods/bucket_intelligent_tiering_configurations_List' - update: [] - title: bucket_intelligent_tiering_configurations - bucket_inventory_configurations: - id: aws.s3_api.bucket_inventory_configurations - methods: - bucket_inventory_configurations_Delete: - operation: - $ref: '#/paths/~1?inventory#id/delete' - response: - mediaType: text/xml - openAPIDocKey: '200' - bucket_inventory_configurations_Get: - operation: - $ref: '#/paths/~1?inventory#id/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - bucket_inventory_configurations_List: - operation: - $ref: '#/paths/~1?inventory/get' - response: - mediaType: text/xml - objectKey: /*/InventoryConfiguration/member - openAPIDocKey: '200' - bucket_inventory_configurations_Put: - operation: - $ref: '#/paths/~1?inventory#id/put' - response: - mediaType: text/xml - openAPIDocKey: '200' - name: bucket_inventory_configurations - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/bucket_inventory_configurations/methods/bucket_inventory_configurations_Delete' - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/bucket_inventory_configurations/methods/bucket_inventory_configurations_Get' - - $ref: '#/components/x-stackQL-resources/bucket_inventory_configurations/methods/bucket_inventory_configurations_List' - update: [] - title: bucket_inventory_configurations - bucket_lifecycle_configurations: - id: aws.s3_api.bucket_lifecycle_configurations - methods: - bucket_lifecycle_configurations_Get: - operation: - $ref: '#/paths/~1?lifecycle/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - bucket_lifecycle_configurations_Put: - operation: - $ref: '#/paths/~1?lifecycle/put' - response: - mediaType: text/xml - openAPIDocKey: '200' - name: bucket_lifecycle_configurations - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/bucket_lifecycle_configurations/methods/bucket_lifecycle_configurations_Get' - update: [] - title: bucket_lifecycle_configurations - bucket_lifecycles: - id: aws.s3_api.bucket_lifecycles - methods: - bucket_lifecycles_Delete: - operation: - $ref: '#/paths/~1?lifecycle/delete' - response: - mediaType: text/xml - openAPIDocKey: '200' - bucket_lifecycles_Get: - operation: - $ref: '#/paths/~1?lifecycle#deprecated!/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - bucket_lifecycles_Put: - operation: - $ref: '#/paths/~1?lifecycle#deprecated!/put' - response: - mediaType: text/xml - openAPIDocKey: '200' - name: bucket_lifecycles - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/bucket_lifecycles/methods/bucket_lifecycles_Delete' - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/bucket_lifecycles/methods/bucket_lifecycles_Get' - update: [] - title: bucket_lifecycles - bucket_locations: - id: aws.s3_api.bucket_locations - methods: - bucket_locations_Get: - operation: - $ref: '#/paths/~1?location/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - name: bucket_locations - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/bucket_locations/methods/bucket_locations_Get' - update: [] - title: bucket_locations - bucket_loggings: - id: aws.s3_api.bucket_loggings - methods: - bucket_loggings_Get: - operation: - $ref: '#/paths/~1?logging/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - bucket_loggings_Put: - operation: - $ref: '#/paths/~1?logging/put' - response: - mediaType: text/xml - openAPIDocKey: '200' - name: bucket_loggings - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/bucket_loggings/methods/bucket_loggings_Get' - update: [] - title: bucket_loggings - bucket_metrics_configurations: - id: aws.s3_api.bucket_metrics_configurations - methods: - bucket_metrics_configurations_Delete: - operation: - $ref: '#/paths/~1?metrics#id/delete' - response: - mediaType: text/xml - openAPIDocKey: '200' - bucket_metrics_configurations_Get: - operation: - $ref: '#/paths/~1?metrics#id/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - bucket_metrics_configurations_List: - operation: - $ref: '#/paths/~1?metrics/get' - response: - mediaType: text/xml - objectKey: /*/MetricsConfiguration/member - openAPIDocKey: '200' - bucket_metrics_configurations_Put: - operation: - $ref: '#/paths/~1?metrics#id/put' - response: - mediaType: text/xml - openAPIDocKey: '200' - name: bucket_metrics_configurations - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/bucket_metrics_configurations/methods/bucket_metrics_configurations_Delete' - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/bucket_metrics_configurations/methods/bucket_metrics_configurations_Get' - - $ref: '#/components/x-stackQL-resources/bucket_metrics_configurations/methods/bucket_metrics_configurations_List' - update: [] - title: bucket_metrics_configurations - bucket_notification_configurations: - id: aws.s3_api.bucket_notification_configurations - methods: - bucket_notification_configurations_Get: - operation: - $ref: '#/paths/~1?notification/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - bucket_notification_configurations_Put: - operation: - $ref: '#/paths/~1?notification/put' - response: - mediaType: text/xml - openAPIDocKey: '200' - name: bucket_notification_configurations - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/bucket_notification_configurations/methods/bucket_notification_configurations_Get' - update: [] - title: bucket_notification_configurations - bucket_notifications: - id: aws.s3_api.bucket_notifications - methods: - bucket_notifications_Get: - operation: - $ref: '#/paths/~1?notification#deprecated!/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - bucket_notifications_Put: - operation: - $ref: '#/paths/~1?notification#deprecated!/put' - response: - mediaType: text/xml - openAPIDocKey: '200' - name: bucket_notifications - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/bucket_notifications/methods/bucket_notifications_Get' - update: [] - title: bucket_notifications - bucket_ownership_controls: - id: aws.s3_api.bucket_ownership_controls - methods: - bucket_ownership_controls_Delete: - operation: - $ref: '#/paths/~1?ownershipControls/delete' - response: - mediaType: text/xml - openAPIDocKey: '200' - bucket_ownership_controls_Get: - operation: - $ref: '#/paths/~1?ownershipControls/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - bucket_ownership_controls_Put: - operation: - $ref: '#/paths/~1?ownershipControls/put' - response: - mediaType: text/xml - openAPIDocKey: '200' - name: bucket_ownership_controls - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/bucket_ownership_controls/methods/bucket_ownership_controls_Delete' - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/bucket_ownership_controls/methods/bucket_ownership_controls_Get' - update: [] - title: bucket_ownership_controls - bucket_policies: - id: aws.s3_api.bucket_policies - methods: - bucket_policies_Delete: - operation: - $ref: '#/paths/~1?policy/delete' - response: - mediaType: text/xml - openAPIDocKey: '200' - bucket_policies_Get: - operation: - $ref: '#/paths/~1?policy/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - bucket_policies_Put: - operation: - $ref: '#/paths/~1?policy/put' - response: - mediaType: text/xml - openAPIDocKey: '200' - name: bucket_policies - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/bucket_policies/methods/bucket_policies_Delete' - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/bucket_policies/methods/bucket_policies_Get' - update: [] - title: bucket_policies - bucket_policy_status: - id: aws.s3_api.bucket_policy_status - methods: - bucket_policy_status_Get: - operation: - $ref: '#/paths/~1?policyStatus/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - name: bucket_policy_status - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/bucket_policy_status/methods/bucket_policy_status_Get' - update: [] - title: bucket_policy_status - bucket_replications: - id: aws.s3_api.bucket_replications - methods: - bucket_replications_Delete: - operation: - $ref: '#/paths/~1?replication/delete' - response: - mediaType: text/xml - openAPIDocKey: '200' - bucket_replications_Get: - operation: - $ref: '#/paths/~1?replication/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - bucket_replications_Put: - operation: - $ref: '#/paths/~1?replication/put' - response: - mediaType: text/xml - openAPIDocKey: '200' - name: bucket_replications - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/bucket_replications/methods/bucket_replications_Delete' - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/bucket_replications/methods/bucket_replications_Get' - update: [] - title: bucket_replications - bucket_request_payments: - id: aws.s3_api.bucket_request_payments - methods: - bucket_request_payments_Get: - operation: - $ref: '#/paths/~1?requestPayment/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - bucket_request_payments_Put: - operation: - $ref: '#/paths/~1?requestPayment/put' - response: - mediaType: text/xml - openAPIDocKey: '200' - name: bucket_request_payments - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/bucket_request_payments/methods/bucket_request_payments_Get' - update: [] - title: bucket_request_payments - bucket_taggings: - id: aws.s3_api.bucket_taggings - methods: - bucket_taggings_Delete: - operation: - $ref: '#/paths/~1?tagging/delete' - response: - mediaType: text/xml - openAPIDocKey: '200' - bucket_taggings_Get: - operation: - $ref: '#/paths/~1?tagging/get' - response: - mediaType: text/xml - objectKey: /*/TagSet/Tag - openAPIDocKey: '200' - bucket_taggings_Put: - operation: - $ref: '#/paths/~1?tagging/put' - response: - mediaType: text/xml - openAPIDocKey: '200' - name: bucket_taggings - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/bucket_taggings/methods/bucket_taggings_Delete' - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/bucket_taggings/methods/bucket_taggings_Get' - update: [] - title: bucket_taggings - bucket_versionings: - id: aws.s3_api.bucket_versionings - methods: - bucket_versionings_Get: - operation: - $ref: '#/paths/~1?versioning/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - bucket_versionings_Put: - operation: - $ref: '#/paths/~1?versioning/put' - response: - mediaType: text/xml - openAPIDocKey: '200' - name: bucket_versionings - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/bucket_versionings/methods/bucket_versionings_Get' - update: [] - title: bucket_versionings - bucket_websites: - id: aws.s3_api.bucket_websites - methods: - bucket_websites_Delete: - operation: - $ref: '#/paths/~1?website/delete' - response: - mediaType: text/xml - openAPIDocKey: '200' - bucket_websites_Get: - operation: - $ref: '#/paths/~1?website/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - bucket_websites_Put: - operation: - $ref: '#/paths/~1?website/put' - response: - mediaType: text/xml - openAPIDocKey: '200' - name: bucket_websites - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/bucket_websites/methods/bucket_websites_Delete' - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/bucket_websites/methods/bucket_websites_Get' - update: [] - title: bucket_websites - buckets: - id: aws.s3_api.buckets - methods: - buckets_Create: - operation: - $ref: '#/paths/~1/put' - response: - mediaType: text/xml - openAPIDocKey: '200' - buckets_Delete: - operation: - $ref: '#/paths/~1/delete' - response: - mediaType: text/xml - openAPIDocKey: '200' - buckets_List: - operation: - $ref: '#/paths/~1/get' - response: - mediaType: text/xml - objectKey: /*/Buckets/Bucket - openAPIDocKey: '200' - name: buckets - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/buckets/methods/buckets_Delete' - insert: - - $ref: '#/components/x-stackQL-resources/buckets/methods/buckets_Create' - select: - - $ref: '#/components/x-stackQL-resources/buckets/methods/buckets_List' - update: [] - title: buckets - get_object_responses: - id: aws.s3_api.get_object_responses - methods: - get_object_responses_Write: - operation: - $ref: '#/paths/~1WriteGetObjectResponse#x-amz-request-route&x-amz-request-token/post' - name: get_object_responses - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: get_object_responses - multipart_uploads: - id: aws.s3_api.multipart_uploads - methods: - multipart_uploads_Complete: - operation: - $ref: '#/paths/~1{Key}#uploadId/post' - response: - mediaType: text/xml - openAPIDocKey: '200' - multipart_uploads_Create: - operation: - $ref: '#/paths/~1{Key}?uploads/post' - multipart_uploads_List: - operation: - $ref: '#/paths/~1?uploads/get' - response: - mediaType: text/xml - objectKey: /*/CommonPrefixes/member - openAPIDocKey: '200' - name: multipart_uploads - sqlVerbs: - delete: [] - insert: - - $ref: '#/components/x-stackQL-resources/multipart_uploads/methods/multipart_uploads_Create' - select: [] - # - $ref: '#/components/x-stackQL-resources/multipart_uploads/methods/multipart_uploads_List' - update: [] - title: multipart_uploads - object_acls: - id: aws.s3_api.object_acls - methods: - object_acls_Get: - operation: - $ref: '#/paths/~1{Key}?acl/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - object_acls_Put: - operation: - $ref: '#/paths/~1{Key}?acl/put' - response: - mediaType: text/xml - openAPIDocKey: '200' - name: object_acls - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/object_acls/methods/object_acls_Get' - update: [] - title: object_acls - object_attributes: - id: aws.s3_api.object_attributes - methods: - object_attributes_Get: - operation: - $ref: '#/paths/~1{Key}?attributes#x-amz-object-attributes/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - name: object_attributes - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/object_attributes/methods/object_attributes_Get' - update: [] - title: object_attributes - object_contents: - id: aws.s3_api.object_contents - methods: - object_contents_Select: - operation: - $ref: '#/paths/~1{Key}?select&select-type=2/post' - name: object_contents - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: object_contents - object_legal_holds: - id: aws.s3_api.object_legal_holds - methods: - object_legal_holds_Get: - operation: - $ref: '#/paths/~1{Key}?legal-hold/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - object_legal_holds_Put: - operation: - $ref: '#/paths/~1{Key}?legal-hold/put' - response: - mediaType: text/xml - openAPIDocKey: '200' - name: object_legal_holds - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/object_legal_holds/methods/object_legal_holds_Get' - update: [] - title: object_legal_holds - object_lock_configurations: - id: aws.s3_api.object_lock_configurations - methods: - object_lock_configurations_Get: - operation: - $ref: '#/paths/~1?object-lock/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - object_lock_configurations_Put: - operation: - $ref: '#/paths/~1?object-lock/put' - response: - mediaType: text/xml - openAPIDocKey: '200' - name: object_lock_configurations - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/object_lock_configurations/methods/object_lock_configurations_Get' - update: [] - title: object_lock_configurations - object_retentions: - id: aws.s3_api.object_retentions - methods: - object_retentions_Get: - operation: - $ref: '#/paths/~1{Key}?retention/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - object_retentions_Put: - operation: - $ref: '#/paths/~1{Key}?retention/put' - response: - mediaType: text/xml - openAPIDocKey: '200' - name: object_retentions - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/object_retentions/methods/object_retentions_Get' - update: [] - title: object_retentions - object_taggings: - id: aws.s3_api.object_taggings - methods: - object_taggings_Delete: - operation: - $ref: '#/paths/~1{Key}?tagging/delete' - response: - mediaType: text/xml - openAPIDocKey: '200' - object_taggings_Get: - operation: - $ref: '#/paths/~1{Key}?tagging/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - object_taggings_Put: - operation: - $ref: '#/paths/~1{Key}?tagging/put' - response: - mediaType: text/xml - openAPIDocKey: '200' - name: object_taggings - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/object_taggings/methods/object_taggings_Delete' - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/object_taggings/methods/object_taggings_Get' - update: [] - title: object_taggings - object_torrents: - id: aws.s3_api.object_torrents - methods: - object_torrents_Get: - operation: - $ref: '#/paths/~1{Key}?torrent/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - name: object_torrents - sqlVerbs: - delete: [] - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/object_torrents/methods/object_torrents_Get' - update: [] - title: object_torrents - object_versions: - id: aws.s3_api.object_versions - methods: - object_versions_List: - operation: - $ref: '#/paths/~1?versions/get' - response: - mediaType: text/xml - objectKey: /*/CommonPrefixes/member - openAPIDocKey: '200' - name: object_versions - sqlVerbs: - delete: [] - insert: [] - # select: - # - $ref: '#/components/x-stackQL-resources/object_versions/methods/object_versions_List' - update: [] - title: object_versions - objects: - id: aws.s3_api.objects - methods: - objects_Copy: - operation: - $ref: '#/paths/~1{Key}#x-amz-copy-source/put' - objects_Delete: - operation: - $ref: '#/paths/~1?delete/post' - objects_Get: - operation: - $ref: '#/paths/~1{Key}/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - objects_List: - operation: - $ref: '#/paths/~1?max-keys=1000/get' - response: - mediaType: text/xml - objectKey: /*/Contents - openAPIDocKey: '200' - objects_Put: - operation: - $ref: '#/paths/~1{Key}/put' - response: - mediaType: text/xml - openAPIDocKey: '200' - objects_Restore: - operation: - $ref: '#/paths/~1{Key}?restore/post' - name: objects - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/objects/methods/objects_Delete' - - $ref: '#/components/x-stackQL-resources/objects/methods/objects_Delete' - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/objects/methods/objects_List' - - $ref: '#/components/x-stackQL-resources/objects/methods/objects_Get' - update: [] - title: objects - objects_v2s: - id: aws.s3_api.objects_v2s - methods: - objects_v2s_List: - operation: - $ref: '#/paths/~1?list-type=2/get' - response: - mediaType: text/xml - objectKey: /*/Contents/member - openAPIDocKey: '200' - name: objects_v2s - sqlVerbs: - # delete: [] - # insert: [] - # select: - # - $ref: '#/components/x-stackQL-resources/objects_v2s/methods/objects_v2s_List' - # update: [] - title: objects_v2s - part_copies: - id: aws.s3_api.part_copies - methods: - part_copies_Upload: - operation: - $ref: '#/paths/~1{Key}#x-amz-copy-source&partNumber&uploadId/put' - name: part_copies - sqlVerbs: - delete: [] - insert: [] - select: [] - update: [] - title: part_copies - parts: - id: aws.s3_api.parts - methods: - parts_List: - operation: - $ref: '#/paths/~1{Key}#uploadId/get' - response: - mediaType: text/xml - objectKey: /*/Part/member - openAPIDocKey: '200' - parts_Upload: - operation: - $ref: '#/paths/~1{Key}#partNumber&uploadId/put' - name: parts - sqlVerbs: - # delete: [] - # insert: [] - # select: - # - $ref: '#/components/x-stackQL-resources/parts/methods/parts_List' - # update: [] - title: parts - public_access_blocks: - id: aws.s3_api.public_access_blocks - methods: - public_access_blocks_Delete: - operation: - $ref: '#/paths/~1?publicAccessBlock/delete' - response: - mediaType: text/xml - openAPIDocKey: '200' - public_access_blocks_Get: - operation: - $ref: '#/paths/~1?publicAccessBlock/get' - response: - mediaType: text/xml - objectKey: /* - openAPIDocKey: '200' - public_access_blocks_Put: - operation: - $ref: '#/paths/~1?publicAccessBlock/put' - response: - mediaType: text/xml - openAPIDocKey: '200' - name: public_access_blocks - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/public_access_blocks/methods/public_access_blocks_Delete' - insert: [] - select: - - $ref: '#/components/x-stackQL-resources/public_access_blocks/methods/public_access_blocks_Get' - update: [] - title: public_access_blocks -externalDocs: - description: Amazon Web Services documentation - url: https://docs.aws.amazon.com/s3/ -info: - contact: - email: mike.ralphson@gmail.com - name: Mike Ralphson - url: https://github.com/mermade/aws2openapi - x-twitter: PermittedSoc - description:

- license: - name: Apache 2.0 License - url: http://www.apache.org/licenses/ - termsOfService: https://aws.amazon.com/service-terms/ - title: Amazon Simple Storage Service - version: '2006-03-01' - x-apiClientRegistration: - url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct - x-apisguru-categories: - - cloud - x-logo: - backgroundColor: '#FFFFFF' - url: https://twitter.com/awscloud/profile_image?size=original - x-origin: - - contentType: application/json - converter: - url: https://github.com/mermade/aws2openapi - version: 1.0.0 - url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/s3-2006-03-01.normal.json - x-apisguru-driver: external - x-preferred: true - x-providerName: amazonaws.com - x-release: s3 - x-serviceName: s3 -openapi: 3.0.0 -paths: - /WriteGetObjectResponse#x-amz-request-route&x-amz-request-token: - parameters: - - $ref: '#/components/parameters/x-amz-security-token' - post: - description: '

Passes transformed objects to a GetObject operation - when using Object Lambda access points. For information about Object Lambda - access points, see Transforming - objects with Object Lambda access points in the Amazon S3 User Guide.

-

This operation supports metadata that can be returned by GetObject, - in addition to RequestRoute, RequestToken, StatusCode, - ErrorCode, and ErrorMessage. The GetObject - response metadata is supported so that the WriteGetObjectResponse - caller, typically an Lambda function, can provide the same metadata when it - internally invokes GetObject. When WriteGetObjectResponse - is called by a customer-owned Lambda function, the metadata returned to the - end user GetObject call might differ from what Amazon S3 would - normally return.

You can include any number of metadata headers. When - including a metadata header, it should be prefaced with x-amz-meta. - For example, x-amz-meta-my-custom-header: MyCustomValue. The - primary use case for this is to forward GetObject metadata.

-

Amazon Web Services provides some prebuilt Lambda functions that you can - use with S3 Object Lambda to detect and redact personally identifiable information - (PII) and decompress S3 objects. These Lambda functions are available in the - Amazon Web Services Serverless Application Repository, and can be selected - through the Amazon Web Services Management Console when you create your Object - Lambda access point.

Example 1: PII Access Control - This Lambda function - uses Amazon Comprehend, a natural language processing (NLP) service using - machine learning to find insights and relationships in text. It automatically - detects personally identifiable information (PII) such as names, addresses, - dates, credit card numbers, and social security numbers from documents in - your Amazon S3 bucket.

Example 2: PII Redaction - This Lambda function - uses Amazon Comprehend, a natural language processing (NLP) service using - machine learning to find insights and relationships in text. It automatically - redacts personally identifiable information (PII) such as names, addresses, - dates, credit card numbers, and social security numbers from documents in - your Amazon S3 bucket.

Example 3: Decompression - The Lambda function - S3ObjectLambdaDecompression, is equipped to decompress objects stored in S3 - in one of six compressed file formats including bzip2, gzip, snappy, zlib, - zstandard and ZIP.

For information on how to view and use these functions, - see Using - Amazon Web Services built Lambda functions in the Amazon S3 User Guide.

' - operationId: WriteGetObjectResponse - parameters: - - description: Route prefix to the HTTP URL generated. - in: header - name: x-amz-request-route - required: true - schema: - type: string - - description: A single use encrypted token that maps WriteGetObjectResponse - to the end user GetObject request. - in: header - name: x-amz-request-token - required: true - schema: - type: string - - description:

The integer status code for an HTTP response of a corresponding - GetObject request.

Status Codes -

  • 200 - OK

  • 206 - - Partial Content

  • 304 - Not Modified -

  • 400 - Bad Request

  • 401 - - Unauthorized

  • 403 - Forbidden

    -

  • 404 - Not Found

  • 405 - - Method Not Allowed

  • 409 - Conflict -

  • 411 - Length Required

  • - 412 - Precondition Failed

  • 416 - Range - Not Satisfiable

  • 500 - Internal Server Error -

  • 503 - Service Unavailable

- in: header - name: x-amz-fwd-status - required: false - schema: - type: integer - - description: A string that uniquely identifies an error condition. Returned - in the <Code> tag of the error XML response for a corresponding GetObject - call. Cannot be used with a successful StatusCode header or - when the transformed object is provided in the body. All error codes from - S3 are sentence-cased. The regular expression (regex) value is "^[A-Z][a-zA-Z]+$". - in: header - name: x-amz-fwd-error-code - required: false - schema: - type: string - - description: Contains a generic description of the error condition. Returned - in the <Message> tag of the error XML response for a corresponding - GetObject call. Cannot be used with a successful StatusCode - header or when the transformed object is provided in body. - in: header - name: x-amz-fwd-error-message - required: false - schema: - type: string - - description: Indicates that a range of bytes was specified. - in: header - name: x-amz-fwd-header-accept-ranges - required: false - schema: - type: string - - description: Specifies caching behavior along the request/reply chain. - in: header - name: x-amz-fwd-header-Cache-Control - required: false - schema: - type: string - - description: Specifies presentational information for the object. - in: header - name: x-amz-fwd-header-Content-Disposition - required: false - schema: - type: string - - description: Specifies what content encodings have been applied to the object - and thus what decoding mechanisms must be applied to obtain the media-type - referenced by the Content-Type header field. - in: header - name: x-amz-fwd-header-Content-Encoding - required: false - schema: - type: string - - description: The language the content is in. - in: header - name: x-amz-fwd-header-Content-Language - required: false - schema: - type: string - - description: The size of the content body in bytes. - in: header - name: Content-Length - required: false - schema: - type: integer - - description: The portion of the object returned in the response. - in: header - name: x-amz-fwd-header-Content-Range - required: false - schema: - type: string - - description: A standard MIME type describing the format of the object data. - in: header - name: x-amz-fwd-header-Content-Type - required: false - schema: - type: string - - description:

This header can be used as a data integrity check to verify - that the data received is the same data that was originally sent. This specifies - the base64-encoded, 32-bit CRC32 checksum of the object returned by the - Object Lambda function. This may not match the checksum for the object stored - in Amazon S3. Amazon S3 will perform validation of the checksum values only - when the original GetObject request required checksum validation. - For more information about checksums, see Checking - object integrity in the Amazon S3 User Guide.

Only one - checksum header can be specified at a time. If you supply multiple checksum - headers, this request will fail.

- in: header - name: x-amz-fwd-header-x-amz-checksum-crc32 - required: false - schema: - type: string - - description:

This header can be used as a data integrity check to verify - that the data received is the same data that was originally sent. This specifies - the base64-encoded, 32-bit CRC32C checksum of the object returned by the - Object Lambda function. This may not match the checksum for the object stored - in Amazon S3. Amazon S3 will perform validation of the checksum values only - when the original GetObject request required checksum validation. - For more information about checksums, see Checking - object integrity in the Amazon S3 User Guide.

Only one - checksum header can be specified at a time. If you supply multiple checksum - headers, this request will fail.

- in: header - name: x-amz-fwd-header-x-amz-checksum-crc32c - required: false - schema: - type: string - - description:

This header can be used as a data integrity check to verify - that the data received is the same data that was originally sent. This specifies - the base64-encoded, 160-bit SHA-1 digest of the object returned by the Object - Lambda function. This may not match the checksum for the object stored in - Amazon S3. Amazon S3 will perform validation of the checksum values only - when the original GetObject request required checksum validation. - For more information about checksums, see Checking - object integrity in the Amazon S3 User Guide.

Only one - checksum header can be specified at a time. If you supply multiple checksum - headers, this request will fail.

- in: header - name: x-amz-fwd-header-x-amz-checksum-sha1 - required: false - schema: - type: string - - description:

This header can be used as a data integrity check to verify - that the data received is the same data that was originally sent. This specifies - the base64-encoded, 256-bit SHA-256 digest of the object returned by the - Object Lambda function. This may not match the checksum for the object stored - in Amazon S3. Amazon S3 will perform validation of the checksum values only - when the original GetObject request required checksum validation. - For more information about checksums, see Checking - object integrity in the Amazon S3 User Guide.

Only one - checksum header can be specified at a time. If you supply multiple checksum - headers, this request will fail.

- in: header - name: x-amz-fwd-header-x-amz-checksum-sha256 - required: false - schema: - type: string - - description: 'Specifies whether an object stored in Amazon S3 is (true) - or is not (false) a delete marker. ' - in: header - name: x-amz-fwd-header-x-amz-delete-marker - required: false - schema: - type: boolean - - description: 'An opaque identifier assigned by a web server to a specific - version of a resource found at a URL. ' - in: header - name: x-amz-fwd-header-ETag - required: false - schema: - type: string - - description: The date and time at which the object is no longer cacheable. - in: header - name: x-amz-fwd-header-Expires - required: false - schema: - format: date-time - type: string - - description: 'If the object expiration is configured (see PUT Bucket lifecycle), - the response includes this header. It includes the expiry-date - and rule-id key-value pairs that provide the object expiration - information. The value of the rule-id is URL-encoded. ' - in: header - name: x-amz-fwd-header-x-amz-expiration - required: false - schema: - type: string - - description: The date and time that the object was last modified. - in: header - name: x-amz-fwd-header-Last-Modified - required: false - schema: - format: date-time - type: string - - description: Set to the number of metadata entries not returned in x-amz-meta - headers. This can happen if you create metadata using an API like SOAP that - supports more flexible metadata than the REST API. For example, using SOAP, - you can create metadata whose values are not legal HTTP headers. - in: header - name: x-amz-fwd-header-x-amz-missing-meta - required: false - schema: - type: integer - - description: Indicates whether an object stored in Amazon S3 has Object Lock - enabled. For more information about S3 Object Lock, see Object - Lock. - in: header - name: x-amz-fwd-header-x-amz-object-lock-mode - required: false - schema: - enum: - - GOVERNANCE - - COMPLIANCE - type: string - - description: Indicates whether an object stored in Amazon S3 has an active - legal hold. - in: header - name: x-amz-fwd-header-x-amz-object-lock-legal-hold - required: false - schema: - enum: - - 'ON' - - 'OFF' - type: string - - description: The date and time when Object Lock is configured to expire. - in: header - name: x-amz-fwd-header-x-amz-object-lock-retain-until-date - required: false - schema: - format: date-time - type: string - - description: The count of parts this object has. - in: header - name: x-amz-fwd-header-x-amz-mp-parts-count - required: false - schema: - type: integer - - description: Indicates if request involves bucket that is either a source - or destination in a Replication rule. For more information about S3 Replication, - see Replication. - in: header - name: x-amz-fwd-header-x-amz-replication-status - required: false - schema: - enum: - - COMPLETE - - PENDING - - FAILED - - REPLICA - type: string - - description: '' - in: header - name: x-amz-fwd-header-x-amz-request-charged - required: false - schema: - description: If present, indicates that the requester was successfully charged - for the request. - enum: - - requester - type: string - - description: Provides information about object restoration operation and expiration - time of the restored object copy. - in: header - name: x-amz-fwd-header-x-amz-restore - required: false - schema: - type: string - - description: ' The server-side encryption algorithm used when storing requested - object in Amazon S3 (for example, AES256, aws:kms).' - in: header - name: x-amz-fwd-header-x-amz-server-side-encryption - required: false - schema: - enum: - - AES256 - - aws:kms - type: string - - description: Encryption algorithm used if server-side encryption with a customer-provided - encryption key was specified for object stored in Amazon S3. - in: header - name: x-amz-fwd-header-x-amz-server-side-encryption-customer-algorithm - required: false - schema: - type: string - - description: ' If present, specifies the ID of the Amazon Web Services Key - Management Service (Amazon Web Services KMS) symmetric customer managed - key that was used for stored in Amazon S3 object. ' - in: header - name: x-amz-fwd-header-x-amz-server-side-encryption-aws-kms-key-id - required: false - schema: - format: password - type: string - - description: ' 128-bit MD5 digest of customer-provided encryption key used - in Amazon S3 to encrypt data stored in S3. For more information, see Protecting - data using server-side encryption with customer-provided encryption keys - (SSE-C).' - in: header - name: x-amz-fwd-header-x-amz-server-side-encryption-customer-key-MD5 - required: false - schema: - type: string - - description:

Provides storage class information of the object. Amazon S3 - returns this header for all objects except for S3 Standard storage class - objects.

For more information, see Storage - Classes.

- in: header - name: x-amz-fwd-header-x-amz-storage-class - required: false - schema: - enum: - - STANDARD - - REDUCED_REDUNDANCY - - STANDARD_IA - - ONEZONE_IA - - INTELLIGENT_TIERING - - GLACIER - - DEEP_ARCHIVE - - OUTPOSTS - - GLACIER_IR - type: string - - description: The number of tags, if any, on the object. - in: header - name: x-amz-fwd-header-x-amz-tagging-count - required: false - schema: - type: integer - - description: An ID used to reference a specific version of the object. - in: header - name: x-amz-fwd-header-x-amz-version-id - required: false - schema: - type: string - - description: ' Indicates whether the object stored in Amazon S3 uses an S3 - bucket key for server-side encryption with Amazon Web Services KMS (SSE-KMS).' - in: header - name: x-amz-fwd-header-x-amz-server-side-encryption-bucket-key-enabled - required: false - schema: - type: boolean - requestBody: - content: - text/xml: - schema: - properties: - Body: - description: The object data. - type: string - x-amz-meta-: - additionalProperties: - $ref: '#/components/schemas/MetadataValue' - description: A map of metadata to store with the object in S3. - type: object - type: object - required: true - responses: - '200': - description: Success - /: - delete: - description:

Deletes the S3 bucket. All objects (including all object versions - and delete markers) in the bucket must be deleted before the bucket itself - can be deleted.

Related Resources

- externalDocs: - url: http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETE.html - operationId: DeleteBucket - parameters: - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - responses: - '204': - description: Success - get: - description: Returns a list of all buckets owned by the authenticated sender - of the request. To use this operation, you must have the s3:ListAllMyBuckets - permission. - servers: - - description: The Amazon S3 multi-region endpoint - url: https://s3.{region}.amazonaws.com - variables: - region: - default: us-east-2 - description: The AWS region - enum: - - us-east-2 - - us-gov-east-1 - - ca-central-1 - - eu-north-1 - - eu-west-2 - - eu-west-3 - - eu-central-1 - - eu-south-1 - - af-south-1 - - ap-northeast-2 - - ap-northeast-3 - - ap-east-1 - - ap-south-1 - - me-south-1 - externalDocs: - url: http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTServiceGET.html - operationId: ListBuckets - responses: - '200': - content: - text/xml: - schema: - $ref: '#/components/schemas/ListBucketsOutput' - description: Success - head: - description:

This action is useful to determine if a bucket exists and you - have permission to access it. The action returns a 200 OK if - the bucket exists and you have permission to access it.

If the bucket - does not exist or you do not have permission to access it, the HEAD - request returns a generic 404 Not Found or 403 Forbidden - code. A message body is not included, so you cannot determine the exception - beyond these error codes.

To use this operation, you must have permissions - to perform the s3:ListBucket action. The bucket owner has this - permission by default and can grant this permission to others. For more information - about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources.

To use this API - against an access point, you must provide the alias of the access point in - place of the bucket name or specify the access point ARN. When using the access - point ARN, you must direct requests to the access point hostname. The access - point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using the Amazon Web Services SDKs, you provide the ARN in place of the - bucket name. For more information see, Using - access points.

- externalDocs: - url: http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketHEAD.html - operationId: HeadBucket - parameters: - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - responses: - '200': - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchBucket' - description: NoSuchBucket - parameters: - - $ref: '#/components/parameters/x-amz-security-token' - put: - description: "

Creates a new S3 bucket. To create a bucket, you must register\ - \ with Amazon S3 and have a valid Amazon Web Services Access Key ID to authenticate\ - \ requests. Anonymous requests are never allowed to create buckets. By creating\ - \ the bucket, you become the bucket owner.

Not every string is an acceptable\ - \ bucket name. For information about bucket naming restrictions, see Bucket naming rules.

If you want to create an Amazon S3 on Outposts\ - \ bucket, see Create Bucket.

By default, the bucket is created in the US East\ - \ (N. Virginia) Region. You can optionally specify a Region in the request\ - \ body. You might choose a Region to optimize latency, minimize costs, or\ - \ address regulatory requirements. For example, if you reside in Europe, you\ - \ will probably find it advantageous to create buckets in the Europe (Ireland)\ - \ Region. For more information, see Accessing a bucket.

If you send your create bucket request\ - \ to the s3.amazonaws.com endpoint, the request goes to the us-east-1\ - \ Region. Accordingly, the signature calculations in Signature Version 4 must\ - \ use us-east-1 as the Region, even if the location constraint in the request\ - \ specifies another Region where the bucket is to be created. If you create\ - \ a bucket in a Region other than US East (N. Virginia), your application\ - \ must be able to handle 307 redirect. For more information, see Virtual\ - \ hosting of buckets.

Access control lists (ACLs)\ - \

When creating a bucket using this operation, you can optionally\ - \ configure the bucket ACL to specify the accounts or groups that should be\ - \ granted specific permissions on the bucket.

If your CreateBucket\ - \ request sets bucket owner enforced for S3 Object Ownership and specifies\ - \ a bucket ACL that provides access to an external Amazon Web Services account,\ - \ your request fails with a 400 error and returns the InvalidBucketAclWithObjectOwnership\ - \ error code. For more information, see Controlling object ownership in the Amazon S3 User Guide.

\ - \

There are two ways to grant the appropriate permissions\ - \ using the request headers.

  • Specify a canned ACL using the\ - \ x-amz-acl request header. Amazon S3 supports a set of predefined\ - \ ACLs, known as canned ACLs. Each canned ACL has a predefined set\ - \ of grantees and permissions. For more information, see Canned ACL.

  • Specify access permissions explicitly using\ - \ the x-amz-grant-read, x-amz-grant-write, x-amz-grant-read-acp,\ - \ x-amz-grant-write-acp, and x-amz-grant-full-control\ - \ headers. These headers map to the set of permissions Amazon S3 supports\ - \ in an ACL. For more information, see Access control list (ACL) overview.

    You specify each grantee as\ - \ a type=value pair, where the type is one of the following:

    • \ - \

      id \u2013 if the value specified is the canonical user\ - \ ID of an Amazon Web Services account

    • uri\ - \ \u2013 if you are granting permissions to a predefined group

    • \ - \

      emailAddress \u2013 if the value specified is the email\ - \ address of an Amazon Web Services account

      Using email addresses\ - \ to specify a grantee is only supported in the following Amazon Web Services\ - \ Regions:

      • US East (N. Virginia)

      • US West\ - \ (N. California)

      • US West (Oregon)

      • Asia\ - \ Pacific (Singapore)

      • Asia Pacific (Sydney)

      • \ - \

        Asia Pacific (Tokyo)

      • Europe (Ireland)

      • \ - \

        South America (S\xE3o Paulo)

      For a list of all the\ - \ Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

      \ - \

    For example, the following x-amz-grant-read\ - \ header grants the Amazon Web Services accounts identified by account IDs\ - \ permissions to read object data and its metadata:

    x-amz-grant-read:\ - \ id=\"11112222333\", id=\"444455556666\"

\ - \

You can use either a canned ACL or specify access permissions explicitly.\ - \ You cannot do both.

Permissions

In addition\ - \ to s3:CreateBucket, the following permissions are required\ - \ when your CreateBucket includes specific headers:

  • ACLs\ - \ - If your CreateBucket request specifies ACL permissions and\ - \ the ACL is public-read, public-read-write, authenticated-read, or if you\ - \ specify access permissions explicitly through any other ACL, both s3:CreateBucket\ - \ and s3:PutBucketAcl permissions are needed. If the ACL the\ - \ CreateBucket request is private or doesn't specify any ACLs,\ - \ only s3:CreateBucket permission is needed.

  • \ - \

    Object Lock - If ObjectLockEnabledForBucket is set\ - \ to true in your CreateBucket request, s3:PutBucketObjectLockConfiguration\ - \ and s3:PutBucketVersioning permissions are required.

    • \ - \

  • S3 Object Ownership - If your CreateBucket request includes\ - \ the the x-amz-object-ownership header, s3:PutBucketOwnershipControls\ - \ permission is required.

The following operations are\ - \ related to CreateBucket:

" - externalDocs: - url: http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUT.html - operationId: CreateBucket - parameters: - - description: The canned ACL to apply to the bucket. - in: header - name: x-amz-acl - required: false - schema: - enum: - - private - - public-read - - public-read-write - - authenticated-read - type: string - - description: Allows grantee the read, write, read ACP, and write ACP permissions - on the bucket. - in: header - name: x-amz-grant-full-control - required: false - schema: - type: string - - description: Allows grantee to list the objects in the bucket. - in: header - name: x-amz-grant-read - required: false - schema: - type: string - - description: Allows grantee to read the bucket ACL. - in: header - name: x-amz-grant-read-acp - required: false - schema: - type: string - - description:

Allows grantee to create new objects in the bucket.

For - the bucket and object owners of existing objects, also allows deletions - and overwrites of those objects.

- in: header - name: x-amz-grant-write - required: false - schema: - type: string - - description: Allows grantee to write the ACL for the applicable bucket. - in: header - name: x-amz-grant-write-acp - required: false - schema: - type: string - - description: Specifies whether you want S3 Object Lock to be enabled for the - new bucket. - in: header - name: x-amz-bucket-object-lock-enabled - required: false - schema: - type: boolean - - description: '' - in: header - name: x-amz-object-ownership - required: false - schema: - description:

The container element for object ownership for a bucket's - ownership controls.

BucketOwnerPreferred - Objects uploaded to - the bucket change ownership to the bucket owner if the objects are uploaded - with the bucket-owner-full-control canned ACL.

ObjectWriter - - The uploading account will own the object if the object is uploaded - with the bucket-owner-full-control canned ACL.

BucketOwnerEnforced - - Access control lists (ACLs) are disabled and no longer affect permissions. - The bucket owner automatically owns and has full control over every object - in the bucket. The bucket only accepts PUT requests that don't specify - an ACL or bucket owner full control ACLs, such as the bucket-owner-full-control - canned ACL or an equivalent form of this ACL expressed in the XML format.

- enum: - - BucketOwnerPreferred - - ObjectWriter - - BucketOwnerEnforced - type: string - requestBody: - content: - text/xml: - schema: - properties: - CreateBucketConfiguration: - description: The configuration information for the bucket. - properties: - LocationConstraint: - allOf: - - $ref: '#/components/schemas/BucketLocationConstraint' - - description: Specifies the Region where the bucket will be - created. If you don't specify a Region, the bucket is created - in the US East (N. Virginia) Region (us-east-1). - type: object - type: object - required: true - responses: - '200': - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateBucketOutput' - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/BucketAlreadyExists' - description: BucketAlreadyExists - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/BucketAlreadyOwnedByYou' - description: BucketAlreadyOwnedByYou - /?max-keys=1000: - get: - servers: - - description: The Amazon S3 multi-region endpoint - url: https://{bucket}.s3.{region}.amazonaws.com - variables: - bucket: - default: null-bucket - description: The name of the bucket - region: - default: us-east-2 - description: The AWS region - enum: - - us-east-2 - - us-gov-east-1 - - ca-central-1 - - eu-north-1 - - eu-west-2 - - eu-west-3 - - eu-central-1 - - eu-south-1 - - af-south-1 - - ap-northeast-2 - - ap-northeast-3 - - ap-east-1 - - ap-south-1 - - me-south-1 - description:

Returns some or all (up to 1,000) of the objects in a bucket. - You can use the request parameters as selection criteria to return a subset - of the objects in a bucket. A 200 OK response can contain valid or invalid - XML. Be sure to design your application to parse the contents of the response - and handle it appropriately.

This action has been revised. - We recommend that you use the newer version, ListObjectsV2, - when developing applications. For backward compatibility, Amazon S3 continues - to support ListObjects.

The following operations - are related to ListObjects:

- externalDocs: - url: http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGET.html - operationId: ListObjects - parameters: - - description: A delimiter is a character you use to group keys. - in: query - name: delimiter - required: false - schema: - type: string - - description: '' - in: query - name: encoding-type - required: false - schema: - description: Requests Amazon S3 to encode the object keys in the response - and specifies the encoding method to use. An object key may contain any - Unicode character; however, XML 1.0 parser cannot parse some characters, - such as characters with an ASCII value from 0 to 10. For characters that - are not supported in XML 1.0, you can add this parameter to request that - Amazon S3 encode the keys in the response. - enum: - - url - type: string - - description: Marker is where you want Amazon S3 to start listing from. Amazon - S3 starts listing after this specified key. Marker can be any key in the - bucket. - in: query - name: marker - required: false - schema: - type: string - - description: 'Sets the maximum number of keys returned in the response. By - default the action returns up to 1,000 key names. The response might contain - fewer keys but will never contain more. ' - in: query - name: max-keys - required: false - schema: - type: integer - default: 1000 - - description: Limits the response to keys that begin with the specified prefix. - in: query - name: prefix - required: false - schema: - type: string - - description: Confirms that the requester knows that she or he will be charged - for the list objects request. Bucket owners need not specify this parameter - in their requests. - in: header - name: x-amz-request-payer - required: false - schema: - description: Confirms that the requester knows that they will be charged - for the request. Bucket owners need not specify this parameter in their - requests. For information about downloading objects from Requester Pays - buckets, see Downloading - Objects in Requester Pays Buckets in the Amazon S3 User Guide. - enum: - - requester - type: string - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - description: Pagination limit - in: query - name: MaxKeys - required: false - schema: - type: string - - description: Pagination token - in: query - name: Marker - required: false - schema: - type: string - responses: - '200': - content: - text/xml: - schema: - $ref: '#/components/schemas/ListObjectsOutput' - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchBucket' - description: NoSuchBucket - /{Key}: - delete: - description:

Removes the null version (if there is one) of an object and - inserts a delete marker, which becomes the latest version of the object. If - there isn't a null version, Amazon S3 does not remove any objects but will - still respond that the command was successful.

To remove a specific - version, you must be the bucket owner and you must use the version Id subresource. - Using this subresource permanently deletes the version. If the object deleted - is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, - to true.

If the object you want to delete is in a bucket where the - bucket versioning configuration is MFA Delete enabled, you must include the - x-amz-mfa request header in the DELETE versionId - request. Requests that include x-amz-mfa must use HTTPS.

-

For more information about MFA Delete, see Using - MFA Delete. To see sample requests that use versioning, see Sample - Request.

You can delete objects by explicitly calling DELETE Object - or configure its lifecycle (PutBucketLifecycle) - to enable Amazon S3 to remove them for you. If you want to block users or - accounts from removing or deleting objects from your bucket, you must deny - them the s3:DeleteObject, s3:DeleteObjectVersion, - and s3:PutLifeCycleConfiguration actions.

The following - action is related to DeleteObject:

- externalDocs: - url: http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectDELETE.html - operationId: DeleteObject - parameters: - - description: Key name of the object to delete. - in: path - name: Key - required: true - schema: - minLength: 1 - type: string - - description: The concatenation of the authentication device's serial number, - a space, and the value that is displayed on your authentication device. - Required to permanently delete a versioned object if versioning is configured - with MFA delete enabled. - in: header - name: x-amz-mfa - required: false - schema: - type: string - - description: VersionId used to reference a specific version of the object. - in: query - name: versionId - required: false - schema: - type: string - - description: '' - in: header - name: x-amz-request-payer - required: false - schema: - description: Confirms that the requester knows that they will be charged - for the request. Bucket owners need not specify this parameter in their - requests. For information about downloading objects from Requester Pays - buckets, see Downloading - Objects in Requester Pays Buckets in the Amazon S3 User Guide. - enum: - - requester - type: string - - description: Indicates whether S3 Object Lock should bypass Governance-mode - restrictions to process this operation. To use this header, you must have - the s3:BypassGovernanceRetention permission. - in: header - name: x-amz-bypass-governance-retention - required: false - schema: - type: boolean - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - responses: - '204': - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteObjectOutput' - description: Success - get: - description: "

Retrieves objects from Amazon S3. To use GET,\ - \ you must have READ access to the object. If you grant READ\ - \ access to the anonymous user, you can return the object without using an\ - \ authorization header.

An Amazon S3 bucket has no directory hierarchy\ - \ such as you would find in a typical computer file system. You can, however,\ - \ create a logical hierarchy by using object key names that imply a folder\ - \ structure. For example, instead of naming an object sample.jpg,\ - \ you can name it photos/2006/February/sample.jpg.

To\ - \ get an object from such a logical hierarchy, specify the full key name for\ - \ the object in the GET operation. For a virtual hosted-style\ - \ request example, if you have the object photos/2006/February/sample.jpg,\ - \ specify the resource as /photos/2006/February/sample.jpg. For\ - \ a path-style request example, if you have the object photos/2006/February/sample.jpg\ - \ in the bucket named examplebucket, specify the resource as\ - \ /examplebucket/photos/2006/February/sample.jpg. For more information\ - \ about request types, see HTTP Host Header Bucket Specification.

For more information about\ - \ returning the ACL of an object, see GetObjectAcl.

If the object you are retrieving is stored in the\ - \ S3 Glacier or S3 Glacier Deep Archive storage class, or S3 Intelligent-Tiering\ - \ Archive or S3 Intelligent-Tiering Deep Archive tiers, before you can retrieve\ - \ the object you must first restore a copy using RestoreObject. Otherwise, this action returns an InvalidObjectStateError\ - \ error. For information about restoring archived objects, see Restoring\ - \ Archived Objects.

Encryption request headers, like x-amz-server-side-encryption,\ - \ should not be sent for GET requests if your object uses server-side encryption\ - \ with KMS keys (SSE-KMS) or server-side encryption with Amazon S3\u2013managed\ - \ encryption keys (SSE-S3). If your object does use these types of keys, you\u2019\ - ll get an HTTP 400 BadRequest error.

If you encrypt an object by using\ - \ server-side encryption with customer-provided encryption keys (SSE-C) when\ - \ you store the object in Amazon S3, then when you GET the object, you must\ - \ use the following headers:

  • x-amz-server-side-encryption-customer-algorithm

    \ - \

  • x-amz-server-side-encryption-customer-key

  • x-amz-server-side-encryption-customer-key-MD5

    \ - \

For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys).

\ - \

Assuming you have the relevant permission to read object tags, the response\ - \ also returns the x-amz-tagging-count header that provides the\ - \ count of number of tags associated with the object. You can use GetObjectTagging to retrieve the tag set associated with an object.

\ - \

Permissions

You need the relevant read object (or version)\ - \ permission for this operation. For more information, see Specifying Permissions in a Policy. If the object you request does not\ - \ exist, the error Amazon S3 returns depends on whether you also have the\ - \ s3:ListBucket permission.

  • If you have the\ - \ s3:ListBucket permission on the bucket, Amazon S3 will return\ - \ an HTTP status code 404 (\"no such key\") error.

  • If you\ - \ don\u2019t have the s3:ListBucket permission, Amazon S3 will\ - \ return an HTTP status code 403 (\"access denied\") error.

\ - \

Versioning

By default, the GET action returns the current\ - \ version of an object. To return a different version, use the versionId\ - \ subresource.

  • If you supply a versionId,\ - \ you need the s3:GetObjectVersion permission to access a specific\ - \ version of an object. If you request a specific version, you do not need\ - \ to have the s3:GetObject permission.

  • If\ - \ the current version of the object is a delete marker, Amazon S3 behaves\ - \ as if the object was deleted and includes x-amz-delete-marker: true\ - \ in the response.

For more information about versioning,\ - \ see PutBucketVersioning.

Overriding Response Header Values\ - \

There are times when you want to override certain response header\ - \ values in a GET response. For example, you might override the Content-Disposition\ - \ response header value in your GET request.

You can override values\ - \ for a set of response headers using the following query parameters. These\ - \ response header values are sent only on a successful request, that is, when\ - \ status code 200 OK is returned. The set of headers you can override using\ - \ these parameters is a subset of the headers that Amazon S3 accepts when\ - \ you create an object. The response headers that you can override for the\ - \ GET response are Content-Type, Content-Language,\ - \ Expires, Cache-Control, Content-Disposition,\ - \ and Content-Encoding. To override these header values in the\ - \ GET response, you use the following request parameters.

You\ - \ must sign the request, either using an Authorization header or a presigned\ - \ URL, when using these parameters. They cannot be used with an unsigned (anonymous)\ - \ request.

  • response-content-type

    \ - \

  • response-content-language

  • \ - \ response-expires

  • response-cache-control\ - \

  • response-content-disposition

    • \ - \

  • response-content-encoding

Additional\ - \ Considerations about Request Headers

If both of the If-Match\ - \ and If-Unmodified-Since headers are present in the request\ - \ as follows: If-Match condition evaluates to true,\ - \ and; If-Unmodified-Since condition evaluates to false;\ - \ then, S3 returns 200 OK and the data requested.

If both of the If-None-Match\ - \ and If-Modified-Since headers are present in the request as\ - \ follows: If-None-Match condition evaluates to false,\ - \ and; If-Modified-Since condition evaluates to true;\ - \ then, S3 returns 304 Not Modified response code.

For more information\ - \ about conditional requests, see RFC 7232.

The following operations are related to GetObject:

\ - \ " - externalDocs: - url: http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectGET.html - operationId: GetObject - parameters: - - description: Return the object only if its entity tag (ETag) is the same as - the one specified; otherwise, return a 412 (precondition failed) error. - in: header - name: If-Match - required: false - schema: - type: string - - description: Return the object only if it has been modified since the specified - time; otherwise, return a 304 (not modified) error. - in: header - name: If-Modified-Since - required: false - schema: - format: date-time - type: string - - description: Return the object only if its entity tag (ETag) is different - from the one specified; otherwise, return a 304 (not modified) error. - in: header - name: If-None-Match - required: false - schema: - type: string - - description: Return the object only if it has not been modified since the - specified time; otherwise, return a 412 (precondition failed) error. - in: header - name: If-Unmodified-Since - required: false - schema: - format: date-time - type: string - - description: Key of the object to get. - in: path - name: Key - required: true - schema: - minLength: 1 - type: string - - description:

Downloads the specified range bytes of an object. For more - information about the HTTP Range header, see https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.

-

Amazon S3 doesn't support retrieving multiple ranges of data per - GET request.

 - in: header - name: Range - required: false - schema: - type: string - - description: Sets the Cache-Control header of the response. - in: query - name: response-cache-control - required: false - schema: - type: string - - description: Sets the Content-Disposition header of the response - in: query - name: response-content-disposition - required: false - schema: - type: string - - description: Sets the Content-Encoding header of the response. - in: query - name: response-content-encoding - required: false - schema: - type: string - - description: Sets the Content-Language header of the response. - in: query - name: response-content-language - required: false - schema: - type: string - - description: Sets the Content-Type header of the response. - in: query - name: response-content-type - required: false - schema: - type: string - - description: Sets the Expires header of the response. - in: query - name: response-expires - required: false - schema: - format: date-time - type: string - - description: VersionId used to reference a specific version of the object. - in: query - name: versionId - required: false - schema: - type: string - - description: Specifies the algorithm to use to when decrypting the object - (for example, AES256). - in: header - name: x-amz-server-side-encryption-customer-algorithm - required: false - schema: - type: string - - description: Specifies the customer-provided encryption key for Amazon S3 - used to encrypt the data. This value is used to decrypt the object when - recovering it and must match the one used when storing the data. The key - must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm - header. - in: header - name: x-amz-server-side-encryption-customer-key - required: false - schema: - format: password - type: string - - description: Specifies the 128-bit MD5 digest of the encryption key according - to RFC 1321. Amazon S3 uses this header for a message integrity check to - ensure that the encryption key was transmitted without error. - in: header - name: x-amz-server-side-encryption-customer-key-MD5 - required: false - schema: - type: string - - description: '' - in: header - name: x-amz-request-payer - required: false - schema: - description: Confirms that the requester knows that they will be charged - for the request. Bucket owners need not specify this parameter in their - requests. For information about downloading objects from Requester Pays - buckets, see Downloading - Objects in Requester Pays Buckets in the Amazon S3 User Guide. - enum: - - requester - type: string - - description: Part number of the object being read. This is a positive integer - between 1 and 10,000. Effectively performs a 'ranged' GET request for the - part specified. Useful for downloading just a part of an object. - in: query - name: partNumber - required: false - schema: - type: integer - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - description: To retrieve the checksum, this mode must be enabled. - in: header - name: x-amz-checksum-mode - required: false - schema: - enum: - - ENABLED - type: string - responses: - '200': - content: - text/xml: - schema: - $ref: '#/components/schemas/GetObjectOutput' - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchKey' - description: NoSuchKey - '481': - content: - text/xml: - schema: - $ref: '#/components/schemas/InvalidObjectState' - description: InvalidObjectState - head: - description: "

The HEAD action retrieves metadata from an object without returning\ - \ the object itself. This action is useful if you're only interested in an\ - \ object's metadata. To use HEAD, you must have READ access to the object.

\ - \

A HEAD request has the same options as a GET\ - \ action on an object. The response is identical to the GET response\ - \ except that there is no response body. Because of this, if the HEAD\ - \ request generates an error, it returns a generic 404 Not Found\ - \ or 403 Forbidden code. It is not possible to retrieve the exact\ - \ exception beyond these error codes.

If you encrypt an object by using\ - \ server-side encryption with customer-provided encryption keys (SSE-C) when\ - \ you store the object in Amazon S3, then when you retrieve the metadata from\ - \ the object, you must use the following headers:

  • x-amz-server-side-encryption-customer-algorithm

    \ - \

  • x-amz-server-side-encryption-customer-key

  • x-amz-server-side-encryption-customer-key-MD5

    \ - \

For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys).

\ - \

  • Encryption request headers, like x-amz-server-side-encryption,\ - \ should not be sent for GET requests if your object uses server-side encryption\ - \ with KMS keys (SSE-KMS) or server-side encryption with Amazon S3\u2013managed\ - \ encryption keys (SSE-S3). If your object does use these types of keys, you\u2019\ - ll get an HTTP 400 BadRequest error.

  • The last modified\ - \ property in this case is the creation date of the object.

\ - \

Request headers are limited to 8 KB in size. For more information,\ - \ see Common Request Headers.

Consider the following when using request\ - \ headers:

  • Consideration 1 \u2013 If both of the If-Match\ - \ and If-Unmodified-Since headers are present in the request\ - \ as follows:

    • If-Match condition evaluates\ - \ to true, and;

    • If-Unmodified-Since\ - \ condition evaluates to false;

    Then Amazon\ - \ S3 returns 200 OK and the data requested.

  • \ - \ Consideration 2 \u2013 If both of the If-None-Match and If-Modified-Since\ - \ headers are present in the request as follows:

    • If-None-Match\ - \ condition evaluates to false, and;

    • If-Modified-Since\ - \ condition evaluates to true;

    Then Amazon\ - \ S3 returns the 304 Not Modified response code.

\ - \

For more information about conditional requests, see RFC 7232.

Permissions

You need the relevant read\ - \ object (or version) permission for this operation. For more information,\ - \ see Specifying Permissions in a Policy. If the object you request does not\ - \ exist, the error Amazon S3 returns depends on whether you also have the\ - \ s3:ListBucket permission.

  • If you have the s3:ListBucket\ - \ permission on the bucket, Amazon S3 returns an HTTP status code 404 (\"\ - no such key\") error.

  • If you don\u2019t have the s3:ListBucket\ - \ permission, Amazon S3 returns an HTTP status code 403 (\"access denied\"\ - ) error.

The following actions are related to HeadObject:

\ - \ " - externalDocs: - url: http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectHEAD.html - operationId: HeadObject - parameters: - - description: Return the object only if its entity tag (ETag) is the same as - the one specified; otherwise, return a 412 (precondition failed) error. - in: header - name: If-Match - required: false - schema: - type: string - - description: Return the object only if it has been modified since the specified - time; otherwise, return a 304 (not modified) error. - in: header - name: If-Modified-Since - required: false - schema: - format: date-time - type: string - - description: Return the object only if its entity tag (ETag) is different - from the one specified; otherwise, return a 304 (not modified) error. - in: header - name: If-None-Match - required: false - schema: - type: string - - description: Return the object only if it has not been modified since the - specified time; otherwise, return a 412 (precondition failed) error. - in: header - name: If-Unmodified-Since - required: false - schema: - format: date-time - type: string - - description: The object key. - in: path - name: Key - required: true - schema: - minLength: 1 - type: string - - description: Because HeadObject returns only the metadata for - an object, this parameter has no effect. - in: header - name: Range - required: false - schema: - type: string - - description: VersionId used to reference a specific version of the object. - in: query - name: versionId - required: false - schema: - type: string - - description: Specifies the algorithm to use to when encrypting the object - (for example, AES256). - in: header - name: x-amz-server-side-encryption-customer-algorithm - required: false - schema: - type: string - - description: Specifies the customer-provided encryption key for Amazon S3 - to use in encrypting data. This value is used to store the object and then - it is discarded; Amazon S3 does not store the encryption key. The key must - be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm - header. - in: header - name: x-amz-server-side-encryption-customer-key - required: false - schema: - format: password - type: string - - description: Specifies the 128-bit MD5 digest of the encryption key according - to RFC 1321. Amazon S3 uses this header for a message integrity check to - ensure that the encryption key was transmitted without error. - in: header - name: x-amz-server-side-encryption-customer-key-MD5 - required: false - schema: - type: string - - description: '' - in: header - name: x-amz-request-payer - required: false - schema: - description: Confirms that the requester knows that they will be charged - for the request. Bucket owners need not specify this parameter in their - requests. For information about downloading objects from Requester Pays - buckets, see Downloading - Objects in Requester Pays Buckets in the Amazon S3 User Guide. - enum: - - requester - type: string - - description: Part number of the object being read. This is a positive integer - between 1 and 10,000. Effectively performs a 'ranged' HEAD request for the - part specified. Useful querying about the size of the part and the number - of parts in this object. - in: query - name: partNumber - required: false - schema: - type: integer - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - description:

To retrieve the checksum, this parameter must be enabled.

-

In addition, if you enable ChecksumMode and the object is - encrypted with Amazon Web Services Key Management Service (Amazon Web Services - KMS), you must have permission to use the kms:Decrypt action - for the request to succeed.

- in: header - name: x-amz-checksum-mode - required: false - schema: - enum: - - ENABLED - type: string - responses: - '200': - content: - text/xml: - schema: - $ref: '#/components/schemas/HeadObjectOutput' - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchKey' - description: NoSuchKey - parameters: - - $ref: '#/components/parameters/x-amz-security-token' - put: - description:

Adds an object to a bucket. You must have WRITE permissions - on a bucket to add an object to it.

Amazon S3 never adds partial objects; - if you receive a success response, Amazon S3 added the entire object to the - bucket.

Amazon S3 is a distributed system. If it receives multiple - write requests for the same object simultaneously, it overwrites all but the - last object written. Amazon S3 does not provide object locking; if you need - this, make sure to build it into your application layer or use versioning - instead.

To ensure that data is not corrupted traversing the network, - use the Content-MD5 header. When you use this header, Amazon - S3 checks the object against the provided MD5 value and, if they do not match, - returns an error. Additionally, you can calculate the MD5 while putting an - object to Amazon S3 and compare the returned ETag to the calculated MD5 value.

-

  • To successfully complete the PutObject request, - you must have the s3:PutObject in your IAM permissions.

    • -

  • To successfully change the objects acl of your PutObject - request, you must have the s3:PutObjectAcl in your IAM permissions.

    -

  • The Content-MD5 header is required for any request - to upload an object with a retention period configured using Amazon S3 Object - Lock. For more information about Amazon S3 Object Lock, see Amazon - S3 Object Lock Overview in the Amazon S3 User Guide.

    • -

Server-side Encryption

You can optionally - request server-side encryption. With server-side encryption, Amazon S3 encrypts - your data as it writes it to disks in its data centers and decrypts the data - when you access it. You have the option to provide your own encryption key - or use Amazon Web Services managed encryption keys (SSE-S3 or SSE-KMS). For - more information, see Using - Server-Side Encryption.

If you request server-side encryption using - Amazon Web Services Key Management Service (SSE-KMS), you can enable an S3 - Bucket Key at the object-level. For more information, see Amazon - S3 Bucket Keys in the Amazon S3 User Guide.

Access Control - List (ACL)-Specific Request Headers

You can use headers to grant - ACL- based permissions. By default, all objects are private. Only the owner - has full access control. When adding a new object, you can grant permissions - to individual Amazon Web Services accounts or to predefined groups defined - by Amazon S3. These permissions are then added to the ACL on the object. For - more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API.

If the bucket that you're uploading objects - to uses the bucket owner enforced setting for S3 Object Ownership, ACLs are - disabled and no longer affect permissions. Buckets that use this setting only - accept PUT requests that don't specify an ACL or PUT requests that specify - bucket owner full control ACLs, such as the bucket-owner-full-control - canned ACL or an equivalent form of this ACL expressed in the XML format. - PUT requests that contain other ACLs (for example, custom grants to certain - Amazon Web Services accounts) fail and return a 400 error with - the error code AccessControlListNotSupported.

For more - information, see - Controlling ownership of objects and disabling ACLs in the Amazon S3 - User Guide.

If your bucket uses the bucket owner enforced - setting for Object Ownership, all objects written to the bucket by any account - will be owned by the bucket owner.

Storage Class Options -

By default, Amazon S3 uses the STANDARD Storage Class to store newly - created objects. The STANDARD storage class provides high durability and high - availability. Depending on performance needs, you can specify a different - Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. - For more information, see Storage - Classes in the Amazon S3 User Guide.

Versioning -

If you enable versioning for a bucket, Amazon S3 automatically generates - a unique version ID for the object being stored. Amazon S3 returns this ID - in the response. When you enable versioning for a bucket, if Amazon S3 receives - multiple write requests for the same object simultaneously, it stores all - of the objects.

For more information about versioning, see Adding - Objects to Versioning Enabled Buckets. For information about returning - the versioning state of a bucket, see GetBucketVersioning. -

Related Resources

- externalDocs: - url: http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectPUT.html - operationId: PutObject - parameters: - - description:

The canned ACL to apply to the object. For more information, - see Canned - ACL.

This action is not supported by Amazon S3 on Outposts.

- in: header - name: x-amz-acl - required: false - schema: - enum: - - private - - public-read - - public-read-write - - authenticated-read - - aws-exec-read - - bucket-owner-read - - bucket-owner-full-control - type: string - - description: ' Can be used to specify caching behavior along the request/reply - chain. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.' - in: header - name: Cache-Control - required: false - schema: - type: string - - description: Specifies presentational information for the object. For more - information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1. - in: header - name: Content-Disposition - required: false - schema: - type: string - - description: Specifies what content encodings have been applied to the object - and thus what decoding mechanisms must be applied to obtain the media-type - referenced by the Content-Type header field. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11. - in: header - name: Content-Encoding - required: false - schema: - type: string - - description: The language the content is in. - in: header - name: Content-Language - required: false - schema: - type: string - - description: Size of the body in bytes. This parameter is useful when the - size of the body cannot be determined automatically. For more information, - see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13. - in: header - name: Content-Length - required: false - schema: - type: integer - - description: The base64-encoded 128-bit MD5 digest of the message (without - the headers) according to RFC 1864. This header can be used as a message - integrity check to verify that the data is the same data that was originally - sent. Although it is optional, we recommend using the Content-MD5 mechanism - as an end-to-end integrity check. For more information about REST request - authentication, see REST - Authentication. - in: header - name: Content-MD5 - required: false - schema: - type: string - - description: A standard MIME type describing the format of the contents. For - more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17. - in: header - name: Content-Type - required: false - schema: - type: string - - description:

Indicates the algorithm used to create the checksum for the - object when using the SDK. This header will not provide any additional functionality - if not using the SDK. When sending this header, there must be a corresponding - x-amz-checksum or x-amz-trailer header sent. Otherwise, - Amazon S3 fails the request with the HTTP status code 400 Bad Request. - For more information, see Checking - object integrity in the Amazon S3 User Guide.

If you provide - an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm - parameter.

- in: header - name: x-amz-sdk-checksum-algorithm - required: false - schema: - enum: - - CRC32 - - CRC32C - - SHA1 - - SHA256 - type: string - - description: This header can be used as a data integrity check to verify that - the data received is the same data that was originally sent. This header - specifies the base64-encoded, 32-bit CRC32 checksum of the object. For more - information, see Checking - object integrity in the Amazon S3 User Guide. - in: header - name: x-amz-checksum-crc32 - required: false - schema: - type: string - - description: This header can be used as a data integrity check to verify that - the data received is the same data that was originally sent. This header - specifies the base64-encoded, 32-bit CRC32C checksum of the object. For - more information, see Checking - object integrity in the Amazon S3 User Guide. - in: header - name: x-amz-checksum-crc32c - required: false - schema: - type: string - - description: This header can be used as a data integrity check to verify that - the data received is the same data that was originally sent. This header - specifies the base64-encoded, 160-bit SHA-1 digest of the object. For more - information, see Checking - object integrity in the Amazon S3 User Guide. - in: header - name: x-amz-checksum-sha1 - required: false - schema: - type: string - - description: This header can be used as a data integrity check to verify that - the data received is the same data that was originally sent. This header - specifies the base64-encoded, 256-bit SHA-256 digest of the object. For - more information, see Checking - object integrity in the Amazon S3 User Guide. - in: header - name: x-amz-checksum-sha256 - required: false - schema: - type: string - - description: The date and time at which the object is no longer cacheable. - For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21. - in: header - name: Expires - required: false - schema: - format: date-time - type: string - - description:

Gives the grantee READ, READ_ACP, and WRITE_ACP permissions - on the object.

This action is not supported by Amazon S3 on Outposts.

- in: header - name: x-amz-grant-full-control - required: false - schema: - type: string - - description:

Allows grantee to read the object data and its metadata.

-

This action is not supported by Amazon S3 on Outposts.

- in: header - name: x-amz-grant-read - required: false - schema: - type: string - - description:

Allows grantee to read the object ACL.

This action - is not supported by Amazon S3 on Outposts.

- in: header - name: x-amz-grant-read-acp - required: false - schema: - type: string - - description:

Allows grantee to write the ACL for the applicable object.

-

This action is not supported by Amazon S3 on Outposts.

- in: header - name: x-amz-grant-write-acp - required: false - schema: - type: string - - description: Object key for which the PUT action was initiated. - in: path - name: Key - required: true - schema: - minLength: 1 - type: string - - description: The server-side encryption algorithm used when storing this object - in Amazon S3 (for example, AES256, aws:kms). - in: header - name: x-amz-server-side-encryption - required: false - schema: - enum: - - AES256 - - aws:kms - type: string - - description: By default, Amazon S3 uses the STANDARD Storage Class to store - newly created objects. The STANDARD storage class provides high durability - and high availability. Depending on performance needs, you can specify a - different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage - Class. For more information, see Storage - Classes in the Amazon S3 User Guide. - in: header - name: x-amz-storage-class - required: false - schema: - enum: - - STANDARD - - REDUCED_REDUNDANCY - - STANDARD_IA - - ONEZONE_IA - - INTELLIGENT_TIERING - - GLACIER - - DEEP_ARCHIVE - - OUTPOSTS - - GLACIER_IR - type: string - - description: '

If the bucket is configured as a website, redirects requests - for this object to another object in the same bucket or to an external URL. - Amazon S3 stores the value of this header in the object metadata. For information - about object metadata, see Object - Key and Metadata.

In the following example, the request header - sets the redirect to an object (anotherPage.html) in the same bucket:

-

x-amz-website-redirect-location: /anotherPage.html

-

In the following example, the request header sets the object redirect - to another website:

x-amz-website-redirect-location: http://www.example.com/ -

For more information about website hosting in Amazon S3, see Hosting - Websites on Amazon S3 and How - to Configure Website Page Redirects.

' - in: header - name: x-amz-website-redirect-location - required: false - schema: - type: string - - description: Specifies the algorithm to use to when encrypting the object - (for example, AES256). - in: header - name: x-amz-server-side-encryption-customer-algorithm - required: false - schema: - type: string - - description: Specifies the customer-provided encryption key for Amazon S3 - to use in encrypting data. This value is used to store the object and then - it is discarded; Amazon S3 does not store the encryption key. The key must - be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm - header. - in: header - name: x-amz-server-side-encryption-customer-key - required: false - schema: - format: password - type: string - - description: Specifies the 128-bit MD5 digest of the encryption key according - to RFC 1321. Amazon S3 uses this header for a message integrity check to - ensure that the encryption key was transmitted without error. - in: header - name: x-amz-server-side-encryption-customer-key-MD5 - required: false - schema: - type: string - - description: 'If x-amz-server-side-encryption is present and - has the value of aws:kms, this header specifies the ID of the - Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetrical - customer managed key that was used for the object. If you specify x-amz-server-side-encryption:aws:kms, - but do not provide x-amz-server-side-encryption-aws-kms-key-id, - Amazon S3 uses the Amazon Web Services managed key to protect the data. - If the KMS key does not exist in the same account issuing the command, you - must use the full ARN and not just the ID. ' - in: header - name: x-amz-server-side-encryption-aws-kms-key-id - required: false - schema: - format: password - type: string - - description: Specifies the Amazon Web Services KMS Encryption Context to use - for object encryption. The value of this header is a base64-encoded UTF-8 - string holding JSON with the encryption context key-value pairs. - in: header - name: x-amz-server-side-encryption-context - required: false - schema: - format: password - type: string - - description: "

Specifies whether Amazon S3 should use an S3 Bucket Key for\ - \ object encryption with server-side encryption using AWS KMS (SSE-KMS).\ - \ Setting this header to true causes Amazon S3 to use an S3\ - \ Bucket Key for object encryption with SSE-KMS.

Specifying this\ - \ header with a PUT action doesn\u2019t affect bucket-level settings for\ - \ S3 Bucket Key.

" - in: header - name: x-amz-server-side-encryption-bucket-key-enabled - required: false - schema: - type: boolean - - description: '' - in: header - name: x-amz-request-payer - required: false - schema: - description: Confirms that the requester knows that they will be charged - for the request. Bucket owners need not specify this parameter in their - requests. For information about downloading objects from Requester Pays - buckets, see Downloading - Objects in Requester Pays Buckets in the Amazon S3 User Guide. - enum: - - requester - type: string - - description: The tag-set for the object. The tag-set must be encoded as URL - Query parameters. (For example, "Key1=Value1") - in: header - name: x-amz-tagging - required: false - schema: - type: string - - description: The Object Lock mode that you want to apply to this object. - in: header - name: x-amz-object-lock-mode - required: false - schema: - enum: - - GOVERNANCE - - COMPLIANCE - type: string - - description: The date and time when you want this object's Object Lock to - expire. Must be formatted as a timestamp parameter. - in: header - name: x-amz-object-lock-retain-until-date - required: false - schema: - format: date-time - type: string - - description: Specifies whether a legal hold will be applied to this object. - For more information about S3 Object Lock, see Object - Lock. - in: header - name: x-amz-object-lock-legal-hold - required: false - schema: - enum: - - 'ON' - - 'OFF' - type: string - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - requestBody: - content: - text/xml: - schema: - properties: - Body: - description: Object data. - type: string - x-amz-meta-: - additionalProperties: - $ref: '#/components/schemas/MetadataValue' - description: A map of metadata to store with the object in S3. - type: object - type: object - required: true - responses: - '200': - content: - text/xml: - schema: - $ref: '#/components/schemas/PutObjectOutput' - description: Success - /{Key}#partNumber&uploadId: - parameters: - - $ref: '#/components/parameters/x-amz-security-token' - put: - description: '

Uploads a part in a multipart upload.

In this - operation, you provide part data in your request. However, you have an option - to specify your existing Amazon S3 object as a data source for the part you - are uploading. To upload a part from an existing object, you use the UploadPartCopy - operation.

You must initiate a multipart upload (see CreateMultipartUpload) - before you can upload any part. In response to your initiate request, Amazon - S3 returns an upload ID, a unique identifier, that you must include in your - upload part request.

Part numbers can be any number from 1 to 10,000, - inclusive. A part number uniquely identifies a part and also defines its position - within the object being created. If you upload a new part using the same part - number that was used with a previous part, the previously uploaded part is - overwritten.

For information about maximum and minimum part sizes and - other multipart upload specifications, see Multipart - upload limits in the Amazon S3 User Guide.

To ensure that - data is not corrupted when traversing the network, specify the Content-MD5 - header in the upload part request. Amazon S3 checks the part data against - the provided MD5 value. If they do not match, Amazon S3 returns an error. -

If the upload request is signed with Signature Version 4, then Amazon - Web Services S3 uses the x-amz-content-sha256 header as a checksum - instead of Content-MD5. For more information see Authenticating - Requests: Using the Authorization Header (Amazon Web Services Signature Version - 4).

Note: After you initiate multipart upload and upload - one or more parts, you must either complete or abort multipart upload in order - to stop getting charged for storage of the uploaded parts. Only after you - either complete or abort multipart upload, Amazon S3 frees up the parts storage - and stops charging you for the parts storage.

For more information - on multipart uploads, go to Multipart - Upload Overview in the Amazon S3 User Guide .

For information - on the permissions required to use the multipart upload API, go to Multipart - Upload and Permissions in the Amazon S3 User Guide.

You - can optionally request server-side encryption where Amazon S3 encrypts your - data as it writes it to disks in its data centers and decrypts it for you - when you access it. You have the option of providing your own encryption key, - or you can use the Amazon Web Services managed encryption keys. If you choose - to provide your own encryption key, the request headers you provide in the - request must match the headers you used in the request to initiate the upload - by using CreateMultipartUpload. - For more information, go to Using - Server-Side Encryption in the Amazon S3 User Guide.

Server-side - encryption is supported by the S3 Multipart Upload actions. Unless you are - using a customer-provided encryption key, you don''t need to specify the encryption - parameters in each UploadPart request. Instead, you only need to specify the - server-side encryption parameters in the initial Initiate Multipart request. - For more information, see CreateMultipartUpload.

-

If you requested server-side encryption using a customer-provided encryption - key in your initiate multipart upload request, you must provide identical - encryption information in each part upload using the following headers.

-

  • x-amz-server-side-encryption-customer-algorithm

  • -

    x-amz-server-side-encryption-customer-key

  • x-amz-server-side-encryption-customer-key-MD5

    -

Special Errors

    • -

      Code: NoSuchUpload

    • Cause: The specified - multipart upload does not exist. The upload ID might be invalid, or the multipart - upload might have been aborted or completed.

    • HTTP - Status Code: 404 Not Found

    • SOAP Fault Code Prefix: - Client

Related Resources -

' - externalDocs: - url: http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadUploadPart.html - operationId: UploadPart - parameters: - - description: Size of the body in bytes. This parameter is useful when the - size of the body cannot be determined automatically. - in: header - name: Content-Length - required: false - schema: - type: integer - - description: The base64-encoded 128-bit MD5 digest of the part data. This - parameter is auto-populated when using the command from the CLI. This parameter - is required if object lock parameters are specified. - in: header - name: Content-MD5 - required: false - schema: - type: string - - description:

Indicates the algorithm used to create the checksum for the - object when using the SDK. This header will not provide any additional functionality - if not using the SDK. When sending this header, there must be a corresponding - x-amz-checksum or x-amz-trailer header sent. Otherwise, - Amazon S3 fails the request with the HTTP status code 400 Bad Request. - For more information, see Checking - object integrity in the Amazon S3 User Guide.

If you provide - an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm - parameter.

This checksum algorithm must be the same for all parts - and it match the checksum value supplied in the CreateMultipartUpload - request.

- in: header - name: x-amz-sdk-checksum-algorithm - required: false - schema: - enum: - - CRC32 - - CRC32C - - SHA1 - - SHA256 - type: string - - description: This header can be used as a data integrity check to verify that - the data received is the same data that was originally sent. This header - specifies the base64-encoded, 32-bit CRC32 checksum of the object. For more - information, see Checking - object integrity in the Amazon S3 User Guide. - in: header - name: x-amz-checksum-crc32 - required: false - schema: - type: string - - description: This header can be used as a data integrity check to verify that - the data received is the same data that was originally sent. This header - specifies the base64-encoded, 32-bit CRC32C checksum of the object. For - more information, see Checking - object integrity in the Amazon S3 User Guide. - in: header - name: x-amz-checksum-crc32c - required: false - schema: - type: string - - description: This header can be used as a data integrity check to verify that - the data received is the same data that was originally sent. This header - specifies the base64-encoded, 160-bit SHA-1 digest of the object. For more - information, see Checking - object integrity in the Amazon S3 User Guide. - in: header - name: x-amz-checksum-sha1 - required: false - schema: - type: string - - description: This header can be used as a data integrity check to verify that - the data received is the same data that was originally sent. This header - specifies the base64-encoded, 256-bit SHA-256 digest of the object. For - more information, see Checking - object integrity in the Amazon S3 User Guide. - in: header - name: x-amz-checksum-sha256 - required: false - schema: - type: string - - description: Object key for which the multipart upload was initiated. - in: path - name: Key - required: true - schema: - minLength: 1 - type: string - - description: Part number of part being uploaded. This is a positive integer - between 1 and 10,000. - in: query - name: partNumber - required: true - schema: - type: integer - - description: Upload ID identifying the multipart upload whose part is being - uploaded. - in: query - name: uploadId - required: true - schema: - type: string - - description: Specifies the algorithm to use to when encrypting the object - (for example, AES256). - in: header - name: x-amz-server-side-encryption-customer-algorithm - required: false - schema: - type: string - - description: Specifies the customer-provided encryption key for Amazon S3 - to use in encrypting data. This value is used to store the object and then - it is discarded; Amazon S3 does not store the encryption key. The key must - be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm - header. This must be the same encryption key specified in the initiate - multipart upload request. - in: header - name: x-amz-server-side-encryption-customer-key - required: false - schema: - format: password - type: string - - description: Specifies the 128-bit MD5 digest of the encryption key according - to RFC 1321. Amazon S3 uses this header for a message integrity check to - ensure that the encryption key was transmitted without error. - in: header - name: x-amz-server-side-encryption-customer-key-MD5 - required: false - schema: - type: string - - description: '' - in: header - name: x-amz-request-payer - required: false - schema: - description: Confirms that the requester knows that they will be charged - for the request. Bucket owners need not specify this parameter in their - requests. For information about downloading objects from Requester Pays - buckets, see Downloading - Objects in Requester Pays Buckets in the Amazon S3 User Guide. - enum: - - requester - type: string - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - requestBody: - content: - text/xml: - schema: - properties: - Body: - description: Object data. - type: string - type: object - required: true - responses: - '200': - content: - text/xml: - schema: - $ref: '#/components/schemas/UploadPartOutput' - description: Success - /{Key}#uploadId: - delete: - description:

This action aborts a multipart upload. After a multipart upload - is aborted, no additional parts can be uploaded using that upload ID. The - storage consumed by any previously uploaded parts will be freed. However, - if any part uploads are currently in progress, those part uploads might or - might not succeed. As a result, it might be necessary to abort a given multipart - upload multiple times in order to completely free all storage consumed by - all parts.

To verify that all parts have been removed, so you don't - get charged for the part storage, you should call the ListParts - action and ensure that the parts list is empty.

For information about - permissions required to use the multipart upload, see Multipart - Upload and Permissions.

The following operations are related to - AbortMultipartUpload:

- externalDocs: - url: http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadAbort.html - operationId: AbortMultipartUpload - parameters: - - description: Key of the object for which the multipart upload was initiated. - in: path - name: Key - required: true - schema: - minLength: 1 - type: string - - description: Upload ID that identifies the multipart upload. - in: query - name: uploadId - required: true - schema: - type: string - - description: '' - in: header - name: x-amz-request-payer - required: false - schema: - description: Confirms that the requester knows that they will be charged - for the request. Bucket owners need not specify this parameter in their - requests. For information about downloading objects from Requester Pays - buckets, see Downloading - Objects in Requester Pays Buckets in the Amazon S3 User Guide. - enum: - - requester - type: string - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - responses: - '204': - content: - text/xml: - schema: - $ref: '#/components/schemas/AbortMultipartUploadOutput' - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchUpload' - description: NoSuchUpload - get: - description:

Lists the parts that have been uploaded for a specific multipart - upload. This operation must include the upload ID, which you obtain by sending - the initiate multipart upload request (see CreateMultipartUpload). - This request returns a maximum of 1,000 uploaded parts. The default number - of parts returned is 1,000 parts. You can restrict the number of parts returned - by specifying the max-parts request parameter. If your multipart - upload consists of more than 1,000 parts, the response returns an IsTruncated - field with the value of true, and a NextPartNumberMarker element. - In subsequent ListParts requests you can include the part-number-marker - query string parameter and set its value to the NextPartNumberMarker - field value from the previous response.

If the upload was created using - a checksum algorithm, you will need to have permission to the kms:Decrypt - action for the request to succeed.

For more information on multipart - uploads, see Uploading - Objects Using Multipart Upload.

For information on permissions - required to use the multipart upload API, see Multipart - Upload and Permissions.

The following operations are related to - ListParts:

- externalDocs: - url: http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadListParts.html - operationId: ListParts - parameters: - - description: Object key for which the multipart upload was initiated. - in: path - name: Key - required: true - schema: - minLength: 1 - type: string - - description: Sets the maximum number of parts to return. - in: query - name: max-parts - required: false - schema: - type: integer - - description: Specifies the part after which listing should begin. Only parts - with higher part numbers will be listed. - in: query - name: part-number-marker - required: false - schema: - type: integer - - description: Upload ID identifying the multipart upload whose parts are being - listed. - in: query - name: uploadId - required: true - schema: - type: string - - description: '' - in: header - name: x-amz-request-payer - required: false - schema: - description: Confirms that the requester knows that they will be charged - for the request. Bucket owners need not specify this parameter in their - requests. For information about downloading objects from Requester Pays - buckets, see Downloading - Objects in Requester Pays Buckets in the Amazon S3 User Guide. - enum: - - requester - type: string - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - description: The server-side encryption (SSE) algorithm used to encrypt the - object. This parameter is needed only when the object was created using - a checksum algorithm. For more information, see Protecting - data using SSE-C keys in the Amazon S3 User Guide. - in: header - name: x-amz-server-side-encryption-customer-algorithm - required: false - schema: - type: string - - description: The server-side encryption (SSE) customer managed key. This parameter - is needed only when the object was created using a checksum algorithm. For - more information, see Protecting - data using SSE-C keys in the Amazon S3 User Guide. - in: header - name: x-amz-server-side-encryption-customer-key - required: false - schema: - format: password - type: string - - description: The MD5 server-side encryption (SSE) customer managed key. This - parameter is needed only when the object was created using a checksum algorithm. - For more information, see Protecting - data using SSE-C keys in the Amazon S3 User Guide. - in: header - name: x-amz-server-side-encryption-customer-key-MD5 - required: false - schema: - type: string - - description: Pagination limit - in: query - name: MaxParts - required: false - schema: - type: string - - description: Pagination token - in: query - name: PartNumberMarker - required: false - schema: - type: string - responses: - '200': - content: - text/xml: - schema: - $ref: '#/components/schemas/ListPartsOutput' - description: Success - parameters: - - $ref: '#/components/parameters/x-amz-security-token' - post: - description: '

Completes a multipart upload by assembling previously uploaded - parts.

You first initiate the multipart upload and then upload all - parts using the UploadPart - operation. After successfully uploading all relevant parts of an upload, you - call this action to complete the upload. Upon receiving this request, Amazon - S3 concatenates all the parts in ascending order by part number to create - a new object. In the Complete Multipart Upload request, you must provide the - parts list. You must ensure that the parts list is complete. This action concatenates - the parts that you provide in the list. For each part in the list, you must - provide the part number and the ETag value, returned after that - part was uploaded.

Processing of a Complete Multipart Upload request - could take several minutes to complete. After Amazon S3 begins processing - the request, it sends an HTTP response header that specifies a 200 OK response. - While processing is in progress, Amazon S3 periodically sends white space - characters to keep the connection from timing out. Because a request could - fail after the initial 200 OK response has been sent, it is important that - you check the response body to determine whether the request succeeded.

-

Note that if CompleteMultipartUpload fails, applications should - be prepared to retry the failed requests. For more information, see Amazon - S3 Error Best Practices.

You cannot use Content-Type: - application/x-www-form-urlencoded with Complete Multipart Upload requests. - Also, if you do not provide a Content-Type header, CompleteMultipartUpload - returns a 200 OK response.

For more information about - multipart uploads, see Uploading - Objects Using Multipart Upload.

For information about permissions - required to use the multipart upload API, see Multipart - Upload and Permissions.

CompleteMultipartUpload has - the following special errors:

  • Error code: EntityTooSmall -

    • Description: Your proposed upload is smaller than the minimum - allowed object size. Each part must be at least 5 MB in size, except the last - part.

    • 400 Bad Request

  • Error - code: InvalidPart

    • Description: One or more - of the specified parts could not be found. The part might not have been uploaded, - or the specified entity tag might not have matched the part''s entity tag.

      -

    • 400 Bad Request

  • Error code: InvalidPartOrder -

    • Description: The list of parts was not in ascending order. - The parts list must be specified in order by part number.

    • 400 - Bad Request

  • Error code: NoSuchUpload -

    • Description: The specified multipart upload does not exist. - The upload ID might be invalid, or the multipart upload might have been aborted - or completed.

    • 404 Not Found

-

The following operations are related to CompleteMultipartUpload:

- ' - externalDocs: - url: http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadComplete.html - operationId: CompleteMultipartUpload - parameters: - - description: Object key for which the multipart upload was initiated. - in: path - name: Key - required: true - schema: - minLength: 1 - type: string - - description: ID for the initiated multipart upload. - in: query - name: uploadId - required: true - schema: - type: string - - description: This header can be used as a data integrity check to verify that - the data received is the same data that was originally sent. This header - specifies the base64-encoded, 32-bit CRC32 checksum of the object. For more - information, see Checking - object integrity in the Amazon S3 User Guide. - in: header - name: x-amz-checksum-crc32 - required: false - schema: - type: string - - description: This header can be used as a data integrity check to verify that - the data received is the same data that was originally sent. This header - specifies the base64-encoded, 32-bit CRC32C checksum of the object. For - more information, see Checking - object integrity in the Amazon S3 User Guide. - in: header - name: x-amz-checksum-crc32c - required: false - schema: - type: string - - description: This header can be used as a data integrity check to verify that - the data received is the same data that was originally sent. This header - specifies the base64-encoded, 160-bit SHA-1 digest of the object. For more - information, see Checking - object integrity in the Amazon S3 User Guide. - in: header - name: x-amz-checksum-sha1 - required: false - schema: - type: string - - description: This header can be used as a data integrity check to verify that - the data received is the same data that was originally sent. This header - specifies the base64-encoded, 256-bit SHA-256 digest of the object. For - more information, see Checking - object integrity in the Amazon S3 User Guide. - in: header - name: x-amz-checksum-sha256 - required: false - schema: - type: string - - description: '' - in: header - name: x-amz-request-payer - required: false - schema: - description: Confirms that the requester knows that they will be charged - for the request. Bucket owners need not specify this parameter in their - requests. For information about downloading objects from Requester Pays - buckets, see Downloading - Objects in Requester Pays Buckets in the Amazon S3 User Guide. - enum: - - requester - type: string - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - description: The server-side encryption (SSE) algorithm used to encrypt the - object. This parameter is needed only when the object was created using - a checksum algorithm. For more information, see Protecting - data using SSE-C keys in the Amazon S3 User Guide. - in: header - name: x-amz-server-side-encryption-customer-algorithm - required: false - schema: - type: string - - description: The server-side encryption (SSE) customer managed key. This parameter - is needed only when the object was created using a checksum algorithm. For - more information, see Protecting - data using SSE-C keys in the Amazon S3 User Guide. - in: header - name: x-amz-server-side-encryption-customer-key - required: false - schema: - format: password - type: string - - description: The MD5 server-side encryption (SSE) customer managed key. This - parameter is needed only when the object was created using a checksum algorithm. - For more information, see Protecting - data using SSE-C keys in the Amazon S3 User Guide. - in: header - name: x-amz-server-side-encryption-customer-key-MD5 - required: false - schema: - type: string - requestBody: - content: - text/xml: - schema: - properties: - CompleteMultipartUpload: - description: The container for the completed multipart upload details. - properties: - Part: - allOf: - - $ref: '#/components/schemas/CompletedPartList' - - description:

Array of CompletedPart data types.

If - you do not supply a valid Part with your request, - the service sends back an HTTP 400 response.

- type: object - type: object - required: true - responses: - '200': - content: - text/xml: - schema: - $ref: '#/components/schemas/CompleteMultipartUploadOutput' - description: Success - /{Key}#x-amz-copy-source: - parameters: - - $ref: '#/components/parameters/x-amz-security-token' - put: - description:

Creates a copy of an object that is already stored in Amazon - S3.

You can store individual objects of up to 5 TB in Amazon - S3. You create a copy of your object up to 5 GB in size in a single atomic - action using this API. However, to copy an object greater than 5 GB, you must - use the multipart upload Upload Part - Copy (UploadPartCopy) API. For more - information, see Copy - Object Using the REST Multipart Upload API.

All copy requests - must be authenticated. Additionally, you must have read access to the - source object and write access to the destination bucket. For more - information, see REST - Authentication. Both the Region that you want to copy the object from - and the Region that you want to copy the object to must be enabled for your - account.

A copy request might return an error when Amazon S3 receives - the copy request or while Amazon S3 is copying the files. If the error occurs - before the copy action starts, you receive a standard Amazon S3 error. If - the error occurs during the copy operation, the error response is embedded - in the 200 OK response. This means that a 200 OK - response can contain either a success or an error. Design your application - to parse the contents of the response and handle it appropriately.

If - the copy is successful, you receive a response with information about the - copied object.

If the request is an HTTP 1.1 request, the response - is chunk encoded. If it were not, it would not contain the content-length, - and you would need to read the entire body.

The copy request - charge is based on the storage class and Region that you specify for the destination - object. For pricing information, see Amazon - S3 pricing.

Amazon S3 transfer acceleration does not - support cross-Region copies. If you request a cross-Region copy using a transfer - acceleration endpoint, you get a 400 Bad Request error. For more - information, see Transfer - Acceleration.

Metadata

When copying - an object, you can preserve all metadata (default) or specify new metadata. - However, the ACL is not preserved and is set to private for the user making - the request. To override the default ACL setting, specify a new ACL when generating - a copy request. For more information, see Using - ACLs.

To specify whether you want the object metadata copied from - the source object or replaced with metadata provided in the request, you can - optionally add the x-amz-metadata-directive header. When you - grant permissions, you can use the s3:x-amz-metadata-directive - condition key to enforce certain metadata behavior when objects are uploaded. - For more information, see Specifying - Conditions in a Policy in the Amazon S3 User Guide. For a complete - list of Amazon S3-specific condition keys, see Actions, - Resources, and Condition Keys for Amazon S3.

x-amz-copy-source-if - Headers

To only copy an object under certain conditions, such - as whether the Etag matches or whether the object was modified - before or after a specified date, use the following request parameters:

-

  • x-amz-copy-source-if-match

  • - x-amz-copy-source-if-none-match

  • x-amz-copy-source-if-unmodified-since -

  • x-amz-copy-source-if-modified-since

    -

If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since - headers are present in the request and evaluate as follows, Amazon S3 returns - 200 OK and copies the data:

  • x-amz-copy-source-if-match - condition evaluates to true

  • x-amz-copy-source-if-unmodified-since - condition evaluates to false

If both the x-amz-copy-source-if-none-match - and x-amz-copy-source-if-modified-since headers are present in - the request and evaluate as follows, Amazon S3 returns the 412 Precondition - Failed response code:

  • x-amz-copy-source-if-none-match - condition evaluates to false

  • x-amz-copy-source-if-modified-since - condition evaluates to true

All headers with the - x-amz- prefix, including x-amz-copy-source, must - be signed.

Server-side encryption

When you - perform a CopyObject operation, you can optionally use the appropriate encryption-related - headers to encrypt the object using server-side encryption with Amazon Web - Services managed encryption keys (SSE-S3 or SSE-KMS) or a customer-provided - encryption key. With server-side encryption, Amazon S3 encrypts your data - as it writes it to disks in its data centers and decrypts the data when you - access it. For more information about server-side encryption, see Using - Server-Side Encryption.

If a target object uses SSE-KMS, you can - enable an S3 Bucket Key for the object. For more information, see Amazon - S3 Bucket Keys in the Amazon S3 User Guide.

Access Control - List (ACL)-Specific Request Headers

When copying an object, you - can optionally use headers to grant ACL-based permissions. By default, all - objects are private. Only the owner has full access control. When adding a - new object, you can grant permissions to individual Amazon Web Services accounts - or to predefined groups defined by Amazon S3. These permissions are then added - to the ACL on the object. For more information, see Access - Control List (ACL) Overview and Managing - ACLs Using the REST API.

If the bucket that you're copying objects - to uses the bucket owner enforced setting for S3 Object Ownership, ACLs are - disabled and no longer affect permissions. Buckets that use this setting only - accept PUT requests that don't specify an ACL or PUT requests that specify - bucket owner full control ACLs, such as the bucket-owner-full-control - canned ACL or an equivalent form of this ACL expressed in the XML format.

-

For more information, see - Controlling ownership of objects and disabling ACLs in the Amazon S3 - User Guide.

If your bucket uses the bucket owner enforced - setting for Object Ownership, all objects written to the bucket by any account - will be owned by the bucket owner.

Checksums

When - copying an object, if it has a checksum, that checksum will be copied to the - new object by default. When you copy the object over, you may optionally specify - a different checksum algorithm to use with the x-amz-checksum-algorithm - header.

Storage Class Options

You can use the CopyObject - action to change the storage class of an object that is already stored in - Amazon S3 using the StorageClass parameter. For more information, - see Storage - Classes in the Amazon S3 User Guide.

Versioning -

By default, x-amz-copy-source identifies the current - version of an object to copy. If the current version is a delete marker, Amazon - S3 behaves as if the object was deleted. To copy a different version, use - the versionId subresource.

If you enable versioning on - the target bucket, Amazon S3 generates a unique version ID for the object - being copied. This version ID is different from the version ID of the source - object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id - response header in the response.

If you do not enable versioning or - suspend it on the target bucket, the version ID that Amazon S3 generates is - always null.

If the source object's storage class is GLACIER, you must - restore a copy of this object before you can use it as a source object for - the copy operation. For more information, see RestoreObject.

-

The following operations are related to CopyObject:

For more information, see Copying - Objects.

- externalDocs: - url: http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectCOPY.html - operationId: CopyObject - parameters: - - description:

The canned ACL to apply to the object.

This action - is not supported by Amazon S3 on Outposts.

- in: header - name: x-amz-acl - required: false - schema: - enum: - - private - - public-read - - public-read-write - - authenticated-read - - aws-exec-read - - bucket-owner-read - - bucket-owner-full-control - type: string - - description: Specifies caching behavior along the request/reply chain. - in: header - name: Cache-Control - required: false - schema: - type: string - - description: Indicates the algorithm you want Amazon S3 to use to create the - checksum for the object. For more information, see Checking - object integrity in the Amazon S3 User Guide. - in: header - name: x-amz-checksum-algorithm - required: false - schema: - enum: - - CRC32 - - CRC32C - - SHA1 - - SHA256 - type: string - - description: Specifies presentational information for the object. - in: header - name: Content-Disposition - required: false - schema: - type: string - - description: Specifies what content encodings have been applied to the object - and thus what decoding mechanisms must be applied to obtain the media-type - referenced by the Content-Type header field. - in: header - name: Content-Encoding - required: false - schema: - type: string - - description: The language the content is in. - in: header - name: Content-Language - required: false - schema: - type: string - - description: A standard MIME type describing the format of the object data. - in: header - name: Content-Type - required: false - schema: - type: string - - description:

Specifies the source object for the copy operation. You specify - the value in one of two formats, depending on whether you want to access - the source object through an access - point:

  • For objects not accessed through an access point, - specify the name of the source bucket and the key of the source object, - separated by a slash (/). For example, to copy the object reports/january.pdf - from the bucket awsexamplebucket, use awsexamplebucket/reports/january.pdf. - The value must be URL-encoded.

  • For objects accessed through - access points, specify the Amazon Resource Name (ARN) of the object as accessed - through the access point, in the format arn:aws:s3:<Region>:<account-id>:accesspoint/<access-point-name>/object/<key>. - For example, to copy the object reports/january.pdf through - access point my-access-point owned by account 123456789012 - in Region us-west-2, use the URL encoding of arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf. - The value must be URL encoded.

    Amazon S3 supports copy operations - using access points only when the source and destination buckets are in - the same Amazon Web Services Region.

    Alternatively, for objects - accessed through Amazon S3 on Outposts, specify the ARN of the object as - accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/object/<key>. - For example, to copy the object reports/january.pdf through - outpost my-outpost owned by account 123456789012 - in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf. - The value must be URL-encoded.

To copy a specific version - of an object, append ?versionId=<version-id> to the value - (for example, awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893). - If you don't specify a version ID, Amazon S3 copies the latest version of - the source object.

- in: header - name: x-amz-copy-source - required: true - schema: - pattern: \/.+\/.+ - type: string - - description: Copies the object if its entity tag (ETag) matches the specified - tag. - in: header - name: x-amz-copy-source-if-match - required: false - schema: - type: string - - description: Copies the object if it has been modified since the specified - time. - in: header - name: x-amz-copy-source-if-modified-since - required: false - schema: - format: date-time - type: string - - description: Copies the object if its entity tag (ETag) is different than - the specified ETag. - in: header - name: x-amz-copy-source-if-none-match - required: false - schema: - type: string - - description: Copies the object if it hasn't been modified since the specified - time. - in: header - name: x-amz-copy-source-if-unmodified-since - required: false - schema: - format: date-time - type: string - - description: The date and time at which the object is no longer cacheable. - in: header - name: Expires - required: false - schema: - format: date-time - type: string - - description:

Gives the grantee READ, READ_ACP, and WRITE_ACP permissions - on the object.

This action is not supported by Amazon S3 on Outposts.

- in: header - name: x-amz-grant-full-control - required: false - schema: - type: string - - description:

Allows grantee to read the object data and its metadata.

-

This action is not supported by Amazon S3 on Outposts.

- in: header - name: x-amz-grant-read - required: false - schema: - type: string - - description:

Allows grantee to read the object ACL.

This action - is not supported by Amazon S3 on Outposts.

- in: header - name: x-amz-grant-read-acp - required: false - schema: - type: string - - description:

Allows grantee to write the ACL for the applicable object.

-

This action is not supported by Amazon S3 on Outposts.

- in: header - name: x-amz-grant-write-acp - required: false - schema: - type: string - - description: The key of the destination object. - in: path - name: Key - required: true - schema: - minLength: 1 - type: string - - description: Specifies whether the metadata is copied from the source object - or replaced with metadata provided in the request. - in: header - name: x-amz-metadata-directive - required: false - schema: - enum: - - COPY - - REPLACE - type: string - - description: Specifies whether the object tag-set are copied from the source - object or replaced with tag-set provided in the request. - in: header - name: x-amz-tagging-directive - required: false - schema: - enum: - - COPY - - REPLACE - type: string - - description: The server-side encryption algorithm used when storing this object - in Amazon S3 (for example, AES256, aws:kms). - in: header - name: x-amz-server-side-encryption - required: false - schema: - enum: - - AES256 - - aws:kms - type: string - - description: By default, Amazon S3 uses the STANDARD Storage Class to store - newly created objects. The STANDARD storage class provides high durability - and high availability. Depending on performance needs, you can specify a - different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage - Class. For more information, see Storage - Classes in the Amazon S3 User Guide. - in: header - name: x-amz-storage-class - required: false - schema: - enum: - - STANDARD - - REDUCED_REDUNDANCY - - STANDARD_IA - - ONEZONE_IA - - INTELLIGENT_TIERING - - GLACIER - - DEEP_ARCHIVE - - OUTPOSTS - - GLACIER_IR - type: string - - description: If the bucket is configured as a website, redirects requests - for this object to another object in the same bucket or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - in: header - name: x-amz-website-redirect-location - required: false - schema: - type: string - - description: Specifies the algorithm to use to when encrypting the object - (for example, AES256). - in: header - name: x-amz-server-side-encryption-customer-algorithm - required: false - schema: - type: string - - description: Specifies the customer-provided encryption key for Amazon S3 - to use in encrypting data. This value is used to store the object and then - it is discarded; Amazon S3 does not store the encryption key. The key must - be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm - header. - in: header - name: x-amz-server-side-encryption-customer-key - required: false - schema: - format: password - type: string - - description: Specifies the 128-bit MD5 digest of the encryption key according - to RFC 1321. Amazon S3 uses this header for a message integrity check to - ensure that the encryption key was transmitted without error. - in: header - name: x-amz-server-side-encryption-customer-key-MD5 - required: false - schema: - type: string - - description: Specifies the Amazon Web Services KMS key ID to use for object - encryption. All GET and PUT requests for an object protected by Amazon Web - Services KMS will fail if not made via SSL or using SigV4. For information - about configuring using any of the officially supported Amazon Web Services - SDKs and Amazon Web Services CLI, see Specifying - the Signature Version in Request Authentication in the Amazon S3 - User Guide. - in: header - name: x-amz-server-side-encryption-aws-kms-key-id - required: false - schema: - format: password - type: string - - description: Specifies the Amazon Web Services KMS Encryption Context to use - for object encryption. The value of this header is a base64-encoded UTF-8 - string holding JSON with the encryption context key-value pairs. - in: header - name: x-amz-server-side-encryption-context - required: false - schema: - format: password - type: string - - description: "

Specifies whether Amazon S3 should use an S3 Bucket Key for\ - \ object encryption with server-side encryption using AWS KMS (SSE-KMS).\ - \ Setting this header to true causes Amazon S3 to use an S3\ - \ Bucket Key for object encryption with SSE-KMS.

Specifying this\ - \ header with a COPY action doesn\u2019t affect bucket-level settings for\ - \ S3 Bucket Key.

" - in: header - name: x-amz-server-side-encryption-bucket-key-enabled - required: false - schema: - type: boolean - - description: Specifies the algorithm to use when decrypting the source object - (for example, AES256). - in: header - name: x-amz-copy-source-server-side-encryption-customer-algorithm - required: false - schema: - type: string - - description: Specifies the customer-provided encryption key for Amazon S3 - to use to decrypt the source object. The encryption key provided in this - header must be one that was used when the source object was created. - in: header - name: x-amz-copy-source-server-side-encryption-customer-key - required: false - schema: - format: password - type: string - - description: Specifies the 128-bit MD5 digest of the encryption key according - to RFC 1321. Amazon S3 uses this header for a message integrity check to - ensure that the encryption key was transmitted without error. - in: header - name: x-amz-copy-source-server-side-encryption-customer-key-MD5 - required: false - schema: - type: string - - description: '' - in: header - name: x-amz-request-payer - required: false - schema: - description: Confirms that the requester knows that they will be charged - for the request. Bucket owners need not specify this parameter in their - requests. For information about downloading objects from Requester Pays - buckets, see Downloading - Objects in Requester Pays Buckets in the Amazon S3 User Guide. - enum: - - requester - type: string - - description: The tag-set for the object destination object this value must - be used in conjunction with the TaggingDirective. The tag-set - must be encoded as URL Query parameters. - in: header - name: x-amz-tagging - required: false - schema: - type: string - - description: The Object Lock mode that you want to apply to the copied object. - in: header - name: x-amz-object-lock-mode - required: false - schema: - enum: - - GOVERNANCE - - COMPLIANCE - type: string - - description: The date and time when you want the copied object's Object Lock - to expire. - in: header - name: x-amz-object-lock-retain-until-date - required: false - schema: - format: date-time - type: string - - description: Specifies whether you want to apply a legal hold to the copied - object. - in: header - name: x-amz-object-lock-legal-hold - required: false - schema: - enum: - - 'ON' - - 'OFF' - type: string - - description: The account ID of the expected destination bucket owner. If the - destination bucket is owned by a different account, the request fails with - the HTTP status code 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - description: The account ID of the expected source bucket owner. If the source - bucket is owned by a different account, the request fails with the HTTP - status code 403 Forbidden (access denied). - in: header - name: x-amz-source-expected-bucket-owner - required: false - schema: - type: string - requestBody: - content: - text/xml: - schema: - properties: - x-amz-meta-: - additionalProperties: - $ref: '#/components/schemas/MetadataValue' - description: A map of metadata to store with the object in S3. - type: object - type: object - required: true - responses: - '200': - content: - text/xml: - schema: - $ref: '#/components/schemas/CopyObjectOutput' - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/ObjectNotInActiveTierError' - description: ObjectNotInActiveTierError - /{Key}#x-amz-copy-source&partNumber&uploadId: - parameters: - - $ref: '#/components/parameters/x-amz-security-token' - put: - description: '

Uploads a part by copying data from an existing object as data - source. You specify the data source by adding the request header x-amz-copy-source - in your request and a byte range by adding the request header x-amz-copy-source-range - in your request.

For information about maximum and minimum part sizes - and other multipart upload specifications, see Multipart - upload limits in the Amazon S3 User Guide.

Instead - of using an existing object as part data, you might use the UploadPart - action and provide data in your request.

You must initiate - a multipart upload before you can upload any part. In response to your initiate - request. Amazon S3 returns a unique identifier, the upload ID, that you must - include in your upload part request.

For more information about using - the UploadPartCopy operation, see the following:

  • -

    For conceptual information about multipart uploads, see Uploading - Objects Using Multipart Upload in the Amazon S3 User Guide.

    -

  • For information about permissions required to use the multipart - upload API, see Multipart - Upload and Permissions in the Amazon S3 User Guide.

  • -

    For information about copying objects using a single atomic action vs. - a multipart upload, see Operations - on Objects in the Amazon S3 User Guide.

  • For information - about using server-side encryption with customer-provided encryption keys - with the UploadPartCopy operation, see CopyObject - and UploadPart.

    -

Note the following additional considerations about the request - headers x-amz-copy-source-if-match, x-amz-copy-source-if-none-match, - x-amz-copy-source-if-unmodified-since, and x-amz-copy-source-if-modified-since:

-

  • Consideration 1 - If both of the x-amz-copy-source-if-match - and x-amz-copy-source-if-unmodified-since headers are present - in the request as follows:

    x-amz-copy-source-if-match - condition evaluates to true, and;

    x-amz-copy-source-if-unmodified-since - condition evaluates to false;

    Amazon S3 returns 200 - OK and copies the data.

  • Consideration 2 - - If both of the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since - headers are present in the request as follows:

    x-amz-copy-source-if-none-match - condition evaluates to false, and;

    x-amz-copy-source-if-modified-since - condition evaluates to true;

    Amazon S3 returns 412 - Precondition Failed response code.

Versioning -

If your bucket has versioning enabled, you could have multiple versions - of the same object. By default, x-amz-copy-source identifies - the current version of the object to copy. If the current version is a delete - marker and you don''t specify a versionId in the x-amz-copy-source, - Amazon S3 returns a 404 error, because the object does not exist. If you specify - versionId in the x-amz-copy-source and the versionId is a delete - marker, Amazon S3 returns an HTTP 400 error, because you are not allowed to - specify a delete marker as a version for the x-amz-copy-source. -

You can optionally specify a specific version of the source object - to copy by adding the versionId subresource as shown in the following - example:

x-amz-copy-source: /bucket/object?versionId=version - id

Special Errors

    • -

    • Code: NoSuchUpload

    • Cause: The specified - multipart upload does not exist. The upload ID might be invalid, or the multipart - upload might have been aborted or completed.

    • HTTP - Status Code: 404 Not Found

    • Code: - InvalidRequest

    • Cause: The specified copy source - is not supported as a byte-range copy source.

    • HTTP - Status Code: 400 Bad Request

- Related Resources

' - externalDocs: - url: http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadUploadPartCopy.html - operationId: UploadPartCopy - parameters: - - description:

Specifies the source object for the copy operation. You specify - the value in one of two formats, depending on whether you want to access - the source object through an access - point:

  • For objects not accessed through an access point, - specify the name of the source bucket and key of the source object, separated - by a slash (/). For example, to copy the object reports/january.pdf - from the bucket awsexamplebucket, use awsexamplebucket/reports/january.pdf. - The value must be URL-encoded.

  • For objects accessed through - access points, specify the Amazon Resource Name (ARN) of the object as accessed - through the access point, in the format arn:aws:s3:<Region>:<account-id>:accesspoint/<access-point-name>/object/<key>. - For example, to copy the object reports/january.pdf through - access point my-access-point owned by account 123456789012 - in Region us-west-2, use the URL encoding of arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf. - The value must be URL encoded.

    Amazon S3 supports copy operations - using access points only when the source and destination buckets are in - the same Amazon Web Services Region.

    Alternatively, for objects - accessed through Amazon S3 on Outposts, specify the ARN of the object as - accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/object/<key>. - For example, to copy the object reports/january.pdf through - outpost my-outpost owned by account 123456789012 - in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf. - The value must be URL-encoded.

To copy a specific version - of an object, append ?versionId=<version-id> to the value - (for example, awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893). - If you don't specify a version ID, Amazon S3 copies the latest version of - the source object.

- in: header - name: x-amz-copy-source - required: true - schema: - pattern: \/.+\/.+ - type: string - - description: Copies the object if its entity tag (ETag) matches the specified - tag. - in: header - name: x-amz-copy-source-if-match - required: false - schema: - type: string - - description: Copies the object if it has been modified since the specified - time. - in: header - name: x-amz-copy-source-if-modified-since - required: false - schema: - format: date-time - type: string - - description: Copies the object if its entity tag (ETag) is different than - the specified ETag. - in: header - name: x-amz-copy-source-if-none-match - required: false - schema: - type: string - - description: Copies the object if it hasn't been modified since the specified - time. - in: header - name: x-amz-copy-source-if-unmodified-since - required: false - schema: - format: date-time - type: string - - description: The range of bytes to copy from the source object. The range - value must use the form bytes=first-last, where the first and last are the - zero-based byte offsets to copy. For example, bytes=0-9 indicates that you - want to copy the first 10 bytes of the source. You can copy a range only - if the source object is greater than 5 MB. - in: header - name: x-amz-copy-source-range - required: false - schema: - type: string - - description: Object key for which the multipart upload was initiated. - in: path - name: Key - required: true - schema: - minLength: 1 - type: string - - description: Part number of part being copied. This is a positive integer - between 1 and 10,000. - in: query - name: partNumber - required: true - schema: - type: integer - - description: Upload ID identifying the multipart upload whose part is being - copied. - in: query - name: uploadId - required: true - schema: - type: string - - description: Specifies the algorithm to use to when encrypting the object - (for example, AES256). - in: header - name: x-amz-server-side-encryption-customer-algorithm - required: false - schema: - type: string - - description: Specifies the customer-provided encryption key for Amazon S3 - to use in encrypting data. This value is used to store the object and then - it is discarded; Amazon S3 does not store the encryption key. The key must - be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm - header. This must be the same encryption key specified in the initiate multipart - upload request. - in: header - name: x-amz-server-side-encryption-customer-key - required: false - schema: - format: password - type: string - - description: Specifies the 128-bit MD5 digest of the encryption key according - to RFC 1321. Amazon S3 uses this header for a message integrity check to - ensure that the encryption key was transmitted without error. - in: header - name: x-amz-server-side-encryption-customer-key-MD5 - required: false - schema: - type: string - - description: Specifies the algorithm to use when decrypting the source object - (for example, AES256). - in: header - name: x-amz-copy-source-server-side-encryption-customer-algorithm - required: false - schema: - type: string - - description: Specifies the customer-provided encryption key for Amazon S3 - to use to decrypt the source object. The encryption key provided in this - header must be one that was used when the source object was created. - in: header - name: x-amz-copy-source-server-side-encryption-customer-key - required: false - schema: - format: password - type: string - - description: Specifies the 128-bit MD5 digest of the encryption key according - to RFC 1321. Amazon S3 uses this header for a message integrity check to - ensure that the encryption key was transmitted without error. - in: header - name: x-amz-copy-source-server-side-encryption-customer-key-MD5 - required: false - schema: - type: string - - description: '' - in: header - name: x-amz-request-payer - required: false - schema: - description: Confirms that the requester knows that they will be charged - for the request. Bucket owners need not specify this parameter in their - requests. For information about downloading objects from Requester Pays - buckets, see Downloading - Objects in Requester Pays Buckets in the Amazon S3 User Guide. - enum: - - requester - type: string - - description: The account ID of the expected destination bucket owner. If the - destination bucket is owned by a different account, the request fails with - the HTTP status code 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - description: The account ID of the expected source bucket owner. If the source - bucket is owned by a different account, the request fails with the HTTP - status code 403 Forbidden (access denied). - in: header - name: x-amz-source-expected-bucket-owner - required: false - schema: - type: string - responses: - '200': - content: - text/xml: - schema: - $ref: '#/components/schemas/UploadPartCopyOutput' - description: Success - /{Key}?acl: - get: - description:

Returns the access control list (ACL) of an object. To use this - operation, you must have s3:GetObjectAcl permissions or READ_ACP - access to the object. For more information, see Mapping - of ACL permissions and access policy permissions in the Amazon S3 User - Guide

This action is not supported by Amazon S3 on Outposts.

-

Versioning

By default, GET returns ACL information about - the current version of an object. To return ACL information about a different - version, use the versionId subresource.

If your bucket uses - the bucket owner enforced setting for S3 Object Ownership, requests to read - ACLs are still supported and return the bucket-owner-full-control - ACL with the owner being the account that created the bucket. For more information, - see - Controlling object ownership and disabling ACLs in the Amazon S3 User - Guide.

The following operations are related to GetObjectAcl:

- - externalDocs: - url: http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectGETacl.html - operationId: GetObjectAcl - parameters: - - description: The key of the object for which to get the ACL information. - in: path - name: Key - required: true - schema: - minLength: 1 - type: string - - description: VersionId used to reference a specific version of the object. - in: query - name: versionId - required: false - schema: - type: string - - description: '' - in: header - name: x-amz-request-payer - required: false - schema: - description: Confirms that the requester knows that they will be charged - for the request. Bucket owners need not specify this parameter in their - requests. For information about downloading objects from Requester Pays - buckets, see Downloading - Objects in Requester Pays Buckets in the Amazon S3 User Guide. - enum: - - requester - type: string - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: acl - required: true - schema: - enum: - - true - type: boolean - responses: - '200': - content: - text/xml: - schema: - $ref: '#/components/schemas/GetObjectAclOutput' - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchKey' - description: NoSuchKey - parameters: - - $ref: '#/components/parameters/x-amz-security-token' - put: - description: "

Uses the acl subresource to set the access control\ - \ list (ACL) permissions for a new or existing object in an S3 bucket. You\ - \ must have WRITE_ACP permission to set the ACL of an object.\ - \ For more information, see What permissions can I grant? in the Amazon S3 User Guide.

\ - \

This action is not supported by Amazon S3 on Outposts.

Depending\ - \ on your application needs, you can choose to set the ACL on an object using\ - \ either the request body or the headers. For example, if you have an existing\ - \ application that updates a bucket ACL using the request body, you can continue\ - \ to use that approach. For more information, see Access Control List (ACL) Overview in the Amazon S3 User Guide.

\ - \

If your bucket uses the bucket owner enforced setting for\ - \ S3 Object Ownership, ACLs are disabled and no longer affect permissions.\ - \ You must use policies to grant access to your bucket and the objects in\ - \ it. Requests to set ACLs or update ACLs fail and return the AccessControlListNotSupported\ - \ error code. Requests to read ACLs are still supported. For more information,\ - \ see Controlling object ownership in the Amazon S3 User Guide.

\ - \

Access Permissions

You can set access permissions\ - \ using one of the following methods:

  • Specify a canned ACL\ - \ with the x-amz-acl request header. Amazon S3 supports a set\ - \ of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined\ - \ set of grantees and permissions. Specify the canned ACL name as the value\ - \ of x-amz-acl. If you use this header, you cannot use other\ - \ access control-specific headers in your request. For more information, see\ - \ Canned ACL.

  • Specify access permissions explicitly with\ - \ the x-amz-grant-read, x-amz-grant-read-acp, x-amz-grant-write-acp,\ - \ and x-amz-grant-full-control headers. When using these headers,\ - \ you specify explicit access permissions and grantees (Amazon Web Services\ - \ accounts or Amazon S3 groups) who will receive the permission. If you use\ - \ these ACL-specific headers, you cannot use x-amz-acl header\ - \ to set a canned ACL. These parameters map to the set of permissions that\ - \ Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview.

    You specify each grantee as\ - \ a type=value pair, where the type is one of the following:

    • \ - \

      id \u2013 if the value specified is the canonical user\ - \ ID of an Amazon Web Services account

    • uri\ - \ \u2013 if you are granting permissions to a predefined group

    • \ - \

      emailAddress \u2013 if the value specified is the email\ - \ address of an Amazon Web Services account

      Using email addresses\ - \ to specify a grantee is only supported in the following Amazon Web Services\ - \ Regions:

      • US East (N. Virginia)

      • US West\ - \ (N. California)

      • US West (Oregon)

      • Asia\ - \ Pacific (Singapore)

      • Asia Pacific (Sydney)

      • \ - \

        Asia Pacific (Tokyo)

      • Europe (Ireland)

      • \ - \

        South America (S\xE3o Paulo)

      For a list of all the\ - \ Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

      \ - \

    For example, the following x-amz-grant-read\ - \ header grants list objects permission to the two Amazon Web Services accounts\ - \ identified by their email addresses.

    x-amz-grant-read: emailAddress=\"\ - xyz@amazon.com\", emailAddress=\"abc@amazon.com\"

\ - \

You can use either a canned ACL or specify access permissions explicitly.\ - \ You cannot do both.

Grantee Values

You can specify\ - \ the person (grantee) to whom you're assigning access rights (using request\ - \ elements) in the following ways:

  • By the person's ID:

    \ - \

    <Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"\ - \ xsi:type=\"CanonicalUser\"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName>\ - \ </Grantee>

    DisplayName is optional and ignored in the\ - \ request.

  • By URI:

    <Grantee xmlns:xsi=\"\ - http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"Group\"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee>\ - \

  • By Email address:

    <Grantee xmlns:xsi=\"\ - http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"AmazonCustomerByEmail\"\ - ><EmailAddress><>Grantees@email.com<></EmailAddress>lt;/Grantee>\ - \

    The grantee is resolved to the CanonicalUser and, in a response\ - \ to a GET Object acl request, appears as the CanonicalUser.

    Using\ - \ email addresses to specify a grantee is only supported in the following\ - \ Amazon Web Services Regions:

    • US East (N. Virginia)

      \ - \

    • US West (N. California)

    • US West (Oregon)

      \ - \

    • Asia Pacific (Singapore)

    • Asia Pacific (Sydney)

      \ - \

    • Asia Pacific (Tokyo)

    • Europe (Ireland)

      \ - \

    • South America (S\xE3o Paulo)

    For a list\ - \ of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

    \ - \

Versioning

The ACL of an object is\ - \ set at the object version level. By default, PUT sets the ACL of the current\ - \ version of an object. To set the ACL of a different version, use the versionId\ - \ subresource.

Related Resources

" - externalDocs: - url: http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectPUTacl.html - operationId: PutObjectAcl - parameters: - - description: The canned ACL to apply to the object. For more information, - see Canned - ACL. - in: header - name: x-amz-acl - required: false - schema: - enum: - - private - - public-read - - public-read-write - - authenticated-read - - aws-exec-read - - bucket-owner-read - - bucket-owner-full-control - type: string - - description:

The base64-encoded 128-bit MD5 digest of the data. This header - must be used as a message integrity check to verify that the request body - was not corrupted in transit. For more information, go to RFC - 1864.>

For requests made using the Amazon Web Services Command - Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated - automatically.

- in: header - name: Content-MD5 - required: false - schema: - type: string - - description:

Indicates the algorithm used to create the checksum for the - object when using the SDK. This header will not provide any additional functionality - if not using the SDK. When sending this header, there must be a corresponding - x-amz-checksum or x-amz-trailer header sent. Otherwise, - Amazon S3 fails the request with the HTTP status code 400 Bad Request. - For more information, see Checking - object integrity in the Amazon S3 User Guide.

If you provide - an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm - parameter.

- in: header - name: x-amz-sdk-checksum-algorithm - required: false - schema: - enum: - - CRC32 - - CRC32C - - SHA1 - - SHA256 - type: string - - description:

Allows grantee the read, write, read ACP, and write ACP permissions - on the bucket.

This action is not supported by Amazon S3 on Outposts.

- in: header - name: x-amz-grant-full-control - required: false - schema: - type: string - - description:

Allows grantee to list the objects in the bucket.

This - action is not supported by Amazon S3 on Outposts.

- in: header - name: x-amz-grant-read - required: false - schema: - type: string - - description:

Allows grantee to read the bucket ACL.

This action - is not supported by Amazon S3 on Outposts.

- in: header - name: x-amz-grant-read-acp - required: false - schema: - type: string - - description:

Allows grantee to create new objects in the bucket.

For - the bucket and object owners of existing objects, also allows deletions - and overwrites of those objects.

- in: header - name: x-amz-grant-write - required: false - schema: - type: string - - description:

Allows grantee to write the ACL for the applicable bucket.

-

This action is not supported by Amazon S3 on Outposts.

- in: header - name: x-amz-grant-write-acp - required: false - schema: - type: string - - description:

Key for which the PUT action was initiated.

When using - this action with an access point, you must direct requests to the access - point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. - When using this action with an access point through the Amazon Web Services - SDKs, you provide the access point ARN in place of the bucket name. For - more information about access point ARNs, see Using - access points in the Amazon S3 User Guide.

When using - this action with Amazon S3 on Outposts, you must direct requests to the - S3 on Outposts hostname. The S3 on Outposts hostname takes the form - AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. - When using this action with S3 on Outposts through the Amazon Web Services - SDKs, you provide the Outposts bucket ARN in place of the bucket name. For - more information about S3 on Outposts ARNs, see Using - Amazon S3 on Outposts in the Amazon S3 User Guide.

- in: path - name: Key - required: true - schema: - minLength: 1 - type: string - - description: '' - in: header - name: x-amz-request-payer - required: false - schema: - description: Confirms that the requester knows that they will be charged - for the request. Bucket owners need not specify this parameter in their - requests. For information about downloading objects from Requester Pays - buckets, see Downloading - Objects in Requester Pays Buckets in the Amazon S3 User Guide. - enum: - - requester - type: string - - description: VersionId used to reference a specific version of the object. - in: query - name: versionId - required: false - schema: - type: string - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: acl - required: true - schema: - enum: - - true - type: boolean - requestBody: - content: - text/xml: - schema: - properties: - AccessControlPolicy: - description: Contains the elements that set the ACL permissions - for an object per grantee. - properties: - AccessControlList: - allOf: - - $ref: '#/components/schemas/Grants' - - description: A list of grants. - Owner: - allOf: - - $ref: '#/components/schemas/Owner' - - description: Container for the bucket owner's display name - and ID. - type: object - type: object - required: true - responses: - '200': - content: - text/xml: - schema: - $ref: '#/components/schemas/PutObjectAclOutput' - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchKey' - description: NoSuchKey - /{Key}?attributes#x-amz-object-attributes: - get: - description:

Retrieves all the metadata from an object without returning - the object itself. This action is useful if you're interested only in an object's - metadata. To use GetObjectAttributes, you must have READ access - to the object.

GetObjectAttributes combines the functionality - of GetObjectAcl, GetObjectLegalHold, GetObjectLockConfiguration, - GetObjectRetention, GetObjectTagging, HeadObject, - and ListParts. All of the data returned with each of those individual - calls can be returned with a single call to GetObjectAttributes.

-

If you encrypt an object by using server-side encryption with customer-provided - encryption keys (SSE-C) when you store the object in Amazon S3, then when - you retrieve the metadata from the object, you must use the following headers:

-

  • x-amz-server-side-encryption-customer-algorithm -

  • x-amz-server-side-encryption-customer-key -

  • x-amz-server-side-encryption-customer-key-MD5 -

For more information about SSE-C, see Server-Side - Encryption (Using Customer-Provided Encryption Keys) in the Amazon - S3 User Guide.

  • Encryption request headers, such - as x-amz-server-side-encryption, should not be sent for GET requests - if your object uses server-side encryption with Amazon Web Services KMS keys - stored in Amazon Web Services Key Management Service (SSE-KMS) or server-side - encryption with Amazon S3 managed encryption keys (SSE-S3). If your object - does use these types of keys, you'll get an HTTP 400 Bad Request - error.

  • The last modified property in this case is the creation - date of the object.

Consider the following when - using request headers:

  • If both of the If-Match - and If-Unmodified-Since headers are present in the request as - follows, then Amazon S3 returns the HTTP status code 200 OK and - the data requested:

    • If-Match condition evaluates - to true.

    • If-Unmodified-Since - condition evaluates to false.

  • If - both of the If-None-Match and If-Modified-Since - headers are present in the request as follows, then Amazon S3 returns the - HTTP status code 304 Not Modified:

    • If-None-Match - condition evaluates to false.

    • If-Modified-Since - condition evaluates to true.

For - more information about conditional requests, see RFC - 7232.

Permissions

The permissions that you need - to use this operation depend on whether the bucket is versioned. If the bucket - is versioned, you need both the s3:GetObjectVersion and s3:GetObjectVersionAttributes - permissions for this operation. If the bucket is not versioned, you need the - s3:GetObject and s3:GetObjectAttributes permissions. - For more information, see Specifying - Permissions in a Policy in the Amazon S3 User Guide. If the object - that you request does not exist, the error Amazon S3 returns depends on whether - you also have the s3:ListBucket permission.

  • If - you have the s3:ListBucket permission on the bucket, Amazon S3 - returns an HTTP status code 404 Not Found ("no such key") error.

    -

  • If you don't have the s3:ListBucket permission, - Amazon S3 returns an HTTP status code 403 Forbidden ("access - denied") error.

The following actions are related to GetObjectAttributes:

- - operationId: GetObjectAttributes - parameters: - - description: The object key. - in: path - name: Key - required: true - schema: - minLength: 1 - type: string - - description: The version ID used to reference a specific version of the object. - in: query - name: versionId - required: false - schema: - type: string - - description: Sets the maximum number of parts to return. - in: header - name: x-amz-max-parts - required: false - schema: - type: integer - - description: Specifies the part after which listing should begin. Only parts - with higher part numbers will be listed. - in: header - name: x-amz-part-number-marker - required: false - schema: - type: integer - - description: Specifies the algorithm to use when encrypting the object (for - example, AES256). - in: header - name: x-amz-server-side-encryption-customer-algorithm - required: false - schema: - type: string - - description: Specifies the customer-provided encryption key for Amazon S3 - to use in encrypting data. This value is used to store the object and then - it is discarded; Amazon S3 does not store the encryption key. The key must - be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm - header. - in: header - name: x-amz-server-side-encryption-customer-key - required: false - schema: - format: password - type: string - - description: Specifies the 128-bit MD5 digest of the encryption key according - to RFC 1321. Amazon S3 uses this header for a message integrity check to - ensure that the encryption key was transmitted without error. - in: header - name: x-amz-server-side-encryption-customer-key-MD5 - required: false - schema: - type: string - - description: '' - in: header - name: x-amz-request-payer - required: false - schema: - description: Confirms that the requester knows that they will be charged - for the request. Bucket owners need not specify this parameter in their - requests. For information about downloading objects from Requester Pays - buckets, see Downloading - Objects in Requester Pays Buckets in the Amazon S3 User Guide. - enum: - - requester - type: string - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - description: An XML header that specifies the fields at the root level that - you want returned in the response. Fields that you do not specify are not - returned. - in: header - name: x-amz-object-attributes - required: true - schema: - items: - $ref: '#/components/schemas/ObjectAttributes' - type: array - - allowEmptyValue: true - in: query - name: attributes - required: true - schema: - enum: - - true - type: boolean - responses: - '200': - content: - text/xml: - schema: - $ref: '#/components/schemas/GetObjectAttributesOutput' - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchKey' - description: NoSuchKey - parameters: - - $ref: '#/components/parameters/x-amz-security-token' - /{Key}?legal-hold: - get: - description:

Gets an object's current legal hold status. For more information, - see Locking - Objects.

This action is not supported by Amazon S3 on Outposts.

-

The following action is related to GetObjectLegalHold:

- - operationId: GetObjectLegalHold - parameters: - - description: The key name for the object whose legal hold status you want - to retrieve. - in: path - name: Key - required: true - schema: - minLength: 1 - type: string - - description: The version ID of the object whose legal hold status you want - to retrieve. - in: query - name: versionId - required: false - schema: - type: string - - description: '' - in: header - name: x-amz-request-payer - required: false - schema: - description: Confirms that the requester knows that they will be charged - for the request. Bucket owners need not specify this parameter in their - requests. For information about downloading objects from Requester Pays - buckets, see Downloading - Objects in Requester Pays Buckets in the Amazon S3 User Guide. - enum: - - requester - type: string - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: legal-hold - required: true - schema: - enum: - - true - type: boolean - responses: - '200': - content: - text/xml: - schema: - $ref: '#/components/schemas/GetObjectLegalHoldOutput' - description: Success - parameters: - - $ref: '#/components/parameters/x-amz-security-token' - put: - description:

Applies a legal hold configuration to the specified object. - For more information, see Locking - Objects.

This action is not supported by Amazon S3 on Outposts.

- operationId: PutObjectLegalHold - parameters: - - description: The key name for the object that you want to place a legal hold - on. - in: path - name: Key - required: true - schema: - minLength: 1 - type: string - - description: '' - in: header - name: x-amz-request-payer - required: false - schema: - description: Confirms that the requester knows that they will be charged - for the request. Bucket owners need not specify this parameter in their - requests. For information about downloading objects from Requester Pays - buckets, see Downloading - Objects in Requester Pays Buckets in the Amazon S3 User Guide. - enum: - - requester - type: string - - description: The version ID of the object that you want to place a legal hold - on. - in: query - name: versionId - required: false - schema: - type: string - - description:

The MD5 hash for the request body.

For requests made - using the Amazon Web Services Command Line Interface (CLI) or Amazon Web - Services SDKs, this field is calculated automatically.

- in: header - name: Content-MD5 - required: false - schema: - type: string - - description:

Indicates the algorithm used to create the checksum for the - object when using the SDK. This header will not provide any additional functionality - if not using the SDK. When sending this header, there must be a corresponding - x-amz-checksum or x-amz-trailer header sent. Otherwise, - Amazon S3 fails the request with the HTTP status code 400 Bad Request. - For more information, see Checking - object integrity in the Amazon S3 User Guide.

If you provide - an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm - parameter.

- in: header - name: x-amz-sdk-checksum-algorithm - required: false - schema: - enum: - - CRC32 - - CRC32C - - SHA1 - - SHA256 - type: string - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: legal-hold - required: true - schema: - enum: - - true - type: boolean - requestBody: - content: - text/xml: - schema: - properties: - LegalHold: - description: A legal hold configuration for an object. - properties: - Status: - allOf: - - $ref: '#/components/schemas/ObjectLockLegalHoldStatus' - - description: Indicates whether the specified object has a - legal hold in place. - type: object - type: object - required: true - responses: - '200': - content: - text/xml: - schema: - $ref: '#/components/schemas/PutObjectLegalHoldOutput' - description: Success - /{Key}?restore: - parameters: - - $ref: '#/components/parameters/x-amz-security-token' - post: - description: "

Restores an archived copy of an object back into Amazon S3

\ - \

This action is not supported by Amazon S3 on Outposts.

This action\ - \ performs the following types of requests:

  • select\ - \ - Perform a select query on an archived object

  • restore\ - \ an archive - Restore an archived object

To use\ - \ this operation, you must have permissions to perform the s3:RestoreObject\ - \ action. The bucket owner has this permission by default and can grant this\ - \ permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources in the Amazon\ - \ S3 User Guide.

Querying Archives with Select Requests\ - \

You use a select type of request to perform SQL queries on archived\ - \ objects. The archived objects that are being queried by the select request\ - \ must be formatted as uncompressed comma-separated values (CSV) files. You\ - \ can run queries and custom analytics on your archived data without having\ - \ to restore your data to a hotter Amazon S3 tier. For an overview about select\ - \ requests, see Querying Archived Objects in the Amazon S3 User Guide.

When\ - \ making a select request, do the following:

  • Define an output\ - \ location for the select query's output. This must be an Amazon S3 bucket\ - \ in the same Amazon Web Services Region as the bucket that contains the archive\ - \ object that is being queried. The Amazon Web Services account that initiates\ - \ the job must have permissions to write to the S3 bucket. You can specify\ - \ the storage class and encryption for the output objects stored in the bucket.\ - \ For more information about output, see Querying Archived Objects in the Amazon S3 User Guide.

    For\ - \ more information about the S3 structure in the request body,\ - \ see the following:

  • Define the SQL expression for the\ - \ SELECT type of restoration for your query in the request body's\ - \ SelectParameters structure. You can use expressions like the\ - \ following examples.

    • The following expression returns all\ - \ records from the specified object.

      SELECT * FROM Object\ - \

    • Assuming that you are not using any headers for data\ - \ stored in the object, you can specify columns with positional headers.

      \ - \

      SELECT s._1, s._2 FROM Object s WHERE s._3 > 100

      \ - \

    • If you have headers and you set the fileHeaderInfo\ - \ in the CSV structure in the request body to USE,\ - \ you can specify headers in the query. (If you set the fileHeaderInfo\ - \ field to IGNORE, the first row is skipped for the query.) You\ - \ cannot mix ordinal positions with header column names.

      SELECT\ - \ s.Id, s.FirstName, s.SSN FROM S3Object s

\ - \

For more information about using SQL with S3 Glacier Select restore,\ - \ see SQL Reference for Amazon S3 Select and S3 Glacier Select in the Amazon\ - \ S3 User Guide.

When making a select request, you can also do\ - \ the following:

  • To expedite your queries, specify the Expedited\ - \ tier. For more information about tiers, see \"Restoring Archives,\" later\ - \ in this topic.

  • Specify details about the data serialization\ - \ format of both the input object that is being queried and the serialization\ - \ of the CSV-encoded query results.

The following are additional\ - \ important facts about the select feature:

  • The output results\ - \ are new Amazon S3 objects. Unlike archive retrievals, they are stored until\ - \ explicitly deleted-manually or through a lifecycle policy.

  • \ - \

    You can issue more than one select request on the same Amazon S3 object.\ - \ Amazon S3 doesn't deduplicate requests, so avoid issuing duplicate requests.

    \ - \

  • Amazon S3 accepts a select request even if the object has\ - \ already been restored. A select request doesn\u2019t return error response\ - \ 409.

Restoring objects

Objects\ - \ that you archive to the S3 Glacier or S3 Glacier Deep Archive storage class,\ - \ and S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive\ - \ tiers are not accessible in real time. For objects in Archive Access or\ - \ Deep Archive Access tiers you must first initiate a restore request, and\ - \ then wait until the object is moved into the Frequent Access tier. For objects\ - \ in S3 Glacier or S3 Glacier Deep Archive storage classes you must first\ - \ initiate a restore request, and then wait until a temporary copy of the\ - \ object is available. To access an archived object, you must restore the\ - \ object for the duration (number of days) that you specify.

To restore\ - \ a specific object version, you can provide a version ID. If you don't provide\ - \ a version ID, Amazon S3 restores the current version.

When restoring\ - \ an archived object (or using a select request), you can specify one of the\ - \ following data access tier options in the Tier element of the\ - \ request body:

  • Expedited - Expedited retrievals\ - \ allow you to quickly access your data stored in the S3 Glacier storage class\ - \ or S3 Intelligent-Tiering Archive tier when occasional urgent requests for\ - \ a subset of archives are required. For all but the largest archived objects\ - \ (250 MB+), data accessed using Expedited retrievals is typically made available\ - \ within 1\u20135 minutes. Provisioned capacity ensures that retrieval capacity\ - \ for Expedited retrievals is available when you need it. Expedited retrievals\ - \ and provisioned capacity are not available for objects stored in the S3\ - \ Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive\ - \ tier.

  • Standard - Standard retrievals allow\ - \ you to access any of your archived objects within several hours. This is\ - \ the default option for retrieval requests that do not specify the retrieval\ - \ option. Standard retrievals typically finish within 3\u20135 hours for objects\ - \ stored in the S3 Glacier storage class or S3 Intelligent-Tiering Archive\ - \ tier. They typically finish within 12 hours for objects stored in the S3\ - \ Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive\ - \ tier. Standard retrievals are free for objects stored in S3 Intelligent-Tiering.

    \ - \

  • Bulk - Bulk retrievals are the lowest-cost retrieval\ - \ option in S3 Glacier, enabling you to retrieve large amounts, even petabytes,\ - \ of data inexpensively. Bulk retrievals typically finish within 5\u201312\ - \ hours for objects stored in the S3 Glacier storage class or S3 Intelligent-Tiering\ - \ Archive tier. They typically finish within 48 hours for objects stored in\ - \ the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep\ - \ Archive tier. Bulk retrievals are free for objects stored in S3 Intelligent-Tiering.

    \ - \

For more information about archive retrieval options and\ - \ provisioned capacity for Expedited data access, see Restoring\ - \ Archived Objects in the Amazon S3 User Guide.

You can\ - \ use Amazon S3 restore speed upgrade to change the restore speed to a faster\ - \ speed while it is in progress. For more information, see Upgrading the speed of an in-progress restore in the Amazon S3 User\ - \ Guide.

To get the status of object restoration, you can send\ - \ a HEAD request. Operations return the x-amz-restore\ - \ header, which provides information about the restoration status, in the\ - \ response. You can use Amazon S3 event notifications to notify you when a\ - \ restore is initiated or completed. For more information, see Configuring\ - \ Amazon S3 Event Notifications in the Amazon S3 User Guide.

\ - \

After restoring an archived object, you can update the restoration period\ - \ by reissuing the request with a new period. Amazon S3 updates the restoration\ - \ period relative to the current time and charges only for the request-there\ - \ are no data transfer charges. You cannot update the restoration period when\ - \ Amazon S3 is actively processing your current restore request for the object.

\ - \

If your bucket has a lifecycle configuration with a rule that includes\ - \ an expiration action, the object expiration overrides the life span that\ - \ you specify in a restore request. For example, if you restore an object\ - \ copy for 10 days, but the object is scheduled to expire in 3 days, Amazon\ - \ S3 deletes the object in 3 days. For more information about lifecycle configuration,\ - \ see PutBucketLifecycleConfiguration and Object Lifecycle Management in Amazon S3 User Guide.

Responses\ - \

A successful action returns either the 200 OK or 202\ - \ Accepted status code.

  • If the object is not previously\ - \ restored, then Amazon S3 returns 202 Accepted in the response.\ - \

  • If the object is previously restored, Amazon S3 returns\ - \ 200 OK in the response.

Special Errors

    • Code: RestoreAlreadyInProgress\ - \

    • Cause: Object restore is already in progress. (This\ - \ error does not apply to SELECT type requests.)

    • HTTP\ - \ Status Code: 409 Conflict

    • SOAP Fault Code Prefix:\ - \ Client

    • Code: GlacierExpeditedRetrievalNotAvailable\ - \

    • Cause: expedited retrievals are currently not available.\ - \ Try again later. (Returned if there is insufficient capacity to process\ - \ the Expedited request. This error applies only to Expedited retrievals and\ - \ not to S3 Standard or Bulk retrievals.)

    • HTTP\ - \ Status Code: 503

    • SOAP Fault Code Prefix: N/A\ - \

Related Resources\ - \

" - externalDocs: - url: http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectRestore.html - operationId: RestoreObject - parameters: - - description: Object key for which the action was initiated. - in: path - name: Key - required: true - schema: - minLength: 1 - type: string - - description: VersionId used to reference a specific version of the object. - in: query - name: versionId - required: false - schema: - type: string - - description: '' - in: header - name: x-amz-request-payer - required: false - schema: - description: Confirms that the requester knows that they will be charged - for the request. Bucket owners need not specify this parameter in their - requests. For information about downloading objects from Requester Pays - buckets, see Downloading - Objects in Requester Pays Buckets in the Amazon S3 User Guide. - enum: - - requester - type: string - - description:

Indicates the algorithm used to create the checksum for the - object when using the SDK. This header will not provide any additional functionality - if not using the SDK. When sending this header, there must be a corresponding - x-amz-checksum or x-amz-trailer header sent. Otherwise, - Amazon S3 fails the request with the HTTP status code 400 Bad Request. - For more information, see Checking - object integrity in the Amazon S3 User Guide.

If you provide - an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm - parameter.

- in: header - name: x-amz-sdk-checksum-algorithm - required: false - schema: - enum: - - CRC32 - - CRC32C - - SHA1 - - SHA256 - type: string - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: restore - required: true - schema: - enum: - - true - type: boolean - requestBody: - content: - text/xml: - schema: - properties: - RestoreRequest: - description: Container for restore job parameters. - properties: - Days: - allOf: - - $ref: '#/components/schemas/Days' - - description:

Lifetime of the active copy in days. Do not - use with restores that specify OutputLocation.

-

The Days element is required for regular restores, and - must not be provided for select requests.

- Description: - allOf: - - $ref: '#/components/schemas/Description' - - description: The optional description for the job. - GlacierJobParameters: - allOf: - - $ref: '#/components/schemas/GlacierJobParameters' - - description: S3 Glacier related parameters pertaining to this - job. Do not use with restores that specify OutputLocation. - OutputLocation: - allOf: - - $ref: '#/components/schemas/OutputLocation' - - description: Describes the location where the restore job's - output is stored. - SelectParameters: - allOf: - - $ref: '#/components/schemas/SelectParameters' - - description: Describes the parameters for Select job types. - Tier: - allOf: - - $ref: '#/components/schemas/Tier' - - description: Retrieval tier at which the restore will be processed. - Type: - allOf: - - $ref: '#/components/schemas/RestoreRequestType' - - description: Type of restore request. - type: object - type: object - required: true - responses: - '200': - content: - text/xml: - schema: - $ref: '#/components/schemas/RestoreObjectOutput' - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/ObjectAlreadyInActiveTierError' - description: ObjectAlreadyInActiveTierError - /{Key}?retention: - get: - description:

Retrieves an object's retention settings. For more information, - see Locking - Objects.

This action is not supported by Amazon S3 on Outposts.

-

The following action is related to GetObjectRetention:

- - operationId: GetObjectRetention - parameters: - - description: The key name for the object whose retention settings you want - to retrieve. - in: path - name: Key - required: true - schema: - minLength: 1 - type: string - - description: The version ID for the object whose retention settings you want - to retrieve. - in: query - name: versionId - required: false - schema: - type: string - - description: '' - in: header - name: x-amz-request-payer - required: false - schema: - description: Confirms that the requester knows that they will be charged - for the request. Bucket owners need not specify this parameter in their - requests. For information about downloading objects from Requester Pays - buckets, see Downloading - Objects in Requester Pays Buckets in the Amazon S3 User Guide. - enum: - - requester - type: string - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: retention - required: true - schema: - enum: - - true - type: boolean - responses: - '200': - content: - text/xml: - schema: - $ref: '#/components/schemas/GetObjectRetentionOutput' - description: Success - parameters: - - $ref: '#/components/parameters/x-amz-security-token' - put: - description:

Places an Object Retention configuration on an object. For more - information, see Locking - Objects. Users or accounts require the s3:PutObjectRetention - permission in order to place an Object Retention configuration on objects. - Bypassing a Governance Retention configuration requires the s3:BypassGovernanceRetention - permission.

This action is not supported by Amazon S3 on Outposts.

- operationId: PutObjectRetention - parameters: - - description: The key name for the object that you want to apply this Object - Retention configuration to. - in: path - name: Key - required: true - schema: - minLength: 1 - type: string - - description: '' - in: header - name: x-amz-request-payer - required: false - schema: - description: Confirms that the requester knows that they will be charged - for the request. Bucket owners need not specify this parameter in their - requests. For information about downloading objects from Requester Pays - buckets, see Downloading - Objects in Requester Pays Buckets in the Amazon S3 User Guide. - enum: - - requester - type: string - - description: The version ID for the object that you want to apply this Object - Retention configuration to. - in: query - name: versionId - required: false - schema: - type: string - - description: Indicates whether this action should bypass Governance-mode restrictions. - in: header - name: x-amz-bypass-governance-retention - required: false - schema: - type: boolean - - description:

The MD5 hash for the request body.

For requests made - using the Amazon Web Services Command Line Interface (CLI) or Amazon Web - Services SDKs, this field is calculated automatically.

- in: header - name: Content-MD5 - required: false - schema: - type: string - - description:

Indicates the algorithm used to create the checksum for the - object when using the SDK. This header will not provide any additional functionality - if not using the SDK. When sending this header, there must be a corresponding - x-amz-checksum or x-amz-trailer header sent. Otherwise, - Amazon S3 fails the request with the HTTP status code 400 Bad Request. - For more information, see Checking - object integrity in the Amazon S3 User Guide.

If you provide - an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm - parameter.

- in: header - name: x-amz-sdk-checksum-algorithm - required: false - schema: - enum: - - CRC32 - - CRC32C - - SHA1 - - SHA256 - type: string - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: retention - required: true - schema: - enum: - - true - type: boolean - requestBody: - content: - text/xml: - schema: - properties: - Retention: - description: A Retention configuration for an object. - properties: - Mode: - allOf: - - $ref: '#/components/schemas/ObjectLockRetentionMode' - - description: Indicates the Retention mode for the specified - object. - RetainUntilDate: - allOf: - - $ref: '#/components/schemas/Date' - - description: The date on which this Object Lock Retention - will expire. - type: object - type: object - required: true - responses: - '200': - content: - text/xml: - schema: - $ref: '#/components/schemas/PutObjectRetentionOutput' - description: Success - /{Key}?select&select-type=2: - parameters: - - $ref: '#/components/parameters/x-amz-security-token' - post: - description: "

This action filters the contents of an Amazon S3 object based\ - \ on a simple structured query language (SQL) statement. In the request, along\ - \ with the SQL expression, you must also specify a data serialization format\ - \ (JSON, CSV, or Apache Parquet) of the object. Amazon S3 uses this format\ - \ to parse object data into records, and returns only records that match the\ - \ specified SQL expression. You must also specify the data serialization format\ - \ for the response.

This action is not supported by Amazon S3 on Outposts.

\ - \

For more information about Amazon S3 Select, see Selecting Content from Objects and SELECT Command in the Amazon S3 User Guide.

For more information\ - \ about using SQL with Amazon S3 Select, see SQL Reference for Amazon S3 Select and S3 Glacier Select in the Amazon\ - \ S3 User Guide.

Permissions

You must have\ - \ s3:GetObject permission for this operation.\_Amazon S3 Select\ - \ does not support anonymous access. For more information about permissions,\ - \ see Specifying Permissions in a Policy in the Amazon S3 User Guide.

\ - \

Object Data Formats

You can use Amazon S3 Select\ - \ to query objects that have the following format properties:

  • \ - \

    CSV, JSON, and Parquet - Objects must be in CSV, JSON, or Parquet\ - \ format.

  • UTF-8 - UTF-8 is the only encoding type\ - \ Amazon S3 Select supports.

  • GZIP or BZIP2 - CSV\ - \ and JSON files can be compressed using GZIP or BZIP2. GZIP and BZIP2 are\ - \ the only compression formats that Amazon S3 Select supports for CSV and\ - \ JSON files. Amazon S3 Select supports columnar compression for Parquet using\ - \ GZIP or Snappy. Amazon S3 Select does not support whole-object compression\ - \ for Parquet objects.

  • Server-side encryption -\ - \ Amazon S3 Select supports querying objects that are protected with server-side\ - \ encryption.

    For objects that are encrypted with customer-provided\ - \ encryption keys (SSE-C), you must use HTTPS, and you must use the headers\ - \ that are documented in the GetObject. For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys) in the\ - \ Amazon S3 User Guide.

    For objects that are encrypted with\ - \ Amazon S3 managed encryption keys (SSE-S3) and Amazon Web Services KMS keys\ - \ (SSE-KMS), server-side encryption is handled transparently, so you don't\ - \ need to specify anything. For more information about server-side encryption,\ - \ including SSE-S3 and SSE-KMS, see Protecting Data Using Server-Side Encryption in the Amazon S3 User\ - \ Guide.

Working with the Response Body

\ - \

Given the response size is unknown, Amazon S3 Select streams the response\ - \ as a series of messages and includes a Transfer-Encoding header\ - \ with chunked as its value in the response. For more information,\ - \ see Appendix: SelectObjectContent Response.

GetObject Support\ - \

The SelectObjectContent action does not support the\ - \ following GetObject functionality. For more information, see\ - \ GetObject.

  • Range: Although you can specify\ - \ a scan range for an Amazon S3 Select request (see SelectObjectContentRequest - ScanRange in the request parameters), you\ - \ cannot specify the range of bytes of an object to return.

  • \ - \

    GLACIER, DEEP_ARCHIVE and REDUCED_REDUNDANCY storage classes: You cannot\ - \ specify the GLACIER, DEEP_ARCHIVE, or REDUCED_REDUNDANCY storage\ - \ classes. For more information, about storage classes see Storage Classes in the Amazon S3 User Guide.

\ - \

Special Errors

For a list of special errors for this\ - \ operation, see List of SELECT Object Content Error Codes

Related\ - \ Resources

" - operationId: SelectObjectContent - parameters: - - description: The object key. - in: path - name: Key - required: true - schema: - minLength: 1 - type: string - - description: The server-side encryption (SSE) algorithm used to encrypt the - object. This parameter is needed only when the object was created using - a checksum algorithm. For more information, see Protecting - data using SSE-C keys in the Amazon S3 User Guide. - in: header - name: x-amz-server-side-encryption-customer-algorithm - required: false - schema: - type: string - - description: The server-side encryption (SSE) customer managed key. This parameter - is needed only when the object was created using a checksum algorithm. For - more information, see Protecting - data using SSE-C keys in the Amazon S3 User Guide. - in: header - name: x-amz-server-side-encryption-customer-key - required: false - schema: - format: password - type: string - - description: The MD5 server-side encryption (SSE) customer managed key. This - parameter is needed only when the object was created using a checksum algorithm. - For more information, see Protecting - data using SSE-C keys in the Amazon S3 User Guide. - in: header - name: x-amz-server-side-encryption-customer-key-MD5 - required: false - schema: - type: string - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: select - required: true - schema: - enum: - - true - type: boolean - - in: query - name: select-type - required: true - schema: - enum: - - '2' - type: string - requestBody: - content: - text/xml: - schema: - properties: - Expression: - description: The expression that is used to query the object. - type: string - ExpressionType: - description: The type of the provided expression (for example, SQL). - enum: - - SQL - type: string - InputSerialization: - description: Describes the serialization format of the object. - properties: - CSV: - allOf: - - $ref: '#/components/schemas/CSVInput' - - description: Describes the serialization of a CSV-encoded - object. - CompressionType: - allOf: - - $ref: '#/components/schemas/CompressionType' - - description: 'Specifies object''s compression format. Valid - values: NONE, GZIP, BZIP2. Default Value: NONE.' - JSON: - allOf: - - $ref: '#/components/schemas/JSONInput' - - description: Specifies JSON as object's input serialization - format. - Parquet: - allOf: - - $ref: '#/components/schemas/ParquetInput' - - description: Specifies Parquet as object's input serialization - format. - type: object - OutputSerialization: - description: Describes how results of the Select job are serialized. - properties: - CSV: - allOf: - - $ref: '#/components/schemas/CSVOutput' - - description: Describes the serialization of CSV-encoded Select - results. - JSON: - allOf: - - $ref: '#/components/schemas/JSONOutput' - - description: Specifies JSON as request's output serialization - format. - type: object - RequestProgress: - description: Container for specifying if periodic QueryProgress - messages should be sent. - properties: - Enabled: - allOf: - - $ref: '#/components/schemas/EnableRequestProgress' - - description: 'Specifies whether periodic QueryProgress frames - should be sent. Valid values: TRUE, FALSE. Default value: - FALSE.' - type: object - ScanRange: - description: Specifies the byte range of the object to get the records - from. A record is processed when its first byte is contained by - the range. This parameter is optional, but when specified, it - must not be empty. See RFC 2616, Section 14.35.1 about how to - specify the start and end of the range. - properties: - End: - allOf: - - $ref: '#/components/schemas/End' - - description: 'Specifies the end of the byte range. This parameter - is optional. Valid values: non-negative integers. The default - value is one less than the size of the object being queried. - If only the End parameter is supplied, it is interpreted - to mean scan the last N bytes of the file. For example, - <scanrange><end>50</end></scanrange> - means scan the last 50 bytes.' - Start: - allOf: - - $ref: '#/components/schemas/Start' - - description: 'Specifies the start of the byte range. This - parameter is optional. Valid values: non-negative integers. - The default value is 0. If only start is supplied, - it means scan from that point to the end of the file. For - example, <scanrange><start>50</start></scanrange> - means scan from byte 50 until the end of the file.' - type: object - required: - - Expression - - ExpressionType - - InputSerialization - - OutputSerialization - type: object - required: true - responses: - '200': - content: - text/xml: - schema: - $ref: '#/components/schemas/SelectObjectContentOutput' - description: Success - /{Key}?tagging: - delete: - description:

Removes the entire tag set from the specified object. For more - information about managing object tags, see - Object Tagging.

To use this operation, you must have permission - to perform the s3:DeleteObjectTagging action.

To delete - tags of a specific object version, add the versionId query parameter - in the request. You will need permission for the s3:DeleteObjectVersionTagging - action.

The following operations are related to DeleteBucketMetricsConfiguration:

- - operationId: DeleteObjectTagging - parameters: - - description: The key that identifies the object in the bucket from which to - remove all tags. - in: path - name: Key - required: true - schema: - minLength: 1 - type: string - - description: The versionId of the object that the tag-set will be removed - from. - in: query - name: versionId - required: false - schema: - type: string - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: tagging - required: true - schema: - enum: - - true - type: boolean - responses: - '204': - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteObjectTaggingOutput' - description: Success - get: - description:

Returns the tag-set of an object. You send the GET request against - the tagging subresource associated with the object.

To use this operation, - you must have permission to perform the s3:GetObjectTagging action. - By default, the GET action returns information about current version of an - object. For a versioned bucket, you can have multiple versions of an object - in your bucket. To retrieve tags of any other version, use the versionId query - parameter. You also need permission for the s3:GetObjectVersionTagging - action.

By default, the bucket owner has this permission and can grant - this permission to others.

For information about the Amazon S3 object - tagging feature, see Object - Tagging.

The following actions are related to GetObjectTagging:

- - operationId: GetObjectTagging - parameters: - - description: Object key for which to get the tagging information. - in: path - name: Key - required: true - schema: - minLength: 1 - type: string - - description: The versionId of the object for which to get the tagging information. - in: query - name: versionId - required: false - schema: - type: string - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - description: '' - in: header - name: x-amz-request-payer - required: false - schema: - description: Confirms that the requester knows that they will be charged - for the request. Bucket owners need not specify this parameter in their - requests. For information about downloading objects from Requester Pays - buckets, see Downloading - Objects in Requester Pays Buckets in the Amazon S3 User Guide. - enum: - - requester - type: string - - allowEmptyValue: true - in: query - name: tagging - required: true - schema: - enum: - - true - type: boolean - responses: - '200': - content: - text/xml: - schema: - $ref: '#/components/schemas/GetObjectTaggingOutput' - description: Success - parameters: - - $ref: '#/components/parameters/x-amz-security-token' - put: - description: '

Sets the supplied tag-set to an object that already exists - in a bucket.

A tag is a key-value pair. You can associate tags with - an object by sending a PUT request against the tagging subresource that is - associated with the object. You can retrieve tags by sending a GET request. - For more information, see GetObjectTagging.

-

For tagging-related restrictions related to characters and encodings, see - Tag - Restrictions. Note that Amazon S3 limits the maximum number of tags to - 10 tags per object.

To use this operation, you must have permission - to perform the s3:PutObjectTagging action. By default, the bucket - owner has this permission and can grant this permission to others.

To - put tags of any other version, use the versionId query parameter. - You also need permission for the s3:PutObjectVersionTagging action.

-

For information about the Amazon S3 object tagging feature, see Object - Tagging.

Special Errors

    • -

    • Code: InvalidTagError

    • Cause: The tag - provided was not a valid tag. This error can occur if the tag did not pass - input validation. For more information, see Object - Tagging.

    • Code: MalformedXMLError -

    • Cause: The XML provided does not match the schema. -

    • Code: OperationAbortedError -

    • Cause: A conflicting conditional action is currently - in progress against this resource. Please try again.

    -

    • Code: InternalError

    • Cause: - The service was unable to apply the provided tag to the object.

      • -

Related Resources

' - operationId: PutObjectTagging - parameters: - - description: Name of the object key. - in: path - name: Key - required: true - schema: - minLength: 1 - type: string - - description: The versionId of the object that the tag-set will be added to. - in: query - name: versionId - required: false - schema: - type: string - - description:

The MD5 hash for the request body.

For requests made - using the Amazon Web Services Command Line Interface (CLI) or Amazon Web - Services SDKs, this field is calculated automatically.

- in: header - name: Content-MD5 - required: false - schema: - type: string - - description:

Indicates the algorithm used to create the checksum for the - object when using the SDK. This header will not provide any additional functionality - if not using the SDK. When sending this header, there must be a corresponding - x-amz-checksum or x-amz-trailer header sent. Otherwise, - Amazon S3 fails the request with the HTTP status code 400 Bad Request. - For more information, see Checking - object integrity in the Amazon S3 User Guide.

If you provide - an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm - parameter.

- in: header - name: x-amz-sdk-checksum-algorithm - required: false - schema: - enum: - - CRC32 - - CRC32C - - SHA1 - - SHA256 - type: string - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - description: '' - in: header - name: x-amz-request-payer - required: false - schema: - description: Confirms that the requester knows that they will be charged - for the request. Bucket owners need not specify this parameter in their - requests. For information about downloading objects from Requester Pays - buckets, see Downloading - Objects in Requester Pays Buckets in the Amazon S3 User Guide. - enum: - - requester - type: string - - allowEmptyValue: true - in: query - name: tagging - required: true - schema: - enum: - - true - type: boolean - requestBody: - content: - text/xml: - schema: - properties: - Tagging: - description: Container for TagSet elements. - properties: - TagSet: - allOf: - - $ref: '#/components/schemas/TagSet' - - description: A collection for a set of tags - type: object - required: - - Tagging - type: object - required: true - responses: - '200': - content: - text/xml: - schema: - $ref: '#/components/schemas/PutObjectTaggingOutput' - description: Success - /{Key}?torrent: - get: - description:

Returns torrent files from a bucket. BitTorrent can save you - bandwidth when you're distributing large files. For more information about - BitTorrent, see Using - BitTorrent with Amazon S3.

You can get torrent only for - objects that are less than 5 GB in size, and that are not encrypted using - server-side encryption with a customer-provided encryption key.

 -

To use GET, you must have READ access to the object.

This action - is not supported by Amazon S3 on Outposts.

The following action is - related to GetObjectTorrent:

- externalDocs: - url: http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectGETtorrent.html - operationId: GetObjectTorrent - parameters: - - description: The object key for which to get the information. - in: path - name: Key - required: true - schema: - minLength: 1 - type: string - - description: '' - in: header - name: x-amz-request-payer - required: false - schema: - description: Confirms that the requester knows that they will be charged - for the request. Bucket owners need not specify this parameter in their - requests. For information about downloading objects from Requester Pays - buckets, see Downloading - Objects in Requester Pays Buckets in the Amazon S3 User Guide. - enum: - - requester - type: string - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: torrent - required: true - schema: - enum: - - true - type: boolean - responses: - '200': - content: - text/xml: - schema: - $ref: '#/components/schemas/GetObjectTorrentOutput' - description: Success - parameters: - - $ref: '#/components/parameters/x-amz-security-token' - /{Key}?uploads: - parameters: - - $ref: '#/components/parameters/x-amz-security-token' - post: - description: "

This action initiates a multipart upload and returns an upload\ - \ ID. This upload ID is used to associate all of the parts in the specific\ - \ multipart upload. You specify this upload ID in each of your subsequent\ - \ upload part requests (see UploadPart). You also include this upload ID in the final request to\ - \ either complete or abort the multipart upload request.

For more information\ - \ about multipart uploads, see Multipart Upload Overview.

If you have configured a lifecycle\ - \ rule to abort incomplete multipart uploads, the upload must complete within\ - \ the number of days specified in the bucket lifecycle configuration. Otherwise,\ - \ the incomplete multipart upload becomes eligible for an abort action and\ - \ Amazon S3 aborts the multipart upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy.

\ - \

For information about the permissions required to use the multipart upload\ - \ API, see Multipart Upload and Permissions.

For request signing, multipart\ - \ upload is just a series of regular requests. You initiate a multipart upload,\ - \ send one or more requests to upload parts, and then complete the multipart\ - \ upload process. You sign each request individually. There is nothing special\ - \ about signing multipart upload requests. For more information about signing,\ - \ see Authenticating Requests (Amazon Web Services Signature Version 4).

\ - \

After you initiate a multipart upload and upload one or more\ - \ parts, to stop being charged for storing the uploaded parts, you must either\ - \ complete or abort the multipart upload. Amazon S3 frees up the space used\ - \ to store the parts and stop charging you for storing them only after you\ - \ either complete or abort a multipart upload.

You can optionally\ - \ request server-side encryption. For server-side encryption, Amazon S3 encrypts\ - \ your data as it writes it to disks in its data centers and decrypts it when\ - \ you access it. You can provide your own encryption key, or use Amazon Web\ - \ Services KMS keys or Amazon S3-managed encryption keys. If you choose to\ - \ provide your own encryption key, the request headers you provide in UploadPart\ - \ and UploadPartCopy requests must match the headers you used in the request\ - \ to initiate the upload by using CreateMultipartUpload.

\ - \

To perform a multipart upload with encryption using an Amazon Web Services\ - \ KMS key, the requester must have permission to the kms:Decrypt\ - \ and kms:GenerateDataKey* actions on the key. These permissions\ - \ are required because Amazon S3 must decrypt and read data from the encrypted\ - \ file parts before it completes the multipart upload. For more information,\ - \ see Multipart upload API and permissions in the Amazon S3 User Guide.

\ - \

If your Identity and Access Management (IAM) user or role is in the same\ - \ Amazon Web Services account as the KMS key, then you must have these permissions\ - \ on the key policy. If your IAM user or role belongs to a different account\ - \ than the key, then you must have the permissions on both the key policy\ - \ and your IAM user or role.

For more information, see Protecting Data Using Server-Side Encryption.

Access Permissions
\ - \

When copying an object, you can optionally specify the accounts\ - \ or groups that should be granted specific permissions on the new object.\ - \ There are two ways to grant the permissions using the request headers:

\ - \

  • Specify a canned ACL with the x-amz-acl request\ - \ header. For more information, see Canned ACL.

  • Specify access permissions explicitly with\ - \ the x-amz-grant-read, x-amz-grant-read-acp, x-amz-grant-write-acp,\ - \ and x-amz-grant-full-control headers. These parameters map\ - \ to the set of permissions that Amazon S3 supports in an ACL. For more information,\ - \ see Access Control List (ACL) Overview.

You can use either\ - \ a canned ACL or specify access permissions explicitly. You cannot do both.

\ - \
Server-Side- Encryption-Specific Request Headers

You\ - \ can optionally tell Amazon S3 to encrypt data at rest using server-side\ - \ encryption. Server-side encryption is for data encryption at rest. Amazon\ - \ S3 encrypts your data as it writes it to disks in its data centers and decrypts\ - \ it when you access it. The option you use depends on whether you want to\ - \ use Amazon Web Services managed encryption keys or provide your own encryption\ - \ key.

  • Use encryption keys managed by Amazon S3 or customer\ - \ managed key stored in Amazon Web Services Key Management Service (Amazon\ - \ Web Services KMS) \u2013 If you want Amazon Web Services to manage the keys\ - \ used to encrypt data, specify the following headers in the request.

    \ - \

    • x-amz-server-side-encryption

    • \ - \

      x-amz-server-side-encryption-aws-kms-key-id

      • \ - \

    • x-amz-server-side-encryption-context

    \ - \

    If you specify x-amz-server-side-encryption:aws:kms,\ - \ but don't provide x-amz-server-side-encryption-aws-kms-key-id,\ - \ Amazon S3 uses the Amazon Web Services managed key in Amazon Web Services\ - \ KMS to protect the data.

    All GET and PUT requests\ - \ for an object protected by Amazon Web Services KMS fail if you don't make\ - \ them with SSL or by using SigV4.

    For more information\ - \ about server-side encryption with KMS key (SSE-KMS), see Protecting Data Using Server-Side Encryption with KMS keys.

    • \ - \

  • Use customer-provided encryption keys \u2013 If you want to manage\ - \ your own encryption keys, provide all the following headers in the request.

    \ - \

    • x-amz-server-side-encryption-customer-algorithm\ - \

    • x-amz-server-side-encryption-customer-key\ - \

    • x-amz-server-side-encryption-customer-key-MD5\ - \

    For more information about server-side encryption with\ - \ KMS keys (SSE-KMS), see Protecting Data Using Server-Side Encryption with KMS keys.

    • \ - \
Access-Control-List (ACL)-Specific Request Headers
\ - \

You also can use the following access control\u2013related headers\ - \ with this operation. By default, all objects are private. Only the owner\ - \ has full access control. When adding a new object, you can grant permissions\ - \ to individual Amazon Web Services accounts or to predefined groups defined\ - \ by Amazon S3. These permissions are then added to the access control list\ - \ (ACL) on the object. For more information, see Using ACLs. With this operation, you can grant access permissions using\ - \ one of the following two methods:

  • Specify a canned ACL\ - \ (x-amz-acl) \u2014 Amazon S3 supports a set of predefined ACLs,\ - \ known as canned ACLs. Each canned ACL has a predefined set of grantees\ - \ and permissions. For more information, see Canned ACL.

  • Specify access permissions explicitly \u2014\ - \ To explicitly grant access permissions to specific Amazon Web Services accounts\ - \ or groups, use the following headers. Each header maps to specific permissions\ - \ that Amazon S3 supports in an ACL. For more information, see Access\ - \ Control List (ACL) Overview. In the header, you specify a list of grantees\ - \ who get the specific permission. To grant permissions explicitly, use:

    \ - \

    • x-amz-grant-read

    • x-amz-grant-write\ - \

    • x-amz-grant-read-acp

    • \ - \ x-amz-grant-write-acp

    • x-amz-grant-full-control\ - \

    You specify each grantee as a type=value pair, where\ - \ the type is one of the following:

    • id \u2013\ - \ if the value specified is the canonical user ID of an Amazon Web Services\ - \ account

    • uri \u2013 if you are granting permissions\ - \ to a predefined group

    • emailAddress \u2013\ - \ if the value specified is the email address of an Amazon Web Services account

      \ - \

      Using email addresses to specify a grantee is only supported in\ - \ the following Amazon Web Services Regions:

      • US East (N.\ - \ Virginia)

      • US West (N. California)

      • US\ - \ West (Oregon)

      • Asia Pacific (Singapore)

      • \ - \

        Asia Pacific (Sydney)

      • Asia Pacific (Tokyo)

        • \ - \

      • Europe (Ireland)

      • South America (S\xE3o Paulo)

        \ - \

      For a list of all the Amazon S3 supported Regions and endpoints,\ - \ see Regions and Endpoints in the Amazon Web Services General Reference.

      \ - \

    For example, the following x-amz-grant-read\ - \ header grants the Amazon Web Services accounts identified by account IDs\ - \ permissions to read object data and its metadata:

    x-amz-grant-read:\ - \ id=\"11112222333\", id=\"444455556666\"

\ - \

The following operations are related to CreateMultipartUpload:

\ - \ " - externalDocs: - url: http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadInitiate.html - operationId: CreateMultipartUpload - parameters: - - description:

The canned ACL to apply to the object.

This action - is not supported by Amazon S3 on Outposts.

- in: header - name: x-amz-acl - required: false - schema: - enum: - - private - - public-read - - public-read-write - - authenticated-read - - aws-exec-read - - bucket-owner-read - - bucket-owner-full-control - type: string - - description: Specifies caching behavior along the request/reply chain. - in: header - name: Cache-Control - required: false - schema: - type: string - - description: Specifies presentational information for the object. - in: header - name: Content-Disposition - required: false - schema: - type: string - - description: Specifies what content encodings have been applied to the object - and thus what decoding mechanisms must be applied to obtain the media-type - referenced by the Content-Type header field. - in: header - name: Content-Encoding - required: false - schema: - type: string - - description: The language the content is in. - in: header - name: Content-Language - required: false - schema: - type: string - - description: A standard MIME type describing the format of the object data. - in: header - name: Content-Type - required: false - schema: - type: string - - description: The date and time at which the object is no longer cacheable. - in: header - name: Expires - required: false - schema: - format: date-time - type: string - - description:

Gives the grantee READ, READ_ACP, and WRITE_ACP permissions - on the object.

This action is not supported by Amazon S3 on Outposts.

- in: header - name: x-amz-grant-full-control - required: false - schema: - type: string - - description:

Allows grantee to read the object data and its metadata.

-

This action is not supported by Amazon S3 on Outposts.

- in: header - name: x-amz-grant-read - required: false - schema: - type: string - - description:

Allows grantee to read the object ACL.

This action - is not supported by Amazon S3 on Outposts.

- in: header - name: x-amz-grant-read-acp - required: false - schema: - type: string - - description:

Allows grantee to write the ACL for the applicable object.

-

This action is not supported by Amazon S3 on Outposts.

- in: header - name: x-amz-grant-write-acp - required: false - schema: - type: string - - description: Object key for which the multipart upload is to be initiated. - in: path - name: Key - required: true - schema: - minLength: 1 - type: string - - description: The server-side encryption algorithm used when storing this object - in Amazon S3 (for example, AES256, aws:kms). - in: header - name: x-amz-server-side-encryption - required: false - schema: - enum: - - AES256 - - aws:kms - type: string - - description: By default, Amazon S3 uses the STANDARD Storage Class to store - newly created objects. The STANDARD storage class provides high durability - and high availability. Depending on performance needs, you can specify a - different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage - Class. For more information, see Storage - Classes in the Amazon S3 User Guide. - in: header - name: x-amz-storage-class - required: false - schema: - enum: - - STANDARD - - REDUCED_REDUNDANCY - - STANDARD_IA - - ONEZONE_IA - - INTELLIGENT_TIERING - - GLACIER - - DEEP_ARCHIVE - - OUTPOSTS - - GLACIER_IR - type: string - - description: If the bucket is configured as a website, redirects requests - for this object to another object in the same bucket or to an external URL. - Amazon S3 stores the value of this header in the object metadata. - in: header - name: x-amz-website-redirect-location - required: false - schema: - type: string - - description: Specifies the algorithm to use to when encrypting the object - (for example, AES256). - in: header - name: x-amz-server-side-encryption-customer-algorithm - required: false - schema: - type: string - - description: Specifies the customer-provided encryption key for Amazon S3 - to use in encrypting data. This value is used to store the object and then - it is discarded; Amazon S3 does not store the encryption key. The key must - be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm - header. - in: header - name: x-amz-server-side-encryption-customer-key - required: false - schema: - format: password - type: string - - description: Specifies the 128-bit MD5 digest of the encryption key according - to RFC 1321. Amazon S3 uses this header for a message integrity check to - ensure that the encryption key was transmitted without error. - in: header - name: x-amz-server-side-encryption-customer-key-MD5 - required: false - schema: - type: string - - description: Specifies the ID of the symmetric customer managed key to use - for object encryption. All GET and PUT requests for an object protected - by Amazon Web Services KMS will fail if not made via SSL or using SigV4. - For information about configuring using any of the officially supported - Amazon Web Services SDKs and Amazon Web Services CLI, see Specifying - the Signature Version in Request Authentication in the Amazon S3 - User Guide. - in: header - name: x-amz-server-side-encryption-aws-kms-key-id - required: false - schema: - format: password - type: string - - description: Specifies the Amazon Web Services KMS Encryption Context to use - for object encryption. The value of this header is a base64-encoded UTF-8 - string holding JSON with the encryption context key-value pairs. - in: header - name: x-amz-server-side-encryption-context - required: false - schema: - format: password - type: string - - description: "

Specifies whether Amazon S3 should use an S3 Bucket Key for\ - \ object encryption with server-side encryption using AWS KMS (SSE-KMS).\ - \ Setting this header to true causes Amazon S3 to use an S3\ - \ Bucket Key for object encryption with SSE-KMS.

Specifying this\ - \ header with an object action doesn\u2019t affect bucket-level settings\ - \ for S3 Bucket Key.

" - in: header - name: x-amz-server-side-encryption-bucket-key-enabled - required: false - schema: - type: boolean - - description: '' - in: header - name: x-amz-request-payer - required: false - schema: - description: Confirms that the requester knows that they will be charged - for the request. Bucket owners need not specify this parameter in their - requests. For information about downloading objects from Requester Pays - buckets, see Downloading - Objects in Requester Pays Buckets in the Amazon S3 User Guide. - enum: - - requester - type: string - - description: The tag-set for the object. The tag-set must be encoded as URL - Query parameters. - in: header - name: x-amz-tagging - required: false - schema: - type: string - - description: Specifies the Object Lock mode that you want to apply to the - uploaded object. - in: header - name: x-amz-object-lock-mode - required: false - schema: - enum: - - GOVERNANCE - - COMPLIANCE - type: string - - description: Specifies the date and time when you want the Object Lock to - expire. - in: header - name: x-amz-object-lock-retain-until-date - required: false - schema: - format: date-time - type: string - - description: Specifies whether you want to apply a legal hold to the uploaded - object. - in: header - name: x-amz-object-lock-legal-hold - required: false - schema: - enum: - - 'ON' - - 'OFF' - type: string - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - description: Indicates the algorithm you want Amazon S3 to use to create the - checksum for the object. For more information, see Checking - object integrity in the Amazon S3 User Guide. - in: header - name: x-amz-checksum-algorithm - required: false - schema: - enum: - - CRC32 - - CRC32C - - SHA1 - - SHA256 - type: string - - allowEmptyValue: true - in: query - name: uploads - required: true - schema: - enum: - - true - type: boolean - requestBody: - content: - text/xml: - schema: - properties: - x-amz-meta-: - additionalProperties: - $ref: '#/components/schemas/MetadataValue' - description: A map of metadata to store with the object in S3. - type: object - type: object - required: true - responses: - '200': - content: - text/xml: - schema: - $ref: '#/components/schemas/CreateMultipartUploadOutput' - description: Success - /?accelerate: - get: - description:

This implementation of the GET action uses the accelerate - subresource to return the Transfer Acceleration state of a bucket, which is - either Enabled or Suspended. Amazon S3 Transfer - Acceleration is a bucket-level feature that enables you to perform faster - data transfers to and from Amazon S3.

To use this operation, you must - have permission to perform the s3:GetAccelerateConfiguration - action. The bucket owner has this permission by default. The bucket owner - can grant this permission to others. For more information about permissions, - see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to your Amazon S3 Resources in the Amazon S3 User - Guide.

You set the Transfer Acceleration state of an existing bucket - to Enabled or Suspended by using the PutBucketAccelerateConfiguration - operation.

A GET accelerate request does not return a - state value for a bucket that has no transfer acceleration state. A bucket - has no Transfer Acceleration state if a state has never been set on the bucket. -

For more information about transfer acceleration, see Transfer - Acceleration in the Amazon S3 User Guide.

Related - Resources

- operationId: GetBucketAccelerateConfiguration - parameters: - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: accelerate - required: true - schema: - enum: - - true - type: boolean - responses: - '200': - content: - text/xml: - schema: - $ref: '#/components/schemas/GetBucketAccelerateConfigurationOutput' - description: Success - parameters: - - $ref: '#/components/parameters/x-amz-security-token' - put: - description: "

Sets the accelerate configuration of an existing bucket. Amazon\ - \ S3 Transfer Acceleration is a bucket-level feature that enables you to perform\ - \ faster data transfers to Amazon S3.

To use this operation, you must\ - \ have permission to perform the s3:PutAccelerateConfiguration\ - \ action. The bucket owner has this permission by default. The bucket owner\ - \ can grant this permission to others. For more information about permissions,\ - \ see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

The\ - \ Transfer Acceleration state of a bucket can be set to one of the following\ - \ two values:

  • Enabled \u2013 Enables accelerated data transfers\ - \ to the bucket.

  • Suspended \u2013 Disables accelerated\ - \ data transfers to the bucket.

The GetBucketAccelerateConfiguration action returns the transfer acceleration\ - \ state of a bucket.

After setting the Transfer Acceleration state\ - \ of a bucket to Enabled, it might take up to thirty minutes before the data\ - \ transfer rates to the bucket increase.

The name of the bucket used\ - \ for Transfer Acceleration must be DNS-compliant and must not contain periods\ - \ (\".\").

For more information about transfer acceleration, see Transfer Acceleration.

The following operations are related to\ - \ PutBucketAccelerateConfiguration:

" - operationId: PutBucketAccelerateConfiguration - parameters: - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - description:

Indicates the algorithm used to create the checksum for the - object when using the SDK. This header will not provide any additional functionality - if not using the SDK. When sending this header, there must be a corresponding - x-amz-checksum or x-amz-trailer header sent. Otherwise, - Amazon S3 fails the request with the HTTP status code 400 Bad Request. - For more information, see Checking - object integrity in the Amazon S3 User Guide.

If you provide - an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm - parameter.

- in: header - name: x-amz-sdk-checksum-algorithm - required: false - schema: - enum: - - CRC32 - - CRC32C - - SHA1 - - SHA256 - type: string - - allowEmptyValue: true - in: query - name: accelerate - required: true - schema: - enum: - - true - type: boolean - requestBody: - content: - text/xml: - schema: - properties: - AccelerateConfiguration: - description: Configures the transfer acceleration state for an Amazon - S3 bucket. For more information, see Amazon - S3 Transfer Acceleration in the Amazon S3 User Guide. - properties: - Status: - allOf: - - $ref: '#/components/schemas/BucketAccelerateStatus' - - description: Specifies the transfer acceleration status of - the bucket. - type: object - required: - - AccelerateConfiguration - type: object - required: true - responses: - '200': - description: Success - /?acl: - get: - description:

This implementation of the GET action uses the - acl subresource to return the access control list (ACL) of a - bucket. To use GET to return the ACL of the bucket, you must - have READ_ACP access to the bucket. If READ_ACP - permission is granted to the anonymous user, you can return the ACL of the - bucket without using an authorization header.

If your bucket - uses the bucket owner enforced setting for S3 Object Ownership, requests to - read ACLs are still supported and return the bucket-owner-full-control - ACL with the owner being the account that created the bucket. For more information, - see - Controlling object ownership and disabling ACLs in the Amazon S3 User - Guide.

Related Resources

- externalDocs: - url: http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETacl.html - operationId: GetBucketAcl - parameters: - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: acl - required: true - schema: - enum: - - true - type: boolean - responses: - '200': - content: - text/xml: - schema: - $ref: '#/components/schemas/GetBucketAclOutput' - description: Success - parameters: - - $ref: '#/components/parameters/x-amz-security-token' - put: - description: "

Sets the permissions on an existing bucket using access control\ - \ lists (ACL). For more information, see Using ACLs. To set the ACL of a bucket, you must have WRITE_ACP\ - \ permission.

You can use one of the following two ways to set a bucket's\ - \ permissions:

  • Specify the ACL in the request body

    • \ - \

  • Specify permissions using request headers

\ - \

You cannot specify access permission using both the body and the request\ - \ headers.

Depending on your application needs, you may choose\ - \ to set the ACL on a bucket using either the request body or the headers.\ - \ For example, if you have an existing application that updates a bucket ACL\ - \ using the request body, then you can continue to use that approach.

\ - \

If your bucket uses the bucket owner enforced setting for\ - \ S3 Object Ownership, ACLs are disabled and no longer affect permissions.\ - \ You must use policies to grant access to your bucket and the objects in\ - \ it. Requests to set ACLs or update ACLs fail and return the AccessControlListNotSupported\ - \ error code. Requests to read ACLs are still supported. For more information,\ - \ see Controlling object ownership in the Amazon S3 User Guide.

\ - \

Access Permissions

You can set access permissions\ - \ using one of the following methods:

  • Specify a canned ACL\ - \ with the x-amz-acl request header. Amazon S3 supports a set\ - \ of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined\ - \ set of grantees and permissions. Specify the canned ACL name as the value\ - \ of x-amz-acl. If you use this header, you cannot use other\ - \ access control-specific headers in your request. For more information, see\ - \ Canned ACL.

  • Specify access permissions explicitly with\ - \ the x-amz-grant-read, x-amz-grant-read-acp, x-amz-grant-write-acp,\ - \ and x-amz-grant-full-control headers. When using these headers,\ - \ you specify explicit access permissions and grantees (Amazon Web Services\ - \ accounts or Amazon S3 groups) who will receive the permission. If you use\ - \ these ACL-specific headers, you cannot use the x-amz-acl header\ - \ to set a canned ACL. These parameters map to the set of permissions that\ - \ Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview.

    You specify each grantee as\ - \ a type=value pair, where the type is one of the following:

    • \ - \

      id \u2013 if the value specified is the canonical user\ - \ ID of an Amazon Web Services account

    • uri\ - \ \u2013 if you are granting permissions to a predefined group

    • \ - \

      emailAddress \u2013 if the value specified is the email\ - \ address of an Amazon Web Services account

      Using email addresses\ - \ to specify a grantee is only supported in the following Amazon Web Services\ - \ Regions:

      • US East (N. Virginia)

      • US West\ - \ (N. California)

      • US West (Oregon)

      • Asia\ - \ Pacific (Singapore)

      • Asia Pacific (Sydney)

      • \ - \

        Asia Pacific (Tokyo)

      • Europe (Ireland)

      • \ - \

        South America (S\xE3o Paulo)

      For a list of all the\ - \ Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

      \ - \

    For example, the following x-amz-grant-write\ - \ header grants create, overwrite, and delete objects permission to LogDelivery\ - \ group predefined by Amazon S3 and two Amazon Web Services accounts identified\ - \ by their email addresses.

    x-amz-grant-write: uri=\"http://acs.amazonaws.com/groups/s3/LogDelivery\"\ - , id=\"111122223333\", id=\"555566667777\"

You\ - \ can use either a canned ACL or specify access permissions explicitly. You\ - \ cannot do both.

Grantee Values

You can specify the\ - \ person (grantee) to whom you're assigning access rights (using request elements)\ - \ in the following ways:

  • By the person's ID:

    <Grantee\ - \ xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"CanonicalUser\"\ - ><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName>\ - \ </Grantee>

    DisplayName is optional and ignored in the\ - \ request

  • By URI:

    <Grantee xmlns:xsi=\"\ - http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"Group\"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee>\ - \

  • By Email address:

    <Grantee xmlns:xsi=\"\ - http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"AmazonCustomerByEmail\"\ - ><EmailAddress><>Grantees@email.com<></EmailAddress>lt;/Grantee>\ - \

    The grantee is resolved to the CanonicalUser and, in a response\ - \ to a GET Object acl request, appears as the CanonicalUser.

    Using\ - \ email addresses to specify a grantee is only supported in the following\ - \ Amazon Web Services Regions:

    • US East (N. Virginia)

      \ - \

    • US West (N. California)

    • US West (Oregon)

      \ - \

    • Asia Pacific (Singapore)

    • Asia Pacific (Sydney)

      \ - \

    • Asia Pacific (Tokyo)

    • Europe (Ireland)

      \ - \

    • South America (S\xE3o Paulo)

    For a list\ - \ of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

    \ - \

Related Resources

" - externalDocs: - url: http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTacl.html - operationId: PutBucketAcl - parameters: - - description: The canned ACL to apply to the bucket. - in: header - name: x-amz-acl - required: false - schema: - enum: - - private - - public-read - - public-read-write - - authenticated-read - type: string - - description:

The base64-encoded 128-bit MD5 digest of the data. This header - must be used as a message integrity check to verify that the request body - was not corrupted in transit. For more information, go to RFC - 1864.

For requests made using the Amazon Web Services Command - Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated - automatically.

- in: header - name: Content-MD5 - required: false - schema: - type: string - - description:

Indicates the algorithm used to create the checksum for the - object when using the SDK. This header will not provide any additional functionality - if not using the SDK. When sending this header, there must be a corresponding - x-amz-checksum or x-amz-trailer header sent. Otherwise, - Amazon S3 fails the request with the HTTP status code 400 Bad Request. - For more information, see Checking - object integrity in the Amazon S3 User Guide.

If you provide - an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm - parameter.

- in: header - name: x-amz-sdk-checksum-algorithm - required: false - schema: - enum: - - CRC32 - - CRC32C - - SHA1 - - SHA256 - type: string - - description: Allows grantee the read, write, read ACP, and write ACP permissions - on the bucket. - in: header - name: x-amz-grant-full-control - required: false - schema: - type: string - - description: Allows grantee to list the objects in the bucket. - in: header - name: x-amz-grant-read - required: false - schema: - type: string - - description: Allows grantee to read the bucket ACL. - in: header - name: x-amz-grant-read-acp - required: false - schema: - type: string - - description:

Allows grantee to create new objects in the bucket.

For - the bucket and object owners of existing objects, also allows deletions - and overwrites of those objects.

- in: header - name: x-amz-grant-write - required: false - schema: - type: string - - description: Allows grantee to write the ACL for the applicable bucket. - in: header - name: x-amz-grant-write-acp - required: false - schema: - type: string - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: acl - required: true - schema: - enum: - - true - type: boolean - requestBody: - content: - text/xml: - schema: - properties: - AccessControlPolicy: - description: Contains the elements that set the ACL permissions - for an object per grantee. - properties: - AccessControlList: - allOf: - - $ref: '#/components/schemas/Grants' - - description: A list of grants. - Owner: - allOf: - - $ref: '#/components/schemas/Owner' - - description: Container for the bucket owner's display name - and ID. - type: object - type: object - required: true - responses: - '200': - description: Success - /?analytics: - get: - description: "

Lists the analytics configurations for the bucket. You can\ - \ have up to 1,000 analytics configurations per bucket.

This action\ - \ supports list pagination and does not return more than 100 configurations\ - \ at a time. You should always check the IsTruncated element\ - \ in the response. If there are no more configurations to list, IsTruncated\ - \ is set to false. If there are more configurations to list, IsTruncated\ - \ is set to true, and there will be a value in NextContinuationToken.\ - \ You use the NextContinuationToken value to continue the pagination\ - \ of the list by passing the value in continuation-token in the request to\ - \ GET the next page.

To use this operation, you must have\ - \ permissions to perform the s3:GetAnalyticsConfiguration action.\ - \ The bucket owner has this permission by default. The bucket owner can grant\ - \ this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

For information\ - \ about Amazon S3 analytics feature, see Amazon S3 Analytics \u2013 Storage Class Analysis.

The following\ - \ operations are related to ListBucketAnalyticsConfigurations:

\ - \ " - operationId: ListBucketAnalyticsConfigurations - parameters: - - description: The ContinuationToken that represents a placeholder from where - this request should begin. - in: query - name: continuation-token - required: false - schema: - type: string - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: analytics - required: true - schema: - enum: - - true - type: boolean - responses: - '200': - content: - text/xml: - schema: - $ref: '#/components/schemas/ListBucketAnalyticsConfigurationsOutput' - description: Success - parameters: - - $ref: '#/components/parameters/x-amz-security-token' - /?analytics#id: - delete: - description: "

Deletes an analytics configuration for the bucket (specified\ - \ by the analytics configuration ID).

To use this operation, you must\ - \ have permissions to perform the s3:PutAnalyticsConfiguration\ - \ action. The bucket owner has this permission by default. The bucket owner\ - \ can grant this permission to others. For more information about permissions,\ - \ see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

For information\ - \ about the Amazon S3 analytics feature, see Amazon S3 Analytics \u2013 Storage Class Analysis.

The following\ - \ operations are related to DeleteBucketAnalyticsConfiguration:

\ - \ " - operationId: DeleteBucketAnalyticsConfiguration - parameters: - - description: The ID that identifies the analytics configuration. - in: query - name: id - required: true - schema: - type: string - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: analytics - required: true - schema: - enum: - - true - type: boolean - responses: - '204': - description: Success - get: - description: "

This implementation of the GET action returns an analytics\ - \ configuration (identified by the analytics configuration ID) from the bucket.

\ - \

To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration\ - \ action. The bucket owner has this permission by default. The bucket owner\ - \ can grant this permission to others. For more information about permissions,\ - \ see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources in the Amazon\ - \ S3 User Guide.

For information about Amazon S3 analytics feature,\ - \ see Amazon S3 Analytics \u2013 Storage Class Analysis in the Amazon S3\ - \ User Guide.

Related Resources

" - operationId: GetBucketAnalyticsConfiguration - parameters: - - description: The ID that identifies the analytics configuration. - in: query - name: id - required: true - schema: - type: string - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: analytics - required: true - schema: - enum: - - true - type: boolean - responses: - '200': - content: - text/xml: - schema: - $ref: '#/components/schemas/GetBucketAnalyticsConfigurationOutput' - description: Success - parameters: - - $ref: '#/components/parameters/x-amz-security-token' - put: - description: "

Sets an analytics configuration for the bucket (specified by\ - \ the analytics configuration ID). You can have up to 1,000 analytics configurations\ - \ per bucket.

You can choose to have storage class analysis export\ - \ analysis reports sent to a comma-separated values (CSV) flat file. See the\ - \ DataExport request element. Reports are updated daily and are\ - \ based on the object filters that you configure. When selecting data export,\ - \ you specify a destination bucket and an optional destination prefix where\ - \ the file is written. You can export the data to a destination bucket in\ - \ a different account. However, the destination bucket must be in the same\ - \ Region as the bucket that you are making the PUT analytics configuration\ - \ to. For more information, see Amazon S3 Analytics \u2013 Storage Class Analysis.

You\ - \ must create a bucket policy on the destination bucket where the exported\ - \ file is written to grant permissions to Amazon S3 to write objects to the\ - \ bucket. For an example policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.

\ - \

To use this operation, you must have permissions to perform\ - \ the s3:PutAnalyticsConfiguration action. The bucket owner has\ - \ this permission by default. The bucket owner can grant this permission to\ - \ others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

Special Errors

    • HTTP Error:\ - \ HTTP 400 Bad Request

    • Code: InvalidArgument\ - \

    • Cause: Invalid argument.

    • \ - \

    • HTTP Error: HTTP 400 Bad Request

    • \ - \

      Code: TooManyConfigurations

    • Cause: You\ - \ are attempting to create a new configuration but have already reached the\ - \ 1,000-configuration limit.

    • \ - \ HTTP Error: HTTP 403 Forbidden

    • Code: AccessDenied\ - \

    • Cause: You are not the owner of the specified bucket,\ - \ or you do not have the s3:PutAnalyticsConfiguration bucket permission to\ - \ set the configuration on the bucket.

Related Resources

" - operationId: PutBucketAnalyticsConfiguration - parameters: - - description: The ID that identifies the analytics configuration. - in: query - name: id - required: true - schema: - type: string - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: analytics - required: true - schema: - enum: - - true - type: boolean - requestBody: - content: - text/xml: - schema: - properties: - AnalyticsConfiguration: - description: Specifies the configuration and any analyses for the - analytics filter of an Amazon S3 bucket. - properties: - Filter: - allOf: - - $ref: '#/components/schemas/AnalyticsFilter' - - description: The filter used to describe a set of objects - for analyses. A filter must have exactly one prefix, one - tag, or one conjunction (AnalyticsAndOperator). If no filter - is provided, all objects will be considered in any analysis. - Id: - allOf: - - $ref: '#/components/schemas/AnalyticsId' - - description: The ID that identifies the analytics configuration. - StorageClassAnalysis: - allOf: - - $ref: '#/components/schemas/StorageClassAnalysis' - - description: ' Contains data related to access patterns to - be collected and made available to analyze the tradeoffs - between different storage classes. ' - type: object - required: - - AnalyticsConfiguration - type: object - required: true - responses: - '200': - description: Success - /?cors: - delete: - description:

Deletes the cors configuration information set - for the bucket.

To use this operation, you must have permission to - perform the s3:PutBucketCORS action. The bucket owner has this - permission by default and can grant this permission to others.

For - information about cors, see Enabling - Cross-Origin Resource Sharing in the Amazon S3 User Guide.

-

Related Resources:

- externalDocs: - url: http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETEcors.html - operationId: DeleteBucketCors - parameters: - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: cors - required: true - schema: - enum: - - true - type: boolean - responses: - '204': - description: Success - get: - description:

Returns the Cross-Origin Resource Sharing (CORS) configuration - information set for the bucket.

To use this operation, you must have - permission to perform the s3:GetBucketCORS action. By default, - the bucket owner has this permission and can grant it to others.

For - more information about CORS, see - Enabling Cross-Origin Resource Sharing.

The following operations - are related to GetBucketCors:

- externalDocs: - url: http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETcors.html - operationId: GetBucketCors - parameters: - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: cors - required: true - schema: - enum: - - true - type: boolean - responses: - '200': - content: - text/xml: - schema: - $ref: '#/components/schemas/GetBucketCorsOutput' - description: Success - parameters: - - $ref: '#/components/parameters/x-amz-security-token' - put: - description:

Sets the cors configuration for your bucket. If - the configuration exists, Amazon S3 replaces it.

To use this operation, - you must be allowed to perform the s3:PutBucketCORS action. By - default, the bucket owner has this permission and can grant it to others.

-

You set this configuration on a bucket so that the bucket can service cross-origin - requests. For example, you might want to enable a request whose origin is - http://www.example.com to access your Amazon S3 bucket at my.example.bucket.com - by using the browser's XMLHttpRequest capability.

To enable - cross-origin resource sharing (CORS) on a bucket, you add the cors - subresource to the bucket. The cors subresource is an XML document - in which you configure rules that identify origins and the HTTP methods that - can be executed on your bucket. The document is limited to 64 KB in size. -

When Amazon S3 receives a cross-origin request (or a pre-flight OPTIONS - request) against a bucket, it evaluates the cors configuration - on the bucket and uses the first CORSRule rule that matches the - incoming browser request to enable a cross-origin request. For a rule to match, - the following conditions must be met:

  • The request's Origin - header must match AllowedOrigin elements.

  • The - request method (for example, GET, PUT, HEAD, and so on) or the Access-Control-Request-Method - header in case of a pre-flight OPTIONS request must be one of - the AllowedMethod elements.

  • Every header specified - in the Access-Control-Request-Headers request header of a pre-flight - request must match an AllowedHeader element.

-

For more information about CORS, go to Enabling - Cross-Origin Resource Sharing in the Amazon S3 User Guide.

-

Related Resources

- externalDocs: - url: http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTcors.html - operationId: PutBucketCors - parameters: - - description:

The base64-encoded 128-bit MD5 digest of the data. This header - must be used as a message integrity check to verify that the request body - was not corrupted in transit. For more information, go to RFC - 1864.

For requests made using the Amazon Web Services Command - Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated - automatically.

- in: header - name: Content-MD5 - required: false - schema: - type: string - - description:

Indicates the algorithm used to create the checksum for the - object when using the SDK. This header will not provide any additional functionality - if not using the SDK. When sending this header, there must be a corresponding - x-amz-checksum or x-amz-trailer header sent. Otherwise, - Amazon S3 fails the request with the HTTP status code 400 Bad Request. - For more information, see Checking - object integrity in the Amazon S3 User Guide.

If you provide - an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm - parameter.

- in: header - name: x-amz-sdk-checksum-algorithm - required: false - schema: - enum: - - CRC32 - - CRC32C - - SHA1 - - SHA256 - type: string - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: cors - required: true - schema: - enum: - - true - type: boolean - requestBody: - content: - text/xml: - schema: - properties: - CORSConfiguration: - description: Describes the cross-origin access configuration for - objects in an Amazon S3 bucket. For more information, see Enabling - Cross-Origin Resource Sharing in the Amazon S3 User Guide. - properties: - CORSRule: - allOf: - - $ref: '#/components/schemas/CORSRules' - - description: A set of origins and methods (cross-origin access - that you want to allow). You can add up to 100 rules to - the configuration. - type: object - required: - - CORSConfiguration - type: object - required: true - responses: - '200': - description: Success - /?delete: - parameters: - - $ref: '#/components/parameters/x-amz-security-token' - post: - description: '

This action enables you to delete multiple objects from a bucket - using a single HTTP request. If you know the object keys that you want to - delete, then this action provides a suitable alternative to sending individual - delete requests, reducing per-request overhead.

The request contains - a list of up to 1000 keys that you want to delete. In the XML, you provide - the object key names, and optionally, version IDs if you want to delete a - specific version of the object from a versioning-enabled bucket. For each - key, Amazon S3 performs a delete action and returns the result of that delete, - success, or failure, in the response. Note that if the object specified in - the request is not found, Amazon S3 returns the result as deleted.

- The action supports two modes for the response: verbose and quiet. By default, - the action uses verbose mode in which the response includes the result of - deletion of each key in your request. In quiet mode the response includes - only keys where the delete action encountered an error. For a successful deletion, - the action does not return any information about the delete in the response - body.

When performing this action on an MFA Delete enabled bucket, - that attempts to delete any versioned objects, you must include an MFA token. - If you do not provide one, the entire request will fail, even if there are - non-versioned objects you are trying to delete. If you provide an invalid - token, whether there are versioned keys in the request or not, the entire - Multi-Object Delete request will fail. For information about MFA Delete, see - - MFA Delete.

Finally, the Content-MD5 header is required for all - Multi-Object Delete requests. Amazon S3 uses the header value to ensure that - your request body has not been altered in transit.

The following operations - are related to DeleteObjects:

' - externalDocs: - url: http://docs.amazonwebservices.com/AmazonS3/latest/API/multiobjectdeleteapi.html - operationId: DeleteObjects - parameters: - - description: The concatenation of the authentication device's serial number, - a space, and the value that is displayed on your authentication device. - Required to permanently delete a versioned object if versioning is configured - with MFA delete enabled. - in: header - name: x-amz-mfa - required: false - schema: - type: string - - description: '' - in: header - name: x-amz-request-payer - required: false - schema: - description: Confirms that the requester knows that they will be charged - for the request. Bucket owners need not specify this parameter in their - requests. For information about downloading objects from Requester Pays - buckets, see Downloading - Objects in Requester Pays Buckets in the Amazon S3 User Guide. - enum: - - requester - type: string - - description: Specifies whether you want to delete this object even if it has - a Governance-type Object Lock in place. To use this header, you must have - the s3:BypassGovernanceRetention permission. - in: header - name: x-amz-bypass-governance-retention - required: false - schema: - type: boolean - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - description:

Indicates the algorithm used to create the checksum for the - object when using the SDK. This header will not provide any additional functionality - if not using the SDK. When sending this header, there must be a corresponding - x-amz-checksum or x-amz-trailer header sent. Otherwise, - Amazon S3 fails the request with the HTTP status code 400 Bad Request. - For more information, see Checking - object integrity in the Amazon S3 User Guide.

If you provide - an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm - parameter.

This checksum algorithm must be the same for all parts - and it match the checksum value supplied in the CreateMultipartUpload - request.

- in: header - name: x-amz-sdk-checksum-algorithm - required: false - schema: - enum: - - CRC32 - - CRC32C - - SHA1 - - SHA256 - type: string - - allowEmptyValue: true - in: query - name: delete - required: true - schema: - enum: - - true - type: boolean - requestBody: - content: - text/xml: - schema: - properties: - Delete: - description: Container for the objects to delete. - properties: - Object: - allOf: - - $ref: '#/components/schemas/ObjectIdentifierList' - - description: The objects to delete. - Quiet: - allOf: - - $ref: '#/components/schemas/Quiet' - - description: Element to enable quiet mode for the request. - When you add this element, you must set its value to true. - type: object - required: - - Delete - type: object - required: true - responses: - '200': - content: - text/xml: - schema: - $ref: '#/components/schemas/DeleteObjectsOutput' - description: Success - /?encryption: - delete: - description:

This implementation of the DELETE action removes default encryption - from the bucket. For information about the Amazon S3 default encryption feature, - see Amazon - S3 Default Bucket Encryption in the Amazon S3 User Guide.

To - use this operation, you must have permissions to perform the s3:PutEncryptionConfiguration - action. The bucket owner has this permission by default. The bucket owner - can grant this permission to others. For more information about permissions, - see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to your Amazon S3 Resources in the Amazon S3 User - Guide.

Related Resources

- operationId: DeleteBucketEncryption - parameters: - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: encryption - required: true - schema: - enum: - - true - type: boolean - responses: - '204': - description: Success - get: - description:

Returns the default encryption configuration for an Amazon S3 - bucket. If the bucket does not have a default encryption configuration, GetBucketEncryption - returns ServerSideEncryptionConfigurationNotFoundError.

-

For information about the Amazon S3 default encryption feature, see Amazon - S3 Default Bucket Encryption.

To use this operation, you must - have permission to perform the s3:GetEncryptionConfiguration - action. The bucket owner has this permission by default. The bucket owner - can grant this permission to others. For more information about permissions, - see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources.

The following operations - are related to GetBucketEncryption:

- operationId: GetBucketEncryption - parameters: - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: encryption - required: true - schema: - enum: - - true - type: boolean - responses: - '200': - content: - text/xml: - schema: - $ref: '#/components/schemas/GetBucketEncryptionOutput' - description: Success - parameters: - - $ref: '#/components/parameters/x-amz-security-token' - put: - description:

This action uses the encryption subresource to - configure default encryption and Amazon S3 Bucket Key for an existing bucket.

-

Default encryption for a bucket can use server-side encryption with Amazon - S3-managed keys (SSE-S3) or customer managed keys (SSE-KMS). If you specify - default encryption using SSE-KMS, you can also configure Amazon S3 Bucket - Key. When the default encryption is SSE-KMS, if you upload an object to the - bucket and do not specify the KMS key to use for encryption, Amazon S3 uses - the default Amazon Web Services managed KMS key for your account. For information - about default encryption, see Amazon - S3 default bucket encryption in the Amazon S3 User Guide. For more - information about S3 Bucket Keys, see Amazon - S3 Bucket Keys in the Amazon S3 User Guide.

This - action requires Amazon Web Services Signature Version 4. For more information, - see - Authenticating Requests (Amazon Web Services Signature Version 4).

-

To use this operation, you must have permissions to perform - the s3:PutEncryptionConfiguration action. The bucket owner has - this permission by default. The bucket owner can grant this permission to - others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources in the Amazon S3 User Guide. -

Related Resources

- operationId: PutBucketEncryption - parameters: - - description:

The base64-encoded 128-bit MD5 digest of the server-side encryption - configuration.

For requests made using the Amazon Web Services Command - Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated - automatically.

- in: header - name: Content-MD5 - required: false - schema: - type: string - - description:

Indicates the algorithm used to create the checksum for the - object when using the SDK. This header will not provide any additional functionality - if not using the SDK. When sending this header, there must be a corresponding - x-amz-checksum or x-amz-trailer header sent. Otherwise, - Amazon S3 fails the request with the HTTP status code 400 Bad Request. - For more information, see Checking - object integrity in the Amazon S3 User Guide.

If you provide - an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm - parameter.

- in: header - name: x-amz-sdk-checksum-algorithm - required: false - schema: - enum: - - CRC32 - - CRC32C - - SHA1 - - SHA256 - type: string - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: encryption - required: true - schema: - enum: - - true - type: boolean - requestBody: - content: - text/xml: - schema: - properties: - ServerSideEncryptionConfiguration: - description: Specifies the default server-side-encryption configuration. - properties: - Rule: - allOf: - - $ref: '#/components/schemas/ServerSideEncryptionRules' - - description: Container for information about a particular - server-side encryption configuration rule. - type: object - required: - - ServerSideEncryptionConfiguration - type: object - required: true - responses: - '200': - description: Success - /?intelligent-tiering: - get: - description: '

Lists the S3 Intelligent-Tiering configuration from the specified - bucket.

The S3 Intelligent-Tiering storage class is designed to optimize - storage costs by automatically moving data to the most cost-effective storage - access tier, without performance impact or operational overhead. S3 Intelligent-Tiering - delivers automatic cost savings in three low latency and high throughput access - tiers. To get the lowest storage cost on data that can be accessed in minutes - to hours, you can choose to activate additional archiving capabilities.

-

The S3 Intelligent-Tiering storage class is the ideal storage class for - data with unknown, changing, or unpredictable access patterns, independent - of object size or retention period. If the size of an object is less than - 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects - can be stored, but they are always charged at the Frequent Access tier rates - in the S3 Intelligent-Tiering storage class.

For more information, - see Storage - class for automatically optimizing frequently and infrequently accessed objects.

-

Operations related to ListBucketIntelligentTieringConfigurations - include:

' - operationId: ListBucketIntelligentTieringConfigurations - parameters: - - description: The ContinuationToken that represents a placeholder - from where this request should begin. - in: query - name: continuation-token - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: intelligent-tiering - required: true - schema: - enum: - - true - type: boolean - responses: - '200': - content: - text/xml: - schema: - $ref: '#/components/schemas/ListBucketIntelligentTieringConfigurationsOutput' - description: Success - parameters: - - $ref: '#/components/parameters/x-amz-security-token' - /?intelligent-tiering#id: - delete: - description: '

Deletes the S3 Intelligent-Tiering configuration from the specified - bucket.

The S3 Intelligent-Tiering storage class is designed to optimize - storage costs by automatically moving data to the most cost-effective storage - access tier, without performance impact or operational overhead. S3 Intelligent-Tiering - delivers automatic cost savings in three low latency and high throughput access - tiers. To get the lowest storage cost on data that can be accessed in minutes - to hours, you can choose to activate additional archiving capabilities.

-

The S3 Intelligent-Tiering storage class is the ideal storage class for - data with unknown, changing, or unpredictable access patterns, independent - of object size or retention period. If the size of an object is less than - 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects - can be stored, but they are always charged at the Frequent Access tier rates - in the S3 Intelligent-Tiering storage class.

For more information, - see Storage - class for automatically optimizing frequently and infrequently accessed objects.

-

Operations related to DeleteBucketIntelligentTieringConfiguration - include:

' - operationId: DeleteBucketIntelligentTieringConfiguration - parameters: - - description: The ID used to identify the S3 Intelligent-Tiering configuration. - in: query - name: id - required: true - schema: - type: string - - allowEmptyValue: true - in: query - name: intelligent-tiering - required: true - schema: - enum: - - true - type: boolean - responses: - '204': - description: Success - get: - description: '

Gets the S3 Intelligent-Tiering configuration from the specified - bucket.

The S3 Intelligent-Tiering storage class is designed to optimize - storage costs by automatically moving data to the most cost-effective storage - access tier, without performance impact or operational overhead. S3 Intelligent-Tiering - delivers automatic cost savings in three low latency and high throughput access - tiers. To get the lowest storage cost on data that can be accessed in minutes - to hours, you can choose to activate additional archiving capabilities.

-

The S3 Intelligent-Tiering storage class is the ideal storage class for - data with unknown, changing, or unpredictable access patterns, independent - of object size or retention period. If the size of an object is less than - 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects - can be stored, but they are always charged at the Frequent Access tier rates - in the S3 Intelligent-Tiering storage class.

For more information, - see Storage - class for automatically optimizing frequently and infrequently accessed objects.

-

Operations related to GetBucketIntelligentTieringConfiguration - include:

' - operationId: GetBucketIntelligentTieringConfiguration - parameters: - - description: The ID used to identify the S3 Intelligent-Tiering configuration. - in: query - name: id - required: true - schema: - type: string - - allowEmptyValue: true - in: query - name: intelligent-tiering - required: true - schema: - enum: - - true - type: boolean - responses: - '200': - content: - text/xml: - schema: - $ref: '#/components/schemas/GetBucketIntelligentTieringConfigurationOutput' - description: Success - parameters: - - $ref: '#/components/parameters/x-amz-security-token' - put: - description: '

Puts a S3 Intelligent-Tiering configuration to the specified - bucket. You can have up to 1,000 S3 Intelligent-Tiering configurations per - bucket.

The S3 Intelligent-Tiering storage class is designed to optimize - storage costs by automatically moving data to the most cost-effective storage - access tier, without performance impact or operational overhead. S3 Intelligent-Tiering - delivers automatic cost savings in three low latency and high throughput access - tiers. To get the lowest storage cost on data that can be accessed in minutes - to hours, you can choose to activate additional archiving capabilities.

-

The S3 Intelligent-Tiering storage class is the ideal storage class for - data with unknown, changing, or unpredictable access patterns, independent - of object size or retention period. If the size of an object is less than - 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects - can be stored, but they are always charged at the Frequent Access tier rates - in the S3 Intelligent-Tiering storage class.

For more information, - see Storage - class for automatically optimizing frequently and infrequently accessed objects.

-

Operations related to PutBucketIntelligentTieringConfiguration - include:

You only need S3 Intelligent-Tiering enabled on - a bucket if you want to automatically move objects stored in the S3 Intelligent-Tiering - storage class to the Archive Access or Deep Archive Access tier.

 -

Special Errors

  • HTTP - 400 Bad Request Error

    • Code: InvalidArgument

      -

    • Cause: Invalid Argument

  • HTTP 400 Bad Request Error

    • Code: - TooManyConfigurations

    • Cause: You are attempting - to create a new configuration but have already reached the 1,000-configuration - limit.

  • HTTP 403 Forbidden - Error

    • Code: AccessDenied

    • - Cause: You are not the owner of the specified bucket, or you do not - have the s3:PutIntelligentTieringConfiguration bucket permission - to set the configuration on the bucket.

' - operationId: PutBucketIntelligentTieringConfiguration - parameters: - - description: The ID used to identify the S3 Intelligent-Tiering configuration. - in: query - name: id - required: true - schema: - type: string - - allowEmptyValue: true - in: query - name: intelligent-tiering - required: true - schema: - enum: - - true - type: boolean - requestBody: - content: - text/xml: - schema: - properties: - IntelligentTieringConfiguration: - description:

Specifies the S3 Intelligent-Tiering configuration - for an Amazon S3 bucket.

For information about the S3 Intelligent-Tiering - storage class, see Storage - class for automatically optimizing frequently and infrequently - accessed objects.

- properties: - Filter: - allOf: - - $ref: '#/components/schemas/IntelligentTieringFilter' - - description: Specifies a bucket filter. The configuration - only includes objects that meet the filter's criteria. - Id: - allOf: - - $ref: '#/components/schemas/IntelligentTieringId' - - description: The ID used to identify the S3 Intelligent-Tiering - configuration. - Status: - allOf: - - $ref: '#/components/schemas/IntelligentTieringStatus' - - description: Specifies the status of the configuration. - Tiering: - allOf: - - $ref: '#/components/schemas/TieringList' - - description: Specifies the S3 Intelligent-Tiering storage - class tier of the configuration. - type: object - required: - - IntelligentTieringConfiguration - type: object - required: true - responses: - '200': - description: Success - /?inventory: - get: - description:

Returns a list of inventory configurations for the bucket. You - can have up to 1,000 analytics configurations per bucket.

This action - supports list pagination and does not return more than 100 configurations - at a time. Always check the IsTruncated element in the response. - If there are no more configurations to list, IsTruncated is set - to false. If there are more configurations to list, IsTruncated - is set to true, and there is a value in NextContinuationToken. - You use the NextContinuationToken value to continue the pagination - of the list by passing the value in continuation-token in the request to GET - the next page.

To use this operation, you must have permissions to - perform the s3:GetInventoryConfiguration action. The bucket owner - has this permission by default. The bucket owner can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources.

For information - about the Amazon S3 inventory feature, see Amazon - S3 Inventory

The following operations are related to ListBucketInventoryConfigurations:

- - operationId: ListBucketInventoryConfigurations - parameters: - - description: The marker used to continue an inventory configuration listing - that has been truncated. Use the NextContinuationToken from a previously - truncated list response to continue the listing. The continuation token - is an opaque value that Amazon S3 understands. - in: query - name: continuation-token - required: false - schema: - type: string - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: inventory - required: true - schema: - enum: - - true - type: boolean - responses: - '200': - content: - text/xml: - schema: - $ref: '#/components/schemas/ListBucketInventoryConfigurationsOutput' - description: Success - parameters: - - $ref: '#/components/parameters/x-amz-security-token' - /?inventory#id: - delete: - description: '

Deletes an inventory configuration (identified by the inventory - ID) from the bucket.

To use this operation, you must have permissions - to perform the s3:PutInventoryConfiguration action. The bucket - owner has this permission by default. The bucket owner can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources.

For information - about the Amazon S3 inventory feature, see Amazon - S3 Inventory.

Operations related to DeleteBucketInventoryConfiguration - include:

' - operationId: DeleteBucketInventoryConfiguration - parameters: - - description: The ID used to identify the inventory configuration. - in: query - name: id - required: true - schema: - type: string - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: inventory - required: true - schema: - enum: - - true - type: boolean - responses: - '204': - description: Success - get: - description:

Returns an inventory configuration (identified by the inventory - configuration ID) from the bucket.

To use this operation, you must - have permissions to perform the s3:GetInventoryConfiguration - action. The bucket owner has this permission by default and can grant this - permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources.

For information - about the Amazon S3 inventory feature, see Amazon - S3 Inventory.

The following operations are related to GetBucketInventoryConfiguration:

- - operationId: GetBucketInventoryConfiguration - parameters: - - description: The ID used to identify the inventory configuration. - in: query - name: id - required: true - schema: - type: string - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: inventory - required: true - schema: - enum: - - true - type: boolean - responses: - '200': - content: - text/xml: - schema: - $ref: '#/components/schemas/GetBucketInventoryConfigurationOutput' - description: Success - parameters: - - $ref: '#/components/parameters/x-amz-security-token' - put: - description:

This implementation of the PUT action adds an inventory - configuration (identified by the inventory ID) to the bucket. You can have - up to 1,000 inventory configurations per bucket.

Amazon S3 inventory - generates inventories of the objects in the bucket on a daily or weekly basis, - and the results are published to a flat file. The bucket that is inventoried - is called the source bucket, and the bucket where the inventory flat - file is stored is called the destination bucket. The destination - bucket must be in the same Amazon Web Services Region as the source - bucket.

When you configure an inventory for a source bucket, - you specify the destination bucket where you want the inventory to - be stored, and whether to generate the inventory daily or weekly. You can - also configure what object metadata to include and whether to inventory all - object versions or only current versions. For more information, see Amazon - S3 Inventory in the Amazon S3 User Guide.

You must - create a bucket policy on the destination bucket to grant permissions - to Amazon S3 to write objects to the bucket in the defined location. For an - example policy, see - Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.

-

To use this operation, you must have permissions to perform - the s3:PutInventoryConfiguration action. The bucket owner has - this permission by default and can grant this permission to others. For more - information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources in the Amazon S3 User Guide.

-

Special Errors

  • HTTP - 400 Bad Request Error

    • Code: InvalidArgument

      -

    • Cause: Invalid Argument

  • HTTP 400 Bad Request Error

    • Code: - TooManyConfigurations

    • Cause: You are attempting - to create a new configuration but have already reached the 1,000-configuration - limit.

  • HTTP 403 Forbidden - Error

    • Code: AccessDenied

    • - Cause: You are not the owner of the specified bucket, or you do not - have the s3:PutInventoryConfiguration bucket permission to set - the configuration on the bucket.

- Related Resources

- operationId: PutBucketInventoryConfiguration - parameters: - - description: The ID used to identify the inventory configuration. - in: query - name: id - required: true - schema: - type: string - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: inventory - required: true - schema: - enum: - - true - type: boolean - requestBody: - content: - text/xml: - schema: - properties: - InventoryConfiguration: - description: 'Specifies the inventory configuration for an Amazon - S3 bucket. For more information, see GET - Bucket inventory in the Amazon S3 API Reference. ' - properties: - Destination: - allOf: - - $ref: '#/components/schemas/InventoryDestination' - - description: Contains information about where to publish the - inventory results. - Filter: - allOf: - - $ref: '#/components/schemas/InventoryFilter' - - description: Specifies an inventory filter. The inventory - only includes objects that meet the filter's criteria. - Id: - allOf: - - $ref: '#/components/schemas/InventoryId' - - description: The ID used to identify the inventory configuration. - IncludedObjectVersions: - allOf: - - $ref: '#/components/schemas/InventoryIncludedObjectVersions' - - description: Object versions to include in the inventory list. - If set to All, the list includes all the object - versions, which adds the version-related fields VersionId, - IsLatest, and DeleteMarker to - the list. If set to Current, the list does - not contain these version-related fields. - IsEnabled: - allOf: - - $ref: '#/components/schemas/IsEnabled' - - description: Specifies whether the inventory is enabled or - disabled. If set to True, an inventory list - is generated. If set to False, no inventory - list is generated. - OptionalFields: - allOf: - - $ref: '#/components/schemas/InventoryOptionalFields' - - description: Contains the optional fields that are included - in the inventory results. - Schedule: - allOf: - - $ref: '#/components/schemas/InventorySchedule' - - description: Specifies the schedule for generating inventory - results. - type: object - required: - - InventoryConfiguration - type: object - required: true - responses: - '200': - description: Success - /?lifecycle: - delete: - description:

Deletes the lifecycle configuration from the specified bucket. - Amazon S3 removes all the lifecycle configuration rules in the lifecycle subresource - associated with the bucket. Your objects never expire, and Amazon S3 no longer - automatically deletes any objects on the basis of rules contained in the deleted - lifecycle configuration.

To use this operation, you must have permission - to perform the s3:PutLifecycleConfiguration action. By default, - the bucket owner has this permission and the bucket owner can grant this permission - to others.

There is usually some time lag before lifecycle configuration - deletion is fully propagated to all the Amazon S3 systems.

For more - information about the object expiration, see Elements - to Describe Lifecycle Actions.

Related actions include:

- externalDocs: - url: http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETElifecycle.html - operationId: DeleteBucketLifecycle - parameters: - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: lifecycle - required: true - schema: - enum: - - true - type: boolean - responses: - '204': - description: Success - get: - description: '

Bucket lifecycle configuration now supports specifying - a lifecycle rule using an object key name prefix, one or more object tags, - or a combination of both. Accordingly, this section describes the latest API. - The response describes the new filter element that you can use to specify - a filter to select a subset of objects to which the rule applies. If you are - using a previous version of the lifecycle configuration, it still works. For - the earlier action, see GetBucketLifecycle.

-

Returns the lifecycle configuration information set on the bucket. - For information about lifecycle configuration, see Object - Lifecycle Management.

To use this operation, you must have permission - to perform the s3:GetLifecycleConfiguration action. The bucket - owner has this permission, by default. The bucket owner can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources.

GetBucketLifecycleConfiguration - has the following special error:

  • Error code: NoSuchLifecycleConfiguration -

    • Description: The lifecycle configuration does not exist.

      -

    • HTTP Status Code: 404 Not Found

    • SOAP Fault - Code Prefix: Client

The following operations - are related to GetBucketLifecycleConfiguration:

' - operationId: GetBucketLifecycleConfiguration - parameters: - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: lifecycle - required: true - schema: - enum: - - true - type: boolean - responses: - '200': - content: - text/xml: - schema: - $ref: '#/components/schemas/GetBucketLifecycleConfigurationOutput' - description: Success - parameters: - - $ref: '#/components/parameters/x-amz-security-token' - put: - description:

Creates a new lifecycle configuration for the bucket or replaces - an existing lifecycle configuration. Keep in mind that this will overwrite - an existing lifecycle configuration, so if you want to retain any configuration - details, they must be included in the new lifecycle configuration. For information - about lifecycle configuration, see Managing - your storage lifecycle.

Bucket lifecycle configuration now - supports specifying a lifecycle rule using an object key name prefix, one - or more object tags, or a combination of both. Accordingly, this section describes - the latest API. The previous version of the API supported filtering based - only on an object key name prefix, which is supported for backward compatibility. - For the related API description, see PutBucketLifecycle.

-

Rules

You specify the lifecycle configuration in - your request body. The lifecycle configuration is specified as XML consisting - of one or more rules. An Amazon S3 Lifecycle configuration can have up to - 1,000 rules. This limit is not adjustable. Each rule consists of the following:

-

  • Filter identifying a subset of objects to which the rule applies. - The filter can be based on a key name prefix, object tags, or a combination - of both.

  • Status whether the rule is in effect.

    • -

  • One or more lifecycle transition and expiration actions that you want - Amazon S3 to perform on the objects identified by the filter. If the state - of your bucket is versioning-enabled or versioning-suspended, you can have - many versions of the same object (one current version and zero or more noncurrent - versions). Amazon S3 provides predefined actions that you can specify for - current and noncurrent object versions.

For more information, - see Object - Lifecycle Management and Lifecycle - Configuration Elements.

Permissions

By default, - all Amazon S3 resources are private, including buckets, objects, and related - subresources (for example, lifecycle configuration and website configuration). - Only the resource owner (that is, the Amazon Web Services account that created - it) can access the resource. The resource owner can optionally grant access - permissions to others by writing an access policy. For this operation, a user - must get the s3:PutLifecycleConfiguration permission.

You - can also explicitly deny permissions. Explicit deny also supersedes any other - permissions. If you want to block users or accounts from removing or deleting - objects from your bucket, you must deny them permissions for the following - actions:

  • s3:DeleteObject

  • - s3:DeleteObjectVersion

  • s3:PutLifecycleConfiguration -

For more information about permissions, see Managing - Access Permissions to Your Amazon S3 Resources.

The following are - related to PutBucketLifecycleConfiguration:

- operationId: PutBucketLifecycleConfiguration - parameters: - - description:

Indicates the algorithm used to create the checksum for the - object when using the SDK. This header will not provide any additional functionality - if not using the SDK. When sending this header, there must be a corresponding - x-amz-checksum or x-amz-trailer header sent. Otherwise, - Amazon S3 fails the request with the HTTP status code 400 Bad Request. - For more information, see Checking - object integrity in the Amazon S3 User Guide.

If you provide - an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm - parameter.

- in: header - name: x-amz-sdk-checksum-algorithm - required: false - schema: - enum: - - CRC32 - - CRC32C - - SHA1 - - SHA256 - type: string - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: lifecycle - required: true - schema: - enum: - - true - type: boolean - requestBody: - content: - text/xml: - schema: - properties: - LifecycleConfiguration: - description: Specifies the lifecycle configuration for objects in - an Amazon S3 bucket. For more information, see Object - Lifecycle Management in the Amazon S3 User Guide. - properties: - Rule: - allOf: - - $ref: '#/components/schemas/LifecycleRules' - - description: A lifecycle rule for individual objects in an - Amazon S3 bucket. - type: object - type: object - required: true - responses: - '200': - description: Success - /?lifecycle#deprecated!: - get: - deprecated: true - description: '

For an updated version of this API, see GetBucketLifecycleConfiguration. - If you configured a bucket lifecycle using the filter element, - you should see the updated version of this topic. This topic is provided for - backward compatibility.

Returns the lifecycle configuration - information set on the bucket. For information about lifecycle configuration, - see Object - Lifecycle Management.

To use this operation, you must have permission - to perform the s3:GetLifecycleConfiguration action. The bucket - owner has this permission by default. The bucket owner can grant this permission - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources.

GetBucketLifecycle - has the following special error:

  • Error code: NoSuchLifecycleConfiguration -

    • Description: The lifecycle configuration does not exist.

      -

    • HTTP Status Code: 404 Not Found

    • SOAP Fault - Code Prefix: Client

The following operations - are related to GetBucketLifecycle:

' - externalDocs: - url: http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETlifecycle.html - operationId: GetBucketLifecycle - parameters: - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: lifecycle - required: true - schema: - enum: - - true - type: boolean - responses: - '200': - content: - text/xml: - schema: - $ref: '#/components/schemas/GetBucketLifecycleOutput' - description: Success - parameters: - - $ref: '#/components/parameters/x-amz-security-token' - put: - deprecated: true - description: "

For an updated version of this API, see PutBucketLifecycleConfiguration. This version has been deprecated. Existing\ - \ lifecycle configurations will work. For new lifecycle configurations, use\ - \ the updated API.

Creates a new lifecycle configuration\ - \ for the bucket or replaces an existing lifecycle configuration. For information\ - \ about lifecycle configuration, see Object Lifecycle Management in the Amazon S3 User Guide.

\ - \

By default, all Amazon S3 resources, including buckets, objects, and\ - \ related subresources (for example, lifecycle configuration and website configuration)\ - \ are private. Only the resource owner, the Amazon Web Services account that\ - \ created the resource, can access it. The resource owner can optionally grant\ - \ access permissions to others by writing an access policy. For this operation,\ - \ users must get the s3:PutLifecycleConfiguration permission.

\ - \

You can also explicitly deny permissions. Explicit denial also supersedes\ - \ any other permissions. If you want to prevent users or accounts from removing\ - \ or deleting objects from your bucket, you must deny them permissions for\ - \ the following actions:

  • s3:DeleteObject

    \ - \

  • s3:DeleteObjectVersion

  • s3:PutLifecycleConfiguration\ - \

For more information about permissions, see Managing Access Permissions to your Amazon S3 Resources in the Amazon\ - \ S3 User Guide.

For more examples of transitioning objects to\ - \ storage classes such as STANDARD_IA or ONEZONE_IA, see Examples of Lifecycle Configuration.

Related\ - \ Resources

" - externalDocs: - url: http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTlifecycle.html - operationId: PutBucketLifecycle - parameters: - - description:

For requests made using the Amazon Web Services Command - Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated - automatically.

- in: header - name: Content-MD5 - required: false - schema: - type: string - - description:

Indicates the algorithm used to create the checksum for the - object when using the SDK. This header will not provide any additional functionality - if not using the SDK. When sending this header, there must be a corresponding - x-amz-checksum or x-amz-trailer header sent. Otherwise, - Amazon S3 fails the request with the HTTP status code 400 Bad Request. - For more information, see Checking - object integrity in the Amazon S3 User Guide.

If you provide - an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm - parameter.

- in: header - name: x-amz-sdk-checksum-algorithm - required: false - schema: - enum: - - CRC32 - - CRC32C - - SHA1 - - SHA256 - type: string - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: lifecycle - required: true - schema: - enum: - - true - type: boolean - requestBody: - content: - text/xml: - schema: - properties: - LifecycleConfiguration: - description: Container for lifecycle rules. You can add as many - as 1000 rules. - properties: - Rule: - allOf: - - $ref: '#/components/schemas/Rules' - - description: 'Specifies lifecycle configuration rules for - an Amazon S3 bucket. ' - type: object - type: object - required: true - responses: - '200': - description: Success - /?list-type=2: - get: - description:

Returns some or all (up to 1,000) of the objects in a bucket - with each request. You can use the request parameters as selection criteria - to return a subset of the objects in a bucket. A 200 OK response - can contain valid or invalid XML. Make sure to design your application to - parse the contents of the response and handle it appropriately. Objects are - returned sorted in an ascending order of the respective key names in the list. - For more information about listing objects, see Listing - object keys programmatically

To use this operation, you must have - READ access to the bucket.

To use this action in an Identity and Access - Management (IAM) policy, you must have permissions to perform the s3:ListBucket - action. The bucket owner has this permission by default and can grant this - permission to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources.

This - section describes the latest revision of this action. We recommend that you - use this revised API for application development. For backward compatibility, - Amazon S3 continues to support the prior version of this API, ListObjects.

-

To get a list of your buckets, see ListBuckets.

-

The following operations are related to ListObjectsV2:

- - operationId: ListObjectsV2 - parameters: - - description: A delimiter is a character you use to group keys. - in: query - name: delimiter - required: false - schema: - type: string - - description: Encoding type used by Amazon S3 to encode object keys in the - response. - in: query - name: encoding-type - required: false - schema: - description: Requests Amazon S3 to encode the object keys in the response - and specifies the encoding method to use. An object key may contain any - Unicode character; however, XML 1.0 parser cannot parse some characters, - such as characters with an ASCII value from 0 to 10. For characters that - are not supported in XML 1.0, you can add this parameter to request that - Amazon S3 encode the keys in the response. - enum: - - url - type: string - - description: Sets the maximum number of keys returned in the response. By - default the action returns up to 1,000 key names. The response might contain - fewer keys but will never contain more. - in: query - name: max-keys - required: false - schema: - type: integer - - description: Limits the response to keys that begin with the specified prefix. - in: query - name: prefix - required: false - schema: - type: string - - description: ContinuationToken indicates Amazon S3 that the list is being - continued on this bucket with a token. ContinuationToken is obfuscated and - is not a real key. - in: query - name: continuation-token - required: false - schema: - type: string - - description: The owner field is not present in listV2 by default, if you want - to return owner field with each key in the result then set the fetch owner - field to true. - in: query - name: fetch-owner - required: false - schema: - type: boolean - - description: StartAfter is where you want Amazon S3 to start listing from. - Amazon S3 starts listing after this specified key. StartAfter can be any - key in the bucket. - in: query - name: start-after - required: false - schema: - type: string - - description: Confirms that the requester knows that she or he will be charged - for the list objects request in V2 style. Bucket owners need not specify - this parameter in their requests. - in: header - name: x-amz-request-payer - required: false - schema: - description: Confirms that the requester knows that they will be charged - for the request. Bucket owners need not specify this parameter in their - requests. For information about downloading objects from Requester Pays - buckets, see Downloading - Objects in Requester Pays Buckets in the Amazon S3 User Guide. - enum: - - requester - type: string - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - description: Pagination limit - in: query - name: MaxKeys - required: false - schema: - type: string - - description: Pagination token - in: query - name: ContinuationToken - required: false - schema: - type: string - - in: query - name: list-type - required: true - schema: - enum: - - '2' - type: string - responses: - '200': - content: - text/xml: - schema: - $ref: '#/components/schemas/ListObjectsV2Output' - description: Success - '480': - content: - text/xml: - schema: - $ref: '#/components/schemas/NoSuchBucket' - description: NoSuchBucket - parameters: - - $ref: '#/components/parameters/x-amz-security-token' - /?location: - get: - description:

Returns the Region the bucket resides in. You set the bucket's - Region using the LocationConstraint request parameter in a CreateBucket - request. For more information, see CreateBucket.

-

To use this implementation of the operation, you must be the bucket owner.

-

To use this API against an access point, provide the alias of the access - point in place of the bucket name.

The following operations are related - to GetBucketLocation:

- externalDocs: - url: http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETlocation.html - operationId: GetBucketLocation - parameters: - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: location - required: true - schema: - enum: - - true - type: boolean - responses: - '200': - content: - text/xml: - schema: - $ref: '#/components/schemas/GetBucketLocationOutput' - description: Success - parameters: - - $ref: '#/components/parameters/x-amz-security-token' - /?logging: - get: - description:

Returns the logging status of a bucket and the permissions users - have to view and modify that status. To use GET, you must be the bucket owner.

-

The following operations are related to GetBucketLogging:

- - externalDocs: - url: http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETlogging.html - operationId: GetBucketLogging - parameters: - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: logging - required: true - schema: - enum: - - true - type: boolean - responses: - '200': - content: - text/xml: - schema: - $ref: '#/components/schemas/GetBucketLoggingOutput' - description: Success - parameters: - - $ref: '#/components/parameters/x-amz-security-token' - put: - description:

Set the logging parameters for a bucket and to specify permissions - for who can view and modify the logging parameters. All logs are saved to - buckets in the same Amazon Web Services Region as the source bucket. To set - the logging status of a bucket, you must be the bucket owner.

The bucket - owner is automatically granted FULL_CONTROL to all logs. You use the Grantee - request element to grant access to other people. The Permissions - request element specifies the kind of access the grantee has to the logs.

-

If the target bucket for log delivery uses the bucket owner - enforced setting for S3 Object Ownership, you can't use the Grantee - request element to grant access to others. Permissions can only be granted - using policies. For more information, see Permissions - for server access log delivery in the Amazon S3 User Guide.

-

Grantee Values

You can specify the person - (grantee) to whom you're assigning access rights (using request elements) - in the following ways:

  • By the person's ID:

    <Grantee - xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> - </Grantee>

    DisplayName is optional and ignored in the - request.

  • By Email address:

    <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress></Grantee> -

    The grantee is resolved to the CanonicalUser and, in a response to - a GET Object acl request, appears as the CanonicalUser.

  • By - URI:

    <Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee> -

To enable logging, you use LoggingEnabled and its children - request elements. To disable logging, you use an empty BucketLoggingStatus - request element:

<BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01" - />

For more information about server access logging, see - Server - Access Logging in the Amazon S3 User Guide.

For more information - about creating a bucket, see CreateBucket. - For more information about returning the logging status of a bucket, see GetBucketLogging.

-

The following operations are related to PutBucketLogging:

- - externalDocs: - url: http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTlogging.html - operationId: PutBucketLogging - parameters: - - description:

The MD5 hash of the PutBucketLogging request - body.

For requests made using the Amazon Web Services Command Line - Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

- in: header - name: Content-MD5 - required: false - schema: - type: string - - description:

Indicates the algorithm used to create the checksum for the - object when using the SDK. This header will not provide any additional functionality - if not using the SDK. When sending this header, there must be a corresponding - x-amz-checksum or x-amz-trailer header sent. Otherwise, - Amazon S3 fails the request with the HTTP status code 400 Bad Request. - For more information, see Checking - object integrity in the Amazon S3 User Guide.

If you provide - an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm - parameter.

- in: header - name: x-amz-sdk-checksum-algorithm - required: false - schema: - enum: - - CRC32 - - CRC32C - - SHA1 - - SHA256 - type: string - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: logging - required: true - schema: - enum: - - true - type: boolean - requestBody: - content: - text/xml: - schema: - properties: - BucketLoggingStatus: - description: Container for logging status information. - properties: - LoggingEnabled: - $ref: '#/components/schemas/LoggingEnabled' - type: object - required: - - BucketLoggingStatus - type: object - required: true - responses: - '200': - description: Success - /?metrics: - get: - description:

Lists the metrics configurations for the bucket. The metrics - configurations are only for the request metrics of the bucket and do not provide - information on daily storage metrics. You can have up to 1,000 configurations - per bucket.

This action supports list pagination and does not return - more than 100 configurations at a time. Always check the IsTruncated - element in the response. If there are no more configurations to list, IsTruncated - is set to false. If there are more configurations to list, IsTruncated - is set to true, and there is a value in NextContinuationToken. - You use the NextContinuationToken value to continue the pagination - of the list by passing the value in continuation-token in the - request to GET the next page.

To use this operation, you - must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner - can grant this permission to others. For more information about permissions, - see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources.

For more information - about metrics configurations and CloudWatch request metrics, see Monitoring - Metrics with Amazon CloudWatch.

The following operations are related - to ListBucketMetricsConfigurations:

- operationId: ListBucketMetricsConfigurations - parameters: - - description: The marker that is used to continue a metrics configuration listing - that has been truncated. Use the NextContinuationToken from a previously - truncated list response to continue the listing. The continuation token - is an opaque value that Amazon S3 understands. - in: query - name: continuation-token - required: false - schema: - type: string - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: metrics - required: true - schema: - enum: - - true - type: boolean - responses: - '200': - content: - text/xml: - schema: - $ref: '#/components/schemas/ListBucketMetricsConfigurationsOutput' - description: Success - parameters: - - $ref: '#/components/parameters/x-amz-security-token' - /?metrics#id: - delete: - description:

Deletes a metrics configuration for the Amazon CloudWatch request - metrics (specified by the metrics configuration ID) from the bucket. Note - that this doesn't include the daily storage metrics.

To use this operation, - you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner - can grant this permission to others. For more information about permissions, - see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources.

For information - about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch.

The following operations are related - to DeleteBucketMetricsConfiguration:

- operationId: DeleteBucketMetricsConfiguration - parameters: - - description: The ID used to identify the metrics configuration. - in: query - name: id - required: true - schema: - type: string - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: metrics - required: true - schema: - enum: - - true - type: boolean - responses: - '204': - description: Success - get: - description:

Gets a metrics configuration (specified by the metrics configuration - ID) from the bucket. Note that this doesn't include the daily storage metrics.

-

To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner - can grant this permission to others. For more information about permissions, - see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources.

For information - about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch.

The following operations are related - to GetBucketMetricsConfiguration:

- operationId: GetBucketMetricsConfiguration - parameters: - - description: The ID used to identify the metrics configuration. - in: query - name: id - required: true - schema: - type: string - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: metrics - required: true - schema: - enum: - - true - type: boolean - responses: - '200': - content: - text/xml: - schema: - $ref: '#/components/schemas/GetBucketMetricsConfigurationOutput' - description: Success - parameters: - - $ref: '#/components/parameters/x-amz-security-token' - put: - description: '

Sets a metrics configuration (specified by the metrics configuration - ID) for the bucket. You can have up to 1,000 metrics configurations per bucket. - If you''re updating an existing metrics configuration, note that this is a - full replacement of the existing metrics configuration. If you don''t include - the elements you want to keep, they are erased.

To use this operation, - you must have permissions to perform the s3:PutMetricsConfiguration - action. The bucket owner has this permission by default. The bucket owner - can grant this permission to others. For more information about permissions, - see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources.

For information - about CloudWatch request metrics for Amazon S3, see Monitoring - Metrics with Amazon CloudWatch.

The following operations are related - to PutBucketMetricsConfiguration:

GetBucketLifecycle has the following special - error:

  • Error code: TooManyConfigurations

    -

    • Description: You are attempting to create a new configuration - but have already reached the 1,000-configuration limit.

    • HTTP - Status Code: HTTP 400 Bad Request

' - operationId: PutBucketMetricsConfiguration - parameters: - - description: The ID used to identify the metrics configuration. - in: query - name: id - required: true - schema: - type: string - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: metrics - required: true - schema: - enum: - - true - type: boolean - requestBody: - content: - text/xml: - schema: - properties: - MetricsConfiguration: - description: Specifies a metrics configuration for the CloudWatch - request metrics (specified by the metrics configuration ID) from - an Amazon S3 bucket. If you're updating an existing metrics configuration, - note that this is a full replacement of the existing metrics configuration. - If you don't include the elements you want to keep, they are erased. - For more information, see PutBucketMetricsConfiguration. - properties: - Filter: - allOf: - - $ref: '#/components/schemas/MetricsFilter' - - description: Specifies a metrics configuration filter. The - metrics configuration will only include objects that meet - the filter's criteria. A filter must be a prefix, an object - tag, an access point ARN, or a conjunction (MetricsAndOperator). - Id: - allOf: - - $ref: '#/components/schemas/MetricsId' - - description: The ID used to identify the metrics configuration. - type: object - required: - - MetricsConfiguration - type: object - required: true - responses: - '200': - description: Success - /?notification: - get: - description:

Returns the notification configuration of a bucket.

If - notifications are not enabled on the bucket, the action returns an empty NotificationConfiguration - element.

By default, you must be the bucket owner to read the notification - configuration of a bucket. However, the bucket owner can use a bucket policy - to grant permission to other users to read this configuration with the s3:GetBucketNotification - permission.

For more information about setting and reading the notification - configuration on a bucket, see Setting - Up Notification of Bucket Events. For more information about bucket policies, - see Using - Bucket Policies.

The following action is related to GetBucketNotification:

- - operationId: GetBucketNotificationConfiguration - parameters: - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: notification - required: true - schema: - enum: - - true - type: boolean - responses: - '200': - content: - text/xml: - schema: - $ref: '#/components/schemas/NotificationConfiguration' - description: Success - parameters: - - $ref: '#/components/parameters/x-amz-security-token' - put: - description:

Enables notifications of specified events for a bucket. For - more information about event notifications, see Configuring - Event Notifications.

Using this API, you can replace an existing - notification configuration. The configuration is an XML file that defines - the event types that you want Amazon S3 to publish and the destination where - you want Amazon S3 to publish an event notification when it detects an event - of the specified type.

By default, your bucket has no event notifications - configured. That is, the notification configuration will be an empty NotificationConfiguration.

-

<NotificationConfiguration>

</NotificationConfiguration> -

This action replaces the existing notification configuration with - the configuration you include in the request body.

After Amazon S3 - receives this request, it first verifies that any Amazon Simple Notification - Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination - exists, and that the bucket owner has permission to publish to it by sending - a test notification. In the case of Lambda destinations, Amazon S3 verifies - that the Lambda function permissions grant Amazon S3 permission to invoke - the function from the Amazon S3 bucket. For more information, see Configuring - Notifications for Amazon S3 Events.

You can disable notifications - by adding the empty NotificationConfiguration element.

For more information - about the number of event notification configurations that you can create - per bucket, see Amazon - S3 service quotas in Amazon Web Services General Reference.

-

By default, only the bucket owner can configure notifications on a bucket. - However, bucket owners can use a bucket policy to grant permission to other - users to set this configuration with s3:PutBucketNotification - permission.

The PUT notification is an atomic operation. For - example, suppose your notification configuration includes SNS topic, SQS queue, - and Lambda function configurations. When you send a PUT request with this - configuration, Amazon S3 sends test messages to your SNS topic. If the message - fails, the entire PUT action will fail, and Amazon S3 will not add the configuration - to your bucket.

Responses

If the configuration - in the request body includes only one TopicConfiguration specifying - only the s3:ReducedRedundancyLostObject event type, the response - will also include the x-amz-sns-test-message-id header containing - the message ID of the test notification sent to the topic.

The following - action is related to PutBucketNotificationConfiguration:

- - operationId: PutBucketNotificationConfiguration - parameters: - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - description: Skips validation of Amazon SQS, Amazon SNS, and Lambda destinations. - True or false value. - in: header - name: x-amz-skip-destination-validation - required: false - schema: - type: boolean - - allowEmptyValue: true - in: query - name: notification - required: true - schema: - enum: - - true - type: boolean - requestBody: - content: - text/xml: - schema: - properties: - NotificationConfiguration: - description: A container for specifying the notification configuration - of the bucket. If this element is empty, notifications are turned - off for the bucket. - properties: - CloudFunctionConfiguration: - allOf: - - $ref: '#/components/schemas/LambdaFunctionConfigurationList' - - description: Describes the Lambda functions to invoke and - the events for which to invoke them. - EventBridgeConfiguration: - allOf: - - $ref: '#/components/schemas/EventBridgeConfiguration' - - description: Enables delivery of events to Amazon EventBridge. - QueueConfiguration: - allOf: - - $ref: '#/components/schemas/QueueConfigurationList' - - description: The Amazon Simple Queue Service queues to publish - messages to and the events for which to publish messages. - TopicConfiguration: - allOf: - - $ref: '#/components/schemas/TopicConfigurationList' - - description: The topic to which notifications are sent and - the events for which notifications are generated. - type: object - required: - - NotificationConfiguration - type: object - required: true - responses: - '200': - description: Success - /?notification#deprecated!: - get: - deprecated: true - description: ' No longer used, see GetBucketNotificationConfiguration.' - externalDocs: - url: http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETnotification.html - operationId: GetBucketNotification - parameters: - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: notification - required: true - schema: - enum: - - true - type: boolean - responses: - '200': - content: - text/xml: - schema: - $ref: '#/components/schemas/NotificationConfigurationDeprecated' - description: Success - parameters: - - $ref: '#/components/parameters/x-amz-security-token' - put: - deprecated: true - description: ' No longer used, see the PutBucketNotificationConfiguration - operation.' - externalDocs: - url: http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTnotification.html - operationId: PutBucketNotification - parameters: - - description:

The MD5 hash of the PutPublicAccessBlock request - body.

For requests made using the Amazon Web Services Command Line - Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

- in: header - name: Content-MD5 - required: false - schema: - type: string - - description:

Indicates the algorithm used to create the checksum for the - object when using the SDK. This header will not provide any additional functionality - if not using the SDK. When sending this header, there must be a corresponding - x-amz-checksum or x-amz-trailer header sent. Otherwise, - Amazon S3 fails the request with the HTTP status code 400 Bad Request. - For more information, see Checking - object integrity in the Amazon S3 User Guide.

If you provide - an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm - parameter.

- in: header - name: x-amz-sdk-checksum-algorithm - required: false - schema: - enum: - - CRC32 - - CRC32C - - SHA1 - - SHA256 - type: string - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: notification - required: true - schema: - enum: - - true - type: boolean - requestBody: - content: - text/xml: - schema: - properties: - NotificationConfiguration: - description: The container for the configuration. - example: - QueueConfiguration: - Event: s3:ObjectCreated:Put - Events: - - s3:ObjectCreated:Put - Id: MDQ2OGQ4NDEtOTBmNi00YTM4LTk0NzYtZDIwN2I3NWQ1NjIx - Queue: arn:aws:sqs:us-east-1:acct-id:S3ObjectCreatedEventQueue - TopicConfiguration: - Event: s3:ObjectCreated:Copy - Events: - - s3:ObjectCreated:Copy - Id: YTVkMWEzZGUtNTY1NS00ZmE2LWJjYjktMmRlY2QwODFkNTJi - Topic: arn:aws:sns:us-east-1:acct-id:S3ObjectCreatedEventTopic - properties: - CloudFunctionConfiguration: - allOf: - - $ref: '#/components/schemas/CloudFunctionConfiguration' - - description: Container for specifying the Lambda notification - configuration. - QueueConfiguration: - allOf: - - $ref: '#/components/schemas/QueueConfigurationDeprecated' - - description: 'This data type is deprecated. This data type - specifies the configuration for publishing messages to an - Amazon Simple Queue Service (Amazon SQS) queue when Amazon - S3 detects specified events. ' - TopicConfiguration: - allOf: - - $ref: '#/components/schemas/TopicConfigurationDeprecated' - - description: 'This data type is deprecated. A container for - specifying the configuration for publication of messages - to an Amazon Simple Notification Service (Amazon SNS) topic - when Amazon S3 detects specified events. ' - type: object - required: - - NotificationConfiguration - type: object - required: true - responses: - '200': - description: Success - /?object-lock: - get: - description:

Gets the Object Lock configuration for a bucket. The rule specified - in the Object Lock configuration will be applied by default to every new object - placed in the specified bucket. For more information, see Locking - Objects.

The following action is related to GetObjectLockConfiguration:

- - operationId: GetObjectLockConfiguration - parameters: - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: object-lock - required: true - schema: - enum: - - true - type: boolean - responses: - '200': - content: - text/xml: - schema: - $ref: '#/components/schemas/GetObjectLockConfigurationOutput' - description: Success - parameters: - - $ref: '#/components/parameters/x-amz-security-token' - put: - description:

Places an Object Lock configuration on the specified bucket. - The rule specified in the Object Lock configuration will be applied by default - to every new object placed in the specified bucket. For more information, - see Locking - Objects.

  • The DefaultRetention settings - require both a mode and a period.

  • The DefaultRetention - period can be either Days or Years but you must - select one. You cannot specify Days and Years at - the same time.

  • You can only enable Object Lock for new buckets. - If you want to turn on Object Lock for an existing bucket, contact Amazon - Web Services Support.

 - operationId: PutObjectLockConfiguration - parameters: - - description: '' - in: header - name: x-amz-request-payer - required: false - schema: - description: Confirms that the requester knows that they will be charged - for the request. Bucket owners need not specify this parameter in their - requests. For information about downloading objects from Requester Pays - buckets, see Downloading - Objects in Requester Pays Buckets in the Amazon S3 User Guide. - enum: - - requester - type: string - - description: A token to allow Object Lock to be enabled for an existing bucket. - in: header - name: x-amz-bucket-object-lock-token - required: false - schema: - type: string - - description:

The MD5 hash for the request body.

For requests made - using the Amazon Web Services Command Line Interface (CLI) or Amazon Web - Services SDKs, this field is calculated automatically.

- in: header - name: Content-MD5 - required: false - schema: - type: string - - description:

Indicates the algorithm used to create the checksum for the - object when using the SDK. This header will not provide any additional functionality - if not using the SDK. When sending this header, there must be a corresponding - x-amz-checksum or x-amz-trailer header sent. Otherwise, - Amazon S3 fails the request with the HTTP status code 400 Bad Request. - For more information, see Checking - object integrity in the Amazon S3 User Guide.

If you provide - an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm - parameter.

- in: header - name: x-amz-sdk-checksum-algorithm - required: false - schema: - enum: - - CRC32 - - CRC32C - - SHA1 - - SHA256 - type: string - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: object-lock - required: true - schema: - enum: - - true - type: boolean - requestBody: - content: - text/xml: - schema: - properties: - ObjectLockConfiguration: - description: The container element for Object Lock configuration - parameters. - properties: - ObjectLockEnabled: - allOf: - - $ref: '#/components/schemas/ObjectLockEnabled' - - description: 'Indicates whether this bucket has an Object - Lock configuration enabled. Enable ObjectLockEnabled - when you apply ObjectLockConfiguration to a - bucket. ' - Rule: - allOf: - - $ref: '#/components/schemas/ObjectLockRule' - - description: Specifies the Object Lock rule for the specified - object. Enable the this rule when you apply ObjectLockConfiguration - to a bucket. Bucket settings require both a mode and a period. - The period can be either Days or Years - but you must select one. You cannot specify Days - and Years at the same time. - type: object - type: object - required: true - responses: - '200': - content: - text/xml: - schema: - $ref: '#/components/schemas/PutObjectLockConfigurationOutput' - description: Success - /?ownershipControls: - delete: - description:

Removes OwnershipControls for an Amazon S3 bucket. - To use this operation, you must have the s3:PutBucketOwnershipControls - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy.

For information about Amazon S3 Object - Ownership, see Using - Object Ownership.

The following operations are related to DeleteBucketOwnershipControls:

- - operationId: DeleteBucketOwnershipControls - parameters: - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: ownershipControls - required: true - schema: - enum: - - true - type: boolean - responses: - '204': - description: Success - get: - description:

Retrieves OwnershipControls for an Amazon S3 bucket. - To use this operation, you must have the s3:GetBucketOwnershipControls - permission. For more information about Amazon S3 permissions, see Specifying - permissions in a policy.

For information about Amazon S3 Object - Ownership, see Using - Object Ownership.

The following operations are related to GetBucketOwnershipControls:

- - operationId: GetBucketOwnershipControls - parameters: - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: ownershipControls - required: true - schema: - enum: - - true - type: boolean - responses: - '200': - content: - text/xml: - schema: - $ref: '#/components/schemas/GetBucketOwnershipControlsOutput' - description: Success - parameters: - - $ref: '#/components/parameters/x-amz-security-token' - put: - description:

Creates or modifies OwnershipControls for an Amazon - S3 bucket. To use this operation, you must have the s3:PutBucketOwnershipControls - permission. For more information about Amazon S3 permissions, see Specifying - permissions in a policy.

For information about Amazon S3 Object - Ownership, see Using - object ownership.

The following operations are related to PutBucketOwnershipControls:

- - operationId: PutBucketOwnershipControls - parameters: - - description:

The MD5 hash of the OwnershipControls request - body.

For requests made using the Amazon Web Services Command Line - Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

- in: header - name: Content-MD5 - required: false - schema: - type: string - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: ownershipControls - required: true - schema: - enum: - - true - type: boolean - requestBody: - content: - text/xml: - schema: - properties: - OwnershipControls: - description: The container element for a bucket's ownership controls. - properties: - Rule: - allOf: - - $ref: '#/components/schemas/OwnershipControlsRules' - - description: The container element for an ownership control - rule. - type: object - required: - - OwnershipControls - type: object - required: true - responses: - '200': - description: Success - /?policy: - delete: - description:

This implementation of the DELETE action uses the policy subresource - to delete the policy of a specified bucket. If you are using an identity other - than the root user of the Amazon Web Services account that owns the bucket, - the calling identity must have the DeleteBucketPolicy permissions - on the specified bucket and belong to the bucket owner's account to use this - operation.

If you don't have DeleteBucketPolicy permissions, - Amazon S3 returns a 403 Access Denied error. If you have the - correct permissions, but you're not using an identity that belongs to the - bucket owner's account, Amazon S3 returns a 405 Method Not Allowed - error.

As a security precaution, the root user of the - Amazon Web Services account that owns a bucket can always use this operation, - even if the policy explicitly denies the root user the ability to perform - this action.

For more information about bucket policies, - see Using - Bucket Policies and UserPolicies.

The following operations are - related to DeleteBucketPolicy

- externalDocs: - url: http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETEpolicy.html - operationId: DeleteBucketPolicy - parameters: - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: policy - required: true - schema: - enum: - - true - type: boolean - responses: - '204': - description: Success - get: - description:

Returns the policy of a specified bucket. If you are using an - identity other than the root user of the Amazon Web Services account that - owns the bucket, the calling identity must have the GetBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account - in order to use this operation.

If you don't have GetBucketPolicy - permissions, Amazon S3 returns a 403 Access Denied error. If - you have the correct permissions, but you're not using an identity that belongs - to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed - error.

As a security precaution, the root user of the Amazon - Web Services account that owns a bucket can always use this operation, even - if the policy explicitly denies the root user the ability to perform this - action.

For more information about bucket policies, see - Using - Bucket Policies and User Policies.

The following action is related - to GetBucketPolicy:

- externalDocs: - url: http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETpolicy.html - operationId: GetBucketPolicy - parameters: - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: policy - required: true - schema: - enum: - - true - type: boolean - responses: - '200': - content: - text/xml: - schema: - $ref: '#/components/schemas/GetBucketPolicyOutput' - description: Success - parameters: - - $ref: '#/components/parameters/x-amz-security-token' - put: - description:

Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If - you are using an identity other than the root user of the Amazon Web Services - account that owns the bucket, the calling identity must have the PutBucketPolicy - permissions on the specified bucket and belong to the bucket owner's account - in order to use this operation.

If you don't have PutBucketPolicy - permissions, Amazon S3 returns a 403 Access Denied error. If - you have the correct permissions, but you're not using an identity that belongs - to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed - error.

As a security precaution, the root user of the - Amazon Web Services account that owns a bucket can always use this operation, - even if the policy explicitly denies the root user the ability to perform - this action.

For more information, see Bucket - policy examples.

The following operations are related to PutBucketPolicy:

- - externalDocs: - url: http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTpolicy.html - operationId: PutBucketPolicy - parameters: - - description:

The MD5 hash of the request body.

For requests made - using the Amazon Web Services Command Line Interface (CLI) or Amazon Web - Services SDKs, this field is calculated automatically.

- in: header - name: Content-MD5 - required: false - schema: - type: string - - description:

Indicates the algorithm used to create the checksum for the - object when using the SDK. This header will not provide any additional functionality - if not using the SDK. When sending this header, there must be a corresponding - x-amz-checksum or x-amz-trailer header sent. Otherwise, - Amazon S3 fails the request with the HTTP status code 400 Bad Request. - For more information, see Checking - object integrity in the Amazon S3 User Guide.

If you provide - an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm - parameter.

- in: header - name: x-amz-sdk-checksum-algorithm - required: false - schema: - enum: - - CRC32 - - CRC32C - - SHA1 - - SHA256 - type: string - - description: Set this parameter to true to confirm that you want to remove - your permissions to change this bucket policy in the future. - in: header - name: x-amz-confirm-remove-self-bucket-access - required: false - schema: - type: boolean - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: policy - required: true - schema: - enum: - - true - type: boolean - requestBody: - content: - text/xml: - schema: - properties: - Policy: - description: The bucket policy as a JSON document. - type: string - required: - - Policy - type: object - required: true - responses: - '200': - description: Success - /?policyStatus: - get: - description:

Retrieves the policy status for an Amazon S3 bucket, indicating - whether the bucket is public. In order to use this operation, you must have - the s3:GetBucketPolicyStatus permission. For more information - about Amazon S3 permissions, see Specifying - Permissions in a Policy.

For more information about when Amazon - S3 considers a bucket public, see The - Meaning of "Public".

The following operations are related to GetBucketPolicyStatus:

- - operationId: GetBucketPolicyStatus - parameters: - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: policyStatus - required: true - schema: - enum: - - true - type: boolean - responses: - '200': - content: - text/xml: - schema: - $ref: '#/components/schemas/GetBucketPolicyStatusOutput' - description: Success - parameters: - - $ref: '#/components/parameters/x-amz-security-token' - /?publicAccessBlock: - delete: - description:

Removes the PublicAccessBlock configuration for - an Amazon S3 bucket. To use this operation, you must have the s3:PutBucketPublicAccessBlock - permission. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources.

The following operations - are related to DeletePublicAccessBlock:

- operationId: DeletePublicAccessBlock - parameters: - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: publicAccessBlock - required: true - schema: - enum: - - true - type: boolean - responses: - '204': - description: Success - get: - description:

Retrieves the PublicAccessBlock configuration for - an Amazon S3 bucket. To use this operation, you must have the s3:GetBucketPublicAccessBlock - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy.

When Amazon S3 evaluates the - PublicAccessBlock configuration for a bucket or an object, it - checks the PublicAccessBlock configuration for both the bucket - (or the bucket that contains the object) and the bucket owner's account. If - the PublicAccessBlock settings are different between the bucket - and the account, Amazon S3 uses the most restrictive combination of the bucket-level - and account-level settings.

For more information about - when Amazon S3 considers a bucket or an object public, see The - Meaning of "Public".

The following operations are related to GetPublicAccessBlock:

- - operationId: GetPublicAccessBlock - parameters: - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: publicAccessBlock - required: true - schema: - enum: - - true - type: boolean - responses: - '200': - content: - text/xml: - schema: - $ref: '#/components/schemas/GetPublicAccessBlockOutput' - description: Success - parameters: - - $ref: '#/components/parameters/x-amz-security-token' - put: - description:

Creates or modifies the PublicAccessBlock configuration - for an Amazon S3 bucket. To use this operation, you must have the s3:PutBucketPublicAccessBlock - permission. For more information about Amazon S3 permissions, see Specifying - Permissions in a Policy.

When Amazon S3 evaluates the - PublicAccessBlock configuration for a bucket or an object, it - checks the PublicAccessBlock configuration for both the bucket - (or the bucket that contains the object) and the bucket owner's account. If - the PublicAccessBlock configurations are different between the - bucket and the account, Amazon S3 uses the most restrictive combination of - the bucket-level and account-level settings.

For more - information about when Amazon S3 considers a bucket or an object public, see - The - Meaning of "Public".

Related Resources

- - operationId: PutPublicAccessBlock - parameters: - - description:

The MD5 hash of the PutPublicAccessBlock request - body.

For requests made using the Amazon Web Services Command Line - Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

- in: header - name: Content-MD5 - required: false - schema: - type: string - - description:

Indicates the algorithm used to create the checksum for the - object when using the SDK. This header will not provide any additional functionality - if not using the SDK. When sending this header, there must be a corresponding - x-amz-checksum or x-amz-trailer header sent. Otherwise, - Amazon S3 fails the request with the HTTP status code 400 Bad Request. - For more information, see Checking - object integrity in the Amazon S3 User Guide.

If you provide - an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm - parameter.

- in: header - name: x-amz-sdk-checksum-algorithm - required: false - schema: - enum: - - CRC32 - - CRC32C - - SHA1 - - SHA256 - type: string - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: publicAccessBlock - required: true - schema: - enum: - - true - type: boolean - requestBody: - content: - text/xml: - schema: - properties: - PublicAccessBlockConfiguration: - description: 'The PublicAccessBlock configuration that you want - to apply to this Amazon S3 bucket. You can enable the configuration - options in any combination. For more information about when Amazon - S3 considers a bucket or object public, see The - Meaning of "Public" in the Amazon S3 User Guide. ' - properties: {} - type: object - required: - - PublicAccessBlockConfiguration - type: object - required: true - responses: - '200': - description: Success - /?replication: - delete: - description:

Deletes the replication configuration from the bucket.

-

To use this operation, you must have permissions to perform the s3:PutReplicationConfiguration - action. The bucket owner has these permissions by default and can grant it - to others. For more information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources.

It can - take a while for the deletion of a replication configuration to fully propagate.

-

For information about replication configuration, see Replication - in the Amazon S3 User Guide.

The following operations are related - to DeleteBucketReplication:

- operationId: DeleteBucketReplication - parameters: - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: replication - required: true - schema: - enum: - - true - type: boolean - responses: - '204': - description: Success - get: - description:

Returns the replication configuration of a bucket.

-

It can take a while to propagate the put or delete a replication configuration - to all Amazon S3 systems. Therefore, a get request soon after put or delete - can return a wrong result.

For information about replication - configuration, see Replication - in the Amazon S3 User Guide.

This action requires permissions - for the s3:GetReplicationConfiguration action. For more information - about permissions, see Using - Bucket Policies and User Policies.

If you include the Filter - element in a replication configuration, you must also include the DeleteMarkerReplication - and Priority elements. The response also returns those elements.

-

For information about GetBucketReplication errors, see List - of replication-related error codes

The following operations are - related to GetBucketReplication:

- operationId: GetBucketReplication - parameters: - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: replication - required: true - schema: - enum: - - true - type: boolean - responses: - '200': - content: - text/xml: - schema: - $ref: '#/components/schemas/GetBucketReplicationOutput' - description: Success - parameters: - - $ref: '#/components/parameters/x-amz-security-token' - put: - description: '

Creates a replication configuration or replaces an existing - one. For more information, see Replication - in the Amazon S3 User Guide.

Specify the replication configuration - in the request body. In the replication configuration, you provide the name - of the destination bucket or buckets where you want Amazon S3 to replicate - objects, the IAM role that Amazon S3 can assume to replicate objects on your - behalf, and other relevant information.

A replication configuration - must include at least one rule, and can contain a maximum of 1,000. Each rule - identifies a subset of objects to replicate by filtering the objects in the - source bucket. To choose additional subsets of objects to replicate, add a - rule for each subset.

To specify a subset of the objects in the source - bucket to apply a replication rule to, add the Filter element as a child of - the Rule element. You can filter objects based on an object key prefix, one - or more object tags, or both. When you add the Filter element in the configuration, - you must also add the following elements: DeleteMarkerReplication, - Status, and Priority.

If you are using - an earlier version of the replication configuration, Amazon S3 handles replication - of delete markers differently. For more information, see Backward - Compatibility.

For information about enabling versioning - on a bucket, see Using - Versioning.

Handling Replication of Encrypted Objects

-

By default, Amazon S3 doesn''t replicate objects that are stored at rest - using server-side encryption with KMS keys. To replicate Amazon Web Services - KMS-encrypted objects, add the following: SourceSelectionCriteria, - SseKmsEncryptedObjects, Status, EncryptionConfiguration, - and ReplicaKmsKeyID. For information about replication configuration, - see Replicating - Objects Created with SSE Using KMS keys.

For information on PutBucketReplication - errors, see List - of replication-related error codes

Permissions

To - create a PutBucketReplication request, you must have s3:PutReplicationConfiguration - permissions for the bucket.

By default, a resource owner, in this - case the Amazon Web Services account that created the bucket, can perform - this operation. The resource owner can also grant others permissions to perform - the operation. For more information about permissions, see Specifying - Permissions in a Policy and Managing - Access Permissions to Your Amazon S3 Resources.

To perform - this operation, the user or role performing the action must have the iam:PassRole - permission.

The following operations are related to PutBucketReplication:

- ' - operationId: PutBucketReplication - parameters: - - description:

The base64-encoded 128-bit MD5 digest of the data. You must - use this header as a message integrity check to verify that the request - body was not corrupted in transit. For more information, see RFC - 1864.

For requests made using the Amazon Web Services Command - Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated - automatically.

- in: header - name: Content-MD5 - required: false - schema: - type: string - - description:

Indicates the algorithm used to create the checksum for the - object when using the SDK. This header will not provide any additional functionality - if not using the SDK. When sending this header, there must be a corresponding - x-amz-checksum or x-amz-trailer header sent. Otherwise, - Amazon S3 fails the request with the HTTP status code 400 Bad Request. - For more information, see Checking - object integrity in the Amazon S3 User Guide.

If you provide - an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm - parameter.

- in: header - name: x-amz-sdk-checksum-algorithm - required: false - schema: - enum: - - CRC32 - - CRC32C - - SHA1 - - SHA256 - type: string - - description: A token to allow Object Lock to be enabled for an existing bucket. - in: header - name: x-amz-bucket-object-lock-token - required: false - schema: - type: string - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: replication - required: true - schema: - enum: - - true - type: boolean - requestBody: - content: - text/xml: - schema: - properties: - ReplicationConfiguration: - description: A container for replication rules. You can add up to - 1,000 rules. The maximum size of a replication configuration is - 2 MB. - properties: - Role: - allOf: - - $ref: '#/components/schemas/Role' - - description: The Amazon Resource Name (ARN) of the Identity - and Access Management (IAM) role that Amazon S3 assumes - when replicating objects. For more information, see How - to Set Up Replication in the Amazon S3 User Guide. - Rule: - allOf: - - $ref: '#/components/schemas/ReplicationRules' - - description: 'A container for one or more replication rules. - A replication configuration must have at least one rule - and can contain a maximum of 1,000 rules. ' - type: object - required: - - ReplicationConfiguration - type: object - required: true - responses: - '200': - description: Success - /?requestPayment: - get: - description:

Returns the request payment configuration of a bucket. To use - this version of the operation, you must be the bucket owner. For more information, - see Requester - Pays Buckets.

The following operations are related to GetBucketRequestPayment:

- - externalDocs: - url: http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTrequestPaymentGET.html - operationId: GetBucketRequestPayment - parameters: - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: requestPayment - required: true - schema: - enum: - - true - type: boolean - responses: - '200': - content: - text/xml: - schema: - $ref: '#/components/schemas/GetBucketRequestPaymentOutput' - description: Success - parameters: - - $ref: '#/components/parameters/x-amz-security-token' - put: - description:

Sets the request payment configuration for a bucket. By default, - the bucket owner pays for downloads from the bucket. This configuration parameter - enables the bucket owner (only) to specify that the person requesting the - download will be charged for the download. For more information, see Requester - Pays Buckets.

The following operations are related to PutBucketRequestPayment:

- - externalDocs: - url: http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTrequestPaymentPUT.html - operationId: PutBucketRequestPayment - parameters: - - description:

The base64-encoded 128-bit MD5 digest of the data. You must - use this header as a message integrity check to verify that the request - body was not corrupted in transit. For more information, see RFC - 1864.

For requests made using the Amazon Web Services Command - Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated - automatically.

- in: header - name: Content-MD5 - required: false - schema: - type: string - - description:

Indicates the algorithm used to create the checksum for the - object when using the SDK. This header will not provide any additional functionality - if not using the SDK. When sending this header, there must be a corresponding - x-amz-checksum or x-amz-trailer header sent. Otherwise, - Amazon S3 fails the request with the HTTP status code 400 Bad Request. - For more information, see Checking - object integrity in the Amazon S3 User Guide.

If you provide - an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm - parameter.

- in: header - name: x-amz-sdk-checksum-algorithm - required: false - schema: - enum: - - CRC32 - - CRC32C - - SHA1 - - SHA256 - type: string - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: requestPayment - required: true - schema: - enum: - - true - type: boolean - requestBody: - content: - text/xml: - schema: - properties: - RequestPaymentConfiguration: - description: Container for Payer. - properties: - Payer: - allOf: - - $ref: '#/components/schemas/Payer' - - description: Specifies who pays for the download and request - fees. - type: object - required: - - RequestPaymentConfiguration - type: object - required: true - responses: - '200': - description: Success - /?tagging: - delete: - description:

Deletes the tags from the bucket.

To use this operation, - you must have permission to perform the s3:PutBucketTagging action. - By default, the bucket owner has this permission and can grant this permission - to others.

The following operations are related to DeleteBucketTagging:

- - externalDocs: - url: http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETEtagging.html - operationId: DeleteBucketTagging - parameters: - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: tagging - required: true - schema: - enum: - - true - type: boolean - responses: - '204': - description: Success - get: - description: '

Returns the tag set associated with the bucket.

To use - this operation, you must have permission to perform the s3:GetBucketTagging - action. By default, the bucket owner has this permission and can grant this - permission to others.

GetBucketTagging has the following - special error:

  • Error code: NoSuchTagSet

    -

    • Description: There is no tag set associated with the bucket.

      -

The following operations are related to GetBucketTagging:

- ' - externalDocs: - url: http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETtagging.html - operationId: GetBucketTagging - parameters: - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: tagging - required: true - schema: - enum: - - true - type: boolean - responses: - '200': - content: - text/xml: - schema: - $ref: '#/components/schemas/GetBucketTaggingOutput' - description: Success - parameters: - - $ref: '#/components/parameters/x-amz-security-token' - put: - description: '

Sets the tags for a bucket.

Use tags to organize your - Amazon Web Services bill to reflect your own cost structure. To do this, sign - up to get your Amazon Web Services account bill with tag key values included. - Then, to see the cost of combined resources, organize your billing information - according to resources with the same tag key values. For example, you can - tag several resources with a specific application name, and then organize - your billing information to see the total cost of that application across - several services. For more information, see Cost - Allocation and Tagging and Using - Cost Allocation in Amazon S3 Bucket Tags.

When this operation - sets the tags for a bucket, it will overwrite any current tags the bucket - already has. You cannot use this operation to add tags to an existing list - of tags.

To use this operation, you must have permissions to - perform the s3:PutBucketTagging action. The bucket owner has - this permission by default and can grant this permission to others. For more - information about permissions, see Permissions - Related to Bucket Subresource Operations and Managing - Access Permissions to Your Amazon S3 Resources.

PutBucketTagging - has the following special errors:

  • Error code: InvalidTagError -

    -

  • Error code: MalformedXMLError

    • Description: - The XML provided does not match the schema.

  • Error - code: OperationAbortedError

    • Description: A - conflicting conditional action is currently in progress against this resource. - Please try again.

  • Error code: InternalError -

    • Description: The service was unable to apply the provided - tag to the bucket.

The following operations - are related to PutBucketTagging:

' - externalDocs: - url: http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTtagging.html - operationId: PutBucketTagging - parameters: - - description:

The base64-encoded 128-bit MD5 digest of the data. You must - use this header as a message integrity check to verify that the request - body was not corrupted in transit. For more information, see RFC - 1864.

For requests made using the Amazon Web Services Command - Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated - automatically.

- in: header - name: Content-MD5 - required: false - schema: - type: string - - description:

Indicates the algorithm used to create the checksum for the - object when using the SDK. This header will not provide any additional functionality - if not using the SDK. When sending this header, there must be a corresponding - x-amz-checksum or x-amz-trailer header sent. Otherwise, - Amazon S3 fails the request with the HTTP status code 400 Bad Request. - For more information, see Checking - object integrity in the Amazon S3 User Guide.

If you provide - an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm - parameter.

- in: header - name: x-amz-sdk-checksum-algorithm - required: false - schema: - enum: - - CRC32 - - CRC32C - - SHA1 - - SHA256 - type: string - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: tagging - required: true - schema: - enum: - - true - type: boolean - requestBody: - content: - text/xml: - schema: - properties: - Tagging: - description: Container for TagSet elements. - properties: - TagSet: - allOf: - - $ref: '#/components/schemas/TagSet' - - description: A collection for a set of tags - type: object - required: - - Tagging - type: object - required: true - responses: - '200': - description: Success - /?uploads: - get: - description:

This action lists in-progress multipart uploads. An in-progress - multipart upload is a multipart upload that has been initiated using the Initiate - Multipart Upload request, but has not yet been completed or aborted.

This - action returns at most 1,000 multipart uploads in the response. 1,000 multipart - uploads is the maximum number of uploads a response can include, which is - also the default value. You can further limit the number of uploads in a response - by specifying the max-uploads parameter in the response. If additional - multipart uploads satisfy the list criteria, the response will contain an - IsTruncated element with the value true. To list the additional - multipart uploads, use the key-marker and upload-id-marker - request parameters.

In the response, the uploads are sorted by key. - If your application has initiated more than one multipart upload using the - same object key, then uploads in the response are first sorted by key. Additionally, - uploads are sorted in ascending order within each key by the upload initiation - time.

For more information on multipart uploads, see Uploading - Objects Using Multipart Upload.

For information on permissions - required to use the multipart upload API, see Multipart - Upload and Permissions.

The following operations are related to - ListMultipartUploads:

- externalDocs: - url: http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadListMPUpload.html - operationId: ListMultipartUploads - parameters: - - description:

Character you use to group keys.

All keys that contain - the same string between the prefix, if specified, and the first occurrence - of the delimiter after the prefix are grouped under a single result element, - CommonPrefixes. If you don't specify the prefix parameter, - then the substring starts at the beginning of the key. The keys that are - grouped under CommonPrefixes result element are not returned - elsewhere in the response.

- in: query - name: delimiter - required: false - schema: - type: string - - description: '' - in: query - name: encoding-type - required: false - schema: - description: Requests Amazon S3 to encode the object keys in the response - and specifies the encoding method to use. An object key may contain any - Unicode character; however, XML 1.0 parser cannot parse some characters, - such as characters with an ASCII value from 0 to 10. For characters that - are not supported in XML 1.0, you can add this parameter to request that - Amazon S3 encode the keys in the response. - enum: - - url - type: string - - description:

Together with upload-id-marker, this parameter specifies the - multipart upload after which listing should begin.

If upload-id-marker - is not specified, only the keys lexicographically greater than the specified - key-marker will be included in the list.

If upload-id-marker - is specified, any multipart uploads for a key equal to the key-marker - might also be included, provided those multipart uploads have upload IDs - lexicographically greater than the specified upload-id-marker.

- in: query - name: key-marker - required: false - schema: - type: string - - description: Sets the maximum number of multipart uploads, from 1 to 1,000, - to return in the response body. 1,000 is the maximum number of uploads that - can be returned in a response. - in: query - name: max-uploads - required: false - schema: - type: integer - - description: Lists in-progress uploads only for those keys that begin with - the specified prefix. You can use prefixes to separate a bucket into different - grouping of keys. (You can think of using prefix to make groups in the same - way you'd use a folder in a file system.) - in: query - name: prefix - required: false - schema: - type: string - - description: Together with key-marker, specifies the multipart upload after - which listing should begin. If key-marker is not specified, the upload-id-marker - parameter is ignored. Otherwise, any multipart uploads for a key equal to - the key-marker might be included in the list only if they have an upload - ID lexicographically greater than the specified upload-id-marker. - in: query - name: upload-id-marker - required: false - schema: - type: string - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - description: Pagination limit - in: query - name: MaxUploads - required: false - schema: - type: string - - description: Pagination token - in: query - name: KeyMarker - required: false - schema: - type: string - - description: Pagination token - in: query - name: UploadIdMarker - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: uploads - required: true - schema: - enum: - - true - type: boolean - responses: - '200': - content: - text/xml: - schema: - $ref: '#/components/schemas/ListMultipartUploadsOutput' - description: Success - parameters: - - $ref: '#/components/parameters/x-amz-security-token' - /?versioning: - get: - description:

Returns the versioning state of a bucket.

To retrieve - the versioning state of a bucket, you must be the bucket owner.

This - implementation also returns the MFA Delete status of the versioning state. - If the MFA Delete status is enabled, the bucket owner must use - an authentication device to change the versioning state of the bucket.

-

The following operations are related to GetBucketVersioning:

- - externalDocs: - url: http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETversioningStatus.html - operationId: GetBucketVersioning - parameters: - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: versioning - required: true - schema: - enum: - - true - type: boolean - responses: - '200': - content: - text/xml: - schema: - $ref: '#/components/schemas/GetBucketVersioningOutput' - description: Success - parameters: - - $ref: '#/components/parameters/x-amz-security-token' - put: - description: "

Sets the versioning state of an existing bucket.

You\ - \ can set the versioning state with one of the following values:

Enabled\u2014\ - Enables versioning for the objects in the bucket. All objects added to the\ - \ bucket receive a unique version ID.

Suspended\u2014Disables\ - \ versioning for the objects in the bucket. All objects added to the bucket\ - \ receive the version ID null.

If the versioning state has never been\ - \ set on a bucket, it has no versioning state; a GetBucketVersioning request does not return a versioning state value.

\ - \

In order to enable MFA Delete, you must be the bucket owner. If you are\ - \ the bucket owner and want to enable MFA Delete in the bucket versioning\ - \ configuration, you must include the x-amz-mfa request header\ - \ and the Status and the MfaDelete request elements\ - \ in a request to set the versioning state of the bucket.

\ - \

If you have an object expiration lifecycle policy in your non-versioned\ - \ bucket and you want to maintain the same permanent delete behavior when\ - \ you enable versioning, you must add a noncurrent expiration policy. The\ - \ noncurrent expiration lifecycle policy will manage the deletes of the noncurrent\ - \ object versions in the version-enabled bucket. (A version-enabled bucket\ - \ maintains one current and zero or more noncurrent object versions.) For\ - \ more information, see Lifecycle and Versioning.

Related\ - \ Resources

" - externalDocs: - url: http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTVersioningStatus.html - operationId: PutBucketVersioning - parameters: - - description:

>The base64-encoded 128-bit MD5 digest of the data. You - must use this header as a message integrity check to verify that the request - body was not corrupted in transit. For more information, see RFC - 1864.

For requests made using the Amazon Web Services Command - Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated - automatically.

- in: header - name: Content-MD5 - required: false - schema: - type: string - - description:

Indicates the algorithm used to create the checksum for the - object when using the SDK. This header will not provide any additional functionality - if not using the SDK. When sending this header, there must be a corresponding - x-amz-checksum or x-amz-trailer header sent. Otherwise, - Amazon S3 fails the request with the HTTP status code 400 Bad Request. - For more information, see Checking - object integrity in the Amazon S3 User Guide.

If you provide - an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm - parameter.

- in: header - name: x-amz-sdk-checksum-algorithm - required: false - schema: - enum: - - CRC32 - - CRC32C - - SHA1 - - SHA256 - type: string - - description: The concatenation of the authentication device's serial number, - a space, and the value that is displayed on your authentication device. - in: header - name: x-amz-mfa - required: false - schema: - type: string - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: versioning - required: true - schema: - enum: - - true - type: boolean - requestBody: - content: - text/xml: - schema: - properties: - VersioningConfiguration: - description: Describes the versioning state of an Amazon S3 bucket. - For more information, see PUT - Bucket versioning in the Amazon S3 API Reference. - properties: - MfaDelete: - allOf: - - $ref: '#/components/schemas/MFADelete' - - description: Specifies whether MFA delete is enabled in the - bucket versioning configuration. This element is only returned - if the bucket has been configured with MFA delete. If the - bucket has never been so configured, this element is not - returned. - Status: - allOf: - - $ref: '#/components/schemas/BucketVersioningStatus' - - description: The versioning state of the bucket. - type: object - required: - - VersioningConfiguration - type: object - required: true - responses: - '200': - description: Success - /?versions: - get: - description:

Returns metadata about all versions of the objects in a bucket. - You can also use request parameters as selection criteria to return metadata - about a subset of all the object versions.

To use this - operation, you must have permissions to perform the s3:ListBucketVersions - action. Be aware of the name difference.

A 200 - OK response can contain valid or invalid XML. Make sure to design your application - to parse the contents of the response and handle it appropriately.

 -

To use this operation, you must have READ access to the bucket.

This - action is not supported by Amazon S3 on Outposts.

The following operations - are related to ListObjectVersions:

- externalDocs: - url: http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETVersion.html - operationId: ListObjectVersions - parameters: - - description: A delimiter is a character that you specify to group keys. All - keys that contain the same string between the prefix and the - first occurrence of the delimiter are grouped under a single result element - in CommonPrefixes. These groups are counted as one result against the max-keys - limitation. These keys are not returned elsewhere in the response. - in: query - name: delimiter - required: false - schema: - type: string - - description: '' - in: query - name: encoding-type - required: false - schema: - description: Requests Amazon S3 to encode the object keys in the response - and specifies the encoding method to use. An object key may contain any - Unicode character; however, XML 1.0 parser cannot parse some characters, - such as characters with an ASCII value from 0 to 10. For characters that - are not supported in XML 1.0, you can add this parameter to request that - Amazon S3 encode the keys in the response. - enum: - - url - type: string - - description: Specifies the key to start with when listing objects in a bucket. - in: query - name: key-marker - required: false - schema: - type: string - - description: Sets the maximum number of keys returned in the response. By - default the action returns up to 1,000 key names. The response might contain - fewer keys but will never contain more. If additional keys satisfy the search - criteria, but were not returned because max-keys was exceeded, the response - contains <isTruncated>true</isTruncated>. To return the additional - keys, see key-marker and version-id-marker. - in: query - name: max-keys - required: false - schema: - type: integer - - description: 'Use this parameter to select only those keys that begin with - the specified prefix. You can use prefixes to separate a bucket into different - groupings of keys. (You can think of using prefix to make groups in the - same way you''d use a folder in a file system.) You can use prefix with - delimiter to roll up numerous objects into a single result under CommonPrefixes. ' - in: query - name: prefix - required: false - schema: - type: string - - description: Specifies the object version you want to start listing from. - in: query - name: version-id-marker - required: false - schema: - type: string - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - description: Pagination limit - in: query - name: MaxKeys - required: false - schema: - type: string - - description: Pagination token - in: query - name: KeyMarker - required: false - schema: - type: string - - description: Pagination token - in: query - name: VersionIdMarker - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: versions - required: true - schema: - enum: - - true - type: boolean - responses: - '200': - content: - text/xml: - schema: - $ref: '#/components/schemas/ListObjectVersionsOutput' - description: Success - parameters: - - $ref: '#/components/parameters/x-amz-security-token' - /?website: - delete: - description:

This action removes the website configuration for a bucket. - Amazon S3 returns a 200 OK response upon successfully deleting - a website configuration on the specified bucket. You will get a 200 - OK response if the website configuration you are trying to delete does - not exist on the bucket. Amazon S3 returns a 404 response if - the bucket specified in the request does not exist.

This DELETE action - requires the S3:DeleteBucketWebsite permission. By default, only - the bucket owner can delete the website configuration attached to a bucket. - However, bucket owners can grant other users permission to delete the website - configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite - permission.

For more information about hosting websites, see Hosting - Websites on Amazon S3.

The following operations are related to - DeleteBucketWebsite:

- externalDocs: - url: http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETEwebsite.html - operationId: DeleteBucketWebsite - parameters: - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: website - required: true - schema: - enum: - - true - type: boolean - responses: - '204': - description: Success - get: - description:

Returns the website configuration for a bucket. To host website - on Amazon S3, you can configure a bucket as website by adding a website configuration. - For more information about hosting websites, see Hosting - Websites on Amazon S3.

This GET action requires the S3:GetBucketWebsite - permission. By default, only the bucket owner can read the bucket website - configuration. However, bucket owners can allow other users to read the website - configuration by writing a bucket policy granting them the S3:GetBucketWebsite - permission.

The following operations are related to DeleteBucketWebsite:

- - externalDocs: - url: http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETwebsite.html - operationId: GetBucketWebsite - parameters: - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: website - required: true - schema: - enum: - - true - type: boolean - responses: - '200': - content: - text/xml: - schema: - $ref: '#/components/schemas/GetBucketWebsiteOutput' - description: Success - parameters: - - $ref: '#/components/parameters/x-amz-security-token' - put: - description:

Sets the configuration of the website that is specified in the - website subresource. To configure a bucket as a website, you - can add this subresource on the bucket with website configuration information - such as the file name of the index document and any redirect rules. For more - information, see Hosting - Websites on Amazon S3.

This PUT action requires the S3:PutBucketWebsite - permission. By default, only the bucket owner can configure the website attached - to a bucket; however, bucket owners can allow other users to set the website - configuration by writing a bucket policy that grants them the S3:PutBucketWebsite - permission.

To redirect all website requests sent to the bucket's website - endpoint, you add a website configuration with the following elements. Because - all requests are sent to another website, you don't need to provide index - document name for the bucket.

  • WebsiteConfiguration -

  • RedirectAllRequestsTo

  • - HostName

  • Protocol

    • -

If you want granular control over redirects, you can use the following - elements to add routing rules that describe conditions for redirecting requests - and information about the redirect destination. In this case, the website - configuration must provide an index document for the bucket, because some - requests might not be redirected.

  • WebsiteConfiguration -

  • IndexDocument

  • Suffix -

  • ErrorDocument

  • Key -

  • RoutingRules

  • RoutingRule -

  • Condition

  • HttpErrorCodeReturnedEquals -

  • KeyPrefixEquals

  • Redirect -

  • Protocol

  • HostName -

  • ReplaceKeyPrefixWith

  • - ReplaceKeyWith

  • HttpRedirectCode -

Amazon S3 has a limitation of 50 routing rules per website - configuration. If you require more than 50 routing rules, you can use object - redirect. For more information, see Configuring - an Object Redirect in the Amazon S3 User Guide.

- externalDocs: - url: http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTwebsite.html - operationId: PutBucketWebsite - parameters: - - description:

The base64-encoded 128-bit MD5 digest of the data. You must - use this header as a message integrity check to verify that the request - body was not corrupted in transit. For more information, see RFC - 1864.

For requests made using the Amazon Web Services Command - Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated - automatically.

- in: header - name: Content-MD5 - required: false - schema: - type: string - - description:

Indicates the algorithm used to create the checksum for the - object when using the SDK. This header will not provide any additional functionality - if not using the SDK. When sending this header, there must be a corresponding - x-amz-checksum or x-amz-trailer header sent. Otherwise, - Amazon S3 fails the request with the HTTP status code 400 Bad Request. - For more information, see Checking - object integrity in the Amazon S3 User Guide.

If you provide - an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm - parameter.

- in: header - name: x-amz-sdk-checksum-algorithm - required: false - schema: - enum: - - CRC32 - - CRC32C - - SHA1 - - SHA256 - type: string - - description: The account ID of the expected bucket owner. If the bucket is - owned by a different account, the request fails with the HTTP status code - 403 Forbidden (access denied). - in: header - name: x-amz-expected-bucket-owner - required: false - schema: - type: string - - allowEmptyValue: true - in: query - name: website - required: true - schema: - enum: - - true - type: boolean - requestBody: - content: - text/xml: - schema: - properties: - WebsiteConfiguration: - description: Specifies website configuration parameters for an Amazon - S3 bucket. - properties: - ErrorDocument: - allOf: - - $ref: '#/components/schemas/ErrorDocument' - - description: The name of the error document for the website. - IndexDocument: - allOf: - - $ref: '#/components/schemas/IndexDocument' - - description: The name of the index document for the website. - RedirectAllRequestsTo: - allOf: - - $ref: '#/components/schemas/RedirectAllRequestsTo' - - description:

The redirect behavior for every request to - this bucket's website endpoint.

If you - specify this property, you can't specify any other property.

- - RoutingRules: - allOf: - - $ref: '#/components/schemas/RoutingRules' - - description: Rules that define when a redirect is applied - and the redirect behavior. - type: object - required: - - WebsiteConfiguration - type: object - required: true - responses: - '200': - description: Success -security: -- hmac: [] -servers: -- description: The Amazon S3 multi-region endpoint - url: https://{bucket}.s3.{region}.amazonaws.com - variables: - bucket: - default: rubbish-bucket - region: - default: us-east-2 - description: The AWS region - enum: - - us-east-2 - - us-gov-east-1 - - ca-central-1 - - eu-north-1 - - eu-west-2 - - eu-west-3 - - eu-central-1 - - eu-south-1 - - af-south-1 - - ap-northeast-2 - - ap-northeast-3 - - ap-east-1 - - ap-south-1 - - me-south-1 \ No newline at end of file diff --git a/providers/src/aws/v00.00.00000/services/transfer.yaml b/providers/src/aws/v00.00.00000/services/transfer.yaml index c0dbb758..4d0e972f 100644 --- a/providers/src/aws/v00.00.00000/services/transfer.yaml +++ b/providers/src/aws/v00.00.00000/services/transfer.yaml @@ -2479,6 +2479,253 @@ components: description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 x-stackQL-resources: + servers: + name: servers + x-cfn-schema-name: DescribedServer + x-example-where-clause: WHERE region = 'us-east-1' AND ServerId = '' + x-type: native + methods: + create_server: + serviceName: transfer + operation: + $ref: '#/paths/~1?__X-Amz-Target=TransferService.CreateServer?__nativeEndpoint=true/post' + request: + mediaType: application/x-amz-json-1.1 + default: | + {} + response: + mediaType: application/json + openAPIDocKey: '200' + list_servers: + serviceName: transfer + operation: + $ref: '#/paths/~1?__X-Amz-Target=TransferService.ListServers?__nativeEndpoint=true/post' + request: + mediaType: application/x-amz-json-1.1 + default: | + {} + response: + objectKey: $.Servers + mediaType: application/json + openAPIDocKey: '200' + describe_server: + serviceName: transfer + operation: + $ref: '#/paths/~1?__X-Amz-Target=TransferService.DescribeServer?__nativeEndpoint=true/post' + request: + mediaType: application/x-amz-json-1.1 + response: + objectKey: $.Server + mediaType: application/json + openAPIDocKey: '200' + update_server: + serviceName: transfer + operation: + $ref: '#/paths/~1?__X-Amz-Target=TransferService.UpdateServer?__nativeEndpoint=true/post' + request: + mediaType: application/x-amz-json-1.1 + response: + mediaType: application/json + openAPIDocKey: '200' + delete_server: + serviceName: transfer + operation: + $ref: '#/paths/~1?__X-Amz-Target=TransferService.DeleteServer?__nativeEndpoint=true/post' + request: + mediaType: application/x-amz-json-1.1 + response: + openAPIDocKey: '200' + start_server: + serviceName: transfer + operation: + $ref: '#/paths/~1?__X-Amz-Target=TransferService.StartServer?__nativeEndpoint=true/post' + request: + mediaType: application/x-amz-json-1.1 + response: + openAPIDocKey: '200' + stop_server: + serviceName: transfer + operation: + $ref: '#/paths/~1?__X-Amz-Target=TransferService.StopServer?__nativeEndpoint=true/post' + request: + mediaType: application/x-amz-json-1.1 + response: + openAPIDocKey: '200' + id: aws.transfer.servers + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/servers/methods/delete_server' + insert: + - $ref: '#/components/x-stackQL-resources/servers/methods/create_server' + select: + - $ref: '#/components/x-stackQL-resources/servers/methods/describe_server' + - $ref: '#/components/x-stackQL-resources/servers/methods/list_servers' + update: + - $ref: '#/components/x-stackQL-resources/servers/methods/update_server' + title: servers + users: + name: users + x-cfn-schema-name: DescribedUser + x-example-where-clause: WHERE region = 'us-east-1' AND ServerId = '' AND UserName = '' + x-type: native + methods: + list_users: + serviceName: transfer + operation: + $ref: '#/paths/~1?__X-Amz-Target=TransferService.ListUsers?__nativeEndpoint=true/post' + request: + mediaType: application/x-amz-json-1.1 + response: + objectKey: $.Users + mediaType: application/json + openAPIDocKey: '200' + describe_user: + serviceName: transfer + operation: + $ref: '#/paths/~1?__X-Amz-Target=TransferService.DescribeUser?__nativeEndpoint=true/post' + request: + mediaType: application/x-amz-json-1.1 + response: + objectKey: $.User + mediaType: application/json + openAPIDocKey: '200' + create_user: + serviceName: transfer + operation: + $ref: '#/paths/~1?__X-Amz-Target=TransferService.CreateUser?__nativeEndpoint=true/post' + request: + mediaType: application/x-amz-json-1.1 + response: + mediaType: application/json + openAPIDocKey: '200' + update_user: + serviceName: transfer + operation: + $ref: '#/paths/~1?__X-Amz-Target=TransferService.UpdateUser?__nativeEndpoint=true/post' + request: + mediaType: application/x-amz-json-1.1 + response: + mediaType: application/json + openAPIDocKey: '200' + delete_user: + serviceName: transfer + operation: + $ref: '#/paths/~1?__X-Amz-Target=TransferService.DeleteUser?__nativeEndpoint=true/post' + request: + mediaType: application/x-amz-json-1.1 + response: + openAPIDocKey: '200' + id: aws.transfer.users + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/users/methods/delete_user' + insert: + - $ref: '#/components/x-stackQL-resources/users/methods/create_user' + select: + - $ref: '#/components/x-stackQL-resources/users/methods/describe_user' + - $ref: '#/components/x-stackQL-resources/users/methods/list_users' + update: + - $ref: '#/components/x-stackQL-resources/users/methods/update_user' + title: users + public_keys: + name: public_keys + x-description: Imports or deletes a public key for a user + x-type: native + methods: + import_public_key: + serviceName: transfer + operation: + $ref: '#/paths/~1?__X-Amz-Target=TransferService.ImportSshPublicKey?__nativeEndpoint=true/post' + request: + mediaType: application/x-amz-json-1.1 + response: + mediaType: application/json + openAPIDocKey: '200' + delete_public_key: + serviceName: transfer + operation: + $ref: '#/paths/~1?__X-Amz-Target=TransferService.DeleteSshPublicKey?__nativeEndpoint=true/post' + request: + mediaType: application/x-amz-json-1.1 + response: + openAPIDocKey: '200' + id: aws.transfer.public_keys + sqlVerbs: + delete: + - $ref: '#/components/x-stackQL-resources/public_keys/methods/delete_public_key' + insert: + - $ref: '#/components/x-stackQL-resources/public_keys/methods/import_public_key' + select: [] + update: [] + title: public_keys + server_tags: + name: server_tags + id: aws.transfer.server_tags + x-cfn-schema-name: server_tags + x-type: view + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + data__ServerId, + region, + JSON_EXTRACT(json_each.value, '$.Key') as key, + JSON_EXTRACT(json_each.value, '$.Value') as value + FROM aws.transfer.servers, json_each(Tags) + WHERE region = 'us-east-1' + AND data__ServerId = 's-ab1234567890123cd' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + data__ServerId, + region, + json_array_elements_text(Tags)::jsonb ->> 'Key' as key, + json_array_elements_text(Tags)::jsonb ->> 'Value' as value + FROM + aws.transfer.servers + WHERE + region = 'us-east-1' + AND data__ServerId = 's-ab1234567890123cd' + user_public_keys: + name: user_public_keys + id: aws.transfer.user_public_keys + x-cfn-schema-name: user_public_keys + x-type: view + config: + views: + select: + predicate: sqlDialect == "sqlite3" + ddl: |- + SELECT + data__ServerId, + data__UserName, + region, + JSON_EXTRACT(json_each.value, '$.SshPublicKeyBody') as ssh_public_key_body, + JSON_EXTRACT(json_each.value, '$.SshPublicKeyId') as ssh_public_key_id, + JSON_EXTRACT(json_each.value, '$.DateImported') as date_imported + FROM aws.transfer.users, json_each(SshPublicKeys) + WHERE region = 'us-east-1' + AND data__ServerId = 's-ab1234567890123cd' + AND data__UserName = 'my_user_name' + fallback: + predicate: sqlDialect == "postgres" + ddl: |- + SELECT + data__ServerId, + data__UserName, + region, + json_array_elements_text(SshPublicKeys)::jsonb ->> 'SshPublicKeyBody' as ssh_public_key_body, + json_array_elements_text(SshPublicKeys)::jsonb ->> 'SshPublicKeyId' as ssh_public_key_id, + json_array_elements_text(SshPublicKeys)::jsonb ->> 'DateImported' as date_imported + FROM + aws.transfer.users + WHERE + region = 'us-east-1' + AND data__ServerId = 's-ab1234567890123cd' + AND data__UserName = 'my_user_name' agreements: name: agreements id: aws.transfer.agreements @@ -3031,253 +3278,6 @@ components: json_extract_path_text(Properties, 'WorkflowId') as workflow_id FROM aws.cloud_control.resources WHERE data__TypeName = 'AWS::Transfer::Workflow' AND region = 'us-east-1' - servers: - name: servers - x-cfn-schema-name: DescribedServer - x-example-where-clause: WHERE region = 'us-east-1' AND ServerId = '' - x-type: native - methods: - create_server: - serviceName: transfer - operation: - $ref: '#/paths/~1?__X-Amz-Target=TransferService.CreateServer?__nativeEndpoint=true/post' - request: - mediaType: application/x-amz-json-1.1 - default: | - {} - response: - mediaType: application/json - openAPIDocKey: '200' - list_servers: - serviceName: transfer - operation: - $ref: '#/paths/~1?__X-Amz-Target=TransferService.ListServers?__nativeEndpoint=true/post' - request: - mediaType: application/x-amz-json-1.1 - default: | - {} - response: - objectKey: $.Servers - mediaType: application/json - openAPIDocKey: '200' - describe_server: - serviceName: transfer - operation: - $ref: '#/paths/~1?__X-Amz-Target=TransferService.DescribeServer?__nativeEndpoint=true/post' - request: - mediaType: application/x-amz-json-1.1 - response: - objectKey: $.Server - mediaType: application/json - openAPIDocKey: '200' - update_server: - serviceName: transfer - operation: - $ref: '#/paths/~1?__X-Amz-Target=TransferService.UpdateServer?__nativeEndpoint=true/post' - request: - mediaType: application/x-amz-json-1.1 - response: - mediaType: application/json - openAPIDocKey: '200' - delete_server: - serviceName: transfer - operation: - $ref: '#/paths/~1?__X-Amz-Target=TransferService.DeleteServer?__nativeEndpoint=true/post' - request: - mediaType: application/x-amz-json-1.1 - response: - openAPIDocKey: '200' - start_server: - serviceName: transfer - operation: - $ref: '#/paths/~1?__X-Amz-Target=TransferService.StartServer?__nativeEndpoint=true/post' - request: - mediaType: application/x-amz-json-1.1 - response: - openAPIDocKey: '200' - stop_server: - serviceName: transfer - operation: - $ref: '#/paths/~1?__X-Amz-Target=TransferService.StopServer?__nativeEndpoint=true/post' - request: - mediaType: application/x-amz-json-1.1 - response: - openAPIDocKey: '200' - id: aws.transfer.servers - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/servers/methods/delete_server' - insert: - - $ref: '#/components/x-stackQL-resources/servers/methods/create_server' - select: - - $ref: '#/components/x-stackQL-resources/servers/methods/describe_server' - - $ref: '#/components/x-stackQL-resources/servers/methods/list_servers' - update: - - $ref: '#/components/x-stackQL-resources/servers/methods/update_server' - title: servers - users: - name: users - x-cfn-schema-name: DescribedUser - x-example-where-clause: WHERE region = 'us-east-1' AND ServerId = '' AND UserName = '' - x-type: native - methods: - list_users: - serviceName: transfer - operation: - $ref: '#/paths/~1?__X-Amz-Target=TransferService.ListUsers?__nativeEndpoint=true/post' - request: - mediaType: application/x-amz-json-1.1 - response: - objectKey: $.Users - mediaType: application/json - openAPIDocKey: '200' - describe_user: - serviceName: transfer - operation: - $ref: '#/paths/~1?__X-Amz-Target=TransferService.DescribeUser?__nativeEndpoint=true/post' - request: - mediaType: application/x-amz-json-1.1 - response: - objectKey: $.User - mediaType: application/json - openAPIDocKey: '200' - create_user: - serviceName: transfer - operation: - $ref: '#/paths/~1?__X-Amz-Target=TransferService.CreateUser?__nativeEndpoint=true/post' - request: - mediaType: application/x-amz-json-1.1 - response: - mediaType: application/json - openAPIDocKey: '200' - update_user: - serviceName: transfer - operation: - $ref: '#/paths/~1?__X-Amz-Target=TransferService.UpdateUser?__nativeEndpoint=true/post' - request: - mediaType: application/x-amz-json-1.1 - response: - mediaType: application/json - openAPIDocKey: '200' - delete_user: - serviceName: transfer - operation: - $ref: '#/paths/~1?__X-Amz-Target=TransferService.DeleteUser?__nativeEndpoint=true/post' - request: - mediaType: application/x-amz-json-1.1 - response: - openAPIDocKey: '200' - id: aws.transfer.users - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/users/methods/delete_user' - insert: - - $ref: '#/components/x-stackQL-resources/users/methods/create_user' - select: - - $ref: '#/components/x-stackQL-resources/users/methods/describe_user' - - $ref: '#/components/x-stackQL-resources/users/methods/list_users' - update: - - $ref: '#/components/x-stackQL-resources/users/methods/update_user' - title: users - public_keys: - name: public_keys - x-description: Imports or deletes a public key for a user - x-type: native - methods: - import_public_key: - serviceName: transfer - operation: - $ref: '#/paths/~1?__X-Amz-Target=TransferService.ImportSshPublicKey?__nativeEndpoint=true/post' - request: - mediaType: application/x-amz-json-1.1 - response: - mediaType: application/json - openAPIDocKey: '200' - delete_public_key: - serviceName: transfer - operation: - $ref: '#/paths/~1?__X-Amz-Target=TransferService.DeleteSshPublicKey?__nativeEndpoint=true/post' - request: - mediaType: application/x-amz-json-1.1 - response: - openAPIDocKey: '200' - id: aws.transfer.public_keys - sqlVerbs: - delete: - - $ref: '#/components/x-stackQL-resources/public_keys/methods/delete_public_key' - insert: - - $ref: '#/components/x-stackQL-resources/public_keys/methods/import_public_key' - select: [] - update: [] - title: public_keys - server_tags: - name: server_tags - id: aws.transfer.server_tags - x-cfn-schema-name: server_tags - x-type: view - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - data__ServerId, - region, - JSON_EXTRACT(json_each.value, '$.Key') as key, - JSON_EXTRACT(json_each.value, '$.Value') as value - FROM aws.transfer.servers, json_each(Tags) - WHERE region = 'us-east-1' - AND data__ServerId = 's-ab1234567890123cd' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - data__ServerId, - region, - json_array_elements_text(Tags)::jsonb ->> 'Key' as key, - json_array_elements_text(Tags)::jsonb ->> 'Value' as value - FROM - aws.transfer.servers - WHERE - region = 'us-east-1' - AND data__ServerId = 's-ab1234567890123cd' - user_public_keys: - name: user_public_keys - id: aws.transfer.user_public_keys - x-cfn-schema-name: user_public_keys - x-type: view - config: - views: - select: - predicate: sqlDialect == "sqlite3" - ddl: |- - SELECT - data__ServerId, - data__UserName, - region, - JSON_EXTRACT(json_each.value, '$.SshPublicKeyBody') as ssh_public_key_body, - JSON_EXTRACT(json_each.value, '$.SshPublicKeyId') as ssh_public_key_id, - JSON_EXTRACT(json_each.value, '$.DateImported') as date_imported - FROM aws.transfer.users, json_each(SshPublicKeys) - WHERE region = 'us-east-1' - AND data__ServerId = 's-ab1234567890123cd' - AND data__UserName = 'my_user_name' - fallback: - predicate: sqlDialect == "postgres" - ddl: |- - SELECT - data__ServerId, - data__UserName, - region, - json_array_elements_text(SshPublicKeys)::jsonb ->> 'SshPublicKeyBody' as ssh_public_key_body, - json_array_elements_text(SshPublicKeys)::jsonb ->> 'SshPublicKeyId' as ssh_public_key_id, - json_array_elements_text(SshPublicKeys)::jsonb ->> 'DateImported' as date_imported - FROM - aws.transfer.users - WHERE - region = 'us-east-1' - AND data__ServerId = 's-ab1234567890123cd' - AND data__UserName = 'my_user_name' paths: /?Action=CreateResource&Version=2021-09-30: parameters: